commit e73e599165b855cb642faff071a5464a825592d7 Author: shenlei Date: Sat Oct 10 15:16:32 2026 +0900 Initial MeshPort SDK and cross-platform client diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2c67101 --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +/target/ +/work/ +/build/ +**/.dart_tool/ +**/build/ +**/.flutter-plugins-dependencies +**/Flutter/ephemeral/ +.DS_Store +*.dylib +*.so +*.dll +*.apk +*.aab +*.app/ +*.keystore +*.jks diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..cfae2cc --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,5001 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "aead" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d122413f284cf2d62fb1b7db97e02edb8cda96d769b16e443a4f6195e35662b0" +dependencies = [ + "crypto-common 0.1.7", + "generic-array", +] + +[[package]] +name = "aes" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b169f7a6d4742236a0a00c541b845991d0ac43e546831af1249753ab4c3aa3a0" +dependencies = [ + "cfg-if", + "cipher 0.4.4", + "cpufeatures 0.2.17", +] + +[[package]] +name = "aes" +version = "0.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "35f0f96ce78e38c3dc6d8948aa8163d06385be74000f3c7a95bf1eef35d3ea32" +dependencies = [ + "cipher 0.5.2", + "cpubits", + "cpufeatures 0.3.1", +] + +[[package]] +name = "aes-gcm" +version = "0.10.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "831010a0f742e1209b3bcea8fab6a8e149051ba6099432c8cb2cc117dec3ead1" +dependencies = [ + "aead", + "aes 0.8.4", + "cipher 0.4.4", + "ctr", + "ghash", + "subtle", +] + +[[package]] +name = "aho-corasick" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c982642fa9e8606056828ee9a8505737230110bb1099153c79efe865c59d12ba" +dependencies = [ + "memchr", +] + +[[package]] +name = "allocator-api2" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923" + +[[package]] +name = "android_system_properties" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae221649c9976a6f6c56ae1facf410f3ddb33cc661c4b7b61020a912d4237fbc" +dependencies = [ + "libc", +] + +[[package]] +name = "annotate-snippets" +version = "0.12.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f211a51805bc641f3ad5b7664c77d2547af685cc33b4cd8d31964027a46f13f1" +dependencies = [ + "anstyle", + "memchr", + "unicode-width", +] + +[[package]] +name = "anstream" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "824a212faf96e9acacdbd09febd34438f8f711fb84e09a8916013cd7815ca28d" +dependencies = [ + "anstyle", + "anstyle-parse", + "anstyle-query", + "anstyle-wincon", + "colorchoice", + "is_terminal_polyfill", + "utf8parse", +] + +[[package]] +name = "anstyle" +version = "1.0.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "940b3a0ca603d1eade50a4846a2afffd5ef57a9feac2c0e2ec2e14f9ead76000" + +[[package]] +name = "anstyle-parse" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52ce7f38b242319f7cabaa6813055467063ecdc9d355bbb4ce0c68908cd8130e" +dependencies = [ + "utf8parse", +] + +[[package]] +name = "anstyle-query" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "40c48f72fd53cd289104fc64099abca73db4166ad86ea0b4341abe65af83dadc" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "anstyle-wincon" +version = "3.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d" +dependencies = [ + "anstyle", + "once_cell_polyfill", + "windows-sys 0.61.2", +] + +[[package]] +name = "anyhow" +version = "1.0.104" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "330a5ed07fa54e4702c9d6c4174f74427fc0ef6e214bbd677ae50a5099946470" + +[[package]] +name = "arc-swap" +version = "1.9.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c049c0be4daef0b145cb3555416b3b8ef5b7888a38aea1a3a155801fe7b0810b" +dependencies = [ + "rustversion", +] + +[[package]] +name = "array-const-fn-init" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8bcb85e548c05d407fa6faff46b750ba287714ef32afc0f5e15b4641ffd6affb" + +[[package]] +name = "arraydeque" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d902e3d592a523def97af8f317b08ce16b7ab854c1985a0c671e6f15cebc236" + +[[package]] +name = "arrayvec" +version = "0.7.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3fb67a6e08acf24fdeccbac2cb6ac4305825bd1f117462e0e6f2f193345ad56" + +[[package]] +name = "async-lock" +version = "3.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "290f7f2596bd5b78a9fec8088ccd89180d7f9f55b94b0576823bbbdc72ee8311" +dependencies = [ + "event-listener", + "event-listener-strategy", + "pin-project-lite", +] + +[[package]] +name = "async-recursion" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4f8abc12baad266b1c8cec146854c195b5864b4221d4b2ca7296a7ae82d9e451" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "async-ringbuf" +version = "0.3.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "befd9b989dc6b1fa531c1c3b408c711b73969249b3e1d70f0ba8d45c27a8e51a" +dependencies = [ + "futures-util", + "ringbuf", +] + +[[package]] +name = "async-trait" +version = "0.1.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "atomic-shim" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67cd4b51d303cf3501c301e8125df442128d3c6d7c69f71b27833d253de47e77" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "atomic-waker" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" + +[[package]] +name = "atomic_refcell" +version = "0.1.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "21e4227379beff4205943696e6c3e0cd809bacdf3f0edd6e3dd153e2269571a4" + +[[package]] +name = "auto_impl" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "683bf733a032aec4f8954e5c0ec9d5c2183c341c49d0939ad77acc0a19fa338a" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "autocfg" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53" + +[[package]] +name = "aws-lc-rs" +version = "1.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b281d307588d634de920874890732659e2e7672f72b5e10e81badc1a8a83621e" +dependencies = [ + "aws-lc-sys", + "zeroize", +] + +[[package]] +name = "aws-lc-sys" +version = "0.45.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9bff6c3b54fad79a2e60b8102caf565819711497c1f5f092f49508e2f5c31b27" +dependencies = [ + "cc", + "cmake", + "dunce", + "fs_extra", + "pkg-config", +] + +[[package]] +name = "base62" +version = "2.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3a647dce9631f152a99ec16cfc09267ae55fe280d5dc288964027d458076323" + +[[package]] +name = "base64" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" + +[[package]] +name = "base64" +version = "0.23.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac07cdecf99051d9a5238b80f35af32cdeba5b336e55d957b318b50137e18da5" + +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + +[[package]] +name = "bitflags" +version = "2.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06" + +[[package]] +name = "block-buffer" +version = "0.10.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71" +dependencies = [ + "generic-array", +] + +[[package]] +name = "block-buffer" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d2f6c7dbe95a6ed67ad9f18e57daf93a2f034c524b99fd2b76d18fdfeb6660aa" +dependencies = [ + "hybrid-array", + "zeroize", +] + +[[package]] +name = "bon" +version = "3.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "214f5df094ce551a10a30ffb9c70243d61f121a3d985a6495933e181dee6a7d2" +dependencies = [ + "bon-macros", +] + +[[package]] +name = "bon-macros" +version = "3.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2706da6c749998cc555d04184909608956a69ad3f8ab1a076fbc867b4a3c3ce5" +dependencies = [ + "darling", + "ident_case", + "prettyplease 0.3.0", + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "bstr" +version = "1.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6bb31b46c14244e20ee9984b11bf5c992b91fb6939fea616e3512c8baecdbe5f" +dependencies = [ + "memchr", + "serde_core", +] + +[[package]] +name = "bumpalo" +version = "3.20.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649" + +[[package]] +name = "bytecodec" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1016c00ae68a934cd21f6e3837555ffdc977c0bd8e7df3093ca35c3d726789e" +dependencies = [ + "byteorder", + "trackable", +] + +[[package]] +name = "byteorder" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b" + +[[package]] +name = "bytes" +version = "1.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04" + +[[package]] +name = "bzip2" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3a53fac24f34a81bc9954b5d6cfce0c21e18ec6959f44f56e8e90e4bb7c346c" +dependencies = [ + "libbz2-rs-sys", +] + +[[package]] +name = "c2rust-bitfields" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b43c3f07ab0ef604fa6f595aa46ec2f8a22172c975e186f6f5bf9829a3b72c41" +dependencies = [ + "c2rust-bitfields-derive", +] + +[[package]] +name = "c2rust-bitfields-derive" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3cbc102e2597c9744c8bd8c15915d554300601c91a079430d309816b0912545" +dependencies = [ + "proc-macro2", + "quote", + "syn 1.0.109", +] + +[[package]] +name = "cc" +version = "1.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f74872d07caf508b30a21f6836e7d7016a2eaf7d9ff4f48deaa58cd8a0407630" +dependencies = [ + "find-msvc-tools", + "jobserver", + "libc", + "shlex", +] + +[[package]] +name = "cfg-if" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600" + +[[package]] +name = "cfg_aliases" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f079e83a288787bcd14a6aea84cee5c87a67c5a3e660c30f557a3d24761b3527" + +[[package]] +name = "chacha20" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3613f74bd2eac03dad61bd53dbe620703d4371614fe0bc3b9f04dd36fe4e818" +dependencies = [ + "cfg-if", + "cipher 0.4.4", + "cpufeatures 0.2.17", +] + +[[package]] +name = "chacha20" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65c35e4b699c7e15ccbe7ee35c005e4fc0a278d22238a2857e6ce2dadeda1b06" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.1", + "rand_core 0.10.1", +] + +[[package]] +name = "chacha20poly1305" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10cd79432192d1c0f4e1a0fef9527696cc039165d729fb41b3f4f4f354c2dc35" +dependencies = [ + "aead", + "chacha20 0.9.1", + "cipher 0.4.4", + "poly1305", + "zeroize", +] + +[[package]] +name = "chrono" +version = "0.4.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1aa79e62e7697b8e29b513a68abacf485adcd1fe8284a4316c5ae868e6633327" +dependencies = [ + "iana-time-zone", + "js-sys", + "num-traits", + "serde", + "wasm-bindgen", + "windows-link", +] + +[[package]] +name = "cidr" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "579504560394e388085d0c080ea587dfa5c15f7e251b4d5247d1e1a61d1d6928" +dependencies = [ + "serde", +] + +[[package]] +name = "cipher" +version = "0.4.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "773f3b9af64447d2ce9850330c473515014aa235e6a783b02db81ff39e4a3dad" +dependencies = [ + "crypto-common 0.1.7", + "inout 0.1.4", + "zeroize", +] + +[[package]] +name = "cipher" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e8cf2a2c93cd704877c0858356ed03480ff301ee950b43f1cbe4573b088bfa6c" +dependencies = [ + "crypto-common 0.2.2", + "inout 0.2.2", +] + +[[package]] +name = "clap" +version = "4.6.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa8876b300ab35ba921adea3dfd70157a46249b33f95c9084ae5709785478946" +dependencies = [ + "clap_builder", + "clap_derive", +] + +[[package]] +name = "clap_builder" +version = "4.6.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec0797fb7aeb1406c84efac526901f7ec3ead2124f946b494e72879d4b54704d" +dependencies = [ + "anstream", + "anstyle", + "clap_lex", + "strsim", + "terminal_size", + "unicase", + "unicode-width", +] + +[[package]] +name = "clap_complete" +version = "4.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "037e2a1a92236d0aff7e845093f64661d6df4c02c9fcc61a60e9e1d736fa392f" +dependencies = [ + "clap", +] + +[[package]] +name = "clap_complete_nushell" +version = "4.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ffb66bc82eb9c92b1727310ae2c5868df22ae7cf46185bc5c544a4fa71955e49" +dependencies = [ + "clap", + "clap_complete", +] + +[[package]] +name = "clap_derive" +version = "4.6.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9c751b79415d4e559e3d1fcf128e09e720eb673a06d26cf6f392d37d75b66e0" +dependencies = [ + "heck", + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "clap_lex" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c133bc6a41be0d194c306b5506d15e6feeea7b1d6604bd3f8310dfb2ca96486" + +[[package]] +name = "cmake" +version = "0.1.58" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0f78a02292a74a88ac736019ab962ece0bc380e3f977bf72e376c5d78ff0678" +dependencies = [ + "cc", +] + +[[package]] +name = "cmov" +version = "0.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c9ea0ac24bc397ab3c98583a3c9ba74fa56b09a4449bbe172b9b1ddb016027a" + +[[package]] +name = "codepage" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bdff162541cd8b79de82e2edcc7eff3a8c2a6dc3d75152636028f96d93de3b26" +dependencies = [ + "encoding_rs", +] + +[[package]] +name = "colorchoice" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570" + +[[package]] +name = "combine" +version = "4.6.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfc320937d09e6de266b31b9afb480f197d7a861be86be7cb2ea7e5d1bfffc5e" +dependencies = [ + "bytes", + "memchr", +] + +[[package]] +name = "const-oid" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6ef517f0926dd24a1582492c791b6a4818a4d94e789a334894aa15b0d12f55c" + +[[package]] +name = "constant_time_eq" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d52eff69cd5e647efe296129160853a42795992097e8af39800e1060caeea9b" + +[[package]] +name = "convert_case" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "633458d4ef8c78b72454de2d54fd6ab2e60f9e02be22f3c6104cdc8a4e0fceb9" +dependencies = [ + "unicode-segmentation", +] + +[[package]] +name = "core-foundation" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91e195e091a93c46f7102ec7818a2aa394e1e1771c3ab4825963fa03e45afb8f" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "core-foundation" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2a6cd9ae233e7f62ba4e9353e81a88df7fc8a5987b8d445b4d90c879bd156f6" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "core-foundation-sys" +version = "0.8.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" + +[[package]] +name = "core_detect" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f8f80099a98041a3d1622845c271458a2d73e688351bf3cb999266764b81d48" + +[[package]] +name = "cpubits" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "15b85f9c39137c3a891689859392b1bd49812121d0d61c9caf00d46ed5ce06ae" + +[[package]] +name = "cpufeatures" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280" +dependencies = [ + "libc", +] + +[[package]] +name = "cpufeatures" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5ca28b0ae3115b884660db4118d803791fd6756b6e88f39c0f3f7859060d7566" +dependencies = [ + "libc", +] + +[[package]] +name = "crc" +version = "3.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5eb8a2a1cd12ab0d987a5d5e825195d372001a4094a0376319d5a0ad71c1ba0d" +dependencies = [ + "crc-catalog", +] + +[[package]] +name = "crc-catalog" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "217698eaf96b4a3f0bc4f3662aaa55bdf913cd54d7204591faa790070c6d0853" + +[[package]] +name = "crc32fast" +version = "1.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "01a7799fd6b852db0e61728dde9a204c423b44d689dbd432522543614b490e78" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "crossbeam" +version = "0.8.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e71406cd8807725f7ac2f999a4cdd32e98f829fdf65f528343cebf945e41df1e" +dependencies = [ + "crossbeam-channel", + "crossbeam-deque", + "crossbeam-epoch", + "crossbeam-queue", + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-channel" +version = "0.5.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "98b0cc327b5bc766e7fda9c9260cc0fa81b43a8e240440422dff70788e3f9ef1" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-deque" +version = "0.8.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "622f3fc73690be383c7214310406f28a90e6edeadc3cea882f9d71e495b9711a" +dependencies = [ + "crossbeam-epoch", + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-epoch" +version = "0.9.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc74980687109a3b14c72fd458107bf0baa1da1a1a805e178d15501ba9b86d9d" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-queue" +version = "0.3.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03e8bd762f7479489c70ed6c768ddca99d7296857de437a68dcb2a94365b3fae" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-utils" +version = "0.8.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a31eee39dddec8330830986fcd7625edb5a24ec90ea038215273bbc3adb08ac6" + +[[package]] +name = "crypto-common" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78c8292055d1c1df0cce5d180393dc8cce0abec0a7102adb6c7b1eef6016d60a" +dependencies = [ + "generic-array", + "rand_core 0.6.4", + "typenum", +] + +[[package]] +name = "crypto-common" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce6e4c961d6cd6c9a86db418387425e8bdeaf05b3c8bc1411e6dca4c252f1453" +dependencies = [ + "hybrid-array", +] + +[[package]] +name = "ctr" +version = "0.9.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0369ee1ad671834580515889b80f2ea915f23b8be8d0daa4bbaf2ac5c7590835" +dependencies = [ + "cipher 0.4.4", +] + +[[package]] +name = "ctutils" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03bb0e1cc970d482d121d9a1744999169b69a07470b3d644a7894e53fcaf4574" +dependencies = [ + "cmov", +] + +[[package]] +name = "curve25519-dalek" +version = "4.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "97fb8b7c4503de7d6ae7b42ab72a5a59857b4c937ec27a3d4539dba95b5ab2be" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "curve25519-dalek-derive", + "fiat-crypto", + "rustc_version", + "subtle", + "zeroize", +] + +[[package]] +name = "curve25519-dalek-derive" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f46882e17999c6cc590af592290432be3bce0428cb0d5f8b6715e4dc7b383eb3" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "darling" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed17f5901b6630b993ca003def43f2f8ef4014fc13b047b57aad617ff32bc2ec" +dependencies = [ + "darling_core", + "darling_macro", +] + +[[package]] +name = "darling_core" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6837e2cf7485aaae18f86181d2f0e9a7ed297a025e220aeabf63fdebd3a2ddff" +dependencies = [ + "ident_case", + "proc-macro2", + "quote", + "strsim", + "syn 3.0.6", +] + +[[package]] +name = "darling_macro" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ac7135c3ef02b2f7833bbeb1be5ba7f966dcde8a87c6b87f65a778d71a02785" +dependencies = [ + "darling_core", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "dashmap" +version = "6.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6361d5c062261c78a176addb82d4c821ae42bed6089de0e12603cd25de2059c" +dependencies = [ + "cfg-if", + "crossbeam-utils", + "hashbrown 0.14.5", + "lock_api", + "once_cell", + "parking_lot_core", +] + +[[package]] +name = "deflate64" +version = "0.1.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac6b926516df9c60bfa16e107b21086399f8285a44ca9711344b9e553c5146e2" + +[[package]] +name = "defmt" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e2953bfe4f93bbd20cc71198842756f77d161884c99ebbabc41d80231ded88d1" +dependencies = [ + "bitflags 1.3.2", + "defmt-macros", +] + +[[package]] +name = "defmt-macros" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bad9c72e7ca2137e0dc3813245a0d282fd6daad32fd800af018306a9169b5fe8" +dependencies = [ + "defmt-parser", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "defmt-parser" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10d60334b3b2e7c9d91ef8150abfb6fa4c1c39ebbcf4a81c2e346aad939fee3e" +dependencies = [ + "thiserror 2.0.21", +] + +[[package]] +name = "deranged" +version = "0.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7cd812cc2bc1d69d4764bd80df88b4317eaef9e773c75226407d9bc0876b211c" + +[[package]] +name = "derive_more" +version = "2.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d751e9e49156b02b44f9c1815bcb94b984cdcc4396ecc32521c739452808b134" +dependencies = [ + "derive_more-impl", +] + +[[package]] +name = "derive_more-impl" +version = "2.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "799a97264921d8623a957f6c3b9011f3b5492f557bbb7a5a19b7fa6d06ba8dcb" +dependencies = [ + "convert_case", + "proc-macro2", + "quote", + "rustc_version", + "syn 2.0.119", + "unicode-xid", +] + +[[package]] +name = "digest" +version = "0.10.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292" +dependencies = [ + "block-buffer 0.10.4", + "crypto-common 0.1.7", + "subtle", +] + +[[package]] +name = "digest" +version = "0.11.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1dd6dbb5841937940781866fa1281a1ff7bd3bf827091440879f9994983d5c2" +dependencies = [ + "block-buffer 0.12.1", + "const-oid", + "crypto-common 0.2.2", + "ctutils", + "zeroize", +] + +[[package]] +name = "dirs" +version = "4.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca3aa72a6f96ea37bbc5aa912f6788242832f75369bdfdadcb0e38423f100059" +dependencies = [ + "dirs-sys 0.3.7", +] + +[[package]] +name = "dirs" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3e8aa94d75141228480295a7d0e7feb620b1a5ad9f12bc40be62411e38cce4e" +dependencies = [ + "dirs-sys 0.5.0", +] + +[[package]] +name = "dirs-sys" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b1d1d91c932ef41c0f2663aa8b0ca0342d444d842c06914aa0a7e352d0bada6" +dependencies = [ + "libc", + "redox_users 0.4.6", + "winapi", +] + +[[package]] +name = "dirs-sys" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e01a3366d27ee9890022452ee61b2b63a67e6f13f58900b651ff5665f0bb1fab" +dependencies = [ + "libc", + "option-ext", + "redox_users 0.5.3", + "windows-sys 0.61.2", +] + +[[package]] +name = "displaydoc" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6232dd377dcc64799954cbd3a9bb882e9cdc1308ccd87b1c098f1fb2eaf82a8" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "dunce" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813" + +[[package]] +name = "easytier" +version = "2.7.0" +dependencies = [ + "anyhow", + "arc-swap", + "async-recursion", + "async-trait", + "atomic-shim", + "atomic_refcell", + "base64 0.22.1", + "bon", + "byteorder", + "bytes", + "cfg_aliases", + "chrono", + "cidr", + "clap", + "clap_complete", + "clap_complete_nushell", + "crossbeam", + "dashmap", + "derive_more", + "easytier-core", + "easytier-proto", + "encoding", + "futures", + "gethostname", + "git-version", + "globwalk 0.9.1", + "guarden", + "indoc", + "log", + "machine-uid", + "moka", + "netlink-sys", + "network-interface", + "nix 0.31.3", + "once_cell", + "parking_lot", + "paste", + "percent-encoding", + "pin-project-lite", + "prost", + "quanta", + "rand 0.8.8", + "regex", + "rust-i18n", + "serde", + "serde_json", + "service-manager", + "shellexpand", + "socket2", + "strum", + "sys-locale", + "thiserror 2.0.21", + "thunk-rs", + "tokio", + "tokio-util", + "toml 1.1.8+spec-1.1.0", + "tracing", + "tun-easytier", + "url", + "uuid", + "winapi", + "windivert", + "windows 0.62.2", + "windows-service", + "winreg", + "zerocopy 0.7.35", +] + +[[package]] +name = "easytier-core" +version = "2.7.0" +dependencies = [ + "aes-gcm", + "anyhow", + "arc-swap", + "async-ringbuf", + "async-trait", + "atomic-shim", + "auto_impl", + "base64 0.22.1", + "bitflags 2.13.2", + "bon", + "bytecodec", + "bytes", + "chrono", + "cidr", + "crossbeam-utils", + "dashmap", + "easytier-proto", + "futures", + "getrandom 0.2.17", + "getrandom 0.3.4", + "guarden", + "hmac 0.12.1", + "idna", + "ordered_hash_map", + "parking_lot", + "percent-encoding", + "petgraph", + "pin-project-lite", + "prefix-trie", + "prost", + "prost-types", + "quanta", + "rand 0.8.8", + "serde", + "serde_json", + "sha2 0.10.9", + "smoltcp", + "snow", + "strum", + "stun_codec", + "thiserror 2.0.21", + "tokio", + "tokio-util", + "toml 1.1.8+spec-1.1.0", + "tracing", + "url", + "uuid", + "wasm-bindgen", + "wildmatch", + "x25519-dalek", + "zerocopy 0.7.35", +] + +[[package]] +name = "easytier-proto" +version = "2.7.0" +dependencies = [ + "anyhow", + "async-trait", + "auto_impl", + "base64 0.22.1", + "bytes", + "chrono", + "cidr", + "hmac 0.12.1", + "indoc", + "pbjson", + "pbjson-build", + "proc-macro2", + "prost", + "prost-build", + "prost-types", + "quote", + "reqwest", + "serde", + "serde_json", + "sha2 0.10.9", + "thiserror 2.0.21", + "tokio", + "url", + "uuid", + "x25519-dalek", + "zip", +] + +[[package]] +name = "either" +version = "1.19.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0e9c71c2167ca323c882b99918929403426e2373ea17242ff5653e0d5e1058be" + +[[package]] +name = "encoding" +version = "0.2.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b0d943856b990d12d3b55b359144ff341533e516d94098b1d3fc1ac666d36ec" +dependencies = [ + "encoding-index-japanese", + "encoding-index-korean", + "encoding-index-simpchinese", + "encoding-index-singlebyte", + "encoding-index-tradchinese", +] + +[[package]] +name = "encoding-index-japanese" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04e8b2ff42e9a05335dbf8b5c6f7567e5591d0d916ccef4e0b1710d32a0d0c91" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-index-korean" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4dc33fb8e6bcba213fe2f14275f0963fd16f0a02c878e3095ecfdf5bee529d81" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-index-simpchinese" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d87a7194909b9118fc707194baa434a4e3b0fb6a5a757c73c3adb07aa25031f7" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-index-singlebyte" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3351d5acffb224af9ca265f435b859c7c01537c0849754d3db3fdf2bfe2ae84a" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-index-tradchinese" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd0e20d5688ce3cab59eb3ef3a2083a5c77bf496cb798dc6fcdb75f323890c18" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-utils" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "87b881ab2524b96a5ce932056c7482ba6152e2226fed3936b3e592adeb95ca6d" +dependencies = [ + "codepage", + "encoding_rs", + "windows-sys 0.52.0", +] + +[[package]] +name = "encoding_index_tests" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a246d82be1c9d791c5dfde9a2bd045fc3cbba3fa2b11ad558f27d01712f00569" + +[[package]] +name = "encoding_rs" +version = "0.8.42" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e985e0451871ad22fb8d2b6b076e2028a502a0d3950998c2c5c0a4f9b5d9679" +dependencies = [ + "cfg-if", + "core_detect", + "multiversion_no_op", + "rustversion", + "scopeguard", + "simdutf8", +] + +[[package]] +name = "encoding_rs_io" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fba3fe847045ecff794b9c138293a80db914678c453ad63fbf0c6a9eb6e00b22" +dependencies = [ + "encoding_rs", +] + +[[package]] +name = "equivalent" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" + +[[package]] +name = "errno" +version = "0.3.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "etherparse" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "827292ea592108849932ad8e30218f8b1f21c0dfd0696698a18b5d0aed62d990" +dependencies = [ + "arrayvec", +] + +[[package]] +name = "event-listener" +version = "5.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a23add41df1562121a9393cb065eab5146a1242410f23a644851e90cfd669d2" +dependencies = [ + "parking", + "pin-project-lite", +] + +[[package]] +name = "event-listener-strategy" +version = "0.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8be9f3dfaaffdae2972880079a491a1a8bb7cbed0b8dd7a347f668b4150a3b93" +dependencies = [ + "event-listener", + "pin-project-lite", +] + +[[package]] +name = "fastrand" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da7c62ceae207dd37ea5b845da6a0696c799f85e97da1ab5b7910be3c1c80223" + +[[package]] +name = "fiat-crypto" +version = "0.2.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "28dea519a9695b9977216879a3ebfddf92f1c08c05d984f8996aecd6ecdc811d" + +[[package]] +name = "find-msvc-tools" +version = "0.1.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aedcfb3409746eddb02b9e19ebda1c3394f759a152e48ee875a0844d1b955484" + +[[package]] +name = "fixedbitset" +version = "0.5.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d674e81391d1e1ab681a28d99df07927c6d4aa5b027d7da16ba32d1d21ecd99" + +[[package]] +name = "flate2" +version = "1.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e634e2e0ebac1ee034020da1ca582e17ffe4e0f5e985823721e168928136dcb" +dependencies = [ + "zlib-rs", +] + +[[package]] +name = "fnv" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" + +[[package]] +name = "foldhash" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" + +[[package]] +name = "foldhash" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77ce24cb58228fbb8aa041425bb1050850ac19177686ea6e0f41a70416f56fdb" + +[[package]] +name = "form_urlencoded" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" +dependencies = [ + "percent-encoding", +] + +[[package]] +name = "fs_extra" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42703706b716c37f96a77aea830392ad231f44c9e9a67872fa5548707e11b11c" + +[[package]] +name = "futures" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a31d2a3fbaaeb2af2368bbdd904aa8e812d3c04a1ee10d3171f52d556e5d0a3" +dependencies = [ + "futures-channel", + "futures-core", + "futures-executor", + "futures-io", + "futures-sink", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-channel" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f9e3d69d39e4862ffed03ed071a76f9a13ba1d9109d355b0f0aa6b15e393c4" +dependencies = [ + "futures-core", + "futures-sink", +] + +[[package]] +name = "futures-core" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92d699e522242e69e3003b94ecc1f960f3a5e015aa7c5d7486e65ad01dd94f5e" + +[[package]] +name = "futures-executor" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "031b47cf1a3c6cc8bc2fc76cd437f521619387907d469316e7c0bc278f1f5432" +dependencies = [ + "futures-core", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-io" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed" + +[[package]] +name = "futures-macro" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9fb9654ba8355388abeb8dcb4fc62f511300867002afc858860463bdd9fe0c44" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "futures-sink" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1944426bf7d03f1d14f708785e4b33efd750b36d48a157b836b3efc15ede8e1d" + +[[package]] +name = "futures-task" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd417de3d1d015fc3bfd2b1ea46dfc7bab72ef86f1cc7cc9c78e728b34a6d1fd" + +[[package]] +name = "futures-util" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d50a92467f8ba5dd6e3ee5d4bd04d73ab2e4e1c44474a0674821dfce14b79bc" +dependencies = [ + "futures-channel", + "futures-core", + "futures-io", + "futures-macro", + "futures-sink", + "futures-task", + "memchr", + "pin-project-lite", + "slab", +] + +[[package]] +name = "generic-array" +version = "0.14.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a" +dependencies = [ + "typenum", + "version_check", +] + +[[package]] +name = "gethostname" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1bd49230192a3797a9a4d6abe9b3eed6f7fa4c8a8a4947977c6f80025f92cbd8" +dependencies = [ + "rustix 1.1.5", + "windows-link", +] + +[[package]] +name = "getrandom" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff2abc00be7fca6ebc474524697ae276ad847ad0a6b3faa4bcb027e9a4614ad0" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "wasi", + "wasm-bindgen", +] + +[[package]] +name = "getrandom" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "899def5c37c4fd7b2664648c28120ecec138e4d395b459e5ca34f9cce2dd77fd" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "r-efi 5.3.0", + "wasip2", + "wasm-bindgen", +] + +[[package]] +name = "getrandom" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "300e883d756b2e4ec94e02791f39b04b522276138852cfc41d9fb7e904106099" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "r-efi 6.0.0", + "rand_core 0.10.1", + "wasm-bindgen", +] + +[[package]] +name = "ghash" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0d8a4362ccb29cb0b265253fb0a2728f592895ee6854fd9bc13f2ffda266ff1" +dependencies = [ + "opaque-debug", + "polyval", +] + +[[package]] +name = "git-version" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ad568aa3db0fcbc81f2f116137f263d7304f512a1209b35b85150d3ef88ad19" +dependencies = [ + "git-version-macro", +] + +[[package]] +name = "git-version-macro" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53010ccb100b96a67bc32c0175f0ed1426b31b655d562898e57325f81c023ac0" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "glob" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e4eba85ea1d0a966a983acd07deee566e67395d2d96b6fb39e62b5a833f1eb0b" + +[[package]] +name = "globset" +version = "0.4.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07c34a9410465b45bd9787443bc7370f37735bad04b0f0cd57ff1a3186c98988" +dependencies = [ + "aho-corasick", + "bstr", + "log", + "regex-automata", + "regex-syntax", +] + +[[package]] +name = "globwalk" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93e3af942408868f6934a7b85134a3230832b9977cf66125df2f9edcfce4ddcc" +dependencies = [ + "bitflags 1.3.2", + "ignore", + "walkdir", +] + +[[package]] +name = "globwalk" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf760ebf69878d9fd8f110c89703d90ce35095324d1f1edcb595c63945ee757" +dependencies = [ + "bitflags 2.13.2", + "ignore", + "walkdir", +] + +[[package]] +name = "granit-parser" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e20f99e46474f56bd905c56e817ebddcf377a611f94c53ac4649e4d3fa3c0cd0" +dependencies = [ + "arraydeque", + "smallvec", +] + +[[package]] +name = "guarden" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "11e5aa725802d305ed9726003d1d2c0329cea9802314d482b7d1206b10e92461" +dependencies = [ + "futures-core", + "guarden-macros", + "tokio", +] + +[[package]] +name = "guarden-macros" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "58fae24d0e2228af3151faf0153dc6c9ef1f7fa7965ffb7e3022052fcb78f297" +dependencies = [ + "proc-macro-crate", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "h2" +version = "0.4.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d29020232d6aa3fb1daca64c1127cf662cf97f254ae16c18c05b8ab635fc118" +dependencies = [ + "atomic-waker", + "bytes", + "fnv", + "futures-core", + "futures-sink", + "http", + "indexmap", + "slab", + "tokio", + "tokio-util", + "tracing", +] + +[[package]] +name = "hash32" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47d60b12902ba28e2730cd37e95b8c9223af2808df9e902d4df49588d1470606" +dependencies = [ + "byteorder", +] + +[[package]] +name = "hashbrown" +version = "0.14.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" + +[[package]] +name = "hashbrown" +version = "0.15.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9229cfe53dfd69f0609a49f65461bd93001ea1ef889cd5529dd176593f5338a1" +dependencies = [ + "allocator-api2", + "equivalent", + "foldhash 0.1.5", +] + +[[package]] +name = "hashbrown" +version = "0.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" + +[[package]] +name = "heapless" +version = "0.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "25ba4bd83f9415b58b4ed8dc5714c76e626a105be4646c02630ad730ad3b5aa4" +dependencies = [ + "hash32", + "stable_deref_trait", +] + +[[package]] +name = "heck" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" + +[[package]] +name = "hmac" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c49c37c09c17a53d937dfbb742eb3a961d65a994e6bcdcf37e7399d0cc8ab5e" +dependencies = [ + "digest 0.10.7", +] + +[[package]] +name = "hmac" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6303bc9732ae41b04cb554b844a762b4115a61bfaa81e3e83050991eeb56863f" +dependencies = [ + "digest 0.11.3", +] + +[[package]] +name = "home" +version = "0.5.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc627f471c528ff0c4a49e1d5e60450c8f6461dd6d10ba9dcd3a61d3dff7728d" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "http" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "918d3568bebf352712bc2ef3d46a8bcf1a75b373be6539de198e9105cbbf9ce0" +dependencies = [ + "bytes", + "itoa", +] + +[[package]] +name = "http-body" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca2a8f2913ee65f60facd6a5905613afaa448497a0230cc41ce022d93290bc2c" +dependencies = [ + "bytes", + "http", +] + +[[package]] +name = "http-body-util" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23169fe34a5fbcdd3f3862e78fb9b6fccd5f02a6dc6f732547005d45631ce71c" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "pin-project-lite", +] + +[[package]] +name = "httparse" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87" + +[[package]] +name = "hybrid-array" +version = "0.4.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27f864f10dfb56725ce5ce5472bc52252c8f93a4ab86327122cebf62c5f59a17" +dependencies = [ + "typenum", +] + +[[package]] +name = "hyper" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2c3e324da4c95177d6291d4c8730197c0d1822f8a9766814a4a44fa5ab797c9c" +dependencies = [ + "atomic-waker", + "bytes", + "futures-channel", + "futures-core", + "h2", + "http", + "http-body", + "httparse", + "itoa", + "pin-project-lite", + "smallvec", + "tokio", + "want", +] + +[[package]] +name = "hyper-rustls" +version = "0.27.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dfa8e654703247911e29c23fbeaa261834bd9bb74efba2f9acddc37bfb127f53" +dependencies = [ + "http", + "hyper", + "hyper-util", + "rustls", + "tokio", + "tokio-rustls", + "tower-service", +] + +[[package]] +name = "hyper-util" +version = "0.1.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ddc03d96684f9226b8a787cdb71488417b53ab5ea8fdb1dac946cb9431cc8bff" +dependencies = [ + "base64 0.23.1", + "bytes", + "futures-channel", + "futures-util", + "http", + "http-body", + "httparse", + "hyper", + "ipnet", + "libc", + "percent-encoding", + "pin-project-lite", + "socket2", + "system-configuration", + "tokio", + "tower-service", + "tracing", + "windows-registry", +] + +[[package]] +name = "iana-time-zone" +version = "0.1.65" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e31bc9ad994ba00e440a8aa5c9ef0ec67d5cb5e5cb0cc7f8b744a35b389cc470" +dependencies = [ + "android_system_properties", + "core-foundation-sys", + "iana-time-zone-haiku", + "js-sys", + "log", + "wasm-bindgen", + "windows-core", +] + +[[package]] +name = "iana-time-zone-haiku" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f" +dependencies = [ + "cc", +] + +[[package]] +name = "icu_collections" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fa68d21081c4a05d5a901a1c62add574c77048b6a1c67be3b50ce0b60d4ca513" +dependencies = [ + "displaydoc", + "potential_utf", + "utf8_iter", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_locale_core" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d56e28588da92eee5c3201a6eff33fabdd49b62269c8938d4ff050ce4d900deb" +dependencies = [ + "displaydoc", + "litemap", + "tinystr", + "writeable", + "zerovec", +] + +[[package]] +name = "icu_normalizer" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "12f9cf5f235641ed274641dd81c3f28d870e276763d0797aeeab72317b1c646f" +dependencies = [ + "icu_collections", + "icu_normalizer_data", + "icu_properties", + "icu_provider", + "smallvec", + "zerovec", +] + +[[package]] +name = "icu_normalizer_data" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1563da1ed3e0b3bf3d74c9b85917ac9c56464d2f57242270c09c9e752f8021a0" + +[[package]] +name = "icu_properties" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e7ca276ad3145661a65914e6daf131ca5120cd3dcee8f8f3214b8875184a148" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_locale_core", + "icu_properties_data", + "icu_provider", + "zerotrie", + "zerovec", +] + +[[package]] +name = "icu_properties_data" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e590f038c1464a96894fd6d10127e90a8be4509f56ff7ecef851b15cee0b7caa" + +[[package]] +name = "icu_provider" +version = "2.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d27bbb9d3abbefac45d55f647c9de1d44aafcd1186eb91879afef17c396c3e73" +dependencies = [ + "displaydoc", + "icu_locale_core", + "writeable", + "yoke", + "zerofrom", + "zerotrie", + "zerovec", +] + +[[package]] +name = "ident_case" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" + +[[package]] +name = "idna" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" +dependencies = [ + "idna_adapter", + "smallvec", + "utf8_iter", +] + +[[package]] +name = "idna_adapter" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb68373c0d6620ef8105e855e7745e18b0d00d3bdb07fb532e434244cdb9a714" +dependencies = [ + "icu_normalizer", + "icu_properties", +] + +[[package]] +name = "ignore" +version = "0.4.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00b69833ed729dc5aa7d19541d96d6cf8e9137194207a04916d658e43168402f" +dependencies = [ + "crossbeam-deque", + "globset", + "log", + "memchr", + "regex-automata", + "same-file", + "walkdir", + "winapi-util", +] + +[[package]] +name = "indexmap" +version = "2.14.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc4e190f5d26ca7051642629da2c52fc03bde85a03197c99408dcd291734c855" +dependencies = [ + "equivalent", + "hashbrown 0.17.1", +] + +[[package]] +name = "indoc" +version = "2.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706" +dependencies = [ + "rustversion", +] + +[[package]] +name = "inout" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "879f10e63c20629ecabbb64a8010319738c66a5cd0c29b02d63d272b03751d01" +dependencies = [ + "generic-array", +] + +[[package]] +name = "inout" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4250ce6452e92010fdf7268ccc5d14faa80bb12fc741938534c58f16804e03c7" +dependencies = [ + "hybrid-array", +] + +[[package]] +name = "ipnet" +version = "2.12.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "791930b43c0d5973160d90a8f3894509f2b273430f5c5c73b668636d0287c5c0" + +[[package]] +name = "is_terminal_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695" + +[[package]] +name = "itertools" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1c173a5686ce8bfa551b3563d0c2170bf24ca44da99c7ca4bfdab5418c3fe57" +dependencies = [ + "either", +] + +[[package]] +name = "itertools" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b192c782037fadd9cfa75548310488aabdbf3d2da73885b31bd0abd03351285" +dependencies = [ + "either", +] + +[[package]] +name = "itoa" +version = "1.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682" + +[[package]] +name = "jni" +version = "0.22.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5efd9a482cf3a427f00d6b35f14332adc7902ce91efb778580e180ff90fa3498" +dependencies = [ + "cfg-if", + "combine", + "jni-macros", + "jni-sys", + "log", + "simd_cesu8", + "thiserror 2.0.21", + "walkdir", + "windows-link", +] + +[[package]] +name = "jni-macros" +version = "0.22.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a00109accc170f0bdb141fed3e393c565b6f5e072365c3bd58f5b062591560a3" +dependencies = [ + "proc-macro2", + "quote", + "rustc_version", + "simd_cesu8", + "syn 2.0.119", +] + +[[package]] +name = "jni-sys" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6377a88cb3910bee9b0fa88d4f42e1d2da8e79915598f65fb0c7ee14c878af2" +dependencies = [ + "jni-sys-macros", +] + +[[package]] +name = "jni-sys-macros" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38c0b942f458fe50cdac086d2f946512305e5631e720728f2a61aabcd47a6264" +dependencies = [ + "quote", + "syn 2.0.119", +] + +[[package]] +name = "jobserver" +version = "0.1.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c00acbd29eabad4a2392fa0e921c874934dbbf4194312ad20f04a0ed67a3cb3" +dependencies = [ + "getrandom 0.4.3", + "libc", +] + +[[package]] +name = "js-sys" +version = "0.3.106" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7883d941dae510fb2d978fc3fe018c71c9e2892fd38854de3e8b92c2e5ad9cc5" +dependencies = [ + "cfg-if", + "futures-util", + "wasm-bindgen", +] + +[[package]] +name = "lazy_static" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "20870f649af7073d53e38067b2a84312175d56ea15217e1b15bc83506ec50afb" + +[[package]] +name = "libbz2-rs-sys" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "34b357333733e8260735ba5894eb928c02ecc69c78715f01a8019e7fa7f2db4c" + +[[package]] +name = "libc" +version = "0.2.190" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce5d3ddc6d3fa000eb1536d85e147bfe31aacaba692ed6a876f95cb7c855be78" + +[[package]] +name = "libloading" +version = "0.8.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d7c4b02199fee7c5d21a5ae7d8cfa79a6ef5bb2fc834d6e9058e89c825efdc55" +dependencies = [ + "cfg-if", + "windows-link", +] + +[[package]] +name = "libredox" +version = "0.1.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61ff90caf6077a803a240f62fdbe88645a890bbca49ef8174c3cb0404362171d" +dependencies = [ + "libc", +] + +[[package]] +name = "linux-raw-sys" +version = "0.4.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d26c52dbd32dccf2d10cac7725f8eae5296885fb5703b261f7d0a0739ec807ab" + +[[package]] +name = "linux-raw-sys" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53" + +[[package]] +name = "litemap" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47d9d19d1d6efa0109d2f65ff4c85cddd50bd572e5a00127ab10987290bcefae" + +[[package]] +name = "lock_api" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "224399e74b87b5f3557511d98dff8b14089b3dadafcab6bb93eab67d3aace965" +dependencies = [ + "scopeguard", +] + +[[package]] +name = "log" +version = "0.4.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9f8bd3e56ce4dfc153cf470fffbfa98c7620958b312ca5c3a4b8d5181fd13c6" + +[[package]] +name = "lru-slab" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4050469837a6ff301cd14c1f8f24f88549e6d548f24f64e2148eb0f72cebc51f" + +[[package]] +name = "lzma-rust2" +version = "0.16.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca93e534d1142d1d0dcca6d25fe302508a5dfb40b302802904577725ea0b695b" +dependencies = [ + "sha2 0.11.0", +] + +[[package]] +name = "machine-uid" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfe0d6336d341b10ae80e099b8f3c59f34bf8aef66ef25e83aa98bf2955c0ae7" +dependencies = [ + "libc", + "windows-registry", + "windows-sys 0.61.2", +] + +[[package]] +name = "managed" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ca88d725a0a943b096803bd34e73a4437208b6077654cc4ecb2947a5f91618d" + +[[package]] +name = "md5" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "490cc448043f947bae3cbee9c203358d62dbee0db12107a74be5c30ccfd09771" + +[[package]] +name = "memchr" +version = "2.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98" + +[[package]] +name = "memoffset" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a" +dependencies = [ + "autocfg", +] + +[[package]] +name = "meshport" +version = "0.1.0" +dependencies = [ + "anyhow", + "meshport-easytier", + "meshport-netstack", + "serde", + "serde_json", + "tokio", +] + +[[package]] +name = "meshport-easytier" +version = "0.1.0" +dependencies = [ + "anyhow", + "async-trait", + "cidr", + "easytier", + "easytier-core", + "network-interface", + "serde", + "serde_json", + "tokio", + "toml 1.1.8+spec-1.1.0", +] + +[[package]] +name = "meshport-ffi" +version = "0.1.0" +dependencies = [ + "anyhow", + "meshport", + "meshport-easytier", + "serde_json", + "tokio", + "tracing", + "tracing-subscriber", +] + +[[package]] +name = "meshport-netstack" +version = "0.1.0" +dependencies = [ + "anyhow", + "easytier-core", + "tokio", +] + +[[package]] +name = "meshport-test-server" +version = "0.1.0" +dependencies = [ + "anyhow", + "tokio", +] + +[[package]] +name = "meshport-vpn-helper" +version = "0.1.0" +dependencies = [ + "anyhow", + "easytier", + "easytier-core", + "libc", + "meshport", + "meshport-easytier", + "meshport-ffi", + "serde_json", + "tokio", +] + +[[package]] +name = "mime" +version = "0.3.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a" + +[[package]] +name = "mio" +version = "1.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1788edb87fdc09c7e26304471e2f5be8cdefb1b6930d6e3985fc02ff53bf86ee" +dependencies = [ + "libc", + "wasi", + "windows-sys 0.61.2", +] + +[[package]] +name = "moka" +version = "0.12.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4293f18e7567a1caf3c584855554377025c65e0aa445344d04171f5ad63d19b9" +dependencies = [ + "async-lock", + "crossbeam-channel", + "crossbeam-epoch", + "crossbeam-utils", + "equivalent", + "event-listener", + "futures-util", + "parking_lot", + "portable-atomic", + "smallvec", + "tagptr", + "uuid", +] + +[[package]] +name = "multimap" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d87ecb2933e8aeadb3e3a02b828fed80a7528047e68b4f424523a0981a3a084" + +[[package]] +name = "multiversion_no_op" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "743fb55ba31b18fb1ecef6bdc9aa2743314978ac084044301a7eee33fb99a20d" + +[[package]] +name = "netlink-sys" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c99d38e00b420df49e940fe0826e667c3dad82ac68eb4c2bbf754c1c14a83a10" +dependencies = [ + "bytes", + "libc", + "log", +] + +[[package]] +name = "network-interface" +version = "2.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ddcb8865ad3d9950f22f42ffa0ef0aecbfbf191867b3122413602b0a360b2a6" +dependencies = [ + "cc", + "libc", + "thiserror 2.0.21", + "winapi", +] + +[[package]] +name = "nix" +version = "0.29.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "71e2746dc3a24dd78b3cfcb7be93368c6de9963d30f43a6a73998a9cf4b17b46" +dependencies = [ + "bitflags 2.13.2", + "cfg-if", + "cfg_aliases", + "libc", +] + +[[package]] +name = "nix" +version = "0.31.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf20d2fde8ff38632c426f1165ed7436270b44f199fc55284c38276f9db47c3d" +dependencies = [ + "bitflags 2.13.2", + "cfg-if", + "cfg_aliases", + "libc", + "memoffset", +] + +[[package]] +name = "nohash-hasher" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2bf50223579dc7cdcfb3bfcacf7069ff68243f8c363f62ffa99cf000a6b9c451" + +[[package]] +name = "normpath" +version = "1.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b11ce00d2594068e8a27c9146fdc5cf9f3ac38eb42c7cd34d05fea618873ac9f" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "num-conv" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "521739c6d2bac4aa25192232afe6841231376b2b26d4d9fae5ecf8ca5772e441" + +[[package]] +name = "num-traits" +version = "0.2.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" +dependencies = [ + "autocfg", +] + +[[package]] +name = "once_cell" +version = "1.21.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" + +[[package]] +name = "once_cell_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe" + +[[package]] +name = "opaque-debug" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c08d65885ee38876c4f86fa503fb49d7b507c2b62552df7c70b2fce627e06381" + +[[package]] +name = "openssl-probe" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c87def4c32ab89d880effc9e097653c8da5d6ef28e6b539d313baaacfbafcbe" + +[[package]] +name = "option-ext" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d" + +[[package]] +name = "ordered_hash_map" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e38d933ec41eca03e5f549db0529fa008f945d63cd66d491ed7f71376c1a94b5" +dependencies = [ + "hashbrown 0.15.5", +] + +[[package]] +name = "parking" +version = "2.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f38d5652c16fde515bb1ecef450ab0f6a219d619a7274976324d5e377f7dceba" + +[[package]] +name = "parking_lot" +version = "0.12.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93857453250e3077bd71ff98b6a65ea6621a19bb0f559a85248955ac12c45a1a" +dependencies = [ + "lock_api", + "parking_lot_core", +] + +[[package]] +name = "parking_lot_core" +version = "0.9.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2621685985a2ebf1c516881c026032ac7deafcda1a2c9b7850dc81e3dfcb64c1" +dependencies = [ + "cfg-if", + "libc", + "redox_syscall", + "smallvec", + "windows-link", +] + +[[package]] +name = "paste" +version = "1.0.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "57c0d7b74b563b49d38dae00a0c37d4d6de9b432382b2892f0574ddcae73fd0a" + +[[package]] +name = "pbjson" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e8edd1efdd8ab23ba9cb9ace3d9987a72663d5d7c9f74fa00b51d6213645cf6c" +dependencies = [ + "base64 0.22.1", + "serde", +] + +[[package]] +name = "pbjson-build" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ed4d5c6ae95e08ac768883c8401cf0e8deb4e6e1d6a4e1fd3d2ec4f0ec63200" +dependencies = [ + "heck", + "itertools 0.14.0", + "prost", + "prost-types", +] + +[[package]] +name = "pbkdf2" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "112d82ceb8c5bf524d9af484d4e4970c9fd5a0cc15ba14ad93dccd28873b0629" +dependencies = [ + "digest 0.11.3", + "hmac 0.13.0", +] + +[[package]] +name = "percent-encoding" +version = "2.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" + +[[package]] +name = "petgraph" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8701b58ea97060d5e5b155d383a69952a60943f0e6dfe30b04c287beb0b27455" +dependencies = [ + "fixedbitset", + "hashbrown 0.15.5", + "indexmap", + "serde", +] + +[[package]] +name = "pin-project-lite" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" + +[[package]] +name = "pkg-config" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6b464fbc74e149a392436b17d523f769e057cb6877f6a5c4618bc6f11800548" + +[[package]] +name = "plist" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2896bade328c13f7042a297ea5ac5b0951f6cf989dea5f32c2fd98da398195cb" +dependencies = [ + "base64 0.23.1", + "indexmap", + "quick-xml", + "serde", + "time", +] + +[[package]] +name = "poly1305" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8159bd90725d2df49889a078b54f4f79e87f1f8a8444194cdca81d38f5393abf" +dependencies = [ + "cpufeatures 0.2.17", + "opaque-debug", + "universal-hash", +] + +[[package]] +name = "polyval" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d1fe60d06143b2430aa532c94cfe9e29783047f06c0d7fd359a9a51b729fa25" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "opaque-debug", + "universal-hash", +] + +[[package]] +name = "portable-atomic" +version = "1.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "05c8b63e8d9609db387f0324918f81d68fe27748f084ef092fb35954d0539a85" + +[[package]] +name = "portable-atomic-util" +version = "0.2.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10ab3eb7f3becc3a1cbc4f2c6f20267996cfc1a6467a873763411b136a122715" +dependencies = [ + "portable-atomic", +] + +[[package]] +name = "potential_utf" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d83eb9bc6d8e5cf568e7a1101d60ee05e81ed50ea106026f3d18deeb046d7661" +dependencies = [ + "zerovec", +] + +[[package]] +name = "powerfmt" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a6394b9e965e73d0a289ee54f589087e2c676aedf60885baf52c76b771e4958" + +[[package]] +name = "ppmd-rust" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "196a7c80b9a7652aba7cc070827516c2abe4ccdf53d128e1944003cf5726cff1" + +[[package]] +name = "ppv-lite86" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9" +dependencies = [ + "zerocopy 0.8.62", +] + +[[package]] +name = "prefix-trie" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6369af434551b9bf8be05ab871ac1263687d6f0c9485e6d781f904f3e06d7d03" +dependencies = [ + "array-const-fn-init", + "cidr", + "either", + "ipnet", + "num-traits", + "smallvec", +] + +[[package]] +name = "prettyplease" +version = "0.2.37" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "479ca8adacdd7ce8f1fb39ce9ecccbfe93a3f1344b3d0d97f20bc0196208f62b" +dependencies = [ + "proc-macro2", + "syn 2.0.119", +] + +[[package]] +name = "prettyplease" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2bfe0f4c752e450fc2faf62654f1c134747922825d5b04ca717b8874f41a40c0" +dependencies = [ + "proc-macro2", + "syn 3.0.6", +] + +[[package]] +name = "proc-macro-crate" +version = "3.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e67ba7e9b2b56446f1d419b1d807906278ffa1a658a8a5d8a39dcb1f5a78614f" +dependencies = [ + "toml_edit 0.25.17+spec-1.1.0", +] + +[[package]] +name = "proc-macro2" +version = "1.0.107" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "prost" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "528ac67416ff8646872a3c02cad9cc4ee5dc9f9540c9b10771855c95cb2e5ae1" +dependencies = [ + "bytes", + "prost-derive", +] + +[[package]] +name = "prost-build" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03da047801ff44bb6a4d407d4860c05fd70bb81714e6b2f3812603d5b145b042" +dependencies = [ + "heck", + "itertools 0.14.0", + "log", + "multimap", + "petgraph", + "prettyplease 0.2.37", + "prost", + "prost-types", + "regex", + "syn 2.0.119", + "tempfile", +] + +[[package]] +name = "prost-derive" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b570b25f7617e43d59005d0990ccb79e950a423952cea19671b7a876da390adf" +dependencies = [ + "anyhow", + "itertools 0.14.0", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "prost-types" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f94967dc7688f3054c7fac87473ffae4cc4c3904800e2d9f5b857246d8963b0a" +dependencies = [ + "prost", +] + +[[package]] +name = "quanta" +version = "0.12.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3ab5a9d756f0d97bdc89019bd2e4ea098cf9cde50ee7564dde6b81ccc8f06c7" +dependencies = [ + "crossbeam-utils", + "libc", + "once_cell", + "raw-cpuid", + "wasi", + "web-sys", + "winapi", +] + +[[package]] +name = "quick-xml" +version = "0.42.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41b1177fdf999d2321d3fb46ff47159d9c1fb9ad66a4879f8c50a0b504615e9b" +dependencies = [ + "memchr", +] + +[[package]] +name = "quinn" +version = "0.11.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4051e23e9185c255a7e33ef59cdbca87a22d359052eecd22fc6b901fb37d9d11" +dependencies = [ + "bytes", + "cfg_aliases", + "pin-project-lite", + "quinn-proto", + "quinn-udp", + "rustc-hash", + "rustls", + "socket2", + "thiserror 2.0.21", + "tokio", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-proto" +version = "0.11.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0e750cca55fe4f0439a15d0bb529da9651e79993e8e72c61a899a36d462befbe" +dependencies = [ + "aws-lc-rs", + "bytes", + "getrandom 0.4.3", + "lru-slab", + "rand 0.10.3", + "rand_pcg", + "ring", + "rustc-hash", + "rustls", + "rustls-pki-types", + "slab", + "thiserror 2.0.21", + "tinyvec", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-udp" +version = "0.5.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af66907df18639dcf4db56ca65490cabc4b27a97dbadd96f2926cca73298f016" +dependencies = [ + "cfg_aliases", + "libc", + "once_cell", + "socket2", + "tracing", + "windows-sys 0.61.2", +] + +[[package]] +name = "quote" +version = "1.0.47" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "r-efi" +version = "5.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "69cdb34c158ceb288df11e18b4bd39de994f6657d83847bdffdbd7f346754b0f" + +[[package]] +name = "r-efi" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf" + +[[package]] +name = "rand" +version = "0.8.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e058c7de0b26af77780c769414d6257830bb240f3c38477dbc2c16e5f54d6d4c" +dependencies = [ + "libc", + "rand_chacha", + "rand_core 0.6.4", +] + +[[package]] +name = "rand" +version = "0.10.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65c9fb96cbc91e3478eaae79a69fcd3f1ae4ad052e471fe6732fff548984b4af" +dependencies = [ + "chacha20 0.10.2", + "getrandom 0.4.3", + "rand_core 0.10.1", +] + +[[package]] +name = "rand_chacha" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88" +dependencies = [ + "ppv-lite86", + "rand_core 0.6.4", +] + +[[package]] +name = "rand_core" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c" +dependencies = [ + "getrandom 0.2.17", +] + +[[package]] +name = "rand_core" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63b8176103e19a2643978565ca18b50549f6101881c443590420e4dc998a3c69" + +[[package]] +name = "rand_pcg" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "caa0f4137e1c0a72f4c651489402276c8e8e1cf081f3b0ba156d2cbeef09e86a" +dependencies = [ + "rand_core 0.10.1", +] + +[[package]] +name = "raw-cpuid" +version = "11.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "498cd0dc59d73224351ee52a95fee0f1a617a2eae0e7d9d720cc622c73a54186" +dependencies = [ + "bitflags 2.13.2", +] + +[[package]] +name = "redox_syscall" +version = "0.5.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed2bf2547551a7053d6fdfafda3f938979645c44812fbfcda098faae3f1a362d" +dependencies = [ + "bitflags 2.13.2", +] + +[[package]] +name = "redox_users" +version = "0.4.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba009ff324d1fc1b900bd1fdb31564febe58a8ccc8a6fdbb93b543d33b13ca43" +dependencies = [ + "getrandom 0.2.17", + "libredox", + "thiserror 1.0.69", +] + +[[package]] +name = "redox_users" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60dc65c0ff1a7ae1294b0c67b9f14baf70b644404010370171787bfac1038fc0" +dependencies = [ + "libredox", + "thiserror 2.0.21", +] + +[[package]] +name = "regex" +version = "1.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f020237b6c8eed93db2e2cb53c00c60a8e1bc73da7d073199a1180401450218d" +dependencies = [ + "aho-corasick", + "memchr", + "regex-automata", + "regex-syntax", +] + +[[package]] +name = "regex-automata" +version = "0.4.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ad8553b9b26413251cbf30e620595c7a41b3887f03da04579c0e6b0d6a06b4b2" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.8.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4" + +[[package]] +name = "reqwest" +version = "0.13.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16a1cfa75cc186dd73d5818e510e042e40927bccc9c236b061cea97e1eb08029" +dependencies = [ + "base64 0.23.1", + "bytes", + "encoding_rs", + "futures-channel", + "futures-core", + "futures-util", + "h2", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-rustls", + "hyper-util", + "js-sys", + "log", + "mime", + "percent-encoding", + "pin-project-lite", + "quinn", + "rustls", + "rustls-pki-types", + "rustls-platform-verifier", + "sync_wrapper", + "tokio", + "tokio-rustls", + "tower", + "tower-http", + "tower-service", + "url", + "wasm-bindgen", + "wasm-bindgen-futures", + "web-sys", +] + +[[package]] +name = "ring" +version = "0.17.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4689e6c2294d81e88dc6261c768b63bc4fcdb852be6d1352498b114f61383b7" +dependencies = [ + "cc", + "cfg-if", + "getrandom 0.2.17", + "libc", + "untrusted", + "windows-sys 0.52.0", +] + +[[package]] +name = "ringbuf" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b58b631e416dd7d84549d7e6a50f767e111f9b03e30d04f40072f6618f386aaf" +dependencies = [ + "crossbeam-utils", + "portable-atomic", + "portable-atomic-util", +] + +[[package]] +name = "rust-i18n" +version = "4.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8502e73e6461c738659455c5d2cf95bc132760a6f203c717e66ee72b78906d7f" +dependencies = [ + "globwalk 0.8.1", + "regex", + "rust-i18n-macro", + "rust-i18n-support", + "smallvec", +] + +[[package]] +name = "rust-i18n-macro" +version = "4.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d54a28dd9d46108d56b9f0c85b220908844233e561c03087890325104f90f2c6" +dependencies = [ + "glob", + "proc-macro2", + "quote", + "rust-i18n-support", + "serde", + "serde_json", + "syn 2.0.119", +] + +[[package]] +name = "rust-i18n-support" +version = "4.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e806c2a9701cbd6043992cd935c30cb1fdb128fa15e7b506f3b46f97045737c0" +dependencies = [ + "arc-swap", + "base62", + "foldhash 0.2.0", + "globwalk 0.8.1", + "itertools 0.11.0", + "normpath", + "serde", + "serde-saphyr", + "serde_json", + "siphasher", + "toml 0.8.23", + "triomphe", +] + +[[package]] +name = "rustc-hash" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b1e7f9a428571be2dc5bc0505c13fb6bf936822b894ec87abf8a08a4e51742d" + +[[package]] +name = "rustc_version" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfcb3a22ef46e85b45de6ee7e79d063319ebb6594faafcf1c225ea92ab6e9b92" +dependencies = [ + "semver", +] + +[[package]] +name = "rustix" +version = "0.38.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fdb5bc1ae2baa591800df16c9ca78619bf65c0488b41b96ccec5d11220d8c154" +dependencies = [ + "bitflags 2.13.2", + "errno", + "libc", + "linux-raw-sys 0.4.15", + "windows-sys 0.59.0", +] + +[[package]] +name = "rustix" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "891efababe418670775f199f0d233d84843c227a0949a883ce15b37c78d6629d" +dependencies = [ + "bitflags 2.13.2", + "errno", + "libc", + "linux-raw-sys 0.12.1", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustls" +version = "0.23.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d41d731c7d2f962d1ccc364cec258de3c0e93b38c2fb3ba97ac74513048d634" +dependencies = [ + "aws-lc-rs", + "once_cell", + "rustls-pki-types", + "rustls-webpki", + "subtle", + "zeroize", +] + +[[package]] +name = "rustls-native-certs" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dab5152771c58876a2146916e53e35057e1a4dfa2b9df0f0305b07f611fdea4d" +dependencies = [ + "openssl-probe", + "rustls-pki-types", + "schannel", + "security-framework", +] + +[[package]] +name = "rustls-pki-types" +version = "1.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2f4925028c7eb5d1fcdaf196971378ed9d2c1c4efc7dc5d011256f76c99c0a96" +dependencies = [ + "web-time", + "zeroize", +] + +[[package]] +name = "rustls-platform-verifier" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1167586491e2b18b8bfbb293e8180ec17c201c4f076d7cb3070ca964e7598f98" +dependencies = [ + "core-foundation 0.10.1", + "core-foundation-sys", + "jni", + "log", + "once_cell", + "rustls", + "rustls-native-certs", + "rustls-platform-verifier-android", + "rustls-webpki", + "security-framework", + "security-framework-sys", + "webpki-root-certs", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustls-platform-verifier-android" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eec689c0bc40ff2458a5977b6619cb718087084a18e02a131c599b62d05e1a5f" + +[[package]] +name = "rustls-webpki" +version = "0.103.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3c3cf1d8b1e7d4927e2d154c3fcb02979afb9939629c62cd9048d4f07b60ac2" +dependencies = [ + "aws-lc-rs", + "ring", + "rustls-pki-types", + "untrusted", +] + +[[package]] +name = "rustversion" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f" + +[[package]] +name = "same-file" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "schannel" +version = "0.1.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91c1b7e4904c873ef0710c1f407dde2e6287de2bebc1bbbf7d430bb7cbffd939" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "scopeguard" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" + +[[package]] +name = "security-framework" +version = "3.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7f4bc775c73d9a02cde8bf7b2ec4c9d12743edf609006c7facc23998404cd1d" +dependencies = [ + "bitflags 2.13.2", + "core-foundation 0.10.1", + "core-foundation-sys", + "libc", + "security-framework-sys", +] + +[[package]] +name = "security-framework-sys" +version = "2.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2691df843ecc5d231c0b14ece2acc3efb62c0a398c7e1d875f3983ce020e3" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "semver" +version = "1.0.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a7852d02fc848982e0c167ef163aaff9cd91dc640ba85e263cb1ce46fae51cd" + +[[package]] +name = "serde" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4148590afebada386688f18773da617792bf2ef03ffc1e4cbd2b1d45b023e0ba" +dependencies = [ + "serde_core", + "serde_derive", +] + +[[package]] +name = "serde-saphyr" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8050abb251097357e24aff63ba2c52a6309ecb7d23a5474023df960a02694d8" +dependencies = [ + "annotate-snippets", + "base64 0.23.1", + "encoding_rs_io", + "granit-parser", + "nohash-hasher", + "num-traits", + "serde_core", + "smallvec", + "zmij", +] + +[[package]] +name = "serde_core" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67dca2c9c51e58a4791a4b1ed58308b39c64224d349a935ab5039aa360942a48" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "serde_json" +version = "1.0.151" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c841b55ecdae098c80dcae9cf767f6f8a0c2cdb3416bbef72181df4d0fe73f14" +dependencies = [ + "itoa", + "memchr", + "serde", + "serde_core", + "zmij", +] + +[[package]] +name = "serde_spanned" +version = "0.6.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf41e0cfaf7226dca15e8197172c295a782857fcb97fad1808a166870dee75a3" +dependencies = [ + "serde", +] + +[[package]] +name = "serde_spanned" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e7523beb55eece201a2356bee0bbca0d1ab466c14c07703b2e0ee6d42cb0c2c" +dependencies = [ + "serde_core", +] + +[[package]] +name = "service-manager" +version = "0.8.0" +source = "git+https://github.com/EasyTier/service-manager-rs.git?branch=main#5eb28f7a686858eea4f4933534ed989d3b71dc2a" +dependencies = [ + "cfg-if", + "dirs 4.0.0", + "encoding-utils", + "encoding_rs", + "plist", + "sys-info", + "which", + "xml-rs", +] + +[[package]] +name = "sha1" +version = "0.10.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a978451301f4db1d02937a4ab3ccce137717b81826e79b7d49ffe3244a13c3b8" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "digest 0.10.7", +] + +[[package]] +name = "sha1" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aacc4cc499359472b4abe1bf11d0b12e688af9a805fa5e3016f9a386dc2d0214" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.1", + "digest 0.11.3", +] + +[[package]] +name = "sha2" +version = "0.10.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a7507d819769d01a365ab707794a4084392c824f54a7a6a7862f8c3d0892b283" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "digest 0.10.7", +] + +[[package]] +name = "sha2" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "446ba717509524cb3f22f17ecc096f10f4822d76ab5c0b9822c5f9c284e825f4" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.1", + "digest 0.11.3", +] + +[[package]] +name = "sharded-slab" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f40ca3c46823713e0d4209592e8d6e826aa57e928f09752619fc696c499637f6" +dependencies = [ + "lazy_static", +] + +[[package]] +name = "shellexpand" +version = "3.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32824fab5e16e6c4d86dc1ba84489390419a39f97699852b66480bb87d297ed8" +dependencies = [ + "dirs 6.0.0", +] + +[[package]] +name = "shlex" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba" + +[[package]] +name = "signal-hook-registry" +version = "1.4.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4db69cba1110affc0e9f7bcd48bbf87b3f4fc7c61fc9155afd4c469eb3d6c1b" +dependencies = [ + "errno", + "libc", +] + +[[package]] +name = "simd-adler32" +version = "0.3.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3a219298ac11a56ea9a6d2120044824d6f01aeb034955e7af7bc16858527deea" + +[[package]] +name = "simd_cesu8" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "11031e251abf8611c80f460e19dbdeb54a66db918e49c65a7065b46ac7aec520" +dependencies = [ + "rustc_version", + "simdutf8", +] + +[[package]] +name = "simdutf8" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3a9fe34e3e7a50316060351f37187a3f546bce95496156754b601a5fa71b76e" + +[[package]] +name = "siphasher" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33f4fe9184a62d842c9ef383018f3306d8ba224fd9d836f56d7288308847c256" + +[[package]] +name = "slab" +version = "0.4.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5" + +[[package]] +name = "smallvec" +version = "1.16.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9395f0f0eee849a9b707b2f06bb92a6a422090e2123bb2ef8e87a0e61892a8e" + +[[package]] +name = "smoltcp" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6f8b28ad56c6e35524a37dd492af5d1a47e31e1a4d175cd12f89c075f01980f" +dependencies = [ + "bitflags 1.3.2", + "byteorder", + "cfg-if", + "defmt", + "heapless", + "managed", +] + +[[package]] +name = "snow" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "599b506ccc4aff8cf7844bc42cf783009a434c1e26c964432560fb6d6ad02d82" +dependencies = [ + "chacha20poly1305", + "curve25519-dalek", + "getrandom 0.3.4", + "rustc_version", + "sha2 0.10.9", + "subtle", +] + +[[package]] +name = "socket2" +version = "0.6.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3d1e2c7f27f8d4cb10542a02c49005dbd6e93095799d6f3be745fae9f8fedd4" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "stable_deref_trait" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596" + +[[package]] +name = "strsim" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" + +[[package]] +name = "strum" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9628de9b8791db39ceda2b119bbe13134770b56c138ec1d3af810d045c04f9bd" +dependencies = [ + "strum_macros", +] + +[[package]] +name = "strum_macros" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ab85eea0270ee17587ed4156089e10b9e6880ee688791d45a905f5b1ca36f664" +dependencies = [ + "heck", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "stun_codec" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2663da41e3e056af18e2ec9ca537d53a4667798fdf92684f9848bd248263223a" +dependencies = [ + "bytecodec", + "byteorder", + "crc", + "hmac 0.12.1", + "md5", + "sha1 0.10.7", + "trackable", +] + +[[package]] +name = "subtle" +version = "2.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292" + +[[package]] +name = "syn" +version = "1.0.109" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syn" +version = "2.0.119" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syn" +version = "3.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8593e8e72159ed2257d083c7a454a85cbf854f37a0966d8d483aff8c8a3ebcee" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "sync_wrapper" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf256ce5efdfa370213c1dabab5935a12e49f2c58d15e9eac2870d3b4f27263" +dependencies = [ + "futures-core", +] + +[[package]] +name = "synstructure" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "901704edd0dfe137f1987838ee4f259e4e063c31371bdb423f7ae38ec6f77f02" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "sys-info" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b3a0d0aba8bf96a0e1ddfdc352fc53b3df7f39318c71854910c3c4b024ae52c" +dependencies = [ + "cc", + "libc", +] + +[[package]] +name = "sys-locale" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8eab9a99a024a169fe8a903cf9d4a3b3601109bcc13bd9e3c6fff259138626c4" +dependencies = [ + "libc", +] + +[[package]] +name = "system-configuration" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a13f3d0daba03132c0aa9767f98351b3488edc2c100cda2d2ec2b04f3d8d3c8b" +dependencies = [ + "bitflags 2.13.2", + "core-foundation 0.9.4", + "system-configuration-sys", +] + +[[package]] +name = "system-configuration-sys" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e1d1b10ced5ca923a1fcb8d03e96b8d3268065d724548c0211415ff6ac6bac4" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "tagptr" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b2093cf4c8eb1e67749a6762251bc9cd836b6fc171623bd0a9d324d37af2417" + +[[package]] +name = "tempfile" +version = "3.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd" +dependencies = [ + "fastrand", + "once_cell", + "rustix 1.1.5", + "windows-sys 0.61.2", +] + +[[package]] +name = "terminal_size" +version = "0.4.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "230a1b821ccbd75b185820a1f1ff7b14d21da1e442e22c0863ea5f08771a8874" +dependencies = [ + "rustix 1.1.5", + "windows-sys 0.61.2", +] + +[[package]] +name = "thiserror" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52" +dependencies = [ + "thiserror-impl 1.0.69", +] + +[[package]] +name = "thiserror" +version = "2.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09e52cb86a36cede5cb101bf8908837b3e4c6e5e59fe7fd85c23fb56200d189e" +dependencies = [ + "thiserror-impl 2.0.21", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "thiserror-impl" +version = "2.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fe5197923287db20a58125f0bc85c062f7f2c892de97b18c356f9efb14b28524" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "thread_local" +version = "1.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ad99c4c6d32803332c548b1af0540b357b3f5fc0be8f6c6bfe8b2e6ae784070" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "thunk-rs" +version = "0.3.5" +source = "git+https://github.com/EasyTier/thunk.git#cbbeec75a66b7b3cf0824ae890d9d06bcfb9d1f3" + +[[package]] +name = "time" +version = "0.3.55" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cdb87b95ec50ddfa440816d227a17b2ccbdda963a316a727fda0fc4334f7d134" +dependencies = [ + "deranged", + "js-sys", + "num-conv", + "powerfmt", + "serde_core", + "time-core", + "time-macros", +] + +[[package]] +name = "time-core" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e1c906769ad99c88eaa54e728060edef082f8e358ff32030cb7c7d315e81109" + +[[package]] +name = "time-macros" +version = "0.2.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e689342a48d2ea927c87ea50cabf8594854bf940e9310208848d680d668ed85" +dependencies = [ + "num-conv", + "time-core", +] + +[[package]] +name = "tinystr" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1e27c91459209c2986af3dcf603a5a74a4368754ce37414f59acc971167f643" +dependencies = [ + "displaydoc", + "zerovec", +] + +[[package]] +name = "tinyvec" +version = "1.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd3ca314f692efd6c868f8408f53fe444634a845f96c028b97d35f6a1f79f0ee" + +[[package]] +name = "tokio" +version = "1.53.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e95f91fcc7a621e8b030f6aa23c71fe9838ae2fb4d8118b75602a328f5144044" +dependencies = [ + "bytes", + "libc", + "mio", + "pin-project-lite", + "signal-hook-registry", + "socket2", + "tokio-macros", + "windows-sys 0.61.2", +] + +[[package]] +name = "tokio-macros" +version = "2.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78773a2a397f451582ce068015985c33193cf6dea8b74d2a639fe457b2f07b0e" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "tokio-rustls" +version = "0.26.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c9cc2678c2cdd569ef8215e2afd7954ada2ae20b4fdd2c5fe6139a3b02d105db" +dependencies = [ + "rustls", + "tokio", +] + +[[package]] +name = "tokio-util" +version = "0.7.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "494815d09bf52b5548659851081238f0ca39ff638363907596da739561c62c52" +dependencies = [ + "bytes", + "futures-core", + "futures-sink", + "futures-util", + "libc", + "pin-project-lite", + "tokio", +] + +[[package]] +name = "toml" +version = "0.8.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc1beb996b9d83529a9e75c17a1686767d148d70663143c7854d8b4a09ced362" +dependencies = [ + "serde", + "serde_spanned 0.6.9", + "toml_datetime 0.6.11", + "toml_edit 0.22.27", +] + +[[package]] +name = "toml" +version = "1.1.8+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "20489e00e4d8741d6be680764cc12e270655e375a20d1011e844a9c3379e678d" +dependencies = [ + "indexmap", + "serde_core", + "serde_spanned 1.1.2", + "toml_datetime 1.1.2+spec-1.1.0", + "toml_parser", + "toml_writer", + "winnow 1.0.4", +] + +[[package]] +name = "toml_datetime" +version = "0.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "22cddaf88f4fbc13c51aebbf5f8eceb5c7c5a9da2ac40a13519eb5b0a0e8f11c" +dependencies = [ + "serde", +] + +[[package]] +name = "toml_datetime" +version = "1.1.2+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b86d767906c6c42421dcba507eb9d203e779497710a47782a224bb871653053" +dependencies = [ + "serde_core", +] + +[[package]] +name = "toml_edit" +version = "0.22.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41fe8c660ae4257887cf66394862d21dbca4a6ddd26f04a3560410406a2f819a" +dependencies = [ + "indexmap", + "serde", + "serde_spanned 0.6.9", + "toml_datetime 0.6.11", + "toml_write", + "winnow 0.7.15", +] + +[[package]] +name = "toml_edit" +version = "0.25.17+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3641d5bbb5349a79e1020a242d251efbc546ad8048d133958323ce9c40a9c9c" +dependencies = [ + "indexmap", + "toml_datetime 1.1.2+spec-1.1.0", + "toml_parser", + "winnow 1.0.4", +] + +[[package]] +name = "toml_parser" +version = "1.1.5+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "baa693a8032d7e1cada7d0041e96126df243179ff061456783ac7f12bda4744c" +dependencies = [ + "winnow 1.0.4", +] + +[[package]] +name = "toml_write" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d99f8c9a7727884afe522e9bd5edbfc91a3312b36a77b5fb8926e4c31a41801" + +[[package]] +name = "toml_writer" +version = "1.1.3+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06bdbd8cfc056b8d2e2e85f29b56a3bdbecb527cef81eb39e3e7b98af4652770" + +[[package]] +name = "tower" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebe5ef63511595f1344e2d5cfa636d973292adc0eec1f0ad45fae9f0851ab1d4" +dependencies = [ + "futures-core", + "futures-util", + "pin-project-lite", + "sync_wrapper", + "tokio", + "tower-layer", + "tower-service", +] + +[[package]] +name = "tower-http" +version = "0.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4cfcf7e2740e6fc6d4d688b4ef00650406bb94adf4731e43c096c3a19fe40840" +dependencies = [ + "bitflags 2.13.2", + "bytes", + "futures-util", + "http", + "http-body", + "pin-project-lite", + "tower", + "tower-layer", + "tower-service", + "url", +] + +[[package]] +name = "tower-layer" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e" + +[[package]] +name = "tower-service" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" + +[[package]] +name = "tracing" +version = "0.1.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63e71662fa4b2a2c3a26f570f037eb95bb1f85397f3cd8076caed2f026a6d100" +dependencies = [ + "pin-project-lite", + "tracing-attributes", + "tracing-core", +] + +[[package]] +name = "tracing-attributes" +version = "0.1.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7490cfa5ec963746568740651ac6781f701c9c5ea257c58e057f3ba8cf69e8da" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "tracing-core" +version = "0.1.36" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db97caf9d906fbde555dd62fa95ddba9eecfd14cb388e4f491a66d74cd5fb79a" +dependencies = [ + "once_cell", +] + +[[package]] +name = "tracing-subscriber" +version = "0.3.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb7f578e5945fb242538965c2d0b04418d38ec25c79d160cd279bf0731c8d319" +dependencies = [ + "sharded-slab", + "thread_local", + "tracing-core", +] + +[[package]] +name = "trackable" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b15bd114abb99ef8cee977e517c8f37aee63f184f2d08e3e6ceca092373369ae" +dependencies = [ + "trackable_derive", +] + +[[package]] +name = "trackable_derive" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebeb235c5847e2f82cfe0f07eb971d1e5f6804b18dac2ae16349cc604380f82f" +dependencies = [ + "quote", + "syn 1.0.109", +] + +[[package]] +name = "triomphe" +version = "0.1.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b40688ea6389c8171614b25491f71d4a27946e0c7ce2da1c6de27e25abf1a0ae" +dependencies = [ + "arc-swap", + "serde", + "stable_deref_trait", +] + +[[package]] +name = "try-lock" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b" + +[[package]] +name = "tun-easytier" +version = "1.1.1" +source = "git+https://github.com/EasyTier/rust-tun#12378839e7985283df0e4fb536b7137230356db5" +dependencies = [ + "bytes", + "cfg-if", + "futures-core", + "ipnet", + "libc", + "libloading", + "log", + "nix 0.29.0", + "thiserror 1.0.69", + "tokio", + "tokio-util", + "windows-sys 0.59.0", + "wintun", +] + +[[package]] +name = "typed-path" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e28f89b80c87b8fb0cf04ab448d5dd0dd0ade2f8891bae878de66a75a28600e" + +[[package]] +name = "typenum" +version = "1.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20" + +[[package]] +name = "unicase" +version = "2.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "357cc3acc6a036009fd6c973ed009037c732d60d0b4f6c673e9041497482a28f" + +[[package]] +name = "unicode-ident" +version = "1.0.26" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d245f478577f809a851594d02313b640fb437e0bb33866753cff937863096954" + +[[package]] +name = "unicode-segmentation" +version = "1.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6f5d3c3b1bf09027a88a6bc961fc00497d651009560b5463668dc81b0fa87a8" + +[[package]] +name = "unicode-width" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b4ac048d71ede7ee76d585517add45da530660ef4390e49b098733c6e897f254" + +[[package]] +name = "unicode-xid" +version = "0.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853" + +[[package]] +name = "universal-hash" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc1de2c688dc15305988b563c3854064043356019f97a4b46276fe734c4f07ea" +dependencies = [ + "crypto-common 0.1.7", + "subtle", +] + +[[package]] +name = "untrusted" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1" + +[[package]] +name = "url" +version = "2.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff67a8a4397373c3ef660812acab3268222035010ab8680ec4215f38ba3d0eed" +dependencies = [ + "form_urlencoded", + "idna", + "percent-encoding", + "serde", + "serde_derive", +] + +[[package]] +name = "utf8_iter" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" + +[[package]] +name = "utf8parse" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" + +[[package]] +name = "uuid" +version = "1.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "97277d36b9c3ace13e58fa6e753f8b0bbbf302a18dd193240d70f9e29681059a" +dependencies = [ + "getrandom 0.4.3", + "js-sys", + "rand 0.10.3", + "serde_core", + "wasm-bindgen", +] + +[[package]] +name = "version_check" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" + +[[package]] +name = "walkdir" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29790946404f91d9c5d06f9874efddea1dc06c5efe94541a7d6863108e3a5e4b" +dependencies = [ + "same-file", + "winapi-util", +] + +[[package]] +name = "want" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec4cdd0dd910afe868b7ef477227d8d538b46b3075031afee8a9f2acb0a2ed0b" +dependencies = [ + "try-lock", +] + +[[package]] +name = "wasi" +version = "0.11.1+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b" + +[[package]] +name = "wasip2" +version = "1.0.4+wasi-0.2.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b67efb37e106e55ce722a510d6b5f9c17f083e5fc79afc2badeb12cc313d9487" +dependencies = [ + "wit-bindgen", +] + +[[package]] +name = "wasm-bindgen" +version = "0.2.129" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9bb54f33acc68fd454578d9820b0bde1a1a3d17aa17bb7b6595806d02886d409" +dependencies = [ + "cfg-if", + "once_cell", + "rustversion", + "wasm-bindgen-macro", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-futures" +version = "0.4.79" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3cbab34de2d982e9b48e18d216d04c4a6f641066ff19ffb699980f591ee3610e" +dependencies = [ + "js-sys", + "tokio", + "wasm-bindgen", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.129" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2e29d0c35b16e224a7eeb5cd2d25e3e1968fbd65604117b44d3b789d00ee8535" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.129" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6f501a8bc3719dba86ef8ae4728879c08001bea749eb1333ac5b91e040e2a6b7" +dependencies = [ + "bumpalo", + "proc-macro2", + "quote", + "syn 3.0.6", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.129" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23f0c9c52aa7cd7d77769a4cfe2a9adb1b331f489a41d912ce14513d5ab995c6" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "web-sys" +version = "0.3.106" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "88261b9deccee56594c11a3460c462c41f58d148598fe70ad77070126a68aba4" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "web-time" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a6580f308b1fad9207618087a65c04e7a10bc77e02c8e84e9b00dd4b12fa0bb" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "webpki-root-certs" +version = "1.0.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b96554aa2acc8ccdb7e1c9a58a7a68dd5d13bccc69cd124cb09406db612a1c9b" +dependencies = [ + "rustls-pki-types", +] + +[[package]] +name = "which" +version = "4.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "87ba24419a2078cd2b0f2ede2691b6c66d8e47836da3b6db8265ebad47afbfc7" +dependencies = [ + "either", + "home", + "once_cell", + "rustix 0.38.44", +] + +[[package]] +name = "widestring" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72069c3113ab32ab29e5584db3c6ec55d416895e60715417b5b883a357c3e471" + +[[package]] +name = "wildmatch" +version = "2.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29333c3ea1ba8b17211763463ff24ee84e41c78224c16b001cd907e663a38c68" + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-util" +version = "0.1.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2a7b1c03c876122aa43f3020e6c3c3ee5c05081c9a00739faf7503aeba10d22" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" + +[[package]] +name = "windivert" +version = "0.6.0" +source = "git+https://github.com/EasyTier/windivert-rust.git?rev=adcc56d1550f7b5377ec2b3429f413ee24a77375#adcc56d1550f7b5377ec2b3429f413ee24a77375" +dependencies = [ + "etherparse", + "thiserror 1.0.69", + "windivert-sys", + "windows 0.48.0", +] + +[[package]] +name = "windivert-sys" +version = "0.10.0" +source = "git+https://github.com/EasyTier/windivert-rust.git?rev=adcc56d1550f7b5377ec2b3429f413ee24a77375#adcc56d1550f7b5377ec2b3429f413ee24a77375" +dependencies = [ + "cc", + "thiserror 1.0.69", + "windows 0.48.0", +] + +[[package]] +name = "windows" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e686886bc078bc1b0b600cac0147aadb815089b6e4da64016cbd754b6342700f" +dependencies = [ + "windows-targets 0.48.5", +] + +[[package]] +name = "windows" +version = "0.62.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "527fadee13e0c05939a6a05d5bd6eec6cd2e3dbd648b9f8e447c6518133d8580" +dependencies = [ + "windows-collections", + "windows-core", + "windows-future", + "windows-numerics", +] + +[[package]] +name = "windows-collections" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23b2d95af1a8a14a3c7367e1ed4fc9c20e0a26e79551b1454d72583c97cc6610" +dependencies = [ + "windows-core", +] + +[[package]] +name = "windows-core" +version = "0.62.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8e83a14d34d0623b51dce9581199302a221863196a1dde71a7663a4c2be9deb" +dependencies = [ + "windows-implement", + "windows-interface", + "windows-link", + "windows-result", + "windows-strings", +] + +[[package]] +name = "windows-future" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e1d6f90251fe18a279739e78025bd6ddc52a7e22f921070ccdc67dde84c605cb" +dependencies = [ + "windows-core", + "windows-link", + "windows-threading", +] + +[[package]] +name = "windows-implement" +version = "0.60.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "053e2e040ab57b9dc951b72c264860db7eb3b0200ba345b4e4c3b14f67855ddf" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "windows-interface" +version = "0.59.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f316c4a2570ba26bbec722032c4099d8c8bc095efccdc15688708623367e358" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "windows-link" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" + +[[package]] +name = "windows-numerics" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e2e40844ac143cdb44aead537bbf727de9b044e107a0f1220392177d15b0f26" +dependencies = [ + "windows-core", + "windows-link", +] + +[[package]] +name = "windows-registry" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "02752bf7fbdcce7f2a27a742f798510f3e5ad88dbe84871e5168e2120c3d5720" +dependencies = [ + "windows-link", + "windows-result", + "windows-strings", +] + +[[package]] +name = "windows-result" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7781fa89eaf60850ac3d2da7af8e5242a5ea78d1a11c49bf2910bb5a73853eb5" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows-service" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "857224b3b211c6f3616921f081ee54721ee3ad2ace2fac6a6337e032f7b4dcf2" +dependencies = [ + "bitflags 2.13.2", + "widestring", + "windows-sys 0.61.2", +] + +[[package]] +name = "windows-strings" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7837d08f69c77cf6b07689544538e017c1bfcf57e34b4c0ff58e6c2cd3b37091" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows-sys" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" +dependencies = [ + "windows-targets 0.52.6", +] + +[[package]] +name = "windows-sys" +version = "0.59.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b" +dependencies = [ + "windows-targets 0.52.6", +] + +[[package]] +name = "windows-sys" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows-targets" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c" +dependencies = [ + "windows_aarch64_gnullvm 0.48.5", + "windows_aarch64_msvc 0.48.5", + "windows_i686_gnu 0.48.5", + "windows_i686_msvc 0.48.5", + "windows_x86_64_gnu 0.48.5", + "windows_x86_64_gnullvm 0.48.5", + "windows_x86_64_msvc 0.48.5", +] + +[[package]] +name = "windows-targets" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" +dependencies = [ + "windows_aarch64_gnullvm 0.52.6", + "windows_aarch64_msvc 0.52.6", + "windows_i686_gnu 0.52.6", + "windows_i686_gnullvm", + "windows_i686_msvc 0.52.6", + "windows_x86_64_gnu 0.52.6", + "windows_x86_64_gnullvm 0.52.6", + "windows_x86_64_msvc 0.52.6", +] + +[[package]] +name = "windows-threading" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3949bd5b99cafdf1c7ca86b43ca564028dfe27d66958f2470940f73d86d75b37" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" + +[[package]] +name = "windows_i686_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" + +[[package]] +name = "windows_i686_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" + +[[package]] +name = "windows_i686_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" + +[[package]] +name = "windows_i686_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" + +[[package]] +name = "winnow" +version = "0.7.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df79d97927682d2fd8adb29682d1140b343be4ac0f08fd68b7765d9c059d3945" +dependencies = [ + "memchr", +] + +[[package]] +name = "winnow" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23b97319f7b8343df12cc98938e5c3eb436064524c8d2b4e30a1d3a36eecdf81" +dependencies = [ + "memchr", +] + +[[package]] +name = "winreg" +version = "0.56.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d6f32a0ff4a9f6f01231eb2059cc85479330739333e0e58cadf03b6af2cca10" +dependencies = [ + "cfg-if", + "windows-sys 0.61.2", +] + +[[package]] +name = "wintun" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da99be64b5aa3de869c16977994314d0759a698d9a73ab0a5b1d52e2282033ae" +dependencies = [ + "c2rust-bitfields", + "libloading", + "log", + "thiserror 1.0.69", + "windows-sys 0.52.0", +] + +[[package]] +name = "wit-bindgen" +version = "0.57.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ebf944e87a7c253233ad6766e082e3cd714b5d03812acc24c318f549614536e" + +[[package]] +name = "writeable" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ad82d2a33cdc9674dc7465672f271e096168fcdbe0f799d9e6db8c5892679dc" + +[[package]] +name = "x25519-dalek" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7e468321c81fb07fa7f4c636c3972b9100f0346e5b6a9f2bd0603a52f7ed277" +dependencies = [ + "curve25519-dalek", + "rand_core 0.6.4", + "serde", + "zeroize", +] + +[[package]] +name = "xml-rs" +version = "0.8.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e450f9b2ed1dff33c94c12589a87338689467b9c4f5d8a5710bd09a847d2c8a7" + +[[package]] +name = "yoke" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "709fe23a0424b6a435d82152b1bd3fdfb0833487d5fa90d05d42762a9891fef5" +dependencies = [ + "stable_deref_trait", + "yoke-derive", + "zerofrom", +] + +[[package]] +name = "yoke-derive" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec8ebde2db3681e8c9980cc27822030e68752690ddfa9473e739aeb4dbde6d71" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", + "synstructure", +] + +[[package]] +name = "zerocopy" +version = "0.7.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b9b4fd18abc82b8136838da5d50bae7bdea537c574d8dc1a34ed098d6c166f0" +dependencies = [ + "byteorder", + "zerocopy-derive 0.7.35", +] + +[[package]] +name = "zerocopy" +version = "0.8.62" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "86502bf56ac7c77571a32e2647bb2a15894565e981fb2a48d7bde2d91c965a9d" +dependencies = [ + "zerocopy-derive 0.8.62", +] + +[[package]] +name = "zerocopy-derive" +version = "0.7.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "zerocopy-derive" +version = "0.8.62" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5457206954b06561e2608c7e19cf58b1926586d999c246eebe4502f7e2039d1a" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "zerofrom" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ec05a11813ea801ff6d75110ad09cd0824ddba17dfe17128ea0d5f68e6c5272" +dependencies = [ + "zerofrom-derive", +] + +[[package]] +name = "zerofrom-derive" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f75b4683f6c7f45248d4d64056a24298c6281e0993356d7d1b4a1a962ef10d4a" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", + "synstructure", +] + +[[package]] +name = "zeroize" +version = "1.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e13084392c5e4bc371903e2935a5eaeed24905a7511356b883835e18a78f6879" +dependencies = [ + "zeroize_derive", +] + +[[package]] +name = "zeroize_derive" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c50655cbb0fe3fc43170059e702f1ce5e19b84cec58dc87b037a09935c2f328" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "zerotrie" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ea269c3bd32f0a32c321907a2ae912ba6f4649bb0fc764a15627e99a7095a3f" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", +] + +[[package]] +name = "zerovec" +version = "0.11.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bb0464e17806c1d976d5cba29399c7f08e516e279e2ba493f63123b5fca67dd8" +dependencies = [ + "yoke", + "zerofrom", + "zerovec-derive", +] + +[[package]] +name = "zerovec-derive" +version = "0.11.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "34df6fc39dbd26ddc9c10e6a2984476e13acce22e64e4487636ef494369225da" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "zip" +version = "8.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2d04a6b5381502aa6087c94c669499eb1602eb9c5e8198e534de571f7154809b" +dependencies = [ + "aes 0.9.3", + "bzip2", + "constant_time_eq", + "crc32fast", + "deflate64", + "flate2", + "getrandom 0.4.3", + "hmac 0.13.0", + "indexmap", + "lzma-rust2", + "memchr", + "pbkdf2", + "ppmd-rust", + "sha1 0.11.0", + "time", + "typed-path", + "zeroize", + "zopfli", + "zstd", +] + +[[package]] +name = "zlib-rs" +version = "0.6.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b268e58e7c693d7c271f93ffc4ba3b380412554231c85bf61ca7af91042a4112" + +[[package]] +name = "zmij" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29666d0abbfad1e3dc4dcf6144730dd3a3ab225bbbdac83319345b1b44ccfc1b" + +[[package]] +name = "zopfli" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f05cd8797d63865425ff89b5c4a48804f35ba0ce8d125800027ad6017d2b5249" +dependencies = [ + "bumpalo", + "crc32fast", + "log", + "simd-adler32", +] + +[[package]] +name = "zstd" +version = "0.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e91ee311a569c327171651566e07972200e76fcfe2242a4fa446149a3881c08a" +dependencies = [ + "zstd-safe", +] + +[[package]] +name = "zstd-safe" +version = "7.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "64d80649ab6db9d9f6f9c80a40becd948eda4714a0a5ac8c4d157a32231c7882" +dependencies = [ + "zstd-sys", +] + +[[package]] +name = "zstd-sys" +version = "2.1.0+zstd.1.5.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ef0a8027ec3ee71300ab3bcbcd0393f434aa72b91ca6d635a39941deae8eea0" +dependencies = [ + "cc", + "pkg-config", +] diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..db56207 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,21 @@ +[workspace] +resolver = "2" +members = ["crates/*", "tools/meshport-test-server", "tools/meshport-vpn-helper"] +exclude = ["vendor/easytier"] + +[workspace.package] +version = "0.1.0" +edition = "2024" +rust-version = "1.95" + +[workspace.dependencies] +anyhow = "1" +serde = { version = "1", features = ["derive"] } +serde_json = "1" +toml = "1" +tokio = { version = "1", features = ["rt-multi-thread", "macros", "net", "io-util", "sync", "time"] } +easytier = { path = "vendor/easytier/easytier", default-features = false, features = ["aes-gcm", "ffi-dataplane", "proxy-cidr-monitor", "dhcp-ipv4", "tcp-hole-punch"] } +easytier-core = { path = "vendor/easytier/easytier-core", default-features = false, features = ["proxy-smoltcp-stack"] } +meshport = { path = "crates/meshport" } +meshport-easytier = { path = "crates/meshport-easytier" } +meshport-netstack = { path = "crates/meshport-netstack" } diff --git a/README.md b/README.md new file mode 100644 index 0000000..2e901f6 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +# MeshPort + +虚拟组网 SDK,默认应用内模式,复用 Rust EasyTier 核心,通过用户态 TCP/IP 栈提供 TCP/UDP 通信。Flutter **MeshPort Lab** 是使用同一公开 SDK 的验证客户端。 + +目前为 **0.1.0 开发原型**。已实现真实网络通信,不是 UI 模拟。macOS Apple Silicon 已验证;Android ARM64 已构建并通过真机应用内 TCP/UDP,系统 VPN 真机验证仍待完成。其他平台原生库打包与运行尚未完成。 + +## 快速开始 + +需要 Rust ≥1.95、protoc 和 Flutter。当前机器的项目本地工具链位于 `work/toolchain/`,`scripts/cargo-local.sh` 会自动使用它;其他机器可使用系统工具链,或运行 `scripts/bootstrap-local.sh` 安装到项目内。 + +```sh +scripts/cargo-local.sh test --workspace --locked +scripts/run-lab-macos.sh +``` + +构建内含 Rust 动态库、可直接启动的 macOS 开发版: + +```sh +scripts/build-lab-macos.sh +open apps/meshport_lab/build/macos/Build/Products/Debug/MeshPort.app +``` + +进入设置,填写与游戏服务器一致的网络名称、网络密钥、唯一虚拟 IPv4 和初始节点地址。启动引擎后等待节点出现,然后测试服务器虚拟 IP 和游戏端口。**引擎 Running 不代表服务器已可达。** + +Android 构建:scripts/build-lab-android.sh --release;安装包输出到 outputs/android。平台接入与验证说明见 [Android](docs/android.md)。 + +TCP 建连测试可以针对游戏端口。数据回显校验与 UDP 测试需要协作的回显服务,不能拿任意游戏端口当 echo 服务。 + +在已安装 EasyTier 的游戏服务器上,另开测试端口: + +```sh +cargo run -p meshport-test-server -- 10.77.0.2:7007 +``` + +将地址替换成服务器真实的虚拟 IPv4,防火墙允许 TCP/UDP 测试端口。工具默认只绑定 `127.0.0.1:7007`,需要显式指定虚拟网地址。 + +## 目录 + +- `crates/meshport`:Rust 公共 API。 +- `crates/meshport-easytier`:固定上游快照、配置约束、实例与状态适配。 +- `crates/meshport-netstack`:复用 EasyTier 已有 smoltcp 数据面,提供通信类型和回显验证。 +- `crates/meshport-ffi`:C ABI、实例/连接句柄、JSON 控制接口。 +- `bindings/flutter/meshport_flutter`:Dart FFI SDK,原生调用放在后台 isolate。 +- `apps/meshport_lab`:响应式 Flutter 验证工具。 +- `tools/meshport-vpn-helper`:macOS 开发版特权 TUN 控制与自检。 +- `tools/meshport-test-server`:普通系统 socket 的 TCP/UDP echo 服务。 +- `vendor/easytier`:保留许可证的上游源码快照与本地选路定制。 +- `docs`:架构、配置、ABI 契约、验证记录。 +- `outputs/ui`:设计参考图。 + +## 使用边界 + +- 默认应用内模式不创建 TUN/TAP,只影响 SDK 连接;macOS 开发版可切换系统组网模式,创建 utun 并安装虚拟网段路由。详见 [系统组网](docs/system-vpn.md)。 +- IPv4 数据面;底层 TCP/UDP 传输。其他协议、安全模式和完整 EasyTier 配置未全部开放。 +- UDP 接收当前按已经主动发送过的远端会话匹配;不支持陌生远端首包的通用 UDP 服务端监听。 +- Rust API 为 async;ABI v1 是同步、每 context 串行的开发接口。Dart 放到后台 isolate 避免阻塞 UI,但尚不适合高并发/低开销的最终游戏数据面。 +- 超时写入可能已经发送部分 TCP 数据,不能盲目重发。 +- macOS 设置页可独立保存配置到 Keychain,启动自动回填,手动连接;扫码、文件导入、完整候选路径优化、长期压测和移动端后台运行尚未完成。 +- 稳定性页面目前执行真实的重复连接/回显探测;不表示所有设计稿中的测试模式均已实现。 + +线路策略和实测工具见 [跨国线路优化](docs/optimization.md)。 + +本地定制核心基于 EasyTier `7af7bdc16a41d64d58743d15023a63b3eed2102c`(2.7.0 开发源码)。需另行验证与现有服务器实际版本的互通,不能把同版本本地测试当成全版本兼容。 + +详见 [架构](docs/architecture.md)、[配置](docs/configuration.md)、[ABI](docs/ffi-contract.md)、[验证记录](docs/testing.md)和[兼容范围](docs/compatibility.md)。 + +两种模式均自动学习符合规则的节点公告子网,无需填写远端 CIDR。应用内模式仅供 SDK TCP/UDP 访问;系统模式自动同步 OS 路由。规则及 macOS 启动方式见 [系统组网](docs/system-vpn.md)。 diff --git a/apps/meshport_lab/.gitignore b/apps/meshport_lab/.gitignore new file mode 100644 index 0000000..3820a95 --- /dev/null +++ b/apps/meshport_lab/.gitignore @@ -0,0 +1,45 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.build/ +.buildlog/ +.history +.svn/ +.swiftpm/ +migrate_working_dir/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# The .vscode folder contains launch configuration and tasks you configure in +# VS Code which you may wish to be included in version control, so this line +# is commented out by default. +#.vscode/ + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins-dependencies +.pub-cache/ +.pub/ +/build/ +/coverage/ + +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json + +# Android Studio will place build artifacts here +/android/app/debug +/android/app/profile +/android/app/release diff --git a/apps/meshport_lab/.metadata b/apps/meshport_lab/.metadata new file mode 100644 index 0000000..b2ab492 --- /dev/null +++ b/apps/meshport_lab/.metadata @@ -0,0 +1,42 @@ +# This file tracks properties of this Flutter project. +# Used by Flutter tool to assess capabilities and perform upgrades etc. +# +# This file should be version controlled and should not be manually edited. + +version: + revision: "ff37bef603469fb030f2b72995ab929ccfc227f0" + channel: "stable" + +project_type: app + +# Tracks metadata for the flutter migrate command +migration: + platforms: + - platform: root + create_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + base_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + - platform: android + create_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + base_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + - platform: ios + create_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + base_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + - platform: linux + create_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + base_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + - platform: macos + create_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + base_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + - platform: windows + create_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + base_revision: ff37bef603469fb030f2b72995ab929ccfc227f0 + + # User provided section + + # List of Local paths (relative to this file) that should be + # ignored by the migrate tool. + # + # Files that are not part of the templates will be ignored by default. + unmanaged_files: + - 'lib/main.dart' + - 'ios/Runner.xcodeproj/project.pbxproj' diff --git a/apps/meshport_lab/README.md b/apps/meshport_lab/README.md new file mode 100644 index 0000000..504ee50 --- /dev/null +++ b/apps/meshport_lab/README.md @@ -0,0 +1,17 @@ +# meshport_lab + +A new Flutter project. + +## Getting Started + +This project is a starting point for a Flutter application. + +A few resources to get you started if this is your first Flutter project: + +- [Learn Flutter](https://docs.flutter.dev/get-started/learn-flutter) +- [Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) +- [Flutter learning resources](https://docs.flutter.dev/reference/learning-resources) + +For help getting started with Flutter development, view the +[online documentation](https://docs.flutter.dev/), which offers tutorials, +samples, guidance on mobile development, and a full API reference. diff --git a/apps/meshport_lab/analysis_options.yaml b/apps/meshport_lab/analysis_options.yaml new file mode 100644 index 0000000..0d29021 --- /dev/null +++ b/apps/meshport_lab/analysis_options.yaml @@ -0,0 +1,28 @@ +# This file configures the analyzer, which statically analyzes Dart code to +# check for errors, warnings, and lints. +# +# The issues identified by the analyzer are surfaced in the UI of Dart-enabled +# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be +# invoked from the command line by running `flutter analyze`. + +# The following line activates a set of recommended lints for Flutter apps, +# packages, and plugins designed to encourage good coding practices. +include: package:flutter_lints/flutter.yaml + +linter: + # The lint rules applied to this project can be customized in the + # section below to disable rules from the `package:flutter_lints/flutter.yaml` + # included above or to enable additional rules. A list of all available lints + # and their documentation is published at https://dart.dev/lints. + # + # Instead of disabling a lint rule for the entire project in the + # section below, it can also be suppressed for a single line of code + # or a specific dart file by using the `// ignore: name_of_lint` and + # `// ignore_for_file: name_of_lint` syntax on the line or in the file + # producing the lint. + rules: + # avoid_print: false # Uncomment to disable the `avoid_print` rule + # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule + +# Additional information about this file can be found at +# https://dart.dev/guides/language/analysis-options diff --git a/apps/meshport_lab/android/.gitignore b/apps/meshport_lab/android/.gitignore new file mode 100644 index 0000000..be3943c --- /dev/null +++ b/apps/meshport_lab/android/.gitignore @@ -0,0 +1,14 @@ +gradle-wrapper.jar +/.gradle +/captures/ +/gradlew +/gradlew.bat +/local.properties +GeneratedPluginRegistrant.java +.cxx/ + +# Remember to never publicly share your keystore. +# See https://flutter.dev/to/reference-keystore +key.properties +**/*.keystore +**/*.jks diff --git a/apps/meshport_lab/android/app/build.gradle.kts b/apps/meshport_lab/android/app/build.gradle.kts new file mode 100644 index 0000000..3a39931 --- /dev/null +++ b/apps/meshport_lab/android/app/build.gradle.kts @@ -0,0 +1,53 @@ +plugins { + id("com.android.application") + id("kotlin-android") + // The Flutter Gradle Plugin must be applied after the Android and Kotlin Gradle plugins. + id("dev.flutter.flutter-gradle-plugin") +} + +android { + buildFeatures { buildConfig = true } + namespace = "com.example.meshport_lab" + compileSdk = flutter.compileSdkVersion + ndkVersion = "28.2.13676358" + + compileOptions { + sourceCompatibility = JavaVersion.VERSION_17 + targetCompatibility = JavaVersion.VERSION_17 + } + + kotlinOptions { + jvmTarget = JavaVersion.VERSION_17.toString() + } + + defaultConfig { + // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html). + applicationId = "com.example.meshport_lab" + // You can update the following values to match your application needs. + // For more information, see: https://flutter.dev/to/review-gradle-config. + minSdk = 26 + ndk { abiFilters += listOf("arm64-v8a") } + externalNativeBuild { cmake { + arguments += "-DANDROID_STL=c++_shared" + abiFilters += "arm64-v8a" + } } + targetSdk = flutter.targetSdkVersion + versionCode = flutter.versionCode + versionName = flutter.versionName + } + + buildTypes { + debug { ndk { abiFilters.clear(); abiFilters += "arm64-v8a" } } + release { + proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro") + // TODO: Add your own signing config for the release build. + // Signing with the debug keys for now, so `flutter run --release` works. + signingConfig = signingConfigs.getByName("debug") + } + } + externalNativeBuild { cmake { path = file("src/main/cpp/CMakeLists.txt"); version = "3.22.1" } } +} + +flutter { + source = "../.." +} diff --git a/apps/meshport_lab/android/app/proguard-rules.pro b/apps/meshport_lab/android/app/proguard-rules.pro new file mode 100644 index 0000000..a0d1cb2 --- /dev/null +++ b/apps/meshport_lab/android/app/proguard-rules.pro @@ -0,0 +1,2 @@ +# JNI resolves this class and static callback by name. +-keep class com.example.meshport_lab.NativeBridge { *; } diff --git a/apps/meshport_lab/android/app/src/debug/AndroidManifest.xml b/apps/meshport_lab/android/app/src/debug/AndroidManifest.xml new file mode 100644 index 0000000..399f698 --- /dev/null +++ b/apps/meshport_lab/android/app/src/debug/AndroidManifest.xml @@ -0,0 +1,7 @@ + + + + diff --git a/apps/meshport_lab/android/app/src/main/AndroidManifest.xml b/apps/meshport_lab/android/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..69c0875 --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/AndroidManifest.xml @@ -0,0 +1,54 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apps/meshport_lab/android/app/src/main/cpp/CMakeLists.txt b/apps/meshport_lab/android/app/src/main/cpp/CMakeLists.txt new file mode 100644 index 0000000..7f2e4a6 --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/cpp/CMakeLists.txt @@ -0,0 +1,7 @@ +cmake_minimum_required(VERSION 3.22.1) +project(meshport_android) +add_library(meshport_ffi SHARED IMPORTED) +set_target_properties(meshport_ffi PROPERTIES IMPORTED_LOCATION "${CMAKE_CURRENT_SOURCE_DIR}/../jniLibs/${ANDROID_ABI}/libmeshport_ffi.so") +add_library(meshport_android SHARED bridge.cpp) +target_link_libraries(meshport_android meshport_ffi) +target_link_options(meshport_android PRIVATE "-Wl,-z,max-page-size=16384") diff --git a/apps/meshport_lab/android/app/src/main/cpp/bridge.cpp b/apps/meshport_lab/android/app/src/main/cpp/bridge.cpp new file mode 100644 index 0000000..6faa5ac --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/cpp/bridge.cpp @@ -0,0 +1,59 @@ +#include +#include +#include +#include +extern "C" { +uint64_t meshport_context_new(); +void meshport_context_free(uint64_t); +char* meshport_call(uint64_t, const char*); +void meshport_string_free(char*); +void meshport_set_android_socket_protector(bool (*callback)(int)); +} +static JavaVM* vm; +static jclass bridge; +static jmethodID protectMethod; +static bool protectSocket(int fd) { + JNIEnv* env = nullptr; + bool attached = vm->GetEnv(reinterpret_cast(&env), JNI_VERSION_1_6) == JNI_EDETACHED; + if (attached && vm->AttachCurrentThread(&env, nullptr) != JNI_OK) return false; + bool ok = env && env->CallStaticBooleanMethod(bridge, protectMethod, fd); + if (env && env->ExceptionCheck()) { env->ExceptionClear(); ok = false; } + if (attached) vm->DetachCurrentThread(); + return ok; +} +extern "C" JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* value, void*) { + vm = value; + JNIEnv* env = nullptr; + if (vm->GetEnv(reinterpret_cast(&env), JNI_VERSION_1_6) != JNI_OK) return JNI_ERR; + auto cls = env->FindClass("com/example/meshport_lab/NativeBridge"); + if (!cls) return JNI_ERR; + bridge = static_cast(env->NewGlobalRef(cls)); + protectMethod = env->GetStaticMethodID(bridge, "protectFd", "(I)Z"); + if (!protectMethod) return JNI_ERR; + meshport_set_android_socket_protector(protectSocket); + return JNI_VERSION_1_6; +} +extern "C" JNIEXPORT jlong JNICALL Java_com_example_meshport_1lab_NativeBridge_newContext(JNIEnv*, jobject) { + return static_cast(meshport_context_new()); +} +extern "C" JNIEXPORT void JNICALL Java_com_example_meshport_1lab_NativeBridge_freeContext(JNIEnv*, jobject, jlong handle) { + meshport_context_free(static_cast(handle)); +} +extern "C" JNIEXPORT jstring JNICALL Java_com_example_meshport_1lab_NativeBridge_call(JNIEnv* env, jobject, jlong handle, jstring text) { + auto stringClass = env->FindClass("java/lang/String"); + auto charset = env->NewStringUTF("UTF-8"); + auto getBytes = env->GetMethodID(stringClass, "getBytes", "(Ljava/lang/String;)[B"); + auto bytes = static_cast(env->CallObjectMethod(text, getBytes, charset)); + if (!bytes || env->ExceptionCheck()) return nullptr; + auto size = env->GetArrayLength(bytes); + if (size > 131072) return env->NewStringUTF("{\"ok\":false,\"error\":\"Request too large\"}"); + std::string input(size, '\0'); + env->GetByteArrayRegion(bytes, 0, size, reinterpret_cast(input.data())); + char* response = meshport_call(static_cast(handle), input.c_str()); + if (!response) return nullptr; + auto output = env->NewByteArray(static_cast(strlen(response))); + env->SetByteArrayRegion(output, 0, env->GetArrayLength(output), reinterpret_cast(response)); + meshport_string_free(response); + auto constructor = env->GetMethodID(stringClass, "", "([BLjava/lang/String;)V"); + return static_cast(env->NewObject(stringClass, constructor, output, charset)); +} diff --git a/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/MainActivity.kt b/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/MainActivity.kt new file mode 100644 index 0000000..852ca3c --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/MainActivity.kt @@ -0,0 +1,92 @@ +package com.example.meshport_lab + +import io.flutter.embedding.android.FlutterActivity +import io.flutter.embedding.engine.FlutterEngine +import io.flutter.plugin.common.MethodChannel +import android.app.Activity +import android.content.Intent +import android.net.VpnService +import android.os.Handler +import android.os.Looper +import org.json.JSONObject +import java.util.concurrent.Executors + +class MainActivity : FlutterActivity() { + private val background = Executors.newSingleThreadExecutor() + private val main = Handler(Looper.getMainLooper()) + private var permissionResult: MethodChannel.Result? = null + override fun configureFlutterEngine(flutterEngine: FlutterEngine) { + super.configureFlutterEngine(flutterEngine) + MethodChannel(flutterEngine.dartExecutor.binaryMessenger, "meshport/system_vpn").setMethodCallHandler { call, result -> + if (call.method == "prepare_android_vpn") { + if (permissionResult != null) { result.error("VPN_BUSY", "VPN authorization pending", null); return@setMethodCallHandler } + val intent = VpnService.prepare(this) + if (intent == null) result.success(null) + else { permissionResult = result; startActivityForResult(intent, 1001) } + return@setMethodCallHandler + } + background.execute { + try { + val profiles = ProfileStore(this) + when (call.method) { + "load_profile" -> { val value = profiles.load(); main.post { result.success(value) } } + "save_profile" -> { profiles.save(call.arguments as String); main.post { result.success(null) } } + "delete_profile" -> { profiles.delete(); main.post { result.success(null) } } + "debug_storage_self_test" -> { + check(BuildConfig.DEBUG) + val isolated = ProfileStore(this, "device_validation") + try { + isolated.save("MeshPort 测试 🌍 test-only") + check(ProfileStore(this, "device_validation").load() == "MeshPort 测试 🌍 test-only") + isolated.delete(); check(isolated.load() == null) + main.post { result.success(true) } + } finally { isolated.delete() } + } + "android_vpn_request" -> { + val request = JSONObject(call.arguments as String) + require(request.toString().toByteArray(Charsets.UTF_8).size <= 131072) + if (request.getString("op") == "start" && MeshVpnService.current == null) { + check(VpnService.prepare(this) == null) { "Android VPN authorization required" } + startForegroundService(Intent(this, MeshVpnService::class.java)) + for (attempt in 0 until 100) { + if (MeshVpnService.current != null) break + Thread.sleep(50) + } + } + val service = MeshVpnService.current + if (service == null) { + check(request.getString("op") in listOf("stop", "status", "diagnostics_enable")) { "VPN service not running" } + val data = JSONObject().put("state", "Stopped").put("peer_count", 0).put("enabled", false) + val reply = JSONObject().put("ok", true).put("data", data).toString() + main.post { result.success(reply) } + } else { + service.worker.execute { + try { + val reply = service.request(request).toString() + main.post { result.success(reply) } + } catch (error: Exception) { main.post { result.error("VPN_REQUEST", error.message, null) } } + } + } + } + else -> main.post { result.notImplemented() } + } + } catch (error: Exception) { main.post { result.error("PLATFORM_REQUEST", error.message, null) } } + } + } + } + @Deprecated("Legacy VPN permission result") + override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { + super.onActivityResult(requestCode, resultCode, data) + if (requestCode == 1001) { + val pending = permissionResult; permissionResult = null + if (resultCode == Activity.RESULT_OK) pending?.success(null) + else pending?.error("VPN_DENIED", "Android VPN authorization cancelled", null) + } + } + override fun onDestroy() { + permissionResult?.error("VPN_CANCELLED", "Activity closed during VPN authorization", null) + permissionResult = null + background.shutdown() + super.onDestroy() + } +} diff --git a/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/MeshVpnService.kt b/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/MeshVpnService.kt new file mode 100644 index 0000000..997066f --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/MeshVpnService.kt @@ -0,0 +1,129 @@ +package com.example.meshport_lab + +import android.app.Notification +import android.app.NotificationChannel +import android.app.NotificationManager +import android.app.PendingIntent +import android.content.Intent +import android.net.VpnService +import android.os.ParcelFileDescriptor +import android.system.OsConstants +import android.util.Log +import org.json.JSONObject +import java.net.InetAddress +import java.util.concurrent.ScheduledThreadPoolExecutor +import java.util.concurrent.TimeUnit + +class MeshVpnService : VpnService() { + companion object { @Volatile var current: MeshVpnService? = null; private set } + val worker = ScheduledThreadPoolExecutor(1) + private var handle = 0L + private var tun: ParcelFileDescriptor? = null + private var ipv4 = "" + private var installed = emptyList() + private var running = false + private var failure: String? = null + override fun onCreate() { + super.onCreate() + current = this + val manager = getSystemService(NotificationManager::class.java) + manager.createNotificationChannel(NotificationChannel("meshport_vpn", "MeshPort 组网", NotificationManager.IMPORTANCE_LOW)) + val open = PendingIntent.getActivity(this, 0, Intent(this, MainActivity::class.java), PendingIntent.FLAG_IMMUTABLE) + startForeground(77, Notification.Builder(this, "meshport_vpn") + .setContentTitle("MeshPort").setContentText("虚拟组网服务正在运行") + .setSmallIcon(R.drawable.ic_stat_meshport).setContentIntent(open).setOngoing(true).build()) + worker.scheduleWithFixedDelay({ + if (running) try { + val snapshot = native(JSONObject().put("op", "status")).getJSONObject("data") + val routes = snapshot.getJSONObject("platform_network").getJSONArray("subnet_routes") + val next = (0 until routes.length()).map { routes.getString(it) }.sorted() + if (next != installed) rebuild(next) + } catch (_: Exception) { failure = "VPN 路由更新失败,请重新连接"; shutdown() } + }, 2, 2, TimeUnit.SECONDS) + } + private fun native(request: JSONObject): JSONObject { + check(handle != 0L) { "VPN context not started" } + val response = JSONObject(NativeBridge.call(handle, request.toString())) + check(response.optBoolean("ok")) { response.optString("error", "Native request failed") } + return response + } + fun request(request: JSONObject): JSONObject { + return when (request.getString("op")) { + "start" -> { + check(!running) { "VPN already started" } + failure = null + Log.i("MeshPortVPN", "Creating native VPN context") + handle = NativeBridge.newContext() + try { + val config = request.getString("toml") + val validation = native(JSONObject().put("op", "validate").put("toml", config).put("include_profile", true)).getJSONObject("data") + check(validation.getString("runtime_mode") == "system_vpn") + ipv4 = validation.getJSONObject("profile").getString("ipv4") + Log.i("MeshPortVPN", "Starting native engine") + val result = native(request) + Log.i("MeshPortVPN", "Native engine started") + running = true + rebuild(emptyList()) + result + } catch (error: Exception) { shutdown(); stopSelf(); throw error } + } + "stop" -> { shutdown(); stopSelf(); JSONObject().put("ok", true).put("data", JSONObject()) } + "status" -> { + if (!running) JSONObject().put("ok", true).put("data", JSONObject().put("state", if (failure == null) "Stopped" else "Failed").put("peer_count", 0)) + else native(request).also { reply -> + reply.getJSONObject("data").getJSONObject("platform_network") + .put("installed_subnet_routes", org.json.JSONArray(installed)).put("route_installation", "android_vpn") + } + } + "diagnostics_enable" -> { + if (handle == 0L) JSONObject().put("ok", true).put("data", JSONObject().put("enabled", false)) else native(request) + } + else -> native(request) + } + } + private fun rebuild(routes: List) { + val parts = ipv4.split('/') + val address = parts[0] + val prefix = if (parts.size == 2) parts[1].toInt() else 24 + val raw = InetAddress.getByName(address).address + val network = raw.mapIndexed { index, byte -> + val bits = (prefix - index * 8).coerceIn(0, 8) + (byte.toInt() and (0xff shl (8 - bits))).and(0xff) + }.joinToString(".") + val builder = Builder().setSession("MeshPort").setMtu(1280) + .addAddress(address, prefix).addRoute(network, prefix).allowFamily(OsConstants.AF_INET6) + for (route in routes) { + val cidr = route.split('/') + builder.addRoute(cidr[0], cidr[1].toInt()) + } + Log.i("MeshPortVPN", "Establishing TUN with ${routes.size} learned routes") + val next = builder.establish() ?: error("Android VPN authorization revoked") + val previous = tun + try { + Log.i("MeshPortVPN", "Attaching TUN to native engine") + native(JSONObject().put("op", "attach_tun").put("fd", next.fd)) + var ready = false + for (attempt in 0 until 50) { + val state = native(JSONObject().put("op", "status")).getJSONObject("data") + if (state.getJSONObject("platform_network").optBoolean("ready")) { ready = true; break } + Thread.sleep(100) + } + check(ready) { "Native TUN attachment timed out" } + Log.i("MeshPortVPN", "TUN ready") + tun = next + installed = routes + previous?.close() + } catch (error: Exception) { next.close(); throw error } + } + private fun shutdown() { + running = false + if (handle != 0L) { NativeBridge.freeContext(handle); handle = 0L } + tun?.close(); tun = null; installed = emptyList() + } + override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int = START_NOT_STICKY + override fun onRevoke() { worker.execute { shutdown(); stopSelf() } } + override fun onDestroy() { + worker.execute { shutdown(); if (current === this) current = null; worker.shutdown() } + super.onDestroy() + } +} diff --git a/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/NativeBridge.kt b/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/NativeBridge.kt new file mode 100644 index 0000000..2d3877a --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/NativeBridge.kt @@ -0,0 +1,9 @@ +package com.example.meshport_lab + +object NativeBridge { + init { System.loadLibrary("meshport_android") } + external fun newContext(): Long + external fun freeContext(handle: Long) + external fun call(handle: Long, request: String): String + @JvmStatic fun protectFd(fd: Int): Boolean = MeshVpnService.current?.protect(fd) ?: true +} diff --git a/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/ProfileStore.kt b/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/ProfileStore.kt new file mode 100644 index 0000000..ce4cf38 --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/kotlin/com/example/meshport_lab/ProfileStore.kt @@ -0,0 +1,40 @@ +package com.example.meshport_lab + +import android.content.Context +import android.security.keystore.KeyGenParameterSpec +import android.security.keystore.KeyProperties +import android.util.Base64 +import java.security.KeyStore +import javax.crypto.Cipher +import javax.crypto.KeyGenerator +import javax.crypto.SecretKey +import javax.crypto.spec.GCMParameterSpec + +class ProfileStore(context: Context, namespace: String = "profile") { + private val prefs = context.getSharedPreferences("meshport_$namespace", Context.MODE_PRIVATE) + private val alias = "MeshPort.Network.$namespace" + private fun key(): SecretKey { + val store = KeyStore.getInstance("AndroidKeyStore").apply { load(null) } + (store.getKey(alias, null) as? SecretKey)?.let { return it } + return KeyGenerator.getInstance(KeyProperties.KEY_ALGORITHM_AES, "AndroidKeyStore").apply { + init(KeyGenParameterSpec.Builder(alias, KeyProperties.PURPOSE_ENCRYPT or KeyProperties.PURPOSE_DECRYPT) + .setBlockModes(KeyProperties.BLOCK_MODE_GCM).setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE).build()) + }.generateKey() + } + fun save(config: String) { + require(config.toByteArray(Charsets.UTF_8).size <= 65536) + val cipher = Cipher.getInstance("AES/GCM/NoPadding") + cipher.init(Cipher.ENCRYPT_MODE, key()) + val data = cipher.doFinal(config.toByteArray(Charsets.UTF_8)) + check(prefs.edit().putString("data", Base64.encodeToString(data, Base64.NO_WRAP)) + .putString("iv", Base64.encodeToString(cipher.iv, Base64.NO_WRAP)).commit()) + } + fun load(): String? { + val data = prefs.getString("data", null) ?: return null + val iv = prefs.getString("iv", null) ?: error("Missing profile IV") + val cipher = Cipher.getInstance("AES/GCM/NoPadding") + cipher.init(Cipher.DECRYPT_MODE, key(), GCMParameterSpec(128, Base64.decode(iv, Base64.NO_WRAP))) + return cipher.doFinal(Base64.decode(data, Base64.NO_WRAP)).toString(Charsets.UTF_8) + } + fun delete() { check(prefs.edit().clear().commit()) } +} diff --git a/apps/meshport_lab/android/app/src/main/res/drawable-v21/launch_background.xml b/apps/meshport_lab/android/app/src/main/res/drawable-v21/launch_background.xml new file mode 100644 index 0000000..f74085f --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/res/drawable-v21/launch_background.xml @@ -0,0 +1,12 @@ + + + + + + + + diff --git a/apps/meshport_lab/android/app/src/main/res/drawable/ic_stat_meshport.xml b/apps/meshport_lab/android/app/src/main/res/drawable/ic_stat_meshport.xml new file mode 100644 index 0000000..c2f1c84 --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/res/drawable/ic_stat_meshport.xml @@ -0,0 +1,3 @@ + + + diff --git a/apps/meshport_lab/android/app/src/main/res/drawable/launch_background.xml b/apps/meshport_lab/android/app/src/main/res/drawable/launch_background.xml new file mode 100644 index 0000000..304732f --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/res/drawable/launch_background.xml @@ -0,0 +1,12 @@ + + + + + + + + diff --git a/apps/meshport_lab/android/app/src/main/res/mipmap-hdpi/ic_launcher.png b/apps/meshport_lab/android/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 0000000..32a7b13 Binary files /dev/null and b/apps/meshport_lab/android/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/apps/meshport_lab/android/app/src/main/res/mipmap-mdpi/ic_launcher.png b/apps/meshport_lab/android/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 0000000..ecb8f13 Binary files /dev/null and b/apps/meshport_lab/android/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/apps/meshport_lab/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/apps/meshport_lab/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 0000000..818fa7f Binary files /dev/null and b/apps/meshport_lab/android/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/apps/meshport_lab/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/apps/meshport_lab/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 0000000..d913e32 Binary files /dev/null and b/apps/meshport_lab/android/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/apps/meshport_lab/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/apps/meshport_lab/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 0000000..c4e211c Binary files /dev/null and b/apps/meshport_lab/android/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/apps/meshport_lab/android/app/src/main/res/values-night/styles.xml b/apps/meshport_lab/android/app/src/main/res/values-night/styles.xml new file mode 100644 index 0000000..06952be --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/res/values-night/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/apps/meshport_lab/android/app/src/main/res/values/styles.xml b/apps/meshport_lab/android/app/src/main/res/values/styles.xml new file mode 100644 index 0000000..cb1ef88 --- /dev/null +++ b/apps/meshport_lab/android/app/src/main/res/values/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/apps/meshport_lab/android/app/src/profile/AndroidManifest.xml b/apps/meshport_lab/android/app/src/profile/AndroidManifest.xml new file mode 100644 index 0000000..399f698 --- /dev/null +++ b/apps/meshport_lab/android/app/src/profile/AndroidManifest.xml @@ -0,0 +1,7 @@ + + + + diff --git a/apps/meshport_lab/android/build.gradle.kts b/apps/meshport_lab/android/build.gradle.kts new file mode 100644 index 0000000..dbee657 --- /dev/null +++ b/apps/meshport_lab/android/build.gradle.kts @@ -0,0 +1,24 @@ +allprojects { + repositories { + google() + mavenCentral() + } +} + +val newBuildDir: Directory = + rootProject.layout.buildDirectory + .dir("../../build") + .get() +rootProject.layout.buildDirectory.value(newBuildDir) + +subprojects { + val newSubprojectBuildDir: Directory = newBuildDir.dir(project.name) + project.layout.buildDirectory.value(newSubprojectBuildDir) +} +subprojects { + project.evaluationDependsOn(":app") +} + +tasks.register("clean") { + delete(rootProject.layout.buildDirectory) +} diff --git a/apps/meshport_lab/android/gradle.properties b/apps/meshport_lab/android/gradle.properties new file mode 100644 index 0000000..fbee1d8 --- /dev/null +++ b/apps/meshport_lab/android/gradle.properties @@ -0,0 +1,2 @@ +org.gradle.jvmargs=-Xmx8G -XX:MaxMetaspaceSize=4G -XX:ReservedCodeCacheSize=512m -XX:+HeapDumpOnOutOfMemoryError +android.useAndroidX=true diff --git a/apps/meshport_lab/android/gradle/wrapper/gradle-wrapper.properties b/apps/meshport_lab/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..e4ef43f --- /dev/null +++ b/apps/meshport_lab/android/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-all.zip diff --git a/apps/meshport_lab/android/settings.gradle.kts b/apps/meshport_lab/android/settings.gradle.kts new file mode 100644 index 0000000..ca7fe06 --- /dev/null +++ b/apps/meshport_lab/android/settings.gradle.kts @@ -0,0 +1,26 @@ +pluginManagement { + val flutterSdkPath = + run { + val properties = java.util.Properties() + file("local.properties").inputStream().use { properties.load(it) } + val flutterSdkPath = properties.getProperty("flutter.sdk") + require(flutterSdkPath != null) { "flutter.sdk not set in local.properties" } + flutterSdkPath + } + + includeBuild("$flutterSdkPath/packages/flutter_tools/gradle") + + repositories { + google() + mavenCentral() + gradlePluginPortal() + } +} + +plugins { + id("dev.flutter.flutter-plugin-loader") version "1.0.0" + id("com.android.application") version "8.11.1" apply false + id("org.jetbrains.kotlin.android") version "2.2.20" apply false +} + +include(":app") diff --git a/apps/meshport_lab/assets/branding/meshport.png b/apps/meshport_lab/assets/branding/meshport.png new file mode 100644 index 0000000..5b333d9 Binary files /dev/null and b/apps/meshport_lab/assets/branding/meshport.png differ diff --git a/apps/meshport_lab/integration_test/android_network_test.dart b/apps/meshport_lab/integration_test/android_network_test.dart new file mode 100644 index 0000000..1415668 --- /dev/null +++ b/apps/meshport_lab/integration_test/android_network_test.dart @@ -0,0 +1,144 @@ +import 'dart:convert'; +import 'dart:io'; +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:integration_test/integration_test.dart'; +import 'package:meshport_flutter/meshport_flutter.dart'; + +const channel = MethodChannel('meshport/system_vpn'); +const target = '10.253.79.1:17007'; +String config(String mode) => + ''' +hostname = "Android-validation" +ipv4 = "10.253.83.11/24" +listeners = [] +stun_servers = [] +stun_servers_v6 = [] +[[peer]] +uri = "tcp://127.0.0.1:18080" +[network_identity] +network_name = "android-validation" +network_secret = "test-only" +[runtime] +mode = "$mode" +'''; + +Future waitForRoutes( + MeshPortClient client, { + bool withdrawn = false, + bool installed = false, +}) async { + final deadline = DateTime.now().add(const Duration(seconds: 40)); + while (DateTime.now().isBefore(deadline)) { + final state = await client.status(); + final platform = state['platform_network'] as Map? ?? {}; + final routes = + platform[installed ? 'installed_subnet_routes' : 'subnet_routes'] + as List? ?? + []; + if (withdrawn ? routes.isEmpty : routes.contains('10.253.79.0/24')) return; + await Future.delayed(const Duration(milliseconds: 200)); + } + throw StateError('Automatic subnet route transition timed out'); +} + +void main() { + IntegrationTestWidgetsFlutterBinding.ensureInitialized(); + testWidgets( + 'Android native SDK, secure storage and system VPN data plane', + (tester) async { + await tester.pumpWidget( + const MaterialApp( + home: Scaffold(body: Center(child: Text('MeshPort Android 验证中'))), + ), + ); + expect(await channel.invokeMethod('debug_storage_self_test'), true); + debugPrint('ANDROID_KEYSTORE_PASS'); + final client = await MeshPortClient.open(); + try { + await client.start(config('application')); + await waitForRoutes(client); + final stream = await client.connectTcp(target); + final payload = Uint8List.fromList(utf8.encode('Android SDK 测试')); + try { + await client.writeTcp(stream, payload); + expect(await client.readTcp(stream), orderedEquals(payload)); + } finally { + await client.closeResource(stream); + } + final reply = await client.probe(target, udp: true, echo: true); + expect(reply['verified_bytes'], greaterThan(0)); + debugPrint('ANDROID_APPLICATION_TCP_UDP_PASS'); + } finally { + await client.close(); + } + + debugPrint('WAITING_FOR_ANDROID_VPN_PERMISSION'); + final vpn = await openAndroidSystemVpn( + prepare: () async { + await channel.invokeMethod('prepare_android_vpn'); + }, + request: (request) async => + jsonDecode( + (await channel.invokeMethod( + 'android_vpn_request', + jsonEncode(request), + ))!, + ) + as Map, + ); + try { + await vpn.start(config('system_vpn')); + await waitForRoutes(vpn, installed: true); + // Plain OS sockets prove that traffic from other applications can use + // the VPN. No SDK stream is used for these transfers. + final socket = await Socket.connect( + '10.253.79.1', + 17007, + timeout: const Duration(seconds: 10), + ); + try { + socket.add(utf8.encode('OS TCP Android')); + await socket.flush(); + expect( + utf8.decode( + await socket.first.timeout(const Duration(seconds: 10)), + ), + 'OS TCP Android', + ); + } finally { + socket.destroy(); + } + final udp = await RawDatagramSocket.bind(InternetAddress.anyIPv4, 0); + try { + final reply = udp.firstWhere((event) => event == RawSocketEvent.read); + udp.send( + utf8.encode('OS UDP Android'), + InternetAddress('10.253.79.1'), + 17007, + ); + await reply.timeout(const Duration(seconds: 10)); + expect(utf8.decode(udp.receive()!.data), 'OS UDP Android'); + } finally { + udp.close(); + } + debugPrint('ANDROID_SYSTEM_VPN_TCP_UDP_PASS'); + final control = await Socket.connect('127.0.0.1', 18081); + try { + control.add(utf8.encode('withdraw')); + await control.flush(); + expect(utf8.decode(await control.first), contains('withdrawn')); + } finally { + control.destroy(); + } + await waitForRoutes(vpn, withdrawn: true); + await waitForRoutes(vpn, withdrawn: true, installed: true); + debugPrint('ANDROID_AUTOMATIC_ROUTE_WITHDRAW_PASS'); + } finally { + await vpn.close(); + } + }, + timeout: const Timeout(Duration(minutes: 10)), + ); +} diff --git a/apps/meshport_lab/ios/.gitignore b/apps/meshport_lab/ios/.gitignore new file mode 100644 index 0000000..7a7f987 --- /dev/null +++ b/apps/meshport_lab/ios/.gitignore @@ -0,0 +1,34 @@ +**/dgph +*.mode1v3 +*.mode2v3 +*.moved-aside +*.pbxuser +*.perspectivev3 +**/*sync/ +.sconsign.dblite +.tags* +**/.vagrant/ +**/DerivedData/ +Icon? +**/Pods/ +**/.symlinks/ +profile +xcuserdata +**/.generated/ +Flutter/App.framework +Flutter/Flutter.framework +Flutter/Flutter.podspec +Flutter/Generated.xcconfig +Flutter/ephemeral/ +Flutter/app.flx +Flutter/app.zip +Flutter/flutter_assets/ +Flutter/flutter_export_environment.sh +ServiceDefinitions.json +Runner/GeneratedPluginRegistrant.* + +# Exceptions to above rules. +!default.mode1v3 +!default.mode2v3 +!default.pbxuser +!default.perspectivev3 diff --git a/apps/meshport_lab/ios/Flutter/AppFrameworkInfo.plist b/apps/meshport_lab/ios/Flutter/AppFrameworkInfo.plist new file mode 100644 index 0000000..391a902 --- /dev/null +++ b/apps/meshport_lab/ios/Flutter/AppFrameworkInfo.plist @@ -0,0 +1,24 @@ + + + + + CFBundleDevelopmentRegion + en + CFBundleExecutable + App + CFBundleIdentifier + io.flutter.flutter.app + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + App + CFBundlePackageType + FMWK + CFBundleShortVersionString + 1.0 + CFBundleSignature + ???? + CFBundleVersion + 1.0 + + diff --git a/apps/meshport_lab/ios/Flutter/Debug.xcconfig b/apps/meshport_lab/ios/Flutter/Debug.xcconfig new file mode 100644 index 0000000..ec97fc6 --- /dev/null +++ b/apps/meshport_lab/ios/Flutter/Debug.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig" +#include "Generated.xcconfig" diff --git a/apps/meshport_lab/ios/Flutter/Release.xcconfig b/apps/meshport_lab/ios/Flutter/Release.xcconfig new file mode 100644 index 0000000..c4855bf --- /dev/null +++ b/apps/meshport_lab/ios/Flutter/Release.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" +#include "Generated.xcconfig" diff --git a/apps/meshport_lab/ios/Podfile b/apps/meshport_lab/ios/Podfile new file mode 100644 index 0000000..620e46e --- /dev/null +++ b/apps/meshport_lab/ios/Podfile @@ -0,0 +1,43 @@ +# Uncomment this line to define a global platform for your project +# platform :ios, '13.0' + +# CocoaPods analytics sends network stats synchronously affecting flutter build latency. +ENV['COCOAPODS_DISABLE_STATS'] = 'true' + +project 'Runner', { + 'Debug' => :debug, + 'Profile' => :release, + 'Release' => :release, +} + +def flutter_root + generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'Generated.xcconfig'), __FILE__) + unless File.exist?(generated_xcode_build_settings_path) + raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure flutter pub get is executed first" + end + + File.foreach(generated_xcode_build_settings_path) do |line| + matches = line.match(/FLUTTER_ROOT\=(.*)/) + return matches[1].strip if matches + end + raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Generated.xcconfig, then run flutter pub get" +end + +require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root) + +flutter_ios_podfile_setup + +target 'Runner' do + use_frameworks! + + flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__)) + target 'RunnerTests' do + inherit! :search_paths + end +end + +post_install do |installer| + installer.pods_project.targets.each do |target| + flutter_additional_ios_build_settings(target) + end +end diff --git a/apps/meshport_lab/ios/Runner.xcodeproj/project.pbxproj b/apps/meshport_lab/ios/Runner.xcodeproj/project.pbxproj new file mode 100644 index 0000000..d448c7c --- /dev/null +++ b/apps/meshport_lab/ios/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,623 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 54; + objects = { + +/* Begin PBXBuildFile section */ + 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; }; + 331C808B294A63AB00263BE5 /* RunnerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 331C807B294A618700263BE5 /* RunnerTests.swift */; }; + 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; }; + 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74858FAE1ED2DC5600515810 /* AppDelegate.swift */; }; + 7884E8682EC3CC0700C636F2 /* SceneDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7884E8672EC3CC0400C636F2 /* SceneDelegate.swift */; }; + 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FA1CF9000F007C117D /* Main.storyboard */; }; + 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FD1CF9000F007C117D /* Assets.xcassets */; }; + 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 331C8085294A63A400263BE5 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 97C146E61CF9000F007C117D /* Project object */; + proxyType = 1; + remoteGlobalIDString = 97C146ED1CF9000F007C117D; + remoteInfo = Runner; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXCopyFilesBuildPhase section */ + 9705A1C41CF9048500538489 /* Embed Frameworks */ = { + isa = PBXCopyFilesBuildPhase; + buildActionMask = 2147483647; + dstPath = ""; + dstSubfolderSpec = 10; + files = ( + ); + name = "Embed Frameworks"; + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXCopyFilesBuildPhase section */ + +/* Begin PBXFileReference section */ + 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = GeneratedPluginRegistrant.h; sourceTree = ""; }; + 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GeneratedPluginRegistrant.m; sourceTree = ""; }; + 331C807B294A618700263BE5 /* RunnerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RunnerTests.swift; sourceTree = ""; }; + 331C8081294A63A400263BE5 /* RunnerTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = ""; }; + 74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Runner-Bridging-Header.h"; sourceTree = ""; }; + 74858FAE1ED2DC5600515810 /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; + 7884E8672EC3CC0400C636F2 /* SceneDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SceneDelegate.swift; sourceTree = ""; }; + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Release.xcconfig; path = Flutter/Release.xcconfig; sourceTree = ""; }; + 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Debug.xcconfig; path = Flutter/Debug.xcconfig; sourceTree = ""; }; + 9740EEB31CF90195004384FC /* Generated.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Generated.xcconfig; path = Flutter/Generated.xcconfig; sourceTree = ""; }; + 97C146EE1CF9000F007C117D /* Runner.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Runner.app; sourceTree = BUILT_PRODUCTS_DIR; }; + 97C146FB1CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = ""; }; + 97C146FD1CF9000F007C117D /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = ""; }; + 97C147001CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = ""; }; + 97C147021CF9000F007C117D /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 97C146EB1CF9000F007C117D /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 331C8082294A63A400263BE5 /* RunnerTests */ = { + isa = PBXGroup; + children = ( + 331C807B294A618700263BE5 /* RunnerTests.swift */, + ); + path = RunnerTests; + sourceTree = ""; + }; + 9740EEB11CF90186004384FC /* Flutter */ = { + isa = PBXGroup; + children = ( + 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */, + 9740EEB21CF90195004384FC /* Debug.xcconfig */, + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, + 9740EEB31CF90195004384FC /* Generated.xcconfig */, + ); + name = Flutter; + sourceTree = ""; + }; + 97C146E51CF9000F007C117D = { + isa = PBXGroup; + children = ( + 9740EEB11CF90186004384FC /* Flutter */, + 97C146F01CF9000F007C117D /* Runner */, + 97C146EF1CF9000F007C117D /* Products */, + 331C8082294A63A400263BE5 /* RunnerTests */, + ); + sourceTree = ""; + }; + 97C146EF1CF9000F007C117D /* Products */ = { + isa = PBXGroup; + children = ( + 97C146EE1CF9000F007C117D /* Runner.app */, + 331C8081294A63A400263BE5 /* RunnerTests.xctest */, + ); + name = Products; + sourceTree = ""; + }; + 97C146F01CF9000F007C117D /* Runner */ = { + isa = PBXGroup; + children = ( + 97C146FA1CF9000F007C117D /* Main.storyboard */, + 97C146FD1CF9000F007C117D /* Assets.xcassets */, + 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */, + 97C147021CF9000F007C117D /* Info.plist */, + 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */, + 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */, + 74858FAE1ED2DC5600515810 /* AppDelegate.swift */, + 7884E8672EC3CC0400C636F2 /* SceneDelegate.swift */, + 74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */, + ); + path = Runner; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 331C8080294A63A400263BE5 /* RunnerTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 331C8087294A63A400263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */; + buildPhases = ( + 331C807D294A63A400263BE5 /* Sources */, + 331C807F294A63A400263BE5 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 331C8086294A63A400263BE5 /* PBXTargetDependency */, + ); + name = RunnerTests; + productName = RunnerTests; + productReference = 331C8081294A63A400263BE5 /* RunnerTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; + 97C146ED1CF9000F007C117D /* Runner */ = { + isa = PBXNativeTarget; + buildConfigurationList = 97C147051CF9000F007C117D /* Build configuration list for PBXNativeTarget "Runner" */; + buildPhases = ( + 9740EEB61CF901F6004384FC /* Run Script */, + 97C146EA1CF9000F007C117D /* Sources */, + 97C146EB1CF9000F007C117D /* Frameworks */, + 97C146EC1CF9000F007C117D /* Resources */, + 9705A1C41CF9048500538489 /* Embed Frameworks */, + 3B06AD1E1E4923F5004D2608 /* Thin Binary */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = Runner; + productName = Runner; + productReference = 97C146EE1CF9000F007C117D /* Runner.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 97C146E61CF9000F007C117D /* Project object */ = { + isa = PBXProject; + attributes = { + BuildIndependentTargetsInParallel = YES; + LastUpgradeCheck = 1510; + ORGANIZATIONNAME = ""; + TargetAttributes = { + 331C8080294A63A400263BE5 = { + CreatedOnToolsVersion = 14.0; + TestTargetID = 97C146ED1CF9000F007C117D; + }; + 97C146ED1CF9000F007C117D = { + CreatedOnToolsVersion = 7.3.1; + LastSwiftMigration = 1100; + }; + }; + }; + buildConfigurationList = 97C146E91CF9000F007C117D /* Build configuration list for PBXProject "Runner" */; + compatibilityVersion = "Xcode 9.3"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 97C146E51CF9000F007C117D; + productRefGroup = 97C146EF1CF9000F007C117D /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 97C146ED1CF9000F007C117D /* Runner */, + 331C8080294A63A400263BE5 /* RunnerTests */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 331C807F294A63A400263BE5 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 97C146EC1CF9000F007C117D /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */, + 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */, + 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */, + 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + 3B06AD1E1E4923F5004D2608 /* Thin Binary */ = { + isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + "${TARGET_BUILD_DIR}/${INFOPLIST_PATH}", + ); + name = "Thin Binary"; + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" embed_and_thin"; + }; + 9740EEB61CF901F6004384FC /* Run Script */ = { + isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + ); + name = "Run Script"; + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" build"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 331C807D294A63A400263BE5 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 331C808B294A63AB00263BE5 /* RunnerTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 97C146EA1CF9000F007C117D /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */, + 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */, + 7884E8682EC3CC0700C636F2 /* SceneDelegate.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 331C8086294A63A400263BE5 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 97C146ED1CF9000F007C117D /* Runner */; + targetProxy = 331C8085294A63A400263BE5 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin PBXVariantGroup section */ + 97C146FA1CF9000F007C117D /* Main.storyboard */ = { + isa = PBXVariantGroup; + children = ( + 97C146FB1CF9000F007C117D /* Base */, + ); + name = Main.storyboard; + sourceTree = ""; + }; + 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */ = { + isa = PBXVariantGroup; + children = ( + 97C147001CF9000F007C117D /* Base */, + ); + name = LaunchScreen.storyboard; + sourceTree = ""; + }; +/* End PBXVariantGroup section */ + +/* Begin XCBuildConfiguration section */ + 249021D3217E4FDB00AE95B9 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 13.0; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = iphoneos; + SUPPORTED_PLATFORMS = iphoneos; + TARGETED_DEVICE_FAMILY = "1,2"; + VALIDATE_PRODUCT = YES; + }; + name = Profile; + }; + 249021D4217E4FDB00AE95B9 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; + DEVELOPMENT_TEAM = Q659D4XU6T; + ENABLE_BITCODE = NO; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; + SWIFT_VERSION = 5.0; + VERSIONING_SYSTEM = "apple-generic"; + }; + name = Profile; + }; + 331C8088294A63A400263BE5 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/Runner"; + }; + name = Debug; + }; + 331C8089294A63A400263BE5 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/Runner"; + }; + name = Release; + }; + 331C808A294A63A400263BE5 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CODE_SIGN_STYLE = Automatic; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/Runner.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/Runner"; + }; + name = Profile; + }; + 97C147031CF9000F007C117D /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 13.0; + MTL_ENABLE_DEBUG_INFO = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = iphoneos; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Debug; + }; + 97C147041CF9000F007C117D /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++0x"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu99; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 13.0; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = iphoneos; + SUPPORTED_PLATFORMS = iphoneos; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + TARGETED_DEVICE_FAMILY = "1,2"; + VALIDATE_PRODUCT = YES; + }; + name = Release; + }; + 97C147061CF9000F007C117D /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; + DEVELOPMENT_TEAM = Q659D4XU6T; + ENABLE_BITCODE = NO; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + VERSIONING_SYSTEM = "apple-generic"; + }; + name = Debug; + }; + 97C147071CF9000F007C117D /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; + DEVELOPMENT_TEAM = Q659D4XU6T; + ENABLE_BITCODE = NO; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_OBJC_BRIDGING_HEADER = "Runner/Runner-Bridging-Header.h"; + SWIFT_VERSION = 5.0; + VERSIONING_SYSTEM = "apple-generic"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 331C8087294A63A400263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 331C8088294A63A400263BE5 /* Debug */, + 331C8089294A63A400263BE5 /* Release */, + 331C808A294A63A400263BE5 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 97C146E91CF9000F007C117D /* Build configuration list for PBXProject "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 97C147031CF9000F007C117D /* Debug */, + 97C147041CF9000F007C117D /* Release */, + 249021D3217E4FDB00AE95B9 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 97C147051CF9000F007C117D /* Build configuration list for PBXNativeTarget "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 97C147061CF9000F007C117D /* Debug */, + 97C147071CF9000F007C117D /* Release */, + 249021D4217E4FDB00AE95B9 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 97C146E61CF9000F007C117D /* Project object */; +} diff --git a/apps/meshport_lab/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/apps/meshport_lab/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..919434a --- /dev/null +++ b/apps/meshport_lab/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/apps/meshport_lab/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/apps/meshport_lab/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/apps/meshport_lab/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/apps/meshport_lab/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/apps/meshport_lab/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/apps/meshport_lab/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/apps/meshport_lab/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/apps/meshport_lab/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 0000000..e3773d4 --- /dev/null +++ b/apps/meshport_lab/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,101 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apps/meshport_lab/ios/Runner.xcworkspace/contents.xcworkspacedata b/apps/meshport_lab/ios/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..1d526a1 --- /dev/null +++ b/apps/meshport_lab/ios/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/apps/meshport_lab/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/apps/meshport_lab/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/apps/meshport_lab/ios/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/apps/meshport_lab/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/apps/meshport_lab/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/apps/meshport_lab/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/apps/meshport_lab/ios/Runner/AppDelegate.swift b/apps/meshport_lab/ios/Runner/AppDelegate.swift new file mode 100644 index 0000000..c30b367 --- /dev/null +++ b/apps/meshport_lab/ios/Runner/AppDelegate.swift @@ -0,0 +1,16 @@ +import Flutter +import UIKit + +@main +@objc class AppDelegate: FlutterAppDelegate, FlutterImplicitEngineDelegate { + override func application( + _ application: UIApplication, + didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? + ) -> Bool { + return super.application(application, didFinishLaunchingWithOptions: launchOptions) + } + + func didInitializeImplicitFlutterEngine(_ engineBridge: FlutterImplicitEngineBridge) { + GeneratedPluginRegistrant.register(with: engineBridge.pluginRegistry) + } +} diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 0000000..d36b1fa --- /dev/null +++ b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json @@ -0,0 +1,122 @@ +{ + "images" : [ + { + "size" : "20x20", + "idiom" : "iphone", + "filename" : "Icon-App-20x20@2x.png", + "scale" : "2x" + }, + { + "size" : "20x20", + "idiom" : "iphone", + "filename" : "Icon-App-20x20@3x.png", + "scale" : "3x" + }, + { + "size" : "29x29", + "idiom" : "iphone", + "filename" : "Icon-App-29x29@1x.png", + "scale" : "1x" + }, + { + "size" : "29x29", + "idiom" : "iphone", + "filename" : "Icon-App-29x29@2x.png", + "scale" : "2x" + }, + { + "size" : "29x29", + "idiom" : "iphone", + "filename" : "Icon-App-29x29@3x.png", + "scale" : "3x" + }, + { + "size" : "40x40", + "idiom" : "iphone", + "filename" : "Icon-App-40x40@2x.png", + "scale" : "2x" + }, + { + "size" : "40x40", + "idiom" : "iphone", + "filename" : "Icon-App-40x40@3x.png", + "scale" : "3x" + }, + { + "size" : "60x60", + "idiom" : "iphone", + "filename" : "Icon-App-60x60@2x.png", + "scale" : "2x" + }, + { + "size" : "60x60", + "idiom" : "iphone", + "filename" : "Icon-App-60x60@3x.png", + "scale" : "3x" + }, + { + "size" : "20x20", + "idiom" : "ipad", + "filename" : "Icon-App-20x20@1x.png", + "scale" : "1x" + }, + { + "size" : "20x20", + "idiom" : "ipad", + "filename" : "Icon-App-20x20@2x.png", + "scale" : "2x" + }, + { + "size" : "29x29", + "idiom" : "ipad", + "filename" : "Icon-App-29x29@1x.png", + "scale" : "1x" + }, + { + "size" : "29x29", + "idiom" : "ipad", + "filename" : "Icon-App-29x29@2x.png", + "scale" : "2x" + }, + { + "size" : "40x40", + "idiom" : "ipad", + "filename" : "Icon-App-40x40@1x.png", + "scale" : "1x" + }, + { + "size" : "40x40", + "idiom" : "ipad", + "filename" : "Icon-App-40x40@2x.png", + "scale" : "2x" + }, + { + "size" : "76x76", + "idiom" : "ipad", + "filename" : "Icon-App-76x76@1x.png", + "scale" : "1x" + }, + { + "size" : "76x76", + "idiom" : "ipad", + "filename" : "Icon-App-76x76@2x.png", + "scale" : "2x" + }, + { + "size" : "83.5x83.5", + "idiom" : "ipad", + "filename" : "Icon-App-83.5x83.5@2x.png", + "scale" : "2x" + }, + { + "size" : "1024x1024", + "idiom" : "ios-marketing", + "filename" : "Icon-App-1024x1024@1x.png", + "scale" : "1x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +} diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png new file mode 100644 index 0000000..5440d98 Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-1024x1024@1x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png new file mode 100644 index 0000000..1cb5ebf Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@1x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png new file mode 100644 index 0000000..8760ffb Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@2x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png new file mode 100644 index 0000000..025b274 Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-20x20@3x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png new file mode 100644 index 0000000..384dca7 Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@1x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png new file mode 100644 index 0000000..4e2b57f Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@2x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png new file mode 100644 index 0000000..8e2867b Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-29x29@3x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png new file mode 100644 index 0000000..8760ffb Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@1x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png new file mode 100644 index 0000000..dfe2a51 Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@2x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png new file mode 100644 index 0000000..4558638 Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-40x40@3x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png new file mode 100644 index 0000000..4558638 Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@2x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png new file mode 100644 index 0000000..a4db724 Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-60x60@3x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png new file mode 100644 index 0000000..398ed60 Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@1x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png new file mode 100644 index 0000000..36fcd6f Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-76x76@2x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png new file mode 100644 index 0000000..47aa3e6 Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/AppIcon.appiconset/Icon-App-83.5x83.5@2x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json new file mode 100644 index 0000000..0bedcf2 --- /dev/null +++ b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/Contents.json @@ -0,0 +1,23 @@ +{ + "images" : [ + { + "idiom" : "universal", + "filename" : "LaunchImage.png", + "scale" : "1x" + }, + { + "idiom" : "universal", + "filename" : "LaunchImage@2x.png", + "scale" : "2x" + }, + { + "idiom" : "universal", + "filename" : "LaunchImage@3x.png", + "scale" : "3x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +} diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png new file mode 100644 index 0000000..9da19ea Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png new file mode 100644 index 0000000..9da19ea Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@2x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png new file mode 100644 index 0000000..9da19ea Binary files /dev/null and b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/LaunchImage@3x.png differ diff --git a/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md new file mode 100644 index 0000000..89c2725 --- /dev/null +++ b/apps/meshport_lab/ios/Runner/Assets.xcassets/LaunchImage.imageset/README.md @@ -0,0 +1,5 @@ +# Launch Screen Assets + +You can customize the launch screen with your own desired assets by replacing the image files in this directory. + +You can also do it by opening your Flutter project's Xcode project with `open ios/Runner.xcworkspace`, selecting `Runner/Assets.xcassets` in the Project Navigator and dropping in the desired images. \ No newline at end of file diff --git a/apps/meshport_lab/ios/Runner/Base.lproj/LaunchScreen.storyboard b/apps/meshport_lab/ios/Runner/Base.lproj/LaunchScreen.storyboard new file mode 100644 index 0000000..f2e259c --- /dev/null +++ b/apps/meshport_lab/ios/Runner/Base.lproj/LaunchScreen.storyboard @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apps/meshport_lab/ios/Runner/Base.lproj/Main.storyboard b/apps/meshport_lab/ios/Runner/Base.lproj/Main.storyboard new file mode 100644 index 0000000..f3c2851 --- /dev/null +++ b/apps/meshport_lab/ios/Runner/Base.lproj/Main.storyboard @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apps/meshport_lab/ios/Runner/Info.plist b/apps/meshport_lab/ios/Runner/Info.plist new file mode 100644 index 0000000..588685a --- /dev/null +++ b/apps/meshport_lab/ios/Runner/Info.plist @@ -0,0 +1,70 @@ + + + + + CADisableMinimumFrameDurationOnPhone + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleDisplayName + MeshPort + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + MeshPort + CFBundlePackageType + APPL + CFBundleShortVersionString + $(FLUTTER_BUILD_NAME) + CFBundleSignature + ???? + CFBundleVersion + $(FLUTTER_BUILD_NUMBER) + LSRequiresIPhoneOS + + UIApplicationSceneManifest + + UIApplicationSupportsMultipleScenes + + UISceneConfigurations + + UIWindowSceneSessionRoleApplication + + + UISceneClassName + UIWindowScene + UISceneConfigurationName + flutter + UISceneDelegateClassName + $(PRODUCT_MODULE_NAME).SceneDelegate + UISceneStoryboardFile + Main + + + + + UIApplicationSupportsIndirectInputEvents + + UILaunchStoryboardName + LaunchScreen + UIMainStoryboardFile + Main + UISupportedInterfaceOrientations + + UIInterfaceOrientationPortrait + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + UISupportedInterfaceOrientations~ipad + + UIInterfaceOrientationPortrait + UIInterfaceOrientationPortraitUpsideDown + UIInterfaceOrientationLandscapeLeft + UIInterfaceOrientationLandscapeRight + + + diff --git a/apps/meshport_lab/ios/Runner/Runner-Bridging-Header.h b/apps/meshport_lab/ios/Runner/Runner-Bridging-Header.h new file mode 100644 index 0000000..308a2a5 --- /dev/null +++ b/apps/meshport_lab/ios/Runner/Runner-Bridging-Header.h @@ -0,0 +1 @@ +#import "GeneratedPluginRegistrant.h" diff --git a/apps/meshport_lab/ios/Runner/SceneDelegate.swift b/apps/meshport_lab/ios/Runner/SceneDelegate.swift new file mode 100644 index 0000000..b9ce8ea --- /dev/null +++ b/apps/meshport_lab/ios/Runner/SceneDelegate.swift @@ -0,0 +1,6 @@ +import Flutter +import UIKit + +class SceneDelegate: FlutterSceneDelegate { + +} diff --git a/apps/meshport_lab/ios/RunnerTests/RunnerTests.swift b/apps/meshport_lab/ios/RunnerTests/RunnerTests.swift new file mode 100644 index 0000000..86a7c3b --- /dev/null +++ b/apps/meshport_lab/ios/RunnerTests/RunnerTests.swift @@ -0,0 +1,12 @@ +import Flutter +import UIKit +import XCTest + +class RunnerTests: XCTestCase { + + func testExample() { + // If you add code to the Runner application, consider adding tests here. + // See https://developer.apple.com/documentation/xctest for more information about using XCTest. + } + +} diff --git a/apps/meshport_lab/lib/app.dart b/apps/meshport_lab/lib/app.dart new file mode 100644 index 0000000..2b1b7cd --- /dev/null +++ b/apps/meshport_lab/lib/app.dart @@ -0,0 +1,32 @@ +import 'package:flutter/material.dart'; +import 'features/lab_screen.dart'; + +class MeshPortApp extends StatelessWidget { + const MeshPortApp({super.key}); + @override + Widget build(BuildContext context) => MaterialApp( + title: 'MeshPort', + debugShowCheckedModeBanner: false, + theme: ThemeData( + useMaterial3: true, + colorScheme: ColorScheme.fromSeed( + seedColor: const Color(0xff087d8e), + surface: const Color(0xfffaf8f4), + ), + scaffoldBackgroundColor: const Color(0xfffaf8f4), + inputDecorationTheme: const InputDecorationTheme( + border: OutlineInputBorder(), + isDense: true, + ), + cardTheme: CardThemeData( + elevation: 0, + color: Colors.white, + shape: RoundedRectangleBorder( + borderRadius: BorderRadius.circular(14), + side: const BorderSide(color: Color(0xffe4e0d9)), + ), + ), + ), + home: const LabScreen(), + ); +} diff --git a/apps/meshport_lab/lib/features/config_import_dialog.dart b/apps/meshport_lab/lib/features/config_import_dialog.dart new file mode 100644 index 0000000..53a40d1 --- /dev/null +++ b/apps/meshport_lab/lib/features/config_import_dialog.dart @@ -0,0 +1,41 @@ +import 'package:flutter/material.dart'; + +/// The dialog owns its controller until the route has actually been removed. +class ConfigImportDialog extends StatefulWidget { + const ConfigImportDialog({super.key}); + @override + State createState() => _ConfigImportDialogState(); +} + +class _ConfigImportDialogState extends State { + final editor = TextEditingController(); + @override + void dispose() { + editor.dispose(); + super.dispose(); + } + + @override + Widget build(BuildContext context) => AlertDialog( + title: const Text('导入 TOML'), + content: SizedBox( + width: 560, + child: TextField( + controller: editor, + maxLines: 12, + autofocus: true, + decoration: const InputDecoration(hintText: '粘贴完整配置。不支持的配置将拒绝导入。'), + ), + ), + actions: [ + TextButton( + onPressed: () => Navigator.pop(context), + child: const Text('取消'), + ), + FilledButton( + onPressed: () => Navigator.pop(context, editor.text), + child: const Text('校验并连接'), + ), + ], + ); +} diff --git a/apps/meshport_lab/lib/features/lab_screen.dart b/apps/meshport_lab/lib/features/lab_screen.dart new file mode 100644 index 0000000..c2d8bd3 --- /dev/null +++ b/apps/meshport_lab/lib/features/lab_screen.dart @@ -0,0 +1,1090 @@ +import 'dart:async'; +import 'dart:convert'; +import 'dart:io'; +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:meshport_flutter/meshport_flutter.dart'; +import 'config_import_dialog.dart'; +import 'network_telemetry.dart'; + +class LabScreen extends StatefulWidget { + const LabScreen({super.key, this.initializeNative = true}); + final bool initializeNative; + @override + State createState() => _LabScreenState(); +} + +class _LabScreenState extends State { + MeshPortClient? client, applicationClient, systemClient; + String runtimeMode = 'application'; + bool rememberConfig = false; + String? savedConfig; + String? loadedConfig, loadedForm; + static const vpnChannel = MethodChannel('meshport/system_vpn'); + Timer? timer; + int page = 0, configTab = 0, completed = 0, failed = 0; + bool busy = false, + udp = false, + echo = false, + stability = false, + cancel = false; + bool refreshing = false; + String eventInstance = ''; + int eventSequence = 0, traceSequence = 0; + bool autoIp = false, latencyFirst = true, ipv6 = true; + String routeMode = 'adaptive'; + bool preferUdp = true; + final relayIds = TextEditingController(); + final qualitySamples = >[]; + bool qualityRunning = false; + Map status = {'state': 'Stopped', 'peer_count': 0}; + Map? result; + final logs = []; + final latencies = []; + final name = TextEditingController(text: 'game-net'); + final secret = TextEditingController(); + final hostname = TextEditingController(text: 'MeshPort'); + final ip = TextEditingController(text: '10.77.0.11'); + final peers = TextEditingController(); + final target = TextEditingController(text: '10.77.0.2:7007'); + final count = TextEditingController(text: '100'); + String error = ''; + bool get running => status['state'] == 'Running'; + bool get profileSupported => Platform.isMacOS || Platform.isAndroid; + String get profileStorage => + Platform.isAndroid ? 'Android 安全存储' : 'macOS 钥匙串'; + @override + void initState() { + super.initState(); + if (widget.initializeNative) { + unawaited(initialize()); + } + } + + Future initialize() async { + try { + const path = String.fromEnvironment('MESHPORT_LIBRARY'); + final opened = await MeshPortClient.open( + libraryPath: path.isEmpty ? null : path, + ); + if (!mounted) { + await opened.close(); + return; + } + client = applicationClient = opened; + log('原生库已加载 · ABI v1'); + if (profileSupported) { + try { + final stored = (await vpnChannel.invokeMethod( + 'load_profile', + ))?.replaceAll(RegExp(r'^subnet_routes\s*=.*$', multiLine: true), ''); + if (stored != null) { + await loadForm(stored); + if (mounted) { + setState(() { + savedConfig = stored; + rememberConfig = true; + }); + } + log('已自动载入保存的网络配置,点击连接即可组网'); + } + } catch (_) { + log('读取已保存配置失败,请在设置中重试'); + } + } + final diagnostics = await opened.enableDiagnostics(); + log(diagnostics['enabled'] == true ? '穿透详细日志采集已开启' : '穿透日志未接管:宿主已有日志订阅器'); + if (Platform.isAndroid) { + final snapshot = await androidVpnRequest({'op': 'status'}); + final data = snapshot['data'] as Map?; + if (data?['state'] == 'Running') { + systemClient = client = MeshPortClient.fromTransport( + request: androidVpnRequest, + close: () async { + await androidVpnRequest({'op': 'stop'}); + }, + ); + runtimeMode = 'system_vpn'; + log('已恢复正在运行的 Android VPN 会话'); + await refresh(); + } + } + timer = Timer.periodic(const Duration(seconds: 2), (_) { + if (!busy) { + unawaited(refresh()); + } + }); + } catch (e) { + if (mounted) { + setState(() => error = '原生库未加载,请先构建并指定 MESHPORT_LIBRARY。$e'); + } + } + } + + Future> androidVpnRequest( + Map request, + ) async { + final response = await vpnChannel.invokeMethod( + 'android_vpn_request', + jsonEncode(request), + ); + return jsonDecode(response!) as Map; + } + + void log(String text) { + if (!mounted) { + return; + } + setState(() { + logs.insert( + 0, + '${DateTime.now().toIso8601String().substring(11, 19)} $text', + ); + if (logs.length > 300) { + logs.removeLast(); + } + }); + } + + Future refresh() async { + if (refreshing) return; + refreshing = true; + try { + final next = await client?.status(); + if (mounted && next != null) { + final instance = next['instance_id'] as String? ?? ''; + if (eventInstance != instance) { + eventInstance = instance; + eventSequence = 0; + } + for (final event in next['native_events'] as List? ?? []) { + final sequence = (event['sequence'] as num).toInt(); + if (sequence > eventSequence) { + log('原生 · ${event['message']}'); + eventSequence = sequence; + } + } + for (final trace in next['diagnostic_traces'] as List? ?? []) { + final sequence = (trace['sequence'] as num).toInt(); + if (sequence > traceSequence) { + log('穿透 · ${trace['message']}'); + traceSequence = sequence; + } + } + setState(() => status = next); + } + } catch (e) { + if (mounted && systemClient != null && status['state'] != 'Failed') { + setState(() { + status = { + 'state': 'Failed', + 'runtime_mode': 'system_vpn', + 'peer_count': 0, + }; + error = 'VPN 辅助进程已断开,请重新连接。'; + }); + } + } finally { + refreshing = false; + } + } + + Future perform(Future Function(MeshPortClient) action) async { + if (busy || client == null) { + return; + } + setState(() { + busy = true; + error = ''; + }); + try { + await action(client!); + await refresh(); + } catch (e) { + log('操作失败:$e'); + if (mounted) { + setState(() => error = '$e'); + } + } finally { + if (mounted) { + setState(() => busy = false); + } + } + } + + String buildConfig() { + final form = buildFormConfig(); + return loadedForm == form && loadedConfig != null ? loadedConfig! : form; + } + + Future loadForm(String config) async { + final validated = await applicationClient!.request({ + 'op': 'validate', + 'toml': config, + 'include_profile': true, + }); + if (!mounted) return; + final profile = validated['profile'] as Map; + final optimization = profile['optimization'] as Map; + setState(() { + name.text = profile['network_name'] as String; + secret.text = profile['network_secret'] as String; + hostname.text = profile['hostname'] as String; + ip.text = profile['ipv4'] as String; + autoIp = profile['dhcp'] == true; + peers.text = (profile['peers'] as List).join('\n'); + ipv6 = profile['enable_ipv6'] == true; + latencyFirst = profile['latency_first'] == true; + runtimeMode = validated['runtime_mode'] as String; + routeMode = optimization['mode'] as String; + preferUdp = optimization['prefer_udp'] == true; + relayIds.text = (optimization['relay_peer_ids'] as List).join(','); + loadedConfig = config; + loadedForm = buildFormConfig(); + }); + } + + String buildFormConfig() { + final addresses = peers.text + .split('\n') + .map((v) => v.trim()) + .where((v) => v.isNotEmpty); + return 'hostname = ${jsonEncode(hostname.text)}\n${autoIp ? 'dhcp = true' : 'ipv4 = ${jsonEncode(ip.text)}'}\nlisteners = []\n' + '${addresses.map((v) => '[[peer]]\nuri = ${jsonEncode(v)}\n').join()}' + '[network_identity]\nnetwork_name = ${jsonEncode(name.text)}\nnetwork_secret = ${jsonEncode(secret.text)}\n' + '[flags]\nno_tun = ${runtimeMode == 'application'}\nuse_smoltcp = ${runtimeMode == 'application'}\nenable_encryption = true\ndefault_protocol = "udp"\nlatency_first = $latencyFirst\nenable_ipv6 = $ipv6\n' + '[runtime]\nmode = ${jsonEncode(runtimeMode)}\n' + '[optimization]\nmode = ${jsonEncode(routeMode)}\nprefer_udp = $preferUdp\nrelay_peer_ids = [${relayIds.text.split(RegExp(r"[,\s]+")).where((v) => v.isNotEmpty).join(',')}]\n'; + } + + Future connect(MeshPortClient c) async { + final config = buildConfig(); + await startConfig(config); + log('组网引擎已启动,等待节点连接'); + } + + Future startConfig(String config) async { + // Validation selects mode from effective flags, avoiding ad-hoc TOML parsing. + final validated = await applicationClient!.request({ + 'op': 'validate', + 'toml': config, + }); + final system = validated['runtime_mode'] == 'system_vpn'; + if (systemClient != null) { + try { + await systemClient!.close(); + } catch (_) {} + systemClient = null; + client = applicationClient; + } + if (!system) { + await applicationClient!.start(config); + await saveProfile(config); + return; + } + final opened = Platform.isAndroid + ? await openAndroidSystemVpn( + prepare: () async { + log('等待 Android VPN 授权'); + await vpnChannel.invokeMethod('prepare_android_vpn'); + }, + request: androidVpnRequest, + ) + : await openMacSystemVpn( + launch: (path, uid) async { + log('等待管理员授权以创建虚拟网卡'); + await vpnChannel.invokeMethod('launch', { + 'socket': path, + 'uid': uid, + }); + }, + ); + try { + await opened.enableDiagnostics(); + await opened.start(config); + systemClient = client = opened; + log('系统 VPN 已启动,接入虚拟网段与远端子网'); + await saveProfile(config); + } catch (_) { + await opened.close(); + rethrow; + } + } + + Future saveProfile(String config, {bool explicit = false}) async { + if ((!rememberConfig && !explicit) || !profileSupported) return; + try { + await applicationClient!.request({'op': 'validate', 'toml': config}); + await vpnChannel.invokeMethod('save_profile', config); + if (mounted) { + setState(() { + savedConfig = config; + rememberConfig = true; + }); + } + log('网络配置已保存到 $profileStorage'); + } catch (_) { + if (explicit) throw StateError('配置保存失败,请检查配置和安全存储访问权限'); + log('连接成功,但配置未能保存到 $profileStorage'); + } + } + + Future stopActive(MeshPortClient c) async { + try { + await c.stop(); + } finally { + if (systemClient != null) { + try { + await systemClient!.close(); + } finally { + systemClient = null; + client = applicationClient; + } + } + } + log('已停止并释放网络资源'); + } + + Future probe(MeshPortClient c) async { + final next = await c.probe(target.text.trim(), udp: udp, echo: echo || udp); + if (mounted) { + setState(() { + result = next; + latencies.add((next['elapsed_ms'] as num).toDouble()); + if (latencies.length > 60) { + latencies.removeAt(0); + } + }); + } + log( + '${next['protocol']} ${next['kind']} 成功 · ${(next['elapsed_ms'] as num).toStringAsFixed(1)} ms', + ); + } + + Future repeat(MeshPortClient c) async { + final rounds = int.tryParse(count.text); + if (rounds == null || rounds < 1 || rounds > 10000) { + throw ArgumentError('测试次数应为 1–10000'); + } + cancel = false; + setState(() { + completed = 0; + failed = 0; + }); + for (var i = 0; i < rounds && !cancel && mounted; i++) { + try { + await probe(c); + } catch (e) { + if (mounted) { + setState(() => failed++); + } + log('第 ${i + 1} 次失败:$e'); + } + if (mounted) { + setState(() => completed++); + } + if (!cancel) { + await Future.delayed(const Duration(milliseconds: 500)); + } + } + log('重复探测结束:$completed 次,失败 $failed 次'); + } + + Future measureQuality(MeshPortClient c) async { + cancel = false; + setState(() { + qualitySamples.clear(); + qualityRunning = true; + }); + int? socket; + final nonce = DateTime.now().microsecondsSinceEpoch; + final address = target.text.trim(); + try { + socket = await c.bindUdp(); + await c.sampleUdpQuality( + socket, + address, + nonce, + ); // Warm up before measured samples. + for (var i = 0; i < 60 && !cancel && mounted; i++) { + final sample = await c.sampleUdpQuality(socket, address, nonce + i + 1); + if (mounted) setState(() => qualitySamples.add(sample)); + if (!cancel) { + await Future.delayed(const Duration(milliseconds: 500)); + } + } + log('线路质量测量完成 · ${qualitySamples.length} 次 UDP 回显'); + } finally { + if (socket != null) await c.closeResource(socket); + if (mounted) setState(() => qualityRunning = false); + } + } + + Widget qualityPanel() { + final groups = >>{}; + for (final sample in qualitySamples) { + final path = sample['route_changed'] == true + ? '路径切换期间' + : sample['next_hop_peer_id']?.toString() ?? '未知'; + groups.putIfAbsent(path, () => []).add(sample); + } + String ms(double? value) => + value == null ? '—' : '${value.toStringAsFixed(1)} ms'; + return panel('线路质量 · 端到端 UDP 回显', [ + Text( + status['runtime_mode'] == 'system_vpn' + ? '系统 VPN 首版可使用上方系统 socket 建连/回显测试;批量质量测量暂限应用内模式。' + : '使用上方目标地址。需要回显服务;测量当前实际路径,不强制切换候选线路。', + ), + const SizedBox(height: 10), + FilledButton.icon( + onPressed: busy || !running || status['runtime_mode'] == 'system_vpn' + ? null + : () => perform(measureQuality), + icon: const Icon(Icons.analytics_outlined), + label: const Text('测量线路质量(60 次)'), + ), + if (qualityRunning) + TextButton( + onPressed: () => setState(() => cancel = true), + child: const Text('停止测量'), + ), + for (final entry in groups.entries) ...[ + const SizedBox(height: 12), + Text('下一跳 ${entry.key} · ${entry.value.length} 次'), + Builder( + builder: (_) { + final summary = QualitySummary(entry.value); + return Text( + '中位 RTT ${ms(summary.medianMs)} · P95 ${ms(summary.p95Ms)}\n抖动 ${ms(summary.jitterMs)} · 未响应 ${summary.lossPercent?.toStringAsFixed(1) ?? '—'}%', + ); + }, + ), + ], + const Text('抖动为相邻成功样本 RTT 差的平均值。超时可能来自丢包或服务未响应。'), + ]); + } + + @override + void dispose() { + cancel = true; + timer?.cancel(); + if (client != null) { + unawaited(client!.close()); + if (applicationClient != client) unawaited(applicationClient!.close()); + } + for (final c in [ + name, + secret, + hostname, + ip, + peers, + target, + count, + relayIds, + ]) { + c.dispose(); + } + super.dispose(); + } + + Widget panel(String title, List children) => Card( + child: Padding( + padding: const EdgeInsets.all(18), + child: Column( + crossAxisAlignment: CrossAxisAlignment.stretch, + children: [ + Text( + title, + style: const TextStyle(fontSize: 17, fontWeight: FontWeight.w600), + ), + const SizedBox(height: 14), + ...children, + ], + ), + ), + ); + Widget field( + String label, + TextEditingController c, { + bool obscure = false, + int lines = 1, + }) => Padding( + padding: const EdgeInsets.only(bottom: 12), + child: TextField( + controller: c, + obscureText: obscure, + maxLines: lines, + decoration: InputDecoration(labelText: label), + enabled: !busy && !running, + ), + ); + Widget metric(String title, String value) => Expanded( + child: panel(title, [ + Text( + value, + style: const TextStyle( + fontSize: 30, + fontWeight: FontWeight.w600, + color: Color(0xff8a611c), + ), + ), + ]), + ); + Widget overview() => Column( + crossAxisAlignment: CrossAxisAlignment.stretch, + children: [ + Card( + color: const Color(0xffe4f3f5), + child: ListTile( + leading: Icon( + running ? Icons.circle : Icons.circle_outlined, + color: const Color(0xff087d8e), + ), + title: Text(running ? '引擎运行中 · ${status['peer_count']} 个节点' : '尚未连接'), + subtitle: Text( + '虚拟 IP:${status['ipv4'] ?? '—'} · ${status['runtime_mode'] == 'system_vpn' ? '系统 VPN · ${status['platform_network']?['ready'] == true ? '虚拟网卡就绪' : '虚拟网卡未就绪'}' : '应用内网络'}', + ), + trailing: TextButton( + onPressed: busy || client == null + ? null + : () => perform( + running + ? (c) async { + await stopActive(c); + } + : connect, + ), + child: Text(running ? '断开连接' : '连接网络'), + ), + ), + ), + Row( + children: [ + metric( + '最近测试耗时', + result == null + ? '—' + : '${(result!['elapsed_ms'] as num).toStringAsFixed(1)} ms', + ), + metric('远端节点', '${status['peer_count'] ?? 0}'), + ], + ), + panel('网络流量', [ + Row( + children: [ + metric( + '↓ 下载速率', + formatBytes( + status['traffic']?['rx_bytes_per_second'] as num?, + rate: true, + ), + ), + metric( + '↑ 上传速率', + formatBytes( + status['traffic']?['tx_bytes_per_second'] as num?, + rate: true, + ), + ), + ], + ), + const SizedBox(height: 8), + Text( + '本次引擎运行累计 ↓ ${formatBytes(status['traffic']?['rx_bytes'] as num?)} ↑ ${formatBytes(status['traffic']?['tx_bytes'] as num?)}', + ), + const Text('隧道流量,包含心跳与组网控制报文;每 2 秒刷新'), + ]), + panel('远端子网', [ + Text( + '自动接入:${(status['platform_network']?['subnet_routes'] as List? ?? []).isEmpty ? '无' : (status['platform_network']['subnet_routes'] as List).join(', ')}', + ), + const Text('自动学习节点发布的子网;列表显示允许接入的路由。系统模式可在路由表确认接口。'), + ]), + panel('节点链路', [NodeTelemetry(status: status)]), + panel('NAT 与穿透诊断', [ + Text( + 'UDP NAT:${status['connectivity']?['udp_nat_type'] ?? '等待检测'} · TCP NAT:${status['connectivity']?['tcp_nat_type'] ?? '等待检测'}', + ), + Text( + '实际监听:${(status['connectivity']?['listeners'] as List? ?? []).join(', ').isEmpty ? '无普通监听端口' : (status['connectivity']['listeners'] as List).join(', ')}', + ), + const Text('本库未启用 UPnP;无普通监听端口不等于关闭打洞。'), + TextButton.icon( + onPressed: () async { + await Clipboard.setData( + ClipboardData( + text: const JsonEncoder.withIndent(' ').convert(status), + ), + ); + log('网络诊断已复制(不含网络密钥,含节点名称和地址)'); + }, + icon: const Icon(Icons.copy), + label: const Text('复制网络诊断'), + ), + ]), + panel('最近测试趋势', [ + const Text('显示连接或回显耗时,并非持续服务器 RTT'), + const SizedBox(height: 12), + SizedBox(height: 140, child: CustomPaint(painter: _Trend(latencies))), + ]), + panel('快速测试', [ + Text('目标 ${target.text}'), + const SizedBox(height: 12), + FilledButton.icon( + onPressed: () => setState(() => page = 2), + icon: const Icon(Icons.play_arrow), + label: const Text('打开连接测试'), + ), + ]), + panel( + '最近事件', + logs + .take(4) + .map( + (v) => Padding( + padding: const EdgeInsets.only(bottom: 8), + child: Text(v), + ), + ) + .toList(), + ), + ], + ); + Widget nodes() => panel('节点与链路', [NodeTelemetry(status: status)]); + + Widget tests() => Column( + children: [ + SegmentedButton( + segments: const [ + ButtonSegment(value: false, label: Text('连接测试')), + ButtonSegment(value: true, label: Text('稳定性')), + ], + selected: {stability}, + onSelectionChanged: busy + ? null + : (s) => setState(() => stability = s.first), + ), + const SizedBox(height: 12), + panel(stability ? '重复探测' : 'TCP / UDP 连接测试', [ + TextField( + controller: target, + enabled: !busy, + decoration: const InputDecoration(labelText: '目标虚拟 IP:端口'), + ), + const SizedBox(height: 12), + SegmentedButton( + segments: const [ + ButtonSegment(value: false, label: Text('TCP')), + ButtonSegment(value: true, label: Text('UDP')), + ], + selected: {udp}, + onSelectionChanged: busy + ? null + : (s) => setState(() => udp = s.first), + ), + SwitchListTile( + contentPadding: EdgeInsets.zero, + title: const Text('回显与数据校验'), + subtitle: Text(udp ? 'UDP 必须有回显服务端响应' : '关闭时只验证 TCP 建连;开启需回显服务端'), + value: echo || udp, + onChanged: busy || udp ? null : (v) => setState(() => echo = v), + ), + if (stability) ...[ + TextField( + controller: count, + enabled: !busy, + keyboardType: TextInputType.number, + decoration: const InputDecoration(labelText: '次数(1–10000)'), + ), + const SizedBox(height: 12), + Text('完成 $completed · 失败 $failed'), + const SizedBox(height: 10), + const Text('此模式反复创建连接/套接字,不重启组网引擎。'), + ], + const SizedBox(height: 12), + FilledButton( + onPressed: busy || !running + ? null + : () => perform(stability ? repeat : probe), + child: Text(busy ? '测试进行中…' : '开始测试'), + ), + if (busy && stability) + OutlinedButton( + onPressed: () => setState(() => cancel = true), + child: const Text('停止(当前探测结束后)'), + ), + ]), + qualityPanel(), + if (result != null) + panel('最近成功结果', [ + Text( + const JsonEncoder.withIndent(' ').convert(result), + style: const TextStyle(fontFamily: 'monospace'), + ), + ]), + ], + ); + Widget profilePanel() => panel('配置保存', [ + Text( + savedConfig == null + ? '保存后,下次启动自动填写网络配置。网络密钥保存在 $profileStorage 中。' + : '已保存网络配置 · 启动时自动载入,手动点击连接。', + ), + const SizedBox(height: 12), + Wrap( + spacing: 12, + runSpacing: 8, + children: [ + FilledButton.icon( + onPressed: busy || client == null + ? null + : () => + perform((_) => saveProfile(buildConfig(), explicit: true)), + icon: const Icon(Icons.save_outlined), + label: const Text('保存配置'), + ), + if (savedConfig != null) ...[ + OutlinedButton( + onPressed: busy || running + ? null + : () => perform((_) => loadForm(savedConfig!)), + child: const Text('重新载入配置'), + ), + TextButton( + onPressed: busy || running + ? null + : () async { + try { + await vpnChannel.invokeMethod('delete_profile'); + if (mounted) { + setState(() { + savedConfig = null; + rememberConfig = false; + }); + } + log('已删除保存的配置'); + } catch (_) { + log('删除已保存配置失败'); + } + }, + child: const Text('删除已保存配置'), + ), + ], + ], + ), + SwitchListTile( + contentPadding: EdgeInsets.zero, + title: const Text('连接成功后自动保存配置'), + subtitle: const Text('包含网络密钥;不会在启动时自动连接'), + value: rememberConfig, + onChanged: busy + ? null + : (value) => setState(() => rememberConfig = value), + ), + if (loadedConfig != null) + const Text('载入的完整 TOML 会原样保留;修改表单后,连接和保存将使用表单生成的配置。'), + ]); + + Widget settings() => Column( + children: [ + if (profileSupported) profilePanel(), + panel('网络配置', [ + if (running) + const Padding( + padding: EdgeInsets.only(bottom: 12), + child: Text('编辑配置前请先断开连接。'), + ), + SegmentedButton( + segments: const [ + ButtonSegment(value: 0, label: Text('基础')), + ButtonSegment(value: 1, label: Text('连接')), + ButtonSegment(value: 2, label: Text('导入')), + ], + selected: {configTab}, + onSelectionChanged: (s) => setState(() => configTab = s.first), + ), + const SizedBox(height: 16), + if (configTab == 0) ...[ + DropdownButtonFormField( + key: ValueKey(runtimeMode), + initialValue: runtimeMode, + decoration: const InputDecoration(labelText: '运行模式'), + items: [ + const DropdownMenuItem( + value: 'application', + child: Text('应用内 · 仅 SDK 通信'), + ), + DropdownMenuItem( + value: 'system_vpn', + enabled: Platform.isMacOS || Platform.isAndroid, + child: Text( + '系统 VPN · 供其他应用使用(${Platform.isAndroid ? 'Android' : 'macOS'})', + ), + ), + ], + onChanged: busy || running + ? null + : (v) => setState(() { + runtimeMode = v!; + if (v == 'system_vpn') autoIp = false; + }), + ), + if (runtimeMode == 'system_vpn') + Text( + '${Platform.isAndroid ? '连接时需要 Android VPN 授权。' : '连接时需要管理员授权。'}使用静态私有 IPv4,仅路由虚拟网段和允许接入的私有子网,不修改默认网关或 DNS。', + ), + ...[ + const Text('自动模式过滤默认路由、公网网段、过宽网段及与本机接口重叠的子网。最多接入 32 个 /16~/32 子网。'), + ], + field('网络名称', name), + field('网络密钥', secret, obscure: true), + field('节点名称', hostname), + SwitchListTile( + contentPadding: EdgeInsets.zero, + title: const Text('自动分配虚拟 IP'), + value: autoIp, + onChanged: busy || running || runtimeMode == 'system_vpn' + ? null + : (v) => setState(() => autoIp = v), + ), + if (!autoIp) field('虚拟 IPv4', ip), + field('初始节点(每行一个 tcp:// 或 udp:// 地址)', peers, lines: 3), + ], + if (configTab == 1) ...[ + DropdownButtonFormField( + key: ValueKey(routeMode), + initialValue: routeMode, + decoration: const InputDecoration(labelText: '线路策略'), + items: const [ + DropdownMenuItem( + value: 'adaptive', + child: Text('自适应 · 质量接近优先直连'), + ), + DropdownMenuItem(value: 'direct', child: Text('优先直连')), + DropdownMenuItem(value: 'latency', child: Text('延迟估算优先')), + DropdownMenuItem(value: 'hop', child: Text('最少跳数')), + ], + onChanged: busy || running + ? null + : (v) => setState(() { + routeMode = v!; + latencyFirst = v == 'adaptive' || v == 'latency'; + }), + ), + const Text('自适应:估算改善至少 15 ms 且 15%,持续 10 秒;切换冷却 30 秒。'), + SwitchListTile( + title: const Text('优先使用已确认的 UDP 连接'), + value: preferUdp, + onChanged: busy || running + ? null + : (v) => setState(() => preferUdp = v), + ), + field('中继下一跳节点 ID(逗号分隔,留空不限制)', relayIds), + SwitchListTile( + title: const Text('底层 IPv6'), + value: ipv6, + onChanged: busy || running ? null : (v) => setState(() => ipv6 = v), + ), + const Text('当前支持 UDP/TCP 传输和 IPv4 数据面。高级配置可通过 TOML 导入;不支持的选项会明确拒绝。'), + ], + if (configTab == 2) ...[ + OutlinedButton( + onPressed: busy || running ? null : importConfig, + child: const Text('粘贴 TOML 并连接'), + ), + OutlinedButton( + onPressed: () async { + final text = buildFormConfig().replaceFirst( + RegExp(r'network_secret = .*'), + 'network_secret = ""', + ); + await Clipboard.setData(ClipboardData(text: text)); + log('已复制配置(不含密钥)'); + }, + child: const Text('复制配置(不含密钥)'), + ), + ], + const SizedBox(height: 12), + FilledButton( + onPressed: busy || running || client == null + ? null + : () => perform(connect), + child: const Text('校验并连接'), + ), + ]), + panel('日志', [ + Row( + children: [ + Expanded(child: Text('${logs.length} 条事件')), + TextButton( + onPressed: () async { + await Clipboard.setData(ClipboardData(text: logs.join('\n'))); + log('日志已复制'); + }, + child: const Text('复制日志'), + ), + ], + ), + ...logs + .take(30) + .map( + (v) => Padding( + padding: const EdgeInsets.only(bottom: 8), + child: Text( + v, + style: const TextStyle(fontFamily: 'monospace', fontSize: 12), + ), + ), + ), + ]), + panel('关于', [ + const Text( + 'MeshPort 0.1.0 · 预览版\n应用内模式:仅 SDK 连接进入虚拟网络。\n系统 VPN:创建虚拟网卡,自动接入虚拟网段与节点公告子网。\n不修改默认网关和系统 DNS。\nAndroid 已接入应用内与系统 VPN;iOS 尚待验证。', + ), + ]), + ], + ); + Future importConfig() async { + final text = await showDialog( + context: context, + builder: (_) => const ConfigImportDialog(), + ); + if (text != null && mounted) { + await perform((c) async { + await loadForm(text); + await startConfig(text); + log('导入配置并启动引擎'); + }); + } + } + + @override + Widget build(BuildContext context) { + final pages = [overview, nodes, tests, settings]; + const labels = ['概览', '节点', '测试', '设置']; + final wide = MediaQuery.sizeOf(context).width >= 850; + final body = Column( + children: [ + if (error.isNotEmpty) + MaterialBanner( + content: Text(error), + actions: [ + TextButton( + onPressed: () => setState(() => error = ''), + child: const Text('关闭'), + ), + ], + ), + Expanded( + child: SingleChildScrollView( + padding: const EdgeInsets.all(16), + child: Center( + child: ConstrainedBox( + constraints: const BoxConstraints(maxWidth: 1000), + child: pages[page](), + ), + ), + ), + ), + ], + ); + const destinations = [ + NavigationDestination(icon: Icon(Icons.dashboard_outlined), label: '概览'), + NavigationDestination(icon: Icon(Icons.hub_outlined), label: '节点'), + NavigationDestination(icon: Icon(Icons.science_outlined), label: '测试'), + NavigationDestination(icon: Icon(Icons.settings_outlined), label: '设置'), + ]; + return Scaffold( + appBar: AppBar( + title: Row( + children: [ + Image.asset( + 'assets/branding/meshport.png', + width: 32, + height: 32, + semanticLabel: 'MeshPort', + ), + const SizedBox(width: 10), + Text('MeshPort / ${labels[page]}'), + ], + ), + actions: [ + Padding( + padding: const EdgeInsets.only(right: 20), + child: Center(child: Text(name.text)), + ), + ], + ), + body: wide + ? Row( + children: [ + NavigationRail( + selectedIndex: page, + onDestinationSelected: (v) => setState(() => page = v), + labelType: NavigationRailLabelType.all, + destinations: destinations + .map( + (d) => NavigationRailDestination( + icon: d.icon, + label: Text(d.label), + ), + ) + .toList(), + ), + const VerticalDivider(width: 1), + Expanded(child: body), + ], + ) + : body, + bottomNavigationBar: wide + ? null + : NavigationBar( + selectedIndex: page, + onDestinationSelected: (v) => setState(() => page = v), + destinations: destinations, + ), + ); + } +} + +class _Trend extends CustomPainter { + final List samples; + _Trend(this.samples); + @override + void paint(Canvas canvas, Size size) { + final grid = Paint() + ..color = const Color(0xffe9e6e0) + ..strokeWidth = 1; + for (var i = 0; i < 5; i++) { + final y = size.height * i / 4; + canvas.drawLine(Offset(0, y), Offset(size.width, y), grid); + } + if (samples.length < 2) { + return; + } + final max = samples.reduce((a, b) => a > b ? a : b) * 1.2 + 1; + final path = Path(); + for (var i = 0; i < samples.length; i++) { + final p = Offset( + size.width * i / (samples.length - 1), + size.height * (1 - samples[i] / max), + ); + if (i == 0) { + path.moveTo(p.dx, p.dy); + } else { + path.lineTo(p.dx, p.dy); + } + } + canvas.drawPath( + path, + Paint() + ..color = const Color(0xff087d8e) + ..style = PaintingStyle.stroke + ..strokeWidth = 2, + ); + } + + @override + bool shouldRepaint(_Trend oldDelegate) => true; +} diff --git a/apps/meshport_lab/lib/features/network_telemetry.dart b/apps/meshport_lab/lib/features/network_telemetry.dart new file mode 100644 index 0000000..c296026 --- /dev/null +++ b/apps/meshport_lab/lib/features/network_telemetry.dart @@ -0,0 +1,150 @@ +import 'package:flutter/material.dart'; + +String formatBytes(num? value, {bool rate = false}) { + if (value == null) return '—'; + var amount = value.toDouble(); + const units = ['B', 'KB', 'MB', 'GB', 'TB']; + var unit = 0; + while (amount >= 1024 && unit < units.length - 1) { + amount /= 1024; + unit++; + } + return '${amount.toStringAsFixed(unit == 0 ? 0 : 1)} ${units[unit]}${rate ? '/s' : ''}'; +} + +class NodeTelemetry extends StatelessWidget { + const NodeTelemetry({super.key, required this.status}); + final Map status; + + @override + Widget build(BuildContext context) { + final peers = >{ + for (final peer in status['peers'] as List? ?? []) + peer['peer_id']: Map.from(peer), + }; + final nodes = >{ + for (final route in status['routes'] as List? ?? []) + route['peer_id']: Map.from(route), + }; + for (final id in peers.keys) { + nodes.putIfAbsent(id, () => {'peer_id': id}); + } + final local = status['local_peer'] as Map?; + if (local != null) nodes.remove(local['peer_id']); + if (nodes.isEmpty && local == null) { + return const Text('尚未发现节点,连接后显示链路延迟与流量。'); + } + return Column( + crossAxisAlignment: CrossAxisAlignment.stretch, + children: [ + if (local != null) + Padding( + padding: const EdgeInsets.symmetric(vertical: 10), + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Row( + children: [ + const Icon( + Icons.devices, + size: 20, + color: Color(0xff087d8e), + ), + const SizedBox(width: 10), + Expanded( + child: Text( + '${local['hostname'] ?? '本机'} · 当前设备', + style: const TextStyle(fontWeight: FontWeight.w600), + ), + ), + Text( + local['state'] == 'Running' + ? '运行中' + : '${local['state'] ?? '未知状态'}', + ), + ], + ), + const SizedBox(height: 6), + Text( + '${local['ipv4'] ?? '等待分配虚拟 IP'} · 节点 ID ${local['peer_id'] ?? '—'}', + ), + Text( + 'UDP NAT:${local['udp_nat_type'] ?? '未知'} · 核心 ${local['version'] ?? '未知'}', + ), + ], + ), + ), + if (local != null && nodes.isNotEmpty) const Divider(), + if (local != null && nodes.isEmpty) const Text('尚未发现其他节点。'), + ...nodes.values.map((node) { + final peer = peers[node['peer_id']]; + final directAvailable = peer?['direct'] == true; + final direct = + directAvailable && + (node['next_hop_peer_id'] == null || + node['next_hop_peer_id'] == node['peer_id']); + final measured = direct ? (peer?['latency_ms'] as num?) : null; + final estimated = node['estimated_latency_ms'] as num?; + final latency = measured ?? estimated; + final latencyLabel = measured != null ? '链路 RTT' : '路由估算'; + return Padding( + padding: const EdgeInsets.symmetric(vertical: 10), + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + Row( + children: [ + Icon( + direct ? Icons.link : Icons.alt_route, + size: 20, + color: const Color(0xff087d8e), + ), + const SizedBox(width: 10), + Expanded( + child: Text( + '${node['hostname'] ?? '节点 ${node['peer_id']}'}', + style: const TextStyle(fontWeight: FontWeight.w600), + ), + ), + Text( + latency == null + ? '等待测量' + : '${latency.toStringAsFixed(1)} ms', + style: const TextStyle( + color: Color(0xff8a611c), + fontWeight: FontWeight.w600, + ), + ), + ], + ), + const SizedBox(height: 6), + Text( + '${node['ipv4'] ?? '无虚拟地址'} · ${direct ? '直连' : '中继'}${direct && peer?['hole_punched'] == true ? ' · 打洞建立' : ''}${!direct && directAvailable ? ' · 有直连可用' : ''}${latency == null ? '' : ' · $latencyLabel'}', + ), + if (node['udp_nat_type'] != null) + Text( + 'UDP NAT:${node['udp_nat_type']} · 核心 ${node['version'] ?? '未知'}', + ), + if ((node['advertised_subnets'] as List? ?? []).isNotEmpty) + Text( + '发布子网:${(node['advertised_subnets'] as List).join(', ')}', + ), + const SizedBox(height: 6), + Text( + peer == null + ? '流量经下一跳 ${node['next_hop_peer_id'] ?? '—'},未单独计量' + : '↓ ${formatBytes(peer['rx_bytes_per_second'] as num?, rate: true)} ↑ ${formatBytes(peer['tx_bytes_per_second'] as num?, rate: true)}', + ), + if (peer != null) + Text( + '当前链路累计 ↓ ${formatBytes(peer['rx_bytes'] as num?)} ↑ ${formatBytes(peer['tx_bytes'] as num?)}', + style: Theme.of(context).textTheme.bodySmall, + ), + ], + ), + ); + }), + ], + ); + } +} diff --git a/apps/meshport_lab/lib/main.dart b/apps/meshport_lab/lib/main.dart new file mode 100644 index 0000000..e07e6bb --- /dev/null +++ b/apps/meshport_lab/lib/main.dart @@ -0,0 +1,4 @@ +import 'package:flutter/material.dart'; +import 'app.dart'; + +void main() => runApp(const MeshPortApp()); diff --git a/apps/meshport_lab/linux/.gitignore b/apps/meshport_lab/linux/.gitignore new file mode 100644 index 0000000..d3896c9 --- /dev/null +++ b/apps/meshport_lab/linux/.gitignore @@ -0,0 +1 @@ +flutter/ephemeral diff --git a/apps/meshport_lab/linux/CMakeLists.txt b/apps/meshport_lab/linux/CMakeLists.txt new file mode 100644 index 0000000..3312cab --- /dev/null +++ b/apps/meshport_lab/linux/CMakeLists.txt @@ -0,0 +1,128 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.13) +project(runner LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "meshport_lab") +# The unique GTK application identifier for this application. See: +# https://wiki.gnome.org/HowDoI/ChooseApplicationID +set(APPLICATION_ID "com.example.meshport_lab") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(SET CMP0063 NEW) + +# Load bundled libraries from the lib/ directory relative to the binary. +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Root filesystem for cross-building. +if(FLUTTER_TARGET_PLATFORM_SYSROOT) + set(CMAKE_SYSROOT ${FLUTTER_TARGET_PLATFORM_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH ${CMAKE_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) + set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) +endif() + +# Define build configuration options. +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") +endif() + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_14) + target_compile_options(${TARGET} PRIVATE -Wall -Werror) + target_compile_options(${TARGET} PRIVATE "$<$>:-O3>") + target_compile_definitions(${TARGET} PRIVATE "$<$>:NDEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) + +# Only the install-generated bundle's copy of the executable will launch +# correctly, since the resources must in the right relative locations. To avoid +# people trying to run the unbundled copy, put it in a subdirectory instead of +# the default top-level location. +set_target_properties(${BINARY_NAME} + PROPERTIES + RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run" +) + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# By default, "installing" just makes a relocatable bundle in the build +# directory. +set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle") +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +# Start with a clean build bundle directory every time. +install(CODE " + file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\") + " COMPONENT Runtime) + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +foreach(bundled_library ${PLUGIN_BUNDLED_LIBRARIES}) + install(FILES "${bundled_library}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endforeach(bundled_library) + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/linux/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +if(NOT CMAKE_BUILD_TYPE MATCHES "Debug") + install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() diff --git a/apps/meshport_lab/linux/flutter/CMakeLists.txt b/apps/meshport_lab/linux/flutter/CMakeLists.txt new file mode 100644 index 0000000..d5bd016 --- /dev/null +++ b/apps/meshport_lab/linux/flutter/CMakeLists.txt @@ -0,0 +1,88 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.10) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. + +# Serves the same purpose as list(TRANSFORM ... PREPEND ...), +# which isn't available in 3.10. +function(list_prepend LIST_NAME PREFIX) + set(NEW_LIST "") + foreach(element ${${LIST_NAME}}) + list(APPEND NEW_LIST "${PREFIX}${element}") + endforeach(element) + set(${LIST_NAME} "${NEW_LIST}" PARENT_SCOPE) +endfunction() + +# === Flutter Library === +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) +pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) +pkg_check_modules(GIO REQUIRED IMPORTED_TARGET gio-2.0) + +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/libflutter_linux_gtk.so") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/lib/libapp.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "fl_basic_message_channel.h" + "fl_binary_codec.h" + "fl_binary_messenger.h" + "fl_dart_project.h" + "fl_engine.h" + "fl_json_message_codec.h" + "fl_json_method_codec.h" + "fl_message_codec.h" + "fl_method_call.h" + "fl_method_channel.h" + "fl_method_codec.h" + "fl_method_response.h" + "fl_plugin_registrar.h" + "fl_plugin_registry.h" + "fl_standard_message_codec.h" + "fl_standard_method_codec.h" + "fl_string_codec.h" + "fl_value.h" + "fl_view.h" + "flutter_linux.h" +) +list_prepend(FLUTTER_LIBRARY_HEADERS "${EPHEMERAL_DIR}/flutter_linux/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}") +target_link_libraries(flutter INTERFACE + PkgConfig::GTK + PkgConfig::GLIB + PkgConfig::GIO +) +add_dependencies(flutter flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CMAKE_CURRENT_BINARY_DIR}/_phony_ + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.sh" + ${FLUTTER_TARGET_PLATFORM} ${CMAKE_BUILD_TYPE} + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} +) diff --git a/apps/meshport_lab/linux/flutter/generated_plugin_registrant.cc b/apps/meshport_lab/linux/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..e71a16d --- /dev/null +++ b/apps/meshport_lab/linux/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void fl_register_plugins(FlPluginRegistry* registry) { +} diff --git a/apps/meshport_lab/linux/flutter/generated_plugin_registrant.h b/apps/meshport_lab/linux/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..e0f0a47 --- /dev/null +++ b/apps/meshport_lab/linux/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void fl_register_plugins(FlPluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/apps/meshport_lab/linux/flutter/generated_plugins.cmake b/apps/meshport_lab/linux/flutter/generated_plugins.cmake new file mode 100644 index 0000000..2e1de87 --- /dev/null +++ b/apps/meshport_lab/linux/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/linux plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/linux plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/apps/meshport_lab/linux/runner/CMakeLists.txt b/apps/meshport_lab/linux/runner/CMakeLists.txt new file mode 100644 index 0000000..e97dabc --- /dev/null +++ b/apps/meshport_lab/linux/runner/CMakeLists.txt @@ -0,0 +1,26 @@ +cmake_minimum_required(VERSION 3.13) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} + "main.cc" + "my_application.cc" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the application ID. +add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") + +# Add dependency libraries. Add any application-specific dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter) +target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) + +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") diff --git a/apps/meshport_lab/linux/runner/main.cc b/apps/meshport_lab/linux/runner/main.cc new file mode 100644 index 0000000..e7c5c54 --- /dev/null +++ b/apps/meshport_lab/linux/runner/main.cc @@ -0,0 +1,6 @@ +#include "my_application.h" + +int main(int argc, char** argv) { + g_autoptr(MyApplication) app = my_application_new(); + return g_application_run(G_APPLICATION(app), argc, argv); +} diff --git a/apps/meshport_lab/linux/runner/my_application.cc b/apps/meshport_lab/linux/runner/my_application.cc new file mode 100644 index 0000000..b875e69 --- /dev/null +++ b/apps/meshport_lab/linux/runner/my_application.cc @@ -0,0 +1,148 @@ +#include "my_application.h" + +#include +#ifdef GDK_WINDOWING_X11 +#include +#endif + +#include "flutter/generated_plugin_registrant.h" + +struct _MyApplication { + GtkApplication parent_instance; + char** dart_entrypoint_arguments; +}; + +G_DEFINE_TYPE(MyApplication, my_application, GTK_TYPE_APPLICATION) + +// Called when first Flutter frame received. +static void first_frame_cb(MyApplication* self, FlView* view) { + gtk_widget_show(gtk_widget_get_toplevel(GTK_WIDGET(view))); +} + +// Implements GApplication::activate. +static void my_application_activate(GApplication* application) { + MyApplication* self = MY_APPLICATION(application); + GtkWindow* window = + GTK_WINDOW(gtk_application_window_new(GTK_APPLICATION(application))); + + // Use a header bar when running in GNOME as this is the common style used + // by applications and is the setup most users will be using (e.g. Ubuntu + // desktop). + // If running on X and not using GNOME then just use a traditional title bar + // in case the window manager does more exotic layout, e.g. tiling. + // If running on Wayland assume the header bar will work (may need changing + // if future cases occur). + gboolean use_header_bar = TRUE; +#ifdef GDK_WINDOWING_X11 + GdkScreen* screen = gtk_window_get_screen(window); + if (GDK_IS_X11_SCREEN(screen)) { + const gchar* wm_name = gdk_x11_screen_get_window_manager_name(screen); + if (g_strcmp0(wm_name, "GNOME Shell") != 0) { + use_header_bar = FALSE; + } + } +#endif + if (use_header_bar) { + GtkHeaderBar* header_bar = GTK_HEADER_BAR(gtk_header_bar_new()); + gtk_widget_show(GTK_WIDGET(header_bar)); + gtk_header_bar_set_title(header_bar, "meshport_lab"); + gtk_header_bar_set_show_close_button(header_bar, TRUE); + gtk_window_set_titlebar(window, GTK_WIDGET(header_bar)); + } else { + gtk_window_set_title(window, "meshport_lab"); + } + + gtk_window_set_default_size(window, 1280, 720); + + g_autoptr(FlDartProject) project = fl_dart_project_new(); + fl_dart_project_set_dart_entrypoint_arguments( + project, self->dart_entrypoint_arguments); + + FlView* view = fl_view_new(project); + GdkRGBA background_color; + // Background defaults to black, override it here if necessary, e.g. #00000000 + // for transparent. + gdk_rgba_parse(&background_color, "#000000"); + fl_view_set_background_color(view, &background_color); + gtk_widget_show(GTK_WIDGET(view)); + gtk_container_add(GTK_CONTAINER(window), GTK_WIDGET(view)); + + // Show the window when Flutter renders. + // Requires the view to be realized so we can start rendering. + g_signal_connect_swapped(view, "first-frame", G_CALLBACK(first_frame_cb), + self); + gtk_widget_realize(GTK_WIDGET(view)); + + fl_register_plugins(FL_PLUGIN_REGISTRY(view)); + + gtk_widget_grab_focus(GTK_WIDGET(view)); +} + +// Implements GApplication::local_command_line. +static gboolean my_application_local_command_line(GApplication* application, + gchar*** arguments, + int* exit_status) { + MyApplication* self = MY_APPLICATION(application); + // Strip out the first argument as it is the binary name. + self->dart_entrypoint_arguments = g_strdupv(*arguments + 1); + + g_autoptr(GError) error = nullptr; + if (!g_application_register(application, nullptr, &error)) { + g_warning("Failed to register: %s", error->message); + *exit_status = 1; + return TRUE; + } + + g_application_activate(application); + *exit_status = 0; + + return TRUE; +} + +// Implements GApplication::startup. +static void my_application_startup(GApplication* application) { + // MyApplication* self = MY_APPLICATION(object); + + // Perform any actions required at application startup. + + G_APPLICATION_CLASS(my_application_parent_class)->startup(application); +} + +// Implements GApplication::shutdown. +static void my_application_shutdown(GApplication* application) { + // MyApplication* self = MY_APPLICATION(object); + + // Perform any actions required at application shutdown. + + G_APPLICATION_CLASS(my_application_parent_class)->shutdown(application); +} + +// Implements GObject::dispose. +static void my_application_dispose(GObject* object) { + MyApplication* self = MY_APPLICATION(object); + g_clear_pointer(&self->dart_entrypoint_arguments, g_strfreev); + G_OBJECT_CLASS(my_application_parent_class)->dispose(object); +} + +static void my_application_class_init(MyApplicationClass* klass) { + G_APPLICATION_CLASS(klass)->activate = my_application_activate; + G_APPLICATION_CLASS(klass)->local_command_line = + my_application_local_command_line; + G_APPLICATION_CLASS(klass)->startup = my_application_startup; + G_APPLICATION_CLASS(klass)->shutdown = my_application_shutdown; + G_OBJECT_CLASS(klass)->dispose = my_application_dispose; +} + +static void my_application_init(MyApplication* self) {} + +MyApplication* my_application_new() { + // Set the program name to the application ID, which helps various systems + // like GTK and desktop environments map this running application to its + // corresponding .desktop file. This ensures better integration by allowing + // the application to be recognized beyond its binary name. + g_set_prgname(APPLICATION_ID); + + return MY_APPLICATION(g_object_new(my_application_get_type(), + "application-id", APPLICATION_ID, "flags", + G_APPLICATION_NON_UNIQUE, nullptr)); +} diff --git a/apps/meshport_lab/linux/runner/my_application.h b/apps/meshport_lab/linux/runner/my_application.h new file mode 100644 index 0000000..db16367 --- /dev/null +++ b/apps/meshport_lab/linux/runner/my_application.h @@ -0,0 +1,21 @@ +#ifndef FLUTTER_MY_APPLICATION_H_ +#define FLUTTER_MY_APPLICATION_H_ + +#include + +G_DECLARE_FINAL_TYPE(MyApplication, + my_application, + MY, + APPLICATION, + GtkApplication) + +/** + * my_application_new: + * + * Creates a new Flutter-based application. + * + * Returns: a new #MyApplication. + */ +MyApplication* my_application_new(); + +#endif // FLUTTER_MY_APPLICATION_H_ diff --git a/apps/meshport_lab/macos/.gitignore b/apps/meshport_lab/macos/.gitignore new file mode 100644 index 0000000..746adbb --- /dev/null +++ b/apps/meshport_lab/macos/.gitignore @@ -0,0 +1,7 @@ +# Flutter-related +**/Flutter/ephemeral/ +**/Pods/ + +# Xcode-related +**/dgph +**/xcuserdata/ diff --git a/apps/meshport_lab/macos/Flutter/Flutter-Debug.xcconfig b/apps/meshport_lab/macos/Flutter/Flutter-Debug.xcconfig new file mode 100644 index 0000000..4b81f9b --- /dev/null +++ b/apps/meshport_lab/macos/Flutter/Flutter-Debug.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig" +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/apps/meshport_lab/macos/Flutter/Flutter-Release.xcconfig b/apps/meshport_lab/macos/Flutter/Flutter-Release.xcconfig new file mode 100644 index 0000000..5caa9d1 --- /dev/null +++ b/apps/meshport_lab/macos/Flutter/Flutter-Release.xcconfig @@ -0,0 +1,2 @@ +#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig" +#include "ephemeral/Flutter-Generated.xcconfig" diff --git a/apps/meshport_lab/macos/Flutter/GeneratedPluginRegistrant.swift b/apps/meshport_lab/macos/Flutter/GeneratedPluginRegistrant.swift new file mode 100644 index 0000000..cccf817 --- /dev/null +++ b/apps/meshport_lab/macos/Flutter/GeneratedPluginRegistrant.swift @@ -0,0 +1,10 @@ +// +// Generated file. Do not edit. +// + +import FlutterMacOS +import Foundation + + +func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) { +} diff --git a/apps/meshport_lab/macos/Podfile b/apps/meshport_lab/macos/Podfile new file mode 100644 index 0000000..ff5ddb3 --- /dev/null +++ b/apps/meshport_lab/macos/Podfile @@ -0,0 +1,42 @@ +platform :osx, '10.15' + +# CocoaPods analytics sends network stats synchronously affecting flutter build latency. +ENV['COCOAPODS_DISABLE_STATS'] = 'true' + +project 'Runner', { + 'Debug' => :debug, + 'Profile' => :release, + 'Release' => :release, +} + +def flutter_root + generated_xcode_build_settings_path = File.expand_path(File.join('..', 'Flutter', 'ephemeral', 'Flutter-Generated.xcconfig'), __FILE__) + unless File.exist?(generated_xcode_build_settings_path) + raise "#{generated_xcode_build_settings_path} must exist. If you're running pod install manually, make sure \"flutter pub get\" is executed first" + end + + File.foreach(generated_xcode_build_settings_path) do |line| + matches = line.match(/FLUTTER_ROOT\=(.*)/) + return matches[1].strip if matches + end + raise "FLUTTER_ROOT not found in #{generated_xcode_build_settings_path}. Try deleting Flutter-Generated.xcconfig, then run \"flutter pub get\"" +end + +require File.expand_path(File.join('packages', 'flutter_tools', 'bin', 'podhelper'), flutter_root) + +flutter_macos_podfile_setup + +target 'Runner' do + use_frameworks! + + flutter_install_all_macos_pods File.dirname(File.realpath(__FILE__)) + target 'RunnerTests' do + inherit! :search_paths + end +end + +post_install do |installer| + installer.pods_project.targets.each do |target| + flutter_additional_macos_build_settings(target) + end +end diff --git a/apps/meshport_lab/macos/Runner.xcodeproj/project.pbxproj b/apps/meshport_lab/macos/Runner.xcodeproj/project.pbxproj new file mode 100644 index 0000000..a6e4ab6 --- /dev/null +++ b/apps/meshport_lab/macos/Runner.xcodeproj/project.pbxproj @@ -0,0 +1,705 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 54; + objects = { + +/* Begin PBXAggregateTarget section */ + 33CC111A2044C6BA0003C045 /* Flutter Assemble */ = { + isa = PBXAggregateTarget; + buildConfigurationList = 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */; + buildPhases = ( + 33CC111E2044C6BF0003C045 /* ShellScript */, + ); + dependencies = ( + ); + name = "Flutter Assemble"; + productName = FLX; + }; +/* End PBXAggregateTarget section */ + +/* Begin PBXBuildFile section */ + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 331C80D7294CF71000263BE5 /* RunnerTests.swift */; }; + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */ = {isa = PBXBuildFile; fileRef = 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */; }; + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC10F02044A3C60003C045 /* AppDelegate.swift */; }; + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F22044A3C60003C045 /* Assets.xcassets */; }; + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F42044A3C60003C045 /* MainMenu.xib */; }; + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC10EC2044A3C60003C045; + remoteInfo = Runner; + }; + 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 33CC10E52044A3C60003C045 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 33CC111A2044C6BA0003C045; + remoteInfo = FLX; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXCopyFilesBuildPhase section */ + 33CC110E2044A8840003C045 /* Bundle Framework */ = { + isa = PBXCopyFilesBuildPhase; + buildActionMask = 2147483647; + dstPath = ""; + dstSubfolderSpec = 10; + files = ( + ); + name = "Bundle Framework"; + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXCopyFilesBuildPhase section */ + +/* Begin PBXFileReference section */ + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = RunnerTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 331C80D7294CF71000263BE5 /* RunnerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RunnerTests.swift; sourceTree = ""; }; + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Warnings.xcconfig; sourceTree = ""; }; + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GeneratedPluginRegistrant.swift; sourceTree = ""; }; + 33CC10ED2044A3C60003C045 /* meshport_lab.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "meshport_lab.app"; sourceTree = BUILT_PRODUCTS_DIR; }; + 33CC10F02044A3C60003C045 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; + 33CC10F22044A3C60003C045 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Assets.xcassets; path = Runner/Assets.xcassets; sourceTree = ""; }; + 33CC10F52044A3C60003C045 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = Base.lproj/MainMenu.xib; sourceTree = ""; }; + 33CC10F72044A3C60003C045 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; name = Info.plist; path = Runner/Info.plist; sourceTree = ""; }; + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MainFlutterWindow.swift; sourceTree = ""; }; + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Debug.xcconfig"; sourceTree = ""; }; + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = "Flutter-Release.xcconfig"; sourceTree = ""; }; + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = "Flutter-Generated.xcconfig"; path = "ephemeral/Flutter-Generated.xcconfig"; sourceTree = ""; }; + 33E51913231747F40026EE4D /* DebugProfile.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = DebugProfile.entitlements; sourceTree = ""; }; + 33E51914231749380026EE4D /* Release.entitlements */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.entitlements; path = Release.entitlements; sourceTree = ""; }; + 33E5194F232828860026EE4D /* AppInfo.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = AppInfo.xcconfig; sourceTree = ""; }; + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Release.xcconfig; sourceTree = ""; }; + 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; path = Debug.xcconfig; sourceTree = ""; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 331C80D2294CF70F00263BE5 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EA2044A3C60003C045 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 331C80D6294CF71000263BE5 /* RunnerTests */ = { + isa = PBXGroup; + children = ( + 331C80D7294CF71000263BE5 /* RunnerTests.swift */, + ); + path = RunnerTests; + sourceTree = ""; + }; + 33BA886A226E78AF003329D5 /* Configs */ = { + isa = PBXGroup; + children = ( + 33E5194F232828860026EE4D /* AppInfo.xcconfig */, + 9740EEB21CF90195004384FC /* Debug.xcconfig */, + 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, + 333000ED22D3DE5D00554162 /* Warnings.xcconfig */, + ); + path = Configs; + sourceTree = ""; + }; + 33CC10E42044A3C60003C045 = { + isa = PBXGroup; + children = ( + 33FAB671232836740065AC1E /* Runner */, + 33CEB47122A05771004F2AC0 /* Flutter */, + 331C80D6294CF71000263BE5 /* RunnerTests */, + 33CC10EE2044A3C60003C045 /* Products */, + D73912EC22F37F3D000D13A0 /* Frameworks */, + ); + sourceTree = ""; + }; + 33CC10EE2044A3C60003C045 /* Products */ = { + isa = PBXGroup; + children = ( + 33CC10ED2044A3C60003C045 /* meshport_lab.app */, + 331C80D5294CF71000263BE5 /* RunnerTests.xctest */, + ); + name = Products; + sourceTree = ""; + }; + 33CC11242044D66E0003C045 /* Resources */ = { + isa = PBXGroup; + children = ( + 33CC10F22044A3C60003C045 /* Assets.xcassets */, + 33CC10F42044A3C60003C045 /* MainMenu.xib */, + 33CC10F72044A3C60003C045 /* Info.plist */, + ); + name = Resources; + path = ..; + sourceTree = ""; + }; + 33CEB47122A05771004F2AC0 /* Flutter */ = { + isa = PBXGroup; + children = ( + 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */, + 33CEB47222A05771004F2AC0 /* Flutter-Debug.xcconfig */, + 33CEB47422A05771004F2AC0 /* Flutter-Release.xcconfig */, + 33CEB47722A0578A004F2AC0 /* Flutter-Generated.xcconfig */, + ); + path = Flutter; + sourceTree = ""; + }; + 33FAB671232836740065AC1E /* Runner */ = { + isa = PBXGroup; + children = ( + 33CC10F02044A3C60003C045 /* AppDelegate.swift */, + 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */, + 33E51913231747F40026EE4D /* DebugProfile.entitlements */, + 33E51914231749380026EE4D /* Release.entitlements */, + 33CC11242044D66E0003C045 /* Resources */, + 33BA886A226E78AF003329D5 /* Configs */, + ); + path = Runner; + sourceTree = ""; + }; + D73912EC22F37F3D000D13A0 /* Frameworks */ = { + isa = PBXGroup; + children = ( + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 331C80D4294CF70F00263BE5 /* RunnerTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */; + buildPhases = ( + 331C80D1294CF70F00263BE5 /* Sources */, + 331C80D2294CF70F00263BE5 /* Frameworks */, + 331C80D3294CF70F00263BE5 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 331C80DA294CF71000263BE5 /* PBXTargetDependency */, + ); + name = RunnerTests; + productName = RunnerTests; + productReference = 331C80D5294CF71000263BE5 /* RunnerTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; + 33CC10EC2044A3C60003C045 /* Runner */ = { + isa = PBXNativeTarget; + buildConfigurationList = 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */; + buildPhases = ( + 33CC10E92044A3C60003C045 /* Sources */, + 33CC10EA2044A3C60003C045 /* Frameworks */, + 33CC10EB2044A3C60003C045 /* Resources */, + 33CC110E2044A8840003C045 /* Bundle Framework */, + 3399D490228B24CF009A79C7 /* ShellScript */, + ); + buildRules = ( + ); + dependencies = ( + 33CC11202044C79F0003C045 /* PBXTargetDependency */, + ); + name = Runner; + productName = Runner; + productReference = 33CC10ED2044A3C60003C045 /* meshport_lab.app */; + productType = "com.apple.product-type.application"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 33CC10E52044A3C60003C045 /* Project object */ = { + isa = PBXProject; + attributes = { + BuildIndependentTargetsInParallel = YES; + LastSwiftUpdateCheck = 0920; + LastUpgradeCheck = 1510; + ORGANIZATIONNAME = ""; + TargetAttributes = { + 331C80D4294CF70F00263BE5 = { + CreatedOnToolsVersion = 14.0; + TestTargetID = 33CC10EC2044A3C60003C045; + }; + 33CC10EC2044A3C60003C045 = { + CreatedOnToolsVersion = 9.2; + LastSwiftMigration = 1100; + ProvisioningStyle = Automatic; + SystemCapabilities = { + com.apple.Sandbox = { + enabled = 1; + }; + }; + }; + 33CC111A2044C6BA0003C045 = { + CreatedOnToolsVersion = 9.2; + ProvisioningStyle = Manual; + }; + }; + }; + buildConfigurationList = 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */; + compatibilityVersion = "Xcode 9.3"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 33CC10E42044A3C60003C045; + productRefGroup = 33CC10EE2044A3C60003C045 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 33CC10EC2044A3C60003C045 /* Runner */, + 331C80D4294CF70F00263BE5 /* RunnerTests */, + 33CC111A2044C6BA0003C045 /* Flutter Assemble */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 331C80D3294CF70F00263BE5 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10EB2044A3C60003C045 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */, + 33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + 3399D490228B24CF009A79C7 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + ); + inputPaths = ( + ); + outputFileListPaths = ( + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "echo \"$PRODUCT_NAME.app\" > \"$PROJECT_DIR\"/Flutter/ephemeral/.app_filename && \"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh embed\n"; + }; + 33CC111E2044C6BF0003C045 /* ShellScript */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + Flutter/ephemeral/FlutterInputs.xcfilelist, + ); + inputPaths = ( + Flutter/ephemeral/tripwire, + ); + outputFileListPaths = ( + Flutter/ephemeral/FlutterOutputs.xcfilelist, + ); + outputPaths = ( + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "\"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh && touch Flutter/ephemeral/tripwire"; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 331C80D1294CF70F00263BE5 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 331C80D8294CF71000263BE5 /* RunnerTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 33CC10E92044A3C60003C045 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */, + 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */, + 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 331C80DA294CF71000263BE5 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC10EC2044A3C60003C045 /* Runner */; + targetProxy = 331C80D9294CF71000263BE5 /* PBXContainerItemProxy */; + }; + 33CC11202044C79F0003C045 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 33CC111A2044C6BA0003C045 /* Flutter Assemble */; + targetProxy = 33CC111F2044C79F0003C045 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin PBXVariantGroup section */ + 33CC10F42044A3C60003C045 /* MainMenu.xib */ = { + isa = PBXVariantGroup; + children = ( + 33CC10F52044A3C60003C045 /* Base */, + ); + name = MainMenu.xib; + path = Runner; + sourceTree = ""; + }; +/* End PBXVariantGroup section */ + +/* Begin XCBuildConfiguration section */ + 331C80DB294CF71000263BE5 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/meshport_lab.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/meshport_lab"; + }; + name = Debug; + }; + 331C80DC294CF71000263BE5 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/meshport_lab.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/meshport_lab"; + }; + name = Release; + }; + 331C80DD294CF71000263BE5 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + BUNDLE_LOADER = "$(TEST_HOST)"; + CURRENT_PROJECT_VERSION = 1; + GENERATE_INFOPLIST_FILE = YES; + MARKETING_VERSION = 1.0; + PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab.RunnerTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TEST_HOST = "$(BUILT_PRODUCTS_DIR)/meshport_lab.app/$(BUNDLE_EXECUTABLE_FOLDER_PATH)/meshport_lab"; + }; + name = Profile; + }; + 338D0CE9231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.15; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Profile; + }; + 338D0CEA231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Profile; + }; + 338D0CEB231458BD00FA5F75 /* Profile */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Profile; + }; + 33CC10F92044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.15; + MTL_ENABLE_DEBUG_INFO = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = macosx; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + }; + name = Debug; + }; + 33CC10FA2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + ASSETCATALOG_COMPILER_GENERATE_SWIFT_ASSET_SYMBOL_EXTENSIONS = YES; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CODE_SIGN_IDENTITY = "-"; + COPY_PHASE_STRIP = NO; + DEAD_CODE_STRIPPING = YES; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_USER_SCRIPT_SANDBOXING = NO; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + MACOSX_DEPLOYMENT_TARGET = 10.15; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = macosx; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + }; + name = Release; + }; + 33CC10FC2044A3C60003C045 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/DebugProfile.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + }; + name = Debug; + }; + 33CC10FD2044A3C60003C045 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 33E5194F232828860026EE4D /* AppInfo.xcconfig */; + buildSettings = { + ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_ENTITLEMENTS = Runner/Release.entitlements; + CODE_SIGN_STYLE = Automatic; + COMBINE_HIDPI_IMAGES = YES; + INFOPLIST_FILE = Runner/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/../Frameworks", + ); + PROVISIONING_PROFILE_SPECIFIER = ""; + SWIFT_VERSION = 5.0; + }; + name = Release; + }; + 33CC111C2044C6BA0003C045 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Manual; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Debug; + }; + 33CC111D2044C6BA0003C045 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + PRODUCT_NAME = "$(TARGET_NAME)"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 331C80DE294CF71000263BE5 /* Build configuration list for PBXNativeTarget "RunnerTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 331C80DB294CF71000263BE5 /* Debug */, + 331C80DC294CF71000263BE5 /* Release */, + 331C80DD294CF71000263BE5 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10E82044A3C60003C045 /* Build configuration list for PBXProject "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10F92044A3C60003C045 /* Debug */, + 33CC10FA2044A3C60003C045 /* Release */, + 338D0CE9231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC10FC2044A3C60003C045 /* Debug */, + 33CC10FD2044A3C60003C045 /* Release */, + 338D0CEA231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 33CC111B2044C6BA0003C045 /* Build configuration list for PBXAggregateTarget "Flutter Assemble" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 33CC111C2044C6BA0003C045 /* Debug */, + 33CC111D2044C6BA0003C045 /* Release */, + 338D0CEB231458BD00FA5F75 /* Profile */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 33CC10E52044A3C60003C045 /* Project object */; +} diff --git a/apps/meshport_lab/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/apps/meshport_lab/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/apps/meshport_lab/macos/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/apps/meshport_lab/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/apps/meshport_lab/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme new file mode 100644 index 0000000..88e0329 --- /dev/null +++ b/apps/meshport_lab/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apps/meshport_lab/macos/Runner.xcworkspace/contents.xcworkspacedata b/apps/meshport_lab/macos/Runner.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..1d526a1 --- /dev/null +++ b/apps/meshport_lab/macos/Runner.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/apps/meshport_lab/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/apps/meshport_lab/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/apps/meshport_lab/macos/Runner.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/apps/meshport_lab/macos/Runner/AppDelegate.swift b/apps/meshport_lab/macos/Runner/AppDelegate.swift new file mode 100644 index 0000000..b3c1761 --- /dev/null +++ b/apps/meshport_lab/macos/Runner/AppDelegate.swift @@ -0,0 +1,13 @@ +import Cocoa +import FlutterMacOS + +@main +class AppDelegate: FlutterAppDelegate { + override func applicationShouldTerminateAfterLastWindowClosed(_ sender: NSApplication) -> Bool { + return true + } + + override func applicationSupportsSecureRestorableState(_ app: NSApplication) -> Bool { + return true + } +} diff --git a/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json new file mode 100644 index 0000000..a2ec33f --- /dev/null +++ b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/Contents.json @@ -0,0 +1,68 @@ +{ + "images" : [ + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_16.png", + "scale" : "1x" + }, + { + "size" : "16x16", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "2x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_32.png", + "scale" : "1x" + }, + { + "size" : "32x32", + "idiom" : "mac", + "filename" : "app_icon_64.png", + "scale" : "2x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_128.png", + "scale" : "1x" + }, + { + "size" : "128x128", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "2x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_256.png", + "scale" : "1x" + }, + { + "size" : "256x256", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "2x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_512.png", + "scale" : "1x" + }, + { + "size" : "512x512", + "idiom" : "mac", + "filename" : "app_icon_1024.png", + "scale" : "2x" + } + ], + "info" : { + "version" : 1, + "author" : "xcode" + } +} diff --git a/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png new file mode 100644 index 0000000..c4f9806 Binary files /dev/null and b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_1024.png differ diff --git a/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png new file mode 100644 index 0000000..890957f Binary files /dev/null and b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_128.png differ diff --git a/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png new file mode 100644 index 0000000..18d7e64 Binary files /dev/null and b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_16.png differ diff --git a/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png new file mode 100644 index 0000000..5b333d9 Binary files /dev/null and b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_256.png differ diff --git a/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png new file mode 100644 index 0000000..083196c Binary files /dev/null and b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_32.png differ diff --git a/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png new file mode 100644 index 0000000..f62ce91 Binary files /dev/null and b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_512.png differ diff --git a/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png new file mode 100644 index 0000000..44c2a54 Binary files /dev/null and b/apps/meshport_lab/macos/Runner/Assets.xcassets/AppIcon.appiconset/app_icon_64.png differ diff --git a/apps/meshport_lab/macos/Runner/Base.lproj/MainMenu.xib b/apps/meshport_lab/macos/Runner/Base.lproj/MainMenu.xib new file mode 100644 index 0000000..80e867a --- /dev/null +++ b/apps/meshport_lab/macos/Runner/Base.lproj/MainMenu.xib @@ -0,0 +1,343 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/apps/meshport_lab/macos/Runner/Configs/AppInfo.xcconfig b/apps/meshport_lab/macos/Runner/Configs/AppInfo.xcconfig new file mode 100644 index 0000000..f5314fb --- /dev/null +++ b/apps/meshport_lab/macos/Runner/Configs/AppInfo.xcconfig @@ -0,0 +1,14 @@ +// Application-level settings for the Runner target. +// +// This may be replaced with something auto-generated from metadata (e.g., pubspec.yaml) in the +// future. If not, the values below would default to using the project name when this becomes a +// 'flutter create' template. + +// The application's name. By default this is also the title of the Flutter window. +PRODUCT_NAME = MeshPort + +// The application's bundle identifier +PRODUCT_BUNDLE_IDENTIFIER = com.example.meshportLab + +// The copyright displayed in application information +PRODUCT_COPYRIGHT = Copyright © 2026 com.example. All rights reserved. diff --git a/apps/meshport_lab/macos/Runner/Configs/Debug.xcconfig b/apps/meshport_lab/macos/Runner/Configs/Debug.xcconfig new file mode 100644 index 0000000..36b0fd9 --- /dev/null +++ b/apps/meshport_lab/macos/Runner/Configs/Debug.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Debug.xcconfig" +#include "Warnings.xcconfig" diff --git a/apps/meshport_lab/macos/Runner/Configs/Release.xcconfig b/apps/meshport_lab/macos/Runner/Configs/Release.xcconfig new file mode 100644 index 0000000..dff4f49 --- /dev/null +++ b/apps/meshport_lab/macos/Runner/Configs/Release.xcconfig @@ -0,0 +1,2 @@ +#include "../../Flutter/Flutter-Release.xcconfig" +#include "Warnings.xcconfig" diff --git a/apps/meshport_lab/macos/Runner/Configs/Warnings.xcconfig b/apps/meshport_lab/macos/Runner/Configs/Warnings.xcconfig new file mode 100644 index 0000000..42bcbf4 --- /dev/null +++ b/apps/meshport_lab/macos/Runner/Configs/Warnings.xcconfig @@ -0,0 +1,13 @@ +WARNING_CFLAGS = -Wall -Wconditional-uninitialized -Wnullable-to-nonnull-conversion -Wmissing-method-return-type -Woverlength-strings +GCC_WARN_UNDECLARED_SELECTOR = YES +CLANG_UNDEFINED_BEHAVIOR_SANITIZER_NULLABILITY = YES +CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE +CLANG_WARN__DUPLICATE_METHOD_MATCH = YES +CLANG_WARN_PRAGMA_PACK = YES +CLANG_WARN_STRICT_PROTOTYPES = YES +CLANG_WARN_COMMA = YES +GCC_WARN_STRICT_SELECTOR_MATCH = YES +CLANG_WARN_OBJC_REPEATED_USE_OF_WEAK = YES +CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES +GCC_WARN_SHADOW = YES +CLANG_WARN_UNREACHABLE_CODE = YES diff --git a/apps/meshport_lab/macos/Runner/DebugProfile.entitlements b/apps/meshport_lab/macos/Runner/DebugProfile.entitlements new file mode 100644 index 0000000..78c36cf --- /dev/null +++ b/apps/meshport_lab/macos/Runner/DebugProfile.entitlements @@ -0,0 +1,14 @@ + + + + + com.apple.security.app-sandbox + + com.apple.security.cs.allow-jit + + com.apple.security.network.server + + com.apple.security.network.client + + + diff --git a/apps/meshport_lab/macos/Runner/Info.plist b/apps/meshport_lab/macos/Runner/Info.plist new file mode 100644 index 0000000..4789daa --- /dev/null +++ b/apps/meshport_lab/macos/Runner/Info.plist @@ -0,0 +1,32 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIconFile + + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + $(PRODUCT_NAME) + CFBundlePackageType + APPL + CFBundleShortVersionString + $(FLUTTER_BUILD_NAME) + CFBundleVersion + $(FLUTTER_BUILD_NUMBER) + LSMinimumSystemVersion + $(MACOSX_DEPLOYMENT_TARGET) + NSHumanReadableCopyright + $(PRODUCT_COPYRIGHT) + NSMainNibFile + MainMenu + NSPrincipalClass + NSApplication + + diff --git a/apps/meshport_lab/macos/Runner/MainFlutterWindow.swift b/apps/meshport_lab/macos/Runner/MainFlutterWindow.swift new file mode 100644 index 0000000..e95d8a5 --- /dev/null +++ b/apps/meshport_lab/macos/Runner/MainFlutterWindow.swift @@ -0,0 +1,80 @@ +import Cocoa +import Security +import FlutterMacOS + +class MainFlutterWindow: NSWindow { + private var vpnChannel: FlutterMethodChannel? + + override func awakeFromNib() { + let flutterViewController = FlutterViewController() + let windowFrame = self.frame + self.contentViewController = flutterViewController + self.setFrame(windowFrame, display: true) + RegisterGeneratedPlugins(registry: flutterViewController) + + vpnChannel = FlutterMethodChannel(name: "meshport/system_vpn", binaryMessenger: flutterViewController.engine.binaryMessenger) + vpnChannel?.setMethodCallHandler { call, result in + let profileQuery: [String: Any] = [ + kSecClass as String: kSecClassGenericPassword, + kSecAttrService as String: "MeshPort.Lab.NetworkProfile", + kSecAttrAccount as String: "last-network" + ] + if call.method == "save_profile", let config = call.arguments as? String, + config.utf8.count <= 65536, let data = config.data(using: .utf8) { + let attributes = [kSecValueData as String: data] + var status = SecItemUpdate(profileQuery as CFDictionary, attributes as CFDictionary) + if status == errSecItemNotFound { + var item = profileQuery + item[kSecValueData as String] = data + status = SecItemAdd(item as CFDictionary, nil) + } + if status == errSecSuccess { result(nil) } + else { result(FlutterError(code: "KEYCHAIN_SAVE", message: "Could not save network profile to Keychain", details: status)) } + return + } + if call.method == "load_profile" { + var query = profileQuery + query[kSecReturnData as String] = true + query[kSecMatchLimit as String] = kSecMatchLimitOne + var value: CFTypeRef? + let status = SecItemCopyMatching(query as CFDictionary, &value) + if status == errSecItemNotFound { result(nil) } + else if status == errSecSuccess, let data = value as? Data { result(String(data: data, encoding: .utf8)) } + else { result(FlutterError(code: "KEYCHAIN_LOAD", message: "Could not read network profile", details: status)) } + return + } + if call.method == "delete_profile" { + let status = SecItemDelete(profileQuery as CFDictionary) + if status == errSecSuccess || status == errSecItemNotFound { result(nil) } + else { result(FlutterError(code: "KEYCHAIN_DELETE", message: "Could not delete network profile", details: status)) } + return + } + guard call.method == "launch", let args = call.arguments as? [String: Any], + let socket = args["socket"] as? String, let uid = args["uid"] as? Int, + uid == Int(getuid()), uid != 0, + socket.hasPrefix("/tmp/meshport-vpn-"), socket.hasSuffix("/control.sock"), + let helper = Bundle.main.path(forAuxiliaryExecutable: "meshport-vpn-helper") else { + result(FlutterError(code: "VPN_UNAVAILABLE", message: "VPN helper missing or invalid launch request", details: nil)) + return + } + func quoteShell(_ value: String) -> String { + "'" + value.replacingOccurrences(of: "'", with: "'\"'\"'") + "'" + } + let command = quoteShell(helper) + " --socket " + quoteShell(socket) + " --uid " + String(uid) + " /dev/null 2>&1 &" + let literal = command.replacingOccurrences(of: "\\", with: "\\\\").replacingOccurrences(of: "\"", with: "\\\"") + DispatchQueue.global(qos: .userInitiated).async { + var error: NSDictionary? + let script = NSAppleScript(source: "do shell script \"" + literal + "\" with administrator privileges") + let output = script?.executeAndReturnError(&error) + DispatchQueue.main.async { + if output == nil || error != nil { + result(FlutterError(code: "VPN_AUTHORIZATION", message: "Administrator authorization cancelled or helper launch failed", details: nil)) + } else { + result(nil) + } + } + } + } + super.awakeFromNib() + } +} diff --git a/apps/meshport_lab/macos/Runner/Release.entitlements b/apps/meshport_lab/macos/Runner/Release.entitlements new file mode 100644 index 0000000..7ae2420 --- /dev/null +++ b/apps/meshport_lab/macos/Runner/Release.entitlements @@ -0,0 +1,12 @@ + + + + + com.apple.security.app-sandbox + + com.apple.security.network.server + + com.apple.security.network.client + + + diff --git a/apps/meshport_lab/macos/RunnerTests/RunnerTests.swift b/apps/meshport_lab/macos/RunnerTests/RunnerTests.swift new file mode 100644 index 0000000..61f3bd1 --- /dev/null +++ b/apps/meshport_lab/macos/RunnerTests/RunnerTests.swift @@ -0,0 +1,12 @@ +import Cocoa +import FlutterMacOS +import XCTest + +class RunnerTests: XCTestCase { + + func testExample() { + // If you add code to the Runner application, consider adding tests here. + // See https://developer.apple.com/documentation/xctest for more information about using XCTest. + } + +} diff --git a/apps/meshport_lab/pubspec.lock b/apps/meshport_lab/pubspec.lock new file mode 100644 index 0000000..370ef56 --- /dev/null +++ b/apps/meshport_lab/pubspec.lock @@ -0,0 +1,291 @@ +# Generated by pub +# See https://dart.dev/tools/pub/glossary#lockfile +packages: + async: + dependency: transitive + description: + name: async + sha256: e2eb0491ba5ddb6177742d2da23904574082139b07c1e33b8503b9f46f3e1a37 + url: "https://pub.dev" + source: hosted + version: "2.13.1" + boolean_selector: + dependency: transitive + description: + name: boolean_selector + sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea" + url: "https://pub.dev" + source: hosted + version: "2.1.2" + characters: + dependency: transitive + description: + name: characters + sha256: faf38497bda5ead2a8c7615f4f7939df04333478bf32e4173fcb06d428b5716b + url: "https://pub.dev" + source: hosted + version: "1.4.1" + clock: + dependency: transitive + description: + name: clock + sha256: fddb70d9b5277016c77a80201021d40a2247104d9f4aa7bab7157b7e3f05b84b + url: "https://pub.dev" + source: hosted + version: "1.1.2" + collection: + dependency: transitive + description: + name: collection + sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76" + url: "https://pub.dev" + source: hosted + version: "1.19.1" + cupertino_icons: + dependency: "direct main" + description: + name: cupertino_icons + sha256: "41e005c33bd814be4d3096aff55b1908d419fde52ca656c8c47719ec745873cd" + url: "https://pub.dev" + source: hosted + version: "1.0.9" + fake_async: + dependency: transitive + description: + name: fake_async + sha256: "5368f224a74523e8d2e7399ea1638b37aecfca824a3cc4dfdf77bf1fa905ac44" + url: "https://pub.dev" + source: hosted + version: "1.3.3" + ffi: + dependency: transitive + description: + name: ffi + sha256: "6d7fd89431262d8f3125e81b50d3847a091d846eafcd4fdb88dd06f36d705a45" + url: "https://pub.dev" + source: hosted + version: "2.2.0" + file: + dependency: transitive + description: + name: file + sha256: a3b4f84adafef897088c160faf7dfffb7696046cb13ae90b508c2cbc95d3b8d4 + url: "https://pub.dev" + source: hosted + version: "7.0.1" + flutter: + dependency: "direct main" + description: flutter + source: sdk + version: "0.0.0" + flutter_driver: + dependency: transitive + description: flutter + source: sdk + version: "0.0.0" + flutter_lints: + dependency: "direct dev" + description: + name: flutter_lints + sha256: "3105dc8492f6183fb076ccf1f351ac3d60564bff92e20bfc4af9cc1651f4e7e1" + url: "https://pub.dev" + source: hosted + version: "6.0.0" + flutter_test: + dependency: "direct dev" + description: flutter + source: sdk + version: "0.0.0" + fuchsia_remote_debug_protocol: + dependency: transitive + description: flutter + source: sdk + version: "0.0.0" + integration_test: + dependency: "direct dev" + description: flutter + source: sdk + version: "0.0.0" + leak_tracker: + dependency: transitive + description: + name: leak_tracker + sha256: "33e2e26bdd85a0112ec15400c8cbffea70d0f9c3407491f672a2fad47915e2de" + url: "https://pub.dev" + source: hosted + version: "11.0.2" + leak_tracker_flutter_testing: + dependency: transitive + description: + name: leak_tracker_flutter_testing + sha256: "1dbc140bb5a23c75ea9c4811222756104fbcd1a27173f0c34ca01e16bea473c1" + url: "https://pub.dev" + source: hosted + version: "3.0.10" + leak_tracker_testing: + dependency: transitive + description: + name: leak_tracker_testing + sha256: "8d5a2d49f4a66b49744b23b018848400d23e54caf9463f4eb20df3eb8acb2eb1" + url: "https://pub.dev" + source: hosted + version: "3.0.2" + lints: + dependency: transitive + description: + name: lints + sha256: "12f842a479589fea194fe5c5a3095abc7be0c1f2ddfa9a0e76aed1dbd26a87df" + url: "https://pub.dev" + source: hosted + version: "6.1.0" + matcher: + dependency: transitive + description: + name: matcher + sha256: dc0b7dc7651697ea4ff3e69ef44b0407ea32c487a39fff6a4004fa585e901861 + url: "https://pub.dev" + source: hosted + version: "0.12.19" + material_color_utilities: + dependency: transitive + description: + name: material_color_utilities + sha256: "9c337007e82b1889149c82ed242ed1cb24a66044e30979c44912381e9be4c48b" + url: "https://pub.dev" + source: hosted + version: "0.13.0" + meshport_flutter: + dependency: "direct main" + description: + path: "../../bindings/flutter/meshport_flutter" + relative: true + source: path + version: "0.1.0" + meta: + dependency: transitive + description: + name: meta + sha256: "23f08335362185a5ea2ad3a4e597f1375e78bce8a040df5c600c8d3552ef2394" + url: "https://pub.dev" + source: hosted + version: "1.17.0" + path: + dependency: transitive + description: + name: path + sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5" + url: "https://pub.dev" + source: hosted + version: "1.9.1" + platform: + dependency: transitive + description: + name: platform + sha256: "5d6b1b0036a5f331ebc77c850ebc8506cbc1e9416c27e59b439f917a902a4984" + url: "https://pub.dev" + source: hosted + version: "3.1.6" + process: + dependency: transitive + description: + name: process + sha256: "4242ba3508d37e01808bdf71ad1d5bb93a8d671bf2e7450e6b1b353fb0808891" + url: "https://pub.dev" + source: hosted + version: "5.0.6" + sky_engine: + dependency: transitive + description: flutter + source: sdk + version: "0.0.0" + source_span: + dependency: transitive + description: + name: source_span + sha256: "56a02f1f4cd1a2d96303c0144c93bd6d909eea6bee6bf5a0e0b685edbd4c47ab" + url: "https://pub.dev" + source: hosted + version: "1.10.2" + stack_trace: + dependency: transitive + description: + name: stack_trace + sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1" + url: "https://pub.dev" + source: hosted + version: "1.12.1" + stream_channel: + dependency: transitive + description: + name: stream_channel + sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d" + url: "https://pub.dev" + source: hosted + version: "2.1.4" + string_scanner: + dependency: transitive + description: + name: string_scanner + sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43" + url: "https://pub.dev" + source: hosted + version: "1.4.1" + sync_http: + dependency: transitive + description: + name: sync_http + sha256: "7f0cd72eca000d2e026bcd6f990b81d0ca06022ef4e32fb257b30d3d1014a961" + url: "https://pub.dev" + source: hosted + version: "0.3.1" + term_glyph: + dependency: transitive + description: + name: term_glyph + sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e" + url: "https://pub.dev" + source: hosted + version: "1.2.2" + test_api: + dependency: transitive + description: + name: test_api + sha256: "8161c84903fd860b26bfdefb7963b3f0b68fee7adea0f59ef805ecca346f0c7a" + url: "https://pub.dev" + source: hosted + version: "0.7.10" + vector_math: + dependency: transitive + description: + name: vector_math + sha256: d530bd74fea330e6e364cda7a85019c434070188383e1cd8d9777ee586914c5b + url: "https://pub.dev" + source: hosted + version: "2.2.0" + vm_service: + dependency: transitive + description: + name: vm_service + sha256: "5f37239c4851efcef929cea7824e76df7f2f0970aef85d66bbc430afa40e72f0" + url: "https://pub.dev" + source: hosted + version: "15.3.0" + web: + dependency: transitive + description: + name: web + sha256: "868d88a33d8a87b18ffc05f9f030ba328ffefba92d6c127917a2ba740f9cfe4a" + url: "https://pub.dev" + source: hosted + version: "1.1.1" + webdriver: + dependency: transitive + description: + name: webdriver + sha256: "28b82ec894fed45dd71c23ba62d1af973ed97dd59a4f5790a4d38b0b13e5657e" + url: "https://pub.dev" + source: hosted + version: "3.2.0" +sdks: + dart: ">=3.11.1 <4.0.0" + flutter: ">=3.18.0-18.0.pre.54" diff --git a/apps/meshport_lab/pubspec.yaml b/apps/meshport_lab/pubspec.yaml new file mode 100644 index 0000000..73c7c59 --- /dev/null +++ b/apps/meshport_lab/pubspec.yaml @@ -0,0 +1,95 @@ +name: meshport_lab +description: "MeshPort virtual networking client." +# The following line prevents the package from being accidentally published to +# pub.dev using `flutter pub publish`. This is preferred for private packages. +publish_to: 'none' # Remove this line if you wish to publish to pub.dev + +# The following defines the version and build number for your application. +# A version number is three numbers separated by dots, like 1.2.43 +# followed by an optional build number separated by a +. +# Both the version and the builder number may be overridden in flutter +# build by specifying --build-name and --build-number, respectively. +# In Android, build-name is used as versionName while build-number used as versionCode. +# Read more about Android versioning at https://developer.android.com/studio/publish/versioning +# In iOS, build-name is used as CFBundleShortVersionString while build-number is used as CFBundleVersion. +# Read more about iOS versioning at +# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html +# In Windows, build-name is used as the major, minor, and patch parts +# of the product and file versions while build-number is used as the build suffix. +version: 0.1.0+1 + +environment: + sdk: ^3.11.1 + +# Dependencies specify other packages that your package needs in order to work. +# To automatically upgrade your package dependencies to the latest versions +# consider running `flutter pub upgrade --major-versions`. Alternatively, +# dependencies can be manually updated by changing the version numbers below to +# the latest version available on pub.dev. To see which dependencies have newer +# versions available, run `flutter pub outdated`. +dependencies: + meshport_flutter: + path: ../../bindings/flutter/meshport_flutter + flutter: + sdk: flutter + + # The following adds the Cupertino Icons font to your application. + # Use with the CupertinoIcons class for iOS style icons. + cupertino_icons: ^1.0.8 + +dev_dependencies: + integration_test: + sdk: flutter + flutter_test: + sdk: flutter + + # The "flutter_lints" package below contains a set of recommended lints to + # encourage good coding practices. The lint set provided by the package is + # activated in the `analysis_options.yaml` file located at the root of your + # package. See that file for information about deactivating specific lint + # rules and activating additional ones. + flutter_lints: ^6.0.0 + +# For information on the generic Dart part of this file, see the +# following page: https://dart.dev/tools/pub/pubspec + +# The following section is specific to Flutter packages. +flutter: + + # The following line ensures that the Material Icons font is + # included with your application, so that you can use the icons in + # the material Icons class. + uses-material-design: true + assets: + - assets/branding/meshport.png + + # To add assets to your application, add an assets section, like this: + # assets: + # - images/a_dot_burr.jpeg + # - images/a_dot_ham.jpeg + + # An image asset can refer to one or more resolution-specific "variants", see + # https://flutter.dev/to/resolution-aware-images + + # For details regarding adding assets from package dependencies, see + # https://flutter.dev/to/asset-from-package + + # To add custom fonts to your application, add a fonts section here, + # in this "flutter" section. Each entry in this list should have a + # "family" key with the font family name, and a "fonts" key with a + # list giving the asset and other descriptors for the font. For + # example: + # fonts: + # - family: Schyler + # fonts: + # - asset: fonts/Schyler-Regular.ttf + # - asset: fonts/Schyler-Italic.ttf + # style: italic + # - family: Trajan Pro + # fonts: + # - asset: fonts/TrajanPro.ttf + # - asset: fonts/TrajanPro_Bold.ttf + # weight: 700 + # + # For details regarding fonts from package dependencies, + # see https://flutter.dev/to/font-from-package diff --git a/apps/meshport_lab/test/native_import_test.dart b/apps/meshport_lab/test/native_import_test.dart new file mode 100644 index 0000000..41ac621 --- /dev/null +++ b/apps/meshport_lab/test/native_import_test.dart @@ -0,0 +1,76 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:meshport_lab/features/lab_screen.dart'; + +void main() { + testWidgets( + 'TOML import starts real native engine and can stop it', + (tester) async { + await tester.pumpWidget(const MaterialApp(home: LabScreen())); + await tester.runAsync(() async { + await Future.delayed(const Duration(milliseconds: 500)); + }); + await tester.pump(); + expect(find.textContaining('原生库已加载'), findsOneWidget); + await tester.tap(find.text('设置').last); + await tester.pumpAndSettle(); + await tester.tap(find.text('导入')); + await tester.pumpAndSettle(); + await tester.tap(find.text('粘贴 TOML 并连接')); + await tester.pumpAndSettle(); + await tester.enterText(find.byType(TextField).last, ''' +ipv4 = "10.79.0.11" +listeners = [] +stun_servers = [] +stun_servers_v6 = [] +[network_identity] +network_name = "ui-local-test" +network_secret = "test-only" +[flags] +default_protocol = "udp" +'''); + await tester.tap(find.text('校验并连接').last); + await tester.pump(const Duration(milliseconds: 500)); + await tester.pumpAndSettle(); + for ( + var i = 0; + i < 40 && find.textContaining('导入配置并启动引擎').evaluate().isEmpty; + i++ + ) { + await tester.runAsync(() async { + await Future.delayed(const Duration(milliseconds: 100)); + }); + await tester.pump(); + } + expect(find.textContaining('导入配置并启动引擎'), findsOneWidget); + await tester.tap(find.text('概览').last); + await tester.pumpAndSettle(); + for ( + var i = 0; + i < 40 && find.text('引擎运行中 · 0 个节点').evaluate().isEmpty; + i++ + ) { + await tester.runAsync( + () => Future.delayed(const Duration(milliseconds: 100)), + ); + await tester.pump(); + } + expect(find.text('引擎运行中 · 0 个节点'), findsOneWidget); + expect(find.textContaining('当前设备'), findsOneWidget); + expect(find.textContaining('节点 ID'), findsOneWidget); + await tester.tap(find.text('断开连接')); + for (var i = 0; i < 40 && find.text('尚未连接').evaluate().isEmpty; i++) { + await tester.runAsync(() async { + await Future.delayed(const Duration(milliseconds: 100)); + }); + await tester.pump(); + } + expect(find.text('尚未连接'), findsOneWidget); + await tester.pumpWidget(const SizedBox.shrink()); + await tester.runAsync(() async { + await Future.delayed(const Duration(milliseconds: 100)); + }); + }, + skip: !const bool.hasEnvironment('MESHPORT_LIBRARY'), + ); +} diff --git a/apps/meshport_lab/test/profile_test.dart b/apps/meshport_lab/test/profile_test.dart new file mode 100644 index 0000000..b1d6a49 --- /dev/null +++ b/apps/meshport_lab/test/profile_test.dart @@ -0,0 +1,129 @@ +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:meshport_lab/features/lab_screen.dart'; + +void main() { + const channel = MethodChannel('meshport/system_vpn'); + final binding = TestWidgetsFlutterBinding.ensureInitialized(); + String? stored; + setUp(() { + stored = null; + binding.defaultBinaryMessenger.setMockMethodCallHandler(channel, ( + call, + ) async { + switch (call.method) { + case 'load_profile': + return stored; + case 'save_profile': + stored = call.arguments as String; + return null; + case 'delete_profile': + stored = null; + return null; + default: + throw StateError('Unexpected call: ${call.method}'); + } + }); + }); + tearDown( + () => + binding.defaultBinaryMessenger.setMockMethodCallHandler(channel, null), + ); + + Future waitFor(WidgetTester tester, Finder finder) async { + for (var i = 0; i < 60 && finder.evaluate().isEmpty; i++) { + await tester.runAsync( + () => Future.delayed(const Duration(milliseconds: 50)), + ); + await tester.pump(); + } + expect(finder, findsWidgets); + } + + Future openSettings(WidgetTester tester) async { + await tester.pumpWidget(const MaterialApp(home: LabScreen())); + await waitFor(tester, find.textContaining('原生库已加载')); + await tester.tap(find.text('设置').last); + await tester.pumpAndSettle(); + } + + Finder field(String label) => find.byWidgetPredicate( + (widget) => widget is TextField && widget.decoration?.labelText == label, + ); + + testWidgets( + 'save without connecting, restore on restart, delete persisted profile', + (tester) async { + tester.view.physicalSize = const Size(1400, 1600); + tester.view.devicePixelRatio = 1; + addTearDown(tester.view.resetPhysicalSize); + addTearDown(tester.view.resetDevicePixelRatio); + await openSettings(tester); + await tester.enterText(field('网络名称'), '我的网络'); + await tester.enterText(field('网络密钥'), 'test-only-secret'); + await tester.enterText(field('节点名称'), 'saved-node'); + await tester.enterText(field('虚拟 IPv4'), '10.79.0.11/24'); + await tester.tap(find.text('保存配置')); + await waitFor(tester, find.textContaining('网络配置已保存到 macOS 钥匙串')); + expect(stored, contains('我的网络')); + expect(find.text('尚未连接'), findsNothing); // The settings page is selected. + await tester.pumpWidget(const SizedBox.shrink()); + await tester.runAsync( + () => Future.delayed(const Duration(milliseconds: 100)), + ); + await openSettings(tester); + await waitFor(tester, find.textContaining('已自动载入保存的网络配置')); + expect(tester.widget(field('网络名称')).controller!.text, '我的网络'); + expect( + tester.widget(field('网络密钥')).controller!.text, + 'test-only-secret', + ); + expect( + tester.widget(field('节点名称')).controller!.text, + 'saved-node', + ); + expect( + tester.widget(field('虚拟 IPv4')).controller!.text, + '10.79.0.11/24', + ); + await tester.tap(find.text('概览').last); + await tester.pumpAndSettle(); + expect(find.text('尚未连接'), findsOneWidget); + await tester.tap(find.text('设置').last); + await tester.pumpAndSettle(); + await tester.tap(find.text('删除已保存配置')); + await waitFor(tester, find.textContaining('已删除保存的配置')); + expect(stored, isNull); + await tester.pumpWidget(const SizedBox.shrink()); + }, + skip: !const bool.hasEnvironment('MESHPORT_LIBRARY'), + ); + + testWidgets( + 'unchanged restored profile retains advanced TOML', + (tester) async { + stored = ''' +hostname = "advanced-node" +ipv4 = "10.79.0.11/24" +listeners = [] +stun_servers = [] +stun_servers_v6 = [] +[network_identity] +network_name = "advanced" +network_secret = "test-only" +[flags] +disable_udp_hole_punching = true +'''; + final original = stored; + await openSettings(tester); + await waitFor(tester, find.textContaining('已自动载入保存的网络配置')); + await tester.ensureVisible(find.text('保存配置')); + await tester.tap(find.text('保存配置')); + await waitFor(tester, find.textContaining('网络配置已保存到 macOS 钥匙串')); + expect(stored, original); + await tester.pumpWidget(const SizedBox.shrink()); + }, + skip: !const bool.hasEnvironment('MESHPORT_LIBRARY'), + ); +} diff --git a/apps/meshport_lab/test/quality_test.dart b/apps/meshport_lab/test/quality_test.dart new file mode 100644 index 0000000..93bedaa --- /dev/null +++ b/apps/meshport_lab/test/quality_test.dart @@ -0,0 +1,26 @@ +import 'package:flutter_test/flutter_test.dart'; +import 'package:meshport_flutter/meshport_flutter.dart'; + +void main() { + test( + 'Quality includes timeouts in loss but excludes them from RTT percentiles', + () { + final summary = QualitySummary([ + {'success': true, 'elapsed_ms': 10}, + {'success': true, 'elapsed_ms': 20}, + {'success': false}, + {'success': true, 'elapsed_ms': 30}, + ]); + expect(summary.lossPercent, 25); + expect(summary.medianMs, 20); + expect(summary.p95Ms, 30); + expect(summary.jitterMs, 10); + expect( + QualitySummary([ + {'success': false}, + ]).medianMs, + isNull, + ); + }, + ); +} diff --git a/apps/meshport_lab/test/system_vpn_transport_test.dart b/apps/meshport_lab/test/system_vpn_transport_test.dart new file mode 100644 index 0000000..66ca27f --- /dev/null +++ b/apps/meshport_lab/test/system_vpn_transport_test.dart @@ -0,0 +1,53 @@ +import 'dart:convert'; +import 'dart:io'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:meshport_flutter/meshport_flutter.dart'; + +void main() { + test( + 'Unix control serializes replies and removes socket on close', + () async { + String? path; + Socket? helper; + final operations = []; + final client = await openMacSystemVpn( + launch: (address, uid) async { + path = address; + expect(uid, greaterThan(0)); + helper = await Socket.connect( + InternetAddress(address, type: InternetAddressType.unix), + 0, + ); + helper! + .cast>() + .transform(utf8.decoder) + .transform(const LineSplitter()) + .listen((line) { + final request = jsonDecode(line) as Map; + final operation = request['op'] as String; + operations.add(operation); + helper!.write( + '${jsonEncode({ + 'ok': true, + 'data': {'operation': operation}, + })}\n', + ); + }); + }, + ); + try { + final results = await Future.wait([ + client.request({'op': 'status'}), + client.request({'op': 'validate', 'toml': ''}), + ]); + expect(results.map((r) => r['operation']), ['status', 'validate']); + await client.close(); + expect(operations, ['status', 'validate', 'stop']); + expect(await Directory(File(path!).parent.path).exists(), false); + } finally { + helper?.destroy(); + } + }, + skip: !Platform.isMacOS, + ); +} diff --git a/apps/meshport_lab/test/telemetry_test.dart b/apps/meshport_lab/test/telemetry_test.dart new file mode 100644 index 0000000..5dd2566 --- /dev/null +++ b/apps/meshport_lab/test/telemetry_test.dart @@ -0,0 +1,141 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:meshport_lab/features/network_telemetry.dart'; + +void main() { + testWidgets('Shows current device before any remote peer is discovered', ( + tester, + ) async { + await tester.pumpWidget( + const MaterialApp( + home: Scaffold( + body: NodeTelemetry( + status: { + 'local_peer': { + 'peer_id': 42, + 'hostname': 'MeshPort-Lab', + 'ipv4': '192.168.20.5/24', + 'state': 'Running', + 'udp_nat_type': 'Symmetric', + 'version': 'test-core', + }, + 'peers': [], + 'routes': [], + }, + ), + ), + ), + ); + expect(find.text('MeshPort-Lab · 当前设备'), findsOneWidget); + expect(find.textContaining('192.168.20.5/24'), findsOneWidget); + expect(find.textContaining('节点 ID 42'), findsOneWidget); + expect(find.text('运行中'), findsOneWidget); + expect(find.text('尚未发现其他节点。'), findsOneWidget); + expect(find.textContaining('中继'), findsNothing); + expect(find.textContaining('ms'), findsNothing); + }); + testWidgets('Displays direct RTT and distinguishes relayed estimates', ( + tester, + ) async { + await tester.pumpWidget( + const MaterialApp( + home: Scaffold( + body: NodeTelemetry( + status: { + 'peers': [ + { + 'peer_id': 1, + 'direct': true, + 'latency_ms': 23.4, + 'rx_bytes': 2048, + 'tx_bytes': 1024, + 'rx_bytes_per_second': 1024.0, + 'tx_bytes_per_second': 512.0, + }, + ], + 'routes': [ + {'peer_id': 1, 'hostname': 'game-server', 'ipv4': '10.77.0.2'}, + { + 'peer_id': 2, + 'hostname': 'relay-target', + 'estimated_latency_ms': 89, + 'next_hop_peer_id': 1, + }, + ], + }, + ), + ), + ), + ); + expect(find.text('23.4 ms'), findsOneWidget); + expect(find.text('89.0 ms'), findsOneWidget); + expect(find.textContaining('链路 RTT'), findsOneWidget); + expect(find.textContaining('路由估算'), findsOneWidget); + expect(find.textContaining('1.0 KB/s'), findsOneWidget); + expect(find.textContaining('未单独计量'), findsOneWidget); + }); + testWidgets('A direct connection can coexist with a relayed selected route', ( + tester, + ) async { + await tester.pumpWidget( + const MaterialApp( + home: Scaffold( + body: NodeTelemetry( + status: { + 'peers': [ + {'peer_id': 1, 'direct': true, 'latency_ms': 166.5}, + ], + 'routes': [ + { + 'peer_id': 1, + 'hostname': 'DIG-US', + 'next_hop_peer_id': 2, + 'estimated_latency_ms': 108, + 'udp_nat_type': 'FullCone', + 'version': '2.4.5', + }, + ], + }, + ), + ), + ), + ); + expect(find.textContaining('中继 · 有直连可用'), findsOneWidget); + expect(find.text('108.0 ms'), findsOneWidget); + expect(find.text('166.5 ms'), findsNothing); + expect(find.textContaining('FullCone'), findsOneWidget); + }); + testWidgets('Punched Redmi AX6 uses measured RTT and direct label', ( + tester, + ) async { + await tester.pumpWidget( + const MaterialApp( + home: Scaffold( + body: NodeTelemetry( + status: { + 'peers': [ + { + 'peer_id': 3157594741, + 'direct': true, + 'hole_punched': true, + 'latency_ms': 7.497, + }, + ], + 'routes': [ + { + 'peer_id': 3157594741, + 'hostname': 'Redmi_AX6', + 'next_hop_peer_id': 3157594741, + 'estimated_latency_ms': 7, + }, + ], + }, + ), + ), + ), + ); + expect(find.text('7.5 ms'), findsOneWidget); + expect(find.textContaining('直连 · 打洞建立 · 链路 RTT'), findsOneWidget); + expect(find.textContaining('中继'), findsNothing); + }); +} diff --git a/apps/meshport_lab/test/widget_test.dart b/apps/meshport_lab/test/widget_test.dart new file mode 100644 index 0000000..bed4158 --- /dev/null +++ b/apps/meshport_lab/test/widget_test.dart @@ -0,0 +1,19 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:meshport_lab/features/lab_screen.dart'; + +void main() { + testWidgets('Starts disconnected and exposes networking configuration', ( + tester, + ) async { + await tester.pumpWidget( + const MaterialApp(home: LabScreen(initializeNative: false)), + ); + expect(find.text('尚未连接'), findsOneWidget); + await tester.tap(find.text('设置').last); + await tester.pumpAndSettle(); + expect(find.text('网络密钥'), findsOneWidget); + expect(find.text('校验并连接'), findsOneWidget); + expect(find.text('保存配置'), findsOneWidget); + }); +} diff --git a/apps/meshport_lab/tool/native_smoke.dart b/apps/meshport_lab/tool/native_smoke.dart new file mode 100644 index 0000000..8629548 --- /dev/null +++ b/apps/meshport_lab/tool/native_smoke.dart @@ -0,0 +1,94 @@ +import 'dart:io'; +import 'dart:typed_data'; +import 'package:meshport_flutter/meshport_flutter.dart'; + +Future main(List arguments) async { + final path = arguments.single; + final server = await MeshPortClient.open(libraryPath: path); + final client = await MeshPortClient.open(libraryPath: path); + final osSocket = await RawDatagramSocket.bind( + InternetAddress.loopbackIPv4, + 0, + ); + final port = osSocket.port; + osSocket.close(); + String config(String ip, bool listen) => + ''' +ipv4 = "$ip" +stun_servers = [] +stun_servers_v6 = [] +${listen ? 'listeners = ["udp://127.0.0.1:$port"]' : 'listeners = []\n[[peer]]\nuri = "udp://127.0.0.1:$port"'} +[network_identity] +network_name = "ffi-smoke" +network_secret = "test-only" +[flags] +default_protocol = "udp" +'''; + try { + await server.start(config('10.78.0.2', true)); + await client.start(config('10.78.0.11', false)); + final deadline = DateTime.now().add(const Duration(seconds: 10)); + while ((await client.status())['peer_count'] == 0) { + if (DateTime.now().isAfter(deadline)) { + throw StateError('Peer discovery timeout'); + } + await Future.delayed(const Duration(milliseconds: 100)); + } + await Future.delayed(const Duration(milliseconds: 500)); + final a = await client.bindUdp(port: 17007); + final b = await server.bindUdp(port: 17008); + // UDP API currently receives only registered remote flows. Warm up both directions. + await server.sendUdp(b, '10.78.0.11:17007', Uint8List.fromList([0])); + await Future.delayed(const Duration(milliseconds: 100)); + final payload = Uint8List.fromList([1, 2, 3, 4]); + await client.sendUdp(a, '10.78.0.2:17008', payload); + final received = await server.receiveUdp(b); + if (received['bytes'].toString() != payload.toList().toString()) { + throw StateError('Data mismatch'); + } + await server.sendUdp(b, '10.78.0.11:17007', payload); + var response = await client.receiveUdp(a); + if (response['bytes'].toString() == '[0]') { + response = await client.receiveUdp(a); + } + if (response['bytes'].toString() != payload.toList().toString()) { + throw StateError('Reply mismatch'); + } + // Echo runs on the other context while the client waits in quality_sample. + final echo = () async { + final probe = await server.receiveUdp(b); + await server.sendUdp( + b, + probe['source'] as String, + Uint8List.fromList((probe['bytes'] as List).cast()), + ); + }(); + final quality = await client.sampleUdpQuality(a, '10.78.0.2:17008', 42); + await echo; + if (quality['success'] != true || + quality['elapsed_ms'] is! num || + quality['next_hop_peer_id'] == null || + quality['route_changed'] != false) { + throw StateError('Quality sample mismatch: $quality'); + } + final timeout = await client.sampleUdpQuality( + a, + '10.78.0.2:17008', + 43, + timeoutMs: 100, + ); + if (timeout['success'] != false || timeout['elapsed_ms'] != null) { + throw StateError('Quality timeout mismatch: $timeout'); + } + await client.closeResource(a); + await server.closeResource(b); + await client.stop(); + await server.stop(); + stdout.writeln( + 'PASS: Dart isolate → C ABI → EasyTier UDP overlay → data verified', + ); + } finally { + await client.close(); + await server.close(); + } +} diff --git a/apps/meshport_lab/windows/.gitignore b/apps/meshport_lab/windows/.gitignore new file mode 100644 index 0000000..d492d0d --- /dev/null +++ b/apps/meshport_lab/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/apps/meshport_lab/windows/CMakeLists.txt b/apps/meshport_lab/windows/CMakeLists.txt new file mode 100644 index 0000000..0a33c55 --- /dev/null +++ b/apps/meshport_lab/windows/CMakeLists.txt @@ -0,0 +1,108 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(meshport_lab LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "meshport_lab") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(VERSION 3.14...3.25) + +# Define build configuration option. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() +# Define settings for the Profile build mode. +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/windows/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/apps/meshport_lab/windows/flutter/CMakeLists.txt b/apps/meshport_lab/windows/flutter/CMakeLists.txt new file mode 100644 index 0000000..903f489 --- /dev/null +++ b/apps/meshport_lab/windows/flutter/CMakeLists.txt @@ -0,0 +1,109 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.14) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# Set fallback configurations for older versions of the flutter tool. +if (NOT DEFINED FLUTTER_TARGET_PLATFORM) + set(FLUTTER_TARGET_PLATFORM "windows-x64") +endif() + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + ${FLUTTER_TARGET_PLATFORM} $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/apps/meshport_lab/windows/flutter/generated_plugin_registrant.cc b/apps/meshport_lab/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..8b6d468 --- /dev/null +++ b/apps/meshport_lab/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void RegisterPlugins(flutter::PluginRegistry* registry) { +} diff --git a/apps/meshport_lab/windows/flutter/generated_plugin_registrant.h b/apps/meshport_lab/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..dc139d8 --- /dev/null +++ b/apps/meshport_lab/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/apps/meshport_lab/windows/flutter/generated_plugins.cmake b/apps/meshport_lab/windows/flutter/generated_plugins.cmake new file mode 100644 index 0000000..b93c4c3 --- /dev/null +++ b/apps/meshport_lab/windows/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/apps/meshport_lab/windows/runner/CMakeLists.txt b/apps/meshport_lab/windows/runner/CMakeLists.txt new file mode 100644 index 0000000..394917c --- /dev/null +++ b/apps/meshport_lab/windows/runner/CMakeLists.txt @@ -0,0 +1,40 @@ +cmake_minimum_required(VERSION 3.14) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the build version. +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION=\"${FLUTTER_VERSION}\"") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MAJOR=${FLUTTER_VERSION_MAJOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MINOR=${FLUTTER_VERSION_MINOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_PATCH=${FLUTTER_VERSION_PATCH}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_BUILD=${FLUTTER_VERSION_BUILD}") + +# Disable Windows macros that collide with C++ standard library functions. +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") + +# Add dependency libraries and include directories. Add any application-specific +# dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_link_libraries(${BINARY_NAME} PRIVATE "dwmapi.lib") +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/apps/meshport_lab/windows/runner/Runner.rc b/apps/meshport_lab/windows/runner/Runner.rc new file mode 100644 index 0000000..485dde0 --- /dev/null +++ b/apps/meshport_lab/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#if defined(FLUTTER_VERSION_MAJOR) && defined(FLUTTER_VERSION_MINOR) && defined(FLUTTER_VERSION_PATCH) && defined(FLUTTER_VERSION_BUILD) +#define VERSION_AS_NUMBER FLUTTER_VERSION_MAJOR,FLUTTER_VERSION_MINOR,FLUTTER_VERSION_PATCH,FLUTTER_VERSION_BUILD +#else +#define VERSION_AS_NUMBER 1,0,0,0 +#endif + +#if defined(FLUTTER_VERSION) +#define VERSION_AS_STRING FLUTTER_VERSION +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "com.example" "\0" + VALUE "FileDescription", "MeshPort" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "meshport_lab" "\0" + VALUE "LegalCopyright", "Copyright (C) 2026 com.example. All rights reserved." "\0" + VALUE "OriginalFilename", "meshport_lab.exe" "\0" + VALUE "ProductName", "MeshPort" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/apps/meshport_lab/windows/runner/flutter_window.cpp b/apps/meshport_lab/windows/runner/flutter_window.cpp new file mode 100644 index 0000000..955ee30 --- /dev/null +++ b/apps/meshport_lab/windows/runner/flutter_window.cpp @@ -0,0 +1,71 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + + flutter_controller_->engine()->SetNextFrameCallback([&]() { + this->Show(); + }); + + // Flutter can complete the first frame before the "show window" callback is + // registered. The following call ensures a frame is pending to ensure the + // window is shown. It is a no-op if the first frame hasn't completed yet. + flutter_controller_->ForceRedraw(); + + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opportunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/apps/meshport_lab/windows/runner/flutter_window.h b/apps/meshport_lab/windows/runner/flutter_window.h new file mode 100644 index 0000000..6da0652 --- /dev/null +++ b/apps/meshport_lab/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/apps/meshport_lab/windows/runner/main.cpp b/apps/meshport_lab/windows/runner/main.cpp new file mode 100644 index 0000000..686fd6b --- /dev/null +++ b/apps/meshport_lab/windows/runner/main.cpp @@ -0,0 +1,43 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.Create(L"meshport_lab", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/apps/meshport_lab/windows/runner/resource.h b/apps/meshport_lab/windows/runner/resource.h new file mode 100644 index 0000000..66a65d1 --- /dev/null +++ b/apps/meshport_lab/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/apps/meshport_lab/windows/runner/resources/app_icon.ico b/apps/meshport_lab/windows/runner/resources/app_icon.ico new file mode 100644 index 0000000..f59f82c Binary files /dev/null and b/apps/meshport_lab/windows/runner/resources/app_icon.ico differ diff --git a/apps/meshport_lab/windows/runner/runner.exe.manifest b/apps/meshport_lab/windows/runner/runner.exe.manifest new file mode 100644 index 0000000..153653e --- /dev/null +++ b/apps/meshport_lab/windows/runner/runner.exe.manifest @@ -0,0 +1,14 @@ + + + + + PerMonitorV2 + + + + + + + + + diff --git a/apps/meshport_lab/windows/runner/utils.cpp b/apps/meshport_lab/windows/runner/utils.cpp new file mode 100644 index 0000000..3a0b465 --- /dev/null +++ b/apps/meshport_lab/windows/runner/utils.cpp @@ -0,0 +1,65 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + unsigned int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, nullptr, 0, nullptr, nullptr) + -1; // remove the trailing null character + int input_length = (int)wcslen(utf16_string); + std::string utf8_string; + if (target_length == 0 || target_length > utf8_string.max_size()) { + return utf8_string; + } + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + input_length, utf8_string.data(), target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/apps/meshport_lab/windows/runner/utils.h b/apps/meshport_lab/windows/runner/utils.h new file mode 100644 index 0000000..3879d54 --- /dev/null +++ b/apps/meshport_lab/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/apps/meshport_lab/windows/runner/win32_window.cpp b/apps/meshport_lab/windows/runner/win32_window.cpp new file mode 100644 index 0000000..60608d0 --- /dev/null +++ b/apps/meshport_lab/windows/runner/win32_window.cpp @@ -0,0 +1,288 @@ +#include "win32_window.h" + +#include +#include + +#include "resource.h" + +namespace { + +/// Window attribute that enables dark mode window decorations. +/// +/// Redefined in case the developer's machine has a Windows SDK older than +/// version 10.0.22000.0. +/// See: https://docs.microsoft.com/windows/win32/api/dwmapi/ne-dwmapi-dwmwindowattribute +#ifndef DWMWA_USE_IMMERSIVE_DARK_MODE +#define DWMWA_USE_IMMERSIVE_DARK_MODE 20 +#endif + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +/// Registry key for app theme preference. +/// +/// A value of 0 indicates apps should use dark mode. A non-zero or missing +/// value indicates apps should use light mode. +constexpr const wchar_t kGetPreferredBrightnessRegKey[] = + L"Software\\Microsoft\\Windows\\CurrentVersion\\Themes\\Personalize"; +constexpr const wchar_t kGetPreferredBrightnessRegValue[] = L"AppsUseLightTheme"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + } + FreeLibrary(user32_module); +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registrar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::Create(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + UpdateTheme(window); + + return OnCreate(); +} + +bool Win32Window::Show() { + return ShowWindow(window_handle_, SW_SHOWNORMAL); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + + case WM_DWMCOLORIZATIONCOLORCHANGED: + UpdateTheme(hwnd); + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} + +void Win32Window::UpdateTheme(HWND const window) { + DWORD light_mode; + DWORD light_mode_size = sizeof(light_mode); + LSTATUS result = RegGetValue(HKEY_CURRENT_USER, kGetPreferredBrightnessRegKey, + kGetPreferredBrightnessRegValue, + RRF_RT_REG_DWORD, nullptr, &light_mode, + &light_mode_size); + + if (result == ERROR_SUCCESS) { + BOOL enable_dark_mode = light_mode == 0; + DwmSetWindowAttribute(window, DWMWA_USE_IMMERSIVE_DARK_MODE, + &enable_dark_mode, sizeof(enable_dark_mode)); + } +} diff --git a/apps/meshport_lab/windows/runner/win32_window.h b/apps/meshport_lab/windows/runner/win32_window.h new file mode 100644 index 0000000..e901dde --- /dev/null +++ b/apps/meshport_lab/windows/runner/win32_window.h @@ -0,0 +1,102 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates a win32 window with |title| that is positioned and sized using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size this function will scale the inputted width and height as + // as appropriate for the default monitor. The window is invisible until + // |Show| is called. Returns true if the window was created successfully. + bool Create(const std::wstring& title, const Point& origin, const Size& size); + + // Show the current window. Returns true if the window was successfully shown. + bool Show(); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + // Update the window frame's theme to match the system theme. + static void UpdateTheme(HWND const window); + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/bindings/flutter/meshport_flutter/lib/meshport_flutter.dart b/bindings/flutter/meshport_flutter/lib/meshport_flutter.dart new file mode 100644 index 0000000..27921d7 --- /dev/null +++ b/bindings/flutter/meshport_flutter/lib/meshport_flutter.dart @@ -0,0 +1,8 @@ +/// MeshPort native SDK. All native calls execute outside the UI isolate. +library; + +export 'src/client.dart'; + +export 'src/quality.dart'; + +export 'src/system_vpn.dart'; diff --git a/bindings/flutter/meshport_flutter/lib/src/client.dart b/bindings/flutter/meshport_flutter/lib/src/client.dart new file mode 100644 index 0000000..de34f95 --- /dev/null +++ b/bindings/flutter/meshport_flutter/lib/src/client.dart @@ -0,0 +1,192 @@ +import 'dart:convert'; +import 'dart:ffi'; +import 'dart:io'; +import 'dart:isolate'; +import 'dart:typed_data'; +import 'package:ffi/ffi.dart'; + +String _defaultLibrary() { + if (Platform.isMacOS) { + final bundled = + '${File(Platform.resolvedExecutable).parent.parent.path}/Frameworks/libmeshport_ffi.dylib'; + if (File(bundled).existsSync()) return bundled; + } + return Platform.isWindows + ? 'meshport_ffi.dll' + : Platform.isMacOS + ? 'libmeshport_ffi.dylib' + : 'libmeshport_ffi.so'; +} + +DynamicLibrary _open(String path) => + Platform.isIOS ? DynamicLibrary.process() : DynamicLibrary.open(path); + +Map _call(String path, int handle, String request) { + final library = _open(path); + final call = library + .lookupFunction< + Pointer Function(Uint64, Pointer), + Pointer Function(int, Pointer) + >('meshport_call'); + final free = library + .lookupFunction< + Void Function(Pointer), + void Function(Pointer) + >('meshport_string_free'); + final input = request.toNativeUtf8(); + try { + final result = call(handle, input); + if (result == nullptr) throw StateError('Native response is null'); + try { + return jsonDecode(result.toDartString()) as Map; + } finally { + free(result); + } + } finally { + calloc.free(input); + } +} + +class MeshPortClient { + final String libraryPath; + final int _handle; + final Future> Function(Map)? _transport; + final Future Function()? _closeTransport; + bool _closed = false; + MeshPortClient._(this.libraryPath, this._handle) + : _transport = null, + _closeTransport = null; + + /// A platform-owned control transport. Responses use the same ABI JSON envelope. + MeshPortClient.fromTransport({ + required Future> Function(Map) + request, + required Future Function() close, + }) : libraryPath = '', + _handle = 0, + _transport = request, + _closeTransport = close; + static Future open({String? libraryPath}) async { + final path = libraryPath ?? _defaultLibrary(); + final handle = await Isolate.run(() { + final lib = _open(path); + final version = lib.lookupFunction( + 'meshport_abi_version', + )(); + if (version != 1) throw StateError('Unsupported MeshPort ABI: $version'); + return lib.lookupFunction( + 'meshport_context_new', + )(); + }); + if (handle == 0) throw StateError('Could not create MeshPort context'); + return MeshPortClient._(path, handle); + } + + Future> request(Map request) async { + if (_closed) throw StateError('MeshPort context is closed'); + final path = libraryPath, handle = _handle, text = jsonEncode(request); + final response = _transport != null + ? await _transport(request) + : await Isolate.run(() => _call(path, handle, text)); + if (response['ok'] != true) + throw StateError( + response['error'] as String? ?? 'Native operation failed', + ); + return response['data'] as Map; + } + + Future validate(String toml) async { + await request({'op': 'validate', 'toml': toml}); + } + + Future start(String toml) async { + await request({'op': 'start', 'toml': toml}); + } + + Future stop() async { + await request({'op': 'stop'}); + } + + /// Opt in to bounded process-wide punch tracing. Does not replace host logging. + Future> enableDiagnostics() => + request({'op': 'diagnostics_enable'}); + + Future> status() => request({'op': 'status'}); + Future> probe( + String target, { + bool udp = false, + bool echo = false, + int timeoutMs = 5000, + }) => request({ + 'op': 'probe', + 'target': target, + 'protocol': udp ? 'UDP' : 'TCP', + 'echo': echo, + 'timeout_ms': timeoutMs, + }); + Future connectTcp(String target) async => + (await request({'op': 'tcp_connect', 'target': target}))['resource'] + as int; + Future writeTcp(int stream, Uint8List data) async { + await request({ + 'op': 'tcp_write', + 'resource': stream, + 'bytes': data.toList(), + }); + } + + Future readTcp(int stream, {int maxBytes = 16384}) async => + Uint8List.fromList( + List.from( + (await request({ + 'op': 'tcp_read', + 'resource': stream, + 'max_bytes': maxBytes, + }))['bytes'], + ), + ); + Future bindUdp({int port = 0}) async => + (await request({'op': 'udp_bind', 'port': port}))['resource'] as int; + Future sendUdp(int socket, String target, Uint8List data) async { + await request({ + 'op': 'udp_send', + 'resource': socket, + 'target': target, + 'bytes': data.toList(), + }); + } + + Future> sampleUdpQuality( + int socket, + String target, + int sequence, { + int timeoutMs = 1000, + }) => request({ + 'op': 'quality_sample', + 'resource': socket, + 'target': target, + 'sequence': sequence, + 'timeout_ms': timeoutMs, + }); + Future> receiveUdp(int socket) => + request({'op': 'udp_receive', 'resource': socket}); + Future closeResource(int resource) async { + await request({'op': 'resource_close', 'resource': resource}); + } + + Future close() async { + if (_closed) return; + _closed = true; + if (_closeTransport != null) { + await _closeTransport(); + return; + } + final path = libraryPath, handle = _handle; + await Isolate.run( + () => + _open(path).lookupFunction( + 'meshport_context_free', + )(handle), + ); + } +} diff --git a/bindings/flutter/meshport_flutter/lib/src/quality.dart b/bindings/flutter/meshport_flutter/lib/src/quality.dart new file mode 100644 index 0000000..6673afb --- /dev/null +++ b/bindings/flutter/meshport_flutter/lib/src/quality.dart @@ -0,0 +1,28 @@ +/// Summaries of real echo samples. Loss means no valid reply before the deadline. +class QualitySummary { + QualitySummary(Iterable> samples) { + final rows = samples.toList(); + sent = rows.length; + final values = rows + .where((r) => r['success'] == true && r['elapsed_ms'] is num) + .map((r) => (r['elapsed_ms'] as num).toDouble()) + .where((v) => v.isFinite && v >= 0) + .toList(); + received = values.length; + if (values.isEmpty) return; + var differences = 0.0; + for (var i = 1; i < values.length; i++) { + differences += (values[i] - values[i - 1]).abs(); + } + jitterMs = values.length < 2 ? null : differences / (values.length - 1); + values.sort(); + medianMs = values.length.isOdd + ? values[values.length ~/ 2] + : (values[values.length ~/ 2 - 1] + values[values.length ~/ 2]) / 2; + p95Ms = values[(values.length * .95).ceil() - 1]; + } + late int sent, received; + double? medianMs, p95Ms, jitterMs; + double? get lossPercent => + sent == 0 ? null : 100.0 * (sent - received) / sent; +} diff --git a/bindings/flutter/meshport_flutter/lib/src/system_vpn.dart b/bindings/flutter/meshport_flutter/lib/src/system_vpn.dart new file mode 100644 index 0000000..b5c0652 --- /dev/null +++ b/bindings/flutter/meshport_flutter/lib/src/system_vpn.dart @@ -0,0 +1,118 @@ +import 'dart:async'; +import 'dart:convert'; +import 'dart:ffi'; +import 'dart:io'; +import 'client.dart'; + +/// Android's host supplies VpnService authorization and a serialized control +/// channel. Keeping Flutter APIs out of this library permits non-Flutter hosts. +Future openAndroidSystemVpn({ + required Future Function() prepare, + required Future> Function(Map) request, +}) async { + if (!Platform.isAndroid) + throw UnsupportedError('Android VPN requires Android'); + await prepare(); + return MeshPortClient.fromTransport( + request: request, + close: () async { + await request({'op': 'stop'}); + }, + ); +} + +/// The host app supplies administrator authorization, without elevating its UI. +Future openMacSystemVpn({ + required Future Function(String socketPath, int uid) launch, +}) async { + if (!Platform.isMacOS) + throw UnsupportedError('System VPN currently supports macOS only'); + final uid = DynamicLibrary.process() + .lookupFunction('getuid')(); + final directory = await Directory('/tmp').createTemp('meshport-vpn-'); + ServerSocket? listener; + Socket? socket; + StreamIterator? replies; + StreamSubscription? subscription; + Future cleanup() async { + socket?.destroy(); + await replies?.cancel(); + await subscription?.cancel(); + await listener?.close(); + if (await directory.exists()) await directory.delete(recursive: true); + } + + try { + final permissions = await Process.run('/bin/chmod', [ + '700', + directory.path, + ]); + if (permissions.exitCode != 0) + throw StateError('Cannot protect VPN control directory'); + final address = '${directory.path}/control.sock'; + listener = await ServerSocket.bind( + InternetAddress(address, type: InternetAddressType.unix), + 0, + ); + final accepted = Completer(); + subscription = listener.listen( + (connection) { + if (accepted.isCompleted) { + connection.destroy(); + } else { + accepted.complete(connection); + } + }, + onError: (Object e) { + if (!accepted.isCompleted) accepted.completeError(e); + }, + ); + await launch(address, uid); + socket = await accepted.future.timeout(const Duration(seconds: 10)); + replies = StreamIterator( + socket! + .cast>() + .transform(utf8.decoder) + .transform(const LineSplitter()), + ); + Future queue = Future.value(); + Future> request(Map value) { + final job = queue.then((_) async { + final encoded = jsonEncode(value); + if (utf8.encode(encoded).length > 131072) + throw ArgumentError('Request exceeds control limit'); + socket!.write('$encoded\n'); + await socket!.flush(); + final received = await replies!.moveNext().timeout( + const Duration(seconds: 30), + ); + if (!received) + throw StateError( + 'VPN helper disconnected; reconnect to authorize again', + ); + return jsonDecode(replies!.current) as Map; + }); + queue = job.then( + (_) {}, + onError: (Object e, StackTrace s) { + socket?.destroy(); + }, + ); + return job; + } + + return MeshPortClient.fromTransport( + request: request, + close: () async { + try { + await request({'op': 'stop'}); + } finally { + await cleanup(); + } + }, + ); + } catch (_) { + await cleanup(); + rethrow; + } +} diff --git a/bindings/flutter/meshport_flutter/pubspec.yaml b/bindings/flutter/meshport_flutter/pubspec.yaml new file mode 100644 index 0000000..28a4964 --- /dev/null +++ b/bindings/flutter/meshport_flutter/pubspec.yaml @@ -0,0 +1,8 @@ +name: meshport_flutter +description: Application-only EasyTier networking SDK bindings for MeshPort. +version: 0.1.0 +publish_to: none +environment: + sdk: ^3.11.0 +dependencies: + ffi: ^2.1.4 diff --git a/crates/meshport-easytier/Cargo.toml b/crates/meshport-easytier/Cargo.toml new file mode 100644 index 0000000..d455a75 --- /dev/null +++ b/crates/meshport-easytier/Cargo.toml @@ -0,0 +1,26 @@ +[package] +name = "meshport-easytier" +version.workspace = true +edition.workspace = true +rust-version.workspace = true + +[dependencies] +easytier.workspace = true +easytier-core.workspace = true +anyhow.workspace = true +toml.workspace = true +serde_json.workspace = true +tokio.workspace = true + +serde.workspace = true +cidr = "0.3" +network-interface = "2.0.5" +async-trait = "0.1" + +[features] +default = [] +system-vpn = ["easytier/tun", "easytier/proxy-cidr-monitor"] + + +[dev-dependencies] +easytier = { workspace = true, features = ["smoltcp", "proxy-packet"] } diff --git a/crates/meshport-easytier/examples/android_test_server.rs b/crates/meshport-easytier/examples/android_test_server.rs new file mode 100644 index 0000000..c223c9f --- /dev/null +++ b/crates/meshport-easytier/examples/android_test_server.rs @@ -0,0 +1,62 @@ +//! Isolated USB/adb-reverse fixture, not a production relay or user network. +use easytier::instance::factory::create_native_instance; +use easytier_core::config::toml::{ConfigLoader, TomlConfig}; +use easytier_core::instance::CoreInstanceConfig; +use tokio::{ + io::{AsyncReadExt, AsyncWriteExt}, + net::{TcpListener, UdpSocket}, +}; + +#[tokio::main] +async fn main() -> anyhow::Result<()> { + let config = TomlConfig::new_from_str( + "ipv4 = '10.253.83.2/24'\nlisteners = ['tcp://127.0.0.1:18080']\nstun_servers = []\nstun_servers_v6 = []\n[[proxy_network]]\ncidr = '127.0.0.0/24'\nmapped_cidr = '10.253.79.0/24'\n[network_identity]\nnetwork_name = 'android-validation'\nnetwork_secret = 'test-only'\n[flags]\nno_tun = true\nuse_smoltcp = true", + )?; + let server = create_native_instance(config.clone())?; + server.start().await?; + let tcp = TcpListener::bind("127.0.0.1:17007").await?; + let udp = UdpSocket::bind("127.0.0.1:17007").await?; + let control = TcpListener::bind("127.0.0.1:18081").await?; + tokio::spawn(async move { + while let Ok((mut stream, _)) = tcp.accept().await { + tokio::spawn(async move { + let mut buffer = [0; 4096]; + while let Ok(n) = stream.read(&mut buffer).await { + if n == 0 || stream.write_all(&buffer[..n]).await.is_err() { + break; + } + } + }); + } + }); + tokio::spawn(async move { + let mut buffer = [0; 4096]; + while let Ok((n, peer)) = udp.recv_from(&mut buffer).await { + let _ = udp.send_to(&buffer[..n], peer).await; + } + }); + let gateway = server.clone(); + tokio::spawn(async move { + while let Ok((mut stream, _)) = control.accept().await { + let mut buffer = [0; 32]; + if stream.read(&mut buffer).await.is_ok() { + config.clear_proxy_cidrs(); + let updated = CoreInstanceConfig::from_toml(&config).unwrap(); + gateway + .update_runtime_config( + easytier_core::config::runtime::CoreInstanceRuntimeConfig { + services: updated.connectivity.runtime, + peer: std::sync::Arc::new(updated.peer.snapshot), + }, + ) + .await + .unwrap(); + let _ = stream.write_all(b"withdrawn\n").await; + } + } + }); + println!("Android validation fixture ready on localhost:18080; echo subnet 10.253.79.0/24"); + tokio::signal::ctrl_c().await?; + server.stop().await; + Ok(()) +} diff --git a/crates/meshport-easytier/src/android.rs b/crates/meshport-easytier/src/android.rs new file mode 100644 index 0000000..5885973 --- /dev/null +++ b/crates/meshport-easytier/src/android.rs @@ -0,0 +1,23 @@ +use easytier::socket_protector::{NativeSocketProtector, set_native_socket_protector}; +use std::{io, sync::Arc}; + +pub type ProtectSocket = extern "C" fn(i32) -> bool; +struct AndroidProtector(ProtectSocket); +#[async_trait::async_trait] +impl NativeSocketProtector for AndroidProtector { + async fn protect(&self, socket_handle: u64) -> io::Result<()> { + let fd = i32::try_from(socket_handle) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid socket fd"))?; + if (self.0)(fd) { + Ok(()) + } else { + Err(io::Error::new( + io::ErrorKind::PermissionDenied, + "Android VPN socket protection failed", + )) + } + } +} +pub fn install_socket_protector(callback: ProtectSocket) { + set_native_socket_protector(Some(Arc::new(AndroidProtector(callback)))); +} diff --git a/crates/meshport-easytier/src/lib.rs b/crates/meshport-easytier/src/lib.rs new file mode 100644 index 0000000..88c3a5c --- /dev/null +++ b/crates/meshport-easytier/src/lib.rs @@ -0,0 +1,846 @@ +//! Pinned EasyTier adapter with strict application and opt-in macOS system VPN modes. +use anyhow::{Context, Result, bail}; +use easytier::common::global_ctx::{EventBusSubscriber, GlobalCtxEvent}; +use easytier::instance::factory::{ + NativeCoreInstance, create_native_instance, subscribe_native_instance_event, +}; +pub use easytier_core::config::toml::ConfigLoader; +use easytier_core::config::toml::TomlConfig; +use std::{ + collections::HashMap, + sync::{Arc, Mutex}, + time::Instant, +}; + +pub use easytier_core::peers::meshport_optimization::{Mode, OptimizationPolicy}; + +#[cfg(target_os = "android")] +pub mod android; +mod system_routes; + +pub const REVISION: &str = "7af7bdc16a41d64d58743d15023a63b3eed2102c"; + +/// Strict mode-aware allowlist. Unknown options fail rather than disappear. +pub fn parse_config(input: &str) -> Result { + if input.len() > 65536 { + bail!("configuration exceeds 64 KiB"); + } + let value: toml::Value = + toml::from_str(input).map_err(|_| anyhow::anyhow!("invalid TOML configuration"))?; + let table = value + .as_table() + .context("configuration must be a TOML table")?; + let allowed = [ + "runtime", + "optimization", + "hostname", + "instance_name", + "ipv4", + "dhcp", + "network_identity", + "peer", + "listeners", + "mapped_listeners", + "flags", + "stun_servers", + "stun_servers_v6", + ]; + let system_vpn = runtime_mode(&value)? == RuntimeMode::SystemVpn; + for key in table.keys() { + if !allowed.contains(&key.as_str()) { + bail!("unsupported application-mode option: {key}"); + } + } + if let Some(flags) = table.get("flags") { + let flags = flags.as_table().context("flags must be a table")?; + let allowed = [ + "default_protocol", + "latency_first", + "enable_ipv6", + "disable_p2p", + "p2p_only", + "lazy_p2p", + "need_p2p", + "disable_tcp_hole_punching", + "disable_udp_hole_punching", + "disable_sym_hole_punching", + "private_mode", + "foreign_relay_bps_limit", + "no_tun", + "use_smoltcp", + "enable_encryption", + ]; + for key in flags.keys() { + if !allowed.contains(&key.as_str()) { + bail!("unsupported application-mode flag: {key}"); + } + } + if flags + .get("enable_encryption") + .is_some_and(|v| v.as_bool() != Some(true)) + { + bail!("enable_encryption must be true"); + } + } + if let Some(identity) = table.get("network_identity") { + let identity = identity + .as_table() + .context("network_identity must be a table")?; + for key in identity.keys() { + if !["network_name", "network_secret"].contains(&key.as_str()) { + bail!("unsupported identity field: {key}"); + } + } + } + if let Some(peers) = table.get("peer") { + for peer in peers + .as_array() + .context("peer must be an array of tables")? + { + let peer = peer.as_table().context("peer must be a table")?; + for key in peer.keys() { + if key != "uri" { + bail!("unsupported peer field: {key}"); + } + } + } + } + if let Some(flags) = table.get("flags").and_then(|v| v.as_table()) { + for key in ["no_tun", "use_smoltcp"] { + if flags + .get(key) + .is_some_and(|v| v.as_bool() != Some(!system_vpn)) + { + bail!("{key} contradicts runtime mode"); + } + } + } + // Upstream errors may contain input/credentials, so do not forward raw parser errors. + let optimization = optimization_config(input)?; + let mut upstream = value.clone(); + upstream.as_table_mut().unwrap().remove("optimization"); + upstream.as_table_mut().unwrap().remove("runtime"); + let config = TomlConfig::new_from_str( + &toml::to_string(&upstream).map_err(|_| anyhow::anyhow!("invalid configuration"))?, + ) + .map_err(|_| { + anyhow::anyhow!("invalid EasyTier configuration; check field types and addresses") + })?; + if config.get_ipv4().is_none() && !config.get_dhcp() { + bail!("ipv4 or dhcp = true is required"); + } + if config.get_ipv4().is_some() && config.get_dhcp() { + bail!("choose static ipv4 or dhcp, not both"); + } + if config.get_network_identity().network_name.trim().is_empty() { + bail!("network_name must not be empty"); + } + let mut flags = config.get_flags(); + if !["tcp", "udp"].contains(&flags.default_protocol.as_str()) { + bail!("this build supports only tcp and udp transports"); + } + for uri in config + .get_peers() + .iter() + .map(|p| &p.uri) + .chain(config.get_listener_uris().iter()) + { + if !["tcp", "udp"].contains(&uri.scheme()) { + bail!("unsupported transport: {}", uri.scheme()); + } + } + if table.contains_key("optimization") { + flags.latency_first = matches!(optimization.mode, Mode::Adaptive | Mode::Latency); + } + if system_vpn { + let ip = config + .get_ipv4() + .context("system_vpn requires a static private ipv4 in this stage")?; + if !(16..=30).contains(&ip.network_length()) + || !ip.address().is_private() + || ip.address() == ip.first_address() + || ip.address() == ip.last_address() + { + bail!("system_vpn requires a private IPv4 host with prefix /16 through /30"); + } + } + config.set_routes(None); + flags.no_tun = !system_vpn; + flags.use_smoltcp = !system_vpn; + flags.enable_encryption = true; + flags.accept_dns = false; + flags.enable_exit_node = false; + flags.proxy_forward_by_system = false; + flags.disable_upnp = true; + flags.relay_network_whitelist.clear(); + config.set_flags(flags); + if config.get_listeners().is_none() { + config.set_listeners(vec![]); + } + Ok(config) +} + +#[derive(Clone, Copy, Debug, PartialEq, serde::Serialize)] +#[serde(rename_all = "snake_case")] +pub enum RuntimeMode { + Application, + SystemVpn, +} +fn runtime_mode(value: &toml::Value) -> Result { + let Some(runtime) = value.get("runtime") else { + return Ok(RuntimeMode::Application); + }; + let table = runtime.as_table().context("runtime must be a table")?; + if table.keys().any(|k| !["mode"].contains(&k.as_str())) { + bail!("unsupported runtime setting"); + } + match table.get("mode").and_then(|v| v.as_str()) { + Some("application") => Ok(RuntimeMode::Application), + Some("system_vpn") => Ok(RuntimeMode::SystemVpn), + _ => bail!("runtime.mode must be application or system_vpn"), + } +} + +pub fn optimization_config(input: &str) -> Result { + let value: toml::Value = + toml::from_str(input).map_err(|_| anyhow::anyhow!("invalid TOML configuration"))?; + let policy: OptimizationPolicy = match value.get("optimization") { + Some(value) => value + .clone() + .try_into() + .map_err(|_| anyhow::anyhow!("invalid optimization settings"))?, + None => OptimizationPolicy { + mode: if value + .get("flags") + .and_then(|f| f.get("latency_first")) + .and_then(|v| v.as_bool()) + .unwrap_or(false) + { + Mode::Adaptive + } else { + Mode::Hop + }, + ..Default::default() + }, + }; + policy + .validate() + .map_err(|message| anyhow::anyhow!(message))?; + Ok(policy) +} + +// Upstream directly_connected_conns deliberately excludes hole-punched links. +// A default connection belongs to the local peer map; foreign logical peers have none. +fn has_direct_transport(peer: &easytier_core::peers::peer_manager::PeerSnapshot) -> bool { + peer.default_conn_id.is_some() + && peer.conns.iter().any(|conn| { + !conn.is_closed + && conn + .tunnel + .as_ref() + .is_some_and(|t| matches!(t.tunnel_type.as_str(), "tcp" | "udp")) + }) +} + +pub struct Engine { + pub instance: Arc, + pub config: TomlConfig, + pub mode: RuntimeMode, + interface_name: Mutex>, + optimization: OptimizationPolicy, + traffic: Mutex, + events: Mutex>, + journal: Mutex>, + event_sequence: Mutex, +} + +#[derive(Default)] +struct Traffic { + previous: HashMap, + sampled_at: Option, + rx_bytes: u64, + tx_bytes: u64, +} +impl Engine { + pub async fn start(input: &str) -> Result { + let config = parse_config(input)?; + let mode = if config.get_flags().no_tun { + RuntimeMode::Application + } else { + RuntimeMode::SystemVpn + }; + if mode == RuntimeMode::SystemVpn + && !(cfg!(feature = "system-vpn") + && cfg!(any(target_os = "macos", target_os = "android"))) + { + bail!("system_vpn requires a platform VPN build and platform authorization"); + } + let optimization = optimization_config(input)?; + let instance = create_native_instance(config.clone())?; + instance + .peer_manager() + .configure_optimization(optimization.clone()); + let policy_config = config.clone(); + instance + .packet_plane() + .set_proxy_route_filter(Arc::new(move |route| { + policy_config.get_ipv4().is_some_and(|overlay| { + system_routes::allowed(route, overlay.address(), overlay.network_length()) + }) + })); + let events = subscribe_native_instance_event(&instance); + if let Err(error) = instance.start().await { + instance.stop().await; + return Err(error); + } + Ok(Self { + instance, + config, + mode, + interface_name: Mutex::new(None), + optimization, + traffic: Mutex::new(Traffic::default()), + events: Mutex::new(events), + journal: Mutex::new(Vec::new()), + event_sequence: Mutex::new(0), + }) + } + pub fn redact_diagnostic(&self, text: &str) -> String { + let secret = self + .config + .get_network_identity() + .network_secret + .unwrap_or_default(); + if secret.is_empty() { + text.to_owned() + } else { + text.replace(&secret, "[redacted]") + } + } + #[cfg(target_os = "android")] + pub fn attach_tun_fd(&self, fd: i32) -> Result<()> { + if self.mode != RuntimeMode::SystemVpn || fd < 0 { + bail!("TUN attachment requires system VPN mode and a valid fd"); + } + *self.interface_name.lock().unwrap() = None; + self.instance.attach_tun_fd(fd) + } + pub async fn stop(&self) { + self.instance.stop().await; + *self.interface_name.lock().unwrap() = None; + } + pub async fn snapshot(&self) -> serde_json::Value { + if let Some(receiver) = self.events.lock().unwrap().as_mut() { + loop { + let message = match receiver.try_recv() { + Ok(event) => match event { + GlobalCtxEvent::TunDeviceReady(name) => { + *self.interface_name.lock().unwrap() = Some(name.clone()); + Some(format!("虚拟网卡就绪 {name}")) + } + GlobalCtxEvent::TunDeviceError(_) => { + *self.interface_name.lock().unwrap() = None; + Some("虚拟网卡创建失败".to_owned()) + } + GlobalCtxEvent::PeerAdded(id) => Some(format!("节点加入 {id}")), + GlobalCtxEvent::PeerRemoved(id) => Some(format!("节点离开 {id}")), + GlobalCtxEvent::PeerConnAdded(info) => Some(format!( + "连接建立 节点 {} 协议 {}", + info.peer_id, + info.tunnel + .as_ref() + .map(|t| t.tunnel_type.as_str()) + .unwrap_or("unknown") + )), + GlobalCtxEvent::PeerConnRemoved(info) => { + Some(format!("连接断开 节点 {}", info.peer_id)) + } + GlobalCtxEvent::ListenerAdded(url) => Some(format!( + "监听建立 {}://{}:{}", + url.scheme(), + url.host_str().unwrap_or(""), + url.port().unwrap_or(0) + )), + GlobalCtxEvent::ListenerAddFailed(_, error) => { + Some(format!("监听失败 {error}")) + } + GlobalCtxEvent::ListenerAcceptFailed(_, error) => { + Some(format!("接收连接失败 {error}")) + } + GlobalCtxEvent::ConnectError(_, family, error) => { + Some(format!("连接失败 {family} {error}")) + } + GlobalCtxEvent::ConnectionError(_, _, error) => { + Some(format!("连接错误 {error}")) + } + _ => None, + }, + Err(tokio::sync::broadcast::error::TryRecvError::Lagged(count)) => { + Some(format!("原生事件溢出,丢失 {count} 条")) + } + Err(_) => break, + }; + if let Some(mut message) = message { + let secret = self + .config + .get_network_identity() + .network_secret + .unwrap_or_default(); + if !secret.is_empty() { + message = message.replace(&secret, "[redacted]"); + } + let mut sequence = self.event_sequence.lock().unwrap(); + *sequence += 1; + let mut journal = self.journal.lock().unwrap(); + journal.push(serde_json::json!({"sequence": *sequence, "message": message.chars().take(1000).collect::()})); + if journal.len() > 100 { + journal.remove(0); + } + } + } + } + let node = self.instance.node_snapshot().await; + let peers = self.instance.peer_manager().list_peer_snapshots().await; + let routes = self.instance.peer_manager().list_route_snapshots().await; + let mut effective_hops = HashMap::new(); + for route in &routes { + effective_hops.insert( + route.peer_id, + self.instance + .peer_manager() + .effective_next_hop(route.peer_id) + .await, + ); + } + let subnet_routes = self + .instance + .packet_plane() + .proxy_cidr_diff(&Default::default()) + .await + .map(|d| { + d.current + .into_iter() + .map(|r| r.to_string()) + .collect::>() + }) + .unwrap_or_default(); + let mut traffic = self.traffic.lock().unwrap(); + let now = Instant::now(); + let seconds = traffic + .sampled_at + .map(|t| now.duration_since(t).as_secs_f64()); + let mut current = HashMap::new(); + let mut total_rx_delta = 0u64; + let mut total_tx_delta = 0u64; + let peer_stats = peers.iter().map(|p| { + let mut rx = 0u64; + let mut tx = 0u64; + let mut rx_delta = 0u64; + let mut tx_delta = 0u64; + for conn in &p.conns { + if let Some(stats) = &conn.stats { + let key = format!("{}:{}", p.peer_id, conn.conn_id); + let previous = traffic.previous.get(&key).copied().unwrap_or((0, 0)); + rx += stats.rx_bytes; + tx += stats.tx_bytes; + rx_delta += stats.rx_bytes.saturating_sub(previous.0); + tx_delta += stats.tx_bytes.saturating_sub(previous.1); + current.insert(key, (stats.rx_bytes, stats.tx_bytes)); + } + } + total_rx_delta += rx_delta; + total_tx_delta += tx_delta; + let latency_us = p.conns.iter() + .filter(|c| p.default_conn_id.as_ref().is_some_and(|id| id.to_string() == c.conn_id)) + .filter_map(|c| c.stats.as_ref()).map(|s| s.latency_us).find(|v| *v > 0); + serde_json::json!({ + "peer_id": p.peer_id, "connections": p.conns.len(), + "direct": has_direct_transport(p), + "hole_punched": has_direct_transport(p) && p.conns.iter().any(|c| !c.is_closed && !p.directly_connected_conns.iter().any(|id| id.to_string() == c.conn_id)), + "selected_transport": p.conns.iter().find(|c| p.default_conn_id.as_ref().is_some_and(|id| id.to_string() == c.conn_id)).and_then(|c| c.tunnel.as_ref()).map(|t| &t.tunnel_type), + "transports": p.conns.iter().filter_map(|c| c.tunnel.as_ref().map(|t| t.tunnel_type.clone())).collect::>(), + "latency_ms": latency_us.map(|v| v as f64 / 1000.0), + "rx_bytes": rx, "tx_bytes": tx, + "rx_bytes_per_second": seconds.filter(|s| *s > 0.0).map(|s| rx_delta as f64 / s), + "tx_bytes_per_second": seconds.filter(|s| *s > 0.0).map(|s| tx_delta as f64 / s) + }) + }).collect::>(); + traffic.rx_bytes += total_rx_delta; + traffic.tx_bytes += total_tx_delta; + traffic.previous = current; + traffic.sampled_at = Some(now); + let flags = self.config.get_flags(); + let latency_first = flags.latency_first; + let interface_name = self.interface_name.lock().unwrap().clone(); + serde_json::json!({ + "state": format!("{:?}", self.instance.state()), + "ipv4": node.ipv4_addr.map(|ip| ip.to_string()), + "network_name": self.config.get_network_identity().network_name, + "local_peer": { + "peer_id": node.peer_id, "hostname": node.hostname, + "ipv4": node.ipv4_addr.map(|ip| ip.to_string()), + "state": format!("{:?}", self.instance.state()), + "version": node.version, + "udp_nat_type": format!("{:?}", easytier::proto::common::NatType::try_from(node.stun_info.udp_nat_type).unwrap_or_default()) + }, + "optimization": self.optimization, + "optimization_basis": "link_rtt_and_route_estimate", + "peer_count": peers.len(), "peers": peer_stats, + "instance_id": node.instance_id.to_string(), + "native_events": self.journal.lock().unwrap().clone(), + "connectivity": { + "udp_nat_type": format!("{:?}", easytier::proto::common::NatType::try_from(node.stun_info.udp_nat_type).unwrap_or_default()), + "tcp_nat_type": format!("{:?}", easytier::proto::common::NatType::try_from(node.stun_info.tcp_nat_type).unwrap_or_default()), + "stun_last_update": node.stun_info.last_update_time, + "listeners": node.listeners.iter().filter(|v| matches!(v.scheme(), "tcp" | "udp")).map(|v| v.to_string()).collect::>(), + "stun_servers": self.config.get_stun_servers(), + "stun_servers_v6": self.config.get_stun_servers_v6(), + "disable_p2p": flags.disable_p2p, + "disable_udp_hole_punching": flags.disable_udp_hole_punching, + "disable_tcp_hole_punching": flags.disable_tcp_hole_punching, + "disable_sym_hole_punching": flags.disable_sym_hole_punching, + "lazy_p2p": flags.lazy_p2p, "need_p2p": flags.need_p2p, + "upnp_enabled": false, + "bind_device": flags.bind_device, + "interface_ipv4s": node.ip_list.interface_ipv4s.iter().map(|ip| std::net::Ipv4Addr::from(*ip).to_string()).collect::>(), + "interface_ipv6s": node.ip_list.interface_ipv6s.iter().map(|ip| std::net::Ipv6Addr::from(*ip).to_string()).collect::>(), + "tcp_hole_punch_compiled": true, + "latency_first": latency_first + }, + "traffic": { + "rx_bytes": traffic.rx_bytes, "tx_bytes": traffic.tx_bytes, + "rx_bytes_per_second": seconds.filter(|s| *s > 0.0).map(|s| total_rx_delta as f64 / s), + "tx_bytes_per_second": seconds.filter(|s| *s > 0.0).map(|s| total_tx_delta as f64 / s), + "scope": "tunnel_including_control" + }, + "routes": routes.iter().map(|r| { + let path_latency = if latency_first {r.path_latency_latency_first.unwrap_or(r.path_latency)} else {r.path_latency}; + serde_json::json!({"peer_id": r.peer_id, "hostname": r.hostname, + "ipv4": r.ipv4_addr.as_ref().map(|v| v.to_string()), + "advertised_subnets": r.proxy_cidrs, + "cost": effective_hops.get(&r.peer_id).copied().flatten().map(|hop| if hop == r.peer_id {1} else if latency_first {r.cost_latency_first.unwrap_or(r.cost)} else {r.cost}), + "version": r.version, + "udp_nat_type": r.stun_info.as_ref().map(|s| format!("{:?}", easytier::proto::common::NatType::try_from(s.udp_nat_type).unwrap_or_default())), + "disable_p2p": r.feature_flag.as_ref().map(|f| f.disable_p2p), + "need_p2p": r.feature_flag.as_ref().map(|f| f.need_p2p), + "next_hop_peer_id": effective_hops.get(&r.peer_id).copied().flatten(), + "candidate_next_hop_peer_id": if latency_first { r.next_hop_peer_id_latency_first.unwrap_or(r.next_hop_peer_id) } else { r.next_hop_peer_id }, + "estimated_latency_ms": if path_latency > 0 {Some(path_latency)} else {None} + }) + }).collect::>(), + "application_only": self.mode == RuntimeMode::Application, + "runtime_mode": self.mode, + "platform_network": { + "interface_name": interface_name, + "ready": interface_name.is_some(), + "route_scope": if !subnet_routes.is_empty() { "overlay_and_remote_subnets" } else { "overlay_only" }, + "subnet_route_mode": "automatic", + "route_installation": if self.mode == RuntimeMode::SystemVpn { "system" } else { "sdk_only" }, + "subnet_routes": subnet_routes, "subnet_routes_scope": "accepted_projection", "dns_changed": false, "default_route_changed": false + }, "upstream_revision": REVISION + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + // Run explicitly on a Mac with another TUN VPN already active. Uses an + // isolated network identity and never changes the host routing table. + #[cfg(target_os = "macos")] + #[tokio::test(flavor = "multi_thread", worker_threads = 4)] + #[ignore = "requires an active physical macOS network interface"] + async fn physical_bootstrap_with_existing_tun() { + use network_interface::{NetworkInterface, NetworkInterfaceConfig}; + let interfaces = NetworkInterface::show().unwrap(); + let physical = interfaces.iter().find(|iface| { + iface.name.starts_with("en") && iface.addr.iter().any(|addr| { + matches!(addr.ip(), std::net::IpAddr::V4(ip) if !ip.is_link_local() && !ip.is_loopback()) + }) + }).expect("active physical interface"); + let ip = physical + .addr + .iter() + .find_map(|addr| match addr.ip() { + std::net::IpAddr::V4(ip) if !ip.is_link_local() && !ip.is_loopback() => Some(ip), + _ => None, + }) + .unwrap(); + let listener = std::net::TcpListener::bind((ip, 0)).unwrap(); + let port = listener.local_addr().unwrap().port(); + drop(listener); + let shared = "[network_identity]\nnetwork_name = 'physical-bootstrap-test'\nnetwork_secret = 'test-only'\n"; + let server = Engine::start(&format!( + "stun_servers = []\nstun_servers_v6 = []\nipv4 = '10.253.83.2'\nlisteners = ['tcp://{ip}:{port}']\n{shared}" + )) + .await + .unwrap(); + let client = Engine::start(&format!( + "stun_servers = []\nstun_servers_v6 = []\nipv4 = '10.253.83.11'\nlisteners = []\n[[peer]]\nuri = 'tcp://{ip}:{port}'\n{shared}" + )) + .await + .unwrap(); + let result = tokio::time::timeout(std::time::Duration::from_secs(15), async { + loop { + let snapshot = client.snapshot().await; + if snapshot["peer_count"].as_u64().unwrap_or_default() > 0 { + assert_eq!(snapshot["connectivity"]["bind_device"], true); + let candidates = snapshot["connectivity"]["interface_ipv4s"] + .as_array() + .unwrap(); + assert!(candidates.iter().any(|value| value == &ip.to_string())); + for iface in interfaces + .iter() + .filter(|iface| iface.name.starts_with("utun")) + { + for addr in &iface.addr { + assert!( + !candidates + .iter() + .any(|value| value == &addr.ip().to_string()), + "TUN leaked into physical candidates" + ); + } + } + break; + } + tokio::time::sleep(std::time::Duration::from_millis(100)).await; + } + }) + .await; + client.stop().await; + server.stop().await; + result.expect("physical-interface bootstrap timed out"); + } + #[test] + fn hole_punched_udp_is_direct_but_foreign_or_closed_connections_are_not() { + let mut peer = easytier_core::peers::peer_manager::PeerSnapshot { + peer_id: 3157594741, + default_conn_id: Some("8c653a79-f814-4f92-9030-b86c93e1017d".parse().unwrap()), + directly_connected_conns: vec![], + conns: vec![Default::default()], + }; + peer.conns[0].tunnel.get_or_insert_default().tunnel_type = "udp".into(); + assert!( + has_direct_transport(&peer), + "UDP punch is a physical direct link" + ); + peer.conns[0].is_closed = true; + assert!(!has_direct_transport(&peer)); + peer.conns[0].is_closed = false; + peer.default_conn_id = None; + assert!( + !has_direct_transport(&peer), + "foreign logical connections are not direct" + ); + } + #[test] + fn optimization_configuration_is_strict_and_controls_effective_flags() { + let input = format!( + "{BASE}\n[optimization]\nmode = 'adaptive'\nmin_improvement_ms = 20\nrelay_peer_ids = [10,20]" + ); + assert!(parse_config(&input).unwrap().get_flags().latency_first); + assert_eq!( + optimization_config(&input).unwrap().relay_peer_ids, + vec![10, 20] + ); + assert!(parse_config(&format!("{BASE}\n[optimization]\ntypo = true")).is_err()); + } + #[tokio::test(flavor = "multi_thread", worker_threads = 4)] + async fn udp_preference_and_tcp_backup_use_real_connections() { + let tcp = std::net::TcpListener::bind("127.0.0.1:0").unwrap(); + let port = tcp.local_addr().unwrap().port(); + let udp = std::net::UdpSocket::bind(("127.0.0.1", port)).unwrap(); + drop(tcp); + drop(udp); + let shared = "[network_identity]\nnetwork_name = 'transport-test'\nnetwork_secret = 'test-only'\n[optimization]\nmode = 'adaptive'\nprefer_udp = true\n"; + let server = Engine::start(&format!("stun_servers = []\nstun_servers_v6 = []\nipv4 = '10.81.0.2'\nlisteners = ['tcp://127.0.0.1:{port}', 'udp://127.0.0.1:{port}']\n{shared}")).await.unwrap(); + let client = Engine::start(&format!("stun_servers = []\nstun_servers_v6 = []\nipv4 = '10.81.0.11'\nlisteners = []\n[[peer]]\nuri = 'tcp://127.0.0.1:{port}'\n[[peer]]\nuri = 'udp://127.0.0.1:{port}'\n{shared}")).await.unwrap(); + let started = Instant::now(); + loop { + let snapshot = client.snapshot().await; + if snapshot["peers"].as_array().is_some_and(|p| { + p.iter().any(|v| { + v["transports"].as_array().is_some_and(|t| t.len() >= 2) + && v["selected_transport"] == "udp" + }) + }) { + break; + } + assert!(started.elapsed().as_secs() < 15, "UDP selection timed out"); + tokio::time::sleep(std::time::Duration::from_millis(100)).await; + } + let peers = client.instance.peer_manager().list_peer_snapshots().await; + let peer = &peers[0]; + let conn = peer + .conns + .iter() + .find(|c| c.tunnel.as_ref().is_some_and(|t| t.tunnel_type == "udp")) + .unwrap(); + client + .instance + .peer_manager() + .close_peer_conn(peer.peer_id, &conn.conn_id.parse().unwrap()) + .await + .unwrap(); + let started = Instant::now(); + loop { + if client.snapshot().await["peers"][0]["selected_transport"] == "tcp" { + break; + } + assert!(started.elapsed().as_secs() < 5, "TCP backup timed out"); + tokio::time::sleep(std::time::Duration::from_millis(50)).await; + } + client.stop().await; + server.stop().await; + } + #[tokio::test] + async fn application_learns_filters_and_withdraws_advertised_subnets() { + use std::time::Duration; + use tokio::io::{AsyncReadExt, AsyncWriteExt}; + let port = std::net::UdpSocket::bind("127.0.0.1:0") + .unwrap() + .local_addr() + .unwrap() + .port(); + let identity = "[network_identity]\nnetwork_name = 'auto-subnets-test'\nnetwork_secret = 'test-only'\n"; + let server_config = TomlConfig::new_from_str(&format!("ipv4 = '10.253.81.2/24'\nstun_servers = []\nstun_servers_v6 = []\nlisteners = ['udp://127.0.0.1:{port}']\n[[proxy_network]]\ncidr = '127.0.0.0/24'\nmapped_cidr = '10.253.79.0/24'\n{identity}[flags]\nno_tun = true\nuse_smoltcp = true")).unwrap(); + let server = create_native_instance(server_config.clone()).unwrap(); + server.start().await.unwrap(); + let client = Engine::start(&format!("ipv4 = '10.253.80.11/24'\nlisteners = []\nstun_servers = []\nstun_servers_v6 = []\n[[peer]]\nuri = 'udp://127.0.0.1:{port}'\n{identity}")).await.unwrap(); + let result = tokio::time::timeout(Duration::from_secs(20), async { + loop { + let snapshot = client.snapshot().await; + let routes = snapshot["platform_network"]["subnet_routes"] + .as_array() + .unwrap(); + if routes.iter().any(|r| r == "10.253.79.0/24") { + assert_eq!(routes.len(), 1, "unfiltered advertisements: {routes:?}"); + assert_eq!(snapshot["platform_network"]["ready"], false); + break; + } + tokio::time::sleep(Duration::from_millis(100)).await; + } + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let tcp_port = listener.local_addr().unwrap().port(); + let echo = tokio::spawn(async move { + let (mut stream, _) = listener.accept().await.unwrap(); + let mut bytes = [0; 4]; + stream.read_exact(&mut bytes).await.unwrap(); + stream.write_all(&bytes).await.unwrap(); + let _ = stream.read(&mut bytes).await; + }); + let mut tcp = client + .instance + .data_plane_tcp_connect( + format!("10.253.79.1:{tcp_port}").parse().unwrap(), + Duration::from_secs(3), + ) + .await + .unwrap(); + tcp.write_all(b"auto").await.unwrap(); + let mut bytes = [0; 4]; + tcp.read_exact(&mut bytes).await.unwrap(); + assert_eq!(&bytes, b"auto"); + drop(tcp); + echo.abort(); + let _ = echo.await; + let receiver = tokio::net::UdpSocket::bind("127.0.0.1:0").await.unwrap(); + let udp_port = receiver.local_addr().unwrap().port(); + let sender = client + .instance + .data_plane_udp_bind(7009, Duration::from_secs(3)) + .await + .unwrap(); + sender + .send_to( + b"udp-auto", + format!("10.253.79.1:{udp_port}").parse().unwrap(), + ) + .await + .unwrap(); + let mut bytes = [0; 32]; + let (n, source) = receiver.recv_from(&mut bytes).await.unwrap(); + assert_eq!(&bytes[..n], b"udp-auto"); + receiver.send_to(&bytes[..n], source).await.unwrap(); + loop { + let (n, _) = sender.recv_from(&mut bytes).await.unwrap(); + if &bytes[..n] == b"warm" { + continue; + } + assert_eq!(&bytes[..n], b"udp-auto"); + break; + } + server_config.clear_proxy_cidrs(); + let config = + easytier_core::instance::CoreInstanceConfig::from_toml(&server_config).unwrap(); + server + .update_runtime_config(easytier_core::config::runtime::CoreInstanceRuntimeConfig { + services: config.connectivity.runtime, + peer: Arc::new(config.peer.snapshot), + }) + .await + .unwrap(); + while !client.snapshot().await["platform_network"]["subnet_routes"] + .as_array() + .unwrap() + .is_empty() + { + tokio::time::sleep(Duration::from_millis(100)).await; + } + }) + .await; + client.stop().await; + server.stop().await; + assert!(result.is_ok(), "automatic subnet test timed out"); + } + + const BASE: &str = "ipv4 = '10.77.0.11'\n[network_identity]\nnetwork_name = 'test'\nnetwork_secret = 'never-log-me'\n"; + #[test] + fn system_mode_learns_routes_automatically() { + let input = format!("{BASE}\n[runtime]\nmode = 'system_vpn'"); + let config = parse_config(&input).unwrap(); + assert!(!config.get_flags().no_tun && !config.get_flags().use_smoltcp); + assert_eq!(config.get_routes(), None); + assert!(parse_config(&format!("{input}\nsubnet_routes = ['192.168.21.0/24']")).is_err()); + assert!(!config.get_flags().accept_dns && !config.get_flags().enable_exit_node); + assert!(parse_config(&format!("{input}\n[flags]\nno_tun = true")).is_err()); + assert!(parse_config(&input.replace("10.77.0.11", "8.8.8.8")).is_err()); + assert!(parse_config(&input.replace("10.77.0.11", "10.77.0.11/8")).is_err()); + assert!(parse_config(&input.replace("10.77.0.11", "10.77.0.0/24")).is_err()); + assert!(parse_config(&input.replace("ipv4 = '10.77.0.11'", "dhcp = true")).is_err()); + assert!(parse_config(&format!("{input}\nroutes = ['0.0.0.0/0']")).is_err()); + assert!(parse_config(&format!("{BASE}\n[runtime]\nmode = 'typo'")).is_err()); + } + #[test] + fn application_invariants() { + let c = parse_config(BASE).unwrap(); + let f = c.get_flags(); + assert!(f.no_tun && f.use_smoltcp && f.disable_upnp && f.enable_encryption); + assert!(!f.accept_dns && !f.proxy_forward_by_system && !f.enable_exit_node); + } + #[test] + fn reject_system_and_unknown_options() { + for field in ["exit_nodes = []", "proxy_network = []", "typo = true"] { + assert!(parse_config(&format!("{field}\n{BASE}")).is_err()); + } + assert!(parse_config(&format!("{BASE}\n[flags]\nno_tun = false")).is_err()); + assert!(parse_config(&format!("{BASE}\n[flags]\naccept_dns = true")).is_err()); + } + #[test] + fn secrets_do_not_leak_in_parse_errors() { + let input = "ipv4 = 'secret-address'\n[network_identity]\nnetwork_secret = 'never-log-me'"; + assert!( + !parse_config(input) + .err() + .unwrap() + .to_string() + .contains("never-log-me") + ); + } +} + +#[cfg(test)] +#[allow(dead_code)] +#[path = "../../../vendor/easytier/easytier-core/src/peers/meshport_optimization.rs"] +mod routing_policy_tests; diff --git a/crates/meshport-easytier/src/system_routes.rs b/crates/meshport-easytier/src/system_routes.rs new file mode 100644 index 0000000..2979743 --- /dev/null +++ b/crates/meshport-easytier/src/system_routes.rs @@ -0,0 +1,100 @@ +use cidr::Ipv4Cidr; +use std::net::Ipv4Addr; + +fn overlaps(base: Ipv4Addr, prefix: u8, other: Ipv4Addr, other_mask: u32) -> bool { + let mask = u32::MAX.checked_shl(32 - u32::from(prefix)).unwrap_or(0) & other_mask; + u32::from(base) & mask == u32::from(other) & mask +} + +fn permitted(route: &Ipv4Cidr, overlay: Ipv4Addr, prefix: u8) -> bool { + (16..=32).contains(&route.network_length()) + && route.first_address().is_private() + && !overlaps( + route.first_address(), + route.network_length(), + overlay, + u32::MAX.checked_shl(32 - u32::from(prefix)).unwrap_or(0), + ) +} + +pub fn allowed(route: &Ipv4Cidr, overlay: Ipv4Addr, prefix: u8) -> bool { + if !permitted(route, overlay, prefix) { + return false; + } + local_interfaces_allow(route) +} + +type InterfaceNetworks = Vec<(Ipv4Addr, u32)>; +type InterfaceCache = Option<(std::time::Instant, Option)>; +fn local_interfaces_allow(route: &Ipv4Cidr) -> bool { + use network_interface::{Addr, NetworkInterface, NetworkInterfaceConfig}; + use std::sync::{Mutex, OnceLock}; + static CACHE: OnceLock> = OnceLock::new(); + let mut cache = CACHE.get_or_init(|| Mutex::new(None)).lock().unwrap(); + if cache + .as_ref() + .is_none_or(|(time, _)| time.elapsed().as_secs() >= 2) + { + let networks = NetworkInterface::show().ok().map(|interfaces| { + interfaces + .into_iter() + .flat_map(|iface| iface.addr) + .filter_map(|addr| match addr { + Addr::V4(v4) => Some((v4.ip, u32::from(v4.netmask?))), + _ => None, + }) + .collect() + }); + *cache = Some((std::time::Instant::now(), networks)); + } + cache + .as_ref() + .and_then(|(_, networks)| networks.as_ref()) + .is_some_and(|networks| { + networks.iter().all(|(ip, mask)| { + !overlaps(route.first_address(), route.network_length(), *ip, *mask) + }) + }) +} + +#[cfg(test)] +mod tests { + use super::*; + #[test] + fn rejects_defaults_public_broad_and_overlay_routes() { + let overlay = "192.168.20.4".parse().unwrap(); + for text in [ + "0.0.0.0/0", + "8.8.8.0/24", + "10.0.0.0/8", + "192.168.20.0/24", + "192.168.0.0/16", + ] { + assert!(!permitted(&text.parse().unwrap(), overlay, 24), "{text}"); + } + assert!(permitted(&"192.168.21.0/24".parse().unwrap(), overlay, 24)); + assert!(permitted(&"10.5.0.1/32".parse().unwrap(), overlay, 24)); + } + #[test] + fn detects_physical_subnet_overlap() { + let local = "10.10.8.54".parse().unwrap(); + assert!(overlaps( + "10.10.0.0".parse().unwrap(), + 16, + local, + 0xffffff00 + )); + assert!(overlaps( + "10.10.8.201".parse().unwrap(), + 32, + local, + 0xffffff00 + )); + assert!(!overlaps( + "192.168.21.0".parse().unwrap(), + 24, + local, + 0xffffff00 + )); + } +} diff --git a/crates/meshport-ffi/Cargo.toml b/crates/meshport-ffi/Cargo.toml new file mode 100644 index 0000000..bdbfd53 --- /dev/null +++ b/crates/meshport-ffi/Cargo.toml @@ -0,0 +1,21 @@ +[package] +name = "meshport-ffi" +version.workspace = true +edition.workspace = true +rust-version.workspace = true + +[lib] +crate-type = ["cdylib", "staticlib", "rlib"] + +[dependencies] +meshport.workspace = true +meshport-easytier.workspace = true +anyhow.workspace = true +serde_json.workspace = true +tokio.workspace = true +tracing = "0.1" +tracing-subscriber = { version = "0.3", default-features = false, features = ["std", "fmt", "registry"] } + +[features] +default = [] +system-vpn = ["meshport/system-vpn"] diff --git a/crates/meshport-ffi/include/meshport.h b/crates/meshport-ffi/include/meshport.h new file mode 100644 index 0000000..1e640c1 --- /dev/null +++ b/crates/meshport-ffi/include/meshport.h @@ -0,0 +1,22 @@ +#ifndef MESHPORT_H +#define MESHPORT_H +#include +#include +#ifdef __cplusplus +extern "C" { +#endif +uint32_t meshport_abi_version(void); +uint64_t meshport_context_new(void); +void meshport_context_free(uint64_t context); +/* Blocking; run off the UI thread. Owned JSON result, free exactly once. */ +char *meshport_call(uint64_t context, const char *request_json); +void meshport_string_free(char *response); +#ifdef __ANDROID__ +/* Process-wide callback; keep valid until all native contexts have stopped. + * Invoked on native workers. Return VpnService.protect(fd)'s result. */ +void meshport_set_android_socket_protector(bool (*callback)(int fd)); +#endif +#ifdef __cplusplus +} +#endif +#endif diff --git a/crates/meshport-ffi/src/diagnostics.rs b/crates/meshport-ffi/src/diagnostics.rs new file mode 100644 index 0000000..b0b8d8c --- /dev/null +++ b/crates/meshport-ffi/src/diagnostics.rs @@ -0,0 +1,76 @@ +//! Optional, process-wide capture for the lab. SDK hosts retain their subscriber. +use serde_json::{Value, json}; +use std::{ + collections::VecDeque, + io::{self, Write}, + sync::{LazyLock, Mutex}, +}; +use tracing_subscriber::{Layer, layer::SubscriberExt, util::SubscriberInitExt}; + +static RECORDS: LazyLock)>> = + LazyLock::new(|| Mutex::new((0, VecDeque::new()))); +static ENABLED: LazyLock = LazyLock::new(|| { + let layer = tracing_subscriber::fmt::layer() + .with_ansi(false) + .with_writer(|| Capture(Vec::new())) + .with_filter(tracing_subscriber::filter::filter_fn(|metadata| { + metadata + .target() + .starts_with("easytier_core::connectivity::hole_punch") + && *metadata.level() <= tracing::Level::DEBUG + })); + tracing_subscriber::registry() + .with(layer) + .try_init() + .is_ok() +}); + +pub fn enable() -> bool { + *ENABLED +} +pub fn snapshot() -> Vec { + RECORDS.lock().unwrap().1.iter().cloned().collect() +} +struct Capture(Vec); +impl Write for Capture { + fn write(&mut self, bytes: &[u8]) -> io::Result { + let remaining = 4096usize.saturating_sub(self.0.len()); + self.0 + .extend_from_slice(&bytes[..bytes.len().min(remaining)]); + Ok(bytes.len()) + } + fn flush(&mut self) -> io::Result<()> { + Ok(()) + } +} +impl Drop for Capture { + fn drop(&mut self) { + if self.0.is_empty() { + return; + } + let mut records = RECORDS.lock().unwrap(); + records.0 += 1; + let sequence = records.0; + records.1.push_back( + json!({"sequence": sequence, "message": String::from_utf8_lossy(&self.0).trim()}), + ); + if records.1.len() > 200 { + records.1.pop_front(); + } + } +} + +#[cfg(test)] +mod tests { + #[test] + fn capture_is_opt_in_and_excludes_other_modules() { + assert!(super::enable()); + tracing::warn!(target: "unrelated_application", "private unrelated log"); + tracing::warn!(target: "easytier_core::connectivity::hole_punch::test", dst_peer_id = 42, "diagnostic capture check"); + let records = super::snapshot(); + let text = serde_json::to_string(&records).unwrap(); + assert!(text.contains("diagnostic capture check")); + assert!(text.contains("42")); + assert!(!text.contains("private unrelated log")); + } +} diff --git a/crates/meshport-ffi/src/lib.rs b/crates/meshport-ffi/src/lib.rs new file mode 100644 index 0000000..0e94a02 --- /dev/null +++ b/crates/meshport-ffi/src/lib.rs @@ -0,0 +1,404 @@ +//! ABI v1: opaque numeric contexts and owned UTF-8 JSON responses. +//! Blocking calls must execute on a foreign worker thread/isolate. +mod diagnostics; +use meshport::Network; +use serde_json::{Value, json}; +use std::{ + collections::HashMap, + ffi::{CStr, CString, c_char}, + panic::{AssertUnwindSafe, catch_unwind}, + sync::{ + Arc, LazyLock, Mutex, + atomic::{AtomicU64, Ordering}, + }, + time::Duration, +}; +use tokio::runtime::Runtime; +static NEXT: AtomicU64 = AtomicU64::new(1); +#[cfg(target_os = "android")] +#[unsafe(no_mangle)] +pub extern "C" fn meshport_set_android_socket_protector( + callback: meshport_easytier::android::ProtectSocket, +) { + meshport_easytier::android::install_socket_protector(callback); +} +static CONTEXTS: LazyLock>>> = + LazyLock::new(|| Mutex::new(HashMap::new())); +struct Context { + runtime: Runtime, + network: Mutex>, + tcp: tokio::sync::Mutex>, + udp: tokio::sync::Mutex>, +} +impl Drop for Context { + fn drop(&mut self) { + if let Ok(slot) = self.network.get_mut() + && let Some(n) = slot.take() + { + self.runtime.block_on(n.stop()); + } + } +} +#[unsafe(no_mangle)] +pub extern "C" fn meshport_abi_version() -> u32 { + 1 +} +#[unsafe(no_mangle)] +pub extern "C" fn meshport_context_new() -> u64 { + catch_unwind(|| { + let runtime = match tokio::runtime::Builder::new_multi_thread() + .worker_threads(2) + .enable_all() + .build() + { + Ok(v) => v, + Err(_) => return 0, + }; + let id = NEXT.fetch_add(1, Ordering::Relaxed); + CONTEXTS.lock().unwrap().insert( + id, + Arc::new(Context { + runtime, + network: Mutex::new(None), + tcp: tokio::sync::Mutex::new(HashMap::new()), + udp: tokio::sync::Mutex::new(HashMap::new()), + }), + ); + id + }) + .unwrap_or(0) +} +#[unsafe(no_mangle)] +pub extern "C" fn meshport_context_free(id: u64) { + // Drop outside registry lock; in-flight calls retain an Arc until completion. + let _ = catch_unwind(|| { + let context = CONTEXTS.lock().unwrap().remove(&id); + drop(context); + }); +} +fn dispatch(context: &Context, request: Value) -> anyhow::Result { + let op = request["op"] + .as_str() + .ok_or_else(|| anyhow::anyhow!("missing op"))?; + if op == "diagnostics_enable" { + return Ok(json!({"enabled": diagnostics::enable(), "scope": "process"})); + } + if op == "validate" { + use meshport_easytier::ConfigLoader; + let input = request["toml"] + .as_str() + .ok_or_else(|| anyhow::anyhow!("missing toml"))?; + let config = meshport::validate_config(input)?; + let flags = config.get_flags(); + let mut result = json!({"valid": true, "runtime_mode": if flags.no_tun {"application"} else {"system_vpn"}}); + // Only return credentials when the local caller explicitly requests a + // form projection. Ordinary validation remains free of credentials. + if request["include_profile"].as_bool() == Some(true) { + let identity = config.get_network_identity(); + let optimization = meshport_easytier::optimization_config(input)?; + result["profile"] = json!({ + "network_name": identity.network_name, + "network_secret": identity.network_secret.unwrap_or_default(), + "hostname": config.get_hostname(), + "ipv4": config.get_ipv4().map(|ip| ip.to_string()).unwrap_or_default(), + "dhcp": config.get_dhcp(), + "peers": config.get_peers().iter().map(|peer| peer.uri.to_string()).collect::>(), + "enable_ipv6": flags.enable_ipv6, + "latency_first": flags.latency_first, + "optimization": optimization + }); + } + return Ok(result); + } + let mut network = context + .network + .lock() + .map_err(|_| anyhow::anyhow!("context lock poisoned"))?; + match op { + #[cfg(target_os = "android")] + "attach_tun" => { + let fd = i32::try_from( + request["fd"] + .as_i64() + .ok_or_else(|| anyhow::anyhow!("missing fd"))?, + )?; + network + .as_ref() + .ok_or_else(|| anyhow::anyhow!("not started"))? + .attach_tun_fd(fd)?; + Ok(json!({"attached": true})) + } + "start" => { + anyhow::ensure!( + network.is_none(), + "already started; stop before applying a new configuration" + ); + let config = request["toml"] + .as_str() + .ok_or_else(|| anyhow::anyhow!("missing toml"))?; + *network = Some(context.runtime.block_on(Network::start(config))?); + Ok(json!({"engine_started": true})) + } + "stop" => { + context.tcp.blocking_lock().clear(); + context.udp.blocking_lock().clear(); + if let Some(n) = network.take() { + context.runtime.block_on(n.stop()); + } + Ok(json!({"stopped": true})) + } + "status" => match network.as_ref() { + Some(n) => { + let mut snapshot = context.runtime.block_on(n.snapshot()); + let traces = diagnostics::snapshot() + .into_iter() + .map(|mut trace| { + if let Some(message) = trace["message"].as_str() { + trace["message"] = json!(n.redact_diagnostic(message)); + } + trace + }) + .collect::>(); + snapshot["diagnostic_traces"] = json!(traces); + Ok(snapshot) + } + None => Ok(json!({"state": "Stopped", "peer_count": 0, "application_only": true})), + }, + "quality_sample" => { + let network = network + .as_ref() + .ok_or_else(|| anyhow::anyhow!("network is stopped"))?; + let id = request["resource"] + .as_u64() + .ok_or_else(|| anyhow::anyhow!("missing resource"))?; + let target = request["target"] + .as_str() + .ok_or_else(|| anyhow::anyhow!("missing target"))? + .parse::()?; + anyhow::ensure!(target.is_ipv4(), "IPv4 required"); + let sequence = request["sequence"] + .as_u64() + .ok_or_else(|| anyhow::anyhow!("missing sequence"))?; + let timeout = request["timeout_ms"].as_u64().unwrap_or(1000); + anyhow::ensure!( + (100..=5000).contains(&timeout), + "quality timeout must be 100-5000 ms" + ); + context.runtime.block_on(async { + let sockets = context.udp.lock().await; + let socket = sockets + .get(&id) + .ok_or_else(|| anyhow::anyhow!("invalid UDP resource"))?; + network + .sample_udp_quality(socket, target, sequence, Duration::from_millis(timeout)) + .await + }) + } + "tcp_connect" | "udp_bind" => { + let n = network + .as_ref() + .ok_or_else(|| anyhow::anyhow!("network is stopped"))?; + let id = NEXT.fetch_add(1, Ordering::Relaxed); + if op == "tcp_connect" { + let target = request["target"] + .as_str() + .ok_or_else(|| anyhow::anyhow!("missing target"))? + .parse()?; + let stream = context + .runtime + .block_on(n.connect_tcp(target, Duration::from_secs(5)))?; + context.tcp.blocking_lock().insert(id, stream); + } else { + let port = request["port"].as_u64().unwrap_or(0); + anyhow::ensure!(port <= 65535, "invalid UDP port"); + let socket = context + .runtime + .block_on(n.bind_udp(port as u16, Duration::from_secs(5)))?; + context.udp.blocking_lock().insert(id, socket); + } + Ok(json!({"resource": id})) + } + "resource_close" => { + let id = request["resource"] + .as_u64() + .ok_or_else(|| anyhow::anyhow!("missing resource"))?; + let tcp = context.tcp.blocking_lock().remove(&id).is_some(); + let udp = context.udp.blocking_lock().remove(&id).is_some(); + anyhow::ensure!(tcp || udp, "invalid resource"); + Ok(json!({"closed": true})) + } + "tcp_read" | "tcp_write" | "udp_send" | "udp_receive" => { + use tokio::io::{AsyncReadExt, AsyncWriteExt}; + anyhow::ensure!(network.is_some(), "network is stopped"); + let id = request["resource"] + .as_u64() + .ok_or_else(|| anyhow::anyhow!("missing resource"))?; + let timeout = request["timeout_ms"].as_u64().unwrap_or(5000); + anyhow::ensure!((1..=30000).contains(&timeout), "invalid timeout"); + let mut bytes = Vec::new(); + if op.ends_with("write") || op == "udp_send" { + let data = request["bytes"] + .as_array() + .ok_or_else(|| anyhow::anyhow!("missing bytes array"))?; + anyhow::ensure!(data.len() <= 65507, "payload too large"); + for b in data { + let b = b + .as_u64() + .filter(|b| *b <= 255) + .ok_or_else(|| anyhow::anyhow!("invalid byte"))?; + bytes.push(b as u8); + } + } + context.runtime.block_on(async { + tokio::time::timeout(Duration::from_millis(timeout), async { + if op.starts_with("tcp") { + let mut streams = context.tcp.lock().await; + let stream = streams + .get_mut(&id) + .ok_or_else(|| anyhow::anyhow!("invalid TCP resource"))?; + if op == "tcp_write" { + stream.write_all(&bytes).await?; + Ok(json!({"written": bytes.len()})) + } else { + let max = request["max_bytes"].as_u64().unwrap_or(16384); + anyhow::ensure!((1..=65535).contains(&max), "invalid read size"); + let mut buffer = vec![0; max as usize]; + let size = stream.read(&mut buffer).await?; + buffer.truncate(size); + Ok(json!({"bytes": buffer, "eof": size == 0})) + } + } else { + let sockets = context.udp.lock().await; + let socket = sockets + .get(&id) + .ok_or_else(|| anyhow::anyhow!("invalid UDP resource"))?; + if op == "udp_send" { + let addr = request["target"] + .as_str() + .ok_or_else(|| anyhow::anyhow!("missing target"))? + .parse()?; + let written = socket.send_to(&bytes, addr).await?; + Ok(json!({"written": written})) + } else { + let mut buffer = vec![0; 65535]; + let (size, source) = socket.recv_from(&mut buffer).await?; + buffer.truncate(size); + Ok(json!({"bytes": buffer, "source": source.to_string()})) + } + } + }) + .await + })? + } + "probe" => { + let n = network + .as_ref() + .ok_or_else(|| anyhow::anyhow!("network is stopped"))?; + let target = request["target"] + .as_str() + .ok_or_else(|| anyhow::anyhow!("missing target"))? + .parse()?; + let protocol = request["protocol"].as_str().unwrap_or("TCP"); + anyhow::ensure!( + ["TCP", "UDP"].contains(&protocol), + "protocol must be TCP or UDP" + ); + let timeout_ms = request["timeout_ms"].as_u64().unwrap_or(5000); + anyhow::ensure!( + (1..=30000).contains(&timeout_ms), + "timeout must be 1..30000 ms" + ); + context.runtime.block_on(n.probe( + target, + protocol == "UDP", + request["echo"].as_bool().unwrap_or(false), + Duration::from_millis(timeout_ms), + )) + } + _ => anyhow::bail!("unknown operation"), + } +} +/// # Safety +/// request must be a valid NUL-terminated UTF-8 C string for the duration of the call. +/// Return is owned by MeshPort; release exactly once with meshport_string_free. +#[unsafe(no_mangle)] +pub unsafe extern "C" fn meshport_call(id: u64, request: *const c_char) -> *mut c_char { + let response = catch_unwind(AssertUnwindSafe(|| -> anyhow::Result { + anyhow::ensure!(!request.is_null(), "request is null"); + let text = unsafe { CStr::from_ptr(request) }.to_str()?; + anyhow::ensure!(text.len() <= 131072, "request exceeds 128 KiB"); + let parsed: Value = + serde_json::from_str(text).map_err(|_| anyhow::anyhow!("invalid JSON request"))?; + let context = CONTEXTS + .lock() + .unwrap() + .get(&id) + .cloned() + .ok_or_else(|| anyhow::anyhow!("invalid context"))?; + dispatch(&context, parsed) + })); + let value = match response { + Ok(Ok(v)) => json!({"ok": true, "data": v}), + Ok(Err(e)) => json!({"ok": false, "error": e.to_string()}), + Err(_) => json!({"ok": false, "error": "internal panic"}), + }; + CString::new(value.to_string()).unwrap().into_raw() +} +/// # Safety +/// ptr must be null or an unfreed pointer returned by meshport_call. +#[unsafe(no_mangle)] +pub unsafe extern "C" fn meshport_string_free(ptr: *mut c_char) { + if !ptr.is_null() { + drop(unsafe { CString::from_raw(ptr) }); + } +} + +#[cfg(test)] +mod tests { + use super::*; + fn call(id: u64, s: &str) -> Value { + let q = CString::new(s).unwrap(); + unsafe { + let p = meshport_call(id, q.as_ptr()); + let result = serde_json::from_str(CStr::from_ptr(p).to_str().unwrap()).unwrap(); + meshport_string_free(p); + result + } + } + #[test] + fn abi_invalid_handle_and_lifecycle() { + let id = meshport_context_new(); + assert_ne!(id, 0); + assert_eq!(call(id, r#"{"op":"status"}"#)["data"]["state"], "Stopped"); + assert_eq!( + call(id, r#"{"op":"probe","target":"10.0.0.2:1234"}"#)["ok"], + false + ); + meshport_context_free(id); + meshport_context_free(id); + assert_eq!(call(id, r#"{"op":"status"}"#)["ok"], false); + } + #[test] + fn validation_only_projects_credentials_when_requested() { + let id = meshport_context_new(); + let config = "hostname = 'saved-node'\nipv4 = '10.79.0.11/24'\nlisteners = []\n[[peer]]\nuri = 'tcp://127.0.0.1:1234'\n[network_identity]\nnetwork_name = 'saved-network'\nnetwork_secret = 'test-only-secret'\n"; + let ordinary = call(id, &json!({"op": "validate", "toml": config}).to_string()); + assert_eq!(ordinary["ok"], true); + assert!(!ordinary.to_string().contains("test-only-secret")); + let projected = call( + id, + &json!({"op": "validate", "toml": config, "include_profile": true}).to_string(), + ); + assert_eq!(projected["ok"], true); + assert_eq!( + projected["data"]["profile"]["network_secret"], + "test-only-secret" + ); + assert_eq!(projected["data"]["profile"]["ipv4"], "10.79.0.11/24"); + assert_eq!( + projected["data"]["profile"]["peers"][0], + "tcp://127.0.0.1:1234" + ); + meshport_context_free(id); + } +} diff --git a/crates/meshport-netstack/Cargo.toml b/crates/meshport-netstack/Cargo.toml new file mode 100644 index 0000000..ec105a7 --- /dev/null +++ b/crates/meshport-netstack/Cargo.toml @@ -0,0 +1,10 @@ +[package] +name = "meshport-netstack" +version.workspace = true +edition.workspace = true +rust-version.workspace = true + +[dependencies] +easytier-core.workspace = true +anyhow.workspace = true +tokio.workspace = true diff --git a/crates/meshport-netstack/src/lib.rs b/crates/meshport-netstack/src/lib.rs new file mode 100644 index 0000000..6fddd59 --- /dev/null +++ b/crates/meshport-netstack/src/lib.rs @@ -0,0 +1,47 @@ +//! Reuse EasyTier's instance-scoped smoltcp plane rather than creating a second stack. +use anyhow::{Result, ensure}; +pub use easytier_core::gateway::{ + DataPlaneTcpListener as TcpListener, DataPlaneTcpStream as TcpStream, + DataPlaneUdpSocket as UdpSocket, +}; +use std::{net::SocketAddr, time::Duration}; +use tokio::io::{AsyncReadExt, AsyncWriteExt}; + +pub async fn tcp_echo( + stream: &mut TcpStream, + payload: &[u8], + timeout: Duration, +) -> Result> { + tokio::time::timeout(timeout, async { + stream.write_all(payload).await?; + let mut received = vec![0; payload.len()]; + stream.read_exact(&mut received).await?; + ensure!(received == payload, "TCP echo data mismatch"); + Ok(received) + }) + .await? +} +pub async fn udp_echo( + socket: &UdpSocket, + target: SocketAddr, + payload: &[u8], + timeout: Duration, +) -> Result> { + ensure!( + payload.len() <= 65507, + "UDP payload exceeds IPv4 datagram limit" + ); + tokio::time::timeout(timeout, async { + socket.send_to(payload, target).await?; + let mut buffer = vec![0; 65535]; + loop { + let (len, source) = socket.recv_from(&mut buffer).await?; + if source != target { + continue; + } + ensure!(&buffer[..len] == payload, "UDP echo data mismatch"); + return Ok(buffer[..len].to_vec()); + } + }) + .await? +} diff --git a/crates/meshport/Cargo.toml b/crates/meshport/Cargo.toml new file mode 100644 index 0000000..b48a731 --- /dev/null +++ b/crates/meshport/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "meshport" +version.workspace = true +edition.workspace = true +rust-version.workspace = true + +[dependencies] +meshport-easytier.workspace = true +meshport-netstack.workspace = true +anyhow.workspace = true +serde.workspace = true +serde_json.workspace = true +tokio.workspace = true + +[features] +default = [] +system-vpn = ["meshport-easytier/system-vpn"] diff --git a/crates/meshport/examples/tcp_client.rs b/crates/meshport/examples/tcp_client.rs new file mode 100644 index 0000000..00a0ca8 --- /dev/null +++ b/crates/meshport/examples/tcp_client.rs @@ -0,0 +1,25 @@ +use meshport::Network; +use std::{net::SocketAddr, time::Duration}; +use tokio::io::{AsyncReadExt, AsyncWriteExt}; +#[tokio::main] +async fn main() -> anyhow::Result<()> { + let args: Vec<_> = std::env::args().collect(); + anyhow::ensure!( + args.len() == 3, + "usage: tcp_client " + ); + let config = std::fs::read_to_string(&args[1])?; + let target: SocketAddr = args[2].parse()?; + let network = Network::start(&config).await?; + let result = async { + let mut stream = network.connect_tcp(target, Duration::from_secs(10)).await?; + stream.write_all(b"MeshPort TCP example").await?; + let mut buffer = [0; 256]; + let n = tokio::time::timeout(Duration::from_secs(5), stream.read(&mut buffer)).await??; + println!("Received {n} bytes: {:?}", &buffer[..n]); + Ok::<_, anyhow::Error>(()) + } + .await; + network.stop().await; + result +} diff --git a/crates/meshport/src/lib.rs b/crates/meshport/src/lib.rs new file mode 100644 index 0000000..7ae7c70 --- /dev/null +++ b/crates/meshport/src/lib.rs @@ -0,0 +1,104 @@ +//! EasyTier networking SDK: application sockets by default, opt-in macOS system VPN. +mod quality; +mod system_probe; +use anyhow::{Result, ensure}; +use meshport_easytier::Engine; +pub use meshport_easytier::parse_config as validate_config; +pub use meshport_netstack::{TcpListener, TcpStream, UdpSocket}; +use std::{ + net::SocketAddr, + time::{Duration, Instant}, +}; + +pub struct Network { + engine: Engine, +} +impl Network { + #[cfg(target_os = "android")] + pub fn attach_tun_fd(&self, fd: i32) -> Result<()> { + self.engine.attach_tun_fd(fd) + } + /// Running means the engine is started, not that a remote peer is reachable. + pub async fn start(toml: &str) -> Result { + Ok(Self { + engine: Engine::start(toml).await?, + }) + } + pub async fn stop(&self) { + self.engine.stop().await; + } + /// Removes this network's secret from diagnostic text before export. + pub fn redact_diagnostic(&self, text: &str) -> String { + self.engine.redact_diagnostic(text) + } + pub async fn snapshot(&self) -> serde_json::Value { + self.engine.snapshot().await + } + pub async fn connect_tcp(&self, target: SocketAddr, timeout: Duration) -> Result { + self.require_application_mode()?; + ensure!( + target.is_ipv4(), + "IPv6 data plane is not supported in this prototype" + ); + Ok(self + .engine + .instance + .data_plane_tcp_connect(target, timeout) + .await?) + } + pub async fn listen_tcp(&self, port: u16, timeout: Duration) -> Result { + self.require_application_mode()?; + Ok(self + .engine + .instance + .data_plane_tcp_bind(port, timeout) + .await?) + } + pub async fn bind_udp(&self, port: u16, timeout: Duration) -> Result { + self.require_application_mode()?; + Ok(self + .engine + .instance + .data_plane_udp_bind(port, timeout) + .await?) + } + fn require_application_mode(&self) -> Result<()> { + ensure!( + self.engine.mode == meshport_easytier::RuntimeMode::Application, + "use ordinary OS sockets in system_vpn mode" + ); + Ok(()) + } + pub async fn probe( + &self, + target: SocketAddr, + udp: bool, + echo: bool, + timeout: Duration, + ) -> Result { + if self.engine.mode == meshport_easytier::RuntimeMode::SystemVpn { + return system_probe::probe(target, udp, echo, timeout).await; + } + ensure!(!udp || echo, "UDP tests require a cooperating echo server"); + let started = Instant::now(); + let payload = b"MeshPort echo verification v1"; + let bytes = if udp { + let socket = self.bind_udp(0, timeout).await?; + meshport_netstack::udp_echo(&socket, target, payload, timeout) + .await? + .len() + } else { + let mut stream = self.connect_tcp(target, timeout).await?; + if echo { + meshport_netstack::tcp_echo(&mut stream, payload, timeout) + .await? + .len() + } else { + 0 + } + }; + Ok( + serde_json::json!({"protocol": if udp { "UDP" } else { "TCP" }, "target": target.to_string(), "elapsed_ms": started.elapsed().as_secs_f64()*1000.0, "verified_bytes": bytes, "kind": if echo { "echo_roundtrip" } else { "tcp_connect" }}), + ) + } +} diff --git a/crates/meshport/src/quality.rs b/crates/meshport/src/quality.rs new file mode 100644 index 0000000..11d1687 --- /dev/null +++ b/crates/meshport/src/quality.rs @@ -0,0 +1,59 @@ +use crate::{Network, UdpSocket}; +use anyhow::Result; +use std::{ + net::SocketAddr, + time::{Duration, Instant}, +}; +impl Network { + /// Samples a reusable UDP echo socket. Ignores late/foreign replies. + pub async fn sample_udp_quality( + &self, + socket: &UdpSocket, + target: SocketAddr, + sequence: u64, + timeout: Duration, + ) -> Result { + let before = self.snapshot().await; + let destination = before["routes"] + .as_array() + .and_then(|routes| { + routes.iter().find(|r| { + r["ipv4"].as_str().is_some_and(|ip| { + ip.split('/').next() == Some(target.ip().to_string().as_str()) + }) + }) + }) + .cloned(); + let payload = format!("MeshPort quality v1 {sequence}").into_bytes(); + let started = Instant::now(); + let result = tokio::time::timeout(timeout, async { + socket.send_to(&payload, target).await?; + let mut bytes = [0; 2048]; + loop { + let (n, source) = socket.recv_from(&mut bytes).await?; + if source == target && bytes[..n] == payload { + return Ok::<_, anyhow::Error>(()); + } + } + }) + .await; + let success = matches!(result, Ok(Ok(()))); + let elapsed_ms = success.then(|| started.elapsed().as_secs_f64() * 1000.0); + let after = self.snapshot().await; + let peer_id = destination.as_ref().and_then(|d| d["peer_id"].as_u64()); + let after_hop = after["routes"] + .as_array() + .and_then(|rows| rows.iter().find(|r| r["peer_id"].as_u64() == peer_id)) + .and_then(|r| r["next_hop_peer_id"].as_u64()); + let before_hop = destination + .as_ref() + .and_then(|d| d["next_hop_peer_id"].as_u64()); + Ok(serde_json::json!({"success": success, "sequence": sequence, + "elapsed_ms": elapsed_ms, + "next_hop_peer_id": before_hop, + "next_hop_after": after_hop, "route_changed": before_hop != after_hop, + "target_peer_id": destination.as_ref().and_then(|d| d["peer_id"].as_u64()), + "kind": "udp_echo_roundtrip", "error": if success {None} else {Some("timeout_or_io_error")} + })) + } +} diff --git a/crates/meshport/src/system_probe.rs b/crates/meshport/src/system_probe.rs new file mode 100644 index 0000000..0a90956 --- /dev/null +++ b/crates/meshport/src/system_probe.rs @@ -0,0 +1,44 @@ +use anyhow::{Result, ensure}; +use std::{ + net::SocketAddr, + time::{Duration, Instant}, +}; +use tokio::io::{AsyncReadExt, AsyncWriteExt}; +pub async fn probe( + target: SocketAddr, + udp: bool, + echo: bool, + timeout: Duration, +) -> Result { + ensure!(target.is_ipv4(), "IPv4 required"); + ensure!(!udp || echo, "UDP tests require a cooperating echo server"); + let started = Instant::now(); + let payload = b"MeshPort system socket echo v1"; + let bytes = tokio::time::timeout(timeout, async { + if udp { + let socket = tokio::net::UdpSocket::bind("0.0.0.0:0").await?; + socket.connect(target).await?; + socket.send(payload).await?; + let mut bytes = [0; 2048]; + let n = socket.recv(&mut bytes).await?; + ensure!(&bytes[..n] == payload, "echo data mismatch"); + Ok::(n) + } else { + let mut socket = tokio::net::TcpStream::connect(target).await?; + if !echo { + return Ok(0); + } + socket.write_all(payload).await?; + let mut bytes = vec![0; payload.len()]; + socket.read_exact(&mut bytes).await?; + ensure!(bytes == payload, "echo data mismatch"); + Ok(bytes.len()) + } + }) + .await??; + Ok( + serde_json::json!({"protocol": if udp {"UDP"} else {"TCP"}, "target": target.to_string(), + "elapsed_ms": started.elapsed().as_secs_f64()*1000.0, "verified_bytes": bytes, + "kind": if echo {"echo_roundtrip"} else {"tcp_connect"}, "socket_scope": "system"}), + ) +} diff --git a/crates/meshport/tests/overlay.rs b/crates/meshport/tests/overlay.rs new file mode 100644 index 0000000..07d148a --- /dev/null +++ b/crates/meshport/tests/overlay.rs @@ -0,0 +1,121 @@ +use meshport::Network; +use std::{net::SocketAddr, time::Duration}; +use tokio::io::{AsyncReadExt, AsyncWriteExt}; + +fn config(ip: &str, port: u16, server: bool) -> String { + let transport = if server { + format!("listeners = ['udp://127.0.0.1:{port}']\n") + } else { + format!("listeners = []\n[[peer]]\nuri = 'udp://127.0.0.1:{port}'\n") + }; + format!( + "ipv4 = '{ip}'\nstun_servers = []\nstun_servers_v6 = []\n{transport}\n[network_identity]\nnetwork_name = 'meshport-test'\nnetwork_secret = 'test-only'\n[flags]\ndefault_protocol = 'udp'\n" + ) +} +#[tokio::test(flavor = "multi_thread", worker_threads = 4)] +async fn real_overlay_tcp_udp_and_restart() { + let port = std::net::UdpSocket::bind("127.0.0.1:0") + .unwrap() + .local_addr() + .unwrap() + .port(); + let server = Network::start(&config("10.77.0.2", port, true)) + .await + .unwrap(); + let client = Network::start(&config("10.77.0.11", port, false)) + .await + .unwrap(); + let timeout = Duration::from_secs(10); + let mut listener = server.listen_tcp(7007, timeout).await.unwrap(); + let tcp_echo = tokio::spawn(async move { + let (mut stream, _) = listener.accept().await.unwrap(); + let mut bytes = [0; 128]; + let n = stream.read(&mut bytes).await.unwrap(); + stream.write_all(&bytes[..n]).await.unwrap(); + // Keep the connection alive until the client consumes its echo. + let _ = stream.read(&mut bytes).await; + }); + let udp = server.bind_udp(7007, timeout).await.unwrap(); + let client_udp = client.bind_udp(0, timeout).await.unwrap(); + // Upstream UDP is outbound-flow scoped; register the known remote first. + udp.send_to(b"warmup", client_udp.local_addr()) + .await + .unwrap(); + let udp_echo = tokio::spawn(async move { + let mut bytes = [0; 128]; + for _ in 0..4 { + let (n, addr) = udp.recv_from(&mut bytes).await.unwrap(); + udp.send_to(&bytes[..n], addr).await.unwrap(); + } + tokio::time::sleep(Duration::from_millis(300)).await; + }); + let target: SocketAddr = "10.77.0.2:7007".parse().unwrap(); + let started = std::time::Instant::now(); + while client.snapshot().await["peer_count"].as_u64().unwrap() == 0 { + assert!(started.elapsed() < timeout, "peer discovery timed out"); + tokio::time::sleep(Duration::from_millis(100)).await; + } + tokio::time::sleep(Duration::from_millis(500)).await; + let before = client.snapshot().await; + assert_eq!(before["connectivity"]["disable_p2p"], false); + assert_eq!(before["connectivity"]["disable_udp_hole_punching"], false); + assert_eq!(before["connectivity"]["disable_tcp_hole_punching"], false); + assert_eq!(before["connectivity"]["listeners"], serde_json::json!([])); + assert!( + !before["peers"][0]["transports"] + .as_array() + .unwrap() + .is_empty() + ); + let tcp = client.probe(target, false, true, timeout).await.unwrap(); + assert!(tcp["verified_bytes"].as_u64().unwrap() > 0); + let received = meshport_netstack::udp_echo(&client_udp, target, b"udp-echo", timeout) + .await + .unwrap(); + assert_eq!(received, b"udp-echo"); + tokio::time::sleep(Duration::from_millis(200)).await; + let after = client.snapshot().await; + assert!(!after["native_events"].as_array().unwrap().is_empty()); + assert!(!after.to_string().contains("test-only")); + assert!( + after["traffic"]["rx_bytes"].as_u64().unwrap() + > before["traffic"]["rx_bytes"].as_u64().unwrap() + ); + assert!( + after["traffic"]["tx_bytes"].as_u64().unwrap() + > before["traffic"]["tx_bytes"].as_u64().unwrap() + ); + assert!(after["traffic"]["rx_bytes_per_second"].as_f64().unwrap() > 0.0); + assert!(after["peers"][0]["rx_bytes"].as_u64().unwrap() > 0); + let started = std::time::Instant::now(); + while client.snapshot().await["peers"][0]["latency_ms"] + .as_f64() + .is_none() + { + assert!( + started.elapsed() < timeout, + "link RTT measurement timed out" + ); + tokio::time::sleep(Duration::from_millis(100)).await; + } + for sequence in 0..3 { + let sample = client + .sample_udp_quality(&client_udp, target, sequence, timeout) + .await + .unwrap(); + assert_eq!(sample["success"], true); + assert!(sample["elapsed_ms"].as_f64().unwrap() > 0.0); + assert_eq!(sample["next_hop_peer_id"], sample["target_peer_id"]); + } + tcp_echo.abort(); + udp_echo.abort(); + client.stop().await; + server.stop().await; + client.stop().await; + for _ in 0..3 { + let client = Network::start(&config("10.77.0.11", port, false)) + .await + .unwrap(); + client.stop().await; + } +} diff --git a/docs/android.md b/docs/android.md new file mode 100644 index 0000000..db2f8ff --- /dev/null +++ b/docs/android.md @@ -0,0 +1,39 @@ +# Android 客户端与 SDK + +当前实现面向 Android 8.0(API 26)及以上的 ARM64 设备。 + +## 构建 + +构建环境需要 Flutter、JDK 17、Android SDK、NDK 28.2.13676358、CMake 3.22.1,以及 Rust 的 aarch64-linux-android target。 + +```sh +scripts/build-lab-android.sh --release +``` + +脚本先编译含 system-vpn 功能的 Rust 库,再打包 Flutter APK,输出到 outputs/android。当前使用开发签名,适合本机安装验证。正式发行需配置自己的签名和应用 ID。原生库与 JNI 桥接使用 16 KB ELF 页面对齐;当前真机为 4 KB 页面,16 KB 设备运行尚未验证。 + +## 两种模式 + +- 应用内:通过 meshport_flutter SDK 的 TCP/UDP 接口通信,不创建系统 VPN。 +- 系统 VPN:宿主请求用户授权,由前台 VpnService 创建虚拟网卡,将文件描述符交给 Rust 引擎。虚拟网段及符合规则的公告子网自动安装、更新和撤销,不需要填写远端子网。 + +外层连接通过 VpnService.protect 排除在自己的 VPN 之外。系统模式不配置默认路由或 DNS;IPv6 保留系统通路,当前虚拟网络数据面为 IPv4。其他 Android VPN 与此系统 VPN 不能同时作为当前 VPN 运行。 + +配置使用 Android Keystore 的 AES-GCM 密钥加密,私有存储仅保存密文与 IV,关闭 Android 备份。启动恢复表单,不自动连接;后台服务仍运行时重新打开界面会恢复该会话。 + +## 真机验证 + +integration_test/android_network_test.dart 使用隔离网络身份和 USB 转发的本机测试网关,覆盖加密存储、应用内 TCP/UDP、普通系统 Socket 经 VPN 访问自动公告子网,以及公告撤销。 + +```sh +# 先在项目根目录启动本机夹具 +scripts/cargo-local.sh run -p meshport-easytier --example android_test_server +adb reverse tcp:18080 tcp:18080 +adb reverse tcp:18081 tcp:18081 +cd apps/meshport_lab +flutter test integration_test/android_network_test.dart -d DEVICE_SERIAL +``` + +测试中的系统 VPN 授权必须由用户在手机上完成。测试结束应删除两条 adb reverse 并关闭夹具。测试使用固定地址,不覆盖公网打洞、移动网络切换、长期后台存活或实际游戏负载。 + +2026-10-10 已通过真机加密存储及应用内 TCP/UDP。系统 VPN 验证在设备断开时中止,仍待完成。 diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..d5978aa --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,17 @@ +# 架构 + +Flutter Lab → Dart SDK → C ABI → MeshPort → EasyTier 原生实例与其 smoltcp 数据面。 + +当前上游已经提供 `data_plane_tcp_connect`、`data_plane_tcp_bind`、`data_plane_udp_bind`。因此第一版不维护第二套 TCP/IP 栈;netstack crate 是适配边界,可在以后替换实现。 + +核心上游依赖禁用默认 features,仅开启 aes-gcm、ffi-dataplane、dhcp-ipv4、tcp-hole-punch、proxy-cidr-monitor。默认未启用 tun、magic-dns、linux-netlink、UPnP、出口节点和配置服务器集成。应用内模式强制 no_tun/use_smoltcp/加密。显式 system-vpn feature 可启用 macOS TUN,系统模式拒绝 DNS 和出口。两种模式共享公告子网过滤策略:应用内模式限制数据面发送,系统模式同步安装及删除 OS 路由。 + +每个 FFI context 有独立的两线程 Tokio runtime,实例与资源属于该 context。context free 从全局注册表移除句柄;正在执行的调用通过 Arc 保持资源活着,完成后再析构。句柄不复用。停止节点前清理 TCP/UDP 资源;关闭实例使上游会话失效。 + +第一版 JSON ABI 的用途是正确性与生命周期验证,数据以 byte array 传递,非零拷贝。单 context 串行,read 等待期间其他操作也会等待;停止不会抢占在途读操作。需在后续改为异步提交/取消/完成队列,并支持连接级并发。不同 context 可独立运行。 + +UI 仅显示实测状态与结果。连接耗时与 echo 往返耗时分开标识,不当成持续 RTT。默认配置不保存密钥;macOS 可 opt-in 保存完整配置到 Keychain,日志不记录配置原文。 + +选路优化在 vendor/easytier/easytier-core 的连接及下一跳选择层执行,适配层负责严格配置和实际路由快照。质量测量通过公开 Rust/C ABI/Dart API 发起真实 UDP echo,不改系统网络,详见 [优化说明](optimization.md)。 + +系统模式:Flutter → Dart Unix 控制通道 → macOS 特权 helper → 同一 C ABI → EasyTier TUN;其他应用通过普通系统 socket 使用虚拟网段。详见 [系统组网](system-vpn.md)。 diff --git a/docs/compatibility.md b/docs/compatibility.md new file mode 100644 index 0000000..125d616 --- /dev/null +++ b/docs/compatibility.md @@ -0,0 +1,13 @@ +# 兼容范围与依赖 + +EasyTier 仓库:https://github.com/EasyTier/EasyTier + +vendor/easytier 是固定提交的本地定制快照,来源和修改清单见该目录 MESHPORT.md。基础提交:7af7bdc16a41d64d58743d15023a63b3eed2102c。Cargo.lock 固定传递依赖;build 使用 --locked。 + +当前本机验证:macOS aarch64、Rust1.99、Flutter3.41.4/Dart3.11.1。 + +目标平台:macOS/Linux/Windows/iOS/Android。macOS 原生库和客户端已验证。Android ARM64 原生库、JNI 和 APK 已构建,真机配置加密存储和应用内 TCP/UDP 已通过;系统 VPN 已实现但真机验证在设备断开时中止,仍待完成。其他 runner 是脚手架,仍需要目标编译、链接、库加载和真机测试。iOS 使用静态链接,并需要保留导出符号。Android 说明见 android.md。 + +本地集成测试两端使用同一固定 EasyTier 核心,因此证明的是该版本应用内数据面的组网与数据校验。与服务器既有发布版、跨版本混合网络、公网中继、NAT打洞、跨国链路和移动端后台恢复尚未实测。 + +上游 EasyTier 使用 LGPL-3.0,文本见 upstream/EasyTier-LICENSE;未复制 GPL-3.0 iOS 客户端代码。MeshPort 自身许可证尚未选定。发行原生库/客户端时需核对上游、smoltcp及传递依赖许可证和对应源码/构建材料。 diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..682e06d --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,17 @@ +# 配置 + +使用 EasyTier TOML,示例见 `examples/client.toml`。必须填写虚拟 IPv4 或 `dhcp = true`,二者互斥。自动分配实际地址由上游动态生成;状态从运行实例快照读取。 + +第一版允许顶层字段:hostname、instance_name、ipv4、dhcp、network_identity、peer、listeners、mapped_listeners、flags、stun_servers、stun_servers_v6、optimization、runtime。 + +network_identity 允许 network_name、network_secret。peer 数组的每项仅允许 uri。节点、监听与映射地址仅支持 tcp/udp。默认不开放监听端口;用户可显式设置 listeners。 + +flags 允许:default_protocol、latency_first、enable_ipv6、disable_p2p、p2p_only、lazy_p2p、need_p2p、disable_tcp_hole_punching、disable_udp_hole_punching、disable_sym_hole_punching、private_mode、foreign_relay_bps_limit,以及 no_tun、use_smoltcp、enable_encryption。enable_encryption 必须为 true;前两项在默认 application 模式必须为 true,在 system_vpn 模式必须为 false,可省略由模式确定。 + +未知、不支持的字段拒绝,不静默吞掉。解析器错误不返回配置原文,避免泄漏密钥。当前校验支持 TOML 解析与基本类型/策略,完整 runtime 能力校验仍在 start 阶段完成;validate 成功不保证远端可达。 + +UI 表单提供常用字段,其他已支持字段通过粘贴 TOML 输入。导出表单配置默认去掉密钥。高级安全模式、KCP/QUIC、Magic DNS、子网导出、系统出口、虚拟 IPv6 暂未支持。 + +`[runtime] mode = "system_vpn"` 显式选择 macOS 系统组网开发模式,默认 `application`。两种模式自动接入符合规则的已发布私有子网,无需 `subnet_routes`(该字段已移除)。只接入 /16~/32 的私有 IPv4,最多 32 项,过滤本机接口和虚拟网段冲突;公告撤回时取消接入。系统模式限制及权限要求见 [系统组网](system-vpn.md)。 + +MeshPort 扩展 `[optimization]` 配置在传入上游前解析并移除;模式、阈值、UDP优先和候选限制见 [优化说明](optimization.md)。 diff --git a/docs/ffi-contract.md b/docs/ffi-contract.md new file mode 100644 index 0000000..36f4aec --- /dev/null +++ b/docs/ffi-contract.md @@ -0,0 +1,41 @@ +# C ABI v1 + +声明位于 `crates/meshport-ffi/include/meshport.h`。 + +- `meshport_context_new()` 返回非零 context;失败为 0。 +- `meshport_call(context, request_json)` 返回库分配的 NUL 结尾 UTF-8 字符串。 +- `meshport_string_free()` 必须且只能释放该返回值一次。 +- `meshport_context_free()` 停止该实例并释放资源;重复释放 context 为 no-op。 +- 传入字符串必须在调用期间有效,不能传悬空指针。异常不会跨 C ABI 展开。 + +返回格式:`{"ok":true,"data":{...}}` 或 `{"ok":false,"error":"..."}`。 + +控制操作:validate/start(toml)、stop、status。 + +Android 系统模式需宿主 VpnService 创建 TUN 后调用 attach_tun(fd)。fd 由宿主持有,原生库不负责关闭;必须在原生实例停止后再关闭,替换网卡时须等新接口 ready 后关闭旧 fd。启动前注册 meshport_set_android_socket_protector,将原生 worker 的外层 socket 交给 VpnService.protect,回调与 JVM 桥接需保持有效。参考客户端 MeshVpnService 和 JNI NativeBridge。 + +TCP:tcp_connect(target)返回 resource;tcp_write(resource、bytes);tcp_read(resource、max_bytes、timeout_ms)返回 bytes/eof。 + +UDP:udp_bind(port,0 表示动态端口)返回 resource;udp_send(resource、target、bytes);udp_receive(resource、timeout_ms)返回 bytes/source。仅接收已建立远端 flow 的报文。 + +resource_close 关闭指定资源。资源不能跨 context 使用;停止后资源全部失效。 + +probe:target、protocol(TCP/UDP)、echo、timeout_ms。TCP echo=false 只测建连;TCP echo=true/UDP 验证回显字节。UDP 必须 echo=true。耗时包括相应操作全过程,并非基础线路纯 RTT。 + +单次 JSON 请求 ≤128 KiB,配置 ≤64 KiB;写数据建议按16 KiB分块。UDP bytes ≤65507;TCP read 最大65535。普通 I/O 超时 1–30000 ms,默认5000 ms。连接/绑定超时当前固定5000 ms。 + +该 ABI 同步且每 context 串行,必须在后台线程执行。停止和释放会等待在途请求完成;当前不提供立即取消。TCP超时后可能已有部分字节发出,不应直接重发整个消息。后续生产版需异步资源接口和结构化错误码。 + +## 网络遥测 + +`status` 增加 `traffic`:`rx_bytes` / `tx_bytes` 为当前引擎运行期间采样到的累计隧道字节,`rx_bytes_per_second` / `tx_bytes_per_second` 是两次状态采样间的平均 B/s。首次采样速率为 null,重启引擎重新计数。包含组网控制、心跳和转发流量,不等于应用有效载荷。计数来自存活连接快照;若连接在两次采样之间消失,最后一次采样后的字节可能未计入。 + +`peers` 增加默认连接的 `latency_ms`(EasyTier ping RTT;未测出为 null),当前存活连接合计字节及采样速率。`routes` 增加所选路由的 `estimated_latency_ms` 与 `next_hop_peer_id`;估算为路由各链路延迟之和,不是端到端实测 RTT。多连接节点的 RTT 来自默认连接,流量为全部存活连接之和。中继目标未单独归集流量,其流量计入下一跳隧道。 + +`diagnostics_enable` 显式开启进程级穿透 tracing 采集,返回 enabled 与 scope。SDK 默认不安装全局 subscriber;已有宿主 subscriber 时 enabled=false,宿主应自行开启 EasyTier 穿透日志。启用后不可在本进程中卸载,采集仅匹配 easytier_core::connectivity::hole_punch,最多 200 条、每条 4 KiB;status 增加 diagnostic_traces,含递增 sequence,可跨采样去重。多实例共享采集范围;诊断中含节点地址,导出时当前网络密钥脱敏。 + +路由诊断增加 version、udp_nat_type、disable_p2p、need_p2p;cost 与 next_hop_peer_id 使用同一路由策略。peers.direct 表示存在物理直连,判断目标当前是否走直连还应核对对应 routes.next_hop_peer_id 是否等于目标 peer_id。 + +注意上游 directly_connected_conns 只统计非打洞连接,本 SDK 不再直接以其为空推断中继。peers.direct 包括 TCP/UDP 打洞后的物理连接,hole_punched 表示存在上游归类为打洞的存活连接。页面的直连/中继标签仍根据所选下一跳判断,而非仅根据 direct。 + +`quality_sample` 请求:`resource` 为已绑定 UDP 句柄,`target` 为 IPv4:port,`sequence` 为 u64,`timeout_ms` 为100–5000(默认1000)。返回 success、elapsed_ms、target_peer_id、next_hop_peer_id、next_hop_after、route_changed。超时/I/O错误返回 success=false、elapsed_ms=null;非法句柄或参数走 ABI 错误。复用 socket 并顺序调用,目标须支持原样 echo;状态前后采样不计入 RTT。 diff --git a/docs/optimization.md b/docs/optimization.md new file mode 100644 index 0000000..74715c2 --- /dev/null +++ b/docs/optimization.md @@ -0,0 +1,43 @@ +# 跨国线路优化:第一轮 + +MeshPort 使用本地定制的 EasyTier 核心,保持现有网络协议。修改位于 vendor/easytier,不要求现有服务端同步修改。混合版本、公网链路仍需实测。 + +## 线路策略 + +Flutter「设置 → 连接」默认选自适应。引擎只影响通过 MeshPort SDK 发起的通信,不创建 TUN 或改变系统路由。 + +```toml +[optimization] +mode = "adaptive" +min_improvement_ms = 15.0 +min_improvement_ratio = 0.15 +hold_seconds = 10 +cooldown_seconds = 30 +prefer_udp = true +relay_peer_ids = [] +``` + +- adaptive:存在可用直连时,候选中继估算至少改善 15 ms 且 15%,持续 10 秒才切换;切换后冷却 30 秒。路径失效优先恢复可用路径。 +- direct:有直连便使用,否则接受上游中继候选。 +- latency:接受上游延迟优先候选,候选不可用时回退直连。 +- hop:有直连便使用,否则按上游最少跳数候选选择。 + +没有 optimization 时,保留原 flags.latency_first 的含义:true 使用 adaptive,false/缺省使用 hop。显式 mode 优先决定该 flag。阈值范围:毫秒 0–1000、比例 0–0.9、持续时间 0–300 秒、冷却 0–600 秒。 + +UDP 优先作用于同一节点已经建立的连接,保留 TCP 作为备用。尚未首次 ping 确认的打洞连接不会抢占已确认连接。连接选择最多每 5 秒刷新;路由选择缓存 2 秒,通过流量或状态采样驱动阈值评估。策略不会凭空建立配置中没有的备用通道。 + +relay_peer_ids 最多 64 项,约束本机普通 peer-map 中上游候选的第一跳,空列表不限制。它不是完整的中继池调度器:上游最优候选不在列表时,不搜索第二优候选;没有直连可能暂时不可达。也不约束远端后续转发或所有 foreign-network 转发。建议第一轮留空。 + +## 实测质量 + +「测试 → 测量线路质量」复用 UDP socket,先预热,再发送 60 次带唯一序号的 echo,单次默认超时 1 秒,样本间隔 500 ms。需要目标虚拟 IP 上运行协作 UDP echo 服务,可以使用 meshport-test-server。任意游戏端口不能直接作为 echo 服务。 + +统计中位 RTT、P95(nearest-rank)、相邻有效 RTT 差值均值及未收到有效回包比例。超时也可能由 I/O 错误或 echo 服务不可用导致,不等同于纯链路丢包。迟到、其他来源及不匹配内容的回包不会被计为有效样本。按采样前下一跳分组;前后下一跳不同的样本单列。仅检测采样前后变化,不能证明途中没有短暂切换。 + +状态 routes.next_hop_peer_id 显示本机实际选择;candidate_next_hop_peer_id 保留上游候选,estimated_latency_ms 仍是上游候选路径估算;直连 RTT 从 peers.latency_ms 读取。optimization_basis 明确为 link_rtt_and_route_estimate。 + +当前自动选路比较直连的选中连接 RTT 与上游路径估算,并未将端到端 P95/抖动/丢包自动反馈到路由器,也未强制逐条候选路径探测。先分别使用 direct/adaptive 测量同一 echo 目标,检查结果再调阈值。配置修改需断开重连。 + +## 后续范围 + +独立候选路径探测与端到端反馈、完整专用中继池搜索、拥塞/排队感知、MTU 探测、游戏流优先和跨国长时故障测试尚未实现。此轮没有部署或购买中继服务器。 diff --git a/docs/p2p-investigation.md b/docs/p2p-investigation.md new file mode 100644 index 0000000..1a5abcb --- /dev/null +++ b/docs/p2p-investigation.md @@ -0,0 +1,49 @@ +# P2P 差异调查(2026-10-09) + +## 已观察到的证据 + +读取运行中的 MeshPort 界面:DIG-US 有直接链路,其余目标显示中继/路由估算。原版日志只有加载、启动、停止八条界面操作事件,没有原生连接事件,也没有 UDP 打洞失败细节。 + +用户提供的 EasyTier GUI 日志:两条初始 TCP 连接先超时、后成功;随后到节点 3157594741 建立 UDP 连接。它证明 GUI 建立了 UDP 隧道;是否由打洞建立,需要确认该地址不是手动配置的初始节点。新增连接时 latency_us 为零、包数为一,属于初始统计,不能当成打洞失败或零延迟。 + +## 代码对比 + +- UDP 穿透由上游 CoreUdpHolePunchService 创建并在原生实例启动时启动;不依赖 TUN,也不是因为本项目关掉默认 Cargo feature 就整体消失。TCP 穿透 feature 明确编译开启。 +- MeshPort 普通 listeners 为空;上游 GUI 默认包含 TCP/UDP 11010。空监听影响普通主动直连/同局域网连接,不能直接推断 UDP 打洞被禁用;UDP 打洞服务会另建自己的监听。 +- MeshPort 明确禁用 UPnP 且不编译其映射适配器;GUI 默认未禁用。这可能影响某些 NAT 的成功率,但目前没有证据证明 GUI 的成功链路使用了 UPnP。当前保留此限制,避免默认改变用户路由器端口映射。 +- MeshPort 使用固定的 2.7.0 开发版上游提交;已从本机 /Applications/easytier-gui.app/Contents/Info.plist 确认 GUI 为 2.4.5;服务器实际版本未知。比较两版官方源码,UdpHolePunchRpc 的方法名和顺序仍一致,不能仅凭版本不同认定信令不兼容。 +- MeshPort macOS Debug 包已有 network.client/server;Release 只有 client。本次补齐 Release 的 server entitlement。用户正在运行 Debug 包,所以此修复不能作为当前故障根因。 +- 首版使用 latency_first=true,GUI 上游默认 false。选择路由和建立直连是不同问题;即使存在直连,延迟策略也可能选择另一条路径。 + +参考官方配置:https://easytier.rs/guide/network/configurations.html +参考官方 P2P 文档:https://easytier.rs/guide/network/p2p-optimize + +## 本次改动 + +状态增加 UDP/TCP NAT 类型、STUN 更新时间、显式 STUN 配置、实际 TCP/UDP 普通监听地址、有效 P2P 开关和连接协议。STUN 配置 null 表示采用上游默认,空数组表示明确不给探测服务器;NAT Unknown 本身不区分尚未探测、探测失败或禁用。 + +在实例启动之前订阅原生事件,保留最多 100 条连接/监听事件,带 sequence;Flutter 刷新时去重写入日志。网络密钥从错误文本中脱敏。此事件流不是完整 tracing:UDP 打洞算法的内部重试/失败原因可能仍需额外 tracing 采集。复制网络诊断不含配置中的密钥,但包含节点名称、IP 等网络信息。 + +## 尚未确认 + +尚未取得故障发生时 MeshPort 的 NAT 结果及原生穿透内部错误,没有在用户真实网络复现并证明修复成功。本机双节点测试只证明网络模块与新增诊断工作,不证明跨 NAT 打洞。 + +下一轮按相同网络、初始节点和目标对比:先确认 NAT 是否完成检测、有效 P2P 禁用开关、到 3157594741 的 UDP 连接是否出现;再验证 GUI 使用的版本、STUN 和 UPnP。保持两个客户端分别运行,避免同时运行造成端口或路由干扰。 + +## 第二轮诊断 + +用户提供的状态:本地 UDP NAT 为 Symmetric,STUN 已更新,UDP/TCP/对称 NAT 打洞禁用开关均为 false。仅有到两个服务器的 TCP 连接;Redmi_AX6(3157594741)不存在直接连接。此前的约 2 秒 handshake timeout 是原生连接事件,未记录目的节点,不能据此认定是 UDP 打洞超时。 + +当前核心对 hard-symmetric → cone 有尝试路径,hard-symmetric → symmetric 不作为 UDP 客户端尝试。需要结合对端 NAT 分类判断是否触发;因此状态新增对端 NAT、版本和 P2P 通告开关。 + +还发现诊断把 latency_first 所选 next-hop 和普通模式 cost 混用了;已修正 cost 使用同一策略。UI 根据所选 next-hop 区分“当前直连”和“中继但有直连可用”,避免把已经存在的 TCP 直连误当成当前路由。 + +Lab 在创建网络前显式调用 diagnostics_enable,开启穿透模块 DEBUG 级详细 tracing,进程内保留最多 200 条、单条最多 4 KiB。用于观察 RPC 失败、端口预测、发包后等待超时。该操作不替换宿主已存在的 subscriber,默认 SDK 不自动启用;详细日志包含节点/网络地址信息。仍没有在真实故障网络确认根因或证明修复成功。 + +## 第三轮:确认 Redmi_AX6 已打洞成功,修正显示错误 + +最新诊断出现“连接建立 节点 3157594741 协议 udp”,RTT 7.497 ms,路由 cost=1,next_hop_peer_id 等于目标自身。因此 Redmi_AX6 当前有 UDP 物理直连;此前认为它始终打洞失败的判断不适用于本次状态。其他目标的失败日志不能代替它的当前状态。 + +根因是 MeshPort 错用了上游 directly_connected_conns:easytier-core/src/peers/conn/peer.rs 的 get_directly_connections 会明确 filter 掉 is_hole_punched() 的连接。空列表并非没有物理直连。 + +修正 peers.direct 判断为本地 peer-map 有默认连接且存在存活 TCP/UDP 隧道,排除只有 foreign logical 连接的节点。新增 hole_punched 字段,展示“直连 · 打洞建立”;是否当前走直连继续核对路由下一跳,显示 7.5 ms 实测 RTT。加入 Rust 回归测试覆盖打洞、关闭和 foreign 状态;Flutter 覆盖本次 Redmi_AX6 的路由与显示。 diff --git a/docs/system-vpn.md b/docs/system-vpn.md new file mode 100644 index 0000000..70912f3 --- /dev/null +++ b/docs/system-vpn.md @@ -0,0 +1,45 @@ +# macOS 系统组网开发版 + +MeshPort 保留两种独立模式:默认 `application` 只服务通过 SDK 发起的连接;`system_vpn` 创建 macOS utun,使其他应用的普通系统 TCP/UDP socket 可以访问虚拟网段。Flutter Lab 的设置页可选择模式。 + +## 配置与路由边界 + +```toml +ipv4 = "192.168.20.5/24" +listeners = [] +[[peer]] +uri = "tcp://your-server:52015" +[network_identity] +network_name = "your-network" +network_secret = "your-secret" +[runtime] +mode = "system_vpn" +``` + +本阶段仅支持 macOS、静态私有 IPv4,前缀 /16 到 /30。虚拟地址必须唯一。helper 在启动前检查已有接口的 IPv4 网段,重叠时拒绝启动;同时使用 EasyTier GUI 时应先断开冲突网络。当前不支持系统模式 DHCP、本机子网发布、出口节点或默认路由。两种模式均自动学习符合规则的节点公告子网。系统模式安装相应 OS 路由;应用内模式仅供 SDK TCP/UDP 连接访问,不配置系统 DNS。 + +Rust 的 `system-vpn` feature 是显式编译开关;默认 SDK 构建保持应用内模式。系统模式使用操作系统 socket,不能调用应用内模式的 `connect_tcp/listen_tcp/bind_udp`;Lab 的单次 TCP/UDP 探测自动改用系统 socket。批量 UDP 线路采样仍属于应用内模式。 + +## 启动和生命周期 + +运行 `scripts/run-lab-macos.sh`,它构建并启动包含动态库与 helper 的开发应用。系统模式启动时 macOS 请求管理员授权;Flutter UI 不提权,独立 helper 创建网络接口。控制通道是当前用户私有临时目录中的 Unix socket,helper 校验对端 UID,限制请求大小与允许的操作。断开连接、控制通道关闭或空闲超时后停止引擎;临时目录由 Dart 清理。虚拟网段在启动前检查冲突。自动公告子网只允许私有 IPv4 /16 至 /32,最多 32 项(CIDR 排序后截取);过滤默认路由、公网、过宽网段、虚拟网段及本机接口重叠。接口缓存每 2 秒更新,系统路由定期重新同步;安装失败重试,公告撤回删除路由。 + +原生调用超过 60 秒时 helper 退出,以关闭 utun 文件描述符;Dart 控制请求超时为 30 秒。 + +设置页顶部有“配置保存”面板,可在未连接时点击“保存配置”。完整 TOML(包含网络密钥)保存在 macOS Keychain;启动时自动回填表单,不自动连接。已保存的配置可以重新载入或删除。“连接成功后自动保存配置”首次默认关闭,主动保存或加载已有配置后开启。未编辑的导入配置原样保留高级参数;修改表单后使用表单生成的配置。 + +## 发布边界 + +这是开发版 helper 方案,使用临时管理员授权与 ad-hoc 签名,尚未完成正式签名、公证或 Network Extension 发布流程;macOS App Sandbox 已为此开发方案关闭。Android VpnService、iOS Packet Tunnel、移动端后台恢复尚未接入,不能把这次 macOS 实现视作移动端已可用。 + +显式特权自检:`sudo target/debug/meshport-vpn-helper --self-test`。自检通过 loopback 建立两个隔离的 EasyTier 节点,使用 10.253.77.0/24 作为客户端虚拟网段,自动学习另一节点发布的 10.253.78.0/24,验证额外子网路由以及普通系统 TCP/UDP 经 utun 回显、默认路由保持不变、公告撤回后的路由删除和停止后的接口删除。最多运行 45 秒;阶段日志写入 `/tmp/meshport-vpn-self-test-.log`,不写网络密钥。 + +## 与其他 TUN 共存 + +macOS 的节点连接使用物理网卡候选,IPv4/IPv6 都排除其他 VPN 的 utun;不会将默认出口探测到的代理 TUN 地址重新加入候选。硬件检测在阻塞线程池等待子进程,避免嵌入宿主的异步信号处理影响冷启动。诊断中的 connectivity.bind_device 和 interface_ipv4s/interface_ipv6s 可确认实际候选。此调整由应用内和系统模式共用,不修改其他 VPN 的默认路由或配置。 + +例如 Redmi_AX6 已发布 192.168.21.0/24,Lab 虚拟 IP 为 192.168.20.4/24:无需填写远端子网。节点列表显示发布子网,两种模式的概览显示自动接入网段。该列表是通过规则的目标路由投影,不代表每一条 OS 路由安装均成功;实际系统路由可用 route 命令确认。 + +保留 v2rayN TUN,先用 `route -n get 192.168.21.201` 检查更具体的 /24 路由是否指向 MeshPort 的 utun。只设置 v2rayN “直连”规则不能建立 EasyTier 子网路由。如路由仍被代理接管,再检查 TUN 路由排除配置;不要依赖变化的 utun 编号设置永久路由。 + +旧版 runtime.subnet_routes 已移除;Lab 从钥匙串恢复旧版单行配置时会删除该字段并改用自动学习。直接使用 SDK 的旧配置应移除此字段。自动子网是 IPv4;移动端、Windows 的打包与实际互通尚待验证。 diff --git a/docs/testing.md b/docs/testing.md new file mode 100644 index 0000000..92450bb --- /dev/null +++ b/docs/testing.md @@ -0,0 +1,94 @@ +# 验证记录 + +## Android 阶段(2026-10-10) + +ARM64 Rust 原生库、JNI 桥接、Android debug/release APK 构建通过。OPPO PJZ110(API 37,4 KB 页面)已完成 Android Keystore 独立测试存储的保存/重新读取/删除,以及 SDK 经隔离公告子网的 TCP/UDP 回显。系统 VPN 授权后前台服务已启动,测试在设备从 ADB 断开时中止,尚未确认系统 Socket 经 VPN 通信及公告撤销。未把该测试记为通过。 + +最新源代码 Flutter analyze 无问题、7 项 widget 测试通过(3 项依赖原生 macOS 库的测试跳过),Rust workspace 测试及 doc-tests 通过。正式客户端界面的新版 APK 已打包,设备离线时尚未安装;测试夹具已关闭。需要设备重新连接完成剩余测试。详见 android.md。 + +2026-10-09,macOS Apple Silicon。 + +已经通过: + +- Rust workspace 首次构建。 +- 打洞 UDP 连接即使上游 directly_connected_conns 为空仍判为直连;关闭连接、外网逻辑连接不误判。 +- 配置不允许 TUN、系统路由/DNS选项;未知字段拒绝;解析错误不泄漏密钥。 +- 两个实际 EasyTier 原生实例通过本机 UDP tunnel 连接,虚拟 IP TCP echo 与 UDP数据校验。 +- 实际通信后上传/下载计数增加、采样速率大于零、默认链路 RTT 测量成功。 +- 停止实例及3次重新创建/停止。 +- C ABI context 创建、停止态、非法/失效句柄、重复释放。 +- 穿透详细日志 opt-in 采集、保留节点 ID、过滤其他应用模块日志。 +- Dart后台isolate → C ABI → Rust → 两节点EasyTier UDP通信,校验字节与来源。 +- Flutter widget 初始未连接状态、设置入口。 +- Flutter TOML 导入 → 实际原生引擎启动 → 状态显示 → 断开连接。 +- C 示例编译并读取原生实例状态。 +- Flutter Redmi_AX6 打洞直连显示 7.5 ms 实测 RTT,排除错误中继标签。 +- Flutter 节点 RTT、路由估算、流量速率和中继统计范围显示测试;已有直连但实际路由经中继时正确区分。 +- Flutter macOS debug 构建。 + +注意:首次 UDP测试发现上游只接收已发送过的远端会话报文;测试按上游会话模型显式预热,不把它当成通用 UDP监听。游戏服务端的普通 socket 回包路径仍需实际服务器验证。 + +运行命令: + +```sh +scripts/cargo-local.sh test --workspace --locked +scripts/cargo-local.sh clippy --workspace --all-targets --no-deps --locked -- -D warnings +cd apps/meshport_lab +flutter analyze +flutter test +# 包含真实原生引擎的界面测试(先构建 Rust 库) +flutter test --dart-define=MESHPORT_LIBRARY="$(cd ../.. && pwd)/target/debug/libmeshport_ffi.dylib" +dart run tool/native_smoke.dart ../../target/debug/libmeshport_ffi.dylib +``` + +最后一条从 apps/meshport_lab 执行,也可传入 Rust 库的绝对路径。 + +后续:真实游戏服务器发布版互通、网络切换/中继故障、长时内存与并发、用户态UDP首次入站支持、异步ABI、移动端打包与真机测试。 + +## 跨国优化第一轮回归 + +已通过:Rust workspace 12 个测试及 doc-tests;策略阈值、持续时间、冷却、候选限制与失效回退;两个实际 EasyTier 实例同时建立 TCP/UDP,确认 UDP 被选择,关闭 UDP 后选择 TCP。Dart → C ABI → 实际 overlay 质量采样验证成功回包、下一跳及超时结果。Flutter analyze 无问题,包含原生导入的 6 个测试全部通过;更新后的 macOS debug 包构建和签名通过。 + +Clippy 使用 --no-deps 检查 MeshPort 工作区且 -D warnings 通过。保留的上游源码在 Rust 1.99 下有 8 条既有弃用/未使用警告。 + +尚未完成真实跨国线路的长期对比、满负载游戏测试、UDP 黑洞恢复时延测试以及全部候选路径的端到端自动探测;本机功能测试不证明公网加速效果。 + +## macOS 系统组网阶段(2026-10-10) + +已通过 Rust workspace 13 项测试及 doc-tests、Flutter analyze、Flutter 8 项测试(包含 Unix 控制通道并发请求顺序及关闭清理)、macOS debug 构建和 codesign 深度校验。 + +系统模式自检曾完成真实 OS TCP/UDP → utun → EasyTier 的回显,并检查停止删除接口、默认路由不变。重复自检发现网卡初始化系统命令存在间歇性等待;macOS 命令已改为后台线程等待,避免依赖 Tokio 的进程信号通知;helper 增加原生操作 60 秒退出保护。最终代码连续两轮特权自检均通过:普通 OS TCP/UDP 经 utun 回显正确,停止后接口删除,启动期间及停止后默认路由保持不变。结果记录在 /tmp/meshport-system-vpn-final.log,阶段日志 PID 23903、23924。Clippy --no-deps -D warnings 通过。 + +Keychain 调用已编译,尚未执行保存/恢复的 GUI 端到端测试。Android/iOS 系统模式尚未实现;真实游戏、跨国长期压测和故障切换仍需后续验证。 + +## 指定远端子网修复(2026-10-10) + +Rust 13 项测试及 doc-tests、Flutter 8 项测试、analyze、Clippy --no-deps -D warnings、macOS 构建与签名通过。系统模式开启显式私有子网接入,拒绝默认路由、公网网段及本机接口网段重叠。 + +在 v2rayN TUN 开启时,特权自检为 10.253.78.0/24 添加 MeshPort 路由,经普通 OS TCP/UDP 完成额外子网的回显;确认目标路由指向测试 utun,停止后该接口及子网路由清理,默认路由不变。记录 /tmp/meshport-subnet-self-test.log。这验证的是本机额外子网路由和数据面;Redmi_AX6 发布的真实局域网及屏幕共享仍需用新版重连实测。当前显式接入,不自动接受全部节点发布的子网。 + +## 自动公告子网接入(2026-10-10) + +此版本取代上一阶段的手动子网列表。应用内与系统模式使用相同的私有 IPv4 /16~/32、32 项上限、虚拟网段和本机接口冲突过滤规则。runtime.subnet_routes 配置与 UI 字段均已删除。 + +应用内集成测试使用真正的发布节点:将 loopback 服务映射发布为 10.253.79.0/24,SDK 客户端自动学习后通过该子网完成 TCP 和 UDP 双向回显;发布节点清空公告后确认接入列表消失。测试节点启用独立 packet proxy host capability,生产客户端无需启用子网发布或 KCP/QUIC。 + +系统特权自检通过自动公告学习安装额外子网路由,经普通 OS TCP/UDP 回显;发布节点清空公告后确认路由删除,停止后 utun 消失,默认路由不变。记录 /tmp/meshport-auto-system-final.log。该自检的服务位于另一节点的虚拟 IP,应用内映射子网测试另外覆盖了后端服务访问。 + +此前实际 Redmi_AX6 子网 192.168.21.0/24 的屏幕共享端口已验证返回 RFB 握手;用户确认访问问题已解决。新版在真实网络中的自动接入仍需用新客户端重连验证,已有真实验证使用的是手动路由版本。 + +最终检查:Rust 工作区 16 项测试及 doc-tests、Clippy --no-deps -D warnings、Flutter 8 项测试(含最终原生库导入)、analyze、macOS 构建和严格签名验证通过。独立应用 outputs/macos/MeshPortLab-20261010121113.app。 + +## 代理 TUN 先启动时的物理网卡连接(2026-10-10) + +macOS 网络地址收集不再追加默认出口探测到的 TUN 地址;IPv6 使用同一物理网卡过滤。networksetup 硬件检测改用阻塞线程池等待。诊断增加 bind_device 和接口候选地址。 + +在 v2rayN utun58(172.18.0.1)保持开启时运行 `scripts/cargo-local.sh test -p meshport-easytier physical_bootstrap_with_existing_tun -- --ignored --nocapture`,通过物理地址启动独立测试网络并完成 EasyTier TCP 握手,同时断言候选不包含任何 utun 地址。测试不修改 OS 路由。这是本机真实套接字回归,不能替代用户远端节点在相同启动顺序下的互通验证。记录 /tmp/meshport-tun-bootstrap.log。 + +## 配置保存与 MeshPort 品牌(2026-10-10) + +设置页增加独立保存、重新载入和删除;启动自动回填,不自动连接。保存的未编辑高级 TOML 原样保留。Flutter 测试覆盖未连接保存、重建界面后回填名称/密钥/节点/IP、保持断开、删除,以及高级参数保留。测试调用真实 FFI,钥匙串 MethodChannel 使用隔离内存替身,不覆盖用户已有钥匙串配置。原生 macOS Keychain 实现随应用编译,真实钥匙串跨重启访问授权仍以设备实测为准。 + +FFI 测试验证普通 validate 不返回密钥,只有显式 include_profile 才返回表单所需字段。应用正式名称为 MeshPort;macOS/iOS/Android/Windows 图标及 Flutter 页头配置为已设计图标。其他平台尚未打包验证。 + +最终验证:Flutter 10 项测试及 analyze、FFI 3 项测试、Clippy --no-deps -D warnings、macOS 构建和严格签名验证通过。已打开正式应用,窗口标题为 MeshPort,页头为新图标,设置页顶部“保存配置”按钮可见。独立应用 outputs/macos/MeshPort-20261010144609.app(0.1.0 预览版)。实机检查未保存测试配置,避免污染用户配置。 diff --git a/docs/upstream/EasyTier-LICENSE b/docs/upstream/EasyTier-LICENSE new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/docs/upstream/EasyTier-LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/examples/c_client/status.c b/examples/c_client/status.c new file mode 100644 index 0000000..efa5c81 --- /dev/null +++ b/examples/c_client/status.c @@ -0,0 +1,10 @@ +#include +#include "meshport.h" +int main(void) { + uint64_t context = meshport_context_new(); + if (!context) return 1; + char *result = meshport_call(context, "{\"op\":\"status\"}"); + if (result) { puts(result); meshport_string_free(result); } + meshport_context_free(context); + return 0; +} diff --git a/examples/client.toml b/examples/client.toml new file mode 100644 index 0000000..5fa2887 --- /dev/null +++ b/examples/client.toml @@ -0,0 +1,18 @@ +# Replace with the same network identity used on the game server. +hostname = "MeshPort-Lab" +ipv4 = "10.77.0.11" +listeners = [] + +[[peer]] +uri = "udp://relay.example.com:11010" + +[network_identity] +network_name = "game-net" +network_secret = "replace-me" + +[flags] +no_tun = true +use_smoltcp = true +enable_encryption = true +default_protocol = "udp" +latency_first = true diff --git a/examples/system-vpn.toml b/examples/system-vpn.toml new file mode 100644 index 0000000..68103d9 --- /dev/null +++ b/examples/system-vpn.toml @@ -0,0 +1,13 @@ +# macOS development helper; choose an unused private subnet and unique address. +ipv4 = "192.168.20.5/24" +listeners = [] +[[peer]] +uri = "tcp://your-server:52015" +[network_identity] +network_name = "your-network" +network_secret = "replace-me" +[runtime] +mode = "system_vpn" + +# Optional: a remote peer must advertise this private LAN. +# subnet_routes = ["192.168.21.0/24"] diff --git a/outputs/branding/README.md b/outputs/branding/README.md new file mode 100644 index 0000000..c388df2 --- /dev/null +++ b/outputs/branding/README.md @@ -0,0 +1,11 @@ +# MeshPort Logo v1 + +通过内置 imagegen 生成。设计为青蓝渐变底色、白色 M 形连线与节点,用于应用图标。透明 PNG 原图:`meshport-logo-v1.png`。已配置到 macOS、iOS、Android、Windows 图标资源和 Flutter 页头。iOS 图标按平台要求铺底去除透明通道;其他图标保留透明度。macOS 构建已验证,其他平台资源尚未打包验证。 + +使用 Pillow 运行 `scripts/generate-app-icons.py` 可从原图重新生成各尺寸资源。正式应用名称为 MeshPort,保留原应用标识及钥匙串服务名以兼容已保存配置。 + +## 生成提示词 + +Use case: logo-brand. Design a polished final app icon for MeshPort, a cross-platform virtual mesh networking application powered by Rust and compatible with EasyTier, used to connect devices and game servers. Single icon only, centered, front-facing, square composition. Create an original bold geometric white monogram that subtly combines an M with interconnected mesh paths and the idea of a port or gateway. Three or four strong connected endpoints integrated into the letter shape, visually balanced, large simple silhouettes, excellent readability at 32px. Refined teal and deep ocean blue palette consistent with a networking dashboard: rich teal rounded-square tile with a very subtle blue-to-teal tonal gradient, white symbol, small cyan accent only if useful. Flat vector-like graphic, crisp edges, restrained premium utility aesthetic. Plenty of safe padding around the glyph. Tile fills most of canvas, transparent outside the rounded corners. No wordmark, no letters other than the abstract M glyph, no captions, no mockup, no device, no shadows outside tile, no glass, no metallic 3D, no padlock, no globe, no wifi symbol, no circuit-board complexity. Deliver a single large high-resolution app icon. + +参数:transparent_background = true。 diff --git a/outputs/branding/meshport-logo-v1.png b/outputs/branding/meshport-logo-v1.png new file mode 100644 index 0000000..3a7332f Binary files /dev/null and b/outputs/branding/meshport-logo-v1.png differ diff --git a/outputs/ui/meshport-mobile-all-screens-v1-prompt.txt b/outputs/ui/meshport-mobile-all-screens-v1-prompt.txt new file mode 100644 index 0000000..528521a --- /dev/null +++ b/outputs/ui/meshport-mobile-all-screens-v1-prompt.txt @@ -0,0 +1,8 @@ +Use case ui-mockup. Create a high-resolution cohesive Chinese mobile UI design board for MeshPort. Reference image is prior concept STYLE reference: use only its mobile styling, warm ivory, thin warm gray borders, white cards, pale cyan status backgrounds, teal primary actions, ochre relay badges, monospaced numeric metrics. This is an embedded application-only virtual networking SDK test app, no global VPN, no system routing or DNS controls. Need ALL SIX full mobile screens, arranged exactly THREE columns by TWO rows, equally sized tall screenshots, no hardware frames, no perspective, no overlaps, generous gutters and short numbered captions outside each screen. Canvas portrait-ish accommodates six 390x844-style screens. Large readable UI labels, restrained compact text, polished product sketch. Board title 'MeshPort · 移动端界面草图' and subtitle '应用内组网 / 连接测试 / 稳定性验证'. Every screen common bottom nav four tabs '概览' '节点' '测试' '设置'; appropriate selected tab. Stability under 测试 via segmented subnavigation; logs under 设置 via back navigation, do not add inconsistent nav tabs. Every screen status bar 9:41 battery, restrained header. Values demo only. +Screen 01 概览: MeshPort logo header network selector GameNet, cyan 已连接 card 10.77.0.11 运行02:14:36 small 应用内网络. Hero 28 ms 服务器RTT, tiny upload/download 114/156 kbps, recent60s teal chart ms and time axes, two cards 测试丢包率0.0% 在线节点3/3, Game Server row 10.77.0.2 teal直连28ms. Buttons 开始连接测试 and 断开连接. Overview selected. +Screen02 节点: header 节点 online 3/3, search 搜索节点或虚拟IP, filter 全部 直连 中继. Three distinct rows Game Server 10.77.0.2 直连28ms, Relay Tokyo 10.77.0.3 中继46ms, Laptop10.77.0.12 直连12ms. Expanded Game Server detail card 虚拟IP10.77.0.2 连接方式直连 传输UDP 最近活跃刚刚. button 测试此节点. Nodes selected. +Screen03 连接测试: header 测试 with two tabs 连接测试 selected 稳定性. Fields 目标IP10.77.0.2 端口25565, TCP/UDP segmented TCP selected, explanatory short 'TCP 检查连接;UDP 测试需服务端响应'. button 开始测试. Result cyan card TCP连接成功 28ms. secondary results 发送64KB 接收64KB 数据校验通过, small recent records with times and TCP成功 UDP超时. No imply arbitrary UDP echo support. Test selected. +Screen04 稳定性: header 测试 with tabs 连接测试 稳定性 selected. profile 循环重连 / 持续传输 / 并发连接 selectable chips. target10.77.0.2:25565, count100 interval1s. Running status '测试进行中' 68/100 clear teal progress bar, results 成功68 失败0 平均重连420ms. small trend sparkline, outlined 停止测试, subdued 导出报告. Test selected. +Screen05 日志: back chevron 日志 top export icon, text search 搜索日志, level chips 全部 信息 警告 错误, tidy chronological readable entries 14:32:08 TCP连接成功,14:32:07 直连已建立,14:31:55 节点加入网络,14:31:52 尝试中继连接 amber. Each brief content and timestamp mono. bottom outline 导出日志. Settings selected. +Screen06 设置: header 设置. Network configuration grouped rows 网络名称GameNet, 虚拟IP10.77.0.11, 接入节点2个, 网络密钥 masked bullets with eye icon; 导入配置 and 导出配置 buttons. 日志 row, 自动重连 toggle on. about group 核心版本0.1.0-dev SDK版本0.1.0-dev, 应用内网络 informational small '仅通过SDK接口的连接进入虚拟网络'. No kernel VPN, no permissions to modify whole network. Settings selected. +Keep good whitespace and hierarchy, no clipping, no random duplicated labels, no English brand SwiftWire, no default route or routed apps, no device renders. All screens should visibly belong to same app and be complete within their screenshot bounds. diff --git a/outputs/ui/meshport-mobile-all-screens-v1.png b/outputs/ui/meshport-mobile-all-screens-v1.png new file mode 100644 index 0000000..665435c Binary files /dev/null and b/outputs/ui/meshport-mobile-all-screens-v1.png differ diff --git a/outputs/ui/meshport-mobile-network-config-v2-prompt.txt b/outputs/ui/meshport-mobile-network-config-v2-prompt.txt new file mode 100644 index 0000000..559effd --- /dev/null +++ b/outputs/ui/meshport-mobile-network-config-v2-prompt.txt @@ -0,0 +1,14 @@ +Use case ui-mockup. Create revised MeshPort mobile NETWORK CONFIGURATION design board, four detailed screens in a 2 columns x 2 rows grid, high resolution readable Chinese. Match attached previous mockups exactly in aesthetic: warm ivory, white rounded form groups thin gray border, pale cyan, teal primary controls, charcoal text, mono addresses. Screens full flat front facing, no hardware frames, no perspective. Header board 'MeshPort · 网络配置草图' subtitle '基础接入 / 连接策略 / 高级配置 / 导入校验'. This is proposed design for embedded application-only Rust EasyTier-compatible SDK, supported options still to be verified. Do not imply system VPN, route or DNS changes. All four screens header back chevron 网络配置 and segmented section nav 基础 连接 高级. Screens show selected configuration GameNet; use a small bottom caption board '配置支持范围以 SDK 固定版本为准 · 示例数据'. +Screen01 基础 active: header small GameNet 编辑配置. Identity form fields '配置名称' GameNet (local display name), '节点名称' MeshPort-iPhone, '网络名称' game-net, '认证方式' 网络密钥 chevron, masked 网络密钥 eye. Address card '虚拟地址' segmented '自动分配' selected '手动指定', small 当前地址10.77.0.11, row 虚拟IPv6 可选 chevron. Initial peers card '初始节点' '+添加', two monospace URLs udp://relay.example.com:11010 and tcp://backup.example.com:11010 with remove icons. Small link '共享节点设置 ›'. footer 保存配置 teal and tiny '保存后重新连接生效'. No hostname or addresses that are sensitive. +Screen02 连接 active: group 传输设置 rows '首选协议' UDP chevron, '监听设置' 自动 chevron, '底层IPv6' 启用 toggle, '连接策略' 自动直连与中继 chevron. group 路径选择 '延迟优先' toggle on, 'UDP打洞' toggle on, 'TCP打洞' toggle on; footnote '打洞失败时允许中继'. STUN设置 group 默认服务器 selected and 自定义服务器 chevron, separate IPv4 / IPv6 server lists entries manageable; label 公网映射与UPnP chevron '待验证' neutral badge, not auto on. Footer 保存配置. +Screen03 高级 active: Security group '安全模式' 与服务器一致 chevron, '本地身份密钥' 安全存储 chevron, '临时接入凭据' 可选 chevron, '加密算法' 默认 chevron. relay group '私有模式' toggle on, '外部网络中继' 关闭 row, '中继带宽限制' 未设置 row. run group '运行时线程' 自动 chevron, '更多兼容选项' chevron; label 待SDK验证. subtle informative box '应用内模式' '系统网卡、系统路由和系统DNS选项不在此模式启用'. bottom outline 导入TOML and teal 保存配置. Do not expose disable encryption switch casually, no arbitrary magic-DNS or kernel route toggles. +Screen04 standalone '导入配置' back header, source buttons 文件 粘贴 扫码, small monospace TOML preview real syntactically coherent content: +hostname = "MeshPort-iPhone" +ipv4 = "10.77.0.11" +[[peer]] +uri = "udp://relay.example.com:11010" +[network_identity] +network_name = "game-net" +network_secret = "••••••••" +Use masked preview only not actual valid secret claim. Below '校验结果' checkmark '基础配置可解析', amber '2项系统配置不适用', rows 'dev_name' '系统网卡选项' and 'proxy_forward_by_system' '系统转发选项'. small actionable choice '移除不适用项后导入' unchecked confirmation choice, secondary '查看原始配置'. Export include secrets toggle OFF label '导出包含密钥' (perhaps import screen omit export toggle to keep clear). Footer outline 取消 and teal 导入兼容配置. No silently ignore options, validation explicit. Don't claim schema validation implemented, visual conceptual only. +Layout realistic scrollable forms with bottom safe area, good whitespace but sufficient information, labels must be legible. No bottom main navigation inside config editor. Each screen caption below 01 基础配置 02 连接与传输 03 安全与高级 04 导入与校验. This board supplements previous six main screens. diff --git a/outputs/ui/meshport-mobile-network-config-v2.png b/outputs/ui/meshport-mobile-network-config-v2.png new file mode 100644 index 0000000..7d4c0b1 Binary files /dev/null and b/outputs/ui/meshport-mobile-network-config-v2.png differ diff --git a/outputs/ui/meshport-ui-concept-v1-prompt.txt b/outputs/ui/meshport-ui-concept-v1-prompt.txt new file mode 100644 index 0000000..d1be767 --- /dev/null +++ b/outputs/ui/meshport-ui-concept-v1-prompt.txt @@ -0,0 +1,4 @@ +Use case: ui-mockup. Generate a polished first UI concept sketch board for MeshPort, a cross-platform Flutter tool for validating an embedded Rust EasyTier-compatible application-only virtual networking SDK. Reference image is STYLE REFERENCE ONLY: warm ivory background, restrained teal, ochre relay indicators, monospaced network metrics, fine gray borders, readable spacious rounded cards. Do not copy SwiftWire branding or global VPN functionality. +Composition: landscape high resolution design board, one large desktop dashboard on left (roughly 70% width) and one tall mobile dashboard on right (30%), both fully visible with generous margins, no devices, no perspectives, flat front-facing app screenshots. Small board heading 'MeshPort / UI 草图 · 01'. Realistic cohesive Flutter product layout, simplified and credible rather than marketing. Use readable Chinese labels and English technical terms. +Desktop: slim left sidebar MeshPort simple geometric mesh icon; nav 概览 selected, 节点, 连接测试, 稳定性, 日志, 设置. Main top bar 概览 with network selector 'GameNet' and outline '导入配置'. Teal pale status strip '已连接' '10.77.0.11' '运行 02:14:36' and outline '断开连接'. A quiet scope label '应用内网络' beside status. Four metric blocks '服务器 RTT' 28 ms, '测试丢包率' 0.0%, '在线节点' 3 / 3, '活动连接' 6. Main middle two columns: broad recent-60-seconds teal latency line chart with explicit ms axis; right compact quick-test panel '连接测试' target 10.77.0.2:25565, TCP / UDP segmented control, button '开始测试', status 'TCP 握手成功'. Under chart peer table '节点' rows Game Server 10.77.0.2 '直连' 28 ms, Relay Tokyo '中继节点' RTT 46 ms, Laptop 10.77.0.12 '直连' 12 ms. On bottom right small stability summary '稳定性测试' '循环重连 100 / 100' '数据校验 通过' secondary '查看报告'. Bottom slim event log '14:32:08 已连接 Game Server'. Metric figures are illustrative demo data. +Mobile matching visual: MeshPort header network dropdown GameNet, connected strip 已连接 10.77.0.11, prominent 28 ms RTT with upload download rates 114 / 156 kbps small, compact teal latency chart, two-column cards 测试丢包率 0.0% and 在线节点 3/3, Game Server row direct badge 28ms, primary '开始连接测试' and subtle '断开连接'. Bottom nav 概览 节点 测试 设置. No default route, routed apps, Stop VPN, system VPN toggle or global traffic capture. No blurry text, no redactions, no ornamental fake data. Professional calm refined mockup with subtle pencil-free digital wireframe feel, near-production visual hierarchy. diff --git a/outputs/ui/meshport-ui-concept-v1.png b/outputs/ui/meshport-ui-concept-v1.png new file mode 100644 index 0000000..435ea72 Binary files /dev/null and b/outputs/ui/meshport-ui-concept-v1.png differ diff --git a/scripts/bootstrap-local.sh b/scripts/bootstrap-local.sh new file mode 100755 index 0000000..c64e4e3 --- /dev/null +++ b/scripts/bootstrap-local.sh @@ -0,0 +1,18 @@ +#!/bin/sh +# Optional: install build tools inside work/, leaving the user's shell unchanged. +set -eu +cd "$(dirname "$0")/.." +mkdir -p work/toolchain +curl --fail --location https://sh.rustup.rs -o work/toolchain/rustup-init.sh +export CARGO_HOME="$PWD/work/toolchain/cargo" +export RUSTUP_HOME="$PWD/work/toolchain/rustup" +sh work/toolchain/rustup-init.sh -y --profile minimal --no-modify-path +"$CARGO_HOME/bin/rustup" component add rustfmt clippy +case "$(uname -s)-$(uname -m)" in + Darwin-*) archive="protoc-31.1-osx-universal_binary.zip" ;; + Linux-x86_64) archive="protoc-31.1-linux-x86_64.zip" ;; + Linux-aarch64) archive="protoc-31.1-linux-aarch_64.zip" ;; + *) printf '%s\n' 'Install protoc for this platform manually.'; exit 1 ;; +esac +curl --fail --location "https://github.com/protocolbuffers/protobuf/releases/download/v31.1/$archive" -o work/toolchain/protoc.zip +unzip -q -o work/toolchain/protoc.zip -d work/toolchain/protoc diff --git a/scripts/build-lab-android.sh b/scripts/build-lab-android.sh new file mode 100755 index 0000000..ea372b7 --- /dev/null +++ b/scripts/build-lab-android.sh @@ -0,0 +1,28 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +mode="${1:---release}" +case "$mode" in --debug|--release) ;; *) printf '%s\n' 'usage: build-lab-android.sh [--debug|--release]' >&2; exit 2;; esac +sdk="${ANDROID_SDK_ROOT:-$HOME/Library/Android/sdk}" +ndk="$sdk/ndk/28.2.13676358/toolchains/llvm/prebuilt/darwin-x86_64/bin" +export CARGO_TARGET_AARCH64_LINUX_ANDROID_LINKER="$ndk/aarch64-linux-android26-clang" +export CC_aarch64_linux_android="$CARGO_TARGET_AARCH64_LINUX_ANDROID_LINKER" +export AR_aarch64_linux_android="$ndk/llvm-ar" +export CARGO_TARGET_AARCH64_LINUX_ANDROID_RUSTFLAGS='-C link-arg=-Wl,-z,max-page-size=16384' +if [ "$mode" = --release ]; then + scripts/cargo-local.sh build -p meshport-ffi --target aarch64-linux-android --features system-vpn --release --locked + profile=release +else + scripts/cargo-local.sh build -p meshport-ffi --target aarch64-linux-android --features system-vpn --locked + profile=debug +fi +mkdir -p apps/meshport_lab/android/app/src/main/jniLibs/arm64-v8a +cp "target/aarch64-linux-android/$profile/libmeshport_ffi.so" apps/meshport_lab/android/app/src/main/jniLibs/arm64-v8a/ +build_number=$(date +%s) +cd apps/meshport_lab +flutter build apk "$mode" --target-platform android-arm64 --build-number="$build_number" +cd ../.. +mkdir -p outputs/android +output="$PWD/outputs/android/MeshPort-0.1.0-$build_number-$profile.apk" +cp "apps/meshport_lab/build/app/outputs/flutter-apk/app-$profile.apk" "$output" +printf '%s\n' "$output" diff --git a/scripts/build-lab-macos.sh b/scripts/build-lab-macos.sh new file mode 100755 index 0000000..57c5b5b --- /dev/null +++ b/scripts/build-lab-macos.sh @@ -0,0 +1,16 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +scripts/cargo-local.sh build -p meshport-ffi -p meshport-vpn-helper --locked +root="$PWD" +cd apps/meshport_lab +build_number=$(TZ=Asia/Tokyo date +%Y%m%d%H%M%S) +flutter build macos --debug --build-number="$build_number" +app="$PWD/build/macos/Build/Products/Debug/MeshPort.app" +cp "$root/target/debug/libmeshport_ffi.dylib" "$app/Contents/Frameworks/" +cp "$root/target/debug/meshport-vpn-helper" "$app/Contents/MacOS/" +codesign --force --sign - "$app/Contents/MacOS/meshport-vpn-helper" +codesign --force --sign - "$app/Contents/Frameworks/libmeshport_ffi.dylib" +codesign --force --deep --sign - --entitlements macos/Runner/DebugProfile.entitlements "$app" +touch "$app" +printf '%s\n' "$app" diff --git a/scripts/cargo-local.sh b/scripts/cargo-local.sh new file mode 100755 index 0000000..216102f --- /dev/null +++ b/scripts/cargo-local.sh @@ -0,0 +1,12 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +if [ -x work/toolchain/cargo/bin/cargo ]; then + export CARGO_HOME="$PWD/work/toolchain/cargo" + export RUSTUP_HOME="$PWD/work/toolchain/rustup" + export PATH="$CARGO_HOME/bin:$PATH" +fi +if [ -x work/toolchain/protoc/bin/protoc ]; then + export PROTOC="$PWD/work/toolchain/protoc/bin/protoc" +fi +exec cargo "$@" diff --git a/scripts/generate-app-icons.py b/scripts/generate-app-icons.py new file mode 100644 index 0000000..eafa5bf --- /dev/null +++ b/scripts/generate-app-icons.py @@ -0,0 +1,32 @@ +"""Resize the approved MeshPort artwork into native platform icon assets. + +Requires Pillow. No generation or creative editing of the source artwork. +""" +import json +from pathlib import Path +from PIL import Image + +ROOT = Path(__file__).resolve().parent.parent +APP = ROOT / "apps/meshport_lab" +source = Image.open(ROOT / "outputs/branding/meshport-logo-v1.png").convert("RGBA") + +def write_icon(path, size, opaque=False): + image = source.resize((size, size), Image.Resampling.LANCZOS) + if opaque: + background = Image.new("RGBA", image.size, "#087d8e") + background.alpha_composite(image) + image = background.convert("RGB") + path.parent.mkdir(parents=True, exist_ok=True) + image.save(path) + +for platform in ("macos", "ios"): + directory = APP / platform / "Runner/Assets.xcassets/AppIcon.appiconset" + for item in json.loads((directory / "Contents.json").read_text())["images"]: + if "filename" in item: + pixels = round(float(item["size"].split("x")[0]) * float(item["scale"].rstrip("x"))) + write_icon(directory / item["filename"], pixels, opaque=platform == "ios") + +for density, size in {"mdpi": 48, "hdpi": 72, "xhdpi": 96, "xxhdpi": 144, "xxxhdpi": 192}.items(): + write_icon(APP / f"android/app/src/main/res/mipmap-{density}/ic_launcher.png", size) +source.save(APP / "windows/runner/resources/app_icon.ico", sizes=[(16,16), (32,32), (48,48), (64,64), (128,128), (256,256)]) +write_icon(APP / "assets/branding/meshport.png", 256) diff --git a/scripts/run-lab-macos.sh b/scripts/run-lab-macos.sh new file mode 100755 index 0000000..1a7003a --- /dev/null +++ b/scripts/run-lab-macos.sh @@ -0,0 +1,5 @@ +#!/bin/sh +set -eu +cd "$(dirname "$0")/.." +scripts/build-lab-macos.sh +exec open apps/meshport_lab/build/macos/Build/Products/Debug/MeshPort.app diff --git a/tools/meshport-test-server/Cargo.toml b/tools/meshport-test-server/Cargo.toml new file mode 100644 index 0000000..6e92052 --- /dev/null +++ b/tools/meshport-test-server/Cargo.toml @@ -0,0 +1,8 @@ +[package] +name = "meshport-test-server" +version.workspace = true +edition.workspace = true + +[dependencies] +tokio.workspace = true +anyhow.workspace = true diff --git a/tools/meshport-test-server/src/main.rs b/tools/meshport-test-server/src/main.rs new file mode 100644 index 0000000..582f11a --- /dev/null +++ b/tools/meshport-test-server/src/main.rs @@ -0,0 +1,44 @@ +//! Run on the game server; TCP/UDP echo is separate from the actual game service. +use anyhow::Result; +use tokio::{ + io::{AsyncReadExt, AsyncWriteExt}, + net::{TcpListener, UdpSocket}, +}; +#[tokio::main] +async fn main() -> Result<()> { + let addr = std::env::args() + .nth(1) + .unwrap_or_else(|| "127.0.0.1:7007".into()); + let tcp = TcpListener::bind(&addr).await?; + let udp = UdpSocket::bind(&addr).await?; + println!("MeshPort TCP/UDP echo listening on {addr}"); + let tcp_task = async { + loop { + let (mut socket, _) = tcp.accept().await?; + tokio::spawn(async move { + let mut buffer = [0; 16384]; + loop { + let n = socket.read(&mut buffer).await?; + if n == 0 { + break; + } + socket.write_all(&buffer[..n]).await?; + } + Ok::<_, std::io::Error>(()) + }); + } + #[allow(unreachable_code)] + Ok::<(), std::io::Error>(()) + }; + let udp_task = async { + let mut buffer = [0; 65535]; + loop { + let (n, peer) = udp.recv_from(&mut buffer).await?; + udp.send_to(&buffer[..n], peer).await?; + } + #[allow(unreachable_code)] + Ok::<(), std::io::Error>(()) + }; + tokio::try_join!(tcp_task, udp_task)?; + Ok(()) +} diff --git a/tools/meshport-vpn-helper/Cargo.toml b/tools/meshport-vpn-helper/Cargo.toml new file mode 100644 index 0000000..ec98283 --- /dev/null +++ b/tools/meshport-vpn-helper/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "meshport-vpn-helper" +version.workspace = true +edition.workspace = true +rust-version.workspace = true +[dependencies] +meshport-ffi = { path = "../../crates/meshport-ffi", features = ["system-vpn"] } +meshport-easytier.workspace = true +serde_json.workspace = true +anyhow.workspace = true +libc = "0.2" +meshport.workspace = true +tokio.workspace = true + +easytier.workspace = true +easytier-core.workspace = true diff --git a/tools/meshport-vpn-helper/src/mac/self_test.rs b/tools/meshport-vpn-helper/src/mac/self_test.rs new file mode 100644 index 0000000..f9bf1ff --- /dev/null +++ b/tools/meshport-vpn-helper/src/mac/self_test.rs @@ -0,0 +1,135 @@ +//! Privileged test: overlay 10.253.77.0/24, advertised subnet 10.253.78.0/24, loopback. +use anyhow::{Context, Result, ensure}; +use meshport::Network; +use meshport_easytier::ConfigLoader; +use std::{process::Command, time::Duration}; +use tokio::io::{AsyncReadExt, AsyncWriteExt}; +fn default_route() -> Result> { + let output = Command::new("/sbin/route") + .args(["-n", "get", "default"]) + .output()?; + ensure!(output.status.success(), "cannot record default route"); + Ok(output.stdout) +} +fn stage(value: &str) { + use std::io::Write; + let path = format!("/tmp/meshport-vpn-self-test-{}.log", std::process::id()); + let mut log = std::fs::OpenOptions::new().append(true).open(path).unwrap(); + writeln!(log, "{value}").unwrap(); +} +pub fn run() -> Result<()> { + use std::os::unix::fs::OpenOptionsExt; + std::fs::OpenOptions::new() + .write(true) + .create_new(true) + .mode(0o644) + .open(format!( + "/tmp/meshport-vpn-self-test-{}.log", + std::process::id() + ))?; + // Self-test must not leave privileged interfaces behind if an upstream task stalls. + std::thread::spawn(|| { + std::thread::sleep(Duration::from_secs(45)); + std::process::exit(2); + }); + stage("preflight"); + tokio::runtime::Runtime::new()?.block_on(async { + let before = default_route()?; + let port = std::net::UdpSocket::bind("127.0.0.1:0")?.local_addr()?.port(); + let identity = "[network_identity]\nnetwork_name = 'meshport-vpn-self-test'\nnetwork_secret = 'test-only'\n"; + let system_config = format!("ipv4 = '10.253.77.11/24'\nlisteners = []\nstun_servers = []\nstun_servers_v6 = []\n[[peer]]\nuri = 'udp://127.0.0.1:{port}'\n{identity}[runtime]\nmode = 'system_vpn'"); + super::overlap_preflight(&system_config)?; + stage("starting application server"); + let server_config = easytier::common::config::TomlConfigLoader::new_from_str(&format!( + "ipv4 = '10.253.78.2/24'\nstun_servers = []\nstun_servers_v6 = []\nlisteners = ['udp://127.0.0.1:{port}']\n[[proxy_network]]\ncidr = '10.253.78.0/24'\n{identity}[flags]\nno_tun = true\nuse_smoltcp = true" + ))?; + let server = easytier::instance::factory::create_native_instance(server_config.clone())?; + server.start().await?; + stage("starting system VPN"); + let vpn = match Network::start(&system_config).await { Ok(v) => v, Err(e) => { server.stop().await; return Err(e); } }; + stage("system started, collecting snapshot"); + let snapshot = vpn.snapshot().await; + stage("snapshot ready"); + let interface = snapshot["platform_network"]["interface_name"].as_str().map(str::to_owned); + let result = async { + ensure!(snapshot["platform_network"]["ready"] == true, "TUN not ready"); + stage("TCP listener"); + let mut listener = server.data_plane_tcp_bind(7007, Duration::from_secs(5)).await?; + let tcp_port = 7007; + let echo = tokio::spawn(async move { + let (mut stream, _) = listener.accept().await?; + let mut bytes = [0; 128]; let n = stream.read(&mut bytes).await?; + stream.write_all(&bytes[..n]).await?; + let _ = stream.read(&mut bytes).await; + Ok::<_, anyhow::Error>(()) + }); + let started = std::time::Instant::now(); + while vpn.snapshot().await["peer_count"] == 0 { + ensure!(started.elapsed() < Duration::from_secs(10), "peer discovery timeout"); + tokio::time::sleep(Duration::from_millis(100)).await; + } + while !vpn.snapshot().await["platform_network"]["subnet_routes"].as_array() + .is_some_and(|routes| routes.iter().any(|r| r == "10.253.78.0/24")) { + ensure!(started.elapsed() < Duration::from_secs(10), "advertised subnet learning timeout"); + tokio::time::sleep(Duration::from_millis(100)).await; + } + tokio::time::sleep(Duration::from_secs(2)).await; + // Ordinary OS TCP socket: no MeshPort data-plane API on the client. + let route = Command::new("/sbin/route").args(["-n", "get", "10.253.78.2"]).output()?; + let route = String::from_utf8_lossy(&route.stdout); + ensure!(route.lines().any(|line| line.trim() == format!("interface: {}", interface.as_deref().unwrap())), "learned subnet does not use VPN interface"); + stage("OS TCP connect via learned subnet"); + let mut tcp = tokio::net::TcpStream::connect(format!("10.253.78.2:{tcp_port}")).await?; + tcp.write_all(b"OS TCP via utun").await?; + let mut bytes = [0; 15]; tcp.read_exact(&mut bytes).await?; + ensure!(&bytes == b"OS TCP via utun", "TCP echo mismatch"); + drop(tcp); echo.await??; + stage("TCP passed, OS UDP probe"); + let udp_server = server.data_plane_udp_bind(7008, Duration::from_secs(5)).await?; + let udp_port = 7008; + let udp_client = tokio::net::UdpSocket::bind("10.253.77.11:0").await?; + udp_server.send_to(b"warmup", udp_client.local_addr()?).await?; + tokio::time::sleep(Duration::from_millis(100)).await; + udp_client.send_to(b"OS UDP via utun", format!("10.253.78.2:{udp_port}")).await?; + let mut bytes = [0; 128]; let (n, target) = udp_server.recv_from(&mut bytes).await?; + udp_server.send_to(&bytes[..n], target).await?; + loop { + let (n, _) = udp_client.recv_from(&mut bytes).await?; + if &bytes[..n] == b"warmup" { continue; } + ensure!(&bytes[..n] == b"OS UDP via utun", "UDP echo mismatch"); break; + } + ensure!(default_route()? == before, "default route changed"); + stage("withdrawing advertised subnet"); + server_config.clear_proxy_cidrs(); + let config = easytier_core::instance::CoreInstanceConfig::from_toml(&server_config)?; + server.update_runtime_config(easytier_core::config::runtime::CoreInstanceRuntimeConfig { + services: config.connectivity.runtime, + peer: std::sync::Arc::new(config.peer.snapshot), + }).await?; + let withdrawn = std::time::Instant::now(); + loop { + let route = Command::new("/sbin/route").args(["-n", "get", "10.253.78.2"]).output()?; + if !String::from_utf8_lossy(&route.stdout).lines().any(|line| line.trim() == format!("interface: {}", interface.as_deref().unwrap())) { break; } + ensure!(withdrawn.elapsed() < Duration::from_secs(12), "withdrawn route was not removed"); + tokio::time::sleep(Duration::from_millis(200)).await; + } + stage("withdrawal passed"); + Ok::<_, anyhow::Error>(()) + }; + let result = tokio::time::timeout(Duration::from_secs(35), result).await; + stage("stopping VPN"); + vpn.stop().await; + stage("VPN stopped"); server.stop().await; + tokio::time::sleep(Duration::from_millis(500)).await; + if let Some(interface) = interface { + let after = Command::new("/sbin/route").args(["-n", "get", "10.253.78.2"]).output()?; + ensure!(!String::from_utf8_lossy(&after.stdout).lines().any(|line| line.trim() == format!("interface: {interface}")), "subnet route still uses removed interface"); + ensure!(!Command::new("/sbin/ifconfig").arg(interface).output()?.status.success(), "TUN still exists after stop"); + } + ensure!(default_route()? == before, "default route changed after stop"); + result.context("system socket test timed out")??; + stage("PASS"); + println!("PASS: learned subnet route → OS TCP/UDP → utun → EasyTier; withdrawn route and interface removed, default route unchanged"); + Ok(()) + }) +} diff --git a/tools/meshport-vpn-helper/src/main.rs b/tools/meshport-vpn-helper/src/main.rs new file mode 100644 index 0000000..61f078b --- /dev/null +++ b/tools/meshport-vpn-helper/src/main.rs @@ -0,0 +1,210 @@ +//! Development-only macOS privileged transport. No persistent root service. +#[cfg(target_os = "macos")] +mod mac { + mod self_test; + use anyhow::{Context, Result, bail, ensure}; + use meshport_easytier::ConfigLoader; + use std::{ + ffi::{CStr, CString}, + io::{Read, Write}, + os::fd::AsRawFd, + os::unix::net::UnixStream, + sync::atomic::{AtomicBool, Ordering}, + time::{Duration, Instant}, + }; + static QUIT: AtomicBool = AtomicBool::new(false); + static BUSY_SINCE: std::sync::Mutex> = std::sync::Mutex::new(None); + extern "C" fn signal(_: libc::c_int) { + QUIT.store(true, Ordering::Relaxed); + } + struct ContextHandle(u64); + impl Drop for ContextHandle { + fn drop(&mut self) { + *BUSY_SINCE.lock().unwrap() = Some(Instant::now()); + meshport_ffi::meshport_context_free(self.0); + *BUSY_SINCE.lock().unwrap() = None; + } + } + fn call(id: u64, value: &serde_json::Value) -> Result { + let input = CString::new(value.to_string())?; + unsafe { + let p = meshport_ffi::meshport_call(id, input.as_ptr()); + ensure!(!p.is_null(), "native response missing"); + let decoded = serde_json::from_slice(CStr::from_ptr(p).to_bytes()); + meshport_ffi::meshport_string_free(p); + Ok(decoded?) + } + } + fn overlap_preflight(config: &str) -> Result<()> { + let config = meshport_easytier::parse_config(config)?; + ensure!( + !config.get_flags().no_tun, + "helper accepts only system_vpn mode" + ); + let overlay = config.get_ipv4().context("static overlay IPv4 required")?; + let mut head = std::ptr::null_mut(); + unsafe { + ensure!( + libc::getifaddrs(&mut head) == 0, + "cannot inspect existing interfaces" + ); + let mut p = head; + let mut conflict = false; + while !p.is_null() { + let row = &*p; + if !row.ifa_addr.is_null() + && !row.ifa_netmask.is_null() + && (*row.ifa_addr).sa_family as i32 == libc::AF_INET + { + let a = &*(row.ifa_addr as *const libc::sockaddr_in); + let m = &*(row.ifa_netmask as *const libc::sockaddr_in); + let ip = u32::from_be(a.sin_addr.s_addr); + let mask = u32::from_be(m.sin_addr.s_addr); + let networks = + std::iter::once((overlay.first_address(), overlay.network_length())).chain( + config + .get_routes() + .unwrap_or_default() + .into_iter() + .map(|r| (r.first_address(), r.network_length())), + ); + if networks.into_iter().any(|(base, prefix)| { + let overlay_mask = u32::MAX << (32 - prefix); + ip & mask & overlay_mask == u32::from(base) & mask & overlay_mask + }) { + conflict = true; + break; + } + } + p = row.ifa_next; + } + libc::freeifaddrs(head); + ensure!( + !conflict, + "overlay or selected subnet overlaps an existing interface; choose another subnet or stop the conflicting VPN" + ); + } + Ok(()) + } + fn dispatch(id: u64, request: serde_json::Value) -> serde_json::Value { + let result = (|| -> Result { + match request["op"].as_str() { + Some("start") => { + overlap_preflight(request["toml"].as_str().context("missing toml")?)? + } + Some("stop" | "status" | "probe" | "validate" | "diagnostics_enable") => {} + _ => bail!("operation unavailable in system VPN helper"), + } + call(id, &request) + })(); + result.unwrap_or_else(|e| serde_json::json!({"ok": false, "error": e.to_string()})) + } + fn serve(id: u64, reader: &mut impl Read, writer: &mut impl Write) -> Result<()> { + let mut line = Vec::new(); + let mut last = Instant::now(); + loop { + if QUIT.load(Ordering::Relaxed) || last.elapsed() > Duration::from_secs(120) { + break; + } + let mut buffer = [0; 4096]; + let n = match reader.read(&mut buffer) { + Ok(0) => break, + Ok(n) => n, + Err(e) + if matches!( + e.kind(), + std::io::ErrorKind::WouldBlock + | std::io::ErrorKind::TimedOut + | std::io::ErrorKind::Interrupted + ) => + { + continue; + } + Err(e) => return Err(e.into()), + }; + last = Instant::now(); + for b in &buffer[..n] { + if *b != b'\n' { + line.push(*b); + ensure!(line.len() <= 131072, "request exceeds limit"); + continue; + } + let request = serde_json::from_slice(&line)?; + line.clear(); + *BUSY_SINCE.lock().unwrap() = Some(Instant::now()); + let response = dispatch(id, request); + *BUSY_SINCE.lock().unwrap() = None; + serde_json::to_writer(&mut *writer, &response)?; + writer.write_all(b"\n")?; + writer.flush()?; + } + } + Ok(()) + } + pub fn run() -> Result<()> { + ensure!( + unsafe { libc::geteuid() } == 0, + "administrator authorization is required" + ); + // Upstream interface commands must resolve from system directories only. + unsafe { + std::env::set_var("PATH", "/usr/bin:/bin:/usr/sbin:/sbin"); + libc::signal(libc::SIGTERM, signal as *const () as libc::sighandler_t); + libc::signal(libc::SIGINT, signal as *const () as libc::sighandler_t); + } + // Closing the process also closes all utun FDs if a native operation stalls. + std::thread::spawn(|| { + loop { + std::thread::sleep(Duration::from_secs(1)); + if BUSY_SINCE + .lock() + .unwrap() + .is_some_and(|at| at.elapsed() > Duration::from_secs(60)) + { + std::process::exit(2); + } + } + }); + *BUSY_SINCE.lock().unwrap() = Some(Instant::now()); + let args: Vec<_> = std::env::args().skip(1).collect(); + if args == ["--self-test"] { + *BUSY_SINCE.lock().unwrap() = None; + return self_test::run(); + } + let handle = ContextHandle(meshport_ffi::meshport_context_new()); + ensure!(handle.0 != 0, "could not create network context"); + *BUSY_SINCE.lock().unwrap() = None; + if args == ["--stdio"] { + return serve(handle.0, &mut std::io::stdin(), &mut std::io::stdout()); + } + ensure!( + args.len() == 4 && args[0] == "--socket" && args[2] == "--uid", + "usage: meshport-vpn-helper --socket PATH --uid UID | --stdio" + ); + let uid: libc::uid_t = args[3].parse()?; + ensure!(uid != 0, "GUI must run as an ordinary user"); + let mut stream = UnixStream::connect(&args[1])?; + let (mut peer_uid, mut peer_gid) = (0, 0); + ensure!( + unsafe { libc::getpeereid(stream.as_raw_fd(), &mut peer_uid, &mut peer_gid) } == 0 + && peer_uid == uid, + "unexpected control socket owner" + ); + stream.set_read_timeout(Some(Duration::from_secs(1)))?; + stream.set_write_timeout(Some(Duration::from_secs(5)))?; + let mut output = stream.try_clone()?; + serve(handle.0, &mut stream, &mut output) + } +} +fn main() { + #[cfg(target_os = "macos")] + if let Err(e) = mac::run() { + eprintln!("MeshPort VPN helper: {e}"); + std::process::exit(1); + } + #[cfg(not(target_os = "macos"))] + { + eprintln!("system VPN helper currently supports macOS only"); + std::process::exit(1); + } +} diff --git a/vendor/easytier/Cargo.lock b/vendor/easytier/Cargo.lock new file mode 100644 index 0000000..24187a0 --- /dev/null +++ b/vendor/easytier/Cargo.lock @@ -0,0 +1,12521 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "ab_glyph" +version = "0.2.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "01c0457472c38ea5bd1c3b5ada5e368271cb550be7a4ca4a0b4634e9913f6cc2" +dependencies = [ + "ab_glyph_rasterizer", + "owned_ttf_parser", +] + +[[package]] +name = "ab_glyph_rasterizer" +version = "0.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "366ffbaa4442f4684d91e2cd7c5ea7c4ed8add41959a31447066e279e432b618" + +[[package]] +name = "adler2" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa" + +[[package]] +name = "aead" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d122413f284cf2d62fb1b7db97e02edb8cda96d769b16e443a4f6195e35662b0" +dependencies = [ + "crypto-common 0.1.7", + "generic-array", +] + +[[package]] +name = "aead" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1973cfbc1a2daf9cf550e74e1f088c28e7f7d8c1e1418fb6c9dc5184b7e84c99" +dependencies = [ + "crypto-common 0.2.2", + "inout 0.2.2", +] + +[[package]] +name = "aes" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b169f7a6d4742236a0a00c541b845991d0ac43e546831af1249753ab4c3aa3a0" +dependencies = [ + "cfg-if", + "cipher 0.4.4", + "cpufeatures 0.2.17", +] + +[[package]] +name = "aes" +version = "0.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "35f0f96ce78e38c3dc6d8948aa8163d06385be74000f3c7a95bf1eef35d3ea32" +dependencies = [ + "cipher 0.5.2", + "cpubits", + "cpufeatures 0.3.1", +] + +[[package]] +name = "aes-gcm" +version = "0.10.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "831010a0f742e1209b3bcea8fab6a8e149051ba6099432c8cb2cc117dec3ead1" +dependencies = [ + "aead 0.5.2", + "aes 0.8.4", + "cipher 0.4.4", + "ctr", + "ghash", + "subtle", +] + +[[package]] +name = "ahash" +version = "0.8.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a15f179cd60c4584b8a8c596927aadc462e27f2ca70c04e0071964a73ba7a75" +dependencies = [ + "cfg-if", + "once_cell", + "version_check", + "zerocopy 0.8.57", +] + +[[package]] +name = "aho-corasick" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c982642fa9e8606056828ee9a8505737230110bb1099153c79efe865c59d12ba" +dependencies = [ + "memchr", +] + +[[package]] +name = "aliasable" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "250f629c0161ad8107cf89319e990051fae62832fd343083bea452d93e2205fd" + +[[package]] +name = "alloc-no-stdlib" +version = "2.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc7bb162ec39d46ab1ca8c77bf72e890535becd1751bb45f64c597edb4c8c6b3" + +[[package]] +name = "alloc-stdlib" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0e76a019e91224d279006ff972f1e984179a6e9feb050adba6ce8274aef23195" +dependencies = [ + "alloc-no-stdlib", +] + +[[package]] +name = "alloca" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5a7d05ea6aea7e9e64d25b9156ba2fee3fdd659e34e41063cd2fc7cd020d7f4" +dependencies = [ + "cc", +] + +[[package]] +name = "allocator-api2" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "683d7910e743518b0e34f1186f92494becacb047c7b6bf616c96772180fef923" + +[[package]] +name = "android_log-sys" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "84521a3cf562bc62942e294181d9eef17eb38ceb8c68677bc49f144e4c3d4f8d" + +[[package]] +name = "android_logger" +version = "0.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dbb4e440d04be07da1f1bf44fb4495ebd58669372fe0cffa6e48595ac5bd88a3" +dependencies = [ + "android_log-sys", + "env_filter", + "log", +] + +[[package]] +name = "android_system_properties" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae221649c9976a6f6c56ae1facf410f3ddb33cc661c4b7b61020a912d4237fbc" +dependencies = [ + "libc", +] + +[[package]] +name = "anes" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4b46cbb362ab8752921c97e041f5e366ee6297bd428a31275b9fcf1e380f7299" + +[[package]] +name = "annotate-snippets" +version = "0.12.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f211a51805bc641f3ad5b7664c77d2547af685cc33b4cd8d31964027a46f13f1" +dependencies = [ + "anstyle", + "memchr", + "unicode-width", +] + +[[package]] +name = "anstream" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "824a212faf96e9acacdbd09febd34438f8f711fb84e09a8916013cd7815ca28d" +dependencies = [ + "anstyle", + "anstyle-parse", + "anstyle-query", + "anstyle-wincon", + "colorchoice", + "is_terminal_polyfill", + "utf8parse", +] + +[[package]] +name = "anstyle" +version = "1.0.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "940b3a0ca603d1eade50a4846a2afffd5ef57a9feac2c0e2ec2e14f9ead76000" + +[[package]] +name = "anstyle-parse" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52ce7f38b242319f7cabaa6813055467063ecdc9d355bbb4ce0c68908cd8130e" +dependencies = [ + "utf8parse", +] + +[[package]] +name = "anstyle-query" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "40c48f72fd53cd289104fc64099abca73db4166ad86ea0b4341abe65af83dadc" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "anstyle-wincon" +version = "3.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d" +dependencies = [ + "anstyle", + "once_cell_polyfill", + "windows-sys 0.61.2", +] + +[[package]] +name = "anyhow" +version = "1.0.104" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "330a5ed07fa54e4702c9d6c4174f74427fc0ef6e214bbd677ae50a5099946470" + +[[package]] +name = "approx" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cab112f0a86d568ea0e627cc1d6be74a1e9cd55214684db5561995f6dad897c6" +dependencies = [ + "num-traits", +] + +[[package]] +name = "arboard" +version = "3.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0348a1c054491f4bfe6ab86a7b6ab1e44e45d899005de92f58b3df180b36ddaf" +dependencies = [ + "clipboard-win", + "image", + "log", + "objc2", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-core-graphics", + "objc2-foundation", + "parking_lot", + "percent-encoding", + "windows-sys 0.60.2", + "wl-clipboard-rs", + "x11rb", +] + +[[package]] +name = "arc-swap" +version = "1.9.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c049c0be4daef0b145cb3555416b3b8ef5b7888a38aea1a3a155801fe7b0810b" +dependencies = [ + "rustversion", +] + +[[package]] +name = "argon2" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c3610892ee6e0cbce8ae2700349fcf8f98adb0dbfbee85aec3c9179d29cc072" +dependencies = [ + "base64ct", + "blake2 0.10.6", + "cpufeatures 0.2.17", + "password-hash", +] + +[[package]] +name = "ariadne" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8454c8a44ce2cb9cc7e7fae67fc6128465b343b92c6631e94beca3c8d1524ea5" +dependencies = [ + "unicode-width", + "yansi", +] + +[[package]] +name = "array-const-fn-init" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8bcb85e548c05d407fa6faff46b750ba287714ef32afc0f5e15b4641ffd6affb" + +[[package]] +name = "arraydeque" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d902e3d592a523def97af8f317b08ce16b7ab854c1985a0c671e6f15cebc236" + +[[package]] +name = "arrayvec" +version = "0.7.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3fb67a6e08acf24fdeccbac2cb6ac4305825bd1f117462e0e6f2f193345ad56" + +[[package]] +name = "asn1-rs" +version = "0.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7f43a50ac4fdca5df8e885c21b835997f0a1cdee65494a6847694a98652d9d8" +dependencies = [ + "asn1-rs-derive", + "asn1-rs-impl", + "displaydoc", + "nom 7.1.3", + "num-traits", + "rusticata-macros", + "thiserror 2.0.20", + "time", +] + +[[package]] +name = "asn1-rs-derive" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3109e49b1e4909e9db6515a30c633684d68cdeaa252f215214cb4fa1a5bfee2c" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", + "synstructure 0.13.2", +] + +[[package]] +name = "asn1-rs-impl" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b18050c2cd6fe86c3a76584ef5e0baf286d038cda203eb6223df2cc413565f7" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "async-broadcast" +version = "0.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "435a87a52755b8f27fcf321ac4f04b2802e337c8c4872923137471ec39c37532" +dependencies = [ + "event-listener", + "event-listener-strategy", + "futures-core", + "pin-project-lite", +] + +[[package]] +name = "async-channel" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "924ed96dd52d1b75e9c1a3e6275715fd320f5f9439fb5a4a11fa51f4221158d2" +dependencies = [ + "concurrent-queue", + "event-listener-strategy", + "futures-core", + "pin-project-lite", +] + +[[package]] +name = "async-compression" +version = "0.4.48" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fb61aea1a7def73ee7c350a184f0e70b32c182344e2e75bf70c9b621b83417fd" +dependencies = [ + "compression-codecs", + "compression-core", + "pin-project-lite", + "tokio", +] + +[[package]] +name = "async-executor" +version = "1.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c96bf972d85afc50bf5ab8fe2d54d1586b4e0b46c97c50a0c9e71e2f7bcd812a" +dependencies = [ + "async-task", + "concurrent-queue", + "fastrand", + "futures-lite", + "pin-project-lite", + "slab", +] + +[[package]] +name = "async-io" +version = "2.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "456b8a8feb6f42d237746d4b3e9a178494627745c3c56c6ea55d92ba50d026fc" +dependencies = [ + "autocfg", + "cfg-if", + "concurrent-queue", + "futures-io", + "futures-lite", + "parking", + "polling", + "rustix 1.1.5", + "slab", + "windows-sys 0.61.2", +] + +[[package]] +name = "async-lock" +version = "3.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "290f7f2596bd5b78a9fec8088ccd89180d7f9f55b94b0576823bbbdc72ee8311" +dependencies = [ + "event-listener", + "event-listener-strategy", + "pin-project-lite", +] + +[[package]] +name = "async-process" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc50921ec0055cdd8a16de48773bfeec5c972598674347252c0399676be7da75" +dependencies = [ + "async-channel", + "async-io", + "async-lock", + "async-signal", + "async-task", + "blocking", + "cfg-if", + "event-listener", + "futures-lite", + "rustix 1.1.5", +] + +[[package]] +name = "async-recursion" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b43422f69d8ff38f95f1b2bb76517c91589a924d1559a0e935d7c8ce0274c11" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "async-ringbuf" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6b71bf1a7acc4f0941e853c630427f7a87545cc008fe60f2f1ae4a04add8a78" +dependencies = [ + "futures-util", + "ringbuf", +] + +[[package]] +name = "async-signal" +version = "0.2.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52b5aaafa020cf5053a01f2a60e8ff5dccf550f0f77ec54a4e47285ac2bab485" +dependencies = [ + "async-io", + "async-lock", + "atomic-waker", + "cfg-if", + "futures-core", + "futures-io", + "rustix 1.1.5", + "signal-hook-registry", + "slab", + "windows-sys 0.61.2", +] + +[[package]] +name = "async-stream" +version = "0.3.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b5a71a6f37880a80d1d7f19efd781e4b5de42c88f0722cc13bcb6cc2cfe8476" +dependencies = [ + "async-stream-impl", + "futures-core", + "pin-project-lite", +] + +[[package]] +name = "async-stream-impl" +version = "0.3.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7c24de15d275a1ecfd47a380fb4d5ec9bfe0933f309ed5e705b775596a3574d" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "async-task" +version = "4.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8b75356056920673b02621b35afd0f7dda9306d03c79a30f5c56c44cf256e3de" + +[[package]] +name = "async-trait" +version = "0.1.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "atk" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "241b621213072e993be4f6f3a9e4b45f65b7e6faad43001be957184b7bb1824b" +dependencies = [ + "atk-sys", + "glib", + "libc", +] + +[[package]] +name = "atk-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c5e48b684b0ca77d2bbadeef17424c2ea3c897d44d566a1617e7e8f30614d086" +dependencies = [ + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "atoi" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f28d99ec8bfea296261ca1af174f24225171fea9664ba9003cbebee704810528" +dependencies = [ + "num-traits", +] + +[[package]] +name = "atomic-shim" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67cd4b51d303cf3501c301e8125df442128d3c6d7c69f71b27833d253de47e77" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "atomic-waker" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" + +[[package]] +name = "atomic-write-file" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae67d5c03ee972c101a1d8db3ddbf8a9c819ad1ea9d6fd9cd385605547b60edb" +dependencies = [ + "nix 0.31.3", + "rand 0.10.2", +] + +[[package]] +name = "atomic_refcell" +version = "0.1.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "21e4227379beff4205943696e6c3e0cd809bacdf3f0edd6e3dd153e2269571a4" + +[[package]] +name = "auto_impl" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ffdcb70bdbc4d478427380519163274ac86e52916e10f0a8889adf0f96d3fee7" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "autocfg" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53" + +[[package]] +name = "aws-lc-rs" +version = "1.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b281d307588d634de920874890732659e2e7672f72b5e10e81badc1a8a83621e" +dependencies = [ + "aws-lc-sys", + "zeroize", +] + +[[package]] +name = "aws-lc-sys" +version = "0.45.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9bff6c3b54fad79a2e60b8102caf565819711497c1f5f092f49508e2f5c31b27" +dependencies = [ + "cc", + "cmake", + "dunce", + "fs_extra", + "pkg-config", +] + +[[package]] +name = "axum" +version = "0.8.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "31b698c5f9a010f6573133b09e0de5408834d0c82f8d7475a89fc1867a71cd90" +dependencies = [ + "axum-core 0.5.6", + "axum-macros", + "bytes", + "form_urlencoded", + "futures-util", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-util", + "itoa", + "matchit", + "memchr", + "mime", + "percent-encoding", + "pin-project-lite", + "serde_core", + "serde_json", + "serde_path_to_error", + "serde_urlencoded", + "sync_wrapper", + "tokio", + "tower", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "axum-core" +version = "0.4.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09f2bd6146b97ae3359fa0cc6d6b376d9539582c7b4220f041a33ec24c226199" +dependencies = [ + "async-trait", + "bytes", + "futures-util", + "http", + "http-body", + "http-body-util", + "mime", + "pin-project-lite", + "rustversion", + "sync_wrapper", + "tower-layer", + "tower-service", +] + +[[package]] +name = "axum-core" +version = "0.5.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08c78f31d7b1291f7ee735c1c6780ccde7785daae9a9206026862dab7d8792d1" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "http-body-util", + "mime", + "pin-project-lite", + "sync_wrapper", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "axum-embed" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "077959a7f8cf438676af90b483304528eb7e16eadadb7f44e9ada4f9dceb9e62" +dependencies = [ + "axum-core 0.4.5", + "chrono", + "http", + "mime_guess", + "rust-embed", + "tower-service", +] + +[[package]] +name = "axum-extra" +version = "0.12.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be44683b41ccb9ab2d23a5230015c9c3c55be97a25e4428366de8873103f7970" +dependencies = [ + "axum", + "axum-core 0.5.6", + "bytes", + "form_urlencoded", + "futures-core", + "futures-util", + "http", + "http-body", + "http-body-util", + "mime", + "pin-project-lite", + "serde_core", + "serde_html_form", + "serde_path_to_error", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "axum-login" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "964ea6eb764a227baa8c3368e45c94d23b6863cc7b880c6c9e341c143c5a5ff7" +dependencies = [ + "axum", + "form_urlencoded", + "serde", + "subtle", + "thiserror 2.0.20", + "tower-cookies", + "tower-layer", + "tower-service", + "tower-sessions", + "tracing", + "urlencoding", +] + +[[package]] +name = "axum-macros" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7aa268c23bfbbd2c4363b9cd302a4f504fb2a9dfe7e3451d66f35dd392e20aca" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "axum-messages" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d67ce6e7bc1e1e71f2a4e86d418045a29c63c4ebb631f3d9bb2f81c4958ea391" +dependencies = [ + "axum-core 0.5.6", + "http", + "parking_lot", + "serde", + "serde_json", + "tower", + "tower-sessions-core", + "tracing", +] + +[[package]] +name = "base16ct" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4c7f02d4ea65f2c1853089ffd8d2787bdbc63de2f0d29dedbcf8ccdfa0ccd4cf" + +[[package]] +name = "base62" +version = "2.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3a647dce9631f152a99ec16cfc09267ae55fe280d5dc288964027d458076323" + +[[package]] +name = "base64" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e1b586273c5702936fe7b7d6896644d8be71e6314cfe09d3167c95f712589e8" + +[[package]] +name = "base64" +version = "0.21.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d297deb1925b89f2ccc13d7635fa0714f12c87adce1c75356b39ca9b7178567" + +[[package]] +name = "base64" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" + +[[package]] +name = "base64" +version = "0.23.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac07cdecf99051d9a5238b80f35af32cdeba5b336e55d957b318b50137e18da5" + +[[package]] +name = "base64ct" +version = "1.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2af50177e190e07a26ab74f8b1efbfe2ef87da2116221318cb1c2e82baf7de06" + +[[package]] +name = "bigdecimal" +version = "0.4.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4d6867f1565b3aad85681f1015055b087fcfd840d6aeee6eee7f2da317603695" +dependencies = [ + "autocfg", + "libm", + "num-bigint", + "num-integer", + "num-traits", + "serde", +] + +[[package]] +name = "bindgen" +version = "0.72.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "993776b509cfb49c750f11b8f07a46fa23e0a1386ffc01fb1e7d343efc387895" +dependencies = [ + "bitflags 2.13.2", + "cexpr", + "clang-sys", + "itertools 0.13.0", + "proc-macro2", + "quote", + "regex", + "rustc-hash", + "shlex 1.3.0", + "syn 2.0.119", +] + +[[package]] +name = "bit-set" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08807e080ed7f9d5433fa9b275196cfc35414f66a0c79d864dc51a0d825231a3" +dependencies = [ + "bit-vec 0.8.0", +] + +[[package]] +name = "bit-vec" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e764a1d40d510daf35e07be9eb06e75770908c27d411ee6c92109c9840eaaf7" + +[[package]] +name = "bit-vec" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b71798fca2c1fe1086445a7258a4bc81e6e49dcd24c8d0dd9a1e57395b603f51" +dependencies = [ + "serde", +] + +[[package]] +name = "bitflags" +version = "1.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" + +[[package]] +name = "bitflags" +version = "2.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06" +dependencies = [ + "serde_core", +] + +[[package]] +name = "blake2" +version = "0.10.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "46502ad458c9a52b69d4d4d32775c788b7a1b85e8bc9d482d92250fc0e3f8efe" +dependencies = [ + "digest 0.10.7", +] + +[[package]] +name = "blake2" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5b5d4d889834ee8ecfc0f8426ad30faf7cdcb10f741a8e6d7224d95325479f6f" +dependencies = [ + "digest 0.11.3", +] + +[[package]] +name = "block-buffer" +version = "0.10.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71" +dependencies = [ + "generic-array", +] + +[[package]] +name = "block-buffer" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d2f6c7dbe95a6ed67ad9f18e57daf93a2f034c524b99fd2b76d18fdfeb6660aa" +dependencies = [ + "hybrid-array", + "zeroize", +] + +[[package]] +name = "block2" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cdeb9d870516001442e364c5220d3574d2da8dc765554b4a617230d33fa58ef5" +dependencies = [ + "objc2", +] + +[[package]] +name = "blocking" +version = "1.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a70e4329df6cb94385eed412ec92375c3cdd8a6e502493d1229b6414e4036dfa" +dependencies = [ + "async-channel", + "async-task", + "futures-io", + "futures-lite", + "piper", +] + +[[package]] +name = "bon" +version = "3.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60eafe0d77c3a2fc292c1d1346c3041b33c0a108085a2afabf672b70f69dbbc9" +dependencies = [ + "bon-macros", +] + +[[package]] +name = "bon-macros" +version = "3.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bd0f9631d8aaaee112c41985d675ef269e02acbd4f33122836af4f0c5f699ff6" +dependencies = [ + "darling 0.24.1", + "ident_case", + "prettyplease 0.3.0", + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "boringtun-easytier" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2f09b4d1ada8affba260cb185bbdf6d5acff42f924dea1a17f938cf3e8fbe475" +dependencies = [ + "aead 0.5.2", + "atomic-shim", + "base64 0.13.1", + "blake2 0.10.6", + "chacha20poly1305 0.10.1", + "hex", + "hmac 0.12.1", + "ip_network", + "ip_network_table", + "libc", + "nix 0.25.1", + "parking_lot", + "rand_core 0.6.4", + "ring", + "tracing", + "untrusted", + "x25519-dalek 2.0.1", +] + +[[package]] +name = "borsh" +version = "1.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "553c5d846a6ba5150c65e3b1b8ec073bcf1abc20f9b7220de384a4443ea4e20a" +dependencies = [ + "borsh-derive", + "bytes", + "cfg_aliases", +] + +[[package]] +name = "borsh-derive" +version = "1.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "12cdfe656708a01f89b451a7d36466e6fe6c414de0aa18fc54f864f6f9ca9f56" +dependencies = [ + "once_cell", + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "brotli" +version = "8.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5cc91aac060a7a1e25823bdccbfb6af1875b88f17c6daac97894eed8207166b3" +dependencies = [ + "alloc-no-stdlib", + "alloc-stdlib", + "brotli-decompressor", +] + +[[package]] +name = "brotli-decompressor" +version = "5.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3a32acac15fe1967bc3986b2a6347dffc965602354ea6f450ad07e8bfd253583" +dependencies = [ + "alloc-no-stdlib", + "alloc-stdlib", +] + +[[package]] +name = "bs58" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf88ba1141d185c399bee5288d850d63b8369520c1eafc32a0430b5b6c287bf4" +dependencies = [ + "tinyvec", +] + +[[package]] +name = "bstr" +version = "1.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6bb31b46c14244e20ee9984b11bf5c992b91fb6939fea616e3512c8baecdbe5f" +dependencies = [ + "memchr", + "serde_core", +] + +[[package]] +name = "bumpalo" +version = "3.20.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649" + +[[package]] +name = "bytecodec" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1016c00ae68a934cd21f6e3837555ffdc977c0bd8e7df3093ca35c3d726789e" +dependencies = [ + "byteorder", + "trackable", +] + +[[package]] +name = "bytecount" +version = "0.6.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "175812e0be2bccb6abe50bb8d566126198344f707e304f45c648fd8f2cc0365e" + +[[package]] +name = "bytemuck" +version = "1.25.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95832e849adfb21180ccb6826a99da14e5d266ae5c2e668e1602cf234f153797" + +[[package]] +name = "byteorder" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b" + +[[package]] +name = "byteorder-lite" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f1fe948ff07f4bd06c30984e69f5b4899c516a3ef74f34df92a2df2ab535495" + +[[package]] +name = "bytes" +version = "1.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04" +dependencies = [ + "serde", +] + +[[package]] +name = "bzip2" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3a53fac24f34a81bc9954b5d6cfce0c21e18ec6959f44f56e8e90e4bb7c346c" +dependencies = [ + "libbz2-rs-sys", +] + +[[package]] +name = "c2rust-bitfields" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b43c3f07ab0ef604fa6f595aa46ec2f8a22172c975e186f6f5bf9829a3b72c41" +dependencies = [ + "c2rust-bitfields-derive", +] + +[[package]] +name = "c2rust-bitfields-derive" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3cbc102e2597c9744c8bd8c15915d554300601c91a079430d309816b0912545" +dependencies = [ + "proc-macro2", + "quote", + "syn 1.0.109", +] + +[[package]] +name = "cairo-rs" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ca26ef0159422fb77631dc9d17b102f253b876fe1586b03b803e63a309b4ee2" +dependencies = [ + "bitflags 2.13.2", + "cairo-sys-rs", + "glib", + "libc", + "once_cell", + "thiserror 1.0.69", +] + +[[package]] +name = "cairo-sys-rs" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "685c9fa8e590b8b3d678873528d83411db17242a73fccaed827770ea0fedda51" +dependencies = [ + "glib-sys", + "libc", + "system-deps", +] + +[[package]] +name = "camino" +version = "1.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbbad30e4b4c14a39e3cc8aed085a12a327257c316619c93581e017bc52be591" +dependencies = [ + "serde_core", +] + +[[package]] +name = "cargo-platform" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e35af189006b9c0f00a064685c727031e3ed2d8020f7ba284d78cc2671bd36ea" +dependencies = [ + "serde", +] + +[[package]] +name = "cargo_metadata" +version = "0.19.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd5eb614ed4c27c5d706420e4320fbe3216ab31fa1c33cd8246ac36dae4479ba" +dependencies = [ + "camino", + "cargo-platform", + "semver", + "serde", + "serde_json", + "thiserror 2.0.20", +] + +[[package]] +name = "cargo_toml" +version = "0.22.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "374b7c592d9c00c1f4972ea58390ac6b18cbb6ab79011f3bdc90a0b82ca06b77" +dependencies = [ + "serde", + "toml 0.9.12+spec-1.1.0", +] + +[[package]] +name = "cast" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "37b2a672a2cb129a2e41c10b1224bb368f9f37a2b16b612598138befd7b37eb5" + +[[package]] +name = "cc" +version = "1.4.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3eb0f42d6c360dc3f8a821f6bf2fdea7f72bfd36b3076eb0e6d1e9e0752fff4" +dependencies = [ + "find-msvc-tools", + "jobserver", + "libc", + "shlex 2.0.1", +] + +[[package]] +name = "cesu8" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6d43a04d8753f35258c91f8ec639f792891f748a1edbd759cf1dcea3382ad83c" + +[[package]] +name = "cexpr" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6fac387a98bb7c37292057cffc56d62ecb629900026402633ae9160df93a8766" +dependencies = [ + "nom 7.1.3", +] + +[[package]] +name = "cfb" +version = "0.7.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d38f2da7a0a2c4ccf0065be06397cc26a81f4e528be095826eee9d4adbb8c60f" +dependencies = [ + "byteorder", + "fnv", + "uuid", +] + +[[package]] +name = "cfg-expr" +version = "0.15.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d067ad48b8650848b989a59a86c6c36a995d02d2bf778d45c3c5d57bc2718f02" +dependencies = [ + "smallvec", + "target-lexicon", +] + +[[package]] +name = "cfg-if" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600" + +[[package]] +name = "cfg_aliases" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f079e83a288787bcd14a6aea84cee5c87a67c5a3e660c30f557a3d24761b3527" + +[[package]] +name = "chacha20" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3613f74bd2eac03dad61bd53dbe620703d4371614fe0bc3b9f04dd36fe4e818" +dependencies = [ + "cfg-if", + "cipher 0.4.4", + "cpufeatures 0.2.17", +] + +[[package]] +name = "chacha20" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "65c35e4b699c7e15ccbe7ee35c005e4fc0a278d22238a2857e6ce2dadeda1b06" +dependencies = [ + "cfg-if", + "cipher 0.5.2", + "cpufeatures 0.3.1", + "rand_core 0.10.1", +] + +[[package]] +name = "chacha20poly1305" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10cd79432192d1c0f4e1a0fef9527696cc039165d729fb41b3f4f4f354c2dc35" +dependencies = [ + "aead 0.5.2", + "chacha20 0.9.1", + "cipher 0.4.4", + "poly1305 0.8.0", + "zeroize", +] + +[[package]] +name = "chacha20poly1305" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b89e1c441e926b9c82a8d023f6e1b7ae0adcfaa7d621814e4d60789bac751cb" +dependencies = [ + "aead 0.6.1", + "chacha20 0.10.2", + "cipher 0.5.2", + "poly1305 0.9.1", +] + +[[package]] +name = "chrono" +version = "0.4.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1aa79e62e7697b8e29b513a68abacf485adcd1fe8284a4316c5ae868e6633327" +dependencies = [ + "iana-time-zone", + "js-sys", + "num-traits", + "serde", + "wasm-bindgen", + "windows-link 0.2.1", +] + +[[package]] +name = "ciborium" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42e69ffd6f0917f5c029256a24d0161db17cea3997d185db0d35926308770f0e" +dependencies = [ + "ciborium-io", + "ciborium-ll", + "serde", +] + +[[package]] +name = "ciborium-io" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "05afea1e0a06c9be33d539b876f1ce3692f4afea2cb41f740e7743225ed1c757" + +[[package]] +name = "ciborium-ll" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "57663b653d948a338bfb3eeba9bb2fd5fcfaecb9e199e87e1eda4d9e8b240fd9" +dependencies = [ + "ciborium-io", + "half", +] + +[[package]] +name = "cidr" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "579504560394e388085d0c080ea587dfa5c15f7e251b4d5247d1e1a61d1d6928" +dependencies = [ + "serde", +] + +[[package]] +name = "cipher" +version = "0.4.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "773f3b9af64447d2ce9850330c473515014aa235e6a783b02db81ff39e4a3dad" +dependencies = [ + "crypto-common 0.1.7", + "inout 0.1.4", + "zeroize", +] + +[[package]] +name = "cipher" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e8cf2a2c93cd704877c0858356ed03480ff301ee950b43f1cbe4573b088bfa6c" +dependencies = [ + "block-buffer 0.12.1", + "crypto-common 0.2.2", + "inout 0.2.2", +] + +[[package]] +name = "clang-sys" +version = "1.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "157a8ba7b480713b56f4c09fd13fc3e0a22a5dfab8097ba61cbc5feef950788a" +dependencies = [ + "glob", + "libc", + "libloading 0.8.9", +] + +[[package]] +name = "clap" +version = "4.6.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa8876b300ab35ba921adea3dfd70157a46249b33f95c9084ae5709785478946" +dependencies = [ + "clap_builder", + "clap_derive", +] + +[[package]] +name = "clap_builder" +version = "4.6.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec0797fb7aeb1406c84efac526901f7ec3ead2124f946b494e72879d4b54704d" +dependencies = [ + "anstream", + "anstyle", + "clap_lex", + "strsim", + "terminal_size", + "unicase", + "unicode-width", +] + +[[package]] +name = "clap_complete" +version = "4.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "037e2a1a92236d0aff7e845093f64661d6df4c02c9fcc61a60e9e1d736fa392f" +dependencies = [ + "clap", +] + +[[package]] +name = "clap_complete_nushell" +version = "4.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ffb66bc82eb9c92b1727310ae2c5868df22ae7cf46185bc5c544a4fa71955e49" +dependencies = [ + "clap", + "clap_complete", +] + +[[package]] +name = "clap_derive" +version = "4.6.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9c751b79415d4e559e3d1fcf128e09e720eb673a06d26cf6f392d37d75b66e0" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "clap_lex" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c133bc6a41be0d194c306b5506d15e6feeea7b1d6604bd3f8310dfb2ca96486" + +[[package]] +name = "clipboard-win" +version = "5.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bde03770d3df201d4fb868f2c9c59e66a3e4e2bd06692a0fe701e7103c7e84d4" +dependencies = [ + "error-code", +] + +[[package]] +name = "cmake" +version = "0.1.58" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0f78a02292a74a88ac736019ab962ece0bc380e3f977bf72e376c5d78ff0678" +dependencies = [ + "cc", +] + +[[package]] +name = "cmov" +version = "0.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c9ea0ac24bc397ab3c98583a3c9ba74fa56b09a4449bbe172b9b1ddb016027a" + +[[package]] +name = "codepage" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bdff162541cd8b79de82e2edcc7eff3a8c2a6dc3d75152636028f96d93de3b26" +dependencies = [ + "encoding_rs", +] + +[[package]] +name = "colorchoice" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570" + +[[package]] +name = "combine" +version = "4.6.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfc320937d09e6de266b31b9afb480f197d7a861be86be7cb2ea7e5d1bfffc5e" +dependencies = [ + "bytes", + "memchr", +] + +[[package]] +name = "compression-codecs" +version = "0.4.43" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bef16c47ba2797aa6a909cc37d39911f3a6743811fe7408ac0b0cc0276b656e9" +dependencies = [ + "brotli", + "compression-core", + "flate2", + "memchr", + "zstd 0.14.0", + "zstd-safe 8.0.0", +] + +[[package]] +name = "compression-core" +version = "0.4.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e8ccc4ea9f6acc32d102c0f6d471d11d913ad15f20c04de743374861fa1d414" + +[[package]] +name = "concurrent-queue" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ca0197aee26d1ae37445ee532fefce43251d24cc7c166799f4d46817f1d3973" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "console-api" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e8599749b6667e2f0c910c1d0dff6901163ff698a52d5a39720f61b5be4b20d3" +dependencies = [ + "futures-core", + "prost 0.14.4", + "prost-types 0.14.4", + "tonic", + "tonic-prost", + "tracing-core", +] + +[[package]] +name = "console-subscriber" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fb4915b7d8dd960457a1b6c380114c2944f728e7c65294ab247ae6b6f1f37592" +dependencies = [ + "console-api", + "crossbeam-channel", + "crossbeam-utils", + "futures-task", + "hdrhistogram", + "humantime", + "hyper-util", + "prost 0.14.4", + "prost-types 0.14.4", + "serde", + "serde_json", + "thread_local", + "tokio", + "tokio-stream", + "tonic", + "tracing", + "tracing-core", + "tracing-subscriber", +] + +[[package]] +name = "const-oid" +version = "0.9.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2459377285ad874054d797f3ccebf984978aa39129f6eafde5cdc8315b612f8" + +[[package]] +name = "const-oid" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6ef517f0926dd24a1582492c791b6a4818a4d94e789a334894aa15b0d12f55c" + +[[package]] +name = "constant_time_eq" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d52eff69cd5e647efe296129160853a42795992097e8af39800e1060caeea9b" + +[[package]] +name = "convert_case" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "633458d4ef8c78b72454de2d54fd6ab2e60f9e02be22f3c6104cdc8a4e0fceb9" +dependencies = [ + "unicode-segmentation", +] + +[[package]] +name = "convert_case" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "affbf0190ed2caf063e3def54ff444b449371d55c58e513a95ab98eca50adb49" +dependencies = [ + "unicode-segmentation", +] + +[[package]] +name = "cookie" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a373e3602691c3cdea496d2f0ee5935151e6168fe87739483c463db1b2f2f87" +dependencies = [ + "base64 0.22.1", + "hmac 0.12.1", + "percent-encoding", + "rand 0.8.8", + "sha2 0.10.9", + "subtle", + "time", + "version_check", +] + +[[package]] +name = "core-foundation" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91e195e091a93c46f7102ec7818a2aa394e1e1771c3ab4825963fa03e45afb8f" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "core-foundation" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2a6cd9ae233e7f62ba4e9353e81a88df7fc8a5987b8d445b4d90c879bd156f6" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "core-foundation-sys" +version = "0.8.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" + +[[package]] +name = "core-graphics" +version = "0.25.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "064badf302c3194842cf2c5d61f56cc88e54a759313879cdf03abdd27d0c3b97" +dependencies = [ + "bitflags 2.13.2", + "core-foundation 0.10.1", + "core-graphics-types", + "foreign-types 0.5.0", + "libc", +] + +[[package]] +name = "core-graphics-types" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d44a101f213f6c4cdc1853d4b78aef6db6bdfa3468798cc1d9912f4735013eb" +dependencies = [ + "bitflags 2.13.2", + "core-foundation 0.10.1", + "libc", +] + +[[package]] +name = "core_detect" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f8f80099a98041a3d1622845c271458a2d73e688351bf3cb999266764b81d48" + +[[package]] +name = "cpubits" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "15b85f9c39137c3a891689859392b1bd49812121d0d61c9caf00d46ed5ce06ae" + +[[package]] +name = "cpufeatures" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280" +dependencies = [ + "libc", +] + +[[package]] +name = "cpufeatures" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5ca28b0ae3115b884660db4118d803791fd6756b6e88f39c0f3f7859060d7566" +dependencies = [ + "libc", +] + +[[package]] +name = "crc" +version = "3.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5eb8a2a1cd12ab0d987a5d5e825195d372001a4094a0376319d5a0ad71c1ba0d" +dependencies = [ + "crc-catalog", +] + +[[package]] +name = "crc-catalog" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "217698eaf96b4a3f0bc4f3662aaa55bdf913cd54d7204591faa790070c6d0853" + +[[package]] +name = "crc32fast" +version = "1.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "01a7799fd6b852db0e61728dde9a204c423b44d689dbd432522543614b490e78" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "criterion" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "950046b2aa2492f9a536f5f4f9a3de7b9e2476e575e05bd6c333371add4d98f3" +dependencies = [ + "alloca", + "anes", + "cast", + "ciborium", + "clap", + "criterion-plot", + "itertools 0.13.0", + "num-traits", + "oorandom", + "page_size", + "plotters", + "rayon", + "regex", + "serde", + "serde_json", + "tinytemplate", + "walkdir", +] + +[[package]] +name = "criterion-plot" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8d80a2f4f5b554395e47b5d8305bc3d27813bacb73493eb1001e8f76dae29ea" +dependencies = [ + "cast", + "itertools 0.13.0", +] + +[[package]] +name = "critical-section" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "790eea4361631c5e7d22598ecd5723ff611904e3344ce8720784c93e3d83d40b" + +[[package]] +name = "crossbeam" +version = "0.8.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e71406cd8807725f7ac2f999a4cdd32e98f829fdf65f528343cebf945e41df1e" +dependencies = [ + "crossbeam-channel", + "crossbeam-deque", + "crossbeam-epoch", + "crossbeam-queue", + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-channel" +version = "0.5.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "98b0cc327b5bc766e7fda9c9260cc0fa81b43a8e240440422dff70788e3f9ef1" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-deque" +version = "0.8.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "622f3fc73690be383c7214310406f28a90e6edeadc3cea882f9d71e495b9711a" +dependencies = [ + "crossbeam-epoch", + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-epoch" +version = "0.9.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc74980687109a3b14c72fd458107bf0baa1da1a1a805e178d15501ba9b86d9d" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-queue" +version = "0.3.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03e8bd762f7479489c70ed6c768ddca99d7296857de437a68dcb2a94365b3fae" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-utils" +version = "0.8.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a31eee39dddec8330830986fcd7625edb5a24ec90ea038215273bbc3adb08ac6" + +[[package]] +name = "crunchy" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "460fbee9c2c2f33933d720630a6a0bac33ba7053db5344fac858d4b8952d77d5" + +[[package]] +name = "crypto-bigint" +version = "0.5.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0dc92fb57ca44df6db8059111ab3af99a63d5d0f8375d9972e319a379c6bab76" +dependencies = [ + "generic-array", + "rand_core 0.6.4", + "subtle", + "zeroize", +] + +[[package]] +name = "crypto-common" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78c8292055d1c1df0cce5d180393dc8cce0abec0a7102adb6c7b1eef6016d60a" +dependencies = [ + "generic-array", + "rand_core 0.6.4", + "typenum", +] + +[[package]] +name = "crypto-common" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce6e4c961d6cd6c9a86db418387425e8bdeaf05b3c8bc1411e6dca4c252f1453" +dependencies = [ + "getrandom 0.4.3", + "hybrid-array", + "rand_core 0.10.1", +] + +[[package]] +name = "cssparser" +version = "0.36.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dae61cf9c0abb83bd659dab65b7e4e38d8236824c85f0f804f173567bda257d2" +dependencies = [ + "cssparser-macros", + "dtoa-short", + "itoa", + "phf", + "smallvec", +] + +[[package]] +name = "cssparser-macros" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "13b588ba4ac1a99f7f2964d24b3d896ddc6bf847ee3855dbd4366f058cfcd331" +dependencies = [ + "quote", + "syn 2.0.119", +] + +[[package]] +name = "ctor" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "352d39c2f7bef1d6ad73db6f5160efcaed66d94ef8c6c573a8410c00bf909a98" +dependencies = [ + "ctor-proc-macro", + "dtor", +] + +[[package]] +name = "ctor" +version = "1.0.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "914a755b7c2d4af2bdcff7ce1739e2db9a1b81a9b07123d8015786ae03c0980d" + +[[package]] +name = "ctor-proc-macro" +version = "0.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52560adf09603e58c9a7ee1fe1dcb95a16927b17c127f0ac02d6e768a0e25bc1" + +[[package]] +name = "ctr" +version = "0.9.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0369ee1ad671834580515889b80f2ea915f23b8be8d0daa4bbaf2ac5c7590835" +dependencies = [ + "cipher 0.4.4", +] + +[[package]] +name = "ctutils" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d5515a3834141de9eafb9717ad39eea8247b5674e6066c404e8c4b365d2a29e" +dependencies = [ + "cmov", +] + +[[package]] +name = "curve25519-dalek" +version = "4.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "97fb8b7c4503de7d6ae7b42ab72a5a59857b4c937ec27a3d4539dba95b5ab2be" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "curve25519-dalek-derive", + "digest 0.10.7", + "fiat-crypto 0.2.9", + "rustc_version", + "subtle", + "zeroize", +] + +[[package]] +name = "curve25519-dalek" +version = "5.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5eed333089e2e1c1ac8c6c0398e5e2497b4c9926ca6d0365ed1e099afa5bc23" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.1", + "curve25519-dalek-derive", + "fiat-crypto 0.3.0", + "rustc_version", + "subtle", + "zeroize", +] + +[[package]] +name = "curve25519-dalek-derive" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f46882e17999c6cc590af592290432be3bce0428cb0d5f8b6715e4dc7b383eb3" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "darling" +version = "0.20.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc7f46116c46ff9ab3eb1597a45688b6715c6e628b5c133e288e709a29bcb4ee" +dependencies = [ + "darling_core 0.20.11", + "darling_macro 0.20.11", +] + +[[package]] +name = "darling" +version = "0.23.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "25ae13da2f202d56bd7f91c25fba009e7717a1e4a1cc98a76d844b65ae912e9d" +dependencies = [ + "darling_core 0.23.0", + "darling_macro 0.23.0", +] + +[[package]] +name = "darling" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed17f5901b6630b993ca003def43f2f8ef4014fc13b047b57aad617ff32bc2ec" +dependencies = [ + "darling_core 0.24.1", + "darling_macro 0.24.1", +] + +[[package]] +name = "darling_core" +version = "0.20.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d00b9596d185e565c2207a0b01f8bd1a135483d02d9b7b0a54b11da8d53412e" +dependencies = [ + "fnv", + "ident_case", + "proc-macro2", + "quote", + "strsim", + "syn 2.0.119", +] + +[[package]] +name = "darling_core" +version = "0.23.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9865a50f7c335f53564bb694ef660825eb8610e0a53d3e11bf1b0d3df31e03b0" +dependencies = [ + "ident_case", + "proc-macro2", + "quote", + "strsim", + "syn 2.0.119", +] + +[[package]] +name = "darling_core" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6837e2cf7485aaae18f86181d2f0e9a7ed297a025e220aeabf63fdebd3a2ddff" +dependencies = [ + "ident_case", + "proc-macro2", + "quote", + "strsim", + "syn 3.0.6", +] + +[[package]] +name = "darling_macro" +version = "0.20.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc34b93ccb385b40dc71c6fceac4b2ad23662c7eeb248cf10d529b7e055b6ead" +dependencies = [ + "darling_core 0.20.11", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "darling_macro" +version = "0.23.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3984ec7bd6cfa798e62b4a642426a5be0e68f9401cfc2a01e3fa9ea2fcdb8d" +dependencies = [ + "darling_core 0.23.0", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "darling_macro" +version = "0.24.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ac7135c3ef02b2f7833bbeb1be5ba7f966dcde8a87c6b87f65a778d71a02785" +dependencies = [ + "darling_core 0.24.1", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "dashmap" +version = "6.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6361d5c062261c78a176addb82d4c821ae42bed6089de0e12603cd25de2059c" +dependencies = [ + "cfg-if", + "crossbeam-utils", + "hashbrown 0.14.5", + "lock_api", + "once_cell", + "parking_lot_core", +] + +[[package]] +name = "data-encoding" +version = "2.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4583a4551df46e2792f82ceeac45e850d2e2d5debba0b91f102385cda5b11f06" + +[[package]] +name = "dbus" +version = "0.9.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ab69f03cc8c4340c9c8e315114e1658e6775a9b16a04357973aa21cec22b32e" +dependencies = [ + "libc", + "libdbus-sys", + "windows-sys 0.61.2", +] + +[[package]] +name = "defguard_boringtun" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a575302d61f1019ba326452a03ca7df013187e5966214e244fdab4900127ca3" +dependencies = [ + "aead 0.6.1", + "base64 0.23.1", + "blake2 0.11.0", + "chacha20poly1305 0.11.0", + "hex", + "hmac 0.13.0", + "ip_network", + "ip_network_table", + "libc", + "nix 0.31.3", + "parking_lot", + "rand 0.10.2", + "ring", + "socket2", + "thiserror 2.0.20", + "tracing", + "x25519-dalek 3.0.0", +] + +[[package]] +name = "defguard_wireguard_rs" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6200ebad7ba02fc3272f9bd3883ef1aa187b95f0205491c1685b4168b22a3b8" +dependencies = [ + "base64 0.23.1", + "defguard_boringtun", + "ipnet", + "libc", + "log", + "netlink-packet-core 0.9.0", + "netlink-packet-generic", + "netlink-packet-route 0.33.0", + "netlink-packet-utils 0.6.0", + "netlink-packet-wireguard", + "netlink-sys 0.9.0", + "serde", + "thiserror 2.0.20", + "windows 0.62.2", + "wireguard-nt", + "x25519-dalek 3.0.0", +] + +[[package]] +name = "deflate64" +version = "0.1.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac6b926516df9c60bfa16e107b21086399f8285a44ca9711344b9e553c5146e2" + +[[package]] +name = "defmt" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e2953bfe4f93bbd20cc71198842756f77d161884c99ebbabc41d80231ded88d1" +dependencies = [ + "bitflags 1.3.2", + "defmt-macros", +] + +[[package]] +name = "defmt-macros" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bad9c72e7ca2137e0dc3813245a0d282fd6daad32fd800af018306a9169b5fe8" +dependencies = [ + "defmt-parser", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "defmt-parser" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10d60334b3b2e7c9d91ef8150abfb6fa4c1c39ebbcf4a81c2e346aad939fee3e" +dependencies = [ + "thiserror 2.0.20", +] + +[[package]] +name = "der" +version = "0.7.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7c1832837b905bbfb5101e07cc24c8deddf52f93225eee6ead5f4d63d53ddcb" +dependencies = [ + "const-oid 0.9.6", + "pem-rfc7468", + "zeroize", +] + +[[package]] +name = "der-parser" +version = "10.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07da5016415d5a3c4dd39b11ed26f915f52fc4e0dc197d87908bc916e51bc1a6" +dependencies = [ + "asn1-rs", + "displaydoc", + "nom 7.1.3", + "num-bigint", + "num-traits", + "rusticata-macros", +] + +[[package]] +name = "deranged" +version = "0.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7cd812cc2bc1d69d4764bd80df88b4317eaef9e773c75226407d9bc0876b211c" +dependencies = [ + "serde_core", +] + +[[package]] +name = "derive_builder" +version = "0.20.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "507dfb09ea8b7fa618fcf76e953f4f5e192547945816d5358edffe39f6f94947" +dependencies = [ + "derive_builder_macro", +] + +[[package]] +name = "derive_builder_core" +version = "0.20.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2d5bcf7b024d6835cfb3d473887cd966994907effbe9227e8c8219824d06c4e8" +dependencies = [ + "darling 0.20.11", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "derive_builder_macro" +version = "0.20.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ab63b0e2bf4d5928aff72e83a7dace85d7bba5fe12dcc3c5a572d78caffd3f3c" +dependencies = [ + "derive_builder_core", + "syn 2.0.119", +] + +[[package]] +name = "derive_more" +version = "2.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d751e9e49156b02b44f9c1815bcb94b984cdcc4396ecc32521c739452808b134" +dependencies = [ + "derive_more-impl", +] + +[[package]] +name = "derive_more-impl" +version = "2.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "799a97264921d8623a957f6c3b9011f3b5492f557bbb7a5a19b7fa6d06ba8dcb" +dependencies = [ + "convert_case 0.10.0", + "proc-macro2", + "quote", + "rustc_version", + "syn 2.0.119", + "unicode-xid", +] + +[[package]] +name = "digest" +version = "0.10.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292" +dependencies = [ + "block-buffer 0.10.4", + "const-oid 0.9.6", + "crypto-common 0.1.7", + "subtle", +] + +[[package]] +name = "digest" +version = "0.11.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1dd6dbb5841937940781866fa1281a1ff7bd3bf827091440879f9994983d5c2" +dependencies = [ + "block-buffer 0.12.1", + "const-oid 0.10.2", + "crypto-common 0.2.2", + "ctutils", + "zeroize", +] + +[[package]] +name = "dirs" +version = "4.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca3aa72a6f96ea37bbc5aa912f6788242832f75369bdfdadcb0e38423f100059" +dependencies = [ + "dirs-sys 0.3.7", +] + +[[package]] +name = "dirs" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3e8aa94d75141228480295a7d0e7feb620b1a5ad9f12bc40be62411e38cce4e" +dependencies = [ + "dirs-sys 0.5.0", +] + +[[package]] +name = "dirs-sys" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b1d1d91c932ef41c0f2663aa8b0ca0342d444d842c06914aa0a7e352d0bada6" +dependencies = [ + "libc", + "redox_users 0.4.6", + "winapi", +] + +[[package]] +name = "dirs-sys" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e01a3366d27ee9890022452ee61b2b63a67e6f13f58900b651ff5665f0bb1fab" +dependencies = [ + "libc", + "option-ext", + "redox_users 0.5.3", + "windows-sys 0.61.2", +] + +[[package]] +name = "dispatch2" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e0e367e4e7da84520dedcac1901e4da967309406d1e51017ae1abfb97adbd38" +dependencies = [ + "bitflags 2.13.2", + "block2", + "libc", + "objc2", +] + +[[package]] +name = "displaydoc" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6232dd377dcc64799954cbd3a9bb882e9cdc1308ccd87b1c098f1fb2eaf82a8" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "dlopen2" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09b4f5f101177ff01b8ec4ecc81eead416a8aa42819a2869311b3420fa114ffa" +dependencies = [ + "libc", + "once_cell", + "winapi", +] + +[[package]] +name = "dlopen2" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e2c5bd4158e66d1e215c49b837e11d62f3267b30c92f1d171c4d3105e3dc4d4" +dependencies = [ + "dlopen2_derive", + "libc", + "once_cell", + "winapi", +] + +[[package]] +name = "dlopen2_derive" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0fbbb781877580993a8707ec48672673ec7b81eeba04cfd2310bd28c08e47c8f" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "dom_query" +version = "0.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "521e380c0c8afb8d9a1e83a1822ee03556fc3e3e7dbc1fd30be14e37f9cb3f89" +dependencies = [ + "bit-set", + "cssparser", + "foldhash 0.2.0", + "html5ever", + "precomputed-hash", + "selectors", + "tendril", +] + +[[package]] +name = "dotenvy" +version = "0.15.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1aaf95b3e5c8f23aa320147307562d361db0ae0d51242340f558153b4eb2439b" + +[[package]] +name = "downcast-rs" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75b325c5dbd37f80359721ad39aca5a29fb04c89279657cffdda8736d0c0b9d2" + +[[package]] +name = "dpi" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8b14ccef22fc6f5a8f4d7d768562a182c04ce9a3b3157b91390b52ddfdf1a76" +dependencies = [ + "serde", +] + +[[package]] +name = "dtoa" +version = "1.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4c3cf4824e2d5f025c7b531afcb2325364084a16806f6d47fbc1f5fbd9960590" + +[[package]] +name = "dtoa-short" +version = "0.3.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd1511a7b6a56299bd043a9c167a6d2bfb37bf84a6dfceaba651168adfb43c87" +dependencies = [ + "dtoa", +] + +[[package]] +name = "dtor" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1057d6c64987086ff8ed0fd3fbf377a6b7d205cc7715868cd401705f715cbe4" +dependencies = [ + "dtor-proc-macro", +] + +[[package]] +name = "dtor-proc-macro" +version = "0.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f678cf4a922c215c63e0de95eb1ff08a958a81d47e485cf9da1e27bf6305cfa5" + +[[package]] +name = "dunce" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92773504d58c093f6de2459af4af33faa518c13451eb8f2b5698ed3d36e7c813" + +[[package]] +name = "dyn-clone" +version = "1.0.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d0881ea181b1df73ff77ffaaf9c7544ecc11e82fba9b5f27b262a3c73a332555" + +[[package]] +name = "easytier" +version = "2.7.0" +dependencies = [ + "anyhow", + "arc-swap", + "async-recursion", + "async-trait", + "atomic-shim", + "atomic-write-file", + "atomic_refcell", + "base64 0.22.1", + "bon", + "boringtun-easytier", + "bytecodec", + "byteorder", + "bytes", + "cfg_aliases", + "chrono", + "cidr", + "clap", + "clap_complete", + "clap_complete_nushell", + "console-subscriber", + "criterion", + "crossbeam", + "dashmap", + "defguard_wireguard_rs", + "derive_builder", + "derive_more", + "easytier-core", + "easytier-proto", + "encoding", + "flume 0.12.0", + "forwarded-header-value", + "futures", + "gethostname", + "git-version", + "globwalk 0.9.1", + "guarden", + "hickory-client", + "hickory-proto", + "hickory-resolver", + "hickory-server", + "hkdf", + "http", + "http-body-util", + "humansize", + "humantime-serde", + "hyper", + "hyper-util", + "indoc", + "kcp-sys", + "log", + "machine-uid", + "maplit", + "mimalloc", + "moka", + "natpmp", + "netlink-sys 0.9.0", + "network-interface", + "nix 0.31.3", + "once_cell", + "parking_lot", + "paste", + "percent-encoding", + "pin-project-lite", + "pnet_datalink", + "prost 0.14.4", + "quanta", + "quinn", + "quinn-proto", + "rand 0.8.8", + "rcgen", + "regex", + "rstest", + "rust-i18n", + "rustls", + "seahash", + "serde", + "serde_json", + "serial_test", + "service-manager", + "sha2 0.10.9", + "shellexpand", + "smoltcp", + "socket2", + "strum 0.28.0", + "stun_codec", + "sys-locale", + "tabled", + "tempfile", + "terminal_size", + "thiserror 2.0.20", + "thunk-rs", + "tikv-jemalloc-ctl", + "tikv-jemalloc-sys", + "tikv-jemallocator", + "tokio", + "tokio-rustls", + "tokio-socks", + "tokio-util", + "tokio-websockets", + "toml 1.1.6+spec-1.1.0", + "tracing", + "tracing-subscriber", + "tun-easytier", + "unicode-width", + "url", + "uuid", + "winapi", + "windivert", + "windows 0.62.2", + "windows-service", + "winreg 0.56.0", + "x25519-dalek 2.0.1", + "xmltree", + "zerocopy 0.7.35", +] + +[[package]] +name = "easytier-android-jni" +version = "0.1.0" +dependencies = [ + "android_logger", + "easytier", + "easytier-ffi", + "jni 0.21.1", + "log", + "once_cell", + "serde_json", +] + +[[package]] +name = "easytier-core" +version = "2.7.0" +dependencies = [ + "aes-gcm", + "anyhow", + "arc-swap", + "ariadne", + "async-ringbuf", + "async-trait", + "atomic-shim", + "auto_impl", + "base64 0.22.1", + "bitflags 2.13.2", + "bon", + "bytecodec", + "bytes", + "chacha20poly1305 0.10.1", + "chrono", + "cidr", + "crossbeam-utils", + "dashmap", + "easytier-proto", + "futures", + "getrandom 0.2.17", + "getrandom 0.3.4", + "guarden", + "hmac 0.12.1", + "http-body-util", + "hyper", + "hyper-util", + "idna", + "openssl", + "ordered_hash_map", + "parking_lot", + "percent-encoding", + "petgraph", + "pin-project-lite", + "prefix-trie 0.10.1", + "prost 0.14.4", + "prost-types 0.14.4", + "quanta", + "rand 0.8.8", + "ring", + "rustls", + "rustls-pki-types", + "serde", + "serde_json", + "sha2 0.10.9", + "smoltcp", + "snow", + "strum 0.28.0", + "stun_codec", + "thiserror 2.0.20", + "tokio", + "tokio-rustls", + "tokio-util", + "toml 1.1.6+spec-1.1.0", + "tracing", + "url", + "uuid", + "wasm-bindgen", + "webpki-roots 1.0.9", + "wildmatch", + "x25519-dalek 2.0.1", + "zerocopy 0.7.35", + "zstd 0.14.0", +] + +[[package]] +name = "easytier-ffi" +version = "0.1.0" +dependencies = [ + "async-trait", + "easytier", + "easytier-core", + "log", + "once_cell", + "serde_json", + "thunk-rs", + "tokio", + "uuid", +] + +[[package]] +name = "easytier-gui" +version = "2.7.0" +dependencies = [ + "anyhow", + "async-trait", + "dashmap", + "easytier", + "easytier-core", + "libc", + "once_cell", + "security-framework-sys", + "serde", + "serde_json", + "tauri", + "tauri-build", + "tauri-plugin-clipboard-manager", + "tauri-plugin-os", + "tauri-plugin-process", + "tauri-plugin-shell", + "tauri-plugin-single-instance", + "tauri-plugin-vpnservice", + "thunk-rs", + "tokio", + "url", + "uuid", + "winapi", + "windows 0.62.2", +] + +[[package]] +name = "easytier-ios" +version = "0.1.0" +dependencies = [ + "easytier-core", + "easytier-ffi", + "serde_json", + "tracing", + "tracing-subscriber", + "uuid", +] + +[[package]] +name = "easytier-mini" +version = "2.7.0" +dependencies = [ + "anyhow", + "easytier", + "tokio", +] + +[[package]] +name = "easytier-ohos-core" +version = "0.1.0" +dependencies = [ + "async-trait", + "easytier", + "ipnet", + "once_cell", + "serde", + "serde_json", + "tokio", + "url", +] + +[[package]] +name = "easytier-ohos-features" +version = "0.1.0" +dependencies = [ + "base64 0.22.1", + "easytier", + "flate2", + "gethostname", + "once_cell", + "prost-reflect", + "rusqlite", + "serde", + "serde_json", + "tracing", + "url", + "uuid", +] + +[[package]] +name = "easytier-ohrs" +version = "0.1.0" +dependencies = [ + "anyhow", + "async-trait", + "bytes", + "easytier", + "easytier-core", + "easytier-ohos-core", + "easytier-ohos-features", + "easytier-proto", + "futures", + "napi-build-ohos", + "napi-derive-ohos", + "napi-ohos", + "once_cell", + "serde", + "serde_json", + "tokio", + "tracing", + "tracing-subscriber", + "url", + "uuid", +] + +[[package]] +name = "easytier-proto" +version = "2.7.0" +dependencies = [ + "anyhow", + "async-trait", + "auto_impl", + "base64 0.22.1", + "bytes", + "chrono", + "cidr", + "hmac 0.12.1", + "indoc", + "pbjson", + "pbjson-build", + "proc-macro2", + "prost 0.14.4", + "prost-build", + "prost-types 0.14.4", + "prost-wkt-types", + "quote", + "reqwest", + "serde", + "serde_json", + "sha2 0.10.9", + "thiserror 2.0.20", + "tokio", + "url", + "uuid", + "x25519-dalek 2.0.1", + "zip", +] + +[[package]] +name = "easytier-uptime" +version = "0.1.0" +dependencies = [ + "anyhow", + "async-trait", + "axum", + "axum-extra", + "chrono", + "clap", + "dashmap", + "easytier", + "jsonwebtoken", + "mimalloc", + "sea-orm", + "sea-orm-migration", + "serde", + "serde_json", + "sqlx", + "thiserror 2.0.20", + "tokio", + "tokio-util", + "tower-http 0.7.1", + "tracing", + "tracing-subscriber", + "uuid", + "validator", +] + +[[package]] +name = "easytier-web" +version = "2.7.0" +dependencies = [ + "ab_glyph", + "anyhow", + "async-trait", + "axum", + "axum-embed", + "axum-login", + "axum-messages", + "base64 0.22.1", + "chrono", + "cidr", + "clap", + "dashmap", + "easytier", + "easytier-core", + "easytier-proto", + "futures", + "image", + "imageproc", + "maxminddb", + "mimalloc", + "oauth2-reqwest", + "openidconnect", + "password-auth", + "prost 0.14.4", + "rand 0.8.8", + "reqwest", + "rust-embed", + "rust-i18n", + "sea-orm", + "sea-orm-migration", + "serde", + "serde_json", + "sha2 0.10.9", + "sqlx", + "subtle", + "sys-locale", + "thiserror 2.0.20", + "thunk-rs", + "tokio", + "tokio-util", + "tower", + "tower-http 0.7.1", + "tower-sessions", + "tower-sessions-sqlx-store", + "tracing", + "url", + "uuid", + "x25519-dalek 2.0.1", +] + +[[package]] +name = "ecdsa" +version = "0.16.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ee27f32b5c5292967d2d4a9d7f1e0b0aed2c15daded5a60300e4abb9d8020bca" +dependencies = [ + "der", + "digest 0.10.7", + "elliptic-curve", + "rfc6979", + "signature", + "spki", +] + +[[package]] +name = "ed25519" +version = "2.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "115531babc129696a58c64a4fef0a8bf9e9698629fb97e9e40767d235cfbcd53" +dependencies = [ + "pkcs8", + "signature", +] + +[[package]] +name = "ed25519-dalek" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70e796c081cee67dc755e1a36a0a172b897fab85fc3f6bc48307991f64e4eca9" +dependencies = [ + "curve25519-dalek 4.1.3", + "ed25519", + "serde", + "sha2 0.10.9", + "subtle", + "zeroize", +] + +[[package]] +name = "either" +version = "1.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "252afb9ae5eaa683babdc6a068b3f5726eb19e05070c731f9b2a23a7c3e8ed34" +dependencies = [ + "serde", +] + +[[package]] +name = "elliptic-curve" +version = "0.13.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5e6043086bf7973472e0c7dff2142ea0b680d30e18d9cc40f267efbf222bd47" +dependencies = [ + "base16ct", + "crypto-bigint", + "digest 0.10.7", + "ff", + "generic-array", + "group", + "hkdf", + "pem-rfc7468", + "pkcs8", + "rand_core 0.6.4", + "sec1", + "subtle", + "zeroize", +] + +[[package]] +name = "embed-resource" +version = "3.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fbfdaacccebec3b28e4866b8973543c7647797db5ada1bdab552e48fe665fbbd" +dependencies = [ + "cc", + "memchr", + "rustc_version", + "toml 1.1.6+spec-1.1.0", + "vswhom", + "winreg 0.55.0", +] + +[[package]] +name = "embed_plist" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ef6b89e5b37196644d8796de5268852ff179b44e96276cf4290264843743bb7" + +[[package]] +name = "encoding" +version = "0.2.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b0d943856b990d12d3b55b359144ff341533e516d94098b1d3fc1ac666d36ec" +dependencies = [ + "encoding-index-japanese", + "encoding-index-korean", + "encoding-index-simpchinese", + "encoding-index-singlebyte", + "encoding-index-tradchinese", +] + +[[package]] +name = "encoding-index-japanese" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04e8b2ff42e9a05335dbf8b5c6f7567e5591d0d916ccef4e0b1710d32a0d0c91" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-index-korean" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4dc33fb8e6bcba213fe2f14275f0963fd16f0a02c878e3095ecfdf5bee529d81" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-index-simpchinese" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d87a7194909b9118fc707194baa434a4e3b0fb6a5a757c73c3adb07aa25031f7" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-index-singlebyte" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3351d5acffb224af9ca265f435b859c7c01537c0849754d3db3fdf2bfe2ae84a" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-index-tradchinese" +version = "1.20141219.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd0e20d5688ce3cab59eb3ef3a2083a5c77bf496cb798dc6fcdb75f323890c18" +dependencies = [ + "encoding_index_tests", +] + +[[package]] +name = "encoding-utils" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "87b881ab2524b96a5ce932056c7482ba6152e2226fed3936b3e592adeb95ca6d" +dependencies = [ + "codepage", + "encoding_rs", + "windows-sys 0.52.0", +] + +[[package]] +name = "encoding_index_tests" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a246d82be1c9d791c5dfde9a2bd045fc3cbba3fa2b11ad558f27d01712f00569" + +[[package]] +name = "encoding_rs" +version = "0.8.41" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b5ef0006ac9ab233c38522f5ae99cae3625151de8f706cacee1cba4b8e2832a" +dependencies = [ + "cfg-if", + "core_detect", + "multiversion", + "multiversion_no_op", + "rustversion", + "scopeguard", + "simdutf8", +] + +[[package]] +name = "encoding_rs_io" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fba3fe847045ecff794b9c138293a80db914678c453ad63fbf0c6a9eb6e00b22" +dependencies = [ + "encoding_rs", +] + +[[package]] +name = "endi" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "66b7e2430c6dff6a955451e2cfc438f09cea1965a9d6f87f7e3b90decc014099" + +[[package]] +name = "endian-type" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c34f04666d835ff5d62e058c3995147c06f42fe86ff053337632bca83e42702d" + +[[package]] +name = "enum-as-inner" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1e6a265c649f3f5979b601d26f1d05ada116434c87741c9493cb56218f76cbc" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "enumflags2" +version = "0.7.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1027f7680c853e056ebcec683615fb6fbbc07dbaa13b4d5d9442b146ded4ecef" +dependencies = [ + "enumflags2_derive", + "serde", +] + +[[package]] +name = "enumflags2_derive" +version = "0.7.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67c78a4d8fdf9953a5c9d458f9efe940fd97a0cab0941c075a813ac594733827" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "env_filter" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1bf3c259d255ca70051b30e2e95b5446cdb8949ac4cd22c0d7fd634d89f568e2" +dependencies = [ + "log", + "regex", +] + +[[package]] +name = "equivalent" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" + +[[package]] +name = "erased-serde" +version = "0.4.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d2add8a07dd6a8d93ff627029c51de145e12686fbc36ecb298ac22e74cf02dec" +dependencies = [ + "serde", + "serde_core", + "typeid", +] + +[[package]] +name = "errno" +version = "0.3.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "error-code" +version = "3.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b5343afd4a8365a643ac588dab4cf234a190c7f6c88c9f6dd6ffe00837661b7" + +[[package]] +name = "etcetera" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "136d1b5283a1ab77bd9257427ffd09d8667ced0570b6f938942bc7568ed5b943" +dependencies = [ + "cfg-if", + "home", + "windows-sys 0.48.0", +] + +[[package]] +name = "etherparse" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "827292ea592108849932ad8e30218f8b1f21c0dfd0696698a18b5d0aed62d990" +dependencies = [ + "arrayvec", +] + +[[package]] +name = "event-listener" +version = "5.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a23add41df1562121a9393cb065eab5146a1242410f23a644851e90cfd669d2" +dependencies = [ + "parking", + "pin-project-lite", +] + +[[package]] +name = "event-listener-strategy" +version = "0.5.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8be9f3dfaaffdae2972880079a491a1a8bb7cbed0b8dd7a347f668b4150a3b93" +dependencies = [ + "event-listener", + "pin-project-lite", +] + +[[package]] +name = "fallible-iterator" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2acce4a10f12dc2fb14a218589d4f1f62ef011b2d0cc4b3cb1bba8e94da14649" + +[[package]] +name = "fallible-streaming-iterator" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7360491ce676a36bf9bb3c56c1aa791658183a54d2744120f27285738d90465a" + +[[package]] +name = "fastbloom" +version = "0.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ef975e30683b2d965054bb0a836f8973857c4ebf6acf274fe46617cd285060d8" +dependencies = [ + "foldhash 0.2.0", + "libm", + "portable-atomic", + "siphasher", +] + +[[package]] +name = "fastrand" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da7c62ceae207dd37ea5b845da6a0696c799f85e97da1ab5b7910be3c1c80223" +dependencies = [ + "getrandom 0.4.3", +] + +[[package]] +name = "fax" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "caf1079563223d5d59d83c85886a56e586cfd5c1a26292e971a0fa266531ac5a" + +[[package]] +name = "fdeflate" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e6853b52649d4ac5c0bd02320cddc5ba956bdb407c4b75a2c6b75bf51500f8c" +dependencies = [ + "simd-adler32", +] + +[[package]] +name = "ff" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0b50bfb653653f9ca9095b427bed08ab8d75a137839d9ad64eb11810d5b6393" +dependencies = [ + "rand_core 0.6.4", + "subtle", +] + +[[package]] +name = "fiat-crypto" +version = "0.2.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "28dea519a9695b9977216879a3ebfddf92f1c08c05d984f8996aecd6ecdc811d" + +[[package]] +name = "fiat-crypto" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "64cd1e32ddd350061ae6edb1b082d7c54915b5c672c389143b9a63403a109f24" + +[[package]] +name = "field-offset" +version = "0.3.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38e2275cc4e4fc009b0669731a1e5ab7ebf11f469eaede2bab9309a5b4d6057f" +dependencies = [ + "memoffset", + "rustc_version", +] + +[[package]] +name = "find-msvc-tools" +version = "0.1.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3e0f1c7c3a72c66fd80abe965175f7523475c0489a87d3ff9d6e8c87d87a9d2d" + +[[package]] +name = "fixedbitset" +version = "0.5.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d674e81391d1e1ab681a28d99df07927c6d4aa5b027d7da16ba32d1d21ecd99" + +[[package]] +name = "flate2" +version = "1.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e634e2e0ebac1ee034020da1ca582e17ffe4e0f5e985823721e168928136dcb" +dependencies = [ + "crc32fast", + "miniz_oxide 0.9.1", + "zlib-rs", +] + +[[package]] +name = "flume" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da0e4dd2a88388a1f4ccc7c9ce104604dab68d9f408dc34cd45823d5a9069095" +dependencies = [ + "futures-core", + "futures-sink", + "spin", +] + +[[package]] +name = "flume" +version = "0.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e139bc46ca777eb5efaf62df0ab8cc5fd400866427e56c68b22e414e53bd3be" +dependencies = [ + "fastrand", + "futures-core", + "futures-sink", + "spin", +] + +[[package]] +name = "fnv" +version = "1.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" + +[[package]] +name = "foldhash" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" + +[[package]] +name = "foldhash" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77ce24cb58228fbb8aa041425bb1050850ac19177686ea6e0f41a70416f56fdb" + +[[package]] +name = "foreign-types" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6f339eb8adc052cd2ca78910fda869aefa38d22d5cb648e6485e4d3fc06f3b1" +dependencies = [ + "foreign-types-shared 0.1.1", +] + +[[package]] +name = "foreign-types" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d737d9aa519fb7b749cbc3b962edcf310a8dd1f4b67c91c4f83975dbdd17d965" +dependencies = [ + "foreign-types-macros", + "foreign-types-shared 0.3.1", +] + +[[package]] +name = "foreign-types-macros" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ea5190182e6915eb873ddbc16e23b711b6eb1f9c00a0d0a3a91b5f6228475225" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "foreign-types-shared" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b" + +[[package]] +name = "foreign-types-shared" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa9a19cbb55df58761df49b23516a86d432839add4af60fc256da840f66ed35b" + +[[package]] +name = "form_urlencoded" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" +dependencies = [ + "percent-encoding", +] + +[[package]] +name = "forwarded-header-value" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8835f84f38484cc86f110a805655697908257fb9a7af005234060891557198e9" +dependencies = [ + "nonempty", + "thiserror 1.0.69", +] + +[[package]] +name = "fs_extra" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42703706b716c37f96a77aea830392ad231f44c9e9a67872fa5548707e11b11c" + +[[package]] +name = "futures" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a31d2a3fbaaeb2af2368bbdd904aa8e812d3c04a1ee10d3171f52d556e5d0a3" +dependencies = [ + "futures-channel", + "futures-core", + "futures-executor", + "futures-io", + "futures-sink", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-channel" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f9e3d69d39e4862ffed03ed071a76f9a13ba1d9109d355b0f0aa6b15e393c4" +dependencies = [ + "futures-core", + "futures-sink", +] + +[[package]] +name = "futures-core" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92d699e522242e69e3003b94ecc1f960f3a5e015aa7c5d7486e65ad01dd94f5e" + +[[package]] +name = "futures-executor" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "031b47cf1a3c6cc8bc2fc76cd437f521619387907d469316e7c0bc278f1f5432" +dependencies = [ + "futures-core", + "futures-task", + "futures-util", +] + +[[package]] +name = "futures-intrusive" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d930c203dd0b6ff06e0201a4a2fe9149b43c684fd4420555b26d21b1a02956f" +dependencies = [ + "futures-core", + "lock_api", + "parking_lot", +] + +[[package]] +name = "futures-io" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed" + +[[package]] +name = "futures-lite" +version = "2.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f78e10609fe0e0b3f4157ffab1876319b5b0db102a2c60dc4626306dc46b44ad" +dependencies = [ + "fastrand", + "futures-core", + "futures-io", + "parking", + "pin-project-lite", +] + +[[package]] +name = "futures-macro" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9fb9654ba8355388abeb8dcb4fc62f511300867002afc858860463bdd9fe0c44" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "futures-sink" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1944426bf7d03f1d14f708785e4b33efd750b36d48a157b836b3efc15ede8e1d" + +[[package]] +name = "futures-task" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd417de3d1d015fc3bfd2b1ea46dfc7bab72ef86f1cc7cc9c78e728b34a6d1fd" + +[[package]] +name = "futures-timer" +version = "3.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af43fadb8a98512d547e37b4e92e0ced13e205c061b87b4623eff01d918d6968" + +[[package]] +name = "futures-util" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d50a92467f8ba5dd6e3ee5d4bd04d73ab2e4e1c44474a0674821dfce14b79bc" +dependencies = [ + "futures-channel", + "futures-core", + "futures-io", + "futures-macro", + "futures-sink", + "futures-task", + "memchr", + "pin-project-lite", + "slab", +] + +[[package]] +name = "gdk" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9f245958c627ac99d8e529166f9823fb3b838d1d41fd2b297af3075093c2691" +dependencies = [ + "cairo-rs", + "gdk-pixbuf", + "gdk-sys", + "gio", + "glib", + "libc", + "pango", +] + +[[package]] +name = "gdk-pixbuf" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50e1f5f1b0bfb830d6ccc8066d18db35c487b1b2b1e8589b5dfe9f07e8defaec" +dependencies = [ + "gdk-pixbuf-sys", + "gio", + "glib", + "libc", + "once_cell", +] + +[[package]] +name = "gdk-pixbuf-sys" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f9839ea644ed9c97a34d129ad56d38a25e6756f99f3a88e15cd39c20629caf7" +dependencies = [ + "gio-sys", + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "gdk-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c2d13f38594ac1e66619e188c6d5a1adb98d11b2fcf7894fc416ad76aa2f3f7" +dependencies = [ + "cairo-sys-rs", + "gdk-pixbuf-sys", + "gio-sys", + "glib-sys", + "gobject-sys", + "libc", + "pango-sys", + "pkg-config", + "system-deps", +] + +[[package]] +name = "gdkwayland-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "140071d506d223f7572b9f09b5e155afbd77428cd5cc7af8f2694c41d98dfe69" +dependencies = [ + "gdk-sys", + "glib-sys", + "gobject-sys", + "libc", + "pkg-config", + "system-deps", +] + +[[package]] +name = "gdkx11" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3caa00e14351bebbc8183b3c36690327eb77c49abc2268dd4bd36b856db3fbfe" +dependencies = [ + "gdk", + "gdkx11-sys", + "gio", + "glib", + "libc", + "x11", +] + +[[package]] +name = "gdkx11-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e2e7445fe01ac26f11601db260dd8608fe172514eb63b3b5e261ea6b0f4428d" +dependencies = [ + "gdk-sys", + "glib-sys", + "libc", + "system-deps", + "x11", +] + +[[package]] +name = "generic-array" +version = "0.14.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a" +dependencies = [ + "typenum", + "version_check", + "zeroize", +] + +[[package]] +name = "gethostname" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1bd49230192a3797a9a4d6abe9b3eed6f7fa4c8a8a4947977c6f80025f92cbd8" +dependencies = [ + "rustix 1.1.5", + "windows-link 0.2.1", +] + +[[package]] +name = "getrandom" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff2abc00be7fca6ebc474524697ae276ad847ad0a6b3faa4bcb027e9a4614ad0" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "wasi", + "wasm-bindgen", +] + +[[package]] +name = "getrandom" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "899def5c37c4fd7b2664648c28120ecec138e4d395b459e5ca34f9cce2dd77fd" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "r-efi 5.3.0", + "wasip2", + "wasm-bindgen", +] + +[[package]] +name = "getrandom" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "300e883d756b2e4ec94e02791f39b04b522276138852cfc41d9fb7e904106099" +dependencies = [ + "cfg-if", + "js-sys", + "libc", + "r-efi 6.0.0", + "rand_core 0.10.1", + "wasm-bindgen", +] + +[[package]] +name = "ghash" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0d8a4362ccb29cb0b265253fb0a2728f592895ee6854fd9bc13f2ffda266ff1" +dependencies = [ + "opaque-debug", + "polyval", +] + +[[package]] +name = "gio" +version = "0.18.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d4fc8f532f87b79cbc51a79748f16a6828fb784be93145a322fa14d06d354c73" +dependencies = [ + "futures-channel", + "futures-core", + "futures-io", + "futures-util", + "gio-sys", + "glib", + "libc", + "once_cell", + "pin-project-lite", + "smallvec", + "thiserror 1.0.69", +] + +[[package]] +name = "gio-sys" +version = "0.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "37566df850baf5e4cb0dfb78af2e4b9898d817ed9263d1090a2df958c64737d2" +dependencies = [ + "glib-sys", + "gobject-sys", + "libc", + "system-deps", + "winapi", +] + +[[package]] +name = "git-version" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ad568aa3db0fcbc81f2f116137f263d7304f512a1209b35b85150d3ef88ad19" +dependencies = [ + "git-version-macro", +] + +[[package]] +name = "git-version-macro" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53010ccb100b96a67bc32c0175f0ed1426b31b655d562898e57325f81c023ac0" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "glam" +version = "0.30.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "19fc433e8437a212d1b6f1e68c7824af3aed907da60afa994e7f542d18d12aa9" + +[[package]] +name = "glam" +version = "0.31.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "556f6b2ea90b8d15a74e0e7bb41671c9bdf38cd9f78c284d750b9ce58a2b5be7" + +[[package]] +name = "glam" +version = "0.32.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f70749695b063ecbf6b62949ccccde2e733ec3ecbbd71d467dca4e5c6c97cca0" + +[[package]] +name = "glam" +version = "0.33.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e762b9b188634fc508d4ec54b62ea3d352c43fd431d18d05d46f559f217f4725" + +[[package]] +name = "glib" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "233daaf6e83ae6a12a52055f568f9d7cf4671dabb78ff9560ab6da230ce00ee5" +dependencies = [ + "bitflags 2.13.2", + "futures-channel", + "futures-core", + "futures-executor", + "futures-task", + "futures-util", + "gio-sys", + "glib-macros", + "glib-sys", + "gobject-sys", + "libc", + "memchr", + "once_cell", + "smallvec", + "thiserror 1.0.69", +] + +[[package]] +name = "glib-macros" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bb0228f477c0900c880fd78c8759b95c7636dbd7842707f49e132378aa2acdc" +dependencies = [ + "heck 0.4.1", + "proc-macro-crate 2.0.0", + "proc-macro-error", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "glib-sys" +version = "0.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "063ce2eb6a8d0ea93d2bf8ba1957e78dbab6be1c2220dd3daca57d5a9d869898" +dependencies = [ + "libc", + "system-deps", +] + +[[package]] +name = "glob" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e4eba85ea1d0a966a983acd07deee566e67395d2d96b6fb39e62b5a833f1eb0b" + +[[package]] +name = "globset" +version = "0.4.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07c34a9410465b45bd9787443bc7370f37735bad04b0f0cd57ff1a3186c98988" +dependencies = [ + "aho-corasick", + "bstr", + "log", + "regex-automata", + "regex-syntax", +] + +[[package]] +name = "globwalk" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93e3af942408868f6934a7b85134a3230832b9977cf66125df2f9edcfce4ddcc" +dependencies = [ + "bitflags 1.3.2", + "ignore", + "walkdir", +] + +[[package]] +name = "globwalk" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf760ebf69878d9fd8f110c89703d90ce35095324d1f1edcb595c63945ee757" +dependencies = [ + "bitflags 2.13.2", + "ignore", + "walkdir", +] + +[[package]] +name = "gobject-sys" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0850127b514d1c4a4654ead6dedadb18198999985908e6ffe4436f53c785ce44" +dependencies = [ + "glib-sys", + "libc", + "system-deps", +] + +[[package]] +name = "granit-parser" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e20f99e46474f56bd905c56e817ebddcf377a611f94c53ac4649e4d3fa3c0cd0" +dependencies = [ + "arraydeque", + "smallvec", +] + +[[package]] +name = "group" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0f9ef7462f7c099f518d754361858f86d8a07af53ba9af0fe635bbccb151a63" +dependencies = [ + "ff", + "rand_core 0.6.4", + "subtle", +] + +[[package]] +name = "gtk" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd56fb197bfc42bd5d2751f4f017d44ff59fbb58140c6b49f9b3b2bdab08506a" +dependencies = [ + "atk", + "cairo-rs", + "field-offset", + "futures-channel", + "gdk", + "gdk-pixbuf", + "gio", + "glib", + "gtk-sys", + "gtk3-macros", + "libc", + "pango", + "pkg-config", +] + +[[package]] +name = "gtk-sys" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f29a1c21c59553eb7dd40e918be54dccd60c52b049b75119d5d96ce6b624414" +dependencies = [ + "atk-sys", + "cairo-sys-rs", + "gdk-pixbuf-sys", + "gdk-sys", + "gio-sys", + "glib-sys", + "gobject-sys", + "libc", + "pango-sys", + "system-deps", +] + +[[package]] +name = "gtk3-macros" +version = "0.18.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52ff3c5b21f14f0736fed6dcfc0bfb4225ebf5725f3c0209edeec181e4d73e9d" +dependencies = [ + "proc-macro-crate 1.3.1", + "proc-macro-error", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "guarden" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "11e5aa725802d305ed9726003d1d2c0329cea9802314d482b7d1206b10e92461" +dependencies = [ + "futures-core", + "guarden-macros", + "tokio", +] + +[[package]] +name = "guarden-macros" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "58fae24d0e2228af3151faf0153dc6c9ef1f7fa7965ffb7e3022052fcb78f297" +dependencies = [ + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "h2" +version = "0.4.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ef8e5e5a340588f4452631496976cf8636d4a7ecf600239fdc27615d2530bc16" +dependencies = [ + "atomic-waker", + "bytes", + "fnv", + "futures-core", + "futures-sink", + "http", + "indexmap 2.14.2", + "slab", + "tokio", + "tokio-util", + "tracing", +] + +[[package]] +name = "half" +version = "2.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ea2d84b969582b4b1864a92dc5d27cd2b77b622a8d79306834f1be5ba20d84b" +dependencies = [ + "cfg-if", + "crunchy", + "zerocopy 0.8.57", +] + +[[package]] +name = "hash32" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47d60b12902ba28e2730cd37e95b8c9223af2808df9e902d4df49588d1470606" +dependencies = [ + "byteorder", +] + +[[package]] +name = "hashbrown" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888" + +[[package]] +name = "hashbrown" +version = "0.14.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" +dependencies = [ + "ahash", +] + +[[package]] +name = "hashbrown" +version = "0.15.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9229cfe53dfd69f0609a49f65461bd93001ea1ef889cd5529dd176593f5338a1" +dependencies = [ + "allocator-api2", + "equivalent", + "foldhash 0.1.5", +] + +[[package]] +name = "hashbrown" +version = "0.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" + +[[package]] +name = "hashlink" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ba4ff7128dee98c7dc9794b6a411377e1404dba1c97deb8d1a55297bd25d8af" +dependencies = [ + "hashbrown 0.14.5", +] + +[[package]] +name = "hashlink" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7382cf6263419f2d8df38c55d7da83da5c18aef87fc7a7fc1fb1e344edfe14c1" +dependencies = [ + "hashbrown 0.15.5", +] + +[[package]] +name = "hdrhistogram" +version = "7.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f49d1053f4708f0af3cf9fc5bffc7e68a914a3c45becb231c80068c9c3f78bea" +dependencies = [ + "base64 0.22.1", + "byteorder", + "flate2", + "nom 8.0.0", + "num-traits", +] + +[[package]] +name = "heapless" +version = "0.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "25ba4bd83f9415b58b4ed8dc5714c76e626a105be4646c02630ad730ad3b5aa4" +dependencies = [ + "hash32", + "stable_deref_trait", +] + +[[package]] +name = "heck" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8" + +[[package]] +name = "heck" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" + +[[package]] +name = "hermit-abi" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e17592d60ebacc7d5e169f4663c5f84f9161cc90328abcfe8456f41e4dfcb284" + +[[package]] +name = "hex" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f24254aa9a54b5c858eaee2f5bccdb46aaf0e486a595ed5fd8f86ba55232a70" + +[[package]] +name = "hickory-client" +version = "0.25.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c466cd63a4217d5b2b8e32f23f58312741ce96e3c84bf7438677d2baff0fc555" +dependencies = [ + "cfg-if", + "data-encoding", + "futures-channel", + "futures-util", + "hickory-proto", + "once_cell", + "radix_trie", + "rand 0.9.5", + "thiserror 2.0.20", + "tokio", + "tracing", +] + +[[package]] +name = "hickory-proto" +version = "0.25.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8a6fe56c0038198998a6f217ca4e7ef3a5e51f46163bd6dd60b5c71ca6c6502" +dependencies = [ + "async-trait", + "cfg-if", + "data-encoding", + "enum-as-inner", + "futures-channel", + "futures-io", + "futures-util", + "idna", + "ipnet", + "once_cell", + "rand 0.9.5", + "ring", + "serde", + "thiserror 2.0.20", + "tinyvec", + "tokio", + "tracing", + "url", +] + +[[package]] +name = "hickory-resolver" +version = "0.25.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc62a9a99b0bfb44d2ab95a7208ac952d31060efc16241c87eaf36406fecf87a" +dependencies = [ + "cfg-if", + "futures-util", + "hickory-proto", + "ipconfig", + "moka", + "once_cell", + "parking_lot", + "rand 0.9.5", + "resolv-conf", + "serde", + "smallvec", + "thiserror 2.0.20", + "tokio", + "tracing", +] + +[[package]] +name = "hickory-server" +version = "0.25.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d53e5fe811b941c74ee46b8818228bfd2bc2688ba276a0eaeb0f2c95ea3b2585" +dependencies = [ + "async-trait", + "bytes", + "cfg-if", + "data-encoding", + "enum-as-inner", + "futures-util", + "hickory-proto", + "hickory-resolver", + "ipnet", + "prefix-trie 0.7.0", + "serde", + "thiserror 2.0.20", + "time", + "tokio", + "tokio-util", + "tracing", +] + +[[package]] +name = "hkdf" +version = "0.12.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b5f8eb2ad728638ea2c7d47a21db23b7b58a72ed6a38256b8a1849f15fbbdf7" +dependencies = [ + "hmac 0.12.1", +] + +[[package]] +name = "hmac" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c49c37c09c17a53d937dfbb742eb3a961d65a994e6bcdcf37e7399d0cc8ab5e" +dependencies = [ + "digest 0.10.7", +] + +[[package]] +name = "hmac" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6303bc9732ae41b04cb554b844a762b4115a61bfaa81e3e83050991eeb56863f" +dependencies = [ + "digest 0.11.3", +] + +[[package]] +name = "home" +version = "0.5.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc627f471c528ff0c4a49e1d5e60450c8f6461dd6d10ba9dcd3a61d3dff7728d" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "html5ever" +version = "0.38.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1054432bae2f14e0061e33d23402fbaa67a921d319d56adc6bcf887ddad1cbc2" +dependencies = [ + "log", + "markup5ever", +] + +[[package]] +name = "http" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "918d3568bebf352712bc2ef3d46a8bcf1a75b373be6539de198e9105cbbf9ce0" +dependencies = [ + "bytes", + "itoa", +] + +[[package]] +name = "http-body" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca2a8f2913ee65f60facd6a5905613afaa448497a0230cc41ce022d93290bc2c" +dependencies = [ + "bytes", + "http", +] + +[[package]] +name = "http-body-util" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23169fe34a5fbcdd3f3862e78fb9b6fccd5f02a6dc6f732547005d45631ce71c" +dependencies = [ + "bytes", + "futures-core", + "http", + "http-body", + "pin-project-lite", +] + +[[package]] +name = "httparse" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87" + +[[package]] +name = "httpdate" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df3b46402a9d5adb4c86a0cf463f42e19994e3ee891101b1841f30a545cb49a9" + +[[package]] +name = "humansize" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6cb51c9a029ddc91b07a787f1d86b53ccfa49b0e86688c946ebe8d3555685dd7" +dependencies = [ + "libm", +] + +[[package]] +name = "humantime" +version = "2.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "15cdd26707701c53297e2fa6afb323d55fbc1d0810c3aec078ae3ef0424c3c15" + +[[package]] +name = "humantime-serde" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "57a3db5ea5923d99402c94e9feb261dc5ee9b4efa158b0315f788cf549cc200c" +dependencies = [ + "humantime", + "serde", +] + +[[package]] +name = "hybrid-array" +version = "0.4.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27f864f10dfb56725ce5ce5472bc52252c8f93a4ab86327122cebf62c5f59a17" +dependencies = [ + "typenum", +] + +[[package]] +name = "hyper" +version = "1.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27b501faa50e7a26c3d3560ca625132f4078a17771f4810baf70475ae48cbe43" +dependencies = [ + "atomic-waker", + "bytes", + "futures-channel", + "futures-core", + "h2", + "http", + "http-body", + "httparse", + "httpdate", + "itoa", + "pin-project-lite", + "smallvec", + "tokio", + "want", +] + +[[package]] +name = "hyper-rustls" +version = "0.27.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33ca68d021ef39cf6463ab54c1d0f5daf03377b70561305bb89a8f83aab66e0f" +dependencies = [ + "http", + "hyper", + "hyper-util", + "rustls", + "tokio", + "tokio-rustls", + "tower-service", +] + +[[package]] +name = "hyper-timeout" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b90d566bffbce6a75bd8b09a05aa8c2cb1fabb6cb348f8840c9e4c90a0d83b0" +dependencies = [ + "hyper", + "hyper-util", + "pin-project-lite", + "tokio", + "tower-service", +] + +[[package]] +name = "hyper-util" +version = "0.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96547c2556ec9d12fb1578c4eaf448b04993e7fb79cbaad930a656880a6bdfa0" +dependencies = [ + "base64 0.22.1", + "bytes", + "futures-channel", + "futures-util", + "http", + "http-body", + "hyper", + "ipnet", + "libc", + "percent-encoding", + "pin-project-lite", + "socket2", + "system-configuration 0.7.0", + "tokio", + "tower-service", + "tracing", + "windows-registry", +] + +[[package]] +name = "iana-time-zone" +version = "0.1.65" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e31bc9ad994ba00e440a8aa5c9ef0ec67d5cb5e5cb0cc7f8b744a35b389cc470" +dependencies = [ + "android_system_properties", + "core-foundation-sys", + "iana-time-zone-haiku", + "js-sys", + "log", + "wasm-bindgen", + "windows-core 0.62.2", +] + +[[package]] +name = "iana-time-zone-haiku" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f" +dependencies = [ + "cc", +] + +[[package]] +name = "ico" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3e795dff5605e0f04bff85ca41b51a96b83e80b281e96231bcaaf1ac35103371" +dependencies = [ + "byteorder", + "png 0.17.16", +] + +[[package]] +name = "icu_collections" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fa68d21081c4a05d5a901a1c62add574c77048b6a1c67be3b50ce0b60d4ca513" +dependencies = [ + "displaydoc", + "potential_utf", + "utf8_iter", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_locale_core" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d56e28588da92eee5c3201a6eff33fabdd49b62269c8938d4ff050ce4d900deb" +dependencies = [ + "displaydoc", + "litemap", + "tinystr", + "writeable", + "zerovec", +] + +[[package]] +name = "icu_normalizer" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "12f9cf5f235641ed274641dd81c3f28d870e276763d0797aeeab72317b1c646f" +dependencies = [ + "icu_collections", + "icu_normalizer_data", + "icu_properties", + "icu_provider", + "smallvec", + "zerovec", +] + +[[package]] +name = "icu_normalizer_data" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1563da1ed3e0b3bf3d74c9b85917ac9c56464d2f57242270c09c9e752f8021a0" + +[[package]] +name = "icu_properties" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e7ca276ad3145661a65914e6daf131ca5120cd3dcee8f8f3214b8875184a148" +dependencies = [ + "displaydoc", + "icu_collections", + "icu_locale_core", + "icu_properties_data", + "icu_provider", + "zerotrie", + "zerovec", +] + +[[package]] +name = "icu_properties_data" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e590f038c1464a96894fd6d10127e90a8be4509f56ff7ecef851b15cee0b7caa" + +[[package]] +name = "icu_provider" +version = "2.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d27bbb9d3abbefac45d55f647c9de1d44aafcd1186eb91879afef17c396c3e73" +dependencies = [ + "displaydoc", + "icu_locale_core", + "writeable", + "yoke", + "zerofrom", + "zerotrie", + "zerovec", +] + +[[package]] +name = "ident_case" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" + +[[package]] +name = "idna" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" +dependencies = [ + "idna_adapter", + "smallvec", + "utf8_iter", +] + +[[package]] +name = "idna_adapter" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb68373c0d6620ef8105e855e7745e18b0d00d3bdb07fb532e434244cdb9a714" +dependencies = [ + "icu_normalizer", + "icu_properties", +] + +[[package]] +name = "ignore" +version = "0.4.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00b69833ed729dc5aa7d19541d96d6cf8e9137194207a04916d658e43168402f" +dependencies = [ + "crossbeam-deque", + "globset", + "log", + "memchr", + "regex-automata", + "same-file", + "walkdir", + "winapi-util", +] + +[[package]] +name = "image" +version = "0.25.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85ab80394333c02fe689eaf900ab500fbd0c2213da414687ebf995a65d5a6104" +dependencies = [ + "bytemuck", + "byteorder-lite", + "moxcms", + "num-traits", + "png 0.18.1", + "tiff", +] + +[[package]] +name = "imageproc" +version = "0.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7b27bc0867dc40df08deb53d6e96342db6e0702e7ae33ed09a4eba33e594b05" +dependencies = [ + "ab_glyph", + "approx", + "getrandom 0.4.3", + "image", + "itertools 0.14.0", + "nalgebra", + "num", + "rand 0.10.2", + "rand_distr", +] + +[[package]] +name = "indexmap" +version = "1.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bd070e393353796e801d209ad339e89596eb4c8d430d18ede6a1cced8fafbd99" +dependencies = [ + "autocfg", + "hashbrown 0.12.3", + "serde", +] + +[[package]] +name = "indexmap" +version = "2.14.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc4e190f5d26ca7051642629da2c52fc03bde85a03197c99408dcd291734c855" +dependencies = [ + "equivalent", + "hashbrown 0.17.1", + "serde", + "serde_core", +] + +[[package]] +name = "indoc" +version = "2.0.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706" +dependencies = [ + "rustversion", +] + +[[package]] +name = "infer" +version = "0.19.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a588916bfdfd92e71cacef98a63d9b1f0d74d6599980d11894290e7ddefffcf7" +dependencies = [ + "cfb", +] + +[[package]] +name = "inherent" +version = "1.0.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bee2c455ca60511a054699102d40ce7153621cb2429558f9eaa600e4499b5984" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "inout" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "879f10e63c20629ecabbb64a8010319738c66a5cd0c29b02d63d272b03751d01" +dependencies = [ + "generic-array", +] + +[[package]] +name = "inout" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4250ce6452e92010fdf7268ccc5d14faa80bb12fc741938534c58f16804e03c7" +dependencies = [ + "hybrid-array", +] + +[[package]] +name = "inventory" +version = "0.3.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4f0c30c76f2f4ccee3fe55a2435f691ca00c0e4bd87abe4f4a851b1d4dac39b" +dependencies = [ + "rustversion", +] + +[[package]] +name = "ip_network" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa2f047c0a98b2f299aa5d6d7088443570faae494e9ae1305e48be000c9e0eb1" + +[[package]] +name = "ip_network_table" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4099b7cfc5c5e2fe8c5edf3f6f7adf7a714c9cc697534f63a5a5da30397cb2c0" +dependencies = [ + "ip_network", + "ip_network_table-deps-treebitmap", +] + +[[package]] +name = "ip_network_table-deps-treebitmap" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e537132deb99c0eb4b752f0346b6a836200eaaa3516dd7e5514b63930a09e5d" + +[[package]] +name = "ipconfig" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4d40460c0ce33d6ce4b0630ad68ff63d6661961c48b6dba35e5a4d81cfb48222" +dependencies = [ + "socket2", + "widestring 1.2.1", + "windows-registry", + "windows-result 0.4.1", + "windows-sys 0.61.2", +] + +[[package]] +name = "ipnet" +version = "2.12.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "791930b43c0d5973160d90a8f3894509f2b273430f5c5c73b668636d0287c5c0" +dependencies = [ + "serde", +] + +[[package]] +name = "ipnetwork" +version = "0.20.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf466541e9d546596ee94f9f69590f89473455f88372423e0008fc1a7daf100e" +dependencies = [ + "serde", +] + +[[package]] +name = "ipnetwork" +version = "0.21.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf370abdafd54d13e54a620e8c3e1145f28e46cc9d704bc6d94414559df41763" + +[[package]] +name = "is-docker" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "928bae27f42bc99b60d9ac7334e3a21d10ad8f1835a4e12ec3ec0464765ed1b3" +dependencies = [ + "once_cell", +] + +[[package]] +name = "is-wsl" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "173609498df190136aa7dea1a91db051746d339e18476eed5ca40521f02d7aa5" +dependencies = [ + "is-docker", + "once_cell", +] + +[[package]] +name = "is_terminal_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695" + +[[package]] +name = "itertools" +version = "0.10.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b0fd2260e829bddf4cb6ea802289de2f86d6a7a690192fbe91b3f46e0f2c8473" +dependencies = [ + "either", +] + +[[package]] +name = "itertools" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1c173a5686ce8bfa551b3563d0c2170bf24ca44da99c7ca4bfdab5418c3fe57" +dependencies = [ + "either", +] + +[[package]] +name = "itertools" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "413ee7dfc52ee1a4949ceeb7dbc8a33f2d6c088194d9f922fb8318faf1f01186" +dependencies = [ + "either", +] + +[[package]] +name = "itertools" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b192c782037fadd9cfa75548310488aabdbf3d2da73885b31bd0abd03351285" +dependencies = [ + "either", +] + +[[package]] +name = "itoa" +version = "1.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682" + +[[package]] +name = "javascriptcore-rs" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca5671e9ffce8ffba57afc24070e906da7fc4b1ba66f2cabebf61bf2ea257fcc" +dependencies = [ + "bitflags 1.3.2", + "glib", + "javascriptcore-rs-sys", +] + +[[package]] +name = "javascriptcore-rs-sys" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af1be78d14ffa4b75b66df31840478fef72b51f8c2465d4ca7c194da9f7a5124" +dependencies = [ + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "jiff" +version = "0.2.37" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ab1baf72f08796de0260609515130699b890ac25f30e610ad894bc5856cafdb" +dependencies = [ + "defmt", + "jiff-core", + "jiff-static", + "jiff-tzdb-platform", + "log", + "portable-atomic", + "portable-atomic-util", + "serde_core", + "windows-link 0.2.1", +] + +[[package]] +name = "jiff-core" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e52fe76043ccecc9005d2305ebaadf7d7fc0cc89ca6baa10a94d6bc68c7128c" +dependencies = [ + "defmt", + "log", +] + +[[package]] +name = "jiff-static" +version = "0.2.37" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "378268a1116ad67ae6228701118ac9f491d78fda38a40a1f1a9e1348de6f7212" +dependencies = [ + "jiff-core", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "jiff-tzdb" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "142bd39932ad231f10513df9ab62661fead8719872150b7ad02a2df79f4e141e" + +[[package]] +name = "jiff-tzdb-platform" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "875a5a69ac2bab1a891711cf5eccbec1ce0341ea805560dcd90b7a2e925132e8" +dependencies = [ + "jiff-tzdb", +] + +[[package]] +name = "jni" +version = "0.21.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a87aa2bb7d2af34197c04845522473242e1aa17c12f4935d5856491a7fb8c97" +dependencies = [ + "cesu8", + "cfg-if", + "combine", + "jni-sys 0.3.1", + "log", + "thiserror 1.0.69", + "walkdir", + "windows-sys 0.45.0", +] + +[[package]] +name = "jni" +version = "0.22.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5efd9a482cf3a427f00d6b35f14332adc7902ce91efb778580e180ff90fa3498" +dependencies = [ + "cfg-if", + "combine", + "jni-macros", + "jni-sys 0.4.1", + "log", + "simd_cesu8", + "thiserror 2.0.20", + "walkdir", + "windows-link 0.2.1", +] + +[[package]] +name = "jni-macros" +version = "0.22.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a00109accc170f0bdb141fed3e393c565b6f5e072365c3bd58f5b062591560a3" +dependencies = [ + "proc-macro2", + "quote", + "rustc_version", + "simd_cesu8", + "syn 2.0.119", +] + +[[package]] +name = "jni-sys" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41a652e1f9b6e0275df1f15b32661cf0d4b78d4d87ddec5e0c3c20f097433258" +dependencies = [ + "jni-sys 0.4.1", +] + +[[package]] +name = "jni-sys" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6377a88cb3910bee9b0fa88d4f42e1d2da8e79915598f65fb0c7ee14c878af2" +dependencies = [ + "jni-sys-macros", +] + +[[package]] +name = "jni-sys-macros" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38c0b942f458fe50cdac086d2f946512305e5631e720728f2a61aabcd47a6264" +dependencies = [ + "quote", + "syn 2.0.119", +] + +[[package]] +name = "jobserver" +version = "0.1.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c00acbd29eabad4a2392fa0e921c874934dbbf4194312ad20f04a0ed67a3cb3" +dependencies = [ + "getrandom 0.4.3", + "libc", +] + +[[package]] +name = "js-sys" +version = "0.3.105" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce57d20d1ea864ce2ac172ab472d409214f4fd359f0b2a2775abdf522e2af99e" +dependencies = [ + "cfg-if", + "futures-util", + "wasm-bindgen", +] + +[[package]] +name = "json-patch" +version = "3.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "863726d7afb6bc2590eeff7135d923545e5e964f004c2ccf8716c25e70a86f08" +dependencies = [ + "jsonptr", + "serde", + "serde_json", + "thiserror 1.0.69", +] + +[[package]] +name = "jsonptr" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5dea2b27dd239b2556ed7a25ba842fe47fd602e7fc7433c2a8d6106d4d9edd70" +dependencies = [ + "serde", + "serde_json", +] + +[[package]] +name = "jsonwebtoken" +version = "11.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e75fe14a82d81e5f5af639997db37d8b96045938a7ac6ab18cdbe1c7467e05e1" +dependencies = [ + "base64 0.22.1", + "ed25519-dalek", + "getrandom 0.2.17", + "hmac 0.12.1", + "js-sys", + "p256", + "p384", + "pem 3.0.6", + "rand 0.8.8", + "rsa", + "serde", + "serde_json", + "sha2 0.10.9", + "signature", + "simple_asn1", + "zeroize", +] + +[[package]] +name = "kcp-sys" +version = "0.1.0" +source = "git+https://github.com/EasyTier/kcp-sys?rev=268533568d734ae89dc89603078da3ca522effe1#268533568d734ae89dc89603078da3ca522effe1" +dependencies = [ + "anyhow", + "auto_impl", + "bindgen", + "bitflags 2.13.2", + "bytes", + "cc", + "dashmap", + "parking_lot", + "rand 0.8.8", + "thiserror 2.0.20", + "tokio", + "tokio-util", + "tracing", + "tracing-subscriber", + "zerocopy 0.7.35", +] + +[[package]] +name = "keyboard-types" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b750dcadc39a09dbadd74e118f6dd6598df77fa01df0cfcdc52c28dece74528a" +dependencies = [ + "bitflags 2.13.2", + "serde", + "unicode-segmentation", +] + +[[package]] +name = "lazy_static" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" +dependencies = [ + "spin", +] + +[[package]] +name = "libappindicator" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03589b9607c868cc7ae54c0b2a22c8dc03dd41692d48f2d7df73615c6a95dc0a" +dependencies = [ + "glib", + "gtk", + "gtk-sys", + "libappindicator-sys", + "log", +] + +[[package]] +name = "libappindicator-sys" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e9ec52138abedcc58dc17a7c6c0c00a2bdb4f3427c7f63fa97fd0d859155caf" +dependencies = [ + "gtk-sys", + "libloading 0.7.4", + "once_cell", +] + +[[package]] +name = "libbz2-rs-sys" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "34b357333733e8260735ba5894eb928c02ecc69c78715f01a8019e7fa7f2db4c" + +[[package]] +name = "libc" +version = "0.2.189" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3eaf3ede3fee6db1a4c2ee091bf8a8b4dccdc6d17f656fb07896ee72867612f2" + +[[package]] +name = "libdbus-sys" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "328c4789d42200f1eeec05bd86c9c13c7f091d2ba9a6ea35acdf51f31bc0f043" +dependencies = [ + "pkg-config", +] + +[[package]] +name = "libloading" +version = "0.7.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b67380fd3b2fbe7527a606e18729d21c6f3951633d0500574c4dc22d2d638b9f" +dependencies = [ + "cfg-if", + "winapi", +] + +[[package]] +name = "libloading" +version = "0.8.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d7c4b02199fee7c5d21a5ae7d8cfa79a6ef5bb2fc834d6e9058e89c825efdc55" +dependencies = [ + "cfg-if", + "windows-link 0.2.1", +] + +[[package]] +name = "libloading" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "754ca22de805bb5744484a5b151a9e1a8e837d5dc232c2d7d8c2e3492edc8b60" +dependencies = [ + "cfg-if", + "windows-link 0.2.1", +] + +[[package]] +name = "libm" +version = "0.2.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6d2cec3eae94f9f509c767b45932f1ada8350c4bdb85af2fcab4a3c14807981" + +[[package]] +name = "libmimalloc-sys" +version = "0.1.49" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6a45a52f43e1c16f667ccfe4dd8c85b7f7c204fd5e3bf46c5b0db9a5c3c0b8e9" +dependencies = [ + "cc", +] + +[[package]] +name = "libredox" +version = "0.1.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6480ccc157a1389bb2e4891b24751b0f798ba640d22386f23143fbcc89da195a" +dependencies = [ + "bitflags 2.13.2", + "libc", + "plain", + "redox_syscall 0.9.4", +] + +[[package]] +name = "libsqlite3-sys" +version = "0.30.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2e99fb7a497b1e3339bc746195567ed8d3e24945ecd636e3619d20b9de9e9149" +dependencies = [ + "cc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "linux-raw-sys" +version = "0.4.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d26c52dbd32dccf2d10cac7725f8eae5296885fb5703b261f7d0a0739ec807ab" + +[[package]] +name = "linux-raw-sys" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53" + +[[package]] +name = "litemap" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47d9d19d1d6efa0109d2f65ff4c85cddd50bd572e5a00127ab10987290bcefae" + +[[package]] +name = "lock_api" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "224399e74b87b5f3557511d98dff8b14089b3dadafcab6bb93eab67d3aace965" +dependencies = [ + "scopeguard", + "serde", +] + +[[package]] +name = "log" +version = "0.4.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9f8bd3e56ce4dfc153cf470fffbfa98c7620958b312ca5c3a4b8d5181fd13c6" + +[[package]] +name = "lru-slab" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4050469837a6ff301cd14c1f8f24f88549e6d548f24f64e2148eb0f72cebc51f" + +[[package]] +name = "lzma-rust2" +version = "0.16.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca93e534d1142d1d0dcca6d25fe302508a5dfb40b302802904577725ea0b695b" +dependencies = [ + "sha2 0.11.0", +] + +[[package]] +name = "mac_address" +version = "1.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0aeb26bf5e836cc1c341c8106051b573f1766dfa05aa87f0b98be5e51b02303" +dependencies = [ + "nix 0.29.0", + "serde", + "winapi", +] + +[[package]] +name = "machine-uid" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfe0d6336d341b10ae80e099b8f3c59f34bf8aef66ef25e83aa98bf2955c0ae7" +dependencies = [ + "libc", + "windows-registry", + "windows-sys 0.61.2", +] + +[[package]] +name = "managed" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ca88d725a0a943b096803bd34e73a4437208b6077654cc4ecb2947a5f91618d" + +[[package]] +name = "maplit" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3e2e65a1a2e43cfcb47a895c4c8b10d1f4a61097f9f254f183aee60cad9c651d" + +[[package]] +name = "markup5ever" +version = "0.38.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8983d30f2915feeaaab2d6babdd6bc7e9ed1a00b66b5e6d74df19aa9c0e91862" +dependencies = [ + "log", + "tendril", + "web_atoms", +] + +[[package]] +name = "matchers" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1525a2a28c7f4fa0fc98bb91ae755d1e2d1505079e05539e35bc876b5d65ae9" +dependencies = [ + "regex-automata", +] + +[[package]] +name = "matchit" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47e1ffaa40ddd1f3ed91f717a33c8c0ee23fff369e3aa8772b9605cc1d22f4c3" + +[[package]] +name = "matrixmultiply" +version = "0.3.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f607c237553f086e7043417a51df26b2eb899d3caff94e6a67592ff992fedc7" +dependencies = [ + "autocfg", + "rawpointer", +] + +[[package]] +name = "maxminddb" +version = "0.32.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b43d2458d977b610b04a3858e6504f06133663d303a1a0606601b530bfc9bc6" +dependencies = [ + "ipnetwork 0.21.1", + "memchr", + "serde", + "thiserror 2.0.20", +] + +[[package]] +name = "md-5" +version = "0.10.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d89e7ee0cfbedfc4da3340218492196241d89eefb6dab27de5df917a6d2e78cf" +dependencies = [ + "cfg-if", + "digest 0.10.7", +] + +[[package]] +name = "md5" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "490cc448043f947bae3cbee9c203358d62dbee0db12107a74be5c30ccfd09771" + +[[package]] +name = "memchr" +version = "2.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98" + +[[package]] +name = "memoffset" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "488016bfae457b036d996092f6cb448677611ce4449e970ceaf42695203f218a" +dependencies = [ + "autocfg", +] + +[[package]] +name = "mimalloc" +version = "0.1.52" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2d4139bb28d14ad1facf21d5eb8825051b326e172d216b39f6d31df53cc97862" +dependencies = [ + "libmimalloc-sys", +] + +[[package]] +name = "mime" +version = "0.3.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a" + +[[package]] +name = "mime_guess" +version = "2.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f7c44f8e672c00fe5308fa235f821cb4198414e1c77935c1ab6948d3fd78550e" +dependencies = [ + "mime", + "unicase", +] + +[[package]] +name = "minimal-lexical" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a" + +[[package]] +name = "miniz_oxide" +version = "0.8.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fa76a2c86f704bdb222d66965fb3d63269ce38518b83cb0575fca855ebb6316" +dependencies = [ + "adler2", + "simd-adler32", +] + +[[package]] +name = "miniz_oxide" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b63fbc4a50860e98e7b2aa7804ded1db5cbc3aff9193adaff57a6931bf7c4b4c" +dependencies = [ + "adler2", + "simd-adler32", +] + +[[package]] +name = "mio" +version = "1.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4b18443e9c262bfe8fa82f51666e2642c53393f7e5c27b3e1aeab922cff5b9d8" +dependencies = [ + "libc", + "wasi", + "windows-sys 0.61.2", +] + +[[package]] +name = "moka" +version = "0.12.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4293f18e7567a1caf3c584855554377025c65e0aa445344d04171f5ad63d19b9" +dependencies = [ + "async-lock", + "crossbeam-channel", + "crossbeam-epoch", + "crossbeam-utils", + "equivalent", + "event-listener", + "futures-util", + "parking_lot", + "portable-atomic", + "smallvec", + "tagptr", + "uuid", +] + +[[package]] +name = "moxcms" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bb85c154ba489f01b25c0d36ae69a87e4a1c73a72631fc6c0eb6dde34a73e44b" +dependencies = [ + "num-traits", + "pxfm", +] + +[[package]] +name = "muda" +version = "0.19.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1dd04e60bc0b07438a6771710ee1698f98f6ebbc7f89b61264af1563b8aeb878" +dependencies = [ + "crossbeam-channel", + "dpi", + "gtk", + "keyboard-types", + "objc2", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-foundation", + "once_cell", + "png 0.18.1", + "serde", + "thiserror 2.0.20", + "windows-sys 0.61.2", +] + +[[package]] +name = "multimap" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d87ecb2933e8aeadb3e3a02b828fed80a7528047e68b4f424523a0981a3a084" + +[[package]] +name = "multiversion" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b4ca4bea16ffc3f443cf7d866912118196bfef4c6a1556ca00f9f9b00bb43f7c" +dependencies = [ + "multiversion-macros", +] + +[[package]] +name = "multiversion-macros" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d416831a7317ef4b08bee00b69cbbb9c8763da7959a7026244d6266869f9c83" +dependencies = [ + "proc-macro2", + "quote", + "rustversion", + "syn 3.0.6", +] + +[[package]] +name = "multiversion_no_op" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "743fb55ba31b18fb1ecef6bdc9aa2743314978ac084044301a7eee33fb99a20d" + +[[package]] +name = "nalgebra" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "adc43a60c217b0c6ff46e47f26911015ad8d2e5a8be1af668c67e370d99a4346" +dependencies = [ + "approx", + "glam 0.30.10", + "glam 0.31.1", + "glam 0.32.1", + "glam 0.33.7", + "matrixmultiply", + "num-complex", + "num-rational", + "num-traits", + "simba", + "typenum", +] + +[[package]] +name = "napi-build-ohos" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "617bcd176a3dc3d96c0acad112a482f592242d6fba6773a9eb8d90e042a35260" + +[[package]] +name = "napi-derive-backend-ohos" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5b06bf282ab442eed04c89f8a833bd06d4cf22f18654f50d848449db9e94438a" +dependencies = [ + "convert_case 0.11.0", + "proc-macro2", + "quote", + "semver", + "syn 2.0.119", +] + +[[package]] +name = "napi-derive-ohos" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "419b1721d9f21d76c1a5cb38e2628211cb786b5efb9e1dd2fc049ba1cb938e47" +dependencies = [ + "convert_case 0.11.0", + "ctor 1.0.13", + "napi-derive-backend-ohos", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "napi-ohos" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fe1a014105134b7889e85f5ab6f8ec5240db43ed37e6c4a38bd7b4a164b345e0" +dependencies = [ + "bitflags 2.13.2", + "chrono", + "ctor 1.0.13", + "encoding_rs", + "futures", + "futures-core", + "indexmap 2.14.2", + "napi-build-ohos", + "napi-sys-ohos", + "nohash-hasher", + "rustc-hash", + "serde", + "serde_json", + "tokio", + "tokio-stream", +] + +[[package]] +name = "napi-sys-ohos" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "266964b97e57f3ca023ed13e7c78d4c8f3900aa00466bbeb8cb7746653cabc5f" +dependencies = [ + "libloading 0.9.0", +] + +[[package]] +name = "natpmp" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77366fa8ce34e2e1322dd97da65f11a62f451bd3daae8be6993c00800f61dd07" +dependencies = [ + "async-trait", + "cc", + "netdev", + "tokio", +] + +[[package]] +name = "ndk" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3f42e7bbe13d351b6bead8286a43aac9534b82bd3cc43e47037f012ebfd62d4" +dependencies = [ + "bitflags 2.13.2", + "jni-sys 0.3.1", + "log", + "ndk-sys", + "num_enum", + "raw-window-handle", + "thiserror 1.0.69", +] + +[[package]] +name = "ndk-sys" +version = "0.6.0+11769913" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ee6cda3051665f1fb8d9e08fc35c96d5a244fb1be711a03b71118828afc9a873" +dependencies = [ + "jni-sys 0.3.1", +] + +[[package]] +name = "netdev" +version = "0.31.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f901362e84cd407be6f8cd9d3a46bccf09136b095792785401ea7d283c79b91d" +dependencies = [ + "dlopen2 0.5.0", + "ipnet", + "libc", + "netlink-packet-core 0.7.0", + "netlink-packet-route 0.17.1", + "netlink-sys 0.8.8", + "once_cell", + "system-configuration 0.6.1", + "windows-sys 0.52.0", +] + +[[package]] +name = "netlink-packet-core" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72724faf704479d67b388da142b186f916188505e7e0b26719019c525882eda4" +dependencies = [ + "anyhow", + "byteorder", + "netlink-packet-utils 0.5.2", +] + +[[package]] +name = "netlink-packet-core" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2d6e2daf9a8c2e21302714706860a0e6be02e03d17294ecc66b354ea7d4059dd" + +[[package]] +name = "netlink-packet-generic" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e609a7be61318181c110df304d54ed3f3e129b9569b8ca16e40a9d644f46930c" +dependencies = [ + "netlink-packet-core 0.9.0", + "zerocopy 0.8.57", +] + +[[package]] +name = "netlink-packet-route" +version = "0.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "053998cea5a306971f88580d0829e90f270f940befd7cf928da179d4187a5a66" +dependencies = [ + "anyhow", + "bitflags 1.3.2", + "byteorder", + "libc", + "netlink-packet-core 0.7.0", + "netlink-packet-utils 0.5.2", +] + +[[package]] +name = "netlink-packet-route" +version = "0.33.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "59d48ffc8b73a506e1ff0878528c72668f2bfbc3d875b6be890a96be5d0d5576" +dependencies = [ + "bitflags 2.13.2", + "libc", + "log", + "netlink-packet-core 0.9.0", + "zerocopy 0.8.57", +] + +[[package]] +name = "netlink-packet-utils" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ede8a08c71ad5a95cdd0e4e52facd37190977039a4704eb82a283f713747d34" +dependencies = [ + "anyhow", + "byteorder", + "paste", + "thiserror 1.0.69", +] + +[[package]] +name = "netlink-packet-utils" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3176f18d11a1ae46053e59ec89d46ba318ae1343615bd3f8c908bfc84edae35c" +dependencies = [ + "byteorder", + "pastey", + "thiserror 2.0.20", +] + +[[package]] +name = "netlink-packet-wireguard" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1586e7d665d51e10a6e67eaf433beeea784c8dcb96d89c7b9b99444de4221d16" +dependencies = [ + "bitflags 2.13.2", + "libc", + "log", + "netlink-packet-core 0.9.0", + "netlink-packet-generic", +] + +[[package]] +name = "netlink-sys" +version = "0.8.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cd6c30ed10fa69cc491d491b85cc971f6bdeb8e7367b7cde2ee6cc878d583fae" +dependencies = [ + "bytes", + "libc", + "log", +] + +[[package]] +name = "netlink-sys" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c99d38e00b420df49e940fe0826e667c3dad82ac68eb4c2bbf754c1c14a83a10" +dependencies = [ + "bytes", + "libc", + "log", +] + +[[package]] +name = "network-interface" +version = "2.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ddcb8865ad3d9950f22f42ffa0ef0aecbfbf191867b3122413602b0a360b2a6" +dependencies = [ + "cc", + "libc", + "thiserror 2.0.20", + "winapi", +] + +[[package]] +name = "new_debug_unreachable" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "650eef8c711430f1a879fdd01d4745a7deea475becfb90269c06775983bbf086" + +[[package]] +name = "nibble_vec" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77a5d83df9f36fe23f0c3648c6bbb8b0298bb5f1939c8f2704431371f4b84d43" +dependencies = [ + "smallvec", +] + +[[package]] +name = "nix" +version = "0.25.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f346ff70e7dbfd675fe90590b92d59ef2de15a8779ae305ebcbfd3f0caf59be4" +dependencies = [ + "autocfg", + "bitflags 1.3.2", + "cfg-if", + "libc", +] + +[[package]] +name = "nix" +version = "0.29.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "71e2746dc3a24dd78b3cfcb7be93368c6de9963d30f43a6a73998a9cf4b17b46" +dependencies = [ + "bitflags 2.13.2", + "cfg-if", + "cfg_aliases", + "libc", + "memoffset", +] + +[[package]] +name = "nix" +version = "0.31.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf20d2fde8ff38632c426f1165ed7436270b44f199fc55284c38276f9db47c3d" +dependencies = [ + "bitflags 2.13.2", + "cfg-if", + "cfg_aliases", + "libc", + "memoffset", +] + +[[package]] +name = "no-std-net" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "43794a0ace135be66a25d3ae77d41b91615fb68ae937f904090203e81f755b65" + +[[package]] +name = "nohash-hasher" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2bf50223579dc7cdcfb3bfcacf7069ff68243f8c363f62ffa99cf000a6b9c451" + +[[package]] +name = "nom" +version = "7.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d273983c5a657a70a3e8f2a01329822f3b8c8172b73826411a55751e404a0a4a" +dependencies = [ + "memchr", + "minimal-lexical", +] + +[[package]] +name = "nom" +version = "8.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df9761775871bdef83bee530e60050f7e54b1105350d6884eb0fb4f46c2f9405" +dependencies = [ + "memchr", +] + +[[package]] +name = "nonempty" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e9e591e719385e6ebaeb5ce5d3887f7d5676fceca6411d1925ccc95745f3d6f7" + +[[package]] +name = "normpath" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9985ef7269fa99f3b12437bb698381da2428743ab90f20393f399fa14cab21a" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "nu-ansi-term" +version = "0.50.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7957b9740744892f114936ab4a57b3f487491bbeafaf8083688b16841a4240e5" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "num" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "35bd024e8b2ff75562e5f34e7f4905839deb4b22955ef5e73d2fea1b9813cb23" +dependencies = [ + "num-complex", + "num-integer", + "num-iter", + "num-rational", + "num-traits", +] + +[[package]] +name = "num-bigint" +version = "0.4.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c89e69e7e0f03bea5ef08013795c25018e101932225a656383bd384495ecc367" +dependencies = [ + "num-integer", + "num-traits", +] + +[[package]] +name = "num-bigint-dig" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e661dda6640fad38e827a6d4a310ff4763082116fe217f279885c97f511bb0b7" +dependencies = [ + "lazy_static", + "libm", + "num-integer", + "num-iter", + "num-traits", + "rand 0.8.8", + "smallvec", + "zeroize", +] + +[[package]] +name = "num-complex" +version = "0.4.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "73f88a1307638156682bada9d7604135552957b7818057dcef22705b4d509495" +dependencies = [ + "num-traits", +] + +[[package]] +name = "num-conv" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "521739c6d2bac4aa25192232afe6841231376b2b26d4d9fae5ecf8ca5772e441" + +[[package]] +name = "num-integer" +version = "0.1.47" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7ce2d95d4b3734dc35aa2f45e1aa22cd416814592a4f9d9205e11affd5b8e10b" +dependencies = [ + "num-traits", +] + +[[package]] +name = "num-iter" +version = "0.1.46" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c92800bd69a1eac91786bcfe9da64a897eb72911b8dc3095decbd07429e8048b" +dependencies = [ + "num-integer", + "num-traits", +] + +[[package]] +name = "num-rational" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f83d14da390562dca69fc84082e73e548e1ad308d24accdedd2720017cb37824" +dependencies = [ + "num-bigint", + "num-integer", + "num-traits", +] + +[[package]] +name = "num-traits" +version = "0.2.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" +dependencies = [ + "autocfg", + "libm", +] + +[[package]] +name = "num_enum" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d0bca838442ec211fa11de3a8b0e0e8f3a4522575b5c4c06ed722e005036f26" +dependencies = [ + "num_enum_derive", + "rustversion", +] + +[[package]] +name = "num_enum_derive" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "680998035259dcfcafe653688bf2aa6d3e2dc05e98be6ab46afb089dc84f1df8" +dependencies = [ + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "oauth2" +version = "5.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "51e219e79014df21a225b1860a479e2dcd7cbd9130f4defd4bd0e191ea31d67d" +dependencies = [ + "base64 0.22.1", + "chrono", + "getrandom 0.2.17", + "http", + "rand 0.8.8", + "serde", + "serde_json", + "serde_path_to_error", + "sha2 0.10.9", + "thiserror 1.0.69", + "url", +] + +[[package]] +name = "oauth2-reqwest" +version = "0.1.0-alpha.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "234fb5c965bbce983ee5de636a7a51d6a3223da8067ea02f9ab2d2d78ac08be2" +dependencies = [ + "oauth2", + "reqwest", +] + +[[package]] +name = "objc2" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3a12a8ed07aefc768292f076dc3ac8c48f3781c8f2d5851dd3d98950e8c5a89f" +dependencies = [ + "objc2-encode", + "objc2-exception-helper", +] + +[[package]] +name = "objc2-app-kit" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d49e936b501e5c5bf01fda3a9452ff86dc3ea98ad5f283e1455153142d97518c" +dependencies = [ + "bitflags 2.13.2", + "block2", + "objc2", + "objc2-core-foundation", + "objc2-core-graphics", + "objc2-foundation", +] + +[[package]] +name = "objc2-cloud-kit" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "73ad74d880bb43877038da939b7427bba67e9dd42004a18b809ba7d87cee241c" +dependencies = [ + "bitflags 2.13.2", + "objc2", + "objc2-foundation", +] + +[[package]] +name = "objc2-core-data" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b402a653efbb5e82ce4df10683b6b28027616a2715e90009947d50b8dd298fa" +dependencies = [ + "objc2", + "objc2-foundation", +] + +[[package]] +name = "objc2-core-foundation" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2a180dd8642fa45cdb7dd721cd4c11b1cadd4929ce112ebd8b9f5803cc79d536" +dependencies = [ + "bitflags 2.13.2", + "dispatch2", + "objc2", +] + +[[package]] +name = "objc2-core-graphics" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e022c9d066895efa1345f8e33e584b9f958da2fd4cd116792e15e07e4720a807" +dependencies = [ + "bitflags 2.13.2", + "dispatch2", + "objc2", + "objc2-core-foundation", + "objc2-io-surface", +] + +[[package]] +name = "objc2-core-image" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5d563b38d2b97209f8e861173de434bd0214cf020e3423a52624cd1d989f006" +dependencies = [ + "objc2", + "objc2-foundation", +] + +[[package]] +name = "objc2-core-location" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ca347214e24bc973fc025fd0d36ebb179ff30536ed1f80252706db19ee452009" +dependencies = [ + "objc2", + "objc2-foundation", +] + +[[package]] +name = "objc2-core-text" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0cde0dfb48d25d2b4862161a4d5fcc0e3c24367869ad306b0c9ec0073bfed92d" +dependencies = [ + "bitflags 2.13.2", + "objc2", + "objc2-core-foundation", + "objc2-core-graphics", +] + +[[package]] +name = "objc2-encode" +version = "4.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ef25abbcd74fb2609453eb695bd2f860d389e457f67dc17cafc8b8cbc89d0c33" + +[[package]] +name = "objc2-exception-helper" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7a1c5fbb72d7735b076bb47b578523aedc40f3c439bea6dfd595c089d79d98a" +dependencies = [ + "cc", +] + +[[package]] +name = "objc2-foundation" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3e0adef53c21f888deb4fa59fc59f7eb17404926ee8a6f59f5df0fd7f9f3272" +dependencies = [ + "bitflags 2.13.2", + "block2", + "libc", + "objc2", + "objc2-core-foundation", +] + +[[package]] +name = "objc2-io-surface" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "180788110936d59bab6bd83b6060ffdfffb3b922ba1396b312ae795e1de9d81d" +dependencies = [ + "bitflags 2.13.2", + "objc2", + "objc2-core-foundation", +] + +[[package]] +name = "objc2-quartz-core" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96c1358452b371bf9f104e21ec536d37a650eb10f7ee379fff67d2e08d537f1f" +dependencies = [ + "bitflags 2.13.2", + "objc2", + "objc2-core-foundation", + "objc2-foundation", +] + +[[package]] +name = "objc2-ui-kit" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d87d638e33c06f577498cbcc50491496a3ed4246998a7fbba7ccb98b1e7eab22" +dependencies = [ + "bitflags 2.13.2", + "block2", + "objc2", + "objc2-cloud-kit", + "objc2-core-data", + "objc2-core-foundation", + "objc2-core-graphics", + "objc2-core-image", + "objc2-core-location", + "objc2-core-text", + "objc2-foundation", + "objc2-quartz-core", + "objc2-user-notifications", +] + +[[package]] +name = "objc2-user-notifications" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9df9128cbbfef73cda168416ccf7f837b62737d748333bfe9ab71c245d76613e" +dependencies = [ + "objc2", + "objc2-foundation", +] + +[[package]] +name = "objc2-web-kit" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2e5aaab980c433cf470df9d7af96a7b46a9d892d521a2cbbb2f8a4c16751e7f" +dependencies = [ + "bitflags 2.13.2", + "block2", + "objc2", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-foundation", +] + +[[package]] +name = "oid-registry" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "12f40cff3dde1b6087cc5d5f5d4d65712f34016a03ed60e9c08dcc392736b5b7" +dependencies = [ + "asn1-rs", +] + +[[package]] +name = "once_cell" +version = "1.21.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" +dependencies = [ + "critical-section", + "portable-atomic", +] + +[[package]] +name = "once_cell_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe" + +[[package]] +name = "oorandom" +version = "11.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d6790f58c7ff633d8771f42965289203411a5e5c68388703c06e14f24770b41e" + +[[package]] +name = "opaque-debug" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c08d65885ee38876c4f86fa503fb49d7b507c2b62552df7c70b2fce627e06381" + +[[package]] +name = "open" +version = "5.4.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa576c76302b7b808eecc68061e67336c47833ef9d22caa74dda10fa9675eebc" +dependencies = [ + "dunce", + "is-wsl", + "libc", +] + +[[package]] +name = "openidconnect" +version = "4.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d8c6709ba2ea764bbed26bce1adf3c10517113ddea6f2d4196e4851757ef2b2" +dependencies = [ + "base64 0.21.7", + "chrono", + "dyn-clone", + "ed25519-dalek", + "hmac 0.12.1", + "http", + "itertools 0.10.5", + "log", + "oauth2", + "p256", + "p384", + "rand 0.8.8", + "rsa", + "serde", + "serde-value", + "serde_json", + "serde_path_to_error", + "serde_plain", + "serde_with", + "sha2 0.10.9", + "subtle", + "thiserror 1.0.69", + "url", +] + +[[package]] +name = "openssl" +version = "0.10.81" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77823a27f0babb03091cb9ed9ef80af3b39dbc82f97e8fa530374b7dafd87a45" +dependencies = [ + "bitflags 2.13.2", + "cfg-if", + "foreign-types 0.3.2", + "libc", + "openssl-macros", + "openssl-sys", +] + +[[package]] +name = "openssl-macros" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "openssl-probe" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c87def4c32ab89d880effc9e097653c8da5d6ef28e6b539d313baaacfbafcbe" + +[[package]] +name = "openssl-src" +version = "300.6.1+3.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "46eb8fb9fb3b61ce1c0f8a026c4c1a0714d3a9e138e7fbde78753ce2babc3846" +dependencies = [ + "cc", +] + +[[package]] +name = "openssl-sys" +version = "0.9.117" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b47e7e6bb2c38cd930d25a23b40fa52e068c10e85f3e03a7f5ba5aaca5713695" +dependencies = [ + "cc", + "libc", + "openssl-src", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "option-ext" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d" + +[[package]] +name = "ordered-float" +version = "2.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68f19d67e5a2795c94e73e0bb1cc1a7edeb2e28efd39e2e1c9b7a40c1108b11c" +dependencies = [ + "num-traits", +] + +[[package]] +name = "ordered-float" +version = "4.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7bb71e1b3fa6ca1c61f383464aaf2bb0e2f8e772a1f01d486832464de363b951" +dependencies = [ + "num-traits", +] + +[[package]] +name = "ordered-stream" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9aa2b01e1d916879f73a53d01d1d6cee68adbb31d6d9177a8cfce093cced1d50" +dependencies = [ + "futures-core", + "pin-project-lite", +] + +[[package]] +name = "ordered_hash_map" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e38d933ec41eca03e5f549db0529fa008f945d63cd66d491ed7f71376c1a94b5" +dependencies = [ + "hashbrown 0.15.5", +] + +[[package]] +name = "os_info" +version = "3.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9cf20a545b305cf1da722b236b5155c9bb35f1d5ceb28c048bd96ca842f41b5b" +dependencies = [ + "android_system_properties", + "log", + "nix 0.31.3", + "objc2", + "objc2-foundation", + "objc2-ui-kit", + "serde", + "windows-sys 0.61.2", +] + +[[package]] +name = "os_pipe" +version = "1.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d8fae84b431384b68627d0f9b3b1245fcf9f46f6c0e3dc902e9dce64edd1967" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "ouroboros" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e0f050db9c44b97a94723127e6be766ac5c340c48f2c4bb3ffa11713744be59" +dependencies = [ + "aliasable", + "ouroboros_macro", + "static_assertions", +] + +[[package]] +name = "ouroboros_macro" +version = "0.18.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c7028bdd3d43083f6d8d4d5187680d0d3560d54df4cc9d752005268b41e64d0" +dependencies = [ + "heck 0.4.1", + "proc-macro2", + "proc-macro2-diagnostics", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "owned_ttf_parser" +version = "0.25.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "36820e9051aca1014ddc75770aab4d68bc1e9e632f0f5627c4086bc216fb583b" +dependencies = [ + "ttf-parser", +] + +[[package]] +name = "p256" +version = "0.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c9863ad85fa8f4460f9c48cb909d38a0d689dba1f6f6988a5e3e0d31071bcd4b" +dependencies = [ + "ecdsa", + "elliptic-curve", + "primeorder", + "sha2 0.10.9", +] + +[[package]] +name = "p384" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fe42f1670a52a47d448f14b6a5c61dd78fce51856e68edaa38f7ae3a46b8d6b6" +dependencies = [ + "ecdsa", + "elliptic-curve", + "primeorder", + "sha2 0.10.9", +] + +[[package]] +name = "page_size" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "30d5b2194ed13191c1999ae0704b7839fb18384fa22e49b57eeaa97d79ce40da" +dependencies = [ + "libc", + "winapi", +] + +[[package]] +name = "pango" +version = "0.18.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7ca27ec1eb0457ab26f3036ea52229edbdb74dee1edd29063f5b9b010e7ebee4" +dependencies = [ + "gio", + "glib", + "libc", + "once_cell", + "pango-sys", +] + +[[package]] +name = "pango-sys" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "436737e391a843e5933d6d9aa102cb126d501e815b83601365a948a518555dc5" +dependencies = [ + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "papergrid" +version = "0.18.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d0984e668274d34691bc2b262ef0d115de5fa9973bcdee7ae32213f93099153e" +dependencies = [ + "bytecount", + "fnv", + "unicode-width", +] + +[[package]] +name = "parking" +version = "2.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f38d5652c16fde515bb1ecef450ab0f6a219d619a7274976324d5e377f7dceba" + +[[package]] +name = "parking_lot" +version = "0.12.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93857453250e3077bd71ff98b6a65ea6621a19bb0f559a85248955ac12c45a1a" +dependencies = [ + "lock_api", + "parking_lot_core", +] + +[[package]] +name = "parking_lot_core" +version = "0.9.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2621685985a2ebf1c516881c026032ac7deafcda1a2c9b7850dc81e3dfcb64c1" +dependencies = [ + "cfg-if", + "libc", + "redox_syscall 0.5.18", + "smallvec", + "windows-link 0.2.1", +] + +[[package]] +name = "password-auth" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a2a4764cc1f8d961d802af27193c6f4f0124bd0e76e8393cf818e18880f0524" +dependencies = [ + "argon2", + "getrandom 0.2.17", + "password-hash", + "rand_core 0.6.4", +] + +[[package]] +name = "password-hash" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "346f04948ba92c43e8469c1ee6736c7563d71012b17d40745260fe106aac2166" +dependencies = [ + "base64ct", + "rand_core 0.6.4", + "subtle", +] + +[[package]] +name = "paste" +version = "1.0.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "57c0d7b74b563b49d38dae00a0c37d4d6de9b432382b2892f0574ddcae73fd0a" + +[[package]] +name = "pastey" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "35fb2e5f958ec131621fdd531e9fc186ed768cbe395337403ae56c17a74c68ec" + +[[package]] +name = "pbjson" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e8edd1efdd8ab23ba9cb9ace3d9987a72663d5d7c9f74fa00b51d6213645cf6c" +dependencies = [ + "base64 0.22.1", + "serde", +] + +[[package]] +name = "pbjson-build" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ed4d5c6ae95e08ac768883c8401cf0e8deb4e6e1d6a4e1fd3d2ec4f0ec63200" +dependencies = [ + "heck 0.5.0", + "itertools 0.14.0", + "prost 0.14.4", + "prost-types 0.14.4", +] + +[[package]] +name = "pbkdf2" +version = "0.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "112d82ceb8c5bf524d9af484d4e4970c9fd5a0cc15ba14ad93dccd28873b0629" +dependencies = [ + "digest 0.11.3", + "hmac 0.13.0", +] + +[[package]] +name = "pem" +version = "3.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d30c53c26bc5b31a98cd02d20f25a7c8567146caf63ed593a9d87b2775291be" +dependencies = [ + "base64 0.22.1", + "serde_core", +] + +[[package]] +name = "pem" +version = "4.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d354a98a3d1251555de99e8fdd8afda05573c31b82f59063a7b0a29b5527f120" +dependencies = [ + "base64 0.23.1", + "serde_core", +] + +[[package]] +name = "pem-rfc7468" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "88b39c9bfcfc231068454382784bb460aae594343fb030d46e9f50a645418412" +dependencies = [ + "base64ct", +] + +[[package]] +name = "percent-encoding" +version = "2.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" + +[[package]] +name = "petgraph" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8701b58ea97060d5e5b155d383a69952a60943f0e6dfe30b04c287beb0b27455" +dependencies = [ + "fixedbitset", + "hashbrown 0.15.5", + "indexmap 2.14.2", + "serde", +] + +[[package]] +name = "pgvector" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3673cba5b9a124916096a423b806a9f29620972c6c97b08db5f2053e9428b481" +dependencies = [ + "serde", +] + +[[package]] +name = "phf" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c1562dc717473dbaa4c1f85a36410e03c047b2e7df7f45ee938fbef64ae7fadf" +dependencies = [ + "phf_macros", + "phf_shared", + "serde", +] + +[[package]] +name = "phf_codegen" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "49aa7f9d80421bca176ca8dbfebe668cc7a2684708594ec9f3c0db0805d5d6e1" +dependencies = [ + "phf_generator", + "phf_shared", +] + +[[package]] +name = "phf_generator" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "135ace3a761e564ec88c03a77317a7c6b80bb7f7135ef2544dbe054243b89737" +dependencies = [ + "fastrand", + "phf_shared", +] + +[[package]] +name = "phf_macros" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "812f032b54b1e759ccd5f8b6677695d5268c588701effba24601f6932f8269ef" +dependencies = [ + "phf_generator", + "phf_shared", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "phf_shared" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e57fef6bc5981e38c2ce2d63bfa546861309f875b8a75f092d1d54ae2d64f266" +dependencies = [ + "siphasher", +] + +[[package]] +name = "pin-project" +version = "1.1.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2466b2336ed02bcdca6b294417127b90ec92038d1d5c4fbeac971a922e0e0924" +dependencies = [ + "pin-project-internal", +] + +[[package]] +name = "pin-project-internal" +version = "1.1.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c96395f0a926bc13b1c17622aaddda1ecb55d49c8f1bf9777e4d877800a43f8b" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "pin-project-lite" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" + +[[package]] +name = "piper" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c835479a4443ded371d6c535cbfd8d31ad92c5d23ae9770a61bc155e4992a3c1" +dependencies = [ + "atomic-waker", + "fastrand", + "futures-io", +] + +[[package]] +name = "pkcs1" +version = "0.7.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8ffb9f10fa047879315e6625af03c164b16962a5368d724ed16323b68ace47f" +dependencies = [ + "der", + "pkcs8", + "spki", +] + +[[package]] +name = "pkcs8" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f950b2377845cebe5cf8b5165cb3cc1a5e0fa5cfa3e1f7f55707d8fd82e0a7b7" +dependencies = [ + "der", + "spki", +] + +[[package]] +name = "pkg-config" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6b464fbc74e149a392436b17d523f769e057cb6877f6a5c4618bc6f11800548" + +[[package]] +name = "plain" +version = "0.2.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b4596b6d070b27117e987119b4dac604f3c58cfb0b191112e24771b2faeac1a6" + +[[package]] +name = "plist" +version = "1.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2896bade328c13f7042a297ea5ac5b0951f6cf989dea5f32c2fd98da398195cb" +dependencies = [ + "base64 0.23.1", + "indexmap 2.14.2", + "quick-xml 0.42.0", + "serde", + "time", +] + +[[package]] +name = "plotters" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5aeb6f403d7a4911efb1e33402027fc44f29b5bf6def3effcc22d7bb75f2b747" +dependencies = [ + "num-traits", + "plotters-backend", + "plotters-svg", + "wasm-bindgen", + "web-sys", +] + +[[package]] +name = "plotters-backend" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df42e13c12958a16b3f7f4386b9ab1f3e7933914ecea48da7139435263a4172a" + +[[package]] +name = "plotters-svg" +version = "0.3.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "51bae2ac328883f7acdfea3d66a7c35751187f870bc81f94563733a154d7a670" +dependencies = [ + "plotters-backend", +] + +[[package]] +name = "pnet_base" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ffc190d4067df16af3aba49b3b74c469e611cad6314676eaf1157f31aa0fb2f7" +dependencies = [ + "no-std-net", +] + +[[package]] +name = "pnet_datalink" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e79e70ec0be163102a332e1d2d5586d362ad76b01cec86f830241f2b6452a7b7" +dependencies = [ + "ipnetwork 0.20.0", + "libc", + "pnet_base", + "pnet_sys", + "winapi", +] + +[[package]] +name = "pnet_sys" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d4643d3d4db6b08741050c2f3afa9a892c4244c085a72fcda93c9c2c9a00f4b" +dependencies = [ + "libc", + "winapi", +] + +[[package]] +name = "png" +version = "0.17.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82151a2fc869e011c153adc57cf2789ccb8d9906ce52c0b39a6b5697749d7526" +dependencies = [ + "bitflags 1.3.2", + "crc32fast", + "fdeflate", + "flate2", + "miniz_oxide 0.8.9", +] + +[[package]] +name = "png" +version = "0.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60769b8b31b2a9f263dae2776c37b1b28ae246943cf719eb6946a1db05128a61" +dependencies = [ + "bitflags 2.13.2", + "crc32fast", + "fdeflate", + "flate2", + "miniz_oxide 0.8.9", +] + +[[package]] +name = "polling" +version = "3.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d0e4f59085d47d8241c88ead0f274e8a0cb551f3625263c05eb8dd897c34218" +dependencies = [ + "cfg-if", + "concurrent-queue", + "hermit-abi", + "pin-project-lite", + "rustix 1.1.5", + "windows-sys 0.61.2", +] + +[[package]] +name = "poly1305" +version = "0.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8159bd90725d2df49889a078b54f4f79e87f1f8a8444194cdca81d38f5393abf" +dependencies = [ + "cpufeatures 0.2.17", + "opaque-debug", + "universal-hash 0.5.1", +] + +[[package]] +name = "poly1305" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e2d0073b297041425c7c3df6eb4792d598a15323fe63346852b092eca02904c" +dependencies = [ + "cpufeatures 0.3.1", + "universal-hash 0.6.1", +] + +[[package]] +name = "polyval" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d1fe60d06143b2430aa532c94cfe9e29783047f06c0d7fd359a9a51b729fa25" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "opaque-debug", + "universal-hash 0.5.1", +] + +[[package]] +name = "portable-atomic" +version = "1.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "05c8b63e8d9609db387f0324918f81d68fe27748f084ef092fb35954d0539a85" + +[[package]] +name = "portable-atomic-util" +version = "0.2.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10ab3eb7f3becc3a1cbc4f2c6f20267996cfc1a6467a873763411b136a122715" +dependencies = [ + "portable-atomic", +] + +[[package]] +name = "potential_utf" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d83eb9bc6d8e5cf568e7a1101d60ee05e81ed50ea106026f3d18deeb046d7661" +dependencies = [ + "zerovec", +] + +[[package]] +name = "powerfmt" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "439ee305def115ba05938db6eb1644ff94165c5ab5e9420d1c1bcedbba909391" + +[[package]] +name = "ppmd-rust" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "196a7c80b9a7652aba7cc070827516c2abe4ccdf53d128e1944003cf5726cff1" + +[[package]] +name = "ppv-lite86" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9" +dependencies = [ + "zerocopy 0.8.57", +] + +[[package]] +name = "precomputed-hash" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "925383efa346730478fb4838dbe9137d2a47675ad789c546d150a6e1dd4ab31c" + +[[package]] +name = "prefix-trie" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85cf4c7c25f1dd66c76b451e9041a8cfce26e4ca754934fa7aed8d5a59a01d20" +dependencies = [ + "ipnet", + "num-traits", +] + +[[package]] +name = "prefix-trie" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6369af434551b9bf8be05ab871ac1263687d6f0c9485e6d781f904f3e06d7d03" +dependencies = [ + "array-const-fn-init", + "cidr", + "either", + "ipnet", + "num-traits", + "smallvec", +] + +[[package]] +name = "prettyplease" +version = "0.2.37" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "479ca8adacdd7ce8f1fb39ce9ecccbfe93a3f1344b3d0d97f20bc0196208f62b" +dependencies = [ + "proc-macro2", + "syn 2.0.119", +] + +[[package]] +name = "prettyplease" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2bfe0f4c752e450fc2faf62654f1c134747922825d5b04ca717b8874f41a40c0" +dependencies = [ + "proc-macro2", + "syn 3.0.6", +] + +[[package]] +name = "primeorder" +version = "0.13.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "353e1ca18966c16d9deb1c69278edbc5f194139612772bd9537af60ac231e1e6" +dependencies = [ + "elliptic-curve", +] + +[[package]] +name = "proc-macro-crate" +version = "1.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f4c021e1093a56626774e81216a4ce732a735e5bad4868a03f3ed65ca0c3919" +dependencies = [ + "once_cell", + "toml_edit 0.19.15", +] + +[[package]] +name = "proc-macro-crate" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e8366a6159044a37876a2b9817124296703c586a5c92e2c53751fa06d8d43e8" +dependencies = [ + "toml_edit 0.20.7", +] + +[[package]] +name = "proc-macro-crate" +version = "3.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e67ba7e9b2b56446f1d419b1d807906278ffa1a658a8a5d8a39dcb1f5a78614f" +dependencies = [ + "toml_edit 0.25.15+spec-1.1.0", +] + +[[package]] +name = "proc-macro-error" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c" +dependencies = [ + "proc-macro-error-attr", + "proc-macro2", + "quote", + "syn 1.0.109", + "version_check", +] + +[[package]] +name = "proc-macro-error-attr" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869" +dependencies = [ + "proc-macro2", + "quote", + "version_check", +] + +[[package]] +name = "proc-macro-error-attr3" +version = "3.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e564d14133360e1ae169ffde5da25881b5fa47261665b8e5713c212c27799da" +dependencies = [ + "proc-macro2", + "quote", +] + +[[package]] +name = "proc-macro-error3" +version = "3.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f0d4471b3436c22106b21913b1dda531558918ae9b7ec55d58aa84b43552233" +dependencies = [ + "proc-macro-error-attr3", + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "proc-macro2" +version = "1.0.107" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "proc-macro2-diagnostics" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af066a9c399a26e020ada66a034357a868728e72cd426f3adcd35f80d88d88c8" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", + "version_check", + "yansi", +] + +[[package]] +name = "prost" +version = "0.13.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2796faa41db3ec313a31f7624d9286acf277b52de526150b7e69f3debf891ee5" +dependencies = [ + "bytes", + "prost-derive 0.13.5", +] + +[[package]] +name = "prost" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "528ac67416ff8646872a3c02cad9cc4ee5dc9f9540c9b10771855c95cb2e5ae1" +dependencies = [ + "bytes", + "prost-derive 0.14.4", +] + +[[package]] +name = "prost-build" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03da047801ff44bb6a4d407d4860c05fd70bb81714e6b2f3812603d5b145b042" +dependencies = [ + "heck 0.5.0", + "itertools 0.14.0", + "log", + "multimap", + "petgraph", + "prettyplease 0.2.37", + "prost 0.14.4", + "prost-types 0.14.4", + "regex", + "syn 2.0.119", + "tempfile", +] + +[[package]] +name = "prost-derive" +version = "0.13.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a56d757972c98b346a9b766e3f02746cde6dd1cd1d1d563472929fdd74bec4d" +dependencies = [ + "anyhow", + "itertools 0.14.0", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "prost-derive" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b570b25f7617e43d59005d0990ccb79e950a423952cea19671b7a876da390adf" +dependencies = [ + "anyhow", + "itertools 0.14.0", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "prost-reflect" +version = "0.14.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b5edd582b62f5cde844716e66d92565d7faf7ab1445c8cebce6e00fba83ddb2" +dependencies = [ + "once_cell", + "prost 0.13.5", + "prost-reflect-derive", + "prost-types 0.13.5", +] + +[[package]] +name = "prost-reflect-derive" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f4fce6b22f15cc8d8d400a2b98ad29202b33bd56c7d9ddd815bc803a807ecb65" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "prost-types" +version = "0.13.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52c2c1bf36ddb1a1c396b3601a3cec27c2462e45f07c386894ec3ccf5332bd16" +dependencies = [ + "prost 0.13.5", +] + +[[package]] +name = "prost-types" +version = "0.14.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f94967dc7688f3054c7fac87473ffae4cc4c3904800e2d9f5b857246d8963b0a" +dependencies = [ + "prost 0.14.4", +] + +[[package]] +name = "prost-wkt" +version = "0.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4bf89e78de037257a7be0177e894311c31bf7f0a02b752e74f402a5b324cc0fc" +dependencies = [ + "chrono", + "inventory", + "prost 0.14.4", + "serde", + "serde_derive", + "serde_json", + "typetag", +] + +[[package]] +name = "prost-wkt-build" +version = "0.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb5cd191fad9142d096efc97c64715db73db4adb60c38ebdf22f5b54cd6ea712" +dependencies = [ + "heck 0.5.0", + "prost 0.14.4", + "prost-build", + "prost-types 0.14.4", + "quote", +] + +[[package]] +name = "prost-wkt-types" +version = "0.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c46d9cbfee659aaabc63e8ab7d88e4814c2ad6eacdc09b404244ce3c7fbcdfc" +dependencies = [ + "chrono", + "prost 0.14.4", + "prost-build", + "prost-types 0.14.4", + "prost-wkt", + "prost-wkt-build", + "regex", + "serde", + "serde_derive", + "serde_json", +] + +[[package]] +name = "pxfm" +version = "0.1.30" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d55d956fa96f5ec02be2e13af0e20391a5aa83d6a074e3ad368959d0fab299ea" + +[[package]] +name = "quanta" +version = "0.12.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3ab5a9d756f0d97bdc89019bd2e4ea098cf9cde50ee7564dde6b81ccc8f06c7" +dependencies = [ + "crossbeam-utils", + "libc", + "once_cell", + "raw-cpuid", + "wasi", + "web-sys", + "winapi", +] + +[[package]] +name = "quick-error" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a993555f31e5a609f617c12db6250dedcac1b0a85076912c436e6fc9b2c8e6a3" + +[[package]] +name = "quick-xml" +version = "0.41.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e660451e55124f798a69a5af3f49ccfbefbd41910eefd25caf2393e1f3473ec1" +dependencies = [ + "memchr", +] + +[[package]] +name = "quick-xml" +version = "0.42.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41b1177fdf999d2321d3fb46ff47159d9c1fb9ad66a4879f8c50a0b504615e9b" +dependencies = [ + "memchr", +] + +[[package]] +name = "quinn" +version = "0.11.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4051e23e9185c255a7e33ef59cdbca87a22d359052eecd22fc6b901fb37d9d11" +dependencies = [ + "bytes", + "cfg_aliases", + "pin-project-lite", + "quinn-proto", + "quinn-udp", + "rustc-hash", + "rustls", + "socket2", + "thiserror 2.0.20", + "tokio", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-proto" +version = "0.11.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a9746dbde176634f4f2f1faf2404e30a31b2bc1e9cafb5329c95d8177a18c9fc" +dependencies = [ + "aws-lc-rs", + "bytes", + "fastbloom", + "getrandom 0.4.3", + "lru-slab", + "rand 0.10.2", + "rand_pcg", + "ring", + "rustc-hash", + "rustls", + "rustls-pki-types", + "rustls-platform-verifier", + "slab", + "thiserror 2.0.20", + "tinyvec", + "tracing", + "web-time", +] + +[[package]] +name = "quinn-udp" +version = "0.5.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "35a133f956daabe89a61a685c2649f13d82d5aa4bd5d12d1277e1072a21c0694" +dependencies = [ + "cfg_aliases", + "libc", + "once_cell", + "socket2", + "tracing", + "windows-sys 0.61.2", +] + +[[package]] +name = "quote" +version = "1.0.47" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "r-efi" +version = "5.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "69cdb34c158ceb288df11e18b4bd39de994f6657d83847bdffdbd7f346754b0f" + +[[package]] +name = "r-efi" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf" + +[[package]] +name = "radix_trie" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c069c179fcdc6a2fe24d8d18305cf085fdbd4f922c041943e203685d6a1c58fd" +dependencies = [ + "endian-type", + "nibble_vec", +] + +[[package]] +name = "rand" +version = "0.8.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e058c7de0b26af77780c769414d6257830bb240f3c38477dbc2c16e5f54d6d4c" +dependencies = [ + "libc", + "rand_chacha 0.3.1", + "rand_core 0.6.4", +] + +[[package]] +name = "rand" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9ef1d0d795eb7d84685bca4f72f3649f064e6641543d3a8c415898726a57b41" +dependencies = [ + "rand_chacha 0.9.0", + "rand_core 0.9.5", +] + +[[package]] +name = "rand" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7f5fa3a058cd35567ef9bfa5e75732bee0f9e4c55fa90477bef2dfcdbc4be80" +dependencies = [ + "chacha20 0.10.2", + "getrandom 0.4.3", + "rand_core 0.10.1", +] + +[[package]] +name = "rand_chacha" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88" +dependencies = [ + "ppv-lite86", + "rand_core 0.6.4", +] + +[[package]] +name = "rand_chacha" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb" +dependencies = [ + "ppv-lite86", + "rand_core 0.9.5", +] + +[[package]] +name = "rand_core" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c" +dependencies = [ + "getrandom 0.2.17", +] + +[[package]] +name = "rand_core" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "76afc826de14238e6e8c374ddcc1fa19e374fd8dd986b0d2af0d02377261d83c" +dependencies = [ + "getrandom 0.3.4", +] + +[[package]] +name = "rand_core" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63b8176103e19a2643978565ca18b50549f6101881c443590420e4dc998a3c69" + +[[package]] +name = "rand_distr" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4d431c2703ccf129de4d45253c03f49ebb22b97d6ad79ee3ecfc7e3f4862c1d8" +dependencies = [ + "num-traits", + "rand 0.10.2", +] + +[[package]] +name = "rand_pcg" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "caa0f4137e1c0a72f4c651489402276c8e8e1cf081f3b0ba156d2cbeef09e86a" +dependencies = [ + "rand_core 0.10.1", +] + +[[package]] +name = "raw-cpuid" +version = "11.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "498cd0dc59d73224351ee52a95fee0f1a617a2eae0e7d9d720cc622c73a54186" +dependencies = [ + "bitflags 2.13.2", +] + +[[package]] +name = "raw-window-handle" +version = "0.6.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "20675572f6f24e9e76ef639bc5552774ed45f1c30e2951e1e99c59888861c539" + +[[package]] +name = "rawpointer" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60a357793950651c4ed0f3f52338f53b2f809f32d83a07f72909fa13e4c6c1e3" + +[[package]] +name = "rayon" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fb39b166781f92d482534ef4b4b1b2568f42613b53e5b6c160e24cfbfa30926d" +dependencies = [ + "either", + "rayon-core", +] + +[[package]] +name = "rayon-core" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "22e18b0f0062d30d4230b2e85ff77fdfe4326feb054b9783a3460d8435c8ab91" +dependencies = [ + "crossbeam-deque", + "crossbeam-utils", +] + +[[package]] +name = "rcgen" +version = "0.14.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8774e05a7d0de114588e6a28fe7e71694b82614ed569d86d8b389dfbc98b8ad8" +dependencies = [ + "pem 4.0.0", + "ring", + "rustls-pki-types", + "time", + "x509-parser", + "yasna", +] + +[[package]] +name = "redox_syscall" +version = "0.5.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed2bf2547551a7053d6fdfafda3f938979645c44812fbfcda098faae3f1a362d" +dependencies = [ + "bitflags 2.13.2", +] + +[[package]] +name = "redox_syscall" +version = "0.9.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "737970939a87c6fa31e7acad13307bccbb017a073b695b6089a2c484f929e20e" +dependencies = [ + "bitflags 2.13.2", +] + +[[package]] +name = "redox_users" +version = "0.4.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba009ff324d1fc1b900bd1fdb31564febe58a8ccc8a6fdbb93b543d33b13ca43" +dependencies = [ + "getrandom 0.2.17", + "libredox", + "thiserror 1.0.69", +] + +[[package]] +name = "redox_users" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60dc65c0ff1a7ae1294b0c67b9f14baf70b644404010370171787bfac1038fc0" +dependencies = [ + "libredox", + "thiserror 2.0.20", +] + +[[package]] +name = "ref-cast" +version = "1.0.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e440fb4e4b4147295338efb76001ab9e4efc0e5839df2c47fc5ac2381d365c3" +dependencies = [ + "ref-cast-impl", +] + +[[package]] +name = "ref-cast-impl" +version = "1.0.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92ecd8964f8453721699a1ed72037b0db49ce2f5a5138486ee89bed6f67cdf3a" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "regex" +version = "1.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f020237b6c8eed93db2e2cb53c00c60a8e1bc73da7d073199a1180401450218d" +dependencies = [ + "aho-corasick", + "memchr", + "regex-automata", + "regex-syntax", +] + +[[package]] +name = "regex-automata" +version = "0.4.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ad8553b9b26413251cbf30e620595c7a41b3887f03da04579c0e6b0d6a06b4b2" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.8.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4" + +[[package]] +name = "relative-path" +version = "1.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba39f3699c378cd8970968dcbff9c43159ea4cfbd88d43c00b22f2ef10a435d2" + +[[package]] +name = "reqwest" +version = "0.13.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "16a1cfa75cc186dd73d5818e510e042e40927bccc9c236b061cea97e1eb08029" +dependencies = [ + "base64 0.23.1", + "bytes", + "encoding_rs", + "futures-channel", + "futures-core", + "futures-util", + "h2", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-rustls", + "hyper-util", + "js-sys", + "log", + "mime", + "percent-encoding", + "pin-project-lite", + "quinn", + "rustls", + "rustls-pki-types", + "rustls-platform-verifier", + "serde", + "serde_json", + "sync_wrapper", + "tokio", + "tokio-rustls", + "tokio-util", + "tower", + "tower-http 0.6.11", + "tower-service", + "url", + "wasm-bindgen", + "wasm-bindgen-futures", + "wasm-streams", + "web-sys", +] + +[[package]] +name = "resolv-conf" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e061d1b48cb8d38042de4ae0a7a6401009d6143dc80d2e2d6f31f0bdd6470c7" + +[[package]] +name = "rfc6979" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8dd2a808d456c4a54e300a23e9f5a67e122c3024119acbfd73e3bf664491cb2" +dependencies = [ + "hmac 0.12.1", + "subtle", +] + +[[package]] +name = "ring" +version = "0.17.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4689e6c2294d81e88dc6261c768b63bc4fcdb852be6d1352498b114f61383b7" +dependencies = [ + "cc", + "cfg-if", + "getrandom 0.2.17", + "libc", + "untrusted", + "windows-sys 0.52.0", +] + +[[package]] +name = "ringbuf" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b123165531e325df9079f56c036f2da4103a5d5abfef9e2fda4b9c34d1ef7aa" +dependencies = [ + "crossbeam-utils", + "portable-atomic", + "portable-atomic-util", +] + +[[package]] +name = "rmp" +version = "0.8.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ba8be72d372b2c9b35542551678538b562e7cf86c3315773cae48dfbfe7790c" +dependencies = [ + "num-traits", +] + +[[package]] +name = "rmp-serde" +version = "1.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72f81bee8c8ef9b577d1681a70ebbc962c232461e397b22c208c43c04b67a155" +dependencies = [ + "rmp", + "serde", +] + +[[package]] +name = "rsa" +version = "0.9.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8573f03f5883dcaebdfcf4725caa1ecb9c15b2ef50c43a07b816e06799bb12d" +dependencies = [ + "const-oid 0.9.6", + "digest 0.10.7", + "num-bigint-dig", + "num-integer", + "num-traits", + "pkcs1", + "pkcs8", + "rand_core 0.6.4", + "signature", + "spki", + "subtle", + "zeroize", +] + +[[package]] +name = "rstest" +version = "0.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "948203e6d13b83e51a90d7cf236dd58a0065f23f4b902f00f306e7eb2bd09b9c" +dependencies = [ + "futures-timer", + "futures-util", + "rstest_macros", +] + +[[package]] +name = "rstest_macros" +version = "0.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8d92eaf7b6e51e12471d71ddc72608e7151573de44099aacfbb1128177c0da4" +dependencies = [ + "cfg-if", + "glob", + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "regex", + "relative-path", + "rustc_version", + "syn 2.0.119", + "unicode-ident", +] + +[[package]] +name = "rusqlite" +version = "0.32.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7753b721174eb8ff87a9a0e799e2d7bc3749323e773db92e0984debb00019d6e" +dependencies = [ + "bitflags 2.13.2", + "fallible-iterator", + "fallible-streaming-iterator", + "hashlink 0.9.1", + "libsqlite3-sys", + "smallvec", +] + +[[package]] +name = "rust-embed" +version = "8.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e9e7760e252aaba7b09f4be00e36476cf585bdb68a53552ac954cdf504ab4bc9" +dependencies = [ + "rust-embed-impl", + "rust-embed-utils", + "walkdir", +] + +[[package]] +name = "rust-embed-impl" +version = "8.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3bcfc4d6f53af43755f7a723e4b6b8794fcce052a178dd8c6c1dadc5f5343097" +dependencies = [ + "mime_guess", + "proc-macro2", + "quote", + "rust-embed-utils", + "syn 2.0.119", + "walkdir", +] + +[[package]] +name = "rust-embed-utils" +version = "8.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42ffa149f6aa81b58a5b3011d01a857c4ed12c7a732d2c51947a4c7c692185f0" +dependencies = [ + "globset", + "sha2 0.11.0", + "walkdir", +] + +[[package]] +name = "rust-i18n" +version = "4.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7c43fd69c20da13756643a5bf51ae799965465c78e05c57a1242a736aaa56527" +dependencies = [ + "globwalk 0.8.1", + "regex", + "rust-i18n-macro", + "rust-i18n-support", + "smallvec", +] + +[[package]] +name = "rust-i18n-macro" +version = "4.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "086ec8a9eaa6afda33919b9bc1661c1f4e017c40e99bbd33ca98f6e1cb6ca91f" +dependencies = [ + "glob", + "proc-macro2", + "quote", + "rust-i18n-support", + "serde", + "serde_json", + "syn 2.0.119", +] + +[[package]] +name = "rust-i18n-support" +version = "4.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac02dcb9a01ec145d0a5534ea9554a966050ca250b346bb2a9ab0fcdafab5979" +dependencies = [ + "arc-swap", + "base62", + "globwalk 0.8.1", + "itertools 0.11.0", + "normpath", + "serde", + "serde-saphyr", + "serde_json", + "siphasher", + "toml 0.8.23", + "triomphe", +] + +[[package]] +name = "rust_decimal" +version = "1.43.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7653272e75dcac41dc199fbea6f5797633994fafd339943c06c9af16bf29cd3a" +dependencies = [ + "arrayvec", + "borsh", + "bytes", + "num-traits", + "rand 0.8.8", + "rand 0.9.5", + "serde", + "serde_json", + "wasm-bindgen", +] + +[[package]] +name = "rustc-hash" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6b1e7f9a428571be2dc5bc0505c13fb6bf936822b894ec87abf8a08a4e51742d" + +[[package]] +name = "rustc_version" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfcb3a22ef46e85b45de6ee7e79d063319ebb6594faafcf1c225ea92ab6e9b92" +dependencies = [ + "semver", +] + +[[package]] +name = "rusticata-macros" +version = "4.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "faf0c4a6ece9950b9abdb62b1cfcf2a68b3b67a10ba445b3bb85be2a293d0632" +dependencies = [ + "nom 7.1.3", +] + +[[package]] +name = "rustix" +version = "0.38.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fdb5bc1ae2baa591800df16c9ca78619bf65c0488b41b96ccec5d11220d8c154" +dependencies = [ + "bitflags 2.13.2", + "errno", + "libc", + "linux-raw-sys 0.4.15", + "windows-sys 0.59.0", +] + +[[package]] +name = "rustix" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "891efababe418670775f199f0d233d84843c227a0949a883ce15b37c78d6629d" +dependencies = [ + "bitflags 2.13.2", + "errno", + "libc", + "linux-raw-sys 0.12.1", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustls" +version = "0.23.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d41d731c7d2f962d1ccc364cec258de3c0e93b38c2fb3ba97ac74513048d634" +dependencies = [ + "aws-lc-rs", + "once_cell", + "ring", + "rustls-pki-types", + "rustls-webpki", + "subtle", + "zeroize", +] + +[[package]] +name = "rustls-native-certs" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dab5152771c58876a2146916e53e35057e1a4dfa2b9df0f0305b07f611fdea4d" +dependencies = [ + "openssl-probe", + "rustls-pki-types", + "schannel", + "security-framework", +] + +[[package]] +name = "rustls-pki-types" +version = "1.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2f4925028c7eb5d1fcdaf196971378ed9d2c1c4efc7dc5d011256f76c99c0a96" +dependencies = [ + "web-time", + "zeroize", +] + +[[package]] +name = "rustls-platform-verifier" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "26d1e2536ce4f35f4846aa13bff16bd0ff40157cdb14cc056c7b14ba41233ba0" +dependencies = [ + "core-foundation 0.10.1", + "core-foundation-sys", + "jni 0.22.4", + "log", + "once_cell", + "rustls", + "rustls-native-certs", + "rustls-platform-verifier-android", + "rustls-webpki", + "security-framework", + "security-framework-sys", + "webpki-root-certs", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustls-platform-verifier-android" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f87165f0995f63a9fbeea62b64d10b4d9d8e78ec6d7d51fb2125fda7bb36788f" + +[[package]] +name = "rustls-webpki" +version = "0.103.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3c3cf1d8b1e7d4927e2d154c3fcb02979afb9939629c62cd9048d4f07b60ac2" +dependencies = [ + "aws-lc-rs", + "ring", + "rustls-pki-types", + "untrusted", +] + +[[package]] +name = "rustversion" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf54715a573b99ac80df0bc206da022bcd442c974952c7b9720069370852e21f" + +[[package]] +name = "ryu" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9774ba4a74de5f7b1c1451ed6cd5285a32eddb5cccb8cc655a4e50009e06477f" + +[[package]] +name = "safe_arch" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42c6efa15875e6ecb39ca61fb0b0c1a40b84fac5a5ffe71eef7d1000c8eb3f5f" +dependencies = [ + "bytemuck", +] + +[[package]] +name = "same-file" +version = "1.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502" +dependencies = [ + "winapi-util", +] + +[[package]] +name = "schannel" +version = "0.1.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91c1b7e4904c873ef0710c1f407dde2e6287de2bebc1bbbf7d430bb7cbffd939" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "schemars" +version = "0.8.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3fbf2ae1b8bc8e02df939598064d22402220cd5bbcca1c76f7d6a310974d5615" +dependencies = [ + "dyn-clone", + "indexmap 1.9.3", + "schemars_derive", + "serde", + "serde_json", + "url", + "uuid", +] + +[[package]] +name = "schemars" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4cd191f9397d57d581cddd31014772520aa448f65ef991055d7f61582c65165f" +dependencies = [ + "dyn-clone", + "ref-cast", + "serde", + "serde_json", +] + +[[package]] +name = "schemars" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "687274d293b6cdc6e73e0fee520bf2049650090d7164f87672d212a3c530cf4a" +dependencies = [ + "dyn-clone", + "ref-cast", + "serde", + "serde_json", +] + +[[package]] +name = "schemars_derive" +version = "0.8.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32e265784ad618884abaea0600a9adf15393368d840e0222d101a072f3f7534d" +dependencies = [ + "proc-macro2", + "quote", + "serde_derive_internals", + "syn 2.0.119", +] + +[[package]] +name = "scopeguard" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" + +[[package]] +name = "sea-bae" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "260bbc7148a8d6818ac5032a1b9970da1a68bdd723d45b12d59f7c1bf3565e24" +dependencies = [ + "heck 0.4.1", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "sea-orm" +version = "1.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2dc312fedd460a47ea563911761d254a84e7b51d8cc73ec92c929e78f33fa957" +dependencies = [ + "async-stream", + "async-trait", + "bigdecimal", + "chrono", + "derive_more", + "futures-util", + "log", + "mac_address", + "ouroboros", + "pgvector", + "rust_decimal", + "sea-orm-macros", + "sea-query", + "sea-query-binder", + "serde", + "serde_json", + "sqlx", + "strum 0.26.3", + "thiserror 2.0.20", + "time", + "tracing", + "url", + "uuid", +] + +[[package]] +name = "sea-orm-cli" +version = "1.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da80ebcdb44571e86f03a2bdcb5532136a87397f366f38bbce64673fc5e6a450" +dependencies = [ + "chrono", + "clap", + "dotenvy", + "glob", + "regex", + "tracing", + "tracing-subscriber", + "url", +] + +[[package]] +name = "sea-orm-macros" +version = "1.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b9a3f90e336ec74803e8eb98c61bc98754c1adfba3b4f84d946237b752b1c88" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "sea-bae", + "syn 2.0.119", + "unicode-ident", +] + +[[package]] +name = "sea-orm-migration" +version = "1.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07c577f2959277e936c1d08109acd1e08fc36a95ef29ec028190ba82cad8f96e" +dependencies = [ + "async-trait", + "clap", + "dotenvy", + "sea-orm", + "sea-orm-cli", + "sea-schema", + "tracing", + "tracing-subscriber", +] + +[[package]] +name = "sea-query" +version = "0.32.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a5d1c518eaf5eda38e5773f902b26ab6d5e9e9e2bb2349ca6c64cf96f80448c" +dependencies = [ + "bigdecimal", + "chrono", + "inherent", + "ordered-float 4.6.0", + "rust_decimal", + "sea-query-derive", + "serde_json", + "time", + "uuid", +] + +[[package]] +name = "sea-query-binder" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b0019f47430f7995af63deda77e238c17323359af241233ec768aba1faea7608" +dependencies = [ + "bigdecimal", + "chrono", + "rust_decimal", + "sea-query", + "serde_json", + "sqlx", + "time", + "uuid", +] + +[[package]] +name = "sea-query-derive" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bae0cbad6ab996955664982739354128c58d16e126114fe88c2a493642502aab" +dependencies = [ + "darling 0.20.11", + "heck 0.4.1", + "proc-macro2", + "quote", + "syn 2.0.119", + "thiserror 2.0.20", +] + +[[package]] +name = "sea-schema" +version = "0.16.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2239ff574c04858ca77485f112afea1a15e53135d3097d0c86509cef1def1338" +dependencies = [ + "futures", + "sea-query", + "sea-schema-derive", +] + +[[package]] +name = "sea-schema-derive" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "debdc8729c37fdbf88472f97fd470393089f997a909e535ff67c544d18cfccf0" +dependencies = [ + "heck 0.4.1", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "seahash" +version = "4.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c107b6f4780854c8b126e228ea8869f4d7b71260f962fefb57b996b8959ba6b" + +[[package]] +name = "sec1" +version = "0.7.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3e97a565f76233a6003f9f5c54be1d9c5bdfa3eccfb189469f11ec4901c47dc" +dependencies = [ + "base16ct", + "der", + "generic-array", + "pkcs8", + "subtle", + "zeroize", +] + +[[package]] +name = "security-framework" +version = "3.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7f4bc775c73d9a02cde8bf7b2ec4c9d12743edf609006c7facc23998404cd1d" +dependencies = [ + "bitflags 2.13.2", + "core-foundation 0.10.1", + "core-foundation-sys", + "libc", + "security-framework-sys", +] + +[[package]] +name = "security-framework-sys" +version = "2.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2691df843ecc5d231c0b14ece2acc3efb62c0a398c7e1d875f3983ce020e3" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "selectors" +version = "0.36.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c5d9c0c92a92d33f08817311cf3f2c29a3538a8240e94a6a3c622ce652d7e00c" +dependencies = [ + "bitflags 2.13.2", + "cssparser", + "derive_more", + "log", + "new_debug_unreachable", + "phf", + "phf_codegen", + "precomputed-hash", + "rustc-hash", + "servo_arc", + "smallvec", +] + +[[package]] +name = "semver" +version = "1.0.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a7852d02fc848982e0c167ef163aaff9cd91dc640ba85e263cb1ce46fae51cd" +dependencies = [ + "serde", + "serde_core", +] + +[[package]] +name = "serde" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4148590afebada386688f18773da617792bf2ef03ffc1e4cbd2b1d45b023e0ba" +dependencies = [ + "serde_core", + "serde_derive", +] + +[[package]] +name = "serde-saphyr" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8050abb251097357e24aff63ba2c52a6309ecb7d23a5474023df960a02694d8" +dependencies = [ + "annotate-snippets", + "base64 0.23.1", + "encoding_rs_io", + "granit-parser", + "nohash-hasher", + "num-traits", + "serde_core", + "smallvec", + "zmij", +] + +[[package]] +name = "serde-untagged" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f9faf48a4a2d2693be24c6289dbe26552776eb7737074e6722891fadbe6c5058" +dependencies = [ + "erased-serde", + "serde", + "serde_core", + "typeid", +] + +[[package]] +name = "serde-value" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3a1a3341211875ef120e117ea7fd5228530ae7e7036a779fdc9117be6b3282c" +dependencies = [ + "ordered-float 2.10.1", + "serde", +] + +[[package]] +name = "serde_core" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67dca2c9c51e58a4791a4b1ed58308b39c64224d349a935ab5039aa360942a48" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "serde_derive_internals" +version = "0.29.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "18d26a20a969b9e3fdf2fc2d9f21eda6c40e2de84c9408bb5d3b05d499aae711" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "serde_html_form" +version = "0.2.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2f2d7ff8a2140333718bb329f5c40fc5f0865b84c426183ce14c97d2ab8154f" +dependencies = [ + "form_urlencoded", + "indexmap 2.14.2", + "itoa", + "ryu", + "serde_core", +] + +[[package]] +name = "serde_json" +version = "1.0.151" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c841b55ecdae098c80dcae9cf767f6f8a0c2cdb3416bbef72181df4d0fe73f14" +dependencies = [ + "itoa", + "memchr", + "serde", + "serde_core", + "zmij", +] + +[[package]] +name = "serde_path_to_error" +version = "0.1.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "10a9ff822e371bb5403e391ecd83e182e0e77ba7f6fe0160b795797109d1b457" +dependencies = [ + "itoa", + "serde", + "serde_core", +] + +[[package]] +name = "serde_plain" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ce1fc6db65a611022b23a0dec6975d63fb80a302cb3388835ff02c097258d50" +dependencies = [ + "serde", +] + +[[package]] +name = "serde_repr" +version = "0.1.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8d3b1629de253c70a0508c3899572da79ca359fdab27c7920ff00406df418906" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "serde_spanned" +version = "0.6.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf41e0cfaf7226dca15e8197172c295a782857fcb97fad1808a166870dee75a3" +dependencies = [ + "serde", +] + +[[package]] +name = "serde_spanned" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6662b5879511e06e8999a8a235d848113e942c9124f211511b16466ee2995f26" +dependencies = [ + "serde_core", +] + +[[package]] +name = "serde_urlencoded" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3491c14715ca2294c4d6a88f15e84739788c1d030eed8c110436aafdaa2f3fd" +dependencies = [ + "form_urlencoded", + "itoa", + "ryu", + "serde", +] + +[[package]] +name = "serde_with" +version = "3.23.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "935177bb8c0cd8ca1a4e6d1a2ac8988bea69cab4f9d3a31311e012ad27868ea4" +dependencies = [ + "base64 0.23.1", + "bs58", + "chrono", + "hex", + "indexmap 1.9.3", + "indexmap 2.14.2", + "jiff", + "schemars 0.9.0", + "schemars 1.2.2", + "serde_core", + "serde_json", + "serde_with_macros", + "time", +] + +[[package]] +name = "serde_with_macros" +version = "3.23.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d607aa01a3cb0ad757d6fd216136910db3c97b102fe686585689615a02dbcdc" +dependencies = [ + "darling 0.24.1", + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "serial_test" +version = "4.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6df5ed973ad8d834e09f824f9e9f449af6b9a3745f78dec7cc752770bd3bf11" +dependencies = [ + "futures-executor", + "futures-util", + "log", + "once_cell", + "parking_lot", + "serial_test_derive", +] + +[[package]] +name = "serial_test_derive" +version = "4.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a22144e767da4ddd8416dbf383700542ffd8a5dc493dfecedfe1fe3ad03c98ae" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "serialize-to-javascript" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "04f3666a07a197cdb77cdf306c32be9b7f598d7060d50cfd4d5aa04bfd92f6c5" +dependencies = [ + "serde", + "serde_json", + "serialize-to-javascript-impl", +] + +[[package]] +name = "serialize-to-javascript-impl" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "772ee033c0916d670af7860b6e1ef7d658a4629a6d0b4c8c3e67f09b3765b75d" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "service-manager" +version = "0.8.0" +source = "git+https://github.com/EasyTier/service-manager-rs.git?branch=main#5eb28f7a686858eea4f4933534ed989d3b71dc2a" +dependencies = [ + "cfg-if", + "dirs 4.0.0", + "encoding-utils", + "encoding_rs", + "plist", + "sys-info", + "which", + "xml-rs", +] + +[[package]] +name = "servo_arc" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "170fb83ab34de17dc69aa7c67482b22218ddb85da56546f9bd6b929e32a05930" +dependencies = [ + "stable_deref_trait", +] + +[[package]] +name = "sha1" +version = "0.10.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a978451301f4db1d02937a4ab3ccce137717b81826e79b7d49ffe3244a13c3b8" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "digest 0.10.7", +] + +[[package]] +name = "sha1" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aacc4cc499359472b4abe1bf11d0b12e688af9a805fa5e3016f9a386dc2d0214" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.1", + "digest 0.11.3", +] + +[[package]] +name = "sha2" +version = "0.10.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a7507d819769d01a365ab707794a4084392c824f54a7a6a7862f8c3d0892b283" +dependencies = [ + "cfg-if", + "cpufeatures 0.2.17", + "digest 0.10.7", +] + +[[package]] +name = "sha2" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "446ba717509524cb3f22f17ecc096f10f4822d76ab5c0b9822c5f9c284e825f4" +dependencies = [ + "cfg-if", + "cpufeatures 0.3.1", + "digest 0.11.3", +] + +[[package]] +name = "sharded-slab" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f40ca3c46823713e0d4209592e8d6e826aa57e928f09752619fc696c499637f6" +dependencies = [ + "lazy_static", +] + +[[package]] +name = "shared_child" +version = "1.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "607549934f6cc26b89cfecfdc46fa90f1e5d1536a68349b0c3a4f9d1c0d37959" +dependencies = [ + "libc", + "sigchld", + "windows-sys 0.61.2", +] + +[[package]] +name = "shellexpand" +version = "3.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32824fab5e16e6c4d86dc1ba84489390419a39f97699852b66480bb87d297ed8" +dependencies = [ + "dirs 6.0.0", +] + +[[package]] +name = "shlex" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" + +[[package]] +name = "shlex" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba" + +[[package]] +name = "sigchld" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24f2b37f04360cd465089b87a9c3869c08220a2f3458463f0adf8badf5e77f2c" +dependencies = [ + "libc", + "os_pipe", + "signal-hook", +] + +[[package]] +name = "signal-hook" +version = "0.4.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2a0c28ca5908dbdbcd52e6fdaa00358ab88637f8ab33e1f188dd510eb44b53d" +dependencies = [ + "libc", + "signal-hook-registry", +] + +[[package]] +name = "signal-hook-registry" +version = "1.4.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4db69cba1110affc0e9f7bcd48bbf87b3f4fc7c61fc9155afd4c469eb3d6c1b" +dependencies = [ + "errno", + "libc", +] + +[[package]] +name = "signature" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77549399552de45a898a580c1b41d445bf730df867cc44e6c0233bbc4b8329de" +dependencies = [ + "digest 0.10.7", + "rand_core 0.6.4", +] + +[[package]] +name = "simba" +version = "0.10.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f1a7200d82ff1c7b4235efd12f11e2537a402c91cf83a5cb97ce80eef787fde7" +dependencies = [ + "approx", + "num-complex", + "num-traits", + "wide", +] + +[[package]] +name = "simd-adler32" +version = "0.3.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3a219298ac11a56ea9a6d2120044824d6f01aeb034955e7af7bc16858527deea" + +[[package]] +name = "simd_cesu8" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "11031e251abf8611c80f460e19dbdeb54a66db918e49c65a7065b46ac7aec520" +dependencies = [ + "rustc_version", + "simdutf8", +] + +[[package]] +name = "simdutf8" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3a9fe34e3e7a50316060351f37187a3f546bce95496156754b601a5fa71b76e" + +[[package]] +name = "simple_asn1" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0d585997b0ac10be3c5ee635f1bab02d512760d14b7c468801ac8a01d9ae5f1d" +dependencies = [ + "num-bigint", + "num-traits", + "thiserror 2.0.20", + "time", +] + +[[package]] +name = "siphasher" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ee5873ec9cce0195efcb7a4e9507a04cd49aec9c83d0389df45b1ef7ba2e649" + +[[package]] +name = "slab" +version = "0.4.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c790de23124f9ab44544d7ac05d60440adc586479ce501c1d6d7da3cd8c9cf5" + +[[package]] +name = "smallvec" +version = "1.16.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba467056f1b547ed52077911161fc86985becbc60e8e1857c8a144dab0def891" +dependencies = [ + "serde", +] + +[[package]] +name = "smoltcp" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6f8b28ad56c6e35524a37dd492af5d1a47e31e1a4d175cd12f89c075f01980f" +dependencies = [ + "bitflags 1.3.2", + "byteorder", + "cfg-if", + "defmt", + "heapless", + "managed", +] + +[[package]] +name = "snow" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "599b506ccc4aff8cf7844bc42cf783009a434c1e26c964432560fb6d6ad02d82" +dependencies = [ + "chacha20poly1305 0.10.1", + "curve25519-dalek 4.1.3", + "getrandom 0.3.4", + "rustc_version", + "sha2 0.10.9", + "subtle", +] + +[[package]] +name = "socket2" +version = "0.6.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3d1e2c7f27f8d4cb10542a02c49005dbd6e93095799d6f3be745fae9f8fedd4" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "softbuffer" +version = "0.4.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aac18da81ebbf05109ab275b157c22a653bb3c12cf884450179942f81bcbf6c3" +dependencies = [ + "bytemuck", + "js-sys", + "ndk", + "objc2", + "objc2-core-foundation", + "objc2-core-graphics", + "objc2-foundation", + "objc2-quartz-core", + "raw-window-handle", + "redox_syscall 0.5.18", + "tracing", + "wasm-bindgen", + "web-sys", + "windows-sys 0.61.2", +] + +[[package]] +name = "soup3" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "471f924a40f31251afc77450e781cb26d55c0b650842efafc9c6cbd2f7cc4f9f" +dependencies = [ + "futures-channel", + "gio", + "glib", + "libc", + "soup3-sys", +] + +[[package]] +name = "soup3-sys" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7ebe8950a680a12f24f15ebe1bf70db7af98ad242d9db43596ad3108aab86c27" +dependencies = [ + "gio-sys", + "glib-sys", + "gobject-sys", + "libc", + "system-deps", +] + +[[package]] +name = "spin" +version = "0.9.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3763264f6b73151db08c50ff20d7d8a0b8796e021cdea7ceedad07b80155fa0e" +dependencies = [ + "lock_api", +] + +[[package]] +name = "spki" +version = "0.7.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d91ed6c858b01f942cd56b37a94b3e0a1798290327d1236e4d9cf4eaca44d29d" +dependencies = [ + "base64ct", + "der", +] + +[[package]] +name = "sqlx" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fefb893899429669dcdd979aff487bd78f4064e5e7907e4269081e0ef7d97dc" +dependencies = [ + "sqlx-core", + "sqlx-macros", + "sqlx-mysql", + "sqlx-postgres", + "sqlx-sqlite", +] + +[[package]] +name = "sqlx-core" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ee6798b1838b6a0f69c007c133b8df5866302197e404e8b6ee8ed3e3a5e68dc6" +dependencies = [ + "base64 0.22.1", + "bigdecimal", + "bytes", + "chrono", + "crc", + "crossbeam-queue", + "either", + "event-listener", + "futures-core", + "futures-intrusive", + "futures-io", + "futures-util", + "hashbrown 0.15.5", + "hashlink 0.10.0", + "indexmap 2.14.2", + "log", + "memchr", + "once_cell", + "percent-encoding", + "rust_decimal", + "rustls", + "serde", + "serde_json", + "sha2 0.10.9", + "smallvec", + "thiserror 2.0.20", + "time", + "tokio", + "tokio-stream", + "tracing", + "url", + "uuid", + "webpki-roots 0.26.11", +] + +[[package]] +name = "sqlx-macros" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a2d452988ccaacfbf5e0bdbc348fb91d7c8af5bee192173ac3636b5fb6e6715d" +dependencies = [ + "proc-macro2", + "quote", + "sqlx-core", + "sqlx-macros-core", + "syn 2.0.119", +] + +[[package]] +name = "sqlx-macros-core" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "19a9c1841124ac5a61741f96e1d9e2ec77424bf323962dd894bdb93f37d5219b" +dependencies = [ + "dotenvy", + "either", + "heck 0.5.0", + "hex", + "once_cell", + "proc-macro2", + "quote", + "serde", + "serde_json", + "sha2 0.10.9", + "sqlx-core", + "sqlx-mysql", + "sqlx-postgres", + "sqlx-sqlite", + "syn 2.0.119", + "tokio", + "url", +] + +[[package]] +name = "sqlx-mysql" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aa003f0038df784eb8fecbbac13affe3da23b45194bd57dba231c8f48199c526" +dependencies = [ + "atoi", + "base64 0.22.1", + "bigdecimal", + "bitflags 2.13.2", + "byteorder", + "bytes", + "chrono", + "crc", + "digest 0.10.7", + "dotenvy", + "either", + "futures-channel", + "futures-core", + "futures-io", + "futures-util", + "generic-array", + "hex", + "hkdf", + "hmac 0.12.1", + "itoa", + "log", + "md-5", + "memchr", + "once_cell", + "percent-encoding", + "rand 0.8.8", + "rsa", + "rust_decimal", + "serde", + "sha1 0.10.7", + "sha2 0.10.9", + "smallvec", + "sqlx-core", + "stringprep", + "thiserror 2.0.20", + "time", + "tracing", + "uuid", + "whoami", +] + +[[package]] +name = "sqlx-postgres" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db58fcd5a53cf07c184b154801ff91347e4c30d17a3562a635ff028ad5deda46" +dependencies = [ + "atoi", + "base64 0.22.1", + "bigdecimal", + "bitflags 2.13.2", + "byteorder", + "chrono", + "crc", + "dotenvy", + "etcetera", + "futures-channel", + "futures-core", + "futures-util", + "hex", + "hkdf", + "hmac 0.12.1", + "home", + "itoa", + "log", + "md-5", + "memchr", + "num-bigint", + "once_cell", + "rand 0.8.8", + "rust_decimal", + "serde", + "serde_json", + "sha2 0.10.9", + "smallvec", + "sqlx-core", + "stringprep", + "thiserror 2.0.20", + "time", + "tracing", + "uuid", + "whoami", +] + +[[package]] +name = "sqlx-sqlite" +version = "0.8.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2d12fe70b2c1b4401038055f90f151b78208de1f9f89a7dbfd41587a10c3eea" +dependencies = [ + "atoi", + "chrono", + "flume 0.11.1", + "futures-channel", + "futures-core", + "futures-executor", + "futures-intrusive", + "futures-util", + "libsqlite3-sys", + "log", + "percent-encoding", + "serde", + "serde_urlencoded", + "sqlx-core", + "thiserror 2.0.20", + "time", + "tracing", + "url", + "uuid", +] + +[[package]] +name = "stable_deref_trait" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596" + +[[package]] +name = "static_assertions" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f" + +[[package]] +name = "string_cache" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a18596f8c785a729f2819c0f6a7eae6ebeebdfffbfe4214ae6b087f690e31901" +dependencies = [ + "new_debug_unreachable", + "parking_lot", + "phf_shared", + "precomputed-hash", +] + +[[package]] +name = "string_cache_codegen" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "585635e46db231059f76c5849798146164652513eb9e8ab2685939dd90f29b69" +dependencies = [ + "phf_generator", + "phf_shared", + "proc-macro2", + "quote", +] + +[[package]] +name = "stringprep" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b4df3d392d81bd458a8a621b8bffbd2302a12ffe288a9d931670948749463b1" +dependencies = [ + "unicode-bidi", + "unicode-normalization", + "unicode-properties", +] + +[[package]] +name = "strsim" +version = "0.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f" + +[[package]] +name = "strum" +version = "0.26.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8fec0f0aef304996cf250b31b5a10dee7980c85da9d759361292b8bca5a18f06" + +[[package]] +name = "strum" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9628de9b8791db39ceda2b119bbe13134770b56c138ec1d3af810d045c04f9bd" +dependencies = [ + "strum_macros", +] + +[[package]] +name = "strum_macros" +version = "0.28.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ab85eea0270ee17587ed4156089e10b9e6880ee688791d45a905f5b1ca36f664" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "stun_codec" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2663da41e3e056af18e2ec9ca537d53a4667798fdf92684f9848bd248263223a" +dependencies = [ + "bytecodec", + "byteorder", + "crc", + "hmac 0.12.1", + "md5", + "sha1 0.10.7", + "trackable", +] + +[[package]] +name = "subtle" +version = "2.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292" + +[[package]] +name = "swift-rs" +version = "1.0.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e45c444e496845d3f2a351146bff59aae4975b2280238df1dfaa0c7d1846f38e" +dependencies = [ + "base64 0.21.7", + "serde", + "serde_json", +] + +[[package]] +name = "syn" +version = "1.0.109" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syn" +version = "2.0.119" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "syn" +version = "3.0.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8593e8e72159ed2257d083c7a454a85cbf854f37a0966d8d483aff8c8a3ebcee" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "sync_wrapper" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0bf256ce5efdfa370213c1dabab5935a12e49f2c58d15e9eac2870d3b4f27263" +dependencies = [ + "futures-core", +] + +[[package]] +name = "synstructure" +version = "0.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "728a70f3dbaf5bab7f0c4b1ac8d7ae5ea60a4b5549c8a5914361c99147a709d2" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "synstructure" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "901704edd0dfe137f1987838ee4f259e4e063c31371bdb423f7ae38ec6f77f02" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "sys-info" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b3a0d0aba8bf96a0e1ddfdc352fc53b3df7f39318c71854910c3c4b024ae52c" +dependencies = [ + "cc", + "libc", +] + +[[package]] +name = "sys-locale" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8eab9a99a024a169fe8a903cf9d4a3b3601109bcc13bd9e3c6fff259138626c4" +dependencies = [ + "libc", +] + +[[package]] +name = "system-configuration" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c879d448e9d986b661742763247d3693ed13609438cf3d006f51f5368a5ba6b" +dependencies = [ + "bitflags 2.13.2", + "core-foundation 0.9.4", + "system-configuration-sys", +] + +[[package]] +name = "system-configuration" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a13f3d0daba03132c0aa9767f98351b3488edc2c100cda2d2ec2b04f3d8d3c8b" +dependencies = [ + "bitflags 2.13.2", + "core-foundation 0.9.4", + "system-configuration-sys", +] + +[[package]] +name = "system-configuration-sys" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e1d1b10ced5ca923a1fcb8d03e96b8d3268065d724548c0211415ff6ac6bac4" +dependencies = [ + "core-foundation-sys", + "libc", +] + +[[package]] +name = "system-deps" +version = "6.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3e535eb8dded36d55ec13eddacd30dec501792ff23a0b1682c38601b8cf2349" +dependencies = [ + "cfg-expr", + "heck 0.5.0", + "pkg-config", + "toml 0.8.23", + "version-compare", +] + +[[package]] +name = "tabled" +version = "0.22.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2d2596a104db1900b943f97d793a6c99addca918c4525c999f751a0f17d472eb" +dependencies = [ + "papergrid", + "tabled_derive", + "testing_table", +] + +[[package]] +name = "tabled_derive" +version = "0.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7dca1937322a1e892b1a65f6a6736183bb0a29d3b4234d1d53bc436dff9beb76" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "tagptr" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b2093cf4c8eb1e67749a6762251bc9cd836b6fc171623bd0a9d324d37af2417" + +[[package]] +name = "tao" +version = "0.35.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1c93047acf68669466a34690ac58cca7010bd1b201e1ec86f1fd0a75d3dd4a9" +dependencies = [ + "bitflags 2.13.2", + "block2", + "core-foundation 0.10.1", + "core-graphics", + "crossbeam-channel", + "dbus", + "dispatch2", + "dlopen2 0.8.2", + "dpi", + "gdkwayland-sys", + "gdkx11-sys", + "gtk", + "jni 0.21.1", + "libc", + "log", + "ndk", + "ndk-sys", + "objc2", + "objc2-app-kit", + "objc2-foundation", + "objc2-ui-kit", + "once_cell", + "parking_lot", + "percent-encoding", + "raw-window-handle", + "tao-macros", + "unicode-segmentation", + "url", + "windows 0.61.3", + "windows-core 0.61.2", + "windows-version", + "x11-dl", +] + +[[package]] +name = "tao-macros" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5f7eeb6d99155545da6150a1795945f16ac9c178deb2a5f2e74d776107bd5849" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "target-lexicon" +version = "0.12.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "61c41af27dd6d1e27b1b16b489db798443478cef1f06a660c96db617ba5de3b1" + +[[package]] +name = "tauri" +version = "2.11.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "667b20e2726d572dea2de7370da16e188eb06008faf9a92fab7cdc46791190b5" +dependencies = [ + "anyhow", + "bytes", + "cookie", + "dirs 6.0.0", + "dunce", + "embed_plist", + "getrandom 0.3.4", + "glob", + "gtk", + "heck 0.5.0", + "http", + "image", + "jni 0.21.1", + "libc", + "log", + "mime", + "muda", + "objc2", + "objc2-app-kit", + "objc2-foundation", + "objc2-ui-kit", + "objc2-web-kit", + "percent-encoding", + "plist", + "raw-window-handle", + "reqwest", + "serde", + "serde_json", + "serde_repr", + "serialize-to-javascript", + "swift-rs", + "tauri-build", + "tauri-macros", + "tauri-runtime", + "tauri-runtime-wry", + "tauri-utils", + "thiserror 2.0.20", + "tokio", + "tray-icon", + "url", + "webkit2gtk", + "webview2-com", + "window-vibrancy", + "windows 0.61.3", +] + +[[package]] +name = "tauri-build" +version = "2.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bc9ce40b16101cb6ea63d3e221567affd1c3a9205f95d7bc574941a10636b632" +dependencies = [ + "anyhow", + "cargo_toml", + "dirs 6.0.0", + "glob", + "heck 0.5.0", + "json-patch", + "schemars 0.8.22", + "semver", + "serde", + "serde_json", + "tauri-utils", + "tauri-winres", + "walkdir", +] + +[[package]] +name = "tauri-codegen" +version = "2.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08279169ff42f8fc45a1dbc9dcae888893ba95288142e5880c59b93a26d2cfc5" +dependencies = [ + "base64 0.22.1", + "brotli", + "ico", + "json-patch", + "plist", + "png 0.17.16", + "proc-macro2", + "quote", + "semver", + "serde", + "serde_json", + "sha2 0.10.9", + "syn 2.0.119", + "tauri-utils", + "thiserror 2.0.20", + "time", + "url", + "uuid", + "walkdir", +] + +[[package]] +name = "tauri-macros" +version = "2.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e8b394794f399a421811d06966343e7933fcae92d59f5180b9388d1174497a45" +dependencies = [ + "heck 0.5.0", + "proc-macro2", + "quote", + "syn 2.0.119", + "tauri-codegen", + "tauri-utils", +] + +[[package]] +name = "tauri-plugin" +version = "2.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "74be5dd4bed9afbd145e5716b5fa2ec28cbc29c34ffa61c258c9273d896c8020" +dependencies = [ + "anyhow", + "glob", + "plist", + "schemars 0.8.22", + "serde", + "serde_json", + "tauri-utils", + "walkdir", +] + +[[package]] +name = "tauri-plugin-clipboard-manager" +version = "2.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4136fb69d967753d000423d7e5f863f89bf949efbdfbecb43a580426a01a0194" +dependencies = [ + "arboard", + "log", + "serde", + "serde_json", + "tauri", + "tauri-plugin", + "thiserror 2.0.20", +] + +[[package]] +name = "tauri-plugin-os" +version = "2.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8f08346c8deb39e96f86973da0e2d76cbb933d7ac9b750f6dc4daf955a6f997" +dependencies = [ + "gethostname", + "log", + "os_info", + "serde", + "serde_json", + "serialize-to-javascript", + "sys-locale", + "tauri", + "tauri-plugin", + "thiserror 2.0.20", +] + +[[package]] +name = "tauri-plugin-process" +version = "2.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d55511a7bf6cd70c8767b02c97bf8134fa434daf3926cfc1be0a0f94132d165a" +dependencies = [ + "tauri", + "tauri-plugin", +] + +[[package]] +name = "tauri-plugin-shell" +version = "2.3.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8548af174c5516e4f71f142acea4d02e00316296ea9aafa58798851481003e3c" +dependencies = [ + "encoding_rs", + "log", + "open", + "os_pipe", + "regex", + "schemars 0.8.22", + "serde", + "serde_json", + "shared_child", + "tauri", + "tauri-plugin", + "thiserror 2.0.20", + "tokio", +] + +[[package]] +name = "tauri-plugin-single-instance" +version = "2.4.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5cd0cb5c412a5071b69bab6a6df1583cbb89460d4a83b6a24769b08d15b6b1e1" +dependencies = [ + "serde", + "serde_json", + "tauri", + "thiserror 2.0.20", + "tokio", + "tracing", + "windows-sys 0.60.2", + "zbus", +] + +[[package]] +name = "tauri-plugin-vpnservice" +version = "0.0.0" +dependencies = [ + "serde", + "tauri", + "tauri-plugin", + "thiserror 2.0.20", +] + +[[package]] +name = "tauri-runtime" +version = "2.11.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b0b4bc95aed361b0019067d189a1174a603d460d0f6c72606512d59fc9c12ec8" +dependencies = [ + "cookie", + "dpi", + "gtk", + "http", + "jni 0.21.1", + "objc2", + "objc2-ui-kit", + "objc2-web-kit", + "raw-window-handle", + "serde", + "serde_json", + "tauri-utils", + "thiserror 2.0.20", + "url", + "webkit2gtk", + "webview2-com", + "windows 0.61.3", +] + +[[package]] +name = "tauri-runtime-wry" +version = "2.11.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e6fac707727b7a2f48e4ded90976324267371073edbb415ffb73bb0458d203f" +dependencies = [ + "gtk", + "http", + "jni 0.21.1", + "log", + "objc2", + "objc2-app-kit", + "once_cell", + "percent-encoding", + "raw-window-handle", + "softbuffer", + "tao", + "tauri-runtime", + "tauri-utils", + "url", + "webkit2gtk", + "webview2-com", + "windows 0.61.3", + "wry", +] + +[[package]] +name = "tauri-utils" +version = "2.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3e176a18e67764923c4f1ce66f25ae4abe5f688384d5eb1a0fa6c77f3d90f887" +dependencies = [ + "anyhow", + "brotli", + "cargo_metadata", + "ctor 0.8.0", + "dom_query", + "dunce", + "glob", + "http", + "infer", + "json-patch", + "log", + "memchr", + "phf", + "plist", + "proc-macro2", + "quote", + "regex", + "schemars 0.8.22", + "semver", + "serde", + "serde-untagged", + "serde_json", + "serde_with", + "swift-rs", + "thiserror 2.0.20", + "toml 1.1.6+spec-1.1.0", + "url", + "urlpattern", + "uuid", + "walkdir", +] + +[[package]] +name = "tauri-winres" +version = "0.3.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc65d45c68858bfe420dd29e834b5d15dbecf8a07a8a16cf4d532c7b1f69d4b6" +dependencies = [ + "dunce", + "embed-resource", + "toml 1.1.6+spec-1.1.0", +] + +[[package]] +name = "tempfile" +version = "3.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd" +dependencies = [ + "fastrand", + "getrandom 0.4.3", + "once_cell", + "rustix 1.1.5", + "windows-sys 0.61.2", +] + +[[package]] +name = "tendril" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5fed54709c5b3a53d09bb1c113ea4f5ceafd1e772ddcb0030a82e1d56c087b08" +dependencies = [ + "new_debug_unreachable", +] + +[[package]] +name = "terminal_size" +version = "0.4.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "230a1b821ccbd75b185820a1f1ff7b14d21da1e442e22c0863ea5f08771a8874" +dependencies = [ + "rustix 1.1.5", + "windows-sys 0.61.2", +] + +[[package]] +name = "testing_table" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0f8daae29995a24f65619e19d8d31dea5b389f3d853d8bf297bbf607cd0014cc" +dependencies = [ + "unicode-width", +] + +[[package]] +name = "thiserror" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52" +dependencies = [ + "thiserror-impl 1.0.69", +] + +[[package]] +name = "thiserror" +version = "2.0.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ec86235f5fcc2a73650310756d2ac5b138a5780bbbdfae3eeccec992c435ba4f" +dependencies = [ + "thiserror-impl 2.0.20", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "thiserror-impl" +version = "2.0.20" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bc04cd3e1236dd4a98afca4569f2deb3f120e5422a4023be2cb683f8486292af" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "thread_local" +version = "1.1.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ad99c4c6d32803332c548b1af0540b357b3f5fc0be8f6c6bfe8b2e6ae784070" +dependencies = [ + "cfg-if", +] + +[[package]] +name = "thunk-rs" +version = "0.3.5" +source = "git+https://github.com/EasyTier/thunk.git#cbbeec75a66b7b3cf0824ae890d9d06bcfb9d1f3" + +[[package]] +name = "tiff" +version = "0.11.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b63feaf3343d35b6ca4d50483f94843803b0f51634937cc2ec519fc32232bc52" +dependencies = [ + "fax", + "flate2", + "half", + "quick-error", + "weezl", + "zune-jpeg", +] + +[[package]] +name = "tikv-jemalloc-ctl" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3a184c43b8ab2f41df2733b55556e3f5f632f4aeaa205b1bb018f574b7f5f142" +dependencies = [ + "libc", + "paste", + "tikv-jemalloc-sys", +] + +[[package]] +name = "tikv-jemalloc-sys" +version = "0.7.1+5.3.1-0-g81034ce1f1373e37dc865038e1bc8eeecf559ce8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1a2825c78386b4ae0314074867860ba9577875de945f05992c38815cbec327f0" +dependencies = [ + "cc", + "libc", +] + +[[package]] +name = "tikv-jemallocator" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "249f09e49ab1609436f34c776e84231bead18d6a955f119f939bdc1d847561bd" +dependencies = [ + "libc", + "tikv-jemalloc-sys", +] + +[[package]] +name = "time" +version = "0.3.55" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cdb87b95ec50ddfa440816d227a17b2ccbdda963a316a727fda0fc4334f7d134" +dependencies = [ + "deranged", + "js-sys", + "num-conv", + "powerfmt", + "serde_core", + "time-core", + "time-macros", +] + +[[package]] +name = "time-core" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9e1c906769ad99c88eaa54e728060edef082f8e358ff32030cb7c7d315e81109" + +[[package]] +name = "time-macros" +version = "0.2.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7e689342a48d2ea927c87ea50cabf8594854bf940e9310208848d680d668ed85" +dependencies = [ + "num-conv", + "time-core", +] + +[[package]] +name = "tinystr" +version = "0.8.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1e27c91459209c2986af3dcf603a5a74a4368754ce37414f59acc971167f643" +dependencies = [ + "displaydoc", + "zerovec", +] + +[[package]] +name = "tinytemplate" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be4d6b5f19ff7664e8c98d03e2139cb510db9b0a60b55f8e8709b689d939b6bc" +dependencies = [ + "serde", + "serde_json", +] + +[[package]] +name = "tinyvec" +version = "1.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd3ca314f692efd6c868f8408f53fe444634a845f96c028b97d35f6a1f79f0ee" + +[[package]] +name = "tokio" +version = "1.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "202caea871b69668250d242070849eb495be178ed697a3e98aebce5bc81a0bed" +dependencies = [ + "bytes", + "libc", + "mio", + "parking_lot", + "pin-project-lite", + "signal-hook-registry", + "socket2", + "tokio-macros", + "tracing", + "windows-sys 0.61.2", +] + +[[package]] +name = "tokio-macros" +version = "2.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78773a2a397f451582ce068015985c33193cf6dea8b74d2a639fe457b2f07b0e" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "tokio-rustls" +version = "0.26.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b0c85f2c3ef0b1cd58b36682f4b17aaa995f0e5db534d85692b4903abce21f67" +dependencies = [ + "rustls", + "tokio", +] + +[[package]] +name = "tokio-socks" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a7e2948f60dbe26b35f2c7fb74ac2854c1fddded0fe9d7548fcc674a246f7615" +dependencies = [ + "either", + "futures-util", + "thiserror 1.0.69", + "tokio", +] + +[[package]] +name = "tokio-stream" +version = "0.1.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3d06f0b082ba57c26b79407372e57cf2a1e28124f78e9479fe80322cf53420b" +dependencies = [ + "futures-core", + "pin-project-lite", + "tokio", +] + +[[package]] +name = "tokio-util" +version = "0.7.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "494815d09bf52b5548659851081238f0ca39ff638363907596da739561c62c52" +dependencies = [ + "bytes", + "futures-core", + "futures-io", + "futures-sink", + "futures-util", + "hashbrown 0.15.5", + "libc", + "pin-project-lite", + "slab", + "tokio", +] + +[[package]] +name = "tokio-websockets" +version = "0.13.2" +source = "git+https://github.com/EasyTier/tokio-websockets#dc9771c7c215882349c3cb328877550a3593df21" +dependencies = [ + "base64 0.22.1", + "bytes", + "fastrand", + "futures-core", + "futures-sink", + "http", + "httparse", + "ring", + "rustls-pki-types", + "simdutf8", + "tokio", + "tokio-rustls", + "tokio-util", + "webpki-roots 1.0.9", +] + +[[package]] +name = "toml" +version = "0.8.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc1beb996b9d83529a9e75c17a1686767d148d70663143c7854d8b4a09ced362" +dependencies = [ + "serde", + "serde_spanned 0.6.9", + "toml_datetime 0.6.11", + "toml_edit 0.22.27", +] + +[[package]] +name = "toml" +version = "0.9.12+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf92845e79fc2e2def6a5d828f0801e29a2f8acc037becc5ab08595c7d5e9863" +dependencies = [ + "indexmap 2.14.2", + "serde_core", + "serde_spanned 1.1.1", + "toml_datetime 0.7.5+spec-1.1.0", + "toml_parser", + "toml_writer", + "winnow 0.7.15", +] + +[[package]] +name = "toml" +version = "1.1.6+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "920602543f0911ab71da12c50d59701da54c196d1a2bf5cb4b75667f137a406a" +dependencies = [ + "indexmap 2.14.2", + "serde_core", + "serde_spanned 1.1.1", + "toml_datetime 1.1.1+spec-1.1.0", + "toml_parser", + "toml_writer", + "winnow 1.0.4", +] + +[[package]] +name = "toml_datetime" +version = "0.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "22cddaf88f4fbc13c51aebbf5f8eceb5c7c5a9da2ac40a13519eb5b0a0e8f11c" +dependencies = [ + "serde", +] + +[[package]] +name = "toml_datetime" +version = "0.7.5+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92e1cfed4a3038bc5a127e35a2d360f145e1f4b971b551a2ba5fd7aedf7e1347" +dependencies = [ + "serde_core", +] + +[[package]] +name = "toml_datetime" +version = "1.1.1+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3165f65f62e28e0115a00b2ebdd37eb6f3b641855f9d636d3cd4103767159ad7" +dependencies = [ + "serde_core", +] + +[[package]] +name = "toml_edit" +version = "0.19.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b5bb770da30e5cbfde35a2d7b9b8a2c4b8ef89548a7a6aeab5c9a576e3e7421" +dependencies = [ + "indexmap 2.14.2", + "toml_datetime 0.6.11", + "winnow 0.5.40", +] + +[[package]] +name = "toml_edit" +version = "0.20.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70f427fce4d84c72b5b732388bf4a9f4531b53f74e2887e3ecb2481f68f66d81" +dependencies = [ + "indexmap 2.14.2", + "toml_datetime 0.6.11", + "winnow 0.5.40", +] + +[[package]] +name = "toml_edit" +version = "0.22.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41fe8c660ae4257887cf66394862d21dbca4a6ddd26f04a3560410406a2f819a" +dependencies = [ + "indexmap 2.14.2", + "serde", + "serde_spanned 0.6.9", + "toml_datetime 0.6.11", + "toml_write", + "winnow 0.7.15", +] + +[[package]] +name = "toml_edit" +version = "0.25.15+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1340ea94a5856333492c9064b02c778b191dd2c853778d9609debdcdfea3a614" +dependencies = [ + "indexmap 2.14.2", + "toml_datetime 1.1.1+spec-1.1.0", + "toml_parser", + "winnow 1.0.4", +] + +[[package]] +name = "toml_parser" +version = "1.1.3+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d38ac1cf9b95face32296c0a3ede1fdc270627c9d9c02a7274dd6d960dc4d56" +dependencies = [ + "winnow 1.0.4", +] + +[[package]] +name = "toml_write" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d99f8c9a7727884afe522e9bd5edbfc91a3312b36a77b5fb8926e4c31a41801" + +[[package]] +name = "toml_writer" +version = "1.1.2+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d56353a2a665ad0f41a421187180aab746c8c325620617ad883a99a1cbe66d2" + +[[package]] +name = "tonic" +version = "0.14.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac2a5518c70fa84342385732db33fb3f44bc4cc748936eb5833d2df34d6445ef" +dependencies = [ + "async-trait", + "axum", + "base64 0.22.1", + "bytes", + "h2", + "http", + "http-body", + "http-body-util", + "hyper", + "hyper-timeout", + "hyper-util", + "percent-encoding", + "pin-project", + "socket2", + "sync_wrapper", + "tokio", + "tokio-stream", + "tower", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "tonic-prost" +version = "0.14.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "50849f68853be452acf590cde0b146665b8d507b3b8af17261df47e02c209ea0" +dependencies = [ + "bytes", + "prost 0.14.4", + "tonic", +] + +[[package]] +name = "tower" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebe5ef63511595f1344e2d5cfa636d973292adc0eec1f0ad45fae9f0851ab1d4" +dependencies = [ + "futures-core", + "futures-util", + "indexmap 2.14.2", + "pin-project-lite", + "slab", + "sync_wrapper", + "tokio", + "tokio-util", + "tower-layer", + "tower-service", + "tracing", +] + +[[package]] +name = "tower-cookies" +version = "0.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "151b5a3e3c45df17466454bb74e9ecedecc955269bdedbf4d150dfa393b55a36" +dependencies = [ + "axum-core 0.5.6", + "cookie", + "futures-util", + "http", + "parking_lot", + "pin-project-lite", + "tower-layer", + "tower-service", +] + +[[package]] +name = "tower-http" +version = "0.6.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4cfcf7e2740e6fc6d4d688b4ef00650406bb94adf4731e43c096c3a19fe40840" +dependencies = [ + "bitflags 2.13.2", + "bytes", + "futures-util", + "http", + "http-body", + "pin-project-lite", + "tower", + "tower-layer", + "tower-service", + "url", +] + +[[package]] +name = "tower-http" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08a05a66a4fdd61cbbe0a1d755ffe0ca6aba159dd4820936a0ff8a8278245b9c" +dependencies = [ + "async-compression", + "bitflags 2.13.2", + "bytes", + "futures-core", + "http", + "http-body", + "percent-encoding", + "pin-project-lite", + "tokio", + "tokio-util", + "tower-layer", + "tower-service", +] + +[[package]] +name = "tower-layer" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e" + +[[package]] +name = "tower-service" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" + +[[package]] +name = "tower-sessions" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "43a05911f23e8fae446005fe9b7b97e66d95b6db589dc1c4d59f6a2d4d4927d3" +dependencies = [ + "async-trait", + "http", + "time", + "tokio", + "tower-cookies", + "tower-layer", + "tower-service", + "tower-sessions-core", + "tracing", +] + +[[package]] +name = "tower-sessions-core" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ce8cce604865576b7751b7a6bc3058f754569a60d689328bb74c52b1d87e355b" +dependencies = [ + "async-trait", + "axum-core 0.5.6", + "base64 0.22.1", + "futures", + "http", + "parking_lot", + "rand 0.8.8", + "serde", + "serde_json", + "thiserror 2.0.20", + "time", + "tokio", + "tracing", +] + +[[package]] +name = "tower-sessions-sqlx-store" +version = "0.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e054622079f57fc1a7d6a6089c9334f963d62028fe21dc9eddd58af9a78480b3" +dependencies = [ + "async-trait", + "rmp-serde", + "sqlx", + "thiserror 1.0.69", + "time", + "tower-sessions-core", +] + +[[package]] +name = "tracing" +version = "0.1.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63e71662fa4b2a2c3a26f570f037eb95bb1f85397f3cd8076caed2f026a6d100" +dependencies = [ + "log", + "pin-project-lite", + "tracing-attributes", + "tracing-core", +] + +[[package]] +name = "tracing-attributes" +version = "0.1.31" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7490cfa5ec963746568740651ac6781f701c9c5ea257c58e057f3ba8cf69e8da" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "tracing-core" +version = "0.1.36" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db97caf9d906fbde555dd62fa95ddba9eecfd14cb388e4f491a66d74cd5fb79a" +dependencies = [ + "once_cell", + "valuable", +] + +[[package]] +name = "tracing-log" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ee855f1f400bd0e5c02d150ae5de3840039a3f54b025156404e34c23c03f47c3" +dependencies = [ + "log", + "once_cell", + "tracing-core", +] + +[[package]] +name = "tracing-subscriber" +version = "0.3.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb7f578e5945fb242538965c2d0b04418d38ec25c79d160cd279bf0731c8d319" +dependencies = [ + "matchers", + "nu-ansi-term", + "once_cell", + "regex-automata", + "sharded-slab", + "smallvec", + "thread_local", + "tracing", + "tracing-core", + "tracing-log", +] + +[[package]] +name = "trackable" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b15bd114abb99ef8cee977e517c8f37aee63f184f2d08e3e6ceca092373369ae" +dependencies = [ + "trackable_derive", +] + +[[package]] +name = "trackable_derive" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebeb235c5847e2f82cfe0f07eb971d1e5f6804b18dac2ae16349cc604380f82f" +dependencies = [ + "quote", + "syn 1.0.109", +] + +[[package]] +name = "tray-icon" +version = "0.24.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "045979e3f037cd18ad1cb2a419dfda133c5c29c9f3453370079f2255d46c257e" +dependencies = [ + "crossbeam-channel", + "dirs 6.0.0", + "libappindicator", + "muda", + "objc2", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-core-graphics", + "objc2-foundation", + "once_cell", + "png 0.18.1", + "serde", + "thiserror 2.0.20", + "windows-sys 0.61.2", +] + +[[package]] +name = "tree_magic_mini" +version = "3.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8765b90061cba6c22b5831f675da109ae5561588290f9fa2317adab2714d5a6" +dependencies = [ + "memchr", + "nom 8.0.0", + "petgraph", +] + +[[package]] +name = "triomphe" +version = "0.1.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b40688ea6389c8171614b25491f71d4a27946e0c7ce2da1c6de27e25abf1a0ae" +dependencies = [ + "arc-swap", + "serde", + "stable_deref_trait", +] + +[[package]] +name = "try-lock" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b" + +[[package]] +name = "ttf-parser" +version = "0.25.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d2df906b07856748fa3f6e0ad0cbaa047052d4a7dd609e231c4f72cee8c36f31" + +[[package]] +name = "tun-easytier" +version = "1.1.1" +source = "git+https://github.com/EasyTier/rust-tun#12378839e7985283df0e4fb536b7137230356db5" +dependencies = [ + "bytes", + "cfg-if", + "futures-core", + "ipnet", + "libc", + "libloading 0.8.9", + "log", + "nix 0.29.0", + "thiserror 1.0.69", + "tokio", + "tokio-util", + "windows-sys 0.59.0", + "wintun", +] + +[[package]] +name = "typed-path" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e28f89b80c87b8fb0cf04ab448d5dd0dd0ade2f8891bae878de66a75a28600e" + +[[package]] +name = "typeid" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bc7d623258602320d5c55d1bc22793b57daff0ec7efc270ea7d55ce1d5f5471c" + +[[package]] +name = "typenum" +version = "1.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20" + +[[package]] +name = "typetag" +version = "0.2.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c90e86058a30d42a1a928dfb4b49bb33c98c3a2b4909492e6b0881cd94798ec2" +dependencies = [ + "erased-serde", + "inventory", + "once_cell", + "serde", + "typetag-impl", +] + +[[package]] +name = "typetag-impl" +version = "0.2.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f153acc4e99a5f2a5aefa09fb078be54e26271b2813f6041200b224c098d8328" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "uds_windows" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2f6fb2847f6742cd76af783a2a2c49e9375d0a111c7bef6f71cd9e738c72d6e" +dependencies = [ + "memoffset", + "tempfile", + "windows-sys 0.61.2", +] + +[[package]] +name = "unic-char-property" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a8c57a407d9b6fa02b4795eb81c5b6652060a15a7903ea981f3d723e6c0be221" +dependencies = [ + "unic-char-range", +] + +[[package]] +name = "unic-char-range" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0398022d5f700414f6b899e10b8348231abf9173fa93144cbc1a43b9793c1fbc" + +[[package]] +name = "unic-common" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "80d7ff825a6a654ee85a63e80f92f054f904f21e7d12da4e22f9834a4aaa35bc" + +[[package]] +name = "unic-ucd-ident" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e230a37c0381caa9219d67cf063aa3a375ffed5bf541a452db16e744bdab6987" +dependencies = [ + "unic-char-property", + "unic-char-range", + "unic-ucd-version", +] + +[[package]] +name = "unic-ucd-version" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "96bd2f2237fe450fcd0a1d2f5f4e91711124f7857ba2e964247776ebeeb7b0c4" +dependencies = [ + "unic-common", +] + +[[package]] +name = "unicase" +version = "2.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dbc4bc3a9f746d862c45cb89d705aa10f187bb96c76001afab07a0d35ce60142" + +[[package]] +name = "unicode-bidi" +version = "0.3.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c1cb5db39152898a79168971543b1cb5020dff7fe43c8dc468b0885f5e29df5" + +[[package]] +name = "unicode-ident" +version = "1.0.26" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d245f478577f809a851594d02313b640fb437e0bb33866753cff937863096954" + +[[package]] +name = "unicode-normalization" +version = "0.1.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5fd4f6878c9cb28d874b009da9e8d183b5abc80117c40bbd187a1fde336be6e8" +dependencies = [ + "tinyvec", +] + +[[package]] +name = "unicode-properties" +version = "0.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7df058c713841ad818f1dc5d3fd88063241cc61f49f5fbea4b951e8cf5a8d71d" + +[[package]] +name = "unicode-segmentation" +version = "1.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c6f5d3c3b1bf09027a88a6bc961fc00497d651009560b5463668dc81b0fa87a8" + +[[package]] +name = "unicode-width" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b4ac048d71ede7ee76d585517add45da530660ef4390e49b098733c6e897f254" + +[[package]] +name = "unicode-xid" +version = "0.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853" + +[[package]] +name = "universal-hash" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc1de2c688dc15305988b563c3854064043356019f97a4b46276fe734c4f07ea" +dependencies = [ + "crypto-common 0.1.7", + "subtle", +] + +[[package]] +name = "universal-hash" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f4987bdc12753382e0bec4a65c50738ffaabc998b9cdd1f952fb5f39b0048a96" +dependencies = [ + "crypto-common 0.2.2", + "ctutils", +] + +[[package]] +name = "untrusted" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1" + +[[package]] +name = "url" +version = "2.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff67a8a4397373c3ef660812acab3268222035010ab8680ec4215f38ba3d0eed" +dependencies = [ + "form_urlencoded", + "idna", + "percent-encoding", + "serde", + "serde_derive", +] + +[[package]] +name = "urlencoding" +version = "2.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "daf8dba3b7eb870caf1ddeed7bc9d2a049f3cfdfae7cb521b087cc33ae4c49da" + +[[package]] +name = "urlpattern" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "70acd30e3aa1450bc2eece896ce2ad0d178e9c079493819301573dae3c37ba6d" +dependencies = [ + "regex", + "serde", + "unic-ucd-ident", + "url", +] + +[[package]] +name = "utf8_iter" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" + +[[package]] +name = "utf8parse" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" + +[[package]] +name = "uuid" +version = "1.26.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2ef6dac1e96601b4fb3acccccff2139741fcb757cb9a36089bf5be91cfb285ce" +dependencies = [ + "getrandom 0.4.3", + "js-sys", + "rand 0.10.2", + "serde_core", + "wasm-bindgen", +] + +[[package]] +name = "validator" +version = "0.21.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3d68c6633c483df6780cc5277a417c7c2d1bceee2649d06c8ab6b0fd2dd3c81" +dependencies = [ + "idna", + "regex", + "serde", + "serde_derive", + "serde_json", + "url", + "validator_derive", +] + +[[package]] +name = "validator_derive" +version = "0.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "240e4b81c20a1d6d50d1d7265c658dfbd204e8b9ac4d80f3c931f39462196335" +dependencies = [ + "darling 0.23.0", + "proc-macro-error3", + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "valuable" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba73ea9cf16a25df0c8caa16c51acb937d5712a8429db78a3ee29d5dcacd3a65" + +[[package]] +name = "vcpkg" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" + +[[package]] +name = "version-compare" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "03c2856837ef78f57382f06b2b8563a2f512f7185d732608fd9176cb3b8edf0e" + +[[package]] +name = "version_check" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" + +[[package]] +name = "vswhom" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be979b7f07507105799e854203b470ff7c78a1639e330a58f183b5fea574608b" +dependencies = [ + "libc", + "vswhom-sys", +] + +[[package]] +name = "vswhom-sys" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fb067e4cbd1ff067d1df46c9194b5de0e98efd2810bbc95c5d5e5f25a3231150" +dependencies = [ + "cc", + "libc", +] + +[[package]] +name = "walkdir" +version = "2.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29790946404f91d9c5d06f9874efddea1dc06c5efe94541a7d6863108e3a5e4b" +dependencies = [ + "same-file", + "winapi-util", +] + +[[package]] +name = "want" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bfa7760aed19e106de2c7c0b581b509f2f25d3dacaf737cb82ac61bc6d760b0e" +dependencies = [ + "try-lock", +] + +[[package]] +name = "wasi" +version = "0.11.1+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b" + +[[package]] +name = "wasip2" +version = "1.0.4+wasi-0.2.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b67efb37e106e55ce722a510d6b5f9c17f083e5fc79afc2badeb12cc313d9487" +dependencies = [ + "wit-bindgen", +] + +[[package]] +name = "wasite" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8dad83b4f25e74f184f64c43b150b91efe7647395b42289f38e50566d82855b" + +[[package]] +name = "wasm-bindgen" +version = "0.2.128" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "aecb87a33d3b0c5e3b7aa46336eaf486cffafbd281b195e4c8b80d50df2351bf" +dependencies = [ + "cfg-if", + "once_cell", + "rustversion", + "serde", + "wasm-bindgen-macro", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-futures" +version = "0.4.78" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ef4c5d3d2cdf5c54f4231181768f5510842e350db025faf1f7163b1030ed928" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "wasm-bindgen-macro" +version = "0.2.128" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a690d511e3c1a8b3a55e33511e3c2c00c78415cd23650f32b808627f5696b9ed" +dependencies = [ + "quote", + "wasm-bindgen-macro-support", +] + +[[package]] +name = "wasm-bindgen-macro-support" +version = "0.2.128" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "411e4887f0071ef2d2164a9d5fdf2d20efbef78fccd3a78b0c10a1dc5295e48a" +dependencies = [ + "bumpalo", + "proc-macro2", + "quote", + "syn 3.0.6", + "wasm-bindgen-shared", +] + +[[package]] +name = "wasm-bindgen-shared" +version = "0.2.128" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "81941cd78d0c92026c33e5e01312845a4cb1e9af3407f9134b100dd03144103e" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "wasm-streams" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d1ec4f6517c9e11ae630e200b2b65d193279042e28edd4a2cda233e46670bbb" +dependencies = [ + "futures-util", + "js-sys", + "wasm-bindgen", + "wasm-bindgen-futures", + "web-sys", +] + +[[package]] +name = "wayland-backend" +version = "0.3.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38a91b4eaddff87b1cd1074985e3713da4af2c49742d1b356b2c01670a67a078" +dependencies = [ + "cc", + "downcast-rs", + "rustix 1.1.5", + "smallvec", + "wayland-sys", +] + +[[package]] +name = "wayland-client" +version = "0.31.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e3c36a0f861ad76d0901f2800b46321410d9f73f2ea88aac0650d86c32688073" +dependencies = [ + "bitflags 2.13.2", + "rustix 1.1.5", + "wayland-backend", + "wayland-scanner", +] + +[[package]] +name = "wayland-protocols" +version = "0.32.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23d0c813de3daa2ed6520af85a3bd49b0e722a3078506899aa9686fea58dc4b6" +dependencies = [ + "bitflags 2.13.2", + "wayland-backend", + "wayland-client", + "wayland-scanner", +] + +[[package]] +name = "wayland-protocols-wlr" +version = "0.3.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eb04e52f7836d7c7976c78ca0250d61e33873c34156a2a1fc9474828ec268234" +dependencies = [ + "bitflags 2.13.2", + "wayland-backend", + "wayland-client", + "wayland-protocols", + "wayland-scanner", +] + +[[package]] +name = "wayland-scanner" +version = "0.31.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "338e30461b3a2b67d70eb30a6d89f8e0c93a833e07d2ae89085cd070c4a00ac0" +dependencies = [ + "proc-macro2", + "quick-xml 0.41.0", + "quote", +] + +[[package]] +name = "wayland-sys" +version = "0.31.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8eab23fefc9e41f8e841df4a9c707e8a8c4ed26e944ef69297184de2785e3be" +dependencies = [ + "pkg-config", +] + +[[package]] +name = "web-sys" +version = "0.3.105" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9fbddc4a036f00ec4f18c83445bd3115cb306a91da554919a099d9222fe4a7f8" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "web-time" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a6580f308b1fad9207618087a65c04e7a10bc77e02c8e84e9b00dd4b12fa0bb" +dependencies = [ + "js-sys", + "wasm-bindgen", +] + +[[package]] +name = "web_atoms" +version = "0.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba8b815c1b593dc0baf78dd0f4fc8fdb2de53198fb1163738093e9a311c33fb3" +dependencies = [ + "phf", + "phf_codegen", + "string_cache", + "string_cache_codegen", +] + +[[package]] +name = "webkit2gtk" +version = "2.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1027150013530fb2eaf806408df88461ae4815a45c541c8975e61d6f2fc4793" +dependencies = [ + "bitflags 1.3.2", + "cairo-rs", + "gdk", + "gdk-sys", + "gio", + "gio-sys", + "glib", + "glib-sys", + "gobject-sys", + "gtk", + "gtk-sys", + "javascriptcore-rs", + "libc", + "once_cell", + "soup3", + "webkit2gtk-sys", +] + +[[package]] +name = "webkit2gtk-sys" +version = "2.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "916a5f65c2ef0dfe12fff695960a2ec3d4565359fdbb2e9943c974e06c734ea5" +dependencies = [ + "bitflags 1.3.2", + "cairo-sys-rs", + "gdk-sys", + "gio-sys", + "glib-sys", + "gobject-sys", + "gtk-sys", + "javascriptcore-rs-sys", + "libc", + "pkg-config", + "soup3-sys", + "system-deps", +] + +[[package]] +name = "webpki-root-certs" +version = "1.0.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b96554aa2acc8ccdb7e1c9a58a7a68dd5d13bccc69cd124cb09406db612a1c9b" +dependencies = [ + "rustls-pki-types", +] + +[[package]] +name = "webpki-roots" +version = "0.26.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "521bc38abb08001b01866da9f51eb7c5d647a19260e00054a8c7fd5f9e57f7a9" +dependencies = [ + "webpki-roots 1.0.9", +] + +[[package]] +name = "webpki-roots" +version = "1.0.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7dcd9d09a39985f5344844e66b0c530a33843579125f23e21e9f0f220850f22a" +dependencies = [ + "rustls-pki-types", +] + +[[package]] +name = "webview2-com" +version = "0.38.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7130243a7a5b33c54a444e54842e6a9e133de08b5ad7b5861cd8ed9a6a5bc96a" +dependencies = [ + "webview2-com-macros", + "webview2-com-sys", + "windows 0.61.3", + "windows-core 0.61.2", + "windows-implement", + "windows-interface", +] + +[[package]] +name = "webview2-com-macros" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67a921c1b6914c367b2b823cd4cde6f96beec77d30a939c8199bb377cf9b9b54" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "webview2-com-sys" +version = "0.38.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "381336cfffd772377d291702245447a5251a2ffa5bad679c99e61bc48bacbf9c" +dependencies = [ + "thiserror 2.0.20", + "windows 0.61.3", + "windows-core 0.61.2", +] + +[[package]] +name = "weezl" +version = "0.1.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a28ac98ddc8b9274cb41bb4d9d4d5c425b6020c50c46f25559911905610b4a88" + +[[package]] +name = "which" +version = "4.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "87ba24419a2078cd2b0f2ede2691b6c66d8e47836da3b6db8265ebad47afbfc7" +dependencies = [ + "either", + "home", + "once_cell", + "rustix 0.38.44", +] + +[[package]] +name = "whoami" +version = "1.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5d4a4db5077702ca3015d3d02d74974948aba2ad9e12ab7df718ee64ccd7e97d" +dependencies = [ + "libredox", + "wasite", +] + +[[package]] +name = "wide" +version = "1.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d920ac99c3c8edce110cb8d07dbb324d6d026011dce85b1e9355b70f0adacc4f" +dependencies = [ + "bytemuck", + "safe_arch", +] + +[[package]] +name = "widestring" +version = "0.4.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c168940144dd21fd8046987c16a46a33d5fc84eec29ef9dcddc2ac9e31526b7c" + +[[package]] +name = "widestring" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72069c3113ab32ab29e5584db3c6ec55d416895e60715417b5b883a357c3e471" + +[[package]] +name = "wildmatch" +version = "2.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29333c3ea1ba8b17211763463ff24ee84e41c78224c16b001cd907e663a38c68" + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-util" +version = "0.1.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2a7b1c03c876122aa43f3020e6c3c3ee5c05081c9a00739faf7503aeba10d22" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" + +[[package]] +name = "windivert" +version = "0.6.0" +source = "git+https://github.com/EasyTier/windivert-rust.git?rev=adcc56d1550f7b5377ec2b3429f413ee24a77375#adcc56d1550f7b5377ec2b3429f413ee24a77375" +dependencies = [ + "etherparse", + "thiserror 1.0.69", + "windivert-sys", + "windows 0.48.0", +] + +[[package]] +name = "windivert-sys" +version = "0.10.0" +source = "git+https://github.com/EasyTier/windivert-rust.git?rev=adcc56d1550f7b5377ec2b3429f413ee24a77375#adcc56d1550f7b5377ec2b3429f413ee24a77375" +dependencies = [ + "cc", + "thiserror 1.0.69", + "windows 0.48.0", +] + +[[package]] +name = "window-vibrancy" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9bec5a31f3f9362f2258fd0e9c9dd61a9ca432e7306cc78c444258f0dce9a9c" +dependencies = [ + "objc2", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-foundation", + "raw-window-handle", + "windows-sys 0.59.0", + "windows-version", +] + +[[package]] +name = "windows" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e686886bc078bc1b0b600cac0147aadb815089b6e4da64016cbd754b6342700f" +dependencies = [ + "windows-targets 0.48.5", +] + +[[package]] +name = "windows" +version = "0.61.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9babd3a767a4c1aef6900409f85f5d53ce2544ccdfaa86dad48c91782c6d6893" +dependencies = [ + "windows-collections 0.2.0", + "windows-core 0.61.2", + "windows-future 0.2.1", + "windows-link 0.1.3", + "windows-numerics 0.2.0", +] + +[[package]] +name = "windows" +version = "0.62.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "527fadee13e0c05939a6a05d5bd6eec6cd2e3dbd648b9f8e447c6518133d8580" +dependencies = [ + "windows-collections 0.3.2", + "windows-core 0.62.2", + "windows-future 0.3.2", + "windows-numerics 0.3.1", +] + +[[package]] +name = "windows-collections" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3beeceb5e5cfd9eb1d76b381630e82c4241ccd0d27f1a39ed41b2760b255c5e8" +dependencies = [ + "windows-core 0.61.2", +] + +[[package]] +name = "windows-collections" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23b2d95af1a8a14a3c7367e1ed4fc9c20e0a26e79551b1454d72583c97cc6610" +dependencies = [ + "windows-core 0.62.2", +] + +[[package]] +name = "windows-core" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c0fdd3ddb90610c7638aa2b3a3ab2904fb9e5cdbecc643ddb3647212781c4ae3" +dependencies = [ + "windows-implement", + "windows-interface", + "windows-link 0.1.3", + "windows-result 0.3.4", + "windows-strings 0.4.2", +] + +[[package]] +name = "windows-core" +version = "0.62.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8e83a14d34d0623b51dce9581199302a221863196a1dde71a7663a4c2be9deb" +dependencies = [ + "windows-implement", + "windows-interface", + "windows-link 0.2.1", + "windows-result 0.4.1", + "windows-strings 0.5.1", +] + +[[package]] +name = "windows-future" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc6a41e98427b19fe4b73c550f060b59fa592d7d686537eebf9385621bfbad8e" +dependencies = [ + "windows-core 0.61.2", + "windows-link 0.1.3", + "windows-threading 0.1.0", +] + +[[package]] +name = "windows-future" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e1d6f90251fe18a279739e78025bd6ddc52a7e22f921070ccdc67dde84c605cb" +dependencies = [ + "windows-core 0.62.2", + "windows-link 0.2.1", + "windows-threading 0.2.1", +] + +[[package]] +name = "windows-implement" +version = "0.60.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "053e2e040ab57b9dc951b72c264860db7eb3b0200ba345b4e4c3b14f67855ddf" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "windows-interface" +version = "0.59.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f316c4a2570ba26bbec722032c4099d8c8bc095efccdc15688708623367e358" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "windows-link" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e6ad25900d524eaabdbbb96d20b4311e1e7ae1699af4fb28c17ae66c80d798a" + +[[package]] +name = "windows-link" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" + +[[package]] +name = "windows-numerics" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9150af68066c4c5c07ddc0ce30421554771e528bde427614c61038bc2c92c2b1" +dependencies = [ + "windows-core 0.61.2", + "windows-link 0.1.3", +] + +[[package]] +name = "windows-numerics" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e2e40844ac143cdb44aead537bbf727de9b044e107a0f1220392177d15b0f26" +dependencies = [ + "windows-core 0.62.2", + "windows-link 0.2.1", +] + +[[package]] +name = "windows-registry" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "02752bf7fbdcce7f2a27a742f798510f3e5ad88dbe84871e5168e2120c3d5720" +dependencies = [ + "windows-link 0.2.1", + "windows-result 0.4.1", + "windows-strings 0.5.1", +] + +[[package]] +name = "windows-result" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56f42bd332cc6c8eac5af113fc0c1fd6a8fd2aa08a0119358686e5160d0586c6" +dependencies = [ + "windows-link 0.1.3", +] + +[[package]] +name = "windows-result" +version = "0.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7781fa89eaf60850ac3d2da7af8e5242a5ea78d1a11c49bf2910bb5a73853eb5" +dependencies = [ + "windows-link 0.2.1", +] + +[[package]] +name = "windows-service" +version = "0.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "857224b3b211c6f3616921f081ee54721ee3ad2ace2fac6a6337e032f7b4dcf2" +dependencies = [ + "bitflags 2.13.2", + "widestring 1.2.1", + "windows-sys 0.61.2", +] + +[[package]] +name = "windows-strings" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56e6c93f3a0c3b36176cb1327a4958a0353d5d166c2a35cb268ace15e91d3b57" +dependencies = [ + "windows-link 0.1.3", +] + +[[package]] +name = "windows-strings" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7837d08f69c77cf6b07689544538e017c1bfcf57e34b4c0ff58e6c2cd3b37091" +dependencies = [ + "windows-link 0.2.1", +] + +[[package]] +name = "windows-sys" +version = "0.45.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0" +dependencies = [ + "windows-targets 0.42.2", +] + +[[package]] +name = "windows-sys" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9" +dependencies = [ + "windows-targets 0.48.5", +] + +[[package]] +name = "windows-sys" +version = "0.52.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" +dependencies = [ + "windows-targets 0.52.6", +] + +[[package]] +name = "windows-sys" +version = "0.59.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b" +dependencies = [ + "windows-targets 0.52.6", +] + +[[package]] +name = "windows-sys" +version = "0.60.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2f500e4d28234f72040990ec9d39e3a6b950f9f22d3dba18416c35882612bcb" +dependencies = [ + "windows-targets 0.53.5", +] + +[[package]] +name = "windows-sys" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" +dependencies = [ + "windows-link 0.2.1", +] + +[[package]] +name = "windows-targets" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e5180c00cd44c9b1c88adb3693291f1cd93605ded80c250a75d472756b4d071" +dependencies = [ + "windows_aarch64_gnullvm 0.42.2", + "windows_aarch64_msvc 0.42.2", + "windows_i686_gnu 0.42.2", + "windows_i686_msvc 0.42.2", + "windows_x86_64_gnu 0.42.2", + "windows_x86_64_gnullvm 0.42.2", + "windows_x86_64_msvc 0.42.2", +] + +[[package]] +name = "windows-targets" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c" +dependencies = [ + "windows_aarch64_gnullvm 0.48.5", + "windows_aarch64_msvc 0.48.5", + "windows_i686_gnu 0.48.5", + "windows_i686_msvc 0.48.5", + "windows_x86_64_gnu 0.48.5", + "windows_x86_64_gnullvm 0.48.5", + "windows_x86_64_msvc 0.48.5", +] + +[[package]] +name = "windows-targets" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" +dependencies = [ + "windows_aarch64_gnullvm 0.52.6", + "windows_aarch64_msvc 0.52.6", + "windows_i686_gnu 0.52.6", + "windows_i686_gnullvm 0.52.6", + "windows_i686_msvc 0.52.6", + "windows_x86_64_gnu 0.52.6", + "windows_x86_64_gnullvm 0.52.6", + "windows_x86_64_msvc 0.52.6", +] + +[[package]] +name = "windows-targets" +version = "0.53.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4945f9f551b88e0d65f3db0bc25c33b8acea4d9e41163edf90dcd0b19f9069f3" +dependencies = [ + "windows-link 0.2.1", + "windows_aarch64_gnullvm 0.53.1", + "windows_aarch64_msvc 0.53.1", + "windows_i686_gnu 0.53.1", + "windows_i686_gnullvm 0.53.1", + "windows_i686_msvc 0.53.1", + "windows_x86_64_gnu 0.53.1", + "windows_x86_64_gnullvm 0.53.1", + "windows_x86_64_msvc 0.53.1", +] + +[[package]] +name = "windows-threading" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b66463ad2e0ea3bbf808b7f1d371311c80e115c0b71d60efc142cafbcfb057a6" +dependencies = [ + "windows-link 0.1.3", +] + +[[package]] +name = "windows-threading" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3949bd5b99cafdf1c7ca86b43ca564028dfe27d66958f2470940f73d86d75b37" +dependencies = [ + "windows-link 0.2.1", +] + +[[package]] +name = "windows-version" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e4060a1da109b9d0326b7262c8e12c84df67cc0dbc9e33cf49e01ccc2eb63631" +dependencies = [ + "windows-link 0.2.1", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "597a5118570b68bc08d8d59125332c54f1ba9d9adeedeef5b99b02ba2b0698f8" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a9d8416fa8b42f5c947f8482c43e7d89e73a173cead56d044f6a56104a6d1b53" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e08e8864a60f06ef0d0ff4ba04124db8b0fb3be5776a5cd47641e942e58c4d43" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9d782e804c2f632e395708e99a94275910eb9100b2114651e04744e9b125006" + +[[package]] +name = "windows_i686_gnu" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c61d927d8da41da96a81f029489353e68739737d3beca43145c8afec9a31a84f" + +[[package]] +name = "windows_i686_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" + +[[package]] +name = "windows_i686_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" + +[[package]] +name = "windows_i686_gnu" +version = "0.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "960e6da069d81e09becb0ca57a65220ddff016ff2d6af6a223cf372a506593a3" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fa7359d10048f68ab8b09fa71c3daccfb0e9b559aed648a8f95469c27057180c" + +[[package]] +name = "windows_i686_msvc" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "44d840b6ec649f480a41c8d80f9c65108b92d89345dd94027bfe06ac444d1060" + +[[package]] +name = "windows_i686_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" + +[[package]] +name = "windows_i686_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" + +[[package]] +name = "windows_i686_msvc" +version = "0.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e7ac75179f18232fe9c285163565a57ef8d3c89254a30685b57d83a38d326c2" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8de912b8b8feb55c064867cf047dda097f92d51efad5b491dfb98f6bbb70cb36" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9c3842cdd74a865a8066ab39c8a7a473c0778a3f29370b5fd6b4b9aa7df4a499" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "26d41b46a36d453748aedef1486d5c7a85db22e56aff34643984ea85514e94a3" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ffa179e2d07eee8ad8f57493436566c7cc30ac536a3379fdf008f47f6bb7ae1" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.42.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9aec5da331524158c6d1a4ac0ab1541149c0b9505fde06423b02f5ef0106b9f0" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.48.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.53.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d6bbff5f0aada427a1e5a6da5f1f98158182f26556f345ac9e04d36d0ebed650" + +[[package]] +name = "winnow" +version = "0.5.40" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f593a95398737aeed53e489c785df13f3618e41dbcd6718c6addbf1395aa6876" +dependencies = [ + "memchr", +] + +[[package]] +name = "winnow" +version = "0.7.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "df79d97927682d2fd8adb29682d1140b343be4ac0f08fd68b7765d9c059d3945" +dependencies = [ + "memchr", +] + +[[package]] +name = "winnow" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23b97319f7b8343df12cc98938e5c3eb436064524c8d2b4e30a1d3a36eecdf81" +dependencies = [ + "memchr", +] + +[[package]] +name = "winreg" +version = "0.55.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb5a765337c50e9ec252c2069be9bf91c7df47afb103b642ba3a53bf8101be97" +dependencies = [ + "cfg-if", + "windows-sys 0.59.0", +] + +[[package]] +name = "winreg" +version = "0.56.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7d6f32a0ff4a9f6f01231eb2059cc85479330739333e0e58cadf03b6af2cca10" +dependencies = [ + "cfg-if", + "windows-sys 0.61.2", +] + +[[package]] +name = "wintun" +version = "0.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da99be64b5aa3de869c16977994314d0759a698d9a73ab0a5b1d52e2282033ae" +dependencies = [ + "c2rust-bitfields", + "libloading 0.8.9", + "log", + "thiserror 1.0.69", + "windows-sys 0.52.0", +] + +[[package]] +name = "wireguard-nt" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "22b4dbcc6c93786cf22e420ef96e8976bfb92a455070282302b74de5848191f4" +dependencies = [ + "bitflags 2.13.2", + "getrandom 0.2.17", + "ipnet", + "libloading 0.8.9", + "log", + "thiserror 1.0.69", + "widestring 0.4.3", + "windows-sys 0.59.0", +] + +[[package]] +name = "wit-bindgen" +version = "0.57.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ebf944e87a7c253233ad6766e082e3cd714b5d03812acc24c318f549614536e" + +[[package]] +name = "wl-clipboard-rs" +version = "0.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e9651471a32e87d96ef3a127715382b2d11cc7c8bb9822ded8a7cc94072eb0a3" +dependencies = [ + "libc", + "log", + "os_pipe", + "rustix 1.1.5", + "thiserror 2.0.20", + "tree_magic_mini", + "wayland-backend", + "wayland-client", + "wayland-protocols", + "wayland-protocols-wlr", +] + +[[package]] +name = "writeable" +version = "0.6.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ad82d2a33cdc9674dc7465672f271e096168fcdbe0f799d9e6db8c5892679dc" + +[[package]] +name = "wry" +version = "0.55.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "186f9871daa55fd9c016578b810d149de58367113db7fb72b462d2323ce19514" +dependencies = [ + "base64 0.22.1", + "block2", + "cookie", + "crossbeam-channel", + "dirs 6.0.0", + "dom_query", + "dpi", + "dunce", + "gdkx11", + "gtk", + "http", + "javascriptcore-rs", + "jni 0.21.1", + "libc", + "ndk", + "objc2", + "objc2-app-kit", + "objc2-core-foundation", + "objc2-foundation", + "objc2-ui-kit", + "objc2-web-kit", + "once_cell", + "percent-encoding", + "raw-window-handle", + "sha2 0.10.9", + "soup3", + "tao-macros", + "thiserror 2.0.20", + "url", + "webkit2gtk", + "webkit2gtk-sys", + "webview2-com", + "windows 0.61.3", + "windows-core 0.61.2", + "windows-version", + "x11-dl", +] + +[[package]] +name = "x11" +version = "2.21.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "502da5464ccd04011667b11c435cb992822c2c0dbde1770c988480d312a0db2e" +dependencies = [ + "libc", + "pkg-config", +] + +[[package]] +name = "x11-dl" +version = "2.21.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "38735924fedd5314a6e548792904ed8c6de6636285cb9fec04d5b1db85c1516f" +dependencies = [ + "libc", + "once_cell", + "pkg-config", +] + +[[package]] +name = "x11rb" +version = "0.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9993aa5be5a26815fe2c3eacfc1fde061fc1a1f094bf1ad2a18bf9c495dd7414" +dependencies = [ + "gethostname", + "rustix 1.1.5", + "x11rb-protocol", +] + +[[package]] +name = "x11rb-protocol" +version = "0.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ea6fc2961e4ef194dcbfe56bb845534d0dc8098940c7e5c012a258bfec6701bd" + +[[package]] +name = "x25519-dalek" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7e468321c81fb07fa7f4c636c3972b9100f0346e5b6a9f2bd0603a52f7ed277" +dependencies = [ + "curve25519-dalek 4.1.3", + "rand_core 0.6.4", + "serde", + "zeroize", +] + +[[package]] +name = "x25519-dalek" +version = "3.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7e8131a03190127fb2263afc72b322ecadae46b6ff8c6f399ff5d02f5559af6" +dependencies = [ + "curve25519-dalek 5.0.0", + "getrandom 0.4.3", + "rand_core 0.10.1", + "zeroize", +] + +[[package]] +name = "x509-parser" +version = "0.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d43b0f71ce057da06bc0851b23ee24f3f86190b07203dd8f567d0b706a185202" +dependencies = [ + "asn1-rs", + "data-encoding", + "der-parser", + "lazy_static", + "nom 7.1.3", + "oid-registry", + "ring", + "rusticata-macros", + "thiserror 2.0.20", + "time", +] + +[[package]] +name = "xml" +version = "1.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2f45bb2c13fec6a6cb4c0f76a7e94839e110a14ec803ec2940777a94c347bc52" + +[[package]] +name = "xml-rs" +version = "0.8.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e450f9b2ed1dff33c94c12589a87338689467b9c4f5d8a5710bd09a847d2c8a7" + +[[package]] +name = "xmltree" +version = "0.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cbc04313cab124e498ab1724e739720807b6dc405b9ed0edc5860164d2e4ff70" +dependencies = [ + "xml", +] + +[[package]] +name = "yansi" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfe53a6657fd280eaa890a3bc59152892ffa3e30101319d168b781ed6529b049" + +[[package]] +name = "yasna" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b5f6765e852b9b4dc8e2a76843e4d64d1cea8e79bcde0b6901aea8e7c7f08282" +dependencies = [ + "bit-vec 0.9.1", + "time", +] + +[[package]] +name = "yoke" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "709fe23a0424b6a435d82152b1bd3fdfb0833487d5fa90d05d42762a9891fef5" +dependencies = [ + "stable_deref_trait", + "yoke-derive", + "zerofrom", +] + +[[package]] +name = "yoke-derive" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "33811428bee40dbceb6d545e95754741d17a6aef9a4849f0fd62e2ba4f412a78" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", + "synstructure 0.14.0", +] + +[[package]] +name = "zbus" +version = "5.19.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5db4be7c075cb421e4b7ee645541604239bd243ba7c357511f4ff3a74b555907" +dependencies = [ + "async-broadcast", + "async-executor", + "async-io", + "async-lock", + "async-process", + "async-recursion", + "async-task", + "async-trait", + "blocking", + "enumflags2", + "event-listener", + "futures-core", + "futures-lite", + "hex", + "libc", + "ordered-stream", + "rustix 1.1.5", + "serde", + "serde_repr", + "tracing", + "uds_windows", + "uuid", + "windows-sys 0.61.2", + "winnow 1.0.4", + "zbus_macros", + "zbus_names", + "zvariant", +] + +[[package]] +name = "zbus_macros" +version = "5.19.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2990635d09ade6df1868f72f8cac69a876a90981e8bd3c40b1be413f8dc88f40" +dependencies = [ + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "syn 3.0.6", + "zbus_names", + "zvariant", + "zvariant_utils", +] + +[[package]] +name = "zbus_names" +version = "4.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8bf88b4a3ff53e883001e0e0115b297a9d53c31b9c1edd2bfdd853e3428624e" +dependencies = [ + "serde", + "winnow 1.0.4", + "zvariant", +] + +[[package]] +name = "zcheapstr" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d1afec51604565183aeb5c54c20aeab286120d4e4460f7f76e3e8bb8c0d99473" +dependencies = [ + "serde", +] + +[[package]] +name = "zerocopy" +version = "0.7.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1b9b4fd18abc82b8136838da5d50bae7bdea537c574d8dc1a34ed098d6c166f0" +dependencies = [ + "byteorder", + "zerocopy-derive 0.7.35", +] + +[[package]] +name = "zerocopy" +version = "0.8.57" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d35102a9f36d089ccae9e4c6802bc118be4487b80aaffc0ab4e0cf5ce92d2873" +dependencies = [ + "zerocopy-derive 0.8.57", +] + +[[package]] +name = "zerocopy-derive" +version = "0.7.35" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "zerocopy-derive" +version = "0.8.57" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "146c01f5ab44258da43cf276c74a2763db2ff3969c9c652c3f2de07041d0b2bc" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "zerofrom" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ec05a11813ea801ff6d75110ad09cd0824ddba17dfe17128ea0d5f68e6c5272" +dependencies = [ + "zerofrom-derive", +] + +[[package]] +name = "zerofrom-derive" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f75b4683f6c7f45248d4d64056a24298c6281e0993356d7d1b4a1a962ef10d4a" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", + "synstructure 0.14.0", +] + +[[package]] +name = "zeroize" +version = "1.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e13c156562582aa81c60cb29407084cdb54c4164760106ab78e6c5b0858cf64e" +dependencies = [ + "zeroize_derive", +] + +[[package]] +name = "zeroize_derive" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3c50655cbb0fe3fc43170059e702f1ce5e19b84cec58dc87b037a09935c2f328" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + +[[package]] +name = "zerotrie" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ea269c3bd32f0a32c321907a2ae912ba6f4649bb0fc764a15627e99a7095a3f" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", +] + +[[package]] +name = "zerovec" +version = "0.11.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bb0464e17806c1d976d5cba29399c7f08e516e279e2ba493f63123b5fca67dd8" +dependencies = [ + "yoke", + "zerofrom", + "zerovec-derive", +] + +[[package]] +name = "zerovec-derive" +version = "0.11.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "34df6fc39dbd26ddc9c10e6a2984476e13acce22e64e4487636ef494369225da" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + +[[package]] +name = "zip" +version = "8.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2d04a6b5381502aa6087c94c669499eb1602eb9c5e8198e534de571f7154809b" +dependencies = [ + "aes 0.9.3", + "bzip2", + "constant_time_eq", + "crc32fast", + "deflate64", + "flate2", + "getrandom 0.4.3", + "hmac 0.13.0", + "indexmap 2.14.2", + "lzma-rust2", + "memchr", + "pbkdf2", + "ppmd-rust", + "sha1 0.11.0", + "time", + "typed-path", + "zeroize", + "zopfli", + "zstd 0.13.3", +] + +[[package]] +name = "zlib-rs" +version = "0.6.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b268e58e7c693d7c271f93ffc4ba3b380412554231c85bf61ca7af91042a4112" + +[[package]] +name = "zmij" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29666d0abbfad1e3dc4dcf6144730dd3a3ab225bbbdac83319345b1b44ccfc1b" + +[[package]] +name = "zopfli" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f05cd8797d63865425ff89b5c4a48804f35ba0ce8d125800027ad6017d2b5249" +dependencies = [ + "bumpalo", + "crc32fast", + "log", + "simd-adler32", +] + +[[package]] +name = "zstd" +version = "0.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e91ee311a569c327171651566e07972200e76fcfe2242a4fa446149a3881c08a" +dependencies = [ + "zstd-safe 7.3.0", +] + +[[package]] +name = "zstd" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bf06bd8162af0734b344780deb55b42a2429ae430870d13fcc12f238e880fe6e" +dependencies = [ + "zstd-safe 8.0.0", +] + +[[package]] +name = "zstd-safe" +version = "7.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "64d80649ab6db9d9f6f9c80a40becd948eda4714a0a5ac8c4d157a32231c7882" +dependencies = [ + "zstd-sys", +] + +[[package]] +name = "zstd-safe" +version = "8.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae42c0555055784c70058d19ba8e275528e8a99a706684868ace5da4e716a4ab" +dependencies = [ + "zstd-sys", +] + +[[package]] +name = "zstd-sys" +version = "2.1.0+zstd.1.5.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ef0a8027ec3ee71300ab3bcbcd0393f434aa72b91ca6d635a39941deae8eea0" +dependencies = [ + "cc", + "pkg-config", +] + +[[package]] +name = "zune-core" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d56377fd46368984a170bc5aac5567e52ca5da874caa60bea39fcbca78fb658b" + +[[package]] +name = "zune-jpeg" +version = "0.5.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27bc9d5b815bc103f142aa054f561d9187d191692ec7c2d1e2b4737f8dbd7296" +dependencies = [ + "zune-core", +] + +[[package]] +name = "zvariant" +version = "5.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c1d34c27cc6cdd1f458427519dd6b8612f7b7e3f7b9a0b2355d041dda9869147" +dependencies = [ + "endi", + "enumflags2", + "serde", + "winnow 1.0.4", + "zcheapstr", + "zvariant_derive", + "zvariant_utils", +] + +[[package]] +name = "zvariant_derive" +version = "5.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "864155e69b4352db0c7f374917bf45d1e0c8d17659c8b3dbf9795f3673f8c497" +dependencies = [ + "proc-macro-crate 3.5.0", + "proc-macro2", + "quote", + "syn 3.0.6", + "zvariant_utils", +] + +[[package]] +name = "zvariant_utils" +version = "4.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bad0294361a320b694a328460dc73add56c306150f5cb6bfafc44446120008a3" +dependencies = [ + "proc-macro2", + "quote", + "serde", + "syn 3.0.6", + "winnow 1.0.4", +] diff --git a/vendor/easytier/Cargo.toml b/vendor/easytier/Cargo.toml new file mode 100644 index 0000000..e9938c5 --- /dev/null +++ b/vendor/easytier/Cargo.toml @@ -0,0 +1,105 @@ +[workspace] +resolver = "2" +members = ["easytier", "easytier-core", "easytier-proto"] +default-members = ["easytier"] +exclude = [] + +[workspace.package] +edition = "2024" +rust-version = "1.95" + +[workspace.dependencies] +# Shared versions and sources; members select features and optional dependencies. +anyhow = "1.0" +arc-swap = "1.9" +async-trait = "0.1.92" +atomic-shim = "0.2.0" +auto_impl = "1.3.0" +axum = "0.8" +# Match pbjson 0.9's base64 dependency; upgrade together to avoid two codecs. +base64 = "0.22.1" +bon = "3.10.1" +bytecodec = "0.5.0" +bytes = "1.12.1" +chrono = "0.4.45" +cidr = "0.3.2" +clap = "4.6.7" +crossbeam = "0.8.5" +crossbeam-utils = "0.8.23" +dashmap = "6.2.1" +easytier = { version = "2.7.0", path = "easytier", default-features = false } +easytier-core = { version = "2.7.0", path = "easytier-core", default-features = false } +easytier-ffi = { version = "0.1.0", path = "easytier-contrib/easytier-ffi", default-features = false } +easytier-ohos-core = { version = "0.1.0", path = "easytier-contrib/easytier-ohrs/crates/easytier-ohos-core", default-features = false } +easytier-ohos-features = { version = "0.1.0", path = "easytier-contrib/easytier-ohrs/crates/easytier-ohos-features", default-features = false } +easytier-proto = { version = "2.7.0", path = "easytier-proto", default-features = false } +futures = { version = "0.3", default-features = false } +gethostname = "1.1" +guarden = "0.3" +# Keep HMAC/SHA2 on digest 0.10, shared by stun_codec 0.4 and snow 0.10. +# Upgrade this crypto family together when those upstream constraints move. +hmac = "0.12.1" +http-body-util = "0.1" +hyper = { version = "1", default-features = false } +hyper-util = { version = "0.1", default-features = false } +indoc = "2.0.7" +log = "0.4" +mimalloc = "*" +once_cell = "1.21" +parking_lot = "0.12.5" +percent-encoding = "2.3.2" +pin-project-lite = "0.2.17" +prost = "0.14.4" +prost-types = "0.14.4" +quanta = "0.12" +# rand 0.10 / x25519-dalek 3 require a coordinated RNG trait migration. +rand = "0.8.8" +reqwest = { version = "0.13.5", default-features = false } +rust-i18n = "4" +rustls = { version = "0.23.45", default-features = false } +# tower-sessions-sqlx-store 0.15 requires SQLx 0.8; SeaORM 2 requires SQLx 0.9. +sea-orm = "1.1.20" +sea-orm-migration = "1.1.20" +serde = "1.0.229" +serde_json = "1.0" +# See the HMAC constraint above; SHA2 must use the same digest generation. +sha2 = "0.10.9" +smoltcp = { version = "0.14.0", default-features = false } +sqlx = "0.8.6" +strum = "0.28.0" +stun_codec = "0.4.0" +sys-locale = "0.3" +tauri = "2.11.5" +tempfile = "3.27.0" +thiserror = "2.0" +thunk-rs = { git = "https://github.com/EasyTier/thunk.git", default-features = false } +tokio = { version = "1.53", default-features = false } +tokio-rustls = { version = "0.26", default-features = false } +tokio-util = "0.7.19" +toml = "1.1.6" +tower-http = "0.7" +tracing = "0.1" +tracing-subscriber = { version = "0.3", default-features = false } +url = "2.5" +uuid = "1.26.1" +winapi = "0.3.9" +windows = "0.62" +x25519-dalek = "2.0.1" +# zerocopy 0.8 requires migrating the packet layout and casting APIs. +zerocopy = "0.7.35" + +[profile.dev] +panic = "unwind" +debug = 2 + +[profile.release] +panic = "abort" +lto = true +codegen-units = 1 +opt-level = 3 +strip = true + +[profile.mini] +inherits = "release" +opt-level = "z" +strip = "symbols" diff --git a/vendor/easytier/LICENSE b/vendor/easytier/LICENSE new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/vendor/easytier/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/vendor/easytier/MESHPORT.md b/vendor/easytier/MESHPORT.md new file mode 100644 index 0000000..11044e3 --- /dev/null +++ b/vendor/easytier/MESHPORT.md @@ -0,0 +1,23 @@ +# MeshPort vendored EasyTier + +Source: https://github.com/EasyTier/EasyTier +Upstream revision: 7af7bdc16a41d64d58743d15023a63b3eed2102c +Imported using git archive. Retained LGPL-3.0 LICENSE and upstream crate sources. + +This is a local source customization, not a published GitHub fork. Root workspace members were limited to easytier, easytier-core and easytier-proto for the SDK build. MeshPort root uses path dependencies and its own Cargo.lock. + +Local modifications: +- easytier/src/common/network.rs: macOS hardware enumeration uses blocking subprocess waits; physical connection candidates exclude route-probe addresses and nonphysical IPv6 interfaces so another VPN's TUN is not reintroduced. Hardware device names match exactly. +- easytier-core/src/peers/meshport_optimization.rs: direct preference, improvement thresholds, hold/cooldown and candidate first-hop filter. +- easytier-core/src/peers/mod.rs: exposes policy module. +- easytier-core/src/peers/conn/peer_map.rs: local policy and bounded decision caches. +- easytier-core/src/peers/conn/peer.rs: optional UDP preference, skip closed connections, resolve default selection for status/fallback. +- easytier-core/src/peers/peer_manager.rs: policy configuration and effective next-hop inspection. +- easytier/src/common/ifcfg/mod.rs: macOS interface commands use blocking-pool subprocess waits rather than Tokio SIGCHLD-driven waits, for embedded runtime compatibility. +- easytier-core/src/instance/packet_plane.rs: optional host subnet filter for route projection. +- easytier-core/src/peers/peer_manager.rs: apply the same host filter to application TCP/UDP packet destinations. +- easytier/src/instance/virtual_nic.rs: recompute filtered route deltas on events and periodic refresh, retry failed route additions. +- easytier/Cargo.toml and easytier/src/instance/config.rs: expose the existing core packet proxy as an independent native host capability for subnet-gateway tests, without requiring KCP/QUIC. SDK production builds do not enable it. +- Cargo.toml: reduced workspace member list. + +No packet/protobuf wire-format modification. Do not assume mixed-version interoperability from local tests alone. Before upstream updates, compare these files against the pinned revision and rerun MeshPort real overlay and transport fallback tests. See ../../docs/optimization.md for policy limits. diff --git a/vendor/easytier/easytier-core/Cargo.toml b/vendor/easytier/easytier-core/Cargo.toml new file mode 100644 index 0000000..fde05de --- /dev/null +++ b/vendor/easytier/easytier-core/Cargo.toml @@ -0,0 +1,178 @@ +[package] +name = "easytier-core" +description = "EasyTier OS-free control-plane core primitives." +homepage = "https://github.com/EasyTier/EasyTier" +repository = "https://github.com/EasyTier/EasyTier" +version = "2.7.0" +edition.workspace = true +rust-version.workspace = true +authors = ["kkrainbow"] +keywords = ["vpn", "p2p", "network", "easytier"] +categories = ["network-programming"] +license-file = "../LICENSE" + +[lib] +crate-type = ["rlib", "cdylib"] + +[package.metadata.wasm-pack.profile.release] +wasm-opt = ["-Oz", "--enable-bulk-memory", "--enable-nontrapping-float-to-int"] + +[dependencies] +anyhow.workspace = true +ariadne = { version = "0.6", optional = true } +arc-swap.workspace = true +async-ringbuf = "0.3.9" +async-trait.workspace = true +auto_impl.workspace = true +base64.workspace = true +bitflags = "2.13" +bytecodec.workspace = true +bytes.workspace = true +chrono = { workspace = true, features = ["clock"] } +cidr = { workspace = true, features = ["serde"] } +crossbeam-utils.workspace = true +dashmap.workspace = true +bon.workspace = true +easytier-proto = { workspace = true, features = ["core"] } +futures = { workspace = true, features = ["std", "async-await"] } +guarden.workspace = true +hmac.workspace = true +http-body-util = { workspace = true, optional = true } +hyper = { workspace = true, features = ["client", "http1"], optional = true } +hyper-util = { workspace = true, features = ["tokio"], optional = true } +idna = "1.1" +atomic-shim.workspace = true +ordered_hash_map = "0.6.1" +parking_lot.workspace = true +percent-encoding.workspace = true +petgraph = "0.8.3" +pin-project-lite.workspace = true +prefix-trie = { version = "0.10.1", features = ["cidr"] } +prost.workspace = true +prost-types.workspace = true +rand.workspace = true +quanta.workspace = true +ring = { version = "0.17", optional = true } +rustls = { workspace = true, features = ["ring", "std", "tls12"], optional = true } +serde = { workspace = true, features = ["derive"] } +serde_json.workspace = true +sha2.workspace = true +smoltcp = { workspace = true, optional = true } +# All core Noise handshakes use 25519_ChaChaPoly_SHA256. Snow's std feature +# also enables unused ring and BLAKE2 dependencies, so use its alloc support. +snow = { version = "0.10.0", default-features = false, features = [ + "use-chacha20poly1305", + "use-sha2", + "use-curve25519", + "use-getrandom", +] } +stun_codec.workspace = true +thiserror.workspace = true +tracing.workspace = true +strum = { workspace = true, features = ["derive"] } +toml.workspace = true +tokio = { workspace = true, features = [ + "rt", + "time", + "sync", + "macros", + "io-util", +] } +tokio-util = { workspace = true, features = ["io", "rt"] } +tokio-rustls = { workspace = true, optional = true } +url = { workspace = true, features = ["serde"] } +wildmatch = "2.6.1" +uuid = { workspace = true, features = ["v4", "serde"] } +webpki-roots = { version = "1.0", optional = true } +x25519-dalek = { workspace = true, features = ["static_secrets"] } +zerocopy = { workspace = true, features = ["derive", "simd"] } +zstd = { version = "0.14", optional = true } +# Match snow 0.10's AEAD generation to share aead, cipher and crypto-common. +# Upgrade together with snow rather than pulling in a second crypto stack. +aes-gcm = { version = "0.10.3", optional = true } +chacha20poly1305 = { version = "0.10.1", optional = true } +openssl = { version = "0.10", optional = true, features = ["vendored"] } + +[target.'cfg(all(target_arch = "wasm32", target_os = "unknown"))'.dependencies] +getrandom-02 = { package = "getrandom", version = "0.2.17", features = ["js"] } +getrandom-03 = { package = "getrandom", version = "0.3.4", features = ["wasm_js"] } +ring = { version = "0.17", features = ["wasm32_unknown_unknown_js"], optional = true } +rustls-pki-types = { version = "1.15.1", features = ["web"], optional = true } +uuid = { workspace = true, features = ["js"] } +wasm-bindgen = "0.2" + +[features] +default = ["aes-gcm", "endpoint-discovery", "extended-services", "management", "tcp-hole-punch"] +aes-gcm = ["dep:aes-gcm"] +browser-config = ["config-write", "easytier-proto/api", "easytier-proto/json-rpc"] +chacha20 = ["dep:chacha20poly1305"] +openssl-crypto = ["dep:openssl"] +ring-crypto = ["dep:ring"] +wasi-crypto-offload = ["ring-crypto"] +config-write = [] +endpoint-discovery = [ + "dep:http-body-util", + "dep:hyper", + "dep:hyper-util", + "dep:ring", + "dep:rustls", + "dep:rustls-pki-types", + "dep:tokio-rustls", + "dep:webpki-roots", +] +dhcp-ipv4 = [] +public-ipv6-provider = [] +vpn-portal = [] +wrapped-transport = [] +extended-services = [ + "dhcp-ipv4", + "public-ipv6-provider", + "vpn-portal", + "wrapped-transport", + "proxy-cidr-monitor", +] +web-client = ["management-rpc", "config-write"] +management = ["web-client", "extended-services", "rich-config-errors", "easytier-proto/json-rpc"] +management-rpc = ["easytier-proto/api"] +proxy-cidr-monitor = [] +rich-config-errors = ["dep:ariadne"] +tcp-hole-punch = [] +proxy-packet = [ + "wrapped-transport", + "dep:smoltcp", + "smoltcp/std", + "smoltcp/proto-ipv4", + "smoltcp/proto-ipv4-fragmentation", + "smoltcp/fragmentation-buffer-size-65536", + "smoltcp/assembler-max-segment-count-16", + "smoltcp/reassembly-buffer-size-65536", + "smoltcp/reassembly-buffer-count-16", +] +proxy-smoltcp-stack = [ + "proxy-packet", + "smoltcp/medium-ip", + "smoltcp/socket-tcp", + "smoltcp/socket-udp", + "smoltcp/proto-ipv6", + "smoltcp/async", +] +wasm-host-tunnel = [] +wasm-host-tunnel-outbound = ["wasm-host-tunnel"] +test-utils = [] +tracing-log = ["tracing/log"] +zstd = ["dep:zstd"] + +[dev-dependencies] +futures = { workspace = true, features = ["executor"] } + +[target.'cfg(not(target_os = "wasi"))'.dev-dependencies] +tokio = { workspace = true, features = ["rt-multi-thread", "test-util"] } + +[package.metadata.cargo-machete] +ignored = [ + # Enable browser entropy backends for transitive rand/snow/AEAD dependencies. + "getrandom-02", + "getrandom-03", + # Enable browser time for rustls certificate validation. + "rustls-pki-types", +] diff --git a/vendor/easytier/easytier-core/src/config/api.rs b/vendor/easytier/easytier-core/src/config/api.rs new file mode 100644 index 0000000..47b58b8 --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/api.rs @@ -0,0 +1,219 @@ +//! Portable conversion between the shared TOML model and management schema. + +use easytier_proto::api::manage::{ + self, NetworkConfig, NetworkingMethod, PortForwardConfig as ApiPortForwardConfig, +}; + +use super::{ + api_input::managed_credential_to_proto, + toml::{ConfigLoader as _, TomlConfig}, +}; + +pub fn network_config_from_toml(config: &TomlConfig) -> NetworkConfig { + let default_config = TomlConfig::default(); + let mut result = NetworkConfig { + instance_id: Some(config.get_id().to_string()), + dhcp: Some(config.get_dhcp()), + ..Default::default() + }; + + if config.get_hostname() != default_config.get_hostname() { + result.hostname = Some(config.get_hostname()); + } + + let network_identity = config.get_network_identity(); + result.network_name = Some(network_identity.network_name); + result.network_secret = network_identity.network_secret; + + if let Some(ipv4) = config.get_ipv4() { + result.virtual_ipv4 = Some(ipv4.address().to_string()); + result.network_length = Some(ipv4.network_length() as i32); + } + + if config.get_ipv6_public_addr_provider() != default_config.get_ipv6_public_addr_provider() { + result.ipv6_public_addr_provider = Some(config.get_ipv6_public_addr_provider()); + } + if config.get_ipv6_public_addr_auto() != default_config.get_ipv6_public_addr_auto() { + result.ipv6_public_addr_auto = Some(config.get_ipv6_public_addr_auto()); + } + result.ipv6_public_addr_prefix = config + .get_ipv6_public_addr_prefix() + .map(|prefix| prefix.to_string()); + + let peers = config.get_peers(); + result.networking_method = Some(NetworkingMethod::Manual as i32); + if !peers.is_empty() { + result.peer_urls = peers.iter().map(|peer| peer.uri.to_string()).collect(); + result.peers = peers + .iter() + .map(|peer| manage::NetworkPeerConfig { + uri: peer.uri.to_string(), + peer_public_key: peer.peer_public_key.clone(), + }) + .collect(); + } + + result.listener_urls = config + .get_listeners() + .unwrap_or_default() + .iter() + .map(ToString::to_string) + .collect(); + result.proxy_cidrs = config + .get_proxy_cidrs() + .iter() + .map(|proxy| match proxy.mapped_cidr { + Some(mapped) => format!("{}->{}", proxy.cidr, mapped), + None => proxy.cidr.to_string(), + }) + .collect(); + + let port_forwards = config.get_port_forwards(); + if !port_forwards.is_empty() { + result.port_forwards = port_forwards + .iter() + .map(|forward| ApiPortForwardConfig { + proto: forward.proto.clone(), + bind_ip: forward.bind_addr.ip().to_string(), + bind_port: forward.bind_addr.port() as u32, + dst_ip: forward.dst_addr.ip().to_string(), + dst_port: forward.dst_addr.port() as u32, + }) + .collect(); + } + + if let Some(vpn_config) = config.get_vpn_portal_config() { + result.vpn_portal_config = Some(manage::VpnPortalConfig { + enabled: vpn_config.enabled, + wireguard_listen: vpn_config.wireguard_listen.to_string(), + wireguard_private_key: vpn_config.wireguard_private_key, + clients: vpn_config + .clients + .into_iter() + .map(|client| manage::VpnPortalClientConfig { + name: client.name, + virtual_ip: client.virtual_ip.to_string(), + groups: client.groups, + }) + .collect(), + }); + } + + if let Some(routes) = config.get_routes() + && !routes.is_empty() + { + result.enable_manual_routes = Some(true); + result.routes = routes.iter().map(ToString::to_string).collect(); + } + let exit_nodes = config.get_exit_nodes(); + if !exit_nodes.is_empty() { + result.exit_nodes = exit_nodes.iter().map(ToString::to_string).collect(); + } + if let Some(socks5_portal) = config.get_socks5_portal() { + result.enable_socks5 = Some(true); + result.socks5_port = socks5_portal.port().map(|port| port as i32); + } + let mapped_listeners = config.get_mapped_listeners(); + if !mapped_listeners.is_empty() { + result.mapped_listeners = mapped_listeners.iter().map(ToString::to_string).collect(); + } + + result.secure_mode = config.get_secure_mode(); + result.credential_file = config + .get_credential_file() + .map(|path| path.to_string_lossy().into_owned()); + result.managed_credentials = config + .get_managed_credentials() + .into_iter() + .map(managed_credential_to_proto) + .collect(); + + let flags = config.get_flags(); + let default_flags = default_config.get_flags(); + result.latency_first = Some(flags.latency_first); + result.dev_name = Some(flags.dev_name.clone()); + result.use_smoltcp = Some(flags.use_smoltcp); + result.disable_ipv6 = Some(!flags.enable_ipv6); + result.enable_kcp_proxy = Some(flags.enable_kcp_proxy); + result.disable_kcp_input = Some(flags.disable_kcp_input); + result.enable_quic_proxy = Some(flags.enable_quic_proxy); + result.disable_quic_input = Some(flags.disable_quic_input); + result.disable_p2p = Some(flags.disable_p2p); + result.p2p_only = Some(flags.p2p_only); + result.lazy_p2p = Some(flags.lazy_p2p); + result.bind_device = Some(flags.bind_device); + result.socket_mark = flags.socket_mark; + result.no_tun = Some(flags.no_tun); + result.enable_exit_node = Some(flags.enable_exit_node); + result.relay_all_peer_rpc = Some(flags.relay_all_peer_rpc); + result.need_p2p = Some(flags.need_p2p); + result.multi_thread = Some(flags.multi_thread); + result.proxy_forward_by_system = Some(flags.proxy_forward_by_system); + result.disable_encryption = Some(!flags.enable_encryption); + result.disable_tcp_hole_punching = Some(flags.disable_tcp_hole_punching); + result.disable_udp_hole_punching = Some(flags.disable_udp_hole_punching); + result.disable_upnp = Some(flags.disable_upnp); + result.disable_relay_data = Some(flags.disable_relay_data); + result.prefer_peer_relay = Some(flags.prefer_peer_relay); + result.enable_udp_broadcast_relay = Some(flags.enable_udp_broadcast_relay); + result.disable_sym_hole_punching = Some(flags.disable_sym_hole_punching); + result.enable_magic_dns = Some(flags.accept_dns); + result.mtu = Some(flags.mtu as i32); + result.data_compress_algo = (flags.data_compress_algo != default_flags.data_compress_algo) + .then_some(flags.data_compress_algo); + result.encryption_algorithm = (flags.encryption_algorithm + != default_flags.encryption_algorithm) + .then_some(flags.encryption_algorithm); + result.instance_recv_bps_limit = + (flags.instance_recv_bps_limit != u64::MAX).then_some(flags.instance_recv_bps_limit); + result.enable_private_mode = Some(flags.private_mode); + result.acl = config.get_acl(); + + if flags.relay_network_whitelist == "*" { + result.enable_relay_network_whitelist = Some(false); + } else { + result.enable_relay_network_whitelist = Some(true); + result.relay_network_whitelist = flags + .relay_network_whitelist + .split_whitespace() + .map(ToOwned::to_owned) + .collect(); + } + + result +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::config::toml::ManagedCredentialConfig; + + #[test] + fn includes_managed_credentials() { + let config = TomlConfig::default(); + config.set_managed_credentials(vec![ManagedCredentialConfig { + credential_id: "managed-a".to_owned(), + credential_secret: "credential-secret".to_owned(), + groups: vec!["ops".to_owned()], + allow_relay: true, + allowed_proxy_cidrs: vec!["10.0.0.0/24".to_owned()], + expiry_unix: 2_000_000_000, + reusable: false, + }]); + + let projected = network_config_from_toml(&config); + + assert_eq!( + projected.managed_credentials, + vec![manage::ManagedCredentialConfig { + credential_id: "managed-a".to_owned(), + credential_secret: "credential-secret".to_owned(), + groups: vec!["ops".to_owned()], + allow_relay: true, + allowed_proxy_cidrs: vec!["10.0.0.0/24".to_owned()], + expiry_unix: 2_000_000_000, + reusable: Some(false), + }] + ); + } +} diff --git a/vendor/easytier/easytier-core/src/config/api_input.rs b/vendor/easytier/easytier-core/src/config/api_input.rs new file mode 100644 index 0000000..62dd96c --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/api_input.rs @@ -0,0 +1,1016 @@ +//! Conversion between the management NetworkConfig schema and shared TOML. + +use std::net::SocketAddr; + +use anyhow::Context; +use easytier_proto::api::manage; + +use crate::config::{ + MappedListenerPolicy, normalize_secure_mode_config, + toml::{ + ConfigLoader, ManagedCredentialConfig, NetworkIdentity, PeerConfig, PortForwardConfig, + TomlConfigLoader, VpnPortalClientConfig, VpnPortalConfig, gen_default_flags, + }, +}; + +fn parse_mapped_listener_urls(mapped_listeners: &[String]) -> Result, anyhow::Error> { + MappedListenerPolicy::new(["tcp", "udp", "wg", "quic", "ws", "wss", "faketcp"]) + .parse_urls(mapped_listeners) +} + +pub fn add_proxy_network_to_config( + proxy_network: &str, + cfg: &TomlConfigLoader, +) -> Result<(), anyhow::Error> { + let parts: Vec<&str> = proxy_network.split("->").collect(); + let real_cidr = parts[0] + .parse() + .with_context(|| format!("failed to parse proxy network: {}", parts[0]))?; + + if parts.len() > 2 { + return Err(anyhow::anyhow!( + "invalid proxy network format: {}, support format: or ->, example: + 10.0.0.0/24 or 10.0.0.0/24->192.168.0.0/24", + proxy_network + )); + } + + let mapped_cidr = if parts.len() == 2 { + Some( + parts[1] + .parse() + .with_context(|| format!("failed to parse mapped network: {}", parts[1]))?, + ) + } else { + None + }; + cfg.add_proxy_cidr(real_cidr, mapped_cidr)?; + Ok(()) +} + +pub type NetworkingMethod = easytier_proto::api::manage::NetworkingMethod; +pub type NetworkConfig = easytier_proto::api::manage::NetworkConfig; + +pub(crate) fn managed_credential_from_proto( + credential: &manage::ManagedCredentialConfig, +) -> ManagedCredentialConfig { + ManagedCredentialConfig { + credential_id: credential.credential_id.clone(), + credential_secret: credential.credential_secret.clone(), + groups: credential.groups.clone(), + allow_relay: credential.allow_relay, + allowed_proxy_cidrs: credential.allowed_proxy_cidrs.clone(), + expiry_unix: credential.expiry_unix, + reusable: credential.reusable.unwrap_or(true), + } +} + +pub(crate) fn managed_credential_to_proto( + credential: ManagedCredentialConfig, +) -> manage::ManagedCredentialConfig { + manage::ManagedCredentialConfig { + credential_id: credential.credential_id, + credential_secret: credential.credential_secret, + groups: credential.groups, + allow_relay: credential.allow_relay, + allowed_proxy_cidrs: credential.allowed_proxy_cidrs, + expiry_unix: credential.expiry_unix, + reusable: Some(credential.reusable), + } +} + +pub trait NetworkConfigExt { + fn gen_config(&self) -> Result; + fn new_from_config(config: impl ConfigLoader) -> Result; +} + +#[cfg(all( + feature = "browser-config", + any(test, all(target_arch = "wasm32", target_os = "unknown")) +))] +const FORM_MANAGED_TOML_FIELDS: &[&str] = &[ + "hostname", + "instance_id", + "ipv4", + "ipv6_public_addr_provider", + "ipv6_public_addr_auto", + "ipv6_public_addr_prefix", + "dhcp", + "network_identity", + "listeners", + "mapped_listeners", + "exit_nodes", + "peer", + "proxy_network", + "vpn_portal_config", + "routes", + "socks5_proxy", + "port_forward", + "secure_mode", + "acl", + "credential_file", + "managed_credentials", +]; + +#[cfg(all( + feature = "browser-config", + any(test, all(target_arch = "wasm32", target_os = "unknown")) +))] +const FORM_MANAGED_FLAG_FIELDS: &[&str] = &[ + "latency_first", + "dev_name", + "use_smoltcp", + "enable_ipv6", + "enable_kcp_proxy", + "disable_kcp_input", + "enable_quic_proxy", + "disable_quic_input", + "disable_p2p", + "p2p_only", + "lazy_p2p", + "bind_device", + "socket_mark", + "no_tun", + "enable_exit_node", + "relay_all_peer_rpc", + "need_p2p", + "multi_thread", + "proxy_forward_by_system", + "enable_encryption", + "relay_network_whitelist", + "disable_tcp_hole_punching", + "disable_udp_hole_punching", + "disable_upnp", + "disable_relay_data", + "prefer_peer_relay", + "enable_udp_broadcast_relay", + "disable_sym_hole_punching", + "accept_dns", + "mtu", + "instance_recv_bps_limit", + "private_mode", + "encryption_algorithm", + "data_compress_algo", +]; + +#[cfg(all( + feature = "browser-config", + any(test, all(target_arch = "wasm32", target_os = "unknown")) +))] +pub(crate) fn merge_network_config_toml( + original_toml: &str, + config: &NetworkConfig, +) -> Result { + let generated_toml = config.gen_config()?.dump(); + let mut original = toml::from_str::(original_toml) + .context("failed to parse the original TOML document")?; + let mut generated = toml::from_str::(&generated_toml) + .context("failed to parse the generated TOML document")?; + + for (key, value) in original.iter() { + if key != "flags" && !FORM_MANAGED_TOML_FIELDS.contains(&key.as_str()) { + generated.insert(key.clone(), value.clone()); + } + } + if !original.contains_key("instance_name") { + generated.remove("instance_name"); + } + + let mut merged_flags: toml::Table = original + .remove("flags") + .and_then(|value| value.try_into().ok()) + .unwrap_or_default(); + let generated_flags: toml::Table = generated + .remove("flags") + .and_then(|value| value.try_into().ok()) + .unwrap_or_default(); + for key in FORM_MANAGED_FLAG_FIELDS { + if let Some(value) = generated_flags.get(*key) { + merged_flags.insert((*key).to_owned(), value.clone()); + } else { + merged_flags.remove(*key); + } + } + if !merged_flags.is_empty() { + generated.insert("flags".to_owned(), toml::Value::Table(merged_flags)); + } + + toml::to_string_pretty(&generated).context("failed to serialize the merged TOML document") +} + +fn parse_peer(peer: &manage::NetworkPeerConfig) -> Result, anyhow::Error> { + let uri = peer.uri.trim(); + if uri.is_empty() { + return Ok(None); + } + + Ok(Some(PeerConfig { + uri: uri + .parse() + .with_context(|| format!("failed to parse peer uri: {}", uri))?, + peer_public_key: peer.peer_public_key.clone(), + })) +} + +fn parse_peers(peers: &[manage::NetworkPeerConfig]) -> Result, anyhow::Error> { + let mut ret = Vec::new(); + for peer in peers { + if let Some(peer) = parse_peer(peer)? { + ret.push(peer); + } + } + Ok(ret) +} + +fn parse_peer_urls(peer_urls: &[String]) -> Result, anyhow::Error> { + let mut peers = vec![]; + for peer_url in peer_urls.iter() { + let peer_url = peer_url.trim(); + if peer_url.is_empty() { + continue; + } + peers.push(PeerConfig { + uri: peer_url + .parse() + .with_context(|| format!("failed to parse peer uri: {}", peer_url))?, + peer_public_key: None, + }); + } + Ok(peers) +} + +impl NetworkConfigExt for NetworkConfig { + #[allow(deprecated)] + fn gen_config(&self) -> Result { + let cfg = TomlConfigLoader::default(); + cfg.set_id( + self.instance_id + .clone() + .unwrap_or(uuid::Uuid::new_v4().to_string()) + .parse() + .with_context(|| format!("failed to parse instance id: {:?}", self.instance_id))?, + ); + cfg.set_hostname(self.hostname.clone()); + cfg.set_dhcp(self.dhcp.unwrap_or_default()); + cfg.set_inst_name(self.network_name.clone().unwrap_or_default()); + + // The web UI does not expose credential inputs directly, but imported/saved + // NetworkConfig objects still need to preserve credential-mode instances via + // secure_mode.local_private_key + empty network_secret. + let credential_secret = if self.network_secret.is_some() { + None + } else { + self.secure_mode + .as_ref() + .and_then(|mode| mode.local_private_key.clone()) + .filter(|s| !s.is_empty()) + }; + + if credential_secret.is_some() { + cfg.set_network_identity(NetworkIdentity::new_credential( + self.network_name.clone().unwrap_or_default(), + )); + } else { + cfg.set_network_identity(NetworkIdentity::new( + self.network_name.clone().unwrap_or_default(), + self.network_secret.clone().unwrap_or_default(), + )); + } + + if !cfg.get_dhcp() { + let virtual_ipv4 = self.virtual_ipv4.clone().unwrap_or_default(); + if !virtual_ipv4.is_empty() { + let ip = format!("{}/{}", virtual_ipv4, self.network_length.unwrap_or(24)) + .parse() + .with_context(|| { + format!( + "failed to parse ipv4 inet address: {}, {:?}", + virtual_ipv4, self.network_length + ) + })?; + cfg.set_ipv4(Some(ip)); + } + } + + match NetworkingMethod::try_from(self.networking_method.unwrap_or_default()) + .unwrap_or_default() + { + NetworkingMethod::PublicServer => { + let peers = parse_peers(&self.peers)?; + if peers.is_empty() { + let public_server_url = self.public_server_url.clone().unwrap_or_default(); + cfg.set_peers(vec![PeerConfig { + uri: public_server_url.parse().with_context(|| { + format!("failed to parse public server uri: {}", public_server_url) + })?, + peer_public_key: None, + }]); + } else { + cfg.set_peers(peers); + } + } + NetworkingMethod::Manual => { + let mut peers = parse_peers(&self.peers)?; + if peers.is_empty() { + peers = parse_peer_urls(&self.peer_urls)?; + } + if !peers.is_empty() { + cfg.set_peers(peers); + } + } + NetworkingMethod::Standalone => {} + } + + let mut listener_urls = vec![]; + for listener_url in self.listener_urls.iter() { + if listener_url.is_empty() { + continue; + } + listener_urls.push( + listener_url + .parse() + .with_context(|| format!("failed to parse listener uri: {}", listener_url))?, + ); + } + cfg.set_listeners(listener_urls); + + for n in self.proxy_cidrs.iter() { + add_proxy_network_to_config(n, &cfg)?; + } + + if !self.port_forwards.is_empty() { + cfg.set_port_forwards( + self.port_forwards + .iter() + .filter(|pf| !pf.bind_ip.is_empty() && !pf.dst_ip.is_empty()) + .filter_map(|pf| { + let bind_addr = + format!("{}:{}", pf.bind_ip, pf.bind_port).parse::(); + let dst_addr = + format!("{}:{}", pf.dst_ip, pf.dst_port).parse::(); + + match (bind_addr, dst_addr) { + (Ok(bind_addr), Ok(dst_addr)) => Some(PortForwardConfig { + bind_addr, + dst_addr, + proto: pf.proto.clone(), + }), + _ => None, + } + }) + .collect::>(), + ); + } + + if self.enable_vpn_portal == Some(true) { + anyhow::bail!( + "legacy VPN portal configuration is no longer supported; configure vpn_portal_config with named clients" + ); + } + + if let Some(vpn_config) = &self.vpn_portal_config { + cfg.set_vpn_portal_config(VpnPortalConfig { + enabled: vpn_config.enabled, + wireguard_listen: vpn_config.wireguard_listen.parse().with_context(|| { + format!( + "failed to parse vpn portal wireguard listen address: {}", + vpn_config.wireguard_listen + ) + })?, + wireguard_private_key: vpn_config.wireguard_private_key.clone(), + clients: vpn_config + .clients + .iter() + .map(|client| { + Ok(VpnPortalClientConfig { + name: client.name.clone(), + virtual_ip: client.virtual_ip.parse().with_context(|| { + format!( + "failed to parse vpn portal virtual IP for client {}: {}", + client.name, client.virtual_ip + ) + })?, + groups: client.groups.clone(), + }) + }) + .collect::, anyhow::Error>>()?, + }); + } + + if self.enable_manual_routes.unwrap_or_default() { + let mut routes = Vec::::with_capacity(self.routes.len()); + for route in self.routes.iter() { + routes.push( + route + .parse() + .with_context(|| format!("failed to parse route: {}", route))?, + ); + } + cfg.set_routes(Some(routes)); + } + + if !self.exit_nodes.is_empty() { + let mut exit_nodes = Vec::::with_capacity(self.exit_nodes.len()); + for node in self.exit_nodes.iter() { + exit_nodes.push( + node.parse() + .with_context(|| format!("failed to parse exit node: {}", node))?, + ); + } + cfg.set_exit_nodes(exit_nodes); + } + + if self.enable_socks5.unwrap_or_default() + && let Some(socks5_port) = self.socks5_port + { + cfg.set_socks5_portal(Some( + format!("socks5://0.0.0.0:{}", socks5_port).parse().unwrap(), + )); + } + + if !self.mapped_listeners.is_empty() { + let mapped_listeners = parse_mapped_listener_urls(&self.mapped_listeners)?; + cfg.set_mapped_listeners(Some(mapped_listeners)); + } + + if let Some(credential_file) = self + .credential_file + .as_ref() + .filter(|path| !path.is_empty()) + { + cfg.set_credential_file(Some(credential_file.into())); + } + + cfg.set_managed_credentials( + self.managed_credentials + .iter() + .map(managed_credential_from_proto) + .collect(), + ); + + if let Some(credential_secret) = credential_secret { + cfg.set_secure_mode(Some(normalize_secure_mode_config( + easytier_proto::common::SecureModeConfig { + enabled: true, + local_private_key: Some(credential_secret), + local_public_key: None, + }, + )?)); + } else { + cfg.set_secure_mode( + self.secure_mode + .clone() + .map(normalize_secure_mode_config) + .transpose()?, + ); + } + + let mut flags = gen_default_flags(); + if let Some(latency_first) = self.latency_first { + flags.latency_first = latency_first; + } + + if let Some(dev_name) = self.dev_name.clone() { + flags.dev_name = dev_name; + } + + if let Some(use_smoltcp) = self.use_smoltcp { + flags.use_smoltcp = use_smoltcp; + } + + if let Some(ipv6_public_addr_provider) = self.ipv6_public_addr_provider { + cfg.set_ipv6_public_addr_provider(ipv6_public_addr_provider); + } + + if let Some(ipv6_public_addr_auto) = self.ipv6_public_addr_auto { + cfg.set_ipv6_public_addr_auto(ipv6_public_addr_auto); + } + + if let Some(ipv6_public_addr_prefix) = self + .ipv6_public_addr_prefix + .as_ref() + .filter(|prefix| !prefix.is_empty()) + { + cfg.set_ipv6_public_addr_prefix(Some(ipv6_public_addr_prefix.parse().with_context( + || format!("failed to parse ipv6 public address prefix: {ipv6_public_addr_prefix}"), + )?)); + } + + if let Some(disable_ipv6) = self.disable_ipv6 { + flags.enable_ipv6 = !disable_ipv6; + } + + if let Some(enable_kcp_proxy) = self.enable_kcp_proxy { + flags.enable_kcp_proxy = enable_kcp_proxy; + } + + if let Some(disable_kcp_input) = self.disable_kcp_input { + flags.disable_kcp_input = disable_kcp_input; + } + + if let Some(enable_quic_proxy) = self.enable_quic_proxy { + flags.enable_quic_proxy = enable_quic_proxy; + } + + if let Some(disable_quic_input) = self.disable_quic_input { + flags.disable_quic_input = disable_quic_input; + } + + if let Some(disable_p2p) = self.disable_p2p { + flags.disable_p2p = disable_p2p; + } + + if let Some(p2p_only) = self.p2p_only { + flags.p2p_only = p2p_only; + } + + if let Some(lazy_p2p) = self.lazy_p2p { + flags.lazy_p2p = lazy_p2p; + } + + if let Some(bind_device) = self.bind_device { + flags.bind_device = bind_device; + } + + if self.socket_mark.is_some() { + flags.socket_mark = self.socket_mark; + } + + if let Some(no_tun) = self.no_tun { + flags.no_tun = no_tun; + } + + if let Some(enable_exit_node) = self.enable_exit_node { + flags.enable_exit_node = enable_exit_node; + } + + if let Some(relay_all_peer_rpc) = self.relay_all_peer_rpc { + flags.relay_all_peer_rpc = relay_all_peer_rpc; + } + + if let Some(need_p2p) = self.need_p2p { + flags.need_p2p = need_p2p; + } + + if let Some(multi_thread) = self.multi_thread { + flags.multi_thread = multi_thread; + } + + if let Some(proxy_forward_by_system) = self.proxy_forward_by_system { + flags.proxy_forward_by_system = proxy_forward_by_system; + } + + if let Some(disable_encryption) = self.disable_encryption { + flags.enable_encryption = !disable_encryption; + } + + if self.enable_relay_network_whitelist.unwrap_or_default() { + if !self.relay_network_whitelist.is_empty() { + flags.relay_network_whitelist = self.relay_network_whitelist.join(" "); + } else { + flags.relay_network_whitelist = "".to_string(); + } + } + + if let Some(disable_tcp_hole_punching) = self.disable_tcp_hole_punching { + flags.disable_tcp_hole_punching = disable_tcp_hole_punching; + } + + if let Some(disable_udp_hole_punching) = self.disable_udp_hole_punching { + flags.disable_udp_hole_punching = disable_udp_hole_punching; + } + + if let Some(disable_upnp) = self.disable_upnp { + flags.disable_upnp = disable_upnp; + } + + if let Some(disable_relay_data) = self.disable_relay_data { + flags.disable_relay_data = disable_relay_data; + } + + if let Some(prefer_peer_relay) = self.prefer_peer_relay { + flags.prefer_peer_relay = prefer_peer_relay; + } + + if let Some(enable_udp_broadcast_relay) = self.enable_udp_broadcast_relay { + flags.enable_udp_broadcast_relay = enable_udp_broadcast_relay; + } + + if let Some(disable_sym_hole_punching) = self.disable_sym_hole_punching { + flags.disable_sym_hole_punching = disable_sym_hole_punching; + } + + if let Some(enable_magic_dns) = self.enable_magic_dns { + flags.accept_dns = enable_magic_dns; + } + + if let Some(mtu) = self.mtu { + flags.mtu = mtu as u32; + } + + if let Some(instance_recv_bps_limit) = self.instance_recv_bps_limit { + flags.instance_recv_bps_limit = instance_recv_bps_limit; + } + + if let Some(enable_private_mode) = self.enable_private_mode { + flags.private_mode = enable_private_mode; + } + + if let Some(encryption_algorithm) = self.encryption_algorithm.clone() { + flags.encryption_algorithm = encryption_algorithm; + } + + if let Some(acl) = self.acl.as_ref() + && !acl.is_empty() + { + cfg.set_acl(Some(acl.clone())); + } + + if let Some(data_compress_algo) = self.data_compress_algo { + if data_compress_algo < 1 { + flags.data_compress_algo = 1; + } else { + flags.data_compress_algo = data_compress_algo + } + } + + cfg.set_flags(flags); + Ok(cfg) + } + + fn new_from_config(config: impl ConfigLoader) -> Result { + let default_config = TomlConfigLoader::default(); + + let mut result = Self { + ..Default::default() + }; + + result.instance_id = Some(config.get_id().to_string()); + if config.get_hostname() != default_config.get_hostname() { + result.hostname = Some(config.get_hostname()); + } + + result.dhcp = Some(config.get_dhcp()); + + let network_identity = config.get_network_identity(); + result.network_name = Some(network_identity.network_name.clone()); + result.network_secret = network_identity.network_secret; + + if let Some(ipv4) = config.get_ipv4() { + result.virtual_ipv4 = Some(ipv4.address().to_string()); + result.network_length = Some(ipv4.network_length() as i32); + } + + if config.get_ipv6_public_addr_provider() != default_config.get_ipv6_public_addr_provider() + { + result.ipv6_public_addr_provider = Some(config.get_ipv6_public_addr_provider()); + } + if config.get_ipv6_public_addr_auto() != default_config.get_ipv6_public_addr_auto() { + result.ipv6_public_addr_auto = Some(config.get_ipv6_public_addr_auto()); + } + result.ipv6_public_addr_prefix = config + .get_ipv6_public_addr_prefix() + .map(|prefix| prefix.to_string()); + + let peers = config.get_peers(); + result.networking_method = Some(NetworkingMethod::Manual as i32); + if !peers.is_empty() { + result.peer_urls = peers.iter().map(|p| p.uri.to_string()).collect(); + result.peers = peers + .iter() + .map(|p| manage::NetworkPeerConfig { + uri: p.uri.to_string(), + peer_public_key: p.peer_public_key.clone(), + }) + .collect(); + } + + result.listener_urls = config + .get_listeners() + .unwrap_or_default() + .iter() + .map(|l| l.to_string()) + .collect(); + + result.proxy_cidrs = config + .get_proxy_cidrs() + .iter() + .map(|c| { + if let Some(mapped) = c.mapped_cidr { + format!("{}->{}", c.cidr, mapped) + } else { + c.cidr.to_string() + } + }) + .collect(); + + let port_forwards = config.get_port_forwards(); + if !port_forwards.is_empty() { + result.port_forwards = port_forwards + .iter() + .map(|f| manage::PortForwardConfig { + proto: f.proto.clone(), + bind_ip: f.bind_addr.ip().to_string(), + bind_port: f.bind_addr.port() as u32, + dst_ip: f.dst_addr.ip().to_string(), + dst_port: f.dst_addr.port() as u32, + }) + .collect(); + } + + if let Some(vpn_config) = config.get_vpn_portal_config() { + result.vpn_portal_config = Some(manage::VpnPortalConfig { + enabled: vpn_config.enabled, + wireguard_listen: vpn_config.wireguard_listen.to_string(), + wireguard_private_key: vpn_config.wireguard_private_key, + clients: vpn_config + .clients + .into_iter() + .map(|client| manage::VpnPortalClientConfig { + name: client.name, + virtual_ip: client.virtual_ip.to_string(), + groups: client.groups, + }) + .collect(), + }); + } + + if let Some(routes) = config.get_routes() + && !routes.is_empty() + { + result.enable_manual_routes = Some(true); + result.routes = routes.iter().map(|r| r.to_string()).collect(); + } + + let exit_nodes = config.get_exit_nodes(); + if !exit_nodes.is_empty() { + result.exit_nodes = exit_nodes.iter().map(|n| n.to_string()).collect(); + } + + if let Some(socks5_portal) = config.get_socks5_portal() { + result.enable_socks5 = Some(true); + result.socks5_port = socks5_portal.port().map(|p| p as i32); + } + + let mapped_listeners = config.get_mapped_listeners(); + if !mapped_listeners.is_empty() { + result.mapped_listeners = mapped_listeners.iter().map(|l| l.to_string()).collect(); + } + + result.secure_mode = config.get_secure_mode(); + result.credential_file = config + .get_credential_file() + .map(|path| path.to_string_lossy().into_owned()); + result.managed_credentials = config + .get_managed_credentials() + .into_iter() + .map(managed_credential_to_proto) + .collect(); + let flags = config.get_flags(); + let default_flags = default_config.get_flags(); + result.latency_first = Some(flags.latency_first); + result.dev_name = Some(flags.dev_name.clone()); + result.use_smoltcp = Some(flags.use_smoltcp); + result.disable_ipv6 = Some(!flags.enable_ipv6); + result.enable_kcp_proxy = Some(flags.enable_kcp_proxy); + result.disable_kcp_input = Some(flags.disable_kcp_input); + result.enable_quic_proxy = Some(flags.enable_quic_proxy); + result.disable_quic_input = Some(flags.disable_quic_input); + result.disable_p2p = Some(flags.disable_p2p); + result.p2p_only = Some(flags.p2p_only); + result.lazy_p2p = Some(flags.lazy_p2p); + result.bind_device = Some(flags.bind_device); + result.socket_mark = flags.socket_mark; + result.no_tun = Some(flags.no_tun); + result.enable_exit_node = Some(flags.enable_exit_node); + result.relay_all_peer_rpc = Some(flags.relay_all_peer_rpc); + result.need_p2p = Some(flags.need_p2p); + result.multi_thread = Some(flags.multi_thread); + result.proxy_forward_by_system = Some(flags.proxy_forward_by_system); + result.disable_encryption = Some(!flags.enable_encryption); + result.disable_tcp_hole_punching = Some(flags.disable_tcp_hole_punching); + result.disable_udp_hole_punching = Some(flags.disable_udp_hole_punching); + result.disable_upnp = Some(flags.disable_upnp); + result.disable_relay_data = Some(flags.disable_relay_data); + result.prefer_peer_relay = Some(flags.prefer_peer_relay); + result.enable_udp_broadcast_relay = Some(flags.enable_udp_broadcast_relay); + result.disable_sym_hole_punching = Some(flags.disable_sym_hole_punching); + result.enable_magic_dns = Some(flags.accept_dns); + result.mtu = Some(flags.mtu as i32); + result.data_compress_algo = (flags.data_compress_algo != default_flags.data_compress_algo) + .then_some(flags.data_compress_algo); + result.encryption_algorithm = (flags.encryption_algorithm + != default_flags.encryption_algorithm) + .then_some(flags.encryption_algorithm.clone()); + result.instance_recv_bps_limit = + (flags.instance_recv_bps_limit != u64::MAX).then_some(flags.instance_recv_bps_limit); + result.enable_private_mode = Some(flags.private_mode); + + result.acl = config.get_acl(); + + if flags.relay_network_whitelist == "*" { + result.enable_relay_network_whitelist = Some(false); + } else { + result.enable_relay_network_whitelist = Some(true); + if flags.relay_network_whitelist.is_empty() { + result.relay_network_whitelist = vec![]; + } else { + result.relay_network_whitelist = flags + .relay_network_whitelist + .split_whitespace() + .map(|s| s.to_string()) + .collect(); + } + } + + Ok(result) + } +} + +#[cfg(test)] +mod tests { + #![allow(deprecated)] + + use super::*; + + fn api_portal_config() -> manage::VpnPortalConfig { + manage::VpnPortalConfig { + enabled: None, + wireguard_listen: "0.0.0.0:51820".to_owned(), + wireguard_private_key: Some("server-private-key".to_owned()), + clients: vec![manage::VpnPortalClientConfig { + name: "alice".to_owned(), + virtual_ip: "10.144.144.10/16".to_owned(), + groups: vec!["staff".to_owned()], + }], + } + } + + fn standalone_config() -> NetworkConfig { + NetworkConfig { + networking_method: Some(NetworkingMethod::Standalone as i32), + ..Default::default() + } + } + + #[test] + fn vpn_portal_api_config_round_trips_through_toml_model() { + let input = NetworkConfig { + vpn_portal_config: Some(api_portal_config()), + ..standalone_config() + }; + + let config = input.gen_config().unwrap(); + let portal = config.get_vpn_portal_config().unwrap(); + assert_eq!(portal.wireguard_listen, "0.0.0.0:51820".parse().unwrap()); + assert_eq!( + portal.wireguard_private_key.as_deref(), + Some("server-private-key") + ); + assert_eq!(portal.clients[0].name, "alice"); + assert_eq!(portal.clients[0].virtual_ip.to_string(), "10.144.144.10/16"); + assert_eq!(portal.clients[0].groups, vec!["staff".to_owned()]); + + let output = NetworkConfig::new_from_config(&config).unwrap(); + assert_eq!(output.vpn_portal_config, input.vpn_portal_config); + assert_eq!(output.enable_vpn_portal, None); + } + + #[test] + fn disabled_vpn_portal_preserves_clients_and_key_without_a_runtime() { + let mut portal = api_portal_config(); + portal.enabled = Some(false); + let input = NetworkConfig { + vpn_portal_config: Some(portal), + ..standalone_config() + }; + let config = input.gen_config().unwrap(); + let restored = crate::config::toml::TomlConfig::new_from_str(&config.dump()).unwrap(); + let output = NetworkConfig::new_from_config(&restored).unwrap(); + assert_eq!(output.vpn_portal_config, input.vpn_portal_config); + assert!( + crate::instance::CoreInstanceConfig::from_toml(&restored) + .unwrap() + .vpn_portal + .is_none() + ); + + let mut portal = restored.get_vpn_portal_config().unwrap(); + portal.enabled = Some(true); + restored.set_vpn_portal_config(portal); + let runtime = crate::instance::CoreInstanceConfig::from_toml(&restored).unwrap(); + assert_eq!(runtime.vpn_portal.unwrap().clients[0].name, "alice"); + } + + #[test] + fn managed_credentials_round_trip_through_toml_model() { + let input = NetworkConfig { + managed_credentials: vec![manage::ManagedCredentialConfig { + credential_id: "managed-a".to_owned(), + credential_secret: "secret".to_owned(), + groups: vec!["ops".to_owned()], + allow_relay: true, + allowed_proxy_cidrs: vec!["10.0.0.0/24".to_owned()], + expiry_unix: 2_000_000_000, + reusable: None, + }], + ..standalone_config() + }; + + let config = input.gen_config().unwrap(); + let output = NetworkConfig::new_from_config(&config).unwrap(); + assert_eq!(output.managed_credentials[0].credential_id, "managed-a"); + assert_eq!(output.managed_credentials[0].reusable, Some(true)); + } + + #[test] + fn peer_relay_preference_round_trips_independently() { + let input = NetworkConfig { + disable_relay_data: Some(false), + prefer_peer_relay: Some(true), + ..standalone_config() + }; + + let config = input.gen_config().unwrap(); + let flags = config.get_flags(); + assert!(!flags.disable_relay_data); + assert!(flags.prefer_peer_relay); + + let output = NetworkConfig::new_from_config(&config).unwrap(); + assert_eq!(output.disable_relay_data, Some(false)); + assert_eq!(output.prefer_peer_relay, Some(true)); + } + + #[test] + fn legacy_enabled_vpn_portal_config_reports_migration_error() { + let error = NetworkConfig { + enable_vpn_portal: Some(true), + ..standalone_config() + } + .gen_config() + .unwrap_err() + .to_string(); + + assert!(error.contains("legacy VPN portal"), "{error}"); + } + + #[test] + fn legacy_disabled_vpn_portal_defaults_are_ignored() { + let config = NetworkConfig { + enable_vpn_portal: Some(false), + vpn_portal_listen_port: Some(0), + vpn_portal_client_network_addr: Some(String::new()), + vpn_portal_client_network_len: Some(0), + ..standalone_config() + } + .gen_config() + .unwrap(); + + assert!(config.get_vpn_portal_config().is_none()); + } + + #[cfg(feature = "browser-config")] + #[test] + fn browser_merge_preserves_fields_outside_the_shared_form() { + let original = r#" +instance_name = "module-instance" +rpc_portal = "0.0.0.0:15888" +tcp_whitelist = ["22"] +stun_servers = ["custom.example.com:3478"] + +[network_identity] +network_name = "old-network" +network_secret = "secret" + +[flags] +default_protocol = "udp" +disable_p2p = true +"#; + let parsed = TomlConfigLoader::new_from_str(original).unwrap(); + let mut network_config = NetworkConfig::new_from_config(&parsed).unwrap(); + network_config.network_name = Some("edited-network".to_owned()); + network_config.disable_p2p = Some(false); + + let merged = merge_network_config_toml(original, &network_config).unwrap(); + let merged: toml::Table = toml::from_str(&merged).unwrap(); + + assert_eq!(merged["instance_name"].as_str(), Some("module-instance")); + assert_eq!(merged["rpc_portal"].as_str(), Some("0.0.0.0:15888")); + assert_eq!(merged["tcp_whitelist"][0].as_str(), Some("22")); + assert_eq!( + merged["stun_servers"][0].as_str(), + Some("custom.example.com:3478") + ); + assert_eq!( + merged["network_identity"]["network_name"].as_str(), + Some("edited-network") + ); + assert_eq!(merged["flags"]["default_protocol"].as_str(), Some("udp")); + assert!( + !merged["flags"] + .as_table() + .unwrap() + .contains_key("disable_p2p") + ); + } +} diff --git a/vendor/easytier/easytier-core/src/config/browser.rs b/vendor/easytier/easytier-core/src/config/browser.rs new file mode 100644 index 0000000..d73d611 --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/browser.rs @@ -0,0 +1,33 @@ +use wasm_bindgen::prelude::*; + +use super::{ + api_input::{NetworkConfig, NetworkConfigExt, merge_network_config_toml}, + toml::{ConfigLoader, TomlConfig}, +}; + +fn js_error(error: impl std::fmt::Debug) -> JsValue { + JsValue::from_str(&format!("{error:?}")) +} + +#[wasm_bindgen] +pub fn generate_config(config_json: &str) -> Result { + let config: NetworkConfig = serde_json::from_str(config_json).map_err(js_error)?; + config + .gen_config() + .map(|config| config.dump()) + .map_err(js_error) +} + +#[wasm_bindgen] +pub fn merge_config(original_toml: &str, config_json: &str) -> Result { + let config: NetworkConfig = serde_json::from_str(config_json).map_err(js_error)?; + merge_network_config_toml(original_toml, &config).map_err(js_error) +} + +#[wasm_bindgen] +pub fn parse_config(toml_config: &str) -> Result { + let config = TomlConfig::new_from_str(toml_config) + .and_then(|config| NetworkConfig::new_from_config(&config)) + .map_err(js_error)?; + serde_json::to_string(&config).map_err(js_error) +} diff --git a/vendor/easytier/easytier-core/src/config/encryption.rs b/vendor/easytier/easytier-core/src/config/encryption.rs new file mode 100644 index 0000000..f865a03 --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/encryption.rs @@ -0,0 +1,73 @@ +use std::{fmt, str::FromStr}; + +use strum::VariantArray; + +/// Stable configuration vocabulary for every known encryption algorithm. +#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, VariantArray)] +pub enum EncryptionAlgorithm { + Xor, + #[default] + AesGcm, + Aes256Gcm, + ChaCha20, +} + +impl EncryptionAlgorithm { + pub const fn as_str(self) -> &'static str { + match self { + Self::Xor => "xor", + Self::AesGcm => "aes-gcm", + Self::Aes256Gcm => "aes-256-gcm", + Self::ChaCha20 => "chacha20", + } + } +} + +impl fmt::Display for EncryptionAlgorithm { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter.write_str(self.as_str()) + } +} + +impl FromStr for EncryptionAlgorithm { + type Err = (); + + fn from_str(value: &str) -> Result { + match value.to_ascii_lowercase().as_str() { + "xor" => Ok(Self::Xor), + "aes-gcm" | "openssl-aes-gcm" => Ok(Self::AesGcm), + "aes-256-gcm" | "openssl-aes-256-gcm" => Ok(Self::Aes256Gcm), + "chacha20" | "chacha20-poly1305" | "openssl-chacha20" => Ok(Self::ChaCha20), + _ => Err(()), + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn known_algorithm_names_are_stable() { + let cases = [ + ("xor", EncryptionAlgorithm::Xor), + ("aes-gcm", EncryptionAlgorithm::AesGcm), + ("aes-256-gcm", EncryptionAlgorithm::Aes256Gcm), + ("chacha20", EncryptionAlgorithm::ChaCha20), + ("chacha20-poly1305", EncryptionAlgorithm::ChaCha20), + ("openssl-aes-gcm", EncryptionAlgorithm::AesGcm), + ("openssl-aes-256-gcm", EncryptionAlgorithm::Aes256Gcm), + ("openssl-chacha20", EncryptionAlgorithm::ChaCha20), + ]; + + for (name, expected) in cases { + assert_eq!(name.parse(), Ok(expected)); + } + assert_eq!(EncryptionAlgorithm::ChaCha20.to_string(), "chacha20"); + } + + #[test] + fn aes_is_the_stable_default() { + assert_eq!(EncryptionAlgorithm::default(), EncryptionAlgorithm::AesGcm); + } +} diff --git a/vendor/easytier/easytier-core/src/config/gateway.rs b/vendor/easytier/easytier-core/src/config/gateway.rs new file mode 100644 index 0000000..abaac4d --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/gateway.rs @@ -0,0 +1,138 @@ +use std::net::SocketAddr; + +use serde::{Deserialize, Serialize}; + +use easytier_proto::common::{PortForwardConfigPb, SocketType}; + +/// Runtime configuration for the core-owned SOCKS and port-forward gateway. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub struct GatewayRuntimeConfig { + pub socks5_bind: Option, + pub port_forwards: Vec, +} + +/// One TCP or UDP port-forward rule. +#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub struct PortForwardConfig { + pub bind_addr: SocketAddr, + pub dst_addr: SocketAddr, + pub proto: String, +} + +impl From for PortForwardConfig { + fn from(config: PortForwardConfigPb) -> Self { + Self { + bind_addr: config.bind_addr.unwrap_or_default().into(), + dst_addr: config.dst_addr.unwrap_or_default().into(), + proto: match SocketType::try_from(config.socket_type) { + Ok(SocketType::Tcp) => "tcp".to_string(), + Ok(SocketType::Udp) => "udp".to_string(), + _ => "tcp".to_string(), + }, + } + } +} + +impl From for PortForwardConfigPb { + fn from(config: PortForwardConfig) -> Self { + Self { + bind_addr: Some(config.bind_addr.into()), + dst_addr: Some(config.dst_addr.into()), + socket_type: match config.proto.to_lowercase().as_str() { + "tcp" => SocketType::Tcp as i32, + "udp" => SocketType::Udp as i32, + _ => SocketType::Tcp as i32, + }, + } + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct ProxyRuntimeConfig { + pub enable_exit_node: bool, + pub no_tun: bool, + pub forward_by_system: bool, + pub force_smoltcp: bool, + pub icmp_failure_is_fatal: bool, + pub udp_response_ipv4_mtu: usize, +} + +impl ProxyRuntimeConfig { + pub fn should_start(self, has_proxy_networks: bool) -> bool { + if !has_proxy_networks && !self.enable_exit_node && !self.no_tun { + return false; + } + + !self.forward_by_system || self.no_tun + } +} + +impl Default for ProxyRuntimeConfig { + fn default() -> Self { + Self { + enable_exit_node: false, + no_tun: false, + forward_by_system: false, + force_smoltcp: false, + icmp_failure_is_fatal: false, + udp_response_ipv4_mtu: 1280, + } + } +} + +#[cfg(test)] +mod tests { + use super::ProxyRuntimeConfig; + + #[test] + fn proxy_startup_policy_preserves_runtime_modes() { + assert!(!ProxyRuntimeConfig::default().should_start(false)); + assert!(ProxyRuntimeConfig::default().should_start(true)); + assert!( + ProxyRuntimeConfig { + enable_exit_node: true, + ..Default::default() + } + .should_start(false) + ); + assert!( + ProxyRuntimeConfig { + no_tun: true, + ..Default::default() + } + .should_start(false) + ); + } + + #[test] + fn proxy_startup_policy_preserves_system_forwarding_rules() { + assert!( + !ProxyRuntimeConfig { + forward_by_system: true, + ..Default::default() + } + .should_start(true) + ); + assert!( + !ProxyRuntimeConfig { + enable_exit_node: true, + forward_by_system: true, + ..Default::default() + } + .should_start(false) + ); + assert!( + ProxyRuntimeConfig { + no_tun: true, + forward_by_system: true, + ..Default::default() + } + .should_start(false) + ); + } + + #[test] + fn proxy_runtime_defaults_preserve_udp_mtu() { + assert_eq!(ProxyRuntimeConfig::default().udp_response_ipv4_mtu, 1280); + } +} diff --git a/vendor/easytier/easytier-core/src/config/mod.rs b/vendor/easytier/easytier-core/src/config/mod.rs new file mode 100644 index 0000000..4b3e39e --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/mod.rs @@ -0,0 +1,827 @@ +//! Static configuration schema plus the live runtime configuration store. + +#[cfg(feature = "web-client")] +pub mod api; +#[cfg(any(feature = "web-client", feature = "browser-config"))] +pub mod api_input; +#[cfg(all( + feature = "browser-config", + target_arch = "wasm32", + target_os = "unknown" +))] +mod browser; +mod encryption; +pub mod gateway; +pub mod peers; +pub mod runtime; +pub mod toml; + +pub use encryption::EncryptionAlgorithm; + +pub(crate) const DEFAULT_UDP_STUN_SERVERS: &[&str] = &[ + "txt:stun.easytier.cn", + "stun.miwifi.com", + "stun.chat.bilibili.com", + "stun.hitv.com", +]; +pub(crate) const DEFAULT_TCP_STUN_SERVERS: &[&str] = &[ + "stun.hot-chilli.net", + "stun.fitauto.ru", + "fwa.lifesizecloud.com", + "global.turn.twilio.com", + "turn.cloudflare.com", + "stun.voip.blackberry.com", + "stun.radiojar.com", +]; +pub(crate) const DEFAULT_UDP_V6_STUN_SERVERS: &[&str] = &["txt:stun-v6.easytier.cn"]; + +pub(crate) fn default_stun_servers(servers: &[&str]) -> Vec { + servers.iter().map(ToString::to_string).collect() +} + +use std::{ + collections::{BTreeSet, hash_map::DefaultHasher}, + hash::{Hash, Hasher}, + net::IpAddr, +}; + +use anyhow::Context as _; +use base64::{Engine as _, prelude::BASE64_STANDARD}; +use easytier_proto::{common as common_pb, core_config as pb}; +use serde::{Deserialize, Serialize}; +use url::Url; + +pub type PeerId = u32; + +pub type NetworkSecretDigest = [u8; 32]; + +/// Host capabilities used by the portable mapped-listener validation rule. +#[derive(Debug, Clone, Default, PartialEq, Eq)] +pub struct MappedListenerPolicy { + implicit_port_schemes: BTreeSet, +} + +impl MappedListenerPolicy { + pub fn new(implicit_port_schemes: I) -> Self + where + I: IntoIterator, + S: Into, + { + Self { + implicit_port_schemes: implicit_port_schemes + .into_iter() + .map(Into::into) + .map(|scheme: String| scheme.to_ascii_lowercase()) + .collect(), + } + } + + pub fn validate(&self, url: &Url) -> anyhow::Result<()> { + if url.port().is_none() && !self.implicit_port_schemes.contains(url.scheme()) { + anyhow::bail!("mapped listener port is missing: {}", url); + } + + Ok(()) + } + + pub fn parse_urls(&self, mapped_listeners: &[String]) -> anyhow::Result> { + mapped_listeners + .iter() + .map(|value| { + let url: Url = value + .parse() + .with_context(|| format!("mapped listener is not a valid url: {}", value))?; + self.validate(&url)?; + Ok(url) + }) + .collect() + } +} + +/// Completes and validates the portable secure-mode key configuration. +pub fn normalize_secure_mode_config( + mut config: common_pb::SecureModeConfig, +) -> anyhow::Result { + if !config.enabled { + return Ok(config); + } + + let private_key = if config.local_private_key.is_none() { + let private = x25519_dalek::StaticSecret::random_from_rng(rand::rngs::OsRng); + config.local_private_key = Some(BASE64_STANDARD.encode(private.as_bytes())); + private + } else { + config.private_key()? + }; + let generated_public_key = x25519_dalek::PublicKey::from(&private_key); + let generated_public_key = BASE64_STANDARD.encode(generated_public_key.as_bytes()); + + match config.local_public_key.as_ref() { + None => config.local_public_key = Some(generated_public_key), + Some(configured_public_key) => { + config.public_key()?; + if configured_public_key != &generated_public_key { + anyhow::bail!( + "local public key {} does not match generated public key {}", + configured_public_key, + generated_public_key + ); + } + } + } + + Ok(config) +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct NetworkIdentity { + pub network_name: String, + pub network_secret: Option, + pub network_secret_digest: Option, +} + +impl NetworkIdentity { + pub fn new(network_name: String, network_secret: String) -> Self { + Self { + network_secret_digest: Some(network_secret_digest(&network_name, &network_secret)), + network_name, + network_secret: Some(network_secret), + } + } + + pub fn new_credential(network_name: String) -> Self { + Self { + network_name, + network_secret: None, + network_secret_digest: None, + } + } + + pub fn secret_digest(&self) -> Option { + if self.network_secret_digest.is_some() { + self.network_secret_digest + } else if let Some(network_secret) = &self.network_secret { + let mut network_secret_digest = [0u8; 32]; + generate_digest_from_str( + &self.network_name, + network_secret, + &mut network_secret_digest, + ); + Some(network_secret_digest) + } else { + None + } + } + + pub fn with_secret_digest(mut self) -> Self { + self.network_secret_digest = self.secret_digest(); + self + } +} + +#[derive(Eq, PartialEq, Hash)] +struct NetworkIdentityWithOnlyDigest { + network_name: String, + network_secret_digest: Option, +} + +fn generate_digest_from_str(str1: &str, str2: &str, digest: &mut [u8]) { + let mut hasher = DefaultHasher::new(); + hasher.write(str1.as_bytes()); + hasher.write(str2.as_bytes()); + + assert_eq!(digest.len() % 8, 0, "digest length must be multiple of 8"); + + let shard_count = digest.len() / 8; + for i in 0..shard_count { + digest[i * 8..(i + 1) * 8].copy_from_slice(&hasher.finish().to_be_bytes()); + hasher.write(&digest[..(i + 1) * 8]); + } +} + +fn network_secret_digest(network_name: &str, network_secret: &str) -> NetworkSecretDigest { + let mut digest = [0u8; 32]; + generate_digest_from_str(network_name, network_secret, &mut digest); + digest +} + +impl From for NetworkIdentityWithOnlyDigest { + fn from(identity: NetworkIdentity) -> Self { + Self { + network_secret_digest: identity.secret_digest(), + network_name: identity.network_name, + } + } +} + +impl PartialEq for NetworkIdentity { + fn eq(&self, other: &Self) -> bool { + let self_with_digest = NetworkIdentityWithOnlyDigest::from(self.clone()); + let other_with_digest = NetworkIdentityWithOnlyDigest::from(other.clone()); + self_with_digest == other_with_digest + } +} + +impl Eq for NetworkIdentity {} + +impl Hash for NetworkIdentity { + fn hash(&self, state: &mut H) { + let self_with_digest = NetworkIdentityWithOnlyDigest::from(self.clone()); + self_with_digest.hash(state); + } +} + +impl Default for NetworkIdentity { + fn default() -> Self { + Self::new("default".to_string(), "".to_string()) + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)] +pub struct CoreConfig { + pub node: NodeConfig, + pub routes: RouteConfig, + pub peer_policy: PeerPolicyConfig, + pub traffic: TrafficConfig, +} + +#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)] +pub struct NodeConfig { + pub peer_id: Option, + pub instance_id: Option<[u8; 16]>, + pub hostname: Option, + pub network_name: String, +} + +#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)] +pub struct RouteConfig { + pub ipv4: Option, + pub ipv6: Option, + pub advertised_routes: Vec, + pub proxy_networks: Vec, + pub foreign_networks: Vec, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct IpPrefix { + pub address: IpAddr, + pub prefix_len: u8, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct ProxyNetworkConfig { + pub real: IpPrefix, + pub mapped: Option, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct ForeignNetworkConfig { + pub name: String, + pub cidrs: Vec, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct PeerPolicyConfig { + pub p2p_enabled: bool, + pub relay_peer_rpc: bool, + pub relay_data: bool, + pub latency_first: bool, + pub encryption_required: bool, +} + +impl Default for PeerPolicyConfig { + fn default() -> Self { + Self { + p2p_enabled: true, + relay_peer_rpc: false, + relay_data: true, + latency_first: false, + encryption_required: true, + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)] +pub struct P2pPolicyFlags { + pub disable_udp_hole_punching: bool, + pub disable_sym_hole_punching: bool, + pub disable_upnp: bool, + pub lazy_p2p: bool, + pub disable_p2p: bool, + pub need_p2p: bool, +} + +#[derive(Debug, Clone, PartialEq, Eq, Default, Serialize, Deserialize)] +pub struct TrafficConfig { + pub mtu: Option, + pub instance_recv_bps_limit: Option, + pub foreign_relay_bps_limit: Option, +} + +#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)] +pub enum ConfigError { + #[error("missing required field: {0}")] + MissingField(&'static str), + #[error("invalid IPv4 prefix length: {0}")] + InvalidIpv4Prefix(u8), + #[error("invalid IPv6 prefix length: {0}")] + InvalidIpv6Prefix(u8), + #[error("invalid MTU: {0}")] + InvalidMtu(u32), +} + +impl IpPrefix { + pub fn new(address: IpAddr, prefix_len: u8) -> Result { + match address { + IpAddr::V4(_) if prefix_len <= 32 => Ok(Self { + address, + prefix_len, + }), + IpAddr::V4(_) => Err(ConfigError::InvalidIpv4Prefix(prefix_len)), + IpAddr::V6(_) if prefix_len <= 128 => Ok(Self { + address, + prefix_len, + }), + IpAddr::V6(_) => Err(ConfigError::InvalidIpv6Prefix(prefix_len)), + } + } +} + +impl TryFrom for CoreConfig { + type Error = ConfigError; + + fn try_from(value: pb::CoreConfig) -> Result { + Ok(Self { + node: value + .node + .map(TryInto::try_into) + .transpose()? + .unwrap_or_default(), + routes: value + .routes + .map(TryInto::try_into) + .transpose()? + .unwrap_or_default(), + peer_policy: value.peer_policy.map(Into::into).unwrap_or_default(), + traffic: value + .traffic + .map(TryInto::try_into) + .transpose()? + .unwrap_or_default(), + }) + } +} + +impl From for pb::CoreConfig { + fn from(value: CoreConfig) -> Self { + Self { + node: Some(value.node.into()), + routes: Some(value.routes.into()), + peer_policy: Some(value.peer_policy.into()), + traffic: Some(value.traffic.into()), + } + } +} + +impl TryFrom for NodeConfig { + type Error = ConfigError; + + fn try_from(value: pb::NodeConfig) -> Result { + Ok(Self { + peer_id: value.peer_id, + instance_id: value.instance_id.map(uuid_to_bytes), + hostname: value.hostname, + network_name: value.network_name, + }) + } +} + +impl From for pb::NodeConfig { + fn from(value: NodeConfig) -> Self { + Self { + peer_id: value.peer_id, + instance_id: value.instance_id.map(uuid_from_bytes), + hostname: value.hostname, + network_name: value.network_name, + } + } +} + +impl TryFrom for RouteConfig { + type Error = ConfigError; + + fn try_from(value: pb::RouteConfig) -> Result { + Ok(Self { + ipv4: value.ipv4.map(TryInto::try_into).transpose()?, + ipv6: value.ipv6.map(TryInto::try_into).transpose()?, + advertised_routes: value + .advertised_routes + .into_iter() + .map(TryInto::try_into) + .collect::>()?, + proxy_networks: value + .proxy_networks + .into_iter() + .map(TryInto::try_into) + .collect::>()?, + foreign_networks: value + .foreign_networks + .into_iter() + .map(TryInto::try_into) + .collect::>()?, + }) + } +} + +impl From for pb::RouteConfig { + fn from(value: RouteConfig) -> Self { + Self { + ipv4: value.ipv4.map(Into::into), + ipv6: value.ipv6.map(Into::into), + advertised_routes: value + .advertised_routes + .into_iter() + .map(Into::into) + .collect(), + proxy_networks: value.proxy_networks.into_iter().map(Into::into).collect(), + foreign_networks: value.foreign_networks.into_iter().map(Into::into).collect(), + } + } +} + +impl TryFrom for IpPrefix { + type Error = ConfigError; + + fn try_from(value: pb::IpPrefix) -> Result { + let address = pb_ip_addr_to_std( + value + .address + .ok_or(ConfigError::MissingField("IpPrefix.address"))?, + )?; + let prefix_len = u8::try_from(value.prefix_len) + .map_err(|_| invalid_prefix_for_address(address, value.prefix_len))?; + Self::new(address, prefix_len) + } +} + +impl From for pb::IpPrefix { + fn from(value: IpPrefix) -> Self { + Self { + address: Some(value.address.into()), + prefix_len: value.prefix_len.into(), + } + } +} + +impl TryFrom for ProxyNetworkConfig { + type Error = ConfigError; + + fn try_from(value: pb::ProxyNetworkConfig) -> Result { + Ok(Self { + real: value + .real + .ok_or(ConfigError::MissingField("ProxyNetworkConfig.real"))? + .try_into()?, + mapped: value.mapped.map(TryInto::try_into).transpose()?, + }) + } +} + +impl From for pb::ProxyNetworkConfig { + fn from(value: ProxyNetworkConfig) -> Self { + Self { + real: Some(value.real.into()), + mapped: value.mapped.map(Into::into), + } + } +} + +impl TryFrom for ForeignNetworkConfig { + type Error = ConfigError; + + fn try_from(value: pb::ForeignNetworkConfig) -> Result { + Ok(Self { + name: value.name, + cidrs: value + .cidrs + .into_iter() + .map(TryInto::try_into) + .collect::>()?, + }) + } +} + +impl From for pb::ForeignNetworkConfig { + fn from(value: ForeignNetworkConfig) -> Self { + Self { + name: value.name, + cidrs: value.cidrs.into_iter().map(Into::into).collect(), + } + } +} + +impl From for PeerPolicyConfig { + fn from(value: pb::PeerPolicyConfig) -> Self { + let default = Self::default(); + Self { + p2p_enabled: value.p2p_enabled.unwrap_or(default.p2p_enabled), + relay_peer_rpc: value.relay_peer_rpc.unwrap_or(default.relay_peer_rpc), + relay_data: value.relay_data.unwrap_or(default.relay_data), + latency_first: value.latency_first.unwrap_or(default.latency_first), + encryption_required: value + .encryption_required + .unwrap_or(default.encryption_required), + } + } +} + +impl From for pb::PeerPolicyConfig { + fn from(value: PeerPolicyConfig) -> Self { + Self { + p2p_enabled: Some(value.p2p_enabled), + relay_peer_rpc: Some(value.relay_peer_rpc), + relay_data: Some(value.relay_data), + latency_first: Some(value.latency_first), + encryption_required: Some(value.encryption_required), + } + } +} + +impl TryFrom for TrafficConfig { + type Error = ConfigError; + + fn try_from(value: pb::TrafficConfig) -> Result { + Ok(Self { + mtu: value + .mtu + .map(|mtu| u16::try_from(mtu).map_err(|_| ConfigError::InvalidMtu(mtu))) + .transpose()?, + instance_recv_bps_limit: value.instance_recv_bps_limit, + foreign_relay_bps_limit: value.foreign_relay_bps_limit, + }) + } +} + +impl From for pb::TrafficConfig { + fn from(value: TrafficConfig) -> Self { + Self { + mtu: value.mtu.map(Into::into), + instance_recv_bps_limit: value.instance_recv_bps_limit, + foreign_relay_bps_limit: value.foreign_relay_bps_limit, + } + } +} + +fn pb_ip_addr_to_std(value: common_pb::IpAddr) -> Result { + match value.ip.ok_or(ConfigError::MissingField("IpAddr.ip"))? { + common_pb::ip_addr::Ip::Ipv4(addr) => Ok(IpAddr::V4(addr.into())), + common_pb::ip_addr::Ip::Ipv6(addr) => Ok(IpAddr::V6(addr.into())), + } +} + +fn invalid_prefix_for_address(address: IpAddr, prefix_len: u32) -> ConfigError { + let prefix_len = u8::try_from(prefix_len).unwrap_or(u8::MAX); + match address { + IpAddr::V4(_) => ConfigError::InvalidIpv4Prefix(prefix_len), + IpAddr::V6(_) => ConfigError::InvalidIpv6Prefix(prefix_len), + } +} + +fn uuid_to_bytes(value: common_pb::Uuid) -> [u8; 16] { + let mut bytes = [0; 16]; + bytes[0..4].copy_from_slice(&value.part1.to_be_bytes()); + bytes[4..8].copy_from_slice(&value.part2.to_be_bytes()); + bytes[8..12].copy_from_slice(&value.part3.to_be_bytes()); + bytes[12..16].copy_from_slice(&value.part4.to_be_bytes()); + bytes +} + +fn uuid_from_bytes(bytes: [u8; 16]) -> common_pb::Uuid { + common_pb::Uuid { + part1: u32::from_be_bytes([bytes[0], bytes[1], bytes[2], bytes[3]]), + part2: u32::from_be_bytes([bytes[4], bytes[5], bytes[6], bytes[7]]), + part3: u32::from_be_bytes([bytes[8], bytes[9], bytes[10], bytes[11]]), + part4: u32::from_be_bytes([bytes[12], bytes[13], bytes[14], bytes[15]]), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use base64::prelude::BASE64_STANDARD; + use x25519_dalek::{PublicKey, StaticSecret}; + + fn digest(network_name: &str, network_secret: &str) -> NetworkSecretDigest { + let mut digest = [0u8; 32]; + generate_digest_from_str(network_name, network_secret, &mut digest); + digest + } + + #[test] + fn network_identity_matches_secret_to_digest_identity() { + let local = NetworkIdentity { + network_name: "net".to_string(), + network_secret: Some("secret".to_string()), + network_secret_digest: None, + }; + let remote = NetworkIdentity { + network_name: "net".to_string(), + network_secret: None, + network_secret_digest: Some(digest("net", "secret")), + }; + + assert_eq!(local, remote); + } + + #[test] + fn network_identity_rejects_different_digest() { + let local = NetworkIdentity { + network_name: "net".to_string(), + network_secret: Some("secret".to_string()), + network_secret_digest: None, + }; + let remote = NetworkIdentity { + network_name: "net".to_string(), + network_secret: None, + network_secret_digest: Some(digest("net", "other")), + }; + + assert_ne!(local, remote); + } + + #[test] + fn network_identity_equal_values_have_equal_hash() { + let local = NetworkIdentity { + network_name: "net".to_string(), + network_secret: Some("secret".to_string()), + network_secret_digest: None, + }; + let remote = NetworkIdentity { + network_name: "net".to_string(), + network_secret: None, + network_secret_digest: Some(digest("net", "secret")), + }; + let mut local_hasher = DefaultHasher::new(); + let mut remote_hasher = DefaultHasher::new(); + + local.hash(&mut local_hasher); + remote.hash(&mut remote_hasher); + + assert_eq!(local_hasher.finish(), remote_hasher.finish()); + } + + #[test] + fn network_identity_derives_digest_from_plaintext_secret() { + let identity = NetworkIdentity { + network_name: "net".to_string(), + network_secret: Some("secret".to_string()), + network_secret_digest: None, + }; + + assert_eq!(identity.secret_digest(), Some(digest("net", "secret"))); + } + + #[test] + fn network_identity_default_matches_native_default_network() { + assert_eq!( + NetworkIdentity::default(), + NetworkIdentity::new("default".to_string(), "".to_string()) + ); + } + + #[test] + fn mapped_listener_policy_uses_explicit_host_capabilities() { + let policy = MappedListenerPolicy::new(["tcp", "ws", "wss"]); + let parsed = policy + .parse_urls(&[ + "tcp://127.0.0.1".to_string(), + "ws://example.com".to_string(), + "wss://example.com/path".to_string(), + "ring://peer-id:1000".to_string(), + ]) + .unwrap(); + + assert_eq!(parsed.len(), 4); + assert_eq!(parsed[0].scheme(), "tcp"); + assert_eq!(parsed[1].scheme(), "ws"); + assert_eq!(parsed[2].scheme(), "wss"); + assert_eq!(parsed[3].port(), Some(1000)); + + let error = policy + .parse_urls(&["ring://peer-id".to_string()]) + .unwrap_err(); + assert!( + error + .to_string() + .contains("mapped listener port is missing") + ); + } + + #[test] + fn secure_mode_normalization_generates_missing_key_pair() { + let normalized = normalize_secure_mode_config(common_pb::SecureModeConfig { + enabled: true, + local_private_key: None, + local_public_key: None, + }) + .unwrap(); + + let private_key = normalized.private_key().unwrap(); + let public_key = normalized.public_key().unwrap(); + assert_eq!(public_key, PublicKey::from(&private_key)); + } + + #[test] + fn secure_mode_normalization_preserves_existing_key_configuration() { + let private_key = StaticSecret::from([7; 32]); + let public_key = PublicKey::from(&private_key); + let config = common_pb::SecureModeConfig { + enabled: true, + local_private_key: Some(BASE64_STANDARD.encode(private_key.as_bytes())), + local_public_key: Some(BASE64_STANDARD.encode(public_key.as_bytes())), + }; + + assert_eq!( + normalize_secure_mode_config(config.clone()).unwrap(), + config + ); + } + + #[test] + fn secure_mode_normalization_rejects_mismatched_public_key() { + let private_key = StaticSecret::from([7; 32]); + let other_public_key = PublicKey::from(&StaticSecret::from([9; 32])); + let error = normalize_secure_mode_config(common_pb::SecureModeConfig { + enabled: true, + local_private_key: Some(BASE64_STANDARD.encode(private_key.as_bytes())), + local_public_key: Some(BASE64_STANDARD.encode(other_public_key.as_bytes())), + }) + .unwrap_err() + .to_string(); + + assert!( + error.contains("does not match generated public key"), + "{error}" + ); + } + + #[test] + fn disabled_secure_mode_does_not_validate_keys() { + let config = common_pb::SecureModeConfig { + enabled: false, + local_private_key: Some("not-base64".to_string()), + local_public_key: Some("not-base64".to_string()), + }; + + assert_eq!( + normalize_secure_mode_config(config.clone()).unwrap(), + config + ); + } + + #[test] + fn validates_ip_prefix_lengths() { + assert!(IpPrefix::new("10.0.0.1".parse().unwrap(), 24).is_ok()); + assert_eq!( + IpPrefix::new("10.0.0.1".parse().unwrap(), 33), + Err(ConfigError::InvalidIpv4Prefix(33)) + ); + assert!(IpPrefix::new("2001:db8::1".parse().unwrap(), 64).is_ok()); + assert_eq!( + IpPrefix::new("2001:db8::1".parse().unwrap(), 129), + Err(ConfigError::InvalidIpv6Prefix(129)) + ); + } + + #[test] + fn converts_core_config_from_proto_defaults() { + let config = CoreConfig::try_from(pb::CoreConfig { + node: Some(pb::NodeConfig { + peer_id: Some(7), + instance_id: None, + hostname: Some("node-a".to_string()), + network_name: "net".to_string(), + }), + routes: None, + peer_policy: None, + traffic: Some(pb::TrafficConfig { + mtu: Some(1380), + instance_recv_bps_limit: Some(100), + foreign_relay_bps_limit: None, + }), + }) + .unwrap(); + + assert_eq!(config.node.peer_id, Some(7)); + assert_eq!(config.node.hostname.as_deref(), Some("node-a")); + assert!(config.peer_policy.p2p_enabled); + assert_eq!(config.traffic.mtu, Some(1380)); + } + + #[test] + fn converts_ip_prefix_round_trip() { + let prefix = IpPrefix::new("10.1.0.1".parse().unwrap(), 16).unwrap(); + let pb: pb::IpPrefix = prefix.clone().into(); + assert_eq!(IpPrefix::try_from(pb).unwrap(), prefix); + } +} diff --git a/vendor/easytier/easytier-core/src/config/peers.rs b/vendor/easytier/easytier-core/src/config/peers.rs new file mode 100644 index 0000000..ee40002 --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/peers.rs @@ -0,0 +1,359 @@ +//! Peer-flavored configuration data owned by the config layer. +//! +//! These types are pure serializable configuration snapshots. Normalization +//! and derivation behavior that depends on peer-domain logic stays in +//! `crate::peers`. + +use anyhow::Context as _; +use cidr::Ipv6Cidr; +use easytier_proto::common::{FlagsInConfig, PeerFeatureFlag, SecureModeConfig, StunInfo}; +use serde::{Deserialize, Serialize}; + +use crate::proto::acl::{Acl, AclV1, Action, Chain, ChainType, GroupInfo, Protocol, Rule}; + +use super::{CoreConfig, NetworkIdentity}; + +#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)] +pub struct AclRuleConfig { + pub acl: Option, + pub tcp_whitelist: Vec, + pub udp_whitelist: Vec, + pub whitelist_priority: Option, +} + +#[derive(Debug, Clone, Default, PartialEq, Eq)] +pub struct AclWhitelistSnapshot { + pub tcp_ports: Vec, + pub udp_ports: Vec, +} + +impl From<&AclRuleConfig> for AclWhitelistSnapshot { + fn from(config: &AclRuleConfig) -> Self { + Self { + tcp_ports: config.tcp_whitelist.clone(), + udp_ports: config.udp_whitelist.clone(), + } + } +} + +impl AclRuleConfig { + fn parse_port_list(port_list: &[String]) -> anyhow::Result> { + let mut ports = Vec::new(); + + for port_spec in port_list { + if port_spec.contains('-') { + let parts: Vec<&str> = port_spec.split('-').collect(); + if parts.len() != 2 { + return Err(anyhow::anyhow!("Invalid port range format: {}", port_spec)); + } + + let start: u16 = parts[0] + .parse() + .with_context(|| format!("Invalid start port in range: {}", port_spec))?; + let end: u16 = parts[1] + .parse() + .with_context(|| format!("Invalid end port in range: {}", port_spec))?; + + if start > end { + return Err(anyhow::anyhow!( + "Start port must be <= end port in range: {}", + port_spec + )); + } + ports.push(port_spec.clone()); + } else { + let port: u16 = port_spec + .parse() + .with_context(|| format!("Invalid port number: {}", port_spec))?; + ports.push(port.to_string()); + } + } + + Ok(ports) + } + + fn generate_acl_from_whitelists(&mut self) -> anyhow::Result<()> { + if self.tcp_whitelist.is_empty() && self.udp_whitelist.is_empty() { + return Ok(()); + } + + let mut inbound_chain = Chain { + name: "inbound_whitelist".to_string(), + chain_type: ChainType::Inbound as i32, + description: "Auto-generated inbound whitelist from CLI".to_string(), + enabled: true, + rules: vec![], + default_action: Action::Allow as i32, + }; + + let mut rule_priority = self.whitelist_priority.unwrap_or(1000u32); + + if !self.tcp_whitelist.is_empty() { + let tcp_ports = Self::parse_port_list(&self.tcp_whitelist)?; + inbound_chain.rules.push(Rule { + name: "tcp_whitelist".to_string(), + description: "Auto-generated TCP whitelist rule".to_string(), + priority: rule_priority, + enabled: true, + protocol: Protocol::Tcp as i32, + ports: tcp_ports, + source_ips: vec![], + destination_ips: vec![], + source_ports: vec![], + action: Action::Allow as i32, + rate_limit: 0, + burst_limit: 0, + stateful: true, + source_groups: vec![], + destination_groups: vec![], + }); + inbound_chain.rules.push(Rule { + name: "tcp_whitelist_deny_other".to_string(), + description: "Auto-generated TCP whitelist rule to deny other ports".to_string(), + priority: 0, + enabled: true, + protocol: Protocol::Tcp as i32, + ports: vec!["0-65535".to_string()], + source_ips: vec![], + destination_ips: vec![], + source_ports: vec![], + action: Action::Drop as i32, + rate_limit: 0, + burst_limit: 0, + stateful: false, + source_groups: vec![], + destination_groups: vec![], + }); + rule_priority -= 1; + } + + if !self.udp_whitelist.is_empty() { + let udp_ports = Self::parse_port_list(&self.udp_whitelist)?; + inbound_chain.rules.push(Rule { + name: "udp_whitelist".to_string(), + description: "Auto-generated UDP whitelist rule".to_string(), + priority: rule_priority, + enabled: true, + protocol: Protocol::Udp as i32, + ports: udp_ports, + source_ips: vec![], + destination_ips: vec![], + source_ports: vec![], + action: Action::Allow as i32, + rate_limit: 0, + burst_limit: 0, + stateful: false, + source_groups: vec![], + destination_groups: vec![], + }); + inbound_chain.rules.push(Rule { + name: "udp_whitelist_deny_other".to_string(), + description: "Auto-generated UDP whitelist rule to deny other ports".to_string(), + priority: 0, + enabled: true, + protocol: Protocol::Udp as i32, + ports: vec!["0-65535".to_string()], + source_ips: vec![], + destination_ips: vec![], + source_ports: vec![], + action: Action::Drop as i32, + rate_limit: 0, + burst_limit: 0, + stateful: false, + source_groups: vec![], + destination_groups: vec![], + }); + } + + if self.acl.is_none() { + self.acl = Some(Acl::default()); + } + + let acl = self.acl.as_mut().expect("ACL was initialized above"); + if let Some(acl_v1) = acl.acl_v1.as_mut() { + acl_v1.chains.push(inbound_chain); + } else { + acl.acl_v1 = Some(AclV1 { + chains: vec![inbound_chain], + group: Some(GroupInfo { + declares: vec![], + members: vec![], + }), + }); + } + + Ok(()) + } + + pub(crate) fn for_credential_peer(&self) -> Self { + let mut config = self.clone(); + if let Some(acl) = config.acl.as_mut().and_then(|acl| acl.acl_v1.as_mut()) { + acl.group = None; + } + config + } + + pub fn build(&self) -> anyhow::Result> { + let mut config = self.clone(); + config.generate_acl_from_whitelists()?; + Ok(config.acl) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +pub struct PublicIpv6ProviderConfig { + pub provider_enabled: bool, + pub configured_prefix: Option, + pub provider_supported: bool, +} + +impl PublicIpv6ProviderConfig { + pub fn should_run_reconcile(self) -> bool { + self.provider_enabled + } +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct PeerRuntimeConfig { + pub core: CoreConfig, + pub network_identity: NetworkIdentity, + pub stun_info: StunInfo, + pub feature_flags: PeerFeatureFlag, + pub secure_mode: Option, + pub host_routing: HostRoutingPolicy, +} + +#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)] +pub struct HostRoutingPolicy { + /// Route otherwise-unreachable external IPv4 traffic through this node and + /// keep self-delivered packets eligible for the host TUN/proxy path. + pub local_exit_node_fallback: bool, +} + +/// One normalized peer configuration version submitted by a host. +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct PeerRuntimeSnapshot { + pub runtime: PeerRuntimeConfig, + pub easytier_version: String, + pub avoid_relay_data_preference: bool, + pub flags: FlagsInConfig, + pub pinned_peers: Vec<(url::Url, Option)>, + pub peer_group_memberships: Vec, + pub acl_group_declarations: Vec, + pub ospf_update_my_foreign_network_interval_sec: u64, + pub max_direct_conns_per_peer_in_foreign_network: usize, + pub hmac_secret_digest: bool, +} + +impl PeerRuntimeSnapshot { + pub fn new(runtime: PeerRuntimeConfig, flags: FlagsInConfig) -> Self { + let avoid_relay_data_preference = runtime.feature_flags.avoid_relay_data; + Self { + runtime, + easytier_version: env!("CARGO_PKG_VERSION").to_owned(), + avoid_relay_data_preference, + flags, + pinned_peers: Vec::new(), + peer_group_memberships: Vec::new(), + acl_group_declarations: Vec::new(), + ospf_update_my_foreign_network_interval_sec: 10, + max_direct_conns_per_peer_in_foreign_network: 3, + hmac_secret_digest: false, + } + } +} + +impl Default for PeerRuntimeSnapshot { + fn default() -> Self { + Self::new( + PeerRuntimeConfig { + core: CoreConfig::default(), + network_identity: NetworkIdentity::default(), + stun_info: StunInfo::default(), + feature_flags: PeerFeatureFlag::default(), + secure_mode: None, + host_routing: HostRoutingPolicy::default(), + }, + FlagsInConfig::default(), + ) + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct PeerGroupIdentity { + pub group_name: String, + pub group_secret: String, +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn whitelist_rules_are_built_in_core() { + let acl = AclRuleConfig { + tcp_whitelist: vec!["80".to_string(), "8000-9000".to_string()], + udp_whitelist: vec!["53".to_string()], + ..Default::default() + } + .build() + .unwrap() + .unwrap(); + + let chain = &acl.acl_v1.unwrap().chains[0]; + assert_eq!(chain.name, "inbound_whitelist"); + assert_eq!(chain.rules.len(), 4); + assert_eq!(chain.rules[0].ports, ["80", "8000-9000"]); + assert_eq!(chain.rules[2].ports, ["53"]); + } + + #[test] + fn invalid_whitelist_range_is_rejected() { + let error = AclRuleConfig { + tcp_whitelist: vec!["9000-8000".to_string()], + ..Default::default() + } + .build() + .unwrap_err(); + + assert!(error.to_string().contains("Start port must be <= end port")); + } + + #[test] + fn credential_peer_acl_preserves_chains_without_group_secrets() { + let config = AclRuleConfig { + acl: Some(Acl { + acl_v1: Some(AclV1 { + chains: vec![Chain { + name: "forward".to_owned(), + chain_type: ChainType::Forward as i32, + rules: vec![Rule { + action: Action::Drop as i32, + ..Default::default() + }], + ..Default::default() + }], + group: Some(GroupInfo { + declares: vec![crate::proto::acl::GroupIdentity { + group_name: "ops".to_owned(), + group_secret: "secret".to_owned(), + }], + members: vec!["ops".to_owned()], + }), + }), + }), + tcp_whitelist: vec!["22".to_owned()], + ..Default::default() + }; + + let sanitized = config.for_credential_peer(); + + let acl = sanitized.acl.unwrap().acl_v1.unwrap(); + assert_eq!(acl.chains.len(), 1); + assert_eq!(acl.chains[0].name, "forward"); + assert_eq!(acl.chains[0].rules[0].action, Action::Drop as i32); + assert!(acl.group.is_none()); + assert_eq!(sanitized.tcp_whitelist, ["22"]); + assert!(config.acl.unwrap().acl_v1.unwrap().group.is_some()); + } +} diff --git a/vendor/easytier/easytier-core/src/config/runtime.rs b/vendor/easytier/easytier-core/src/config/runtime.rs new file mode 100644 index 0000000..d7b5cf6 --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/runtime.rs @@ -0,0 +1,284 @@ +//! Atomic runtime configuration owned by one core instance. + +use std::{collections::BTreeSet, sync::Arc}; + +use arc_swap::ArcSwap; +use cidr::Ipv4Cidr; +use parking_lot::Mutex; +use serde::{Deserialize, Serialize}; + +use super::{ + gateway::{GatewayRuntimeConfig, ProxyRuntimeConfig}, + peers::{AclRuleConfig, PeerRuntimeSnapshot, PublicIpv6ProviderConfig}, +}; + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct CoreRuntimeConfig { + pub acl: AclRuleConfig, + pub dhcp_ipv4: bool, + pub gateway: GatewayRuntimeConfig, + #[serde(default, skip_serializing_if = "Option::is_none")] + pub manual_routes: Option>, + pub proxy: ProxyRuntimeConfig, + #[serde(default)] + pub public_ipv6_auto: bool, + pub public_ipv6_provider: PublicIpv6ProviderConfig, +} + +impl Default for CoreRuntimeConfig { + fn default() -> Self { + Self { + acl: AclRuleConfig::default(), + dhcp_ipv4: false, + gateway: GatewayRuntimeConfig::default(), + manual_routes: None, + proxy: ProxyRuntimeConfig::default(), + public_ipv6_auto: false, + public_ipv6_provider: PublicIpv6ProviderConfig { + provider_enabled: false, + configured_prefix: None, + provider_supported: false, + }, + } + } +} + +#[derive(Debug, Clone)] +pub struct CoreInstanceRuntimeConfig { + pub services: CoreRuntimeConfig, + pub peer: Arc, +} + +struct CoreRuntimeConfigStoreInner { + snapshot: ArcSwap, + update: Mutex<()>, + peer_changes: tokio::sync::watch::Sender, + service_changes: tokio::sync::watch::Sender, +} + +/// Atomic configuration authority shared by one core instance and its peer +/// context. Readers always observe a complete submitted version. +#[derive(Clone)] +pub struct CoreRuntimeConfigStore { + inner: Arc, +} + +impl CoreRuntimeConfigStore { + pub fn new(services: CoreRuntimeConfig, peer: Arc) -> Self { + let (peer_changes, _) = tokio::sync::watch::channel(0); + let (service_changes, _) = tokio::sync::watch::channel(0); + Self { + inner: Arc::new(CoreRuntimeConfigStoreInner { + snapshot: ArcSwap::from_pointee(CoreInstanceRuntimeConfig { services, peer }), + update: Mutex::new(()), + peer_changes, + service_changes, + }), + } + } + + pub fn snapshot(&self) -> Arc { + self.inner.snapshot.load_full() + } + + pub(crate) fn with_snapshot(&self, read: impl FnOnce(&CoreInstanceRuntimeConfig) -> T) -> T { + let snapshot = self.inner.snapshot.load(); + read(&snapshot) + } + + pub fn replace(&self, config: CoreInstanceRuntimeConfig) { + let _update = self.inner.update.lock(); + self.inner.snapshot.store(Arc::new(config)); + self.inner.peer_changes.send_modify(|version| *version += 1); + self.inner + .service_changes + .send_modify(|version| *version += 1); + } + + pub(crate) fn replace_with_current( + &self, + mut config: CoreInstanceRuntimeConfig, + merge: impl FnOnce(&CoreInstanceRuntimeConfig, &mut CoreInstanceRuntimeConfig), + ) -> Arc { + let _update = self.inner.update.lock(); + let current = self.inner.snapshot.load_full(); + merge(¤t, &mut config); + let config = Arc::new(config); + self.inner.snapshot.store(config.clone()); + self.inner.peer_changes.send_modify(|version| *version += 1); + self.inner + .service_changes + .send_modify(|version| *version += 1); + config + } + + pub fn update_services(&self, update: impl FnOnce(&mut CoreRuntimeConfig)) { + let _update = self.inner.update.lock(); + let mut config = self.inner.snapshot.load_full().as_ref().clone(); + update(&mut config.services); + self.inner.snapshot.store(Arc::new(config)); + self.inner + .service_changes + .send_modify(|version| *version += 1); + } + + pub fn update_peer(&self, peer: Arc) { + let _update = self.inner.update.lock(); + let mut config = self.inner.snapshot.load_full().as_ref().clone(); + config.peer = peer; + self.inner.snapshot.store(Arc::new(config)); + self.inner.peer_changes.send_modify(|version| *version += 1); + } + + pub(crate) fn update_peer_with(&self, update: impl FnOnce(&mut PeerRuntimeSnapshot)) { + let _update = self.inner.update.lock(); + let mut config = self.inner.snapshot.load_full().as_ref().clone(); + update(Arc::make_mut(&mut config.peer)); + self.inner.snapshot.store(Arc::new(config)); + self.inner.peer_changes.send_modify(|version| *version += 1); + } + + pub fn subscribe_peer_runtime_changes(&self) -> tokio::sync::watch::Receiver { + self.inner.peer_changes.subscribe() + } + + pub fn subscribe_service_runtime_changes(&self) -> tokio::sync::watch::Receiver { + self.inner.service_changes.subscribe() + } + #[cfg(test)] + pub(crate) fn peer_change_subscriber_count(&self) -> usize { + self.inner.peer_changes.receiver_count() + } + + #[cfg(test)] + pub(crate) fn service_change_subscriber_count(&self) -> usize { + self.inner.service_changes.receiver_count() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn replaces_service_and_peer_as_one_version() { + let mut before_peer = PeerRuntimeSnapshot::default(); + before_peer.runtime.core.node.hostname = Some("before".to_owned()); + let store = + CoreRuntimeConfigStore::new(CoreRuntimeConfig::default(), Arc::new(before_peer)); + let before = store.snapshot(); + + let after_services = CoreRuntimeConfig { + dhcp_ipv4: true, + ..Default::default() + }; + let mut after_peer = PeerRuntimeSnapshot::default(); + after_peer.runtime.core.node.hostname = Some("after".to_owned()); + store.replace(CoreInstanceRuntimeConfig { + services: after_services, + peer: Arc::new(after_peer), + }); + + assert!(!before.services.dhcp_ipv4); + assert_eq!( + before.peer.runtime.core.node.hostname.as_deref(), + Some("before") + ); + let after = store.snapshot(); + assert!(after.services.dhcp_ipv4); + assert_eq!( + after.peer.runtime.core.node.hostname.as_deref(), + Some("after") + ); + } + + #[tokio::test] + async fn notifies_peer_snapshot_changes() { + let store = CoreRuntimeConfigStore::new( + CoreRuntimeConfig::default(), + Arc::new(PeerRuntimeSnapshot::default()), + ); + let mut changes = store.subscribe_peer_runtime_changes(); + let mut peer = PeerRuntimeSnapshot::default(); + peer.runtime.core.node.hostname = Some("updated".to_owned()); + + store.update_peer(Arc::new(peer)); + + assert!(changes.changed().await.is_ok()); + } + + #[tokio::test] + async fn notifies_service_snapshot_changes() { + let store = CoreRuntimeConfigStore::new( + CoreRuntimeConfig::default(), + Arc::new(PeerRuntimeSnapshot::default()), + ); + let mut changes = store.subscribe_service_runtime_changes(); + + store.update_services(|services| services.dhcp_ipv4 = true); + + assert!(changes.changed().await.is_ok()); + assert!(store.snapshot().services.dhcp_ipv4); + } + + #[tokio::test] + async fn peer_update_does_not_notify_service_watchers() { + let store = CoreRuntimeConfigStore::new( + CoreRuntimeConfig::default(), + Arc::new(PeerRuntimeSnapshot::default()), + ); + let changes = store.subscribe_service_runtime_changes(); + let mut peer = PeerRuntimeSnapshot::default(); + peer.runtime.core.node.hostname = Some("updated".to_owned()); + + store.update_peer(Arc::new(peer)); + + assert!(!changes.has_changed().unwrap()); + } + + #[test] + fn peer_in_place_update_preserves_the_rest_of_the_atomic_snapshot() { + let services = CoreRuntimeConfig { + dhcp_ipv4: true, + ..Default::default() + }; + let mut peer = PeerRuntimeSnapshot::default(); + peer.runtime.core.node.hostname = Some("preserved".to_owned()); + let store = CoreRuntimeConfigStore::new(services, Arc::new(peer)); + + store.update_peer_with(|peer| { + peer.runtime.core.routes.ipv4 = Some(crate::config::IpPrefix { + address: "10.20.30.7".parse().unwrap(), + prefix_len: 24, + }); + }); + + let snapshot = store.snapshot(); + assert!(snapshot.services.dhcp_ipv4); + assert_eq!( + snapshot.peer.runtime.core.node.hostname.as_deref(), + Some("preserved") + ); + assert_eq!( + snapshot + .peer + .runtime + .core + .routes + .ipv4 + .as_ref() + .unwrap() + .address, + "10.20.30.7".parse::().unwrap() + ); + } + + #[test] + fn missing_manual_routes_preserves_portable_config_compatibility() { + let encoded = serde_json::to_value(CoreRuntimeConfig::default()).unwrap(); + assert!(encoded.get("manual_routes").is_none()); + + let decoded: CoreRuntimeConfig = serde_json::from_value(encoded).unwrap(); + assert_eq!(decoded.manual_routes, None); + } +} diff --git a/vendor/easytier/easytier-core/src/config/toml.rs b/vendor/easytier/easytier-core/src/config/toml.rs new file mode 100644 index 0000000..8169286 --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/toml.rs @@ -0,0 +1,2016 @@ +//! Complete EasyTier TOML configuration model. + +use std::{ + net::{IpAddr, SocketAddr}, + path::PathBuf, + sync::{Arc, Mutex}, +}; + +use super::normalize_secure_mode_config; +pub use super::{EncryptionAlgorithm, gateway::PortForwardConfig}; +use anyhow::Context; +#[cfg(feature = "rich-config-errors")] +use ariadne::{CharSet, Config as AriadneConfig, IndexType, Label, Report, ReportKind, Source}; +use serde::{Deserialize, Serialize}; + +use crate::proto::{ + acl::Acl, + common::{CompressionAlgoPb, SecureModeConfig}, +}; + +pub const DEFAULT_ET_DNS_ZONE: &str = "et.net."; + +pub type Flags = crate::proto::common::FlagsInConfig; + +pub(crate) fn default_instance_name() -> String { + "default".to_owned() +} + +pub fn gen_default_flags() -> Flags { + #[allow(deprecated)] + Flags { + default_protocol: "tcp".to_string(), + dev_name: "".to_string(), + enable_encryption: true, + enable_ipv6: true, + mtu: 1380, + latency_first: false, + enable_exit_node: false, + proxy_forward_by_system: false, + no_tun: false, + use_smoltcp: false, + relay_network_whitelist: "*".to_string(), + disable_p2p: false, + p2p_only: false, + lazy_p2p: false, + relay_all_peer_rpc: false, + disable_tcp_hole_punching: false, + disable_udp_hole_punching: false, + multi_thread: true, + data_compress_algo: CompressionAlgoPb::None.into(), + bind_device: true, + enable_kcp_proxy: false, + disable_kcp_input: false, + disable_relay_kcp: false, + enable_relay_foreign_network_kcp: false, + accept_dns: false, + private_mode: false, + enable_quic_proxy: false, + disable_quic_input: false, + disable_relay_quic: false, + enable_relay_foreign_network_quic: false, + foreign_relay_bps_limit: u64::MAX, + multi_thread_count: 2, + encryption_algorithm: EncryptionAlgorithm::default().to_string(), + disable_sym_hole_punching: false, + tld_dns_zone: DEFAULT_ET_DNS_ZONE.to_string(), + + quic_listen_port: u32::MAX, + need_p2p: false, + instance_recv_bps_limit: u64::MAX, + disable_upnp: false, + disable_relay_data: false, + prefer_peer_relay: false, + enable_udp_broadcast_relay: false, + socket_mark: None, + } +} + +#[cfg(feature = "config-write")] +macro_rules! define_flags_diff { + ( + fields: [$($field:ident),* $(,)?], + u64s: [$($u64_field:ident),* $(,)?], + enums: [$($enum_field:ident),* $(,)?] + ) => { + #[allow(deprecated)] + fn flags_diff_from_default(flags: &Flags) -> serde_json::Map { + let defaults = gen_default_flags(); + let mut changed = serde_json::Map::new(); + $( + if flags.$field != defaults.$field { + changed.insert( + stringify!($field).to_owned(), + serde_json::to_value(&flags.$field) + .expect("FlagsInConfig field should serialize to JSON"), + ); + } + )* + $( + if flags.$u64_field != defaults.$u64_field { + changed.insert( + stringify!($u64_field).to_owned(), + serde_json::json!(flags.$u64_field.to_string()), + ); + } + )* + $( + if flags.$enum_field != defaults.$enum_field { + let value = CompressionAlgoPb::try_from(flags.$enum_field) + .map(|value| serde_json::to_value(value).expect("enum should serialize")) + .unwrap_or_else(|_| serde_json::json!(flags.$enum_field)); + changed.insert(stringify!($enum_field).to_owned(), value); + } + )* + changed + } + + #[cfg(all(test, feature = "config-write"))] + const FLAGS_DIFF_FIELDS: &[&str] = &[ + $(stringify!($field),)* + $(stringify!($u64_field),)* + $(stringify!($enum_field),)* + ]; + }; +} + +#[cfg(feature = "config-write")] +define_flags_diff! { + fields: [ + default_protocol, + dev_name, + enable_encryption, + enable_ipv6, + mtu, + latency_first, + enable_exit_node, + no_tun, + use_smoltcp, + relay_network_whitelist, + disable_p2p, + relay_all_peer_rpc, + disable_udp_hole_punching, + multi_thread, + bind_device, + enable_kcp_proxy, + disable_kcp_input, + disable_relay_kcp, + proxy_forward_by_system, + accept_dns, + private_mode, + enable_quic_proxy, + disable_quic_input, + disable_relay_quic, + quic_listen_port, + multi_thread_count, + enable_relay_foreign_network_kcp, + enable_relay_foreign_network_quic, + encryption_algorithm, + disable_sym_hole_punching, + tld_dns_zone, + p2p_only, + disable_tcp_hole_punching, + lazy_p2p, + need_p2p, + disable_upnp, + disable_relay_data, + prefer_peer_relay, + enable_udp_broadcast_relay, + socket_mark, + ], + u64s: [foreign_relay_bps_limit, instance_recv_bps_limit], + enums: [data_compress_algo] +} + +#[auto_impl::auto_impl(Box, &)] +pub trait ConfigLoader: Send + Sync { + fn get_id(&self) -> uuid::Uuid; + fn set_id(&self, id: uuid::Uuid); + + fn get_hostname(&self) -> String; + fn set_hostname(&self, name: Option); + + fn get_inst_name(&self) -> String; + fn set_inst_name(&self, name: String); + + fn get_netns(&self) -> Option; + fn set_netns(&self, ns: Option); + + fn get_ipv4(&self) -> Option; + fn set_ipv4(&self, addr: Option); + + fn get_ipv6(&self) -> Option; + fn set_ipv6(&self, addr: Option); + + fn get_ipv6_public_addr_provider(&self) -> bool; + fn set_ipv6_public_addr_provider(&self, enabled: bool); + + fn get_ipv6_public_addr_auto(&self) -> bool; + fn set_ipv6_public_addr_auto(&self, enabled: bool); + + fn get_ipv6_public_addr_prefix(&self) -> Option; + fn set_ipv6_public_addr_prefix(&self, prefix: Option); + + fn get_dhcp(&self) -> bool; + fn set_dhcp(&self, dhcp: bool); + + fn add_proxy_cidr( + &self, + cidr: cidr::Ipv4Cidr, + mapped_cidr: Option, + ) -> Result<(), anyhow::Error>; + fn remove_proxy_cidr(&self, cidr: cidr::Ipv4Cidr); + fn clear_proxy_cidrs(&self); + fn get_proxy_cidrs(&self) -> Vec; + + fn get_network_identity(&self) -> NetworkIdentity; + fn set_network_identity(&self, identity: NetworkIdentity); + + fn get_listener_uris(&self) -> Vec; + + fn get_peers(&self) -> Vec; + fn set_peers(&self, peers: Vec); + + fn get_listeners(&self) -> Option>; + fn set_listeners(&self, listeners: Vec); + + fn get_mapped_listeners(&self) -> Vec; + fn set_mapped_listeners(&self, listeners: Option>); + + fn get_vpn_portal_config(&self) -> Option; + fn set_vpn_portal_config(&self, config: VpnPortalConfig); + + fn get_flags(&self) -> Flags; + fn set_flags(&self, flags: Flags); + + fn get_exit_nodes(&self) -> Vec; + fn set_exit_nodes(&self, nodes: Vec); + + fn get_routes(&self) -> Option>; + fn set_routes(&self, routes: Option>); + + fn get_socks5_portal(&self) -> Option; + fn set_socks5_portal(&self, addr: Option); + + fn get_port_forwards(&self) -> Vec; + fn set_port_forwards(&self, forwards: Vec); + + fn get_acl(&self) -> Option; + fn set_acl(&self, acl: Option); + + fn get_tcp_whitelist(&self) -> Vec; + fn set_tcp_whitelist(&self, whitelist: Vec); + + fn get_udp_whitelist(&self) -> Vec; + fn set_udp_whitelist(&self, whitelist: Vec); + + fn get_stun_servers(&self) -> Option>; + fn set_stun_servers(&self, servers: Option>); + + fn get_tcp_stun_servers(&self) -> Option> { + None + } + fn set_tcp_stun_servers(&self, _servers: Option>) {} + + fn get_stun_servers_v6(&self) -> Option>; + fn set_stun_servers_v6(&self, servers: Option>); + + fn get_secure_mode(&self) -> Option; + fn set_secure_mode(&self, secure_mode: Option); + + fn get_credential_file(&self) -> Option { + None + } + fn set_credential_file(&self, _path: Option) {} + + fn get_managed_credentials(&self) -> Vec { + Vec::new() + } + fn set_managed_credentials(&self, _credentials: Vec) {} + + fn get_network_config_source(&self) -> ConfigSource { + ConfigSource::User + } + fn set_network_config_source(&self, _source: Option) {} + + fn dump(&self) -> String; + fn dump_redacted(&self) -> String { + self.dump() + } +} + +pub trait LoggingConfigLoader { + fn get_file_logger_config(&self) -> FileLoggerConfig; + + fn get_console_logger_config(&self) -> ConsoleLoggerConfig; +} + +use super::NetworkSecretDigest; + +#[derive(Debug, Clone, Deserialize, Serialize)] +pub struct NetworkIdentity { + pub network_name: String, + pub network_secret: Option, + #[serde(skip)] + pub network_secret_digest: Option, +} + +impl From for NetworkIdentity { + fn from(value: super::NetworkIdentity) -> Self { + Self { + network_name: value.network_name, + network_secret: value.network_secret, + network_secret_digest: value.network_secret_digest, + } + } +} + +impl From<&NetworkIdentity> for super::NetworkIdentity { + fn from(value: &NetworkIdentity) -> Self { + Self { + network_name: value.network_name.clone(), + network_secret: value.network_secret.clone(), + network_secret_digest: value.network_secret_digest, + } + } +} + +impl From for super::NetworkIdentity { + fn from(value: NetworkIdentity) -> Self { + Self { + network_name: value.network_name, + network_secret: value.network_secret, + network_secret_digest: value.network_secret_digest, + } + } +} + +#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, Default)] +#[serde(rename_all = "snake_case")] +pub enum ConfigSource { + #[default] + User, + Web, +} + +impl ConfigSource { + pub fn as_str(self) -> &'static str { + match self { + Self::User => "user", + Self::Web => "web", + } + } +} + +impl std::str::FromStr for ConfigSource { + type Err = String; + + fn from_str(s: &str) -> Result { + match s { + "user" => Ok(Self::User), + "web" => Ok(Self::Web), + other => Err(format!("unknown network config source: {other}")), + } + } +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] +struct ConfigSourceConfig { + source: ConfigSource, +} + +impl PartialEq for NetworkIdentity { + fn eq(&self, other: &Self) -> bool { + super::NetworkIdentity::from(self) == super::NetworkIdentity::from(other) + } +} + +impl Eq for NetworkIdentity {} + +impl std::hash::Hash for NetworkIdentity { + fn hash(&self, state: &mut H) { + std::hash::Hash::hash(&super::NetworkIdentity::from(self), state); + } +} + +impl NetworkIdentity { + pub fn new(network_name: String, network_secret: String) -> Self { + super::NetworkIdentity::new(network_name, network_secret).into() + } + + /// Create a NetworkIdentity for a credential node (no network_secret). + /// The node identifies by network_name only and authenticates via credential keypair. + pub fn new_credential(network_name: String) -> Self { + super::NetworkIdentity::new_credential(network_name).into() + } +} + +impl Default for NetworkIdentity { + fn default() -> Self { + super::NetworkIdentity::default().into() + } +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] +pub struct PeerConfig { + pub uri: url::Url, + pub peer_public_key: Option, +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)] +pub struct ProxyNetworkConfig { + pub cidr: cidr::Ipv4Cidr, // the CIDR of the proxy network + pub mapped_cidr: Option, // allow remap the proxy CIDR to another CIDR + pub allow: Option>, +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Default)] +pub struct FileLoggerConfig { + pub level: Option, + pub file: Option, + pub dir: Option, + pub size_mb: Option, + pub count: Option, +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Default)] +pub struct ConsoleLoggerConfig { + pub level: Option, +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, bon::Builder)] +pub struct LoggingConfig { + #[builder(into)] + pub file_logger: Option, + #[builder(into)] + pub console_logger: Option, +} + +impl LoggingConfigLoader for &LoggingConfig { + fn get_file_logger_config(&self) -> FileLoggerConfig { + self.file_logger.clone().unwrap_or_default() + } + + fn get_console_logger_config(&self) -> ConsoleLoggerConfig { + self.console_logger.clone().unwrap_or_default() + } +} + +#[derive(Clone, Deserialize, Serialize, PartialEq)] +#[serde(deny_unknown_fields)] +pub struct VpnPortalConfig { + #[serde(default, skip_serializing_if = "Option::is_none")] + pub enabled: Option, + pub wireguard_listen: SocketAddr, + #[serde(default, skip_serializing_if = "Option::is_none")] + pub wireguard_private_key: Option, + #[serde(default)] + pub clients: Vec, +} + +impl std::fmt::Debug for VpnPortalConfig { + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("VpnPortalConfig") + .field("enabled", &self.enabled) + .field("wireguard_listen", &self.wireguard_listen) + .field( + "wireguard_private_key", + &self.wireguard_private_key.as_ref().map(|_| ""), + ) + .field("clients", &self.clients) + .finish() + } +} + +#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)] +#[serde(deny_unknown_fields)] +pub struct VpnPortalClientConfig { + pub name: String, + pub virtual_ip: cidr::Ipv4Inet, + #[serde(default)] + pub groups: Vec, +} + +fn default_true() -> bool { + true +} + +#[derive(Clone, Deserialize, Serialize, PartialEq, Eq)] +#[serde(deny_unknown_fields)] +pub struct ManagedCredentialConfig { + pub credential_id: String, + pub credential_secret: String, + #[serde(default, skip_serializing_if = "Vec::is_empty")] + pub groups: Vec, + #[serde(default)] + pub allow_relay: bool, + #[serde(default, skip_serializing_if = "Vec::is_empty")] + pub allowed_proxy_cidrs: Vec, + pub expiry_unix: i64, + #[serde(default = "default_true")] + pub reusable: bool, +} + +impl std::fmt::Debug for ManagedCredentialConfig { + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("ManagedCredentialConfig") + .field("credential_id", &self.credential_id) + .field("credential_secret", &"") + .field("groups", &self.groups) + .field("allow_relay", &self.allow_relay) + .field("allowed_proxy_cidrs", &self.allowed_proxy_cidrs) + .field("expiry_unix", &self.expiry_unix) + .field("reusable", &self.reusable) + .finish() + } +} + +#[derive(Debug, Clone, PartialEq, Deserialize)] +#[cfg_attr(feature = "config-write", derive(Serialize))] +struct Config { + netns: Option, + hostname: Option, + instance_name: Option, + instance_id: Option, + ipv4: Option, + ipv6: Option, + ipv6_public_addr_provider: Option, + ipv6_public_addr_auto: Option, + ipv6_public_addr_prefix: Option, + dhcp: Option, + network_identity: Option, + listeners: Option>, + mapped_listeners: Option>, + exit_nodes: Option>, + + peer: Option>, + proxy_network: Option>, + + vpn_portal_config: Option, + + routes: Option>, + + socks5_proxy: Option, + + port_forward: Option>, + + secure_mode: Option, + + flags: Option>, + + #[serde(skip)] + flags_struct: Option, + + acl: Option, + + tcp_whitelist: Option>, + udp_whitelist: Option>, + stun_servers: Option>, + tcp_stun_servers: Option>, + stun_servers_v6: Option>, + + credential_file: Option, + #[serde(default, skip_serializing_if = "Vec::is_empty")] + managed_credentials: Vec, + source: Option, +} + +#[cfg(feature = "rich-config-errors")] +fn format_toml_parse_error(source_name: &str, config_str: &str, error: &toml::de::Error) -> String { + let message = format!("failed to parse config TOML from {source_name}"); + + let Some(span) = error.span() else { + return format!("{message}\ndetail: {error}"); + }; + + let mut output = Vec::new(); + let report = Report::build(ReportKind::Error, (source_name, span.clone())) + .with_config( + AriadneConfig::default() + .with_color(false) + .with_char_set(CharSet::Ascii) + .with_index_type(IndexType::Byte), + ) + .with_message(&message) + .with_label(Label::new((source_name, span)).with_message(error.message())) + .finish(); + + if report + .write((source_name, Source::from(config_str)), &mut output) + .is_ok() + { + String::from_utf8_lossy(&output).into_owned() + } else { + format!("{message}\ndetail: {error}") + } +} + +#[cfg(not(feature = "rich-config-errors"))] +fn format_toml_parse_error( + source_name: &str, + _config_str: &str, + error: &toml::de::Error, +) -> String { + format!("failed to parse config TOML from {source_name}: {error}") +} + +#[derive(Debug, Clone)] +pub struct TomlConfig { + config: Arc>, +} + +impl Default for TomlConfig { + fn default() -> Self { + TomlConfig::new_from_str("").unwrap() + } +} + +impl TomlConfig { + fn normalize_config_source(config: &mut Config) { + if matches!( + config.source.as_ref().map(|source| source.source), + Some(ConfigSource::User) + ) { + config.source = None; + } + } + + #[cfg(feature = "config-write")] + fn config_for_dump(&self) -> Config { + let mut config = self.config.lock().unwrap().clone(); + Self::normalize_config_source(&mut config); + config.flags = Some(flags_diff_from_default(&self.get_flags())); + config + } + + #[cfg(feature = "config-write")] + fn redact_secrets(config: &mut Config) { + const REDACTED: &str = ""; + + if let Some(secret) = config + .network_identity + .as_mut() + .and_then(|identity| identity.network_secret.as_mut()) + && !secret.is_empty() + { + *secret = REDACTED.to_owned(); + } + if let Some(private_key) = config + .secure_mode + .as_mut() + .and_then(|secure_mode| secure_mode.local_private_key.as_mut()) + && !private_key.is_empty() + { + *private_key = REDACTED.to_owned(); + } + if let Some(private_key) = config + .vpn_portal_config + .as_mut() + .and_then(|portal| portal.wireguard_private_key.as_mut()) + && !private_key.is_empty() + { + *private_key = REDACTED.to_owned(); + } + if let Some(declarations) = config + .acl + .as_mut() + .and_then(|acl| acl.acl_v1.as_mut()) + .and_then(|acl| acl.group.as_mut()) + .map(|group| &mut group.declares) + { + for declaration in declarations { + if !declaration.group_secret.is_empty() { + declaration.group_secret = REDACTED.to_owned(); + } + } + } + for credential in &mut config.managed_credentials { + if !credential.credential_secret.is_empty() { + credential.credential_secret = REDACTED.to_owned(); + } + } + } + + pub fn new_from_str(config_str: &str) -> Result { + Self::new_from_str_with_source("inline config", config_str) + } + + pub fn new_from_str_with_source( + source_name: &str, + config_str: &str, + ) -> Result { + let mut config = toml::de::from_str::(config_str).map_err(|err| { + let message = format_toml_parse_error(source_name, config_str, &err); + anyhow::Error::new(err).context(message) + })?; + + Self::normalize_config_source(&mut config); + + Self::new_from_config(config).map_err(|err| { + let message = format!("failed to load config from {source_name}: {err}"); + err.context(message) + }) + } + + fn new_from_config(mut config: Config) -> Result { + config.flags_struct = Some( + Self::gen_flags(config.flags.clone().unwrap_or_default()) + .context("failed to parse flags")?, + ); + config.secure_mode = config + .secure_mode + .take() + .map(normalize_secure_mode_config) + .transpose() + .context("failed to normalize [secure_mode] config")?; + let has_network_identity = config.network_identity.is_some(); + + let config = TomlConfig { + config: Arc::new(Mutex::new(config)), + }; + + let old_ns = config.get_network_identity(); + + // Detect credential mode: secure_mode enabled + no network_secret in TOML + let is_credential = has_network_identity + && config + .get_secure_mode() + .map(|sm| sm.enabled) + .unwrap_or(false) + && old_ns + .network_secret + .as_deref() + .is_none_or(|s| s.is_empty()); + + if is_credential { + config.set_network_identity(NetworkIdentity::new_credential(old_ns.network_name)); + } else { + config.set_network_identity(NetworkIdentity::new( + old_ns.network_name, + old_ns.network_secret.unwrap_or_default(), + )); + } + + Ok(config) + } + + fn gen_flags( + flags_hashmap: serde_json::Map, + ) -> serde_json::Result { + let mut merged_hashmap = match serde_json::to_value(gen_default_flags()) { + Ok(serde_json::Value::Object(map)) => map, + _ => serde_json::Map::new(), + }; + merged_hashmap.extend(flags_hashmap); + serde_json::from_value(serde_json::Value::Object(merged_hashmap)) + } +} + +#[cfg(feature = "web-client")] +mod snapshot; + +impl ConfigLoader for TomlConfig { + fn get_inst_name(&self) -> String { + self.config + .lock() + .unwrap() + .instance_name + .clone() + .unwrap_or_else(default_instance_name) + } + + fn set_inst_name(&self, name: String) { + self.config.lock().unwrap().instance_name = Some(name); + } + + fn get_hostname(&self) -> String { + let hostname = self.config.lock().unwrap().hostname.clone(); + + match hostname { + Some(hostname) => { + let hostname = hostname + .chars() + .filter(|c| !c.is_control()) + .take(32) + .collect::(); + + if !hostname.is_empty() { + self.set_hostname(Some(hostname.clone())); + hostname + } else { + self.set_hostname(None); + String::new() + } + } + None => String::new(), + } + } + + fn set_hostname(&self, name: Option) { + self.config.lock().unwrap().hostname = name; + } + + fn get_netns(&self) -> Option { + self.config.lock().unwrap().netns.clone() + } + + fn set_netns(&self, ns: Option) { + self.config.lock().unwrap().netns = ns; + } + + fn get_ipv4(&self) -> Option { + let locked_config = self.config.lock().unwrap(); + locked_config + .ipv4 + .as_ref() + .and_then(|s| s.parse().ok()) + .map(|c: cidr::Ipv4Inet| { + if c.network_length() == 32 { + cidr::Ipv4Inet::new(c.address(), 24).unwrap() + } else { + c + } + }) + } + + fn set_ipv4(&self, addr: Option) { + self.config.lock().unwrap().ipv4 = addr.map(|addr| addr.to_string()); + } + + fn get_ipv6(&self) -> Option { + let locked_config = self.config.lock().unwrap(); + locked_config.ipv6.as_ref().and_then(|s| s.parse().ok()) + } + + fn set_ipv6(&self, addr: Option) { + self.config.lock().unwrap().ipv6 = addr.map(|addr| addr.to_string()); + } + + fn get_ipv6_public_addr_provider(&self) -> bool { + self.config + .lock() + .unwrap() + .ipv6_public_addr_provider + .unwrap_or_default() + } + + fn set_ipv6_public_addr_provider(&self, enabled: bool) { + self.config.lock().unwrap().ipv6_public_addr_provider = Some(enabled); + } + + fn get_ipv6_public_addr_auto(&self) -> bool { + self.config + .lock() + .unwrap() + .ipv6_public_addr_auto + .unwrap_or_default() + } + + fn set_ipv6_public_addr_auto(&self, enabled: bool) { + self.config.lock().unwrap().ipv6_public_addr_auto = Some(enabled); + } + + fn get_ipv6_public_addr_prefix(&self) -> Option { + let locked_config = self.config.lock().unwrap(); + locked_config + .ipv6_public_addr_prefix + .as_ref() + .and_then(|s| s.parse().ok()) + } + + fn set_ipv6_public_addr_prefix(&self, prefix: Option) { + self.config.lock().unwrap().ipv6_public_addr_prefix = + prefix.map(|prefix| prefix.to_string()); + } + + fn get_dhcp(&self) -> bool { + self.config.lock().unwrap().dhcp.unwrap_or_default() + } + + fn set_dhcp(&self, dhcp: bool) { + self.config.lock().unwrap().dhcp = Some(dhcp); + } + + fn add_proxy_cidr( + &self, + cidr: cidr::Ipv4Cidr, + mapped_cidr: Option, + ) -> Result<(), anyhow::Error> { + let mut locked_config = self.config.lock().unwrap(); + if locked_config.proxy_network.is_none() { + locked_config.proxy_network = Some(vec![]); + } + if let Some(mapped_cidr) = mapped_cidr.as_ref() + && cidr.network_length() != mapped_cidr.network_length() + { + return Err(anyhow::anyhow!( + "Mapped CIDR must have the same network length as the original CIDR: {} != {}", + cidr.network_length(), + mapped_cidr.network_length() + )); + } + // insert if no duplicate + if !locked_config + .proxy_network + .as_ref() + .unwrap() + .iter() + .any(|c| c.cidr == cidr && c.mapped_cidr == mapped_cidr) + { + locked_config + .proxy_network + .as_mut() + .unwrap() + .push(ProxyNetworkConfig { + cidr, + mapped_cidr, + allow: None, + }); + } + Ok(()) + } + + fn remove_proxy_cidr(&self, cidr: cidr::Ipv4Cidr) { + let mut locked_config = self.config.lock().unwrap(); + if let Some(proxy_cidrs) = &mut locked_config.proxy_network { + proxy_cidrs.retain(|c| c.cidr != cidr); + } + } + + fn clear_proxy_cidrs(&self) { + let mut locked_config = self.config.lock().unwrap(); + locked_config.proxy_network = None; + } + + fn get_proxy_cidrs(&self) -> Vec { + self.config + .lock() + .unwrap() + .proxy_network + .as_ref() + .cloned() + .unwrap_or_default() + } + + fn get_id(&self) -> uuid::Uuid { + let mut locked_config = self.config.lock().unwrap(); + match locked_config.instance_id { + Some(id) => id, + None => { + let id = uuid::Uuid::new_v4(); + locked_config.instance_id = Some(id); + id + } + } + } + + fn set_id(&self, id: uuid::Uuid) { + self.config.lock().unwrap().instance_id = Some(id); + } + + fn get_network_identity(&self) -> NetworkIdentity { + self.config + .lock() + .unwrap() + .network_identity + .clone() + .unwrap_or_default() + } + + fn set_network_identity(&self, identity: NetworkIdentity) { + self.config.lock().unwrap().network_identity = Some(identity); + } + + fn get_listener_uris(&self) -> Vec { + self.config + .lock() + .unwrap() + .listeners + .clone() + .unwrap_or_default() + } + + fn get_peers(&self) -> Vec { + self.config.lock().unwrap().peer.clone().unwrap_or_default() + } + + fn set_peers(&self, peers: Vec) { + self.config.lock().unwrap().peer = Some(peers); + } + + fn get_listeners(&self) -> Option> { + self.config.lock().unwrap().listeners.clone() + } + + fn set_listeners(&self, listeners: Vec) { + self.config.lock().unwrap().listeners = Some(listeners); + } + + fn get_mapped_listeners(&self) -> Vec { + self.config + .lock() + .unwrap() + .mapped_listeners + .clone() + .unwrap_or_default() + } + + fn set_mapped_listeners(&self, listeners: Option>) { + self.config.lock().unwrap().mapped_listeners = listeners; + } + + fn get_vpn_portal_config(&self) -> Option { + self.config.lock().unwrap().vpn_portal_config.clone() + } + fn set_vpn_portal_config(&self, config: VpnPortalConfig) { + self.config.lock().unwrap().vpn_portal_config = Some(config); + } + + fn get_flags(&self) -> Flags { + self.config + .lock() + .unwrap() + .flags_struct + .clone() + .unwrap_or_default() + } + + fn set_flags(&self, flags: Flags) { + self.config.lock().unwrap().flags_struct = Some(flags); + } + + fn get_exit_nodes(&self) -> Vec { + self.config + .lock() + .unwrap() + .exit_nodes + .clone() + .unwrap_or_default() + } + + fn set_exit_nodes(&self, nodes: Vec) { + self.config.lock().unwrap().exit_nodes = Some(nodes); + } + + fn get_routes(&self) -> Option> { + self.config.lock().unwrap().routes.clone() + } + + fn set_routes(&self, routes: Option>) { + self.config.lock().unwrap().routes = routes; + } + + fn get_socks5_portal(&self) -> Option { + self.config.lock().unwrap().socks5_proxy.clone() + } + + fn set_socks5_portal(&self, addr: Option) { + self.config.lock().unwrap().socks5_proxy = addr; + } + + fn get_port_forwards(&self) -> Vec { + self.config + .lock() + .unwrap() + .port_forward + .clone() + .unwrap_or_default() + } + + fn set_port_forwards(&self, forwards: Vec) { + self.config.lock().unwrap().port_forward = Some(forwards); + } + + fn get_acl(&self) -> Option { + self.config.lock().unwrap().acl.clone() + } + + fn set_acl(&self, acl: Option) { + self.config.lock().unwrap().acl = acl; + } + + fn get_tcp_whitelist(&self) -> Vec { + self.config + .lock() + .unwrap() + .tcp_whitelist + .clone() + .unwrap_or_default() + } + + fn set_tcp_whitelist(&self, whitelist: Vec) { + self.config.lock().unwrap().tcp_whitelist = Some(whitelist); + } + + fn get_udp_whitelist(&self) -> Vec { + self.config + .lock() + .unwrap() + .udp_whitelist + .clone() + .unwrap_or_default() + } + + fn set_udp_whitelist(&self, whitelist: Vec) { + self.config.lock().unwrap().udp_whitelist = Some(whitelist); + } + + fn get_stun_servers(&self) -> Option> { + self.config.lock().unwrap().stun_servers.clone() + } + + fn set_stun_servers(&self, servers: Option>) { + self.config.lock().unwrap().stun_servers = servers; + } + + fn get_tcp_stun_servers(&self) -> Option> { + self.config.lock().unwrap().tcp_stun_servers.clone() + } + + fn set_tcp_stun_servers(&self, servers: Option>) { + self.config.lock().unwrap().tcp_stun_servers = servers; + } + + fn get_stun_servers_v6(&self) -> Option> { + self.config.lock().unwrap().stun_servers_v6.clone() + } + + fn set_stun_servers_v6(&self, servers: Option>) { + self.config.lock().unwrap().stun_servers_v6 = servers; + } + + fn get_secure_mode(&self) -> Option { + self.config.lock().unwrap().secure_mode.clone() + } + + fn set_secure_mode(&self, secure_mode: Option) { + self.config.lock().unwrap().secure_mode = secure_mode; + } + + fn get_credential_file(&self) -> Option { + self.config.lock().unwrap().credential_file.clone() + } + + fn set_credential_file(&self, path: Option) { + self.config.lock().unwrap().credential_file = path; + } + + fn get_managed_credentials(&self) -> Vec { + self.config.lock().unwrap().managed_credentials.clone() + } + + fn set_managed_credentials(&self, credentials: Vec) { + self.config.lock().unwrap().managed_credentials = credentials; + } + + fn get_network_config_source(&self) -> ConfigSource { + self.config + .lock() + .unwrap() + .source + .as_ref() + .map(|source| source.source) + .unwrap_or(ConfigSource::User) + } + + fn set_network_config_source(&self, source: Option) { + self.config.lock().unwrap().source = source.and_then(|source| match source { + ConfigSource::User => None, + other => Some(ConfigSourceConfig { source: other }), + }); + } + + fn dump(&self) -> String { + #[cfg(feature = "config-write")] + { + toml::to_string_pretty(&self.config_for_dump()).unwrap() + } + #[cfg(not(feature = "config-write"))] + { + panic!("this build does not include TOML configuration serialization") + } + } + + fn dump_redacted(&self) -> String { + #[cfg(feature = "config-write")] + { + let mut config = self.config_for_dump(); + Self::redact_secrets(&mut config); + toml::to_string_pretty(&config).unwrap() + } + #[cfg(not(feature = "config-write"))] + { + panic!("this build does not include TOML configuration serialization") + } + } +} + +/// Transitional name retained while native consumers migrate to [`TomlConfig`]. +pub type TomlConfigLoader = TomlConfig; + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn parse_error_preserves_source_and_location() { + let error = + TomlConfig::new_from_str_with_source("fixture.toml", "dhcp = \"yes\"").unwrap_err(); + let display = error.to_string(); + + assert!(display.contains("fixture.toml")); + assert!(display.contains("dhcp = \"yes\"")); + assert!(display.contains("invalid type: string")); + assert!( + error + .chain() + .any(|cause| cause.downcast_ref::().is_some()) + ); + } + + #[cfg(feature = "config-write")] + #[test] + fn toml_round_trip_preserves_config_and_non_default_flags() { + let config = TomlConfig::new_from_str( + r#" +instance_name = "node-a" +instance_id = "018f85a8-a9d0-7d4c-b73d-4ab62c048a20" +hostname = "host-a" +listeners = ["tcp://0.0.0.0:11010"] + +[network_identity] +network_name = "network-a" +network_secret = "secret-a" + +[flags] +mtu = 1420 +socket_mark = 0 +"#, + ) + .unwrap(); + + let dumped = config.dump(); + let restored = TomlConfig::new_from_str(&dumped).unwrap(); + + assert_eq!(restored.get_id(), config.get_id()); + assert_eq!(restored.get_hostname(), "host-a"); + assert_eq!( + restored.get_network_identity(), + config.get_network_identity() + ); + assert_eq!(restored.get_listener_uris(), config.get_listener_uris()); + assert_eq!(restored.get_flags().mtu, 1420); + assert_eq!(restored.get_flags().socket_mark, Some(0)); + } + + #[test] + fn legacy_vpn_portal_client_cidr_is_rejected_explicitly() { + let error = TomlConfig::new_from_str( + r#" +[vpn_portal_config] +client_cidr = "10.14.14.0/24" +wireguard_listen = "0.0.0.0:51820" +"#, + ) + .unwrap_err() + .to_string(); + + assert!(error.contains("client_cidr"), "{error}"); + } + + #[cfg(feature = "config-write")] + #[test] + fn vpn_portal_round_trip_and_redacted_dump_preserve_dump_semantics() { + let config = TomlConfig::new_from_str( + r#" +[network_identity] +network_name = "network-a" +network_secret = "network-secret" + +[secure_mode] +enabled = true +local_private_key = "YWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWE=" + +[vpn_portal_config] +wireguard_listen = "0.0.0.0:51820" +wireguard_private_key = "wireguard-private-key" + +[[vpn_portal_config.clients]] +name = "alice" +virtual_ip = "10.144.144.10/24" +groups = ["staff"] + +[acl.acl_v1.group] + +[[acl.acl_v1.group.declares]] +group_name = "staff" +group_secret = "group-secret" +"#, + ) + .unwrap(); + + let dumped = config.dump(); + assert!(dumped.contains("network-secret")); + assert!(dumped.contains("YWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWE=")); + assert!(dumped.contains("wireguard-private-key")); + assert!(dumped.contains("group-secret")); + assert_eq!( + TomlConfig::new_from_str(&dumped) + .unwrap() + .get_vpn_portal_config(), + config.get_vpn_portal_config() + ); + + let redacted = config.dump_redacted(); + assert!(!redacted.contains("network-secret")); + assert!(!redacted.contains("YWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWE=")); + assert!(!redacted.contains("wireguard-private-key")); + assert!(!redacted.contains("group-secret")); + assert_eq!(redacted.matches("").count(), 4); + } + + #[cfg(feature = "config-write")] + #[test] + fn managed_credentials_round_trip_and_redact_secret() { + let config = TomlConfig::new_from_str( + r#" +[[managed_credentials]] +credential_id = "managed-a" +credential_secret = "private-key-material" +groups = ["ops"] +allow_relay = true +allowed_proxy_cidrs = ["10.0.0.0/24"] +expiry_unix = 2000000000 +"#, + ) + .unwrap(); + + let dumped = config.dump(); + let restored = TomlConfig::new_from_str(&dumped).unwrap(); + assert_eq!( + restored.get_managed_credentials(), + config.get_managed_credentials() + ); + assert!(dumped.contains("private-key-material")); + + let redacted = config.dump_redacted(); + assert!(!redacted.contains("private-key-material")); + assert!(redacted.contains("")); + assert!(!TomlConfig::default().dump().contains("managed_credentials")); + } + + #[test] + fn hostname_normalization_is_portable_and_has_no_host_fallback() { + let absent = TomlConfig::default(); + assert_eq!(absent.get_hostname(), ""); + + let configured = TomlConfig::new_from_str("hostname = \"node\\u0007-name\"").unwrap(); + assert_eq!(configured.get_hostname(), "node-name"); + } + + #[test] + fn credential_mode_does_not_synthesize_a_network_secret() { + let config = TomlConfig::new_from_str( + r#" +[network_identity] +network_name = "credential-network" + +[secure_mode] +enabled = true +"#, + ) + .unwrap(); + + let identity = config.get_network_identity(); + assert_eq!(identity.network_name, "credential-network"); + assert_eq!(identity.network_secret, None); + } + + #[cfg(feature = "config-write")] + #[test] + fn user_source_is_implicit_while_web_source_round_trips() { + let user = TomlConfig::new_from_str( + r#" +[source] +source = "user" +"#, + ) + .unwrap(); + assert_eq!(user.get_network_config_source(), ConfigSource::User); + assert!(!user.dump().contains("[source]")); + + let web = TomlConfig::new_from_str( + r#" +[source] +source = "web" +"#, + ) + .unwrap(); + assert_eq!(web.get_network_config_source(), ConfigSource::Web); + assert!(web.dump().contains("source = \"web\"")); + } +} + +#[cfg(test)] +mod compatibility_tests { + use super::*; + use base64::{Engine as _, prelude::BASE64_STANDARD}; + + #[cfg(feature = "config-write")] + #[test] + fn flags_diff_covers_every_protobuf_field() { + use prost::Message as _; + + let descriptor_set = + prost_types::FileDescriptorSet::decode(crate::proto::DESCRIPTOR_POOL_BYTES).unwrap(); + let proto_fields = descriptor_set + .file + .iter() + .find(|file| file.package.as_deref() == Some("common")) + .and_then(|file| { + file.message_type + .iter() + .find(|message| message.name.as_deref() == Some("FlagsInConfig")) + }) + .unwrap() + .field + .iter() + .map(|field| field.name.as_deref().unwrap()) + .collect::>(); + let diff_fields = FLAGS_DIFF_FIELDS + .iter() + .copied() + .collect::>(); + + assert_eq!(diff_fields, proto_fields); + } + + #[test] + fn socket_mark_config_file_roundtrip_none_some_and_zero() { + // Omitting the flag leaves socket_mark unset (None) -> SO_MARK untouched. + let cfg = TomlConfigLoader::new_from_str( + r#" +[network_identity] +network_name = "n" +network_secret = "s" +"#, + ) + .unwrap(); + assert_eq!(cfg.get_flags().socket_mark, None); + + // socket_mark = 0 is a legitimate value distinct from "unset". + let cfg = TomlConfigLoader::new_from_str( + r#" +[network_identity] +network_name = "n" +network_secret = "s" + +[flags] +socket_mark = 0 +"#, + ) + .unwrap(); + assert_eq!(cfg.get_flags().socket_mark, Some(0)); + + // A non-zero mark round-trips as Some(v). + let cfg = TomlConfigLoader::new_from_str( + r#" +[network_identity] +network_name = "n" +network_secret = "s" + +[flags] +socket_mark = 66 +"#, + ) + .unwrap(); + assert_eq!(cfg.get_flags().socket_mark, Some(66)); + + // set_flags(None) must serialize back through gen_config without + // resurrecting a value (guards the gen_flags merge against dropping + // the key when the serialized default is null). + cfg.set_flags(Flags { + socket_mark: None, + ..cfg.get_flags() + }); + assert_eq!(cfg.get_flags().socket_mark, None); + } + + #[cfg(feature = "config-write")] + #[test] + fn dump_preserves_flags_that_differ_from_easytier_defaults() { + let cfg = TomlConfigLoader::default(); + let mut flags = gen_default_flags(); + flags.dev_name = "et_test".to_string(); + flags.enable_quic_proxy = true; + flags.disable_tcp_hole_punching = true; + flags.disable_sym_hole_punching = true; + flags.multi_thread = false; + flags.bind_device = false; + flags.enable_ipv6 = false; + flags.relay_network_whitelist = "".to_string(); + flags.prefer_peer_relay = true; + flags.mtu = 0; + flags.foreign_relay_bps_limit = u64::MAX - 1; + flags.instance_recv_bps_limit = u64::MAX - 2; + flags.data_compress_algo = CompressionAlgoPb::Zstd.into(); + flags.socket_mark = Some(0); + cfg.set_flags(flags); + + let dumped = cfg.dump(); + + assert!(dumped.contains("dev_name = \"et_test\"")); + assert!(dumped.contains("enable_quic_proxy = true")); + assert!(dumped.contains("disable_tcp_hole_punching = true")); + assert!(dumped.contains("disable_sym_hole_punching = true")); + assert!(dumped.contains("multi_thread = false")); + assert!(dumped.contains("bind_device = false")); + assert!(dumped.contains("enable_ipv6 = false")); + assert!(dumped.contains("relay_network_whitelist = \"\"")); + assert!(dumped.contains("mtu = 0")); + assert!(dumped.contains("foreign_relay_bps_limit = \"18446744073709551614\"")); + assert!(dumped.contains("instance_recv_bps_limit = \"18446744073709551613\"")); + assert!(dumped.contains("data_compress_algo = \"Zstd\"")); + assert!(dumped.contains("socket_mark = 0")); + + let reloaded = TomlConfigLoader::new_from_str(&dumped).unwrap(); + let reloaded_flags = reloaded.get_flags(); + assert_eq!(reloaded_flags.dev_name, "et_test"); + assert!(reloaded_flags.enable_quic_proxy); + assert!(reloaded_flags.disable_tcp_hole_punching); + assert!(reloaded_flags.disable_sym_hole_punching); + assert!(!reloaded_flags.multi_thread); + assert!(!reloaded_flags.bind_device); + assert!(!reloaded_flags.enable_ipv6); + assert_eq!(reloaded_flags.relay_network_whitelist, ""); + assert!(reloaded_flags.prefer_peer_relay); + assert_eq!(reloaded_flags.mtu, 0); + assert_eq!(reloaded_flags.foreign_relay_bps_limit, u64::MAX - 1); + assert_eq!(reloaded_flags.instance_recv_bps_limit, u64::MAX - 2); + assert_eq!( + reloaded_flags.data_compress_algo, + i32::from(CompressionAlgoPb::Zstd) + ); + assert_eq!(reloaded_flags.socket_mark, Some(0)); + } + + #[test] + fn test_stun_servers_config() { + let config = TomlConfigLoader::default(); + let stun_servers = config.get_stun_servers(); + assert!(stun_servers.is_none()); + assert!(config.get_tcp_stun_servers().is_none()); + + // Test setting custom stun servers + let custom_servers = vec!["txt:stun.easytier.cn".to_string()]; + config.set_stun_servers(Some(custom_servers.clone())); + + let retrieved_servers = config.get_stun_servers(); + assert_eq!(retrieved_servers.unwrap(), custom_servers); + + let custom_tcp_servers = vec!["tcp-stun.example.com:3478".to_string()]; + config.set_tcp_stun_servers(Some(custom_tcp_servers.clone())); + + let retrieved_tcp_servers = config.get_tcp_stun_servers(); + assert_eq!(retrieved_tcp_servers.unwrap(), custom_tcp_servers); + } + + #[test] + fn test_stun_servers_toml_parsing() { + let config_str = r#" +instance_name = "test" +stun_servers = [ + "stun.l.google.com:19302", + "stun1.l.google.com:19302", + "txt:stun.easytier.cn" +] +tcp_stun_servers = [ + "tcp-stun.example.com:3478" +]"#; + + let config = TomlConfigLoader::new_from_str(config_str).unwrap(); + let stun_servers = config.get_stun_servers().unwrap(); + let tcp_stun_servers = config.get_tcp_stun_servers().unwrap(); + + assert_eq!(stun_servers.len(), 3); + assert_eq!(stun_servers[0], "stun.l.google.com:19302"); + assert_eq!(stun_servers[1], "stun1.l.google.com:19302"); + assert_eq!(stun_servers[2], "txt:stun.easytier.cn"); + assert_eq!(tcp_stun_servers, ["tcp-stun.example.com:3478"]); + } + + #[test] + fn test_empty_tcp_stun_servers_toml_parsing() { + let config = TomlConfigLoader::new_from_str( + r#" +instance_name = "test" +tcp_stun_servers = [] +"#, + ) + .unwrap(); + + assert_eq!(config.get_tcp_stun_servers(), Some(Vec::new())); + } + + #[cfg(feature = "config-write")] + #[test] + fn test_network_config_source_toml_roundtrip() { + let config = TomlConfigLoader::default(); + assert_eq!(config.get_network_config_source(), ConfigSource::User); + + config.set_network_config_source(Some(ConfigSource::Web)); + let dumped = config.dump(); + + assert!(dumped.contains("[source]")); + assert!(dumped.contains("source = \"web\"")); + + let loaded = TomlConfigLoader::new_from_str(&dumped).unwrap(); + assert_eq!(loaded.get_network_config_source(), ConfigSource::Web); + } + + #[cfg(feature = "config-write")] + #[test] + fn test_toml_credential_mode_omits_network_secret() { + for network_secret in ["", r#"network_secret = """#] { + let config = TomlConfigLoader::new_from_str(&format!( + r#" +[network_identity] +network_name = "credential-network" +{network_secret} + +[secure_mode] +enabled = true +"# + )) + .unwrap(); + + let identity = config.get_network_identity(); + assert_eq!(identity.network_name, "credential-network"); + assert_eq!(identity.network_secret, None); + assert_eq!(identity.network_secret_digest, None); + assert!(!config.dump().contains("network_secret")); + } + } + + #[test] + fn test_toml_secure_mode_without_network_identity_uses_default_secret() { + let config = TomlConfigLoader::new_from_str( + r#" +[secure_mode] +enabled = true +"#, + ) + .unwrap(); + + let identity = config.get_network_identity(); + assert_eq!(identity.network_name, "default"); + assert_eq!(identity.network_secret.as_deref(), Some("")); + assert!(identity.network_secret_digest.is_some()); + } + + #[test] + fn test_toml_secure_mode_generates_keypair_when_keys_missing() { + let config = TomlConfigLoader::new_from_str( + r#" +[secure_mode] +enabled = true +"#, + ) + .unwrap(); + + let secure_mode = config.get_secure_mode().unwrap(); + let private_key = secure_mode.private_key().unwrap(); + let public_key = secure_mode.public_key().unwrap(); + assert_eq!( + x25519_dalek::PublicKey::from(&private_key).as_bytes(), + public_key.as_bytes() + ); + } + + #[test] + fn test_toml_secure_mode_derives_public_key_from_private_key() { + let private = x25519_dalek::StaticSecret::random_from_rng(rand::rngs::OsRng); + let config = TomlConfigLoader::new_from_str(&format!( + r#" +[secure_mode] +enabled = true +local_private_key = "{}" +"#, + BASE64_STANDARD.encode(private.as_bytes()) + )) + .unwrap(); + + let secure_mode = config.get_secure_mode().unwrap(); + let private_key = secure_mode.private_key().unwrap(); + assert_eq!(private_key.as_bytes(), private.as_bytes()); + assert_eq!( + secure_mode.public_key().unwrap().as_bytes(), + x25519_dalek::PublicKey::from(&private).as_bytes() + ); + } + + #[test] + fn test_toml_secure_mode_rejects_mismatched_keypair() { + let private = x25519_dalek::StaticSecret::random_from_rng(rand::rngs::OsRng); + let other_public = x25519_dalek::PublicKey::from( + &x25519_dalek::StaticSecret::random_from_rng(rand::rngs::OsRng), + ); + let error = TomlConfigLoader::new_from_str(&format!( + r#" +[secure_mode] +enabled = true +local_private_key = "{}" +local_public_key = "{}" +"#, + BASE64_STANDARD.encode(private.as_bytes()), + BASE64_STANDARD.encode(other_public.as_bytes()) + )) + .unwrap_err(); + let error = format!("{error:#}"); + + assert!( + error.contains("failed to normalize [secure_mode] config"), + "{error}" + ); + assert!( + error.contains("does not match generated public key"), + "{error}" + ); + } + + #[test] + fn test_toml_secure_mode_disabled_keeps_keys_unset() { + let config = TomlConfigLoader::new_from_str( + r#" +[secure_mode] +enabled = false +"#, + ) + .unwrap(); + + let secure_mode = config.get_secure_mode().unwrap(); + assert!(!secure_mode.enabled); + assert_eq!(secure_mode.local_private_key, None); + assert_eq!(secure_mode.local_public_key, None); + } + + #[cfg(feature = "config-write")] + #[test] + fn test_toml_secure_mode_keypair_survives_roundtrip() { + let config = TomlConfigLoader::new_from_str( + r#" +[secure_mode] +enabled = true +"#, + ) + .unwrap(); + + let dumped = config.dump(); + let restored = TomlConfigLoader::new_from_str(&dumped).unwrap(); + + assert_eq!( + config.get_secure_mode().unwrap(), + restored.get_secure_mode().unwrap() + ); + } + + #[test] + fn test_acl_toml_rule_uses_defaults_for_omitted_fields() { + use crate::proto::acl::{Action, ChainType, Protocol}; + + let config_str = r#" +[[acl.acl_v1.chains]] +name = "subnet_proxy_protect" +chain_type = 3 +enabled = true +default_action = 2 + +[[acl.acl_v1.chains.rules]] +name = "allow_my_devices" +priority = 1000 +action = 1 +source_ips = ["10.172.192.2/32"] +protocol = 5 +enabled = true +"#; + + let config = TomlConfigLoader::new_from_str(config_str).unwrap(); + let acl = config.get_acl().unwrap(); + let acl_v1 = acl.acl_v1.unwrap(); + let chain = &acl_v1.chains[0]; + let rule = &chain.rules[0]; + + assert_eq!(chain.chain_type, ChainType::Forward as i32); + assert_eq!(chain.default_action, Action::Drop as i32); + assert_eq!(rule.action, Action::Allow as i32); + assert_eq!(rule.protocol, Protocol::Any as i32); + assert_eq!(rule.source_ips, vec!["10.172.192.2/32"]); + assert!(rule.ports.is_empty()); + assert!(rule.source_ports.is_empty()); + assert!(rule.destination_ips.is_empty()); + assert!(rule.source_groups.is_empty()); + assert!(rule.destination_groups.is_empty()); + assert_eq!(rule.rate_limit, 0); + assert_eq!(rule.burst_limit, 0); + assert!(!rule.stateful); + } + + #[test] + fn test_acl_toml_group_can_omit_declares_or_members() { + let declares_only = r#" +[acl.acl_v1.group] + +[[acl.acl_v1.group.declares]] +group_name = "admin" +group_secret = "admin-pw" +"#; + let config = TomlConfigLoader::new_from_str(declares_only).unwrap(); + let group = config.get_acl().unwrap().acl_v1.unwrap().group.unwrap(); + assert_eq!(group.declares.len(), 1); + assert!(group.members.is_empty()); + + let members_only = r#" +[acl.acl_v1.group] +members = ["admin"] +"#; + let config = TomlConfigLoader::new_from_str(members_only).unwrap(); + let group = config.get_acl().unwrap().acl_v1.unwrap().group.unwrap(); + assert!(group.declares.is_empty()); + assert_eq!(group.members, vec!["admin"]); + } + + #[cfg(feature = "config-write")] + #[test] + fn test_network_config_source_user_is_implicit() { + let config = TomlConfigLoader::default(); + config.set_network_config_source(Some(ConfigSource::User)); + let dumped = config.dump(); + + assert!(!dumped.contains("[source]")); + + let loaded = TomlConfigLoader::new_from_str(&dumped).unwrap(); + assert_eq!(loaded.get_network_config_source(), ConfigSource::User); + + let explicit_user = TomlConfigLoader::new_from_str( + r#" +[source] +source = "user" +"#, + ) + .unwrap(); + assert_eq!( + explicit_user.get_network_config_source(), + ConfigSource::User + ); + assert!(!explicit_user.dump().contains("[source]")); + } + + #[cfg(feature = "config-write")] + #[test] + fn test_ipv6_public_addr_config_roundtrip() { + let config = TomlConfigLoader::default(); + let prefix: cidr::Ipv6Cidr = "2001:db8:100::/64".parse().unwrap(); + + config.set_ipv6_public_addr_provider(true); + config.set_ipv6_public_addr_auto(true); + config.set_ipv6_public_addr_prefix(Some(prefix)); + + assert!(config.get_ipv6_public_addr_provider()); + assert!(config.get_ipv6_public_addr_auto()); + assert_eq!(config.get_ipv6_public_addr_prefix(), Some(prefix)); + + let dumped = config.dump(); + let loaded = TomlConfigLoader::new_from_str(&dumped).unwrap(); + assert!(loaded.get_ipv6_public_addr_provider()); + assert!(loaded.get_ipv6_public_addr_auto()); + assert_eq!(loaded.get_ipv6_public_addr_prefix(), Some(prefix)); + } +} + +#[cfg(test)] +mod full_example_tests { + use super::*; + + #[cfg(feature = "config-write")] + #[test] + fn full_example_test() { + let config_str = r#" +instance_name = "default" +instance_id = "87ede5a2-9c3d-492d-9bbe-989b9d07e742" +ipv4 = "10.144.144.10" +listeners = [ "tcp://0.0.0.0:11010", "udp://0.0.0.0:11010" ] +routes = [ "192.168.0.0/16" ] + +[network_identity] +network_name = "default" +network_secret = "" + +[[peer]] +uri = "tcp://public.kkrainbow.top:11010" + +[[peer]] +uri = "udp://192.168.94.33:11010" + +[[proxy_network]] +cidr = "10.147.223.0/24" +allow = ["tcp", "udp", "icmp"] + +[[proxy_network]] +cidr = "10.1.1.0/24" +allow = ["tcp", "icmp"] + +[file_logger] +level = "info" +file = "easytier" +dir = "/tmp/easytier" + +[console_logger] +level = "warn" + +[[port_forward]] +bind_addr = "0.0.0.0:11011" +dst_addr = "192.168.94.33:11011" +proto = "tcp" +"#; + let ret = TomlConfigLoader::new_from_str(config_str); + if let Err(e) = &ret { + println!("{}", e); + } else { + println!("{:?}", ret.as_ref().unwrap()); + } + assert!(ret.is_ok()); + + let ret = ret.unwrap(); + assert_eq!("10.144.144.10/24", ret.get_ipv4().unwrap().to_string()); + + assert_eq!( + vec!["tcp://0.0.0.0:11010", "udp://0.0.0.0:11010"], + ret.get_listener_uris() + .iter() + .map(|u| u.to_string()) + .collect::>() + ); + + assert_eq!( + vec![PortForwardConfig { + bind_addr: "0.0.0.0:11011".parse().unwrap(), + dst_addr: "192.168.94.33:11011".parse().unwrap(), + proto: "tcp".to_string(), + }], + ret.get_port_forwards() + ); + println!("{}", ret.dump()); + } +} + +#[cfg(test)] +mod diagnostic_compatibility_tests { + use super::*; + + #[test] + fn stdin_source_name_and_caret_are_preserved() { + let error = TomlConfig::new_from_str_with_source("stdin", "dhcp = \"yes\"") + .unwrap_err() + .to_string(); + + assert!(error.contains("stdin")); + assert!(error.contains("dhcp = \"yes\"")); + assert!(error.contains('^')); + assert!(!error.contains("")); + } + + #[test] + fn non_ascii_before_typed_error_keeps_byte_location() { + let error = TomlConfig::new_from_str("hostname = \"节点\"\ndhcp = \"yes\"") + .unwrap_err() + .to_string(); + + assert!(error.contains("dhcp = \"yes\"")); + assert!(error.contains('^')); + assert!(error.contains("invalid type: string")); + } + + #[cfg(feature = "rich-config-errors")] + #[test] + fn non_ascii_on_syntax_error_line_keeps_source_location() { + let error = TomlConfig::new_from_str("hostname = \"节点\" dhcp = \"yes\"") + .unwrap_err() + .to_string(); + + assert!(error.contains("inline config:1:")); + assert!(error.contains("hostname = \"节点\" dhcp = \"yes\"")); + assert!(error.contains("expected newline")); + assert!(!error.contains("")); + } + + #[test] + fn flags_conversion_error_keeps_source_and_cause_chain() { + let error = TomlConfig::new_from_str_with_source( + "flags-fixture.toml", + "[flags]\nsocket_mark = \"bad\"", + ) + .unwrap_err(); + let display = error.to_string(); + + assert!(display.contains("flags-fixture.toml")); + assert!(display.contains("failed to load config")); + assert!(display.contains("failed to parse flags")); + assert!( + error + .chain() + .any(|cause| cause.to_string().contains("failed to parse flags")) + ); + } +} diff --git a/vendor/easytier/easytier-core/src/config/toml/snapshot.rs b/vendor/easytier/easytier-core/src/config/toml/snapshot.rs new file mode 100644 index 0000000..f3bb7e9 --- /dev/null +++ b/vendor/easytier/easytier-core/src/config/toml/snapshot.rs @@ -0,0 +1,15 @@ +use super::{Arc, Mutex, TomlConfig}; + +impl TomlConfig { + pub(crate) fn detached_snapshot(&self) -> Self { + let config = self.config.lock().unwrap().clone(); + Self { + config: Arc::new(Mutex::new(config)), + } + } + + pub(crate) fn replace_from_snapshot(&self, snapshot: &Self) { + let config = snapshot.config.lock().unwrap().clone(); + *self.config.lock().unwrap() = config; + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/composite.rs b/vendor/easytier/easytier-core/src/connectivity/composite.rs new file mode 100644 index 0000000..6eb3bfe --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/composite.rs @@ -0,0 +1,496 @@ +//! Composes process-wide socket capabilities with instance-scoped network facts. + +use std::{ + future::Future, + net::{IpAddr, Ipv6Addr, SocketAddr}, + sync::Arc, + time::{Duration, Instant}, +}; + +use async_trait::async_trait; +use url::Url; + +use crate::{ + connectivity::{ + direct::DirectConnectorHost, + manual::{ManualConnectorHost, ManualInterfaceAddrs}, + transport::ConnectedByteStream, + }, + proto::peer_rpc::GetIpListResponse, + socket::{ + SocketContext, + tcp::{ + TcpConnectOptions, TcpListenOptions, VirtualTcpListenerFactory, VirtualTcpSocketFactory, + }, + udp::{PreferredIpv6Source, UdpBindOptions, VirtualUdpSocketFactory}, + }, +}; + +const INTERFACE_ADDR_CACHE_TTL: Duration = Duration::from_secs(60); + +#[derive(Clone)] +struct CachedInterfaceAddrs { + collected_at: Instant, + response: GetIpListResponse, +} + +struct InterfaceAddrCacheEntry { + context: SocketContext, + value: Arc>>, +} + +struct InterfaceAddrCache { + entries: tokio::sync::Mutex>, + ttl: Duration, +} + +impl InterfaceAddrCache { + fn new(ttl: Duration) -> Self { + Self { + entries: tokio::sync::Mutex::new(Vec::new()), + ttl, + } + } + + async fn get_or_collect(&self, context: &SocketContext, collect: F) -> GetIpListResponse + where + F: FnOnce() -> Fut, + Fut: Future, + { + let value = { + let mut entries = self.entries.lock().await; + entries.retain(|entry| { + if Arc::strong_count(&entry.value) > 1 { + return true; + } + entry.value.try_lock().map_or(true, |cached| { + cached + .as_ref() + .is_some_and(|cached| cached.collected_at.elapsed() < self.ttl) + }) + }); + if let Some(entry) = entries.iter().find(|entry| &entry.context == context) { + entry.value.clone() + } else { + let value = Arc::new(tokio::sync::Mutex::new(None)); + entries.push(InterfaceAddrCacheEntry { + context: context.clone(), + value: value.clone(), + }); + value + } + }; + + // Only collectors for the same socket context share this lock. A slow + // namespace observation cannot block fresh hits or refreshes elsewhere. + let mut cached = value.lock().await; + if let Some(cached) = cached + .as_ref() + .filter(|cached| cached.collected_at.elapsed() < self.ttl) + { + return cached.response.clone(); + } + + let response = collect().await; + *cached = Some(CachedInterfaceAddrs { + collected_at: Instant::now(), + response: response.clone(), + }); + response + } +} + +/// Mechanical connector operations supplied by one process-wide runtime. +#[async_trait] +pub trait ConnectorRuntime: VirtualTcpSocketFactory + Send + Sync + 'static { + fn supports_external_tunnel(&self, _scheme: &str) -> bool { + false + } + + async fn connect_external_tunnel( + &self, + _url: &Url, + ) -> anyhow::Result>> { + Ok(None) + } + + async fn connect_byte_stream( + &self, + url: &Url, + ) -> anyhow::Result>; + + async fn local_addr_for_remote( + &self, + remote_addr: SocketAddr, + context: SocketContext, + ) -> anyhow::Result; + + async fn collect_ip_addrs(&self, context: &SocketContext) -> GetIpListResponse; + + async fn preferred_ipv6_source( + &self, + ip: Ipv6Addr, + context: SocketContext, + ) -> Option; +} + +/// Instance facts consumed by portable connector policy. +/// +/// Socket creation, route probing and host interface I/O are deliberately +/// absent; those belong to the process-wide [`ConnectorRuntime`]. +pub trait ConnectorEnvironment: Send + Sync + 'static { + fn socket_context(&self) -> SocketContext; + + fn mapped_listeners(&self) -> Vec; + fn is_local_ip(&self, ip: &IpAddr) -> bool; +} + +/// Deep adapter that combines one socket runtime with one instance environment. +pub struct ConnectorHostAdapter { + sockets: Arc, + environment: Arc, + interface_addrs: InterfaceAddrCache, +} + +impl ConnectorHostAdapter { + pub fn new(sockets: Arc, environment: Arc) -> Self { + Self { + sockets, + environment, + interface_addrs: InterfaceAddrCache::new(INTERFACE_ADDR_CACHE_TTL), + } + } +} + +impl ConnectorHostAdapter +where + S: ConnectorRuntime, +{ + async fn cached_ip_addrs(&self, context: &SocketContext) -> GetIpListResponse { + self.interface_addrs + .get_or_collect(context, || self.sockets.collect_ip_addrs(context)) + .await + } +} + +#[async_trait] +impl VirtualTcpSocketFactory for ConnectorHostAdapter +where + S: VirtualTcpSocketFactory, + E: Send + Sync + 'static, +{ + type Socket = S::Socket; + + async fn connect_tcp(&self, options: TcpConnectOptions) -> anyhow::Result { + self.sockets.connect_tcp(options).await + } +} + +#[async_trait] +impl VirtualTcpListenerFactory for ConnectorHostAdapter +where + S: VirtualTcpListenerFactory, + E: Send + Sync + 'static, +{ + type Listener = S::Listener; + + async fn bind_tcp(&self, options: TcpListenOptions) -> anyhow::Result> { + self.sockets.bind_tcp(options).await + } +} + +#[async_trait] +impl VirtualUdpSocketFactory for ConnectorHostAdapter +where + S: VirtualUdpSocketFactory, + E: Send + Sync + 'static, +{ + type Socket = S::Socket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.sockets.bind_udp(options).await + } +} + +#[async_trait] +impl ManualConnectorHost for ConnectorHostAdapter +where + S: ConnectorRuntime + VirtualUdpSocketFactory, + E: ConnectorEnvironment, +{ + fn supports_external_tunnel(&self, scheme: &str) -> bool { + self.sockets.supports_external_tunnel(scheme) + } + + async fn connect_external_tunnel( + &self, + url: &Url, + ) -> anyhow::Result>> { + self.sockets.connect_external_tunnel(url).await + } + + async fn local_addr_for_remote( + &self, + remote_addr: SocketAddr, + context: SocketContext, + ) -> anyhow::Result { + self.sockets + .local_addr_for_remote(remote_addr, context) + .await + } + + async fn interface_addrs(&self) -> anyhow::Result { + let addrs = self + .cached_ip_addrs(&self.environment.socket_context()) + .await; + Ok(ManualInterfaceAddrs { + interface_ipv4s: addrs + .interface_ipv4s + .into_iter() + .map(std::net::Ipv4Addr::from) + .collect(), + interface_ipv6s: addrs + .interface_ipv6s + .into_iter() + .map(std::net::Ipv6Addr::from) + .collect(), + public_ipv6: addrs.public_ipv6.map(std::net::Ipv6Addr::from), + }) + } + + async fn connect_byte_stream( + &self, + url: &Url, + ) -> anyhow::Result::Socket>> { + self.sockets.connect_byte_stream(url).await + } +} + +#[async_trait] +impl DirectConnectorHost for ConnectorHostAdapter +where + S: ConnectorRuntime + VirtualUdpSocketFactory, + E: ConnectorEnvironment, +{ + async fn collect_ip_addrs(&self, context: &SocketContext) -> GetIpListResponse { + self.cached_ip_addrs(context).await + } + + async fn collect_foreign_ip_addrs(&self, context: &SocketContext) -> GetIpListResponse { + self.cached_ip_addrs(context).await + } + + fn mapped_listeners(&self) -> Vec { + self.environment.mapped_listeners() + } + + fn is_local_ip(&self, ip: &IpAddr) -> bool { + self.environment.is_local_ip(ip) + } + + async fn preferred_ipv6_source( + &self, + ip: Ipv6Addr, + context: SocketContext, + ) -> Option { + if !valid_public_ipv6_candidate(ip) { + return None; + } + self.sockets.preferred_ipv6_source(ip, context).await + } + + async fn preferred_foreign_ipv6_source( + &self, + ip: Ipv6Addr, + context: SocketContext, + ) -> Option { + if !valid_public_ipv6_candidate(ip) { + return None; + } + self.sockets.preferred_ipv6_source(ip, context).await + } +} + +fn valid_public_ipv6_candidate(ip: Ipv6Addr) -> bool { + !(ip.is_loopback() + || ip.is_unspecified() + || ip.is_unique_local() + || ip.is_unicast_link_local() + || ip.is_multicast()) +} + +#[cfg(test)] +mod tests { + use std::sync::atomic::{AtomicUsize, Ordering}; + + use tokio::sync::oneshot; + + use super::*; + use crate::socket::{IpVersion, NetNamespace}; + + #[tokio::test] + async fn concurrent_cache_misses_share_one_collection() { + let cache = Arc::new(InterfaceAddrCache::new(Duration::from_secs(60))); + let context = SocketContext::default(); + let calls = Arc::new(AtomicUsize::new(0)); + let (started_tx, started_rx) = oneshot::channel(); + let (release_tx, release_rx) = oneshot::channel(); + + let first = tokio::spawn({ + let cache = cache.clone(); + let context = context.clone(); + let calls = calls.clone(); + async move { + cache + .get_or_collect(&context, || async move { + calls.fetch_add(1, Ordering::SeqCst); + let _ = started_tx.send(()); + let _ = release_rx.await; + GetIpListResponse::default() + }) + .await + } + }); + started_rx.await.unwrap(); + + let (second_started_tx, second_started_rx) = oneshot::channel(); + let second = tokio::spawn({ + let cache = cache.clone(); + let context = context.clone(); + let calls = calls.clone(); + async move { + let _ = second_started_tx.send(()); + cache + .get_or_collect(&context, || async move { + calls.fetch_add(1, Ordering::SeqCst); + GetIpListResponse::default() + }) + .await + } + }); + second_started_rx.await.unwrap(); + tokio::task::yield_now().await; + let _ = release_tx.send(()); + + first.await.unwrap(); + second.await.unwrap(); + assert_eq!(calls.load(Ordering::SeqCst), 1); + } + + #[tokio::test] + async fn cache_keys_include_the_complete_socket_context() { + let cache = InterfaceAddrCache::new(Duration::from_secs(60)); + let calls = AtomicUsize::new(0); + let contexts = [ + SocketContext::default(), + SocketContext::default().with_ip_version(IpVersion::V4), + SocketContext::default().with_socket_mark(Some(7)), + SocketContext::default().with_netns(Some(NetNamespace::new("foreign-a"))), + ]; + + for context in &contexts { + cache + .get_or_collect(context, || async { + calls.fetch_add(1, Ordering::SeqCst); + GetIpListResponse::default() + }) + .await; + } + cache + .get_or_collect(&contexts[0], || async { + calls.fetch_add(1, Ordering::SeqCst); + GetIpListResponse::default() + }) + .await; + + assert_eq!(calls.load(Ordering::SeqCst), contexts.len()); + } + + #[tokio::test] + async fn slow_collection_does_not_block_a_different_context() { + let cache = Arc::new(InterfaceAddrCache::new(Duration::from_secs(60))); + let slow_context = SocketContext::default().with_socket_mark(Some(1)); + let other_context = SocketContext::default().with_socket_mark(Some(2)); + let (started_tx, started_rx) = oneshot::channel(); + let (release_tx, release_rx) = oneshot::channel(); + let slow = tokio::spawn({ + let cache = cache.clone(); + async move { + cache + .get_or_collect(&slow_context, || async move { + let _ = started_tx.send(()); + let _ = release_rx.await; + GetIpListResponse::default() + }) + .await + } + }); + started_rx.await.unwrap(); + + tokio::time::timeout( + Duration::from_millis(100), + cache.get_or_collect(&other_context, || async { GetIpListResponse::default() }), + ) + .await + .expect("different socket contexts must collect independently"); + + let _ = release_tx.send(()); + slow.await.unwrap(); + } + + #[tokio::test] + async fn slow_collection_does_not_block_a_fresh_hit() { + let cache = Arc::new(InterfaceAddrCache::new(Duration::from_secs(60))); + let cached_context = SocketContext::default().with_socket_mark(Some(1)); + let slow_context = SocketContext::default().with_socket_mark(Some(2)); + cache + .get_or_collect(&cached_context, || async { GetIpListResponse::default() }) + .await; + + let (started_tx, started_rx) = oneshot::channel(); + let (release_tx, release_rx) = oneshot::channel(); + let slow = tokio::spawn({ + let cache = cache.clone(); + async move { + cache + .get_or_collect(&slow_context, || async move { + let _ = started_tx.send(()); + let _ = release_rx.await; + GetIpListResponse::default() + }) + .await + } + }); + started_rx.await.unwrap(); + + tokio::time::timeout( + Duration::from_millis(100), + cache.get_or_collect(&cached_context, || async { + panic!("fresh cache hit must not recollect") + }), + ) + .await + .expect("fresh hit must not wait for another socket context"); + + let _ = release_tx.send(()); + slow.await.unwrap(); + } + + #[tokio::test] + async fn expired_entries_are_recollected() { + let cache = InterfaceAddrCache::new(Duration::ZERO); + let calls = AtomicUsize::new(0); + let context = SocketContext::default(); + + for _ in 0..2 { + cache + .get_or_collect(&context, || async { + calls.fetch_add(1, Ordering::SeqCst); + GetIpListResponse::default() + }) + .await; + } + + assert_eq!(calls.load(Ordering::SeqCst), 2); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/connector_host.rs b/vendor/easytier/easytier-core/src/connectivity/connector_host.rs new file mode 100644 index 0000000..c96e5e7 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/connector_host.rs @@ -0,0 +1,797 @@ +//! Host-operation Adapter for the shared connector composition. +//! +//! This module was previously named `host`, which collided with the +//! top-level [`crate::host`] layer, and one concept was split across two +//! same-named `environment.rs` files. The ownership split is: +//! +//! - Mechanical environment queries implement +//! [`crate::host::environment::HostConnectorEnvironmentIo`]. +//! - [`HostConnectorRuntime`] adapts host socket/listener factories and an +//! injected environment snapshot to the shared connector runtime and +//! environment traits. +//! - [`HostConnectorEnvironmentSnapshot`] is connectivity's captured view of +//! the host environment. + +use std::{ + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr}, + sync::Arc, +}; + +use async_trait::async_trait; +use serde::{Deserialize, Serialize}; +use url::Url; + +use crate::{ + connectivity::{ + composite::{ConnectorEnvironment, ConnectorHostAdapter, ConnectorRuntime}, + manual::ExternalTunnelConnector, + transport::ConnectedByteStream, + }, + host::environment::{HostConnectorEnvironmentIo, local_addr_for_remote}, + host::socket::{ + HostSocketRuntime, HostTcpStream, + factory::{HostSocketBackend, HostSocketFactory}, + listener::{HostTcpListener, HostTcpListenerBackend, HostTcpListenerFactory}, + udp::HostUdpSocket, + }, + proto::peer_rpc::GetIpListResponse, + socket::{ + SocketContext, + tcp::{ + TcpConnectOptions, TcpListenOptions, VirtualTcpListenerFactory, VirtualTcpSocketFactory, + }, + udp::{PreferredIpv6Source, UdpBindOptions, VirtualUdpSocketFactory}, + }, +}; + +/// Host-observed facts consumed by core connector policy. +/// +/// The host normalizes this snapshot before constructing an instance. Core +/// owns all selection and connection policy applied to these facts. +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub struct HostConnectorEnvironmentSnapshot { + pub public_ipv4: Option, + pub interface_ipv4s: Vec, + pub public_ipv6: Option, + pub interface_ipv6s: Vec, + pub mapped_listeners: Vec, + pub local_ips: Vec, + pub protected_tcp_ports: Vec, + pub preferred_ipv6_sources: Vec, +} + +impl HostConnectorEnvironmentSnapshot { + fn ip_list(&self) -> GetIpListResponse { + GetIpListResponse { + public_ipv4: self.public_ipv4.map(Into::into), + interface_ipv4s: self + .interface_ipv4s + .iter() + .copied() + .map(Into::into) + .collect(), + public_ipv6: self.public_ipv6.map(Into::into), + interface_ipv6s: self + .interface_ipv6s + .iter() + .copied() + .map(Into::into) + .collect(), + listeners: Default::default(), + } + } + + fn preferred_ipv6_source(&self, ip: Ipv6Addr) -> Option { + if ip.is_loopback() + || ip.is_unspecified() + || ip.is_unique_local() + || ip.is_unicast_link_local() + || ip.is_multicast() + { + return None; + } + self.preferred_ipv6_sources + .iter() + .find(|source| source.ip == ip) + .copied() + } +} + +/// One host handle domain capable of creating and operating connector sockets. +pub trait ConnectorHostSocketBackend: HostSocketBackend + HostTcpListenerBackend {} + +impl ConnectorHostSocketBackend for T where T: HostSocketBackend + HostTcpListenerBackend {} + +/// Adapts mechanical host sockets and captured environment state to the +/// shared connector composition. +pub struct HostConnectorRuntime +where + B: ConnectorHostSocketBackend, + E: HostConnectorEnvironmentIo, +{ + socket_runtime: HostSocketRuntime, + sockets: HostSocketFactory, + listeners: HostTcpListenerFactory, + environment: Arc, + environment_io: Arc, + external_tunnel_connector: Option>, +} + +impl HostConnectorRuntime +where + B: ConnectorHostSocketBackend, + E: HostConnectorEnvironmentIo, +{ + pub fn new( + runtime: HostSocketRuntime, + backend: Arc, + environment: HostConnectorEnvironmentSnapshot, + environment_io: Arc, + ) -> Self { + Self { + socket_runtime: runtime.clone(), + sockets: HostSocketFactory::new(runtime.clone(), backend.clone()), + listeners: HostTcpListenerFactory::new(runtime, backend), + environment: Arc::new(environment), + environment_io, + external_tunnel_connector: None, + } + } + + pub fn with_external_tunnel_connector( + mut self, + connector: Arc, + ) -> Self { + self.external_tunnel_connector = Some(connector); + self + } +} + +#[async_trait] +impl VirtualTcpSocketFactory for HostConnectorRuntime +where + B: ConnectorHostSocketBackend, + E: HostConnectorEnvironmentIo, +{ + type Socket = HostTcpStream; + + async fn connect_tcp(&self, options: TcpConnectOptions) -> anyhow::Result { + self.sockets.connect_tcp(options).await + } +} + +#[async_trait] +impl VirtualUdpSocketFactory for HostConnectorRuntime +where + B: ConnectorHostSocketBackend, + E: HostConnectorEnvironmentIo, +{ + type Socket = HostUdpSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.sockets.bind_udp(options).await + } +} + +#[async_trait] +impl VirtualTcpListenerFactory for HostConnectorRuntime +where + B: ConnectorHostSocketBackend, + E: HostConnectorEnvironmentIo, +{ + type Listener = HostTcpListener; + + async fn bind_tcp(&self, options: TcpListenOptions) -> anyhow::Result> { + self.listeners.bind_tcp(options).await + } +} + +#[async_trait] +impl ConnectorRuntime for HostConnectorRuntime +where + B: ConnectorHostSocketBackend, + E: HostConnectorEnvironmentIo, +{ + fn supports_external_tunnel(&self, scheme: &str) -> bool { + self.external_tunnel_connector + .as_ref() + .is_some_and(|connector| connector.supports_scheme(scheme)) + } + + async fn connect_external_tunnel( + &self, + url: &Url, + ) -> anyhow::Result>> { + let Some(connector) = &self.external_tunnel_connector else { + return Ok(None); + }; + if !connector.supports_scheme(url.scheme()) { + return Ok(None); + } + Ok(Some(connector.connect(url).await?)) + } + + async fn connect_byte_stream( + &self, + url: &Url, + ) -> anyhow::Result> { + anyhow::bail!("host does not support external byte stream: {url}") + } + + async fn local_addr_for_remote( + &self, + remote_addr: SocketAddr, + context: SocketContext, + ) -> anyhow::Result { + local_addr_for_remote( + &self.socket_runtime, + self.environment_io.clone(), + remote_addr, + context, + ) + .await + } + + async fn collect_ip_addrs(&self, _context: &SocketContext) -> GetIpListResponse { + self.environment.ip_list() + } + + async fn preferred_ipv6_source( + &self, + ip: Ipv6Addr, + _context: SocketContext, + ) -> Option { + self.environment.preferred_ipv6_source(ip) + } +} + +impl ConnectorEnvironment for HostConnectorRuntime +where + B: ConnectorHostSocketBackend, + E: HostConnectorEnvironmentIo, +{ + fn socket_context(&self) -> SocketContext { + SocketContext::default() + } + + fn mapped_listeners(&self) -> Vec { + self.environment.mapped_listeners.clone() + } + + fn is_local_ip(&self, ip: &IpAddr) -> bool { + self.environment.local_ips.contains(ip) + } +} + +/// Shared connector policy composed with a host-operation runtime. +pub type ConnectorHost = + ConnectorHostAdapter, HostConnectorRuntime>; + +/// Builds the shared connector host over one host-operation backend. +pub fn new_connector_host( + socket_runtime: HostSocketRuntime, + backend: Arc, + environment: HostConnectorEnvironmentSnapshot, + environment_io: Arc, +) -> ConnectorHost +where + B: ConnectorHostSocketBackend, + E: HostConnectorEnvironmentIo, +{ + let runtime = Arc::new(HostConnectorRuntime::new( + socket_runtime, + backend, + environment, + environment_io, + )); + ConnectorHostAdapter::new(runtime.clone(), runtime) +} + +pub fn new_connector_host_with_external_tunnel( + socket_runtime: HostSocketRuntime, + backend: Arc, + environment: HostConnectorEnvironmentSnapshot, + environment_io: Arc, + connector: Arc, +) -> ConnectorHost +where + B: ConnectorHostSocketBackend, + E: HostConnectorEnvironmentIo, +{ + let runtime = Arc::new( + HostConnectorRuntime::new(socket_runtime, backend, environment, environment_io) + .with_external_tunnel_connector(connector), + ); + ConnectorHostAdapter::new(runtime.clone(), runtime) +} + +#[cfg(test)] +mod tests { + use std::{ + io, + sync::{ + Mutex, + atomic::{AtomicBool, Ordering}, + }, + task::Poll, + }; + + use crate::{ + connectivity::{ + direct::{DirectConnectorHost, DirectConnectorRpcHandler}, + hole_punch::tcp::TcpHolePunchHost, + manual::ManualConnectorHost, + stun::StunInfoProvider, + }, + host::socket::{ + HostOperationId, HostSocketHandle, HostSocketIo, HostTcpIo, + factory::{HostSocketFactoryIo, HostTcpConnectResult, HostUdpBindResult}, + listener::{HostTcpBindResult, HostTcpListenerIo}, + udp::{HostUdpDatagram, HostUdpIo}, + }, + proto::{ + common::StunInfo, + peer_rpc::{DirectConnectorRpc as _, GetIpListRequest}, + rpc_types::controller::BaseController, + }, + socket::udp::UdpSocketSendMeta, + }; + + use super::*; + + #[derive(Default)] + struct UnsupportedBackend { + udp_send_attempts: Mutex, SocketAddr, UdpSocketSendMeta)>>, + reject_preferred_source: AtomicBool, + } + + struct FixedStunProvider; + + struct ExternalFailingConnector; + + #[async_trait] + impl ExternalTunnelConnector for ExternalFailingConnector { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "ws" + } + + async fn connect(&self, _url: &Url) -> anyhow::Result> { + anyhow::bail!("external connector called") + } + } + + #[async_trait] + impl StunInfoProvider for FixedStunProvider { + fn get_stun_info(&self) -> StunInfo { + StunInfo { + public_ip: vec!["198.51.100.7".to_owned(), "2001:db8::1".to_owned()], + ..Default::default() + } + } + + async fn get_udp_port_mapping(&self, _local_port: u16) -> anyhow::Result { + anyhow::bail!("unused by direct RPC projection test") + } + + async fn get_tcp_port_mapping(&self, _local_port: u16) -> anyhow::Result { + anyhow::bail!("unused by direct RPC projection test") + } + + fn update_stun_info(&self) {} + } + + fn unsupported() -> io::Result { + Err(io::ErrorKind::Unsupported.into()) + } + + impl HostSocketIo for UnsupportedBackend { + fn cancel_operation(&self, _operation: HostOperationId) -> io::Result<()> { + Ok(()) + } + + fn close(&self, _handle: HostSocketHandle) -> io::Result<()> { + Ok(()) + } + } + + impl HostTcpIo for UnsupportedBackend { + fn submit_read( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + _capacity: usize, + ) -> io::Result<()> { + unsupported() + } + + fn take_read(&self, _operation: HostOperationId) -> Poll>> { + Poll::Ready(unsupported()) + } + + fn submit_write( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + _source: &[u8], + ) -> io::Result<()> { + unsupported() + } + + fn take_write(&self, _operation: HostOperationId) -> Poll> { + Poll::Ready(unsupported()) + } + } + + impl HostUdpIo for UnsupportedBackend { + fn submit_recv( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + _capacity: usize, + ) -> io::Result<()> { + unsupported() + } + + fn take_recv(&self, _operation: HostOperationId) -> Poll> { + Poll::Ready(unsupported()) + } + + fn try_send( + &self, + _handle: HostSocketHandle, + source: &[u8], + peer_addr: SocketAddr, + meta: UdpSocketSendMeta, + ) -> io::Result<()> { + self.udp_send_attempts + .lock() + .unwrap() + .push((source.to_vec(), peer_addr, meta)); + if self.reject_preferred_source.load(Ordering::Relaxed) && meta.src_ip.is_some() { + return Err(io::ErrorKind::AddrNotAvailable.into()); + } + Ok(()) + } + + fn submit_send_ready( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + ) -> io::Result<()> { + unsupported() + } + + fn take_send_ready(&self, _operation: HostOperationId) -> Poll> { + Poll::Ready(unsupported()) + } + } + + impl HostSocketFactoryIo for UnsupportedBackend { + fn submit_tcp_connect( + &self, + _operation: HostOperationId, + _options: &TcpConnectOptions, + ) -> io::Result<()> { + unsupported() + } + + fn take_tcp_connect( + &self, + _operation: HostOperationId, + ) -> Poll> { + Poll::Ready(unsupported()) + } + + fn submit_udp_bind( + &self, + _operation: HostOperationId, + _options: &UdpBindOptions, + ) -> io::Result<()> { + unsupported() + } + + fn take_udp_bind( + &self, + _operation: HostOperationId, + ) -> Poll> { + Poll::Ready(unsupported()) + } + } + + impl HostTcpListenerIo for UnsupportedBackend { + fn submit_tcp_bind( + &self, + _operation: HostOperationId, + _options: &TcpListenOptions, + ) -> io::Result<()> { + unsupported() + } + + fn take_tcp_bind( + &self, + _operation: HostOperationId, + ) -> Poll> { + Poll::Ready(unsupported()) + } + + fn submit_tcp_accept( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + ) -> io::Result<()> { + unsupported() + } + + fn take_tcp_accept( + &self, + _operation: HostOperationId, + ) -> Poll> { + Poll::Ready(unsupported()) + } + } + + #[derive(Default)] + struct TestEnvironmentIo { + local_requests: Mutex>, + ready: Mutex>, + } + + impl HostConnectorEnvironmentIo for TestEnvironmentIo { + fn submit_local_addr_for_remote( + &self, + operation: HostOperationId, + remote_addr: SocketAddr, + context: &SocketContext, + ) -> io::Result<()> { + self.local_requests + .lock() + .unwrap() + .push((remote_addr, context.clone())); + self.ready.lock().unwrap().push(operation); + Ok(()) + } + + fn take_local_addr_for_remote( + &self, + operation: HostOperationId, + ) -> Poll> { + let mut ready = self.ready.lock().unwrap(); + let Some(index) = ready.iter().position(|candidate| *candidate == operation) else { + return Poll::Pending; + }; + ready.swap_remove(index); + Poll::Ready(Ok("192.0.2.1:40100".parse().unwrap())) + } + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.ready + .lock() + .unwrap() + .retain(|candidate| *candidate != operation); + Ok(()) + } + } + + fn test_environment_snapshot() -> HostConnectorEnvironmentSnapshot { + HostConnectorEnvironmentSnapshot { + interface_ipv4s: vec!["192.0.2.1".parse().unwrap()], + public_ipv6: Some("2001:db8::1".parse().unwrap()), + interface_ipv6s: vec!["2001:db8::1".parse().unwrap()], + mapped_listeners: vec!["tcp://192.0.2.1:11010".parse().unwrap()], + local_ips: vec!["192.0.2.1".parse().unwrap()], + protected_tcp_ports: vec![11010], + preferred_ipv6_sources: vec![PreferredIpv6Source { + ip: "2001:db8::1".parse().unwrap(), + ifindex: 7, + }], + ..Default::default() + } + } + + fn assert_core_host() + where + H: DirectConnectorHost + TcpHolePunchHost, + { + } + + #[tokio::test] + async fn delegates_connector_environment_without_owning_policy() { + type TestHost = ConnectorHost; + assert_core_host::(); + + let environment_io = Arc::new(TestEnvironmentIo::default()); + let host = new_connector_host( + HostSocketRuntime::new(), + Arc::new(UnsupportedBackend::default()), + test_environment_snapshot(), + environment_io.clone(), + ); + let remote = "203.0.113.1:11010".parse().unwrap(); + let context = SocketContext::default().with_socket_mark(Some(7)); + let local = ManualConnectorHost::local_addr_for_remote(&host, remote, context.clone()) + .await + .unwrap(); + assert_eq!(local, "192.0.2.1:40100".parse().unwrap()); + assert_eq!( + *environment_io.local_requests.lock().unwrap(), + vec![(remote, context)] + ); + assert_eq!( + ManualConnectorHost::interface_addrs(&host) + .await + .unwrap() + .public_ipv6, + Some("2001:db8::1".parse().unwrap()) + ); + let byte_stream_error = + match ManualConnectorHost::connect_byte_stream(&host, &"ring://42".parse().unwrap()) + .await + { + Ok(_) => panic!("test environment should reject byte streams"), + Err(error) => error, + }; + assert_eq!( + byte_stream_error.to_string(), + "host does not support external byte stream: ring://42" + ); + assert_eq!( + DirectConnectorHost::mapped_listeners(&host), + vec!["tcp://192.0.2.1:11010".parse::().unwrap()] + ); + } + + #[tokio::test] + async fn delegates_external_tunnel_connections() { + let host = new_connector_host_with_external_tunnel( + HostSocketRuntime::new(), + Arc::new(UnsupportedBackend::default()), + test_environment_snapshot(), + Arc::new(TestEnvironmentIo::default()), + Arc::new(ExternalFailingConnector), + ); + + let error = ManualConnectorHost::connect_external_tunnel( + &host, + &"ws://relay.example/".parse().unwrap(), + ) + .await + .unwrap_err(); + assert_eq!(error.to_string(), "external connector called"); + assert!( + ManualConnectorHost::connect_external_tunnel( + &host, + &"tcp://relay.example:11010".parse().unwrap(), + ) + .await + .unwrap() + .is_none() + ); + } + + #[tokio::test] + async fn direct_rpc_projects_host_observations_without_instance_policy() { + let host = Arc::new(new_connector_host( + HostSocketRuntime::new(), + Arc::new(UnsupportedBackend::default()), + test_environment_snapshot(), + Arc::new(TestEnvironmentIo::default()), + )); + let handler = DirectConnectorRpcHandler::new_with_stun( + host, + SocketContext::default().with_socket_mark(Some(7)), + Some(Arc::new(FixedStunProvider)), + ); + + let response = handler + .get_ip_list(BaseController::default(), GetIpListRequest {}) + .await + .unwrap(); + + assert_eq!( + response.interface_ipv4s, + vec![std::net::Ipv4Addr::new(192, 0, 2, 1).into()] + ); + assert_eq!( + response.interface_ipv6s, + vec!["2001:db8::1".parse::().unwrap().into()] + ); + assert_eq!( + response.public_ipv4, + Some("198.51.100.7".parse::().unwrap().into()) + ); + assert_eq!( + response.public_ipv6, + Some("2001:db8::1".parse::().unwrap().into()) + ); + assert_eq!( + response + .listeners + .into_iter() + .map(Url::from) + .collect::>(), + vec!["tcp://192.0.2.1:11010".parse::().unwrap()] + ); + } + + #[tokio::test] + async fn foreign_direct_rpc_preserves_parent_managed_ipv6_addresses() { + let host = Arc::new(new_connector_host( + HostSocketRuntime::new(), + Arc::new(UnsupportedBackend::default()), + test_environment_snapshot(), + Arc::new(TestEnvironmentIo::default()), + )); + let handler = DirectConnectorRpcHandler::new_for_foreign_network_with_stun( + host, + SocketContext::default().with_socket_mark(Some(7)), + Some(Arc::new(FixedStunProvider)), + ); + + let response = handler + .get_ip_list(BaseController::default(), GetIpListRequest {}) + .await + .unwrap(); + + assert_eq!( + response.interface_ipv6s, + vec!["2001:db8::1".parse::().unwrap().into()] + ); + assert_eq!( + response.public_ipv6, + Some("2001:db8::1".parse::().unwrap().into()) + ); + assert_eq!( + response.public_ipv4, + Some("198.51.100.7".parse::().unwrap().into()) + ); + } + + fn snapshot() -> HostConnectorEnvironmentSnapshot { + HostConnectorEnvironmentSnapshot { + public_ipv4: Some("198.51.100.1".parse().unwrap()), + interface_ipv4s: vec!["192.0.2.1".parse().unwrap()], + public_ipv6: Some("2001:db8::1".parse().unwrap()), + interface_ipv6s: vec!["2001:db8::2".parse().unwrap()], + mapped_listeners: vec!["tcp://198.51.100.1:11010".parse().unwrap()], + local_ips: vec!["192.0.2.1".parse().unwrap()], + protected_tcp_ports: vec![11010], + preferred_ipv6_sources: vec![ + PreferredIpv6Source { + ip: "2001:db8::2".parse().unwrap(), + ifindex: 7, + }, + PreferredIpv6Source { + ip: "fd00::1".parse().unwrap(), + ifindex: 8, + }, + ], + } + } + + #[test] + fn projects_normalized_snapshot() { + let snapshot = snapshot(); + assert_eq!( + serde_json::from_slice::( + &serde_json::to_vec(&snapshot).unwrap() + ) + .unwrap(), + snapshot + ); + assert_eq!( + snapshot.ip_list().interface_ipv4s, + vec![Ipv4Addr::new(192, 0, 2, 1).into()] + ); + assert_eq!( + snapshot.preferred_ipv6_source("2001:db8::2".parse().unwrap()), + Some(PreferredIpv6Source { + ip: "2001:db8::2".parse().unwrap(), + ifindex: 7, + }) + ); + assert_eq!( + snapshot.preferred_ipv6_source("fd00::1".parse().unwrap()), + None + ); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/direct/mod.rs b/vendor/easytier/easytier-core/src/connectivity/direct/mod.rs new file mode 100644 index 0000000..cf6269d --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/direct/mod.rs @@ -0,0 +1,1262 @@ +use std::{ + collections::HashSet, + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr}, + sync::{Arc, Weak}, + time::Duration, +}; + +use anyhow::Context; +use async_trait::async_trait; +use quanta::Instant; +use rand::Rng; +use serde::{Deserialize, Serialize}; +use tokio::task::JoinSet; +use url::{Host, Url}; + +use crate::{ + config::PeerId, + connectivity::hole_punch::policy::{should_background_p2p_with_peer, should_try_p2p_with_peer}, + connectivity::stun::{StunInfoProvider, StunSocketMapper}, + connectivity::{ + LocalListenerUrls, NoLocalListeners, + protocol::{ + ClientProtocolUpgrader, ProtocolTransport, protocol_transport, protocol_uses_udp, + }, + transport::{self, ConnectedTransport, UdpSessionMode}, + }, + foundation::expiring_set::ExpiringSet, + foundation::task::{PeerTaskLauncher, PeerTaskManager}, + host::dns::DnsResolver, + peers::{ + PeerConnectionOrigin, conn::peer_conn::PeerConnId, + foreign_network::ForeignNetworkRpcRegistrar, peer_manager::PeerManagerCore, + peer_rpc::PeerRpcManager, + }, + process_runtime::ProtectedTcpPortRegistry, + proto::{ + common::Void, + peer_rpc::{ + DirectConnectorRpc, DirectConnectorRpcClientFactory, + DirectConnectorRpcServer as GeneratedDirectConnectorRpcServer, GetIpListRequest, + GetIpListResponse, SendUdpHolePunchPacketRequest, + }, + rpc_types::{self, controller::BaseController}, + }, + socket::{ + IpVersion, SocketContext, + tcp::{TcpBindOptions, TcpSocketPurpose}, + udp::{ + PreferredIpv6Source, UdpBindOptions, VirtualUdpSocket, VirtualUdpSocketFactory, + send_v4_hole_punch_control_packet, send_v6_hole_punch_control_packet, + }, + }, + tunnel::Tunnel, +}; + +use super::manual::{ + ManualConnectorHost, collect_bind_addrs, convert_idn_to_ascii, resolve_remote_addr, + resolve_url_addrs, +}; + +mod udp; + +const DIRECT_CONNECTOR_BLACKLIST_TIMEOUT: Duration = Duration::from_secs(300); +const INVALID_SERVICE_BLACKLIST_TIMEOUT: Duration = Duration::from_secs(3600); +const DIRECT_CONNECT_TIMEOUT: Duration = Duration::from_secs(3); +const DIRECT_TASK_LOOP_INTERVAL_MS: u64 = 5000; +const MAX_IPV6_HOLE_PUNCH_CONNECTOR_ADDRS: usize = 16; +const MAX_UDP_HOLE_PUNCH_CONNECTOR_ADDRS: usize = 16; + +#[async_trait] +pub trait DirectConnectorHost: ManualConnectorHost { + async fn collect_ip_addrs(&self, context: &SocketContext) -> GetIpListResponse; + + async fn collect_foreign_ip_addrs(&self, context: &SocketContext) -> GetIpListResponse { + self.collect_ip_addrs(context).await + } + + fn mapped_listeners(&self) -> Vec; + + fn is_local_ip(&self, ip: &IpAddr) -> bool; + + async fn preferred_ipv6_source( + &self, + ip: Ipv6Addr, + context: SocketContext, + ) -> Option; + + async fn preferred_foreign_ipv6_source( + &self, + ip: Ipv6Addr, + context: SocketContext, + ) -> Option { + self.preferred_ipv6_source(ip, context).await + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum DirectTransport { + Tcp(TcpSocketPurpose), + Udp(UdpSessionMode), +} + +impl DirectTransport { + fn from_url(url: &Url) -> anyhow::Result { + match protocol_transport(url.scheme()) { + Some(ProtocolTransport::Tcp) => Ok(Self::Tcp(TcpSocketPurpose::DirectConnect)), + Some(ProtocolTransport::FakeTcp) => Ok(Self::Tcp(TcpSocketPurpose::FakeTcp)), + Some(ProtocolTransport::Udp(mode)) => Ok(Self::Udp(mode)), + None => anyhow::bail!("unsupported direct transport scheme: {}", url.scheme()), + } + } + + fn is_udp(self) -> bool { + matches!(self, Self::Udp(_)) + } + + fn supports_interface_bind(self) -> bool { + !matches!(self, Self::Tcp(TcpSocketPurpose::FakeTcp)) + } +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct DirectConnectorOptions { + pub default_protocol: String, + pub enable_ipv6: bool, + pub allow_public_server: bool, + pub bind_device: bool, + pub allow_interface_bind: bool, + pub tcp_bind: TcpBindOptions, + pub udp_bind: UdpBindOptions, + #[serde(skip)] + pub testing: bool, +} + +impl Default for DirectConnectorOptions { + fn default() -> Self { + Self { + default_protocol: "tcp".to_owned(), + enable_ipv6: true, + allow_public_server: false, + bind_device: false, + allow_interface_bind: true, + tcp_bind: TcpBindOptions::default(), + udp_bind: UdpBindOptions::direct_connect(), + testing: false, + } + } +} + +impl DirectConnectorOptions { + fn socket_context(&self, transport: DirectTransport, ip_version: IpVersion) -> SocketContext { + let context = match transport { + DirectTransport::Tcp(_) => self.tcp_bind.context.clone(), + DirectTransport::Udp(_) => self.udp_bind.context.clone(), + }; + context.with_ip_version(ip_version) + } +} + +#[derive(Debug, Hash, Eq, PartialEq, Clone)] +struct ListenerBlacklistKey(PeerId, String); + +struct DirectConnectorData +where + H: DirectConnectorHost, +{ + peer_manager: Arc, + host: Arc, + protected_tcp_ports: Arc, + stun: Arc::Socket>>, + running_listeners: Arc, + dns: Arc, + protocol: + Arc::Socket>>, + options: DirectConnectorOptions, + listener_blacklist: ExpiringSet, + peer_blacklist: ExpiringSet, +} + +impl std::fmt::Debug for DirectConnectorData +where + H: DirectConnectorHost, +{ + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("DirectConnectorData") + .field("peer_id", &self.peer_manager.my_peer_id()) + .field("network_name", &self.peer_manager.network_name()) + .finish() + } +} + +pub(crate) struct DirectConnectorManager +where + H: DirectConnectorHost, +{ + data: Arc>, + client: PeerTaskManager>, +} + +impl DirectConnectorManager +where + H: DirectConnectorHost, +{ + #[allow(clippy::too_many_arguments)] + pub(crate) fn new_with_running_listeners( + peer_manager: Arc, + host: Arc, + protected_tcp_ports: Arc, + stun: Arc::Socket>>, + running_listeners: Arc, + dns: Arc, + protocol: Arc< + dyn ClientProtocolUpgrader<::Socket>, + >, + options: DirectConnectorOptions, + ) -> Self { + let data = Arc::new(DirectConnectorData { + peer_manager: peer_manager.clone(), + host, + protected_tcp_ports, + stun, + running_listeners, + dns, + protocol, + options, + listener_blacklist: ExpiringSet::default(), + peer_blacklist: ExpiringSet::default(), + }); + let client = PeerTaskManager::new_with_external_signal( + DirectConnectorLauncher(data.clone()), + Some(peer_manager.p2p_demand_notify()), + ); + Self { data, client } + } + + pub fn run(&self) { + self.run_as_server(); + self.run_as_client(); + } + + pub fn run_as_server(&self) { + self.data + .peer_manager + .get_peer_rpc_mgr() + .rpc_server() + .registry() + .register( + GeneratedDirectConnectorRpcServer::new( + DirectConnectorRpcHandler::new_with_running_listeners_and_stun( + self.data.host.clone(), + Some(Arc::downgrade(&self.data.peer_manager)), + self.data.running_listeners.clone(), + self.data.options.udp_bind.context.clone(), + Some(self.data.stun.clone()), + ), + ), + self.data.peer_manager.network_name(), + ); + } + + pub fn run_as_client(&self) { + self.client.start(); + } + + pub async fn stop(&self) { + self.client.stop().await; + self.data + .peer_manager + .get_peer_rpc_mgr() + .rpc_server() + .registry() + .unregister( + GeneratedDirectConnectorRpcServer::new( + DirectConnectorRpcHandler::new_with_running_listeners_and_stun( + self.data.host.clone(), + Some(Arc::downgrade(&self.data.peer_manager)), + self.data.running_listeners.clone(), + self.data.options.udp_bind.context.clone(), + Some(self.data.stun.clone()), + ), + ), + self.data.peer_manager.network_name(), + ); + } + + pub(crate) async fn local_address_observations_with_stun( + &self, + stun_info: &crate::proto::common::StunInfo, + ) -> GetIpListResponse { + collect_address_observations( + self.data.host.as_ref(), + Some(self.data.peer_manager.as_ref()), + &self.data.options.udp_bind.context, + false, + Some(stun_info), + ) + .await + } +} + +struct DirectConnectorLauncher(Arc>) +where + H: DirectConnectorHost; + +impl Clone for DirectConnectorLauncher +where + H: DirectConnectorHost, +{ + fn clone(&self) -> Self { + Self(self.0.clone()) + } +} + +#[async_trait] +impl PeerTaskLauncher for DirectConnectorLauncher +where + H: DirectConnectorHost, +{ + type CollectPeerItem = PeerId; + type TaskRet = (); + + async fn collect_peers_need_task(&self) -> Vec { + let data = &self.0; + data.peer_blacklist.cleanup(); + let my_peer_id = data.peer_manager.my_peer_id(); + let policy = data.peer_manager.p2p_policy_flags(); + let now = Instant::now(); + data.peer_manager + .get_route() + .list_routes() + .await + .into_iter() + .filter(|route| { + let static_allowed = should_background_p2p_with_peer( + route.feature_flag.as_ref(), + data.options.allow_public_server, + policy.lazy_p2p, + policy.disable_p2p, + policy.need_p2p, + ); + let dynamic_allowed = should_try_p2p_with_peer( + route.feature_flag.as_ref(), + data.options.allow_public_server, + policy.disable_p2p, + policy.need_p2p, + ) && data.peer_manager.has_recent_traffic(route.peer_id, now); + route.peer_id != my_peer_id + && (static_allowed || dynamic_allowed) + && !data.peer_manager.has_directly_connected_conn(route.peer_id) + && !data.peer_blacklist.contains(&route.peer_id) + }) + .map(|route| route.peer_id) + .collect() + } + + async fn launch_task(&self, peer_id: PeerId) -> tokio::task::JoinHandle> { + let data = self.0.clone(); + tokio::spawn(async move { data.try_direct_connect(peer_id).await }) + } + + fn loop_interval_ms(&self) -> u64 { + DIRECT_TASK_LOOP_INTERVAL_MS + } +} + +impl DirectConnectorData +where + H: DirectConnectorHost, +{ + async fn try_direct_connect(self: Arc, dst_peer_id: PeerId) -> anyhow::Result<()> { + let backoffs_ms = [1000, 2000, 2000, 5000, 5000, 10000, 30000, 60000]; + let mut backoff_index = 0usize; + let mut attempt = 0usize; + + loop { + if self.peer_blacklist.contains(&dst_peer_id) { + anyhow::bail!("peer {dst_peer_id} is blacklisted"); + } + if attempt > 0 { + crate::foundation::time::sleep(Duration::from_millis(backoffs_ms[backoff_index])) + .await; + backoff_index = (backoff_index + 1).min(backoffs_ms.len() - 1); + } + attempt += 1; + + let rpc_stub = self + .peer_manager + .get_peer_rpc_mgr() + .rpc_client() + .scoped_client::>( + self.peer_manager.my_peer_id(), + dst_peer_id, + self.peer_manager.network_name().to_owned(), + ); + let ip_list = match rpc_stub + .get_ip_list(BaseController::default(), GetIpListRequest {}) + .await + { + Ok(ip_list) => ip_list, + Err(error @ rpc_types::error::Error::InvalidServiceKey(_, _)) => { + self.peer_blacklist + .insert(dst_peer_id, INVALID_SERVICE_BLACKLIST_TIMEOUT); + return Err(error.into()); + } + Err(error) => return Err(error.into()), + }; + + tracing::info!(?ip_list, dst_peer_id, "got direct-connect IP list"); + let result = self + .try_direct_connect_with_ip_list(dst_peer_id, ip_list) + .await; + tracing::info!(?result, dst_peer_id, "direct-connect attempt returned"); + if self.peer_manager.has_directly_connected_conn(dst_peer_id) { + return Ok(()); + } + } + } + + async fn try_direct_connect_with_ip_list( + self: &Arc, + dst_peer_id: PeerId, + ip_list: GetIpListResponse, + ) -> anyhow::Result<()> { + let mut available_listeners = ip_list + .listeners + .clone() + .into_iter() + .map(Into::::into) + .filter(|listener| listener.scheme() != "ring") + .filter(|listener| { + mapped_listener_port(listener).is_some() && listener.host().is_some() + }) + .filter(|listener| { + self.options.enable_ipv6 || !matches!(listener.host(), Some(Host::Ipv6(_))) + }) + .collect::>(); + + if available_listeners.is_empty() { + anyhow::bail!("peer {dst_peer_id} has no valid listener"); + } + + available_listeners.sort_by_key(|listener| { + if listener.scheme() == self.options.default_protocol { + 3 + } else if listener.scheme() == "udp" { + 2 + } else { + 1 + } + }); + + while !available_listeners.is_empty() { + let mut tasks = JoinSet::new(); + let current_scheme = available_listeners + .last() + .expect("non-empty listener list") + .scheme() + .to_owned(); + while available_listeners + .last() + .is_some_and(|listener| listener.scheme() == current_scheme) + { + let listener = available_listeners.pop().expect("listener should exist"); + self.spawn_direct_connect_tasks(dst_peer_id, &ip_list, &listener, &mut tasks) + .await; + } + let _ = tasks.join_all().await; + if self.peer_manager.has_directly_connected_conn(dst_peer_id) { + return Ok(()); + } + } + Ok(()) + } + + async fn spawn_direct_connect_tasks( + self: &Arc, + dst_peer_id: PeerId, + ip_list: &GetIpListResponse, + listener: &Url, + tasks: &mut JoinSet>, + ) { + let Ok(mut addrs) = resolve_mapped_listener_addrs( + listener, + self.options.tcp_bind.context.clone(), + self.dns.as_ref(), + ) + .await + else { + tracing::error!(?listener, "failed to resolve direct listener"); + return; + }; + let listener_host = addrs.pop(); + let is_udp = protocol_uses_udp(listener.scheme()); + let local_listeners = self.running_listeners.local_listener_urls(); + let port_has_local_listener = |port: u16| { + local_listeners.iter().any(|local| { + local.port() == Some(port) && protocol_uses_udp(local.scheme()) == is_udp + }) + }; + let should_deny_target = |target: &SocketAddr| { + let port_is_protected = port_has_local_listener(target.port()) + || (!is_udp && self.protected_tcp_ports.contains(target.port())); + port_is_protected && self.host.is_local_ip(&target.ip()) + }; + + match listener_host { + Some(SocketAddr::V4(socket_addr)) if socket_addr.ip().is_unspecified() => { + for ip in ip_list + .interface_ipv4s + .iter() + .chain(ip_list.public_ipv4.iter()) + { + let target = SocketAddr::new(IpAddr::V4(ip.addr.into()), socket_addr.port()); + if should_deny_target(&target) { + continue; + } + let mut url = listener.clone(); + if url.set_ip_host(target.ip()).is_ok() { + tasks.spawn(Self::try_connect_to_url( + self.clone(), + dst_peer_id, + url.to_string(), + )); + } + } + } + Some(SocketAddr::V4(socket_addr)) + if (!socket_addr.ip().is_loopback() || self.options.testing) + && !should_deny_target(&SocketAddr::V4(socket_addr)) => + { + tasks.spawn(Self::try_connect_to_url( + self.clone(), + dst_peer_id, + listener.to_string(), + )); + } + Some(SocketAddr::V6(socket_addr)) if socket_addr.ip().is_unspecified() => { + let mut candidates = HashSet::new(); + for ip in ip_list + .interface_ipv6s + .iter() + .chain(ip_list.public_ipv6.iter()) + .map(|ip| Ipv6Addr::from(*ip)) + { + if self.is_usable_public_ipv6(&ip).await { + candidates.insert(ip); + } + } + for ip in candidates { + let target = SocketAddr::new(IpAddr::V6(ip), socket_addr.port()); + if should_deny_target(&target) { + continue; + } + let mut url = listener.clone(); + if url.set_ip_host(target.ip()).is_ok() { + tasks.spawn(Self::try_connect_to_url( + self.clone(), + dst_peer_id, + url.to_string(), + )); + } + } + } + Some(SocketAddr::V6(socket_addr)) + if self + .peer_manager + .is_easytier_managed_ipv6(socket_addr.ip()) + .await => + { + tracing::debug!(?listener, "skip managed IPv6 direct target"); + } + Some(SocketAddr::V6(socket_addr)) + if (!socket_addr.ip().is_loopback() || self.options.testing) + && !should_deny_target(&SocketAddr::V6(socket_addr)) => + { + tasks.spawn(Self::try_connect_to_url( + self.clone(), + dst_peer_id, + listener.to_string(), + )); + } + _ => {} + } + } + + async fn try_connect_to_url( + self: Arc, + dst_peer_id: PeerId, + url: String, + ) -> anyhow::Result<()> { + self.listener_blacklist.cleanup(); + let key = ListenerBlacklistKey(dst_peer_id, url.clone()); + if self.listener_blacklist.contains(&key) { + anyhow::bail!("direct listener URL is blacklisted"); + } + + let backoffs_ms = [1000i64, 2000, 4000]; + for attempt in 0..=backoffs_ms.len() { + if self.peer_manager.has_directly_connected_conn(dst_peer_id) { + return Ok(()); + } + let result = self.connect_to_url_once(dst_peer_id, &url).await; + if result.is_ok() || self.peer_manager.has_directly_connected_conn(dst_peer_id) { + return Ok(()); + } + if attempt == backoffs_ms.len() { + self.listener_blacklist + .insert(key, DIRECT_CONNECTOR_BLACKLIST_TIMEOUT); + return result; + } + + let base = backoffs_ms[attempt]; + let delta = base >> 1; + let delay_ms = { + let mut rng = rand::thread_rng(); + base + rng.gen_range(-delta..delta) + }; + crate::foundation::time::sleep(Duration::from_millis(delay_ms as u64)).await; + } + unreachable!("direct URL retry loop must return") + } + + async fn connect_to_url_once(&self, dst_peer_id: PeerId, raw_url: &str) -> anyhow::Result<()> { + let url = Url::parse(raw_url)?; + let (peer_id, conn_id) = if url.scheme() == "udp" { + match url.host() { + Some(Host::Ipv6(_)) => self.connect_public_ipv6(dst_peer_id, &url).await?, + Some(Host::Ipv4(ip)) if is_public_ipv4(ip) => { + match self.connect_public_ipv4(dst_peer_id, &url).await { + Ok(result) => result, + Err(error) => { + tracing::debug!(?error, %url, "public IPv4 UDP punch failed; fallback"); + self.connect_ordinary(dst_peer_id, url.clone()).await? + } + } + } + _ => self.connect_ordinary(dst_peer_id, url.clone()).await?, + } + } else { + self.connect_ordinary(dst_peer_id, url.clone()).await? + }; + + if peer_id != dst_peer_id && !self.options.testing { + self.peer_manager.close_peer_conn(peer_id, &conn_id).await?; + anyhow::bail!("direct peer mismatch for {url}: expected {dst_peer_id}, got {peer_id}"); + } + Ok(()) + } + + async fn connect_ordinary( + &self, + dst_peer_id: PeerId, + url: Url, + ) -> anyhow::Result<(PeerId, PeerConnId)> { + let transport = DirectTransport::from_url(&url)?; + let normalized = convert_idn_to_ascii(url.clone())?; + let default_port = mapped_listener_port(&normalized) + .ok_or_else(|| anyhow::anyhow!("listener has no port: {url}"))?; + let remote_addr = resolve_remote_addr( + self.peer_manager.as_ref(), + self.host.as_ref(), + self.dns.as_ref(), + &normalized, + default_port, + self.options.socket_context(transport, IpVersion::Both), + ) + .await?; + let bind_addrs = if self.options.bind_device + && self.options.allow_interface_bind + && transport.supports_interface_bind() + { + collect_bind_addrs( + self.peer_manager.as_ref(), + self.host.as_ref(), + transport.is_udp(), + remote_addr, + ) + .await? + } else { + Vec::new() + }; + crate::foundation::time::timeout(DIRECT_CONNECT_TIMEOUT, async { + let connected = match transport { + DirectTransport::Tcp(purpose) => ConnectedTransport::Tcp( + transport::connect_tcp( + self.host.clone(), + remote_addr, + bind_addrs, + self.options.tcp_bind.clone(), + purpose, + ) + .await?, + ), + DirectTransport::Udp(mode) => ConnectedTransport::Udp( + transport::connect_udp( + self.host.clone(), + remote_addr, + bind_addrs, + self.options.udp_bind.clone(), + mode, + ) + .await?, + ), + }; + let tunnel = self.protocol.upgrade_client(connected, url).await?; + self.admit(tunnel, dst_peer_id).await + }) + .await? + } + + async fn connect_public_ipv4( + &self, + dst_peer_id: PeerId, + url: &Url, + ) -> anyhow::Result<(PeerId, PeerConnId)> { + let socket = self + .host + .bind_udp( + UdpBindOptions::direct_connect() + .with_context( + self.options + .udp_bind + .context + .clone() + .with_ip_version(IpVersion::V4), + ) + .with_local_addr(Some("0.0.0.0:0".parse().unwrap())), + ) + .await?; + let connector_addr = self + .stun + .get_udp_port_mapping_with_socket(socket.clone()) + .await?; + let _ = self + .remote_send_udp_hole_punch_packet(dst_peer_id, vec![connector_addr], None, url) + .await; + let remote_addr = resolve_literal_url(url, IpVersion::V4)?; + let connected = udp::connect_with_socket(self.host.clone(), socket, remote_addr).await?; + let tunnel = self + .protocol + .upgrade_client(ConnectedTransport::Udp(connected), url.clone()) + .await?; + self.admit(tunnel, dst_peer_id).await + } + + async fn connect_public_ipv6( + &self, + dst_peer_id: PeerId, + url: &Url, + ) -> anyhow::Result<(PeerId, PeerConnId)> { + let socket = self + .host + .bind_udp( + UdpBindOptions::direct_connect() + .with_context( + self.options + .udp_bind + .context + .clone() + .with_ip_version(IpVersion::V6), + ) + .with_local_addr(Some("[::]:0".parse().unwrap())), + ) + .await?; + let connector_ips = self.collect_ipv6_hole_punch_candidates().await?; + if !connector_ips.is_empty() { + let port = socket.local_addr()?.port(); + let connector_addrs = connector_ips + .into_iter() + .map(|ip| SocketAddr::new(IpAddr::V6(ip), port)) + .collect(); + let preferred_src = match url.host() { + Some(Host::Ipv6(ip)) => Some(ip), + _ => None, + }; + let _ = self + .remote_send_udp_hole_punch_packet(dst_peer_id, connector_addrs, preferred_src, url) + .await; + } + let remote_addr = resolve_literal_url(url, IpVersion::V6)?; + let connected = udp::connect_with_socket(self.host.clone(), socket, remote_addr).await?; + let tunnel = self + .protocol + .upgrade_client(ConnectedTransport::Udp(connected), url.clone()) + .await?; + self.admit(tunnel, dst_peer_id).await + } + + async fn collect_ipv6_hole_punch_candidates(&self) -> anyhow::Result> { + let mut candidates = Vec::new(); + for ip in self + .stun + .get_stun_info() + .public_ip + .into_iter() + .filter_map(|ip| ip.parse().ok()) + { + if let IpAddr::V6(ip) = ip { + self.push_ipv6_candidate(&mut candidates, ip).await; + } + } + let interface_addrs = self.host.interface_addrs().await?; + for ip in interface_addrs + .interface_ipv6s + .into_iter() + .chain(interface_addrs.public_ipv6) + { + self.push_ipv6_candidate(&mut candidates, ip).await; + } + Ok(candidates) + } + + async fn push_ipv6_candidate(&self, candidates: &mut Vec, ip: Ipv6Addr) { + if candidates.len() < MAX_IPV6_HOLE_PUNCH_CONNECTOR_ADDRS + && self.is_usable_public_ipv6(&ip).await + && !candidates.contains(&ip) + { + candidates.push(ip); + } + } + + async fn is_usable_public_ipv6(&self, ip: &Ipv6Addr) -> bool { + !self.peer_manager.is_easytier_managed_ipv6(ip).await + && (self.options.testing + || (!ip.is_loopback() + && !ip.is_unspecified() + && !ip.is_unique_local() + && !ip.is_unicast_link_local() + && !ip.is_multicast())) + } + + async fn remote_send_udp_hole_punch_packet( + &self, + dst_peer_id: PeerId, + connector_addrs: Vec, + preferred_src_ipv6: Option, + remote_url: &Url, + ) -> anyhow::Result<()> { + if remote_url.scheme() != "udp" { + anyhow::bail!("UDP punch request requires a UDP listener: {remote_url}"); + } + let listener_port = mapped_listener_port(remote_url) + .ok_or_else(|| anyhow::anyhow!("listener has no port: {remote_url}"))?; + let rpc_stub = self + .peer_manager + .get_peer_rpc_mgr() + .rpc_client() + .scoped_client::>( + self.peer_manager.my_peer_id(), + dst_peer_id, + self.peer_manager.network_name().to_owned(), + ); + rpc_stub + .send_udp_hole_punch_packet( + BaseController::default(), + SendUdpHolePunchPacketRequest { + connector_addr: connector_addrs.first().copied().map(Into::into), + listener_port: listener_port as u32, + preferred_src_ipv6: preferred_src_ipv6.map(Into::into), + connector_addrs: connector_addrs.into_iter().map(Into::into).collect(), + }, + ) + .await + .with_context(|| format!("send UDP punch request to peer {dst_peer_id}"))?; + Ok(()) + } + + async fn admit( + &self, + tunnel: Box, + dst_peer_id: PeerId, + ) -> anyhow::Result<(PeerId, PeerConnId)> { + self.peer_manager + .add_client_tunnel_with_peer_id_hint( + tunnel, + PeerConnectionOrigin::Direct, + Some(dst_peer_id), + ) + .await + .map_err(Into::into) + } +} + +pub(crate) struct DirectConnectorRpcHandler +where + H: DirectConnectorHost, +{ + host: Arc, + peer_manager: Option>, + running_listeners: Arc, + socket_context: SocketContext, + foreign_network: bool, + stun: Option>, +} + +impl Clone for DirectConnectorRpcHandler +where + H: DirectConnectorHost, +{ + fn clone(&self) -> Self { + Self { + host: self.host.clone(), + peer_manager: self.peer_manager.clone(), + running_listeners: self.running_listeners.clone(), + socket_context: self.socket_context.clone(), + foreign_network: self.foreign_network, + stun: self.stun.clone(), + } + } +} + +impl DirectConnectorRpcHandler +where + H: DirectConnectorHost, +{ + pub fn new_for_foreign_network_with_stun( + host: Arc, + socket_context: SocketContext, + stun: Option>, + ) -> Self { + let running_listeners = Arc::new(NoLocalListeners); + Self { + host, + peer_manager: None, + running_listeners, + socket_context, + foreign_network: true, + stun, + } + } + + fn new_with_running_listeners_and_stun( + host: Arc, + peer_manager: Option>, + running_listeners: Arc, + socket_context: SocketContext, + stun: Option>, + ) -> Self { + Self { + host, + peer_manager, + running_listeners, + socket_context, + foreign_network: false, + stun, + } + } +} + +async fn collect_address_observations( + host: &H, + peer_manager: Option<&PeerManagerCore>, + socket_context: &SocketContext, + foreign_network: bool, + stun_info: Option<&crate::proto::common::StunInfo>, +) -> GetIpListResponse +where + H: DirectConnectorHost, +{ + let mut response = if foreign_network { + host.collect_foreign_ip_addrs(socket_context).await + } else { + host.collect_ip_addrs(socket_context).await + }; + if let Some(stun_info) = stun_info { + for public_ip in &stun_info.public_ip { + match public_ip.parse::() { + Ok(IpAddr::V4(ip)) => response.public_ipv4 = Some(ip.into()), + Ok(IpAddr::V6(ip)) => response.public_ipv6 = Some(ip.into()), + Err(_) => {} + } + } + } + if let Some(peer_manager) = peer_manager.filter(|_| !foreign_network) { + let mut interface_ipv6s = Vec::with_capacity(response.interface_ipv6s.len()); + for ip in response.interface_ipv6s { + if !peer_manager + .is_easytier_managed_ipv6(&Ipv6Addr::from(ip)) + .await + { + interface_ipv6s.push(ip); + } + } + response.interface_ipv6s = interface_ipv6s; + if let Some(ip) = response.public_ipv6.map(Ipv6Addr::from) + && peer_manager.is_easytier_managed_ipv6(&ip).await + { + response.public_ipv6 = None; + } + } + response +} + +pub(crate) struct ForeignDirectConnectorRpcRegistrar +where + H: DirectConnectorHost, +{ + host: Arc, + stun: Arc, +} + +impl ForeignDirectConnectorRpcRegistrar +where + H: DirectConnectorHost, +{ + pub fn new(host: Arc, stun: Arc) -> Self { + Self { host, stun } + } +} + +impl ForeignNetworkRpcRegistrar for ForeignDirectConnectorRpcRegistrar +where + H: DirectConnectorHost, +{ + fn register_peer_rpc_services( + &self, + peer_rpc: &Arc, + network_name: &str, + socket_context: SocketContext, + ) { + peer_rpc.rpc_server().registry().register( + GeneratedDirectConnectorRpcServer::new( + DirectConnectorRpcHandler::new_for_foreign_network_with_stun( + self.host.clone(), + socket_context, + Some(self.stun.clone()), + ), + ), + network_name, + ); + } +} + +#[async_trait] +impl DirectConnectorRpc for DirectConnectorRpcHandler +where + H: DirectConnectorHost, +{ + type Controller = BaseController; + + async fn get_ip_list( + &self, + _: BaseController, + _: GetIpListRequest, + ) -> rpc_types::error::Result { + let peer_manager = self.peer_manager.as_ref().and_then(Weak::upgrade); + let mut response = collect_address_observations( + self.host.as_ref(), + peer_manager.as_deref(), + &self.socket_context, + self.foreign_network, + self.stun + .as_deref() + .map(StunInfoProvider::get_stun_info) + .as_ref(), + ) + .await; + response.listeners = self + .host + .mapped_listeners() + .into_iter() + .chain(self.running_listeners.local_listener_urls()) + .map(Into::into) + .collect(); + Ok(response) + } + + async fn send_udp_hole_punch_packet( + &self, + _: BaseController, + request: SendUdpHolePunchPacketRequest, + ) -> rpc_types::error::Result { + let (listener_port, connector_addrs, preferred_src_ipv6) = + connector_addrs_from_request(request)?; + let peer_manager = self.peer_manager.as_ref().and_then(Weak::upgrade); + let preferred_source = match preferred_src_ipv6.map(Ipv6Addr::from) { + Some(ip) => { + if self.foreign_network { + self.host + .preferred_foreign_ipv6_source(ip, self.socket_context.clone()) + .await + } else if let Some(peer_manager) = peer_manager.as_deref() + && peer_manager.is_easytier_managed_ipv6(&ip).await + { + None + } else { + self.host + .preferred_ipv6_source(ip, self.socket_context.clone()) + .await + } + } + None => None, + }; + + for _ in 0..3 { + for connector_addr in &connector_addrs { + let result = match connector_addr { + SocketAddr::V4(addr) => { + send_v4_hole_punch_control_packet( + self.host.as_ref(), + self.socket_context.clone(), + listener_port, + *addr, + ) + .await + } + SocketAddr::V6(addr) => { + send_v6_hole_punch_control_packet( + self.host.as_ref(), + self.socket_context.clone(), + listener_port, + *addr, + preferred_source, + ) + .await + } + }; + if let Err(error) = result { + tracing::debug!(?error, ?connector_addr, "send UDP punch packet failed"); + } + } + crate::foundation::time::sleep(Duration::from_millis(30)).await; + } + Ok(Void::default()) + } +} + +fn connector_addrs_from_request( + request: SendUdpHolePunchPacketRequest, +) -> rpc_types::error::Result<(u16, Vec, Option)> { + let listener_port = u16::try_from(request.listener_port) + .map_err(|_| anyhow::anyhow!("listener_port out of range: {}", request.listener_port))?; + let mut connector_addrs = request + .connector_addrs + .into_iter() + .map(SocketAddr::from) + .collect::>(); + if connector_addrs.is_empty() { + connector_addrs.push( + request + .connector_addr + .ok_or_else(|| anyhow::anyhow!("connector_addr is required"))? + .into(), + ); + } + let mut deduped = Vec::with_capacity(connector_addrs.len()); + for addr in connector_addrs { + if !deduped.contains(&addr) { + deduped.push(addr); + } + if deduped.len() >= MAX_UDP_HOLE_PUNCH_CONNECTOR_ADDRS { + break; + } + } + Ok((listener_port, deduped, request.preferred_src_ipv6)) +} + +fn mapped_listener_port(url: &Url) -> Option { + url.port() + .or_else(|| crate::connectivity::protocol::protocol_default_port(url.scheme())) +} + +async fn resolve_mapped_listener_addrs( + listener: &Url, + context: SocketContext, + dns: &dyn DnsResolver, +) -> anyhow::Result> { + let port = mapped_listener_port(listener) + .ok_or_else(|| anyhow::anyhow!("listener has no default port: {listener}"))?; + resolve_url_addrs( + listener, + port, + context.with_ip_version(IpVersion::Both), + dns, + ) + .await +} + +fn resolve_literal_url(url: &Url, ip_version: IpVersion) -> anyhow::Result { + let port = + mapped_listener_port(url).ok_or_else(|| anyhow::anyhow!("listener has no port: {url}"))?; + match (url.host(), ip_version) { + (Some(Host::Ipv4(ip)), IpVersion::V4 | IpVersion::Both) => { + Ok(SocketAddr::new(IpAddr::V4(ip), port)) + } + (Some(Host::Ipv6(ip)), IpVersion::V6 | IpVersion::Both) => { + Ok(SocketAddr::new(IpAddr::V6(ip), port)) + } + _ => anyhow::bail!("URL host does not match {ip_version:?}: {url}"), + } +} + +fn is_public_ipv4(ip: Ipv4Addr) -> bool { + !ip.is_private() + && !ip.is_loopback() + && !ip.is_link_local() + && !ip.is_broadcast() + && !ip.is_unspecified() +} + +#[cfg(test)] +mod tests { + use super::*; + + impl DirectConnectorRpcHandler + where + H: DirectConnectorHost, + { + pub(crate) fn new_with_stun( + host: Arc, + socket_context: SocketContext, + stun: Option>, + ) -> Self { + let running_listeners = Arc::new(NoLocalListeners); + Self { + host, + peer_manager: None, + running_listeners, + socket_context, + foreign_network: false, + stun, + } + } + } + + #[test] + fn faketcp_uses_specialized_tcp_socket_without_interface_binding() { + let transport = + DirectTransport::from_url(&"faketcp://127.0.0.1:11013".parse().unwrap()).unwrap(); + + assert_eq!(transport, DirectTransport::Tcp(TcpSocketPurpose::FakeTcp)); + assert!(!transport.supports_interface_bind()); + assert!(!transport.is_udp()); + } + + #[test] + fn connector_address_request_deduplicates_and_caps() { + let mut request = SendUdpHolePunchPacketRequest { + listener_port: 11010, + ..Default::default() + }; + for port in 1..=20 { + request + .connector_addrs + .push(SocketAddr::from(([127, 0, 0, 1], port)).into()); + } + request + .connector_addrs + .push(SocketAddr::from(([127, 0, 0, 1], 1)).into()); + + let (_, addrs, _) = connector_addrs_from_request(request).unwrap(); + assert_eq!(addrs.len(), MAX_UDP_HOLE_PUNCH_CONNECTOR_ADDRS); + assert_eq!(addrs[0], SocketAddr::from(([127, 0, 0, 1], 1))); + } + + #[test] + fn expiring_set_removes_expired_entries() { + let set = ExpiringSet::default(); + set.insert(7u32, Duration::ZERO); + assert!(!set.contains(&7)); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/direct/udp.rs b/vendor/easytier/easytier-core/src/connectivity/direct/udp.rs new file mode 100644 index 0000000..272101e --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/direct/udp.rs @@ -0,0 +1,21 @@ +use std::{net::SocketAddr, sync::Arc}; + +use crate::{ + connectivity::transport::ConnectedUdpSession, + socket::udp::{UdpSessionLayer, VirtualUdpSocketFactory}, +}; + +use super::DirectConnectorHost; + +pub(super) async fn connect_with_socket( + host: Arc, + socket: Arc<::Socket>, + remote_addr: SocketAddr, +) -> anyhow::Result +where + H: DirectConnectorHost, +{ + let layer = Arc::new(UdpSessionLayer::new_with_stun_responder(socket, host)); + let session = layer.connect(remote_addr).await?; + Ok(ConnectedUdpSession::new(session, layer)) +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/mod.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/mod.rs new file mode 100644 index 0000000..c48afc5 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/mod.rs @@ -0,0 +1,42 @@ +use async_trait::async_trait; + +use crate::peers::PeerConnectionOrigin; +use crate::proto::rpc_types::{controller::BaseController, handler::Handler}; +use crate::tunnel::Tunnel; + +mod peer_adapters; +pub(crate) mod policy; +pub mod port_mapping; +pub(crate) mod tcp; +pub(crate) mod udp; + +/// Registration seam for hole-punch RPC services. +/// +/// The engines build the proto-generated server wrapper around their RPC +/// endpoint; the implementation owns the peer RPC registry and the network +/// domain the service is registered under. Implemented only by the sealed +/// peer adapter in `peer_adapters.rs`. +pub(crate) trait HolePunchRpcRegistry: Send + Sync + 'static { + fn register_rpc_service(&self, service: H) + where + H: Handler; + + fn unregister_rpc_service(&self, service: H) + where + H: Handler; +} + +#[async_trait] +pub(crate) trait HolePunchTunnelSink: Send + Sync + 'static { + async fn add_client_tunnel( + &self, + tunnel: Box, + origin: PeerConnectionOrigin, + ) -> anyhow::Result<()>; + + async fn add_server_tunnel( + &self, + tunnel: Box, + origin: PeerConnectionOrigin, + ) -> anyhow::Result<()>; +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/peer_adapters.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/peer_adapters.rs new file mode 100644 index 0000000..bf700a5 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/peer_adapters.rs @@ -0,0 +1,197 @@ +use std::{ + net::{IpAddr, Ipv6Addr}, + sync::Arc, +}; + +use async_trait::async_trait; +use quanta::Instant; + +use crate::{ + config::{P2pPolicyFlags, PeerId}, + foundation::task::ExternalTaskSignal, + peers::{PeerConnectionOrigin, peer_manager::PeerManagerCore}, + proto::{ + common::NatType, + peer_rpc::{ + TcpHolePunchRpc, TcpHolePunchRpcClientFactory, UdpHolePunchRpc, + UdpHolePunchRpcClientFactory, + }, + rpc_types::{controller::BaseController, handler::Handler}, + }, + tunnel::Tunnel, +}; + +use super::{ + HolePunchRpcRegistry, HolePunchTunnelSink, + tcp::{TcpHolePunchPeerSource, TcpPunchCandidate}, + udp::{UdpHolePunchPeerSource, UdpHolePunchRpcSource, UdpPunchCandidate}, +}; + +#[async_trait] +impl UdpHolePunchPeerSource for PeerManagerCore { + fn local_peer_id(&self) -> PeerId { + PeerManagerCore::my_peer_id(self) + } + + fn p2p_policy_flags(&self) -> P2pPolicyFlags { + PeerManagerCore::p2p_policy_flags(self) + } + + async fn candidates(&self) -> Vec { + let now = Instant::now(); + let peer_map = self.get_peer_map(); + self.list_route_snapshots() + .await + .into_iter() + .filter_map(|route| { + let udp_nat_type = route + .stun_info + .as_ref() + .map(|info| info.udp_nat_type) + .unwrap_or_default(); + let Ok(udp_nat_type) = crate::proto::common::NatType::try_from(udp_nat_type) else { + return None; + }; + Some(UdpPunchCandidate { + peer_id: route.peer_id, + udp_nat_type, + feature_flag: route.feature_flag, + has_direct_connection: peer_map.has_peer(route.peer_id), + has_recent_traffic: self.has_recent_traffic(route.peer_id, now), + }) + }) + .collect() + } + + fn p2p_demand_notify(&self) -> Arc { + PeerManagerCore::p2p_demand_notify(self) + } + + fn is_local_virtual_ip(&self, ip: &IpAddr) -> bool { + PeerManagerCore::is_local_virtual_ip(self, ip) + } + + async fn is_easytier_managed_ipv6(&self, ip: &Ipv6Addr) -> bool { + PeerManagerCore::is_easytier_managed_ipv6(self, ip).await + } +} + +impl UdpHolePunchRpcSource for PeerManagerCore { + fn local_peer_id(&self) -> PeerId { + PeerManagerCore::my_peer_id(self) + } + + fn rpc_stub( + &self, + dst_peer_id: PeerId, + ) -> Box + Send + Sync + 'static> { + PeerManagerCore::get_peer_rpc_mgr(self) + .rpc_client() + .scoped_client::>( + PeerManagerCore::my_peer_id(self), + dst_peer_id, + PeerManagerCore::network_name(self).to_owned(), + ) + } +} + +#[async_trait] +impl HolePunchTunnelSink for PeerManagerCore { + async fn add_client_tunnel( + &self, + tunnel: Box, + origin: PeerConnectionOrigin, + ) -> anyhow::Result<()> { + self.add_client_tunnel_with_peer_id_hint(tunnel, origin, None) + .await + .map(|_| ()) + .map_err(anyhow::Error::from) + } + + async fn add_server_tunnel( + &self, + tunnel: Box, + origin: PeerConnectionOrigin, + ) -> anyhow::Result<()> { + self.add_tunnel_as_server_with_origin(tunnel, origin) + .await + .map(|_| ()) + .map_err(anyhow::Error::from) + } +} + +#[async_trait] +impl TcpHolePunchPeerSource for PeerManagerCore { + fn local_peer_id(&self) -> PeerId { + PeerManagerCore::my_peer_id(self) + } + + fn p2p_policy_flags(&self) -> P2pPolicyFlags { + PeerManagerCore::p2p_policy_flags(self) + } + + fn tcp_hole_punching_disabled(&self) -> bool { + PeerManagerCore::tcp_hole_punching_disabled(self) + } + + fn p2p_demand_notify(&self) -> Arc { + PeerManagerCore::p2p_demand_notify(self) + } + + async fn candidates(&self) -> Vec { + let now = Instant::now(); + let peer_map = self.get_peer_map(); + self.list_route_snapshots() + .await + .into_iter() + .map(|route| TcpPunchCandidate { + peer_id: route.peer_id, + tcp_nat_type: route + .stun_info + .as_ref() + .map(|info| info.tcp_nat_type) + .and_then(|nat_type| NatType::try_from(nat_type).ok()) + .unwrap_or(NatType::Unknown), + feature_flag: route.feature_flag, + has_direct_connection: peer_map.has_peer(route.peer_id), + has_recent_traffic: self.has_recent_traffic(route.peer_id, now), + }) + .collect() + } + + fn rpc_stub( + &self, + dst_peer_id: PeerId, + ) -> Box + Send + Sync + 'static> { + PeerManagerCore::get_peer_rpc_mgr(self) + .rpc_client() + .scoped_client::>( + PeerManagerCore::my_peer_id(self), + dst_peer_id, + PeerManagerCore::network_name(self).to_owned(), + ) + } +} + +#[async_trait] +impl HolePunchRpcRegistry for PeerManagerCore { + fn register_rpc_service(&self, service: H) + where + H: Handler, + { + PeerManagerCore::get_peer_rpc_mgr(self) + .rpc_server() + .registry() + .register(service, PeerManagerCore::network_name(self)); + } + + fn unregister_rpc_service(&self, service: H) + where + H: Handler, + { + PeerManagerCore::get_peer_rpc_mgr(self) + .rpc_server() + .registry() + .unregister(service, PeerManagerCore::network_name(self)); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/policy.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/policy.rs new file mode 100644 index 0000000..68ffd4a --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/policy.rs @@ -0,0 +1,212 @@ +use crate::proto::common::PeerFeatureFlag; + +#[derive(Debug)] +pub struct BackOff { + backoffs_ms: Vec, + current_idx: usize, +} + +impl BackOff { + pub fn new(backoffs_ms: Vec) -> Self { + Self { + backoffs_ms, + current_idx: 0, + } + } + + pub fn next_backoff(&mut self) -> u64 { + let backoff = self.backoffs_ms[self.current_idx]; + self.current_idx = (self.current_idx + 1).min(self.backoffs_ms.len() - 1); + backoff + } + + pub fn rollback(&mut self) { + self.current_idx = self.current_idx.saturating_sub(1); + } + + pub async fn sleep_for_next_backoff(&mut self) { + let backoff = self.next_backoff(); + if backoff > 0 { + crate::foundation::time::sleep(crate::foundation::time::Duration::from_millis(backoff)) + .await; + } + } +} + +pub fn should_try_p2p_with_peer( + feature_flag: Option<&PeerFeatureFlag>, + allow_public_server: bool, + local_disable_p2p: bool, + local_need_p2p: bool, +) -> bool { + feature_flag + .map(|flag| { + (allow_public_server || !flag.is_public_server) + && (!local_disable_p2p || flag.need_p2p) + && (!flag.disable_p2p || local_need_p2p) + }) + .unwrap_or(!local_disable_p2p) +} + +pub fn should_background_p2p_with_peer( + feature_flag: Option<&PeerFeatureFlag>, + allow_public_server: bool, + lazy_p2p: bool, + local_disable_p2p: bool, + local_need_p2p: bool, +) -> bool { + should_try_p2p_with_peer( + feature_flag, + allow_public_server, + local_disable_p2p, + local_need_p2p, + ) && (!lazy_p2p || feature_flag.map(|flag| flag.need_p2p).unwrap_or(false)) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn backoff_saturates_and_can_rollback() { + let mut backoff = BackOff::new(vec![10, 20]); + + assert_eq!(backoff.next_backoff(), 10); + assert_eq!(backoff.next_backoff(), 20); + assert_eq!(backoff.next_backoff(), 20); + backoff.rollback(); + assert_eq!(backoff.next_backoff(), 10); + } + + #[test] + fn lazy_background_p2p_requires_need_p2p() { + let no_need_p2p = PeerFeatureFlag { + need_p2p: false, + ..Default::default() + }; + let need_p2p = PeerFeatureFlag { + need_p2p: true, + ..Default::default() + }; + + assert!(should_background_p2p_with_peer( + Some(&no_need_p2p), + false, + false, + false, + false + )); + assert!(!should_background_p2p_with_peer( + Some(&no_need_p2p), + false, + true, + false, + false + )); + assert!(should_background_p2p_with_peer( + Some(&need_p2p), + false, + true, + false, + false + )); + } + + #[test] + fn p2p_policy_respects_public_server_setting() { + let public_server = PeerFeatureFlag { + is_public_server: true, + ..Default::default() + }; + + assert!(!should_try_p2p_with_peer( + Some(&public_server), + false, + false, + false + )); + assert!(should_try_p2p_with_peer( + Some(&public_server), + true, + false, + false + )); + assert!(!should_background_p2p_with_peer( + Some(&public_server), + false, + false, + false, + false + )); + assert!(should_background_p2p_with_peer( + Some(&public_server), + true, + false, + false, + false + )); + } + + #[test] + fn disable_p2p_only_allows_need_p2p_exceptions() { + let normal_peer = PeerFeatureFlag::default(); + let need_peer = PeerFeatureFlag { + need_p2p: true, + ..Default::default() + }; + let disable_peer = PeerFeatureFlag { + disable_p2p: true, + ..Default::default() + }; + let disable_need_peer = PeerFeatureFlag { + disable_p2p: true, + need_p2p: true, + ..Default::default() + }; + + assert!(should_try_p2p_with_peer( + Some(&normal_peer), + false, + false, + false + )); + assert!(should_try_p2p_with_peer(None, false, false, false)); + assert!(!should_try_p2p_with_peer(None, false, true, false)); + assert!(!should_try_p2p_with_peer( + Some(&normal_peer), + false, + true, + false + )); + assert!(should_try_p2p_with_peer( + Some(&need_peer), + false, + true, + false + )); + assert!(!should_try_p2p_with_peer( + Some(&disable_peer), + false, + false, + false + )); + assert!(should_try_p2p_with_peer( + Some(&disable_peer), + false, + false, + true + )); + assert!(should_try_p2p_with_peer( + Some(&disable_need_peer), + false, + true, + true + )); + assert!(!should_try_p2p_with_peer( + Some(&disable_need_peer), + false, + true, + false + )); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/port_mapping.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/port_mapping.rs new file mode 100644 index 0000000..e1bd465 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/port_mapping.rs @@ -0,0 +1,439 @@ +use std::{ + fmt, + future::Future, + net::{Ipv4Addr, SocketAddr}, + pin::Pin, + sync::Arc, + time::Duration, +}; + +use async_trait::async_trait; +use tokio::sync::oneshot; + +use crate::events::{CoreEvent, CoreEventSink}; + +const UPNP_RENEW_INTERVAL: Duration = Duration::from_secs(240); + +pub(crate) trait UdpPortMappingLease: Send + Sync + fmt::Debug { + fn public_addr_resolved(&self, _mapped_addr: SocketAddr) {} +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum UdpPortMappingBackend { + Igd, + NatPmp, +} + +impl UdpPortMappingBackend { + pub fn name(self) -> &'static str { + match self { + Self::Igd => "igd", + Self::NatPmp => "nat-pmp", + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum UdpPortMappingAttemptPhase { + Discovery, + Establishment, +} + +#[derive(Debug)] +pub struct UdpPortMappingAttemptError { + phase: UdpPortMappingAttemptPhase, + source: anyhow::Error, +} + +impl UdpPortMappingAttemptError { + pub fn discovery(source: impl Into) -> Self { + Self { + phase: UdpPortMappingAttemptPhase::Discovery, + source: source.into(), + } + } + + pub fn establishment(source: impl Into) -> Self { + Self { + phase: UdpPortMappingAttemptPhase::Establishment, + source: source.into(), + } + } + + pub(crate) fn phase(&self) -> UdpPortMappingAttemptPhase { + self.phase + } + + pub(crate) fn source(&self) -> &anyhow::Error { + &self.source + } +} + +impl fmt::Display for UdpPortMappingAttemptError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + self.source.fmt(f) + } +} + +impl std::error::Error for UdpPortMappingAttemptError { + fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { + Some(self.source.as_ref()) + } +} + +#[async_trait] +pub trait ActiveUdpPortMapping: Send + Sync + fmt::Debug { + fn backend(&self) -> UdpPortMappingBackend; + + fn local_addr(&self) -> SocketAddr; + + fn gateway_external_port(&self) -> u16; + + async fn renew(&self) -> anyhow::Result<()>; + + async fn remove(&self) -> anyhow::Result<()>; +} + +pub type UdpPortMappingLifecycle = Pin + Send + 'static>>; + +#[async_trait] +pub trait UdpPortMappingPlatform: Send + Sync + 'static { + async fn establish_udp_port_mapping( + &self, + backend: UdpPortMappingBackend, + local_listener: &url::Url, + ) -> Result, UdpPortMappingAttemptError>; + + fn spawn_udp_port_mapping_lifecycle( + &self, + _local_listener: url::Url, + lifecycle: UdpPortMappingLifecycle, + ) { + tokio::spawn(lifecycle); + } +} + +struct ManagedUdpPortMappingLease { + events: Arc, + local_listener: url::Url, + backend: UdpPortMappingBackend, + gateway_external_port: u16, + stop_tx: Option>, +} + +impl fmt::Debug for ManagedUdpPortMappingLease { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("UdpPortMappingLease") + .field("backend", &self.backend.name()) + .field("gateway_external_port", &self.gateway_external_port) + .finish() + } +} + +impl Drop for ManagedUdpPortMappingLease { + fn drop(&mut self) { + if let Some(stop_tx) = self.stop_tx.take() { + let _ = stop_tx.send(()); + } + } +} + +impl UdpPortMappingLease for ManagedUdpPortMappingLease { + fn public_addr_resolved(&self, mapped_addr: SocketAddr) { + self.events.emit(CoreEvent::UdpPortMappingEstablished { + local_listener: self.local_listener.clone(), + mapped_listener: udp_url(mapped_addr), + backend: self.backend.name().to_owned(), + }); + tracing::info!( + local_listener = %self.local_listener, + backend = self.backend.name(), + gateway_external_port = self.gateway_external_port, + stun_mapped_addr = %mapped_addr, + "udp public addr resolved after port mapping" + ); + } +} + +pub(crate) async fn start_udp_port_mapping( + platform: Arc, + events: Arc, + local_listener: &url::Url, +) -> anyhow::Result>> { + if !should_map_udp_listener(local_listener) { + return Ok(None); + } + + let mapping = discover_udp_port_mapping(platform.as_ref(), local_listener).await?; + let backend = mapping.backend(); + let gateway_external_port = mapping.gateway_external_port(); + tracing::info!( + %local_listener, + backend = backend.name(), + local_addr = %mapping.local_addr(), + gateway_external_port, + "udp port mapping established" + ); + + let (stop_tx, stop_rx) = oneshot::channel(); + platform.spawn_udp_port_mapping_lifecycle( + local_listener.clone(), + Box::pin(run_udp_port_mapping_lifecycle( + local_listener.clone(), + mapping, + stop_rx, + )), + ); + + Ok(Some(Box::new(ManagedUdpPortMappingLease { + events, + local_listener: local_listener.clone(), + backend, + gateway_external_port, + stop_tx: Some(stop_tx), + }))) +} + +async fn discover_udp_port_mapping( + platform: &dyn UdpPortMappingPlatform, + local_listener: &url::Url, +) -> anyhow::Result> { + let igd_error = match platform + .establish_udp_port_mapping(UdpPortMappingBackend::Igd, local_listener) + .await + { + Ok(mapping) => return Ok(mapping), + Err(error) => error, + }; + match igd_error.phase() { + UdpPortMappingAttemptPhase::Discovery => tracing::debug!( + igd_err = ?igd_error.source(), + %local_listener, + "igd gateway discovery failed, retry with nat-pmp" + ), + UdpPortMappingAttemptPhase::Establishment => tracing::debug!( + igd_err = ?igd_error.source(), + %local_listener, + "igd udp port mapping failed, retry with nat-pmp" + ), + } + + match platform + .establish_udp_port_mapping(UdpPortMappingBackend::NatPmp, local_listener) + .await + { + Ok(mapping) => Ok(mapping), + Err(nat_pmp_error) => Err(combined_mapping_error( + local_listener, + igd_error, + nat_pmp_error, + )), + } +} + +fn combined_mapping_error( + local_listener: &url::Url, + igd_error: UdpPortMappingAttemptError, + nat_pmp_error: UdpPortMappingAttemptError, +) -> anyhow::Error { + let igd_label = match igd_error.phase() { + UdpPortMappingAttemptPhase::Discovery => "igd discovery error", + UdpPortMappingAttemptPhase::Establishment => "igd error", + }; + let nat_pmp_label = match nat_pmp_error.phase() { + UdpPortMappingAttemptPhase::Discovery => "nat-pmp discovery error", + UdpPortMappingAttemptPhase::Establishment => "nat-pmp error", + }; + anyhow::anyhow!( + "udp port mapping failed for {local_listener}: {igd_label}: {}; {nat_pmp_label}: {}", + igd_error.source(), + nat_pmp_error.source(), + ) +} + +async fn run_udp_port_mapping_lifecycle( + local_listener: url::Url, + mapping: Box, + mut stop_rx: oneshot::Receiver<()>, +) { + loop { + tokio::select! { + _ = crate::foundation::time::sleep(UPNP_RENEW_INTERVAL) => { + if let Err(error) = mapping.renew().await { + tracing::warn!( + err = ?error, + %local_listener, + backend = mapping.backend().name(), + gateway_external_port = mapping.gateway_external_port(), + "failed to renew udp port mapping" + ); + } + } + _ = &mut stop_rx => break, + } + } + + if let Err(error) = mapping.remove().await { + tracing::debug!( + err = ?error, + %local_listener, + backend = mapping.backend().name(), + gateway_external_port = mapping.gateway_external_port(), + "failed to remove udp port mapping" + ); + } +} + +pub(crate) fn should_map_udp_listener(local_listener: &url::Url) -> bool { + if local_listener.scheme() != "udp" { + return false; + } + + let Some(host) = listener_ipv4_host(local_listener) else { + return false; + }; + + if host.is_loopback() || host.is_broadcast() { + return false; + } + + host.is_unspecified() || host.is_private() || host.is_link_local() +} + +fn listener_ipv4_host(local_listener: &url::Url) -> Option { + local_listener.host_str()?.parse().ok() +} + +fn udp_url(addr: SocketAddr) -> url::Url { + let mut url = url::Url::parse("udp://0.0.0.0").expect("static UDP URL should be valid"); + url.set_ip_host(addr.ip()) + .expect("socket IP should be a valid URL host"); + url.set_port(Some(addr.port())) + .expect("UDP URL should accept a port"); + url +} + +#[cfg(test)] +mod tests { + use std::sync::{ + Mutex, + atomic::{AtomicUsize, Ordering}, + }; + + use super::*; + + #[derive(Debug)] + struct MockMapping { + backend: UdpPortMappingBackend, + removals: Arc, + } + + #[async_trait] + impl ActiveUdpPortMapping for MockMapping { + fn backend(&self) -> UdpPortMappingBackend { + self.backend + } + + fn local_addr(&self) -> SocketAddr { + "192.168.1.5:11010".parse().unwrap() + } + + fn gateway_external_port(&self) -> u16 { + 41010 + } + + async fn renew(&self) -> anyhow::Result<()> { + Ok(()) + } + + async fn remove(&self) -> anyhow::Result<()> { + self.removals.fetch_add(1, Ordering::SeqCst); + Ok(()) + } + } + + struct MockPlatform { + attempts: Mutex>, + igd_phase: Option, + removals: Arc, + } + + #[async_trait] + impl UdpPortMappingPlatform for MockPlatform { + async fn establish_udp_port_mapping( + &self, + backend: UdpPortMappingBackend, + _local_listener: &url::Url, + ) -> Result, UdpPortMappingAttemptError> { + self.attempts.lock().unwrap().push(backend); + if backend == UdpPortMappingBackend::Igd + && let Some(phase) = self.igd_phase + { + return Err(match phase { + UdpPortMappingAttemptPhase::Discovery => { + UdpPortMappingAttemptError::discovery(anyhow::anyhow!("no igd")) + } + UdpPortMappingAttemptPhase::Establishment => { + UdpPortMappingAttemptError::establishment(anyhow::anyhow!("igd denied")) + } + }); + } + Ok(Box::new(MockMapping { + backend, + removals: self.removals.clone(), + })) + } + } + + #[test] + fn mapping_requires_private_or_unspecified_ipv4_listener() { + assert!(should_map_udp_listener( + &"udp://0.0.0.0:11010".parse().unwrap() + )); + assert!(should_map_udp_listener( + &"udp://192.168.1.10:11010".parse().unwrap() + )); + assert!(!should_map_udp_listener( + &"udp://127.0.0.1:11010".parse().unwrap() + )); + assert!(!should_map_udp_listener( + &"udp://8.8.8.8:11010".parse().unwrap() + )); + assert!(!should_map_udp_listener( + &"tcp://0.0.0.0:11010".parse().unwrap() + )); + } + + #[tokio::test] + async fn falls_back_from_igd_to_nat_pmp_and_removes_on_drop() { + let removals = Arc::new(AtomicUsize::new(0)); + let platform = Arc::new(MockPlatform { + attempts: Mutex::new(Vec::new()), + igd_phase: Some(UdpPortMappingAttemptPhase::Discovery), + removals: removals.clone(), + }); + + let lease = start_udp_port_mapping( + platform.clone(), + Arc::new(()), + &"udp://0.0.0.0:11010".parse().unwrap(), + ) + .await + .unwrap() + .unwrap(); + assert_eq!( + *platform.attempts.lock().unwrap(), + vec![UdpPortMappingBackend::Igd, UdpPortMappingBackend::NatPmp] + ); + + drop(lease); + tokio::time::timeout(Duration::from_secs(1), async { + while removals.load(Ordering::SeqCst) == 0 { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + assert_eq!(removals.load(Ordering::SeqCst), 1); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/tcp.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/tcp.rs new file mode 100644 index 0000000..6a7eda9 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/tcp.rs @@ -0,0 +1,1123 @@ +#![cfg_attr(not(feature = "tcp-hole-punch"), allow(dead_code))] + +use std::{ + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr}, + sync::{ + Arc, Mutex, + atomic::{AtomicBool, Ordering}, + }, + time::Duration, +}; + +use anyhow::Context as _; +use async_trait::async_trait; +use dashmap::DashMap; +use quanta::Instant; +use rand::Rng as _; +use tokio::task::JoinSet; +use tokio_util::task::AbortOnDropHandle; + +use crate::{ + config::{P2pPolicyFlags, PeerId}, + connectivity::{ + hole_punch::{ + HolePunchRpcRegistry, HolePunchTunnelSink, + policy::{BackOff, should_background_p2p_with_peer, should_try_p2p_with_peer}, + }, + protocol::{ClientProtocolUpgrader, ServerProtocolUpgrade, ServerProtocolUpgrader}, + stun::StunInfoProvider, + transport::ConnectedTransport, + }, + foundation::task::{ + ExternalTaskSignal, PeerTaskLauncher, PeerTaskManager, reap_joinset_background, + }, + peers::PeerConnectionOrigin, + proto::{ + common::{NatType, PeerFeatureFlag}, + peer_rpc::{ + TcpHolePunchRequest, TcpHolePunchResponse, TcpHolePunchRpc, TcpHolePunchRpcServer, + }, + rpc_types::{self, controller::BaseController}, + }, + socket::{ + IpVersion, SocketContext, + tcp::{ + TcpBindOptions, TcpConnectOptions, TcpListenOptions, VirtualTcpListener, + VirtualTcpListenerFactory, VirtualTcpSocketFactory, + }, + }, +}; + +pub trait TcpHolePunchHost: VirtualTcpListenerFactory + VirtualTcpSocketFactory {} + +impl TcpHolePunchHost for T where T: VirtualTcpListenerFactory + VirtualTcpSocketFactory {} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum TcpHolePunchAdmission { + Client, + Server, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct TcpPunchCandidate { + pub peer_id: PeerId, + pub tcp_nat_type: NatType, + pub feature_flag: Option, + pub has_direct_connection: bool, + pub has_recent_traffic: bool, +} + +/// Narrow peer-graph view required by the TCP hole-punch engine. +/// +/// Implemented only by the sealed peer adapter in `super::peer_adapters`. +#[async_trait] +pub trait TcpHolePunchPeerSource: Send + Sync + 'static { + fn local_peer_id(&self) -> PeerId; + + fn p2p_policy_flags(&self) -> P2pPolicyFlags; + + fn tcp_hole_punching_disabled(&self) -> bool; + + fn p2p_demand_notify(&self) -> Arc; + + async fn candidates(&self) -> Vec; + + fn rpc_stub( + &self, + dst_peer_id: PeerId, + ) -> Box + Send + Sync + 'static>; +} + +#[derive(Debug, thiserror::Error)] +pub enum TcpHolePunchTransportError { + #[error("TCP hole-punch protocol upgrade failed")] + Upgrade(#[source] anyhow::Error), + #[error("TCP hole-punch tunnel admission failed")] + Admission(#[source] anyhow::Error), +} + +#[async_trait] +pub trait TcpHolePunchTransportSink: Send + Sync + 'static { + type ConnectedSocket; + type AcceptedSocket; + + async fn add_connected_transport( + &self, + socket: Self::ConnectedSocket, + requested_url: url::Url, + admission: TcpHolePunchAdmission, + ) -> Result<(), TcpHolePunchTransportError>; + + async fn add_accepted_transport( + &self, + socket: Self::AcceptedSocket, + local_url: url::Url, + ) -> Result<(), TcpHolePunchTransportError>; +} + +pub struct ProtocolTcpHolePunchTransportSink { + client_protocol: Arc>, + server_protocol: Arc>, + tunnel_sink: Arc, +} + +impl + ProtocolTcpHolePunchTransportSink +{ + pub fn new( + client_protocol: Arc>, + server_protocol: Arc>, + tunnel_sink: Arc, + ) -> Self { + Self { + client_protocol, + server_protocol, + tunnel_sink, + } + } +} + +#[async_trait] +impl TcpHolePunchTransportSink + for ProtocolTcpHolePunchTransportSink +where + ConnectedSocket: Send + 'static, + AcceptedSocket: Send + 'static, + T: HolePunchTunnelSink, +{ + type ConnectedSocket = ConnectedSocket; + type AcceptedSocket = AcceptedSocket; + + async fn add_connected_transport( + &self, + socket: ConnectedSocket, + requested_url: url::Url, + admission: TcpHolePunchAdmission, + ) -> Result<(), TcpHolePunchTransportError> { + let tunnel = self + .client_protocol + .upgrade_client(ConnectedTransport::Tcp(socket), requested_url) + .await + .map_err(TcpHolePunchTransportError::Upgrade)?; + match admission { + TcpHolePunchAdmission::Client => { + self.tunnel_sink + .add_client_tunnel(tunnel, PeerConnectionOrigin::TcpHolePunch) + .await + } + TcpHolePunchAdmission::Server => { + self.tunnel_sink + .add_server_tunnel(tunnel, PeerConnectionOrigin::TcpHolePunch) + .await + } + } + .map_err(TcpHolePunchTransportError::Admission) + } + + async fn add_accepted_transport( + &self, + socket: AcceptedSocket, + local_url: url::Url, + ) -> Result<(), TcpHolePunchTransportError> { + let upgrade = self + .server_protocol + .upgrade_tcp(socket, local_url) + .await + .map_err(TcpHolePunchTransportError::Upgrade)?; + let ServerProtocolUpgrade::Tunnel(tunnel) = upgrade else { + return Err(TcpHolePunchTransportError::Upgrade(anyhow::anyhow!( + "TCP hole-punch protocol returned a tunnel acceptor" + ))); + }; + self.tunnel_sink + .add_server_tunnel(tunnel, PeerConnectionOrigin::TcpHolePunch) + .await + .map_err(TcpHolePunchTransportError::Admission) + } +} + +type ConnectedTcpSocket = ::Socket; +type AcceptedTcpSocket = + <::Listener as VirtualTcpListener>::Socket; + +pub(super) type TcpHolePunchTransportSinkFor = dyn TcpHolePunchTransportSink< + ConnectedSocket = ConnectedTcpSocket, + AcceptedSocket = AcceptedTcpSocket, + >; + +fn bind_addr_for_port(port: u16, is_v6: bool) -> SocketAddr { + if is_v6 { + SocketAddr::new(IpAddr::V6(Ipv6Addr::UNSPECIFIED), port) + } else { + SocketAddr::new(IpAddr::V4(Ipv4Addr::UNSPECIFIED), port) + } +} + +pub async fn select_local_port( + host: &H, + context: SocketContext, + is_v6: bool, +) -> anyhow::Result +where + H: VirtualTcpListenerFactory, +{ + let bind_addr = bind_addr_for_port(0, is_v6); + tracing::trace!(?bind_addr, is_v6, "tcp hole punch select local port"); + let context = context.with_ip_version(if is_v6 { IpVersion::V6 } else { IpVersion::V4 }); + let listener = host + .bind_tcp( + TcpListenOptions::hole_punch(bind_addr).with_bind( + TcpBindOptions::default() + .with_context(context) + .with_local_addr(Some(bind_addr)), + ), + ) + .await?; + let port = listener.local_addr()?.port(); + tracing::debug!(?bind_addr, port, "tcp hole punch selected local port"); + Ok(port) +} + +// TCP supports simultaneous connect, so both peers may dial from the mapped port. +pub async fn try_connect_to_remote( + host: Arc, + transport_sink: Arc< + dyn TcpHolePunchTransportSink< + ConnectedSocket = ::Socket, + AcceptedSocket = AcceptedSocket, + >, + >, + remote_mapped_addr: SocketAddr, + local_port: u16, + context: SocketContext, + admission: TcpHolePunchAdmission, + max_attempts: u32, +) -> anyhow::Result<()> +where + H: VirtualTcpSocketFactory, + AcceptedSocket: 'static, +{ + tracing::info!( + ?remote_mapped_addr, + local_port, + "tcp hole punch server start connect loop" + ); + + let bind_addr = bind_addr_for_port(local_port, remote_mapped_addr.is_ipv6()); + let context = context.with_ip_version(if remote_mapped_addr.is_ipv6() { + IpVersion::V6 + } else { + IpVersion::V4 + }); + let requested_url: url::Url = format!("tcp://{remote_mapped_addr}").parse().unwrap(); + + let start = crate::foundation::time::Instant::now(); + let mut attempts = 0_u32; + while start.elapsed() < Duration::from_secs(10) && attempts < max_attempts { + attempts = attempts.wrapping_add(1); + let bind = TcpBindOptions::default() + .with_context(context.clone()) + .with_local_addr(Some(bind_addr)) + .with_only_v6(true); + let options = + TcpConnectOptions::hole_punch(remote_mapped_addr, Some(bind_addr)).with_bind(bind); + if let Ok(Ok(socket)) = + crate::foundation::time::timeout(Duration::from_secs(3), host.connect_tcp(options)) + .await + { + let admission_result = transport_sink + .add_connected_transport(socket, requested_url.clone(), admission) + .await; + match admission_result { + Ok(()) => {} + Err(TcpHolePunchTransportError::Upgrade(error)) => return Err(error), + Err(TcpHolePunchTransportError::Admission(error)) => { + tracing::error!( + ?remote_mapped_addr, + local_port, + attempts, + ?error, + "tcp hole punch server connected and added client tunnel failed" + ); + continue; + } + } + + tracing::info!( + ?remote_mapped_addr, + local_port, + attempts, + ?admission, + "tcp hole punch server connected and added tunnel" + ); + return Ok(()); + } + tracing::trace!( + ?remote_mapped_addr, + local_port, + attempts, + "tcp hole punch server connect attempt failed" + ); + let sleep_ms = rand::thread_rng().gen_range(10..100); + crate::foundation::time::sleep(Duration::from_millis(sleep_ms)).await; + } + + tracing::warn!( + ?remote_mapped_addr, + local_port, + attempts, + "tcp hole punch server connect loop timeout" + ); + + Err(anyhow::anyhow!( + "tcp hole punch server connect loop timeout" + )) +} + +pub async fn accept_connections( + listener: Arc, + transport_sink: Arc< + dyn TcpHolePunchTransportSink, + >, + dst_peer_id: PeerId, +) -> anyhow::Result<()> +where + L: VirtualTcpListener, + ConnectedSocket: 'static, +{ + loop { + match listener.accept().await { + Ok((socket, _)) => { + let local_url = format!("tcp://0.0.0.0:{}", listener.local_addr()?.port()) + .parse() + .unwrap(); + if let Err(error) = transport_sink + .add_accepted_transport(socket, local_url) + .await + { + tracing::error!(?error, "tcp hole punch transport admission error"); + continue; + } + + tracing::info!( + dst_peer_id, + "tcp hole punch initiator accepted and added server tunnel" + ); + } + Err(error) => { + tracing::error!(?error, "tcp hole punch accept error"); + } + } + } +} + +const BLACKLIST_TIMEOUT: Duration = Duration::from_secs(3600); + +fn fallback_listener_options( + socket_context: SocketContext, + bind_addr: std::net::SocketAddr, +) -> TcpListenOptions { + let bind = TcpBindOptions::default() + .with_context(socket_context.with_ip_version(IpVersion::V4)) + .with_local_addr(Some(bind_addr)) + .with_only_v6(true); + TcpListenOptions::hole_punch(bind_addr).with_bind(bind) +} + +struct TcpHolePunchBlacklist { + entries: DashMap, +} + +impl TcpHolePunchBlacklist { + fn new() -> Self { + Self { + entries: DashMap::new(), + } + } + + fn insert(&self, peer_id: PeerId) { + self.entries.insert(peer_id, Instant::now()); + } + + fn contains(&self, peer_id: PeerId) -> bool { + let active = self + .entries + .get(&peer_id) + .is_some_and(|inserted_at| inserted_at.elapsed() < BLACKLIST_TIMEOUT); + if !active { + self.entries.remove(&peer_id); + } + active + } + + fn cleanup(&self) { + self.entries + .retain(|_, inserted_at| inserted_at.elapsed() < BLACKLIST_TIMEOUT); + } +} + +fn handle_rpc_result( + result: Result, + dst_peer_id: PeerId, + blacklist: &TcpHolePunchBlacklist, +) -> Result { + match result { + Ok(result) => Ok(result), + Err(error) => { + if matches!(error, rpc_types::error::Error::InvalidServiceKey(_, _)) { + blacklist.insert(dst_peer_id); + } + Err(error) + } + } +} + +fn is_symmetric_tcp_nat(nat_type: NatType) -> bool { + matches!( + nat_type, + NatType::Symmetric | NatType::SymmetricEasyInc | NatType::SymmetricEasyDec + ) +} + +struct TcpHolePunchServer +where + H: TcpHolePunchHost, +{ + host: Arc, + stun: Arc, + socket_context: SocketContext, + transport_sink: Arc>, + tasks: Arc>>, + reaper: Mutex>>, + stopping: AtomicBool, +} + +impl TcpHolePunchServer +where + H: TcpHolePunchHost, +{ + fn new( + host: Arc, + stun: Arc, + socket_context: SocketContext, + transport_sink: Arc>, + ) -> Arc { + Arc::new(Self { + host, + stun, + socket_context, + transport_sink, + tasks: Arc::new(Mutex::new(JoinSet::new())), + reaper: Mutex::new(None), + stopping: AtomicBool::new(true), + }) + } + + fn start(&self) { + let mut reaper = self.reaper.lock().unwrap(); + if reaper.as_ref().is_some_and(|task| !task.is_finished()) { + return; + } + { + let _tasks = self.tasks.lock().unwrap(); + self.stopping.store(false, Ordering::Release); + } + reaper.replace(AbortOnDropHandle::new(tokio::spawn( + reap_joinset_background(Arc::downgrade(&self.tasks), "tcp hole punch"), + ))); + } + + fn begin_stop(&self) { + self.stopping.store(true, Ordering::Release); + } + + async fn stop(&self) { + let reaper = self.reaper.lock().unwrap().take(); + if let Some(reaper) = reaper { + reaper.abort(); + let _ = reaper.await; + } + let mut tasks = { + let mut task_slot = self.tasks.lock().unwrap(); + std::mem::replace(&mut *task_slot, JoinSet::new()) + }; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + } +} + +#[async_trait] +impl TcpHolePunchRpc for TcpHolePunchServer +where + H: TcpHolePunchHost, +{ + type Controller = BaseController; + + #[tracing::instrument(skip(self), fields(a_mapped_addr = ?input.connector_mapped_addr), err)] + async fn exchange_mapped_addr( + &self, + _controller: Self::Controller, + input: TcpHolePunchRequest, + ) -> rpc_types::error::Result { + let local_nat_type = + NatType::try_from(self.stun.get_stun_info().tcp_nat_type).unwrap_or(NatType::Unknown); + tracing::debug!(?local_nat_type, "tcp hole punch rpc received"); + if local_nat_type == NatType::Unknown { + tracing::warn!(?local_nat_type, "tcp hole punch rpc rejected (unknown)"); + return Err(anyhow::anyhow!("tcp nat type unknown not supported").into()); + } + + let remote_mapped_addr = input + .connector_mapped_addr + .ok_or_else(|| anyhow::anyhow!("connector_mapped_addr is required"))?; + let remote_mapped_addr: std::net::SocketAddr = remote_mapped_addr.into(); + let remote_ip = remote_mapped_addr.ip(); + if remote_ip.is_unspecified() || remote_ip.is_multicast() { + tracing::warn!( + ?remote_mapped_addr, + "tcp hole punch rpc invalid connector addr" + ); + return Err(anyhow::anyhow!("connector_mapped_addr is malformed").into()); + } + + let local_port = select_local_port( + self.host.as_ref(), + self.socket_context.clone(), + remote_mapped_addr.is_ipv6(), + ) + .await?; + let local_mapped_addr = self + .stun + .get_tcp_port_mapping(local_port) + .await + .context("failed to get tcp port mapping")?; + + tracing::info!( + ?remote_mapped_addr, + local_port, + ?local_mapped_addr, + "tcp hole punch rpc responding with listener mapped addr and start connecting" + ); + + let host = self.host.clone(); + let socket_context = self.socket_context.clone(); + let transport_sink = self.transport_sink.clone(); + let mut tasks = self.tasks.lock().unwrap(); + if self.stopping.load(Ordering::Acquire) { + return Err(rpc_types::error::Error::Shutdown); + } + tasks.spawn(async move { + let _ = try_connect_to_remote( + host, + transport_sink, + remote_mapped_addr, + local_port, + socket_context, + TcpHolePunchAdmission::Client, + 5, + ) + .await; + }); + + Ok(TcpHolePunchResponse { + listener_mapped_addr: Some(local_mapped_addr.into()), + }) + } +} + +struct TcpHolePunchConnectorData +where + H: TcpHolePunchHost, + P: TcpHolePunchPeerSource, +{ + host: Arc, + stun: Arc, + socket_context: SocketContext, + peer_source: Arc

, + transport_sink: Arc>, + blacklist: TcpHolePunchBlacklist, +} + +impl TcpHolePunchConnectorData +where + H: TcpHolePunchHost, + P: TcpHolePunchPeerSource, +{ + async fn punch_as_initiator(self: Arc, dst_peer_id: PeerId) -> anyhow::Result<()> { + let mut backoff = BackOff::new(vec![1000, 1000, 4000, 8000]); + + loop { + backoff.sleep_for_next_backoff().await; + if self.do_punch_as_initiator(dst_peer_id).await.is_ok() { + break; + } + + if self.blacklist.contains(dst_peer_id) { + tracing::warn!( + dst_peer_id, + "tcp hole punch initiator skipped (blacklisted)" + ); + break; + } + } + + Ok(()) + } + + #[tracing::instrument(skip(self), fields(dst_peer_id), err)] + async fn do_punch_as_initiator(&self, dst_peer_id: PeerId) -> anyhow::Result<()> { + let local_nat_type = + NatType::try_from(self.stun.get_stun_info().tcp_nat_type).unwrap_or(NatType::Unknown); + tracing::debug!(?local_nat_type, "tcp hole punch initiator start"); + if is_symmetric_tcp_nat(local_nat_type) || local_nat_type == NatType::Unknown { + tracing::debug!("tcp hole punch initiator skipped (symmetric)"); + return Ok(()); + } + + let local_port = + select_local_port(self.host.as_ref(), self.socket_context.clone(), false).await?; + let local_mapped_addr = self + .stun + .get_tcp_port_mapping(local_port) + .await + .context("failed to get tcp port mapping")?; + + tracing::info!( + dst_peer_id, + local_port, + ?local_mapped_addr, + "tcp hole punch initiator got mapped addr, start rpc exchange" + ); + + let rpc_stub = self.peer_source.rpc_stub(dst_peer_id); + let response = rpc_stub + .exchange_mapped_addr( + BaseController { + timeout_ms: 6000, + ..Default::default() + }, + TcpHolePunchRequest { + connector_mapped_addr: Some(local_mapped_addr.into()), + }, + ) + .await; + let response = handle_rpc_result(response, dst_peer_id, &self.blacklist)?; + let remote_mapped_addr = response + .listener_mapped_addr + .ok_or_else(|| anyhow::anyhow!("listener_mapped_addr is required"))?; + let remote_mapped_addr = remote_mapped_addr.into(); + tracing::info!( + dst_peer_id, + ?remote_mapped_addr, + "tcp hole punch initiator rpc returned" + ); + + if try_connect_to_remote( + self.host.clone(), + self.transport_sink.clone(), + remote_mapped_addr, + local_port, + self.socket_context.clone(), + TcpHolePunchAdmission::Server, + 1, + ) + .await + .is_ok() + { + tracing::info!( + dst_peer_id, + local_port, + ?remote_mapped_addr, + "tcp hole punch initiator connected to remote mapped addr with simultaneous connection" + ); + return Ok(()); + } + + tracing::debug!( + dst_peer_id, + local_port, + ?remote_mapped_addr, + "tcp hole punch initiator sent syn to remote mapped addr" + ); + + let bind_addr = + std::net::SocketAddr::new(std::net::Ipv4Addr::UNSPECIFIED.into(), local_port); + let listener = self + .host + .bind_tcp(fallback_listener_options( + self.socket_context.clone(), + bind_addr, + )) + .await?; + tracing::info!( + dst_peer_id, + local_port, + local_addr = ?listener.local_addr()?, + "tcp hole punch initiator listening" + ); + + crate::foundation::time::timeout( + Duration::from_secs(10), + accept_connections(listener, self.transport_sink.clone(), dst_peer_id), + ) + .await??; + + tracing::info!( + dst_peer_id, + "tcp hole punch initiator accepted and added server tunnel" + ); + Ok(()) + } + + async fn collect_peers_need_task(&self) -> Vec { + let local_nat_type = + NatType::try_from(self.stun.get_stun_info().tcp_nat_type).unwrap_or(NatType::Unknown); + if is_symmetric_tcp_nat(local_nat_type) || local_nat_type == NatType::Unknown { + tracing::trace!( + ?local_nat_type, + "tcp hole punch task collect skipped (symmetric)" + ); + return Vec::new(); + } + + self.blacklist.cleanup(); + let policy = self.peer_source.p2p_policy_flags(); + let local_peer_id = self.peer_source.local_peer_id(); + let mut peers_to_connect = Vec::new(); + for candidate in self.peer_source.candidates().await { + let static_allowed = should_background_p2p_with_peer( + candidate.feature_flag.as_ref(), + false, + policy.lazy_p2p, + policy.disable_p2p, + policy.need_p2p, + ); + let dynamic_allowed = should_try_p2p_with_peer( + candidate.feature_flag.as_ref(), + false, + policy.disable_p2p, + policy.need_p2p, + ) && candidate.has_recent_traffic; + if !static_allowed && !dynamic_allowed { + continue; + } + + let peer_id = candidate.peer_id; + if peer_id == local_peer_id { + tracing::trace!(peer_id, "tcp hole punch task collect skip self"); + continue; + } + if self.blacklist.contains(peer_id) { + tracing::debug!(peer_id, "tcp hole punch task collect skip blacklisted"); + continue; + } + if candidate.has_direct_connection { + tracing::trace!(peer_id, "tcp hole punch task collect skip already has peer"); + continue; + } + + let peer_nat_type = candidate.tcp_nat_type; + if peer_nat_type == NatType::Unknown { + tracing::debug!( + peer_id, + ?peer_nat_type, + "tcp hole punch task collect skip peer unknown" + ); + continue; + } + + tracing::info!( + peer_id, + local_peer_id, + ?local_nat_type, + ?peer_nat_type, + "tcp hole punch task collect add peer" + ); + peers_to_connect.push(peer_id); + } + peers_to_connect + } +} + +struct TcpHolePunchPeerTaskLauncher(Arc>) +where + H: TcpHolePunchHost, + P: TcpHolePunchPeerSource; + +impl Clone for TcpHolePunchPeerTaskLauncher +where + H: TcpHolePunchHost, + P: TcpHolePunchPeerSource, +{ + fn clone(&self) -> Self { + Self(self.0.clone()) + } +} + +#[async_trait] +impl PeerTaskLauncher for TcpHolePunchPeerTaskLauncher +where + H: TcpHolePunchHost, + P: TcpHolePunchPeerSource, +{ + type CollectPeerItem = PeerId; + type TaskRet = (); + + async fn collect_peers_need_task(&self) -> Vec { + self.0.collect_peers_need_task().await + } + + async fn launch_task( + &self, + dst_peer_id: PeerId, + ) -> tokio::task::JoinHandle> { + let data = self.0.clone(); + tokio::spawn(async move { data.punch_as_initiator(dst_peer_id).await }) + } + + fn loop_interval_ms(&self) -> u64 { + 5000 + } +} + +pub struct TcpHolePunchConnector +where + H: TcpHolePunchHost, + P: TcpHolePunchPeerSource + HolePunchTunnelSink + HolePunchRpcRegistry, +{ + server: Arc>, + client: PeerTaskManager>, + peer_source: Arc

, +} + +impl TcpHolePunchConnector +where + H: TcpHolePunchHost, + P: TcpHolePunchPeerSource + HolePunchTunnelSink + HolePunchRpcRegistry, +{ + pub fn new( + peer_source: Arc

, + host: Arc, + stun: Arc, + socket_context: SocketContext, + client_protocol: Arc>>, + server_protocol: Arc>>, + ) -> Self { + let transport_sink: Arc> = + Arc::new(ProtocolTcpHolePunchTransportSink::new( + client_protocol, + server_protocol, + peer_source.clone(), + )); + let data = Arc::new(TcpHolePunchConnectorData { + host: host.clone(), + stun: stun.clone(), + socket_context: socket_context.clone(), + peer_source: peer_source.clone(), + transport_sink: transport_sink.clone(), + blacklist: TcpHolePunchBlacklist::new(), + }); + Self { + server: TcpHolePunchServer::new(host, stun, socket_context, transport_sink), + client: PeerTaskManager::new_with_external_signal( + TcpHolePunchPeerTaskLauncher(data), + Some(peer_source.p2p_demand_notify()), + ), + peer_source, + } + } + + pub fn run(&self) { + if self.peer_source.tcp_hole_punching_disabled() { + tracing::debug!("tcp hole punch disabled by runtime configuration"); + return; + } + self.server.start(); + self.peer_source + .register_rpc_service(TcpHolePunchRpcServer::new_arc(self.server.clone())); + self.client.start(); + } + + pub async fn stop(&self) { + self.client.stop().await; + self.server.begin_stop(); + self.peer_source + .unregister_rpc_service(TcpHolePunchRpcServer::new_arc(self.server.clone())); + self.server.stop().await; + } +} + +#[cfg(test)] +mod tests { + use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering}; + + use super::*; + use crate::tunnel::Tunnel; + + #[derive(Default)] + struct MockProtocols { + client_upgrades: AtomicUsize, + server_upgrades: AtomicUsize, + fail_client_upgrade: AtomicBool, + } + + #[async_trait] + impl ClientProtocolUpgrader<()> for MockProtocols { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "tcp" + } + + async fn upgrade_client( + &self, + connected: ConnectedTransport<()>, + _requested_url: url::Url, + ) -> anyhow::Result> { + let ConnectedTransport::Tcp(()) = connected else { + anyhow::bail!("expected TCP transport"); + }; + if self.fail_client_upgrade.load(Ordering::Relaxed) { + anyhow::bail!("mock client upgrade failure"); + } + self.client_upgrades.fetch_add(1, Ordering::Relaxed); + Ok(crate::tunnel::ring::create_ring_tunnel_pair().0) + } + } + + #[async_trait] + impl ServerProtocolUpgrader<()> for MockProtocols { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "tcp" + } + + async fn upgrade_tcp( + &self, + _socket: (), + _local_url: url::Url, + ) -> anyhow::Result { + self.server_upgrades.fetch_add(1, Ordering::Relaxed); + Ok(ServerProtocolUpgrade::Tunnel( + crate::tunnel::ring::create_ring_tunnel_pair().0, + )) + } + + async fn upgrade_udp( + &self, + _session: crate::socket::udp::UdpSession, + _local_url: url::Url, + _admission: Option, + ) -> anyhow::Result { + anyhow::bail!("unexpected UDP transport") + } + + async fn upgrade_byte_stream( + &self, + _socket: (), + _local_url: url::Url, + _remote_url: Option, + ) -> anyhow::Result { + anyhow::bail!("unexpected byte stream") + } + } + + #[derive(Default)] + struct MockTunnelSink { + clients: AtomicUsize, + servers: AtomicUsize, + fail_client_admission: AtomicBool, + } + + #[async_trait] + impl HolePunchTunnelSink for MockTunnelSink { + async fn add_client_tunnel( + &self, + _tunnel: Box, + origin: PeerConnectionOrigin, + ) -> anyhow::Result<()> { + assert_eq!(origin, PeerConnectionOrigin::TcpHolePunch); + if self.fail_client_admission.load(Ordering::Relaxed) { + anyhow::bail!("mock client admission failure"); + } + self.clients.fetch_add(1, Ordering::Relaxed); + Ok(()) + } + + async fn add_server_tunnel( + &self, + _tunnel: Box, + origin: PeerConnectionOrigin, + ) -> anyhow::Result<()> { + assert_eq!(origin, PeerConnectionOrigin::TcpHolePunch); + self.servers.fetch_add(1, Ordering::Relaxed); + Ok(()) + } + } + + #[tokio::test] + async fn protocol_sink_upgrades_before_tcp_hole_punch_admission() { + let protocols = Arc::new(MockProtocols::default()); + let tunnel_sink = Arc::new(MockTunnelSink::default()); + let sink = ProtocolTcpHolePunchTransportSink::new( + protocols.clone(), + protocols.clone(), + tunnel_sink.clone(), + ); + let url = url::Url::parse("tcp://198.51.100.1:11010").unwrap(); + + sink.add_connected_transport((), url.clone(), TcpHolePunchAdmission::Client) + .await + .unwrap(); + sink.add_connected_transport((), url.clone(), TcpHolePunchAdmission::Server) + .await + .unwrap(); + sink.add_accepted_transport((), url).await.unwrap(); + + assert_eq!(protocols.client_upgrades.load(Ordering::Relaxed), 2); + assert_eq!(protocols.server_upgrades.load(Ordering::Relaxed), 1); + assert_eq!(tunnel_sink.clients.load(Ordering::Relaxed), 1); + assert_eq!(tunnel_sink.servers.load(Ordering::Relaxed), 2); + + protocols.fail_client_upgrade.store(true, Ordering::Relaxed); + assert!(matches!( + sink.add_connected_transport( + (), + url::Url::parse("tcp://198.51.100.1:11010").unwrap(), + TcpHolePunchAdmission::Client, + ) + .await, + Err(TcpHolePunchTransportError::Upgrade(_)) + )); + protocols + .fail_client_upgrade + .store(false, Ordering::Relaxed); + tunnel_sink + .fail_client_admission + .store(true, Ordering::Relaxed); + assert!(matches!( + sink.add_connected_transport( + (), + url::Url::parse("tcp://198.51.100.1:11010").unwrap(), + TcpHolePunchAdmission::Client, + ) + .await, + Err(TcpHolePunchTransportError::Admission(_)) + )); + } + + #[test] + fn bind_address_tracks_requested_family_and_port() { + assert_eq!( + bind_addr_for_port(1234, false), + "0.0.0.0:1234".parse().unwrap() + ); + assert_eq!(bind_addr_for_port(4321, true), "[::]:4321".parse().unwrap()); + } + + #[test] + fn symmetric_tcp_nat_variants_are_ineligible_initiators() { + assert!(is_symmetric_tcp_nat(NatType::Symmetric)); + assert!(is_symmetric_tcp_nat(NatType::SymmetricEasyInc)); + assert!(is_symmetric_tcp_nat(NatType::SymmetricEasyDec)); + assert!(!is_symmetric_tcp_nat(NatType::PortRestricted)); + assert!(!is_symmetric_tcp_nat(NatType::Unknown)); + } + + #[test] + fn blacklist_tracks_and_cleans_entries() { + let blacklist = TcpHolePunchBlacklist::new(); + assert!(!blacklist.contains(7)); + blacklist.insert(7); + assert!(blacklist.contains(7)); + blacklist.cleanup(); + assert!(blacklist.contains(7)); + } + + #[test] + fn fallback_listener_normalizes_context_to_ipv4() { + let bind_addr = "0.0.0.0:23333".parse().unwrap(); + let context = SocketContext::default() + .with_socket_mark(Some(0)) + .with_netns(Some(crate::socket::NetNamespace::new("test-netns"))); + + let options = fallback_listener_options(context, bind_addr); + + assert_eq!( + options.purpose, + crate::socket::tcp::TcpListenPurpose::HolePunch + ); + assert_eq!(options.bind.local_addr, Some(bind_addr)); + assert_eq!(options.bind.context.ip_version, IpVersion::V4); + assert_eq!(options.bind.context.socket_mark, Some(0)); + assert_eq!( + options + .bind + .context + .netns + .as_ref() + .map(|netns| netns.token()), + Some("test-netns") + ); + assert!(options.bind.only_v6); + assert_eq!(options.bind.reuse_addr, None); + assert!(!options.bind.reuse_port); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/binding.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/binding.rs new file mode 100644 index 0000000..72691a3 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/binding.rs @@ -0,0 +1,802 @@ +//! Core-owned UDP hole-punch socket/session runtime. + +use std::{ + net::{IpAddr, Ipv4Addr, SocketAddr, SocketAddrV4}, + sync::{Arc, Weak}, +}; + +use anyhow::Context as _; +use async_trait::async_trait; + +use crate::{ + connectivity::{ + direct::DirectConnectorHost, + hole_punch::port_mapping::{UdpPortMappingPlatform, start_udp_port_mapping}, + hole_punch::{HolePunchRpcRegistry, HolePunchTunnelSink}, + protocol::ClientProtocolUpgrader, + stun::{StunInfoProvider, StunSocketMapper}, + }, + proto::peer_rpc::UdpHolePunchRpcServer, + socket::{ + IpVersion, ListenerConnectionCounter, SocketContext, + tcp::VirtualTcpSocketFactory, + udp::{ + UdpBindOptions, UdpSessionLayer, UdpSessionSocket, UdpSessionStunResponder, + VirtualUdpSocket, VirtualUdpSocketFactory, + }, + }, +}; + +use super::{ + ProtocolUdpHolePunchTransportSink, UdpHolePunchConnector, UdpHolePunchPeerSource, + UdpHolePunchRuntime, UdpPunchAcceptor, UdpPunchListener, UdpPunchSocket, UdpResolvedPublicAddr, + UdpSymPunchLock, + rpc::{PeerRpcUdpHolePunchSignaling, UdpHolePunchRpcEndpoint, UdpHolePunchRpcSource}, +}; + +async fn resolve_public_addr_with_policy( + stun: &dyn StunSocketMapper, + platform: Option>, + events: Arc, + socket: Arc, + local_listener: &url::Url, + disable_upnp: bool, +) -> anyhow::Result +where + S: VirtualUdpSocket + 'static, +{ + let port_mapping_lease = if disable_upnp { + None + } else if let Some(platform) = platform { + match start_udp_port_mapping(platform, events, local_listener).await { + Ok(lease) => lease, + Err(error) => { + tracing::warn!( + ?error, + %local_listener, + "failed to establish udp port mapping, fallback to stun-only public addr resolution" + ); + None + } + } + } else { + None + }; + + let mapped_addr = stun + .get_udp_port_mapping_with_socket(socket) + .await + .with_context(|| format!("resolve udp public addr for {local_listener}"))?; + if let Some(lease) = &port_mapping_lease { + lease.public_addr_resolved(mapped_addr); + } else { + tracing::debug!( + %local_listener, + stun_mapped_addr = %mapped_addr, + "udp public addr resolved without port mapping" + ); + } + + Ok(UdpResolvedPublicAddr { + mapped_addr, + port_mapping_lease, + }) +} + +fn managed_local_addr_error( + local_addr: SocketAddr, + is_local_virtual_ipv4: bool, + is_easytier_managed_ipv6: bool, +) -> Option<&'static str> { + match local_addr.ip() { + IpAddr::V4(_) if is_local_virtual_ipv4 => Some("local address is virtual ipv4"), + IpAddr::V6(_) if is_easytier_managed_ipv6 => Some("local address is easytier-managed ipv6"), + _ => None, + } +} + +type HostUdpSocket = ::Socket; +type HostTcpSocket = ::Socket; +type CoreUdpSessionLayer = UdpSessionLayer, H>; +type CoreUdpHolePunchTransportSink = ProtocolUdpHolePunchTransportSink, P>; +type CoreUdpHolePunchConnector = UdpHolePunchConnector< + P, + PeerRpcUdpHolePunchSignaling

, + CoreUdpHolePunchTransportSink, + CoreUdpHolePunchRuntime, +>; +type CoreUdpHolePunchEndpoint = + UdpHolePunchRpcEndpoint, CoreUdpHolePunchTransportSink>; + +pub(crate) struct CoreUdpHolePunchService +where + H: DirectConnectorHost, + P: UdpHolePunchPeerSource + + HolePunchTunnelSink + + UdpHolePunchRpcSource + + HolePunchRpcRegistry + + 'static, +{ + server: Arc>, + client: CoreUdpHolePunchConnector, + peer_source: Arc

, +} + +impl CoreUdpHolePunchService +where + H: DirectConnectorHost + Send + Sync + 'static, + HostUdpSocket: VirtualUdpSocket + 'static, + P: UdpHolePunchPeerSource + + HolePunchTunnelSink + + UdpHolePunchRpcSource + + HolePunchRpcRegistry + + 'static, +{ + pub(crate) fn new( + peer_source: Arc

, + host: Arc, + stun: Arc>>, + platform: Option>, + events: Arc, + socket_context: SocketContext, + protocol: Arc>>, + ) -> Self { + let stun_mapper = stun.clone(); + let stun_info: Arc = stun; + let transport_sink = Arc::new(ProtocolUdpHolePunchTransportSink::new( + protocol, + peer_source.clone(), + )); + let runtime = Arc::new(CoreUdpHolePunchRuntime::new( + host, + peer_source.clone(), + stun_mapper, + platform, + events, + socket_context, + )); + let sym_punch_lock = UdpSymPunchLock::default(); + let client = UdpHolePunchConnector::new( + peer_source.clone(), + Arc::new(PeerRpcUdpHolePunchSignaling::new(peer_source.clone())), + transport_sink.clone(), + runtime.clone(), + stun_info.clone(), + sym_punch_lock.clone(), + Some(peer_source.p2p_demand_notify()), + ); + + Self { + server: UdpHolePunchRpcEndpoint::new( + stun_info, + transport_sink, + sym_punch_lock, + runtime, + ), + client, + peer_source, + } + } + + pub(crate) async fn start(&self) -> anyhow::Result<()> { + if self + .peer_source + .p2p_policy_flags() + .disable_udp_hole_punching + { + return Ok(()); + } + + self.server.start().await; + self.peer_source + .register_rpc_service(UdpHolePunchRpcServer::new(Arc::downgrade(&self.server))); + self.client.run_as_client(); + Ok(()) + } + + pub(crate) async fn stop(&self) { + self.client.stop().await; + self.server.begin_stop(); + self.peer_source + .unregister_rpc_service(UdpHolePunchRpcServer::new(Arc::downgrade(&self.server))); + self.server.stop().await; + } +} + +struct CoreUdpPunchAcceptor +where + H: VirtualUdpSocketFactory, + HostUdpSocket: VirtualUdpSocket, +{ + layer: Arc>, +} + +#[async_trait] +impl UdpPunchAcceptor for CoreUdpPunchAcceptor +where + H: VirtualUdpSocketFactory + UdpSessionStunResponder> + Send + Sync + 'static, + HostUdpSocket: VirtualUdpSocket + 'static, +{ + async fn accept(&mut self) -> anyhow::Result { + let session = self.layer.accept().await?; + let remote_addr = session.peer_addr()?; + Ok(UdpPunchSocket::new( + session, + remote_addr, + self.layer.clone(), + )) + } +} + +struct CoreUdpPunchConnCounter +where + H: VirtualUdpSocketFactory, + HostUdpSocket: VirtualUdpSocket, +{ + layer: Weak>, +} + +impl std::fmt::Debug for CoreUdpPunchConnCounter +where + H: VirtualUdpSocketFactory, + HostUdpSocket: VirtualUdpSocket, +{ + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("CoreUdpPunchConnCounter") + .finish_non_exhaustive() + } +} + +impl ListenerConnectionCounter for CoreUdpPunchConnCounter +where + H: VirtualUdpSocketFactory + UdpSessionStunResponder> + Send + Sync + 'static, + HostUdpSocket: VirtualUdpSocket + 'static, +{ + fn get(&self) -> Option { + Some( + self.layer + .upgrade() + .map(|layer| layer.active_session_count() as u32) + .unwrap_or(0), + ) + } +} + +pub struct CoreUdpHolePunchRuntime +where + H: DirectConnectorHost, + P: UdpHolePunchPeerSource + 'static, +{ + host: Arc, + peer_source: Arc

, + stun: Arc>>, + platform: Option>, + events: Arc, + socket_context: SocketContext, +} + +impl CoreUdpHolePunchRuntime +where + H: DirectConnectorHost + Send + Sync + 'static, + HostUdpSocket: VirtualUdpSocket + 'static, + P: UdpHolePunchPeerSource + 'static, +{ + pub fn new( + host: Arc, + peer_source: Arc

, + stun: Arc>>, + platform: Option>, + events: Arc, + socket_context: SocketContext, + ) -> Self { + Self { + host, + peer_source, + stun, + platform, + events, + socket_context, + } + } + + fn session_layer(&self, socket: Arc>) -> Arc> { + Arc::new(UdpSessionLayer::new_with_stun_responder( + socket, + self.host.clone(), + )) + } + + async fn create_listener_with_mapping( + &self, + resolve_public_addr: bool, + port: Option, + ) -> anyhow::Result>> { + let bind = match port { + Some(port) => UdpBindOptions::hole_punch_candidate().with_local_addr(Some( + SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, port)), + )), + None => UdpBindOptions::hole_punch_control(), + } + .with_context(self.socket_context.clone().with_ip_version(IpVersion::V4)); + let socket = self.host.bind_udp(bind).await?; + let local_port = socket.local_addr()?.port(); + let resolved = if resolve_public_addr { + self.resolve_public_addr(socket.clone()).await? + } else { + UdpResolvedPublicAddr { + mapped_addr: SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, local_port)), + port_mapping_lease: None, + } + }; + + let layer = self.session_layer(socket.clone()); + let conn_counter = Arc::new(CoreUdpPunchConnCounter { + layer: Arc::downgrade(&layer), + }); + let acceptor = Box::new(CoreUdpPunchAcceptor { layer }); + + Ok(UdpPunchListener { + socket, + mapped_addr: resolved.mapped_addr, + conn_counter, + acceptor, + port_mapping_lease: resolved.port_mapping_lease, + }) + } + + async fn resolve_public_addr( + &self, + socket: Arc>, + ) -> anyhow::Result { + let local_port = socket.local_addr()?.port(); + let local_listener: url::Url = format!("udp://0.0.0.0:{local_port}").parse()?; + resolve_public_addr_with_policy( + self.stun.as_ref(), + self.platform.clone(), + self.events.clone(), + socket, + &local_listener, + self.peer_source.p2p_policy_flags().disable_upnp, + ) + .await + } + + async fn validate_socket_route( + &self, + context: SocketContext, + remote_addr: SocketAddr, + ) -> anyhow::Result<()> { + let local_addr = self + .host + .local_addr_for_remote(remote_addr, context) + .await?; + let is_local_virtual_ipv4 = match local_addr.ip() { + IpAddr::V4(ip) => self.peer_source.is_local_virtual_ip(&IpAddr::V4(ip)), + IpAddr::V6(_) => false, + }; + let is_easytier_managed_ipv6 = match local_addr.ip() { + IpAddr::V4(_) => false, + IpAddr::V6(ip) => self.peer_source.is_easytier_managed_ipv6(&ip).await, + }; + if let Some(error) = + managed_local_addr_error(local_addr, is_local_virtual_ipv4, is_easytier_managed_ipv6) + { + anyhow::bail!(error); + } + Ok(()) + } +} + +#[async_trait] +impl UdpHolePunchRuntime for CoreUdpHolePunchRuntime +where + H: DirectConnectorHost + Send + Sync + 'static, + HostUdpSocket: VirtualUdpSocket + 'static, + P: UdpHolePunchPeerSource + 'static, +{ + type Socket = HostUdpSocket; + + fn socket_context(&self) -> SocketContext { + self.socket_context.clone() + } + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.host.bind_udp(options).await + } + + async fn bind_direct_connect_udp(&self) -> anyhow::Result> { + self.host + .bind_udp( + UdpBindOptions::hole_punch_candidate() + .with_context(self.socket_context.clone().with_ip_version(IpVersion::V4)), + ) + .await + } + + async fn resolve_udp_public_addr( + &self, + socket: Arc, + ) -> anyhow::Result { + self.resolve_public_addr(socket).await + } + + async fn create_listener( + &self, + _prefer_port_mapping: bool, + ) -> anyhow::Result> { + self.create_listener_with_mapping(true, None).await + } + + async fn create_port_bound_listener( + &self, + port: u16, + ) -> anyhow::Result> { + self.create_listener_with_mapping(false, Some(port)).await + } + + async fn connect_with_socket( + &self, + socket: Arc, + remote: SocketAddr, + ) -> anyhow::Result { + self.validate_socket_route(socket.socket_context(), remote) + .await?; + let layer = self.session_layer(socket); + let session = layer.connect(remote).await?; + if session.peer_addr()? != remote { + tracing::debug!( + recv_addr = ?session.peer_addr()?, + ?remote, + "udp connect addr not match" + ); + } + Ok(UdpPunchSocket::new(session, remote, layer)) + } +} + +#[cfg(test)] +mod tests { + use std::{ + io, + net::{Ipv6Addr, SocketAddrV6}, + sync::{ + Mutex, + atomic::{AtomicUsize, Ordering}, + }, + }; + + use crate::{connectivity::stun::StunInfoProvider, proto::common::StunInfo}; + + use super::*; + + #[derive(Debug)] + struct MockSocket { + local_addr: SocketAddr, + } + + #[async_trait] + impl VirtualUdpSocket for MockSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], _addr: SocketAddr) -> io::Result { + Ok(data.len()) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } + } + + struct MockStun { + mapped_addr: SocketAddr, + fail: bool, + calls: AtomicUsize, + } + + impl MockStun { + fn succeeds_with(mapped_addr: SocketAddr) -> Self { + Self { + mapped_addr, + fail: false, + calls: AtomicUsize::new(0), + } + } + + fn failing() -> Self { + Self { + mapped_addr: "0.0.0.0:0".parse().unwrap(), + fail: true, + calls: AtomicUsize::new(0), + } + } + } + + #[async_trait] + impl StunInfoProvider for MockStun { + fn get_stun_info(&self) -> StunInfo { + StunInfo::default() + } + + async fn get_udp_port_mapping(&self, _local_port: u16) -> anyhow::Result { + Ok(self.mapped_addr) + } + + async fn get_tcp_port_mapping(&self, _local_port: u16) -> anyhow::Result { + Ok(self.mapped_addr) + } + + fn update_stun_info(&self) {} + } + + #[async_trait] + impl StunSocketMapper for MockStun { + async fn get_udp_port_mapping_with_socket( + &self, + _socket: Arc, + ) -> anyhow::Result { + self.calls.fetch_add(1, Ordering::SeqCst); + if self.fail { + anyhow::bail!("mock STUN failure"); + } + Ok(self.mapped_addr) + } + } + + #[derive(Debug, Default)] + struct LeaseState { + drops: AtomicUsize, + } + + #[derive(Default)] + struct MockEvents { + established: Mutex>, + } + + impl crate::events::CoreEventSink for MockEvents { + fn emit(&self, event: crate::events::CoreEvent) { + self.established.lock().unwrap().push(event); + } + } + + #[derive(Debug)] + struct MockMapping { + state: Arc, + backend: crate::connectivity::hole_punch::port_mapping::UdpPortMappingBackend, + } + + #[async_trait] + impl crate::connectivity::hole_punch::port_mapping::ActiveUdpPortMapping for MockMapping { + fn backend(&self) -> crate::connectivity::hole_punch::port_mapping::UdpPortMappingBackend { + self.backend + } + + fn local_addr(&self) -> SocketAddr { + "192.168.1.5:30123".parse().unwrap() + } + + fn gateway_external_port(&self) -> u16 { + 40123 + } + + async fn renew(&self) -> anyhow::Result<()> { + Ok(()) + } + + async fn remove(&self) -> anyhow::Result<()> { + self.state.drops.fetch_add(1, Ordering::SeqCst); + Ok(()) + } + } + + struct MockPlatform { + calls: AtomicUsize, + fail: bool, + lease_state: Arc, + } + + impl MockPlatform { + fn failing() -> Self { + Self { + calls: AtomicUsize::new(0), + fail: true, + lease_state: Arc::default(), + } + } + + fn with_lease(lease_state: Arc) -> Self { + Self { + calls: AtomicUsize::new(0), + fail: false, + lease_state, + } + } + } + + #[async_trait] + impl UdpPortMappingPlatform for MockPlatform { + async fn establish_udp_port_mapping( + &self, + backend: crate::connectivity::hole_punch::port_mapping::UdpPortMappingBackend, + _local_listener: &url::Url, + ) -> Result< + Box, + crate::connectivity::hole_punch::port_mapping::UdpPortMappingAttemptError, + > { + self.calls.fetch_add(1, Ordering::SeqCst); + if self.fail { + return Err( + crate::connectivity::hole_punch::port_mapping::UdpPortMappingAttemptError::establishment( + anyhow::anyhow!("mock port-mapping failure"), + ), + ); + } + Ok(Box::new(MockMapping { + state: self.lease_state.clone(), + backend, + })) + } + } + + fn socket() -> Arc { + Arc::new(MockSocket { + local_addr: "0.0.0.0:30123".parse().unwrap(), + }) + } + + fn listener_url() -> url::Url { + "udp://0.0.0.0:30123".parse().unwrap() + } + + #[tokio::test] + async fn port_mapping_failure_falls_back_to_stun() { + let mapped_addr = "198.51.100.8:40123".parse().unwrap(); + let stun = MockStun::succeeds_with(mapped_addr); + let platform = Arc::new(MockPlatform::failing()); + + let resolved = resolve_public_addr_with_policy( + &stun, + Some(platform.clone()), + Arc::new(()), + socket(), + &listener_url(), + false, + ) + .await + .unwrap(); + + assert_eq!(resolved.mapped_addr, mapped_addr); + assert!(resolved.port_mapping_lease.is_none()); + assert_eq!(platform.calls.load(Ordering::SeqCst), 2); + assert_eq!(stun.calls.load(Ordering::SeqCst), 1); + } + + #[tokio::test] + async fn stun_failure_releases_mapping_without_notification() { + let lease_state = Arc::new(LeaseState::default()); + let platform = Arc::new(MockPlatform::with_lease(lease_state.clone())); + let events = Arc::new(MockEvents::default()); + + let result = resolve_public_addr_with_policy( + &MockStun::failing(), + Some(platform), + events.clone(), + socket(), + &listener_url(), + false, + ) + .await; + + assert!(result.is_err()); + tokio::time::timeout(std::time::Duration::from_secs(1), async { + while lease_state.drops.load(Ordering::SeqCst) == 0 { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + assert_eq!(lease_state.drops.load(Ordering::SeqCst), 1); + assert!(events.established.lock().unwrap().is_empty()); + } + + #[tokio::test] + async fn disable_upnp_is_applied_per_resolution() { + let mapped_addr = "198.51.100.9:40124".parse().unwrap(); + let stun = MockStun::succeeds_with(mapped_addr); + let lease_state = Arc::new(LeaseState::default()); + let platform = Arc::new(MockPlatform::with_lease(lease_state)); + + let disabled = resolve_public_addr_with_policy( + &stun, + Some(platform.clone()), + Arc::new(()), + socket(), + &listener_url(), + true, + ) + .await + .unwrap(); + assert!(disabled.port_mapping_lease.is_none()); + assert_eq!(platform.calls.load(Ordering::SeqCst), 0); + + let enabled = resolve_public_addr_with_policy( + &stun, + Some(platform.clone()), + Arc::new(()), + socket(), + &listener_url(), + false, + ) + .await + .unwrap(); + assert!(enabled.port_mapping_lease.is_some()); + assert_eq!(platform.calls.load(Ordering::SeqCst), 1); + } + + #[tokio::test] + async fn successful_mapping_is_notified_and_held_with_result() { + let mapped_addr = "198.51.100.10:40125".parse().unwrap(); + let lease_state = Arc::new(LeaseState::default()); + let platform = Arc::new(MockPlatform::with_lease(lease_state.clone())); + let events = Arc::new(MockEvents::default()); + + let resolved = resolve_public_addr_with_policy( + &MockStun::succeeds_with(mapped_addr), + Some(platform), + events.clone(), + socket(), + &listener_url(), + false, + ) + .await + .unwrap(); + + { + let established = events.established.lock().unwrap(); + assert!(matches!( + established.as_slice(), + [crate::events::CoreEvent::UdpPortMappingEstablished { + local_listener, + mapped_listener, + backend, + }] if local_listener == &listener_url() + && mapped_listener.as_str() == "udp://198.51.100.10:40125" + && backend == "igd" + )); + } + assert_eq!(lease_state.drops.load(Ordering::SeqCst), 0); + drop(resolved); + tokio::time::timeout(std::time::Duration::from_secs(1), async { + while lease_state.drops.load(Ordering::SeqCst) == 0 { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + assert_eq!(lease_state.drops.load(Ordering::SeqCst), 1); + } + + #[test] + fn managed_local_addresses_are_rejected() { + let virtual_ipv4 = "10.144.0.2:1234".parse().unwrap(); + assert_eq!( + managed_local_addr_error(virtual_ipv4, true, false), + Some("local address is virtual ipv4") + ); + assert_eq!(managed_local_addr_error(virtual_ipv4, false, false), None); + + let managed_ipv6 = SocketAddr::V6(SocketAddrV6::new( + "fd00::1".parse::().unwrap(), + 1234, + 0, + 0, + )); + assert_eq!( + managed_local_addr_error(managed_ipv6, false, true), + Some("local address is easytier-managed ipv6") + ); + assert_eq!(managed_local_addr_error(managed_ipv6, false, false), None); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/client.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/client.rs new file mode 100644 index 0000000..a40fce5 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/client.rs @@ -0,0 +1,995 @@ +use std::{ + net::{IpAddr, Ipv4Addr, SocketAddr}, + sync::{ + Arc, + atomic::{AtomicBool, Ordering}, + }, +}; + +use guarden::defer; +use quanta::Instant; +use rand::Rng; +use tokio::sync::RwLock; +use tokio_util::task::AbortOnDropHandle; + +use crate::{ + config::PeerId, + connectivity::stun::StunInfoProvider, + packet::{HOLE_PUNCH_PACKET_BODY_LEN, new_hole_punch_packet}, + socket::udp::{UdpBindOptions, VirtualUdpSocketFactory}, +}; + +use super::{ + SelectPunchListener, SendPunchPacketBothEasySym, SendPunchPacketCone, SendPunchPacketEasySym, + SendPunchPacketHardSym, UdpHolePunchRuntime, UdpHolePunchSignalError, UdpHolePunchSignaling, + UdpNatType, UdpPunchSocket, UdpSocketArray, +}; + +#[derive(Debug, thiserror::Error)] +pub enum UdpHolePunchClientError { + #[error("signaling: {0}")] + Signaling(#[from] UdpHolePunchSignalError), + #[error(transparent)] + Other(#[from] anyhow::Error), +} + +pub type UdpHolePunchClientResult = Result; + +const UDP_ARRAY_SIZE_FOR_HARD_SYM: usize = 84; +const UDP_ARRAY_SIZE_FOR_BOTH_EASY_SYM: usize = 25; +const DST_PORT_OFFSET: u16 = 20; +const REMOTE_WAIT_TIME_MS: u64 = 5000; + +pub fn apply_peer_easy_sym_port_offset(base_port: u16, peer_is_incremental: bool) -> u16 { + let port = if peer_is_incremental { + (base_port as u32).saturating_add(DST_PORT_OFFSET as u32) + } else { + (base_port as u32).saturating_sub(DST_PORT_OFFSET as u32) + }; + port as u16 +} + +#[tracing::instrument(skip(runtime, signaling), fields(dst_peer_id), err)] +pub async fn punch_cone_to_cone( + runtime: Arc, + signaling: Arc, + dst_peer_id: PeerId, +) -> UdpHolePunchClientResult> +where + R: UdpHolePunchRuntime, + S: UdpHolePunchSignaling + 'static, +{ + tracing::info!(?dst_peer_id, "start hole punching"); + let tid = rand::random(); + + let udp_array = UdpSocketArray::new_with_context(1, runtime.clone(), runtime.socket_context()); + + let resp = signaling + .select_punch_listener( + dst_peer_id, + SelectPunchListener { + force_new: false, + prefer_port_mapping: true, + }, + ) + .await?; + let remote_mapped_addr = resp.listener_mapped_addr; + + let local_socket = UdpHolePunchRuntime::bind_udp( + runtime.as_ref(), + UdpBindOptions::hole_punch_control().with_context( + runtime + .socket_context() + .with_ip_version(crate::socket::IpVersion::V4), + ), + ) + .await?; + let resolved = runtime + .resolve_udp_public_addr(local_socket.clone()) + .await?; + let local_mapped_addr = resolved.mapped_addr; + let _local_port_mapping_lease = resolved.port_mapping_lease; + + tracing::debug!( + ?local_mapped_addr, + ?remote_mapped_addr, + "hole punch got remote listener" + ); + + udp_array.add_new_socket(local_socket).await?; + udp_array.add_intreast_tid(tid); + let punch_packet = new_hole_punch_packet(tid, HOLE_PUNCH_PACKET_BODY_LEN).into_bytes(); + + send_from_local(&udp_array, &punch_packet, remote_mapped_addr).await?; + + let signaling_for_task = signaling.clone(); + let punch_task = AbortOnDropHandle::new(tokio::spawn(async move { + if let Err(e) = signaling_for_task + .send_punch_packet_cone( + dst_peer_id, + SendPunchPacketCone { + listener_mapped_addr: remote_mapped_addr, + dest_addr: local_mapped_addr, + transaction_id: tid, + packet_count_per_batch: 2, + packet_batch_count: 5, + packet_interval_ms: 400, + }, + ) + .await + { + tracing::error!(?e, "failed to call remote send punch packet"); + } + })); + + let mut finish_time: Option = None; + while finish_time.is_none() || finish_time.as_ref().unwrap().elapsed().as_millis() < 1000 { + crate::foundation::time::sleep(std::time::Duration::from_millis(200)).await; + + if finish_time.is_none() && punch_task.is_finished() { + finish_time = Some(Instant::now()); + } + + let Some(socket) = udp_array.try_fetch_punched_socket(tid) else { + tracing::debug!("no punched socket found, send some more hole punch packets"); + send_from_local(&udp_array, &punch_packet, remote_mapped_addr).await?; + continue; + }; + + tracing::debug!(?socket, ?tid, "punched socket found, try connect with it"); + + for _ in 0..2 { + match runtime + .connect_with_socket(socket.socket.clone(), remote_mapped_addr) + .await + { + Ok(socket) => { + tracing::info!(?socket, "hole punched"); + return Ok(Some(socket)); + } + Err(e) => { + tracing::error!(?e, "failed to connect with socket"); + } + } + } + } + + Ok(None) +} + +async fn send_from_local( + udp_array: &UdpSocketArray, + punch_packet: &[u8], + remote_mapped_addr: SocketAddr, +) -> UdpHolePunchClientResult<()> +where + R: VirtualUdpSocketFactory, +{ + udp_array + .send_with_all(punch_packet, remote_mapped_addr) + .await?; + Ok(()) +} + +pub struct UdpSymToConePunchClient +where + R: UdpHolePunchRuntime, + S: UdpHolePunchSignaling + 'static, +{ + runtime: Arc, + signaling: Arc, + stun: Arc, + udp_array: RwLock>>>, + try_direct_connect: AtomicBool, + punch_predictably: AtomicBool, +} + +impl UdpSymToConePunchClient +where + R: UdpHolePunchRuntime, + S: UdpHolePunchSignaling + 'static, +{ + pub fn new(runtime: Arc, signaling: Arc, stun: Arc) -> Self { + Self { + runtime, + signaling, + stun, + udp_array: RwLock::new(None), + try_direct_connect: AtomicBool::new(true), + punch_predictably: AtomicBool::new(true), + } + } + + pub async fn clear_udp_array(&self) { + let mut wlocked = self.udp_array.write().await; + wlocked.take(); + } + + async fn prepare_udp_array(&self) -> anyhow::Result>> { + let rlocked = self.udp_array.read().await; + if let Some(udp_array) = rlocked.clone() { + return Ok(udp_array); + } + + drop(rlocked); + let mut wlocked = self.udp_array.write().await; + if let Some(udp_array) = wlocked.clone() { + return Ok(udp_array); + } + + let udp_array = Arc::new(UdpSocketArray::new_with_context( + UDP_ARRAY_SIZE_FOR_HARD_SYM, + self.runtime.clone(), + self.runtime.socket_context(), + )); + udp_array.start().await?; + wlocked.replace(udp_array.clone()); + Ok(udp_array) + } + + async fn get_base_port_for_easy_sym(&self, my_nat_info: UdpNatType) -> Option { + if my_nat_info.is_easy_sym() { + match self.stun.get_udp_port_mapping(0).await { + Ok(addr) => Some(addr.port()), + ret => { + tracing::warn!(?ret, "failed to get udp port mapping for easy sym"); + None + } + } + } else { + None + } + } + + async fn remote_send_hole_punch_packet_predictable( + signaling: Arc, + dst_peer_id: PeerId, + base_port_for_easy_sym: Option, + my_nat_info: UdpNatType, + remote_mapped_addr: SocketAddr, + public_ips: Vec, + tid: u32, + ) { + let Some(inc) = my_nat_info.get_inc_of_easy_sym() else { + return; + }; + let req = SendPunchPacketEasySym { + listener_mapped_addr: remote_mapped_addr, + public_ips, + transaction_id: tid, + base_port_num: base_port_for_easy_sym.unwrap() as u32, + max_port_num: 50, + is_incremental: inc, + }; + tracing::debug!(?req, "send punch packet for easy sym start"); + let ret = signaling.send_punch_packet_easy_sym(dst_peer_id, req).await; + tracing::debug!(?ret, "send punch packet for easy sym return"); + } + + async fn remote_send_hole_punch_packet_random( + signaling: Arc, + dst_peer_id: PeerId, + remote_mapped_addr: SocketAddr, + public_ips: Vec, + tid: u32, + round: u32, + port_index: u32, + ) -> Option { + let req = SendPunchPacketHardSym { + listener_mapped_addr: remote_mapped_addr, + public_ips, + transaction_id: tid, + round, + port_index, + }; + tracing::debug!(?req, "send punch packet for hard sym start"); + match signaling.send_punch_packet_hard_sym(dst_peer_id, req).await { + Err(e) => { + tracing::error!(?e, "failed to send punch packet for hard sym"); + None + } + Ok(resp) => Some(resp.next_port_index), + } + } + + async fn check_hole_punch_result( + &self, + udp_array: &Arc>, + packet: &[u8], + tid: u32, + remote_mapped_addr: SocketAddr, + punch_task: &AbortOnDropHandle, + ) -> anyhow::Result> { + let mut ret_socket = None; + let mut finish_time: Option = None; + while finish_time.is_none() || finish_time.as_ref().unwrap().elapsed().as_millis() < 1000 { + udp_array.send_with_all(packet, remote_mapped_addr).await?; + + crate::foundation::time::sleep(std::time::Duration::from_millis(200)).await; + + if finish_time.is_none() && punch_task.is_finished() { + finish_time = Some(Instant::now()); + } + + let Some(socket) = udp_array.try_fetch_punched_socket(tid) else { + tracing::debug!("no punched socket found, wait for more time"); + continue; + }; + + match self + .runtime + .connect_with_socket(socket.socket.clone(), remote_mapped_addr) + .await + { + Ok(socket) => { + ret_socket.replace(socket); + break; + } + Err(e) => { + tracing::error!(?e, "failed to connect with socket"); + udp_array.add_new_socket(socket.socket).await?; + continue; + } + } + } + + Ok(ret_socket) + } + + #[tracing::instrument(err(level = tracing::Level::ERROR), skip(self))] + pub async fn do_hole_punching( + &self, + dst_peer_id: PeerId, + round: u32, + last_port_idx: &mut usize, + my_nat_info: UdpNatType, + ) -> UdpHolePunchClientResult> { + let udp_array = self.prepare_udp_array().await?; + + let resp = self + .signaling + .select_punch_listener( + dst_peer_id, + SelectPunchListener { + force_new: false, + prefer_port_mapping: true, + }, + ) + .await?; + + let remote_mapped_addr = resp.listener_mapped_addr; + + if self.try_direct_connect.load(Ordering::Relaxed) { + let socket = self.runtime.bind_direct_connect_udp().await?; + if let Ok(socket) = self + .runtime + .connect_with_socket(socket, remote_mapped_addr) + .await + { + return Ok(Some(socket)); + } + } + + let stun_info = self.stun.get_stun_info(); + let public_ips: Vec = stun_info + .public_ip + .iter() + .filter_map(|x| x.parse().ok()) + .collect(); + if public_ips.is_empty() { + return Err(anyhow::anyhow!("failed to get public ips").into()); + } + + let tid = rand::thread_rng().r#gen(); + let packet = new_hole_punch_packet(tid, HOLE_PUNCH_PACKET_BODY_LEN).into_bytes(); + udp_array.add_intreast_tid(tid); + defer! { udp_array.remove_intreast_tid(tid); } + + let port_index = *last_port_idx as u32; + let base_port_for_easy_sym = self.get_base_port_for_easy_sym(my_nat_info).await; + udp_array.send_with_all(&packet, remote_mapped_addr).await?; + + if self.punch_predictably.load(Ordering::Relaxed) && base_port_for_easy_sym.is_some() { + let signaling = self.signaling.clone(); + let punch_task = AbortOnDropHandle::new(tokio::spawn( + Self::remote_send_hole_punch_packet_predictable( + signaling, + dst_peer_id, + base_port_for_easy_sym, + my_nat_info, + remote_mapped_addr, + public_ips.clone(), + tid, + ), + )); + let ret_socket = self + .check_hole_punch_result(&udp_array, &packet, tid, remote_mapped_addr, &punch_task) + .await?; + + let task_ret = punch_task.await; + tracing::debug!(?ret_socket, ?task_ret, "predictable punch task got result"); + if let Some(socket) = ret_socket { + return Ok(Some(socket)); + } + } + + let signaling = self.signaling.clone(); + let punch_task = + AbortOnDropHandle::new(tokio::spawn(Self::remote_send_hole_punch_packet_random( + signaling, + dst_peer_id, + remote_mapped_addr, + public_ips.clone(), + tid, + round, + port_index, + ))); + let ret_socket = self + .check_hole_punch_result(&udp_array, &packet, tid, remote_mapped_addr, &punch_task) + .await?; + + let punch_task_result = punch_task.await; + tracing::debug!(?punch_task_result, ?ret_socket, "punch task got result"); + + if let Ok(Some(next_port_idx)) = punch_task_result { + *last_port_idx = next_port_idx as usize; + } else { + *last_port_idx = rand::random(); + } + + Ok(ret_socket) + } +} + +pub struct UdpBothEasySymPunchClient +where + R: UdpHolePunchRuntime, + S: UdpHolePunchSignaling + 'static, +{ + runtime: Arc, + signaling: Arc, + stun: Arc, +} + +impl UdpBothEasySymPunchClient +where + R: UdpHolePunchRuntime, + S: UdpHolePunchSignaling + 'static, +{ + pub fn new(runtime: Arc, signaling: Arc, stun: Arc) -> Self { + Self { + runtime, + signaling, + stun, + } + } + + #[tracing::instrument(ret, skip(self))] + pub async fn do_hole_punching( + &self, + dst_peer_id: PeerId, + my_nat_info: UdpNatType, + peer_nat_info: UdpNatType, + is_busy: &mut bool, + ) -> UdpHolePunchClientResult> { + *is_busy = false; + + let udp_array = UdpSocketArray::new_with_context( + UDP_ARRAY_SIZE_FOR_BOTH_EASY_SYM, + self.runtime.clone(), + self.runtime.socket_context(), + ); + udp_array.start().await?; + + let cur_mapped_addr = self.stun.get_udp_port_mapping(0).await?; + let my_public_ip = match cur_mapped_addr.ip() { + IpAddr::V4(v4) => v4, + _ => { + return Err(anyhow::anyhow!("ipv6 is not supported").into()); + } + }; + let me_is_incremental = my_nat_info + .get_inc_of_easy_sym() + .ok_or(anyhow::anyhow!("me_is_incremental is required"))?; + let peer_is_incremental = peer_nat_info + .get_inc_of_easy_sym() + .ok_or(anyhow::anyhow!("peer_is_incremental is required"))?; + + let tid = rand::random(); + udp_array.add_intreast_tid(tid); + + let remote_ret = self + .signaling + .send_punch_packet_both_easy_sym( + dst_peer_id, + SendPunchPacketBothEasySym { + transaction_id: tid, + public_ip: my_public_ip, + dst_port_num: if me_is_incremental { + cur_mapped_addr.port().saturating_add(DST_PORT_OFFSET) + } else { + cur_mapped_addr.port().saturating_sub(DST_PORT_OFFSET) + } as u32, + udp_socket_count: UDP_ARRAY_SIZE_FOR_BOTH_EASY_SYM as u32, + wait_time_ms: REMOTE_WAIT_TIME_MS as u32, + }, + ) + .await?; + + if remote_ret.is_busy { + *is_busy = true; + return Err(anyhow::anyhow!("remote is busy").into()); + } + + let mut remote_mapped_addr = remote_ret + .base_mapped_addr + .ok_or(anyhow::anyhow!("remote_mapped_addr is required"))?; + + let now = Instant::now(); + remote_mapped_addr.set_port(apply_peer_easy_sym_port_offset( + remote_mapped_addr.port(), + peer_is_incremental, + )); + tracing::debug!( + ?remote_mapped_addr, + ?remote_ret, + "start send hole punch packet for both easy sym" + ); + + while now.elapsed().as_millis() < (REMOTE_WAIT_TIME_MS + 1000).into() { + udp_array + .send_with_all( + &new_hole_punch_packet(tid, HOLE_PUNCH_PACKET_BODY_LEN).into_bytes(), + remote_mapped_addr, + ) + .await?; + + crate::foundation::time::sleep(std::time::Duration::from_millis(100)).await; + + let Some(socket) = udp_array.try_fetch_punched_socket(tid) else { + tracing::trace!( + ?remote_mapped_addr, + ?tid, + "no punched socket found, send some more hole punch packets" + ); + continue; + }; + + tracing::info!( + ?socket, + ?remote_mapped_addr, + ?tid, + "got punched socket in both easy sym" + ); + + for _ in 0..2 { + match self + .runtime + .connect_with_socket(socket.socket.clone(), remote_mapped_addr) + .await + { + Ok(socket) => { + return Ok(Some(socket)); + } + Err(e) => { + tracing::error!(?e, "failed to connect with socket"); + continue; + } + } + } + udp_array.add_new_socket(socket.socket).await?; + } + + Ok(None) + } +} + +#[cfg(test)] +mod tests { + use std::{ + io, + sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, + }, + }; + + use async_trait::async_trait; + + use super::*; + use crate::{ + proto::common::{NatType, StunInfo}, + socket::udp::VirtualUdpSocket, + }; + + impl UdpSymToConePunchClient + where + R: UdpHolePunchRuntime, + S: UdpHolePunchSignaling + 'static, + { + fn set_try_direct_connect(&self, enabled: bool) { + self.try_direct_connect.store(enabled, Ordering::Relaxed); + } + } + + struct MockSocket { + local_addr: SocketAddr, + } + + #[async_trait] + impl VirtualUdpSocket for MockSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, _data: &[u8], _addr: SocketAddr) -> io::Result { + Ok(0) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } + } + + struct MockRuntime { + bind_count: AtomicUsize, + resolve_count: AtomicUsize, + bind_options: tokio::sync::Mutex>, + } + + impl MockRuntime { + fn new() -> Self { + Self { + bind_count: AtomicUsize::new(0), + resolve_count: AtomicUsize::new(0), + bind_options: tokio::sync::Mutex::new(Vec::new()), + } + } + } + + #[async_trait] + impl UdpHolePunchRuntime for MockRuntime { + type Socket = MockSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.bind_options.lock().await.push(options); + let bind_idx = self.bind_count.fetch_add(1, Ordering::Relaxed); + Ok(Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], 10000 + bind_idx as u16)), + })) + } + + async fn resolve_udp_public_addr( + &self, + _socket: Arc, + ) -> anyhow::Result { + self.resolve_count.fetch_add(1, Ordering::Relaxed); + Ok(super::super::UdpResolvedPublicAddr { + mapped_addr: SocketAddr::from(([203, 0, 113, 1], 10000)), + port_mapping_lease: None, + }) + } + + async fn create_listener( + &self, + _prefer_port_mapping: bool, + ) -> anyhow::Result> { + unimplemented!("not used by cone client tests") + } + + async fn create_port_bound_listener( + &self, + _port: u16, + ) -> anyhow::Result> { + unimplemented!("not used by cone client tests") + } + + async fn connect_with_socket( + &self, + _socket: Arc, + _remote: SocketAddr, + ) -> anyhow::Result { + unimplemented!("not used by cone client tests") + } + } + + #[derive(Default)] + struct MockStunInfoProvider { + port_mapping_count: AtomicUsize, + } + + #[async_trait] + impl StunInfoProvider for MockStunInfoProvider { + fn get_stun_info(&self) -> StunInfo { + StunInfo { + public_ip: vec!["127.0.0.1".to_string()], + ..Default::default() + } + } + + async fn get_udp_port_mapping(&self, _port: u16) -> anyhow::Result { + self.port_mapping_count.fetch_add(1, Ordering::Relaxed); + Ok(SocketAddr::from(([203, 0, 113, 1], 10000))) + } + + async fn get_tcp_port_mapping(&self, _port: u16) -> anyhow::Result { + unreachable!("TCP mapping is not used by UDP hole-punch tests") + } + + fn update_stun_info(&self) {} + } + + struct RejectingSignaling; + + #[async_trait] + impl UdpHolePunchSignaling for RejectingSignaling { + async fn select_punch_listener( + &self, + _dst_peer_id: PeerId, + _request: SelectPunchListener, + ) -> Result { + Err(UdpHolePunchSignalError::InvalidServiceKey) + } + + async fn send_punch_packet_cone( + &self, + _dst_peer_id: PeerId, + _request: SendPunchPacketCone, + ) -> Result<(), UdpHolePunchSignalError> { + Ok(()) + } + + async fn send_punch_packet_hard_sym( + &self, + _dst_peer_id: PeerId, + _request: super::super::SendPunchPacketHardSym, + ) -> Result { + unimplemented!("not used by cone client tests") + } + + async fn send_punch_packet_easy_sym( + &self, + _dst_peer_id: PeerId, + _request: super::super::SendPunchPacketEasySym, + ) -> Result<(), UdpHolePunchSignalError> { + unimplemented!("not used by cone client tests") + } + + async fn send_punch_packet_both_easy_sym( + &self, + _dst_peer_id: PeerId, + _request: super::super::SendPunchPacketBothEasySym, + ) -> Result + { + unimplemented!("not used by cone client tests") + } + } + + #[tokio::test] + async fn cone_punch_does_not_bind_or_resolve_before_listener_rpc_succeeds() { + let runtime = Arc::new(MockRuntime::new()); + let signaling = Arc::new(RejectingSignaling); + + let err = punch_cone_to_cone(runtime.clone(), signaling, 2) + .await + .unwrap_err(); + + assert!(matches!( + err, + UdpHolePunchClientError::Signaling(UdpHolePunchSignalError::InvalidServiceKey) + )); + assert_eq!(runtime.bind_count.load(Ordering::Relaxed), 0); + assert_eq!(runtime.resolve_count.load(Ordering::Relaxed), 0); + } + + #[tokio::test] + async fn default_direct_connect_bind_uses_direct_connect_purpose() { + let runtime = MockRuntime::new(); + + let socket = runtime.bind_direct_connect_udp().await.unwrap(); + + assert_eq!(socket.local_addr().unwrap().port(), 10000); + let bind_options = runtime.bind_options.lock().await; + assert_eq!( + bind_options.as_slice(), + &[UdpBindOptions::direct_connect().with_ip_version(crate::socket::IpVersion::V4)] + ); + } + + struct RecordingSignaling { + easy_requests: tokio::sync::Mutex>, + hard_requests: tokio::sync::Mutex>, + both_requests: tokio::sync::Mutex>, + both_response: super::super::SendPunchPacketBothEasySymResponse, + next_port_index: u32, + } + + impl RecordingSignaling { + fn new(next_port_index: u32) -> Self { + Self { + easy_requests: tokio::sync::Mutex::new(Vec::new()), + hard_requests: tokio::sync::Mutex::new(Vec::new()), + both_requests: tokio::sync::Mutex::new(Vec::new()), + both_response: super::super::SendPunchPacketBothEasySymResponse { + is_busy: false, + base_mapped_addr: Some(SocketAddr::from(([127, 0, 0, 1], 40144))), + }, + next_port_index, + } + } + + fn with_both_response( + mut self, + both_response: super::super::SendPunchPacketBothEasySymResponse, + ) -> Self { + self.both_response = both_response; + self + } + } + + #[async_trait] + impl UdpHolePunchSignaling for RecordingSignaling { + async fn select_punch_listener( + &self, + _dst_peer_id: PeerId, + _request: SelectPunchListener, + ) -> Result { + Ok(super::super::SelectPunchListenerResponse { + listener_mapped_addr: SocketAddr::from(([127, 0, 0, 1], 30000)), + }) + } + + async fn send_punch_packet_cone( + &self, + _dst_peer_id: PeerId, + _request: SendPunchPacketCone, + ) -> Result<(), UdpHolePunchSignalError> { + Ok(()) + } + + async fn send_punch_packet_hard_sym( + &self, + _dst_peer_id: PeerId, + request: SendPunchPacketHardSym, + ) -> Result { + self.hard_requests.lock().await.push(request); + Ok(super::super::SendPunchPacketHardSymResponse { + next_port_index: self.next_port_index, + }) + } + + async fn send_punch_packet_easy_sym( + &self, + _dst_peer_id: PeerId, + request: SendPunchPacketEasySym, + ) -> Result<(), UdpHolePunchSignalError> { + self.easy_requests.lock().await.push(request); + Ok(()) + } + + async fn send_punch_packet_both_easy_sym( + &self, + _dst_peer_id: PeerId, + request: SendPunchPacketBothEasySym, + ) -> Result + { + self.both_requests.lock().await.push(request); + Ok(self.both_response.clone()) + } + } + + #[tokio::test] + async fn sym_to_cone_easy_sym_uses_port_mapping_in_predictable_request() { + let runtime = Arc::new(MockRuntime::new()); + let signaling = Arc::new(RecordingSignaling::new(42)); + let stun = Arc::new(MockStunInfoProvider::default()); + let client = UdpSymToConePunchClient::new(runtime.clone(), signaling.clone(), stun.clone()); + client.set_try_direct_connect(false); + + let mut last_port_idx = 7; + let ret = client + .do_hole_punching(2, 3, &mut last_port_idx, NatType::SymmetricEasyInc.into()) + .await + .unwrap(); + + assert!(ret.is_none()); + assert_eq!(stun.port_mapping_count.load(Ordering::Relaxed), 1); + + let easy_requests = signaling.easy_requests.lock().await; + assert_eq!(easy_requests.len(), 1); + let req = &easy_requests[0]; + assert_eq!( + req.listener_mapped_addr, + SocketAddr::from(([127, 0, 0, 1], 30000)) + ); + assert_eq!(req.public_ips, vec![Ipv4Addr::new(127, 0, 0, 1)]); + assert_eq!(req.base_port_num, 10000); + assert_eq!(req.max_port_num, 50); + assert!(req.is_incremental); + + let hard_requests = signaling.hard_requests.lock().await; + assert_eq!(hard_requests.len(), 1); + assert_eq!(last_port_idx, 42); + } + + #[tokio::test] + async fn sym_to_cone_hard_sym_sends_random_request_and_updates_port_index() { + let runtime = Arc::new(MockRuntime::new()); + let signaling = Arc::new(RecordingSignaling::new(321)); + let stun = Arc::new(MockStunInfoProvider::default()); + let client = UdpSymToConePunchClient::new(runtime.clone(), signaling.clone(), stun.clone()); + client.set_try_direct_connect(false); + + let mut last_port_idx = 123; + let ret = client + .do_hole_punching(2, 4, &mut last_port_idx, NatType::Symmetric.into()) + .await + .unwrap(); + + assert!(ret.is_none()); + assert_eq!(stun.port_mapping_count.load(Ordering::Relaxed), 0); + assert!(signaling.easy_requests.lock().await.is_empty()); + + let hard_requests = signaling.hard_requests.lock().await; + assert_eq!(hard_requests.len(), 1); + let req = &hard_requests[0]; + assert_eq!( + req.listener_mapped_addr, + SocketAddr::from(([127, 0, 0, 1], 30000)) + ); + assert_eq!(req.public_ips, vec![Ipv4Addr::new(127, 0, 0, 1)]); + assert_eq!(req.round, 4); + assert_eq!(req.port_index, 123); + assert_eq!(last_port_idx, 321); + } + + #[test] + fn both_easy_sym_port_offset_preserves_old_proto_cast_semantics() { + assert_eq!(apply_peer_easy_sym_port_offset(65530, true), 14); + assert_eq!(apply_peer_easy_sym_port_offset(10, false), 0); + } + + #[tokio::test] + async fn both_easy_sym_sends_remote_request_and_reports_busy() { + let runtime = Arc::new(MockRuntime::new()); + let stun = Arc::new(MockStunInfoProvider::default()); + let signaling = Arc::new(RecordingSignaling::new(0).with_both_response( + super::super::SendPunchPacketBothEasySymResponse { + is_busy: true, + base_mapped_addr: None, + }, + )); + let client = + UdpBothEasySymPunchClient::new(runtime.clone(), signaling.clone(), stun.clone()); + + let mut is_busy = false; + let err = client + .do_hole_punching( + 2, + NatType::SymmetricEasyInc.into(), + NatType::SymmetricEasyDec.into(), + &mut is_busy, + ) + .await + .unwrap_err(); + + assert!(is_busy); + assert!(err.to_string().contains("remote is busy")); + assert_eq!(stun.port_mapping_count.load(Ordering::Relaxed), 1); + assert_eq!( + runtime.bind_count.load(Ordering::Relaxed), + UDP_ARRAY_SIZE_FOR_BOTH_EASY_SYM + ); + + let both_requests = signaling.both_requests.lock().await; + assert_eq!(both_requests.len(), 1); + let req = &both_requests[0]; + assert_eq!(req.public_ip, Ipv4Addr::new(203, 0, 113, 1)); + assert_eq!(req.dst_port_num, 10020); + assert_eq!( + req.udp_socket_count, + UDP_ARRAY_SIZE_FOR_BOTH_EASY_SYM as u32 + ); + assert_eq!(req.wait_time_ms, REMOTE_WAIT_TIME_MS as u32); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/common.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/common.rs new file mode 100644 index 0000000..aada742 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/common.rs @@ -0,0 +1,249 @@ +use crate::{config::PeerId, proto::common::NatType}; + +pub const BLACKLIST_TIMEOUT_SEC: u64 = 3600; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum UdpPunchClientMethod { + None, + ConeToCone, + SymToCone, + EasySymToEasySym, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub enum UdpNatType { + Unknown, + Open(NatType), + Cone(NatType), + EasySymmetric(NatType, bool), + HardSymmetric(NatType), +} + +impl From for UdpNatType { + fn from(nat_type: NatType) -> Self { + match nat_type { + NatType::Unknown => UdpNatType::Unknown, + NatType::OpenInternet => UdpNatType::Open(nat_type), + NatType::NoPat | NatType::FullCone | NatType::Restricted | NatType::PortRestricted => { + UdpNatType::Cone(nat_type) + } + NatType::Symmetric | NatType::SymUdpFirewall => UdpNatType::HardSymmetric(nat_type), + NatType::SymmetricEasyInc => UdpNatType::EasySymmetric(nat_type, true), + NatType::SymmetricEasyDec => UdpNatType::EasySymmetric(nat_type, false), + } + } +} + +impl From for NatType { + fn from(val: UdpNatType) -> Self { + match val { + UdpNatType::Unknown => NatType::Unknown, + UdpNatType::Open(nat_type) => nat_type, + UdpNatType::Cone(nat_type) => nat_type, + UdpNatType::EasySymmetric(nat_type, _) => nat_type, + UdpNatType::HardSymmetric(nat_type) => nat_type, + } + } +} + +impl UdpNatType { + pub fn is_open(&self) -> bool { + matches!(self, UdpNatType::Open(_)) + } + + pub fn is_unknown(&self) -> bool { + matches!(self, UdpNatType::Unknown) + } + + pub fn is_sym(&self) -> bool { + self.is_hard_sym() || self.is_easy_sym() + } + + pub fn is_hard_sym(&self) -> bool { + matches!(self, UdpNatType::HardSymmetric(_)) + } + + pub fn is_easy_sym(&self) -> bool { + matches!(self, UdpNatType::EasySymmetric(_, _)) + } + + pub fn is_cone(&self) -> bool { + matches!(self, UdpNatType::Cone(_)) + } + + pub fn get_inc_of_easy_sym(&self) -> Option { + match self { + UdpNatType::EasySymmetric(_, inc) => Some(*inc), + _ => None, + } + } + + pub fn get_punch_hole_method( + &self, + other: Self, + disable_sym_hole_punching: bool, + ) -> UdpPunchClientMethod { + if disable_sym_hole_punching && self.is_sym() { + if other.is_sym() { + return UdpPunchClientMethod::None; + } else { + return UdpPunchClientMethod::ConeToCone; + } + } + + if other.is_unknown() { + if self.is_sym() { + return UdpPunchClientMethod::SymToCone; + } else { + return UdpPunchClientMethod::ConeToCone; + } + } + + if self.is_unknown() { + if other.is_sym() { + return UdpPunchClientMethod::None; + } else { + return UdpPunchClientMethod::ConeToCone; + } + } + + if self.is_open() || other.is_open() { + return UdpPunchClientMethod::None; + } + + if self.is_cone() { + if other.is_sym() { + UdpPunchClientMethod::None + } else { + UdpPunchClientMethod::ConeToCone + } + } else if self.is_easy_sym() { + if other.is_hard_sym() { + UdpPunchClientMethod::None + } else if other.is_easy_sym() { + UdpPunchClientMethod::EasySymToEasySym + } else { + UdpPunchClientMethod::SymToCone + } + } else if self.is_hard_sym() { + if other.is_sym() { + UdpPunchClientMethod::None + } else { + UdpPunchClientMethod::SymToCone + } + } else { + unreachable!("invalid nat type"); + } + } + + pub fn can_punch_hole_as_client( + &self, + other: Self, + my_peer_id: PeerId, + dst_peer_id: PeerId, + disable_sym_hole_punching: bool, + ) -> bool { + match self.get_punch_hole_method(other, disable_sym_hole_punching) { + UdpPunchClientMethod::None => false, + UdpPunchClientMethod::ConeToCone | UdpPunchClientMethod::SymToCone => true, + UdpPunchClientMethod::EasySymToEasySym => my_peer_id < dst_peer_id, + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn nat(nat_type: NatType) -> UdpNatType { + nat_type.into() + } + + #[test] + fn nat_type_classification_matches_proto_values() { + assert_eq!(nat(NatType::Unknown), UdpNatType::Unknown); + assert_eq!( + nat(NatType::OpenInternet), + UdpNatType::Open(NatType::OpenInternet) + ); + assert_eq!(nat(NatType::FullCone), UdpNatType::Cone(NatType::FullCone)); + assert_eq!( + nat(NatType::Symmetric), + UdpNatType::HardSymmetric(NatType::Symmetric) + ); + assert_eq!( + nat(NatType::SymmetricEasyInc), + UdpNatType::EasySymmetric(NatType::SymmetricEasyInc, true) + ); + assert_eq!( + nat(NatType::SymmetricEasyDec), + UdpNatType::EasySymmetric(NatType::SymmetricEasyDec, false) + ); + } + + #[test] + fn punch_method_preserves_current_nat_matrix() { + let cone = nat(NatType::FullCone); + let hard_sym = nat(NatType::Symmetric); + let easy_sym = nat(NatType::SymmetricEasyInc); + let open = nat(NatType::OpenInternet); + let unknown = nat(NatType::Unknown); + + assert_eq!( + cone.get_punch_hole_method(cone, false), + UdpPunchClientMethod::ConeToCone + ); + assert_eq!( + hard_sym.get_punch_hole_method(cone, false), + UdpPunchClientMethod::SymToCone + ); + assert_eq!( + cone.get_punch_hole_method(hard_sym, false), + UdpPunchClientMethod::None + ); + assert_eq!( + easy_sym.get_punch_hole_method(easy_sym, false), + UdpPunchClientMethod::EasySymToEasySym + ); + assert_eq!( + easy_sym.get_punch_hole_method(hard_sym, false), + UdpPunchClientMethod::None + ); + assert_eq!( + hard_sym.get_punch_hole_method(unknown, false), + UdpPunchClientMethod::SymToCone + ); + assert_eq!( + unknown.get_punch_hole_method(hard_sym, false), + UdpPunchClientMethod::None + ); + assert_eq!( + open.get_punch_hole_method(cone, false), + UdpPunchClientMethod::None + ); + } + + #[test] + fn disabled_symmetric_punching_keeps_existing_fallback() { + let cone = nat(NatType::FullCone); + let hard_sym = nat(NatType::Symmetric); + let easy_sym = nat(NatType::SymmetricEasyInc); + + assert_eq!( + hard_sym.get_punch_hole_method(cone, true), + UdpPunchClientMethod::ConeToCone + ); + assert_eq!( + hard_sym.get_punch_hole_method(easy_sym, true), + UdpPunchClientMethod::None + ); + } + + #[test] + fn easy_sym_to_easy_sym_uses_lower_peer_id_as_client() { + let easy_sym = nat(NatType::SymmetricEasyInc); + + assert!(easy_sym.can_punch_hole_as_client(easy_sym, 1, 2, false)); + assert!(!easy_sym.can_punch_hole_as_client(easy_sym, 2, 1, false)); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/connector.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/connector.rs new file mode 100644 index 0000000..e539da5 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/connector.rs @@ -0,0 +1,529 @@ +use std::sync::{ + Arc, + atomic::{AtomicBool, Ordering}, +}; + +use anyhow::Error; +use dashmap::DashMap; +use quanta::Instant; +use tokio::{ + sync::{Mutex, OwnedMutexGuard, TryLockError}, + task::JoinHandle, +}; + +use crate::{ + config::PeerId, + connectivity::stun::StunInfoProvider, + foundation::task::{ExternalTaskSignal, PeerTaskLauncher, PeerTaskManager}, + proto::common::NatType, +}; + +use crate::connectivity::hole_punch::policy::BackOff; + +use super::{ + BLACKLIST_TIMEOUT_SEC, UdpBothEasySymPunchClient, UdpHolePunchClientError, + UdpHolePunchPeerSource, UdpHolePunchRuntime, UdpHolePunchSignaling, UdpHolePunchTransportSink, + UdpNatType, UdpPunchClientMethod, UdpPunchSocket, UdpPunchTaskInfo, UdpSymToConePunchClient, + collect_udp_punch_tasks, punch_cone_to_cone, should_blacklist_signal_error, +}; + +#[derive(Clone, Default)] +pub struct UdpSymPunchLock { + inner: Arc>, +} + +impl UdpSymPunchLock { + pub(crate) async fn lock(&self) -> OwnedMutexGuard<()> { + self.inner.clone().lock_owned().await + } + + pub(crate) fn try_lock(&self) -> Result, TryLockError> { + self.inner.clone().try_lock_owned() + } +} + +struct UdpHolePunchBlacklist { + items: DashMap, +} + +impl UdpHolePunchBlacklist { + fn new() -> Self { + Self { + items: DashMap::new(), + } + } + + fn contains(&self, peer_id: PeerId) -> bool { + let Some(insert_time) = self.items.get(&peer_id) else { + return false; + }; + let expired = insert_time.elapsed().as_secs() >= BLACKLIST_TIMEOUT_SEC; + drop(insert_time); + + if expired { + self.items.remove(&peer_id); + false + } else { + true + } + } + + fn insert(&self, peer_id: PeerId) { + self.items.insert(peer_id, Instant::now()); + } + + fn cleanup(&self) { + self.items + .retain(|_, insert_time| insert_time.elapsed().as_secs() < BLACKLIST_TIMEOUT_SEC); + } +} + +struct UdpHolePunchConnectorParts +where + P: UdpHolePunchPeerSource + 'static, + S: UdpHolePunchSignaling + 'static, + T: UdpHolePunchTransportSink + 'static, + R: UdpHolePunchRuntime, +{ + peer_source: Arc

, + signaling: Arc, + transport_sink: Arc, + runtime: Arc, + stun: Arc, + sym_punch_lock: UdpSymPunchLock, + try_cone_before_sym: AtomicBool, +} + +pub struct UdpHolePunchConnectorData +where + P: UdpHolePunchPeerSource + 'static, + S: UdpHolePunchSignaling + 'static, + T: UdpHolePunchTransportSink + 'static, + R: UdpHolePunchRuntime, +{ + peer_source: Arc

, + signaling: Arc, + transport_sink: Arc, + runtime: Arc, + stun: Arc, + sym_punch_lock: UdpSymPunchLock, + blacklist: UdpHolePunchBlacklist, + try_cone_before_sym: Arc, + pub sym_to_cone_client: UdpSymToConePunchClient, + pub both_easy_sym_client: UdpBothEasySymPunchClient, +} + +impl UdpHolePunchConnectorData +where + P: UdpHolePunchPeerSource + 'static, + S: UdpHolePunchSignaling + 'static, + T: UdpHolePunchTransportSink + 'static, + R: UdpHolePunchRuntime, +{ + fn new(parts: Arc>) -> Arc { + Arc::new(Self { + peer_source: parts.peer_source.clone(), + signaling: parts.signaling.clone(), + transport_sink: parts.transport_sink.clone(), + runtime: parts.runtime.clone(), + stun: parts.stun.clone(), + sym_punch_lock: parts.sym_punch_lock.clone(), + blacklist: UdpHolePunchBlacklist::new(), + try_cone_before_sym: Arc::new(AtomicBool::new( + parts.try_cone_before_sym.load(Ordering::Relaxed), + )), + sym_to_cone_client: UdpSymToConePunchClient::new( + parts.runtime.clone(), + parts.signaling.clone(), + parts.stun.clone(), + ), + both_easy_sym_client: UdpBothEasySymPunchClient::new( + parts.runtime.clone(), + parts.signaling.clone(), + parts.stun.clone(), + ), + }) + } + + fn should_skip_blacklisted(&self, peer_id: PeerId) -> bool { + if self.blacklist.contains(peer_id) { + tracing::debug!( + dst_peer_id = peer_id, + "peer is blacklisted, skipping hole punching" + ); + true + } else { + false + } + } + + fn map_client_result( + &self, + dst_peer_id: PeerId, + ret: Result, UdpHolePunchClientError>, + ) -> Result, Error> { + match ret { + Ok(ret) => Ok(ret), + Err(UdpHolePunchClientError::Signaling(err)) => { + if should_blacklist_signal_error(&err) { + self.blacklist.insert(dst_peer_id); + } + Err(err.into()) + } + Err(err) => Err(err.into()), + } + } + + #[tracing::instrument(skip(self))] + async fn handle_punch_result( + &self, + ret: Result, Error>, + backoff: Option<&mut BackOff>, + round: Option<&mut u32>, + ) -> bool { + let op = |rollback: bool| { + if rollback { + if let Some(backoff) = backoff { + backoff.rollback(); + } + if let Some(round) = round { + *round = round.saturating_sub(1); + } + } else if let Some(round) = round { + *round += 1; + } + }; + + match ret { + Ok(Some(socket)) => { + let (connected, requested_url) = socket.into_connected(); + if let Err(err) = self + .transport_sink + .add_client_transport(connected, requested_url) + .await + { + tracing::warn!(?err, "upgrade or add UDP hole-punch transport failed"); + op(true); + false + } else { + tracing::info!( + "hole punching transport admitted; awaiting liveness measurement" + ); + true + } + } + Ok(None) => { + tracing::info!("hole punching failed, no punched socket"); + op(false); + false + } + Err(err) => { + tracing::info!(?err, "hole punching failed"); + op(true); + false + } + } + } + + #[tracing::instrument(skip(self))] + async fn cone_to_cone(self: Arc, task_info: UdpPunchTaskInfo) -> Result<(), Error> { + let mut backoff = BackOff::new(vec![1000, 1000, 2000, 4000, 4000, 8000, 8000, 16000]); + + loop { + backoff.sleep_for_next_backoff().await; + + if self.should_skip_blacklisted(task_info.dst_peer_id) { + break; + } + + let ret = punch_cone_to_cone( + self.runtime.clone(), + self.signaling.clone(), + task_info.dst_peer_id, + ) + .await; + let ret = self.map_client_result(task_info.dst_peer_id, ret); + + if self + .handle_punch_result(ret, Some(&mut backoff), None) + .await + { + break; + } + } + + Ok(()) + } + + #[tracing::instrument(skip(self))] + async fn sym_to_cone(self: Arc, task_info: UdpPunchTaskInfo) -> Result<(), Error> { + let mut backoff = + BackOff::new(vec![1000, 1000, 2000, 4000, 4000, 8000, 8000, 16000, 64000]); + let mut round = 0; + let mut port_idx = rand::random(); + + loop { + backoff.sleep_for_next_backoff().await; + + if self.should_skip_blacklisted(task_info.dst_peer_id) { + break; + } + + if self.try_cone_before_sym.load(Ordering::Relaxed) { + let ret = punch_cone_to_cone( + self.runtime.clone(), + self.signaling.clone(), + task_info.dst_peer_id, + ) + .await; + let ret = self.map_client_result(task_info.dst_peer_id, ret); + if self.handle_punch_result(ret, None, None).await { + break; + } + if self.should_skip_blacklisted(task_info.dst_peer_id) { + break; + } + } + + let ret = { + let _lock = self.sym_punch_lock.lock().await; + self.sym_to_cone_client + .do_hole_punching( + task_info.dst_peer_id, + round, + &mut port_idx, + task_info.my_nat_type, + ) + .await + }; + let ret = self.map_client_result(task_info.dst_peer_id, ret); + + if self + .handle_punch_result(ret, Some(&mut backoff), Some(&mut round)) + .await + { + break; + } + } + + Ok(()) + } + + #[tracing::instrument(skip(self))] + async fn both_easy_sym(self: Arc, task_info: UdpPunchTaskInfo) -> Result<(), Error> { + let mut backoff = + BackOff::new(vec![1000, 1000, 2000, 4000, 4000, 8000, 8000, 16000, 64000]); + + loop { + backoff.sleep_for_next_backoff().await; + + if self.should_skip_blacklisted(task_info.dst_peer_id) { + break; + } + + if self.try_cone_before_sym.load(Ordering::Relaxed) { + let ret = punch_cone_to_cone( + self.runtime.clone(), + self.signaling.clone(), + task_info.dst_peer_id, + ) + .await; + let ret = self.map_client_result(task_info.dst_peer_id, ret); + if self.handle_punch_result(ret, None, None).await { + break; + } + if self.should_skip_blacklisted(task_info.dst_peer_id) { + break; + } + } + + let mut is_busy = false; + let ret = { + let _lock = self.sym_punch_lock.lock().await; + self.both_easy_sym_client + .do_hole_punching( + task_info.dst_peer_id, + task_info.my_nat_type, + task_info.dst_nat_type, + &mut is_busy, + ) + .await + }; + let ret = self.map_client_result(task_info.dst_peer_id, ret); + + if is_busy { + backoff.rollback(); + } else if self + .handle_punch_result(ret, Some(&mut backoff), None) + .await + { + break; + } + } + + Ok(()) + } +} + +struct UdpHolePunchPeerTaskLauncher(Arc>) +where + P: UdpHolePunchPeerSource + 'static, + S: UdpHolePunchSignaling + 'static, + T: UdpHolePunchTransportSink + 'static, + R: UdpHolePunchRuntime; + +impl Clone for UdpHolePunchPeerTaskLauncher +where + P: UdpHolePunchPeerSource + 'static, + S: UdpHolePunchSignaling + 'static, + T: UdpHolePunchTransportSink + 'static, + R: UdpHolePunchRuntime, +{ + fn clone(&self) -> Self { + Self(self.0.clone()) + } +} + +#[async_trait::async_trait] +impl PeerTaskLauncher for UdpHolePunchPeerTaskLauncher +where + P: UdpHolePunchPeerSource + 'static, + S: UdpHolePunchSignaling + 'static, + T: UdpHolePunchTransportSink + 'static, + R: UdpHolePunchRuntime, +{ + type CollectPeerItem = UdpPunchTaskInfo; + type TaskRet = (); + + async fn collect_peers_need_task(&self) -> Vec { + let data = &self.0; + let my_nat_type = data.stun.get_stun_info().udp_nat_type; + let my_nat_type: UdpNatType = NatType::try_from(my_nat_type) + .unwrap_or(NatType::Unknown) + .into(); + if !my_nat_type.is_sym() { + data.sym_to_cone_client.clear_udp_array().await; + } + + if my_nat_type.is_open() { + return Vec::new(); + } + + data.blacklist.cleanup(); + + let my_peer_id = data.peer_source.local_peer_id(); + let policy = data.peer_source.p2p_policy_flags(); + let candidates = data.peer_source.candidates().await; + let peers_to_connect = + collect_udp_punch_tasks(my_peer_id, my_nat_type, policy, candidates, |peer_id| { + data.blacklist.contains(peer_id) + }); + for task in &peers_to_connect { + tracing::info!( + peer_id = task.dst_peer_id, + peer_nat_type = ?task.dst_nat_type, + ?my_nat_type, + "found peer to do hole punching" + ); + } + + peers_to_connect + } + + async fn launch_task( + &self, + item: Self::CollectPeerItem, + ) -> JoinHandle> { + let data = self.0.clone(); + let disable_sym_hole_punching = data + .peer_source + .p2p_policy_flags() + .disable_sym_hole_punching; + let punch_method = item + .my_nat_type + .get_punch_hole_method(item.dst_nat_type, disable_sym_hole_punching); + match punch_method { + UdpPunchClientMethod::ConeToCone => tokio::spawn(data.cone_to_cone(item)), + UdpPunchClientMethod::SymToCone => tokio::spawn(data.sym_to_cone(item)), + UdpPunchClientMethod::EasySymToEasySym => tokio::spawn(data.both_easy_sym(item)), + _ => unreachable!(), + } + } + + async fn all_task_done(&self) { + self.0.sym_to_cone_client.clear_udp_array().await; + } + + fn loop_interval_ms(&self) -> u64 { + 5000 + } +} + +pub struct UdpHolePunchConnector +where + P: UdpHolePunchPeerSource + 'static, + S: UdpHolePunchSignaling + 'static, + T: UdpHolePunchTransportSink + 'static, + R: UdpHolePunchRuntime, +{ + client: PeerTaskManager>, +} + +impl UdpHolePunchConnector +where + P: UdpHolePunchPeerSource + 'static, + S: UdpHolePunchSignaling + 'static, + T: UdpHolePunchTransportSink + 'static, + R: UdpHolePunchRuntime, +{ + pub fn new( + peer_source: Arc

, + signaling: Arc, + transport_sink: Arc, + runtime: Arc, + stun: Arc, + sym_punch_lock: UdpSymPunchLock, + external_signal: Option>, + ) -> Self { + let parts = Arc::new(UdpHolePunchConnectorParts { + peer_source, + signaling, + transport_sink, + runtime, + stun, + sym_punch_lock, + try_cone_before_sym: AtomicBool::new(true), + }); + let data = UdpHolePunchConnectorData::new(parts); + Self { + client: PeerTaskManager::new_with_external_signal( + UdpHolePunchPeerTaskLauncher(data), + external_signal, + ), + } + } + + pub fn run_as_client(&self) { + self.client.start(); + } + + pub async fn stop(&self) { + self.client.stop().await; + } +} + +#[cfg(test)] +mod tests { + use super::UdpSymPunchLock; + + #[test] + fn symmetric_punch_locks_are_scoped_per_instance() { + let first = UdpSymPunchLock::default(); + let first_clone = first.clone(); + let second = UdpSymPunchLock::default(); + + let _first_guard = first.try_lock().unwrap(); + assert!(first_clone.try_lock().is_err()); + assert!(second.try_lock().is_ok()); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/mod.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/mod.rs new file mode 100644 index 0000000..22c09fe --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/mod.rs @@ -0,0 +1,39 @@ +mod binding; +mod client; +mod common; +mod connector; +mod punch_listener; +mod rpc; +mod runtime; +mod server; +mod socket_array; +mod task; + +pub(crate) use binding::CoreUdpHolePunchService; +pub(crate) use client::{ + UdpBothEasySymPunchClient, UdpHolePunchClientError, UdpSymToConePunchClient, punch_cone_to_cone, +}; +pub(crate) use common::{BLACKLIST_TIMEOUT_SEC, UdpNatType, UdpPunchClientMethod}; +pub(crate) use connector::{UdpHolePunchConnector, UdpSymPunchLock}; +pub(crate) use punch_listener::{ + MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS, ReusableUdpPunchListener, can_reuse_port_mapping_listener, + can_reuse_public_listener, select_reusable_port_mapping_listener_idx, + select_reusable_public_listener_idx, should_create_public_listener, + should_retry_public_listener_selection, +}; +pub(crate) use rpc::UdpHolePunchRpcSource; +pub(crate) use runtime::{ + ProtocolUdpHolePunchTransportSink, SelectPunchListener, SelectPunchListenerResponse, + SendPunchPacketBothEasySym, SendPunchPacketBothEasySymResponse, SendPunchPacketCone, + SendPunchPacketEasySym, SendPunchPacketHardSym, SendPunchPacketHardSymResponse, + UdpHolePunchInbound, UdpHolePunchPeerSource, UdpHolePunchRuntime, UdpHolePunchSignalError, + UdpHolePunchSignaling, UdpHolePunchTransportSink, UdpPunchAcceptor, UdpPunchListener, + UdpPunchSocket, UdpResolvedPublicAddr, should_blacklist_signal_error, +}; +pub(crate) use server::UdpHolePunchServer; +pub(crate) use socket_array::UdpSocketArray; +pub(crate) use task::{UdpPunchCandidate, UdpPunchTaskInfo, collect_udp_punch_tasks}; + +const fn udp_packet_len(body_len: u16) -> usize { + crate::packet::UDP_TUNNEL_HEADER_SIZE + body_len as usize +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/punch_listener.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/punch_listener.rs new file mode 100644 index 0000000..fd0b776 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/punch_listener.rs @@ -0,0 +1,195 @@ +use std::net::SocketAddr; + +use quanta::Instant; + +pub const MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS: usize = 4; + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub struct ReusableUdpPunchListener { + pub running: bool, + pub mapped_addr: SocketAddr, + pub has_port_mapping_lease: bool, + pub last_active_time: Instant, +} + +pub fn can_reuse_public_listener(listener: &ReusableUdpPunchListener) -> bool { + listener.running && !listener.mapped_addr.ip().is_unspecified() +} + +pub fn can_reuse_port_mapping_listener(listener: &ReusableUdpPunchListener) -> bool { + can_reuse_public_listener(listener) && listener.has_port_mapping_lease +} + +pub fn select_reusable_public_listener_idx( + listeners: &[ReusableUdpPunchListener], +) -> Option { + listeners + .iter() + .enumerate() + .filter(|(_, listener)| can_reuse_public_listener(listener)) + .max_by_key(|(_, listener)| listener.last_active_time) + .map(|(idx, _)| idx) +} + +pub fn select_reusable_port_mapping_listener_idx( + listeners: &[ReusableUdpPunchListener], +) -> Option { + listeners + .iter() + .enumerate() + .filter(|(_, listener)| can_reuse_port_mapping_listener(listener)) + .max_by_key(|(_, listener)| listener.last_active_time) + .map(|(idx, _)| idx) +} + +pub fn should_create_public_listener( + current_listener_count: usize, + has_reusable_listener: bool, + has_port_mapping_listener: bool, + force_new_listener: bool, + prefer_port_mapping: bool, +) -> bool { + if current_listener_count >= MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS { + return false; + } + + if current_listener_count == 0 { + return true; + } + + if force_new_listener { + return true; + } + + if prefer_port_mapping && !has_port_mapping_listener { + return true; + } + + !has_reusable_listener +} + +pub fn should_retry_public_listener_selection( + force_new_listener: bool, + current_listener_count: usize, + prefer_port_mapping: bool, + has_port_mapping_listener: bool, +) -> bool { + if prefer_port_mapping && has_port_mapping_listener { + return false; + } + + !force_new_listener && current_listener_count < MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS +} + +#[cfg(test)] +mod tests { + use std::{ + net::{Ipv4Addr, SocketAddr, SocketAddrV4}, + time::Duration, + }; + + use super::*; + + fn listener( + port: u16, + running: bool, + has_port_mapping_lease: bool, + active_age: Duration, + ) -> ReusableUdpPunchListener { + ReusableUdpPunchListener { + running, + mapped_addr: SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, port)), + has_port_mapping_lease, + last_active_time: Instant::now() - active_age, + } + } + + #[test] + fn listener_selection_prefers_reuse_before_cap() { + assert!(!should_create_public_listener(1, true, true, false, false)); + assert!(!should_create_public_listener( + MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS, + true, + true, + false, + false + )); + } + + #[test] + fn listener_selection_creates_when_empty_or_no_reusable_listener() { + assert!(should_create_public_listener(0, false, false, false, false)); + assert!(should_create_public_listener(1, false, false, false, false)); + } + + #[test] + fn listener_selection_force_new_respects_cap() { + assert!(should_create_public_listener(1, true, true, true, false)); + assert!(!should_create_public_listener( + MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS, + true, + true, + true, + false + )); + } + + #[test] + fn listener_selection_prefers_port_mapping_until_available() { + assert!(should_create_public_listener(1, true, false, false, true)); + assert!(!should_create_public_listener(1, true, true, false, true)); + } + + #[test] + fn listener_selection_retry_respects_cap() { + assert!(should_retry_public_listener_selection( + false, 1, false, false + )); + assert!(!should_retry_public_listener_selection( + false, + MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS, + false, + false + )); + assert!(!should_retry_public_listener_selection( + true, 1, false, false + )); + assert!(!should_retry_public_listener_selection( + false, 1, true, true + )); + } + + #[test] + fn selects_most_recent_reusable_public_listener() { + let listeners = vec![ + listener(1000, true, false, Duration::from_secs(10)), + listener(1001, false, false, Duration::from_secs(1)), + listener(1002, true, false, Duration::from_secs(2)), + ]; + + assert_eq!(select_reusable_public_listener_idx(&listeners), Some(2)); + } + + #[test] + fn selects_most_recent_reusable_port_mapping_listener() { + let listeners = vec![ + listener(1000, true, false, Duration::from_secs(1)), + listener(1001, true, true, Duration::from_secs(10)), + listener(1002, true, true, Duration::from_secs(2)), + ]; + + assert_eq!( + select_reusable_port_mapping_listener_idx(&listeners), + Some(2) + ); + } + + #[test] + fn unspecified_addr_is_not_reusable() { + let mut listener = listener(1000, true, true, Duration::ZERO); + listener.mapped_addr = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 1000)); + + assert!(!can_reuse_public_listener(&listener)); + assert!(!can_reuse_port_mapping_listener(&listener)); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/rpc.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/rpc.rs new file mode 100644 index 0000000..e5ea1d4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/rpc.rs @@ -0,0 +1,828 @@ +use std::{fmt, net::SocketAddr, sync::Arc}; + +use async_trait::async_trait; + +use crate::{ + config::PeerId, + connectivity::hole_punch::udp::{ + SelectPunchListener, SelectPunchListenerResponse as CoreSelectPunchListenerResponse, + SendPunchPacketBothEasySym, + SendPunchPacketBothEasySymResponse as CoreSendPunchPacketBothEasySymResponse, + SendPunchPacketCone, SendPunchPacketEasySym, SendPunchPacketHardSym, + SendPunchPacketHardSymResponse as CoreSendPunchPacketHardSymResponse, UdpHolePunchInbound, + UdpHolePunchRuntime, UdpHolePunchServer as CoreUdpHolePunchServer, UdpHolePunchSignalError, + UdpHolePunchSignaling, UdpHolePunchTransportSink, UdpSymPunchLock, + }, + connectivity::stun::StunInfoProvider, + proto::{ + common::Void, + peer_rpc::{ + SelectPunchListenerRequest, SelectPunchListenerResponse, + SendPunchPacketBothEasySymRequest, SendPunchPacketBothEasySymResponse, + SendPunchPacketConeRequest, SendPunchPacketEasySymRequest, + SendPunchPacketHardSymRequest, SendPunchPacketHardSymResponse, UdpHolePunchRpc, + }, + rpc_types::{self, controller::BaseController}, + }, +}; + +const CONE_RPC_TIMEOUT_MS: i32 = 4000; +const SYMMETRIC_RPC_TIMEOUT_MS: i32 = 4000; +const BOTH_EASY_SYMMETRIC_RPC_TIMEOUT_MS: i32 = 2000; + +fn cone_controller() -> BaseController { + BaseController { + timeout_ms: CONE_RPC_TIMEOUT_MS, + ..Default::default() + } +} + +fn symmetric_controller() -> BaseController { + BaseController { + timeout_ms: SYMMETRIC_RPC_TIMEOUT_MS, + trace_id: 0, + ..Default::default() + } +} + +fn both_easy_symmetric_controller() -> BaseController { + BaseController { + timeout_ms: BOTH_EASY_SYMMETRIC_RPC_TIMEOUT_MS, + ..Default::default() + } +} + +fn select_listener_request_to_rpc(request: SelectPunchListener) -> SelectPunchListenerRequest { + SelectPunchListenerRequest { + force_new: request.force_new, + prefer_port_mapping: request.prefer_port_mapping, + } +} + +fn select_listener_request_from_rpc(input: SelectPunchListenerRequest) -> SelectPunchListener { + SelectPunchListener { + force_new: input.force_new, + prefer_port_mapping: input.prefer_port_mapping, + } +} + +fn select_listener_response_from_rpc( + response: SelectPunchListenerResponse, +) -> Result { + Ok(CoreSelectPunchListenerResponse { + listener_mapped_addr: SocketAddr::from( + response + .listener_mapped_addr + .ok_or_else(|| missing_field("listener_mapped_addr"))?, + ), + }) +} + +fn select_listener_response_to_rpc( + response: CoreSelectPunchListenerResponse, +) -> SelectPunchListenerResponse { + SelectPunchListenerResponse { + listener_mapped_addr: Some(response.listener_mapped_addr.into()), + } +} + +fn cone_request_to_rpc(request: SendPunchPacketCone) -> SendPunchPacketConeRequest { + SendPunchPacketConeRequest { + listener_mapped_addr: Some(request.listener_mapped_addr.into()), + dest_addr: Some(request.dest_addr.into()), + transaction_id: request.transaction_id, + packet_count_per_batch: request.packet_count_per_batch, + packet_batch_count: request.packet_batch_count, + packet_interval_ms: request.packet_interval_ms, + } +} + +fn hard_symmetric_request_to_rpc(request: SendPunchPacketHardSym) -> SendPunchPacketHardSymRequest { + SendPunchPacketHardSymRequest { + listener_mapped_addr: Some(request.listener_mapped_addr.into()), + public_ips: request.public_ips.into_iter().map(Into::into).collect(), + transaction_id: request.transaction_id, + port_index: request.port_index, + round: request.round, + } +} + +fn easy_symmetric_request_to_rpc(request: SendPunchPacketEasySym) -> SendPunchPacketEasySymRequest { + SendPunchPacketEasySymRequest { + listener_mapped_addr: Some(request.listener_mapped_addr.into()), + public_ips: request.public_ips.into_iter().map(Into::into).collect(), + transaction_id: request.transaction_id, + base_port_num: request.base_port_num, + max_port_num: request.max_port_num, + is_incremental: request.is_incremental, + } +} + +fn both_easy_symmetric_request_to_rpc( + request: SendPunchPacketBothEasySym, +) -> SendPunchPacketBothEasySymRequest { + SendPunchPacketBothEasySymRequest { + transaction_id: request.transaction_id, + public_ip: Some(request.public_ip.into()), + dst_port_num: request.dst_port_num, + udp_socket_count: request.udp_socket_count, + wait_time_ms: request.wait_time_ms, + } +} + +fn hard_symmetric_response_from_rpc( + response: SendPunchPacketHardSymResponse, +) -> CoreSendPunchPacketHardSymResponse { + CoreSendPunchPacketHardSymResponse { + next_port_index: response.next_port_index, + } +} + +fn hard_symmetric_response_to_rpc( + response: CoreSendPunchPacketHardSymResponse, +) -> SendPunchPacketHardSymResponse { + SendPunchPacketHardSymResponse { + next_port_index: response.next_port_index, + } +} + +fn both_easy_symmetric_response_from_rpc( + response: SendPunchPacketBothEasySymResponse, +) -> CoreSendPunchPacketBothEasySymResponse { + CoreSendPunchPacketBothEasySymResponse { + is_busy: response.is_busy, + base_mapped_addr: response.base_mapped_addr.map(SocketAddr::from), + } +} + +fn both_easy_symmetric_response_to_rpc( + response: CoreSendPunchPacketBothEasySymResponse, +) -> SendPunchPacketBothEasySymResponse { + SendPunchPacketBothEasySymResponse { + is_busy: response.is_busy, + base_mapped_addr: response.base_mapped_addr.map(Into::into), + } +} + +/// Narrow source of peer-scoped UDP hole-punch RPC stubs. +/// +/// Implemented only by the sealed peer adapter in `super::peer_adapters`. +pub trait UdpHolePunchRpcSource: Send + Sync + 'static { + fn local_peer_id(&self) -> PeerId; + + fn rpc_stub( + &self, + dst_peer_id: PeerId, + ) -> Box + Send + Sync + 'static>; +} + +#[derive(Clone)] +pub(super) struct PeerRpcUdpHolePunchSignaling

+where + P: UdpHolePunchRpcSource, +{ + rpc_source: Arc

, +} + +impl

fmt::Debug for PeerRpcUdpHolePunchSignaling

+where + P: UdpHolePunchRpcSource, +{ + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("PeerRpcUdpHolePunchSignaling") + .field("my_peer_id", &self.rpc_source.local_peer_id()) + .finish_non_exhaustive() + } +} + +impl

PeerRpcUdpHolePunchSignaling

+where + P: UdpHolePunchRpcSource, +{ + pub(super) fn new(rpc_source: Arc

) -> Self { + Self { rpc_source } + } + + fn rpc_stub( + &self, + dst_peer_id: PeerId, + ) -> Box + Send + Sync + 'static> { + self.rpc_source.rpc_stub(dst_peer_id) + } +} + +fn map_rpc_error(error: rpc_types::error::Error) -> UdpHolePunchSignalError { + match error { + rpc_types::error::Error::InvalidServiceKey(_, _) => { + UdpHolePunchSignalError::InvalidServiceKey + } + rpc_types::error::Error::Timeout(_) => UdpHolePunchSignalError::Timeout, + rpc_types::error::Error::ExecutionError(error) => { + UdpHolePunchSignalError::RemoteRejected(error.to_string()) + } + other => UdpHolePunchSignalError::Transport(other.to_string()), + } +} + +fn missing_field(field: &str) -> UdpHolePunchSignalError { + UdpHolePunchSignalError::RemoteRejected(format!("missing {field}")) +} + +#[async_trait] +impl

UdpHolePunchSignaling for PeerRpcUdpHolePunchSignaling

+where + P: UdpHolePunchRpcSource, +{ + async fn select_punch_listener( + &self, + dst_peer_id: PeerId, + request: SelectPunchListener, + ) -> Result { + let response = self + .rpc_stub(dst_peer_id) + .select_punch_listener( + BaseController::default(), + select_listener_request_to_rpc(request), + ) + .await + .map_err(map_rpc_error)?; + + select_listener_response_from_rpc(response) + } + + async fn send_punch_packet_cone( + &self, + dst_peer_id: PeerId, + request: SendPunchPacketCone, + ) -> Result<(), UdpHolePunchSignalError> { + self.rpc_stub(dst_peer_id) + .send_punch_packet_cone(cone_controller(), cone_request_to_rpc(request)) + .await + .map(|_| ()) + .map_err(map_rpc_error) + } + + async fn send_punch_packet_hard_sym( + &self, + dst_peer_id: PeerId, + request: SendPunchPacketHardSym, + ) -> Result { + let response = self + .rpc_stub(dst_peer_id) + .send_punch_packet_hard_sym( + symmetric_controller(), + hard_symmetric_request_to_rpc(request), + ) + .await + .map_err(map_rpc_error)?; + + Ok(hard_symmetric_response_from_rpc(response)) + } + + async fn send_punch_packet_easy_sym( + &self, + dst_peer_id: PeerId, + request: SendPunchPacketEasySym, + ) -> Result<(), UdpHolePunchSignalError> { + self.rpc_stub(dst_peer_id) + .send_punch_packet_easy_sym( + symmetric_controller(), + easy_symmetric_request_to_rpc(request), + ) + .await + .map(|_| ()) + .map_err(map_rpc_error) + } + + async fn send_punch_packet_both_easy_sym( + &self, + dst_peer_id: PeerId, + request: SendPunchPacketBothEasySym, + ) -> Result { + let response = self + .rpc_stub(dst_peer_id) + .send_punch_packet_both_easy_sym( + both_easy_symmetric_controller(), + both_easy_symmetric_request_to_rpc(request), + ) + .await + .map_err(map_rpc_error)?; + + Ok(both_easy_symmetric_response_from_rpc(response)) + } +} + +pub(super) struct UdpHolePunchRpcEndpoint +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + inner: CoreUdpHolePunchServer, +} + +impl UdpHolePunchRpcEndpoint +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + pub(super) fn new( + stun: Arc, + transport_sink: Arc, + sym_punch_lock: UdpSymPunchLock, + runtime: Arc, + ) -> Arc { + let inner = CoreUdpHolePunchServer::new(runtime, stun, transport_sink, sym_punch_lock); + Arc::new(Self { inner }) + } + + pub(super) async fn start(&self) { + self.inner.start().await; + } + + pub(super) fn begin_stop(&self) { + self.inner.begin_stop(); + } + + pub(super) async fn stop(&self) { + self.inner.stop().await; + } +} + +fn signal_error_to_rpc_error(error: UdpHolePunchSignalError) -> rpc_types::error::Error { + match error { + UdpHolePunchSignalError::InvalidServiceKey => rpc_types::error::Error::InvalidServiceKey( + "UdpHolePunchRpc".to_owned(), + "UdpHolePunchRpc".to_owned(), + ), + UdpHolePunchSignalError::Timeout => anyhow::anyhow!("timeout").into(), + UdpHolePunchSignalError::RemoteRejected(message) + | UdpHolePunchSignalError::Transport(message) => anyhow::anyhow!(message).into(), + } +} + +fn cone_request_from_rpc( + input: SendPunchPacketConeRequest, +) -> rpc_types::error::Result { + let listener_addr = input.listener_mapped_addr.ok_or(anyhow::anyhow!( + "send_punch_packet_for_cone request missing listener_mapped_addr" + ))?; + let dest_addr = input.dest_addr.ok_or(anyhow::anyhow!( + "send_punch_packet_for_cone request missing dest_addr" + ))?; + Ok(SendPunchPacketCone { + listener_mapped_addr: listener_addr.into(), + dest_addr: dest_addr.into(), + transaction_id: input.transaction_id, + packet_count_per_batch: input.packet_count_per_batch, + packet_batch_count: input.packet_batch_count, + packet_interval_ms: input.packet_interval_ms, + }) +} + +fn hard_symmetric_request_from_rpc( + input: SendPunchPacketHardSymRequest, +) -> rpc_types::error::Result { + let listener_addr = input.listener_mapped_addr.ok_or(anyhow::anyhow!( + "try_punch_symmetric request missing listener_addr" + ))?; + Ok(SendPunchPacketHardSym { + listener_mapped_addr: listener_addr.into(), + public_ips: input.public_ips.into_iter().map(Into::into).collect(), + transaction_id: input.transaction_id, + port_index: input.port_index, + round: input.round, + }) +} + +fn easy_symmetric_request_from_rpc( + input: SendPunchPacketEasySymRequest, +) -> rpc_types::error::Result { + let listener_addr = input.listener_mapped_addr.ok_or(anyhow::anyhow!( + "send_punch_packet_easy_sym request missing listener_addr" + ))?; + Ok(SendPunchPacketEasySym { + listener_mapped_addr: listener_addr.into(), + public_ips: input.public_ips.into_iter().map(Into::into).collect(), + transaction_id: input.transaction_id, + base_port_num: input.base_port_num, + max_port_num: input.max_port_num, + is_incremental: input.is_incremental, + }) +} + +fn both_easy_symmetric_request_from_rpc( + input: SendPunchPacketBothEasySymRequest, +) -> rpc_types::error::Result { + let public_ip = input + .public_ip + .ok_or(anyhow::anyhow!("public_ip is required"))?; + Ok(SendPunchPacketBothEasySym { + transaction_id: input.transaction_id, + public_ip: public_ip.into(), + dst_port_num: input.dst_port_num, + udp_socket_count: input.udp_socket_count, + wait_time_ms: input.wait_time_ms, + }) +} + +#[async_trait] +impl UdpHolePunchInbound for UdpHolePunchRpcEndpoint +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + async fn select_punch_listener( + &self, + request: SelectPunchListener, + ) -> Result { + self.inner.select_punch_listener(request).await + } + + async fn send_punch_packet_cone( + &self, + request: SendPunchPacketCone, + ) -> Result<(), UdpHolePunchSignalError> { + self.inner.send_punch_packet_cone(request).await + } + + async fn send_punch_packet_hard_sym( + &self, + request: SendPunchPacketHardSym, + ) -> Result { + self.inner.send_punch_packet_hard_sym(request).await + } + + async fn send_punch_packet_easy_sym( + &self, + request: SendPunchPacketEasySym, + ) -> Result<(), UdpHolePunchSignalError> { + self.inner.send_punch_packet_easy_sym(request).await + } + + async fn send_punch_packet_both_easy_sym( + &self, + request: SendPunchPacketBothEasySym, + ) -> Result { + self.inner.send_punch_packet_both_easy_sym(request).await + } +} + +#[async_trait] +impl UdpHolePunchRpc for UdpHolePunchRpcEndpoint +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + type Controller = BaseController; + + async fn select_punch_listener( + &self, + _controller: Self::Controller, + input: SelectPunchListenerRequest, + ) -> rpc_types::error::Result { + let response = UdpHolePunchInbound::select_punch_listener( + self, + select_listener_request_from_rpc(input), + ) + .await + .map_err(signal_error_to_rpc_error)?; + + Ok(select_listener_response_to_rpc(response)) + } + + async fn send_punch_packet_cone( + &self, + _controller: Self::Controller, + input: SendPunchPacketConeRequest, + ) -> rpc_types::error::Result { + UdpHolePunchInbound::send_punch_packet_cone(self, cone_request_from_rpc(input)?) + .await + .map_err(signal_error_to_rpc_error)?; + + Ok(Void::default()) + } + + async fn send_punch_packet_hard_sym( + &self, + _controller: Self::Controller, + input: SendPunchPacketHardSymRequest, + ) -> rpc_types::error::Result { + let response = UdpHolePunchInbound::send_punch_packet_hard_sym( + self, + hard_symmetric_request_from_rpc(input)?, + ) + .await + .map_err(signal_error_to_rpc_error)?; + + Ok(hard_symmetric_response_to_rpc(response)) + } + + async fn send_punch_packet_easy_sym( + &self, + _controller: Self::Controller, + input: SendPunchPacketEasySymRequest, + ) -> rpc_types::error::Result { + UdpHolePunchInbound::send_punch_packet_easy_sym( + self, + easy_symmetric_request_from_rpc(input)?, + ) + .await + .map_err(signal_error_to_rpc_error)?; + + Ok(Void::default()) + } + + async fn send_punch_packet_both_easy_sym( + &self, + _controller: Self::Controller, + input: SendPunchPacketBothEasySymRequest, + ) -> rpc_types::error::Result { + let response = UdpHolePunchInbound::send_punch_packet_both_easy_sym( + self, + both_easy_symmetric_request_from_rpc(input)?, + ) + .await + .map_err(signal_error_to_rpc_error)?; + + Ok(both_easy_symmetric_response_to_rpc(response)) + } +} + +#[cfg(test)] +mod tests { + use std::{future, net::Ipv4Addr, time::Duration}; + + use super::*; + + #[test] + fn outbound_rpc_controllers_preserve_timeouts() { + assert_eq!(cone_controller().timeout_ms, 4000); + assert_eq!(symmetric_controller().timeout_ms, 4000); + assert_eq!(symmetric_controller().trace_id, 0); + assert_eq!(both_easy_symmetric_controller().timeout_ms, 2000); + } + + #[test] + fn select_listener_dto_preserves_fields_and_requires_response_addr() { + let domain_request = SelectPunchListener { + force_new: true, + prefer_port_mapping: false, + }; + let rpc_request = select_listener_request_to_rpc(domain_request.clone()); + assert!(rpc_request.force_new); + assert!(!rpc_request.prefer_port_mapping); + assert_eq!( + select_listener_request_from_rpc(SelectPunchListenerRequest { + force_new: true, + prefer_port_mapping: false, + }), + domain_request + ); + + let mapped_addr: SocketAddr = "198.51.100.1:31001".parse().unwrap(); + let core_response = CoreSelectPunchListenerResponse { + listener_mapped_addr: mapped_addr, + }; + let rpc_response = select_listener_response_to_rpc(core_response.clone()); + assert_eq!( + SocketAddr::from(rpc_response.listener_mapped_addr.unwrap()), + mapped_addr + ); + assert_eq!( + select_listener_response_from_rpc(rpc_response).unwrap(), + core_response + ); + + let error = + select_listener_response_from_rpc(SelectPunchListenerResponse::default()).unwrap_err(); + assert_eq!( + error, + UdpHolePunchSignalError::RemoteRejected("missing listener_mapped_addr".to_owned()) + ); + } + + #[test] + fn cone_dto_round_trip_preserves_all_fields() { + let request = SendPunchPacketCone { + listener_mapped_addr: "198.51.100.2:31002".parse().unwrap(), + dest_addr: "203.0.113.2:32002".parse().unwrap(), + transaction_id: 12, + packet_count_per_batch: 3, + packet_batch_count: 4, + packet_interval_ms: 500, + }; + + let rpc = cone_request_to_rpc(request.clone()); + assert_eq!( + SocketAddr::from(rpc.listener_mapped_addr.unwrap()), + request.listener_mapped_addr + ); + assert_eq!(SocketAddr::from(rpc.dest_addr.unwrap()), request.dest_addr); + assert_eq!(rpc.transaction_id, 12); + assert_eq!(rpc.packet_count_per_batch, 3); + assert_eq!(rpc.packet_batch_count, 4); + assert_eq!(rpc.packet_interval_ms, 500); + assert_eq!(cone_request_from_rpc(rpc).unwrap(), request); + } + + #[test] + fn hard_symmetric_dto_round_trip_preserves_all_fields() { + let request = SendPunchPacketHardSym { + listener_mapped_addr: "198.51.100.3:31003".parse().unwrap(), + public_ips: vec![Ipv4Addr::new(203, 0, 113, 3), Ipv4Addr::new(203, 0, 113, 4)], + transaction_id: 13, + port_index: 17, + round: 19, + }; + + let rpc = hard_symmetric_request_to_rpc(request.clone()); + assert_eq!( + SocketAddr::from(rpc.listener_mapped_addr.unwrap()), + request.listener_mapped_addr + ); + assert_eq!( + rpc.public_ips + .iter() + .cloned() + .map(Ipv4Addr::from) + .collect::>(), + request.public_ips + ); + assert_eq!(rpc.transaction_id, 13); + assert_eq!(rpc.port_index, 17); + assert_eq!(rpc.round, 19); + assert_eq!(hard_symmetric_request_from_rpc(rpc).unwrap(), request); + } + + #[test] + fn easy_symmetric_dto_round_trip_preserves_all_fields() { + let request = SendPunchPacketEasySym { + listener_mapped_addr: "198.51.100.5:31005".parse().unwrap(), + public_ips: vec![Ipv4Addr::new(203, 0, 113, 5)], + transaction_id: 15, + base_port_num: 33000, + max_port_num: 51, + is_incremental: true, + }; + + let rpc = easy_symmetric_request_to_rpc(request.clone()); + assert_eq!( + SocketAddr::from(rpc.listener_mapped_addr.unwrap()), + request.listener_mapped_addr + ); + assert_eq!( + rpc.public_ips + .iter() + .cloned() + .map(Ipv4Addr::from) + .collect::>(), + request.public_ips + ); + assert_eq!(rpc.transaction_id, 15); + assert_eq!(rpc.base_port_num, 33000); + assert_eq!(rpc.max_port_num, 51); + assert!(rpc.is_incremental); + assert_eq!(easy_symmetric_request_from_rpc(rpc).unwrap(), request); + } + + #[test] + fn both_easy_symmetric_dto_round_trip_preserves_all_fields() { + let request = SendPunchPacketBothEasySym { + udp_socket_count: 25, + public_ip: Ipv4Addr::new(203, 0, 113, 6), + transaction_id: 16, + dst_port_num: 34000, + wait_time_ms: 2500, + }; + + let rpc = both_easy_symmetric_request_to_rpc(request.clone()); + assert_eq!(rpc.udp_socket_count, 25); + assert_eq!(Ipv4Addr::from(rpc.public_ip.unwrap()), request.public_ip); + assert_eq!(rpc.transaction_id, 16); + assert_eq!(rpc.dst_port_num, 34000); + assert_eq!(rpc.wait_time_ms, 2500); + assert_eq!(both_easy_symmetric_request_from_rpc(rpc).unwrap(), request); + } + + #[test] + fn rpc_response_dtos_preserve_all_fields() { + let hard_response = CoreSendPunchPacketHardSymResponse { + next_port_index: 41, + }; + let hard_rpc = hard_symmetric_response_to_rpc(hard_response.clone()); + assert_eq!(hard_rpc.next_port_index, 41); + assert_eq!(hard_symmetric_response_from_rpc(hard_rpc), hard_response); + + let both_response = CoreSendPunchPacketBothEasySymResponse { + is_busy: true, + base_mapped_addr: Some("198.51.100.8:31008".parse().unwrap()), + }; + let both_rpc = both_easy_symmetric_response_to_rpc(both_response.clone()); + assert!(both_rpc.is_busy); + assert_eq!( + SocketAddr::from(both_rpc.base_mapped_addr.unwrap()), + both_response.base_mapped_addr.unwrap() + ); + assert_eq!( + both_easy_symmetric_response_from_rpc(both_rpc), + both_response + ); + } + + #[test] + fn inbound_rpc_dtos_reject_missing_required_fields() { + let cone_listener_error = cone_request_from_rpc(SendPunchPacketConeRequest::default()) + .unwrap_err() + .to_string(); + assert_eq!( + cone_listener_error, + "Rust error: send_punch_packet_for_cone request missing listener_mapped_addr" + ); + + let cone_dest_error = cone_request_from_rpc(SendPunchPacketConeRequest { + listener_mapped_addr: Some("198.51.100.7:31007".parse::().unwrap().into()), + ..Default::default() + }) + .unwrap_err() + .to_string(); + assert_eq!( + cone_dest_error, + "Rust error: send_punch_packet_for_cone request missing dest_addr" + ); + + assert_eq!( + hard_symmetric_request_from_rpc(SendPunchPacketHardSymRequest::default()) + .unwrap_err() + .to_string(), + "Rust error: try_punch_symmetric request missing listener_addr" + ); + assert_eq!( + easy_symmetric_request_from_rpc(SendPunchPacketEasySymRequest::default()) + .unwrap_err() + .to_string(), + "Rust error: send_punch_packet_easy_sym request missing listener_addr" + ); + assert_eq!( + both_easy_symmetric_request_from_rpc(SendPunchPacketBothEasySymRequest::default()) + .unwrap_err() + .to_string(), + "Rust error: public_ip is required" + ); + } + + #[tokio::test] + async fn rpc_errors_keep_domain_classification() { + assert_eq!( + map_rpc_error(rpc_types::error::Error::InvalidServiceKey( + "service".to_owned(), + "proto".to_owned() + )), + UdpHolePunchSignalError::InvalidServiceKey + ); + assert_eq!( + map_rpc_error(rpc_types::error::Error::ExecutionError(anyhow::anyhow!( + "rejected" + ))), + UdpHolePunchSignalError::RemoteRejected("rejected".to_owned()) + ); + assert_eq!( + map_rpc_error(rpc_types::error::Error::TunnelError("closed".to_owned())), + UdpHolePunchSignalError::Transport("Tunnel error: closed".to_owned()) + ); + + let elapsed = tokio::time::timeout(Duration::ZERO, future::pending::<()>()) + .await + .unwrap_err(); + assert_eq!( + map_rpc_error(rpc_types::error::Error::Timeout(elapsed)), + UdpHolePunchSignalError::Timeout + ); + } + + #[test] + fn domain_errors_keep_rpc_classification() { + assert!(matches!( + signal_error_to_rpc_error(UdpHolePunchSignalError::InvalidServiceKey), + rpc_types::error::Error::InvalidServiceKey(_, _) + )); + for (domain_error, expected_message) in [ + (UdpHolePunchSignalError::Timeout, "timeout"), + ( + UdpHolePunchSignalError::RemoteRejected("rejected".to_owned()), + "rejected", + ), + ( + UdpHolePunchSignalError::Transport("closed".to_owned()), + "closed", + ), + ] { + let rpc_types::error::Error::ExecutionError(error) = + signal_error_to_rpc_error(domain_error) + else { + panic!("domain error should map to execution error"); + }; + assert_eq!(error.to_string(), expected_message); + } + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/runtime.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/runtime.rs new file mode 100644 index 0000000..5be63eb --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/runtime.rs @@ -0,0 +1,524 @@ +use std::{ + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr}, + sync::Arc, +}; + +use async_trait::async_trait; + +use super::super::{HolePunchTunnelSink, port_mapping::UdpPortMappingLease}; + +use crate::{ + config::P2pPolicyFlags, + connectivity::{ + protocol::ClientProtocolUpgrader, + transport::{ConnectedTransport, ConnectedUdpSession}, + }, + foundation::task::ExternalTaskSignal, + peers::PeerConnectionOrigin, + socket::{ + ListenerConnectionCounter, SocketContext, + udp::{UdpBindOptions, UdpSession, VirtualUdpSocket, VirtualUdpSocketFactory}, + }, + tunnel::Tunnel, +}; + +#[async_trait] +pub trait UdpPunchAcceptor: Send { + async fn accept(&mut self) -> anyhow::Result; +} + +pub struct UdpPunchSocket { + session: UdpSession, + requested_remote_addr: SocketAddr, + lifetime_guard: Box, +} + +impl UdpPunchSocket { + pub fn new(session: UdpSession, requested_remote_addr: SocketAddr, lifetime_guard: G) -> Self + where + G: Send + Sync + 'static, + { + Self { + session, + requested_remote_addr, + lifetime_guard: Box::new(lifetime_guard), + } + } + + pub(crate) fn into_connected(self) -> (ConnectedUdpSession, url::Url) { + ( + ConnectedUdpSession::new(self.session, self.lifetime_guard), + udp_url(self.requested_remote_addr), + ) + } +} + +impl std::fmt::Debug for UdpPunchSocket { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("UdpPunchSocket") + .field("session", &self.session) + .field("requested_remote_addr", &self.requested_remote_addr) + .finish_non_exhaustive() + } +} + +fn udp_url(addr: SocketAddr) -> url::Url { + let mut url = url::Url::parse("udp://0.0.0.0").expect("static UDP URL should be valid"); + url.set_ip_host(addr.ip()) + .expect("socket IP should be a valid URL host"); + url.set_port(Some(addr.port())) + .expect("UDP URL should accept a port"); + url +} + +pub struct UdpPunchListener { + pub socket: Arc, + pub mapped_addr: SocketAddr, + pub conn_counter: Arc, + pub acceptor: Box, + pub(crate) port_mapping_lease: Option>, +} + +pub struct UdpResolvedPublicAddr { + pub mapped_addr: SocketAddr, + pub(crate) port_mapping_lease: Option>, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct SelectPunchListener { + pub force_new: bool, + pub prefer_port_mapping: bool, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct SelectPunchListenerResponse { + pub listener_mapped_addr: SocketAddr, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct SendPunchPacketCone { + pub listener_mapped_addr: SocketAddr, + pub dest_addr: SocketAddr, + pub transaction_id: u32, + pub packet_count_per_batch: u32, + pub packet_batch_count: u32, + pub packet_interval_ms: u32, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct SendPunchPacketHardSym { + pub listener_mapped_addr: SocketAddr, + pub public_ips: Vec, + pub transaction_id: u32, + pub port_index: u32, + pub round: u32, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct SendPunchPacketHardSymResponse { + pub next_port_index: u32, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct SendPunchPacketEasySym { + pub listener_mapped_addr: SocketAddr, + pub public_ips: Vec, + pub transaction_id: u32, + pub base_port_num: u32, + pub max_port_num: u32, + pub is_incremental: bool, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct SendPunchPacketBothEasySym { + pub udp_socket_count: u32, + pub public_ip: Ipv4Addr, + pub transaction_id: u32, + pub dst_port_num: u32, + pub wait_time_ms: u32, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct SendPunchPacketBothEasySymResponse { + pub is_busy: bool, + pub base_mapped_addr: Option, +} + +#[derive(Debug, thiserror::Error, PartialEq, Eq)] +pub enum UdpHolePunchSignalError { + #[error("invalid service key")] + InvalidServiceKey, + #[error("timeout")] + Timeout, + #[error("remote rejected: {0}")] + RemoteRejected(String), + #[error("transport: {0}")] + Transport(String), +} + +pub fn should_blacklist_signal_error(error: &UdpHolePunchSignalError) -> bool { + matches!(error, UdpHolePunchSignalError::InvalidServiceKey) +} + +#[async_trait] +pub trait UdpHolePunchSignaling: Send + Sync { + async fn select_punch_listener( + &self, + dst_peer_id: crate::config::PeerId, + request: SelectPunchListener, + ) -> Result; + + async fn send_punch_packet_cone( + &self, + dst_peer_id: crate::config::PeerId, + request: SendPunchPacketCone, + ) -> Result<(), UdpHolePunchSignalError>; + + async fn send_punch_packet_hard_sym( + &self, + dst_peer_id: crate::config::PeerId, + request: SendPunchPacketHardSym, + ) -> Result; + + async fn send_punch_packet_easy_sym( + &self, + dst_peer_id: crate::config::PeerId, + request: SendPunchPacketEasySym, + ) -> Result<(), UdpHolePunchSignalError>; + + async fn send_punch_packet_both_easy_sym( + &self, + dst_peer_id: crate::config::PeerId, + request: SendPunchPacketBothEasySym, + ) -> Result; +} + +#[async_trait] +pub trait UdpHolePunchInbound: Send + Sync { + async fn select_punch_listener( + &self, + request: SelectPunchListener, + ) -> Result; + + async fn send_punch_packet_cone( + &self, + request: SendPunchPacketCone, + ) -> Result<(), UdpHolePunchSignalError>; + + async fn send_punch_packet_hard_sym( + &self, + request: SendPunchPacketHardSym, + ) -> Result; + + async fn send_punch_packet_easy_sym( + &self, + request: SendPunchPacketEasySym, + ) -> Result<(), UdpHolePunchSignalError>; + + async fn send_punch_packet_both_easy_sym( + &self, + request: SendPunchPacketBothEasySym, + ) -> Result; +} + +#[async_trait] +pub trait UdpHolePunchTransportSink: Send + Sync { + async fn add_client_transport( + &self, + connected: ConnectedUdpSession, + requested_url: url::Url, + ) -> anyhow::Result<()>; + + async fn add_server_transport( + &self, + connected: ConnectedUdpSession, + requested_url: url::Url, + ) -> anyhow::Result<()>; +} + +pub struct ProtocolUdpHolePunchTransportSink { + protocol: Arc>, + tunnel_sink: Arc, +} + +impl ProtocolUdpHolePunchTransportSink { + pub fn new(protocol: Arc>, tunnel_sink: Arc) -> Self { + Self { + protocol, + tunnel_sink, + } + } + + async fn upgrade( + &self, + connected: ConnectedUdpSession, + requested_url: url::Url, + ) -> anyhow::Result> { + self.protocol + .upgrade_client(ConnectedTransport::Udp(connected), requested_url) + .await + } +} + +#[async_trait] +impl UdpHolePunchTransportSink for ProtocolUdpHolePunchTransportSink +where + TcpSocket: 'static, + T: HolePunchTunnelSink, +{ + async fn add_client_transport( + &self, + connected: ConnectedUdpSession, + requested_url: url::Url, + ) -> anyhow::Result<()> { + let tunnel = self.upgrade(connected, requested_url).await?; + self.tunnel_sink + .add_client_tunnel(tunnel, PeerConnectionOrigin::UdpHolePunch) + .await + } + + async fn add_server_transport( + &self, + connected: ConnectedUdpSession, + requested_url: url::Url, + ) -> anyhow::Result<()> { + let tunnel = self.upgrade(connected, requested_url).await?; + self.tunnel_sink + .add_server_tunnel(tunnel, PeerConnectionOrigin::UdpHolePunch) + .await + } +} + +#[async_trait] +pub trait UdpHolePunchPeerSource: Send + Sync { + fn local_peer_id(&self) -> crate::config::PeerId; + fn p2p_policy_flags(&self) -> P2pPolicyFlags; + + async fn candidates(&self) -> Vec; + + fn p2p_demand_notify(&self) -> Arc; + + fn is_local_virtual_ip(&self, ip: &IpAddr) -> bool; + + async fn is_easytier_managed_ipv6(&self, ip: &Ipv6Addr) -> bool; +} + +#[async_trait] +pub trait UdpHolePunchRuntime: Send + Sync + 'static { + type Socket: VirtualUdpSocket + 'static; + + fn socket_context(&self) -> SocketContext { + SocketContext::default() + } + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result>; + + async fn bind_direct_connect_udp(&self) -> anyhow::Result> { + UdpHolePunchRuntime::bind_udp( + self, + UdpBindOptions::direct_connect().with_context( + self.socket_context() + .with_ip_version(crate::socket::IpVersion::V4), + ), + ) + .await + } + + async fn resolve_udp_public_addr( + &self, + socket: Arc, + ) -> anyhow::Result; + + async fn create_listener( + &self, + prefer_port_mapping: bool, + ) -> anyhow::Result>; + + async fn create_port_bound_listener( + &self, + port: u16, + ) -> anyhow::Result>; + + async fn connect_with_socket( + &self, + socket: Arc, + remote: SocketAddr, + ) -> anyhow::Result; +} + +#[async_trait] +impl VirtualUdpSocketFactory for T +where + T: UdpHolePunchRuntime + Send + Sync + 'static, +{ + type Socket = T::Socket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + UdpHolePunchRuntime::bind_udp(self, options).await + } +} + +#[cfg(test)] +mod tests { + use std::{ + io, + sync::{ + Arc, + atomic::{AtomicBool, AtomicUsize, Ordering}, + }, + }; + + use super::*; + use crate::socket::udp::UdpSessionKind; + + struct MockSocket { + local_addr: SocketAddr, + } + + #[async_trait] + impl VirtualUdpSocket for MockSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], _addr: SocketAddr) -> io::Result { + Ok(data.len()) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } + } + + struct DropSignal(Arc); + + impl Drop for DropSignal { + fn drop(&mut self) { + self.0.store(true, Ordering::Relaxed); + } + } + + #[derive(Default)] + struct MockProtocol { + upgrades: AtomicUsize, + } + + #[async_trait] + impl ClientProtocolUpgrader<()> for MockProtocol { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "udp" + } + + async fn upgrade_client( + &self, + connected: ConnectedTransport<()>, + requested_url: url::Url, + ) -> anyhow::Result> { + self.upgrades.fetch_add(1, Ordering::Relaxed); + let ConnectedTransport::Udp(connected) = connected else { + anyhow::bail!("expected UDP transport"); + }; + Ok(crate::connectivity::protocol::raw::upgrade_connected_udp( + connected, + requested_url, + )?) + } + } + + #[derive(Default)] + struct MockTunnelSink { + clients: AtomicUsize, + servers: AtomicUsize, + } + + #[async_trait] + impl HolePunchTunnelSink for MockTunnelSink { + async fn add_client_tunnel( + &self, + _tunnel: Box, + origin: PeerConnectionOrigin, + ) -> anyhow::Result<()> { + assert_eq!(origin, PeerConnectionOrigin::UdpHolePunch); + self.clients.fetch_add(1, Ordering::Relaxed); + Ok(()) + } + + async fn add_server_tunnel( + &self, + _tunnel: Box, + origin: PeerConnectionOrigin, + ) -> anyhow::Result<()> { + assert_eq!(origin, PeerConnectionOrigin::UdpHolePunch); + self.servers.fetch_add(1, Ordering::Relaxed); + Ok(()) + } + } + + fn punched_socket(local_port: u16, remote_port: u16) -> UdpPunchSocket { + let remote_addr = SocketAddr::from(([203, 0, 113, 1], remote_port)); + let session = UdpSession::identity_standalone( + Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], local_port)), + }), + remote_addr, + UdpSessionKind::EasyTierMux, + ) + .unwrap(); + UdpPunchSocket::new(session, remote_addr, ()) + } + + #[tokio::test] + async fn protocol_sink_upgrades_before_role_specific_admission() { + let protocol = Arc::new(MockProtocol::default()); + let tunnel_sink = Arc::new(MockTunnelSink::default()); + let sink = + ProtocolUdpHolePunchTransportSink::<(), _>::new(protocol.clone(), tunnel_sink.clone()); + + let (client, client_url) = punched_socket(1000, 2000).into_connected(); + sink.add_client_transport(client, client_url).await.unwrap(); + let (server, server_url) = punched_socket(1001, 2001).into_connected(); + sink.add_server_transport(server, server_url).await.unwrap(); + + assert_eq!(protocol.upgrades.load(Ordering::Relaxed), 2); + assert_eq!(tunnel_sink.clients.load(Ordering::Relaxed), 1); + assert_eq!(tunnel_sink.servers.load(Ordering::Relaxed), 1); + } + + #[tokio::test] + async fn punched_socket_preserves_requested_and_resolved_addresses() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 1000)); + let requested_remote_addr = SocketAddr::from(([198, 51, 100, 1], 2000)); + let resolved_remote_addr = SocketAddr::from(([203, 0, 113, 1], 3000)); + let session = UdpSession::identity_standalone( + Arc::new(MockSocket { local_addr }), + resolved_remote_addr, + UdpSessionKind::EasyTierMux, + ) + .unwrap(); + let guard_dropped = Arc::new(AtomicBool::new(false)); + let socket = UdpPunchSocket::new( + session, + requested_remote_addr, + DropSignal(guard_dropped.clone()), + ); + + let (connected, requested_url) = socket.into_connected(); + let tunnel = + crate::connectivity::protocol::raw::upgrade_connected_udp(connected, requested_url) + .unwrap(); + let info = tunnel.info().unwrap(); + let local_url: url::Url = info.local_addr.unwrap().into(); + let remote_url: url::Url = info.remote_addr.unwrap().into(); + let resolved_url: url::Url = info.resolved_remote_addr.unwrap().into(); + + assert_eq!(local_url.host_str(), Some("127.0.0.1")); + assert_eq!(local_url.port(), Some(local_addr.port())); + assert_eq!(remote_url.host_str(), Some("198.51.100.1")); + assert_eq!(remote_url.port(), Some(requested_remote_addr.port())); + assert_eq!(resolved_url.host_str(), Some("203.0.113.1")); + assert_eq!(resolved_url.port(), Some(resolved_remote_addr.port())); + assert!(!guard_dropped.load(Ordering::Relaxed)); + drop(tunnel); + assert!(guard_dropped.load(Ordering::Relaxed)); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/server.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/server.rs new file mode 100644 index 0000000..082266e --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/server.rs @@ -0,0 +1,1386 @@ +use std::{ + net::{Ipv4Addr, SocketAddr, SocketAddrV4}, + sync::{ + Arc, + atomic::{AtomicBool, Ordering}, + }, + time::Duration, +}; + +use anyhow::Context; +use crossbeam_utils::atomic::AtomicCell; +use quanta::Instant; +use rand::{Rng, seq::SliceRandom as _}; +use tokio::{ + sync::{Mutex, RwLock, RwLockReadGuard}, + task::JoinSet, +}; +use tokio_util::task::AbortOnDropHandle; + +use crate::{ + connectivity::{hole_punch::port_mapping::UdpPortMappingLease, stun::StunInfoProvider}, + packet::{HOLE_PUNCH_PACKET_BODY_LEN, new_hole_punch_packet}, + socket::{ListenerConnectionCounter, udp::VirtualUdpSocket}, +}; + +use super::{ + MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS, ReusableUdpPunchListener, SelectPunchListener, + SelectPunchListenerResponse, SendPunchPacketBothEasySym, SendPunchPacketBothEasySymResponse, + SendPunchPacketCone, SendPunchPacketEasySym, SendPunchPacketHardSym, + SendPunchPacketHardSymResponse, UdpHolePunchInbound, UdpHolePunchRuntime, + UdpHolePunchSignalError, UdpHolePunchTransportSink, UdpPunchListener, UdpSocketArray, + UdpSymPunchLock, can_reuse_port_mapping_listener, can_reuse_public_listener, + select_reusable_port_mapping_listener_idx, select_reusable_public_listener_idx, + should_create_public_listener, should_retry_public_listener_selection, +}; + +const MAX_K1_FOR_RANDOM_HARD_SYM: u32 = 180; + +pub struct SelectedUdpPunchListener { + /// Kept for listener-selection side effects and tests; production callers + /// only consume `mapped_addr`. + #[allow(dead_code)] + pub socket: Arc, + pub mapped_addr: SocketAddr, +} + +pub struct UdpHolePunchServer +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + sym_punch_lock: UdpSymPunchLock, + common: Arc>, + both_easy_sym_server: UdpBothEasySymPunchServer, + shuffled_port_vec: Arc>, + admission: RwLock<()>, + stopping: AtomicBool, +} + +impl UdpHolePunchServer +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + pub fn new( + runtime: Arc, + stun: Arc, + transport_sink: Arc, + sym_punch_lock: UdpSymPunchLock, + ) -> Self { + let common = Arc::new(UdpHolePunchServerCommon::new( + runtime.clone(), + stun.clone(), + transport_sink.clone(), + )); + let both_easy_sym_common = + Arc::new(UdpHolePunchServerCommon::new(runtime, stun, transport_sink)); + let both_easy_sym_server = UdpBothEasySymPunchServer::new(both_easy_sym_common); + let mut shuffled_port_vec: Vec = (1..=65535).collect(); + shuffled_port_vec.shuffle(&mut rand::thread_rng()); + + Self { + sym_punch_lock, + common, + both_easy_sym_server, + shuffled_port_vec: Arc::new(shuffled_port_vec), + admission: RwLock::new(()), + stopping: AtomicBool::new(true), + } + } + + pub async fn start(&self) { + let _admission = self.admission.write().await; + if !self.stopping.load(Ordering::Acquire) { + return; + } + self.stop_inner().await; + self.common.start().await; + self.both_easy_sym_server.common.start().await; + self.stopping.store(false, Ordering::Release); + } + + pub fn begin_stop(&self) { + self.stopping.store(true, Ordering::Release); + } + + pub async fn stop(&self) { + self.begin_stop(); + let _admission = self.admission.write().await; + self.stopping.store(true, Ordering::Release); + self.stop_inner().await; + } + + async fn stop_inner(&self) { + self.both_easy_sym_server.stop().await; + self.both_easy_sym_server.common.stop().await; + self.common.stop().await; + } + + async fn admit(&self) -> Result, UdpHolePunchSignalError> { + if self.stopping.load(Ordering::Acquire) { + return Err(UdpHolePunchSignalError::Transport( + "udp hole punch server is stopping".into(), + )); + } + let guard = self.admission.read().await; + if self.stopping.load(Ordering::Acquire) { + return Err(UdpHolePunchSignalError::Transport( + "udp hole punch server is stopping".into(), + )); + } + Ok(guard) + } + + fn busy_signal_error() -> UdpHolePunchSignalError { + UdpHolePunchSignalError::RemoteRejected("sym punch lock is busy".into()) + } + + fn anyhow_to_signal_error(error: anyhow::Error) -> UdpHolePunchSignalError { + UdpHolePunchSignalError::RemoteRejected(error.to_string()) + } + + async fn send_punch_packet_easy_sym_inner( + &self, + request: SendPunchPacketEasySym, + ) -> anyhow::Result<()> { + tracing::info!("send_punch_packet_easy_sym start"); + + let listener = self + .common + .find_listener(&request.listener_mapped_addr) + .await + .ok_or(anyhow::anyhow!( + "send_punch_packet_easy_sym failed to find listener" + ))?; + + if request.public_ips.is_empty() { + tracing::warn!("send_punch_packet_easy_sym got zero len public ip"); + anyhow::bail!("send_punch_packet_easy_sym got zero len public ip"); + } + + let base_port_num = request.base_port_num; + let max_port_num = request.max_port_num.max(1); + let port_start = if request.is_incremental { + base_port_num.saturating_add(1) + } else { + base_port_num.saturating_sub(max_port_num) + }; + let port_end = if request.is_incremental { + base_port_num.saturating_add(max_port_num) + } else { + base_port_num.saturating_sub(1) + }; + + if port_end <= port_start { + anyhow::bail!("send_punch_packet_easy_sym invalid port range"); + } + + let ports = (port_start..=port_end) + .map(|port| port as u16) + .collect::>(); + tracing::debug!( + ?ports, + public_ips = ?request.public_ips, + "send_punch_packet_easy_sym send to ports" + ); + + for _ in 0..2 { + send_symmetric_hole_punch_packet( + &ports, + listener.clone(), + request.transaction_id, + &request.public_ips, + 0, + ports.len(), + ) + .await + .with_context(|| "failed to send symmetric hole punch packet")?; + } + + Ok(()) + } + + async fn send_punch_packet_hard_sym_inner( + &self, + request: SendPunchPacketHardSym, + ) -> anyhow::Result { + tracing::info!("try_punch_symmetric start"); + + let listener = self + .common + .find_listener(&request.listener_mapped_addr) + .await + .ok_or(anyhow::anyhow!( + "send_punch_packet_for_cone failed to find listener" + ))?; + + if request.public_ips.is_empty() { + tracing::warn!("try_punch_symmetric got zero len public ip"); + anyhow::bail!("try_punch_symmetric got zero len public ip"); + } + + let last_port_index = request.port_index as usize; + let round = request.round.max(1); + let mut max_k2: u32 = rand::thread_rng().gen_range(600..800); + if round > 2 { + max_k2 = (max_k2 * 2 / round).max(MAX_K1_FOR_RANDOM_HARD_SYM); + } + + let mut next_port_index = 0; + for _ in 0..2 { + next_port_index = send_symmetric_hole_punch_packet( + &self.shuffled_port_vec, + listener.clone(), + request.transaction_id, + &request.public_ips, + last_port_index, + max_k2 as usize, + ) + .await + .with_context(|| "failed to send symmetric hole punch packet randomly")?; + } + + Ok(SendPunchPacketHardSymResponse { + next_port_index: next_port_index as u32, + }) + } +} + +#[async_trait::async_trait] +impl UdpHolePunchInbound for UdpHolePunchServer +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + async fn select_punch_listener( + &self, + request: SelectPunchListener, + ) -> Result { + let _admission = self.admit().await?; + let selected = self + .common + .select_listener(request.force_new, request.prefer_port_mapping) + .await + .ok_or_else(|| { + UdpHolePunchSignalError::RemoteRejected("no listener available".into()) + })?; + + Ok(SelectPunchListenerResponse { + listener_mapped_addr: selected.mapped_addr, + }) + } + + async fn send_punch_packet_cone( + &self, + request: SendPunchPacketCone, + ) -> Result<(), UdpHolePunchSignalError> { + let _admission = self.admit().await?; + let listener = self + .common + .find_listener(&request.listener_mapped_addr) + .await + .ok_or_else(|| { + UdpHolePunchSignalError::RemoteRejected( + "send_punch_packet_for_cone failed to find listener".into(), + ) + })?; + + send_cone_hole_punch_packets(listener, &request) + .await + .map_err(Self::anyhow_to_signal_error) + } + + async fn send_punch_packet_hard_sym( + &self, + request: SendPunchPacketHardSym, + ) -> Result { + let _admission = self.admit().await?; + let _locked = self + .sym_punch_lock + .try_lock() + .map_err(|_| Self::busy_signal_error())?; + self.send_punch_packet_hard_sym_inner(request) + .await + .map_err(Self::anyhow_to_signal_error) + } + + async fn send_punch_packet_easy_sym( + &self, + request: SendPunchPacketEasySym, + ) -> Result<(), UdpHolePunchSignalError> { + let _admission = self.admit().await?; + let _locked = self + .sym_punch_lock + .try_lock() + .map_err(|_| Self::busy_signal_error())?; + self.send_punch_packet_easy_sym_inner(request) + .await + .map_err(Self::anyhow_to_signal_error) + } + + async fn send_punch_packet_both_easy_sym( + &self, + request: SendPunchPacketBothEasySym, + ) -> Result { + let _admission = self.admit().await?; + let _locked = self + .sym_punch_lock + .try_lock() + .map_err(|_| Self::busy_signal_error())?; + self.both_easy_sym_server + .send_punch_packet_both_easy_sym(request) + .await + .map_err(Self::anyhow_to_signal_error) + } +} + +type UdpPunchListenerRecords = Arc>>>>; + +pub struct UdpHolePunchServerCommon +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + runtime: Arc, + stun: Arc, + transport_sink: Arc, + listeners: UdpPunchListenerRecords, + pending: UdpPunchListenerRecords, + retiring: UdpPunchListenerRecords, + cleanup_task: Mutex>>, +} + +impl UdpHolePunchServerCommon +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + pub fn new(runtime: Arc, stun: Arc, transport_sink: Arc) -> Self { + let listeners = Arc::new(Mutex::new(Vec::new())); + + Self { + runtime, + stun, + transport_sink, + listeners, + pending: Arc::new(Mutex::new(Vec::new())), + retiring: Arc::new(Mutex::new(Vec::new())), + cleanup_task: Mutex::new(None), + } + } + + pub async fn start(&self) { + let mut task_slot = self.cleanup_task.lock().await; + if task_slot.as_ref().is_some_and(|task| !task.is_finished()) { + return; + } + let listeners = self.listeners.clone(); + let retiring = self.retiring.clone(); + task_slot.replace(AbortOnDropHandle::new(tokio::spawn(async move { + loop { + crate::foundation::time::sleep(Duration::from_secs(5)).await; + { + let mut retiring = retiring.lock().await; + let mut listeners = listeners.lock().await; + let mut index = 0; + while index < listeners.len() { + let listener = &listeners[index]; + let active = listener.last_active_time.load().elapsed().as_secs() < 40 + || listener.last_select_time.load().elapsed().as_secs() < 30; + if active { + index += 1; + } else { + retiring.push(listeners.remove(index)); + } + } + } + drain_retiring_listeners(retiring.as_ref()).await; + } + }))); + } + + pub async fn stop(&self) { + let mut cleanup_task = self.cleanup_task.lock().await; + if let Some(cleanup_task) = cleanup_task.as_mut() { + cleanup_task.abort(); + let _ = cleanup_task.await; + } + cleanup_task.take(); + drop(cleanup_task); + + { + let mut pending = self.pending.lock().await; + let mut retiring = self.retiring.lock().await; + let mut listeners = self.listeners.lock().await; + retiring.extend(std::mem::take(&mut *pending)); + retiring.extend(std::mem::take(&mut *listeners)); + } + drain_retiring_listeners(self.retiring.as_ref()).await; + } + + pub async fn add_listener(&self, listener: UdpPunchListener) { + let mut listeners = self.listeners.lock().await; + listeners.push(Arc::new(UdpPunchListenerRecord::new( + listener, + self.transport_sink.clone(), + ))); + } + + async fn track_pending_listener( + &self, + listener: UdpPunchListener, + ) -> Arc> { + let mut pending = self.pending.lock().await; + let listener = Arc::new(UdpPunchListenerRecord::new( + listener, + self.transport_sink.clone(), + )); + pending.push(listener.clone()); + listener + } + + async fn promote_pending_listener(&self, listener: Arc>) { + let mut pending = self.pending.lock().await; + let mut listeners = self.listeners.lock().await; + if let Some(index) = pending + .iter() + .position(|candidate| Arc::ptr_eq(candidate, &listener)) + { + pending.remove(index); + listeners.push(listener); + } + } + + async fn retire_pending_listener(&self, listener: Arc>) { + let mut pending = self.pending.lock().await; + let mut retiring = self.retiring.lock().await; + if let Some(index) = pending + .iter() + .position(|candidate| Arc::ptr_eq(candidate, &listener)) + { + retiring.push(pending.remove(index)); + } + } + + pub async fn find_listener(&self, addr: &SocketAddr) -> Option> { + let listeners = self.listeners.lock().await; + + let listener = listeners + .iter() + .find(|listener| listener.mapped_addr == *addr && listener.running.load())?; + + Some(listener.get_socket()) + } + + pub async fn select_listener( + &self, + force_new_listener: bool, + prefer_port_mapping: bool, + ) -> Option> { + let mut force_new_listener = force_new_listener; + + loop { + let (listener_count, has_reusable_listener, has_port_mapping_listener) = { + let listeners = self.listeners.lock().await; + let states = listener_reuse_states(listeners.as_slice()); + ( + states.len(), + states.iter().any(can_reuse_public_listener), + states.iter().any(can_reuse_port_mapping_listener), + ) + }; + let should_create = should_create_public_listener( + listener_count, + has_reusable_listener, + has_port_mapping_listener, + force_new_listener, + prefer_port_mapping, + ); + + if should_create { + tracing::warn!( + max_listeners = MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS, + "creating udp hole punching listener" + ); + match self.runtime.create_listener(prefer_port_mapping).await { + Ok(listener) => self.add_listener(listener).await, + Err(err) => { + tracing::warn!(?err, "failed to create udp hole punching listener"); + } + } + } + + let mut listeners = self.listeners.lock().await; + let listener_count = listeners.len(); + let states = listener_reuse_states(listeners.as_slice()); + let listener_idx = if prefer_port_mapping { + select_reusable_port_mapping_listener_idx(&states) + .or_else(|| { + if should_create && states.last().is_some_and(can_reuse_public_listener) { + Some(states.len() - 1) + } else { + None + } + }) + .or_else(|| select_reusable_public_listener_idx(&states)) + } else if should_create { + listeners.len().checked_sub(1) + } else { + select_reusable_public_listener_idx(&states) + }; + + let Some(listener_idx) = listener_idx else { + tracing::warn!( + ?force_new_listener, + ?prefer_port_mapping, + listener_count, + max_listeners = MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS, + "no available udp hole punching listener with mapped address" + ); + if should_retry_public_listener_selection( + force_new_listener, + listener_count, + prefer_port_mapping, + has_port_mapping_listener, + ) { + force_new_listener = true; + continue; + } + return None; + }; + + let listener = &mut listeners[listener_idx]; + if !can_reuse_public_listener(&listener.reuse_state()) { + tracing::warn!( + ?force_new_listener, + ?prefer_port_mapping, + listener_count, + max_listeners = MAX_PUBLIC_UDP_HOLE_PUNCH_LISTENERS, + "selected udp hole punching listener is not reusable" + ); + return None; + } + + return Some(SelectedUdpPunchListener { + socket: listener.get_socket(), + mapped_addr: listener.mapped_addr, + }); + } + } +} + +struct UdpPunchListenerRecord { + socket: Arc, + tasks: Mutex>, + connection_tasks: Arc>>, + running: Arc>, + mapped_addr: SocketAddr, + has_port_mapping_lease: bool, + _port_mapping_lease: Option>, + conn_counter: Arc, + + _listen_time: Instant, + last_select_time: AtomicCell, + last_active_time: Arc>, +} + +impl UdpPunchListenerRecord +where + S: VirtualUdpSocket + 'static, +{ + fn new(listener: UdpPunchListener, transport_sink: Arc) -> Self + where + T: UdpHolePunchTransportSink + 'static, + { + let UdpPunchListener { + socket, + mapped_addr, + conn_counter, + mut acceptor, + port_mapping_lease, + } = listener; + + let running = Arc::new(AtomicCell::new(true)); + let running_clone = running.clone(); + let mut tasks = JoinSet::new(); + let connection_tasks = Arc::new(Mutex::new(JoinSet::new())); + let accept_connection_tasks = connection_tasks.clone(); + + tasks.spawn(async move { + while let Ok(socket) = acceptor.accept().await { + tracing::warn!(?socket, "udp hole punching listener got peer connection"); + let (connected, requested_url) = socket.into_connected(); + let transport_sink = transport_sink.clone(); + let mut connection_tasks = accept_connection_tasks.lock().await; + while connection_tasks.try_join_next().is_some() {} + connection_tasks.spawn(async move { + if let Err(err) = transport_sink + .add_server_transport(connected, requested_url) + .await + { + tracing::error!( + ?err, + "failed to upgrade or add server UDP hole-punch transport" + ); + } + }); + } + + running_clone.store(false); + }); + + let last_active_time = Arc::new(AtomicCell::new(Instant::now())); + let conn_counter_clone = conn_counter.clone(); + let last_active_time_clone = last_active_time.clone(); + tasks.spawn(async move { + loop { + crate::foundation::time::sleep(Duration::from_secs(5)).await; + if conn_counter_clone.get().unwrap_or(0) != 0 { + last_active_time_clone.store(Instant::now()); + } + } + }); + + tracing::warn!(?mapped_addr, "udp hole punching listener started"); + + Self { + socket, + tasks: Mutex::new(tasks), + connection_tasks, + running, + mapped_addr, + has_port_mapping_lease: port_mapping_lease.is_some(), + _port_mapping_lease: port_mapping_lease, + conn_counter, + + _listen_time: Instant::now(), + last_select_time: AtomicCell::new(Instant::now()), + last_active_time, + } + } + + fn get_socket(&self) -> Arc { + self.last_select_time.store(Instant::now()); + self.socket.clone() + } + + fn conn_count(&self) -> usize { + self.conn_counter.get().unwrap_or(0) as usize + } + + fn reuse_state(&self) -> ReusableUdpPunchListener { + ReusableUdpPunchListener { + running: self.running.load(), + mapped_addr: self.mapped_addr, + has_port_mapping_lease: self.has_port_mapping_lease, + last_active_time: self.last_active_time.load(), + } + } + + async fn stop(&self) { + let mut tasks = self.tasks.lock().await; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + drop(tasks); + + let mut connection_tasks = self.connection_tasks.lock().await; + connection_tasks.abort_all(); + while connection_tasks.join_next().await.is_some() {} + self.running.store(false); + } +} + +async fn drain_retiring_listeners(retiring: &Mutex>>>) +where + S: VirtualUdpSocket + 'static, +{ + loop { + let listener = retiring.lock().await.first().cloned(); + let Some(listener) = listener else { + return; + }; + listener.stop().await; + let mut retiring = retiring.lock().await; + if let Some(index) = retiring + .iter() + .position(|candidate| Arc::ptr_eq(candidate, &listener)) + { + retiring.remove(index); + } + } +} + +fn listener_reuse_states( + listeners: &[Arc>], +) -> Vec +where + S: VirtualUdpSocket + 'static, +{ + listeners + .iter() + .map(|listener| listener.reuse_state()) + .collect() +} + +pub async fn send_cone_hole_punch_packets( + udp: Arc, + request: &SendPunchPacketCone, +) -> anyhow::Result<()> +where + S: VirtualUdpSocket + 'static, +{ + let dest_ip = request.dest_addr.ip(); + if dest_ip.is_unspecified() || dest_ip.is_multicast() { + anyhow::bail!( + "send_punch_packet_for_cone dest_ip is malformed: {:?}", + request + ); + } + + for _ in 0..request.packet_batch_count { + tracing::info!(?request, "sending hole punching packet"); + + for _ in 0..request.packet_count_per_batch { + let udp_packet = + new_hole_punch_packet(request.transaction_id, HOLE_PUNCH_PACKET_BODY_LEN); + if let Err(err) = udp + .send_to(&udp_packet.into_bytes(), request.dest_addr) + .await + { + tracing::error!(?err, "failed to send hole punch packet to dest addr"); + } + } + crate::foundation::time::sleep(Duration::from_millis(request.packet_interval_ms as u64)) + .await; + } + + Ok(()) +} + +#[tracing::instrument(err, ret(level = tracing::Level::DEBUG), skip(ports, udp))] +pub async fn send_symmetric_hole_punch_packet( + ports: &[u16], + udp: Arc, + transaction_id: u32, + public_ips: &[Ipv4Addr], + port_start_idx: usize, + max_packets: usize, +) -> anyhow::Result +where + S: VirtualUdpSocket + 'static, +{ + tracing::debug!("sending hard symmetric hole punching packet"); + let mut sent_packets = 0; + let mut cur_port_idx = port_start_idx; + while sent_packets < max_packets { + let port = ports[cur_port_idx % ports.len()]; + for pub_ip in public_ips { + let addr = SocketAddr::V4(SocketAddrV4::new(*pub_ip, port)); + for _ in 0..3 { + let packet = new_hole_punch_packet(transaction_id, HOLE_PUNCH_PACKET_BODY_LEN); + udp.send_to(&packet.into_bytes(), addr).await?; + } + sent_packets += 1; + } + cur_port_idx = cur_port_idx.wrapping_add(1); + crate::foundation::time::sleep(Duration::from_millis(1)).await; + } + Ok(cur_port_idx % ports.len()) +} + +pub struct UdpBothEasySymPunchServer +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + common: Arc>, + task: Mutex>>, +} + +impl UdpBothEasySymPunchServer +where + R: UdpHolePunchRuntime, + T: UdpHolePunchTransportSink + 'static, +{ + pub fn new(common: Arc>) -> Self { + Self { + common, + task: Mutex::new(None), + } + } + + pub async fn stop(&self) { + let mut task = self.task.lock().await; + if let Some(task) = task.as_mut() { + task.abort(); + let _ = task.await; + } + task.take(); + } + + #[tracing::instrument(skip(self), ret, err)] + pub async fn send_punch_packet_both_easy_sym( + &self, + request: SendPunchPacketBothEasySym, + ) -> anyhow::Result { + tracing::info!("send_punch_packet_both_easy_sym start"); + let busy_resp = Ok(SendPunchPacketBothEasySymResponse { + is_busy: true, + base_mapped_addr: None, + }); + let Ok(mut locked_task) = self.task.try_lock() else { + return busy_resp; + }; + if locked_task.is_some() && !locked_task.as_ref().unwrap().is_finished() { + return busy_resp; + } + + let cur_mapped_addr = self + .common + .stun + .get_udp_port_mapping(0) + .await + .with_context(|| "failed to get udp port mapping")?; + + tracing::info!("send_punch_packet_hard_sym start"); + let socket_count = request.udp_socket_count as usize; + let transaction_id = request.transaction_id; + + let udp_array = UdpSocketArray::new_with_context( + socket_count, + self.common.runtime.clone(), + self.common.runtime.socket_context(), + ); + udp_array.start().await?; + udp_array.add_intreast_tid(transaction_id); + + let punch_packet = + new_hole_punch_packet(transaction_id, HOLE_PUNCH_PACKET_BODY_LEN).into_bytes(); + let common = self.common.clone(); + + let task = tokio::spawn(async move { + let mut listeners = Vec::new(); + let mut punched = Vec::new(); + let start_time = Instant::now(); + let wait_time_ms = request.wait_time_ms.min(8000); + while start_time.elapsed() < Duration::from_millis(wait_time_ms as u64) { + if let Err(e) = udp_array + .send_with_all( + &punch_packet, + SocketAddr::V4(SocketAddrV4::new( + request.public_ip, + request.dst_port_num as u16, + )), + ) + .await + { + tracing::error!(?e, "failed to send hole punch packet"); + break; + } + + crate::foundation::time::sleep(Duration::from_millis(100)).await; + + if let Some(s) = udp_array.try_fetch_punched_socket(transaction_id) { + tracing::info!(?s, ?transaction_id, "got punched socket in both easy sym"); + assert!(Arc::strong_count(&s.socket) == 1); + let Some(port) = s.socket.local_addr().ok().map(|addr| addr.port()) else { + tracing::warn!("failed to get local addr from punched socket"); + continue; + }; + let remote_addr = s.remote_addr; + drop(s); + + let listener = match common.runtime.create_port_bound_listener(port).await { + Ok(listener) => listener, + Err(e) => { + tracing::warn!(?e, "failed to create listener"); + continue; + } + }; + let socket = listener.socket.clone(); + let record = common.track_pending_listener(listener).await; + punched.push((socket, remote_addr)); + listeners.push(record); + } + + for listener in &listeners { + if listener.conn_count() > 0 { + tracing::info!(?listener.mapped_addr, "got punched listener"); + break; + } + } + + if !punched.is_empty() { + tracing::debug!( + punched_count = punched.len(), + "got punched socket and keep sending punch packet" + ); + } + + for p in &punched { + let (socket, remote_addr) = p; + let send_remote_ret = socket.send_to(&punch_packet, *remote_addr).await; + tracing::debug!( + ?send_remote_ret, + ?remote_addr, + "send hole punch packet to punched remote" + ); + } + } + + for listener in listeners { + if listener.conn_count() > 0 { + common.promote_pending_listener(listener).await; + } else { + common.retire_pending_listener(listener).await; + } + } + drain_retiring_listeners(common.retiring.as_ref()).await; + }); + + *locked_task = Some(AbortOnDropHandle::new(task)); + Ok(SendPunchPacketBothEasySymResponse { + is_busy: false, + base_mapped_addr: Some(cur_mapped_addr), + }) + } +} + +#[cfg(test)] +mod tests { + use std::{ + collections::VecDeque, + io, + sync::{ + Mutex as StdMutex, + atomic::{AtomicUsize, Ordering}, + }, + }; + + use async_trait::async_trait; + + use super::*; + use crate::{ + connectivity::hole_punch::udp::{UdpPunchAcceptor, UdpPunchSocket, UdpResolvedPublicAddr}, + proto::common::StunInfo, + socket::udp::{UdpBindOptions, UdpSession, UdpSessionKind}, + }; + + struct MockSocket { + local_addr: SocketAddr, + sent: tokio::sync::Mutex, SocketAddr)>>, + fail_next_send: AtomicUsize, + } + + #[async_trait] + impl VirtualUdpSocket for MockSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], _addr: SocketAddr) -> io::Result { + if self.fail_next_send.load(Ordering::Relaxed) != 0 { + self.fail_next_send.fetch_sub(1, Ordering::Relaxed); + return Err(io::Error::other("mock send failure")); + } + self.sent.lock().await.push((data.to_vec(), _addr)); + Ok(data.len()) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } + } + + #[derive(Debug, Default)] + struct MockCounter { + count: AtomicCell, + } + + impl ListenerConnectionCounter for MockCounter { + fn get(&self) -> Option { + Some(self.count.load()) + } + } + + struct MockAcceptor { + sockets: VecDeque, + } + + #[async_trait] + impl UdpPunchAcceptor for MockAcceptor { + async fn accept(&mut self) -> anyhow::Result { + let Some(socket) = self.sockets.pop_front() else { + return std::future::pending().await; + }; + Ok(socket) + } + } + + struct MockRuntime { + listeners: StdMutex>>, + } + + impl MockRuntime { + fn new(listeners: Vec>) -> Self { + Self { + listeners: StdMutex::new(listeners.into()), + } + } + } + + #[async_trait] + impl UdpHolePunchRuntime for MockRuntime { + type Socket = MockSocket; + + async fn bind_udp(&self, _options: UdpBindOptions) -> anyhow::Result> { + Ok(Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], 0)), + sent: tokio::sync::Mutex::new(Vec::new()), + fail_next_send: AtomicUsize::new(0), + })) + } + + async fn resolve_udp_public_addr( + &self, + socket: Arc, + ) -> anyhow::Result { + Ok(UdpResolvedPublicAddr { + mapped_addr: socket.local_addr()?, + port_mapping_lease: None, + }) + } + + async fn create_listener( + &self, + _prefer_port_mapping: bool, + ) -> anyhow::Result> { + self.listeners + .lock() + .unwrap() + .pop_front() + .ok_or_else(|| anyhow::anyhow!("no listener")) + } + + async fn create_port_bound_listener( + &self, + _port: u16, + ) -> anyhow::Result> { + self.create_listener(false).await + } + + async fn connect_with_socket( + &self, + socket: Arc, + remote: SocketAddr, + ) -> anyhow::Result { + let session = + UdpSession::identity_standalone(socket, remote, UdpSessionKind::EasyTierMux)?; + Ok(UdpPunchSocket::new(session, remote, ())) + } + } + + struct MockStunInfoProvider; + + #[async_trait] + impl StunInfoProvider for MockStunInfoProvider { + fn get_stun_info(&self) -> StunInfo { + StunInfo::default() + } + + async fn get_udp_port_mapping(&self, _port: u16) -> anyhow::Result { + Ok(SocketAddr::from(([203, 0, 113, 1], 10000))) + } + + async fn get_tcp_port_mapping(&self, _port: u16) -> anyhow::Result { + unreachable!("TCP mapping is not used by UDP hole-punch tests") + } + + fn update_stun_info(&self) {} + } + + fn mock_stun() -> Arc { + Arc::new(MockStunInfoProvider) + } + + #[derive(Default)] + struct MockSink { + server_tunnels: AtomicUsize, + } + + #[async_trait] + impl UdpHolePunchTransportSink for MockSink { + async fn add_client_transport( + &self, + _connected: crate::connectivity::transport::ConnectedUdpSession, + _requested_url: url::Url, + ) -> anyhow::Result<()> { + Ok(()) + } + + async fn add_server_transport( + &self, + _connected: crate::connectivity::transport::ConnectedUdpSession, + _requested_url: url::Url, + ) -> anyhow::Result<()> { + self.server_tunnels.fetch_add(1, Ordering::Relaxed); + Ok(()) + } + } + + fn listener(port: u16, sockets: Vec) -> UdpPunchListener { + UdpPunchListener { + socket: Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], port)), + sent: tokio::sync::Mutex::new(Vec::new()), + fail_next_send: AtomicUsize::new(0), + }), + mapped_addr: SocketAddr::from(([203, 0, 113, 1], port)), + conn_counter: Arc::new(MockCounter::default()), + acceptor: Box::new(MockAcceptor { + sockets: sockets.into(), + }), + port_mapping_lease: None, + } + } + + #[tokio::test] + async fn server_keeps_both_easy_sym_listener_pool_separate() { + let runtime = Arc::new(MockRuntime::new(Vec::new())); + let sink = Arc::new(MockSink::default()); + let server = + UdpHolePunchServer::new(runtime, mock_stun(), sink, UdpSymPunchLock::default()); + + assert!(!Arc::ptr_eq( + &server.common, + &server.both_easy_sym_server.common + )); + } + + #[test] + fn server_constructor_is_cold() { + let runtime = Arc::new(MockRuntime::new(Vec::new())); + let sink = Arc::new(MockSink::default()); + + let _server = + UdpHolePunchServer::new(runtime, mock_stun(), sink, UdpSymPunchLock::default()); + } + + #[tokio::test] + async fn common_lifecycle_joins_cleanup_and_listener_tasks() { + let runtime = Arc::new(MockRuntime::new(vec![listener(10003, Vec::new())])); + let sink = Arc::new(MockSink::default()); + let common = Arc::new(UdpHolePunchServerCommon::new(runtime, mock_stun(), sink)); + + common.start().await; + common.select_listener(false, false).await.unwrap(); + common.stop().await; + + assert!(common.cleanup_task.lock().await.is_none()); + assert!(common.listeners.lock().await.is_empty()); + } + + #[tokio::test] + async fn select_listener_creates_and_finds_listener() { + let runtime = Arc::new(MockRuntime::new(vec![listener(10000, Vec::new())])); + let sink = Arc::new(MockSink::default()); + let common = UdpHolePunchServerCommon::new(runtime, mock_stun(), sink); + + let selected = common.select_listener(false, true).await.unwrap(); + + assert_eq!( + selected.mapped_addr, + SocketAddr::from(([203, 0, 113, 1], 10000)) + ); + assert_eq!( + selected.socket.local_addr().unwrap(), + SocketAddr::from(([127, 0, 0, 1], 10000)) + ); + assert!(common.find_listener(&selected.mapped_addr).await.is_some()); + } + + #[tokio::test] + async fn accepted_tunnel_is_forwarded_to_sink() { + let socket = Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], 10001)), + sent: tokio::sync::Mutex::new(Vec::new()), + fail_next_send: AtomicUsize::new(0), + }); + let remote_addr = SocketAddr::from(([127, 0, 0, 1], 20001)); + let session = + UdpSession::identity_standalone(socket, remote_addr, UdpSessionKind::EasyTierMux) + .unwrap(); + let punched_socket = UdpPunchSocket::new(session, remote_addr, ()); + let runtime = Arc::new(MockRuntime::new(vec![listener( + 10001, + vec![punched_socket], + )])); + let sink = Arc::new(MockSink::default()); + let common = UdpHolePunchServerCommon::new(runtime, mock_stun(), sink.clone()); + + common.select_listener(false, false).await.unwrap(); + + for _ in 0..10 { + if sink.server_tunnels.load(Ordering::Relaxed) == 1 { + return; + } + tokio::task::yield_now().await; + } + + assert_eq!(sink.server_tunnels.load(Ordering::Relaxed), 1); + } + + #[tokio::test] + async fn cone_packet_sender_keeps_old_batch_shape() { + let socket = Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], 10002)), + sent: tokio::sync::Mutex::new(Vec::new()), + fail_next_send: AtomicUsize::new(0), + }); + let request = SendPunchPacketCone { + listener_mapped_addr: SocketAddr::from(([203, 0, 113, 1], 10002)), + dest_addr: SocketAddr::from(([198, 51, 100, 1], 20000)), + transaction_id: 9, + packet_count_per_batch: 2, + packet_batch_count: 3, + packet_interval_ms: 0, + }; + + send_cone_hole_punch_packets(socket.clone(), &request) + .await + .unwrap(); + + let sent = socket.sent.lock().await; + assert_eq!(sent.len(), 6); + assert!(sent.iter().all(|(_, addr)| *addr == request.dest_addr)); + } + + #[tokio::test] + async fn cone_packet_sender_rejects_malformed_dest_ip() { + let socket = Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], 10004)), + sent: tokio::sync::Mutex::new(Vec::new()), + fail_next_send: AtomicUsize::new(0), + }); + let request = SendPunchPacketCone { + listener_mapped_addr: SocketAddr::from(([203, 0, 113, 1], 10004)), + dest_addr: SocketAddr::from(([0, 0, 0, 0], 20000)), + transaction_id: 9, + packet_count_per_batch: 2, + packet_batch_count: 3, + packet_interval_ms: 0, + }; + + let err = send_cone_hole_punch_packets(socket.clone(), &request) + .await + .unwrap_err(); + + assert!(err.to_string().contains("dest_ip is malformed")); + assert!(socket.sent.lock().await.is_empty()); + } + + #[tokio::test] + async fn cone_packet_sender_continues_after_send_error() { + let socket = Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], 10005)), + sent: tokio::sync::Mutex::new(Vec::new()), + fail_next_send: AtomicUsize::new(1), + }); + let request = SendPunchPacketCone { + listener_mapped_addr: SocketAddr::from(([203, 0, 113, 1], 10005)), + dest_addr: SocketAddr::from(([198, 51, 100, 1], 20000)), + transaction_id: 9, + packet_count_per_batch: 2, + packet_batch_count: 1, + packet_interval_ms: 0, + }; + + send_cone_hole_punch_packets(socket.clone(), &request) + .await + .unwrap(); + + let sent = socket.sent.lock().await; + assert_eq!(sent.len(), 1); + } + + #[tokio::test] + async fn symmetric_packet_sender_returns_next_port_index() { + let socket = Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], 10003)), + sent: tokio::sync::Mutex::new(Vec::new()), + fail_next_send: AtomicUsize::new(0), + }); + let next_idx = send_symmetric_hole_punch_packet( + &[10, 11, 12], + socket.clone(), + 9, + &[Ipv4Addr::new(198, 51, 100, 1)], + 1, + 2, + ) + .await + .unwrap(); + + assert_eq!(next_idx, 0); + let sent = socket.sent.lock().await; + assert_eq!(sent.len(), 6); + assert_eq!(sent[0].1, SocketAddr::from(([198, 51, 100, 1], 11))); + assert_eq!(sent[3].1, SocketAddr::from(([198, 51, 100, 1], 12))); + } + + #[tokio::test] + async fn symmetric_packet_sender_returns_send_error() { + let socket = Arc::new(MockSocket { + local_addr: SocketAddr::from(([127, 0, 0, 1], 10006)), + sent: tokio::sync::Mutex::new(Vec::new()), + fail_next_send: AtomicUsize::new(1), + }); + + let err = send_symmetric_hole_punch_packet( + &[10], + socket.clone(), + 9, + &[Ipv4Addr::new(198, 51, 100, 1)], + 0, + 1, + ) + .await + .unwrap_err(); + + assert!(err.to_string().contains("mock send failure")); + assert!(socket.sent.lock().await.is_empty()); + } + + #[tokio::test] + async fn both_easy_sym_server_reports_busy_while_task_running() { + let runtime = Arc::new(MockRuntime::new(Vec::new())); + let sink = Arc::new(MockSink::default()); + let common = Arc::new(UdpHolePunchServerCommon::new(runtime, mock_stun(), sink)); + let server = UdpBothEasySymPunchServer::new(common); + let request = SendPunchPacketBothEasySym { + udp_socket_count: 1, + public_ip: Ipv4Addr::new(198, 51, 100, 1), + transaction_id: 9, + dst_port_num: 20000, + wait_time_ms: 500, + }; + + let first_response = server + .send_punch_packet_both_easy_sym(request.clone()) + .await + .unwrap(); + assert!(!first_response.is_busy); + assert_eq!( + first_response.base_mapped_addr, + Some(SocketAddr::from(([203, 0, 113, 1], 10000))) + ); + + let busy_response = server + .send_punch_packet_both_easy_sym(request) + .await + .unwrap(); + assert!(busy_response.is_busy); + assert!(busy_response.base_mapped_addr.is_none()); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/socket_array.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/socket_array.rs new file mode 100644 index 0000000..7d07c8c --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/socket_array.rs @@ -0,0 +1,379 @@ +use std::{ + fmt::Debug, + net::SocketAddr, + sync::{Arc, Mutex}, +}; + +use dashmap::{DashMap, DashSet}; +use tokio::task::JoinSet; +use tracing::{Instrument, Level, instrument}; + +use crate::{ + foundation::task::reap_joinset_background, + packet::{HOLE_PUNCH_PACKET_BODY_LEN, hole_punch_packet_tid}, + socket::{ + IpVersion, SocketContext, + udp::{UdpBindOptions, VirtualUdpSocket, VirtualUdpSocketFactory}, + }, +}; + +pub struct PunchedUdpSocket { + pub socket: Arc, + pub tid: u32, + pub remote_addr: SocketAddr, +} + +impl Debug for PunchedUdpSocket { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PunchedUdpSocket") + .field("tid", &self.tid) + .field("remote_addr", &self.remote_addr) + .finish_non_exhaustive() + } +} + +pub struct UdpSocketArray +where + R: VirtualUdpSocketFactory, +{ + sockets: Arc>>, + max_socket_count: usize, + socket_factory: Arc, + socket_context: SocketContext, + tasks: Arc>>, + + interest_tids: Arc>, + tid_to_socket: Arc>>>, +} + +impl UdpSocketArray +where + R: VirtualUdpSocketFactory, +{ + pub fn new_with_context( + max_socket_count: usize, + socket_factory: Arc, + socket_context: SocketContext, + ) -> Self { + let tasks = Arc::new(Mutex::new(JoinSet::new())); + tokio::spawn(reap_joinset_background( + Arc::downgrade(&tasks), + "UdpSocketArray", + )); + + Self { + sockets: Arc::new(DashMap::new()), + max_socket_count, + socket_factory, + socket_context, + tasks, + + interest_tids: Arc::new(DashSet::new()), + tid_to_socket: Arc::new(DashMap::new()), + } + } + + pub fn started(&self) -> bool { + !self.sockets.is_empty() + } + + pub async fn add_new_socket(&self, socket: Arc) -> anyhow::Result<()> { + let socket_map = self.sockets.clone(); + let local_addr = socket.local_addr()?; + let interest_tids = self.interest_tids.clone(); + let tid_to_socket = self.tid_to_socket.clone(); + socket_map.insert(local_addr, socket.clone()); + self.tasks.lock().unwrap().spawn( + async move { + let _socket_map_guard = RemoveSocketOnDrop { + sockets: socket_map, + local_addr, + }; + let mut buf = [0u8; super::udp_packet_len(HOLE_PUNCH_PACKET_BODY_LEN)]; + tracing::trace!(?local_addr, "udp socket added"); + loop { + let Ok((len, addr)) = socket.recv_from(&mut buf).await else { + break; + }; + + tracing::debug!(?len, ?addr, "got raw packet"); + + let packet = &buf[..len]; + let Some(tid) = hole_punch_packet_tid(packet, HOLE_PUNCH_PACKET_BODY_LEN) + else { + continue; + }; + + tracing::debug!(?addr, ?tid, "got udp hole punch packet"); + + if interest_tids.contains(&tid) { + tracing::info!(?addr, ?tid, "got hole punching packet with interest tid"); + tid_to_socket + .entry(tid) + .or_default() + .push(PunchedUdpSocket { + socket: socket.clone(), + tid, + remote_addr: addr, + }); + break; + } + } + tracing::debug!(?local_addr, "udp socket recv loop end"); + } + .instrument(tracing::info_span!("udp array socket recv loop")), + ); + Ok(()) + } + + #[instrument(err)] + pub async fn start(&self) -> anyhow::Result<()> { + tracing::info!("starting udp socket array"); + + while self.sockets.len() < self.max_socket_count { + let socket = self + .socket_factory + .bind_udp( + UdpBindOptions::hole_punch_candidate() + .with_context(self.socket_context.clone().with_ip_version(IpVersion::V4)), + ) + .await?; + self.add_new_socket(socket).await?; + } + + Ok(()) + } + + #[instrument(err)] + pub async fn send_with_all(&self, data: &[u8], addr: SocketAddr) -> anyhow::Result<()> { + tracing::info!(?addr, "sending hole punching packet"); + + let sockets = self + .sockets + .iter() + .map(|s| s.value().clone()) + .collect::>(); + + for socket in sockets.iter() { + for _ in 0..3 { + socket.send_to(data, addr).await?; + } + } + + Ok(()) + } + + #[instrument(ret(level = Level::DEBUG))] + pub fn try_fetch_punched_socket(&self, tid: u32) -> Option> { + tracing::debug!(?tid, "try fetch punched socket"); + self.tid_to_socket.get_mut(&tid)?.value_mut().pop() + } + + pub fn add_interest_tid(&self, tid: u32) { + self.interest_tids.insert(tid); + } + + pub fn add_intreast_tid(&self, tid: u32) { + self.add_interest_tid(tid); + } + + pub fn remove_interest_tid(&self, tid: u32) { + self.interest_tids.remove(&tid); + self.tid_to_socket.remove(&tid); + } + + pub fn remove_intreast_tid(&self, tid: u32) { + self.remove_interest_tid(tid); + } +} + +impl Debug for UdpSocketArray +where + R: VirtualUdpSocketFactory, +{ + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("UdpSocketArray") + .field("sockets", &self.sockets.len()) + .field("max_socket_count", &self.max_socket_count) + .field("started", &self.started()) + .field("interest_tids", &self.interest_tids.len()) + .field("tid_to_socket", &self.tid_to_socket.len()) + .finish() + } +} + +struct RemoveSocketOnDrop { + sockets: Arc>>, + local_addr: SocketAddr, +} + +impl Drop for RemoveSocketOnDrop { + fn drop(&mut self) { + self.sockets.remove(&self.local_addr); + } +} + +#[cfg(test)] +mod tests { + use std::{ + collections::VecDeque, + io, + sync::atomic::{AtomicU16, Ordering}, + }; + + use async_trait::async_trait; + use tokio::sync::Mutex as TokioMutex; + + use super::*; + use crate::{packet::new_hole_punch_packet, socket::NetNamespace}; + + impl UdpSocketArray + where + R: VirtualUdpSocketFactory, + { + fn new(max_socket_count: usize, socket_factory: Arc) -> Self { + Self::new_with_context(max_socket_count, socket_factory, SocketContext::default()) + } + } + + struct MockSocket { + local_addr: SocketAddr, + incoming: TokioMutex, SocketAddr)>>, + sent: TokioMutex, SocketAddr)>>, + } + + impl MockSocket { + fn new(local_addr: SocketAddr, incoming: Vec<(Vec, SocketAddr)>) -> Self { + Self { + local_addr, + incoming: TokioMutex::new(incoming.into()), + sent: TokioMutex::new(Vec::new()), + } + } + } + + #[async_trait] + impl VirtualUdpSocket for MockSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> io::Result { + self.sent.lock().await.push((data.to_vec(), addr)); + Ok(data.len()) + } + + async fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + let packet = self.incoming.lock().await.pop_front(); + let Some((packet, addr)) = packet else { + return std::future::pending().await; + }; + buf[..packet.len()].copy_from_slice(&packet); + Ok((packet.len(), addr)) + } + } + + struct MockFactory { + next_port: AtomicU16, + bind_options: TokioMutex>, + } + + impl MockFactory { + fn new() -> Self { + Self { + next_port: AtomicU16::new(10000), + bind_options: TokioMutex::new(Vec::new()), + } + } + } + + #[async_trait] + impl VirtualUdpSocketFactory for MockFactory { + type Socket = MockSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.bind_options.lock().await.push(options); + let port = self.next_port.fetch_add(1, Ordering::Relaxed); + Ok(Arc::new(MockSocket::new( + SocketAddr::from(([127, 0, 0, 1], port)), + Vec::new(), + ))) + } + } + + #[tokio::test] + async fn fetches_socket_when_interested_tid_is_received() { + let runtime = Arc::new(MockFactory::new()); + let array = UdpSocketArray::new(0, runtime); + let tid = 7; + let remote_addr = SocketAddr::from(([10, 0, 0, 1], 1234)); + let packet = new_hole_punch_packet(tid, HOLE_PUNCH_PACKET_BODY_LEN) + .into_bytes() + .to_vec(); + let socket = Arc::new(MockSocket::new( + SocketAddr::from(([127, 0, 0, 1], 20000)), + vec![(packet, remote_addr)], + )); + + array.add_interest_tid(tid); + array.add_new_socket(socket.clone()).await.unwrap(); + + for _ in 0..10 { + if let Some(punched) = array.try_fetch_punched_socket(tid) { + assert_eq!(punched.tid, tid); + assert_eq!(punched.remote_addr, remote_addr); + assert!(Arc::ptr_eq(&punched.socket, &socket)); + return; + } + tokio::task::yield_now().await; + } + + panic!("punched socket was not recorded"); + } + + #[tokio::test] + async fn send_with_all_sends_three_packets_per_socket() { + let runtime = Arc::new(MockFactory::new()); + let array = UdpSocketArray::new(0, runtime); + let socket = Arc::new(MockSocket::new( + SocketAddr::from(([127, 0, 0, 1], 20001)), + Vec::new(), + )); + let remote_addr = SocketAddr::from(([10, 0, 0, 2], 1235)); + + array.add_new_socket(socket.clone()).await.unwrap(); + array.send_with_all(b"abc", remote_addr).await.unwrap(); + + let sent = socket.sent.lock().await; + assert_eq!(sent.len(), 3); + assert!( + sent.iter() + .all(|(data, addr)| data == b"abc" && *addr == remote_addr) + ); + } + + #[tokio::test] + async fn start_binds_up_to_max_socket_count() { + let runtime = Arc::new(MockFactory::new()); + let context = SocketContext::default() + .with_socket_mark(Some(0)) + .with_netns(Some(NetNamespace::new("instance-a"))); + let array = UdpSocketArray::new_with_context(2, runtime.clone(), context.clone()); + + array.start().await.unwrap(); + + assert!(array.started()); + assert_eq!(array.sockets.len(), 2); + + let bind_options = runtime.bind_options.lock().await; + assert_eq!( + bind_options.as_slice(), + &[ + UdpBindOptions::hole_punch_candidate() + .with_context(context.clone().with_ip_version(IpVersion::V4)), + UdpBindOptions::hole_punch_candidate() + .with_context(context.with_ip_version(IpVersion::V4)), + ] + ); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/task.rs b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/task.rs new file mode 100644 index 0000000..4616dbf --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/hole_punch/udp/task.rs @@ -0,0 +1,217 @@ +use crate::{ + config::{P2pPolicyFlags, PeerId}, + proto::common::{NatType, PeerFeatureFlag}, +}; + +use super::{ + super::policy::{should_background_p2p_with_peer, should_try_p2p_with_peer}, + UdpNatType, +}; + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct UdpPunchCandidate { + pub peer_id: PeerId, + pub udp_nat_type: NatType, + pub feature_flag: Option, + pub has_direct_connection: bool, + pub has_recent_traffic: bool, +} + +#[derive(Clone, Copy, Debug, Hash, Eq, PartialEq)] +pub struct UdpPunchTaskInfo { + pub dst_peer_id: PeerId, + pub dst_nat_type: UdpNatType, + pub my_nat_type: UdpNatType, +} + +pub fn collect_udp_punch_tasks( + my_peer_id: PeerId, + my_nat_type: UdpNatType, + policy: P2pPolicyFlags, + candidates: I, + is_blacklisted: F, +) -> Vec +where + I: IntoIterator, + F: Fn(PeerId) -> bool, +{ + if my_nat_type.is_open() { + return Vec::new(); + } + + candidates + .into_iter() + .filter_map(|candidate| { + let static_allowed = should_background_p2p_with_peer( + candidate.feature_flag.as_ref(), + false, + policy.lazy_p2p, + policy.disable_p2p, + policy.need_p2p, + ); + let dynamic_allowed = should_try_p2p_with_peer( + candidate.feature_flag.as_ref(), + false, + policy.disable_p2p, + policy.need_p2p, + ) && candidate.has_recent_traffic; + if !static_allowed && !dynamic_allowed { + return None; + } + + let peer_id = candidate.peer_id; + if is_blacklisted(peer_id) || candidate.has_direct_connection { + return None; + } + + let peer_nat_type = candidate.udp_nat_type.into(); + if !my_nat_type.can_punch_hole_as_client( + peer_nat_type, + my_peer_id, + peer_id, + policy.disable_sym_hole_punching, + ) { + return None; + } + + Some(UdpPunchTaskInfo { + dst_peer_id: peer_id, + dst_nat_type: peer_nat_type, + my_nat_type, + }) + }) + .collect() +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::proto::common::PeerFeatureFlag; + + fn candidate(peer_id: PeerId, udp_nat_type: NatType) -> UdpPunchCandidate { + UdpPunchCandidate { + peer_id, + udp_nat_type, + feature_flag: Some(PeerFeatureFlag::default()), + has_direct_connection: false, + has_recent_traffic: false, + } + } + + fn collect( + my_peer_id: PeerId, + my_nat_type: NatType, + policy: P2pPolicyFlags, + candidates: Vec, + ) -> Vec { + collect_udp_punch_tasks(my_peer_id, my_nat_type.into(), policy, candidates, |_| { + false + }) + } + + #[test] + fn open_nat_does_not_start_udp_punch_tasks() { + let tasks = collect( + 1, + NatType::OpenInternet, + P2pPolicyFlags::default(), + vec![candidate(2, NatType::PortRestricted)], + ); + + assert!(tasks.is_empty()); + } + + #[test] + fn lazy_p2p_allows_recent_traffic_without_need_p2p_flag() { + let mut idle = candidate(2, NatType::PortRestricted); + idle.feature_flag = Some(PeerFeatureFlag { + need_p2p: false, + ..Default::default() + }); + + let mut active = idle.clone(); + active.peer_id = 3; + active.has_recent_traffic = true; + + let tasks = collect( + 1, + NatType::PortRestricted, + P2pPolicyFlags { + lazy_p2p: true, + ..Default::default() + }, + vec![idle, active], + ); + + assert_eq!(tasks.len(), 1); + assert_eq!(tasks[0].dst_peer_id, 3); + } + + #[test] + fn skips_blacklisted_and_directly_connected_candidates() { + let mut direct = candidate(2, NatType::PortRestricted); + direct.has_direct_connection = true; + + let tasks = collect_udp_punch_tasks( + 1, + NatType::PortRestricted.into(), + P2pPolicyFlags::default(), + vec![direct, candidate(3, NatType::PortRestricted)], + |peer_id| peer_id == 3, + ); + + assert!(tasks.is_empty()); + } + + #[test] + fn filters_candidates_by_udp_nat_method() { + let tasks = collect( + 1, + NatType::PortRestricted, + P2pPolicyFlags::default(), + vec![ + candidate(2, NatType::Symmetric), + candidate(3, NatType::PortRestricted), + ], + ); + + assert_eq!(tasks.len(), 1); + assert_eq!(tasks[0].dst_peer_id, 3); + assert_eq!(tasks[0].dst_nat_type, NatType::PortRestricted.into()); + } + + #[test] + fn easy_symmetric_pair_uses_lower_peer_id_as_initiator() { + let tasks = collect( + 1, + NatType::SymmetricEasyInc, + P2pPolicyFlags::default(), + vec![candidate(2, NatType::SymmetricEasyDec)], + ); + assert_eq!(tasks.len(), 1); + + let tasks = collect( + 2, + NatType::SymmetricEasyInc, + P2pPolicyFlags::default(), + vec![candidate(1, NatType::SymmetricEasyDec)], + ); + assert!(tasks.is_empty()); + } + + #[test] + fn disabling_symmetric_hole_punch_keeps_sym_to_cone_as_cone_method() { + let tasks = collect( + 1, + NatType::Symmetric, + P2pPolicyFlags { + disable_sym_hole_punching: true, + ..Default::default() + }, + vec![candidate(2, NatType::PortRestricted)], + ); + + assert_eq!(tasks.len(), 1); + assert_eq!(tasks[0].dst_peer_id, 2); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/manual/discovery.rs b/vendor/easytier/easytier-core/src/connectivity/manual/discovery.rs new file mode 100644 index 0000000..ea52e7b --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/manual/discovery.rs @@ -0,0 +1,73 @@ +use std::time::Duration; + +use serde::{Deserialize, Serialize}; + +use crate::socket::{IpVersion, SocketContext, tcp::TcpBindOptions}; + +#[cfg(feature = "endpoint-discovery")] +mod implementation; + +#[cfg(feature = "endpoint-discovery")] +pub(crate) use implementation::CoreManualEndpointResolver; + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct ManualEndpointDiscoveryConfig { + pub user_agent: String, + pub network_name: String, + pub http_timeout: Duration, + pub http_ip_version: IpVersion, + pub http_tcp_bind: TcpBindOptions, + pub dns_record_context: SocketContext, + pub srv_protocols: Vec, +} + +impl Default for ManualEndpointDiscoveryConfig { + fn default() -> Self { + Self { + user_agent: "easytier-core".to_owned(), + network_name: String::new(), + http_timeout: Duration::from_secs(20), + http_ip_version: IpVersion::Both, + http_tcp_bind: TcpBindOptions::default(), + dns_record_context: SocketContext::default(), + srv_protocols: vec!["tcp".to_owned(), "udp".to_owned()], + } + } +} + +#[cfg(not(feature = "endpoint-discovery"))] +pub(crate) struct CoreManualEndpointResolver +where + H: crate::socket::tcp::VirtualTcpSocketFactory, +{ + _host: std::marker::PhantomData H>, +} + +#[cfg(not(feature = "endpoint-discovery"))] +impl CoreManualEndpointResolver +where + H: crate::socket::tcp::VirtualTcpSocketFactory, +{ + pub fn new( + host: std::sync::Arc, + dns: std::sync::Arc, + dns_records: std::sync::Arc, + config: ManualEndpointDiscoveryConfig, + ) -> Self { + let _ = (host, dns, dns_records, config); + Self { + _host: std::marker::PhantomData, + } + } +} + +#[cfg(not(feature = "endpoint-discovery"))] +#[async_trait::async_trait] +impl super::ManualEndpointResolver for CoreManualEndpointResolver +where + H: crate::socket::tcp::VirtualTcpSocketFactory, +{ + async fn resolve_endpoint(&self, url: &url::Url) -> anyhow::Result { + anyhow::bail!("endpoint discovery is disabled for {url}") + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/manual/discovery/implementation.rs b/vendor/easytier/easytier-core/src/connectivity/manual/discovery/implementation.rs new file mode 100644 index 0000000..6029dfb --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/manual/discovery/implementation.rs @@ -0,0 +1,969 @@ +use std::{collections::HashSet, sync::Arc, time::Duration}; + +use anyhow::Context as _; +use bytes::Bytes; +use http_body_util::{BodyExt as _, Empty}; +use hyper::{Request, header}; +use hyper_util::rt::TokioIo; +use rand::{Rng as _, seq::SliceRandom}; +use rustls::pki_types::ServerName; +use tokio::io::{AsyncRead, AsyncWrite}; +use tokio_rustls::TlsConnector; +use tokio_util::task::AbortOnDropHandle; +use url::Url; + +use crate::{ + connectivity::transport, + host::dns::{DnsQuery, DnsRecordResolver, DnsResolver, DnsSrvRecord}, + socket::{ + IpVersion, SocketContext, + tcp::{TcpBindOptions, TcpSocketPurpose, VirtualTcpSocketFactory}, + }, +}; + +use super::super::{ManualEndpointResolver, resolve_url_addrs}; +use super::ManualEndpointDiscoveryConfig; + +const HTTP_DEFAULT_PORT: u16 = 80; +const HTTPS_DEFAULT_PORT: u16 = 443; + +#[derive(Debug, Clone)] +pub(crate) struct HttpDiscoveryRequest { + pub url: Url, + pub user_agent: String, + pub network_name: String, + pub timeout: Duration, + pub ip_version: IpVersion, + pub tcp_bind: TcpBindOptions, +} + +pub(crate) struct CoreManualEndpointResolver +where + H: VirtualTcpSocketFactory, +{ + host: Arc, + dns: Arc, + dns_records: Arc, + config: ManualEndpointDiscoveryConfig, +} + +impl CoreManualEndpointResolver +where + H: VirtualTcpSocketFactory, +{ + pub fn new( + host: Arc, + dns: Arc, + dns_records: Arc, + config: ManualEndpointDiscoveryConfig, + ) -> Self { + Self { + host, + dns, + dns_records, + config, + } + } +} + +#[async_trait::async_trait] +impl ManualEndpointResolver for CoreManualEndpointResolver +where + H: VirtualTcpSocketFactory, +{ + async fn resolve_endpoint(&self, url: &Url) -> anyhow::Result { + match url.scheme() { + "http" | "https" => { + let response = fetch_http_discovery( + self.host.clone(), + self.dns.as_ref(), + HttpDiscoveryRequest { + url: url.clone(), + user_agent: self.config.user_agent.clone(), + network_name: self.config.network_name.clone(), + timeout: self.config.http_timeout, + ip_version: self.config.http_ip_version, + tcp_bind: self.config.http_tcp_bind.clone(), + }, + ) + .await?; + resolve_http_endpoint(response) + .map(|endpoint| endpoint.url) + .map_err(|error| anyhow::anyhow!("Invalid Url: {error}")) + } + "txt" => { + let host = endpoint_host(url)?; + resolve_txt_endpoint( + self.dns_records.as_ref(), + host, + self.config.dns_record_context.clone(), + ) + .await + } + "srv" => { + let host = endpoint_host(url)?; + resolve_srv_endpoint( + self.dns_records.as_ref(), + host, + &self.config.srv_protocols, + self.config.dns_record_context.clone(), + ) + .await + } + scheme => anyhow::bail!("unsupported manual endpoint resolver scheme: {scheme}"), + } + } +} + +pub(super) fn endpoint_host(url: &Url) -> anyhow::Result<&str> { + url.host_str() + .ok_or_else(|| anyhow::anyhow!("host should not be empty in {url}")) +} + +pub(crate) async fn fetch_http_discovery( + host: Arc, + dns: &dyn DnsResolver, + request: HttpDiscoveryRequest, +) -> anyhow::Result +where + H: VirtualTcpSocketFactory, +{ + let timeout = request.timeout; + crate::foundation::time::timeout(timeout, fetch_http_discovery_inner(host, dns, request)) + .await + .map_err(|_| anyhow::anyhow!("HTTP discovery timed out after {timeout:?}"))? +} + +async fn fetch_http_discovery_inner( + host: Arc, + dns: &dyn DnsResolver, + request: HttpDiscoveryRequest, +) -> anyhow::Result +where + H: VirtualTcpSocketFactory, +{ + let default_port = match request.url.scheme() { + "http" => HTTP_DEFAULT_PORT, + "https" => HTTPS_DEFAULT_PORT, + scheme => anyhow::bail!("unsupported HTTP discovery scheme: {scheme}"), + }; + let addrs = resolve_url_addrs( + &request.url, + default_port, + request + .tcp_bind + .context + .clone() + .with_ip_version(request.ip_version), + dns, + ) + .await?; + + let mut last_error = None; + let mut socket = None; + for addr in addrs { + match transport::connect_tcp( + host.clone(), + addr, + Vec::new(), + request.tcp_bind.clone(), + TcpSocketPurpose::ManualConnect, + ) + .await + { + Ok(connected) => { + socket = Some(connected); + break; + } + Err(error) => last_error = Some(error), + } + } + let socket = socket.ok_or_else(|| { + last_error.unwrap_or_else(|| anyhow::anyhow!("no HTTP discovery address candidates")) + })?; + + if request.url.scheme() == "https" { + let server_name = tls_server_name(&request.url)?; + let root_store = rustls::RootCertStore { + roots: webpki_roots::TLS_SERVER_ROOTS.to_vec(), + }; + // A host application can enable another rustls backend through Cargo + // feature unification. Select ring explicitly instead of requiring a + // process-wide provider to have been initialized first (#2607). + let tls_config = rustls::ClientConfig::builder_with_provider(Arc::new( + rustls::crypto::ring::default_provider(), + )) + .with_safe_default_protocol_versions() + .context("selecting HTTPS protocol versions failed")? + .with_root_certificates(root_store) + .with_no_client_auth(); + let stream = TlsConnector::from(Arc::new(tls_config)) + .connect(server_name, socket) + .await + .with_context(|| format!("HTTPS handshake failed for {}", request.url))?; + send_http_discovery_request(stream, request).await + } else { + send_http_discovery_request(socket, request).await + } +} + +pub(super) fn tls_server_name(url: &Url) -> anyhow::Result> { + match url.host() { + Some(url::Host::Domain(host)) => ServerName::try_from(host.to_owned()) + .with_context(|| format!("invalid HTTPS server name in {url}")), + Some(url::Host::Ipv4(ip)) => Ok(ServerName::IpAddress(ip.into())), + Some(url::Host::Ipv6(ip)) => Ok(ServerName::IpAddress(ip.into())), + None => anyhow::bail!("HTTP discovery URL has no host: {url}"), + } +} + +async fn send_http_discovery_request( + stream: S, + request: HttpDiscoveryRequest, +) -> anyhow::Result +where + S: AsyncRead + AsyncWrite + Unpin + Send + 'static, +{ + let io = TokioIo::new(stream); + let (mut sender, connection) = hyper::client::conn::http1::handshake(io) + .await + .with_context(|| format!("starting HTTP connection failed for {}", request.url))?; + let connection_task = AbortOnDropHandle::new(tokio::spawn(connection)); + + let request_target = match request.url.query() { + Some(query) => format!("{}?{query}", request.url.path()), + None => request.url.path().to_owned(), + }; + let host_header = &request.url[url::Position::BeforeHost..url::Position::AfterPort]; + let outgoing = Request::builder() + .method("GET") + .uri(request_target) + .header(header::HOST, host_header) + .header(header::USER_AGENT, request.user_agent) + .header("X-Network-Name", request.network_name) + .header(header::CONNECTION, "close") + .body(Empty::::new())?; + let response = sender + .send_request(outgoing) + .await + .with_context(|| format!("sending HTTP request failed for {}", request.url))?; + let status_code = response.status().as_u16(); + let location = response + .headers() + .get(header::LOCATION) + .map(|value| String::from_utf8_lossy(value.as_bytes()).into_owned()); + let body = response + .into_body() + .collect() + .await + .with_context(|| format!("reading HTTP response failed for {}", request.url))? + .to_bytes(); + drop(sender); + connection_task + .await + .context("HTTP connection task failed")? + .with_context(|| format!("HTTP connection failed for {}", request.url))?; + + Ok(HttpDiscoveryResponse { + status_code, + location, + body: String::from_utf8_lossy(&body).into_owned(), + }) +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(crate) enum HttpEndpointSource { + RedirectQuery, + RedirectUrl, + ResponseBody, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) struct HttpDiscoveryResponse { + pub status_code: u16, + pub location: Option, + pub body: String, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) struct ResolvedHttpEndpoint { + pub url: Url, + pub source: HttpEndpointSource, +} + +fn resolve_http_redirect(location: &str) -> anyhow::Result { + let url = Url::parse(location) + .with_context(|| format!("parsing redirect URL failed. url: {location}"))?; + if !matches!(url.scheme(), "http" | "https") { + return Ok(ResolvedHttpEndpoint { + url, + source: HttpEndpointSource::RedirectUrl, + }); + } + + let candidates = url + .query_pairs() + .filter_map(|(_, value)| Url::parse(&value).ok()) + .collect::>(); + if let Some(url) = candidates.choose(&mut rand::thread_rng()).cloned() { + return Ok(ResolvedHttpEndpoint { + url, + source: HttpEndpointSource::RedirectQuery, + }); + } + + if let Some(url) = location + .strip_prefix(&format!("{}://", url.scheme())) + .and_then(|value| Url::parse(value).ok()) + { + return Ok(ResolvedHttpEndpoint { + url, + source: HttpEndpointSource::RedirectUrl, + }); + } + + anyhow::bail!("no valid connector URL found in redirect location {location:?}") +} + +fn resolve_http_body(body: &str) -> anyhow::Result { + let mut candidates = body + .lines() + .map(str::trim) + .filter(|line| !line.is_empty()) + .collect::>(); + candidates.shuffle(&mut rand::thread_rng()); + for candidate in candidates { + if let Ok(url) = Url::parse(candidate) { + return Ok(ResolvedHttpEndpoint { + url, + source: HttpEndpointSource::ResponseBody, + }); + } + } + anyhow::bail!("no valid connector URL found in response body {body:?}") +} + +pub(crate) fn resolve_http_endpoint( + response: HttpDiscoveryResponse, +) -> anyhow::Result { + match response.status_code { + 300..=399 => resolve_http_redirect( + response + .location + .as_deref() + .ok_or_else(|| anyhow::anyhow!("HTTP redirect has no Location header"))?, + ), + 200..=299 => resolve_http_body(&response.body), + status_code => anyhow::bail!( + "unexpected HTTP discovery status {status_code}, body: {:?}", + response.body + ), + } +} + +fn choose_weighted(options: &[(T, u64)]) -> Option<&T> { + let total_weight = options.iter().map(|(_, weight)| *weight).sum(); + let mut rng = rand::thread_rng(); + let selected = rng.gen_range(0..total_weight); + let mut accumulated = 0; + + for (item, weight) in options { + accumulated += *weight; + if selected < accumulated { + return Some(item); + } + } + None +} + +pub(crate) async fn resolve_txt_endpoint( + resolver: &dyn DnsRecordResolver, + domain_name: &str, + context: SocketContext, +) -> anyhow::Result { + let txt_data = resolver + .resolve_txt(DnsQuery::new(domain_name, context)) + .await + .with_context(|| format!("resolve TXT record failed for {domain_name}"))?; + let candidates = txt_data + .split(' ') + .filter_map(|candidate| Url::parse(candidate).ok()) + .collect::>(); + candidates + .choose(&mut rand::thread_rng()) + .cloned() + .ok_or_else(|| { + anyhow::anyhow!( + "no valid URL found in TXT data {txt_data:?}; expected a space-separated URL list" + ) + }) +} + +fn srv_record_url(protocol: &str, record: DnsSrvRecord) -> anyhow::Result<(Url, u64)> { + if record.port == 0 { + anyhow::bail!("SRV port must be non-zero"); + } + let url = format!("{protocol}://{}:{}", record.target, record.port); + // Preserve the existing EasyTier selection rule, which treats SRV priority + // as the candidate weight. + Ok((Url::parse(&url)?, u64::from(record.priority))) +} + +pub(super) fn deduplicate_srv_candidates(candidates: Vec<(Url, u64)>) -> Vec<(Url, u64)> { + candidates + .into_iter() + .collect::>() + .into_iter() + .collect() +} + +pub(crate) async fn resolve_srv_endpoint( + resolver: &dyn DnsRecordResolver, + domain_name: &str, + supported_protocols: &[String], + context: SocketContext, +) -> anyhow::Result { + let lookups = supported_protocols.iter().map(|protocol| { + let protocol = protocol.clone(); + let query = DnsQuery::new( + format!("_easytier._{protocol}.{domain_name}"), + context.clone(), + ); + async move { (protocol, resolver.resolve_srv(query).await) } + }); + + let mut candidates = Vec::new(); + for (protocol, result) in futures::future::join_all(lookups).await { + let Ok(records) = result else { + continue; + }; + candidates.extend(records.into_iter().filter_map(|record| { + match srv_record_url(&protocol, record) { + Ok(candidate) => Some(candidate), + Err(error) => { + tracing::warn!( + ?error, + srv_domain = %format!("_easytier._{protocol}.{domain_name}"), + "ignore invalid SRV endpoint record" + ); + None + } + } + })); + } + if candidates.is_empty() { + anyhow::bail!("no SRV endpoint found for {domain_name}"); + } + let candidates = deduplicate_srv_candidates(candidates); + + choose_weighted(&candidates) + .cloned() + .ok_or_else(|| anyhow::anyhow!("failed to choose an SRV endpoint for {domain_name}")) +} + +#[cfg(test)] +mod tests { + use std::{ + io, + net::{IpAddr, Ipv4Addr, SocketAddr}, + pin::Pin, + sync::Mutex, + task::{Context, Poll}, + }; + + use async_trait::async_trait; + use tokio::io::{AsyncReadExt as _, AsyncWriteExt as _, DuplexStream, ReadBuf}; + + use crate::socket::tcp::{TcpConnectOptions, VirtualTcpSocket, VirtualTcpSocketFactory}; + + use super::*; + + struct HttpTestSocket { + stream: DuplexStream, + local_addr: SocketAddr, + peer_addr: SocketAddr, + } + + impl AsyncRead for HttpTestSocket { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + Pin::new(&mut self.stream).poll_read(cx, buf) + } + } + + impl AsyncWrite for HttpTestSocket { + fn poll_write( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut self.stream).poll_write(cx, buf) + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_flush(cx) + } + + fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_shutdown(cx) + } + } + + impl VirtualTcpSocket for HttpTestSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + fn peer_addr(&self) -> io::Result { + Ok(self.peer_addr) + } + } + + struct HttpTestHost { + stream: Mutex>, + connects: Mutex>, + } + + #[async_trait] + impl VirtualTcpSocketFactory for HttpTestHost { + type Socket = HttpTestSocket; + + async fn connect_tcp(&self, options: TcpConnectOptions) -> anyhow::Result { + self.connects.lock().unwrap().push(options.clone()); + let stream = self + .stream + .lock() + .unwrap() + .take() + .ok_or_else(|| anyhow::anyhow!("test socket already connected"))?; + Ok(HttpTestSocket { + stream, + local_addr: "192.0.2.2:40000".parse().unwrap(), + peer_addr: options.remote_addr, + }) + } + } + + struct HttpTestDns { + queries: Mutex>, + } + + #[async_trait] + impl DnsResolver for HttpTestDns { + async fn resolve(&self, query: DnsQuery) -> anyhow::Result> { + self.queries.lock().unwrap().push(query); + Ok(vec![IpAddr::V4(Ipv4Addr::new(192, 0, 2, 1))]) + } + } + + #[tokio::test] + async fn http_fetch_uses_host_dns_and_socket_while_core_drives_io() { + let (client, mut server) = tokio::io::duplex(8192); + let host = Arc::new(HttpTestHost { + stream: Mutex::new(Some(client)), + connects: Mutex::new(Vec::new()), + }); + let dns = HttpTestDns { + queries: Mutex::new(Vec::new()), + }; + let server_task = tokio::spawn(async move { + let mut request = Vec::new(); + loop { + let mut chunk = [0; 1024]; + let len = server.read(&mut chunk).await.unwrap(); + assert_ne!(len, 0, "HTTP request ended before its headers"); + request.extend_from_slice(&chunk[..len]); + if request.windows(4).any(|window| window == b"\r\n\r\n") { + break; + } + } + let request = String::from_utf8(request).unwrap().to_ascii_lowercase(); + assert!(request.starts_with("get /lookup?kind=peer http/1.1\r\n")); + assert!(request.contains("host: discovery.example:18080\r\n")); + assert!(request.contains("user-agent: easytier/test\r\n")); + assert!(request.contains("x-network-name: test-network\r\n")); + assert!(request.contains("connection: close\r\n")); + + server + .write_all( + b"HTTP/1.1 302 Found\r\nLocation: tcp://192.0.2.10:11010\r\nTransfer-Encoding: chunked\r\nConnection: close\r\n\r\n5\r\nhello\r\n0\r\n\r\n", + ) + .await + .unwrap(); + server.shutdown().await.unwrap(); + }); + + let response = fetch_http_discovery( + host.clone(), + &dns, + HttpDiscoveryRequest { + url: "http://discovery.example:18080/lookup?kind=peer" + .parse() + .unwrap(), + user_agent: "easytier/test".to_owned(), + network_name: "test-network".to_owned(), + timeout: Duration::from_secs(1), + ip_version: IpVersion::V4, + tcp_bind: TcpBindOptions::default().with_socket_mark(Some(9)), + }, + ) + .await + .unwrap(); + crate::foundation::time::timeout(Duration::from_secs(1), server_task) + .await + .expect("HTTP fetch test server did not finish") + .unwrap(); + + assert_eq!(response.status_code, 302); + assert_eq!(response.location.as_deref(), Some("tcp://192.0.2.10:11010")); + assert_eq!(response.body, "hello"); + assert_eq!( + *dns.queries.lock().unwrap(), + [DnsQuery::new( + "discovery.example", + SocketContext { + ip_version: IpVersion::V4, + socket_mark: Some(9), + netns: None, + } + )] + ); + assert_eq!(host.connects.lock().unwrap().len(), 1); + let options = &host.connects.lock().unwrap()[0]; + assert_eq!(options.remote_addr, "192.0.2.1:18080".parse().unwrap()); + assert_eq!(options.purpose, TcpSocketPurpose::ManualConnect); + assert_eq!(options.bind.context.socket_mark, Some(9)); + } + + #[tokio::test] + async fn https_fetch_reaches_tls_handshake_without_global_provider() { + // Also run with rustls/aws_lc_rs enabled: feature unification must not + // make HTTPS discovery panic before it can send a ClientHello (#2607). + let (client, mut server) = tokio::io::duplex(8192); + let host = Arc::new(HttpTestHost { + stream: Mutex::new(Some(client)), + connects: Mutex::new(Vec::new()), + }); + let dns = HttpTestDns { + queries: Mutex::new(Vec::new()), + }; + let server_task = tokio::spawn(async move { + let mut record_header = [0; 5]; + server.read_exact(&mut record_header).await.unwrap(); + assert_eq!(record_header[0], 22, "expected a TLS handshake record"); + // Close without replying; discovery should report a handshake + // error rather than panic while selecting a crypto provider. + }); + + let error = fetch_http_discovery( + host, + &dns, + HttpDiscoveryRequest { + url: "https://discovery.example/lookup".parse().unwrap(), + user_agent: "easytier/test".to_owned(), + network_name: "test-network".to_owned(), + timeout: Duration::from_secs(5), + ip_version: IpVersion::V4, + tcp_bind: TcpBindOptions::default(), + }, + ) + .await + .expect_err("server closed during the TLS handshake"); + assert!(format!("{error:#}").contains("HTTPS handshake failed")); + server_task.await.unwrap(); + } + + #[test] + fn http_discovery_interprets_redirect_and_body_forms() { + let query = resolve_http_endpoint(HttpDiscoveryResponse { + status_code: 302, + location: Some("https://discovery.example/?url=tcp://127.0.0.1:11010".to_owned()), + body: String::new(), + }) + .unwrap(); + assert_eq!(query.url.as_str(), "tcp://127.0.0.1:11010"); + assert_eq!(query.source, HttpEndpointSource::RedirectQuery); + + let nested = resolve_http_endpoint(HttpDiscoveryResponse { + status_code: 302, + location: Some("https://udp://127.0.0.1:11010".to_owned()), + body: String::new(), + }) + .unwrap(); + assert_eq!(nested.url.as_str(), "udp://127.0.0.1:11010"); + assert_eq!(nested.source, HttpEndpointSource::RedirectUrl); + + let direct = resolve_http_endpoint(HttpDiscoveryResponse { + status_code: 307, + location: Some("quic://127.0.0.1:11012".to_owned()), + body: String::new(), + }) + .unwrap(); + assert_eq!(direct.url.as_str(), "quic://127.0.0.1:11012"); + assert_eq!(direct.source, HttpEndpointSource::RedirectUrl); + + let body = resolve_http_endpoint(HttpDiscoveryResponse { + status_code: 200, + location: None, + body: "invalid\nwg://127.0.0.1:11011\n".to_owned(), + }) + .unwrap(); + assert_eq!(body.url.as_str(), "wg://127.0.0.1:11011"); + assert_eq!(body.source, HttpEndpointSource::ResponseBody); + } + + #[test] + fn http_discovery_reports_malformed_redirect_location() { + let error = resolve_http_endpoint(HttpDiscoveryResponse { + status_code: 302, + location: Some("not a URL".to_owned()), + body: String::new(), + }) + .unwrap_err(); + + let message = error.to_string(); + assert!(message.contains("parsing redirect URL failed")); + assert!(message.contains("not a URL")); + } + + #[test] + fn https_server_name_accepts_ip_literals_without_url_brackets() { + let ipv4: Url = "https://192.0.2.1/".parse().unwrap(); + let ipv6: Url = "https://[2001:db8::1]/".parse().unwrap(); + + assert_eq!( + tls_server_name(&ipv4).unwrap(), + ServerName::IpAddress(Ipv4Addr::new(192, 0, 2, 1).into()) + ); + assert_eq!( + tls_server_name(&ipv6).unwrap(), + ServerName::IpAddress("2001:db8::1".parse::().unwrap().into()) + ); + } + + struct TestResolver { + txt: String, + srv: Vec, + queries: Mutex>, + } + + #[async_trait] + impl DnsRecordResolver for TestResolver { + async fn resolve_txt(&self, query: DnsQuery) -> anyhow::Result { + self.queries.lock().unwrap().push(query); + Ok(self.txt.clone()) + } + + async fn resolve_srv(&self, query: DnsQuery) -> anyhow::Result> { + self.queries.lock().unwrap().push(query); + Ok(self.srv.clone()) + } + } + + #[tokio::test] + async fn core_endpoint_resolver_owns_record_scheme_dispatch() { + let host = Arc::new(HttpTestHost { + stream: Mutex::new(None), + connects: Mutex::new(Vec::new()), + }); + let dns: Arc = Arc::new(HttpTestDns { + queries: Mutex::new(Vec::new()), + }); + let records = Arc::new(TestResolver { + txt: "tcp://192.0.2.10:11010".to_owned(), + srv: vec![DnsSrvRecord { + priority: 1, + weight: 10, + port: 11012, + target: "peer.example.com.".to_owned(), + }], + queries: Mutex::new(Vec::new()), + }); + let record_context = SocketContext { + ip_version: IpVersion::V6, + socket_mark: Some(17), + netns: None, + }; + let resolver = CoreManualEndpointResolver::new( + host, + dns, + records.clone(), + ManualEndpointDiscoveryConfig { + user_agent: "easytier/test".to_owned(), + network_name: "test-network".to_owned(), + http_timeout: Duration::from_secs(1), + http_ip_version: IpVersion::Both, + http_tcp_bind: TcpBindOptions::default(), + dns_record_context: record_context.clone(), + srv_protocols: vec!["quic".to_owned()], + }, + ); + + let txt = resolver + .resolve_endpoint(&"txt://discovery.example".parse().unwrap()) + .await + .unwrap(); + let srv = resolver + .resolve_endpoint(&"srv://discovery.example".parse().unwrap()) + .await + .unwrap(); + + assert_eq!(txt.as_str(), "tcp://192.0.2.10:11010"); + assert_eq!(srv.as_str(), "quic://peer.example.com.:11012"); + assert_eq!( + *records.queries.lock().unwrap(), + [ + DnsQuery::new("discovery.example", record_context.clone()), + DnsQuery::new("_easytier._quic.discovery.example", record_context) + ] + ); + } + + #[tokio::test] + async fn core_endpoint_resolver_passes_http_config_and_error_classification() { + let (client, mut server) = tokio::io::duplex(8192); + let host = Arc::new(HttpTestHost { + stream: Mutex::new(Some(client)), + connects: Mutex::new(Vec::new()), + }); + let dns = Arc::new(HttpTestDns { + queries: Mutex::new(Vec::new()), + }); + let records = Arc::new(TestResolver { + txt: String::new(), + srv: Vec::new(), + queries: Mutex::new(Vec::new()), + }); + let server_task = tokio::spawn(async move { + let mut request = Vec::new(); + loop { + let mut chunk = [0; 1024]; + let len = server.read(&mut chunk).await.unwrap(); + assert_ne!(len, 0, "HTTP request ended before its headers"); + request.extend_from_slice(&chunk[..len]); + if request.windows(4).any(|window| window == b"\r\n\r\n") { + break; + } + } + let request = String::from_utf8(request).unwrap().to_ascii_lowercase(); + assert!(request.contains("user-agent: easytier/facade-test\r\n")); + assert!(request.contains("x-network-name: facade-network\r\n")); + server + .write_all( + b"HTTP/1.1 200 OK\r\nContent-Length: 9\r\nConnection: close\r\n\r\nnot a URL", + ) + .await + .unwrap(); + server.shutdown().await.unwrap(); + }); + let resolver = CoreManualEndpointResolver::new( + host.clone(), + dns.clone(), + records, + ManualEndpointDiscoveryConfig { + user_agent: "easytier/facade-test".to_owned(), + network_name: "facade-network".to_owned(), + http_timeout: Duration::from_secs(1), + http_ip_version: IpVersion::V4, + http_tcp_bind: TcpBindOptions::default().with_socket_mark(Some(23)), + dns_record_context: SocketContext::default(), + srv_protocols: Vec::new(), + }, + ); + + let error = resolver + .resolve_endpoint(&"http://discovery.example:18081/endpoint".parse().unwrap()) + .await + .unwrap_err(); + crate::foundation::time::timeout(Duration::from_secs(1), server_task) + .await + .expect("HTTP facade test server did not finish") + .unwrap(); + + assert!(error.to_string().starts_with("Invalid Url:")); + assert_eq!( + *dns.queries.lock().unwrap(), + [DnsQuery::new( + "discovery.example", + SocketContext { + ip_version: IpVersion::V4, + socket_mark: Some(23), + netns: None, + } + )] + ); + let connects = host.connects.lock().unwrap(); + assert_eq!(connects.len(), 1); + assert_eq!(connects[0].remote_addr, "192.0.2.1:18081".parse().unwrap()); + assert_eq!(connects[0].bind.context.socket_mark, Some(23)); + } + + #[tokio::test] + async fn txt_discovery_parses_easy_tier_url_candidates() { + let resolver = TestResolver { + txt: "invalid tcp://127.0.0.1:11010".to_owned(), + srv: Vec::new(), + queries: Mutex::new(Vec::new()), + }; + + let endpoint = + resolve_txt_endpoint(&resolver, "discovery.example", SocketContext::default()) + .await + .unwrap(); + + assert_eq!(endpoint.as_str(), "tcp://127.0.0.1:11010"); + assert_eq!( + *resolver.queries.lock().unwrap(), + [DnsQuery::new("discovery.example", SocketContext::default())] + ); + } + + #[tokio::test] + async fn srv_discovery_builds_protocol_specific_endpoint() { + let resolver = TestResolver { + txt: String::new(), + srv: vec![DnsSrvRecord { + priority: 1, + weight: 10, + port: 11012, + target: "peer.example.com.".to_owned(), + }], + queries: Mutex::new(Vec::new()), + }; + + let endpoint = resolve_srv_endpoint( + &resolver, + "discovery.example", + &["quic".to_owned()], + SocketContext::default(), + ) + .await + .unwrap(); + + assert_eq!(endpoint.as_str(), "quic://peer.example.com.:11012"); + assert_eq!( + *resolver.queries.lock().unwrap(), + [DnsQuery::new( + "_easytier._quic.discovery.example", + SocketContext::default() + )] + ); + } + + #[test] + fn srv_discovery_deduplicates_url_and_priority() { + let endpoint: Url = "tcp://peer.example.com:11010".parse().unwrap(); + let candidates = deduplicate_srv_candidates(vec![ + (endpoint.clone(), 10), + (endpoint.clone(), 10), + (endpoint.clone(), 20), + ]); + + assert_eq!(candidates.len(), 2); + assert!(candidates.contains(&(endpoint.clone(), 10))); + assert!(candidates.contains(&(endpoint, 20))); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/manual/mod.rs b/vendor/easytier/easytier-core/src/connectivity/manual/mod.rs new file mode 100644 index 0000000..4060216 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/manual/mod.rs @@ -0,0 +1,1485 @@ +pub mod discovery; + +use std::{ + collections::BTreeSet, + future::Future, + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr}, + sync::{Arc, Mutex, Weak}, + time::Duration, +}; + +use async_trait::async_trait; +use dashmap::DashSet; +use percent_encoding::percent_decode_str; +use quanta::Instant; +use rand::seq::SliceRandom; +use serde::{Deserialize, Serialize}; +use tokio::task::JoinSet; +use tokio_util::{sync::CancellationToken, task::AbortOnDropHandle}; +use url::Url; + +use crate::tunnel::ring::RingTunnelRegistry; +use crate::{ + connectivity::{ + protocol::{ClientProtocolUpgrader, ProtocolTransport, protocol_transport}, + transport::{self, ConnectedByteStream, ConnectedTransport, UdpSessionMode}, + }, + events::{CoreEvent, CoreEventSink}, + host::dns::{DnsQuery, DnsResolver}, + peers::{PeerConnectionOrigin, peer_manager::PeerManagerCore}, + proto::common::TunnelInfo, + socket::{ + IpVersion, SocketContext, + tcp::{TcpBindOptions, TcpSocketPurpose, VirtualTcpSocketFactory}, + udp::{UdpBindOptions, VirtualUdpSocketFactory}, + }, + tunnel::{SplitTunnel, Tunnel, TunnelError}, +}; + +const MANUAL_PREFLIGHT_DEFAULT_PORT: u16 = 1000; +const MAX_MANUAL_ENDPOINT_HOPS: usize = 16; + +fn manual_default_port(url: &Url) -> u16 { + crate::connectivity::protocol::protocol_default_port(url.scheme()).unwrap_or(11010) +} + +fn is_manual_endpoint_scheme(scheme: &str) -> bool { + matches!(scheme, "http" | "https" | "txt" | "srv") +} + +/// Checks supported connector and discovery schemes without resolving the URL. +pub fn validate_manual_url(url: &Url) -> anyhow::Result<()> { + if ManualTransport::from_url(url).is_ok() || is_manual_endpoint_scheme(url.scheme()) { + Ok(()) + } else { + anyhow::bail!("unsupported core manual connector URL: {url}") + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(crate) enum ManualTransport { + Tcp(TcpSocketPurpose), + Udp(UdpSessionMode), + ByteStream, +} + +impl ManualTransport { + pub(crate) fn from_url(url: &Url) -> anyhow::Result { + match protocol_transport(url.scheme()) { + Some(ProtocolTransport::Tcp) => Ok(Self::Tcp(TcpSocketPurpose::ManualConnect)), + Some(ProtocolTransport::FakeTcp) => Ok(Self::Tcp(TcpSocketPurpose::FakeTcp)), + Some(ProtocolTransport::Udp(mode)) => Ok(Self::Udp(mode)), + None if matches!(url.scheme(), "ring" | "unix") => Ok(Self::ByteStream), + None => anyhow::bail!("unsupported core manual connector URL: {url}"), + } + } + + fn is_udp(self) -> bool { + matches!(self, Self::Udp(_)) + } + + fn supports_interface_bind(self) -> bool { + !matches!( + self, + Self::Tcp(TcpSocketPurpose::FakeTcp) | Self::ByteStream + ) + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct ManualInterfaceAddrs { + pub interface_ipv4s: Vec, + pub interface_ipv6s: Vec, + pub public_ipv6: Option, +} + +#[async_trait] +pub trait ManualConnectorHost: VirtualTcpSocketFactory + VirtualUdpSocketFactory { + fn supports_external_tunnel(&self, _scheme: &str) -> bool { + false + } + + async fn connect_external_tunnel(&self, _url: &Url) -> anyhow::Result>> { + Ok(None) + } + + async fn local_addr_for_remote( + &self, + remote_addr: SocketAddr, + context: SocketContext, + ) -> anyhow::Result; + + async fn interface_addrs(&self) -> anyhow::Result; + + async fn connect_byte_stream( + &self, + url: &Url, + ) -> anyhow::Result::Socket>> { + anyhow::bail!("host does not support external byte stream: {url}") + } +} + +#[async_trait] +pub trait ExternalTunnelConnector: Send + Sync + 'static { + fn supports_scheme(&self, scheme: &str) -> bool; + + async fn connect(&self, url: &Url) -> anyhow::Result>; +} + +#[async_trait] +pub(crate) trait ManualEndpointResolver: Send + Sync + 'static { + async fn resolve_endpoint(&self, url: &Url) -> anyhow::Result; +} + +/// Connects one endpoint without owning peer-manager retry or admission policy. +/// +/// This is intended for application protocols such as standalone RPC and the +/// configuration client. The host creates transports, while core resolves the +/// endpoint chain and upgrades the resulting socket or session into a tunnel. +pub struct ManualTunnelConnector +where + H: ManualConnectorHost, +{ + host: Arc, + dns: Arc, + endpoint_resolver: Arc, + protocol: Arc::Socket>>, + options: ManualConnectorOptions, + ring_registry: Option>, +} + +impl ManualTunnelConnector +where + H: ManualConnectorHost, +{ + pub(crate) fn new( + host: Arc, + dns: Arc, + endpoint_resolver: Arc, + protocol: Arc::Socket>>, + options: ManualConnectorOptions, + ) -> Self { + Self { + host, + dns, + endpoint_resolver, + protocol, + options, + ring_registry: None, + } + } + + pub(crate) fn with_ring_registry(mut self, ring_registry: Arc) -> Self { + self.ring_registry = Some(ring_registry); + self + } + + pub async fn connect( + &self, + requested_url: Url, + ip_version: IpVersion, + ) -> anyhow::Result> { + validate_manual_url(&requested_url)?; + let endpoint = resolve_manual_endpoint( + self.endpoint_resolver.as_ref(), + convert_idn_to_ascii(requested_url.clone())?, + ) + .await?; + if endpoint.url.scheme() == "ring" { + let registry = self + .ring_registry + .as_ref() + .ok_or_else(|| anyhow::anyhow!("ring registry is not configured"))?; + let tunnel = connect_ring_tunnel(registry, &endpoint.url)?; + return Ok(apply_resolved_endpoint_info( + tunnel, + requested_url, + endpoint.tunnel_prefixes, + )); + } + + if let Some(tunnel) = self.host.connect_external_tunnel(&endpoint.url).await? { + return Ok(apply_resolved_endpoint_info( + tunnel, + requested_url, + endpoint.tunnel_prefixes, + )); + } + + if !self.protocol.supports_scheme(endpoint.url.scheme()) { + anyhow::bail!( + "unsupported client protocol upgrader: {}", + endpoint.url.scheme() + ); + } + + let transport = ManualTransport::from_url(&endpoint.url)?; + let connected = if transport == ManualTransport::ByteStream { + ConnectedTransport::ByteStream(self.host.connect_byte_stream(&endpoint.url).await?) + } else { + let remote_addr = resolve_url_addrs( + &endpoint.url, + manual_default_port(&endpoint.url), + self.options.socket_context(transport, ip_version), + self.dns.as_ref(), + ) + .await? + .choose(&mut rand::thread_rng()) + .copied() + .ok_or(TunnelError::NoDnsRecordFound(ip_version))?; + connect_resolved( + self.host.clone(), + transport, + remote_addr, + Vec::new(), + self.options.tcp_bind.clone(), + self.options.udp_bind.clone(), + ) + .await? + }; + + let tunnel = self + .protocol + .upgrade_client(connected, endpoint.url) + .await?; + Ok(apply_resolved_endpoint_info( + tunnel, + requested_url, + endpoint.tunnel_prefixes, + )) + } +} + +struct ResolvedManualTunnel { + inner: Box, + info: TunnelInfo, +} + +impl Tunnel for ResolvedManualTunnel { + fn split(&self) -> SplitTunnel { + self.inner.split() + } + + fn info(&self) -> Option { + Some(self.info.clone()) + } +} + +#[derive(Debug)] +struct ResolvedManualEndpoint { + url: Url, + tunnel_prefixes: Vec, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum ManualConnectorStatus { + Connected, + Disconnected, + Connecting, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct ManualConnectorSnapshot { + pub url: Url, + pub status: ManualConnectorStatus, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct ManualConnectorOptions { + pub reconnect_interval: Duration, + pub connect_timeout: Duration, + pub endpoint_discovery_timeout: Duration, + pub bind_device: bool, + pub allow_interface_bind: bool, + pub tcp_bind: TcpBindOptions, + pub udp_bind: UdpBindOptions, +} + +impl Default for ManualConnectorOptions { + fn default() -> Self { + Self { + reconnect_interval: Duration::from_secs(1), + connect_timeout: Duration::from_secs(2), + endpoint_discovery_timeout: Duration::from_secs(20), + bind_device: false, + allow_interface_bind: true, + tcp_bind: TcpBindOptions::default(), + udp_bind: UdpBindOptions::direct_connect(), + } + } +} + +impl ManualConnectorOptions { + fn connect_timeout( + &self, + url: &Url, + protocol: &dyn ClientProtocolUpgrader, + ) -> Duration { + if is_manual_endpoint_scheme(url.scheme()) { + self.endpoint_discovery_timeout + } else { + protocol + .connect_timeout(url.scheme()) + .unwrap_or(self.connect_timeout) + } + } + + pub(crate) fn socket_context( + &self, + transport: ManualTransport, + ip_version: IpVersion, + ) -> SocketContext { + let context = match transport { + ManualTransport::Tcp(_) => self.tcp_bind.context.clone(), + ManualTransport::Udp(_) => self.udp_bind.context.clone(), + ManualTransport::ByteStream => SocketContext::default(), + }; + context.with_ip_version(ip_version) + } +} + +#[derive(Default)] +struct ManualConnectorState { + connectors: DashSet, + reconnecting: DashSet, + removed: DashSet, + state_lock: Mutex<()>, +} + +struct ManualConnectorData +where + H: ManualConnectorHost, +{ + state: Arc, + peer_manager: Weak, + host: Arc, + dns: Arc, + endpoint_resolver: Arc, + protocol: Arc::Socket>>, + ring_registry: Arc, + events: Arc, + options: ManualConnectorOptions, +} + +pub(crate) struct ManualConnectorManager +where + H: ManualConnectorHost, +{ + data: Arc>, + task: Mutex>, +} + +struct ManualConnectorTask { + cancel: CancellationToken, + handle: AbortOnDropHandle<()>, +} + +struct ReconnectReservation { + state: Arc, + url: Url, +} + +impl ReconnectReservation { + fn new(state: Arc, url: Url) -> Self { + Self { state, url } + } +} + +impl Drop for ReconnectReservation { + fn drop(&mut self) { + let _state_guard = self + .state + .state_lock + .lock() + .unwrap_or_else(|poisoned| poisoned.into_inner()); + if finish_reconnect_attempt(&self.state, &self.url) { + tracing::warn!(url = %self.url, "manual connector removed after reconnect"); + } + } +} + +impl ManualConnectorManager +where + H: ManualConnectorHost, +{ + #[allow(clippy::too_many_arguments)] + pub(crate) fn new( + peer_manager: Arc, + host: Arc, + dns: Arc, + endpoint_resolver: Arc, + protocol: Arc::Socket>>, + ring_registry: Arc, + options: ManualConnectorOptions, + events: Arc, + ) -> Self { + let data = Arc::new(ManualConnectorData { + state: Arc::new(ManualConnectorState::default()), + peer_manager: Arc::downgrade(&peer_manager), + host, + dns, + endpoint_resolver, + protocol, + ring_registry, + events, + options, + }); + Self { + data, + task: Mutex::new(None), + } + } + + pub fn start(&self) { + let mut task_slot = self.task.lock().unwrap(); + if task_slot + .as_ref() + .is_some_and(|task| !task.handle.is_finished()) + { + return; + } + let cancel = CancellationToken::new(); + task_slot.replace(ManualConnectorTask { + handle: AbortOnDropHandle::new(tokio::spawn(Self::run( + self.data.clone(), + cancel.clone(), + ))), + cancel, + }); + } + + pub async fn stop(&self) { + let task = self.task.lock().unwrap().take(); + if let Some(task) = task { + task.cancel.cancel(); + let _ = task.handle.await; + } + let _state_guard = self.data.state.state_lock.lock().unwrap(); + restore_interrupted_connectors(&self.data.state); + } + + pub fn add_connector(&self, url: Url) -> anyhow::Result<()> { + validate_manual_url(&url)?; + let _state_guard = self.data.state.state_lock.lock().unwrap(); + self.data.state.removed.remove(&url); + if !self.data.state.reconnecting.contains(&url) { + self.data.state.connectors.insert(url); + } + Ok(()) + } + + pub fn remove_connector(&self, url: &Url) -> bool { + let _state_guard = self.data.state.state_lock.lock().unwrap(); + if self.data.state.connectors.remove(url).is_some() { + tracing::warn!(%url, "manual connector removed"); + return true; + } + if self.data.state.reconnecting.contains(url) { + self.data.state.removed.insert(url.clone()); + return true; + } + false + } + + pub fn clear_connectors(&self) { + let _state_guard = self.data.state.state_lock.lock().unwrap(); + self.data.state.connectors.clear(); + for url in self.data.state.reconnecting.iter() { + self.data.state.removed.insert(url.key().clone()); + } + } + + pub fn list_connectors(&self) -> Vec { + let _state_guard = self.data.state.state_lock.lock().unwrap(); + let peer_manager = self.data.peer_manager.upgrade(); + let mut snapshots = self + .data + .state + .connectors + .iter() + .map(|entry| { + let url = entry.key().clone(); + let connected = peer_manager + .as_ref() + .is_some_and(|peer_manager| client_url_is_alive(peer_manager, &url)); + ManualConnectorSnapshot { + url, + status: if connected { + ManualConnectorStatus::Connected + } else { + ManualConnectorStatus::Disconnected + }, + } + }) + .collect::>(); + snapshots.extend(self.data.state.reconnecting.iter().map(|entry| { + ManualConnectorSnapshot { + url: entry.key().clone(), + status: ManualConnectorStatus::Connecting, + } + })); + snapshots + } + + async fn run(data: Arc>, cancel: CancellationToken) { + let mut interval = crate::foundation::time::interval(data.options.reconnect_interval); + let mut reconnect_tasks = JoinSet::new(); + + loop { + tokio::select! { + _ = cancel.cancelled() => break, + _ = interval.tick() => { + for url in take_dead_connectors_for_reconnect(&data) { + let task_data = data.clone(); + let reservation = + ReconnectReservation::new(data.state.clone(), url.clone()); + reconnect_tasks.spawn(async move { + let result = reconnect(task_data, url.clone()).await; + drop(reservation); + (url, result) + }); + } + } + result = reconnect_tasks.join_next(), if !reconnect_tasks.is_empty() => { + let Some(result) = result else { + continue; + }; + match result { + Ok((url, reconnect_result)) => { + tracing::warn!(?url, ?reconnect_result, "manual reconnect task done"); + } + Err(error) => { + tracing::error!(?error, "manual reconnect task failed"); + } + } + } + } + } + + reconnect_tasks.abort_all(); + while reconnect_tasks.join_next().await.is_some() {} + + let _state_guard = data.state.state_lock.lock().unwrap(); + restore_interrupted_connectors(&data.state); + } +} + +fn finish_reconnect_attempt(state: &ManualConnectorState, url: &Url) -> bool { + if state.reconnecting.remove(url).is_none() { + return false; + } + if state.removed.remove(url).is_some() { + return true; + } + state.connectors.insert(url.clone()); + false +} + +fn restore_interrupted_connectors(state: &ManualConnectorState) { + let interrupted = state + .reconnecting + .iter() + .map(|entry| entry.key().clone()) + .collect::>(); + for url in interrupted { + finish_reconnect_attempt(state, &url); + } +} + +fn take_dead_connectors_for_reconnect(data: &ManualConnectorData) -> BTreeSet +where + H: ManualConnectorHost, +{ + let _state_guard = data.state.state_lock.lock().unwrap(); + let Some(peer_manager) = data.peer_manager.upgrade() else { + tracing::warn!("peer manager is gone, skip manual reconnect"); + return BTreeSet::new(); + }; + let dead_connectors = data + .state + .connectors + .iter() + .filter_map(|entry| { + let url = entry.key(); + (!client_url_is_alive(&peer_manager, url)).then(|| url.clone()) + }) + .collect::>(); + for url in &dead_connectors { + let removed = data.state.connectors.remove(url); + debug_assert!(removed.is_some()); + let inserted = data.state.reconnecting.insert(url.clone()); + debug_assert!(inserted); + } + dead_connectors +} + +fn client_url_is_alive(peer_manager: &PeerManagerCore, url: &Url) -> bool { + peer_manager.get_peer_map().is_client_url_alive(url) + || peer_manager + .get_foreign_network_client() + .is_client_url_alive(url) +} + +async fn resolve_manual_endpoint( + resolver: &dyn ManualEndpointResolver, + requested_url: Url, +) -> anyhow::Result { + let mut url = requested_url; + let mut tunnel_prefixes = Vec::new(); + let mut visited = BTreeSet::new(); + loop { + if !visited.insert(url.clone()) { + anyhow::bail!("manual endpoint resolution cycle detected at {url}"); + } + if ManualTransport::from_url(&url).is_ok() { + return Ok(ResolvedManualEndpoint { + url, + tunnel_prefixes, + }); + } + if !is_manual_endpoint_scheme(url.scheme()) { + anyhow::bail!("unsupported resolved manual connector URL: {url}"); + } + if tunnel_prefixes.len() >= MAX_MANUAL_ENDPOINT_HOPS { + anyhow::bail!("manual endpoint resolution exceeded {MAX_MANUAL_ENDPOINT_HOPS} hops"); + } + tunnel_prefixes.push(url.scheme().to_owned()); + url = convert_idn_to_ascii(resolver.resolve_endpoint(&url).await?)?; + } +} + +fn apply_resolved_endpoint_info( + tunnel: Box, + requested_url: Url, + tunnel_prefixes: Vec, +) -> Box { + if tunnel_prefixes.is_empty() { + return tunnel; + } + let inner_info = tunnel.info().unwrap_or_default(); + let tunnel_type = format!("{}-{}", tunnel_prefixes.join("-"), inner_info.tunnel_type); + Box::new(ResolvedManualTunnel { + inner: tunnel, + info: TunnelInfo { + local_addr: inner_info.local_addr, + remote_addr: Some(requested_url.into()), + resolved_remote_addr: inner_info.resolved_remote_addr.or(inner_info.remote_addr), + tunnel_type, + }, + }) +} + +fn connect_ring_tunnel( + registry: &RingTunnelRegistry, + endpoint: &Url, +) -> anyhow::Result> { + let remote_id = endpoint + .host_str() + .ok_or_else(|| anyhow::anyhow!("ring URL has no peer id: {endpoint}"))? + .parse()?; + Ok(registry.connect(remote_id)?.into_tunnel()) +} + +async fn resolve_reconnect_ip_versions( + url: &Url, + connect_timeout: Duration, + context: SocketContext, + dns: &dyn DnsResolver, +) -> anyhow::Result> { + if matches!( + ManualTransport::from_url(url), + Ok(ManualTransport::ByteStream) + ) { + return Ok(vec![IpVersion::Both]); + } + if matches!(url.scheme(), "txt" | "srv") { + return Ok(vec![IpVersion::Both]); + } + + let addrs = with_timeout_budget( + "resolve", + Instant::now(), + connect_timeout, + resolve_url_addrs( + url, + MANUAL_PREFLIGHT_DEFAULT_PORT, + context.with_ip_version(IpVersion::Both), + dns, + ), + ) + .await?; + tracing::info!(?addrs, %url, "manual preflight resolve done"); + + let mut ip_versions = Vec::new(); + if addrs.iter().any(SocketAddr::is_ipv4) { + ip_versions.push(IpVersion::V4); + } + if addrs.iter().any(SocketAddr::is_ipv6) { + ip_versions.push(IpVersion::V6); + } + Ok(ip_versions) +} + +async fn reconnect(data: Arc>, url: Url) -> anyhow::Result<()> +where + H: ManualConnectorHost, +{ + validate_manual_url(&url)?; + let connect_timeout = data.options.connect_timeout(&url, data.protocol.as_ref()); + tracing::info!(%url, "manual reconnect start"); + let normalized_url = match convert_idn_to_ascii(url.clone()) { + Ok(url) => url, + Err(error) => { + emit_connect_error(&data, &url, IpVersion::Both, &error); + return Err(error); + } + }; + let ip_versions = match if data.host.supports_external_tunnel(normalized_url.scheme()) { + Ok(vec![IpVersion::Both]) + } else { + resolve_reconnect_ip_versions( + &normalized_url, + connect_timeout, + ManualTransport::from_url(&normalized_url) + .ok() + .map(|transport| data.options.socket_context(transport, IpVersion::Both)) + .unwrap_or_default(), + data.dns.as_ref(), + ) + .await + } { + Ok(ip_versions) => ip_versions, + Err(error) => { + emit_connect_error(&data, &url, IpVersion::Both, &error); + return Err(error); + } + }; + + let mut last_error = anyhow::anyhow!("cannot get IP from URL"); + for ip_version in ip_versions { + let started_at = Instant::now(); + match reconnect_with_ip_version( + data.clone(), + url.clone(), + ip_version, + started_at, + connect_timeout, + ) + .await + { + Ok(()) => return Ok(()), + Err(error) => { + emit_connect_error(&data, &url, ip_version, &error); + last_error = error; + } + } + } + Err(last_error) +} + +async fn reconnect_with_ip_version( + data: Arc>, + requested_url: Url, + ip_version: IpVersion, + started_at: Instant, + connect_timeout: Duration, +) -> anyhow::Result<()> +where + H: ManualConnectorHost, +{ + let endpoint = with_timeout_budget( + "discover", + started_at, + connect_timeout, + resolve_manual_endpoint( + data.endpoint_resolver.as_ref(), + convert_idn_to_ascii(requested_url.clone())?, + ), + ) + .await?; + let uses_external_tunnel = data.host.supports_external_tunnel(endpoint.url.scheme()); + if endpoint.url.scheme() != "ring" + && !uses_external_tunnel + && !data.protocol.supports_scheme(endpoint.url.scheme()) + { + anyhow::bail!( + "unsupported client protocol upgrader: {}", + endpoint.url.scheme() + ); + } + let transport = (endpoint.url.scheme() != "ring" && !uses_external_tunnel) + .then(|| ManualTransport::from_url(&endpoint.url)) + .transpose()?; + let resolved = match transport { + None | Some(ManualTransport::ByteStream) => None, + Some(transport) => Some( + with_timeout_budget("resolve", started_at, connect_timeout, async { + let peer_manager = data.peer_manager.upgrade().ok_or_else(|| { + anyhow::anyhow!("peer manager is gone, cannot resolve connector") + })?; + let remote_addr = resolve_remote_addr( + peer_manager.as_ref(), + data.host.as_ref(), + data.dns.as_ref(), + &endpoint.url, + manual_default_port(&endpoint.url), + data.options.socket_context(transport, ip_version), + ) + .await?; + let bind_addrs = if data.options.bind_device + && data.options.allow_interface_bind + && transport.supports_interface_bind() + { + collect_bind_addrs( + peer_manager.as_ref(), + data.host.as_ref(), + transport.is_udp(), + remote_addr, + ) + .await? + } else { + Vec::new() + }; + Ok((remote_addr, bind_addrs)) + }) + .await?, + ), + }; + data.events.emit(CoreEvent::ManualConnecting { + url: requested_url.clone(), + }); + + let tunnel = with_timeout_budget("connect", started_at, connect_timeout, async { + if endpoint.url.scheme() == "ring" { + return connect_ring_tunnel(&data.ring_registry, &endpoint.url); + } + if uses_external_tunnel { + return data + .host + .connect_external_tunnel(&endpoint.url) + .await? + .ok_or_else(|| { + anyhow::anyhow!("host did not provide external tunnel for {}", endpoint.url) + }); + } + let transport = transport.expect("non-Ring endpoint should have a transport"); + let connected = match resolved { + Some((remote_addr, bind_addrs)) => { + connect_resolved( + data.host.clone(), + transport, + remote_addr, + bind_addrs, + data.options.tcp_bind.clone(), + data.options.udp_bind.clone(), + ) + .await? + } + None => { + ConnectedTransport::ByteStream(data.host.connect_byte_stream(&endpoint.url).await?) + } + }; + data.protocol.upgrade_client(connected, endpoint.url).await + }) + .await?; + let tunnel = + apply_resolved_endpoint_info(tunnel, requested_url.clone(), endpoint.tunnel_prefixes); + let peer_manager = data + .peer_manager + .upgrade() + .ok_or_else(|| anyhow::anyhow!("peer manager is gone, cannot reconnect"))?; + let (peer_id, conn_id) = + with_timeout_budget("handshake", started_at, connect_timeout, async move { + peer_manager + .add_client_tunnel_with_peer_id_hint(tunnel, PeerConnectionOrigin::Manual, None) + .await + .map_err(anyhow::Error::from) + }) + .await?; + tracing::info!(peer_id, %conn_id, %requested_url, "manual reconnect succeeded"); + Ok(()) +} + +pub(crate) async fn connect_resolved( + host: Arc, + transport: ManualTransport, + remote_addr: SocketAddr, + bind_addrs: Vec, + tcp_bind: TcpBindOptions, + udp_bind: UdpBindOptions, +) -> anyhow::Result::Socket>> +where + H: ManualConnectorHost, +{ + match transport { + ManualTransport::Tcp(purpose) => { + transport::connect_tcp(host, remote_addr, bind_addrs, tcp_bind, purpose) + .await + .map(ConnectedTransport::Tcp) + } + ManualTransport::Udp(mode) => { + transport::connect_udp(host, remote_addr, bind_addrs, udp_bind, mode) + .await + .map(ConnectedTransport::Udp) + } + ManualTransport::ByteStream => { + anyhow::bail!("external byte streams do not use an IP transport address") + } + } +} + +pub(crate) async fn resolve_remote_addr( + peer_manager: &PeerManagerCore, + host: &H, + dns: &dyn DnsResolver, + url: &Url, + default_port: u16, + context: SocketContext, +) -> anyhow::Result +where + H: ManualConnectorHost, +{ + let ip_version = context.ip_version; + let addrs = resolve_url_addrs(url, default_port, context.clone(), dns).await?; + let mut usable = Vec::new(); + let mut rejected_reason = None; + for addr in addrs { + let SocketAddr::V6(v6_addr) = addr else { + usable.push(addr); + continue; + }; + if peer_manager.is_easytier_managed_ipv6(v6_addr.ip()).await { + rejected_reason = Some(format!( + "{url} resolves to EasyTier-managed IPv6 {}", + v6_addr.ip() + )); + continue; + } + match host.local_addr_for_remote(addr, context.clone()).await { + Ok(SocketAddr::V6(local_addr)) + if peer_manager.is_easytier_managed_ipv6(local_addr.ip()).await => + { + rejected_reason = Some(format!( + "{url} would use EasyTier-managed IPv6 {} as local source for {v6_addr}", + local_addr.ip() + )); + } + Ok(_) => usable.push(addr), + Err(error) => return Err(error), + } + } + + if usable.is_empty() { + if let Some(reason) = rejected_reason { + anyhow::bail!("{reason}, refusing overlay-backed underlay connection"); + } + return Err(TunnelError::NoDnsRecordFound(ip_version).into()); + } + usable + .choose(&mut rand::thread_rng()) + .copied() + .ok_or_else(|| TunnelError::NoDnsRecordFound(ip_version).into()) +} + +pub(crate) async fn collect_bind_addrs( + peer_manager: &PeerManagerCore, + host: &H, + is_udp: bool, + remote_addr: SocketAddr, +) -> anyhow::Result> +where + H: ManualConnectorHost, +{ + if is_udp && remote_addr.is_ipv6() { + return Ok(Vec::new()); + } + + let addrs = host.interface_addrs().await?; + if remote_addr.is_ipv4() { + return Ok(addrs + .interface_ipv4s + .into_iter() + .map(|addr| SocketAddr::new(IpAddr::V4(addr), 0)) + .collect()); + } + + let mut ipv6s = addrs.interface_ipv6s; + ipv6s.extend(addrs.public_ipv6); + let mut ret = Vec::new(); + for addr in ipv6s { + if !peer_manager.is_easytier_managed_ipv6(&addr).await { + ret.push(SocketAddr::new(IpAddr::V6(addr), 0)); + } + } + Ok(ret) +} + +pub(crate) async fn resolve_url_addrs( + url: &Url, + default_port: u16, + context: SocketContext, + dns: &dyn DnsResolver, +) -> anyhow::Result> { + let ip_version = context.ip_version; + let host = url + .host() + .ok_or_else(|| anyhow::anyhow!("URL has no host: {url}"))?; + let port = url.port().unwrap_or(default_port); + let addrs = match host { + url::Host::Ipv4(addr) => vec![SocketAddr::new(IpAddr::V4(addr), port)], + url::Host::Ipv6(addr) => vec![SocketAddr::new(IpAddr::V6(addr), port)], + url::Host::Domain(host) => dns + .resolve(DnsQuery::new(host, context)) + .await? + .into_iter() + .map(|addr| SocketAddr::new(addr, port)) + .collect(), + }; + let addrs = addrs + .into_iter() + .filter(|addr| match ip_version { + IpVersion::V4 => addr.is_ipv4(), + IpVersion::V6 => addr.is_ipv6(), + IpVersion::Both => true, + }) + .collect::>(); + if addrs.is_empty() { + return Err(TunnelError::NoDnsRecordFound(ip_version).into()); + } + Ok(addrs) +} + +pub(crate) fn convert_idn_to_ascii(mut url: Url) -> anyhow::Result { + if url.is_special() { + return Ok(url); + } + if let Some(domain) = url.domain() { + let domain = percent_decode_str(domain).decode_utf8()?; + let domain = idna::domain_to_ascii(&domain)?; + url.set_host(Some(&domain))?; + } + Ok(url) +} + +fn emit_connect_error( + data: &ManualConnectorData, + url: &Url, + ip_version: IpVersion, + error: &anyhow::Error, +) where + H: ManualConnectorHost, +{ + data.events.emit(CoreEvent::ManualConnectError { + url: url.clone(), + ip_version, + error: format!("{error:#?}"), + }); +} + +async fn with_timeout_budget( + stage: &'static str, + started_at: Instant, + total_timeout: Duration, + future: F, +) -> anyhow::Result +where + F: Future>, +{ + let remaining = total_timeout + .checked_sub(started_at.elapsed()) + .filter(|remaining| !remaining.is_zero()) + .ok_or_else(|| anyhow::anyhow!("{stage} timeout after {:?}", started_at.elapsed()))?; + crate::foundation::time::timeout(remaining, future) + .await + .map_err(|_| anyhow::anyhow!("{stage} timeout after {remaining:?}"))? +} + +#[cfg(test)] +mod tests { + use std::sync::Mutex; + + use crate::socket::udp::UdpSessionProtocol; + + use super::*; + + fn reserve_pending_connector( + state: &Arc, + url: &Url, + ) -> ReconnectReservation { + let _state_guard = state.state_lock.lock().unwrap(); + assert!(state.connectors.remove(url).is_some()); + assert!(state.reconnecting.insert(url.clone())); + ReconnectReservation::new(state.clone(), url.clone()) + } + + fn assert_connector_is_pending(state: &ManualConnectorState, url: &Url) { + assert!(state.connectors.contains(url)); + assert!(!state.reconnecting.contains(url)); + assert!(!state.removed.contains(url)); + } + + #[test] + fn idn_normalization_covers_connector_schemes_and_url_round_trips() { + let cases = [ + ("example.com", "example.com"), + ("test.org:8080/path", "test.org:8080/path"), + ("räksmörgås.nu", "xn--rksmrgs-5wao1o.nu"), + ("中文.测试", "xn--fiq228c.xn--0zwm56d"), + ("räksmörgås.nu:8080", "xn--rksmrgs-5wao1o.nu:8080"), + ("例子.测试/path", "xn--fsqu00a.xn--0zwm56d/path"), + ("中文.测试:9000/api", "xn--fiq228c.xn--0zwm56d:9000/api"), + ("räksmörgås.nu:8080/path", "xn--rksmrgs-5wao1o.nu:8080/path"), + ( + "中文.测试:8000/用户/管理", + "xn--fiq228c.xn--0zwm56d:8000/%E7%94%A8%E6%88%B7/%E7%AE%A1%E7%90%86", + ), + ("[2001:db8::1]:8080", "[2001:db8::1]:8080"), + ("[2001:db8::1]/path", "[2001:db8::1]/path"), + ( + "[2001:db8::1]/路径/资源", + "[2001:db8::1]/%E8%B7%AF%E5%BE%84/%E8%B5%84%E6%BA%90", + ), + ]; + let schemes = ["tcp", "udp", "ws", "wss", "wg", "quic", "http", "https"]; + + for (host_part, expected_host_part) in cases { + for scheme in schemes { + for round_trip in [false, true] { + let input = Url::parse(&format!("{scheme}://{host_part}")).unwrap(); + let input = if round_trip { + input.to_string().parse().unwrap() + } else { + input + }; + let actual = convert_idn_to_ascii(input.clone()).unwrap().to_string(); + let mut expected = format!("{scheme}://{expected_host_part}"); + if input.is_special() + && actual.ends_with('/') + && !expected_host_part.ends_with('/') + { + expected.push('/'); + } + assert_eq!(actual, expected, "scheme={scheme}, input={host_part}"); + } + } + } + } + + struct StaticDnsResolver { + ips: Vec, + queries: Mutex>, + } + + struct ChainedEndpointResolver; + + struct CyclingEndpointResolver; + + #[async_trait] + impl ManualEndpointResolver for ChainedEndpointResolver { + async fn resolve_endpoint(&self, url: &Url) -> anyhow::Result { + match url.scheme() { + "http" => Ok("txt://discovery.example".parse().unwrap()), + "txt" => Ok("tcp://peer.example:12000".parse().unwrap()), + scheme => anyhow::bail!("unexpected endpoint scheme: {scheme}"), + } + } + } + + #[async_trait] + impl ManualEndpointResolver for CyclingEndpointResolver { + async fn resolve_endpoint(&self, url: &Url) -> anyhow::Result { + Ok(url.clone()) + } + } + + #[async_trait] + impl DnsResolver for StaticDnsResolver { + async fn resolve(&self, query: DnsQuery) -> anyhow::Result> { + self.queries.lock().unwrap().push(query); + Ok(self.ips.clone()) + } + } + + #[test] + fn manual_transport_maps_ip_protocols_to_their_socket_boundary() { + let cases = [ + ( + "tcp://127.0.0.1:1", + ManualTransport::Tcp(TcpSocketPurpose::ManualConnect), + ), + ( + "ws://127.0.0.1:1", + ManualTransport::Tcp(TcpSocketPurpose::ManualConnect), + ), + ( + "wss://127.0.0.1:1", + ManualTransport::Tcp(TcpSocketPurpose::ManualConnect), + ), + ( + "faketcp://127.0.0.1:1", + ManualTransport::Tcp(TcpSocketPurpose::FakeTcp), + ), + ( + "udp://127.0.0.1:1", + ManualTransport::Udp(UdpSessionMode::EasyTierMux), + ), + ( + "wg://127.0.0.1:1", + ManualTransport::Udp(UdpSessionMode::Classified(UdpSessionProtocol::WireGuard)), + ), + ( + "quic://127.0.0.1:1", + ManualTransport::Udp(UdpSessionMode::Classified(UdpSessionProtocol::Quic)), + ), + ("ring://local", ManualTransport::ByteStream), + ("unix:///tmp/easytier.sock", ManualTransport::ByteStream), + ]; + + for (url, expected) in cases { + assert_eq!( + ManualTransport::from_url(&url.parse().unwrap()).unwrap(), + expected + ); + } + assert!(ManualTransport::from_url(&"http://127.0.0.1:1".parse().unwrap()).is_err()); + assert!(validate_manual_url(&"http://127.0.0.1:1".parse().unwrap()).is_ok()); + } + + #[tokio::test] + async fn manual_endpoint_resolution_preserves_the_discovery_chain() { + let endpoint = resolve_manual_endpoint( + &ChainedEndpointResolver, + "http://discovery.example".parse().unwrap(), + ) + .await + .unwrap(); + + assert_eq!(endpoint.url.as_str(), "tcp://peer.example:12000"); + assert_eq!(endpoint.tunnel_prefixes, ["http", "txt"]); + } + + #[tokio::test] + async fn manual_endpoint_resolution_rejects_cycles() { + let error = resolve_manual_endpoint( + &CyclingEndpointResolver, + "http://discovery.example".parse().unwrap(), + ) + .await + .unwrap_err(); + + assert!(error.to_string().contains("cycle detected")); + } + + #[tokio::test] + async fn txt_discovery_does_not_require_address_records() { + let resolver = StaticDnsResolver { + ips: Vec::new(), + queries: Mutex::new(Vec::new()), + }; + let versions = resolve_reconnect_ip_versions( + &"txt://discovery.example".parse().unwrap(), + Duration::from_secs(1), + SocketContext::default(), + &resolver, + ) + .await + .unwrap(); + + assert_eq!(versions, [IpVersion::Both]); + assert!(resolver.queries.lock().unwrap().is_empty()); + } + + #[tokio::test] + async fn external_byte_stream_does_not_require_address_records() { + let resolver = StaticDnsResolver { + ips: Vec::new(), + queries: Mutex::new(Vec::new()), + }; + let versions = resolve_reconnect_ip_versions( + &"ring://local".parse().unwrap(), + Duration::from_secs(1), + SocketContext::default(), + &resolver, + ) + .await + .unwrap(); + + assert_eq!(versions, [IpVersion::Both]); + assert!(resolver.queries.lock().unwrap().is_empty()); + } + + #[test] + fn external_protocol_and_discovery_timeouts_are_explicit() { + struct Protocol; + + #[async_trait] + impl ClientProtocolUpgrader<()> for Protocol { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "external" + } + + fn connect_timeout(&self, scheme: &str) -> Option { + (scheme == "external").then_some(Duration::from_secs(20)) + } + + async fn upgrade_client( + &self, + _connected: ConnectedTransport<()>, + _requested_url: Url, + ) -> anyhow::Result> { + unreachable!() + } + } + + let options = ManualConnectorOptions::default(); + assert_eq!( + options.connect_timeout(&"external://127.0.0.1".parse().unwrap(), &Protocol), + Duration::from_secs(20) + ); + assert_eq!( + options.connect_timeout(&"txt://example.com".parse().unwrap(), &Protocol), + Duration::from_secs(20) + ); + assert_eq!( + options.connect_timeout(&"tcp://127.0.0.1".parse().unwrap(), &Protocol), + Duration::from_secs(2) + ); + } + + #[tokio::test] + async fn resolver_receives_instance_socket_context_and_filters_family() { + let resolver = StaticDnsResolver { + ips: vec![IpAddr::from([127, 0, 0, 1]), Ipv6Addr::LOCALHOST.into()], + queries: Mutex::new(Vec::new()), + }; + let url: Url = "udp://example.com:12000".parse().unwrap(); + + let addrs = resolve_url_addrs( + &url, + crate::connectivity::protocol::protocol_default_port("tcp").unwrap(), + SocketContext::default() + .with_ip_version(IpVersion::V6) + .with_socket_mark(Some(7)), + &resolver, + ) + .await + .unwrap(); + + assert_eq!(addrs, vec!["[::1]:12000".parse().unwrap()]); + assert_eq!( + resolver.queries.lock().unwrap().as_slice(), + &[DnsQuery::new( + "example.com", + SocketContext { + ip_version: IpVersion::V6, + socket_mark: Some(7), + netns: None, + } + )] + ); + } + + #[tokio::test] + async fn timeout_budget_reports_the_active_stage() { + let error = + with_timeout_budget("connect", Instant::now(), Duration::from_millis(1), async { + crate::foundation::time::sleep(Duration::from_millis(20)).await; + Ok::<(), anyhow::Error>(()) + }) + .await + .unwrap_err(); + + assert!(error.to_string().contains("connect timeout after")); + } + + #[test] + fn interrupted_reconnects_return_to_the_pending_set_unless_removed() { + let state = ManualConnectorState::default(); + let retained: Url = "tcp://127.0.0.1:11010".parse().unwrap(); + let deleted: Url = "udp://127.0.0.1:11010".parse().unwrap(); + state.reconnecting.insert(retained.clone()); + state.reconnecting.insert(deleted.clone()); + state.removed.insert(deleted.clone()); + + restore_interrupted_connectors(&state); + restore_interrupted_connectors(&state); + + assert!(state.connectors.contains(&retained)); + assert!(!state.connectors.contains(&deleted)); + assert!(state.reconnecting.is_empty()); + assert!(state.removed.is_empty()); + } + + #[test] + fn reconnect_reservation_restores_connector_on_normal_drop() { + let state = Arc::new(ManualConnectorState::default()); + let url: Url = "tcp://127.0.0.1:11010".parse().unwrap(); + state.connectors.insert(url.clone()); + + let reservation = reserve_pending_connector(&state, &url); + assert!(!state.connectors.contains(&url)); + assert!(state.reconnecting.contains(&url)); + + drop(reservation); + + assert_connector_is_pending(&state, &url); + } + + #[tokio::test] + async fn reconnect_reservation_restores_connector_after_attempt_panic() { + let state = Arc::new(ManualConnectorState::default()); + let url: Url = "tcp://127.0.0.1:11010".parse().unwrap(); + state.connectors.insert(url.clone()); + let reservation = reserve_pending_connector(&state, &url); + + let task = tokio::spawn(async move { + let _reservation = reservation; + panic!("reconnect attempt panic"); + }); + assert!(task.await.unwrap_err().is_panic()); + assert_connector_is_pending(&state, &url); + + let retry_reservation = reserve_pending_connector(&state, &url); + drop(retry_reservation); + assert_connector_is_pending(&state, &url); + } + + #[tokio::test] + async fn reconnect_reservation_restores_connector_after_attempt_abort() { + let state = Arc::new(ManualConnectorState::default()); + let url: Url = "tcp://127.0.0.1:11010".parse().unwrap(); + state.connectors.insert(url.clone()); + let reservation = reserve_pending_connector(&state, &url); + let (started_tx, started_rx) = tokio::sync::oneshot::channel(); + + let task = tokio::spawn(async move { + let _reservation = reservation; + let _ = started_tx.send(()); + std::future::pending::<()>().await; + }); + started_rx.await.unwrap(); + task.abort(); + + assert!(task.await.unwrap_err().is_cancelled()); + assert_connector_is_pending(&state, &url); + + let retry_reservation = reserve_pending_connector(&state, &url); + drop(retry_reservation); + assert_connector_is_pending(&state, &url); + } + + #[test] + fn reconnect_reservation_does_not_restore_removed_connector() { + let state = Arc::new(ManualConnectorState::default()); + let url: Url = "tcp://127.0.0.1:11010".parse().unwrap(); + state.connectors.insert(url.clone()); + let reservation = reserve_pending_connector(&state, &url); + state.removed.insert(url.clone()); + + drop(reservation); + + assert!(!state.connectors.contains(&url)); + assert!(!state.reconnecting.contains(&url)); + assert!(!state.removed.contains(&url)); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/mod.rs b/vendor/easytier/easytier-core/src/connectivity/mod.rs new file mode 100644 index 0000000..4fe9b27 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/mod.rs @@ -0,0 +1,37 @@ +//! Portable connection orchestration. + +use std::fmt::Debug; + +use url::Url; + +pub mod composite; +pub mod direct; +pub mod hole_punch; +// Kept public: the host-driven adapter chain is WASI-only production code +// (cfg(target_os = "wasi")), so crate-private visibility would surface +// dead-code warnings on host builds for code that is live on WASI. +pub mod connector_host; +pub mod manual; +pub mod protocol; +pub mod stun; +pub mod transport; + +/// Supplies the URLs of the instance's currently running listeners. +/// +/// The listener layer's running-listener registry implements this seam. +/// Connectors use it to avoid dialing addresses that would hairpin back +/// into one of their own listeners, so connectivity depends on this narrow +/// query rather than on the listener module's concrete registry type. +pub trait LocalListenerUrls: Debug + Send + Sync + 'static { + fn local_listener_urls(&self) -> Vec; +} + +/// Empty [`LocalListenerUrls`] for connectors that track no listeners. +#[derive(Debug, Default)] +pub struct NoLocalListeners; + +impl LocalListenerUrls for NoLocalListeners { + fn local_listener_urls(&self) -> Vec { + Vec::new() + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/protocol/mod.rs b/vendor/easytier/easytier-core/src/connectivity/protocol/mod.rs new file mode 100644 index 0000000..f436e54 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/protocol/mod.rs @@ -0,0 +1,811 @@ +use std::{marker::PhantomData, num::NonZeroUsize, sync::Arc, time::Duration}; + +use async_trait::async_trait; +use tokio::sync::{OwnedSemaphorePermit, Semaphore}; +use url::Url; + +use crate::{ + socket::{tcp::VirtualTcpSocket, udp::UdpSession}, + tunnel::Tunnel, +}; + +use super::transport::{ConnectedTransport, UdpSessionMode}; + +pub mod raw; + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(crate) enum ProtocolTransport { + Tcp, + FakeTcp, + Udp(UdpSessionMode), +} + +pub(crate) const fn protocol_transport(scheme: &str) -> Option { + match scheme.as_bytes() { + b"tcp" | b"ws" | b"wss" => Some(ProtocolTransport::Tcp), + b"faketcp" => Some(ProtocolTransport::FakeTcp), + b"udp" => Some(ProtocolTransport::Udp(UdpSessionMode::EasyTierMux)), + b"wg" => Some(ProtocolTransport::Udp(UdpSessionMode::Classified( + crate::socket::udp::UdpSessionProtocol::WireGuard, + ))), + b"quic" => Some(ProtocolTransport::Udp(UdpSessionMode::Classified( + crate::socket::udp::UdpSessionProtocol::Quic, + ))), + _ => None, + } +} + +pub(crate) const fn protocol_uses_udp(scheme: &str) -> bool { + matches!(protocol_transport(scheme), Some(ProtocolTransport::Udp(_))) +} + +/// Returns the listener-port offset used when expanding a single base port +/// into EasyTier's protocol-specific listener set. +pub const fn protocol_port_offset(scheme: &str) -> Option { + match scheme.as_bytes() { + b"tcp" | b"udp" => Some(0), + b"wg" | b"ws" => Some(1), + b"quic" | b"wss" => Some(2), + b"faketcp" => Some(3), + _ => None, + } +} + +/// Returns the default port for a concrete EasyTier IP protocol. +pub const fn protocol_default_port(scheme: &str) -> Option { + match scheme.as_bytes() { + b"ws" => Some(80), + b"wss" => Some(443), + _ => match protocol_port_offset(scheme) { + Some(offset) => Some(11010 + offset), + None => None, + }, + } +} + +#[async_trait] +pub trait ClientProtocolUpgrader: Send + Sync + 'static { + fn supports_scheme(&self, scheme: &str) -> bool; + + fn connect_timeout(&self, _scheme: &str) -> Option { + None + } + + async fn upgrade_client( + &self, + connected: ConnectedTransport, + requested_url: Url, + ) -> anyhow::Result>; +} + +#[async_trait] +pub trait ServerTunnelAcceptor: Send + 'static { + async fn accept(&mut self) -> anyhow::Result>; +} + +pub enum ServerProtocolUpgrade { + Tunnel(Box), + Acceptor(Box), +} + +pub struct ServerProtocolAdmission { + active_session: OwnedSemaphorePermit, + handshake_slots: Arc, +} + +impl ServerProtocolAdmission { + pub fn into_parts(self) -> (OwnedSemaphorePermit, Arc) { + (self.active_session, self.handshake_slots) + } +} + +pub struct ServerProtocolAdmissionController { + active_sessions: Arc, + handshake_slots: Arc, +} + +impl ServerProtocolAdmissionController { + pub fn new(max_active_sessions: usize, max_in_flight_handshakes: usize) -> Self { + Self { + active_sessions: Arc::new(Semaphore::new(max_active_sessions)), + handshake_slots: Arc::new(Semaphore::new(max_in_flight_handshakes)), + } + } + + pub fn try_admit(&self) -> Option { + Some(ServerProtocolAdmission { + active_session: self.active_sessions.clone().try_acquire_owned().ok()?, + handshake_slots: self.handshake_slots.clone(), + }) + } + + pub fn quic() -> Self { + Self::new(1024, 128) + } +} + +#[async_trait] +pub trait ServerProtocolUpgrader: Send + Sync + 'static { + fn supports_scheme(&self, scheme: &str) -> bool; + + fn max_pending_tcp_upgrades(&self, _scheme: &str) -> Option { + None + } + + async fn upgrade_tcp( + &self, + socket: TcpSocket, + local_url: Url, + ) -> anyhow::Result; + + async fn upgrade_udp( + &self, + session: UdpSession, + local_url: Url, + admission: Option, + ) -> anyhow::Result; + + async fn upgrade_byte_stream( + &self, + socket: TcpSocket, + local_url: Url, + remote_url: Option, + ) -> anyhow::Result; +} + +#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)] +pub struct CoreClientProtocolConfig { + pub unix: bool, + pub faketcp: bool, +} + +/// Owns portable client protocol dispatch and delegates only protocol engines +/// that are not yet available in core. +pub struct CoreClientProtocolUpgrader { + config: CoreClientProtocolConfig, + external: Option>>, +} + +impl CoreClientProtocolUpgrader { + pub fn new(config: CoreClientProtocolConfig) -> Self { + Self { + config, + external: None, + } + } + + pub fn with_external( + config: CoreClientProtocolConfig, + external: Arc>, + ) -> Self { + Self { + config, + external: Some(external), + } + } +} + +#[async_trait] +impl ClientProtocolUpgrader for CoreClientProtocolUpgrader +where + TcpSocket: VirtualTcpSocket, +{ + fn supports_scheme(&self, scheme: &str) -> bool { + match scheme { + "tcp" | "udp" | "ring" => true, + "unix" => self.config.unix, + "faketcp" => self.config.faketcp, + _ => self + .external + .as_ref() + .is_some_and(|external| external.supports_scheme(scheme)), + } + } + + fn connect_timeout(&self, scheme: &str) -> Option { + self.external + .as_ref() + .filter(|external| external.supports_scheme(scheme)) + .and_then(|external| external.connect_timeout(scheme)) + } + + async fn upgrade_client( + &self, + connected: ConnectedTransport, + requested_url: Url, + ) -> anyhow::Result> { + match requested_url.scheme() { + "tcp" => match connected { + ConnectedTransport::Tcp(socket) => { + Ok(raw::upgrade_connected_tcp(socket, requested_url)?) + } + ConnectedTransport::Udp(_) | ConnectedTransport::ByteStream(_) => { + anyhow::bail!("TCP protocol requires a TCP transport") + } + }, + "udp" => match connected { + ConnectedTransport::Udp(session) => { + Ok(raw::upgrade_connected_udp(session, requested_url)?) + } + ConnectedTransport::Tcp(_) | ConnectedTransport::ByteStream(_) => { + anyhow::bail!("UDP protocol requires a UDP session") + } + }, + "ring" => upgrade_byte_stream(connected), + "unix" if self.config.unix => upgrade_byte_stream(connected), + "faketcp" if self.config.faketcp => match connected { + ConnectedTransport::Tcp(socket) => { + Ok(raw::upgrade_connected_tcp(socket, requested_url)?) + } + ConnectedTransport::Udp(_) | ConnectedTransport::ByteStream(_) => { + anyhow::bail!("FakeTCP protocol requires a TCP transport") + } + }, + "unix" | "faketcp" => anyhow::bail!( + "unsupported client protocol upgrader: {}", + requested_url.scheme() + ), + scheme => { + let Some(external) = &self.external else { + anyhow::bail!("unsupported client protocol upgrader: {scheme}"); + }; + if !external.supports_scheme(scheme) { + anyhow::bail!("unsupported client protocol upgrader: {scheme}"); + } + external.upgrade_client(connected, requested_url).await + } + } + } +} + +fn upgrade_byte_stream( + connected: ConnectedTransport, +) -> anyhow::Result> +where + TcpSocket: VirtualTcpSocket, +{ + match connected { + ConnectedTransport::ByteStream(stream) => Ok(raw::upgrade_connected_byte_stream(stream)?), + ConnectedTransport::Tcp(_) | ConnectedTransport::Udp(_) => { + anyhow::bail!("external protocol requires a host-created byte stream") + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)] +pub struct CoreServerProtocolConfig { + pub unix: bool, + pub faketcp: bool, +} + +/// Owns portable server protocol dispatch and delegates only protocol engines +/// that are not available in core. +pub struct CoreServerProtocolUpgrader { + config: CoreServerProtocolConfig, + external: Option>>, + tcp_socket: PhantomData TcpSocket>, +} + +impl CoreServerProtocolUpgrader { + pub fn new(config: CoreServerProtocolConfig) -> Self { + Self { + config, + external: None, + tcp_socket: PhantomData, + } + } + + pub fn with_external( + config: CoreServerProtocolConfig, + external: Arc>, + ) -> Self { + Self { + config, + external: Some(external), + tcp_socket: PhantomData, + } + } + + fn supports_core_scheme(&self, scheme: &str) -> Option { + match scheme { + "tcp" | "udp" | "ring" => Some(true), + "unix" => Some(self.config.unix), + "faketcp" => Some(self.config.faketcp), + _ => None, + } + } + + fn external(&self, scheme: &str) -> anyhow::Result<&dyn ServerProtocolUpgrader> { + let external = self + .external + .as_deref() + .ok_or_else(|| anyhow::anyhow!("unsupported server protocol upgrader: {scheme}"))?; + if !external.supports_scheme(scheme) { + anyhow::bail!("unsupported server protocol upgrader: {scheme}"); + } + Ok(external) + } +} + +#[async_trait] +impl ServerProtocolUpgrader for CoreServerProtocolUpgrader +where + TcpSocket: VirtualTcpSocket, +{ + fn supports_scheme(&self, scheme: &str) -> bool { + self.supports_core_scheme(scheme).unwrap_or_else(|| { + self.external + .as_ref() + .is_some_and(|external| external.supports_scheme(scheme)) + }) + } + + fn max_pending_tcp_upgrades(&self, scheme: &str) -> Option { + self.external + .as_ref() + .filter(|external| external.supports_scheme(scheme)) + .and_then(|external| external.max_pending_tcp_upgrades(scheme)) + } + + async fn upgrade_tcp( + &self, + socket: TcpSocket, + local_url: Url, + ) -> anyhow::Result { + match local_url.scheme() { + "tcp" | "faketcp" => Ok(ServerProtocolUpgrade::Tunnel( + upgrade_accepted_tcp(socket, local_url, self.config).await?, + )), + "udp" | "wg" | "quic" => { + anyhow::bail!("{} protocol requires a UDP session", local_url.scheme()) + } + "ring" | "unix" => { + anyhow::bail!("{} protocol requires a byte stream", local_url.scheme()) + } + scheme => self.external(scheme)?.upgrade_tcp(socket, local_url).await, + } + } + + async fn upgrade_udp( + &self, + session: UdpSession, + local_url: Url, + admission: Option, + ) -> anyhow::Result { + match local_url.scheme() { + "udp" => Ok(ServerProtocolUpgrade::Tunnel(upgrade_accepted_udp( + session, &local_url, + )?)), + "tcp" | "faketcp" => { + anyhow::bail!("{} protocol requires a TCP transport", local_url.scheme()) + } + "ring" | "unix" => { + anyhow::bail!("{} protocol requires a byte stream", local_url.scheme()) + } + scheme => { + self.external(scheme)? + .upgrade_udp(session, local_url, admission) + .await + } + } + } + + async fn upgrade_byte_stream( + &self, + socket: TcpSocket, + local_url: Url, + remote_url: Option, + ) -> anyhow::Result { + match local_url.scheme() { + "ring" => Ok(ServerProtocolUpgrade::Tunnel( + raw::upgrade_accepted_byte_stream(socket, local_url, remote_url)?, + )), + "unix" if self.config.unix => Ok(ServerProtocolUpgrade::Tunnel( + raw::upgrade_accepted_byte_stream(socket, local_url, remote_url)?, + )), + "tcp" | "faketcp" => { + anyhow::bail!("{} protocol requires a TCP transport", local_url.scheme()) + } + "udp" | "wg" | "quic" => { + anyhow::bail!("{} protocol requires a UDP session", local_url.scheme()) + } + "unix" => anyhow::bail!("unsupported server protocol upgrader: unix"), + scheme => { + self.external(scheme)? + .upgrade_byte_stream(socket, local_url, remote_url) + .await + } + } + } +} + +pub(crate) async fn upgrade_accepted_tcp( + socket: TcpSocket, + local_url: Url, + config: CoreServerProtocolConfig, +) -> anyhow::Result> +where + TcpSocket: VirtualTcpSocket, +{ + match local_url.scheme() { + "tcp" => Ok(raw::upgrade_accepted_tcp_with_local_url(socket, local_url)?), + "faketcp" if config.faketcp => { + Ok(raw::upgrade_accepted_tcp_with_local_url(socket, local_url)?) + } + scheme => anyhow::bail!("unsupported TCP listener protocol: {scheme}"), + } +} + +pub(crate) fn upgrade_accepted_udp( + session: UdpSession, + local_url: &Url, +) -> anyhow::Result> { + match local_url.scheme() { + "udp" => Ok(raw::upgrade_accepted_udp_with_local_url( + session, + local_url.clone(), + )?), + scheme => anyhow::bail!("unsupported UDP listener protocol: {scheme}"), + } +} + +#[cfg(test)] +mod tests { + use std::{ + io, + net::SocketAddr, + pin::Pin, + sync::Arc, + task::{Context, Poll}, + }; + + use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; + + use super::*; + use crate::socket::udp::{UdpSessionKind, VirtualUdpSocket}; + + #[test] + fn protocol_port_metadata_is_authoritative_for_all_ip_protocols() { + let cases = [ + ("tcp", 0, 11010), + ("udp", 0, 11010), + ("wg", 1, 11011), + ("quic", 2, 11012), + ("ws", 1, 80), + ("wss", 2, 443), + ("faketcp", 3, 11013), + ]; + + for (scheme, offset, port) in cases { + assert_eq!(protocol_port_offset(scheme), Some(offset)); + assert_eq!(protocol_default_port(scheme), Some(port)); + } + assert_eq!(protocol_default_port("ring"), None); + } + + struct MockTcpSocket; + + impl AsyncRead for MockTcpSocket { + fn poll_read( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + _buf: &mut ReadBuf<'_>, + ) -> Poll> { + Poll::Pending + } + } + + impl AsyncWrite for MockTcpSocket { + fn poll_write( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + _buf: &[u8], + ) -> Poll> { + Poll::Pending + } + + fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll> { + Poll::Ready(Ok(())) + } + + fn poll_shutdown( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + ) -> Poll> { + Poll::Ready(Ok(())) + } + } + + impl VirtualTcpSocket for MockTcpSocket { + fn local_addr(&self) -> io::Result { + Ok("127.0.0.1:1000".parse().unwrap()) + } + + fn peer_addr(&self) -> io::Result { + Ok("127.0.0.1:2000".parse().unwrap()) + } + } + + struct MockUdpSocket { + local_addr: SocketAddr, + } + + #[async_trait] + impl VirtualUdpSocket for MockUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], _addr: SocketAddr) -> io::Result { + Ok(data.len()) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } + } + + struct MockExternalUpgrader; + + #[async_trait] + impl ClientProtocolUpgrader for MockExternalUpgrader { + fn supports_scheme(&self, _scheme: &str) -> bool { + true + } + + async fn upgrade_client( + &self, + _connected: ConnectedTransport, + _requested_url: Url, + ) -> anyhow::Result> { + anyhow::bail!("external protocol invoked") + } + } + + #[async_trait] + impl ServerProtocolUpgrader for MockExternalUpgrader { + fn supports_scheme(&self, scheme: &str) -> bool { + matches!(scheme, "external" | "ring" | "unix") + } + + async fn upgrade_tcp( + &self, + _socket: MockTcpSocket, + _local_url: Url, + ) -> anyhow::Result { + anyhow::bail!("external server protocol invoked") + } + + async fn upgrade_udp( + &self, + _session: UdpSession, + _local_url: Url, + _admission: Option, + ) -> anyhow::Result { + anyhow::bail!("external server UDP protocol invoked") + } + + async fn upgrade_byte_stream( + &self, + _socket: MockTcpSocket, + _local_url: Url, + _remote_url: Option, + ) -> anyhow::Result { + anyhow::bail!("external server byte-stream protocol invoked") + } + } + + #[tokio::test] + async fn default_core_upgrader_rejects_external_and_mismatched_protocols() { + let upgrader = + CoreClientProtocolUpgrader::::new(CoreClientProtocolConfig::default()); + + assert!(upgrader.supports_scheme("ring")); + assert!(!upgrader.supports_scheme("unix")); + + let unsupported = upgrader + .upgrade_client( + ConnectedTransport::Tcp(MockTcpSocket), + "ws://127.0.0.1:2000".parse().unwrap(), + ) + .await; + assert!(unsupported.is_err()); + + let mismatched = upgrader + .upgrade_client( + ConnectedTransport::Tcp(MockTcpSocket), + "udp://127.0.0.1:2000".parse().unwrap(), + ) + .await; + assert!(mismatched.is_err()); + } + + #[tokio::test] + async fn core_upgrader_owns_builtin_capabilities_and_delegates_external_protocols() { + let upgrader = CoreClientProtocolUpgrader::with_external( + CoreClientProtocolConfig { + unix: false, + faketcp: false, + }, + Arc::new(MockExternalUpgrader), + ); + + assert!(upgrader.supports_scheme("tcp")); + assert!(upgrader.supports_scheme("ring")); + assert!(upgrader.supports_scheme("ws")); + assert!(!upgrader.supports_scheme("unix")); + assert!(!upgrader.supports_scheme("faketcp")); + + let external = upgrader + .upgrade_client( + ConnectedTransport::Tcp(MockTcpSocket), + "ws://127.0.0.1:2000".parse().unwrap(), + ) + .await + .unwrap_err(); + assert_eq!(external.to_string(), "external protocol invoked"); + + let disabled_builtin = upgrader + .upgrade_client( + ConnectedTransport::Tcp(MockTcpSocket), + "faketcp://127.0.0.1:2000".parse().unwrap(), + ) + .await + .unwrap_err(); + assert!( + disabled_builtin + .to_string() + .contains("unsupported client protocol upgrader") + ); + + let mismatched_udp = upgrader + .upgrade_client( + ConnectedTransport::Tcp(MockTcpSocket), + "udp://127.0.0.1:2000".parse().unwrap(), + ) + .await + .unwrap_err(); + assert_eq!( + mismatched_udp.to_string(), + "UDP protocol requires a UDP session" + ); + + let mismatched_tcp = upgrader + .upgrade_client( + ConnectedTransport::ByteStream(super::super::transport::ConnectedByteStream::new( + MockTcpSocket, + None, + "ring://remote".parse().unwrap(), + None, + )), + "tcp://127.0.0.1:2000".parse().unwrap(), + ) + .await + .unwrap_err(); + assert_eq!( + mismatched_tcp.to_string(), + "TCP protocol requires a TCP transport" + ); + } + + #[tokio::test] + async fn core_server_dispatches_raw_tcp_and_enforces_host_capabilities() { + let tunnel = upgrade_accepted_tcp( + MockTcpSocket, + "tcp://0.0.0.0:2000".parse().unwrap(), + CoreServerProtocolConfig::default(), + ) + .await + .unwrap(); + assert_eq!( + tunnel.info().unwrap().local_addr.unwrap().url, + "tcp://0.0.0.0:2000" + ); + + let disabled = upgrade_accepted_tcp( + MockTcpSocket, + "ws://0.0.0.0:2000".parse().unwrap(), + CoreServerProtocolConfig::default(), + ) + .await + .unwrap_err(); + assert_eq!( + disabled.to_string(), + "unsupported TCP listener protocol: ws" + ); + } + + #[tokio::test] + async fn core_server_raw_udp_preserves_explicit_listener_url() { + let local_url: Url = "udp://listener.example:1000/path?bind_device=eth0" + .parse() + .unwrap(); + let session = UdpSession::identity_standalone( + Arc::new(MockUdpSocket { + local_addr: "127.0.0.1:1000".parse().unwrap(), + }), + "127.0.0.1:2000".parse().unwrap(), + UdpSessionKind::EasyTierMux, + ) + .unwrap(); + + let tunnel = upgrade_accepted_udp(session, &local_url).unwrap(); + + assert_eq!( + tunnel.info().unwrap().local_addr.unwrap().url, + local_url.as_str() + ); + } + + #[tokio::test] + async fn core_server_upgrader_owns_builtin_dispatch_and_delegates_external_protocols() { + let upgrader = CoreServerProtocolUpgrader::with_external( + CoreServerProtocolConfig::default(), + Arc::new(MockExternalUpgrader), + ); + + assert!(upgrader.supports_scheme("tcp")); + assert!(upgrader.supports_scheme("udp")); + assert!(!upgrader.supports_scheme("ws")); + assert!(!upgrader.supports_scheme("quic")); + assert!(upgrader.supports_scheme("ring")); + assert!(!upgrader.supports_scheme("unix")); + assert!(upgrader.supports_scheme("external")); + + let external = upgrader + .upgrade_tcp(MockTcpSocket, "external://0.0.0.0:2000".parse().unwrap()) + .await + .err() + .unwrap(); + assert_eq!(external.to_string(), "external server protocol invoked"); + + let mismatched = upgrader + .upgrade_tcp(MockTcpSocket, "quic://0.0.0.0:2000".parse().unwrap()) + .await + .err() + .unwrap(); + assert_eq!( + mismatched.to_string(), + "quic protocol requires a UDP session" + ); + + let wrong_ring_transport = upgrader + .upgrade_tcp(MockTcpSocket, "ring://local".parse().unwrap()) + .await + .err() + .unwrap(); + assert_eq!( + wrong_ring_transport.to_string(), + "ring protocol requires a byte stream" + ); + + let disabled_unix = upgrader + .upgrade_byte_stream( + MockTcpSocket, + "unix:///tmp/easytier.sock".parse().unwrap(), + None, + ) + .await + .err() + .unwrap(); + assert_eq!( + disabled_unix.to_string(), + "unsupported server protocol upgrader: unix" + ); + } + + #[test] + fn server_protocol_admission_is_scoped_to_its_controller() { + let controller = ServerProtocolAdmissionController::new(1, 2); + let admission = controller.try_admit().unwrap(); + assert!(controller.try_admit().is_none()); + + let (active_session, handshake_slots) = admission.into_parts(); + assert_eq!(handshake_slots.available_permits(), 2); + drop(active_session); + assert!(controller.try_admit().is_some()); + + let other = ServerProtocolAdmissionController::new(1, 1); + assert!(other.try_admit().is_some()); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/protocol/raw.rs b/vendor/easytier/easytier-core/src/connectivity/protocol/raw.rs new file mode 100644 index 0000000..bec69bd --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/protocol/raw.rs @@ -0,0 +1,1001 @@ +use std::{fmt, net::SocketAddr, sync::Arc}; + +use async_trait::async_trait; +use rand::seq::SliceRandom as _; +use url::Url; + +use crate::{ + connectivity::{ + manual::resolve_url_addrs, + transport::{self, ConnectedByteStream, ConnectedUdpSession, UdpSessionMode}, + }, + host::dns::DnsResolver, + proto::common::TunnelInfo, + socket::{ + IpVersion, ListenerConnectionCounter, SocketListener, + tcp::{ + TcpBindOptions, TcpListenOptions, TcpSocketListener, TcpSocketPurpose, + VirtualTcpListenerFactory, VirtualTcpSocket, VirtualTcpSocketFactory, + is_retryable_tcp_io_error, + }, + udp::{ + UdpBindOptions, UdpSession, UdpSessionAcceptKind, UdpSessionListenRequest, + UdpSessionSocket, UdpSessionSocketListener, VirtualUdpSocketFactory, + }, + }, + tunnel::{Tunnel, TunnelError, tcp::TcpTunnelUpgrader, udp::UdpTunnelUpgrader}, +}; + +use super::protocol_default_port; + +const BYTE_STREAM_MAX_PACKET_SIZE: usize = 4096; +const TCP_DEFAULT_PORT: u16 = protocol_default_port("tcp").expect("tcp must have a default port"); +const UDP_DEFAULT_PORT: u16 = protocol_default_port("udp").expect("udp must have a default port"); + +#[async_trait] +#[auto_impl::auto_impl(Box, Arc)] +pub trait TunnelDialer: Send + Sync + 'static { + async fn connect(&self) -> anyhow::Result>; + + fn remote_url(&self) -> Url; +} + +/// Core-owned raw TCP Tunnel connector over an injected socket factory. +pub struct TcpTunnelDialer +where + F: VirtualTcpSocketFactory, +{ + remote_url: Url, + factory: Arc, + dns: Arc, + ip_version: IpVersion, + bind: TcpBindOptions, +} + +impl TcpTunnelDialer +where + F: VirtualTcpSocketFactory, +{ + pub fn new(remote_url: Url, factory: Arc, dns: Arc) -> Self { + Self { + remote_url, + factory, + dns, + ip_version: IpVersion::Both, + bind: TcpBindOptions::default(), + } + } + + pub fn with_ip_version(mut self, ip_version: IpVersion) -> Self { + self.ip_version = ip_version; + self + } + + pub fn with_bind(mut self, bind: TcpBindOptions) -> Self { + self.bind = bind; + self + } +} + +#[async_trait] +impl TunnelDialer for TcpTunnelDialer +where + F: VirtualTcpSocketFactory, +{ + async fn connect(&self) -> anyhow::Result> { + if self.remote_url.scheme() != "tcp" { + anyhow::bail!("raw TCP dialer requires tcp URL: {}", self.remote_url); + } + let remote_addr = resolve_url_addrs( + &self.remote_url, + TCP_DEFAULT_PORT, + self.bind.context.clone().with_ip_version(self.ip_version), + self.dns.as_ref(), + ) + .await? + .choose(&mut rand::thread_rng()) + .copied() + .ok_or(TunnelError::NoDnsRecordFound(self.ip_version))?; + let socket = transport::connect_tcp( + self.factory.clone(), + remote_addr, + Vec::new(), + self.bind.clone(), + TcpSocketPurpose::ManualConnect, + ) + .await?; + Ok(upgrade_connected_tcp(socket, self.remote_url.clone())?) + } + + fn remote_url(&self) -> Url { + self.remote_url.clone() + } +} + +/// Core-owned raw TCP Tunnel listener over an injected listener factory. +pub struct TcpTunnelListener +where + F: VirtualTcpListenerFactory, +{ + inner: TcpSocketListener, +} + +impl TcpTunnelListener +where + F: VirtualTcpListenerFactory, +{ + pub fn new(local_addr: SocketAddr, factory: Arc) -> Self { + let bind = TcpBindOptions::default() + .with_local_addr(Some(local_addr)) + .with_only_v6(true); + Self::new_with_bind(local_addr, bind, factory) + } + + pub fn new_with_bind(local_addr: SocketAddr, bind: TcpBindOptions, factory: Arc) -> Self { + Self { + inner: TcpSocketListener::new_with_options( + socket_url("tcp", local_addr), + TcpListenOptions::manual_connect(local_addr).with_bind(bind), + factory, + ), + } + } +} + +impl fmt::Debug for TcpTunnelListener +where + F: VirtualTcpListenerFactory, +{ + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("TcpTunnelListener") + .field("inner", &self.inner) + .finish() + } +} + +#[async_trait] +impl SocketListener for TcpTunnelListener +where + F: VirtualTcpListenerFactory, +{ + type Accepted = Box; + + async fn listen(&mut self) -> anyhow::Result<()> { + self.inner.listen().await + } + + async fn accept(&mut self) -> anyhow::Result { + loop { + let local_url = self.inner.local_url(); + let socket = self.inner.accept().await?; + match upgrade_accepted_tcp_with_local_url(socket, local_url) { + Ok(tunnel) => return Ok(tunnel), + Err(error) if is_retryable_accepted_tcp_error(&error) => { + tracing::warn!( + ?error, + "accepted tcp connection failed with retryable error" + ); + } + Err(error) => return Err(error.into()), + } + } + } + + fn local_url(&self) -> Url { + self.inner.local_url() + } +} + +/// Core-owned raw UDP Tunnel connector over an injected socket factory. +pub struct UdpTunnelDialer +where + H: VirtualUdpSocketFactory, +{ + remote_url: Url, + host: Arc, + dns: Arc, + ip_version: IpVersion, + bind_addrs: Vec, + bind: UdpBindOptions, +} + +impl UdpTunnelDialer +where + H: VirtualUdpSocketFactory, +{ + pub fn new(remote_url: Url, host: Arc, dns: Arc) -> Self { + Self { + remote_url, + host, + dns, + ip_version: IpVersion::Both, + bind_addrs: Vec::new(), + bind: UdpBindOptions::direct_connect(), + } + } + + pub fn with_ip_version(mut self, ip_version: IpVersion) -> Self { + self.ip_version = ip_version; + self + } + + pub fn with_bind_addrs(mut self, bind_addrs: Vec) -> Self { + self.bind_addrs = bind_addrs; + self + } + + pub fn with_bind(mut self, bind: UdpBindOptions) -> Self { + self.bind = bind; + self + } +} + +#[async_trait] +impl TunnelDialer for UdpTunnelDialer +where + H: VirtualUdpSocketFactory, +{ + async fn connect(&self) -> anyhow::Result> { + if self.remote_url.scheme() != "udp" { + anyhow::bail!("raw UDP dialer requires udp URL: {}", self.remote_url); + } + let remote_addr = resolve_url_addrs( + &self.remote_url, + UDP_DEFAULT_PORT, + self.bind.context.clone().with_ip_version(self.ip_version), + self.dns.as_ref(), + ) + .await? + .choose(&mut rand::thread_rng()) + .copied() + .ok_or(TunnelError::NoDnsRecordFound(self.ip_version))?; + let bind_addrs = udp_bind_addrs_for_remote(remote_addr, &self.bind_addrs); + let connected = transport::connect_udp( + self.host.clone(), + remote_addr, + bind_addrs, + self.bind.clone(), + UdpSessionMode::EasyTierMux, + ) + .await?; + Ok(upgrade_connected_udp(connected, self.remote_url.clone())?) + } + + fn remote_url(&self) -> Url { + self.remote_url.clone() + } +} + +/// Core-owned raw UDP Tunnel listener over an injected socket factory. +pub struct UdpTunnelListener +where + H: VirtualUdpSocketFactory, +{ + inner: UdpSessionSocketListener, +} + +impl UdpTunnelListener +where + H: VirtualUdpSocketFactory, +{ + pub fn new(local_url: Url, local_addr: SocketAddr, host: Arc) -> Self { + Self { + inner: UdpSessionSocketListener::new(local_url, local_addr, host), + } + } + + pub fn new_with_request( + local_url: Url, + request: UdpSessionListenRequest, + host: Arc, + ) -> Self { + Self { + inner: UdpSessionSocketListener::new_with_request( + local_url, + request, + UdpSessionAcceptKind::EasyTierMux, + host, + ), + } + } +} + +impl fmt::Debug for UdpTunnelListener +where + H: VirtualUdpSocketFactory, +{ + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("UdpTunnelListener") + .field("inner", &self.inner) + .finish() + } +} + +#[async_trait] +impl SocketListener for UdpTunnelListener +where + H: VirtualUdpSocketFactory, +{ + type Accepted = Box; + + async fn listen(&mut self) -> anyhow::Result<()> { + let local_url = self.inner.local_url(); + if local_url.scheme() != "udp" { + anyhow::bail!("raw UDP listener requires udp URL: {local_url}"); + } + self.inner.listen().await + } + + async fn accept(&mut self) -> anyhow::Result { + let local_url = self.inner.local_url(); + Ok(upgrade_accepted_udp_with_local_url( + self.inner.accept().await?, + local_url, + )?) + } + + fn local_url(&self) -> Url { + self.inner.local_url() + } + + fn connection_counter(&self) -> Arc { + self.inner.connection_counter() + } +} + +pub(crate) fn upgrade_connected_byte_stream( + connected: ConnectedByteStream, +) -> Result, TunnelError> +where + S: VirtualTcpSocket, +{ + let (socket, local_url, remote_url, resolved_remote_url) = connected.into_parts(); + let info = TunnelInfo { + tunnel_type: remote_url.scheme().to_owned(), + local_addr: local_url.map(Into::into), + remote_addr: Some(remote_url.clone().into()), + resolved_remote_addr: Some(resolved_remote_url.unwrap_or(remote_url).into()), + }; + TcpTunnelUpgrader::new(info) + .with_max_packet_size(BYTE_STREAM_MAX_PACKET_SIZE) + .upgrade(socket) +} + +pub(crate) fn upgrade_connected_tcp( + socket: S, + requested_remote_addr: Url, +) -> Result, TunnelError> +where + S: VirtualTcpSocket, +{ + let local_addr = socket.local_addr()?; + let resolved_remote_addr = socket.peer_addr()?; + let scheme = requested_remote_addr.scheme().to_owned(); + let tunnel_type = tcp_tunnel_type(&socket, &scheme)?; + let info = connected_tunnel_info( + &scheme, + &tunnel_type, + local_addr, + resolved_remote_addr, + requested_remote_addr, + ); + TcpTunnelUpgrader::new(info).upgrade(socket) +} + +pub(crate) fn upgrade_connected_udp( + connected: ConnectedUdpSession, + requested_remote_addr: Url, +) -> Result, TunnelError> { + let (session, layer) = connected.into_parts(); + let info = connected_tunnel_info( + "udp", + "udp", + session.local_addr()?, + session.peer_addr()?, + requested_remote_addr, + ); + UdpTunnelUpgrader::with_keep_alive(info, layer).upgrade(session) +} + +pub(crate) fn upgrade_accepted_tcp_with_local_url( + socket: S, + local_url: Url, +) -> Result, TunnelError> +where + S: VirtualTcpSocket, +{ + let remote_addr = socket.peer_addr()?; + let scheme = local_url.scheme().to_owned(); + let remote_url = socket_url(&scheme, remote_addr); + let info = TunnelInfo { + tunnel_type: tcp_tunnel_type(&socket, &scheme)?, + local_addr: Some(local_url.into()), + remote_addr: Some(remote_url.clone().into()), + resolved_remote_addr: Some(remote_url.into()), + }; + TcpTunnelUpgrader::new(info).upgrade(socket) +} + +fn is_retryable_accepted_tcp_error(error: &TunnelError) -> bool { + matches!( + error, + TunnelError::IOError(error) + if is_retryable_tcp_io_error(error) + ) +} + +pub(crate) fn upgrade_accepted_byte_stream( + socket: S, + local_url: Url, + remote_url: Option, +) -> Result, TunnelError> +where + S: VirtualTcpSocket, +{ + let info = TunnelInfo { + tunnel_type: local_url.scheme().to_owned(), + local_addr: Some(local_url.into()), + remote_addr: remote_url.clone().map(Into::into), + resolved_remote_addr: remote_url.map(Into::into), + }; + TcpTunnelUpgrader::new(info) + .with_max_packet_size(BYTE_STREAM_MAX_PACKET_SIZE) + .upgrade(socket) +} + +pub(crate) fn upgrade_accepted_udp_with_local_url( + session: UdpSession, + local_url: Url, +) -> Result, TunnelError> { + if local_url.scheme() != "udp" { + return Err(TunnelError::InvalidProtocol(format!( + "raw UDP listener requires udp URL: {local_url}" + ))); + } + let remote_url = socket_url("udp", session.peer_addr()?); + let info = TunnelInfo { + tunnel_type: "udp".to_owned(), + local_addr: Some(local_url.into()), + remote_addr: Some(remote_url.clone().into()), + resolved_remote_addr: Some(remote_url.into()), + }; + UdpTunnelUpgrader::new(info).upgrade(session) +} + +fn udp_bind_addrs_for_remote( + remote_addr: SocketAddr, + configured: &[SocketAddr], +) -> Vec { + if remote_addr.is_ipv6() { + Vec::new() + } else { + configured.to_vec() + } +} + +fn connected_tunnel_info( + scheme: &str, + tunnel_type: &str, + local_addr: SocketAddr, + resolved_remote_addr: SocketAddr, + requested_remote_addr: Url, +) -> TunnelInfo { + TunnelInfo { + tunnel_type: tunnel_type.to_owned(), + local_addr: Some(socket_url(scheme, local_addr).into()), + remote_addr: Some(requested_remote_addr.into()), + resolved_remote_addr: Some(socket_url(scheme, resolved_remote_addr).into()), + } +} + +fn tcp_tunnel_type(socket: &impl VirtualTcpSocket, scheme: &str) -> Result { + match socket.transport_label() { + Some(label) => Ok(label.to_owned()), + None if scheme == "faketcp" => Err(TunnelError::InternalError( + "FakeTCP upgrader received a socket without a FakeTCP transport label".to_owned(), + )), + None => Ok(scheme.to_owned()), + } +} + +fn socket_url(scheme: &str, addr: SocketAddr) -> Url { + let mut url = + Url::parse(&format!("{scheme}://0.0.0.0")).expect("static transport URL should be valid"); + url.set_ip_host(addr.ip()) + .expect("socket IP should be a valid URL host"); + url.set_port(Some(addr.port())) + .expect("transport URL should accept a port"); + url +} + +#[cfg(test)] +pub(crate) mod tests { + use std::{ + collections::VecDeque, + io, + pin::Pin, + sync::Mutex, + task::{Context, Poll}, + }; + + use futures::{SinkExt, StreamExt}; + use tokio::io::{AsyncRead, AsyncWrite, DuplexStream, ReadBuf}; + + use crate::{ + packet::ZCPacket, + socket::tcp::VirtualTcpListener, + socket::udp::{UdpSessionKind, VirtualUdpSocket}, + }; + + use super::*; + + pub(crate) fn upgrade_accepted_tcp(socket: S) -> Result, TunnelError> + where + S: VirtualTcpSocket, + { + let local_addr = socket.local_addr()?; + upgrade_accepted_tcp_with_local_url(socket, socket_url("tcp", local_addr)) + } + + pub(crate) fn upgrade_accepted_udp( + session: UdpSession, + ) -> Result, TunnelError> { + let local_url = socket_url("udp", session.local_addr()?); + upgrade_accepted_udp_with_local_url(session, local_url) + } + + struct MockTcpSocket { + stream: DuplexStream, + local_addr: SocketAddr, + peer_addr: SocketAddr, + peer_addr_error: Option, + transport_label: Option<&'static str>, + } + + impl MockTcpSocket { + fn new(local_addr: SocketAddr, peer_addr: SocketAddr) -> Self { + let (stream, _) = tokio::io::duplex(64); + Self::from_stream(stream, local_addr, peer_addr) + } + + fn from_stream( + stream: DuplexStream, + local_addr: SocketAddr, + peer_addr: SocketAddr, + ) -> Self { + Self { + stream, + local_addr, + peer_addr, + peer_addr_error: None, + transport_label: None, + } + } + + fn with_transport_label(mut self, transport_label: &'static str) -> Self { + self.transport_label = Some(transport_label); + self + } + + fn with_peer_addr_error(mut self, kind: io::ErrorKind) -> Self { + self.peer_addr_error = Some(kind); + self + } + } + + impl AsyncRead for MockTcpSocket { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + Pin::new(&mut self.stream).poll_read(cx, buf) + } + } + + impl AsyncWrite for MockTcpSocket { + fn poll_write( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut self.stream).poll_write(cx, buf) + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_flush(cx) + } + + fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_shutdown(cx) + } + } + + impl VirtualTcpSocket for MockTcpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + fn peer_addr(&self) -> io::Result { + if let Some(kind) = self.peer_addr_error { + return Err(io::Error::new(kind, "mock peer address failure")); + } + Ok(self.peer_addr) + } + + fn transport_label(&self) -> Option<&str> { + self.transport_label + } + } + + struct MockTcpListener { + local_addr: SocketAddr, + accepts: Mutex>>, + } + + impl MockTcpListener { + fn new( + local_addr: SocketAddr, + accepts: Vec>, + ) -> Self { + Self { + local_addr, + accepts: Mutex::new(accepts.into_iter().collect()), + } + } + } + + #[async_trait] + impl VirtualTcpListener for MockTcpListener { + type Socket = MockTcpSocket; + + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn accept(&self) -> io::Result<(Self::Socket, SocketAddr)> { + let result = { self.accepts.lock().unwrap().pop_front() }; + match result { + Some(result) => result, + None => std::future::pending().await, + } + } + } + + struct MockTcpListenerFactory { + listener: Arc, + } + + #[async_trait] + impl VirtualTcpListenerFactory for MockTcpListenerFactory { + type Listener = MockTcpListener; + + async fn bind_tcp( + &self, + _options: TcpListenOptions, + ) -> anyhow::Result> { + Ok(self.listener.clone()) + } + } + + struct MockUdpSocket { + local_addr: SocketAddr, + } + + #[async_trait] + impl VirtualUdpSocket for MockUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], _addr: SocketAddr) -> io::Result { + Ok(data.len()) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } + } + + #[test] + fn raw_upgrader_preserves_requested_and_resolved_addresses() { + let local_addr: SocketAddr = "127.0.0.1:1000".parse().unwrap(); + let peer_addr: SocketAddr = "127.0.0.1:2000".parse().unwrap(); + let requested_url: Url = "tcp://example.com:2000".parse().unwrap(); + + let connected = upgrade_connected_tcp( + MockTcpSocket::new(local_addr, peer_addr), + requested_url.clone(), + ) + .unwrap(); + let connected_info = connected.info().unwrap(); + assert_eq!( + connected_info.remote_addr.unwrap().url, + requested_url.as_str() + ); + let resolved: Url = connected_info.resolved_remote_addr.unwrap().into(); + assert_eq!(resolved.host_str(), Some("127.0.0.1")); + assert_eq!(resolved.port(), Some(2000)); + + let accepted = upgrade_accepted_tcp(MockTcpSocket::new(local_addr, peer_addr)).unwrap(); + let accepted_info = accepted.info().unwrap(); + assert_eq!( + accepted_info.remote_addr, + accepted_info.resolved_remote_addr + ); + + let requested_local_url: Url = "tcp://0.0.0.0:1000".parse().unwrap(); + let accepted = upgrade_accepted_tcp_with_local_url( + MockTcpSocket::new(local_addr, peer_addr), + requested_local_url.clone(), + ) + .unwrap(); + assert_eq!( + accepted.info().unwrap().local_addr.unwrap().url, + requested_local_url.as_str() + ); + } + + #[test] + fn raw_tcp_upgrader_preserves_host_transport_label() { + let local_addr: SocketAddr = "192.0.2.1:10000".parse().unwrap(); + let peer_addr: SocketAddr = "192.0.2.2:11013".parse().unwrap(); + let requested_url: Url = "faketcp://peer.example:11013".parse().unwrap(); + + let connected = upgrade_connected_tcp( + MockTcpSocket::new(local_addr, peer_addr).with_transport_label("faketcp_test-driver"), + requested_url.clone(), + ) + .unwrap(); + let connected_info = connected.info().unwrap(); + assert_eq!(connected_info.tunnel_type, "faketcp_test-driver"); + assert_eq!( + connected_info.resolved_remote_addr.unwrap().url, + "faketcp://192.0.2.2:11013" + ); + + let accepted = upgrade_accepted_tcp_with_local_url( + MockTcpSocket::new(local_addr, peer_addr).with_transport_label("faketcp_test-driver"), + "faketcp://0.0.0.0:11013".parse().unwrap(), + ) + .unwrap(); + let accepted_info = accepted.info().unwrap(); + assert_eq!(accepted_info.tunnel_type, "faketcp_test-driver"); + assert_eq!( + accepted_info.remote_addr, + accepted_info.resolved_remote_addr + ); + } + + #[tokio::test] + async fn tcp_tunnel_listener_rejects_transient_peer_addr_error_and_continues() { + let local_addr: SocketAddr = "127.0.0.1:11013".parse().unwrap(); + let rejected_peer_addr: SocketAddr = "127.0.0.1:21013".parse().unwrap(); + let accepted_peer_addr: SocketAddr = "127.0.0.1:21014".parse().unwrap(); + let listener = Arc::new(MockTcpListener::new( + local_addr, + vec![ + Ok(( + MockTcpSocket::new(local_addr, rejected_peer_addr) + .with_peer_addr_error(io::ErrorKind::NotConnected), + rejected_peer_addr, + )), + Ok(( + MockTcpSocket::new(local_addr, accepted_peer_addr), + accepted_peer_addr, + )), + ], + )); + let factory = Arc::new(MockTcpListenerFactory { listener }); + let mut tunnel_listener = TcpTunnelListener::new(local_addr, factory); + + tunnel_listener.listen().await.unwrap(); + let tunnel = tunnel_listener.accept().await.unwrap(); + let info = tunnel.info().unwrap(); + + assert_eq!( + info.remote_addr.unwrap().url, + format!("tcp://{accepted_peer_addr}") + ); + } + + #[tokio::test] + async fn tcp_tunnel_listener_propagates_non_retryable_peer_addr_error() { + let local_addr: SocketAddr = "127.0.0.1:11013".parse().unwrap(); + let peer_addr: SocketAddr = "127.0.0.1:21013".parse().unwrap(); + let listener = Arc::new(MockTcpListener::new( + local_addr, + vec![Ok(( + MockTcpSocket::new(local_addr, peer_addr) + .with_peer_addr_error(io::ErrorKind::Other), + peer_addr, + ))], + )); + let factory = Arc::new(MockTcpListenerFactory { listener }); + let mut tunnel_listener = TcpTunnelListener::new(local_addr, factory); + + tunnel_listener.listen().await.unwrap(); + assert!(tunnel_listener.accept().await.is_err()); + } + + #[test] + fn faketcp_upgrader_rejects_socket_without_host_transport_label() { + let local_addr: SocketAddr = "192.0.2.1:10000".parse().unwrap(); + let peer_addr: SocketAddr = "192.0.2.2:11013".parse().unwrap(); + + let connected_error = upgrade_connected_tcp( + MockTcpSocket::new(local_addr, peer_addr), + "faketcp://peer.example:11013".parse().unwrap(), + ) + .unwrap_err(); + assert!(matches!(connected_error, TunnelError::InternalError(_))); + + let accepted_error = upgrade_accepted_tcp_with_local_url( + MockTcpSocket::new(local_addr, peer_addr), + "faketcp://0.0.0.0:11013".parse().unwrap(), + ) + .unwrap_err(); + assert!(matches!(accepted_error, TunnelError::InternalError(_))); + } + + #[test] + fn raw_udp_uses_default_bind_for_ipv6_remote() { + let configured = vec!["192.0.2.1:0".parse().unwrap()]; + + assert_eq!( + udp_bind_addrs_for_remote("198.51.100.1:11010".parse().unwrap(), &configured), + configured + ); + assert!( + udp_bind_addrs_for_remote("[2001:db8::1]:11010".parse().unwrap(), &configured) + .is_empty() + ); + } + + #[tokio::test] + async fn accepted_udp_uses_explicit_listener_url() { + let local_addr = "127.0.0.1:1000".parse().unwrap(); + let peer_addr = "127.0.0.1:2000".parse().unwrap(); + let local_url: Url = "udp://listener.example:1000?bind_device=eth0" + .parse() + .unwrap(); + let session = UdpSession::identity_standalone( + Arc::new(MockUdpSocket { local_addr }), + peer_addr, + UdpSessionKind::EasyTierMux, + ) + .unwrap(); + + let tunnel = upgrade_accepted_udp_with_local_url(session, local_url.clone()).unwrap(); + let info = tunnel.info().unwrap(); + + assert_eq!(info.local_addr.unwrap().url, local_url.as_str()); + assert_eq!(info.remote_addr, info.resolved_remote_addr); + } + + #[tokio::test] + async fn accepted_udp_rejects_non_udp_listener_url() { + let local_addr = "127.0.0.1:1000".parse().unwrap(); + let session = UdpSession::identity_standalone( + Arc::new(MockUdpSocket { local_addr }), + "127.0.0.1:2000".parse().unwrap(), + UdpSessionKind::EasyTierMux, + ) + .unwrap(); + + let error = + upgrade_accepted_udp_with_local_url(session, "quic://127.0.0.1:1000".parse().unwrap()) + .unwrap_err(); + + assert!(matches!(error, TunnelError::InvalidProtocol(_))); + } + + #[test] + fn byte_stream_upgrader_uses_host_endpoint_metadata() { + let local_url: Url = "ring://local".parse().unwrap(); + let remote_url: Url = "ring://remote".parse().unwrap(); + let tunnel = upgrade_connected_byte_stream(ConnectedByteStream::new( + MockTcpSocket::new( + "127.0.0.1:1000".parse().unwrap(), + "127.0.0.1:2000".parse().unwrap(), + ), + Some(local_url.clone()), + remote_url.clone(), + None, + )) + .unwrap(); + let info = tunnel.info().unwrap(); + + assert_eq!(info.tunnel_type, "ring"); + assert_eq!(info.local_addr.unwrap().url, local_url.as_str()); + assert_eq!(info.remote_addr.unwrap().url, remote_url.as_str()); + assert_eq!(info.resolved_remote_addr.unwrap().url, remote_url.as_str()); + } + + #[test] + fn accepted_byte_stream_uses_explicit_endpoint_metadata() { + let local_url: Url = "ring://local".parse().unwrap(); + let remote_url: Url = "ring://remote".parse().unwrap(); + let tunnel = upgrade_accepted_byte_stream( + MockTcpSocket::new( + "127.0.0.1:1000".parse().unwrap(), + "127.0.0.1:2000".parse().unwrap(), + ), + local_url.clone(), + Some(remote_url.clone()), + ) + .unwrap(); + let info = tunnel.info().unwrap(); + + assert_eq!(info.tunnel_type, "ring"); + assert_eq!(info.local_addr.unwrap().url, local_url.as_str()); + assert_eq!(info.remote_addr.unwrap().url, remote_url.as_str()); + assert_eq!(info.resolved_remote_addr.unwrap().url, remote_url.as_str()); + } + + #[test] + fn accepted_byte_stream_allows_unnamed_remote_endpoint() { + let tunnel = upgrade_accepted_byte_stream( + MockTcpSocket::new( + "127.0.0.1:1000".parse().unwrap(), + "127.0.0.1:2000".parse().unwrap(), + ), + "unix:///tmp/easytier.sock".parse().unwrap(), + None, + ) + .unwrap(); + let info = tunnel.info().unwrap(); + + assert_eq!(info.tunnel_type, "unix"); + assert!(info.remote_addr.is_none()); + assert!(info.resolved_remote_addr.is_none()); + } + + #[tokio::test] + async fn byte_stream_upgrader_preserves_legacy_unix_packet_limit() { + let (client_stream, server_stream) = tokio::io::duplex(8192); + let client = upgrade_connected_byte_stream(ConnectedByteStream::new( + MockTcpSocket::from_stream( + client_stream, + "127.0.0.1:1000".parse().unwrap(), + "127.0.0.1:2000".parse().unwrap(), + ), + None, + "unix:///tmp/easytier.sock".parse().unwrap(), + None, + )) + .unwrap(); + let server = upgrade_accepted_byte_stream( + MockTcpSocket::from_stream( + server_stream, + "127.0.0.1:2000".parse().unwrap(), + "127.0.0.1:1000".parse().unwrap(), + ), + "unix:///tmp/easytier.sock".parse().unwrap(), + Some("unix://anonymous/peer".parse().unwrap()), + ) + .unwrap(); + + let (mut client_stream, mut client_sink) = client.split(); + let (mut server_stream, mut server_sink) = server.split(); + let payload = vec![0x5a; 3000]; + client_sink + .send(ZCPacket::new_with_payload(&payload)) + .await + .unwrap(); + + let packet = server_stream.next().await.unwrap().unwrap(); + assert_eq!(packet.payload(), payload); + + let response_payload = vec![0xa5; 3000]; + server_sink + .send(ZCPacket::new_with_payload(&response_payload)) + .await + .unwrap(); + + let packet = client_stream.next().await.unwrap().unwrap(); + assert_eq!(packet.payload(), response_payload); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/stun/client.rs b/vendor/easytier/easytier-core/src/connectivity/stun/client.rs new file mode 100644 index 0000000..2987780 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/stun/client.rs @@ -0,0 +1,1034 @@ +//! Portable STUN clients and NAT classification. + +use std::{ + collections::BTreeSet, + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr}, + sync::Arc, + time::Duration, +}; + +use anyhow::Context as _; +use bytecodec::{DecodeExt as _, EncodeExt as _}; +use quanta::Instant; +use rand::seq::IteratorRandom as _; +use stun_codec::{Message, MessageClass, MessageDecoder, MessageEncoder}; +use tokio::{ + io::{AsyncRead, AsyncReadExt as _, AsyncWriteExt as _}, + sync::{Mutex, broadcast}, + task::JoinSet, +}; +use tracing::{Instrument as _, Level}; + +use crate::{ + host::dns::{DnsQuery, DnsRecordResolver, DnsResolver}, + proto::common::NatType, + socket::{ + IpVersion, SocketContext, + tcp::{TcpBindOptions, TcpConnectOptions, VirtualTcpSocket, VirtualTcpSocketFactory}, + udp::{UdpBindOptions, VirtualUdpSocket, VirtualUdpSocketFactory}, + }, +}; + +use crate::packet::stun::{Attribute, ChangeRequest, tid_to_u32, u32_to_tid}; +use stun_codec::rfc5389::methods::BINDING; + +pub trait StunSocketRuntime: VirtualUdpSocketFactory + VirtualTcpSocketFactory {} + +impl StunSocketRuntime for T where T: VirtualUdpSocketFactory + VirtualTcpSocketFactory {} + +pub trait StunDnsRuntime: DnsResolver + DnsRecordResolver {} + +impl StunDnsRuntime for T where T: DnsResolver + DnsRecordResolver {} + +pub(super) struct HostResolverIter { + dns: Arc, + context: SocketContext, + hostnames: Vec, + ips: Vec, + max_ip_per_domain: u32, + use_ipv6: bool, +} + +impl HostResolverIter +where + D: StunDnsRuntime + ?Sized, +{ + pub(super) fn new( + dns: Arc, + context: SocketContext, + hostnames: Vec, + max_ip_per_domain: u32, + use_ipv6: bool, + ) -> Self { + Self { + dns, + context, + hostnames, + ips: Vec::new(), + max_ip_per_domain, + use_ipv6, + } + } + + async fn get_txt_record(&self, domain_name: &str) -> anyhow::Result> { + let txt_data = self + .dns + .resolve_txt(DnsQuery::new(domain_name, self.context.clone())) + .await?; + Ok(txt_data.split_whitespace().map(str::to_owned).collect()) + } + + pub(super) async fn next(&mut self) -> Option { + loop { + if let Some(addr) = self.ips.pop() { + return Some(addr); + } + + if self.hostnames.is_empty() { + return None; + } + + let endpoint = self.hostnames.remove(0); + if let Some(domain_name) = endpoint.strip_prefix("txt:") { + match self.get_txt_record(domain_name).await { + Ok(hosts) => { + tracing::info!( + ?domain_name, + ?hosts, + "get txt record success when resolve stun server" + ); + self.hostnames.splice(0..0, hosts); + } + Err(error) => { + tracing::warn!( + ?domain_name, + ?error, + "get txt record failed when resolve stun server" + ); + } + } + continue; + } + + if let Some(addr) = explicit_socket_addr(&endpoint) { + if addr.is_ipv6() == self.use_ipv6 { + return Some(addr); + } + continue; + } + + let Some((host, port)) = host_and_port(&endpoint) else { + tracing::warn!(?endpoint, "invalid stun server endpoint"); + continue; + }; + match self + .dns + .resolve(DnsQuery::new(host.clone(), self.context.clone())) + .await + { + Ok(ips) => { + self.ips = ips + .into_iter() + .filter(|ip| ip.is_ipv6() == self.use_ipv6) + .map(|ip| SocketAddr::new(ip, port)) + .choose_multiple(&mut rand::thread_rng(), self.max_ip_per_domain as usize); + } + Err(error) => { + tracing::warn!(?host, ?error, "lookup host for stun failed"); + } + } + } + } +} + +fn explicit_socket_addr(endpoint: &str) -> Option { + if let Ok(addr) = endpoint.parse() { + return Some(addr); + } + endpoint + .parse::() + .ok() + .map(|ip| SocketAddr::new(ip, 3478)) +} + +fn host_and_port(endpoint: &str) -> Option<(String, u16)> { + match endpoint.rsplit_once(':') { + Some((host, port)) if !host.is_empty() => { + Some((host.to_owned(), port.parse::().ok()?)) + } + _ => Some((endpoint.to_owned(), 3478)), + } +} + +#[derive(Debug, Clone)] +struct StunPacket { + data: Vec, + addr: SocketAddr, +} + +type StunPacketReceiver = broadcast::Receiver; + +#[derive(Debug, Clone, Copy)] +pub(super) struct BindRequestResponse { + pub(super) local_addr: SocketAddr, + pub(super) stun_server_addr: SocketAddr, + pub(super) recv_from_addr: SocketAddr, + pub(super) mapped_socket_addr: Option, + #[allow(dead_code)] + changed_socket_addr: Option, + #[allow(dead_code)] + change_ip: bool, + #[allow(dead_code)] + change_port: bool, + real_ip_changed: bool, + real_port_changed: bool, + #[allow(dead_code)] + latency_us: u32, +} + +#[derive(Debug, Clone)] +struct StunClient { + stun_server: SocketAddr, + resp_timeout: Duration, + req_repeat: u32, + socket: Arc, + stun_packet_receiver: Arc>, +} + +impl StunClient +where + S: VirtualUdpSocket, +{ + fn new( + stun_server: SocketAddr, + socket: Arc, + stun_packet_receiver: StunPacketReceiver, + ) -> Self { + Self { + stun_server, + resp_timeout: Duration::from_millis(3000), + req_repeat: 2, + socket, + stun_packet_receiver: Arc::new(Mutex::new(stun_packet_receiver)), + } + } + + async fn wait_stun_response( + &self, + tids: &[u32], + stun_host: &SocketAddr, + ) -> anyhow::Result<(Message, SocketAddr)> { + let mut now = crate::foundation::time::Instant::now(); + let deadline = now + self.resp_timeout; + + while now < deadline { + let mut receiver = self.stun_packet_receiver.lock().await; + let packet = + crate::foundation::time::timeout(deadline - now, receiver.recv()).await??; + now = crate::foundation::time::Instant::now(); + + if packet.data.len() < 20 { + continue; + } + + let mut decoder = MessageDecoder::::new(); + let Ok(message) = decoder + .decode_from_bytes(&packet.data) + .with_context(|| format!("decode stun message from {}", packet.addr))? + else { + continue; + }; + + tracing::trace!( + data = ?packet.data, + ?tids, + remote_addr = ?packet.addr, + ?stun_host, + "recv stun response: {message:#?}" + ); + + if message.class() != MessageClass::SuccessResponse + || message.method() != BINDING + || !tids.contains(&tid_to_u32(&message.transaction_id())) + { + continue; + } + + return Ok((message, packet.addr)); + } + + anyhow::bail!("timed out waiting for STUN response") + } + + fn extract_mapped_addr(message: &Message) -> Option { + message.attributes().find_map(|attribute| match attribute { + Attribute::MappedAddress(addr) => Some(addr.address()), + Attribute::XorMappedAddress(addr) => Some(addr.address()), + _ => None, + }) + } + + fn extract_changed_addr(message: &Message) -> Option { + message.attributes().find_map(|attribute| match attribute { + Attribute::OtherAddress(addr) => Some(addr.address()), + Attribute::ChangedAddress(addr) => Some(addr.address()), + _ => None, + }) + } + + #[tracing::instrument(ret, level = Level::TRACE, skip(self))] + async fn bind_request( + self, + change_ip: bool, + change_port: bool, + ) -> anyhow::Result { + let stun_host = self.stun_server; + let mut tids = Vec::new(); + for _ in 0..self.req_repeat { + let tid = rand::random::(); + let mut message = + Message::::new(MessageClass::Request, BINDING, u32_to_tid(tid)); + message.add_attribute(ChangeRequest::new(change_ip, change_port)); + let bytes = MessageEncoder::new() + .encode_into_bytes(message.clone()) + .with_context(|| "encode stun message")?; + tids.push(tid); + tracing::trace!(?message, ?bytes, tid, "send stun request"); + self.socket.send_to(&bytes, stun_host).await?; + } + + let now = Instant::now(); + let (message, recv_addr) = self.wait_stun_response(&tids, &stun_host).await?; + let changed_socket_addr = Self::extract_changed_addr(&message); + let response = BindRequestResponse { + local_addr: self.socket.local_addr()?, + stun_server_addr: stun_host, + recv_from_addr: recv_addr, + mapped_socket_addr: Self::extract_mapped_addr(&message), + changed_socket_addr, + change_ip, + change_port, + real_ip_changed: stun_host.ip() != recv_addr.ip(), + real_port_changed: stun_host.port() != recv_addr.port(), + latency_us: now.elapsed().as_micros() as u32, + }; + + tracing::trace!( + ?stun_host, + ?recv_addr, + ?changed_socket_addr, + "finish stun bind request" + ); + Ok(response) + } +} + +struct StunClientBuilder +where + S: VirtualUdpSocket, +{ + socket: Arc, + tasks: JoinSet<()>, + stun_packet_sender: broadcast::Sender, +} + +impl StunClientBuilder +where + S: VirtualUdpSocket, +{ + fn new(socket: Arc) -> Self { + let (stun_packet_sender, _) = broadcast::channel(1024); + let mut tasks = JoinSet::new(); + let listener_socket = socket.clone(); + let sender = stun_packet_sender.clone(); + tasks.spawn( + async move { + let mut buf = [0; 1620]; + tracing::trace!("start stun packet listener"); + loop { + let Ok((len, addr)) = listener_socket.recv_from(&mut buf).await else { + tracing::error!("udp recv_from error"); + break; + }; + let data = buf[..len].to_vec(); + tracing::trace!(?addr, ?data, "recv udp stun packet"); + let _ = sender.send(StunPacket { data, addr }); + } + } + .instrument(tracing::info_span!("stun_packet_listener")), + ); + Self { + socket, + tasks, + stun_packet_sender, + } + } + + fn new_stun_client(&self, stun_server: SocketAddr) -> StunClient { + StunClient::new( + stun_server, + self.socket.clone(), + self.stun_packet_sender.subscribe(), + ) + } + + async fn stop(&mut self) { + self.tasks.shutdown().await; + } +} + +impl Drop for StunClientBuilder +where + S: VirtualUdpSocket, +{ + fn drop(&mut self) { + self.tasks.abort_all(); + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum StunTransport { + Udp, + Tcp, +} + +#[derive(Debug, Clone)] +pub struct StunNatTypeDetectResult { + transport: StunTransport, + source_addr: SocketAddr, + pub(super) stun_resps: Vec, + pub(super) extra_bind_test: Option, +} + +impl StunNatTypeDetectResult { + fn new( + transport: StunTransport, + source_addr: SocketAddr, + stun_resps: Vec, + ) -> Self { + Self { + transport, + source_addr, + stun_resps, + extra_bind_test: None, + } + } + + fn has_ip_changed_resp(&self) -> bool { + self.stun_resps.iter().any(|resp| resp.real_ip_changed) + } + + fn has_port_changed_resp(&self) -> bool { + self.stun_resps.iter().any(|resp| resp.real_port_changed) + } + + fn is_open_internet(&self) -> bool { + self.stun_resps + .iter() + .any(|resp| resp.mapped_socket_addr == Some(self.source_addr)) + } + + fn is_no_pat(&self) -> bool { + self.stun_resps.iter().any(|resp| { + resp.mapped_socket_addr.map(|addr| addr.port()) == Some(self.source_addr.port()) + }) + } + + fn stun_server_count(&self) -> usize { + self.stun_resps + .iter() + .map(|resp| resp.recv_from_addr) + .collect::>() + .len() + } + + fn is_cone(&self) -> bool { + self.stun_resps + .iter() + .filter_map(|resp| resp.mapped_socket_addr) + .collect::>() + .len() + == 1 + } + + fn nat_type_udp(&self) -> NatType { + if self.stun_server_count() < 2 { + return NatType::Unknown; + } + + if self.is_cone() { + if self.has_ip_changed_resp() { + if self.is_open_internet() { + NatType::OpenInternet + } else if self.is_no_pat() { + NatType::NoPat + } else { + NatType::FullCone + } + } else if self.has_port_changed_resp() { + NatType::Restricted + } else { + NatType::PortRestricted + } + } else if !self.stun_resps.is_empty() { + if self.public_ips().len() != 1 + || self.usable_stun_resp_count() <= 1 + || self.max_port() - self.min_port() > 15 + { + NatType::Symmetric + } else if let Some(extra_bind_mapped) = self + .extra_bind_test + .as_ref() + .and_then(|extra| extra.mapped_socket_addr) + { + let extra_port = extra_bind_mapped.port(); + let max_port_diff = extra_port.saturating_sub(self.max_port()); + let min_port_diff = self.min_port().saturating_sub(extra_port); + if max_port_diff != 0 && max_port_diff < 100 { + NatType::SymmetricEasyInc + } else if min_port_diff != 0 && min_port_diff < 100 { + NatType::SymmetricEasyDec + } else { + NatType::Symmetric + } + } else { + NatType::Symmetric + } + } else { + NatType::Unknown + } + } + + fn nat_type_tcp(&self) -> NatType { + if self.is_open_internet() { + return NatType::OpenInternet; + } + if self.stun_server_count() < 2 || self.stun_resps.is_empty() { + return NatType::Unknown; + } + if self.is_cone() { + if self.is_no_pat() { + NatType::NoPat + } else { + NatType::FullCone + } + } else { + NatType::Symmetric + } + } + + pub fn nat_type(&self) -> NatType { + match self.transport { + StunTransport::Udp => self.nat_type_udp(), + StunTransport::Tcp => self.nat_type_tcp(), + } + } + + pub fn public_ips(&self) -> Vec { + self.stun_resps + .iter() + .filter_map(|resp| resp.mapped_socket_addr.map(|addr| addr.ip())) + .collect::>() + .into_iter() + .collect() + } + + pub fn collect_available_stun_server(&self) -> Vec { + let mut servers = Vec::new(); + for response in &self.stun_resps { + if !servers.contains(&response.stun_server_addr) { + servers.push(response.stun_server_addr); + } + } + servers + } + + pub fn local_addr(&self) -> SocketAddr { + self.source_addr + } + + pub fn extend_result(&mut self, other: Self) { + self.stun_resps.extend(other.stun_resps); + } + + pub fn min_port(&self) -> u16 { + self.stun_resps + .iter() + .filter_map(|response| response.mapped_socket_addr.map(|addr| addr.port())) + .min() + .unwrap_or(0) + } + + pub fn max_port(&self) -> u16 { + self.stun_resps + .iter() + .filter_map(|response| response.mapped_socket_addr.map(|addr| addr.port())) + .max() + .unwrap_or(u16::MAX) + } + + pub fn usable_stun_resp_count(&self) -> usize { + self.stun_resps + .iter() + .filter(|response| response.mapped_socket_addr.is_some()) + .count() + } +} + +pub struct UdpNatTypeDetector { + runtime: Arc, + dns: Arc, + socket_context: SocketContext, + stun_server_hosts: Vec, + max_ip_per_domain: u32, +} + +impl UdpNatTypeDetector +where + R: StunSocketRuntime, + D: StunDnsRuntime + ?Sized, +{ + pub fn new( + runtime: Arc, + dns: Arc, + socket_context: SocketContext, + stun_server_hosts: Vec, + max_ip_per_domain: u32, + ) -> Self { + Self { + runtime, + dns, + socket_context, + stun_server_hosts, + max_ip_per_domain, + } + } + + pub(super) async fn get_extra_bind_result( + &self, + source_port: u16, + stun_server: SocketAddr, + ) -> anyhow::Result { + let socket = self + .runtime + .bind_udp(stun_udp_bind_options( + self.socket_context.clone(), + IpVersion::V4, + SocketAddr::new(Ipv4Addr::UNSPECIFIED.into(), source_port), + )) + .await?; + udp_bind_request(socket, stun_server).await + } + + pub async fn detect_nat_type( + &self, + source_port: u16, + ) -> anyhow::Result { + let socket = self + .runtime + .bind_udp(stun_udp_bind_options( + self.socket_context.clone(), + IpVersion::V4, + SocketAddr::new(Ipv4Addr::UNSPECIFIED.into(), source_port), + )) + .await?; + self.detect_nat_type_with_socket(socket).await + } + + #[tracing::instrument(skip(self, socket))] + pub async fn detect_nat_type_with_socket( + &self, + socket: Arc<::Socket>, + ) -> anyhow::Result { + let mut resolver = HostResolverIter::new( + self.dns.clone(), + self.socket_context.clone().with_ip_version(IpVersion::V4), + self.stun_server_hosts.clone(), + self.max_ip_per_domain, + false, + ); + let mut stun_servers = Vec::new(); + while let Some(addr) = resolver.next().await { + stun_servers.push(addr); + } + + let client_builder = StunClientBuilder::new(socket.clone()); + let mut tasks = JoinSet::new(); + for stun_server in stun_servers { + tasks.spawn( + client_builder + .new_stun_client(stun_server) + .bind_request(false, false), + ); + tasks.spawn( + client_builder + .new_stun_client(stun_server) + .bind_request(false, true), + ); + tasks.spawn( + client_builder + .new_stun_client(stun_server) + .bind_request(true, true), + ); + } + + let mut responses = Vec::new(); + while let Some(response) = tasks.join_next().await { + if let Ok(Ok(response)) = response { + responses.push(response); + } + } + Ok(StunNatTypeDetectResult::new( + StunTransport::Udp, + socket.local_addr()?, + responses, + )) + } +} + +pub(super) async fn udp_bind_request( + socket: Arc, + stun_server: SocketAddr, +) -> anyhow::Result +where + S: VirtualUdpSocket, +{ + let mut clients = StunClientBuilder::new(socket); + let result = clients + .new_stun_client(stun_server) + .bind_request(false, false) + .await; + clients.stop().await; + result +} + +pub(super) fn stun_udp_bind_options( + context: SocketContext, + ip_version: IpVersion, + local_addr: SocketAddr, +) -> UdpBindOptions { + UdpBindOptions::stun_probe() + .with_context(context.with_ip_version(ip_version)) + .with_local_addr(Some(local_addr)) +} + +struct TcpStunClient { + runtime: Arc, + socket_context: SocketContext, + stun_server: SocketAddr, + conn_timeout: Duration, + io_timeout: Duration, + source_port: u16, +} + +impl TcpStunClient +where + R: StunSocketRuntime, +{ + fn new( + runtime: Arc, + socket_context: SocketContext, + stun_server: SocketAddr, + source_port: u16, + ) -> Self { + Self { + runtime, + socket_context, + stun_server, + conn_timeout: Duration::from_millis(1500), + io_timeout: Duration::from_millis(3000), + source_port, + } + } + + fn extract_mapped_addr(message: &Message) -> Option { + message.attributes().find_map(|attribute| match attribute { + Attribute::MappedAddress(addr) => Some(addr.address()), + Attribute::XorMappedAddress(addr) => Some(addr.address()), + _ => None, + }) + } + + fn message_size_from_header(header: &[u8; 20]) -> anyhow::Result { + if (header[0] & 0b1100_0000) != 0 { + anyhow::bail!("invalid stun message type") + } + let message_len = u16::from_be_bytes([header[2], header[3]]) as usize; + if !message_len.is_multiple_of(4) { + anyhow::bail!("invalid stun message length") + } + let total = 20usize + .checked_add(message_len) + .context("invalid stun message size")?; + if total > 4096 { + anyhow::bail!("stun message too large") + } + Ok(total) + } + + async fn tcp_read_stun_message( + stream: &mut S, + timeout: Duration, + ) -> anyhow::Result> + where + S: AsyncRead + Unpin, + { + let mut header = [0u8; 20]; + crate::foundation::time::timeout(timeout, stream.read_exact(&mut header)).await??; + let total_size = Self::message_size_from_header(&header)?; + let mut buf = vec![0u8; total_size]; + buf[..20].copy_from_slice(&header); + if total_size > 20 { + crate::foundation::time::timeout(timeout, stream.read_exact(&mut buf[20..])).await??; + } + + let mut decoder = MessageDecoder::::new(); + let Ok(message) = decoder + .decode_from_bytes(&buf) + .with_context(|| "decode tcp stun message")? + else { + anyhow::bail!("invalid stun message") + }; + Ok(message) + } + + async fn connect(&self) -> anyhow::Result<::Socket> { + let (bind_addr, ip_version) = match self.stun_server { + SocketAddr::V4(_) => ( + SocketAddr::new(Ipv4Addr::UNSPECIFIED.into(), self.source_port), + IpVersion::V4, + ), + SocketAddr::V6(_) => ( + SocketAddr::new(Ipv6Addr::UNSPECIFIED.into(), self.source_port), + IpVersion::V6, + ), + }; + let bind = TcpBindOptions::default() + .with_context(self.socket_context.clone().with_ip_version(ip_version)) + .with_local_addr(Some(bind_addr)) + .with_reuse_addr(true) + .with_reuse_port(true) + .with_only_v6(bind_addr.is_ipv6()); + crate::foundation::time::timeout( + self.conn_timeout, + self.runtime.connect_tcp( + TcpConnectOptions::stun_probe(self.stun_server, bind_addr).with_bind(bind), + ), + ) + .await? + } + + #[tracing::instrument(ret, level = Level::TRACE, skip(self))] + async fn bind_request(self) -> anyhow::Result { + let mut stream = self.connect().await?; + let local_addr = stream.local_addr()?; + let stun_host = self.stun_server; + let tid = rand::random::(); + let message = Message::::new(MessageClass::Request, BINDING, u32_to_tid(tid)); + let bytes = MessageEncoder::new() + .encode_into_bytes(message) + .with_context(|| "encode tcp stun message")?; + crate::foundation::time::timeout(self.io_timeout, stream.write_all(&bytes)).await??; + + let now = Instant::now(); + let message = Self::tcp_read_stun_message(&mut stream, self.io_timeout).await?; + if message.class() != MessageClass::SuccessResponse + || message.method() != BINDING + || tid_to_u32(&message.transaction_id()) != tid + { + anyhow::bail!("unexpected stun response") + } + + Ok(BindRequestResponse { + local_addr, + stun_server_addr: stun_host, + recv_from_addr: stun_host, + mapped_socket_addr: Self::extract_mapped_addr(&message), + changed_socket_addr: None, + change_ip: false, + change_port: false, + real_ip_changed: false, + real_port_changed: false, + latency_us: now.elapsed().as_micros() as u32, + }) + } +} + +pub(super) async fn tcp_bind_request( + runtime: Arc, + socket_context: SocketContext, + stun_server: SocketAddr, + source_port: u16, +) -> anyhow::Result +where + R: StunSocketRuntime, +{ + TcpStunClient::new(runtime, socket_context, stun_server, source_port) + .bind_request() + .await +} + +pub struct TcpNatTypeDetector { + runtime: Arc, + dns: Arc, + socket_context: SocketContext, + stun_server_hosts: Vec, + max_ip_per_domain: u32, +} + +impl TcpNatTypeDetector +where + R: StunSocketRuntime, + D: StunDnsRuntime + ?Sized, +{ + pub fn new( + runtime: Arc, + dns: Arc, + socket_context: SocketContext, + stun_server_hosts: Vec, + max_ip_per_domain: u32, + ) -> Self { + Self { + runtime, + dns, + socket_context, + stun_server_hosts, + max_ip_per_domain, + } + } + + #[tracing::instrument(skip(self))] + pub async fn detect_nat_type( + &self, + source_port: u16, + ) -> anyhow::Result { + let mut resolver = HostResolverIter::new( + self.dns.clone(), + self.socket_context.clone().with_ip_version(IpVersion::V4), + self.stun_server_hosts.clone(), + self.max_ip_per_domain, + false, + ); + let mut stun_servers = Vec::new(); + while let Some(addr) = resolver.next().await { + stun_servers.push(addr); + } + + let mut responses = Vec::new(); + let mut source_addr = None; + let mut selected_source_port = (source_port != 0).then_some(source_port); + for server in stun_servers { + let response = TcpStunClient::new( + self.runtime.clone(), + self.socket_context.clone(), + server, + selected_source_port.unwrap_or(0), + ) + .bind_request() + .await; + if let Ok(response) = response { + if selected_source_port.is_none() { + selected_source_port = Some(response.local_addr.port()); + } + source_addr.get_or_insert(response.local_addr); + responses.push(response); + if responses.len() >= 3 { + break; + } + } + } + + let source_addr = source_addr.context("no TCP STUN response")?; + Ok(StunNatTypeDetectResult::new( + StunTransport::Tcp, + source_addr, + responses, + )) + } +} + +#[cfg(test)] +mod tests { + use async_trait::async_trait; + + use crate::host::dns::{DnsQuery, DnsRecordResolver, DnsResolver, DnsSrvRecord}; + + use super::*; + + struct EmptyDns; + + #[async_trait] + impl DnsResolver for EmptyDns { + async fn resolve(&self, _query: DnsQuery) -> anyhow::Result> { + Ok(Vec::new()) + } + } + + #[async_trait] + impl DnsRecordResolver for EmptyDns { + async fn resolve_txt(&self, _query: DnsQuery) -> anyhow::Result { + Ok(String::new()) + } + + async fn resolve_srv(&self, _query: DnsQuery) -> anyhow::Result> { + Ok(Vec::new()) + } + } + + #[test] + fn explicit_endpoints_keep_ports_and_default_bare_ips() { + assert_eq!( + explicit_socket_addr("127.0.0.1:5555"), + Some("127.0.0.1:5555".parse().unwrap()) + ); + assert_eq!( + explicit_socket_addr("[::1]:5555"), + Some("[::1]:5555".parse().unwrap()) + ); + assert_eq!( + explicit_socket_addr("2001:db8::1"), + Some("[2001:db8::1]:3478".parse().unwrap()) + ); + } + + #[tokio::test] + async fn invalid_endpoint_does_not_hide_later_servers() { + let mut resolver = HostResolverIter::new( + Arc::new(EmptyDns), + SocketContext::default(), + vec![ + "bad.example:not-a-port".to_owned(), + "127.0.0.1:3478".to_owned(), + ], + 1, + false, + ); + + assert_eq!( + resolver.next().await, + Some("127.0.0.1:3478".parse().unwrap()) + ); + } + + #[test] + fn stun_udp_bind_request_preserves_context_and_family() { + let context = SocketContext::default() + .with_socket_mark(Some(0)) + .with_netns(Some(crate::socket::NetNamespace::new("instance-a"))); + let local_addr = "0.0.0.0:0".parse().unwrap(); + + let options = stun_udp_bind_options(context, IpVersion::V4, local_addr); + + assert_eq!(options.context.ip_version, IpVersion::V4); + assert_eq!(options.context.socket_mark, Some(0)); + assert_eq!( + options.context.netns.as_ref().map(|netns| netns.token()), + Some("instance-a") + ); + assert_eq!(options.local_addr, Some(local_addr)); + assert_eq!( + options.purpose, + crate::socket::udp::UdpSocketPurpose::StunProbe + ); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/stun/collector.rs b/vendor/easytier/easytier-core/src/connectivity/stun/collector.rs new file mode 100644 index 0000000..d9704c8 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/stun/collector.rs @@ -0,0 +1,768 @@ +//! Per-instance STUN state and background detection lifecycle. + +use std::{ + collections::BTreeSet, + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr}, + sync::{ + Arc, Mutex, RwLock, + atomic::{AtomicBool, Ordering}, + }, + time::{Duration, SystemTime, UNIX_EPOCH}, +}; + +use async_trait::async_trait; +use rand::seq::IteratorRandom as _; +use serde::{Deserialize, Serialize}; +use tokio::task::JoinSet; + +use crate::{ + config::{ + DEFAULT_TCP_STUN_SERVERS, DEFAULT_UDP_STUN_SERVERS, DEFAULT_UDP_V6_STUN_SERVERS, + default_stun_servers, + }, + proto::common::{NatType, StunInfo}, + socket::{ + IpVersion, SocketContext, + udp::{VirtualUdpSocket, VirtualUdpSocketFactory}, + }, +}; + +use super::client::{ + HostResolverIter, StunDnsRuntime, StunNatTypeDetectResult, StunSocketRuntime, + TcpNatTypeDetector, UdpNatTypeDetector, stun_udp_bind_options, tcp_bind_request, + udp_bind_request, +}; + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct StunServerConfig { + pub udp_servers: Vec, + pub tcp_servers: Vec, + pub udp_v6_servers: Vec, +} + +impl Default for StunServerConfig { + fn default() -> Self { + Self { + udp_servers: default_stun_servers(DEFAULT_UDP_STUN_SERVERS), + tcp_servers: default_stun_servers(DEFAULT_TCP_STUN_SERVERS), + udp_v6_servers: default_stun_servers(DEFAULT_UDP_V6_STUN_SERVERS), + } + } +} + +#[async_trait] +#[auto_impl::auto_impl(&, Arc, Box)] +pub trait StunInfoProvider: Send + Sync { + fn get_stun_info(&self) -> StunInfo; + + async fn get_udp_port_mapping(&self, local_port: u16) -> anyhow::Result; + + async fn get_tcp_port_mapping(&self, local_port: u16) -> anyhow::Result; + + fn update_stun_info(&self); +} + +#[async_trait] +#[auto_impl::auto_impl(&, Arc, Box)] +pub trait StunSocketMapper: StunInfoProvider + Send + Sync +where + S: VirtualUdpSocket, +{ + async fn get_udp_port_mapping_with_socket(&self, socket: Arc) -> anyhow::Result; +} + +pub struct StunInfoCollector +where + R: StunSocketRuntime, + D: StunDnsRuntime, +{ + runtime: Arc, + dns: Arc, + udp_socket_context: SocketContext, + tcp_socket_context: SocketContext, + stun_servers: Arc>>, + tcp_stun_servers: Arc>>, + stun_servers_v6: Arc>>, + udp_nat_test_result: Arc>>, + tcp_nat_test_result: Arc>>, + public_ipv6: Arc>>, + nat_test_result_time: Arc>, + redetect_notify: Arc, + tasks: Mutex>, + started: AtomicBool, +} + +impl StunInfoCollector +where + R: StunSocketRuntime, + D: StunDnsRuntime + ?Sized, +{ + pub fn new( + runtime: Arc, + dns: Arc, + socket_context: SocketContext, + udp_stun_servers: Vec, + tcp_stun_servers: Vec, + stun_servers_v6: Vec, + ) -> Self { + Self::new_with_socket_contexts( + runtime, + dns, + socket_context.clone(), + socket_context, + udp_stun_servers, + tcp_stun_servers, + stun_servers_v6, + ) + } + + pub fn new_with_socket_contexts( + runtime: Arc, + dns: Arc, + udp_socket_context: SocketContext, + tcp_socket_context: SocketContext, + udp_stun_servers: Vec, + tcp_stun_servers: Vec, + stun_servers_v6: Vec, + ) -> Self { + Self { + runtime, + dns, + udp_socket_context, + tcp_socket_context, + stun_servers: Arc::new(RwLock::new(udp_stun_servers)), + tcp_stun_servers: Arc::new(RwLock::new(tcp_stun_servers)), + stun_servers_v6: Arc::new(RwLock::new(stun_servers_v6)), + udp_nat_test_result: Arc::new(RwLock::new(None)), + tcp_nat_test_result: Arc::new(RwLock::new(None)), + public_ipv6: Arc::new(RwLock::new(None)), + nat_test_result_time: Arc::new(RwLock::new(unix_timestamp())), + redetect_notify: Arc::new(tokio::sync::Notify::new()), + tasks: Mutex::new(JoinSet::new()), + started: AtomicBool::new(false), + } + } + + pub fn new_with_default_servers( + runtime: Arc, + dns: Arc, + socket_context: SocketContext, + ) -> Self { + Self::new( + runtime, + dns, + socket_context, + Self::get_default_servers(), + Self::get_default_tcp_servers(), + Self::get_default_servers_v6(), + ) + } + + pub fn new_with_default_servers_and_socket_contexts( + runtime: Arc, + dns: Arc, + udp_socket_context: SocketContext, + tcp_socket_context: SocketContext, + ) -> Self { + Self::new_with_socket_contexts( + runtime, + dns, + udp_socket_context, + tcp_socket_context, + Self::get_default_servers(), + Self::get_default_tcp_servers(), + Self::get_default_servers_v6(), + ) + } + + pub fn set_stun_servers(&self, stun_servers: Vec) { + *self.stun_servers.write().unwrap() = stun_servers; + } + + pub fn set_stun_servers_v6(&self, stun_servers_v6: Vec) { + *self.stun_servers_v6.write().unwrap() = stun_servers_v6; + } + + pub fn set_tcp_stun_servers(&self, stun_servers: Vec) { + *self.tcp_stun_servers.write().unwrap() = stun_servers; + } + + pub fn get_default_servers() -> Vec { + StunServerConfig::default().udp_servers + } + + pub fn get_default_tcp_servers() -> Vec { + StunServerConfig::default().tcp_servers + } + + pub fn get_default_servers_v6() -> Vec { + StunServerConfig::default().udp_v6_servers + } + + async fn get_public_ipv6( + runtime: Arc, + dns: Arc, + socket_context: SocketContext, + servers: &[String], + ) -> Option { + let mut resolver = HostResolverIter::new( + dns, + socket_context.clone().with_ip_version(IpVersion::V6), + servers.to_vec(), + 10, + true, + ); + while let Some(server) = resolver.next().await { + let socket = runtime + .bind_udp(stun_udp_bind_options( + socket_context.clone(), + IpVersion::V6, + SocketAddr::new(Ipv6Addr::UNSPECIFIED.into(), 0), + )) + .await + .ok()?; + let response = udp_bind_request(socket, server).await; + tracing::debug!(?response, "finish ipv6 udp nat type detect"); + if let Ok(Some(IpAddr::V6(ip))) = + response.map(|response| response.mapped_socket_addr.map(|addr| addr.ip())) + { + return Some(ip); + } + } + None + } + + fn start_stun_routine(&self) { + if self.started.swap(true, Ordering::AcqRel) { + return; + } + + let runtime = self.runtime.clone(); + let dns = self.dns.clone(); + let socket_context = self.udp_socket_context.clone(); + let stun_servers = self.stun_servers.clone(); + let udp_nat_test_result = self.udp_nat_test_result.clone(); + let nat_test_time = self.nat_test_result_time.clone(); + let redetect_notify = self.redetect_notify.clone(); + self.tasks.lock().unwrap().spawn(async move { + loop { + let servers = sampled_servers(&stun_servers.read().unwrap()); + let detector = UdpNatTypeDetector::new( + runtime.clone(), + dns.clone(), + socket_context.clone(), + servers, + 1, + ); + let mut result = detector.detect_nat_type(0).await; + tracing::debug!(?result, "finish udp nat type detect"); + + let nat_type = result + .as_ref() + .map(StunNatTypeDetectResult::nat_type) + .unwrap_or(NatType::Unknown); + if nat_type == NatType::Symmetric { + let old_result = result.as_mut().unwrap(); + tracing::debug!(?old_result, "start get extra bind result"); + for server in old_result.collect_available_stun_server() { + let extra = detector.get_extra_bind_result(0, server).await; + tracing::debug!(?extra, "finish udp nat type detect with another port"); + if let Ok(response) = extra { + old_result.extra_bind_test = Some(response); + break; + } + } + } + + let mut sleep_sec = 10; + if let Ok(result) = result { + *nat_test_time.write().unwrap() = unix_timestamp(); + let completed_extra_test = result.extra_bind_test.is_some(); + *udp_nat_test_result.write().unwrap() = Some(result); + if nat_type != NatType::Unknown + && (nat_type != NatType::Symmetric || completed_extra_test) + { + sleep_sec = 600; + } + } + + tokio::select! { + _ = redetect_notify.notified() => {} + _ = crate::foundation::time::sleep(Duration::from_secs(sleep_sec)) => {} + } + } + }); + + let runtime = self.runtime.clone(); + let dns = self.dns.clone(); + let socket_context = self.tcp_socket_context.clone(); + let tcp_stun_servers = self.tcp_stun_servers.clone(); + let tcp_nat_test_result = self.tcp_nat_test_result.clone(); + let nat_test_time = self.nat_test_result_time.clone(); + let redetect_notify = self.redetect_notify.clone(); + self.tasks.lock().unwrap().spawn(async move { + loop { + let servers = sampled_servers(&tcp_stun_servers.read().unwrap()); + let detector = TcpNatTypeDetector::new( + runtime.clone(), + dns.clone(), + socket_context.clone(), + servers, + 1, + ); + let result = detector.detect_nat_type(0).await; + tracing::debug!(?result, "finish tcp nat type detect"); + + let mut sleep_sec = 10; + if let Ok(result) = result { + *nat_test_time.write().unwrap() = unix_timestamp(); + let nat_type = result.nat_type(); + *tcp_nat_test_result.write().unwrap() = Some(result); + if nat_type != NatType::Unknown { + sleep_sec = 600; + } + } + + tokio::select! { + _ = redetect_notify.notified() => {} + _ = crate::foundation::time::sleep(Duration::from_secs(sleep_sec)) => {} + } + } + }); + + let runtime = self.runtime.clone(); + let dns = self.dns.clone(); + let socket_context = self.udp_socket_context.clone(); + let stun_servers_v6 = self.stun_servers_v6.clone(); + let public_ipv6 = self.public_ipv6.clone(); + let redetect_notify = self.redetect_notify.clone(); + self.tasks.lock().unwrap().spawn(async move { + loop { + let servers = stun_servers_v6.read().unwrap().clone(); + if let Some(ip) = Self::get_public_ipv6( + runtime.clone(), + dns.clone(), + socket_context.clone(), + &servers, + ) + .await + { + *public_ipv6.write().unwrap() = Some(ip); + } + + let sleep_sec = if public_ipv6.read().unwrap().is_none() { + 60 + } else { + 360 + }; + tokio::select! { + _ = redetect_notify.notified() => {} + _ = crate::foundation::time::sleep(Duration::from_secs(sleep_sec)) => {} + } + } + }); + } +} + +#[async_trait] +impl StunInfoProvider for StunInfoCollector +where + R: StunSocketRuntime, + D: StunDnsRuntime + ?Sized, +{ + fn get_stun_info(&self) -> StunInfo { + self.start_stun_routine(); + let udp_result = self.udp_nat_test_result.read().unwrap().clone(); + let tcp_result = self.tcp_nat_test_result.read().unwrap().clone(); + if udp_result.is_none() && tcp_result.is_none() { + return StunInfo::default(); + } + + let mut public_ip = BTreeSet::::new(); + if let Some(result) = &udp_result { + public_ip.extend(result.public_ips().into_iter().map(|ip| ip.to_string())); + } + if let Some(result) = &tcp_result { + public_ip.extend(result.public_ips().into_iter().map(|ip| ip.to_string())); + } + if let Some(ip) = *self.public_ipv6.read().unwrap() { + public_ip.insert(ip.to_string()); + } + + StunInfo { + udp_nat_type: udp_result + .as_ref() + .map(|result| result.nat_type() as i32) + .unwrap_or(NatType::Unknown as i32), + tcp_nat_type: tcp_result + .as_ref() + .map(|result| result.nat_type() as i32) + .unwrap_or(NatType::Unknown as i32), + last_update_time: *self.nat_test_result_time.read().unwrap(), + public_ip: public_ip.into_iter().collect(), + min_port: udp_result + .as_ref() + .map(|result| result.min_port() as u32) + .or_else(|| tcp_result.as_ref().map(|result| result.min_port() as u32)) + .unwrap_or(0), + max_port: udp_result + .as_ref() + .map(|result| result.max_port() as u32) + .or_else(|| tcp_result.as_ref().map(|result| result.max_port() as u32)) + .unwrap_or(0), + } + } + + async fn get_udp_port_mapping(&self, local_port: u16) -> anyhow::Result { + let socket = self + .runtime + .bind_udp(stun_udp_bind_options( + self.udp_socket_context.clone(), + IpVersion::V4, + SocketAddr::new(Ipv4Addr::UNSPECIFIED.into(), local_port), + )) + .await?; + StunSocketMapper::get_udp_port_mapping_with_socket(self, socket).await + } + + async fn get_tcp_port_mapping(&self, local_port: u16) -> anyhow::Result { + self.start_stun_routine(); + let mut servers = self + .tcp_nat_test_result + .read() + .unwrap() + .clone() + .map(|result| result.collect_available_stun_server()) + .unwrap_or_default(); + if servers.is_empty() { + let mut resolver = HostResolverIter::new( + self.dns.clone(), + self.tcp_socket_context + .clone() + .with_ip_version(IpVersion::V4), + self.tcp_stun_servers.read().unwrap().clone(), + 2, + false, + ); + while let Some(addr) = resolver.next().await { + servers.push(addr); + if servers.len() >= 2 { + break; + } + } + } + + for server in servers { + match tcp_bind_request( + self.runtime.clone(), + self.tcp_socket_context.clone(), + server, + local_port, + ) + .await + { + Ok(response) => { + if let Some(mapped_addr) = response.mapped_socket_addr { + return Ok(mapped_addr); + } + } + Err(error) => tracing::warn!(?server, ?error, "tcp stun bind request failed"), + } + } + anyhow::bail!("no TCP STUN mapping found") + } + + fn update_stun_info(&self) { + self.redetect_notify.notify_waiters(); + } +} + +#[async_trait] +impl StunSocketMapper<::Socket> for StunInfoCollector +where + R: StunSocketRuntime, + D: StunDnsRuntime + ?Sized, +{ + async fn get_udp_port_mapping_with_socket( + &self, + socket: Arc<::Socket>, + ) -> anyhow::Result { + self.start_stun_routine(); + let mut servers = self + .udp_nat_test_result + .read() + .unwrap() + .clone() + .map(|result| result.collect_available_stun_server()) + .unwrap_or_default(); + if servers.is_empty() { + let mut resolver = HostResolverIter::new( + self.dns.clone(), + self.udp_socket_context + .clone() + .with_ip_version(IpVersion::V4), + self.stun_servers.read().unwrap().clone(), + 2, + false, + ); + while let Some(addr) = resolver.next().await { + servers.push(addr); + if servers.len() >= 2 { + break; + } + } + } + + for server in servers { + match udp_bind_request(socket.clone(), server).await { + Ok(response) => { + if let Some(mapped_addr) = response.mapped_socket_addr { + return Ok(mapped_addr); + } + } + Err(error) => tracing::warn!(?server, ?error, "stun bind request failed"), + } + } + anyhow::bail!("no UDP STUN mapping found") + } +} + +fn sampled_servers(servers: &[String]) -> Vec { + servers + .iter() + .take(2) + .chain(servers.iter().skip(2).choose(&mut rand::thread_rng())) + .cloned() + .collect() +} + +fn unix_timestamp() -> i64 { + SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap_or_default() + .as_secs() as i64 +} + +#[cfg(test)] +mod tests { + use std::{ + collections::VecDeque, + io, + pin::Pin, + task::{Context, Poll}, + }; + + use bytecodec::{DecodeExt as _, EncodeExt as _}; + use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; + + use crate::host::dns::{DnsQuery, DnsRecordResolver, DnsResolver, DnsSrvRecord}; + use crate::socket::{ + NetNamespace, + tcp::{TcpConnectOptions, VirtualTcpSocket, VirtualTcpSocketFactory}, + udp::{UdpBindOptions, UdpSocketPurpose}, + }; + + use crate::packet::stun::Attribute; + use stun_codec::rfc5389::{attributes::XorMappedAddress, methods::BINDING}; + use stun_codec::{Message, MessageClass, MessageDecoder, MessageEncoder}; + + use super::*; + + struct MockUdpSocket { + local_addr: SocketAddr, + mapped_addr: SocketAddr, + responses: Mutex, SocketAddr)>>, + response_ready: tokio::sync::Notify, + } + + #[async_trait] + impl VirtualUdpSocket for MockUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> io::Result { + let request = MessageDecoder::::new() + .decode_from_bytes(data) + .map_err(|error| io::Error::other(format!("{error:?}")))? + .map_err(|error| io::Error::other(format!("{error:?}")))?; + let mut response = Message::::new( + MessageClass::SuccessResponse, + BINDING, + request.transaction_id(), + ); + response.add_attribute(Attribute::XorMappedAddress(XorMappedAddress::new( + self.mapped_addr, + ))); + let bytes = MessageEncoder::new() + .encode_into_bytes(response) + .map_err(io::Error::other)?; + self.responses.lock().unwrap().push_back((bytes, addr)); + self.response_ready.notify_one(); + Ok(data.len()) + } + + async fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + loop { + if let Some((bytes, addr)) = self.responses.lock().unwrap().pop_front() { + buf[..bytes.len()].copy_from_slice(&bytes); + return Ok((bytes.len(), addr)); + } + self.response_ready.notified().await; + } + } + } + + struct MockTcpSocket(tokio::io::DuplexStream); + + impl AsyncRead for MockTcpSocket { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + Pin::new(&mut self.0).poll_read(cx, buf) + } + } + + impl AsyncWrite for MockTcpSocket { + fn poll_write( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut self.0).poll_write(cx, buf) + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.0).poll_flush(cx) + } + + fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.0).poll_shutdown(cx) + } + } + + impl VirtualTcpSocket for MockTcpSocket { + fn local_addr(&self) -> io::Result { + Ok("127.0.0.1:40000".parse().unwrap()) + } + + fn peer_addr(&self) -> io::Result { + Ok("127.0.0.1:3478".parse().unwrap()) + } + } + + #[derive(Default)] + struct MockRuntime { + udp_binds: Mutex>, + } + + #[async_trait] + impl VirtualUdpSocketFactory for MockRuntime { + type Socket = MockUdpSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.udp_binds.lock().unwrap().push(options); + Ok(Arc::new(MockUdpSocket { + local_addr: "0.0.0.0:40000".parse().unwrap(), + mapped_addr: "198.51.100.10:40123".parse().unwrap(), + responses: Mutex::new(VecDeque::new()), + response_ready: tokio::sync::Notify::new(), + })) + } + } + + #[async_trait] + impl VirtualTcpSocketFactory for MockRuntime { + type Socket = MockTcpSocket; + + async fn connect_tcp(&self, _options: TcpConnectOptions) -> anyhow::Result { + anyhow::bail!("TCP is not used by this test") + } + } + + struct MockDns; + + #[async_trait] + impl DnsResolver for MockDns { + async fn resolve(&self, _query: DnsQuery) -> anyhow::Result> { + Ok(vec!["192.0.2.1".parse().unwrap()]) + } + } + + #[async_trait] + impl DnsRecordResolver for MockDns { + async fn resolve_txt(&self, _query: DnsQuery) -> anyhow::Result { + Ok(String::new()) + } + + async fn resolve_srv(&self, _query: DnsQuery) -> anyhow::Result> { + Ok(Vec::new()) + } + } + + #[test] + fn sampled_servers_keep_first_two_and_at_most_one_extra() { + let servers = ["a", "b", "c", "d"] + .into_iter() + .map(str::to_owned) + .collect::>(); + let sampled = sampled_servers(&servers); + assert_eq!(&sampled[..2], &["a", "b"]); + assert_eq!(sampled.len(), 3); + assert!(matches!(sampled[2].as_str(), "c" | "d")); + } + + #[test] + fn collector_keeps_udp_and_tcp_socket_contexts_separate() { + let udp_context = SocketContext::default() + .with_socket_mark(Some(11)) + .with_netns(Some(NetNamespace::new("udp-instance"))); + let tcp_context = SocketContext::default() + .with_socket_mark(Some(22)) + .with_netns(Some(NetNamespace::new("tcp-instance"))); + let collector = StunInfoCollector::new_with_socket_contexts( + Arc::new(MockRuntime::default()), + Arc::new(MockDns), + udp_context.clone(), + tcp_context.clone(), + Vec::new(), + Vec::new(), + Vec::new(), + ); + + assert_eq!(collector.udp_socket_context, udp_context); + assert_eq!(collector.tcp_socket_context, tcp_context); + } + + #[tokio::test] + async fn udp_mapping_uses_portable_runtime_and_instance_context() { + let runtime = Arc::new(MockRuntime::default()); + let context = SocketContext::default() + .with_socket_mark(Some(0)) + .with_netns(Some(NetNamespace::new("instance-a"))); + let collector = StunInfoCollector::new( + runtime.clone(), + Arc::new(MockDns), + context, + vec!["stun.example".to_owned()], + Vec::new(), + Vec::new(), + ); + + let mapped = collector.get_udp_port_mapping(0).await.unwrap(); + + assert_eq!(mapped, "198.51.100.10:40123".parse().unwrap()); + let binds = runtime.udp_binds.lock().unwrap(); + assert!(!binds.is_empty()); + assert_eq!(binds[0].purpose, UdpSocketPurpose::StunProbe); + assert_eq!(binds[0].local_addr, Some("0.0.0.0:0".parse().unwrap())); + assert_eq!(binds[0].context.ip_version, IpVersion::V4); + assert_eq!(binds[0].context.socket_mark, Some(0)); + assert_eq!( + binds[0].context.netns.as_ref().map(|netns| netns.token()), + Some("instance-a") + ); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/stun/mod.rs b/vendor/easytier/easytier-core/src/connectivity/stun/mod.rs new file mode 100644 index 0000000..1c349b4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/stun/mod.rs @@ -0,0 +1,9 @@ +mod client; +mod collector; +mod responder; + +pub use client::{ + StunDnsRuntime, StunNatTypeDetectResult, StunSocketRuntime, TcpNatTypeDetector, + UdpNatTypeDetector, +}; +pub use collector::{StunInfoCollector, StunInfoProvider, StunServerConfig, StunSocketMapper}; diff --git a/vendor/easytier/easytier-core/src/connectivity/stun/responder.rs b/vendor/easytier/easytier-core/src/connectivity/stun/responder.rs new file mode 100644 index 0000000..42cc940 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/stun/responder.rs @@ -0,0 +1,247 @@ +//! STUN binding-response support over UDP sockets. + +use std::net::SocketAddr; +use std::sync::Arc; + +use anyhow::Context as _; +use bytecodec::{DecodeExt as _, EncodeExt as _}; +use stun_codec::rfc5389::attributes::XorMappedAddress; +use stun_codec::rfc5389::methods::BINDING; +use stun_codec::{Message, MessageClass, MessageDecoder, MessageEncoder}; + +use crate::packet::stun::{Attribute, ChangeRequest, tid_to_u32, u32_to_tid}; +use crate::socket::udp::{UdpBindOptions, VirtualUdpSocket, VirtualUdpSocketFactory}; + +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum StunResponseSendSource { + SameSocket, + NewSocket, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct StunResponse { + pub bytes: Vec, + pub send_source: StunResponseSendSource, +} + +pub fn build_stun_response(addr: SocketAddr, req_buf: &[u8]) -> anyhow::Result { + let mut decoder = MessageDecoder::::new(); + let req_msg = decoder + .decode_from_bytes(req_buf) + .map_err(|e| anyhow::anyhow!("stun decode error: {:?}", e))? + .map_err(|e| anyhow::anyhow!("stun decode broken message error: {:?}", e))?; + + let tid = req_msg.transaction_id(); + // we only respond easytier stun req, whose tid has 0xdeadbeef prefix + if tid.as_bytes()[0..4] != [0xde, 0xad, 0xbe, 0xef] { + anyhow::bail!("stun req tid not from easytier"); + } + + let mut resp_msg = Message::::new( + MessageClass::SuccessResponse, + BINDING, + // we discard the prefix, make sure our implementation is not compatible with other stun client + u32_to_tid(tid_to_u32(&tid)), + ); + resp_msg.add_attribute(Attribute::XorMappedAddress(XorMappedAddress::new(addr))); + + let mut encoder = MessageEncoder::new(); + let bytes = encoder + .encode_into_bytes(resp_msg.clone()) + .map_err(|e| anyhow::anyhow!("stun encode error: {:?}", e))?; + + let change_req = req_msg + .get_attribute::() + .map(|r| r.ip() || r.port()) + .unwrap_or(false); + + Ok(StunResponse { + bytes, + send_source: if change_req { + StunResponseSendSource::NewSocket + } else { + StunResponseSendSource::SameSocket + }, + }) +} + +async fn respond_stun_packet( + socket: Arc, + factory: &F, + addr: SocketAddr, + req_buf: &[u8], +) -> anyhow::Result<()> +where + S: VirtualUdpSocket, + F: VirtualUdpSocketFactory + ?Sized, +{ + let response = build_stun_response(addr, req_buf)?; + match response.send_source { + StunResponseSendSource::SameSocket => { + socket + .send_to(&response.bytes, addr) + .await + .with_context(|| "send stun response error")?; + } + StunResponseSendSource::NewSocket => { + let bind_addr = if addr.is_ipv4() { + "0.0.0.0:0".parse().unwrap() + } else { + "[::]:0".parse().unwrap() + }; + let socket = factory + .bind_udp( + UdpBindOptions::hole_punch_control() + .with_context(socket.socket_context()) + .with_local_addr(Some(bind_addr)), + ) + .await?; + socket.send_to(&response.bytes, addr).await?; + } + } + + tracing::debug!(?addr, "udp respond stun packet done"); + Ok(()) +} + +#[async_trait::async_trait] +impl crate::socket::udp::UdpSessionStunResponder for F +where + S: VirtualUdpSocket, + F: VirtualUdpSocketFactory, +{ + async fn respond_stun( + &self, + socket: Arc, + datagram: &[u8], + remote_addr: SocketAddr, + ) -> std::io::Result<()> { + respond_stun_packet(socket, self, remote_addr, datagram) + .await + .map_err(|error| std::io::Error::other(error.to_string())) + } +} + +#[cfg(test)] +mod tests { + use std::{io, sync::Mutex}; + + use async_trait::async_trait; + use stun_codec::TransactionId; + + use super::*; + + #[derive(Debug, Default)] + struct MockSocket { + sent: Mutex, SocketAddr)>>, + } + + impl MockSocket { + fn sent(&self) -> Vec<(Vec, SocketAddr)> { + self.sent.lock().unwrap().clone() + } + } + + #[async_trait] + impl VirtualUdpSocket for MockSocket { + fn local_addr(&self) -> io::Result { + Ok("127.0.0.1:0".parse().unwrap()) + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> io::Result { + self.sent.lock().unwrap().push((data.to_vec(), addr)); + Ok(data.len()) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } + } + + #[derive(Debug, Default)] + struct MockFactory { + bind_options: Mutex>, + sockets: Mutex>>, + } + + impl MockFactory { + fn bind_options(&self) -> Vec { + self.bind_options.lock().unwrap().clone() + } + + fn sockets(&self) -> Vec> { + self.sockets.lock().unwrap().clone() + } + } + + #[async_trait] + impl VirtualUdpSocketFactory for MockFactory { + type Socket = MockSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.bind_options.lock().unwrap().push(options); + let socket = Arc::new(MockSocket::default()); + self.sockets.lock().unwrap().push(socket.clone()); + Ok(socket) + } + } + + fn stun_request(change_ip: bool, change_port: bool) -> Vec { + let mut request = Message::::new(MessageClass::Request, BINDING, u32_to_tid(7)); + if change_ip || change_port { + request.add_attribute(Attribute::ChangeRequest(ChangeRequest::new( + change_ip, + change_port, + ))); + } + MessageEncoder::new().encode_into_bytes(request).unwrap() + } + + #[test] + fn build_stun_response_rejects_non_easytier_tid() { + let request = + Message::::new(MessageClass::Request, BINDING, TransactionId::new([0; 12])); + let mut encoder = MessageEncoder::new(); + let request = encoder.encode_into_bytes(request).unwrap(); + + assert!(build_stun_response("127.0.0.1:1234".parse().unwrap(), &request).is_err()); + } + + #[test] + fn build_stun_response_detects_change_request() { + let request = stun_request(true, false); + + let response = build_stun_response("127.0.0.1:1234".parse().unwrap(), &request).unwrap(); + + assert_eq!(response.send_source, StunResponseSendSource::NewSocket); + assert!(!response.bytes.is_empty()); + } + + #[tokio::test] + async fn respond_stun_packet_uses_ipv6_unspecified_socket_for_ipv6_change_request() { + let listener_socket = Arc::new(MockSocket::default()); + let factory = MockFactory::default(); + let remote_addr = "[::1]:1234".parse().unwrap(); + + respond_stun_packet( + listener_socket.clone(), + &factory, + remote_addr, + &stun_request(true, false), + ) + .await + .unwrap(); + + assert!(listener_socket.sent().is_empty()); + assert_eq!( + factory.bind_options(), + vec![ + UdpBindOptions::hole_punch_control() + .with_local_addr(Some("[::]:0".parse().unwrap())) + ] + ); + let sockets = factory.sockets(); + assert_eq!(sockets.len(), 1); + assert_eq!(sockets[0].sent()[0].1, remote_addr); + } +} diff --git a/vendor/easytier/easytier-core/src/connectivity/transport/mod.rs b/vendor/easytier/easytier-core/src/connectivity/transport/mod.rs new file mode 100644 index 0000000..6bf41c2 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/transport/mod.rs @@ -0,0 +1,70 @@ +use std::future::Future; + +use futures::{StreamExt, stream::FuturesUnordered}; +use url::Url; + +mod tcp; +mod udp; + +pub(crate) use tcp::connect_tcp; +pub use udp::{ConnectedUdpSession, UdpSessionMode, connect_udp}; + +/// A host-created non-IP byte stream with host-provided endpoint metadata. +/// +/// Unix and in-process transports use the same stream framing boundary as TCP, +/// but their endpoints cannot be represented by `SocketAddr`. +pub struct ConnectedByteStream { + socket: S, + local_url: Option, + remote_url: Url, + resolved_remote_url: Option, +} + +impl ConnectedByteStream { + pub fn new( + socket: S, + local_url: Option, + remote_url: Url, + resolved_remote_url: Option, + ) -> Self { + Self { + socket, + local_url, + remote_url, + resolved_remote_url, + } + } + + pub fn into_parts(self) -> (S, Option, Url, Option) { + ( + self.socket, + self.local_url, + self.remote_url, + self.resolved_remote_url, + ) + } +} + +/// A transport endpoint established by a connectivity strategy. +/// +/// Manual, direct, and hole-punch strategies stop at this boundary. Protocol +/// code consumes the endpoint and upgrades it into an EasyTier tunnel. +pub enum ConnectedTransport { + Tcp(TcpSocket), + Udp(ConnectedUdpSession), + ByteStream(ConnectedByteStream), +} + +async fn first_success(mut futures: FuturesUnordered) -> anyhow::Result +where + F: Future> + Send, +{ + let mut last_error = None; + while let Some(result) = futures.next().await { + match result { + Ok(value) => return Ok(value), + Err(error) => last_error = Some(error), + } + } + Err(last_error.unwrap_or_else(|| anyhow::anyhow!("no transport candidates"))) +} diff --git a/vendor/easytier/easytier-core/src/connectivity/transport/tcp.rs b/vendor/easytier/easytier-core/src/connectivity/transport/tcp.rs new file mode 100644 index 0000000..6edc370 --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/transport/tcp.rs @@ -0,0 +1,53 @@ +use std::{net::SocketAddr, sync::Arc}; + +use futures::stream::FuturesUnordered; + +use crate::socket::{ + IpVersion, + tcp::{TcpBindOptions, TcpConnectOptions, TcpSocketPurpose, VirtualTcpSocketFactory}, +}; + +use super::first_success; + +pub async fn connect_tcp( + host: Arc, + remote_addr: SocketAddr, + bind_addrs: Vec, + default_bind: TcpBindOptions, + purpose: TcpSocketPurpose, +) -> anyhow::Result +where + H: VirtualTcpSocketFactory, +{ + let ip_version = if remote_addr.is_ipv4() { + IpVersion::V4 + } else { + IpVersion::V6 + }; + let default_bind = default_bind.with_ip_version(ip_version); + let futures = FuturesUnordered::new(); + if bind_addrs.is_empty() { + futures.push( + host.connect_tcp( + TcpConnectOptions::direct_connect(remote_addr) + .with_purpose(purpose) + .with_bind(default_bind), + ), + ); + } else { + for bind_addr in bind_addrs { + let bind = default_bind + .clone() + .with_local_addr(Some(bind_addr)) + .with_only_v6(true); + futures.push( + host.connect_tcp( + TcpConnectOptions::direct_connect(remote_addr) + .with_purpose(purpose) + .with_bind(bind), + ), + ); + } + } + first_success(futures).await +} diff --git a/vendor/easytier/easytier-core/src/connectivity/transport/udp.rs b/vendor/easytier/easytier-core/src/connectivity/transport/udp.rs new file mode 100644 index 0000000..8a48d7a --- /dev/null +++ b/vendor/easytier/easytier-core/src/connectivity/transport/udp.rs @@ -0,0 +1,102 @@ +use std::{net::SocketAddr, sync::Arc}; + +use futures::stream::FuturesUnordered; + +use crate::socket::{ + IpVersion, + udp::{ + UdpBindOptions, UdpSession, UdpSessionLayer, UdpSessionProtocol, VirtualUdpSocketFactory, + }, +}; + +use super::first_success; + +pub struct ConnectedUdpSession { + session: UdpSession, + keep_alive: Box, +} + +impl ConnectedUdpSession { + pub fn new(session: UdpSession, keep_alive: T) -> Self + where + T: Send + Sync + 'static, + { + Self { + session, + keep_alive: Box::new(keep_alive), + } + } + + pub fn session(&self) -> &UdpSession { + &self.session + } + + pub fn into_parts(self) -> (UdpSession, Box) { + (self.session, self.keep_alive) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum UdpSessionMode { + EasyTierMux, + Classified(UdpSessionProtocol), +} + +pub async fn connect_udp( + host: Arc, + remote_addr: SocketAddr, + bind_addrs: Vec, + default_bind: UdpBindOptions, + mode: UdpSessionMode, +) -> anyhow::Result +where + H: VirtualUdpSocketFactory, +{ + let ip_version = if remote_addr.is_ipv4() { + IpVersion::V4 + } else { + IpVersion::V6 + }; + let default_bind = default_bind.with_ip_version(ip_version); + let futures = FuturesUnordered::new(); + if bind_addrs.is_empty() { + let local_addr = if remote_addr.is_ipv4() { + "0.0.0.0:0".parse().expect("static IPv4 bind address") + } else { + "[::]:0".parse().expect("static IPv6 bind address") + }; + let bind = default_bind + .with_local_addr(Some(local_addr)) + .with_only_v6(true); + futures.push(bind_and_connect(host.clone(), bind, remote_addr, mode)); + } else { + for bind_addr in bind_addrs { + let bind = default_bind + .clone() + .with_local_addr(Some(bind_addr)) + .with_only_v6(true); + futures.push(bind_and_connect(host.clone(), bind, remote_addr, mode)); + } + } + first_success(futures).await +} + +async fn bind_and_connect( + host: Arc, + bind: UdpBindOptions, + remote_addr: SocketAddr, + mode: UdpSessionMode, +) -> anyhow::Result +where + H: VirtualUdpSocketFactory, +{ + let socket = host.bind_udp(bind).await?; + let layer = Arc::new(UdpSessionLayer::new_with_stun_responder(socket, host)); + let session = match mode { + UdpSessionMode::EasyTierMux => layer.connect(remote_addr).await?, + UdpSessionMode::Classified(protocol) => { + layer.open_classified_session(protocol, remote_addr)? + } + }; + Ok(ConnectedUdpSession::new(session, layer)) +} diff --git a/vendor/easytier/easytier-core/src/events.rs b/vendor/easytier/easytier-core/src/events.rs new file mode 100644 index 0000000..2fb8705 --- /dev/null +++ b/vendor/easytier/easytier-core/src/events.rs @@ -0,0 +1,104 @@ +use std::sync::Arc; + +use cidr::{Ipv4Cidr, Ipv6Inet}; +use url::Url; + +use crate::{ + config::{PeerId, gateway::PortForwardConfig}, + socket::{IpVersion, ListenerConnectionCounter}, +}; + +/// Notifications emitted by the portable core runtime to its host. +#[derive(Debug, Clone)] +pub enum CoreEvent { + PeerAdded(PeerId), + PeerRemoved(PeerId), + PeerConnAdded(easytier_proto::core_peer::peer::PeerConnInfo), + PeerConnRemoved(easytier_proto::core_peer::peer::PeerConnInfo), + CredentialChanged, + + ManualConnecting { + url: Url, + }, + ManualConnectError { + url: Url, + ip_version: IpVersion, + error: String, + }, + + ListenerPlanFailed { + url: Url, + error: String, + }, + ListenerAdded { + url: Url, + connection_counter: Arc, + }, + ListenerRemoved { + url: Url, + }, + ListenerAddFailed { + url: Url, + error: String, + retry_count: usize, + will_retry: bool, + }, + ListenerAcceptFailed { + url: Url, + error: String, + }, + ListenerSocketAccepted { + url: Url, + }, + ListenerAcceptedSocketHandleFailed { + url: Url, + error: String, + }, + + TunnelAccepted { + local_url: String, + remote_url: String, + }, + TunnelAdmissionFailed { + local_url: String, + remote_url: String, + error: String, + }, + UdpPortMappingEstablished { + local_listener: Url, + mapped_listener: Url, + backend: String, + }, + + ProxyCidrsUpdated { + added: Vec, + removed: Vec, + }, + PublicIpv6LeaseChanged { + old: Option, + new: Option, + }, + PublicIpv6RoutesChanged { + added: Vec, + removed: Vec, + }, + + VpnPortalStarted(String), + VpnPortalClientConnected { + portal: String, + client: String, + }, + VpnPortalClientDisconnected { + portal: String, + client: String, + }, + GatewayPortForwardAdded(PortForwardConfig), +} + +pub trait CoreEventSink: Send + Sync + 'static { + fn emit(&self, event: CoreEvent); +} + +impl CoreEventSink for () { + fn emit(&self, _event: CoreEvent) {} +} diff --git a/vendor/easytier/easytier-core/src/foundation/expiring_set.rs b/vendor/easytier/easytier-core/src/foundation/expiring_set.rs new file mode 100644 index 0000000..9cf10f0 --- /dev/null +++ b/vendor/easytier/easytier-core/src/foundation/expiring_set.rs @@ -0,0 +1,71 @@ +use std::{hash::Hash, time::Duration, time::Instant}; + +use dashmap::DashMap; + +/// A thread-safe set whose entries expire after a per-insert TTL. +/// +/// `contains` lazily removes expired entries, so periodic `cleanup` calls +/// are only needed to reclaim memory for keys that stop being read. +#[derive(Debug, Clone)] +pub struct ExpiringSet +where + K: Eq + Hash, +{ + entries: DashMap, +} + +impl Default for ExpiringSet +where + K: Eq + Hash, +{ + fn default() -> Self { + Self { + entries: DashMap::new(), + } + } +} + +impl ExpiringSet +where + K: Eq + Hash + Clone, +{ + pub fn insert(&self, key: K, ttl: Duration) { + self.entries.insert(key, Instant::now() + ttl); + } + + pub fn contains(&self, key: &K) -> bool { + match self + .entries + .remove_if(key, |_, expires_at| *expires_at <= Instant::now()) + { + // Existed and expired: removed while holding the shard lock, so a + // concurrent insert of the same key cannot be dropped by us. + Some(_) => false, + // Not removed: either absent, or still fresh. + None => self.entries.contains_key(key), + } + } + + pub fn cleanup(&self) { + let now = Instant::now(); + self.entries.retain(|_, expires_at| *expires_at > now); + } +} + +#[cfg(test)] +mod tests { + use std::time::Duration; + + use super::*; + + #[test] + fn expired_entries_are_reported_absent() { + let set: ExpiringSet = ExpiringSet::default(); + set.insert(1, Duration::ZERO); + set.insert(2, Duration::from_secs(3600)); + assert!(!set.contains(&1)); + assert!(set.contains(&2)); + set.cleanup(); + assert!(!set.entries.contains_key(&1)); + } +} diff --git a/vendor/easytier/easytier-core/src/foundation/mod.rs b/vendor/easytier/easytier-core/src/foundation/mod.rs new file mode 100644 index 0000000..e1293ae --- /dev/null +++ b/vendor/easytier/easytier-core/src/foundation/mod.rs @@ -0,0 +1,16 @@ +//! Infrastructure Modules with no domain dependency. +//! +//! Everything in `foundation` may be used by any layer, and nothing here may +//! depend on a domain Module. See `CONTEXT.md` "Module layers". + +pub mod expiring_set; +#[cfg(any( + feature = "proxy-smoltcp-stack", + test, + all(feature = "management-rpc", target_os = "wasi") +))] +pub(crate) mod operation_broker; +pub mod stats; +pub(crate) mod task; +pub(crate) mod time; +pub(crate) mod token_bucket; diff --git a/vendor/easytier/easytier-core/src/foundation/operation_broker.rs b/vendor/easytier/easytier-core/src/foundation/operation_broker.rs new file mode 100644 index 0000000..7c6565f --- /dev/null +++ b/vendor/easytier/easytier-core/src/foundation/operation_broker.rs @@ -0,0 +1,503 @@ +//! Domain-neutral lifecycle and completion storage for externally submitted +//! asynchronous operations. + +use std::{ + collections::{HashMap, VecDeque}, + hash::Hash, +}; + +use tokio_util::sync::CancellationToken; + +#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] +#[repr(transparent)] +pub(crate) struct OperationId(u64); + +impl OperationId { + pub(crate) fn from_raw(value: u64) -> Option { + (value != 0).then_some(Self(value)) + } + + pub(crate) fn get(self) -> u64 { + self.0 + } +} + +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(crate) enum AdmissionError { + AtCapacity, + IdExhausted, +} + +pub(crate) struct Admission { + pub(crate) id: OperationId, + pub(crate) cancellation: CancellationToken, +} + +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(crate) enum AccessError { + Missing, + NotDrained, +} + +pub(crate) struct Completion { + pub(crate) operation_id: OperationId, + pub(crate) kind: K, + pub(crate) status: S, +} + +pub(crate) struct ReleasedOperation { + pub(crate) metadata: M, + pub(crate) outcome: Option, +} + +pub(crate) struct TakenOperation { + pub(crate) metadata: M, + pub(crate) value: T, +} + +enum OperationState { + Pending, + Queued(O), + Drained(O), + Discarding, +} + +struct Operation { + kind: K, + metadata: Option, + cancellation: CancellationToken, + state: OperationState, +} + +pub(crate) struct OperationBroker { + max_operations: usize, + next_operation_id: u64, + operations: HashMap>, + completions: VecDeque, + wake_generation: u64, +} + +impl OperationBroker +where + K: Copy, +{ + pub(crate) fn new(max_operations: usize) -> Self { + Self { + max_operations, + next_operation_id: 1, + operations: HashMap::new(), + completions: VecDeque::new(), + wake_generation: 0, + } + } + + pub(crate) fn admit(&mut self, kind: K, metadata: M) -> Result { + if self.operations.len() >= self.max_operations { + return Err(AdmissionError::AtCapacity); + } + let id = + OperationId::from_raw(self.next_operation_id).ok_or(AdmissionError::IdExhausted)?; + self.next_operation_id = self + .next_operation_id + .checked_add(1) + .ok_or(AdmissionError::IdExhausted)?; + let cancellation = CancellationToken::new(); + let replaced = self.operations.insert( + id, + Operation { + kind, + metadata: Some(metadata), + cancellation: cancellation.clone(), + state: OperationState::Pending, + }, + ); + debug_assert!(replaced.is_none()); + Ok(Admission { id, cancellation }) + } + + #[cfg(test)] + pub(crate) fn len(&self) -> usize { + self.operations.len() + } + + pub(crate) fn complete_with( + &mut self, + operation_id: OperationId, + complete: impl FnOnce(K, &mut M) -> O, + ) -> bool { + self.resolve_pending_with(operation_id, false, complete) + } + + pub(crate) fn cancel_with( + &mut self, + operation_id: OperationId, + complete: impl FnOnce(K, &mut M) -> O, + ) -> bool { + self.resolve_pending_with(operation_id, true, complete) + } + + fn resolve_pending_with( + &mut self, + operation_id: OperationId, + cancel: bool, + complete: impl FnOnce(K, &mut M) -> O, + ) -> bool { + let Some(mut operation) = self.operations.remove(&operation_id) else { + return false; + }; + match operation.state { + OperationState::Pending => { + if cancel { + operation.cancellation.cancel(); + } + let outcome = complete( + operation.kind, + operation + .metadata + .as_mut() + .expect("pending operation metadata is present"), + ); + let notify = self.completions.is_empty(); + operation.state = OperationState::Queued(outcome); + self.operations.insert(operation_id, operation); + self.completions.push_back(operation_id); + notify + } + OperationState::Discarding => { + if cancel { + self.operations.insert(operation_id, operation); + } + false + } + OperationState::Queued(_) | OperationState::Drained(_) => { + self.operations.insert(operation_id, operation); + false + } + } + } + + pub(crate) fn free(&mut self, operation_id: OperationId) -> Option> { + let mut operation = self.operations.remove(&operation_id)?; + let state = std::mem::replace(&mut operation.state, OperationState::Discarding); + match state { + OperationState::Pending => { + operation.cancellation.cancel(); + let released = ReleasedOperation { + metadata: operation + .metadata + .take() + .expect("pending operation metadata is present"), + outcome: None, + }; + self.operations.insert(operation_id, operation); + Some(released) + } + OperationState::Queued(outcome) => { + self.completions + .retain(|completion| *completion != operation_id); + Some(ReleasedOperation { + metadata: operation + .metadata + .take() + .expect("queued operation metadata is present"), + outcome: Some(outcome), + }) + } + OperationState::Drained(outcome) => Some(ReleasedOperation { + metadata: operation + .metadata + .take() + .expect("drained operation metadata is present"), + outcome: Some(outcome), + }), + OperationState::Discarding => { + operation.state = OperationState::Discarding; + self.operations.insert(operation_id, operation); + None + } + } + } + + pub(crate) fn drain( + &mut self, + max_count: usize, + mut status: impl FnMut(&O) -> S, + ) -> Vec> { + let mut completions = Vec::with_capacity(max_count.min(self.completions.len())); + while completions.len() < max_count { + let Some(operation_id) = self.completions.pop_front() else { + break; + }; + let Some(operation) = self.operations.get_mut(&operation_id) else { + continue; + }; + let old_state = std::mem::replace(&mut operation.state, OperationState::Discarding); + match old_state { + OperationState::Queued(outcome) => { + completions.push(Completion { + operation_id, + kind: operation.kind, + status: status(&outcome), + }); + operation.state = OperationState::Drained(outcome); + } + other => operation.state = other, + } + } + completions + } + + pub(crate) fn has_completions(&self) -> bool { + !self.completions.is_empty() + } + + pub(crate) fn pending_kind(&self, operation_id: OperationId) -> Option { + self.operations.get(&operation_id).and_then(|operation| { + matches!(operation.state, OperationState::Pending).then_some(operation.kind) + }) + } + + pub(crate) fn request_cancellation(&self, operation_id: OperationId) -> bool { + let Some(operation) = self.operations.get(&operation_id) else { + return false; + }; + if !matches!(operation.state, OperationState::Pending) { + return false; + } + operation.cancellation.cancel(); + true + } + + pub(crate) fn with_drained( + &self, + operation_id: OperationId, + inspect: impl FnOnce(K, &M, &O) -> T, + ) -> Result { + let operation = self + .operations + .get(&operation_id) + .ok_or(AccessError::Missing)?; + match &operation.state { + OperationState::Drained(outcome) => Ok(inspect( + operation.kind, + operation + .metadata + .as_ref() + .expect("drained operation metadata is present"), + outcome, + )), + OperationState::Pending | OperationState::Queued(_) | OperationState::Discarding => { + Err(AccessError::NotDrained) + } + } + } + + pub(crate) fn take_with( + &mut self, + operation_id: OperationId, + take: impl FnOnce(&O) -> Option, + ) -> Result>, AccessError> { + let Some(mut operation) = self.operations.remove(&operation_id) else { + return Err(AccessError::Missing); + }; + let old_state = std::mem::replace(&mut operation.state, OperationState::Discarding); + let outcome = match old_state { + OperationState::Drained(outcome) => outcome, + other => { + operation.state = other; + self.operations.insert(operation_id, operation); + return Err(AccessError::NotDrained); + } + }; + let Some(value) = take(&outcome) else { + operation.state = OperationState::Drained(outcome); + self.operations.insert(operation_id, operation); + return Ok(None); + }; + Ok(Some(TakenOperation { + metadata: operation + .metadata + .take() + .expect("drained operation metadata is present"), + value, + })) + } + + pub(crate) fn pending_ids(&self) -> Vec { + self.operations + .iter() + .filter_map(|(operation_id, operation)| { + matches!(operation.state, OperationState::Pending).then_some(*operation_id) + }) + .collect() + } + + pub(crate) fn wake_generation(&self) -> u64 { + self.wake_generation + } + + pub(crate) fn invalidate_waiters(&mut self) { + self.wake_generation = self.wake_generation.wrapping_add(1); + } + + pub(crate) fn discard_all(&mut self) { + for operation in self.operations.values() { + operation.cancellation.cancel(); + } + self.operations.clear(); + self.completions.clear(); + self.invalidate_waiters(); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[derive(Clone, Copy, Debug, Eq, PartialEq)] + enum Kind { + Read, + Write, + } + + #[test] + fn completion_is_drained_and_taken_once() { + let mut broker = OperationBroker::new(4); + let admission = broker.admit(Kind::Read, "metadata").unwrap(); + + assert!(broker.complete_with(admission.id, |_, _| Ok::<_, u8>(7))); + let completions = broker.drain(4, |outcome| outcome.is_ok()); + assert_eq!(completions.len(), 1); + assert_eq!(completions[0].operation_id, admission.id); + assert_eq!(completions[0].kind, Kind::Read); + assert!(completions[0].status); + assert!(broker.drain(4, |_| true).is_empty()); + + assert!( + broker + .take_with(admission.id, |_| None::) + .unwrap() + .is_none() + ); + let taken = broker + .take_with(admission.id, |outcome| outcome.as_ref().ok().copied()) + .unwrap() + .unwrap(); + assert_eq!(taken.metadata, "metadata"); + assert_eq!(taken.value, 7); + assert!(matches!( + broker.take_with(admission.id, |_| Some(())), + Err(AccessError::Missing) + )); + } + + #[test] + fn free_pending_absorbs_late_completion() { + let mut broker = OperationBroker::new(4); + let admission = broker.admit(Kind::Write, 9).unwrap(); + + let released = broker.free(admission.id).unwrap(); + assert_eq!(released.metadata, 9); + assert!(released.outcome.is_none()); + assert!(admission.cancellation.is_cancelled()); + assert!(!broker.complete_with(admission.id, |_, _| 3)); + + assert_eq!(broker.len(), 0); + assert!(!broker.has_completions()); + } + + #[test] + fn cancellation_and_completion_have_one_terminal_outcome() { + let mut cancelled_first = OperationBroker::new(4); + let cancelled = cancelled_first.admit(Kind::Read, ()).unwrap(); + assert!(cancelled_first.cancel_with(cancelled.id, |_, _| Err::("cancelled"))); + assert!(!cancelled_first.complete_with(cancelled.id, |_, _| Ok(1))); + let completions = cancelled_first.drain(4, |outcome| outcome.is_ok()); + assert_eq!(completions.len(), 1); + assert!(!completions[0].status); + + let mut completed_first = OperationBroker::new(4); + let completed = completed_first.admit(Kind::Read, ()).unwrap(); + assert!(completed_first.complete_with(completed.id, |_, _| Ok::<_, &str>(1))); + assert!(!completed_first.cancel_with(completed.id, |_, _| Err("cancelled"))); + let completions = completed_first.drain(4, |outcome| outcome.is_ok()); + assert_eq!(completions.len(), 1); + assert!(completions[0].status); + } + + #[test] + fn requested_cancellation_stays_pending_until_operation_completes() { + let mut broker = OperationBroker::new(4); + let admission = broker.admit(Kind::Write, "metadata").unwrap(); + + assert_eq!(broker.pending_kind(admission.id), Some(Kind::Write)); + assert!(broker.request_cancellation(admission.id)); + assert!(admission.cancellation.is_cancelled()); + assert!(!broker.has_completions()); + + assert!(broker.complete_with(admission.id, |_, _| Ok::<_, &'static str>(7))); + assert!(broker.has_completions()); + assert_eq!(broker.pending_kind(admission.id), None); + } + + #[test] + fn completion_notification_is_an_empty_to_nonempty_edge() { + let mut broker = OperationBroker::new(4); + let first = broker.admit(Kind::Read, ()).unwrap(); + let second = broker.admit(Kind::Write, ()).unwrap(); + + assert!(broker.complete_with(first.id, |_, _| ())); + assert!(!broker.complete_with(second.id, |_, _| ())); + assert_eq!(broker.drain(2, |_| ()).len(), 2); + assert!(!broker.has_completions()); + + let third = broker.admit(Kind::Read, ()).unwrap(); + assert!(broker.complete_with(third.id, |_, _| ())); + } + + #[test] + fn admission_limit_counts_discarding_tombstones() { + let mut broker = OperationBroker::new(1); + let admission = broker.admit(Kind::Read, ()).unwrap(); + broker.free(admission.id); + + assert!(matches!( + broker.admit(Kind::Write, ()), + Err(AdmissionError::AtCapacity) + )); + + broker.complete_with(admission.id, |_, _| ()); + broker.admit(Kind::Write, ()).unwrap(); + } + + #[test] + fn cancellation_keeps_discarding_tombstone_until_completion() { + let mut broker: OperationBroker = OperationBroker::new(1); + let admission = broker.admit(Kind::Read, ()).unwrap(); + broker.free(admission.id); + + assert!(!broker.cancel_with(admission.id, |_, _| ())); + assert_eq!(broker.len(), 1); + assert!(matches!( + broker.admit(Kind::Write, ()), + Err(AdmissionError::AtCapacity) + )); + + assert!(!broker.complete_with(admission.id, |_, _| ())); + assert_eq!(broker.len(), 0); + broker.admit(Kind::Write, ()).unwrap(); + } + + #[test] + fn discard_invalidates_waiters_and_cancels_operations() { + let mut broker: OperationBroker = OperationBroker::new(1); + let admission = broker.admit(Kind::Read, ()).unwrap(); + let generation = broker.wake_generation(); + + broker.discard_all(); + + assert!(admission.cancellation.is_cancelled()); + assert_ne!(broker.wake_generation(), generation); + assert_eq!(broker.len(), 0); + } +} diff --git a/vendor/easytier/easytier-core/src/foundation/stats.rs b/vendor/easytier/easytier-core/src/foundation/stats.rs new file mode 100644 index 0000000..228fcfa --- /dev/null +++ b/vendor/easytier/easytier-core/src/foundation/stats.rs @@ -0,0 +1,1332 @@ +use dashmap::DashMap; +use serde::{Deserialize, Serialize}; +use std::cell::UnsafeCell; +use std::fmt; +use std::sync::{ + Arc, Mutex, + atomic::{AtomicU32, Ordering}, +}; +use std::time::Duration; +use tokio_util::task::AbortOnDropHandle; + +use crate::foundation::time::interval; + +const METRIC_CLEANUP_INTERVAL: Duration = Duration::from_secs(60); +const METRIC_RETENTION_EPOCHS: u32 = 3; + +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct RpcMetricLabels { + pub network_name: String, + pub src_peer_id: u32, + pub dst_peer_id: u32, + pub service_name: String, + pub method_name: String, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum RpcMetricStatus { + Success, + Error, +} + +impl RpcMetricStatus { + pub fn as_str(self) -> &'static str { + match self { + Self::Success => "success", + Self::Error => "error", + } + } +} + +pub trait RpcMetrics: Send + Sync + 'static { + fn client_tx(&self, _labels: &RpcMetricLabels) {} + + fn client_rx(&self, _labels: &RpcMetricLabels, _duration_ms: u64) {} + + fn client_error( + &self, + _labels: &RpcMetricLabels, + _error_type: Option, + _duration_ms: u64, + ) { + } + + fn server_rx(&self, _labels: &RpcMetricLabels) {} + + fn server_tx(&self, _labels: &RpcMetricLabels, _duration_ms: u64) {} + + fn server_error( + &self, + _labels: &RpcMetricLabels, + _error_type: Option, + _duration_ms: u64, + ) { + } +} + +pub type ArcRpcMetrics = Arc; + +pub trait RpcMetricsProvider: Send + Sync + 'static { + fn into_rpc_metrics(self) -> Option; +} + +impl RpcMetricsProvider for () { + fn into_rpc_metrics(self) -> Option { + None + } +} + +impl RpcMetricsProvider for ArcRpcMetrics { + fn into_rpc_metrics(self) -> Option { + Some(self) + } +} + +impl RpcMetricsProvider for Arc +where + T: RpcMetrics, +{ + fn into_rpc_metrics(self) -> Option { + Some(self) + } +} + +/// Predefined metric names for type safety +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub enum MetricName { + /// RPC calls sent to peers + PeerRpcClientTx, + /// RPC calls received from peers + PeerRpcClientRx, + /// RPC calls sent to peers + PeerRpcServerTx, + /// RPC calls received from peers + PeerRpcServerRx, + /// RPC call duration in milliseconds + PeerRpcDuration, + /// RPC errors + PeerRpcErrors, + + /// Data-plane traffic bytes sent + TrafficBytesTx, + /// Data-plane traffic bytes sent, grouped by destination instance + TrafficBytesTxByInstance, + /// Data-plane traffic bytes received + TrafficBytesRx, + /// Data-plane traffic bytes received, grouped by source instance + TrafficBytesRxByInstance, + /// Control-plane traffic bytes sent + TrafficControlBytesTx, + /// Control-plane traffic bytes sent, grouped by destination instance + TrafficControlBytesTxByInstance, + /// Control-plane traffic bytes received + TrafficControlBytesRx, + /// Control-plane traffic bytes received, grouped by source instance + TrafficControlBytesRxByInstance, + /// Traffic bytes forwarded + TrafficBytesForwarded, + /// Control-plane traffic bytes forwarded + TrafficControlBytesForwarded, + /// Traffic bytes sent to self + TrafficBytesSelfTx, + /// Traffic bytes received from self + TrafficBytesSelfRx, + /// Traffic bytes forwarded for foreign network, rx to local + TrafficBytesForeignForwardRx, + /// Traffic bytes forwarded for foreign network, tx from local + TrafficBytesForeignForwardTx, + /// Traffic bytes forwarded for foreign network, forward + TrafficBytesForeignForwardForwarded, + + /// Data-plane traffic packets sent + TrafficPacketsTx, + /// Data-plane traffic packets sent, grouped by destination instance + TrafficPacketsTxByInstance, + /// Data-plane traffic packets received + TrafficPacketsRx, + /// Data-plane traffic packets received, grouped by source instance + TrafficPacketsRxByInstance, + /// Control-plane traffic packets sent + TrafficControlPacketsTx, + /// Control-plane traffic packets sent, grouped by destination instance + TrafficControlPacketsTxByInstance, + /// Control-plane traffic packets received + TrafficControlPacketsRx, + /// Control-plane traffic packets received, grouped by source instance + TrafficControlPacketsRxByInstance, + /// Traffic packets forwarded + TrafficPacketsForwarded, + /// Control-plane traffic packets forwarded + TrafficControlPacketsForwarded, + /// Traffic packets sent to self + TrafficPacketsSelfTx, + /// Traffic packets received from self + TrafficPacketsSelfRx, + /// Traffic packets forwarded for foreign network, rx to local + TrafficPacketsForeignForwardRx, + /// Traffic packets forwarded for foreign network, tx from local + TrafficPacketsForeignForwardTx, + /// Traffic packets forwarded for foreign network, forward + TrafficPacketsForeignForwardForwarded, + + /// Bytes accepted from one VPN portal client into the mesh + VpnPortalClientBytesTx, + /// Bytes delivered from the mesh to one VPN portal client + VpnPortalClientBytesRx, + /// Packets accepted from one VPN portal client into the mesh + VpnPortalClientPacketsTx, + /// Packets delivered from the mesh to one VPN portal client + VpnPortalClientPacketsRx, + + /// UDP broadcast relay packets captured from the raw socket + UdpBroadcastRelayPacketsCaptured, + /// UDP broadcast relay packets ignored before forwarding + UdpBroadcastRelayPacketsIgnored, + /// UDP broadcast relay packets forwarded + UdpBroadcastRelayPacketsForwarded, + /// UDP broadcast relay packets that failed to forward + UdpBroadcastRelayPacketsForwardFailed, + + /// Compression bytes before compression + CompressionBytesRxBefore, + /// Compression bytes after compression + CompressionBytesRxAfter, + /// Compression bytes before compression + CompressionBytesTxBefore, + /// Compression bytes after compression + CompressionBytesTxAfter, + + TcpProxyConnect, +} + +impl fmt::Display for MetricName { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + MetricName::PeerRpcClientTx => write!(f, "peer_rpc_client_tx"), + MetricName::PeerRpcClientRx => write!(f, "peer_rpc_client_rx"), + MetricName::PeerRpcServerTx => write!(f, "peer_rpc_server_tx"), + MetricName::PeerRpcServerRx => write!(f, "peer_rpc_server_rx"), + MetricName::PeerRpcDuration => write!(f, "peer_rpc_duration_ms"), + MetricName::PeerRpcErrors => write!(f, "peer_rpc_errors"), + + MetricName::TrafficBytesTx => write!(f, "traffic_bytes_tx"), + MetricName::TrafficBytesTxByInstance => write!(f, "traffic_bytes_tx_by_instance"), + MetricName::TrafficBytesRx => write!(f, "traffic_bytes_rx"), + MetricName::TrafficBytesRxByInstance => write!(f, "traffic_bytes_rx_by_instance"), + MetricName::TrafficControlBytesTx => write!(f, "traffic_control_bytes_tx"), + MetricName::TrafficControlBytesTxByInstance => { + write!(f, "traffic_control_bytes_tx_by_instance") + } + MetricName::TrafficControlBytesRx => write!(f, "traffic_control_bytes_rx"), + MetricName::TrafficControlBytesRxByInstance => { + write!(f, "traffic_control_bytes_rx_by_instance") + } + MetricName::TrafficBytesForwarded => write!(f, "traffic_bytes_forwarded"), + MetricName::TrafficControlBytesForwarded => { + write!(f, "traffic_control_bytes_forwarded") + } + MetricName::TrafficBytesSelfTx => write!(f, "traffic_bytes_self_tx"), + MetricName::TrafficBytesSelfRx => write!(f, "traffic_bytes_self_rx"), + MetricName::TrafficBytesForeignForwardRx => { + write!(f, "traffic_bytes_foreign_forward_rx") + } + MetricName::TrafficBytesForeignForwardTx => { + write!(f, "traffic_bytes_foreign_forward_tx") + } + MetricName::TrafficBytesForeignForwardForwarded => { + write!(f, "traffic_bytes_foreign_forward_forwarded") + } + + MetricName::TrafficPacketsTx => write!(f, "traffic_packets_tx"), + MetricName::TrafficPacketsTxByInstance => { + write!(f, "traffic_packets_tx_by_instance") + } + MetricName::TrafficPacketsRx => write!(f, "traffic_packets_rx"), + MetricName::TrafficPacketsRxByInstance => { + write!(f, "traffic_packets_rx_by_instance") + } + MetricName::TrafficControlPacketsTx => write!(f, "traffic_control_packets_tx"), + MetricName::TrafficControlPacketsTxByInstance => { + write!(f, "traffic_control_packets_tx_by_instance") + } + MetricName::TrafficControlPacketsRx => write!(f, "traffic_control_packets_rx"), + MetricName::TrafficControlPacketsRxByInstance => { + write!(f, "traffic_control_packets_rx_by_instance") + } + MetricName::TrafficPacketsForwarded => write!(f, "traffic_packets_forwarded"), + MetricName::TrafficControlPacketsForwarded => { + write!(f, "traffic_control_packets_forwarded") + } + MetricName::TrafficPacketsSelfTx => write!(f, "traffic_packets_self_tx"), + MetricName::TrafficPacketsSelfRx => write!(f, "traffic_packets_self_rx"), + MetricName::TrafficPacketsForeignForwardRx => { + write!(f, "traffic_packets_foreign_forward_rx") + } + MetricName::TrafficPacketsForeignForwardTx => { + write!(f, "traffic_packets_foreign_forward_tx") + } + MetricName::TrafficPacketsForeignForwardForwarded => { + write!(f, "traffic_packets_foreign_forward_forwarded") + } + + MetricName::VpnPortalClientBytesTx => write!(f, "vpn_portal_client_bytes_tx"), + MetricName::VpnPortalClientBytesRx => write!(f, "vpn_portal_client_bytes_rx"), + MetricName::VpnPortalClientPacketsTx => { + write!(f, "vpn_portal_client_packets_tx") + } + MetricName::VpnPortalClientPacketsRx => { + write!(f, "vpn_portal_client_packets_rx") + } + + MetricName::UdpBroadcastRelayPacketsCaptured => { + write!(f, "udp_broadcast_relay_packets_captured") + } + MetricName::UdpBroadcastRelayPacketsIgnored => { + write!(f, "udp_broadcast_relay_packets_ignored") + } + MetricName::UdpBroadcastRelayPacketsForwarded => { + write!(f, "udp_broadcast_relay_packets_forwarded") + } + MetricName::UdpBroadcastRelayPacketsForwardFailed => { + write!(f, "udp_broadcast_relay_packets_forward_failed") + } + + MetricName::CompressionBytesRxBefore => write!(f, "compression_bytes_rx_before"), + MetricName::CompressionBytesRxAfter => write!(f, "compression_bytes_rx_after"), + MetricName::CompressionBytesTxBefore => write!(f, "compression_bytes_tx_before"), + MetricName::CompressionBytesTxAfter => write!(f, "compression_bytes_tx_after"), + + MetricName::TcpProxyConnect => write!(f, "tcp_proxy_connect"), + } + } +} + +/// Predefined label types for type safety +#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub enum LabelType { + /// Network Name + NetworkName(String), + /// Destination instance ID + ToInstanceId(String), + /// Source instance ID + FromInstanceId(String), + /// Source peer ID + SrcPeerId(u32), + /// Destination peer ID + DstPeerId(u32), + /// Service name + ServiceName(String), + /// Method name + MethodName(String), + /// Protocol type + Protocol(String), + /// Direction (tx/rx) + Direction(String), + /// Compression algorithm + CompressionAlgo(String), + /// Error type + ErrorType(String), + /// Status + Status(String), + /// Dst Ip + DstIp(String), + /// Mapped Dst Ip + MappedDstIp(String), + /// Stable VPN portal client name + VpnPortalClient(String), +} + +impl fmt::Display for LabelType { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + LabelType::NetworkName(name) => write!(f, "network_name={}", name), + LabelType::ToInstanceId(id) => write!(f, "to_instance_id={}", id), + LabelType::FromInstanceId(id) => write!(f, "from_instance_id={}", id), + LabelType::SrcPeerId(id) => write!(f, "src_peer_id={}", id), + LabelType::DstPeerId(id) => write!(f, "dst_peer_id={}", id), + LabelType::ServiceName(name) => write!(f, "service_name={}", name), + LabelType::MethodName(name) => write!(f, "method_name={}", name), + LabelType::Protocol(proto) => write!(f, "protocol={}", proto), + LabelType::Direction(dir) => write!(f, "direction={}", dir), + LabelType::CompressionAlgo(algo) => write!(f, "compression_algo={}", algo), + LabelType::ErrorType(err) => write!(f, "error_type={}", err), + LabelType::Status(status) => write!(f, "status={}", status), + LabelType::DstIp(ip) => write!(f, "dst_ip={}", ip), + LabelType::MappedDstIp(ip) => write!(f, "mapped_dst_ip={}", ip), + LabelType::VpnPortalClient(client) => write!(f, "vpn_portal_client={}", client), + } + } +} + +impl LabelType { + pub fn key(&self) -> &'static str { + match self { + LabelType::NetworkName(_) => "network_name", + LabelType::ToInstanceId(_) => "to_instance_id", + LabelType::FromInstanceId(_) => "from_instance_id", + LabelType::SrcPeerId(_) => "src_peer_id", + LabelType::DstPeerId(_) => "dst_peer_id", + LabelType::ServiceName(_) => "service_name", + LabelType::MethodName(_) => "method_name", + LabelType::Protocol(_) => "protocol", + LabelType::Direction(_) => "direction", + LabelType::CompressionAlgo(_) => "compression_algo", + LabelType::ErrorType(_) => "error_type", + LabelType::Status(_) => "status", + LabelType::DstIp(_) => "dst_ip", + LabelType::MappedDstIp(_) => "mapped_dst_ip", + LabelType::VpnPortalClient(_) => "vpn_portal_client", + } + } + + pub fn value(&self) -> String { + match self { + LabelType::NetworkName(name) => name.clone(), + LabelType::ToInstanceId(id) => id.clone(), + LabelType::FromInstanceId(id) => id.clone(), + LabelType::SrcPeerId(id) => id.to_string(), + LabelType::DstPeerId(id) => id.to_string(), + LabelType::ServiceName(name) => name.clone(), + LabelType::MethodName(name) => name.clone(), + LabelType::Protocol(proto) => proto.clone(), + LabelType::Direction(dir) => dir.clone(), + LabelType::CompressionAlgo(algo) => algo.clone(), + LabelType::ErrorType(err) => err.clone(), + LabelType::Status(status) => status.clone(), + LabelType::DstIp(ip) => ip.clone(), + LabelType::MappedDstIp(ip) => ip.clone(), + LabelType::VpnPortalClient(client) => client.clone(), + } + } +} + +/// Label represents a key-value pair for metric identification +#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub struct Label { + pub key: String, + pub value: String, +} + +impl Label { + pub fn new(key: impl Into, value: impl Into) -> Self { + Self { + key: key.into(), + value: value.into(), + } + } + + pub fn from_label_type(label_type: &LabelType) -> Self { + Self { + key: label_type.key().to_string(), + value: label_type.value(), + } + } +} + +/// LabelSet represents a collection of labels for a metric +#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub struct LabelSet { + labels: Vec

, + bind_options: UdpBindOptions, + receive_timeout: Duration, + entries: Arc>>>, + closing: AtomicBool, +} + +impl UdpSocketProxyRuntime +where + F: VirtualUdpSocketFactory, + P: UdpProxyPolicy, +{ + pub fn new( + factory: Arc, + policy: Arc

, + bind_options: UdpBindOptions, + receive_timeout: Duration, + ) -> Self { + Self { + factory, + policy, + bind_options, + receive_timeout, + entries: Arc::new(DashMap::new()), + closing: AtomicBool::new(false), + } + } + + async fn ensure_socket_entry( + &self, + entry_id: UdpNatEntryId, + response_sink: Weak, + ) -> Result>, ProxyRuntimeError> { + if self.closing.load(Ordering::Acquire) { + return Err(ProxyRuntimeError::Other(anyhow::anyhow!( + "UDP proxy runtime is closing" + ))); + } + + let (slot, create) = match self.entries.entry(entry_id) { + Entry::Occupied(entry) => (entry.get().clone(), false), + Entry::Vacant(entry) => { + let slot = UdpSocketEntrySlot::new(); + entry.insert(slot.clone()); + (slot, true) + } + }; + if self.closing.load(Ordering::Acquire) { + slot.close(); + self.remove_slot(entry_id, &slot); + return Err(ProxyRuntimeError::Other(anyhow::anyhow!( + "UDP proxy runtime is closing" + ))); + } + if !create { + return slot.wait_for_entry().await; + } + + let mut creation = + UdpSocketCreationGuard::new(self.entries.clone(), entry_id, slot.clone()); + + let socket = match self.factory.bind_udp(self.bind_options.clone()).await { + Ok(socket) => socket, + Err(error) => { + let error = ProxyRuntimeError::Other(error); + slot.fail(&error); + self.remove_slot(entry_id, &slot); + creation.disarm(); + return Err(error); + } + }; + let candidate = UdpSocketNatEntry::new(socket); + { + let mut state = slot.state.lock().unwrap(); + if slot.closed.load(Ordering::Acquire) || self.closing.load(Ordering::Acquire) { + candidate.stop(); + drop(state); + slot.changed.notify_waiters(); + self.remove_slot(entry_id, &slot); + creation.disarm(); + return Err(ProxyRuntimeError::Other(anyhow::anyhow!( + "UDP proxy socket entry was closed while being created" + ))); + } + candidate.start_receive_task(entry_id, response_sink, self.receive_timeout); + state.entry = Some(candidate.clone()); + } + slot.changed.notify_waiters(); + creation.disarm(); + Ok(candidate) + } + + fn remove_slot(&self, entry_id: UdpNatEntryId, slot: &Arc>) { + remove_entry_slot(&self.entries, entry_id, slot); + } + + pub fn close_all(&self) { + self.closing.store(true, Ordering::Release); + for slot in self.entries.iter() { + slot.close(); + } + self.entries.clear(); + self.entries.shrink_to_fit(); + } +} + +impl ProxyRuntimeInfo for UdpSocketProxyRuntime +where + F: VirtualUdpSocketFactory, + P: UdpProxyPolicy, +{ + fn proxy_runtime_snapshot(&self) -> ProxyRuntimeSnapshot { + self.policy.proxy_runtime_snapshot() + } + + fn is_ip_local_virtual_ip(&self, ip: &IpAddr) -> bool { + self.policy.is_ip_local_virtual_ip(ip) + } +} + +#[async_trait::async_trait] +impl UdpProxyRuntime for UdpSocketProxyRuntime +where + F: VirtualUdpSocketFactory, + P: UdpProxyPolicy, +{ + fn should_deny_udp_proxy(&self, dst: SocketAddr) -> bool { + self.policy.should_deny_udp_proxy(dst) + } + + fn udp_response_ipv4_mtu(&self) -> usize { + self.policy.udp_response_ipv4_mtu() + } + + async fn send_udp_to_socket( + &self, + entry_id: UdpNatEntryId, + dst: SocketAddr, + payload: Bytes, + response_sink: Weak, + ) -> Result<(), ProxyRuntimeError> { + let entry = self.ensure_socket_entry(entry_id, response_sink).await?; + if entry.closed.load(Ordering::Acquire) { + return Err(ProxyRuntimeError::Other(anyhow::anyhow!( + "UDP proxy socket entry is closed" + ))); + } + entry.socket.send_to(&payload, dst).await?; + Ok(()) + } + + fn close_udp_socket(&self, entry_id: UdpNatEntryId) { + if let Some((_, slot)) = self.entries.remove(&entry_id) { + slot.close(); + } + self.entries.shrink_to_fit(); + } +} + +impl Drop for UdpSocketProxyRuntime +where + F: VirtualUdpSocketFactory, + P: UdpProxyPolicy, +{ + fn drop(&mut self) { + self.close_all(); + } +} + +#[cfg(test)] +mod tests { + use std::{ + io, + net::Ipv4Addr, + sync::atomic::{AtomicUsize, Ordering as AtomicOrdering}, + }; + + use super::*; + use crate::socket::udp::UdpSocketPurpose; + + #[derive(Default)] + struct RecordingSocket { + sent: std::sync::Mutex, SocketAddr)>>, + } + + #[async_trait::async_trait] + impl VirtualUdpSocket for RecordingSocket { + fn local_addr(&self) -> io::Result { + Ok("127.0.0.1:40000".parse().unwrap()) + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> io::Result { + self.sent.lock().unwrap().push((data.to_vec(), addr)); + Ok(data.len()) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } + } + + #[derive(Default)] + struct RecordingFactory { + options: std::sync::Mutex>, + socket: Arc, + } + + #[async_trait::async_trait] + impl VirtualUdpSocketFactory for RecordingFactory { + type Socket = RecordingSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.options.lock().unwrap().push(options); + Ok(self.socket.clone()) + } + } + + #[derive(Default)] + struct DelayedFactory { + socket: Arc, + bind_calls: AtomicUsize, + bind_started: Notify, + release_bind: Notify, + } + + #[async_trait::async_trait] + impl VirtualUdpSocketFactory for DelayedFactory { + type Socket = RecordingSocket; + + async fn bind_udp(&self, _options: UdpBindOptions) -> anyhow::Result> { + self.bind_calls.fetch_add(1, AtomicOrdering::AcqRel); + self.bind_started.notify_one(); + self.release_bind.notified().await; + Ok(self.socket.clone()) + } + } + + struct TestPolicy; + + impl ProxyRuntimeInfo for TestPolicy { + fn proxy_runtime_snapshot(&self) -> ProxyRuntimeSnapshot { + ProxyRuntimeSnapshot::default() + } + + fn is_ip_local_virtual_ip(&self, _ip: &IpAddr) -> bool { + false + } + } + + impl UdpProxyPolicy for TestPolicy { + fn should_deny_udp_proxy(&self, _dst: SocketAddr) -> bool { + false + } + + fn udp_response_ipv4_mtu(&self) -> usize { + 1280 + } + } + + struct NoopResponseSink; + + #[async_trait::async_trait] + impl UdpProxyResponseSink for NoopResponseSink { + async fn handle_socket_response( + &self, + _entry_id: UdpNatEntryId, + _src: SocketAddr, + _payload: Bytes, + ) { + } + } + + #[tokio::test] + async fn reuses_one_host_socket_per_nat_entry_and_recreates_after_close() { + let factory = Arc::new(RecordingFactory::default()); + let runtime = UdpSocketProxyRuntime::new( + factory.clone(), + Arc::new(TestPolicy), + UdpBindOptions::proxy_nat(), + Duration::from_secs(120), + ); + let sink: Arc = Arc::new(NoopResponseSink); + let entry_id = UdpNatEntryId::new(); + let destination = SocketAddr::from((Ipv4Addr::LOCALHOST, 53)); + + runtime + .send_udp_to_socket( + entry_id, + destination, + Bytes::from_static(b"first"), + Arc::downgrade(&sink), + ) + .await + .unwrap(); + runtime + .send_udp_to_socket( + entry_id, + destination, + Bytes::from_static(b"second"), + Arc::downgrade(&sink), + ) + .await + .unwrap(); + + assert_eq!(factory.options.lock().unwrap().len(), 1); + assert_eq!( + factory.options.lock().unwrap()[0].purpose, + UdpSocketPurpose::ProxyNat + ); + assert_eq!(factory.socket.sent.lock().unwrap().len(), 2); + + runtime.close_udp_socket(entry_id); + runtime + .send_udp_to_socket( + entry_id, + destination, + Bytes::from_static(b"third"), + Arc::downgrade(&sink), + ) + .await + .unwrap(); + assert_eq!(factory.options.lock().unwrap().len(), 2); + } + + #[tokio::test] + async fn close_all_cancels_an_inflight_socket_creation() { + let factory = Arc::new(DelayedFactory::default()); + let runtime = Arc::new(UdpSocketProxyRuntime::new( + factory.clone(), + Arc::new(TestPolicy), + UdpBindOptions::proxy_nat(), + Duration::from_secs(120), + )); + let sink: Arc = Arc::new(NoopResponseSink); + let entry_id = UdpNatEntryId::new(); + let destination = SocketAddr::from((Ipv4Addr::LOCALHOST, 53)); + let send_task = tokio::spawn({ + let runtime = runtime.clone(); + let sink = Arc::downgrade(&sink); + async move { + runtime + .send_udp_to_socket(entry_id, destination, Bytes::from_static(b"request"), sink) + .await + } + }); + + factory.bind_started.notified().await; + runtime.close_all(); + factory.release_bind.notify_one(); + + let error = send_task.await.unwrap().unwrap_err(); + assert!(error.to_string().contains("closed while being created")); + assert_eq!(factory.bind_calls.load(AtomicOrdering::Acquire), 1); + assert!(factory.socket.sent.lock().unwrap().is_empty()); + assert!(runtime.entries.is_empty()); + } + + #[tokio::test] + async fn cancelled_creator_releases_the_slot_for_retry() { + let factory = Arc::new(DelayedFactory::default()); + let runtime = Arc::new(UdpSocketProxyRuntime::new( + factory.clone(), + Arc::new(TestPolicy), + UdpBindOptions::proxy_nat(), + Duration::from_secs(120), + )); + let sink: Arc = Arc::new(NoopResponseSink); + let entry_id = UdpNatEntryId::new(); + let destination = SocketAddr::from((Ipv4Addr::LOCALHOST, 53)); + let first_send = tokio::spawn({ + let runtime = runtime.clone(); + let sink = Arc::downgrade(&sink); + async move { + runtime + .send_udp_to_socket(entry_id, destination, Bytes::from_static(b"first"), sink) + .await + } + }); + + factory.bind_started.notified().await; + first_send.abort(); + assert!(first_send.await.unwrap_err().is_cancelled()); + + let retry = tokio::spawn({ + let runtime = runtime.clone(); + let sink = Arc::downgrade(&sink); + async move { + runtime + .send_udp_to_socket(entry_id, destination, Bytes::from_static(b"retry"), sink) + .await + } + }); + factory.bind_started.notified().await; + factory.release_bind.notify_one(); + + time::timeout(Duration::from_secs(1), retry) + .await + .unwrap() + .unwrap() + .unwrap(); + assert_eq!(factory.bind_calls.load(AtomicOrdering::Acquire), 2); + assert_eq!(factory.socket.sent.lock().unwrap().len(), 1); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_tcp_proxy.rs b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_tcp_proxy.rs new file mode 100644 index 0000000..312b16b --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_tcp_proxy.rs @@ -0,0 +1,489 @@ +use std::{ + future::Future, + net::{IpAddr, Ipv4Addr, SocketAddr, SocketAddrV4}, + sync::Arc, +}; + +use easytier_proto::acl::{ChainType, Protocol}; +use smoltcp::wire::{IpProtocol, Ipv4Packet, TcpPacket}; + +use crate::{ + gateway::proxy::{ + cidr_table::ProxyCidrTable, proxy_acl::ProxyAclHandler, + traits::WrappedTcpDestinationRuntime, + }, + packet::{PacketType, ZCPacket}, + peers::{ + acl::{filter::AclFilter, processor::PacketInfo}, + route::Route, + }, +}; + +#[async_trait::async_trait] +pub trait WrappedTcpPeerGroupResolver: Send + Sync { + async fn get_peer_groups_by_ip(&self, ip: &IpAddr) -> Arc>; +} + +#[async_trait::async_trait] +impl WrappedTcpPeerGroupResolver for T +where + T: Route + Send + Sync + ?Sized, +{ + async fn get_peer_groups_by_ip(&self, ip: &IpAddr) -> Arc> { + Route::get_peer_groups_by_ip(self, ip).await + } +} + +#[derive(Debug, Clone, Copy)] +pub struct WrappedTcpDestinationRequest { + pub src: SocketAddr, + pub dst: SocketAddr, + pub initial_packet_size: usize, +} + +#[derive(Clone)] +pub struct WrappedTcpDestinationPlan { + pub socket_dst: SocketAddr, + pub acl_handler: ProxyAclHandler, +} + +pub async fn plan_wrapped_tcp_destination( + request: WrappedTcpDestinationRequest, + cidr_table: &ProxyCidrTable, + runtime: &dyn WrappedTcpDestinationRuntime, + group_resolver: &GroupResolver, + acl_filter: Arc, +) -> anyhow::Result +where + GroupResolver: WrappedTcpPeerGroupResolver + ?Sized, +{ + let mut mapped_dst = request.dst; + if let IpAddr::V4(dst_ip) = mapped_dst.ip() + && let Some(real_ip) = cidr_table.lookup_v4(dst_ip) + { + mapped_dst.set_ip(real_ip.into()); + } + + let src_ip = request.src.ip(); + let dst_ip = mapped_dst.ip(); + let (src_groups, dst_groups) = tokio::join!( + group_resolver.get_peer_groups_by_ip(&src_ip), + group_resolver.get_peer_groups_by_ip(&dst_ip), + ); + + if runtime.should_deny_tcp_proxy(mapped_dst) { + anyhow::bail!( + "dst socket {:?} is in running listeners, ignore it", + mapped_dst + ); + } + + let send_to_self = runtime.is_ip_local_virtual_ip(&dst_ip); + let socket_dst = if send_to_self && runtime.no_tun() { + SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), mapped_dst.port()) + } else { + mapped_dst + }; + + let acl_handler = ProxyAclHandler { + acl_filter, + packet_info: PacketInfo { + src_ip, + dst_ip, + src_port: Some(request.src.port()), + dst_port: Some(socket_dst.port()), + protocol: Protocol::Tcp, + packet_size: request.initial_packet_size, + src_groups, + dst_groups, + }, + chain_type: if send_to_self { + ChainType::Inbound + } else { + ChainType::Forward + }, + }; + acl_handler.handle_packet_size(request.initial_packet_size)?; + + Ok(WrappedTcpDestinationPlan { + socket_dst, + acl_handler, + }) +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum WrappedTcpProxyTransport { + Kcp, + Quic, +} + +#[derive(Debug, Clone, Copy)] +pub struct WrappedTcpProxyNicContext { + pub transport: WrappedTcpProxyTransport, + pub my_peer_id: u32, + pub local_ipv4: Option, + pub smoltcp_enabled: bool, +} + +pub async fn try_process_wrapped_tcp_packet_from_nic( + zc_packet: &mut ZCPacket, + ctx: WrappedTcpProxyNicContext, + is_tcp_proxy_flow: ConnectionLookup, + check_dst_allowed: AllowCheck, +) -> bool +where + ConnectionLookup: Fn(SocketAddr, SocketAddr) -> bool, + AllowCheck: FnOnce(Ipv4Addr) -> AllowCheckFut, + AllowCheckFut: Future, +{ + let Some(hdr) = zc_packet.peer_manager_header() else { + return false; + }; + if hdr.packet_type != PacketType::Data as u8 { + return false; + } + + let Ok(ip_packet) = Ipv4Packet::new_checked(zc_packet.payload()) else { + return false; + }; + if ip_packet.version() != 4 || ip_packet.next_header() != IpProtocol::Tcp { + return false; + } + + let Ok(tcp_packet) = TcpPacket::new_checked(ip_packet.payload()) else { + return false; + }; + let src_ip = ip_packet.src_addr(); + let dst_ip = ip_packet.dst_addr(); + let src_port = tcp_packet.src_port(); + let dst_port = tcp_packet.dst_port(); + let is_syn = tcp_packet.syn() && !tcp_packet.ack(); + + if is_syn { + // Own virtual IP traffic must stay local; it can never reach a peer. + if ctx.local_ipv4 == Some(dst_ip) { + return false; + } + if !check_dst_allowed(dst_ip).await { + tracing::warn!( + ?ctx.transport, + dst = %dst_ip, + "wrapped tcp proxy src dst is not allowed" + ); + return false; + } + } else if !is_tcp_proxy_flow( + SocketAddr::V4(SocketAddrV4::new(src_ip, src_port)), + SocketAddr::V4(SocketAddrV4::new(dst_ip, dst_port)), + ) { + return false; + } + + if let Some(local_ipv4) = ctx.local_ipv4 + && src_ip != local_ipv4 + && !ctx.smoltcp_enabled + { + tracing::warn!( + ?ctx.transport, + src = %src_ip, + dst = %dst_ip, + "wrapped tcp proxy net-to-net input is not allowed without smoltcp" + ); + return false; + } + + let hdr = zc_packet + .mut_peer_manager_header() + .expect("peer manager header"); + hdr.to_peer_id = ctx.my_peer_id.into(); + match ctx.transport { + WrappedTcpProxyTransport::Kcp => { + hdr.mark_kcp_src_modified(); + } + WrappedTcpProxyTransport::Quic => { + hdr.mark_quic_src_modified(); + } + } + true +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::gateway::proxy::cidr_table::{ProxyCidrRule, ProxyCidrSnapshot}; + use smoltcp::wire::{IpAddress, IpProtocol, Ipv4Packet, TcpPacket}; + + struct TestDestinationRuntime { + local_ip: IpAddr, + no_tun: bool, + denied: Option, + } + + impl WrappedTcpDestinationRuntime for TestDestinationRuntime { + fn is_ip_local_virtual_ip(&self, ip: &IpAddr) -> bool { + *ip == self.local_ip + } + + fn no_tun(&self) -> bool { + self.no_tun + } + + fn should_deny_tcp_proxy(&self, dst: SocketAddr) -> bool { + self.denied == Some(dst) + } + } + + struct TestGroupResolver; + + #[async_trait::async_trait] + impl WrappedTcpPeerGroupResolver for TestGroupResolver { + async fn get_peer_groups_by_ip(&self, ip: &IpAddr) -> Arc> { + Arc::new(vec![format!("group-{ip}")]) + } + } + + fn destination_runtime(local_ip: &str, no_tun: bool) -> TestDestinationRuntime { + TestDestinationRuntime { + local_ip: local_ip.parse().unwrap(), + no_tun, + denied: None, + } + } + + fn mapped_cidr_table() -> ProxyCidrTable { + ProxyCidrTable::from_snapshot(ProxyCidrSnapshot { + rules: vec![ProxyCidrRule { + cidr: "10.10.0.0/16".parse().unwrap(), + mapped_cidr: Some("100.64.0.0/16".parse().unwrap()), + }], + }) + } + + async fn destination_plan( + runtime: &TestDestinationRuntime, + dst: &str, + ) -> anyhow::Result { + plan_wrapped_tcp_destination( + WrappedTcpDestinationRequest { + src: "10.20.0.2:40000".parse().unwrap(), + dst: dst.parse().unwrap(), + initial_packet_size: b"header".len(), + }, + &mapped_cidr_table(), + runtime, + &TestGroupResolver, + Arc::new(AclFilter::new()), + ) + .await + } + + #[tokio::test] + async fn destination_plan_maps_cidr_and_builds_forward_acl_context() { + let plan = destination_plan(&destination_runtime("10.30.0.1", false), "100.64.2.3:443") + .await + .unwrap(); + + assert_eq!(plan.socket_dst, "10.10.2.3:443".parse().unwrap()); + assert_eq!(plan.acl_handler.chain_type, ChainType::Forward); + assert_eq!( + plan.acl_handler.packet_info.dst_ip, + "10.10.2.3".parse::().unwrap() + ); + assert_eq!( + plan.acl_handler.packet_info.dst_groups.as_ref(), + &["group-10.10.2.3"] + ); + } + + #[tokio::test] + async fn destination_plan_rewrites_local_no_tun_socket_after_acl_identity() { + let plan = destination_plan(&destination_runtime("10.10.2.3", true), "100.64.2.3:443") + .await + .unwrap(); + + assert_eq!(plan.socket_dst, "127.0.0.1:443".parse().unwrap()); + assert_eq!(plan.acl_handler.chain_type, ChainType::Inbound); + assert_eq!( + plan.acl_handler.packet_info.dst_ip, + "10.10.2.3".parse::().unwrap() + ); + } + + #[tokio::test] + async fn destination_plan_denies_mapped_running_listener() { + let mut runtime = destination_runtime("10.30.0.1", false); + runtime.denied = Some("10.10.2.3:443".parse().unwrap()); + + let err = destination_plan(&runtime, "100.64.2.3:443") + .await + .err() + .expect("mapped listener must be denied"); + assert!(err.to_string().contains("running listeners")); + } + + fn build_tcp_packet(src: SocketAddrV4, dst: SocketAddrV4, syn: bool, ack: bool) -> ZCPacket { + let mut raw = vec![0; smoltcp::wire::IPV4_HEADER_LEN + smoltcp::wire::TCP_HEADER_LEN]; + { + let mut ipv4 = Ipv4Packet::new_unchecked(&mut raw); + ipv4.set_version(4); + ipv4.set_header_len(smoltcp::wire::IPV4_HEADER_LEN as u8); + ipv4.set_total_len( + (smoltcp::wire::IPV4_HEADER_LEN + smoltcp::wire::TCP_HEADER_LEN) as u16, + ); + ipv4.set_hop_limit(64); + ipv4.set_next_header(IpProtocol::Tcp); + ipv4.set_src_addr(*src.ip()); + ipv4.set_dst_addr(*dst.ip()); + ipv4.fill_checksum(); + } + { + let mut tcp = TcpPacket::new_unchecked(&mut raw[smoltcp::wire::IPV4_HEADER_LEN..]); + tcp.set_src_port(src.port()); + tcp.set_dst_port(dst.port()); + tcp.set_header_len(smoltcp::wire::TCP_HEADER_LEN as u8); + tcp.set_syn(syn); + tcp.set_ack(ack); + tcp.fill_checksum(&IpAddress::Ipv4(*src.ip()), &IpAddress::Ipv4(*dst.ip())); + } + + let mut packet = ZCPacket::new_with_payload(&raw); + packet.fill_peer_manager_hdr(1, 2, PacketType::Data as u8); + packet + } + + fn context(transport: WrappedTcpProxyTransport) -> WrappedTcpProxyNicContext { + WrappedTcpProxyNicContext { + transport, + my_peer_id: 42, + local_ipv4: Some("10.144.144.204".parse().unwrap()), + smoltcp_enabled: false, + } + } + + #[tokio::test] + async fn allowed_syn_is_marked_for_kcp() { + let src = SocketAddrV4::new("10.144.144.204".parse().unwrap(), 50000); + let dst = SocketAddrV4::new("10.10.10.10".parse().unwrap(), 80); + let mut packet = build_tcp_packet(src, dst, true, false); + + assert!( + try_process_wrapped_tcp_packet_from_nic( + &mut packet, + context(WrappedTcpProxyTransport::Kcp), + |_, _| false, + |_| async { true }, + ) + .await + ); + + let hdr = packet.peer_manager_header().unwrap(); + assert_eq!(hdr.to_peer_id.get(), 42); + assert!(hdr.is_kcp_src_modified()); + } + + #[tokio::test] + async fn denied_syn_is_not_marked() { + let src = SocketAddrV4::new("10.144.144.204".parse().unwrap(), 50000); + let dst = SocketAddrV4::new("10.10.10.10".parse().unwrap(), 80); + let mut packet = build_tcp_packet(src, dst, true, false); + + assert!( + !try_process_wrapped_tcp_packet_from_nic( + &mut packet, + context(WrappedTcpProxyTransport::Kcp), + |_, _| false, + |_| async { false }, + ) + .await + ); + + let hdr = packet.peer_manager_header().unwrap(); + assert_eq!(hdr.packet_type, PacketType::Data as u8); + } + + #[tokio::test] + async fn established_non_syn_is_marked_for_quic() { + let src = SocketAddrV4::new("10.144.144.204".parse().unwrap(), 50000); + let dst = SocketAddrV4::new("10.10.10.10".parse().unwrap(), 80); + let mut packet = build_tcp_packet(src, dst, false, true); + + assert!( + try_process_wrapped_tcp_packet_from_nic( + &mut packet, + context(WrappedTcpProxyTransport::Quic), + |src_addr, dst_addr| { + src_addr == SocketAddr::V4(src) && dst_addr == SocketAddr::V4(dst) + }, + |_| async { false }, + ) + .await + ); + + let hdr = packet.peer_manager_header().unwrap(); + assert_eq!(hdr.to_peer_id.get(), 42); + assert!(hdr.is_quic_src_modified()); + } + + #[tokio::test] + async fn non_syn_without_connection_is_rejected() { + let src = SocketAddrV4::new("10.144.144.204".parse().unwrap(), 50000); + let dst = SocketAddrV4::new("10.10.10.10".parse().unwrap(), 80); + let mut packet = build_tcp_packet(src, dst, false, true); + + assert!( + !try_process_wrapped_tcp_packet_from_nic( + &mut packet, + context(WrappedTcpProxyTransport::Quic), + |_, _| false, + |_| async { true }, + ) + .await + ); + } + + #[tokio::test] + async fn net_to_net_without_smoltcp_is_rejected() { + let src = SocketAddrV4::new("10.144.144.205".parse().unwrap(), 50000); + let dst = SocketAddrV4::new("10.10.10.10".parse().unwrap(), 80); + let mut packet = build_tcp_packet(src, dst, true, false); + + assert!( + !try_process_wrapped_tcp_packet_from_nic( + &mut packet, + context(WrappedTcpProxyTransport::Kcp), + |_, _| false, + |_| async { true }, + ) + .await + ); + } + + #[tokio::test] + async fn own_virtual_ip_syn_is_not_marked() { + let own_ip = "10.144.144.204".parse().unwrap(); + let src = SocketAddrV4::new(own_ip, 50000); + let dst = SocketAddrV4::new(own_ip, 80); + + for transport in [ + WrappedTcpProxyTransport::Kcp, + WrappedTcpProxyTransport::Quic, + ] { + let mut packet = build_tcp_packet(src, dst, true, false); + + assert!( + !try_process_wrapped_tcp_packet_from_nic( + &mut packet, + context(transport), + |_, _| false, + |_| async { true }, + ) + .await + ); + + assert_eq!( + packet.peer_manager_header().unwrap().packet_type, + PacketType::Data as u8 + ); + } + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport.rs b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport.rs new file mode 100644 index 0000000..02280ae --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport.rs @@ -0,0 +1,1142 @@ +use std::sync::{Arc, Weak}; + +use async_trait::async_trait; +use bytes::BytesMut; +use tokio::{sync::Mutex, task::JoinSet}; + +use crate::{ + config::runtime::CoreRuntimeConfigStore, + connectivity::direct::DirectConnectorHost, + connectivity::hole_punch::tcp::TcpHolePunchHost, + gateway::proxy::cidr_table::ProxyCidrTable, + listener::RunningListenerRegistry, + packet::{PacketType, ZCPacket, ZCPacketType}, + peers::{ + PeerPacketFilter, + peer_manager::{PeerManagerCore, PipelineRegistrationGuard}, + }, + process_runtime::ProtectedTcpPortRegistry, + socket::SocketContext, +}; + +#[cfg(all(feature = "proxy-packet", any(feature = "proxy-smoltcp-stack", test)))] +mod connect_api; +mod engine_api; +#[cfg(feature = "proxy-packet")] +mod packet_api; +#[cfg(feature = "proxy-packet")] +#[path = "wrapped_transport/packet_plane.rs"] +mod packet_plane; +#[cfg(not(feature = "proxy-packet"))] +#[path = "wrapped_transport/packet_plane_disabled.rs"] +mod packet_plane; + +#[cfg(feature = "proxy-packet")] +pub use engine_api::{WrappedTransportAcceptedStream, WrappedTransportConnect}; +pub use engine_api::{WrappedTransportEngine, WrappedTransportEngineStart}; +#[cfg(feature = "proxy-packet")] +pub use packet_plane::WrappedTransportDestinationIngress; +use packet_plane::{WrappedTransportPacketPlane, WrappedTransportPacketState}; + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub struct WrappedTransportDirections { + pub source: bool, + pub destination: bool, +} + +impl WrappedTransportDirections { + fn enabled(self) -> bool { + self.source || self.destination + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum WrappedTransportKind { + Kcp, + Quic, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum WrappedTransportRole { + Source, + Destination, +} + +#[derive(Debug, Clone)] +pub struct WrappedTransportDatagram { + pub transport: WrappedTransportKind, + pub role: WrappedTransportRole, + pub peer_id: u32, + pub buffer: WrappedTransportDatagramBuffer, +} + +#[derive(Debug, Clone)] +pub struct WrappedTransportDatagramBuffer(ZCPacket); + +impl WrappedTransportDatagramBuffer { + pub fn copy_from_payload(payload: &[u8]) -> Self { + Self(ZCPacket::new_with_payload(payload)) + } + + pub fn from_packet_buffer(buffer: BytesMut, packet_type: ZCPacketType) -> Self { + Self(ZCPacket::new_from_buf(buffer, packet_type)) + } +} + +impl WrappedTransportDatagram { + fn into_packet(self, my_peer_id: u32) -> ZCPacket { + let mut packet = self.buffer.0; + packet.fill_peer_manager_hdr( + my_peer_id, + self.peer_id, + self.transport.packet_type(self.role) as u8, + ); + packet + } +} + +#[derive(Default)] +pub struct WrappedTransportEngines { + pub kcp: Option>, + pub quic: Option>, +} + +#[derive(Default)] +struct WrappedTransportProxyState { + active: bool, + kcp_started: bool, + quic_started: bool, + packet: WrappedTransportPacketState, + pipeline_guards: Vec, + tasks: JoinSet<()>, +} + +impl WrappedTransportProxyState { + fn has_partial_start(&self, packet_plane: &WrappedTransportPacketPlane) -> bool { + self.kcp_started + || self.quic_started + || !self.pipeline_guards.is_empty() + || !self.tasks.is_empty() + || packet_plane.has_partial_start(&self.packet) + } +} + +impl WrappedTransportKind { + fn packet_type(self, role: WrappedTransportRole) -> PacketType { + match (self, role) { + (Self::Kcp, WrappedTransportRole::Source) => PacketType::KcpSrc, + (Self::Kcp, WrappedTransportRole::Destination) => PacketType::KcpDst, + (Self::Quic, WrappedTransportRole::Source) => PacketType::QuicSrc, + (Self::Quic, WrappedTransportRole::Destination) => PacketType::QuicDst, + } + } + + fn incoming_packet_type(self, role: WrappedTransportRole) -> PacketType { + match role { + WrappedTransportRole::Source => self.packet_type(WrappedTransportRole::Destination), + WrappedTransportRole::Destination => self.packet_type(WrappedTransportRole::Source), + } + } +} + +struct WrappedTransportPeerFilter { + engine: Weak, + transport: WrappedTransportKind, + role: WrappedTransportRole, +} + +#[async_trait] +impl PeerPacketFilter for WrappedTransportPeerFilter { + async fn try_process_packet_from_peer(&self, packet: ZCPacket) -> Option { + let Some(header) = packet.peer_manager_header() else { + return Some(packet); + }; + if header.packet_type != self.transport.incoming_packet_type(self.role) as u8 { + return Some(packet); + } + let Some(engine) = self.engine.upgrade() else { + return Some(packet); + }; + let from_peer_id = header.from_peer_id.get(); + if let Err(error) = engine + .inject_peer_datagram(self.role, from_peer_id, packet.payload_bytes().freeze()) + .await + { + tracing::debug!( + ?error, + transport = ?self.transport, + role = ?self.role, + "failed to inject wrapped transport packet" + ); + } + None + } +} + +pub(crate) struct WrappedTransportProxyModule { + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + kcp: Option>, + quic: Option>, + packet_plane: WrappedTransportPacketPlane, + state: Mutex, +} + +impl WrappedTransportProxyModule { + const DATAGRAM_QUEUE_CAPACITY: usize = 1024; + + #[allow(clippy::too_many_arguments)] + pub(crate) fn new( + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + kcp: Option>, + quic: Option>, + host: Arc, + protected_tcp_ports: Arc, + running_listeners: Arc, + cidr_table: Arc, + socket_context: SocketContext, + ) -> Option> + where + H: DirectConnectorHost + TcpHolePunchHost, + { + if kcp.is_none() && quic.is_none() { + return None; + } + let packet_plane = WrappedTransportPacketPlane::new( + peer_manager.clone(), + runtime_config.clone(), + &kcp, + &quic, + host, + protected_tcp_ports, + running_listeners, + cidr_table, + socket_context, + ); + Some(Arc::new(Self { + peer_manager, + runtime_config, + kcp, + quic, + packet_plane, + state: Mutex::new(WrappedTransportProxyState::default()), + })) + } + + fn directions(&self) -> (WrappedTransportDirections, WrappedTransportDirections) { + let snapshot = self.runtime_config.snapshot(); + let flags = &snapshot.peer.flags; + ( + WrappedTransportDirections { + source: flags.enable_kcp_proxy, + destination: !flags.disable_kcp_input, + }, + WrappedTransportDirections { + source: flags.enable_quic_proxy, + destination: !flags.disable_quic_input, + }, + ) + } + + fn spawn_datagram_egress( + &self, + state: &mut WrappedTransportProxyState, + ) -> tokio::sync::mpsc::Sender { + let (tx, mut rx) = + tokio::sync::mpsc::channel::(Self::DATAGRAM_QUEUE_CAPACITY); + let peer_manager = self.peer_manager.clone(); + state.tasks.spawn(async move { + while let Some(datagram) = rx.recv().await { + let peer_id = datagram.peer_id; + let transport = datagram.transport; + let role = datagram.role; + let packet = datagram.into_packet(peer_manager.my_peer_id()); + if let Err(error) = peer_manager.send_msg_for_proxy(packet, peer_id).await { + tracing::error!( + ?error, + ?transport, + ?role, + peer_id, + "failed to send wrapped transport packet" + ); + } + } + }); + tx + } + + async fn register_peer_filters( + &self, + state: &mut WrappedTransportProxyState, + engine: &Arc, + transport: WrappedTransportKind, + directions: WrappedTransportDirections, + ) { + if directions.source { + let guard = self + .peer_manager + .add_managed_packet_process_pipeline(Box::new(WrappedTransportPeerFilter { + engine: Arc::downgrade(engine), + transport, + role: WrappedTransportRole::Source, + })) + .await; + state.pipeline_guards.push(guard); + } + if directions.destination { + let guard = self + .peer_manager + .add_managed_packet_process_pipeline(Box::new(WrappedTransportPeerFilter { + engine: Arc::downgrade(engine), + transport, + role: WrappedTransportRole::Destination, + })) + .await; + state.pipeline_guards.push(guard); + } + } + + async fn stop_started(&self, state: &mut WrappedTransportProxyState) { + self.packet_plane.clear_connect_ready(&mut state.packet); + for guard in state.pipeline_guards.drain(..).rev() { + guard.close(); + } + if state.quic_started { + self.packet_plane + .stop_source(&mut state.packet, WrappedTransportKind::Quic) + .await; + if let Some(quic) = &self.quic { + quic.stop().await; + } + state.quic_started = false; + } + if state.kcp_started { + self.packet_plane + .stop_source(&mut state.packet, WrappedTransportKind::Kcp) + .await; + if let Some(kcp) = &self.kcp { + kcp.stop().await; + } + state.kcp_started = false; + } + self.packet_plane.stop_destination(&mut state.packet).await; + state.tasks.shutdown().await; + state.active = false; + } + + pub(crate) async fn start(&self) -> anyhow::Result<()> { + let mut state = self.state.lock().await; + if state.active { + return Ok(()); + } + if state.has_partial_start(&self.packet_plane) { + self.stop_started(&mut state).await; + } + let (kcp_directions, quic_directions) = self.directions(); + if let Err(error) = self + .packet_plane + .start_destinations( + &mut state.packet, + kcp_directions, + quic_directions, + self.kcp.is_some(), + self.quic.is_some(), + ) + .await + { + self.stop_started(&mut state).await; + return Err(error); + } + + if let Some(kcp) = &self.kcp + && kcp_directions.enabled() + { + let datagrams = self.spawn_datagram_egress(&mut state); + state.kcp_started = true; + let options = self.packet_plane.engine_start( + &state.packet, + WrappedTransportKind::Kcp, + kcp_directions, + self.peer_manager.my_peer_id(), + datagrams, + ); + if let Err(error) = kcp.prepare(options).await { + self.stop_started(&mut state).await; + return Err(error); + } + self.register_peer_filters(&mut state, kcp, WrappedTransportKind::Kcp, kcp_directions) + .await; + if let Err(error) = self + .packet_plane + .start_source(&mut state.packet, WrappedTransportKind::Kcp, kcp_directions) + .await + { + self.stop_started(&mut state).await; + return Err(error); + } + if let Err(error) = kcp.activate().await { + self.stop_started(&mut state).await; + return Err(error); + } + self.packet_plane.mark_source_connect_ready( + &mut state.packet, + WrappedTransportKind::Kcp, + kcp_directions, + ); + } + if let Some(quic) = &self.quic + && quic_directions.enabled() + { + let datagrams = self.spawn_datagram_egress(&mut state); + state.quic_started = true; + let options = self.packet_plane.engine_start( + &state.packet, + WrappedTransportKind::Quic, + quic_directions, + self.peer_manager.my_peer_id(), + datagrams, + ); + if let Err(error) = quic.prepare(options).await { + self.stop_started(&mut state).await; + return Err(error); + } + self.register_peer_filters( + &mut state, + quic, + WrappedTransportKind::Quic, + quic_directions, + ) + .await; + if let Err(error) = self + .packet_plane + .start_source( + &mut state.packet, + WrappedTransportKind::Quic, + quic_directions, + ) + .await + { + self.stop_started(&mut state).await; + return Err(error); + } + if let Err(error) = quic.activate().await { + self.stop_started(&mut state).await; + return Err(error); + } + self.packet_plane.mark_source_connect_ready( + &mut state.packet, + WrappedTransportKind::Quic, + quic_directions, + ); + } + state.active = true; + Ok(()) + } + + pub(crate) async fn stop(&self) { + let mut state = self.state.lock().await; + self.stop_started(&mut state).await; + } +} + +#[cfg(test)] +mod tests { + use std::sync::{ + Arc, Mutex, + atomic::{AtomicUsize, Ordering}, + }; + + use bytes::Bytes; + use tokio::sync::Notify; + + #[cfg(feature = "proxy-packet")] + use crate::gateway::proxy::{ + tcp_proxy_engine::TcpNatEntrySnapshot, + traits::TcpProxyStream, + wrapped_transport_destination::{ + WrappedTransportDestinationIngresses, WrappedTransportDestinationLifecycle, + }, + }; + use crate::{ + config::peers::{HostRoutingPolicy, PeerRuntimeConfig, PeerRuntimeSnapshot}, + config::runtime::CoreRuntimeConfig, + config::{CoreConfig, NetworkIdentity, NodeConfig}, + peers::peer_manager::PortablePeerManagerConfig, + }; + + use super::*; + + #[cfg(feature = "proxy-packet")] + #[derive(Default)] + struct TestWrappedTransportDestination { + active: std::sync::atomic::AtomicBool, + enabled: std::sync::atomic::AtomicU8, + } + + #[cfg(feature = "proxy-packet")] + #[async_trait] + impl WrappedTransportDestinationLifecycle for TestWrappedTransportDestination { + async fn start( + self: Arc, + kcp: bool, + quic: bool, + ) -> anyhow::Result { + self.active + .store(true, std::sync::atomic::Ordering::Release); + self.enabled.store( + (kcp as u8) | ((quic as u8) << 1), + std::sync::atomic::Ordering::Release, + ); + Ok(WrappedTransportDestinationIngresses::default()) + } + + async fn stop(&self) { + self.active + .store(false, std::sync::atomic::Ordering::Release); + self.enabled.store(0, std::sync::atomic::Ordering::Release); + } + + fn entry_snapshots(&self, _transport: WrappedTransportKind) -> Vec { + Vec::new() + } + + fn is_started(&self, transport: WrappedTransportKind) -> bool { + let mask = match transport { + WrappedTransportKind::Kcp => 1, + WrappedTransportKind::Quic => 2, + }; + self.active.load(std::sync::atomic::Ordering::Acquire) + && self.enabled.load(std::sync::atomic::Ordering::Acquire) & mask != 0 + } + } + + impl WrappedTransportProxyModule { + fn new_without_sources( + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + kcp: Option>, + quic: Option>, + ) -> Option> { + if kcp.is_none() && quic.is_none() { + return None; + } + + #[cfg(feature = "proxy-packet")] + let packet_plane = WrappedTransportPacketPlane { + kcp_source: None, + quic_source: None, + destination: Some(Arc::new(TestWrappedTransportDestination::default())), + }; + #[cfg(not(feature = "proxy-packet"))] + let packet_plane = WrappedTransportPacketPlane::default(); + + Some(Arc::new(Self { + peer_manager, + runtime_config, + kcp, + quic, + packet_plane, + state: tokio::sync::Mutex::new(WrappedTransportProxyState::default()), + })) + } + } + + struct RecordingWrappedTransportEngine { + name: &'static str, + fail_start: bool, + events: Arc>>, + } + + struct CancelOnceStopEngine { + stop_calls: AtomicUsize, + stop_entered: Notify, + release_first_stop: Notify, + events: Arc>>, + } + + #[derive(Default)] + struct AbortOncePrepareEngine { + prepare_calls: AtomicUsize, + activate_calls: AtomicUsize, + stop_calls: AtomicUsize, + first_prepare_entered: Notify, + } + + #[derive(Default)] + struct RecordingDatagramEngine { + injections: Mutex>, + } + + #[async_trait] + impl WrappedTransportEngine for RecordingDatagramEngine { + async fn prepare(&self, _options: WrappedTransportEngineStart) -> anyhow::Result<()> { + Ok(()) + } + + async fn activate(&self) -> anyhow::Result<()> { + Ok(()) + } + + async fn inject_peer_datagram( + &self, + role: WrappedTransportRole, + from_peer_id: u32, + payload: Bytes, + ) -> anyhow::Result<()> { + self.injections + .lock() + .unwrap() + .push((role, from_peer_id, payload)); + Ok(()) + } + + #[cfg(feature = "proxy-packet")] + async fn connect_source( + &self, + _request: WrappedTransportConnect, + ) -> anyhow::Result> { + anyhow::bail!("recording engine does not open streams") + } + + async fn stop(&self) {} + } + + #[async_trait] + impl WrappedTransportEngine for CancelOnceStopEngine { + async fn prepare(&self, options: WrappedTransportEngineStart) -> anyhow::Result<()> { + self.events.lock().unwrap().push("prepare:blocking".into()); + assert_eq!( + options.directions, + WrappedTransportDirections { + source: true, + destination: true, + } + ); + Ok(()) + } + + async fn activate(&self) -> anyhow::Result<()> { + self.events.lock().unwrap().push("activate:blocking".into()); + Ok(()) + } + + async fn inject_peer_datagram( + &self, + _role: WrappedTransportRole, + _from_peer_id: u32, + _payload: Bytes, + ) -> anyhow::Result<()> { + Ok(()) + } + + #[cfg(feature = "proxy-packet")] + async fn connect_source( + &self, + _request: WrappedTransportConnect, + ) -> anyhow::Result> { + anyhow::bail!("blocking engine does not open streams") + } + + async fn stop(&self) { + let call = self.stop_calls.fetch_add(1, Ordering::AcqRel); + self.events.lock().unwrap().push("stop:blocking".into()); + if call == 0 { + self.stop_entered.notify_one(); + self.release_first_stop.notified().await; + } + } + } + + #[async_trait] + impl WrappedTransportEngine for AbortOncePrepareEngine { + async fn prepare(&self, _options: WrappedTransportEngineStart) -> anyhow::Result<()> { + if self.prepare_calls.fetch_add(1, Ordering::AcqRel) == 0 { + self.first_prepare_entered.notify_one(); + std::future::pending::<()>().await; + } + Ok(()) + } + + async fn activate(&self) -> anyhow::Result<()> { + self.activate_calls.fetch_add(1, Ordering::AcqRel); + Ok(()) + } + + async fn inject_peer_datagram( + &self, + _role: WrappedTransportRole, + _from_peer_id: u32, + _payload: Bytes, + ) -> anyhow::Result<()> { + Ok(()) + } + + #[cfg(feature = "proxy-packet")] + async fn connect_source( + &self, + _request: WrappedTransportConnect, + ) -> anyhow::Result> { + anyhow::bail!("blocking engine does not open streams") + } + + async fn stop(&self) { + self.stop_calls.fetch_add(1, Ordering::AcqRel); + } + } + + #[async_trait] + impl WrappedTransportEngine for RecordingWrappedTransportEngine { + async fn prepare(&self, options: WrappedTransportEngineStart) -> anyhow::Result<()> { + let directions = options.directions; + self.events.lock().unwrap().push(format!( + "prepare:{}:{}:{}", + self.name, directions.source, directions.destination + )); + if self.fail_start { + anyhow::bail!("{} start failed", self.name); + } + Ok(()) + } + + async fn activate(&self) -> anyhow::Result<()> { + self.events + .lock() + .unwrap() + .push(format!("activate:{}", self.name)); + Ok(()) + } + + async fn inject_peer_datagram( + &self, + _role: WrappedTransportRole, + _from_peer_id: u32, + _payload: Bytes, + ) -> anyhow::Result<()> { + Ok(()) + } + + #[cfg(feature = "proxy-packet")] + async fn connect_source( + &self, + _request: WrappedTransportConnect, + ) -> anyhow::Result> { + anyhow::bail!("recording engine does not open streams") + } + + async fn stop(&self) { + self.events + .lock() + .unwrap() + .push(format!("stop:{}", self.name)); + } + } + + fn wrapped_transport_engine( + name: &'static str, + fail_start: bool, + events: &Arc>>, + ) -> Arc { + Arc::new(RecordingWrappedTransportEngine { + name, + fail_start, + events: events.clone(), + }) + } + + fn wrapped_transport_peer_manager() -> Arc { + let (packet_tx, _packet_rx) = crate::host::packet::host_packet_channel(); + Arc::new( + PeerManagerCore::new_portable_for_test( + PortablePeerManagerConfig::new(PeerRuntimeConfig { + core: CoreConfig { + node: NodeConfig { + peer_id: Some(1), + network_name: "wrapped-transport-test".to_owned(), + ..Default::default() + }, + ..Default::default() + }, + network_identity: NetworkIdentity { + network_name: "wrapped-transport-test".to_owned(), + network_secret: Some("secret".to_owned()), + network_secret_digest: None, + }, + stun_info: Default::default(), + feature_flags: Default::default(), + secure_mode: None, + host_routing: HostRoutingPolicy::default(), + }), + packet_tx, + ) + .unwrap(), + ) + } + + fn wrapped_transport_runtime( + kcp: WrappedTransportDirections, + quic: WrappedTransportDirections, + ) -> CoreRuntimeConfigStore { + let mut peer = PeerRuntimeSnapshot::default(); + peer.flags.enable_kcp_proxy = kcp.source; + peer.flags.disable_kcp_input = !kcp.destination; + peer.flags.enable_quic_proxy = quic.source; + peer.flags.disable_quic_input = !quic.destination; + CoreRuntimeConfigStore::new(CoreRuntimeConfig::default(), Arc::new(peer)) + } + + #[tokio::test] + async fn peer_filter_maps_packet_role_and_releases_stale_engine() { + let engine = Arc::new(RecordingDatagramEngine::default()); + let dyn_engine: Arc = engine.clone(); + let filter = WrappedTransportPeerFilter { + engine: Arc::downgrade(&dyn_engine), + transport: WrappedTransportKind::Kcp, + role: WrappedTransportRole::Source, + }; + let mut packet = ZCPacket::new_with_payload(b"payload"); + packet.fill_peer_manager_hdr(7, 1, PacketType::KcpDst as u8); + + assert!(filter.try_process_packet_from_peer(packet).await.is_none()); + assert_eq!( + *engine.injections.lock().unwrap(), + [( + WrappedTransportRole::Source, + 7, + Bytes::from_static(b"payload"), + )] + ); + + drop(dyn_engine); + drop(engine); + let mut packet = ZCPacket::new_with_payload(b"stale"); + packet.fill_peer_manager_hdr(7, 1, PacketType::KcpDst as u8); + assert!(filter.try_process_packet_from_peer(packet).await.is_some()); + } + + #[test] + fn datagram_preserves_wire_packet_types() { + for (transport, role, packet_type) in [ + ( + WrappedTransportKind::Kcp, + WrappedTransportRole::Source, + PacketType::KcpSrc, + ), + ( + WrappedTransportKind::Kcp, + WrappedTransportRole::Destination, + PacketType::KcpDst, + ), + ( + WrappedTransportKind::Quic, + WrappedTransportRole::Source, + PacketType::QuicSrc, + ), + ( + WrappedTransportKind::Quic, + WrappedTransportRole::Destination, + PacketType::QuicDst, + ), + ] { + let packet = WrappedTransportDatagram { + transport, + role, + peer_id: 9, + buffer: WrappedTransportDatagramBuffer::copy_from_payload(b"wire"), + } + .into_packet(7); + let header = packet.peer_manager_header().unwrap(); + + assert_eq!(header.from_peer_id.get(), 7); + assert_eq!(header.to_peer_id.get(), 9); + assert_eq!(header.packet_type, packet_type as u8); + assert_eq!(packet.payload(), b"wire"); + } + } + + #[test] + fn packet_buffer_preserves_headroom_allocation() { + let packet = ZCPacket::new_with_payload(b"wire"); + let packet_type = packet.packet_type(); + let buffer = packet.inner(); + let allocation = buffer.as_ptr(); + + let mut packet = WrappedTransportDatagram { + transport: WrappedTransportKind::Quic, + role: WrappedTransportRole::Source, + peer_id: 9, + buffer: WrappedTransportDatagramBuffer::from_packet_buffer(buffer, packet_type), + } + .into_packet(7); + + assert_eq!(packet.mut_inner().as_ptr(), allocation); + assert_eq!(packet.payload(), b"wire"); + } + + #[tokio::test] + async fn module_reads_activation_flags_and_stops_in_reverse() { + let events = Arc::new(Mutex::new(Vec::new())); + let runtime = wrapped_transport_runtime( + WrappedTransportDirections { + source: false, + destination: false, + }, + WrappedTransportDirections { + source: false, + destination: false, + }, + ); + let module = WrappedTransportProxyModule::new_without_sources( + wrapped_transport_peer_manager(), + runtime.clone(), + Some(wrapped_transport_engine("kcp", false, &events)), + Some(wrapped_transport_engine("quic", false, &events)), + ) + .unwrap(); + + runtime.update_peer(Arc::new({ + let mut peer = PeerRuntimeSnapshot::default(); + peer.flags.enable_kcp_proxy = true; + peer.flags.disable_kcp_input = true; + peer.flags.enable_quic_proxy = false; + peer.flags.disable_quic_input = false; + peer + })); + + module.start().await.unwrap(); + module.start().await.unwrap(); + module.stop().await; + module.stop().await; + + assert_eq!( + *events.lock().unwrap(), + [ + "prepare:kcp:true:false", + "activate:kcp", + "prepare:quic:false:true", + "activate:quic", + "stop:quic", + "stop:kcp", + ] + ); + } + + #[cfg(feature = "proxy-packet")] + #[tokio::test] + async fn destination_state_only_reports_available_engines() { + let events = Arc::new(Mutex::new(Vec::new())); + let runtime = wrapped_transport_runtime( + WrappedTransportDirections { + source: false, + destination: true, + }, + WrappedTransportDirections { + source: false, + destination: true, + }, + ); + let module = WrappedTransportProxyModule::new_without_sources( + wrapped_transport_peer_manager(), + runtime, + Some(wrapped_transport_engine("kcp", false, &events)), + None, + ) + .unwrap(); + + module.start().await.unwrap(); + + assert!(module.destination_is_started(WrappedTransportKind::Kcp)); + assert!(!module.destination_is_started(WrappedTransportKind::Quic)); + module.stop().await; + } + + #[cfg(feature = "proxy-packet")] + #[tokio::test] + async fn source_connect_readiness_tracks_active_direction() { + let events = Arc::new(Mutex::new(Vec::new())); + let destination_only = WrappedTransportProxyModule::new_without_sources( + wrapped_transport_peer_manager(), + wrapped_transport_runtime( + WrappedTransportDirections { + source: false, + destination: true, + }, + WrappedTransportDirections { + source: false, + destination: false, + }, + ), + Some(wrapped_transport_engine("kcp", false, &events)), + None, + ) + .unwrap(); + destination_only.start().await.unwrap(); + assert!( + !destination_only + .source_connect_ready(WrappedTransportKind::Kcp) + .await + ); + destination_only.stop().await; + + let source = WrappedTransportProxyModule::new_without_sources( + wrapped_transport_peer_manager(), + wrapped_transport_runtime( + WrappedTransportDirections { + source: true, + destination: false, + }, + WrappedTransportDirections { + source: false, + destination: false, + }, + ), + Some(wrapped_transport_engine("kcp", false, &events)), + None, + ) + .unwrap(); + source.start().await.unwrap(); + assert!(source.source_connect_ready(WrappedTransportKind::Kcp).await); + source.stop().await; + assert!(!source.source_connect_ready(WrappedTransportKind::Kcp).await); + } + + #[tokio::test] + async fn module_rolls_back_failing_engine_and_predecessor() { + let events = Arc::new(Mutex::new(Vec::new())); + let runtime = wrapped_transport_runtime( + WrappedTransportDirections { + source: true, + destination: true, + }, + WrappedTransportDirections { + source: true, + destination: true, + }, + ); + let module = WrappedTransportProxyModule::new_without_sources( + wrapped_transport_peer_manager(), + runtime, + Some(wrapped_transport_engine("kcp", false, &events)), + Some(wrapped_transport_engine("quic", true, &events)), + ) + .unwrap(); + + assert!(module.start().await.is_err()); + + assert_eq!( + *events.lock().unwrap(), + [ + "prepare:kcp:true:true", + "activate:kcp", + "prepare:quic:true:true", + "stop:quic", + "stop:kcp", + ] + ); + } + + #[tokio::test] + async fn module_retries_cleanup_after_stop_is_cancelled() { + let events = Arc::new(Mutex::new(Vec::new())); + let blocking = Arc::new(CancelOnceStopEngine { + stop_calls: AtomicUsize::new(0), + stop_entered: Notify::new(), + release_first_stop: Notify::new(), + events: events.clone(), + }); + let runtime = wrapped_transport_runtime( + WrappedTransportDirections { + source: true, + destination: true, + }, + WrappedTransportDirections { + source: true, + destination: true, + }, + ); + let module = WrappedTransportProxyModule::new_without_sources( + wrapped_transport_peer_manager(), + runtime, + Some(wrapped_transport_engine("kcp", false, &events)), + Some(blocking.clone()), + ) + .unwrap(); + module.start().await.unwrap(); + + let stop_task = tokio::spawn({ + let module = module.clone(); + async move { module.stop().await } + }); + blocking.stop_entered.notified().await; + stop_task.abort(); + assert!(stop_task.await.unwrap_err().is_cancelled()); + + module.stop().await; + + assert_eq!(blocking.stop_calls.load(Ordering::Acquire), 2); + assert_eq!( + *events.lock().unwrap(), + [ + "prepare:kcp:true:true", + "activate:kcp", + "prepare:blocking", + "activate:blocking", + "stop:blocking", + "stop:blocking", + "stop:kcp", + ] + ); + } + + #[tokio::test] + async fn module_cleans_partial_start_before_retry() { + let events = Arc::new(Mutex::new(Vec::new())); + let blocking = Arc::new(AbortOncePrepareEngine::default()); + let runtime = wrapped_transport_runtime( + WrappedTransportDirections { + source: true, + destination: true, + }, + WrappedTransportDirections { + source: true, + destination: true, + }, + ); + let module = WrappedTransportProxyModule::new_without_sources( + wrapped_transport_peer_manager(), + runtime, + Some(wrapped_transport_engine("kcp", false, &events)), + Some(blocking.clone()), + ) + .unwrap(); + + let first_start = tokio::spawn({ + let module = module.clone(); + async move { module.start().await } + }); + blocking.first_prepare_entered.notified().await; + first_start.abort(); + assert!(first_start.await.unwrap_err().is_cancelled()); + #[cfg(feature = "proxy-packet")] + assert!(!module.source_connect_ready(WrappedTransportKind::Kcp).await); + + module.start().await.unwrap(); + + assert_eq!(blocking.prepare_calls.load(Ordering::Acquire), 2); + assert_eq!(blocking.activate_calls.load(Ordering::Acquire), 1); + assert_eq!(blocking.stop_calls.load(Ordering::Acquire), 1); + assert_eq!( + *events.lock().unwrap(), + [ + "prepare:kcp:true:true", + "activate:kcp", + "stop:kcp", + "prepare:kcp:true:true", + "activate:kcp", + ] + ); + + module.stop().await; + assert_eq!(blocking.stop_calls.load(Ordering::Acquire), 2); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/connect_api.rs b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/connect_api.rs new file mode 100644 index 0000000..143cc43 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/connect_api.rs @@ -0,0 +1,56 @@ +use std::net::SocketAddr; + +use crate::gateway::proxy::traits::TcpProxyStream; + +use super::{ + WrappedTransportKind, WrappedTransportPacketPlane, WrappedTransportPacketState, + WrappedTransportProxyModule, packet_plane::connect_wrapped_transport_source, +}; + +impl WrappedTransportPacketPlane { + fn source_connect_ready( + &self, + state: &WrappedTransportPacketState, + transport: WrappedTransportKind, + ) -> bool { + match transport { + WrappedTransportKind::Kcp => state.kcp_source_connect_ready, + WrappedTransportKind::Quic => state.quic_source_connect_ready, + } + } +} + +impl WrappedTransportProxyModule { + pub(crate) async fn source_connect_ready(&self, transport: WrappedTransportKind) -> bool { + let state = self.state.lock().await; + state.active + && self + .packet_plane + .source_connect_ready(&state.packet, transport) + } + + pub(crate) async fn connect_source( + &self, + transport: WrappedTransportKind, + src: SocketAddr, + dst: SocketAddr, + ) -> anyhow::Result> { + let engine = { + let state = self.state.lock().await; + let ready = state.active + && self + .packet_plane + .source_connect_ready(&state.packet, transport); + if !ready { + anyhow::bail!("{transport:?} source is not ready"); + } + match transport { + WrappedTransportKind::Kcp => self.kcp.clone(), + WrappedTransportKind::Quic => self.quic.clone(), + } + } + .ok_or_else(|| anyhow::anyhow!("{transport:?} engine is not available"))?; + + connect_wrapped_transport_source(&self.peer_manager, engine, src, dst).await + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/engine_api.rs b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/engine_api.rs new file mode 100644 index 0000000..1de1c48 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/engine_api.rs @@ -0,0 +1,56 @@ +#[cfg(feature = "proxy-packet")] +use std::net::SocketAddr; + +use async_trait::async_trait; +use bytes::Bytes; + +#[cfg(feature = "proxy-packet")] +use crate::gateway::proxy::{ + traits::TcpProxyStream, wrapped_transport_destination::WrappedTransportDestinationIngress, +}; + +use super::{WrappedTransportDatagram, WrappedTransportDirections, WrappedTransportRole}; + +#[derive(Clone)] +pub struct WrappedTransportEngineStart { + pub directions: WrappedTransportDirections, + pub my_peer_id: u32, + pub datagrams: tokio::sync::mpsc::Sender, + #[cfg(feature = "proxy-packet")] + pub destination_ingress: Option, +} + +#[cfg(feature = "proxy-packet")] +#[derive(Debug, Clone, Copy)] +pub struct WrappedTransportConnect { + pub my_peer_id: u32, + pub dst_peer_id: u32, + pub src: SocketAddr, + pub dst: SocketAddr, +} + +#[cfg(feature = "proxy-packet")] +pub struct WrappedTransportAcceptedStream { + pub src: SocketAddr, + pub dst: SocketAddr, + pub initial_acl_packet_size: usize, + pub stream: Box, +} + +#[async_trait] +pub trait WrappedTransportEngine: Send + Sync + 'static { + async fn prepare(&self, options: WrappedTransportEngineStart) -> anyhow::Result<()>; + async fn activate(&self) -> anyhow::Result<()>; + async fn inject_peer_datagram( + &self, + role: WrappedTransportRole, + from_peer_id: u32, + payload: Bytes, + ) -> anyhow::Result<()>; + #[cfg(feature = "proxy-packet")] + async fn connect_source( + &self, + request: WrappedTransportConnect, + ) -> anyhow::Result>; + async fn stop(&self); +} diff --git a/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/packet_api.rs b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/packet_api.rs new file mode 100644 index 0000000..d9a00a2 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/packet_api.rs @@ -0,0 +1,43 @@ +use crate::gateway::proxy::tcp_proxy_engine::TcpNatEntrySnapshot; + +use super::{WrappedTransportKind, WrappedTransportProxyModule}; + +impl WrappedTransportProxyModule { + pub(crate) fn source_entry_snapshots( + &self, + transport: WrappedTransportKind, + ) -> Vec { + match transport { + WrappedTransportKind::Kcp => self.packet_plane.kcp_source.as_ref(), + WrappedTransportKind::Quic => self.packet_plane.quic_source.as_ref(), + } + .map_or_else(Vec::new, |source| source.entry_snapshots()) + } + + pub(crate) fn source_is_started(&self, transport: WrappedTransportKind) -> bool { + match transport { + WrappedTransportKind::Kcp => self.packet_plane.kcp_source.as_ref(), + WrappedTransportKind::Quic => self.packet_plane.quic_source.as_ref(), + } + .is_some_and(|source| source.is_started()) + } + + pub(crate) fn destination_entry_snapshots( + &self, + transport: WrappedTransportKind, + ) -> Vec { + self.packet_plane + .destination + .as_ref() + .map_or_else(Vec::new, |destination| { + destination.entry_snapshots(transport) + }) + } + + pub(crate) fn destination_is_started(&self, transport: WrappedTransportKind) -> bool { + self.packet_plane + .destination + .as_ref() + .is_some_and(|destination| destination.is_started(transport)) + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/packet_plane.rs b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/packet_plane.rs new file mode 100644 index 0000000..d39eb67 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/packet_plane.rs @@ -0,0 +1,531 @@ +use std::{ + net::{IpAddr, SocketAddr}, + sync::{Arc, Mutex as StdMutex, Weak}, +}; + +use async_trait::async_trait; + +use crate::{ + config::runtime::CoreRuntimeConfigStore, + connectivity::direct::DirectConnectorHost, + connectivity::hole_punch::tcp::TcpHolePunchHost, + gateway::proxy::{ + cidr_table::ProxyCidrTable, + service::CoreProxyRuntime, + tcp_proxy_engine::{TcpNatEntrySnapshot, TcpProxyMode, TcpProxyNicContext}, + tcp_proxy_service::TcpProxyService, + traits::{ProxyRuntimeInfo, TcpProxyDestinationConnector, TcpProxyStream}, + wrapped_tcp_proxy::{ + WrappedTcpProxyNicContext, WrappedTcpProxyTransport, + try_process_wrapped_tcp_packet_from_nic, + }, + wrapped_transport_destination::{ + WrappedTransportDestinationIngresses, WrappedTransportDestinationLifecycle, + WrappedTransportDestinationModule, + }, + }, + listener::RunningListenerRegistry, + packet::ZCPacket, + peers::peer_manager::{PeerManagerCore, PipelineRegistrationGuard}, + process_runtime::ProtectedTcpPortRegistry, + socket::SocketContext, +}; + +pub use crate::gateway::proxy::wrapped_transport_destination::WrappedTransportDestinationIngress; + +use super::{ + WrappedTransportConnect, WrappedTransportDatagram, WrappedTransportDirections, + WrappedTransportEngine, WrappedTransportEngineStart, WrappedTransportKind, +}; + +#[derive(Default)] +pub(super) struct WrappedTransportPacketState { + pub(super) kcp_source_connect_ready: bool, + pub(super) quic_source_connect_ready: bool, + pub(super) kcp_source_started: bool, + pub(super) quic_source_started: bool, + pub(super) destination_started: bool, + pub(super) kcp_source_guard: Option, + pub(super) quic_source_guard: Option, + destination_ingresses: WrappedTransportDestinationIngresses, +} + +impl WrappedTransportPacketState { + fn has_partial_start(&self) -> bool { + self.kcp_source_started || self.quic_source_started || self.destination_started + } +} + +#[derive(Default)] +pub(super) struct WrappedTransportPacketPlane { + pub(super) kcp_source: Option>, + pub(super) quic_source: Option>, + pub(super) destination: Option>, +} + +#[derive(Clone)] +struct WrappedTransportSourceConnector { + peer_manager: Arc, + engine: Weak, + transport: WrappedTransportKind, +} + +pub(super) async fn connect_wrapped_transport_source( + peer_manager: &PeerManagerCore, + engine: Arc, + src: SocketAddr, + dst: SocketAddr, +) -> anyhow::Result> { + let SocketAddr::V4(dst_v4) = dst else { + anyhow::bail!("IPv6 is not supported by wrapped TCP proxy"); + }; + let dst_peer_id = peer_manager + .get_peer_map() + .get_peer_id_by_ipv4(dst_v4.ip()) + .await + .ok_or_else(|| anyhow::anyhow!("no peer found for wrapped TCP dst: {dst}"))?; + engine + .connect_source(WrappedTransportConnect { + my_peer_id: peer_manager.my_peer_id(), + dst_peer_id, + src, + dst, + }) + .await +} + +#[async_trait] +impl TcpProxyDestinationConnector for WrappedTransportSourceConnector { + type DstStream = Box; + + async fn connect(&self, src: SocketAddr, dst: SocketAddr) -> anyhow::Result { + let engine = self + .engine + .upgrade() + .ok_or_else(|| anyhow::anyhow!("wrapped transport engine is not available"))?; + connect_wrapped_transport_source(&self.peer_manager, engine, src, dst).await + } + + fn proxy_mode(&self) -> TcpProxyMode { + match self.transport { + WrappedTransportKind::Kcp => TcpProxyMode::KcpSrc, + WrappedTransportKind::Quic => TcpProxyMode::QuicSrc, + } + } +} + +type WrappedTransportSourceService = + TcpProxyService, H, WrappedTransportSourceConnector>; + +pub(super) struct WrappedTransportSource +where + H: DirectConnectorHost + TcpHolePunchHost, +{ + peer_manager: Arc, + runtime: Arc>, + host: Arc, + connector: Arc, + cidr_table: Arc, + socket_context: SocketContext, + service: StdMutex>>>, + transport: WrappedTransportKind, +} + +impl WrappedTransportSource +where + H: DirectConnectorHost + TcpHolePunchHost, +{ + #[allow(clippy::too_many_arguments)] + pub(super) fn new( + peer_manager: Arc, + host: Arc, + protected_tcp_ports: Arc, + running_listeners: Arc, + runtime_config: CoreRuntimeConfigStore, + cidr_table: Arc, + socket_context: SocketContext, + engine: &Arc, + transport: WrappedTransportKind, + ) -> Arc { + let protocol_label = match transport { + WrappedTransportKind::Kcp => "KCP", + WrappedTransportKind::Quic => "QUIC", + }; + let runtime = CoreProxyRuntime::new( + peer_manager.clone(), + host.clone(), + protected_tcp_ports, + running_listeners, + runtime_config, + protocol_label, + ); + let connector = Arc::new(WrappedTransportSourceConnector { + peer_manager: peer_manager.clone(), + engine: Arc::downgrade(engine), + transport, + }); + Arc::new(Self { + peer_manager, + runtime, + host, + connector, + cidr_table, + socket_context, + service: StdMutex::new(None), + transport, + }) + } + + fn build_service(&self) -> Arc> { + TcpProxyService::new_with_socket_context( + self.peer_manager.clone(), + self.runtime.clone(), + self.host.clone(), + self.connector.clone(), + self.cidr_table.clone(), + self.socket_context.clone(), + ) + } + + async fn start_service(self: &Arc) -> Result { + let service = { + let mut active = self.service.lock().unwrap(); + if active.is_some() { + anyhow::bail!("wrapped transport source is already started"); + } + let service = self.build_service(); + active.replace(service.clone()); + service + }; + self.runtime.latch_smoltcp(); + let guard = self + .peer_manager + .add_managed_nic_packet_process_pipeline(Box::new(WrappedTransportSourceFilter { + source: Arc::downgrade(self), + })) + .await; + service.register_peer_pipeline().await; + if let Err(error) = service.start(false).await { + guard.close(); + self.stop_service().await; + return Err(anyhow::Error::new(error)); + } + Ok(guard) + } + + async fn stop_service(&self) { + let service = self.service.lock().unwrap().take(); + if let Some(service) = service { + service.stop_and_wait().await; + } + } + + fn source_entry_snapshots(&self) -> Vec { + self.service + .lock() + .unwrap() + .as_ref() + .map_or_else(Vec::new, |service| service.engine().list_entries()) + } + + async fn try_process_nic_packet(&self, packet: &mut ZCPacket) -> bool { + let Some(service) = self.service.lock().unwrap().clone() else { + return false; + }; + let snapshot = self.runtime.proxy_runtime_snapshot(); + let engine = service.engine(); + if engine.try_process_packet_from_nic( + packet, + TcpProxyNicContext { + local_inet: snapshot.local_inet, + local_port: engine.local_port(), + my_peer_id: self.peer_manager.my_peer_id(), + smoltcp_enabled: snapshot.smoltcp_enabled, + }, + ) { + return true; + } + + let connection_engine = engine.clone(); + let peer_manager = self.peer_manager.clone(); + let transport = self.transport; + try_process_wrapped_tcp_packet_from_nic( + packet, + WrappedTcpProxyNicContext { + transport: match transport { + WrappedTransportKind::Kcp => WrappedTcpProxyTransport::Kcp, + WrappedTransportKind::Quic => WrappedTcpProxyTransport::Quic, + }, + my_peer_id: self.peer_manager.my_peer_id(), + local_ipv4: snapshot.virtual_ipv4, + smoltcp_enabled: snapshot.smoltcp_enabled, + }, + move |src, mapped_dst| connection_engine.is_tcp_proxy_flow(src, mapped_dst), + move |dst_ip| async move { + match transport { + WrappedTransportKind::Kcp => { + peer_manager + .check_allow_kcp_to_dst(&IpAddr::V4(dst_ip)) + .await + } + WrappedTransportKind::Quic => { + peer_manager + .check_allow_quic_to_dst(&IpAddr::V4(dst_ip)) + .await + } + } + }, + ) + .await + } +} + +#[async_trait] +pub(super) trait WrappedTransportSourceLifecycle: Send + Sync { + async fn start(self: Arc) -> anyhow::Result; + async fn stop(&self); + fn entry_snapshots(&self) -> Vec; + fn is_started(&self) -> bool; +} + +#[async_trait] +impl WrappedTransportSourceLifecycle for WrappedTransportSource +where + H: DirectConnectorHost + TcpHolePunchHost, +{ + async fn start(self: Arc) -> anyhow::Result { + self.start_service().await + } + + async fn stop(&self) { + self.stop_service().await; + } + + fn entry_snapshots(&self) -> Vec { + self.source_entry_snapshots() + } + + fn is_started(&self) -> bool { + self.service + .lock() + .unwrap() + .as_ref() + .is_some_and(|service| service.is_started()) + } +} + +struct WrappedTransportSourceFilter +where + H: DirectConnectorHost + TcpHolePunchHost, +{ + source: Weak>, +} + +#[async_trait] +impl crate::peers::NicPacketFilter for WrappedTransportSourceFilter +where + H: DirectConnectorHost + TcpHolePunchHost, +{ + async fn try_process_packet_from_nic(&self, packet: &mut ZCPacket) -> bool { + let Some(source) = self.source.upgrade() else { + return false; + }; + source.try_process_nic_packet(packet).await + } +} + +impl WrappedTransportPacketPlane { + pub(super) fn has_partial_start(&self, state: &WrappedTransportPacketState) -> bool { + state.has_partial_start() + } + + pub(super) fn clear_connect_ready(&self, state: &mut WrappedTransportPacketState) { + state.kcp_source_connect_ready = false; + state.quic_source_connect_ready = false; + } + + pub(super) async fn stop_source( + &self, + state: &mut WrappedTransportPacketState, + transport: WrappedTransportKind, + ) { + let (source, started, guard) = match transport { + WrappedTransportKind::Kcp => ( + &self.kcp_source, + &mut state.kcp_source_started, + &mut state.kcp_source_guard, + ), + WrappedTransportKind::Quic => ( + &self.quic_source, + &mut state.quic_source_started, + &mut state.quic_source_guard, + ), + }; + if let Some(guard) = guard.take() { + guard.close(); + } + if *started { + if let Some(source) = source { + source.stop().await; + } + *started = false; + } + } + + pub(super) async fn stop_destination(&self, state: &mut WrappedTransportPacketState) { + if state.destination_started { + if let Some(destination) = &self.destination { + destination.stop().await; + } + state.destination_started = false; + } + state.destination_ingresses = WrappedTransportDestinationIngresses::default(); + } + + pub(super) async fn start_destinations( + &self, + state: &mut WrappedTransportPacketState, + kcp_directions: WrappedTransportDirections, + quic_directions: WrappedTransportDirections, + kcp_available: bool, + quic_available: bool, + ) -> anyhow::Result<()> { + let kcp = kcp_directions.destination && kcp_available; + let quic = quic_directions.destination && quic_available; + state.destination_ingresses = if kcp || quic { + state.destination_started = true; + self.destination + .as_ref() + .expect("wrapped destination owner must match its engines") + .clone() + .start(kcp, quic) + .await? + } else { + WrappedTransportDestinationIngresses::default() + }; + Ok(()) + } + + pub(super) fn engine_start( + &self, + state: &WrappedTransportPacketState, + transport: WrappedTransportKind, + directions: WrappedTransportDirections, + my_peer_id: u32, + datagrams: tokio::sync::mpsc::Sender, + ) -> WrappedTransportEngineStart { + let destination_ingress = match transport { + WrappedTransportKind::Kcp => state.destination_ingresses.kcp.clone(), + WrappedTransportKind::Quic => state.destination_ingresses.quic.clone(), + }; + WrappedTransportEngineStart { + directions, + my_peer_id, + datagrams, + destination_ingress, + } + } + + pub(super) async fn start_source( + &self, + state: &mut WrappedTransportPacketState, + transport: WrappedTransportKind, + directions: WrappedTransportDirections, + ) -> anyhow::Result<()> { + if !directions.source { + return Ok(()); + } + let (source, started, guard) = match transport { + WrappedTransportKind::Kcp => ( + &self.kcp_source, + &mut state.kcp_source_started, + &mut state.kcp_source_guard, + ), + WrappedTransportKind::Quic => ( + &self.quic_source, + &mut state.quic_source_started, + &mut state.quic_source_guard, + ), + }; + let Some(source) = source else { + return Ok(()); + }; + *started = true; + *guard = Some(source.clone().start().await?); + Ok(()) + } + + pub(super) fn mark_source_connect_ready( + &self, + state: &mut WrappedTransportPacketState, + transport: WrappedTransportKind, + directions: WrappedTransportDirections, + ) { + if !directions.source { + return; + } + match transport { + WrappedTransportKind::Kcp => state.kcp_source_connect_ready = true, + WrappedTransportKind::Quic => state.quic_source_connect_ready = true, + } + } + + #[allow(clippy::too_many_arguments)] + pub(super) fn new( + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + kcp: &Option>, + quic: &Option>, + host: Arc, + protected_tcp_ports: Arc, + running_listeners: Arc, + cidr_table: Arc, + socket_context: SocketContext, + ) -> Self + where + H: DirectConnectorHost + TcpHolePunchHost, + { + let kcp_source = kcp.as_ref().map(|engine| { + WrappedTransportSource::new( + peer_manager.clone(), + host.clone(), + protected_tcp_ports.clone(), + running_listeners.clone(), + runtime_config.clone(), + cidr_table.clone(), + socket_context.clone(), + engine, + WrappedTransportKind::Kcp, + ) as Arc + }); + let quic_source = quic.as_ref().map(|engine| { + WrappedTransportSource::new( + peer_manager.clone(), + host.clone(), + protected_tcp_ports.clone(), + running_listeners.clone(), + runtime_config.clone(), + cidr_table.clone(), + socket_context.clone(), + engine, + WrappedTransportKind::Quic, + ) as Arc + }); + let destination = (kcp.is_some() || quic.is_some()).then(|| { + WrappedTransportDestinationModule::new( + peer_manager, + host, + protected_tcp_ports, + running_listeners, + runtime_config, + cidr_table, + socket_context, + ) as Arc + }); + Self { + kcp_source, + quic_source, + destination, + } + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/packet_plane_disabled.rs b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/packet_plane_disabled.rs new file mode 100644 index 0000000..9b5a12a --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport/packet_plane_disabled.rs @@ -0,0 +1,97 @@ +use std::sync::Arc; + +use crate::{ + config::runtime::CoreRuntimeConfigStore, connectivity::direct::DirectConnectorHost, + connectivity::hole_punch::tcp::TcpHolePunchHost, gateway::proxy::cidr_table::ProxyCidrTable, + listener::RunningListenerRegistry, peers::peer_manager::PeerManagerCore, + process_runtime::ProtectedTcpPortRegistry, socket::SocketContext, +}; + +use super::{ + WrappedTransportDatagram, WrappedTransportDirections, WrappedTransportEngine, + WrappedTransportEngineStart, WrappedTransportKind, +}; + +#[derive(Default)] +pub(super) struct WrappedTransportPacketState; + +#[derive(Default)] +pub(super) struct WrappedTransportPacketPlane; + +impl WrappedTransportPacketPlane { + pub(super) fn has_partial_start(&self, _state: &WrappedTransportPacketState) -> bool { + false + } + + pub(super) fn clear_connect_ready(&self, _state: &mut WrappedTransportPacketState) {} + + pub(super) async fn stop_source( + &self, + _state: &mut WrappedTransportPacketState, + _transport: WrappedTransportKind, + ) { + } + + pub(super) async fn stop_destination(&self, _state: &mut WrappedTransportPacketState) {} + + pub(super) async fn start_destinations( + &self, + _state: &mut WrappedTransportPacketState, + _kcp_directions: WrappedTransportDirections, + _quic_directions: WrappedTransportDirections, + _kcp_available: bool, + _quic_available: bool, + ) -> anyhow::Result<()> { + Ok(()) + } + + pub(super) fn engine_start( + &self, + _state: &WrappedTransportPacketState, + _transport: WrappedTransportKind, + directions: WrappedTransportDirections, + my_peer_id: u32, + datagrams: tokio::sync::mpsc::Sender, + ) -> WrappedTransportEngineStart { + WrappedTransportEngineStart { + directions, + my_peer_id, + datagrams, + } + } + + pub(super) async fn start_source( + &self, + _state: &mut WrappedTransportPacketState, + _transport: WrappedTransportKind, + _directions: WrappedTransportDirections, + ) -> anyhow::Result<()> { + Ok(()) + } + + pub(super) fn mark_source_connect_ready( + &self, + _state: &mut WrappedTransportPacketState, + _transport: WrappedTransportKind, + _directions: WrappedTransportDirections, + ) { + } + + #[allow(clippy::too_many_arguments)] + pub(super) fn new( + _peer_manager: Arc, + _runtime_config: CoreRuntimeConfigStore, + _kcp: &Option>, + _quic: &Option>, + _host: Arc, + _protected_tcp_ports: Arc, + _running_listeners: Arc, + _cidr_table: Arc, + _socket_context: SocketContext, + ) -> Self + where + H: DirectConnectorHost + TcpHolePunchHost, + { + Self + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport_destination.rs b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport_destination.rs new file mode 100644 index 0000000..1c8c4c5 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/proxy/wrapped_transport_destination.rs @@ -0,0 +1,375 @@ +use std::{ + net::SocketAddr, + sync::{ + Arc, + atomic::{AtomicBool, AtomicU8, Ordering}, + }, + time::{SystemTime, UNIX_EPOCH}, +}; + +use dashmap::DashMap; +use guarden::defer; +use tokio::{sync::Mutex, task::JoinSet}; +use tokio_util::sync::CancellationToken; + +use crate::{ + config::runtime::CoreRuntimeConfigStore, connectivity::direct::DirectConnectorHost, + connectivity::hole_punch::tcp::TcpHolePunchHost, listener::RunningListenerRegistry, + peers::peer_manager::PeerManagerCore, process_runtime::ProtectedTcpPortRegistry, + socket::SocketContext, +}; + +use super::{ + cidr_table::ProxyCidrTable, + service::CoreProxyRuntime, + tcp_proxy_engine::{TcpNatEntrySnapshot, TcpNatEntryState}, + tcp_socket_connector::TcpSocketProxyConnector, + traits::TcpProxyDestinationConnector, + wrapped_tcp_proxy::{WrappedTcpDestinationRequest, plan_wrapped_tcp_destination}, + wrapped_transport::{WrappedTransportAcceptedStream, WrappedTransportKind}, +}; + +struct DestinationEntry { + transport: WrappedTransportKind, + src: SocketAddr, + dst: SocketAddr, + mapped_dst: std::sync::RwLock, + start_time: u64, + state: AtomicU8, +} + +impl DestinationEntry { + fn new(transport: WrappedTransportKind, src: SocketAddr, dst: SocketAddr) -> Self { + Self { + transport, + src, + dst, + mapped_dst: std::sync::RwLock::new(dst), + start_time: SystemTime::now() + .duration_since(UNIX_EPOCH) + .map(|duration| duration.as_secs()) + .unwrap_or_default(), + state: AtomicU8::new(TcpNatEntryState::ConnectingDst as u8), + } + } + + fn set_mapped_dst(&self, mapped_dst: SocketAddr) { + *self + .mapped_dst + .write() + .expect("wrapped destination entry mutex poisoned") = mapped_dst; + } + + fn set_state(&self, state: TcpNatEntryState) { + self.state.store(state as u8, Ordering::Release); + } + + fn snapshot(&self) -> TcpNatEntrySnapshot { + let state = match self.state.load(Ordering::Acquire) { + value if value == TcpNatEntryState::Connected as u8 => TcpNatEntryState::Connected, + _ => TcpNatEntryState::ConnectingDst, + }; + TcpNatEntrySnapshot { + src: self.src, + dst: self.dst, + mapped_dst: *self + .mapped_dst + .read() + .expect("wrapped destination entry mutex poisoned"), + start_time: self.start_time, + state, + } + } +} + +struct AcceptedDestination { + transport: WrappedTransportKind, + stream: WrappedTransportAcceptedStream, +} + +#[derive(Clone)] +pub struct WrappedTransportDestinationIngress { + transport: WrappedTransportKind, + accepted: tokio::sync::mpsc::Sender, +} + +impl WrappedTransportDestinationIngress { + pub async fn submit(&self, stream: WrappedTransportAcceptedStream) -> anyhow::Result<()> { + self.accepted + .send(AcceptedDestination { + transport: self.transport, + stream, + }) + .await + .map_err(|_| anyhow::anyhow!("wrapped destination ingress is stopped")) + } +} + +#[derive(Default)] +pub(crate) struct WrappedTransportDestinationIngresses { + pub(crate) kcp: Option, + pub(crate) quic: Option, +} + +struct DestinationRun { + cancel: CancellationToken, + supervisor: tokio::task::JoinHandle<()>, +} + +async fn stop_destination_run(run: &Mutex>) { + let mut run = run.lock().await; + if let Some(current) = run.as_mut() { + current.cancel.cancel(); + let _ = (&mut current.supervisor).await; + run.take(); + } +} + +pub(crate) struct WrappedTransportDestinationModule +where + H: DirectConnectorHost + TcpHolePunchHost, +{ + runtime: Arc>, + connector: TcpSocketProxyConnector, + cidr_table: Arc, + peer_manager: Arc, + entries: DashMap>, + run: Mutex>, + active: AtomicBool, + enabled: AtomicU8, +} + +#[async_trait::async_trait] +pub(crate) trait WrappedTransportDestinationLifecycle: Send + Sync { + async fn start( + self: Arc, + kcp: bool, + quic: bool, + ) -> anyhow::Result; + async fn stop(&self); + fn entry_snapshots(&self, transport: WrappedTransportKind) -> Vec; + fn is_started(&self, transport: WrappedTransportKind) -> bool; +} + +impl WrappedTransportDestinationModule +where + H: DirectConnectorHost + TcpHolePunchHost, +{ + const INGRESS_CAPACITY: usize = 128; + + pub(crate) fn new( + peer_manager: Arc, + host: Arc, + protected_tcp_ports: Arc, + running_listeners: Arc, + runtime_config: CoreRuntimeConfigStore, + cidr_table: Arc, + socket_context: SocketContext, + ) -> Arc { + Arc::new(Self { + runtime: CoreProxyRuntime::new( + peer_manager.clone(), + host.clone(), + protected_tcp_ports, + running_listeners, + runtime_config, + "TCP", + ), + connector: TcpSocketProxyConnector::new(host).with_socket_context(socket_context), + cidr_table, + peer_manager, + entries: DashMap::new(), + run: Mutex::new(None), + active: AtomicBool::new(false), + enabled: AtomicU8::new(0), + }) + } + + pub(crate) async fn start( + self: &Arc, + kcp: bool, + quic: bool, + ) -> anyhow::Result { + let mut run = self.run.lock().await; + if run.is_some() { + anyhow::bail!("wrapped transport destination is already started"); + } + + let (accepted, mut receiver) = tokio::sync::mpsc::channel(Self::INGRESS_CAPACITY); + let cancel = CancellationToken::new(); + let task_cancel = cancel.clone(); + let owner = Arc::downgrade(self); + let supervisor = tokio::spawn(async move { + let mut sessions = JoinSet::new(); + loop { + tokio::select! { + biased; + _ = task_cancel.cancelled() => break, + accepted = receiver.recv() => { + let Some(accepted) = accepted else { break }; + let Some(owner) = owner.upgrade() else { break }; + sessions.spawn(async move { + if let Err(error) = owner.handle_destination(accepted).await { + tracing::debug!(?error, "wrapped destination session failed"); + } + }); + } + _ = sessions.join_next(), if !sessions.is_empty() => {} + } + } + sessions.shutdown().await; + }); + self.active.store(true, Ordering::Release); + self.enabled + .store((kcp as u8) | ((quic as u8) << 1), Ordering::Release); + *run = Some(DestinationRun { cancel, supervisor }); + + let ingress = |transport| WrappedTransportDestinationIngress { + transport, + accepted: accepted.clone(), + }; + Ok(WrappedTransportDestinationIngresses { + kcp: kcp.then(|| ingress(WrappedTransportKind::Kcp)), + quic: quic.then(|| ingress(WrappedTransportKind::Quic)), + }) + } + + pub(crate) async fn stop(&self) { + self.active.store(false, Ordering::Release); + self.enabled.store(0, Ordering::Release); + stop_destination_run(&self.run).await; + self.entries.clear(); + } + + pub(crate) fn entry_snapshots( + &self, + transport: WrappedTransportKind, + ) -> Vec { + self.entries + .iter() + .filter(|entry| entry.value().transport == transport) + .map(|entry| entry.value().snapshot()) + .collect() + } + + pub(crate) fn is_started(&self, transport: WrappedTransportKind) -> bool { + let mask = match transport { + WrappedTransportKind::Kcp => 1, + WrappedTransportKind::Quic => 2, + }; + self.active.load(Ordering::Acquire) && self.enabled.load(Ordering::Acquire) & mask != 0 + } + + async fn handle_destination(&self, accepted: AcceptedDestination) -> anyhow::Result<()> { + if !self.active.load(Ordering::Acquire) { + anyhow::bail!("wrapped transport destination is not active"); + } + + let entry_id = uuid::Uuid::new_v4(); + let entry = Arc::new(DestinationEntry::new( + accepted.transport, + accepted.stream.src, + accepted.stream.dst, + )); + self.entries.insert(entry_id, entry.clone()); + defer! { + self.remove_entry(entry_id); + } + + let route = self.peer_manager.get_route(); + let plan = plan_wrapped_tcp_destination( + WrappedTcpDestinationRequest { + src: accepted.stream.src, + dst: accepted.stream.dst, + initial_packet_size: accepted.stream.initial_acl_packet_size, + }, + self.cidr_table.as_ref(), + self.runtime.as_ref(), + route.as_ref(), + self.peer_manager.acl_filter(), + ) + .await?; + entry.set_mapped_dst(plan.socket_dst); + + tracing::debug!(dst = ?plan.socket_dst, "wrapped transport connect to destination"); + let destination = self + .connector + .connect("0.0.0.0:0".parse().unwrap(), plan.socket_dst) + .await?; + entry.set_state(TcpNatEntryState::Connected); + + plan.acl_handler + .copy_bidirection_with_acl(accepted.stream.stream, destination) + .await + } + + fn remove_entry(&self, id: uuid::Uuid) { + self.entries.remove(&id); + if self.entries.capacity() - self.entries.len() > 16 { + self.entries.shrink_to_fit(); + } + } +} + +#[async_trait::async_trait] +impl WrappedTransportDestinationLifecycle for WrappedTransportDestinationModule +where + H: DirectConnectorHost + TcpHolePunchHost, +{ + async fn start( + self: Arc, + kcp: bool, + quic: bool, + ) -> anyhow::Result { + WrappedTransportDestinationModule::start(&self, kcp, quic).await + } + + async fn stop(&self) { + WrappedTransportDestinationModule::stop(self).await; + } + + fn entry_snapshots(&self, transport: WrappedTransportKind) -> Vec { + WrappedTransportDestinationModule::entry_snapshots(self, transport) + } + + fn is_started(&self, transport: WrappedTransportKind) -> bool { + WrappedTransportDestinationModule::is_started(self, transport) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use tokio::sync::Notify; + + #[tokio::test] + async fn cancelled_stop_retains_supervisor_for_retry() { + let cancel = CancellationToken::new(); + let stop_entered = Arc::new(Notify::new()); + let release_stop = Arc::new(Notify::new()); + let supervisor = tokio::spawn({ + let cancel = cancel.clone(); + let stop_entered = stop_entered.clone(); + let release_stop = release_stop.clone(); + async move { + cancel.cancelled().await; + stop_entered.notify_one(); + release_stop.notified().await; + } + }); + let run = Arc::new(Mutex::new(Some(DestinationRun { cancel, supervisor }))); + + let first_stop = tokio::spawn({ + let run = run.clone(); + async move { stop_destination_run(run.as_ref()).await } + }); + stop_entered.notified().await; + first_stop.abort(); + assert!(first_stop.await.unwrap_err().is_cancelled()); + assert!(run.lock().await.is_some()); + + release_stop.notify_one(); + stop_destination_run(run.as_ref()).await; + assert!(run.lock().await.is_none()); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/smoltcp/mod.rs b/vendor/easytier/easytier-core/src/gateway/smoltcp/mod.rs new file mode 100644 index 0000000..9e8128f --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/smoltcp/mod.rs @@ -0,0 +1,7 @@ +mod stack; +mod tokio_smoltcp; + +pub(super) use stack::{SmolTcpStack, output_dst_ip}; +pub(super) use tokio_smoltcp::{ + BufferSize, Net, NetConfig, TcpListener, UdpSocket, channel_device, +}; diff --git a/vendor/easytier/easytier-core/src/gateway/smoltcp/stack.rs b/vendor/easytier/easytier-core/src/gateway/smoltcp/stack.rs new file mode 100644 index 0000000..84aa162 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/smoltcp/stack.rs @@ -0,0 +1,194 @@ +use std::net::{IpAddr, Ipv4Addr, SocketAddr}; +use std::sync::Arc; + +use tokio::sync::{Mutex, mpsc}; +use tokio::task::JoinSet; + +use crate::packet::ZCPacket; + +use super::tokio_smoltcp::{BufferSize, Net, NetConfig, TcpListener, channel_device}; +use crate::gateway::proxy::traits::TcpProxyStream; + +pub struct SmolTcpStack { + ingress_tx: mpsc::Sender, + local_port: u16, + output_rx: Mutex>>>, + listener: Mutex, + _net: Net, + tasks: Arc>>, +} + +impl SmolTcpStack { + pub async fn new(local_ip: Ipv4Addr, local_port: u16) -> anyhow::Result> { + let tasks = Arc::new(std::sync::Mutex::new(JoinSet::new())); + let mut cap = smoltcp::phy::DeviceCapabilities::default(); + cap.max_transmission_unit = 1280; + cap.medium = smoltcp::phy::Medium::Ip; + let (dev, stack_sink, stack_stream) = channel_device::ChannelDevice::new(cap); + + let (ingress_tx, mut ingress_rx) = mpsc::channel::(1000); + tasks.lock().unwrap().spawn(async move { + while let Some(packet) = ingress_rx.recv().await { + tracing::trace!( + target: "easytier_core::gateway::stack", + ?packet, + "receive from peer send to smoltcp packet" + ); + if let Err(err) = stack_sink.send(Ok(packet.payload().to_vec())).await { + tracing::error!( + target: "easytier_core::gateway::stack", + ?err, + "send to smoltcp stack failed" + ); + } + } + tracing::error!( + target: "easytier_core::gateway::stack", + "smoltcp stack sink exited" + ); + }); + + let interface_config = smoltcp::iface::Config::new(smoltcp::wire::HardwareAddress::Ip); + let net = Net::new( + dev, + NetConfig::new( + interface_config, + format!("{local_ip}/24").parse().unwrap(), + vec![format!("{local_ip}").parse().unwrap()], + Some(BufferSize { + tcp_rx_size: 1024 * 16, + tcp_tx_size: 1024 * 16, + ..Default::default() + }), + ), + ); + net.set_any_ip(true); + let listener = net + .tcp_bind(SocketAddr::new(Ipv4Addr::UNSPECIFIED.into(), local_port)) + .await + .map_err(|error| anyhow::anyhow!("bind smoltcp listener failed: {error}"))?; + + Ok(Arc::new(Self { + ingress_tx, + local_port, + output_rx: Mutex::new(Some(stack_stream)), + listener: Mutex::new(listener), + _net: net, + tasks, + })) + } + + pub fn local_port(&self) -> u16 { + self.local_port + } + + pub async fn send_ingress(&self, packet: ZCPacket) -> anyhow::Result<()> { + self.ingress_tx + .send(packet) + .await + .map_err(|err| anyhow::anyhow!("send to smoltcp ingress failed: {:?}", err)) + } + + pub async fn take_output_rx(&self) -> anyhow::Result>> { + self.output_rx + .lock() + .await + .take() + .ok_or_else(|| anyhow::anyhow!("smoltcp output receiver already taken")) + } + + pub async fn accept(&self) -> anyhow::Result<(SocketAddr, Box)> { + let (stream, src) = self + .listener + .lock() + .await + .accept() + .await + .map_err(|error| anyhow::anyhow!("smoltcp listener accept failed: {error}"))?; + tracing::info!( + target: "easytier_core::gateway::stack", + ?src, + "smol tcp listener accepted" + ); + Ok((src, Box::new(stream))) + } +} + +impl Drop for SmolTcpStack { + fn drop(&mut self) { + self.tasks.lock().unwrap().abort_all(); + } +} + +pub fn output_dst_ip(data: &[u8]) -> anyhow::Result { + let ipv4 = smoltcp::wire::Ipv4Packet::new_checked(data) + .map_err(|err| anyhow::anyhow!("smoltcp output is not an IPv4 packet: {:?}", err))?; + Ok(IpAddr::V4(ipv4.dst_addr())) +} + +#[cfg(test)] +mod tests { + use std::time::Duration; + + use smoltcp::wire::{Ipv4Address, TcpControl, TcpSeqNumber}; + + use super::SmolTcpStack; + use crate::{ + gateway::smoltcp::tokio_smoltcp::test_utils::{TcpPackets, recv_tcp}, + packet::ZCPacket, + }; + + const LOCAL_ADDR: Ipv4Address = Ipv4Address::new(192, 88, 99, 254); + const LOCAL_PORT: u16 = 8900; + const PACKETS: TcpPackets = TcpPackets::new(LOCAL_ADDR, LOCAL_PORT); + + #[tokio::test] + async fn accepts_concurrent_connections_with_one_logical_listener() { + let stack = SmolTcpStack::new(LOCAL_ADDR, LOCAL_PORT).await.unwrap(); + let mut output = stack.take_output_rx().await.unwrap(); + let client_addr = Ipv4Address::new(192, 88, 99, 1); + + for (port, sequence) in [(40000, 1000), (40001, 2000)] { + stack + .send_ingress(ZCPacket::new_with_payload(&PACKETS.syn( + client_addr, + port, + sequence, + ))) + .await + .unwrap(); + } + + let mut syn_acks = Vec::new(); + for _ in 0..2 { + let syn_ack = recv_tcp(&mut output).await; + assert_eq!(syn_ack.control, TcpControl::Syn); + syn_acks.push((syn_ack.dst_port, syn_ack.sequence)); + } + for (port, sequence) in syn_acks { + let client_sequence = if port == 40000 { 1001 } else { 2001 }; + stack + .send_ingress(ZCPacket::new_with_payload(&PACKETS.ack( + client_addr, + port, + TcpSeqNumber(client_sequence), + sequence + 1, + ))) + .await + .unwrap(); + } + + let mut peers = Vec::new(); + let mut streams = Vec::new(); + for _ in 0..2 { + let (peer, stream) = tokio::time::timeout(Duration::from_secs(1), stack.accept()) + .await + .unwrap() + .unwrap(); + peers.push(peer.port()); + streams.push(stream); + } + peers.sort_unstable(); + assert_eq!(peers, vec![40000, 40001]); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/channel_device.rs b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/channel_device.rs new file mode 100644 index 0000000..b643bc4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/channel_device.rs @@ -0,0 +1,81 @@ +use futures::{Sink, Stream}; +use smoltcp::phy::DeviceCapabilities; +use std::{ + io, + pin::Pin, + task::{Context, Poll}, +}; +use tokio::sync::mpsc::{Receiver, Sender, channel}; +use tokio_util::sync::{PollSendError, PollSender}; + +use super::device::AsyncDevice; + +/// A device that send and receive packets using a channel. +pub struct ChannelDevice { + recv: Receiver>>, + send: PollSender>, + caps: DeviceCapabilities, +} + +pub type ChannelDeviceNewRet = ( + ChannelDevice, + Sender>>, + Receiver>, +); + +impl ChannelDevice { + /// Make a new `ChannelDevice` with the given `recv` and `send` channels. + /// + /// The `caps` is used to determine the device capabilities. `DeviceCapabilities::max_transmission_unit` must be set. + pub fn new(caps: DeviceCapabilities) -> ChannelDeviceNewRet { + let (tx1, rx1) = channel(1000); + let (tx2, rx2) = channel(1000); + ( + ChannelDevice { + send: PollSender::new(tx1), + recv: rx2, + caps, + }, + tx2, + rx1, + ) + } +} + +impl Stream for ChannelDevice { + type Item = io::Result>; + + fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + self.recv.poll_recv(cx) + } +} + +fn map_err(e: PollSendError>) -> io::Error { + io::Error::other(e) +} + +impl Sink> for ChannelDevice { + type Error = io::Error; + + fn poll_ready(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + self.send.poll_reserve(cx).map_err(map_err) + } + + fn start_send(mut self: Pin<&mut Self>, item: Vec) -> Result<(), Self::Error> { + self.send.send_item(item).map_err(map_err) + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + self.send.poll_reserve(cx).map_err(map_err) + } + + fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll> { + Poll::Ready(Ok(())) + } +} + +impl AsyncDevice for ChannelDevice { + fn capabilities(&self) -> &DeviceCapabilities { + &self.caps + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/device.rs b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/device.rs new file mode 100644 index 0000000..4df75d3 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/device.rs @@ -0,0 +1,125 @@ +use futures::{Sink, Stream}; +pub use smoltcp::phy::DeviceCapabilities; +use smoltcp::{ + phy::{Device, RxToken, TxToken}, + time::Instant, +}; +use std::{collections::VecDeque, io}; + +/// Default value of `max_burst_size`. +pub const DEFAULT_MAX_BURST_SIZE: usize = 100; + +/// A packet used in `AsyncDevice`. +pub type Packet = Vec; + +/// A device that send and receive packets asynchronously. +pub trait AsyncDevice: + Stream> + Sink + Send + Unpin +{ + /// Returns the device capabilities. + fn capabilities(&self) -> &DeviceCapabilities; +} + +impl AsyncDevice for Box +where + T: AsyncDevice, +{ + fn capabilities(&self) -> &DeviceCapabilities { + (**self).capabilities() + } +} + +/// A device that send and receive packets synchronously. +pub struct BufferDevice { + caps: DeviceCapabilities, + max_burst_size: usize, + recv_queue: VecDeque, + send_queue: VecDeque, +} + +/// RxToken for `BufferDevice`. +pub struct BufferRxToken(Packet); + +impl RxToken for BufferRxToken { + fn consume(mut self, f: F) -> R + where + F: FnOnce(&[u8]) -> R, + { + let p = &mut self.0; + + f(p) + } +} + +/// TxToken for `BufferDevice`. +pub struct BufferTxToken<'a>(&'a mut BufferDevice); + +impl<'d> TxToken for BufferTxToken<'d> { + fn consume(self, len: usize, f: F) -> R + where + F: FnOnce(&mut [u8]) -> R, + { + let mut buffer = vec![0u8; len]; + let result = f(&mut buffer); + + self.0.send_queue.push_back(buffer); + + result + } +} + +impl Device for BufferDevice { + type RxToken<'a> + = BufferRxToken + where + Self: 'a; + type TxToken<'a> + = BufferTxToken<'a> + where + Self: 'a; + + fn receive(&mut self, _timestamp: Instant) -> Option<(Self::RxToken<'_>, Self::TxToken<'_>)> { + self.recv_queue + .pop_front() + .map(|p| (BufferRxToken(p), BufferTxToken(self))) + } + + fn transmit(&mut self, _timestamp: Instant) -> Option> { + if self.send_queue.len() < self.max_burst_size { + Some(BufferTxToken(self)) + } else { + None + } + } + + fn capabilities(&self) -> DeviceCapabilities { + self.caps.clone() + } +} + +impl BufferDevice { + pub(crate) fn new(caps: DeviceCapabilities) -> BufferDevice { + let max_burst_size = caps.max_burst_size.unwrap_or(DEFAULT_MAX_BURST_SIZE); + BufferDevice { + caps, + max_burst_size, + recv_queue: VecDeque::with_capacity(max_burst_size), + send_queue: VecDeque::with_capacity(max_burst_size), + } + } + pub(crate) fn take_send_queue(&mut self) -> VecDeque { + std::mem::replace( + &mut self.send_queue, + VecDeque::with_capacity(self.max_burst_size), + ) + } + pub(crate) fn push_recv_queue(&mut self, p: impl Iterator) { + self.recv_queue.extend(p.take(self.avaliable_recv_queue())); + } + pub(crate) fn avaliable_recv_queue(&self) -> usize { + self.max_burst_size - self.recv_queue.len() + } + pub(crate) fn need_wait(&self) -> bool { + self.recv_queue.is_empty() + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/mod.rs b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/mod.rs new file mode 100644 index 0000000..2485067 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/mod.rs @@ -0,0 +1,190 @@ +// most code is copied from https://github.com/spacemeowx2/tokio-smoltcp + +//! An asynchronous wrapper for smoltcp. + +use std::{ + io, + net::SocketAddr, + sync::{ + Arc, + atomic::{AtomicU16, Ordering}, + }, +}; + +use device::BufferDevice; +use reactor::Reactor; +pub use smoltcp; +use smoltcp::{ + iface::{Config, Interface}, + time::Instant, + wire::{IpAddress, IpCidr}, +}; +pub use socket::{TcpListener, TcpStream, UdpSocket}; +pub use socket_allocator::BufferSize; +use tokio::sync::Notify; +use tokio_util::task::AbortOnDropHandle; + +/// The async devices. +pub mod channel_device; +pub mod device; +mod reactor; +mod socket; +mod socket_allocator; +#[cfg(test)] +pub(super) mod test_utils; + +/// A config for a `Net`. +/// +/// This is used to configure the `Net`. +#[non_exhaustive] +pub struct NetConfig { + pub interface_config: Config, + pub ip_addr: IpCidr, + pub gateway: Vec, + pub buffer_size: BufferSize, +} + +impl NetConfig { + pub fn new( + interface_config: Config, + ip_addr: IpCidr, + gateway: Vec, + buffer_size: Option, + ) -> Self { + Self { + interface_config, + ip_addr, + gateway, + buffer_size: buffer_size.unwrap_or_default(), + } + } +} + +/// `Net` is the main interface to the network stack. +/// Socket creation and configuration is done through the `Net` interface. +/// +/// When `Net` is dropped, all sockets are closed and the network stack is stopped. +pub struct Net { + reactor: Arc, + ip_addr: IpCidr, + from_port: AtomicU16, + stopper: Arc, + _fut: AbortOnDropHandle>, +} + +impl std::fmt::Debug for Net { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("Net") + .field("ip_addr", &self.ip_addr) + .field("from_port", &self.from_port) + .finish() + } +} + +impl Net { + /// Creates a new `Net` instance. It panics if the medium is not supported. + pub fn new(device: D, config: NetConfig) -> Net { + Self::new2(device, config) + } + + fn new2(device: D, config: NetConfig) -> Net { + let mut buffer_device = BufferDevice::new(device.capabilities().clone()); + let mut iface = Interface::new(config.interface_config, &mut buffer_device, Instant::now()); + let ip_addr = config.ip_addr; + iface.update_ip_addrs(|ip_addrs| { + ip_addrs.push(ip_addr).unwrap(); + }); + for gateway in config.gateway { + match gateway { + IpAddress::Ipv4(v4) => { + iface.routes_mut().add_default_ipv4_route(v4).unwrap(); + } + IpAddress::Ipv6(v6) => { + iface.routes_mut().add_default_ipv6_route(v6).unwrap(); + } + #[allow(unreachable_patterns)] + _ => panic!("Unsupported address"), + }; + } + + let stopper = Arc::new(Notify::new()); + let (reactor, fut) = Reactor::new( + device, + iface, + buffer_device, + config.buffer_size, + stopper.clone(), + ); + + Net { + reactor: Arc::new(reactor), + ip_addr: config.ip_addr, + from_port: AtomicU16::new(10001), + stopper, + _fut: AbortOnDropHandle::new(tokio::spawn(fut)), + } + } + pub fn get_port(&self) -> u16 { + self.from_port + .fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| { + Some(if x > 60000 { 10000 } else { x + 1 }) + }) + .unwrap() + } + /// Creates a new TcpListener, which will be bound to the specified address. + pub async fn tcp_bind(&self, addr: SocketAddr) -> io::Result { + let addr = self.set_address(addr); + TcpListener::new(self.reactor.clone(), socket_addr_to_endpoint(addr)).await + } + /// Opens a TCP connection to a remote host. + pub async fn tcp_connect(&self, addr: SocketAddr, local_port: u16) -> io::Result { + TcpStream::connect( + self.reactor.clone(), + (self.ip_addr.address(), local_port).into(), + socket_addr_to_endpoint(addr), + ) + .await + } + + /// This function will create a new UDP socket and attempt to bind it to the `addr` provided. + pub async fn udp_bind(&self, addr: SocketAddr) -> io::Result { + let addr = self.set_address(addr); + UdpSocket::new(self.reactor.clone(), socket_addr_to_endpoint(addr)).await + } + + fn set_address(&self, mut addr: SocketAddr) -> SocketAddr { + if addr.ip().is_unspecified() { + addr.set_ip(match self.ip_addr.address() { + IpAddress::Ipv4(ip) => ip.into(), + IpAddress::Ipv6(ip) => ip.into(), + #[allow(unreachable_patterns)] + _ => panic!("address must not be unspecified"), + }); + } + if addr.port() == 0 { + addr.set_port(self.get_port()); + } + addr + } + + /// Enable or disable the AnyIP capability. + pub fn set_any_ip(&self, any_ip: bool) { + let iface = self.reactor.iface().clone(); + let mut iface: parking_lot::lock_api::MutexGuard<'_, parking_lot::RawMutex, Interface> = + iface.lock(); + iface.set_any_ip(any_ip); + } +} + +fn socket_addr_to_endpoint(addr: SocketAddr) -> smoltcp::wire::IpEndpoint { + match addr { + SocketAddr::V4(addr) => addr.into(), + SocketAddr::V6(addr) => addr.into(), + } +} + +impl Drop for Net { + fn drop(&mut self) { + self.stopper.notify_waiters() + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/reactor.rs b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/reactor.rs new file mode 100644 index 0000000..46dd7f4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/reactor.rs @@ -0,0 +1,479 @@ +use super::{ + device::{BufferDevice, Packet}, + socket::TCP_LISTENER_MAX_PENDING, + socket_allocator::{ + BufferSize, SocketAlloctor, SocketHandle as OwnedSocketHandle, TCP_LISTENER_TIMEOUT, + TCP_TIMEOUT, + }, +}; +use futures::{FutureExt, SinkExt, StreamExt, stream::iter}; +use parking_lot::{MappedMutexGuard, Mutex, MutexGuard}; +use smoltcp::{ + iface::{Context, Interface, SocketHandle as SmolSocketHandle, SocketSet}, + socket::{AnySocket, Socket, tcp}, + time::{Duration, Instant}, + wire::{ + IpAddress, IpEndpoint, IpProtocol, Ipv4Packet, Ipv6ExtHeader, Ipv6ExtHeaderRepr, + Ipv6Packet, TcpPacket, + }, +}; +use std::{ + collections::VecDeque, + future::Future, + io, + sync::Arc, + task::{Context as TaskContext, Poll, Waker}, +}; +use tokio::{pin, select, sync::Notify}; + +use crate::foundation::time::sleep; + +pub(crate) type BufferInterface = Arc>; +const MAX_BURST_SIZE: usize = 100; + +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(super) struct TcpListenerId(u64); + +struct TcpListenerEntry { + id: TcpListenerId, + local_endpoint: IpEndpoint, + // Raw handles stay owned by the listener until accept transfers one to TcpStream. + pending: Vec, + accept_waker: Option, +} + +#[derive(Default)] +struct TcpListenerRegistry { + next_id: u64, + entries: Vec, +} + +type SharedTcpListenerRegistry = Arc>; + +pub(crate) struct Reactor { + notify: Arc, + iface: BufferInterface, + socket_allocator: SocketAlloctor, + tcp_listeners: SharedTcpListenerRegistry, +} + +async fn receive( + async_iface: &mut impl super::device::AsyncDevice, + recv_buf: &mut VecDeque, +) -> io::Result<()> { + if let Some(packet) = async_iface.next().await { + recv_buf.push_back(packet?); + } + Ok(()) +} + +fn tcp_syn_endpoints(packet: &[u8]) -> Option<(IpEndpoint, IpEndpoint)> { + let (src_addr, dst_addr, payload) = match packet.first()? >> 4 { + 4 => { + let packet = Ipv4Packet::new_checked(packet).ok()?; + if packet.next_header() != IpProtocol::Tcp { + return None; + } + ( + IpAddress::Ipv4(packet.src_addr()), + IpAddress::Ipv4(packet.dst_addr()), + packet.payload(), + ) + } + 6 => { + let packet = Ipv6Packet::new_checked(packet).ok()?; + let mut next_header = packet.next_header(); + let mut payload = packet.payload(); + if next_header == IpProtocol::HopByHop { + let header = Ipv6ExtHeader::new_checked(payload).ok()?; + let repr = Ipv6ExtHeaderRepr::parse(&header).ok()?; + next_header = repr.next_header; + payload = &payload[repr.header_len() + repr.data.len()..]; + } + if next_header != IpProtocol::Tcp { + return None; + } + ( + IpAddress::Ipv6(packet.src_addr()), + IpAddress::Ipv6(packet.dst_addr()), + payload, + ) + } + _ => return None, + }; + let packet = TcpPacket::new_checked(payload).ok()?; + if !packet.syn() || packet.ack() || packet.rst() || packet.fin() { + return None; + } + Some(( + IpEndpoint::new(src_addr, packet.src_port()), + IpEndpoint::new(dst_addr, packet.dst_port()), + )) +} + +fn tcp_tuple_exists( + sockets: &SocketSet<'_>, + remote_endpoint: IpEndpoint, + local_endpoint: IpEndpoint, +) -> bool { + sockets.iter().any(|(_, socket)| { + let Socket::Tcp(socket) = socket else { + return false; + }; + socket.state() != smoltcp::socket::tcp::State::Closed + && socket.remote_endpoint() == Some(remote_endpoint) + && socket.local_endpoint() == Some(local_endpoint) + }) +} + +fn tcp_listener_connection_ready(state: tcp::State) -> bool { + matches!(state, tcp::State::Established | tcp::State::CloseWait) +} + +fn prepare_tcp_listener_socket( + remote_endpoint: IpEndpoint, + local_endpoint: IpEndpoint, + listeners: &mut TcpListenerRegistry, + sockets: &mut SocketSet<'static>, + socket_allocator: &SocketAlloctor, +) -> bool { + let Some(listener) = listeners + .entries + .iter_mut() + .find(|listener| listener.local_endpoint == local_endpoint) + else { + return false; + }; + if listener.pending.len() >= TCP_LISTENER_MAX_PENDING { + return false; + } + // Keep the global lookup off the rejected-SYN path. Once pending is full, + // retransmissions can still reach their exact socket without a new Listen socket. + if tcp_tuple_exists(sockets, remote_endpoint, local_endpoint) { + return false; + } + // The socket exists only for this packet. update_tcp_listeners removes it unless + // smoltcp binds it to the SYN's four-tuple. + match socket_allocator.add_tcp_listener_socket(sockets, local_endpoint) { + Ok(handle) => { + listener.pending.push(handle); + true + } + Err(error) => { + tracing::error!( + target: "easytier_core::gateway::smoltcp", + ?error, + ?local_endpoint, + "failed to allocate TCP listener socket" + ); + false + } + } +} + +fn update_tcp_listeners( + listeners: &mut TcpListenerRegistry, + sockets: &mut SocketSet<'static>, +) -> Vec { + let mut wakers = Vec::new(); + for listener in &mut listeners.entries { + let mut index = 0; + let mut ready = false; + while index < listener.pending.len() { + let handle = listener.pending[index]; + let state = sockets.get::(handle).state(); + if matches!(state, tcp::State::Closed | tcp::State::Listen) { + listener.pending.swap_remove(index); + sockets.remove(handle); + continue; + } + if tcp_listener_connection_ready(state) { + let socket = sockets.get_mut::(handle); + if socket.timeout() == Some(TCP_LISTENER_TIMEOUT) { + socket.set_timeout(Some(TCP_TIMEOUT)); + } + ready = true; + } + index += 1; + } + if ready && let Some(waker) = listener.accept_waker.take() { + wakers.push(waker); + } + } + wakers +} + +async fn run( + mut async_iface: impl super::device::AsyncDevice, + iface: BufferInterface, + mut device: BufferDevice, + socket_allocator: SocketAlloctor, + tcp_listeners: SharedTcpListenerRegistry, + notify: Arc, + stopper: Arc, +) -> io::Result<()> { + let default_timeout = Duration::from_secs(60); + let timer = sleep(default_timeout.into()); + let max_burst_size = async_iface + .capabilities() + .max_burst_size + .unwrap_or(MAX_BURST_SIZE); + let mut recv_buf = VecDeque::with_capacity(max_burst_size); + pin!(timer); + + loop { + let packets = device.take_send_queue(); + + async_iface.send_all(&mut iter(packets).map(Ok)).await?; + + if recv_buf.is_empty() && device.need_wait() { + let start = Instant::now(); + let deadline = { + iface + .lock() + .poll_delay(start, &socket_allocator.sockets().lock()) + .unwrap_or(default_timeout) + }; + + if deadline != Duration::ZERO { + timer + .as_mut() + .reset(crate::foundation::time::Instant::now() + deadline.into()); + select! { + _ = &mut timer => {}, + _ = receive(&mut async_iface,&mut recv_buf) => {} + _ = notify.notified() => {} + _ = stopper.notified() => break, + }; + } + + while let (true, Some(Ok(p))) = ( + recv_buf.len() < max_burst_size, + async_iface.next().now_or_never().flatten(), + ) { + recv_buf.push_back(p); + } + } + + let now = Instant::now(); + let mut iface = iface.lock(); + let mut listeners = tcp_listeners.lock(); + let mut sockets = socket_allocator.sockets().lock(); + let recv_count = device.avaliable_recv_queue().min(recv_buf.len()); + let mut listener_wakers = Vec::new(); + for packet in recv_buf.drain(..recv_count) { + let listener_socket_added = + if let Some((remote_endpoint, local_endpoint)) = tcp_syn_endpoints(&packet) { + // Advance timers, reclaim stale pending sockets, and preserve packet + // order before exposing a generic Listen socket. + iface.poll(now, &mut device, &mut sockets); + listener_wakers.extend(update_tcp_listeners(&mut listeners, &mut sockets)); + prepare_tcp_listener_socket( + remote_endpoint, + local_endpoint, + &mut listeners, + &mut sockets, + &socket_allocator, + ) + } else { + false + }; + device.push_recv_queue(std::iter::once(packet)); + if listener_socket_added { + // Bind the generic Listen socket to this SYN before another packet + // can be dispatched to it. + iface.poll_ingress_single(now, &mut device, &mut sockets); + listener_wakers.extend(update_tcp_listeners(&mut listeners, &mut sockets)); + } + } + + iface.poll(now, &mut device, &mut sockets); + listener_wakers.extend(update_tcp_listeners(&mut listeners, &mut sockets)); + + // wake up all closed sockets (smoltcp seems have a bug that it doesn't wake up closed sockets) + for (_, socket) in sockets.iter_mut() { + if let Socket::Tcp(tcp) = socket + && tcp.state() == smoltcp::socket::tcp::State::Closed + { + tcp.abort(); + } + } + drop(sockets); + drop(listeners); + drop(iface); + for waker in listener_wakers { + waker.wake(); + } + } + + Ok(()) +} + +impl Reactor { + pub fn new( + async_device: impl super::device::AsyncDevice, + iface: Interface, + device: BufferDevice, + buffer_size: BufferSize, + stopper: Arc, + ) -> (Self, impl Future> + Send) { + let iface = Arc::new(Mutex::new(iface)); + let notify = Arc::new(Notify::new()); + let socket_allocator = SocketAlloctor::new(buffer_size); + let tcp_listeners = Arc::new(Mutex::new(TcpListenerRegistry::default())); + let fut = run( + async_device, + iface.clone(), + device, + socket_allocator.clone(), + tcp_listeners.clone(), + notify.clone(), + stopper, + ); + + ( + Reactor { + notify, + iface, + socket_allocator, + tcp_listeners, + }, + fut, + ) + } + pub fn get_socket>( + &self, + handle: SmolSocketHandle, + ) -> MappedMutexGuard<'_, T> { + MutexGuard::map( + self.socket_allocator.sockets().lock(), + |sockets: &mut smoltcp::iface::SocketSet<'_>| sockets.get_mut::(handle), + ) + } + pub fn context(&self) -> MappedMutexGuard<'_, Context> { + MutexGuard::map(self.iface.lock(), |iface| iface.context()) + } + pub fn socket_allocator(&self) -> &SocketAlloctor { + &self.socket_allocator + } + pub(super) fn register_tcp_listener( + &self, + local_endpoint: IpEndpoint, + ) -> io::Result { + let mut listeners = self.tcp_listeners.lock(); + if listeners + .entries + .iter() + .any(|listener| listener.local_endpoint == local_endpoint) + { + return Err(io::ErrorKind::AddrInUse.into()); + } + let id = TcpListenerId(listeners.next_id); + listeners.next_id += 1; + listeners.entries.push(TcpListenerEntry { + id, + local_endpoint, + pending: Vec::new(), + accept_waker: None, + }); + Ok(id) + } + pub(super) fn poll_tcp_accept( + &self, + id: TcpListenerId, + cx: &TaskContext<'_>, + ) -> Poll> { + let mut listeners = self.tcp_listeners.lock(); + let Some(listener) = listeners + .entries + .iter_mut() + .find(|listener| listener.id == id) + else { + return Poll::Ready(Err(io::ErrorKind::NotConnected.into())); + }; + let mut sockets = self.socket_allocator.sockets().lock(); + let mut index = 0; + while index < listener.pending.len() { + let handle = listener.pending[index]; + let (state, endpoints) = { + let socket = sockets.get::(handle); + ( + socket.state(), + (socket.remote_endpoint(), socket.local_endpoint()), + ) + }; + if matches!(state, tcp::State::Closed | tcp::State::Listen) { + listener.pending.swap_remove(index); + sockets.remove(handle); + continue; + } + if tcp_listener_connection_ready(state) { + let handle = listener.pending.swap_remove(index); + let (Some(remote_endpoint), Some(local_endpoint)) = endpoints else { + sockets.remove(handle); + return Poll::Ready(Err(io::ErrorKind::NotConnected.into())); + }; + drop(sockets); + drop(listeners); + return Poll::Ready(Ok(( + self.socket_allocator.own_socket(handle), + remote_endpoint, + local_endpoint, + ))); + } + index += 1; + } + if listener + .accept_waker + .as_ref() + .is_none_or(|waker| !waker.will_wake(cx.waker())) + { + listener.accept_waker = Some(cx.waker().clone()); + } + Poll::Pending + } + pub(super) fn unregister_tcp_listener(&self, id: TcpListenerId) { + let mut listeners = self.tcp_listeners.lock(); + let Some(index) = listeners + .entries + .iter() + .position(|listener| listener.id == id) + else { + return; + }; + let listener = listeners.entries.swap_remove(index); + let mut sockets = self.socket_allocator.sockets().lock(); + for handle in listener.pending { + sockets.remove(handle); + } + } + #[cfg(test)] + pub(super) fn tcp_listener_handles(&self, id: TcpListenerId) -> Vec { + self.tcp_listeners + .lock() + .entries + .iter() + .find(|listener| listener.id == id) + .map(|listener| listener.pending.clone()) + .unwrap_or_default() + } + pub fn notify(&self) { + // The externally driven WASI runtime can park immediately after a + // socket enqueues work. Keep one permit when the reactor has not + // reached its select yet; notify_waiters() would lose that edge. + self.notify.notify_one(); + } + pub fn iface(&self) -> &BufferInterface { + &self.iface + } +} + +impl Drop for Reactor { + fn drop(&mut self) { + for (_, socket) in self.socket_allocator.sockets().lock().iter_mut() { + if let Socket::Tcp(tcp) = socket { + tcp.close() + } + } + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/socket.rs b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/socket.rs new file mode 100644 index 0000000..714e5c4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/socket.rs @@ -0,0 +1,759 @@ +use super::{ + reactor::{Reactor, TcpListenerId}, + socket_allocator::SocketHandle, +}; +use futures::future::{self, poll_fn}; +pub use smoltcp::socket::tcp; +use smoltcp::socket::udp; +use smoltcp::wire::{IpAddress, IpEndpoint}; +use std::net::IpAddr; +use std::{ + io, + net::SocketAddr, + pin::Pin, + sync::Arc, + task::{Context, Poll}, +}; +use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; + +pub(super) const TCP_LISTENER_MAX_PENDING: usize = 16; + +/// A TCP socket server, listening for connections. +/// +/// You can accept a new connection by using the accept method. +pub struct TcpListener { + id: TcpListenerId, + reactor: Arc, + local_addr: SocketAddr, +} + +fn map_err(e: E) -> io::Error { + io::Error::other(e.to_string()) +} + +impl TcpListener { + pub(super) async fn new( + reactor: Arc, + local_endpoint: IpEndpoint, + ) -> io::Result { + let id = reactor.register_tcp_listener(local_endpoint)?; + let local_addr = ep2sa(&local_endpoint); + Ok(TcpListener { + id, + reactor, + local_addr, + }) + } + + pub fn poll_accept(&mut self, cx: &Context<'_>) -> Poll> { + match self.reactor.poll_tcp_accept(self.id, cx) { + Poll::Ready(Ok((handle, remote_endpoint, local_endpoint))) => Poll::Ready(Ok(( + TcpStream { + handle, + reactor: self.reactor.clone(), + local_addr: ep2sa(&local_endpoint), + }, + ep2sa(&remote_endpoint), + ))), + Poll::Ready(Err(error)) => Poll::Ready(Err(error)), + Poll::Pending => Poll::Pending, + } + } + pub async fn accept(&mut self) -> io::Result<(TcpStream, SocketAddr)> { + poll_fn(|cx| self.poll_accept(cx)).await + } + pub fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } +} + +impl Drop for TcpListener { + fn drop(&mut self) { + self.reactor.unregister_tcp_listener(self.id); + } +} + +fn ep2sa(ep: &IpEndpoint) -> SocketAddr { + match ep.addr { + IpAddress::Ipv4(v4) => SocketAddr::new(IpAddr::V4(v4), ep.port), + IpAddress::Ipv6(v6) => SocketAddr::new(IpAddr::V6(v6), ep.port), + #[allow(unreachable_patterns)] + _ => unreachable!(), + } +} + +fn sa2ep(addr: SocketAddr) -> IpEndpoint { + match addr { + SocketAddr::V4(addr) => addr.into(), + SocketAddr::V6(addr) => addr.into(), + } +} + +/// A TCP stream between a local and a remote socket. +pub struct TcpStream { + handle: SocketHandle, + reactor: Arc, + local_addr: SocketAddr, +} + +impl TcpStream { + pub(super) async fn connect( + reactor: Arc, + local_endpoint: IpEndpoint, + remote_endpoint: IpEndpoint, + ) -> io::Result { + let handle = reactor.socket_allocator().new_tcp_socket(); + + // see https://github.com/spacemeowx2/tokio-smoltcp/pull/12 + let connect_result = { + // Issue #11. We must lock the context before we call connect to + // avoid lock inversion deadlocks, but drop it before constructing + // the TcpStream to avoid a second mutable borror of the reactor. + let mut context = reactor.context(); + reactor.get_socket::(*handle).connect( + &mut context, + remote_endpoint, + local_endpoint, + ) + }; + connect_result.map_err(map_err)?; + + let local_addr = ep2sa(&local_endpoint); + let tcp = TcpStream { + handle, + reactor, + local_addr, + }; + + tcp.reactor.notify(); + future::poll_fn(|cx| tcp.poll_connected(cx)).await?; + + Ok(tcp) + } + + pub fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + pub fn poll_connected(&self, cx: &Context<'_>) -> Poll> { + let mut socket = self.reactor.get_socket::(*self.handle); + if socket.state() == tcp::State::Established { + return Poll::Ready(Ok(())); + } + socket.register_send_waker(cx.waker()); + Poll::Pending + } +} + +impl AsyncRead for TcpStream { + fn poll_read( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + let mut socket = self.reactor.get_socket::(*self.handle); + if !socket.may_recv() { + return Poll::Ready(Ok(())); + } + if socket.can_recv() { + let read = socket + .recv_slice(buf.initialize_unfilled()) + .map_err(map_err)?; + self.reactor.notify(); + buf.advance(read); + return Poll::Ready(Ok(())); + } + socket.register_recv_waker(cx.waker()); + Poll::Pending + } +} + +impl AsyncWrite for TcpStream { + fn poll_write( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + let mut socket = self.reactor.get_socket::(*self.handle); + if !socket.may_send() { + return Poll::Ready(Err(io::ErrorKind::BrokenPipe.into())); + } + if socket.can_send() { + let r = socket.send_slice(buf).map_err(map_err)?; + self.reactor.notify(); + return Poll::Ready(Ok(r)); + } + socket.register_send_waker(cx.waker()); + Poll::Pending + } + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let mut socket = self.reactor.get_socket::(*self.handle); + if !socket.may_send() { + return Poll::Ready(Err(io::ErrorKind::BrokenPipe.into())); + } + if socket.send_queue() == 0 { + return Poll::Ready(Ok(())); + } + socket.register_send_waker(cx.waker()); + Poll::Pending + } + fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let mut socket = self.reactor.get_socket::(*self.handle); + + if socket.may_send() { + socket.close(); + self.reactor.notify(); + } + if matches!( + socket.state(), + tcp::State::FinWait2 | tcp::State::TimeWait | tcp::State::Closed + ) { + return Poll::Ready(Ok(())); + } + + socket.register_send_waker(cx.waker()); + Poll::Pending + } +} + +/// A UDP socket. +pub struct UdpSocket { + handle: SocketHandle, + reactor: Arc, + local_addr: SocketAddr, +} + +impl UdpSocket { + pub(super) async fn new( + reactor: Arc, + local_endpoint: IpEndpoint, + ) -> io::Result { + let handle = reactor.socket_allocator().new_udp_socket(); + { + let mut socket = reactor.get_socket::(*handle); + socket.bind(local_endpoint).map_err(map_err)?; + } + + let local_addr = ep2sa(&local_endpoint); + + Ok(UdpSocket { + handle, + reactor, + local_addr, + }) + } + /// Note that on multiple calls to a poll_* method in the send direction, only the Waker from the Context passed to the most recent call will be scheduled to receive a wakeup. + pub fn poll_send_to( + &self, + cx: &Context<'_>, + buf: &[u8], + target: SocketAddr, + ) -> Poll> { + let mut socket = self.reactor.get_socket::(*self.handle); + let target_ip: IpEndpoint = sa2ep(target); + + match socket.send_slice(buf, target_ip) { + // the buffer is full + Err(udp::SendError::BufferFull) => {} + r => { + r.map_err(map_err)?; + self.reactor.notify(); + return Poll::Ready(Ok(buf.len())); + } + } + + socket.register_send_waker(cx.waker()); + Poll::Pending + } + /// See note on `poll_send_to` + pub async fn send_to(&self, buf: &[u8], target: SocketAddr) -> io::Result { + poll_fn(|cx| self.poll_send_to(cx, buf, target)).await + } + /// Note that on multiple calls to a poll_* method in the recv direction, only the Waker from the Context passed to the most recent call will be scheduled to receive a wakeup. + pub fn poll_recv_from( + &self, + cx: &Context<'_>, + buf: &mut [u8], + ) -> Poll> { + let mut socket = self.reactor.get_socket::(*self.handle); + + match socket.recv_slice(buf) { + // the buffer is empty + Err(udp::RecvError::Exhausted) => {} + r => { + let (size, metadata) = r.map_err(map_err)?; + self.reactor.notify(); + return Poll::Ready(Ok((size, ep2sa(&metadata.endpoint)))); + } + } + + socket.register_recv_waker(cx.waker()); + Poll::Pending + } + /// See note on `poll_recv_from` + pub async fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + poll_fn(|cx| self.poll_recv_from(cx, buf)).await + } + + pub fn poll_recv_from_limited( + &self, + cx: &Context<'_>, + max_len: usize, + ) -> Poll, SocketAddr, bool)>> { + let mut socket = self.reactor.get_socket::(*self.handle); + + match socket.recv() { + Err(udp::RecvError::Exhausted) => {} + Err(error) => return Poll::Ready(Err(map_err(error))), + Ok((payload, metadata)) => { + let copy_len = payload.len().min(max_len); + let truncated = copy_len < payload.len(); + let data = payload[..copy_len].to_vec(); + self.reactor.notify(); + return Poll::Ready(Ok((data, ep2sa(&metadata.endpoint), truncated))); + } + } + + socket.register_recv_waker(cx.waker()); + Poll::Pending + } + + pub async fn recv_from_limited( + &self, + max_len: usize, + ) -> io::Result<(Vec, SocketAddr, bool)> { + poll_fn(|cx| self.poll_recv_from_limited(cx, max_len)).await + } + + pub fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } +} + +#[cfg(test)] +mod tests { + use std::time::Duration as StdDuration; + + use smoltcp::{ + iface::Config, + phy::{DeviceCapabilities, Medium}, + socket::tcp, + time::Duration, + wire::{HardwareAddress, Ipv4Address, TcpControl, TcpSeqNumber}, + }; + + use super::super::{ + Net, NetConfig, channel_device, + test_utils::{TcpPackets, recv_tcp, recv_tcp_for_port}, + }; + use super::{TCP_LISTENER_MAX_PENDING, TcpListener}; + + const LISTEN_ADDR: Ipv4Address = Ipv4Address::new(10, 126, 126, 1); + const LISTEN_PORT: u16 = 34569; + const PACKETS: TcpPackets = TcpPackets::new(LISTEN_ADDR, LISTEN_PORT); + + type TestNet = ( + Net, + tokio::sync::mpsc::Sender>>, + tokio::sync::mpsc::Receiver>, + ); + + fn test_net() -> TestNet { + let mut capabilities = DeviceCapabilities::default(); + capabilities.max_transmission_unit = 1280; + capabilities.medium = Medium::Ip; + let (device, ingress, egress) = channel_device::ChannelDevice::new(capabilities); + let net = Net::new( + device, + NetConfig::new( + Config::new(HardwareAddress::Ip), + "10.126.126.1/24".parse().unwrap(), + Vec::new(), + None, + ), + ); + (net, ingress, egress) + } + + async fn begin_handshake( + ingress: &tokio::sync::mpsc::Sender>>, + egress: &mut tokio::sync::mpsc::Receiver>, + client_addr: Ipv4Address, + client_port: u16, + client_sequence: i32, + ) -> TcpSeqNumber { + ingress + .send(Ok(PACKETS.syn(client_addr, client_port, client_sequence))) + .await + .unwrap(); + let syn_ack = recv_tcp_for_port(egress, client_port).await; + assert_eq!(syn_ack.control, TcpControl::Syn); + syn_ack.sequence + } + + async fn finish_handshake( + ingress: &tokio::sync::mpsc::Sender>>, + client_addr: Ipv4Address, + client_port: u16, + client_sequence: i32, + server_sequence: TcpSeqNumber, + ) { + ingress + .send(Ok(PACKETS.ack( + client_addr, + client_port, + TcpSeqNumber(client_sequence + 1), + server_sequence + 1, + ))) + .await + .unwrap(); + } + + fn listener_states(listener: &TcpListener) -> Vec { + listener + .reactor + .tcp_listener_handles(listener.id) + .into_iter() + .map(|handle| listener.reactor.get_socket::(handle).state()) + .collect() + } + + #[tokio::test] + async fn duplicate_syn_does_not_consume_another_backlog_slot() { + let (net, ingress, mut egress) = test_net(); + let listener = net + .tcp_bind("10.126.126.1:34569".parse().unwrap()) + .await + .unwrap(); + let client_addr = Ipv4Address::new(10, 126, 126, 2); + + { + let sockets = listener.reactor.socket_allocator().sockets().lock(); + assert_eq!( + sockets + .iter() + .filter(|(_, socket)| matches!(socket, smoltcp::socket::Socket::Tcp(_))) + .count(), + 0 + ); + } + begin_handshake(&ingress, &mut egress, client_addr, 40000, 1000).await; + + ingress + .send(Ok(PACKETS.syn(client_addr, 40000, 1000))) + .await + .unwrap(); + ingress + .send(Ok(PACKETS.syn(client_addr, 40001, 2000))) + .await + .unwrap(); + recv_tcp_for_port(&mut egress, 40001).await; + + let states = listener_states(&listener); + assert_eq!( + states + .iter() + .filter(|state| **state == tcp::State::SynReceived) + .count(), + 2 + ); + } + + #[tokio::test] + async fn listener_accepts_new_client_while_first_handshake_is_stalled() { + let (net, ingress, mut egress) = test_net(); + let mut listener = net + .tcp_bind("10.126.126.1:34569".parse().unwrap()) + .await + .unwrap(); + + let first_addr = Ipv4Address::new(10, 126, 126, 2); + begin_handshake(&ingress, &mut egress, first_addr, 40000, 1000).await; + let states = listener_states(&listener); + assert_eq!( + states + .iter() + .filter(|state| **state == tcp::State::SynReceived) + .count(), + 1 + ); + + let second_addr = Ipv4Address::new(10, 126, 126, 3); + let second_sequence = + begin_handshake(&ingress, &mut egress, second_addr, 40001, 2000).await; + for handle in listener.reactor.tcp_listener_handles(listener.id) { + let socket = listener.reactor.get_socket::(handle); + assert_eq!(socket.timeout(), Some(Duration::from_secs(5))); + } + + finish_handshake(&ingress, second_addr, 40001, 2000, second_sequence).await; + tokio::time::timeout(StdDuration::from_secs(1), async { + loop { + let established_timeout = listener + .reactor + .tcp_listener_handles(listener.id) + .into_iter() + .find_map(|handle| { + let socket = listener.reactor.get_socket::(handle); + (socket.state() == tcp::State::Established).then(|| socket.timeout()) + }); + if let Some(timeout) = established_timeout { + assert_eq!(timeout, Some(Duration::from_secs(60))); + break; + } + tokio::time::sleep(StdDuration::from_millis(1)).await; + } + }) + .await + .unwrap(); + let (stream, peer_addr) = + tokio::time::timeout(StdDuration::from_secs(1), listener.accept()) + .await + .unwrap() + .unwrap(); + assert_eq!(peer_addr, "10.126.126.3:40001".parse().unwrap()); + + let stream_socket = stream.reactor.get_socket::(*stream.handle); + assert_eq!(stream_socket.timeout(), Some(Duration::from_secs(60))); + drop(stream_socket); + assert_eq!(listener_states(&listener), vec![tcp::State::SynReceived]); + + { + let handle = listener.reactor.tcp_listener_handles(listener.id)[0]; + let mut socket = listener.reactor.get_socket::(handle); + socket.set_timeout(Some(Duration::from_millis(10))); + } + listener.reactor.notify(); + tokio::time::timeout(StdDuration::from_secs(1), async { + loop { + if listener + .reactor + .tcp_listener_handles(listener.id) + .is_empty() + { + break; + } + tokio::time::sleep(StdDuration::from_millis(1)).await; + } + }) + .await + .unwrap(); + + begin_handshake(&ingress, &mut egress, first_addr, 40002, 3000).await; + assert_eq!(listener_states(&listener), vec![tcp::State::SynReceived]); + } + + #[tokio::test] + async fn listener_limits_pending_connections() { + let (net, ingress, mut egress) = test_net(); + let mut listener = net + .tcp_bind("10.126.126.1:34569".parse().unwrap()) + .await + .unwrap(); + let client_addr = Ipv4Address::new(10, 126, 126, 2); + let mut syn_ack_sequences = Vec::with_capacity(TCP_LISTENER_MAX_PENDING); + + for index in 0..TCP_LISTENER_MAX_PENDING { + ingress + .send(Ok(PACKETS.syn( + client_addr, + 40000 + index as u16, + 1000 + index as i32, + ))) + .await + .unwrap(); + } + for _ in 0..TCP_LISTENER_MAX_PENDING { + let syn_ack = recv_tcp(&mut egress).await; + assert_eq!(syn_ack.control, TcpControl::Syn); + syn_ack_sequences.push((syn_ack.dst_port, syn_ack.sequence)); + } + syn_ack_sequences.sort_unstable_by_key(|(port, _)| *port); + assert!( + listener_states(&listener) + .iter() + .all(|state| *state == tcp::State::SynReceived) + ); + + ingress + .send(Ok(PACKETS.syn(client_addr, 50000, 3000))) + .await + .unwrap(); + assert_eq!(recv_tcp(&mut egress).await.control, TcpControl::Rst); + + for (port, syn_ack_sequence) in syn_ack_sequences { + let index = port - 40000; + finish_handshake( + &ingress, + client_addr, + port, + 1000 + index as i32, + syn_ack_sequence, + ) + .await; + } + + tokio::time::timeout(StdDuration::from_secs(1), async { + loop { + if listener_states(&listener) + .iter() + .all(|state| *state == tcp::State::Established) + { + break; + } + tokio::time::sleep(StdDuration::from_millis(1)).await; + } + }) + .await + .unwrap(); + + ingress + .send(Ok(PACKETS.syn(client_addr, 50001, 4000))) + .await + .unwrap(); + assert_eq!(recv_tcp(&mut egress).await.control, TcpControl::Rst); + + let mut streams = Vec::with_capacity(TCP_LISTENER_MAX_PENDING + 1); + let mut peer_ports = Vec::with_capacity(TCP_LISTENER_MAX_PENDING + 1); + let (stream, peer_addr) = listener.accept().await.unwrap(); + streams.push(stream); + peer_ports.push(peer_addr.port()); + + let replacement_sequence = + begin_handshake(&ingress, &mut egress, client_addr, 50002, 5000).await; + finish_handshake(&ingress, client_addr, 50002, 5000, replacement_sequence).await; + + for _ in 0..TCP_LISTENER_MAX_PENDING { + let (stream, peer_addr) = + tokio::time::timeout(StdDuration::from_secs(1), listener.accept()) + .await + .unwrap() + .unwrap(); + streams.push(stream); + peer_ports.push(peer_addr.port()); + } + peer_ports.sort_unstable(); + assert_eq!( + peer_ports, + (40000..40000 + TCP_LISTENER_MAX_PENDING as u16) + .chain(std::iter::once(50002)) + .collect::>() + ); + assert!(listener_states(&listener).is_empty()); + } + + #[tokio::test] + async fn closed_pending_connections_are_reclaimed_before_admission() { + let (net, ingress, mut egress) = test_net(); + let listener = net + .tcp_bind("10.126.126.1:34569".parse().unwrap()) + .await + .unwrap(); + let client_addr = Ipv4Address::new(10, 126, 126, 2); + + for index in 0..TCP_LISTENER_MAX_PENDING { + begin_handshake( + &ingress, + &mut egress, + client_addr, + 40000 + index as u16, + 1000 + index as i32, + ) + .await; + } + for handle in listener.reactor.tcp_listener_handles(listener.id) { + listener.reactor.get_socket::(handle).abort(); + } + + begin_handshake(&ingress, &mut egress, client_addr, 50000, 3000).await; + assert_eq!(listener_states(&listener), vec![tcp::State::SynReceived]); + } + + #[tokio::test] + async fn dropping_listener_removes_pending_connections() { + let (net, ingress, mut egress) = test_net(); + let listener = net + .tcp_bind("10.126.126.1:34569".parse().unwrap()) + .await + .unwrap(); + + begin_handshake( + &ingress, + &mut egress, + Ipv4Address::new(10, 126, 126, 2), + 40000, + 1000, + ) + .await; + assert_eq!(listener_states(&listener).len(), 1); + + drop(listener); + let listener = net + .tcp_bind("10.126.126.1:34569".parse().unwrap()) + .await + .unwrap(); + assert!(listener_states(&listener).is_empty()); + } + + #[tokio::test] + async fn old_syn_for_accepted_stream_does_not_create_pending_connection() { + let (net, ingress, mut egress) = test_net(); + let mut listener = net + .tcp_bind("10.126.126.1:34569".parse().unwrap()) + .await + .unwrap(); + let client_addr = Ipv4Address::new(10, 126, 126, 2); + + let server_sequence = + begin_handshake(&ingress, &mut egress, client_addr, 40000, 1000).await; + finish_handshake(&ingress, client_addr, 40000, 1000, server_sequence).await; + let (_stream, _) = tokio::time::timeout(StdDuration::from_secs(1), listener.accept()) + .await + .unwrap() + .unwrap(); + + ingress + .send(Ok(PACKETS.syn(client_addr, 40000, 1000))) + .await + .unwrap(); + ingress + .send(Ok(PACKETS.syn(client_addr, 40001, 2000))) + .await + .unwrap(); + recv_tcp_for_port(&mut egress, 40001).await; + + assert_eq!(listener_states(&listener), vec![tcp::State::SynReceived]); + } + + #[tokio::test] + async fn accepts_connection_closed_by_peer_before_accept() { + let (net, ingress, mut egress) = test_net(); + let mut listener = net + .tcp_bind("10.126.126.1:34569".parse().unwrap()) + .await + .unwrap(); + let client_addr = Ipv4Address::new(10, 126, 126, 2); + + let server_sequence = + begin_handshake(&ingress, &mut egress, client_addr, 40000, 1000).await; + finish_handshake(&ingress, client_addr, 40000, 1000, server_sequence).await; + ingress + .send(Ok(PACKETS.fin( + client_addr, + 40000, + TcpSeqNumber(1001), + server_sequence + 1, + ))) + .await + .unwrap(); + + let (stream, peer_addr) = + tokio::time::timeout(StdDuration::from_secs(1), listener.accept()) + .await + .unwrap() + .unwrap(); + assert_eq!(peer_addr, "10.126.126.2:40000".parse().unwrap()); + let socket = stream.reactor.get_socket::(*stream.handle); + assert_eq!(socket.state(), tcp::State::CloseWait); + assert_eq!(socket.timeout(), Some(Duration::from_secs(60))); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/socket_allocator.rs b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/socket_allocator.rs new file mode 100644 index 0000000..4236224 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/socket_allocator.rs @@ -0,0 +1,137 @@ +use parking_lot::Mutex; +use smoltcp::{ + iface::{SocketHandle as InnerSocketHandle, SocketSet}, + socket::{tcp, udp}, + time::Duration, + wire::IpEndpoint, +}; +use std::{ + ops::{Deref, DerefMut}, + sync::Arc, +}; + +pub(super) const TCP_TIMEOUT: Duration = Duration::from_secs(60); +pub(super) const TCP_LISTENER_TIMEOUT: Duration = Duration::from_secs(5); + +/// `BufferSize` is used to configure the size of the socket buffer. +#[derive(Debug, Clone, Copy)] +pub struct BufferSize { + pub tcp_rx_size: usize, + pub tcp_tx_size: usize, + + pub udp_rx_size: usize, + pub udp_tx_size: usize, + pub udp_rx_meta_size: usize, + pub udp_tx_meta_size: usize, +} + +impl Default for BufferSize { + fn default() -> Self { + BufferSize { + tcp_rx_size: 8192, + tcp_tx_size: 8192, + + udp_rx_size: 8192, + udp_tx_size: 8192, + udp_rx_meta_size: 32, + udp_tx_meta_size: 32, + } + } +} + +type SharedSocketSet = Arc>>; + +#[derive(Clone)] +pub struct SocketAlloctor { + sockets: SharedSocketSet, + buffer_size: BufferSize, +} + +impl SocketAlloctor { + pub(crate) fn new(buffer_size: BufferSize) -> SocketAlloctor { + let sockets = Arc::new(Mutex::new(SocketSet::new(Vec::new()))); + SocketAlloctor { + sockets, + buffer_size, + } + } + pub(crate) fn sockets(&self) -> &SharedSocketSet { + &self.sockets + } + pub fn new_tcp_socket(&self) -> SocketHandle { + let mut set = self.sockets.lock(); + let handle = set.add(self.alloc_tcp_socket()); + SocketHandle::new(handle, self.sockets.clone()) + } + pub(super) fn add_tcp_listener_socket( + &self, + sockets: &mut SocketSet<'static>, + local_endpoint: IpEndpoint, + ) -> Result { + let mut socket = self.alloc_tcp_socket(); + socket.set_timeout(Some(TCP_LISTENER_TIMEOUT)); + socket.listen(local_endpoint)?; + Ok(sockets.add(socket)) + } + pub(super) fn own_socket(&self, handle: InnerSocketHandle) -> SocketHandle { + SocketHandle::new(handle, self.sockets.clone()) + } + fn alloc_tcp_socket(&self) -> tcp::Socket<'static> { + let rx_buffer = tcp::SocketBuffer::new(vec![0; self.buffer_size.tcp_rx_size]); + let tx_buffer = tcp::SocketBuffer::new(vec![0; self.buffer_size.tcp_tx_size]); + let mut tcp = tcp::Socket::new(rx_buffer, tx_buffer); + tcp.set_nagle_enabled(false); + tcp.set_keep_alive(Some(Duration::from_secs(10))); + tcp.set_timeout(Some(TCP_TIMEOUT)); + + tcp + } + + pub fn new_udp_socket(&self) -> SocketHandle { + let mut set = self.sockets.lock(); + let handle = set.add(self.alloc_udp_socket()); + SocketHandle::new(handle, self.sockets.clone()) + } + + fn alloc_udp_socket(&self) -> udp::Socket<'static> { + let rx_buffer = udp::PacketBuffer::new( + vec![udp::PacketMetadata::EMPTY; self.buffer_size.udp_rx_meta_size], + vec![0; self.buffer_size.udp_rx_size], + ); + let tx_buffer = udp::PacketBuffer::new( + vec![udp::PacketMetadata::EMPTY; self.buffer_size.udp_tx_meta_size], + vec![0; self.buffer_size.udp_tx_size], + ); + + udp::Socket::new(rx_buffer, tx_buffer) + } +} + +pub struct SocketHandle(InnerSocketHandle, SharedSocketSet); + +impl SocketHandle { + fn new(inner: InnerSocketHandle, set: SharedSocketSet) -> SocketHandle { + SocketHandle(inner, set) + } +} + +impl Drop for SocketHandle { + fn drop(&mut self) { + let mut iface = self.1.lock(); + iface.remove(self.0); + } +} + +impl Deref for SocketHandle { + type Target = InnerSocketHandle; + + fn deref(&self) -> &Self::Target { + &self.0 + } +} + +impl DerefMut for SocketHandle { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.0 + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/test_utils.rs b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/test_utils.rs new file mode 100644 index 0000000..8ed40d9 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/smoltcp/tokio_smoltcp/test_utils.rs @@ -0,0 +1,149 @@ +use std::time::Duration; + +use smoltcp::{ + phy::ChecksumCapabilities, + wire::{ + IpAddress, IpProtocol, Ipv4Address, Ipv4Packet, Ipv4Repr, TcpControl, TcpPacket, TcpRepr, + TcpSeqNumber, + }, +}; +use tokio::sync::mpsc; + +pub(crate) struct TcpPackets { + local_addr: Ipv4Address, + local_port: u16, +} + +impl TcpPackets { + pub(crate) const fn new(local_addr: Ipv4Address, local_port: u16) -> Self { + Self { + local_addr, + local_port, + } + } + + fn packet(&self, src_addr: Ipv4Address, repr: TcpRepr<'_>) -> Vec { + let ipv4_repr = Ipv4Repr { + src_addr, + dst_addr: self.local_addr, + next_header: IpProtocol::Tcp, + payload_len: repr.buffer_len(), + hop_limit: 64, + }; + let mut packet = vec![0; ipv4_repr.buffer_len() + repr.buffer_len()]; + let mut ipv4_packet = Ipv4Packet::new_unchecked(&mut packet); + ipv4_repr.emit(&mut ipv4_packet, &ChecksumCapabilities::default()); + repr.emit( + &mut TcpPacket::new_unchecked(ipv4_packet.payload_mut()), + &IpAddress::Ipv4(src_addr), + &IpAddress::Ipv4(self.local_addr), + &ChecksumCapabilities::default(), + ); + packet + } + + pub(crate) fn syn(&self, src_addr: Ipv4Address, src_port: u16, sequence: i32) -> Vec { + self.packet( + src_addr, + TcpRepr { + src_port, + dst_port: self.local_port, + control: TcpControl::Syn, + seq_number: TcpSeqNumber(sequence), + ack_number: None, + window_len: u16::MAX, + window_scale: None, + max_seg_size: Some(1200), + sack_permitted: false, + sack_ranges: [None; 3], + timestamp: None, + payload: &[], + }, + ) + } + + pub(crate) fn ack( + &self, + src_addr: Ipv4Address, + src_port: u16, + sequence: TcpSeqNumber, + ack_number: TcpSeqNumber, + ) -> Vec { + self.control(src_addr, src_port, TcpControl::None, sequence, ack_number) + } + + pub(crate) fn fin( + &self, + src_addr: Ipv4Address, + src_port: u16, + sequence: TcpSeqNumber, + ack_number: TcpSeqNumber, + ) -> Vec { + self.control(src_addr, src_port, TcpControl::Fin, sequence, ack_number) + } + + fn control( + &self, + src_addr: Ipv4Address, + src_port: u16, + control: TcpControl, + sequence: TcpSeqNumber, + ack_number: TcpSeqNumber, + ) -> Vec { + self.packet( + src_addr, + TcpRepr { + src_port, + dst_port: self.local_port, + control, + seq_number: sequence, + ack_number: Some(ack_number), + window_len: u16::MAX, + window_scale: None, + max_seg_size: None, + sack_permitted: false, + sack_ranges: [None; 3], + timestamp: None, + payload: &[], + }, + ) + } +} + +pub(crate) struct TcpPacketSummary { + pub(crate) control: TcpControl, + pub(crate) sequence: TcpSeqNumber, + pub(crate) dst_port: u16, +} + +pub(crate) async fn recv_tcp(receiver: &mut mpsc::Receiver>) -> TcpPacketSummary { + let packet = tokio::time::timeout(Duration::from_secs(1), receiver.recv()) + .await + .unwrap() + .unwrap(); + let ipv4_packet = Ipv4Packet::new_checked(&packet).unwrap(); + let repr = TcpRepr::parse( + &TcpPacket::new_checked(ipv4_packet.payload()).unwrap(), + &IpAddress::Ipv4(ipv4_packet.src_addr()), + &IpAddress::Ipv4(ipv4_packet.dst_addr()), + &ChecksumCapabilities::default(), + ) + .unwrap(); + TcpPacketSummary { + control: repr.control, + sequence: repr.seq_number, + dst_port: repr.dst_port, + } +} + +pub(crate) async fn recv_tcp_for_port( + receiver: &mut mpsc::Receiver>, + dst_port: u16, +) -> TcpPacketSummary { + loop { + let packet = recv_tcp(receiver).await; + if packet.dst_port == dst_port { + return packet; + } + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/socks5/adapter.rs b/vendor/easytier/easytier-core/src/gateway/socks5/adapter.rs new file mode 100644 index 0000000..1868f38 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/socks5/adapter.rs @@ -0,0 +1,215 @@ +//! Host-listener adapter that translates SOCKS5 sessions into data-plane calls. + +use std::{ + net::SocketAddr, + sync::{ + Arc, + atomic::{AtomicBool, Ordering}, + }, + time::Duration, +}; + +use tokio::{sync::Mutex, task::JoinSet}; + +use crate::{ + config::runtime::CoreRuntimeConfigStore, + foundation::task::reap_joinset_background, + gateway::dataplane::{ + DataPlaneConsumerLease, DataPlaneError, DataPlaneErrorKind, DataPlaneRuntime, + DataPlaneTcpConnectOptions, DataPlaneTcpStream, + }, + host::dns::DnsResolver, + socket::{ + SocketContext, + tcp::{ + TcpListenOptions, TcpSocketPurpose, VirtualTcpListener, VirtualTcpListenerFactory, + VirtualTcpSocket, VirtualTcpSocketFactory, + }, + udp::VirtualUdpSocketFactory, + }, +}; + +use super::{ + AcceptAuthentication, AsyncTcpConnector, Config, HostSocks5ServerRuntime, Result, Socks5Socket, + SocksError, codec::ReplyError, +}; + +struct Socks5DataPlaneConnector +where + H: VirtualTcpSocketFactory + VirtualTcpListenerFactory + VirtualUdpSocketFactory, +{ + data_plane: Arc>, + source_addr: SocketAddr, +} + +#[async_trait::async_trait] +impl AsyncTcpConnector for Socks5DataPlaneConnector +where + H: VirtualTcpSocketFactory + VirtualTcpListenerFactory + VirtualUdpSocketFactory, +{ + type S = DataPlaneTcpStream; + + async fn tcp_connect(&self, addr: SocketAddr, timeout_s: u64) -> Result { + self.data_plane + .connect_tcp( + addr, + DataPlaneTcpConnectOptions::gateway( + Duration::from_secs(timeout_s), + TcpSocketPurpose::Socks5, + self.source_addr, + ), + ) + .await + .map_err(map_data_plane_error) + } +} + +fn map_data_plane_error(error: DataPlaneError) -> SocksError { + match error.kind() { + DataPlaneErrorKind::DeadlineExceeded => ReplyError::ConnectionTimeout.into(), + DataPlaneErrorKind::ConnectionRefused => ReplyError::ConnectionRefused.into(), + DataPlaneErrorKind::NoOverlayRoute | DataPlaneErrorKind::PathNotReady => { + ReplyError::NetworkUnreachable.into() + } + DataPlaneErrorKind::AddressFamilyUnsupported => ReplyError::AddressTypeNotSupported.into(), + DataPlaneErrorKind::Cancelled + | DataPlaneErrorKind::InstanceStopped + | DataPlaneErrorKind::HandleClosed + | DataPlaneErrorKind::NetworkChanged => ReplyError::ConnectionNotAllowed.into(), + DataPlaneErrorKind::AddressInUse + | DataPlaneErrorKind::ResourceLimit + | DataPlaneErrorKind::BufferTooSmall + | DataPlaneErrorKind::Io => SocksError::Other(anyhow::Error::new(error)), + } +} + +async fn handle_socks5_stream( + stream: S, + data_plane: Arc>, + source_addr: SocketAddr, + command_runtime: Arc>, +) where + H: VirtualTcpSocketFactory + VirtualTcpListenerFactory + VirtualUdpSocketFactory, + S: VirtualTcpSocket, +{ + let mut config = Config::::default(); + config.set_request_timeout(10); + config.set_skip_auth(false); + config.set_allow_no_auth(true); + + let connector = Socks5DataPlaneConnector { + data_plane, + source_addr, + }; + let socket = Socks5Socket::new(stream, Arc::new(config), connector, command_runtime); + if let Err(error) = socket.upgrade_to_socks5().await { + tracing::error!(?error, "SOCKS5 session failed"); + } +} + +pub(crate) struct Socks5GatewayAdapter +where + H: VirtualTcpSocketFactory + VirtualTcpListenerFactory + VirtualUdpSocketFactory, +{ + operation: Mutex<()>, + started: AtomicBool, + runtime_config: CoreRuntimeConfigStore, + data_plane: Arc>, + host: Arc, + socket_context: SocketContext, + command_runtime: Arc>, + consumer_lease: Mutex>, + tasks: Arc>>, +} + +impl Socks5GatewayAdapter +where + H: VirtualTcpSocketFactory + VirtualTcpListenerFactory + VirtualUdpSocketFactory, +{ + pub(crate) fn new( + runtime_config: CoreRuntimeConfigStore, + data_plane: Arc>, + host: Arc, + dns: Arc, + socket_context: SocketContext, + ) -> Arc { + Arc::new(Self { + operation: Mutex::new(()), + started: AtomicBool::new(false), + runtime_config, + data_plane, + host: host.clone(), + socket_context: socket_context.clone(), + command_runtime: Arc::new(HostSocks5ServerRuntime::new(host, dns, socket_context)), + consumer_lease: Mutex::new(None), + tasks: Arc::new(std::sync::Mutex::new(JoinSet::new())), + }) + } + + async fn start_inner(&self) -> anyhow::Result<()> { + let Some(bind_addr) = self.runtime_config.snapshot().services.gateway.socks5_bind else { + return Ok(()); + }; + let options = TcpListenOptions::socks5(bind_addr); + let bind = options + .bind + .clone() + .with_context(self.socket_context.clone()); + let listener = self.host.bind_tcp(options.with_bind(bind)).await?; + let consumer_lease = self.data_plane.acquire_consumer_lease()?; + + self.tasks.lock().unwrap().spawn(reap_joinset_background( + Arc::downgrade(&self.tasks), + "SOCKS5 gateway adapter", + )); + let data_plane = self.data_plane.clone(); + let command_runtime = self.command_runtime.clone(); + let session_tasks = self.tasks.clone(); + self.tasks.lock().unwrap().spawn(async move { + loop { + match listener.accept().await { + Ok((socket, source_addr)) => { + tracing::info!(?source_addr, "accepted a SOCKS5 connection"); + session_tasks.lock().unwrap().spawn(handle_socks5_stream( + socket, + data_plane.clone(), + source_addr, + command_runtime.clone(), + )); + } + Err(error) => tracing::error!(?error, "SOCKS5 accept failed"), + } + } + }); + self.consumer_lease.lock().await.replace(consumer_lease); + Ok(()) + } + + pub(crate) async fn start(&self) -> anyhow::Result<()> { + let _operation = self.operation.lock().await; + if self.started.load(Ordering::Acquire) { + return Ok(()); + } + if let Err(error) = self.start_inner().await { + self.stop_inner().await; + return Err(error); + } + self.started.store(true, Ordering::Release); + Ok(()) + } + + async fn stop_inner(&self) { + self.started.store(false, Ordering::Release); + self.consumer_lease.lock().await.take(); + let mut tasks = { + let mut tasks = self.tasks.lock().unwrap(); + std::mem::replace(&mut *tasks, JoinSet::new()) + }; + tasks.shutdown().await; + } + + pub(crate) async fn stop(&self) { + let _operation = self.operation.lock().await; + self.stop_inner().await; + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/socks5/codec.rs b/vendor/easytier/easytier-core/src/gateway/socks5/codec.rs new file mode 100644 index 0000000..8c836cb --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/socks5/codec.rs @@ -0,0 +1,274 @@ +//! Portable SOCKS5 wire types and codecs: protocol constants, error and +//! address types, and the UDP request header encode/decode helpers. +//! +//! DNS resolution, socket creation, listeners, and concrete command execution +//! are deliberately supplied by host adapters outside this module. + +mod target_addr; + +use anyhow::Context; +use std::fmt; +use std::io; +pub(crate) use target_addr::TargetAddr; +pub(super) use target_addr::{AddrError, ToTargetAddr, read_address}; +use thiserror::Error; + +use tokio::io::AsyncReadExt; + +use tracing::error; + +#[rustfmt::skip] +pub(super) mod consts { + pub const SOCKS5_VERSION: u8 = 0x05; + + pub const SOCKS5_AUTH_METHOD_NONE: u8 = 0x00; + pub const SOCKS5_AUTH_METHOD_PASSWORD: u8 = 0x02; + pub const SOCKS5_AUTH_METHOD_NOT_ACCEPTABLE: u8 = 0xff; + + pub const SOCKS5_CMD_TCP_CONNECT: u8 = 0x01; + pub const SOCKS5_CMD_TCP_BIND: u8 = 0x02; + pub const SOCKS5_CMD_UDP_ASSOCIATE: u8 = 0x03; + + pub const SOCKS5_ADDR_TYPE_IPV4: u8 = 0x01; + pub const SOCKS5_ADDR_TYPE_DOMAIN_NAME: u8 = 0x03; + pub const SOCKS5_ADDR_TYPE_IPV6: u8 = 0x04; + + pub const SOCKS5_REPLY_SUCCEEDED: u8 = 0x00; + pub const SOCKS5_REPLY_GENERAL_FAILURE: u8 = 0x01; + pub const SOCKS5_REPLY_CONNECTION_NOT_ALLOWED: u8 = 0x02; + pub const SOCKS5_REPLY_NETWORK_UNREACHABLE: u8 = 0x03; + pub const SOCKS5_REPLY_CONNECTION_REFUSED: u8 = 0x05; + pub const SOCKS5_REPLY_TTL_EXPIRED: u8 = 0x06; + pub const SOCKS5_REPLY_COMMAND_NOT_SUPPORTED: u8 = 0x07; + pub const SOCKS5_REPLY_ADDRESS_TYPE_NOT_SUPPORTED: u8 = 0x08; +} + +#[derive(Debug, PartialEq)] +pub(super) enum Socks5Command { + TCPConnect, + TCPBind, + UDPAssociate, +} + +impl Socks5Command { + #[inline] + #[rustfmt::skip] + pub fn from_u8(code: u8) -> Option { + match code { + consts::SOCKS5_CMD_TCP_CONNECT => Some(Socks5Command::TCPConnect), + consts::SOCKS5_CMD_TCP_BIND => Some(Socks5Command::TCPBind), + consts::SOCKS5_CMD_UDP_ASSOCIATE => Some(Socks5Command::UDPAssociate), + _ => None, + } + } +} + +#[derive(Debug, PartialEq)] +pub(super) enum AuthenticationMethod { + None, + Password { username: String, password: String }, +} + +impl AuthenticationMethod { + #[inline] + #[rustfmt::skip] + pub fn from_u8(code: u8) -> Option { + match code { + consts::SOCKS5_AUTH_METHOD_NONE => Some(AuthenticationMethod::None), + consts::SOCKS5_AUTH_METHOD_PASSWORD => Some(AuthenticationMethod::Password { username: "test".to_string(), password: "test".to_string()}), + _ => None, + } + } +} + +impl fmt::Display for AuthenticationMethod { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match *self { + AuthenticationMethod::None => f.write_str("AuthenticationMethod::None"), + AuthenticationMethod::Password { .. } => f.write_str("AuthenticationMethod::Password"), + } + } +} + +//impl Vec { +// pub fn as_bytes(&self) -> &[u8] { +// self.iter().map(|l| l.as_u8()).collect() +// } +//} +// +//impl From<&[AuthenticationMethod]> for &[u8] { +// fn from(_: Vec) -> Self { +// &[0x00] +// } +//} + +#[derive(Error, Debug)] +pub(crate) enum SocksError { + #[error("i/o error: {0}")] + Io(#[from] io::Error), + + #[error("Auth method unacceptable `{0:?}`.")] + AuthMethodUnacceptable(Vec), + #[error("Unsupported SOCKS version `{0}`.")] + UnsupportedSocksVersion(u8), + #[error("Domain exceeded max sequence length")] + ExceededMaxDomainLen(usize), + #[error("Authentication failed `{0}`")] + AuthenticationFailed(String), + #[error("Authentication rejected `{0}`")] + AuthenticationRejected(String), + + #[error("Error with reply: {0}.")] + ReplyError(#[from] ReplyError), + + // #[error("Other: `{0}`.")] + #[error(transparent)] + Other(#[from] anyhow::Error), +} + +pub(crate) type Result = core::result::Result; + +/// SOCKS5 reply code +#[derive(Error, Debug, Copy, Clone)] +pub(crate) enum ReplyError { + #[error("Succeeded")] + Succeeded, + #[error("General failure")] + GeneralFailure, + #[error("Connection not allowed by ruleset")] + ConnectionNotAllowed, + #[error("Network unreachable")] + NetworkUnreachable, + #[error("Connection refused")] + ConnectionRefused, + #[error("Connection timeout")] + ConnectionTimeout, + #[error("Command not supported")] + CommandNotSupported, + #[error("Address type not supported")] + AddressTypeNotSupported, + // OtherReply(u8), +} + +impl ReplyError { + #[inline] + #[rustfmt::skip] + pub fn as_u8(self) -> u8 { + match self { + ReplyError::Succeeded => consts::SOCKS5_REPLY_SUCCEEDED, + ReplyError::GeneralFailure => consts::SOCKS5_REPLY_GENERAL_FAILURE, + ReplyError::ConnectionNotAllowed => consts::SOCKS5_REPLY_CONNECTION_NOT_ALLOWED, + ReplyError::NetworkUnreachable => consts::SOCKS5_REPLY_NETWORK_UNREACHABLE, + ReplyError::ConnectionRefused => consts::SOCKS5_REPLY_CONNECTION_REFUSED, + ReplyError::ConnectionTimeout => consts::SOCKS5_REPLY_TTL_EXPIRED, + ReplyError::CommandNotSupported => consts::SOCKS5_REPLY_COMMAND_NOT_SUPPORTED, + ReplyError::AddressTypeNotSupported => consts::SOCKS5_REPLY_ADDRESS_TYPE_NOT_SUPPORTED, +// ReplyError::OtherReply(c) => c, + } + } +} + +/// Generate UDP header +/// +/// # UDP Request header structure. +/// ```text +/// +----+------+------+----------+----------+----------+ +/// |RSV | FRAG | ATYP | DST.ADDR | DST.PORT | DATA | +/// +----+------+------+----------+----------+----------+ +/// | 2 | 1 | 1 | Variable | 2 | Variable | +/// +----+------+------+----------+----------+----------+ +/// +/// The fields in the UDP request header are: +/// +/// o RSV Reserved X'0000' +/// o FRAG Current fragment number +/// o ATYP address type of following addresses: +/// o IP V4 address: X'01' +/// o DOMAINNAME: X'03' +/// o IP V6 address: X'04' +/// o DST.ADDR desired destination address +/// o DST.PORT desired destination port +/// o DATA user data +/// ``` +pub(super) fn new_udp_header(target_addr: T) -> Result> { + let mut header = vec![ + 0, 0, // RSV + 0, // FRAG + ]; + header.append(&mut target_addr.to_target_addr()?.to_be_bytes()?); + + Ok(header) +} + +/// Parse data from UDP client on raw buffer, return (frag, target_addr, payload). +pub(super) async fn parse_udp_request(mut req: &[u8]) -> Result<(u8, TargetAddr, &[u8])> { + let mut rsv = [0u8; 2]; + req.read_exact(&mut rsv) + .await + .context("Malformed request")?; + + if !rsv.eq(&[0u8; 2]) { + return Err(ReplyError::GeneralFailure.into()); + } + + let mut frag_and_type = [0u8; 2]; + req.read_exact(&mut frag_and_type) + .await + .context("Malformed request")?; + let [frag, atyp] = frag_and_type; + + let target_addr = read_address(&mut req, atyp).await.map_err(|e| { + // print explicit error + error!("{:#}", e); + // then convert it to a reply + ReplyError::AddressTypeNotSupported + })?; + + Ok((frag, target_addr, req)) +} + +#[cfg(test)] +mod tests { + use std::net::SocketAddr; + + use super::*; + + #[tokio::test] + async fn udp_ipv4_header_round_trips() { + let destination: SocketAddr = "10.42.0.7:5353".parse().unwrap(); + let mut packet = new_udp_header(destination).unwrap(); + packet.extend_from_slice(b"payload"); + + let (fragment, parsed_destination, payload) = parse_udp_request(&packet).await.unwrap(); + + assert_eq!(fragment, 0); + assert_eq!(parsed_destination, TargetAddr::Ip(destination)); + assert_eq!(payload, b"payload"); + } + + #[tokio::test] + async fn udp_domain_header_round_trips() { + let mut packet = new_udp_header(("peer.example", 443)).unwrap(); + packet.extend_from_slice(b"hello"); + + let (_, parsed_destination, payload) = parse_udp_request(&packet).await.unwrap(); + + assert_eq!( + parsed_destination, + TargetAddr::Domain("peer.example".to_string(), 443) + ); + assert_eq!(payload, b"hello"); + } + + #[tokio::test] + async fn udp_header_rejects_nonzero_reserved_field() { + let err = parse_udp_request(&[1, 0, 0, consts::SOCKS5_ADDR_TYPE_IPV4]) + .await + .expect_err("nonzero reserved field must fail"); + + assert!(matches!( + err, + SocksError::ReplyError(ReplyError::GeneralFailure) + )); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/socks5/codec/target_addr.rs b/vendor/easytier/easytier-core/src/gateway/socks5/codec/target_addr.rs new file mode 100644 index 0000000..3b6e073 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/socks5/codec/target_addr.rs @@ -0,0 +1,248 @@ +use super::{SocksError, consts}; +use consts::SOCKS5_ADDR_TYPE_IPV4; + +use anyhow::Context; +use std::fmt; +use std::io; +use std::net::{Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6}; +use std::vec::IntoIter; +use thiserror::Error; +use tokio::io::{AsyncRead, AsyncReadExt}; + +use tracing::debug; + +/// SOCKS5 reply code +#[derive(Error, Debug)] +pub enum AddrError { + #[error("DNS Resolution failed")] + DNSResolutionFailed, + #[error("Can't read IPv4")] + IPv4Unreadable, + #[error("Can't read IPv6")] + IPv6Unreadable, + #[error("Can't read port number")] + PortNumberUnreadable, + #[error("Can't read domain len")] + DomainLenUnreadable, + #[error("Can't read Domain content")] + DomainContentUnreadable, + #[error("Malformed UTF-8")] + Utf8, + #[error("Unknown address type")] + IncorrectAddressType, + #[error("{0}")] + Custom(String), +} + +/// A description of a connection target. +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub enum TargetAddr { + /// Connect to an IP address. + Ip(SocketAddr), + /// Connect to a fully qualified domain name. + /// + /// The domain name will be passed along to the proxy server and DNS lookup + /// will happen there. + Domain(String, u16), +} + +impl TargetAddr { + pub fn to_be_bytes(&self) -> anyhow::Result> { + let mut buf = vec![]; + match self { + TargetAddr::Ip(SocketAddr::V4(addr)) => { + debug!("TargetAddr::IpV4"); + + buf.extend_from_slice(&[SOCKS5_ADDR_TYPE_IPV4]); + + debug!("addr ip {:?}", (*addr.ip()).octets()); + buf.extend_from_slice(&(addr.ip()).octets()); // ip + buf.extend_from_slice(&addr.port().to_be_bytes()); // port + } + TargetAddr::Ip(SocketAddr::V6(addr)) => { + debug!("TargetAddr::IpV6"); + buf.extend_from_slice(&[consts::SOCKS5_ADDR_TYPE_IPV6]); + + debug!("addr ip {:?}", (*addr.ip()).octets()); + buf.extend_from_slice(&(addr.ip()).octets()); // ip + buf.extend_from_slice(&addr.port().to_be_bytes()); // port + } + TargetAddr::Domain(domain, port) => { + debug!("TargetAddr::Domain"); + if domain.len() > u8::MAX as usize { + return Err(SocksError::ExceededMaxDomainLen(domain.len()).into()); + } + buf.extend_from_slice(&[consts::SOCKS5_ADDR_TYPE_DOMAIN_NAME, domain.len() as u8]); + buf.extend_from_slice(domain.as_bytes()); // domain content + buf.extend_from_slice(&port.to_be_bytes()); + // port content (.to_be_bytes() convert from u16 to u8 type) + } + } + Ok(buf) + } +} + +impl std::net::ToSocketAddrs for TargetAddr { + type Iter = IntoIter; + + fn to_socket_addrs(&self) -> io::Result { + match self { + TargetAddr::Ip(address) => Ok(vec![*address].into_iter()), + TargetAddr::Domain(_, _) => Err(io::Error::other( + "domain name has to be explicitly resolved", + )), + } + } +} + +impl fmt::Display for TargetAddr { + #[inline] + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + match *self { + TargetAddr::Ip(ref addr) => write!(f, "{}", addr), + TargetAddr::Domain(ref addr, ref port) => write!(f, "{}:{}", addr, port), + } + } +} + +/// A trait for objects that can be converted to `TargetAddr`. +pub trait ToTargetAddr { + /// Converts the value of `self` to a `TargetAddr`. + fn to_target_addr(&self) -> io::Result; +} + +impl ToTargetAddr for (&str, u16) { + fn to_target_addr(&self) -> io::Result { + // try to parse as an IP first + if let Ok(addr) = self.0.parse::() { + return (addr, self.1).to_target_addr(); + } + + if let Ok(addr) = self.0.parse::() { + return (addr, self.1).to_target_addr(); + } + + Ok(TargetAddr::Domain(self.0.to_owned(), self.1)) + } +} + +impl ToTargetAddr for SocketAddr { + fn to_target_addr(&self) -> io::Result { + Ok(TargetAddr::Ip(*self)) + } +} + +impl ToTargetAddr for SocketAddrV4 { + fn to_target_addr(&self) -> io::Result { + SocketAddr::V4(*self).to_target_addr() + } +} + +impl ToTargetAddr for SocketAddrV6 { + fn to_target_addr(&self) -> io::Result { + SocketAddr::V6(*self).to_target_addr() + } +} + +impl ToTargetAddr for (Ipv4Addr, u16) { + fn to_target_addr(&self) -> io::Result { + SocketAddrV4::new(self.0, self.1).to_target_addr() + } +} + +impl ToTargetAddr for (Ipv6Addr, u16) { + fn to_target_addr(&self) -> io::Result { + SocketAddrV6::new(self.0, self.1, 0, 0).to_target_addr() + } +} + +#[derive(Debug)] +pub enum Addr { + V4([u8; 4]), + V6([u8; 16]), + Domain(String), // Vec<[u8]> or Box<[u8]> or String ? +} + +/// This function is used by the client & the server +pub async fn read_address( + stream: &mut T, + atyp: u8, +) -> anyhow::Result { + let addr = match atyp { + consts::SOCKS5_ADDR_TYPE_IPV4 => { + debug!("Address type `IPv4`"); + let mut bytes = [0u8; 4]; + stream + .read_exact(&mut bytes) + .await + .context(AddrError::IPv4Unreadable)?; + Addr::V4(bytes) + } + consts::SOCKS5_ADDR_TYPE_IPV6 => { + debug!("Address type `IPv6`"); + let mut bytes = [0u8; 16]; + stream + .read_exact(&mut bytes) + .await + .context(AddrError::IPv6Unreadable)?; + Addr::V6(bytes) + } + consts::SOCKS5_ADDR_TYPE_DOMAIN_NAME => { + debug!("Address type `domain`"); + let mut len = [0]; + stream + .read_exact(&mut len) + .await + .context(AddrError::DomainLenUnreadable)?; + let mut domain = vec![0u8; len[0] as usize]; + stream + .read_exact(&mut domain) + .await + .context(AddrError::DomainContentUnreadable)?; + // make sure the bytes are correct utf8 string + let domain = String::from_utf8(domain).context(AddrError::Utf8)?; + + Addr::Domain(domain) + } + _ => return Err(anyhow::anyhow!(AddrError::IncorrectAddressType)), + }; + + // Find port number + let mut port = [0u8; 2]; + stream + .read_exact(&mut port) + .await + .context(AddrError::PortNumberUnreadable)?; + // Convert (u8 * 2) into u16 + let port = (port[0] as u16) << 8 | port[1] as u16; + + // Merge ADDRESS + PORT into a TargetAddr + let addr: TargetAddr = match addr { + Addr::V4([a, b, c, d]) => (Ipv4Addr::new(a, b, c, d), port).to_target_addr()?, + Addr::V6(x) => (Ipv6Addr::from(x), port).to_target_addr()?, + Addr::Domain(domain) => TargetAddr::Domain(domain, port), + }; + + Ok(addr) +} + +#[cfg(test)] +mod tests { + use super::*; + use std::net::ToSocketAddrs; + + #[test] + fn target_addr_to_socket_addrs_keeps_ip_only_contract() { + let address: SocketAddr = "192.0.2.8:443".parse().unwrap(); + let resolved = TargetAddr::Ip(address) + .to_socket_addrs() + .unwrap() + .collect::>(); + assert_eq!(resolved, vec![address]); + + let error = TargetAddr::Domain("peer.example".into(), 443) + .to_socket_addrs() + .unwrap_err(); + assert_eq!(error.kind(), io::ErrorKind::Other); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/socks5/host.rs b/vendor/easytier/easytier-core/src/gateway/socks5/host.rs new file mode 100644 index 0000000..45af66d --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/socks5/host.rs @@ -0,0 +1,371 @@ +use std::{ + io, + net::{IpAddr, Ipv6Addr, SocketAddr, SocketAddrV6}, + sync::{Arc, Mutex}, +}; + +use crate::{ + host::dns::{DnsQuery, DnsResolver}, + socket::{ + IpVersion, SocketContext, + udp::{UdpBindOptions, VirtualUdpSocket, VirtualUdpSocketFactory}, + }, +}; + +use super::{ + codec::{AddrError, Result, SocksError, TargetAddr, new_udp_header, parse_udp_request}, + server::{Socks5ServerRuntime, Socks5UdpAssociation}, +}; + +/// Portable SOCKS command runtime backed exclusively by host capabilities. +pub(crate) struct HostSocks5ServerRuntime +where + H: VirtualUdpSocketFactory, +{ + host: Arc, + dns: Arc, + socket_context: SocketContext, +} + +impl HostSocks5ServerRuntime +where + H: VirtualUdpSocketFactory, +{ + pub fn new(host: Arc, dns: Arc, socket_context: SocketContext) -> Self { + Self { + host, + dns, + socket_context, + } + } + + async fn resolve_target(&self, target: TargetAddr) -> Result { + match target { + TargetAddr::Ip(address) => Ok(address), + TargetAddr::Domain(domain, port) => { + tracing::debug!(%domain, "attempting SOCKS DNS resolution"); + let address = self + .dns + .resolve(DnsQuery::new(domain.clone(), self.socket_context.clone())) + .await + .map_err(|error| { + SocksError::Other(error.context(AddrError::DNSResolutionFailed)) + })? + .into_iter() + .next() + .ok_or_else(|| { + SocksError::Other(anyhow::Error::new(AddrError::Custom(format!( + "cannot resolve SOCKS domain {domain}" + )))) + })?; + let address = SocketAddr::new(address, port); + tracing::debug!(%address, "SOCKS domain resolved"); + Ok(address) + } + } + } + + fn udp_bind_options(&self) -> UdpBindOptions { + UdpBindOptions::socks5() + .with_need_protect(false) + .with_context(self.socket_context.clone().with_ip_version(IpVersion::V6)) + .with_local_addr(Some(SocketAddr::V6(SocketAddrV6::new( + Ipv6Addr::UNSPECIFIED, + 0, + 0, + 0, + )))) + } +} + +#[async_trait::async_trait] +impl Socks5ServerRuntime for HostSocks5ServerRuntime +where + H: VirtualUdpSocketFactory, +{ + async fn resolve_dns(&self, target_addr: TargetAddr) -> Result { + self.resolve_target(target_addr).await.map(TargetAddr::Ip) + } + + async fn bind_udp_association(&self) -> Result> { + let inbound = self + .host + .bind_udp(self.udp_bind_options()) + .await + .map_err(SocksError::Other)?; + Ok(Box::new(HostSocks5UdpAssociation { + inbound, + host: self.host.clone(), + socket_context: self.socket_context.clone(), + client: Mutex::new(None), + })) + } +} + +struct HostSocks5UdpAssociation +where + H: VirtualUdpSocketFactory, +{ + inbound: Arc, + host: Arc, + socket_context: SocketContext, + client: Mutex>, +} + +#[async_trait::async_trait] +impl Socks5UdpAssociation for HostSocks5UdpAssociation +where + H: VirtualUdpSocketFactory, +{ + fn local_addr(&self) -> io::Result { + self.inbound.local_addr() + } + + async fn transfer(self: Box) -> Result<()> { + let outbound = self + .host + .bind_udp( + UdpBindOptions::socks5() + .with_context(self.socket_context.clone().with_ip_version(IpVersion::V6)) + .with_local_addr(Some(SocketAddr::V6(SocketAddrV6::new( + Ipv6Addr::UNSPECIFIED, + 0, + 0, + 0, + )))), + ) + .await + .map_err(SocksError::Other)?; + tokio::try_join!( + transfer_requests(self.as_ref(), outbound.as_ref()), + transfer_responses(self.as_ref(), outbound.as_ref()), + )?; + Ok(()) + } +} + +async fn transfer_requests( + association: &HostSocks5UdpAssociation, + outbound: &H::Socket, +) -> Result<()> +where + H: VirtualUdpSocketFactory, +{ + let mut buffer = vec![0u8; 0x10000]; + loop { + let (size, client) = association.inbound.recv_from(&mut buffer).await?; + { + let mut pinned = association.client.lock().unwrap(); + match *pinned { + None => *pinned = Some(client), + Some(current) if current == client => {} + Some(_) => continue, + } + } + + let (fragment, target, data) = parse_udp_request(&buffer[..size]).await?; + if fragment != 0 { + tracing::debug!(fragment, "discarding fragmented SOCKS UDP request"); + return Ok(()); + } + + let target = match target { + TargetAddr::Ip(address) => address, + TargetAddr::Domain(_, _) => { + return Err(io::Error::other( + "SOCKS UDP domain targets must be explicitly resolved by the client", + ) + .into()); + } + }; + outbound.send_to(data, ipv4_mapped_addr(target)).await?; + } +} + +async fn transfer_responses( + association: &HostSocks5UdpAssociation, + outbound: &H::Socket, +) -> Result<()> +where + H: VirtualUdpSocketFactory, +{ + let mut buffer = vec![0u8; 0x10000]; + loop { + let (size, remote) = outbound.recv_from(&mut buffer).await?; + let client = *association.client.lock().unwrap(); + let Some(client) = client else { + continue; + }; + let mut data = new_udp_header(ipv4_mapped_addr(remote))?; + data.extend_from_slice(&buffer[..size]); + association.inbound.send_to(&data, client).await?; + } +} + +fn ipv4_mapped_addr(mut address: SocketAddr) -> SocketAddr { + if let IpAddr::V4(ipv4) = address.ip() { + address.set_ip(IpAddr::V6(ipv4.to_ipv6_mapped())); + } + address +} + +#[cfg(test)] +mod tests { + use super::*; + use std::collections::VecDeque; + use std::sync::atomic::{AtomicUsize, Ordering}; + + struct StaticDns; + + #[async_trait::async_trait] + impl DnsResolver for StaticDns { + async fn resolve(&self, query: DnsQuery) -> anyhow::Result> { + assert_eq!(query.host, "peer.example"); + Ok(vec!["192.0.2.8".parse().unwrap()]) + } + } + + #[derive(Default)] + struct MockSocket { + receives: Mutex, SocketAddr)>>, + sends: Mutex, SocketAddr)>>, + } + + #[async_trait::async_trait] + impl VirtualUdpSocket for MockSocket { + fn local_addr(&self) -> io::Result { + Ok("[::]:42000".parse().unwrap()) + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> io::Result { + self.sends.lock().unwrap().push((data.to_vec(), addr)); + Ok(data.len()) + } + + async fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + let (data, addr) = self.receives.lock().unwrap().pop_front().unwrap(); + buf[..data.len()].copy_from_slice(&data); + Ok((data.len(), addr)) + } + } + + #[derive(Default)] + struct MockHost { + binds: AtomicUsize, + options: Mutex>, + } + + #[async_trait::async_trait] + impl VirtualUdpSocketFactory for MockHost { + type Socket = MockSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.binds.fetch_add(1, Ordering::Relaxed); + self.options.lock().unwrap().push(options); + Ok(Arc::new(MockSocket::default())) + } + } + + #[tokio::test] + async fn resolves_and_binds_only_through_host_capabilities() { + let host = Arc::new(MockHost::default()); + let context = SocketContext::default().with_socket_mark(Some(7)); + let runtime = + HostSocks5ServerRuntime::new(host.clone(), Arc::new(StaticDns), context.clone()); + + assert_eq!( + runtime + .resolve_dns(TargetAddr::Domain("peer.example".into(), 443)) + .await + .unwrap(), + TargetAddr::Ip("192.0.2.8:443".parse().unwrap()) + ); + let association = runtime.bind_udp_association().await.unwrap(); + assert_eq!(association.local_addr().unwrap().port(), 42000); + assert_eq!(host.binds.load(Ordering::Relaxed), 1); + let options = host.options.lock().unwrap(); + assert_eq!( + options[0].purpose, + crate::socket::udp::UdpSocketPurpose::Socks5 + ); + assert_eq!(options[0].context.socket_mark, context.socket_mark); + assert_eq!(options[0].context.ip_version, IpVersion::V6); + assert!( + !options[0].need_protect, + "SOCKS5 association socket is inbound" + ); + } + + #[tokio::test] + async fn udp_requests_pin_the_first_client_and_map_ipv4_targets() { + let client: SocketAddr = "192.0.2.1:1000".parse().unwrap(); + let other_client: SocketAddr = "192.0.2.2:1000".parse().unwrap(); + let target: SocketAddr = "198.51.100.3:53".parse().unwrap(); + let inbound = Arc::new(MockSocket::default()); + let outbound = MockSocket::default(); + + let mut request = new_udp_header(target).unwrap(); + request.extend_from_slice(b"first"); + let mut ignored = new_udp_header(target).unwrap(); + ignored.extend_from_slice(b"ignored"); + let mut fragmented = new_udp_header(target).unwrap(); + fragmented[2] = 1; + inbound.receives.lock().unwrap().extend([ + (request, client), + (ignored, other_client), + (fragmented, client), + ]); + + let association = HostSocks5UdpAssociation { + inbound, + host: Arc::new(MockHost::default()), + socket_context: SocketContext::default(), + client: Mutex::new(None), + }; + transfer_requests(&association, &outbound).await.unwrap(); + + assert_eq!(*association.client.lock().unwrap(), Some(client)); + let sends = outbound.sends.lock().unwrap(); + assert_eq!(sends.len(), 1); + assert_eq!(sends[0].0, b"first"); + assert_eq!(sends[0].1, "[::ffff:198.51.100.3]:53".parse().unwrap()); + } + + #[tokio::test] + async fn udp_requests_reject_domain_targets_without_dns() { + let client: SocketAddr = "192.0.2.1:1000".parse().unwrap(); + let inbound = Arc::new(MockSocket::default()); + let outbound = MockSocket::default(); + let mut request = new_udp_header(("peer.example", 53)).unwrap(); + request.extend_from_slice(b"query"); + inbound + .receives + .lock() + .unwrap() + .push_back((request, client)); + + let association = HostSocks5UdpAssociation { + inbound, + host: Arc::new(MockHost::default()), + socket_context: SocketContext::default(), + client: Mutex::new(None), + }; + let error = transfer_requests(&association, &outbound) + .await + .unwrap_err(); + + assert!(error.to_string().contains("must be explicitly resolved")); + assert!(outbound.sends.lock().unwrap().is_empty()); + } + + #[test] + fn udp_response_preserves_ipv6_wire_family_for_mapped_ipv4() { + let remote = ipv4_mapped_addr("198.51.100.3:53".parse().unwrap()); + let header = new_udp_header(remote).unwrap(); + + assert_eq!( + header[3], + crate::gateway::socks5::codec::consts::SOCKS5_ADDR_TYPE_IPV6 + ); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/socks5/mod.rs b/vendor/easytier/easytier-core/src/gateway/socks5/mod.rs new file mode 100644 index 0000000..dfa2084 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/socks5/mod.rs @@ -0,0 +1,13 @@ +//! SOCKS5 protocol and Host-listener Adapter for the gateway data plane. + +#![forbid(unsafe_code)] + +mod adapter; +mod codec; +mod host; +mod server; + +pub(crate) use adapter::Socks5GatewayAdapter; +pub(crate) use codec::{Result, SocksError}; +pub(crate) use host::HostSocks5ServerRuntime; +pub(crate) use server::{AcceptAuthentication, AsyncTcpConnector, Config, Socks5Socket}; diff --git a/vendor/easytier/easytier-core/src/gateway/socks5/server.rs b/vendor/easytier/easytier-core/src/gateway/socks5/server.rs new file mode 100644 index 0000000..a35d5b6 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/socks5/server.rs @@ -0,0 +1,876 @@ +use super::codec::{ + AuthenticationMethod, ReplyError, Result, Socks5Command, SocksError, TargetAddr, consts, + read_address, +}; +use anyhow::Context; +use std::io; +use std::net::IpAddr; +use std::net::Ipv4Addr; +use std::net::SocketAddr; +use std::pin::Pin; +use std::sync::Arc; +use std::task::Poll; +use tokio::io::AsyncReadExt; +use tokio::io::{AsyncRead, AsyncWrite, AsyncWriteExt}; +use tracing::{debug, error, info, trace}; + +#[derive(Clone)] +pub(crate) struct Config { + /// Timeout of the command request + request_timeout: u64, + /// Avoid useless roundtrips if we don't need the Authentication layer + skip_auth: bool, + /// Enable dns-resolving + dns_resolve: bool, + /// Enable command execution + execute_command: bool, + /// Enable UDP support + allow_udp: bool, + /// For some complex scenarios, we may want to either accept Username/Password configuration + /// or IP Whitelisting, in case the client send only 1-2 auth methods (no auth) rather than 3 (with auth) + allow_no_auth: bool, + /// Contains the authentication trait to use the user against with + auth: Option>, +} + +impl Default for Config { + fn default() -> Self { + Config { + request_timeout: 10, + skip_auth: false, + dns_resolve: true, + execute_command: true, + allow_udp: false, + allow_no_auth: false, + auth: None, + } + } +} + +/// Use this trait to handle a custom authentication on your end. +#[async_trait::async_trait] +pub(crate) trait Authentication: Send + Sync { + type Item; + + async fn authenticate(&self, credentials: Option<(String, String)>) -> Option; +} + +/// This will simply return Option::None, which denies the authentication +#[derive(Copy, Clone, Default)] +pub(crate) struct DenyAuthentication {} + +#[async_trait::async_trait] +impl Authentication for DenyAuthentication { + type Item = (); + + async fn authenticate(&self, _credentials: Option<(String, String)>) -> Option { + None + } +} + +/// While this one will always allow the user in. +#[derive(Copy, Clone, Default)] +pub(crate) struct AcceptAuthentication {} + +#[async_trait::async_trait] +impl Authentication for AcceptAuthentication { + type Item = (); + + async fn authenticate(&self, _credentials: Option<(String, String)>) -> Option { + Some(()) + } +} + +impl Config { + /// How much time it should wait until the request timeout. + pub fn set_request_timeout(&mut self, n: u64) -> &mut Self { + self.request_timeout = n; + self + } + + /// Skip the entire auth/handshake part, which means the server will directly wait for + /// the command request. + pub fn set_skip_auth(&mut self, value: bool) -> &mut Self { + self.skip_auth = value; + self.auth = None; + self + } + + /// For some complex scenarios, we may want to either accept Username/Password configuration + /// or IP Whitelisting, in case the client send only 2 auth methods rather than 3 (with auth) + pub fn set_allow_no_auth(&mut self, value: bool) -> &mut Self { + self.allow_no_auth = value; + self + } +} + +#[async_trait::async_trait] +pub(crate) trait AsyncTcpConnector { + type S: AsyncRead + AsyncWrite + Unpin + Send; + + async fn tcp_connect(&self, addr: SocketAddr, timeout_s: u64) -> Result; +} + +#[async_trait::async_trait] +pub(crate) trait Socks5UdpAssociation: Send { + fn local_addr(&self) -> io::Result; + + async fn transfer(self: Box) -> Result<()>; +} + +#[async_trait::async_trait] +pub(crate) trait Socks5ServerRuntime: Send + Sync { + async fn resolve_dns(&self, target_addr: TargetAddr) -> Result; + + async fn bind_udp_association(&self) -> Result>; +} + +/// Wrap TcpStream and contains Socks5 protocol implementation. +pub(crate) struct Socks5Socket< + T: AsyncRead + AsyncWrite + Unpin, + A: Authentication, + C: AsyncTcpConnector, +> { + inner: T, + config: Arc>, + target_addr: Option, + cmd: Option, + /// Socket address which will be used in the reply message. + reply_ip: Option, + tcp_connector: C, + runtime: Arc, +} + +impl + Socks5Socket +{ + pub fn new( + socket: T, + config: Arc>, + tcp_connector: C, + runtime: Arc, + ) -> Self { + Socks5Socket { + inner: socket, + config, + target_addr: None, + cmd: None, + reply_ip: None, + tcp_connector, + runtime, + } + } + + /// Process clients SOCKS requests + /// This is the entry point where a whole request is processed. + pub async fn upgrade_to_socks5(mut self) -> Result> { + trace!("upgrading to socks5..."); + + // Handshake + if !self.config.skip_auth { + let methods = self.get_methods().await?; + + let auth_method = self.can_accept_method(methods).await?; + + if self.config.auth.is_some() { + self.authenticate(auth_method).await?; + } + } else { + debug!("skipping auth"); + } + + match self.request().await { + Ok(_) => {} + Err(SocksError::ReplyError(e)) => { + // If a reply error has been returned, we send it to the client + self.reply_error(&e).await?; + return Err(e.into()); // propagate the error to end this connection's task + } + // if any other errors has been detected, we simply end connection's task + Err(d) => return Err(d), + }; + + Ok(self) + } + + /// Read the authentication method provided by the client. + /// A client send a list of methods that he supports, he could send + /// + /// - 0: Non auth + /// - 2: Auth with username/password + /// + /// Altogether, then the server choose to use of of these, + /// or deny the handshake (thus the connection). + /// + /// # Examples + /// ```text + /// {SOCKS Version, methods-length} + /// eg. (non-auth) {5, 2} + /// eg. (auth) {5, 3} + /// ``` + /// + async fn get_methods(&mut self) -> Result> { + trace!("Socks5Socket: get_methods()"); + // read the first 2 bytes which contains the SOCKS version and the methods len() + let mut header = [0u8; 2]; + self.inner + .read_exact(&mut header) + .await + .context("Can't read methods")?; + let [version, methods_len] = header; + debug!( + "Handshake headers: [version: {version}, methods len: {len}]", + version = version, + len = methods_len, + ); + + if version != consts::SOCKS5_VERSION { + return Err(SocksError::UnsupportedSocksVersion(version)); + } + + // {METHODS available from the client} + // eg. (non-auth) {0, 1} + // eg. (auth) {0, 1, 2} + let mut methods = vec![0u8; methods_len as usize]; + self.inner + .read_exact(&mut methods) + .await + .context("Can't get methods.")?; + debug!("methods supported sent by the client: {:?}", &methods); + + // Return methods available + Ok(methods) + } + + /// Decide to whether or not, accept the authentication method. + /// Don't forget that the methods list sent by the client, contains one or more methods. + /// + /// # Request + /// + /// Client send an array of 3 entries: [0, 1, 2] + /// ```text + /// {SOCKS Version, Authentication chosen} + /// eg. (non-auth) {5, 0} + /// eg. (GSSAPI) {5, 1} + /// eg. (auth) {5, 2} + /// ``` + /// + /// # Response + /// ```text + /// eg. (accept non-auth) {5, 0x00} + /// eg. (non-acceptable) {5, 0xff} + /// ``` + /// + async fn can_accept_method(&mut self, client_methods: Vec) -> Result { + let method_supported; + + if let Some(_auth) = self.config.auth.as_ref() { + if client_methods.contains(&consts::SOCKS5_AUTH_METHOD_PASSWORD) { + // can auth with password + method_supported = consts::SOCKS5_AUTH_METHOD_PASSWORD; + } else { + // client hasn't provided a password + if self.config.allow_no_auth { + // but we allow no auth, for ip whitelisting + method_supported = consts::SOCKS5_AUTH_METHOD_NONE; + } else { + // we don't allow no auth, so we deny the entry + debug!("Don't support this auth method, reply with (0xff)"); + self.inner + .write_all(&[ + consts::SOCKS5_VERSION, + consts::SOCKS5_AUTH_METHOD_NOT_ACCEPTABLE, + ]) + .await + .context("Can't reply with method not acceptable.")?; + + return Err(SocksError::AuthMethodUnacceptable(client_methods)); + } + } + } else { + method_supported = consts::SOCKS5_AUTH_METHOD_NONE; + } + + debug!( + "Reply with method {} ({})", + AuthenticationMethod::from_u8(method_supported).context("Method not supported")?, + method_supported + ); + self.inner + .write(&[consts::SOCKS5_VERSION, method_supported]) + .await + .context("Can't reply with method auth-none")?; + Ok(method_supported) + } + + async fn read_username_password(socket: &mut T) -> Result<(String, String)> { + trace!("Socks5Socket: authenticate()"); + let mut header = [0u8; 2]; + socket + .read_exact(&mut header) + .await + .context("Can't read user len")?; + let [version, user_len] = header; + debug!( + "Auth: [version: {version}, user len: {len}]", + version = version, + len = user_len, + ); + + if user_len < 1 { + return Err(SocksError::AuthenticationFailed(format!( + "Username malformed ({} chars)", + user_len + ))); + } + + let mut username = vec![0u8; user_len as usize]; + socket + .read_exact(&mut username) + .await + .context("Can't get username.")?; + debug!("username bytes: {:?}", &username); + + let mut pass_len = [0u8; 1]; + socket + .read_exact(&mut pass_len) + .await + .context("Can't read pass len")?; + let [pass_len] = pass_len; + debug!("Auth: [pass len: {len}]", len = pass_len,); + + if pass_len < 1 { + return Err(SocksError::AuthenticationFailed(format!( + "Password malformed ({} chars)", + pass_len + ))); + } + + let mut password = vec![0u8; pass_len as usize]; + socket + .read_exact(&mut password) + .await + .context("Can't get password.")?; + debug!("password bytes: {:?}", &password); + + let username = String::from_utf8(username).context("Failed to convert username")?; + let password = String::from_utf8(password).context("Failed to convert password")?; + + Ok((username, password)) + } + + /// Only called if + /// - this server has `Authentication` trait implemented. + /// - and the client supports authentication via username/password + /// - or the client doesn't send authentication, but we let the trait decides if the `allow_no_auth()` set as `true` + async fn authenticate(&mut self, auth_method: u8) -> Result { + let credentials = if auth_method == consts::SOCKS5_AUTH_METHOD_PASSWORD { + let credentials = Self::read_username_password(&mut self.inner).await?; + Some(credentials) + } else { + // the client hasn't provided any credentials, the function auth.authenticate() + // will then check None, according to other parameters provided by the trait + // such as IP, etc. + None + }; + + let auth = self.config.auth.as_ref().context("No auth module")?; + + if let Some(credentials) = auth.authenticate(credentials).await { + if auth_method == consts::SOCKS5_AUTH_METHOD_PASSWORD { + // only the password way expect to write a response at this moment + self.inner + .write_all(&[1, consts::SOCKS5_REPLY_SUCCEEDED]) + .await + .context("Can't reply auth success")?; + } + + info!("User logged successfully."); + + Ok(credentials) + } else { + self.inner + .write_all(&[1, consts::SOCKS5_AUTH_METHOD_NOT_ACCEPTABLE]) + .await + .context("Can't reply with auth method not acceptable.")?; + + Err(SocksError::AuthenticationRejected( + "Authentication, rejected.".to_string(), + )) + } + } + + /// Wrapper to principally cover ReplyError types for both functions read & execute request. + async fn request(&mut self) -> Result<()> { + self.read_command().await?; + + if self.config.dns_resolve { + self.resolve_dns().await?; + } else { + debug!("Domain won't be resolved because `dns_resolve`'s config has been turned off.") + } + + if self.config.execute_command { + self.execute_command().await?; + } + + Ok(()) + } + + /// Reply error to the client with the reply code according to the RFC. + async fn reply_error(&mut self, error: &ReplyError) -> Result<()> { + let reply = new_reply(error, "0.0.0.0:0".parse().unwrap()); + debug!("reply error to be written: {:?}", &reply); + + self.inner + .write(&reply) + .await + .context("Can't write the reply!")?; + + self.inner.flush().await.context("Can't flush the reply!")?; + + Ok(()) + } + + /// Decide to whether or not, accept the authentication method. + /// Don't forget that the methods list sent by the client, contains one or more methods. + /// + /// # Request + /// ```text + /// +----+-----+-------+------+----------+----------+ + /// |VER | CMD | RSV | ATYP | DST.ADDR | DST.PORT | + /// +----+-----+-------+------+----------+----------+ + /// | 1 | 1 | 1 | 1 | Variable | 2 | + /// +----+-----+-------+------+----------+----------+ + /// ``` + /// + /// It the request is correct, it should returns a ['SocketAddr']. + /// + async fn read_command(&mut self) -> Result<()> { + let mut header = [0u8; 4]; + self.inner + .read_exact(&mut header) + .await + .context("Malformed request")?; + let [version, cmd, rsv, address_type] = header; + debug!( + "Request: [version: {version}, command: {cmd}, rev: {rsv}, address_type: {address_type}]", + version = version, + cmd = cmd, + rsv = rsv, + address_type = address_type, + ); + + if version != consts::SOCKS5_VERSION { + return Err(SocksError::UnsupportedSocksVersion(version)); + } + + match Socks5Command::from_u8(cmd) { + None => return Err(ReplyError::CommandNotSupported.into()), + Some(cmd) => match cmd { + Socks5Command::TCPConnect => { + self.cmd = Some(cmd); + } + Socks5Command::UDPAssociate => { + if !self.config.allow_udp { + return Err(ReplyError::CommandNotSupported.into()); + } + self.cmd = Some(cmd); + } + Socks5Command::TCPBind => return Err(ReplyError::CommandNotSupported.into()), + }, + } + + // Guess address type + let target_addr = read_address(&mut self.inner, address_type) + .await + .map_err(|e| { + // print explicit error + error!("{:#}", e); + // then convert it to a reply + ReplyError::AddressTypeNotSupported + })?; + + self.target_addr = Some(target_addr); + + debug!("Request target is {}", self.target_addr.as_ref().unwrap()); + + Ok(()) + } + + /// This function is public, it can be call manually on your own-willing + /// if config flag has been turned off: `Config::dns_resolve == false`. + pub async fn resolve_dns(&mut self) -> Result<()> { + trace!("resolving dns"); + if let Some(target_addr) = self.target_addr.take() { + // decide whether we have to resolve DNS or not + self.target_addr = match target_addr { + TargetAddr::Domain(_, _) => Some(self.runtime.resolve_dns(target_addr).await?), + TargetAddr::Ip(_) => Some(target_addr), + }; + } + + Ok(()) + } + + /// Execute the socks5 command that the client wants. + async fn execute_command(&mut self) -> Result<()> { + match &self.cmd { + None => Err(ReplyError::CommandNotSupported.into()), + Some(cmd) => match cmd { + Socks5Command::TCPBind => Err(ReplyError::CommandNotSupported.into()), + Socks5Command::TCPConnect => return self.execute_command_connect().await, + Socks5Command::UDPAssociate => { + if self.config.allow_udp { + return self.execute_command_udp_assoc().await; + } else { + Err(ReplyError::CommandNotSupported.into()) + } + } + }, + } + } + + /// Connect to the target address that the client wants, + /// then forward the data between them (client <=> target address). + async fn execute_command_connect(&mut self) -> Result<()> { + let addr = match self.target_addr.as_ref().context("target_addr empty")? { + TargetAddr::Ip(addr) => *addr, + TargetAddr::Domain(_, _) => { + return Err(io::Error::other( + "domain must be resolved when SOCKS DNS resolution is enabled", + ) + .into()); + } + }; + + // TCP connect with timeout, to avoid memory leak for connection that takes forever + let outbound = self + .tcp_connector + .tcp_connect(addr, self.config.request_timeout) + .await?; + + debug!("Connected to remote destination"); + + self.inner + .write(&new_reply( + &ReplyError::Succeeded, + SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 0), + )) + .await + .context("Can't write successful reply")?; + + self.inner.flush().await.context("Can't flush the reply!")?; + + debug!("Wrote success"); + + transfer(&mut self.inner, outbound).await + } + + /// Bind to a random UDP port, wait for the traffic from + /// the client, and then forward the data to the remote addr. + async fn execute_command_udp_assoc(&mut self) -> Result<()> { + // The DST.ADDR and DST.PORT fields contain the address and port that + // the client expects to use to send UDP datagrams on for the + // association. The server MAY use this information to limit access + // to the association. + // @see Page 6, https://datatracker.ietf.org/doc/html/rfc1928. + // + // We do NOT limit the access from the client currently in this implementation. + let _not_used = self.target_addr.as_ref(); + + // Listen with UDP6 socket, so the client can connect to it with either + // IPv4 or IPv6. + let association = self.runtime.bind_udp_association().await?; + + // Respect the pre-populated reply IP address. + self.inner + .write(&new_reply( + &ReplyError::Succeeded, + SocketAddr::new( + self.reply_ip.context("invalid reply ip")?, + association.local_addr()?.port(), + ), + )) + .await + .context("Can't write successful reply")?; + + debug!("Wrote success"); + + association.transfer().await?; + + Ok(()) + } +} + +/// Copy data between two peers +/// Using 2 different generators, because they could be different structs with same traits. +async fn transfer(mut inbound: I, mut outbound: O) -> Result<()> +where + I: AsyncRead + AsyncWrite + Unpin, + O: AsyncRead + AsyncWrite + Unpin, +{ + match tokio::io::copy_bidirectional(&mut inbound, &mut outbound).await { + Ok(res) => info!("transfer closed ({}, {})", res.0, res.1), + Err(err) => error!("transfer error: {:?}", err), + }; + + Ok(()) +} + +// Fixes the issue "cannot borrow data in dereference of `Pin<&mut >` as mutable" +// +// cf. https://users.rust-lang.org/t/take-in-impl-future-cannot-borrow-data-in-a-dereference-of-pin/52042 +impl Unpin for Socks5Socket where + T: AsyncRead + AsyncWrite + Unpin +{ +} + +/// Allow us to read directly from the struct +impl AsyncRead for Socks5Socket +where + T: AsyncRead + AsyncWrite + Unpin, +{ + fn poll_read( + mut self: Pin<&mut Self>, + context: &mut std::task::Context, + buf: &mut tokio::io::ReadBuf<'_>, + ) -> Poll> { + Pin::new(&mut self.inner).poll_read(context, buf) + } +} + +/// Allow us to write directly into the struct +impl AsyncWrite for Socks5Socket +where + T: AsyncRead + AsyncWrite + Unpin, +{ + fn poll_write( + mut self: Pin<&mut Self>, + context: &mut std::task::Context, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut self.inner).poll_write(context, buf) + } + + fn poll_flush( + mut self: Pin<&mut Self>, + context: &mut std::task::Context, + ) -> Poll> { + Pin::new(&mut self.inner).poll_flush(context) + } + + fn poll_shutdown( + mut self: Pin<&mut Self>, + context: &mut std::task::Context, + ) -> Poll> { + Pin::new(&mut self.inner).poll_shutdown(context) + } +} + +/// Generate reply code according to the RFC. +fn new_reply(error: &ReplyError, sock_addr: SocketAddr) -> Vec { + let (addr_type, mut ip_oct, mut port) = match sock_addr { + SocketAddr::V4(sock) => ( + consts::SOCKS5_ADDR_TYPE_IPV4, + sock.ip().octets().to_vec(), + sock.port().to_be_bytes().to_vec(), + ), + SocketAddr::V6(sock) => ( + consts::SOCKS5_ADDR_TYPE_IPV6, + sock.ip().octets().to_vec(), + sock.port().to_be_bytes().to_vec(), + ), + }; + + let mut reply = vec![ + consts::SOCKS5_VERSION, + error.as_u8(), // transform the error into byte code + 0x00, // reserved + addr_type, // address type (ipv4, v6, domain) + ]; + reply.append(&mut ip_oct); + reply.append(&mut port); + + reply +} + +#[cfg(test)] +mod tests { + use std::sync::Mutex; + + use tokio::io::{AsyncReadExt, AsyncWriteExt, DuplexStream}; + + use super::*; + + struct SimpleUserPassword { + username: String, + password: String, + } + + #[async_trait::async_trait] + impl Authentication for SimpleUserPassword { + type Item = (); + + async fn authenticate(&self, credentials: Option<(String, String)>) -> Option { + credentials + .filter(|(username, password)| { + username == &self.username && password == &self.password + }) + .map(|_| ()) + } + } + + impl Config { + fn with_authentication(self, authentication: T) -> Config { + Config { + request_timeout: self.request_timeout, + skip_auth: self.skip_auth, + dns_resolve: self.dns_resolve, + execute_command: self.execute_command, + allow_udp: self.allow_udp, + allow_no_auth: self.allow_no_auth, + auth: Some(Arc::new(authentication)), + } + } + } + + struct TestConnector { + outbound: Mutex>, + } + + #[async_trait::async_trait] + impl AsyncTcpConnector for TestConnector { + type S = DuplexStream; + + async fn tcp_connect(&self, _addr: SocketAddr, _timeout_s: u64) -> Result { + self.outbound + .lock() + .unwrap() + .take() + .context("test outbound already taken") + .map_err(Into::into) + } + } + + struct TestRuntime; + + #[async_trait::async_trait] + impl Socks5ServerRuntime for TestRuntime { + async fn resolve_dns(&self, target_addr: TargetAddr) -> Result { + Ok(target_addr) + } + + async fn bind_udp_association(&self) -> Result> { + Err(SocksError::Io(io::Error::new( + io::ErrorKind::Unsupported, + "UDP is not used by this test runtime", + ))) + } + } + + fn connector(outbound: DuplexStream) -> TestConnector { + TestConnector { + outbound: Mutex::new(Some(outbound)), + } + } + + #[tokio::test] + async fn no_auth_connect_handshake_transfers_bidirectionally() { + let (server_stream, mut client_stream) = tokio::io::duplex(1024); + let (outbound, mut destination_stream) = tokio::io::duplex(1024); + let mut config = Config::::default(); + config.set_allow_no_auth(true); + let socket = Socks5Socket::new( + server_stream, + Arc::new(config), + connector(outbound), + Arc::new(TestRuntime), + ); + let task = tokio::spawn(socket.upgrade_to_socks5()); + + client_stream.write_all(&[5, 1, 0]).await.unwrap(); + let mut method_reply = [0u8; 2]; + client_stream.read_exact(&mut method_reply).await.unwrap(); + assert_eq!(method_reply, [5, 0]); + + client_stream + .write_all(&[5, 1, 0, 1, 10, 42, 0, 7, 0, 80]) + .await + .unwrap(); + let mut connect_reply = [0u8; 10]; + client_stream.read_exact(&mut connect_reply).await.unwrap(); + assert_eq!(connect_reply[0..2], [5, 0]); + + client_stream.write_all(b"request").await.unwrap(); + let mut request = [0u8; 7]; + destination_stream.read_exact(&mut request).await.unwrap(); + assert_eq!(&request, b"request"); + + destination_stream.write_all(b"response").await.unwrap(); + let mut response = [0u8; 8]; + client_stream.read_exact(&mut response).await.unwrap(); + assert_eq!(&response, b"response"); + + drop(client_stream); + drop(destination_stream); + assert!(task.await.unwrap().is_ok()); + } + + #[tokio::test] + async fn unresolved_domain_keeps_dns_disabled_failure_semantics() { + let (server_stream, _client_stream) = tokio::io::duplex(128); + let (outbound, _destination_stream) = tokio::io::duplex(128); + let mut socket = Socks5Socket::new( + server_stream, + Arc::new(Config::::default()), + connector(outbound), + Arc::new(TestRuntime), + ); + socket.target_addr = Some(TargetAddr::Domain("peer.example".into(), 443)); + + let error = socket.execute_command_connect().await.unwrap_err(); + + assert!(matches!(error, SocksError::Io(_))); + } + + #[tokio::test] + async fn password_authentication_rejection_preserves_wire_reply() { + let (server_stream, mut client_stream) = tokio::io::duplex(128); + let (outbound, _destination_stream) = tokio::io::duplex(128); + let config = + Config::::default().with_authentication(SimpleUserPassword { + username: "user".to_string(), + password: "correct".to_string(), + }); + let socket = Socks5Socket::new( + server_stream, + Arc::new(config), + connector(outbound), + Arc::new(TestRuntime), + ); + let task = tokio::spawn(socket.upgrade_to_socks5()); + + client_stream.write_all(&[5, 1, 2]).await.unwrap(); + let mut method_reply = [0u8; 2]; + client_stream.read_exact(&mut method_reply).await.unwrap(); + assert_eq!(method_reply, [5, 2]); + + client_stream + .write_all(&[ + 1, 4, b'u', b's', b'e', b'r', 5, b'w', b'r', b'o', b'n', b'g', + ]) + .await + .unwrap(); + let mut auth_reply = [0u8; 2]; + client_stream.read_exact(&mut auth_reply).await.unwrap(); + assert_eq!(auth_reply, [1, 0xff]); + + let err = task + .await + .unwrap() + .err() + .expect("wrong password must reject authentication"); + assert!(matches!(err, SocksError::AuthenticationRejected(_))); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/udp_broadcast.rs b/vendor/easytier/easytier-core/src/gateway/udp_broadcast.rs new file mode 100644 index 0000000..e293c55 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/udp_broadcast.rs @@ -0,0 +1,718 @@ +use std::net::Ipv4Addr; + +use cidr::Ipv4Inet; +use smoltcp::wire::{ + IPV4_HEADER_LEN, IpAddress, IpProtocol, Ipv4Packet, UDP_HEADER_LEN, UdpPacket, +}; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct PhysicalInterface { + addr: Ipv4Addr, + directed_broadcast: Ipv4Addr, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub struct NonContiguousIpv4Netmask(Ipv4Addr); + +impl NonContiguousIpv4Netmask { + pub fn netmask(self) -> Ipv4Addr { + self.0 + } +} + +impl PhysicalInterface { + pub fn from_observation( + addr: Ipv4Addr, + netmask: Option, + is_internal: bool, + virtual_addr: Ipv4Addr, + ) -> Result, NonContiguousIpv4Netmask> { + if is_internal || addr == virtual_addr { + return Ok(None); + } + + let Some(netmask) = netmask else { + return Ok(None); + }; + let prefix = prefix_len_from_netmask(netmask).ok_or(NonContiguousIpv4Netmask(netmask))?; + Ok(Self::from_ip_and_prefix(addr, prefix)) + } + + pub fn from_ip_and_prefix(addr: Ipv4Addr, prefix: u8) -> Option { + if should_ignore_interface_addr(addr) || prefix > 30 { + return None; + } + + Some(Self { + addr, + directed_broadcast: directed_broadcast(addr, prefix)?, + }) + } + + pub fn address(&self) -> Ipv4Addr { + self.addr + } + + pub fn directed_broadcast(&self) -> Ipv4Addr { + self.directed_broadcast + } +} + +#[derive(Debug, Clone)] +pub struct BroadcastRelayConfig { + virtual_ipv4: Ipv4Inet, + physical_interfaces: Vec, +} + +impl BroadcastRelayConfig { + pub fn new(virtual_ipv4: Ipv4Inet, physical_interfaces: Vec) -> Self { + let mut eligible_interfaces = Vec::with_capacity(physical_interfaces.len()); + for interface in physical_interfaces { + if interface.addr == virtual_ipv4.address() || eligible_interfaces.contains(&interface) + { + continue; + } + eligible_interfaces.push(interface); + } + + Self { + virtual_ipv4, + physical_interfaces: eligible_interfaces, + } + } + + pub fn virtual_ipv4(&self) -> &Ipv4Inet { + &self.virtual_ipv4 + } + + pub fn physical_interfaces(&self) -> &[PhysicalInterface] { + &self.physical_interfaces + } + + fn is_physical_source(&self, addr: Ipv4Addr) -> bool { + self.physical_interfaces + .iter() + .any(|iface| iface.addr == addr) + } + + fn normalize_destination(&self, dst: Ipv4Addr) -> Option { + if dst.is_broadcast() || dst.is_multicast() { + return Some(dst); + } + + self.physical_interfaces + .iter() + .any(|iface| iface.directed_broadcast == dst) + .then_some(self.virtual_ipv4.last_address()) + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct NormalizedPacket { + pub packet: Vec, + pub destination: Ipv4Addr, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub struct UdpPacketSummary { + pub src: Ipv4Addr, + pub dst: Ipv4Addr, + pub src_port: u16, + pub dst_port: u16, + pub ip_len: usize, + pub udp_len: usize, + pub payload_len: usize, +} + +impl UdpPacketSummary { + pub fn parse(packet: &[u8]) -> Option { + if packet.len() < IPV4_HEADER_LEN { + return None; + } + let ipv4_packet = Ipv4Packet::new_unchecked(packet); + if ipv4_packet.version() != 4 || ipv4_packet.next_header() != IpProtocol::Udp { + return None; + } + + let header_len = usize::from(ipv4_packet.header_len()); + let total_len = usize::from(ipv4_packet.total_len()); + if header_len < IPV4_HEADER_LEN + || total_len < header_len + UDP_HEADER_LEN + || total_len > packet.len() + { + return None; + } + + let udp_packet = UdpPacket::new_unchecked(&packet[header_len..total_len]); + let udp_len = usize::from(udp_packet.len()); + if udp_len < UDP_HEADER_LEN || header_len + udp_len != total_len { + return None; + } + + Some(Self { + src: ipv4_packet.src_addr(), + dst: ipv4_packet.dst_addr(), + src_port: udp_packet.src_port(), + dst_port: udp_packet.dst_port(), + ip_len: total_len, + udp_len, + payload_len: udp_len - UDP_HEADER_LEN, + }) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum UdpBroadcastPacketRejection { + MalformedIpv4, + NotUdpIpv4, + Fragmented, + BadIpv4Length, + IgnoredSource, + VirtualSourceDuplicate, + NonPhysicalSource, + UnsupportedDestination, + LoopbackDestination, + MalformedUdp, + BadUdpLength, +} + +impl UdpBroadcastPacketRejection { + pub fn reason(self) -> &'static str { + match self { + Self::MalformedIpv4 => "malformed_ipv4", + Self::NotUdpIpv4 => "not_udp_ipv4", + Self::Fragmented => "fragmented", + Self::BadIpv4Length => "bad_ipv4_length", + Self::IgnoredSource => "ignored_source", + Self::VirtualSourceDuplicate => "virtual_source_duplicate", + Self::NonPhysicalSource => "non_physical_source", + Self::UnsupportedDestination => "unsupported_destination", + Self::LoopbackDestination => "loopback_destination", + Self::MalformedUdp => "malformed_udp", + Self::BadUdpLength => "bad_udp_length", + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +struct ParsedUdpBroadcastPacket { + header_len: usize, + udp_len: usize, + normalized_destination: Ipv4Addr, +} + +fn should_ignore_interface_addr(addr: Ipv4Addr) -> bool { + addr.is_unspecified() || addr.is_loopback() || addr.is_multicast() || addr.is_broadcast() +} + +fn prefix_len_from_netmask(mask: Ipv4Addr) -> Option { + let raw = u32::from(mask); + let prefix = raw.count_ones() as u8; + let expected = if prefix == 0 { + 0 + } else { + u32::MAX << (32 - prefix) + }; + (raw == expected).then_some(prefix) +} + +fn directed_broadcast(addr: Ipv4Addr, prefix: u8) -> Option { + if prefix > 32 { + return None; + } + + let mask = if prefix == 0 { + 0 + } else { + u32::MAX << (32 - prefix) + }; + Some(Ipv4Addr::from(u32::from(addr) | !mask)) +} + +fn parse_udp_broadcast( + packet: &[u8], + config: &BroadcastRelayConfig, +) -> Result { + if packet.len() < IPV4_HEADER_LEN { + return Err(UdpBroadcastPacketRejection::MalformedIpv4); + } + let ipv4_packet = Ipv4Packet::new_unchecked(packet); + if ipv4_packet.version() != 4 || ipv4_packet.next_header() != IpProtocol::Udp { + return Err(UdpBroadcastPacketRejection::NotUdpIpv4); + } + + if ipv4_packet.frag_offset() != 0 || ipv4_packet.more_frags() { + return Err(UdpBroadcastPacketRejection::Fragmented); + } + + let header_len = usize::from(ipv4_packet.header_len()); + let total_len = usize::from(ipv4_packet.total_len()); + if header_len < IPV4_HEADER_LEN + || total_len < header_len + UDP_HEADER_LEN + || total_len > packet.len() + { + return Err(UdpBroadcastPacketRejection::BadIpv4Length); + } + + let src = ipv4_packet.src_addr(); + let dst = ipv4_packet.dst_addr(); + if should_ignore_interface_addr(src) { + return Err(UdpBroadcastPacketRejection::IgnoredSource); + } + if src == config.virtual_ipv4.address() { + return Err(UdpBroadcastPacketRejection::VirtualSourceDuplicate); + } + if !config.is_physical_source(src) { + return Err(UdpBroadcastPacketRejection::NonPhysicalSource); + } + + let normalized_destination = config + .normalize_destination(dst) + .ok_or(UdpBroadcastPacketRejection::UnsupportedDestination)?; + if normalized_destination.is_loopback() { + return Err(UdpBroadcastPacketRejection::LoopbackDestination); + } + + let udp_packet = UdpPacket::new_unchecked(&packet[header_len..total_len]); + let udp_len = usize::from(udp_packet.len()); + if udp_len < UDP_HEADER_LEN || header_len + udp_len != total_len { + return Err(UdpBroadcastPacketRejection::BadUdpLength); + } + + Ok(ParsedUdpBroadcastPacket { + header_len, + udp_len, + normalized_destination, + }) +} + +pub fn normalize_udp_broadcast_packet( + packet: &[u8], + config: &BroadcastRelayConfig, +) -> Result { + let parsed = parse_udp_broadcast(packet, config)?; + let header_len = parsed.header_len; + let packet_len = header_len + parsed.udp_len; + let destination = parsed.normalized_destination; + let virtual_ipv4 = config.virtual_ipv4.address(); + let mut normalized = packet[..packet_len].to_vec(); + + { + let mut ipv4_packet = Ipv4Packet::new_unchecked(&mut normalized); + ipv4_packet.set_src_addr(virtual_ipv4); + ipv4_packet.set_dst_addr(destination); + ipv4_packet.set_total_len(packet_len as u16); + ipv4_packet.set_checksum(0); + } + + { + let mut udp_packet = UdpPacket::new_unchecked(&mut normalized[header_len..packet_len]); + udp_packet.fill_checksum( + &IpAddress::Ipv4(virtual_ipv4), + &IpAddress::Ipv4(destination), + ); + } + + { + Ipv4Packet::new_unchecked(&mut normalized).fill_checksum(); + } + + Ok(NormalizedPacket { + packet: normalized, + destination, + }) +} + +#[derive(Clone)] +pub struct UdpBroadcastRelayStats { + packets_captured: crate::foundation::stats::CounterHandle, + packets_ignored: crate::foundation::stats::CounterHandle, + packets_forwarded: crate::foundation::stats::CounterHandle, + packets_forward_failed: crate::foundation::stats::CounterHandle, +} + +impl UdpBroadcastRelayStats { + pub(crate) fn new( + packets_captured: crate::foundation::stats::CounterHandle, + packets_ignored: crate::foundation::stats::CounterHandle, + packets_forwarded: crate::foundation::stats::CounterHandle, + packets_forward_failed: crate::foundation::stats::CounterHandle, + ) -> Self { + Self { + packets_captured, + packets_ignored, + packets_forwarded, + packets_forward_failed, + } + } + + pub fn record_captured(&self) { + self.packets_captured.inc(); + } + + pub fn record_ignored(&self) { + self.packets_ignored.inc(); + } + + pub fn record_forwarded(&self) { + self.packets_forwarded.inc(); + } + + pub fn record_forward_failed(&self) { + self.packets_forward_failed.inc(); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn config() -> BroadcastRelayConfig { + BroadcastRelayConfig::new( + "10.144.144.1/24".parse().unwrap(), + vec![PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(192, 168, 1, 7), 24).unwrap()], + ) + } + + fn build_udp_packet(src: Ipv4Addr, dst: Ipv4Addr, payload: &[u8]) -> Vec { + let mut packet = vec![0; 20 + 8 + payload.len()]; + { + let mut ipv4_packet = Ipv4Packet::new_unchecked(&mut packet); + ipv4_packet.set_version(4); + ipv4_packet.set_header_len(20); + ipv4_packet.set_total_len((20 + 8 + payload.len()) as u16); + ipv4_packet.set_hop_limit(64); + ipv4_packet.set_next_header(IpProtocol::Udp); + ipv4_packet.set_src_addr(src); + ipv4_packet.set_dst_addr(dst); + } + + { + let mut udp_packet = UdpPacket::new_unchecked(&mut packet[20..]); + udp_packet.set_src_port(12345); + udp_packet.set_dst_port(37020); + udp_packet.set_len((8 + payload.len()) as u16); + udp_packet.payload_mut().copy_from_slice(payload); + udp_packet.fill_checksum(&IpAddress::Ipv4(src), &IpAddress::Ipv4(dst)); + } + + Ipv4Packet::new_unchecked(&mut packet).fill_checksum(); + + packet + } + + fn assert_valid_checksums(packet: &[u8]) { + let ipv4_packet = Ipv4Packet::new_checked(packet).unwrap(); + assert!(ipv4_packet.verify_checksum()); + let udp_packet = UdpPacket::new_checked(ipv4_packet.payload()).unwrap(); + assert!(udp_packet.verify_checksum( + &IpAddress::Ipv4(ipv4_packet.src_addr()), + &IpAddress::Ipv4(ipv4_packet.dst_addr()), + )); + } + + #[test] + fn rewrites_limited_broadcast() { + let packet = build_udp_packet(Ipv4Addr::new(192, 168, 1, 7), Ipv4Addr::BROADCAST, b"hello"); + + let normalized = normalize_udp_broadcast_packet(&packet, &config()).unwrap(); + let ipv4_packet = Ipv4Packet::new_checked(&normalized.packet).unwrap(); + + assert_eq!(normalized.destination, Ipv4Addr::BROADCAST); + assert_eq!(ipv4_packet.src_addr(), Ipv4Addr::new(10, 144, 144, 1)); + assert_eq!(ipv4_packet.dst_addr(), Ipv4Addr::BROADCAST); + assert_eq!(&ipv4_packet.payload()[8..], b"hello"); + assert_valid_checksums(&normalized.packet); + } + + #[test] + fn rewrites_directed_broadcast() { + let packet = build_udp_packet( + Ipv4Addr::new(192, 168, 1, 7), + Ipv4Addr::new(192, 168, 1, 255), + b"directed", + ); + + let normalized = normalize_udp_broadcast_packet(&packet, &config()).unwrap(); + let ipv4_packet = Ipv4Packet::new_checked(&normalized.packet).unwrap(); + + assert_eq!(normalized.destination, Ipv4Addr::new(10, 144, 144, 255)); + assert_eq!(ipv4_packet.src_addr(), Ipv4Addr::new(10, 144, 144, 1)); + assert_eq!(ipv4_packet.dst_addr(), Ipv4Addr::new(10, 144, 144, 255)); + assert_eq!(&ipv4_packet.payload()[8..], b"directed"); + assert_valid_checksums(&normalized.packet); + } + + #[test] + fn preserves_multicast_destination() { + let multicast = Ipv4Addr::new(239, 255, 255, 250); + let packet = build_udp_packet(Ipv4Addr::new(192, 168, 1, 7), multicast, b"multicast"); + + let normalized = normalize_udp_broadcast_packet(&packet, &config()).unwrap(); + let ipv4_packet = Ipv4Packet::new_checked(&normalized.packet).unwrap(); + + assert_eq!(normalized.destination, multicast); + assert_eq!(ipv4_packet.src_addr(), Ipv4Addr::new(10, 144, 144, 1)); + assert_eq!(ipv4_packet.dst_addr(), multicast); + assert_eq!(&ipv4_packet.payload()[8..], b"multicast"); + assert_valid_checksums(&normalized.packet); + } + + #[test] + fn rejects_malformed_packets() { + assert_eq!( + normalize_udp_broadcast_packet(&[], &config()), + Err(UdpBroadcastPacketRejection::MalformedIpv4) + ); + + let mut packet = + build_udp_packet(Ipv4Addr::new(192, 168, 1, 7), Ipv4Addr::BROADCAST, b"bad"); + packet[2..4].copy_from_slice(&10u16.to_be_bytes()); + assert_eq!( + normalize_udp_broadcast_packet(&packet, &config()), + Err(UdpBroadcastPacketRejection::BadIpv4Length) + ); + } + + #[test] + fn rejects_fragments() { + let mut packet = build_udp_packet( + Ipv4Addr::new(192, 168, 1, 7), + Ipv4Addr::BROADCAST, + b"fragment", + ); + { + let mut ipv4_packet = Ipv4Packet::new_unchecked(&mut packet); + ipv4_packet.set_more_frags(true); + } + + assert_eq!( + normalize_udp_broadcast_packet(&packet, &config()), + Err(UdpBroadcastPacketRejection::Fragmented) + ); + } + + #[test] + fn rejects_non_broadcast_destinations() { + let packet = build_udp_packet( + Ipv4Addr::new(192, 168, 1, 7), + Ipv4Addr::new(192, 168, 1, 10), + b"unicast", + ); + + assert_eq!( + normalize_udp_broadcast_packet(&packet, &config()), + Err(UdpBroadcastPacketRejection::UnsupportedDestination) + ); + } + + #[test] + fn rejects_virtual_source_duplicates() { + let packet = build_udp_packet(Ipv4Addr::new(10, 144, 144, 1), Ipv4Addr::BROADCAST, b"loop"); + + assert_eq!( + normalize_udp_broadcast_packet(&packet, &config()), + Err(UdpBroadcastPacketRejection::VirtualSourceDuplicate) + ); + } + + #[test] + fn rejects_non_udp_ipv4_packets() { + let mut packet = + build_udp_packet(Ipv4Addr::new(192, 168, 1, 7), Ipv4Addr::BROADCAST, b"tcp"); + Ipv4Packet::new_unchecked(&mut packet).set_next_header(IpProtocol::Tcp); + + assert_eq!( + normalize_udp_broadcast_packet(&packet, &config()), + Err(UdpBroadcastPacketRejection::NotUdpIpv4) + ); + } + + #[test] + fn rejects_ignored_and_non_physical_sources() { + let ignored = build_udp_packet(Ipv4Addr::LOCALHOST, Ipv4Addr::BROADCAST, b"ignored"); + assert_eq!( + normalize_udp_broadcast_packet(&ignored, &config()), + Err(UdpBroadcastPacketRejection::IgnoredSource) + ); + + let non_physical = + build_udp_packet(Ipv4Addr::new(192, 168, 1, 8), Ipv4Addr::BROADCAST, b"other"); + assert_eq!( + normalize_udp_broadcast_packet(&non_physical, &config()), + Err(UdpBroadcastPacketRejection::NonPhysicalSource) + ); + } + + #[test] + fn rejects_loopback_destination_after_mapping() { + let config = BroadcastRelayConfig::new( + "127.0.0.1/24".parse().unwrap(), + vec![PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(192, 168, 1, 7), 24).unwrap()], + ); + let packet = build_udp_packet( + Ipv4Addr::new(192, 168, 1, 7), + Ipv4Addr::new(192, 168, 1, 255), + b"loopback", + ); + + assert_eq!( + normalize_udp_broadcast_packet(&packet, &config), + Err(UdpBroadcastPacketRejection::LoopbackDestination) + ); + } + + #[test] + fn summarizes_packets_and_rejects_bad_udp_length() { + let mut packet = build_udp_packet( + Ipv4Addr::new(192, 168, 1, 7), + Ipv4Addr::BROADCAST, + b"summary", + ); + assert_eq!( + UdpPacketSummary::parse(&packet), + Some(UdpPacketSummary { + src: Ipv4Addr::new(192, 168, 1, 7), + dst: Ipv4Addr::BROADCAST, + src_port: 12345, + dst_port: 37020, + ip_len: 35, + udp_len: 15, + payload_len: 7, + }) + ); + + packet[24..26].copy_from_slice(&8u16.to_be_bytes()); + assert_eq!( + normalize_udp_broadcast_packet(&packet, &config()), + Err(UdpBroadcastPacketRejection::BadUdpLength) + ); + assert_eq!(UdpPacketSummary::parse(&packet), None); + } + + #[test] + fn rejection_reasons_preserve_log_values() { + let reasons = [ + (UdpBroadcastPacketRejection::MalformedIpv4, "malformed_ipv4"), + (UdpBroadcastPacketRejection::NotUdpIpv4, "not_udp_ipv4"), + (UdpBroadcastPacketRejection::Fragmented, "fragmented"), + ( + UdpBroadcastPacketRejection::BadIpv4Length, + "bad_ipv4_length", + ), + (UdpBroadcastPacketRejection::IgnoredSource, "ignored_source"), + ( + UdpBroadcastPacketRejection::VirtualSourceDuplicate, + "virtual_source_duplicate", + ), + ( + UdpBroadcastPacketRejection::NonPhysicalSource, + "non_physical_source", + ), + ( + UdpBroadcastPacketRejection::UnsupportedDestination, + "unsupported_destination", + ), + ( + UdpBroadcastPacketRejection::LoopbackDestination, + "loopback_destination", + ), + (UdpBroadcastPacketRejection::MalformedUdp, "malformed_udp"), + (UdpBroadcastPacketRejection::BadUdpLength, "bad_udp_length"), + ]; + + for (rejection, reason) in reasons { + assert_eq!(rejection.reason(), reason); + } + } + + #[test] + fn detects_directed_broadcast_from_prefix() { + let physical = + PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(172, 16, 5, 10), 20).unwrap(); + assert_eq!( + physical.directed_broadcast(), + Ipv4Addr::new(172, 16, 15, 255) + ); + assert_eq!( + prefix_len_from_netmask(Ipv4Addr::new(255, 255, 240, 0)), + Some(20) + ); + assert_eq!(prefix_len_from_netmask(Ipv4Addr::new(255, 0, 255, 0)), None); + } + + #[test] + fn classifies_physical_interface_observations() { + let addr = Ipv4Addr::new(192, 168, 1, 7); + let virtual_addr = Ipv4Addr::new(10, 144, 144, 1); + let netmask = Ipv4Addr::new(255, 255, 255, 0); + let non_contiguous = Ipv4Addr::new(255, 0, 255, 0); + + assert_eq!( + PhysicalInterface::from_observation(addr, Some(netmask), false, virtual_addr), + Ok(PhysicalInterface::from_ip_and_prefix(addr, 24)) + ); + assert_eq!( + PhysicalInterface::from_observation(addr, None, false, virtual_addr), + Ok(None) + ); + assert_eq!( + PhysicalInterface::from_observation(addr, Some(non_contiguous), true, virtual_addr), + Ok(None) + ); + assert_eq!( + PhysicalInterface::from_observation( + virtual_addr, + Some(non_contiguous), + false, + virtual_addr, + ), + Ok(None) + ); + assert_eq!( + PhysicalInterface::from_observation(addr, Some(non_contiguous), false, virtual_addr,), + Err(NonContiguousIpv4Netmask(non_contiguous)) + ); + } + + #[test] + fn keeps_link_local_interfaces() { + let physical = + PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(169, 254, 13, 10), 16).unwrap(); + assert_eq!( + physical.directed_broadcast(), + Ipv4Addr::new(169, 254, 255, 255) + ); + } + + #[test] + fn rejects_ineligible_interface_addresses_and_prefixes() { + for addr in [ + Ipv4Addr::UNSPECIFIED, + Ipv4Addr::LOCALHOST, + Ipv4Addr::new(239, 1, 2, 3), + Ipv4Addr::BROADCAST, + ] { + assert_eq!(PhysicalInterface::from_ip_and_prefix(addr, 24), None); + } + assert_eq!( + PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(192, 168, 1, 7), 31), + None + ); + } + + #[test] + fn config_excludes_virtual_and_duplicate_interfaces() { + let virtual_interface = + PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(10, 144, 144, 1), 24).unwrap(); + let physical_interface = + PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(192, 168, 1, 7), 24).unwrap(); + + let config = BroadcastRelayConfig::new( + "10.144.144.1/24".parse().unwrap(), + vec![virtual_interface, physical_interface, physical_interface], + ); + + assert_eq!(config.physical_interfaces(), &[physical_interface]); + } +} diff --git a/vendor/easytier/easytier-core/src/gateway/vpn_portal.rs b/vendor/easytier/easytier-core/src/gateway/vpn_portal.rs new file mode 100644 index 0000000..1ffffc4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/vpn_portal.rs @@ -0,0 +1,9 @@ +//! Protocol-neutral portal runtime and host adapter seam. + +mod runtime; + +pub use runtime::{ + MAX_VPN_PORTAL_CLIENTS, PortalClientConfig, PortalClientConfigPlan, PortalClientInfoSnapshot, + PortalClientState, PortalHost, PortalInfoSnapshot, PortalListener, PortalModule, + PortalRuntimeConfig, PortalSession, validate_clients, +}; diff --git a/vendor/easytier/easytier-core/src/gateway/vpn_portal/runtime.rs b/vendor/easytier/easytier-core/src/gateway/vpn_portal/runtime.rs new file mode 100644 index 0000000..418ab29 --- /dev/null +++ b/vendor/easytier/easytier-core/src/gateway/vpn_portal/runtime.rs @@ -0,0 +1,2086 @@ +//! Protocol-neutral portal session orchestration. +//! +//! Native adapters authenticate clients and yield sessions. This module owns +//! configured client identities, attached-peer lifetimes, per-client +//! generations, and raw IPv4 packet forwarding at the Host packet seam. + +use std::{ + collections::{BTreeMap, BTreeSet}, + net::{IpAddr, Ipv4Addr}, + sync::{Arc, RwLock as StdRwLock}, +}; + +use async_trait::async_trait; +use cidr::Ipv4Inet; +use serde::{Deserialize, Serialize}; +use tokio::{ + sync::{Mutex, RwLock, mpsc, watch}, + task::{JoinHandle, JoinSet}, +}; +use tokio_util::sync::CancellationToken; + +use crate::{ + config::runtime::{CoreInstanceRuntimeConfig, CoreRuntimeConfigStore}, + events::{CoreEvent, CoreEventSink}, + foundation::stats::{CounterHandle, LabelSet, LabelType, MetricName, StatsManager}, + peers::{ + attached::{AttachedPeerConfig, AttachedPeerRuntime}, + peer_manager::PeerManagerCore, + }, + socket::SocketListener, +}; + +pub const MAX_VPN_PORTAL_CLIENTS: usize = 64; + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct PortalClientConfig { + pub name: String, + pub virtual_ip: Ipv4Inet, + #[serde(default, skip_serializing_if = "Vec::is_empty")] + pub groups: Vec, +} + +#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)] +pub struct PortalRuntimeConfig { + pub clients: Vec, +} + +/// One authenticated protocol session produced by a native portal adapter. A +/// new value is emitted only for a new authenticated client generation; +/// ordinary reauthentication and endpoint roaming stay within that adapter. +/// The endpoint watch exposes the current authenticated endpoint and any later +/// roaming within the generation. Packet channels carry complete raw IPv4 +/// packets without protocol framing. +pub struct PortalSession { + pub client_name: String, + pub endpoint: watch::Receiver, + pub identity_private_key: [u8; 32], + pub from_client: mpsc::Receiver>, + pub to_client: mpsc::Sender>, +} + +impl std::fmt::Debug for PortalSession { + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let endpoint = self.endpoint.borrow(); + formatter + .debug_struct("PortalSession") + .field("client_name", &self.client_name) + .field("endpoint", &endpoint.as_str()) + .finish_non_exhaustive() + } +} + +pub type PortalListener = Box>; + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct PortalClientConfigPlan { + pub name: String, + pub address: Ipv4Addr, + pub allowed_ips: Vec, + pub listener_url: url::Url, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum PortalClientState { + Offline, + Connecting, + Online, + Error, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct PortalClientInfoSnapshot { + pub name: String, + pub virtual_ip: Ipv4Addr, + pub groups: Vec, + pub state: PortalClientState, + pub peer_id: Option, + pub endpoint: Option, + pub tunnel_ip: Option, + pub client_config: String, + pub error: Option, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct PortalInfoSnapshot { + pub vpn_type: String, + pub clients: Vec, + pub listener: Option, +} + +#[async_trait] +pub trait PortalHost: Send + Sync + 'static { + /// Starts the shared protocol engines. Core owns accepted generations and + /// all portable attached-peer lifecycle after this seam. + async fn start_listeners(&self) -> anyhow::Result>; + + fn name(&self) -> String; + + fn render_client_config(&self, plan: &PortalClientConfigPlan) -> String; + + /// Replaces the configured client set at runtime without restarting the + /// listeners. Established sessions of untouched clients must stay intact; + /// sessions of removed or changed clients are torn down through the + /// regular channel-close cleanup path. + async fn update_clients(&self, clients: &[PortalClientConfig]) -> anyhow::Result<()> { + let _ = clients; + anyhow::bail!("portal host does not support runtime client updates") + } +} + +#[derive(Debug, Clone)] +struct ClientStatus { + state: PortalClientState, + generation: u64, + peer_id: Option, + endpoint: Option, + tunnel_ip: Option, + error: Option, +} + +impl Default for ClientStatus { + fn default() -> Self { + Self { + state: PortalClientState::Offline, + generation: 0, + peer_id: None, + endpoint: None, + tunnel_ip: None, + error: None, + } + } +} + +#[derive(Clone)] +struct PortalClientTrafficMetrics { + upload_bytes: CounterHandle, + upload_packets: CounterHandle, + download_bytes: CounterHandle, + download_packets: CounterHandle, +} + +impl PortalClientTrafficMetrics { + fn new(stats: &StatsManager, network_name: &str, client_name: &str) -> Self { + let labels = LabelSet::new() + .with_label_type(LabelType::NetworkName(network_name.to_owned())) + .with_label_type(LabelType::VpnPortalClient(client_name.to_owned())); + Self { + upload_bytes: stats.get_counter(MetricName::VpnPortalClientBytesTx, labels.clone()), + upload_packets: stats.get_counter(MetricName::VpnPortalClientPacketsTx, labels.clone()), + download_bytes: stats.get_counter(MetricName::VpnPortalClientBytesRx, labels.clone()), + download_packets: stats.get_counter(MetricName::VpnPortalClientPacketsRx, labels), + } + } + + fn record_upload(&self, bytes: usize) { + self.upload_bytes.add(bytes as u64); + self.upload_packets.inc(); + } + + fn record_download(&self, bytes: usize) { + self.download_bytes.add(bytes as u64); + self.download_packets.inc(); + } +} + +struct PortalRuntime { + cancel: CancellationToken, + tasks: JoinSet<()>, + listener_urls: Vec, +} + +pub struct PortalModule { + operation: Mutex<()>, + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + config: Option>>, + host: Option>, + events: Arc, + statuses: Arc>>, + session_locks: Arc>>>>, + traffic_metrics: Arc>>, + runtime: Mutex>, +} + +impl PortalModule { + pub fn new( + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + config: Option, + host: Option>, + events: Arc, + ) -> anyhow::Result> { + if let Some(config) = config.as_ref() { + validate_clients(config, runtime_config.snapshot().as_ref())?; + } + let network_name = runtime_config + .snapshot() + .peer + .runtime + .network_identity + .network_name + .clone(); + let stats = peer_manager.stats_manager(); + let traffic_metrics = config + .as_ref() + .into_iter() + .flat_map(|config| &config.clients) + .map(|client| { + ( + client.name.clone(), + PortalClientTrafficMetrics::new(&stats, &network_name, &client.name), + ) + }) + .collect(); + Ok(Arc::new(Self { + operation: Mutex::new(()), + peer_manager, + runtime_config, + config: config.map(|config| Arc::new(StdRwLock::new(config))), + host, + events, + statuses: Arc::new(RwLock::new(BTreeMap::new())), + session_locks: Arc::new(RwLock::new(BTreeMap::new())), + traffic_metrics: Arc::new(StdRwLock::new(traffic_metrics)), + runtime: Mutex::new(None), + })) + } + #[cfg(feature = "vpn-portal")] + pub(crate) fn validate_runtime_config( + &self, + runtime_config: &CoreInstanceRuntimeConfig, + ) -> anyhow::Result<()> { + let Some(config) = self.config.as_ref() else { + return Ok(()); + }; + let config = config.read().unwrap(); + validate_runtime_compatibility(&config, runtime_config) + } + + /// Replaces the configured client set at runtime. Untouched clients keep + /// their established sessions; removed and changed clients are torn down + /// through the regular cleanup path and may re-handshake afterwards. + /// + /// The caller supplies the runtime snapshot the new set must be validated + /// against, so a combined configuration patch is judged by its final + /// state rather than the currently running one. + pub async fn update_clients( + &self, + clients: Vec, + runtime: &CoreInstanceRuntimeConfig, + ) -> anyhow::Result> { + let _operation = self.operation.lock().await; + let Some(config) = self.config.as_ref() else { + anyhow::bail!("VPN portal is not configured"); + }; + if self.host.is_none() { + anyhow::bail!("VPN portal has no host adapter"); + } + let candidate = PortalRuntimeConfig { clients }; + validate_clients(&candidate, runtime)?; + + self.host + .as_ref() + .expect("checked above") + .update_clients(&candidate.clients) + .await?; + + let applied: BTreeSet = candidate + .clients + .iter() + .map(|client| client.name.clone()) + .collect(); + let removed: Vec = { + let mut current = config.write().unwrap(); + let removed: Vec = current + .clients + .iter() + .map(|client| client.name.clone()) + .filter(|name| !applied.contains(name)) + .collect(); + current.clients = candidate.clients.clone(); + removed + }; + let applied_clients = candidate.clients; + + { + let network_name = self + .runtime_config + .snapshot() + .peer + .runtime + .network_identity + .network_name + .clone(); + let stats = self.peer_manager.stats_manager(); + let mut traffic_metrics = self.traffic_metrics.write().unwrap(); + traffic_metrics.retain(|name, _| applied.contains(name)); + for name in &applied { + traffic_metrics.entry(name.clone()).or_insert_with(|| { + PortalClientTrafficMetrics::new(&stats, &network_name, name) + }); + } + } + + { + let mut statuses = self.statuses.write().await; + statuses.retain(|name, _| applied.contains(name)); + for name in &applied { + statuses.entry(name.clone()).or_default(); + } + } + { + let mut locks = self.session_locks.write().await; + for name in removed { + // Entries still held by a live session are left alone; the + // session drops its reference during its regular cleanup. + if locks + .get(&name) + .is_none_or(|lock| Arc::strong_count(lock) == 1) + { + locks.remove(&name); + } + } + } + Ok(applied_clients) + } + + pub async fn start(&self) -> anyhow::Result<()> { + let _operation = self.operation.lock().await; + if self.config.is_none() { + return Ok(()); + } + let stale_runtime = { + let mut runtime = self.runtime.lock().await; + if runtime + .as_ref() + .is_some_and(|runtime| !runtime.cancel.is_cancelled()) + { + return Ok(()); + } + runtime.take() + }; + if let Some(stale_runtime) = stale_runtime { + self.shutdown_runtime(stale_runtime).await; + } + + let host = self.host.as_ref().ok_or_else(|| { + anyhow::anyhow!("VPN portal is configured but no host adapter exists") + })?; + let listeners = host.start_listeners().await?; + if listeners.is_empty() { + anyhow::bail!("VPN portal host returned no active listeners"); + } + + let mut prepared = Vec::with_capacity(listeners.len()); + for mut listener in listeners { + listener.listen().await?; + let listener_url = listener.local_url(); + prepared.push((listener, listener_url)); + } + + let cancel = CancellationToken::new(); + let start_signal = CancellationToken::new(); + let mut tasks = JoinSet::new(); + let mut listener_urls = Vec::with_capacity(prepared.len()); + for (listener, listener_url) in prepared { + listener_urls.push(listener_url.clone()); + tasks.spawn(Self::run_listener( + listener, + listener_url, + self.peer_manager.clone(), + self.runtime_config.clone(), + self.config.clone().expect("checked above"), + self.statuses.clone(), + self.session_locks.clone(), + self.traffic_metrics.clone(), + self.events.clone(), + cancel.clone(), + start_signal.clone(), + )); + } + *self.runtime.lock().await = Some(PortalRuntime { + cancel, + tasks, + listener_urls: listener_urls.clone(), + }); + for local_url in &listener_urls { + self.events + .emit(CoreEvent::VpnPortalStarted(local_url.to_string())); + } + start_signal.cancel(); + Ok(()) + } + + #[allow(clippy::too_many_arguments)] + async fn run_listener( + mut listener: PortalListener, + listener_url: url::Url, + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + config: Arc>, + statuses: Arc>>, + session_locks: Arc>>>>, + traffic_metrics: Arc>>, + events: Arc, + cancel: CancellationToken, + start_signal: CancellationToken, + ) { + tokio::select! { + _ = cancel.cancelled() => return, + _ = start_signal.cancelled() => {} + } + let mut sessions = JoinSet::new(); + loop { + tokio::select! { + _ = cancel.cancelled() => { + break; + } + accepted = listener.accept() => match accepted { + Ok(session) => { + sessions.spawn(Self::run_session( + session, + listener_url.clone(), + peer_manager.clone(), + runtime_config.clone(), + config.clone(), + statuses.clone(), + session_locks.clone(), + traffic_metrics.clone(), + events.clone(), + cancel.clone(), + )); + } + Err(error) => { + tracing::warn!(?error, "VPN portal listener stopped accepting"); + cancel.cancel(); + break; + } + }, + _ = sessions.join_next(), if !sessions.is_empty() => {} + } + } + drop(listener); + while sessions.join_next().await.is_some() {} + } + + #[allow(clippy::too_many_arguments)] + async fn run_session( + mut session: PortalSession, + listener_url: url::Url, + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + config: Arc>, + statuses: Arc>>, + session_locks: Arc>>>>, + traffic_metrics: Arc>>, + events: Arc, + cancel: CancellationToken, + ) { + let Some(client) = config + .read() + .unwrap() + .clients + .iter() + .find(|client| client.name == session.client_name) + .cloned() + else { + tracing::warn!(client = %session.client_name, "unknown VPN portal client session"); + return; + }; + let session_lock = { + let mut locks = session_locks.write().await; + locks.entry(client.name.clone()).or_default().clone() + }; + let _session_guard = tokio::select! { + _ = cancel.cancelled() => return, + guard = session_lock.lock() => guard, + }; + let Some(traffic) = traffic_metrics.read().unwrap().get(&client.name).cloned() else { + // The client was removed by a concurrent config update while this + // session was waiting for the session lock. + tracing::warn!(client = %client.name, "VPN portal client removed before session started"); + return; + }; + let generation = { + let mut statuses = statuses.write().await; + let status = statuses.entry(client.name.clone()).or_default(); + status.generation = status.generation.wrapping_add(1); + status.state = PortalClientState::Connecting; + status.endpoint = Some(session.endpoint.borrow_and_update().clone()); + status.tunnel_ip = Some(client.virtual_ip.address()); + status.error = None; + status.generation + }; + + let attached = match AttachedPeerRuntime::connect( + peer_manager, + runtime_config, + AttachedPeerConfig { + name: client.name.clone(), + virtual_ip: client.virtual_ip, + groups: client.groups.clone(), + identity_private_key: session.identity_private_key, + }, + ) + .await + { + Ok(attached) => attached, + Err(error) => { + Self::finish_generation( + &statuses, + &client.name, + generation, + Some(error.to_string()), + ) + .await; + return; + } + }; + + { + let mut statuses = statuses.write().await; + let Some(status) = statuses.get_mut(&client.name) else { + drop(statuses); + attached.close().await; + return; + }; + if status.generation != generation { + drop(statuses); + attached.close().await; + return; + } + status.state = PortalClientState::Online; + status.peer_id = Some(attached.peer_id()); + } + events.emit(CoreEvent::VpnPortalClientConnected { + portal: listener_url.to_string(), + client: client.name.clone(), + }); + + let mut client_stream = session.from_client; + let endpoint = session.endpoint; + let client_sink = session.to_client; + let client_to_mesh = { + let attached = attached.clone(); + let name = client.name.clone(); + let virtual_ip = client.virtual_ip.address(); + let traffic = traffic.clone(); + tokio::spawn(async move { + while let Some(payload) = client_stream.recv().await { + if !has_ipv4_source(&payload, virtual_ip) { + tracing::warn!(client = %name, expected = ?virtual_ip, "VPN client source does not match its assigned address"); + continue; + } + if let Err(error) = attached.send_packet(&payload).await { + tracing::debug!(?error, client = %name, "attached peer send failed"); + break; + } + traffic.record_upload(payload.len()); + } + }) + }; + let mesh_to_client = { + let attached = attached.clone(); + tokio::spawn(async move { + while let Some(packet) = attached.recv_packet().await { + let payload = packet.payload().to_vec(); + let bytes = payload.len(); + if client_sink.send(payload).await.is_err() { + break; + } + traffic.record_download(bytes); + } + }) + }; + Self::supervise_session_io( + endpoint, + statuses.clone(), + client.name.clone(), + generation, + cancel, + client_to_mesh, + mesh_to_client, + ) + .await; + + attached.close().await; + Self::finish_generation(&statuses, &client.name, generation, None).await; + events.emit(CoreEvent::VpnPortalClientDisconnected { + portal: listener_url.to_string(), + client: client.name, + }); + } + #[allow(clippy::too_many_arguments)] + async fn supervise_session_io( + mut endpoint: watch::Receiver, + statuses: Arc>>, + client_name: String, + generation: u64, + cancel: CancellationToken, + mut client_to_mesh: JoinHandle<()>, + mut mesh_to_client: JoinHandle<()>, + ) { + let mut client_to_mesh_finished = false; + let mut mesh_to_client_finished = false; + loop { + tokio::select! { + biased; + _ = cancel.cancelled() => break, + result = &mut client_to_mesh, if !client_to_mesh_finished => { + client_to_mesh_finished = true; + if let Err(error) = result { + tracing::debug!( + ?error, + client = %client_name, + "VPN portal client-to-mesh task failed" + ); + } + break; + } + result = &mut mesh_to_client, if !mesh_to_client_finished => { + mesh_to_client_finished = true; + if let Err(error) = result { + tracing::debug!( + ?error, + client = %client_name, + "VPN portal mesh-to-client task failed" + ); + } + break; + } + changed = endpoint.changed() => { + if changed.is_err() { + break; + } + let current = endpoint.borrow_and_update().clone(); + let mut statuses = statuses.write().await; + if let Some(status) = statuses.get_mut(&client_name) + && status.generation == generation + { + status.endpoint = Some(current); + } + } + } + } + if !client_to_mesh_finished { + client_to_mesh.abort(); + let _ = client_to_mesh.await; + } + if !mesh_to_client_finished { + mesh_to_client.abort(); + let _ = mesh_to_client.await; + } + } + + async fn finish_generation( + statuses: &RwLock>, + name: &str, + generation: u64, + error: Option, + ) { + let mut statuses = statuses.write().await; + let Some(status) = statuses.get_mut(name) else { + return; + }; + if status.generation != generation { + return; + } + status.state = if error.is_some() { + PortalClientState::Error + } else { + PortalClientState::Offline + }; + status.peer_id = None; + status.endpoint = None; + status.tunnel_ip = None; + status.error = error; + } + + async fn shutdown_runtime(&self, mut runtime: PortalRuntime) { + runtime.cancel.cancel(); + while let Some(result) = runtime.tasks.join_next().await { + if let Err(error) = result { + tracing::debug!(?error, "VPN portal listener task failed"); + } + } + for status in self.statuses.write().await.values_mut() { + *status = ClientStatus::default(); + } + } + + pub async fn stop(&self) { + let _operation = self.operation.lock().await; + let Some(runtime) = self.runtime.lock().await.take() else { + return; + }; + self.shutdown_runtime(runtime).await; + } + + pub async fn info_snapshot(&self) -> PortalInfoSnapshot { + let Some(config) = self + .config + .as_ref() + .map(|config| config.read().unwrap().clone()) + else { + return PortalInfoSnapshot { + vpn_type: "null".to_owned(), + clients: Vec::new(), + listener: None, + }; + }; + let listener_url = self + .runtime + .lock() + .await + .as_ref() + .filter(|runtime| !runtime.cancel.is_cancelled()) + .and_then(|runtime| runtime.listener_urls.first().cloned()); + let allowed_ips = self.allowed_ips().await; + let statuses = self.statuses.read().await; + let clients = config + .clients + .iter() + .map(|client| { + let status = statuses.get(&client.name).cloned().unwrap_or_default(); + let client_config = match (self.host.as_ref(), listener_url.as_ref()) { + (Some(host), Some(listener_url)) => { + let mut client_allowed_ips = allowed_ips.clone(); + client_allowed_ips.push(client.virtual_ip.network().to_string()); + client_allowed_ips.sort(); + client_allowed_ips.dedup(); + host.render_client_config(&PortalClientConfigPlan { + name: client.name.clone(), + address: client.virtual_ip.address(), + allowed_ips: client_allowed_ips, + listener_url: listener_url.clone(), + }) + } + _ => String::new(), + }; + PortalClientInfoSnapshot { + name: client.name.clone(), + virtual_ip: client.virtual_ip.address(), + groups: client.groups.clone(), + state: status.state, + peer_id: status.peer_id, + endpoint: status.endpoint, + tunnel_ip: status.tunnel_ip, + client_config, + error: status.error, + } + }) + .collect(); + PortalInfoSnapshot { + vpn_type: self + .host + .as_ref() + .map_or_else(|| "null".to_owned(), |host| host.name()), + clients, + listener: listener_url.map(|url| url.to_string()), + } + } + + async fn allowed_ips(&self) -> Vec { + let snapshot = self.runtime_config.snapshot(); + let mut allowed = BTreeSet::new(); + for route in self.peer_manager.list_route_snapshots().await { + allowed.extend(route.proxy_cidrs); + } + for proxy in &snapshot.peer.runtime.core.routes.proxy_networks { + let mapped = proxy.mapped.as_ref().unwrap_or(&proxy.real); + allowed.insert(format!("{}/{}", mapped.address, mapped.prefix_len)); + } + allowed.into_iter().collect() + } +} + +/// Validates a client set. The empty set is legal in every lifecycle stage: +/// a portal with zero clients keeps listening and accepts nothing, so +/// clearing all clients never produces a configuration that fails a later +/// instance recreation. +pub fn validate_clients( + config: &PortalRuntimeConfig, + runtime_config: &CoreInstanceRuntimeConfig, +) -> anyhow::Result<()> { + if config.clients.len() > MAX_VPN_PORTAL_CLIENTS { + anyhow::bail!("VPN portal supports at most {MAX_VPN_PORTAL_CLIENTS} clients"); + } + validate_runtime_compatibility(config, runtime_config)?; + let snapshot = runtime_config; + let declared_groups = snapshot + .peer + .acl_group_declarations + .iter() + .map(|group| group.group_name.as_str()) + .collect::>(); + let mut names = BTreeSet::new(); + let mut addresses = BTreeSet::new(); + for client in &config.clients { + validate_client_name(&client.name)?; + if !names.insert(client.name.as_str()) { + anyhow::bail!("duplicate VPN portal client name: {}", client.name); + } + if !addresses.insert(client.virtual_ip.address()) { + anyhow::bail!("duplicate VPN portal virtual IP: {}", client.virtual_ip); + } + for group in &client.groups { + if !declared_groups.contains(group.as_str()) { + anyhow::bail!( + "VPN portal client {} uses unknown ACL group {group}", + client.name + ); + } + } + } + Ok(()) +} + +fn validate_runtime_compatibility( + config: &PortalRuntimeConfig, + runtime_config: &CoreInstanceRuntimeConfig, +) -> anyhow::Result<()> { + let snapshot = runtime_config; + if snapshot + .peer + .runtime + .network_identity + .network_secret + .as_deref() + .is_none_or(str::is_empty) + { + anyhow::bail!("VPN portal requires an admin node with a non-empty network secret"); + } + let host_address = snapshot + .peer + .runtime + .core + .routes + .ipv4 + .as_ref() + .and_then(|prefix| match prefix.address { + IpAddr::V4(address) => Some(address), + IpAddr::V6(_) => None, + }); + for client in &config.clients { + let address = client.virtual_ip.address(); + let network = client.virtual_ip.network(); + if host_address == Some(address) + || address == network.first_address() + || address == network.last_address() + { + anyhow::bail!( + "VPN portal client {} has an unusable virtual IP {}", + client.name, + address + ); + } + } + Ok(()) +} + +fn validate_client_name(name: &str) -> anyhow::Result<()> { + let valid = !name.is_empty() + && name.len() <= 63 + && name + .bytes() + .all(|byte| byte.is_ascii_alphanumeric() || byte == b'-') + && name + .as_bytes() + .first() + .is_some_and(u8::is_ascii_alphanumeric) + && name + .as_bytes() + .last() + .is_some_and(u8::is_ascii_alphanumeric); + if !valid { + anyhow::bail!("invalid VPN portal client name: {name}"); + } + Ok(()) +} + +fn ipv4_source(payload: &[u8]) -> Option { + if payload.len() < 20 || payload[0] >> 4 != 4 { + return None; + } + Some(Ipv4Addr::new( + payload[12], + payload[13], + payload[14], + payload[15], + )) +} + +fn has_ipv4_source(payload: &[u8], expected: Ipv4Addr) -> bool { + ipv4_source(payload) == Some(expected) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::{ + config::{ + IpPrefix, NetworkIdentity, + peers::{PeerGroupIdentity, PeerRuntimeSnapshot}, + runtime::CoreRuntimeConfig, + }, + peers::peer_manager::PeerManagerCore, + }; + use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; + use std::{ + future::pending, + sync::{ + Mutex as StdMutex, Weak, + atomic::{AtomicBool, AtomicUsize, Ordering}, + }, + }; + use tokio::sync::{Notify, mpsc}; + use x25519_dalek::{PublicKey, StaticSecret}; + + #[derive(Default)] + struct RecordingEvents(std::sync::Mutex>); + + impl CoreEventSink for RecordingEvents { + fn emit(&self, event: CoreEvent) { + self.0.lock().unwrap().push(event); + } + } + + struct StaticPortalHost { + listeners: StdMutex>>, + } + + impl StaticPortalHost { + fn new(listeners: Vec) -> Arc { + Arc::new(Self { + listeners: StdMutex::new(Some(listeners)), + }) + } + } + + #[async_trait] + impl PortalHost for StaticPortalHost { + async fn start_listeners(&self) -> anyhow::Result> { + self.listeners + .lock() + .unwrap() + .take() + .ok_or_else(|| anyhow::anyhow!("test listeners already started")) + } + + fn name(&self) -> String { + "test".to_owned() + } + + fn render_client_config(&self, plan: &PortalClientConfigPlan) -> String { + format!( + "config:{}:{}:{}", + plan.name, + plan.address, + plan.allowed_ips.join(",") + ) + } + } + + #[derive(Debug)] + struct PendingPortalListener { + url: url::Url, + accept_calls: Arc, + } + + #[async_trait] + impl SocketListener for PendingPortalListener { + type Accepted = PortalSession; + + async fn listen(&mut self) -> anyhow::Result<()> { + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + self.accept_calls.fetch_add(1, Ordering::SeqCst); + pending().await + } + + fn local_url(&self) -> url::Url { + self.url.clone() + } + } + + #[derive(Debug)] + struct FailingListenPortalListener { + url: url::Url, + listening: Arc, + fail: Arc, + } + + #[async_trait] + impl SocketListener for FailingListenPortalListener { + type Accepted = PortalSession; + + async fn listen(&mut self) -> anyhow::Result<()> { + self.listening.notify_one(); + self.fail.notified().await; + anyhow::bail!("listener setup failed") + } + + async fn accept(&mut self) -> anyhow::Result { + unreachable!("failed listeners cannot accept") + } + + fn local_url(&self) -> url::Url { + self.url.clone() + } + } + + #[derive(Debug)] + struct FailingAcceptPortalListener { + url: url::Url, + } + + #[async_trait] + impl SocketListener for FailingAcceptPortalListener { + type Accepted = PortalSession; + + async fn listen(&mut self) -> anyhow::Result<()> { + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + anyhow::bail!("listener receive failed") + } + + fn local_url(&self) -> url::Url { + self.url.clone() + } + } + + struct RestartingPortalHost { + starts: AtomicUsize, + accept_calls: Arc, + } + + #[async_trait] + impl PortalHost for RestartingPortalHost { + async fn start_listeners(&self) -> anyhow::Result> { + let attempt = self.starts.fetch_add(1, Ordering::SeqCst); + let url = format!("test://127.0.0.1:{}", 10000 + attempt) + .parse() + .unwrap(); + if attempt == 0 { + Ok(vec![Box::new(FailingAcceptPortalListener { url })]) + } else { + Ok(vec![Box::new(PendingPortalListener { + url, + accept_calls: self.accept_calls.clone(), + })]) + } + } + + fn name(&self) -> String { + "test".to_owned() + } + + fn render_client_config(&self, plan: &PortalClientConfigPlan) -> String { + format!("config:{}", plan.name) + } + } + + #[derive(Default)] + struct RuntimeObservingEvents { + module: StdMutex>, + runtime_visible_on_start: AtomicBool, + } + + impl CoreEventSink for RuntimeObservingEvents { + fn emit(&self, event: CoreEvent) { + if matches!(event, CoreEvent::VpnPortalStarted(_)) + && let Some(module) = self.module.lock().unwrap().upgrade() + && let Ok(runtime) = module.runtime.try_lock() + { + self.runtime_visible_on_start.store( + runtime + .as_ref() + .is_some_and(|runtime| !runtime.cancel.is_cancelled()), + Ordering::SeqCst, + ); + } + } + } + + struct TaskDropCounter(Arc); + + impl Drop for TaskDropCounter { + fn drop(&mut self) { + self.0.fetch_add(1, Ordering::SeqCst); + } + } + + fn runtime_config() -> CoreRuntimeConfigStore { + let mut peer = PeerRuntimeSnapshot::default(); + peer.runtime.network_identity = + NetworkIdentity::new("portal-test".to_owned(), "shared-secret".to_owned()); + peer.runtime.core.routes.ipv4 = Some(IpPrefix { + address: IpAddr::V4(Ipv4Addr::new(10, 82, 0, 1)), + prefix_len: 24, + }); + peer.acl_group_declarations = vec![PeerGroupIdentity { + group_name: "ops".to_owned(), + group_secret: "ops-secret".to_owned(), + }]; + CoreRuntimeConfigStore::new(CoreRuntimeConfig::default(), Arc::new(peer)) + } + + fn client(name: &str, virtual_ip: Ipv4Addr, groups: &[&str]) -> PortalClientConfig { + PortalClientConfig { + name: name.to_owned(), + virtual_ip: Ipv4Inet::new(virtual_ip, 24).unwrap(), + groups: groups.iter().map(|group| (*group).to_owned()).collect(), + } + } + + fn traffic_metrics( + peer_manager: &PeerManagerCore, + clients: &[&str], + ) -> Arc>> { + let stats = peer_manager.stats_manager(); + Arc::new(StdRwLock::new( + clients + .iter() + .map(|name| { + ( + (*name).to_owned(), + PortalClientTrafficMetrics::new(&stats, "portal-test", name), + ) + }) + .collect(), + )) + } + + fn raw_ipv4(source: Ipv4Addr, destination: Ipv4Addr) -> Vec { + let mut packet = vec![0u8; 28]; + packet[0] = 0x45; + packet[2..4].copy_from_slice(&28u16.to_be_bytes()); + packet[8] = 64; + packet[9] = 1; + packet[12..16].copy_from_slice(&source.octets()); + packet[16..20].copy_from_slice(&destination.octets()); + packet[20] = 8; + packet + } + + #[test] + fn portal_client_packet_requires_its_assigned_source() { + let assigned = Ipv4Addr::new(10, 82, 0, 2); + + assert!(has_ipv4_source( + &raw_ipv4(assigned, Ipv4Addr::new(10, 82, 0, 1)), + assigned + )); + assert!(!has_ipv4_source( + &raw_ipv4(Ipv4Addr::new(10, 82, 0, 99), Ipv4Addr::new(10, 82, 0, 1)), + assigned + )); + assert!(!has_ipv4_source(&[0u8; 8], assigned)); + } + + #[tokio::test] + async fn portal_client_traffic_accumulates_across_sessions() { + let stats = StatsManager::new(); + let first = PortalClientTrafficMetrics::new(&stats, "portal-test", "client-a"); + first.record_upload(80); + first.record_download(120); + drop(first); + + let reconnected = PortalClientTrafficMetrics::new(&stats, "portal-test", "client-a"); + reconnected.record_upload(20); + reconnected.record_download(30); + + let labels = LabelSet::new() + .with_label_type(LabelType::NetworkName("portal-test".to_owned())) + .with_label_type(LabelType::VpnPortalClient("client-a".to_owned())); + assert_eq!( + stats + .get_metric(MetricName::VpnPortalClientBytesTx, &labels) + .unwrap() + .value, + 100 + ); + assert_eq!( + stats + .get_metric(MetricName::VpnPortalClientPacketsTx, &labels) + .unwrap() + .value, + 2 + ); + assert_eq!( + stats + .get_metric(MetricName::VpnPortalClientBytesRx, &labels) + .unwrap() + .value, + 150 + ); + assert_eq!( + stats + .get_metric(MetricName::VpnPortalClientPacketsRx, &labels) + .unwrap() + .value, + 2 + ); + assert!(stats.export_prometheus().contains( + "vpn_portal_client_bytes_tx{network_name=\"portal-test\",vpn_portal_client=\"client-a\"} 100" + )); + stats.stop_cleanup_task().await; + } + + fn network_runtime() -> (Arc, CoreRuntimeConfigStore) { + network_runtime_with_secure_mode(false) + } + + fn secure_network_runtime() -> (Arc, CoreRuntimeConfigStore) { + network_runtime_with_secure_mode(true) + } + + fn network_runtime_with_secure_mode( + secure_mode: bool, + ) -> (Arc, CoreRuntimeConfigStore) { + let store = runtime_config(); + if secure_mode { + let private = StaticSecret::from([42; 32]); + let public = PublicKey::from(&private); + store.update_peer_with(|peer| { + peer.runtime.secure_mode = Some(crate::proto::common::SecureModeConfig { + enabled: true, + local_private_key: Some(BASE64_STANDARD.encode(private.to_bytes())), + local_public_key: Some(BASE64_STANDARD.encode(public.as_bytes())), + }); + }); + } + let snapshot = store.snapshot(); + let runtime = snapshot.peer.runtime.clone(); + let mut portable = crate::peers::peer_manager::PortablePeerManagerConfig::new(runtime); + portable.snapshot.acl_group_declarations = snapshot.peer.acl_group_declarations.clone(); + let (packet_sender, _packet_receiver) = crate::host::packet::host_packet_channel(); + let public_ipv6_runtime = crate::peers::public_ipv6::CorePublicIpv6Runtime::new( + store.clone(), + Arc::new(()), + Arc::new(()), + ); + let peer = Arc::new( + PeerManagerCore::new( + portable, + Vec::new(), + store.clone(), + Arc::new(()), + packet_sender, + public_ipv6_runtime, + Arc::new(()), + None, + Arc::new(()), + ) + .unwrap(), + ); + (peer, store) + } + + #[test] + fn portal_runtime_rejects_duplicate_names_and_virtual_ips() { + let runtime_config = runtime_config(); + let snapshot = runtime_config.snapshot(); + let alice = client("alice", Ipv4Addr::new(10, 82, 0, 2), &["ops"]); + + let duplicate_name = PortalRuntimeConfig { + clients: vec![ + alice.clone(), + client("alice", Ipv4Addr::new(10, 82, 0, 3), &["ops"]), + ], + }; + let error = validate_clients(&duplicate_name, snapshot.as_ref()) + .unwrap_err() + .to_string(); + assert!(error.contains("duplicate VPN portal client name")); + + let duplicate_ip = PortalRuntimeConfig { + clients: vec![alice, client("bob", Ipv4Addr::new(10, 82, 0, 2), &["ops"])], + }; + let error = validate_clients(&duplicate_ip, snapshot.as_ref()) + .unwrap_err() + .to_string(); + assert!(error.contains("duplicate VPN portal virtual IP")); + } + + #[test] + fn portal_runtime_rejects_unknown_acl_groups() { + let runtime_config = runtime_config(); + let config = PortalRuntimeConfig { + clients: vec![client("alice", Ipv4Addr::new(10, 82, 0, 2), &["unknown"])], + }; + let error = validate_clients(&config, runtime_config.snapshot().as_ref()) + .unwrap_err() + .to_string(); + assert!(error.contains("unknown ACL group")); + } + + #[test] + fn portal_runtime_rejects_credential_node() { + let runtime_config = runtime_config(); + runtime_config.update_peer_with(|peer| { + peer.runtime.network_identity.network_secret = None; + }); + let config = PortalRuntimeConfig { + clients: vec![client("alice", Ipv4Addr::new(10, 82, 0, 2), &["ops"])], + }; + + let error = validate_clients(&config, runtime_config.snapshot().as_ref()) + .unwrap_err() + .to_string(); + + assert!(error.contains("VPN portal requires an admin node")); + } + + #[test] + fn portal_client_cidr_is_independent_of_host_addressing() { + let runtime_config = runtime_config(); + runtime_config.update_peer_with(|peer| peer.runtime.core.routes.ipv4 = None); + runtime_config.update_services(|services| services.dhcp_ipv4 = true); + let config = PortalRuntimeConfig { + clients: vec![PortalClientConfig { + name: "alice".to_owned(), + virtual_ip: "10.82.0.2/16".parse().unwrap(), + groups: vec!["ops".to_owned()], + }], + }; + + validate_clients(&config, runtime_config.snapshot().as_ref()).unwrap(); + } + + #[test] + fn portal_session_debug_redacts_identity_private_key() { + let identity_private_key = [173u8; 32]; + let (_to_runtime, from_client) = mpsc::channel(1); + let (to_client, _from_runtime) = mpsc::channel(1); + let (_endpoint_sender, endpoint) = tokio::sync::watch::channel("portal://alice".to_owned()); + let session = PortalSession { + client_name: "alice".to_owned(), + endpoint, + identity_private_key, + from_client, + to_client, + }; + + let rendered = format!("{session:?}"); + assert!(!rendered.contains("identity_private_key")); + assert!(!rendered.contains(&format!("{identity_private_key:?}"))); + } + + #[tokio::test] + async fn portal_session_publishes_virtual_ip_before_first_client_packet() { + let (peer_manager, runtime_config) = network_runtime(); + peer_manager.run().await.unwrap(); + let virtual_ip = Ipv4Addr::new(10, 82, 0, 2); + let config = PortalRuntimeConfig { + clients: vec![client("alice", virtual_ip, &["ops"])], + }; + let statuses = Arc::new(RwLock::new(BTreeMap::from([( + "alice".to_owned(), + ClientStatus::default(), + )]))); + let session_locks = Arc::new(RwLock::new(BTreeMap::from([( + "alice".to_owned(), + Arc::new(Mutex::new(())), + )]))); + let (to_runtime, from_client) = mpsc::channel(1); + let (to_client, mut from_runtime) = mpsc::channel(1); + let (endpoint_sender, endpoint) = tokio::sync::watch::channel("portal://alice".to_owned()); + let session = PortalSession { + client_name: "alice".to_owned(), + endpoint, + identity_private_key: [173u8; 32], + from_client, + to_client, + }; + let cancel = CancellationToken::new(); + let task = tokio::spawn(PortalModule::run_session( + session, + "portal://listener".parse().unwrap(), + peer_manager.clone(), + runtime_config, + Arc::new(StdRwLock::new(config)), + statuses.clone(), + session_locks, + traffic_metrics(&peer_manager, &["alice"]), + Arc::new(()), + cancel, + )); + + tokio::time::timeout(std::time::Duration::from_secs(5), async { + loop { + let status = statuses.read().await.get("alice").cloned().unwrap(); + if status.state == PortalClientState::Online && status.tunnel_ip == Some(virtual_ip) + { + return; + } + assert_ne!( + status.state, + PortalClientState::Error, + "portal session failed before publishing virtual IP: {:?}", + status.error + ); + assert!( + !task.is_finished(), + "portal session ended before publishing virtual IP" + ); + tokio::task::yield_now().await; + } + }) + .await + .expect("configured virtual IP was not published before the first client packet"); + + let mesh_packet = raw_ipv4(Ipv4Addr::new(10, 82, 0, 1), virtual_ip); + let outbound = tokio::time::timeout(std::time::Duration::from_secs(5), async { + loop { + let _ = peer_manager + .send_msg_by_ip( + crate::packet::ZCPacket::new_with_payload(&mesh_packet), + IpAddr::V4(virtual_ip), + false, + ) + .await; + if let Ok(Some(packet)) = + tokio::time::timeout(std::time::Duration::from_millis(20), from_runtime.recv()) + .await + { + break packet; + } + } + }) + .await + .expect("mesh packet was not delivered before the first client packet"); + assert_eq!(&outbound[16..20], virtual_ip.octets().as_slice()); + let labels = LabelSet::new() + .with_label_type(LabelType::NetworkName("portal-test".to_owned())) + .with_label_type(LabelType::VpnPortalClient("alice".to_owned())); + assert!( + peer_manager + .stats_manager() + .get_metric(MetricName::VpnPortalClientBytesRx, &labels) + .is_some_and(|metric| metric.value >= mesh_packet.len() as u64) + ); + assert!( + peer_manager + .stats_manager() + .get_metric(MetricName::VpnPortalClientPacketsRx, &labels) + .is_some_and(|metric| metric.value >= 1) + ); + + endpoint_sender.send("portal://roamed".to_owned()).unwrap(); + tokio::time::timeout(std::time::Duration::from_secs(5), async { + loop { + let status = statuses.read().await.get("alice").cloned().unwrap(); + if status.endpoint.as_deref() == Some("portal://roamed") { + return; + } + assert!( + !task.is_finished(), + "portal session ended before publishing the roamed endpoint" + ); + tokio::task::yield_now().await; + } + }) + .await + .expect("roamed endpoint was not published"); + + drop(to_runtime); + task.await.unwrap(); + peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn portal_session_cancellation_runs_complete_cleanup() { + let (peer_manager, runtime_config) = secure_network_runtime(); + peer_manager.run().await.unwrap(); + let config = PortalRuntimeConfig { + clients: vec![client("alice", Ipv4Addr::new(10, 82, 0, 2), &["ops"])], + }; + let statuses = Arc::new(RwLock::new(BTreeMap::from([( + "alice".to_owned(), + ClientStatus::default(), + )]))); + let session_locks = Arc::new(RwLock::new(BTreeMap::from([( + "alice".to_owned(), + Arc::new(Mutex::new(())), + )]))); + let (_to_runtime, from_client) = mpsc::channel(1); + let (to_client, _from_runtime) = mpsc::channel(1); + let (_endpoint_sender, endpoint) = tokio::sync::watch::channel("portal://alice".to_owned()); + let identity_private_key = [174u8; 32]; + let identity_public_key = + *PublicKey::from(&StaticSecret::from(identity_private_key)).as_bytes(); + let session = PortalSession { + client_name: "alice".to_owned(), + endpoint, + identity_private_key, + from_client, + to_client, + }; + let cancel = CancellationToken::new(); + let events = Arc::new(RecordingEvents::default()); + let mut task = tokio::spawn(PortalModule::run_session( + session, + "portal://listener".parse().unwrap(), + peer_manager.clone(), + runtime_config, + Arc::new(StdRwLock::new(config)), + statuses.clone(), + session_locks, + traffic_metrics(&peer_manager, &["alice"]), + events.clone(), + cancel.clone(), + )); + + let attached_peer_id = tokio::time::timeout(std::time::Duration::from_secs(5), async { + loop { + let status = statuses.read().await.get("alice").cloned().unwrap(); + if status.state == PortalClientState::Online { + return status.peer_id.unwrap(); + } + assert!( + !task.is_finished(), + "portal session ended before becoming online: {:?}", + status.error + ); + tokio::task::yield_now().await; + } + }) + .await + .expect("portal session did not become online"); + assert!( + peer_manager + .credential_manager() + .is_pubkey_trusted(&identity_public_key) + ); + + cancel.cancel(); + if tokio::time::timeout(std::time::Duration::from_secs(5), &mut task) + .await + .is_err() + { + task.abort(); + let _ = task.await; + peer_manager.clear_resources().await; + panic!("portal session did not stop after cancellation"); + } + + let status = statuses.read().await.get("alice").cloned().unwrap(); + assert_eq!(status.state, PortalClientState::Offline); + assert!(status.peer_id.is_none()); + assert!(status.tunnel_ip.is_none()); + assert!( + !peer_manager + .get_peer_map() + .has_direct_attached_peer(attached_peer_id) + ); + assert!( + !peer_manager + .credential_manager() + .is_pubkey_trusted(&identity_public_key) + ); + { + let events = events.0.lock().unwrap(); + assert_eq!( + events + .iter() + .filter(|event| matches!(event, CoreEvent::VpnPortalClientConnected { .. })) + .count(), + 1 + ); + assert_eq!( + events + .iter() + .filter(|event| matches!(event, CoreEvent::VpnPortalClientDisconnected { .. })) + .count(), + 1 + ); + } + peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn portal_session_stops_when_outbound_packet_task_ends() { + let (peer_manager, runtime_config) = network_runtime(); + peer_manager.run().await.unwrap(); + let virtual_ip = Ipv4Addr::new(10, 82, 0, 2); + let config = PortalRuntimeConfig { + clients: vec![client("alice", virtual_ip, &["ops"])], + }; + let statuses = Arc::new(RwLock::new(BTreeMap::from([( + "alice".to_owned(), + ClientStatus::default(), + )]))); + let session_locks = Arc::new(RwLock::new(BTreeMap::from([( + "alice".to_owned(), + Arc::new(Mutex::new(())), + )]))); + let (to_runtime, from_client) = mpsc::channel(1); + let (to_client, from_runtime) = mpsc::channel(1); + let (_endpoint_sender, endpoint) = tokio::sync::watch::channel("portal://alice".to_owned()); + let session = PortalSession { + client_name: "alice".to_owned(), + endpoint, + identity_private_key: [175u8; 32], + from_client, + to_client, + }; + let events = Arc::new(RecordingEvents::default()); + let task = tokio::spawn(PortalModule::run_session( + session, + "portal://listener".parse().unwrap(), + peer_manager.clone(), + runtime_config, + Arc::new(StdRwLock::new(config)), + statuses.clone(), + session_locks, + traffic_metrics(&peer_manager, &["alice"]), + events.clone(), + CancellationToken::new(), + )); + + let client_packet = raw_ipv4(virtual_ip, Ipv4Addr::new(10, 82, 0, 1)); + to_runtime.send(client_packet.clone()).await.unwrap(); + let attached_peer_id = tokio::time::timeout(std::time::Duration::from_secs(5), async { + loop { + let status = statuses.read().await.get("alice").cloned().unwrap(); + if status.state == PortalClientState::Online && status.tunnel_ip == Some(virtual_ip) + { + return status.peer_id.unwrap(); + } + assert!( + !task.is_finished(), + "portal session ended before publishing its virtual address: {:?}", + status.error + ); + tokio::task::yield_now().await; + } + }) + .await + .expect("portal session did not publish its virtual address"); + + drop(from_runtime); + let mesh_packet = raw_ipv4(Ipv4Addr::new(10, 82, 0, 1), virtual_ip); + if tokio::time::timeout(std::time::Duration::from_secs(5), async { + while !task.is_finished() { + let _ = peer_manager + .send_msg_by_ip( + crate::packet::ZCPacket::new_with_payload(&mesh_packet), + IpAddr::V4(virtual_ip), + false, + ) + .await; + tokio::task::yield_now().await; + } + }) + .await + .is_err() + { + task.abort(); + let _ = task.await; + peer_manager.clear_resources().await; + panic!("portal session did not stop when its outbound task ended"); + } + task.await.unwrap(); + + let labels = LabelSet::new() + .with_label_type(LabelType::NetworkName("portal-test".to_owned())) + .with_label_type(LabelType::VpnPortalClient("alice".to_owned())); + assert_eq!( + peer_manager + .stats_manager() + .get_metric(MetricName::VpnPortalClientBytesTx, &labels) + .unwrap() + .value, + client_packet.len() as u64 + ); + assert_eq!( + peer_manager + .stats_manager() + .get_metric(MetricName::VpnPortalClientPacketsTx, &labels) + .unwrap() + .value, + 1 + ); + + let status = statuses.read().await.get("alice").cloned().unwrap(); + assert_eq!(status.state, PortalClientState::Offline); + assert!(status.peer_id.is_none()); + assert!( + !peer_manager + .get_peer_map() + .has_direct_attached_peer(attached_peer_id) + ); + assert_eq!( + events + .0 + .lock() + .unwrap() + .iter() + .filter(|event| matches!(event, CoreEvent::VpnPortalClientDisconnected { .. })) + .count(), + 1 + ); + peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn portal_start_does_not_accept_before_all_listeners_are_ready() { + let (peer_manager, runtime_config) = network_runtime(); + let first_accept_calls = Arc::new(AtomicUsize::new(0)); + let second_listening = Arc::new(Notify::new()); + let fail_second = Arc::new(Notify::new()); + let host = StaticPortalHost::new(vec![ + Box::new(PendingPortalListener { + url: "test://127.0.0.1:10001".parse().unwrap(), + accept_calls: first_accept_calls.clone(), + }), + Box::new(FailingListenPortalListener { + url: "test://127.0.0.1:10002".parse().unwrap(), + listening: second_listening.clone(), + fail: fail_second.clone(), + }), + ]); + let events = Arc::new(RecordingEvents::default()); + let module = PortalModule::new( + peer_manager.clone(), + runtime_config, + Some(PortalRuntimeConfig { + clients: vec![client("alice", Ipv4Addr::new(10, 82, 0, 2), &["ops"])], + }), + Some(host), + events.clone(), + ) + .unwrap(); + let start = tokio::spawn({ + let module = module.clone(); + async move { module.start().await } + }); + second_listening.notified().await; + + let accepted_before_failure = + tokio::time::timeout(std::time::Duration::from_millis(50), async { + while first_accept_calls.load(Ordering::SeqCst) == 0 { + tokio::task::yield_now().await; + } + }) + .await + .is_ok(); + fail_second.notify_one(); + + let error = start.await.unwrap().unwrap_err(); + assert!(error.to_string().contains("listener setup failed")); + assert!( + !accepted_before_failure, + "an earlier listener accepted before startup completed" + ); + assert!(module.runtime.lock().await.is_none()); + assert!( + events + .0 + .lock() + .unwrap() + .iter() + .all(|event| !matches!(event, CoreEvent::VpnPortalStarted(_))) + ); + peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn portal_started_event_observes_installed_runtime() { + let (peer_manager, runtime_config) = network_runtime(); + let events = Arc::new(RuntimeObservingEvents::default()); + let module = PortalModule::new( + peer_manager.clone(), + runtime_config, + Some(PortalRuntimeConfig { + clients: vec![client("alice", Ipv4Addr::new(10, 82, 0, 2), &["ops"])], + }), + Some(StaticPortalHost::new(vec![Box::new( + PendingPortalListener { + url: "test://127.0.0.1:10003".parse().unwrap(), + accept_calls: Arc::new(AtomicUsize::new(0)), + }, + )])), + events.clone(), + ) + .unwrap(); + *events.module.lock().unwrap() = Arc::downgrade(&module); + + module.start().await.unwrap(); + + assert!( + events.runtime_visible_on_start.load(Ordering::SeqCst), + "VpnPortalStarted was emitted before runtime installation" + ); + module.stop().await; + peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn portal_client_config_routes_its_own_network_not_the_host_network() { + let (peer_manager, runtime_config) = network_runtime(); + let module = PortalModule::new( + peer_manager.clone(), + runtime_config, + Some(PortalRuntimeConfig { + clients: vec![PortalClientConfig { + name: "alice".to_owned(), + virtual_ip: "10.90.0.2/16".parse().unwrap(), + groups: vec!["ops".to_owned()], + }], + }), + Some(StaticPortalHost::new(vec![Box::new( + PendingPortalListener { + url: "test://127.0.0.1:10004".parse().unwrap(), + accept_calls: Arc::new(AtomicUsize::new(0)), + }, + )])), + Arc::new(()), + ) + .unwrap(); + + module.start().await.unwrap(); + let snapshot = module.info_snapshot().await; + + assert!(snapshot.clients[0].client_config.contains("10.90.0.2")); + assert!(snapshot.clients[0].client_config.contains("10.90.0.0/16")); + assert!(!snapshot.clients[0].client_config.contains("10.82.0.0/24")); + module.stop().await; + peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn portal_restarts_after_listener_accept_failure() { + let (peer_manager, runtime_config) = network_runtime(); + let host = Arc::new(RestartingPortalHost { + starts: AtomicUsize::new(0), + accept_calls: Arc::new(AtomicUsize::new(0)), + }); + let module = PortalModule::new( + peer_manager.clone(), + runtime_config, + Some(PortalRuntimeConfig { + clients: vec![client("alice", Ipv4Addr::new(10, 82, 0, 2), &["ops"])], + }), + Some(host.clone()), + Arc::new(()), + ) + .unwrap(); + module.start().await.unwrap(); + + tokio::time::timeout(std::time::Duration::from_secs(1), async { + loop { + if module.info_snapshot().await.listener.is_none() { + break; + } + tokio::task::yield_now().await; + } + }) + .await + .expect("failed listener remained reported as active"); + + module.start().await.unwrap(); + + assert_eq!(host.starts.load(Ordering::SeqCst), 2); + assert_eq!( + module.info_snapshot().await.listener.as_deref(), + Some("test://127.0.0.1:10001") + ); + module.stop().await; + peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn session_io_cancellation_aborts_blocked_packet_directions() { + let drops = Arc::new(AtomicUsize::new(0)); + let blocked_task = |drops: Arc| { + tokio::spawn(async move { + let _drop_counter = TaskDropCounter(drops); + pending::<()>().await; + }) + }; + let client_to_mesh = blocked_task(drops.clone()); + let mesh_to_client = blocked_task(drops.clone()); + let (_endpoint_sender, endpoint) = watch::channel("test://127.0.0.1:10004".to_owned()); + let statuses = Arc::new(RwLock::new(BTreeMap::from([( + "alice".to_owned(), + ClientStatus { + generation: 1, + ..Default::default() + }, + )]))); + let cancel = CancellationToken::new(); + let supervisor = tokio::spawn(PortalModule::supervise_session_io( + endpoint, + statuses, + "alice".to_owned(), + 1, + cancel.clone(), + client_to_mesh, + mesh_to_client, + )); + tokio::task::yield_now().await; + + cancel.cancel(); + + tokio::time::timeout(std::time::Duration::from_secs(1), supervisor) + .await + .expect("session I/O supervisor ignored cancellation") + .unwrap(); + assert_eq!(drops.load(Ordering::SeqCst), 2); + } + + #[test] + fn client_names_are_dns_safe() { + assert!(validate_client_name("laptop-1").is_ok()); + assert!(validate_client_name("-laptop").is_err()); + assert!(validate_client_name("laptop_1").is_err()); + assert!(validate_client_name("").is_err()); + } + + #[derive(Default)] + struct RecordingPortalHost { + updates: StdMutex>>, + } + + impl RecordingPortalHost { + fn recorded(&self) -> Vec> { + self.updates.lock().unwrap().clone() + } + } + + #[async_trait] + impl PortalHost for RecordingPortalHost { + async fn start_listeners(&self) -> anyhow::Result> { + anyhow::bail!("recording host never starts listeners") + } + + fn name(&self) -> String { + "recording".to_owned() + } + + fn render_client_config(&self, plan: &PortalClientConfigPlan) -> String { + format!("config:{}", plan.name) + } + + async fn update_clients(&self, clients: &[PortalClientConfig]) -> anyhow::Result<()> { + self.updates.lock().unwrap().push(clients.to_vec()); + Ok(()) + } + } + + fn portal_module_with_recording_host( + initial: PortalRuntimeConfig, + ) -> ( + Arc, + Arc, + CoreRuntimeConfigStore, + ) { + let (peer_manager, runtime_config) = network_runtime(); + let host = Arc::new(RecordingPortalHost::default()); + let module = PortalModule::new( + peer_manager, + runtime_config.clone(), + Some(initial), + Some(host.clone()), + Arc::new(()), + ) + .unwrap(); + (module, host, runtime_config) + } + + #[tokio::test] + async fn portal_module_update_clients_rejects_invalid_sets() { + let (module, _host, runtime_config) = + portal_module_with_recording_host(PortalRuntimeConfig { + clients: vec![client("alice", Ipv4Addr::new(10, 82, 0, 2), &["ops"])], + }); + let runtime = runtime_config.snapshot(); + + let duplicate = module + .update_clients( + vec![ + client("bob", Ipv4Addr::new(10, 82, 0, 3), &["ops"]), + client("bob", Ipv4Addr::new(10, 82, 0, 4), &["ops"]), + ], + runtime.as_ref(), + ) + .await + .unwrap_err(); + assert!( + duplicate + .to_string() + .contains("duplicate VPN portal client name") + ); + + let unknown_group = module + .update_clients( + vec![client("bob", Ipv4Addr::new(10, 82, 0, 3), &["missing"])], + runtime.as_ref(), + ) + .await + .unwrap_err(); + assert!(unknown_group.to_string().contains("unknown ACL group")); + + // Runtime updates may drain the portal to zero clients. + let applied = module + .update_clients(Vec::new(), runtime.as_ref()) + .await + .unwrap(); + assert!(applied.is_empty()); + } + + #[tokio::test] + async fn portal_module_update_clients_replaces_shared_state_and_notifies_host() { + let (module, host, runtime_config) = + portal_module_with_recording_host(PortalRuntimeConfig { + clients: vec![client("alice", Ipv4Addr::new(10, 82, 0, 2), &["ops"])], + }); + + let applied = module + .update_clients( + vec![client("bob", Ipv4Addr::new(10, 82, 0, 3), &["ops"])], + runtime_config.snapshot().as_ref(), + ) + .await + .unwrap(); + assert_eq!(applied.len(), 1); + assert_eq!(applied[0].name, "bob"); + + let recorded = host.recorded(); + assert_eq!(recorded.len(), 1); + assert_eq!(recorded[0].len(), 1); + assert_eq!(recorded[0][0].name, "bob"); + + let snapshot = module.info_snapshot().await; + assert_eq!(snapshot.clients.len(), 1); + assert_eq!(snapshot.clients[0].name, "bob"); + } + + #[tokio::test] + async fn portal_module_update_clients_requires_configured_portal() { + let (peer_manager, runtime_config) = network_runtime(); + let module = PortalModule::new( + peer_manager, + runtime_config.clone(), + None, + None, + Arc::new(()), + ) + .unwrap(); + let error = module + .update_clients( + vec![client("alice", Ipv4Addr::new(10, 82, 0, 2), &["ops"])], + runtime_config.snapshot().as_ref(), + ) + .await + .unwrap_err(); + assert!(error.to_string().contains("not configured")); + } +} diff --git a/vendor/easytier/easytier-core/src/host/dns.rs b/vendor/easytier/easytier-core/src/host/dns.rs new file mode 100644 index 0000000..3f2f994 --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/dns.rs @@ -0,0 +1,429 @@ +use std::{io, net::IpAddr, sync::Arc, task::Poll}; + +use async_trait::async_trait; + +use crate::socket::SocketContext; + +use super::socket::{HostOperationId, HostSocketRuntime}; + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct DnsQuery { + pub host: String, + pub context: SocketContext, +} + +impl DnsQuery { + pub fn new(host: impl Into, context: SocketContext) -> Self { + Self { + host: host.into(), + context, + } + } +} + +#[async_trait] +pub trait DnsResolver: Send + Sync + 'static { + async fn resolve(&self, query: DnsQuery) -> anyhow::Result>; +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct DnsSrvRecord { + pub priority: u16, + pub weight: u16, + pub port: u16, + pub target: String, +} + +/// Resolves non-address DNS records used by EasyTier endpoint discovery. +#[async_trait] +pub trait DnsRecordResolver: Send + Sync + 'static { + async fn resolve_txt(&self, query: DnsQuery) -> anyhow::Result; + + async fn resolve_srv(&self, query: DnsQuery) -> anyhow::Result>; +} + +/// Mechanical asynchronous DNS below core's resolver seam. +/// +/// Submit methods must return without waiting for DNS. Completion methods own +/// their returned data and must not retain guest-memory borrows. Cancellation +/// removes pending or completed-but-unobserved operation state. +/// When the host uses VPN bypass, every underlying DNS socket (including TCP +/// fallback) must be protected before sending queries. A system resolver is only +/// suitable if the host can guarantee equivalent routing; errors must not fall +/// back to unprotected DNS traffic. +pub trait HostDnsIo: Send + Sync + 'static { + fn submit_resolve(&self, operation: HostOperationId, query: &DnsQuery) -> io::Result<()>; + + fn take_resolve(&self, operation: HostOperationId) -> Poll>>; + + fn submit_txt(&self, operation: HostOperationId, query: &DnsQuery) -> io::Result<()>; + + fn take_txt(&self, operation: HostOperationId) -> Poll>; + + fn submit_srv(&self, operation: HostOperationId, query: &DnsQuery) -> io::Result<()>; + + fn take_srv(&self, operation: HostOperationId) -> Poll>>; + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()>; +} + +pub struct HostDnsResolver +where + D: HostDnsIo, +{ + runtime: HostSocketRuntime, + io: Arc, +} + +impl Clone for HostDnsResolver +where + D: HostDnsIo, +{ + fn clone(&self) -> Self { + Self { + runtime: self.runtime.clone(), + io: self.io.clone(), + } + } +} + +impl HostDnsResolver +where + D: HostDnsIo, +{ + pub fn new(runtime: HostSocketRuntime, io: Arc) -> Self { + Self { runtime, io } + } + + async fn run_operation( + &self, + submit: impl FnOnce(&D, HostOperationId) -> io::Result<()>, + take: impl Fn(&D, HostOperationId) -> Poll>, + ) -> io::Result { + self.runtime + .run_operation(self.io.clone(), submit, take, |io, operation| { + io.cancel_operation(operation) + }) + .await + } +} + +#[async_trait] +impl DnsResolver for HostDnsResolver +where + D: HostDnsIo, +{ + async fn resolve(&self, query: DnsQuery) -> anyhow::Result> { + Ok(self + .run_operation( + |io, operation| io.submit_resolve(operation, &query), + HostDnsIo::take_resolve, + ) + .await?) + } +} + +#[async_trait] +impl DnsRecordResolver for HostDnsResolver +where + D: HostDnsIo, +{ + async fn resolve_txt(&self, query: DnsQuery) -> anyhow::Result { + Ok(self + .run_operation( + |io, operation| io.submit_txt(operation, &query), + HostDnsIo::take_txt, + ) + .await?) + } + + async fn resolve_srv(&self, query: DnsQuery) -> anyhow::Result> { + Ok(self + .run_operation( + |io, operation| io.submit_srv(operation, &query), + HostDnsIo::take_srv, + ) + .await?) + } +} + +#[cfg(test)] +mod tests { + use std::{collections::HashMap, sync::Mutex}; + + use crate::socket::{IpVersion, SocketContext}; + + use super::*; + + enum TestDnsOperation { + Resolve { + query: DnsQuery, + result: Option>>, + }, + Txt { + query: DnsQuery, + result: Option>, + }, + Srv { + query: DnsQuery, + result: Option>>, + }, + } + + #[derive(Default)] + struct TestDnsIo { + operations: Mutex>, + cancelled: Mutex>, + } + + impl TestDnsIo { + fn operation( + &self, + predicate: impl Fn(&TestDnsOperation) -> bool, + ) -> (HostOperationId, DnsQuery) { + self.operations + .lock() + .unwrap() + .iter() + .find_map(|(operation, value)| { + if !predicate(value) { + return None; + } + let query = match value { + TestDnsOperation::Resolve { query, .. } + | TestDnsOperation::Txt { query, .. } + | TestDnsOperation::Srv { query, .. } => query, + }; + Some((*operation, query.clone())) + }) + .unwrap() + } + + fn complete_resolve(&self, operation: HostOperationId, addresses: Vec) { + let mut operations = self.operations.lock().unwrap(); + let TestDnsOperation::Resolve { result, .. } = operations.get_mut(&operation).unwrap() + else { + panic!("operation is not an address query"); + }; + *result = Some(Ok(addresses)); + } + + fn complete_txt(&self, operation: HostOperationId, text: String) { + let mut operations = self.operations.lock().unwrap(); + let TestDnsOperation::Txt { result, .. } = operations.get_mut(&operation).unwrap() + else { + panic!("operation is not a TXT query"); + }; + *result = Some(Ok(text)); + } + + fn complete_srv(&self, operation: HostOperationId, records: Vec) { + let mut operations = self.operations.lock().unwrap(); + let TestDnsOperation::Srv { result, .. } = operations.get_mut(&operation).unwrap() + else { + panic!("operation is not an SRV query"); + }; + *result = Some(Ok(records)); + } + } + + impl HostDnsIo for TestDnsIo { + fn submit_resolve(&self, operation: HostOperationId, query: &DnsQuery) -> io::Result<()> { + self.operations.lock().unwrap().insert( + operation, + TestDnsOperation::Resolve { + query: query.clone(), + result: None, + }, + ); + Ok(()) + } + + fn take_resolve(&self, operation: HostOperationId) -> Poll>> { + let mut operations = self.operations.lock().unwrap(); + let Some(TestDnsOperation::Resolve { result, .. }) = operations.get_mut(&operation) + else { + return Poll::Ready(Err(io::ErrorKind::NotFound.into())); + }; + let Some(result) = result.take() else { + return Poll::Pending; + }; + operations.remove(&operation); + Poll::Ready(result) + } + + fn submit_txt(&self, operation: HostOperationId, query: &DnsQuery) -> io::Result<()> { + self.operations.lock().unwrap().insert( + operation, + TestDnsOperation::Txt { + query: query.clone(), + result: None, + }, + ); + Ok(()) + } + + fn take_txt(&self, operation: HostOperationId) -> Poll> { + let mut operations = self.operations.lock().unwrap(); + let Some(TestDnsOperation::Txt { result, .. }) = operations.get_mut(&operation) else { + return Poll::Ready(Err(io::ErrorKind::NotFound.into())); + }; + let Some(result) = result.take() else { + return Poll::Pending; + }; + operations.remove(&operation); + Poll::Ready(result) + } + + fn submit_srv(&self, operation: HostOperationId, query: &DnsQuery) -> io::Result<()> { + self.operations.lock().unwrap().insert( + operation, + TestDnsOperation::Srv { + query: query.clone(), + result: None, + }, + ); + Ok(()) + } + + fn take_srv(&self, operation: HostOperationId) -> Poll>> { + let mut operations = self.operations.lock().unwrap(); + let Some(TestDnsOperation::Srv { result, .. }) = operations.get_mut(&operation) else { + return Poll::Ready(Err(io::ErrorKind::NotFound.into())); + }; + let Some(result) = result.take() else { + return Poll::Pending; + }; + operations.remove(&operation); + Poll::Ready(result) + } + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.operations.lock().unwrap().remove(&operation); + self.cancelled.lock().unwrap().push(operation); + Ok(()) + } + } + + fn query(host: &str, ip_version: IpVersion) -> DnsQuery { + DnsQuery::new( + host, + SocketContext { + ip_version, + socket_mark: Some(7), + netns: None, + }, + ) + } + + #[test] + fn query_keeps_host_and_socket_context() { + let context = SocketContext::default(); + assert_eq!( + DnsQuery::new("example.com", context.clone()), + DnsQuery { + host: "example.com".to_owned(), + context, + } + ); + } + + #[test] + fn srv_record_keeps_dns_selection_fields() { + let record = DnsSrvRecord { + priority: 10, + weight: 20, + port: 11010, + target: "peer.example.com.".to_owned(), + }; + + assert_eq!(record.priority, 10); + assert_eq!(record.weight, 20); + assert_eq!(record.port, 11010); + assert_eq!(record.target, "peer.example.com."); + } + + #[tokio::test] + async fn forwards_all_query_types_and_wakes_completed_futures() { + let io = Arc::new(TestDnsIo::default()); + let runtime = HostSocketRuntime::new(); + let resolver = HostDnsResolver::new(runtime.clone(), io.clone()); + + let address_query = query("peer.example", IpVersion::V4); + let address_task = tokio::spawn({ + let resolver = resolver.clone(); + let query = address_query.clone(); + async move { resolver.resolve(query).await } + }); + tokio::task::yield_now().await; + let (address_operation, submitted) = + io.operation(|value| matches!(value, TestDnsOperation::Resolve { .. })); + assert_eq!(submitted, address_query); + let addresses = vec!["192.0.2.1".parse().unwrap()]; + io.complete_resolve(address_operation, addresses.clone()); + runtime.notify_completions(); + assert_eq!(address_task.await.unwrap().unwrap(), addresses); + + let txt_query = query("_easytier.example", IpVersion::Both); + let mut txt = Box::pin(resolver.resolve_txt(txt_query.clone())); + assert!(futures::poll!(&mut txt).is_pending()); + let (txt_operation, submitted) = + io.operation(|value| matches!(value, TestDnsOperation::Txt { .. })); + assert_eq!(submitted, txt_query); + io.complete_txt(txt_operation, "tcp://peer.example:11010".to_owned()); + runtime.notify_completions(); + assert_eq!(txt.await.unwrap(), "tcp://peer.example:11010"); + + let srv_query = query("_easytier._udp.example", IpVersion::V6); + let mut srv = Box::pin(resolver.resolve_srv(srv_query.clone())); + assert!(futures::poll!(&mut srv).is_pending()); + let (srv_operation, submitted) = + io.operation(|value| matches!(value, TestDnsOperation::Srv { .. })); + assert_eq!(submitted, srv_query); + let records = vec![DnsSrvRecord { + priority: 10, + weight: 20, + port: 11010, + target: "peer.example.".to_owned(), + }]; + io.complete_srv(srv_operation, records.clone()); + runtime.notify_completions(); + assert_eq!(srv.await.unwrap(), records); + } + + #[tokio::test] + async fn dropping_pending_or_unobserved_completion_cancels_host_state() { + let io = Arc::new(TestDnsIo::default()); + let runtime = HostSocketRuntime::new(); + let resolver = HostDnsResolver::new(runtime.clone(), io.clone()); + + let pending_operation = { + let mut resolve = + Box::pin(resolver.resolve_txt(query("pending.example", IpVersion::Both))); + assert!(futures::poll!(&mut resolve).is_pending()); + assert_eq!(runtime.inner.wakers.len(), 1); + let (operation, _) = + io.operation(|value| matches!(value, TestDnsOperation::Txt { .. })); + drop(resolve); + assert_eq!(runtime.inner.wakers.len(), 0); + operation + }; + let completed_operation = { + let mut resolve = Box::pin(resolver.resolve(query("cancel.example", IpVersion::Both))); + assert!(futures::poll!(&mut resolve).is_pending()); + assert_eq!(runtime.inner.wakers.len(), 1); + let (operation, _) = + io.operation(|value| matches!(value, TestDnsOperation::Resolve { .. })); + io.complete_resolve(operation, vec!["192.0.2.2".parse().unwrap()]); + drop(resolve); + assert_eq!(runtime.inner.wakers.len(), 0); + operation + }; + + assert_eq!( + *io.cancelled.lock().unwrap(), + vec![pending_operation, completed_operation] + ); + assert!(io.operations.lock().unwrap().is_empty()); + } +} diff --git a/vendor/easytier/easytier-core/src/host/environment.rs b/vendor/easytier/easytier-core/src/host/environment.rs new file mode 100644 index 0000000..b8e5a06 --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/environment.rs @@ -0,0 +1,234 @@ +//! Host-operation bridge for connector environment queries. + +use std::{io, net::SocketAddr, sync::Arc, task::Poll}; + +use crate::socket::SocketContext; + +use super::socket::{HostOperationId, HostSocketRuntime}; + +/// Mechanical asynchronous environment operations below connector policy. +/// +/// Submit calls must take ownership of their complete input before returning +/// and must leave no operation state when they return an error. A `Pending` +/// take retains the operation; a `Ready` take consumes both successful and +/// failed results. Cancellation must remove pending and completed-but-unread +/// state and is idempotent for an already-absent operation. +/// Source-address probes describe the underlay route: if VPN bypass is active, +/// protect the probe socket before connect/source-address selection. Protection +/// acknowledgement belongs inside this host operation, not a later guest call. +pub trait HostConnectorEnvironmentIo: Send + Sync + 'static { + fn submit_local_addr_for_remote( + &self, + operation: HostOperationId, + remote_addr: SocketAddr, + context: &SocketContext, + ) -> io::Result<()>; + + fn take_local_addr_for_remote( + &self, + operation: HostOperationId, + ) -> Poll>; + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()>; +} + +pub(crate) async fn local_addr_for_remote( + runtime: &HostSocketRuntime, + io: Arc, + remote_addr: SocketAddr, + context: SocketContext, +) -> anyhow::Result +where + I: HostConnectorEnvironmentIo, +{ + Ok(runtime + .run_operation( + io, + |io, operation| io.submit_local_addr_for_remote(operation, remote_addr, &context), + HostConnectorEnvironmentIo::take_local_addr_for_remote, + |io, operation| io.cancel_operation(operation), + ) + .await?) +} + +#[cfg(test)] +mod tests { + use std::{collections::HashMap, sync::Mutex}; + + use super::*; + + #[derive(Debug, Clone, PartialEq, Eq)] + enum Request { + Local(SocketAddr, SocketContext), + } + + #[derive(Debug, Clone, Copy)] + enum Completion { + Ok(SocketAddr), + Err(io::ErrorKind), + } + + #[derive(Default)] + struct TestIo { + requests: Mutex)>>, + cancelled: Mutex>, + } + + impl TestIo { + fn submit(&self, operation: HostOperationId, request: Request) -> io::Result<()> { + let replaced = self + .requests + .lock() + .unwrap() + .insert(operation, (request, None)); + if replaced.is_some() { + return Err(io::ErrorKind::AlreadyExists.into()); + } + Ok(()) + } + + fn take(&self, operation: HostOperationId) -> Poll> { + let mut requests = self.requests.lock().unwrap(); + let Some((_, result)) = requests.get(&operation) else { + return Poll::Ready(Err(io::ErrorKind::NotFound.into())); + }; + let Some(result) = *result else { + return Poll::Pending; + }; + requests.remove(&operation); + Poll::Ready(match result { + Completion::Ok(address) => Ok(address), + Completion::Err(kind) => Err(kind.into()), + }) + } + + fn operation_for(&self, request: Request) -> HostOperationId { + self.requests + .lock() + .unwrap() + .iter() + .find_map(|(operation, (candidate, _))| { + (*candidate == request).then_some(*operation) + }) + .expect("submitted host environment operation") + } + + fn complete(&self, operation: HostOperationId, result: Completion) { + self.requests.lock().unwrap().get_mut(&operation).unwrap().1 = Some(result); + } + } + + impl HostConnectorEnvironmentIo for TestIo { + fn submit_local_addr_for_remote( + &self, + operation: HostOperationId, + remote_addr: SocketAddr, + context: &SocketContext, + ) -> io::Result<()> { + self.submit(operation, Request::Local(remote_addr, context.clone())) + } + + fn take_local_addr_for_remote( + &self, + operation: HostOperationId, + ) -> Poll> { + self.take(operation) + } + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.requests.lock().unwrap().remove(&operation); + self.cancelled.lock().unwrap().push(operation); + Ok(()) + } + } + + #[tokio::test] + async fn wakes_completed_operations_and_cancels_dropped_futures() { + let runtime = HostSocketRuntime::new(); + let io = Arc::new(TestIo::default()); + let remote = "203.0.113.1:11010".parse().unwrap(); + let context = SocketContext::default().with_socket_mark(Some(7)); + let task = tokio::spawn({ + let runtime = runtime.clone(); + let io = io.clone(); + let context = context.clone(); + async move { local_addr_for_remote(&runtime, io, remote, context).await } + }); + tokio::task::yield_now().await; + + let operation = io.operation_for(Request::Local(remote, context)); + io.complete( + operation, + Completion::Ok("192.0.2.1:40100".parse().unwrap()), + ); + runtime.notify_completions(); + assert_eq!( + task.await.unwrap().unwrap(), + "192.0.2.1:40100".parse().unwrap() + ); + + let pending_remote = "203.0.113.2:11010".parse().unwrap(); + let pending = tokio::spawn({ + let runtime = runtime.clone(); + let io = io.clone(); + async move { + local_addr_for_remote(&runtime, io, pending_remote, SocketContext::default()).await + } + }); + tokio::task::yield_now().await; + let cancelled = io.operation_for(Request::Local(pending_remote, SocketContext::default())); + pending.abort(); + let _ = pending.await; + assert_eq!(*io.cancelled.lock().unwrap(), vec![cancelled]); + assert!(!io.requests.lock().unwrap().contains_key(&cancelled)); + + let failed_remote = "203.0.113.3:11010".parse().unwrap(); + let failed = tokio::spawn({ + let runtime = runtime.clone(); + let io = io.clone(); + async move { + local_addr_for_remote(&runtime, io, failed_remote, SocketContext::default()).await + } + }); + tokio::task::yield_now().await; + let failed_operation = + io.operation_for(Request::Local(failed_remote, SocketContext::default())); + io.complete( + failed_operation, + Completion::Err(io::ErrorKind::AddrNotAvailable), + ); + runtime.notify_completions(); + assert_eq!( + failed + .await + .unwrap() + .unwrap_err() + .downcast_ref::() + .unwrap() + .kind(), + io::ErrorKind::AddrNotAvailable + ); + assert!(!io.requests.lock().unwrap().contains_key(&failed_operation)); + + let unread_remote = "203.0.113.4:11010".parse().unwrap(); + let unread = tokio::spawn({ + let runtime = runtime.clone(); + let io = io.clone(); + async move { + local_addr_for_remote(&runtime, io, unread_remote, SocketContext::default()).await + } + }); + tokio::task::yield_now().await; + let unread_operation = + io.operation_for(Request::Local(unread_remote, SocketContext::default())); + io.complete( + unread_operation, + Completion::Ok("198.51.100.1:44000".parse().unwrap()), + ); + runtime.notify_completions(); + unread.abort(); + let _ = unread.await; + assert!(io.cancelled.lock().unwrap().contains(&unread_operation)); + assert!(!io.requests.lock().unwrap().contains_key(&unread_operation)); + } +} diff --git a/vendor/easytier/easytier-core/src/host/management.rs b/vendor/easytier/easytier-core/src/host/management.rs new file mode 100644 index 0000000..dac2949 --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/management.rs @@ -0,0 +1,41 @@ +use std::{io, sync::Arc, task::Poll}; + +use super::socket::{HostOperationId, HostSocketRuntime}; + +/// Mechanical process-management I/O delegated to the embedding host. +pub trait HostManagementIo: Send + Sync + 'static { + fn submit_call(&self, operation: HostOperationId, request: &[u8]) -> io::Result<()>; + + fn take_call(&self, operation: HostOperationId) -> Poll>>; + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()>; +} + +#[derive(Clone)] +pub struct HostManagementClient +where + I: HostManagementIo, +{ + runtime: HostSocketRuntime, + io: Arc, +} + +impl HostManagementClient +where + I: HostManagementIo, +{ + pub fn new(runtime: HostSocketRuntime, io: Arc) -> Self { + Self { runtime, io } + } + + pub async fn call(&self, request: &[u8]) -> io::Result> { + self.runtime + .run_operation( + self.io.clone(), + |io, operation| io.submit_call(operation, request), + HostManagementIo::take_call, + |io, operation| io.cancel_operation(operation), + ) + .await + } +} diff --git a/vendor/easytier/easytier-core/src/host/mod.rs b/vendor/easytier/easytier-core/src/host/mod.rs new file mode 100644 index 0000000..3925f10 --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/mod.rs @@ -0,0 +1,18 @@ +//! Host capability seams. +//! +//! This module is the single home of every Host capability seam (see +//! CONTEXT.md, "Host capability"): DNS resolution, connector environment +//! facts, packet egress, and host-backed sockets. The socket-flavoured seams +//! — the host operation runtime and identifiers, the TCP stream and UDP +//! socket bridges, socket factories, and TCP listeners — live in [`socket`]. +//! Concrete WASI adapters for these seams live in [`crate::wasi`]. + +pub mod dns; +pub mod environment; +#[cfg(feature = "management")] +pub mod management; +pub mod packet; +pub mod socket; +#[cfg(test)] +pub(crate) mod testkit; +pub mod tunnel; diff --git a/vendor/easytier/easytier-core/src/host/packet.rs b/vendor/easytier/easytier-core/src/host/packet.rs new file mode 100644 index 0000000..6b7888e --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/packet.rs @@ -0,0 +1,441 @@ +use std::{fmt, io, sync::Arc, task::Poll}; + +use async_trait::async_trait; +use tokio::sync::mpsc; + +use crate::packet::{ZCPacket, ZCPacketType}; + +use super::socket::{HostOperationId, HostSocketRuntime}; + +/// An owned raw IP packet crossing the Host packet seam. +/// +/// The backing allocation and any core-private headroom stay opaque. Native +/// adapters can move the packet without copying its payload, while ABI adapters +/// can borrow [`Self::payload`] at the point where a copy is unavoidable. +pub struct HostPacket { + inner: ZCPacket, +} + +pub(crate) type HostPacketSender = mpsc::Sender; + +/// The single bounded receive side for packets leaving a core instance. +/// +/// Hosts own this receiver for the instance lifetime. Keeping the channel +/// opaque prevents platform adapters from depending on core packet headers or +/// replacing the bounded backpressure contract. +pub struct HostPacketReceiver { + receiver: mpsc::Receiver, +} + +impl HostPacketReceiver { + /// Wraps a Host-owned bounded packet channel. + /// + /// This is intended for native adapters that already receive owned + /// [`HostPacket`] values from an in-process packet sink. + pub fn new(receiver: mpsc::Receiver) -> Self { + Self { receiver } + } + + pub async fn recv(&mut self) -> Option { + self.receiver.recv().await + } +} + +pub(crate) fn host_packet_channel() -> (HostPacketSender, HostPacketReceiver) { + let (sender, receiver) = mpsc::channel(128); + (sender, HostPacketReceiver::new(receiver)) +} + +impl HostPacket { + /// Copies raw IP bytes into core-owned packet storage. + /// + /// Native packet devices should use [`Self::from_tun_packet`] instead. + pub fn copy_from_payload(payload: &[u8]) -> Self { + Self { + inner: ZCPacket::new_with_payload(payload), + } + } + + /// Moves a packet read from a native TUN adapter into the Host seam. + pub fn from_tun_packet(packet: ZCPacket) -> Self { + debug_assert_eq!(packet.packet_type(), ZCPacketType::NIC); + Self { inner: packet } + } + + pub fn payload(&self) -> &[u8] { + self.inner.payload() + } + + pub fn len(&self) -> usize { + self.inner.payload_len() + } + + pub fn is_empty(&self) -> bool { + self.inner.payload().is_empty() + } + + /// Moves a packet into a native TUN adapter without copying its payload. + /// + /// Core-private headers are cleared before the backing allocation crosses + /// the seam. The returned packet retains its original payload offset so the + /// native writer can reuse the existing headroom for packet-info framing. + pub fn into_tun_packet(mut self) -> ZCPacket { + let payload_offset = self.inner.payload_offset(); + self.inner.mut_inner()[..payload_offset].fill(0); + self.inner + } + + pub(crate) fn from_core_packet(packet: ZCPacket) -> Self { + Self { inner: packet } + } + + pub(crate) fn into_core_packet(self) -> ZCPacket { + self.inner + } +} + +impl fmt::Debug for HostPacket { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("HostPacket") + .field("len", &self.len()) + .finish() + } +} + +/// Receives owned IP packets leaving the EasyTier peer graph. +/// +/// The host decides whether packets go to a TUN device, a Go callback, or a +/// different packet backend. Core's internal packet headers remain hidden, and +/// core never performs platform I/O directly. +#[async_trait] +pub trait PacketSink: Send + Sync + 'static { + async fn write_packet(&self, packet: HostPacket) -> anyhow::Result<()>; +} + +#[async_trait] +impl PacketSink for mpsc::Sender> { + async fn write_packet(&self, packet: HostPacket) -> anyhow::Result<()> { + self.send(packet.payload().to_vec()) + .await + .map_err(|_| anyhow::anyhow!("packet sink channel is closed")) + } +} + +/// Ownership-preserving in-process adapter for native packet runtimes. +pub struct HostPacketChannelSink { + sender: mpsc::Sender, +} + +impl HostPacketChannelSink { + pub fn new(sender: mpsc::Sender) -> Self { + Self { sender } + } +} + +#[async_trait] +impl PacketSink for HostPacketChannelSink { + async fn write_packet(&self, packet: HostPacket) -> anyhow::Result<()> { + self.sender + .send(packet) + .await + .map_err(|_| anyhow::anyhow!("packet sink channel is closed")) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct HostPacketSinkHandle(pub u64); + +/// Mechanical packet egress below core's packet scheduling seam. +/// +/// A successful `try_write_packet` owns a complete packet copy before it +/// returns. `WouldBlock` has no side effects. Readiness operations only report +/// that another admission attempt may succeed; they never accept a packet. +pub trait HostPacketIo: Send + Sync + 'static { + fn try_write_packet(&self, handle: HostPacketSinkHandle, packet: &[u8]) -> io::Result<()>; + + fn submit_write_ready( + &self, + handle: HostPacketSinkHandle, + operation: HostOperationId, + ) -> io::Result<()>; + + fn take_write_ready(&self, operation: HostOperationId) -> Poll>; + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()>; +} + +pub struct HostPacketSink +where + I: HostPacketIo, +{ + runtime: HostSocketRuntime, + io: Arc, + handle: HostPacketSinkHandle, +} + +impl Clone for HostPacketSink +where + I: HostPacketIo, +{ + fn clone(&self) -> Self { + Self { + runtime: self.runtime.clone(), + io: self.io.clone(), + handle: self.handle, + } + } +} + +impl HostPacketSink +where + I: HostPacketIo, +{ + pub fn new(runtime: HostSocketRuntime, io: Arc, handle: HostPacketSinkHandle) -> Self { + Self { + runtime, + io, + handle, + } + } + + async fn wait_writable(&self) -> io::Result<()> { + self.runtime + .run_operation( + self.io.clone(), + |io, operation| io.submit_write_ready(self.handle, operation), + |io, operation| io.take_write_ready(operation), + |io, operation| io.cancel_operation(operation), + ) + .await + } +} + +#[async_trait] +impl PacketSink for HostPacketSink +where + I: HostPacketIo, +{ + async fn write_packet(&self, packet: HostPacket) -> anyhow::Result<()> { + loop { + match self.io.try_write_packet(self.handle, packet.payload()) { + Ok(()) => return Ok(()), + Err(error) if error.kind() == io::ErrorKind::WouldBlock => { + self.wait_writable().await?; + } + Err(error) => return Err(error.into()), + } + } + } +} + +#[cfg(test)] +mod tests { + use std::{collections::HashMap, sync::Mutex}; + + use super::*; + + #[derive(Default)] + struct TestPacketState { + writable: bool, + packets: Vec<(HostPacketSinkHandle, Vec)>, + waiters: HashMap, + cancelled: Vec, + } + + #[derive(Default)] + struct TestPacketIo { + state: Mutex, + } + + impl TestPacketIo { + fn set_writable(&self) { + let mut state = self.state.lock().unwrap(); + state.writable = true; + for ready in state.waiters.values_mut() { + *ready = true; + } + } + + fn waiter(&self) -> HostOperationId { + *self.state.lock().unwrap().waiters.keys().next().unwrap() + } + } + + impl HostPacketIo for TestPacketIo { + fn try_write_packet(&self, handle: HostPacketSinkHandle, packet: &[u8]) -> io::Result<()> { + let mut state = self.state.lock().unwrap(); + if !state.writable { + return Err(io::ErrorKind::WouldBlock.into()); + } + state.writable = false; + state.packets.push((handle, packet.to_vec())); + Ok(()) + } + + fn submit_write_ready( + &self, + _handle: HostPacketSinkHandle, + operation: HostOperationId, + ) -> io::Result<()> { + let mut state = self.state.lock().unwrap(); + let ready = state.writable; + state.waiters.insert(operation, ready); + Ok(()) + } + + fn take_write_ready(&self, operation: HostOperationId) -> Poll> { + let mut state = self.state.lock().unwrap(); + match state.waiters.get(&operation) { + Some(true) => { + state.waiters.remove(&operation); + Poll::Ready(Ok(())) + } + Some(false) => Poll::Pending, + None => Poll::Ready(Err(io::ErrorKind::NotFound.into())), + } + } + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + let mut state = self.state.lock().unwrap(); + state.waiters.remove(&operation); + state.cancelled.push(operation); + Ok(()) + } + } + + fn test_sink( + writable: bool, + ) -> ( + HostSocketRuntime, + Arc, + HostPacketSink, + ) { + let runtime = HostSocketRuntime::new(); + let io = Arc::new(TestPacketIo::default()); + io.state.lock().unwrap().writable = writable; + let sink = HostPacketSink::new(runtime.clone(), io.clone(), HostPacketSinkHandle(41)); + (runtime, io, sink) + } + + #[tokio::test] + async fn admits_complete_packet_without_readiness_wait() { + let (_runtime, io, sink) = test_sink(true); + sink.write_packet(HostPacket::copy_from_payload(&[1, 2, 3, 4])) + .await + .unwrap(); + + let state = io.state.lock().unwrap(); + assert_eq!( + state.packets, + vec![(HostPacketSinkHandle(41), vec![1, 2, 3, 4])] + ); + assert!(state.waiters.is_empty()); + } + + #[tokio::test] + async fn waits_for_capacity_then_admits_packet_once() { + let (runtime, io, sink) = test_sink(false); + let task = tokio::spawn(async move { + sink.write_packet(HostPacket::copy_from_payload(&[5, 6, 7])) + .await + }); + tokio::task::yield_now().await; + assert!(io.state.lock().unwrap().packets.is_empty()); + assert_eq!(runtime.inner.wakers.len(), 1); + + io.set_writable(); + runtime.notify_completions(); + task.await.unwrap().unwrap(); + + let state = io.state.lock().unwrap(); + assert_eq!( + state.packets, + vec![(HostPacketSinkHandle(41), vec![5, 6, 7])] + ); + assert!(state.waiters.is_empty()); + assert!(state.cancelled.is_empty()); + assert_eq!(runtime.inner.wakers.len(), 0); + } + + #[tokio::test] + async fn dropping_pending_waiter_removes_waker_and_host_state() { + let (runtime, io, sink) = test_sink(false); + let operation = { + let mut write = Box::pin(sink.write_packet(HostPacket::copy_from_payload(&[7, 8]))); + assert!(futures::poll!(&mut write).is_pending()); + assert_eq!(runtime.inner.wakers.len(), 1); + let operation = io.waiter(); + drop(write); + operation + }; + + let state = io.state.lock().unwrap(); + assert!(state.packets.is_empty()); + assert!(state.waiters.is_empty()); + assert_eq!(state.cancelled, vec![operation]); + assert_eq!(runtime.inner.wakers.len(), 0); + } + + #[tokio::test] + async fn dropping_ready_waiter_does_not_admit_packet() { + let (runtime, io, sink) = test_sink(false); + let operation = { + let mut write = Box::pin(sink.write_packet(HostPacket::copy_from_payload(&[8, 9]))); + assert!(futures::poll!(&mut write).is_pending()); + let operation = io.waiter(); + io.set_writable(); + runtime.notify_completions(); + drop(write); + operation + }; + + { + let state = io.state.lock().unwrap(); + assert!(state.packets.is_empty()); + assert!(state.waiters.is_empty()); + assert_eq!(state.cancelled, vec![operation]); + } + sink.write_packet(HostPacket::copy_from_payload(&[8, 9])) + .await + .unwrap(); + assert_eq!( + io.state.lock().unwrap().packets, + vec![(HostPacketSinkHandle(41), vec![8, 9])] + ); + } + + #[test] + fn native_packet_round_trip_preserves_allocation_and_hides_headers() { + let mut core_packet = ZCPacket::new_with_payload(b"owned payload"); + let payload_offset = core_packet.payload_offset(); + core_packet.mut_inner()[..payload_offset].fill(0xa5); + let payload_pointer = core_packet.payload().as_ptr(); + + let host_packet = HostPacket::from_core_packet(core_packet); + assert_eq!(host_packet.payload().as_ptr(), payload_pointer); + assert_eq!(host_packet.payload(), b"owned payload"); + + let tun_packet = host_packet.into_tun_packet(); + assert_eq!(tun_packet.payload().as_ptr(), payload_pointer); + assert_eq!(tun_packet.payload(), b"owned payload"); + assert!( + tun_packet.inner()[..payload_offset] + .iter() + .all(|byte| *byte == 0) + ); + } + + #[test] + fn tun_packet_moves_into_core_without_copying_payload() { + let tun_packet = ZCPacket::new_with_payload(b"from tun"); + let payload_pointer = tun_packet.payload().as_ptr(); + + let host_packet = HostPacket::from_tun_packet(tun_packet); + assert_eq!(host_packet.payload().as_ptr(), payload_pointer); + let core_packet = host_packet.into_core_packet(); + + assert_eq!(core_packet.payload().as_ptr(), payload_pointer); + assert_eq!(core_packet.payload(), b"from tun"); + } +} diff --git a/vendor/easytier/easytier-core/src/host/socket/factory.rs b/vendor/easytier/easytier-core/src/host/socket/factory.rs new file mode 100644 index 0000000..e78ef8a --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/socket/factory.rs @@ -0,0 +1,510 @@ +use std::{io, net::SocketAddr, sync::Arc, task::Poll}; + +use crate::socket::{ + tcp::{TcpConnectOptions, VirtualTcpSocketFactory}, + udp::{UdpBindOptions, VirtualUdpSocketFactory}, +}; +use async_trait::async_trait; + +use super::{ + HostOperationId, HostSocketHandle, HostSocketIo, HostSocketRuntime, HostTcpIo, HostTcpStream, + udp::{HostUdpIo, HostUdpSocket}, +}; + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct HostTcpConnectResult { + pub handle: HostSocketHandle, + pub local_addr: SocketAddr, + pub peer_addr: SocketAddr, + pub transport_label: Option, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct HostUdpBindResult { + pub handle: HostSocketHandle, + pub local_addr: SocketAddr, +} + +/// Mechanical creation of host-owned socket resources. +/// +/// Submit methods start work without blocking the guest. Completion results own +/// their handles and address metadata. Canceling an operation must atomically +/// stop pending creation or close and discard a resource that completed before +/// core observed it, so dropping a factory future cannot leak a host socket. +/// When bind options request socket protection, the host must complete and +/// acknowledge protection before connect, datagram I/O, or successful creation +/// completion. A protection error fails the creation operation. +pub trait HostSocketFactoryIo: HostSocketIo { + fn submit_tcp_connect( + &self, + operation: HostOperationId, + options: &TcpConnectOptions, + ) -> io::Result<()>; + + fn take_tcp_connect( + &self, + operation: HostOperationId, + ) -> Poll>; + + fn submit_udp_bind( + &self, + operation: HostOperationId, + options: &UdpBindOptions, + ) -> io::Result<()>; + + fn take_udp_bind(&self, operation: HostOperationId) -> Poll>; +} + +pub trait HostSocketBackend: HostSocketFactoryIo + HostTcpIo + HostUdpIo {} + +impl HostSocketBackend for T where T: HostSocketFactoryIo + HostTcpIo + HostUdpIo {} + +pub struct HostSocketFactory +where + B: HostSocketBackend, +{ + runtime: HostSocketRuntime, + backend: Arc, +} + +impl Clone for HostSocketFactory +where + B: HostSocketBackend, +{ + fn clone(&self) -> Self { + Self { + runtime: self.runtime.clone(), + backend: self.backend.clone(), + } + } +} + +impl HostSocketFactory +where + B: HostSocketBackend, +{ + pub fn new(runtime: HostSocketRuntime, backend: Arc) -> Self { + Self { runtime, backend } + } + + async fn connect_tcp(&self, options: TcpConnectOptions) -> io::Result { + let result = self + .runtime + .run_operation( + self.backend.clone(), + |backend, operation| backend.submit_tcp_connect(operation, &options), + |backend, operation| backend.take_tcp_connect(operation), + |backend, operation| backend.cancel_operation(operation), + ) + .await?; + Ok(self.runtime.tcp_stream( + self.backend.clone(), + result.handle, + result.local_addr, + result.peer_addr, + result.transport_label, + )) + } + + async fn bind_udp(&self, options: UdpBindOptions) -> io::Result> { + let context = options.context.clone(); + let result = self + .runtime + .run_operation( + self.backend.clone(), + |backend, operation| backend.submit_udp_bind(operation, &options), + |backend, operation| backend.take_udp_bind(operation), + |backend, operation| backend.cancel_operation(operation), + ) + .await?; + Ok(Arc::new(self.runtime.udp_socket_with_context( + self.backend.clone(), + result.handle, + result.local_addr, + context, + ))) + } +} + +#[async_trait] +impl VirtualTcpSocketFactory for HostSocketFactory +where + B: HostSocketBackend, +{ + type Socket = HostTcpStream; + + async fn connect_tcp(&self, options: TcpConnectOptions) -> anyhow::Result { + Ok(self.connect_tcp(options).await?) + } +} + +#[async_trait] +impl VirtualUdpSocketFactory for HostSocketFactory +where + B: HostSocketBackend, +{ + type Socket = HostUdpSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + Ok(self.bind_udp(options).await?) + } +} + +#[cfg(test)] +mod tests { + use std::{ + collections::{HashMap, HashSet}, + sync::Mutex, + }; + + use crate::socket::{ + tcp::{TcpBindOptions, TcpSocketPurpose, VirtualTcpSocket}, + udp::{UdpSocketPurpose, UdpSocketSendMeta, VirtualUdpSocket}, + }; + + use super::*; + + enum TestCreate { + Tcp { + options: TcpConnectOptions, + result: Option>, + }, + Udp { + options: UdpBindOptions, + result: Option>, + }, + } + + #[derive(Default)] + struct TestHostIo { + creates: Mutex>, + cancelled: Mutex>, + closed: Mutex>, + } + + impl TestHostIo { + fn operation(&self, tcp: bool) -> HostOperationId { + self.creates + .lock() + .unwrap() + .iter() + .find_map(|(operation, create)| match (tcp, create) { + (true, TestCreate::Tcp { .. }) | (false, TestCreate::Udp { .. }) => { + Some(*operation) + } + _ => None, + }) + .unwrap() + } + + fn complete_tcp(&self, operation: HostOperationId, result: HostTcpConnectResult) { + let mut creates = self.creates.lock().unwrap(); + let TestCreate::Tcp { + result: completion, .. + } = creates.get_mut(&operation).unwrap() + else { + panic!("operation is not TCP connect"); + }; + *completion = Some(Ok(result)); + } + + fn complete_udp(&self, operation: HostOperationId, result: HostUdpBindResult) { + let mut creates = self.creates.lock().unwrap(); + let TestCreate::Udp { + result: completion, .. + } = creates.get_mut(&operation).unwrap() + else { + panic!("operation is not UDP bind"); + }; + *completion = Some(Ok(result)); + } + } + + impl HostSocketIo for TestHostIo { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + if let Some(create) = self.creates.lock().unwrap().remove(&operation) { + let handle = match create { + TestCreate::Tcp { + result: Some(Ok(result)), + .. + } => Some(result.handle), + TestCreate::Udp { + result: Some(Ok(result)), + .. + } => Some(result.handle), + _ => None, + }; + if let Some(handle) = handle { + self.closed.lock().unwrap().insert(handle); + } + } + self.cancelled.lock().unwrap().push(operation); + Ok(()) + } + + fn close(&self, handle: HostSocketHandle) -> io::Result<()> { + self.closed.lock().unwrap().insert(handle); + Ok(()) + } + } + + impl HostSocketFactoryIo for TestHostIo { + fn submit_tcp_connect( + &self, + operation: HostOperationId, + options: &TcpConnectOptions, + ) -> io::Result<()> { + self.creates.lock().unwrap().insert( + operation, + TestCreate::Tcp { + options: options.clone(), + result: None, + }, + ); + Ok(()) + } + + fn take_tcp_connect( + &self, + operation: HostOperationId, + ) -> Poll> { + let mut creates = self.creates.lock().unwrap(); + let Some(TestCreate::Tcp { result, .. }) = creates.get_mut(&operation) else { + return Poll::Ready(Err(io::ErrorKind::NotFound.into())); + }; + let Some(result) = result.take() else { + return Poll::Pending; + }; + creates.remove(&operation); + Poll::Ready(result) + } + + fn submit_udp_bind( + &self, + operation: HostOperationId, + options: &UdpBindOptions, + ) -> io::Result<()> { + self.creates.lock().unwrap().insert( + operation, + TestCreate::Udp { + options: options.clone(), + result: None, + }, + ); + Ok(()) + } + + fn take_udp_bind(&self, operation: HostOperationId) -> Poll> { + let mut creates = self.creates.lock().unwrap(); + let Some(TestCreate::Udp { result, .. }) = creates.get_mut(&operation) else { + return Poll::Ready(Err(io::ErrorKind::NotFound.into())); + }; + let Some(result) = result.take() else { + return Poll::Pending; + }; + creates.remove(&operation); + Poll::Ready(result) + } + } + + impl HostTcpIo for TestHostIo { + fn submit_read( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + _capacity: usize, + ) -> io::Result<()> { + Err(io::ErrorKind::Unsupported.into()) + } + + fn take_read(&self, _operation: HostOperationId) -> Poll>> { + Poll::Ready(Err(io::ErrorKind::Unsupported.into())) + } + + fn submit_write( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + _source: &[u8], + ) -> io::Result<()> { + Err(io::ErrorKind::Unsupported.into()) + } + + fn take_write(&self, _operation: HostOperationId) -> Poll> { + Poll::Ready(Err(io::ErrorKind::Unsupported.into())) + } + } + + impl HostUdpIo for TestHostIo { + fn submit_recv( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + _capacity: usize, + ) -> io::Result<()> { + Err(io::ErrorKind::Unsupported.into()) + } + + fn take_recv( + &self, + _operation: HostOperationId, + ) -> Poll> { + Poll::Ready(Err(io::ErrorKind::Unsupported.into())) + } + + fn try_send( + &self, + _handle: HostSocketHandle, + _source: &[u8], + _peer_addr: SocketAddr, + _meta: UdpSocketSendMeta, + ) -> io::Result<()> { + Err(io::ErrorKind::Unsupported.into()) + } + + fn submit_send_ready( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + ) -> io::Result<()> { + Err(io::ErrorKind::Unsupported.into()) + } + + fn take_send_ready(&self, _operation: HostOperationId) -> Poll> { + Poll::Ready(Err(io::ErrorKind::Unsupported.into())) + } + } + + fn test_factory(io: Arc) -> (HostSocketRuntime, HostSocketFactory) { + let runtime = HostSocketRuntime::new(); + let factory = HostSocketFactory::new(runtime.clone(), io); + (runtime, factory) + } + + #[tokio::test] + async fn forwards_tcp_connect_options_and_wraps_completed_handle() { + let io = Arc::new(TestHostIo::default()); + let (runtime, factory) = test_factory(io.clone()); + let options = TcpConnectOptions { + remote_addr: "192.0.2.2:11013".parse().unwrap(), + bind: TcpBindOptions::default() + .with_local_addr(Some("192.0.2.1:0".parse().unwrap())) + .with_socket_mark(Some(7)) + .with_bind_device(Some("host-device".to_owned())) + .with_reuse_port(true) + .with_need_protect(true), + purpose: TcpSocketPurpose::ManualConnect, + }; + let task = tokio::spawn({ + let factory = factory.clone(); + let options = options.clone(); + async move { VirtualTcpSocketFactory::connect_tcp(&factory, options).await } + }); + tokio::task::yield_now().await; + let operation = io.operation(true); + { + let creates = io.creates.lock().unwrap(); + let TestCreate::Tcp { + options: submitted, .. + } = creates.get(&operation).unwrap() + else { + panic!("operation is not TCP connect"); + }; + assert_eq!(submitted, &options); + assert!(submitted.bind.need_protect); + } + + io.complete_tcp( + operation, + HostTcpConnectResult { + handle: HostSocketHandle(41), + local_addr: "192.0.2.1:40100".parse().unwrap(), + peer_addr: options.remote_addr, + transport_label: Some("host-tcp".to_owned()), + }, + ); + runtime.notify_completions(); + let stream = task.await.unwrap().unwrap(); + assert_eq!( + stream.local_addr().unwrap(), + "192.0.2.1:40100".parse().unwrap() + ); + assert_eq!(stream.peer_addr().unwrap(), options.remote_addr); + assert_eq!(stream.transport_label(), Some("host-tcp")); + drop(stream); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(41))); + } + + #[tokio::test] + async fn forwards_udp_bind_options_and_wraps_completed_handle() { + let io = Arc::new(TestHostIo::default()); + let (runtime, factory) = test_factory(io.clone()); + let options = UdpBindOptions { + context: crate::socket::SocketContext::default().with_socket_mark(Some(9)), + need_protect: false, + local_addr: Some("[::]:11013".parse().unwrap()), + bind_device: Some("host-device".to_owned()), + reuse_addr: true, + reuse_port: true, + only_v6: true, + purpose: UdpSocketPurpose::PortBoundListener, + }; + let task = tokio::spawn({ + let factory = factory.clone(); + let options = options.clone(); + async move { VirtualUdpSocketFactory::bind_udp(&factory, options).await } + }); + tokio::task::yield_now().await; + let operation = io.operation(false); + { + let creates = io.creates.lock().unwrap(); + let TestCreate::Udp { + options: submitted, .. + } = creates.get(&operation).unwrap() + else { + panic!("operation is not UDP bind"); + }; + assert_eq!(submitted, &options); + assert!(!submitted.need_protect); + } + + io.complete_udp( + operation, + HostUdpBindResult { + handle: HostSocketHandle(42), + local_addr: "[::]:11013".parse().unwrap(), + }, + ); + runtime.notify_completions(); + let socket = task.await.unwrap().unwrap(); + assert_eq!(socket.local_addr().unwrap(), "[::]:11013".parse().unwrap()); + drop(socket); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(42))); + } + + #[tokio::test] + async fn cancelling_completed_create_closes_unobserved_handle() { + let io = Arc::new(TestHostIo::default()); + let (_runtime, factory) = test_factory(io.clone()); + let options = TcpConnectOptions::direct_connect("192.0.2.2:11013".parse().unwrap()); + let mut connect = Box::pin(VirtualTcpSocketFactory::connect_tcp( + &factory, + options.clone(), + )); + assert!(futures::poll!(&mut connect).is_pending()); + let operation = io.operation(true); + io.complete_tcp( + operation, + HostTcpConnectResult { + handle: HostSocketHandle(43), + local_addr: "192.0.2.1:40101".parse().unwrap(), + peer_addr: options.remote_addr, + transport_label: None, + }, + ); + drop(connect); + + assert_eq!(*io.cancelled.lock().unwrap(), vec![operation]); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(43))); + } +} diff --git a/vendor/easytier/easytier-core/src/host/socket/listener.rs b/vendor/easytier/easytier-core/src/host/socket/listener.rs new file mode 100644 index 0000000..049a53c --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/socket/listener.rs @@ -0,0 +1,465 @@ +use std::{io, net::SocketAddr, sync::Arc, task::Poll}; + +use crate::socket::tcp::{TcpListenOptions, VirtualTcpListener, VirtualTcpListenerFactory}; +use async_trait::async_trait; + +use super::{ + HostOperationId, HostSocketHandle, HostSocketIo, HostSocketRuntime, HostTcpIo, HostTcpStream, + factory::HostTcpConnectResult, +}; + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct HostTcpBindResult { + pub handle: HostSocketHandle, + pub local_addr: SocketAddr, +} + +/// Mechanical TCP listener creation and accept readiness. +/// +/// Bind cancellation must close a completed but unobserved listener. Accepted +/// connections stay in a host-owned listener queue until `take_tcp_accept` is +/// called from a guest poll; canceling an accept waiter must not remove one. +/// When bind options request socket protection, the host must complete and +/// acknowledge protection before bind/listen and before exposing each accepted +/// child. A protection error fails the corresponding bind or accept operation. +pub trait HostTcpListenerIo: HostSocketIo { + fn submit_tcp_bind( + &self, + operation: HostOperationId, + options: &TcpListenOptions, + ) -> io::Result<()>; + + fn take_tcp_bind(&self, operation: HostOperationId) -> Poll>; + + fn submit_tcp_accept( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + ) -> io::Result<()>; + + fn take_tcp_accept(&self, operation: HostOperationId) + -> Poll>; +} + +pub trait HostTcpListenerBackend: HostTcpListenerIo + HostTcpIo {} + +impl HostTcpListenerBackend for T where T: HostTcpListenerIo + HostTcpIo {} + +pub struct HostTcpListenerFactory +where + B: HostTcpListenerBackend, +{ + runtime: HostSocketRuntime, + backend: Arc, +} + +impl Clone for HostTcpListenerFactory +where + B: HostTcpListenerBackend, +{ + fn clone(&self) -> Self { + Self { + runtime: self.runtime.clone(), + backend: self.backend.clone(), + } + } +} + +impl HostTcpListenerFactory +where + B: HostTcpListenerBackend, +{ + pub fn new(runtime: HostSocketRuntime, backend: Arc) -> Self { + Self { runtime, backend } + } + + async fn bind(&self, options: TcpListenOptions) -> io::Result>> { + let result = self + .runtime + .run_operation( + self.backend.clone(), + |backend, operation| backend.submit_tcp_bind(operation, &options), + |backend, operation| backend.take_tcp_bind(operation), + |backend, operation| backend.cancel_operation(operation), + ) + .await?; + Ok(Arc::new(HostTcpListener { + runtime: self.runtime.clone(), + backend: self.backend.clone(), + handle: result.handle, + local_addr: result.local_addr, + })) + } +} + +#[async_trait] +impl VirtualTcpListenerFactory for HostTcpListenerFactory +where + B: HostTcpListenerBackend, +{ + type Listener = HostTcpListener; + + async fn bind_tcp(&self, options: TcpListenOptions) -> anyhow::Result> { + Ok(self.bind(options).await?) + } +} + +pub struct HostTcpListener +where + B: HostTcpListenerBackend, +{ + runtime: HostSocketRuntime, + backend: Arc, + handle: HostSocketHandle, + local_addr: SocketAddr, +} + +impl std::fmt::Debug for HostTcpListener +where + B: HostTcpListenerBackend, +{ + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("HostTcpListener") + .field("handle", &self.handle) + .field("local_addr", &self.local_addr) + .finish_non_exhaustive() + } +} + +#[async_trait] +impl VirtualTcpListener for HostTcpListener +where + B: HostTcpListenerBackend, +{ + type Socket = HostTcpStream; + + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn accept(&self) -> io::Result<(Self::Socket, SocketAddr)> { + let result = self + .runtime + .run_operation( + self.backend.clone(), + |backend, operation| backend.submit_tcp_accept(self.handle, operation), + |backend, operation| backend.take_tcp_accept(operation), + |backend, operation| backend.cancel_operation(operation), + ) + .await?; + let peer_addr = result.peer_addr; + Ok(( + self.runtime.tcp_stream( + self.backend.clone(), + result.handle, + result.local_addr, + peer_addr, + result.transport_label, + ), + peer_addr, + )) + } +} + +impl Drop for HostTcpListener +where + B: HostTcpListenerBackend, +{ + fn drop(&mut self) { + let _ = self.backend.close(self.handle); + } +} + +#[cfg(test)] +mod tests { + use std::{ + collections::{HashMap, HashSet, VecDeque}, + sync::Mutex, + }; + + use crate::socket::tcp::{TcpBindOptions, TcpListenPurpose, VirtualTcpSocket}; + + use super::*; + + enum TestOperation { + Bind { + options: TcpListenOptions, + result: Option>, + }, + Accept { + handle: HostSocketHandle, + }, + } + + #[derive(Default)] + struct TestHostIo { + operations: Mutex>, + accepted: Mutex>>, + cancelled: Mutex>, + closed: Mutex>, + } + + impl TestHostIo { + fn bind_operation(&self) -> HostOperationId { + self.operation(|operation| matches!(operation, TestOperation::Bind { .. })) + } + + fn accept_operation(&self) -> HostOperationId { + self.operation(|operation| matches!(operation, TestOperation::Accept { .. })) + } + + fn operation(&self, predicate: impl Fn(&TestOperation) -> bool) -> HostOperationId { + self.operations + .lock() + .unwrap() + .iter() + .find_map(|(operation, value)| predicate(value).then_some(*operation)) + .unwrap() + } + + fn complete_bind(&self, operation: HostOperationId, result: HostTcpBindResult) { + let mut operations = self.operations.lock().unwrap(); + let TestOperation::Bind { + result: completion, .. + } = operations.get_mut(&operation).unwrap() + else { + panic!("operation is not bind"); + }; + *completion = Some(Ok(result)); + } + + fn queue_accept(&self, operation: HostOperationId, result: HostTcpConnectResult) { + let operations = self.operations.lock().unwrap(); + let TestOperation::Accept { handle } = operations.get(&operation).unwrap() else { + panic!("operation is not accept"); + }; + self.accepted + .lock() + .unwrap() + .entry(*handle) + .or_default() + .push_back(result); + } + } + + impl HostSocketIo for TestHostIo { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + if let Some(TestOperation::Bind { + result: Some(Ok(result)), + .. + }) = self.operations.lock().unwrap().remove(&operation) + { + self.closed.lock().unwrap().insert(result.handle); + } + self.cancelled.lock().unwrap().push(operation); + Ok(()) + } + + fn close(&self, handle: HostSocketHandle) -> io::Result<()> { + self.closed.lock().unwrap().insert(handle); + Ok(()) + } + } + + impl HostTcpListenerIo for TestHostIo { + fn submit_tcp_bind( + &self, + operation: HostOperationId, + options: &TcpListenOptions, + ) -> io::Result<()> { + self.operations.lock().unwrap().insert( + operation, + TestOperation::Bind { + options: options.clone(), + result: None, + }, + ); + Ok(()) + } + + fn take_tcp_bind(&self, operation: HostOperationId) -> Poll> { + let mut operations = self.operations.lock().unwrap(); + let Some(TestOperation::Bind { result, .. }) = operations.get_mut(&operation) else { + return Poll::Ready(Err(io::ErrorKind::NotFound.into())); + }; + let Some(result) = result.take() else { + return Poll::Pending; + }; + operations.remove(&operation); + Poll::Ready(result) + } + + fn submit_tcp_accept( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + ) -> io::Result<()> { + self.operations + .lock() + .unwrap() + .insert(operation, TestOperation::Accept { handle }); + Ok(()) + } + + fn take_tcp_accept( + &self, + operation: HostOperationId, + ) -> Poll> { + let mut operations = self.operations.lock().unwrap(); + let Some(TestOperation::Accept { handle }) = operations.get(&operation) else { + return Poll::Ready(Err(io::ErrorKind::NotFound.into())); + }; + let handle = *handle; + let Some(result) = self + .accepted + .lock() + .unwrap() + .entry(handle) + .or_default() + .pop_front() + else { + return Poll::Pending; + }; + operations.remove(&operation); + Poll::Ready(Ok(result)) + } + } + + impl HostTcpIo for TestHostIo { + fn submit_read( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + _capacity: usize, + ) -> io::Result<()> { + Err(io::ErrorKind::Unsupported.into()) + } + + fn take_read(&self, _operation: HostOperationId) -> Poll>> { + Poll::Ready(Err(io::ErrorKind::Unsupported.into())) + } + + fn submit_write( + &self, + _handle: HostSocketHandle, + _operation: HostOperationId, + _source: &[u8], + ) -> io::Result<()> { + Err(io::ErrorKind::Unsupported.into()) + } + + fn take_write(&self, _operation: HostOperationId) -> Poll> { + Poll::Ready(Err(io::ErrorKind::Unsupported.into())) + } + } + + fn listener( + runtime: &HostSocketRuntime, + io: Arc, + handle: HostSocketHandle, + ) -> HostTcpListener { + HostTcpListener { + runtime: runtime.clone(), + backend: io, + handle, + local_addr: "192.0.2.1:11013".parse().unwrap(), + } + } + + #[tokio::test] + async fn forwards_bind_options_and_wraps_accepted_stream() { + let io = Arc::new(TestHostIo::default()); + let runtime = HostSocketRuntime::new(); + let factory = HostTcpListenerFactory::new(runtime.clone(), io.clone()); + let options = TcpListenOptions { + bind: TcpBindOptions::default() + .with_local_addr(Some("192.0.2.1:0".parse().unwrap())) + .with_socket_mark(Some(7)) + .with_bind_device(Some("host-device".to_owned())) + .with_reuse_port(true), + purpose: TcpListenPurpose::ManualConnect, + }; + let bind_task = tokio::spawn({ + let factory = factory.clone(); + let options = options.clone(); + async move { factory.bind_tcp(options).await } + }); + tokio::task::yield_now().await; + let bind_operation = io.bind_operation(); + { + let operations = io.operations.lock().unwrap(); + let TestOperation::Bind { + options: submitted, .. + } = operations.get(&bind_operation).unwrap() + else { + panic!("operation is not bind"); + }; + assert_eq!(submitted, &options); + } + io.complete_bind( + bind_operation, + HostTcpBindResult { + handle: HostSocketHandle(51), + local_addr: "192.0.2.1:11013".parse().unwrap(), + }, + ); + runtime.notify_completions(); + let listener = bind_task.await.unwrap().unwrap(); + + let accept_task = tokio::spawn({ + let listener = listener.clone(); + async move { listener.accept().await } + }); + tokio::task::yield_now().await; + let accept_operation = io.accept_operation(); + io.queue_accept( + accept_operation, + HostTcpConnectResult { + handle: HostSocketHandle(52), + local_addr: "192.0.2.1:11013".parse().unwrap(), + peer_addr: "192.0.2.2:40100".parse().unwrap(), + transport_label: Some("host-accepted".to_owned()), + }, + ); + runtime.notify_completions(); + let (stream, peer_addr) = accept_task.await.unwrap().unwrap(); + assert_eq!(peer_addr, "192.0.2.2:40100".parse().unwrap()); + assert_eq!(stream.transport_label(), Some("host-accepted")); + drop(stream); + drop(listener); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(51))); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(52))); + } + + #[tokio::test] + async fn cancelling_ready_accept_preserves_connection_for_next_poll() { + let io = Arc::new(TestHostIo::default()); + let runtime = HostSocketRuntime::new(); + let listener = listener(&runtime, io.clone(), HostSocketHandle(53)); + let peer_addr = "192.0.2.2:40101".parse().unwrap(); + let operation = { + let mut accept = Box::pin(listener.accept()); + assert!(futures::poll!(&mut accept).is_pending()); + let operation = io.accept_operation(); + io.queue_accept( + operation, + HostTcpConnectResult { + handle: HostSocketHandle(54), + local_addr: "192.0.2.1:11013".parse().unwrap(), + peer_addr, + transport_label: None, + }, + ); + runtime.notify_completions(); + drop(accept); + operation + }; + assert_eq!(*io.cancelled.lock().unwrap(), vec![operation]); + + let (stream, accepted_peer) = listener.accept().await.unwrap(); + assert_eq!(accepted_peer, peer_addr); + drop(stream); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(54))); + } +} diff --git a/vendor/easytier/easytier-core/src/host/socket/mod.rs b/vendor/easytier/easytier-core/src/host/socket/mod.rs new file mode 100644 index 0000000..a27f49d --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/socket/mod.rs @@ -0,0 +1,902 @@ +//! Host-backed socket seams. +//! +//! This module holds the socket-flavoured Host capability seams. Core owns +//! socket I/O scheduling, backpressure, and protocol state; the host Adapter +//! behind these traits owns the mechanical endpoint operations (see +//! CONTEXT.md, "Socket"). [`HostSocketIo`] and [`HostTcpIo`] are the base +//! operation traits keyed by [`HostSocketHandle`] and [`HostOperationId`]; +//! [`HostSocketRuntime`] schedules host completions; [`HostTcpStream`] +//! bridges host TCP I/O into core's socket traits. Socket creation lives in +//! [`factory`], TCP listener bind/accept in [`listener`], and the UDP +//! datagram bridge in [`udp`]. Concrete WASI adapters behind these seams live +//! in [`crate::wasi`]. + +use std::{ + collections::HashMap, + fmt, io, + io::IoSlice, + net::SocketAddr, + pin::Pin, + sync::{Arc, LazyLock, Mutex, atomic::Ordering}, + task::{Context, Poll, Waker}, +}; + +use atomic_shim::AtomicU64; +use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; + +use crate::socket::tcp::VirtualTcpSocket; + +pub mod factory; +pub mod listener; +pub mod udp; + +static NEXT_HOST_OPERATION: LazyLock = LazyLock::new(|| AtomicU64::new(1)); + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct HostSocketHandle(pub u64); + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub struct HostOperationId(pub u64); + +/// Mechanical host I/O below core's socket scheduling seam. +pub trait HostSocketIo: Send + Sync + 'static { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()>; + + /// Close must be idempotent. + fn close(&self, handle: HostSocketHandle) -> io::Result<()>; +} + +/// Mechanical host TCP I/O below core's socket scheduling seam. +/// +/// Submit methods must return without waiting for I/O. `submit_write` must take +/// ownership of the complete source before returning and complete only after +/// all accepted bytes are written or an error occurs. Completion methods return +/// host-owned results; they never retain guest-memory borrows. +pub trait HostTcpIo: HostSocketIo { + fn submit_read( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + capacity: usize, + ) -> io::Result<()>; + + fn take_read(&self, operation: HostOperationId) -> Poll>>; + + fn submit_write( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + source: &[u8], + ) -> io::Result<()>; + + fn take_write(&self, operation: HostOperationId) -> Poll>; +} + +#[derive(Default)] +pub(in crate::host) struct WakerRegistry { + wakers: Mutex>, +} + +impl WakerRegistry { + fn register(&self, operation: HostOperationId, waker: &Waker) { + let mut wakers = self.wakers.lock().expect("host waker registry poisoned"); + match wakers.get_mut(&operation) { + Some(registered) if registered.will_wake(waker) => {} + Some(registered) => *registered = waker.clone(), + None => { + wakers.insert(operation, waker.clone()); + } + } + } + + pub(in crate::host) fn remove(&self, operation: HostOperationId) { + self.wakers + .lock() + .expect("host waker registry poisoned") + .remove(&operation); + } + + fn wake_all(&self) { + let wakers = { + let mut registered = self.wakers.lock().expect("host waker registry poisoned"); + std::mem::take(&mut *registered) + }; + for waker in wakers.into_values() { + waker.wake(); + } + } +} + +pub(in crate::host) struct HostSocketRuntimeInner { + pub(in crate::host) completion_epoch: AtomicU64, + pub(in crate::host) wakers: WakerRegistry, +} + +#[derive(Clone)] +pub struct HostSocketRuntime { + pub(in crate::host) inner: Arc, +} + +impl Default for HostSocketRuntime { + fn default() -> Self { + Self::new() + } +} + +impl HostSocketRuntime { + pub fn new() -> Self { + Self { + inner: Arc::new(HostSocketRuntimeInner { + completion_epoch: AtomicU64::new(0), + wakers: WakerRegistry::default(), + }), + } + } + + pub fn tcp_stream( + &self, + io: Arc, + handle: HostSocketHandle, + local_addr: SocketAddr, + peer_addr: SocketAddr, + transport_label: Option, + ) -> HostTcpStream { + HostTcpStream { + runtime: self.clone(), + io, + handle, + local_addr, + peer_addr, + transport_label, + read_operation: None, + read_buffer: None, + read_eof: false, + write_operation: None, + closed: false, + } + } + + /// Wake socket tasks after the host reports one or more completions. + pub fn notify_completions(&self) { + self.inner.completion_epoch.fetch_add(1, Ordering::SeqCst); + self.inner.wakers.wake_all(); + } + + pub(in crate::host) fn next_operation(&self) -> HostOperationId { + loop { + let operation = NEXT_HOST_OPERATION.fetch_add(1, Ordering::Relaxed); + if operation != 0 { + return HostOperationId(operation); + } + } + } + + pub(in crate::host) fn register_pending( + &self, + operation: HostOperationId, + observed_epoch: u64, + context: &Context<'_>, + ) { + self.inner.wakers.register(operation, context.waker()); + if self.inner.completion_epoch.load(Ordering::SeqCst) != observed_epoch { + self.inner.wakers.remove(operation); + context.waker().wake_by_ref(); + } + } + + pub(crate) async fn run_operation( + &self, + io: Arc, + submit: impl FnOnce(&I, HostOperationId) -> io::Result<()>, + take: impl Fn(&I, HostOperationId) -> Poll>, + cancel: fn(&I, HostOperationId) -> io::Result<()>, + ) -> io::Result + where + I: ?Sized + Send + Sync + 'static, + { + let operation = self.next_operation(); + submit(io.as_ref(), operation)?; + let mut pending = PendingHostOperation::new(self.clone(), io, operation, cancel); + futures::future::poll_fn(|context| { + pending.poll(context, |io, operation| take(io, operation)) + }) + .await + } +} + +pub(in crate::host) struct PendingHostOperation +where + I: ?Sized, +{ + runtime: HostSocketRuntime, + io: Arc, + operation: HostOperationId, + cancel: fn(&I, HostOperationId) -> io::Result<()>, + completed: bool, +} + +impl PendingHostOperation +where + I: ?Sized, +{ + pub(in crate::host) fn new( + runtime: HostSocketRuntime, + io: Arc, + operation: HostOperationId, + cancel: fn(&I, HostOperationId) -> io::Result<()>, + ) -> Self { + Self { + runtime, + io, + operation, + cancel, + completed: false, + } + } + + fn poll( + &mut self, + context: &Context<'_>, + take: impl FnOnce(&I, HostOperationId) -> Poll, + ) -> Poll { + let epoch = self.runtime.inner.completion_epoch.load(Ordering::SeqCst); + match take(self.io.as_ref(), self.operation) { + Poll::Pending => { + self.runtime + .register_pending(self.operation, epoch, context); + Poll::Pending + } + Poll::Ready(result) => { + self.complete(); + Poll::Ready(result) + } + } + } + + fn complete(&mut self) { + self.runtime.inner.wakers.remove(self.operation); + self.completed = true; + } + + fn cancel(mut self) -> io::Result<()> { + self.runtime.inner.wakers.remove(self.operation); + self.completed = true; + (self.cancel)(self.io.as_ref(), self.operation) + } +} + +impl Drop for PendingHostOperation +where + I: ?Sized, +{ + fn drop(&mut self) { + if self.completed { + return; + } + self.runtime.inner.wakers.remove(self.operation); + let _ = (self.cancel)(self.io.as_ref(), self.operation); + } +} + +struct ReadBuffer { + data: Vec, + offset: usize, +} + +pub struct HostTcpStream { + runtime: HostSocketRuntime, + io: Arc, + handle: HostSocketHandle, + local_addr: SocketAddr, + peer_addr: SocketAddr, + transport_label: Option, + read_operation: Option>, + read_buffer: Option, + read_eof: bool, + write_operation: Option>, + closed: bool, +} + +const HOST_TCP_READ_CAPACITY: usize = 64 * 1024; + +impl HostTcpStream { + fn close(&mut self) -> io::Result<()> { + if self.closed { + return Ok(()); + } + + let mut first_error = None; + for pending in [self.read_operation.take(), self.write_operation.take()] + .into_iter() + .flatten() + { + if let Err(error) = pending.cancel() + && first_error.is_none() + { + first_error = Some(error); + } + } + + match self.io.close(self.handle) { + Ok(()) => self.closed = true, + Err(error) if first_error.is_none() => first_error = Some(error), + Err(_) => {} + } + + match first_error { + Some(error) => Err(error), + None => Ok(()), + } + } + + fn copy_buffered_read(&mut self, buffer: &mut ReadBuf<'_>) -> bool { + let Some(pending) = &mut self.read_buffer else { + return false; + }; + let remaining = &pending.data[pending.offset..]; + let copy_len = remaining.len().min(buffer.remaining()); + buffer.put_slice(&remaining[..copy_len]); + pending.offset += copy_len; + if pending.offset == pending.data.len() { + self.read_buffer = None; + } + true + } + + fn poll_write_completion(&mut self, context: &Context<'_>) -> Poll> { + let Some(pending) = &mut self.write_operation else { + return Poll::Ready(Ok(())); + }; + match pending.poll(context, |io, operation| io.take_write(operation)) { + Poll::Pending => Poll::Pending, + Poll::Ready(result) => { + self.write_operation = None; + Poll::Ready(result) + } + } + } + + fn poll_submit_write( + &mut self, + context: &mut Context<'_>, + buffer: &[u8], + ) -> Poll> { + if self.closed { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::BrokenPipe, + "host TCP stream is closed", + ))); + } + if buffer.is_empty() { + return Poll::Ready(Ok(0)); + } + + match self.poll_write_completion(context) { + Poll::Pending => return Poll::Pending, + Poll::Ready(Err(error)) => return Poll::Ready(Err(error)), + Poll::Ready(Ok(())) => {} + } + + let operation = self.runtime.next_operation(); + if let Err(error) = self.io.submit_write(self.handle, operation, buffer) { + return Poll::Ready(Err(error)); + } + self.write_operation = Some(PendingHostOperation::new( + self.runtime.clone(), + self.io.clone(), + operation, + |io, operation| io.cancel_operation(operation), + )); + Poll::Ready(Ok(buffer.len())) + } +} + +impl fmt::Debug for HostTcpStream { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("HostTcpStream") + .field("handle", &self.handle) + .field("local_addr", &self.local_addr) + .field("peer_addr", &self.peer_addr) + .field("transport_label", &self.transport_label) + .field("closed", &self.closed) + .finish_non_exhaustive() + } +} + +impl AsyncRead for HostTcpStream { + fn poll_read( + mut self: Pin<&mut Self>, + context: &mut Context<'_>, + buffer: &mut ReadBuf<'_>, + ) -> Poll> { + if buffer.remaining() == 0 || self.closed || self.read_eof { + return Poll::Ready(Ok(())); + } + if self.copy_buffered_read(buffer) { + return Poll::Ready(Ok(())); + } + + loop { + if self.read_operation.is_none() { + let operation = self.runtime.next_operation(); + if let Err(error) = self.io.submit_read( + self.handle, + operation, + buffer.remaining().max(HOST_TCP_READ_CAPACITY), + ) { + return Poll::Ready(Err(error)); + } + self.read_operation = Some(PendingHostOperation::new( + self.runtime.clone(), + self.io.clone(), + operation, + |io, operation| io.cancel_operation(operation), + )); + } + + let completion = self + .read_operation + .as_mut() + .expect("read operation was just installed") + .poll(context, |io, operation| io.take_read(operation)); + match completion { + Poll::Pending => return Poll::Pending, + Poll::Ready(result) => { + self.read_operation = None; + match result { + Ok(data) if data.is_empty() => { + self.read_eof = true; + return Poll::Ready(Ok(())); + } + Ok(data) => { + self.read_buffer = Some(ReadBuffer { data, offset: 0 }); + if self.copy_buffered_read(buffer) { + return Poll::Ready(Ok(())); + } + } + Err(error) => return Poll::Ready(Err(error)), + } + } + } + } + } +} + +impl AsyncWrite for HostTcpStream { + fn poll_write( + mut self: Pin<&mut Self>, + context: &mut Context<'_>, + buffer: &[u8], + ) -> Poll> { + self.poll_submit_write(context, buffer) + } + + fn poll_write_vectored( + mut self: Pin<&mut Self>, + context: &mut Context<'_>, + buffers: &[IoSlice<'_>], + ) -> Poll> { + if buffers.len() == 1 { + return self.poll_submit_write(context, &buffers[0]); + } + let length = buffers.iter().map(|buffer| buffer.len()).sum(); + if length == 0 { + return self.poll_submit_write(context, &[]); + } + + let mut combined = Vec::with_capacity(length); + for buffer in buffers { + combined.extend_from_slice(buffer); + } + self.poll_submit_write(context, &combined) + } + + fn is_write_vectored(&self) -> bool { + true + } + + fn poll_flush(mut self: Pin<&mut Self>, context: &mut Context<'_>) -> Poll> { + self.poll_write_completion(context) + } + + fn poll_shutdown(mut self: Pin<&mut Self>, context: &mut Context<'_>) -> Poll> { + let flush_error = match self.poll_write_completion(context) { + Poll::Pending => return Poll::Pending, + Poll::Ready(Ok(())) => None, + Poll::Ready(Err(error)) => Some(error), + }; + let close_result = self.close(); + match (flush_error, close_result) { + (Some(error), _) => Poll::Ready(Err(error)), + (None, result) => Poll::Ready(result), + } + } +} + +impl VirtualTcpSocket for HostTcpStream { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + fn peer_addr(&self) -> io::Result { + Ok(self.peer_addr) + } + + fn transport_label(&self) -> Option<&str> { + self.transport_label.as_deref() + } +} + +impl Drop for HostTcpStream { + fn drop(&mut self) { + let _ = self.close(); + } +} + +#[cfg(test)] +mod tests { + use std::{collections::HashSet, sync::atomic::AtomicBool}; + + use tokio::io::{AsyncReadExt as _, AsyncWriteExt as _}; + + use super::*; + + impl WakerRegistry { + pub(crate) fn len(&self) -> usize { + self.wakers.lock().unwrap().len() + } + } + + enum TestOperation { + Read { + capacity: usize, + result: Option>>, + }, + Write { + source: Vec, + result: Option>, + }, + } + + #[derive(Default)] + struct TestHostIo { + operations: Mutex>, + cancelled: Mutex>, + closed: Mutex>, + notify_during_take: AtomicBool, + runtime: Mutex>, + } + + impl TestHostIo { + fn operation(&self, read: bool) -> HostOperationId { + self.operations + .lock() + .unwrap() + .iter() + .find_map(|(id, operation)| match (read, operation) { + (true, TestOperation::Read { .. }) | (false, TestOperation::Write { .. }) => { + Some(*id) + } + _ => None, + }) + .expect("operation was not submitted") + } + + fn write_source(&self, operation: HostOperationId) -> Vec { + let operations = self.operations.lock().unwrap(); + let TestOperation::Write { source, .. } = operations.get(&operation).unwrap() else { + panic!("operation is not a write"); + }; + source.clone() + } + + fn read_capacity(&self, operation: HostOperationId) -> usize { + let operations = self.operations.lock().unwrap(); + let TestOperation::Read { capacity, .. } = operations.get(&operation).unwrap() else { + panic!("operation is not a read"); + }; + *capacity + } + + fn complete_read(&self, operation: HostOperationId, data: Vec) { + let mut operations = self.operations.lock().unwrap(); + let TestOperation::Read { result, .. } = operations.get_mut(&operation).unwrap() else { + panic!("operation is not a read"); + }; + *result = Some(Ok(data)); + } + + fn complete_write(&self, operation: HostOperationId) { + let mut operations = self.operations.lock().unwrap(); + let TestOperation::Write { result, .. } = operations.get_mut(&operation).unwrap() + else { + panic!("operation is not a write"); + }; + *result = Some(Ok(())); + } + + fn fail_write(&self, operation: HostOperationId) { + let mut operations = self.operations.lock().unwrap(); + let TestOperation::Write { result, .. } = operations.get_mut(&operation).unwrap() + else { + panic!("operation is not a write"); + }; + *result = Some(Err(io::Error::other("write failed"))); + } + } + + impl HostSocketIo for TestHostIo { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.operations.lock().unwrap().remove(&operation); + self.cancelled.lock().unwrap().push(operation); + Ok(()) + } + + fn close(&self, handle: HostSocketHandle) -> io::Result<()> { + self.closed.lock().unwrap().insert(handle); + Ok(()) + } + } + + impl HostTcpIo for TestHostIo { + fn submit_read( + &self, + _handle: HostSocketHandle, + operation: HostOperationId, + capacity: usize, + ) -> io::Result<()> { + self.operations.lock().unwrap().insert( + operation, + TestOperation::Read { + capacity, + result: None, + }, + ); + Ok(()) + } + + fn take_read(&self, operation: HostOperationId) -> Poll>> { + if self.notify_during_take.swap(false, Ordering::SeqCst) { + self.runtime + .lock() + .unwrap() + .as_ref() + .unwrap() + .notify_completions(); + return Poll::Pending; + } + let mut operations = self.operations.lock().unwrap(); + let Some(TestOperation::Read { result, .. }) = operations.get_mut(&operation) else { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::NotFound, + "read operation is missing", + ))); + }; + let Some(result) = result.take() else { + return Poll::Pending; + }; + operations.remove(&operation); + Poll::Ready(result) + } + + fn submit_write( + &self, + _handle: HostSocketHandle, + operation: HostOperationId, + source: &[u8], + ) -> io::Result<()> { + self.operations.lock().unwrap().insert( + operation, + TestOperation::Write { + source: source.to_vec(), + result: None, + }, + ); + Ok(()) + } + + fn take_write(&self, operation: HostOperationId) -> Poll> { + let mut operations = self.operations.lock().unwrap(); + let Some(TestOperation::Write { result, .. }) = operations.get_mut(&operation) else { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::NotFound, + "write operation is missing", + ))); + }; + let Some(result) = result.take() else { + return Poll::Pending; + }; + operations.remove(&operation); + Poll::Ready(result) + } + } + + fn test_stream(io: Arc) -> (HostSocketRuntime, HostTcpStream) { + let runtime = HostSocketRuntime::new(); + *io.runtime.lock().unwrap() = Some(runtime.clone()); + let stream = runtime.tcp_stream( + io, + HostSocketHandle(7), + "192.0.2.1:10000".parse().unwrap(), + "192.0.2.2:11013".parse().unwrap(), + Some("host-test".to_owned()), + ); + (runtime, stream) + } + + #[tokio::test] + async fn pending_completions_wake_reads_and_apply_write_backpressure() { + let io = Arc::new(TestHostIo::default()); + let (runtime, stream) = test_stream(io.clone()); + assert_eq!(stream.transport_label(), Some("host-test")); + let (mut reader, mut writer) = tokio::io::split(stream); + + let read_task = tokio::spawn(async move { + let mut data = [0_u8; 3]; + reader.read_exact(&mut data).await.unwrap(); + data + }); + tokio::task::yield_now().await; + let read_operation = io.operation(true); + io.complete_read(read_operation, b"abc".to_vec()); + runtime.notify_completions(); + assert_eq!(read_task.await.unwrap(), *b"abc"); + + let write_task = tokio::spawn(async move { + writer.write_all(b"one").await.unwrap(); + writer.write_all(b"two").await.unwrap(); + writer.shutdown().await.unwrap(); + }); + tokio::task::yield_now().await; + let first_write = io.operation(false); + assert_eq!(io.write_source(first_write), b"one"); + io.complete_write(first_write); + runtime.notify_completions(); + tokio::task::yield_now().await; + let second_write = io.operation(false); + assert_ne!(second_write, first_write); + assert_eq!(io.write_source(second_write), b"two"); + io.complete_write(second_write); + runtime.notify_completions(); + write_task.await.unwrap(); + + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(7))); + } + + #[tokio::test] + async fn small_reads_submit_one_bounded_read_ahead_operation() { + let io = Arc::new(TestHostIo::default()); + let (runtime, mut stream) = test_stream(io.clone()); + let mut first = [0_u8; 1]; + let mut read = Box::pin(stream.read(&mut first)); + assert!(futures::poll!(&mut read).is_pending()); + + let operation = io.operation(true); + assert_eq!(io.read_capacity(operation), HOST_TCP_READ_CAPACITY); + io.complete_read(operation, b"abc".to_vec()); + runtime.notify_completions(); + assert_eq!(read.await.unwrap(), 1); + assert_eq!(&first, b"a"); + + let mut remainder = [0_u8; 2]; + stream.read_exact(&mut remainder).await.unwrap(); + assert_eq!(&remainder, b"bc"); + } + + #[tokio::test] + async fn vectored_write_submits_one_ordered_host_operation() { + let io = Arc::new(TestHostIo::default()); + let (runtime, mut stream) = test_stream(io.clone()); + assert!(stream.is_write_vectored()); + + let buffers = [IoSlice::new(b"one"), IoSlice::new(b"two")]; + assert_eq!(stream.write_vectored(&buffers).await.unwrap(), 6); + let operation = io.operation(false); + assert_eq!(io.write_source(operation), b"onetwo"); + + io.complete_write(operation); + runtime.notify_completions(); + stream.shutdown().await.unwrap(); + } + + #[tokio::test] + async fn cancelled_read_keeps_owned_completion_remainder() { + let io = Arc::new(TestHostIo::default()); + let (runtime, mut stream) = test_stream(io.clone()); + let mut large = [0_u8; 4]; + let mut first_read = Box::pin(stream.read(&mut large)); + assert!(futures::poll!(&mut first_read).is_pending()); + drop(first_read); + + let operation = io.operation(true); + io.complete_read(operation, b"abcd".to_vec()); + runtime.notify_completions(); + let mut first = [0_u8; 1]; + stream.read_exact(&mut first).await.unwrap(); + assert_eq!(&first, b"a"); + let mut remainder = [0_u8; 3]; + stream.read_exact(&mut remainder).await.unwrap(); + assert_eq!(&remainder, b"bcd"); + } + + #[tokio::test] + async fn empty_read_completion_reports_eof() { + let io = Arc::new(TestHostIo::default()); + let (runtime, mut stream) = test_stream(io.clone()); + let read_task = tokio::spawn(async move { + let mut byte = [0_u8; 1]; + stream.read(&mut byte).await.unwrap() + }); + tokio::task::yield_now().await; + let operation = io.operation(true); + io.complete_read(operation, Vec::new()); + runtime.notify_completions(); + + assert_eq!(read_task.await.unwrap(), 0); + } + + #[tokio::test] + async fn shutdown_closes_handle_after_buffered_write_error() { + let io = Arc::new(TestHostIo::default()); + let (runtime, mut stream) = test_stream(io.clone()); + stream.write_all(b"data").await.unwrap(); + let operation = io.operation(false); + io.fail_write(operation); + runtime.notify_completions(); + + let error = stream.shutdown().await.unwrap_err(); + assert_eq!(error.to_string(), "write failed"); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(7))); + } + + #[tokio::test] + async fn completion_between_poll_and_registration_is_not_lost() { + let io = Arc::new(TestHostIo::default()); + let (_runtime, mut stream) = test_stream(io.clone()); + let operation = { + let mut byte = [0_u8; 1]; + let mut read = Box::pin(stream.read(&mut byte)); + assert!(futures::poll!(&mut read).is_pending()); + io.operation(true) + }; + io.complete_read(operation, b"x".to_vec()); + io.notify_during_take.store(true, Ordering::SeqCst); + + let mut byte = [0_u8; 1]; + tokio::time::timeout( + std::time::Duration::from_secs(1), + stream.read_exact(&mut byte), + ) + .await + .unwrap() + .unwrap(); + assert_eq!(&byte, b"x"); + } + + #[tokio::test] + async fn dropping_pending_stream_removes_waker_cancels_and_closes() { + let io = Arc::new(TestHostIo::default()); + let (runtime, mut stream) = test_stream(io.clone()); + let read_task = tokio::spawn(async move { + let mut byte = [0_u8; 1]; + let _ = stream.read(&mut byte).await; + }); + tokio::task::yield_now().await; + let operation = io.operation(true); + assert_eq!(runtime.inner.wakers.len(), 1); + read_task.abort(); + let _ = read_task.await; + + assert_eq!(runtime.inner.wakers.len(), 0); + assert_eq!(*io.cancelled.lock().unwrap(), vec![operation]); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(7))); + } + + #[test] + fn shared_host_io_receives_unique_operation_ids() { + let runtime_a = HostSocketRuntime::new(); + let runtime_b = HostSocketRuntime::new(); + assert_ne!(runtime_a.next_operation(), runtime_b.next_operation()); + } +} diff --git a/vendor/easytier/easytier-core/src/host/socket/udp.rs b/vendor/easytier/easytier-core/src/host/socket/udp.rs new file mode 100644 index 0000000..f8aece2 --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/socket/udp.rs @@ -0,0 +1,522 @@ +use std::{fmt, io, net::SocketAddr, sync::Arc, task::Poll}; + +use async_trait::async_trait; + +use crate::socket::{ + SocketContext, + udp::{UdpSocketRecvMeta, UdpSocketSendMeta, VirtualUdpSocket}, +}; + +use super::{HostOperationId, HostSocketHandle, HostSocketIo, HostSocketRuntime}; + +/// One host-owned UDP receive completion. +#[derive(Debug)] +pub struct HostUdpDatagram { + pub data: Vec, + pub peer_addr: SocketAddr, + pub meta: UdpSocketRecvMeta, +} + +/// Mechanical host UDP I/O below core's datagram scheduling seam. +/// +/// Submit methods register readiness without performing the datagram I/O. +/// Receive datagrams stay in a host-owned socket queue until `take_recv` is +/// called from a guest poll, so canceling a waiter cannot consume a datagram. +/// `try_send` must synchronously copy one complete datagram into a bounded host +/// queue or return `WouldBlock`; it must never retain guest-memory borrows. +pub trait HostUdpIo: HostSocketIo { + fn submit_recv( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + capacity: usize, + ) -> io::Result<()>; + + fn take_recv(&self, operation: HostOperationId) -> Poll>; + + fn try_send( + &self, + handle: HostSocketHandle, + source: &[u8], + peer_addr: SocketAddr, + meta: UdpSocketSendMeta, + ) -> io::Result<()>; + + fn submit_send_ready( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + ) -> io::Result<()>; + + fn take_send_ready(&self, operation: HostOperationId) -> Poll>; +} + +pub struct HostUdpSocket { + runtime: HostSocketRuntime, + io: Arc, + handle: HostSocketHandle, + local_addr: SocketAddr, + context: SocketContext, +} + +impl HostSocketRuntime { + pub fn udp_socket( + &self, + io: Arc, + handle: HostSocketHandle, + local_addr: SocketAddr, + ) -> HostUdpSocket { + self.udp_socket_with_context(io, handle, local_addr, SocketContext::default()) + } + + pub fn udp_socket_with_context( + &self, + io: Arc, + handle: HostSocketHandle, + local_addr: SocketAddr, + context: SocketContext, + ) -> HostUdpSocket { + HostUdpSocket { + runtime: self.clone(), + io, + handle, + local_addr, + context, + } + } +} + +impl HostUdpSocket { + async fn send( + &self, + data: &[u8], + peer_addr: SocketAddr, + meta: UdpSocketSendMeta, + ) -> io::Result { + loop { + match self.io.try_send(self.handle, data, peer_addr, meta) { + Ok(()) => return Ok(data.len()), + Err(error) if error.kind() == io::ErrorKind::WouldBlock => {} + Err(error) => return Err(error), + } + + self.runtime + .run_operation( + self.io.clone(), + |io, operation| io.submit_send_ready(self.handle, operation), + |io, operation| io.take_send_ready(operation), + |io, operation| io.cancel_operation(operation), + ) + .await?; + } + } + + async fn receive(&self, buffer: &mut [u8]) -> io::Result { + let datagram = self + .runtime + .run_operation( + self.io.clone(), + |io, operation| io.submit_recv(self.handle, operation, buffer.len()), + |io, operation| io.take_recv(operation), + |io, operation| io.cancel_operation(operation), + ) + .await?; + + let copy_len = datagram.data.len().min(buffer.len()); + buffer[..copy_len].copy_from_slice(&datagram.data[..copy_len]); + let mut datagram = datagram; + datagram.data.truncate(copy_len); + Ok(datagram) + } +} + +impl fmt::Debug for HostUdpSocket { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("HostUdpSocket") + .field("handle", &self.handle) + .field("local_addr", &self.local_addr) + .finish_non_exhaustive() + } +} + +#[async_trait] +impl VirtualUdpSocket for HostUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + fn socket_context(&self) -> SocketContext { + self.context.clone() + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> io::Result { + self.send(data, addr, UdpSocketSendMeta::default()).await + } + + async fn recv_from(&self, buffer: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + let datagram = self.receive(buffer).await?; + Ok((datagram.data.len(), datagram.peer_addr)) + } + + async fn send_to_with_meta( + &self, + data: &[u8], + addr: SocketAddr, + meta: UdpSocketSendMeta, + ) -> io::Result { + self.send(data, addr, meta).await + } + + async fn recv_from_with_meta( + &self, + buffer: &mut [u8], + ) -> io::Result<(usize, SocketAddr, UdpSocketRecvMeta)> { + let datagram = self.receive(buffer).await?; + Ok((datagram.data.len(), datagram.peer_addr, datagram.meta)) + } +} + +impl Drop for HostUdpSocket { + fn drop(&mut self) { + let _ = self.io.close(self.handle); + } +} + +#[cfg(test)] +mod tests { + use std::{ + collections::{HashMap, HashSet, VecDeque}, + net::{IpAddr, Ipv4Addr}, + sync::{ + Mutex, + atomic::{AtomicBool, Ordering}, + }, + }; + + use super::*; + + enum TestOperation { + Receive, + SendReady(Option>), + } + + #[derive(Default)] + struct TestHostUdpIo { + operations: Mutex>, + received: Mutex>, + sent: Mutex, SocketAddr, UdpSocketSendMeta)>>, + writable: AtomicBool, + cancelled: Mutex>, + closed: Mutex>, + } + + impl TestHostUdpIo { + fn operation(&self, receive: bool) -> HostOperationId { + self.operations + .lock() + .unwrap() + .iter() + .find_map(|(id, operation)| match (receive, operation) { + (true, TestOperation::Receive) | (false, TestOperation::SendReady(_)) => { + Some(*id) + } + _ => None, + }) + .expect("operation was not submitted") + } + + fn complete_recv(&self, operation: HostOperationId, datagram: HostUdpDatagram) { + let operations = self.operations.lock().unwrap(); + let TestOperation::Receive = operations.get(&operation).unwrap() else { + panic!("operation is not a receive"); + }; + self.received.lock().unwrap().push_back(datagram); + } + + fn complete_send(&self, operation: HostOperationId) { + let mut operations = self.operations.lock().unwrap(); + let TestOperation::SendReady(result) = operations.get_mut(&operation).unwrap() else { + panic!("operation is not a send"); + }; + *result = Some(Ok(())); + self.writable.store(true, Ordering::SeqCst); + } + } + + impl HostSocketIo for TestHostUdpIo { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.operations.lock().unwrap().remove(&operation); + self.cancelled.lock().unwrap().push(operation); + Ok(()) + } + + fn close(&self, handle: HostSocketHandle) -> io::Result<()> { + self.closed.lock().unwrap().insert(handle); + Ok(()) + } + } + + impl HostUdpIo for TestHostUdpIo { + fn submit_recv( + &self, + _handle: HostSocketHandle, + operation: HostOperationId, + _capacity: usize, + ) -> io::Result<()> { + self.operations + .lock() + .unwrap() + .insert(operation, TestOperation::Receive); + Ok(()) + } + + fn take_recv(&self, operation: HostOperationId) -> Poll> { + let mut operations = self.operations.lock().unwrap(); + let Some(TestOperation::Receive) = operations.get_mut(&operation) else { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::NotFound, + "receive operation is missing", + ))); + }; + let Some(datagram) = self.received.lock().unwrap().pop_front() else { + return Poll::Pending; + }; + operations.remove(&operation); + Poll::Ready(Ok(datagram)) + } + + fn try_send( + &self, + _handle: HostSocketHandle, + source: &[u8], + peer_addr: SocketAddr, + meta: UdpSocketSendMeta, + ) -> io::Result<()> { + if !self.writable.swap(false, Ordering::SeqCst) { + return Err(io::ErrorKind::WouldBlock.into()); + } + self.sent + .lock() + .unwrap() + .push((source.to_vec(), peer_addr, meta)); + Ok(()) + } + + fn submit_send_ready( + &self, + _handle: HostSocketHandle, + operation: HostOperationId, + ) -> io::Result<()> { + self.operations + .lock() + .unwrap() + .insert(operation, TestOperation::SendReady(None)); + Ok(()) + } + + fn take_send_ready(&self, operation: HostOperationId) -> Poll> { + let mut operations = self.operations.lock().unwrap(); + let Some(TestOperation::SendReady(result)) = operations.get_mut(&operation) else { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::NotFound, + "send readiness operation is missing", + ))); + }; + let Some(result) = result.take() else { + return Poll::Pending; + }; + operations.remove(&operation); + Poll::Ready(result) + } + } + + fn test_socket(io: Arc) -> (HostSocketRuntime, HostUdpSocket) { + let runtime = HostSocketRuntime::new(); + let socket = + runtime.udp_socket(io, HostSocketHandle(9), "192.0.2.1:11013".parse().unwrap()); + (runtime, socket) + } + + #[tokio::test] + async fn send_waits_for_readiness_then_enqueues_atomically() { + let io = Arc::new(TestHostUdpIo::default()); + let (runtime, socket) = test_socket(io.clone()); + let socket = Arc::new(socket); + let peer_addr = "192.0.2.2:22026".parse().unwrap(); + let source_ip = IpAddr::V4(Ipv4Addr::new(192, 0, 2, 10)); + let task = tokio::spawn({ + let socket = socket.clone(); + async move { + socket + .send_to_with_meta( + b"udp", + peer_addr, + UdpSocketSendMeta { + src_ip: Some(source_ip), + src_ifindex: None, + }, + ) + .await + } + }); + tokio::task::yield_now().await; + + let operation = io.operation(false); + assert!(io.sent.lock().unwrap().is_empty()); + + io.complete_send(operation); + runtime.notify_completions(); + assert_eq!(task.await.unwrap().unwrap(), 3); + assert_eq!( + *io.sent.lock().unwrap(), + vec![( + b"udp".to_vec(), + peer_addr, + UdpSocketSendMeta { + src_ip: Some(source_ip), + src_ifindex: None, + } + )] + ); + drop(socket); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(9))); + } + + #[tokio::test] + async fn receive_returns_owned_payload_peer_and_destination_metadata() { + let io = Arc::new(TestHostUdpIo::default()); + let (runtime, socket) = test_socket(io.clone()); + let socket = Arc::new(socket); + let peer_addr = "192.0.2.2:22026".parse().unwrap(); + let destination_ip = IpAddr::V4(Ipv4Addr::new(192, 0, 2, 10)); + let task = tokio::spawn({ + let socket = socket.clone(); + async move { + let mut buffer = [0_u8; 4]; + let result = socket.recv_from_with_meta(&mut buffer).await; + (result, buffer) + } + }); + tokio::task::yield_now().await; + + let operation = io.operation(true); + io.complete_recv( + operation, + HostUdpDatagram { + data: b"data".to_vec(), + peer_addr, + meta: UdpSocketRecvMeta { + dst_ip: Some(destination_ip), + }, + }, + ); + runtime.notify_completions(); + + let (result, buffer) = task.await.unwrap(); + let (length, received_peer, meta) = result.unwrap(); + assert_eq!(length, 4); + assert_eq!(&buffer, b"data"); + assert_eq!(received_peer, peer_addr); + assert_eq!(meta.dst_ip, Some(destination_ip)); + } + + #[tokio::test] + async fn cancelling_completed_receive_preserves_datagram_for_next_poll() { + let io = Arc::new(TestHostUdpIo::default()); + let (runtime, socket) = test_socket(io.clone()); + let peer_addr = "192.0.2.2:22026".parse().unwrap(); + let operation = { + let mut buffer = [0_u8; 1]; + let mut receive = Box::pin(socket.recv_from(&mut buffer)); + assert!(futures::poll!(&mut receive).is_pending()); + let operation = io.operation(true); + assert_eq!(runtime.inner.wakers.len(), 1); + io.complete_recv( + operation, + HostUdpDatagram { + data: b"kept".to_vec(), + peer_addr, + meta: UdpSocketRecvMeta::default(), + }, + ); + runtime.notify_completions(); + drop(receive); + operation + }; + + assert_eq!(runtime.inner.wakers.len(), 0); + assert_eq!(*io.cancelled.lock().unwrap(), vec![operation]); + let mut recovered = [0_u8; 4]; + assert_eq!( + socket.recv_from(&mut recovered).await.unwrap(), + (4, peer_addr) + ); + assert_eq!(&recovered, b"kept"); + drop(socket); + assert!(io.closed.lock().unwrap().contains(&HostSocketHandle(9))); + } + + #[tokio::test] + async fn cancelling_send_readiness_never_enqueues_datagram() { + let io = Arc::new(TestHostUdpIo::default()); + let (runtime, socket) = test_socket(io.clone()); + let peer_addr = "192.0.2.2:22026".parse().unwrap(); + let operation = { + let mut send = Box::pin(socket.send_to(b"cancelled", peer_addr)); + assert!(futures::poll!(&mut send).is_pending()); + let operation = io.operation(false); + io.complete_send(operation); + runtime.notify_completions(); + drop(send); + operation + }; + + assert_eq!(*io.cancelled.lock().unwrap(), vec![operation]); + assert!(io.sent.lock().unwrap().is_empty()); + } + + async fn receive_payload( + runtime: &HostSocketRuntime, + io: &Arc, + socket: Arc, + payload: Vec, + ) -> (usize, [u8; N]) { + let peer_addr = "192.0.2.2:22026".parse().unwrap(); + let task = tokio::spawn(async move { + let mut buffer = [0_u8; N]; + let (length, _) = socket.recv_from(&mut buffer).await.unwrap(); + (length, buffer) + }); + tokio::task::yield_now().await; + let operation = io.operation(true); + io.complete_recv( + operation, + HostUdpDatagram { + data: payload, + peer_addr, + meta: UdpSocketRecvMeta::default(), + }, + ); + runtime.notify_completions(); + task.await.unwrap() + } + + #[tokio::test] + async fn receive_truncates_and_distinguishes_empty_buffers_from_datagrams() { + let io = Arc::new(TestHostUdpIo::default()); + let (runtime, socket) = test_socket(io.clone()); + let socket = Arc::new(socket); + + let (length, buffer) = + receive_payload(&runtime, &io, socket.clone(), b"long".to_vec()).await; + assert_eq!((length, buffer), (2, *b"lo")); + + let (length, buffer) = + receive_payload::<0>(&runtime, &io, socket.clone(), b"consumed".to_vec()).await; + assert_eq!((length, buffer), (0, [])); + + let (length, buffer) = receive_payload(&runtime, &io, socket, Vec::new()).await; + assert_eq!((length, buffer), (0, [0])); + } +} diff --git a/vendor/easytier/easytier-core/src/host/testkit.rs b/vendor/easytier/easytier-core/src/host/testkit.rs new file mode 100644 index 0000000..6ab4774 --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/testkit.rs @@ -0,0 +1,206 @@ +//! Shared virtual-socket and DNS fakes for core unit tests. +//! +//! `gateway` and `instance` tests drive the same portable host seams; both use +//! this kit instead of keeping parallel copies. The fakes are inert by +//! default: TCP connects only succeed for proxy-NAT purposes, listeners never +//! accept, UDP sockets never receive, and DNS answers only literal IP hosts. + +use std::{ + io, + net::{IpAddr, SocketAddr}, + pin::Pin, + sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, + }, + task::{Context, Poll}, +}; + +use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; + +use super::dns::{DnsQuery, DnsRecordResolver, DnsResolver, DnsSrvRecord}; +use crate::socket::{ + tcp::{ + TcpConnectOptions, TcpListenOptions, TcpListenPurpose, TcpSocketPurpose, + VirtualTcpListener, VirtualTcpListenerFactory, VirtualTcpSocket, VirtualTcpSocketFactory, + }, + udp::{UdpBindOptions, VirtualUdpSocket, VirtualUdpSocketFactory}, +}; + +pub struct TestTcpSocket(pub tokio::io::DuplexStream); + +impl AsyncRead for TestTcpSocket { + fn poll_read( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + Pin::new(&mut self.get_mut().0).poll_read(_cx, buf) + } +} + +impl AsyncWrite for TestTcpSocket { + fn poll_write( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut self.get_mut().0).poll_write(_cx, buf) + } + + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.get_mut().0).poll_flush(cx) + } + + fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.get_mut().0).poll_shutdown(cx) + } +} + +impl VirtualTcpSocket for TestTcpSocket { + fn local_addr(&self) -> io::Result { + Ok("127.0.0.1:20000".parse().unwrap()) + } + + fn peer_addr(&self) -> io::Result { + Ok("127.0.0.1:20001".parse().unwrap()) + } +} + +pub struct TestTcpListener { + address: SocketAddr, + active_listeners: Arc, +} + +impl Drop for TestTcpListener { + fn drop(&mut self) { + self.active_listeners.fetch_sub(1, Ordering::Relaxed); + } +} + +#[async_trait::async_trait] +impl VirtualTcpListener for TestTcpListener { + type Socket = TestTcpSocket; + + fn local_addr(&self) -> io::Result { + Ok(self.address) + } + + async fn accept(&self) -> io::Result<(Self::Socket, SocketAddr)> { + std::future::pending().await + } +} + +pub struct TestUdpSocket(pub SocketAddr); + +#[async_trait::async_trait] +impl VirtualUdpSocket for TestUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.0) + } + + async fn send_to(&self, data: &[u8], _addr: SocketAddr) -> io::Result { + Ok(data.len()) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } +} + +#[derive(Default)] +pub struct TestHost { + pub tcp_binds: AtomicUsize, + pub active_tcp_listeners: Arc, + pub udp_binds: AtomicUsize, + pub proxy_nat_connections: + Option>, + pub reject_socks5_listener: bool, +} + +#[async_trait::async_trait] +impl VirtualTcpSocketFactory for TestHost { + type Socket = TestTcpSocket; + + async fn connect_tcp(&self, options: TcpConnectOptions) -> anyhow::Result { + if options.purpose != TcpSocketPurpose::ProxyNat { + anyhow::bail!("test host does not connect non-proxy TCP sockets"); + } + let connections = self + .proxy_nat_connections + .as_ref() + .ok_or_else(|| anyhow::anyhow!("test host proxy NAT is disabled"))?; + let (socket, peer) = tokio::io::duplex(1024); + connections + .send((options.remote_addr, peer)) + .map_err(|_| anyhow::anyhow!("test host proxy NAT receiver is closed"))?; + Ok(TestTcpSocket(socket)) + } +} + +#[async_trait::async_trait] +impl VirtualTcpListenerFactory for TestHost { + type Listener = TestTcpListener; + + async fn bind_tcp(&self, options: TcpListenOptions) -> anyhow::Result> { + self.tcp_binds.fetch_add(1, Ordering::Relaxed); + if self.reject_socks5_listener && options.purpose == TcpListenPurpose::Socks5 { + anyhow::bail!("test host rejected SOCKS5 listener"); + } + let address = options + .bind + .local_addr + .unwrap_or_else(|| "127.0.0.1:20000".parse().unwrap()); + // Ephemeral binds still report a fixed nonzero port: the gateway + // smoltcp connector feeds `local_addr().port()` into the virtual + // stack, which rejects source port 0 as unaddressable. + let address = if address.port() == 0 { + SocketAddr::new(address.ip(), 20000) + } else { + address + }; + self.active_tcp_listeners.fetch_add(1, Ordering::Relaxed); + Ok(Arc::new(TestTcpListener { + address, + active_listeners: self.active_tcp_listeners.clone(), + })) + } +} + +#[async_trait::async_trait] +impl VirtualUdpSocketFactory for TestHost { + type Socket = TestUdpSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.udp_binds.fetch_add(1, Ordering::Relaxed); + let address = options + .local_addr + .unwrap_or_else(|| "127.0.0.1:20002".parse().unwrap()); + let address = if address.port() == 0 { + SocketAddr::new(address.ip(), 20002) + } else { + address + }; + Ok(Arc::new(TestUdpSocket(address))) + } +} + +pub struct TestDns; + +#[async_trait::async_trait] +impl DnsResolver for TestDns { + async fn resolve(&self, query: DnsQuery) -> anyhow::Result> { + Ok(query.host.parse().into_iter().collect()) + } +} + +#[async_trait::async_trait] +impl DnsRecordResolver for TestDns { + async fn resolve_txt(&self, _query: DnsQuery) -> anyhow::Result { + anyhow::bail!("test DNS has no TXT records") + } + + async fn resolve_srv(&self, _query: DnsQuery) -> anyhow::Result> { + Ok(Vec::new()) + } +} diff --git a/vendor/easytier/easytier-core/src/host/tunnel.rs b/vendor/easytier/easytier-core/src/host/tunnel.rs new file mode 100644 index 0000000..d6db54e --- /dev/null +++ b/vendor/easytier/easytier-core/src/host/tunnel.rs @@ -0,0 +1,36 @@ +//! Host-backed message tunnels. +//! +//! The host owns the concrete transport and exposes complete EasyTier tunnel +//! payloads. Core owns packet semantics and the peer lifecycle above them. + +use std::{io, task::Poll}; + +use super::socket::{HostOperationId, HostSocketHandle, HostSocketIo}; + +/// Maximum message payload accepted from a host tunnel adapter. +pub const MAX_HOST_TUNNEL_PAYLOAD_LEN: usize = 1024 * 1024; + +/// Mechanical host I/O below EasyTier's message-tunnel seam. +/// +/// Submit methods copy their complete input before returning. A receive keeps +/// the host transport's message boundary intact. A clean remote close is +/// reported as [`io::ErrorKind::UnexpectedEof`] by `take_receive`. +pub trait HostTunnelIo: HostSocketIo { + fn submit_receive( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + capacity: usize, + ) -> io::Result<()>; + + fn take_receive(&self, operation: HostOperationId) -> Poll>>; + + fn submit_send( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + source: &[u8], + ) -> io::Result<()>; + + fn take_send(&self, operation: HostOperationId) -> Poll>; +} diff --git a/vendor/easytier/easytier-core/src/instance/build_capabilities.rs b/vendor/easytier/easytier-core/src/instance/build_capabilities.rs new file mode 100644 index 0000000..dd7ee73 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/build_capabilities.rs @@ -0,0 +1,79 @@ +//! Compile-time capability selection for portable Instance validation. +//! +//! Cargo features are localized here so configuration validation remains one +//! unconditional path in `CoreInstance`. + +use crate::config::{peers::PeerRuntimeSnapshot, runtime::CoreRuntimeConfig}; + +use super::CoreInstanceConfig; + +const DHCP_IPV4_AVAILABLE: bool = cfg!(feature = "dhcp-ipv4"); +const SMOLTCP_GATEWAY_AVAILABLE: bool = cfg!(feature = "proxy-smoltcp-stack"); +const PACKET_PROXY_AVAILABLE: bool = cfg!(feature = "proxy-packet"); +const PROXY_CIDR_MONITOR_AVAILABLE: bool = cfg!(feature = "proxy-cidr-monitor"); +const WRAPPED_TRANSPORT_AVAILABLE: bool = cfg!(feature = "wrapped-transport"); +const PUBLIC_IPV6_AVAILABLE: bool = cfg!(feature = "public-ipv6-provider"); +const VPN_PORTAL_AVAILABLE: bool = cfg!(feature = "vpn-portal"); + +fn require(available: bool, requested: bool, capability: &str) -> anyhow::Result<()> { + if requested && !available { + anyhow::bail!("this build does not include {capability}"); + } + Ok(()) +} + +fn validate_snapshot( + runtime: &CoreRuntimeConfig, + peer: &PeerRuntimeSnapshot, +) -> anyhow::Result<()> { + let core = &peer.runtime.core; + require(DHCP_IPV4_AVAILABLE, runtime.dhcp_ipv4, "DHCP IPv4")?; + require( + SMOLTCP_GATEWAY_AVAILABLE, + runtime.gateway.socks5_bind.is_some() || !runtime.gateway.port_forwards.is_empty(), + "the smoltcp gateway", + )?; + require( + PROXY_CIDR_MONITOR_AVAILABLE, + runtime + .manual_routes + .as_ref() + .is_some_and(|routes| !routes.is_empty()), + "the proxy CIDR monitor", + )?; + require( + WRAPPED_TRANSPORT_AVAILABLE, + !core.routes.proxy_networks.is_empty(), + "proxy routing services", + )?; + require( + PACKET_PROXY_AVAILABLE, + runtime + .proxy + .should_start(!core.routes.proxy_networks.is_empty()), + "packet proxy services", + )?; + require( + PUBLIC_IPV6_AVAILABLE, + runtime.public_ipv6_auto + || runtime.public_ipv6_provider.provider_enabled + || runtime.public_ipv6_provider.configured_prefix.is_some(), + "public IPv6 services", + )?; + Ok(()) +} + +pub(super) fn validate(config: &CoreInstanceConfig) -> anyhow::Result<()> { + validate_snapshot(&config.connectivity.runtime, &config.peer.snapshot)?; + require( + VPN_PORTAL_AVAILABLE, + config.vpn_portal.is_some(), + "the VPN portal", + ) +} + +pub(super) fn validate_runtime( + config: &crate::config::runtime::CoreInstanceRuntimeConfig, +) -> anyhow::Result<()> { + validate_snapshot(&config.services, &config.peer) +} diff --git a/vendor/easytier/easytier-core/src/instance/config.rs b/vendor/easytier/easytier-core/src/instance/config.rs new file mode 100644 index 0000000..7bfdd23 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/config.rs @@ -0,0 +1,740 @@ +//! Portable normalization from the shared TOML model into one core instance. + +use std::collections::BTreeSet; + +use crate::{ + config::{ + EncryptionAlgorithm, IpPrefix, NodeConfig, ProxyNetworkConfig, RouteConfig, + gateway::{GatewayRuntimeConfig, ProxyRuntimeConfig}, + peers::{AclRuleConfig, HostRoutingPolicy, PublicIpv6ProviderConfig}, + runtime::CoreRuntimeConfig, + toml::{ConfigLoader as _, Flags, TomlConfig}, + }, + connectivity::{ + direct::DirectConnectorOptions, + manual::{ManualConnectorOptions, discovery::ManualEndpointDiscoveryConfig}, + stun::StunServerConfig, + }, + gateway::vpn_portal::{PortalClientConfig, PortalRuntimeConfig}, + listener::plan::ListenerRuntimeConfig, + packet::CompressorAlgo, + peers::{ + context::PeerRuntimeSnapshotInput, + peer_manager::{PortablePeerManagerConfig, RouteAlgoType}, + }, + socket::{NetNamespace, SocketContext, tcp::TcpBindOptions, udp::UdpBindOptions}, + tunnel::encrypt::algorithm_is_available, +}; + +use easytier_proto::common::CompressionAlgoPb; + +use super::{CoreConnectivityConfig, CoreConnectivityMode, CoreInstanceConfig}; + +const OSPF_UPDATE_MY_FOREIGN_NETWORK_INTERVAL_SEC: u64 = 10; +const MAX_DIRECT_CONNS_PER_PEER_IN_FOREIGN_NETWORK: usize = 3; + +/// Host facts and policy that cannot be derived from the shared TOML model. +/// +/// This input deliberately contains no routes, ACL, peer, gateway, listener, +/// or other portable configuration. Core combines it with TOML through one +/// normalization path for both initial construction and runtime patching. +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct CoreInstanceHostConfig { + pub hostname_fallback: Option, + pub host_routing: HostRoutingPolicy, + pub force_exit_node: bool, + pub allow_interface_bind: bool, + pub smoltcp_available: bool, + pub requires_smoltcp: bool, + pub icmp_failure_is_fatal: bool, + pub public_ipv6_provider_supported: bool, + pub gateway_enabled: bool, + pub proxy_enabled: bool, + pub vpn_portal_enabled: bool, + pub magic_dns_enabled: bool, + pub kcp_enabled: bool, + pub quic_enabled: bool, + pub udp_broadcast_enabled: bool, + pub upnp_enabled: bool, + pub tcp_hole_punching_enabled: bool, + pub ignore_unsupported_config: bool, + pub connectivity: CoreConnectivityMode, + pub easytier_version: String, + pub endpoint_protocols: Vec, +} + +impl Default for CoreInstanceHostConfig { + fn default() -> Self { + Self { + hostname_fallback: None, + host_routing: HostRoutingPolicy::default(), + force_exit_node: false, + allow_interface_bind: true, + smoltcp_available: false, + requires_smoltcp: false, + icmp_failure_is_fatal: false, + public_ipv6_provider_supported: false, + gateway_enabled: true, + proxy_enabled: true, + vpn_portal_enabled: true, + magic_dns_enabled: true, + kcp_enabled: true, + quic_enabled: true, + udp_broadcast_enabled: true, + upnp_enabled: true, + tcp_hole_punching_enabled: true, + ignore_unsupported_config: false, + connectivity: CoreConnectivityMode::Full, + easytier_version: env!("CARGO_PKG_VERSION").to_owned(), + endpoint_protocols: ManualEndpointDiscoveryConfig::default().srv_protocols, + } + } +} + +impl CoreInstanceHostConfig { + pub(crate) fn accepts_runtime_url(&self, url: &url::Url) -> bool { + !self.ignore_unsupported_config + || self + .endpoint_protocols + .iter() + .any(|scheme| scheme.eq_ignore_ascii_case(url.scheme())) + } + + fn runtime_flags(&self, mut flags: Flags) -> Flags { + if !self.ignore_unsupported_config { + return flags; + } + + if !self.smoltcp_available { + flags.no_tun = false; + flags.use_smoltcp = false; + } + if !self.proxy_enabled { + flags.enable_exit_node = false; + } + if !self.magic_dns_enabled { + flags.accept_dns = false; + } + if !self.kcp_enabled { + flags.enable_kcp_proxy = false; + flags.disable_kcp_input = true; + flags.disable_relay_kcp = true; + flags.enable_relay_foreign_network_kcp = false; + } + if !self.quic_enabled { + flags.enable_quic_proxy = false; + flags.disable_quic_input = true; + flags.disable_relay_quic = true; + flags.enable_relay_foreign_network_quic = false; + } + if !self.udp_broadcast_enabled { + flags.enable_udp_broadcast_relay = false; + } + if !self.upnp_enabled { + flags.disable_upnp = true; + } + if !self.tcp_hole_punching_enabled { + flags.disable_tcp_hole_punching = true; + } + if CompressionAlgoPb::try_from(flags.data_compress_algo) + .ok() + .and_then(|algorithm| CompressorAlgo::try_from(algorithm).ok()) + .is_some_and(|algorithm| !algorithm.is_available()) + { + flags.data_compress_algo = CompressionAlgoPb::None as i32; + } + + if flags + .encryption_algorithm + .parse::() + .is_ok_and(|algorithm| !algorithm_is_available(algorithm)) + && algorithm_is_available(EncryptionAlgorithm::AesGcm) + { + flags.encryption_algorithm = EncryptionAlgorithm::AesGcm.to_string(); + } + + flags + } +} + +impl CoreInstanceConfig { + /// Normalizes the complete shared TOML model using OS-independent defaults. + /// + /// A Host may still project runtime facts such as a fallback hostname or + /// platform capability after parsing, but it does not need another network + /// configuration schema. + pub fn from_toml(config: &TomlConfig) -> anyhow::Result { + Self::from_toml_with_host(config, &CoreInstanceHostConfig::default()) + } + + /// Normalizes TOML with explicit Host facts and policy. + pub fn from_toml_with_host( + config: &TomlConfig, + host: &CoreInstanceHostConfig, + ) -> anyhow::Result { + let flags = host.runtime_flags(config.get_flags()); + let instance_id = config.get_id(); + let identity: crate::config::NetworkIdentity = config.get_network_identity().into(); + let managed_credentials = config.get_managed_credentials(); + if !managed_credentials.is_empty() && identity.network_secret.is_none() { + anyhow::bail!( + "only admin nodes with a network_secret can configure managed credentials" + ); + } + let network_name = identity.network_name.clone(); + let socket_context = SocketContext::default() + .with_socket_mark(flags.socket_mark) + .with_netns(config.get_netns().map(NetNamespace::new)); + let hostname = match config.get_hostname() { + hostname if !hostname.is_empty() => hostname, + _ => host.hostname_fallback.clone().unwrap_or_default(), + }; + let acl = config.get_acl(); + let peers = config + .get_peers() + .into_iter() + .filter(|peer| host.accepts_runtime_url(&peer.uri)) + .collect::>(); + let proxy_networks = if host.ignore_unsupported_config && !host.proxy_enabled { + Vec::new() + } else { + config.get_proxy_cidrs() + }; + + let peer_snapshot = + crate::config::peers::PeerRuntimeSnapshot::from_host_input(PeerRuntimeSnapshotInput { + node: NodeConfig { + peer_id: None, + instance_id: Some(*instance_id.as_bytes()), + hostname: (!hostname.is_empty()).then_some(hostname), + network_name: network_name.clone(), + }, + routes: RouteConfig { + ipv4: config.get_ipv4().map(|value| IpPrefix { + address: value.address().into(), + prefix_len: value.network_length(), + }), + ipv6: config.get_ipv6().map(|value| IpPrefix { + address: value.address().into(), + prefix_len: value.network_length(), + }), + proxy_networks: proxy_networks + .into_iter() + .map(|proxy| ProxyNetworkConfig { + real: IpPrefix { + address: proxy.cidr.first_address().into(), + prefix_len: proxy.cidr.network_length(), + }, + mapped: proxy.mapped_cidr.map(|mapped| IpPrefix { + address: mapped.first_address().into(), + prefix_len: mapped.network_length(), + }), + }) + .collect(), + ..Default::default() + }, + network_identity: identity, + stun_info: Default::default(), + flags: flags.clone(), + secure_mode: config.get_secure_mode(), + host_routing: host.host_routing, + acl: acl.clone(), + easytier_version: host.easytier_version.clone(), + pinned_peers: peers + .iter() + .cloned() + .map(|peer| (peer.uri, peer.peer_public_key)) + .collect(), + ospf_update_my_foreign_network_interval_sec: + OSPF_UPDATE_MY_FOREIGN_NETWORK_INTERVAL_SEC, + max_direct_conns_per_peer_in_foreign_network: + MAX_DIRECT_CONNS_PER_PEER_IN_FOREIGN_NETWORK, + hmac_secret_digest: false, + }); + let peer = PortablePeerManagerConfig { + snapshot: peer_snapshot, + route_algo: RouteAlgoType::Ospf, + exit_nodes: if host.ignore_unsupported_config && !host.proxy_enabled { + Vec::new() + } else { + config.get_exit_nodes() + }, + foreign_context_default_flags: host.runtime_flags(TomlConfig::default().get_flags()), + }; + + let tcp_bind = TcpBindOptions::default().with_context(socket_context.clone()); + let udp_bind = UdpBindOptions::direct_connect().with_context(socket_context.clone()); + let listeners = Some(ListenerRuntimeConfig::new( + config + .get_listener_uris() + .into_iter() + .filter(|url| host.accepts_runtime_url(url)) + .collect(), + flags.enable_ipv6, + socket_context.clone(), + )); + let socks5_bind = (!host.ignore_unsupported_config || host.gateway_enabled) + .then(|| config.get_socks5_portal()) + .flatten() + .map(|url| { + let host = url + .host_str() + .ok_or_else(|| anyhow::anyhow!("SOCKS5 portal host is missing"))?; + let port = url + .port() + .ok_or_else(|| anyhow::anyhow!("SOCKS5 portal port is missing"))?; + format!("{host}:{port}") + .parse() + .map_err(|error| anyhow::anyhow!("invalid SOCKS5 portal address: {error}")) + }) + .transpose()?; + let runtime = CoreRuntimeConfig { + acl: AclRuleConfig { + acl, + tcp_whitelist: config.get_tcp_whitelist(), + udp_whitelist: config.get_udp_whitelist(), + whitelist_priority: None, + }, + dhcp_ipv4: config.get_dhcp(), + gateway: GatewayRuntimeConfig { + socks5_bind, + port_forwards: if host.ignore_unsupported_config && !host.gateway_enabled { + Vec::new() + } else { + config.get_port_forwards() + }, + }, + manual_routes: config + .get_routes() + .map(|routes| routes.into_iter().collect::>()), + proxy: ProxyRuntimeConfig { + enable_exit_node: flags.enable_exit_node || host.force_exit_node, + no_tun: flags.no_tun, + forward_by_system: flags.proxy_forward_by_system, + force_smoltcp: host.smoltcp_available + && (flags.use_smoltcp || flags.no_tun || host.requires_smoltcp), + icmp_failure_is_fatal: host.icmp_failure_is_fatal, + udp_response_ipv4_mtu: 1280, + }, + public_ipv6_auto: config.get_ipv6_public_addr_auto() + && (!host.ignore_unsupported_config || host.public_ipv6_provider_supported), + public_ipv6_provider: PublicIpv6ProviderConfig { + provider_enabled: config.get_ipv6_public_addr_provider() + && (!host.ignore_unsupported_config || host.public_ipv6_provider_supported), + configured_prefix: (!host.ignore_unsupported_config + || host.public_ipv6_provider_supported) + .then(|| config.get_ipv6_public_addr_prefix()) + .flatten(), + provider_supported: host.public_ipv6_provider_supported, + }, + }; + let stun_servers = config.get_stun_servers(); + + Ok(Self { + instance_name: config.get_inst_name(), + peer, + managed_credentials, + vpn_portal: (!host.ignore_unsupported_config || host.vpn_portal_enabled) + .then(|| config.get_vpn_portal_config()) + .flatten() + .filter(|config| config.enabled != Some(false)) + .map(|config| PortalRuntimeConfig { + clients: config + .clients + .into_iter() + .map(|client| PortalClientConfig { + name: client.name, + virtual_ip: client.virtual_ip, + groups: client.groups, + }) + .collect(), + }), + connectivity: CoreConnectivityConfig { + initial_peers: peers.into_iter().map(|peer| peer.uri).collect(), + listeners, + runtime, + startup_plan: super::CoreInstanceStartupPlan { + gateway: host.gateway_enabled, + packet_proxy: host.proxy_enabled, + connectivity: host.connectivity, + }, + stun: StunServerConfig { + udp_servers: stun_servers + .clone() + .unwrap_or_else(|| StunServerConfig::default().udp_servers), + tcp_servers: config + .get_tcp_stun_servers() + .or_else(|| stun_servers.clone()) + .unwrap_or_else(|| StunServerConfig::default().tcp_servers), + udp_v6_servers: config + .get_stun_servers_v6() + .or_else(|| stun_servers.as_ref().map(|_| Vec::new())) + .unwrap_or_else(|| StunServerConfig::default().udp_v6_servers), + }, + endpoint_discovery: ManualEndpointDiscoveryConfig { + user_agent: format!("easytier/{}", host.easytier_version), + network_name: network_name.clone(), + http_tcp_bind: tcp_bind.clone(), + dns_record_context: socket_context, + srv_protocols: host.endpoint_protocols.clone(), + ..Default::default() + }, + manual: ManualConnectorOptions { + bind_device: flags.bind_device, + allow_interface_bind: host.allow_interface_bind, + tcp_bind: tcp_bind.clone(), + udp_bind: udp_bind.clone(), + ..Default::default() + }, + direct: DirectConnectorOptions { + default_protocol: flags.default_protocol, + enable_ipv6: flags.enable_ipv6, + allow_public_server: true, + bind_device: flags.bind_device, + allow_interface_bind: host.allow_interface_bind, + tcp_bind, + udp_bind, + testing: false, + }, + }, + }) + } +} + +#[cfg(test)] +mod tests { + use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; + + use super::*; + + #[test] + fn tcp_stun_servers_follow_toml_override_rules() { + let fallback = TomlConfig::new_from_str( + r#" +stun_servers = ["fallback.example.com:3478"] +"#, + ) + .unwrap(); + let normalized = CoreInstanceConfig::from_toml(&fallback).unwrap(); + assert_eq!( + normalized.connectivity.stun.tcp_servers, + ["fallback.example.com:3478"] + ); + + let overridden = TomlConfig::new_from_str( + r#" +stun_servers = ["fallback.example.com:3478"] +tcp_stun_servers = ["tcp.example.com:3478"] +"#, + ) + .unwrap(); + let normalized = CoreInstanceConfig::from_toml(&overridden).unwrap(); + assert_eq!( + normalized.connectivity.stun.tcp_servers, + ["tcp.example.com:3478"] + ); + + let disabled = TomlConfig::new_from_str( + r#" +stun_servers = ["fallback.example.com:3478"] +tcp_stun_servers = [] +"#, + ) + .unwrap(); + let normalized = CoreInstanceConfig::from_toml(&disabled).unwrap(); + assert!(normalized.connectivity.stun.tcp_servers.is_empty()); + } + + #[test] + fn custom_udp_stun_servers_disable_default_ipv6_servers() { + let config = TomlConfig::new_from_str( + r#" +stun_servers = ["custom.example.com:3478"] +"#, + ) + .unwrap(); + let normalized = CoreInstanceConfig::from_toml(&config).unwrap(); + assert!(normalized.connectivity.stun.udp_v6_servers.is_empty()); + + let config = TomlConfig::new_from_str( + r#" +stun_servers = ["custom.example.com:3478"] +stun_servers_v6 = ["custom-v6.example.com:3478"] +"#, + ) + .unwrap(); + let normalized = CoreInstanceConfig::from_toml(&config).unwrap(); + assert_eq!( + normalized.connectivity.stun.udp_v6_servers, + ["custom-v6.example.com:3478"] + ); + } + + #[test] + fn credential_nodes_cannot_declare_managed_credentials() { + let config = TomlConfig::default(); + config.set_network_identity(crate::config::toml::NetworkIdentity::new_credential( + "credential-network".to_owned(), + )); + config.set_managed_credentials(vec![crate::config::toml::ManagedCredentialConfig { + credential_id: "managed".to_owned(), + credential_secret: BASE64_STANDARD.encode([1u8; 32]), + groups: Vec::new(), + allow_relay: false, + allowed_proxy_cidrs: Vec::new(), + expiry_unix: 2_000_000_000, + reusable: true, + }]); + + let error = CoreInstanceConfig::from_toml(&config).unwrap_err(); + assert!(error.to_string().contains("only admin nodes")); + } + + #[cfg(feature = "config-write")] + #[test] + fn explicit_stun_servers_survive_dump_reload() { + let assert_roundtrip = |config: TomlConfig| { + let before = CoreInstanceConfig::from_toml(&config) + .unwrap() + .connectivity + .stun; + let reloaded = TomlConfig::new_from_str(&config.dump()).unwrap(); + let after = CoreInstanceConfig::from_toml(&reloaded) + .unwrap() + .connectivity + .stun; + + assert_eq!(after, before); + }; + + let defaults = StunServerConfig::default(); + let config = TomlConfig::default(); + config.set_stun_servers(Some(defaults.udp_servers.clone())); + assert_roundtrip(config); + + let config = TomlConfig::default(); + config.set_stun_servers(Some(vec!["custom.example.com:3478".to_string()])); + config.set_tcp_stun_servers(Some(defaults.tcp_servers)); + config.set_stun_servers_v6(Some(defaults.udp_v6_servers)); + assert_roundtrip(config); + } + + #[test] + fn shared_toml_normalizes_instance_identity_and_connectivity() { + let config = TomlConfig::new_from_str( + r#" +instance_id = "018f4fb1-7a2c-7d1f-9d89-935b0ad7e135" +instance_name = "wasi-test" +hostname = "portable-host" +ipv4 = "10.144.0.2/24" +listeners = ["tcp://0.0.0.0:11010"] + +[[peer]] +uri = "tcp://127.0.0.1:11010" + +[network_identity] +network_name = "portable" +network_secret = "secret" + +[flags] +disable_p2p = true +"#, + ) + .unwrap(); + + let normalized = CoreInstanceConfig::from_toml(&config).unwrap(); + assert_eq!(normalized.instance_name, "wasi-test"); + assert_eq!( + normalized.peer.snapshot.runtime.core.node.instance_id, + Some(*config.get_id().as_bytes()) + ); + assert_eq!(normalized.peer.snapshot.runtime.core.node.peer_id, None); + assert_eq!( + normalized + .peer + .snapshot + .runtime + .core + .node + .hostname + .as_deref(), + Some("portable-host") + ); + assert_eq!( + normalized.peer.snapshot.runtime.core.node.network_name, + "portable" + ); + assert_eq!(normalized.connectivity.initial_peers.len(), 1); + assert_eq!( + normalized + .connectivity + .listeners + .as_ref() + .unwrap() + .urls + .len(), + 1 + ); + assert!(normalized.peer.snapshot.flags.disable_p2p); + } + + #[test] + fn host_config_supplies_only_platform_policy() { + let config = TomlConfig::default(); + let host = CoreInstanceHostConfig { + hostname_fallback: Some("host-fallback".to_owned()), + host_routing: HostRoutingPolicy { + local_exit_node_fallback: true, + }, + force_exit_node: true, + allow_interface_bind: false, + smoltcp_available: true, + requires_smoltcp: true, + icmp_failure_is_fatal: true, + public_ipv6_provider_supported: true, + gateway_enabled: false, + connectivity: CoreConnectivityMode::InboundOnly, + easytier_version: "host-version".to_owned(), + endpoint_protocols: vec!["host-protocol".to_owned()], + ..Default::default() + }; + + let normalized = CoreInstanceConfig::from_toml_with_host(&config, &host).unwrap(); + + assert_eq!( + normalized + .peer + .snapshot + .runtime + .core + .node + .hostname + .as_deref(), + Some("host-fallback") + ); + assert_eq!( + normalized.connectivity.startup_plan.connectivity, + CoreConnectivityMode::InboundOnly + ); + assert!( + normalized + .peer + .snapshot + .runtime + .host_routing + .local_exit_node_fallback + ); + assert_eq!(normalized.peer.snapshot.easytier_version, "host-version"); + assert!(normalized.connectivity.runtime.proxy.enable_exit_node); + assert!(normalized.connectivity.runtime.proxy.force_smoltcp); + assert!(normalized.connectivity.runtime.proxy.icmp_failure_is_fatal); + assert!( + normalized + .connectivity + .runtime + .public_ipv6_provider + .provider_supported + ); + assert!(!normalized.connectivity.startup_plan.gateway); + assert!(!normalized.connectivity.manual.allow_interface_bind); + assert!(!normalized.connectivity.direct.allow_interface_bind); + assert_eq!( + normalized.connectivity.endpoint_discovery.srv_protocols, + ["host-protocol"] + ); + } + + #[test] + fn ignored_capabilities_stay_in_toml_but_not_runtime_config() { + let config = TomlConfig::new_from_str( + r#" +listeners = ["tcp://127.0.0.1:11010", "quic://127.0.0.1:11011"] +proxy_network = [{ cidr = "10.20.0.0/16" }] + +[[peer]] +uri = "tcp://127.0.0.1:11010" + +[[peer]] +uri = "quic://127.0.0.1:11011" + +[flags] +enable_exit_node = true +enable_kcp_proxy = true +accept_dns = true +encryption_algorithm = "chacha20" +data_compress_algo = "Zstd" +"#, + ) + .unwrap(); + config.set_exit_nodes(vec!["10.144.144.2".parse().unwrap()]); + config.set_ipv6_public_addr_provider(true); + config.get_id(); + let before = config.dump(); + + let host = CoreInstanceHostConfig { + ignore_unsupported_config: true, + smoltcp_available: true, + proxy_enabled: false, + gateway_enabled: false, + public_ipv6_provider_supported: false, + magic_dns_enabled: false, + kcp_enabled: false, + quic_enabled: false, + endpoint_protocols: vec!["tcp".to_owned(), "udp".to_owned()], + ..Default::default() + }; + + let normalized = CoreInstanceConfig::from_toml_with_host(&config, &host).unwrap(); + + assert_eq!(config.dump(), before); + assert!(!normalized.connectivity.startup_plan.packet_proxy); + assert_eq!(normalized.connectivity.initial_peers.len(), 1); + assert_eq!( + normalized + .connectivity + .listeners + .as_ref() + .unwrap() + .urls + .len(), + 1 + ); + assert!( + normalized + .peer + .snapshot + .runtime + .core + .routes + .proxy_networks + .is_empty() + ); + assert!(normalized.peer.exit_nodes.is_empty()); + assert!(!normalized.connectivity.runtime.proxy.enable_exit_node); + assert!( + !normalized + .connectivity + .runtime + .public_ipv6_provider + .provider_enabled + ); + let flags = &normalized.peer.snapshot.flags; + assert!(!flags.enable_kcp_proxy); + assert!(flags.disable_kcp_input); + assert!(!flags.accept_dns); + let expected_encryption = if algorithm_is_available(EncryptionAlgorithm::ChaCha20) { + EncryptionAlgorithm::ChaCha20 + } else { + EncryptionAlgorithm::AesGcm + }; + assert_eq!(flags.encryption_algorithm, expected_encryption.to_string()); + assert_eq!( + flags.data_compress_algo, + if CompressorAlgo::ZstdDefault.is_available() { + CompressionAlgoPb::Zstd as i32 + } else { + CompressionAlgoPb::None as i32 + } + ); + } +} diff --git a/vendor/easytier/easytier-core/src/instance/data_plane_extension.rs b/vendor/easytier/easytier-core/src/instance/data_plane_extension.rs new file mode 100644 index 0000000..c956ef1 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/data_plane_extension.rs @@ -0,0 +1,46 @@ +use std::{net::SocketAddr, sync::Arc, time::Duration}; + +use crate::gateway::{ + DataPlaneError, DataPlaneSession, DataPlaneTcpListener, DataPlaneTcpStream, DataPlaneUdpSocket, +}; + +use super::{CoreInstance, CoreInstanceHost}; + +impl CoreInstance +where + H: CoreInstanceHost, +{ + pub fn data_plane_session(&self) -> Arc> { + self.data_plane_session.clone() + } + + pub async fn data_plane_tcp_connect( + &self, + dst_addr: SocketAddr, + timeout: Duration, + ) -> Result { + self.data_plane_runtime + .data_plane_tcp_connect(dst_addr, timeout) + .await + } + + pub async fn data_plane_tcp_bind( + &self, + local_port: u16, + timeout: Duration, + ) -> Result { + self.data_plane_runtime + .data_plane_tcp_bind(local_port, timeout) + .await + } + + pub async fn data_plane_udp_bind( + &self, + local_port: u16, + timeout: Duration, + ) -> Result { + self.data_plane_runtime + .data_plane_udp_bind(local_port, timeout) + .await + } +} diff --git a/vendor/easytier/easytier-core/src/instance/lifecycle.rs b/vendor/easytier/easytier-core/src/instance/lifecycle.rs new file mode 100644 index 0000000..18139b3 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/lifecycle.rs @@ -0,0 +1,276 @@ +//! Serial start/stop orchestration for `CoreInstance`. +//! +//! Each runtime Module owns its internal resources. `CoreInstance` only +//! chooses their composition order and provides one outer cancellation and +//! cleanup path. + +use std::sync::{Arc, Weak}; + +#[cfg(feature = "dhcp-ipv4")] +use crate::gateway::dhcp::{DhcpIpv4Host, DhcpIpv4RouteSource}; + +use super::{CoreInstance, CoreInstanceHost, CoreInstanceState}; + +struct RecoveryGuard +where + F: FnOnce(), +{ + recovery: Option, +} + +impl RecoveryGuard +where + F: FnOnce(), +{ + fn new(recovery: F) -> Self { + Self { + recovery: Some(recovery), + } + } + + fn disarm(&mut self) { + self.recovery.take(); + } +} + +impl Drop for RecoveryGuard +where + F: FnOnce(), +{ + fn drop(&mut self) { + if let Some(recovery) = self.recovery.take() { + recovery(); + } + } +} + +impl CoreInstance +where + H: CoreInstanceHost, +{ + fn recovery_guard(self: &Arc) -> RecoveryGuard> { + let weak: Weak = Arc::downgrade(self); + RecoveryGuard::new(move || { + if let Some(instance) = weak.upgrade() { + tokio::spawn(async move { + instance.stop().await; + }); + } + }) + } + + async fn start_listener(&self) -> anyhow::Result<()> { + match &self.listener { + Some(listener) => listener.start().await, + None => Ok(()), + } + } + + #[cfg(feature = "dhcp-ipv4")] + async fn start_dhcp_ipv4(&self, host: Option>) -> anyhow::Result<()> { + if !self.runtime_config.snapshot().services.dhcp_ipv4 { + return Ok(()); + } + let host = host.ok_or_else(|| { + anyhow::anyhow!("DHCP IPv4 is enabled but no host adapter was provided") + })?; + let route_source: Arc = self.peer_manager.clone(); + self.dhcp_ipv4 + .start(route_source, self.runtime_config.clone(), host) + .await; + Ok(()) + } + + #[cfg(feature = "proxy-packet")] + async fn start_packet_proxy(&self) -> anyhow::Result<()> { + let config = self.runtime_config.snapshot(); + let has_proxy_networks = !config.peer.runtime.core.routes.proxy_networks.is_empty(); + if config.services.proxy.should_start(has_proxy_networks) { + self.packet_proxy + .start() + .await + .map_err(anyhow::Error::new)?; + } + Ok(()) + } + + async fn start_components(&self) -> anyhow::Result<()> { + #[cfg(feature = "public-ipv6-provider")] + self.public_ipv6_provider.validate_before_start().await?; + self.peer_manager + .get_route() + .set_route_cost_fn(self.peer_center.get_cost_calculator()) + .await; + + self.start_listener().await?; + let packet_receiver = self + .packet_receiver + .lock() + .await + .take() + .ok_or_else(|| anyhow::anyhow!("packet egress is one-shot and already started"))?; + self.packet_egress.start(packet_receiver).await?; + self.peer_manager.run().await.map_err(anyhow::Error::from)?; + if let Some(direct) = &self.direct { + direct.run(); + } + #[cfg(feature = "tcp-hole-punch")] + if let Some(tcp_hole_punch) = &self.tcp_hole_punch { + tcp_hole_punch.run(); + } + if let Some(manual) = &self.manual { + manual.start(); + } + #[cfg(feature = "public-ipv6-provider")] + self.public_ipv6_provider.start().await; + + let dhcp_host = self.instance_runtime.prepare(self.packet_plane()).await?; + #[cfg(feature = "dhcp-ipv4")] + self.start_dhcp_ipv4(dhcp_host).await?; + #[cfg(not(feature = "dhcp-ipv4"))] + let _ = dhcp_host; + #[cfg(feature = "wrapped-transport")] + if let Some(wrapped_transport) = &self.wrapped_transport { + wrapped_transport.start().await?; + } + #[cfg(feature = "proxy-packet")] + if self.startup_plan.packet_proxy { + self.start_packet_proxy().await?; + } + if let Some(udp_hole_punch) = &self.udp_hole_punch { + udp_hole_punch.start().await?; + } + self.peer_center.init().await; + #[cfg(feature = "proxy-cidr-monitor")] + self.proxy_cidr_monitor + .start(&self.peer_manager, self.runtime_config.clone()) + .await; + #[cfg(feature = "vpn-portal")] + self.vpn_portal.start().await?; + #[cfg(feature = "proxy-smoltcp-stack")] + self.data_plane_runtime.start_runtime().await?; + #[cfg(feature = "proxy-smoltcp-stack")] + self.data_plane_session + .start() + .map_err(anyhow::Error::new)?; + #[cfg(feature = "proxy-smoltcp-stack")] + if self.startup_plan.gateway { + self.socks5_adapter.start().await?; + self.port_forward_adapter.start().await?; + } + Ok(()) + } + + async fn stop_components(&self) { + if !self.peer_manager.withdraw_routes_before_stop().await { + tracing::warn!( + instance = %self.instance_name, + "not every direct route session acknowledged the shutdown withdrawal" + ); + } + + #[cfg(feature = "vpn-portal")] + self.vpn_portal.stop().await; + #[cfg(feature = "public-ipv6-provider")] + self.public_ipv6_provider.stop().await; + #[cfg(feature = "dhcp-ipv4")] + self.dhcp_ipv4.stop().await; + #[cfg(feature = "proxy-cidr-monitor")] + self.proxy_cidr_monitor.stop().await; + if let Some(listener) = &self.listener { + listener.stop().await; + } + if let Some(udp_hole_punch) = &self.udp_hole_punch { + udp_hole_punch.stop().await; + } + #[cfg(feature = "proxy-smoltcp-stack")] + self.port_forward_adapter.stop().await; + #[cfg(feature = "proxy-smoltcp-stack")] + self.socks5_adapter.stop().await; + #[cfg(feature = "proxy-smoltcp-stack")] + self.data_plane_session.stop(); + #[cfg(feature = "proxy-smoltcp-stack")] + self.data_plane_runtime.stop_runtime().await; + #[cfg(feature = "wrapped-transport")] + if let Some(wrapped_transport) = &self.wrapped_transport { + wrapped_transport.stop().await; + } + #[cfg(feature = "proxy-packet")] + self.packet_proxy.stop().await; + if let Some(manual) = &self.manual { + manual.stop().await; + } + #[cfg(feature = "tcp-hole-punch")] + if let Some(tcp_hole_punch) = &self.tcp_hole_punch { + tcp_hole_punch.stop().await; + } + if let Some(direct) = &self.direct { + direct.stop().await; + } + self.peer_center.stop().await; + + // Host packet tasks can still call the packet plane, so stop them + // before clearing PeerManager resources. + self.instance_runtime.shutdown().await; + self.peer_manager.clear_resources().await; + self.packet_egress.stop().await; + } + + /// Starts the complete instance through one serial composition path. + pub async fn start(self: &Arc) -> anyhow::Result<()> { + let _operation = self.operation.lock().await; + let state = self.state(); + if state != CoreInstanceState::Created { + anyhow::bail!("core instance cannot start from state {state:?}"); + } + + self.latest_error.write().take(); + self.set_state(CoreInstanceState::Starting); + let mut recovery = self.recovery_guard(); + let result = tokio::select! { + _ = self.cancel.cancelled() => { + Err(anyhow::anyhow!("core instance start cancelled")) + } + result = self.start_components() => result, + }; + let result = match result { + Ok(()) => { + self.set_state(CoreInstanceState::Running); + if self.cancel.is_cancelled() { + Err(anyhow::anyhow!("core instance start cancelled")) + } else { + Ok(()) + } + } + Err(error) => Err(error), + }; + + if let Err(error) = result { + self.latest_error.write().replace(format!("{error:#}")); + self.cancel.cancel(); + self.set_state(CoreInstanceState::Stopping); + self.stop_components().await; + self.set_state(CoreInstanceState::Stopped); + recovery.disarm(); + return Err(error); + } + + recovery.disarm(); + Ok(()) + } + + pub async fn stop(self: &Arc) { + self.cancel.cancel(); + let mut recovery = self.recovery_guard(); + let _operation = self.operation.lock().await; + if self.state() == CoreInstanceState::Stopped { + recovery.disarm(); + return; + } + + self.set_state(CoreInstanceState::Stopping); + self.stop_components().await; + self.set_state(CoreInstanceState::Stopped); + recovery.disarm(); + } +} diff --git a/vendor/easytier/easytier-core/src/instance/management.rs b/vendor/easytier/easytier-core/src/instance/management.rs new file mode 100644 index 0000000..b8ec79e --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/management.rs @@ -0,0 +1,246 @@ +use std::{any::Any, net::IpAddr, sync::Arc}; + +use url::Url; + +use crate::{ + config::peers::AclWhitelistSnapshot, + connectivity::manual::ManualConnectorSnapshot, + foundation::stats::MetricSnapshot, + peers::{ + conn::peer_conn::PeerConnId, + credential_manager::{ + CredentialCreateOptions, CredentialInfo, CredentialUpsertOptions, GeneratedCredential, + }, + peer_manager::PeerSnapshot, + }, +}; + +use super::{CoreInstance, CoreInstanceHost, CorePacketPlane}; + +impl CoreInstance +where + H: CoreInstanceHost, +{ + pub fn instance_id(&self) -> uuid::Uuid { + self.peer_manager.instance_id() + } + + pub fn instance_name(&self) -> &str { + &self.instance_name + } + + pub fn add_connector(&self, url: Url) -> anyhow::Result<()> { + self.manual + .as_ref() + .ok_or_else(|| anyhow::anyhow!("inbound-only connectivity has no outbound connectors"))? + .add_connector(url) + } + + pub fn remove_connector(&self, url: &Url) -> bool { + self.manual + .as_ref() + .is_some_and(|manual| manual.remove_connector(url)) + } + + pub fn clear_connectors(&self) { + if let Some(manual) = &self.manual { + manual.clear_connectors(); + } + } + + pub fn list_connectors(&self) -> Vec { + self.manual + .as_ref() + .map(|manual| manual.list_connectors()) + .unwrap_or_default() + } + + pub fn running_listeners(&self) -> Vec { + self.running_listeners.running_listeners() + } + + pub fn peer_id(&self) -> crate::config::PeerId { + self.peer_manager.my_peer_id() + } + + pub fn packet_plane(&self) -> Arc { + self.packet_plane.clone() + } + + /// Recovers the concrete Host runtime Adapter for host-specific integration. + pub fn runtime_host(&self) -> Option<&T> { + let runtime_host: &dyn Any = self.instance_runtime.as_ref(); + runtime_host.downcast_ref() + } + + pub fn attach_tun_fd(&self, fd: i32) -> anyhow::Result<()> { + self.instance_runtime.attach_tun_fd(fd) + } + + pub fn latest_error(&self) -> Option { + self.latest_error.read().clone() + } + + pub fn is_ready(&self) -> bool { + self.state() == super::CoreInstanceState::Running + } + + pub fn management_events(&self) -> Vec { + self.instance_runtime.management_events() + } + + pub fn global_peer_map_snapshot(&self) -> crate::proto::peer_rpc::GetGlobalPeerMapResponse { + self.peer_center.global_peer_map_snapshot() + } + + pub async fn peer_snapshots(&self) -> Vec { + self.peer_manager.list_peer_snapshots().await + } + + pub async fn node_snapshot(&self) -> crate::peers::peer_manager::NodeSnapshot { + let mut snapshot = self + .peer_manager + .node_snapshot(self.running_listeners()) + .await; + if let Some(direct) = &self.direct { + snapshot.ip_list = direct + .local_address_observations_with_stun(&snapshot.stun_info) + .await; + } + snapshot + } + + pub async fn route_snapshots(&self) -> Vec { + self.peer_manager.list_route_snapshots().await + } + + pub async fn dump_route(&self) -> String { + self.peer_manager.dump_route().await + } + + pub async fn local_public_ipv6_info( + &self, + ) -> crate::proto::core_peer::peer::ListPublicIpv6InfoResponse { + self.peer_manager.local_public_ipv6_info().await + } + + pub async fn foreign_network_route_infos( + &self, + ) -> crate::proto::peer_rpc::RouteForeignNetworkInfos { + self.peer_manager.foreign_network_route_infos().await + } + + pub async fn foreign_network_snapshots( + &self, + include_trusted_keys: bool, + ) -> std::collections::HashMap + { + self.peer_manager + .list_foreign_network_infos(include_trusted_keys) + .await + } + + pub async fn foreign_network_route_summary( + &self, + ) -> crate::proto::peer_rpc::RouteForeignNetworkSummary { + self.peer_manager.foreign_network_route_summary().await + } + + pub fn acl_stats(&self) -> crate::proto::acl::AclStats { + self.peer_manager.acl_stats() + } + + pub fn acl_whitelist_snapshot(&self) -> AclWhitelistSnapshot { + let config = self.runtime_config.snapshot(); + AclWhitelistSnapshot::from(&config.services.acl) + } + + pub fn generate_credential( + &self, + options: CredentialCreateOptions, + ) -> anyhow::Result { + if !self.peer_manager.can_manage_credentials() { + anyhow::bail!("only admin nodes (with network_secret) can generate credentials"); + } + if options.ttl.is_zero() { + anyhow::bail!("ttl_seconds must be positive"); + } + let generated = self + .peer_manager + .credential_manager() + .generate_credential_with_options(options) + .map_err(anyhow::Error::msg)?; + self.peer_manager.notify_credential_changed(); + Ok(generated) + } + + pub fn revoke_credential(&self, credential_id: &str) -> anyhow::Result { + if !self.peer_manager.can_manage_credentials() { + anyhow::bail!("only admin nodes (with network_secret) can revoke credentials"); + } + let revoked = self + .peer_manager + .credential_manager() + .revoke_credential(credential_id) + .map_err(anyhow::Error::msg)?; + if revoked { + self.peer_manager.notify_credential_changed(); + } + Ok(revoked) + } + + pub fn upsert_credential(&self, options: CredentialUpsertOptions) -> anyhow::Result { + if !self.peer_manager.can_manage_credentials() { + anyhow::bail!("only admin nodes (with network_secret) can import credentials"); + } + let changed = self + .peer_manager + .credential_manager() + .upsert_credential(options) + .map_err(anyhow::Error::msg)?; + if changed { + self.peer_manager.notify_credential_changed(); + } + Ok(changed) + } + + pub fn credential_snapshots(&self) -> Vec { + self.peer_manager.credential_manager().list_credentials() + } + + #[cfg(feature = "web-client")] + pub(crate) fn credential_manager( + &self, + ) -> Arc { + self.peer_manager.credential_manager() + } + + #[cfg(feature = "web-client")] + pub(crate) fn notify_credential_changed(&self) { + self.peer_manager.notify_credential_changed(); + } + + pub fn metric_snapshots(&self) -> Vec { + self.peer_manager.stats_manager().get_all_metrics() + } + + pub fn prometheus_metrics(&self) -> String { + self.peer_manager.stats_manager().export_prometheus() + } + + pub async fn close_peer_conn( + &self, + peer_id: crate::config::PeerId, + conn_id: &PeerConnId, + ) -> Result<(), crate::peers::error::Error> { + self.peer_manager.close_peer_conn(peer_id, conn_id).await + } + + pub async fn update_exit_nodes(&self, exit_nodes: Vec) { + self.peer_manager.update_exit_nodes(exit_nodes).await; + } + + pub async fn refresh_acl_groups(&self) { + self.peer_manager.get_route().refresh_acl_groups().await; + } +} diff --git a/vendor/easytier/easytier-core/src/instance/management_extension.rs b/vendor/easytier/easytier-core/src/instance/management_extension.rs new file mode 100644 index 0000000..b1144a1 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/management_extension.rs @@ -0,0 +1,14 @@ +use super::{CoreInstance, CoreInstanceHost, CoreInstanceHostConfig}; + +impl CoreInstance +where + H: CoreInstanceHost, +{ + pub fn toml_config(&self) -> Option { + self.management.toml_config() + } + + pub(crate) fn host_config(&self) -> &CoreInstanceHostConfig { + self.management.host_config() + } +} diff --git a/vendor/easytier/easytier-core/src/instance/management_state.rs b/vendor/easytier/easytier-core/src/instance/management_state.rs new file mode 100644 index 0000000..eac1377 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/management_state.rs @@ -0,0 +1,34 @@ +use crate::{config::toml::TomlConfig, instance::CoreInstanceHostConfig}; + +pub(super) struct ManagementState { + #[cfg(feature = "web-client")] + toml_config: Option, + #[cfg(feature = "web-client")] + host_config: CoreInstanceHostConfig, +} + +impl ManagementState { + pub(super) fn new( + toml_config: Option, + host_config: CoreInstanceHostConfig, + ) -> Self { + #[cfg(not(feature = "web-client"))] + let _ = (toml_config, host_config); + Self { + #[cfg(feature = "web-client")] + toml_config, + #[cfg(feature = "web-client")] + host_config, + } + } + + #[cfg(feature = "web-client")] + pub(super) fn toml_config(&self) -> Option { + self.toml_config.clone() + } + + #[cfg(feature = "web-client")] + pub(super) fn host_config(&self) -> &CoreInstanceHostConfig { + &self.host_config + } +} diff --git a/vendor/easytier/easytier-core/src/instance/manager.rs b/vendor/easytier/easytier-core/src/instance/manager.rs new file mode 100644 index 0000000..3351d60 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/manager.rs @@ -0,0 +1,758 @@ +//! Canonical process-level ownership and lifecycle for EasyTier instances. + +use std::{ + collections::{HashMap, hash_map::Entry}, + error::Error, + fmt, + path::PathBuf, + sync::{ + Arc, Mutex, + atomic::{AtomicUsize, Ordering}, + }, +}; + +use dashmap::DashMap; +use uuid::Uuid; + +use crate::config::toml::TomlConfig; +use crate::instance::{CoreInstance, CoreInstanceHost, CoreInstanceState}; +use crate::process_runtime::CoreProcessRuntime; +#[cfg(feature = "web-client")] +use crate::{ + config::toml::{ConfigLoader as _, ConfigSource}, + management::network_instance_running_info, +}; +#[cfg(feature = "web-client")] +use easytier_proto::api::manage::NetworkInstanceRunningInfo; + +/// Stable identity required by the instance collection. +pub trait ManagedInstance: Send + Sync + 'static { + fn instance_id(&self) -> Uuid; +} + +impl ManagedInstance for CoreInstance +where + H: CoreInstanceHost, +{ + fn instance_id(&self) -> Uuid { + self.instance_id() + } +} + +/// Host-specific construction seam for one complete instance record. +pub trait InstanceFactory: Send + Sync + 'static { + type Instance: ManagedInstance; + type CreateContext; + type Error; + + fn create( + &self, + config: TomlConfig, + context: Self::CreateContext, + ) -> Result, Self::Error>; +} + +/// Error returned while constructing or registering an instance. +#[derive(Debug)] +pub enum InstanceCreateError { + Factory(E), + AlreadyExists { instance_id: Uuid }, +} + +impl fmt::Display for InstanceCreateError +where + E: fmt::Display, +{ + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + Self::Factory(error) => write!(formatter, "failed to create instance: {error:#}"), + Self::AlreadyExists { instance_id } => { + write!(formatter, "instance {instance_id} already exists") + } + } + } +} + +impl Error for InstanceCreateError where E: fmt::Debug + fmt::Display {} + +/// Supplies the process runtime used by every instance created by this +/// factory. +pub trait ProcessRuntimeProvider: InstanceFactory { + fn process_runtime(&self) -> Arc; +} + +#[derive(Clone, Copy, Default)] +pub struct ConfigFilePermission(u8); + +impl ConfigFilePermission { + pub const READ_ONLY: u8 = 1 << 0; + pub const NO_DELETE: u8 = 1 << 1; + + pub fn with_flag(self, flag: u8) -> Self { + Self(self.0 | flag) + } + + pub fn remove_flag(self, flag: u8) -> Self { + Self(self.0 & !flag) + } + + pub fn has_flag(&self, flag: u8) -> bool { + self.0 & flag != 0 + } +} + +impl From for ConfigFilePermission { + fn from(value: u8) -> Self { + Self(value) + } +} + +impl From for ConfigFilePermission { + fn from(value: u32) -> Self { + Self(value as u8) + } +} + +impl From for u8 { + fn from(value: ConfigFilePermission) -> Self { + value.0 + } +} + +impl From for u32 { + fn from(value: ConfigFilePermission) -> Self { + value.0 as u32 + } +} + +impl fmt::Debug for ConfigFilePermission { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + let access = if self.has_flag(Self::READ_ONLY) { + "READ_ONLY" + } else { + "EDITABLE" + }; + let deletion = if self.has_flag(Self::NO_DELETE) { + "NO_DELETE" + } else { + "DELETABLE" + }; + write!(formatter, "{access}|{deletion}") + } +} + +#[derive(Debug, Clone)] +pub struct ConfigFileControl { + pub path: Option, + pub permission: ConfigFilePermission, +} + +impl ConfigFileControl { + pub const STATIC_CONFIG: Self = Self { + path: None, + permission: ConfigFilePermission( + ConfigFilePermission::READ_ONLY | ConfigFilePermission::NO_DELETE, + ), + }; + + pub fn new(path: Option, permission: ConfigFilePermission) -> Self { + Self { path, permission } + } + + pub fn is_read_only(&self) -> bool { + self.permission.has_flag(ConfigFilePermission::READ_ONLY) + } + + pub fn set_read_only(&mut self, read_only: bool) { + self.permission = if read_only { + self.permission.with_flag(ConfigFilePermission::READ_ONLY) + } else { + self.permission.remove_flag(ConfigFilePermission::READ_ONLY) + }; + } + + pub fn is_no_delete(&self) -> bool { + self.permission.has_flag(ConfigFilePermission::NO_DELETE) + } + + pub fn set_no_delete(&mut self, no_delete: bool) { + self.permission = if no_delete { + self.permission.with_flag(ConfigFilePermission::NO_DELETE) + } else { + self.permission.remove_flag(ConfigFilePermission::NO_DELETE) + }; + } + + pub fn is_deletable(&self) -> bool { + !self.is_no_delete() + } +} + +pub struct DaemonGuard { + guard: Option>, + notifier: Arc, +} + +impl Drop for DaemonGuard { + fn drop(&mut self) { + drop(self.guard.take()); + self.notifier.notify_one(); + } +} + +struct ActiveStopGuard { + active_stops: Arc, + notifier: Arc, +} + +#[derive(Default)] +struct InstanceStateChanges { + generation: AtomicUsize, + notify: tokio::sync::Notify, +} + +impl InstanceStateChanges { + fn generation(&self) -> usize { + self.generation.load(Ordering::Acquire) + } + + fn mark_changed(&self) { + self.generation.fetch_add(1, Ordering::AcqRel); + self.notify.notify_waiters(); + } + + async fn wait_for_change(&self, generation: usize) -> usize { + loop { + let notified = self.notify.notified(); + tokio::pin!(notified); + // Register the waiter before reading the generation: notify_waiters + // does not retain permits, so a change landing between the read + // and the await would otherwise be missed until the next change. + notified.as_mut().enable(); + let current = self.generation(); + if current != generation { + return current; + } + notified.await; + } + } +} + +impl Drop for ActiveStopGuard { + fn drop(&mut self) { + let previous = self.active_stops.fetch_sub(1, Ordering::AcqRel); + debug_assert!(previous > 0); + self.notifier.notify_one(); + } +} + +/// Owns all process-level Instance state and operations. +pub struct InstanceManager { + factory: F, + instances: Mutex>>, + config_controls: DashMap, + notifier: Arc, + config_dir: Option, + daemon_guard: Arc<()>, + mutation_lock: Arc>, + runtime_handle: Option, + active_stops: Arc, + instance_state_changes: Arc, +} + +impl InstanceManager { + pub fn new(factory: F, runtime_handle: Option) -> Self { + Self { + factory, + instances: Mutex::new(HashMap::new()), + config_controls: DashMap::new(), + notifier: Arc::new(tokio::sync::Notify::new()), + config_dir: None, + daemon_guard: Arc::new(()), + mutation_lock: Arc::new(tokio::sync::Mutex::new(())), + runtime_handle, + active_stops: Arc::new(AtomicUsize::new(0)), + instance_state_changes: Arc::new(InstanceStateChanges::default()), + } + } + + pub fn with_config_path(mut self, config_dir: Option) -> Self { + self.config_dir = config_dir; + self + } + + pub fn create( + &self, + config: TomlConfig, + context: F::CreateContext, + ) -> Result, InstanceCreateError> { + let instance = self + .factory + .create(config, context) + .map_err(InstanceCreateError::Factory)?; + let instance_id = instance.instance_id(); + let mut instances = self.instances.lock().expect("instance map lock poisoned"); + + match instances.entry(instance_id) { + Entry::Vacant(entry) => { + entry.insert(instance.clone()); + Ok(instance) + } + Entry::Occupied(_) => Err(InstanceCreateError::AlreadyExists { instance_id }), + } + } + + pub(crate) fn get(&self, instance_id: Uuid) -> Option> { + self.instances + .lock() + .expect("instance map lock poisoned") + .get(&instance_id) + .cloned() + } + + pub(crate) fn list(&self) -> Vec> { + self.instances + .lock() + .expect("instance map lock poisoned") + .values() + .cloned() + .collect() + } + + pub(crate) fn remove(&self, instance_id: Uuid) -> Option> { + self.instances + .lock() + .expect("instance map lock poisoned") + .remove(&instance_id) + } + + pub fn config_control(&self, instance_id: Uuid) -> Option { + self.config_controls + .get(&instance_id) + .map(|control| control.clone()) + } + + pub fn mutation_lock(&self) -> Arc> { + self.mutation_lock.clone() + } + + pub fn config_dir(&self) -> Option<&PathBuf> { + self.config_dir.as_ref() + } + + pub fn register_daemon(&self) -> DaemonGuard { + DaemonGuard { + guard: Some(self.daemon_guard.clone()), + notifier: self.notifier.clone(), + } + } + + pub(crate) fn instance_state_generation(&self) -> usize { + self.instance_state_changes.generation() + } + + pub(crate) async fn wait_for_instance_state_change(&self, generation: usize) -> usize { + self.instance_state_changes + .wait_for_change(generation) + .await + } +} + +impl InstanceManager { + pub fn process_runtime(&self) -> Arc { + self.factory.process_runtime() + } +} + +impl InstanceManager +where + F: InstanceFactory, CreateContext = ()>, + F::Error: fmt::Debug + fmt::Display + Send + Sync + 'static, + H: CoreInstanceHost, +{ + pub fn run_network_instance( + &self, + config: TomlConfig, + control: ConfigFileControl, + ) -> anyhow::Result { + let runtime = self + .runtime_handle + .clone() + .or_else(|| tokio::runtime::Handle::try_current().ok()) + .ok_or_else(|| anyhow::anyhow!("tokio runtime not found, cannot start instance"))?; + let instance = self.create(config, ()).map_err(anyhow::Error::new)?; + let instance_id = instance.instance_id(); + self.config_controls.insert(instance_id, control); + let notifier = self.notifier.clone(); + let instance_state_changes = self.instance_state_changes.clone(); + runtime.spawn(async move { + if let Err(error) = instance.start().await { + tracing::error!(%error, %instance_id, "instance failed to start"); + } + instance_state_changes.mark_changed(); + notifier.notify_one(); + }); + Ok(instance_id) + } + + pub async fn delete_network_instances( + &self, + instance_ids: impl IntoIterator, + ) -> anyhow::Result> { + let runtime = self + .runtime_handle + .clone() + .or_else(|| tokio::runtime::Handle::try_current().ok()) + .ok_or_else(|| anyhow::anyhow!("tokio runtime not found, cannot stop instance"))?; + self.active_stops.fetch_add(1, Ordering::AcqRel); + let active_stop = ActiveStopGuard { + active_stops: self.active_stops.clone(), + notifier: self.notifier.clone(), + }; + let mut removed = Vec::new(); + for instance_id in instance_ids { + self.config_controls.remove(&instance_id); + if let Some(instance) = self.remove(instance_id) { + removed.push(instance); + } + } + if removed.is_empty() { + drop(active_stop); + return Ok(self.instance_ids()); + } + self.instance_state_changes.mark_changed(); + + runtime + .spawn(async move { + let _active_stop = active_stop; + for instance in removed { + instance.stop().await; + } + }) + .await + .map_err(|error| anyhow::anyhow!("instance stop task failed: {error}"))?; + Ok(self.instance_ids()) + } + + pub async fn retain_network_instances(&self, retained: &[Uuid]) -> anyhow::Result> { + let removed = self + .list() + .into_iter() + .map(|instance| instance.instance_id()) + .filter(|instance_id| !retained.contains(instance_id)) + .collect::>(); + self.delete_network_instances(removed).await + } + + pub fn instance_ids(&self) -> Vec { + self.list() + .into_iter() + .map(|instance| instance.instance_id()) + .collect() + } + + pub fn failed_instance_ids(&self) -> Vec { + self.list() + .into_iter() + .filter(|instance| { + instance.state() == CoreInstanceState::Stopped + && instance + .latest_error() + .is_some_and(|error| !error.trim().is_empty()) + }) + .map(|instance| instance.instance_id()) + .collect() + } + + pub fn instance(&self, instance_id: Uuid) -> Option>> { + self.get(instance_id) + } + + pub fn instances(&self) -> Vec>> { + self.list() + } + + pub fn attach_tun_fd(&self, instance_id: Uuid, fd: i32) -> anyhow::Result<()> { + self.get(instance_id) + .ok_or_else(|| anyhow::anyhow!("instance {instance_id} not found"))? + .attach_tun_fd(fd) + } + + pub fn data_plane_runtime_handle(&self, instance_id: &Uuid) -> Option { + self.instance(*instance_id)?; + self.runtime_handle + .clone() + .or_else(|| tokio::runtime::Handle::try_current().ok()) + } + + pub async fn wait(&self) { + loop { + let instance_running = self + .list() + .iter() + .any(|instance| instance.state() != crate::instance::CoreInstanceState::Stopped); + let daemon_running = Arc::strong_count(&self.daemon_guard) > 1; + let instance_stopping = self.active_stops.load(Ordering::Acquire) != 0; + if !instance_running && !instance_stopping && !daemon_running { + return; + } + self.notifier.notified().await; + } + } + + #[cfg(feature = "web-client")] + pub fn config(&self, instance_id: Uuid) -> Option { + self.get(instance_id) + .and_then(|instance| instance.toml_config()) + } + + #[cfg(feature = "web-client")] + pub fn config_source(&self, instance_id: Uuid) -> Option { + self.config(instance_id) + .map(|config| config.get_network_config_source()) + } + + #[cfg(feature = "web-client")] + pub async fn network_info(&self, instance_id: Uuid) -> Option { + let instance = self.get(instance_id)?; + network_instance_running_info(instance.as_ref()).await.ok() + } + + #[cfg(feature = "web-client")] + pub async fn collect_network_infos( + &self, + ) -> anyhow::Result> { + let mut result = std::collections::BTreeMap::new(); + for instance in self.list() { + result.insert( + instance.instance_id(), + network_instance_running_info(instance.as_ref()).await?, + ); + } + Ok(result) + } + + #[cfg(feature = "web-client")] + pub fn collect_network_infos_sync( + &self, + ) -> anyhow::Result> { + self.runtime_handle + .as_ref() + .ok_or_else(|| anyhow::anyhow!("InstanceManager runtime handle is unavailable"))? + .block_on(self.collect_network_infos()) + } + + #[cfg(feature = "proxy-smoltcp-stack")] + pub fn data_plane_session( + &self, + instance_id: &Uuid, + ) -> Option>> { + self.instance(*instance_id) + .map(|instance| instance.data_plane_session()) + } + + #[cfg(feature = "proxy-smoltcp-stack")] + pub async fn data_plane_tcp_connect( + &self, + instance_id: &Uuid, + dst_addr: std::net::SocketAddr, + timeout: std::time::Duration, + ) -> anyhow::Result { + Ok(self + .instance(*instance_id) + .ok_or_else(|| anyhow::anyhow!("instance {instance_id} not found"))? + .data_plane_tcp_connect(dst_addr, timeout) + .await?) + } + + #[cfg(feature = "proxy-smoltcp-stack")] + pub async fn data_plane_tcp_bind( + &self, + instance_id: &Uuid, + local_port: u16, + timeout: std::time::Duration, + ) -> anyhow::Result { + Ok(self + .instance(*instance_id) + .ok_or_else(|| anyhow::anyhow!("instance {instance_id} not found"))? + .data_plane_tcp_bind(local_port, timeout) + .await?) + } + + #[cfg(feature = "proxy-smoltcp-stack")] + pub async fn data_plane_udp_bind( + &self, + instance_id: &Uuid, + local_port: u16, + timeout: std::time::Duration, + ) -> anyhow::Result { + Ok(self + .instance(*instance_id) + .ok_or_else(|| anyhow::anyhow!("instance {instance_id} not found"))? + .data_plane_udp_bind(local_port, timeout) + .await?) + } +} + +#[cfg(test)] +mod instance_state_change_tests { + use super::InstanceStateChanges; + use std::{sync::Arc, time::Duration}; + + #[tokio::test] + async fn state_change_wait_observes_existing_and_future_changes() { + let changes = Arc::new(InstanceStateChanges::default()); + + let observed = changes.generation(); + changes.mark_changed(); + assert_eq!( + tokio::time::timeout(Duration::from_secs(1), changes.wait_for_change(observed)) + .await + .expect("an existing change must not be lost"), + 1 + ); + + let observed = changes.generation(); + let waiter_changes = changes.clone(); + let waiter = tokio::spawn(async move { waiter_changes.wait_for_change(observed).await }); + tokio::task::yield_now().await; + changes.mark_changed(); + assert_eq!( + tokio::time::timeout(Duration::from_secs(1), waiter) + .await + .expect("a future change must wake the waiter") + .unwrap(), + 2 + ); + } +} + +#[cfg(test)] +mod tests { + use std::{ + sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, + }, + thread, + }; + + use super::*; + struct TestFactory { + drops: Arc, + } + + #[derive(Debug)] + struct TestInstance { + id: Uuid, + drops: Arc, + } + + impl ManagedInstance for TestInstance { + fn instance_id(&self) -> Uuid { + self.id + } + } + + impl Drop for TestInstance { + fn drop(&mut self) { + self.drops.fetch_add(1, Ordering::SeqCst); + } + } + + impl InstanceFactory for TestFactory { + type Instance = TestInstance; + type CreateContext = (); + type Error = std::convert::Infallible; + + fn create( + &self, + config: TomlConfig, + (): Self::CreateContext, + ) -> Result, Self::Error> { + Ok(Arc::new(TestInstance { + id: config.get_id(), + drops: self.drops.clone(), + })) + } + } + + fn manager() -> (Arc>, Arc) { + let drops = Arc::new(AtomicUsize::new(0)); + ( + Arc::new(InstanceManager::new( + TestFactory { + drops: drops.clone(), + }, + None, + )), + drops, + ) + } + + fn config(instance_id: Uuid) -> TomlConfig { + let config = TomlConfig::default(); + config.set_id(instance_id); + config + } + + #[test] + fn duplicate_create_drops_losing_complete_record() { + let (manager, drops) = manager(); + let instance_id = Uuid::new_v4(); + let first = manager.create(config(instance_id), ()).unwrap(); + let error = manager.create(config(instance_id), ()).unwrap_err(); + + assert!(matches!( + error, + InstanceCreateError::AlreadyExists { + instance_id: duplicate + } if duplicate == instance_id + )); + assert_eq!(drops.load(Ordering::SeqCst), 1); + assert!(Arc::ptr_eq(&first, &manager.get(instance_id).unwrap())); + } + + #[test] + fn concurrent_duplicate_create_registers_exactly_one_instance() { + let (manager, drops) = manager(); + let instance_id = Uuid::new_v4(); + let workers = (0..2) + .map(|_| { + let manager = manager.clone(); + thread::spawn(move || manager.create(config(instance_id), ())) + }) + .collect::>(); + let results = workers + .into_iter() + .map(|worker| worker.join().unwrap()) + .collect::>(); + + assert_eq!(results.iter().filter(|result| result.is_ok()).count(), 1); + assert_eq!(results.iter().filter(|result| result.is_err()).count(), 1); + assert_eq!(drops.load(Ordering::SeqCst), 1); + assert_eq!(manager.list().len(), 1); + } + + #[test] + fn list_is_an_arc_snapshot_and_remove_returns_exact_stored_value() { + let (manager, drops) = manager(); + let first_id = Uuid::new_v4(); + let second_id = Uuid::new_v4(); + let first = manager.create(config(first_id), ()).unwrap(); + let second = manager.create(config(second_id), ()).unwrap(); + + let snapshot = manager.list(); + let removed = manager.remove(first_id).unwrap(); + + assert!(Arc::ptr_eq(&first, &removed)); + assert!(snapshot.iter().any(|item| Arc::ptr_eq(item, &removed))); + assert!(manager.get(first_id).is_none()); + assert!(Arc::ptr_eq(&second, &manager.get(second_id).unwrap())); + drop(removed); + drop(first); + assert_eq!(drops.load(Ordering::SeqCst), 0); + drop(snapshot); + assert_eq!(drops.load(Ordering::SeqCst), 1); + } +} diff --git a/vendor/easytier/easytier-core/src/instance/mod.rs b/vendor/easytier/easytier-core/src/instance/mod.rs new file mode 100644 index 0000000..00b299a --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/mod.rs @@ -0,0 +1,985 @@ +//! Lifecycle owner for the portable EasyTier runtime. + +mod build_capabilities; +mod config; +#[cfg(feature = "proxy-smoltcp-stack")] +mod data_plane_extension; +mod lifecycle; +mod management; +#[cfg(feature = "web-client")] +mod management_extension; +mod management_state; +pub mod manager; +mod packet_io; +mod packet_plane; +#[cfg(feature = "proxy-packet")] +mod packet_proxy_extension; +#[cfg(feature = "public-ipv6-provider")] +mod public_ipv6_extension; +#[cfg(feature = "vpn-portal")] +mod vpn_portal_extension; + +use std::sync::{ + Arc, + atomic::{AtomicU8, Ordering}, +}; + +use parking_lot::RwLock; +use serde::{Deserialize, Serialize}; +#[cfg(feature = "test-utils")] +use std::sync::atomic::AtomicUsize; +use tokio::sync::Mutex; +use tokio_util::sync::CancellationToken; +use url::Url; + +#[cfg(feature = "tcp-hole-punch")] +use crate::connectivity::hole_punch::tcp::TcpHolePunchConnector; +use crate::{ + config::runtime::{CoreInstanceRuntimeConfig, CoreRuntimeConfig, CoreRuntimeConfigStore}, + config::toml::TomlConfig, + connectivity::hole_punch::port_mapping::UdpPortMappingPlatform, + connectivity::hole_punch::tcp::TcpHolePunchHost, + connectivity::stun::{ + StunDnsRuntime, StunInfoCollector, StunInfoProvider, StunServerConfig, StunSocketMapper, + }, + connectivity::{ + direct::{ + DirectConnectorHost, DirectConnectorManager, DirectConnectorOptions, + ForeignDirectConnectorRpcRegistrar, + }, + hole_punch::udp::CoreUdpHolePunchService, + manual::{ + ManualConnectorManager, ManualConnectorOptions, + discovery::{CoreManualEndpointResolver, ManualEndpointDiscoveryConfig}, + }, + protocol::{ + ClientProtocolUpgrader, CoreClientProtocolConfig, CoreClientProtocolUpgrader, + ServerProtocolUpgrader, + }, + }, + events::CoreEventSink, + gateway::dhcp::DhcpIpv4Host, + host::{ + dns::{DnsRecordResolver, DnsResolver}, + packet::{HostPacketReceiver, PacketSink, host_packet_channel}, + }, + listener::{ + AcceptedSocketHandler, ExternalListenerFactory, ExternalListenerRequest, + HostListenerRegistration, ListenerFactory, RunningListenerRegistry, + plan::{ListenerRuntimeConfig, PreparedListenerPlan, prepare_listener_plan}, + transport::{ + AcceptedTransport, CoreListenerRuntime, HostAcceptedTcpSocket, + ProtocolAcceptedTransportHandler, + }, + }, + peers::peer_center::instance::PeerCenterInstance, + peers::{ + admission::{PeerAcceptedTunnelHandler, RawAcceptedTransportHandler}, + context::PeerStunInfoSource, + credential_manager::CredentialStorage, + peer_manager::{PeerManagerCore, PortablePeerManagerConfig}, + public_ipv6::{CorePublicIpv6Runtime, PublicIpv6Host}, + }, + process_runtime::CoreProcessRuntime, + socket::{tcp::VirtualTcpSocketFactory, udp::VirtualUdpSocketFactory}, +}; + +use crate::gateway::proxy::cidr_table::{ProxyCidrSnapshot, ProxyCidrTable}; +#[cfg(feature = "proxy-packet")] +use crate::gateway::proxy::icmp_host::IcmpProxyHost; +#[cfg(feature = "wrapped-transport")] +use crate::gateway::proxy::wrapped_transport::WrappedTransportEngines; +#[cfg(feature = "vpn-portal")] +use crate::gateway::vpn_portal::PortalHost; +use crate::gateway::vpn_portal::PortalRuntimeConfig; + +#[cfg(feature = "public-ipv6-provider")] +use crate::peers::public_ipv6::provider::PublicIpv6ProviderPlatform; + +#[cfg(feature = "dhcp-ipv4")] +use crate::gateway::dhcp::DhcpIpv4Runtime; +#[cfg(feature = "proxy-cidr-monitor")] +use crate::gateway::proxy::cidr_monitor::ProxyCidrMonitorRuntime; +#[cfg(feature = "proxy-packet")] +use crate::gateway::proxy::service::CoreProxyModule; +#[cfg(feature = "wrapped-transport")] +use crate::gateway::proxy::wrapped_transport::WrappedTransportProxyModule; +#[cfg(feature = "vpn-portal")] +use crate::gateway::vpn_portal::PortalModule; +#[cfg(feature = "proxy-smoltcp-stack")] +use crate::gateway::{ + DataPlaneRuntime, DataPlaneSession, PortForwardAdapter, Socks5GatewayAdapter, +}; +#[cfg(feature = "public-ipv6-provider")] +use crate::peers::public_ipv6::provider::PublicIpv6ProviderRuntime; +pub use config::CoreInstanceHostConfig; +use management_state::ManagementState; +pub use packet_io::PacketEgressHost; +use packet_io::PacketSinkEgress; +pub use packet_plane::CorePacketPlane; + +/// Complete Host capability set required by one portable core instance. +pub trait CoreInstanceHost: DirectConnectorHost + TcpHolePunchHost {} + +impl CoreInstanceHost for T where T: DirectConnectorHost + TcpHolePunchHost {} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +#[repr(u8)] +pub enum CoreInstanceState { + Created, + Starting, + Running, + Stopping, + Stopped, +} + +impl CoreInstanceState { + fn from_u8(value: u8) -> Self { + match value { + value if value == Self::Created as u8 => Self::Created, + value if value == Self::Starting as u8 => Self::Starting, + value if value == Self::Running as u8 => Self::Running, + value if value == Self::Stopping as u8 => Self::Stopping, + value if value == Self::Stopped as u8 => Self::Stopped, + _ => unreachable!("invalid core instance state"), + } + } +} + +fn default_true() -> bool { + true +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +pub struct CoreInstanceStartupPlan { + #[serde(default = "default_true")] + pub gateway: bool, + #[serde(default = "default_true")] + pub packet_proxy: bool, + #[serde(default)] + pub connectivity: CoreConnectivityMode, +} + +impl CoreInstanceStartupPlan { + fn is_default(&self) -> bool { + self == &Self::default() + } +} + +impl Default for CoreInstanceStartupPlan { + fn default() -> Self { + Self { + gateway: true, + packet_proxy: true, + connectivity: CoreConnectivityMode::Full, + } + } +} + +/// Selects which portable connectivity Modules participate in one instance. +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Default)] +#[serde(rename_all = "snake_case")] +pub enum CoreConnectivityMode { + #[default] + Full, + /// Dial configured peers without listeners, discovery, or direct connectivity. + OutboundOnly, + /// Accept Host-registered listeners without constructing outbound socket Modules. + InboundOnly, +} + +#[derive(Debug, Clone, Serialize, Deserialize, Default)] +pub struct CoreConnectivityConfig { + pub initial_peers: Vec, + pub listeners: Option, + pub runtime: CoreRuntimeConfig, + #[serde(default, skip_serializing_if = "CoreInstanceStartupPlan::is_default")] + pub startup_plan: CoreInstanceStartupPlan, + pub stun: StunServerConfig, + pub endpoint_discovery: ManualEndpointDiscoveryConfig, + pub manual: ManualConnectorOptions, + pub direct: DirectConnectorOptions, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct CoreInstanceConfig { + #[serde(default = "crate::config::toml::default_instance_name")] + pub instance_name: String, + pub peer: PortablePeerManagerConfig, + pub connectivity: CoreConnectivityConfig, + #[serde(default, skip_serializing_if = "Option::is_none")] + pub vpn_portal: Option, + #[serde(default, skip_serializing_if = "Vec::is_empty")] + pub managed_credentials: Vec, +} + +#[cfg(any(test, feature = "test-utils"))] +#[doc(hidden)] +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub struct PeerRelaySessionSnapshot { + pub has_state: bool, + pub has_session: bool, +} + +fn proxy_cidr_snapshot(config: &CoreInstanceRuntimeConfig) -> ProxyCidrSnapshot { + ProxyCidrSnapshot::from_proxy_networks(&config.peer.runtime.core.routes.proxy_networks) +} + +/// Host-owned resources that must be prepared for the complete Instance +/// lifetime, such as a native packet interface. +#[async_trait::async_trait] +pub trait InstanceRuntimeHost: std::any::Any + Send + Sync + 'static { + async fn prepare( + &self, + packet_plane: Arc, + ) -> anyhow::Result>>; + + async fn shutdown(&self); + + /// Requests prompt Host cleanup when the canonical instance owner is + /// dropped without an opportunity to await [`Self::shutdown`]. + fn request_shutdown(&self) {} + + /// Returns the bounded, serialized event journal exposed by process + /// management. Hosts that do not produce events keep the default empty + /// journal. + fn management_events(&self) -> Vec { + Vec::new() + } + + /// Applies Host-side cached views of fields already committed to the + /// shared TOML model. + #[cfg(feature = "web-client")] + fn synchronize_config( + &self, + _patch: &crate::proto::api::config::InstanceConfigPatch, + _config: &CoreInstanceRuntimeConfig, + ) { + } + + #[cfg(feature = "web-client")] + fn publish_config_patch(&self, _patch: crate::proto::api::config::InstanceConfigPatch) {} + + fn attach_tun_fd(&self, _fd: i32) -> anyhow::Result<()> { + anyhow::bail!("external TUN attachment is not supported by this Host") + } +} + +#[async_trait::async_trait] +impl InstanceRuntimeHost for () { + async fn prepare( + &self, + _packet_plane: Arc, + ) -> anyhow::Result>> { + Ok(None) + } + + async fn shutdown(&self) {} +} + +/// Host Adapters and optional native capabilities for one core instance. +/// +/// Callers provide this bundle and one normalized [`CoreInstanceConfig`] to +/// [`CoreInstance::new`]. Core constructs and owns every portable runtime +/// Module behind that seam. +pub struct CoreHostAdapters +where + H: CoreInstanceHost, +{ + host: Arc, + /// Host OS policy and build capabilities used during configuration + /// normalization. It contains no portable TOML-derived state. + pub config: CoreInstanceHostConfig, + #[cfg(any(test, feature = "test-utils"))] + /// Optional construction-time STUN provider used by deterministic tests. + stun_override: Option::Socket>>>, + dns: Arc, + process_runtime: Arc, + pub packet_egress: Arc, + pub instance_runtime: Arc, + pub events: Arc, + pub credential_storage: Option>, + #[cfg(feature = "wrapped-transport")] + pub wrapped_transports: WrappedTransportEngines, + pub protocol: Option::Socket>>>, + pub external_listener_factory: + Option>>>>, + pub host_listener_registrations: Vec, + pub server_protocol: Option>>>, + /// Optional OS port-mapping adapter. STUN-only hole punching remains + /// available when the host does not provide one. + pub udp_hole_punch_platform: Option>, + #[cfg(feature = "proxy-packet")] + pub icmp_proxy_host: Option>, + #[cfg(feature = "proxy-cidr-monitor")] + pub proxy_cidr_monitor_enabled: bool, + #[cfg(feature = "public-ipv6-provider")] + pub public_ipv6_host: Option>, + #[cfg(feature = "public-ipv6-provider")] + pub public_ipv6_provider: Option>, + #[cfg(feature = "vpn-portal")] + pub vpn_portal: Option>, +} + +impl CoreHostAdapters +where + H: CoreInstanceHost, +{ + /// Creates the minimal host bundle. Optional native capabilities can be + /// installed on the returned value before constructing the instance. + pub fn new( + host: Arc, + dns: Arc, + packet_sink: Arc, + process_runtime: Arc, + ) -> Self { + Self::new_with_packet_egress( + host, + dns, + Arc::new(PacketSinkEgress::new(packet_sink)), + process_runtime, + ) + } + + /// Creates a host bundle whose packet runtime owns the core's single + /// bounded egress receiver directly. + pub fn new_with_packet_egress( + host: Arc, + dns: Arc, + packet_egress: Arc, + process_runtime: Arc, + ) -> Self { + Self { + host, + config: CoreInstanceHostConfig::default(), + #[cfg(any(test, feature = "test-utils"))] + stun_override: None, + dns, + process_runtime, + packet_egress, + instance_runtime: Arc::new(()), + events: Arc::new(()), + credential_storage: None, + #[cfg(feature = "wrapped-transport")] + wrapped_transports: WrappedTransportEngines::default(), + protocol: None, + external_listener_factory: None, + host_listener_registrations: Vec::new(), + server_protocol: None, + udp_hole_punch_platform: None, + #[cfg(feature = "proxy-packet")] + icmp_proxy_host: None, + #[cfg(feature = "proxy-cidr-monitor")] + proxy_cidr_monitor_enabled: false, + #[cfg(feature = "public-ipv6-provider")] + public_ipv6_host: None, + #[cfg(feature = "public-ipv6-provider")] + public_ipv6_provider: None, + #[cfg(feature = "vpn-portal")] + vpn_portal: None, + } + } +} + +struct CoreStunPeerInfoSource(Arc); + +impl PeerStunInfoSource for CoreStunPeerInfoSource { + fn stun_info(&self) -> crate::proto::common::StunInfo { + self.0.get_stun_info() + } +} + +/// Owns the portable peer and connectivity runtime for one EasyTier instance. +/// +/// An instance is intentionally one-shot: after it is stopped, construct a new +/// instance rather than trying to rebuild partially consumed peer-manager state. +pub struct CoreInstance +where + H: CoreInstanceHost, +{ + instance_name: String, + #[allow(dead_code)] + management: ManagementState, + pub(super) instance_runtime: Arc, + state: AtomicU8, + latest_error: RwLock>, + pub(super) operation: Mutex<()>, + pub(super) cancel: CancellationToken, + pub(super) peer_manager: Arc, + packet_plane: Arc, + pub(super) manual: Option>, + pub(super) direct: Option>, + #[cfg(feature = "tcp-hole-punch")] + tcp_hole_punch: Option>, + pub(super) listener: Option>>, + running_listeners: Arc, + pub(super) udp_hole_punch: Option>, + #[cfg(feature = "wrapped-transport")] + wrapped_transport: Option>, + #[cfg(feature = "proxy-smoltcp-stack")] + data_plane_runtime: Arc>, + #[cfg(feature = "proxy-smoltcp-stack")] + data_plane_session: Arc>, + #[cfg(feature = "proxy-smoltcp-stack")] + socks5_adapter: Arc>, + #[cfg(feature = "proxy-smoltcp-stack")] + port_forward_adapter: Arc>, + proxy_cidr_table: Arc, + #[cfg(feature = "proxy-packet")] + packet_proxy: Arc>, + #[cfg(feature = "proxy-cidr-monitor")] + proxy_cidr_monitor: ProxyCidrMonitorRuntime, + #[cfg(feature = "dhcp-ipv4")] + dhcp_ipv4: DhcpIpv4Runtime, + pub(super) packet_egress: Arc, + pub(super) packet_receiver: Mutex>, + pub(super) peer_center: Arc, + #[cfg(feature = "public-ipv6-provider")] + public_ipv6_provider: PublicIpv6ProviderRuntime, + #[cfg(feature = "vpn-portal")] + vpn_portal: Arc, + #[cfg(feature = "proxy-packet")] + pub(super) startup_plan: CoreInstanceStartupPlan, + pub(super) runtime_config: CoreRuntimeConfigStore, + #[cfg(feature = "test-utils")] + acl_reload_count: AtomicUsize, +} + +impl CoreInstance +where + H: CoreInstanceHost, +{ + fn prepare_stun( + adapters: &CoreHostAdapters, + config: &CoreConnectivityConfig, + ) -> Arc::Socket>> { + #[cfg(any(test, feature = "test-utils"))] + if let Some(stun_override) = &adapters.stun_override { + return stun_override.clone(); + } + Arc::new(StunInfoCollector::new_with_socket_contexts( + adapters.host.clone(), + adapters.dns.clone(), + config.direct.udp_bind.context.clone(), + config.direct.tcp_bind.context.clone(), + config.stun.udp_servers.clone(), + config.stun.tcp_servers.clone(), + config.stun.udp_v6_servers.clone(), + )) + } + + /// Constructs the complete portable runtime for one EasyTier instance. + /// + /// This is the only instance construction entry. The normalized config is + /// authoritative after creation; all platform behavior enters through the + /// supplied Host Adapters. + pub fn new( + config: CoreInstanceConfig, + adapters: CoreHostAdapters, + ) -> anyhow::Result> { + let host_config = adapters.config.clone(); + Self::new_inner(config, None, host_config, adapters) + } + + /// Constructs an instance from the shared TOML model and retains that + /// model as the authoritative management configuration. + pub fn from_toml( + toml_config: TomlConfig, + adapters: CoreHostAdapters, + ) -> anyhow::Result> { + let host_config = adapters.config.clone(); + let config = CoreInstanceConfig::from_toml_with_host(&toml_config, &host_config)?; + Self::new_inner(config, Some(toml_config), host_config, adapters) + } + + fn new_inner( + config: CoreInstanceConfig, + toml_config: Option, + host_config: CoreInstanceHostConfig, + mut adapters: CoreHostAdapters, + ) -> anyhow::Result> { + build_capabilities::validate(&config)?; + let connectivity_mode = config.connectivity.startup_plan.connectivity; + let instance_name = config.instance_name; + #[cfg(feature = "vpn-portal")] + let vpn_portal_config = config.vpn_portal.clone(); + let (packet_tx, packet_rx) = host_packet_channel(); + let runtime_config = CoreRuntimeConfigStore::new( + config.connectivity.runtime.clone(), + Arc::new(config.peer.snapshot.clone()), + ); + let events = adapters.events.clone(); + #[cfg(feature = "public-ipv6-provider")] + let public_ipv6_host: Arc = adapters + .public_ipv6_host + .take() + .unwrap_or_else(|| Arc::new(())); + #[cfg(not(feature = "public-ipv6-provider"))] + let public_ipv6_host: Arc = Arc::new(()); + #[cfg(feature = "public-ipv6-provider")] + let public_ipv6_events = events.clone(); + #[cfg(not(feature = "public-ipv6-provider"))] + let public_ipv6_events: Arc = Arc::new(()); + let public_ipv6_runtime = CorePublicIpv6Runtime::new( + runtime_config.clone(), + public_ipv6_host, + public_ipv6_events, + ); + let stun = (connectivity_mode == CoreConnectivityMode::Full) + .then(|| Self::prepare_stun(&adapters, &config.connectivity)); + let (peer_stun, foreign_rpc_registrar): ( + Arc, + Arc, + ) = match &stun { + Some(stun) => ( + Arc::new(CoreStunPeerInfoSource(stun.clone())), + Arc::new(ForeignDirectConnectorRpcRegistrar::new( + adapters.host.clone(), + stun.clone(), + )), + ), + None => (Arc::new(()), Arc::new(())), + }; + let peer_manager = Arc::new(PeerManagerCore::new( + config.peer, + config.managed_credentials, + runtime_config.clone(), + peer_stun, + packet_tx, + public_ipv6_runtime.clone(), + events.clone(), + adapters.credential_storage.take(), + foreign_rpc_registrar, + )?); + let config = config.connectivity; + let configured_listeners = (connectivity_mode != CoreConnectivityMode::OutboundOnly) + .then_some(config.listeners.as_ref()) + .flatten(); + let listener_plan = prepare_listener_plan( + configured_listeners, + peer_manager.instance_id(), + adapters.server_protocol.as_deref(), + adapters.external_listener_factory.as_deref(), + )?; + let CoreHostAdapters { + host, + config: _, + #[cfg(any(test, feature = "test-utils"))] + stun_override: _, + dns, + process_runtime, + packet_egress, + instance_runtime, + events, + credential_storage: _, + #[cfg(feature = "wrapped-transport")] + wrapped_transports, + protocol, + external_listener_factory, + host_listener_registrations, + server_protocol, + udp_hole_punch_platform, + #[cfg(feature = "proxy-packet")] + icmp_proxy_host, + #[cfg(feature = "proxy-cidr-monitor")] + proxy_cidr_monitor_enabled, + #[cfg(feature = "public-ipv6-provider")] + public_ipv6_host: _, + #[cfg(feature = "public-ipv6-provider")] + public_ipv6_provider, + #[cfg(feature = "vpn-portal")] + vpn_portal, + } = adapters; + let host_listener_registrations = if connectivity_mode == CoreConnectivityMode::OutboundOnly + { + Vec::new() + } else { + host_listener_registrations + }; + let dns_records: Arc = dns.clone(); + let dns: Arc = dns; + let ring_registry = process_runtime.ring_registry(); + let protected_tcp_ports = process_runtime.protected_tcp_ports(); + let CoreConnectivityConfig { + initial_peers, + listeners: _, + runtime: _, + startup_plan, + stun: _, + endpoint_discovery, + manual: manual_options, + direct: direct_options, + } = config; + #[cfg(not(feature = "proxy-packet"))] + let _ = startup_plan; + if connectivity_mode == CoreConnectivityMode::InboundOnly && !initial_peers.is_empty() { + anyhow::bail!("inbound-only connectivity does not support outbound peers"); + } + let accepted_tunnel_handler = PeerAcceptedTunnelHandler::new(&peer_manager, events.clone()); + let accepted_transport_handler: Arc< + dyn AcceptedSocketHandler>>, + > = match server_protocol { + Some(server_protocol) => Arc::new(ProtocolAcceptedTransportHandler::new( + &accepted_tunnel_handler, + server_protocol, + )), + None => Arc::new(RawAcceptedTransportHandler::new( + accepted_tunnel_handler.clone(), + )), + }; + let running_listeners = Arc::new(RunningListenerRegistry::default()); + let PreparedListenerPlan { + transports, + external, + failures, + } = listener_plan; + let mut external_factories = + Vec::with_capacity(external.len() + host_listener_registrations.len()); + if (!external.is_empty() || !host_listener_registrations.is_empty()) + && external_listener_factory.is_none() + { + anyhow::bail!("listener plan requires an external listener factory"); + } + for (listener, socket_context) in external { + let factory = external_listener_factory.clone().unwrap(); + let request = ExternalListenerRequest { + url: listener.url, + socket_context, + }; + external_factories.push(ListenerFactory::new( + move || factory.create(request.clone()), + listener.must_succeed, + )); + } + for request in host_listener_registrations { + let factory = external_listener_factory.clone().unwrap(); + if !factory.supports_scheme(request.url.scheme()) { + anyhow::bail!( + "external listener factory does not support Host listener scheme {}", + request.url.scheme() + ); + } + external_factories.push(ListenerFactory::new( + move || factory.create(request.clone()), + true, + )); + } + let has_listener_work = + !transports.is_empty() || !external_factories.is_empty() || !failures.is_empty(); + let listener = has_listener_work.then(|| { + Arc::new(CoreListenerRuntime::new_with_events( + host.clone(), + dns.clone(), + ring_registry.clone(), + transports, + external_factories, + failures, + accepted_transport_handler, + events.clone(), + running_listeners.clone(), + )) + }); + let protocol = (connectivity_mode != CoreConnectivityMode::InboundOnly).then(|| { + protocol.unwrap_or_else(|| { + Arc::new(CoreClientProtocolUpgrader::new( + CoreClientProtocolConfig::default(), + )) + }) + }); + let manual = if let Some(protocol) = &protocol { + let endpoint_resolver = Arc::new(CoreManualEndpointResolver::new( + host.clone(), + dns.clone(), + dns_records, + endpoint_discovery, + )); + let manual = ManualConnectorManager::new( + peer_manager.clone(), + host.clone(), + dns.clone(), + endpoint_resolver, + protocol.clone(), + ring_registry, + manual_options, + events.clone(), + ); + for url in initial_peers { + manual.add_connector(url)?; + } + Some(manual) + } else { + None + }; + let udp_hole_punch = stun + .as_ref() + .zip(protocol.as_ref()) + .map(|(stun, protocol)| { + CoreUdpHolePunchService::new( + peer_manager.clone(), + host.clone(), + stun.clone(), + udp_hole_punch_platform, + events.clone(), + direct_options.udp_bind.context.clone(), + protocol.clone(), + ) + }); + let proxy_cidr_table = Arc::new(ProxyCidrTable::from_snapshot(proxy_cidr_snapshot( + runtime_config.snapshot().as_ref(), + ))); + #[cfg(feature = "wrapped-transport")] + let tcp_proxy_socket_context = direct_options.tcp_bind.context.clone(); + #[cfg(feature = "proxy-packet")] + let packet_proxy = CoreProxyModule::new( + peer_manager.clone(), + host.clone(), + protected_tcp_ports.clone(), + running_listeners.clone(), + runtime_config.clone(), + proxy_cidr_table.clone(), + tcp_proxy_socket_context.clone(), + direct_options.udp_bind.context.clone(), + // Raw ICMP shares the datagram/network-layer routing context. + direct_options.udp_bind.context.clone(), + icmp_proxy_host, + ); + #[cfg(feature = "wrapped-transport")] + let wrapped_transport = { + let WrappedTransportEngines { kcp, quic } = wrapped_transports; + WrappedTransportProxyModule::new( + peer_manager.clone(), + runtime_config.clone(), + kcp, + quic, + host.clone(), + protected_tcp_ports.clone(), + running_listeners.clone(), + proxy_cidr_table.clone(), + tcp_proxy_socket_context, + ) + }; + #[cfg(feature = "proxy-smoltcp-stack")] + let data_plane_runtime = DataPlaneRuntime::new( + runtime_config.clone(), + peer_manager.clone(), + wrapped_transport.as_ref(), + host.clone(), + direct_options.tcp_bind.context.clone(), + ); + #[cfg(feature = "proxy-smoltcp-stack")] + let data_plane_session = DataPlaneSession::new(&data_plane_runtime); + #[cfg(feature = "proxy-smoltcp-stack")] + let socks5_adapter = Socks5GatewayAdapter::new( + runtime_config.clone(), + data_plane_runtime.clone(), + host.clone(), + dns.clone(), + direct_options.tcp_bind.context.clone(), + ); + #[cfg(feature = "proxy-smoltcp-stack")] + let port_forward_adapter = PortForwardAdapter::new( + runtime_config.clone(), + data_plane_runtime.clone(), + host.clone(), + direct_options.tcp_bind.context.clone(), + events.clone(), + ); + #[cfg(feature = "tcp-hole-punch")] + let tcp_hole_punch = stun + .as_ref() + .zip(protocol.as_ref()) + .map(|(stun, protocol)| { + TcpHolePunchConnector::new( + peer_manager.clone(), + host.clone(), + stun.clone(), + direct_options.tcp_bind.context.clone(), + protocol.clone(), + Arc::new(crate::connectivity::protocol::CoreServerProtocolUpgrader::< + HostAcceptedTcpSocket, + >::new( + crate::connectivity::protocol::CoreServerProtocolConfig::default(), + )), + ) + }); + let direct = match (stun, protocol) { + (Some(stun), Some(protocol)) => { + Some(DirectConnectorManager::new_with_running_listeners( + peer_manager.clone(), + host.clone(), + protected_tcp_ports, + stun, + running_listeners.clone(), + dns, + protocol, + direct_options, + )) + } + _ => None, + }; + let peer_center = Arc::new(PeerCenterInstance::new(peer_manager.clone())); + #[cfg(feature = "public-ipv6-provider")] + let public_ipv6_provider = PublicIpv6ProviderRuntime::new( + public_ipv6_provider, + runtime_config.clone(), + public_ipv6_runtime, + ); + #[cfg(feature = "vpn-portal")] + let vpn_portal = PortalModule::new( + peer_manager.clone(), + runtime_config.clone(), + vpn_portal_config, + vpn_portal, + events.clone(), + )?; + #[cfg(feature = "proxy-cidr-monitor")] + let proxy_cidr_monitor = + ProxyCidrMonitorRuntime::new(proxy_cidr_monitor_enabled, events.clone()); + #[cfg(feature = "proxy-cidr-monitor")] + let proxy_cidr_monitor_available = proxy_cidr_monitor.is_enabled(); + #[cfg(not(feature = "proxy-cidr-monitor"))] + let proxy_cidr_monitor_available = false; + let packet_plane = Arc::new(CorePacketPlane::new( + peer_manager.clone(), + runtime_config.clone(), + proxy_cidr_monitor_available, + )); + + Ok(Arc::new(Self { + instance_name, + management: ManagementState::new(toml_config, host_config), + instance_runtime, + state: AtomicU8::new(CoreInstanceState::Created as u8), + latest_error: RwLock::new(None), + operation: Mutex::new(()), + cancel: CancellationToken::new(), + peer_manager, + packet_plane, + manual, + direct, + #[cfg(feature = "tcp-hole-punch")] + tcp_hole_punch, + listener, + running_listeners, + udp_hole_punch, + #[cfg(feature = "wrapped-transport")] + wrapped_transport, + #[cfg(feature = "proxy-smoltcp-stack")] + data_plane_runtime, + #[cfg(feature = "proxy-smoltcp-stack")] + data_plane_session, + #[cfg(feature = "proxy-smoltcp-stack")] + socks5_adapter, + #[cfg(feature = "proxy-smoltcp-stack")] + port_forward_adapter, + proxy_cidr_table, + #[cfg(feature = "proxy-packet")] + packet_proxy, + #[cfg(feature = "proxy-cidr-monitor")] + proxy_cidr_monitor, + #[cfg(feature = "dhcp-ipv4")] + dhcp_ipv4: DhcpIpv4Runtime::new(), + packet_egress, + packet_receiver: Mutex::new(Some(packet_rx)), + peer_center, + #[cfg(feature = "public-ipv6-provider")] + public_ipv6_provider, + #[cfg(feature = "vpn-portal")] + vpn_portal, + #[cfg(feature = "proxy-packet")] + startup_plan, + runtime_config, + #[cfg(feature = "test-utils")] + acl_reload_count: AtomicUsize::new(0), + })) + } + + pub fn state(&self) -> CoreInstanceState { + CoreInstanceState::from_u8(self.state.load(Ordering::Acquire)) + } + + /// Returns the peer manager for tunnels accepted outside this instance's + /// regular listener path, such as the shared Web listener. + pub fn peer_manager(&self) -> &Arc { + &self.peer_manager + } + + fn set_state(&self, state: CoreInstanceState) { + self.state.store(state as u8, Ordering::Release); + } + + /// Publishes one complete instance configuration version. Host changes have + /// no effect until submitted through this method. + pub async fn update_runtime_config( + &self, + config: CoreInstanceRuntimeConfig, + ) -> anyhow::Result<()> { + let _operation = self.operation.lock().await; + self.update_runtime_config_under_operation(config).await + } + + pub(crate) async fn update_runtime_config_under_operation( + &self, + config: CoreInstanceRuntimeConfig, + ) -> anyhow::Result<()> { + if matches!( + self.state(), + CoreInstanceState::Stopping | CoreInstanceState::Stopped + ) { + anyhow::bail!("runtime config cannot update while instance is stopping or stopped"); + } + self.validate_runtime_config_capabilities(&config)?; + #[cfg(feature = "test-utils")] + let reload_acl = self.runtime_config.snapshot().services.acl != config.services.acl; + let published = self.peer_manager.update_runtime_config(config).await?; + #[cfg(feature = "test-utils")] + if reload_acl { + self.acl_reload_count.fetch_add(1, Ordering::Relaxed); + } + self.proxy_cidr_table + .update_snapshot(proxy_cidr_snapshot(&published)); + #[cfg(feature = "proxy-smoltcp-stack")] + self.port_forward_adapter + .reload( + &self + .runtime_config + .snapshot() + .services + .gateway + .port_forwards, + ) + .await?; + Ok(()) + } + + pub(crate) fn validate_runtime_config_capabilities( + &self, + config: &CoreInstanceRuntimeConfig, + ) -> anyhow::Result<()> { + build_capabilities::validate_runtime(config)?; + #[cfg(feature = "vpn-portal")] + self.vpn_portal.validate_runtime_config(config)?; + Ok(()) + } + + pub async fn wait(&self) { + self.peer_manager.wait().await; + } +} + +impl Drop for CoreInstance +where + H: CoreInstanceHost, +{ + fn drop(&mut self) { + self.cancel.cancel(); + self.instance_runtime.request_shutdown(); + self.packet_egress.request_stop(); + } +} + +#[cfg(any(test, feature = "test-utils"))] +mod test_utils; + +#[cfg(test)] +mod tests; diff --git a/vendor/easytier/easytier-core/src/instance/packet_io.rs b/vendor/easytier/easytier-core/src/instance/packet_io.rs new file mode 100644 index 0000000..ebb21e2 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/packet_io.rs @@ -0,0 +1,205 @@ +use std::{ + net::{IpAddr, Ipv4Addr, Ipv6Addr}, + sync::{Arc, Mutex}, +}; + +use tokio::task::JoinHandle; + +use crate::host::packet::{HostPacketReceiver, PacketSink}; + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(crate) struct IpPacketMeta { + pub(crate) source: IpAddr, + pub(crate) destination: IpAddr, +} + +pub(crate) fn parse_ip_packet(packet: &[u8]) -> anyhow::Result { + let Some(version) = packet.first().map(|byte| byte >> 4) else { + anyhow::bail!("IP packet is empty"); + }; + match version { + 4 => parse_ipv4_packet(packet), + 6 => parse_ipv6_packet(packet), + _ => anyhow::bail!("unsupported IP version: {version}"), + } +} + +fn parse_ipv4_packet(packet: &[u8]) -> anyhow::Result { + if packet.len() < 20 { + anyhow::bail!("IPv4 packet is shorter than the minimum header"); + } + let header_len = usize::from(packet[0] & 0x0f) * 4; + let total_len = usize::from(u16::from_be_bytes([packet[2], packet[3]])); + if header_len < 20 || total_len < header_len || total_len != packet.len() { + anyhow::bail!("invalid IPv4 header or total length"); + } + Ok(IpPacketMeta { + source: IpAddr::V4(Ipv4Addr::new( + packet[12], packet[13], packet[14], packet[15], + )), + destination: IpAddr::V4(Ipv4Addr::new( + packet[16], packet[17], packet[18], packet[19], + )), + }) +} + +fn parse_ipv6_packet(packet: &[u8]) -> anyhow::Result { + if packet.len() < 40 { + anyhow::bail!("IPv6 packet is shorter than the fixed header"); + } + let payload_len = usize::from(u16::from_be_bytes([packet[4], packet[5]])); + if (payload_len == 0 && packet.len() != 40) + || (payload_len != 0 && 40 + payload_len != packet.len()) + { + anyhow::bail!("IPv6 payload length does not match the packet"); + } + Ok(IpPacketMeta { + source: IpAddr::V6(Ipv6Addr::from( + <[u8; 16]>::try_from(&packet[8..24]).expect("checked IPv6 header length"), + )), + destination: IpAddr::V6(Ipv6Addr::from( + <[u8; 16]>::try_from(&packet[24..40]).expect("checked IPv6 header length"), + )), + }) +} + +#[async_trait::async_trait] +pub trait PacketEgressHost: Send + Sync + 'static { + async fn start(&self, receiver: HostPacketReceiver) -> anyhow::Result<()>; + + async fn stop(&self); + + fn request_stop(&self) {} +} + +pub(crate) struct PacketSinkEgress { + sink: Arc, + task: Mutex>>, + started: std::sync::atomic::AtomicBool, +} + +impl PacketSinkEgress { + pub(crate) fn new(sink: Arc) -> Self { + Self { + sink, + task: Mutex::new(None), + started: std::sync::atomic::AtomicBool::new(false), + } + } +} + +#[async_trait::async_trait] +impl PacketEgressHost for PacketSinkEgress { + async fn start(&self, mut receiver: HostPacketReceiver) -> anyhow::Result<()> { + if self.started.swap(true, std::sync::atomic::Ordering::AcqRel) { + anyhow::bail!("packet egress is one-shot and already started"); + } + let sink = self.sink.clone(); + let task = tokio::spawn(async move { + while let Some(packet) = receiver.recv().await { + if let Err(error) = sink.write_packet(packet).await { + tracing::warn!(?error, "host packet sink rejected an egress packet"); + } + } + }); + *self.task.lock().unwrap() = Some(task); + Ok(()) + } + + async fn stop(&self) { + let task = self.task.lock().unwrap().take(); + if let Some(task) = task { + task.abort(); + let _ = task.await; + } + } + + fn request_stop(&self) { + if let Some(task) = self.task.lock().unwrap().take() { + task.abort(); + } + } +} + +impl Drop for PacketSinkEgress { + fn drop(&mut self) { + if let Some(task) = self.task.lock().unwrap().take() { + task.abort(); + } + } +} + +#[cfg(test)] +mod tests { + use crate::foundation::time::{Duration, timeout}; + use crate::host::packet::{HostPacket, host_packet_channel}; + + use super::*; + + #[test] + fn parses_ipv4_and_ipv6_packet_endpoints() { + let mut ipv4 = vec![0u8; 20]; + ipv4[0] = 0x45; + ipv4[2..4].copy_from_slice(&20u16.to_be_bytes()); + ipv4[12..16].copy_from_slice(&[10, 1, 0, 1]); + ipv4[16..20].copy_from_slice(&[10, 2, 0, 1]); + assert_eq!( + parse_ip_packet(&ipv4).unwrap(), + IpPacketMeta { + source: "10.1.0.1".parse().unwrap(), + destination: "10.2.0.1".parse().unwrap(), + } + ); + + let mut ipv6 = vec![0u8; 40]; + ipv6[0] = 0x60; + ipv6[8..24].copy_from_slice(&"fd00::1".parse::().unwrap().octets()); + ipv6[24..40].copy_from_slice(&"fd00::2".parse::().unwrap().octets()); + assert_eq!( + parse_ip_packet(&ipv6).unwrap(), + IpPacketMeta { + source: "fd00::1".parse().unwrap(), + destination: "fd00::2".parse().unwrap(), + } + ); + } + + #[test] + fn rejects_truncated_or_unknown_ip_packets() { + assert!(parse_ip_packet(&[]).is_err()); + assert!(parse_ip_packet(&[0x70]).is_err()); + assert!(parse_ip_packet(&[0x45; 19]).is_err()); + assert!(parse_ip_packet(&[0x60; 39]).is_err()); + + let mut ipv4_with_trailing_bytes = vec![0u8; 21]; + ipv4_with_trailing_bytes[0] = 0x45; + ipv4_with_trailing_bytes[2..4].copy_from_slice(&20u16.to_be_bytes()); + assert!(parse_ip_packet(&ipv4_with_trailing_bytes).is_err()); + + let mut unsupported_ipv6_jumbogram = vec![0u8; 41]; + unsupported_ipv6_jumbogram[0] = 0x60; + assert!(parse_ip_packet(&unsupported_ipv6_jumbogram).is_err()); + } + + #[tokio::test] + async fn packet_egress_forwards_to_host_sink_and_joins_on_stop() { + let (core_tx, core_rx) = host_packet_channel(); + let (host_tx, mut host_rx) = tokio::sync::mpsc::channel(1); + let egress = PacketSinkEgress::new(Arc::new(host_tx)); + egress.start(core_rx).await.unwrap(); + + core_tx + .send(HostPacket::copy_from_payload(b"packet")) + .await + .unwrap(); + let packet = timeout(Duration::from_secs(1), host_rx.recv()) + .await + .expect("packet egress did not forward to the host") + .expect("host packet channel closed"); + assert_eq!(packet, b"packet"); + + egress.stop().await; + let (_core_tx, core_rx) = host_packet_channel(); + assert!(egress.start(core_rx).await.is_err()); + } +} diff --git a/vendor/easytier/easytier-core/src/instance/packet_plane.rs b/vendor/easytier/easytier-core/src/instance/packet_plane.rs new file mode 100644 index 0000000..8ffba5b --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/packet_plane.rs @@ -0,0 +1,160 @@ +use std::{ + collections::BTreeSet, + net::IpAddr, + sync::{Arc, RwLock}, +}; + +use async_trait::async_trait; + +use crate::{ + config::runtime::CoreRuntimeConfigStore, + gateway::magic_dns::{MagicDnsRouteSnapshot, MagicDnsRouteSource}, + gateway::proxy::cidr_monitor::{ProxyCidrDiff, collect_proxy_cidr_diff}, + host::packet::HostPacket, + peers::peer_manager::PeerManagerCore, +}; + +#[cfg(feature = "proxy-packet")] +use crate::foundation::stats::{LabelSet, LabelType, MetricName}; +#[cfg(feature = "proxy-packet")] +use crate::gateway::magic_dns::{ + MagicDnsQueryResolver, MagicDnsResolverRegistration, magic_dns_packet_filter, +}; +#[cfg(feature = "proxy-packet")] +use crate::gateway::udp_broadcast::UdpBroadcastRelayStats; + +use super::packet_io::parse_ip_packet; + +type ProxyRouteFilter = Arc bool + Send + Sync>; + +/// Stable packet- and route-plane projection for platform integrations. +pub struct CorePacketPlane { + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + proxy_cidr_monitor_available: bool, + proxy_route_filter: RwLock>, +} + +impl CorePacketPlane { + pub(super) fn new( + peer_manager: Arc, + runtime_config: CoreRuntimeConfigStore, + proxy_cidr_monitor_available: bool, + ) -> Self { + Self { + peer_manager, + runtime_config, + proxy_cidr_monitor_available, + proxy_route_filter: RwLock::new(None), + } + } + + pub async fn send_ip_packet(&self, packet: HostPacket) -> anyhow::Result<()> { + let meta = parse_ip_packet(packet.payload())?; + let source_is_local = self.peer_manager.is_local_virtual_ip(&meta.source); + if matches!(meta.source, IpAddr::V6(ip) if ip.is_unicast_link_local()) && !source_is_local { + return Ok(()); + } + self.peer_manager + .send_msg_by_ip(packet.into_core_packet(), meta.destination, source_is_local) + .await + .map_err(Into::into) + } + + pub async fn send_local_ip_packet(&self, packet: HostPacket) -> anyhow::Result<()> { + let destination = parse_ip_packet(packet.payload())?.destination; + self.peer_manager + .send_msg_by_ip(packet.into_core_packet(), destination, true) + .await + .map_err(Into::into) + } + + pub async fn proxy_cidr_diff( + &self, + previous: &BTreeSet, + ) -> Option { + if !self.proxy_cidr_monitor_available { + return None; + } + let mut diff = + collect_proxy_cidr_diff(self.peer_manager.as_ref(), &self.runtime_config, previous) + .await; + if let Some(filter) = self.proxy_route_filter.read().unwrap().as_ref() { + diff.current = diff + .current + .into_iter() + .filter(|route| filter(route)) + .take(32) + .collect(); + diff.added = diff.current.difference(previous).copied().collect(); + diff.removed = previous.difference(&diff.current).copied().collect(); + } + Some(diff) + } + + /// Set the host's policy before starting the native route updater. + pub fn set_proxy_route_filter(&self, filter: ProxyRouteFilter) { + self.peer_manager.set_host_subnet_filter(filter.clone()); + *self.proxy_route_filter.write().unwrap() = Some(filter); + } + + pub async fn public_ipv6_routes(&self) -> BTreeSet { + self.peer_manager.list_public_ipv6_routes().await + } + + pub async fn public_ipv6_addr(&self) -> Option { + self.peer_manager.public_ipv6_addr().await + } + + #[cfg(feature = "proxy-packet")] + pub fn udp_broadcast_relay_stats(&self) -> UdpBroadcastRelayStats { + let network_name = self + .runtime_config + .snapshot() + .peer + .runtime + .network_identity + .network_name + .clone(); + let labels = LabelSet::new().with_label_type(LabelType::NetworkName(network_name)); + let stats = self.peer_manager.stats_manager(); + UdpBroadcastRelayStats::new( + stats.get_counter(MetricName::UdpBroadcastRelayPacketsCaptured, labels.clone()), + stats.get_counter(MetricName::UdpBroadcastRelayPacketsIgnored, labels.clone()), + stats.get_counter( + MetricName::UdpBroadcastRelayPacketsForwarded, + labels.clone(), + ), + stats.get_counter(MetricName::UdpBroadcastRelayPacketsForwardFailed, labels), + ) + } + + #[cfg(feature = "proxy-packet")] + pub async fn register_magic_dns_resolver( + &self, + fake_ip: std::net::Ipv4Addr, + resolver: Arc, + ) -> MagicDnsResolverRegistration { + let runtime = tokio::runtime::Handle::current(); + let pipeline = self + .peer_manager + .add_managed_nic_packet_process_pipeline(magic_dns_packet_filter( + fake_ip, + self.peer_manager.my_peer_id(), + resolver, + )) + .await; + MagicDnsResolverRegistration::new(Arc::downgrade(&self.peer_manager), pipeline, runtime) + } +} + +#[async_trait] +impl MagicDnsRouteSource for CorePacketPlane { + async fn snapshot(&self) -> MagicDnsRouteSnapshot { + MagicDnsRouteSource::snapshot(self.peer_manager.as_ref()).await + } + + async fn revision(&self) -> quanta::Instant { + MagicDnsRouteSource::revision(self.peer_manager.as_ref()).await + } +} diff --git a/vendor/easytier/easytier-core/src/instance/packet_proxy_extension.rs b/vendor/easytier/easytier-core/src/instance/packet_proxy_extension.rs new file mode 100644 index 0000000..2111d76 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/packet_proxy_extension.rs @@ -0,0 +1,41 @@ +use crate::gateway::proxy::{ + tcp_proxy_engine::TcpNatEntrySnapshot, + wrapped_transport::{WrappedTransportKind, WrappedTransportRole}, +}; + +use super::{CoreInstance, CoreInstanceHost}; + +impl CoreInstance +where + H: CoreInstanceHost, +{ + pub fn tcp_proxy_entry_snapshots(&self) -> Vec { + self.packet_proxy.tcp_entry_snapshots() + } + + pub fn wrapped_tcp_proxy_entry_snapshots( + &self, + transport: WrappedTransportKind, + role: WrappedTransportRole, + ) -> Vec { + self.wrapped_transport + .as_ref() + .map_or_else(Vec::new, |proxy| match role { + WrappedTransportRole::Source => proxy.source_entry_snapshots(transport), + WrappedTransportRole::Destination => proxy.destination_entry_snapshots(transport), + }) + } + + pub fn wrapped_transport_is_started( + &self, + transport: WrappedTransportKind, + role: WrappedTransportRole, + ) -> bool { + self.wrapped_transport + .as_ref() + .is_some_and(|proxy| match role { + WrappedTransportRole::Source => proxy.source_is_started(transport), + WrappedTransportRole::Destination => proxy.destination_is_started(transport), + }) + } +} diff --git a/vendor/easytier/easytier-core/src/instance/public_ipv6_extension.rs b/vendor/easytier/easytier-core/src/instance/public_ipv6_extension.rs new file mode 100644 index 0000000..59e8b5e --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/public_ipv6_extension.rs @@ -0,0 +1,10 @@ +use crate::instance::{CoreInstance, CoreInstanceHost}; + +impl CoreInstance +where + H: CoreInstanceHost, +{ + pub async fn reconcile_public_ipv6_provider(&self) -> bool { + self.public_ipv6_provider.reconcile().await + } +} diff --git a/vendor/easytier/easytier-core/src/instance/test_utils.rs b/vendor/easytier/easytier-core/src/instance/test_utils.rs new file mode 100644 index 0000000..c7eebe4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/test_utils.rs @@ -0,0 +1,90 @@ +use std::{sync::Arc, time::Duration}; + +use crate::{ + connectivity::stun::StunSocketMapper, peers::conn::peer_conn::PeerConnId, + socket::udp::VirtualUdpSocketFactory, +}; + +use super::{ + CoreHostAdapters, CoreInstance, CoreInstanceConfig, CoreInstanceHost, PeerRelaySessionSnapshot, + build_capabilities, +}; + +impl CoreInstanceConfig { + #[doc(hidden)] + pub fn validate_build_capabilities_for_test(&self) -> anyhow::Result<()> { + build_capabilities::validate(self) + } +} + +impl CoreHostAdapters +where + H: CoreInstanceHost, +{ + #[doc(hidden)] + pub fn replace_stun_provider( + &mut self, + provider: Arc::Socket>>, + ) { + self.stun_override = Some(provider); + } +} + +impl CoreInstance +where + H: CoreInstanceHost, +{ + #[doc(hidden)] + pub async fn connected_peers(&self) -> Vec { + self.peer_manager + .get_peer_map() + .list_peers_with_conn() + .await + } + + #[doc(hidden)] + pub async fn admit_client_tunnel_for_test( + &self, + tunnel: Box, + ) -> Result<(crate::config::PeerId, PeerConnId), crate::peers::error::Error> { + self.peer_manager.add_client_tunnel(tunnel).await + } + + #[doc(hidden)] + pub async fn relay_route_has_static_key_for_test( + &self, + peer_id: crate::config::PeerId, + ) -> bool { + self.peer_manager + .get_peer_map() + .get_route_peer_info(peer_id) + .await + .is_some_and(|info| !info.noise_static_pubkey.is_empty()) + } + + #[doc(hidden)] + pub fn relay_session_snapshot_for_test( + &self, + peer_id: crate::config::PeerId, + ) -> PeerRelaySessionSnapshot { + let relay = self.peer_manager.get_relay_peer_map(); + PeerRelaySessionSnapshot { + has_state: relay.has_state(peer_id), + has_session: relay.has_session_without_touch(peer_id), + } + } + + #[doc(hidden)] + pub fn evict_idle_relay_sessions_for_test(&self, idle: Duration) { + self.peer_manager + .get_relay_peer_map() + .evict_idle_sessions(idle); + } + + #[doc(hidden)] + pub fn evict_unused_peer_sessions_for_test(&self, idle: Duration) { + self.peer_manager + .get_peer_session_store() + .evict_unused_sessions_idle(idle); + } +} diff --git a/vendor/easytier/easytier-core/src/instance/tests.rs b/vendor/easytier/easytier-core/src/instance/tests.rs new file mode 100644 index 0000000..773993a --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/tests.rs @@ -0,0 +1,3311 @@ +use async_trait::async_trait; + +use super::*; +use crate::{ + config::toml::ConfigLoader as _, + listener::transport::TransportListenerConfig, + socket::{ + SocketContext, SocketListener, + udp::{UdpSessionAcceptKind, UdpSessionProtocol}, + }, +}; + +struct TestServerProtocol; + +#[async_trait] +impl ServerProtocolUpgrader<()> for TestServerProtocol { + fn supports_scheme(&self, scheme: &str) -> bool { + matches!(scheme, "ws" | "wss" | "wg" | "quic" | "faketcp" | "unix") + } + + async fn upgrade_tcp( + &self, + _socket: (), + _local_url: Url, + ) -> anyhow::Result { + unreachable!() + } + + async fn upgrade_udp( + &self, + _session: crate::socket::udp::UdpSession, + _local_url: Url, + _admission: Option, + ) -> anyhow::Result { + unreachable!() + } + + async fn upgrade_byte_stream( + &self, + _socket: (), + _local_url: Url, + _remote_url: Option, + ) -> anyhow::Result { + unreachable!() + } +} + +struct TestExternalListenerFactory; + +impl ExternalListenerFactory<()> for TestExternalListenerFactory { + fn supports_scheme(&self, scheme: &str) -> bool { + matches!(scheme, "faketcp" | "unix") + } + + fn create(&self, _request: ExternalListenerRequest) -> Box> { + unreachable!() + } +} + +#[test] +fn core_plans_transport_and_external_listener_capabilities() { + let self_id = uuid::Uuid::new_v4(); + let config = ListenerRuntimeConfig::new( + [ + "tcp://127.0.0.1:1", + "udp://127.0.0.1:2", + "ws://127.0.0.1:3", + "wg://127.0.0.1:4", + "quic://127.0.0.1:5", + "faketcp://127.0.0.1:6", + "unix:///tmp/easytier-test", + "http://127.0.0.1:7", + ] + .into_iter() + .map(str::parse) + .collect::, _>>() + .unwrap(), + false, + SocketContext::default().with_socket_mark(Some(7)), + ); + + let plan = prepare_listener_plan::<(), ()>( + Some(&config), + self_id, + Some(&TestServerProtocol), + Some(&TestExternalListenerFactory), + ) + .unwrap(); + + assert_eq!(plan.transports.len(), 6); + assert_eq!(plan.external.len(), 2); + assert_eq!(plan.failures.len(), 1); + assert_eq!( + plan.transports[0].url(), + &crate::listener::plan::ring_listener_url(self_id) + ); + assert!(matches!( + &plan.transports[4], + TransportListenerConfig::Udp { + accept_kind: UdpSessionAcceptKind::Classified(UdpSessionProtocol::WireGuard), + .. + } + )); + assert!(matches!( + &plan.transports[5], + TransportListenerConfig::Udp { + accept_kind: UdpSessionAcceptKind::Classified(UdpSessionProtocol::Quic), + .. + } + )); + assert_eq!(plan.external[0].0.url.scheme(), "faketcp"); + assert_eq!(plan.external[0].1.socket_mark, Some(7)); +} + +#[test] +fn unsupported_protocol_listener_becomes_a_plan_failure() { + let config = ListenerRuntimeConfig::new( + vec!["wg://127.0.0.1:11011".parse().unwrap()], + false, + SocketContext::default(), + ); + + let plan = + prepare_listener_plan::<(), ()>(Some(&config), uuid::Uuid::new_v4(), None, None).unwrap(); + + assert_eq!(plan.transports.len(), 1); + assert!(plan.external.is_empty()); + assert_eq!(plan.failures.len(), 1); +} + +#[test] +fn raw_unix_listener_does_not_require_a_server_protocol() { + let config = ListenerRuntimeConfig::new( + vec!["unix:///tmp/easytier-test".parse().unwrap()], + false, + SocketContext::default(), + ); + + let plan = prepare_listener_plan::<(), ()>( + Some(&config), + uuid::Uuid::new_v4(), + None, + Some(&TestExternalListenerFactory), + ) + .unwrap(); + + assert_eq!(plan.transports.len(), 1); + assert_eq!(plan.external.len(), 1); + assert!(plan.failures.is_empty()); + assert_eq!(plan.external[0].0.url.scheme(), "unix"); +} + +#[test] +fn core_instance_config_round_trips_as_normalized_json() { + let mut core = crate::config::CoreConfig::default(); + core.peer_policy.encryption_required = false; + core.peer_policy.p2p_enabled = false; + let peer = crate::peers::peer_manager::PortablePeerManagerConfig::new( + crate::config::peers::PeerRuntimeConfig { + core, + network_identity: crate::config::NetworkIdentity { + network_name: "default".to_owned(), + network_secret: Some("test".to_owned()), + network_secret_digest: None, + }, + stun_info: crate::proto::common::StunInfo::default(), + feature_flags: crate::proto::common::PeerFeatureFlag::default(), + secure_mode: None, + host_routing: crate::config::peers::HostRoutingPolicy::default(), + }, + ); + let config = CoreInstanceConfig { + instance_name: String::new(), + peer, + connectivity: CoreConnectivityConfig::default(), + vpn_portal: None, + managed_credentials: Vec::new(), + }; + + let mut config = config; + config.connectivity.direct.testing = true; + let encoded = serde_json::to_value(&config).unwrap(); + assert!(encoded["connectivity"]["direct"].get("testing").is_none()); + let decoded: CoreInstanceConfig = serde_json::from_value(encoded.clone()).unwrap(); + + assert!(!decoded.connectivity.direct.testing); + assert!(decoded.connectivity.startup_plan.gateway); + assert_eq!( + decoded.connectivity.startup_plan.connectivity, + CoreConnectivityMode::Full + ); + assert_eq!(serde_json::to_value(&decoded).unwrap(), encoded); + + let mut legacy = encoded; + legacy.as_object_mut().unwrap().remove("instance_name"); + let decoded: CoreInstanceConfig = serde_json::from_value(legacy).unwrap(); + assert_eq!(decoded.instance_name, "default"); +} + +#[test] +fn wasi_create_config_uses_shared_toml() { + let fixture = include_bytes!("../../testdata/wasi_core_instance_create.json"); + let mut create = + serde_json::from_slice::(fixture) + .unwrap(); + create.validate().unwrap(); + let config = create.parse_config().unwrap(); + let normalized = CoreInstanceConfig::from_toml(&config).unwrap(); + + assert_eq!( + normalized.peer.snapshot.runtime.core.node.instance_id, + Some(*config.get_id().as_bytes()) + ); + assert!(normalized.peer.snapshot.flags.disable_p2p); + create.version += 1; + assert!(create.validate().is_err()); +} + +#[test] +fn acl_config_rejects_invalid_whitelist() { + let config = crate::config::peers::AclRuleConfig { + tcp_whitelist: vec!["9000-8000".to_owned()], + ..Default::default() + }; + + let error = config.build().unwrap_err(); + + assert!(error.to_string().contains("Start port must be <= end port")); +} + +mod portable_runtime { + use std::{ + net::{IpAddr, Ipv6Addr, SocketAddr}, + sync::{ + Arc, + atomic::{AtomicBool, AtomicUsize, Ordering}, + }, + time::Duration, + }; + + use tokio::sync::Notify; + use tokio_util::task::AbortOnDropHandle; + + #[cfg(feature = "proxy-packet")] + use std::sync::Mutex as StdMutex; + + use super::*; + use crate::{ + config::peers::{HostRoutingPolicy, PeerRuntimeConfig}, + config::runtime::CoreInstanceRuntimeConfig, + config::{ + CoreConfig, IpPrefix, NetworkIdentity, ProxyNetworkConfig, gateway::PortForwardConfig, + }, + connectivity::manual::{ManualConnectorHost, ManualInterfaceAddrs}, + gateway::proxy::wrapped_transport::{ + WrappedTransportEngine, WrappedTransportEngineStart, WrappedTransportEngines, + WrappedTransportRole, + }, + host::testkit::{TestDns, TestHost, TestTcpSocket}, + listener::transport::AcceptedTransport, + peers::peer_manager::PortablePeerManagerConfig, + proto::{common::StunInfo, peer_rpc::GetIpListResponse}, + socket::{SocketContext, udp::PreferredIpv6Source}, + }; + + #[cfg(feature = "proxy-packet")] + use crate::gateway::proxy::wrapped_transport::WrappedTransportKind; + + #[async_trait] + impl ManualConnectorHost for TestHost { + async fn local_addr_for_remote( + &self, + remote_addr: SocketAddr, + _context: SocketContext, + ) -> anyhow::Result { + Ok(match remote_addr { + SocketAddr::V4(_) => "127.0.0.1:0".parse().unwrap(), + SocketAddr::V6(_) => "[::1]:0".parse().unwrap(), + }) + } + + async fn interface_addrs(&self) -> anyhow::Result { + Ok(ManualInterfaceAddrs { + interface_ipv4s: vec![], + interface_ipv6s: vec![], + public_ipv6: None, + }) + } + } + + #[async_trait] + impl DirectConnectorHost for TestHost { + async fn collect_ip_addrs(&self, _context: &SocketContext) -> GetIpListResponse { + GetIpListResponse::default() + } + + fn mapped_listeners(&self) -> Vec { + Vec::new() + } + + fn is_local_ip(&self, _ip: &IpAddr) -> bool { + false + } + + async fn preferred_ipv6_source( + &self, + _ip: Ipv6Addr, + _context: SocketContext, + ) -> Option { + None + } + } + + fn test_config(network_name: &str) -> CoreInstanceConfig { + let mut core = CoreConfig::default(); + core.node.network_name = network_name.to_owned(); + core.peer_policy.encryption_required = false; + let peer = PortablePeerManagerConfig::new(PeerRuntimeConfig { + core, + network_identity: NetworkIdentity { + network_name: network_name.to_owned(), + network_secret: Some(String::new()), + network_secret_digest: None, + }, + stun_info: StunInfo::default(), + feature_flags: Default::default(), + secure_mode: None, + host_routing: HostRoutingPolicy::default(), + }); + let connectivity = CoreConnectivityConfig::default(); + CoreInstanceConfig { + instance_name: network_name.to_owned(), + peer, + connectivity, + vpn_portal: None, + managed_credentials: Vec::new(), + } + } + #[cfg(feature = "vpn-portal")] + fn portal_test_config(network_name: &str) -> CoreInstanceConfig { + let mut config = test_config(network_name); + config.peer.snapshot.runtime.network_identity.network_secret = + Some("portal-network-secret".to_owned()); + config.peer.snapshot.runtime.core.routes.ipv4 = Some(IpPrefix { + address: "10.82.0.1".parse().unwrap(), + prefix_len: 24, + }); + config.vpn_portal = Some(crate::gateway::vpn_portal::PortalRuntimeConfig { + clients: vec![crate::gateway::vpn_portal::PortalClientConfig { + name: "alice".to_owned(), + virtual_ip: "10.82.0.2/24".parse().unwrap(), + groups: Vec::new(), + }], + }); + config + } + + fn runtime_snapshot(config: &CoreInstanceConfig) -> CoreInstanceRuntimeConfig { + CoreInstanceRuntimeConfig { + services: config.connectivity.runtime.clone(), + peer: Arc::new(config.peer.snapshot.clone()), + } + } + + fn proxy_network(real: &str, mapped: Option<&str>) -> ProxyNetworkConfig { + fn prefix(value: &str) -> IpPrefix { + let (address, prefix_len) = value.split_once('/').unwrap(); + IpPrefix { + address: address.parse().unwrap(), + prefix_len: prefix_len.parse().unwrap(), + } + } + + ProxyNetworkConfig { + real: prefix(real), + mapped: mapped.map(prefix), + } + } + + fn adapters( + external_listener_factory: Option< + Arc>>, + >, + packet_sink: Arc, + ) -> CoreHostAdapters { + adapters_with_process_runtime( + external_listener_factory, + packet_sink, + CoreProcessRuntime::new(), + ) + } + + fn adapters_with_process_runtime( + external_listener_factory: Option< + Arc>>, + >, + packet_sink: Arc, + process_runtime: Arc, + ) -> CoreHostAdapters { + adapters_with_host_and_process_runtime( + Arc::new(TestHost::default()), + external_listener_factory, + packet_sink, + process_runtime, + ) + } + + #[cfg(any(feature = "proxy-packet", feature = "proxy-smoltcp-stack"))] + fn adapters_with_host( + host: Arc, + external_listener_factory: Option< + Arc>>, + >, + packet_sink: Arc, + ) -> CoreHostAdapters { + adapters_with_host_and_process_runtime( + host, + external_listener_factory, + packet_sink, + CoreProcessRuntime::new(), + ) + } + + fn adapters_with_host_and_process_runtime( + host: Arc, + external_listener_factory: Option< + Arc>>, + >, + packet_sink: Arc, + process_runtime: Arc, + ) -> CoreHostAdapters { + let dns = Arc::new(TestDns); + let mut adapters = CoreHostAdapters::new(host, dns, packet_sink, process_runtime); + adapters.external_listener_factory = external_listener_factory; + adapters + } + + fn build_with_engines( + config: CoreInstanceConfig, + engines: WrappedTransportEngines, + ) -> anyhow::Result>> { + build_with_engines_and_listener(config, engines, None) + } + + fn build_with_engines_and_listener( + config: CoreInstanceConfig, + engines: WrappedTransportEngines, + external_listener_factory: Option< + Arc>>, + >, + ) -> anyhow::Result>> { + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters(external_listener_factory, Arc::new(packet_sink)); + adapters.wrapped_transports = engines; + CoreInstance::new(config, adapters) + } + + fn build_instance(config: CoreInstanceConfig) -> anyhow::Result>> { + build_with_engines(config, WrappedTransportEngines::default()) + } + + #[cfg(feature = "management")] + struct RecordingConfigPatchPersistence { + writes: std::sync::Mutex>, + fail: AtomicBool, + } + + #[cfg(feature = "management")] + #[async_trait] + impl crate::management::ConfigPatchPersistence for RecordingConfigPatchPersistence { + async fn persist( + &self, + _instance_id: uuid::Uuid, + config: &TomlConfig, + ) -> anyhow::Result<()> { + if self.fail.load(Ordering::Relaxed) { + anyhow::bail!("injected config persistence failure"); + } + self.writes.lock().unwrap().push(config.dump()); + Ok(()) + } + } + + #[cfg(feature = "vpn-portal")] + struct RejectingPortalHost; + + #[cfg(feature = "vpn-portal")] + #[async_trait] + impl crate::gateway::vpn_portal::PortalHost for RejectingPortalHost { + async fn start_listeners( + &self, + ) -> anyhow::Result> { + anyhow::bail!("injected portal start failure") + } + + fn name(&self) -> String { + "rejecting-test-portal".to_owned() + } + + fn render_client_config( + &self, + _plan: &crate::gateway::vpn_portal::PortalClientConfigPlan, + ) -> String { + String::new() + } + + async fn update_clients( + &self, + _clients: &[crate::gateway::vpn_portal::PortalClientConfig], + ) -> anyhow::Result<()> { + anyhow::bail!("injected portal update failure") + } + } + #[cfg(feature = "vpn-portal")] + #[tokio::test] + async fn runtime_update_rejects_portal_client_address_conflict() { + let instance = build_instance(portal_test_config("portal-runtime-update")).unwrap(); + let before = instance.runtime_config.snapshot(); + let mut conflicting = before.as_ref().clone(); + Arc::make_mut(&mut conflicting.peer) + .runtime + .core + .routes + .ipv4 = Some(IpPrefix { + address: "10.82.0.2".parse().unwrap(), + prefix_len: 24, + }); + + let error = instance + .update_runtime_config(conflicting) + .await + .unwrap_err(); + + assert!( + error.to_string().contains("unusable virtual IP"), + "unexpected runtime update error: {error:#}" + ); + assert_eq!( + instance + .runtime_config + .snapshot() + .peer + .runtime + .core + .routes + .ipv4, + before.peer.runtime.core.routes.ipv4 + ); + instance.peer_manager.clear_resources().await; + } + #[cfg(feature = "vpn-portal")] + #[tokio::test] + async fn runtime_update_allows_removing_portal_client_acl_group() { + let mut config = portal_test_config("portal-acl-group-removal"); + config.vpn_portal.as_mut().unwrap().clients[0].groups = vec!["ops".to_owned()]; + config.peer.snapshot.acl_group_declarations = + vec![crate::config::peers::PeerGroupIdentity { + group_name: "ops".to_owned(), + group_secret: "ops-secret".to_owned(), + }]; + let instance = build_instance(config).unwrap(); + let mut updated = instance.runtime_config.snapshot().as_ref().clone(); + Arc::make_mut(&mut updated.peer) + .acl_group_declarations + .clear(); + + instance.update_runtime_config(updated).await.unwrap(); + + assert!( + instance + .runtime_config + .snapshot() + .peer + .acl_group_declarations + .is_empty() + ); + instance.peer_manager.clear_resources().await; + } + + #[cfg(feature = "dhcp-ipv4")] + #[tokio::test] + async fn runtime_update_preserves_dhcp_owned_ipv4() { + let mut initial = test_config("dhcp-runtime-update"); + initial.connectivity.runtime.dhcp_ipv4 = true; + let instance = build_instance(initial).unwrap(); + let lease = IpPrefix { + address: "10.126.126.7".parse().unwrap(), + prefix_len: 24, + }; + instance.runtime_config.update_peer_with(|peer| { + peer.runtime.core.routes.ipv4 = Some(lease.clone()); + }); + + let mut replacement = test_config("dhcp-runtime-update"); + replacement.connectivity.runtime.dhcp_ipv4 = true; + instance + .update_runtime_config(runtime_snapshot(&replacement)) + .await + .unwrap(); + + assert_eq!( + instance + .runtime_config + .snapshot() + .peer + .runtime + .core + .routes + .ipv4, + Some(lease) + ); + + let static_replacement = test_config("dhcp-runtime-update"); + instance + .update_runtime_config(runtime_snapshot(&static_replacement)) + .await + .unwrap(); + assert_eq!( + instance + .runtime_config + .snapshot() + .peer + .runtime + .core + .routes + .ipv4, + None + ); + } + + #[tokio::test] + async fn core_instance_is_a_direct_managed_record() { + let instance = build_instance(test_config("managed-directly")).unwrap(); + + assert_eq!(instance.instance_name(), "managed-directly"); + assert_eq!( + instance.instance_id(), + crate::instance::manager::ManagedInstance::instance_id(instance.as_ref()) + ); + } + + #[tokio::test] + async fn instance_start_ignores_configured_peer_id() { + let mut config = test_config("fresh-peer-id"); + let instance_id = uuid::Uuid::from_bytes([7; 16]); + config.peer.snapshot.runtime.core.node.instance_id = Some(*instance_id.as_bytes()); + config.peer.snapshot.runtime.core.node.peer_id = Some(0); + + let instance = build_instance(config).unwrap(); + let generated_peer_id = instance.peer_id(); + + assert_eq!(instance.instance_id(), instance_id); + assert_ne!(generated_peer_id, 0); + assert_eq!( + instance + .runtime_config + .snapshot() + .peer + .runtime + .core + .node + .peer_id, + Some(generated_peer_id) + ); + } + + #[cfg(all(feature = "proxy-packet", feature = "management"))] + #[tokio::test] + async fn process_management_rpc_resolves_and_calls_core_instance_directly() { + use crate::{ + config::toml::TomlConfig, + instance::manager::{InstanceFactory, InstanceManager}, + management::InstanceManagementRpc, + }; + use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; + use easytier_proto::{ + api::config::{ConfigRpc, GetConfigRequest, InstanceConfigPatch, PatchConfigRequest}, + api::instance::{ + PeerManageRpc, ShowNodeInfoRequest, + instance_identifier::{InstanceSelector, Selector}, + }, + api::manage::{ManagedCredentialConfig, ManagedCredentialSet}, + rpc_types::controller::BaseController, + }; + + struct ManagementTestFactory; + + impl InstanceFactory for ManagementTestFactory { + type Instance = CoreInstance; + type CreateContext = (); + type Error = anyhow::Error; + + fn create( + &self, + config: TomlConfig, + (): Self::CreateContext, + ) -> Result, Self::Error> { + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters(None, Arc::new(packet_sink)); + adapters.config.force_exit_node = true; + adapters.config.public_ipv6_provider_supported = true; + adapters.config.easytier_version = "host-version".to_owned(); + CoreInstance::from_toml(config, adapters) + } + } + + let manager = Arc::new(InstanceManager::new(ManagementTestFactory, None)); + let config = TomlConfig::new_from_str( + r#" +instance_name = "managed-by-name" +hostname = "core-owned-config" + +[network_identity] +network_name = "managed-network" +network_secret = "network-secret" +"#, + ) + .unwrap(); + let instance = manager.create(config, ()).unwrap(); + instance.start().await.unwrap(); + let rpc = InstanceManagementRpc::::new(manager); + + let response = rpc + .show_node_info( + BaseController::default(), + ShowNodeInfoRequest { + instance: Some(easytier_proto::api::instance::InstanceIdentifier { + selector: Some(Selector::InstanceSelector(InstanceSelector { + name: Some("managed-by-name".to_owned()), + })), + }), + }, + ) + .await + .unwrap(); + + let node = response.node_info.unwrap(); + assert_eq!(node.hostname, "core-owned-config"); + assert!(node.config.contains("instance_name = \"managed-by-name\"")); + + let selector = || easytier_proto::api::instance::InstanceIdentifier { + selector: Some(Selector::InstanceSelector(InstanceSelector { + name: Some("managed-by-name".to_owned()), + })), + }; + rpc.patch_config( + BaseController::default(), + PatchConfigRequest { + patch: Some(InstanceConfigPatch { + hostname: Some("patched-in-core".to_owned()), + ..Default::default() + }), + instance: Some(selector()), + }, + ) + .await + .unwrap(); + let response = rpc + .get_config( + BaseController::default(), + GetConfigRequest { + instance: Some(selector()), + }, + ) + .await + .unwrap(); + assert_eq!( + response.config.unwrap().hostname.as_deref(), + Some("patched-in-core") + ); + + let secret = BASE64_STANDARD.encode([9u8; 32]); + rpc.patch_config( + BaseController::default(), + PatchConfigRequest { + patch: Some(InstanceConfigPatch { + managed_credentials: Some(ManagedCredentialSet { + entries: vec![ManagedCredentialConfig { + credential_id: "pathless".to_owned(), + credential_secret: secret.clone(), + expiry_unix: i64::MAX, + ..Default::default() + }], + }), + ..Default::default() + }), + instance: Some(selector()), + }, + ) + .await + .unwrap(); + let response = rpc + .get_config( + BaseController::default(), + GetConfigRequest { + instance: Some(selector()), + }, + ) + .await + .unwrap(); + assert_eq!( + response.config.unwrap().managed_credentials, + vec![ManagedCredentialConfig { + credential_id: "pathless".to_owned(), + credential_secret: secret, + expiry_unix: i64::MAX, + reusable: Some(true), + ..Default::default() + }] + ); + let runtime = instance.runtime_config.snapshot(); + assert!(runtime.services.proxy.enable_exit_node); + assert!(runtime.services.public_ipv6_provider.provider_supported); + assert_eq!(runtime.peer.easytier_version, "host-version"); + } + + #[cfg(feature = "management")] + #[tokio::test] + async fn config_patch_rejects_instance_before_host_startup_is_complete() { + let instance = build_instance(test_config("not-ready-for-patch")).unwrap(); + + let error = crate::management::apply_config_patch( + &instance, + easytier_proto::api::config::InstanceConfigPatch { + hostname: Some("too-early".to_owned()), + ..Default::default() + }, + None, + ) + .await + .unwrap_err(); + + assert!(error.to_string().contains("instance is not ready")); + } + + #[cfg(feature = "management")] + #[tokio::test] + async fn managed_credential_patch_is_durable_atomic_and_does_not_restart() { + use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; + use easytier_proto::api::{ + config::InstanceConfigPatch, + manage::{ManagedCredentialConfig, ManagedCredentialSet}, + }; + + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let config = TomlConfig::new_from_str( + r#" +[network_identity] +network_name = "managed-network" +network_secret = "network-secret" + +[source] +source = "web" +"#, + ) + .unwrap(); + let instance = + CoreInstance::from_toml(config, adapters(None, Arc::new(packet_sink))).unwrap(); + instance.start().await.unwrap(); + let peer_id = instance.peer_id(); + let secret = BASE64_STANDARD.encode([7u8; 32]); + let patch = InstanceConfigPatch { + managed_credentials: Some(ManagedCredentialSet { + entries: vec![ManagedCredentialConfig { + credential_id: "managed".to_owned(), + credential_secret: secret.clone(), + groups: vec!["ops".to_owned()], + allow_relay: false, + allowed_proxy_cidrs: Vec::new(), + expiry_unix: 2_000_000_000, + reusable: Some(true), + }], + }), + ..Default::default() + }; + let persistence = RecordingConfigPatchPersistence { + writes: std::sync::Mutex::new(Vec::new()), + fail: AtomicBool::new(true), + }; + + let error = + crate::management::apply_config_patch(&instance, patch.clone(), Some(&persistence)) + .await + .unwrap_err(); + assert!( + error + .to_string() + .contains("injected config persistence failure") + ); + assert!( + instance + .toml_config() + .unwrap() + .get_managed_credentials() + .is_empty() + ); + let private_bytes: [u8; 32] = BASE64_STANDARD.decode(&secret).unwrap().try_into().unwrap(); + let public_key = + x25519_dalek::PublicKey::from(&x25519_dalek::StaticSecret::from(private_bytes)); + assert!( + !instance + .credential_manager() + .is_pubkey_trusted(public_key.as_bytes()) + ); + + persistence.fail.store(false, Ordering::Relaxed); + crate::management::apply_config_patch(&instance, patch, Some(&persistence)) + .await + .unwrap(); + + assert_eq!(instance.peer_id(), peer_id); + assert_eq!(instance.state(), CoreInstanceState::Running); + assert!( + instance + .credential_manager() + .is_pubkey_trusted(public_key.as_bytes()) + ); + assert_eq!( + instance + .toml_config() + .unwrap() + .get_managed_credentials() + .len(), + 1 + ); + let persisted = persistence.writes.lock().unwrap(); + assert_eq!(persisted.len(), 1); + assert!(persisted[0].contains(&secret)); + } + + #[cfg(feature = "management")] + #[tokio::test] + async fn ordinary_config_patch_is_durable_before_commit() { + use easytier_proto::api::config::InstanceConfigPatch; + + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let config = TomlConfig::new_from_str( + r#" +instance_name = "durable-ordinary-patch" +hostname = "before" + +[network_identity] +network_name = "durable-network" +network_secret = "network-secret" + +[source] +source = "web" +"#, + ) + .unwrap(); + let instance = + CoreInstance::from_toml(config, adapters(None, Arc::new(packet_sink))).unwrap(); + instance.start().await.unwrap(); + let patch = InstanceConfigPatch { + hostname: Some("after".to_owned()), + ..Default::default() + }; + let persistence = RecordingConfigPatchPersistence { + writes: std::sync::Mutex::new(Vec::new()), + fail: AtomicBool::new(true), + }; + + let error = + crate::management::apply_config_patch(&instance, patch.clone(), Some(&persistence)) + .await + .unwrap_err(); + assert!( + error + .to_string() + .contains("injected config persistence failure") + ); + assert_eq!(instance.toml_config().unwrap().get_hostname(), "before"); + + persistence.fail.store(false, Ordering::Relaxed); + crate::management::apply_config_patch(&instance, patch, Some(&persistence)) + .await + .unwrap(); + + assert_eq!(instance.toml_config().unwrap().get_hostname(), "after"); + { + let persisted = persistence.writes.lock().unwrap(); + assert_eq!(persisted.len(), 1); + assert!(persisted[0].contains("hostname = \"after\"")); + } + instance.stop().await; + } + + #[cfg(all(feature = "management", feature = "vpn-portal"))] + #[tokio::test] + async fn portal_client_patch_restores_durable_state_after_failures() { + use easytier_proto::api::{ + config::{ConfigPatchAction, InstanceConfigPatch, VpnPortalClientPatch}, + manage::VpnPortalClientConfig, + }; + + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut host_adapters = adapters(None, Arc::new(packet_sink)); + host_adapters.vpn_portal = Some(Arc::new(RejectingPortalHost)); + let instance = CoreInstance::from_toml( + TomlConfig::new_from_str( + r#" +instance_name = "durable-portal-patch" +ipv4 = "10.82.0.1/24" + +[network_identity] +network_name = "durable-portal-network" +network_secret = "network-secret" + +[vpn_portal_config] +wireguard_listen = "0.0.0.0:51820" + +[[vpn_portal_config.clients]] +name = "alice" +virtual_ip = "10.82.0.2/24" + +[source] +source = "web" +"#, + ) + .unwrap(), + host_adapters, + ) + .unwrap(); + instance.set_state(CoreInstanceState::Running); + let persistence = RecordingConfigPatchPersistence { + writes: std::sync::Mutex::new(Vec::new()), + fail: AtomicBool::new(true), + }; + + let error = crate::management::apply_config_patch( + &instance, + InstanceConfigPatch { + vpn_portal_clients: vec![ + VpnPortalClientPatch { + action: ConfigPatchAction::Remove as i32, + client: Some(VpnPortalClientConfig { + name: "alice".to_owned(), + ..Default::default() + }), + }, + VpnPortalClientPatch { + action: ConfigPatchAction::Add as i32, + client: Some(VpnPortalClientConfig { + name: "bob".to_owned(), + virtual_ip: "10.82.0.3/24".to_owned(), + ..Default::default() + }), + }, + ], + ..Default::default() + }, + Some(&persistence), + ) + .await + .unwrap_err(); + + assert!( + error + .to_string() + .contains("injected config persistence failure") + ); + let clients = instance + .toml_config() + .unwrap() + .get_vpn_portal_config() + .unwrap() + .clients; + assert_eq!(clients.len(), 1); + assert_eq!(clients[0].name, "alice"); + assert!(persistence.writes.lock().unwrap().is_empty()); + + persistence.fail.store(false, Ordering::Relaxed); + let error = crate::management::apply_config_patch( + &instance, + InstanceConfigPatch { + vpn_portal_clients: vec![ + VpnPortalClientPatch { + action: ConfigPatchAction::Remove as i32, + client: Some(VpnPortalClientConfig { + name: "alice".to_owned(), + ..Default::default() + }), + }, + VpnPortalClientPatch { + action: ConfigPatchAction::Add as i32, + client: Some(VpnPortalClientConfig { + name: "bob".to_owned(), + virtual_ip: "10.82.0.3/24".to_owned(), + ..Default::default() + }), + }, + ], + ..Default::default() + }, + Some(&persistence), + ) + .await + .unwrap_err(); + assert!(error.to_string().contains("injected portal update failure")); + + crate::management::apply_config_patch( + &instance, + InstanceConfigPatch { + hostname: Some("after-rollback".to_owned()), + ..Default::default() + }, + Some(&persistence), + ) + .await + .unwrap(); + + { + let persisted = persistence.writes.lock().unwrap(); + assert_eq!(persisted.len(), 3); + assert!(persisted[0].contains("name = \"bob\"")); + assert!(persisted[1].contains("name = \"alice\"")); + assert!(persisted[2].contains("name = \"alice\"")); + assert!(!persisted[2].contains("name = \"bob\"")); + } + instance.peer_manager.clear_resources().await; + } + + #[cfg(all(feature = "management", not(feature = "proxy-smoltcp-stack")))] + #[tokio::test] + async fn unavailable_gateway_patch_does_not_commit_shared_toml() { + use easytier_proto::{ + api::config::{ConfigPatchAction, InstanceConfigPatch, PortForwardPatch}, + common::{PortForwardConfigPb, SocketType}, + }; + + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let instance = CoreInstance::from_toml( + crate::config::toml::TomlConfig::new_from_str( + "instance_name = \"rejected-gateway-patch\"", + ) + .unwrap(), + adapters(None, Arc::new(packet_sink)), + ) + .unwrap(); + instance.start().await.unwrap(); + + let error = crate::management::apply_config_patch( + &instance, + InstanceConfigPatch { + port_forwards: vec![PortForwardPatch { + action: ConfigPatchAction::Add as i32, + cfg: Some(PortForwardConfigPb { + bind_addr: Some( + "127.0.0.1:18080" + .parse::() + .unwrap() + .into(), + ), + dst_addr: Some( + "10.144.144.2:8080" + .parse::() + .unwrap() + .into(), + ), + socket_type: SocketType::Tcp as i32, + }), + }], + ..Default::default() + }, + None, + ) + .await + .unwrap_err(); + + assert!( + error + .to_string() + .contains("does not include the smoltcp gateway"), + "unexpected patch error: {error:#}" + ); + assert!( + instance + .toml_config() + .unwrap() + .get_port_forwards() + .is_empty() + ); + assert!( + instance + .runtime_config + .snapshot() + .services + .gateway + .port_forwards + .is_empty() + ); + instance.stop().await; + } + #[cfg(all(feature = "management", feature = "vpn-portal"))] + #[tokio::test] + async fn rejected_portal_address_patch_does_not_commit_shared_toml() { + use easytier_proto::api::config::InstanceConfigPatch; + + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let instance = CoreInstance::from_toml( + crate::config::toml::TomlConfig::new_from_str( + r#" +instance_name = "rejected-portal-address-patch" +ipv4 = "10.82.0.1/24" + +[network_identity] +network_name = "rejected-portal-address-patch" +network_secret = "portal-network-secret" + +[vpn_portal_config] +wireguard_listen = "0.0.0.0:51820" + +[[vpn_portal_config.clients]] +name = "alice" +virtual_ip = "10.82.0.2/24" +"#, + ) + .unwrap(), + adapters(None, Arc::new(packet_sink)), + ) + .unwrap(); + instance.set_state(CoreInstanceState::Running); + + let error = crate::management::apply_config_patch( + &instance, + InstanceConfigPatch { + ipv4: Some("10.82.0.2/24".parse::().unwrap().into()), + ..Default::default() + }, + None, + ) + .await + .unwrap_err(); + + assert!( + error.to_string().contains("unusable virtual IP"), + "unexpected config patch error: {error:#}" + ); + assert_eq!( + instance.toml_config().unwrap().get_ipv4().unwrap(), + "10.82.0.1/24".parse().unwrap() + ); + assert_eq!( + instance + .runtime_config + .snapshot() + .peer + .runtime + .core + .routes + .ipv4 + .as_ref() + .unwrap() + .address, + "10.82.0.1".parse::().unwrap() + ); + instance.peer_manager.clear_resources().await; + } + + #[cfg(feature = "web-client")] + #[tokio::test] + async fn ignored_gateway_patch_remains_in_toml_config() { + use easytier_proto::{ + api::config::{ConfigPatchAction, InstanceConfigPatch, PortForwardPatch, UrlPatch}, + common::{PortForwardConfigPb, SocketType}, + }; + + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let toml_config = crate::config::toml::TomlConfig::new_from_str( + "instance_name = \"ignored-gateway-patch\"", + ) + .unwrap(); + let mut host_adapters = adapters(None, Arc::new(packet_sink)); + host_adapters.config.ignore_unsupported_config = true; + host_adapters.config.gateway_enabled = false; + host_adapters.config.endpoint_protocols = vec!["tcp".to_owned(), "udp".to_owned()]; + let instance = CoreInstance::from_toml(toml_config, host_adapters).unwrap(); + instance.start().await.unwrap(); + + crate::management::apply_config_patch( + &instance, + InstanceConfigPatch { + port_forwards: vec![PortForwardPatch { + action: ConfigPatchAction::Add as i32, + cfg: Some(PortForwardConfigPb { + bind_addr: Some( + "127.0.0.1:18080" + .parse::() + .unwrap() + .into(), + ), + dst_addr: Some( + "10.144.144.2:8080" + .parse::() + .unwrap() + .into(), + ), + socket_type: SocketType::Tcp as i32, + }), + }], + connectors: vec![UrlPatch { + action: ConfigPatchAction::Add as i32, + url: Some("quic://127.0.0.1:11010".parse::().unwrap().into()), + }], + ..Default::default() + }, + None, + ) + .await + .unwrap(); + + assert_eq!(instance.toml_config().unwrap().get_port_forwards().len(), 1); + assert!( + instance + .runtime_config + .snapshot() + .services + .gateway + .port_forwards + .is_empty() + ); + assert!(instance.list_connectors().is_empty()); + instance.stop().await; + } + + #[tokio::test] + async fn dropping_core_instance_requests_host_shutdown() { + struct DropAwareRuntimeHost(Arc); + + #[async_trait] + impl InstanceRuntimeHost for DropAwareRuntimeHost { + async fn prepare( + &self, + _packet_plane: Arc, + ) -> anyhow::Result>> { + Ok(None) + } + + async fn shutdown(&self) {} + + fn request_shutdown(&self) { + self.0.store(true, Ordering::Release); + } + } + + let shutdown_requested = Arc::new(AtomicBool::new(false)); + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters(None, Arc::new(packet_sink)); + adapters.instance_runtime = Arc::new(DropAwareRuntimeHost(shutdown_requested.clone())); + let instance = CoreInstance::new(test_config("drop-cleanup"), adapters).unwrap(); + + drop(instance); + + assert!(shutdown_requested.load(Ordering::Acquire)); + } + + #[tokio::test] + async fn host_prepare_failure_runs_unified_cleanup() { + #[derive(Default)] + struct FailingRuntimeHost { + shutdown_calls: AtomicUsize, + } + + #[async_trait] + impl InstanceRuntimeHost for FailingRuntimeHost { + async fn prepare( + &self, + _packet_plane: Arc, + ) -> anyhow::Result>> { + anyhow::bail!("host prepare failed") + } + + async fn shutdown(&self) { + self.shutdown_calls.fetch_add(1, Ordering::Relaxed); + } + } + + let runtime_host = Arc::new(FailingRuntimeHost::default()); + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters(None, Arc::new(packet_sink)); + adapters.instance_runtime = runtime_host.clone(); + let instance = CoreInstance::new(test_config("host-prepare-failure"), adapters).unwrap(); + + let error = instance.start().await.unwrap_err(); + + assert!(error.to_string().contains("host prepare failed")); + assert_eq!(instance.state(), CoreInstanceState::Stopped); + assert!(!instance.is_ready()); + assert_eq!(runtime_host.shutdown_calls.load(Ordering::Relaxed), 1); + assert!( + instance + .latest_error() + .unwrap() + .contains("host prepare failed") + ); + } + + #[tokio::test] + async fn manager_reports_only_stopped_instances_with_errors() { + use crate::instance::manager::{InstanceFactory, InstanceManager}; + + struct StateTestFactory; + + impl InstanceFactory for StateTestFactory { + type Instance = CoreInstance; + type CreateContext = (); + type Error = anyhow::Error; + + fn create( + &self, + config: TomlConfig, + (): Self::CreateContext, + ) -> Result, Self::Error> { + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + CoreInstance::from_toml(config, adapters(None, Arc::new(packet_sink))) + } + } + + fn create_instance( + manager: &InstanceManager, + name: &str, + ) -> Arc> { + let config = TomlConfig::new_from_str(&format!("instance_name = \"{name}\"")).unwrap(); + manager.create(config, ()).unwrap() + } + + let manager = InstanceManager::new(StateTestFactory, None); + let running = create_instance(&manager, "running"); + running + .latest_error + .write() + .replace("old startup error".to_owned()); + running.set_state(CoreInstanceState::Running); + + let starting = create_instance(&manager, "starting"); + starting + .latest_error + .write() + .replace("old startup error".to_owned()); + starting.set_state(CoreInstanceState::Starting); + + let stopped_without_error = create_instance(&manager, "stopped-without-error"); + stopped_without_error.set_state(CoreInstanceState::Stopped); + + let stopped_with_blank_error = create_instance(&manager, "stopped-with-blank-error"); + stopped_with_blank_error + .latest_error + .write() + .replace(" \n".to_owned()); + stopped_with_blank_error.set_state(CoreInstanceState::Stopped); + + let failed = create_instance(&manager, "failed"); + failed + .latest_error + .write() + .replace("startup failed".to_owned()); + failed.set_state(CoreInstanceState::Stopped); + let failed_id = failed.instance_id(); + + assert_eq!(manager.failed_instance_ids(), vec![failed_id]); + + manager.delete_network_instances([failed_id]).await.unwrap(); + assert!(manager.failed_instance_ids().is_empty()); + } + + #[tokio::test] + async fn aborting_host_prepare_runs_unified_cleanup() { + #[derive(Default)] + struct BlockingPrepareRuntimeHost { + prepare_started: Notify, + prepare_release: Notify, + shutdown_calls: AtomicUsize, + } + + #[async_trait] + impl InstanceRuntimeHost for BlockingPrepareRuntimeHost { + async fn prepare( + &self, + _packet_plane: Arc, + ) -> anyhow::Result>> { + self.prepare_started.notify_one(); + self.prepare_release.notified().await; + Ok(None) + } + + async fn shutdown(&self) { + self.shutdown_calls.fetch_add(1, Ordering::Relaxed); + } + } + + let runtime_host = Arc::new(BlockingPrepareRuntimeHost::default()); + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters(None, Arc::new(packet_sink)); + adapters.instance_runtime = runtime_host.clone(); + let instance = CoreInstance::new(test_config("aborted-host-prepare"), adapters).unwrap(); + let start = tokio::spawn({ + let instance = instance.clone(); + async move { instance.start().await } + }); + runtime_host.prepare_started.notified().await; + + start.abort(); + assert!(start.await.unwrap_err().is_cancelled()); + tokio::time::timeout(Duration::from_secs(2), async { + while instance.state() != CoreInstanceState::Stopped { + tokio::task::yield_now().await; + } + }) + .await + .expect("aborted Host prepare should stop the instance"); + + assert!(!instance.is_ready()); + assert_eq!(runtime_host.shutdown_calls.load(Ordering::Relaxed), 1); + } + + #[cfg(feature = "management")] + #[tokio::test] + async fn cancelled_delete_finishes_stop_and_keeps_wait_blocked() { + use std::{path::Path, path::PathBuf}; + + use crate::{ + config::toml::TomlConfig, + instance::manager::InstanceFactory, + management::{ + ConfigFileControl, ConfigFilePermission, ConfigFileStorage, InstanceManager, + InstanceMutationHooks, ProcessManagementRpc, + }, + }; + use easytier_proto::{ + api::manage::{DeleteNetworkInstanceRequest, WebClientService}, + rpc_types::controller::BaseController, + }; + + #[derive(Default)] + struct BlockingRuntimeHost { + shutdown_started: Notify, + shutdown_release: Notify, + } + + #[async_trait] + impl InstanceRuntimeHost for BlockingRuntimeHost { + async fn prepare( + &self, + _packet_plane: Arc, + ) -> anyhow::Result>> { + Ok(None) + } + + async fn shutdown(&self) { + self.shutdown_started.notify_one(); + self.shutdown_release.notified().await; + } + } + + struct BlockingFactory { + runtime_host: Arc, + process_runtime: Arc, + } + + impl InstanceFactory for BlockingFactory { + type Instance = CoreInstance; + type CreateContext = (); + type Error = anyhow::Error; + + fn create( + &self, + config: TomlConfig, + (): Self::CreateContext, + ) -> Result, Self::Error> { + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters_with_process_runtime( + None, + Arc::new(packet_sink), + self.process_runtime.clone(), + ); + adapters.instance_runtime = self.runtime_host.clone(); + CoreInstance::from_toml(config, adapters) + } + } + + impl crate::management::ProcessRuntimeProvider for BlockingFactory { + fn process_runtime(&self) -> Arc { + self.process_runtime.clone() + } + } + + #[derive(Default)] + struct RecordingStorage(AtomicBool); + + #[async_trait] + impl ConfigFileStorage for RecordingStorage { + async fn inspect(&self, path: &Path) -> ConfigFileControl { + ConfigFileControl::new(Some(path.to_owned()), ConfigFilePermission::default()) + } + + async fn read(&self, _path: &Path) -> anyhow::Result>> { + Ok(None) + } + + async fn write(&self, _path: &Path, _contents: &[u8]) -> anyhow::Result<()> { + Ok(()) + } + + async fn remove(&self, _path: &Path) -> anyhow::Result<()> { + self.0.store(true, Ordering::Release); + Ok(()) + } + } + + #[derive(Default)] + struct RecordingHooks(AtomicBool); + + #[async_trait] + impl InstanceMutationHooks for RecordingHooks { + async fn post_remove_network_instances( + &self, + _instance_ids: &[uuid::Uuid], + ) -> Result<(), String> { + self.0.store(true, Ordering::Release); + Ok(()) + } + } + + let runtime_host = Arc::new(BlockingRuntimeHost::default()); + let process_runtime = CoreProcessRuntime::new(); + let instances = Arc::new(InstanceManager::new( + BlockingFactory { + runtime_host: runtime_host.clone(), + process_runtime, + }, + Some(tokio::runtime::Handle::current()), + )); + let config = TomlConfig::default(); + config.set_listeners(Vec::new()); + let instance_id = config.get_id(); + instances + .run_network_instance( + config, + ConfigFileControl::new( + Some(PathBuf::from("cancelled-delete.toml")), + ConfigFilePermission::default(), + ), + ) + .unwrap(); + let storage = Arc::new(RecordingStorage::default()); + let hooks = Arc::new(RecordingHooks::default()); + let rpc = ProcessManagementRpc::::new( + instances.clone(), + hooks.clone(), + storage.clone(), + ); + + let deletion = tokio::spawn(async move { + rpc.delete_network_instance( + BaseController::default(), + DeleteNetworkInstanceRequest { + inst_ids: vec![instance_id.into()], + }, + ) + .await + }); + runtime_host.shutdown_started.notified().await; + deletion.abort(); + assert!(deletion.await.unwrap_err().is_cancelled()); + + let mut wait = tokio::spawn({ + let instances = instances.clone(); + async move { instances.wait().await } + }); + assert!( + tokio::time::timeout(Duration::from_millis(20), &mut wait) + .await + .is_err() + ); + + runtime_host.shutdown_release.notify_one(); + tokio::time::timeout(Duration::from_secs(1), async { + while !storage.0.load(Ordering::Acquire) { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + tokio::time::timeout(Duration::from_secs(1), wait) + .await + .unwrap() + .unwrap(); + assert!(hooks.0.load(Ordering::Acquire)); + assert!(instances.instances().is_empty()); + } + + #[cfg(feature = "web-client")] + #[tokio::test] + async fn process_management_rpc_owns_instance_create_list_and_delete() { + use crate::{ + config::toml::TomlConfig, + instance::manager::InstanceFactory, + management::{ + InstanceManager, ProcessManagementRpc, UnsupportedConfigFileStorage, + register_web_client_rpc, + }, + rpc::service_registry::ServiceRegistry, + }; + use easytier_proto::{ + api::manage::{ + DeleteNetworkInstanceRequest, ListNetworkInstanceRequest, NetworkConfig, + NetworkingMethod, RunNetworkInstanceRequest, WebClientService, + }, + common::RpcDescriptor, + rpc_types::controller::BaseController, + }; + + struct ManagementTestFactory(Arc); + + impl InstanceFactory for ManagementTestFactory { + type Instance = CoreInstance; + type CreateContext = (); + type Error = anyhow::Error; + + fn create( + &self, + config: TomlConfig, + (): Self::CreateContext, + ) -> Result, Self::Error> { + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + CoreInstance::from_toml( + config, + adapters_with_process_runtime(None, Arc::new(packet_sink), self.0.clone()), + ) + } + } + + impl crate::management::ProcessRuntimeProvider for ManagementTestFactory { + fn process_runtime(&self) -> Arc { + self.0.clone() + } + } + + let instances = Arc::new(InstanceManager::new( + ManagementTestFactory(CoreProcessRuntime::new()), + Some(tokio::runtime::Handle::current()), + )); + let registry = ServiceRegistry::new(); + register_web_client_rpc( + instances.clone(), + ®istry, + Arc::new(()), + Arc::new(UnsupportedConfigFileStorage), + ); + assert_eq!( + registry.get_method_name(&RpcDescriptor { + domain_name: String::new(), + service_name: "ConfigRpc".to_owned(), + proto_name: "ConfigRpc".to_owned(), + method_index: 2, + }), + Some("get_config".to_owned()) + ); + assert_eq!( + registry.get_method_name(&RpcDescriptor { + domain_name: String::new(), + service_name: "WebClientService".to_owned(), + proto_name: "WebClientService".to_owned(), + method_index: 1, + }), + Some("validate_config".to_owned()) + ); + let rpc = ProcessManagementRpc::::new( + instances.clone(), + Arc::new(()), + Arc::new(UnsupportedConfigFileStorage), + ); + let created = rpc + .run_network_instance( + BaseController::default(), + RunNetworkInstanceRequest { + config: Some(NetworkConfig { + network_name: Some("managed-process-rpc".to_owned()), + networking_method: Some(NetworkingMethod::Standalone.into()), + ..Default::default() + }), + overwrite: true, + ..Default::default() + }, + ) + .await + .unwrap() + .inst_id + .unwrap(); + + let listed = rpc + .list_network_instance(BaseController::default(), ListNetworkInstanceRequest {}) + .await + .unwrap(); + assert_eq!(listed.inst_ids, vec![created]); + + let deleted = rpc + .delete_network_instance( + BaseController::default(), + DeleteNetworkInstanceRequest { + inst_ids: vec![created], + }, + ) + .await + .unwrap(); + assert!(deleted.remain_inst_ids.is_empty()); + assert!(instances.instances().is_empty()); + } + + #[cfg(feature = "web-client")] + #[tokio::test] + async fn process_management_rpc_collects_only_requested_instances() { + use std::{collections::VecDeque, sync::Mutex as StdMutex}; + + use crate::{ + config::toml::TomlConfig, + instance::manager::InstanceFactory, + management::{InstanceManager, ProcessManagementRpc, UnsupportedConfigFileStorage}, + }; + use easytier_proto::{ + api::manage::{CollectNetworkInfoRequest, WebClientService}, + rpc_types::controller::BaseController, + }; + + #[derive(Default)] + struct RecordingRuntimeHost { + collection_count: AtomicUsize, + } + + #[async_trait] + impl InstanceRuntimeHost for RecordingRuntimeHost { + async fn prepare( + &self, + _packet_plane: Arc, + ) -> anyhow::Result>> { + Ok(None) + } + + async fn shutdown(&self) {} + + fn management_events(&self) -> Vec { + self.collection_count.fetch_add(1, Ordering::Relaxed); + Vec::new() + } + } + + struct RecordingFactory { + process_runtime: Arc, + runtime_hosts: StdMutex>>, + } + + impl InstanceFactory for RecordingFactory { + type Instance = CoreInstance; + type CreateContext = (); + type Error = anyhow::Error; + + fn create( + &self, + config: TomlConfig, + (): Self::CreateContext, + ) -> Result, Self::Error> { + let runtime_host = self.runtime_hosts.lock().unwrap().pop_front().unwrap(); + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters_with_process_runtime( + None, + Arc::new(packet_sink), + self.process_runtime.clone(), + ); + adapters.instance_runtime = runtime_host; + CoreInstance::from_toml(config, adapters) + } + } + + let requested_runtime = Arc::new(RecordingRuntimeHost::default()); + let unrequested_runtime = Arc::new(RecordingRuntimeHost::default()); + let instances = Arc::new(InstanceManager::new( + RecordingFactory { + process_runtime: CoreProcessRuntime::new(), + runtime_hosts: StdMutex::new(VecDeque::from([ + requested_runtime.clone(), + unrequested_runtime.clone(), + ])), + }, + Some(tokio::runtime::Handle::current()), + )); + let requested_id = uuid::Uuid::new_v4(); + let unrequested_id = uuid::Uuid::new_v4(); + for instance_id in [requested_id, unrequested_id] { + let config = TomlConfig::default(); + config.set_id(instance_id); + config.set_listeners(Vec::new()); + instances + .create(config, ()) + .unwrap() + .set_state(CoreInstanceState::Running); + } + let rpc = ProcessManagementRpc::::new( + instances, + Arc::new(()), + Arc::new(UnsupportedConfigFileStorage), + ); + + let response = rpc + .collect_network_info( + BaseController::default(), + CollectNetworkInfoRequest { + inst_ids: vec![ + requested_id.into(), + requested_id.into(), + uuid::Uuid::new_v4().into(), + ], + }, + ) + .await + .unwrap(); + let info = response.info.unwrap().map; + assert_eq!(info.len(), 1); + assert!(info.contains_key(&requested_id.to_string())); + assert_eq!( + requested_runtime.collection_count.load(Ordering::Relaxed), + 1 + ); + assert_eq!( + unrequested_runtime.collection_count.load(Ordering::Relaxed), + 0 + ); + + let response = rpc + .collect_network_info( + BaseController::default(), + CollectNetworkInfoRequest::default(), + ) + .await + .unwrap(); + assert_eq!(response.info.unwrap().map.len(), 2); + assert_eq!( + requested_runtime.collection_count.load(Ordering::Relaxed), + 2 + ); + assert_eq!( + unrequested_runtime.collection_count.load(Ordering::Relaxed), + 1 + ); + } + + #[cfg(feature = "management")] + #[tokio::test] + async fn owned_selection_and_cleanup_share_the_canonical_transaction() { + use crate::{ + config::toml::TomlConfig, + instance::manager::InstanceFactory, + management::{ + ConfigFileControl, InstanceManager, InstanceMutationHooks, ProcessManagement, + UnsupportedConfigFileStorage, + }, + }; + + struct ManagementTestFactory(Arc); + + impl InstanceFactory for ManagementTestFactory { + type Instance = CoreInstance; + type CreateContext = (); + type Error = anyhow::Error; + + fn create( + &self, + config: TomlConfig, + (): Self::CreateContext, + ) -> Result, Self::Error> { + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + CoreInstance::from_toml( + config, + adapters_with_process_runtime(None, Arc::new(packet_sink), self.0.clone()), + ) + } + } + + impl crate::management::ProcessRuntimeProvider for ManagementTestFactory { + fn process_runtime(&self) -> Arc { + self.0.clone() + } + } + + #[derive(Default)] + struct BlockingRemovalHook { + entered: Notify, + release: Notify, + removed: std::sync::Mutex>>, + } + + #[async_trait] + impl InstanceMutationHooks for BlockingRemovalHook { + async fn post_remove_network_instances( + &self, + instance_ids: &[uuid::Uuid], + ) -> Result<(), String> { + self.removed.lock().unwrap().push(instance_ids.to_vec()); + self.entered.notify_one(); + self.release.notified().await; + Ok(()) + } + } + + let instances = Arc::new(InstanceManager::new( + ManagementTestFactory(CoreProcessRuntime::new()), + Some(tokio::runtime::Handle::current()), + )); + let config = TomlConfig::default(); + config.set_listeners(Vec::new()); + let instance_id = config.get_id(); + instances + .run_network_instance(config, ConfigFileControl::STATIC_CONFIG) + .unwrap(); + let hooks = Arc::new(BlockingRemovalHook::default()); + let management = ProcessManagement::::new( + instances.clone(), + hooks.clone(), + Arc::new(UnsupportedConfigFileStorage), + ); + + let deletion_management = management.clone(); + let deletion = tokio::spawn(async move { + deletion_management + .delete_owned_network_instances(vec![instance_id, uuid::Uuid::new_v4()]) + .await + }); + hooks.entered.notified().await; + assert!(instances.mutation_lock().try_lock().is_err()); + assert_eq!( + hooks.removed.lock().unwrap().as_slice(), + &[vec![instance_id]] + ); + hooks.release.notify_one(); + + let result = deletion.await.unwrap().unwrap(); + assert_eq!(result.removed_instance_ids, vec![instance_id]); + assert_eq!(hooks.removed.lock().unwrap().len(), 1); + + let old_name = format!("old-{instance_id}"); + let new_name = format!("new-{instance_id}"); + let old_config = TomlConfig::default(); + old_config.set_id(instance_id); + old_config.set_inst_name(old_name.clone()); + old_config.set_listeners(Vec::new()); + instances + .run_network_instance(old_config, ConfigFileControl::STATIC_CONFIG) + .unwrap(); + + let mutation_guard = instances.mutation_lock().lock_owned().await; + let deletion = management.delete_owned_network_instances_by_name(vec![old_name]); + tokio::pin!(deletion); + assert!(matches!( + futures::poll!(deletion.as_mut()), + std::task::Poll::Pending + )); + + instances + .delete_network_instances([instance_id]) + .await + .unwrap(); + let new_config = TomlConfig::default(); + new_config.set_id(instance_id); + new_config.set_inst_name(new_name.clone()); + new_config.set_listeners(Vec::new()); + instances + .run_network_instance(new_config, ConfigFileControl::STATIC_CONFIG) + .unwrap(); + + drop(mutation_guard); + hooks.release.notify_one(); + let result = deletion.await.unwrap(); + assert!(result.removed_instance_ids.is_empty()); + assert_eq!( + instances + .instance(instance_id) + .map(|instance| instance.instance_name().to_owned()) + .as_deref(), + Some(new_name.as_str()) + ); + assert_eq!( + hooks.removed.lock().unwrap().as_slice(), + &[vec![instance_id], Vec::new()] + ); + instances + .delete_network_instances([instance_id]) + .await + .unwrap(); + + let selection_ran = Arc::new(std::sync::atomic::AtomicBool::new(false)); + let selection_ran_for_call = selection_ran.clone(); + let mutation_guard = instances.mutation_lock().lock_owned().await; + let deletion = management.delete_owned_network_instances_selected_by(move || { + selection_ran_for_call.store(true, std::sync::atomic::Ordering::Release); + Vec::new() + }); + tokio::pin!(deletion); + assert!(matches!( + futures::poll!(deletion.as_mut()), + std::task::Poll::Pending + )); + assert!(!selection_ran.load(std::sync::atomic::Ordering::Acquire)); + drop(mutation_guard); + hooks.release.notify_one(); + deletion.await.unwrap(); + assert!(selection_ran.load(std::sync::atomic::Ordering::Acquire)); + } + + #[cfg(feature = "management")] + #[tokio::test] + async fn process_management_rpc_rolls_back_instance_and_file_on_hook_failure() { + use std::{ + collections::HashMap, + path::{Path, PathBuf}, + sync::Mutex as StdMutex, + }; + + use crate::{ + config::toml::TomlConfig, + instance::manager::InstanceFactory, + management::{ + ConfigFileControl, ConfigFilePermission, ConfigFileStorage, InstanceManager, + InstanceMutationHooks, ProcessManagementRpc, + }, + }; + use easytier_proto::{ + api::manage::{ + NetworkConfig, NetworkingMethod, RunNetworkInstanceRequest, WebClientService, + }, + rpc_types::controller::BaseController, + }; + + struct ManagementTestFactory(Arc); + + impl InstanceFactory for ManagementTestFactory { + type Instance = CoreInstance; + type CreateContext = (); + type Error = anyhow::Error; + + fn create( + &self, + config: TomlConfig, + (): Self::CreateContext, + ) -> Result, Self::Error> { + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + CoreInstance::from_toml( + config, + adapters_with_process_runtime(None, Arc::new(packet_sink), self.0.clone()), + ) + } + } + + impl crate::management::ProcessRuntimeProvider for ManagementTestFactory { + fn process_runtime(&self) -> Arc { + self.0.clone() + } + } + + #[derive(Default)] + struct MemoryStorage(StdMutex>>); + + #[async_trait] + impl ConfigFileStorage for MemoryStorage { + async fn inspect(&self, path: &Path) -> ConfigFileControl { + ConfigFileControl::new(Some(path.to_owned()), ConfigFilePermission::default()) + } + + async fn read(&self, path: &Path) -> anyhow::Result>> { + Ok(self.0.lock().unwrap().get(path).cloned()) + } + + async fn write(&self, path: &Path, contents: &[u8]) -> anyhow::Result<()> { + self.0 + .lock() + .unwrap() + .insert(path.to_owned(), contents.to_vec()); + Ok(()) + } + + async fn remove(&self, path: &Path) -> anyhow::Result<()> { + self.0.lock().unwrap().remove(path); + Ok(()) + } + } + + struct RejectPostRun; + + #[async_trait] + impl InstanceMutationHooks for RejectPostRun { + fn manages_remote_config_instances(&self) -> bool { + true + } + + async fn post_run_network_instance( + &self, + _instance_id: &uuid::Uuid, + ) -> Result<(), String> { + Err("rejected for rollback test".to_owned()) + } + } + + let instances = Arc::new(InstanceManager::new( + ManagementTestFactory(CoreProcessRuntime::new()), + Some(tokio::runtime::Handle::current()), + )); + let storage = Arc::new(MemoryStorage::default()); + let instance_id = uuid::Uuid::new_v4(); + let config_path = PathBuf::from("managed-process-rpc.toml"); + let original_file = b"original configuration".to_vec(); + storage + .0 + .lock() + .unwrap() + .insert(config_path.clone(), original_file.clone()); + let original = TomlConfig::default(); + original.set_id(instance_id); + original.set_inst_name("original-instance".to_owned()); + original.set_listeners(Vec::new()); + instances + .run_network_instance( + original, + ConfigFileControl::new(Some(config_path.clone()), ConfigFilePermission::default()), + ) + .unwrap(); + let rpc = ProcessManagementRpc::::new( + instances.clone(), + Arc::new(RejectPostRun), + storage.clone(), + ); + + let result = rpc + .run_network_instance( + BaseController::default(), + RunNetworkInstanceRequest { + inst_id: Some(instance_id.into()), + config: Some(NetworkConfig { + network_name: Some("replacement".to_owned()), + networking_method: Some(NetworkingMethod::Standalone.into()), + ..Default::default() + }), + overwrite: true, + ..Default::default() + }, + ) + .await; + + assert!(result.is_err()); + assert_eq!( + instances + .instance(instance_id) + .map(|instance| instance.instance_name().to_owned()) + .as_deref(), + Some("original-instance") + ); + assert_eq!( + storage.0.lock().unwrap().get(&config_path), + Some(&original_file) + ); + instances + .delete_network_instances([instance_id]) + .await + .unwrap(); + } + + #[tokio::test] + async fn packet_plane_does_not_retain_core_instance() { + let instance = build_instance(test_config("packet-plane-ownership")).unwrap(); + let weak = Arc::downgrade(&instance); + let packet_plane = instance.packet_plane(); + + drop(instance); + + assert!(weak.upgrade().is_none()); + drop(packet_plane); + } + + #[derive(Default)] + struct RecordingProxyService { + start_calls: AtomicUsize, + stop_calls: AtomicUsize, + start_gate: Option>, + #[cfg(feature = "proxy-packet")] + destination_ingress: StdMutex< + Option, + >, + } + + #[derive(Default)] + struct ProxyStartGate { + entered: Notify, + release: Notify, + } + + impl RecordingProxyService { + fn blocking() -> (Arc, Arc) { + let gate = Arc::new(ProxyStartGate::default()); + ( + Arc::new(Self { + start_gate: Some(gate.clone()), + ..Default::default() + }), + gate, + ) + } + + #[cfg(feature = "proxy-packet")] + fn destination_ingress( + &self, + ) -> Option + { + self.destination_ingress.lock().unwrap().clone() + } + } + + #[async_trait] + impl WrappedTransportEngine for RecordingProxyService { + async fn prepare(&self, options: WrappedTransportEngineStart) -> anyhow::Result<()> { + self.start_calls.fetch_add(1, Ordering::Relaxed); + #[cfg(feature = "proxy-packet")] + { + *self.destination_ingress.lock().unwrap() = options.destination_ingress; + } + #[cfg(not(feature = "proxy-packet"))] + let _ = options; + if let Some(gate) = &self.start_gate { + gate.entered.notify_one(); + gate.release.notified().await; + } + Ok(()) + } + + async fn activate(&self) -> anyhow::Result<()> { + Ok(()) + } + + async fn inject_peer_datagram( + &self, + _role: WrappedTransportRole, + _from_peer_id: u32, + _payload: bytes::Bytes, + ) -> anyhow::Result<()> { + Ok(()) + } + + #[cfg(feature = "proxy-packet")] + async fn connect_source( + &self, + _request: crate::gateway::proxy::wrapped_transport::WrappedTransportConnect, + ) -> anyhow::Result> { + anyhow::bail!("recording engine does not open streams") + } + + async fn stop(&self) { + self.stop_calls.fetch_add(1, Ordering::Relaxed); + } + } + + #[derive(Debug, Default)] + struct BlockingListenerState { + start_entered: Notify, + drop_calls: AtomicUsize, + } + + #[derive(Debug)] + struct BlockingSocketListener { + url: Url, + state: Arc, + } + + #[async_trait] + impl SocketListener for BlockingSocketListener { + type Accepted = AcceptedTransport; + + async fn listen(&mut self) -> anyhow::Result<()> { + self.state.start_entered.notify_one(); + std::future::pending().await + } + + async fn accept(&mut self) -> anyhow::Result { + std::future::pending().await + } + + fn local_url(&self) -> Url { + self.url.clone() + } + } + + impl Drop for BlockingSocketListener { + fn drop(&mut self) { + self.state.drop_calls.fetch_add(1, Ordering::Relaxed); + } + } + + struct BlockingExternalListenerFactory { + state: Arc, + } + + impl ExternalListenerFactory> for BlockingExternalListenerFactory { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "unix" + } + + fn create( + &self, + request: ExternalListenerRequest, + ) -> Box>> { + Box::new(BlockingSocketListener { + url: request.url, + state: self.state.clone(), + }) + } + } + + #[derive(Debug)] + struct ReadySocketListener(Url); + + #[async_trait] + impl SocketListener for ReadySocketListener { + type Accepted = AcceptedTransport; + + async fn listen(&mut self) -> anyhow::Result<()> { + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + std::future::pending().await + } + + fn local_url(&self) -> Url { + self.0.clone() + } + } + + struct ReadyExternalListenerFactory; + + impl ExternalListenerFactory> for ReadyExternalListenerFactory { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "unix" + } + + fn create( + &self, + request: ExternalListenerRequest, + ) -> Box>> { + Box::new(ReadySocketListener(request.url)) + } + } + + #[tokio::test] + async fn runtime_updates_refresh_avoid_relay_preference() { + let config = test_config("portable-runtime-update"); + let instance = build_instance(config.clone()).unwrap(); + + assert!( + !instance + .node_snapshot() + .await + .feature_flags + .avoid_relay_data + ); + + let mut enabled = runtime_snapshot(&config); + Arc::make_mut(&mut enabled.peer).avoid_relay_data_preference = true; + instance.update_runtime_config(enabled).await.unwrap(); + assert!( + instance + .node_snapshot() + .await + .feature_flags + .avoid_relay_data + ); + + let mut disabled = runtime_snapshot(&config); + Arc::make_mut(&mut disabled.peer).avoid_relay_data_preference = false; + instance.update_runtime_config(disabled).await.unwrap(); + assert!( + !instance + .node_snapshot() + .await + .feature_flags + .avoid_relay_data + ); + } + + #[cfg(all(feature = "test-utils", feature = "dhcp-ipv4"))] + #[cfg_attr( + not(target_os = "wasi"), + tokio::test(flavor = "multi_thread", worker_threads = 2) + )] + #[cfg_attr(target_os = "wasi", tokio::test)] + async fn concurrent_runtime_updates_keep_snapshot_and_derived_state_coherent() { + let config = test_config("concurrent-runtime-update"); + let instance = build_instance(config.clone()).unwrap(); + instance.start().await.unwrap(); + + let original = instance.node_snapshot().await; + let mut full = runtime_snapshot(&config); + full.services.dhcp_ipv4 = true; + full.services.acl.tcp_whitelist = vec!["80".to_owned()]; + { + let peer = Arc::make_mut(&mut full.peer); + peer.runtime.core.node.hostname = Some("full".to_owned()); + peer.runtime.core.routes.proxy_networks = + vec![proxy_network("192.0.2.0/24", Some("198.51.100.0/24"))]; + } + let mut peer_update = full.clone(); + { + let peer = Arc::make_mut(&mut peer_update.peer); + peer.runtime.core.node.hostname = Some("peer".to_owned()); + peer.runtime.core.routes.proxy_networks = + vec![proxy_network("203.0.113.0/24", Some("10.20.30.0/24"))]; + } + + let start = Arc::new(tokio::sync::Barrier::new(3)); + let full_update = tokio::spawn({ + let instance = instance.clone(); + let start = start.clone(); + async move { + start.wait().await; + instance.update_runtime_config(full).await + } + }); + let peer_update = tokio::spawn({ + let instance = instance.clone(); + let start = start.clone(); + async move { + start.wait().await; + instance.update_runtime_config(peer_update).await + } + }); + start.wait().await; + full_update.await.unwrap().unwrap(); + peer_update.await.unwrap().unwrap(); + + let final_config = instance.runtime_config.snapshot(); + assert!(final_config.services.dhcp_ipv4); + assert_eq!(instance.acl_whitelist_snapshot().tcp_ports, ["80"]); + assert_eq!(instance.acl_reload_count.load(Ordering::Relaxed), 1); + let node = instance.node_snapshot().await; + assert_eq!(node.peer_id, original.peer_id); + assert_eq!(node.instance_id, original.instance_id); + assert_eq!( + final_config.peer.runtime.core.node.hostname.as_deref(), + Some(node.hostname.as_str()) + ); + match node.hostname.as_str() { + "full" => assert_eq!( + instance + .proxy_cidr_table + .lookup_v4("198.51.100.42".parse().unwrap()), + Some("192.0.2.42".parse().unwrap()) + ), + "peer" => assert_eq!( + instance + .proxy_cidr_table + .lookup_v4("10.20.30.42".parse().unwrap()), + Some("203.0.113.42".parse().unwrap()) + ), + hostname => panic!("unexpected final hostname: {hostname:?}"), + } + + instance.stop().await; + } + + #[cfg(all(feature = "test-utils", feature = "dhcp-ipv4"))] + #[tokio::test] + async fn active_runtime_update_skips_unchanged_and_rejects_invalid_acl() { + let config = test_config("invalid-active-acl-update"); + let instance = build_instance(config.clone()).unwrap(); + instance.start().await.unwrap(); + + let mut unrelated = runtime_snapshot(&config); + Arc::make_mut(&mut unrelated.peer) + .runtime + .core + .node + .hostname = Some("accepted".to_owned()); + instance.update_runtime_config(unrelated).await.unwrap(); + assert_eq!(instance.acl_reload_count.load(Ordering::Relaxed), 0); + let before = instance.node_snapshot().await; + + let mut rejected = runtime_snapshot(&config); + rejected.services.dhcp_ipv4 = true; + rejected.services.acl.tcp_whitelist = vec!["invalid".to_owned()]; + Arc::make_mut(&mut rejected.peer).runtime.core.node.hostname = Some("rejected".to_owned()); + + let error = instance.update_runtime_config(rejected).await.unwrap_err(); + assert!(error.to_string().contains("Invalid port number")); + assert!(!instance.runtime_config.snapshot().services.dhcp_ipv4); + assert!(instance.acl_whitelist_snapshot().tcp_ports.is_empty()); + assert_eq!(instance.acl_reload_count.load(Ordering::Relaxed), 0); + assert_eq!(instance.node_snapshot().await.hostname, before.hostname); + instance.stop().await; + } + + #[cfg(feature = "proxy-packet")] + #[tokio::test] + async fn runtime_core_instance_owns_connectivity_lifecycle() { + let mut config = test_config("connectivity-lifecycle"); + config.peer.snapshot.runtime.core.routes.proxy_networks = + vec![proxy_network("10.1.2.0/24", None)]; + let initial_peer: Url = "tcp://127.0.0.1:29999".parse().unwrap(); + config.connectivity.initial_peers = vec![initial_peer.clone()]; + let proxy = Arc::new(RecordingProxyService::default()); + let instance = build_with_engines( + config, + WrappedTransportEngines { + kcp: Some(proxy.clone()), + quic: None, + }, + ) + .unwrap(); + + assert_eq!(instance.state(), CoreInstanceState::Created); + assert_eq!(instance.list_connectors().len(), 1); + assert_eq!(instance.list_connectors()[0].url, initial_peer); + instance.start().await.unwrap(); + assert_eq!(instance.state(), CoreInstanceState::Running); + assert!(instance.is_ready()); + assert!(instance.start().await.is_err()); + assert_eq!(proxy.start_calls.load(Ordering::Relaxed), 1); + + instance.stop().await; + instance.stop().await; + assert_eq!(instance.state(), CoreInstanceState::Stopped); + assert_eq!(proxy.stop_calls.load(Ordering::Relaxed), 1); + } + + #[cfg(feature = "proxy-smoltcp-stack")] + #[tokio::test] + async fn startup_plan_controls_gateway_for_initial_and_updated_config() { + fn build(config: CoreInstanceConfig) -> (Arc>, Arc) { + let host = Arc::new(TestHost { + reject_socks5_listener: true, + ..Default::default() + }); + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let adapters = adapters_with_host(host.clone(), None, Arc::new(packet_sink)); + (CoreInstance::new(config, adapters).unwrap(), host) + } + + let mut enabled_config = test_config("gateway-enabled-by-default"); + enabled_config.connectivity.runtime.gateway.socks5_bind = + Some("127.0.0.1:1080".parse().unwrap()); + let (enabled, _) = build(enabled_config); + let error = enabled.start().await.unwrap_err(); + assert!(error.to_string().contains("rejected SOCKS5 listener")); + assert_eq!(enabled.state(), CoreInstanceState::Stopped); + + let mut disabled_config = test_config("gateway-disabled-by-plan"); + disabled_config.connectivity.startup_plan.gateway = false; + disabled_config.peer.snapshot.runtime.core.routes.ipv4 = + Some(IpPrefix::new("10.144.0.1".parse().unwrap(), 24).unwrap()); + let (disabled, _) = build(disabled_config.clone()); + let mut updated = runtime_snapshot(&disabled_config); + updated.services.gateway.socks5_bind = Some("127.0.0.1:1080".parse().unwrap()); + disabled.update_runtime_config(updated).await.unwrap(); + disabled.start().await.unwrap(); + assert_eq!(disabled.state(), CoreInstanceState::Running); + let socket = disabled + .data_plane_udp_bind(0, Duration::from_secs(1)) + .await + .expect("startup plan must not disable the data-plane runtime"); + drop(socket); + disabled.stop().await; + } + + #[cfg(feature = "proxy-smoltcp-stack")] + #[tokio::test] + async fn failed_port_forward_start_releases_started_listeners() { + let mut config = test_config("port-forward-start-rollback"); + config.connectivity.runtime.gateway.port_forwards = vec![ + PortForwardConfig { + bind_addr: "127.0.0.1:18080".parse().unwrap(), + dst_addr: "10.144.0.2:80".parse().unwrap(), + proto: "tcp".to_owned(), + }, + PortForwardConfig { + bind_addr: "127.0.0.1:18081".parse().unwrap(), + dst_addr: "10.144.0.2:81".parse().unwrap(), + proto: "unsupported".to_owned(), + }, + ]; + let host = Arc::new(TestHost::default()); + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let adapters = adapters_with_host(host.clone(), None, Arc::new(packet_sink)); + let instance = CoreInstance::new(config, adapters).unwrap(); + + let error = instance.start().await.unwrap_err(); + + assert!(error.to_string().contains("unsupported protocol")); + assert_eq!(instance.state(), CoreInstanceState::Stopped); + assert_eq!(host.active_tcp_listeners.load(Ordering::Relaxed), 0); + } + + #[cfg(feature = "proxy-packet")] + #[tokio::test] + async fn runtime_core_instance_owns_wrapped_transport_source_nat() { + let mut config = test_config("wrapped-source"); + config.peer.snapshot.flags.enable_kcp_proxy = true; + config.peer.snapshot.flags.disable_kcp_input = true; + let engine = Arc::new(RecordingProxyService::default()); + let instance = build_with_engines( + config, + WrappedTransportEngines { + kcp: Some(engine.clone()), + quic: None, + }, + ) + .unwrap(); + + instance.start().await.unwrap(); + assert!( + instance.wrapped_transport_is_started( + WrappedTransportKind::Kcp, + WrappedTransportRole::Source, + ) + ); + assert!( + instance + .wrapped_tcp_proxy_entry_snapshots( + WrappedTransportKind::Kcp, + WrappedTransportRole::Source, + ) + .is_empty() + ); + + instance.stop().await; + assert!( + !instance.wrapped_transport_is_started( + WrappedTransportKind::Kcp, + WrappedTransportRole::Source, + ) + ); + assert_eq!(engine.stop_calls.load(Ordering::Relaxed), 1); + } + + #[cfg(feature = "proxy-packet")] + #[tokio::test] + async fn runtime_core_instance_owns_wrapped_transport_destination_sessions() { + let mut config = test_config("wrapped-destination"); + config.peer.snapshot.flags.enable_kcp_proxy = false; + config.peer.snapshot.flags.disable_kcp_input = false; + let engine = Arc::new(RecordingProxyService::default()); + let (connections, mut connection_receiver) = tokio::sync::mpsc::unbounded_channel(); + let host = Arc::new(TestHost { + proxy_nat_connections: Some(connections), + ..Default::default() + }); + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters_with_host(host, None, Arc::new(packet_sink)); + adapters.wrapped_transports = WrappedTransportEngines { + kcp: Some(engine.clone()), + quic: None, + }; + let instance = CoreInstance::new(config, adapters).unwrap(); + + instance.start().await.unwrap(); + assert!(instance.wrapped_transport_is_started( + WrappedTransportKind::Kcp, + WrappedTransportRole::Destination, + )); + + let destination: SocketAddr = "127.0.0.1:20100".parse().unwrap(); + let ingress = engine + .destination_ingress() + .expect("core should inject a destination ingress"); + let (core_stream, peer_stream) = tokio::io::duplex(1024); + ingress + .submit( + crate::gateway::proxy::wrapped_transport::WrappedTransportAcceptedStream { + src: "10.0.0.2:40000".parse().unwrap(), + dst: destination, + initial_acl_packet_size: 16, + stream: Box::new(core_stream), + }, + ) + .await + .unwrap(); + let (connected_destination, destination_stream) = tokio::time::timeout( + std::time::Duration::from_secs(2), + connection_receiver.recv(), + ) + .await + .expect("core should request the destination socket") + .unwrap(); + assert_eq!(connected_destination, destination); + tokio::time::timeout(std::time::Duration::from_secs(2), async { + loop { + let entries = instance.wrapped_tcp_proxy_entry_snapshots( + WrappedTransportKind::Kcp, + WrappedTransportRole::Destination, + ); + if entries.iter().any(|entry| { + entry.state + == crate::gateway::proxy::tcp_proxy_engine::TcpNatEntryState::Connected + }) { + break; + } + tokio::task::yield_now().await; + } + }) + .await + .expect("core should own the connected destination entry"); + + drop(peer_stream); + drop(destination_stream); + tokio::time::timeout(std::time::Duration::from_secs(2), async { + while !instance + .wrapped_tcp_proxy_entry_snapshots( + WrappedTransportKind::Kcp, + WrappedTransportRole::Destination, + ) + .is_empty() + { + tokio::task::yield_now().await; + } + }) + .await + .expect("completed destination entry should be removed"); + + let (core_stream, _blocked_peer_stream) = tokio::io::duplex(1024); + ingress + .submit( + crate::gateway::proxy::wrapped_transport::WrappedTransportAcceptedStream { + src: "10.0.0.2:40001".parse().unwrap(), + dst: destination, + initial_acl_packet_size: 16, + stream: Box::new(core_stream), + }, + ) + .await + .unwrap(); + let (connected_destination, _blocked_destination_stream) = tokio::time::timeout( + std::time::Duration::from_secs(2), + connection_receiver.recv(), + ) + .await + .expect("second destination session should request a socket") + .unwrap(); + assert_eq!(connected_destination, destination); + tokio::time::timeout(std::time::Duration::from_secs(2), async { + while instance + .wrapped_tcp_proxy_entry_snapshots( + WrappedTransportKind::Kcp, + WrappedTransportRole::Destination, + ) + .is_empty() + { + tokio::task::yield_now().await; + } + }) + .await + .expect("blocked destination session should be visible"); + + tokio::time::timeout(std::time::Duration::from_secs(2), instance.stop()) + .await + .expect("stop should cancel core-owned destination sessions"); + assert!( + instance + .wrapped_tcp_proxy_entry_snapshots( + WrappedTransportKind::Kcp, + WrappedTransportRole::Destination, + ) + .is_empty() + ); + assert!( + ingress + .submit( + crate::gateway::proxy::wrapped_transport::WrappedTransportAcceptedStream { + src: "10.0.0.2:40002".parse().unwrap(), + dst: destination, + initial_acl_packet_size: 16, + stream: Box::new(tokio::io::duplex(64).0), + }, + ) + .await + .is_err() + ); + } + + #[tokio::test] + async fn runtime_core_instance_owns_the_transport_proxy_cidr_table() { + let mut config = test_config("transport-proxy-cidr"); + config.connectivity.runtime.proxy.forward_by_system = true; + config.peer.snapshot.runtime.core.routes.proxy_networks = + vec![proxy_network("192.0.2.0/24", Some("198.51.100.0/24"))]; + let mut updated = runtime_snapshot(&config); + let proxy = Arc::new(RecordingProxyService::default()); + let instance = build_with_engines( + config, + WrappedTransportEngines { + kcp: Some(proxy.clone()), + quic: None, + }, + ) + .unwrap(); + + assert_eq!(instance.node_snapshot().await.proxy_networks.len(), 1); + instance.start().await.unwrap(); + assert_eq!(proxy.start_calls.load(Ordering::Relaxed), 1); + + Arc::make_mut(&mut updated.peer) + .runtime + .core + .routes + .proxy_networks = vec![proxy_network("203.0.113.0/24", Some("10.20.30.0/24"))]; + instance.update_runtime_config(updated).await.unwrap(); + let proxy_networks = instance.node_snapshot().await.proxy_networks; + assert_eq!(proxy_networks.len(), 1); + assert_eq!( + proxy_networks[0].real.address, + "203.0.113.0".parse::().unwrap() + ); + assert_eq!( + proxy_networks[0].mapped.as_ref().unwrap().address, + "10.20.30.0".parse::().unwrap() + ); + + instance.stop().await; + assert!(instance.start().await.is_err()); + assert_eq!(proxy.stop_calls.load(Ordering::Relaxed), 1); + } + + #[tokio::test] + async fn runtime_core_rejects_invalid_acl_runtime_snapshot() { + let config = test_config("explicit-acl"); + let instance = build_instance(config.clone()).unwrap(); + assert_eq!(instance.acl_whitelist_snapshot(), Default::default()); + + let mut updated = runtime_snapshot(&config); + updated.services.acl.tcp_whitelist = vec!["invalid".to_owned()]; + let error = instance.update_runtime_config(updated).await.unwrap_err(); + assert!(error.to_string().contains("Invalid port number")); + assert!(instance.acl_whitelist_snapshot().tcp_ports.is_empty()); + instance.start().await.unwrap(); + instance.stop().await; + } + + #[cfg(feature = "dhcp-ipv4")] + #[tokio::test] + async fn runtime_core_accepts_explicit_dhcp_runtime_snapshot() { + let config = test_config("explicit-dhcp"); + let instance = build_instance(config.clone()).unwrap(); + let mut updated = runtime_snapshot(&config); + updated.services.dhcp_ipv4 = true; + instance.update_runtime_config(updated).await.unwrap(); + let error = instance.start().await.unwrap_err(); + assert!(error.to_string().contains("no host adapter was provided")); + assert_eq!(instance.state(), CoreInstanceState::Stopped); + } + + #[cfg(feature = "public-ipv6-provider")] + #[tokio::test] + async fn runtime_core_accepts_explicit_public_ipv6_runtime_snapshot() { + let config = test_config("explicit-public-ipv6"); + let instance = build_instance(config.clone()).unwrap(); + let mut updated = runtime_snapshot(&config); + updated.services.public_ipv6_provider.provider_enabled = true; + updated.services.public_ipv6_provider.provider_supported = true; + updated.services.public_ipv6_provider.configured_prefix = + Some("fd00::/64".parse().unwrap()); + instance.update_runtime_config(updated).await.unwrap(); + + let error = instance.start().await.unwrap_err(); + assert!(error.to_string().contains("not a valid global unicast")); + assert_eq!(instance.state(), CoreInstanceState::Stopped); + } + + #[cfg(not(feature = "proxy-packet"))] + #[test] + fn runtime_core_rejects_packet_proxy_requests_when_unavailable() { + let mut config = test_config("packet-proxy-unavailable"); + config.connectivity.runtime.proxy.enable_exit_node = true; + + let error = match build_instance(config) { + Ok(_) => panic!("packet proxy request unexpectedly succeeded"), + Err(error) => error, + }; + + assert!( + error + .to_string() + .contains("does not include packet proxy services") + ); + } + + #[cfg(not(feature = "proxy-smoltcp-stack"))] + #[tokio::test] + async fn runtime_core_rejects_unavailable_gateway_updates() { + let config = test_config("smoltcp-gateway-update-unavailable"); + let instance = build_instance(config.clone()).unwrap(); + let mut updated = runtime_snapshot(&config); + updated.services.gateway.socks5_bind = Some("127.0.0.1:1080".parse().unwrap()); + + let error = instance.update_runtime_config(updated).await.unwrap_err(); + + assert!( + error + .to_string() + .contains("does not include the smoltcp gateway") + ); + } + + #[tokio::test] + async fn stopping_while_transport_proxy_starts_rolls_back_once() { + let mut config = test_config("blocking-transport-proxy"); + config.connectivity.runtime.proxy.forward_by_system = true; + config.peer.snapshot.runtime.core.routes.proxy_networks = + vec![proxy_network("10.1.2.0/24", None)]; + config.connectivity.initial_peers = vec!["tcp://127.0.0.1:29998".parse().unwrap()]; + let (proxy, start_gate) = RecordingProxyService::blocking(); + let instance = build_with_engines( + config, + WrappedTransportEngines { + kcp: Some(proxy.clone()), + quic: None, + }, + ) + .unwrap(); + + let start_task = tokio::spawn({ + let instance = instance.clone(); + async move { instance.start().await } + }); + start_gate.entered.notified().await; + let stop_task = tokio::spawn({ + let instance = instance.clone(); + async move { instance.stop().await } + }); + while !instance.cancel.is_cancelled() { + tokio::task::yield_now().await; + } + + assert!(start_task.await.unwrap().is_err()); + stop_task.await.unwrap(); + assert_eq!(instance.list_connectors().len(), 1); + assert_eq!(instance.state(), CoreInstanceState::Stopped); + assert!(!instance.is_ready()); + assert_eq!(proxy.start_calls.load(Ordering::Relaxed), 1); + assert_eq!(proxy.stop_calls.load(Ordering::Relaxed), 1); + } + + #[tokio::test] + async fn start_serializes_runtime_updates() { + let mut config = test_config("serialized-start"); + config.connectivity.runtime.proxy.forward_by_system = true; + config.peer.snapshot.runtime.core.routes.proxy_networks = + vec![proxy_network("10.1.4.0/24", None)]; + let mut updated = runtime_snapshot(&config); + Arc::make_mut(&mut updated.peer).runtime.core.node.hostname = + Some("updated-after-start".to_owned()); + let (proxy, start_gate) = RecordingProxyService::blocking(); + let instance = build_with_engines( + config, + WrappedTransportEngines { + kcp: Some(proxy), + quic: None, + }, + ) + .unwrap(); + + let start = tokio::spawn({ + let instance = instance.clone(); + async move { instance.start().await } + }); + start_gate.entered.notified().await; + + let update = instance.update_runtime_config(updated); + tokio::pin!(update); + assert!(matches!( + futures::poll!(update.as_mut()), + std::task::Poll::Pending + )); + + start_gate.release.notify_one(); + start.await.unwrap().unwrap(); + update.await.unwrap(); + assert_eq!( + instance.node_snapshot().await.hostname, + "updated-after-start" + ); + instance.stop().await; + } + + #[tokio::test] + async fn aborting_start_stops_partial_runtime() { + let mut config = test_config("aborted-start"); + config.connectivity.runtime.proxy.forward_by_system = true; + config.peer.snapshot.runtime.core.routes.proxy_networks = + vec![proxy_network("10.1.3.0/24", None)]; + let (proxy, start_gate) = RecordingProxyService::blocking(); + let instance = build_with_engines( + config, + WrappedTransportEngines { + kcp: Some(proxy.clone()), + quic: None, + }, + ) + .unwrap(); + + let start = tokio::spawn({ + let instance = instance.clone(); + async move { instance.start().await } + }); + start_gate.entered.notified().await; + start.abort(); + assert!(start.await.unwrap_err().is_cancelled()); + + tokio::time::timeout(Duration::from_secs(2), async { + while instance.state() != CoreInstanceState::Stopped { + tokio::task::yield_now().await; + } + }) + .await + .expect("aborted activation should recover the instance"); + assert!(!instance.is_ready()); + assert_eq!(proxy.start_calls.load(Ordering::Relaxed), 1); + assert_eq!(proxy.stop_calls.load(Ordering::Relaxed), 1); + } + + #[tokio::test] + async fn invalid_initial_peer_fails_during_construction() { + let mut config = test_config("invalid-initial-peer"); + config.connectivity.initial_peers = + vec!["unsupported://peer.example:1234".parse().unwrap()]; + + let error = build_instance(config) + .err() + .expect("invalid initial peer should fail construction"); + assert!( + error + .to_string() + .contains("unsupported core manual connector URL"), + "unexpected construction error: {error:#}" + ); + } + + #[tokio::test] + async fn runtime_core_instances_keep_lifecycle_and_connectors_isolated() { + let instance_a = build_instance(test_config("instance-a")).unwrap(); + let instance_b = build_instance(test_config("instance-b")).unwrap(); + let connector_a: Url = "tcp://127.0.0.1:21001".parse().unwrap(); + let connector_b: Url = "udp://127.0.0.1:21002".parse().unwrap(); + + instance_a.add_connector(connector_a.clone()).unwrap(); + instance_b.add_connector(connector_b.clone()).unwrap(); + assert_eq!(instance_a.list_connectors()[0].url, connector_a); + assert_eq!(instance_b.list_connectors()[0].url, connector_b); + instance_a.clear_connectors(); + instance_b.clear_connectors(); + + let (start_a, start_b) = tokio::join!(instance_a.start(), instance_b.start()); + start_a.unwrap(); + start_b.unwrap(); + assert_eq!(instance_a.state(), CoreInstanceState::Running); + assert_eq!(instance_b.state(), CoreInstanceState::Running); + + instance_a.stop().await; + assert_eq!(instance_a.state(), CoreInstanceState::Stopped); + assert_eq!(instance_b.state(), CoreInstanceState::Running); + instance_b.stop().await; + assert_eq!(instance_b.state(), CoreInstanceState::Stopped); + } + + #[cfg(unix)] + #[tokio::test] + async fn stop_cancels_pending_listener_start() { + let state = Arc::new(BlockingListenerState::default()); + let mut config = test_config("pending-listener"); + config.connectivity.listeners = Some(ListenerRuntimeConfig::new( + vec!["unix:///tmp/easytier-pending-listener".parse().unwrap()], + false, + SocketContext::default(), + )); + let instance = build_with_engines_and_listener( + config, + WrappedTransportEngines::default(), + Some(Arc::new(BlockingExternalListenerFactory { + state: state.clone(), + })), + ) + .unwrap(); + let start_instance = instance.clone(); + let start_task = + AbortOnDropHandle::new(tokio::spawn(async move { start_instance.start().await })); + let start_result = tokio::time::timeout(Duration::from_secs(1), async { + state.start_entered.notified().await; + instance.stop().await; + start_task.await.unwrap() + }) + .await + .expect("listener cancellation should complete promptly"); + + assert!(start_result.is_err()); + assert_eq!(instance.state(), CoreInstanceState::Stopped); + assert_eq!(state.drop_calls.load(Ordering::Relaxed), 1); + } + + #[tokio::test] + async fn external_listener_uses_core_running_listener_registry() { + let external_url: Url = "unix:///tmp/easytier-external-listener-test" + .parse() + .unwrap(); + let mut config = test_config("external-listener-registry"); + config.connectivity.listeners = Some(ListenerRuntimeConfig::new( + vec![external_url.clone()], + false, + SocketContext::default(), + )); + let instance = build_with_engines_and_listener( + config, + WrappedTransportEngines::default(), + Some(Arc::new(ReadyExternalListenerFactory)), + ) + .unwrap(); + + instance.start().await.unwrap(); + let running = instance.running_listeners(); + assert_eq!(running.len(), 2); + assert!(running.iter().any(|url| url.scheme() == "ring")); + assert!(running.contains(&external_url)); + assert_eq!(instance.node_snapshot().await.listeners, running); + + instance.stop().await; + assert!(instance.running_listeners().is_empty()); + } + + #[tokio::test] + async fn inbound_only_uses_host_registered_listener_lifecycle() { + let external_url: Url = "unix:///tmp/easytier-host-listener-test".parse().unwrap(); + let mut config = test_config("host-listener"); + config.connectivity.startup_plan.connectivity = CoreConnectivityMode::InboundOnly; + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters( + Some(Arc::new(ReadyExternalListenerFactory)), + Arc::new(packet_sink), + ); + adapters + .host_listener_registrations + .push(ExternalListenerRequest { + url: external_url.clone(), + socket_context: SocketContext::default(), + }); + let instance = CoreInstance::new(config, adapters).unwrap(); + + assert!( + instance + .add_connector("tcp://127.0.0.1:11010".parse().unwrap()) + .is_err() + ); + instance.start().await.unwrap(); + assert!(instance.running_listeners().contains(&external_url)); + + instance.stop().await; + assert!(instance.running_listeners().is_empty()); + } + + #[tokio::test] + async fn inbound_only_rejects_initial_peers() { + let mut config = test_config("inbound-only-peer"); + config.connectivity.startup_plan.connectivity = CoreConnectivityMode::InboundOnly; + config + .connectivity + .initial_peers + .push("tcp://127.0.0.1:11010".parse().unwrap()); + + let Err(error) = build_instance(config) else { + panic!("inbound-only instance accepted an outbound peer"); + }; + assert!( + error + .to_string() + .contains("inbound-only connectivity does not support outbound peers"), + "unexpected construction error: {error:#}" + ); + } + + #[tokio::test] + async fn outbound_only_ignores_configured_and_host_registered_listeners() { + let configured_url: Url = "unix:///tmp/easytier-outbound-configured-listener" + .parse() + .unwrap(); + let host_url: Url = "unix:///tmp/easytier-outbound-host-listener" + .parse() + .unwrap(); + let mut config = test_config("outbound-only-listeners"); + config.connectivity.startup_plan.connectivity = CoreConnectivityMode::OutboundOnly; + config.connectivity.listeners = Some(ListenerRuntimeConfig::new( + vec![configured_url], + false, + SocketContext::default(), + )); + let (packet_sink, _packet_receiver) = tokio::sync::mpsc::channel(16); + let mut adapters = adapters( + Some(Arc::new(ReadyExternalListenerFactory)), + Arc::new(packet_sink), + ); + adapters + .host_listener_registrations + .push(ExternalListenerRequest { + url: host_url, + socket_context: SocketContext::default(), + }); + let instance = CoreInstance::new(config, adapters).unwrap(); + + instance.start().await.unwrap(); + assert!(instance.running_listeners().is_empty()); + + instance.stop().await; + } +} diff --git a/vendor/easytier/easytier-core/src/instance/vpn_portal_extension.rs b/vendor/easytier/easytier-core/src/instance/vpn_portal_extension.rs new file mode 100644 index 0000000..77db302 --- /dev/null +++ b/vendor/easytier/easytier-core/src/instance/vpn_portal_extension.rs @@ -0,0 +1,29 @@ +use crate::{ + config::runtime::CoreInstanceRuntimeConfig, + gateway::vpn_portal::{PortalClientConfig, PortalInfoSnapshot}, + instance::{CoreInstance, CoreInstanceHost}, +}; + +impl CoreInstance +where + H: CoreInstanceHost, +{ + pub async fn vpn_portal_info(&self) -> PortalInfoSnapshot { + self.vpn_portal.info_snapshot().await + } + + /// Replaces the VPN portal client set at runtime without restarting the + /// instance. Untouched clients keep their established sessions. + /// + /// The caller supplies the runtime snapshot the new set is validated + /// against, so a combined configuration patch is judged by its final + /// state rather than the currently running one. + #[cfg(feature = "vpn-portal")] + pub(crate) async fn update_vpn_portal_clients( + &self, + clients: Vec, + runtime: &CoreInstanceRuntimeConfig, + ) -> anyhow::Result> { + self.vpn_portal.update_clients(clients, runtime).await + } +} diff --git a/vendor/easytier/easytier-core/src/lib.rs b/vendor/easytier/easytier-core/src/lib.rs new file mode 100644 index 0000000..440e33d --- /dev/null +++ b/vendor/easytier/easytier-core/src/lib.rs @@ -0,0 +1,21 @@ +pub mod config; +pub mod connectivity; +pub mod events; +pub mod foundation; +pub mod gateway; +pub mod host; +pub mod instance; +pub mod listener; +#[cfg(feature = "management-rpc")] +pub mod management; +pub mod packet; +pub mod peers; +pub mod process_runtime; +pub mod rpc; +pub mod socket; +pub mod tunnel; + +#[cfg(any(test, target_os = "wasi"))] +pub mod wasi; + +pub(crate) use easytier_proto as proto; diff --git a/vendor/easytier/easytier-core/src/listener/mod.rs b/vendor/easytier/easytier-core/src/listener/mod.rs new file mode 100644 index 0000000..e59247b --- /dev/null +++ b/vendor/easytier/easytier-core/src/listener/mod.rs @@ -0,0 +1,1064 @@ +use std::{fmt::Debug, future::Future, pin::Pin, sync::Arc, time::Duration}; + +use anyhow::Context as _; +use async_trait::async_trait; +use tokio::{ + sync::{Mutex, mpsc}, + task::JoinSet, +}; +use tokio_util::sync::CancellationToken; +use url::Url; + +use crate::{ + events::{CoreEvent, CoreEventSink}, + socket::{SocketContext, SocketListener}, +}; + +pub mod plan; +#[cfg(any( + test, + all( + feature = "wasm-host-tunnel", + not(feature = "wasm-host-tunnel-outbound") + ) +))] +pub(crate) mod queue; +pub mod transport; + +pub trait ExternalListenerFactory: Send + Sync + 'static +where + Accepted: Send + 'static, +{ + fn supports_scheme(&self, scheme: &str) -> bool; + + fn create( + &self, + request: ExternalListenerRequest, + ) -> Box>; +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct ExternalListenerRequest { + pub url: Url, + pub socket_context: SocketContext, +} + +/// One listener supplied by the Host rather than the portable TOML model. +/// Host listeners are mandatory: startup fails when one cannot bind. +pub type HostListenerRegistration = ExternalListenerRequest; + +#[async_trait] +pub trait AcceptedSocketHandler: Send + Sync { + async fn handle_accepted_socket(&self, accepted: Accepted) -> anyhow::Result<()>; +} + +#[async_trait] +impl AcceptedSocketHandler for F +where + Accepted: Send + 'static, + F: Fn(Accepted) -> Fut + Send + Sync, + Fut: Future> + Send, +{ + async fn handle_accepted_socket(&self, accepted: Accepted) -> anyhow::Result<()> { + self(accepted).await + } +} + +#[derive(Debug, Default)] +pub(crate) struct RunningListenerRegistry { + listeners: std::sync::Mutex>, +} + +impl RunningListenerRegistry { + pub(crate) fn running_listeners(&self) -> Vec { + self.listeners + .lock() + .unwrap() + .iter() + .map(|(url, _)| url.clone()) + .collect() + } + + fn register(self: &Arc, url: Url) -> RunningListenerRegistration { + let mut listeners = self.listeners.lock().unwrap(); + if let Some((_, count)) = listeners.iter_mut().find(|(listener, _)| listener == &url) { + *count += 1; + } else { + listeners.push((url.clone(), 1)); + } + RunningListenerRegistration { + registry: self.clone(), + url, + } + } + + fn unregister(&self, url: &Url) { + let mut listeners = self.listeners.lock().unwrap(); + let Some(index) = listeners.iter().position(|(listener, _)| listener == url) else { + return; + }; + if listeners[index].1 == 1 { + listeners.remove(index); + } else { + listeners[index].1 -= 1; + } + } +} + +struct RunningListenerRegistration { + registry: Arc, + url: Url, +} + +impl Drop for RunningListenerRegistration { + fn drop(&mut self) { + self.registry.unregister(&self.url); + } +} + +impl crate::connectivity::LocalListenerUrls for RunningListenerRegistry { + fn local_listener_urls(&self) -> Vec { + self.running_listeners() + } +} + +type ListenerCreatorArc = + Arc Box> + Send + Sync>; + +#[derive(Clone)] +pub(crate) struct ListenerFactory { + creator: ListenerCreatorArc, + must_succeed: bool, +} + +impl ListenerFactory { + pub(crate) fn new(creator: C, must_succeed: bool) -> Self + where + C: Fn() -> Box> + Send + Sync + 'static, + { + Self { + creator: Arc::new(creator), + must_succeed, + } + } +} + +#[derive(Debug, Clone)] +pub struct ListenerManagerOptions { + pub max_listen_retries: usize, + pub listen_retry_delay: Duration, + pub accept_retry_delay: Duration, +} + +impl Default for ListenerManagerOptions { + fn default() -> Self { + Self { + max_listen_retries: 5, + listen_retry_delay: Duration::from_secs(1), + accept_retry_delay: Duration::from_secs(1), + } + } +} + +pub struct ListenerManager { + factories: Vec>, + handler: Arc, + events: Arc, + registry: Arc, + options: ListenerManagerOptions, + operation: Mutex<()>, + cancel: CancellationToken, + tasks: Mutex>, + handler_tasks: Arc>>, + accepted_tasks: AcceptedTaskSpawner, + accepted_task_rx: std::sync::Mutex>>, +} + +type AcceptedTask = Pin + Send + 'static>>; + +#[derive(Clone)] +struct AcceptedTaskSpawner { + tx: mpsc::UnboundedSender, +} + +impl AcceptedTaskSpawner { + fn new() -> (Self, mpsc::UnboundedReceiver) { + let (tx, rx) = mpsc::unbounded_channel(); + (Self { tx }, rx) + } + + fn spawn(&self, future: F) + where + F: Future + Send + 'static, + { + if self.tx.send(Box::pin(future)).is_err() { + tracing::warn!("accepted socket handler task runner stopped"); + } + } +} + +impl ListenerManager +where + Accepted: Send + 'static, + H: AcceptedSocketHandler + ?Sized + 'static, +{ + pub fn new_with_events(handler: Arc, events: Arc) -> Self { + Self::new_with_options(handler, events, ListenerManagerOptions::default()) + } + + pub fn new_with_options( + handler: Arc, + events: Arc, + options: ListenerManagerOptions, + ) -> Self { + Self::new_with_registry( + handler, + events, + Arc::new(RunningListenerRegistry::default()), + options, + ) + } + + pub(crate) fn new_with_registry( + handler: Arc, + events: Arc, + registry: Arc, + options: ListenerManagerOptions, + ) -> Self { + let (accepted_tasks, accepted_task_rx) = AcceptedTaskSpawner::new(); + Self { + factories: Vec::new(), + handler, + events, + registry, + options, + operation: Mutex::new(()), + cancel: CancellationToken::new(), + tasks: Mutex::new(JoinSet::new()), + handler_tasks: Arc::new(Mutex::new(JoinSet::new())), + accepted_tasks, + accepted_task_rx: std::sync::Mutex::new(Some(accepted_task_rx)), + } + } + + pub fn add_listener(&mut self, creator: C, must_succeed: bool) + where + C: Fn() -> Box> + Send + Sync + 'static, + { + self.factories + .push(ListenerFactory::new(creator, must_succeed)); + } + + pub(crate) fn add_factory(&mut self, factory: ListenerFactory) { + self.factories.push(factory); + } + + pub async fn run(&self) -> anyhow::Result<()> { + let _operation = self.operation.lock().await; + if self.cancel.is_cancelled() { + anyhow::bail!("listener manager is stopped"); + } + let accepted_task_rx = self + .accepted_task_rx + .lock() + .unwrap() + .take() + .ok_or_else(|| anyhow::anyhow!("listener manager is one-shot and already ran"))?; + let mut initial_listeners = Vec::with_capacity(self.factories.len()); + for factory in &self.factories { + initial_listeners.push(if factory.must_succeed { + let listener = tokio::select! { + _ = self.cancel.cancelled() => { + anyhow::bail!("listener manager stopped during startup") + } + result = listen_once(factory.creator.clone()) => { + result.with_context(|| "required listener failed to start")? + } + }; + Some(listener) + } else { + None + }); + } + if self.cancel.is_cancelled() { + anyhow::bail!("listener manager stopped during startup"); + } + let initial_listeners = initial_listeners + .into_iter() + .map(|listener| { + listener.map(|listener| { + RegisteredListener::new(listener, self.events.clone(), self.registry.clone()) + }) + }) + .collect::>(); + + let mut tasks = self.tasks.lock().await; + tasks.spawn(run_accepted_task_runner( + accepted_task_rx, + self.handler_tasks.clone(), + self.cancel.clone(), + )); + + for (factory, initial_listener) in self.factories.iter().zip(initial_listeners) { + let cancel = self.cancel.clone(); + let listener = run_listener( + factory.creator.clone(), + self.handler.clone(), + self.events.clone(), + self.registry.clone(), + self.options.clone(), + self.accepted_tasks.clone(), + initial_listener, + ); + tasks.spawn(async move { + tokio::select! { + _ = cancel.cancelled() => {} + _ = listener => {} + } + }); + } + + Ok(()) + } + + pub async fn stop(&self) { + self.cancel.cancel(); + let _operation = self.operation.lock().await; + let mut tasks = self.tasks.lock().await; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + drop(tasks); + + let mut handler_tasks = self.handler_tasks.lock().await; + handler_tasks.abort_all(); + while handler_tasks.join_next().await.is_some() {} + } +} + +async fn listen_once( + creator: ListenerCreatorArc, +) -> anyhow::Result>> +where + Accepted: Send + 'static, +{ + let mut listener = creator(); + match listener.listen().await { + Ok(()) => Ok(listener), + Err(error) => Err(error), + } +} + +async fn run_listener( + creator: ListenerCreatorArc, + handler: Arc, + events: Arc, + registry: Arc, + options: ListenerManagerOptions, + accepted_tasks: AcceptedTaskSpawner, + mut initial_listener: Option>, +) where + Accepted: Send + 'static, + H: AcceptedSocketHandler + ?Sized + 'static, +{ + let mut listen_error_count = 0; + loop { + let registered_listener = match initial_listener.take() { + Some(listener) => listener, + None => { + let mut listener = creator(); + match listener.listen().await { + Ok(()) => { + listen_error_count = 0; + RegisteredListener::new(listener, events.clone(), registry.clone()) + } + Err(error) => { + listen_error_count += 1; + let will_retry = listen_error_count <= options.max_listen_retries; + events.emit(CoreEvent::ListenerAddFailed { + url: listener.local_url(), + error: format!("{error:?}"), + retry_count: listen_error_count, + will_retry, + }); + tracing::error!(?error, ?listener, "listener listen error"); + if !will_retry { + return; + } + crate::foundation::time::sleep(options.listen_retry_delay).await; + continue; + } + } + } + }; + let mut listener = registered_listener.listener; + let _registration = registered_listener.registration; + + loop { + let listener_url = listener.local_url(); + let accepted = match listener.accept().await { + Ok(accepted) => accepted, + Err(error) => { + events.emit(CoreEvent::ListenerAcceptFailed { + url: listener_url.clone(), + error: format!("{error:?}"), + }); + tracing::error!(?error, ?listener, "listener accept error"); + crate::foundation::time::sleep(options.accept_retry_delay).await; + break; + } + }; + + events.emit(CoreEvent::ListenerSocketAccepted { + url: listener_url.clone(), + }); + let handler = handler.clone(); + let events = events.clone(); + accepted_tasks.spawn(async move { + if let Err(error) = handler.handle_accepted_socket(accepted).await { + events.emit(CoreEvent::ListenerAcceptedSocketHandleFailed { + url: listener_url, + error: format!("{error:?}"), + }); + } + }); + } + } +} + +async fn run_accepted_task_runner( + mut accepted_task_rx: mpsc::UnboundedReceiver, + handler_tasks: Arc>>, + cancel: CancellationToken, +) { + // Preserve the reaping deadline when new accepts win the select. + let mut reap_interval = crate::foundation::time::interval(Duration::from_secs(1)); + loop { + tokio::select! { + _ = cancel.cancelled() => break, + maybe_task = accepted_task_rx.recv() => { + match maybe_task { + Some(task) => { + handler_tasks.lock().await.spawn(task); + } + None => break, + } + } + _ = reap_interval.tick() => { + let mut handler_tasks = handler_tasks.lock().await; + while let Some(task) = handler_tasks.try_join_next() { + if let Err(error) = task { + tracing::error!(?error, "accepted socket handler task failed"); + } + } + } + } + } + + let mut handler_tasks = handler_tasks.lock().await; + if cancel.is_cancelled() { + handler_tasks.abort_all(); + } + while let Some(task) = handler_tasks.join_next().await { + if let Err(error) = task { + tracing::error!(?error, "accepted socket handler task failed"); + } + } +} + +struct RegisteredListener +where + Accepted: Send + 'static, +{ + listener: Box>, + registration: ListenerRegistration, +} + +impl RegisteredListener +where + Accepted: Send + 'static, +{ + fn new( + listener: Box>, + events: Arc, + registry: Arc, + ) -> Self { + let url = listener.local_url(); + let registry = registry.register(url.clone()); + events.emit(CoreEvent::ListenerAdded { + url: url.clone(), + connection_counter: listener.connection_counter(), + }); + Self { + listener, + registration: ListenerRegistration { + url, + events, + registry: Some(registry), + }, + } + } +} + +struct ListenerRegistration { + url: Url, + events: Arc, + registry: Option, +} + +impl Drop for ListenerRegistration { + fn drop(&mut self) { + drop(self.registry.take()); + self.events.emit(CoreEvent::ListenerRemoved { + url: self.url.clone(), + }); + } +} + +#[cfg(test)] +mod tests { + use std::{ + collections::VecDeque, + fmt, + sync::{ + Mutex, + atomic::{AtomicUsize, Ordering}, + }, + }; + + use super::*; + + #[derive(Debug)] + struct MockListener { + url: Url, + listen_results: Arc>>>, + accepts: Arc>>>, + listen_count: Arc, + drop_count: Arc, + } + + impl Drop for MockListener { + fn drop(&mut self) { + self.drop_count.fetch_add(1, Ordering::Relaxed); + } + } + + #[async_trait] + impl SocketListener for MockListener { + type Accepted = usize; + + async fn listen(&mut self) -> anyhow::Result<()> { + self.listen_count.fetch_add(1, Ordering::Relaxed); + self.listen_results + .lock() + .unwrap() + .pop_front() + .unwrap_or(Ok(())) + } + + async fn accept(&mut self) -> anyhow::Result { + let next_accept = self.accepts.lock().unwrap().pop_front(); + match next_accept { + Some(ret) => ret, + None => std::future::pending().await, + } + } + + fn local_url(&self) -> Url { + self.url.clone() + } + } + + #[derive(Debug)] + struct BlockingListenListener { + started: Arc, + } + + #[async_trait] + impl SocketListener for BlockingListenListener { + type Accepted = usize; + + async fn listen(&mut self) -> anyhow::Result<()> { + self.started.notify_one(); + std::future::pending().await + } + + async fn accept(&mut self) -> anyhow::Result { + std::future::pending().await + } + + fn local_url(&self) -> Url { + "mock://blocking-start".parse().unwrap() + } + } + + #[derive(Debug)] + struct MockHandler { + accepted: Mutex>, + } + + #[async_trait] + impl AcceptedSocketHandler for MockHandler { + async fn handle_accepted_socket(&self, accepted: usize) -> anyhow::Result<()> { + self.accepted.lock().unwrap().push(accepted); + Ok(()) + } + } + + #[derive(Default)] + struct Events { + events: Mutex>, + } + + impl Debug for Events { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("Events").finish() + } + } + + impl CoreEventSink for Events { + fn emit(&self, event: CoreEvent) { + self.events.lock().unwrap().push(event); + } + } + + #[test] + fn running_listener_registry_reference_counts_duplicate_urls() { + let registry = Arc::new(RunningListenerRegistry::default()); + let url: Url = "tcp://127.0.0.1:11010".parse().unwrap(); + let first = registry.register(url.clone()); + let second = registry.register(url.clone()); + assert_eq!(registry.running_listeners(), vec![url.clone()]); + + drop(first); + assert_eq!(registry.running_listeners(), vec![url.clone()]); + drop(second); + assert!(registry.running_listeners().is_empty()); + } + + #[tokio::test] + async fn required_listener_reuses_successful_initial_listen() { + let handler = Arc::new(MockHandler { + accepted: Mutex::new(Vec::new()), + }); + let events = Arc::new(Events::default()); + let listen_count = Arc::new(AtomicUsize::new(0)); + let drop_count = Arc::new(AtomicUsize::new(0)); + let accepts = Arc::new(Mutex::new(VecDeque::from([Ok::<_, anyhow::Error>(7)]))); + let mut manager = ListenerManager::new_with_options( + handler.clone(), + events.clone(), + ListenerManagerOptions { + accept_retry_delay: Duration::from_millis(1), + listen_retry_delay: Duration::from_millis(1), + max_listen_retries: 0, + }, + ); + + let listener_accepts = accepts.clone(); + let listener_listen_count = listen_count.clone(); + let listener_drop_count = drop_count.clone(); + manager.add_listener( + move || { + Box::new(MockListener { + url: "mock://required".parse().unwrap(), + listen_results: Arc::new(Mutex::new(VecDeque::from([Ok(())]))), + accepts: listener_accepts.clone(), + listen_count: listener_listen_count.clone(), + drop_count: listener_drop_count.clone(), + }) + }, + true, + ); + + manager.run().await.unwrap(); + crate::foundation::time::sleep(Duration::from_millis(20)).await; + + assert_eq!(listen_count.load(Ordering::Relaxed), 1); + assert_eq!(handler.accepted.lock().unwrap().as_slice(), &[7]); + assert!( + events + .events + .lock() + .unwrap() + .iter() + .any(|event| matches!(event, CoreEvent::ListenerAdded { .. })) + ); + } + + #[tokio::test] + async fn optional_listener_retries_until_listen_succeeds() { + let handler = Arc::new(MockHandler { + accepted: Mutex::new(Vec::new()), + }); + let events = Arc::new(Events::default()); + let listen_count = Arc::new(AtomicUsize::new(0)); + let listen_results = Arc::new(Mutex::new(VecDeque::from([ + Err(anyhow::anyhow!("not ready")), + Ok(()), + ]))); + let accepts = Arc::new(Mutex::new(VecDeque::from([Ok::<_, anyhow::Error>(3)]))); + let mut manager = ListenerManager::new_with_options( + handler.clone(), + events.clone(), + ListenerManagerOptions { + accept_retry_delay: Duration::from_millis(1), + listen_retry_delay: Duration::from_millis(1), + max_listen_retries: 2, + }, + ); + + let listener_results = listen_results.clone(); + let listener_accepts = accepts.clone(); + let listener_listen_count = listen_count.clone(); + manager.add_listener( + move || { + Box::new(MockListener { + url: "mock://optional".parse().unwrap(), + listen_results: listener_results.clone(), + accepts: listener_accepts.clone(), + listen_count: listener_listen_count.clone(), + drop_count: Arc::new(AtomicUsize::new(0)), + }) + }, + false, + ); + + manager.run().await.unwrap(); + crate::foundation::time::sleep(Duration::from_millis(20)).await; + + assert!(listen_count.load(Ordering::Relaxed) >= 2); + assert_eq!(handler.accepted.lock().unwrap().as_slice(), &[3]); + assert!(events.events.lock().unwrap().iter().any(|event| matches!( + event, + CoreEvent::ListenerAddFailed { + will_retry: true, + .. + } + ))); + } + + #[tokio::test] + async fn required_listener_failure_does_not_leave_partial_tasks_running() { + let handler = Arc::new(MockHandler { + accepted: Mutex::new(Vec::new()), + }); + let events = Arc::new(Events::default()); + let first_accepts = Arc::new(Mutex::new(VecDeque::from([Ok::<_, anyhow::Error>(9)]))); + let mut manager = ListenerManager::new_with_options( + handler.clone(), + events.clone(), + ListenerManagerOptions { + accept_retry_delay: Duration::from_millis(1), + listen_retry_delay: Duration::from_millis(1), + max_listen_retries: 0, + }, + ); + + let first_accepts_clone = first_accepts.clone(); + manager.add_listener( + move || { + Box::new(MockListener { + url: "mock://first".parse().unwrap(), + listen_results: Arc::new(Mutex::new(VecDeque::from([Ok(())]))), + accepts: first_accepts_clone.clone(), + listen_count: Arc::new(AtomicUsize::new(0)), + drop_count: Arc::new(AtomicUsize::new(0)), + }) + }, + true, + ); + manager.add_listener( + move || { + Box::new(MockListener { + url: "mock://second".parse().unwrap(), + listen_results: Arc::new(Mutex::new(VecDeque::from([Err(anyhow::anyhow!( + "bind failed" + ))]))), + accepts: Arc::new(Mutex::new(VecDeque::new())), + listen_count: Arc::new(AtomicUsize::new(0)), + drop_count: Arc::new(AtomicUsize::new(0)), + }) + }, + true, + ); + + assert!(manager.run().await.is_err()); + crate::foundation::time::sleep(Duration::from_millis(20)).await; + assert!(handler.accepted.lock().unwrap().is_empty()); + assert!( + events + .events + .lock() + .unwrap() + .iter() + .all(|event| !matches!(event, CoreEvent::ListenerAdded { .. })) + ); + } + + #[tokio::test] + async fn manager_owned_closure_handler_handles_accepted_socket() { + let accepted = Arc::new(Mutex::new(Vec::new())); + let mut manager = ListenerManager::new_with_options( + Arc::new({ + let accepted = accepted.clone(); + move |value| { + let accepted = accepted.clone(); + async move { + accepted.lock().unwrap().push(value); + Ok(()) + } + } + }), + Arc::new(Events::default()), + ListenerManagerOptions { + accept_retry_delay: Duration::from_millis(1), + listen_retry_delay: Duration::from_millis(1), + max_listen_retries: 0, + }, + ); + + manager.add_listener( + move || { + Box::new(MockListener { + url: "mock://closure".parse().unwrap(), + listen_results: Arc::new(Mutex::new(VecDeque::from([Ok(())]))), + accepts: Arc::new(Mutex::new(VecDeque::from([Ok::<_, anyhow::Error>(11)]))), + listen_count: Arc::new(AtomicUsize::new(0)), + drop_count: Arc::new(AtomicUsize::new(0)), + }) + }, + true, + ); + + manager.run().await.unwrap(); + crate::foundation::time::sleep(Duration::from_millis(20)).await; + + assert_eq!(accepted.lock().unwrap().as_slice(), &[11]); + } + + #[derive(Debug)] + struct DropSignal(Option>); + + impl Drop for DropSignal { + fn drop(&mut self) { + if let Some(tx) = self.0.take() { + let _ = tx.send(()); + } + } + } + + #[derive(Debug)] + struct DropSignalListener { + url: Url, + listen_results: Arc>>>, + accepts: Arc>>>, + } + + #[async_trait] + impl SocketListener for DropSignalListener { + type Accepted = DropSignal; + + async fn listen(&mut self) -> anyhow::Result<()> { + self.listen_results + .lock() + .unwrap() + .pop_front() + .unwrap_or(Ok(())) + } + + async fn accept(&mut self) -> anyhow::Result { + let next_accept = self.accepts.lock().unwrap().pop_front(); + match next_accept { + Some(ret) => ret, + None => std::future::pending().await, + } + } + + fn local_url(&self) -> Url { + self.url.clone() + } + } + + #[derive(Debug)] + struct PendingHandler; + + #[async_trait] + impl AcceptedSocketHandler for PendingHandler { + async fn handle_accepted_socket(&self, accepted: DropSignal) -> anyhow::Result<()> { + let _accepted = accepted; + std::future::pending::<()>().await; + Ok(()) + } + } + + #[tokio::test(start_paused = true)] + async fn continuous_accepts_do_not_prevent_completed_handler_reaping() { + let (spawner, rx) = AcceptedTaskSpawner::new(); + let handler_tasks = Arc::new(tokio::sync::Mutex::new(JoinSet::new())); + let cancel = CancellationToken::new(); + let runner = tokio::spawn(run_accepted_task_runner( + rx, + handler_tasks.clone(), + cancel.clone(), + )); + + // Keep accepting more frequently than the one-second reaping period. + // Waiting for completion ensures that retained entries are finished tasks. + for _ in 0..100 { + let (completed_tx, completed_rx) = tokio::sync::oneshot::channel(); + spawner.spawn(async move { + completed_tx.send(()).unwrap(); + }); + completed_rx.await.unwrap(); + tokio::time::advance(Duration::from_millis(100)).await; + tokio::task::yield_now().await; + } + + let retained = handler_tasks.lock().await.len(); + cancel.cancel(); + runner.await.unwrap(); + + assert!( + retained <= 10, + "continuous accepts retained {retained} completed handlers" + ); + assert!(handler_tasks.lock().await.is_empty()); + } + + #[tokio::test] + async fn stop_joins_in_flight_handler_tasks_and_is_one_shot() { + let (drop_tx, drop_rx) = tokio::sync::oneshot::channel(); + let mut manager = ListenerManager::new_with_options( + Arc::new(PendingHandler), + Arc::new(Events::default()), + ListenerManagerOptions { + accept_retry_delay: Duration::from_millis(1), + listen_retry_delay: Duration::from_millis(1), + max_listen_retries: 0, + }, + ); + let accepts = Arc::new(Mutex::new(VecDeque::from([Ok::<_, anyhow::Error>( + DropSignal(Some(drop_tx)), + )]))); + let listener_accepts = accepts.clone(); + manager.add_listener( + move || { + Box::new(DropSignalListener { + url: "mock://drop".parse().unwrap(), + listen_results: Arc::new(Mutex::new(VecDeque::from([Ok(())]))), + accepts: listener_accepts.clone(), + }) + }, + true, + ); + + manager.run().await.unwrap(); + crate::foundation::time::sleep(Duration::from_millis(20)).await; + manager.stop().await; + + crate::foundation::time::timeout(Duration::from_secs(1), drop_rx) + .await + .unwrap() + .unwrap(); + assert!(manager.run().await.is_err()); + } + + #[tokio::test] + async fn stop_interrupts_required_listener_startup() { + let started = Arc::new(tokio::sync::Notify::new()); + let mut manager = ListenerManager::new_with_events( + Arc::new(MockHandler { + accepted: Mutex::new(Vec::new()), + }), + Arc::new(Events::default()), + ); + let listener_started = started.clone(); + manager.add_listener( + move || { + Box::new(BlockingListenListener { + started: listener_started.clone(), + }) + }, + true, + ); + let manager = Arc::new(manager); + let run_task = { + let manager = manager.clone(); + tokio::spawn(async move { manager.run().await }) + }; + + crate::foundation::time::timeout(Duration::from_secs(1), started.notified()) + .await + .unwrap(); + manager.stop().await; + + assert!(run_task.await.unwrap().is_err()); + assert!(manager.tasks.lock().await.is_empty()); + } + + #[tokio::test] + async fn listen_retry_exhaustion_keeps_in_flight_handler_tasks_until_manager_drop() { + let (drop_tx, mut drop_rx) = tokio::sync::oneshot::channel(); + let listen_results = Arc::new(Mutex::new(VecDeque::from([ + Ok(()), + Err(anyhow::anyhow!("bind failed")), + ]))); + let accepts = Arc::new(Mutex::new(VecDeque::from([ + Ok::<_, anyhow::Error>(DropSignal(Some(drop_tx))), + Err(anyhow::anyhow!("accept failed")), + ]))); + let events = Arc::new(Events::default()); + let mut manager = ListenerManager::new_with_options( + Arc::new(PendingHandler), + events.clone(), + ListenerManagerOptions { + accept_retry_delay: Duration::from_millis(1), + listen_retry_delay: Duration::from_millis(1), + max_listen_retries: 0, + }, + ); + let listener_results = listen_results.clone(); + let listener_accepts = accepts.clone(); + manager.add_listener( + move || { + Box::new(DropSignalListener { + url: "mock://retry-exhausted".parse().unwrap(), + listen_results: listener_results.clone(), + accepts: listener_accepts.clone(), + }) + }, + true, + ); + + manager.run().await.unwrap(); + crate::foundation::time::timeout(Duration::from_secs(1), async { + loop { + if events.events.lock().unwrap().iter().any(|event| { + matches!( + event, + CoreEvent::ListenerAddFailed { + will_retry: false, + .. + } + ) + }) { + break; + } + crate::foundation::time::sleep(Duration::from_millis(1)).await; + } + }) + .await + .unwrap(); + + assert!(matches!( + drop_rx.try_recv(), + Err(tokio::sync::oneshot::error::TryRecvError::Empty) + )); + + drop(manager); + crate::foundation::time::timeout(Duration::from_secs(1), drop_rx) + .await + .unwrap() + .unwrap(); + } +} diff --git a/vendor/easytier/easytier-core/src/listener/plan.rs b/vendor/easytier/easytier-core/src/listener/plan.rs new file mode 100644 index 0000000..6d044ed --- /dev/null +++ b/vendor/easytier/easytier-core/src/listener/plan.rs @@ -0,0 +1,475 @@ +use std::{ + collections::{BTreeMap, BTreeSet}, + net::IpAddr, + str::FromStr, +}; + +use percent_encoding::percent_decode_str; +use serde::{Deserialize, Serialize}; +use url::Url; + +use crate::{ + connectivity::{ + protocol::{ProtocolTransport, ServerProtocolUpgrader, protocol_transport}, + transport::UdpSessionMode, + }, + socket::{ + SocketContext, + tcp::{TcpBindOptions, TcpListenOptions}, + udp::{UdpBindOptions, UdpSessionAcceptKind, UdpSessionListenRequest}, + }, +}; + +use super::{ExternalListenerFactory, transport::TransportListenerConfig}; + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(crate) enum ListenerKind { + Ring, + TcpStream, + UdpSession, + External, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) enum ListenerPlanSource { + Ring, + Configured, + Ipv6Shadow { original: Url }, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) struct PlannedListener { + pub url: Url, + pub kind: ListenerKind, + pub must_succeed: bool, + pub source: ListenerPlanSource, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) struct ListenerPlanFailure { + pub url: Url, + pub message: String, +} + +#[derive(Debug, Clone, Default, PartialEq, Eq)] +pub(crate) struct ListenerPlan { + pub listeners: Vec, + pub failures: Vec, +} + +#[derive(Debug, Clone, Default, PartialEq, Eq)] +pub(crate) struct ListenerSchemeRegistry { + schemes: BTreeMap, + no_ipv6_shadow: BTreeSet, +} + +impl ListenerSchemeRegistry { + pub(crate) fn new() -> Self { + Self::default() + } + + pub(crate) fn support(mut self, scheme: impl Into, kind: ListenerKind) -> Self { + self.schemes.insert(normalize_scheme(scheme), kind); + self + } + + pub(crate) fn disable_ipv6_shadow(mut self, scheme: impl Into) -> Self { + self.no_ipv6_shadow.insert(normalize_scheme(scheme)); + self + } + + pub(crate) fn classify(&self, url: &Url) -> Option { + self.schemes.get(url.scheme()).copied() + } + + fn allows_ipv6_shadow(&self, url: &Url) -> bool { + !self.no_ipv6_shadow.contains(url.scheme()) + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) struct ListenerPlanRequest { + pub self_id: uuid::Uuid, + pub listeners: Vec, + pub enable_ipv6: bool, +} + +/// Normalized listener inputs owned and planned by one core instance. +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct ListenerRuntimeConfig { + pub urls: Vec, + pub enable_ipv6: bool, + pub socket_context: SocketContext, +} + +impl ListenerRuntimeConfig { + pub fn new(urls: Vec, enable_ipv6: bool, socket_context: SocketContext) -> Self { + Self { + urls, + enable_ipv6, + socket_context, + } + } + + pub(crate) fn request(&self, self_id: uuid::Uuid) -> ListenerPlanRequest { + ListenerPlanRequest::new(self_id, self.urls.clone(), self.enable_ipv6) + } +} + +pub(crate) struct PreparedListenerPlan { + pub transports: Vec, + pub external: Vec<(PlannedListener, SocketContext)>, + pub failures: Vec, +} + +pub(crate) fn prepare_listener_plan( + config: Option<&ListenerRuntimeConfig>, + self_id: uuid::Uuid, + server_protocol: Option<&dyn ServerProtocolUpgrader>, + external_factory: Option<&dyn ExternalListenerFactory>, +) -> anyhow::Result +where + Accepted: Send + 'static, +{ + let Some(config) = config else { + return Ok(PreparedListenerPlan { + transports: Vec::new(), + external: Vec::new(), + failures: Vec::new(), + }); + }; + let mut schemes = ListenerSchemeRegistry::new() + .support("tcp", ListenerKind::TcpStream) + .support("udp", ListenerKind::UdpSession); + for (scheme, kind) in [ + ("ws", ListenerKind::TcpStream), + ("wss", ListenerKind::TcpStream), + ("wg", ListenerKind::UdpSession), + ("quic", ListenerKind::UdpSession), + ] { + if server_protocol.is_some_and(|protocol| protocol.supports_scheme(scheme)) { + schemes = schemes.support(scheme, kind); + } + } + schemes = schemes.disable_ipv6_shadow("quic"); + if server_protocol.is_some_and(|protocol| protocol.supports_scheme("faketcp")) + && external_factory.is_some_and(|factory| factory.supports_scheme("faketcp")) + { + schemes = schemes.support("faketcp", ListenerKind::External); + } + if external_factory.is_some_and(|factory| factory.supports_scheme("unix")) { + schemes = schemes.support("unix", ListenerKind::External); + } + schemes = schemes.disable_ipv6_shadow("faketcp"); + + let plan = plan_listeners(config.request(self_id), &schemes); + let mut transports = Vec::new(); + let mut external = Vec::new(); + for listener in plan.listeners { + let must_succeed = listener.must_succeed; + match listener.kind { + ListenerKind::Ring => transports.push(TransportListenerConfig::Ring { + url: listener.url, + must_succeed, + }), + ListenerKind::TcpStream => { + let max_pending_upgrades = server_protocol + .and_then(|protocol| protocol.max_pending_tcp_upgrades(listener.url.scheme())); + transports.push(TransportListenerConfig::Tcp { + url: listener.url, + options: unresolved_tcp_listener_options(config.socket_context.clone()), + max_pending_upgrades, + must_succeed, + }); + } + ListenerKind::UdpSession => { + let accept_kind = match protocol_transport(listener.url.scheme()) { + Some(ProtocolTransport::Udp(UdpSessionMode::EasyTierMux)) => { + UdpSessionAcceptKind::EasyTierMux + } + Some(ProtocolTransport::Udp(UdpSessionMode::Classified(protocol))) => { + UdpSessionAcceptKind::Classified(protocol) + } + _ => anyhow::bail!( + "listener scheme {} cannot produce a core UDP session", + listener.url.scheme() + ), + }; + let request = unresolved_udp_session_listen_request( + &listener.url, + config.socket_context.clone(), + ); + transports.push(TransportListenerConfig::Udp { + url: listener.url, + request, + accept_kind, + must_succeed, + }); + } + ListenerKind::External => external.push((listener, config.socket_context.clone())), + } + } + validate_listener_protocols(&transports, server_protocol.is_some())?; + + Ok(PreparedListenerPlan { + transports, + external, + failures: plan.failures, + }) +} + +fn validate_listener_protocols( + listeners: &[TransportListenerConfig], + has_server_protocol: bool, +) -> anyhow::Result<()> { + if has_server_protocol { + return Ok(()); + } + if let Some(listener) = listeners + .iter() + .find(|listener| !listener.supports_raw_handler()) + { + anyhow::bail!( + "listener {} requires a server protocol upgrader", + listener.url() + ); + } + Ok(()) +} + +impl ListenerPlanRequest { + pub(crate) fn new(self_id: uuid::Uuid, listeners: Vec, enable_ipv6: bool) -> Self { + Self { + self_id, + listeners, + enable_ipv6, + } + } +} + +pub(crate) fn plan_listeners( + request: ListenerPlanRequest, + registry: &ListenerSchemeRegistry, +) -> ListenerPlan { + let mut plan = ListenerPlan::default(); + plan.listeners.push(PlannedListener { + url: ring_listener_url(request.self_id), + kind: ListenerKind::Ring, + must_succeed: true, + source: ListenerPlanSource::Ring, + }); + + for url in request.listeners { + let Some(kind) = registry.classify(&url) else { + plan.failures.push(unsupported_listener(&url)); + continue; + }; + + plan.listeners.push(PlannedListener { + url: url.clone(), + kind, + must_succeed: true, + source: ListenerPlanSource::Configured, + }); + + if should_add_ipv6_shadow_listener(&url, request.enable_ipv6, registry) { + match ipv6_shadow_listener(&url) { + Ok(ipv6_url) => plan.listeners.push(PlannedListener { + url: ipv6_url, + kind, + must_succeed: false, + source: ListenerPlanSource::Ipv6Shadow { original: url }, + }), + Err(message) => plan.failures.push(ListenerPlanFailure { url, message }), + } + } + } + + plan +} + +pub(crate) fn ring_listener_url(self_id: uuid::Uuid) -> Url { + format!("ring://{self_id}") + .parse() + .expect("ring listener url should be valid") +} + +pub(crate) fn listener_default_port(scheme: &str) -> Option { + crate::connectivity::protocol::protocol_default_port(scheme) +} + +pub(crate) fn listener_url_bind_device(url: &Url) -> Option { + url.path().strip_prefix('/').and_then(|path| { + if path.is_empty() { + None + } else { + Some(String::from_utf8(percent_decode_str(path).collect()).unwrap()) + } + }) +} + +pub(crate) fn unresolved_udp_session_listen_request( + url: &Url, + context: SocketContext, +) -> UdpSessionListenRequest { + UdpSessionListenRequest::new( + UdpBindOptions::port_bound_listener("0.0.0.0:0".parse().unwrap()) + .with_local_addr(None) + .with_context(context) + .with_bind_device(listener_url_bind_device(url)), + ) +} + +pub(crate) fn unresolved_tcp_listener_options(context: SocketContext) -> TcpListenOptions { + TcpListenOptions::direct_connect("0.0.0.0:0".parse().unwrap()) + .with_bind(TcpBindOptions::default().with_context(context)) +} + +pub(crate) fn is_url_host_ipv6(url: &Url) -> bool { + url.host_str().is_some_and(|h| h.contains(':')) +} + +pub(crate) fn is_url_host_unspecified(url: &Url) -> bool { + if let Ok(ip) = IpAddr::from_str(url.host_str().unwrap_or_default()) { + ip.is_unspecified() + } else { + false + } +} + +fn should_add_ipv6_shadow_listener( + url: &Url, + enable_ipv6: bool, + registry: &ListenerSchemeRegistry, +) -> bool { + enable_ipv6 + && registry.allows_ipv6_shadow(url) + && !is_url_host_ipv6(url) + && is_url_host_unspecified(url) +} + +fn ipv6_shadow_listener(url: &Url) -> Result { + let mut ipv6_url = url.clone(); + ipv6_url + .set_host(Some("[::]")) + .map_err(|_| format!("failed to set ipv6 host for listener: {url}"))?; + Ok(ipv6_url) +} + +fn unsupported_listener(url: &Url) -> ListenerPlanFailure { + ListenerPlanFailure { + url: url.clone(), + message: format!("failed to get listener by url: {url}, maybe not supported"), + } +} + +fn normalize_scheme(scheme: impl Into) -> String { + scheme.into().to_ascii_lowercase() +} + +#[cfg(test)] +mod tests { + use super::*; + + fn registry() -> ListenerSchemeRegistry { + ListenerSchemeRegistry::new() + .support("tcp", ListenerKind::TcpStream) + .support("udp", ListenerKind::UdpSession) + .support("quic", ListenerKind::External) + .support("faketcp", ListenerKind::External) + .disable_ipv6_shadow("quic") + .disable_ipv6_shadow("faketcp") + } + + #[test] + fn listener_plan_adds_ring_and_configured_listener() { + let self_id = uuid::Uuid::parse_str("00000000-0000-0000-0000-000000000001").unwrap(); + let plan = plan_listeners( + ListenerPlanRequest::new( + self_id, + vec!["udp://127.0.0.1:11010".parse().unwrap()], + false, + ), + ®istry(), + ); + + assert_eq!(plan.failures, Vec::new()); + assert_eq!( + plan.listeners + .iter() + .map(|entry| (&entry.url, entry.kind, entry.must_succeed)) + .collect::>(), + vec![ + ( + &"ring://00000000-0000-0000-0000-000000000001" + .parse() + .unwrap(), + ListenerKind::Ring, + true + ), + ( + &"udp://127.0.0.1:11010".parse().unwrap(), + ListenerKind::UdpSession, + true + ), + ] + ); + } + + #[test] + fn listener_plan_adds_ipv6_shadow_for_unspecified_ip_listener() { + let plan = plan_listeners( + ListenerPlanRequest::new( + uuid::Uuid::new_v4(), + vec!["tcp://0.0.0.0:11010".parse().unwrap()], + true, + ), + ®istry(), + ); + + assert_eq!(plan.failures, Vec::new()); + assert_eq!(plan.listeners.len(), 3); + assert_eq!(plan.listeners[2].url, "tcp://[::]:11010".parse().unwrap()); + assert!(!plan.listeners[2].must_succeed); + assert!(matches!( + plan.listeners[2].source, + ListenerPlanSource::Ipv6Shadow { .. } + )); + } + + #[test] + fn listener_plan_skips_ipv6_shadow_for_excluded_schemes() { + for url in ["quic://0.0.0.0:11012", "faketcp://0.0.0.0:11013"] { + let plan = plan_listeners( + ListenerPlanRequest::new(uuid::Uuid::new_v4(), vec![url.parse().unwrap()], true), + ®istry(), + ); + + assert_eq!(plan.failures, Vec::new()); + assert_eq!(plan.listeners.len(), 2); + } + } + + #[test] + fn listener_plan_reports_unsupported_scheme() { + let url = "http://0.0.0.0:8080".parse().unwrap(); + let plan = plan_listeners( + ListenerPlanRequest::new(uuid::Uuid::new_v4(), vec![url], true), + ®istry(), + ); + + assert_eq!(plan.listeners.len(), 1); + assert_eq!(plan.failures.len(), 1); + assert_eq!( + plan.failures[0].message, + "failed to get listener by url: http://0.0.0.0:8080/, maybe not supported" + ); + } + + #[test] + fn listener_url_bind_device_decodes_url_path() { + let url = "udp://0.0.0.0:11010/eth%2Btest".parse().unwrap(); + + assert_eq!(listener_url_bind_device(&url), Some("eth+test".to_owned())); + } +} diff --git a/vendor/easytier/easytier-core/src/listener/queue.rs b/vendor/easytier/easytier-core/src/listener/queue.rs new file mode 100644 index 0000000..3734b10 --- /dev/null +++ b/vendor/easytier/easytier-core/src/listener/queue.rs @@ -0,0 +1,149 @@ +use std::{collections::VecDeque, sync::Mutex}; + +use tokio::sync::Notify; + +struct HostListenerQueueState { + closed: bool, + listeners: usize, + pending: VecDeque, +} + +/// Bounded handoff from a synchronous Host callback to async listeners. +pub(crate) struct HostListenerQueue { + capacity: usize, + state: Mutex>, + changed: Notify, +} + +impl HostListenerQueue { + pub(crate) fn new(capacity: usize) -> Self { + Self { + capacity, + state: Mutex::new(HostListenerQueueState { + closed: false, + listeners: 0, + pending: VecDeque::new(), + }), + changed: Notify::new(), + } + } + + pub(crate) fn register_listener(&self) -> bool { + let mut state = self.state.lock().unwrap(); + if state.closed { + return false; + } + state.listeners += 1; + true + } + + pub(crate) fn unregister_listener(&self) { + let pending = { + let mut state = self.state.lock().unwrap(); + debug_assert!(state.listeners > 0); + state.listeners -= 1; + if state.listeners != 0 { + return; + } + state.closed = true; + std::mem::take(&mut state.pending) + }; + drop(pending); + self.changed.notify_waiters(); + } + + /// Constructs `T` only after the queue accepts Host-to-guest ownership. + pub(crate) fn enqueue_with(&self, create: impl FnOnce() -> T) -> anyhow::Result<()> { + { + let mut state = self.state.lock().unwrap(); + if state.closed || state.listeners == 0 { + anyhow::bail!("Host listener queue is closed"); + } + if state.pending.len() >= self.capacity { + anyhow::bail!("Host listener admission queue is full"); + } + state.pending.push_back(create()); + } + self.changed.notify_one(); + Ok(()) + } + + pub(crate) async fn accept(&self) -> Option { + loop { + let changed = self.changed.notified(); + { + let mut state = self.state.lock().unwrap(); + if let Some(item) = state.pending.pop_front() { + return Some(item); + } + if state.closed { + return None; + } + } + changed.await; + } + } +} + +#[cfg(test)] +mod tests { + use std::sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, + }; + + use super::HostListenerQueue; + + struct DropCounter(Arc); + + impl Drop for DropCounter { + fn drop(&mut self) { + self.0.fetch_add(1, Ordering::Relaxed); + } + } + + #[tokio::test] + async fn constructs_only_after_listener_accepts_ownership() { + let queue = HostListenerQueue::new(1); + let constructed = AtomicUsize::new(0); + + assert!( + queue + .enqueue_with(|| { + constructed.fetch_add(1, Ordering::Relaxed); + }) + .is_err() + ); + assert_eq!(constructed.load(Ordering::Relaxed), 0); + + assert!(queue.register_listener()); + queue + .enqueue_with(|| { + constructed.fetch_add(1, Ordering::Relaxed); + }) + .unwrap(); + assert!( + queue + .enqueue_with(|| { + constructed.fetch_add(1, Ordering::Relaxed); + }) + .is_err() + ); + assert_eq!(constructed.load(Ordering::Relaxed), 1); + queue.accept().await.unwrap(); + queue.unregister_listener(); + } + + #[test] + fn last_listener_closes_and_drains_pending_items() { + let queue = HostListenerQueue::new(1); + let drops = Arc::new(AtomicUsize::new(0)); + assert!(queue.register_listener()); + queue.enqueue_with(|| DropCounter(drops.clone())).unwrap(); + + queue.unregister_listener(); + + assert_eq!(drops.load(Ordering::Relaxed), 1); + assert!(!queue.register_listener()); + } +} diff --git a/vendor/easytier/easytier-core/src/listener/transport.rs b/vendor/easytier/easytier-core/src/listener/transport.rs new file mode 100644 index 0000000..16c5d70 --- /dev/null +++ b/vendor/easytier/easytier-core/src/listener/transport.rs @@ -0,0 +1,1581 @@ +use std::{fmt, marker::PhantomData, sync::Arc}; + +use async_trait::async_trait; +use rand::seq::SliceRandom as _; +use tokio::sync::{OwnedSemaphorePermit, Semaphore}; +use url::Url; + +use crate::{ + connectivity::{ + manual::resolve_url_addrs, + protocol::{ + ServerProtocolAdmissionController, ServerProtocolUpgrade, ServerProtocolUpgrader, raw, + }, + }, + events::{CoreEvent, CoreEventSink}, + host::dns::DnsResolver, + listener::{ + AcceptedSocketHandler, ListenerFactory, ListenerManager, RunningListenerRegistry, + plan::ListenerPlanFailure, + }, + socket::{ + IpVersion, ListenerConnectionCounter, SocketContext, SocketListener, + tcp::{TcpListenOptions, TcpSocketListener, VirtualTcpListener, VirtualTcpListenerFactory}, + udp::{ + UdpSession, UdpSessionAcceptKind, UdpSessionListenRequest, UdpSessionSocket, + UdpSessionSocketListener, VirtualUdpSocketFactory, + }, + }, + tunnel::{Tunnel, ring::RingTunnelRegistry}, +}; + +pub type HostAcceptedTcpSocket = + <::Listener as VirtualTcpListener>::Socket; + +/// The transport boundary of a core listener. +/// +/// Socket creation and binding belong to the host factory. Protocol handling +/// consumes this value and may turn it into one or more EasyTier tunnels. +#[allow(clippy::large_enum_variant)] +pub enum AcceptedTransport { + Tunnel { + tunnel: Box, + local_url: Url, + }, + Tcp { + socket: TcpSocket, + local_url: Url, + upgrade_permit: Option, + }, + Udp { + session: UdpSession, + local_url: Url, + admission: Option, + }, + ByteStream { + socket: TcpSocket, + local_url: Url, + remote_url: Option, + }, +} + +impl AcceptedTransport { + pub fn local_url(&self) -> &Url { + match self { + Self::Tunnel { local_url, .. } + | Self::Tcp { local_url, .. } + | Self::Udp { local_url, .. } + | Self::ByteStream { local_url, .. } => local_url, + } + } +} + +#[async_trait] +pub trait AcceptedTunnelHandler: Send + Sync + 'static { + async fn handle_tunnel(&self, tunnel: Box) -> anyhow::Result<()>; +} + +/// Upgrades accepted sockets or sessions in core before peer admission. +pub struct ProtocolAcceptedTransportHandler { + tunnel_handler: Arc, + protocol: Arc>, +} + +impl ProtocolAcceptedTransportHandler { + pub fn new( + tunnel_handler: &Arc, + protocol: Arc>, + ) -> Self { + Self { + tunnel_handler: tunnel_handler.clone(), + protocol, + } + } +} + +impl ProtocolAcceptedTransportHandler +where + H: AcceptedTunnelHandler, +{ + async fn handle_tunnel(&self, tunnel: Box) -> anyhow::Result<()> { + self.tunnel_handler.handle_tunnel(tunnel).await + } + + async fn handle_upgrade(&self, upgrade: ServerProtocolUpgrade) -> anyhow::Result<()> { + match upgrade { + ServerProtocolUpgrade::Tunnel(tunnel) => self.handle_tunnel(tunnel).await, + ServerProtocolUpgrade::Acceptor(mut acceptor) => loop { + let tunnel = acceptor.accept().await?; + let _ = self.handle_tunnel(tunnel).await; + }, + } + } +} + +#[async_trait] +impl AcceptedSocketHandler> + for ProtocolAcceptedTransportHandler +where + TcpSocket: crate::socket::tcp::VirtualTcpSocket, + H: AcceptedTunnelHandler, +{ + async fn handle_accepted_socket( + &self, + accepted: AcceptedTransport, + ) -> anyhow::Result<()> { + let (upgrade, tcp_upgrade_permit) = match accepted { + AcceptedTransport::Tunnel { tunnel, .. } => { + return self.handle_tunnel(tunnel).await; + } + AcceptedTransport::Tcp { + socket, + local_url, + upgrade_permit, + } => ( + self.protocol.upgrade_tcp(socket, local_url).await?, + upgrade_permit, + ), + AcceptedTransport::Udp { + session, + local_url, + admission, + } => ( + self.protocol + .upgrade_udp(session, local_url, admission) + .await?, + None, + ), + AcceptedTransport::ByteStream { + socket, + local_url, + remote_url, + } if local_url.scheme() == "unix" => { + let tunnel = raw::upgrade_accepted_byte_stream(socket, local_url, remote_url)?; + return self.handle_tunnel(tunnel).await; + } + AcceptedTransport::ByteStream { + socket, + local_url, + remote_url, + } => ( + self.protocol + .upgrade_byte_stream(socket, local_url, remote_url) + .await?, + None, + ), + }; + drop(tcp_upgrade_permit); + self.handle_upgrade(upgrade).await + } +} + +#[derive(Debug, Clone)] +pub(crate) enum TransportListenerConfig { + Ring { + url: Url, + must_succeed: bool, + }, + Tcp { + url: Url, + options: TcpListenOptions, + max_pending_upgrades: Option, + must_succeed: bool, + }, + Udp { + url: Url, + request: UdpSessionListenRequest, + accept_kind: UdpSessionAcceptKind, + must_succeed: bool, + }, +} + +impl TransportListenerConfig { + pub(crate) fn must_succeed(&self) -> bool { + match self { + Self::Ring { must_succeed, .. } + | Self::Tcp { must_succeed, .. } + | Self::Udp { must_succeed, .. } => *must_succeed, + } + } + + pub(crate) fn url(&self) -> &Url { + match self { + Self::Ring { url, .. } | Self::Tcp { url, .. } | Self::Udp { url, .. } => url, + } + } + + pub(crate) fn supports_raw_handler(&self) -> bool { + matches!(self, Self::Ring { url, .. } if url.scheme() == "ring") + || matches!(self, Self::Tcp { url, .. } if url.scheme() == "tcp") + || matches!( + self, + Self::Udp { + url, + accept_kind: UdpSessionAcceptKind::EasyTierMux, + .. + } if url.scheme() == "udp" + ) + } +} + +struct RingTransportListener { + url: Url, + registry: Arc, + inner: Option, + tcp_socket: PhantomData TcpSocket>, +} + +impl RingTransportListener { + fn new(url: Url, registry: Arc) -> Self { + Self { + url, + registry, + inner: None, + tcp_socket: PhantomData, + } + } +} + +impl fmt::Debug for RingTransportListener { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("RingTransportListener") + .field("url", &self.url) + .field("listening", &self.inner.is_some()) + .finish() + } +} + +#[async_trait] +impl SocketListener for RingTransportListener +where + TcpSocket: Send + 'static, +{ + type Accepted = AcceptedTransport; + + async fn listen(&mut self) -> anyhow::Result<()> { + if self.inner.is_none() { + if self.url.scheme() != "ring" { + anyhow::bail!("Ring listener requires ring URL: {}", self.url); + } + let local_id = self + .url + .host_str() + .ok_or_else(|| anyhow::anyhow!("ring listener URL has no peer id: {}", self.url))? + .parse()?; + self.inner = Some(self.registry.bind(local_id)?); + } + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + let accepted = self + .inner + .as_mut() + .ok_or_else(|| anyhow::anyhow!("Ring transport listener is not started"))? + .accept() + .await?; + Ok(AcceptedTransport::Tunnel { + tunnel: accepted.into_tunnel(), + local_url: self.url.clone(), + }) + } + + fn local_url(&self) -> Url { + self.url.clone() + } +} + +struct TcpTransportListener +where + H: VirtualTcpListenerFactory, +{ + url: Url, + options: TcpListenOptions, + host: Arc, + dns: Arc, + upgrade_slots: Option>, + inner: Option>, +} + +impl TcpTransportListener +where + H: VirtualTcpListenerFactory, +{ + fn new( + url: Url, + options: TcpListenOptions, + max_pending_upgrades: Option, + host: Arc, + dns: Arc, + ) -> Self { + let upgrade_slots = max_pending_upgrades.map(|limit| Arc::new(Semaphore::new(limit.get()))); + Self { + url, + options, + host, + dns, + upgrade_slots, + inner: None, + } + } + + fn inner(&mut self) -> anyhow::Result<&mut TcpSocketListener> { + self.inner + .as_mut() + .ok_or_else(|| anyhow::anyhow!("TCP transport listener is not started")) + } +} + +impl fmt::Debug for TcpTransportListener +where + H: VirtualTcpListenerFactory, +{ + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("TcpTransportListener") + .field("url", &self.url) + .field("listening", &self.inner.is_some()) + .finish() + } +} + +#[async_trait] +impl SocketListener for TcpTransportListener +where + H: VirtualTcpListenerFactory, +{ + type Accepted = AcceptedTransport>; + + async fn listen(&mut self) -> anyhow::Result<()> { + if self.inner.is_some() { + return Ok(()); + } + let mut options = self.options.clone(); + if options.bind.local_addr.is_none() { + options.bind.local_addr = Some( + resolve_listener_addr(&self.url, options.bind.context.clone(), self.dns.as_ref()) + .await?, + ); + } + if let Some(local_addr) = options.bind.local_addr { + options.bind.context.ip_version = if local_addr.is_ipv4() { + IpVersion::V4 + } else { + IpVersion::V6 + }; + options.bind.only_v6 = local_addr.is_ipv6(); + } + let mut inner = + TcpSocketListener::new_with_options(self.url.clone(), options, self.host.clone()); + inner.listen().await?; + self.inner = Some(inner); + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + let upgrade_permit = match &self.upgrade_slots { + Some(slots) => Some(slots.clone().acquire_owned().await?), + None => None, + }; + let local_url = self.local_url(); + let socket = self.inner()?.accept().await?; + Ok(AcceptedTransport::Tcp { + socket, + local_url, + upgrade_permit, + }) + } + + fn local_url(&self) -> Url { + self.inner + .as_ref() + .map(SocketListener::local_url) + .unwrap_or_else(|| self.url.clone()) + } + + fn connection_counter(&self) -> Arc { + self.inner + .as_ref() + .map(SocketListener::connection_counter) + .unwrap_or_else(|| Arc::new(EmptyTransportConnectionCounter)) + } +} + +struct UdpTransportListener +where + H: VirtualUdpSocketFactory, +{ + url: Url, + request: UdpSessionListenRequest, + accept_kind: UdpSessionAcceptKind, + host: Arc, + dns: Arc, + inner: Option>, + protocol_admission: Option, + tcp_socket: PhantomData TcpSocket>, +} + +impl UdpTransportListener +where + H: VirtualUdpSocketFactory, +{ + fn new( + url: Url, + request: UdpSessionListenRequest, + accept_kind: UdpSessionAcceptKind, + host: Arc, + dns: Arc, + ) -> Self { + let protocol_admission = matches!( + accept_kind, + UdpSessionAcceptKind::Classified(crate::socket::udp::UdpSessionProtocol::Quic) + ) + .then(ServerProtocolAdmissionController::quic); + Self { + url, + request, + accept_kind, + host, + dns, + inner: None, + protocol_admission, + tcp_socket: PhantomData, + } + } + + fn inner(&mut self) -> anyhow::Result<&mut UdpSessionSocketListener> { + self.inner + .as_mut() + .ok_or_else(|| anyhow::anyhow!("UDP transport listener is not started")) + } +} + +impl fmt::Debug for UdpTransportListener +where + H: VirtualUdpSocketFactory, +{ + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("UdpTransportListener") + .field("url", &self.url) + .field("accept_kind", &self.accept_kind) + .field("listening", &self.inner.is_some()) + .finish() + } +} + +#[async_trait] +impl SocketListener for UdpTransportListener +where + H: VirtualUdpSocketFactory, + TcpSocket: Send + 'static, +{ + type Accepted = AcceptedTransport; + + async fn listen(&mut self) -> anyhow::Result<()> { + if self.inner.is_some() { + return Ok(()); + } + let mut request = self.request.clone(); + if request.bind.local_addr.is_none() { + request.bind.local_addr = Some( + resolve_listener_addr(&self.url, request.bind.context.clone(), self.dns.as_ref()) + .await?, + ); + } + if let Some(local_addr) = request.bind.local_addr { + request.bind.context.ip_version = if local_addr.is_ipv4() { + IpVersion::V4 + } else { + IpVersion::V6 + }; + request.bind.only_v6 = local_addr.is_ipv6(); + } + let mut inner = UdpSessionSocketListener::new_with_request( + self.url.clone(), + request, + self.accept_kind, + self.host.clone(), + ); + inner.listen().await?; + self.inner = Some(inner); + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + loop { + let session = self.inner()?.accept().await?; + let admission = match &self.protocol_admission { + Some(controller) => match controller.try_admit() { + Some(admission) => Some(admission), + None => { + tracing::debug!( + peer_addr = ?session.peer_addr(), + "drop UDP session after protocol admission limit" + ); + continue; + } + }, + None => None, + }; + return Ok(AcceptedTransport::Udp { + session, + local_url: self.local_url(), + admission, + }); + } + } + + fn local_url(&self) -> Url { + self.inner + .as_ref() + .map(SocketListener::local_url) + .unwrap_or_else(|| self.url.clone()) + } + + fn connection_counter(&self) -> Arc { + self.inner + .as_ref() + .map(SocketListener::connection_counter) + .unwrap_or_else(|| Arc::new(EmptyTransportConnectionCounter)) + } +} + +#[derive(Debug)] +struct EmptyTransportConnectionCounter; + +impl ListenerConnectionCounter for EmptyTransportConnectionCounter { + fn get(&self) -> Option { + None + } +} + +async fn resolve_listener_addr( + url: &Url, + context: SocketContext, + dns: &dyn DnsResolver, +) -> anyhow::Result { + let default_port = super::plan::listener_default_port(url.scheme()) + .ok_or_else(|| anyhow::anyhow!("listener has no default port: {url}"))?; + resolve_url_addrs( + url, + default_port, + context.with_ip_version(IpVersion::Both), + dns, + ) + .await? + .choose(&mut rand::thread_rng()) + .copied() + .ok_or_else(|| anyhow::anyhow!("listener has no resolved address: {url}")) +} + +type HostTransportListenerManager = ListenerManager< + AcceptedTransport>, + dyn AcceptedSocketHandler>>, +>; + +/// Owns all listeners planned by core, including host-backed external sockets. +pub(crate) struct CoreListenerRuntime +where + H: VirtualTcpListenerFactory + VirtualUdpSocketFactory, +{ + manager: HostTransportListenerManager, + plan_failures: Vec, + events: Arc, +} + +impl CoreListenerRuntime +where + H: VirtualTcpListenerFactory + VirtualUdpSocketFactory, +{ + #[allow(clippy::too_many_arguments)] + pub(crate) fn new_with_events( + host: Arc, + dns: Arc, + ring_registry: Arc, + configs: Vec, + external_factories: Vec>>>, + plan_failures: Vec, + handler: Arc>>>, + events: Arc, + registry: Arc, + ) -> Self { + let mut manager = ListenerManager::new_with_registry( + handler, + events.clone(), + registry, + crate::listener::ListenerManagerOptions::default(), + ); + + for config in configs { + let must_succeed = config.must_succeed(); + match config { + TransportListenerConfig::Ring { url, .. } => { + let ring_registry = ring_registry.clone(); + manager.add_listener( + move || { + Box::new(RingTransportListener::new( + url.clone(), + ring_registry.clone(), + )) + }, + must_succeed, + ); + } + TransportListenerConfig::Tcp { + url, + options, + max_pending_upgrades, + .. + } => { + let host = host.clone(); + let dns = dns.clone(); + manager.add_listener( + move || { + Box::new(TcpTransportListener::new( + url.clone(), + options.clone(), + max_pending_upgrades, + host.clone(), + dns.clone(), + )) + }, + must_succeed, + ); + } + TransportListenerConfig::Udp { + url, + request, + accept_kind, + .. + } => { + let host = host.clone(); + let dns = dns.clone(); + manager.add_listener( + move || { + Box::new(UdpTransportListener::new( + url.clone(), + request.clone(), + accept_kind, + host.clone(), + dns.clone(), + )) + }, + must_succeed, + ); + } + } + } + + for factory in external_factories { + manager.add_factory(factory); + } + + Self { + manager, + plan_failures, + events, + } + } + + pub async fn start(&self) -> anyhow::Result<()> { + for failure in &self.plan_failures { + self.events.emit(CoreEvent::ListenerPlanFailed { + url: failure.url.clone(), + error: failure.message.clone(), + }); + } + self.manager.run().await + } + + pub async fn stop(&self) { + self.manager.stop().await; + } +} + +#[cfg(test)] +mod tests { + use std::{ + collections::VecDeque, + io, + net::SocketAddr, + pin::Pin, + sync::{ + Arc, Mutex as StdMutex, + atomic::{AtomicU16, AtomicUsize, Ordering}, + }, + task::{Context, Poll}, + time::Duration, + }; + + use futures::{SinkExt as _, StreamExt as _}; + use tokio::{ + io::{AsyncRead, AsyncWrite, DuplexStream, ReadBuf}, + sync::{Mutex, Notify, Semaphore, mpsc}, + }; + + use super::*; + use crate::{ + connectivity::protocol::{CoreServerProtocolUpgrader, ServerTunnelAcceptor}, + host::dns::{DnsQuery, DnsResolver}, + packet::ZCPacket, + socket::{ + tcp::{VirtualTcpListener, VirtualTcpSocket}, + udp::{ + UdpBindOptions, UdpSessionKind, UdpSessionProtocol, UdpSessionSocket, + VirtualUdpSocket, new_syn_packet, + }, + }, + }; + + struct MockDns; + + #[async_trait] + impl DnsResolver for MockDns { + async fn resolve(&self, _query: DnsQuery) -> anyhow::Result> { + Ok(vec!["127.0.0.1".parse().unwrap()]) + } + } + + struct MockTcpSocket { + stream: DuplexStream, + local_addr: SocketAddr, + peer_addr: SocketAddr, + } + + impl AsyncRead for MockTcpSocket { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + Pin::new(&mut self.stream).poll_read(cx, buf) + } + } + + impl AsyncWrite for MockTcpSocket { + fn poll_write( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut self.stream).poll_write(cx, buf) + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_flush(cx) + } + + fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_shutdown(cx) + } + } + + impl VirtualTcpSocket for MockTcpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + fn peer_addr(&self) -> io::Result { + Ok(self.peer_addr) + } + } + + struct MockTcpListener { + local_addr: SocketAddr, + accepted_tx: mpsc::UnboundedSender, + accepted_rx: Mutex>, + } + + impl MockTcpListener { + fn new(local_addr: SocketAddr) -> Self { + let (accepted_tx, accepted_rx) = mpsc::unbounded_channel(); + Self { + local_addr, + accepted_tx, + accepted_rx: Mutex::new(accepted_rx), + } + } + + fn accept_from(&self, peer_addr: SocketAddr) { + let (stream, _remote) = tokio::io::duplex(64); + self.accepted_tx + .send(MockTcpSocket { + stream, + local_addr: self.local_addr, + peer_addr, + }) + .unwrap(); + } + } + + #[async_trait] + impl VirtualTcpListener for MockTcpListener { + type Socket = MockTcpSocket; + + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn accept(&self) -> io::Result<(Self::Socket, SocketAddr)> { + let socket = + self.accepted_rx.lock().await.recv().await.ok_or_else(|| { + io::Error::new(io::ErrorKind::BrokenPipe, "accept queue closed") + })?; + let peer_addr = socket.peer_addr; + Ok((socket, peer_addr)) + } + } + + struct MockUdpSocket { + local_addr: SocketAddr, + incoming: StdMutex, SocketAddr)>>, + incoming_notify: Notify, + } + + impl MockUdpSocket { + fn new(local_addr: SocketAddr) -> Self { + Self { + local_addr, + incoming: StdMutex::new(VecDeque::new()), + incoming_notify: Notify::new(), + } + } + + fn receive_from(&self, data: Vec, peer_addr: SocketAddr) { + self.incoming.lock().unwrap().push_back((data, peer_addr)); + self.incoming_notify.notify_one(); + } + } + + #[async_trait] + impl VirtualUdpSocket for MockUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], _addr: SocketAddr) -> io::Result { + Ok(data.len()) + } + + async fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + loop { + if let Some((data, peer_addr)) = self.incoming.lock().unwrap().pop_front() { + let len = data.len().min(buf.len()); + buf[..len].copy_from_slice(&data[..len]); + return Ok((len, peer_addr)); + } + self.incoming_notify.notified().await; + } + } + } + + struct MockHost { + next_tcp_port: AtomicU16, + next_udp_port: AtomicU16, + tcp_bind_options: StdMutex>, + udp_bind_options: StdMutex>, + tcp_listeners: StdMutex>>, + udp_sockets: StdMutex>>, + } + + impl MockHost { + fn new() -> Self { + Self { + next_tcp_port: AtomicU16::new(21000), + next_udp_port: AtomicU16::new(22000), + tcp_bind_options: StdMutex::new(Vec::new()), + udp_bind_options: StdMutex::new(Vec::new()), + tcp_listeners: StdMutex::new(Vec::new()), + udp_sockets: StdMutex::new(Vec::new()), + } + } + + fn tcp_listener(&self, index: usize) -> Arc { + self.tcp_listeners.lock().unwrap()[index].clone() + } + + fn udp_socket(&self, index: usize) -> Arc { + self.udp_sockets.lock().unwrap()[index].clone() + } + + fn tcp_bind_options(&self, index: usize) -> TcpListenOptions { + self.tcp_bind_options.lock().unwrap()[index].clone() + } + + fn udp_bind_options(&self, index: usize) -> UdpBindOptions { + self.udp_bind_options.lock().unwrap()[index].clone() + } + } + + fn assigned_addr(requested: Option, next_port: &AtomicU16) -> SocketAddr { + let mut addr = requested.unwrap_or_else(|| "127.0.0.1:0".parse().unwrap()); + if addr.port() == 0 { + addr.set_port(next_port.fetch_add(1, Ordering::Relaxed)); + } + addr + } + + #[async_trait] + impl VirtualTcpListenerFactory for MockHost { + type Listener = MockTcpListener; + + async fn bind_tcp(&self, options: TcpListenOptions) -> anyhow::Result> { + let local_addr = assigned_addr(options.bind.local_addr, &self.next_tcp_port); + self.tcp_bind_options.lock().unwrap().push(options); + let listener = Arc::new(MockTcpListener::new(local_addr)); + self.tcp_listeners.lock().unwrap().push(listener.clone()); + Ok(listener) + } + } + + #[async_trait] + impl VirtualUdpSocketFactory for MockHost { + type Socket = MockUdpSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + let local_addr = assigned_addr(options.local_addr, &self.next_udp_port); + self.udp_bind_options.lock().unwrap().push(options); + let socket = Arc::new(MockUdpSocket::new(local_addr)); + self.udp_sockets.lock().unwrap().push(socket.clone()); + Ok(socket) + } + } + + #[derive(Debug, PartialEq, Eq)] + enum AcceptedEvent { + Tcp { port: u16 }, + Udp { port: u16, kind: UdpSessionKind }, + } + + struct ActiveHandlerGuard(Arc); + + impl ActiveHandlerGuard { + fn new(active: Arc) -> Self { + active.fetch_add(1, Ordering::Relaxed); + Self(active) + } + } + + impl Drop for ActiveHandlerGuard { + fn drop(&mut self) { + self.0.fetch_sub(1, Ordering::Relaxed); + } + } + + struct RecordingHandler { + events: mpsc::UnboundedSender, + blocked: Arc, + active: Arc, + } + + #[derive(Default)] + struct RecordingListenerEvents { + events: StdMutex>, + } + + impl CoreEventSink for RecordingListenerEvents { + fn emit(&self, event: CoreEvent) { + self.events.lock().unwrap().push(event); + } + } + + struct QueueTunnelAcceptor { + tunnels: VecDeque>, + } + + #[async_trait] + impl ServerTunnelAcceptor for QueueTunnelAcceptor { + async fn accept(&mut self) -> anyhow::Result> { + self.tunnels + .pop_front() + .ok_or_else(|| anyhow::anyhow!("server tunnel acceptor finished")) + } + } + + struct RecordingServerProtocolUpgrader { + tcp_calls: AtomicUsize, + udp_calls: AtomicUsize, + byte_stream_calls: AtomicUsize, + } + + impl RecordingServerProtocolUpgrader { + fn new() -> Self { + Self { + tcp_calls: AtomicUsize::new(0), + udp_calls: AtomicUsize::new(0), + byte_stream_calls: AtomicUsize::new(0), + } + } + } + + #[async_trait] + impl ServerProtocolUpgrader for RecordingServerProtocolUpgrader { + fn supports_scheme(&self, scheme: &str) -> bool { + matches!(scheme, "tcp" | "udp") + } + + async fn upgrade_tcp( + &self, + socket: MockTcpSocket, + _local_url: Url, + ) -> anyhow::Result { + self.tcp_calls.fetch_add(1, Ordering::Relaxed); + let first = raw::tests::upgrade_accepted_tcp(socket)?; + let (stream, _remote) = tokio::io::duplex(64); + let second = raw::tests::upgrade_accepted_tcp(MockTcpSocket { + stream, + local_addr: "127.0.0.1:21001".parse().unwrap(), + peer_addr: "127.0.0.1:31001".parse().unwrap(), + })?; + Ok(ServerProtocolUpgrade::Acceptor(Box::new( + QueueTunnelAcceptor { + tunnels: VecDeque::from([first, second]), + }, + ))) + } + + async fn upgrade_udp( + &self, + session: UdpSession, + _local_url: Url, + _admission: Option, + ) -> anyhow::Result { + self.udp_calls.fetch_add(1, Ordering::Relaxed); + Ok(ServerProtocolUpgrade::Tunnel( + raw::tests::upgrade_accepted_udp(session)?, + )) + } + + async fn upgrade_byte_stream( + &self, + socket: MockTcpSocket, + local_url: Url, + remote_url: Option, + ) -> anyhow::Result { + self.byte_stream_calls.fetch_add(1, Ordering::Relaxed); + Ok(ServerProtocolUpgrade::Tunnel( + raw::upgrade_accepted_byte_stream(socket, local_url, remote_url)?, + )) + } + } + + struct RecordingTunnelHandler { + calls: AtomicUsize, + } + + struct BlockingTunnelHandler { + entered: Notify, + release: Notify, + } + + #[async_trait] + impl AcceptedTunnelHandler for RecordingTunnelHandler { + async fn handle_tunnel( + &self, + _tunnel: Box, + ) -> anyhow::Result<()> { + let call = self.calls.fetch_add(1, Ordering::Relaxed); + if call == 0 { + anyhow::bail!("first admission rejected"); + } + Ok(()) + } + } + + #[async_trait] + impl AcceptedTunnelHandler for BlockingTunnelHandler { + async fn handle_tunnel( + &self, + _tunnel: Box, + ) -> anyhow::Result<()> { + self.entered.notify_one(); + self.release.notified().await; + Ok(()) + } + } + + #[async_trait] + impl AcceptedSocketHandler> for RecordingHandler { + async fn handle_accepted_socket( + &self, + accepted: AcceptedTransport, + ) -> anyhow::Result<()> { + let _active = ActiveHandlerGuard::new(self.active.clone()); + match accepted { + AcceptedTransport::Tunnel { tunnel, .. } => { + drop(tunnel); + } + AcceptedTransport::Tcp { + socket, local_url, .. + } => { + self.events.send(AcceptedEvent::Tcp { + port: local_url.port().unwrap(), + })?; + self.blocked.notified().await; + drop(socket); + } + AcceptedTransport::Udp { + session, local_url, .. + } => { + self.events.send(AcceptedEvent::Udp { + port: local_url.port().unwrap(), + kind: session.kind(), + })?; + self.blocked.notified().await; + drop(session); + } + AcceptedTransport::ByteStream { + socket, local_url, .. + } => { + self.events.send(AcceptedEvent::Tcp { + port: local_url.port().unwrap_or_default(), + })?; + self.blocked.notified().await; + drop(socket); + } + } + Ok(()) + } + } + + fn wireguard_packet() -> Vec { + let mut packet = vec![0; 32]; + packet[..4].copy_from_slice(&4u32.to_le_bytes()); + packet + } + + fn quic_initial_packet(dcid: u8) -> Vec { + let mut packet = vec![0; 1200]; + packet[0] = 0xc0; + packet[4] = 1; + packet[5] = 1; + packet[6] = dcid; + packet[7] = 0; + packet[8] = 0; + packet[9] = 1; + packet + } + + #[tokio::test] + async fn ring_listener_delivers_packet_native_tunnel() -> anyhow::Result<()> { + let local_id = uuid::Uuid::new_v4(); + let registry = Arc::new(RingTunnelRegistry::default()); + let mut listener = RingTransportListener::::new( + format!("ring://{local_id}").parse()?, + registry.clone(), + ); + listener.listen().await?; + let client = registry.connect(local_id)?.into_tunnel(); + let AcceptedTransport::Tunnel { tunnel: server, .. } = listener.accept().await? else { + anyhow::bail!("Ring listener did not produce a Tunnel"); + }; + let (_client_stream, mut client_sink) = client.split(); + let (mut server_stream, _server_sink) = server.split(); + + client_sink + .send(ZCPacket::new_with_payload(b"packet-native-listener")) + .await?; + let packet = server_stream.next().await.transpose()?.unwrap(); + assert_eq!(packet.payload(), b"packet-native-listener"); + Ok(()) + } + + #[tokio::test] + async fn ring_listener_rejects_non_ring_url() { + let registry = Arc::new(RingTunnelRegistry::default()); + let mut listener = RingTransportListener::::new( + format!("tcp://{}", uuid::Uuid::new_v4()).parse().unwrap(), + registry, + ); + + assert!(listener.listen().await.is_err()); + } + + #[tokio::test] + async fn unresolved_listener_urls_use_core_dns_and_protocol_default_ports() -> anyhow::Result<()> + { + let host = Arc::new(MockHost::new()); + let mut tcp = TcpTransportListener::new( + "tcp://listener.example".parse()?, + super::super::plan::unresolved_tcp_listener_options( + SocketContext::default().with_socket_mark(Some(7)), + ), + None, + host.clone(), + Arc::new(MockDns), + ); + tcp.listen().await?; + assert_eq!(host.tcp_listener(0).local_addr()?.port(), 11010); + assert_eq!( + host.tcp_bind_options(0).bind.context.ip_version, + IpVersion::V4 + ); + assert!(!host.tcp_bind_options(0).bind.only_v6); + + let mut udp = UdpTransportListener::::new( + "wg://listener.example".parse()?, + super::super::plan::unresolved_udp_session_listen_request( + &"wg://listener.example".parse()?, + SocketContext::default().with_socket_mark(Some(7)), + ), + UdpSessionAcceptKind::Classified(UdpSessionProtocol::WireGuard), + host.clone(), + Arc::new(MockDns), + ); + udp.listen().await?; + assert_eq!(host.udp_socket(0).local_addr()?.port(), 11011); + assert_eq!(host.udp_bind_options(0).context.ip_version, IpVersion::V4); + assert!(!host.udp_bind_options(0).only_v6); + + let mut tcp_v6 = TcpTransportListener::new( + "tcp://[::1]:0".parse()?, + super::super::plan::unresolved_tcp_listener_options(SocketContext::default()), + None, + host.clone(), + Arc::new(MockDns), + ); + tcp_v6.listen().await?; + assert_eq!( + host.tcp_bind_options(1).bind.context.ip_version, + IpVersion::V6 + ); + assert!(host.tcp_bind_options(1).bind.only_v6); + + let udp_v6_url: Url = "udp://[::1]:0".parse()?; + let mut udp_v6 = UdpTransportListener::::new( + udp_v6_url.clone(), + super::super::plan::unresolved_udp_session_listen_request( + &udp_v6_url, + SocketContext::default(), + ), + UdpSessionAcceptKind::EasyTierMux, + host.clone(), + Arc::new(MockDns), + ); + udp_v6.listen().await?; + assert_eq!(host.udp_bind_options(1).context.ip_version, IpVersion::V6); + assert!(host.udp_bind_options(1).only_v6); + Ok(()) + } + + #[tokio::test] + async fn tcp_listener_applies_protocol_upgrade_limit() -> anyhow::Result<()> { + let host = Arc::new(MockHost::new()); + let mut listener = TcpTransportListener::new( + "tcp://127.0.0.1:0".parse()?, + super::super::plan::unresolved_tcp_listener_options(SocketContext::default()), + Some(std::num::NonZeroUsize::MIN), + host.clone(), + Arc::new(MockDns), + ); + listener.listen().await?; + let socket = host.tcp_listener(0); + socket.accept_from("127.0.0.1:31000".parse()?); + socket.accept_from("127.0.0.1:31001".parse()?); + + let first = listener.accept().await?; + assert!( + crate::foundation::time::timeout(Duration::from_millis(50), listener.accept()) + .await + .is_err() + ); + drop(first); + crate::foundation::time::timeout(Duration::from_secs(1), listener.accept()).await??; + Ok(()) + } + + #[tokio::test] + async fn tcp_upgrade_permit_is_released_before_peer_admission() -> anyhow::Result<()> { + let tunnel_handler = Arc::new(BlockingTunnelHandler { + entered: Notify::new(), + release: Notify::new(), + }); + let protocol = Arc::new(CoreServerProtocolUpgrader::new(Default::default())); + let handler = ProtocolAcceptedTransportHandler::new(&tunnel_handler, protocol); + let upgrade_slots = Arc::new(Semaphore::new(1)); + let permit = upgrade_slots.clone().acquire_owned().await?; + let (stream, _remote) = tokio::io::duplex(64); + + let task = tokio::spawn(async move { + handler + .handle_accepted_socket(AcceptedTransport::Tcp { + socket: MockTcpSocket { + stream, + local_addr: "127.0.0.1:21000".parse().unwrap(), + peer_addr: "127.0.0.1:31000".parse().unwrap(), + }, + local_url: "tcp://127.0.0.1:21000".parse().unwrap(), + upgrade_permit: Some(permit), + }) + .await + }); + + tunnel_handler.entered.notified().await; + let next_permit = + crate::foundation::time::timeout(Duration::from_secs(1), upgrade_slots.acquire_owned()) + .await??; + drop(next_permit); + tunnel_handler.release.notify_one(); + task.await??; + Ok(()) + } + + #[tokio::test] + async fn quic_admission_happens_before_transport_is_returned() -> anyhow::Result<()> { + let host = Arc::new(MockHost::new()); + let mut listener = UdpTransportListener::::new( + "quic://127.0.0.1:0".parse()?, + UdpSessionListenRequest::new(UdpBindOptions::port_bound_listener( + "127.0.0.1:0".parse()?, + )), + UdpSessionAcceptKind::Classified(UdpSessionProtocol::Quic), + host.clone(), + Arc::new(MockDns), + ); + listener.protocol_admission = Some(ServerProtocolAdmissionController::new(1, 1)); + listener.listen().await?; + let socket = host.udp_socket(0); + + socket.receive_from(quic_initial_packet(1), "127.0.0.1:32001".parse()?); + let first = + crate::foundation::time::timeout(Duration::from_secs(1), listener.accept()).await??; + assert!(matches!( + &first, + AcceptedTransport::Udp { + admission: Some(_), + .. + } + )); + + socket.receive_from(quic_initial_packet(2), "127.0.0.1:32002".parse()?); + assert!( + crate::foundation::time::timeout(Duration::from_millis(100), listener.accept()) + .await + .is_err() + ); + + drop(first); + socket.receive_from(quic_initial_packet(3), "127.0.0.1:32003".parse()?); + let third = + crate::foundation::time::timeout(Duration::from_secs(1), listener.accept()).await??; + assert!(matches!( + third, + AcceptedTransport::Udp { + admission: Some(_), + .. + } + )); + Ok(()) + } + + #[tokio::test] + async fn protocol_handler_consumes_multi_tunnel_acceptors_and_udp_upgrades() + -> anyhow::Result<()> { + let tunnel_handler = Arc::new(RecordingTunnelHandler { + calls: AtomicUsize::new(0), + }); + let protocol = Arc::new(RecordingServerProtocolUpgrader::new()); + let handler = ProtocolAcceptedTransportHandler::new(&tunnel_handler, protocol.clone()); + + let (stream, _remote) = tokio::io::duplex(64); + let tcp_result = handler + .handle_accepted_socket(AcceptedTransport::Tcp { + socket: MockTcpSocket { + stream, + local_addr: "127.0.0.1:21000".parse().unwrap(), + peer_addr: "127.0.0.1:31000".parse().unwrap(), + }, + local_url: "tcp://127.0.0.1:21000".parse().unwrap(), + upgrade_permit: None, + }) + .await + .unwrap_err(); + assert_eq!(tcp_result.to_string(), "server tunnel acceptor finished"); + assert_eq!(protocol.tcp_calls.load(Ordering::Relaxed), 1); + assert_eq!(tunnel_handler.calls.load(Ordering::Relaxed), 2); + + let udp_socket = Arc::new(MockUdpSocket::new("127.0.0.1:22000".parse().unwrap())); + let udp_session = UdpSession::identity_standalone( + udp_socket, + "127.0.0.1:32000".parse().unwrap(), + UdpSessionKind::EasyTierMux, + )?; + handler + .handle_accepted_socket(AcceptedTransport::Udp { + session: udp_session, + local_url: "udp://127.0.0.1:22000".parse().unwrap(), + admission: None, + }) + .await?; + assert_eq!(protocol.udp_calls.load(Ordering::Relaxed), 1); + assert_eq!(tunnel_handler.calls.load(Ordering::Relaxed), 3); + + let (stream, _remote) = tokio::io::duplex(64); + handler + .handle_accepted_socket(AcceptedTransport::ByteStream { + socket: MockTcpSocket { + stream, + local_addr: "127.0.0.1:21002".parse()?, + peer_addr: "127.0.0.1:31002".parse()?, + }, + local_url: "external://local".parse()?, + remote_url: Some("external://remote".parse()?), + }) + .await?; + assert_eq!(protocol.byte_stream_calls.load(Ordering::Relaxed), 1); + assert_eq!(tunnel_handler.calls.load(Ordering::Relaxed), 4); + + Ok::<(), anyhow::Error>(()) + } + + #[tokio::test] + async fn core_builtin_server_upgrades_raw_udp_and_byte_streams() -> anyhow::Result<()> { + let tunnel_handler = Arc::new(RecordingTunnelHandler { + calls: AtomicUsize::new(0), + }); + let protocol = Arc::new(CoreServerProtocolUpgrader::new(Default::default())); + let handler = ProtocolAcceptedTransportHandler::new(&tunnel_handler, protocol); + + let udp_socket = Arc::new(MockUdpSocket::new("127.0.0.1:22000".parse()?)); + let udp_session = UdpSession::identity_standalone( + udp_socket, + "127.0.0.1:32000".parse()?, + UdpSessionKind::EasyTierMux, + )?; + let admission_error = handler + .handle_accepted_socket(AcceptedTransport::Udp { + session: udp_session, + local_url: "udp://127.0.0.1:22000".parse()?, + admission: None, + }) + .await + .unwrap_err(); + assert_eq!(admission_error.to_string(), "first admission rejected"); + + let (stream, _remote) = tokio::io::duplex(64); + handler + .handle_accepted_socket(AcceptedTransport::ByteStream { + socket: MockTcpSocket { + stream, + local_addr: "127.0.0.1:21000".parse()?, + peer_addr: "127.0.0.1:31000".parse()?, + }, + local_url: "unix:///tmp/easytier.sock".parse()?, + remote_url: Some("unix://anonymous/remote".parse()?), + }) + .await?; + assert_eq!(tunnel_handler.calls.load(Ordering::Relaxed), 2); + Ok(()) + } + + #[tokio::test] + async fn service_preserves_transport_boundary_and_stops_blocked_handlers() { + let host = Arc::new(MockHost::new()); + let (event_tx, mut event_rx) = mpsc::unbounded_channel(); + let active = Arc::new(AtomicUsize::new(0)); + let handler = Arc::new(RecordingHandler { + events: event_tx, + blocked: Arc::new(Notify::new()), + active: active.clone(), + }); + let service = CoreListenerRuntime::new_with_events( + host.clone(), + Arc::new(MockDns), + Arc::new(RingTunnelRegistry::default()), + vec![ + TransportListenerConfig::Tcp { + url: "tcp://127.0.0.1:0".parse().unwrap(), + options: TcpListenOptions::manual_connect("127.0.0.1:0".parse().unwrap()), + max_pending_upgrades: None, + must_succeed: true, + }, + TransportListenerConfig::Udp { + url: "udp://127.0.0.1:0".parse().unwrap(), + request: UdpSessionListenRequest::new(UdpBindOptions::port_bound_listener( + "127.0.0.1:0".parse().unwrap(), + )), + accept_kind: UdpSessionAcceptKind::EasyTierMux, + must_succeed: true, + }, + TransportListenerConfig::Udp { + url: "wg://127.0.0.1:0".parse().unwrap(), + request: UdpSessionListenRequest::new(UdpBindOptions::port_bound_listener( + "127.0.0.1:0".parse().unwrap(), + )), + accept_kind: UdpSessionAcceptKind::Classified(UdpSessionProtocol::WireGuard), + must_succeed: true, + }, + ], + Vec::new(), + Vec::new(), + handler, + Arc::new(RecordingListenerEvents::default()), + Arc::new(RunningListenerRegistry::default()), + ); + + service.start().await.unwrap(); + host.tcp_listener(0) + .accept_from("127.0.0.1:31000".parse().unwrap()); + host.udp_socket(0).receive_from( + new_syn_packet(1, 2).into_bytes().to_vec(), + "127.0.0.1:32000".parse().unwrap(), + ); + host.udp_socket(1) + .receive_from(wireguard_packet(), "127.0.0.1:32001".parse().unwrap()); + + let mut events = Vec::new(); + for _ in 0..3 { + events.push( + crate::foundation::time::timeout(Duration::from_secs(1), event_rx.recv()) + .await + .expect("accepted transport was not handled") + .expect("accepted transport event channel closed"), + ); + } + assert!(events.contains(&AcceptedEvent::Tcp { port: 21000 })); + assert!(events.contains(&AcceptedEvent::Udp { + port: 22000, + kind: UdpSessionKind::EasyTierMux, + })); + assert!(events.contains(&AcceptedEvent::Udp { + port: 22001, + kind: UdpSessionKind::WireGuard, + })); + assert_eq!(active.load(Ordering::Relaxed), 3); + + crate::foundation::time::timeout(Duration::from_secs(1), service.stop()) + .await + .expect("transport listener service did not stop"); + assert_eq!(active.load(Ordering::Relaxed), 0); + } + + #[tokio::test] + async fn runtime_publishes_plan_failures_before_starting_listeners() { + let events = Arc::new(RecordingListenerEvents::default()); + let service = CoreListenerRuntime::new_with_events( + Arc::new(MockHost::new()), + Arc::new(MockDns), + Arc::new(RingTunnelRegistry::default()), + Vec::new(), + Vec::new(), + vec![ListenerPlanFailure { + url: "unsupported://listener".parse().unwrap(), + message: "unsupported listener".to_owned(), + }], + Arc::new(|_: AcceptedTransport| async { Ok(()) }), + events.clone(), + Arc::new(RunningListenerRegistry::default()), + ); + + service.start().await.unwrap(); + assert!(matches!( + events.events.lock().unwrap().as_slice(), + [CoreEvent::ListenerPlanFailed { url, error }] + if url.as_str() == "unsupported://listener" + && error == "unsupported listener" + )); + service.stop().await; + } +} diff --git a/vendor/easytier/easytier-core/src/management/forwarded_rpc.rs b/vendor/easytier/easytier-core/src/management/forwarded_rpc.rs new file mode 100644 index 0000000..cd3c5bc --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/forwarded_rpc.rs @@ -0,0 +1,152 @@ +use std::marker::PhantomData; + +use async_trait::async_trait; +use bytes::Bytes; + +use crate::{ + proto::{ + api::{ + config::ConfigRpcDescriptor, + instance::{ConnectorManageRpcDescriptor, PeerManageRpcDescriptor}, + }, + rpc_types::{ + controller::BaseController, + descriptor::{MethodDescriptor, ServiceDescriptor}, + error, + handler::Handler, + }, + }, + rpc::service_registry::ServiceRegistry, +}; + +#[async_trait] +pub(crate) trait ManagementRpcForwarder: Clone + Send + Sync + 'static { + async fn forward(&self, full_method_name: String, input: Bytes) -> error::Result; +} + +struct ForwardedManagementHandler { + forwarder: F, + _descriptor: PhantomData D>, +} + +impl ForwardedManagementHandler { + fn new(forwarder: F) -> Self { + Self { + forwarder, + _descriptor: PhantomData, + } + } +} + +impl Clone for ForwardedManagementHandler +where + F: Clone, +{ + fn clone(&self) -> Self { + Self::new(self.forwarder.clone()) + } +} + +#[async_trait] +impl Handler for ForwardedManagementHandler +where + F: ManagementRpcForwarder, + D: ServiceDescriptor + Default + 'static, +{ + type Descriptor = D; + type Controller = BaseController; + + async fn call( + &self, + _: Self::Controller, + method: D::Method, + input: Bytes, + ) -> error::Result { + let descriptor = D::default(); + let full_method_name = if descriptor.package().is_empty() { + format!("{}.{}", descriptor.proto_name(), method.proto_name()) + } else { + format!( + "{}.{}.{}", + descriptor.package(), + descriptor.proto_name(), + method.proto_name() + ) + }; + self.forwarder.forward(full_method_name, input).await + } +} + +/// Registers the instance-management services supported by the bound WASI RPC ABI. +pub(crate) fn register_forwarded_instance_management_rpc( + forwarder: F, + registry: &ServiceRegistry, +) where + F: ManagementRpcForwarder, +{ + registry.register( + ForwardedManagementHandler::::new(forwarder.clone()), + "", + ); + registry.register( + ForwardedManagementHandler::::new(forwarder.clone()), + "", + ); + registry.register( + ForwardedManagementHandler::::new(forwarder), + "", + ); +} + +#[cfg(test)] +mod tests { + use std::sync::{Arc, Mutex}; + + use super::*; + + #[derive(Clone, Default)] + struct RecordingForwarder { + calls: Arc>>, + } + + #[async_trait] + impl ManagementRpcForwarder for RecordingForwarder { + async fn forward(&self, full_method_name: String, input: Bytes) -> error::Result { + self.calls + .lock() + .unwrap() + .push((full_method_name, input.clone())); + Ok(input) + } + } + + #[tokio::test] + async fn registers_and_forwards_bound_instance_management_services() { + let forwarder = RecordingForwarder::default(); + let registry = ServiceRegistry::new(); + register_forwarded_instance_management_rpc(forwarder.clone(), ®istry); + + let methods = [ + "api.instance.PeerManageRpc.ListPeer", + "api.instance.ConnectorManageRpc.ListConnector", + "api.config.ConfigRpc.GetConfig", + ]; + for (index, full_method_name) in methods.into_iter().enumerate() { + let descriptor = registry + .resolve_method("", full_method_name) + .unwrap_or_else(|| panic!("missing forwarded method: {full_method_name}")); + let request = Bytes::from(vec![index as u8]); + let response = registry + .call_method(descriptor, BaseController::default(), request.clone()) + .await + .unwrap(); + assert_eq!(response, request); + } + + let calls = forwarder.calls.lock().unwrap(); + assert_eq!(calls.len(), methods.len()); + for ((actual, _), expected) in calls.iter().zip(methods) { + assert_eq!(actual, expected); + } + } +} diff --git a/vendor/easytier/easytier-core/src/management/full/compiled.rs b/vendor/easytier/easytier-core/src/management/full/compiled.rs new file mode 100644 index 0000000..0852fb8 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/full/compiled.rs @@ -0,0 +1,47 @@ +use std::sync::Arc; + +use easytier_proto::{ + api::{ + config::ConfigRpcServer, + instance::{ + AclManageRpcServer, ConnectorManageRpcServer, CredentialManageRpcServer, + MappedListenerManageRpcServer, PeerManageRpcServer, PortForwardManageRpcServer, + StatsRpcServer, VpnPortalRpcServer, + }, + }, + peer_rpc::PeerCenterRpcServer, +}; + +use super::super::instance_rpc::InstanceManagementRpc; +use super::ConfigFileStorage; +use crate::{ + instance::{ + CoreInstance, CoreInstanceHost, + manager::{InstanceFactory, InstanceManager}, + }, + rpc::service_registry::ServiceRegistry, +}; + +/// Registers each Instance-targeted management protocol Interface once for +/// the complete process-level Instance collection. +pub fn register_instance_management_rpc( + manager: Arc>, + registry: &ServiceRegistry, + storage: Arc, +) where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + let rpc = InstanceManagementRpc::::new_with_config_storage(manager.clone(), storage); + registry.register(PeerManageRpcServer::new(rpc.clone()), ""); + registry.register(ConnectorManageRpcServer::new(rpc.clone()), ""); + registry.register(MappedListenerManageRpcServer::new(rpc.clone()), ""); + registry.register(VpnPortalRpcServer::new(rpc.clone()), ""); + super::packet_proxy::register(manager.clone(), registry); + registry.register(AclManageRpcServer::new(rpc.clone()), ""); + registry.register(PortForwardManageRpcServer::new(rpc.clone()), ""); + registry.register(StatsRpcServer::new(rpc.clone()), ""); + registry.register(ConfigRpcServer::new(rpc.clone()), ""); + registry.register(CredentialManageRpcServer::new(rpc.clone()), ""); + registry.register(PeerCenterRpcServer::new(rpc), ""); +} diff --git a/vendor/easytier/easytier-core/src/management/full/config_patch.rs b/vendor/easytier/easytier-core/src/management/full/config_patch.rs new file mode 100644 index 0000000..ed261ce --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/full/config_patch.rs @@ -0,0 +1,704 @@ +use std::{fmt::Debug, sync::Arc}; + +use anyhow::Context as _; +use easytier_proto::api::config::{ + self, AclPatch, ConfigPatchAction, ExitNodePatch, InstanceConfigPatch, Patchable, + PortForwardPatch, ProxyNetworkPatch, RoutePatch, UrlPatch, VpnPortalClientPatch, +}; + +use crate::{ + config::{ + api_input::managed_credential_from_proto, + peers::AclRuleConfig, + runtime::CoreInstanceRuntimeConfig, + toml::{ConfigLoader as _, TomlConfig}, + }, + instance::{CoreInstance, CoreInstanceConfig, CoreInstanceHost, CoreInstanceState}, + peers::credential_manager::CredentialManager, +}; + +#[async_trait::async_trait] +pub trait ConfigPatchPersistence: Send + Sync { + async fn persist(&self, instance_id: uuid::Uuid, config: &TomlConfig) -> anyhow::Result<()>; +} + +pub async fn apply_config_patch( + instance: &Arc>, + patch: InstanceConfigPatch, + persistence: Option<&dyn ConfigPatchPersistence>, +) -> anyhow::Result<()> +where + H: CoreInstanceHost, +{ + let _operation = instance.operation.lock().await; + if instance.state() != CoreInstanceState::Running { + anyhow::bail!("instance is not ready; config patch rejected"); + } + + let config = instance + .toml_config() + .ok_or_else(|| anyhow::anyhow!("shared TOML configuration is not available"))?; + let candidate = config.detached_snapshot(); + let parsed_prefix = + parse_ipv6_public_addr_prefix_patch(patch.ipv6_public_addr_prefix.as_deref())?; + // Take the credential set out first so the host-facing copy below never + // clones secret material. + let mut patch = patch; + let managed_credentials = patch.managed_credentials.take(); + let patch_for_host = patch_without_managed_credentials(&patch); + + // Preserve the existing ordered partial-commit contract: earlier valid + // sub-patches remain applied if a later sub-patch fails. + let patch_result: anyhow::Result<(bool, bool)> = async { + let result = patch_port_forwards(&candidate, patch.port_forwards); + validate_persist_and_commit_candidate(instance, &config, &candidate, persistence).await?; + result?; + + let result = patch_acl(&candidate, patch.acl); + validate_persist_and_commit_candidate(instance, &config, &candidate, persistence).await?; + result?; + + let result = patch_proxy_networks(&candidate, patch.proxy_networks); + validate_persist_and_commit_candidate(instance, &config, &candidate, persistence).await?; + result?; + + let result = patch_routes(&candidate, patch.routes); + validate_persist_and_commit_candidate(instance, &config, &candidate, persistence).await?; + result?; + + let result = patch_exit_nodes_config(&candidate, patch.exit_nodes); + let normalized = + validate_persist_and_commit_candidate(instance, &config, &candidate, persistence) + .await?; + result?; + instance + .update_exit_nodes(normalized.peer.exit_nodes.clone()) + .await; + + let result = patch_mapped_listeners(&candidate, patch.mapped_listeners); + validate_persist_and_commit_candidate(instance, &config, &candidate, persistence).await?; + result?; + + patch_connectors(instance, patch.connectors)?; + + let mut provider_config_changed = false; + if let Some(hostname) = patch.hostname { + candidate.set_hostname(Some(hostname)); + } + if let Some(ipv4) = patch.ipv4 + && !candidate.get_dhcp() + { + candidate.set_ipv4(Some(ipv4.into())); + } + if let Some(ipv6) = patch.ipv6 { + candidate.set_ipv6(Some(ipv6.into())); + } + if let Some(disable_relay_data) = patch.disable_relay_data { + let mut flags = candidate.get_flags(); + flags.disable_relay_data = disable_relay_data; + candidate.set_flags(flags); + } + if let Some(prefer_peer_relay) = patch.prefer_peer_relay { + let mut flags = candidate.get_flags(); + flags.prefer_peer_relay = prefer_peer_relay; + candidate.set_flags(flags); + } + if let Some(enabled) = patch.ipv6_public_addr_provider { + candidate.set_ipv6_public_addr_provider(enabled); + provider_config_changed = true; + } + if let Some(enabled) = patch.ipv6_public_addr_auto { + candidate.set_ipv6_public_addr_auto(enabled); + } + if let Some(prefix) = parsed_prefix { + candidate.set_ipv6_public_addr_prefix(prefix); + provider_config_changed = true; + } + let mut managed_credentials_changed = false; + + // Runs last so client validation sees the fully patched candidate, + // including routes and the node IPv4 set earlier in this request. + if !patch.vpn_portal_clients.is_empty() { + let previous = config.detached_snapshot(); + apply_vpn_portal_client_patches(&candidate, patch.vpn_portal_clients)?; + // Deep-validate and durably persist before hot-applying. A failed + // write leaves the live Portal untouched. If the host rejects the + // hot update, restore the previous durable snapshot before + // returning so a later patch cannot overwrite from stale shared + // state and a restart cannot apply a rejected client set. + let normalized = validate_candidate(instance, &candidate)?; + persist_candidate_if_changed(instance, &config, &candidate, persistence).await?; + #[cfg(feature = "vpn-portal")] + { + let portal = normalized + .vpn_portal + .clone() + .ok_or_else(|| anyhow::anyhow!("VPN portal is not configured"))?; + if let Err(error) = instance + .update_vpn_portal_clients( + portal.clients, + &runtime_config_from_normalized(&normalized), + ) + .await + { + if let Some(persistence) = persistence + && let Err(rollback_error) = + persistence.persist(instance.instance_id(), &previous).await + { + return Err(error.context(format!( + "failed to restore durable configuration after VPN portal update: \ + {rollback_error:#}" + ))); + } + return Err(error); + } + } + #[cfg(not(feature = "vpn-portal"))] + { + let _ = normalized; + } + config.replace_from_snapshot(&candidate); + } + + if let Some(managed) = &managed_credentials { + // Managed credential patch transaction: validate and reserve → + // persist → install. The reservation prevents base or ephemeral + // credential mutations from invalidating the replacement while + // the durable write is in flight, without holding a synchronous + // lock across the await. Dropping the replacement before install + // releases the reservation. + // + // Accepted consistency limits: + // + // 1. A persistence implementation may finish its write after this + // RPC future is cancelled. The reservation is then released and + // the running instance keeps its previous credentials even if + // the durable file contains the replacement. A retry, controller + // reconcile, or restart is required to converge; until then a + // removed credential may remain trusted by the running instance. + // + // 2. This instance operation is not serialized with a process-level + // instance overwrite. The built-in web reconciler serializes its + // own actions, but independently concurrent admin RPCs are + // last-writer-wins and may leave the running instance and durable + // file on different config generations. A restart aligns runtime + // with the file; controller reconcile is required to restore its + // desired generation. + let credential_manager = instance.credential_manager(); + let entries = managed + .entries + .iter() + .map(managed_credential_from_proto) + .collect::>(); + let replacement = credential_manager + .validate_managed_credentials(&entries) + .map_err(anyhow::Error::msg)?; + candidate.set_managed_credentials(entries); + validate_candidate(instance, &candidate)?; + // When durable storage is configured, persist before installing + // secret authority so a successful replacement survives restart. + if let Some(persistence) = persistence { + persistence + .persist(instance.instance_id(), &candidate) + .await?; + } + config.replace_from_snapshot(&candidate); + managed_credentials_changed = + CredentialManager::install_managed_credentials(replacement); + } else { + validate_persist_and_commit_candidate(instance, &config, &candidate, persistence) + .await?; + } + let normalized = validate_candidate(instance, &candidate)?; + let runtime = runtime_config_from_normalized(&normalized); + if patch_for_host != InstanceConfigPatch::default() { + instance + .instance_runtime + .synchronize_config(&patch_for_host, &runtime); + } + Ok((provider_config_changed, managed_credentials_changed)) + } + .await; + + instance + .update_runtime_config_under_operation(runtime_config_from_toml(instance, &config)?) + .await?; + let (provider_config_changed, managed_credentials_changed) = patch_result?; + if patch_for_host != InstanceConfigPatch::default() { + instance + .instance_runtime + .publish_config_patch(patch_for_host); + } + if managed_credentials_changed { + instance.notify_credential_changed(); + } + #[cfg(feature = "public-ipv6-provider")] + if provider_config_changed && instance.state() == CoreInstanceState::Running { + instance.reconcile_public_ipv6_provider().await; + } + #[cfg(not(feature = "public-ipv6-provider"))] + let _ = provider_config_changed; + Ok(()) +} + +fn patch_without_managed_credentials(patch: &InstanceConfigPatch) -> InstanceConfigPatch { + let mut patch = patch.clone(); + patch.managed_credentials = None; + patch +} + +fn validate_candidate( + instance: &CoreInstance, + candidate: &TomlConfig, +) -> anyhow::Result +where + H: CoreInstanceHost, +{ + let normalized = CoreInstanceConfig::from_toml_with_host(candidate, instance.host_config())?; + let runtime = runtime_config_from_normalized(&normalized); + runtime.services.public_ipv6_provider.validate()?; + instance.validate_runtime_config_capabilities(&runtime)?; + Ok(normalized) +} + +async fn validate_persist_and_commit_candidate( + instance: &CoreInstance, + shared: &TomlConfig, + candidate: &TomlConfig, + persistence: Option<&dyn ConfigPatchPersistence>, +) -> anyhow::Result +where + H: CoreInstanceHost, +{ + let normalized = validate_candidate(instance, candidate)?; + if persist_candidate_if_changed(instance, shared, candidate, persistence).await? { + shared.replace_from_snapshot(candidate); + } + Ok(normalized) +} + +async fn persist_candidate_if_changed( + instance: &CoreInstance, + shared: &TomlConfig, + candidate: &TomlConfig, + persistence: Option<&dyn ConfigPatchPersistence>, +) -> anyhow::Result +where + H: CoreInstanceHost, +{ + if shared.dump() == candidate.dump() { + return Ok(false); + } + if let Some(persistence) = persistence { + persistence + .persist(instance.instance_id(), candidate) + .await?; + } + Ok(true) +} + +fn runtime_config_from_toml( + instance: &CoreInstance, + config: &TomlConfig, +) -> anyhow::Result +where + H: CoreInstanceHost, +{ + let normalized = CoreInstanceConfig::from_toml_with_host(config, instance.host_config())?; + Ok(runtime_config_from_normalized(&normalized)) +} + +pub(super) fn runtime_config_from_normalized( + config: &CoreInstanceConfig, +) -> CoreInstanceRuntimeConfig { + CoreInstanceRuntimeConfig { + services: config.connectivity.runtime.clone(), + peer: Arc::new(config.peer.snapshot.clone()), + } +} + +fn parse_ipv6_public_addr_prefix_patch( + prefix: Option<&str>, +) -> anyhow::Result>> { + let Some(prefix) = prefix else { + return Ok(None); + }; + let prefix = prefix.trim(); + if prefix.is_empty() { + return Ok(Some(None)); + } + Ok(Some(Some(prefix.parse().with_context(|| { + format!("failed to parse ipv6 public address prefix: {prefix}") + })?))) +} + +fn trace_patchables(patches: &[Patchable]) { + for patch in patches { + match patch.action { + Some(ConfigPatchAction::Add) | Some(ConfigPatchAction::Remove) => { + if let Some(value) = &patch.value { + tracing::info!(?patch.action, ?value, "applying configuration patch"); + } else { + tracing::warn!(?patch.action, "ignored configuration patch without value"); + } + } + Some(ConfigPatchAction::Clear) => { + tracing::info!("clearing configuration collection"); + } + None => tracing::warn!("ignored invalid configuration patch action"), + } + } +} + +#[cfg(test)] +mod managed_credential_tests { + use easytier_proto::api::manage::ManagedCredentialSet; + + use super::*; + + #[test] + fn event_patch_drops_managed_credential_secrets() { + let patch = InstanceConfigPatch { + managed_credentials: Some(ManagedCredentialSet::default()), + ..Default::default() + }; + + assert!( + patch_without_managed_credentials(&patch) + .managed_credentials + .is_none() + ); + } +} + +fn patch_port_forwards(config: &TomlConfig, patches: Vec) -> anyhow::Result<()> { + if patches.is_empty() { + return Ok(()); + } + let mut current = config.get_port_forwards(); + let patches = patches + .into_iter() + .map(|patch| Patchable { + action: ConfigPatchAction::try_from(patch.action).ok(), + value: patch.cfg.map(Into::into), + }) + .collect::>(); + trace_patchables(&patches); + config::patch_vec(&mut current, patches); + config.set_port_forwards(current); + Ok(()) +} + +fn patch_acl(config: &TomlConfig, patch: Option) -> anyhow::Result<()> { + let Some(patch) = patch else { + return Ok(()); + }; + let mut acl = AclRuleConfig { + acl: config.get_acl(), + tcp_whitelist: config.get_tcp_whitelist(), + udp_whitelist: config.get_udp_whitelist(), + whitelist_priority: None, + }; + if let Some(next) = patch.acl { + acl.acl = Some(next); + } + if !patch.tcp_whitelist.is_empty() { + let patches = patch + .tcp_whitelist + .into_iter() + .map(Into::into) + .collect::>(); + trace_patchables(&patches); + config::patch_vec(&mut acl.tcp_whitelist, patches); + } + if !patch.udp_whitelist.is_empty() { + let patches = patch + .udp_whitelist + .into_iter() + .map(Into::into) + .collect::>(); + trace_patchables(&patches); + config::patch_vec(&mut acl.udp_whitelist, patches); + } + acl.build()?; + config.set_acl(acl.acl); + config.set_tcp_whitelist(acl.tcp_whitelist); + config.set_udp_whitelist(acl.udp_whitelist); + Ok(()) +} + +fn patch_proxy_networks( + config: &TomlConfig, + patches: Vec, +) -> anyhow::Result<()> { + for patch in patches { + match ConfigPatchAction::try_from(patch.action) { + Ok(ConfigPatchAction::Add) => { + let Some(cidr) = patch.cidr.map(Into::into) else { + tracing::warn!("ignored proxy-network add without CIDR"); + continue; + }; + config.add_proxy_cidr(cidr, patch.mapped_cidr.map(Into::into))?; + } + Ok(ConfigPatchAction::Remove) => { + let Some(cidr) = patch.cidr.map(Into::into) else { + tracing::warn!("ignored proxy-network remove without CIDR"); + continue; + }; + config.remove_proxy_cidr(cidr); + } + Ok(ConfigPatchAction::Clear) => config.clear_proxy_cidrs(), + Err(_) => tracing::warn!( + action = patch.action, + "ignored invalid proxy-network action" + ), + } + } + Ok(()) +} + +fn patch_routes(config: &TomlConfig, patches: Vec) -> anyhow::Result<()> { + if patches.is_empty() { + return Ok(()); + } + let mut current = config.get_routes().unwrap_or_default(); + let patches = patches.into_iter().map(Into::into).collect::>(); + trace_patchables(&patches); + config::patch_vec(&mut current, patches); + config.set_routes((!current.is_empty()).then_some(current)); + Ok(()) +} + +fn patch_exit_nodes_config( + config: &TomlConfig, + patches: Vec, +) -> anyhow::Result> { + if patches.is_empty() { + return Ok(config.get_exit_nodes()); + } + let mut current = config.get_exit_nodes(); + let patches = patches.into_iter().map(Into::into).collect::>(); + trace_patchables(&patches); + config::patch_vec(&mut current, patches); + config.set_exit_nodes(current.clone()); + Ok(current) +} + +fn patch_mapped_listeners(config: &TomlConfig, patches: Vec) -> anyhow::Result<()> { + if patches.is_empty() { + return Ok(()); + } + let mut current = config.get_mapped_listeners(); + let patches = patches.into_iter().map(Into::into).collect::>(); + trace_patchables(&patches); + config::patch_vec(&mut current, patches); + config.set_mapped_listeners((!current.is_empty()).then_some(current)); + Ok(()) +} + +/// Applies VPN portal client patches to the candidate TOML model. The live +/// portal is updated by the caller after the candidate commits, so deep +/// validation runs against the final configuration state. +pub(super) fn apply_vpn_portal_client_patches( + config: &TomlConfig, + patches: Vec, +) -> anyhow::Result<()> { + if patches.is_empty() { + return Ok(()); + } + let mut portal = config + .get_vpn_portal_config() + .ok_or_else(|| anyhow::anyhow!("VPN portal is not configured; cannot patch its clients"))?; + anyhow::ensure!( + portal.enabled != Some(false), + "VPN portal is disabled; cannot patch its clients" + ); + for patch in patches { + match ConfigPatchAction::try_from(patch.action) { + Ok(ConfigPatchAction::Add) => { + let Some(client) = patch.client else { + tracing::warn!("ignored VPN portal client add without client"); + continue; + }; + let virtual_ip = + client + .virtual_ip + .parse::() + .with_context(|| { + format!( + "invalid VPN portal client virtual CIDR: {}", + client.virtual_ip + ) + })?; + portal + .clients + .push(crate::config::toml::VpnPortalClientConfig { + name: client.name, + virtual_ip, + groups: client.groups, + }); + } + Ok(ConfigPatchAction::Remove) => { + let Some(client) = patch.client else { + tracing::warn!("ignored VPN portal client remove without client"); + continue; + }; + let before = portal.clients.len(); + portal + .clients + .retain(|existing| existing.name != client.name); + if portal.clients.len() == before { + anyhow::bail!("VPN portal client not found: {}", client.name); + } + } + Ok(ConfigPatchAction::Clear) => portal.clients.clear(), + Err(_) => tracing::warn!( + action = patch.action, + "ignored invalid VPN portal client action" + ), + } + } + config.set_vpn_portal_config(portal); + Ok(()) +} + +fn patch_connectors(instance: &CoreInstance, patches: Vec) -> anyhow::Result<()> +where + H: CoreInstanceHost, +{ + for patch in patches { + match ConfigPatchAction::try_from(patch.action) { + Ok(ConfigPatchAction::Add) => { + let Some(url) = patch.url.map(Into::::into) else { + tracing::warn!("ignored connector add without URL"); + continue; + }; + if !instance.host_config().accepts_runtime_url(&url) { + continue; + } + instance.add_connector(url)?; + } + Ok(ConfigPatchAction::Remove) => { + let Some(url) = patch.url.map(Into::::into) else { + tracing::warn!("ignored connector remove without URL"); + continue; + }; + if !instance.host_config().accepts_runtime_url(&url) { + continue; + } + if !instance.remove_connector(&url) { + anyhow::bail!("connector not found: {url}"); + } + } + Ok(ConfigPatchAction::Clear) => instance.clear_connectors(), + Err(_) => tracing::warn!(action = patch.action, "ignored invalid connector action"), + } + } + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::config::toml::{VpnPortalClientConfig, VpnPortalConfig}; + use easytier_proto::api::manage::VpnPortalClientConfig as ClientPb; + + fn portal_config() -> TomlConfig { + let config = TomlConfig::default(); + config.set_vpn_portal_config(VpnPortalConfig { + enabled: None, + wireguard_listen: "0.0.0.0:51820".parse().unwrap(), + wireguard_private_key: None, + clients: vec![VpnPortalClientConfig { + name: "alice".to_owned(), + virtual_ip: "10.0.0.2/24".parse().unwrap(), + groups: Vec::new(), + }], + }); + config + } + + fn configured_names(config: &TomlConfig) -> Vec { + config + .get_vpn_portal_config() + .unwrap() + .clients + .into_iter() + .map(|client| client.name) + .collect() + } + + fn add(name: &str, ip: &str) -> VpnPortalClientPatch { + VpnPortalClientPatch { + action: ConfigPatchAction::Add as i32, + client: Some(ClientPb { + name: name.to_owned(), + virtual_ip: ip.to_owned(), + groups: Vec::new(), + }), + } + } + + fn remove(name: &str) -> VpnPortalClientPatch { + VpnPortalClientPatch { + action: ConfigPatchAction::Remove as i32, + client: Some(ClientPb { + name: name.to_owned(), + virtual_ip: String::new(), + groups: Vec::new(), + }), + } + } + + #[test] + fn vpn_portal_client_patches_add_remove_and_clear() { + let config = portal_config(); + + apply_vpn_portal_client_patches(&config, vec![add("bob", "10.0.0.3/24")]).unwrap(); + assert_eq!(configured_names(&config), ["alice", "bob"]); + + apply_vpn_portal_client_patches(&config, vec![remove("alice")]).unwrap(); + assert_eq!(configured_names(&config), ["bob"]); + + apply_vpn_portal_client_patches( + &config, + vec![VpnPortalClientPatch { + action: ConfigPatchAction::Clear as i32, + client: None, + }], + ) + .unwrap(); + assert!(configured_names(&config).is_empty()); + } + + #[test] + fn vpn_portal_client_patches_preserve_disabled_configuration() { + let config = portal_config(); + let mut portal = config.get_vpn_portal_config().unwrap(); + portal.enabled = Some(false); + config.set_vpn_portal_config(portal.clone()); + let error = apply_vpn_portal_client_patches(&config, vec![remove("alice")]).unwrap_err(); + assert!(error.to_string().contains("disabled")); + assert_eq!(config.get_vpn_portal_config(), Some(portal)); + } + + #[test] + fn vpn_portal_client_patches_reject_missing_prerequisites() { + let bare = TomlConfig::default(); + let error = + apply_vpn_portal_client_patches(&bare, vec![add("alice", "10.0.0.2")]).unwrap_err(); + assert!(error.to_string().contains("not configured")); + + let config = portal_config(); + let error = apply_vpn_portal_client_patches(&config, vec![remove("ghost")]).unwrap_err(); + assert!(error.to_string().contains("not found")); + + let error = + apply_vpn_portal_client_patches(&config, vec![add("bob", "not-an-ip")]).unwrap_err(); + assert!( + error + .to_string() + .contains("invalid VPN portal client virtual CIDR") + ); + } +} diff --git a/vendor/easytier/easytier-core/src/management/full/instance_info.rs b/vendor/easytier/easytier-core/src/management/full/instance_info.rs new file mode 100644 index 0000000..0c471f2 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/full/instance_info.rs @@ -0,0 +1,80 @@ +use easytier_proto::api::{ + instance::{PeerInfo, list_peer_route_pair}, + manage::{MyNodeInfo, NetworkInstanceRunningInfo}, +}; + +use crate::{ + config::toml::ConfigLoader as _, + instance::{CoreInstance, CoreInstanceHost, CoreInstanceState}, +}; + +/// Builds the process-level running snapshot directly from one core Instance. +#[allow(deprecated)] +pub async fn network_instance_running_info( + instance: &CoreInstance, +) -> anyhow::Result +where + H: CoreInstanceHost, +{ + let running = !matches!( + instance.state(), + CoreInstanceState::Created | CoreInstanceState::Stopped + ); + if !instance.is_ready() { + return Ok(NetworkInstanceRunningInfo { + running, + error_msg: instance.latest_error(), + ..Default::default() + }); + } + + let peers = instance + .peer_snapshots() + .await + .into_iter() + .map(|snapshot| PeerInfo { + peer_id: snapshot.peer_id, + default_conn_id: snapshot.default_conn_id.map(Into::into), + directly_connected_conns: snapshot + .directly_connected_conns + .into_iter() + .map(Into::into) + .collect(), + conns: snapshot.conns.into_iter().map(Into::into).collect(), + }) + .collect::>(); + let node = instance.node_snapshot().await; + let routes = instance + .route_snapshots() + .await + .into_iter() + .map(Into::into) + .collect::>(); + let peer_route_pairs = list_peer_route_pair(peers.clone(), routes.clone()); + let dev_name = instance + .toml_config() + .map(|config| config.get_flags().dev_name) + .unwrap_or_default(); + + Ok(NetworkInstanceRunningInfo { + dev_name, + my_node_info: Some(MyNodeInfo { + virtual_ipv4: node.ipv4_addr.map(Into::into), + hostname: node.hostname, + version: node.version, + ips: Some(node.ip_list), + stun_info: Some(node.stun_info), + listeners: node.listeners.into_iter().map(Into::into).collect(), + // Client private keys are returned only by the explicit portal RPC. + vpn_portal_cfg: None, + peer_id: node.peer_id, + }), + events: instance.management_events(), + routes, + peers, + peer_route_pairs, + running, + error_msg: instance.latest_error(), + foreign_network_summary: Some(instance.foreign_network_route_summary().await), + }) +} diff --git a/vendor/easytier/easytier-core/src/management/full/logger_rpc.rs b/vendor/easytier/easytier-core/src/management/full/logger_rpc.rs new file mode 100644 index 0000000..052e4e7 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/full/logger_rpc.rs @@ -0,0 +1,126 @@ +use std::sync::Arc; + +use easytier_proto::{ + api::logger::{ + GetLoggerConfigRequest, GetLoggerConfigResponse, LogLevel, LoggerRpc, + SetLoggerConfigRequest, SetLoggerConfigResponse, + }, + rpc_types::{self, controller::BaseController}, +}; + +pub trait LoggerControl: Send + Sync + 'static { + fn set_level(&self, level: &str) -> anyhow::Result<()>; + + fn level(&self) -> String; +} + +#[derive(Default)] +pub struct UnsupportedLoggerControl; + +impl LoggerControl for UnsupportedLoggerControl { + fn set_level(&self, _level: &str) -> anyhow::Result<()> { + anyhow::bail!("logger control is unsupported by this Host") + } + + fn level(&self) -> String { + "info".to_owned() + } +} + +#[derive(Clone)] +pub struct LoggerManagementRpc { + control: Arc, +} + +impl LoggerManagementRpc { + pub fn new(control: Arc) -> Self { + Self { control } + } +} + +pub fn log_level_name(level: LogLevel) -> &'static str { + match level { + LogLevel::Disabled => "off", + LogLevel::Error => "error", + LogLevel::Warning => "warn", + LogLevel::Info => "info", + LogLevel::Debug => "debug", + LogLevel::Trace => "trace", + } +} + +pub fn parse_log_level(level: &str) -> LogLevel { + match level.to_ascii_lowercase().as_str() { + "off" | "disabled" => LogLevel::Disabled, + "error" => LogLevel::Error, + "warn" | "warning" => LogLevel::Warning, + "debug" => LogLevel::Debug, + "trace" => LogLevel::Trace, + _ => LogLevel::Info, + } +} + +#[async_trait::async_trait] +impl LoggerRpc for LoggerManagementRpc { + type Controller = BaseController; + + async fn set_logger_config( + &self, + _: BaseController, + request: SetLoggerConfigRequest, + ) -> rpc_types::error::Result { + self.control.set_level(log_level_name(request.level()))?; + Ok(SetLoggerConfigResponse {}) + } + + async fn get_logger_config( + &self, + _: BaseController, + _: GetLoggerConfigRequest, + ) -> rpc_types::error::Result { + Ok(GetLoggerConfigResponse { + level: parse_log_level(&self.control.level()).into(), + }) + } +} + +#[cfg(test)] +mod tests { + use std::sync::Mutex; + + use super::*; + + #[derive(Default)] + struct TestLoggerControl(Mutex); + + impl LoggerControl for TestLoggerControl { + fn set_level(&self, level: &str) -> anyhow::Result<()> { + *self.0.lock().unwrap() = level.to_owned(); + Ok(()) + } + + fn level(&self) -> String { + self.0.lock().unwrap().clone() + } + } + + #[tokio::test] + async fn logger_rpc_delegates_process_effects_to_host_control() { + let rpc = LoggerManagementRpc::new(Arc::new(TestLoggerControl::default())); + + rpc.set_logger_config( + BaseController::default(), + SetLoggerConfigRequest { + level: LogLevel::Debug.into(), + }, + ) + .await + .unwrap(); + let response = rpc + .get_logger_config(BaseController::default(), GetLoggerConfigRequest {}) + .await + .unwrap(); + + assert_eq!(response.level(), LogLevel::Debug); + } +} diff --git a/vendor/easytier/easytier-core/src/management/full/mod.rs b/vendor/easytier/easytier-core/src/management/full/mod.rs new file mode 100644 index 0000000..2a29358 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/full/mod.rs @@ -0,0 +1,145 @@ +#[cfg(feature = "management")] +mod compiled; +mod config_patch; +mod instance_info; +#[cfg(feature = "management")] +mod logger_rpc; +#[cfg(feature = "management")] +pub(super) mod packet_proxy; +mod process_rpc; +#[cfg(feature = "management")] +pub mod remote_client; +mod web_client; + +use std::sync::Arc; + +#[cfg(any(not(feature = "management"), test))] +use easytier_proto::api::config::ConfigRpcServer; +use easytier_proto::api::manage::WebClientServiceServer; +#[cfg(feature = "management")] +use easytier_proto::{ + api::logger::{LoggerRpc, LoggerRpcServer}, + rpc_types::controller::BaseController, +}; + +use crate::{ + config::toml::ConfigSource, + instance::{ + CoreInstance, CoreInstanceHost, + manager::{InstanceFactory, InstanceManager}, + }, + rpc::service_registry::ServiceRegistry, +}; + +use super::{ + ConfigFileControl, ConfigFilePermission, DaemonGuard, resolve_optional_instance_by_name, +}; + +#[cfg(feature = "management")] +pub use compiled::register_instance_management_rpc; +pub use config_patch::{ConfigPatchPersistence, apply_config_patch}; +pub use instance_info::network_instance_running_info; +#[cfg(feature = "management")] +pub use logger_rpc::{ + LoggerControl, LoggerManagementRpc, UnsupportedLoggerControl, log_level_name, parse_log_level, +}; +pub use process_rpc::{ + ConfigFileStorage, InstanceMutationHooks, InstanceMutationResult, ProcessManagement, + ProcessManagementRpc, UnsupportedConfigFileStorage, +}; +#[cfg(target_os = "wasi")] +pub(crate) use web_client::WebClientBackend; +pub use web_client::{ConfigServerEndpoint, WebClient, WebClientConfig}; + +#[cfg(feature = "management")] +pub use super::instance_rpc::full::call_instance_json_rpc; + +pub fn config_source_from_rpc(source: i32) -> Option { + match easytier_proto::api::manage::ConfigSource::try_from(source).ok() { + Some(easytier_proto::api::manage::ConfigSource::Web) => Some(ConfigSource::Web), + Some(easytier_proto::api::manage::ConfigSource::User) => Some(ConfigSource::User), + _ => None, + } +} + +pub fn config_source_to_rpc(source: ConfigSource) -> i32 { + match source { + ConfigSource::User => easytier_proto::api::manage::ConfigSource::User as i32, + ConfigSource::Web => easytier_proto::api::manage::ConfigSource::Web as i32, + } +} + +/// Registers the complete process-level management surface once. +#[cfg(feature = "management")] +pub fn register_management_rpc( + instances: Arc>, + registry: &ServiceRegistry, + hooks: Arc, + storage: Arc, + logger: Arc, +) where + F: InstanceFactory, CreateContext = ()>, + F::Error: std::fmt::Debug + std::fmt::Display + Send + Sync + 'static, + H: CoreInstanceHost, +{ + register_instance_management_rpc(instances.clone(), registry, storage.clone()); + registry.register(LoggerRpcServer::new(LoggerManagementRpc::new(logger)), ""); + registry.register( + WebClientServiceServer::new(ProcessManagementRpc::::new(instances, hooks, storage)), + "", + ); +} + +/// Registers the compact reverse-RPC surface required by easytier-web. +#[cfg(any(not(feature = "management"), test))] +pub(crate) fn register_web_client_rpc( + instances: Arc>, + registry: &ServiceRegistry, + hooks: Arc, + storage: Arc, +) where + F: InstanceFactory, CreateContext = ()>, + F::Error: std::fmt::Debug + std::fmt::Display + Send + Sync + 'static, + H: CoreInstanceHost, +{ + let config_rpc = super::instance_rpc::InstanceManagementRpc::::new_with_config_storage( + instances.clone(), + storage.clone(), + ); + registry.register(ConfigRpcServer::new(config_rpc), ""); + registry.register( + WebClientServiceServer::new(ProcessManagementRpc::::new(instances, hooks, storage)), + "", + ); +} + +#[cfg(feature = "management")] +pub async fn call_management_json_rpc( + manager: &Arc>, + logger: Arc, + service_name: &str, + method_name: &str, + domain_name: Option<&str>, + payload: serde_json::Value, +) -> crate::proto::rpc_types::error::Result +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + if service_name == "api.manage.WebClientService" { + return Err(anyhow::anyhow!( + "service {service_name} is not exposed through FFI/JNI generic RPC" + ) + .into()); + } + if service_name == "api.logger.LoggerRpcService" { + return LoggerRpc::json_call_method( + &LoggerManagementRpc::new(logger), + BaseController::default(), + method_name, + payload, + ) + .await; + } + call_instance_json_rpc(manager, service_name, method_name, domain_name, payload).await +} diff --git a/vendor/easytier/easytier-core/src/management/full/packet_proxy.rs b/vendor/easytier/easytier-core/src/management/full/packet_proxy.rs new file mode 100644 index 0000000..9c930f2 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/full/packet_proxy.rs @@ -0,0 +1,156 @@ +use std::sync::Arc; + +#[cfg(feature = "proxy-packet")] +use easytier_proto::{ + api::instance::{TcpProxyRpc, TcpProxyRpcServer}, + rpc_types::controller::BaseController, +}; + +#[cfg(feature = "proxy-packet")] +use crate::{ + gateway::proxy::wrapped_transport::{WrappedTransportKind, WrappedTransportRole}, + management::instance_rpc::packet_proxy::TcpProxyManagementRpc, +}; +use crate::{ + instance::{ + CoreInstance, CoreInstanceHost, + manager::{InstanceFactory, InstanceManager}, + }, + rpc::service_registry::ServiceRegistry, +}; + +pub(in crate::management) type JsonCall = + Result, serde_json::Value>; + +#[cfg(feature = "proxy-packet")] +pub(in crate::management) fn register( + manager: Arc>, + registry: &ServiceRegistry, +) where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + registry.register( + TcpProxyRpcServer::new(TcpProxyManagementRpc::::tcp(manager.clone())), + "tcp", + ); + for (domain, transport, role) in [ + ( + "kcp_src", + WrappedTransportKind::Kcp, + WrappedTransportRole::Source, + ), + ( + "kcp_dst", + WrappedTransportKind::Kcp, + WrappedTransportRole::Destination, + ), + ( + "quic_src", + WrappedTransportKind::Quic, + WrappedTransportRole::Source, + ), + ( + "quic_dst", + WrappedTransportKind::Quic, + WrappedTransportRole::Destination, + ), + ] { + registry.register( + TcpProxyRpcServer::new(TcpProxyManagementRpc::::wrapped( + manager.clone(), + transport, + role, + )), + domain, + ); + } +} + +#[cfg(not(feature = "proxy-packet"))] +pub(in crate::management) fn register( + _manager: Arc>, + _registry: &ServiceRegistry, +) where + F: InstanceFactory>, + H: CoreInstanceHost, +{ +} + +#[cfg(feature = "proxy-packet")] +pub(in crate::management) async fn call_json( + manager: &Arc>, + service_name: &str, + method_name: &str, + domain_name: Option<&str>, + payload: serde_json::Value, +) -> JsonCall +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + if service_name != "api.instance.TcpProxyRpcService" { + return Err(payload); + } + + let rpc = match tcp_proxy_json_service(manager.clone(), domain_name) { + Ok(rpc) => rpc, + Err(error) => return Ok(Err(error)), + }; + Ok(rpc + .json_call_method(BaseController::default(), method_name, payload) + .await) +} + +#[cfg(not(feature = "proxy-packet"))] +pub(in crate::management) async fn call_json( + _manager: &Arc>, + _service_name: &str, + _method_name: &str, + _domain_name: Option<&str>, + payload: serde_json::Value, +) -> JsonCall +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + Err(payload) +} + +#[cfg(feature = "proxy-packet")] +fn tcp_proxy_json_service( + manager: Arc>, + domain_name: Option<&str>, +) -> crate::proto::rpc_types::error::Result> +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + let rpc = match domain_name { + None | Some("") | Some("tcp") => TcpProxyManagementRpc::tcp(manager), + Some("kcp_src") => TcpProxyManagementRpc::wrapped( + manager, + WrappedTransportKind::Kcp, + WrappedTransportRole::Source, + ), + Some("kcp_dst") => TcpProxyManagementRpc::wrapped( + manager, + WrappedTransportKind::Kcp, + WrappedTransportRole::Destination, + ), + Some("quic_src") => TcpProxyManagementRpc::wrapped( + manager, + WrappedTransportKind::Quic, + WrappedTransportRole::Source, + ), + Some("quic_dst") => TcpProxyManagementRpc::wrapped( + manager, + WrappedTransportKind::Quic, + WrappedTransportRole::Destination, + ), + Some(domain) => { + return Err(anyhow::anyhow!("invalid TcpProxyRpcService domain_name: {domain}").into()); + } + }; + Ok(rpc) +} diff --git a/vendor/easytier/easytier-core/src/management/full/process_rpc.rs b/vendor/easytier/easytier-core/src/management/full/process_rpc.rs new file mode 100644 index 0000000..b1d37d1 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/full/process_rpc.rs @@ -0,0 +1,760 @@ +use std::{ + collections::HashSet, + path::{Path, PathBuf}, + sync::Arc, +}; + +use easytier_proto::{ + api::manage::{ + CollectNetworkInfoRequest, CollectNetworkInfoResponse, DeleteNetworkInstanceRequest, + DeleteNetworkInstanceResponse, GetNetworkInstanceConfigRequest, + GetNetworkInstanceConfigResponse, ListNetworkInstanceMetaRequest, + ListNetworkInstanceMetaResponse, ListNetworkInstanceRequest, ListNetworkInstanceResponse, + NetworkInstanceRunningInfoMap, NetworkMeta, RetainNetworkInstanceRequest, + RetainNetworkInstanceResponse, RunNetworkInstanceRequest, RunNetworkInstanceResponse, + ValidateConfigRequest, ValidateConfigResponse, WebClientService, + }, + rpc_types::{self, controller::BaseController}, +}; + +use crate::{ + config::{ + api::network_config_from_toml, + api_input::NetworkConfigExt as _, + toml::{ConfigLoader as _, ConfigSource, TomlConfig}, + }, + instance::{CoreInstance, CoreInstanceHost, manager::InstanceFactory}, +}; + +use super::{ + ConfigFileControl, ConfigFilePermission, InstanceManager, config_source_from_rpc, + config_source_to_rpc, network_instance_running_info, +}; + +#[async_trait::async_trait] +pub trait InstanceMutationHooks: Send + Sync + 'static { + fn manages_remote_config_instances(&self) -> bool { + false + } + + async fn pre_run_network_instance(&self, _config: &TomlConfig) -> Result<(), String> { + Ok(()) + } + + async fn post_run_network_instance(&self, _instance_id: &uuid::Uuid) -> Result<(), String> { + Ok(()) + } + + async fn post_remove_network_instances( + &self, + _instance_ids: &[uuid::Uuid], + ) -> Result<(), String> { + Ok(()) + } +} + +#[async_trait::async_trait] +impl InstanceMutationHooks for () {} + +/// Host Adapter for configuration-file effects used by process management. +#[async_trait::async_trait] +pub trait ConfigFileStorage: Send + Sync + 'static { + async fn inspect(&self, path: &Path) -> ConfigFileControl; + + async fn read(&self, path: &Path) -> anyhow::Result>>; + + /// Atomically replaces the file and restricts newly created files to the + /// current user when the Host supports file permissions. + async fn write(&self, path: &Path, contents: &[u8]) -> anyhow::Result<()>; + + async fn remove(&self, path: &Path) -> anyhow::Result<()>; +} + +#[derive(Default)] +pub struct UnsupportedConfigFileStorage; + +#[async_trait::async_trait] +impl ConfigFileStorage for UnsupportedConfigFileStorage { + async fn inspect(&self, path: &Path) -> ConfigFileControl { + ConfigFileControl::new( + Some(path.to_owned()), + ConfigFilePermission::from(ConfigFilePermission::READ_ONLY), + ) + } + + async fn read(&self, _path: &Path) -> anyhow::Result>> { + anyhow::bail!("configuration-file storage is unsupported by this Host") + } + + async fn write(&self, _path: &Path, _contents: &[u8]) -> anyhow::Result<()> { + anyhow::bail!("configuration-file storage is unsupported by this Host") + } + + async fn remove(&self, _path: &Path) -> anyhow::Result<()> { + anyhow::bail!("configuration-file storage is unsupported by this Host") + } +} + +/// Result of one process-level removal transaction. +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct InstanceMutationResult { + pub remaining_instance_ids: Vec, + pub removed_instance_ids: Vec, +} + +/// Transport-independent process-level Instance management. +pub struct ProcessManagement +where + F: InstanceFactory, +{ + instances: Arc>, + hooks: Arc, + storage: Arc, + mutation_lock: Arc>, +} + +impl Clone for ProcessManagement +where + F: InstanceFactory, +{ + fn clone(&self) -> Self { + Self { + instances: self.instances.clone(), + hooks: self.hooks.clone(), + storage: self.storage.clone(), + mutation_lock: self.mutation_lock.clone(), + } + } +} + +impl ProcessManagement +where + F: InstanceFactory, CreateContext = ()>, + F::Error: std::fmt::Debug + std::fmt::Display + Send + Sync + 'static, + H: CoreInstanceHost, +{ + pub fn new( + instances: Arc>, + hooks: Arc, + storage: Arc, + ) -> Self { + let mutation_lock = instances.mutation_lock(); + Self { + instances, + hooks, + storage, + mutation_lock, + } + } + + async fn is_remote_removable(&self, control: &ConfigFileControl) -> bool { + if control.is_read_only() || !control.is_deletable() { + return false; + } + let Some(path) = control.path.as_deref() else { + return true; + }; + !self.storage.inspect(path).await.is_read_only() + } + + async fn ensure_overwritable( + &self, + instance_id: uuid::Uuid, + control: &ConfigFileControl, + require_deletable: bool, + ) -> anyhow::Result<()> { + if control.is_read_only() { + anyhow::bail!("instance {instance_id} is read-only, cannot be overwritten"); + } + if require_deletable && !control.is_deletable() { + anyhow::bail!("instance {instance_id} is no-delete, cannot be overwritten"); + } + if let Some(path) = control.path.as_deref() + && self.storage.inspect(path).await.is_read_only() + { + anyhow::bail!( + "config file {} is read-only, cannot be overwritten", + path.display() + ); + } + Ok(()) + } + + async fn apply_file_cleanup(&self, cleanup: ConfigFileCleanup) { + let result = match cleanup { + ConfigFileCleanup::Remove(path) => self.storage.remove(&path).await, + ConfigFileCleanup::Restore { path, contents } => { + self.storage.write(&path, &contents).await + } + }; + if let Err(error) = result { + tracing::warn!(%error, "failed to roll back configuration file"); + } + } + + async fn rollback_started_instance( + &self, + started_instance_id: Option, + file_cleanup: Option, + restore_instance: Option<(TomlConfig, ConfigFileControl)>, + ) { + if let Some(instance_id) = started_instance_id + && let Err(error) = self.instances.delete_network_instances([instance_id]).await + { + tracing::warn!(%error, "failed to remove rolled-back instance"); + return; + } + if let Some(cleanup) = file_cleanup { + self.apply_file_cleanup(cleanup).await; + } + if let Some((config, control)) = restore_instance + && let Err(error) = self.instances.run_network_instance(config, control) + { + tracing::warn!(%error, "failed to restore overwritten instance"); + } + } + + pub async fn run_network_instance( + &self, + config: TomlConfig, + requested_id: Option, + overwrite: bool, + requested_source: Option, + ) -> anyhow::Result { + let mut instance_id = config.get_id(); + if let Some(requested_id) = requested_id { + instance_id = requested_id; + config.set_id(instance_id); + } + let _mutation = self.mutation_lock.lock().await; + let remote_managed = self.hooks.manages_remote_config_instances(); + + let mut replacing = false; + let mut restore_instance = None; + let mut control = if let Some(control) = self.instances.config_control(instance_id) { + let existing_source = self.instances.config_source(instance_id); + let error_message = self + .instances + .network_info(instance_id) + .await + .and_then(|info| info.error_msg) + .unwrap_or_default(); + if !overwrite && error_message.is_empty() { + return Ok(instance_id); + } + self.ensure_overwritable(instance_id, &control, remote_managed) + .await?; + config.set_network_config_source(requested_source.or(existing_source)); + replacing = true; + restore_instance = self + .instances + .config(instance_id) + .map(|config| (config, control.clone())); + control + } else if let Some(config_dir) = self.instances.config_dir() { + config.set_network_config_source(requested_source); + ConfigFileControl::new( + Some(config_dir.join(format!("{instance_id}.toml"))), + ConfigFilePermission::default(), + ) + } else { + config.set_network_config_source(requested_source); + ConfigFileControl::new(None, ConfigFilePermission::default()) + }; + + self.hooks + .pre_run_network_instance(&config) + .await + .map_err(|error| anyhow::anyhow!("pre-run hook failed: {error}"))?; + + if replacing { + self.ensure_overwritable(instance_id, &control, remote_managed) + .await?; + } + + let mut file_cleanup = None; + if !control.is_read_only() + && let Some(path) = control.path.as_deref() + { + let cleanup = match self.storage.read(path).await { + Ok(Some(contents)) => Some(ConfigFileCleanup::Restore { + path: path.to_owned(), + contents, + }), + Ok(None) => Some(ConfigFileCleanup::Remove(path.to_owned())), + Err(error) => { + return Err(anyhow::anyhow!( + "failed to back up config file {} before overwrite: {error}", + path.display() + )); + } + }; + if let Err(error) = self.storage.write(path, config.dump().as_bytes()).await { + tracing::warn!(%error, path = %path.display(), "failed to write config file"); + control.set_read_only(true); + } else { + file_cleanup = cleanup; + } + } + + if replacing + && let Err(error) = self.instances.delete_network_instances([instance_id]).await + { + self.rollback_started_instance(None, file_cleanup, restore_instance) + .await; + return Err(error); + } + + if let Err(error) = self.instances.run_network_instance(config, control) { + self.rollback_started_instance(None, file_cleanup, restore_instance) + .await; + return Err(error); + } + + if let Err(error) = self.hooks.post_run_network_instance(&instance_id).await { + if remote_managed { + self.rollback_started_instance(Some(instance_id), file_cleanup, restore_instance) + .await; + return Err(anyhow::anyhow!("post-run hook failed: {error}")); + } + tracing::warn!(%error, "post-run hook failed"); + } + Ok(instance_id) + } + + pub async fn retain_network_instances( + &self, + retained: Vec, + ) -> anyhow::Result { + let _mutation = self.mutation_lock.lock().await; + self.retain_network_instances_locked(retained).await + } + + /// Resolves retained names and mutates the collection in one transaction. + pub async fn retain_owned_network_instances_by_name( + &self, + retained_names: Vec, + ) -> anyhow::Result { + let _mutation = self.mutation_lock.lock().await; + let retained = self.resolve_instance_ids_by_name(&retained_names)?; + self.retain_network_instances_locked(retained).await + } + + async fn retain_network_instances_locked( + &self, + retained: Vec, + ) -> anyhow::Result { + let before = self.instances.instance_ids(); + if !self.hooks.manages_remote_config_instances() { + let remaining = self.instances.retain_network_instances(&retained).await?; + let remaining_set = remaining.iter().copied().collect::>(); + let removed = before + .into_iter() + .filter(|id| !remaining_set.contains(id)) + .collect::>(); + self.notify_removed_instances(&removed).await?; + return Ok(InstanceMutationResult { + removed_instance_ids: removed, + remaining_instance_ids: remaining, + }); + } + + let mut retained = retained.into_iter().collect::>(); + let mut removed = Vec::new(); + for instance in self.instances.instances() { + let instance_id = instance.instance_id(); + if retained.contains(&instance_id) { + continue; + } + let Some(control) = self.instances.config_control(instance_id) else { + continue; + }; + if self.is_remote_removable(&control).await { + removed.push(instance_id); + } else { + retained.insert(instance_id); + } + } + let remaining = self + .instances + .retain_network_instances(&retained.into_iter().collect::>()) + .await?; + self.notify_removed_instances(&removed).await?; + Ok(InstanceMutationResult { + remaining_instance_ids: remaining, + removed_instance_ids: removed, + }) + } + + pub async fn delete_network_instances( + &self, + requested: Vec, + ) -> anyhow::Result { + let _mutation = self.mutation_lock.lock().await; + let requested = requested.into_iter().collect::>(); + let remote_managed = self.hooks.manages_remote_config_instances(); + let mut removed = Vec::new(); + let mut files = Vec::new(); + for instance in self.instances.instances() { + let instance_id = instance.instance_id(); + if !requested.contains(&instance_id) { + continue; + } + let Some(control) = self.instances.config_control(instance_id) else { + continue; + }; + let removable = if remote_managed { + self.is_remote_removable(&control).await + } else { + control.is_deletable() + }; + if removable { + removed.push(instance_id); + files.extend(control.path); + } + } + let remaining = self + .instances + .delete_network_instances(removed.clone()) + .await?; + self.notify_removed_instances(&removed).await?; + for path in files { + if remote_managed && self.storage.inspect(&path).await.is_read_only() { + continue; + } + if let Err(error) = self.storage.remove(&path).await { + tracing::warn!(%error, path = %path.display(), "failed to remove config file"); + } + } + Ok(InstanceMutationResult { + remaining_instance_ids: remaining, + removed_instance_ids: removed, + }) + } + + /// Starts one caller-owned Instance while preserving its static control. + pub async fn run_owned_network_instance( + &self, + config: TomlConfig, + control: ConfigFileControl, + ) -> anyhow::Result { + let _mutation = self.mutation_lock.lock().await; + let instance_id = config.get_id(); + if self.instances.instance(instance_id).is_some() { + anyhow::bail!("instance {instance_id} already exists"); + } + let instance_name = config.get_inst_name(); + if super::resolve_optional_instance_by_name(self.instances.as_ref(), &instance_name)? + .is_some() + { + anyhow::bail!("instance name {instance_name} already exists"); + } + self.instances.run_network_instance(config, control) + } + + /// Removes caller-owned Instances without applying remote config-file policy. + pub async fn delete_owned_network_instances( + &self, + requested: Vec, + ) -> anyhow::Result { + self.delete_owned_network_instances_selected_by(|| requested) + .await + } + + /// Selects caller-owned Instances and removes them under one lock. + pub async fn delete_owned_network_instances_selected_by( + &self, + select: impl FnOnce() -> Vec, + ) -> anyhow::Result { + let _mutation = self.mutation_lock.lock().await; + let requested = select(); + self.delete_owned_network_instances_locked(requested).await + } + + /// Resolves requested names and removes them in one transaction. + pub async fn delete_owned_network_instances_by_name( + &self, + requested_names: Vec, + ) -> anyhow::Result { + let _mutation = self.mutation_lock.lock().await; + let requested = self.resolve_instance_ids_by_name(&requested_names)?; + self.delete_owned_network_instances_locked(requested).await + } + + async fn delete_owned_network_instances_locked( + &self, + requested: Vec, + ) -> anyhow::Result { + let before = self.instances.instance_ids(); + let remaining = self.instances.delete_network_instances(requested).await?; + let remaining_set = remaining.iter().copied().collect::>(); + let removed = before + .into_iter() + .filter(|id| !remaining_set.contains(id)) + .collect::>(); + self.notify_removed_instances(&removed).await?; + Ok(InstanceMutationResult { + removed_instance_ids: removed, + remaining_instance_ids: remaining, + }) + } + + fn resolve_instance_ids_by_name(&self, names: &[String]) -> anyhow::Result> { + names + .iter() + .map(|name| { + super::resolve_optional_instance_by_name(self.instances.as_ref(), name) + .map(|instance| instance.map(|instance| instance.instance_id())) + }) + .filter_map(Result::transpose) + .collect() + } + + async fn notify_removed_instances(&self, removed: &[uuid::Uuid]) -> anyhow::Result<()> { + if let Err(error) = self.hooks.post_remove_network_instances(removed).await { + if self.hooks.manages_remote_config_instances() { + anyhow::bail!("post-remove hook failed: {error}"); + } + tracing::warn!(%error, "post-remove hook failed"); + } + Ok(()) + } +} + +enum ConfigFileCleanup { + Remove(PathBuf), + Restore { path: PathBuf, contents: Vec }, +} + +/// Protobuf projection over transport-independent process management. +pub struct ProcessManagementRpc +where + F: InstanceFactory, +{ + management: ProcessManagement, +} + +impl Clone for ProcessManagementRpc +where + F: InstanceFactory, +{ + fn clone(&self) -> Self { + Self { + management: self.management.clone(), + } + } +} + +impl ProcessManagementRpc +where + F: InstanceFactory, CreateContext = ()>, + F::Error: std::fmt::Debug + std::fmt::Display + Send + Sync + 'static, + H: CoreInstanceHost, +{ + pub fn new( + instances: Arc>, + hooks: Arc, + storage: Arc, + ) -> Self { + Self { + management: ProcessManagement::new(instances, hooks, storage), + } + } +} + +#[async_trait::async_trait] +impl WebClientService for ProcessManagementRpc +where + F: InstanceFactory, CreateContext = ()>, + F::Error: std::fmt::Debug + std::fmt::Display + Send + Sync + 'static, + H: CoreInstanceHost, +{ + type Controller = BaseController; + + async fn validate_config( + &self, + _: BaseController, + request: ValidateConfigRequest, + ) -> rpc_types::error::Result { + Ok(ValidateConfigResponse { + toml_config: request.config.unwrap_or_default().gen_config()?.dump(), + }) + } + + async fn run_network_instance( + &self, + _: BaseController, + request: RunNetworkInstanceRequest, + ) -> rpc_types::error::Result { + let config = request + .config + .ok_or_else(|| anyhow::anyhow!("config is required"))? + .gen_config()?; + let requested_id = request.inst_id.map(Into::into); + let requested_source = config_source_from_rpc(request.source); + let management = self.management.clone(); + let instance_id = tokio::spawn(async move { + management + .run_network_instance(config, requested_id, request.overwrite, requested_source) + .await + }) + .await + .map_err(|error| anyhow::anyhow!("instance mutation task failed: {error}"))??; + Ok(RunNetworkInstanceResponse { + inst_id: Some(instance_id.into()), + }) + } + + async fn retain_network_instance( + &self, + _: BaseController, + request: RetainNetworkInstanceRequest, + ) -> rpc_types::error::Result { + let retained = request.inst_ids.into_iter().map(Into::into).collect(); + let management = self.management.clone(); + let result = + tokio::spawn(async move { management.retain_network_instances(retained).await }) + .await + .map_err(|error| anyhow::anyhow!("instance mutation task failed: {error}"))??; + Ok(RetainNetworkInstanceResponse { + remain_inst_ids: result + .remaining_instance_ids + .into_iter() + .map(Into::into) + .collect(), + }) + } + + async fn collect_network_info( + &self, + _: BaseController, + request: CollectNetworkInfoRequest, + ) -> rpc_types::error::Result { + let included = request + .inst_ids + .into_iter() + .map(uuid::Uuid::from) + .collect::>(); + let map = if included.is_empty() { + self.management + .instances + .collect_network_infos() + .await? + .into_iter() + .map(|(id, info)| (id.to_string(), info)) + .collect() + } else { + let mut map = std::collections::BTreeMap::new(); + for instance_id in included { + let Some(instance) = self.management.instances.instance(instance_id) else { + continue; + }; + map.insert( + instance_id.to_string(), + network_instance_running_info(instance.as_ref()).await?, + ); + } + map + }; + Ok(CollectNetworkInfoResponse { + info: Some(NetworkInstanceRunningInfoMap { map }), + }) + } + + async fn list_network_instance( + &self, + _: BaseController, + _: ListNetworkInstanceRequest, + ) -> rpc_types::error::Result { + Ok(ListNetworkInstanceResponse { + inst_ids: self + .management + .instances + .instance_ids() + .into_iter() + .map(Into::into) + .collect(), + }) + } + + async fn delete_network_instance( + &self, + _: BaseController, + request: DeleteNetworkInstanceRequest, + ) -> rpc_types::error::Result { + let requested = request.inst_ids.into_iter().map(Into::into).collect(); + let management = self.management.clone(); + let result = + tokio::spawn(async move { management.delete_network_instances(requested).await }) + .await + .map_err(|error| anyhow::anyhow!("instance mutation task failed: {error}"))??; + Ok(DeleteNetworkInstanceResponse { + remain_inst_ids: result + .remaining_instance_ids + .into_iter() + .map(Into::into) + .collect(), + }) + } + + async fn get_network_instance_config( + &self, + _: BaseController, + request: GetNetworkInstanceConfigRequest, + ) -> rpc_types::error::Result { + let instance_id = request + .inst_id + .ok_or_else(|| anyhow::anyhow!("instance id is required"))? + .into(); + let control = self + .management + .instances + .config_control(instance_id) + .ok_or_else(|| anyhow::anyhow!("instance config control not found"))?; + if control.is_read_only() { + return Err( + anyhow::anyhow!("configuration for instance {instance_id} is read-only").into(), + ); + } + Ok(GetNetworkInstanceConfigResponse { + config: self + .management + .instances + .config(instance_id) + .map(|config| network_config_from_toml(&config)), + source: config_source_to_rpc( + self.management + .instances + .config_source(instance_id) + .unwrap_or(ConfigSource::User), + ), + }) + } + + async fn list_network_instance_meta( + &self, + _: BaseController, + request: ListNetworkInstanceMetaRequest, + ) -> rpc_types::error::Result { + let mut metas = Vec::with_capacity(request.inst_ids.len()); + for instance_id in request.inst_ids.into_iter().map(uuid::Uuid::from) { + let Some(instance) = self.management.instances.instance(instance_id) else { + continue; + }; + let Some(config) = instance.toml_config() else { + continue; + }; + let Some(control) = self.management.instances.config_control(instance_id) else { + continue; + }; + metas.push(NetworkMeta { + inst_id: Some(instance_id.into()), + network_name: config.get_network_identity().network_name, + config_permission: control.permission.into(), + instance_name: instance.instance_name().to_owned(), + source: config_source_to_rpc(config.get_network_config_source()), + }); + } + Ok(ListNetworkInstanceMetaResponse { metas }) + } +} diff --git a/vendor/easytier/easytier-core/src/management/full/remote_client.rs b/vendor/easytier/easytier-core/src/management/full/remote_client.rs new file mode 100644 index 0000000..579441c --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/full/remote_client.rs @@ -0,0 +1,749 @@ +use async_trait::async_trait; +use uuid::Uuid; + +use easytier_proto::{ + api::config::{ConfigRpc, InstanceConfigPatch, PatchConfigRequest, VpnPortalClientPatch}, + api::instance::{InstanceIdentifier, instance_identifier}, + api::manage::{ + CollectNetworkInfoRequest, CollectNetworkInfoResponse, DeleteNetworkInstanceRequest, + GetNetworkInstanceConfigRequest, ListNetworkInstanceMetaRequest, + ListNetworkInstanceRequest, NetworkConfig, NetworkMeta, RunNetworkInstanceRequest, + ValidateConfigRequest, ValidateConfigResponse, WebClientService, + }, + rpc_types::controller::BaseController, +}; + +use crate::config::{api_input::NetworkConfigExt as _, toml::ConfigSource}; + +use super::{config_source_from_rpc, config_source_to_rpc}; + +#[async_trait] +pub trait RemoteClientManager +where + T: Clone + Send + 'static, + C: PersistentConfig + Send + 'static, + E: Send + 'static, +{ + fn get_rpc_client( + &self, + identify: T, + ) -> Option + Send>>; + + fn get_storage(&self) -> &impl Storage; + + fn get_config_rpc_client( + &self, + identify: T, + ) -> Option + Send>>; + + async fn handle_patch_vpn_portal_clients( + &self, + identify: T, + inst_id: uuid::Uuid, + patches: Vec, + ) -> Result<(), RemoteClientError> { + // The caller serializes this operation with its other device changes + // and (for Web) desired-config updates and runtime reconciliation. + if patches.is_empty() { + return Ok(()); + } + let stored = self + .get_storage() + .get_network_config(identify.clone(), &inst_id.to_string()) + .await + .map_err(RemoteClientError::PersistentError)?; + let mut desired = None; + if let Some(stored) = stored { + let mut config = stored + .get_network_config() + .map_err(RemoteClientError::PersistentError)?; + let candidate = config + .gen_config() + .map_err(|e| RemoteClientError::Other(e.to_string()))?; + super::config_patch::apply_vpn_portal_client_patches(&candidate, patches.clone()) + .map_err(|e| RemoteClientError::Other(e.to_string()))?; + let normalized = crate::instance::CoreInstanceConfig::from_toml(&candidate) + .map_err(|e| RemoteClientError::Other(e.to_string()))?; + // Pending saved clients, addresses and ACL declarations may differ + // from runtime. Validate the actual saved candidate as well. + crate::gateway::vpn_portal::validate_clients( + normalized.vpn_portal.as_ref().unwrap(), + &super::config_patch::runtime_config_from_normalized(&normalized), + ) + .map_err(|e| RemoteClientError::Other(e.to_string()))?; + let updated = NetworkConfig::new_from_config(&candidate) + .map_err(|e| RemoteClientError::Other(e.to_string()))?; + // Keep pending saved changes, including the listener and key. + // Only the requested device changes belong to this operation. + config.vpn_portal_config.as_mut().unwrap().clients = + updated.vpn_portal_config.unwrap().clients; + desired = Some((config, stored.get_network_config_source())); + } + let client = self + .get_config_rpc_client(identify.clone()) + .ok_or(RemoteClientError::ClientNotFound)?; + client + .patch_config( + BaseController::default(), + PatchConfigRequest { + instance: Some(InstanceIdentifier { + selector: Some(instance_identifier::Selector::Id(inst_id.into())), + }), + patch: Some(InstanceConfigPatch { + vpn_portal_clients: patches, + ..Default::default() + }), + }, + ) + .await?; + + // PatchConfig persists the node's TOML file, when present. GUI and + // Web also own saved configurations that must retain this change. + let (config, source) = if let Some(desired) = desired { + desired + } else { + let rpc = self + .get_rpc_client(identify.clone()) + .ok_or(RemoteClientError::ClientNotFound)?; + let response = rpc + .get_network_instance_config( + BaseController::default(), + GetNetworkInstanceConfigRequest { + inst_id: Some(inst_id.into()), + }, + ) + .await?; + let config = response.config.ok_or_else(|| { + RemoteClientError::NotFound(format!("No running network instance: {inst_id}")) + })?; + let source = config_source_from_rpc(response.source).unwrap_or(ConfigSource::User); + (config, source) + }; + self.get_storage() + .insert_or_update_user_network_config(identify, inst_id, config, source) + .await + .map_err(RemoteClientError::PersistentError) + } + + async fn handle_validate_config( + &self, + identify: T, + config: NetworkConfig, + ) -> Result> { + let client = self + .get_rpc_client(identify) + .ok_or(RemoteClientError::ClientNotFound)?; + client + .validate_config( + BaseController::default(), + ValidateConfigRequest { + config: Some(config), + }, + ) + .await + .map_err(RemoteClientError::RpcError) + } + + async fn handle_run_network_instance( + &self, + identify: T, + config: NetworkConfig, + save: bool, + ) -> Result<(), RemoteClientError> { + self.handle_run_network_instance_with_source(identify, config, save, ConfigSource::User) + .await + } + + async fn handle_run_network_instance_with_source( + &self, + identify: T, + config: NetworkConfig, + save: bool, + source: ConfigSource, + ) -> Result<(), RemoteClientError> { + let client = self + .get_rpc_client(identify.clone()) + .ok_or(RemoteClientError::ClientNotFound)?; + let resp = client + .run_network_instance( + BaseController::default(), + RunNetworkInstanceRequest { + inst_id: None, + config: Some(config.clone()), + overwrite: true, + source: config_source_to_rpc(source), + }, + ) + .await?; + + if save { + self.get_storage() + .insert_or_update_user_network_config( + identify, + resp.inst_id.unwrap_or_default().into(), + config, + source, + ) + .await + .map_err(RemoteClientError::PersistentError)?; + } + + Ok(()) + } + + async fn handle_collect_network_info( + &self, + identify: T, + inst_ids: Option>, + ) -> Result> { + let client = self + .get_rpc_client(identify) + .ok_or(RemoteClientError::ClientNotFound)?; + let resp = client + .collect_network_info( + BaseController::default(), + CollectNetworkInfoRequest { + inst_ids: inst_ids + .unwrap_or_default() + .into_iter() + .map(|id| id.into()) + .collect(), + }, + ) + .await?; + + Ok(resp) + } + + async fn handle_list_network_instance_ids( + &self, + identify: T, + ) -> Result> { + let client = self + .get_rpc_client(identify.clone()) + .ok_or(RemoteClientError::ClientNotFound)?; + let ret = client + .list_network_instance(BaseController::default(), ListNetworkInstanceRequest {}) + .await?; + + let running_inst_ids = ret.inst_ids.clone().into_iter().collect(); + + // collect networks that are disabled + let disabled_inst_ids = self + .get_storage() + .list_network_configs(identify, ListNetworkProps::All) + .await + .map_err(RemoteClientError::PersistentError)? + .iter() + .map(|x| { + Into::::into(x.get_network_inst_id().to_string()) + }) + .filter(|id| !ret.inst_ids.contains(id)) + .collect::>(); + + Ok(ListNetworkInstanceIdsJsonResp { + running_inst_ids, + disabled_inst_ids, + }) + } + + async fn handle_remove_network_instances( + &self, + identify: T, + inst_ids: Vec, + ) -> Result<(), RemoteClientError> { + if inst_ids.is_empty() { + return Ok(()); + } + let client = self + .get_rpc_client(identify.clone()) + .ok_or(RemoteClientError::ClientNotFound)?; + self.get_storage() + .delete_network_configs(identify, &inst_ids) + .await + .map_err(RemoteClientError::PersistentError)?; + + client + .delete_network_instance( + BaseController::default(), + DeleteNetworkInstanceRequest { + inst_ids: inst_ids.into_iter().map(|id| id.into()).collect(), + }, + ) + .await?; + + Ok(()) + } + + async fn handle_update_network_state( + &self, + identify: T, + inst_id: uuid::Uuid, + disabled: bool, + ) -> Result<(), RemoteClientError> { + let client = self + .get_rpc_client(identify.clone()) + .ok_or(RemoteClientError::ClientNotFound)?; + + let (cfg, source) = self + .handle_get_network_config_with_source(identify.clone(), inst_id) + .await?; + + if disabled { + self.get_storage() + .insert_or_update_user_network_config( + identify.clone(), + inst_id, + cfg.clone(), + source, + ) + .await + .map_err(RemoteClientError::PersistentError)?; + + client + .delete_network_instance( + BaseController::default(), + DeleteNetworkInstanceRequest { + inst_ids: vec![inst_id.into()], + }, + ) + .await?; + } else { + client + .run_network_instance( + BaseController::default(), + RunNetworkInstanceRequest { + inst_id: Some(inst_id.into()), + config: Some(cfg), + overwrite: true, + source: config_source_to_rpc(source), + }, + ) + .await?; + } + + self.get_storage() + .update_network_config_state(identify, inst_id, disabled) + .await + .map_err(RemoteClientError::PersistentError)?; + + Ok(()) + } + + async fn handle_get_network_metas( + &self, + identify: T, + inst_ids: Vec, + ) -> Result> { + let mut metas = std::collections::HashMap::new(); + + if let Some(client) = self.get_rpc_client(identify.clone()) + && let Ok(resp) = client + .list_network_instance_meta( + BaseController::default(), + ListNetworkInstanceMetaRequest { + inst_ids: inst_ids.iter().cloned().map(|id| id.into()).collect(), + }, + ) + .await + { + for meta in resp.metas { + if let Some(inst_id) = meta.inst_id.as_ref() { + let inst_id: uuid::Uuid = (*inst_id).into(); + metas.insert(inst_id, meta); + } + } + } + + for instance_id in inst_ids { + if metas.contains_key(&instance_id) { + continue; + } + let (config, source) = self + .handle_get_network_config_with_source(identify.clone(), instance_id) + .await?; + let network_name = config.network_name.unwrap_or_default(); + metas.insert( + instance_id, + NetworkMeta { + inst_id: Some(instance_id.into()), + network_name: network_name.clone(), + config_permission: 0, + instance_name: network_name, + source: config_source_to_rpc(source), + }, + ); + } + + Ok(GetNetworkMetasResponse { metas }) + } + + async fn handle_save_network_config( + &self, + identify: T, + inst_id: uuid::Uuid, + config: NetworkConfig, + ) -> Result<(), RemoteClientError> { + self.handle_save_network_config_with_source(identify, inst_id, config, ConfigSource::User) + .await + } + + async fn handle_save_network_config_with_source( + &self, + identify: T, + inst_id: uuid::Uuid, + config: NetworkConfig, + source: ConfigSource, + ) -> Result<(), RemoteClientError> { + self.get_storage() + .insert_or_update_user_network_config(identify.clone(), inst_id, config, source) + .await + .map_err(RemoteClientError::PersistentError)?; + self.get_storage() + .update_network_config_state(identify, inst_id, true) + .await + .map_err(RemoteClientError::PersistentError)?; + Ok(()) + } + + async fn handle_get_network_config( + &self, + identify: T, + inst_id: uuid::Uuid, + ) -> Result> { + self.handle_get_network_config_with_source(identify, inst_id) + .await + .map(|(config, _)| config) + } + + async fn handle_get_network_config_with_source( + &self, + identify: T, + inst_id: uuid::Uuid, + ) -> Result<(NetworkConfig, ConfigSource), RemoteClientError> { + if let Some(client) = self.get_rpc_client(identify.clone()) + && let Ok(resp) = client + .get_network_instance_config( + BaseController::default(), + GetNetworkInstanceConfigRequest { + inst_id: Some(inst_id.into()), + }, + ) + .await + && let Some(config) = resp.config + { + let source = if let Some(source) = config_source_from_rpc(resp.source) { + source + } else { + self.get_storage() + .get_network_config(identify.clone(), &inst_id.to_string()) + .await + .map_err(RemoteClientError::PersistentError)? + .map(|cfg| cfg.get_runtime_network_config_source()) + .unwrap_or(ConfigSource::User) + }; + return Ok((config, source)); + } + + let inst_id = inst_id.to_string(); + + let db_row = self + .get_storage() + .get_network_config(identify, &inst_id) + .await + .map_err(RemoteClientError::PersistentError)? + .ok_or(RemoteClientError::NotFound(format!( + "No such network instance: {}", + inst_id + )))?; + + Ok(( + db_row + .get_network_config() + .map_err(RemoteClientError::PersistentError)?, + db_row.get_runtime_network_config_source(), + )) + } +} + +#[derive(Debug, thiserror::Error)] +pub enum RemoteClientError { + #[error("Client not found")] + ClientNotFound, + #[error("Not found: {0}")] + NotFound(String), + #[error(transparent)] + RpcError(#[from] easytier_proto::rpc_types::error::Error), + #[error(transparent)] + PersistentError(E), + #[error("Other error: {0}")] + Other(String), +} + +pub enum ListNetworkProps { + All, + EnabledOnly, + DisabledOnly, +} + +#[derive(Debug, serde::Deserialize, serde::Serialize)] +pub struct ListNetworkInstanceIdsJsonResp { + running_inst_ids: Vec, + disabled_inst_ids: Vec, +} + +#[derive(Debug, serde::Deserialize, serde::Serialize)] +pub struct GetNetworkMetasResponse { + metas: std::collections::HashMap, +} + +pub trait PersistentConfig { + fn get_network_inst_id(&self) -> &str; + fn get_network_config(&self) -> Result; + fn get_network_config_source(&self) -> ConfigSource; + fn get_runtime_network_config_source(&self) -> ConfigSource { + self.get_network_config_source() + } +} + +#[async_trait] +pub trait Storage: Send + Sync +where + C: PersistentConfig, +{ + async fn insert_or_update_user_network_config( + &self, + identify: T, + network_inst_id: Uuid, + network_config: NetworkConfig, + source: ConfigSource, + ) -> Result<(), E>; + + async fn delete_network_configs(&self, identify: T, network_inst_ids: &[Uuid]) + -> Result<(), E>; + + async fn update_network_config_state( + &self, + identify: T, + network_inst_id: Uuid, + disabled: bool, + ) -> Result<(), E>; + + async fn list_network_configs(&self, identify: T, props: ListNetworkProps) + -> Result, E>; + + async fn get_network_config(&self, identify: T, network_inst_id: &str) -> Result, E>; +} + +#[cfg(test)] +mod tests { + use std::sync::Mutex; + + use easytier_proto::api::{ + config::{ConfigPatchAction, GetConfigRequest, GetConfigResponse, PatchConfigResponse}, + manage::{NetworkingMethod, VpnPortalClientConfig, VpnPortalConfig}, + }; + + use super::*; + + #[derive(Clone)] + struct SavedConfig(NetworkConfig, ConfigSource); + + impl PersistentConfig for SavedConfig { + fn get_network_inst_id(&self) -> &str { + self.0.instance_id.as_deref().unwrap() + } + + fn get_network_config(&self) -> anyhow::Result { + Ok(self.0.clone()) + } + + fn get_network_config_source(&self) -> ConfigSource { + self.1 + } + } + + #[async_trait] + impl Storage<(), SavedConfig, anyhow::Error> for Mutex> { + async fn insert_or_update_user_network_config( + &self, + _: (), + _: Uuid, + config: NetworkConfig, + source: ConfigSource, + ) -> anyhow::Result<()> { + *self.lock().unwrap() = Some(SavedConfig(config, source)); + Ok(()) + } + + async fn get_network_config(&self, _: (), _: &str) -> anyhow::Result> { + Ok(self.lock().unwrap().clone()) + } + + async fn delete_network_configs(&self, _: (), _: &[Uuid]) -> anyhow::Result<()> { + unreachable!() + } + + async fn update_network_config_state(&self, _: (), _: Uuid, _: bool) -> anyhow::Result<()> { + unreachable!() + } + + async fn list_network_configs( + &self, + _: (), + _: ListNetworkProps, + ) -> anyhow::Result> { + unreachable!() + } + } + + struct PatchRpc { + fail: bool, + } + + #[async_trait] + impl ConfigRpc for PatchRpc { + type Controller = BaseController; + + async fn patch_config( + &self, + _: BaseController, + _: PatchConfigRequest, + ) -> easytier_proto::rpc_types::error::Result { + if self.fail { + Err(easytier_proto::rpc_types::error::Error::Shutdown) + } else { + Ok(PatchConfigResponse::default()) + } + } + + async fn get_config( + &self, + _: BaseController, + _: GetConfigRequest, + ) -> easytier_proto::rpc_types::error::Result { + unreachable!() + } + } + + struct ClientManager { + storage: Mutex>, + patch_fails: bool, + } + + #[async_trait] + impl RemoteClientManager<(), SavedConfig, anyhow::Error> for ClientManager { + fn get_rpc_client( + &self, + _: (), + ) -> Option + Send>> { + // The session is unavailable for any read after PatchConfig. + None + } + + fn get_storage(&self) -> &impl Storage<(), SavedConfig, anyhow::Error> { + &self.storage + } + + fn get_config_rpc_client( + &self, + _: (), + ) -> Option + Send>> { + Some(Box::new(PatchRpc { + fail: self.patch_fails, + })) + } + } + + fn saved_config() -> NetworkConfig { + NetworkConfig { + instance_id: Some(Uuid::new_v4().to_string()), + hostname: Some("pending-hostname".to_owned()), + network_secret: Some("network-secret".to_owned()), + networking_method: Some(NetworkingMethod::Standalone as i32), + vpn_portal_config: Some(VpnPortalConfig { + wireguard_listen: "0.0.0.0:51821".to_owned(), + wireguard_private_key: Some( + "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAE=".to_owned(), + ), + ..Default::default() + }), + ..Default::default() + } + } + + fn add_client() -> VpnPortalClientPatch { + VpnPortalClientPatch { + action: ConfigPatchAction::Add as i32, + client: Some(VpnPortalClientConfig { + name: "alice".to_owned(), + virtual_ip: "10.0.0.2/24".to_owned(), + groups: Vec::new(), + }), + } + } + + #[tokio::test] + async fn portal_patch_persists_saved_config_without_a_followup_rpc() { + for source in [ConfigSource::Web, ConfigSource::User] { + let mut expected = saved_config(); + let manager = ClientManager { + storage: Mutex::new(Some(SavedConfig(expected.clone(), source))), + patch_fails: false, + }; + manager + .handle_patch_vpn_portal_clients( + (), + expected.instance_id.as_ref().unwrap().parse().unwrap(), + vec![add_client()], + ) + .await + .unwrap(); + + expected.vpn_portal_config.as_mut().unwrap().clients = + vec![add_client().client.unwrap()]; + let saved = manager.storage.lock().unwrap(); + let saved = saved.as_ref().unwrap(); + assert_eq!(saved.0, expected); + assert_eq!(saved.1, source); + } + } + + #[tokio::test] + async fn portal_patch_failure_preserves_saved_config() { + for source in [ConfigSource::Web, ConfigSource::User] { + let config = saved_config(); + let manager = ClientManager { + storage: Mutex::new(Some(SavedConfig(config.clone(), source))), + patch_fails: true, + }; + let result = manager + .handle_patch_vpn_portal_clients( + (), + config.instance_id.as_ref().unwrap().parse().unwrap(), + vec![add_client()], + ) + .await; + + assert!(matches!(result, Err(RemoteClientError::RpcError(_)))); + let saved = manager.storage.lock().unwrap(); + let saved = saved.as_ref().unwrap(); + assert_eq!(saved.0, config); + assert_eq!(saved.1, source); + } + } + + #[tokio::test] + async fn portal_patch_without_saved_config_requires_runtime_config() { + let manager = ClientManager { + storage: Mutex::new(None), + patch_fails: false, + }; + let result = manager + .handle_patch_vpn_portal_clients((), Uuid::new_v4(), vec![add_client()]) + .await; + + assert!(matches!(result, Err(RemoteClientError::ClientNotFound))); + assert!(manager.storage.lock().unwrap().is_none()); + } +} diff --git a/vendor/easytier/easytier-core/src/management/full/web_client.rs b/vendor/easytier/easytier-core/src/management/full/web_client.rs new file mode 100644 index 0000000..d5a57ce --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/full/web_client.rs @@ -0,0 +1,796 @@ +use std::collections::HashSet; +use std::sync::{ + Arc, Weak, + atomic::{AtomicBool, Ordering}, +}; + +use async_trait::async_trait; +use easytier_proto::{ + rpc_types::controller::BaseController, + web::{ + DeviceOsInfo, GetFeatureRequest, GetFeatureResponse, HeartbeatRequest, HeartbeatResponse, + WebServerServiceClientFactory, + }, +}; +use tokio::{sync::Mutex, task::JoinSet}; +use tokio_util::task::AbortOnDropHandle; +use url::Url; + +use crate::{ + connectivity::protocol::raw::TunnelDialer, + foundation::time, + instance::{CoreInstance, CoreInstanceHost, manager::InstanceFactory}, + rpc::{bidirect::BidirectRpcManager, service_registry::ServiceRegistry}, + tunnel::{Tunnel, web_security}, +}; + +#[cfg(not(feature = "management"))] +use super::register_web_client_rpc; +use super::{ConfigFileStorage, DaemonGuard, InstanceManager, InstanceMutationHooks}; +#[cfg(feature = "management")] +use super::{LoggerControl, register_management_rpc}; + +const RETRY_INTERVAL: std::time::Duration = std::time::Duration::from_secs(1); +// Keep retry ownership in this loop when transport or protocol handshakes stall. +const CONNECT_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(20); +const FEATURE_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(3); +const DEFAULT_HEARTBEAT_INTERVAL_MS: u32 = 3_500; +const DEFAULT_HEARTBEAT_TIMEOUT_MS: u32 = 15_000; +const MIN_HEARTBEAT_INTERVAL_MS: u32 = 1_000; +const MAX_HEARTBEAT_INTERVAL_MS: u32 = 60_000; +const MIN_HEARTBEAT_TIMEOUT_MS: u32 = 5_000; +const MAX_HEARTBEAT_TIMEOUT_MS: u32 = 120_000; +const MIN_HEARTBEAT_TIMEOUT_MARGIN_MS: u32 = 5_000; + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +struct HeartbeatPolicy { + interval: std::time::Duration, + timeout_ms: i32, +} + +impl Default for HeartbeatPolicy { + fn default() -> Self { + Self { + interval: std::time::Duration::from_millis(DEFAULT_HEARTBEAT_INTERVAL_MS.into()), + timeout_ms: DEFAULT_HEARTBEAT_TIMEOUT_MS as i32, + } + } +} + +impl HeartbeatPolicy { + fn from_response(response: &HeartbeatResponse) -> (Self, bool) { + let requested_interval = response + .heartbeat_interval_ms + .unwrap_or(DEFAULT_HEARTBEAT_INTERVAL_MS); + let requested_timeout = response + .heartbeat_timeout_ms + .unwrap_or(DEFAULT_HEARTBEAT_TIMEOUT_MS); + let interval_ms = + requested_interval.clamp(MIN_HEARTBEAT_INTERVAL_MS, MAX_HEARTBEAT_INTERVAL_MS); + let timeout_ms = requested_timeout + .clamp(MIN_HEARTBEAT_TIMEOUT_MS, MAX_HEARTBEAT_TIMEOUT_MS) + .max(interval_ms.saturating_add(MIN_HEARTBEAT_TIMEOUT_MARGIN_MS)); + ( + Self { + interval: std::time::Duration::from_millis(interval_ms.into()), + timeout_ms: timeout_ms as i32, + }, + interval_ms != requested_interval || timeout_ms != requested_timeout, + ) + } + + fn controller(self) -> BaseController { + BaseController { + timeout_ms: self.timeout_ms, + ..Default::default() + } + } + + fn remaining_interval(self, elapsed: std::time::Duration) -> Option { + self.interval + .checked_sub(elapsed) + .filter(|delay| !delay.is_zero()) + } +} + +async fn connect_config_server( + connector: &dyn TunnelDialer, + timeout: std::time::Duration, +) -> anyhow::Result> { + time::timeout(timeout, connector.connect()) + .await + .map_err(|_| anyhow::anyhow!("config-server connection timed out after {timeout:?}"))? +} + +/// Normalized config-server endpoint and authentication token. +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct ConfigServerEndpoint { + connect_url: Url, + token: String, +} + +impl ConfigServerEndpoint { + pub fn parse(input: &str, supports_scheme: impl FnOnce(&Url) -> bool) -> anyhow::Result { + let endpoint = Url::parse(input) + .map_err(|error| anyhow::anyhow!("failed to parse config server URL: {error}"))?; + if !supports_scheme(&endpoint) { + anyhow::bail!("unsupported config server scheme: {}", endpoint.scheme()); + } + + let token = endpoint + .path_segments() + .and_then(|mut segments| segments.next_back()) + .map(|segment| percent_encoding::percent_decode_str(segment).decode_utf8()) + .transpose() + .map_err(|error| anyhow::anyhow!("failed to decode config server token: {error}"))? + .map(|token| token.to_string()) + .unwrap_or_default(); + if token.is_empty() { + anyhow::bail!("empty token"); + } + + let mut connect_url = endpoint; + if !matches!(connect_url.scheme(), "ws" | "wss") { + connect_url.set_path(""); + } + Ok(Self { connect_url, token }) + } + + pub fn connect_url(&self) -> &Url { + &self.connect_url + } + + pub fn token(&self) -> &str { + &self.token + } +} + +pub struct WebClientConfig { + pub token: String, + pub machine_id: uuid::Uuid, + pub hostname: String, + pub device_os: DeviceOsInfo, + pub easytier_version: String, + pub secure_mode: bool, +} + +#[async_trait] +pub(crate) trait WebClientBackend: Send + Sync + 'static { + fn register(&self, registry: &ServiceRegistry); + + async fn instance_ids(&self) -> anyhow::Result>; + + fn failed_instance_ids(&self) -> Vec; + + fn instance_state_generation(&self) -> usize { + 0 + } + + async fn wait_for_instance_state_change(&self, _generation: usize) -> usize { + std::future::pending().await + } +} + +struct NativeWebClientBackend +where + F: InstanceFactory, +{ + instances: Arc>, + hooks: Arc, + storage: Arc, + #[cfg(feature = "management")] + logger: Arc, +} + +#[async_trait] +impl WebClientBackend for NativeWebClientBackend +where + F: InstanceFactory, CreateContext = ()>, + F::Error: std::fmt::Debug + std::fmt::Display + Send + Sync + 'static, + H: CoreInstanceHost, +{ + fn register(&self, registry: &ServiceRegistry) { + #[cfg(feature = "management")] + register_management_rpc( + self.instances.clone(), + registry, + self.hooks.clone(), + self.storage.clone(), + self.logger.clone(), + ); + #[cfg(not(feature = "management"))] + register_web_client_rpc( + self.instances.clone(), + registry, + self.hooks.clone(), + self.storage.clone(), + ); + } + + async fn instance_ids(&self) -> anyhow::Result> { + Ok(self.instances.instance_ids()) + } + + fn failed_instance_ids(&self) -> Vec { + self.instances.failed_instance_ids() + } + + fn instance_state_generation(&self) -> usize { + self.instances.instance_state_generation() + } + + async fn wait_for_instance_state_change(&self, generation: usize) -> usize { + self.instances + .wait_for_instance_state_change(generation) + .await + } +} + +struct WebClientController { + config: WebClientConfig, + backend: Arc, + runtime_id: uuid::Uuid, +} + +/// Portable config-server client. Hosts only supply identity and adapters. +pub struct WebClient { + _controller: Arc, + _tasks: AbortOnDropHandle<()>, + _manager_guard: Option, + connected: Arc, + _factory: std::marker::PhantomData, +} + +impl WebClient +where + F: InstanceFactory, CreateContext = ()>, + F::Error: std::fmt::Debug + std::fmt::Display + Send + Sync + 'static, + H: CoreInstanceHost, +{ + pub fn new( + connector: T, + config: WebClientConfig, + instances: Arc>, + hooks: Arc, + storage: Arc, + #[cfg(feature = "management")] logger: Arc, + ) -> Self { + let manager_guard = instances.register_daemon(); + let backend = Arc::new(NativeWebClientBackend { + instances, + hooks, + storage, + #[cfg(feature = "management")] + logger, + }); + Self::start(connector, config, backend, Some(manager_guard)) + } +} + +#[cfg(target_os = "wasi")] +impl WebClient<()> { + pub(crate) fn with_backend( + connector: T, + config: WebClientConfig, + backend: Arc, + ) -> Self { + Self::start(connector, config, backend, None) + } +} + +impl WebClient { + fn start( + connector: T, + config: WebClientConfig, + backend: Arc, + manager_guard: Option, + ) -> Self { + let controller = Arc::new(WebClientController { + config, + backend, + runtime_id: uuid::Uuid::new_v4(), + }); + let connected = Arc::new(AtomicBool::new(false)); + let tasks = AbortOnDropHandle::new(tokio::spawn(web_client_routine( + controller.clone(), + connected.clone(), + Box::new(connector), + ))); + + Self { + _controller: controller, + _tasks: tasks, + _manager_guard: manager_guard, + connected, + _factory: std::marker::PhantomData, + } + } + + pub fn is_connected(&self) -> bool { + self.connected.load(Ordering::Acquire) + } +} + +async fn web_client_routine( + controller: Arc, + connected: Arc, + connector: Box, +) { + loop { + let connection = match connect_config_server(connector.as_ref(), CONNECT_TIMEOUT).await { + Ok(connection) => connection, + Err(error) => { + tracing::warn!(%error, "failed to connect to config server; retrying"); + time::sleep(RETRY_INTERVAL).await; + continue; + } + }; + + connected.store(true, Ordering::Release); + tracing::info!(?connection, "connected to config server"); + let mut session = WebClientSession::new(connection, controller.clone()); + let support_encryption = match time::timeout(FEATURE_TIMEOUT, session.get_feature()).await { + Ok(Ok(feature)) => feature.support_encryption, + Ok(Err(error)) => { + tracing::warn!(%error, "GetFeature RPC failed; using legacy tunnel"); + false + } + Err(_) => { + tracing::warn!("GetFeature RPC timed out; using legacy tunnel"); + false + } + }; + + if support_encryption && web_security::web_secure_tunnel_supported() { + drop(session); + let connection = match connect_config_server(connector.as_ref(), CONNECT_TIMEOUT).await + { + Ok(connection) => connection, + Err(error) => { + connected.store(false, Ordering::Release); + tracing::warn!(%error, "failed to reconnect secure config-server tunnel"); + time::sleep(RETRY_INTERVAL).await; + continue; + } + }; + let connection = match web_security::upgrade_client_tunnel(connection).await { + Ok(connection) => connection, + Err(error) => { + connected.store(false, Ordering::Release); + tracing::warn!(%error, "config-server secure handshake failed"); + time::sleep(RETRY_INTERVAL).await; + continue; + } + }; + let mut session = WebClientSession::new(connection, controller.clone()); + session.start_heartbeat().await; + session.wait().await; + connected.store(false, Ordering::Release); + continue; + } + + if support_encryption { + if controller.config.secure_mode { + connected.store(false, Ordering::Release); + tracing::warn!("secure mode requires web secure-tunnel support in the local build"); + time::sleep(RETRY_INTERVAL).await; + continue; + } + tracing::warn!( + "server supports encryption but the local build is using a legacy tunnel" + ); + } + if controller.config.secure_mode { + connected.store(false, Ordering::Release); + tracing::warn!("secure mode requires config-server encryption support"); + time::sleep(RETRY_INTERVAL).await; + continue; + } + + session.start_heartbeat().await; + session.wait().await; + connected.store(false, Ordering::Release); + } +} + +struct WebClientSession { + rpc: BidirectRpcManager, + controller: Arc, + heartbeat_started: AtomicBool, + tasks: Mutex>, +} + +fn running_instances_for_heartbeat( + instance_ids: Vec, + failed_instance_ids: &[uuid::Uuid], +) -> Vec { + let failed_instance_ids: HashSet<_> = failed_instance_ids.iter().copied().collect(); + instance_ids + .into_iter() + .filter(|instance_id| !failed_instance_ids.contains(instance_id)) + .collect() +} + +fn build_heartbeat_request( + config: &WebClientConfig, + runtime_id: uuid::Uuid, + running_network_instances: Vec, + failed_network_instances: Vec, +) -> HeartbeatRequest { + HeartbeatRequest { + machine_id: Some(config.machine_id.into()), + inst_id: Some(runtime_id.into()), + user_token: config.token.clone(), + easytier_version: config.easytier_version.clone(), + hostname: config.hostname.clone(), + report_time: chrono::Local::now().to_rfc3339(), + device_os: Some(config.device_os.clone()), + support_config_source: true, + running_network_instances: running_network_instances + .into_iter() + .map(Into::into) + .collect(), + failed_network_instances: failed_network_instances + .into_iter() + .map(Into::into) + .collect(), + support_heartbeat_policy: true, + } +} + +async fn wait_for_next_heartbeat( + backend: &dyn WebClientBackend, + observed_generation: usize, + policy: HeartbeatPolicy, + elapsed: std::time::Duration, +) { + let Some(delay) = policy.remaining_interval(elapsed) else { + return; + }; + tokio::select! { + _ = time::sleep(delay) => {} + _ = backend.wait_for_instance_state_change(observed_generation) => {} + } +} + +impl WebClientSession { + fn new(tunnel: Box, controller: Arc) -> Self { + let rpc = BidirectRpcManager::new(); + rpc.run_with_tunnel(tunnel); + controller.backend.register(rpc.rpc_server().registry()); + Self { + rpc, + controller, + heartbeat_started: AtomicBool::new(false), + tasks: Mutex::new(JoinSet::new()), + } + } + + pub async fn start_heartbeat(&self) { + if self.heartbeat_started.swap(true, Ordering::AcqRel) { + return; + } + let mut tasks = self.tasks.lock().await; + Self::heartbeat_routine(&self.rpc, Arc::downgrade(&self.controller), &mut tasks); + } + + fn heartbeat_routine( + rpc: &BidirectRpcManager, + controller: Weak, + tasks: &mut JoinSet<()>, + ) { + let controller = controller.upgrade().expect("web client controller"); + let controller = Arc::downgrade(&controller); + let client = rpc + .rpc_client() + .scoped_client::>(1, 1, String::new()); + + tasks.spawn(async move { + let mut heartbeat_policy = HeartbeatPolicy::default(); + loop { + let heartbeat_started_at = std::time::Instant::now(); + let Some(controller) = controller.upgrade() else { + break; + }; + let observed_generation = controller.backend.instance_state_generation(); + let failed_network_instances = controller.backend.failed_instance_ids(); + let running_network_instances = match controller.backend.instance_ids().await { + Ok(instance_ids) => { + running_instances_for_heartbeat(instance_ids, &failed_network_instances) + } + Err(error) => { + tracing::error!(%error, "failed to list config-server instances"); + break; + } + }; + let request = build_heartbeat_request( + &controller.config, + controller.runtime_id, + running_network_instances, + failed_network_instances, + ); + + match client + .heartbeat(heartbeat_policy.controller(), request) + .await + { + Ok(response) => { + tracing::debug!(?response, "config-server heartbeat response"); + let (next_policy, adjusted) = HeartbeatPolicy::from_response(&response); + if adjusted { + tracing::warn!( + requested_interval_ms = ?response.heartbeat_interval_ms, + requested_timeout_ms = ?response.heartbeat_timeout_ms, + applied_interval_ms = next_policy.interval.as_millis(), + applied_timeout_ms = next_policy.timeout_ms, + "config-server heartbeat policy was outside safe bounds" + ); + } + heartbeat_policy = next_policy; + wait_for_next_heartbeat( + controller.backend.as_ref(), + observed_generation, + heartbeat_policy, + heartbeat_started_at.elapsed(), + ) + .await; + } + Err(error) => { + tracing::error!(?error, "config-server heartbeat failed"); + break; + } + } + } + }); + } + + async fn wait_routines(&self) { + self.tasks.lock().await.join_next().await; + self.tasks.lock().await.abort_all(); + } + + async fn wait(&mut self) { + tokio::select! { + _ = self.rpc.wait() => {} + _ = self.wait_routines() => {} + } + } + + async fn get_feature( + &self, + ) -> Result { + let client = self + .rpc + .rpc_client() + .scoped_client::>(1, 1, String::new()); + client + .get_feature(BaseController::default(), GetFeatureRequest {}) + .await + } +} + +#[cfg(test)] +mod tests { + use std::{ + future::pending, + sync::atomic::{AtomicUsize, Ordering}, + }; + + use async_trait::async_trait; + + use super::*; + use crate::tunnel::ring::create_ring_tunnel_pair; + + struct StalledThenReadyDialer { + attempts: AtomicUsize, + } + + struct ImmediateStateChangeBackend; + + #[async_trait] + impl WebClientBackend for ImmediateStateChangeBackend { + fn register(&self, _registry: &ServiceRegistry) {} + + async fn instance_ids(&self) -> anyhow::Result> { + Ok(Vec::new()) + } + + fn failed_instance_ids(&self) -> Vec { + Vec::new() + } + + async fn wait_for_instance_state_change(&self, generation: usize) -> usize { + generation.wrapping_add(1) + } + } + + #[async_trait] + impl TunnelDialer for StalledThenReadyDialer { + async fn connect(&self) -> anyhow::Result> { + if self.attempts.fetch_add(1, Ordering::Relaxed) == 0 { + return pending().await; + } + + let (tunnel, _peer) = create_ring_tunnel_pair(); + Ok(tunnel) + } + + fn remote_url(&self) -> Url { + "ring://config-server".parse().unwrap() + } + } + + #[test] + fn heartbeat_hides_failed_instances_from_the_running_list() { + let running = uuid::Uuid::new_v4(); + let failed = uuid::Uuid::new_v4(); + let stopped_clean = uuid::Uuid::new_v4(); + let instance_ids = vec![running, failed, stopped_clean]; + let failed_instance_ids = vec![failed]; + + let reported = running_instances_for_heartbeat(instance_ids.clone(), &failed_instance_ids); + + assert_eq!(reported, vec![running, stopped_clean]); + assert!(running_instances_for_heartbeat(instance_ids, &[]).len() == 3); + } + + #[tokio::test] + async fn stalled_connection_attempt_times_out_and_allows_redial() { + let connector = StalledThenReadyDialer { + attempts: AtomicUsize::new(0), + }; + + let error = connect_config_server(&connector, std::time::Duration::from_millis(10)) + .await + .unwrap_err(); + assert!(error.to_string().contains("connection timed out")); + + connect_config_server(&connector, std::time::Duration::from_secs(1)) + .await + .unwrap(); + assert_eq!(connector.attempts.load(Ordering::Relaxed), 2); + } + + #[tokio::test] + async fn instance_state_change_interrupts_a_long_heartbeat_interval() { + let policy = HeartbeatPolicy { + interval: std::time::Duration::from_secs(60), + timeout_ms: 65_000, + }; + + tokio::time::timeout( + std::time::Duration::from_secs(1), + wait_for_next_heartbeat( + &ImmediateStateChangeBackend, + 0, + policy, + std::time::Duration::ZERO, + ), + ) + .await + .expect("instance state change must wake heartbeat before its interval"); + } + + #[test] + fn endpoint_normalizes_non_websocket_paths() { + let endpoint = + ConfigServerEndpoint::parse("udp://example.com/team%2Ftoken", |_| true).unwrap(); + assert_eq!(endpoint.token(), "team/token"); + assert_eq!(endpoint.connect_url().as_str(), "udp://example.com"); + } + + #[test] + fn endpoint_rejects_token_shorthand() { + let error = ConfigServerEndpoint::parse("team%2Ftoken", |_| true).unwrap_err(); + assert!( + error + .to_string() + .contains("failed to parse config server URL") + ); + } + + #[test] + fn endpoint_preserves_websocket_path_and_validates_scheme() { + let endpoint = + ConfigServerEndpoint::parse("wss://example.com/team", |url| url.scheme() == "wss") + .unwrap(); + assert_eq!(endpoint.token(), "team"); + assert_eq!(endpoint.connect_url().as_str(), "wss://example.com/team"); + + let error = + ConfigServerEndpoint::parse("unknown://example.com/team", |_| false).unwrap_err(); + assert!( + error + .to_string() + .contains("unsupported config server scheme") + ); + } + + #[test] + fn endpoint_rejects_an_empty_token() { + assert!(ConfigServerEndpoint::parse("udp://example.com", |_| true).is_err()); + } + + #[test] + fn heartbeat_request_carries_registered_and_failed_instance_ids() { + let runtime_id = uuid::Uuid::new_v4(); + let registered = uuid::Uuid::new_v4(); + let failed = uuid::Uuid::new_v4(); + let request = build_heartbeat_request( + &WebClientConfig { + token: "token".to_owned(), + machine_id: uuid::Uuid::new_v4(), + hostname: "host".to_owned(), + device_os: DeviceOsInfo::default(), + easytier_version: "test-version".to_owned(), + secure_mode: false, + }, + runtime_id, + vec![registered], + vec![failed], + ); + + assert_eq!(request.inst_id.map(uuid::Uuid::from), Some(runtime_id)); + assert_eq!( + request + .running_network_instances + .into_iter() + .map(uuid::Uuid::from) + .collect::>(), + vec![registered] + ); + assert_eq!( + request + .failed_network_instances + .into_iter() + .map(uuid::Uuid::from) + .collect::>(), + vec![failed] + ); + assert!(request.support_heartbeat_policy); + } + + #[test] + fn heartbeat_policy_uses_safe_defaults_for_legacy_servers() { + let (policy, adjusted) = HeartbeatPolicy::from_response(&HeartbeatResponse::default()); + + assert!(!adjusted); + assert_eq!( + policy.interval, + std::time::Duration::from_millis(DEFAULT_HEARTBEAT_INTERVAL_MS.into()) + ); + assert_eq!(policy.timeout_ms, DEFAULT_HEARTBEAT_TIMEOUT_MS as i32); + } + + #[test] + fn heartbeat_policy_clamps_server_values_and_preserves_timeout_margin() { + let (minimum, adjusted) = HeartbeatPolicy::from_response(&HeartbeatResponse { + heartbeat_interval_ms: Some(1), + heartbeat_timeout_ms: Some(1), + }); + assert!(adjusted); + assert_eq!( + minimum.interval, + std::time::Duration::from_millis(MIN_HEARTBEAT_INTERVAL_MS.into()) + ); + assert_eq!(minimum.timeout_ms, 6_000); + + let (maximum, adjusted) = HeartbeatPolicy::from_response(&HeartbeatResponse { + heartbeat_interval_ms: Some(u32::MAX), + heartbeat_timeout_ms: Some(u32::MAX), + }); + assert!(adjusted); + assert_eq!( + maximum.interval, + std::time::Duration::from_millis(MAX_HEARTBEAT_INTERVAL_MS.into()) + ); + assert_eq!(maximum.timeout_ms, MAX_HEARTBEAT_TIMEOUT_MS as i32); + + let (margin, adjusted) = HeartbeatPolicy::from_response(&HeartbeatResponse { + heartbeat_interval_ms: Some(60_000), + heartbeat_timeout_ms: Some(5_000), + }); + assert!(adjusted); + assert_eq!(margin.timeout_ms, 65_000); + } +} diff --git a/vendor/easytier/easytier-core/src/management/instance_rpc/config.rs b/vendor/easytier/easytier-core/src/management/instance_rpc/config.rs new file mode 100644 index 0000000..6cc6057 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/instance_rpc/config.rs @@ -0,0 +1,48 @@ +use easytier_proto::{ + api::config::{ + ConfigRpc, GetConfigRequest, GetConfigResponse, PatchConfigRequest, PatchConfigResponse, + }, + rpc_types::{self, controller::BaseController}, +}; + +use crate::{ + config::{api::network_config_from_toml, toml::ConfigLoader as _}, + management::apply_config_patch, +}; + +use super::{ReadOnlyInstanceResolver, ResolvedInstanceManagementRpc}; + +#[async_trait::async_trait] +impl ConfigRpc for ResolvedInstanceManagementRpc +where + R: ReadOnlyInstanceResolver, +{ + type Controller = BaseController; + + async fn patch_config( + &self, + _: BaseController, + request: PatchConfigRequest, + ) -> rpc_types::error::Result { + let instance = self.instance(request.instance.as_ref())?; + if let Some(patch) = request.patch { + apply_config_patch(&instance, patch, self.config_patch_persistence.as_deref()).await?; + } + Ok(PatchConfigResponse::default()) + } + + async fn get_config( + &self, + _: BaseController, + request: GetConfigRequest, + ) -> rpc_types::error::Result { + let config = self + .instance(request.instance.as_ref())? + .toml_config() + .ok_or_else(|| anyhow::anyhow!("shared TOML configuration is not available"))?; + Ok(GetConfigResponse { + config: Some(network_config_from_toml(&config)), + toml_config: config.dump(), + }) + } +} diff --git a/vendor/easytier/easytier-core/src/management/instance_rpc/full.rs b/vendor/easytier/easytier-core/src/management/instance_rpc/full.rs new file mode 100644 index 0000000..7b698e5 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/instance_rpc/full.rs @@ -0,0 +1,494 @@ +use std::{sync::Arc, time::Duration}; + +use easytier_proto::{ + api::{ + config::ConfigRpc, + instance::{ + AclManageRpc, ConnectorManageRpc, CredentialInfo, CredentialManageRpc, + GenerateCredentialRequest, GenerateCredentialResponse, GetAclStatsRequest, + GetAclStatsResponse, GetPrometheusStatsRequest, GetPrometheusStatsResponse, + GetStatsRequest, GetStatsResponse, GetVpnPortalInfoRequest, GetVpnPortalInfoResponse, + GetWhitelistRequest, GetWhitelistResponse, ListCredentialsRequest, + ListCredentialsResponse, ListMappedListenerRequest, ListMappedListenerResponse, + ListPortForwardRequest, ListPortForwardResponse, MappedListener, + MappedListenerManageRpc, MetricSnapshot, PeerManageRpc, PortForwardManageRpc, + RevokeCredentialRequest, RevokeCredentialResponse, StatsRpc, UpsertCredentialRequest, + UpsertCredentialResponse, VpnPortalClientInfo, VpnPortalClientState, VpnPortalInfo, + VpnPortalRpc, + }, + }, + common::PortForwardConfigPb, + peer_rpc::{ + GetGlobalPeerMapRequest, GetGlobalPeerMapResponse, PeerCenterRpc, ReportPeersRequest, + ReportPeersResponse, + }, + rpc_types::{self, controller::BaseController}, +}; + +use crate::{ + config::toml::ConfigLoader as _, + gateway::vpn_portal::{PortalClientState, PortalInfoSnapshot}, + instance::{ + CoreInstance, CoreInstanceHost, + manager::{InstanceFactory, InstanceManager}, + }, + peers::credential_manager::{ + CredentialCreateOptions, CredentialInfo as CoreCredentialInfo, CredentialUpsertOptions, + }, +}; + +use super::InstanceManagementRpc; +use crate::management::{full::packet_proxy, resolve_instance}; + +/// Dispatches the JSON form of an Instance-targeted management RPC without +/// introducing a second, Host-owned set of service implementations. +pub async fn call_instance_json_rpc( + manager: &Arc>, + service_name: &str, + method_name: &str, + domain_name: Option<&str>, + payload: serde_json::Value, +) -> rpc_types::error::Result +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + let payload = + match packet_proxy::call_json(manager, service_name, method_name, domain_name, payload) + .await + { + Ok(response) => return response, + Err(payload) => payload, + }; + let ctrl = BaseController::default(); + let rpc = InstanceManagementRpc::::new(manager.clone()); + + match service_name { + "api.instance.PeerManageRpcService" => { + PeerManageRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + "api.instance.PeerCenterManageRpcService" => { + PeerCenterRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + "api.instance.ConnectorManageRpcService" => { + ConnectorManageRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + "api.instance.MappedListenerManageRpcService" => { + MappedListenerManageRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + "api.instance.VpnPortalRpcService" => { + VpnPortalRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + "api.instance.AclManageRpcService" => { + AclManageRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + "api.instance.PortForwardManageRpcService" => { + PortForwardManageRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + "api.instance.StatsRpcService" => { + StatsRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + "api.instance.CredentialManageRpcService" => { + CredentialManageRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + "api.config.ConfigRpcService" => { + ConfigRpc::json_call_method(&rpc, ctrl, method_name, payload).await + } + _ => Err(rpc_types::error::Error::InvalidServiceKey( + service_name.to_owned(), + service_name.to_owned(), + )), + } +} + +fn credential_info_to_api(info: CoreCredentialInfo) -> CredentialInfo { + CredentialInfo { + credential_id: info.credential_id, + groups: info.groups, + allow_relay: info.allow_relay, + expiry_unix: info.expiry_unix, + allowed_proxy_cidrs: info.allowed_proxy_cidrs, + reusable: info.reusable, + public_key_fingerprint: info.public_key_fingerprint, + } +} + +#[async_trait::async_trait] +impl MappedListenerManageRpc for InstanceManagementRpc +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + type Controller = BaseController; + + async fn list_mapped_listener( + &self, + _: BaseController, + request: ListMappedListenerRequest, + ) -> rpc_types::error::Result { + let config = self + .instance(request.instance.as_ref())? + .toml_config() + .ok_or_else(|| anyhow::anyhow!("shared TOML configuration is not available"))?; + Ok(ListMappedListenerResponse { + mappedlisteners: config + .get_mapped_listeners() + .into_iter() + .map(|url| MappedListener { + url: Some(url.into()), + }) + .collect(), + }) + } +} + +fn vpn_portal_info_to_proto(info: PortalInfoSnapshot) -> VpnPortalInfo { + let client_config = info + .clients + .first() + .map(|client| client.client_config.clone()) + .unwrap_or_default(); + let connected_clients = info + .clients + .iter() + .filter(|client| client.state == PortalClientState::Online) + .filter_map(|client| client.endpoint.clone()) + .collect(); + #[allow(deprecated)] + VpnPortalInfo { + vpn_type: info.vpn_type, + client_config, + connected_clients, + clients: info + .clients + .into_iter() + .map(|client| VpnPortalClientInfo { + name: client.name, + virtual_ip: client.virtual_ip.to_string(), + groups: client.groups, + state: match client.state { + PortalClientState::Offline => VpnPortalClientState::Offline as i32, + PortalClientState::Connecting => VpnPortalClientState::Connecting as i32, + PortalClientState::Online => VpnPortalClientState::Online as i32, + PortalClientState::Error => VpnPortalClientState::Error as i32, + }, + peer_id: client.peer_id, + endpoint: client.endpoint, + tunnel_ip: client.tunnel_ip.map(|address| address.to_string()), + client_config: client.client_config, + error: client.error, + }) + .collect(), + listener: info.listener, + } +} + +#[async_trait::async_trait] +impl VpnPortalRpc for InstanceManagementRpc +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + type Controller = BaseController; + + async fn get_vpn_portal_info( + &self, + _: BaseController, + request: GetVpnPortalInfoRequest, + ) -> rpc_types::error::Result { + let info = self + .instance(request.instance.as_ref())? + .vpn_portal_info() + .await; + Ok(GetVpnPortalInfoResponse { + vpn_portal_info: Some(vpn_portal_info_to_proto(info)), + }) + } +} + +#[async_trait::async_trait] +impl AclManageRpc for InstanceManagementRpc +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + type Controller = BaseController; + + async fn get_acl_stats( + &self, + _: BaseController, + request: GetAclStatsRequest, + ) -> rpc_types::error::Result { + Ok(GetAclStatsResponse { + acl_stats: Some(self.instance(request.instance.as_ref())?.acl_stats()), + }) + } + + async fn get_whitelist( + &self, + _: BaseController, + request: GetWhitelistRequest, + ) -> rpc_types::error::Result { + let whitelist = self + .instance(request.instance.as_ref())? + .acl_whitelist_snapshot(); + Ok(GetWhitelistResponse { + tcp_ports: whitelist.tcp_ports, + udp_ports: whitelist.udp_ports, + }) + } +} + +#[async_trait::async_trait] +impl PortForwardManageRpc for InstanceManagementRpc +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + type Controller = BaseController; + + async fn list_port_forward( + &self, + _: BaseController, + request: ListPortForwardRequest, + ) -> rpc_types::error::Result { + let config = self + .instance(request.instance.as_ref())? + .toml_config() + .ok_or_else(|| anyhow::anyhow!("shared TOML configuration is not available"))?; + Ok(ListPortForwardResponse { + cfgs: config + .get_port_forwards() + .into_iter() + .map(PortForwardConfigPb::from) + .collect(), + }) + } +} + +#[async_trait::async_trait] +impl StatsRpc for InstanceManagementRpc +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + type Controller = BaseController; + + async fn get_stats( + &self, + _: BaseController, + request: GetStatsRequest, + ) -> rpc_types::error::Result { + Ok(GetStatsResponse { + metrics: self + .instance(request.instance.as_ref())? + .metric_snapshots() + .into_iter() + .map(|snapshot| MetricSnapshot { + name: snapshot.name_str(), + value: snapshot.value, + labels: snapshot + .labels + .labels() + .iter() + .map(|label| (label.key.clone(), label.value.clone())) + .collect(), + }) + .collect(), + }) + } + + async fn get_prometheus_stats( + &self, + _: BaseController, + request: GetPrometheusStatsRequest, + ) -> rpc_types::error::Result { + Ok(GetPrometheusStatsResponse { + prometheus_text: self + .instance(request.instance.as_ref())? + .prometheus_metrics(), + }) + } +} + +#[async_trait::async_trait] +impl CredentialManageRpc for InstanceManagementRpc +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + type Controller = BaseController; + + async fn generate_credential( + &self, + _: BaseController, + request: GenerateCredentialRequest, + ) -> rpc_types::error::Result { + if request.ttl_seconds <= 0 { + return Err(anyhow::anyhow!("ttl_seconds must be positive").into()); + } + let generated = self + .instance(request.instance.as_ref())? + .generate_credential(CredentialCreateOptions { + groups: request.groups, + allow_relay: request.allow_relay, + allowed_proxy_cidrs: request.allowed_proxy_cidrs, + ttl: Duration::from_secs(request.ttl_seconds as u64), + credential_id: request.credential_id, + reusable: request.reusable.unwrap_or(true), + })?; + Ok(GenerateCredentialResponse { + credential_id: generated.credential_id, + credential_secret: generated.secret, + expiry_unix: generated.expiry_unix, + }) + } + + async fn upsert_credential( + &self, + _: BaseController, + request: UpsertCredentialRequest, + ) -> rpc_types::error::Result { + let changed = self + .instance(request.instance.as_ref())? + .upsert_credential(CredentialUpsertOptions { + credential_id: request.credential_id, + credential_secret: request.credential_secret, + groups: request.groups, + allow_relay: request.allow_relay, + allowed_proxy_cidrs: request.allowed_proxy_cidrs, + expiry_unix: request.expiry_unix, + reusable: request.reusable.unwrap_or(true), + })?; + Ok(UpsertCredentialResponse { changed }) + } + + async fn revoke_credential( + &self, + _: BaseController, + request: RevokeCredentialRequest, + ) -> rpc_types::error::Result { + Ok(RevokeCredentialResponse { + success: self + .instance(request.instance.as_ref())? + .revoke_credential(&request.credential_id)?, + }) + } + + async fn list_credentials( + &self, + _: BaseController, + request: ListCredentialsRequest, + ) -> rpc_types::error::Result { + Ok(ListCredentialsResponse { + credentials: self + .instance(request.instance.as_ref())? + .credential_snapshots() + .into_iter() + .map(credential_info_to_api) + .collect(), + }) + } +} + +#[async_trait::async_trait] +impl PeerCenterRpc for InstanceManagementRpc +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + type Controller = BaseController; + + async fn get_global_peer_map( + &self, + _: BaseController, + _: GetGlobalPeerMapRequest, + ) -> rpc_types::error::Result { + let instance = resolve_instance(self.manager(), None).map_err(|error| { + if error.to_string().contains("please specify the instance ID") { + anyhow::anyhow!( + "PeerCenter management RPC cannot select an instance automatically when \ + multiple instances are running; please use an API that allows specifying \ + an instance identifier." + ) + } else { + error + } + })?; + Ok(instance.global_peer_map_snapshot()) + } + + async fn report_peers( + &self, + _: BaseController, + _: ReportPeersRequest, + ) -> rpc_types::error::Result { + Err(anyhow::anyhow!("not implemented for management API").into()) + } +} + +#[cfg(test)] +mod tests { + use std::net::Ipv4Addr; + + use super::*; + use crate::gateway::vpn_portal::PortalClientInfoSnapshot; + + #[test] + #[allow(deprecated)] + fn vpn_portal_info_to_proto_preserves_per_client_status() { + let info = vpn_portal_info_to_proto(PortalInfoSnapshot { + vpn_type: "wireguard".to_owned(), + clients: vec![ + PortalClientInfoSnapshot { + name: "alice".to_owned(), + virtual_ip: Ipv4Addr::new(10, 82, 0, 2), + groups: vec!["ops".to_owned()], + state: PortalClientState::Online, + peer_id: Some(42), + endpoint: Some("198.51.100.2:51820".to_owned()), + tunnel_ip: Some(Ipv4Addr::new(10, 82, 0, 2)), + client_config: "[Interface]\nPrivateKey = secret\n".to_owned(), + error: None, + }, + PortalClientInfoSnapshot { + name: "bob".to_owned(), + virtual_ip: Ipv4Addr::new(10, 82, 0, 3), + groups: vec!["guests".to_owned()], + state: PortalClientState::Error, + peer_id: None, + endpoint: None, + tunnel_ip: None, + client_config: String::new(), + error: Some("activation failed".to_owned()), + }, + ], + listener: Some("udp://0.0.0.0:51820".to_owned()), + }); + + assert_eq!(info.vpn_type, "wireguard"); + assert_eq!(info.listener.as_deref(), Some("udp://0.0.0.0:51820")); + assert_eq!(info.client_config, "[Interface]\nPrivateKey = secret\n"); + assert_eq!(info.connected_clients, ["198.51.100.2:51820"]); + assert_eq!(info.clients.len(), 2); + + let online = &info.clients[0]; + assert_eq!(online.name, "alice"); + assert_eq!(online.virtual_ip, "10.82.0.2"); + assert_eq!(online.groups, ["ops"]); + assert_eq!(online.state, VpnPortalClientState::Online as i32); + assert_eq!(online.peer_id, Some(42)); + assert_eq!(online.endpoint.as_deref(), Some("198.51.100.2:51820")); + assert_eq!(online.tunnel_ip.as_deref(), Some("10.82.0.2")); + assert_eq!(online.client_config, "[Interface]\nPrivateKey = secret\n"); + assert_eq!(online.error, None); + + let failed = &info.clients[1]; + assert_eq!(failed.name, "bob"); + assert_eq!(failed.state, VpnPortalClientState::Error as i32); + assert_eq!(failed.peer_id, None); + assert_eq!(failed.endpoint, None); + assert_eq!(failed.tunnel_ip, None); + assert_eq!(failed.error.as_deref(), Some("activation failed")); + } +} diff --git a/vendor/easytier/easytier-core/src/management/instance_rpc/mod.rs b/vendor/easytier/easytier-core/src/management/instance_rpc/mod.rs new file mode 100644 index 0000000..20b360b --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/instance_rpc/mod.rs @@ -0,0 +1,667 @@ +use std::sync::Arc; + +use easytier_proto::{ + api::instance::{ + Connector, ConnectorManageRpc, ConnectorStatus, DumpRouteRequest, DumpRouteResponse, + ForeignNetworkEntryPb, GetForeignNetworkSummaryRequest, GetForeignNetworkSummaryResponse, + ListConnectorRequest, ListConnectorResponse, ListForeignNetworkRequest, + ListForeignNetworkResponse, ListGlobalForeignNetworkRequest, + ListGlobalForeignNetworkResponse, ListPeerRequest, ListPeerResponse, + ListPublicIpv6InfoRequest, ListPublicIpv6InfoResponse, ListRouteRequest, ListRouteResponse, + NodeInfo, PeerInfo, PeerManageRpc, ShowNodeInfoRequest, ShowNodeInfoResponse, + TrustedKeyInfoPb, TrustedKeySourcePb, + list_global_foreign_network_response::OneForeignNetwork, + }, + rpc_types::{self, controller::BaseController}, +}; + +use crate::{ + config::{ + IpPrefix, ProxyNetworkConfig, + toml::{ConfigLoader as _, TomlConfig}, + }, + connectivity::manual::{ManualConnectorSnapshot, ManualConnectorStatus}, + instance::{ + CoreInstance, CoreInstanceHost, + manager::{InstanceFactory, InstanceManager}, + }, + peers::{context::TrustedKeySource, foreign_network::ForeignNetworkEntryInfo}, +}; + +use super::resolve_instance; +#[cfg(feature = "web-client")] +use super::{ConfigFileStorage, ConfigPatchPersistence}; + +#[cfg(feature = "web-client")] +mod config; +#[cfg(feature = "management")] +pub(super) mod full; +#[cfg(all(feature = "management", feature = "proxy-packet"))] +pub(super) mod packet_proxy; +mod projection; + +#[doc(hidden)] +pub trait ReadOnlyInstanceResolver: Clone + Send + Sync + 'static { + type Host: CoreInstanceHost; + + fn resolve( + &self, + identifier: Option<&easytier_proto::api::instance::InstanceIdentifier>, + ) -> rpc_types::error::Result>>; +} + +/// Resolver used by the public process-level management RPC type. +#[doc(hidden)] +pub struct ManagerInstanceResolver +where + F: InstanceFactory, +{ + manager: Arc>, +} + +impl Clone for ManagerInstanceResolver +where + F: InstanceFactory, +{ + fn clone(&self) -> Self { + Self { + manager: self.manager.clone(), + } + } +} + +impl ReadOnlyInstanceResolver for ManagerInstanceResolver +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + type Host = H; + + fn resolve( + &self, + identifier: Option<&easytier_proto::api::instance::InstanceIdentifier>, + ) -> rpc_types::error::Result>> { + resolve_instance(&self.manager, identifier).map_err(Into::into) + } +} + +#[cfg(target_os = "wasi")] +pub(super) struct BoundInstanceResolver +where + H: CoreInstanceHost, +{ + instance: Arc>, +} + +#[cfg(target_os = "wasi")] +impl Clone for BoundInstanceResolver +where + H: CoreInstanceHost, +{ + fn clone(&self) -> Self { + Self { + instance: self.instance.clone(), + } + } +} + +#[cfg(target_os = "wasi")] +impl ReadOnlyInstanceResolver for BoundInstanceResolver +where + H: CoreInstanceHost, +{ + type Host = H; + + fn resolve( + &self, + identifier: Option<&easytier_proto::api::instance::InstanceIdentifier>, + ) -> rpc_types::error::Result>> { + validate_bound_identifier( + identifier, + self.instance.instance_id(), + self.instance.instance_name(), + )?; + Ok(self.instance.clone()) + } +} + +/// Instance-targeted management RPC backed by a selector resolver. +#[doc(hidden)] +pub struct ResolvedInstanceManagementRpc { + resolver: R, + #[cfg(feature = "web-client")] + config_patch_persistence: Option>, +} + +impl Clone for ResolvedInstanceManagementRpc +where + R: Clone, +{ + fn clone(&self) -> Self { + Self { + resolver: self.resolver.clone(), + #[cfg(feature = "web-client")] + config_patch_persistence: self.config_patch_persistence.clone(), + } + } +} + +impl ResolvedInstanceManagementRpc +where + R: ReadOnlyInstanceResolver, +{ + fn instance( + &self, + identifier: Option<&easytier_proto::api::instance::InstanceIdentifier>, + ) -> rpc_types::error::Result>> { + self.resolver.resolve(identifier) + } +} + +/// One process-level implementation for Instance-targeted management RPC. +pub type InstanceManagementRpc = ResolvedInstanceManagementRpc>; + +impl ResolvedInstanceManagementRpc> +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + pub fn new(manager: Arc>) -> Self { + Self { + resolver: ManagerInstanceResolver { manager }, + #[cfg(feature = "web-client")] + config_patch_persistence: None, + } + } + #[cfg(feature = "web-client")] + pub fn new_with_config_storage( + manager: Arc>, + storage: Arc, + ) -> Self { + let persistence = Arc::new(ManagerConfigPatchPersistence { + manager: manager.clone(), + storage, + _host: std::marker::PhantomData, + }); + Self { + resolver: ManagerInstanceResolver { manager }, + config_patch_persistence: Some(persistence), + } + } + + #[cfg(feature = "management")] + pub(super) fn manager(&self) -> &Arc> { + &self.resolver.manager + } +} + +#[cfg(target_os = "wasi")] +pub(super) fn bound_rpc( + instance: Arc>, +) -> ResolvedInstanceManagementRpc> +where + H: CoreInstanceHost, +{ + ResolvedInstanceManagementRpc { + resolver: BoundInstanceResolver { instance }, + #[cfg(feature = "web-client")] + config_patch_persistence: Some(Arc::new(InMemoryConfigPatchPersistence)), + } +} + +#[cfg(all(feature = "web-client", target_os = "wasi"))] +struct InMemoryConfigPatchPersistence; + +#[async_trait::async_trait] +#[cfg(all(feature = "web-client", target_os = "wasi"))] +impl ConfigPatchPersistence for InMemoryConfigPatchPersistence { + async fn persist(&self, _instance_id: uuid::Uuid, _config: &TomlConfig) -> anyhow::Result<()> { + Ok(()) + } +} + +#[cfg(feature = "web-client")] +struct ManagerConfigPatchPersistence +where + F: InstanceFactory, + H: CoreInstanceHost, +{ + manager: Arc>, + storage: Arc, + _host: std::marker::PhantomData H>, +} + +#[cfg(feature = "web-client")] +async fn persist_config_patch( + storage: &dyn ConfigFileStorage, + control: &crate::instance::manager::ConfigFileControl, + config: &TomlConfig, +) -> anyhow::Result<()> { + if control.is_read_only() { + anyhow::bail!("configuration file is read-only"); + } + let Some(path) = control.path.as_deref() else { + return Ok(()); + }; + if storage.inspect(path).await.is_read_only() { + anyhow::bail!( + "config file {} is read-only, cannot be overwritten", + path.display() + ); + } + storage.write(path, config.dump().as_bytes()).await +} + +#[async_trait::async_trait] +#[cfg(feature = "web-client")] +impl ConfigPatchPersistence for ManagerConfigPatchPersistence +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + async fn persist(&self, instance_id: uuid::Uuid, config: &TomlConfig) -> anyhow::Result<()> { + let control = self + .manager + .config_control(instance_id) + .ok_or_else(|| anyhow::anyhow!("configuration file control is unavailable"))?; + persist_config_patch(self.storage.as_ref(), &control, config).await + } +} + +#[cfg(all(test, feature = "web-client"))] +mod config_patch_persistence_tests { + use std::{ + path::{Path, PathBuf}, + sync::atomic::{AtomicBool, AtomicUsize, Ordering}, + }; + + use super::*; + use crate::{ + instance::manager::{ConfigFileControl, ConfigFilePermission}, + management::ConfigFileStorage, + }; + + #[derive(Default)] + struct RecordingStorage { + read_only: AtomicBool, + inspections: AtomicUsize, + writes: AtomicUsize, + } + + #[async_trait::async_trait] + impl ConfigFileStorage for RecordingStorage { + async fn inspect(&self, path: &Path) -> ConfigFileControl { + self.inspections.fetch_add(1, Ordering::Relaxed); + let permission = if self.read_only.load(Ordering::Relaxed) { + ConfigFilePermission::from(ConfigFilePermission::READ_ONLY) + } else { + ConfigFilePermission::default() + }; + ConfigFileControl::new(Some(path.to_owned()), permission) + } + + async fn read(&self, _path: &Path) -> anyhow::Result>> { + unreachable!("config patch persistence does not read files") + } + + async fn write(&self, _path: &Path, _contents: &[u8]) -> anyhow::Result<()> { + self.writes.fetch_add(1, Ordering::Relaxed); + Ok(()) + } + + async fn remove(&self, _path: &Path) -> anyhow::Result<()> { + unreachable!("config patch persistence does not remove files") + } + } + + #[tokio::test] + async fn pathless_config_patch_skips_persistence() { + let storage = RecordingStorage::default(); + let control = ConfigFileControl::new(None, ConfigFilePermission::default()); + + persist_config_patch(&storage, &control, &TomlConfig::default()) + .await + .unwrap(); + + assert_eq!(storage.inspections.load(Ordering::Relaxed), 0); + assert_eq!(storage.writes.load(Ordering::Relaxed), 0); + } + + #[tokio::test] + async fn config_patch_rechecks_file_permission_before_write() { + let storage = RecordingStorage::default(); + storage.read_only.store(true, Ordering::Relaxed); + let control = ConfigFileControl::new( + Some(PathBuf::from("managed.toml")), + ConfigFilePermission::default(), + ); + + let error = persist_config_patch(&storage, &control, &TomlConfig::default()) + .await + .unwrap_err(); + + assert!(error.to_string().contains("managed.toml is read-only")); + assert_eq!(storage.inspections.load(Ordering::Relaxed), 1); + assert_eq!(storage.writes.load(Ordering::Relaxed), 0); + } +} + +#[cfg(any(test, target_os = "wasi"))] +fn validate_bound_identifier( + identifier: Option<&easytier_proto::api::instance::InstanceIdentifier>, + instance_id: uuid::Uuid, + instance_name: &str, +) -> anyhow::Result<()> { + use easytier_proto::api::instance::instance_identifier::Selector; + + let matches = match identifier.and_then(|identifier| identifier.selector.as_ref()) { + None + | Some(Selector::InstanceSelector( + easytier_proto::api::instance::instance_identifier::InstanceSelector { name: None }, + )) => true, + Some(Selector::Id(selected)) => uuid::Uuid::from(*selected) == instance_id, + Some(Selector::InstanceSelector(selector)) => { + selector.name.as_deref() == Some(instance_name) + } + }; + if !matches { + anyhow::bail!("instance selector does not match the bound WASM instance"); + } + Ok(()) +} + +fn foreign_network_info_to_api(info: ForeignNetworkEntryInfo) -> ForeignNetworkEntryPb { + ForeignNetworkEntryPb { + network_secret_digest: info.network_secret_digest, + my_peer_id_for_this_network: info.my_peer_id_for_this_network, + peers: info + .peers + .into_iter() + .map(|peer| PeerInfo { + peer_id: peer.peer_id, + conns: peer.conns.into_iter().map(Into::into).collect(), + ..Default::default() + }) + .collect(), + trusted_keys: info + .trusted_keys + .into_iter() + .map(|key| TrustedKeyInfoPb { + pubkey: key.pubkey, + source: match key.source { + TrustedKeySource::OspfNode => TrustedKeySourcePb::OspfNode.into(), + TrustedKeySource::OspfCredential => TrustedKeySourcePb::OspfCredential.into(), + }, + expiry_unix: key.expiry_unix, + }) + .collect(), + } +} + +fn format_prefix(prefix: &IpPrefix) -> String { + format!("{}/{}", prefix.address, prefix.prefix_len) +} + +fn format_proxy_network(proxy: ProxyNetworkConfig) -> String { + let real = format_prefix(&proxy.real); + match proxy.mapped { + Some(mapped) => format!("{}->{}", real, format_prefix(&mapped)), + None => real, + } +} + +fn connector_snapshots_to_api(snapshots: Vec) -> Vec { + let mut connectors = Vec::with_capacity(snapshots.len()); + for connector in snapshots { + let status = match connector.status { + ManualConnectorStatus::Connected => ConnectorStatus::Connected, + ManualConnectorStatus::Disconnected => ConnectorStatus::Disconnected, + ManualConnectorStatus::Connecting => ConnectorStatus::Connecting, + }; + connectors.insert( + 0, + Connector { + url: Some(connector.url.into()), + status: status.into(), + }, + ); + } + connectors +} + +#[async_trait::async_trait] +impl PeerManageRpc for ResolvedInstanceManagementRpc +where + R: ReadOnlyInstanceResolver, +{ + type Controller = BaseController; + + async fn list_peer( + &self, + _: BaseController, + request: ListPeerRequest, + ) -> rpc_types::error::Result { + let peer_infos = self + .instance(request.instance.as_ref())? + .peer_snapshots() + .await + .into_iter() + .map(|snapshot| PeerInfo { + peer_id: snapshot.peer_id, + default_conn_id: snapshot.default_conn_id.map(Into::into), + directly_connected_conns: snapshot + .directly_connected_conns + .into_iter() + .map(Into::into) + .collect(), + conns: snapshot.conns.into_iter().map(Into::into).collect(), + }) + .collect(); + Ok(ListPeerResponse { + peer_infos, + ..Default::default() + }) + } + + async fn list_public_ipv6_info( + &self, + _: BaseController, + request: ListPublicIpv6InfoRequest, + ) -> rpc_types::error::Result { + Ok(self + .instance(request.instance.as_ref())? + .local_public_ipv6_info() + .await + .into()) + } + + async fn list_route( + &self, + _: BaseController, + request: ListRouteRequest, + ) -> rpc_types::error::Result { + Ok(ListRouteResponse { + routes: self + .instance(request.instance.as_ref())? + .route_snapshots() + .await + .into_iter() + .map(Into::into) + .collect(), + }) + } + + async fn dump_route( + &self, + _: BaseController, + request: DumpRouteRequest, + ) -> rpc_types::error::Result { + Ok(DumpRouteResponse { + result: self.instance(request.instance.as_ref())?.dump_route().await, + }) + } + + async fn list_foreign_network( + &self, + _: BaseController, + request: ListForeignNetworkRequest, + ) -> rpc_types::error::Result { + Ok(ListForeignNetworkResponse { + foreign_networks: self + .instance(request.instance.as_ref())? + .foreign_network_snapshots(request.include_trusted_keys) + .await + .into_iter() + .map(|(network_name, info)| (network_name, foreign_network_info_to_api(info))) + .collect(), + }) + } + + async fn list_global_foreign_network( + &self, + _: BaseController, + request: ListGlobalForeignNetworkRequest, + ) -> rpc_types::error::Result { + let mut response = ListGlobalForeignNetworkResponse::default(); + let route_infos = self + .instance(request.instance.as_ref())? + .foreign_network_route_infos() + .await; + for info in &route_infos.infos { + let Some(key) = info.key.as_ref() else { + continue; + }; + let Some(route_info) = info.value.as_ref() else { + continue; + }; + response + .foreign_networks + .entry(key.peer_id) + .or_default() + .foreign_networks + .push(OneForeignNetwork { + network_name: key.network_name.clone(), + peer_ids: route_info.foreign_peer_ids.clone(), + last_updated: match route_info.last_update.as_ref() { + Some(last_update) => projection::format_last_update(last_update)?, + None => String::new(), + }, + version: route_info.version, + }); + } + Ok(response) + } + + async fn get_foreign_network_summary( + &self, + _: BaseController, + request: GetForeignNetworkSummaryRequest, + ) -> rpc_types::error::Result { + Ok(GetForeignNetworkSummaryResponse { + summary: Some( + self.instance(request.instance.as_ref())? + .foreign_network_route_summary() + .await, + ), + }) + } + + async fn show_node_info( + &self, + _: BaseController, + request: ShowNodeInfoRequest, + ) -> rpc_types::error::Result { + let instance = self.instance(request.instance.as_ref())?; + let config = projection::node_config(instance.as_ref())?; + let snapshot = instance.node_snapshot().await; + Ok(ShowNodeInfoResponse { + node_info: Some(NodeInfo { + peer_id: snapshot.peer_id, + ipv4_addr: snapshot + .ipv4_addr + .map(|addr| addr.to_string()) + .unwrap_or_default(), + proxy_cidrs: snapshot + .proxy_networks + .into_iter() + .map(format_proxy_network) + .collect(), + hostname: snapshot.hostname, + stun_info: Some(snapshot.stun_info), + inst_id: snapshot.instance_id.to_string(), + listeners: snapshot + .listeners + .into_iter() + .map(|listener| listener.to_string()) + .collect(), + config, + version: snapshot.version, + feature_flag: Some(snapshot.feature_flags), + ip_list: Some(snapshot.ip_list), + public_ipv6_addr: snapshot.public_ipv6_addr.map(Into::into), + ipv6_public_addr_prefix: snapshot.ipv6_public_addr_prefix.map(Into::into), + }), + }) + } +} + +#[async_trait::async_trait] +impl ConnectorManageRpc for ResolvedInstanceManagementRpc +where + R: ReadOnlyInstanceResolver, +{ + type Controller = BaseController; + + async fn list_connector( + &self, + _: BaseController, + request: ListConnectorRequest, + ) -> rpc_types::error::Result { + Ok(ListConnectorResponse { + connectors: connector_snapshots_to_api( + self.instance(request.instance.as_ref())?.list_connectors(), + ), + }) + } +} + +#[cfg(test)] +mod tests { + use easytier_proto::{ + api::instance::{ + InstanceIdentifier, + instance_identifier::{InstanceSelector, Selector}, + }, + common::Uuid as UuidPb, + }; + + use super::validate_bound_identifier; + + #[test] + fn bound_identifier_accepts_only_the_current_instance() { + let instance_id = uuid::Uuid::new_v4(); + let by_id = |id| InstanceIdentifier { + selector: Some(Selector::Id(UuidPb::from(id))), + }; + let by_name = |name: &str| InstanceIdentifier { + selector: Some(Selector::InstanceSelector(InstanceSelector { + name: Some(name.to_owned()), + })), + }; + + assert!(validate_bound_identifier(None, instance_id, "current").is_ok()); + assert!( + validate_bound_identifier(Some(&by_id(instance_id)), instance_id, "current").is_ok() + ); + assert!( + validate_bound_identifier(Some(&by_name("current")), instance_id, "current").is_ok() + ); + assert!( + validate_bound_identifier(Some(&by_id(uuid::Uuid::new_v4())), instance_id, "current") + .is_err() + ); + assert!( + validate_bound_identifier(Some(&by_name("other")), instance_id, "current").is_err() + ); + } +} diff --git a/vendor/easytier/easytier-core/src/management/instance_rpc/packet_proxy.rs b/vendor/easytier/easytier-core/src/management/instance_rpc/packet_proxy.rs new file mode 100644 index 0000000..c6cee34 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/instance_rpc/packet_proxy.rs @@ -0,0 +1,135 @@ +use std::sync::Arc; + +use easytier_proto::{ + api::instance::{ + ListTcpProxyEntryRequest, ListTcpProxyEntryResponse, TcpProxyEntry, TcpProxyEntryState, + TcpProxyEntryTransportType, TcpProxyRpc, + }, + rpc_types::{self, controller::BaseController}, +}; + +use crate::{ + gateway::proxy::{ + tcp_proxy_engine::{TcpNatEntrySnapshot, TcpNatEntryState as CoreTcpNatEntryState}, + wrapped_transport::{WrappedTransportKind, WrappedTransportRole}, + }, + instance::{ + CoreInstance, CoreInstanceHost, + manager::{InstanceFactory, InstanceManager}, + }, +}; + +use super::super::resolve_instance; + +#[derive(Clone, Copy)] +enum TcpProxySource { + Tcp, + Wrapped(WrappedTransportKind, WrappedTransportRole), +} + +pub(crate) struct TcpProxyManagementRpc +where + F: InstanceFactory, +{ + manager: Arc>, + source: TcpProxySource, +} + +impl Clone for TcpProxyManagementRpc +where + F: InstanceFactory, +{ + fn clone(&self) -> Self { + Self { + manager: self.manager.clone(), + source: self.source, + } + } +} + +impl TcpProxyManagementRpc +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + pub(crate) fn tcp(manager: Arc>) -> Self { + Self { + manager, + source: TcpProxySource::Tcp, + } + } + + pub(crate) fn wrapped( + manager: Arc>, + transport: WrappedTransportKind, + role: WrappedTransportRole, + ) -> Self { + Self { + manager, + source: TcpProxySource::Wrapped(transport, role), + } + } +} + +fn tcp_entry_snapshot_to_api( + entry: TcpNatEntrySnapshot, + transport_type: TcpProxyEntryTransportType, +) -> TcpProxyEntry { + TcpProxyEntry { + src: Some(entry.src.into()), + dst: Some(entry.dst.into()), + start_time: entry.start_time, + state: match entry.state { + CoreTcpNatEntryState::SynReceived => TcpProxyEntryState::SynReceived, + CoreTcpNatEntryState::ConnectingDst => TcpProxyEntryState::ConnectingDst, + CoreTcpNatEntryState::Connected => TcpProxyEntryState::Connected, + CoreTcpNatEntryState::ClosingSrc => TcpProxyEntryState::ClosingSrc, + CoreTcpNatEntryState::ClosingDst => TcpProxyEntryState::ClosingDst, + CoreTcpNatEntryState::Closed => TcpProxyEntryState::Closed, + } + .into(), + transport_type: transport_type.into(), + } +} + +#[async_trait::async_trait] +impl TcpProxyRpc for TcpProxyManagementRpc +where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + type Controller = BaseController; + + async fn list_tcp_proxy_entry( + &self, + _: BaseController, + request: ListTcpProxyEntryRequest, + ) -> rpc_types::error::Result { + let instance = resolve_instance(&self.manager, request.instance.as_ref())?; + let (snapshots, transport_type) = match self.source { + TcpProxySource::Tcp => ( + instance.tcp_proxy_entry_snapshots(), + TcpProxyEntryTransportType::Tcp, + ), + TcpProxySource::Wrapped(transport, role) => { + if !instance.wrapped_transport_is_started(transport, role) { + return Err(anyhow::anyhow!("wrapped TCP proxy is not available").into()); + } + let transport_type = match transport { + WrappedTransportKind::Kcp => TcpProxyEntryTransportType::Kcp, + WrappedTransportKind::Quic => TcpProxyEntryTransportType::Quic, + }; + ( + instance.wrapped_tcp_proxy_entry_snapshots(transport, role), + transport_type, + ) + } + }; + Ok(ListTcpProxyEntryResponse { + entries: snapshots + .into_iter() + .map(|entry| tcp_entry_snapshot_to_api(entry, transport_type)) + .collect(), + }) + } +} diff --git a/vendor/easytier/easytier-core/src/management/instance_rpc/projection.rs b/vendor/easytier/easytier-core/src/management/instance_rpc/projection.rs new file mode 100644 index 0000000..ec28c33 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/instance_rpc/projection.rs @@ -0,0 +1,39 @@ +use crate::instance::{CoreInstance, CoreInstanceHost}; + +#[cfg(not(feature = "management"))] +pub(super) fn format_last_update( + last_update: &easytier_proto::common::RuntimeTimestamp, +) -> anyhow::Result { + let last_update = last_update.normalized(); + let date_time = chrono::DateTime::from_timestamp(last_update.seconds, last_update.nanos as u32) + .ok_or_else(|| anyhow::anyhow!("invalid protobuf timestamp"))?; + Ok(format!("\"{date_time:?}\"")) +} + +#[cfg(feature = "management")] +pub(super) fn format_last_update( + last_update: &easytier_proto::common::RuntimeTimestamp, +) -> anyhow::Result { + serde_json::to_string(last_update).map_err(anyhow::Error::from) +} + +#[cfg(not(feature = "management"))] +pub(super) fn node_config(_instance: &CoreInstance) -> anyhow::Result +where + H: CoreInstanceHost, +{ + Ok(String::new()) +} + +#[cfg(feature = "management")] +pub(super) fn node_config(instance: &CoreInstance) -> anyhow::Result +where + H: CoreInstanceHost, +{ + use crate::config::toml::ConfigLoader as _; + + instance + .toml_config() + .ok_or_else(|| anyhow::anyhow!("shared TOML configuration is not available")) + .map(|config| config.dump()) +} diff --git a/vendor/easytier/easytier-core/src/management/mod.rs b/vendor/easytier/easytier-core/src/management/mod.rs new file mode 100644 index 0000000..9f948d4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/mod.rs @@ -0,0 +1,82 @@ +//! Process-level management over the canonical Instance collection. + +#[cfg(all(feature = "management", any(test, target_os = "wasi")))] +mod forwarded_rpc; +#[cfg(feature = "web-client")] +mod full; +mod instance_rpc; +mod rpc_server_hook; +mod selector; +mod server; + +use std::sync::Arc; + +use crate::{ + instance::{CoreInstance, CoreInstanceHost, manager::InstanceFactory}, + rpc::service_registry::ServiceRegistry, +}; +#[cfg(all(feature = "management", target_os = "wasi"))] +use easytier_proto::api::config::ConfigRpcServer; +use easytier_proto::api::instance::{ConnectorManageRpcServer, PeerManageRpcServer}; + +pub use crate::instance::manager::{ + ConfigFileControl, ConfigFilePermission, DaemonGuard, InstanceManager, ProcessRuntimeProvider, +}; +#[cfg(all(feature = "management", target_os = "wasi"))] +pub(crate) use forwarded_rpc::{ + ManagementRpcForwarder, register_forwarded_instance_management_rpc, +}; +#[cfg(all(feature = "management", target_os = "wasi"))] +pub(crate) use full::WebClientBackend; +#[cfg(all(feature = "web-client", test))] +pub(crate) use full::register_web_client_rpc; +#[cfg(feature = "management")] +pub use full::remote_client; +#[cfg(feature = "web-client")] +pub use full::{ + ConfigFileStorage, ConfigPatchPersistence, ConfigServerEndpoint, InstanceMutationHooks, + InstanceMutationResult, ProcessManagement, ProcessManagementRpc, UnsupportedConfigFileStorage, + WebClient, WebClientConfig, apply_config_patch, config_source_from_rpc, config_source_to_rpc, + network_instance_running_info, +}; +#[cfg(feature = "management")] +pub use full::{ + LoggerControl, LoggerManagementRpc, UnsupportedLoggerControl, call_instance_json_rpc, + call_management_json_rpc, log_level_name, parse_log_level, register_instance_management_rpc, + register_management_rpc, +}; +pub use instance_rpc::InstanceManagementRpc; +pub use rpc_server_hook::ManagementRpcServerHook; +pub use selector::{ + ManagementInstance, ManagementSelector, resolve_instance, resolve_management_instance, + resolve_optional_instance_by_name, +}; +#[cfg(feature = "management")] +pub use server::ManagementServer; +pub use server::ReadOnlyManagementServer; +/// Registers the read-only status surface used by compact native nodes. +pub fn register_read_only_management_rpc( + manager: Arc>, + registry: &ServiceRegistry, +) where + F: InstanceFactory>, + H: CoreInstanceHost, +{ + let rpc = InstanceManagementRpc::::new(manager); + registry.register(PeerManageRpcServer::new(rpc.clone()), ""); + registry.register(ConnectorManageRpcServer::new(rpc), ""); +} + +#[cfg(target_os = "wasi")] +pub(crate) fn register_bound_management_rpc( + instance: Arc>, + registry: &ServiceRegistry, +) where + H: CoreInstanceHost, +{ + let rpc = instance_rpc::bound_rpc(instance); + registry.register(PeerManageRpcServer::new(rpc.clone()), ""); + registry.register(ConnectorManageRpcServer::new(rpc.clone()), ""); + #[cfg(feature = "management")] + registry.register(ConfigRpcServer::new(rpc), ""); +} diff --git a/vendor/easytier/easytier-core/src/management/rpc_server_hook.rs b/vendor/easytier/easytier-core/src/management/rpc_server_hook.rs new file mode 100644 index 0000000..634763b --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/rpc_server_hook.rs @@ -0,0 +1,59 @@ +use std::{net::IpAddr, sync::Arc}; + +use cidr::IpCidr; +use easytier_proto::common::TunnelInfo; + +use crate::rpc::standalone::RpcServerHook; + +/// Restricts the process-level management endpoint to configured client CIDRs. +pub struct ManagementRpcServerHook { + whitelist: Vec, +} + +impl ManagementRpcServerHook { + pub fn new(whitelist: Option>) -> Self { + Self { + whitelist: whitelist.unwrap_or_else(|| { + vec!["127.0.0.0/8".parse().unwrap(), "::1/128".parse().unwrap()] + }), + } + } +} + +#[async_trait::async_trait] +impl RpcServerHook for ManagementRpcServerHook { + async fn on_new_client( + &self, + tunnel_info: Option, + ) -> Result, anyhow::Error> { + let tunnel_info = tunnel_info.ok_or_else(|| anyhow::anyhow!("tunnel info is None"))?; + let remote_url = tunnel_info + .remote_addr + .as_ref() + .ok_or_else(|| anyhow::anyhow!("remote_addr is None"))?; + let url = url::Url::parse(&remote_url.url) + .map_err(|error| anyhow::anyhow!("failed to parse remote URL: {error}"))?; + let host = url + .host_str() + .ok_or_else(|| anyhow::anyhow!("remote URL has no host"))?; + let ip_addr: IpAddr = host + .parse() + .map_err(|error| anyhow::anyhow!("failed to parse client IP {host}: {error}"))?; + + if self.whitelist.iter().any(|cidr| cidr.contains(&ip_addr)) { + return Ok(Some(tunnel_info)); + } + + Err(anyhow::anyhow!( + "RPC portal client IP {} is not in whitelist {:?}", + ip_addr, + self.whitelist + )) + } +} + +impl From for Arc { + fn from(value: ManagementRpcServerHook) -> Self { + Arc::new(value) + } +} diff --git a/vendor/easytier/easytier-core/src/management/selector.rs b/vendor/easytier/easytier-core/src/management/selector.rs new file mode 100644 index 0000000..18abae2 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/selector.rs @@ -0,0 +1,227 @@ +use std::sync::Arc; + +use easytier_proto::api::instance::{InstanceIdentifier, instance_identifier::Selector}; + +use crate::instance::{ + CoreInstance, CoreInstanceHost, + manager::{InstanceFactory, InstanceManager, ManagedInstance}, +}; + +/// Transport-independent selector for one managed Instance. +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum ManagementSelector { + Id(uuid::Uuid), + Name(String), + UnambiguousDefault, +} + +/// Instance metadata required by process-level management selection. +pub trait ManagementInstance: ManagedInstance { + fn instance_name(&self) -> &str; +} + +impl ManagementInstance for CoreInstance +where + H: CoreInstanceHost, +{ + fn instance_name(&self) -> &str { + self.instance_name() + } +} + +/// Resolves one stateless management selector through the canonical Manager. +pub fn resolve_instance( + manager: &InstanceManager, + identifier: Option<&InstanceIdentifier>, +) -> anyhow::Result> +where + F: InstanceFactory, + F::Instance: ManagementInstance, +{ + let selector = match identifier.and_then(|identifier| identifier.selector.as_ref()) { + Some(Selector::Id(instance_id)) => ManagementSelector::Id((*instance_id).into()), + Some(Selector::InstanceSelector(selector)) => selector + .name + .clone() + .map(ManagementSelector::Name) + .unwrap_or(ManagementSelector::UnambiguousDefault), + None => ManagementSelector::UnambiguousDefault, + }; + resolve_management_instance(manager, &selector) +} + +/// Resolves one Instance without coupling the caller to an RPC request type. +pub fn resolve_management_instance( + manager: &InstanceManager, + selector: &ManagementSelector, +) -> anyhow::Result> +where + F: InstanceFactory, + F::Instance: ManagementInstance, +{ + if let ManagementSelector::Id(instance_id) = selector { + return manager + .get(*instance_id) + .ok_or_else(|| anyhow::anyhow!("Instance not found")); + } + + let matching = manager + .list() + .into_iter() + .filter(|instance| match selector { + ManagementSelector::Name(name) => instance.instance_name() == name, + ManagementSelector::UnambiguousDefault => true, + ManagementSelector::Id(_) => unreachable!(), + }) + .collect::>(); + + match matching.as_slice() { + [] => anyhow::bail!("No instance matches the selector"), + [instance] => Ok(instance.clone()), + _ => anyhow::bail!( + "{} instances match the selector, please specify the instance ID", + matching.len() + ), + } +} + +/// Resolves a unique name, distinguishing a missing name from ambiguity. +pub fn resolve_optional_instance_by_name( + manager: &InstanceManager, + name: &str, +) -> anyhow::Result>> +where + F: InstanceFactory, + F::Instance: ManagementInstance, +{ + let matching = manager + .list() + .into_iter() + .filter(|instance| instance.instance_name() == name) + .collect::>(); + match matching.as_slice() { + [] => Ok(None), + [instance] => Ok(Some(instance.clone())), + _ => anyhow::bail!( + "{} instances match the selector, please specify the instance ID", + matching.len() + ), + } +} + +#[cfg(test)] +mod tests { + use easytier_proto::{ + api::instance::{ + InstanceIdentifier, instance_identifier::InstanceSelector, + instance_identifier::Selector, + }, + common::Uuid as UuidPb, + }; + use uuid::Uuid; + + use super::*; + use crate::config::toml::{ConfigLoader as _, TomlConfig}; + #[derive(Debug)] + struct TestInstance { + id: Uuid, + name: String, + } + + impl ManagedInstance for TestInstance { + fn instance_id(&self) -> Uuid { + self.id + } + } + + impl ManagementInstance for TestInstance { + fn instance_name(&self) -> &str { + &self.name + } + } + + struct TestFactory; + + impl InstanceFactory for TestFactory { + type Instance = TestInstance; + type CreateContext = String; + type Error = std::convert::Infallible; + + fn create( + &self, + config: TomlConfig, + name: Self::CreateContext, + ) -> Result, Self::Error> { + Ok(Arc::new(TestInstance { + id: config.get_id(), + name, + })) + } + } + + fn add(manager: &InstanceManager, id: Uuid, name: &str) { + let config = TomlConfig::default(); + config.set_id(id); + manager.create(config, name.to_owned()).unwrap(); + } + + fn by_id(id: Uuid) -> InstanceIdentifier { + InstanceIdentifier { + selector: Some(Selector::Id(UuidPb::from(id))), + } + } + + fn by_name(name: &str) -> InstanceIdentifier { + InstanceIdentifier { + selector: Some(Selector::InstanceSelector(InstanceSelector { + name: Some(name.to_owned()), + })), + } + } + + #[test] + fn resolves_uuid_name_and_single_implicit_instance() { + let manager = InstanceManager::new(TestFactory, None); + let id = Uuid::new_v4(); + add(&manager, id, "alpha"); + + assert_eq!(resolve_instance(&manager, Some(&by_id(id))).unwrap().id, id); + assert_eq!( + resolve_instance(&manager, Some(&by_name("alpha"))) + .unwrap() + .id, + id + ); + assert_eq!(resolve_instance(&manager, None).unwrap().id, id); + } + + #[test] + fn rejects_missing_and_ambiguous_selectors() { + let manager = InstanceManager::new(TestFactory, None); + assert_eq!( + resolve_instance(&manager, None).unwrap_err().to_string(), + "No instance matches the selector" + ); + + add(&manager, Uuid::new_v4(), "same"); + add(&manager, Uuid::new_v4(), "same"); + assert!( + resolve_instance(&manager, None) + .unwrap_err() + .to_string() + .contains("2 instances match") + ); + assert!( + resolve_instance(&manager, Some(&by_name("same"))) + .unwrap_err() + .to_string() + .contains("2 instances match") + ); + assert_eq!( + resolve_instance(&manager, Some(&by_name("missing"))) + .unwrap_err() + .to_string(), + "No instance matches the selector" + ); + } +} diff --git a/vendor/easytier/easytier-core/src/management/server.rs b/vendor/easytier/easytier-core/src/management/server.rs new file mode 100644 index 0000000..fcc2cc7 --- /dev/null +++ b/vendor/easytier/easytier-core/src/management/server.rs @@ -0,0 +1,176 @@ +use std::sync::Arc; + +use cidr::IpCidr; + +use crate::{ + instance::{ + CoreInstance, CoreInstanceHost, + manager::{InstanceFactory, ProcessRuntimeProvider}, + }, + process_runtime::{CoreProcessRuntime, ProtectedTcpPortLease}, + proto::rpc_types::error::Error, + rpc::{ + service_registry::ServiceRegistry, + standalone::{RpcServerHook, StandAloneServer}, + }, + socket::SocketListener, + tunnel::Tunnel, +}; + +#[cfg(feature = "management")] +use super::{ConfigFileStorage, InstanceMutationHooks, LoggerControl, register_management_rpc}; +use super::{InstanceManager, ManagementRpcServerHook, register_read_only_management_rpc}; + +struct ManagementListener +where + L: SocketListener> + 'static, +{ + server: StandAloneServer, + process_runtime: Arc, +} + +impl ManagementListener +where + L: SocketListener> + 'static, +{ + fn new(listener: L, process_runtime: Arc) -> Self { + Self { + server: StandAloneServer::new(listener), + process_runtime, + } + } + + fn set_whitelist(&mut self, whitelist: Option>) { + let hook: Arc = Arc::new(ManagementRpcServerHook::new(whitelist)); + self.server.set_hook(hook); + } + + async fn serve(&mut self) -> crate::proto::rpc_types::error::Result<()> { + let process_runtime = self.process_runtime.clone(); + let binding_guard = protect_tcp_port(&process_runtime, &self.server.listener_url())?; + self.server + .serve_with_bound_listener(binding_guard, move |url| { + protect_tcp_port(&process_runtime, url) + }) + .await + } + + fn set_rx_timeout(&mut self, timeout: Option) { + self.server.set_rx_timeout(timeout); + } + + fn registry(&self) -> &ServiceRegistry { + self.server.registry() + } +} + +impl Drop for ManagementListener +where + L: SocketListener> + 'static, +{ + fn drop(&mut self) { + self.server.registry().unregister_all(); + } +} + +fn protect_tcp_port( + process_runtime: &CoreProcessRuntime, + url: &url::Url, +) -> Result, Error> { + match (url.scheme(), url.port()) { + ("tcp", Some(0) | None) => Err(anyhow::anyhow!( + "management TCP listener requires a concrete protected port before binding" + ) + .into()), + ("tcp", Some(port)) => Ok(Some(process_runtime.protect_tcp_port(port))), + _ => Ok(None), + } +} + +#[cfg(feature = "management")] +pub struct ManagementServer +where + L: SocketListener> + 'static, +{ + listener: ManagementListener, +} + +#[cfg(feature = "management")] +impl ManagementServer +where + L: SocketListener> + 'static, +{ + pub fn new( + listener: L, + instances: Arc>, + hooks: Arc, + storage: Arc, + logger: Arc, + ) -> Self + where + F: InstanceFactory, CreateContext = ()> + ProcessRuntimeProvider, + F::Error: std::fmt::Debug + std::fmt::Display + Send + Sync + 'static, + H: CoreInstanceHost, + { + let server = ManagementListener::new(listener, instances.process_runtime()); + register_management_rpc(instances, server.registry(), hooks, storage, logger); + Self { listener: server } + } + + /// Enables CIDR authorization for IP-based management transports. + /// Non-IP local transports intentionally keep the server default. + pub fn set_whitelist(&mut self, whitelist: Option>) { + self.listener.set_whitelist(whitelist); + } + + pub async fn serve(&mut self) -> crate::proto::rpc_types::error::Result<()> { + self.listener.serve().await + } + + pub fn with_rx_timeout(mut self, timeout: Option) -> Self { + self.listener.set_rx_timeout(timeout); + self + } + + pub fn set_rx_timeout(&mut self, timeout: Option) { + self.listener.set_rx_timeout(timeout); + } + + pub fn registry(&self) -> &ServiceRegistry { + self.listener.registry() + } +} + +pub struct ReadOnlyManagementServer +where + L: SocketListener> + 'static, +{ + listener: ManagementListener, +} + +impl ReadOnlyManagementServer +where + L: SocketListener> + 'static, +{ + pub fn new(listener: L, instances: Arc>) -> Self + where + F: InstanceFactory> + ProcessRuntimeProvider, + H: CoreInstanceHost, + { + let server = ManagementListener::new(listener, instances.process_runtime()); + register_read_only_management_rpc(instances, server.registry()); + Self { listener: server } + } + + pub fn set_whitelist(&mut self, whitelist: Option>) { + self.listener.set_whitelist(whitelist); + } + + pub async fn serve(&mut self) -> crate::proto::rpc_types::error::Result<()> { + self.listener.serve().await + } + + pub fn set_rx_timeout(&mut self, timeout: Option) { + self.listener.set_rx_timeout(timeout); + } +} diff --git a/vendor/easytier/easytier-core/src/packet/compressor.rs b/vendor/easytier/easytier-core/src/packet/compressor.rs new file mode 100644 index 0000000..68db8d6 --- /dev/null +++ b/vendor/easytier/easytier-core/src/packet/compressor.rs @@ -0,0 +1,213 @@ +use zerocopy::{AsBytes as _, FromBytes as _}; + +use super::{COMPRESSOR_TAIL_SIZE, CompressorAlgo, CompressorTail, ZCPacket}; + +mod zstd; + +type Error = anyhow::Error; + +#[async_trait::async_trait] +pub trait Compressor { + async fn compress( + &self, + packet: &mut ZCPacket, + compress_algo: CompressorAlgo, + ) -> Result<(), Error>; + async fn decompress(&self, packet: &mut ZCPacket) -> Result<(), Error>; +} + +pub struct DefaultCompressor {} + +impl Default for DefaultCompressor { + fn default() -> Self { + Self::new() + } +} + +impl DefaultCompressor { + pub fn new() -> Self { + DefaultCompressor {} + } + + pub async fn compress_raw( + &self, + data: &[u8], + compress_algo: CompressorAlgo, + ) -> Result, Error> { + match compress_algo { + CompressorAlgo::ZstdDefault => zstd::compress(data, compress_algo), + CompressorAlgo::None => Ok(data.to_vec()), + } + } + + pub async fn decompress_raw( + &self, + data: &[u8], + compress_algo: CompressorAlgo, + ) -> Result, Error> { + match compress_algo { + CompressorAlgo::ZstdDefault => zstd::decompress(data, compress_algo), + CompressorAlgo::None => Ok(data.to_vec()), + } + } +} + +#[async_trait::async_trait] +impl Compressor for DefaultCompressor { + async fn compress( + &self, + zc_packet: &mut ZCPacket, + compress_algo: CompressorAlgo, + ) -> Result<(), Error> { + if matches!(compress_algo, CompressorAlgo::None) { + return Ok(()); + } + + let pm_header = zc_packet.peer_manager_header().unwrap(); + if pm_header.is_compressed() { + return Ok(()); + } + + let tail = CompressorTail::new(compress_algo); + let buf = self + .compress_raw(zc_packet.payload(), compress_algo) + .await?; + + if buf.len() + COMPRESSOR_TAIL_SIZE > pm_header.len.get() as usize { + // Compressed data is larger than original data, don't compress + return Ok(()); + } + + zc_packet + .mut_peer_manager_header() + .unwrap() + .set_compressed(true); + + let payload_offset = zc_packet.payload_offset(); + zc_packet.mut_inner().truncate(payload_offset); + zc_packet.mut_inner().extend_from_slice(&buf); + zc_packet.mut_inner().extend_from_slice(tail.as_bytes()); + + Ok(()) + } + + async fn decompress(&self, zc_packet: &mut ZCPacket) -> Result<(), Error> { + let pm_header = zc_packet.peer_manager_header().unwrap(); + if !pm_header.is_compressed() { + return Ok(()); + } + + let payload_len = zc_packet.payload().len(); + if payload_len < COMPRESSOR_TAIL_SIZE { + return Err(anyhow::anyhow!("Packet too short: {}", payload_len)); + } + + let text_len = payload_len - COMPRESSOR_TAIL_SIZE; + + let tail = CompressorTail::ref_from_suffix(zc_packet.payload()) + .unwrap() + .clone(); + + let algo = tail + .get_algo() + .ok_or(anyhow::anyhow!("Unknown algo: {:?}", tail))?; + + let buf = self + .decompress_raw(&zc_packet.payload()[..text_len], algo) + .await?; + + if buf.len() != pm_header.len.get() as usize { + anyhow::bail!( + "Decompressed length mismatch: decompressed len {} != pm header len {}", + buf.len(), + pm_header.len.get() + ); + } + + zc_packet + .mut_peer_manager_header() + .unwrap() + .set_compressed(false); + + let payload_offset = zc_packet.payload_offset(); + zc_packet.mut_inner().truncate(payload_offset); + zc_packet.mut_inner().extend_from_slice(&buf); + + Ok(()) + } +} + +pub(super) fn zstd_available() -> bool { + zstd::AVAILABLE +} + +#[cfg(test)] +pub mod tests { + use super::*; + + #[cfg(feature = "zstd")] + #[tokio::test] + async fn test_compress() { + let text = b"12345670000000000000000000"; + let mut packet = ZCPacket::new_with_payload(text); + packet.fill_peer_manager_hdr(0, 0, 0); + + let compressor = DefaultCompressor {}; + + println!( + "Uncompressed packet: {:?}, len: {}", + packet, + packet.payload_len() + ); + + compressor + .compress(&mut packet, CompressorAlgo::ZstdDefault) + .await + .unwrap(); + println!( + "Compressed packet: {:?}, len: {}", + packet, + packet.payload_len() + ); + assert!(packet.peer_manager_header().unwrap().is_compressed()); + + compressor.decompress(&mut packet).await.unwrap(); + assert_eq!(packet.payload(), text); + assert!(!packet.peer_manager_header().unwrap().is_compressed()); + } + + #[cfg(feature = "zstd")] + #[tokio::test] + async fn test_short_text_compress() { + let text = b"1234"; + let mut packet = ZCPacket::new_with_payload(text); + packet.fill_peer_manager_hdr(0, 0, 0); + + let compressor = DefaultCompressor {}; + + // short text can't be compressed + compressor + .compress(&mut packet, CompressorAlgo::ZstdDefault) + .await + .unwrap(); + assert!(!packet.peer_manager_header().unwrap().is_compressed()); + + compressor.decompress(&mut packet).await.unwrap(); + assert_eq!(packet.payload(), text); + assert!(!packet.peer_manager_header().unwrap().is_compressed()); + } + + #[cfg(not(feature = "zstd"))] + #[tokio::test] + async fn unavailable_zstd_returns_an_explicit_error() { + let error = DefaultCompressor::new() + .compress_raw(b"payload", CompressorAlgo::ZstdDefault) + .await + .unwrap_err(); + + assert_eq!( + error.to_string(), + "compression algorithm is unavailable in this build: ZstdDefault" + ); + } +} diff --git a/vendor/easytier/easytier-core/src/packet/compressor/zstd.rs b/vendor/easytier/easytier-core/src/packet/compressor/zstd.rs new file mode 100644 index 0000000..629a234 --- /dev/null +++ b/vendor/easytier/easytier-core/src/packet/compressor/zstd.rs @@ -0,0 +1,76 @@ +#[cfg(feature = "zstd")] +use std::cell::RefCell; + +#[cfg(feature = "zstd")] +use anyhow::Context as _; +#[cfg(feature = "zstd")] +use dashmap::DashMap; +#[cfg(feature = "zstd")] +use zstd::bulk; + +use super::CompressorAlgo; + +#[cfg(feature = "zstd")] +pub(super) const AVAILABLE: bool = true; +#[cfg(not(feature = "zstd"))] +pub(super) const AVAILABLE: bool = false; + +#[cfg(feature = "zstd")] +thread_local! { + static CTX_MAP: RefCell>> = + RefCell::new(DashMap::new()); + static DCTX_MAP: RefCell>> = + RefCell::new(DashMap::new()); +} + +#[cfg(feature = "zstd")] +pub(super) fn compress(data: &[u8], compress_algo: CompressorAlgo) -> anyhow::Result> { + CTX_MAP.with(|map_cell| { + let map = map_cell.borrow(); + let mut ctx_entry = map.entry(compress_algo).or_default(); + ctx_entry.compress(data).with_context(|| { + format!( + "Failed to compress data with algorithm: {:?}", + compress_algo + ) + }) + }) +} + +#[cfg(not(feature = "zstd"))] +pub(super) fn compress(_data: &[u8], compress_algo: CompressorAlgo) -> anyhow::Result> { + unavailable(compress_algo) +} + +#[cfg(feature = "zstd")] +pub(super) fn decompress(data: &[u8], compress_algo: CompressorAlgo) -> anyhow::Result> { + DCTX_MAP.with(|map_cell| { + let map = map_cell.borrow(); + let mut ctx_entry = map.entry(compress_algo).or_default(); + for i in 1..=5 { + let mut len = data.len() * 2usize.pow(i); + if i == 5 && len < 64 * 1024 { + len = 64 * 1024; + } + match ctx_entry.decompress(data, len) { + Ok(buf) => return Ok(buf), + Err(error) if error.to_string().contains("buffer is too small") => continue, + Err(error) => return Err(error.into()), + } + } + Err(anyhow::anyhow!( + "Failed to decompress data after multiple attempts with algorithm: {:?}", + compress_algo + )) + }) +} + +#[cfg(not(feature = "zstd"))] +pub(super) fn decompress(_data: &[u8], compress_algo: CompressorAlgo) -> anyhow::Result> { + unavailable(compress_algo) +} + +#[cfg(not(feature = "zstd"))] +fn unavailable(compress_algo: CompressorAlgo) -> anyhow::Result> { + Err(super::super::CompressionUnavailableError(compress_algo).into()) +} diff --git a/vendor/easytier/easytier-core/src/packet/hole_punch.rs b/vendor/easytier/easytier-core/src/packet/hole_punch.rs new file mode 100644 index 0000000..f430bad --- /dev/null +++ b/vendor/easytier/easytier-core/src/packet/hole_punch.rs @@ -0,0 +1,79 @@ +use bytes::BytesMut; +use rand::{Rng, SeedableRng}; +use zerocopy::FromBytes as _; + +use super::{UDP_TUNNEL_HEADER_SIZE, UDPTunnelHeader, UdpPacketType, ZCPacket, ZCPacketType}; + +pub(crate) const HOLE_PUNCH_PACKET_BODY_LEN: u16 = 16; + +fn new_udp_packet(f: F, udp_body: &[u8]) -> ZCPacket +where + F: FnOnce(&mut UDPTunnelHeader), +{ + let mut buf = BytesMut::new(); + buf.resize(UDP_TUNNEL_HEADER_SIZE + udp_body.len(), 0); + buf[UDP_TUNNEL_HEADER_SIZE..].copy_from_slice(udp_body); + + let mut ret = ZCPacket::new_from_buf(buf, ZCPacketType::UDP); + let header = ret.mut_udp_tunnel_header().unwrap(); + f(header); + ret +} + +pub(crate) fn new_hole_punch_packet(tid: u32, buf_len: u16) -> ZCPacket { + let mut rng = rand::rngs::StdRng::from_entropy(); + let mut buf = vec![0u8; buf_len as usize]; + rng.fill(&mut buf[..]); + new_udp_packet( + |header| { + header.msg_type = UdpPacketType::HolePunch as u8; + header.conn_id.set(tid); + header.len.set(buf_len); + }, + &buf, + ) +} + +pub(crate) fn hole_punch_packet_tid(data: &[u8], body_len: u16) -> Option { + if data.len() != UDP_TUNNEL_HEADER_SIZE + body_len as usize { + return None; + } + + let header = UDPTunnelHeader::ref_from_prefix(data)?; + let valid = header.msg_type == UdpPacketType::HolePunch as u8 && header.len.get() == body_len; + + valid.then(|| header.conn_id.get()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn builds_and_parses_hole_punch_packet() { + let tid = 0x1234_5678; + let packet = new_hole_punch_packet(tid, HOLE_PUNCH_PACKET_BODY_LEN); + let bytes = packet.into_bytes(); + + assert_eq!( + bytes.len(), + UDP_TUNNEL_HEADER_SIZE + HOLE_PUNCH_PACKET_BODY_LEN as usize + ); + assert_eq!( + hole_punch_packet_tid(&bytes, HOLE_PUNCH_PACKET_BODY_LEN), + Some(tid) + ); + } + + #[test] + fn rejects_non_matching_hole_punch_packet_length() { + let packet = new_hole_punch_packet(1, HOLE_PUNCH_PACKET_BODY_LEN); + let mut bytes = packet.into_bytes().to_vec(); + bytes.pop(); + + assert_eq!( + hole_punch_packet_tid(&bytes, HOLE_PUNCH_PACKET_BODY_LEN), + None + ); + } +} diff --git a/vendor/easytier/easytier-core/src/packet/mod.rs b/vendor/easytier/easytier-core/src/packet/mod.rs new file mode 100644 index 0000000..705ada8 --- /dev/null +++ b/vendor/easytier/easytier-core/src/packet/mod.rs @@ -0,0 +1,974 @@ +pub(crate) mod compressor; +mod hole_punch; +pub mod stun; + +pub(crate) use hole_punch::{ + HOLE_PUNCH_PACKET_BODY_LEN, hole_punch_packet_tid, new_hole_punch_packet, +}; + +use bytes::Buf; +use bytes::Bytes; +use bytes::BytesMut; +use easytier_proto::common::CompressionAlgoPb; +use zerocopy::AsBytes; +use zerocopy::FromBytes; +use zerocopy::FromZeroes; +use zerocopy::byteorder::*; + +type DefaultEndian = LittleEndian; + +const fn max(a: usize, b: usize) -> usize { + [a, b][(a < b) as usize] +} + +// TCP TunnelHeader +#[repr(C, packed)] +#[derive(AsBytes, FromBytes, FromZeroes, Clone, Debug, Default)] +pub struct TCPTunnelHeader { + pub len: U32, +} +pub const TCP_TUNNEL_HEADER_SIZE: usize = std::mem::size_of::(); + +#[derive(AsBytes, FromZeroes, Clone, Debug)] +#[repr(u8)] +pub enum UdpPacketType { + Invalid = 0, + Syn = 1, + Sack = 2, + Data = 3, + Fin = 4, + HolePunch = 5, + V4HolePunch = 6, // when receiving v4 hole punch packet, the packet contains a socket addr of other peer, we + // will send a hole punch packet to that peer. we only accept this packet from loopback interface. + V6HolePunch = 7, // when receiving v6 hole punch packet, the packet contains a socket addr of other peer, we + // will send a hole punch packet to that peer. we only accept this packet from lookback interface. +} + +#[repr(C, packed)] +#[derive(AsBytes, FromBytes, FromZeroes, Clone, Debug, Default)] +pub struct V4HolePunchPacket { + pub dst_ipv4: [u8; 4], + pub dst_port: U16, +} + +#[repr(C, packed)] +#[derive(AsBytes, FromBytes, FromZeroes, Clone, Debug, Default)] +pub struct V6HolePunchPacket { + pub dst_ipv6: [u8; 16], + pub dst_port: U16, + pub preferred_src_ipv6: [u8; 16], + pub preferred_src_ifindex: U32, +} + +#[repr(C, packed)] +#[derive(AsBytes, FromBytes, FromZeroes, Clone, Debug, Default)] +pub struct UDPTunnelHeader { + pub conn_id: U32, + pub msg_type: u8, + pub padding: u8, + pub len: U16, +} +pub const UDP_TUNNEL_HEADER_SIZE: usize = std::mem::size_of::(); + +#[repr(C, packed)] +#[derive(AsBytes, FromBytes, FromZeroes, Clone, Debug, Default)] +pub struct WGTunnelHeader { + pub ipv4_header: [u8; 20], +} +pub const WG_TUNNEL_HEADER_SIZE: usize = std::mem::size_of::(); + +#[derive(AsBytes, FromZeroes, Copy, Clone, Debug)] +#[repr(u8)] +pub enum PacketType { + Invalid = 0, + Data = 1, + HandShake = 2, + RoutePacket = 3, // deprecated + Ping = 4, + Pong = 5, + TaRpc = 6, // deprecated + Route = 7, // deprecated + RpcReq = 8, + RpcResp = 9, + ForeignNetworkPacket = 10, + KcpSrc = 11, + KcpDst = 12, + QuicSrc = 16, + QuicDst = 17, + NoiseHandshakeMsg1 = 13, + NoiseHandshakeMsg2 = 14, + NoiseHandshakeMsg3 = 15, + RelayHandshake = 20, + RelayHandshakeAck = 21, + + // used internally, + DataWithKcpSrcModified = 18, + DataWithQuicSrcModified = 19, +} + +bitflags::bitflags! { + struct PeerManagerHeaderFlags: u8 { + const ENCRYPTED = 0b0000_0001; + const LATENCY_FIRST = 0b0000_0010; + const EXIT_NODE = 0b0000_0100; + const NO_PROXY = 0b0000_1000; + const COMPRESSED = 0b0001_0000; + // deprecated flags, can be reused. + const LIVENESS_PROBE = 0b0010_0000; + const NOT_SEND_TO_TUN = 0b0100_0000; + const LIVENESS_ECHO = 0b1000_0000; + + const _ = !0; + } +} + +#[repr(C, packed)] +#[derive(AsBytes, FromBytes, FromZeroes, Clone, Debug, Default)] +pub struct PeerManagerHeader { + pub from_peer_id: U32, + pub to_peer_id: U32, + pub packet_type: u8, + pub flags: u8, + pub forward_counter: u8, + reserved: u8, + pub len: U32, +} +pub const PEER_MANAGER_HEADER_SIZE: usize = std::mem::size_of::(); + +impl PeerManagerHeader { + pub fn is_encrypted(&self) -> bool { + PeerManagerHeaderFlags::from_bits(self.flags) + .unwrap() + .contains(PeerManagerHeaderFlags::ENCRYPTED) + } + + pub fn set_encrypted(&mut self, encrypted: bool) { + let mut flags = PeerManagerHeaderFlags::from_bits(self.flags).unwrap(); + if encrypted { + flags.insert(PeerManagerHeaderFlags::ENCRYPTED); + } else { + flags.remove(PeerManagerHeaderFlags::ENCRYPTED); + } + self.flags = flags.bits(); + } + + pub fn is_latency_first(&self) -> bool { + PeerManagerHeaderFlags::from_bits(self.flags) + .unwrap() + .contains(PeerManagerHeaderFlags::LATENCY_FIRST) + } + + pub fn is_exit_node(&self) -> bool { + PeerManagerHeaderFlags::from_bits(self.flags) + .unwrap() + .contains(PeerManagerHeaderFlags::EXIT_NODE) + } + + pub fn is_no_proxy(&self) -> bool { + PeerManagerHeaderFlags::from_bits(self.flags) + .unwrap() + .contains(PeerManagerHeaderFlags::NO_PROXY) + } + + pub fn is_compressed(&self) -> bool { + PeerManagerHeaderFlags::from_bits(self.flags) + .unwrap() + .contains(PeerManagerHeaderFlags::COMPRESSED) + } + + pub fn set_latency_first(&mut self, latency_first: bool) -> &mut Self { + let mut flags = PeerManagerHeaderFlags::from_bits(self.flags).unwrap(); + if latency_first { + flags.insert(PeerManagerHeaderFlags::LATENCY_FIRST); + } else { + flags.remove(PeerManagerHeaderFlags::LATENCY_FIRST); + } + self.flags = flags.bits(); + self + } + + pub fn set_exit_node(&mut self, exit_node: bool) -> &mut Self { + let mut flags = PeerManagerHeaderFlags::from_bits(self.flags).unwrap(); + if exit_node { + flags.insert(PeerManagerHeaderFlags::EXIT_NODE); + } else { + flags.remove(PeerManagerHeaderFlags::EXIT_NODE); + } + self.flags = flags.bits(); + self + } + + pub fn set_no_proxy(&mut self, no_proxy: bool) -> &mut Self { + let mut flags = PeerManagerHeaderFlags::from_bits(self.flags).unwrap(); + if no_proxy { + flags.insert(PeerManagerHeaderFlags::NO_PROXY); + } else { + flags.remove(PeerManagerHeaderFlags::NO_PROXY); + } + self.flags = flags.bits(); + self + } + + pub fn set_compressed(&mut self, compressed: bool) -> &mut Self { + let mut flags = PeerManagerHeaderFlags::from_bits(self.flags).unwrap(); + if compressed { + flags.insert(PeerManagerHeaderFlags::COMPRESSED); + } else { + flags.remove(PeerManagerHeaderFlags::COMPRESSED); + } + self.flags = flags.bits(); + self + } + + pub(crate) fn liveness_probe_token(&self) -> Option { + PeerManagerHeaderFlags::from_bits(self.flags) + .unwrap() + .contains(PeerManagerHeaderFlags::LIVENESS_PROBE) + .then_some(self.reserved) + } + + pub(crate) fn liveness_echo_token(&self) -> Option { + PeerManagerHeaderFlags::from_bits(self.flags) + .unwrap() + .contains(PeerManagerHeaderFlags::LIVENESS_ECHO) + .then_some(self.reserved) + } + + pub(crate) fn set_liveness_probe(&mut self, token: u8) { + self.set_liveness_marker(PeerManagerHeaderFlags::LIVENESS_PROBE, token); + } + + pub(crate) fn set_liveness_echo(&mut self, token: u8) { + self.set_liveness_marker(PeerManagerHeaderFlags::LIVENESS_ECHO, token); + } + + pub(crate) fn clear_liveness_marker(&mut self) { + let mut flags = PeerManagerHeaderFlags::from_bits(self.flags).unwrap(); + flags + .remove(PeerManagerHeaderFlags::LIVENESS_PROBE | PeerManagerHeaderFlags::LIVENESS_ECHO); + self.flags = flags.bits(); + self.reserved = 0; + } + + fn set_liveness_marker(&mut self, marker: PeerManagerHeaderFlags, token: u8) { + self.clear_liveness_marker(); + let mut flags = PeerManagerHeaderFlags::from_bits(self.flags).unwrap(); + flags.insert(marker); + self.flags = flags.bits(); + self.reserved = token; + } + + pub fn mark_kcp_src_modified(&mut self) -> &mut Self { + assert_eq!(self.packet_type, PacketType::Data as u8); + self.packet_type = PacketType::DataWithKcpSrcModified as u8; + self + } + + pub fn mark_quic_src_modified(&mut self) -> &mut Self { + assert_eq!(self.packet_type, PacketType::Data as u8); + self.packet_type = PacketType::DataWithQuicSrcModified as u8; + self + } + + pub fn set_not_send_to_tun(&mut self, not_send_to_tun: bool) -> &mut Self { + let mut flags = PeerManagerHeaderFlags::from_bits(self.flags).unwrap(); + if not_send_to_tun { + flags.insert(PeerManagerHeaderFlags::NOT_SEND_TO_TUN); + } else { + flags.remove(PeerManagerHeaderFlags::NOT_SEND_TO_TUN); + } + self.flags = flags.bits(); + self + } + + pub fn is_not_send_to_tun(&self) -> bool { + PeerManagerHeaderFlags::from_bits(self.flags) + .unwrap() + .contains(PeerManagerHeaderFlags::NOT_SEND_TO_TUN) + } +} + +#[repr(C, packed)] +#[derive(AsBytes, FromBytes, FromZeroes, Clone, Debug, Default)] +pub struct ForeignNetworkPacketHeader { + pub header_len: U16, + pub dst_peer_id: U32, + pub network_name_offset: U16, + pub network_name_len: U16, + /* variable length network_name string */ +} + +impl ForeignNetworkPacketHeader { + pub fn new(dst_peer_id: u32, network_name: &str) -> Self { + let network_name_offset = std::mem::size_of::() as u16; + let network_name_len = network_name.len() as u16; + let header_len = network_name_offset + network_name_len; + Self { + header_len: U16::new(header_len), + dst_peer_id: U32::new(dst_peer_id), + network_name_offset: U16::new(network_name_offset), + network_name_len: U16::new(network_name_len), + } + } + + pub fn get_network_name(&self, zc_packet_payload: &[u8]) -> String { + let offset = self.network_name_offset.get() as usize; + let len = self.network_name_len.get() as usize; + std::str::from_utf8(&zc_packet_payload[offset..offset + len]) + .unwrap() + .to_string() + } + + pub fn get_dst_peer_id(&self) -> u32 { + self.dst_peer_id.get() + } + + pub fn get_header_len(&self) -> usize { + self.header_len.get() as usize + } +} + +// reserve space for AEAD authentication tag and nonce +#[repr(C, packed)] +#[derive(AsBytes, FromBytes, FromZeroes, Clone, Debug)] +pub struct AeadTail { + pub tag: [u8; TAG_SIZE], + pub nonce: [u8; NONCE_SIZE], +} + +impl AeadTail { + pub const TAG_SIZE: usize = TAG_SIZE; + pub const NONCE_SIZE: usize = NONCE_SIZE; + + pub const SIZE: usize = std::mem::size_of::(); +} + +pub type StandardAeadTail = AeadTail<16, 12>; + +#[derive(AsBytes, FromZeroes, Clone, Debug, Copy, PartialEq, Hash, Eq)] +#[repr(u8)] +pub enum CompressorAlgo { + None = 0, + ZstdDefault = 1, +} + +impl CompressorAlgo { + pub fn is_available(self) -> bool { + match self { + Self::None => true, + Self::ZstdDefault => compressor::zstd_available(), + } + } + + pub fn ensure_available(self) -> Result<(), CompressionUnavailableError> { + self.is_available() + .then_some(()) + .ok_or(CompressionUnavailableError(self)) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)] +#[error("invalid compression algorithm: {0:?}")] +pub struct CompressionAlgoError(pub CompressionAlgoPb); + +#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)] +#[error("compression algorithm is unavailable in this build: {0:?}")] +pub struct CompressionUnavailableError(pub CompressorAlgo); + +impl TryFrom for CompressorAlgo { + type Error = CompressionAlgoError; + + fn try_from(value: CompressionAlgoPb) -> Result { + match value { + CompressionAlgoPb::Zstd => Ok(CompressorAlgo::ZstdDefault), + CompressionAlgoPb::None => Ok(CompressorAlgo::None), + _ => Err(CompressionAlgoError(value)), + } + } +} + +impl TryFrom for CompressionAlgoPb { + type Error = CompressionAlgoError; + + fn try_from(value: CompressorAlgo) -> Result { + match value { + CompressorAlgo::ZstdDefault => Ok(CompressionAlgoPb::Zstd), + CompressorAlgo::None => Ok(CompressionAlgoPb::None), + } + } +} + +#[repr(C, packed)] +#[derive(AsBytes, FromBytes, FromZeroes, Clone, Debug, Default)] +pub struct CompressorTail { + pub algo: u8, +} +pub const COMPRESSOR_TAIL_SIZE: usize = std::mem::size_of::(); + +impl CompressorTail { + pub fn get_algo(&self) -> Option { + match self.algo { + 1 => Some(CompressorAlgo::ZstdDefault), + _ => None, + } + } + + pub fn new(algo: CompressorAlgo) -> Self { + Self { algo: algo as u8 } + } +} + +pub const TAIL_RESERVED_SIZE: usize = max(StandardAeadTail::SIZE, COMPRESSOR_TAIL_SIZE); + +#[derive(Default, Debug)] +pub struct ZCPacketOffsets { + pub payload_offset: usize, + pub peer_manager_header_offset: usize, + pub tcp_tunnel_header_offset: usize, + pub udp_tunnel_header_offset: usize, + pub wg_tunnel_header_offset: usize, + pub dummy_tunnel_header_offset: usize, +} + +#[derive(Debug, Clone, Copy, PartialEq)] +pub enum ZCPacketType { + // received from peer tcp connection + TCP, + // received from peer udp connection + UDP, + // received from peer wireguard connection + WG, + // received from local tun device, should reserve header space for tcp or udp tunnel + NIC, + // tunnel without header + DummyTunnel, +} + +const PAYLOAD_OFFSET_FOR_NIC_PACKET: usize = max( + max(TCP_TUNNEL_HEADER_SIZE, UDP_TUNNEL_HEADER_SIZE), + WG_TUNNEL_HEADER_SIZE, +) + PEER_MANAGER_HEADER_SIZE; + +// UDP Tunnel: TUN MTU + 24 (Easy) + 20 (Encrypted) + 8(UDP) + 20(IP) = TUN MTU + 72 +// TCP Tunnel: TUN MTU + 20 (Easy) + 20 (Encrypted) + 20(TCP) + 20(IP) = TUN MTU + 80 + +const INVALID_OFFSET: usize = usize::MAX; + +const fn get_converted_offset(old_hdr_size: usize, new_hdr_size: usize) -> usize { + if old_hdr_size < new_hdr_size { + INVALID_OFFSET + } else { + old_hdr_size - new_hdr_size + } +} + +impl ZCPacketType { + pub fn get_packet_offsets(&self) -> ZCPacketOffsets { + match self { + ZCPacketType::TCP => ZCPacketOffsets { + payload_offset: TCP_TUNNEL_HEADER_SIZE + PEER_MANAGER_HEADER_SIZE, + peer_manager_header_offset: TCP_TUNNEL_HEADER_SIZE, + tcp_tunnel_header_offset: 0, + udp_tunnel_header_offset: get_converted_offset( + TCP_TUNNEL_HEADER_SIZE, + UDP_TUNNEL_HEADER_SIZE, + ), + wg_tunnel_header_offset: get_converted_offset( + TCP_TUNNEL_HEADER_SIZE, + WG_TUNNEL_HEADER_SIZE, + ), + dummy_tunnel_header_offset: get_converted_offset(TCP_TUNNEL_HEADER_SIZE, 0), + }, + ZCPacketType::UDP => ZCPacketOffsets { + payload_offset: UDP_TUNNEL_HEADER_SIZE + PEER_MANAGER_HEADER_SIZE, + peer_manager_header_offset: UDP_TUNNEL_HEADER_SIZE, + tcp_tunnel_header_offset: get_converted_offset( + UDP_TUNNEL_HEADER_SIZE, + TCP_TUNNEL_HEADER_SIZE, + ), + udp_tunnel_header_offset: 0, + wg_tunnel_header_offset: get_converted_offset( + UDP_TUNNEL_HEADER_SIZE, + WG_TUNNEL_HEADER_SIZE, + ), + dummy_tunnel_header_offset: get_converted_offset(UDP_TUNNEL_HEADER_SIZE, 0), + }, + ZCPacketType::WG => ZCPacketOffsets { + payload_offset: WG_TUNNEL_HEADER_SIZE + PEER_MANAGER_HEADER_SIZE, + peer_manager_header_offset: WG_TUNNEL_HEADER_SIZE, + tcp_tunnel_header_offset: get_converted_offset( + WG_TUNNEL_HEADER_SIZE, + TCP_TUNNEL_HEADER_SIZE, + ), + udp_tunnel_header_offset: get_converted_offset( + WG_TUNNEL_HEADER_SIZE, + UDP_TUNNEL_HEADER_SIZE, + ), + wg_tunnel_header_offset: 0, + dummy_tunnel_header_offset: get_converted_offset(WG_TUNNEL_HEADER_SIZE, 0), + }, + ZCPacketType::NIC => ZCPacketOffsets { + payload_offset: PAYLOAD_OFFSET_FOR_NIC_PACKET, + peer_manager_header_offset: PAYLOAD_OFFSET_FOR_NIC_PACKET + - PEER_MANAGER_HEADER_SIZE, + tcp_tunnel_header_offset: PAYLOAD_OFFSET_FOR_NIC_PACKET + - PEER_MANAGER_HEADER_SIZE + - TCP_TUNNEL_HEADER_SIZE, + udp_tunnel_header_offset: PAYLOAD_OFFSET_FOR_NIC_PACKET + - PEER_MANAGER_HEADER_SIZE + - UDP_TUNNEL_HEADER_SIZE, + wg_tunnel_header_offset: PAYLOAD_OFFSET_FOR_NIC_PACKET + - PEER_MANAGER_HEADER_SIZE + - WG_TUNNEL_HEADER_SIZE, + dummy_tunnel_header_offset: PAYLOAD_OFFSET_FOR_NIC_PACKET + - PEER_MANAGER_HEADER_SIZE, + }, + ZCPacketType::DummyTunnel => ZCPacketOffsets { + payload_offset: PEER_MANAGER_HEADER_SIZE, + peer_manager_header_offset: 0, + tcp_tunnel_header_offset: get_converted_offset(0, TCP_TUNNEL_HEADER_SIZE), + udp_tunnel_header_offset: get_converted_offset(0, UDP_TUNNEL_HEADER_SIZE), + wg_tunnel_header_offset: get_converted_offset(0, WG_TUNNEL_HEADER_SIZE), + dummy_tunnel_header_offset: 0, + }, + } + } +} + +#[derive(Debug, Clone)] +pub struct ZCPacket { + inner: BytesMut, + packet_type: ZCPacketType, +} + +impl ZCPacket { + fn bytes_from_offset(&self, offset: usize) -> Option<&[u8]> { + self.inner.get(offset..) + } + + fn mut_bytes_from_offset(&mut self, offset: usize) -> Option<&mut [u8]> { + self.inner.get_mut(offset..) + } + + pub fn new_nic_packet() -> Self { + Self { + inner: BytesMut::new(), + packet_type: ZCPacketType::NIC, + } + } + + pub fn new_from_buf(buf: BytesMut, packet_type: ZCPacketType) -> Self { + Self { + inner: buf, + packet_type, + } + } + + pub fn new_with_payload(payload: &[u8]) -> Self { + let mut ret = Self::new_nic_packet(); + let payload_off = ret.packet_type.get_packet_offsets().payload_offset; + let total_len = payload_off + payload.len(); + ret.inner.reserve(total_len); + unsafe { ret.inner.set_len(total_len) }; + ret.mut_payload().copy_from_slice(payload); + ret + } + + pub fn new_for_tun(cap: usize, packet_info_len: usize) -> Self { + let mut ret = Self::new_nic_packet(); + ret.inner.reserve(cap); + let total_len = ret.packet_type.get_packet_offsets().payload_offset - packet_info_len; + unsafe { ret.inner.set_len(total_len) }; + ret + } + + pub fn new_for_foreign_network( + network_name: &String, + dst_peer_id: u32, + foreign_zc_packet: &ZCPacket, + ) -> Self { + let foreign_network_hdr = ForeignNetworkPacketHeader::new(dst_peer_id, network_name); + let total_payload_len = + foreign_network_hdr.get_header_len() + foreign_zc_packet.tunnel_payload().len(); + + let mut ret = Self::new_nic_packet(); + let payload_off = ret.packet_type.get_packet_offsets().payload_offset; + ret.inner.reserve(payload_off + total_payload_len); + unsafe { ret.inner.set_len(payload_off + total_payload_len) }; + + let fixed_hdr_len = std::mem::size_of::(); + ret.mut_payload()[..fixed_hdr_len].copy_from_slice(foreign_network_hdr.as_bytes()); + + let name_offset = foreign_network_hdr.network_name_offset.get() as usize; + let name_len = foreign_network_hdr.network_name_len.get() as usize; + ret.mut_payload()[name_offset..name_offset + name_len] + .copy_from_slice(network_name.as_bytes()); + + ret.mut_payload()[foreign_network_hdr.get_header_len()..] + .copy_from_slice(foreign_zc_packet.tunnel_payload()); + + ret.fill_peer_manager_hdr(0, 0, PacketType::ForeignNetworkPacket as u8); + + ret + } + + pub fn packet_type(&self) -> ZCPacketType { + self.packet_type + } + + pub fn payload_offset(&self) -> usize { + self.packet_type.get_packet_offsets().payload_offset + } + + pub fn mut_payload(&mut self) -> &mut [u8] { + let offset = self.payload_offset(); + &mut self.inner[offset..] + } + + pub fn mut_peer_manager_header(&mut self) -> Option<&mut PeerManagerHeader> { + let offset = self + .packet_type + .get_packet_offsets() + .peer_manager_header_offset; + let bytes = self.mut_bytes_from_offset(offset)?; + PeerManagerHeader::mut_from_prefix(bytes) + } + + pub fn mut_tcp_tunnel_header(&mut self) -> Option<&mut TCPTunnelHeader> { + let offset = self + .packet_type + .get_packet_offsets() + .tcp_tunnel_header_offset; + let bytes = self.mut_bytes_from_offset(offset)?; + TCPTunnelHeader::mut_from_prefix(bytes) + } + + pub fn mut_udp_tunnel_header(&mut self) -> Option<&mut UDPTunnelHeader> { + let offset = self + .packet_type + .get_packet_offsets() + .udp_tunnel_header_offset; + let bytes = self.mut_bytes_from_offset(offset)?; + UDPTunnelHeader::mut_from_prefix(bytes) + } + + pub fn mut_wg_tunnel_header(&mut self) -> Option<&mut WGTunnelHeader> { + let offset = self + .packet_type + .get_packet_offsets() + .wg_tunnel_header_offset; + let bytes = self.mut_bytes_from_offset(offset)?; + WGTunnelHeader::mut_from_prefix(bytes) + } + + // ref versions + pub fn payload(&self) -> &[u8] { + &self.inner[self.payload_offset()..] + } + + pub fn payload_bytes(mut self) -> BytesMut { + self.inner.advance(self.payload_offset()); + self.inner + } + + pub fn peer_manager_header(&self) -> Option<&PeerManagerHeader> { + let offset = self + .packet_type + .get_packet_offsets() + .peer_manager_header_offset; + let bytes = self.bytes_from_offset(offset)?; + PeerManagerHeader::ref_from_prefix(bytes) + } + + pub fn udp_tunnel_header(&self) -> Option<&UDPTunnelHeader> { + let offset = self + .packet_type + .get_packet_offsets() + .udp_tunnel_header_offset; + let bytes = self.bytes_from_offset(offset)?; + UDPTunnelHeader::ref_from_prefix(bytes) + } + + pub fn udp_payload(&self) -> &[u8] { + &self.inner[self + .packet_type + .get_packet_offsets() + .udp_tunnel_header_offset + + UDP_TUNNEL_HEADER_SIZE..] + } + + pub fn udp_payload_bytes(mut self) -> BytesMut { + self.inner.advance( + self.packet_type + .get_packet_offsets() + .udp_tunnel_header_offset + + UDP_TUNNEL_HEADER_SIZE, + ); + self.inner + } + + pub fn payload_len(&self) -> usize { + self.inner.len() - self.payload_offset() + } + + pub fn buf_len(&self) -> usize { + self.inner.len() + } + + pub fn fill_peer_manager_hdr(&mut self, from_peer_id: u32, to_peer_id: u32, packet_type: u8) { + let payload_len = self.payload_len(); + let hdr = self.mut_peer_manager_header().unwrap(); + hdr.from_peer_id.set(from_peer_id); + hdr.to_peer_id.set(to_peer_id); + hdr.packet_type = packet_type; + hdr.flags = 0; + hdr.forward_counter = 1; + hdr.reserved = 0; + hdr.len.set(payload_len as u32); + } + + pub fn tunnel_payload(&self) -> &[u8] { + &self.inner[self + .packet_type + .get_packet_offsets() + .peer_manager_header_offset..] + } + + pub fn tunnel_payload_bytes(mut self) -> BytesMut { + self.inner.advance( + self.packet_type + .get_packet_offsets() + .peer_manager_header_offset, + ); + self.inner + } + + pub fn convert_type(mut self, target_packet_type: ZCPacketType) -> Self { + if target_packet_type == self.packet_type { + return self; + } + + let new_offset = match target_packet_type { + ZCPacketType::TCP => { + self.packet_type + .get_packet_offsets() + .tcp_tunnel_header_offset + } + ZCPacketType::UDP => { + self.packet_type + .get_packet_offsets() + .udp_tunnel_header_offset + } + ZCPacketType::WG => { + self.packet_type + .get_packet_offsets() + .wg_tunnel_header_offset + } + ZCPacketType::DummyTunnel => { + self.packet_type + .get_packet_offsets() + .dummy_tunnel_header_offset + } + ZCPacketType::NIC => unreachable!(), + }; + + tracing::trace!(?self.packet_type, ?target_packet_type, ?new_offset, "convert zc packet type"); + + if new_offset == INVALID_OFFSET { + // copy peer manager header and payload to new buffer + let tunnel_payload = self.tunnel_payload(); + let new_pm_offset = target_packet_type + .get_packet_offsets() + .peer_manager_header_offset; + let mut buf = BytesMut::with_capacity(new_pm_offset + tunnel_payload.len()); + unsafe { buf.set_len(new_pm_offset) }; + buf.extend_from_slice(tunnel_payload); + return Self::new_from_buf(buf, target_packet_type); + } + + self.inner.advance(new_offset); + Self::new_from_buf(self.inner, target_packet_type) + } + + pub fn into_bytes(self) -> Bytes { + self.inner.freeze() + } + + pub fn inner(self) -> BytesMut { + self.inner + } + + pub fn mut_inner(&mut self) -> &mut BytesMut { + &mut self.inner + } + + pub fn is_lossy(&self) -> bool { + self.peer_manager_header() + .map(|hdr| hdr.packet_type == PacketType::Data as u8) + .unwrap_or(false) + } + + pub fn foreign_network_hdr(&self) -> Option<&ForeignNetworkPacketHeader> { + if self.peer_manager_header().unwrap().packet_type == PacketType::ForeignNetworkPacket as u8 + { + ForeignNetworkPacketHeader::ref_from_prefix(self.payload()) + } else { + None + } + } + + pub fn foreign_network_inner_packet_type(&self) -> Option { + self.foreign_network_inner_packet_info() + .map(|(hdr, _)| hdr.packet_type) + } + + pub fn foreign_network_inner_packet_info(&self) -> Option<(&PeerManagerHeader, usize)> { + if self.peer_manager_header()?.packet_type != PacketType::ForeignNetworkPacket as u8 { + return None; + } + + let payload = self.payload(); + let hdr = ForeignNetworkPacketHeader::ref_from_prefix(payload)?; + let inner_packet = payload.get(hdr.get_header_len()..)?; + let peer_manager_header = PeerManagerHeader::ref_from_prefix(inner_packet)?; + let payload_len = inner_packet.len() - PEER_MANAGER_HEADER_SIZE; + Some((peer_manager_header, payload_len)) + } + + pub fn foreign_network_packet(mut self) -> Self { + let hdr = self.foreign_network_hdr().unwrap(); + let foreign_hdr_len = hdr.get_header_len(); + + Self::new_from_buf( + { + self.inner.advance(foreign_hdr_len + self.payload_offset()); + self.inner + }, + ZCPacketType::DummyTunnel, + ) + } + + pub fn get_src_peer_id(&self) -> Option { + self.peer_manager_header().map(|hdr| hdr.from_peer_id.get()) + } + + pub fn get_dst_peer_id(&self) -> Option { + self.peer_manager_header().map(|hdr| hdr.to_peer_id.get()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[cfg(feature = "proxy-packet")] + impl PeerManagerHeader { + pub(crate) fn is_kcp_src_modified(&self) -> bool { + self.packet_type == PacketType::DataWithKcpSrcModified as u8 + } + + pub(crate) fn is_quic_src_modified(&self) -> bool { + self.packet_type == PacketType::DataWithQuicSrcModified as u8 + } + } + + impl ZCPacket { + fn tcp_tunnel_header(&self) -> Option<&TCPTunnelHeader> { + let offset = self + .packet_type + .get_packet_offsets() + .tcp_tunnel_header_offset; + let bytes = self.bytes_from_offset(offset)?; + TCPTunnelHeader::ref_from_prefix(bytes) + } + } + + #[test] + fn test_zc_packet() { + let payload = b"hello world"; + let mut packet = ZCPacket::new_with_payload(payload); + let peer_manager_header = packet.mut_peer_manager_header().unwrap(); + peer_manager_header.packet_type = PacketType::Data as u8; + peer_manager_header.len.set(payload.len() as u32); + + let tcp_tunnel_header = packet.mut_tcp_tunnel_header().unwrap(); + tcp_tunnel_header.len.set(payload.len() as u32); + + // let udp_tunnel_header = packet.mut_udp_tunnel_header().unwrap(); + // udp_tunnel_header.conn_id = 1; + // udp_tunnel_header.msg_type = 2; + // udp_tunnel_header.len = payload.len() as u32; + + assert_eq!(packet.payload(), b"hello world"); + assert_eq!(packet.payload_len(), 11); + println!("{:?}", packet.inner); + + let tcp_packet = packet.convert_type(ZCPacketType::TCP).into_bytes(); + assert_eq!(&tcp_packet[..1], b"\x0b"); + println!("{:?}", tcp_packet); + } + + #[test] + fn test_short_tcp_packet_header_access_is_safe() { + let mut packet = ZCPacket::new_from_buf(BytesMut::from(&b"\x01"[..]), ZCPacketType::TCP); + + assert!(packet.peer_manager_header().is_none()); + assert!(packet.tcp_tunnel_header().is_none()); + assert!(packet.udp_tunnel_header().is_none()); + assert!(packet.mut_peer_manager_header().is_none()); + assert!(packet.mut_tcp_tunnel_header().is_none()); + assert!(packet.mut_udp_tunnel_header().is_none()); + assert!(packet.mut_wg_tunnel_header().is_none()); + } + + #[test] + fn test_invalid_converted_header_offset_is_safe() { + let mut packet = ZCPacket::new_from_buf(BytesMut::from(&b"\x01"[..]), ZCPacketType::UDP); + + assert!(packet.mut_wg_tunnel_header().is_none()); + } + + #[test] + fn converts_compression_algo_none() { + assert_eq!( + CompressorAlgo::None, + CompressorAlgo::try_from(CompressionAlgoPb::None).unwrap() + ); + assert_eq!( + CompressionAlgoPb::None, + CompressionAlgoPb::try_from(CompressorAlgo::None).unwrap() + ); + } + + #[test] + fn converts_zstd_compression_algo_in_every_profile() { + assert_eq!( + CompressorAlgo::ZstdDefault, + CompressorAlgo::try_from(CompressionAlgoPb::Zstd).unwrap() + ); + assert_eq!( + CompressionAlgoPb::Zstd, + CompressionAlgoPb::try_from(CompressorAlgo::ZstdDefault).unwrap() + ); + assert_eq!( + Some(CompressorAlgo::ZstdDefault), + CompressorTail { algo: 1 }.get_algo() + ); + } + + #[cfg(not(feature = "zstd"))] + #[test] + fn reports_zstd_as_unavailable_without_changing_vocabulary() { + assert!(!CompressorAlgo::ZstdDefault.is_available()); + assert_eq!( + CompressorAlgo::ZstdDefault.ensure_available().unwrap_err(), + CompressionUnavailableError(CompressorAlgo::ZstdDefault) + ); + } + + #[cfg(feature = "zstd")] + #[test] + fn reports_zstd_as_available_when_compiled() { + assert!(CompressorAlgo::ZstdDefault.is_available()); + } +} diff --git a/vendor/easytier/easytier-core/src/packet/stun.rs b/vendor/easytier/easytier-core/src/packet/stun.rs new file mode 100644 index 0000000..9ff60cb --- /dev/null +++ b/vendor/easytier/easytier-core/src/packet/stun.rs @@ -0,0 +1,319 @@ +//! STUN wire codec for the attributes EasyTier NAT traversal uses. +//! +//! EasyTier speaks STUN (RFC 5389/5780) for NAT mapping detection and port +//! mapping. This module holds the wire-level attribute types, their codecs, +//! and the EasyTier transaction-id convention (a `0xdeadbeef` prefix); it +//! performs no I/O. The connectivity layer drives probing and responding on +//! top of it. + +use std::net::SocketAddr; + +use bytecodec::fixnum::{U32beDecoder, U32beEncoder}; +use bytecodec::{ByteCount, Decode, Encode, Eos, Result}; +use bytecodec::{SizedEncode, TryTaggedDecode}; +use stun_codec::macros::track; +use stun_codec::net::{SocketAddrDecoder, SocketAddrEncoder, socket_addr_xor}; +use stun_codec::rfc5389::attributes::{ + MappedAddress, Software, XorMappedAddress, XorMappedAddress2, +}; +use stun_codec::rfc5780::attributes::{OtherAddress, ResponseOrigin}; +use stun_codec::{AttributeType, Message, TransactionId, define_attribute_enums}; + +macro_rules! impl_decode { + ($decoder:ty, $item:ident, $and_then:expr) => { + impl Decode for $decoder { + type Item = $item; + + fn decode(&mut self, buf: &[u8], eos: Eos) -> Result { + track!(self.0.decode(buf, eos)) + } + + fn finish_decoding(&mut self) -> Result { + track!(self.0.finish_decoding()).and_then($and_then) + } + + fn requiring_bytes(&self) -> ByteCount { + self.0.requiring_bytes() + } + + fn is_idle(&self) -> bool { + self.0.is_idle() + } + } + impl TryTaggedDecode for $decoder { + type Tag = AttributeType; + + fn try_start_decoding(&mut self, attr_type: Self::Tag) -> Result { + Ok(attr_type.as_u16() == $item::CODEPOINT) + } + } + }; +} + +macro_rules! impl_encode { + ($encoder:ty, $item:ty, $map_from:expr) => { + impl Encode for $encoder { + type Item = $item; + + fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result { + track!(self.0.encode(buf, eos)) + } + + #[allow(clippy::redundant_closure_call)] + fn start_encoding(&mut self, item: Self::Item) -> Result<()> { + track!(self.0.start_encoding($map_from(item))) + } + + fn requiring_bytes(&self) -> ByteCount { + self.0.requiring_bytes() + } + + fn is_idle(&self) -> bool { + self.0.is_idle() + } + } + impl SizedEncode for $encoder { + fn exact_requiring_bytes(&self) -> u64 { + self.0.exact_requiring_bytes() + } + } + }; +} + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct ChangedAddress(SocketAddr); +impl ChangedAddress { + /// The codepoint of the type of the attribute. + pub const CODEPOINT: u16 = 0x0005; + + pub fn new(addr: SocketAddr) -> Self { + ChangedAddress(addr) + } + + /// Returns the address of this instance. + pub fn address(&self) -> SocketAddr { + self.0 + } +} +impl stun_codec::Attribute for ChangedAddress { + type Decoder = ChangedAddressDecoder; + type Encoder = ChangedAddressEncoder; + + fn get_type(&self) -> AttributeType { + AttributeType::new(Self::CODEPOINT) + } + + fn before_encode( + &mut self, + message: &Message, + ) -> bytecodec::Result<()> { + self.0 = socket_addr_xor(self.0, message.transaction_id()); + Ok(()) + } + + fn after_decode( + &mut self, + message: &Message, + ) -> bytecodec::Result<()> { + self.0 = socket_addr_xor(self.0, message.transaction_id()); + Ok(()) + } +} + +#[derive(Debug, Default)] +pub struct ChangedAddressDecoder(SocketAddrDecoder); +impl ChangedAddressDecoder { + pub fn new() -> Self { + Self::default() + } +} +impl_decode!(ChangedAddressDecoder, ChangedAddress, |item| Ok( + ChangedAddress(item) +)); + +#[derive(Debug, Default)] +pub struct ChangedAddressEncoder(SocketAddrEncoder); +impl ChangedAddressEncoder { + pub fn new() -> Self { + Self::default() + } +} +impl_encode!(ChangedAddressEncoder, ChangedAddress, |item: Self::Item| { + item.0 +}); + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct SourceAddress(SocketAddr); +impl SourceAddress { + /// The codepoint of the type of the attribute. + pub const CODEPOINT: u16 = 0x0004; + + pub fn new(addr: SocketAddr) -> Self { + SourceAddress(addr) + } + + /// Returns the address of this instance. + pub fn address(&self) -> SocketAddr { + self.0 + } +} +impl stun_codec::Attribute for SourceAddress { + type Decoder = SourceAddressDecoder; + type Encoder = SourceAddressEncoder; + + fn get_type(&self) -> AttributeType { + AttributeType::new(Self::CODEPOINT) + } + + fn before_encode( + &mut self, + message: &Message, + ) -> bytecodec::Result<()> { + self.0 = socket_addr_xor(self.0, message.transaction_id()); + Ok(()) + } + + fn after_decode( + &mut self, + message: &Message, + ) -> bytecodec::Result<()> { + self.0 = socket_addr_xor(self.0, message.transaction_id()); + Ok(()) + } +} + +#[derive(Debug, Default)] +pub struct SourceAddressDecoder(SocketAddrDecoder); +impl SourceAddressDecoder { + pub fn new() -> Self { + Self::default() + } +} +impl_decode!(SourceAddressDecoder, SourceAddress, |item| Ok( + SourceAddress(item) +)); + +#[derive(Debug, Default)] +pub struct SourceAddressEncoder(SocketAddrEncoder); +impl SourceAddressEncoder { + pub fn new() -> Self { + Self::default() + } +} +impl_encode!(SourceAddressEncoder, SourceAddress, |item: Self::Item| { + item.0 +}); + +/// `CHANGE-REQUEST` attribute. +/// +/// See [RFC 5780 -- 7.2. CHANGE-REQUEST] about this attribute. +/// +/// [RFC 5780 -- 7.2. CHANGE-REQUEST]: https://tools.ietf.org/html/rfc5780#section-7.2 +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct ChangeRequest(bool, bool); + +impl ChangeRequest { + /// The codepoint of the type of the attribute. + pub const CODEPOINT: u16 = 0x0003; + + /// Makes a new `ChangeRequest` instance. + pub fn new(ip: bool, port: bool) -> Self { + ChangeRequest(ip, port) + } + + /// Returns whether the client requested the server to send the Binding Response with a + /// different IP address than the one the Binding Request was received on + pub fn ip(&self) -> bool { + self.0 + } + + /// Returns whether the client requested the server to send the Binding Response with a + /// different port than the one the Binding Request was received on + pub fn port(&self) -> bool { + self.1 + } +} + +impl stun_codec::Attribute for ChangeRequest { + type Decoder = ChangeRequestDecoder; + type Encoder = ChangeRequestEncoder; + + fn get_type(&self) -> AttributeType { + AttributeType::new(Self::CODEPOINT) + } +} + +/// [`ChangeRequest`] decoder. +#[derive(Debug, Default)] +pub struct ChangeRequestDecoder(U32beDecoder); + +impl ChangeRequestDecoder { + /// Makes a new `ChangeRequestDecoder` instance. + pub fn new() -> Self { + Self::default() + } +} +impl_decode!(ChangeRequestDecoder, ChangeRequest, |item| { + Ok(ChangeRequest((item & 0x4) != 0, (item & 0x2) != 0)) +}); + +/// [`ChangeRequest`] encoder. +#[derive(Debug, Default)] +pub struct ChangeRequestEncoder(U32beEncoder); + +impl ChangeRequestEncoder { + /// Makes a new `ChangeRequestEncoder` instance. + pub fn new() -> Self { + Self::default() + } +} +impl_encode!(ChangeRequestEncoder, ChangeRequest, |item: Self::Item| { + let ip = item.0 as u8; + let port = item.1 as u8; + ((ip << 1 | port) << 1) as u32 +}); + +pub fn tid_to_u32(tid: &TransactionId) -> u32 { + let mut tid_buf = [0u8; 4]; + // copy bytes from msg_tid to tid_buf + tid_buf[..].copy_from_slice(&tid.as_bytes()[8..12]); + u32::from_le_bytes(tid_buf) +} + +pub fn u32_to_tid(tid: u32) -> TransactionId { + let tid_buf = tid.to_le_bytes(); + let mut tid_arr = [0u8; 12]; + tid_arr[..4].copy_from_slice(&0xdeadbeefu32.to_be_bytes()); + tid_arr[8..12].copy_from_slice(&tid_buf); + TransactionId::new(tid_arr) +} + +define_attribute_enums!( + Attribute, + AttributeDecoder, + AttributeEncoder, + [ + Software, + MappedAddress, + XorMappedAddress, + XorMappedAddress2, + OtherAddress, + ChangeRequest, + ChangedAddress, + SourceAddress, + ResponseOrigin + ] +); + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn easytier_transaction_id_roundtrips_u32() { + let tid = u32_to_tid(0x1122_3344); + + assert_eq!(&tid.as_bytes()[..4], &[0xde, 0xad, 0xbe, 0xef]); + assert_eq!(tid_to_u32(&tid), 0x1122_3344); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/acl/filter.rs b/vendor/easytier/easytier-core/src/peers/acl/filter.rs new file mode 100644 index 0000000..53c996d --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/acl/filter.rs @@ -0,0 +1,1027 @@ +use std::net::{Ipv4Addr, Ipv6Addr}; +use std::sync::atomic::Ordering; +use std::{ + net::IpAddr, + sync::{Arc, Mutex, atomic::AtomicBool}, +}; + +use arc_swap::ArcSwap; +use dashmap::DashMap; +use easytier_proto::acl::{Acl, AclStats, Action, ChainType, Protocol}; +use quanta::Instant; +use tokio_util::task::AbortOnDropHandle; + +use crate::{ + packet::{PacketType, ZCPacket}, + peers::acl::processor::{AclProcessor, AclResult, AclStatKey, AclStatType, PacketInfo}, +}; + +const IP_PROTO_ICMP: u8 = 1; +const IP_PROTO_TCP: u8 = 6; +const IP_PROTO_UDP: u8 = 17; +const IP_PROTO_ICMPV6: u8 = 58; +const IP_PROTO_UNSPECIFIED: u8 = u8::MAX; + +const ICMP_ECHO_REPLY: u8 = 0; +const ICMP_ECHO_REQUEST: u8 = 8; +const ICMPV6_ECHO_REQUEST: u8 = 128; +const ICMPV6_ECHO_REPLY: u8 = 129; + +const IPV6_HOP_BY_HOP: u8 = 0; +const IPV6_ROUTING: u8 = 43; +const IPV6_FRAGMENT: u8 = 44; +const IPV6_AUTHENTICATION: u8 = 51; +const IPV6_DESTINATION_OPTIONS: u8 = 60; + +#[derive(Clone, Copy)] +struct ParsedIpPacket<'a> { + src_ip: IpAddr, + dst_ip: IpAddr, + protocol: u8, + transport_payload: &'a [u8], + is_non_initial_fragment: bool, +} + +impl ParsedIpPacket<'_> { + fn can_use_allow_record(&self, is_in: bool) -> bool { + let expected_type = match (self.protocol, is_in) { + (IP_PROTO_ICMP, false) => ICMP_ECHO_REQUEST, + (IP_PROTO_ICMP, true) => ICMP_ECHO_REPLY, + (IP_PROTO_ICMPV6, false) => ICMPV6_ECHO_REQUEST, + (IP_PROTO_ICMPV6, true) => ICMPV6_ECHO_REPLY, + (IP_PROTO_UNSPECIFIED, _) => return false, + _ => return true, + }; + if self.is_non_initial_fragment { + // Tails have no ICMP header. They may use an existing response record, + // but must not create one. A reverse request still needs an allowed + // first fragment before the destination can reassemble it. + return is_in; + } + self.transport_payload.len() >= 8 + && self.transport_payload[0] == expected_type + && self.transport_payload[1] == 0 + } +} + +fn parse_ip_packet(payload: &[u8]) -> Option> { + let version = payload.first()? >> 4; + match version { + 4 => parse_ipv4_packet(payload), + 6 => parse_ipv6_packet(payload), + _ => None, + } +} + +fn parse_ipv4_packet(payload: &[u8]) -> Option> { + if payload.len() < 20 { + return None; + } + let header_len = usize::from(payload[0] & 0x0f) * 4; + let options_len = header_len.saturating_sub(20); + let payload_offset = 20 + options_len; + let payload_start = payload_offset.min(payload.len()); + let total_length = usize::from(u16::from_be_bytes([payload[2], payload[3]])); + let payload_len = total_length.saturating_sub(header_len); + let payload_end = payload_start.saturating_add(payload_len).min(payload.len()); + + Some(ParsedIpPacket { + src_ip: IpAddr::V4(Ipv4Addr::new( + payload[12], + payload[13], + payload[14], + payload[15], + )), + dst_ip: IpAddr::V4(Ipv4Addr::new( + payload[16], + payload[17], + payload[18], + payload[19], + )), + protocol: payload[9], + transport_payload: payload.get(payload_start..payload_end)?, + is_non_initial_fragment: u16::from_be_bytes([payload[6], payload[7]]) & 0x1fff != 0, + }) +} + +fn parse_ipv6_packet(payload: &[u8]) -> Option> { + if payload.len() < 40 { + return None; + } + + // A valid base header still supplies the addresses needed for ACL rules, + // even when the upper-layer headers cannot be decoded. + let parsed = ParsedIpPacket { + src_ip: IpAddr::V6(Ipv6Addr::from(<[u8; 16]>::try_from(&payload[8..24]).ok()?)), + dst_ip: IpAddr::V6(Ipv6Addr::from(<[u8; 16]>::try_from(&payload[24..40]).ok()?)), + protocol: IP_PROTO_UNSPECIFIED, + transport_payload: &[], + is_non_initial_fragment: false, + }; + + let payload_len = usize::from(u16::from_be_bytes([payload[4], payload[5]])); + let payload_end = 40usize.saturating_add(payload_len).min(payload.len()); + let mut protocol = payload[6]; + let mut payload_offset = 40; + let mut is_non_initial_fragment = false; + let mut saw_fragment_header = false; + + loop { + match protocol { + IPV6_HOP_BY_HOP | IPV6_ROUTING | IPV6_DESTINATION_OPTIONS => { + let header = &payload[payload_offset..payload_end]; + let Some(&header_len) = header.get(1) else { + return Some(parsed); + }; + let extension_len = (usize::from(header_len) + 1) * 8; + let next_protocol = header[0]; + let extension_end = payload_offset + extension_len; + if extension_end > payload_end { + return Some(parsed); + } + protocol = next_protocol; + payload_offset = extension_end; + } + IPV6_AUTHENTICATION => { + let header = &payload[payload_offset..payload_end]; + let Some(&header_len) = header.get(1) else { + return Some(parsed); + }; + let extension_len = (usize::from(header_len) + 2) * 4; + let next_protocol = header[0]; + let extension_end = payload_offset + extension_len; + if extension_end > payload_end { + return Some(parsed); + } + protocol = next_protocol; + payload_offset = extension_end; + } + IPV6_FRAGMENT => { + if saw_fragment_header { + return Some(parsed); + } + saw_fragment_header = true; + + let fragment_end = payload_offset + 8; + if fragment_end > payload_end { + return Some(parsed); + } + let header = &payload[payload_offset..fragment_end]; + let fragment_field = u16::from_be_bytes([header[2], header[3]]); + is_non_initial_fragment = fragment_field & 0xfff8 != 0; + let next_protocol = header[0]; + payload_offset = fragment_end; + + protocol = next_protocol; + if is_non_initial_fragment { + // Extension headers after the Fragment Header are only in the first + // fragment. Do not interpret tail data as an extension header. + // Only ICMPv6 tails can use the response records without a + // transport header. Leave other tails to address/group ACLs. + if protocol != IP_PROTO_ICMPV6 { + protocol = IP_PROTO_UNSPECIFIED; + } + break; + } + } + _ => break, + } + } + + let transport_payload = &payload[payload_offset..payload_end]; + if payload_offset != 40 && parse_transport_ports(protocol, transport_payload).is_none() { + return Some(parsed); + } + + Some(ParsedIpPacket { + protocol, + transport_payload, + is_non_initial_fragment, + ..parsed + }) +} + +fn parse_transport_ports(protocol: u8, payload: &[u8]) -> Option<(Option, Option)> { + let min_len = match protocol { + IP_PROTO_TCP => 20, + IP_PROTO_UDP => 8, + _ => return Some((None, None)), + }; + if payload.len() < min_len { + return None; + } + + Some(( + Some(u16::from_be_bytes([payload[0], payload[1]])), + Some(u16::from_be_bytes([payload[2], payload[3]])), + )) +} + +fn acl_protocol(protocol: u8) -> Protocol { + match protocol { + IP_PROTO_TCP => Protocol::Tcp, + IP_PROTO_UDP => Protocol::Udp, + IP_PROTO_ICMP => Protocol::Icmp, + IP_PROTO_ICMPV6 => Protocol::IcmPv6, + _ => Protocol::Unspecified, + } +} + +#[derive(Debug, Eq, PartialEq, Hash)] +struct OutboundAllowRecord { + src_ip: IpAddr, + dst_ip: IpAddr, + src_port: Option, + dst_port: Option, + protocol: Protocol, +} + +impl OutboundAllowRecord { + fn new_from_inbound_packet(p: &PacketInfo) -> Self { + Self { + src_ip: p.src_ip, + dst_ip: p.dst_ip, + src_port: p.src_port, + dst_port: p.dst_port, + protocol: p.protocol, + } + } + + fn new_from_outbound_packet(p: &PacketInfo) -> Self { + Self { + src_ip: p.dst_ip, + dst_ip: p.src_ip, + src_port: p.dst_port, + dst_port: p.src_port, + protocol: p.protocol, + } + } +} + +/// ACL filter that can be inserted into the packet processing pipeline +/// Optimized with lock-free hot reloading via atomic processor replacement +pub struct AclFilter { + // Use ArcSwap for lock-free atomic replacement during hot reload + acl_processor: ArcSwap, + acl_enabled: Arc, + + // Track allowed outbound packets and automatically allow their corresponding inbound response + // packets, even if they would normally be dropped by ACL rules + outbound_allow_records: Arc>, + #[allow(dead_code)] + clean_task: Mutex>>, +} + +impl Default for AclFilter { + fn default() -> Self { + Self::new() + } +} + +impl AclFilter { + pub fn new() -> Self { + let outbound_allow_records = Arc::new(DashMap::new()); + let record_clone = outbound_allow_records.clone(); + Self { + acl_processor: ArcSwap::from(Arc::new(AclProcessor::new(Acl::default()))), + acl_enabled: Arc::new(AtomicBool::new(false)), + outbound_allow_records, + clean_task: Mutex::new(Some(AbortOnDropHandle::new(tokio::spawn(async move { + let max_life = std::time::Duration::from_secs(30); + loop { + record_clone.retain(|_, v| v.elapsed() < max_life); + crate::foundation::time::sleep(std::time::Duration::from_secs(30)).await; + } + })))), + } + } + + pub(crate) async fn stop_cleanup_task(&self) { + let task = self.clean_task.lock().unwrap().take(); + if let Some(task) = task { + task.abort(); + let _ = task.await; + } + } + + /// Hot reload ACL rules by creating a new processor instance + /// Preserves connection tracking and rate limiting state across reloads + /// Now lock-free and doesn't require &mut self! + pub fn reload_rules(&self, acl_config: Option<&Acl>) { + self.outbound_allow_records.clear(); + + let Some(acl_config) = acl_config else { + self.acl_enabled.store(false, Ordering::Relaxed); + return; + }; + + // Get current processor to extract shared state + let current_processor = self.acl_processor.load(); + let (conn_track, rate_limiters, stats) = current_processor.get_shared_state(); + + // Create new processor with preserved state + let new_processor = AclProcessor::new_with_shared_state( + acl_config.clone(), + Some(conn_track), + Some(rate_limiters), + Some(stats), + ); + + // Atomic replacement - this is completely lock-free! + self.acl_processor.store(Arc::new(new_processor)); + self.acl_enabled.store(true, Ordering::Relaxed); + + tracing::info!("ACL rules hot reloaded with preserved state (lock-free)"); + } + + /// Get current processor for processing packets + pub fn get_processor(&self) -> Arc { + self.acl_processor.load_full() + } + + pub fn get_stats(&self) -> AclStats { + let processor = self.get_processor(); + let global_stats = processor.get_stats(); + let (conn_track, _, _) = processor.get_shared_state(); + let rules_stats = processor.get_rules_stats(); + + AclStats { + global: global_stats.into_iter().collect(), + conn_track: conn_track.iter().map(|x| *x.value()).collect(), + rules: rules_stats, + } + } + + /// Extract packet information for ACL processing + fn extract_packet_info( + &self, + packet: &ZCPacket, + is_in: bool, + route: &(dyn crate::peers::route::Route + Send + Sync + 'static), + ) -> Option<(PacketInfo, bool)> { + let payload = packet.payload(); + + let parsed = parse_ip_packet(payload)?; + let (src_port, dst_port) = + parse_transport_ports(parsed.protocol, parsed.transport_payload)?; + let acl_protocol = acl_protocol(parsed.protocol); + + let src_groups = packet + .get_src_peer_id() + .map(|peer_id| route.get_peer_groups(peer_id)) + .unwrap_or_else(|| Arc::new(Vec::new())); + let dst_groups = packet + .get_dst_peer_id() + .map(|peer_id| route.get_peer_groups(peer_id)) + .unwrap_or_else(|| Arc::new(Vec::new())); + + Some(( + PacketInfo { + src_ip: parsed.src_ip, + dst_ip: parsed.dst_ip, + src_port, + dst_port, + protocol: acl_protocol, + packet_size: payload.len(), + src_groups, + dst_groups, + }, + parsed.can_use_allow_record(is_in), + )) + } + + /// Process ACL result and log if needed + pub fn handle_acl_result( + &self, + result: &AclResult, + packet_info: &PacketInfo, + chain_type: ChainType, + processor: &AclProcessor, + ) { + if result.should_log + && let Some(ref log_context) = result.log_context + { + let log_message = log_context.to_message(); + tracing::info!( + src_ip = %packet_info.src_ip, + dst_ip = %packet_info.dst_ip, + src_port = packet_info.src_port, + dst_port = packet_info.dst_port, + src_group = packet_info.src_groups.join(","), + dst_group = packet_info.dst_groups.join(","), + protocol = ?packet_info.protocol, + action = ?result.action, + rule = result.matched_rule_str().as_deref().unwrap_or("unknown"), + chain_type = ?chain_type, + "ACL: {}", log_message + ); + } + + // Update global statistics in the ACL processor + match result.action { + Action::Allow => { + processor.increment_stat(AclStatKey::PacketsAllowed); + processor.increment_stat(AclStatKey::from_chain_and_action( + chain_type, + AclStatType::Allowed, + )); + tracing::trace!("ACL: Packet allowed"); + } + Action::Drop => { + processor.increment_stat(AclStatKey::PacketsDropped); + processor.increment_stat(AclStatKey::from_chain_and_action( + chain_type, + AclStatType::Dropped, + )); + tracing::debug!("ACL: Packet dropped"); + } + Action::Noop => { + processor.increment_stat(AclStatKey::PacketsNoop); + processor.increment_stat(AclStatKey::from_chain_and_action( + chain_type, + AclStatType::Noop, + )); + tracing::trace!("ACL: No operation"); + } + } + + // Track total packets processed per chain + processor.increment_stat(AclStatKey::from_chain_and_action( + chain_type, + AclStatType::Total, + )); + processor.increment_stat(AclStatKey::PacketsTotal); + } + + fn classify_chain_type( + is_in: bool, + packet_info: &PacketInfo, + my_ipv4: Option, + is_local_ipv6: impl Fn(Ipv6Addr) -> bool, + ) -> ChainType { + if !is_in { + return ChainType::Outbound; + } + + let is_local_dst = packet_info.dst_ip == my_ipv4.unwrap_or(Ipv4Addr::UNSPECIFIED) + || matches!(packet_info.dst_ip, IpAddr::V6(dst) if is_local_ipv6(dst)); + + if is_local_dst { + ChainType::Inbound + } else { + ChainType::Forward + } + } + + /// Common ACL processing logic + pub fn process_packet_with_acl( + &self, + packet: &ZCPacket, + is_in: bool, + my_ipv4: Option, + is_local_ipv6: impl Fn(Ipv6Addr) -> bool, + route: &(dyn crate::peers::route::Route + Send + Sync + 'static), + ) -> bool { + if !self.acl_enabled.load(Ordering::Relaxed) { + return true; + } + + if packet.peer_manager_header().unwrap().packet_type != PacketType::Data as u8 { + return true; + } + + // Extract packet information + let (packet_info, can_use_allow_record) = + match self.extract_packet_info(packet, is_in, route) { + Some(info) => info, + None => { + tracing::warn!( + "Failed to extract packet info from {:?} packet, header: {:?}", + if is_in { "inbound" } else { "outbound" }, + packet.peer_manager_header() + ); + // allow all unknown packets + return true; + } + }; + + let chain_type = Self::classify_chain_type(is_in, &packet_info, my_ipv4, is_local_ipv6); + + // Get current processor atomically + let processor = self.get_processor(); + + // Process through ACL rules + let acl_result = processor.process_packet(&packet_info, chain_type); + + self.handle_acl_result(&acl_result, &packet_info, chain_type, &processor); + + // Check if packet should be allowed + match acl_result.action { + Action::Allow | Action::Noop => { + if matches!(chain_type, ChainType::Outbound) && can_use_allow_record { + self.outbound_allow_records.insert( + OutboundAllowRecord::new_from_outbound_packet(&packet_info), + Instant::now(), + ); + } + true + } + Action::Drop => { + if is_in && can_use_allow_record { + let record = OutboundAllowRecord::new_from_inbound_packet(&packet_info); + let entry = self.outbound_allow_records.entry(record); + if let dashmap::Entry::Occupied(mut entry) = entry { + entry.insert(Instant::now()); + tracing::trace!( + "ACL: Allowing {:?} packet from {} to {} because of existing allow record, chain_type: {:?}", + packet_info.protocol, + packet_info.src_ip, + packet_info.dst_ip, + chain_type, + ); + return true; + } + } + + tracing::trace!( + "ACL: Dropping {:?} packet from {} to {}, chain_type: {:?}", + packet_info.protocol, + packet_info.src_ip, + packet_info.dst_ip, + chain_type, + ); + + false + } + } + } +} + +#[cfg(test)] +mod tests { + use std::{ + net::{IpAddr, Ipv4Addr, Ipv6Addr}, + sync::Arc, + }; + + use quanta::Instant; + + use easytier_proto::acl::{Acl, AclV1, Action, Chain, ChainType, Protocol, Rule}; + + use crate::peers::acl::processor::PacketInfo; + + use super::{ + AclFilter, ICMP_ECHO_REPLY, ICMP_ECHO_REQUEST, ICMPV6_ECHO_REPLY, ICMPV6_ECHO_REQUEST, + IP_PROTO_ICMP, IP_PROTO_ICMPV6, IP_PROTO_TCP, IP_PROTO_UDP, IP_PROTO_UNSPECIFIED, + IPV6_AUTHENTICATION, IPV6_DESTINATION_OPTIONS, IPV6_FRAGMENT, IPV6_HOP_BY_HOP, + IPV6_ROUTING, OutboundAllowRecord, PacketType, ZCPacket, acl_protocol, parse_ip_packet, + parse_transport_ports, + }; + + impl AclFilter { + pub(crate) fn cleanup_task_is_stopped(&self) -> bool { + self.clean_task.lock().unwrap().is_none() + } + } + + fn packet_info(dst_ip: IpAddr) -> PacketInfo { + PacketInfo { + src_ip: IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1)), + dst_ip, + src_port: Some(1234), + dst_port: Some(80), + protocol: Protocol::Tcp, + packet_size: 64, + src_groups: Arc::new(Vec::new()), + dst_groups: Arc::new(Vec::new()), + } + } + + #[test] + fn parse_ipv4_tcp_packet_extracts_addrs_and_ports() { + let mut packet = vec![0u8; 40]; + packet[0] = 0x45; + packet[2..4].copy_from_slice(&40u16.to_be_bytes()); + packet[9] = IP_PROTO_TCP; + packet[12..16].copy_from_slice(&[10, 0, 0, 1]); + packet[16..20].copy_from_slice(&[10, 0, 0, 2]); + packet[20..22].copy_from_slice(&1234u16.to_be_bytes()); + packet[22..24].copy_from_slice(&80u16.to_be_bytes()); + + let parsed = parse_ip_packet(&packet).unwrap(); + let (src_port, dst_port) = + parse_transport_ports(parsed.protocol, parsed.transport_payload).unwrap(); + + assert_eq!(parsed.src_ip, IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1))); + assert_eq!(parsed.dst_ip, IpAddr::V4(Ipv4Addr::new(10, 0, 0, 2))); + assert_eq!(acl_protocol(parsed.protocol), Protocol::Tcp); + assert_eq!(src_port, Some(1234)); + assert_eq!(dst_port, Some(80)); + } + + #[test] + fn parse_ipv6_udp_packet_extracts_addrs_and_ports() { + let src: Ipv6Addr = "2001:db8::1".parse().unwrap(); + let dst: Ipv6Addr = "2001:db8::2".parse().unwrap(); + let mut packet = vec![0u8; 48]; + packet[0] = 0x60; + packet[4..6].copy_from_slice(&8u16.to_be_bytes()); + packet[6] = IP_PROTO_UDP; + packet[8..24].copy_from_slice(&src.octets()); + packet[24..40].copy_from_slice(&dst.octets()); + packet[40..42].copy_from_slice(&5353u16.to_be_bytes()); + packet[42..44].copy_from_slice(&53u16.to_be_bytes()); + + let parsed = parse_ip_packet(&packet).unwrap(); + let (src_port, dst_port) = + parse_transport_ports(parsed.protocol, parsed.transport_payload).unwrap(); + + assert_eq!(parsed.src_ip, IpAddr::V6(src)); + assert_eq!(parsed.dst_ip, IpAddr::V6(dst)); + assert_eq!(acl_protocol(parsed.protocol), Protocol::Udp); + assert_eq!(src_port, Some(5353)); + assert_eq!(dst_port, Some(53)); + } + + #[test] + fn parse_ipv4_uses_declared_total_length() { + let mut packet = vec![0u8; 40]; + packet[0] = 0x45; + packet[2..4].copy_from_slice(&24u16.to_be_bytes()); + packet[9] = IP_PROTO_TCP; + packet[12..16].copy_from_slice(&[10, 0, 0, 1]); + packet[16..20].copy_from_slice(&[10, 0, 0, 2]); + packet[20..22].copy_from_slice(&1234u16.to_be_bytes()); + packet[22..24].copy_from_slice(&80u16.to_be_bytes()); + + let parsed = parse_ip_packet(&packet).unwrap(); + + assert_eq!(parsed.transport_payload.len(), 4); + assert!(parse_transport_ports(parsed.protocol, parsed.transport_payload).is_none()); + } + + #[test] + fn parse_ipv6_uses_declared_payload_length() { + let mut packet = vec![0u8; 48]; + packet[0] = 0x60; + packet[4..6].copy_from_slice(&4u16.to_be_bytes()); + packet[6] = IP_PROTO_UDP; + packet[40..42].copy_from_slice(&5353u16.to_be_bytes()); + packet[42..44].copy_from_slice(&53u16.to_be_bytes()); + + let parsed = parse_ip_packet(&packet).unwrap(); + + assert_eq!(parsed.transport_payload.len(), 4); + assert!(parse_transport_ports(parsed.protocol, parsed.transport_payload).is_none()); + } + + #[test] + fn parse_ipv4_keeps_pnet_ihl_less_than_five_behavior() { + let mut packet = vec![0u8; 40]; + packet[0] = 0x44; + packet[2..4].copy_from_slice(&40u16.to_be_bytes()); + packet[9] = IP_PROTO_TCP; + packet[20..22].copy_from_slice(&1234u16.to_be_bytes()); + packet[22..24].copy_from_slice(&80u16.to_be_bytes()); + + let parsed = parse_ip_packet(&packet).unwrap(); + let (src_port, dst_port) = + parse_transport_ports(parsed.protocol, parsed.transport_payload).unwrap(); + + assert_eq!(parsed.transport_payload.len(), 20); + assert_eq!(src_port, Some(1234)); + assert_eq!(dst_port, Some(80)); + } + + #[test] + fn parse_ipv4_keeps_pnet_truncated_options_behavior() { + let mut packet = vec![0u8; 20]; + packet[0] = 0x4f; + packet[2..4].copy_from_slice(&60u16.to_be_bytes()); + packet[9] = IP_PROTO_ICMP; + packet[12..16].copy_from_slice(&[10, 0, 0, 1]); + packet[16..20].copy_from_slice(&[10, 0, 0, 2]); + + let parsed = parse_ip_packet(&packet).unwrap(); + let (src_port, dst_port) = + parse_transport_ports(parsed.protocol, parsed.transport_payload).unwrap(); + + assert_eq!(parsed.src_ip, IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1))); + assert_eq!(parsed.dst_ip, IpAddr::V4(Ipv4Addr::new(10, 0, 0, 2))); + assert_eq!(acl_protocol(parsed.protocol), Protocol::Icmp); + assert!(parsed.transport_payload.is_empty()); + assert_eq!(src_port, None); + assert_eq!(dst_port, None); + } + + #[test] + fn classify_chain_type_treats_public_ipv6_lease_as_inbound() { + let leased_ipv6 = Ipv6Addr::new(0x2001, 0xdb8, 0x100, 0, 0, 0, 0, 0x123); + let packet_info = packet_info(IpAddr::V6(leased_ipv6)); + + let chain = + AclFilter::classify_chain_type(true, &packet_info, None, |ip| ip == leased_ipv6); + + assert_eq!(chain, ChainType::Inbound); + } + + #[test] + fn classify_chain_type_keeps_non_local_ipv6_as_forward() { + let leased_ipv6 = Ipv6Addr::new(0x2001, 0xdb8, 0x100, 0, 0, 0, 0, 0x123); + let packet_info = packet_info(IpAddr::V6(Ipv6Addr::new( + 0x2001, 0xdb8, 0xffff, 2, 0, 0, 0, 0x100, + ))); + + let chain = + AclFilter::classify_chain_type(true, &packet_info, None, |ip| ip == leased_ipv6); + + assert_eq!(chain, ChainType::Forward); + } + + // Include both an extension header and a Fragment Header in IPv6 packets. + // Offset zero uses an atomic fragment; IPv4 uses an unfragmented packet. + fn icmp_packet(ipv6: bool, message_type: u8, fragment_offset: u16) -> Vec { + let mut packet = if ipv6 { + let mut packet = vec![0u8; 64]; + packet[0] = 0x60; + packet[4..6].copy_from_slice(&24u16.to_be_bytes()); + packet[6] = IPV6_HOP_BY_HOP; + packet[40] = IPV6_FRAGMENT; + packet[48] = IP_PROTO_ICMPV6; + packet[50..52].copy_from_slice(&(fragment_offset << 3).to_be_bytes()); + packet + } else { + let mut packet = vec![0u8; 28]; + packet[0] = 0x45; + packet[2..4].copy_from_slice(&28u16.to_be_bytes()); + packet[6..8].copy_from_slice(&fragment_offset.to_be_bytes()); + packet[9] = IP_PROTO_ICMP; + packet + }; + let icmp_offset = packet.len() - 8; + packet[icmp_offset] = message_type; + packet + } + + #[test] + fn icmp_allow_records_only_accept_requests_outbound_and_replies_inbound() { + for (ipv6, request, reply) in [ + (false, ICMP_ECHO_REQUEST, ICMP_ECHO_REPLY), + (true, ICMPV6_ECHO_REQUEST, ICMPV6_ECHO_REPLY), + ] { + for (message_type, is_in) in [(request, false), (reply, true)] { + let mut packet = icmp_packet(ipv6, message_type, 0); + let parsed = parse_ip_packet(&packet).unwrap(); + assert!(parsed.can_use_allow_record(is_in)); + assert!(!parsed.can_use_allow_record(!is_in)); + + // The same checks apply to first fragments with more data pending. + if ipv6 { + packet[51] |= 1; + } else { + packet[6] |= 0x20; + } + let parsed = parse_ip_packet(&packet).unwrap(); + assert!(!parsed.is_non_initial_fragment); + assert!(parsed.can_use_allow_record(is_in)); + assert!(!parsed.can_use_allow_record(!is_in)); + + let code_offset = packet.len() - 7; + packet[code_offset] = 1; + assert!( + !parse_ip_packet(&packet) + .unwrap() + .can_use_allow_record(is_in) + ); + packet[code_offset] = 0; + packet.pop(); + assert!( + !parse_ip_packet(&packet) + .unwrap() + .can_use_allow_record(is_in) + ); + } + let packet = icmp_packet(ipv6, 3, 0); + let parsed = parse_ip_packet(&packet).unwrap(); + assert!(!parsed.can_use_allow_record(false)); + assert!(!parsed.can_use_allow_record(true)); + + // Tail bytes can look like a request, but are not an ICMP header. + let packet = icmp_packet(ipv6, request, 1); + let parsed = parse_ip_packet(&packet).unwrap(); + assert!(parsed.is_non_initial_fragment); + assert!(parsed.can_use_allow_record(true)); + assert!(!parsed.can_use_allow_record(false)); + } + } + + #[test] + fn ipv6_fragment_tails_do_not_infer_icmp_from_payload() { + let mut packet = icmp_packet(true, ICMPV6_ECHO_REPLY, 1); + packet[48] = IPV6_DESTINATION_OPTIONS; + packet[56] = IP_PROTO_ICMPV6; + let parsed = parse_ip_packet(&packet).unwrap(); + assert_eq!(parsed.protocol, IP_PROTO_UNSPECIFIED); + assert!(!parsed.can_use_allow_record(true)); + + packet[48] = IP_PROTO_UDP; + let parsed = parse_ip_packet(&packet).unwrap(); + assert_eq!(acl_protocol(parsed.protocol), Protocol::Unspecified); + assert!(!parsed.can_use_allow_record(true)); + } + + #[test] + fn parse_ipv6_keeps_addresses_when_fragment_header_exceeds_declared_payload() { + let mut packet = icmp_packet(true, ICMPV6_ECHO_REPLY, 0); + packet[4..6].copy_from_slice(&12u16.to_be_bytes()); + let parsed = parse_ip_packet(&packet).unwrap(); + assert_eq!(parsed.protocol, IP_PROTO_UNSPECIFIED); + assert!(!parsed.can_use_allow_record(true)); + } + + struct TestRoute; + + #[async_trait::async_trait] + impl crate::peers::route::Route for TestRoute { + async fn open(&self, _: crate::peers::route::RouteInterfaceBox) -> Result { + unreachable!() + } + async fn close(&self) { + unreachable!() + } + async fn get_next_hop(&self, _: u32) -> Option { + unreachable!() + } + async fn list_routes(&self) -> Vec { + unreachable!() + } + async fn list_proxy_cidrs(&self) -> std::collections::BTreeSet { + unreachable!() + } + async fn list_proxy_cidrs_v6(&self) -> std::collections::BTreeSet { + unreachable!() + } + async fn get_peer_info(&self, _: u32) -> Option { + unreachable!() + } + async fn get_peer_info_last_update_time(&self) -> Instant { + unreachable!() + } + fn get_peer_groups(&self, _: u32) -> Arc> { + Arc::new(vec![]) + } + } + + fn assert_ipv6_unknown_payload_follows_acl(next_header: u8, payload: &[u8]) { + let src: Ipv6Addr = "2001:db8::1".parse().unwrap(); + let dst: Ipv6Addr = "2001:db8::2".parse().unwrap(); + let mut bytes = vec![0u8; 40]; + bytes[0] = 0x60; + bytes[4..6].copy_from_slice(&(payload.len() as u16).to_be_bytes()); + bytes[6] = next_header; + bytes[8..24].copy_from_slice(&src.octets()); + bytes[24..40].copy_from_slice(&dst.octets()); + bytes.extend_from_slice(payload); + let mut packet = ZCPacket::new_with_payload(&bytes); + packet.fill_peer_manager_hdr(1, 2, PacketType::Data as u8); + let filter = AclFilter::new(); + let (info, can_use_allow_record) = filter + .extract_packet_info(&packet, true, &TestRoute) + .unwrap(); + assert_eq!(info.src_ip, IpAddr::V6(src)); + assert_eq!(info.dst_ip, IpAddr::V6(dst)); + assert_eq!(info.protocol, Protocol::Unspecified); + assert_eq!((info.src_port, info.dst_port), (None, None)); + assert!(!can_use_allow_record); + + // Unknown payloads still obey the chain policy, and cannot match a + // transport port rule using bytes that only happen to look like ports. + for action in [Action::Drop, Action::Allow] { + filter.reload_rules(Some(&Acl { + acl_v1: Some(AclV1 { + chains: vec![Chain { + name: "inbound".into(), + chain_type: ChainType::Inbound as i32, + enabled: true, + default_action: action as i32, + rules: [Protocol::Tcp, Protocol::Udp] + .into_iter() + .map(|protocol| Rule { + name: format!("allow_{protocol:?}_8081"), + enabled: true, + action: Action::Allow as i32, + protocol: protocol as i32, + ports: vec!["8081".into()], + ..Default::default() + }) + .collect(), + ..Default::default() + }], + ..Default::default() + }), + })); + assert_eq!( + filter.process_packet_with_acl(&packet, true, None, |ip| ip == dst, &TestRoute), + action == Action::Allow, + ); + assert!(filter.process_packet_with_acl(&packet, false, None, |_| false, &TestRoute)); + assert!(filter.outbound_allow_records.is_empty()); + } + } + + #[tokio::test] + async fn ipv6_malformed_extension_headers_follow_acl() { + for protocol in [ + IPV6_HOP_BY_HOP, + IPV6_ROUTING, + IPV6_DESTINATION_OPTIONS, + IPV6_AUTHENTICATION, + IPV6_FRAGMENT, + ] { + for len in [0, 1, 4, 7] { + assert_ipv6_unknown_payload_follows_acl(protocol, &vec![0; len]); + } + } + // The length field extends beyond the available option/AH header. + for protocol in [IPV6_HOP_BY_HOP, IPV6_AUTHENTICATION] { + assert_ipv6_unknown_payload_follows_acl(protocol, &[IP_PROTO_UDP, 2, 0, 0, 0, 0, 0, 0]); + } + // A second Fragment Header must not reach the global parse-failure path. + assert_ipv6_unknown_payload_follows_acl( + IPV6_FRAGMENT, + &[ + IPV6_FRAGMENT, + 0, + 0, + 0, + 0, + 0, + 0, + 1, + IP_PROTO_ICMPV6, + 0, + 0, + 0, + 0, + 0, + 0, + 2, + ], + ); + // A valid extension header followed by a truncated transport header. + for protocol in [IP_PROTO_TCP, IP_PROTO_UDP] { + assert_ipv6_unknown_payload_follows_acl( + IPV6_HOP_BY_HOP, + &[protocol, 0, 0, 0, 0, 0, 0, 0, 0x12, 0x34, 0x1f, 0x91], + ); + } + } + + #[tokio::test] + async fn ipv6_transport_fragment_tails_follow_acl() { + for protocol in [IP_PROTO_TCP, IP_PROTO_UDP] { + for len in [4, 8, 24] { + let mut payload = vec![protocol, 0, 0, 8, 0, 0, 0, 1]; + payload.extend_from_slice(&[0x12, 0x34, 0x1f, 0x91]); + payload.resize(8 + len, 0); + assert_ipv6_unknown_payload_follows_acl(IPV6_FRAGMENT, &payload); + } + } + } + + #[tokio::test] + async fn reload_rules_clears_outbound_allow_records() { + let filter = AclFilter::new(); + filter.outbound_allow_records.insert( + OutboundAllowRecord { + src_ip: IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1)), + dst_ip: IpAddr::V4(Ipv4Addr::new(10, 0, 0, 2)), + src_port: Some(1234), + dst_port: Some(80), + protocol: Protocol::Tcp, + }, + Instant::now(), + ); + assert_eq!(filter.outbound_allow_records.len(), 1); + + filter.reload_rules(Some(&Acl::default())); + + assert_eq!(filter.outbound_allow_records.len(), 0); + + filter.outbound_allow_records.insert( + OutboundAllowRecord { + src_ip: IpAddr::V4(Ipv4Addr::new(10, 0, 0, 2)), + dst_ip: IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1)), + src_port: Some(4321), + dst_port: Some(443), + protocol: Protocol::Tcp, + }, + Instant::now(), + ); + assert_eq!(filter.outbound_allow_records.len(), 1); + + filter.reload_rules(None); + + assert_eq!(filter.outbound_allow_records.len(), 0); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/acl/mod.rs b/vendor/easytier/easytier-core/src/peers/acl/mod.rs new file mode 100644 index 0000000..139e254 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/acl/mod.rs @@ -0,0 +1,7 @@ +//! Access-control list packet filtering: the per-rule processor and the +//! filter wiring it into the peer/NIC packet pipelines. + +pub(crate) mod filter; +pub(crate) mod processor; + +pub(crate) use filter::AclFilter; diff --git a/vendor/easytier/easytier-core/src/peers/acl/processor.rs b/vendor/easytier/easytier-core/src/peers/acl/processor.rs new file mode 100644 index 0000000..b1913fe --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/acl/processor.rs @@ -0,0 +1,1519 @@ +use std::{ + collections::{HashMap, HashSet}, + net::{IpAddr, SocketAddr}, + str::FromStr as _, + sync::Arc, + time::{Duration, SystemTime, UNIX_EPOCH}, +}; + +use quanta::Instant; + +use crate::foundation::token_bucket::TokenBucket; +use dashmap::DashMap; +use easytier_proto::acl::*; +use tokio::task::JoinSet; + +// Performance-optimized key for rate limiting to avoid string allocations +#[derive(Debug, Clone, Hash, PartialEq, Eq)] +pub struct RateLimitKey { + pub chain_type: ChainType, + pub rule_priority: u32, +} + +impl RateLimitKey { + pub fn new(chain_type: ChainType, rule_priority: u32) -> Self { + Self { + chain_type, + rule_priority, + } + } +} + +/// Value wrapper for rate limiters with last update timestamp +pub struct RateLimitValue { + pub token_bucket: Arc, + pub last_update: Instant, +} + +// Performance-optimized rule identifier to avoid string allocations +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum RuleId { + Priority(u32), + Stateful(u32), + Default, +} + +impl RuleId { + /// Convert to string only when actually needed (lazy evaluation) + pub fn to_string_cached(&self) -> String { + match self { + RuleId::Priority(p) => p.to_string(), + RuleId::Stateful(p) => format!("stateful-{}", p), + RuleId::Default => "default".to_string(), + } + } + + /// Get string representation for logging (optimized for hot path) + pub fn as_str(&self) -> String { + self.to_string_cached() + } +} + +// Fast lookup structures for performance optimization +#[derive(Debug, Clone)] +pub struct FastLookupRule { + pub priority: u32, + pub protocol: Protocol, + pub src_ip_ranges: Vec, + pub dst_ip_ranges: Vec, + pub src_port_ranges: Vec<(u16, u16)>, + pub dst_port_ranges: Vec<(u16, u16)>, + pub source_groups: HashSet, + pub destination_groups: HashSet, + pub action: Action, + pub enabled: bool, + pub stateful: bool, + pub rate_limit: u32, + pub burst_limit: u32, + pub rule_stats: Arc, +} + +// Cache key combining packet info and chain type +#[derive(Debug, Clone, Hash, PartialEq, Eq)] +pub struct AclCacheKey { + pub chain_type: ChainType, + pub protocol: Protocol, + pub src_ip: IpAddr, + pub dst_ip: IpAddr, + pub src_port: u16, + pub dst_port: u16, + pub src_groups: Arc>, + pub dst_groups: Arc>, +} + +impl AclCacheKey { + pub fn from_packet_info(packet_info: &PacketInfo, chain_type: ChainType) -> Self { + Self { + chain_type, + protocol: packet_info.protocol, + src_ip: packet_info.src_ip, + dst_ip: packet_info.dst_ip, + src_port: packet_info.src_port.unwrap_or(0), + dst_port: packet_info.dst_port.unwrap_or(0), + src_groups: packet_info.src_groups.clone(), + dst_groups: packet_info.dst_groups.clone(), + } + } +} + +// Cache entry with timestamp for LRU cleanup +#[derive(Debug, Clone)] +pub(crate) struct AclCacheEntry { + pub matched_rule: RuleId, + pub last_access: Instant, + // New fields to track rule characteristics for proper cache behavior + pub conn_track_key: Option, + pub rate_limit_keys: Vec, + pub acl_result: Option, + pub rule_stats_vec: Vec>, +} + +// Packet info extracted for ACL processing +#[derive(Debug, Clone, Hash, PartialEq, Eq)] +pub struct PacketInfo { + pub src_ip: IpAddr, + pub dst_ip: IpAddr, + pub src_port: Option, + pub dst_port: Option, + pub protocol: Protocol, + pub packet_size: usize, + pub src_groups: Arc>, + pub dst_groups: Arc>, +} + +// ACL processing result +#[derive(Debug, Clone)] +pub struct AclResult { + pub action: Action, + pub matched_rule: Option, + pub should_log: bool, + pub log_context: Option, +} + +impl AclResult { + /// Get matched rule as string reference for logging (compatibility method) + pub fn matched_rule_str(&self) -> Option { + self.matched_rule.as_ref().map(|r| r.as_str()) + } +} + +// Context for lazy log message construction +#[derive(Debug, Clone)] +pub enum AclLogContext { + StatefulMatch { + src_ip: IpAddr, + dst_ip: IpAddr, + }, + RuleMatch { + src_ip: IpAddr, + dst_ip: IpAddr, + action: Action, + }, + DefaultDrop, + DefaultAllow, + UnsupportedChainType, + RateLimitDrop, +} + +impl AclLogContext { + pub fn to_message(&self) -> String { + match self { + AclLogContext::StatefulMatch { src_ip, dst_ip } => { + format!("Stateful match: {} -> {}", src_ip, dst_ip) + } + AclLogContext::RuleMatch { + src_ip, + dst_ip, + action, + } => { + format!("Rule match: {} -> {} action: {:?}", src_ip, dst_ip, action) + } + AclLogContext::DefaultDrop => "No matching rule, default drop".to_string(), + AclLogContext::DefaultAllow => "No matching rule, default allow".to_string(), + AclLogContext::UnsupportedChainType => "Unsupported chain type".to_string(), + AclLogContext::RateLimitDrop => "Rate limit drop".to_string(), + } + } +} + +pub type SharedState = ( + Arc>, + Arc>, + Arc>, +); + +// High-performance ACL processor - No more internal locks! +pub struct AclProcessor { + // Immutable rule vectors - no locks needed since they're never modified after creation + inbound_rules: Vec, + outbound_rules: Vec, + forward_rules: Vec, + + default_inbound_action: Action, + default_outbound_action: Action, + default_forward_action: Action, + + default_rule_stats: Arc, + + // Connection tracking table - shared across different processor instances if needed + conn_track: Arc>, + + // Rate limiting buckets per rule using TokenBucket with optimized keys + rate_limiters: Arc>, + + // Rule lookup cache with LRU cleanup + rule_cache: Arc>, + cache_max_size: usize, + cache_cleanup_interval: Duration, + + // Statistics + stats: Arc>, + + tasks: JoinSet<()>, +} + +impl AclProcessor { + /// Create a new ACL processor with pre-built immutable rules + /// This is the main constructor that should be used + pub fn new(acl_config: Acl) -> Self { + Self::new_with_shared_state(acl_config, None, None, None) + } + + /// Create a new ACL processor while preserving connection tracking and rate limiting state + /// This is useful for hot reloading where you want to preserve established connections + pub fn new_with_shared_state( + acl_config: Acl, + conn_track: Option>>, + rate_limiters: Option>>, + stats: Option>>, + ) -> Self { + let (inbound_rules, outbound_rules, forward_rules) = Self::build_rules(&acl_config); + let (default_inbound_action, default_outbound_action, default_forward_action) = + Self::build_default_actions(&acl_config); + let tasks = JoinSet::new(); + + let mut processor = Self { + inbound_rules, + outbound_rules, + forward_rules, + + default_inbound_action, + default_outbound_action, + default_forward_action, + + default_rule_stats: Arc::new(RuleStats { + rule: None, + stat: Some(StatItem { + packet_count: 0, + byte_count: 0, + }), + }), + conn_track: conn_track.unwrap_or_else(|| Arc::new(DashMap::new())), + rate_limiters: rate_limiters.unwrap_or_else(|| Arc::new(DashMap::new())), + rule_cache: Arc::new(DashMap::new()), // Always start with fresh cache + cache_max_size: 1024, // Limit cache to 1k entries + cache_cleanup_interval: Duration::from_secs(20), // Cleanup every 5 minutes + stats: stats.unwrap_or_else(|| Arc::new(DashMap::new())), + tasks, + }; + + processor.start_cache_cleanup_task(); + processor + } + + fn build_default_actions(acl_config: &Acl) -> (Action, Action, Action) { + let default_inbound_action = acl_config + .acl_v1 + .as_ref() + .and_then(|v1| { + v1.chains + .iter() + .find(|c| c.chain_type == ChainType::Inbound as i32) + }) + .map(|c| c.default_action()) + .unwrap_or(Action::Allow); + + let default_outbound_action = acl_config + .acl_v1 + .as_ref() + .and_then(|v1| { + v1.chains + .iter() + .find(|c| c.chain_type == ChainType::Outbound as i32) + }) + .map(|c| c.default_action()) + .unwrap_or(Action::Allow); + + let default_forward_action = acl_config + .acl_v1 + .as_ref() + .and_then(|v1| { + v1.chains + .iter() + .find(|c| c.chain_type == ChainType::Forward as i32) + }) + .map(|c| c.default_action()) + .unwrap_or(Action::Allow); + + ( + default_inbound_action, + default_outbound_action, + default_forward_action, + ) + } + + /// Build all rule vectors from configuration + fn build_rules( + acl_config: &Acl, + ) -> ( + Vec, + Vec, + Vec, + ) { + let mut inbound_rules = Vec::new(); + let mut outbound_rules = Vec::new(); + let mut forward_rules = Vec::new(); + + // Build new rule vectors + if let Some(ref acl_v1) = acl_config.acl_v1 { + for chain in &acl_v1.chains { + if !chain.enabled { + continue; + } + + let mut rules = chain + .rules + .iter() + .filter(|rule| rule.enabled) + .map(Self::convert_to_fast_lookup_rule) + .collect::>(); + + // Sort by priority (higher priority first) + rules.sort_by_key(|r| std::cmp::Reverse(r.priority)); + + match chain.chain_type() { + ChainType::Inbound => inbound_rules.extend(rules), + ChainType::Outbound => outbound_rules.extend(rules), + ChainType::Forward => forward_rules.extend(rules), + _ => {} + } + } + } + + tracing::info!( + "ACL rules built: {} inbound, {} outbound, {} forward", + inbound_rules.len(), + outbound_rules.len(), + forward_rules.len(), + ); + + (inbound_rules, outbound_rules, forward_rules) + } + + /// Start periodic cache cleanup task + fn start_cache_cleanup_task(&mut self) { + let rate_limiters = self.rate_limiters.clone(); + let rule_cache = self.rule_cache.clone(); + let cache_max_size = self.cache_max_size; + let cleanup_interval = self.cache_cleanup_interval; + + self.tasks.spawn(async move { + let mut interval = crate::foundation::time::interval(cleanup_interval); + loop { + interval.tick().await; + Self::cleanup_cache(&rule_cache, cache_max_size); + rule_cache.shrink_to_fit(); + + rate_limiters.retain(|_, v| v.last_update.elapsed() < cleanup_interval); + rate_limiters.shrink_to_fit(); + } + }); + + let conn_track = self.conn_track.clone(); + self.tasks.spawn(async move { + let mut interval = crate::foundation::time::interval(cleanup_interval); + loop { + interval.tick().await; + Self::cleanup_expired_connections(conn_track.clone(), 60); + conn_track.shrink_to_fit(); + } + }); + } + + /// Clean up cache using LRU strategy + fn cleanup_cache(cache: &DashMap, max_size: usize) { + // remove cache not be used in last 15 second + let expired_timepoint = Instant::now() + .checked_sub(Duration::from_secs(15)) + .unwrap_or(Instant::now()); + cache.retain(|_, entry| entry.last_access > expired_timepoint); + + let current_size = cache.len(); + if current_size <= max_size { + return; + } + + // Remove oldest entries (LRU cleanup) + let mut entries: Vec<(AclCacheKey, Instant)> = cache + .iter() + .map(|entry| (entry.key().clone(), entry.value().last_access)) + .collect(); + + // Sort by last_access (oldest first) + entries.sort_by_key(|(_, last_access)| *last_access); + + // Remove oldest 20% of entries + let to_remove = current_size - max_size + (max_size / 5); + for (key, _) in entries.into_iter().take(to_remove) { + cache.remove(&key); + } + + tracing::debug!( + "Cache cleanup completed: removed {} entries, current size: {}", + to_remove, + cache.len() + ); + } + + pub(crate) fn process_packet_with_cache_entry( + &self, + packet_info: &PacketInfo, + cache_entry: &AclCacheEntry, + ) -> AclResult { + for rate_limit_key in cache_entry.rate_limit_keys.iter() { + // bucket should already be created, so rate and burst are not important + if !self.check_rate_limit(rate_limit_key, 1, 1, false) { + return AclResult { + action: Action::Drop, + matched_rule: Some(cache_entry.matched_rule.clone()), + should_log: false, + log_context: Some(AclLogContext::RateLimitDrop), + }; + } + } + + if let Some(conn_track_key) = cache_entry.conn_track_key.as_ref() { + self.check_connection_state(conn_track_key, packet_info); + } + + self.inc_cache_entry_stats(cache_entry, packet_info); + + cache_entry.acl_result.clone().unwrap() + } + + fn inc_cache_entry_stats(&self, cache_entry: &AclCacheEntry, packet_info: &PacketInfo) { + for rule_stats in cache_entry.rule_stats_vec.iter() { + // Use unsafe code to mutate the contents behind the Arc + let stat_ptr = rule_stats.stat.as_ref().unwrap() as *const StatItem as *mut StatItem; + unsafe { + (*stat_ptr).packet_count += 1; + (*stat_ptr).byte_count += packet_info.packet_size as u64; + } + } + } + + pub fn get_rules_stats(&self) -> Vec { + let mut stats: Vec = Vec::new(); + for rule in self.inbound_rules.iter() { + stats.push((*rule.rule_stats).clone()); + } + for rule in self.outbound_rules.iter() { + stats.push((*rule.rule_stats).clone()); + } + for rule in self.forward_rules.iter() { + stats.push((*rule.rule_stats).clone()); + } + stats + } + + /// Process a packet through ACL rules - Now lock-free! + pub fn process_packet(&self, packet_info: &PacketInfo, chain_type: ChainType) -> AclResult { + // Check cache first for performance + let cache_key = AclCacheKey::from_packet_info(packet_info, chain_type); + + // If cache hit and can skip checks, return cached result + if let Some(mut cached) = self.rule_cache.get_mut(&cache_key) { + // Update last access time for LRU + cached.last_access = Instant::now(); + + self.increment_stat(AclStatKey::CacheHits); + return self.process_packet_with_cache_entry(packet_info, &cached); + } + + // Direct access to rules - no locks needed! + let rules = match chain_type { + ChainType::Inbound => &self.inbound_rules, + ChainType::Outbound => &self.outbound_rules, + ChainType::Forward => &self.forward_rules, + _ => { + return AclResult { + action: Action::Drop, + matched_rule: Some(RuleId::Default), + should_log: false, + log_context: Some(AclLogContext::UnsupportedChainType), + }; + } + }; + + let mut cache_entry = AclCacheEntry { + matched_rule: RuleId::Default, + last_access: Instant::now(), + conn_track_key: None, + rate_limit_keys: vec![], + acl_result: None, + rule_stats_vec: vec![], + }; + + // Process rules in priority order + for rule in rules.iter() { + if !rule.enabled || !self.rule_matches(rule, packet_info) { + continue; + } + + // Check rate limiting if configured + if rule.rate_limit > 0 { + let rule_key = RateLimitKey::new(chain_type, rule.priority); + cache_entry.rate_limit_keys.push(rule_key.clone()); + cache_entry.rule_stats_vec.push(rule.rule_stats.clone()); + if !self.check_rate_limit(&rule_key, rule.rate_limit, rule.burst_limit, true) { + // rate limited, drop packet + return AclResult { + action: Action::Drop, + matched_rule: Some(RuleId::Priority(rule.priority)), + should_log: false, + log_context: Some(AclLogContext::RateLimitDrop), + }; + } + } + + // Handle stateful connections if configured + if rule.stateful && rule.action == Action::Allow { + let conn_track_key = self.conn_track_key(packet_info); + self.check_connection_state(&conn_track_key, packet_info); + cache_entry.rule_stats_vec.push(rule.rule_stats.clone()); + cache_entry.matched_rule = RuleId::Stateful(rule.priority); + cache_entry.conn_track_key = Some(conn_track_key); + cache_entry.acl_result = Some(AclResult { + action: Action::Allow, + matched_rule: Some(RuleId::Stateful(rule.priority)), + should_log: false, + log_context: Some(AclLogContext::StatefulMatch { + src_ip: packet_info.src_ip, + dst_ip: packet_info.dst_ip, + }), + }); + } else { + // Rule matched, return action + cache_entry.rule_stats_vec.push(rule.rule_stats.clone()); + cache_entry.matched_rule = RuleId::Priority(rule.priority); + cache_entry.acl_result = Some(AclResult { + action: rule.action, + matched_rule: Some(RuleId::Priority(rule.priority)), + should_log: false, + log_context: Some(AclLogContext::RuleMatch { + src_ip: packet_info.src_ip, + dst_ip: packet_info.dst_ip, + action: rule.action, + }), + }); + } + + // Cache the result with rule info + self.increment_stat(AclStatKey::RuleMatches); + self.inc_cache_entry_stats(&cache_entry, packet_info); + self.cache_result(&cache_key, cache_entry.clone()); + return cache_entry.acl_result.clone().unwrap(); + } + + let default_action = match chain_type { + ChainType::Inbound => self.default_inbound_action, + ChainType::Outbound => self.default_outbound_action, + ChainType::Forward => self.default_forward_action, + _ => Action::Allow, + }; + + // No rule matched, return default drop + if default_action == Action::Drop { + self.increment_stat(AclStatKey::DefaultDrops); + } else { + self.increment_stat(AclStatKey::DefaultAllows); + } + + let log_context = if default_action == Action::Drop { + AclLogContext::DefaultDrop + } else { + AclLogContext::DefaultAllow + }; + + cache_entry + .rule_stats_vec + .push(self.default_rule_stats.clone()); + cache_entry.matched_rule = RuleId::Default; + cache_entry.acl_result = Some(AclResult { + action: default_action, + matched_rule: Some(RuleId::Default), + should_log: false, + log_context: Some(log_context), + }); + + // Cache the default result (no rule info) + self.inc_cache_entry_stats(&cache_entry, packet_info); + self.cache_result(&cache_key, cache_entry.clone()); + cache_entry.acl_result.clone().unwrap() + } + + /// Get shared state for preserving across hot reloads + pub fn get_shared_state(&self) -> SharedState { + ( + self.conn_track.clone(), + self.rate_limiters.clone(), + self.stats.clone(), + ) + } + + /// Cache an ACL result + fn cache_result(&self, cache_key: &AclCacheKey, cache_entry: AclCacheEntry) { + self.rule_cache.insert(cache_key.clone(), cache_entry); + + // Trigger cleanup if cache is getting too large + if self.rule_cache.len() > self.cache_max_size * 2 { + let cache = self.rule_cache.clone(); + let max_size = self.cache_max_size; + Self::cleanup_cache(&cache, max_size); + } + } + + /// Check if a rule matches the packet + fn rule_matches(&self, rule: &FastLookupRule, packet_info: &PacketInfo) -> bool { + // Protocol check + if rule.protocol != Protocol::Any && rule.protocol as i32 != packet_info.protocol as i32 { + return false; + } + + // Source IP check + if !rule.src_ip_ranges.is_empty() { + let matches = rule + .src_ip_ranges + .iter() + .any(|cidr| match (cidr, packet_info.src_ip) { + (cidr::IpCidr::V4(v4_cidr), IpAddr::V4(v4_addr)) => v4_cidr.contains(&v4_addr), + (cidr::IpCidr::V6(v6_cidr), IpAddr::V6(v6_addr)) => v6_cidr.contains(&v6_addr), + _ => false, + }); + if !matches { + return false; + } + } + + // Destination IP check + if !rule.dst_ip_ranges.is_empty() { + let matches = rule + .dst_ip_ranges + .iter() + .any(|cidr| match (cidr, packet_info.dst_ip) { + (cidr::IpCidr::V4(v4_cidr), IpAddr::V4(v4_addr)) => v4_cidr.contains(&v4_addr), + (cidr::IpCidr::V6(v6_cidr), IpAddr::V6(v6_addr)) => v6_cidr.contains(&v6_addr), + _ => false, + }); + if !matches { + return false; + } + } + + // Source port check + if let Some(src_port) = packet_info.src_port + && !rule.src_port_ranges.is_empty() + { + let matches = rule + .src_port_ranges + .iter() + .any(|(start, end)| src_port >= *start && src_port <= *end); + if !matches { + return false; + } + } + + // Destination port check + if let Some(dst_port) = packet_info.dst_port + && !rule.dst_port_ranges.is_empty() + { + let matches = rule + .dst_port_ranges + .iter() + .any(|(start, end)| dst_port >= *start && dst_port <= *end); + if !matches { + return false; + } + } + + // Source group check + if !rule.source_groups.is_empty() { + let matches = packet_info + .src_groups + .iter() + .any(|group| rule.source_groups.contains(group)); + if !matches { + return false; + } + } + + // Destination group check + if !rule.destination_groups.is_empty() { + let matches = packet_info + .dst_groups + .iter() + .any(|group| rule.destination_groups.contains(group)); + if !matches { + return false; + } + } + + true + } + + fn conn_track_key(&self, packet_info: &PacketInfo) -> String { + format!( + "{}:{}->{}:{}", + packet_info.src_ip, + packet_info.src_port.unwrap_or(0), + packet_info.dst_ip, + packet_info.dst_port.unwrap_or(0) + ) + } + + /// Check connection state for stateful rules + fn check_connection_state(&self, conn_track_key: &str, packet_info: &PacketInfo) { + self.conn_track + .entry(conn_track_key.to_string()) + .and_modify(|x| { + x.last_seen = SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap() + .as_secs(); + x.packet_count += 1; + x.byte_count += packet_info.packet_size as u64; + x.state = ConnState::Established as i32; + }) + .or_insert_with(|| ConnTrackEntry { + src_addr: Some( + SocketAddr::new(packet_info.src_ip, packet_info.src_port.unwrap_or(0)).into(), + ), + dst_addr: Some( + SocketAddr::new(packet_info.dst_ip, packet_info.dst_port.unwrap_or(0)).into(), + ), + protocol: packet_info.protocol as i32, + state: ConnState::New as i32, + created_at: SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap() + .as_secs(), + last_seen: SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap() + .as_secs(), + packet_count: 1, + byte_count: packet_info.packet_size as u64, + }); + } + + /// Check rate limiting for a rule + fn check_rate_limit( + &self, + rule_key: &RateLimitKey, + rate: u32, + burst: u32, + allow_create: bool, + ) -> bool { + if rate == 0 { + return true; // No rate limiting + } + + let mut rate_limiter = self + .rate_limiters + .entry(rule_key.clone()) + .or_insert_with(|| { + if !allow_create { + panic!("Rate limit bucket not found"); + } + RateLimitValue { + token_bucket: TokenBucket::new(burst as u64, rate as u64), + last_update: Instant::now(), + } + }); + + // Try to consume 1 token (1 packet) + rate_limiter.last_update = Instant::now(); + rate_limiter.token_bucket.try_consume(1) + } + + /// Convert proto Rule to FastLookupRule + fn convert_to_fast_lookup_rule(rule: &Rule) -> FastLookupRule { + let src_ip_ranges = rule + .source_ips + .iter() + .filter_map(|x| Self::convert_ip_inet_to_cidr(x.as_str())) + .collect(); + + let dst_ip_ranges = rule + .destination_ips + .iter() + .filter_map(|x| Self::convert_ip_inet_to_cidr(x.as_str())) + .collect(); + + let src_port_ranges = rule + .source_ports + .iter() + .filter_map(|port_range| { + if let Some((start, end)) = parse_port_range(port_range) { + Some((start, end)) + } else { + None + } + }) + .collect(); + + let dst_port_ranges = rule + .ports + .iter() + .filter_map(|port_range| { + if let Some((start, end)) = parse_port_range(port_range) { + Some((start, end)) + } else { + None + } + }) + .collect(); + + FastLookupRule { + priority: rule.priority, + protocol: rule.protocol(), + src_ip_ranges, + dst_ip_ranges, + src_port_ranges, + dst_port_ranges, + source_groups: rule.source_groups.iter().cloned().collect(), + destination_groups: rule.destination_groups.iter().cloned().collect(), + action: rule.action(), + enabled: rule.enabled, + stateful: rule.stateful, + rate_limit: rule.rate_limit, + burst_limit: rule.burst_limit, + rule_stats: Arc::new(RuleStats { + rule: Some(rule.clone()), + stat: Some(StatItem { + packet_count: 0, + byte_count: 0, + }), + }), + } + } + + /// Convert IpInet to CIDR for fast lookup + fn convert_ip_inet_to_cidr(input: &str) -> Option { + cidr::IpCidr::from_str(input).ok() + } + + /// Increment statistics counter + pub fn increment_stat(&self, key: AclStatKey) { + self.stats + .entry(key) + .and_modify(|counter| *counter += 1) + .or_insert(1); + } + + /// Get statistics + pub fn get_stats(&self) -> HashMap { + let mut stats = self + .stats + .iter() + .map(|entry| (entry.key().as_str(), *entry.value())) + .collect::>(); + + // Add cache statistics using enum keys + stats.insert(AclStatKey::CacheSize.as_str(), self.rule_cache.len() as u64); + stats.insert( + AclStatKey::CacheMaxSize.as_str(), + self.cache_max_size as u64, + ); + + stats + } + + /// Clean up expired connection tracking entries + pub fn cleanup_expired_connections( + conn_track: Arc>, + timeout_secs: u64, + ) { + let current_time = SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap() + .as_secs(); + let keys_to_remove: Vec = conn_track + .iter() + .filter_map(|entry| { + if current_time - entry.last_seen > timeout_secs { + Some(entry.key().clone()) + } else { + None + } + }) + .collect(); + + for key in keys_to_remove { + conn_track.remove(&key); + } + } +} + +fn parse_port_range(s: &str) -> Option<(u16, u16)> { + if let Some((start, end)) = s.split_once('-') { + let start = start.trim().parse().ok()?; + let end = end.trim().parse().ok()?; + Some((start, end)) + } else { + let port = s.trim().parse().ok()?; + Some((port, port)) + } +} + +// Statistics key enum for better performance +#[derive(Debug, Clone, Hash, PartialEq, Eq)] +pub enum AclStatKey { + // Cache statistics + CacheHits, + CacheSize, + CacheMaxSize, + RuleMatches, + DefaultAllows, + DefaultDrops, + + // Global packet statistics + PacketsTotal, + PacketsAllowed, + PacketsDropped, + PacketsNoop, + + // Per-chain statistics + InboundPacketsTotal, + InboundPacketsAllowed, + InboundPacketsDropped, + InboundPacketsNoop, + + OutboundPacketsTotal, + OutboundPacketsAllowed, + OutboundPacketsDropped, + OutboundPacketsNoop, + + ForwardPacketsTotal, + ForwardPacketsAllowed, + ForwardPacketsDropped, + ForwardPacketsNoop, + + UnknownPacketsTotal, + UnknownPacketsAllowed, + UnknownPacketsDropped, + UnknownPacketsNoop, +} + +impl AclStatKey { + pub fn as_str(&self) -> String { + format!("{:?}", self) + } + + pub fn from_chain_and_action(chain_type: ChainType, stat_type: AclStatType) -> Self { + match (chain_type, stat_type) { + (ChainType::Inbound, AclStatType::Total) => AclStatKey::InboundPacketsTotal, + (ChainType::Inbound, AclStatType::Allowed) => AclStatKey::InboundPacketsAllowed, + (ChainType::Inbound, AclStatType::Dropped) => AclStatKey::InboundPacketsDropped, + (ChainType::Inbound, AclStatType::Noop) => AclStatKey::InboundPacketsNoop, + + (ChainType::Outbound, AclStatType::Total) => AclStatKey::OutboundPacketsTotal, + (ChainType::Outbound, AclStatType::Allowed) => AclStatKey::OutboundPacketsAllowed, + (ChainType::Outbound, AclStatType::Dropped) => AclStatKey::OutboundPacketsDropped, + (ChainType::Outbound, AclStatType::Noop) => AclStatKey::OutboundPacketsNoop, + + (ChainType::Forward, AclStatType::Total) => AclStatKey::ForwardPacketsTotal, + (ChainType::Forward, AclStatType::Allowed) => AclStatKey::ForwardPacketsAllowed, + (ChainType::Forward, AclStatType::Dropped) => AclStatKey::ForwardPacketsDropped, + (ChainType::Forward, AclStatType::Noop) => AclStatKey::ForwardPacketsNoop, + + (_, AclStatType::Total) => AclStatKey::UnknownPacketsTotal, + (_, AclStatType::Allowed) => AclStatKey::UnknownPacketsAllowed, + (_, AclStatType::Dropped) => AclStatKey::UnknownPacketsDropped, + (_, AclStatType::Noop) => AclStatKey::UnknownPacketsNoop, + } + } +} + +#[derive(Debug, Clone, Copy)] +pub enum AclStatType { + Total, + Allowed, + Dropped, + Noop, +} + +#[cfg(test)] +mod tests { + use super::*; + use std::hash::{Hash, Hasher}; + use std::net::{IpAddr, Ipv4Addr}; + + impl AclProcessor { + fn get_cache_hit_rate(&self) -> f64 { + let cache_hits = self + .stats + .get(&AclStatKey::CacheHits) + .map(|v| *v.value()) + .unwrap_or(0); + let total_requests = cache_hits + + self + .stats + .get(&AclStatKey::RuleMatches) + .map(|v| *v.value()) + .unwrap_or(0); + + if total_requests == 0 { + 0.0 + } else { + cache_hits as f64 / total_requests as f64 + } + } + } + + #[tokio::test] + async fn test_group_based_acl_rules() { + let mut acl_config = Acl::default(); + let mut acl_v1 = AclV1::default(); + let mut chain = Chain { + name: "group_test_chain".to_string(), + chain_type: ChainType::Inbound as i32, + enabled: true, + default_action: Action::Drop as i32, + ..Default::default() + }; + + // Rules + chain.rules.push(Rule { + name: "allow_admins_to_db".to_string(), + priority: 100, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + source_groups: vec!["admin".to_string()], + destination_groups: vec!["db-server".to_string()], + ..Default::default() + }); + chain.rules.push(Rule { + name: "allow_devs_from_anywhere".to_string(), + priority: 90, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + source_groups: vec!["dev".to_string()], + ..Default::default() + }); + chain.rules.push(Rule { + name: "deny_guests_to_db".to_string(), + priority: 80, + enabled: true, + action: Action::Drop as i32, + protocol: Protocol::Any as i32, + source_groups: vec!["guest".to_string()], + destination_groups: vec!["db-server".to_string()], + ..Default::default() + }); + chain.rules.push(Rule { + name: "allow_specific_ip".to_string(), + priority: 70, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + source_ips: vec!["1.2.3.4/32".to_string()], + ..Default::default() + }); + + acl_v1.chains.push(chain); + acl_config.acl_v1 = Some(acl_v1); + + let processor = AclProcessor::new(acl_config); + + // Case 3.1: Source group match (devs from anywhere) + let mut packet_info = create_test_packet_info(); + packet_info.src_groups = Arc::new(vec!["dev".to_string()]); + let result = processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result.action, Action::Allow); + assert_eq!(result.matched_rule, Some(RuleId::Priority(90))); + + // Case 3.2: Source group no match + packet_info.src_groups = Arc::new(vec!["guest".to_string()]); + let result = processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result.action, Action::Drop); // Default drop + assert_eq!(result.matched_rule, Some(RuleId::Default)); + + // Case 3.3: Destination group match (deny guests to db) + packet_info.src_groups = Arc::new(vec!["guest".to_string()]); + packet_info.dst_groups = Arc::new(vec!["db-server".to_string()]); + let result = processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result.action, Action::Drop); + assert_eq!(result.matched_rule, Some(RuleId::Priority(80))); + + // Case 3.4: Source and Destination groups match + packet_info.src_groups = Arc::new(vec!["admin".to_string()]); + packet_info.dst_groups = Arc::new(vec!["db-server".to_string()]); + let result = processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result.action, Action::Allow); + assert_eq!(result.matched_rule, Some(RuleId::Priority(100))); + + // Case 3.5: Partial match (admin to web-server) + packet_info.src_groups = Arc::new(vec!["admin".to_string()]); + packet_info.dst_groups = Arc::new(vec!["web-server".to_string()]); + let result = processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result.action, Action::Drop); // Default drop + assert_eq!(result.matched_rule, Some(RuleId::Default)); + + // Case 3.6: Rule with no group definition + packet_info.src_ip = "1.2.3.4".parse().unwrap(); + packet_info.src_groups = Arc::new(vec!["admin".to_string()]); + packet_info.dst_groups = Arc::new(vec![]); + let result = processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result.action, Action::Allow); + assert_eq!(result.matched_rule, Some(RuleId::Priority(70))); + } + + #[tokio::test] + async fn test_forward_acl_source_ip_whitelist() { + let mut acl_config = Acl::default(); + let mut acl_v1 = AclV1::default(); + let mut chain = Chain { + name: "subnet_proxy_protect".to_string(), + chain_type: ChainType::Forward as i32, + enabled: true, + default_action: Action::Drop as i32, + ..Default::default() + }; + + chain.rules.push(Rule { + name: "allow_my_devices".to_string(), + priority: 1000, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + source_ips: vec!["10.172.192.2/32".to_string()], + ..Default::default() + }); + acl_v1.chains.push(chain); + acl_config.acl_v1 = Some(acl_v1); + + let processor = AclProcessor::new(acl_config); + let mut packet_info = create_test_packet_info(); + packet_info.dst_ip = "192.168.1.10".parse().unwrap(); + + packet_info.src_ip = "10.172.192.2".parse().unwrap(); + let result = processor.process_packet(&packet_info, ChainType::Forward); + assert_eq!(result.action, Action::Allow); + assert_eq!(result.matched_rule, Some(RuleId::Priority(1000))); + + packet_info.src_ip = "10.172.192.3".parse().unwrap(); + let result = processor.process_packet(&packet_info, ChainType::Forward); + assert_eq!(result.action, Action::Drop); + assert_eq!(result.matched_rule, Some(RuleId::Default)); + } + + fn create_test_acl_config() -> Acl { + let mut acl_config = Acl::default(); + + let mut acl_v1 = AclV1::default(); + + // Create inbound chain + let mut chain = Chain { + name: "test_inbound".to_string(), + chain_type: ChainType::Inbound as i32, + enabled: true, + ..Default::default() + }; + + // Allow all rule + let rule = Rule { + name: "allow_all".to_string(), + priority: 100, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + ..Default::default() + }; + + chain.rules.push(rule); + acl_v1.chains.push(chain); + acl_config.acl_v1 = Some(acl_v1); + + acl_config + } + + fn create_test_packet_info() -> PacketInfo { + PacketInfo { + src_ip: IpAddr::V4(Ipv4Addr::new(192, 168, 1, 100)), + dst_ip: IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1)), + src_port: Some(12345), + dst_port: Some(80), + protocol: Protocol::Tcp, + packet_size: 1024, + src_groups: Arc::new(vec![]), + dst_groups: Arc::new(vec![]), + } + } + + #[test] + fn test_acl_cache_key_creation() { + let packet_info = create_test_packet_info(); + let cache_key = AclCacheKey::from_packet_info(&packet_info, ChainType::Inbound); + + assert_eq!(cache_key.chain_type, ChainType::Inbound); + assert_eq!(cache_key.protocol, Protocol::Tcp); + assert_eq!( + cache_key.src_ip, + IpAddr::V4(Ipv4Addr::new(192, 168, 1, 100)) + ); + assert_eq!(cache_key.dst_ip, IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1))); + assert_eq!(cache_key.src_port, 12345); + assert_eq!(cache_key.dst_port, 80); + } + + #[test] + fn test_acl_cache_key_equality() { + let packet_info1 = create_test_packet_info(); + let packet_info2 = create_test_packet_info(); + + let key1 = AclCacheKey::from_packet_info(&packet_info1, ChainType::Inbound); + let key2 = AclCacheKey::from_packet_info(&packet_info2, ChainType::Inbound); + + assert_eq!(key1, key2); + + // Test hash consistency + use std::collections::hash_map::DefaultHasher; + let mut hasher1 = DefaultHasher::new(); + let mut hasher2 = DefaultHasher::new(); + key1.hash(&mut hasher1); + key2.hash(&mut hasher2); + assert_eq!(hasher1.finish(), hasher2.finish()); + } + + #[tokio::test] + async fn test_acl_processor_basic_functionality() { + let acl_config = create_test_acl_config(); + let processor = AclProcessor::new(acl_config); + let packet_info = create_test_packet_info(); + + let result = processor.process_packet(&packet_info, ChainType::Inbound); + + assert_eq!(result.action, Action::Allow); + assert!(result.matched_rule.is_some()); + } + + #[tokio::test] + async fn test_acl_cache_hit() { + let acl_config = create_test_acl_config(); + let processor = AclProcessor::new(acl_config); + let packet_info = create_test_packet_info(); + + // First request - should be a cache miss + let result1 = processor.process_packet(&packet_info, ChainType::Inbound); + + // Second request - should be a cache hit + let result2 = processor.process_packet(&packet_info, ChainType::Inbound); + + assert_eq!(result1.action, result2.action); + assert_eq!(result1.matched_rule, result2.matched_rule); + + // Check cache statistics + let stats = processor.get_stats(); + assert_eq!(stats.get(&AclStatKey::CacheHits.as_str()).unwrap_or(&0), &1); + assert!(processor.get_cache_hit_rate() > 0.0); + } + + #[tokio::test] + async fn test_lock_free_hot_reload_demo() { + println!("\n=== ACL 优化演示:无锁热加载 ==="); + + // 创建初始配置 + let initial_config = create_test_acl_config(); + let processor = AclProcessor::new(initial_config); + let packet_info = create_test_packet_info(); + + // 处理一些数据包 + println!("1. 处理初始数据包..."); + let result1 = processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result1.action, Action::Allow); + println!(" ✓ 数据包被允许通过"); + + // 获取共享状态 + let (conn_track, rate_limiters, stats) = processor.get_shared_state(); + println!("2. 保存连接跟踪和统计状态..."); + println!(" ✓ 连接数: {}", conn_track.len()); + println!(" ✓ 限流器数量: {}", rate_limiters.len()); + println!(" ✓ 统计计数器数量: {}", stats.len()); + + // 创建新配置(模拟热加载) + let mut new_config = create_test_acl_config(); + if let Some(ref mut acl_v1) = new_config.acl_v1 { + let drop_rule = Rule { + name: "drop_all".to_string(), + priority: 200, + enabled: true, + action: Action::Drop as i32, + protocol: Protocol::Any as i32, + ..Default::default() + }; + acl_v1.chains[0].rules.push(drop_rule); + } + + // 创建新的处理器实例(热加载) + println!("3. 执行热加载(创建新的处理器实例)..."); + let new_processor = AclProcessor::new_with_shared_state( + new_config, + Some(conn_track.clone()), + Some(rate_limiters.clone()), + Some(stats.clone()), + ); + + // 验证新处理器的行为 + let result2 = new_processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result2.action, Action::Drop); // 新规则应该拒绝 + println!(" ✓ 新规则生效:数据包被拒绝"); + + // 验证状态被保留 + let (new_conn_track, new_rate_limiters, new_stats) = new_processor.get_shared_state(); + assert!(Arc::ptr_eq(&conn_track, &new_conn_track)); + assert!(Arc::ptr_eq(&rate_limiters, &new_rate_limiters)); + assert!(Arc::ptr_eq(&stats, &new_stats)); + println!(" ✓ 连接状态和统计信息被完整保留"); + + println!("\n=== 性能优化效果 ==="); + println!("✓ 无锁访问:处理器内部不再有任何锁"); + println!("✓ 零拷贝:规则访问直接引用,无需克隆Arc"); + println!("✓ 热加载:创建新实例替换,保留所有状态"); + println!("✓ 内存效率:消除了多层Arc包装的开销"); + } + + #[tokio::test] + async fn test_performance_and_security_balance() { + // Create ACL config with different rule types + let mut acl_config = Acl::default(); + + let mut acl_v1 = AclV1::default(); + let mut chain = Chain { + name: "performance_test".to_string(), + chain_type: ChainType::Inbound as i32, + enabled: true, + ..Default::default() + }; + + // 1. High-priority simple rule for UDP (can be cached efficiently) + let simple_rule = Rule { + name: "simple_udp".to_string(), + priority: 300, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Udp as i32, + ..Default::default() + }; + // No stateful or rate limit - can benefit from full cache optimization + chain.rules.push(simple_rule); + + // 2. Medium-priority stateful + rate-limited rule for TCP (security critical) + let security_rule = Rule { + name: "security_tcp".to_string(), + priority: 200, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Tcp as i32, + stateful: true, + rate_limit: 100, + burst_limit: 200, + ..Default::default() + }; + chain.rules.push(security_rule); + + // 3. Low-priority default allow rule for Any + let default_rule = Rule { + name: "default_allow".to_string(), + priority: 100, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + ..Default::default() + }; + chain.rules.push(default_rule); + + acl_v1.chains.push(chain); + acl_config.acl_v1 = Some(acl_v1); + + let processor = AclProcessor::new(acl_config); + + // Test simple UDP packet (should hit high-priority simple rule and be cached) + let udp_packet = PacketInfo { + src_ip: IpAddr::V4(Ipv4Addr::new(192, 168, 1, 100)), + dst_ip: IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1)), + src_port: Some(12345), + dst_port: Some(53), // DNS + protocol: Protocol::Udp, // UDP + packet_size: 512, + src_groups: Arc::new(vec![]), + dst_groups: Arc::new(vec![]), + }; + + // Test TCP packet (should hit stateful+rate-limited rule) + let tcp_packet = PacketInfo { + src_ip: IpAddr::V4(Ipv4Addr::new(192, 168, 1, 100)), + dst_ip: IpAddr::V4(Ipv4Addr::new(10, 0, 0, 1)), + src_port: Some(12345), + dst_port: Some(80), // HTTP + protocol: Protocol::Tcp, // TCP + packet_size: 1024, + src_groups: Arc::new(vec![]), + dst_groups: Arc::new(vec![]), + }; + + // Process UDP packets multiple times + println!("\n=== Performance Test Results ==="); + for i in 1..=5 { + let result = processor.process_packet(&udp_packet, ChainType::Inbound); + assert_eq!(result.action, Action::Allow); + // UDP packets should match the highest priority rule that applies + // Since all rules allow "Any" protocol, UDP will match the highest priority one + println!( + "UDP packet {}: Allowed by rule (priority {:?})", + i, result.matched_rule + ); + } + + // Process TCP packets multiple times (stateful + rate limited) + for i in 1..=3 { + let result = processor.process_packet(&tcp_packet, ChainType::Inbound); + println!( + "TCP packet {}: {:?} by rule (priority {:?})", + i, result.action, result.matched_rule + ); + } + + let stats = processor.get_stats(); + println!("\nStatistics:"); + println!( + " Cache hits: {}", + stats.get(&AclStatKey::CacheHits.as_str()).unwrap_or(&0) + ); + println!( + " Rule matches: {}", + stats.get(&AclStatKey::RuleMatches.as_str()).unwrap_or(&0) + ); + println!( + " Cache hit rate: {:.1}%", + processor.get_cache_hit_rate() * 100.0 + ); + + println!("\n✓ Stateful + rate-limited rules: Always processed for security"); + println!("✓ Simple rules: Cached for performance"); + println!( + "✓ Cache hit rate: {:.1}%", + processor.get_cache_hit_rate() * 100.0 + ); + } + + #[test] + fn test_rate_limit_drop_log_context() { + // Test that RateLimitDrop log context is properly created + let context = AclLogContext::RateLimitDrop; + let message = context.to_message(); + assert_eq!(message, "Rate limit drop"); + } + + #[tokio::test] + async fn test_rate_limit_drop_behavior() { + let mut acl_config = create_test_acl_config(); + + // Create a very restrictive rate-limited rule + if let Some(ref mut acl_v1) = acl_config.acl_v1 { + let rule = Rule { + name: "strict_rate_limit".to_string(), + priority: 200, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + rate_limit: 1, // Allow only 1 packet per second + burst_limit: 1, // Burst of 1 packet + ..Default::default() + }; + acl_v1.chains[0].rules.push(rule); + } + + let processor = AclProcessor::new(acl_config); + let packet_info = create_test_packet_info(); + + // First request should be allowed + let result1 = processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result1.action, Action::Allow); + assert_eq!(result1.matched_rule, Some(RuleId::Priority(200))); + + // Second request should be rate limited and dropped immediately + let result2 = processor.process_packet(&packet_info, ChainType::Inbound); + assert_eq!(result2.action, Action::Drop); + assert_eq!(result2.matched_rule, Some(RuleId::Priority(200))); + assert!(!result2.should_log); + + // Verify the specific log context + assert!(matches!( + result2.log_context, + Some(AclLogContext::RateLimitDrop) + )); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/admission.rs b/vendor/easytier/easytier-core/src/peers/admission.rs new file mode 100644 index 0000000..11f7872 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/admission.rs @@ -0,0 +1,166 @@ +use std::sync::{Arc, Weak}; + +use async_trait::async_trait; + +use crate::{ + connectivity::protocol::raw, + events::{CoreEvent, CoreEventSink}, + listener::{ + AcceptedSocketHandler, + transport::{AcceptedTransport, AcceptedTunnelHandler}, + }, + tunnel::Tunnel, +}; + +use super::peer_manager::PeerManagerCore; + +pub(crate) struct PeerAcceptedTunnelHandler { + peer_manager: Weak, + events: Arc, +} + +impl PeerAcceptedTunnelHandler { + pub(crate) fn new( + peer_manager: &Arc, + events: Arc, + ) -> Arc { + Arc::new(Self { + peer_manager: Arc::downgrade(peer_manager), + events, + }) + } +} + +#[async_trait] +impl AcceptedTunnelHandler for PeerAcceptedTunnelHandler { + async fn handle_tunnel(&self, tunnel: Box) -> anyhow::Result<()> { + let tunnel_info = tunnel + .info() + .ok_or_else(|| anyhow::anyhow!("accepted tunnel has no tunnel info"))?; + let local_url = tunnel_info + .local_addr + .clone() + .unwrap_or_default() + .to_string(); + let remote_url = tunnel_info + .remote_addr + .clone() + .unwrap_or_default() + .to_string(); + self.events.emit(CoreEvent::TunnelAccepted { + local_url: local_url.clone(), + remote_url: remote_url.clone(), + }); + tracing::info!(ret = ?tunnel, "conn accepted"); + + let Some(peer_manager) = self.peer_manager.upgrade() else { + let error = "peer manager is gone, cannot handle tunnel".to_owned(); + self.events.emit(CoreEvent::TunnelAdmissionFailed { + local_url, + remote_url, + error: error.clone(), + }); + tracing::error!(error = %error, "handle conn error"); + return Err(anyhow::anyhow!(error)); + }; + if let Err(error) = peer_manager.add_tunnel_as_server(tunnel).await { + self.events.emit(CoreEvent::TunnelAdmissionFailed { + local_url, + remote_url, + error: error.to_string(), + }); + tracing::error!(?error, "handle conn error"); + return Err(error.into()); + } + Ok(()) + } +} + +pub(crate) struct RawAcceptedTransportHandler { + tunnel_handler: Arc, +} + +impl RawAcceptedTransportHandler { + pub(crate) fn new(tunnel_handler: Arc) -> Self { + Self { tunnel_handler } + } +} + +#[async_trait] +impl AcceptedSocketHandler> for RawAcceptedTransportHandler +where + TcpSocket: crate::socket::tcp::VirtualTcpSocket, +{ + async fn handle_accepted_socket( + &self, + accepted: AcceptedTransport, + ) -> anyhow::Result<()> { + let tunnel = match accepted { + AcceptedTransport::Tunnel { tunnel, .. } => tunnel, + AcceptedTransport::Tcp { + socket, local_url, .. + } => { + if local_url.scheme() != "tcp" { + anyhow::bail!("unsupported raw TCP listener protocol: {local_url}"); + } + raw::upgrade_accepted_tcp_with_local_url(socket, local_url)? + } + AcceptedTransport::Udp { + session, local_url, .. + } => { + if local_url.scheme() != "udp" { + anyhow::bail!("unsupported raw UDP listener protocol: {local_url}"); + } + raw::upgrade_accepted_udp_with_local_url(session, local_url)? + } + AcceptedTransport::ByteStream { + socket, + local_url, + remote_url, + } => raw::upgrade_accepted_byte_stream(socket, local_url, remote_url)?, + }; + self.tunnel_handler.handle_tunnel(tunnel).await + } +} + +#[cfg(test)] +mod tests { + use std::sync::{ + Arc, + atomic::{AtomicUsize, Ordering}, + }; + + use super::*; + use crate::{host::testkit::TestTcpSocket, tunnel::ring::RingTunnelRegistry}; + + struct RecordingTunnelHandler(AtomicUsize); + + #[async_trait] + impl AcceptedTunnelHandler for RecordingTunnelHandler { + async fn handle_tunnel(&self, _tunnel: Box) -> anyhow::Result<()> { + self.0.fetch_add(1, Ordering::Relaxed); + Ok(()) + } + } + + #[tokio::test] + async fn raw_transport_delegates_tunnel_to_shared_admission_handler() { + let registry = Arc::new(RingTunnelRegistry::default()); + let local_id = uuid::Uuid::new_v4(); + let mut listener = registry.bind(local_id).unwrap(); + let _client = registry.connect(local_id).unwrap(); + let tunnel = listener.accept().await.unwrap().into_tunnel(); + let recorder = Arc::new(RecordingTunnelHandler(AtomicUsize::new(0))); + let handler = RawAcceptedTransportHandler::new(recorder.clone()); + + handler + .handle_accepted_socket(AcceptedTransport::::Tunnel { + tunnel, + local_url: format!("ring://{local_id}").parse().unwrap(), + }) + .await + .unwrap(); + + assert_eq!(recorder.0.load(Ordering::Relaxed), 1); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/attached.rs b/vendor/easytier/easytier-core/src/peers/attached.rs new file mode 100644 index 0000000..d7f7787 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/attached.rs @@ -0,0 +1,1260 @@ +//! Locally attached peers backed by their own portable peer runtime. +//! +//! An attached peer participates in routing, ACL identity, and peer lifecycle +//! exactly like a remote EasyTier node. The only privileged part of the seam is +//! the authenticated in-process connection to another peer manager. + +use std::{ + net::{IpAddr, Ipv4Addr}, + sync::Arc, +}; + +use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; +use parking_lot::Mutex as StdMutex; +use tokio::{runtime::Handle, sync::Mutex, task::JoinHandle}; +use tokio_util::sync::CancellationToken; +use x25519_dalek::{PublicKey, StaticSecret}; + +use crate::{ + config::{ + IpPrefix, PeerId, + peers::PeerRuntimeSnapshot, + runtime::{CoreInstanceRuntimeConfig, CoreRuntimeConfig, CoreRuntimeConfigStore}, + }, + host::packet::{HostPacket, HostPacketReceiver, host_packet_channel}, + packet::ZCPacket, + peers::{ + conn::peer_conn::PeerConnId, + peer_manager::{PeerManagerCore, PortablePeerManagerConfig, RouteAlgoType}, + public_ipv6::CorePublicIpv6Runtime, + }, + tunnel::ring::create_ring_tunnel_pair, +}; + +/// Configuration for one locally attached peer. +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct AttachedPeerConfig { + pub name: String, + pub virtual_ip: cidr::Ipv4Inet, + pub groups: Vec, + /// Identity key supplied by the caller. It stays stable for one attached + /// runtime; replacing the runtime may deliberately rotate the identity. + pub identity_private_key: [u8; 32], +} + +#[derive(Debug, Clone, Copy)] +struct AttachedConnections { + network_peer_id: PeerId, + network_conn_id: PeerConnId, + attached_peer_id: PeerId, + attached_conn_id: PeerConnId, +} +#[cfg(test)] +#[derive(Default)] +struct CleanupPause { + started: tokio::sync::Notify, + resume: tokio::sync::Notify, + finished: tokio::sync::Notify, +} + +struct AttachedCredentialRegistration { + network_peer_manager: Arc, + credential_id: Option, + policy_task: Option>, +} + +impl AttachedCredentialRegistration { + fn register( + network_peer_manager: Arc, + network_runtime_config: CoreRuntimeConfigStore, + public_key: [u8; 32], + configured_groups: Vec, + ) -> anyhow::Result { + let mut peer_changes = network_runtime_config.subscribe_peer_runtime_changes(); + let groups = effective_credential_groups( + network_runtime_config.snapshot().as_ref(), + &configured_groups, + ); + let credential_id = + network_peer_manager.register_ephemeral_credential(public_key, groups)?; + let task_peer_manager = network_peer_manager.clone(); + let policy_task = tokio::spawn(async move { + while peer_changes.changed().await.is_ok() { + let _ = peer_changes.borrow_and_update(); + let groups = effective_credential_groups( + network_runtime_config.snapshot().as_ref(), + &configured_groups, + ); + if task_peer_manager + .update_ephemeral_credential_groups(credential_id, groups) + .await + .is_none() + { + return; + } + } + }); + Ok(Self { + network_peer_manager, + credential_id: Some(credential_id), + policy_task: Some(policy_task), + }) + } + + async fn close(mut self) { + if let Some(policy_task) = self.policy_task.take() { + policy_task.abort(); + let _ = policy_task.await; + } + if let Some(credential_id) = self.credential_id.take() { + self.network_peer_manager + .revoke_ephemeral_credential_and_refresh(credential_id) + .await; + } + } + + fn revoke(&mut self) { + if let Some(credential_id) = self.credential_id.take() { + self.network_peer_manager + .revoke_ephemeral_credential(credential_id); + } + } +} + +impl Drop for AttachedCredentialRegistration { + fn drop(&mut self) { + if let Some(policy_task) = self.policy_task.take() { + policy_task.abort(); + } + self.revoke(); + } +} +struct AttachedCleanupResources { + connections: AttachedConnections, + credential_registration: Option, +} + +fn effective_credential_groups( + network: &CoreInstanceRuntimeConfig, + configured_groups: &[String], +) -> Vec { + network + .peer + .acl_group_declarations + .iter() + .filter(|declaration| configured_groups.contains(&declaration.group_name)) + .map(|declaration| declaration.group_name.clone()) + .collect() +} + +fn build_attached_services( + network: &CoreRuntimeConfig, + credential_peer: bool, +) -> CoreRuntimeConfig { + let mut services = network.clone(); + if credential_peer { + services.acl = services.acl.for_credential_peer(); + } + services +} + +/// One complete EasyTier peer connected to another manager in process. +/// +/// The runtime owns the attached manager's lifecycle. Callers exchange only +/// raw IPv4 packets through the Host packet seam. +pub struct AttachedPeerRuntime { + network_peer_manager: Arc, + peer_manager: Arc, + packet_receiver: Mutex, + cleanup_resources: StdMutex>, + cleanup_done: CancellationToken, + runtime_handle: Handle, + closed: CancellationToken, + #[cfg(test)] + cleanup_pause: StdMutex>>, +} + +impl AttachedPeerRuntime { + /// Constructs, starts, and transactionally connects one peer manager. + pub async fn connect( + network_peer_manager: Arc, + network_runtime_config: CoreRuntimeConfigStore, + config: AttachedPeerConfig, + ) -> anyhow::Result> { + let runtime_handle = Handle::current(); + let network = network_runtime_config.snapshot(); + let (peer_snapshot, credential_public_key) = build_peer_snapshot(&network, &config)?; + let credential_registration = match credential_public_key { + Some(public_key) => Some(AttachedCredentialRegistration::register( + network_peer_manager.clone(), + network_runtime_config.clone(), + public_key, + config.groups.clone(), + )?), + None => None, + }; + let services = build_attached_services(&network.services, credential_public_key.is_some()); + let runtime_config = CoreRuntimeConfigStore::new(services, Arc::new(peer_snapshot.clone())); + let (packet_sender, packet_receiver) = host_packet_channel(); + let public_ipv6_runtime = + CorePublicIpv6Runtime::new(runtime_config.clone(), Arc::new(()), Arc::new(())); + let flags = peer_snapshot.flags.clone(); + let peer_manager = Arc::new(PeerManagerCore::new( + PortablePeerManagerConfig { + snapshot: peer_snapshot, + route_algo: RouteAlgoType::Ospf, + exit_nodes: Vec::new(), + foreign_context_default_flags: flags, + }, + Vec::new(), + runtime_config, + Arc::new(()), + packet_sender, + public_ipv6_runtime, + Arc::new(()), + None, + Arc::new(()), + )?); + if let Err(error) = peer_manager + .follow_network_policy(network_runtime_config, config.groups) + .await + { + peer_manager.clear_resources().await; + return Err(error); + } + if let Err(error) = peer_manager.run().await { + peer_manager.clear_resources().await; + return Err(error.into()); + } + + let (network_tunnel, attached_tunnel) = create_ring_tunnel_pair(); + let (network_result, attached_result) = tokio::join!( + network_peer_manager.add_attached_ring_tunnel_as_server(network_tunnel), + peer_manager.add_attached_ring_client_tunnel(attached_tunnel), + ); + let connections = match (network_result, attached_result) { + (Ok((attached_peer_id, network_conn_id)), Ok((network_peer_id, attached_conn_id))) + if attached_peer_id == peer_manager.my_peer_id() + && network_peer_id == network_peer_manager.my_peer_id() => + { + AttachedConnections { + network_peer_id, + network_conn_id, + attached_peer_id, + attached_conn_id, + } + } + (network_result, attached_result) => { + let network_connection = network_result.as_ref().ok().copied(); + let attached_connection = attached_result.as_ref().ok().copied(); + cleanup_partial( + network_peer_manager, + peer_manager.clone(), + network_connection, + attached_connection, + ) + .await; + anyhow::bail!( + "failed to connect attached peer: \ + network={network_result:?}, attached={attached_result:?}" + ); + } + }; + + Ok(Arc::new(Self { + network_peer_manager, + peer_manager, + packet_receiver: Mutex::new(packet_receiver), + cleanup_resources: StdMutex::new(Some(AttachedCleanupResources { + connections, + credential_registration, + })), + cleanup_done: CancellationToken::new(), + runtime_handle, + closed: CancellationToken::new(), + #[cfg(test)] + cleanup_pause: StdMutex::new(None), + })) + } + + pub fn peer_id(&self) -> PeerId { + self.peer_manager.my_peer_id() + } + #[cfg(test)] + fn credential_id(&self) -> Option { + self.cleanup_resources + .lock() + .as_ref() + .and_then(|resources| resources.credential_registration.as_ref()) + .and_then(|registration| registration.credential_id) + } + + /// Receives one packet addressed to the attached peer after routing and ACL. + pub async fn recv_packet(&self) -> Option { + let mut packet_receiver = self.packet_receiver.lock().await; + tokio::select! { + biased; + _ = self.closed.cancelled() => None, + packet = packet_receiver.recv() => packet, + } + } + + /// Injects one raw IPv4 packet as traffic originating from the attached peer. + pub async fn send_packet(&self, payload: &[u8]) -> anyhow::Result<()> { + if self.closed.is_cancelled() { + anyhow::bail!("attached peer is closed"); + } + let destination = ipv4_destination(payload)?; + self.peer_manager + .send_msg_by_ip( + ZCPacket::new_with_payload(payload), + IpAddr::V4(destination), + false, + ) + .await?; + Ok(()) + } + + fn start_cleanup(&self) { + self.closed.cancel(); + let Some(resources) = self.cleanup_resources.lock().take() else { + return; + }; + let AttachedCleanupResources { + connections, + credential_registration, + } = resources; + let network_peer_manager = self.network_peer_manager.clone(); + let peer_manager = self.peer_manager.clone(); + let cleanup_done = self.cleanup_done.clone().drop_guard(); + #[cfg(test)] + let cleanup_pause = self.cleanup_pause.lock().clone(); + self.runtime_handle.spawn(async move { + let _cleanup_done = cleanup_done; + let connection_cleanup = async move { + #[cfg(test)] + if let Some(pause) = cleanup_pause.as_ref() { + pause.started.notify_one(); + pause.resume.notified().await; + } + cleanup(network_peer_manager, peer_manager, connections).await; + #[cfg(test)] + if let Some(pause) = cleanup_pause { + pause.finished.notify_one(); + } + }; + if let Some(credential_registration) = credential_registration { + tokio::join!(connection_cleanup, credential_registration.close()); + } else { + connection_cleanup.await; + } + }); + } + + /// Idempotently tears down both connections and the attached manager. + pub async fn close(&self) { + self.start_cleanup(); + self.cleanup_done.cancelled().await; + } +} + +impl Drop for AttachedPeerRuntime { + fn drop(&mut self) { + self.start_cleanup(); + } +} + +fn ipv4_destination(payload: &[u8]) -> anyhow::Result { + if payload.len() < 20 || payload[0] >> 4 != 4 { + anyhow::bail!("invalid attached-peer IPv4 header"); + } + let header_len = usize::from(payload[0] & 0x0f) * 4; + let total_len = usize::from(u16::from_be_bytes([payload[2], payload[3]])); + if header_len < 20 || header_len > payload.len() || total_len != payload.len() { + anyhow::bail!("invalid attached-peer IPv4 length"); + } + Ok(Ipv4Addr::new( + payload[16], + payload[17], + payload[18], + payload[19], + )) +} + +fn build_peer_snapshot( + network: &CoreInstanceRuntimeConfig, + config: &AttachedPeerConfig, +) -> anyhow::Result<(PeerRuntimeSnapshot, Option<[u8; 32]>)> { + network + .peer + .runtime + .network_identity + .network_secret + .as_deref() + .filter(|secret| !secret.is_empty()) + .ok_or_else(|| anyhow::anyhow!("attached peers require a non-empty network secret"))?; + let address = config.virtual_ip.address(); + let client_network = config.virtual_ip.network(); + if address == client_network.first_address() || address == client_network.last_address() { + anyhow::bail!("unusable attached-peer IPv4 address: {}", config.virtual_ip); + } + + let mut snapshot = network.peer.as_ref().clone(); + snapshot.runtime.core.node.peer_id = None; + snapshot.runtime.core.node.instance_id = None; + snapshot.runtime.core.node.hostname = Some(config.name.clone()); + snapshot.runtime.core.routes.ipv4 = Some(IpPrefix { + address: IpAddr::V4(address), + prefix_len: config.virtual_ip.network_length(), + }); + snapshot.runtime.core.routes.ipv6 = None; + snapshot.runtime.core.routes.advertised_routes.clear(); + snapshot.runtime.core.routes.proxy_networks.clear(); + snapshot.runtime.core.routes.foreign_networks.clear(); + snapshot.runtime.core.peer_policy.p2p_enabled = false; + snapshot.runtime.core.peer_policy.relay_peer_rpc = false; + snapshot.runtime.core.peer_policy.relay_data = false; + snapshot.runtime.stun_info = Default::default(); + let supports_conn_list_sync = snapshot.runtime.feature_flags.support_conn_list_sync; + snapshot.runtime.feature_flags = Default::default(); + snapshot.runtime.feature_flags.support_conn_list_sync = supports_conn_list_sync; + snapshot.runtime.feature_flags.disable_p2p = true; + snapshot.runtime.feature_flags.need_p2p = false; + snapshot.runtime.feature_flags.avoid_relay_data = true; + snapshot.flags.disable_p2p = true; + snapshot.flags.need_p2p = false; + snapshot.flags.relay_all_peer_rpc = false; + snapshot.flags.disable_relay_data = true; + snapshot.flags.p2p_only = false; + snapshot.pinned_peers.clear(); + snapshot.avoid_relay_data_preference = true; + snapshot.peer_group_memberships.clear(); + + let credential_public_key = if snapshot + .runtime + .secure_mode + .as_ref() + .is_some_and(|secure| secure.enabled) + { + let private = StaticSecret::from(config.identity_private_key); + let public = PublicKey::from(&private); + snapshot.runtime.network_identity.network_secret = None; + snapshot.runtime.network_identity.network_secret_digest = None; + snapshot.hmac_secret_digest = false; + snapshot.acl_group_declarations.clear(); + snapshot.runtime.secure_mode = Some(crate::proto::common::SecureModeConfig { + enabled: true, + local_private_key: Some(BASE64_STANDARD.encode(private.as_bytes())), + local_public_key: Some(BASE64_STANDARD.encode(public.as_bytes())), + }); + Some(*public.as_bytes()) + } else { + None + }; + Ok((snapshot, credential_public_key)) +} + +async fn cleanup( + network_peer_manager: Arc, + attached_peer_manager: Arc, + connections: AttachedConnections, +) { + cleanup_partial( + network_peer_manager, + attached_peer_manager, + Some((connections.attached_peer_id, connections.network_conn_id)), + Some((connections.network_peer_id, connections.attached_conn_id)), + ) + .await; +} + +async fn cleanup_partial( + network_peer_manager: Arc, + attached_peer_manager: Arc, + network_connection: Option<(PeerId, PeerConnId)>, + attached_connection: Option<(PeerId, PeerConnId)>, +) { + if let (Some((attached_peer_id, network_conn_id)), Some((network_peer_id, attached_conn_id))) = + (network_connection, attached_connection) + { + let _ = tokio::join!( + network_peer_manager.close_peer_conn(attached_peer_id, &network_conn_id), + attached_peer_manager.close_peer_conn(network_peer_id, &attached_conn_id), + ); + } else { + if let Some((attached_peer_id, network_conn_id)) = network_connection { + let _ = network_peer_manager + .close_peer_conn(attached_peer_id, &network_conn_id) + .await; + } + if let Some((network_peer_id, attached_conn_id)) = attached_connection { + let _ = attached_peer_manager + .close_peer_conn(network_peer_id, &attached_conn_id) + .await; + } + } + if let Some((attached_peer_id, _)) = network_connection { + let _ = network_peer_manager + .get_peer_map() + .close_peer(attached_peer_id) + .await; + } + if let Some((network_peer_id, _)) = attached_connection { + let _ = attached_peer_manager + .get_peer_map() + .close_peer(network_peer_id) + .await; + } + attached_peer_manager.clear_resources().await; +} + +#[cfg(test)] +mod tests { + use std::{collections::BTreeSet, time::Duration}; + + use super::*; + use crate::{ + config::{ + CoreConfig, NetworkIdentity, NodeConfig, + peers::{HostRoutingPolicy, PeerGroupIdentity, PeerRuntimeConfig}, + runtime::CoreRuntimeConfig, + }, + proto::{ + acl::{Acl, AclV1, GroupInfo}, + common::{PeerFeatureFlag, StunInfo}, + }, + }; + + fn attached_ipv4(address: Ipv4Addr) -> cidr::Ipv4Inet { + cidr::Ipv4Inet::new(address, 24).unwrap() + } + + fn peer_manager_with_acl( + tcp_whitelist: Vec, + ) -> (Arc, CoreRuntimeConfigStore) { + peer_manager_with_acl_and_secure(tcp_whitelist, false) + } + + fn peer_manager_with_acl_and_secure( + tcp_whitelist: Vec, + secure_mode_enabled: bool, + ) -> (Arc, CoreRuntimeConfigStore) { + let secure_mode = secure_mode_enabled.then(|| { + let private = StaticSecret::from([99u8; 32]); + let public = PublicKey::from(&private); + crate::proto::common::SecureModeConfig { + enabled: true, + local_private_key: Some(BASE64_STANDARD.encode(private.as_bytes())), + local_public_key: Some(BASE64_STANDARD.encode(public.as_bytes())), + } + }); + let runtime = PeerRuntimeConfig { + core: CoreConfig { + node: NodeConfig { + network_name: "attached-test".to_owned(), + ..Default::default() + }, + routes: crate::config::RouteConfig { + ipv4: Some(IpPrefix { + address: IpAddr::V4(Ipv4Addr::new(10, 82, 0, 1)), + prefix_len: 24, + }), + ..Default::default() + }, + ..Default::default() + }, + network_identity: NetworkIdentity::new( + "attached-test".to_owned(), + "shared-secret".to_owned(), + ), + stun_info: StunInfo::default(), + feature_flags: PeerFeatureFlag::default(), + secure_mode, + host_routing: HostRoutingPolicy::default(), + }; + let mut portable = PortablePeerManagerConfig::new(runtime); + portable.snapshot.acl_group_declarations = vec![PeerGroupIdentity { + group_name: "ops".to_owned(), + group_secret: "ops-secret".to_owned(), + }]; + let services = CoreRuntimeConfig { + acl: crate::config::peers::AclRuleConfig { + acl: Some(Acl { + acl_v1: Some(AclV1 { + chains: Vec::new(), + group: Some(GroupInfo { + declares: vec![crate::proto::acl::GroupIdentity { + group_name: "ops".to_owned(), + group_secret: "ops-secret".to_owned(), + }], + members: Vec::new(), + }), + }), + }), + tcp_whitelist, + ..Default::default() + }, + ..Default::default() + }; + let store = CoreRuntimeConfigStore::new(services, Arc::new(portable.snapshot.clone())); + let (packet_sender, _packet_receiver) = host_packet_channel(); + let public_ipv6_runtime = + CorePublicIpv6Runtime::new(store.clone(), Arc::new(()), Arc::new(())); + let peer_manager = Arc::new( + PeerManagerCore::new( + portable, + Vec::new(), + store.clone(), + Arc::new(()), + packet_sender, + public_ipv6_runtime, + Arc::new(()), + None, + Arc::new(()), + ) + .unwrap(), + ); + (peer_manager, store) + } + + fn peer_manager() -> (Arc, CoreRuntimeConfigStore) { + peer_manager_with_acl(Vec::new()) + } + + async fn wait_for_route( + peer: &PeerManagerCore, + attached_peer_id: PeerId, + address: Ipv4Addr, + present: bool, + ) { + tokio::time::timeout(Duration::from_secs(10), async { + loop { + let found = peer.list_route_snapshots().await.iter().any(|route| { + route.peer_id == attached_peer_id + && route.ipv4_addr == Some(cidr::Ipv4Inet::new(address, 24).unwrap().into()) + }); + if found == present { + return; + } + tokio::time::sleep(Duration::from_millis(10)).await; + } + }) + .await + .expect("attached route state did not converge"); + } + + async fn wait_for_acl_groups( + network_peer_manager: &PeerManagerCore, + peer_id: PeerId, + expected: &[&str], + ) { + let expected = expected + .iter() + .map(|group| (*group).to_owned()) + .collect::>(); + tokio::time::timeout(Duration::from_secs(10), async { + loop { + let advertised = network_peer_manager + .get_route() + .get_peer_groups(peer_id) + .iter() + .cloned() + .collect::>(); + if advertised == expected { + return; + } + tokio::time::sleep(Duration::from_millis(10)).await; + } + }) + .await + .expect("attached ACL groups did not converge"); + } + + async fn wait_for_acl_rules(attached: &AttachedPeerRuntime) { + tokio::time::timeout(Duration::from_secs(10), async { + loop { + if !attached + .peer_manager + .acl_filter() + .get_processor() + .get_rules_stats() + .is_empty() + { + return; + } + tokio::task::yield_now().await; + } + }) + .await + .expect("attached peer manager did not apply updated ACL rules"); + } + + #[tokio::test] + async fn secure_attached_peer_updates_groups_with_declarations() { + let (network_peer_manager, store) = peer_manager_with_acl_and_secure(Vec::new(), true); + network_peer_manager.run().await.unwrap(); + let attached = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store.clone(), + AttachedPeerConfig { + name: "group-update".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 2)), + groups: vec!["ops".to_owned(), "audit".to_owned()], + identity_private_key: [2; 32], + }, + ) + .await + .unwrap(); + wait_for_acl_groups(&network_peer_manager, attached.peer_id(), &["ops"]).await; + store.update_peer_with(|peer| { + peer.acl_group_declarations.push(PeerGroupIdentity { + group_name: "audit".to_owned(), + group_secret: "audit-secret".to_owned(), + }); + }); + wait_for_acl_groups(&network_peer_manager, attached.peer_id(), &["audit", "ops"]).await; + + store.update_peer_with(|peer| peer.acl_group_declarations.clear()); + + wait_for_acl_groups(&network_peer_manager, attached.peer_id(), &[]).await; + attached.close().await; + network_peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn ephemeral_credential_group_update_refreshes_route() { + let (network_peer_manager, store) = peer_manager_with_acl_and_secure(Vec::new(), true); + network_peer_manager.run().await.unwrap(); + let attached = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store, + AttachedPeerConfig { + name: "direct-group-update".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 2)), + groups: vec!["ops".to_owned()], + identity_private_key: [5; 32], + }, + ) + .await + .unwrap(); + wait_for_acl_groups(&network_peer_manager, attached.peer_id(), &["ops"]).await; + let credential_id = attached.credential_id().unwrap(); + + assert_eq!( + network_peer_manager + .update_ephemeral_credential_groups(credential_id, Vec::new()) + .await, + Some(true) + ); + + wait_for_acl_groups(&network_peer_manager, attached.peer_id(), &[]).await; + attached.close().await; + network_peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn peer_manager_loads_initial_acl_from_its_runtime_config() { + let (peer_manager, _store) = peer_manager_with_acl(vec!["22".to_owned()]); + + assert!( + !peer_manager + .acl_filter() + .get_processor() + .get_rules_stats() + .is_empty() + ); + } + + #[tokio::test] + async fn invalid_acl_update_does_not_publish_manager_config() { + let (peer_manager, store) = peer_manager(); + let before = store.snapshot(); + let mut invalid = before.as_ref().clone(); + invalid.services.acl.tcp_whitelist = vec!["not-a-port".to_owned()]; + + assert!(peer_manager.update_runtime_config(invalid).await.is_err()); + assert_eq!(store.snapshot().services.acl, before.services.acl); + assert!( + peer_manager + .acl_filter() + .get_processor() + .get_rules_stats() + .is_empty() + ); + } + + #[tokio::test] + async fn dropped_credential_registration_revokes_credential() { + let (network_peer_manager, store) = peer_manager_with_acl_and_secure(Vec::new(), true); + let credential_public_key = *PublicKey::from(&StaticSecret::from([4; 32])).as_bytes(); + + let registration = AttachedCredentialRegistration::register( + network_peer_manager.clone(), + store, + credential_public_key, + vec!["ops".to_owned()], + ) + .unwrap(); + assert!( + network_peer_manager + .credential_manager() + .is_pubkey_trusted(&credential_public_key) + ); + + drop(registration); + + assert!( + !network_peer_manager + .credential_manager() + .is_pubkey_trusted(&credential_public_key) + ); + } + + #[tokio::test] + async fn secure_attached_runtime_removes_admin_and_group_secrets() { + let (_network_peer_manager, store) = peer_manager_with_acl_and_secure(Vec::new(), true); + let network = store.snapshot(); + let config = AttachedPeerConfig { + name: "sanitized".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 2)), + groups: vec!["ops".to_owned()], + identity_private_key: [3; 32], + }; + + let (snapshot, credential_public_key) = + build_peer_snapshot(network.as_ref(), &config).unwrap(); + let services = build_attached_services(&network.services, credential_public_key.is_some()); + + assert!(credential_public_key.is_some()); + assert!(snapshot.runtime.network_identity.network_secret.is_none()); + assert!( + snapshot + .runtime + .network_identity + .network_secret_digest + .is_none() + ); + assert!(snapshot.peer_group_memberships.is_empty()); + assert!(snapshot.acl_group_declarations.is_empty()); + assert!( + services + .acl + .acl + .as_ref() + .unwrap() + .acl_v1 + .as_ref() + .unwrap() + .group + .is_none() + ); + assert!( + network + .services + .acl + .acl + .as_ref() + .unwrap() + .acl_v1 + .as_ref() + .unwrap() + .group + .is_some() + ); + } + + #[tokio::test] + async fn attached_peer_uses_its_own_cidr_when_host_uses_dhcp() { + let (_network_peer_manager, store) = peer_manager_with_acl_and_secure(Vec::new(), true); + store.update_peer_with(|peer| peer.runtime.core.routes.ipv4 = None); + store.update_services(|services| services.dhcp_ipv4 = true); + let network = store.snapshot(); + let config = AttachedPeerConfig { + name: "wireguard-client".to_owned(), + virtual_ip: "10.90.0.2/16".parse().unwrap(), + groups: vec!["ops".to_owned()], + identity_private_key: [3; 32], + }; + + let (snapshot, _) = build_peer_snapshot(network.as_ref(), &config).unwrap(); + + assert_eq!( + snapshot.runtime.core.routes.ipv4, + Some(IpPrefix { + address: IpAddr::V4(Ipv4Addr::new(10, 90, 0, 2)), + prefix_len: 16, + }) + ); + } + + #[tokio::test] + async fn secure_attached_peer_uses_credential_identity_and_granted_groups() { + let (network_peer_manager, store) = peer_manager_with_acl_and_secure(Vec::new(), true); + network_peer_manager.run().await.unwrap(); + let identity_private_key = [1; 32]; + let credential_public_key = + *PublicKey::from(&StaticSecret::from(identity_private_key)).as_bytes(); + assert!( + !network_peer_manager + .credential_manager() + .is_pubkey_trusted(&credential_public_key) + ); + + let attached = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store, + AttachedPeerConfig { + name: "credential".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 2)), + groups: vec!["ops".to_owned()], + identity_private_key, + }, + ) + .await + .unwrap(); + assert!( + network_peer_manager + .credential_manager() + .is_pubkey_trusted(&credential_public_key) + ); + + assert!( + !attached.peer_manager.can_manage_credentials(), + "Secure-Mode attached peer retained administrator credentials" + ); + wait_for_acl_groups(&network_peer_manager, attached.peer_id(), &["ops"]).await; + + attached.close().await; + assert!( + !network_peer_manager + .credential_manager() + .is_pubkey_trusted(&credential_public_key) + ); + network_peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn peer_managers_own_acl_updates_for_attached_clients() { + let (network_peer_manager, store) = peer_manager(); + let peer_subscribers_before_run = store.peer_change_subscriber_count(); + network_peer_manager.run().await.unwrap(); + tokio::time::timeout(Duration::from_secs(10), async { + while store.peer_change_subscriber_count() == peer_subscribers_before_run { + tokio::task::yield_now().await; + } + }) + .await + .expect("network peer manager did not subscribe to config updates"); + let peer_subscribers = store.peer_change_subscriber_count(); + let service_subscribers = store.service_change_subscriber_count(); + + let first = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store.clone(), + AttachedPeerConfig { + name: "first".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 2)), + groups: vec!["ops".to_owned()], + identity_private_key: [1; 32], + }, + ) + .await + .unwrap(); + let second = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store.clone(), + AttachedPeerConfig { + name: "second".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 3)), + groups: Vec::new(), + identity_private_key: [2; 32], + }, + ) + .await + .unwrap(); + + assert_ne!(first.peer_id(), second.peer_id()); + assert!(!Arc::ptr_eq( + &first.peer_manager.acl_filter(), + &second.peer_manager.acl_filter() + )); + assert_eq!(store.peer_change_subscriber_count(), peer_subscribers + 2); + assert_eq!( + store.service_change_subscriber_count(), + service_subscribers + 2 + ); + wait_for_route( + &network_peer_manager, + first.peer_id(), + Ipv4Addr::new(10, 82, 0, 2), + true, + ) + .await; + wait_for_route( + &network_peer_manager, + second.peer_id(), + Ipv4Addr::new(10, 82, 0, 3), + true, + ) + .await; + wait_for_acl_groups(&network_peer_manager, first.peer_id(), &["ops"]).await; + + store.update_peer_with(|peer| peer.acl_group_declarations.clear()); + wait_for_acl_groups(&network_peer_manager, first.peer_id(), &[]).await; + + let mut updated = store.snapshot().as_ref().clone(); + updated.services.acl.tcp_whitelist.push("22".to_owned()); + store.replace(updated); + wait_for_acl_rules(&first).await; + wait_for_acl_rules(&second).await; + + let first_peer_id = first.peer_id(); + first.close().await; + assert_eq!(store.peer_change_subscriber_count(), peer_subscribers + 1); + assert_eq!( + store.service_change_subscriber_count(), + service_subscribers + 1 + ); + wait_for_route( + &network_peer_manager, + first_peer_id, + Ipv4Addr::new(10, 82, 0, 2), + false, + ) + .await; + second.close().await; + assert_eq!(store.peer_change_subscriber_count(), peer_subscribers); + assert_eq!(store.service_change_subscriber_count(), service_subscribers); + network_peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn attached_peer_reconnects_after_acl_group_removal() { + let (network_peer_manager, store) = peer_manager(); + network_peer_manager.run().await.unwrap(); + store.update_peer_with(|peer| peer.acl_group_declarations.clear()); + + let attached = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store, + AttachedPeerConfig { + name: "reconnected".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 4)), + groups: vec!["ops".to_owned()], + identity_private_key: [3; 32], + }, + ) + .await + .unwrap(); + + wait_for_route( + &network_peer_manager, + attached.peer_id(), + Ipv4Addr::new(10, 82, 0, 4), + true, + ) + .await; + wait_for_acl_groups(&network_peer_manager, attached.peer_id(), &[]).await; + attached.close().await; + network_peer_manager.clear_resources().await; + } + #[tokio::test] + async fn cancelled_close_can_be_awaited_again() { + let (network_peer_manager, store) = peer_manager(); + network_peer_manager.run().await.unwrap(); + let identity_private_key = [6; 32]; + let attached = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store, + AttachedPeerConfig { + name: "cancelled-close".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 4)), + groups: Vec::new(), + identity_private_key, + }, + ) + .await + .unwrap(); + let peer_id = attached.peer_id(); + wait_for_route( + &network_peer_manager, + peer_id, + Ipv4Addr::new(10, 82, 0, 4), + true, + ) + .await; + assert!( + network_peer_manager + .get_peer_map() + .has_direct_attached_peer(peer_id), + "attached connection was not live before close" + ); + + let pause = Arc::new(CleanupPause::default()); + *attached.cleanup_pause.lock() = Some(pause.clone()); + let first_close = tokio::spawn({ + let attached = attached.clone(); + async move { attached.close().await } + }); + pause.started.notified().await; + first_close.abort(); + let _ = first_close.await; + pause.resume.notify_one(); + assert!( + network_peer_manager + .get_peer_map() + .has_direct_attached_peer(peer_id), + "cancelling close unexpectedly completed connection cleanup" + ); + + tokio::time::timeout(Duration::from_secs(5), attached.close()) + .await + .expect("retrying close did not await the in-flight cleanup"); + assert!( + !network_peer_manager + .get_peer_map() + .has_direct_attached_peer(peer_id), + "cancelled close left the attached connection live" + ); + wait_for_route( + &network_peer_manager, + peer_id, + Ipv4Addr::new(10, 82, 0, 4), + false, + ) + .await; + network_peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn closing_attached_peer_unblocks_packet_receiver() { + let (network_peer_manager, store) = peer_manager(); + network_peer_manager.run().await.unwrap(); + let attached = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store, + AttachedPeerConfig { + name: "closed-receiver".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 4)), + groups: Vec::new(), + identity_private_key: [3; 32], + }, + ) + .await + .unwrap(); + let waiting = tokio::spawn({ + let attached = attached.clone(); + async move { attached.recv_packet().await } + }); + tokio::task::yield_now().await; + + attached.close().await; + + let packet = tokio::time::timeout(Duration::from_secs(1), waiting) + .await + .expect("packet receiver remained blocked after close") + .unwrap(); + assert!(packet.is_none()); + network_peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn dropping_attached_peer_removes_its_route() { + let (network_peer_manager, store) = peer_manager(); + network_peer_manager.run().await.unwrap(); + let attached = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store, + AttachedPeerConfig { + name: "dropped".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 4)), + groups: Vec::new(), + identity_private_key: [3; 32], + }, + ) + .await + .unwrap(); + let peer_id = attached.peer_id(); + wait_for_route( + &network_peer_manager, + peer_id, + Ipv4Addr::new(10, 82, 0, 4), + true, + ) + .await; + + drop(attached); + + wait_for_route( + &network_peer_manager, + peer_id, + Ipv4Addr::new(10, 82, 0, 4), + false, + ) + .await; + network_peer_manager.clear_resources().await; + } + + #[tokio::test] + async fn dropping_secure_attached_peer_refreshes_route_trust_before_disconnect() { + let (network_peer_manager, store) = peer_manager_with_acl_and_secure(Vec::new(), true); + network_peer_manager.run().await.unwrap(); + let identity_private_key = [7; 32]; + let credential_public_key = + *PublicKey::from(&StaticSecret::from(identity_private_key)).as_bytes(); + let attached = AttachedPeerRuntime::connect( + network_peer_manager.clone(), + store, + AttachedPeerConfig { + name: "dropped-secure".to_owned(), + virtual_ip: attached_ipv4(Ipv4Addr::new(10, 82, 0, 5)), + groups: vec!["ops".to_owned()], + identity_private_key, + }, + ) + .await + .unwrap(); + let peer_id = attached.peer_id(); + wait_for_route( + &network_peer_manager, + peer_id, + Ipv4Addr::new(10, 82, 0, 5), + true, + ) + .await; + wait_for_acl_groups(&network_peer_manager, peer_id, &["ops"]).await; + + let pause = Arc::new(CleanupPause::default()); + *attached.cleanup_pause.lock() = Some(pause.clone()); + drop(attached); + pause.started.notified().await; + + tokio::time::timeout(Duration::from_secs(5), async { + while network_peer_manager + .credential_manager() + .is_pubkey_trusted(&credential_public_key) + { + tokio::task::yield_now().await; + } + }) + .await + .expect("dropped attached credential remained trusted"); + wait_for_route( + &network_peer_manager, + peer_id, + Ipv4Addr::new(10, 82, 0, 5), + false, + ) + .await; + assert!( + !network_peer_manager + .get_peer_map() + .has_direct_attached_peer(peer_id), + "credential revocation did not refresh route trust before cleanup resumed" + ); + + pause.resume.notify_one(); + pause.finished.notified().await; + network_peer_manager.clear_resources().await; + } +} diff --git a/vendor/easytier/easytier-core/src/peers/conn/mod.rs b/vendor/easytier/easytier-core/src/peers/conn/mod.rs new file mode 100644 index 0000000..ee202d4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/conn/mod.rs @@ -0,0 +1,9 @@ +//! Peer connection primitives: noise sessions, individual peer connections, +//! and the peer map that multiplexes them. + +pub(crate) mod peer; +pub(crate) mod peer_conn; +pub(crate) mod peer_conn_liveness; +pub(crate) mod peer_conn_ping; +pub(crate) mod peer_map; +pub(crate) mod peer_session; diff --git a/vendor/easytier/easytier-core/src/peers/conn/peer.rs b/vendor/easytier/easytier-core/src/peers/conn/peer.rs new file mode 100644 index 0000000..d1de320 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/conn/peer.rs @@ -0,0 +1,372 @@ +use std::sync::Arc; + +use arc_swap::ArcSwapOption; +use crossbeam_utils::atomic::AtomicCell; +use dashmap::{DashMap, DashSet}; +use parking_lot::{Mutex, RwLock}; + +use tokio::{select, sync::mpsc}; + +use tracing::Instrument; + +use super::peer_conn::{PeerConn, PeerConnId}; +use crate::peers::{ + PacketRecvChan, + context::{ArcPeerContext, PeerEvent}, + util::shrink_dashmap, +}; +use crate::{ + config::PeerId, + packet::ZCPacket, + peers::error::Error, + proto::{core_peer::peer::PeerConnInfo, peer_rpc::PeerIdentityType}, +}; +use tokio_util::task::AbortOnDropHandle; + +type ArcPeerConn = Arc; +type ConnMap = Arc>; + +fn conn_latency_sort_key(latency_us: u64, is_hole_punched: bool) -> (bool, u64) { + (is_hole_punched && latency_us == 0, latency_us) +} + +pub struct Peer { + pub peer_node_id: PeerId, + prefer_udp: AtomicCell, + conns: ConnMap, + context: ArcPeerContext, + + packet_recv_chan: PacketRecvChan, + + close_event_sender: mpsc::Sender, + #[allow(dead_code)] + close_event_listener: AbortOnDropHandle<()>, + + shutdown_notifier: Arc, + + default_conn: Arc>, + default_conn_update_lock: Arc>, + peer_identity_type: Arc>>, + peer_public_key: Arc>>>, + #[allow(dead_code)] + default_conn_clear_task: AbortOnDropHandle<()>, +} + +impl Peer { + pub(crate) fn new( + peer_node_id: PeerId, + packet_recv_chan: PacketRecvChan, + context: ArcPeerContext, + ) -> Self { + let conns: ConnMap = Arc::new(DashMap::new()); + let (close_event_sender, mut close_event_receiver) = mpsc::channel(10); + let shutdown_notifier = Arc::new(tokio::sync::Notify::new()); + let peer_identity_type = Arc::new(AtomicCell::new(None)); + let peer_identity_type_copy = peer_identity_type.clone(); + let peer_public_key = Arc::new(RwLock::new(None)); + let peer_public_key_copy = peer_public_key.clone(); + let default_conn = Arc::new(ArcSwapOption::empty()); + let default_conn_update_lock = Arc::new(Mutex::new(())); + + let conns_copy = conns.clone(); + let shutdown_notifier_copy = shutdown_notifier.clone(); + let context_copy = context.clone(); + let default_conn_copy = default_conn.clone(); + let default_conn_update_lock_copy = default_conn_update_lock.clone(); + let close_event_listener = AbortOnDropHandle::new(tokio::spawn( + async move { + loop { + select! { + ret = close_event_receiver.recv() => { + if ret.is_none() { + break; + } + let ret = ret.unwrap(); + tracing::warn!( + ?peer_node_id, + ?ret, + "notified that peer conn is closed", + ); + + let removed_conn = { + let _update_guard = default_conn_update_lock_copy.lock(); + let removed_conn = conns_copy.remove(&ret); + if let Some((_, conn)) = removed_conn.as_ref() { + let cached_conn = default_conn_copy.load(); + if cached_conn + .as_ref() + .is_some_and(|cached| Arc::ptr_eq(cached, conn)) + { + default_conn_copy.store(None); + } + } + removed_conn + }; + + if let Some((_, conn)) = removed_conn { + context_copy.issue_event(PeerEvent::PeerConnRemoved( + conn.get_conn_info(), + )); + shrink_dashmap(&conns_copy, Some(4)); + if conns_copy.is_empty() { + peer_identity_type_copy.store(None); + *peer_public_key_copy.write() = None; + } + } + } + + _ = shutdown_notifier_copy.notified() => { + close_event_receiver.close(); + tracing::warn!(?peer_node_id, "peer close event listener notified"); + } + } + } + tracing::info!("peer {} close event listener exit", peer_node_id); + } + .instrument(tracing::info_span!( + "peer_close_event_listener", + ?peer_node_id, + )), + )); + + let conns_copy = conns.clone(); + let default_conn_copy = default_conn.clone(); + let default_conn_clear_task = AbortOnDropHandle::new(tokio::spawn(async move { + loop { + crate::foundation::time::sleep(std::time::Duration::from_secs(5)).await; + if conns_copy.len() > 1 { + default_conn_copy.store(None); + } + } + })); + + Peer { + peer_node_id, + prefer_udp: AtomicCell::new(false), + conns, + packet_recv_chan, + context, + + close_event_sender, + close_event_listener, + + shutdown_notifier, + default_conn, + default_conn_update_lock, + peer_identity_type, + peer_public_key, + default_conn_clear_task, + } + } + + pub async fn add_peer_conn(&self, mut conn: PeerConn) -> Result<(), Error> { + let conn_identity_type = conn.get_peer_identity_type(); + let peer_identity_type = self.peer_identity_type.load(); + if let Some(peer_identity_type) = peer_identity_type { + if peer_identity_type != conn_identity_type { + return Err(Error::SecretKeyError(format!( + "peer identity type mismatch. peer: {:?}, conn: {:?}", + peer_identity_type, conn_identity_type + ))); + } + } else { + self.peer_identity_type.store(Some(conn_identity_type)); + } + + let close_notifier = conn.get_close_notifier(); + let conn_info = conn.get_conn_info(); + let conn_pubkey = conn_info.noise_remote_static_pubkey.clone(); + { + let mut peer_pubkey = self.peer_public_key.write(); + if let Some(existing_pubkey) = peer_pubkey.as_ref() { + if existing_pubkey != &conn_pubkey { + return Err(Error::SecretKeyError(format!( + "peer public key mismatch. peer_id: {}, existing_len: {}, new_len: {}", + self.peer_node_id, + existing_pubkey.len(), + conn_pubkey.len() + ))); + } + } else { + *peer_pubkey = Some(conn_pubkey); + } + } + + conn.start_recv_loop(self.packet_recv_chan.clone()).await; + conn.start_pingpong(); + self.conns.insert(conn.get_conn_id(), Arc::new(conn)); + + let close_event_sender = self.close_event_sender.clone(); + tokio::spawn(async move { + let conn_id = close_notifier.get_conn_id(); + if let Some(mut waiter) = close_notifier.get_waiter().await { + let _ = waiter.recv().await; + } + if let Err(e) = close_event_sender.send(conn_id).await { + tracing::warn!(?conn_id, "failed to send close event: {}", e); + } + }); + + self.context + .issue_event(PeerEvent::PeerConnAdded(conn_info)); + Ok(()) + } + + pub fn set_udp_preference(&self, enabled: bool) { + self.prefer_udp.store(enabled); + self.default_conn.store(None); + } + fn select_conn(&self) -> Option { + let _update_guard = self.default_conn_update_lock.lock(); + if let Some(conn) = self.default_conn.load_full() { + if !conn.is_closed() { + return Some(conn); + } + self.default_conn.store(None); + } + + // A zero latency on a hole-punched connection means the ping loop has not + // confirmed liveness yet. Prefer any other connection, so a freshly admitted + // hole-punched path cannot steal traffic before its first successful ping. + let selected = self + .conns + .iter() + .filter(|conn| !conn.value().is_closed()) + .min_by_key(|conn| { + let is_udp = conn + .value() + .get_conn_info() + .tunnel + .is_some_and(|t| t.tunnel_type == "udp"); + let base = conn_latency_sort_key( + conn.value().get_stats().latency_us, + conn.value().is_hole_punched(), + ); + (base.0, self.prefer_udp.load() && !is_udp, base.1) + }) + .map(|conn| conn.value().clone()); + + if let Some(conn) = selected.as_ref() { + self.default_conn.store(Some(conn.clone())); + } + selected + } + + pub async fn send_msg(&self, msg: ZCPacket) -> Result<(), Error> { + let default_conn = self.default_conn.load(); + if let Some(conn) = default_conn.as_ref().filter(|conn| !conn.is_closed()) { + conn.send_msg(msg).await?; + return Ok(()); + } + drop(default_conn); + + let Some(conn) = self.select_conn() else { + return Err(Error::PeerNoConnectionError(self.peer_node_id)); + }; + conn.send_msg(msg).await?; + + Ok(()) + } + + pub async fn close_peer_conn(&self, conn_id: &PeerConnId) -> Result<(), Error> { + let has_key = self.conns.contains_key(conn_id); + if !has_key { + return Err(Error::NotFound); + } + self.close_event_sender.send(*conn_id).await.unwrap(); + Ok(()) + } + + pub async fn list_peer_conns(&self) -> Vec { + let mut conns = vec![]; + for conn in self.conns.iter() { + // do not lock here, otherwise it will cause dashmap deadlock + conns.push(conn.clone()); + } + + let mut ret = Vec::new(); + for conn in conns { + let info = conn.get_conn_info(); + if !info.is_closed { + ret.push(info); + } else { + let conn_id = info.conn_id.parse().unwrap(); + let _ = self.close_peer_conn(&conn_id).await; + } + } + ret + } + + pub fn has_live_conns(&self) -> bool { + self.conns.iter().any(|entry| !entry.value().is_closed()) + } + + pub fn has_directly_connected_conn(&self) -> bool { + self.conns + .iter() + .any(|entry| !entry.value().is_closed() && !entry.value().is_hole_punched()) + } + + pub(crate) fn has_direct_attached_conn(&self) -> bool { + self.conns.iter().any(|entry| { + let conn = entry.value(); + !conn.is_closed() && !conn.is_hole_punched() && conn.is_attached() + }) + } + + pub fn get_directly_connections(&self) -> DashSet { + self.conns + .iter() + .filter(|entry| !(entry.value()).is_hole_punched()) + .map(|entry| (entry.value()).get_conn_id()) + .collect() + } + + pub fn get_default_conn_id(&self) -> PeerConnId { + self.select_conn() + .as_ref() + .map(|conn| conn.get_conn_id()) + .unwrap_or_default() + } + + pub fn get_peer_identity_type(&self) -> Option { + self.peer_identity_type.load() + } + + pub fn get_peer_public_key(&self) -> Option> { + self.peer_public_key.read().clone() + } +} + +// pritn on drop +impl Drop for Peer { + fn drop(&mut self) { + self.conns.retain(|_, conn| { + self.context + .issue_event(PeerEvent::PeerConnRemoved(conn.get_conn_info())); + false + }); + self.shutdown_notifier.notify_one(); + tracing::info!("peer {} drop", self.peer_node_id); + } +} + +#[cfg(test)] +mod tests { + use super::conn_latency_sort_key; + + #[test] + fn measured_relay_precedes_unverified_hole_punch_path() { + assert!(conn_latency_sort_key(20_000, false) < conn_latency_sort_key(0, true)); + } + + #[test] + fn unmeasured_regular_connection_keeps_existing_priority() { + assert!(conn_latency_sort_key(0, false) < conn_latency_sort_key(20_000, false)); + } + + #[test] + fn verified_lower_latency_path_can_be_preferred() { + assert!(conn_latency_sort_key(5_000, true) < conn_latency_sort_key(20_000, false)); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/conn/peer_conn.rs b/vendor/easytier/easytier-core/src/peers/conn/peer_conn.rs new file mode 100644 index 0000000..f03bc21 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/conn/peer_conn.rs @@ -0,0 +1,1572 @@ +use arc_swap::ArcSwapOption; +use crossbeam_utils::atomic::AtomicCell; +use futures::{StreamExt, TryFutureExt}; +use std::{ + any::Any, + fmt::Debug, + pin::Pin, + sync::{ + Arc, + atomic::{AtomicU32, Ordering}, + }, +}; + +use tokio::sync::Mutex; + +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64_STANDARD; +use guarden::guard; +use hmac::Mac; +use prost::Message; + +use tokio::{sync::broadcast, task::JoinSet}; + +use tracing::Instrument; +use zerocopy::AsBytes; + +use snow::{HandshakeState, params::NoiseParams}; + +use crate::foundation::time::{Duration, timeout}; + +use super::{ + peer_conn_liveness::{FEATURE as LIVENESS_ECHO_FEATURE, PeerConnLiveness}, + peer_conn_ping::PeerConnPinger, + peer_session::{PeerSession, PeerSessionAction}, +}; +use crate::peers::{ + PacketRecvChan, PeerConnectionOrigin, PeerPacketIngress, + context::{ArcPeerContext, NetworkIdentity, NetworkSecretDigest}, + send_peer_packet_to_chan, + traffic_metrics::data_packet_payload_len, +}; +use crate::{ + config::PeerId, + packet::{PacketType, ZCPacket}, + peers::conn::peer_session::{PeerSessionStore, SessionKey, UpsertResponderSessionReturn}, + peers::error::Error, + proto::{ + common::{SecureModeConfig, TunnelInfo}, + core_peer::peer::{PeerConnInfo, PeerConnStats}, + peer_rpc::{ + HandshakeRequest, PeerConnNoiseMsg1Pb, PeerConnNoiseMsg2Pb, PeerConnNoiseMsg3Pb, + PeerConnSessionActionPb, PeerIdentityType, SecureAuthLevel, + }, + }, + tunnel::{ + Tunnel, TunnelError, ZCPacketStream, + filter::{StatsRecorderTunnelFilter, TunnelFilter, TunnelFilterChain, TunnelWithFilter}, + mpsc::{MpscTunnel, MpscTunnelSender}, + stats::{Throughput, WindowLatency}, + }, +}; + +pub type PeerConnId = uuid::Uuid; + +const MAGIC: u32 = 0xd1e1a5e1; +const VERSION: u32 = 1; + +/// The proof of client secret. +#[derive(Debug)] +struct SecretProof { + challenge: Vec, + proof: Vec, +} + +/// The result of noise handshake. +#[derive(Debug)] +#[allow(dead_code)] +struct NoiseHandshakeResult { + peer_id: PeerId, + session: Arc, + local_static_pubkey: Vec, + remote_static_pubkey: Vec, + secure_auth_level: SecureAuthLevel, + peer_identity_type: PeerIdentityType, + remote_network_name: String, + + secret_digest: Vec, + + // foreign network manager use this to verify peer. + // the challenge will be sent to authorized peer and compare the proof against it. + client_secret_proof: Option, + remote_features: Vec, +} + +#[derive(Clone)] +struct PeerSessionTunnelFilter { + enabled: bool, + my_peer_id: Arc>, + peer_id: Arc>>, + session: Arc>, +} + +impl PeerSessionTunnelFilter { + fn new_with_peer(my_peer_id: PeerId, enabled: bool) -> Self { + Self { + enabled, + my_peer_id: Arc::new(AtomicCell::new(my_peer_id)), + peer_id: Arc::new(AtomicCell::new(None)), + session: Arc::new(ArcSwapOption::empty()), + } + } + + fn set_my_peer_id(&self, my_peer_id: PeerId) { + self.my_peer_id.store(my_peer_id); + } + + fn set_peer_id(&self, peer_id: PeerId) { + self.peer_id.store(Some(peer_id)); + } + + fn set_session(&self, session: Arc) { + self.session.store(Some(session)); + } + + fn should_skip_encrypt(&self, hdr: &crate::packet::PeerManagerHeader) -> bool { + hdr.packet_type == PacketType::NoiseHandshakeMsg1 as u8 + || hdr.packet_type == PacketType::NoiseHandshakeMsg2 as u8 + || hdr.packet_type == PacketType::NoiseHandshakeMsg3 as u8 + || hdr.packet_type == PacketType::RelayHandshake as u8 + || hdr.packet_type == PacketType::RelayHandshakeAck as u8 + || hdr.packet_type == PacketType::Ping as u8 + || hdr.packet_type == PacketType::Pong as u8 + } +} + +impl TunnelFilter for PeerSessionTunnelFilter { + type FilterOutput = (); + + fn before_send(&self, mut data: crate::tunnel::SinkItem) -> Option { + if !self.enabled { + return Some(data); + } + + let Some(hdr) = data.peer_manager_header() else { + return Some(data); + }; + + if self.should_skip_encrypt(hdr) { + return Some(data); + } + + let Some(peer_id) = self.peer_id.load() else { + return Some(data); + }; + + let my_peer_id = self.my_peer_id.load(); + if my_peer_id != hdr.from_peer_id.get() || hdr.to_peer_id.get() != peer_id { + return Some(data); + } + + let session_guard = self.session.load(); + let Some(session) = session_guard.as_deref() else { + return Some(data); + }; + if let Err(e) = session.encrypt_payload(my_peer_id, peer_id, &mut data) { + tracing::warn!( + ?my_peer_id, + ?peer_id, + ?e, + "PeerSessionTunnelFilter: encrypt failed, dropping packet" + ); + return None; + } + + Some(data) + } + + fn after_received(&self, data: crate::tunnel::StreamItem) -> Option { + if !self.enabled { + return Some(data); + } + + let mut data = match data { + Ok(v) => v, + Err(e) => return Some(Err(e)), + }; + + let Some(hdr) = data.peer_manager_header() else { + return Some(Ok(data)); + }; + + if self.should_skip_encrypt(hdr) { + return Some(Ok(data)); + } + + let from_peer_id = hdr.from_peer_id.get(); + if from_peer_id == 0 { + return Some(Ok(data)); + } + + let Some(peer_id) = self.peer_id.load() else { + return Some(Ok(data)); + }; + + if from_peer_id != peer_id { + return Some(Ok(data)); + } + + let session_guard = self.session.load(); + let Some(session) = session_guard.as_deref() else { + return Some(Ok(data)); + }; + + let my_peer_id = self.my_peer_id.load(); + if hdr.to_peer_id.get() != my_peer_id { + return Some(Ok(data)); + } + + if let Err(e) = session.decrypt_payload(from_peer_id, my_peer_id, &mut data) { + if !session.is_valid() { + // Session auto-invalidated after too many consecutive failures. + // Close the connection to trigger reconnection with a fresh handshake. + tracing::error!(?e, "session invalidated, closing connection"); + return Some(Err(TunnelError::InternalError( + "session invalidated due to consecutive decrypt failures".to_string(), + ))); + } + // Transient failure, drop this packet but keep the connection alive. + return None; + } + + Some(Ok(data)) + } + + fn filter_output(&self) {} +} + +pub struct PeerConnCloseNotify { + conn_id: PeerConnId, + sender: Arc>>>, +} + +impl PeerConnCloseNotify { + fn new(conn_id: PeerConnId) -> Self { + let (sender, _) = broadcast::channel(1); + Self { + conn_id, + sender: Arc::new(std::sync::Mutex::new(Some(sender))), + } + } + + fn notify_close(&self) { + self.sender.lock().unwrap().take(); + } + + pub async fn get_waiter(&self) -> Option> { + if let Some(sender) = self.sender.lock().unwrap().as_mut() { + let receiver = sender.subscribe(); + return Some(receiver); + } + None + } + + pub fn get_conn_id(&self) -> PeerConnId { + self.conn_id + } + + pub fn is_closed(&self) -> bool { + self.sender.lock().unwrap().is_none() + } +} + +pub struct PeerConn { + conn_id: PeerConnId, + origin: PeerConnectionOrigin, + + my_peer_id: PeerId, + peer_id_hint: Option, + context: ArcPeerContext, + + secure_mode_cfg: Option, + session_filter: PeerSessionTunnelFilter, + noise_handshake_result: Option, + + #[allow(dead_code)] + tunnel: Arc>>, + sink: MpscTunnelSender, + recv: Mutex>>>, + tunnel_info: Option, + + tasks: JoinSet>, + + info: Option, + is_client: Option, + + close_event_notifier: Arc, + + ctrl_resp_sender: broadcast::Sender, + + latency_stats: Arc, + throughput: Arc, + loss_rate_stats: Arc, + liveness: PeerConnLiveness, + + peer_session_store: Arc, + my_encrypt_algo: String, +} + +impl Debug for PeerConn { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PeerConn") + .field("conn_id", &self.conn_id) + .field("my_peer_id", &self.my_peer_id) + .field("info", &self.info) + .finish() + } +} + +impl PeerConn { + #[cfg(test)] + pub(crate) fn new( + my_peer_id: PeerId, + context: ArcPeerContext, + tunnel: Box, + peer_session_store: Arc, + ) -> Self { + Self::new_with_peer_id_hint_and_origin( + my_peer_id, + context, + tunnel, + None, + peer_session_store, + PeerConnectionOrigin::Manual, + ) + } + + pub(crate) fn new_with_peer_id_hint_and_origin( + my_peer_id: PeerId, + context: ArcPeerContext, + tunnel: Box, + peer_id_hint: Option, + peer_session_store: Arc, + origin: PeerConnectionOrigin, + ) -> Self { + let flags = context.flags(); + let tunnel_info = tunnel.info(); + let (ctrl_sender, _ctrl_receiver) = broadcast::channel(8); + + let secure_mode_cfg = context.secure_mode(); + let session_filter = PeerSessionTunnelFilter::new_with_peer( + my_peer_id, + secure_mode_cfg + .as_ref() + .map(|cfg| cfg.enabled) + .unwrap_or(false), + ); + + let peer_conn_tunnel_filter = StatsRecorderTunnelFilter::new(); + let throughput = peer_conn_tunnel_filter.filter_output(); + let liveness = PeerConnLiveness::new(); + let filter_chain = TunnelFilterChain::new(session_filter.clone(), peer_conn_tunnel_filter) + .chain(liveness.clone()); + let peer_conn_tunnel = TunnelWithFilter::new(tunnel, filter_chain); + let mut mpsc_tunnel = MpscTunnel::new(peer_conn_tunnel, Some(Duration::from_secs(7))); + + let (recv, sink) = (mpsc_tunnel.get_stream(), mpsc_tunnel.get_sink()); + + let conn_id = PeerConnId::new_v4(); + let my_encrypt_algo = flags.encryption_algorithm; + + PeerConn { + conn_id, + origin, + + my_peer_id, + peer_id_hint, + context, + + secure_mode_cfg, + session_filter, + noise_handshake_result: None, + + tunnel: Arc::new(Mutex::new( + Box::new(guard!([mut mpsc_tunnel] mpsc_tunnel.close())) + as Box, + )), + sink, + recv: Mutex::new(Some(recv)), + tunnel_info, + + tasks: JoinSet::new(), + + info: None, + is_client: None, + + close_event_notifier: Arc::new(PeerConnCloseNotify::new(conn_id)), + + ctrl_resp_sender: ctrl_sender, + + latency_stats: Arc::new(WindowLatency::new(15)), + throughput, + loss_rate_stats: Arc::new(AtomicU32::new(0)), + liveness, + + peer_session_store, + my_encrypt_algo, + } + } + + fn get_peer_session_store(&self) -> &Arc { + &self.peer_session_store + } + + pub fn is_secure_mode_enabled(&self) -> bool { + self.secure_mode_cfg + .as_ref() + .map(|cfg| cfg.enabled) + .unwrap_or(false) + } + + // pri, pub + fn get_keypair(&self) -> Result<(Vec, Vec), Error> { + let cfg = self + .secure_mode_cfg + .as_ref() + .ok_or_else(|| Error::WaitRespError("secure mode config not set".to_owned()))?; + Ok(( + cfg.private_key()?.as_bytes().to_vec(), + cfg.public_key()?.as_bytes().to_vec(), + )) + } + + pub fn get_conn_id(&self) -> PeerConnId { + self.conn_id + } + + pub(crate) fn is_attached(&self) -> bool { + self.origin == PeerConnectionOrigin::Attached + } + + pub fn is_hole_punched(&self) -> bool { + matches!( + self.origin, + PeerConnectionOrigin::TcpHolePunch | PeerConnectionOrigin::UdpHolePunch + ) + } + + fn max_ping_interval(&self) -> Duration { + match self.origin { + // TCP hole-punched connections need frequent traffic to stay alive. + PeerConnectionOrigin::TcpHolePunch => Duration::from_secs(1), + PeerConnectionOrigin::Manual + | PeerConnectionOrigin::Direct + | PeerConnectionOrigin::Listener + | PeerConnectionOrigin::UdpHolePunch + | PeerConnectionOrigin::Attached => Duration::from_secs(32), + } + } + + pub fn is_closed(&self) -> bool { + self.close_event_notifier.is_closed() + } + + async fn wait_handshake(&self, need_retry: &mut bool) -> Result { + *need_retry = false; + + let mut locked = self.recv.lock().await; + let recv = locked.as_mut().unwrap(); + let rsp = match recv.next().await { + Some(Ok(rsp)) => rsp, + Some(Err(e)) => { + return Err(Error::WaitRespError(format!( + "conn recv error during wait handshake response, err: {:?}", + e + ))); + } + None => { + return Err(Error::WaitRespError( + "conn closed during wait handshake response".to_owned(), + )); + } + }; + + *need_retry = true; + let rsp_len = rsp.buf_len() as u64; + + let Some(peer_mgr_hdr) = rsp.peer_manager_header() else { + return Err(Error::WaitRespError(format!( + "unexpected packet: {:?}, cannot decode peer manager hdr", + rsp + ))); + }; + + if peer_mgr_hdr.packet_type != PacketType::HandShake as u8 { + return Err(Error::WaitRespError(format!( + "unexpected packet type: {:?}, packet: {:?}", + peer_mgr_hdr.packet_type, rsp + ))); + } + + let rsp = HandshakeRequest::decode(rsp.payload()).map_err(|e| { + Error::WaitRespError(format!("decode handshake response error: {:?}", e)) + })?; + + if rsp.network_secret_digest.len() != std::mem::size_of::() { + return Err(Error::WaitRespError( + "invalid network secret digest".to_owned(), + )); + } + + self.record_control_rx(&rsp.network_name, rsp_len); + + Ok(rsp) + } + + async fn wait_handshake_loop(&self) -> Result { + timeout(Duration::from_secs(5), async move { + loop { + let mut need_retry = true; + match self.wait_handshake(&mut need_retry).await { + Ok(rsp) => return Ok(rsp), + Err(e) => { + tracing::warn!("wait handshake error: {:?}", e); + if !need_retry { + return Err(e); + } + } + } + } + }) + .map_err(|e| Error::WaitRespError(format!("wait handshake timeout: {:?}", e))) + .await? + } + + async fn send_handshake( + &self, + send_secret_digest: bool, + metric_network_name: &str, + ) -> Result<(), Error> { + let network = self.context.network_identity(); + let mut req = HandshakeRequest { + magic: MAGIC, + my_peer_id: self.my_peer_id, + version: VERSION, + features: vec![LIVENESS_ECHO_FEATURE.to_owned()], + network_name: network.network_name.clone(), + ..Default::default() + }; + + // only send network secret digest if the network is the same + if send_secret_digest { + req.network_secret_digest + .extend_from_slice(&network.secret_digest().unwrap_or_default()); + } else { + // fill zero + req.network_secret_digest + .extend_from_slice(&[0u8; std::mem::size_of::()]); + } + + let hs_req = req.encode_to_vec(); + let mut zc_packet = ZCPacket::new_with_payload(hs_req.as_bytes()); + zc_packet.fill_peer_manager_hdr( + self.my_peer_id, + PeerId::default(), + PacketType::HandShake as u8, + ); + let pkt_len = zc_packet.buf_len() as u64; + + self.sink.send(zc_packet).await.map_err(|e| { + tracing::warn!("send handshake request error: {:?}", e); + Error::WaitRespError("send handshake request error".to_owned()) + })?; + self.record_control_tx(metric_network_name, pkt_len); + + // yield to send the response packet + tokio::task::yield_now().await; + + Ok(()) + } + + fn decode_handshake_packet(pkt: &ZCPacket) -> Result { + let Some(peer_mgr_hdr) = pkt.peer_manager_header() else { + return Err(Error::WaitRespError( + "unexpected packet: cannot decode peer manager hdr".to_owned(), + )); + }; + + if peer_mgr_hdr.packet_type != PacketType::HandShake as u8 { + return Err(Error::WaitRespError(format!( + "unexpected packet type: {:?}", + peer_mgr_hdr.packet_type + ))); + } + + let rsp = HandshakeRequest::decode(pkt.payload()).map_err(|e| { + Error::WaitRespError(format!("decode handshake response error: {:?}", e)) + })?; + + if rsp.network_secret_digest.len() != std::mem::size_of::() { + return Err(Error::WaitRespError( + "invalid network secret digest".to_owned(), + )); + } + + Ok(rsp) + } + + async fn recv_next_peer_manager_packet( + &self, + expected_pkt_type: Option, + ) -> Result { + let mut locked = self.recv.lock().await; + let recv = locked.as_mut().unwrap(); + + loop { + let Some(ret) = recv.next().await else { + return Err(Error::WaitRespError( + "conn closed during wait handshake response".to_owned(), + )); + }; + let pkt = match ret { + Ok(v) => v, + Err(e) => { + return Err(Error::WaitRespError(format!( + "conn recv error during wait handshake response, err: {:?}", + e + ))); + } + }; + + let Some(peer_mgr_hdr) = pkt.peer_manager_header() else { + continue; + }; + + if expected_pkt_type.is_none() + || peer_mgr_hdr.packet_type == *expected_pkt_type.as_ref().unwrap() as u8 + { + return Ok(pkt); + } + } + } + + fn decode_b64_32(input: &str) -> Result, Error> { + let decoded = BASE64_STANDARD + .decode(input) + .map_err(|e| Error::WaitRespError(format!("base64 decode failed: {e:?}")))?; + if decoded.len() != 32 { + return Err(Error::WaitRespError(format!( + "invalid key length: {}", + decoded.len() + ))); + } + Ok(decoded) + } + + fn get_pinned_remote_static_pubkey_b64(&self) -> Option { + self.context + .pinned_remote_static_pubkey(self.tunnel_info.as_ref()) + } + + async fn send_noise_msg( + &self, + pb: Msg, + packet_type: PacketType, + remote_peer_id: PeerId, + metric_network_name: &str, + hs: &mut snow::HandshakeState, + ) -> Result<(), Error> { + tracing::info!( + "send noise msg: {:?}, packet_type: {:?}, from: {:?}, to: {:?}", + pb, + packet_type, + self.my_peer_id, + remote_peer_id + ); + let payload = pb.encode_to_vec(); + let mut msg = vec![0u8; 4096]; + let msg_len = hs + .write_message(&payload, &mut msg) + .map_err(|e| Error::WaitRespError(format!("noise write msg1 failed: {e:?}")))?; + let mut pkt = ZCPacket::new_with_payload(&msg[..msg_len]); + pkt.fill_peer_manager_hdr(self.my_peer_id, remote_peer_id, packet_type as u8); + let pkt_len = pkt.buf_len() as u64; + self.sink.send(pkt).await?; + self.record_control_tx(metric_network_name, pkt_len); + Ok(()) + } + + /// Unified remote peer authentication verification. + /// + /// Auth outcome matrix (current behavior): + /// + /// | Client role | Server role | Typical credential condition | Client auth level | Server auth level | Client sees server type | Server sees client type | + /// | --- | --- | --- | --- | --- | --- | --- | + /// | Admin | Admin | same network_secret, proof verified | NetworkSecretConfirmed | NetworkSecretConfirmed | Admin | Admin | + /// | Credential | Admin | admin key is pinned and client key is trusted | PeerVerified | PeerVerified | Admin | Credential | + /// | Credential | Admin | client pubkey is trusted, admin key is not pinned | EncryptedUnauthenticated | PeerVerified | Admin | Credential | + /// | Credential | Admin | client pubkey is unknown | handshake may fail | handshake reject | unknown | unknown | + /// | Admin | SharedNode | pinned key match | PeerVerified | EncryptedUnauthenticated | SharedNode | Admin | + /// | Admin | SharedNode | local has no pinned key requirement | EncryptedUnauthenticated | EncryptedUnauthenticated | SharedNode | Admin | + /// | Credential | SharedNode | no pin and not trusted | EncryptedUnauthenticated | EncryptedUnauthenticated | SharedNode | Credential | + /// | Credential | Credential | should reject | handshake reject | handshake reject | unknown | unknown | + /// + /// Logic (in priority order): + /// 1. **NetworkSecretConfirmed**: proof verification succeeds + /// 2. **PeerVerified**: pinned_pubkey matches + /// 3. **PeerVerified**: pubkey is in trusted list + /// 4. **EncryptedUnauthenticated**: initiator without network_secret + /// 5. **Reject**: none of the above + #[allow(clippy::too_many_arguments)] + fn verify_remote_auth( + &self, + proof: Option<&[u8]>, + handshake_hash: &[u8], + remote_pubkey: &[u8], + pinned_pubkey: Option<&[u8]>, + has_network_secret: bool, + is_initiator: bool, + remote_network_name: &str, + ) -> Result { + // 1. Verify proof + if let Some(proof) = proof + && let Some(mac) = self.context.secret_proof(handshake_hash) + && mac.verify_slice(proof).is_ok() + { + return Ok(SecureAuthLevel::NetworkSecretConfirmed); + } + + // 2. Check pinned pubkey + if let Some(pinned) = pinned_pubkey { + if pinned != remote_pubkey { + return Err(Error::WaitRespError( + "pinned remote static pubkey mismatch".to_owned(), + )); + } + return Ok(SecureAuthLevel::PeerVerified); + } + + // 3. Check if pubkey is in trusted list + if self + .context + .is_pubkey_trusted(remote_pubkey, remote_network_name) + { + return Ok(SecureAuthLevel::PeerVerified); + } + + // 4. If we are the initiator without network_secret, keep encrypted channel only. + if is_initiator && !has_network_secret { + return Ok(SecureAuthLevel::EncryptedUnauthenticated); + } + + // 5. Reject + Err(Error::WaitRespError( + "authentication failed: invalid proof and unknown credential".to_owned(), + )) + } + + fn classify_remote_identity( + &self, + remote_network_name: &str, + secure_auth_level: SecureAuthLevel, + remote_role_hint_is_same_network: bool, + remote_sent_secret_proof: bool, + is_client: bool, + ) -> PeerIdentityType { + if !remote_role_hint_is_same_network || remote_network_name != self.context.network_name() { + if is_client { + PeerIdentityType::SharedNode + } else if remote_sent_secret_proof { + PeerIdentityType::Admin + } else { + PeerIdentityType::Credential + } + } else { + if matches!(secure_auth_level, SecureAuthLevel::NetworkSecretConfirmed) + || remote_sent_secret_proof + { + return PeerIdentityType::Admin; + } + + PeerIdentityType::Credential + } + } + + async fn do_noise_handshake_as_client(&self) -> Result { + let prologue = b"easytier-peerconn-noise".to_vec(); + + let params: NoiseParams = "Noise_XX_25519_ChaChaPoly_SHA256" + .parse() + .map_err(|e| Error::WaitRespError(format!("parse noise params failed: {e:?}")))?; + + let pinned_remote_pubkey = self + .get_pinned_remote_static_pubkey_b64() + .map(|v| Self::decode_b64_32(&v)) + .transpose()?; + + let builder = snow::Builder::new(params); + let (local_private_key, local_static_pubkey) = self.get_keypair()?; + + let network = self.context.network_identity(); + let a_session_generation = self + .peer_id_hint + .and_then(|peer_id| { + self.get_peer_session_store() + .get(&SessionKey::new(network.network_name.clone(), peer_id)) + }) + .map(|s| s.session_generation()); + + let a_conn_id = uuid::Uuid::new_v4(); + let msg1_pb = PeerConnNoiseMsg1Pb { + version: VERSION, + a_network_name: network.network_name.clone(), + a_session_generation, + a_conn_id: Some(a_conn_id.into()), + client_encryption_algorithm: self.my_encrypt_algo.clone(), + features: vec![LIVENESS_ECHO_FEATURE.to_owned()], + }; + + let mut hs = builder + .prologue(&prologue)? + .local_private_key(&local_private_key)? + .build_initiator()?; + + self.send_noise_msg( + msg1_pb, + PacketType::NoiseHandshakeMsg1, + PeerId::default(), + &network.network_name, + &mut hs, + ) + .await?; + + let server_handshake_hash = hs.get_handshake_hash().to_vec(); + + let msg2 = timeout( + Duration::from_secs(5), + self.recv_next_peer_manager_packet(Some(PacketType::NoiseHandshakeMsg2)), + ) + .await??; + self.record_control_rx(&network.network_name, msg2.buf_len() as u64); + let remote_peer_id = msg2.get_src_peer_id().expect("missing src peer id"); + if let Some(hint) = self.peer_id_hint + && hint != remote_peer_id + { + return Err(Error::WaitRespError("peer_id mismatch".to_owned())); + } + let msg2_pb = Self::decode_handshake_message::( + PacketType::NoiseHandshakeMsg2, + Some(&mut hs), + msg2, + )?; + if msg2_pb.a_conn_id_echo != Some(a_conn_id.into()) { + return Err(Error::WaitRespError( + "noise msg2 conn_id_echo mismatch".to_owned(), + )); + } + let action = PeerConnSessionActionPb::try_from(msg2_pb.action) + .map_err(|_| Error::WaitRespError("invalid session action".to_owned()))?; + let remote_network_name = msg2_pb.b_network_name.clone(); + let remote_sent_secret_proof = msg2_pb.secret_proof_32.is_some(); + + if remote_network_name == network.network_name && msg2_pb.role_hint != 1 { + return Err(Error::WaitRespError( + "role_hint must be 1 when network_name is same".to_owned(), + )); + } + + let handshake_hash_for_proof = hs.get_handshake_hash().to_vec(); + let secret_proof_32 = self + .context + .secret_proof(&handshake_hash_for_proof) + .map(|mac| mac.finalize().into_bytes().to_vec()); + + let secret_digest = self.context.secret_digest(&network); + + let msg3_pb = PeerConnNoiseMsg3Pb { + a_conn_id_echo: Some(a_conn_id.into()), + b_conn_id_echo: msg2_pb.b_conn_id, + secret_proof_32, + secret_digest: secret_digest.clone(), + }; + self.send_noise_msg( + msg3_pb, + PacketType::NoiseHandshakeMsg3, + remote_peer_id, + &network.network_name, + &mut hs, + ) + .await?; + + let remote_static = hs + .get_remote_static() + .map(|x: &[u8]| x.to_vec()) + .unwrap_or_default(); + let remote_static_key = if remote_static.len() == 32 { + let mut key = [0u8; 32]; + key.copy_from_slice(&remote_static); + Some(key) + } else { + None + }; + + // Verify server authentication using unified logic + let secure_auth_level = if msg2_pb.role_hint != 1 && pinned_remote_pubkey.is_none() { + SecureAuthLevel::EncryptedUnauthenticated + } else { + self.verify_remote_auth( + msg2_pb.secret_proof_32.as_deref(), + &server_handshake_hash, + &remote_static, + pinned_remote_pubkey.as_deref(), + network.network_secret.is_some(), + true, // is_initiator + &remote_network_name, + )? + }; + let peer_identity_type = self.classify_remote_identity( + &remote_network_name, + secure_auth_level, + msg2_pb.role_hint == 1, + remote_sent_secret_proof, + true, + ); + + let algo = self.context.flags().encryption_algorithm.clone(); + let root_key = msg2_pb + .root_key_32 + .as_deref() + .filter(|v| v.len() == 32) + .map(|v| { + let mut key = [0u8; 32]; + key.copy_from_slice(v); + key + }); + let session_action = match action { + PeerConnSessionActionPb::Join => PeerSessionAction::Join, + PeerConnSessionActionPb::Sync => PeerSessionAction::Sync, + PeerConnSessionActionPb::Create => PeerSessionAction::Create, + }; + let session = self.get_peer_session_store().apply_initiator_action( + &SessionKey::new(network.network_name.clone(), remote_peer_id), + session_action, + msg2_pb.b_session_generation, + root_key, + msg2_pb.initial_epoch, + algo, + msg2_pb.server_encryption_algorithm.clone(), + remote_static_key, + )?; + + Ok(NoiseHandshakeResult { + peer_id: remote_peer_id, + session, + local_static_pubkey: local_static_pubkey.to_vec(), + remote_static_pubkey: remote_static, + secure_auth_level, + peer_identity_type, + remote_network_name, + // we have authorized the peer with noise handshake, so just set secret digest same as us even remote is a shared node. + secret_digest, + client_secret_proof: None, + remote_features: msg2_pb.features, + }) + } + + fn decode_handshake_message( + expected_pkt_type: PacketType, + hs: Option<&mut HandshakeState>, + pkt: ZCPacket, + ) -> Result + where + MsgT: prost::Message + Default, + { + tracing::info!( + "decode_handshake_message: {:?}, expected_pkt_type: {:?}", + pkt, + expected_pkt_type + ); + let Some(hdr) = pkt.peer_manager_header() else { + return Err(Error::WaitRespError( + "packet without peer manager header".to_owned(), + )); + }; + + if hdr.packet_type != expected_pkt_type as u8 { + return Err(Error::WaitRespError(format!( + "packet type not {:?}", + expected_pkt_type + ))); + } + + let msg = match hs { + Some(hs) => { + let mut out = vec![0u8; 4096]; + let out_len = hs + .read_message(pkt.payload(), &mut out) + .map_err(|e| Error::WaitRespError(format!("noise read msg failed: {e:?}")))?; + MsgT::decode(&out[..out_len]) + .map_err(|e| Error::WaitRespError(format!("decode message failed: {e:?}")))? + } + None => MsgT::decode(pkt.payload()) + .map_err(|e| Error::WaitRespError(format!("decode message failed: {e:?}")))?, + }; + + Ok(msg) + } + + async fn do_noise_handshake_as_server( + &mut self, + first_msg1: ZCPacket, + mut handshake_recved: Fn, + ) -> Result + where + Fn: FnMut(&mut PeerConn, &str) -> Result<(), Error> + Send, + { + let prologue = b"easytier-peerconn-noise".to_vec(); + + let params: NoiseParams = "Noise_XX_25519_ChaChaPoly_SHA256" + .parse() + .map_err(|e| Error::WaitRespError(format!("parse noise params failed: {e:?}")))?; + let builder = snow::Builder::new(params); + + let (local_static_private_key, local_static_pubkey) = self.get_keypair()?; + + let mut hs = builder + .prologue(&prologue)? + .local_private_key(&local_static_private_key)? + .build_responder()?; + + let remote_peer_id = first_msg1 + .get_src_peer_id() + .expect("msg1 must have src peer id"); + let first_msg1_len = first_msg1.buf_len() as u64; + + let msg1_pb = Self::decode_handshake_message::( + PacketType::NoiseHandshakeMsg1, + Some(&mut hs), + first_msg1, + )?; + let remote_network_name = msg1_pb.a_network_name.clone(); + self.record_control_rx(&remote_network_name, first_msg1_len); + + // this may update my peer id + handshake_recved(self, &remote_network_name)?; + + let server_network_name = self.context.network_name(); + let (role_hint, secret_proof_32) = if msg1_pb.a_network_name == server_network_name { + ( + 1, + self.context + .secret_proof(hs.get_handshake_hash()) + .map(|m| m.finalize().into_bytes().to_vec()), + ) + } else { + (2, None) + }; + + let algo = self.context.flags().encryption_algorithm.clone(); + let UpsertResponderSessionReturn { + session, + action, + session_generation: b_session_generation, + root_key: root_key_32, + initial_epoch, + } = self.get_peer_session_store().upsert_responder_session( + &SessionKey::new(remote_network_name.clone(), remote_peer_id), + msg1_pb.a_session_generation, + algo.clone(), + msg1_pb.client_encryption_algorithm.clone(), + None, + )?; + + let b_conn_id = uuid::Uuid::new_v4(); + let msg2_pb = PeerConnNoiseMsg2Pb { + b_network_name: server_network_name, + role_hint, + action: match action { + PeerSessionAction::Join => PeerConnSessionActionPb::Join as i32, + PeerSessionAction::Sync => PeerConnSessionActionPb::Sync as i32, + PeerSessionAction::Create => PeerConnSessionActionPb::Create as i32, + }, + b_session_generation, + root_key_32: root_key_32.map(|k| k.to_vec()), + initial_epoch, + b_conn_id: Some(b_conn_id.into()), + a_conn_id_echo: msg1_pb.a_conn_id, + secret_proof_32, + server_encryption_algorithm: algo, + features: vec![LIVENESS_ECHO_FEATURE.to_owned()], + }; + self.send_noise_msg( + msg2_pb, + PacketType::NoiseHandshakeMsg2, + remote_peer_id, + &remote_network_name, + &mut hs, + ) + .await?; + + let handshake_hash_for_proof = hs.get_handshake_hash().to_vec(); + + let msg3_pkt = timeout( + Duration::from_secs(5), + self.recv_next_peer_manager_packet(Some(PacketType::NoiseHandshakeMsg3)), + ) + .await??; + self.record_control_rx(&remote_network_name, msg3_pkt.buf_len() as u64); + let msg3_pb = Self::decode_handshake_message::( + PacketType::NoiseHandshakeMsg3, + Some(&mut hs), + msg3_pkt, + )?; + + if msg3_pb.a_conn_id_echo != msg1_pb.a_conn_id { + return Err(Error::WaitRespError( + "noise msg3 a_conn_id mismatch".to_owned(), + )); + } + if msg3_pb.b_conn_id_echo != Some(b_conn_id.into()) { + return Err(Error::WaitRespError( + "noise msg3 b_conn_id mismatch".to_owned(), + )); + } + + let remote_static = hs + .get_remote_static() + .map(|x: &[u8]| x.to_vec()) + .unwrap_or_default(); + let remote_static_key = if remote_static.len() == 32 { + let mut key = [0u8; 32]; + key.copy_from_slice(&remote_static); + Some(key) + } else { + None + }; + session.check_or_set_peer_static_pubkey(remote_static_key)?; + + // Verify client authentication using unified logic + // Note: Server doesn't use pinned_pubkey since it's the responder + let secure_auth_level = if role_hint == 1 { + self.verify_remote_auth( + msg3_pb.secret_proof_32.as_deref(), + &handshake_hash_for_proof, + &remote_static, + None, // Server doesn't have pinned_remote_pubkey + self.context.network_identity().network_secret.is_some(), + false, // is_initiator + &remote_network_name, + )? + } else { + SecureAuthLevel::EncryptedUnauthenticated + }; + let peer_identity_type = self.classify_remote_identity( + &remote_network_name, + secure_auth_level, + role_hint == 1, + msg3_pb.secret_proof_32.is_some(), + false, + ); + + Ok(NoiseHandshakeResult { + peer_id: remote_peer_id, + session, + local_static_pubkey: local_static_pubkey.to_vec(), + remote_static_pubkey: remote_static, + secure_auth_level, + peer_identity_type, + remote_network_name, + secret_digest: msg3_pb.secret_digest, + client_secret_proof: msg3_pb.secret_proof_32.as_ref().map(|p| SecretProof { + challenge: handshake_hash_for_proof, + proof: p.clone(), + }), + remote_features: msg1_pb.features, + }) + } + + fn build_handshake_rsp(&self, noise: &NoiseHandshakeResult) -> HandshakeRequest { + tracing::info!("build_handshake_rsp: {:?}", noise); + HandshakeRequest { + magic: MAGIC, + my_peer_id: noise.peer_id, + version: VERSION, + network_name: noise.remote_network_name.clone(), + + features: noise.remote_features.clone(), + network_secret_digest: noise.secret_digest.clone(), + } + } + + #[tracing::instrument(skip(handshake_recved))] + pub async fn do_handshake_as_server_ext( + &mut self, + mut handshake_recved: Fn, + ) -> Result<(), Error> + where + Fn: FnMut(&mut PeerConn, &str) -> Result<(), Error> + Send, + { + let first_pkt = timeout( + Duration::from_secs(5), + self.recv_next_peer_manager_packet(None), + ) + .await??; + let Some(hdr) = first_pkt.peer_manager_header() else { + return Err(Error::WaitRespError( + "first packet must have peer manager header".to_owned(), + )); + }; + + if self.is_secure_mode_enabled() && hdr.packet_type == PacketType::NoiseHandshakeMsg1 as u8 + { + let noise = self + .do_noise_handshake_as_server(first_pkt, handshake_recved) + .await?; + // construct handshake rsp from noise result for compat. + let handshake_rsp = self.build_handshake_rsp(&noise); + self.session_filter.set_session(noise.session.clone()); + self.session_filter.set_peer_id(noise.peer_id); + self.noise_handshake_result = Some(noise); + + self.info = Some(handshake_rsp); + self.is_client = Some(false); + } else if hdr.packet_type == PacketType::HandShake as u8 { + let rsp = Self::decode_handshake_packet(&first_pkt)?; + handshake_recved(self, &rsp.network_name)?; + tracing::info!("handshake request: {:?}", rsp); + self.record_control_rx(&rsp.network_name, first_pkt.buf_len() as u64); + self.info = Some(rsp); + self.is_client = Some(false); + + let send_digest = self.get_network_identity() == self.context.network_identity(); + self.send_handshake(send_digest, &self.get_network_identity().network_name) + .await?; + } else { + return Err(Error::WaitRespError(format!( + "unexpected packet type during handshake: {}", + hdr.packet_type + ))); + } + + self.liveness + .set_remote_features(&self.info.as_ref().unwrap().features); + + if self.get_peer_id() == self.my_peer_id { + Err(Error::WaitRespError("peer id conflict".to_owned())) + } else { + Ok(()) + } + } + + #[tracing::instrument] + pub async fn do_handshake_as_client(&mut self) -> Result<(), Error> { + if self.is_secure_mode_enabled() { + let noise = self.do_noise_handshake_as_client().await?; + self.session_filter.set_session(noise.session.clone()); + self.session_filter.set_peer_id(noise.peer_id); + + let handshake_rsp = self.build_handshake_rsp(&noise); + self.noise_handshake_result = Some(noise); + self.info = Some(handshake_rsp); + self.is_client = Some(true); + } else { + let network = self.context.network_identity(); + self.send_handshake(true, &network.network_name).await?; + tracing::info!("waiting for handshake request from server"); + let rsp = self.wait_handshake_loop().await?; + tracing::info!("handshake response: {:?}", rsp); + self.info = Some(rsp); + self.is_client = Some(true); + } + + self.liveness + .set_remote_features(&self.info.as_ref().unwrap().features); + + if self.get_peer_id() == self.my_peer_id { + Err(Error::WaitRespError( + "peer id conflict, are you connecting to yourself?".to_owned(), + )) + } else { + Ok(()) + } + } + + fn record_control_tx(&self, network_name: &str, bytes: u64) { + self.context.record_control_tx(network_name, bytes); + } + + fn record_control_rx(&self, network_name: &str, bytes: u64) { + self.context.record_control_rx(network_name, bytes); + } + + pub async fn start_recv_loop(&mut self, packet_recv_chan: PacketRecvChan) { + let mut stream = self.recv.lock().await.take().unwrap(); + let sink = self.sink.clone(); + let sender = packet_recv_chan.clone(); + let close_event_notifier = self.close_event_notifier.clone(); + let ctrl_sender = self.ctrl_resp_sender.clone(); + let conn_info_for_instrument = self.get_conn_info(); + let context = self.context.clone(); + let ingress = PeerPacketIngress::Peer { + peer_id: self.get_peer_id(), + conn_id: self.conn_id, + origin: self.origin, + }; + let control_network_name = conn_info_for_instrument.network_name.clone(); + + let is_foreign_network = + conn_info_for_instrument.network_name != self.context.network_identity().network_name; + let recv_limiter = self + .context + .recv_limiter(&conn_info_for_instrument.network_name, is_foreign_network); + + self.tasks.spawn( + async move { + tracing::info!("start recving peer conn packet"); + let mut task_ret = Ok(()); + while let Some(ret) = stream.next().await { + if ret.is_err() { + tracing::error!(error = ?ret, "peer conn recv error"); + task_ret = Err(ret.err().unwrap()); + break; + } + + let mut zc_packet = ret.unwrap(); + let buf_len = zc_packet.buf_len() as u64; + if let Some(payload_len) = data_packet_payload_len(&zc_packet) + && let Some(limiter) = recv_limiter.as_ref() + && !limiter.try_consume(payload_len) + { + continue; + } + let Some(peer_mgr_hdr) = zc_packet.mut_peer_manager_header() else { + tracing::error!( + "unexpected packet: {:?}, cannot decode peer manager hdr", + zc_packet + ); + break; + }; + + if peer_mgr_hdr.packet_type == PacketType::Ping as u8 { + context.record_control_rx(&control_network_name, buf_len); + peer_mgr_hdr.packet_type = PacketType::Pong as u8; + if let Err(e) = sink.send(zc_packet).await { + tracing::error!(?e, "peer conn send req error"); + } else { + context.record_control_tx(&control_network_name, buf_len); + } + } else if peer_mgr_hdr.packet_type == PacketType::Pong as u8 { + context.record_control_rx(&control_network_name, buf_len); + if let Err(e) = ctrl_sender.send(zc_packet) { + tracing::error!(?e, "peer conn send ctrl resp error"); + } + } else if send_peer_packet_to_chan(&sender, zc_packet, ingress) + .await + .is_err() + { + break; + } + } + + tracing::info!("end recving peer conn packet"); + + drop(sink); + close_event_notifier.notify_close(); + + task_ret + } + .instrument( + tracing::info_span!("peer conn recv loop", conn_info = ?conn_info_for_instrument), + ), + ); + } + + pub fn start_pingpong(&mut self) { + let mut pingpong = PeerConnPinger::new( + self.my_peer_id, + self.get_peer_id(), + self.sink.clone(), + self.ctrl_resp_sender.clone(), + self.latency_stats.clone(), + self.loss_rate_stats.clone(), + self.throughput.clone(), + self.context.clone(), + self.get_conn_info().network_name, + self.liveness.clone(), + self.max_ping_interval(), + ); + + let close_event_notifier = self.close_event_notifier.clone(); + + self.tasks.spawn(async move { + pingpong.pingpong().await; + + tracing::warn!(?pingpong, "pingpong task exit"); + + close_event_notifier.notify_close(); + + Ok(()) + }); + } + + pub async fn send_msg(&self, msg: ZCPacket) -> Result<(), Error> { + Ok(self.sink.send(msg).await?) + } + + pub fn get_peer_id(&self) -> PeerId { + self.info.as_ref().unwrap().my_peer_id + } + + pub fn get_network_identity(&self) -> NetworkIdentity { + let info = self.info.as_ref().unwrap(); + let mut ret = NetworkIdentity { + network_name: info.network_name.clone(), + network_secret: None, + network_secret_digest: Some([0u8; 32]), + }; + ret.network_secret_digest + .as_mut() + .unwrap() + .copy_from_slice(&info.network_secret_digest); + ret + } + + fn network_secret_digest_is_empty(network: &NetworkIdentity) -> bool { + network + .secret_digest() + .as_ref() + .is_none_or(|digest| digest.iter().all(|byte| *byte == 0)) + } + + fn matches_local_secret_proof(&self) -> bool { + let Some(secret_proof) = self + .noise_handshake_result + .as_ref() + .and_then(|noise| noise.client_secret_proof.as_ref()) + else { + return false; + }; + + self.context + .secret_proof(&secret_proof.challenge) + .is_some_and(|mac| mac.verify_slice(&secret_proof.proof).is_ok()) + } + + pub fn matches_local_network_secret(&self) -> bool { + if self.matches_local_secret_proof() { + return true; + } + + let my_identity = self.context.network_identity(); + let peer_identity = self.get_network_identity(); + + !Self::network_secret_digest_is_empty(&my_identity) + && !Self::network_secret_digest_is_empty(&peer_identity) + && my_identity.secret_digest() == peer_identity.secret_digest() + } + + pub fn get_close_notifier(&self) -> Arc { + self.close_event_notifier.clone() + } + + pub fn get_stats(&self) -> PeerConnStats { + PeerConnStats { + latency_us: self.latency_stats.get_latency_us(), + + tx_bytes: self.throughput.tx_bytes(), + rx_bytes: self.throughput.rx_bytes(), + + tx_packets: self.throughput.tx_packets(), + rx_packets: self.throughput.rx_packets(), + } + } + + pub fn get_conn_info(&self) -> PeerConnInfo { + let info = self.info.as_ref().unwrap(); + PeerConnInfo { + conn_id: self.conn_id.to_string(), + my_peer_id: self.my_peer_id, + peer_id: self.get_peer_id(), + features: info.features.clone(), + tunnel: self.tunnel_info.clone(), + stats: Some(self.get_stats()), + loss_rate: (f64::from(self.loss_rate_stats.load(Ordering::Relaxed)) / 100.0) as f32, + is_client: self.is_client.unwrap_or_default(), + network_name: info.network_name.clone(), + is_closed: self.close_event_notifier.is_closed(), + noise_local_static_pubkey: self + .noise_handshake_result + .as_ref() + .map(|x| x.local_static_pubkey.clone()) + .unwrap_or_default(), + noise_remote_static_pubkey: self + .noise_handshake_result + .as_ref() + .map(|x| x.remote_static_pubkey.clone()) + .unwrap_or_default(), + secure_auth_level: self + .noise_handshake_result + .as_ref() + .map(|x| x.secure_auth_level as i32) + .unwrap_or_default(), + peer_identity_type: self + .noise_handshake_result + .as_ref() + .map(|x| x.peer_identity_type as i32) + .unwrap_or(PeerIdentityType::Admin as i32), + } + } + + pub fn get_peer_identity_type(&self) -> PeerIdentityType { + self.noise_handshake_result + .as_ref() + .map(|x| x.peer_identity_type) + .unwrap_or(PeerIdentityType::Admin) + } + + pub fn set_peer_id(&mut self, peer_id: PeerId) { + if self.info.is_some() { + panic!("set_peer_id should only be called before handshake"); + } + self.my_peer_id = peer_id; + self.session_filter.set_my_peer_id(peer_id); + } + + pub fn get_my_peer_id(&self) -> PeerId { + self.my_peer_id + } +} + +impl Drop for PeerConn { + fn drop(&mut self) { + // if someone drop a conn manually, the notifier is not called. + self.close_event_notifier.notify_close(); + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::{peers::test_support::NoopPeerContext, tunnel::ring::create_ring_tunnel_pair}; + + #[tokio::test] + async fn connection_origin_determines_hole_punch_and_ping_policy() { + for (origin, is_hole_punched, max_interval) in [ + (PeerConnectionOrigin::Manual, false, 32), + (PeerConnectionOrigin::Direct, false, 32), + (PeerConnectionOrigin::Listener, false, 32), + (PeerConnectionOrigin::TcpHolePunch, true, 1), + (PeerConnectionOrigin::UdpHolePunch, true, 32), + (PeerConnectionOrigin::Attached, false, 32), + ] { + // Admission determines the policy even when the transport is a ring. + let (tunnel, _remote_tunnel) = create_ring_tunnel_pair(); + let conn = PeerConn::new_with_peer_id_hint_and_origin( + 1, + Arc::new(NoopPeerContext::default()), + tunnel, + None, + Arc::new(PeerSessionStore::new()), + origin, + ); + + assert_eq!(conn.is_hole_punched(), is_hole_punched, "{origin:?}"); + assert_eq!( + conn.max_ping_interval(), + Duration::from_secs(max_interval), + "{origin:?}", + ); + assert_eq!(conn.is_attached(), origin == PeerConnectionOrigin::Attached); + } + } +} diff --git a/vendor/easytier/easytier-core/src/peers/conn/peer_conn_liveness.rs b/vendor/easytier/easytier-core/src/peers/conn/peer_conn_liveness.rs new file mode 100644 index 0000000..939cbe6 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/conn/peer_conn_liveness.rs @@ -0,0 +1,310 @@ +use std::sync::{ + Arc, + atomic::{AtomicBool, AtomicU8, AtomicU16, Ordering}, +}; + +use tokio::sync::Notify; + +use crate::tunnel::{SinkItem, StreamItem, filter::TunnelFilter}; + +pub(super) const FEATURE: &str = "liveness-echo-v1"; + +#[derive(Clone, Default)] +pub(super) struct PeerConnLiveness { + inner: Arc, +} + +#[derive(Default)] +struct PeerConnLivenessInner { + enabled: AtomicBool, + next_token: AtomicU8, + active_probe: AtomicU16, + acknowledged_probe: AtomicU16, + pending_echo: AtomicU16, + echo_received: Notify, +} + +impl PeerConnLiveness { + pub(super) fn new() -> Self { + Self::default() + } + + pub(super) fn set_enabled(&self, enabled: bool) { + self.inner.enabled.store(enabled, Ordering::Release); + if !enabled { + self.inner.active_probe.store(0, Ordering::Release); + self.inner.acknowledged_probe.store(0, Ordering::Release); + self.inner.pending_echo.store(0, Ordering::Release); + } + } + + pub(super) fn set_remote_features(&self, features: &[String]) { + self.set_enabled(features.iter().any(|feature| feature == FEATURE)); + } + + pub(super) fn start_probe(&self) -> Option { + if !self.inner.enabled.load(Ordering::Acquire) { + return None; + } + + let active = self.inner.active_probe.load(Ordering::Acquire); + if active != 0 { + return Some(Self::decode_probe(active)); + } + + let token = self + .inner + .next_token + .fetch_add(1, Ordering::Relaxed) + .wrapping_add(1); + self.inner.acknowledged_probe.store(0, Ordering::Release); + self.inner + .active_probe + .store(Self::encode_probe(token), Ordering::Release); + Some(token) + } + + pub(super) async fn wait_for_echo(&self, token: u8) { + let expected = Self::encode_probe(token); + loop { + let notified = self.inner.echo_received.notified(); + if self.inner.acknowledged_probe.load(Ordering::Acquire) == expected { + return; + } + notified.await; + } + } + + pub(super) fn finish_probe(&self, token: u8) { + let probe = Self::encode_probe(token); + let _ = + self.inner + .active_probe + .compare_exchange(probe, 0, Ordering::AcqRel, Ordering::Acquire); + let _ = self.inner.acknowledged_probe.compare_exchange( + probe, + 0, + Ordering::AcqRel, + Ordering::Acquire, + ); + } + + fn encode_probe(token: u8) -> u16 { + u16::from(token) + 1 + } + + fn decode_probe(probe: u16) -> u8 { + (probe - 1) as u8 + } + + fn active_probe(&self) -> Option { + let probe = self.inner.active_probe.load(Ordering::Acquire); + (probe != 0).then(|| Self::decode_probe(probe)) + } + + fn queue_echo(&self, token: u8) { + self.inner + .pending_echo + .store(Self::encode_probe(token), Ordering::Release); + } + + fn take_echo(&self) -> Option { + let echo = self.inner.pending_echo.swap(0, Ordering::AcqRel); + (echo != 0).then(|| Self::decode_probe(echo)) + } + + fn acknowledge(&self, token: u8) { + let probe = Self::encode_probe(token); + if self + .inner + .active_probe + .compare_exchange(probe, 0, Ordering::AcqRel, Ordering::Acquire) + .is_ok() + { + self.inner + .acknowledged_probe + .store(probe, Ordering::Release); + self.inner.echo_received.notify_one(); + } + } +} + +impl TunnelFilter for PeerConnLiveness { + type FilterOutput = (); + + fn before_send(&self, mut data: SinkItem) -> Option { + if !self.inner.enabled.load(Ordering::Acquire) { + return Some(data); + } + + let Some(header) = data.mut_peer_manager_header() else { + return Some(data); + }; + header.clear_liveness_marker(); + if let Some(token) = self.take_echo() { + header.set_liveness_echo(token); + } else if let Some(token) = self.active_probe() { + header.set_liveness_probe(token); + } + Some(data) + } + + fn after_received(&self, data: StreamItem) -> Option { + let Ok(mut packet) = data else { + return Some(data); + }; + if !self.inner.enabled.load(Ordering::Acquire) { + return Some(Ok(packet)); + } + + let Some(header) = packet.mut_peer_manager_header() else { + return Some(Ok(packet)); + }; + let probe = header.liveness_probe_token(); + let echo = header.liveness_echo_token(); + header.clear_liveness_marker(); + + match (probe, echo) { + (Some(token), None) => self.queue_echo(token), + (None, Some(token)) => self.acknowledge(token), + _ => {} + } + Some(Ok(packet)) + } + + fn filter_output(&self) {} +} + +#[cfg(test)] +mod tests { + use std::time::Duration; + + use crate::{ + packet::{PacketType, ZCPacket}, + tunnel::filter::TunnelFilter, + }; + + use super::{FEATURE, PeerConnLiveness}; + + fn data_packet(from: u32, to: u32) -> ZCPacket { + let mut packet = ZCPacket::new_with_payload(b"payload"); + packet.fill_peer_manager_hdr(from, to, PacketType::Data as u8); + packet + } + + #[tokio::test] + async fn echoed_business_packet_proves_round_trip_liveness() { + let local = PeerConnLiveness::new(); + let remote = PeerConnLiveness::new(); + local.set_enabled(true); + remote.set_enabled(true); + + let token = local.start_probe().expect("feature enabled"); + let outbound = local.before_send(data_packet(1, 2)).unwrap(); + let received = remote.after_received(Ok(outbound)).unwrap().unwrap(); + assert_eq!(received.payload(), b"payload"); + let header = received.peer_manager_header().unwrap(); + assert_eq!(header.liveness_probe_token(), None); + assert_eq!(header.liveness_echo_token(), None); + + let reply = remote.before_send(data_packet(2, 1)).unwrap(); + let received = local.after_received(Ok(reply)).unwrap().unwrap(); + assert_eq!(received.payload(), b"payload"); + let header = received.peer_manager_header().unwrap(); + assert_eq!(header.liveness_probe_token(), None); + assert_eq!(header.liveness_echo_token(), None); + + tokio::time::timeout(Duration::from_millis(50), local.wait_for_echo(token)) + .await + .expect("matching echo was not observed"); + } + + #[test] + fn old_peer_without_feature_keeps_liveness_markers_disabled() { + let liveness = PeerConnLiveness::new(); + liveness.set_remote_features(&[]); + assert_eq!(liveness.start_probe(), None); + + liveness.set_remote_features(&[FEATURE.to_owned()]); + assert!(liveness.start_probe().is_some()); + } + + #[tokio::test] + async fn unrelated_ingress_does_not_acknowledge_an_active_probe() { + let liveness = PeerConnLiveness::new(); + liveness.set_enabled(true); + let token = liveness.start_probe().unwrap(); + + for _ in 0..8 { + liveness + .after_received(Ok(data_packet(2, 1))) + .unwrap() + .unwrap(); + } + + assert!( + tokio::time::timeout(Duration::from_millis(20), liveness.wait_for_echo(token)) + .await + .is_err(), + "unrelated one-way ingress acknowledged the local probe" + ); + } + + #[tokio::test] + async fn stale_echo_does_not_acknowledge_a_new_probe() { + let liveness = PeerConnLiveness::new(); + liveness.set_enabled(true); + + let old_token = liveness.start_probe().unwrap(); + let mut old_echo = data_packet(2, 1); + old_echo + .mut_peer_manager_header() + .unwrap() + .set_liveness_echo(old_token); + liveness.after_received(Ok(old_echo)).unwrap().unwrap(); + liveness.wait_for_echo(old_token).await; + + let new_token = liveness.start_probe().unwrap(); + assert_ne!(old_token, new_token); + let mut stale_echo = data_packet(2, 1); + stale_echo + .mut_peer_manager_header() + .unwrap() + .set_liveness_echo(old_token); + liveness.after_received(Ok(stale_echo)).unwrap().unwrap(); + + assert!( + tokio::time::timeout(Duration::from_millis(20), liveness.wait_for_echo(new_token)) + .await + .is_err(), + "stale echo acknowledged a newer probe" + ); + } + + #[tokio::test] + async fn simultaneous_probes_are_echoed_in_both_directions() { + let left = PeerConnLiveness::new(); + let right = PeerConnLiveness::new(); + left.set_enabled(true); + right.set_enabled(true); + let left_token = left.start_probe().unwrap(); + let right_token = right.start_probe().unwrap(); + + let left_probe = left.before_send(data_packet(1, 2)).unwrap(); + let right_probe = right.before_send(data_packet(2, 1)).unwrap(); + right.after_received(Ok(left_probe)).unwrap().unwrap(); + left.after_received(Ok(right_probe)).unwrap().unwrap(); + + let left_echo = left.before_send(data_packet(1, 2)).unwrap(); + let right_echo = right.before_send(data_packet(2, 1)).unwrap(); + right.after_received(Ok(left_echo)).unwrap().unwrap(); + left.after_received(Ok(right_echo)).unwrap().unwrap(); + + tokio::time::timeout(Duration::from_millis(50), left.wait_for_echo(left_token)) + .await + .unwrap(); + tokio::time::timeout(Duration::from_millis(50), right.wait_for_echo(right_token)) + .await + .unwrap(); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/conn/peer_conn_ping.rs b/vendor/easytier/easytier-core/src/peers/conn/peer_conn_ping.rs new file mode 100644 index 0000000..caa0836 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/conn/peer_conn_ping.rs @@ -0,0 +1,496 @@ +use std::{ + sync::{ + Arc, + atomic::{AtomicU32, Ordering}, + }, + time::{Duration, Instant}, +}; + +use rand::{Rng, thread_rng}; +use tokio::{ + sync::{broadcast, mpsc::error::TrySendError}, + task::JoinSet, +}; + +use crate::{ + config::PeerId, + foundation::time::{Interval, interval, timeout}, + packet::{PacketType, ZCPacket}, + peers::{conn::peer_conn_liveness::PeerConnLiveness, context::ArcPeerContext, error::Error}, + tunnel::{ + mpsc::MpscTunnelSender, + stats::{Throughput, WindowLatency}, + }, +}; + +#[derive(Debug)] +enum PingResponse { + Pong(u128), + LivenessEcho, +} + +struct PingIntervalController { + throughput: Arc, + loss_counter: Arc, + + interval: Interval, + max_interval: Duration, + + logic_time: u64, + last_send_logic_time: u64, + + backoff_idx: i32, + max_backoff_idx: i32, + + last_throughput: Throughput, +} + +impl std::fmt::Debug for PingIntervalController { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PingIntervalController") + .field("throughput", &self.throughput) + .field("loss_counter", &self.loss_counter) + .field("logic_time", &self.logic_time) + .field("last_send_logic_time", &self.last_send_logic_time) + .field("backoff_idx", &self.backoff_idx) + .field("max_backoff_idx", &self.max_backoff_idx) + .field("max_interval", &self.max_interval) + .field("last_throughput", &self.last_throughput) + .finish() + } +} + +impl PingIntervalController { + fn new( + throughput: Arc, + loss_counter: Arc, + max_interval: Duration, + ) -> Self { + let last_throughput = (*throughput).clone(); + + Self { + throughput, + loss_counter, + interval: interval(Duration::from_secs(1)), + max_interval, + logic_time: 0, + last_send_logic_time: 0, + + backoff_idx: 0, + max_backoff_idx: 5, + + last_throughput, + } + } + + async fn tick(&mut self) { + self.interval.tick().await; + self.logic_time += 1; + } + + fn tx_increase(&self) -> bool { + self.throughput.tx_packets() > self.last_throughput.tx_packets() + } + + fn rx_increase(&self) -> bool { + self.throughput.rx_packets() > self.last_throughput.rx_packets() + } + + fn should_send_ping(&mut self) -> bool { + if self.loss_counter.load(Ordering::Relaxed) > 0 { + self.backoff_idx = 0; + } else if self.tx_increase() && !self.rx_increase() { + // if tx increase but rx not increase, we should do pingpong more frequently + self.backoff_idx = 0; + } + + self.last_throughput = (*self.throughput).clone(); + + let send_interval = Duration::from_secs(1 << self.backoff_idx).min(self.max_interval); + if Duration::from_secs(self.logic_time - self.last_send_logic_time) < send_interval { + return false; + } + + self.backoff_idx = std::cmp::min(self.backoff_idx + 1, self.max_backoff_idx); + + // use this makes two peers not pingpong at the same time + if self.backoff_idx > self.max_backoff_idx - 2 && thread_rng().gen_bool(0.2) { + self.backoff_idx -= 1; + } + + self.last_send_logic_time = self.logic_time; + true + } +} + +pub struct PeerConnPinger { + my_peer_id: PeerId, + peer_id: PeerId, + sink: MpscTunnelSender, + ctrl_sender: broadcast::Sender, + latency_stats: Arc, + loss_rate_stats: Arc, + throughput_stats: Arc, + context: ArcPeerContext, + network_name: String, + liveness: PeerConnLiveness, + max_interval: Duration, +} + +impl std::fmt::Debug for PeerConnPinger { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PeerConnPinger") + .field("my_peer_id", &self.my_peer_id) + .field("peer_id", &self.peer_id) + .finish() + } +} + +impl PeerConnPinger { + #[allow(clippy::too_many_arguments)] + pub(super) fn new( + my_peer_id: PeerId, + peer_id: PeerId, + sink: MpscTunnelSender, + ctrl_sender: broadcast::Sender, + latency_stats: Arc, + loss_rate_stats: Arc, + throughput_stats: Arc, + context: ArcPeerContext, + network_name: String, + liveness: PeerConnLiveness, + max_interval: Duration, + ) -> Self { + Self { + my_peer_id, + peer_id, + sink, + latency_stats, + ctrl_sender, + loss_rate_stats, + throughput_stats, + context, + network_name, + liveness, + max_interval, + } + } + + fn new_ping_packet(my_node_id: PeerId, peer_id: PeerId, seq: u32) -> ZCPacket { + let mut packet = ZCPacket::new_with_payload(&seq.to_le_bytes()); + packet.fill_peer_manager_hdr(my_node_id, peer_id, PacketType::Ping as u8); + packet + } + + async fn do_pingpong_once( + &self, + receiver: &mut broadcast::Receiver, + seq: u32, + liveness_token: Option, + ) -> Result { + // should add seq here. so latency can be calculated more accurately + let req = Self::new_ping_packet(self.my_peer_id, self.peer_id, seq); + let req_len = req.buf_len() as u64; + self.sink.send(req).await?; + self.context.record_control_tx(&self.network_name, req_len); + + let now = Instant::now(); + let wait_for_pong = async { + loop { + match receiver.recv().await { + Ok(p) => { + let payload = p.payload(); + let Ok(seq_buf) = payload[0..4].try_into() else { + tracing::debug!("pingpong recv invalid packet, continue"); + continue; + }; + let resp_seq = u32::from_le_bytes(seq_buf); + if resp_seq == seq { + break; + } + } + Err(e) => { + return Err(Error::WaitRespError(format!( + "wait ping response error: {:?}", + e + ))); + } + } + } + Ok(()) + }; + let resp = timeout(Duration::from_secs(2), async { + if let Some(token) = liveness_token { + tokio::select! { + ret = wait_for_pong => ret.map(|()| PingResponse::Pong(now.elapsed().as_micros())), + () = self.liveness.wait_for_echo(token) => Ok(PingResponse::LivenessEcho), + } + } else { + wait_for_pong + .await + .map(|()| PingResponse::Pong(now.elapsed().as_micros())) + } + }) + .await; + + tracing::trace!(?resp, "wait ping response done"); + + if resp.is_err() { + return Err(Error::WaitRespError( + "wait ping response timeout".to_owned(), + )); + } + + resp.unwrap() + } + + pub async fn pingpong(&mut self) { + let my_node_id = self.my_peer_id; + + // one with 1% precision + let loss_rate_stats_1 = WindowLatency::new(100); + // disconnect the connection if lost 5 pingpong consecutively + let loss_counter = Arc::new(AtomicU32::new(0)); + + let (trigger_sender, mut trigger_receiver) = tokio::sync::mpsc::channel(1); + let mut controller_tasks = JoinSet::new(); + let throughput = self.throughput_stats.clone(); + let controller_loss_counter = loss_counter.clone(); + let max_interval = self.max_interval; + controller_tasks.spawn(async move { + let mut controller = + PingIntervalController::new(throughput, controller_loss_counter, max_interval); + loop { + controller.tick().await; + if !controller.should_send_ping() { + continue; + } + match trigger_sender.try_send(()) { + Ok(()) | Err(TrySendError::Full(())) => {} + Err(TrySendError::Closed(())) => break, + } + } + }); + + let mut req_seq = 0u32; + while trigger_receiver.recv().await.is_some() { + tracing::debug!( + "pingpong controller send pingpong task, seq: {}, node_id: {}", + req_seq, + my_node_id, + ); + + let liveness_token = (loss_counter.load(Ordering::Relaxed) > 0) + .then(|| self.liveness.start_probe()) + .flatten(); + let mut receiver = self.ctrl_sender.subscribe(); + let ret = self + .do_pingpong_once(&mut receiver, req_seq, liveness_token) + .await; + req_seq = req_seq.wrapping_add(1); + + if let Ok(response) = &ret { + if let PingResponse::Pong(lat) = response { + self.latency_stats.record_latency(*lat as u32); + } + if let Some(token) = liveness_token { + self.liveness.finish_probe(token); + } + loss_rate_stats_1.record_latency(0); + loss_counter.store(0, Ordering::Relaxed); + } else { + loss_rate_stats_1.record_latency(1); + loss_counter.fetch_add(1, Ordering::Relaxed); + } + + let loss_rate_1: f64 = loss_rate_stats_1.get_latency_us(); + + tracing::trace!( + ?ret, + ?self, + ?loss_rate_1, + "pingpong task recv pingpong_once result" + ); + + tracing::debug!( + "loss_counter: {:?}, loss_rate_1: {}, node_id: {}", + loss_counter, + loss_rate_1, + my_node_id + ); + + if loss_counter.load(Ordering::Relaxed) >= 5 { + tracing::warn!( + ?ret, + ?self, + ?loss_rate_1, + ?loss_counter, + "too many consecutive pingpong failures, closing the connection", + ); + break; + } + + self.loss_rate_stats + .store((loss_rate_1 * 100.0) as u32, Ordering::Relaxed); + } + } +} + +#[cfg(test)] +mod tests { + use futures::{SinkExt, StreamExt}; + + use super::*; + use crate::{ + packet::PacketType, + peers::conn::peer_conn_liveness::PeerConnLiveness, + peers::test_support::NoopPeerContext, + tunnel::{ + Tunnel, filter::TunnelWithFilter, mpsc::MpscTunnel, ring::create_ring_tunnel_pair, + }, + }; + + #[cfg(not(target_os = "wasi"))] + #[tokio::test(start_paused = true)] + async fn one_second_limit_disables_ping_backoff() { + let mut controller = PingIntervalController::new( + Arc::new(Throughput::new()), + Arc::new(AtomicU32::new(0)), + Duration::from_secs(1), + ); + + let started_at = tokio::time::Instant::now(); + for second in 0..100 { + controller.tick().await; + assert_eq!(started_at.elapsed(), Duration::from_secs(second)); + assert!(controller.should_send_ping()); + assert!(!controller.should_send_ping()); + } + } + + #[cfg(not(target_os = "wasi"))] + #[tokio::test(start_paused = true)] + async fn ping_backoff_respects_non_power_of_two_limit() { + let mut controller = PingIntervalController::new( + Arc::new(Throughput::new()), + Arc::new(AtomicU32::new(0)), + Duration::from_secs(3), + ); + + for tick in 1..=100 { + controller.tick().await; + assert_eq!(controller.should_send_ping(), tick == 1 || tick % 3 == 0); + } + } + + #[cfg(not(target_os = "wasi"))] + #[tokio::test(start_paused = true)] + async fn default_limit_preserves_backoff_and_loss_retries() { + let loss_counter = Arc::new(AtomicU32::new(0)); + let mut controller = PingIntervalController::new( + Arc::new(Throughput::new()), + loss_counter.clone(), + Duration::from_secs(32), + ); + + for second in 1..=14 { + controller.tick().await; + assert_eq!(controller.should_send_ping(), matches!(second, 1 | 3 | 7)); + } + + loss_counter.store(1, Ordering::Relaxed); + for _ in 0..3 { + controller.tick().await; + assert!(controller.should_send_ping()); + } + } + + #[tokio::test(flavor = "current_thread")] + async fn ingress_traffic_does_not_mask_failed_round_trips() { + let (local_tunnel, _remote_tunnel) = create_ring_tunnel_pair(); + let tunnel = MpscTunnel::new(local_tunnel, None); + let (ctrl_sender, _) = broadcast::channel(16); + let throughput = Arc::new(Throughput::new()); + let mut pinger = PeerConnPinger::new( + 1, + 2, + tunnel.get_sink(), + ctrl_sender, + Arc::new(WindowLatency::new(15)), + Arc::new(AtomicU32::new(0)), + throughput.clone(), + Arc::new(NoopPeerContext::default()), + "test".to_owned(), + PeerConnLiveness::new(), + Duration::from_secs(32), + ); + + let ingress = tokio::spawn(async move { + loop { + crate::foundation::time::sleep(Duration::from_millis(100)).await; + throughput.record_rx_bytes(1); + } + }); + + let result = timeout(Duration::from_secs(12), pinger.pingpong()).await; + ingress.abort(); + + assert!( + result.is_ok(), + "unrelated ingress traffic kept a failed round-trip alive" + ); + } + + #[cfg_attr( + not(target_os = "wasi"), + tokio::test(flavor = "multi_thread", worker_threads = 2) + )] + #[cfg_attr(target_os = "wasi", tokio::test)] + async fn echoed_business_traffic_keeps_connection_alive_when_pongs_are_lost() { + let local_liveness = PeerConnLiveness::new(); + let remote_liveness = PeerConnLiveness::new(); + local_liveness.set_enabled(true); + remote_liveness.set_enabled(true); + + let (local_transport, remote_transport) = create_ring_tunnel_pair(); + let local_transport = TunnelWithFilter::new(local_transport, local_liveness.clone()); + let mut local_tunnel = MpscTunnel::new(local_transport, None); + let mut local_stream = local_tunnel.get_stream(); + let local_reader = + tokio::spawn(async move { while local_stream.next().await.is_some() {} }); + + let remote_transport = TunnelWithFilter::new(remote_transport, remote_liveness); + let (mut remote_stream, mut remote_sink) = remote_transport.split(); + let remote = tokio::spawn(async move { + while let Some(Ok(_packet)) = remote_stream.next().await { + let mut reply = ZCPacket::new_with_payload(b"business traffic"); + reply.fill_peer_manager_hdr(2, 1, PacketType::Data as u8); + remote_sink.send(reply).await.unwrap(); + } + }); + + let (ctrl_sender, _) = broadcast::channel(16); + let mut pinger = PeerConnPinger::new( + 1, + 2, + local_tunnel.get_sink(), + ctrl_sender, + Arc::new(WindowLatency::new(15)), + Arc::new(AtomicU32::new(0)), + Arc::new(Throughput::new()), + Arc::new(NoopPeerContext::default()), + "test".to_owned(), + local_liveness, + Duration::from_secs(32), + ); + + let result = timeout(Duration::from_secs(12), pinger.pingpong()).await; + remote.abort(); + local_reader.abort(); + + assert!( + result.is_err(), + "matching business-packet echoes did not keep the connection alive" + ); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/conn/peer_map.rs b/vendor/easytier/easytier-core/src/peers/conn/peer_map.rs new file mode 100644 index 0000000..b3efdf9 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/conn/peer_map.rs @@ -0,0 +1,567 @@ +use std::{ + collections::{BTreeSet, HashMap, HashSet}, + net::{Ipv4Addr, Ipv6Addr}, + sync::Arc, +}; + +use anyhow::Context; +use dashmap::{DashMap, DashSet}; +use parking_lot::Mutex; +use tokio::sync::RwLock; + +use crate::{ + config::PeerId, + packet::ZCPacket, + peers::{ + context::{ArcPeerContext, NetworkIdentity, PeerEvent}, + error::Error, + util::shrink_dashmap, + }, + proto::{ + core_peer::peer::{PeerConnInfo, Route as CoreRoute}, + peer_rpc::{ + DirectConnectedPeerInfo, PeerIdentityType, PeerInfoForGlobalMap, RoutePeerInfo, + }, + }, + tunnel::TunnelError, +}; + +use super::{ + peer::Peer, + peer_conn::{PeerConn, PeerConnId}, +}; +use crate::peers::{ + PacketRecvChan, + route::{ArcRoute, NextHopPolicy}, +}; + +pub struct PeerMap { + choice_cache: Mutex)>>, + optimization: Mutex>, + decisions: Mutex>, + context: ArcPeerContext, + my_peer_id: PeerId, + peer_map: DashMap>, + packet_send: PacketRecvChan, + routes: RwLock>, + alive_client_urls: Arc>>>, +} + +impl PeerMap { + pub(crate) fn new( + packet_send: PacketRecvChan, + context: ArcPeerContext, + my_peer_id: PeerId, + ) -> Self { + PeerMap { + choice_cache: Mutex::new(HashMap::new()), + optimization: Mutex::new(None), + decisions: Mutex::new(HashMap::new()), + context, + my_peer_id, + peer_map: DashMap::new(), + packet_send, + routes: RwLock::new(Vec::new()), + alive_client_urls: Arc::new(Mutex::new(HashMap::new())), + } + } + + async fn add_new_peer(&self, peer: Peer) { + let peer_id = peer.peer_node_id; + peer.set_udp_preference( + self.optimization + .lock() + .as_ref() + .is_some_and(|p| p.prefer_udp), + ); + self.peer_map.insert(peer_id, Arc::new(peer)); + self.context.issue_event(PeerEvent::PeerAdded(peer_id)); + } + + pub async fn add_new_peer_conn(&self, peer_conn: PeerConn) -> Result<(), Error> { + let _ = self.maintain_alive_client_urls(&peer_conn); + let peer_id = peer_conn.get_peer_id(); + let no_entry = self.peer_map.get(&peer_id).is_none(); + if no_entry { + let new_peer = Peer::new(peer_id, self.packet_send.clone(), self.context.clone()); + new_peer.add_peer_conn(peer_conn).await?; + self.add_new_peer(new_peer).await; + } else { + let peer = self.peer_map.get(&peer_id).unwrap().clone(); + peer.add_peer_conn(peer_conn).await?; + } + Ok(()) + } + + fn maintain_alive_client_urls(&self, peer_conn: &PeerConn) -> Option<()> { + let conn_info = peer_conn.get_conn_info(); + if !conn_info.is_client { + return None; + } + + let close_notifier = peer_conn.get_close_notifier(); + let alive_conns_weak = Arc::downgrade(&self.alive_client_urls); + let conn_id = close_notifier.get_conn_id(); + let alive_client_url: url::Url = conn_info.tunnel?.remote_addr?.into(); + self.alive_client_urls + .lock() + .entry(alive_client_url.clone()) + .or_default() + .insert(conn_id); + + tokio::spawn(async move { + if let Some(mut waiter) = close_notifier.get_waiter().await { + let _ = waiter.recv().await; + } + let Some(alive_conns) = alive_conns_weak.upgrade() else { + return; + }; + let mut guard = alive_conns.lock(); + if let Some(conn_ids) = guard.get_mut(&alive_client_url) { + conn_ids.retain(|id| id != &conn_id); + if conn_ids.is_empty() { + guard.remove(&alive_client_url); + } + } + let alive_conn_count = guard.len(); + drop(guard); + tracing::debug!( + ?conn_id, + "peer conn is closed, current alive conns: {}", + alive_conn_count + ); + }); + + Some(()) + } + + pub fn is_client_url_alive(&self, url: &url::Url) -> bool { + self.alive_client_urls.lock().contains_key(url) + } + + pub fn get_peer_by_id(&self, peer_id: PeerId) -> Option> { + self.peer_map.get(&peer_id).map(|v| v.clone()) + } + + pub fn get_directly_connections_by_peer_id(&self, peer_id: PeerId) -> DashSet { + if let Some(peer) = self.get_peer_by_id(peer_id) { + return peer.get_directly_connections(); + } + + DashSet::new() + } + + pub fn has_peer(&self, peer_id: PeerId) -> bool { + peer_id == self.my_peer_id || self.peer_map.contains_key(&peer_id) + } + + pub(crate) fn has_direct_attached_peer(&self, peer_id: PeerId) -> bool { + self.get_peer_by_id(peer_id) + .is_some_and(|peer| peer.has_direct_attached_conn()) + } + + pub(crate) fn is_self(&self, peer_id: PeerId) -> bool { + peer_id == self.my_peer_id + } + + pub async fn send_msg_directly(&self, msg: ZCPacket, dst_peer_id: PeerId) -> Result<(), Error> { + if dst_peer_id == self.my_peer_id { + let packet_send = self.packet_send.clone(); + tokio::spawn(async move { + let ret = packet_send + .send(msg) + .await + .with_context(|| "send msg to self failed"); + if ret.is_err() { + tracing::error!("send msg to self failed: {:?}", ret); + } + }); + return Ok(()); + } + + match self.get_peer_by_id(dst_peer_id) { + Some(peer) => { + peer.send_msg(msg).await?; + } + None => { + tracing::error!("no peer for dst_peer_id: {}", dst_peer_id); + return Err(Error::RouteError(Some(format!( + "peer map sengmsg directly no connected dst_peer_id: {}", + dst_peer_id + )))); + } + } + + Ok(()) + } + + pub fn configure_optimization( + &self, + policy: crate::peers::meshport_optimization::OptimizationPolicy, + ) { + for peer in self.peer_map.iter() { + peer.set_udp_preference(policy.prefer_udp); + } + *self.optimization.lock() = Some(policy); + self.decisions.lock().clear(); + self.choice_cache.lock().clear(); + } + + pub async fn get_gateway_peer_id( + &self, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Option { + if dst_peer_id == self.my_peer_id { + return Some(dst_peer_id); + } + + if self.has_peer(dst_peer_id) && matches!(policy, NextHopPolicy::LeastHop) { + return Some(dst_peer_id); + } + + if self.optimization.lock().is_some() { + if let Some((sampled, gateway)) = self.choice_cache.lock().get(&dst_peer_id).copied() { + if sampled.elapsed() < std::time::Duration::from_secs(2) + && gateway.is_some_and(|id| { + self.get_peer_by_id(id).is_some_and(|p| p.has_live_conns()) + }) + { + return gateway; + } + } + } + // get route info + for route in self.routes.read().await.iter() { + if let Some(gateway_peer_id) = route + .get_next_hop_with_policy(dst_peer_id, policy.clone()) + .await + { + // NOTIC: for foreign network, gateway_peer_id may not connect to me + let optimization = self.optimization.lock().clone(); + if let Some(config) = optimization { + let direct = if let Some(peer) = self.get_peer_by_id(dst_peer_id) { + if peer.has_live_conns() { + peer.list_peer_conns() + .await + .iter() + .filter(|c| c.conn_id == peer.get_default_conn_id().to_string()) + .filter_map(|c| c.stats.as_ref()) + .map(|s| s.latency_us as f64 / 1000.0) + .filter(|ms| *ms > 0.0) + .min_by(f64::total_cmp) + .or(Some(0.0)) + } else { + None + } + } else { + None + }; + let relay_ms = route + .list_routes() + .await + .into_iter() + .find(|r| r.peer_id == dst_peer_id) + .map(|r| r.path_latency_latency_first.unwrap_or(r.path_latency) as f64); + let gateway_live = self + .get_peer_by_id(gateway_peer_id) + .is_some_and(|p| p.has_live_conns()); + let candidate = if gateway_peer_id == dst_peer_id || gateway_live { + Some(gateway_peer_id) + } else { + None + }; + let mut decisions = self.decisions.lock(); + if decisions.len() > 4096 { + decisions.retain(|id, _| self.has_peer(*id)); + } + let choice = decisions.entry(dst_peer_id).or_default().choose( + &config, + dst_peer_id, + candidate, + direct, + relay_ms, + std::time::Instant::now(), + ); + let mut cache = self.choice_cache.lock(); + if cache.len() > 4096 { + cache.retain(|id, _| self.has_peer(*id)); + } + cache.insert(dst_peer_id, (std::time::Instant::now(), choice)); + return choice; + } + return Some(gateway_peer_id); + } + } + + if self.optimization.lock().is_some() + && self + .get_peer_by_id(dst_peer_id) + .is_some_and(|p| p.has_live_conns()) + { + Some(dst_peer_id) + } else { + None + } + } + + pub async fn list_peers_own_foreign_network( + &self, + network_identity: &NetworkIdentity, + ) -> Vec { + let mut ret = Vec::new(); + for route in self.routes.read().await.iter() { + let peers = route.list_peers_own_foreign_network(network_identity).await; + ret.extend(peers); + } + ret + } + + pub async fn send_msg( + &self, + msg: ZCPacket, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result<(), Error> { + let Some(gateway_peer_id) = self.get_gateway_peer_id(dst_peer_id, policy).await else { + return Err(Error::RouteError(Some(format!( + "peer map sengmsg no gateway for dst_peer_id: {}", + dst_peer_id + )))); + }; + + self.send_msg_directly(msg, gateway_peer_id).await?; + Ok(()) + } + + pub async fn get_peer_id_by_ipv4(&self, ipv4: &Ipv4Addr) -> Option { + for route in self.routes.read().await.iter() { + let peer_id = route.get_peer_id_by_ipv4(ipv4).await; + if peer_id.is_some() { + return peer_id; + } + } + None + } + + pub async fn get_peer_id_by_ipv6(&self, ipv6: &Ipv6Addr) -> Option { + for route in self.routes.read().await.iter() { + let peer_id = route.get_peer_id_by_ipv6(ipv6).await; + if peer_id.is_some() { + return peer_id; + } + } + None + } + + pub async fn get_route_peer_info(&self, peer_id: PeerId) -> Option { + for route in self.routes.read().await.iter() { + if let Some(info) = route.get_peer_info(peer_id).await { + return Some(info); + } + } + None + } + + pub async fn get_origin_my_peer_id( + &self, + network_name: &str, + foreign_my_peer_id: PeerId, + ) -> Option { + for route in self.routes.read().await.iter() { + let origin_peer_id = route + .get_origin_my_peer_id(network_name, foreign_my_peer_id) + .await; + if origin_peer_id.is_some() { + return origin_peer_id; + } + } + None + } + + pub fn is_empty(&self) -> bool { + self.peer_map.is_empty() + } + + pub fn list_peers(&self) -> Vec { + let mut ret = Vec::new(); + for item in self.peer_map.iter() { + let peer_id = item.key(); + ret.push(*peer_id); + } + ret + } + + pub async fn list_peers_with_conn(&self) -> Vec { + let mut ret = Vec::new(); + for item in self.peer_map.iter() { + if item.value().has_live_conns() { + ret.push(*item.key()); + } + } + ret + } + + pub async fn list_peer_conns(&self, peer_id: PeerId) -> Option> { + if let Some(p) = self.get_peer_by_id(peer_id) { + Some(p.list_peer_conns().await) + } else { + None + } + } + + pub async fn get_peer_default_conn_id(&self, peer_id: PeerId) -> Option { + self.get_peer_by_id(peer_id) + .map(|p| p.get_default_conn_id()) + } + + pub fn get_peer_identity_type(&self, peer_id: PeerId) -> Option { + self.get_peer_by_id(peer_id) + .and_then(|p| p.get_peer_identity_type()) + } + + pub fn get_peer_public_key(&self, peer_id: PeerId) -> Option> { + self.get_peer_by_id(peer_id) + .and_then(|p| p.get_peer_public_key()) + } + + pub async fn close_peer_conn( + &self, + peer_id: PeerId, + conn_id: &PeerConnId, + ) -> Result<(), Error> { + if let Some(p) = self.get_peer_by_id(peer_id) { + p.close_peer_conn(conn_id).await + } else { + Err(Error::NotFound) + } + } + + pub async fn close_peer(&self, peer_id: PeerId) -> Result<(), TunnelError> { + let remove_ret = self.peer_map.remove(&peer_id); + shrink_dashmap(&self.peer_map, None); + + self.context.issue_event(PeerEvent::PeerRemoved(peer_id)); + tracing::info!( + ?peer_id, + has_old_value = ?remove_ret.is_some(), + peer_ref_counter = ?remove_ret.map(|v| Arc::strong_count(&v.1)), + "peer is closed" + ); + Ok(()) + } + + pub async fn add_route(&self, route: ArcRoute) { + let mut routes = self.routes.write().await; + routes.insert(0, route); + } + + pub(crate) async fn clear_resources(&self) { + for peer_id in self.list_peers() { + let _ = self.close_peer(peer_id).await; + } + let routes = { + let mut routes = self.routes.write().await; + std::mem::take(&mut *routes) + }; + for route in routes { + route.close().await; + } + self.alive_client_urls.lock().clear(); + } + + pub async fn clean_peer_without_conn(&self) { + let mut to_remove = vec![]; + + for peer_id in self.list_peers() { + let conns = self.list_peer_conns(peer_id).await; + if conns.is_none() || conns.as_ref().unwrap().is_empty() { + to_remove.push(peer_id); + } + } + + for peer_id in to_remove { + self.close_peer(peer_id).await.unwrap(); + } + } + + pub async fn list_routes(&self) -> DashMap { + let route_map = DashMap::new(); + for route in self.routes.read().await.iter() { + for item in route.list_routes().await.iter() { + route_map.insert(item.peer_id, item.next_hop_peer_id); + } + } + route_map + } + + pub async fn list_route_infos(&self) -> Vec { + if let Some(route) = self.routes.read().await.iter().next() { + return route.list_routes().await; + } + vec![] + } + + pub async fn need_relay_by_foreign_network(&self, dst_peer_id: PeerId) -> Result { + // if gateway_peer_id is not connected to me, means need relay by foreign network + let gateway_id = self + .get_gateway_peer_id(dst_peer_id, NextHopPolicy::LeastHop) + .await + .ok_or(Error::RouteError(Some(format!( + "peer map need_relay_by_foreign_network no gateway for dst_peer_id: {}", + dst_peer_id + ))))?; + + Ok(!self.has_peer(gateway_id)) + } + + pub fn my_peer_id(&self) -> PeerId { + self.my_peer_id + } +} + +impl Drop for PeerMap { + fn drop(&mut self) { + tracing::debug!( + self.my_peer_id, + network = ?self.context.network_identity(), + "PeerMap is dropped" + ); + } +} + +/// Aggregates the directly-connected peers of several peer maps into the +/// peer-center reporting format, keeping the lowest observed latency per peer. +pub(crate) async fn direct_peer_info(peer_maps: &[Arc]) -> PeerInfoForGlobalMap { + let mut peers = BTreeSet::new(); + for peer_map in peer_maps { + peers.extend(peer_map.list_peers()); + } + + let mut ret = PeerInfoForGlobalMap::default(); + for peer in peers { + let mut conns = None; + for peer_map in peer_maps { + if let Some(found) = peer_map.list_peer_conns(peer).await { + conns = Some(found); + break; + } + } + let Some(min_lat) = conns + .into_iter() + .flatten() + .map(|conn| conn.stats.as_ref().unwrap().latency_us) + .min() + else { + continue; + }; + + ret.direct_peers.insert( + peer, + DirectConnectedPeerInfo { + latency_ms: std::cmp::max(1, (min_lat as u32 / 1000) as i32), + }, + ); + } + ret +} diff --git a/vendor/easytier/easytier-core/src/peers/conn/peer_session.rs b/vendor/easytier/easytier-core/src/peers/conn/peer_session.rs new file mode 100644 index 0000000..cd8c57c --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/conn/peer_session.rs @@ -0,0 +1,574 @@ +use std::sync::{ + Arc, RwLock, + atomic::{AtomicBool, Ordering}, +}; +use std::time::{Duration, Instant}; + +use anyhow::anyhow; +use crossbeam_utils::atomic::AtomicCell; +use dashmap::DashMap; + +use crate::peers::util::shrink_dashmap; +use crate::tunnel::secure_datagram::{SecureDatagramDirection, SecureDatagramSession}; +use crate::{config::PeerId, packet::ZCPacket}; + +const SESSION_IDLE_TIMEOUT: Duration = Duration::from_secs(60); + +pub struct UpsertResponderSessionReturn { + pub session: Arc, + pub action: PeerSessionAction, + pub session_generation: u32, + pub root_key: Option<[u8; 32]>, + pub initial_epoch: u32, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum PeerSessionAction { + Join, + Sync, + Create, +} + +#[derive(PartialEq, Clone, Eq, Hash, Debug)] +pub struct SessionKey { + network_name: String, + peer_id: PeerId, +} + +impl SessionKey { + pub fn new(network_name: String, peer_id: PeerId) -> Self { + Self { + network_name, + peer_id, + } + } +} + +#[derive(Clone)] +pub struct PeerSessionStore { + sessions: Arc>, +} + +struct PeerSessionEntry { + session: Arc, + last_used_at: AtomicCell, +} + +impl PeerSessionEntry { + fn new(session: Arc) -> Self { + Self { + session, + last_used_at: AtomicCell::new(Instant::now()), + } + } + + fn touch(&self) { + self.last_used_at.store(Instant::now()); + } +} + +impl Default for PeerSessionStore { + fn default() -> Self { + Self { + sessions: Arc::new(DashMap::new()), + } + } +} + +impl PeerSessionStore { + pub fn new() -> Self { + Self::default() + } + + pub fn get(&self, key: &SessionKey) -> Option> { + let session = { + let entry = self.sessions.get(key)?; + entry.touch(); + entry.session.clone() + }; + if session.is_valid() { + Some(session) + } else { + self.sessions.remove(key); + None + } + } + + pub fn remove(&self, key: &SessionKey) { + self.sessions.remove(key); + } + + pub fn evict_unused_sessions(&self) { + self.evict_unused_sessions_idle(SESSION_IDLE_TIMEOUT); + } + + pub fn evict_unused_sessions_idle(&self, idle: Duration) { + let now = Instant::now(); + self.sessions.retain(|_key, entry| { + entry.session.is_valid() + && (Arc::strong_count(&entry.session) > 1 + || now.saturating_duration_since(entry.last_used_at.load()) < idle) + }); + shrink_dashmap(&self.sessions, None); + } + + #[tracing::instrument(skip(self))] + pub fn upsert_responder_session( + &self, + key: &SessionKey, + a_session_generation: Option, + send_algorithm: String, + recv_algorithm: String, + peer_static_pubkey: Option<[u8; 32]>, + ) -> Result { + tracing::event!(tracing::Level::INFO, ?key, "upsert_responder_session"); + let existing = self + .sessions + .get(key) + .map(|v| { + v.touch(); + v.session.clone() + }) + .filter(|s| s.is_valid()); + match existing { + None => { + let root_key = PeerSession::new_root_key(); + let session_generation = 1u32; + let initial_epoch = 0u32; + let session = Arc::new(PeerSession::new( + key.peer_id, + root_key, + session_generation, + initial_epoch, + send_algorithm, + recv_algorithm, + peer_static_pubkey, + )); + self.sessions + .insert(key.clone(), PeerSessionEntry::new(session.clone())); + Ok(UpsertResponderSessionReturn { + session, + action: PeerSessionAction::Create, + session_generation, + root_key: Some(root_key), + initial_epoch, + }) + } + Some(session) => { + session.check_encrypt_algo_same(&send_algorithm, &recv_algorithm)?; + session.check_or_set_peer_static_pubkey(peer_static_pubkey)?; + let local_gen = session.session_generation(); + if a_session_generation.is_some_and(|g| g == local_gen) { + Ok(UpsertResponderSessionReturn { + session, + action: PeerSessionAction::Join, + session_generation: local_gen, + root_key: None, + initial_epoch: 0, + }) + } else { + let initial_epoch = session.next_sync_epoch(); + let root_key = session.root_key(); + Ok(UpsertResponderSessionReturn { + session, + action: PeerSessionAction::Sync, + session_generation: local_gen, + root_key: Some(root_key), + initial_epoch, + }) + } + } + } + } + + #[allow(clippy::too_many_arguments)] + #[tracing::instrument(skip(self))] + pub fn apply_initiator_action( + &self, + key: &SessionKey, + action: PeerSessionAction, + b_session_generation: u32, + root_key_32: Option<[u8; 32]>, + initial_epoch: u32, + send_algorithm: String, + recv_algorithm: String, + peer_static_pubkey: Option<[u8; 32]>, + ) -> Result, anyhow::Error> { + tracing::event!(tracing::Level::INFO, "apply_initiator_action {:?}", key); + match action { + PeerSessionAction::Join => { + let Some(session) = self.get(key) else { + return Err(anyhow!("no local session for JOIN")); + }; + session.check_encrypt_algo_same(&send_algorithm, &recv_algorithm)?; + session.check_or_set_peer_static_pubkey(peer_static_pubkey)?; + if session.session_generation() != b_session_generation { + return Err(anyhow!("JOIN generation mismatch")); + } + Ok(session) + } + PeerSessionAction::Sync | PeerSessionAction::Create => { + let root_key = root_key_32.ok_or_else(|| anyhow!("missing root_key"))?; + if let Some(existing) = self.sessions.get(key) + && !existing.session.is_valid() + { + drop(existing); + self.sessions.remove(key); + } + let session = { + let entry = self.sessions.entry(key.clone()).or_insert_with(|| { + PeerSessionEntry::new(Arc::new(PeerSession::new( + key.peer_id, + root_key, + b_session_generation, + initial_epoch, + send_algorithm.clone(), + recv_algorithm.clone(), + peer_static_pubkey, + ))) + }); + entry.touch(); + entry.session.clone() + }; + session.check_encrypt_algo_same(&send_algorithm, &recv_algorithm)?; + session.check_or_set_peer_static_pubkey(peer_static_pubkey)?; + session.sync_root_key( + root_key, + b_session_generation, + initial_epoch, + matches!(action, PeerSessionAction::Sync), + ); + Ok(session) + } + } + } +} + +pub struct PeerSession { + peer_id: PeerId, + peer_static_pubkey: RwLock>, + datagram: SecureDatagramSession, + invalidated: AtomicBool, +} + +impl std::fmt::Debug for PeerSession { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PeerSession") + .field("peer_id", &self.peer_id) + .field("peer_static_pubkey", &self.peer_static_pubkey) + .field("datagram", &self.datagram) + .finish() + } +} + +impl PeerSession { + pub fn new( + peer_id: PeerId, + root_key: [u8; 32], + session_generation: u32, + initial_epoch: u32, + send_cipher_algorithm: String, + recv_cipher_algorithm: String, + peer_static_pubkey: Option<[u8; 32]>, + ) -> Self { + Self { + peer_id, + peer_static_pubkey: RwLock::new(peer_static_pubkey), + datagram: SecureDatagramSession::new( + root_key, + session_generation, + initial_epoch, + send_cipher_algorithm, + recv_cipher_algorithm, + ), + invalidated: AtomicBool::new(false), + } + } + + pub fn peer_id(&self) -> PeerId { + self.peer_id + } + + pub fn invalidate(&self) { + self.invalidated.store(true, Ordering::Relaxed); + self.datagram.invalidate(); + } + + pub fn is_valid(&self) -> bool { + !self.invalidated.load(Ordering::Relaxed) && self.datagram.is_valid() + } + + pub fn session_generation(&self) -> u32 { + self.datagram.session_generation() + } + + pub fn root_key(&self) -> [u8; 32] { + self.datagram.root_key() + } + + pub fn new_root_key() -> [u8; 32] { + SecureDatagramSession::new_root_key() + } + + pub fn next_sync_epoch(&self) -> u32 { + self.datagram.next_sync_epoch() + } + + pub fn check_encrypt_algo_same( + &self, + send_algorithm: &str, + recv_algorithm: &str, + ) -> Result<(), anyhow::Error> { + self.datagram + .check_encrypt_algo_same(send_algorithm, recv_algorithm) + } + + pub fn check_or_set_peer_static_pubkey( + &self, + peer_static_pubkey: Option<[u8; 32]>, + ) -> Result<(), anyhow::Error> { + let Some(peer_static_pubkey) = peer_static_pubkey else { + return Ok(()); + }; + let mut guard = self.peer_static_pubkey.write().unwrap(); + if let Some(existing) = *guard { + if existing != peer_static_pubkey { + return Err(anyhow!("peer static pubkey mismatch")); + } + return Ok(()); + } + *guard = Some(peer_static_pubkey); + Ok(()) + } + + pub fn sync_root_key( + &self, + root_key: [u8; 32], + session_generation: u32, + initial_epoch: u32, + preserve_rx_grace: bool, + ) { + self.datagram.sync_root_key( + root_key, + session_generation, + initial_epoch, + preserve_rx_grace, + ); + } + + pub fn dir_for_sender( + sender_peer_id: PeerId, + receiver_peer_id: PeerId, + ) -> SecureDatagramDirection { + if sender_peer_id < receiver_peer_id { + SecureDatagramDirection::AToB + } else { + SecureDatagramDirection::BToA + } + } + + pub fn encrypt_payload( + &self, + sender_peer_id: PeerId, + receiver_peer_id: PeerId, + pkt: &mut ZCPacket, + ) -> Result<(), anyhow::Error> { + if !self.is_valid() { + return Err(anyhow!("session invalidated")); + } + self.datagram + .encrypt_payload(Self::dir_for_sender(sender_peer_id, receiver_peer_id), pkt) + } + + pub fn decrypt_payload( + &self, + sender_peer_id: PeerId, + receiver_peer_id: PeerId, + ciphertext_with_tail: &mut ZCPacket, + ) -> Result<(), anyhow::Error> { + if !self.is_valid() { + return Err(anyhow!("session invalidated")); + } + self.datagram.decrypt_payload( + Self::dir_for_sender(sender_peer_id, receiver_peer_id), + ciphertext_with_tail, + ) + } +} + +#[cfg(any(test, feature = "test-utils"))] +mod test_utils { + use super::*; + + impl PeerSessionStore { + #[doc(hidden)] + pub(crate) fn contains_valid(&self, key: &SessionKey) -> bool { + self.sessions + .get(key) + .is_some_and(|entry| entry.session.is_valid()) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + impl PeerSessionStore { + fn insert_session(&self, key: SessionKey, session: Arc) { + self.sessions.insert(key, PeerSessionEntry::new(session)); + } + } + + #[test] + #[cfg(all( + any( + feature = "aes-gcm", + feature = "openssl-crypto", + feature = "ring-crypto" + ), + any( + feature = "chacha20", + feature = "openssl-crypto", + feature = "ring-crypto" + ) + ))] + fn peer_session_supports_asymmetric_algorithms() { + let a: PeerId = 10; + let b: PeerId = 20; + let root_key = PeerSession::new_root_key(); + let generation = 1u32; + let initial_epoch = 0u32; + + let sa = PeerSession::new( + b, + root_key, + generation, + initial_epoch, + "aes-256-gcm".to_string(), + "chacha20-poly1305".to_string(), + None, + ); + let sb = PeerSession::new( + a, + root_key, + generation, + initial_epoch, + "chacha20-poly1305".to_string(), + "aes-256-gcm".to_string(), + None, + ); + + let plaintext1 = b"hello from a"; + let mut pkt1 = ZCPacket::new_with_payload(plaintext1); + pkt1.fill_peer_manager_hdr(a as u32, b as u32, 0); + sa.encrypt_payload(a, b, &mut pkt1).unwrap(); + sb.decrypt_payload(a, b, &mut pkt1).unwrap(); + assert_eq!(pkt1.payload(), plaintext1); + + let plaintext2 = b"hello from b"; + let mut pkt2 = ZCPacket::new_with_payload(plaintext2); + pkt2.fill_peer_manager_hdr(b as u32, a as u32, 0); + sb.encrypt_payload(b, a, &mut pkt2).unwrap(); + sa.decrypt_payload(b, a, &mut pkt2).unwrap(); + assert_eq!(pkt2.payload(), plaintext2); + } + + #[test] + fn peer_session_store_keeps_recent_session_without_external_refs() { + let store = PeerSessionStore::new(); + let key = SessionKey::new("net".to_string(), 20); + let session = Arc::new(PeerSession::new( + 20, + PeerSession::new_root_key(), + 1, + 0, + "aes-gcm".to_string(), + "aes-gcm".to_string(), + None, + )); + store.insert_session(key.clone(), session); + + assert!(store.get(&key).is_some()); + store.evict_unused_sessions(); + + assert!( + store.get(&key).is_some(), + "recent relay sessions should survive the periodic GC" + ); + } + + #[test] + fn peer_session_store_evicts_idle_session_without_external_refs() { + let store = PeerSessionStore::new(); + let key = SessionKey::new("net".to_string(), 20); + let session = Arc::new(PeerSession::new( + 20, + PeerSession::new_root_key(), + 1, + 0, + "aes-gcm".to_string(), + "aes-gcm".to_string(), + None, + )); + store.insert_session(key.clone(), session); + + store.evict_unused_sessions_idle(Duration::from_millis(0)); + + assert!( + store.get(&key).is_none(), + "idle sessions without external users should still be collected" + ); + } + + #[test] + fn peer_session_store_evicts_invalid_recent_session() { + let store = PeerSessionStore::new(); + let key = SessionKey::new("net".to_string(), 20); + let session = Arc::new(PeerSession::new( + 20, + PeerSession::new_root_key(), + 1, + 0, + "aes-gcm".to_string(), + "aes-gcm".to_string(), + None, + )); + store.insert_session(key.clone(), session); + + let session = store.get(&key).unwrap(); + session.invalidate(); + drop(session); + store.evict_unused_sessions(); + + assert!( + !store.sessions.contains_key(&key), + "invalid sessions should not be kept by recent activity" + ); + } + + #[cfg(feature = "test-utils")] + #[test] + fn contains_valid_does_not_refresh_session_activity() { + let store = PeerSessionStore::new(); + let key = SessionKey::new("net".to_string(), 20); + let session = Arc::new(PeerSession::new( + 20, + PeerSession::new_root_key(), + 1, + 0, + "aes-gcm".to_string(), + "aes-gcm".to_string(), + None, + )); + store.insert_session(key.clone(), session); + let last_used_at = store.sessions.get(&key).unwrap().last_used_at.load(); + + assert!(store.contains_valid(&key)); + + assert_eq!( + store.sessions.get(&key).unwrap().last_used_at.load(), + last_used_at + ); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/context.rs b/vendor/easytier/easytier-core/src/peers/context.rs new file mode 100644 index 0000000..a259730 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/context.rs @@ -0,0 +1,1775 @@ +use std::{ + collections::HashMap, + net::IpAddr, + sync::{ + Arc, Mutex, + atomic::{AtomicBool, Ordering}, + }, + time::{SystemTime, UNIX_EPOCH}, +}; + +use arc_swap::ArcSwap; +use cidr::{Ipv4Cidr, Ipv4Inet, Ipv6Cidr, Ipv6Inet}; +use dashmap::DashMap; +use easytier_proto::{ + acl::Acl, + common::{FlagsInConfig, PeerFeatureFlag, SecureModeConfig, StunInfo, TunnelInfo}, + peer_rpc::{PeerGroupInfo, TrustedCredentialPubkeyProof}, +}; +use hmac::{Hmac, Mac}; +use sha2::Sha256; + +pub use crate::config::{NetworkIdentity, NetworkSecretDigest}; +use crate::{ + config::peers::{HostRoutingPolicy, PeerGroupIdentity, PeerRuntimeConfig, PeerRuntimeSnapshot}, + config::runtime::CoreRuntimeConfigStore, + config::{ + CoreConfig, IpPrefix, NodeConfig, PeerId, PeerPolicyConfig, ProxyNetworkConfig, + RouteConfig, TrafficConfig, + }, + events::{CoreEvent, CoreEventSink}, + foundation::stats::{LabelSet, LabelType, MetricName, StatsManager}, + foundation::token_bucket::{ArcByteLimiter, BucketConfig, TokenBucketManager}, + peers::{ + credential_manager::{CredentialManager, CredentialStorage}, + util::shrink_dashmap, + whitelist::check_network_in_relay_whitelist, + }, +}; + +pub(crate) const SECRET_PROOF_PREFIX: &[u8] = b"easytier secret proof"; +const PEER_EVENT_CAPACITY: usize = 100; + +#[derive(Debug, Clone)] +#[allow(clippy::enum_variant_names)] +pub(crate) enum PeerEvent { + PeerAdded(PeerId), + PeerRemoved(PeerId), + PeerConnAdded(easytier_proto::core_peer::peer::PeerConnInfo), + PeerConnRemoved(easytier_proto::core_peer::peer::PeerConnInfo), +} + +#[derive(Debug, Clone, PartialEq, Eq)] +#[allow(clippy::enum_variant_names)] +pub(crate) enum PeerContextEvent { + PeerAdded(PeerId), + PeerRemoved(PeerId), + PeerConnAdded, + PeerConnRemoved, +} + +pub(crate) type PeerContextEventSubscriber = tokio::sync::broadcast::Receiver; + +/// Normalized product and host inputs used to derive one peer runtime version. +/// +/// The host owns platform-specific normalization of node, route, identity, and +/// capability values. Peer policy remains derived in core from the submitted +/// flags and ACL. +#[derive(Debug, Clone)] +pub struct PeerRuntimeSnapshotInput { + pub node: NodeConfig, + pub routes: RouteConfig, + pub network_identity: NetworkIdentity, + pub stun_info: StunInfo, + pub flags: FlagsInConfig, + pub secure_mode: Option, + pub host_routing: HostRoutingPolicy, + pub acl: Option, + pub easytier_version: String, + pub pinned_peers: Vec<(url::Url, Option)>, + pub ospf_update_my_foreign_network_interval_sec: u64, + pub max_direct_conns_per_peer_in_foreign_network: usize, + pub hmac_secret_digest: bool, +} + +#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)] +struct PeerTrafficLimits { + instance_recv_bps: Option, + foreign_relay_bps: Option, +} + +impl PeerTrafficLimits { + fn from_portable(runtime: &PeerRuntimeConfig, flags: &FlagsInConfig) -> Self { + let traffic = &runtime.core.traffic; + Self { + instance_recv_bps: Self::normalize( + traffic.instance_recv_bps_limit, + flags.instance_recv_bps_limit, + ), + foreign_relay_bps: Self::normalize( + traffic.foreign_relay_bps_limit, + flags.foreign_relay_bps_limit, + ), + } + } + + fn normalize(explicit: Option, legacy: u64) -> Option { + match explicit { + Some(u64::MAX) => None, + Some(limit) => Some(limit), + None if !matches!(legacy, 0 | u64::MAX) => Some(legacy), + None => None, + } + } +} + +impl PeerRuntimeSnapshot { + pub fn from_host_input(input: PeerRuntimeSnapshotInput) -> Self { + let PeerRuntimeSnapshotInput { + node, + routes, + network_identity, + stun_info, + flags, + secure_mode, + host_routing, + acl, + easytier_version, + pinned_peers, + ospf_update_my_foreign_network_interval_sec, + max_direct_conns_per_peer_in_foreign_network, + hmac_secret_digest, + } = input; + let feature_flags = PeerFeatureFlag { + kcp_input: !flags.disable_kcp_input, + no_relay_kcp: flags.disable_relay_kcp, + support_conn_list_sync: true, + quic_input: !flags.disable_quic_input, + no_relay_quic: flags.disable_relay_quic, + need_p2p: flags.need_p2p, + disable_p2p: flags.disable_p2p, + avoid_relay_data: flags.disable_relay_data, + ..Default::default() + }; + let peer_policy = PeerPolicyConfig { + p2p_enabled: !flags.disable_p2p, + relay_peer_rpc: flags.relay_all_peer_rpc, + relay_data: !flags.disable_relay_data, + latency_first: flags.latency_first, + encryption_required: flags.enable_encryption, + }; + let traffic = TrafficConfig { + mtu: u16::try_from(flags.mtu) + .ok() + .filter(|configured| *configured != 0), + instance_recv_bps_limit: (flags.instance_recv_bps_limit != u64::MAX) + .then_some(flags.instance_recv_bps_limit), + foreign_relay_bps_limit: (flags.foreign_relay_bps_limit != u64::MAX) + .then_some(flags.foreign_relay_bps_limit), + }; + let avoid_relay_data_preference = check_network_in_relay_whitelist( + &flags.relay_network_whitelist, + &network_identity.network_name, + ) + .is_err(); + let (acl_group_declarations, peer_group_memberships) = peer_acl_groups(acl.as_ref()); + + Self { + runtime: PeerRuntimeConfig { + core: CoreConfig { + node, + routes, + peer_policy, + traffic, + }, + network_identity, + stun_info, + feature_flags, + secure_mode, + host_routing, + }, + easytier_version, + avoid_relay_data_preference, + flags, + pinned_peers, + peer_group_memberships, + acl_group_declarations, + ospf_update_my_foreign_network_interval_sec, + max_direct_conns_per_peer_in_foreign_network, + hmac_secret_digest, + } + } + + fn traffic_limits(&self) -> PeerTrafficLimits { + PeerTrafficLimits::from_portable(&self.runtime, &self.flags) + } +} + +fn peer_acl_groups(acl: Option<&Acl>) -> (Vec, Vec) { + let group = acl + .and_then(|acl| acl.acl_v1.as_ref()) + .and_then(|acl| acl.group.as_ref()); + let declarations = group.map_or_else(Vec::new, |group| { + group + .declares + .iter() + .map(|identity| PeerGroupIdentity { + group_name: identity.group_name.clone(), + group_secret: identity.group_secret.clone(), + }) + .collect() + }); + let memberships = group.map_or_else(Vec::new, |group| { + group + .declares + .iter() + .filter(|identity| group.members.contains(&identity.group_name)) + .map(|identity| PeerGroupIdentity { + group_name: identity.group_name.clone(), + group_secret: identity.group_secret.clone(), + }) + .collect() + }); + (declarations, memberships) +} + +/// Supplies the instance's current STUN observation. +pub(crate) trait PeerStunInfoSource: Send + Sync { + fn stun_info(&self) -> StunInfo { + StunInfo::default() + } +} + +impl PeerStunInfoSource for () {} + +/// Supplies public-IPv6 state observed or leased by the host. +pub(crate) trait PeerPublicIpv6State: Send + Sync { + fn public_ipv6_lease_contains(&self, _ip: &std::net::Ipv6Addr) -> bool { + false + } + + fn public_ipv6_provider_enabled(&self) -> bool { + false + } + + fn advertised_ipv6_public_addr_prefix(&self) -> Option { + None + } +} + +impl PeerPublicIpv6State for () {} + +/// Host adapters used to assemble the core-owned peer context. Each field stays +/// narrow so peer modules cannot reach unrelated host state after construction. +pub(crate) struct CorePeerContextAdapters { + pub stun_info_source: Option>, + pub events: Arc, + pub credential_storage: Option>, +} + +/// Peer context backed by one core-owned submitted snapshot and its instance +/// runtime resources. +pub(crate) struct CorePeerContext { + config: CoreRuntimeConfigStore, + avoid_relay_data_preference: AtomicBool, + stun_info_source: Option>, + public_ipv6_state: Arc, + limiter_state: Mutex, + stats_manager: Arc, + credentials: Arc, + trusted_keys: Arc, + peer_events: tokio::sync::broadcast::Sender, + events: Arc, +} + +impl CorePeerContext { + pub(crate) fn new( + config: CoreRuntimeConfigStore, + public_ipv6_state: Arc, + adapters: CorePeerContextAdapters, + ) -> Self { + Self::new_with_stats_manager( + config, + public_ipv6_state, + adapters, + Arc::new(StatsManager::new()), + ) + } + + /// Builds a foreign-network context that contributes to the same + /// instance-level metrics registry while retaining independent identity, + /// credential, trusted-key, event, and limiter state. + pub fn new_foreign( + config: CoreRuntimeConfigStore, + adapters: CorePeerContextAdapters, + parent: &CorePeerContext, + ) -> Self { + Self::new_with_stats_manager(config, Arc::new(()), adapters, parent.stats_manager()) + } + + fn new_with_stats_manager( + config: CoreRuntimeConfigStore, + public_ipv6_state: Arc, + adapters: CorePeerContextAdapters, + stats_manager: Arc, + ) -> Self { + let avoid_relay_data_preference = + AtomicBool::new(config.snapshot().peer.avoid_relay_data_preference); + let credentials = Arc::new( + adapters + .credential_storage + .map_or_else(CredentialManager::new, CredentialManager::from_storage), + ); + Self { + config, + avoid_relay_data_preference, + stun_info_source: adapters.stun_info_source, + public_ipv6_state, + limiter_state: Mutex::new(CoreLimiterState::default()), + stats_manager, + credentials, + trusted_keys: Arc::new(TrustedKeyMapManager::new()), + peer_events: tokio::sync::broadcast::channel(PEER_EVENT_CAPACITY).0, + events: adapters.events, + } + } + + fn snapshot(&self) -> Arc { + self.config.snapshot().peer.clone() + } + + pub(crate) fn runtime_config_store(&self) -> CoreRuntimeConfigStore { + self.config.clone() + } + + pub fn stats_manager(&self) -> Arc { + self.stats_manager.clone() + } + + pub fn credential_manager(&self) -> Arc { + self.credentials.clone() + } + + fn record_control_metric( + &self, + network_name: &str, + bytes: u64, + bytes_metric: MetricName, + packets_metric: MetricName, + ) { + let labels = + LabelSet::new().with_label_type(LabelType::NetworkName(network_name.to_owned())); + self.stats_manager + .get_counter(bytes_metric, labels.clone()) + .add(bytes); + self.stats_manager.get_counter(packets_metric, labels).inc(); + } + + fn get_or_create_limiter(&self, key: &str, bps: u64) -> Option { + let mut state = self.limiter_state.lock().unwrap(); + if state.stopped { + return None; + } + let manager = state.manager.get_or_insert_with(TokenBucketManager::new); + Some(manager.get_or_create(key, BucketConfig::with_default_capacity(bps))) + } + + pub(crate) async fn stop(&self) { + let manager = { + let mut state = self.limiter_state.lock().unwrap(); + state.stopped = true; + state.manager.take() + }; + if let Some(manager) = manager { + manager.stop().await; + } + } +} + +#[derive(Default)] +struct CoreLimiterState { + manager: Option, + stopped: bool, +} + +fn config_ipv4(value: &IpPrefix) -> Option { + let IpAddr::V4(address) = value.address else { + return None; + }; + Ipv4Inet::new(address, value.prefix_len).ok() +} + +fn config_ipv4_cidr(value: &IpPrefix) -> Option { + let IpAddr::V4(address) = value.address else { + return None; + }; + Ipv4Cidr::new(address, value.prefix_len).ok() +} + +fn config_ipv6(value: &IpPrefix) -> Option { + let IpAddr::V6(address) = value.address else { + return None; + }; + Ipv6Inet::new(address, value.prefix_len).ok() +} + +/// Source of a trusted public key propagated by the OSPF route layer. +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum TrustedKeySource { + OspfNode, + OspfCredential, +} + +#[derive(Debug, Clone)] +pub(crate) struct TrustedKeyMetadata { + pub source: TrustedKeySource, + pub expiry_unix: Option, +} + +impl TrustedKeyMetadata { + pub fn is_expired(&self) -> bool { + if let Some(expiry) = self.expiry_unix { + let now = SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap() + .as_secs() as i64; + return now >= expiry; + } + false + } +} + +pub(crate) type TrustedKeyMap = HashMap, TrustedKeyMetadata>; + +pub(crate) struct TrustedKeyMapManager { + network_trusted_keys: DashMap>, +} + +impl TrustedKeyMapManager { + pub fn new() -> Self { + Self { + network_trusted_keys: DashMap::new(), + } + } + + pub fn update_trusted_keys(&self, network_name: &str, trusted_keys: TrustedKeyMap) { + match self.network_trusted_keys.entry(network_name.to_string()) { + dashmap::Entry::Vacant(entry) => { + entry.insert(ArcSwap::new(Arc::new(trusted_keys))); + } + dashmap::Entry::Occupied(entry) => { + entry.get().store(Arc::new(trusted_keys)); + } + } + } + + pub fn remove_trusted_keys(&self, network_name: &str) { + self.network_trusted_keys.remove(network_name); + shrink_dashmap(&self.network_trusted_keys, None); + } + + pub fn verify_trusted_key(&self, pubkey: &[u8], network_name: &str) -> bool { + self.verify_trusted_key_with_source(pubkey, network_name, None) + } + + pub fn verify_trusted_key_with_source( + &self, + pubkey: &[u8], + network_name: &str, + source: Option, + ) -> bool { + let Some(trusted_keys) = self + .network_trusted_keys + .get(network_name) + .map(|v| v.load_full()) + else { + return false; + }; + + let Some(metadata) = trusted_keys.get(&pubkey.to_vec()) else { + return false; + }; + + if let Some(source) = source { + metadata.source == source && !metadata.is_expired() + } else { + !metadata.is_expired() + } + } + + pub fn list_trusted_keys(&self, network_name: &str) -> Vec<(Vec, TrustedKeyMetadata)> { + let Some(trusted_keys) = self + .network_trusted_keys + .get(network_name) + .map(|v| v.load_full()) + else { + return Vec::new(); + }; + + let mut items = trusted_keys + .iter() + .filter(|(_, metadata)| !metadata.is_expired()) + .map(|(pubkey, metadata)| (pubkey.clone(), metadata.clone())) + .collect::>(); + items.sort_by(|left, right| left.0.cmp(&right.0)); + items + } +} + +impl Default for TrustedKeyMapManager { + fn default() -> Self { + Self::new() + } +} + +/// Runtime dependency interface for the peers module. +/// +/// `PeerContext` is intentionally scoped to `easytier-core::peers`; other core +/// modules should depend on their own narrow DTOs or traits instead of treating +/// this as a core-wide global context. +#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)] +pub(crate) struct PeerPacketPolicy { + pub(crate) disable_relay_data: bool, + pub(crate) p2p_only: bool, + pub(crate) latency_first: bool, + pub(crate) disable_p2p: bool, + pub(crate) lazy_p2p: bool, +} + +impl PeerPacketPolicy { + fn from_flags(flags: &FlagsInConfig) -> Self { + Self { + disable_relay_data: flags.disable_relay_data, + p2p_only: flags.p2p_only, + latency_first: flags.latency_first && !flags.p2p_only, + disable_p2p: flags.disable_p2p, + lazy_p2p: flags.lazy_p2p, + } + } +} + +pub(crate) trait PeerContext: Send + Sync { + fn host_routing_policy(&self) -> HostRoutingPolicy { + HostRoutingPolicy::default() + } + + fn network_identity(&self) -> NetworkIdentity; + + fn network_name(&self) -> String { + self.network_identity().network_name + } + + fn flags(&self) -> FlagsInConfig { + FlagsInConfig::default() + } + + fn packet_policy(&self) -> PeerPacketPolicy { + PeerPacketPolicy::from_flags(&self.flags()) + } + + fn disable_relay_data(&self) -> bool { + self.packet_policy().disable_relay_data + } + + fn secure_mode(&self) -> Option { + None + } + + fn stun_info(&self) -> StunInfo { + StunInfo::default() + } + + fn instance_id(&self) -> uuid::Uuid { + uuid::Uuid::nil() + } + + fn ipv4(&self) -> Option { + None + } + + fn ipv6(&self) -> Option { + None + } + + fn is_ip_local_ipv6(&self, ip: &std::net::Ipv6Addr) -> bool { + self.ipv6() + .map(|addr| addr.address() == *ip) + .unwrap_or(false) + } + + fn is_ip_local_virtual_ip(&self, ip: &IpAddr) -> bool { + match ip { + IpAddr::V4(v4) => self + .ipv4() + .map(|addr| addr.address() == *v4) + .unwrap_or(false), + IpAddr::V6(v6) => self.is_ip_local_ipv6(v6), + } + } + + fn proxy_cidrs(&self) -> Vec { + Vec::new() + } + + fn proxy_networks(&self) -> Vec { + Vec::new() + } + + fn hostname(&self) -> String { + String::new() + } + + fn feature_flags(&self) -> PeerFeatureFlag { + PeerFeatureFlag::default() + } + + fn set_avoid_relay_data_preference(&self, _avoid_relay_data: bool) -> bool { + false + } + + fn subscribe_runtime_changes(&self) -> Option> { + None + } + + fn easytier_version(&self) -> String { + env!("CARGO_PKG_VERSION").to_string() + } + + fn ospf_update_my_foreign_network_interval_sec(&self) -> u64 { + 10 + } + + fn max_direct_conns_per_peer_in_foreign_network(&self) -> usize { + 3 + } + + fn hmac_secret_digest(&self) -> bool { + false + } + + fn advertised_ipv6_public_addr_prefix(&self) -> Option { + None + } + + fn is_ip_in_same_network(&self, _ip: &IpAddr) -> bool { + false + } + + fn peer_groups(&self, _peer_id: PeerId) -> Vec { + Vec::new() + } + + fn acl_group_declarations(&self) -> Vec { + Vec::new() + } + + fn pinned_remote_static_pubkey(&self, _tunnel_info: Option<&TunnelInfo>) -> Option { + None + } + + fn secret_proof(&self, _challenge: &[u8]) -> Option> { + None + } + + fn secret_digest(&self, network_identity: &NetworkIdentity) -> Vec { + network_identity + .secret_digest() + .unwrap_or_default() + .to_vec() + } + + fn is_pubkey_trusted(&self, _pubkey: &[u8], _network_name: &str) -> bool { + false + } + + fn is_pubkey_trusted_with_source( + &self, + _pubkey: &[u8], + _network_name: &str, + _source: TrustedKeySource, + ) -> bool { + false + } + + fn list_trusted_keys(&self, _network_name: &str) -> Vec<(Vec, TrustedKeyMetadata)> { + Vec::new() + } + + fn trusted_credential_pubkeys( + &self, + _network_secret: &str, + ) -> Vec { + Vec::new() + } + + fn remove_expired_credentials(&self) -> bool { + false + } + + fn issue_credential_changed(&self) {} + + fn update_trusted_keys(&self, _keys: TrustedKeyMap, _network_name: &str) {} + + fn remove_trusted_keys(&self, _network_name: &str) {} + + fn record_control_tx(&self, _network_name: &str, _bytes: u64) {} + + fn record_control_rx(&self, _network_name: &str, _bytes: u64) {} + + fn recv_limiter( + &self, + _network_name: &str, + _is_foreign_network: bool, + ) -> Option { + None + } + + fn foreign_forward_limiter(&self, _network_name: &str) -> Option { + None + } + + fn issue_event(&self, _event: PeerEvent) {} + + fn subscribe_peer_events(&self) -> Option { + None + } +} + +pub(crate) type ArcPeerContext = Arc; + +pub(crate) fn secret_proof_from_secret(secret: &str, challenge: &[u8]) -> Option> { + let mut mac = Hmac::::new_from_slice(secret.as_bytes()).ok()?; + mac.update(SECRET_PROOF_PREFIX); + mac.update(challenge); + Some(mac) +} + +impl PeerContext for CorePeerContext { + fn max_direct_conns_per_peer_in_foreign_network(&self) -> usize { + self.snapshot().max_direct_conns_per_peer_in_foreign_network + } + + fn network_identity(&self) -> NetworkIdentity { + self.snapshot().runtime.network_identity.clone() + } + + fn flags(&self) -> FlagsInConfig { + self.snapshot().flags.clone() + } + + fn packet_policy(&self) -> PeerPacketPolicy { + self.config + .with_snapshot(|snapshot| PeerPacketPolicy::from_flags(&snapshot.peer.flags)) + } + + fn host_routing_policy(&self) -> HostRoutingPolicy { + self.snapshot().runtime.host_routing + } + + fn secure_mode(&self) -> Option { + self.snapshot().runtime.secure_mode.clone() + } + + fn stun_info(&self) -> StunInfo { + self.stun_info_source + .as_ref() + .map(|source| source.stun_info()) + .unwrap_or_else(|| self.snapshot().runtime.stun_info.clone()) + } + + fn instance_id(&self) -> uuid::Uuid { + self.snapshot() + .runtime + .core + .node + .instance_id + .map(uuid::Uuid::from_bytes) + .unwrap_or_else(uuid::Uuid::nil) + } + + fn ipv4(&self) -> Option { + self.config.with_snapshot(|snapshot| { + snapshot + .peer + .runtime + .core + .routes + .ipv4 + .as_ref() + .and_then(config_ipv4) + }) + } + + fn ipv6(&self) -> Option { + self.snapshot() + .runtime + .core + .routes + .ipv6 + .as_ref() + .and_then(config_ipv6) + } + + fn is_ip_local_ipv6(&self, ip: &std::net::Ipv6Addr) -> bool { + self.ipv6().is_some_and(|address| address.address() == *ip) + || self.public_ipv6_state.public_ipv6_lease_contains(ip) + } + + fn proxy_cidrs(&self) -> Vec { + self.snapshot() + .runtime + .core + .routes + .proxy_networks + .iter() + .filter_map(|proxy| config_ipv4_cidr(proxy.mapped.as_ref().unwrap_or(&proxy.real))) + .collect() + } + + fn proxy_networks(&self) -> Vec { + self.snapshot().runtime.core.routes.proxy_networks.clone() + } + + fn hostname(&self) -> String { + self.snapshot() + .runtime + .core + .node + .hostname + .clone() + .unwrap_or_default() + } + + fn feature_flags(&self) -> PeerFeatureFlag { + let snapshot = self.snapshot(); + let mut flags = snapshot.runtime.feature_flags; + flags.avoid_relay_data = snapshot.flags.disable_relay_data + || self.avoid_relay_data_preference.load(Ordering::Acquire); + flags.ipv6_public_addr_provider |= self.public_ipv6_state.public_ipv6_provider_enabled(); + flags + } + + fn set_avoid_relay_data_preference(&self, avoid_relay_data: bool) -> bool { + let before = self.feature_flags().avoid_relay_data; + self.avoid_relay_data_preference + .store(avoid_relay_data, Ordering::Release); + before != self.feature_flags().avoid_relay_data + } + + fn subscribe_runtime_changes(&self) -> Option> { + Some(self.config.subscribe_peer_runtime_changes()) + } + + fn easytier_version(&self) -> String { + self.snapshot().easytier_version.clone() + } + + fn ospf_update_my_foreign_network_interval_sec(&self) -> u64 { + self.snapshot().ospf_update_my_foreign_network_interval_sec + } + + fn hmac_secret_digest(&self) -> bool { + self.snapshot().hmac_secret_digest + } + + fn advertised_ipv6_public_addr_prefix(&self) -> Option { + self.public_ipv6_state.advertised_ipv6_public_addr_prefix() + } + + fn is_ip_in_same_network(&self, ip: &IpAddr) -> bool { + match ip { + IpAddr::V4(ip) => self.ipv4().is_some_and(|network| network.contains(ip)), + IpAddr::V6(ip) => self.ipv6().is_some_and(|network| network.contains(ip)), + } + } + + fn pinned_remote_static_pubkey(&self, tunnel_info: Option<&TunnelInfo>) -> Option { + let remote_url = tunnel_info + .and_then(|info| info.remote_addr.as_ref())? + .url + .parse::() + .ok()?; + self.snapshot() + .pinned_peers + .iter() + .find(|(uri, _)| *uri == remote_url) + .and_then(|(_, public_key)| public_key.clone()) + } + + fn secret_proof(&self, challenge: &[u8]) -> Option> { + let snapshot = self.snapshot(); + let secret = snapshot.runtime.network_identity.network_secret.as_ref()?; + secret_proof_from_secret(secret, challenge) + } + + fn secret_digest(&self, network_identity: &NetworkIdentity) -> Vec { + let snapshot = self.snapshot(); + if snapshot.hmac_secret_digest { + snapshot + .runtime + .network_identity + .network_secret + .as_deref() + .and_then(|secret| secret_proof_from_secret(secret, b"digest")) + .map(|mac| mac.finalize().into_bytes().to_vec()) + .unwrap_or_default() + } else { + network_identity + .secret_digest() + .unwrap_or_default() + .to_vec() + } + } + + fn peer_groups(&self, peer_id: PeerId) -> Vec { + self.snapshot() + .peer_group_memberships + .iter() + .map(|group| { + PeerGroupInfo::generate_with_proof( + group.group_name.clone(), + group.group_secret.clone(), + peer_id, + ) + }) + .collect() + } + + fn acl_group_declarations(&self) -> Vec { + self.snapshot().acl_group_declarations.clone() + } + + fn is_pubkey_trusted(&self, pubkey: &[u8], network_name: &str) -> bool { + if self.trusted_keys.verify_trusted_key(pubkey, network_name) { + return true; + } + network_name == self.snapshot().runtime.network_identity.network_name + && self.credentials.is_pubkey_trusted(pubkey) + } + + fn is_pubkey_trusted_with_source( + &self, + pubkey: &[u8], + network_name: &str, + source: TrustedKeySource, + ) -> bool { + self.trusted_keys + .verify_trusted_key_with_source(pubkey, network_name, Some(source)) + } + + fn list_trusted_keys(&self, network_name: &str) -> Vec<(Vec, TrustedKeyMetadata)> { + self.trusted_keys.list_trusted_keys(network_name) + } + + fn trusted_credential_pubkeys( + &self, + network_secret: &str, + ) -> Vec { + self.credentials.get_trusted_pubkeys(network_secret) + } + + fn remove_expired_credentials(&self) -> bool { + self.credentials.remove_expired_credentials() + } + + fn issue_credential_changed(&self) { + self.events.emit(CoreEvent::CredentialChanged); + } + + fn update_trusted_keys(&self, keys: TrustedKeyMap, network_name: &str) { + self.trusted_keys.update_trusted_keys(network_name, keys); + } + + fn remove_trusted_keys(&self, network_name: &str) { + self.trusted_keys.remove_trusted_keys(network_name); + } + + fn record_control_tx(&self, network_name: &str, bytes: u64) { + self.record_control_metric( + network_name, + bytes, + MetricName::TrafficControlBytesTx, + MetricName::TrafficControlPacketsTx, + ); + } + + fn record_control_rx(&self, network_name: &str, bytes: u64) { + self.record_control_metric( + network_name, + bytes, + MetricName::TrafficControlBytesRx, + MetricName::TrafficControlPacketsRx, + ); + } + + fn recv_limiter(&self, network_name: &str, is_foreign_network: bool) -> Option { + let limits = self.snapshot().traffic_limits(); + let (key, bps) = if is_foreign_network && let Some(limit) = limits.foreign_relay_bps { + (format!("peer:foreign:{network_name}:recv"), limit) + } else { + ("peer:instance:recv".to_owned(), limits.instance_recv_bps?) + }; + self.get_or_create_limiter(&key, bps) + } + + fn foreign_forward_limiter(&self, network_name: &str) -> Option { + let bps = self.snapshot().traffic_limits().foreign_relay_bps?; + self.get_or_create_limiter(&format!("peer:foreign:{network_name}:forward"), bps) + } + + fn issue_event(&self, event: PeerEvent) { + let context_event = match &event { + PeerEvent::PeerAdded(peer_id) => PeerContextEvent::PeerAdded(*peer_id), + PeerEvent::PeerRemoved(peer_id) => PeerContextEvent::PeerRemoved(*peer_id), + PeerEvent::PeerConnAdded(_) => PeerContextEvent::PeerConnAdded, + PeerEvent::PeerConnRemoved(_) => PeerContextEvent::PeerConnRemoved, + }; + let _ = self.peer_events.send(context_event); + let event = match event { + PeerEvent::PeerAdded(peer_id) => CoreEvent::PeerAdded(peer_id), + PeerEvent::PeerRemoved(peer_id) => CoreEvent::PeerRemoved(peer_id), + PeerEvent::PeerConnAdded(info) => CoreEvent::PeerConnAdded(info), + PeerEvent::PeerConnRemoved(info) => CoreEvent::PeerConnRemoved(info), + }; + self.events.emit(event); + } + + fn subscribe_peer_events(&self) -> Option { + Some(self.peer_events.subscribe()) + } +} + +#[cfg(test)] +pub(crate) mod tests { + #![allow(clippy::field_reassign_with_default)] + + use super::*; + use crate::config::runtime::{CoreRuntimeConfig, CoreRuntimeConfigStore}; + use crate::peers::test_support::{NoopPeerContext, PeerContextTestExt}; + use std::sync::atomic::{AtomicBool, Ordering}; + + impl PeerRuntimeSnapshot { + pub(crate) fn set_acl_groups(&mut self, acl: Option<&Acl>) { + (self.acl_group_declarations, self.peer_group_memberships) = peer_acl_groups(acl); + } + } + + impl CorePeerContext { + pub(crate) fn trusted_key_manager(&self) -> Arc { + self.trusted_keys.clone() + } + } + + impl PeerContextTestExt for CorePeerContext { + fn runtime_config(&self) -> PeerRuntimeConfig { + let mut runtime = self.snapshot().runtime.clone(); + runtime.stun_info = self.stun_info(); + runtime + } + } + + #[derive(Default)] + struct TestPeerEventSink { + events: Mutex>, + credential_changed: AtomicBool, + } + + impl CoreEventSink for TestPeerEventSink { + fn emit(&self, event: CoreEvent) { + if matches!(&event, CoreEvent::CredentialChanged) { + self.credential_changed.store(true, Ordering::Release); + } + self.events.lock().unwrap().push(event); + } + } + + fn test_core_context_adapters(events: Arc) -> CorePeerContextAdapters { + CorePeerContextAdapters { + stun_info_source: Some(Arc::new(())), + events, + credential_storage: None, + } + } + + fn submitted_snapshot(hostname: &str, disable_relay_data: bool) -> PeerRuntimeSnapshot { + let mut flags = FlagsInConfig::default(); + flags.disable_relay_data = disable_relay_data; + PeerRuntimeSnapshot::new( + PeerRuntimeConfig { + core: CoreConfig { + node: NodeConfig { + hostname: Some(hostname.to_owned()), + ..Default::default() + }, + ..Default::default() + }, + network_identity: NetworkIdentity::default(), + stun_info: StunInfo::default(), + feature_flags: PeerFeatureFlag::default(), + secure_mode: None, + host_routing: HostRoutingPolicy::default(), + }, + flags, + ) + } + + fn host_snapshot_input(flags: FlagsInConfig, acl: Option) -> PeerRuntimeSnapshotInput { + PeerRuntimeSnapshotInput { + node: NodeConfig { + peer_id: None, + instance_id: Some([7; 16]), + hostname: Some("host-node".to_owned()), + network_name: "host-network".to_owned(), + }, + routes: RouteConfig { + ipv4: Some(IpPrefix::new("10.20.0.7".parse().unwrap(), 16).unwrap()), + ..Default::default() + }, + network_identity: NetworkIdentity::new("host-network".to_owned(), "secret".to_owned()), + stun_info: StunInfo::default(), + flags, + secure_mode: None, + host_routing: HostRoutingPolicy { + local_exit_node_fallback: true, + }, + acl, + easytier_version: "host-version".to_owned(), + pinned_peers: vec![( + "tcp://192.0.2.10:11010".parse().unwrap(), + Some("peer-key".to_owned()), + )], + ospf_update_my_foreign_network_interval_sec: 17, + max_direct_conns_per_peer_in_foreign_network: 5, + hmac_secret_digest: true, + } + } + + #[test] + fn host_input_derives_peer_policy_features_and_traffic() { + let mut flags = FlagsInConfig::default(); + flags.disable_p2p = true; + flags.need_p2p = true; + flags.relay_all_peer_rpc = true; + flags.disable_relay_data = true; + flags.latency_first = true; + flags.enable_encryption = false; + flags.disable_kcp_input = true; + flags.disable_relay_kcp = true; + flags.disable_quic_input = true; + flags.disable_relay_quic = true; + flags.mtu = 1400; + flags.instance_recv_bps_limit = 0; + flags.foreign_relay_bps_limit = u64::MAX; + flags.relay_network_whitelist = "host-network".to_owned(); + + let snapshot = + PeerRuntimeSnapshot::from_host_input(host_snapshot_input(flags.clone(), None)); + let runtime = &snapshot.runtime; + + assert_eq!(snapshot.flags, flags); + assert!(!runtime.core.peer_policy.p2p_enabled); + assert!(runtime.core.peer_policy.relay_peer_rpc); + assert!(!runtime.core.peer_policy.relay_data); + assert!(runtime.core.peer_policy.latency_first); + assert!(!runtime.core.peer_policy.encryption_required); + assert_eq!(runtime.core.traffic.mtu, Some(1400)); + assert_eq!(runtime.core.traffic.instance_recv_bps_limit, Some(0)); + assert_eq!(runtime.core.traffic.foreign_relay_bps_limit, None); + assert!(!runtime.feature_flags.kcp_input); + assert!(runtime.feature_flags.no_relay_kcp); + assert!(runtime.feature_flags.support_conn_list_sync); + assert!(!runtime.feature_flags.quic_input); + assert!(runtime.feature_flags.no_relay_quic); + assert!(runtime.feature_flags.need_p2p); + assert!(runtime.feature_flags.disable_p2p); + assert!(runtime.feature_flags.avoid_relay_data); + assert!(!snapshot.avoid_relay_data_preference); + } + + #[test] + fn host_input_derives_acl_groups_and_preserves_explicit_inputs() { + let acl = Acl { + acl_v1: Some(easytier_proto::acl::AclV1 { + chains: Vec::new(), + group: Some(easytier_proto::acl::GroupInfo { + declares: vec![ + easytier_proto::acl::GroupIdentity { + group_name: "ops".to_owned(), + group_secret: "ops-secret".to_owned(), + }, + easytier_proto::acl::GroupIdentity { + group_name: "audit".to_owned(), + group_secret: "audit-secret".to_owned(), + }, + ], + members: vec!["ops".to_owned(), "undeclared".to_owned()], + }), + }), + }; + let mut flags = FlagsInConfig::default(); + flags.relay_network_whitelist = "other-network".to_owned(); + + let snapshot = PeerRuntimeSnapshot::from_host_input(host_snapshot_input(flags, Some(acl))); + + assert!(snapshot.avoid_relay_data_preference); + assert_eq!(snapshot.easytier_version, "host-version"); + assert_eq!( + snapshot.pinned_peers, + vec![( + "tcp://192.0.2.10:11010".parse().unwrap(), + Some("peer-key".to_owned()) + )] + ); + assert_eq!(snapshot.ospf_update_my_foreign_network_interval_sec, 17); + assert_eq!(snapshot.max_direct_conns_per_peer_in_foreign_network, 5); + assert!(snapshot.hmac_secret_digest); + assert!(snapshot.runtime.host_routing.local_exit_node_fallback); + assert_eq!( + snapshot.acl_group_declarations, + vec![ + PeerGroupIdentity { + group_name: "ops".to_owned(), + group_secret: "ops-secret".to_owned(), + }, + PeerGroupIdentity { + group_name: "audit".to_owned(), + group_secret: "audit-secret".to_owned(), + }, + ] + ); + assert_eq!( + snapshot.peer_group_memberships, + vec![PeerGroupIdentity { + group_name: "ops".to_owned(), + group_secret: "ops-secret".to_owned(), + }] + ); + } + + #[test] + fn records_control_traffic_in_core_owned_metrics() { + let context = CorePeerContext::new( + CoreRuntimeConfigStore::new( + CoreRuntimeConfig::default(), + Arc::new(PeerRuntimeSnapshot::default()), + ), + Arc::new(()), + test_core_context_adapters(Arc::new(())), + ); + let labels = + LabelSet::new().with_label_type(LabelType::NetworkName("metrics-network".to_owned())); + + PeerContext::record_control_tx(&context, "metrics-network", 128); + + assert_eq!( + context + .stats_manager() + .get_metric(MetricName::TrafficControlBytesTx, &labels) + .unwrap() + .value, + 128 + ); + assert_eq!( + context + .stats_manager() + .get_metric(MetricName::TrafficControlPacketsTx, &labels) + .unwrap() + .value, + 1 + ); + } + + #[test] + fn explicit_traffic_limits_preserve_zero_and_override_flags() { + let mut runtime = PeerRuntimeSnapshot::default().runtime; + runtime.core.traffic.instance_recv_bps_limit = Some(0); + runtime.core.traffic.foreign_relay_bps_limit = Some(2048); + let mut flags = FlagsInConfig::default(); + flags.instance_recv_bps_limit = 1024; + flags.foreign_relay_bps_limit = 4096; + + let snapshot = PeerRuntimeSnapshot::new(runtime, flags); + + assert_eq!(snapshot.traffic_limits().instance_recv_bps, Some(0)); + assert_eq!(snapshot.traffic_limits().foreign_relay_bps, Some(2048)); + } + + #[test] + fn legacy_traffic_limits_ignore_unlimited_sentinels() { + let runtime = PeerRuntimeSnapshot::default().runtime; + let mut flags = FlagsInConfig::default(); + flags.instance_recv_bps_limit = 1024; + flags.foreign_relay_bps_limit = u64::MAX; + + let snapshot = PeerRuntimeSnapshot::new(runtime, flags); + + assert_eq!(snapshot.traffic_limits().instance_recv_bps, Some(1024)); + assert_eq!(snapshot.traffic_limits().foreign_relay_bps, None); + } + + #[test] + fn explicit_unlimited_limits_override_legacy_values() { + let mut runtime = PeerRuntimeSnapshot::default().runtime; + runtime.core.traffic.instance_recv_bps_limit = Some(u64::MAX); + runtime.core.traffic.foreign_relay_bps_limit = Some(u64::MAX); + let mut flags = FlagsInConfig::default(); + flags.instance_recv_bps_limit = 1024; + flags.foreign_relay_bps_limit = 2048; + + let snapshot = PeerRuntimeSnapshot::new(runtime, flags); + + assert_eq!(snapshot.traffic_limits(), PeerTrafficLimits::default()); + } + + #[test] + fn portable_traffic_limits_default_to_unlimited() { + let runtime = PeerRuntimeSnapshot::default().runtime; + + let snapshot = PeerRuntimeSnapshot::new(runtime, FlagsInConfig::default()); + + assert_eq!(snapshot.traffic_limits(), PeerTrafficLimits::default()); + } + + fn submitted_config(snapshot: PeerRuntimeSnapshot) -> CoreRuntimeConfigStore { + CoreRuntimeConfigStore::new(CoreRuntimeConfig::default(), Arc::new(snapshot)) + } + + #[test] + fn core_peer_context_separates_config_versions_from_live_support() { + let config = submitted_config(submitted_snapshot("before", false)); + let context = CorePeerContext::new( + config.clone(), + Arc::new(()), + test_core_context_adapters(Arc::new(())), + ); + + assert_eq!(context.hostname(), "before"); + assert!(!context.feature_flags().avoid_relay_data); + + context.set_avoid_relay_data_preference(true); + assert!(context.feature_flags().avoid_relay_data); + + config.update_peer(Arc::new(submitted_snapshot("after", true))); + context.set_avoid_relay_data_preference(false); + assert_eq!(context.hostname(), "after"); + assert!(context.feature_flags().avoid_relay_data); + + config.update_peer(Arc::new(submitted_snapshot("after", false))); + assert!(!context.feature_flags().avoid_relay_data); + } + + #[tokio::test] + async fn core_peer_context_owns_events_and_projects_them_to_sink() { + let config = submitted_config(submitted_snapshot("events", false)); + let sink = Arc::new(TestPeerEventSink::default()); + let context = CorePeerContext::new( + config, + Arc::new(()), + test_core_context_adapters(sink.clone()), + ); + let mut events = context.subscribe_peer_events().unwrap(); + + context.issue_event(PeerEvent::PeerAdded(7)); + + assert_eq!(events.recv().await.unwrap(), PeerContextEvent::PeerAdded(7)); + assert!(matches!( + sink.events.lock().unwrap().as_slice(), + [CoreEvent::PeerAdded(7)] + )); + } + + #[test] + fn core_peer_context_owns_trusted_keys_and_projects_credential_changes() { + let config = submitted_config(submitted_snapshot("trust", false)); + let events = Arc::new(TestPeerEventSink::default()); + let context = CorePeerContext::new( + config, + Arc::new(()), + test_core_context_adapters(events.clone()), + ); + let public_key = vec![7; 32]; + let mut keys = TrustedKeyMap::new(); + keys.insert( + public_key.clone(), + TrustedKeyMetadata { + source: TrustedKeySource::OspfNode, + expiry_unix: None, + }, + ); + + context.update_trusted_keys(keys, "foreign"); + context.issue_credential_changed(); + + assert!(context.is_pubkey_trusted(&public_key, "foreign")); + assert_eq!(context.list_trusted_keys("foreign").len(), 1); + assert!(events.credential_changed.load(Ordering::Acquire)); + } + + #[tokio::test] + async fn foreign_forward_limiter_is_independent_from_peer_receive_limiter() { + let mut snapshot = submitted_snapshot("limiter", false); + snapshot.runtime.core.traffic.foreign_relay_bps_limit = Some(1024); + let config = submitted_config(snapshot); + let context = CorePeerContext::new( + config, + Arc::new(()), + test_core_context_adapters(Arc::new(())), + ); + + let receive = context.recv_limiter("foreign", true).unwrap(); + let receive_again = context.recv_limiter("foreign", true).unwrap(); + let forward = context.foreign_forward_limiter("foreign").unwrap(); + assert!(Arc::ptr_eq(&receive, &receive_again)); + assert!(!Arc::ptr_eq(&receive, &forward)); + context.stop().await; + } + + #[tokio::test] + async fn foreign_forward_limiter_does_not_fall_back_to_instance_limit() { + let mut snapshot = submitted_snapshot("limiter", false); + snapshot.runtime.core.traffic.foreign_relay_bps_limit = None; + snapshot.runtime.core.traffic.instance_recv_bps_limit = Some(1024); + let config = submitted_config(snapshot); + let context = CorePeerContext::new( + config, + Arc::new(()), + test_core_context_adapters(Arc::new(())), + ); + + assert!(context.recv_limiter("foreign", true).is_some()); + assert!(context.foreign_forward_limiter("foreign").is_none()); + context.stop().await; + } + + #[test] + fn noop_peer_context_uses_runtime_secret_proof_prefix() { + let context = NoopPeerContext::new(NetworkIdentity { + network_name: "net".to_string(), + network_secret: Some("secret".to_string()), + network_secret_digest: None, + }); + + let proof = context + .secret_proof(b"challenge") + .unwrap() + .finalize() + .into_bytes() + .to_vec(); + let expected = secret_proof_from_secret("secret", b"challenge") + .unwrap() + .finalize() + .into_bytes() + .to_vec(); + + assert_eq!(proof, expected); + } + + struct RuntimeConfigContext { + instance_id: uuid::Uuid, + } + + impl PeerContext for RuntimeConfigContext { + fn network_identity(&self) -> NetworkIdentity { + NetworkIdentity { + network_name: "net".to_string(), + network_secret: Some("secret".to_string()), + network_secret_digest: None, + } + } + + fn instance_id(&self) -> uuid::Uuid { + self.instance_id + } + + fn ipv4(&self) -> Option { + Some("10.1.0.1/24".parse().unwrap()) + } + + fn ipv6(&self) -> Option { + Some("2001:db8::1/64".parse().unwrap()) + } + + fn hostname(&self) -> String { + "node-a".to_string() + } + } + + impl PeerContextTestExt for RuntimeConfigContext {} + + #[test] + fn runtime_config_preserves_peer_context_snapshot() { + let instance_id = uuid::Uuid::from_u128(0x11223344556677889900aabbccddeeff); + let context = RuntimeConfigContext { instance_id }; + + let config = context.runtime_config(); + + assert_eq!(config.network_identity.network_name, "net"); + assert_eq!(config.core.node.instance_id, Some(*instance_id.as_bytes())); + assert_eq!(config.core.node.hostname.as_deref(), Some("node-a")); + assert_eq!(config.core.node.network_name, "net"); + assert_eq!( + config.core.routes.ipv4, + Some(IpPrefix::new("10.1.0.1".parse().unwrap(), 24).unwrap()) + ); + assert_eq!( + config.core.routes.ipv6, + Some(IpPrefix::new("2001:db8::1".parse().unwrap(), 64).unwrap()) + ); + } + + #[test] + fn core_owned_peer_context_reads_normalized_snapshot() { + let instance_id = uuid::Uuid::from_u128(0x00112233445566778899aabbccddeeff); + let runtime = PeerRuntimeConfig { + core: CoreConfig { + node: NodeConfig { + peer_id: Some(7), + instance_id: Some(*instance_id.as_bytes()), + hostname: Some("config-node".to_owned()), + network_name: "config-net".to_owned(), + }, + routes: RouteConfig { + ipv4: Some(IpPrefix::new("10.20.0.7".parse().unwrap(), 16).unwrap()), + ipv6: Some(IpPrefix::new("2001:db8::7".parse().unwrap(), 64).unwrap()), + proxy_networks: vec![ + crate::config::ProxyNetworkConfig { + real: IpPrefix::new("10.40.0.0".parse().unwrap(), 16).unwrap(), + mapped: Some(IpPrefix::new("10.50.0.0".parse().unwrap(), 16).unwrap()), + }, + crate::config::ProxyNetworkConfig { + real: IpPrefix::new("10.60.0.0".parse().unwrap(), 16).unwrap(), + mapped: None, + }, + ], + ..Default::default() + }, + ..Default::default() + }, + network_identity: NetworkIdentity { + network_name: "config-net".to_owned(), + network_secret: Some("secret".to_owned()), + network_secret_digest: None, + }, + stun_info: StunInfo::default(), + feature_flags: PeerFeatureFlag::default(), + secure_mode: Some(SecureModeConfig { + enabled: true, + ..Default::default() + }), + host_routing: HostRoutingPolicy { + local_exit_node_fallback: true, + }, + }; + let mut flags = FlagsInConfig::default(); + flags.p2p_only = true; + let acl = Acl { + acl_v1: Some(easytier_proto::acl::AclV1 { + chains: Vec::new(), + group: Some(easytier_proto::acl::GroupInfo { + declares: vec![easytier_proto::acl::GroupIdentity { + group_name: "ops".to_string(), + group_secret: "group-secret".to_string(), + }], + members: vec!["ops".to_string()], + }), + }), + }; + let context = core_owned_context_with_acl(runtime.clone(), flags.clone(), None, Some(&acl)); + + assert_eq!(context.runtime_config().core, runtime.core); + assert_eq!(context.network_identity(), runtime.network_identity); + assert_eq!(context.flags(), flags); + assert_eq!(context.instance_id(), instance_id); + assert_eq!(context.hostname(), "config-node"); + assert_eq!(context.ipv4(), Some("10.20.0.7/16".parse().unwrap())); + assert_eq!(context.ipv6(), Some("2001:db8::7/64".parse().unwrap())); + assert!(context.is_ip_in_same_network(&"10.20.99.1".parse().unwrap())); + assert!(context.is_ip_in_same_network(&"2001:db8::99".parse().unwrap())); + assert!(!context.is_ip_in_same_network(&"10.21.0.1".parse().unwrap())); + assert_eq!( + context.proxy_cidrs(), + vec![ + "10.50.0.0/16".parse().unwrap(), + "10.60.0.0/16".parse().unwrap() + ] + ); + assert!(context.secure_mode().unwrap().enabled); + assert!(context.host_routing_policy().local_exit_node_fallback); + + let groups = context.peer_groups(7); + assert_eq!(groups.len(), 1); + assert_eq!(groups[0].group_name, "ops"); + assert!(groups[0].verify("group-secret", 7)); + assert_eq!( + context.acl_group_declarations(), + vec![PeerGroupIdentity { + group_name: "ops".to_string(), + group_secret: "group-secret".to_string(), + }] + ); + + let proof = context + .secret_proof(b"challenge") + .unwrap() + .finalize() + .into_bytes(); + let expected = secret_proof_from_secret("secret", b"challenge") + .unwrap() + .finalize() + .into_bytes(); + assert_eq!(proof, expected); + } + + #[test] + fn core_owned_peer_context_uses_live_stun_source_when_injected() { + struct TestStunInfoSource(StunInfo); + + impl PeerStunInfoSource for TestStunInfoSource { + fn stun_info(&self) -> StunInfo { + self.0.clone() + } + } + + let mut runtime = PeerRuntimeSnapshot::default().runtime; + runtime.stun_info.tcp_nat_type = 1; + let mut live = StunInfo::default(); + live.tcp_nat_type = 4; + let context = core_owned_context( + runtime, + FlagsInConfig::default(), + Some(Arc::new(TestStunInfoSource(live.clone()))), + ); + + assert_eq!(context.stun_info(), live); + assert_eq!(context.runtime_config().stun_info, live); + } + + fn core_owned_context( + runtime: PeerRuntimeConfig, + flags: FlagsInConfig, + stun_info_source: Option>, + ) -> CorePeerContext { + core_owned_context_with_acl(runtime, flags, stun_info_source, None) + } + + fn core_owned_context_with_acl( + runtime: PeerRuntimeConfig, + flags: FlagsInConfig, + stun_info_source: Option>, + acl: Option<&Acl>, + ) -> CorePeerContext { + let mut snapshot = PeerRuntimeSnapshot::new(runtime, flags); + snapshot.set_acl_groups(acl); + let config = CoreRuntimeConfigStore::new(CoreRuntimeConfig::default(), Arc::new(snapshot)); + CorePeerContext::new( + config, + Arc::new(()), + CorePeerContextAdapters { + stun_info_source, + events: Arc::new(()), + credential_storage: None, + }, + ) + } + + fn core_context_with_routes(ipv4: Option, ipv6: Option) -> CorePeerContext { + core_owned_context( + PeerRuntimeConfig { + core: CoreConfig { + routes: RouteConfig { + ipv4, + ipv6, + ..Default::default() + }, + ..Default::default() + }, + network_identity: NetworkIdentity::default(), + stun_info: StunInfo::default(), + feature_flags: PeerFeatureFlag::default(), + secure_mode: None, + host_routing: HostRoutingPolicy::default(), + }, + FlagsInConfig::default(), + None, + ) + } + + #[tokio::test] + async fn core_owned_peer_context_publishes_peer_events_per_instance() { + let context = core_context_with_routes(None, None); + let mut events = context.subscribe_peer_events().unwrap(); + + context.issue_event(PeerEvent::PeerAdded(7)); + assert_eq!(events.recv().await.unwrap(), PeerContextEvent::PeerAdded(7)); + context.issue_event(PeerEvent::PeerConnAdded(Default::default())); + assert_eq!( + events.recv().await.unwrap(), + PeerContextEvent::PeerConnAdded + ); + context.issue_event(PeerEvent::PeerConnRemoved(Default::default())); + assert_eq!( + events.recv().await.unwrap(), + PeerContextEvent::PeerConnRemoved + ); + context.issue_event(PeerEvent::PeerRemoved(7)); + assert_eq!( + events.recv().await.unwrap(), + PeerContextEvent::PeerRemoved(7) + ); + } + + #[test] + fn core_owned_peer_context_validates_route_family_and_prefix_edges() { + let mismatched = core_context_with_routes( + Some(IpPrefix { + address: "2001:db8::1".parse().unwrap(), + prefix_len: 64, + }), + Some(IpPrefix { + address: "10.20.0.1".parse().unwrap(), + prefix_len: 24, + }), + ); + assert_eq!(mismatched.ipv4(), None); + assert_eq!(mismatched.ipv6(), None); + assert!(!mismatched.is_ip_in_same_network(&"2001:db8::2".parse().unwrap())); + assert!(!mismatched.is_ip_in_same_network(&"10.20.0.2".parse().unwrap())); + + let edges = core_context_with_routes( + Some(IpPrefix::new("10.20.0.7".parse().unwrap(), 0).unwrap()), + Some(IpPrefix::new("2001:db8::7".parse().unwrap(), 128).unwrap()), + ); + assert!(edges.is_ip_in_same_network(&"203.0.113.1".parse().unwrap())); + assert!(edges.is_ip_in_same_network(&"2001:db8::7".parse().unwrap())); + assert!(!edges.is_ip_in_same_network(&"2001:db8::8".parse().unwrap())); + + let invalid = core_context_with_routes( + Some(IpPrefix { + address: "10.20.0.7".parse().unwrap(), + prefix_len: 33, + }), + None, + ); + assert_eq!(invalid.ipv4(), None); + assert!(!invalid.is_ip_in_same_network(&"10.20.0.7".parse().unwrap())); + } + + #[test] + fn trusted_key_manager_respects_source_filter() { + let manager = TrustedKeyMapManager::new(); + let network_name = "net"; + let pubkey = vec![1; 32]; + manager.update_trusted_keys( + network_name, + HashMap::from([( + pubkey.clone(), + TrustedKeyMetadata { + source: TrustedKeySource::OspfCredential, + expiry_unix: None, + }, + )]), + ); + + assert!(manager.verify_trusted_key(&pubkey, network_name)); + assert!(manager.verify_trusted_key_with_source( + &pubkey, + network_name, + Some(TrustedKeySource::OspfCredential), + )); + assert!(!manager.verify_trusted_key_with_source( + &pubkey, + network_name, + Some(TrustedKeySource::OspfNode), + )); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/credential_manager.rs b/vendor/easytier/easytier-core/src/peers/credential_manager.rs new file mode 100644 index 0000000..266b8c4 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/credential_manager.rs @@ -0,0 +1,1352 @@ +use std::{ + collections::{HashMap, HashSet}, + sync::{Arc, Mutex}, + time::{Duration, SystemTime, UNIX_EPOCH}, +}; + +use base64::{Engine, engine::general_purpose::STANDARD as BASE64_STANDARD}; +use serde::{Deserialize, Serialize}; +use sha2::{Digest, Sha256}; +use x25519_dalek::{PublicKey, StaticSecret}; + +use crate::{ + config::toml::ManagedCredentialConfig, + proto::peer_rpc::{TrustedCredentialPubkey, TrustedCredentialPubkeyProof}, +}; + +fn default_true() -> bool { + true +} + +fn current_unix_timestamp() -> i64 { + SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap() + .as_secs() as i64 +} + +#[derive(Debug, Clone)] +pub struct CredentialCreateOptions { + pub groups: Vec, + pub allow_relay: bool, + pub allowed_proxy_cidrs: Vec, + pub ttl: Duration, + pub credential_id: Option, + pub reusable: bool, +} + +#[derive(Debug, Clone)] +pub struct CredentialUpsertOptions { + pub credential_id: String, + pub credential_secret: String, + pub groups: Vec, + pub allow_relay: bool, + pub allowed_proxy_cidrs: Vec, + pub expiry_unix: i64, + pub reusable: bool, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +struct CredentialGrant { + groups: Vec, + allow_relay: bool, + allowed_proxy_cidrs: Vec, + #[serde(default = "default_true")] + reusable: bool, +} + +#[derive(Debug)] +struct InvalidAllowedProxyCidr(String); + +impl std::fmt::Display for InvalidAllowedProxyCidr { + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(formatter, "invalid allowed_proxy_cidr: {}", self.0) + } +} + +impl CredentialGrant { + fn new( + groups: Vec, + allow_relay: bool, + allowed_proxy_cidrs: Vec, + reusable: bool, + ) -> Result { + let mut grant = Self { + groups, + allow_relay, + allowed_proxy_cidrs, + reusable, + }; + grant.normalize()?; + Ok(grant) + } + + fn normalize(&mut self) -> Result<(), InvalidAllowedProxyCidr> { + for cidr in &mut self.allowed_proxy_cidrs { + let normalized = cidr.trim().to_owned(); + normalized + .parse::() + .map_err(|_| InvalidAllowedProxyCidr(normalized.clone()))?; + *cidr = normalized; + } + Ok(()) + } + + fn for_attached_peer(groups: Vec) -> Self { + Self { + groups, + allow_relay: false, + allowed_proxy_cidrs: Vec::new(), + reusable: false, + } + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub(crate) struct CredentialEntry { + pubkey: String, + #[serde(default)] + secret: String, + #[serde(flatten)] + grant: CredentialGrant, + expiry_unix: i64, + created_at_unix: i64, +} + +impl CredentialEntry { + fn is_active_at(&self, now: i64) -> bool { + self.expiry_unix > now + } + + fn to_trusted_credential(&self) -> Option { + Some(TrustedCredentialPubkey { + pubkey: CredentialManager::decode_pubkey_b64(&self.pubkey)?, + groups: self.grant.groups.clone(), + allow_relay: self.grant.allow_relay, + expiry_unix: self.expiry_unix, + allowed_proxy_cidrs: self.grant.allowed_proxy_cidrs.clone(), + reusable: Some(self.grant.reusable), + }) + } + + fn to_credential_info(&self, credential_id: &str) -> CredentialInfo { + CredentialInfo { + credential_id: credential_id.to_string(), + groups: self.grant.groups.clone(), + allow_relay: self.grant.allow_relay, + expiry_unix: self.expiry_unix, + allowed_proxy_cidrs: self.grant.allowed_proxy_cidrs.clone(), + reusable: Some(self.grant.reusable), + public_key_fingerprint: CredentialManager::public_key_fingerprint(&self.pubkey) + .unwrap_or_default(), + } + } + + fn from_managed(entry: &ManagedCredentialConfig) -> Result { + let credential_id = entry.credential_id.trim(); + let private_bytes: [u8; 32] = BASE64_STANDARD + .decode(entry.credential_secret.trim()) + .map_err(|_| format!("credential_secret for {credential_id} must be base64"))? + .try_into() + .map_err(|_| format!("credential_secret for {credential_id} must contain 32 bytes"))?; + let private = StaticSecret::from(private_bytes); + let grant = CredentialGrant::new( + entry.groups.clone(), + entry.allow_relay, + entry.allowed_proxy_cidrs.clone(), + entry.reusable, + ) + .map_err(|error| { + format!( + "invalid allowed_proxy_cidr for {credential_id}: {}", + error.0 + ) + })?; + Ok(Self { + pubkey: BASE64_STANDARD.encode(PublicKey::from(&private).as_bytes()), + secret: BASE64_STANDARD.encode(private.as_bytes()), + grant, + expiry_unix: entry.expiry_unix, + created_at_unix: 0, + }) + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct CredentialInfo { + pub credential_id: String, + pub groups: Vec, + pub allow_relay: bool, + pub expiry_unix: i64, + pub allowed_proxy_cidrs: Vec, + pub reusable: Option, + pub public_key_fingerprint: String, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct GeneratedCredential { + pub credential_id: String, + pub secret: String, + pub expiry_unix: i64, + pub changed: bool, +} + +pub trait CredentialStorage: Send + Sync + 'static { + fn load(&self) -> anyhow::Result>; + + /// Atomically replaces the previously committed credential snapshot. + /// Returning an error must leave that snapshot readable. + fn store(&self, serialized_credentials: &str) -> anyhow::Result<()>; +} + +#[derive(Default)] +struct CredentialState { + base: HashMap, + managed: HashMap, + pending_managed: Option>, + ephemeral: HashMap, +} + +pub(crate) struct CredentialManager { + state: Mutex, + storage: Option>, + storage_load_error: Option, +} + +/// A validated managed credential replacement awaiting installation. +#[cfg(feature = "web-client")] +pub(crate) struct ManagedCredentialReplacement<'a> { + manager: &'a CredentialManager, + changed: bool, + installed: bool, +} + +#[cfg(feature = "web-client")] +impl Drop for ManagedCredentialReplacement<'_> { + fn drop(&mut self) { + if self.changed && !self.installed { + self.manager.state.lock().unwrap().pending_managed = None; + } + } +} + +impl Default for CredentialManager { + fn default() -> Self { + Self::new() + } +} + +/// Validate a complete managed credential replacement with the same +/// normalization and key-identity rules used when it is installed. +#[cfg(any(feature = "management-rpc", feature = "browser-config"))] +pub fn validate_managed_credential_set( + credentials: &[crate::proto::api::manage::ManagedCredentialConfig], +) -> Result<(), String> { + let credentials: Vec<_> = credentials + .iter() + .map(|credential| ManagedCredentialConfig { + credential_id: credential.credential_id.clone(), + credential_secret: credential.credential_secret.clone(), + groups: credential.groups.clone(), + allow_relay: credential.allow_relay, + allowed_proxy_cidrs: credential.allowed_proxy_cidrs.clone(), + expiry_unix: credential.expiry_unix, + reusable: credential.reusable.unwrap_or(true), + }) + .collect(); + CredentialManager::build_managed_entries(&credentials).map(|_| ()) +} + +impl CredentialManager { + pub fn new() -> Self { + Self { + state: Mutex::new(CredentialState::default()), + storage: None, + storage_load_error: None, + } + } + + pub fn from_storage(storage: Arc) -> Self { + let loaded = match storage.load() { + Ok(Some(serialized)) => serde_json::from_str(&serialized) + .map_err(anyhow::Error::from) + .and_then(Self::normalize_loaded_entries), + Ok(None) => Ok(HashMap::new()), + Err(error) => Err(error), + }; + let (base, storage_load_error) = match loaded { + Ok(base) => (base, None), + Err(error) => { + tracing::error!(?error, "credential storage is unavailable"); + (HashMap::new(), Some(error.to_string())) + } + }; + Self { + state: Mutex::new(CredentialState { + base, + ..Default::default() + }), + storage: Some(storage), + storage_load_error, + } + } + + fn normalize_loaded_entries( + mut entries: HashMap, + ) -> anyhow::Result> { + for (credential_id, entry) in &mut entries { + entry.grant.normalize().map_err(|error| { + anyhow::anyhow!("invalid stored credential {credential_id}: {error}") + })?; + } + Ok(entries) + } + + pub fn generate_credential_with_options( + &self, + options: CredentialCreateOptions, + ) -> Result { + let CredentialCreateOptions { + groups, + allow_relay, + allowed_proxy_cidrs, + ttl, + credential_id, + reusable, + } = options; + self.ensure_storage_available() + .map_err(|error| error.to_string())?; + let mut state = self.state.lock().unwrap(); + let now = current_unix_timestamp(); + let mut updated = state.base.clone(); + updated.retain(|_, entry| entry.is_active_at(now)); + let id = if let Some(id) = credential_id + .map(|x| x.trim().to_string()) + .filter(|x| !x.is_empty()) + { + if Self::managed_contains_id(&state, &id) { + return Err(format!("credential_id {id} is managed by configuration")); + } + if let Some(existing) = updated.get(&id) + && !existing.secret.is_empty() + { + return Ok(GeneratedCredential { + credential_id: id, + secret: existing.secret.clone(), + expiry_unix: existing.expiry_unix, + changed: false, + }); + } + id + } else { + loop { + let id = uuid::Uuid::new_v4().to_string(); + if !updated.contains_key(&id) && !Self::managed_contains_id(&state, &id) { + break id; + } + } + }; + let grant = CredentialGrant::new(groups, allow_relay, allowed_proxy_cidrs, reusable) + .map_err(|error| error.to_string())?; + + let (entry, secret) = loop { + let generated = Self::build_entry(grant.clone(), ttl); + let public_key_in_use = updated + .values() + .chain(Self::managed_values(&state)) + .chain(state.ephemeral.values()) + .any(|existing| existing.pubkey == generated.0.pubkey); + if !public_key_in_use { + break generated; + } + }; + let expiry_unix = entry.expiry_unix; + updated.insert(id.clone(), entry); + self.store_base(&updated) + .map_err(|error| format!("failed to store credentials: {error}"))?; + state.base = updated; + Ok(GeneratedCredential { + credential_id: id, + secret, + expiry_unix, + changed: true, + }) + } + + fn build_entry(grant: CredentialGrant, ttl: Duration) -> (CredentialEntry, String) { + let private = StaticSecret::random_from_rng(rand::rngs::OsRng); + let public = PublicKey::from(&private); + let pubkey = BASE64_STANDARD.encode(public.as_bytes()); + let secret = BASE64_STANDARD.encode(private.as_bytes()); + + let now = SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap() + .as_secs() as i64; + let expiry_unix = now + ttl.as_secs() as i64; + + let entry = CredentialEntry { + pubkey, + secret: secret.clone(), + grant, + expiry_unix, + created_at_unix: now, + }; + (entry, secret) + } + + pub fn revoke_credential(&self, credential_id: &str) -> Result { + self.ensure_storage_available() + .map_err(|error| error.to_string())?; + let mut state = self.state.lock().unwrap(); + if !state.base.contains_key(credential_id) { + return Ok(false); + } + let mut updated = state.base.clone(); + updated.remove(credential_id); + self.store_base(&updated) + .map_err(|error| format!("failed to store credentials: {error}"))?; + state.base = updated; + Ok(true) + } + + pub fn register_ephemeral_credential( + &self, + public_key: [u8; 32], + groups: Vec, + ) -> Result { + let entry = CredentialEntry { + pubkey: BASE64_STANDARD.encode(public_key), + secret: String::new(), + grant: CredentialGrant::for_attached_peer(groups), + expiry_unix: i64::MAX, + created_at_unix: current_unix_timestamp(), + }; + + let mut state = self.state.lock().unwrap(); + if state + .base + .values() + .chain(Self::managed_values(&state)) + .any(|existing| existing.pubkey == entry.pubkey) + || state + .ephemeral + .values() + .any(|existing| existing.pubkey == entry.pubkey) + { + return Err("credential public key is already registered".to_owned()); + } + + let credential_id = uuid::Uuid::new_v4(); + state.ephemeral.insert(credential_id, entry); + Ok(credential_id) + } + + pub fn update_ephemeral_credential_groups( + &self, + credential_id: uuid::Uuid, + groups: Vec, + ) -> Option { + let mut state = self.state.lock().unwrap(); + let credential = state.ephemeral.get_mut(&credential_id)?; + if credential.grant.groups == groups { + return Some(false); + } + credential.grant.groups = groups; + Some(true) + } + + pub fn revoke_ephemeral_credential(&self, credential_id: uuid::Uuid) -> bool { + self.state + .lock() + .unwrap() + .ephemeral + .remove(&credential_id) + .is_some() + } + + pub fn upsert_credential(&self, options: CredentialUpsertOptions) -> Result { + let CredentialUpsertOptions { + credential_id, + credential_secret, + groups, + allow_relay, + allowed_proxy_cidrs, + expiry_unix, + reusable, + } = options; + let credential_id = credential_id.trim().to_string(); + if credential_id.is_empty() { + return Err("credential_id must not be empty".to_string()); + } + if expiry_unix <= current_unix_timestamp() { + return Err("expiry_unix must be in the future".to_string()); + } + + let private_bytes: [u8; 32] = BASE64_STANDARD + .decode(credential_secret.trim()) + .map_err(|_| "credential_secret must be base64".to_string())? + .try_into() + .map_err(|_| "credential_secret must contain 32 bytes".to_string())?; + let private = StaticSecret::from(private_bytes); + let grant = CredentialGrant::new(groups, allow_relay, allowed_proxy_cidrs, reusable) + .map_err(|error| error.to_string())?; + let entry = CredentialEntry { + pubkey: BASE64_STANDARD.encode(PublicKey::from(&private).as_bytes()), + secret: BASE64_STANDARD.encode(private.as_bytes()), + grant, + expiry_unix, + created_at_unix: current_unix_timestamp(), + }; + + self.ensure_storage_available() + .map_err(|error| error.to_string())?; + let mut state = self.state.lock().unwrap(); + if Self::managed_contains_id(&state, &credential_id) { + return Err(format!( + "credential_id {credential_id} is managed by configuration" + )); + } + if state + .base + .iter() + .chain(Self::managed_entries(&state)) + .any(|(existing_id, existing)| { + existing_id != &credential_id && existing.pubkey == entry.pubkey + }) + { + return Err("credential_secret is already used by another credential_id".to_string()); + } + if state + .ephemeral + .values() + .any(|existing| existing.pubkey == entry.pubkey) + { + return Err("credential public key is already registered".to_owned()); + } + let changed = state.base.get(&credential_id).is_none_or(|existing| { + existing.secret != entry.secret + || existing.pubkey != entry.pubkey + || existing.grant != entry.grant + || existing.expiry_unix != entry.expiry_unix + }); + if !changed { + return Ok(false); + } + + let mut updated = state.base.clone(); + updated.insert(credential_id, entry); + self.store_base(&updated) + .map_err(|error| format!("failed to store credentials: {error}"))?; + state.base = updated; + Ok(true) + } + + pub fn remove_expired_credentials(&self) -> bool { + self.remove_expired_credentials_at(current_unix_timestamp()) + } + + fn remove_expired_credentials_at(&self, now: i64) -> bool { + let mut state = self.state.lock().unwrap(); + let mut updated = state.base.clone(); + updated.retain(|_, entry| entry.is_active_at(now)); + if updated == state.base { + return false; + } + if let Err(error) = self.store_base(&updated) { + tracing::warn!(?error, "failed to remove expired credentials"); + return false; + } + state.base = updated; + true + } + + pub fn get_trusted_pubkeys(&self, network_secret: &str) -> Vec { + let now = current_unix_timestamp(); + let to_proof = |entry: &CredentialEntry| { + entry.to_trusted_credential().map(|credential| { + TrustedCredentialPubkeyProof::new_signed(credential, network_secret) + }) + }; + let state = self.state.lock().unwrap(); + let mut trusted = state + .base + .values() + .chain(state.managed.values()) + .filter(|entry| entry.is_active_at(now)) + .filter_map(to_proof) + .collect::>(); + trusted.extend(state.ephemeral.values().filter_map(to_proof)); + trusted + } + + pub fn is_pubkey_trusted(&self, pubkey: &[u8]) -> bool { + let now = current_unix_timestamp(); + let encoded = BASE64_STANDARD.encode(pubkey); + let state = self.state.lock().unwrap(); + state + .base + .values() + .chain(state.managed.values()) + .any(|entry| entry.pubkey == encoded && entry.is_active_at(now)) + || state + .ephemeral + .values() + .any(|entry| entry.pubkey == encoded) + } + + pub fn list_credentials(&self) -> Vec { + let now = current_unix_timestamp(); + + let state = self.state.lock().unwrap(); + let mut credentials = state + .base + .iter() + .chain(state.managed.iter()) + .filter(|(_, entry)| entry.is_active_at(now)) + .map(|(id, entry)| entry.to_credential_info(id)) + .collect::>(); + credentials.sort_unstable_by(|left, right| left.credential_id.cmp(&right.credential_id)); + credentials + } + + pub fn install_initial_managed_credentials( + &self, + credentials: &[ManagedCredentialConfig], + ) -> Result<(), String> { + self.ensure_storage_available() + .map_err(|error| error.to_string())?; + let replacement = Self::build_managed_entries(credentials)?; + let mut state = self.state.lock().unwrap(); + Self::validate_managed_conflicts(&state, &replacement)?; + state.managed = replacement; + Ok(()) + } + + /// Fallible checks for a managed credential replacement (secret parsing, + /// duplicate IDs/keys, conflicts with base/ephemeral credentials). Must + /// run before the candidate is persisted so a rejected patch never + /// reaches disk. + #[cfg(feature = "web-client")] + pub fn validate_managed_credentials( + &self, + credentials: &[ManagedCredentialConfig], + ) -> Result, String> { + let replacement = Self::build_managed_entries(credentials)?; + let mut state = self.state.lock().unwrap(); + if state.pending_managed.is_some() { + return Err("managed credential replacement is already pending".to_owned()); + } + Self::validate_managed_conflicts(&state, &replacement)?; + let changed = state.managed != replacement; + if changed { + state.pending_managed = Some(replacement); + } + Ok(ManagedCredentialReplacement { + manager: self, + changed, + installed: false, + }) + } + + /// Installs a replacement whose IDs and public keys were reserved by + /// [`Self::validate_managed_credentials`]. + #[cfg(feature = "web-client")] + pub fn install_managed_credentials(mut replacement: ManagedCredentialReplacement<'_>) -> bool { + if !replacement.changed { + return false; + } + let mut state = replacement.manager.state.lock().unwrap(); + state.managed = state + .pending_managed + .take() + .expect("validated managed credential replacement must remain reserved"); + replacement.installed = true; + true + } + + fn managed_contains_id(state: &CredentialState, credential_id: &str) -> bool { + state.managed.contains_key(credential_id) + || state + .pending_managed + .as_ref() + .is_some_and(|pending| pending.contains_key(credential_id)) + } + + fn managed_entries( + state: &CredentialState, + ) -> impl Iterator { + state.managed.iter().chain( + state + .pending_managed + .iter() + .flat_map(|pending| pending.iter()), + ) + } + + fn managed_values(state: &CredentialState) -> impl Iterator { + Self::managed_entries(state).map(|(_, entry)| entry) + } + + fn build_managed_entries( + credentials: &[ManagedCredentialConfig], + ) -> Result, String> { + let mut entries = HashMap::with_capacity(credentials.len()); + let mut public_keys = HashSet::with_capacity(credentials.len()); + for credential in credentials { + let credential_id = credential.credential_id.trim().to_owned(); + if credential_id.is_empty() { + return Err("credential_id must not be empty".to_owned()); + } + let entry = CredentialEntry::from_managed(credential)?; + if !public_keys.insert(entry.pubkey.clone()) { + return Err("credential_secret is assigned to multiple credential IDs".to_owned()); + } + if entries.insert(credential_id.clone(), entry).is_some() { + return Err(format!("duplicate managed credential_id: {credential_id}")); + } + } + Ok(entries) + } + + fn validate_managed_conflicts( + state: &CredentialState, + replacement: &HashMap, + ) -> Result<(), String> { + if let Some(credential_id) = replacement.keys().find(|id| state.base.contains_key(*id)) { + return Err(format!( + "credential_id {credential_id} is already owned by the credential file" + )); + } + if replacement.values().any(|entry| { + state + .base + .values() + .chain(state.ephemeral.values()) + .any(|existing| existing.pubkey == entry.pubkey) + }) { + return Err("credential public key is already registered".to_owned()); + } + Ok(()) + } + + fn decode_pubkey_b64(s: &str) -> Option> { + let decoded = BASE64_STANDARD.decode(s).ok()?; + if decoded.len() != 32 { + return None; + } + Some(decoded) + } + + fn public_key_fingerprint(pubkey: &str) -> Option { + let decoded = Self::decode_pubkey_b64(pubkey)?; + Some( + Sha256::digest(decoded) + .iter() + .map(|byte| format!("{byte:02x}")) + .collect(), + ) + } + + fn ensure_storage_available(&self) -> anyhow::Result<()> { + if let Some(error) = &self.storage_load_error { + anyhow::bail!("credential storage is unavailable: {error}"); + } + Ok(()) + } + + fn store_base(&self, base: &HashMap) -> anyhow::Result<()> { + self.ensure_storage_available()?; + let Some(storage) = &self.storage else { + return Ok(()); + }; + storage.store(&serde_json::to_string_pretty(base)?) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn managed_credential( + credential_id: &str, + secret_byte: u8, + expiry_unix: i64, + ) -> ManagedCredentialConfig { + ManagedCredentialConfig { + credential_id: credential_id.to_owned(), + credential_secret: BASE64_STANDARD.encode([secret_byte; 32]), + groups: vec!["ops".to_owned()], + allow_relay: false, + allowed_proxy_cidrs: vec!["10.0.0.0/24".to_owned()], + expiry_unix, + reusable: true, + } + } + + #[test] + fn managed_credential_trims_allowed_proxy_cidrs() { + let mut credential = managed_credential("managed", 1, i64::MAX); + credential.allowed_proxy_cidrs = vec![" 10.0.0.0/24 ".to_owned()]; + + let entry = CredentialEntry::from_managed(&credential).unwrap(); + + assert_eq!(entry.grant.allowed_proxy_cidrs, ["10.0.0.0/24"]); + } + + #[test] + fn generated_and_imported_credentials_normalize_allowed_proxy_cidrs() { + let source = CredentialManager::new(); + let generated = source + .generate_credential_with_options(CredentialCreateOptions { + groups: Vec::new(), + allow_relay: false, + allowed_proxy_cidrs: vec![" 10.0.0.0/24 ".to_owned()], + ttl: Duration::from_secs(3600), + credential_id: None, + reusable: true, + }) + .unwrap(); + assert_eq!( + source.list_credentials()[0].allowed_proxy_cidrs, + ["10.0.0.0/24"] + ); + + let target = CredentialManager::new(); + target + .upsert_credential(CredentialUpsertOptions { + credential_id: "imported".to_owned(), + credential_secret: generated.secret, + groups: Vec::new(), + allow_relay: false, + allowed_proxy_cidrs: vec![" 192.168.0.0/16 ".to_owned()], + expiry_unix: generated.expiry_unix, + reusable: true, + }) + .unwrap(); + assert_eq!( + target.list_credentials()[0].allowed_proxy_cidrs, + ["192.168.0.0/16"] + ); + } + + impl CredentialManager { + pub(crate) fn generate_credential( + &self, + groups: Vec, + allow_relay: bool, + allowed_proxy_cidrs: Vec, + ttl: Duration, + ) -> GeneratedCredential { + self.generate_credential_with_options(CredentialCreateOptions { + groups, + allow_relay, + allowed_proxy_cidrs, + ttl, + credential_id: None, + reusable: true, + }) + .unwrap() + } + + fn generate_credential_with_id( + &self, + groups: Vec, + allow_relay: bool, + allowed_proxy_cidrs: Vec, + ttl: Duration, + credential_id: Option, + ) -> GeneratedCredential { + self.generate_credential_with_options(CredentialCreateOptions { + groups, + allow_relay, + allowed_proxy_cidrs, + ttl, + credential_id, + reusable: true, + }) + .unwrap() + } + } + + #[derive(Default)] + struct MemoryCredentialStorage { + serialized: Mutex>, + } + + impl CredentialStorage for MemoryCredentialStorage { + fn load(&self) -> anyhow::Result> { + Ok(self.serialized.lock().unwrap().clone()) + } + + fn store(&self, serialized_credentials: &str) -> anyhow::Result<()> { + *self.serialized.lock().unwrap() = Some(serialized_credentials.to_owned()); + Ok(()) + } + } + + fn credential_storage_with_proxy_cidr( + allowed_proxy_cidr: &str, + ) -> (Arc, String) { + let storage = Arc::new(MemoryCredentialStorage::default()); + let manager = CredentialManager::from_storage(storage.clone()); + let generated = manager.generate_credential( + Vec::new(), + false, + vec!["10.0.0.0/24".to_owned()], + Duration::from_secs(3600), + ); + let serialized = storage.serialized.lock().unwrap().clone().unwrap(); + let mut snapshot: serde_json::Value = serde_json::from_str(&serialized).unwrap(); + snapshot[&generated.credential_id]["allowed_proxy_cidrs"][0] = allowed_proxy_cidr.into(); + *storage.serialized.lock().unwrap() = Some(serde_json::to_string(&snapshot).unwrap()); + (storage, generated.credential_id) + } + + struct FailOnceCredentialStorage { + serialized: Mutex>, + fail_next_store: Mutex, + } + + impl Default for FailOnceCredentialStorage { + fn default() -> Self { + Self { + serialized: Mutex::new(None), + fail_next_store: Mutex::new(true), + } + } + } + + impl CredentialStorage for FailOnceCredentialStorage { + fn load(&self) -> anyhow::Result> { + Ok(self.serialized.lock().unwrap().clone()) + } + + fn store(&self, serialized_credentials: &str) -> anyhow::Result<()> { + let mut fail_next_store = self.fail_next_store.lock().unwrap(); + if *fail_next_store { + *fail_next_store = false; + anyhow::bail!("injected credential storage failure"); + } + *self.serialized.lock().unwrap() = Some(serialized_credentials.to_owned()); + Ok(()) + } + } + + #[test] + fn generate_and_revoke_credential() { + let mgr = CredentialManager::new(); + let generated = mgr.generate_credential( + vec!["guest".to_string()], + false, + vec![], + Duration::from_secs(3600), + ); + + assert!(!generated.credential_id.is_empty()); + assert!(!generated.secret.is_empty()); + assert!(generated.expiry_unix > current_unix_timestamp()); + assert!(generated.changed); + assert!(uuid::Uuid::parse_str(&generated.credential_id).is_ok()); + + let privkey_bytes: [u8; 32] = BASE64_STANDARD + .decode(&generated.secret) + .unwrap() + .try_into() + .unwrap(); + let private = StaticSecret::from(privkey_bytes); + let pubkey_bytes = PublicKey::from(&private).as_bytes().to_vec(); + assert!(mgr.is_pubkey_trusted(&pubkey_bytes)); + + let trusted = mgr.get_trusted_pubkeys("sec"); + assert_eq!(trusted.len(), 1); + assert_eq!( + trusted[0].credential.as_ref().unwrap().groups, + vec!["guest".to_string()] + ); + assert_eq!(trusted[0].credential.as_ref().unwrap().reusable, Some(true)); + + assert!(mgr.revoke_credential(&generated.credential_id).unwrap()); + assert!(!mgr.is_pubkey_trusted(&pubkey_bytes)); + assert!(mgr.get_trusted_pubkeys("sec").is_empty()); + } + + #[test] + fn fixed_id_reuses_existing_secret() { + let mgr = CredentialManager::new(); + let fixed_id = "fixed-credential-id".to_string(); + let first = mgr.generate_credential_with_id( + vec!["group-a".to_string()], + false, + vec!["10.0.0.0/24".to_string()], + Duration::from_secs(3600), + Some(fixed_id.clone()), + ); + let second = mgr.generate_credential_with_id( + vec!["group-b".to_string()], + true, + vec!["192.168.0.0/16".to_string()], + Duration::from_secs(7200), + Some(fixed_id.clone()), + ); + + assert_eq!(first.credential_id, fixed_id); + assert_eq!(second.credential_id, fixed_id); + assert_eq!(first.secret, second.secret); + assert!(first.changed); + assert!(!second.changed); + + let list = mgr.list_credentials(); + assert_eq!(list.len(), 1); + assert_eq!(list[0].credential_id, fixed_id); + assert_eq!(list[0].groups, vec!["group-a".to_string()]); + assert!(!list[0].allow_relay); + assert_eq!(list[0].allowed_proxy_cidrs, vec!["10.0.0.0/24".to_string()]); + assert_eq!(list[0].reusable, Some(true)); + assert_eq!(list[0].public_key_fingerprint.len(), 64); + } + + #[test] + fn upsert_credential_preserves_key_attributes_and_storage() { + let source = CredentialManager::new(); + let generated = source + .generate_credential_with_options(CredentialCreateOptions { + groups: vec!["users".to_string()], + allow_relay: false, + allowed_proxy_cidrs: vec!["10.0.0.0/8".to_string()], + ttl: Duration::from_secs(3600), + credential_id: Some("shared-id".to_string()), + reusable: false, + }) + .unwrap(); + let source_info = source.list_credentials().remove(0); + let options = CredentialUpsertOptions { + credential_id: generated.credential_id, + credential_secret: generated.secret, + groups: source_info.groups.clone(), + allow_relay: source_info.allow_relay, + allowed_proxy_cidrs: source_info.allowed_proxy_cidrs.clone(), + expiry_unix: source_info.expiry_unix, + reusable: source_info.reusable.unwrap(), + }; + + let storage = Arc::new(MemoryCredentialStorage::default()); + let target = CredentialManager::from_storage(storage.clone()); + assert!(target.upsert_credential(options.clone()).unwrap()); + assert!(!target.upsert_credential(options).unwrap()); + assert_eq!(target.list_credentials(), vec![source_info.clone()]); + assert_eq!( + CredentialManager::from_storage(storage).list_credentials(), + vec![source_info] + ); + } + + #[test] + fn upsert_credential_can_retry_after_storage_failure() { + let source = CredentialManager::new(); + let generated = + source.generate_credential(vec![], false, vec![], Duration::from_secs(3600)); + let options = CredentialUpsertOptions { + credential_id: generated.credential_id, + credential_secret: generated.secret, + groups: vec!["users".to_string()], + allow_relay: false, + allowed_proxy_cidrs: vec![], + expiry_unix: generated.expiry_unix, + reusable: true, + }; + + let storage = Arc::new(FailOnceCredentialStorage::default()); + let target = CredentialManager::from_storage(storage.clone()); + assert!(target.upsert_credential(options.clone()).is_err()); + assert!(target.list_credentials().is_empty()); + + assert!(target.upsert_credential(options).unwrap()); + assert_eq!(target.list_credentials().len(), 1); + assert_eq!( + CredentialManager::from_storage(storage) + .list_credentials() + .len(), + 1 + ); + } + + #[test] + fn upsert_credential_rejects_public_key_assigned_to_another_id() { + let source = CredentialManager::new(); + let generated = + source.generate_credential(vec![], false, vec![], Duration::from_secs(3600)); + let options = CredentialUpsertOptions { + credential_id: "original-id".to_string(), + credential_secret: generated.secret, + groups: vec!["users".to_string()], + allow_relay: false, + allowed_proxy_cidrs: vec![], + expiry_unix: generated.expiry_unix, + reusable: true, + }; + + let target = CredentialManager::new(); + assert!(target.upsert_credential(options.clone()).unwrap()); + + let duplicate = CredentialUpsertOptions { + credential_id: "duplicate-id".to_string(), + groups: vec!["admins".to_string()], + ..options + }; + assert_eq!( + target.upsert_credential(duplicate).unwrap_err(), + "credential_secret is already used by another credential_id" + ); + + let credentials = target.list_credentials(); + assert_eq!(credentials.len(), 1); + assert_eq!(credentials[0].credential_id, "original-id"); + assert_eq!(credentials[0].groups, vec!["users".to_string()]); + } + + #[test] + fn expired_credentials_are_filtered() { + let mgr = CredentialManager::new(); + mgr.generate_credential(vec![], false, vec![], Duration::from_secs(3600)); + mgr.generate_credential(vec![], false, vec![], Duration::from_secs(0)); + + assert_eq!(mgr.list_credentials().len(), 1); + assert!(mgr.remove_expired_credentials()); + assert_eq!(mgr.list_credentials().len(), 1); + } + + #[test] + fn injected_storage_loads_and_persists_mutations() { + let storage = Arc::new(MemoryCredentialStorage::default()); + let manager = CredentialManager::from_storage(storage.clone()); + let generated = + manager.generate_credential(vec![], false, vec![], Duration::from_secs(3600)); + + let reloaded = CredentialManager::from_storage(storage.clone()); + assert_eq!( + reloaded.list_credentials()[0].credential_id, + generated.credential_id + ); + + assert!(manager.revoke_credential(&generated.credential_id).unwrap()); + let reloaded = CredentialManager::from_storage(storage); + assert!(reloaded.list_credentials().is_empty()); + } + + #[test] + fn stored_credentials_normalize_allowed_proxy_cidrs_on_load() { + let (storage, credential_id) = credential_storage_with_proxy_cidr(" 10.0.0.0/24 "); + + let manager = CredentialManager::from_storage(storage); + + assert_eq!(manager.list_credentials()[0].credential_id, credential_id); + assert_eq!( + manager.list_credentials()[0].allowed_proxy_cidrs, + ["10.0.0.0/24"] + ); + } + + #[test] + fn stored_credentials_with_invalid_proxy_cidr_fail_closed() { + let (storage, credential_id) = credential_storage_with_proxy_cidr("not-a-cidr"); + + let manager = CredentialManager::from_storage(storage); + + assert!(manager.list_credentials().is_empty()); + let error = manager + .install_initial_managed_credentials(&[]) + .unwrap_err(); + assert!(error.contains(&credential_id), "{error}"); + assert!(error.contains("invalid allowed_proxy_cidr"), "{error}"); + } + + #[test] + fn credential_storage_schema_remains_flat() { + let storage = Arc::new(MemoryCredentialStorage::default()); + let manager = CredentialManager::from_storage(storage.clone()); + manager.generate_credential( + vec!["ops".to_owned()], + true, + vec!["10.0.0.0/24".to_owned()], + Duration::from_secs(3600), + ); + + let serialized = storage.serialized.lock().unwrap().clone().unwrap(); + let mut snapshot: serde_json::Value = serde_json::from_str(&serialized).unwrap(); + let entry = snapshot.as_object().unwrap().values().next().unwrap(); + + assert!(entry.get("grant").is_none()); + assert_eq!(entry["groups"][0], "ops"); + assert_eq!(entry["allowed_proxy_cidrs"][0], "10.0.0.0/24"); + assert_eq!(entry["allow_relay"], true); + assert_eq!(entry["reusable"], true); + + snapshot + .as_object_mut() + .unwrap() + .values_mut() + .next() + .unwrap() + .as_object_mut() + .unwrap() + .remove("reusable"); + let legacy: HashMap = serde_json::from_value(snapshot).unwrap(); + assert!(legacy.values().next().unwrap().grant.reusable); + } + + #[test] + fn malformed_storage_is_fail_closed() { + let storage = Arc::new(MemoryCredentialStorage { + serialized: Mutex::new(Some("not json".to_owned())), + }); + + let manager = CredentialManager::from_storage(storage); + + assert!(manager.list_credentials().is_empty()); + assert!(manager.install_initial_managed_credentials(&[]).is_err()); + } + + #[test] + fn ephemeral_credentials_are_trusted_but_not_persisted_or_listed() { + let storage = Arc::new(MemoryCredentialStorage::default()); + let manager = CredentialManager::from_storage(storage.clone()); + let private = StaticSecret::from([7u8; 32]); + let public = *PublicKey::from(&private).as_bytes(); + + let credential_id = manager + .register_ephemeral_credential(public, vec!["ops".to_owned()]) + .unwrap(); + + assert!(manager.is_pubkey_trusted(&public)); + let trusted = manager.get_trusted_pubkeys("network-secret"); + assert_eq!(trusted.len(), 1); + let credential = trusted[0].credential.as_ref().unwrap(); + assert_eq!(credential.pubkey, public); + assert_eq!(credential.groups, ["ops"]); + assert!(!credential.allow_relay); + assert!(credential.allowed_proxy_cidrs.is_empty()); + assert_eq!(credential.reusable, Some(false)); + assert!(manager.list_credentials().is_empty()); + assert!(storage.serialized.lock().unwrap().is_none()); + + assert!(manager.revoke_ephemeral_credential(credential_id)); + assert!(!manager.is_pubkey_trusted(&public)); + assert!(manager.get_trusted_pubkeys("network-secret").is_empty()); + assert!(storage.serialized.lock().unwrap().is_none()); + } + + #[cfg(feature = "web-client")] + #[test] + fn managed_credentials_work_without_base_storage_and_expire_in_place() { + let manager = CredentialManager::new(); + let active = managed_credential("active", 1, current_unix_timestamp() + 60); + let expired = managed_credential("expired", 2, current_unix_timestamp() - 1); + + manager + .install_initial_managed_credentials(&[active.clone(), expired]) + .unwrap(); + + assert_eq!(manager.list_credentials().len(), 1); + assert_eq!(manager.list_credentials()[0].credential_id, "active"); + let private_bytes: [u8; 32] = BASE64_STANDARD + .decode(active.credential_secret) + .unwrap() + .try_into() + .unwrap(); + let public = PublicKey::from(&StaticSecret::from(private_bytes)); + assert!(manager.is_pubkey_trusted(public.as_bytes())); + + let replacement = manager.validate_managed_credentials(&[]).unwrap(); + assert!(replacement.changed); + assert!(CredentialManager::install_managed_credentials(replacement)); + assert!(manager.list_credentials().is_empty()); + } + + #[cfg(feature = "web-client")] + #[test] + fn pending_managed_replacement_reserves_ids_and_public_keys() { + let manager = CredentialManager::new(); + let pending = managed_credential("pending", 5, current_unix_timestamp() + 60); + let private_bytes: [u8; 32] = BASE64_STANDARD + .decode(&pending.credential_secret) + .unwrap() + .try_into() + .unwrap(); + let public = PublicKey::from(&StaticSecret::from(private_bytes)); + + let replacement = manager + .validate_managed_credentials(std::slice::from_ref(&pending)) + .unwrap(); + + let error = manager + .generate_credential_with_options(CredentialCreateOptions { + groups: Vec::new(), + allow_relay: false, + allowed_proxy_cidrs: Vec::new(), + ttl: Duration::from_secs(60), + credential_id: Some("pending".to_owned()), + reusable: true, + }) + .unwrap_err(); + assert!(error.contains("managed by configuration")); + assert!( + manager + .register_ephemeral_credential(*public.as_bytes(), Vec::new()) + .is_err() + ); + assert!(!manager.is_pubkey_trusted(public.as_bytes())); + + drop(replacement); + assert!( + manager + .register_ephemeral_credential(*public.as_bytes(), Vec::new()) + .is_ok() + ); + } + + #[cfg(feature = "web-client")] + #[test] + fn managed_and_base_credentials_must_be_disjoint() { + let manager = CredentialManager::new(); + manager + .install_initial_managed_credentials(&[managed_credential( + "managed", + 3, + current_unix_timestamp() + 60, + )]) + .unwrap(); + + let error = manager + .generate_credential_with_options(CredentialCreateOptions { + groups: Vec::new(), + allow_relay: false, + allowed_proxy_cidrs: Vec::new(), + ttl: Duration::from_secs(60), + credential_id: Some("managed".to_owned()), + reusable: true, + }) + .unwrap_err(); + assert!(error.contains("managed by configuration")); + + let generated = + manager.generate_credential(Vec::new(), false, Vec::new(), Duration::from_secs(60)); + let conflicting = ManagedCredentialConfig { + credential_id: "other".to_owned(), + credential_secret: generated.secret, + ..managed_credential("other", 4, current_unix_timestamp() + 60) + }; + let error = manager + .validate_managed_credentials(&[conflicting]) + .err() + .unwrap(); + assert_eq!(error, "credential public key is already registered"); + // The rejected replacement must not have touched existing state. + assert!( + manager + .list_credentials() + .iter() + .any(|info| info.credential_id == "managed") + ); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/error.rs b/vendor/easytier/easytier-core/src/peers/error.rs new file mode 100644 index 0000000..8209e7f --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/error.rs @@ -0,0 +1,31 @@ +use crate::{config::PeerId, tunnel::TunnelError}; + +#[derive(Debug, thiserror::Error)] +pub enum Error { + #[error("wait response error: {0}")] + WaitRespError(String), + #[error("secret key error: {0}")] + SecretKeyError(String), + #[error("peer has no connection: {0}")] + PeerNoConnectionError(PeerId), + #[error("route error: {0:?}")] + RouteError(Option), + #[error("not found")] + NotFound, + #[error(transparent)] + Tunnel(#[from] TunnelError), + #[error(transparent)] + Other(#[from] anyhow::Error), +} + +impl From for Error { + fn from(value: snow::Error) -> Self { + Self::WaitRespError(value.to_string()) + } +} + +impl From for Error { + fn from(value: crate::foundation::time::error::Elapsed) -> Self { + Self::WaitRespError(value.to_string()) + } +} diff --git a/vendor/easytier/easytier-core/src/peers/foreign_network/client.rs b/vendor/easytier/easytier-core/src/peers/foreign_network/client.rs new file mode 100644 index 0000000..e5238c9 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/foreign_network/client.rs @@ -0,0 +1,103 @@ +use std::sync::{Arc, Mutex}; + +use tokio_util::task::AbortOnDropHandle; + +use crate::{config::PeerId, packet::ZCPacket}; + +use crate::peers::{ + PacketRecvChan, + conn::{peer_conn::PeerConn, peer_map::PeerMap}, + context::ArcPeerContext, + error::Error, +}; + +pub struct ForeignNetworkClient { + peer_map: Arc, + task: Mutex>>, +} + +impl ForeignNetworkClient { + pub(crate) fn new( + context: ArcPeerContext, + packet_sender_to_mgr: PacketRecvChan, + my_peer_id: PeerId, + ) -> Self { + let peer_map = Arc::new(PeerMap::new( + packet_sender_to_mgr, + context.clone(), + my_peer_id, + )); + Self { + peer_map, + task: Mutex::new(None), + } + } + + pub async fn add_new_peer_conn(&self, peer_conn: PeerConn) -> Result<(), Error> { + tracing::warn!(peer_conn = ?peer_conn.get_conn_info(), network = ?peer_conn.get_network_identity(), "add new peer conn in foreign network client"); + self.peer_map.add_new_peer_conn(peer_conn).await + } + + pub fn is_client_url_alive(&self, url: &url::Url) -> bool { + self.peer_map.is_client_url_alive(url) + } + + pub fn has_next_hop(&self, peer_id: PeerId) -> bool { + self.get_next_hop(peer_id).is_some() + } + + pub async fn list_public_peers(&self) -> Vec { + self.peer_map.list_peers() + } + + pub fn get_next_hop(&self, peer_id: PeerId) -> Option { + if self.peer_map.has_peer(peer_id) { + return Some(peer_id); + } + None + } + + pub async fn send_msg(&self, msg: ZCPacket, peer_id: PeerId) -> Result<(), Error> { + if let Some(next_hop) = self.get_next_hop(peer_id) { + let ret = self.peer_map.send_msg_directly(msg, next_hop).await; + if ret.is_err() { + tracing::error!( + ?ret, + ?peer_id, + ?next_hop, + "foreign network client send msg failed" + ); + } else { + tracing::info!( + ?peer_id, + ?next_hop, + "foreign network client send msg success" + ); + } + return ret; + } + Err(Error::RouteError(Some("no next hop".to_string()))) + } + + pub async fn run(&self) { + let peer_map = Arc::downgrade(&self.peer_map); + *self.task.lock().unwrap() = Some(AbortOnDropHandle::new(tokio::spawn(async move { + loop { + crate::foundation::time::sleep(crate::foundation::time::Duration::from_secs(1)) + .await; + let Some(peer_map) = peer_map.upgrade() else { + break; + }; + peer_map.clean_peer_without_conn().await; + } + }))); + } + + pub(crate) fn stop(&self) { + self.task.lock().unwrap().take(); + } + + pub fn get_peer_map(&self) -> Arc { + self.peer_map.clone() + } +} diff --git a/vendor/easytier/easytier-core/src/peers/foreign_network/mod.rs b/vendor/easytier/easytier-core/src/peers/foreign_network/mod.rs new file mode 100644 index 0000000..f3f790c --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/foreign_network/mod.rs @@ -0,0 +1,2000 @@ +//! Foreign network management: the manager owning foreign-network entries +//! and the client connecting to foreign networks. + +pub(crate) mod client; + +use std::sync::atomic::{AtomicBool, Ordering}; +use std::{ + future, + sync::{Arc, Weak}, + time::SystemTime, +}; + +use dashmap::{DashMap, DashSet}; +use easytier_proto::common::FlagsInConfig; +use guarden::defer; +use tokio::sync::{ + Mutex, RwLock, RwLockReadGuard, + mpsc::{self, UnboundedReceiver, UnboundedSender}, +}; +use tokio::task::JoinSet; + +use crate::{ + config::peers::{PeerRuntimeConfig, PeerRuntimeSnapshot}, + config::runtime::{CoreRuntimeConfig, CoreRuntimeConfigStore}, + config::{CoreConfig, NodeConfig, PeerId}, + foundation::{ + stats::{CounterHandle, LabelSet, LabelType, MetricName, StatsManager}, + task::reap_joinset_background, + token_bucket::ArcByteLimiter, + }, + packet::{PacketType, ZCPacket}, + peers::peer_center::instance::{PeerCenterInstance, PeerCenterPeerManagerTrait}, + peers::{PacketRecvChan, PacketRecvChanReceiver, recv_packet_from_chan}, + proto::core_peer::peer::{PeerConnInfo, Route as CoreRoute}, + socket::SocketContext, +}; + +use super::{ + conn::{ + peer_conn::{PeerConn, PeerConnId}, + peer_map::{PeerMap, direct_peer_info}, + peer_session::PeerSessionStore, + }, + context::{ + ArcPeerContext, CorePeerContext, CorePeerContextAdapters, NetworkIdentity, PeerContext, + PeerContextEvent, PeerStunInfoSource, TrustedKeySource, + }, + error::Error, + peer_rpc::{PeerRpcManager, PeerRpcManagerTransport}, + public_ipv6::{DisabledPublicIpv6Runtime, PublicIpv6Runtime}, + relay_peer_map::RelayPeerMap, + route::{NextHopPolicy, Route, RouteInterface, peer_ospf_route::PeerRoute}, + traffic_metrics::{ + TrafficKind, TrafficMetricRecorder, data_packet_payload_len, is_relay_data_packet_type, + traffic_kind, + }, + util::shrink_dashmap, + whitelist::check_network_in_relay_whitelist, +}; +use crate::proto::peer_rpc::{PeerIdentityType, PeerInfoForGlobalMap}; + +pub const PUBLIC_SERVER_HOSTNAME_PREFIX: &str = "PublicServer_"; + +pub(crate) fn desired_foreign_avoid_relay_data( + parent_context: &ArcPeerContext, + relay_data: bool, +) -> bool { + !relay_data || parent_context.feature_flags().avoid_relay_data +} + +pub(crate) fn sync_foreign_avoid_relay_data( + parent_context: &ArcPeerContext, + foreign_context: &ArcPeerContext, + relay_data: bool, +) -> bool { + let desired = desired_foreign_avoid_relay_data(parent_context, relay_data); + if foreign_context.feature_flags().avoid_relay_data == desired { + return false; + } + foreign_context.set_avoid_relay_data_preference(desired) +} + +fn build_foreign_peer_context( + network: &NetworkIdentity, + parent_context: &Arc, + relay_data: bool, + mut flags: FlagsInConfig, +) -> Arc { + let parent_context_dyn: ArcPeerContext = parent_context.clone(); + let parent_flags = parent_context_dyn.flags(); + flags.disable_relay_kcp = !parent_flags.enable_relay_foreign_network_kcp; + flags.disable_relay_quic = !parent_flags.enable_relay_foreign_network_quic; + flags.socket_mark = parent_flags.socket_mark; + + let mut feature_flags = parent_context_dyn.feature_flags(); + feature_flags.is_public_server = true; + feature_flags.avoid_relay_data = + desired_foreign_avoid_relay_data(&parent_context_dyn, relay_data); + + let instance_id = uuid::Uuid::new_v4(); + let runtime = PeerRuntimeConfig { + core: CoreConfig { + node: NodeConfig { + instance_id: Some(*instance_id.as_bytes()), + hostname: Some(format!( + "{PUBLIC_SERVER_HOSTNAME_PREFIX}{}", + parent_context_dyn.hostname() + )), + network_name: network.network_name.clone(), + ..Default::default() + }, + ..Default::default() + }, + network_identity: network.clone(), + stun_info: parent_context_dyn.stun_info(), + feature_flags, + secure_mode: parent_context_dyn.secure_mode(), + host_routing: parent_context_dyn.host_routing_policy(), + }; + let mut snapshot = PeerRuntimeSnapshot::new(runtime, flags); + snapshot.easytier_version = parent_context_dyn.easytier_version(); + snapshot.ospf_update_my_foreign_network_interval_sec = + parent_context_dyn.ospf_update_my_foreign_network_interval_sec(); + snapshot.max_direct_conns_per_peer_in_foreign_network = + parent_context_dyn.max_direct_conns_per_peer_in_foreign_network(); + snapshot.hmac_secret_digest = parent_context_dyn.hmac_secret_digest(); + + Arc::new(CorePeerContext::new_foreign( + CoreRuntimeConfigStore::new(CoreRuntimeConfig::default(), Arc::new(snapshot)), + CorePeerContextAdapters { + stun_info_source: Some(Arc::new(ParentStunInfoSource(parent_context_dyn))), + events: Arc::new(()), + credential_storage: None, + }, + parent_context, + )) +} + +struct ParentStunInfoSource(ArcPeerContext); + +impl PeerStunInfoSource for ParentStunInfoSource { + fn stun_info(&self) -> crate::proto::common::StunInfo { + self.0.stun_info() + } +} + +/// Adapts a foreign network's peer map and RPC manager to the peer-center +/// trait so each foreign network runs its own peer-center instance. +pub struct PeerMapWithPeerRpcManager { + pub peer_map: Arc, + pub rpc_mgr: Arc, + pub network_name: String, +} + +#[async_trait::async_trait] +impl PeerCenterPeerManagerTrait for PeerMapWithPeerRpcManager { + async fn list_peers(&self) -> PeerInfoForGlobalMap { + // TODO: currently latency between public server cannot be calculated because one public-server pair + // has no connection between them. (hard to get latency from peer manager because it's hard to transform the peer id) + // but it's fine because we don't want too much traffic between public servers. + direct_peer_info(std::slice::from_ref(&self.peer_map)).await + } + + fn my_peer_id(&self) -> PeerId { + self.peer_map.my_peer_id() + } + + fn network_name(&self) -> String { + self.network_name.clone() + } + + fn get_rpc_mgr(&self) -> Weak { + Arc::downgrade(&self.rpc_mgr) + } + + async fn list_routes(&self) -> Vec { + self.peer_map.list_route_infos().await + } +} + +#[derive(Clone, Debug, Default)] +pub(crate) struct ForeignNetworkRouteInfo { + pub network_name: String, + pub peer_ids: Vec, + pub network_secret_digest: Vec, + pub my_peer_id_for_this_network: PeerId, +} + +struct ForeignNetworkRouteInterface { + my_peer_id: PeerId, + peer_map: Weak, + network_identity: NetworkIdentity, + global_peer_map: Weak, +} + +#[async_trait::async_trait] +impl RouteInterface for ForeignNetworkRouteInterface { + async fn list_peers(&self) -> Vec { + let Some(peer_map) = self.peer_map.upgrade() else { + return vec![]; + }; + + let mut global = if let Some(global_peer_map) = self.global_peer_map.upgrade() { + global_peer_map + .list_peers_own_foreign_network(&self.network_identity) + .await + } else { + vec![] + }; + let local = peer_map.list_peers_with_conn().await; + global.extend(local.iter().cloned()); + global + .into_iter() + .filter(|peer_id| *peer_id != self.my_peer_id) + .collect() + } + + fn my_peer_id(&self) -> PeerId { + self.my_peer_id + } + + fn need_periodic_requery_peers(&self) -> bool { + true + } + + async fn get_peer_identity_type(&self, peer_id: PeerId) -> Option { + let peer_map = self.peer_map.upgrade()?; + peer_map.get_peer_identity_type(peer_id) + } + + async fn get_peer_public_key(&self, peer_id: PeerId) -> Option> { + let peer_map = self.peer_map.upgrade()?; + peer_map.get_peer_public_key(peer_id) + } + + async fn close_peer(&self, peer_id: PeerId) { + if let Some(peer_map) = self.peer_map.upgrade() { + let _ = peer_map.close_peer(peer_id).await; + } + } +} + +struct RpcTransport { + my_peer_id: PeerId, + peer_map: Weak, + + packet_recv: Mutex>, +} + +#[async_trait::async_trait] +impl PeerRpcManagerTransport for RpcTransport { + fn my_peer_id(&self) -> PeerId { + self.my_peer_id + } + + async fn send(&self, msg: ZCPacket, dst_peer_id: PeerId) -> anyhow::Result<()> { + tracing::debug!( + "foreign network manager send rpc to peer: {:?}", + dst_peer_id + ); + let peer_map = self + .peer_map + .upgrade() + .ok_or(anyhow::anyhow!("peer map is gone"))?; + + // send to ourselves so we can handle it in forward logic. + peer_map.send_msg_directly(msg, self.my_peer_id).await?; + Ok(()) + } + + async fn recv(&self) -> anyhow::Result { + if let Some(packet) = self.packet_recv.lock().await.recv().await { + tracing::trace!("recv rpc packet in foreign network manager rpc transport"); + Ok(packet) + } else { + Err(anyhow::anyhow!("unknown data store error")) + } + } +} + +impl Drop for RpcTransport { + fn drop(&mut self) { + tracing::debug!( + "drop rpc transport for foreign network manager, my_peer_id: {:?}", + self.my_peer_id + ); + } +} + +#[derive(Clone, Debug)] +pub struct ForeignNetworkTrustedKeyInfo { + pub pubkey: Vec, + pub source: TrustedKeySource, + pub expiry_unix: Option, +} + +#[derive(Clone, Debug, Default)] +pub struct ForeignNetworkPeerInfo { + pub peer_id: PeerId, + pub conns: Vec, +} + +#[derive(Clone, Debug, Default)] +pub struct ForeignNetworkEntryInfo { + pub network_secret_digest: Vec, + pub my_peer_id_for_this_network: PeerId, + pub peers: Vec, + pub trusted_keys: Vec, +} + +#[auto_impl::auto_impl(&, Arc)] +pub(crate) trait ForeignNetworkRpcRegistrar: Send + Sync + 'static { + fn register_peer_rpc_services( + &self, + _peer_rpc: &Arc, + _network_name: &str, + _socket_context: SocketContext, + ) { + } +} + +impl ForeignNetworkRpcRegistrar for () {} + +async fn abort_and_join_persistent_tasks(tasks: &std::sync::Mutex>) { + tasks.lock().unwrap().abort_all(); + future::poll_fn(|cx| { + let mut tasks = tasks.lock().unwrap(); + loop { + match tasks.poll_join_next(cx) { + std::task::Poll::Ready(Some(_)) => continue, + std::task::Poll::Ready(None) => return std::task::Poll::Ready(()), + std::task::Poll::Pending => return std::task::Poll::Pending, + } + } + }) + .await; +} + +struct ForeignNetworkEntry { + my_peer_id: PeerId, + + parent_context: ArcPeerContext, + peer_context: Arc, + network: NetworkIdentity, + peer_map: Arc, + relay_peer_map: Arc, + relay_data: bool, + pm_packet_sender: Mutex>, + + peer_rpc: Arc, + rpc_sender: UnboundedSender, + + packet_recv: Mutex>, + + bps_limiter: Option, + + peer_center: Arc, + + traffic_metrics: Arc, + event_handler_started: AtomicBool, + indexed_peers: DashSet, + + tasks: Mutex>, + + lock: Mutex<()>, +} + +impl ForeignNetworkEntry { + #[allow(clippy::too_many_arguments)] + fn new( + network: NetworkIdentity, + my_peer_id: PeerId, + rpc_registrar: Arc, + parent_context: Arc, + foreign_context_default_flags: FlagsInConfig, + relay_data: bool, + peer_session_store: Arc, + pm_packet_sender: PacketRecvChan, + ) -> Self { + let parent_context_dyn: ArcPeerContext = parent_context.clone(); + let peer_context = build_foreign_peer_context( + &network, + &parent_context, + relay_data, + foreign_context_default_flags, + ); + let socket_mark = peer_context.flags().socket_mark; + let stats_mgr = peer_context.stats_manager(); + let network_name = network.network_name.clone(); + + let (packet_sender, packet_recv) = super::create_packet_recv_chan(); + + let peer_map = Arc::new(PeerMap::new( + packet_sender, + peer_context.clone(), + my_peer_id, + )); + let traffic_metrics = Arc::new(TrafficMetricRecorder::new( + my_peer_id, + Arc::new(super::traffic_metrics::LogicalTrafficMetrics::new( + stats_mgr.clone(), + network_name.clone(), + MetricName::TrafficBytesTx, + MetricName::TrafficPacketsTx, + MetricName::TrafficBytesTxByInstance, + MetricName::TrafficPacketsTxByInstance, + super::traffic_metrics::InstanceLabelKind::To, + )), + Arc::new(super::traffic_metrics::LogicalTrafficMetrics::new( + stats_mgr.clone(), + network_name.clone(), + MetricName::TrafficControlBytesTx, + MetricName::TrafficControlPacketsTx, + MetricName::TrafficControlBytesTxByInstance, + MetricName::TrafficControlPacketsTxByInstance, + super::traffic_metrics::InstanceLabelKind::To, + )), + Arc::new(super::traffic_metrics::LogicalTrafficMetrics::new( + stats_mgr.clone(), + network_name.clone(), + MetricName::TrafficBytesRx, + MetricName::TrafficPacketsRx, + MetricName::TrafficBytesRxByInstance, + MetricName::TrafficPacketsRxByInstance, + super::traffic_metrics::InstanceLabelKind::From, + )), + Arc::new(super::traffic_metrics::LogicalTrafficMetrics::new( + stats_mgr.clone(), + network_name.clone(), + MetricName::TrafficControlBytesRx, + MetricName::TrafficControlPacketsRx, + MetricName::TrafficControlBytesRxByInstance, + MetricName::TrafficControlPacketsRxByInstance, + super::traffic_metrics::InstanceLabelKind::From, + )), + { + let peer_map = Arc::downgrade(&peer_map); + move |peer_id| { + let peer_map = peer_map.clone(); + async move { + let peer_map = peer_map.upgrade()?; + peer_map + .get_route_peer_info(peer_id) + .await + .as_ref() + .and_then(super::traffic_metrics::route_peer_info_instance_id) + } + } + }, + )); + let relay_peer_map = super::relay_peer_map::new_relay_peer_map( + peer_map.clone(), + None, + peer_context.clone(), + my_peer_id, + peer_session_store.clone(), + ); + + let (rpc_transport_sender, rpc_packet_recv) = mpsc::unbounded_channel(); + let peer_rpc = Arc::new(PeerRpcManager::new(RpcTransport { + my_peer_id, + peer_map: Arc::downgrade(&peer_map), + packet_recv: Mutex::new(rpc_packet_recv), + })); + + rpc_registrar.register_peer_rpc_services( + &peer_rpc, + &network.network_name, + SocketContext::default().with_socket_mark(socket_mark), + ); + + let bps_limiter = parent_context.foreign_forward_limiter(&network.network_name); + + let peer_center = Arc::new(PeerCenterInstance::new(Arc::new( + PeerMapWithPeerRpcManager { + peer_map: peer_map.clone(), + rpc_mgr: peer_rpc.clone(), + network_name: peer_context.network_name(), + }, + ))); + + Self { + my_peer_id, + + parent_context: parent_context_dyn, + peer_context, + network, + peer_map, + relay_peer_map, + relay_data, + pm_packet_sender: Mutex::new(Some(pm_packet_sender)), + + peer_rpc, + rpc_sender: rpc_transport_sender, + + packet_recv: Mutex::new(Some(packet_recv)), + + bps_limiter, + + traffic_metrics, + event_handler_started: AtomicBool::new(false), + indexed_peers: DashSet::new(), + + tasks: Mutex::new(JoinSet::new()), + + peer_center, + + lock: Mutex::new(()), + } + } + + async fn prepare_route(&self, global_peer_map: Weak) { + let public_ipv6_runtime: Arc = + Arc::new(DisabledPublicIpv6Runtime::new( + self.peer_context.instance_id(), + self.network.network_name.clone(), + )); + let route = PeerRoute::new( + self.my_peer_id, + self.peer_context.clone(), + public_ipv6_runtime, + self.peer_rpc.clone(), + ); + route + .open(Box::new(ForeignNetworkRouteInterface { + my_peer_id: self.my_peer_id, + peer_map: Arc::downgrade(&self.peer_map), + network_identity: self.network.clone(), + global_peer_map, + })) + .await + .unwrap(); + + route + .set_route_cost_fn(self.peer_center.get_cost_calculator()) + .await; + + self.peer_map.add_route(route).await; + } + + async fn start_packet_recv(&self) { + let packet_recv = self.packet_recv.lock().await.take().unwrap(); + let pm_sender = self.pm_packet_sender.lock().await.take().unwrap(); + let router = ForeignNetworkPacketRouter::new( + self.my_peer_id, + packet_recv, + self.rpc_sender.clone(), + self.peer_map.clone(), + self.relay_peer_map.clone(), + self.traffic_metrics.clone(), + self.parent_context.clone(), + self.relay_data, + pm_sender, + self.network.network_name.clone(), + self.bps_limiter.clone(), + self.peer_context.stats_manager(), + ); + + self.tasks.lock().await.spawn(router.run()); + } + + async fn run_relay_session_gc_routine(&self) { + let relay_peer_map = self.relay_peer_map.clone(); + self.tasks.lock().await.spawn(async move { + loop { + relay_peer_map.evict_idle_sessions(std::time::Duration::from_secs(60)); + crate::foundation::time::sleep(std::time::Duration::from_secs(30)).await; + } + }); + } + + async fn run_parent_feature_flag_sync_routine(&self) { + let parent_context = self.parent_context.clone(); + let foreign_peer_context: ArcPeerContext = self.peer_context.clone(); + let relay_data = self.relay_data; + let runtime_changes = parent_context.subscribe_runtime_changes(); + sync_foreign_avoid_relay_data(&parent_context, &foreign_peer_context, relay_data); + let Some(mut runtime_changes) = runtime_changes else { + return; + }; + self.tasks.lock().await.spawn(async move { + loop { + if runtime_changes.changed().await.is_err() { + break; + } + sync_foreign_avoid_relay_data(&parent_context, &foreign_peer_context, relay_data); + } + }); + } + + async fn prepare(&self, global_peer_map: Weak) { + self.prepare_route(global_peer_map).await; + self.start_packet_recv().await; + self.run_relay_session_gc_routine().await; + self.run_parent_feature_flag_sync_routine().await; + self.peer_rpc.run(); + self.peer_center.init().await; + } + + async fn stop(&self) { + let mut tasks = self.tasks.lock().await; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + drop(tasks); + self.peer_center.stop().await; + self.peer_rpc.stop().await; + self.peer_map.clear_resources().await; + self.peer_context.stop().await; + } +} + +impl Drop for ForeignNetworkEntry { + fn drop(&mut self) { + self.peer_rpc + .rpc_server() + .registry() + .unregister_by_domain(&self.network.network_name); + self.peer_context + .remove_trusted_keys(&self.network.network_name); + + tracing::debug!(self.my_peer_id, ?self.network, "drop foreign network entry"); + } +} + +struct ForeignNetworkManagerData { + network_peer_maps: DashMap>, + peer_network_map: DashMap>, + network_peer_last_update: DashMap, + global_peer_map: Weak, + lock: std::sync::Mutex<()>, +} + +impl ForeignNetworkManagerData { + fn remove_entry_from_peer_index_locked( + &self, + network_name: &String, + entry: &ForeignNetworkEntry, + ) { + let indexed_peers = entry + .indexed_peers + .iter() + .map(|peer_id| *peer_id) + .collect::>(); + for peer_id in indexed_peers { + self.peer_network_map.remove_if(&peer_id, |_, networks| { + networks.remove(network_name); + networks.is_empty() + }); + } + entry.indexed_peers.clear(); + } + + fn get_peer_network(&self, peer_id: PeerId) -> Option> { + self.peer_network_map.get(&peer_id).map(|v| v.clone()) + } + + fn get_network_entry(&self, network_name: &str) -> Option> { + self.network_peer_maps.get(network_name).map(|v| v.clone()) + } + + fn is_current_entry( + &self, + network_name: &String, + expected_entry: &Arc, + ) -> bool { + let _l = self.lock.lock().unwrap(); + self.network_peer_maps + .get(network_name) + .is_some_and(|entry| Arc::ptr_eq(entry.value(), expected_entry)) + } + + fn remove_peer( + &self, + peer_id: PeerId, + network_name: &String, + expected_entry: &Weak, + ) { + let _l = self.lock.lock().unwrap(); + let Some(expected_entry) = expected_entry.upgrade() else { + return; + }; + let is_current = self + .network_peer_maps + .get(network_name) + .is_some_and(|entry| Arc::ptr_eq(entry.value(), &expected_entry)); + if !is_current || expected_entry.peer_map.has_peer(peer_id) { + return; + } + + let network_removed = self + .network_peer_maps + .remove_if(network_name, |_, entry| { + Arc::ptr_eq(entry, &expected_entry) && entry.peer_map.is_empty() + }) + .is_some(); + if network_removed { + self.remove_entry_from_peer_index_locked(network_name, &expected_entry); + self.network_peer_last_update.remove(network_name); + } else { + self.peer_network_map.remove_if(&peer_id, |_, networks| { + networks.remove(network_name); + networks.is_empty() + }); + expected_entry.indexed_peers.remove(&peer_id); + } + shrink_dashmap(&self.peer_network_map, None); + shrink_dashmap(&self.network_peer_maps, None); + shrink_dashmap(&self.network_peer_last_update, None); + } + + async fn clear_no_conn_peer(&self, network_name: &String) { + let Some(peer_map) = self + .network_peer_maps + .get(network_name) + .map(|v| v.peer_map.clone()) + else { + return; + }; + peer_map.clean_peer_without_conn().await; + } + + fn record_peer_if_current( + &self, + network_name: &String, + expected_entry: &Arc, + peer_id: PeerId, + ) -> bool { + let _l = self.lock.lock().unwrap(); + let is_current = self + .network_peer_maps + .get(network_name) + .is_some_and(|entry| Arc::ptr_eq(entry.value(), expected_entry)); + if !is_current || !expected_entry.peer_map.has_peer(peer_id) { + return false; + } + + self.peer_network_map + .entry(peer_id) + .or_default() + .insert(network_name.clone()); + expected_entry.indexed_peers.insert(peer_id); + self.network_peer_last_update + .insert(network_name.clone(), SystemTime::now()); + true + } + + /// Removes the current entry and closes all of its peer connections. A + /// secret-verified peer will reconnect and establish a fresh entry. + async fn remove_network_and_close_peers( + &self, + network_name: &String, + expected_entry: &Weak, + ) -> bool { + let Some(entry) = expected_entry.upgrade() else { + return false; + }; + let _entry_lock = entry.lock.lock().await; + if self + .remove_network_if_current(network_name, expected_entry) + .is_none() + { + return false; + } + + for peer_id in entry.peer_map.list_peers() { + let _ = entry.peer_map.close_peer(peer_id).await; + } + true + } + + fn remove_network_if_current( + &self, + network_name: &String, + expected_entry: &Weak, + ) -> Option> { + let _l = self.lock.lock().unwrap(); + let expected_entry = expected_entry.upgrade()?; + let old = self + .network_peer_maps + .remove_if(network_name, |_, entry| Arc::ptr_eq(entry, &expected_entry)); + let (_, old) = old?; + + old.traffic_metrics.clear_peer_cache(); + self.remove_entry_from_peer_index_locked(network_name, &old); + self.network_peer_last_update.remove(network_name); + shrink_dashmap(&self.peer_network_map, None); + shrink_dashmap(&self.network_peer_maps, None); + shrink_dashmap(&self.network_peer_last_update, None); + Some(old) + } + + fn remove_empty_network_if_current( + &self, + network_name: &String, + expected_entry: &Weak, + ) { + let _l = self.lock.lock().unwrap(); + let Some(expected_entry) = expected_entry.upgrade() else { + return; + }; + if self + .network_peer_maps + .remove_if(network_name, |_, entry| { + Arc::ptr_eq(entry, &expected_entry) + && entry.peer_map.is_empty() + && entry.indexed_peers.is_empty() + }) + .is_some() + { + self.network_peer_last_update.remove(network_name); + shrink_dashmap(&self.network_peer_maps, None); + shrink_dashmap(&self.network_peer_last_update, None); + } + } + + #[allow(clippy::too_many_arguments)] + async fn get_or_insert_entry( + &self, + network_identity: &NetworkIdentity, + allow_create: bool, + my_peer_id: PeerId, + relay_data: bool, + rpc_registrar: Arc, + parent_context: Arc, + foreign_context_default_flags: FlagsInConfig, + peer_session_store: Arc, + pm_packet_sender: &PacketRecvChan, + ) -> Option<(Arc, bool)> { + let mut new_added = false; + + let l = self.lock.lock().unwrap(); + if !allow_create + && !self + .network_peer_maps + .contains_key(&network_identity.network_name) + { + return None; + } + let entry = self + .network_peer_maps + .entry(network_identity.network_name.clone()) + .or_insert_with(|| { + new_added = true; + Arc::new(ForeignNetworkEntry::new( + network_identity.clone(), + my_peer_id, + rpc_registrar, + parent_context, + foreign_context_default_flags, + relay_data, + peer_session_store, + pm_packet_sender.clone(), + )) + }) + .clone(); + + drop(l); + + if new_added { + entry.prepare(self.global_peer_map.clone()).await; + } + + Some((entry, new_added)) + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +enum ForeignNetworkManagerState { + Running, + Stopping, + Stopped, +} + +pub(crate) struct ForeignNetworkManager { + rpc_registrar: Arc, + parent_context: Arc, + foreign_context_default_flags: FlagsInConfig, + peer_session_store: Arc, + packet_sender_to_mgr: PacketRecvChan, + + data: Arc, + + tasks: Arc>>, + task_reaper: Mutex>>, + lifecycle: RwLock, +} + +impl ForeignNetworkManager { + fn network_secret_digest_is_empty(network: &NetworkIdentity) -> bool { + network + .network_secret_digest + .as_ref() + .is_none_or(|d| d.iter().all(|b| *b == 0)) + } + + fn should_reject_credential_trust_path(identity_type: PeerIdentityType) -> bool { + matches!(identity_type, PeerIdentityType::Admin) + } + + fn credential_pubkey_is_trusted( + entry: &ForeignNetworkEntry, + remote_static_pubkey: &[u8], + ) -> bool { + remote_static_pubkey.len() == 32 + && entry.peer_context.is_pubkey_trusted_with_source( + remote_static_pubkey, + &entry.network.network_name, + TrustedKeySource::OspfCredential, + ) + } + + pub fn new( + rpc_registrar: Arc, + parent_context: Arc, + foreign_context_default_flags: FlagsInConfig, + peer_session_store: Arc, + packet_sender_to_mgr: PacketRecvChan, + global_peer_map: Weak, + ) -> Self { + let data = Arc::new(ForeignNetworkManagerData { + network_peer_maps: DashMap::new(), + peer_network_map: DashMap::new(), + network_peer_last_update: DashMap::new(), + global_peer_map, + lock: std::sync::Mutex::new(()), + }); + + let tasks = Arc::new(std::sync::Mutex::new(JoinSet::new())); + let task_reaper = tokio::spawn(reap_joinset_background( + Arc::downgrade(&tasks), + "ForeignNetworkManager", + )); + + Self { + rpc_registrar, + parent_context, + foreign_context_default_flags, + peer_session_store, + packet_sender_to_mgr, + data, + tasks, + task_reaper: Mutex::new(Some(task_reaper)), + lifecycle: RwLock::new(ForeignNetworkManagerState::Running), + } + } + + async fn admission_guard( + &self, + ) -> Result, Error> { + let guard = self.lifecycle.read().await; + if *guard != ForeignNetworkManagerState::Running { + return Err(anyhow::anyhow!("foreign network manager is stopping").into()); + } + Ok(guard) + } + + pub async fn stop(&self) { + let mut lifecycle = self.lifecycle.write().await; + if *lifecycle == ForeignNetworkManagerState::Stopped { + return; + } + // Set this before the first await so cancellation permanently closes + // admission. A later stop call can safely resume the idempotent + // teardown while admissions remain rejected. + *lifecycle = ForeignNetworkManagerState::Stopping; + + let mut reaper = self.task_reaper.lock().await; + if let Some(reaper) = reaper.as_mut() { + reaper.abort(); + let _ = reaper.await; + } + reaper.take(); + drop(reaper); + abort_and_join_persistent_tasks(&self.tasks).await; + + let entries = self + .data + .network_peer_maps + .iter() + .map(|entry| entry.value().clone()) + .collect::>(); + for entry in entries { + entry.stop().await; + } + // Keep entries discoverable until every nested graph is stopped. If + // this future is cancelled, the next stop call can snapshot and retry + // the remaining idempotent teardown instead of losing ownership. + self.data.peer_network_map.clear(); + self.data.network_peer_maps.clear(); + self.data.network_peer_last_update.clear(); + *lifecycle = ForeignNetworkManagerState::Stopped; + } + + pub fn get_network_peer_id(&self, network_name: &str) -> Option { + self.data + .network_peer_maps + .get(network_name) + .map(|v| v.my_peer_id) + } + + pub fn is_existing_credential_pubkey_trusted( + &self, + network_name: &str, + remote_static_pubkey: &[u8], + ) -> bool { + self.data + .get_network_entry(network_name) + .is_some_and(|entry| Self::credential_pubkey_is_trusted(&entry, remote_static_pubkey)) + } + + pub async fn add_peer_conn(&self, peer_conn: PeerConn) -> Result<(), Error> { + let _admission = self.admission_guard().await?; + let conn_info = peer_conn.get_conn_info(); + let peer_network = peer_conn.get_network_identity(); + let dst_peer_id = peer_conn.get_peer_id(); + let conn_id = peer_conn.get_conn_id(); + tracing::info!(peer_conn = ?conn_info, network = ?peer_network, "add new peer conn in foreign network manager"); + + let parent_flags = self.parent_context.flags(); + let ret = check_network_in_relay_whitelist( + &parent_flags.relay_network_whitelist, + &peer_network.network_name, + ); + if ret.is_err() && !parent_flags.relay_all_peer_rpc { + return ret.map_err(Error::Other); + } + + let peer_digest_empty = Self::network_secret_digest_is_empty(&peer_network); + let Some((entry, new_added)) = self + .data + .get_or_insert_entry( + &peer_network, + !peer_digest_empty, + peer_conn.get_my_peer_id(), + ret.is_ok(), + self.rpc_registrar.clone(), + self.parent_context.clone(), + self.foreign_context_default_flags.clone(), + self.peer_session_store.clone(), + &self.packet_sender_to_mgr, + ) + .await + else { + return Err(anyhow::anyhow!( + "foreign network {} is not established by a secret-verified peer yet", + peer_network.network_name + ) + .into()); + }; + + defer!(rollback_new_entry => sync [ + data = self.data.clone(), + network_name = entry.network.network_name.clone(), + entry_for_rollback = Arc::downgrade(&entry), + should_rollback = new_added + ] { + if should_rollback { + tracing::warn!( + %network_name, + "rollback newly added foreign network entry after add_peer_conn returned error" + ); + data.remove_empty_network_if_current(&network_name, &entry_for_rollback); + } + }); + + self.ensure_event_handler_started(&entry); + + let same_identity = entry.network == peer_network; + let peer_identity_type = peer_conn.get_peer_identity_type(); + let credential_peer_trusted = peer_digest_empty + && Self::credential_pubkey_is_trusted(&entry, &conn_info.noise_remote_static_pubkey); + let credential_identity_mismatch = credential_peer_trusted + && Self::should_reject_credential_trust_path(peer_identity_type); + + let _g = entry.lock.lock().await; + + if !self + .data + .is_current_entry(&peer_network.network_name, &entry) + { + return Err(anyhow::anyhow!( + "foreign network entry changed while admitting peer, need retry connect" + ) + .into()); + } + + if (!(same_identity || credential_peer_trusted)) + || credential_identity_mismatch + || entry.my_peer_id != peer_conn.get_my_peer_id() + { + let err = if entry.my_peer_id != peer_conn.get_my_peer_id() { + anyhow::anyhow!( + "my peer id not match. exp: {:?} real: {:?}, need retry connect", + entry.my_peer_id, + peer_conn.get_my_peer_id() + ) + } else if credential_identity_mismatch { + anyhow::anyhow!( + "credential-trusted foreign peer has invalid identity type: {:?}", + peer_identity_type + ) + } else { + anyhow::anyhow!( + "foreign peer identity not trusted. exp: {:?} real: {:?}, remote_pubkey_len: {}, credential_trusted: {}", + entry.network, + peer_network, + conn_info.noise_remote_static_pubkey.len(), + credential_peer_trusted, + ) + }; + tracing::error!(?err, "foreign network entry not match, disconnect peer"); + return Err(err.into()); + } + + if !new_added && let Some(peer) = entry.peer_map.get_peer_by_id(dst_peer_id) { + let direct_conns_len = peer.get_directly_connections().len(); + let max_count = self + .parent_context + .max_direct_conns_per_peer_in_foreign_network(); + if direct_conns_len >= max_count { + return Err(anyhow::anyhow!( + "too many direct conns, cur: {}, max: {}", + direct_conns_len, + max_count + ) + .into()); + } + } + + entry.peer_map.add_new_peer_conn(peer_conn).await?; + if !self + .data + .record_peer_if_current(&peer_network.network_name, &entry, dst_peer_id) + { + let _ = entry.peer_map.close_peer_conn(dst_peer_id, &conn_id).await; + return Err(anyhow::anyhow!( + "foreign network entry changed while admitting peer, need retry connect" + ) + .into()); + } + let _ = rollback_new_entry.defuse(); + Ok(()) + } + + fn ensure_event_handler_started(&self, entry: &Arc) { + if entry.event_handler_started.swap(true, Ordering::AcqRel) { + return; + } + + let Some(mut s) = entry.peer_context.subscribe_peer_events() else { + return; + }; + let data = self.data.clone(); + let network_name = entry.network.network_name.clone(); + let entry_for_cleanup = Arc::downgrade(entry); + let traffic_metrics = Arc::downgrade(&entry.traffic_metrics); + self.tasks.lock().unwrap().spawn(async move { + loop { + match s.recv().await { + Ok(e) => { + match &e { + PeerContextEvent::PeerRemoved(peer_id) => { + tracing::info!(?e, "remove peer from foreign network manager"); + if let Some(traffic_metrics) = traffic_metrics.upgrade() { + traffic_metrics.remove_peer(*peer_id); + } + data.network_peer_last_update + .insert(network_name.clone(), SystemTime::now()); + data.remove_peer( + *peer_id, + &network_name, + &entry_for_cleanup, + ); + } + PeerContextEvent::PeerConnRemoved => { + tracing::info!(?e, "clear no conn peer from foreign network manager"); + data.clear_no_conn_peer(&network_name).await; + } + PeerContextEvent::PeerAdded(_) => { + tracing::info!(?e, "add peer to foreign network manager"); + data.network_peer_last_update + .insert(network_name.clone(), SystemTime::now()); + } + _ => continue, + } + } + Err(tokio::sync::broadcast::error::RecvError::Lagged(skipped)) => { + tracing::warn!( + %network_name, + skipped, + "foreign network event handler lagged; closing the network so peers reconnect" + ); + // Remove the stale entry and close all of its peers. + // A secret-verified peer will reconnect and establish + // a fresh entry. + let _ = data + .remove_network_and_close_peers( + &network_name, + &entry_for_cleanup, + ) + .await; + break; + } + Err(tokio::sync::broadcast::error::RecvError::Closed) => break, + } + } + tracing::error!("global event handler at foreign network manager exit"); + if let Some(traffic_metrics) = traffic_metrics.upgrade() { + traffic_metrics.clear_peer_cache(); + } + let _ = data.remove_network_if_current(&network_name, &entry_for_cleanup); + }); + } + + pub async fn list_foreign_network_infos( + &self, + include_trusted_keys: bool, + ) -> std::collections::HashMap { + let mut ret = std::collections::HashMap::new(); + let networks = self + .data + .network_peer_maps + .iter() + .map(|v| v.key().clone()) + .collect::>(); + + for network_name in networks { + let Some(item) = self + .data + .network_peer_maps + .get(&network_name) + .map(|v| v.clone()) + else { + continue; + }; + + let mut entry = ForeignNetworkEntryInfo { + network_secret_digest: item + .network + .network_secret_digest + .unwrap_or_default() + .to_vec(), + my_peer_id_for_this_network: item.my_peer_id, + peers: Default::default(), + trusted_keys: if include_trusted_keys { + item.peer_context + .list_trusted_keys(&item.network.network_name) + .into_iter() + .map(|(pubkey, metadata)| ForeignNetworkTrustedKeyInfo { + pubkey, + source: metadata.source, + expiry_unix: metadata.expiry_unix, + }) + .collect() + } else { + Default::default() + }, + }; + for peer in item.peer_map.list_peers() { + let peer_info = ForeignNetworkPeerInfo { + peer_id: peer, + conns: item.peer_map.list_peer_conns(peer).await.unwrap_or(vec![]), + }; + entry.peers.push(peer_info); + } + + ret.insert(network_name, entry); + } + ret + } + + pub async fn list_foreign_network_route_infos(&self) -> Vec { + self.list_foreign_network_infos(false) + .await + .into_iter() + .map(|(network_name, info)| ForeignNetworkRouteInfo { + network_name, + peer_ids: info.peers.into_iter().map(|peer| peer.peer_id).collect(), + network_secret_digest: info.network_secret_digest, + my_peer_id_for_this_network: info.my_peer_id_for_this_network, + }) + .collect() + } + + pub fn get_foreign_network_last_update(&self, network_name: &str) -> Option { + self.data + .network_peer_last_update + .get(network_name) + .map(|v| *v) + } + + pub async fn forward_foreign_network_packet( + &self, + network_name: &str, + dst_peer_id: PeerId, + msg: ZCPacket, + ) -> Result<(), Error> { + if let Some(entry) = self.data.get_network_entry(network_name) { + let packet_type = msg + .peer_manager_header() + .map(|hdr| hdr.packet_type) + .unwrap_or(0); + let msg_len = msg.buf_len() as u64; + let send_result = entry + .peer_map + .send_msg(msg, dst_peer_id, NextHopPolicy::LeastHop) + .await; + if send_result.is_ok() { + entry + .traffic_metrics + .record_tx(dst_peer_id, packet_type, msg_len) + .await; + } + send_result + } else { + Err(Error::RouteError(Some("network not found".to_string()))) + } + } + + pub async fn close_peer_conn( + &self, + peer_id: PeerId, + conn_id: &PeerConnId, + ) -> Result<(), Error> { + let network_names = self.data.get_peer_network(peer_id).unwrap_or_default(); + for network_name in network_names { + if let Some(entry) = self.data.get_network_entry(&network_name) { + let ret = entry.peer_map.close_peer_conn(peer_id, conn_id).await; + if ret.is_ok() || !matches!(ret.as_ref().unwrap_err(), Error::NotFound) { + return ret; + } + } + } + Err(Error::NotFound) + } +} + +impl Drop for ForeignNetworkManager { + fn drop(&mut self) { + if let Ok(mut reaper) = self.task_reaper.try_lock() + && let Some(reaper) = reaper.take() + { + reaper.abort(); + } + self.tasks.lock().unwrap().abort_all(); + self.data.peer_network_map.clear(); + self.data.network_peer_maps.clear(); + } +} + +struct ForeignNetworkForwardCounters { + forward_data_bytes: CounterHandle, + forward_data_packets: CounterHandle, + forward_control_bytes: CounterHandle, + forward_control_packets: CounterHandle, + rx_bytes: CounterHandle, + rx_packets: CounterHandle, +} + +pub(crate) struct ForeignNetworkPacketRouter { + my_node_id: PeerId, + packet_recv: PacketRecvChanReceiver, + rpc_sender: UnboundedSender, + peer_map: Arc, + relay_peer_map: Arc, + traffic_metrics: Arc, + parent_context: ArcPeerContext, + relay_data: bool, + pm_sender: PacketRecvChan, + network_name: String, + bps_limiter: Option, + counters: ForeignNetworkForwardCounters, +} + +impl ForeignNetworkPacketRouter { + #[allow(clippy::too_many_arguments)] + pub fn new( + my_node_id: PeerId, + packet_recv: PacketRecvChanReceiver, + rpc_sender: UnboundedSender, + peer_map: Arc, + relay_peer_map: Arc, + traffic_metrics: Arc, + parent_context: ArcPeerContext, + relay_data: bool, + pm_sender: PacketRecvChan, + network_name: String, + bps_limiter: Option, + stats_mgr: Arc, + ) -> Self { + let label_set = + LabelSet::new().with_label_type(LabelType::NetworkName(network_name.clone())); + let counters = ForeignNetworkForwardCounters { + forward_data_bytes: stats_mgr + .get_counter(MetricName::TrafficBytesForwarded, label_set.clone()), + forward_data_packets: stats_mgr + .get_counter(MetricName::TrafficPacketsForwarded, label_set.clone()), + forward_control_bytes: stats_mgr + .get_counter(MetricName::TrafficControlBytesForwarded, label_set.clone()), + forward_control_packets: stats_mgr.get_counter( + MetricName::TrafficControlPacketsForwarded, + label_set.clone(), + ), + rx_bytes: stats_mgr.get_counter(MetricName::TrafficBytesSelfRx, label_set.clone()), + rx_packets: stats_mgr.get_counter(MetricName::TrafficPacketsRx, label_set), + }; + + Self { + my_node_id, + packet_recv, + rpc_sender, + peer_map, + relay_peer_map, + traffic_metrics, + parent_context, + relay_data, + pm_sender, + network_name, + bps_limiter, + counters, + } + } + + pub async fn run(self) { + let Self { + my_node_id, + mut packet_recv, + rpc_sender, + peer_map, + relay_peer_map, + traffic_metrics, + parent_context, + relay_data, + pm_sender, + network_name, + bps_limiter, + counters, + } = self; + + while let Ok(mut zc_packet) = recv_packet_from_chan(&mut packet_recv).await { + let buf_len = zc_packet.buf_len(); + let Some(hdr) = zc_packet.peer_manager_header() else { + tracing::warn!("invalid packet, skip"); + continue; + }; + tracing::trace!(?hdr, "recv packet in foreign network manager"); + let from_peer_id = hdr.from_peer_id.get(); + let packet_type = hdr.packet_type; + let len = hdr.len.get(); + let to_peer_id = hdr.to_peer_id.get(); + let is_local_delivery = to_peer_id == my_node_id; + let is_locally_originated = from_peer_id == my_node_id; + if is_local_delivery && !is_locally_originated { + traffic_metrics + .record_rx(from_peer_id, packet_type, buf_len as u64) + .await; + } + if is_local_delivery { + if packet_type == PacketType::RelayHandshake as u8 + || packet_type == PacketType::RelayHandshakeAck as u8 + { + let _ = relay_peer_map.handle_handshake_packet(zc_packet).await; + continue; + } + + if relay_peer_map.is_secure_mode_enabled() && hdr.is_encrypted() { + match relay_peer_map.decrypt_if_needed(&mut zc_packet).await { + Ok(true) => {} + Ok(false) => { + tracing::error!("secure session not found"); + continue; + } + Err(e) => { + tracing::error!(?e, "secure decrypt failed"); + continue; + } + } + } + + if packet_type == PacketType::TaRpc as u8 + || packet_type == PacketType::RpcReq as u8 + || packet_type == PacketType::RpcResp as u8 + { + counters.rx_bytes.add(buf_len as u64); + counters.rx_packets.inc(); + rpc_sender.send(zc_packet).unwrap(); + continue; + } + tracing::trace!( + ?packet_type, + ?len, + ?from_peer_id, + ?to_peer_id, + "ignore packet in foreign network" + ); + } else { + if is_relay_data_packet_type(packet_type) { + let disable_relay_data = parent_context.disable_relay_data(); + if !relay_data || disable_relay_data { + tracing::debug!( + ?from_peer_id, + ?to_peer_id, + packet_type, + disable_relay_data, + "drop foreign network relay data" + ); + continue; + } + if let Some(payload_len) = data_packet_payload_len(&zc_packet) + && let Some(bps_limiter) = bps_limiter.as_ref() + && !bps_limiter.try_consume(payload_len) + { + continue; + } + } + + match traffic_kind(packet_type) { + TrafficKind::Data => { + counters.forward_data_bytes.add(buf_len as u64); + counters.forward_data_packets.inc(); + } + TrafficKind::Control => { + counters.forward_control_bytes.add(buf_len as u64); + counters.forward_control_packets.inc(); + } + } + + let gateway_peer_id = peer_map + .get_gateway_peer_id(to_peer_id, NextHopPolicy::LeastHop) + .await; + + match gateway_peer_id { + Some(peer_id) if peer_map.has_peer(peer_id) => { + if peer_id != to_peer_id && hdr.from_peer_id.get() == my_node_id { + if let Err(e) = relay_peer_map + .send_msg(zc_packet, to_peer_id, NextHopPolicy::LeastHop) + .await + { + tracing::error!( + ?e, + "send packet to foreign peer inside relay peer map failed" + ); + } else if is_locally_originated { + traffic_metrics + .record_tx(to_peer_id, packet_type, buf_len as u64) + .await; + } + } else if let Err(e) = peer_map.send_msg_directly(zc_packet, peer_id).await + { + tracing::error!( + ?e, + "send packet to foreign peer inside peer map failed" + ); + } else if is_locally_originated { + traffic_metrics + .record_tx(to_peer_id, packet_type, buf_len as u64) + .await; + } + } + _ => { + let mut foreign_packet = ZCPacket::new_for_foreign_network( + &network_name, + to_peer_id, + &zc_packet, + ); + let via_peer = gateway_peer_id.unwrap_or(to_peer_id); + foreign_packet.fill_peer_manager_hdr( + my_node_id, + via_peer, + PacketType::ForeignNetworkPacket as u8, + ); + if let Err(e) = pm_sender.send(foreign_packet).await { + tracing::error!("send packet to peer with pm failed: {:?}", e); + } else if is_locally_originated { + traffic_metrics + .record_tx(to_peer_id, packet_type, buf_len as u64) + .await; + } + } + }; + } + } + } +} + +#[cfg(test)] +mod tests { + #![allow(clippy::field_reassign_with_default)] + + use std::sync::{ + Arc, Weak, + atomic::{AtomicBool, Ordering}, + }; + + use dashmap::DashMap; + use easytier_proto::common::{FlagsInConfig, PeerFeatureFlag}; + + use super::{ + ForeignNetworkEntry, ForeignNetworkManager, ForeignNetworkManagerData, + abort_and_join_persistent_tasks, build_foreign_peer_context, + desired_foreign_avoid_relay_data, sync_foreign_avoid_relay_data, + }; + + use crate::peers::whitelist::check_network_in_relay_whitelist; + + use crate::{ + config::peers::PeerRuntimeSnapshot, + config::runtime::{CoreRuntimeConfig, CoreRuntimeConfigStore}, + foundation::stats::{LabelSet, LabelType, MetricName}, + peers::{ + conn::{peer_map::PeerMap, peer_session::PeerSessionStore}, + context::{ + ArcPeerContext, CorePeerContext, CorePeerContextAdapters, NetworkIdentity, + PeerContext, + }, + create_packet_recv_chan, + error::Error, + }, + proto::common::StunInfo, + }; + + fn new_test_foreign_entry(network_name: &str) -> Arc { + let parent = Arc::new(CorePeerContext::new( + CoreRuntimeConfigStore::new( + CoreRuntimeConfig::default(), + Arc::new(PeerRuntimeSnapshot::default()), + ), + Arc::new(()), + CorePeerContextAdapters { + stun_info_source: None, + events: Arc::new(()), + credential_storage: None, + }, + )); + let (packet_sender, _packet_receiver) = create_packet_recv_chan(); + Arc::new(ForeignNetworkEntry::new( + NetworkIdentity::new(network_name.to_owned(), "secret".to_owned()), + 1, + Arc::new(()), + parent, + FlagsInConfig::default(), + true, + Arc::new(PeerSessionStore::new()), + packet_sender, + )) + } + + fn new_test_manager_data() -> ForeignNetworkManagerData { + ForeignNetworkManagerData { + network_peer_maps: DashMap::new(), + peer_network_map: DashMap::new(), + network_peer_last_update: DashMap::new(), + global_peer_map: Weak::::new(), + lock: std::sync::Mutex::new(()), + } + } + + #[tokio::test] + async fn lag_reset_waits_for_admission_and_cleans_only_its_indexed_peers() { + let network_name = "foreign".to_owned(); + let other_network = "other".to_owned(); + let entry = new_test_foreign_entry(&network_name); + + let data = new_test_manager_data(); + data.network_peer_maps + .insert(network_name.clone(), entry.clone()); + for peer_id in [10, 20] { + data.peer_network_map + .entry(peer_id) + .or_default() + .insert(network_name.clone()); + entry.indexed_peers.insert(peer_id); + } + data.peer_network_map + .get(&20) + .unwrap() + .insert(other_network.clone()); + + let entry_for_reset = Arc::downgrade(&entry); + let entry_lock = entry.lock.lock().await; + let reset_succeeded = { + let reset = data.remove_network_and_close_peers(&network_name, &entry_for_reset); + tokio::pin!(reset); + assert!(matches!( + futures::poll!(reset.as_mut()), + std::task::Poll::Pending + )); + drop(entry_lock); + reset.await + }; + assert!(reset_succeeded); + + assert!(!data.network_peer_maps.contains_key(&network_name)); + assert!(!data.peer_network_map.contains_key(&10)); + assert_eq!( + data.peer_network_map + .get(&20) + .unwrap() + .iter() + .map(|network| network.clone()) + .collect::>(), + [other_network] + ); + assert!(entry.indexed_peers.is_empty()); + assert!(!data.network_peer_last_update.contains_key(&network_name)); + } + + #[tokio::test] + async fn peer_index_commit_rejects_an_entry_that_is_no_longer_current() { + let network_name = "foreign".to_owned(); + let old_entry = new_test_foreign_entry(&network_name); + let current_entry = new_test_foreign_entry(&network_name); + let data = new_test_manager_data(); + data.network_peer_maps + .insert(network_name.clone(), current_entry.clone()); + + data.remove_empty_network_if_current(&network_name, &Arc::downgrade(&old_entry)); + assert!( + data.network_peer_maps + .get(&network_name) + .is_some_and(|entry| Arc::ptr_eq(entry.value(), ¤t_entry)) + ); + assert!(!data.record_peer_if_current(&network_name, &old_entry, 10)); + assert!(!data.peer_network_map.contains_key(&10)); + assert!(!data.is_current_entry(&network_name, &old_entry)); + assert!(data.is_current_entry(&network_name, ¤t_entry)); + assert!(!data.record_peer_if_current(&network_name, ¤t_entry, 10)); + for peer_id in [10, 11] { + data.peer_network_map + .entry(peer_id) + .or_default() + .insert(network_name.clone()); + current_entry.indexed_peers.insert(peer_id); + } + assert!( + data.peer_network_map + .get(&10) + .unwrap() + .contains(&network_name) + ); + assert!(current_entry.indexed_peers.contains(&10)); + + data.remove_peer(10, &network_name, &Arc::downgrade(&old_entry)); + assert!( + data.peer_network_map + .get(&10) + .unwrap() + .contains(&network_name) + ); + + data.remove_empty_network_if_current(&network_name, &Arc::downgrade(¤t_entry)); + assert!( + data.network_peer_maps + .get(&network_name) + .is_some_and(|entry| Arc::ptr_eq(entry.value(), ¤t_entry)) + ); + + data.remove_peer(10, &network_name, &Arc::downgrade(¤t_entry)); + assert!(!data.network_peer_maps.contains_key(&network_name)); + assert!(!data.peer_network_map.contains_key(&10)); + assert!(!data.peer_network_map.contains_key(&11)); + assert!(current_entry.indexed_peers.is_empty()); + } + + impl ForeignNetworkManager { + pub(crate) async fn is_stopped_for_test(&self) -> bool { + *self.lifecycle.read().await == super::ForeignNetworkManagerState::Stopped + && self.task_reaper.lock().await.is_none() + && self.tasks.lock().unwrap().is_empty() + && self.data.network_peer_maps.is_empty() + && self.data.peer_network_map.is_empty() + } + + pub(crate) async fn admission_is_open_for_test(&self) -> bool { + self.admission_guard().await.is_ok() + } + + pub(crate) async fn hold_admission_for_test( + &self, + entered: Arc, + release: Arc, + ) -> Result<(), Error> { + let _admission = self.admission_guard().await?; + entered.notify_one(); + release.notified().await; + Ok(()) + } + } + + #[tokio::test] + async fn cancelled_join_wait_keeps_persistent_task_ownership() { + struct DropFlag(Arc); + + impl Drop for DropFlag { + fn drop(&mut self) { + self.0.store(true, Ordering::Release); + } + } + + let tasks = std::sync::Mutex::new(tokio::task::JoinSet::new()); + let entered = Arc::new(tokio::sync::Notify::new()); + let dropped = Arc::new(AtomicBool::new(false)); + let task_entered = entered.clone(); + let task_dropped = dropped.clone(); + tasks.lock().unwrap().spawn(async move { + let _drop = DropFlag(task_dropped); + task_entered.notify_one(); + std::future::pending::<()>().await; + }); + entered.notified().await; + + { + let first_wait = abort_and_join_persistent_tasks(&tasks); + tokio::pin!(first_wait); + assert!(matches!( + futures::poll!(first_wait.as_mut()), + std::task::Poll::Pending + )); + } + + abort_and_join_persistent_tasks(&tasks).await; + assert!(dropped.load(Ordering::Acquire)); + assert!(tasks.lock().unwrap().is_empty()); + } + + struct FeatureContext { + avoid_relay_data: AtomicBool, + flags: FlagsInConfig, + hostname: String, + } + + impl FeatureContext { + fn new(avoid_relay_data: bool) -> Self { + Self { + avoid_relay_data: AtomicBool::new(avoid_relay_data), + flags: FlagsInConfig::default(), + hostname: String::new(), + } + } + } + + impl PeerContext for FeatureContext { + fn network_identity(&self) -> NetworkIdentity { + NetworkIdentity::default() + } + + fn feature_flags(&self) -> PeerFeatureFlag { + PeerFeatureFlag { + avoid_relay_data: self.avoid_relay_data.load(Ordering::Acquire), + ..Default::default() + } + } + + fn flags(&self) -> FlagsInConfig { + self.flags.clone() + } + + fn hostname(&self) -> String { + self.hostname.clone() + } + + fn set_avoid_relay_data_preference(&self, avoid_relay_data: bool) -> bool { + self.avoid_relay_data + .swap(avoid_relay_data, Ordering::AcqRel) + != avoid_relay_data + } + } + + #[test] + fn relay_whitelist_supports_exact_wildcard_and_empty_rules() { + assert!(check_network_in_relay_whitelist("net1 net2*", "net1").is_ok()); + assert!(check_network_in_relay_whitelist("net1 net2*", "net2-west").is_ok()); + assert!(check_network_in_relay_whitelist("*", "any-network").is_ok()); + assert!(check_network_in_relay_whitelist("", "net1").is_err()); + assert!(check_network_in_relay_whitelist("net1 net2*", "net3").is_err()); + } + + #[test] + fn foreign_avoid_relay_data_policy_tracks_parent_and_relay_permission() { + let parent_state = Arc::new(FeatureContext::new(false)); + let parent: ArcPeerContext = parent_state.clone(); + let foreign_state = Arc::new(FeatureContext::new(true)); + let foreign: ArcPeerContext = foreign_state.clone(); + + assert!(!desired_foreign_avoid_relay_data(&parent, true)); + assert!(sync_foreign_avoid_relay_data(&parent, &foreign, true)); + assert!(!foreign.feature_flags().avoid_relay_data); + assert!(!sync_foreign_avoid_relay_data(&parent, &foreign, true)); + + parent_state.avoid_relay_data.store(true, Ordering::Release); + assert!(sync_foreign_avoid_relay_data(&parent, &foreign, true)); + assert!(foreign.feature_flags().avoid_relay_data); + + parent_state + .avoid_relay_data + .store(false, Ordering::Release); + assert!(!sync_foreign_avoid_relay_data(&parent, &foreign, false)); + assert!(foreign.feature_flags().avoid_relay_data); + } + + #[test] + fn foreign_context_resources_are_assembled_in_core() { + let mut parent_snapshot = PeerRuntimeSnapshot::default(); + parent_snapshot.runtime.core.node.hostname = Some("parent".to_owned()); + parent_snapshot.runtime.stun_info = StunInfo { + public_ip: vec!["198.51.100.1".to_owned()], + ..Default::default() + }; + parent_snapshot + .runtime + .host_routing + .local_exit_node_fallback = true; + parent_snapshot.flags.enable_relay_foreign_network_kcp = true; + parent_snapshot.flags.enable_relay_foreign_network_quic = false; + parent_snapshot.flags.socket_mark = Some(7); + parent_snapshot.hmac_secret_digest = true; + parent_snapshot.runtime.feature_flags = PeerFeatureFlag { + kcp_input: false, + no_relay_kcp: false, + support_conn_list_sync: false, + quic_input: false, + no_relay_quic: false, + need_p2p: true, + disable_p2p: true, + ipv6_public_addr_provider: true, + ..Default::default() + }; + let parent_config = CoreRuntimeConfigStore::new( + CoreRuntimeConfig::default(), + Arc::new(parent_snapshot.clone()), + ); + let parent = Arc::new(CorePeerContext::new( + parent_config.clone(), + Arc::new(()), + CorePeerContextAdapters { + stun_info_source: None, + events: Arc::new(()), + credential_storage: None, + }, + )); + let network = NetworkIdentity { + network_name: "foreign".to_owned(), + network_secret: Some("secret".to_owned()), + network_secret_digest: None, + }; + let mut defaults = FlagsInConfig::default(); + defaults.mtu = 1400; + defaults.relay_network_whitelist = "baseline".to_owned(); + let foreign = build_foreign_peer_context(&network, &parent, false, defaults); + + assert!(Arc::ptr_eq( + &parent.stats_manager(), + &foreign.stats_manager(), + )); + assert!(!Arc::ptr_eq( + &parent.credential_manager(), + &foreign.credential_manager(), + )); + assert!(!Arc::ptr_eq( + &parent.trusted_key_manager(), + &foreign.trusted_key_manager(), + )); + assert_eq!(foreign.network_name(), "foreign"); + assert_eq!(foreign.hostname(), "PublicServer_parent"); + assert!(foreign.secure_mode().is_none()); + assert!(!foreign.flags().disable_relay_kcp); + assert!(foreign.flags().disable_relay_quic); + assert_eq!(foreign.flags().socket_mark, Some(7)); + assert_eq!(foreign.flags().mtu, 1400); + assert_eq!(foreign.flags().relay_network_whitelist, "baseline"); + assert!(foreign.feature_flags().is_public_server); + assert!(foreign.feature_flags().avoid_relay_data); + assert!(!foreign.feature_flags().kcp_input); + assert!(!foreign.feature_flags().no_relay_kcp); + assert!(!foreign.feature_flags().support_conn_list_sync); + assert!(!foreign.feature_flags().quic_input); + assert!(!foreign.feature_flags().no_relay_quic); + assert!(foreign.feature_flags().need_p2p); + assert!(foreign.feature_flags().disable_p2p); + assert!(foreign.feature_flags().ipv6_public_addr_provider); + assert_eq!(foreign.stun_info().public_ip, vec!["198.51.100.1"]); + assert!(foreign.host_routing_policy().local_exit_node_fallback); + assert!(foreign.hmac_secret_digest()); + + parent_snapshot.runtime.stun_info.public_ip = vec!["203.0.113.2".to_owned()]; + parent_config.update_peer(Arc::new(parent_snapshot)); + assert_eq!(foreign.stun_info().public_ip, vec!["203.0.113.2"]); + + foreign.record_control_tx("foreign", 64); + let labels = LabelSet::new().with_label_type(LabelType::NetworkName("foreign".to_owned())); + assert_eq!( + parent + .stats_manager() + .get_metric(MetricName::TrafficControlBytesTx, &labels) + .unwrap() + .value, + 64 + ); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/meshport_optimization.rs b/vendor/easytier/easytier-core/src/peers/meshport_optimization.rs new file mode 100644 index 0000000..bf5caef --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/meshport_optimization.rs @@ -0,0 +1,236 @@ +//! MeshPort local policy; no wire-format changes. +use serde::{Deserialize, Serialize}; +use std::time::{Duration, Instant}; +#[derive(Clone, Debug, Serialize, Deserialize)] +#[serde(default, deny_unknown_fields)] +pub struct OptimizationPolicy { + pub mode: Mode, + pub min_improvement_ms: f64, + pub min_improvement_ratio: f64, + pub hold_seconds: u64, + pub cooldown_seconds: u64, + pub prefer_udp: bool, + pub relay_peer_ids: Vec, +} +#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)] +#[serde(rename_all = "snake_case")] +pub enum Mode { + #[default] + Adaptive, + Direct, + Latency, + Hop, +} +impl Default for OptimizationPolicy { + fn default() -> Self { + Self { + mode: Mode::Adaptive, + min_improvement_ms: 15.0, + min_improvement_ratio: 0.15, + hold_seconds: 10, + cooldown_seconds: 30, + prefer_udp: true, + relay_peer_ids: vec![], + } + } +} +impl OptimizationPolicy { + pub fn validate(&self) -> Result<(), &'static str> { + if !self.min_improvement_ms.is_finite() + || !(0.0..=1000.0).contains(&self.min_improvement_ms) + || !self.min_improvement_ratio.is_finite() + || !(0.0..=0.9).contains(&self.min_improvement_ratio) + || self.hold_seconds > 300 + || self.cooldown_seconds > 600 + || self.relay_peer_ids.len() > 64 + { + Err("invalid routing optimization thresholds") + } else { + Ok(()) + } + } +} +#[derive(Default)] +pub struct Decision { + current: Option, + candidate: Option<(u32, Instant)>, + switched_at: Option, +} +impl Decision { + pub fn choose( + &mut self, + policy: &OptimizationPolicy, + dst: u32, + candidate: Option, + direct_ms: Option, + relay_ms: Option, + now: Instant, + ) -> Option { + let candidate = candidate.filter(|id| { + *id == dst || policy.relay_peer_ids.is_empty() || policy.relay_peer_ids.contains(id) + }); + // Availability wins over cooldown. Unknown RTT still permits a live direct link. + if direct_ms.is_none() { + self.current = candidate; + self.candidate = None; + return candidate; + } + if policy.mode == Mode::Direct || policy.mode == Mode::Hop { + self.current = Some(dst); + return Some(dst); + } + if policy.mode == Mode::Latency { + self.current = candidate.or(Some(dst)); + return self.current; + } + let direct = direct_ms.unwrap(); + let better = candidate.filter(|id| *id != dst).filter(|_| { + relay_ms.is_some_and(|relay| { + direct > 0.0 + && relay > 0.0 + && direct - relay >= policy.min_improvement_ms + && (direct - relay) / direct >= policy.min_improvement_ratio + }) + }); + if self + .current + .is_some_and(|id| id != dst && Some(id) != candidate) + { + self.current = Some(dst); + self.switched_at = None; + } + if self.current.is_none() { + self.current = Some(dst); + } + if let Some(gateway) = better { + let since = match self.candidate { + Some((id, since)) if id == gateway => since, + _ => { + self.candidate = Some((gateway, now)); + now + } + }; + if now.duration_since(since) >= Duration::from_secs(policy.hold_seconds) + && self.switched_at.is_none_or(|t| { + now.duration_since(t) >= Duration::from_secs(policy.cooldown_seconds) + }) + && self.current != Some(gateway) + { + self.current = Some(gateway); + self.switched_at = Some(now); + } + } else { + self.candidate = None; + if self.current != Some(dst) + && self.switched_at.is_none_or(|t| { + now.duration_since(t) >= Duration::from_secs(policy.cooldown_seconds) + }) + { + self.current = Some(dst); + self.switched_at = Some(now); + } + } + self.current + } +} + +#[cfg(test)] +mod tests { + use super::*; + #[test] + fn close_quality_stays_direct_and_large_gain_must_persist() { + let p = OptimizationPolicy::default(); + let mut d = Decision::default(); + let now = Instant::now(); + assert_eq!( + d.choose(&p, 1, Some(2), Some(194.0), Some(190.0), now), + Some(1) + ); + assert_eq!( + d.choose(&p, 1, Some(2), Some(194.0), Some(150.0), now), + Some(1) + ); + assert_eq!( + d.choose( + &p, + 1, + Some(2), + Some(194.0), + Some(150.0), + now + Duration::from_secs(9) + ), + Some(1) + ); + assert_eq!( + d.choose( + &p, + 1, + Some(2), + Some(194.0), + Some(150.0), + now + Duration::from_secs(10) + ), + Some(2) + ); + assert_eq!( + d.choose( + &p, + 1, + Some(2), + Some(194.0), + Some(210.0), + now + Duration::from_secs(11) + ), + Some(2) + ); + assert_eq!( + d.choose( + &p, + 1, + Some(2), + Some(194.0), + Some(210.0), + now + Duration::from_secs(40) + ), + Some(1) + ); + } + #[test] + fn failed_path_bypasses_cooldown_and_pool_rejects_unlisted_relay() { + let p = OptimizationPolicy { + hold_seconds: 0, + relay_peer_ids: vec![2], + ..Default::default() + }; + let mut d = Decision::default(); + let now = Instant::now(); + assert_eq!( + d.choose(&p, 1, Some(3), Some(200.0), Some(100.0), now), + Some(1) + ); + assert_eq!( + d.choose(&p, 1, Some(2), Some(200.0), Some(100.0), now), + Some(2) + ); + assert_eq!(d.choose(&p, 1, None, Some(200.0), None, now), Some(1)); + assert_eq!(d.choose(&p, 1, Some(2), None, Some(100.0), now), Some(2)); + assert_eq!(d.choose(&p, 1, Some(3), None, Some(100.0), now), None); + } + #[test] + fn unknown_direct_rtt_does_not_trigger_relay_and_bad_config_is_rejected() { + let mut d = Decision::default(); + let p = OptimizationPolicy::default(); + assert_eq!( + d.choose(&p, 1, Some(2), Some(0.0), Some(10.0), Instant::now()), + Some(1) + ); + assert!( + OptimizationPolicy { + min_improvement_ratio: 1.5, + ..p + } + .validate() + .is_err() + ); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/mod.rs b/vendor/easytier/easytier-core/src/peers/mod.rs new file mode 100644 index 0000000..3091220 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/mod.rs @@ -0,0 +1,182 @@ +pub(crate) mod acl; +pub(crate) mod admission; +pub(crate) mod attached; +pub(crate) mod conn; +pub mod context; +pub mod credential_manager; +pub mod error; +pub mod foreign_network; +pub mod meshport_optimization; +pub mod peer_center; +pub mod peer_manager; +pub(crate) mod peer_rpc; +pub mod public_ipv6; +pub(crate) mod relay_peer_map; +pub(crate) mod route; +pub(crate) mod traffic_metrics; +mod util; +pub(crate) mod whitelist; + +#[cfg(test)] +pub(crate) mod test_support; +#[cfg(test)] +mod tests; + +use crate::packet::ZCPacket; +use tokio::sync::mpsc::error::{SendError, TryRecvError, TrySendError}; + +use self::conn::peer_conn::PeerConnId; +use crate::config::PeerId; + +/// The local entry point that created a peer connection. +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(crate) enum PeerConnectionOrigin { + Manual, + Direct, + Listener, + TcpHolePunch, + UdpHolePunch, + Attached, +} + +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(crate) enum PeerPacketIngress { + Local, + Peer { + peer_id: PeerId, + conn_id: PeerConnId, + origin: PeerConnectionOrigin, + }, +} + +impl PeerPacketIngress { + pub(crate) fn is_attached(self) -> bool { + matches!( + self, + Self::Peer { + origin: PeerConnectionOrigin::Attached, + .. + } + ) + } + + pub(crate) fn peer_connection(self) -> Option<(PeerId, PeerConnId)> { + match self { + Self::Local => None, + Self::Peer { + peer_id, conn_id, .. + } => Some((peer_id, conn_id)), + } + } +} + +#[derive(Debug)] +pub(crate) struct PeerPacketEnvelope { + packet: ZCPacket, + ingress: PeerPacketIngress, +} + +impl PeerPacketEnvelope { + fn local(packet: ZCPacket) -> Self { + Self { + packet, + ingress: PeerPacketIngress::Local, + } + } + + fn from_peer(packet: ZCPacket, ingress: PeerPacketIngress) -> Self { + debug_assert!(matches!(ingress, PeerPacketIngress::Peer { .. })); + Self { packet, ingress } + } + + pub(crate) fn into_parts(self) -> (ZCPacket, PeerPacketIngress) { + (self.packet, self.ingress) + } +} + +#[derive(Clone)] +pub struct PacketRecvChan(tokio::sync::mpsc::Sender); + +impl PacketRecvChan { + /// Injects a packet produced by a local subsystem. Local injection never carries + /// the privileges of an attached peer connection. + pub async fn send(&self, packet: ZCPacket) -> Result<(), SendError> { + self.0 + .send(PeerPacketEnvelope::local(packet)) + .await + .map_err(|error| SendError(error.0.packet)) + } +} + +pub struct PacketRecvChanReceiver(tokio::sync::mpsc::Receiver); + +impl PacketRecvChanReceiver { + pub async fn recv(&mut self) -> Option { + self.0.recv().await.map(|envelope| envelope.packet) + } +} + +pub fn create_packet_recv_chan() -> (PacketRecvChan, PacketRecvChanReceiver) { + let (sender, receiver) = tokio::sync::mpsc::channel(128); + (PacketRecvChan(sender), PacketRecvChanReceiver(receiver)) +} + +pub(crate) async fn send_peer_packet_to_chan( + sender: &PacketRecvChan, + packet: ZCPacket, + ingress: PeerPacketIngress, +) -> Result<(), SendError> { + let envelope = PeerPacketEnvelope::from_peer(packet, ingress); + match sender.0.try_send(envelope) { + Ok(()) => Ok(()), + Err(TrySendError::Full(envelope)) => sender + .0 + .send(envelope) + .await + .map_err(|error| SendError(error.0.packet)), + Err(TrySendError::Closed(envelope)) => Err(SendError(envelope.packet)), + } +} + +pub(crate) async fn recv_packet_envelope_from_chan( + packet_recv_chan_receiver: &mut PacketRecvChanReceiver, +) -> Result { + match packet_recv_chan_receiver.0.try_recv() { + Ok(packet) => Ok(packet), + Err(TryRecvError::Empty) => packet_recv_chan_receiver + .0 + .recv() + .await + .ok_or(anyhow::anyhow!("recv_packet_from_chan failed")), + Err(TryRecvError::Disconnected) => Err(anyhow::anyhow!("recv_packet_from_chan failed")), + } +} + +pub async fn recv_packet_from_chan( + packet_recv_chan_receiver: &mut PacketRecvChanReceiver, +) -> Result { + recv_packet_envelope_from_chan(packet_recv_chan_receiver) + .await + .map(|envelope| envelope.packet) +} + +#[async_trait::async_trait] +#[auto_impl::auto_impl(Arc)] +pub trait PeerPacketFilter { + async fn try_process_packet_from_peer(&self, zc_packet: ZCPacket) -> Option { + Some(zc_packet) + } +} + +#[async_trait::async_trait] +#[auto_impl::auto_impl(Arc)] +pub trait NicPacketFilter { + async fn try_process_packet_from_nic(&self, data: &mut ZCPacket) -> bool; + + fn id(&self) -> String { + format!("{:p}", self) + } +} + +pub type BoxPeerPacketFilter = Box; +pub type BoxNicPacketFilter = Box; diff --git a/vendor/easytier/easytier-core/src/peers/peer_center/instance.rs b/vendor/easytier/easytier-core/src/peers/peer_center/instance.rs new file mode 100644 index 0000000..8929331 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/peer_center/instance.rs @@ -0,0 +1,420 @@ +use std::{ + collections::BTreeSet, + sync::{Arc, Weak}, + time::{Duration, Instant}, +}; + +use crossbeam_utils::atomic::AtomicCell; +use futures::Future; +use std::sync::RwLock; +use tokio::sync::Mutex; +use tokio::task::JoinSet; +use tracing::Instrument; + +use crate::{ + config::PeerId, + peers::{ + peer_rpc::PeerRpcManager, + route::{RouteCostCalculator, RouteCostCalculatorInterface}, + }, + proto::{ + core_peer::peer::Route as CoreRoute, + peer_rpc::{ + GetGlobalPeerMapRequest, GetGlobalPeerMapResponse, GlobalPeerMap, PeerCenterRpc, + PeerCenterRpcClientFactory, PeerCenterRpcServer, PeerInfoForGlobalMap, + ReportPeersRequest, ReportPeersResponse, + }, + rpc_types::{self, controller::BaseController}, + }, +}; + +use super::{Digest, Error, server::PeerCenterServer}; + +#[async_trait::async_trait] +#[auto_impl::auto_impl(&, Arc, Box)] +pub trait PeerCenterPeerManagerTrait: Send + Sync + 'static { + async fn list_peers(&self) -> PeerInfoForGlobalMap; + fn my_peer_id(&self) -> PeerId; + fn network_name(&self) -> String; + fn get_rpc_mgr(&self) -> Weak; + async fn list_routes(&self) -> Vec; +} + +struct PeerCenterBase { + peer_mgr: Arc, + my_peer_id: PeerId, + tasks: Mutex>, + lock: Arc>, +} + +struct PeridicJobCtx { + my_peer_id: PeerId, + center_peer: AtomicCell, + job_ctx: T, +} + +impl PeerCenterBase { + pub async fn init(&self) -> Result<(), Error> { + let Some(rpc_mgr) = self.peer_mgr.get_rpc_mgr().upgrade() else { + return Err(Error::Shutdown); + }; + rpc_mgr.rpc_server().registry().register( + PeerCenterRpcServer::new(PeerCenterServer::new()), + &self.peer_mgr.network_name(), + ); + Ok(()) + } + + async fn select_center_peer(peer_mgr: &dyn PeerCenterPeerManagerTrait) -> Option { + let peers = peer_mgr.list_routes().await; + if peers.is_empty() { + return None; + } + // find peer with alphabetical smallest id. + let mut min_peer = peer_mgr.my_peer_id(); + for peer in peers + .iter() + .filter(|r| r.feature_flag.map(|r| !r.is_public_server).unwrap_or(true)) + { + let peer_id = peer.peer_id; + if peer_id < min_peer { + min_peer = peer_id; + } + } + Some(min_peer) + } + + async fn init_periodic_job< + T: Send + Sync + 'static + Clone, + Fut: Future> + Send + 'static, + >( + &self, + job_ctx: T, + job_fn: impl Fn( + Box + Send>, + Arc>, + ) -> Fut + + Send + + Sync + + 'static, + ) { + let my_peer_id = self.my_peer_id; + let peer_mgr = self.peer_mgr.clone(); + let lock = self.lock.clone(); + self.tasks.lock().await.spawn( + async move { + let ctx = Arc::new(PeridicJobCtx { + my_peer_id, + center_peer: AtomicCell::new(PeerId::default()), + job_ctx, + }); + loop { + let Some(center_peer) = Self::select_center_peer(&peer_mgr).await else { + tracing::trace!("no center peer found, sleep 1 second"); + crate::foundation::time::sleep(Duration::from_secs(1)).await; + continue; + }; + let Some(rpc_mgr) = peer_mgr.get_rpc_mgr().upgrade() else { + tracing::error!("rpc manager is shutdown, exit periodic job"); + return; + }; + + ctx.center_peer.store(center_peer); + tracing::trace!(?center_peer, "run periodic job"); + let _g = lock.lock().await; + let stub = rpc_mgr + .rpc_client() + .scoped_client::>( + my_peer_id, + center_peer, + peer_mgr.network_name(), + ); + let ret = job_fn(stub, ctx.clone()).await; + drop(_g); + + let Ok(sleep_time_ms) = ret else { + tracing::error!("periodic job to center server rpc failed: {:?}", ret); + crate::foundation::time::sleep(Duration::from_secs(3)).await; + continue; + }; + + if sleep_time_ms > 0 { + crate::foundation::time::sleep(Duration::from_millis(sleep_time_ms as u64)) + .await; + } + } + } + .instrument(tracing::info_span!("periodic_job", ?my_peer_id)), + ); + } + + pub fn new(peer_mgr: Arc) -> Self { + let my_peer_id = peer_mgr.my_peer_id(); + PeerCenterBase { + peer_mgr, + my_peer_id, + tasks: Mutex::new(JoinSet::new()), + lock: Arc::new(Mutex::new(())), + } + } + + async fn stop(&self) { + let mut tasks = self.tasks.lock().await; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + } +} + +#[derive(Clone)] +pub struct PeerCenterInstanceService { + global_peer_map: Arc>, + global_peer_map_digest: Arc>, +} + +#[async_trait::async_trait] +impl PeerCenterRpc for PeerCenterInstanceService { + type Controller = BaseController; + + async fn get_global_peer_map( + &self, + _: BaseController, + _: GetGlobalPeerMapRequest, + ) -> Result { + let global_peer_map = self.global_peer_map.read().unwrap(); + Ok(GetGlobalPeerMapResponse { + global_peer_map: global_peer_map.map.clone(), + digest: Some(self.global_peer_map_digest.load()), + }) + } + + async fn report_peers( + &self, + _: BaseController, + _req: ReportPeersRequest, + ) -> Result { + Err(anyhow::anyhow!("not implemented").into()) + } +} + +pub struct PeerCenterInstance { + peer_mgr: Arc, + + client: Arc, + global_peer_map: Arc>, + global_peer_map_digest: Arc>, + global_peer_map_update_time: Arc>, +} + +impl PeerCenterInstance { + pub fn new(peer_mgr: Arc) -> Self { + PeerCenterInstance { + peer_mgr: peer_mgr.clone(), + client: Arc::new(PeerCenterBase::new(peer_mgr.clone())), + global_peer_map: Arc::new(RwLock::new(GlobalPeerMap::default())), + global_peer_map_digest: Arc::new(AtomicCell::new(Digest::default())), + global_peer_map_update_time: Arc::new(AtomicCell::new(Instant::now())), + } + } + + pub fn global_peer_map_snapshot(&self) -> GetGlobalPeerMapResponse { + GetGlobalPeerMapResponse { + global_peer_map: self.global_peer_map.read().unwrap().map.clone(), + digest: Some(self.global_peer_map_digest.load()), + } + } + + pub async fn init(&self) { + self.client.init().await.unwrap(); + self.init_get_global_info_job().await; + self.init_report_peers_job().await; + } + + pub async fn stop(&self) { + self.client.stop().await; + } + + async fn init_get_global_info_job(&self) { + struct Ctx { + global_peer_map: Arc>, + global_peer_map_digest: Arc>, + global_peer_map_update_time: Arc>, + } + + let ctx = Arc::new(Ctx { + global_peer_map: self.global_peer_map.clone(), + global_peer_map_digest: self.global_peer_map_digest.clone(), + global_peer_map_update_time: self.global_peer_map_update_time.clone(), + }); + + self.client + .init_periodic_job(ctx, |client, ctx| async move { + if ctx + .job_ctx + .global_peer_map_update_time + .load() + .elapsed() + .as_secs() + > 120 + { + ctx.job_ctx.global_peer_map_digest.store(Digest::default()); + } + + let ret = client + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { + digest: ctx.job_ctx.global_peer_map_digest.load(), + }, + ) + .await; + + let Ok(resp) = ret else { + tracing::error!( + "get global info from center server got error result: {:?}", + ret + ); + return Ok(10000); + }; + + if resp == GetGlobalPeerMapResponse::default() { + // digest match, no need to update + return Ok(15000); + } + + tracing::info!( + "get global info from center server: {:?}, digest: {:?}", + resp.global_peer_map, + resp.digest + ); + + *ctx.job_ctx.global_peer_map.write().unwrap() = GlobalPeerMap { + map: resp.global_peer_map, + }; + ctx.job_ctx + .global_peer_map_digest + .store(resp.digest.unwrap_or_default()); + ctx.job_ctx + .global_peer_map_update_time + .store(Instant::now()); + + Ok(15000) + }) + .await; + } + + async fn init_report_peers_job(&self) { + struct Ctx { + peer_mgr: Arc, + last_report_peers: Mutex>, + + last_center_peer: AtomicCell, + last_report_time: AtomicCell, + } + let ctx = Arc::new(Ctx { + peer_mgr: self.peer_mgr.clone(), + last_report_peers: Mutex::new(BTreeSet::new()), + last_center_peer: AtomicCell::new(PeerId::default()), + last_report_time: AtomicCell::new(Instant::now()), + }); + + self.client + .init_periodic_job(ctx, |client, ctx| async move { + let my_node_id = ctx.my_peer_id; + let peers = ctx.job_ctx.peer_mgr.list_peers().await; + let peer_list = peers.direct_peers.keys().copied().collect(); + let job_ctx = &ctx.job_ctx; + + // only report when: + // 1. center peer changed + // 2. last report time is more than 60 seconds + // 3. peers changed + if ctx.center_peer.load() == ctx.job_ctx.last_center_peer.load() + && job_ctx.last_report_time.load().elapsed().as_secs() < 60 + && *job_ctx.last_report_peers.lock().await == peer_list + { + return Ok(5000); + } + + let ret = client + .report_peers( + BaseController::default(), + ReportPeersRequest { + my_peer_id: my_node_id, + peer_infos: Some(peers), + }, + ) + .await; + + if ret.is_ok() { + ctx.job_ctx.last_center_peer.store(ctx.center_peer.load()); + *ctx.job_ctx.last_report_peers.lock().await = peer_list; + ctx.job_ctx.last_report_time.store(Instant::now()); + } else { + tracing::error!("report peers to center server got error result: {:?}", ret); + } + + Ok(5000) + }) + .await; + } + + pub fn get_rpc_service(&self) -> PeerCenterInstanceService { + PeerCenterInstanceService { + global_peer_map: self.global_peer_map.clone(), + global_peer_map_digest: self.global_peer_map_digest.clone(), + } + } + + pub fn get_cost_calculator(&self) -> RouteCostCalculator { + struct RouteCostCalculatorImpl { + global_peer_map: Arc>, + + global_peer_map_clone: GlobalPeerMap, + + last_update_time: AtomicCell, + global_peer_map_update_time: Arc>, + } + + impl RouteCostCalculatorImpl { + fn directed_cost(&self, src: PeerId, dst: PeerId) -> Option { + self.global_peer_map_clone + .map + .get(&src) + .and_then(|src_peer_info| src_peer_info.direct_peers.get(&dst)) + .map(|info| info.latency_ms) + } + } + + impl RouteCostCalculatorInterface for RouteCostCalculatorImpl { + fn calculate_cost(&self, src: PeerId, dst: PeerId) -> i32 { + if let Some(cost) = self.directed_cost(src, dst) { + return cost; + } + self.directed_cost(dst, src).unwrap_or(500) + } + + fn begin_update(&mut self) { + let global_peer_map = self.global_peer_map.read().unwrap(); + self.global_peer_map_clone = global_peer_map.clone(); + } + + fn end_update(&mut self) { + self.last_update_time + .store(self.global_peer_map_update_time.load()); + } + + fn need_update(&self) -> bool { + self.last_update_time.load() < self.global_peer_map_update_time.load() + } + } + + Box::new(RouteCostCalculatorImpl { + global_peer_map: self.global_peer_map.clone(), + global_peer_map_clone: GlobalPeerMap::default(), + last_update_time: AtomicCell::new( + self.global_peer_map_update_time.load() - Duration::from_secs(1), + ), + global_peer_map_update_time: self.global_peer_map_update_time.clone(), + }) + } +} diff --git a/vendor/easytier/easytier-core/src/peers/peer_center/mod.rs b/vendor/easytier/easytier-core/src/peers/peer_center/mod.rs new file mode 100644 index 0000000..26296fb --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/peer_center/mod.rs @@ -0,0 +1,21 @@ +// peer_center is used to collect peer info into one peer node. +// the center node is selected with the following rules: +// 1. has smallest peer id +// 2. TODO: has allow_to_be_center peer feature +// peer center is not guaranteed to be stable and can be changed when peer enter or leave. +// it's used to reduce the cost to exchange infos between peers. + +pub mod instance; +mod server; + +#[derive(thiserror::Error, Debug, serde::Deserialize, serde::Serialize)] +pub enum Error { + #[error("Digest not match, need provide full peer info to center server.")] + DigestMismatch, + #[error("Not center server")] + NotCenterServer, + #[error("Instance shutdown")] + Shutdown, +} + +pub type Digest = u64; diff --git a/vendor/easytier/easytier-core/src/peers/peer_center/server.rs b/vendor/easytier/easytier-core/src/peers/peer_center/server.rs new file mode 100644 index 0000000..e91f933 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/peer_center/server.rs @@ -0,0 +1,384 @@ +use std::{ + collections::BTreeMap, + hash::{Hash, Hasher}, + sync::Arc, +}; + +use parking_lot::RwLock; +use tokio::task::JoinSet; + +use crate::{ + config::PeerId, + proto::{ + peer_rpc::{ + GetGlobalPeerMapRequest, GetGlobalPeerMapResponse, PeerCenterRpc, PeerInfoForGlobalMap, + ReportPeersRequest, ReportPeersResponse, + }, + rpc_types::{self, controller::BaseController}, + }, +}; + +use super::Digest; + +#[derive(Debug, Clone)] +struct PeerCenterInfoEntry { + peer_info: PeerInfoForGlobalMap, + update_time: std::time::Instant, +} + +#[derive(Debug, Default)] +struct PeerCenterServerState { + peer_infos: BTreeMap, + digest: Digest, +} + +#[derive(Debug, Default)] +struct PeerCenterServerData { + state: RwLock, +} + +#[derive(Clone, Debug)] +pub struct PeerCenterServer { + data: Arc, + _tasks: Arc>, +} + +impl PeerCenterServer { + pub fn new() -> Self { + let data = Arc::new(PeerCenterServerData::default()); + let weak_data = Arc::downgrade(&data); + let mut tasks = JoinSet::new(); + tasks.spawn(async move { + loop { + crate::foundation::time::sleep(std::time::Duration::from_secs(10)).await; + let Some(data) = weak_data.upgrade() else { + break; + }; + PeerCenterServer::clean_outdated_peer_data(&data).await; + } + }); + + PeerCenterServer { + data, + _tasks: Arc::new(tasks), + } + } + + async fn clean_outdated_peer_data(data: &PeerCenterServerData) { + let mut state = data.state.write(); + let previous_len = state.peer_infos.len(); + state + .peer_infos + .retain(|_, entry| entry.update_time.elapsed() < std::time::Duration::from_secs(180)); + if state.peer_infos.len() != previous_len { + state.digest = Self::calc_global_digest_data(&state.peer_infos); + } + } + + fn calc_global_digest_data(peer_infos: &BTreeMap) -> Digest { + let mut hasher = std::collections::hash_map::DefaultHasher::new(); + peer_infos.len().hash(&mut hasher); + for (src_peer_id, entry) in peer_infos { + src_peer_id.hash(&mut hasher); + entry.peer_info.direct_peers.len().hash(&mut hasher); + for (dst_peer_id, peer_info) in &entry.peer_info.direct_peers { + dst_peer_id.hash(&mut hasher); + peer_info.latency_ms.hash(&mut hasher); + } + } + hasher.finish() + } +} + +#[async_trait::async_trait] +impl PeerCenterRpc for PeerCenterServer { + type Controller = BaseController; + + #[tracing::instrument()] + async fn report_peers( + &self, + _: BaseController, + req: ReportPeersRequest, + ) -> Result { + let my_peer_id = req.my_peer_id; + let peers = req.peer_infos.unwrap_or_default(); + + tracing::debug!("receive report_peers"); + + let data = &self.data; + let mut state = data.state.write(); + state.peer_infos.insert( + my_peer_id, + PeerCenterInfoEntry { + peer_info: peers, + update_time: std::time::Instant::now(), + }, + ); + state.digest = PeerCenterServer::calc_global_digest_data(&state.peer_infos); + + Ok(ReportPeersResponse::default()) + } + + #[tracing::instrument()] + async fn get_global_peer_map( + &self, + _: BaseController, + req: GetGlobalPeerMapRequest, + ) -> Result { + let digest = req.digest; + + let state = self.data.state.read(); + if digest == state.digest && digest != 0 { + return Ok(GetGlobalPeerMapResponse::default()); + } + + let global_peer_map = state + .peer_infos + .iter() + .map(|(peer_id, entry)| (*peer_id, entry.peer_info.clone())) + .collect(); + + Ok(GetGlobalPeerMapResponse { + global_peer_map, + digest: Some(state.digest), + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::proto::peer_rpc::DirectConnectedPeerInfo; + + #[tokio::test] + async fn server_clones_share_instance_data() { + let server = PeerCenterServer::new(); + let server_clone = server.clone(); + + let mut peers = PeerInfoForGlobalMap::default(); + peers + .direct_peers + .insert(100, DirectConnectedPeerInfo { latency_ms: 3 }); + + server + .report_peers( + BaseController::default(), + ReportPeersRequest { + my_peer_id: 99, + peer_infos: Some(peers), + }, + ) + .await + .unwrap(); + + let resp = server_clone + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { digest: 0 }, + ) + .await + .unwrap(); + assert_eq!(1, resp.global_peer_map.len()); + assert!(resp.global_peer_map[&99].direct_peers.contains_key(&100)); + } + + #[tokio::test] + async fn independent_server_instances_do_not_share_data() { + let server_a = PeerCenterServer::new(); + let server_b = PeerCenterServer::new(); + + let mut peers = PeerInfoForGlobalMap::default(); + peers + .direct_peers + .insert(101, DirectConnectedPeerInfo { latency_ms: 5 }); + + server_a + .report_peers( + BaseController::default(), + ReportPeersRequest { + my_peer_id: 100, + peer_infos: Some(peers), + }, + ) + .await + .unwrap(); + + let resp_a = server_a + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { digest: 0 }, + ) + .await + .unwrap(); + assert_eq!(1, resp_a.global_peer_map.len()); + + let resp_b = server_b + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { digest: 0 }, + ) + .await + .unwrap(); + assert!(resp_b.global_peer_map.is_empty()); + } + + #[tokio::test] + async fn peer_report_replaces_removed_neighbors() { + let server = PeerCenterServer::new(); + let mut peers = PeerInfoForGlobalMap::default(); + peers + .direct_peers + .insert(100, DirectConnectedPeerInfo { latency_ms: 3 }); + server + .report_peers( + BaseController::default(), + ReportPeersRequest { + my_peer_id: 99, + peer_infos: Some(peers), + }, + ) + .await + .unwrap(); + let initial = server + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { digest: 0 }, + ) + .await + .unwrap(); + + server + .report_peers( + BaseController::default(), + ReportPeersRequest { + my_peer_id: 99, + peer_infos: Some(PeerInfoForGlobalMap::default()), + }, + ) + .await + .unwrap(); + let updated = server + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { + digest: initial.digest.unwrap(), + }, + ) + .await + .unwrap(); + + assert!( + updated.digest.is_some(), + "removed peer did not change digest" + ); + assert!( + updated + .global_peer_map + .get(&99) + .is_none_or(|peers| peers.direct_peers.is_empty()) + ); + } + + #[tokio::test] + async fn peer_latency_change_invalidates_digest() { + let server = PeerCenterServer::new(); + let mut peers = PeerInfoForGlobalMap::default(); + peers + .direct_peers + .insert(100, DirectConnectedPeerInfo { latency_ms: 3 }); + server + .report_peers( + BaseController::default(), + ReportPeersRequest { + my_peer_id: 99, + peer_infos: Some(peers), + }, + ) + .await + .unwrap(); + let initial = server + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { digest: 0 }, + ) + .await + .unwrap(); + + let mut peers = PeerInfoForGlobalMap::default(); + peers + .direct_peers + .insert(100, DirectConnectedPeerInfo { latency_ms: 30 }); + server + .report_peers( + BaseController::default(), + ReportPeersRequest { + my_peer_id: 99, + peer_infos: Some(peers), + }, + ) + .await + .unwrap(); + let updated = server + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { + digest: initial.digest.unwrap(), + }, + ) + .await + .unwrap(); + + assert_eq!( + updated.global_peer_map[&99].direct_peers[&100].latency_ms, + 30 + ); + } + + #[tokio::test] + async fn expired_peer_report_invalidates_digest() { + let server = PeerCenterServer::new(); + let mut peers = PeerInfoForGlobalMap::default(); + peers + .direct_peers + .insert(100, DirectConnectedPeerInfo { latency_ms: 3 }); + server + .report_peers( + BaseController::default(), + ReportPeersRequest { + my_peer_id: 99, + peer_infos: Some(peers), + }, + ) + .await + .unwrap(); + let initial = server + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { digest: 0 }, + ) + .await + .unwrap(); + { + let mut state = server.data.state.write(); + state.peer_infos.get_mut(&99).unwrap().update_time = + std::time::Instant::now() - std::time::Duration::from_secs(181); + } + + PeerCenterServer::clean_outdated_peer_data(&server.data).await; + let updated = server + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest { + digest: initial.digest.unwrap(), + }, + ) + .await + .unwrap(); + + assert!( + updated.digest.is_some(), + "expired peer did not change digest" + ); + assert!(!updated.global_peer_map.contains_key(&99)); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/peer_manager.rs b/vendor/easytier/easytier-core/src/peers/peer_manager.rs new file mode 100644 index 0000000..7188868 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/peer_manager.rs @@ -0,0 +1,4582 @@ +use std::time::{Duration, SystemTime}; +use std::{ + collections::BTreeSet, + net::{IpAddr, Ipv4Addr, Ipv6Addr}, + sync::{ + Arc, Weak, + atomic::{AtomicBool, Ordering}, + }, +}; + +use anyhow::Context; +use arc_swap::ArcSwap; +use dashmap::DashMap; +use quanta::Instant; +use serde::{Deserialize, Serialize}; +use tokio::sync::{ + Mutex, RwLock, + mpsc::{self, UnboundedReceiver, UnboundedSender}, +}; +use tokio::task::JoinSet; +use url::Url; + +use crate::{ + config::{ + P2pPolicyFlags, PeerId, ProxyNetworkConfig, + peers::{ + AclRuleConfig, HostRoutingPolicy, PeerGroupIdentity, PeerRuntimeConfig, + PeerRuntimeSnapshot, + }, + runtime::{CoreInstanceRuntimeConfig, CoreRuntimeConfigStore}, + toml::ManagedCredentialConfig, + }, + events::CoreEventSink, + foundation::task::ExternalTaskSignal, + host::packet::{HostPacket, HostPacketSender}, + packet::{ + CompressorAlgo, PacketType, ZCPacket, + compressor::{Compressor as _, DefaultCompressor}, + }, + proto::common::{FlagsInConfig, PeerFeatureFlag, StunInfo, Url as ProtoUrl}, + proto::core_peer::peer::{ListPublicIpv6InfoResponse, PeerConnInfo, Route as CoreRoute}, + tunnel::{ + Tunnel, + encrypt::{ + Encryptor, NullCipher, create_encryptor, derive_key_128, derive_key_256, + validate_algorithm, + }, + }, +}; + +use super::{ + BoxNicPacketFilter, BoxPeerPacketFilter, PacketRecvChanReceiver, PeerConnectionOrigin, + PeerPacketFilter, PeerPacketIngress, + acl::AclFilter, + conn::{ + peer_conn::{PeerConn, PeerConnId}, + peer_map::{PeerMap, direct_peer_info}, + peer_session::PeerSessionStore, + }, + context::{ + ArcPeerContext, CorePeerContext, CorePeerContextAdapters, NetworkIdentity, PeerContext, + PeerPacketPolicy, PeerStunInfoSource, + }, + credential_manager::{CredentialManager, CredentialStorage}, + error::Error, + foreign_network::client::ForeignNetworkClient, + foreign_network::{ForeignNetworkEntryInfo, ForeignNetworkManager, ForeignNetworkRpcRegistrar}, + peer_center::instance::PeerCenterPeerManagerTrait, + peer_rpc::{PeerRpcManager, PeerRpcManagerTransport}, + public_ipv6::{CorePublicIpv6Runtime, PublicIpv6Runtime}, + recv_packet_envelope_from_chan, + relay_peer_map::RelayPeerMap, + route::{ + ArcRoute, DisabledRoute, ForeignNetworkRouteInfoMap, NextHopPolicy, Route, RouteInterface, + peer_ospf_route::PeerRoute, + }, + traffic_metrics::{ + InstanceLabelKind, LogicalTrafficMetrics, TrafficKind, TrafficMetricRecorder, + route_peer_info_instance_id, traffic_kind, + }, + util::shrink_dashmap, +}; +use crate::foundation::stats::{CounterHandle, LabelSet, LabelType, MetricName, StatsManager}; +use crate::proto::peer_rpc::{ + ForeignNetworkRouteInfoEntry, ForeignNetworkRouteInfoKey, GetIpListResponse, PeerIdentityType, + PeerInfoForGlobalMap, RouteForeignNetworkInfos, RouteForeignNetworkSummary, +}; + +#[derive(Debug, Clone)] +pub struct PeerSnapshot { + pub peer_id: PeerId, + pub default_conn_id: Option, + pub directly_connected_conns: Vec, + pub conns: Vec, +} + +#[derive(Debug, Clone)] +pub struct NodeSnapshot { + pub peer_id: PeerId, + pub ipv4_addr: Option, + pub proxy_networks: Vec, + pub hostname: String, + pub stun_info: StunInfo, + pub instance_id: uuid::Uuid, + pub listeners: Vec, + pub version: String, + pub feature_flags: PeerFeatureFlag, + pub ip_list: GetIpListResponse, + pub public_ipv6_addr: Option, + pub ipv6_public_addr_prefix: Option, +} + +struct RpcTransport { + my_peer_id: PeerId, + peers: Weak, + + packet_recv: Mutex>, + peer_rpc_tspt_sender: UnboundedSender, + + encryptor: Arc, + is_secure_mode_enabled: bool, +} + +impl RpcTransport { + pub fn new( + my_peer_id: PeerId, + peers: Weak, + encryptor: Arc, + is_secure_mode_enabled: bool, + ) -> Arc { + let (peer_rpc_tspt_sender, peer_rpc_tspt_recv) = mpsc::unbounded_channel(); + Arc::new(Self { + my_peer_id, + peers, + packet_recv: Mutex::new(peer_rpc_tspt_recv), + peer_rpc_tspt_sender, + encryptor, + is_secure_mode_enabled, + }) + } + + pub fn packet_sender(&self) -> UnboundedSender { + self.peer_rpc_tspt_sender.clone() + } +} + +#[async_trait::async_trait] +impl PeerRpcManagerTransport for RpcTransport { + fn my_peer_id(&self) -> PeerId { + self.my_peer_id + } + + async fn send(&self, mut msg: ZCPacket, dst_peer_id: PeerId) -> anyhow::Result<()> { + let peers = self + .peers + .upgrade() + .ok_or_else(|| anyhow::anyhow!("peer map is gone"))?; + // NOTE: if route info is not exchanged, this will return None. treat it as public server. + let is_dst_peer_public_server = peers + .get_route_peer_info(dst_peer_id) + .await + .and_then(|x| x.feature_flag.map(|x| x.is_public_server)) + // if dst is directly connected, it's must not public server + .unwrap_or(!peers.has_peer(dst_peer_id)); + if !is_dst_peer_public_server && !self.is_secure_mode_enabled { + self.encryptor + .encrypt(&mut msg) + .with_context(|| "encrypt failed")?; + } + // send to self and this packet will be forwarded in peer_recv loop + peers.send_msg_directly(msg, self.my_peer_id).await?; + Ok(()) + } + + async fn recv(&self) -> anyhow::Result { + if let Some(o) = self.packet_recv.lock().await.recv().await { + Ok(o) + } else { + Err(anyhow::anyhow!("rpc transport is closed")) + } + } +} + +pub(crate) fn get_next_hop_policy(is_latency_first: bool) -> NextHopPolicy { + if is_latency_first { + NextHopPolicy::LeastCost + } else { + NextHopPolicy::LeastHop + } +} + +fn random_peer_id() -> PeerId { + loop { + let peer_id = rand::random(); + if peer_id != 0 { + return peer_id; + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +pub enum RouteAlgoType { + Ospf, + None, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct PortablePeerManagerConfig { + pub snapshot: PeerRuntimeSnapshot, + pub route_algo: RouteAlgoType, + pub exit_nodes: Vec, + /// Defaults inherited by peer contexts created for foreign networks. + /// + /// This is explicit because those contexts participate in the same + /// handshake as the parent but do not inherit all parent policy flags. + pub foreign_context_default_flags: FlagsInConfig, +} + +impl PortablePeerManagerConfig { + pub fn new(mut runtime: PeerRuntimeConfig) -> Self { + let policy = &runtime.core.peer_policy; + let traffic = &runtime.core.traffic; + let flags = FlagsInConfig { + enable_encryption: policy.encryption_required, + encryption_algorithm: crate::config::EncryptionAlgorithm::default().to_string(), + disable_p2p: !policy.p2p_enabled, + relay_all_peer_rpc: policy.relay_peer_rpc, + disable_relay_data: !policy.relay_data, + latency_first: policy.latency_first, + data_compress_algo: crate::proto::common::CompressionAlgoPb::None.into(), + mtu: traffic.mtu.map(u32::from).unwrap_or_default(), + instance_recv_bps_limit: traffic.instance_recv_bps_limit.unwrap_or_default(), + foreign_relay_bps_limit: traffic.foreign_relay_bps_limit.unwrap_or_default(), + ..Default::default() + }; + runtime.feature_flags.disable_p2p = flags.disable_p2p; + runtime.feature_flags.avoid_relay_data |= flags.disable_relay_data; + let foreign_context_default_flags = flags.clone(); + Self { + snapshot: PeerRuntimeSnapshot::new(runtime, flags), + route_algo: RouteAlgoType::Ospf, + exit_nodes: Vec::new(), + foreign_context_default_flags, + } + } +} + +fn matching_group_memberships( + declarations: &[PeerGroupIdentity], + configured_groups: &[String], +) -> Vec { + let configured = configured_groups.iter().collect::>(); + declarations + .iter() + .filter(|declaration| configured.contains(&declaration.group_name)) + .cloned() + .collect() +} + +fn first_missing_group<'a>( + memberships: &[PeerGroupIdentity], + configured_groups: &'a [String], +) -> Option<&'a str> { + let resolved = memberships + .iter() + .map(|membership| membership.group_name.as_str()) + .collect::>(); + configured_groups + .iter() + .map(String::as_str) + .find(|group| !resolved.contains(group)) +} + +fn retain_runtime_owned_peer_state( + current: &CoreInstanceRuntimeConfig, + next: &mut CoreInstanceRuntimeConfig, + peer_id: PeerId, +) { + let next_peer = Arc::make_mut(&mut next.peer); + next_peer.runtime.core.node.peer_id = Some(peer_id); + next_peer.runtime.core.node.instance_id = current.peer.runtime.core.node.instance_id; + next_peer.runtime.stun_info = current.peer.runtime.stun_info.clone(); + if current.services.dhcp_ipv4 && next.services.dhcp_ipv4 { + next_peer.runtime.core.routes.ipv4 = current.peer.runtime.core.routes.ipv4.clone(); + } +} + +fn validate_portable_routes(routes: &crate::config::RouteConfig) -> anyhow::Result<()> { + if !routes.advertised_routes.is_empty() { + anyhow::bail!("portable peer manager does not support advertised routes yet"); + } + if !routes.foreign_networks.is_empty() { + anyhow::bail!("portable peer manager does not support foreign networks yet"); + } + if let Some(prefix) = &routes.ipv4 + && (!matches!(prefix.address, IpAddr::V4(_)) || prefix.prefix_len > 32) + { + anyhow::bail!("routes.ipv4 must contain a valid IPv4 prefix"); + } + if let Some(prefix) = &routes.ipv6 + && (!matches!(prefix.address, IpAddr::V6(_)) || prefix.prefix_len > 128) + { + anyhow::bail!("routes.ipv6 must contain a valid IPv6 prefix"); + } + for proxy in &routes.proxy_networks { + for (field, prefix) in [ + ("real", Some(&proxy.real)), + ("mapped", proxy.mapped.as_ref()), + ] { + let Some(prefix) = prefix else { + continue; + }; + let IpAddr::V4(address) = prefix.address else { + anyhow::bail!("proxy network {field} prefix must be IPv4"); + }; + if cidr::Ipv4Cidr::new(address, prefix.prefix_len).is_err() { + anyhow::bail!("proxy network {field} must be a valid IPv4 network prefix"); + } + } + } + Ok(()) +} + +pub(crate) enum RouteAlgoInst { + Ospf(Arc), + None, +} + +impl Clone for RouteAlgoInst { + fn clone(&self) -> Self { + match self { + RouteAlgoInst::Ospf(route) => RouteAlgoInst::Ospf(route.clone()), + RouteAlgoInst::None => RouteAlgoInst::None, + } + } +} + +impl RouteAlgoInst { + pub fn new( + route_algo: RouteAlgoType, + my_peer_id: PeerId, + context: ArcPeerContext, + public_ipv6_runtime: Arc, + peer_rpc_mgr: Arc, + ) -> Self { + match route_algo { + RouteAlgoType::Ospf => RouteAlgoInst::Ospf(PeerRoute::new( + my_peer_id, + context, + public_ipv6_runtime, + peer_rpc_mgr, + )), + RouteAlgoType::None => RouteAlgoInst::None, + } + } + + pub fn ospf_route(&self) -> Option> { + match self { + RouteAlgoInst::Ospf(route) => Some(route.clone()), + RouteAlgoInst::None => None, + } + } + + pub fn route_arc(&self) -> ArcRoute { + match self { + RouteAlgoInst::Ospf(route) => route.clone(), + RouteAlgoInst::None => Arc::new(DisabledRoute), + } + } +} + +fn network_secret_digest_is_empty(network: &NetworkIdentity) -> bool { + network + .network_secret_digest + .as_ref() + .is_none_or(|d| d.iter().all(|b| *b == 0)) +} + +pub(crate) async fn add_new_peer_conn( + peer_map: &PeerMap, + local_identity: &NetworkIdentity, + local_secure_mode: bool, + peer_conn: PeerConn, +) -> Result { + let peer_identity = peer_conn.get_network_identity(); + let conn_info = peer_conn.get_conn_info(); + let peer_secure_mode = !conn_info.noise_remote_static_pubkey.is_empty(); + + if local_secure_mode != peer_secure_mode { + return Err(Error::SecretKeyError( + "same-network peers must use the same secure mode".to_string(), + )); + } + + // For credential nodes, network_secret_digest is either None or all-zeros + // (all-zeros when received over the wire via handshake). + // In this case, only compare network_name. + let my_digest_empty = network_secret_digest_is_empty(local_identity); + let peer_digest_empty = network_secret_digest_is_empty(&peer_identity); + + let identity_ok = if my_digest_empty || peer_digest_empty { + // Credential node: only check network_name + local_identity.network_name == peer_identity.network_name + } else { + local_identity == &peer_identity + }; + + if !identity_ok { + return Err(Error::SecretKeyError( + "network identity not match".to_string(), + )); + } + let peer_id = peer_conn.get_peer_id(); + peer_map.add_new_peer_conn(peer_conn).await?; + Ok(peer_id) +} + +pub(crate) async fn close_untrusted_credential_peers( + peer_map: &PeerMap, + network_name: &str, + mut is_pubkey_trusted: F, +) where + F: FnMut(&[u8], &str) -> bool + Send, +{ + for peer_id in peer_map.list_peers() { + if !matches!( + peer_map.get_peer_identity_type(peer_id), + Some(PeerIdentityType::Credential) + ) { + continue; + } + let Some(peer) = peer_map.get_peer_by_id(peer_id) else { + continue; + }; + let Some(pubkey) = peer.get_peer_public_key() else { + continue; + }; + + if is_pubkey_trusted(&pubkey, network_name) { + continue; + } + + tracing::warn!(?peer_id, "closing untrusted credential peer"); + if let Err(e) = peer_map.close_peer(peer_id).await { + tracing::warn!(?e, ?peer_id, "failed to close untrusted credential peer"); + } + } +} + +struct NicPacketProcessor { + nic_channel: HostPacketSender, +} + +#[async_trait::async_trait] +impl PeerPacketFilter for NicPacketProcessor { + async fn try_process_packet_from_peer(&self, packet: ZCPacket) -> Option { + let hdr = packet.peer_manager_header().unwrap(); + if hdr.packet_type == PacketType::Data as u8 && !hdr.is_not_send_to_tun() { + if hdr.is_encrypted() || hdr.is_compressed() { + tracing::warn!( + from_peer_id = hdr.from_peer_id.get(), + to_peer_id = hdr.to_peer_id.get(), + encrypted = hdr.is_encrypted(), + compressed = hdr.is_compressed(), + "dropping packet before nic because it is not fully decoded" + ); + return None; + } + tracing::trace!(?packet, "send packet to nic channel"); + if let Err(error) = self + .nic_channel + .try_send(HostPacket::from_core_packet(packet)) + { + tracing::trace!( + ?error, + "dropping packet because nic channel cannot accept it" + ); + } + None + } else { + Some(packet) + } + } +} + +struct PeerRpcPacketProcessor { + peer_rpc_tspt_sender: UnboundedSender, +} + +#[async_trait::async_trait] +impl PeerPacketFilter for PeerRpcPacketProcessor { + async fn try_process_packet_from_peer(&self, packet: ZCPacket) -> Option { + let hdr = packet.peer_manager_header().unwrap(); + if hdr.packet_type == PacketType::TaRpc as u8 + || hdr.packet_type == PacketType::RpcReq as u8 + || hdr.packet_type == PacketType::RpcResp as u8 + { + self.peer_rpc_tspt_sender.send(packet).unwrap(); + None + } else { + Some(packet) + } + } +} + +#[derive(Clone)] +pub(crate) struct PeerPipelineEntry { + active: Option>, + filter: Arc, +} + +#[derive(Clone)] +pub(crate) struct NicPipelineEntry { + active: Option>, + filter: Arc, +} + +type PeerPacketPipeline = Arc>>; +type NicPacketPipeline = Arc>>; + +impl PeerPipelineEntry { + fn filter_if_active(&self) -> Option<&Arc> { + if self + .active + .as_ref() + .is_some_and(|active| !active.load(Ordering::Acquire)) + { + return None; + } + Some(&self.filter) + } +} + +impl NicPipelineEntry { + fn filter_if_active(&self) -> Option<&Arc> { + if self + .active + .as_ref() + .is_some_and(|active| !active.load(Ordering::Acquire)) + { + return None; + } + Some(&self.filter) + } +} + +#[derive(Clone)] +pub(crate) struct PipelineRegistrationGuard { + active: Arc, + unregister: Arc, +} + +impl PipelineRegistrationGuard { + pub fn close(&self) { + if self.active.swap(false, Ordering::AcqRel) { + (self.unregister)(); + } + } +} + +impl Drop for PipelineRegistrationGuard { + fn drop(&mut self) { + self.close(); + } +} + +fn permanent_peer_pipeline_entry(filter: BoxPeerPacketFilter) -> PeerPipelineEntry { + PeerPipelineEntry { + active: None, + filter: Arc::from(filter), + } +} + +fn permanent_nic_pipeline_entry(filter: BoxNicPacketFilter) -> NicPipelineEntry { + NicPipelineEntry { + active: None, + filter: Arc::from(filter), + } +} + +fn managed_peer_pipeline_entry( + filter: BoxPeerPacketFilter, + pipeline: &PeerPacketPipeline, +) -> (PeerPipelineEntry, PipelineRegistrationGuard) { + let active = Arc::new(AtomicBool::new(true)); + let weak_pipeline = Arc::downgrade(pipeline); + let registration = active.clone(); + ( + PeerPipelineEntry { + active: Some(active.clone()), + filter: Arc::from(filter), + }, + PipelineRegistrationGuard { + active, + unregister: Arc::new(move || { + let Some(pipeline) = weak_pipeline.upgrade() else { + return; + }; + pipeline.rcu(|current| { + Arc::new( + current + .iter() + .filter(|entry| { + entry + .active + .as_ref() + .is_none_or(|active| !Arc::ptr_eq(active, ®istration)) + }) + .cloned() + .collect(), + ) + }); + }), + }, + ) +} + +#[cfg(any(feature = "proxy-packet", test))] +fn managed_nic_pipeline_entry( + filter: BoxNicPacketFilter, + pipeline: &NicPacketPipeline, +) -> (NicPipelineEntry, PipelineRegistrationGuard) { + let active = Arc::new(AtomicBool::new(true)); + let weak_pipeline = Arc::downgrade(pipeline); + let registration = active.clone(); + ( + NicPipelineEntry { + active: Some(active.clone()), + filter: Arc::from(filter), + }, + PipelineRegistrationGuard { + active, + unregister: Arc::new(move || { + let Some(pipeline) = weak_pipeline.upgrade() else { + return; + }; + pipeline.rcu(|current| { + Arc::new( + current + .iter() + .filter(|entry| { + entry + .active + .as_ref() + .is_none_or(|active| !Arc::ptr_eq(active, ®istration)) + }) + .cloned() + .collect(), + ) + }); + }), + }, + ) +} + +fn append_peer_pipeline(pipeline: &PeerPacketPipeline, entry: PeerPipelineEntry) { + pipeline.rcu(|current| { + let mut next = Vec::with_capacity(current.len() + 1); + next.extend( + current + .iter() + .filter(|entry| { + entry + .active + .as_ref() + .is_none_or(|active| active.load(Ordering::Acquire)) + }) + .cloned(), + ); + next.push(entry.clone()); + Arc::new(next) + }); +} + +fn append_nic_pipeline(pipeline: &NicPacketPipeline, entry: NicPipelineEntry) { + pipeline.rcu(|current| { + let mut next = Vec::with_capacity(current.len() + 1); + next.extend( + current + .iter() + .filter(|entry| { + entry + .active + .as_ref() + .is_none_or(|active| active.load(Ordering::Acquire)) + }) + .cloned(), + ); + next.push(entry.clone()); + Arc::new(next) + }); +} + +async fn init_packet_process_pipeline( + peer_packet_process_pipeline: &PeerPacketPipeline, + nic_channel: HostPacketSender, + peer_rpc_tspt_sender: UnboundedSender, +) { + // for tun/tap ip/eth packet. + append_peer_pipeline( + peer_packet_process_pipeline, + permanent_peer_pipeline_entry(Box::new(NicPacketProcessor { nic_channel })), + ); + + // for peer rpc packet + append_peer_pipeline( + peer_packet_process_pipeline, + permanent_peer_pipeline_entry(Box::new(PeerRpcPacketProcessor { + peer_rpc_tspt_sender, + })), + ); +} + +async fn add_route( + peer_packet_process_pipeline: &PeerPacketPipeline, + peers: Arc, + foreign_network_client: Arc, + foreign_network_manager: Arc, + my_peer_id: PeerId, + route: Arc, +) where + T: Route + PeerPacketFilter + Send + Sync + 'static, +{ + // for route + append_peer_pipeline( + peer_packet_process_pipeline, + permanent_peer_pipeline_entry(Box::new(route.clone())), + ); + + let _route_id = route + .open(Box::new(PeerManagerRouteInterface { + my_peer_id, + peers: Arc::downgrade(&peers), + foreign_network_client: Arc::downgrade(&foreign_network_client), + foreign_network_manager: Arc::downgrade(&foreign_network_manager), + })) + .await + .unwrap(); + + let arc_route: ArcRoute = route; + peers.add_route(arc_route).await; +} + +pub(crate) struct PeerManagerTrafficCounters { + pub self_tx_packets: CounterHandle, + pub self_tx_bytes: CounterHandle, + pub compress_tx_bytes_before: CounterHandle, + pub compress_tx_bytes_after: CounterHandle, +} + +pub type HostSubnetFilter = Arc bool + Send + Sync>; + +pub struct PeerManagerCore { + host_subnet_filter: std::sync::RwLock>, + my_peer_id: PeerId, + tasks: Mutex>, + packet_recv: Arc>>, + peers: Arc, + peer_rpc_mgr: Arc, + peer_rpc_tspt: Arc, + peer_packet_process_pipeline: PeerPacketPipeline, + nic_packet_process_pipeline: NicPacketPipeline, + nic_channel: HostPacketSender, + route_algo_inst: RouteAlgoInst, + foreign_network_client: Arc, + foreign_network_manager: Arc, + relay_peer_map: Arc, + peer_connection_admission: PeerConnectionAdmission, + outbound_packet_router: PeerOutboundPacketRouter, + recent_traffic: RecentTrafficTracker, + peer_session_store: Arc, + encryptor: Arc, + data_compress_algo: CompressorAlgo, + exit_nodes: Arc>>, + acl_filter: Arc, + context: Arc, + runtime_config: CoreRuntimeConfigStore, + runtime_config_update: Mutex<()>, + is_secure_mode_enabled: bool, + route: ArcRoute, + traffic_metrics: Arc, + network_name: String, + counters: PeerManagerTrafficCounters, +} + +fn check_resolved_remote_addr_not_from_virtual_network( + context: &ArcPeerContext, + resolved_remote_addr: Option, +) -> Result<(), Error> { + let Some(remote_addr) = resolved_remote_addr.map(Url::from) else { + return Ok(()); + }; + let Some(ip) = remote_addr.host().and_then(|host| match host { + url::Host::Ipv4(ip) => Some(IpAddr::V4(ip)), + url::Host::Ipv6(ip) => Some(IpAddr::V6(ip)), + url::Host::Domain(host) => host.parse().ok(), + }) else { + return Ok(()); + }; + + // If no-tun is enabled, the src ip of packet in virtual network is converted to loopback. + // TCP/QUIC/KCP proxy listeners already filter those connections. + if ip.is_loopback() || !context.is_ip_in_same_network(&ip) { + return Ok(()); + } + + Err(anyhow::anyhow!( + "tunnel src {} is from the same network (ignore this error please)", + ip + ) + .into()) +} + +impl PeerManagerCore { + pub fn set_host_subnet_filter(&self, filter: HostSubnetFilter) { + *self.host_subnet_filter.write().unwrap() = Some(filter); + } + pub fn host_subnet_filter(&self) -> Option { + self.host_subnet_filter.read().unwrap().clone() + } + + #[allow(clippy::too_many_arguments)] + pub(crate) fn new( + mut config: PortablePeerManagerConfig, + managed_credentials: Vec, + runtime_config: CoreRuntimeConfigStore, + stun_info_source: Arc, + nic_channel: HostPacketSender, + public_ipv6_runtime: Arc, + events: Arc, + credential_storage: Option>, + foreign_rpc_registrar: Arc, + ) -> anyhow::Result { + let initial_acl = runtime_config.snapshot().services.acl.build()?; + let runtime = &mut config.snapshot.runtime; + let flags = &config.snapshot.flags; + let network_name = runtime.network_identity.network_name.clone(); + if network_name.is_empty() { + anyhow::bail!("network identity name cannot be empty"); + } + match runtime.core.node.network_name.as_str() { + "" => runtime.core.node.network_name = network_name.clone(), + configured if configured != network_name => anyhow::bail!( + "core node network name {configured:?} does not match identity {network_name:?}" + ), + _ => {} + } + validate_portable_routes(&runtime.core.routes)?; + + if let (Some(_), Some(expected_digest)) = ( + runtime.network_identity.network_secret.as_ref(), + runtime.network_identity.network_secret_digest.as_ref(), + ) { + let mut identity = runtime.network_identity.clone(); + identity.network_secret_digest = None; + let derived_digest = identity + .secret_digest() + .expect("identity with a secret should derive a digest"); + if &derived_digest != expected_digest { + anyhow::bail!("network secret does not match the configured digest"); + } + } + if runtime.network_identity.network_secret.is_none() + && runtime + .network_identity + .network_secret_digest + .as_ref() + .is_some_and(|digest| digest.iter().any(|byte| *byte != 0)) + { + anyhow::bail!("digest-only local identity requires credential key capabilities"); + } + let is_secure_mode_enabled = runtime + .secure_mode + .as_ref() + .is_some_and(|secure| secure.enabled); + let is_credential_peer = runtime.network_identity.network_secret.is_none(); + if is_credential_peer && !is_secure_mode_enabled { + anyhow::bail!("credential peer identity requires secure mode and a local keypair"); + } + runtime.feature_flags.is_credential_peer = is_credential_peer; + if let Some(secure) = runtime.secure_mode.as_ref().filter(|secure| secure.enabled) { + let private_key = secure.private_key()?; + let public_key = secure.public_key()?; + let derived_public = x25519_dalek::PublicKey::from(&private_key); + if derived_public.as_bytes() != public_key.as_bytes() { + anyhow::bail!("secure mode public key does not match its private key"); + } + } + let data_compress_algo = CompressorAlgo::try_from(flags.data_compress_algo())?; + data_compress_algo.ensure_available()?; + if tokio::runtime::Handle::try_current().is_err() { + anyhow::bail!("portable peer manager construction requires an entered Tokio runtime"); + } + + // Peer IDs identify one live process incarnation. They are never + // configuration: every new PeerManager gets a fresh runtime identity. + let my_peer_id = random_peer_id(); + runtime.core.node.peer_id = Some(my_peer_id); + let instance_id = runtime + .core + .node + .instance_id + .map(uuid::Uuid::from_bytes) + .unwrap_or_else(uuid::Uuid::new_v4); + runtime.core.node.instance_id = Some(*instance_id.as_bytes()); + + let secret = runtime + .network_identity + .network_secret + .as_deref() + .unwrap_or_default(); + let encryptor: Arc = if flags.enable_encryption { + validate_algorithm(&flags.encryption_algorithm)?; + create_encryptor( + &flags.encryption_algorithm, + derive_key_128(secret), + derive_key_256(secret), + ) + } else { + Arc::new(NullCipher) + }; + runtime.feature_flags.disable_p2p = flags.disable_p2p; + runtime.feature_flags.need_p2p = flags.need_p2p; + runtime.feature_flags.avoid_relay_data |= flags.disable_relay_data; + runtime_config.update_peer(Arc::new(config.snapshot.clone())); + let public_ipv6_state = public_ipv6_runtime.clone(); + let public_ipv6_runtime: Arc = public_ipv6_runtime; + let context = Arc::new(CorePeerContext::new( + runtime_config, + public_ipv6_state, + CorePeerContextAdapters { + stun_info_source: Some(stun_info_source), + events, + credential_storage, + }, + )); + context + .credential_manager() + .install_initial_managed_credentials(&managed_credentials) + .map_err(anyhow::Error::msg)?; + let peer_manager = Self::assemble( + config.route_algo, + my_peer_id, + context, + public_ipv6_runtime, + nic_channel, + encryptor, + is_secure_mode_enabled, + data_compress_algo, + config.exit_nodes, + config.foreign_context_default_flags, + foreign_rpc_registrar, + ); + peer_manager.reload_acl(initial_acl.as_ref()); + Ok(peer_manager) + } + + #[allow(clippy::too_many_arguments)] + fn assemble( + route_algo: RouteAlgoType, + my_peer_id: PeerId, + core_context: Arc, + public_ipv6_runtime: Arc, + nic_channel: HostPacketSender, + encryptor: Arc, + is_secure_mode_enabled: bool, + data_compress_algo: CompressorAlgo, + exit_nodes: Vec, + foreign_context_default_flags: FlagsInConfig, + foreign_rpc_registrar: Arc, + ) -> Self { + let stats_manager = core_context.stats_manager(); + let acl_filter = Arc::new(AclFilter::new()); + let context: ArcPeerContext = core_context.clone(); + let (packet_send, packet_recv) = super::create_packet_recv_chan(); + let peers = Arc::new(PeerMap::new( + packet_send.clone(), + context.clone(), + my_peer_id, + )); + let peer_session_store = Arc::new(PeerSessionStore::new()); + + let rpc_tspt = RpcTransport::new( + my_peer_id, + Arc::downgrade(&peers), + encryptor.clone(), + is_secure_mode_enabled, + ); + let peer_rpc_mgr = Arc::new(super::peer_rpc::PeerRpcManager::new_with_stats_manager( + rpc_tspt.clone(), + stats_manager.clone(), + )); + + let route_algo_inst = RouteAlgoInst::new( + route_algo, + my_peer_id, + context.clone(), + public_ipv6_runtime, + peer_rpc_mgr.clone(), + ); + + let foreign_network_manager = Arc::new(ForeignNetworkManager::new( + foreign_rpc_registrar, + core_context.clone(), + foreign_context_default_flags, + peer_session_store.clone(), + packet_send.clone(), + Arc::downgrade(&peers), + )); + let foreign_network_client = Arc::new(ForeignNetworkClient::new( + context.clone(), + packet_send, + my_peer_id, + )); + + let network_name = context.network_name(); + let traffic_tx_metrics = Arc::new(LogicalTrafficMetrics::new( + stats_manager.clone(), + network_name.clone(), + MetricName::TrafficBytesTx, + MetricName::TrafficPacketsTx, + MetricName::TrafficBytesTxByInstance, + MetricName::TrafficPacketsTxByInstance, + InstanceLabelKind::To, + )); + let traffic_control_tx_metrics = Arc::new(LogicalTrafficMetrics::new( + stats_manager.clone(), + network_name.clone(), + MetricName::TrafficControlBytesTx, + MetricName::TrafficControlPacketsTx, + MetricName::TrafficControlBytesTxByInstance, + MetricName::TrafficControlPacketsTxByInstance, + InstanceLabelKind::To, + )); + let self_tx_counters = PeerManagerTrafficCounters { + self_tx_packets: stats_manager.get_counter( + MetricName::TrafficPacketsSelfTx, + LabelSet::new().with_label_type(LabelType::NetworkName(network_name.clone())), + ), + self_tx_bytes: stats_manager.get_counter( + MetricName::TrafficBytesSelfTx, + LabelSet::new().with_label_type(LabelType::NetworkName(network_name.clone())), + ), + compress_tx_bytes_before: stats_manager.get_counter( + MetricName::CompressionBytesTxBefore, + LabelSet::new().with_label_type(LabelType::NetworkName(network_name.clone())), + ), + compress_tx_bytes_after: stats_manager.get_counter( + MetricName::CompressionBytesTxAfter, + LabelSet::new().with_label_type(LabelType::NetworkName(network_name.clone())), + ), + }; + let traffic_rx_metrics = Arc::new(LogicalTrafficMetrics::new( + stats_manager.clone(), + network_name.clone(), + MetricName::TrafficBytesRx, + MetricName::TrafficPacketsRx, + MetricName::TrafficBytesRxByInstance, + MetricName::TrafficPacketsRxByInstance, + InstanceLabelKind::From, + )); + let traffic_control_rx_metrics = Arc::new(LogicalTrafficMetrics::new( + stats_manager.clone(), + network_name.clone(), + MetricName::TrafficControlBytesRx, + MetricName::TrafficControlPacketsRx, + MetricName::TrafficControlBytesRxByInstance, + MetricName::TrafficControlPacketsRxByInstance, + InstanceLabelKind::From, + )); + let route_algo_inst_for_metrics = route_algo_inst.clone(); + let traffic_metrics = Arc::new(TrafficMetricRecorder::new( + my_peer_id, + traffic_tx_metrics, + traffic_control_tx_metrics, + traffic_rx_metrics, + traffic_control_rx_metrics, + move |peer_id| { + let route_algo_inst = route_algo_inst_for_metrics.clone(); + async move { + match route_algo_inst.ospf_route() { + Some(route) => route + .get_peer_info(peer_id) + .await + .as_ref() + .and_then(route_peer_info_instance_id), + None => None, + } + } + }, + )); + let peer_packet_process_pipeline = Arc::new(ArcSwap::from_pointee(Vec::new())); + let nic_packet_process_pipeline = Arc::new(ArcSwap::from_pointee(Vec::new())); + let exit_nodes = Arc::new(RwLock::new(exit_nodes)); + let relay_peer_map = super::relay_peer_map::new_relay_peer_map( + peers.clone(), + Some(foreign_network_client.clone()), + context.clone(), + my_peer_id, + peer_session_store.clone(), + ); + let recent_traffic = RecentTrafficTracker::new(my_peer_id); + let peer_connection_admission = PeerConnectionAdmission::new( + my_peer_id, + context.clone(), + peers.clone(), + foreign_network_client.clone(), + foreign_network_manager.clone(), + peer_session_store.clone(), + recent_traffic.clone(), + ); + let route = route_algo_inst.route_arc(); + let outbound_packet_router = PeerOutboundPacketRouter::new( + my_peer_id, + context.clone(), + peers.clone(), + route.clone(), + foreign_network_client.clone(), + relay_peer_map.clone(), + nic_packet_process_pipeline.clone(), + encryptor.clone(), + data_compress_algo, + exit_nodes.clone(), + recent_traffic.clone(), + traffic_metrics.clone(), + acl_filter.clone(), + is_secure_mode_enabled, + self_tx_counters.self_tx_packets.clone(), + self_tx_counters.self_tx_bytes.clone(), + self_tx_counters.compress_tx_bytes_before.clone(), + self_tx_counters.compress_tx_bytes_after.clone(), + ); + + Self { + host_subnet_filter: std::sync::RwLock::new(None), + my_peer_id, + tasks: Mutex::new(JoinSet::new()), + packet_recv: Arc::new(Mutex::new(Some(packet_recv))), + peers, + peer_rpc_mgr, + peer_rpc_tspt: rpc_tspt, + peer_packet_process_pipeline, + nic_packet_process_pipeline, + nic_channel, + route_algo_inst, + foreign_network_client, + foreign_network_manager, + relay_peer_map, + peer_connection_admission, + outbound_packet_router, + recent_traffic, + peer_session_store, + encryptor, + data_compress_algo, + exit_nodes, + acl_filter, + runtime_config: core_context.runtime_config_store(), + runtime_config_update: Mutex::new(()), + context: core_context, + is_secure_mode_enabled, + route, + traffic_metrics, + network_name, + counters: self_tx_counters, + } + } + + pub fn my_peer_id(&self) -> PeerId { + self.my_peer_id + } + + pub(crate) fn credential_manager(&self) -> Arc { + self.context.credential_manager() + } + + pub(crate) fn register_ephemeral_credential( + &self, + public_key: [u8; 32], + groups: Vec, + ) -> anyhow::Result { + let credential_id = self + .credential_manager() + .register_ephemeral_credential(public_key, groups) + .map_err(anyhow::Error::msg)?; + self.notify_credential_changed(); + Ok(credential_id) + } + + pub(crate) async fn update_ephemeral_credential_groups( + &self, + credential_id: uuid::Uuid, + groups: Vec, + ) -> Option { + let changed = self + .credential_manager() + .update_ephemeral_credential_groups(credential_id, groups)?; + if changed { + self.notify_credential_changed(); + self.route.refresh_acl_groups().await; + } + Some(changed) + } + + pub(crate) fn revoke_ephemeral_credential(&self, credential_id: uuid::Uuid) -> bool { + let revoked = self + .credential_manager() + .revoke_ephemeral_credential(credential_id); + if revoked { + self.notify_credential_changed(); + } + revoked + } + + pub(crate) async fn revoke_ephemeral_credential_and_refresh( + &self, + credential_id: uuid::Uuid, + ) -> bool { + let revoked = self.revoke_ephemeral_credential(credential_id); + if revoked { + self.route.refresh_acl_groups().await; + } + revoked + } + + pub fn stats_manager(&self) -> Arc { + self.context.stats_manager() + } + + pub fn can_manage_credentials(&self) -> bool { + self.context.network_identity().network_secret.is_some() + } + + pub(crate) fn set_avoid_relay_data_preference(&self, avoid_relay_data: bool) { + self.context + .set_avoid_relay_data_preference(avoid_relay_data); + } + + pub fn notify_credential_changed(&self) { + self.context.issue_credential_changed(); + } + + pub async fn list_peer_snapshots(&self) -> Vec { + let foreign_peer_map = self.foreign_network_client.get_peer_map(); + let mut peers = self.peers.list_peers(); + peers.extend(foreign_peer_map.list_peers()); + + let mut snapshots = Vec::with_capacity(peers.len()); + for peer_id in peers { + let conns = if let Some(conns) = self.peers.list_peer_conns(peer_id).await { + conns + } else { + foreign_peer_map + .list_peer_conns(peer_id) + .await + .unwrap_or_default() + }; + snapshots.push(PeerSnapshot { + peer_id, + default_conn_id: self.peers.get_peer_default_conn_id(peer_id).await, + directly_connected_conns: self + .peers + .get_directly_connections_by_peer_id(peer_id) + .into_iter() + .collect(), + conns, + }); + } + snapshots + } + + pub(crate) fn instance_id(&self) -> uuid::Uuid { + self.context.instance_id() + } + + pub(crate) async fn node_snapshot(&self, listeners: Vec) -> NodeSnapshot { + NodeSnapshot { + peer_id: self.my_peer_id, + ipv4_addr: self.context.ipv4(), + proxy_networks: self.context.proxy_networks(), + hostname: self.context.hostname(), + stun_info: self.context.stun_info(), + instance_id: self.context.instance_id(), + listeners, + version: self.context.easytier_version(), + feature_flags: self.context.feature_flags(), + ip_list: GetIpListResponse::default(), + public_ipv6_addr: self.get_route().get_my_public_ipv6_addr().await, + ipv6_public_addr_prefix: self.context.advertised_ipv6_public_addr_prefix().map( + |prefix| { + cidr::Ipv6Inet::new(prefix.first_address(), prefix.network_length()).unwrap() + }, + ), + } + } + + pub fn configure_optimization( + &self, + policy: crate::peers::meshport_optimization::OptimizationPolicy, + ) { + self.peers.configure_optimization(policy); + } + pub async fn effective_next_hop(&self, peer_id: PeerId) -> Option { + self.peers + .get_gateway_peer_id( + peer_id, + get_next_hop_policy(self.context.flags().latency_first), + ) + .await + } + + pub async fn list_route_snapshots(&self) -> Vec { + self.get_route().list_routes().await + } + + pub async fn list_public_ipv6_routes(&self) -> BTreeSet { + self.get_route().list_public_ipv6_routes().await + } + + pub async fn public_ipv6_addr(&self) -> Option { + self.get_route().get_my_public_ipv6_addr().await + } + + pub async fn dump_route(&self) -> String { + self.get_route().dump().await + } + + pub async fn local_public_ipv6_info(&self) -> ListPublicIpv6InfoResponse { + self.get_route().get_local_public_ipv6_info().await + } + + pub async fn foreign_network_route_infos(&self) -> RouteForeignNetworkInfos { + self.get_route().list_foreign_network_info().await + } + + pub async fn list_foreign_network_infos( + &self, + include_trusted_keys: bool, + ) -> std::collections::HashMap { + self.foreign_network_manager + .list_foreign_network_infos(include_trusted_keys) + .await + } + + pub async fn foreign_network_route_summary(&self) -> RouteForeignNetworkSummary { + self.get_route().get_foreign_network_summary().await + } + + pub fn acl_stats(&self) -> crate::proto::acl::AclStats { + self.acl_filter.get_stats() + } + + pub fn acl_filter(&self) -> Arc { + self.acl_filter.clone() + } + + pub(crate) async fn update_runtime_config( + &self, + config: CoreInstanceRuntimeConfig, + ) -> anyhow::Result> { + let _update = self.runtime_config_update.lock().await; + let current = self.runtime_config.snapshot(); + let refresh_acl_groups = current.peer.peer_group_memberships + != config.peer.peer_group_memberships + || current.peer.acl_group_declarations != config.peer.acl_group_declarations; + let reload_acl = current.services.acl != config.services.acl; + let next_acl = reload_acl.then(|| config.services.acl.clone()); + let next_built_acl = next_acl.as_ref().map(AclRuleConfig::build).transpose()?; + + self.set_avoid_relay_data_preference(config.peer.avoid_relay_data_preference); + let published = self + .runtime_config + .replace_with_current(config, |current, next| { + retain_runtime_owned_peer_state(current, next, self.my_peer_id); + }); + if let Some(acl) = next_built_acl.as_ref() { + self.reload_acl(acl.as_ref()); + } + if refresh_acl_groups { + self.route.refresh_acl_groups().await; + } + Ok(published) + } + + /// Keeps this manager's ACL rules and group assignments aligned with a + /// network policy source. The subscription is owned by this manager and is + /// stopped with its other runtime tasks. + pub(crate) async fn follow_network_policy( + self: &Arc, + source: CoreRuntimeConfigStore, + configured_groups: Vec, + ) -> anyhow::Result<()> { + let mut peer_changes = source.subscribe_peer_runtime_changes(); + let mut service_changes = source.subscribe_service_runtime_changes(); + let configured_groups: Arc<[String]> = configured_groups.into(); + self.apply_network_policy(&source, &configured_groups) + .await?; + + let peer_manager = Arc::downgrade(self); + self.tasks.lock().await.spawn(async move { + loop { + let changed = tokio::select! { + changed = peer_changes.changed() => changed, + changed = service_changes.changed() => changed, + }; + if changed.is_err() { + return; + } + let _ = peer_changes.borrow_and_update(); + let _ = service_changes.borrow_and_update(); + let Some(peer_manager) = peer_manager.upgrade() else { + return; + }; + if let Err(error) = peer_manager + .apply_network_policy(&source, &configured_groups) + .await + { + tracing::warn!( + ?error, + peer_id = peer_manager.my_peer_id, + "failed to apply peer manager network policy" + ); + } + } + }); + Ok(()) + } + + async fn apply_network_policy( + &self, + source: &CoreRuntimeConfigStore, + configured_groups: &[String], + ) -> anyhow::Result<()> { + let source = source.snapshot(); + let credential_peer = self.context.feature_flags().is_credential_peer; + let acl = if credential_peer { + source.services.acl.for_credential_peer() + } else { + source.services.acl.clone() + }; + let (declarations, memberships, missing_group) = if credential_peer { + (Vec::new(), Vec::new(), None) + } else { + let declarations = source.peer.acl_group_declarations.clone(); + let memberships = matching_group_memberships(&declarations, configured_groups); + let missing_group = first_missing_group(&memberships, configured_groups); + (declarations, memberships, missing_group) + }; + let current = self.runtime_config.snapshot(); + if current.services.acl == acl + && current.peer.acl_group_declarations == declarations + && current.peer.peer_group_memberships == memberships + { + return Ok(()); + } + + let mut next = current.as_ref().clone(); + next.services.acl = acl; + let peer = Arc::make_mut(&mut next.peer); + peer.acl_group_declarations = declarations; + peer.peer_group_memberships = memberships; + self.update_runtime_config(next).await?; + if let Some(group) = missing_group { + tracing::warn!( + peer_id = self.my_peer_id, + group, + "configured peer ACL group is no longer declared" + ); + } + Ok(()) + } + + pub fn network_name(&self) -> &str { + &self.network_name + } + + pub(crate) fn dns_route_identity( + &self, + ) -> (String, Option, String) { + ( + self.context.hostname(), + self.context.ipv4().map(Into::into), + self.context.flags().tld_dns_zone, + ) + } + + pub fn p2p_policy_flags(&self) -> P2pPolicyFlags { + let flags = self.context.flags(); + P2pPolicyFlags { + disable_udp_hole_punching: flags.disable_udp_hole_punching, + disable_sym_hole_punching: flags.disable_sym_hole_punching, + disable_upnp: flags.disable_upnp, + lazy_p2p: flags.lazy_p2p, + disable_p2p: flags.disable_p2p, + need_p2p: flags.need_p2p, + } + } + + pub fn tcp_hole_punching_disabled(&self) -> bool { + self.context.flags().disable_tcp_hole_punching + } + + pub fn get_peer_map(&self) -> Arc { + self.peers.clone() + } + + pub fn get_relay_peer_map(&self) -> Arc { + self.relay_peer_map.clone() + } + + pub fn get_peer_rpc_mgr(&self) -> Arc { + self.peer_rpc_mgr.clone() + } + + pub fn get_peer_session_store(&self) -> Arc { + self.peer_session_store.clone() + } + pub(crate) fn get_nic_channel(&self) -> HostPacketSender { + self.nic_channel.clone() + } + + pub(crate) fn is_local_virtual_ip(&self, ip: &IpAddr) -> bool { + self.context.is_ip_local_virtual_ip(ip) + } + + pub fn get_foreign_network_client(&self) -> Arc { + self.foreign_network_client.clone() + } + + pub async fn is_easytier_managed_ipv6(&self, ip: &std::net::Ipv6Addr) -> bool { + if self.context.is_ip_local_ipv6(ip) { + return true; + } + self.route + .list_public_ipv6_routes() + .await + .iter() + .any(|route| route.address() == *ip) + } + + pub fn traffic_metrics(&self) -> Arc { + self.traffic_metrics.clone() + } + + pub fn get_route(&self) -> ArcRoute { + self.route.clone() + } + + pub(crate) async fn withdraw_routes_before_stop(&self) -> bool { + let Some(route) = self.route_algo_inst.ospf_route() else { + return true; + }; + route.withdraw_self_conn_info().await + } + + pub fn mark_recent_traffic(&self, dst_peer_id: PeerId) { + let flags = self.context.flags(); + self.recent_traffic + .mark(dst_peer_id, flags.disable_p2p, flags.lazy_p2p, |peer_id| { + self.has_directly_connected_conn(peer_id) + }); + } + + pub fn has_recent_traffic(&self, peer_id: PeerId, now: Instant) -> bool { + self.recent_traffic.has(peer_id, now, |peer_id| { + self.has_directly_connected_conn(peer_id) + }) + } + + pub fn clear_recent_traffic(&self, peer_id: PeerId) { + self.recent_traffic.clear(peer_id); + } + + pub fn p2p_demand_notify(&self) -> Arc { + self.recent_traffic.p2p_demand_notify() + } + + pub fn gc_recent_traffic(&self) { + self.recent_traffic.gc(Instant::now(), |peer_id| { + self.has_directly_connected_conn(peer_id) + }); + } + + pub fn has_directly_connected_conn(&self, peer_id: PeerId) -> bool { + if let Some(peer) = self.peers.get_peer_by_id(peer_id) { + peer.has_directly_connected_conn() + } else { + self.foreign_network_client.get_peer_map().has_peer(peer_id) + } + } + + pub async fn add_client_tunnel( + &self, + tunnel: Box, + ) -> Result<(PeerId, PeerConnId), Error> { + self.add_client_tunnel_with_peer_id_hint(tunnel, PeerConnectionOrigin::Manual, None) + .await + } + + pub(crate) async fn add_client_tunnel_with_peer_id_hint( + &self, + tunnel: Box, + origin: PeerConnectionOrigin, + peer_id_hint: Option, + ) -> Result<(PeerId, PeerConnId), Error> { + self.peer_connection_admission + .add_client_tunnel_with_peer_id_hint(tunnel, origin, peer_id_hint) + .await + } + + pub(crate) async fn add_attached_ring_client_tunnel( + &self, + tunnel: Box, + ) -> Result<(PeerId, PeerConnId), Error> { + self.add_client_tunnel_with_peer_id_hint(tunnel, PeerConnectionOrigin::Attached, None) + .await + } + + pub async fn add_tunnel_as_server(&self, tunnel: Box) -> Result<(), Error> { + self.add_tunnel_as_server_with_origin(tunnel, PeerConnectionOrigin::Listener) + .await + .map(|_| ()) + } + + pub(crate) async fn add_tunnel_as_server_with_origin( + &self, + tunnel: Box, + origin: PeerConnectionOrigin, + ) -> Result<(PeerId, PeerConnId), Error> { + self.peer_connection_admission + .add_tunnel_as_server_with_origin(tunnel, origin) + .await + } + + pub(crate) async fn add_attached_ring_tunnel_as_server( + &self, + tunnel: Box, + ) -> Result<(PeerId, PeerConnId), Error> { + self.add_tunnel_as_server_with_origin(tunnel, PeerConnectionOrigin::Attached) + .await + } + + pub async fn add_packet_process_pipeline(&self, pipeline: BoxPeerPacketFilter) { + // newest pipeline will be executed first + append_peer_pipeline( + &self.peer_packet_process_pipeline, + permanent_peer_pipeline_entry(pipeline), + ); + } + + pub async fn add_nic_packet_process_pipeline(&self, pipeline: BoxNicPacketFilter) { + // newest pipeline will be executed first + append_nic_pipeline( + &self.nic_packet_process_pipeline, + permanent_nic_pipeline_entry(pipeline), + ); + } + + pub(crate) async fn add_managed_packet_process_pipeline( + &self, + pipeline: BoxPeerPacketFilter, + ) -> PipelineRegistrationGuard { + let (entry, guard) = + managed_peer_pipeline_entry(pipeline, &self.peer_packet_process_pipeline); + append_peer_pipeline(&self.peer_packet_process_pipeline, entry); + guard + } + + #[cfg(feature = "proxy-packet")] + pub(crate) async fn add_managed_nic_packet_process_pipeline( + &self, + pipeline: BoxNicPacketFilter, + ) -> PipelineRegistrationGuard { + let (entry, guard) = + managed_nic_pipeline_entry(pipeline, &self.nic_packet_process_pipeline); + append_nic_pipeline(&self.nic_packet_process_pipeline, entry); + guard + } + + #[cfg(feature = "proxy-packet")] + pub(crate) async fn remove_managed_nic_packet_process_pipeline( + &self, + registration: &PipelineRegistrationGuard, + ) { + registration.close(); + } + + pub async fn add_route(&self, route: Arc) + where + T: Route + PeerPacketFilter + Send + Sync + 'static, + { + add_route( + &self.peer_packet_process_pipeline, + self.peers.clone(), + self.foreign_network_client.clone(), + self.foreign_network_manager.clone(), + self.my_peer_id, + route, + ) + .await; + } + + pub async fn remove_nic_packet_process_pipeline(&self, id: String) -> Result<(), Error> { + let snapshot = self.nic_packet_process_pipeline.load_full(); + let Some(target) = snapshot + .iter() + .find(|entry| { + entry + .filter_if_active() + .is_some_and(|filter| filter.id() == id) + }) + .map(|entry| entry.filter.clone()) + else { + return Err(Error::NotFound); + }; + self.nic_packet_process_pipeline.rcu(|current| { + Arc::new( + current + .iter() + .filter(|entry| !Arc::ptr_eq(&entry.filter, &target)) + .cloned() + .collect(), + ) + }); + Ok(()) + } + + pub async fn send_msg_for_proxy( + &self, + msg: ZCPacket, + dst_peer_id: PeerId, + ) -> Result<(), Error> { + self.outbound_packet_router + .send_msg_for_proxy(msg, dst_peer_id) + .await + } + + pub async fn get_msg_dst_peer(&self, addr: &IpAddr) -> (Vec, bool) { + self.outbound_packet_router.get_msg_dst_peer(addr).await + } + + pub async fn get_msg_dst_peer_ipv4(&self, ipv4_addr: &Ipv4Addr) -> (Vec, bool) { + self.outbound_packet_router + .get_msg_dst_peer_ipv4(ipv4_addr) + .await + } + + pub async fn get_msg_dst_peer_ipv6(&self, ipv6_addr: &Ipv6Addr) -> (Vec, bool) { + self.outbound_packet_router + .get_msg_dst_peer_ipv6(ipv6_addr) + .await + } + + pub async fn send_msg_by_ip( + &self, + msg: ZCPacket, + ip_addr: IpAddr, + not_send_to_self: bool, + ) -> Result<(), Error> { + if let (IpAddr::V4(ip), Some(filter)) = (ip_addr, self.host_subnet_filter()) { + let is_virtual_node = self.context.is_ip_in_same_network(&ip_addr) + || self.peers.list_route_infos().await.iter().any(|route| { + route.ipv4_addr.as_ref().is_some_and(|addr| { + let inet: cidr::Ipv4Inet = addr.clone().into(); + inet.address() == ip + }) + }); + if !is_virtual_node { + let accepted = self + .route + .list_proxy_cidrs() + .await + .into_iter() + .filter(|route| filter(route)) + .take(32) + .any(|route| route.contains(&ip)); + if !accepted { + return Err(anyhow::anyhow!( + "destination is outside accepted overlay/subnet routes" + ) + .into()); + } + } + } + self.outbound_packet_router + .send_msg_by_ip(msg, ip_addr, not_send_to_self) + .await + } + + pub async fn check_allow_kcp_to_dst(&self, dst_ip: &IpAddr) -> bool { + self.outbound_packet_router + .check_allow_kcp_to_dst(dst_ip) + .await + } + + pub async fn check_allow_quic_to_dst(&self, dst_ip: &IpAddr) -> bool { + self.outbound_packet_router + .check_allow_quic_to_dst(dst_ip) + .await + } + + pub async fn update_exit_nodes(&self, exit_nodes: Vec) { + *self.exit_nodes.write().await = exit_nodes; + } + + fn reload_acl(&self, acl: Option<&crate::proto::acl::Acl>) { + self.acl_filter.reload_rules(acl); + } + + pub async fn wait(&self) { + while !self.tasks.lock().await.is_empty() { + crate::foundation::time::sleep(std::time::Duration::from_secs(1)).await; + } + } + + pub(crate) async fn stop(&self) { + let mut tasks = { + let mut task_slot = self.tasks.lock().await; + std::mem::replace(&mut *task_slot, JoinSet::new()) + }; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + self.foreign_network_manager.stop().await; + self.route.close().await; + self.peer_rpc_mgr.stop().await; + self.context.stop().await; + self.context.stats_manager().stop_cleanup_task().await; + self.acl_filter.stop_cleanup_task().await; + } + + pub(crate) async fn clear_resources(&self) { + self.stop().await; + self.foreign_network_client.stop(); + self.peers.clear_resources().await; + self.foreign_network_client + .get_peer_map() + .clear_resources() + .await; + self.peer_packet_process_pipeline + .store(Arc::new(Vec::new())); + self.nic_packet_process_pipeline.store(Arc::new(Vec::new())); + + self.peer_rpc_mgr.rpc_server().registry().unregister_all(); + } + + pub async fn close_peer_conn( + &self, + peer_id: PeerId, + conn_id: &PeerConnId, + ) -> Result<(), Error> { + close_peer_conn( + self.peers.as_ref(), + &self.foreign_network_client, + &self.foreign_network_manager, + peer_id, + conn_id, + ) + .await + } + + async fn start_peer_recv(&self) { + let packet_recv = self.packet_recv.lock().await.take().unwrap(); + let is_credential_node = + self.context.network_identity().network_secret.is_none() && self.is_secure_mode_enabled; + let router = PeerPacketRouter::new( + packet_recv, + self.my_peer_id, + self.peers.clone(), + self.peer_packet_process_pipeline.clone(), + self.foreign_network_client.clone(), + self.relay_peer_map.clone(), + self.foreign_network_manager.clone(), + self.encryptor.clone(), + self.data_compress_algo, + self.acl_filter.clone(), + self.context.clone(), + self.is_secure_mode_enabled, + self.route.clone(), + is_credential_node, + self.traffic_metrics.clone(), + self.context.stats_manager(), + self.network_name.clone(), + self.counters.self_tx_packets.clone(), + self.counters.self_tx_bytes.clone(), + self.counters.compress_tx_bytes_before.clone(), + self.counters.compress_tx_bytes_after.clone(), + ); + + self.tasks.lock().await.spawn(router.run()); + } + + pub(crate) async fn run(&self) -> Result<(), Error> { + self.context.stats_manager().start_cleanup_task(); + + if let Some(route) = self.route_algo_inst.ospf_route() { + self.add_route(route).await; + } + + init_packet_process_pipeline( + &self.peer_packet_process_pipeline, + self.nic_channel.clone(), + self.peer_rpc_tspt.packet_sender(), + ) + .await; + self.peer_rpc_mgr.run(); + + self.start_peer_recv().await; + PeerMaintenanceTasks::new( + self.peers.clone(), + self.relay_peer_map.clone(), + self.recent_traffic.clone(), + self.foreign_network_client.clone(), + self.peer_session_store.clone(), + self.context.clone(), + self.traffic_metrics.clone(), + ) + .spawn_into(&self.tasks) + .await; + + self.foreign_network_client.run().await; + + Ok(()) + } +} + +#[async_trait::async_trait] +impl PeerCenterPeerManagerTrait for PeerManagerCore { + async fn list_peers(&self) -> PeerInfoForGlobalMap { + direct_peer_info(&[ + self.get_peer_map(), + self.get_foreign_network_client().get_peer_map(), + ]) + .await + } + + fn my_peer_id(&self) -> PeerId { + self.my_peer_id() + } + + fn network_name(&self) -> String { + self.network_name().to_owned() + } + + fn get_rpc_mgr(&self) -> Weak { + Arc::downgrade(&self.get_peer_rpc_mgr()) + } + + async fn list_routes(&self) -> Vec { + self.get_route().list_routes().await + } +} + +pub(crate) async fn close_peer_conn( + peers: &PeerMap, + foreign_network_client: &ForeignNetworkClient, + foreign_network_manager: &ForeignNetworkManager, + peer_id: PeerId, + conn_id: &PeerConnId, +) -> Result<(), Error> { + let ret = peers.close_peer_conn(peer_id, conn_id).await; + tracing::info!("close_peer_conn in peer map: {:?}", ret); + if ret.is_ok() || !matches!(ret.as_ref().unwrap_err(), Error::NotFound) { + return ret; + } + + let ret = foreign_network_client + .get_peer_map() + .close_peer_conn(peer_id, conn_id) + .await; + tracing::info!("close_peer_conn in foreign network client: {:?}", ret); + if ret.is_ok() || !matches!(ret.as_ref().unwrap_err(), Error::NotFound) { + return ret; + } + + let ret = foreign_network_manager + .close_peer_conn(peer_id, conn_id) + .await; + tracing::info!("close_peer_conn in foreign network manager done: {:?}", ret); + ret +} + +pub(crate) struct PeerConnectionAdmission { + my_peer_id: PeerId, + context: ArcPeerContext, + peers: Arc, + foreign_network_client: Arc, + foreign_network_manager: Arc, + peer_session_store: Arc, + recent_traffic: RecentTrafficTracker, + reserved_my_peer_id_map: DashMap, +} + +impl PeerConnectionAdmission { + fn new( + my_peer_id: PeerId, + context: ArcPeerContext, + peers: Arc, + foreign_network_client: Arc, + foreign_network_manager: Arc, + peer_session_store: Arc, + recent_traffic: RecentTrafficTracker, + ) -> Self { + Self { + my_peer_id, + context, + peers, + foreign_network_client, + foreign_network_manager, + peer_session_store, + recent_traffic, + reserved_my_peer_id_map: DashMap::new(), + } + } + + pub async fn add_client_tunnel_with_peer_id_hint( + &self, + tunnel: Box, + origin: PeerConnectionOrigin, + peer_id_hint: Option, + ) -> Result<(PeerId, PeerConnId), Error> { + let mut peer = PeerConn::new_with_peer_id_hint_and_origin( + self.my_peer_id, + self.context.clone(), + tunnel, + peer_id_hint, + self.peer_session_store.clone(), + origin, + ); + peer.do_handshake_as_client().await?; + let conn_id = peer.get_conn_id(); + let peer_id = peer.get_peer_id(); + let local_identity = self.context.network_identity(); + let is_local_network = + peer.get_network_identity().network_name == local_identity.network_name; + if origin == PeerConnectionOrigin::Attached && !is_local_network { + return Err(Error::SecretKeyError( + "attached ring peer must belong to the local network".to_string(), + )); + } + if is_local_network { + let local_secure_mode = self + .context + .secure_mode() + .as_ref() + .map(|cfg| cfg.enabled) + .unwrap_or(false); + let peer_id = add_new_peer_conn( + self.peers.as_ref(), + &local_identity, + local_secure_mode, + peer, + ) + .await?; + self.recent_traffic.clear(peer_id); + } else { + self.foreign_network_client.add_new_peer_conn(peer).await?; + } + Ok((peer_id, conn_id)) + } + + fn release_reserved_peer_id(&self, network_name: &str) { + self.reserved_my_peer_id_map.remove(network_name); + shrink_dashmap(&self.reserved_my_peer_id_map, None); + } + + #[tracing::instrument(ret, skip(self, tunnel))] + async fn add_tunnel_as_server_with_origin( + &self, + tunnel: Box, + origin: PeerConnectionOrigin, + ) -> Result<(PeerId, PeerConnId), Error> { + tracing::info!("add tunnel as server start"); + let resolved_remote_addr = tunnel.info().and_then(|info| info.resolved_remote_addr); + check_resolved_remote_addr_not_from_virtual_network(&self.context, resolved_remote_addr)?; + + let mut conn = PeerConn::new_with_peer_id_hint_and_origin( + self.my_peer_id, + self.context.clone(), + tunnel, + None, + self.peer_session_store.clone(), + origin, + ); + let mut reserved_peer_id_network_name = None; + let handshake_ret = conn + .do_handshake_as_server_ext(|peer, network_name: &str| { + if network_name == self.context.network_identity().network_name { + return Ok(()); + } + + let mut peer_id = self + .foreign_network_manager + .get_network_peer_id(network_name); + if peer_id.is_none() { + reserved_peer_id_network_name = Some(network_name.to_string()); + peer_id = Some( + *self + .reserved_my_peer_id_map + .entry(network_name.to_string()) + .or_insert_with(random_peer_id) + .value(), + ); + } + peer.set_peer_id(peer_id.unwrap()); + + tracing::info!( + ?peer_id, + ?network_name, + "handshake as server with foreign network, new peer id: {}, peer id in foreign manager: {:?}", + peer.get_my_peer_id(), peer_id + ); + + Ok(()) + }) + .await; + + if let Err(err) = handshake_ret { + if let Some(network_name) = reserved_peer_id_network_name { + self.release_reserved_peer_id(&network_name); + } + return Err(err); + } + + let peer_identity = conn.get_network_identity(); + let peer_network_name = peer_identity.network_name.clone(); + let local_identity = self.context.network_identity(); + let is_local_network = peer_network_name == local_identity.network_name; + if origin == PeerConnectionOrigin::Attached && !is_local_network { + self.release_reserved_peer_id(&peer_network_name); + return Err(Error::SecretKeyError( + "attached ring peer must belong to the local network".to_string(), + )); + } + let peer_id = conn.get_peer_id(); + let conn_id = conn.get_conn_id(); + let trusted_foreign_credential = + matches!(conn.get_peer_identity_type(), PeerIdentityType::Credential) + && self + .foreign_network_manager + .is_existing_credential_pubkey_trusted( + &peer_network_name, + &conn.get_conn_info().noise_remote_static_pubkey, + ); + let foreign_network_allowed = + conn.matches_local_network_secret() || trusted_foreign_credential; + + if !is_local_network && self.context.flags().private_mode && !foreign_network_allowed { + self.release_reserved_peer_id(&peer_network_name); + return Err(Error::SecretKeyError( + "private mode is turned on, foreign network secret mismatch".to_string(), + )); + } + + let add_peer_ret = if is_local_network { + let local_secure_mode = self + .context + .secure_mode() + .as_ref() + .map(|cfg| cfg.enabled) + .unwrap_or(false); + match add_new_peer_conn( + self.peers.as_ref(), + &local_identity, + local_secure_mode, + conn, + ) + .await + { + Ok(peer_id) => { + self.recent_traffic.clear(peer_id); + Ok(()) + } + Err(err) => Err(err), + } + } else { + self.foreign_network_manager.add_peer_conn(conn).await + }; + + if let Err(err) = add_peer_ret { + self.release_reserved_peer_id(&peer_network_name); + return Err(err); + } + + self.release_reserved_peer_id(&peer_network_name); + + tracing::info!("add tunnel as server done"); + Ok((peer_id, conn_id)) + } +} + +// Keep lazy-p2p demand alive across the 5s task rescan interval and a full on-demand +// connect attempt, without retaining extra per-task state in the hot path. +pub(crate) const RECENT_HAVE_TRAFFIC_TTL: Duration = Duration::from_secs(30); + +pub(crate) fn should_mark_recent_traffic_for_fanout(total_dst_peers: usize) -> bool { + total_dst_peers <= 1 +} + +fn gc_recent_traffic_entries( + recent_have_traffic: &DashMap, + now: Instant, + mut has_directly_connected_conn: F, +) where + F: FnMut(PeerId) -> bool, +{ + let mut to_remove = Vec::new(); + for entry in recent_have_traffic.iter() { + let peer_id = *entry.key(); + let expired = now.saturating_duration_since(*entry.value()) > RECENT_HAVE_TRAFFIC_TTL; + if expired || has_directly_connected_conn(peer_id) { + to_remove.push(peer_id); + } + } + + if !to_remove.is_empty() { + for peer_id in to_remove { + recent_have_traffic.remove(&peer_id); + } + shrink_dashmap(recent_have_traffic, None); + } +} + +#[derive(Clone)] +pub(crate) struct RecentTrafficTracker { + my_peer_id: PeerId, + recent_have_traffic: Arc>, + p2p_demand_notify: Arc, +} + +impl RecentTrafficTracker { + pub fn new(my_peer_id: PeerId) -> Self { + Self { + my_peer_id, + recent_have_traffic: Arc::new(DashMap::new()), + p2p_demand_notify: Arc::new(ExternalTaskSignal::new()), + } + } + + pub fn mark( + &self, + dst_peer_id: PeerId, + disable_p2p: bool, + lazy_p2p: bool, + mut has_directly_connected_conn: F, + ) where + F: FnMut(PeerId) -> bool, + { + if dst_peer_id == self.my_peer_id { + return; + } + + if disable_p2p || !lazy_p2p || has_directly_connected_conn(dst_peer_id) { + return; + } + + let now = Instant::now(); + if let Some(mut last_seen) = self.recent_have_traffic.get_mut(&dst_peer_id) { + let should_notify = now.saturating_duration_since(*last_seen) > RECENT_HAVE_TRAFFIC_TTL; + *last_seen = now; + if !should_notify { + return; + } + } else { + self.recent_have_traffic.insert(dst_peer_id, now); + } + self.p2p_demand_notify.notify(); + } + + pub fn has(&self, peer_id: PeerId, now: Instant, mut has_directly_connected_conn: F) -> bool + where + F: FnMut(PeerId) -> bool, + { + if has_directly_connected_conn(peer_id) { + return false; + } + + self.recent_have_traffic + .get(&peer_id) + .map(|last_seen| now.saturating_duration_since(*last_seen) <= RECENT_HAVE_TRAFFIC_TTL) + .unwrap_or(false) + } + + pub fn clear(&self, peer_id: PeerId) { + self.recent_have_traffic.remove(&peer_id); + } + + pub fn gc(&self, now: Instant, has_directly_connected_conn: F) + where + F: FnMut(PeerId) -> bool, + { + gc_recent_traffic_entries( + self.recent_have_traffic.as_ref(), + now, + has_directly_connected_conn, + ); + } + + pub fn p2p_demand_notify(&self) -> Arc { + self.p2p_demand_notify.clone() + } +} + +pub(crate) struct PeerMaintenanceTasks { + peer_map: Arc, + relay_peer_map: Arc, + recent_traffic: RecentTrafficTracker, + foreign_network_client: Arc, + peer_session_store: Arc, + context: ArcPeerContext, + traffic_metrics: Arc, +} + +impl PeerMaintenanceTasks { + pub fn new( + peer_map: Arc, + relay_peer_map: Arc, + recent_traffic: RecentTrafficTracker, + foreign_network_client: Arc, + peer_session_store: Arc, + context: ArcPeerContext, + traffic_metrics: Arc, + ) -> Self { + Self { + peer_map, + relay_peer_map, + recent_traffic, + foreign_network_client, + peer_session_store, + context, + traffic_metrics, + } + } + + pub async fn spawn_into(self, tasks: &Mutex>) { + self.spawn_clean_peer_without_conn_routine(tasks).await; + self.spawn_relay_session_gc_routine(tasks).await; + self.spawn_recent_traffic_gc_routine(tasks).await; + self.spawn_peer_session_gc_routine(tasks).await; + self.spawn_credential_gc_routine(tasks).await; + self.spawn_traffic_metrics_gc_routine(tasks).await; + } + + async fn spawn_clean_peer_without_conn_routine(&self, tasks: &Mutex>) { + let peer_map = self.peer_map.clone(); + tasks.lock().await.spawn(async move { + loop { + peer_map.clean_peer_without_conn().await; + crate::foundation::time::sleep(std::time::Duration::from_secs(3)).await; + } + }); + } + + async fn spawn_relay_session_gc_routine(&self, tasks: &Mutex>) { + let relay_peer_map = self.relay_peer_map.clone(); + tasks.lock().await.spawn(async move { + loop { + relay_peer_map.evict_idle_sessions(std::time::Duration::from_secs(60)); + crate::foundation::time::sleep(std::time::Duration::from_secs(30)).await; + } + }); + } + + async fn spawn_recent_traffic_gc_routine(&self, tasks: &Mutex>) { + let recent_traffic = self.recent_traffic.clone(); + let peers = self.peer_map.clone(); + let foreign_network_client = self.foreign_network_client.clone(); + tasks.lock().await.spawn(async move { + loop { + recent_traffic.gc(Instant::now(), |peer_id| { + if let Some(peer) = peers.get_peer_by_id(peer_id) { + peer.has_directly_connected_conn() + } else { + foreign_network_client.get_peer_map().has_peer(peer_id) + } + }); + crate::foundation::time::sleep(std::time::Duration::from_secs(30)).await; + } + }); + } + + async fn spawn_peer_session_gc_routine(&self, tasks: &Mutex>) { + let peer_session_store = self.peer_session_store.clone(); + tasks.lock().await.spawn(async move { + loop { + crate::foundation::time::sleep(std::time::Duration::from_secs(60)).await; + peer_session_store.evict_unused_sessions(); + } + }); + } + + async fn spawn_credential_gc_routine(&self, tasks: &Mutex>) { + let context = self.context.clone(); + let peer_map = self.peer_map.clone(); + tasks.lock().await.spawn(async move { + loop { + if context.network_identity().network_secret.is_some() { + if context.remove_expired_credentials() { + context.issue_credential_changed(); + } + + let network_name = context.network_name(); + close_untrusted_credential_peers( + peer_map.as_ref(), + &network_name, + |pubkey, network_name| context.is_pubkey_trusted(pubkey, network_name), + ) + .await; + } + crate::foundation::time::sleep(std::time::Duration::from_secs(1)).await; + } + }); + } + + async fn spawn_traffic_metrics_gc_routine(&self, tasks: &Mutex>) { + let Some(mut event_receiver) = self.context.subscribe_peer_events() else { + return; + }; + let context = self.context.clone(); + let traffic_metrics = self.traffic_metrics.clone(); + tasks.lock().await.spawn(async move { + loop { + match event_receiver.recv().await { + Ok(super::context::PeerContextEvent::PeerRemoved(peer_id)) => { + traffic_metrics.remove_peer(peer_id); + } + Ok(_) => {} + Err(tokio::sync::broadcast::error::RecvError::Lagged(skipped)) => { + tracing::warn!( + skipped, + "traffic metrics GC receiver lagged; clearing peer cache to avoid stale metric attribution" + ); + traffic_metrics.clear_peer_cache(); + let Some(new_receiver) = context.subscribe_peer_events() else { + break; + }; + event_receiver = new_receiver; + } + Err(tokio::sync::broadcast::error::RecvError::Closed) => break, + } + } + }); + } +} + +pub(crate) async fn try_compress_and_encrypt( + compress_algo: CompressorAlgo, + encryptor: &Arc, + msg: &mut ZCPacket, + secure_mode_enabled: bool, +) -> Result<(), Error> { + let compressor = DefaultCompressor {}; + compressor + .compress(msg, compress_algo) + .await + .with_context(|| "compress failed")?; + if !secure_mode_enabled { + encryptor.encrypt(msg).with_context(|| "encrypt failed")?; + } + Ok(()) +} + +struct PeerOutboundPacketRouterCounters { + self_tx_packets: CounterHandle, + self_tx_bytes: CounterHandle, + compress_tx_bytes_before: CounterHandle, + compress_tx_bytes_after: CounterHandle, +} + +pub(crate) struct PeerOutboundPacketRouter { + my_peer_id: PeerId, + context: ArcPeerContext, + host_routing: HostRoutingPolicy, + peers: Arc, + route: ArcRoute, + foreign_network_client: Arc, + relay_peer_map: Arc, + nic_packet_process_pipeline: NicPacketPipeline, + encryptor: Arc, + data_compress_algo: CompressorAlgo, + exit_nodes: Arc>>, + recent_traffic: RecentTrafficTracker, + traffic_metrics: Arc, + acl_filter: Arc, + is_secure_mode_enabled: bool, + counters: PeerOutboundPacketRouterCounters, +} + +impl PeerOutboundPacketRouter { + #[allow(clippy::too_many_arguments)] + fn new( + my_peer_id: PeerId, + context: ArcPeerContext, + peers: Arc, + route: ArcRoute, + foreign_network_client: Arc, + relay_peer_map: Arc, + nic_packet_process_pipeline: NicPacketPipeline, + encryptor: Arc, + data_compress_algo: CompressorAlgo, + exit_nodes: Arc>>, + recent_traffic: RecentTrafficTracker, + traffic_metrics: Arc, + acl_filter: Arc, + is_secure_mode_enabled: bool, + self_tx_packets: CounterHandle, + self_tx_bytes: CounterHandle, + compress_tx_bytes_before: CounterHandle, + compress_tx_bytes_after: CounterHandle, + ) -> Self { + let host_routing = context.host_routing_policy(); + Self { + my_peer_id, + context, + host_routing, + peers, + route, + foreign_network_client, + relay_peer_map, + nic_packet_process_pipeline, + encryptor, + data_compress_algo, + exit_nodes, + recent_traffic, + traffic_metrics, + acl_filter, + is_secure_mode_enabled, + counters: PeerOutboundPacketRouterCounters { + self_tx_packets, + self_tx_bytes, + compress_tx_bytes_before, + compress_tx_bytes_after, + }, + } + } + + fn has_directly_connected_conn(&self, peer_id: PeerId) -> bool { + if let Some(peer) = self.peers.get_peer_by_id(peer_id) { + peer.has_directly_connected_conn() + } else { + self.foreign_network_client.get_peer_map().has_peer(peer_id) + } + } + + fn mark_recent_traffic_with_policy( + &self, + dst_peer_id: PeerId, + packet_policy: PeerPacketPolicy, + ) { + self.recent_traffic.mark( + dst_peer_id, + packet_policy.disable_p2p, + packet_policy.lazy_p2p, + |peer_id| self.has_directly_connected_conn(peer_id), + ); + } + + async fn run_nic_packet_process_pipeline(&self, data: &mut ZCPacket) -> bool { + // Enforce ACL for outbound (NIC-originated) packets. If ACL denies, stop processing. + if !self.acl_filter.process_packet_with_acl( + data, + false, + None, + |_| false, + self.route.as_ref(), + ) { + return false; + } + + let pipelines = self.nic_packet_process_pipeline.load_full(); + for pipeline in pipelines.iter().rev() { + if let Some(filter) = pipeline.filter_if_active() { + let _ = filter.try_process_packet_from_nic(data).await; + } + } + + true + } + + fn check_p2p_only_before_send( + &self, + dst_peer_id: PeerId, + packet_policy: PeerPacketPolicy, + ) -> Result<(), Error> { + if packet_policy.p2p_only && !self.peers.has_peer(dst_peer_id) { + return Err(Error::RouteError(None)); + } + Ok(()) + } + + async fn check_allow_wrapped_proxy_to_dst( + &self, + dst_ip: &IpAddr, + dst_allows_input: impl Fn(crate::proto::common::PeerFeatureFlag) -> bool, + next_hop_disables_relay: impl Fn(crate::proto::common::PeerFeatureFlag) -> bool, + ) -> bool { + let Some(dst_peer_id) = self.route.get_peer_id_by_ip(dst_ip).await else { + return false; + }; + let Some(peer_info) = self.route.get_peer_info(dst_peer_id).await else { + return false; + }; + + if !peer_info + .feature_flag + .map(dst_allows_input) + .unwrap_or(false) + { + return false; + } + + let next_hop_policy = get_next_hop_policy(self.context.flags().latency_first); + let Some(next_hop_id) = self + .route + .get_next_hop_with_policy(dst_peer_id, next_hop_policy) + .await + else { + return false; + }; + + if next_hop_id == dst_peer_id { + return true; + } + + let Some(next_hop_info) = self.route.get_peer_info(next_hop_id).await else { + return false; + }; + + !next_hop_info + .feature_flag + .map(next_hop_disables_relay) + .unwrap_or(false) + } + + pub async fn check_allow_kcp_to_dst(&self, dst_ip: &IpAddr) -> bool { + self.check_allow_wrapped_proxy_to_dst( + dst_ip, + |feature_flag| feature_flag.kcp_input, + |feature_flag| feature_flag.no_relay_kcp, + ) + .await + } + + pub async fn check_allow_quic_to_dst(&self, dst_ip: &IpAddr) -> bool { + self.check_allow_wrapped_proxy_to_dst( + dst_ip, + |feature_flag| feature_flag.quic_input, + |feature_flag| feature_flag.no_relay_quic, + ) + .await + } + + pub async fn send_msg_for_proxy( + &self, + mut msg: ZCPacket, + dst_peer_id: PeerId, + ) -> Result<(), Error> { + let packet_policy = self.context.packet_policy(); + self.mark_recent_traffic_with_policy(dst_peer_id, packet_policy); + self.check_p2p_only_before_send(dst_peer_id, packet_policy)?; + + self.counters + .compress_tx_bytes_before + .add(msg.buf_len() as u64); + + try_compress_and_encrypt( + self.data_compress_algo, + &self.encryptor, + &mut msg, + self.is_secure_mode_enabled, + ) + .await?; + + self.counters + .compress_tx_bytes_after + .add(msg.buf_len() as u64); + + let msg_len = msg.buf_len() as u64; + let result = send_msg_internal( + self.peers.as_ref(), + &self.foreign_network_client, + &self.relay_peer_map, + Some(&self.traffic_metrics), + msg, + dst_peer_id, + ) + .await; + if result.is_ok() { + self.counters.self_tx_bytes.add(msg_len); + self.counters.self_tx_packets.inc(); + } + result + } + + pub async fn get_msg_dst_peer(&self, addr: &IpAddr) -> (Vec, bool) { + match addr { + IpAddr::V4(ipv4_addr) => self.get_msg_dst_peer_ipv4(ipv4_addr).await, + IpAddr::V6(ipv6_addr) => self.get_msg_dst_peer_ipv6(ipv6_addr).await, + } + } + + fn is_all_peers_broadcast_ipv4(&self, ipv4_addr: &Ipv4Addr) -> bool { + let network_length = self + .context + .ipv4() + .map(|x| x.network_length()) + .unwrap_or(24); + let ipv4_inet = cidr::Ipv4Inet::new(*ipv4_addr, network_length).unwrap(); + ipv4_addr.is_broadcast() + || ipv4_addr.is_multicast() + || *ipv4_addr == ipv4_inet.last_address() + } + + fn is_all_peers_broadcast_ipv6(&self, ipv6_addr: &Ipv6Addr) -> bool { + let network_length = self + .context + .ipv6() + .map(|x| x.network_length()) + .unwrap_or(64); + let ipv6_inet = cidr::Ipv6Inet::new(*ipv6_addr, network_length).unwrap(); + ipv6_addr.is_multicast() || *ipv6_addr == ipv6_inet.last_address() + } + + fn select_ipv4_broadcast_peers<'a>( + routes: impl IntoIterator, + my_peer_id: PeerId, + ) -> Vec { + routes + .into_iter() + .filter_map(|route| { + (route.peer_id != my_peer_id && route.ipv4_addr.is_some()).then_some(route.peer_id) + }) + .collect() + } + + pub async fn get_msg_dst_peer_ipv4(&self, ipv4_addr: &Ipv4Addr) -> (Vec, bool) { + let mut is_exit_node = false; + let mut dst_peers = vec![]; + if self.is_all_peers_broadcast_ipv4(ipv4_addr) { + dst_peers.extend(Self::select_ipv4_broadcast_peers( + &self.peers.list_route_infos().await, + self.my_peer_id, + )); + } else if let Some(peer_id) = self.peers.get_peer_id_by_ipv4(ipv4_addr).await { + dst_peers.push(peer_id); + } else if !self + .context + .is_ip_in_same_network(&std::net::IpAddr::V4(*ipv4_addr)) + { + for exit_node in self.exit_nodes.read().await.iter() { + let IpAddr::V4(exit_node) = exit_node else { + continue; + }; + if let Some(peer_id) = self.peers.get_peer_id_by_ipv4(exit_node).await { + dst_peers.push(peer_id); + is_exit_node = true; + break; + } + } + } + if self.host_routing.local_exit_node_fallback + && dst_peers.is_empty() + && !self + .context + .is_ip_in_same_network(&std::net::IpAddr::V4(*ipv4_addr)) + { + tracing::trace!( + %ipv4_addr, + "no peer route for external IPv4; use local exit-node fallback" + ); + dst_peers.push(self.my_peer_id); + is_exit_node = true; + } + (dst_peers, is_exit_node) + } + + pub async fn get_msg_dst_peer_ipv6(&self, ipv6_addr: &Ipv6Addr) -> (Vec, bool) { + let mut is_exit_node = false; + let mut dst_peers = vec![]; + if self.is_all_peers_broadcast_ipv6(ipv6_addr) { + dst_peers.extend(self.peers.list_routes().await.iter().map(|x| *x.key())); + } else if let Some(peer_id) = self.peers.get_peer_id_by_ipv6(ipv6_addr).await { + dst_peers.push(peer_id); + } else if !ipv6_addr.is_unicast_link_local() + && let Some(peer_id) = self.route.get_public_ipv6_gateway_peer_id().await + { + dst_peers.push(peer_id); + } else if !ipv6_addr.is_unicast_link_local() { + // NOTE: never route link local address to exit node. + for exit_node in self.exit_nodes.read().await.iter() { + let IpAddr::V6(exit_node) = exit_node else { + continue; + }; + if let Some(peer_id) = self.peers.get_peer_id_by_ipv6(exit_node).await { + dst_peers.push(peer_id); + is_exit_node = true; + break; + } + } + } + + (dst_peers, is_exit_node) + } + + pub async fn send_msg_by_ip( + &self, + mut msg: ZCPacket, + ip_addr: IpAddr, + not_send_to_self: bool, + ) -> Result<(), Error> { + tracing::trace!( + "do send_msg in peer manager, msg: {:?}, ip_addr: {}", + msg, + ip_addr + ); + + msg.fill_peer_manager_hdr(self.my_peer_id, 0, PacketType::Data as u8); + if !self.run_nic_packet_process_pipeline(&mut msg).await { + return Ok(()); + } + let packet_policy = self.context.packet_policy(); + let cur_to_peer_id = msg.peer_manager_header().unwrap().to_peer_id.into(); + if cur_to_peer_id != 0 { + self.mark_recent_traffic_with_policy(cur_to_peer_id, packet_policy); + return send_msg_internal( + self.peers.as_ref(), + &self.foreign_network_client, + &self.relay_peer_map, + Some(&self.traffic_metrics), + msg, + cur_to_peer_id, + ) + .await; + } + + let (dst_peers, is_exit_node) = match ip_addr { + IpAddr::V4(ipv4_addr) => self.get_msg_dst_peer_ipv4(&ipv4_addr).await, + IpAddr::V6(ipv6_addr) => self.get_msg_dst_peer_ipv6(&ipv6_addr).await, + }; + + if dst_peers.is_empty() { + tracing::info!("no peer id for ip: {}", ip_addr); + return Ok(()); + } + + self.counters + .compress_tx_bytes_before + .add(msg.buf_len() as u64); + + try_compress_and_encrypt( + self.data_compress_algo, + &self.encryptor, + &mut msg, + self.is_secure_mode_enabled, + ) + .await?; + + self.counters + .compress_tx_bytes_after + .add(msg.buf_len() as u64); + + msg.mut_peer_manager_header() + .unwrap() + .set_latency_first(packet_policy.latency_first) + .set_exit_node(is_exit_node); + + let mut errs: Vec = vec![]; + let mut msg = Some(msg); + let total_dst_peers = dst_peers.len(); + let should_mark_recent_traffic = should_mark_recent_traffic_for_fanout(total_dst_peers); + for (i, peer_id) in dst_peers.iter().enumerate() { + if should_mark_recent_traffic { + self.mark_recent_traffic_with_policy(*peer_id, packet_policy); + } + if let Err(e) = self.check_p2p_only_before_send(*peer_id, packet_policy) { + errs.push(e); + continue; + } + + let mut msg = if i == total_dst_peers - 1 { + msg.take().unwrap() + } else { + msg.clone().unwrap() + }; + + let hdr = msg.mut_peer_manager_header().unwrap(); + hdr.to_peer_id.set(*peer_id); + + if !self.host_routing.local_exit_node_fallback + && not_send_to_self + && *peer_id == self.my_peer_id + && !self.context.is_ip_local_virtual_ip(&ip_addr) + { + // Keep the loop-prevention flags for proxy-induced self-delivery where + // the destination is not this node's own EasyTier-managed IP. + hdr.set_not_send_to_tun(true); + hdr.set_no_proxy(true); + } + + self.counters.self_tx_bytes.add(msg.buf_len() as u64); + self.counters.self_tx_packets.inc(); + + if let Err(e) = send_msg_internal( + self.peers.as_ref(), + &self.foreign_network_client, + &self.relay_peer_map, + Some(&self.traffic_metrics), + msg, + *peer_id, + ) + .await + { + errs.push(e); + } + } + + tracing::trace!(?dst_peers, "do send_msg in peer manager done"); + + if errs.is_empty() { + Ok(()) + } else { + tracing::error!(?errs, "send_msg has error"); + Err(anyhow::anyhow!("send_msg has error: {:?}", errs).into()) + } + } +} + +struct PeerPacketRouterCounters { + self_tx_packets: CounterHandle, + self_tx_bytes: CounterHandle, + self_rx_packets: CounterHandle, + self_rx_bytes: CounterHandle, + forward_data_tx_packets: CounterHandle, + forward_data_tx_bytes: CounterHandle, + forward_control_tx_packets: CounterHandle, + forward_control_tx_bytes: CounterHandle, + compress_tx_bytes_before: CounterHandle, + compress_tx_bytes_after: CounterHandle, + compress_rx_bytes_before: CounterHandle, + compress_rx_bytes_after: CounterHandle, +} + +pub(crate) struct PeerPacketRouter { + packet_recv: PacketRecvChanReceiver, + my_peer_id: PeerId, + peers: Arc, + peer_packet_process_pipeline: PeerPacketPipeline, + foreign_client: Arc, + relay_peer_map: Arc, + foreign_network_manager: Arc, + encryptor: Arc, + compress_algo: CompressorAlgo, + acl_filter: Arc, + context: ArcPeerContext, + secure_mode_enabled: bool, + route: ArcRoute, + is_credential_node: bool, + traffic_metrics: Arc, + stats_mgr: Arc, + counters: PeerPacketRouterCounters, +} + +impl PeerPacketRouter { + #[allow(clippy::too_many_arguments)] + fn new( + packet_recv: PacketRecvChanReceiver, + my_peer_id: PeerId, + peers: Arc, + peer_packet_process_pipeline: PeerPacketPipeline, + foreign_client: Arc, + relay_peer_map: Arc, + foreign_network_manager: Arc, + encryptor: Arc, + compress_algo: CompressorAlgo, + acl_filter: Arc, + context: ArcPeerContext, + secure_mode_enabled: bool, + route: ArcRoute, + is_credential_node: bool, + traffic_metrics: Arc, + stats_mgr: Arc, + network_name: String, + self_tx_packets: CounterHandle, + self_tx_bytes: CounterHandle, + compress_tx_bytes_before: CounterHandle, + compress_tx_bytes_after: CounterHandle, + ) -> Self { + let label_set = LabelSet::new().with_label_type(LabelType::NetworkName(network_name)); + Self { + packet_recv, + my_peer_id, + peers, + peer_packet_process_pipeline, + foreign_client, + relay_peer_map, + foreign_network_manager, + encryptor, + compress_algo, + acl_filter, + context, + secure_mode_enabled, + route, + is_credential_node, + traffic_metrics, + stats_mgr: stats_mgr.clone(), + counters: PeerPacketRouterCounters { + self_tx_packets, + self_tx_bytes, + self_rx_bytes: stats_mgr + .get_counter(MetricName::TrafficBytesSelfRx, label_set.clone()), + self_rx_packets: stats_mgr + .get_counter(MetricName::TrafficPacketsSelfRx, label_set.clone()), + forward_data_tx_bytes: stats_mgr + .get_counter(MetricName::TrafficBytesForwarded, label_set.clone()), + forward_data_tx_packets: stats_mgr + .get_counter(MetricName::TrafficPacketsForwarded, label_set.clone()), + forward_control_tx_bytes: stats_mgr + .get_counter(MetricName::TrafficControlBytesForwarded, label_set.clone()), + forward_control_tx_packets: stats_mgr.get_counter( + MetricName::TrafficControlPacketsForwarded, + label_set.clone(), + ), + compress_tx_bytes_before, + compress_tx_bytes_after, + compress_rx_bytes_before: stats_mgr + .get_counter(MetricName::CompressionBytesRxBefore, label_set.clone()), + compress_rx_bytes_after: stats_mgr + .get_counter(MetricName::CompressionBytesRxAfter, label_set), + }, + } + } + + pub async fn run(mut self) { + tracing::trace!("start_peer_recv"); + while let Ok(envelope) = recv_packet_envelope_from_chan(&mut self.packet_recv).await { + let (ret, ingress) = envelope.into_parts(); + let disable_relay_data = self.context.disable_relay_data(); + let destination_is_attached = ret + .peer_manager_header() + .is_some_and(|header| self.peers.has_direct_attached_peer(header.to_peer_id.get())); + let drop_foreign_relay_data = disable_relay_data + && is_relay_data_zc_packet(&ret) + && !ingress.is_attached() + && !destination_is_attached; + let Err(ret) = try_handle_foreign_network_packet( + ret, + self.my_peer_id, + &self.peers, + &self.foreign_network_manager, + self.stats_mgr.as_ref(), + drop_foreign_relay_data, + ) + .await + else { + continue; + }; + + self.handle_packet(ret, disable_relay_data, ingress).await; + } + panic!("done_peer_recv"); + } + + async fn handle_packet( + &self, + mut ret: ZCPacket, + disable_relay_data: bool, + ingress: PeerPacketIngress, + ) { + let buf_len = ret.buf_len(); + let destination_is_attached = ret + .peer_manager_header() + .is_some_and(|header| self.peers.has_direct_attached_peer(header.to_peer_id.get())); + let drop_relay_data = should_drop_relay_data( + disable_relay_data, + &ret, + self.my_peer_id, + ingress, + destination_is_attached, + ); + let Some(hdr) = ret.mut_peer_manager_header() else { + tracing::warn!(?ret, "invalid packet, skip"); + return; + }; + + tracing::trace!(?hdr, "peer recv a packet..."); + let from_peer_id = hdr.from_peer_id.get(); + let to_peer_id = hdr.to_peer_id.get(); + let packet_type = hdr.packet_type; + let is_encrypted = hdr.is_encrypted(); + if to_peer_id != self.my_peer_id { + if drop_relay_data { + let ingress_connection = ingress.peer_connection(); + tracing::debug!( + ?from_peer_id, + ?to_peer_id, + packet_type, + ?ingress_connection, + "drop forwarded relay data while relay data is disabled" + ); + return; + } + + if hdr.forward_counter > 7 { + tracing::warn!(?hdr, "forward counter exceed, drop packet"); + return; + } + + // Step 10b: credential nodes don't forward handshake packets + if self.is_credential_node + && (packet_type == PacketType::HandShake as u8 + || packet_type == PacketType::NoiseHandshakeMsg1 as u8 + || packet_type == PacketType::NoiseHandshakeMsg2 as u8 + || packet_type == PacketType::NoiseHandshakeMsg3 as u8) + { + tracing::debug!("credential node dropping forwarded handshake packet"); + return; + } + + if hdr.forward_counter > 2 && hdr.is_latency_first() { + tracing::trace!(?hdr, "set_latency_first false because too many hop"); + hdr.set_latency_first(false); + } + + hdr.forward_counter += 1; + + if from_peer_id == self.my_peer_id { + self.counters.compress_tx_bytes_before.add(buf_len as u64); + + if packet_type == PacketType::Data as u8 + || packet_type == PacketType::KcpSrc as u8 + || packet_type == PacketType::KcpDst as u8 + { + let _ = try_compress_and_encrypt( + self.compress_algo, + &self.encryptor, + &mut ret, + self.secure_mode_enabled, + ) + .await; + } + + self.counters + .compress_tx_bytes_after + .add(ret.buf_len() as u64); + self.counters.self_tx_bytes.add(ret.buf_len() as u64); + self.counters.self_tx_packets.inc(); + } else { + match traffic_kind(packet_type) { + TrafficKind::Data => { + self.counters.forward_data_tx_bytes.add(buf_len as u64); + self.counters.forward_data_tx_packets.inc(); + } + TrafficKind::Control => { + self.counters.forward_control_tx_bytes.add(buf_len as u64); + self.counters.forward_control_tx_packets.inc(); + } + } + } + + tracing::trace!(?to_peer_id, my_peer_id = ?self.my_peer_id, "need forward"); + let tx_metrics = if from_peer_id == self.my_peer_id { + Some(&self.traffic_metrics) + } else { + None + }; + let ret = send_msg_internal( + self.peers.as_ref(), + &self.foreign_client, + &self.relay_peer_map, + tx_metrics, + ret, + to_peer_id, + ) + .await; + if ret.is_err() { + tracing::error!(?ret, ?to_peer_id, ?from_peer_id, "forward packet error"); + } + } else { + if packet_type == PacketType::RelayHandshake as u8 + || packet_type == PacketType::RelayHandshakeAck as u8 + { + let _ = self.relay_peer_map.handle_handshake_packet(ret).await; + return; + } + if !self.secure_mode_enabled { + if let Err(e) = self.encryptor.decrypt(&mut ret) { + tracing::error!(?e, "decrypt failed"); + return; + } + } else if is_encrypted { + match self.relay_peer_map.decrypt_if_needed(&mut ret).await { + Ok(true) => {} + Ok(false) => { + tracing::error!("secure session not found"); + return; + } + Err(e) => { + tracing::error!(?e, "secure decrypt failed"); + return; + } + } + } + + self.counters.self_rx_bytes.add(buf_len as u64); + self.counters.self_rx_packets.inc(); + self.traffic_metrics + .record_rx(from_peer_id, packet_type, buf_len as u64) + .await; + self.counters.compress_rx_bytes_before.add(buf_len as u64); + + let compressor = DefaultCompressor {}; + if let Err(e) = compressor.decompress(&mut ret).await { + tracing::error!(?e, "decompress failed"); + return; + } + + self.counters + .compress_rx_bytes_after + .add(ret.buf_len() as u64); + + if !self.acl_filter.process_packet_with_acl( + &ret, + true, + self.context.ipv4().map(|x| x.address()), + |dst| self.context.is_ip_local_ipv6(&dst), + self.route.as_ref(), + ) { + return; + } + + let mut processed = false; + let mut zc_packet = Some(ret); + tracing::trace!(?zc_packet, "try_process_packet_from_peer"); + let pipelines = self.peer_packet_process_pipeline.load_full(); + for pipeline in pipelines.iter().rev() { + if let Some(filter) = pipeline.filter_if_active() { + zc_packet = filter + .try_process_packet_from_peer(zc_packet.unwrap()) + .await; + } + if zc_packet.is_none() { + processed = true; + break; + } + } + if !processed { + tracing::error!(?zc_packet, "unhandled packet"); + } + } + } +} + +pub(crate) fn is_relay_data_packet(packet_type: u8) -> bool { + super::traffic_metrics::is_relay_data_packet_type(packet_type) +} + +pub(crate) fn is_relay_data_zc_packet(packet: &ZCPacket) -> bool { + let Some(hdr) = packet.peer_manager_header() else { + return false; + }; + + if hdr.packet_type == PacketType::ForeignNetworkPacket as u8 { + let inner_packet_type = packet.foreign_network_inner_packet_type(); + if inner_packet_type.is_none() { + tracing::warn!( + ?hdr, + "foreign network packet has unparseable inner peer manager header" + ); + } + return inner_packet_type.is_none_or(is_relay_data_packet); + } + + is_relay_data_packet(hdr.packet_type) +} + +fn should_drop_relay_data( + disable_relay_data: bool, + packet: &ZCPacket, + my_peer_id: PeerId, + ingress: PeerPacketIngress, + destination_is_attached: bool, +) -> bool { + if !disable_relay_data || !is_relay_data_zc_packet(packet) { + return false; + } + + let is_forwarded = packet + .peer_manager_header() + .is_some_and(|header| header.to_peer_id.get() != my_peer_id); + is_forwarded && !ingress.is_attached() && !destination_is_attached +} + +pub(crate) async fn try_handle_foreign_network_packet( + mut packet: ZCPacket, + my_peer_id: PeerId, + peer_map: &PeerMap, + foreign_network_manager: &ForeignNetworkManager, + stats_manager: &StatsManager, + drop_relay_data: bool, +) -> Result<(), ZCPacket> { + let pm_header = packet.peer_manager_header().unwrap(); + if pm_header.packet_type != PacketType::ForeignNetworkPacket as u8 { + return Err(packet); + } + + let from_peer_id = pm_header.from_peer_id.get(); + let to_peer_id = pm_header.to_peer_id.get(); + + if drop_relay_data { + tracing::debug!( + ?from_peer_id, + ?to_peer_id, + inner_packet_type = ?packet.foreign_network_inner_packet_type(), + "drop foreign network relay data while relay data is disabled" + ); + return Ok(()); + } + + let foreign_hdr = packet.foreign_network_hdr().unwrap(); + let foreign_network_name = foreign_hdr.get_network_name(packet.payload()); + let foreign_peer_id = foreign_hdr.get_dst_peer_id(); + + let foreign_network_my_peer_id = + foreign_network_manager.get_network_peer_id(&foreign_network_name); + + let buf_len = packet.buf_len(); + let label_set = + LabelSet::new().with_label_type(LabelType::NetworkName(foreign_network_name.clone())); + let add_counter = move |bytes_metric, packets_metric| { + stats_manager + .get_counter(bytes_metric, label_set.clone()) + .add(buf_len as u64); + stats_manager.get_counter(packets_metric, label_set).inc(); + }; + + // NOTICE: the to peer id is modified by the src from foreign network my peer id to the origin my peer id + if to_peer_id == my_peer_id { + // packet sent from other peer to me, extract the inner packet and forward it + add_counter( + MetricName::TrafficBytesForeignForwardRx, + MetricName::TrafficPacketsForeignForwardRx, + ); + if let Err(e) = foreign_network_manager + .forward_foreign_network_packet( + &foreign_network_name, + foreign_peer_id, + packet.foreign_network_packet(), + ) + .await + { + tracing::debug!( + ?e, + ?foreign_network_name, + ?foreign_peer_id, + "foreign network mgr send_msg_to_peer failed" + ); + } + Ok(()) + } else if Some(from_peer_id) == foreign_network_my_peer_id { + // to_peer_id is my peer id for the foreign network, need to convert to the origin my_peer_id of dst + let Some(to_peer_id) = peer_map + .get_origin_my_peer_id(&foreign_network_name, to_peer_id) + .await + else { + tracing::debug!( + ?foreign_network_name, + ?to_peer_id, + "cannot find origin my peer id for foreign network." + ); + return Err(packet); + }; + + add_counter( + MetricName::TrafficBytesForeignForwardTx, + MetricName::TrafficPacketsForeignForwardTx, + ); + + // modify the to_peer id from foreign network my peer id to the origin my peer id + packet + .mut_peer_manager_header() + .unwrap() + .to_peer_id + .set(to_peer_id); + + // packet is generated from foreign network mgr and should be forward to other peer + if let Err(e) = peer_map + .send_msg(packet, to_peer_id, NextHopPolicy::LeastHop) + .await + { + tracing::debug!( + ?e, + ?to_peer_id, + "send_msg_directly failed when forward local generated foreign network packet" + ); + } + Ok(()) + } else { + // target is not me, forward it. try get origin peer id + add_counter( + MetricName::TrafficBytesForeignForwardForwarded, + MetricName::TrafficPacketsForeignForwardForwarded, + ); + Err(packet) + } +} + +struct PeerManagerRouteInterface { + my_peer_id: PeerId, + peers: Weak, + foreign_network_client: Weak, + foreign_network_manager: Weak, +} + +#[async_trait::async_trait] +impl RouteInterface for PeerManagerRouteInterface { + async fn list_peers(&self) -> Vec { + let Some(foreign_client) = self.foreign_network_client.upgrade() else { + return vec![]; + }; + + let Some(peer_map) = self.peers.upgrade() else { + return vec![]; + }; + + let mut peers = foreign_client.list_public_peers().await; + peers.extend(peer_map.list_peers_with_conn().await); + peers + } + + fn my_peer_id(&self) -> PeerId { + self.my_peer_id + } + + async fn close_peer(&self, peer_id: PeerId) { + if let Some(peer_map) = self.peers.upgrade() { + let _ = peer_map.close_peer(peer_id).await; + } + + if let Some(foreign_client) = self.foreign_network_client.upgrade() { + let _ = foreign_client.get_peer_map().close_peer(peer_id).await; + } + } + + async fn get_peer_public_key(&self, peer_id: PeerId) -> Option> { + let peer_map = self.peers.upgrade()?; + peer_map.get_peer_public_key(peer_id) + } + + async fn get_peer_identity_type(&self, peer_id: PeerId) -> Option { + let peer_map = self.peers.upgrade()?; + peer_map.get_peer_identity_type(peer_id) + } + + async fn list_foreign_networks(&self) -> ForeignNetworkRouteInfoMap { + let ret = ForeignNetworkRouteInfoMap::new(); + let Some(foreign_network_manager) = self.foreign_network_manager.upgrade() else { + return ret; + }; + + let networks = foreign_network_manager + .list_foreign_network_route_infos() + .await; + for info in networks { + if info.peer_ids.is_empty() { + continue; + } + + let last_update = foreign_network_manager + .get_foreign_network_last_update(&info.network_name) + .unwrap_or(SystemTime::now()); + ret.insert( + ForeignNetworkRouteInfoKey { + peer_id: self.my_peer_id, + network_name: info.network_name, + }, + ForeignNetworkRouteInfoEntry { + foreign_peer_ids: info.peer_ids, + last_update: Some(last_update.into()), + version: 0, + network_secret_digest: info.network_secret_digest, + my_peer_id_for_this_network: info.my_peer_id_for_this_network, + }, + ); + } + ret + } +} + +pub(crate) async fn send_msg_internal( + peers: &PeerMap, + foreign_network_client: &Arc, + relay_peer_map: &Arc, + direct_tx_metrics: Option<&Arc>, + msg: ZCPacket, + dst_peer_id: PeerId, +) -> Result<(), Error> { + let policy = get_next_hop_policy(msg.peer_manager_header().unwrap().is_latency_first()); + let is_latency_first = msg.peer_manager_header().unwrap().is_latency_first(); + let packet_type = msg.peer_manager_header().unwrap().packet_type; + let msg_len = msg.buf_len() as u64; + let latency_first_gateway = if is_latency_first { + peers + .get_gateway_peer_id(dst_peer_id, policy.clone()) + .await + .filter(|gateway| *gateway != dst_peer_id) + } else { + None + }; + let send_result = if let Some(gateway) = latency_first_gateway + && (peers.has_peer(gateway) || foreign_network_client.has_next_hop(gateway)) + { + relay_peer_map.send_msg(msg, dst_peer_id, policy).await + } else if let Some(peer) = peers.get_peer_by_id(dst_peer_id) { + peer.send_msg(msg).await + } else if peers.is_self(dst_peer_id) { + peers.send_msg_directly(msg, dst_peer_id).await + } else if foreign_network_client.has_next_hop(dst_peer_id) { + foreign_network_client.send_msg(msg, dst_peer_id).await + } else if let Some(gateway) = peers.get_gateway_peer_id(dst_peer_id, policy.clone()).await { + if peers.has_peer(gateway) || foreign_network_client.has_next_hop(gateway) { + relay_peer_map.send_msg(msg, dst_peer_id, policy).await + } else { + tracing::warn!( + ?gateway, + ?dst_peer_id, + "cannot send msg to peer through gateway" + ); + Err(Error::RouteError(None)) + } + } else if foreign_network_client.has_next_hop(dst_peer_id) { + // check foreign network again. so in happy path we can avoid extra check + foreign_network_client.send_msg(msg, dst_peer_id).await + } else { + tracing::debug!(?dst_peer_id, "no gateway for peer"); + Err(Error::RouteError(None)) + }; + + if send_result.is_ok() + && let Some(metrics) = direct_tx_metrics + { + metrics.record_tx(dst_peer_id, packet_type, msg_len).await; + } + + send_result +} + +#[cfg(test)] +mod tests { + use std::{ + sync::atomic::{AtomicUsize, Ordering}, + time::Duration, + }; + + use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; + use dashmap::DashMap; + use quanta::Instant; + use x25519_dalek::{PublicKey, StaticSecret}; + + use super::*; + use crate::{ + config::runtime::CoreRuntimeConfig, + config::{CoreConfig, IpPrefix, NetworkIdentity, NodeConfig, ProxyNetworkConfig}, + host::packet::{HostPacketSender, host_packet_channel}, + peers::context::{PeerContext, PeerEvent}, + proto::common::{PeerFeatureFlag, StunInfo}, + }; + + impl PeerManagerCore { + pub(crate) fn new_portable_for_test( + config: PortablePeerManagerConfig, + nic_channel: HostPacketSender, + ) -> anyhow::Result { + let runtime_config = CoreRuntimeConfigStore::new( + CoreRuntimeConfig::default(), + Arc::new(config.snapshot.clone()), + ); + let public_ipv6_runtime = + CorePublicIpv6Runtime::new(runtime_config.clone(), Arc::new(()), Arc::new(())); + let stun_info_source = Arc::new(RuntimeConfigStunInfoSource(runtime_config.clone())); + Self::new( + config, + Vec::new(), + runtime_config, + stun_info_source, + nic_channel, + public_ipv6_runtime, + Arc::new(()), + None, + Arc::new(()), + ) + } + } + + struct RuntimeConfigStunInfoSource(CoreRuntimeConfigStore); + + impl PeerStunInfoSource for RuntimeConfigStunInfoSource { + fn stun_info(&self) -> StunInfo { + self.0.snapshot().peer.runtime.stun_info.clone() + } + } + + struct SameNetworkContext { + contains_every_address: bool, + } + + impl PeerContext for SameNetworkContext { + fn network_identity(&self) -> NetworkIdentity { + NetworkIdentity { + network_name: "test".to_string(), + network_secret: None, + network_secret_digest: None, + } + } + + fn is_ip_in_same_network(&self, ip: &IpAddr) -> bool { + self.contains_every_address + || matches!(ip, IpAddr::V4(ip) if ip.octets()[0..2] == [10, 144]) + } + } + + #[derive(Default)] + struct CountingPeerEventSink(AtomicUsize); + + impl crate::events::CoreEventSink for CountingPeerEventSink { + fn emit(&self, _event: crate::events::CoreEvent) { + self.0.fetch_add(1, Ordering::Relaxed); + } + } + + struct DropCountingNicFilter(Arc); + + impl Drop for DropCountingNicFilter { + fn drop(&mut self) { + self.0.fetch_add(1, Ordering::Relaxed); + } + } + + #[async_trait::async_trait] + impl super::super::NicPacketFilter for DropCountingNicFilter { + async fn try_process_packet_from_nic(&self, _data: &mut ZCPacket) -> bool { + true + } + } + + #[tokio::test] + async fn full_host_packet_queue_does_not_block_peer_packet_processing() { + let (nic_channel, mut nic_receiver) = mpsc::channel(1); + nic_channel + .send(HostPacket::copy_from_payload(b"queued")) + .await + .unwrap(); + let processor = NicPacketProcessor { nic_channel }; + let mut packet = ZCPacket::new_with_payload(b"next"); + packet.fill_peer_manager_hdr(1, 2, PacketType::Data as u8); + + let result = tokio::time::timeout( + Duration::from_millis(100), + processor.try_process_packet_from_peer(packet), + ) + .await; + + assert!(result.is_ok(), "a full host queue blocked the peer router"); + assert!(result.unwrap().is_none()); + assert_eq!(nic_receiver.try_recv().unwrap().payload(), b"queued"); + } + + #[test] + fn managed_nic_pipeline_removal_preserves_in_flight_snapshot() { + let drops = Arc::new(AtomicUsize::new(0)); + let pipeline = Arc::new(ArcSwap::from_pointee(Vec::new())); + let (entry, registration) = + managed_nic_pipeline_entry(Box::new(DropCountingNicFilter(drops.clone())), &pipeline); + append_nic_pipeline(&pipeline, entry); + let reader = pipeline.load_full(); + + registration.close(); + + assert!(pipeline.load().is_empty()); + assert_eq!(drops.load(Ordering::Relaxed), 0); + + drop(reader); + assert_eq!(drops.load(Ordering::Relaxed), 1); + } + + #[test] + fn managed_pipeline_guard_releases_filter_without_a_runtime() { + let drops = Arc::new(AtomicUsize::new(0)); + let pipeline = Arc::new(ArcSwap::from_pointee(Vec::new())); + let (entry, registration) = + managed_nic_pipeline_entry(Box::new(DropCountingNicFilter(drops.clone())), &pipeline); + append_nic_pipeline(&pipeline, entry); + + drop(registration); + + assert!(pipeline.load().is_empty()); + assert_eq!(drops.load(Ordering::Relaxed), 1); + } + + fn portable_runtime_config(network_name: &str) -> PeerRuntimeConfig { + PeerRuntimeConfig { + core: CoreConfig { + node: NodeConfig { + peer_id: None, + network_name: network_name.to_owned(), + ..Default::default() + }, + ..Default::default() + }, + network_identity: NetworkIdentity { + network_name: network_name.to_owned(), + network_secret: Some("secret".to_owned()), + network_secret_digest: None, + }, + stun_info: StunInfo::default(), + feature_flags: PeerFeatureFlag::default(), + secure_mode: None, + host_routing: HostRoutingPolicy::default(), + } + } + + fn credential_secure_mode() -> crate::proto::common::SecureModeConfig { + let private = StaticSecret::from([7; 32]); + let public = PublicKey::from(&private); + crate::proto::common::SecureModeConfig { + enabled: true, + local_private_key: Some(BASE64_STANDARD.encode(private.as_bytes())), + local_public_key: Some(BASE64_STANDARD.encode(public.as_bytes())), + } + } + + fn build_portable_for_test(runtime: PeerRuntimeConfig) -> anyhow::Result { + build_portable_config_for_test(PortablePeerManagerConfig::new(runtime)) + } + + fn build_portable_config_for_test( + config: PortablePeerManagerConfig, + ) -> anyhow::Result { + let (packet_tx, _packet_rx) = host_packet_channel(); + PeerManagerCore::new_portable_for_test(config, packet_tx) + } + + #[tokio::test] + async fn portable_peer_manager_builds_and_stops_from_normalized_config() { + let runtime = portable_runtime_config("portable-net"); + let core = build_portable_for_test(runtime).unwrap(); + + assert_eq!(core.context.network_name(), "portable-net"); + assert_ne!(core.context.instance_id(), uuid::Uuid::nil()); + assert_eq!(core.data_compress_algo, CompressorAlgo::None); + assert!(core.list_foreign_network_infos(false).await.is_empty()); + + core.run().await.unwrap(); + let route = core.route_algo_inst.ospf_route().unwrap(); + assert!(route.task_count() > 0); + assert!(!core.stats_manager().cleanup_task_is_stopped()); + assert!(!core.acl_filter.cleanup_task_is_stopped()); + core.clear_resources().await; + assert_eq!(route.task_count(), 0); + assert!(core.stats_manager().cleanup_task_is_stopped()); + assert!(core.acl_filter.cleanup_task_is_stopped()); + assert!(core.foreign_network_manager.is_stopped_for_test().await); + assert!( + !core + .foreign_network_manager + .admission_is_open_for_test() + .await + ); + } + #[tokio::test] + async fn runtime_updates_retain_manager_owned_peer_identity() { + let core = build_portable_for_test(portable_runtime_config("portable-net")).unwrap(); + let current = core.runtime_config.snapshot(); + let expected_peer_id = core.my_peer_id(); + let expected_instance_id = current.peer.runtime.core.node.instance_id; + let mut next = current.as_ref().clone(); + let next_peer = Arc::make_mut(&mut next.peer); + next_peer.runtime.core.node.peer_id = Some(expected_peer_id.wrapping_add(1)); + next_peer.runtime.core.node.instance_id = Some([1; 16]); + let submitted = next.peer.clone(); + + let published = core.update_runtime_config(next).await.unwrap(); + + assert_eq!( + published.peer.runtime.core.node.peer_id, + Some(expected_peer_id) + ); + assert_eq!( + published.peer.runtime.core.node.instance_id, + expected_instance_id + ); + assert_eq!( + submitted.runtime.core.node.peer_id, + Some(expected_peer_id.wrapping_add(1)) + ); + assert_eq!(submitted.runtime.core.node.instance_id, Some([1; 16])); + core.clear_resources().await; + } + + #[cfg(not(feature = "zstd"))] + #[tokio::test] + async fn portable_peer_manager_rejects_requested_unavailable_zstd() { + let mut config = PortablePeerManagerConfig::new(portable_runtime_config("portable-net")); + config.snapshot.flags.data_compress_algo = + crate::proto::common::CompressionAlgoPb::Zstd.into(); + + let error = build_portable_config_for_test(config).err().unwrap(); + + assert_eq!( + error.to_string(), + "compression algorithm is unavailable in this build: ZstdDefault" + ); + } + + #[cfg(not(any( + feature = "aes-gcm", + feature = "openssl-crypto", + feature = "ring-crypto" + )))] + #[tokio::test] + async fn portable_peer_manager_rejects_requested_unavailable_aes() { + let mut config = PortablePeerManagerConfig::new(portable_runtime_config("portable-net")); + config.snapshot.flags.enable_encryption = true; + config.snapshot.flags.encryption_algorithm = "aes-gcm".to_owned(); + + let error = build_portable_config_for_test(config).err().unwrap(); + + assert_eq!( + error.to_string(), + "encryption algorithm is unavailable in this build: aes-gcm" + ); + } + + #[tokio::test] + async fn portable_peer_manager_rejects_unknown_encryption_algorithm() { + let mut config = PortablePeerManagerConfig::new(portable_runtime_config("portable-net")); + config.snapshot.flags.enable_encryption = true; + config.snapshot.flags.encryption_algorithm = "rot13".to_owned(); + + let error = build_portable_config_for_test(config).err().unwrap(); + + assert_eq!(error.to_string(), "invalid encryption algorithm: rot13"); + } + + #[tokio::test] + async fn unknown_ipv6_has_no_peer_destination() { + let core = build_portable_for_test(portable_runtime_config("ipv6-net")).unwrap(); + let unknown = "fd00::2".parse().unwrap(); + + let (peers, is_self) = core.get_msg_dst_peer_ipv6(&unknown).await; + + assert!(peers.is_empty()); + assert!(!is_self); + } + + #[tokio::test] + async fn foreign_network_stop_waits_for_inflight_admission() { + let core = build_portable_for_test(portable_runtime_config("portable-net")).unwrap(); + let manager = core.foreign_network_manager.clone(); + let entered = Arc::new(tokio::sync::Notify::new()); + let release = Arc::new(tokio::sync::Notify::new()); + let admission_manager = manager.clone(); + let admission_entered = entered.clone(); + let admission_release = release.clone(); + let admission = tokio::spawn(async move { + admission_manager + .hold_admission_for_test(admission_entered, admission_release) + .await + }); + entered.notified().await; + + let stop_manager = manager.clone(); + let stop = tokio::spawn(async move { stop_manager.stop().await }); + tokio::task::yield_now().await; + assert!(!stop.is_finished()); + + release.notify_waiters(); + admission.await.unwrap().unwrap(); + stop.await.unwrap(); + assert!(manager.is_stopped_for_test().await); + assert!(!manager.admission_is_open_for_test().await); + + core.clear_resources().await; + } + + #[tokio::test] + async fn portable_peer_manager_uses_host_context_adapters() { + let config = PortablePeerManagerConfig::new(portable_runtime_config("portable-net")); + let runtime_config = CoreRuntimeConfigStore::new( + CoreRuntimeConfig::default(), + Arc::new(config.snapshot.clone()), + ); + let public_ipv6_runtime = + CorePublicIpv6Runtime::new(runtime_config.clone(), Arc::new(()), Arc::new(())); + let events = Arc::new(CountingPeerEventSink::default()); + let (packet_tx, _packet_rx) = host_packet_channel(); + + let core = PeerManagerCore::new( + config, + Vec::new(), + runtime_config, + Arc::new(()), + packet_tx, + public_ipv6_runtime, + events.clone(), + None, + Arc::new(()), + ) + .unwrap(); + + core.context.issue_event(PeerEvent::PeerAdded(99)); + assert_eq!(events.0.load(Ordering::Relaxed), 1); + core.clear_resources().await; + } + + #[tokio::test] + async fn portable_peer_assembly_preserves_submitted_acl_groups() { + let mut config = PortablePeerManagerConfig::new(portable_runtime_config("portable-net")); + let acl = crate::proto::acl::Acl { + acl_v1: Some(crate::proto::acl::AclV1 { + chains: Vec::new(), + group: Some(crate::proto::acl::GroupInfo { + declares: vec![crate::proto::acl::GroupIdentity { + group_name: "ops".to_owned(), + group_secret: "ops-secret".to_owned(), + }], + members: vec!["ops".to_owned()], + }), + }), + }; + config.snapshot.set_acl_groups(Some(&acl)); + let (packet_tx, _packet_rx) = host_packet_channel(); + + let core = PeerManagerCore::new_portable_for_test(config, packet_tx).unwrap(); + + let groups = core.context.peer_groups(86); + assert_eq!(groups.len(), 1); + assert_eq!(groups[0].group_name, "ops"); + assert!(groups[0].verify("ops-secret", 86)); + assert_eq!(core.context.acl_group_declarations()[0].group_name, "ops"); + core.clear_resources().await; + } + + #[tokio::test] + async fn credential_peer_policy_sync_excludes_group_material() { + let mut runtime = portable_runtime_config("portable-net"); + runtime.network_identity.network_secret = None; + runtime.network_identity.network_secret_digest = None; + runtime.secure_mode = Some(credential_secure_mode()); + let core = Arc::new(build_portable_for_test(runtime).unwrap()); + + let acl = crate::proto::acl::Acl { + acl_v1: Some(crate::proto::acl::AclV1 { + chains: Vec::new(), + group: Some(crate::proto::acl::GroupInfo { + declares: vec![crate::proto::acl::GroupIdentity { + group_name: "ops".to_owned(), + group_secret: "ops-secret".to_owned(), + }], + members: vec!["ops".to_owned()], + }), + }), + }; + let mut services = CoreRuntimeConfig::default(); + services.acl.acl = Some(acl.clone()); + let mut source_peer = core.runtime_config.snapshot().peer.as_ref().clone(); + source_peer.set_acl_groups(Some(&acl)); + let source = CoreRuntimeConfigStore::new(services, Arc::new(source_peer)); + + core.follow_network_policy(source.clone(), vec!["ops".to_owned()]) + .await + .unwrap(); + + let applied = core.runtime_config.snapshot(); + assert!(applied.peer.acl_group_declarations.is_empty()); + assert!(applied.peer.peer_group_memberships.is_empty()); + assert!( + applied + .services + .acl + .acl + .as_ref() + .unwrap() + .acl_v1 + .as_ref() + .unwrap() + .group + .is_none() + ); + + source.update_services(|services| { + services.acl.tcp_whitelist = vec!["22".to_owned()]; + }); + tokio::time::timeout(Duration::from_secs(10), async { + loop { + let applied = core.runtime_config.snapshot(); + if applied.services.acl.tcp_whitelist == ["22"] { + assert!( + applied + .services + .acl + .acl + .as_ref() + .unwrap() + .acl_v1 + .as_ref() + .unwrap() + .group + .is_none() + ); + return; + } + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + core.clear_resources().await; + } + + #[tokio::test] + async fn node_snapshot_exposes_normalized_runtime_state() { + let instance_id = uuid::Uuid::from_u128(0x00112233445566778899aabbccddeeff); + let mut runtime = portable_runtime_config("portable-net"); + runtime.core.node.instance_id = Some(*instance_id.as_bytes()); + runtime.core.node.hostname = Some("portable-node".to_owned()); + runtime.core.routes.ipv4 = Some(IpPrefix::new("10.20.0.91".parse().unwrap(), 16).unwrap()); + runtime.core.routes.proxy_networks = vec![ProxyNetworkConfig { + real: IpPrefix::new("10.40.0.0".parse().unwrap(), 16).unwrap(), + mapped: Some(IpPrefix::new("10.50.0.0".parse().unwrap(), 16).unwrap()), + }]; + runtime.stun_info.public_ip = vec!["192.0.2.91".to_owned()]; + let core = build_portable_for_test(runtime).unwrap(); + let listener = Url::parse("tcp://0.0.0.0:11010").unwrap(); + + let snapshot = core.node_snapshot(vec![listener.clone()]).await; + + assert_eq!(snapshot.peer_id, core.my_peer_id()); + assert_eq!(snapshot.instance_id, instance_id); + assert_eq!(snapshot.hostname, "portable-node"); + assert_eq!(snapshot.ipv4_addr, Some("10.20.0.91/16".parse().unwrap())); + assert_eq!(snapshot.proxy_networks.len(), 1); + assert_eq!(snapshot.listeners, vec![listener]); + assert_eq!(snapshot.stun_info.public_ip, vec!["192.0.2.91"]); + assert_eq!(snapshot.version, env!("CARGO_PKG_VERSION")); + assert!(snapshot.public_ipv6_addr.is_none()); + assert!(snapshot.ipv6_public_addr_prefix.is_none()); + + let dns_identity = core.dns_route_identity(); + assert_eq!( + dns_identity, + ( + "portable-node".to_owned(), + Some("10.20.0.91/16".parse::().unwrap().into()), + String::new(), + ) + ); + } + + #[tokio::test] + async fn portable_peer_manager_auth_uses_managed_credentials() { + let admin_a = build_portable_for_test(portable_runtime_config("portable-net")).unwrap(); + let admin_b = build_portable_for_test(portable_runtime_config("portable-net")).unwrap(); + let generated = admin_a.credential_manager().generate_credential( + vec!["guest".to_owned()], + false, + Vec::new(), + Duration::from_secs(3600), + ); + let private_bytes: [u8; 32] = BASE64_STANDARD + .decode(generated.secret) + .unwrap() + .try_into() + .unwrap(); + let public_key = PublicKey::from(&StaticSecret::from(private_bytes)); + + assert!( + admin_a + .context + .is_pubkey_trusted(public_key.as_bytes(), "portable-net") + ); + assert!( + !admin_a + .context + .is_pubkey_trusted(public_key.as_bytes(), "other") + ); + let trusted = admin_a.context.trusted_credential_pubkeys("secret"); + assert_eq!(trusted.len(), 1); + + let propagated_key = trusted[0].credential.as_ref().unwrap().pubkey.clone(); + admin_b.context.update_trusted_keys( + std::collections::HashMap::from([( + propagated_key.clone(), + crate::peers::context::TrustedKeyMetadata { + source: crate::peers::context::TrustedKeySource::OspfCredential, + expiry_unix: None, + }, + )]), + "portable-net", + ); + assert!( + admin_b + .context + .is_pubkey_trusted(&propagated_key, "portable-net") + ); + assert!(admin_b.context.is_pubkey_trusted_with_source( + &propagated_key, + "portable-net", + crate::peers::context::TrustedKeySource::OspfCredential, + )); + assert!(!admin_b.context.is_pubkey_trusted_with_source( + &propagated_key, + "portable-net", + crate::peers::context::TrustedKeySource::OspfNode, + )); + + assert!( + admin_a + .credential_manager() + .revoke_credential(&generated.credential_id) + .unwrap() + ); + admin_b + .context + .update_trusted_keys(std::collections::HashMap::new(), "portable-net"); + assert!( + !admin_b + .context + .is_pubkey_trusted(&propagated_key, "portable-net") + ); + } + + #[tokio::test] + async fn portable_host_policy_controls_local_exit_node_fallback() { + let external_ipv4 = Ipv4Addr::new(203, 0, 113, 10); + let default_core = + build_portable_for_test(portable_runtime_config("portable-net")).unwrap(); + assert_eq!( + default_core.get_msg_dst_peer_ipv4(&external_ipv4).await, + (Vec::new(), false) + ); + + let mut runtime = portable_runtime_config("portable-net"); + runtime.host_routing.local_exit_node_fallback = true; + let fallback_core = build_portable_for_test(runtime).unwrap(); + assert_eq!( + fallback_core.get_msg_dst_peer_ipv4(&external_ipv4).await, + (vec![fallback_core.my_peer_id()], true) + ); + } + + #[tokio::test] + async fn portable_peer_manager_rejects_inconsistent_network_names() { + let mut runtime = portable_runtime_config("identity-net"); + runtime.core.node.network_name = "node-net".to_owned(); + let (packet_tx, _packet_rx) = host_packet_channel(); + + let result = PeerManagerCore::new_portable_for_test( + PortablePeerManagerConfig::new(runtime), + packet_tx, + ); + + assert!(result.is_err()); + } + + #[tokio::test] + async fn portable_peer_manager_rejects_unavailable_config_capabilities() { + let mut digest_mismatch = portable_runtime_config("portable-net"); + digest_mismatch.network_identity.network_secret_digest = Some([1; 32]); + assert!(build_portable_for_test(digest_mismatch).is_err()); + + let mut secure_without_keys = portable_runtime_config("portable-net"); + secure_without_keys.secure_mode = Some(crate::proto::common::SecureModeConfig { + enabled: true, + ..Default::default() + }); + assert!(build_portable_for_test(secure_without_keys).is_err()); + + let mut mismatched_keys = portable_runtime_config("portable-net"); + mismatched_keys.secure_mode = Some(credential_secure_mode()); + mismatched_keys + .secure_mode + .as_mut() + .unwrap() + .local_public_key = Some(BASE64_STANDARD.encode([9; 32])); + assert!(build_portable_for_test(mismatched_keys).is_err()); + + let mut credential_without_secure_mode = portable_runtime_config("portable-net"); + credential_without_secure_mode + .network_identity + .network_secret = None; + credential_without_secure_mode + .network_identity + .network_secret_digest = None; + assert!(build_portable_for_test(credential_without_secure_mode).is_err()); + } + + #[tokio::test] + async fn portable_peer_manager_accepts_credential_client_config() { + let mut runtime = portable_runtime_config("portable-net"); + runtime.network_identity.network_secret = None; + runtime.network_identity.network_secret_digest = None; + runtime.secure_mode = Some(credential_secure_mode()); + + let core = build_portable_for_test(runtime).unwrap(); + assert!(core.context.feature_flags().is_credential_peer); + assert!(core.context.network_identity().network_secret.is_none()); + assert!(core.is_secure_mode_enabled); + core.clear_resources().await; + } + + #[tokio::test] + async fn portable_peer_manager_accepts_legacy_unlimited_limits() { + let runtime = portable_runtime_config("portable-net"); + let mut flags = PortablePeerManagerConfig::new(runtime.clone()) + .snapshot + .flags; + flags.instance_recv_bps_limit = u64::MAX; + flags.foreign_relay_bps_limit = u64::MAX; + let mut config = PortablePeerManagerConfig::new(runtime.clone()); + config.snapshot = PeerRuntimeSnapshot::new(runtime, flags); + + let core = build_portable_config_for_test(config).unwrap(); + assert!(core.context.recv_limiter("portable-net", false).is_none()); + assert!(core.context.recv_limiter("foreign-net", true).is_none()); + core.clear_resources().await; + } + + #[tokio::test] + async fn portable_peer_manager_builds_configured_recv_limiters() { + let mut runtime = portable_runtime_config("portable-net"); + runtime.core.traffic.instance_recv_bps_limit = Some(1024); + runtime.core.traffic.foreign_relay_bps_limit = Some(2048); + let core = build_portable_for_test(runtime).unwrap(); + + let instance_a = core.context.recv_limiter("portable-net", false).unwrap(); + let instance_b = core.context.recv_limiter("other-net", false).unwrap(); + assert!(Arc::ptr_eq(&instance_a, &instance_b)); + + let foreign_a = core.context.recv_limiter("foreign-a", true).unwrap(); + let foreign_a_again = core.context.recv_limiter("foreign-a", true).unwrap(); + let foreign_b = core.context.recv_limiter("foreign-b", true).unwrap(); + let foreign_named_instance = core.context.recv_limiter("instance", true).unwrap(); + assert!(Arc::ptr_eq(&foreign_a, &foreign_a_again)); + assert!(!Arc::ptr_eq(&foreign_a, &foreign_b)); + assert!(!Arc::ptr_eq(&instance_a, &foreign_a)); + assert!(!Arc::ptr_eq(&instance_a, &foreign_named_instance)); + + core.clear_resources().await; + assert!(core.context.recv_limiter("portable-net", false).is_none()); + assert!(core.context.recv_limiter("foreign-a", true).is_none()); + } + + #[tokio::test] + async fn portable_peer_manager_rejects_invalid_identity_and_prefixes() { + let mut digest_only = portable_runtime_config("portable-net"); + digest_only.network_identity.network_secret = None; + digest_only.network_identity.network_secret_digest = Some([1; 32]); + assert!(build_portable_for_test(digest_only).is_err()); + + let mut wrong_family = portable_runtime_config("portable-net"); + wrong_family.core.routes.ipv4 = Some(IpPrefix { + address: "2001:db8::1".parse().unwrap(), + prefix_len: 64, + }); + assert!(build_portable_for_test(wrong_family).is_err()); + + let mut proxy_host_bits = portable_runtime_config("portable-net"); + proxy_host_bits.core.routes.proxy_networks = vec![crate::config::ProxyNetworkConfig { + real: IpPrefix::new("10.50.0.7".parse().unwrap(), 16).unwrap(), + mapped: None, + }]; + assert!(build_portable_for_test(proxy_host_bits).is_err()); + + let mut wrong_proxy_family = portable_runtime_config("portable-net"); + wrong_proxy_family.core.routes.proxy_networks = vec![crate::config::ProxyNetworkConfig { + real: IpPrefix::new("10.50.0.0".parse().unwrap(), 16).unwrap(), + mapped: Some(IpPrefix::new("2001:db8::".parse().unwrap(), 64).unwrap()), + }]; + assert!(build_portable_for_test(wrong_proxy_family).is_err()); + + let mut advertised = portable_runtime_config("portable-net"); + advertised + .core + .routes + .advertised_routes + .push(IpPrefix::new("10.60.0.0".parse().unwrap(), 16).unwrap()); + assert!(build_portable_for_test(advertised).is_err()); + + let mut foreign = portable_runtime_config("portable-net"); + foreign + .core + .routes + .foreign_networks + .push(crate::config::ForeignNetworkConfig { + name: "other-net".to_owned(), + cidrs: Vec::new(), + }); + assert!(build_portable_for_test(foreign).is_err()); + } + + #[test] + fn portable_peer_manager_reports_missing_tokio_runtime() { + let result = build_portable_for_test(portable_runtime_config("portable-net")); + + let Err(error) = result else { + panic!("construction outside Tokio must fail"); + }; + assert!(error.to_string().contains("entered Tokio runtime")); + } + + #[test] + fn recent_traffic_fanout_policy_only_marks_single_peer() { + assert!(should_mark_recent_traffic_for_fanout(0)); + assert!(should_mark_recent_traffic_for_fanout(1)); + assert!(!should_mark_recent_traffic_for_fanout(2)); + } + + fn resolved_remote_addr_from_url(addr: Option<&str>) -> Option { + addr.map(|addr| Url::parse(addr).unwrap().into()) + } + + #[test] + fn resolved_remote_addr_check_rejects_virtual_network_ip() { + let context: ArcPeerContext = Arc::new(SameNetworkContext { + contains_every_address: false, + }); + let resolved_remote_addr = resolved_remote_addr_from_url(Some("tcp://10.144.0.2:1234")); + + let err = + check_resolved_remote_addr_not_from_virtual_network(&context, resolved_remote_addr); + + assert!(matches!(err, Err(Error::Other(_)))); + } + + #[test] + fn resolved_remote_addr_check_allows_external_or_non_ip_sources() { + let context: ArcPeerContext = Arc::new(SameNetworkContext { + contains_every_address: false, + }); + for resolved_remote_addr_url in [ + Some("tcp://192.0.2.10:1234"), + Some("tcp://example.test:1234"), + Some("ring://peer"), + Some("unix:///tmp/easytier.sock"), + None, + ] { + assert!( + check_resolved_remote_addr_not_from_virtual_network( + &context, + resolved_remote_addr_from_url(resolved_remote_addr_url), + ) + .is_ok() + ); + } + } + + #[test] + fn resolved_remote_addr_check_allows_loopback_inside_virtual_network() { + let context: ArcPeerContext = Arc::new(SameNetworkContext { + contains_every_address: true, + }); + let resolved_remote_addr = resolved_remote_addr_from_url(Some("tcp://127.0.0.1:1234")); + + let ret = + check_resolved_remote_addr_not_from_virtual_network(&context, resolved_remote_addr); + + assert!(ret.is_ok()); + } + + #[test] + fn disable_relay_data_classifies_data_plane_packets_only() { + for packet_type in [ + PacketType::Data, + PacketType::KcpSrc, + PacketType::KcpDst, + PacketType::QuicSrc, + PacketType::QuicDst, + PacketType::DataWithKcpSrcModified, + PacketType::DataWithQuicSrcModified, + PacketType::ForeignNetworkPacket, + ] { + assert!(is_relay_data_packet(packet_type as u8)); + } + + for packet_type in [ + PacketType::RpcReq, + PacketType::RpcResp, + PacketType::Ping, + PacketType::Pong, + PacketType::HandShake, + PacketType::NoiseHandshakeMsg1, + PacketType::NoiseHandshakeMsg2, + PacketType::NoiseHandshakeMsg3, + PacketType::RelayHandshake, + PacketType::RelayHandshakeAck, + ] { + assert!(!is_relay_data_packet(packet_type as u8)); + } + } + + #[test] + fn disable_relay_data_inspects_foreign_network_inner_packet_type() { + let network_name = "net1".to_string(); + + let mut rpc_packet = ZCPacket::new_with_payload(b"rpc"); + rpc_packet.fill_peer_manager_hdr(1, 2, PacketType::RpcReq as u8); + let mut foreign_rpc_packet = + ZCPacket::new_for_foreign_network(&network_name, 2, &rpc_packet); + foreign_rpc_packet.fill_peer_manager_hdr(10, 20, PacketType::ForeignNetworkPacket as u8); + + assert_eq!( + foreign_rpc_packet.foreign_network_inner_packet_type(), + Some(PacketType::RpcReq as u8) + ); + assert!(!is_relay_data_zc_packet(&foreign_rpc_packet)); + + let mut data_packet = ZCPacket::new_with_payload(b"data"); + data_packet.fill_peer_manager_hdr(1, 2, PacketType::Data as u8); + let mut foreign_data_packet = + ZCPacket::new_for_foreign_network(&network_name, 2, &data_packet); + foreign_data_packet.fill_peer_manager_hdr(10, 20, PacketType::ForeignNetworkPacket as u8); + + assert_eq!( + foreign_data_packet.foreign_network_inner_packet_type(), + Some(PacketType::Data as u8) + ); + assert!(is_relay_data_zc_packet(&foreign_data_packet)); + } + + fn data_packet(from_peer_id: PeerId, to_peer_id: PeerId) -> ZCPacket { + let mut packet = ZCPacket::new_with_payload(b"data"); + packet.fill_peer_manager_hdr(from_peer_id, to_peer_id, PacketType::Data as u8); + packet + } + + #[test] + fn forged_attached_source_header_does_not_bypass_relay_disable() { + let packet = data_packet(77, 3); + for origin in [ + PeerConnectionOrigin::Manual, + PeerConnectionOrigin::Direct, + PeerConnectionOrigin::Listener, + PeerConnectionOrigin::TcpHolePunch, + PeerConnectionOrigin::UdpHolePunch, + ] { + let network_ingress = PeerPacketIngress::Peer { + peer_id: 2, + conn_id: PeerConnId::new_v4(), + origin, + }; + + assert!(should_drop_relay_data( + true, + &packet, + 1, + network_ingress, + false, + )); + } + } + + #[test] + fn attached_ingress_and_destination_bypass_relay_disable() { + let packet = data_packet(2, 3); + let attached_ingress = PeerPacketIngress::Peer { + peer_id: 2, + conn_id: PeerConnId::new_v4(), + origin: PeerConnectionOrigin::Attached, + }; + let network_ingress = PeerPacketIngress::Peer { + peer_id: 2, + conn_id: PeerConnId::new_v4(), + origin: PeerConnectionOrigin::Listener, + }; + + assert!(!should_drop_relay_data( + true, + &packet, + 1, + attached_ingress, + false, + )); + assert!(!should_drop_relay_data( + true, + &packet, + 1, + network_ingress, + true, + )); + } + + fn route_with_ipv4( + peer_id: u32, + ipv4_addr: Option, + ) -> crate::proto::core_peer::peer::Route { + crate::proto::core_peer::peer::Route { + peer_id, + ipv4_addr: ipv4_addr.map(|addr| cidr::Ipv4Inet::new(addr, 24).unwrap().into()), + ..Default::default() + } + } + + #[test] + fn ipv4_broadcast_peer_selection_skips_peers_without_ipv4() { + let routes = vec![ + route_with_ipv4(1, Some(std::net::Ipv4Addr::new(10, 126, 126, 1))), + route_with_ipv4(2, None), + route_with_ipv4(3, Some(std::net::Ipv4Addr::new(10, 126, 126, 3))), + route_with_ipv4(4, None), + ]; + + assert_eq!( + PeerOutboundPacketRouter::select_ipv4_broadcast_peers(&routes, 3), + vec![1] + ); + } + + #[test] + fn gc_recent_traffic_removes_expired_and_connected_entries() { + let stale_peer = 1; + let direct_peer = 2; + let active_peer = 3; + let recent_have_traffic = DashMap::new(); + + recent_have_traffic.insert( + stale_peer, + Instant::now() - RECENT_HAVE_TRAFFIC_TTL - Duration::from_millis(1), + ); + recent_have_traffic.insert(direct_peer, Instant::now()); + recent_have_traffic.insert(active_peer, Instant::now()); + + let future_peer = 4; + recent_have_traffic.insert(future_peer, Instant::now() + Duration::from_secs(1)); + + gc_recent_traffic_entries(&recent_have_traffic, Instant::now(), |peer_id| { + peer_id == direct_peer + }); + + assert!(!recent_have_traffic.contains_key(&stale_peer)); + assert!(!recent_have_traffic.contains_key(&direct_peer)); + assert!(recent_have_traffic.contains_key(&active_peer)); + assert!(recent_have_traffic.contains_key(&future_peer)); + } + + #[test] + fn recent_traffic_notifies_only_when_demand_becomes_active() { + let tracker = RecentTrafficTracker::new(1); + let peer_id = 2; + let signal = tracker.p2p_demand_notify(); + + let initial_version = signal.version(); + tracker.mark(peer_id, false, true, |_| false); + assert_eq!(signal.version(), initial_version + 1); + + let first_seen = *tracker.recent_have_traffic.get(&peer_id).unwrap(); + std::thread::sleep(Duration::from_millis(5)); + tracker.mark(peer_id, false, true, |_| false); + assert_eq!( + signal.version(), + initial_version + 1, + "fresh demand should not wake all p2p workers again" + ); + let refreshed_seen = *tracker.recent_have_traffic.get(&peer_id).unwrap(); + assert!(refreshed_seen > first_seen); + + if let Some(mut last_seen) = tracker.recent_have_traffic.get_mut(&peer_id) { + *last_seen = Instant::now() - RECENT_HAVE_TRAFFIC_TTL - Duration::from_millis(1); + } + tracker.mark(peer_id, false, true, |_| false); + assert_eq!(signal.version(), initial_version + 2); + } + + #[test] + fn recent_traffic_tolerates_future_timestamps() { + let tracker = RecentTrafficTracker::new(1); + let peer_id = 2; + tracker + .recent_have_traffic + .insert(peer_id, Instant::now() + Duration::from_secs(1)); + + assert!(tracker.has(peer_id, Instant::now(), |_| false)); + tracker.mark(peer_id, false, true, |_| false); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/peer_rpc.rs b/vendor/easytier/easytier-core/src/peers/peer_rpc.rs new file mode 100644 index 0000000..274857f --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/peer_rpc.rs @@ -0,0 +1,113 @@ +use std::sync::{Arc, Mutex}; + +use futures::{SinkExt as _, StreamExt}; +use tokio::task::JoinSet; + +use crate::{ + config::PeerId, + foundation::stats::{ArcRpcMetrics, RpcMetricsProvider}, + packet::ZCPacket, + rpc::{self, bidirect::BidirectRpcManager}, +}; + +#[async_trait::async_trait] +#[auto_impl::auto_impl(Arc)] +pub trait PeerRpcManagerTransport: Send + Sync + 'static { + fn my_peer_id(&self) -> PeerId; + async fn send(&self, msg: ZCPacket, dst_peer_id: PeerId) -> anyhow::Result<()>; + async fn recv(&self) -> anyhow::Result; +} + +pub struct PeerRpcManager { + tspt: Arc>, + bidirect_rpc: BidirectRpcManager, + tasks: Mutex>, +} + +impl std::fmt::Debug for PeerRpcManager { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PeerRpcManager") + .field("node_id", &self.tspt.my_peer_id()) + .finish() + } +} + +impl PeerRpcManager { + pub fn new(tspt: impl PeerRpcManagerTransport) -> Self { + Self { + tspt: Arc::new(Box::new(tspt)), + bidirect_rpc: BidirectRpcManager::new(), + tasks: Mutex::new(JoinSet::new()), + } + } + + pub fn new_with_stats_manager(tspt: impl PeerRpcManagerTransport, stats_manager: T) -> Self + where + T: Clone + RpcMetricsProvider, + { + Self { + tspt: Arc::new(Box::new(tspt)), + bidirect_rpc: BidirectRpcManager::new_with_stats_manager(stats_manager), + tasks: Mutex::new(JoinSet::new()), + } + } + + pub fn new_with_metrics(tspt: impl PeerRpcManagerTransport, metrics: ArcRpcMetrics) -> Self { + Self { + tspt: Arc::new(Box::new(tspt)), + bidirect_rpc: BidirectRpcManager::new_with_metrics(metrics), + tasks: Mutex::new(JoinSet::new()), + } + } + + pub fn run(&self) { + let ret = self.bidirect_rpc.run_and_create_tunnel(); + let (mut rx, mut tx) = ret.split(); + let tspt = self.tspt.clone(); + self.tasks.lock().unwrap().spawn(async move { + while let Some(Ok(packet)) = rx.next().await { + let dst_peer_id = packet.peer_manager_header().unwrap().to_peer_id.into(); + if let Err(e) = tspt.send(packet, dst_peer_id).await { + tracing::error!("send to rpc tspt error: {:?}", e); + } + } + }); + + let tspt = self.tspt.clone(); + self.tasks.lock().unwrap().spawn(async move { + while let Ok(packet) = tspt.recv().await { + if let Err(e) = tx.send(packet).await { + tracing::error!("send to rpc tspt error: {:?}", e); + } + } + }); + } + + pub async fn stop(&self) { + self.bidirect_rpc.stop().await; + let mut tasks = { + let mut task_slot = self.tasks.lock().unwrap(); + std::mem::replace(&mut *task_slot, JoinSet::new()) + }; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + } + + pub fn rpc_client(&self) -> &rpc::client::Client { + self.bidirect_rpc.rpc_client() + } + + pub fn rpc_server(&self) -> &rpc::server::Server { + self.bidirect_rpc.rpc_server() + } + + pub fn my_peer_id(&self) -> PeerId { + self.tspt.my_peer_id() + } +} + +impl Drop for PeerRpcManager { + fn drop(&mut self) { + tracing::debug!("PeerRpcManager drop, my_peer_id: {:?}", self.my_peer_id()); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/public_ipv6/mod.rs b/vendor/easytier/easytier-core/src/peers/public_ipv6/mod.rs new file mode 100644 index 0000000..7e9883f --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/public_ipv6/mod.rs @@ -0,0 +1,738 @@ +pub mod provider; +pub(crate) mod service; + +pub(crate) use service::PublicIpv6Service; + +use std::{collections::HashSet, net::Ipv6Addr, sync::Arc}; + +use cidr::{Ipv6Cidr, Ipv6Inet}; + +use crate::{ + config::PeerId, + config::peers::PublicIpv6ProviderConfig, + config::runtime::CoreRuntimeConfigStore, + events::{CoreEvent, CoreEventSink}, + peers::context::PeerPublicIpv6State, +}; + +impl PublicIpv6ProviderConfig { + pub fn validate(self) -> Result<(), PublicIpv6ProviderConfigError> { + if !self.provider_enabled { + return Ok(()); + } + if !self.provider_supported { + return Err(PublicIpv6ProviderConfigError::UnsupportedProvider); + } + if let Some(prefix) = self.configured_prefix + && !is_global_routable_public_ipv6_prefix(prefix) + { + return Err(PublicIpv6ProviderConfigError::InvalidPrefix(prefix)); + } + Ok(()) + } +} + +#[derive(Debug, thiserror::Error, PartialEq, Eq)] +pub enum PublicIpv6ProviderConfigError { + #[error( + "the provider feature requires Linux; run without --ipv6-public-addr-provider on this node, or move the provider role to a Linux node. client mode (--ipv6-public-addr-auto) works on all platforms" + )] + UnsupportedProvider, + #[error( + "the prefix {0} is not a valid global unicast IPv6 prefix; it must be a routable address range, not a private, link-local, or multicast address" + )] + InvalidPrefix(Ipv6Cidr), +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) enum PublicIpv6ProviderResolution { + Disabled, + Pending(String), + Active(Ipv6Cidr), +} + +pub(crate) fn resolve_public_ipv6_provider( + config: PublicIpv6ProviderConfig, + detected_prefix: Result, String>, +) -> PublicIpv6ProviderResolution { + if !config.provider_enabled { + return PublicIpv6ProviderResolution::Disabled; + } + if !config.provider_supported { + return PublicIpv6ProviderResolution::Pending( + PublicIpv6ProviderConfigError::UnsupportedProvider.to_string(), + ); + } + + if let Some(prefix) = config.configured_prefix { + return if is_global_routable_public_ipv6_prefix(prefix) { + PublicIpv6ProviderResolution::Active(prefix) + } else { + PublicIpv6ProviderResolution::Pending(format!( + "the configured prefix {prefix} is not a valid global unicast IPv6 prefix" + )) + }; + } + + match detected_prefix { + Ok(Some(prefix)) if is_global_routable_public_ipv6_prefix(prefix) => { + PublicIpv6ProviderResolution::Active(prefix) + } + Ok(Some(prefix)) => PublicIpv6ProviderResolution::Pending(format!( + "the detected prefix {prefix} is not a valid global unicast IPv6 prefix" + )), + Ok(None) => PublicIpv6ProviderResolution::Pending( + "no public IPv6 prefix found on this system; set --ipv6-public-addr-prefix manually, or check that your ISP has delegated an IPv6 prefix and a default-from route exists in the kernel routing table".to_owned(), + ), + Err(error) => PublicIpv6ProviderResolution::Pending(error), + } +} + +pub fn is_global_routable_public_ipv6_prefix(prefix: Ipv6Cidr) -> bool { + let addr = prefix.first_address(); + !addr.is_loopback() + && !addr.is_multicast() + && !addr.is_unicast_link_local() + && !addr.is_unique_local() + && !addr.is_unspecified() +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) struct PublicIpv6PeerRouteInfo { + pub peer_id: PeerId, + pub inst_id: Option, + pub is_provider: bool, + pub prefix: Option, + pub lease: Option, + pub reachable: bool, +} + +pub(crate) trait PublicIpv6RouteControl: Send + Sync { + fn my_peer_id(&self) -> PeerId; + fn peer_route_snapshot(&self) -> Vec; + fn publish_self_public_ipv6_lease(&self, lease: Option) -> bool; +} + +pub(crate) trait PublicIpv6SyncTrigger: Send + Sync { + fn sync_now(&self, reason: &str); +} + +#[async_trait::async_trait] +pub trait PublicIpv6Host: Send + Sync { + async fn collect_reserved_public_ipv6_addrs(&self, prefix: Ipv6Cidr) -> HashSet; +} + +#[async_trait::async_trait] +impl PublicIpv6Host for () { + async fn collect_reserved_public_ipv6_addrs(&self, _prefix: Ipv6Cidr) -> HashSet { + HashSet::new() + } +} + +#[async_trait::async_trait] +#[auto_impl::auto_impl(Arc)] +pub(crate) trait PublicIpv6Runtime: Send + Sync { + fn ipv6_public_addr_auto(&self) -> bool; + fn ipv6_public_addr_provider(&self) -> bool; + fn instance_id(&self) -> uuid::Uuid; + fn network_name(&self) -> String; + async fn collect_reserved_public_ipv6_addrs(&self, prefix: Ipv6Cidr) -> HashSet; + fn public_ipv6_lease_changed(&self, old: Option, new: Option); + fn public_ipv6_routes_changed(&self, added: Vec, removed: Vec); +} + +pub struct CorePublicIpv6Runtime { + config: CoreRuntimeConfigStore, + host: Arc, + events: Arc, + provider_prefix: std::sync::Mutex>, + lease: std::sync::Mutex>, +} + +impl CorePublicIpv6Runtime { + pub fn new( + config: CoreRuntimeConfigStore, + host: Arc, + events: Arc, + ) -> Arc { + Arc::new(Self { + config, + host, + events, + provider_prefix: std::sync::Mutex::new(None), + lease: std::sync::Mutex::new(None), + }) + } + + pub fn set_provider_prefix(&self, prefix: Option) -> bool { + let mut current = self.provider_prefix.lock().unwrap(); + if *current == prefix { + return false; + } + *current = prefix; + true + } +} + +impl PeerPublicIpv6State for CorePublicIpv6Runtime { + fn public_ipv6_lease_contains(&self, ip: &Ipv6Addr) -> bool { + self.lease + .lock() + .unwrap() + .is_some_and(|lease| lease.address() == *ip) + } + + fn public_ipv6_provider_enabled(&self) -> bool { + self.provider_prefix.lock().unwrap().is_some() + } + + fn advertised_ipv6_public_addr_prefix(&self) -> Option { + *self.provider_prefix.lock().unwrap() + } +} + +#[async_trait::async_trait] +impl PublicIpv6Runtime for CorePublicIpv6Runtime { + fn ipv6_public_addr_auto(&self) -> bool { + self.config.snapshot().services.public_ipv6_auto + } + + fn ipv6_public_addr_provider(&self) -> bool { + self.config + .snapshot() + .services + .public_ipv6_provider + .provider_enabled + } + + fn instance_id(&self) -> uuid::Uuid { + self.config + .snapshot() + .peer + .runtime + .core + .node + .instance_id + .map(uuid::Uuid::from_bytes) + .expect("core peer identity must be finalized before public IPv6 starts") + } + + fn network_name(&self) -> String { + self.config + .snapshot() + .peer + .runtime + .network_identity + .network_name + .clone() + } + + async fn collect_reserved_public_ipv6_addrs(&self, prefix: Ipv6Cidr) -> HashSet { + self.host.collect_reserved_public_ipv6_addrs(prefix).await + } + + fn public_ipv6_lease_changed(&self, old: Option, new: Option) { + *self.lease.lock().unwrap() = new; + self.events + .emit(CoreEvent::PublicIpv6LeaseChanged { old, new }); + } + + fn public_ipv6_routes_changed(&self, added: Vec, removed: Vec) { + self.events + .emit(CoreEvent::PublicIpv6RoutesChanged { added, removed }); + } +} + +pub(super) struct DisabledPublicIpv6Runtime { + instance_id: uuid::Uuid, + network_name: String, +} + +impl DisabledPublicIpv6Runtime { + pub(super) fn new(instance_id: uuid::Uuid, network_name: String) -> Self { + Self { + instance_id, + network_name, + } + } +} + +#[async_trait::async_trait] +impl PublicIpv6Runtime for DisabledPublicIpv6Runtime { + fn ipv6_public_addr_auto(&self) -> bool { + false + } + + fn ipv6_public_addr_provider(&self) -> bool { + false + } + + fn instance_id(&self) -> uuid::Uuid { + self.instance_id + } + + fn network_name(&self) -> String { + self.network_name.clone() + } + + async fn collect_reserved_public_ipv6_addrs(&self, _prefix: Ipv6Cidr) -> HashSet { + HashSet::new() + } + + fn public_ipv6_lease_changed(&self, _old: Option, _new: Option) {} + + fn public_ipv6_routes_changed(&self, _added: Vec, _removed: Vec) {} +} + +#[cfg(test)] +mod tests { + use std::net::Ipv6Addr; + use std::{ + collections::{HashMap, HashSet}, + sync::{Arc, Mutex}, + }; + + use cidr::{Ipv6Cidr, Ipv6Inet}; + + use crate::{ + config::PeerId, + config::runtime::{CoreRuntimeConfig, CoreRuntimeConfigStore}, + events::{CoreEvent, CoreEventSink}, + peers::{context::PeerPublicIpv6State, peer_rpc::PeerRpcManager}, + }; + + use super::{ + CorePublicIpv6Runtime, PublicIpv6Host, PublicIpv6PeerRouteInfo, PublicIpv6ProviderConfig, + PublicIpv6ProviderConfigError, PublicIpv6ProviderResolution, PublicIpv6RouteControl, + PublicIpv6Runtime, PublicIpv6Service, PublicIpv6SyncTrigger, resolve_public_ipv6_provider, + service::allocate_public_ipv6_leases, + }; + + struct TestRouteControl { + my_peer_id: PeerId, + peers: Mutex>, + } + + impl PublicIpv6RouteControl for TestRouteControl { + fn my_peer_id(&self) -> PeerId { + self.my_peer_id + } + + fn peer_route_snapshot(&self) -> Vec { + self.peers.lock().unwrap().clone() + } + + fn publish_self_public_ipv6_lease(&self, _lease: Option) -> bool { + false + } + } + + struct TestSyncTrigger; + + impl PublicIpv6SyncTrigger for TestSyncTrigger { + fn sync_now(&self, _reason: &str) {} + } + + struct TestRuntime { + auto: bool, + provider: bool, + inst_id: uuid::Uuid, + network_name: String, + reserved: Mutex>, + lease: Mutex>, + } + + impl TestRuntime { + fn new(auto: bool) -> Self { + Self { + auto, + provider: false, + inst_id: uuid::Uuid::from_u128(1), + network_name: "default".to_string(), + reserved: Mutex::new(HashSet::new()), + lease: Mutex::new(None), + } + } + } + + #[async_trait::async_trait] + impl PublicIpv6Runtime for TestRuntime { + fn ipv6_public_addr_auto(&self) -> bool { + self.auto + } + + fn ipv6_public_addr_provider(&self) -> bool { + self.provider + } + + fn instance_id(&self) -> uuid::Uuid { + self.inst_id + } + + fn network_name(&self) -> String { + self.network_name.clone() + } + + async fn collect_reserved_public_ipv6_addrs(&self, prefix: Ipv6Cidr) -> HashSet { + self.reserved + .lock() + .unwrap() + .iter() + .copied() + .filter(|addr| prefix.contains(addr)) + .collect() + } + + fn public_ipv6_lease_changed(&self, _old: Option, new: Option) { + *self.lease.lock().unwrap() = new; + } + + fn public_ipv6_routes_changed(&self, _added: Vec, _removed: Vec) {} + } + + #[derive(Default)] + struct RecordingPublicIpv6Host { + reserved: Mutex>, + } + + #[derive(Default)] + struct RecordingPublicIpv6Events { + leases: Mutex, Option)>>, + route_deltas: Mutex, Vec)>>, + } + + #[async_trait::async_trait] + impl PublicIpv6Host for RecordingPublicIpv6Host { + async fn collect_reserved_public_ipv6_addrs(&self, prefix: Ipv6Cidr) -> HashSet { + self.reserved + .lock() + .unwrap() + .iter() + .copied() + .filter(|addr| prefix.contains(addr)) + .collect() + } + } + + impl CoreEventSink for RecordingPublicIpv6Events { + fn emit(&self, event: CoreEvent) { + match event { + CoreEvent::PublicIpv6LeaseChanged { old, new } => { + self.leases.lock().unwrap().push((old, new)); + } + CoreEvent::PublicIpv6RoutesChanged { added, removed } => { + self.route_deltas.lock().unwrap().push((added, removed)); + } + _ => {} + } + } + } + + #[tokio::test] + async fn core_runtime_owns_public_ipv6_state_and_projects_only_host_effects() { + let instance_id = uuid::Uuid::from_u128(42); + let mut peer = crate::config::peers::PeerRuntimeSnapshot::default(); + peer.runtime.core.node.instance_id = Some(*instance_id.as_bytes()); + peer.runtime.network_identity.network_name = "owned-by-core".to_owned(); + let config = CoreRuntimeConfigStore::new( + CoreRuntimeConfig { + public_ipv6_auto: true, + public_ipv6_provider: PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: None, + provider_supported: true, + }, + ..Default::default() + }, + Arc::new(peer), + ); + let host = Arc::new(RecordingPublicIpv6Host::default()); + let events = Arc::new(RecordingPublicIpv6Events::default()); + let reserved = "2001:db8::10".parse().unwrap(); + host.reserved.lock().unwrap().insert(reserved); + let runtime = CorePublicIpv6Runtime::new(config.clone(), host.clone(), events.clone()); + let prefix = "2001:db8::/64".parse().unwrap(); + let lease = "2001:db8::20/64".parse().unwrap(); + let route = "2001:db8::30/128".parse().unwrap(); + + assert!(runtime.ipv6_public_addr_auto()); + assert!(runtime.ipv6_public_addr_provider()); + assert_eq!(runtime.instance_id(), instance_id); + assert_eq!(runtime.network_name(), "owned-by-core"); + assert_eq!( + runtime.collect_reserved_public_ipv6_addrs(prefix).await, + HashSet::from([reserved]) + ); + assert!(runtime.set_provider_prefix(Some(prefix))); + assert!(!runtime.set_provider_prefix(Some(prefix))); + assert_eq!(runtime.advertised_ipv6_public_addr_prefix(), Some(prefix)); + + runtime.public_ipv6_lease_changed(None, Some(lease)); + assert!(runtime.public_ipv6_lease_contains(&lease.address())); + runtime.public_ipv6_routes_changed(vec![route], Vec::new()); + assert_eq!( + events.leases.lock().unwrap().as_slice(), + &[(None, Some(lease))] + ); + assert_eq!( + events.route_deltas.lock().unwrap().as_slice(), + &[(vec![route], Vec::new())] + ); + + config.update_services(|services| { + services.public_ipv6_auto = false; + services.public_ipv6_provider.provider_enabled = false; + }); + assert!(!runtime.ipv6_public_addr_auto()); + assert!(!runtime.ipv6_public_addr_provider()); + } + + #[test] + fn public_ipv6_lease_allocator_keeps_stable_addresses() { + let prefix = "2001:db8::/124".parse::().unwrap(); + let first = uuid::Uuid::from_u128(1); + let second = uuid::Uuid::from_u128(2); + + let leases = + allocate_public_ipv6_leases(prefix, &[first, second], &HashSet::new(), &HashMap::new()); + assert_eq!(leases.len(), 2); + assert_ne!(leases[0].addr, leases[1].addr); + + let initial_map = HashMap::from([(first, leases[0].addr)]); + let next = allocate_public_ipv6_leases(prefix, &[first], &HashSet::new(), &initial_map); + assert_eq!(next.len(), 1); + assert_eq!(next[0].addr, leases[0].addr); + assert!(next[0].reused); + } + + #[test] + fn public_ipv6_provider_prefers_smallest_instance_id() { + let info_a = PublicIpv6PeerRouteInfo { + peer_id: 2, + inst_id: Some(uuid::Uuid::from_u128(2)), + is_provider: true, + prefix: Some("2001:db8:1::/120".parse().unwrap()), + lease: None, + reachable: true, + }; + let info_b = PublicIpv6PeerRouteInfo { + peer_id: 1, + inst_id: Some(uuid::Uuid::from_u128(1)), + is_provider: true, + prefix: Some("2001:db8:2::/120".parse().unwrap()), + lease: None, + reachable: true, + }; + + let selected = + PublicIpv6Service::selected_provider_from_snapshot(&[info_a, info_b]).unwrap(); + assert_eq!(selected.peer_id, 1); + } + + #[test] + fn public_ipv6_provider_prefers_reachable_provider() { + let unreachable_lower_id = PublicIpv6PeerRouteInfo { + peer_id: 1, + inst_id: Some(uuid::Uuid::from_u128(1)), + is_provider: true, + prefix: Some("2001:db8:1::/120".parse().unwrap()), + lease: None, + reachable: false, + }; + let reachable_higher_id = PublicIpv6PeerRouteInfo { + peer_id: 2, + inst_id: Some(uuid::Uuid::from_u128(2)), + is_provider: true, + prefix: Some("2001:db8:2::/120".parse().unwrap()), + lease: None, + reachable: true, + }; + + let selected = PublicIpv6Service::selected_provider_from_snapshot(&[ + unreachable_lower_id, + reachable_higher_id, + ]) + .unwrap(); + assert_eq!(selected.peer_id, 2); + } + + #[test] + fn public_ipv6_lease_allocator_stops_when_only_network_offset_is_left() { + let prefix = "2001:db8::/126".parse::().unwrap(); + let network = prefix.first_address(); + let reserved = HashSet::from([ + Ipv6Addr::from(u128::from(network) + 1), + Ipv6Addr::from(u128::from(network) + 2), + Ipv6Addr::from(u128::from(network) + 3), + ]); + + let leases = allocate_public_ipv6_leases( + prefix, + &[uuid::Uuid::from_u128(42)], + &reserved, + &HashMap::new(), + ); + + assert!(leases.is_empty()); + } + + #[tokio::test] + async fn reconcile_runtime_clears_public_ipv6_lease_when_auto_is_disabled() { + let stale_addr = "2001:db8::123/64".parse().unwrap(); + let runtime = Arc::new(TestRuntime::new(false)); + *runtime.lease.lock().unwrap() = Some(stale_addr); + + let service = Arc::new(PublicIpv6Service::new( + runtime.clone(), + std::sync::Weak::::new(), + Arc::new(TestRouteControl { + my_peer_id: 1, + peers: Mutex::new(Vec::new()), + }), + Arc::new(TestSyncTrigger), + )); + *service.my_addr_cache.lock().unwrap() = Some(stale_addr); + + service.reconcile_runtime_from_snapshot(&[]); + + assert_eq!(*service.my_addr_cache.lock().unwrap(), None); + assert_eq!(*runtime.lease.lock().unwrap(), None); + } + + #[tokio::test] + async fn reconcile_runtime_updates_public_lease_when_auto_enabled() { + let public_addr = "2001:db8::123/64".parse().unwrap(); + let runtime = Arc::new(TestRuntime::new(true)); + + let service = Arc::new(PublicIpv6Service::new( + runtime.clone(), + std::sync::Weak::::new(), + Arc::new(TestRouteControl { + my_peer_id: 1, + peers: Mutex::new(vec![PublicIpv6PeerRouteInfo { + peer_id: 1, + inst_id: Some(uuid::Uuid::from_u128(1)), + is_provider: false, + prefix: None, + lease: Some(public_addr), + reachable: true, + }]), + }), + Arc::new(TestSyncTrigger), + )); + + service.reconcile_runtime(); + + assert_eq!(*runtime.lease.lock().unwrap(), Some(public_addr)); + } + + #[test] + fn provider_config_uses_explicit_host_capability() { + let unsupported = PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: None, + provider_supported: false, + }; + assert_eq!( + unsupported.validate(), + Err(PublicIpv6ProviderConfigError::UnsupportedProvider) + ); + + let disabled = PublicIpv6ProviderConfig { + provider_enabled: false, + ..unsupported + }; + assert!(disabled.validate().is_ok()); + assert!(!disabled.should_run_reconcile()); + } + + #[test] + fn provider_config_rejects_non_global_prefixes() { + for prefix in ["::1/128", "fe80::/64", "fd00::/48", "ff00::/8", "::/0"] { + let config = PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: Some(prefix.parse().unwrap()), + provider_supported: true, + }; + assert!(matches!( + config.validate(), + Err(PublicIpv6ProviderConfigError::InvalidPrefix(_)) + )); + } + } + + #[test] + fn provider_config_accepts_global_prefix() { + let config = PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: Some("2001:db8::/48".parse().unwrap()), + provider_supported: true, + }; + assert!(config.validate().is_ok()); + assert!(config.should_run_reconcile()); + } + + #[test] + fn provider_resolution_prefers_configured_prefix_without_detection() { + let prefix = "2001:db8::/48".parse().unwrap(); + let config = PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: Some(prefix), + provider_supported: true, + }; + assert_eq!( + resolve_public_ipv6_provider(config, Err("detection must be ignored".to_owned())), + PublicIpv6ProviderResolution::Active(prefix) + ); + } + + #[test] + fn provider_resolution_normalizes_auto_detection_results() { + let config = PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: None, + provider_supported: true, + }; + let prefix = "2001:db8:1::/56".parse().unwrap(); + assert_eq!( + resolve_public_ipv6_provider(config, Ok(Some(prefix))), + PublicIpv6ProviderResolution::Active(prefix) + ); + assert!(matches!( + resolve_public_ipv6_provider(config, Ok(None)), + PublicIpv6ProviderResolution::Pending(message) + if message.contains("ipv6-public-addr-prefix") + )); + assert_eq!( + resolve_public_ipv6_provider(config, Err("host detection failed".to_owned())), + PublicIpv6ProviderResolution::Pending("host detection failed".to_owned()) + ); + } + + #[test] + fn provider_resolution_rejects_invalid_configured_and_detected_prefixes() { + let configured = PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: Some("fd00::/48".parse().unwrap()), + provider_supported: true, + }; + assert!(matches!( + resolve_public_ipv6_provider(configured, Ok(None)), + PublicIpv6ProviderResolution::Pending(message) + if message.contains("configured prefix") + )); + + let detected = PublicIpv6ProviderConfig { + configured_prefix: None, + ..configured + }; + assert!(matches!( + resolve_public_ipv6_provider( + detected, + Ok(Some("fe80::/64".parse().unwrap())) + ), + PublicIpv6ProviderResolution::Pending(message) + if message.contains("detected prefix") + )); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/public_ipv6/provider.rs b/vendor/easytier/easytier-core/src/peers/public_ipv6/provider.rs new file mode 100644 index 0000000..8277bb1 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/public_ipv6/provider.rs @@ -0,0 +1,601 @@ +use std::{ + sync::{ + Arc, Weak, + atomic::{AtomicBool, Ordering}, + }, + time::Duration, +}; + +use async_trait::async_trait; +use cidr::Ipv6Cidr; +use tokio::sync::Mutex; +use tokio_util::sync::CancellationToken; + +use crate::{ + config::peers::PublicIpv6ProviderConfig, + config::runtime::CoreRuntimeConfigStore, + peers::public_ipv6::{ + CorePublicIpv6Runtime, PublicIpv6ProviderResolution, resolve_public_ipv6_provider, + }, +}; + +const DEFAULT_RECONCILE_INTERVAL: Duration = Duration::from_secs(5); +const MAX_CONFIG_RETRIES: usize = 3; + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct PublicIpv6NdpTarget { + pub wan_interface: String, +} + +#[derive(Debug, Clone, Default, PartialEq, Eq)] +pub struct PublicIpv6PlatformObservation { + pub detected_prefix: Option, + pub ndp_target: Option, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct PublicIpv6NdpDesired { + pub prefix: Ipv6Cidr, + pub target: PublicIpv6NdpTarget, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +enum PublicIpv6ProviderState { + Disabled, + Pending(String), + Active { + prefix: Ipv6Cidr, + ndp_target: Option, + }, +} + +impl PublicIpv6ProviderState { + fn from_resolution( + resolution: PublicIpv6ProviderResolution, + ndp_target: Option, + ) -> Self { + match resolution { + PublicIpv6ProviderResolution::Disabled => Self::Disabled, + PublicIpv6ProviderResolution::Pending(error) => Self::Pending(error), + PublicIpv6ProviderResolution::Active(prefix) => Self::Active { prefix, ndp_target }, + } + } + + fn advertised_prefix(&self) -> Option { + match self { + Self::Active { prefix, .. } => Some(*prefix), + Self::Disabled | Self::Pending(_) => None, + } + } + + fn ndp_desired(&self) -> Option { + match self { + Self::Active { + prefix, + ndp_target: Some(target), + } => Some(PublicIpv6NdpDesired { + prefix: *prefix, + target: target.clone(), + }), + Self::Disabled | Self::Pending(_) | Self::Active { .. } => None, + } + } +} + +#[derive(Debug, Clone, thiserror::Error, PartialEq, Eq)] +pub enum PublicIpv6PlatformError { + #[error("public IPv6 platform adapter is unavailable")] + Unavailable, + #[error("{0}")] + Failed(String), +} + +#[async_trait] +pub trait PublicIpv6ProviderPlatform: Send + Sync + 'static { + fn inspect( + &self, + config: PublicIpv6ProviderConfig, + ) -> Result; + + fn sync_ndp( + &self, + desired: Option, + ) -> Result<(), PublicIpv6PlatformError>; + + /// Waits for a platform state change that requires an immediate retry. + /// Returns `false` when the event source has closed. + async fn wait_for_change(&self) -> bool; +} + +struct PublicIpv6ProviderTask { + cancel: CancellationToken, + handle: tokio::task::JoinHandle<()>, +} + +pub struct PublicIpv6ProviderService { + platform: Arc, + runtime_config: CoreRuntimeConfigStore, + runtime: Arc, + reconcile_interval: Duration, + reconcile: Mutex<()>, + last_state: std::sync::Mutex>, + task: Mutex>, + closing: AtomicBool, +} + +#[cfg(feature = "public-ipv6-provider")] +pub(crate) struct PublicIpv6ProviderRuntime { + service: Option>, + runtime_config: CoreRuntimeConfigStore, +} + +#[cfg(feature = "public-ipv6-provider")] +impl PublicIpv6ProviderRuntime { + pub(crate) fn new( + platform: Option>, + runtime_config: CoreRuntimeConfigStore, + runtime: Arc, + ) -> Self { + let service = platform.map(|platform| { + PublicIpv6ProviderService::new(platform, runtime_config.clone(), runtime) + }); + Self { + service, + runtime_config, + } + } + + pub(crate) async fn validate_before_start(&self) -> anyhow::Result<()> { + let config = self.runtime_config.snapshot().services.public_ipv6_provider; + config.validate().map_err(anyhow::Error::new)?; + if config.provider_enabled && self.service.is_none() { + anyhow::bail!("public IPv6 provider is enabled but no host adapter was provided"); + } + if let Some(service) = &self.service { + service.apply_config().await; + } + Ok(()) + } + + pub(crate) async fn start(&self) { + if let Some(service) = &self.service { + service.start().await; + } + } + + pub(crate) async fn stop(&self) { + if let Some(service) = &self.service { + service.stop().await; + } + } + + pub(crate) async fn reconcile(&self) -> bool { + let Some(service) = &self.service else { + return false; + }; + let applied = service.apply_config().await; + service.start().await; + applied + } +} + +impl PublicIpv6ProviderService { + pub fn new( + platform: Arc, + runtime_config: CoreRuntimeConfigStore, + runtime: Arc, + ) -> Arc { + Self::new_with_interval( + platform, + runtime_config, + runtime, + DEFAULT_RECONCILE_INTERVAL, + ) + } + + fn new_with_interval( + platform: Arc, + runtime_config: CoreRuntimeConfigStore, + runtime: Arc, + reconcile_interval: Duration, + ) -> Arc { + Arc::new(Self { + platform, + runtime_config, + runtime, + reconcile_interval, + reconcile: Mutex::new(()), + last_state: std::sync::Mutex::new(None), + task: Mutex::new(None), + closing: AtomicBool::new(false), + }) + } + + pub async fn reconcile_now(&self) -> bool { + let _reconcile = self.reconcile.lock().await; + if self.closing.load(Ordering::Acquire) { + return false; + } + for attempt in 0..MAX_CONFIG_RETRIES { + let config = self.runtime_config.snapshot().services.public_ipv6_provider; + let observation = if config.provider_enabled && config.provider_supported { + match self.platform.inspect(config) { + Ok(observation) => Ok(observation), + Err(PublicIpv6PlatformError::Unavailable) => return false, + Err(PublicIpv6PlatformError::Failed(error)) => Err(error), + } + } else { + Ok(PublicIpv6PlatformObservation::default()) + }; + let (detected_prefix, ndp_target) = match observation { + Ok(observation) => (Ok(observation.detected_prefix), observation.ndp_target), + Err(error) => (Err(error), None), + }; + let next_state = PublicIpv6ProviderState::from_resolution( + resolve_public_ipv6_provider(config, detected_prefix), + ndp_target, + ); + + if self.runtime_config.snapshot().services.public_ipv6_provider != config { + tracing::debug!( + attempt = attempt + 1, + max_retries = MAX_CONFIG_RETRIES, + "public IPv6 provider config changed during reconcile, retrying" + ); + continue; + } + + let changed = self + .runtime + .set_provider_prefix(next_state.advertised_prefix()); + if let Err(error) = self.platform.sync_ndp(next_state.ndp_desired()) { + match error { + PublicIpv6PlatformError::Unavailable => return false, + PublicIpv6PlatformError::Failed(error) => { + tracing::warn!(%error, "failed to synchronize public IPv6 NDP state"); + } + } + } + self.log_state_change(&next_state, changed); + *self.last_state.lock().unwrap() = Some(next_state); + return true; + } + + tracing::warn!( + max_retries = MAX_CONFIG_RETRIES, + "skipping public IPv6 provider reconcile because config kept changing" + ); + true + } + + pub async fn apply_config(&self) -> bool { + self.reconcile_now().await + } + + pub async fn start(self: &Arc) { + let mut task = self.task.lock().await; + let config = self.runtime_config.snapshot().services.public_ipv6_provider; + if self.closing.load(Ordering::Acquire) || task.is_some() || !config.should_run_reconcile() + { + return; + } + + let cancel = CancellationToken::new(); + let task_cancel = cancel.clone(); + let service = Arc::downgrade(self); + let platform = self.platform.clone(); + let handle = tokio::spawn(async move { + Self::run(service, platform, task_cancel).await; + }); + task.replace(PublicIpv6ProviderTask { cancel, handle }); + } + + pub async fn stop(&self) { + self.closing.store(true, Ordering::Release); + let task = self.task.lock().await.take(); + if let Some(task) = task { + task.cancel.cancel(); + if let Err(error) = task.handle.await { + tracing::warn!(?error, "public IPv6 provider task failed during shutdown"); + } + } + let _reconcile = self.reconcile.lock().await; + if let Err(error) = self.platform.sync_ndp(None) + && !matches!(error, PublicIpv6PlatformError::Unavailable) + { + tracing::warn!(%error, "failed to clean public IPv6 NDP state during shutdown"); + } + } + + fn log_state_change(&self, next_state: &PublicIpv6ProviderState, changed: bool) { + let last_state = self.last_state.lock().unwrap(); + if last_state.as_ref() != Some(next_state) { + match next_state { + PublicIpv6ProviderState::Disabled if last_state.is_some() => { + tracing::info!("public IPv6 provider disabled"); + } + PublicIpv6ProviderState::Disabled => {} + PublicIpv6ProviderState::Pending(reason) => { + tracing::warn!(%reason, "public IPv6 provider not ready"); + } + PublicIpv6ProviderState::Active { prefix, ndp_target } => { + if let Some(target) = ndp_target { + tracing::info!( + %prefix, + wan_interface = %target.wan_interface, + "public IPv6 provider is active with NDP proxy" + ); + } else { + tracing::info!(%prefix, "public IPv6 provider is active"); + } + } + } + } else if changed { + tracing::info!("public IPv6 provider runtime state changed"); + } + } + + async fn run( + service: Weak, + platform: Arc, + cancel: CancellationToken, + ) { + loop { + let Some(service) = service.upgrade() else { + let _ = platform.sync_ndp(None); + return; + }; + if !service.reconcile_now().await { + let _ = service.platform.sync_ndp(None); + return; + } + + let interval = service.reconcile_interval; + drop(service); + let should_continue = tokio::select! { + _ = cancel.cancelled() => false, + _ = crate::foundation::time::sleep(interval) => true, + changed = platform.wait_for_change() => changed, + }; + if !should_continue { + let _ = platform.sync_ndp(None); + return; + } + } + } +} + +#[cfg(test)] +mod tests { + use std::sync::{ + Mutex as StdMutex, + atomic::{AtomicUsize, Ordering}, + }; + + use tokio::sync::Notify; + + use super::*; + use crate::{ + config::peers::PeerRuntimeSnapshot, + config::runtime::{CoreRuntimeConfig, CoreRuntimeConfigStore}, + peers::context::PeerPublicIpv6State, + }; + + struct RecordingHost { + observation: StdMutex>, + inspect_calls: AtomicUsize, + ndp_desired: StdMutex>>, + change: Notify, + } + + impl Default for RecordingHost { + fn default() -> Self { + Self { + observation: StdMutex::new(Ok(PublicIpv6PlatformObservation::default())), + inspect_calls: AtomicUsize::new(0), + ndp_desired: StdMutex::new(Vec::new()), + change: Notify::new(), + } + } + } + + #[async_trait] + impl PublicIpv6ProviderPlatform for RecordingHost { + fn inspect( + &self, + _config: PublicIpv6ProviderConfig, + ) -> Result { + self.inspect_calls.fetch_add(1, Ordering::AcqRel); + self.observation.lock().unwrap().clone() + } + + async fn wait_for_change(&self) -> bool { + self.change.notified().await; + true + } + + fn sync_ndp( + &self, + desired: Option, + ) -> Result<(), PublicIpv6PlatformError> { + self.ndp_desired.lock().unwrap().push(desired); + Ok(()) + } + } + + fn provider_config(enabled: bool, prefix: Option) -> PublicIpv6ProviderConfig { + PublicIpv6ProviderConfig { + provider_enabled: enabled, + configured_prefix: prefix, + provider_supported: true, + } + } + + fn runtime_config(config: PublicIpv6ProviderConfig) -> CoreRuntimeConfigStore { + let services = CoreRuntimeConfig { + public_ipv6_provider: config, + ..Default::default() + }; + CoreRuntimeConfigStore::new(services, Arc::new(PeerRuntimeSnapshot::default())) + } + + fn runtime( + config: PublicIpv6ProviderConfig, + ) -> (CoreRuntimeConfigStore, Arc) { + let config = runtime_config(config); + let runtime = CorePublicIpv6Runtime::new(config.clone(), Arc::new(()), Arc::new(())); + (config, runtime) + } + + async fn wait_for_calls(counter: &AtomicUsize, expected: usize) { + crate::foundation::time::timeout(Duration::from_secs(1), async { + while counter.load(Ordering::Acquire) < expected { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + } + + #[tokio::test] + async fn starts_only_when_enabled_and_reacts_to_host_changes() { + let host = Arc::new(RecordingHost::default()); + let (runtime_config, runtime) = runtime(provider_config(false, None)); + let service = PublicIpv6ProviderService::new_with_interval( + host.clone(), + runtime_config.clone(), + runtime, + Duration::from_secs(60), + ); + + service.start().await; + assert_eq!(host.inspect_calls.load(Ordering::Acquire), 0); + + runtime_config.update_services(|services| { + services.public_ipv6_provider = + provider_config(true, Some("2001:db8::/48".parse().unwrap())); + }); + service.start().await; + wait_for_calls(&host.inspect_calls, 1).await; + host.change.notify_one(); + wait_for_calls(&host.inspect_calls, 2).await; + + service.stop().await; + assert_eq!(host.ndp_desired.lock().unwrap().last(), Some(&None)); + } + + #[tokio::test] + async fn does_not_reconcile_or_restart_after_stop() { + let host = Arc::new(RecordingHost::default()); + let (runtime_config, runtime) = runtime(provider_config( + true, + Some("2001:db8::/48".parse().unwrap()), + )); + let service = PublicIpv6ProviderService::new_with_interval( + host.clone(), + runtime_config, + runtime, + Duration::from_secs(60), + ); + + service.stop().await; + assert!(!service.reconcile_now().await); + service.start().await; + + assert_eq!(host.inspect_calls.load(Ordering::Acquire), 0); + assert_eq!(host.ndp_desired.lock().unwrap().as_slice(), &[None]); + } + + #[tokio::test] + async fn resolves_observation_and_publishes_ndp_desired_state() { + let host = Arc::new(RecordingHost::default()); + let prefix = "2001:db8::/48".parse().unwrap(); + let target = PublicIpv6NdpTarget { + wan_interface: "wan0".to_owned(), + }; + *host.observation.lock().unwrap() = Ok(PublicIpv6PlatformObservation { + detected_prefix: Some(prefix), + ndp_target: Some(target.clone()), + }); + let (runtime_config, runtime) = runtime(provider_config(true, None)); + let service = PublicIpv6ProviderService::new(host.clone(), runtime_config, runtime.clone()); + + assert!(service.reconcile_now().await); + + assert_eq!(runtime.advertised_ipv6_public_addr_prefix(), Some(prefix)); + assert!(runtime.public_ipv6_provider_enabled()); + assert_eq!( + host.ndp_desired.lock().unwrap().as_slice(), + &[Some(PublicIpv6NdpDesired { prefix, target })] + ); + } + + #[tokio::test] + async fn turns_platform_failure_into_pending_provider_state() { + let host = Arc::new(RecordingHost::default()); + *host.observation.lock().unwrap() = Err(PublicIpv6PlatformError::Failed( + "route query failed".to_owned(), + )); + let (runtime_config, runtime) = runtime(provider_config(true, None)); + let service = PublicIpv6ProviderService::new(host.clone(), runtime_config, runtime.clone()); + + assert!(service.reconcile_now().await); + + assert_eq!(runtime.advertised_ipv6_public_addr_prefix(), None); + assert!(!runtime.public_ipv6_provider_enabled()); + assert_eq!(host.ndp_desired.lock().unwrap().as_slice(), &[None]); + } + + struct ReconfiguringHost { + runtime_config: CoreRuntimeConfigStore, + replacement: PublicIpv6ProviderConfig, + inspect_calls: AtomicUsize, + } + + #[async_trait] + impl PublicIpv6ProviderPlatform for ReconfiguringHost { + fn inspect( + &self, + _config: PublicIpv6ProviderConfig, + ) -> Result { + if self.inspect_calls.fetch_add(1, Ordering::AcqRel) == 0 { + self.runtime_config.update_services(|services| { + services.public_ipv6_provider = self.replacement; + }); + } + Ok(PublicIpv6PlatformObservation::default()) + } + + fn sync_ndp( + &self, + _desired: Option, + ) -> Result<(), PublicIpv6PlatformError> { + Ok(()) + } + + async fn wait_for_change(&self) -> bool { + false + } + } + + #[tokio::test] + async fn retries_when_config_changes_during_platform_inspection() { + let first = provider_config(true, Some("2001:db8:1::/48".parse().unwrap())); + let replacement = provider_config(true, Some("2001:db8:2::/48".parse().unwrap())); + let (runtime_config, runtime) = runtime(first); + let host = Arc::new(ReconfiguringHost { + runtime_config: runtime_config.clone(), + replacement, + inspect_calls: AtomicUsize::new(0), + }); + let service = PublicIpv6ProviderService::new(host.clone(), runtime_config, runtime.clone()); + + assert!(service.reconcile_now().await); + + assert_eq!(host.inspect_calls.load(Ordering::Acquire), 2); + assert_eq!( + runtime.advertised_ipv6_public_addr_prefix(), + replacement.configured_prefix + ); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/public_ipv6/service.rs b/vendor/easytier/easytier-core/src/peers/public_ipv6/service.rs new file mode 100644 index 0000000..37cacb2 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/public_ipv6/service.rs @@ -0,0 +1,814 @@ +//! Lease-driven public IPv6 service: the lease allocator, the per-instance +//! service driving acquisition/renewal, and the RPC server serving lease +//! requests from client peers. + +use std::{ + collections::{BTreeMap, BTreeSet, HashMap, HashSet}, + net::Ipv6Addr, + sync::{Arc, Weak}, + time::{Duration, SystemTime}, +}; + +use cidr::{Ipv6Cidr, Ipv6Inet}; + +use crate::{ + config::PeerId, + peers::peer_rpc::PeerRpcManager, + proto::{ + common::Void, + peer_rpc::{ + AcquireIpv6PublicAddrLeaseRequest, GetIpv6PublicAddrLeaseRequest, + Ipv6PublicAddrLeaseReply, PublicIpv6AddrRpc, PublicIpv6AddrRpcClientFactory, + ReleaseIpv6PublicAddrLeaseRequest, RenewIpv6PublicAddrLeaseRequest, + }, + rpc_types::{ + self, + controller::{BaseController, Controller}, + }, + }, +}; + +use super::{ + PublicIpv6PeerRouteInfo, PublicIpv6RouteControl, PublicIpv6Runtime, PublicIpv6SyncTrigger, +}; + +// Use a longer lease with an early renew window to reduce steady-state RPC +// churn while preserving enough margin for transient provider failures. +static PUBLIC_IPV6_LEASE_TTL: Duration = Duration::from_secs(120); +static PUBLIC_IPV6_RENEW_INTERVAL: Duration = Duration::from_secs(40); + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) struct PublicIpv6Provider { + pub peer_id: PeerId, + pub inst_id: uuid::Uuid, + pub prefix: Ipv6Cidr, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub(crate) struct PublicIpv6ProviderLease { + pub peer_id: PeerId, + pub inst_id: uuid::Uuid, + pub addr: Ipv6Inet, + pub valid_until: SystemTime, + pub reused: bool, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +struct PublicIpv6ProviderState { + provider: PublicIpv6Provider, + leases: BTreeMap, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +struct PublicIpv6ClientState { + provider: PublicIpv6Provider, + lease: PublicIpv6ProviderLease, + last_error: Option, +} + +pub(crate) struct PublicIpv6Service { + runtime: Arc, + peer_rpc: Weak, + route_control: Arc, + sync_trigger: Arc, + + provider_state: std::sync::Mutex>, + client_state: std::sync::Mutex>, + route_cache: std::sync::Mutex>, + pub(super) my_addr_cache: std::sync::Mutex>, +} + +impl PublicIpv6Service { + pub fn new( + runtime: Arc, + peer_rpc: Weak, + route_control: Arc, + sync_trigger: Arc, + ) -> Self { + Self { + runtime, + peer_rpc, + route_control, + sync_trigger, + provider_state: std::sync::Mutex::new(None), + client_state: std::sync::Mutex::new(None), + route_cache: std::sync::Mutex::new(BTreeSet::new()), + my_addr_cache: std::sync::Mutex::new(None), + } + } + + pub fn rpc_server(self: &Arc) -> PublicIpv6AddrRpcServerImpl { + PublicIpv6AddrRpcServerImpl { + service: Arc::downgrade(self), + } + } + + fn my_peer_id(&self) -> PeerId { + self.route_control.my_peer_id() + } + + fn selected_provider(&self) -> Option { + Self::selected_provider_from_snapshot(&self.route_control.peer_route_snapshot()) + } + + fn current_provider_state(&self) -> Option { + self.provider_state.lock().unwrap().clone() + } + + fn current_client_state(&self) -> Option { + self.client_state.lock().unwrap().clone() + } + + fn set_provider_state(&self, next: Option) -> bool { + let mut guard = self.provider_state.lock().unwrap(); + if *guard == next { + return false; + } + *guard = next; + true + } + + fn set_client_state(&self, next: Option) -> bool { + let mut guard = self.client_state.lock().unwrap(); + if *guard == next { + return false; + } + *guard = next; + true + } + + pub(super) fn selected_provider_from_snapshot( + peers: &[PublicIpv6PeerRouteInfo], + ) -> Option { + peers + .iter() + .filter(|info| info.is_provider) + .filter(|info| info.reachable) + .filter_map(|info| { + Some(PublicIpv6Provider { + peer_id: info.peer_id, + inst_id: info.inst_id?, + prefix: info.prefix?, + }) + }) + .min_by_key(|provider| provider.inst_id) + } + + fn clear_provider_state_if_provider_changed( + &self, + provider: Option<&PublicIpv6Provider>, + ) -> bool { + let current = self.current_provider_state(); + let should_clear = current + .as_ref() + .is_some_and(|state| provider != Some(&state.provider)); + should_clear && self.set_provider_state(None) + } + + fn clear_client_state_if_provider_changed( + &self, + provider: Option<&PublicIpv6Provider>, + ) -> bool { + let current = self.current_client_state(); + let should_clear = current + .as_ref() + .is_some_and(|state| provider != Some(&state.provider)); + should_clear && self.set_client_state(None) + } + + fn collect_runtime_from_snapshot( + &self, + peers: &[PublicIpv6PeerRouteInfo], + ) -> (Option, BTreeSet) { + let mut my_addr = self.current_client_state().map(|state| state.lease.addr); + let mut routes = BTreeSet::new(); + + for info in peers { + let Some(lease) = info.lease else { + continue; + }; + + if info.peer_id == self.my_peer_id() { + my_addr = Some(lease); + continue; + } + + if info.reachable { + routes.insert(lease); + } + } + + (my_addr, routes) + } + + pub(super) fn reconcile_runtime_from_snapshot(&self, peers: &[PublicIpv6PeerRouteInfo]) { + let (mut my_addr, routes) = self.collect_runtime_from_snapshot(peers); + if !self.runtime.ipv6_public_addr_auto() { + my_addr = None; + } + + let mut cached_my_addr = self.my_addr_cache.lock().unwrap(); + if *cached_my_addr != my_addr { + let old = *cached_my_addr; + *cached_my_addr = my_addr; + self.runtime.public_ipv6_lease_changed(old, my_addr); + } + drop(cached_my_addr); + + let mut cached_routes = self.route_cache.lock().unwrap(); + if *cached_routes != routes { + let added = routes + .difference(&cached_routes) + .copied() + .collect::>(); + let removed = cached_routes + .difference(&routes) + .copied() + .collect::>(); + *cached_routes = routes; + self.runtime.public_ipv6_routes_changed(added, removed); + } + } + + pub(super) fn reconcile_runtime(&self) { + let peers = self.route_control.peer_route_snapshot(); + self.reconcile_runtime_from_snapshot(&peers); + } + + pub fn handle_route_change(&self) -> bool { + let peers = self.route_control.peer_route_snapshot(); + let provider = Self::selected_provider_from_snapshot(&peers); + let _provider_changed = self.clear_provider_state_if_provider_changed(provider.as_ref()); + let client_changed = self.clear_client_state_if_provider_changed(provider.as_ref()); + + let peer_info_changed = if client_changed { + self.publish_current_client_lease() + } else { + false + }; + + // When client state changed, publish_current_client_lease() mutated the + // local peer info synchronously, so the pre-update snapshot is stale for + // this node's own entry. Re-fetch to avoid reconciling against old data. + if client_changed { + self.reconcile_runtime(); + } else { + self.reconcile_runtime_from_snapshot(&peers); + } + peer_info_changed + } + + fn publish_current_client_lease(&self) -> bool { + self.route_control.publish_self_public_ipv6_lease( + self.current_client_state() + .as_ref() + .map(|state| state.lease.addr), + ) + } + + fn clear_client_lease_state(&self, mut state_changed: bool) -> bool { + state_changed |= self.set_client_state(None); + let peer_info_changed = if state_changed { + self.route_control.publish_self_public_ipv6_lease(None) + } else { + false + }; + if state_changed { + // publish_self_public_ipv6_lease mutated the local peer info above, + // so the snapshot passed in is stale for this node. + self.reconcile_runtime(); + } + peer_info_changed + } + + fn build_lease_reply( + provider: &PublicIpv6Provider, + lease: Option<&PublicIpv6ProviderLease>, + error_msg: Option, + ) -> Ipv6PublicAddrLeaseReply { + Ipv6PublicAddrLeaseReply { + provider_peer_id: provider.peer_id, + provider_inst_id: Some(provider.inst_id.into()), + provider_prefix: Some( + Ipv6Inet::new( + provider.prefix.first_address(), + provider.prefix.network_length(), + ) + .unwrap() + .into(), + ), + leased_addr: lease.map(|lease| lease.addr.into()), + valid_until: lease.map(|lease| lease.valid_until.into()), + reused: lease.map(|lease| lease.reused).unwrap_or(false), + error_msg, + } + } + + async fn collect_reserved_addrs(&self, prefix: Ipv6Cidr) -> HashSet { + self.runtime + .collect_reserved_public_ipv6_addrs(prefix) + .await + } + + fn prune_expired_leases( + provider: &PublicIpv6Provider, + current: Option, + ) -> PublicIpv6ProviderState { + let mut state = current.unwrap_or_else(|| PublicIpv6ProviderState { + provider: provider.clone(), + leases: BTreeMap::new(), + }); + state.provider = provider.clone(); + let now = SystemTime::now(); + state.leases.retain(|_, lease| lease.valid_until > now); + state + } + + async fn acquire_lease( + &self, + requester_peer_id: PeerId, + requester_inst_id: uuid::Uuid, + renew_only: bool, + requested_addr: Option, + ) -> Result { + let provider = self + .selected_provider() + .ok_or_else(|| "no active ipv6 public address provider".to_string())?; + if provider.peer_id != self.my_peer_id() { + return Err("this peer is not the selected ipv6 public address provider".to_string()); + } + + let mut state = Self::prune_expired_leases(&provider, self.current_provider_state()); + if let Some(existing) = state.leases.get_mut(&requester_inst_id) { + if requested_addr.is_some() && requested_addr != Some(existing.addr) { + return Err("requested lease does not match the active allocation".to_string()); + } + existing.peer_id = requester_peer_id; + existing.valid_until = SystemTime::now() + PUBLIC_IPV6_LEASE_TTL; + existing.reused = true; + let lease = existing.clone(); + self.set_provider_state(Some(state)); + return Ok(lease); + } + + if renew_only { + return Err("lease not found".to_string()); + } + + let mut reserved = self.collect_reserved_addrs(provider.prefix).await; + let old_map = state + .leases + .iter() + .map(|(inst_id, lease)| { + reserved.insert(lease.addr.address()); + (*inst_id, lease.addr) + }) + .collect::>(); + + let mut allocated = + allocate_public_ipv6_leases(provider.prefix, &[requester_inst_id], &reserved, &old_map); + let Some(mut lease) = allocated.pop() else { + return Err(format!( + "no free ipv6 address left in provider prefix {}", + provider.prefix + )); + }; + lease.peer_id = requester_peer_id; + lease.valid_until = SystemTime::now() + PUBLIC_IPV6_LEASE_TTL; + + state.leases.insert(requester_inst_id, lease.clone()); + self.set_provider_state(Some(state)); + Ok(lease) + } + + fn release_lease(&self, requester_peer_id: PeerId, requester_inst_id: uuid::Uuid) -> bool { + let Some(provider) = self.selected_provider() else { + return false; + }; + if provider.peer_id != self.my_peer_id() { + return false; + } + + let mut state = Self::prune_expired_leases(&provider, self.current_provider_state()); + let removed = state + .leases + .get(&requester_inst_id) + .map(|lease| lease.peer_id == requester_peer_id) + .unwrap_or(false); + if !removed { + return false; + } + + state.leases.remove(&requester_inst_id); + self.set_provider_state(Some(state)) + } + + fn get_lease( + &self, + requester_peer_id: PeerId, + requester_inst_id: uuid::Uuid, + requested_addr: Option, + ) -> Result<(PublicIpv6Provider, PublicIpv6ProviderLease), String> { + let provider = self + .selected_provider() + .ok_or_else(|| "no active ipv6 public address provider".to_string())?; + if provider.peer_id != self.my_peer_id() { + return Err("this peer is not the selected ipv6 public address provider".to_string()); + } + + let state = Self::prune_expired_leases(&provider, self.current_provider_state()); + let Some(lease) = state.leases.get(&requester_inst_id) else { + return Err("lease not found".to_string()); + }; + if lease.peer_id != requester_peer_id { + return Err("lease owner mismatch".to_string()); + } + if requested_addr.is_some() && requested_addr != Some(lease.addr) { + return Err("requested lease does not match the active allocation".to_string()); + } + Ok((provider, lease.clone())) + } + + pub async fn gc_provider_leases(&self) { + let peers = self.route_control.peer_route_snapshot(); + let provider = Self::selected_provider_from_snapshot(&peers); + self.clear_provider_state_if_provider_changed(provider.as_ref()); + + let Some(provider) = provider else { + return; + }; + if provider.peer_id != self.my_peer_id() { + return; + } + + let state = Self::prune_expired_leases(&provider, self.current_provider_state()); + self.set_provider_state(Some(state)); + } + + pub async fn sync_client_state(&self) -> bool { + if !self.runtime.ipv6_public_addr_auto() { + return self + .clear_client_lease_state(self.clear_client_state_if_provider_changed(None)); + } + + let peers = self.route_control.peer_route_snapshot(); + let provider = Self::selected_provider_from_snapshot(&peers); + self.clear_provider_state_if_provider_changed(provider.as_ref()); + let state_changed = self.clear_client_state_if_provider_changed(provider.as_ref()); + + let Some(provider) = provider else { + return self.clear_client_lease_state(state_changed); + }; + + if provider.peer_id == self.my_peer_id() { + return self.clear_client_lease_state(state_changed); + } + + let current = self.current_client_state(); + let need_rpc = current.as_ref().is_none_or(|state| { + state.provider != provider + || state.lease.valid_until <= SystemTime::now() + PUBLIC_IPV6_RENEW_INTERVAL + }); + + if !need_rpc { + if state_changed { + self.reconcile_runtime(); + } + return false; + } + + let Some(peer_rpc) = self.peer_rpc.upgrade() else { + if state_changed { + self.reconcile_runtime(); + } + return false; + }; + + let mut ctrl = BaseController::default(); + ctrl.set_timeout_ms(3000); + let rpc_stub = peer_rpc + .rpc_client() + .scoped_client::>( + self.my_peer_id(), + provider.peer_id, + self.runtime.network_name(), + ); + + let inst_id = self.runtime.instance_id(); + let reply = if let Some(state) = current.as_ref().filter(|state| state.provider == provider) + { + match rpc_stub + .renew_lease( + ctrl.clone(), + RenewIpv6PublicAddrLeaseRequest { + peer_id: self.my_peer_id(), + inst_id: Some(inst_id.into()), + leased_addr: Some(state.lease.addr.into()), + }, + ) + .await + { + Ok(reply) if reply.error_msg.is_none() => Ok(reply), + Ok(_) | Err(_) => { + rpc_stub + .acquire_lease( + ctrl.clone(), + AcquireIpv6PublicAddrLeaseRequest { + peer_id: self.my_peer_id(), + inst_id: Some(inst_id.into()), + }, + ) + .await + } + } + } else { + rpc_stub + .acquire_lease( + ctrl, + AcquireIpv6PublicAddrLeaseRequest { + peer_id: self.my_peer_id(), + inst_id: Some(inst_id.into()), + }, + ) + .await + }; + + let mut state_changed = state_changed; + + match reply { + Ok(reply) if reply.error_msg.is_none() => { + let Some(leased_addr) = reply.leased_addr.map(Into::into) else { + return false; + }; + let valid_until = reply + .valid_until + .and_then(|ts| SystemTime::try_from(ts).ok()) + .unwrap_or_else(|| SystemTime::now() + PUBLIC_IPV6_LEASE_TTL); + let next_state = PublicIpv6ClientState { + provider: provider.clone(), + lease: PublicIpv6ProviderLease { + peer_id: self.my_peer_id(), + inst_id, + addr: leased_addr, + valid_until, + reused: reply.reused, + }, + last_error: None, + }; + state_changed |= self.set_client_state(Some(next_state)); + } + Ok(_) | Err(_) => { + let should_clear = current + .as_ref() + .map(|state| state.lease.valid_until <= SystemTime::now()) + .unwrap_or(true); + if should_clear { + state_changed |= self.set_client_state(None); + } + } + } + + let peer_info_changed = if state_changed { + self.publish_current_client_lease() + } else { + false + }; + + if state_changed { + self.reconcile_runtime(); + } + + peer_info_changed + } + + pub async fn provider_gc_routine(self: Arc) { + if !self.runtime.ipv6_public_addr_provider() { + return; + } + loop { + crate::foundation::time::sleep(Duration::from_secs(15)).await; + self.gc_provider_leases().await; + } + } + + pub async fn client_routine(self: Arc) { + loop { + if self.sync_client_state().await { + self.sync_trigger.sync_now("sync_public_ipv6_client_state"); + } + crate::foundation::time::sleep(Duration::from_secs(5)).await; + } + } + + pub fn list_routes(&self) -> BTreeSet { + self.route_cache.lock().unwrap().clone() + } + + pub fn my_addr(&self) -> Option { + *self.my_addr_cache.lock().unwrap() + } + + pub fn provider_peer_id_for_client(&self) -> Option { + self.current_client_state() + .map(|state| state.provider.peer_id) + } + + pub fn local_provider_state( + &self, + ) -> Option<(PublicIpv6Provider, Vec)> { + let provider = self.selected_provider()?; + if provider.peer_id != self.my_peer_id() { + return None; + } + + let state = Self::prune_expired_leases(&provider, self.current_provider_state()); + let mut leases = state.leases.into_values().collect::>(); + leases.sort_by_key(|lease| (lease.peer_id, lease.inst_id, lease.addr)); + Some((provider, leases)) + } +} + +#[derive(Clone)] +pub(crate) struct PublicIpv6AddrRpcServerImpl { + service: Weak, +} + +impl PublicIpv6AddrRpcServerImpl { + fn selected_provider( + service: &PublicIpv6Service, + ) -> rpc_types::error::Result { + service + .selected_provider() + .ok_or_else(|| anyhow::anyhow!("provider not available").into()) + } + + fn build_error_reply( + service: &PublicIpv6Service, + error_msg: String, + ) -> rpc_types::error::Result { + Ok(PublicIpv6Service::build_lease_reply( + &Self::selected_provider(service)?, + None, + Some(error_msg), + )) + } +} + +#[async_trait::async_trait] +impl PublicIpv6AddrRpc for PublicIpv6AddrRpcServerImpl { + type Controller = BaseController; + + async fn acquire_lease( + &self, + _: BaseController, + request: AcquireIpv6PublicAddrLeaseRequest, + ) -> rpc_types::error::Result { + let Some(service) = self.service.upgrade() else { + return Err(anyhow::anyhow!("public ipv6 service stopped").into()); + }; + let inst_id: uuid::Uuid = request + .inst_id + .ok_or_else(|| anyhow::anyhow!("inst_id is required"))? + .into(); + + match service + .acquire_lease(request.peer_id, inst_id, false, None) + .await + { + Ok(lease) => Ok(PublicIpv6Service::build_lease_reply( + &Self::selected_provider(&service)?, + Some(&lease), + None, + )), + Err(error_msg) => Self::build_error_reply(&service, error_msg), + } + } + + async fn renew_lease( + &self, + _: BaseController, + request: RenewIpv6PublicAddrLeaseRequest, + ) -> rpc_types::error::Result { + let Some(service) = self.service.upgrade() else { + return Err(anyhow::anyhow!("public ipv6 service stopped").into()); + }; + let inst_id: uuid::Uuid = request + .inst_id + .ok_or_else(|| anyhow::anyhow!("inst_id is required"))? + .into(); + let requested_addr = request.leased_addr.map(Into::into); + + match service + .acquire_lease(request.peer_id, inst_id, true, requested_addr) + .await + { + Ok(lease) => Ok(PublicIpv6Service::build_lease_reply( + &Self::selected_provider(&service)?, + Some(&lease), + None, + )), + Err(error_msg) => Self::build_error_reply(&service, error_msg), + } + } + + async fn release_lease( + &self, + _: BaseController, + request: ReleaseIpv6PublicAddrLeaseRequest, + ) -> rpc_types::error::Result { + let Some(service) = self.service.upgrade() else { + return Err(anyhow::anyhow!("public ipv6 service stopped").into()); + }; + let inst_id: uuid::Uuid = request + .inst_id + .ok_or_else(|| anyhow::anyhow!("inst_id is required"))? + .into(); + service.release_lease(request.peer_id, inst_id); + Ok(Default::default()) + } + + async fn get_lease( + &self, + _: BaseController, + request: GetIpv6PublicAddrLeaseRequest, + ) -> rpc_types::error::Result { + let Some(service) = self.service.upgrade() else { + return Err(anyhow::anyhow!("public ipv6 service stopped").into()); + }; + let inst_id: uuid::Uuid = request + .inst_id + .ok_or_else(|| anyhow::anyhow!("inst_id is required"))? + .into(); + match service.get_lease(request.peer_id, inst_id, None) { + Ok((provider, lease)) => Ok(PublicIpv6Service::build_lease_reply( + &provider, + Some(&lease), + None, + )), + Err(error_msg) => Self::build_error_reply(&service, error_msg), + } + } +} + +pub(super) fn allocate_public_ipv6_leases( + prefix: Ipv6Cidr, + auto_peer_ids: &[uuid::Uuid], + reserved: &HashSet, + old_map: &HashMap, +) -> Vec { + let prefix_len = prefix.network_length(); + let host_bits = 128_u32.saturating_sub(prefix_len as u32); + let max_offsets = if host_bits == 128 { + None + } else { + Some(1_u128 << host_bits) + }; + let network = u128::from(prefix.first_address()); + + let mut used_offsets = reserved + .iter() + .filter(|addr| prefix.contains(addr)) + .map(|addr| u128::from(*addr).saturating_sub(network)) + .collect::>(); + + let mut leases = Vec::with_capacity(auto_peer_ids.len()); + for inst_id in auto_peer_ids.iter().copied() { + let addr = if let Some(existing) = old_map.get(&inst_id).copied() + && prefix.contains(&existing.address()) + && used_offsets.insert(u128::from(existing.address()).saturating_sub(network)) + { + existing + } else { + let Some(max_offsets) = max_offsets else { + continue; + }; + let usable_slots = max_offsets.saturating_sub(1); + let offset = if usable_slots == 0 { + used_offsets.insert(0).then_some(0) + } else { + let start_offset = (inst_id.as_u128() % usable_slots) + 1; + (0..usable_slots) + .map(|step| ((start_offset - 1 + step) % usable_slots) + 1) + .find(|offset| used_offsets.insert(*offset)) + }; + let Some(offset) = offset else { + break; + }; + + Ipv6Inet::new(Ipv6Addr::from(network + offset), 128).unwrap() + }; + + leases.push(PublicIpv6ProviderLease { + peer_id: 0, + inst_id, + addr, + valid_until: SystemTime::UNIX_EPOCH, + reused: old_map + .get(&inst_id) + .map(|old| *old == addr) + .unwrap_or(false), + }); + } + + leases +} diff --git a/vendor/easytier/easytier-core/src/peers/relay_peer_map.rs b/vendor/easytier/easytier-core/src/peers/relay_peer_map.rs new file mode 100644 index 0000000..c610037 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/relay_peer_map.rs @@ -0,0 +1,1000 @@ +use std::sync::Arc; + +use dashmap::DashMap; +use prost::Message; +use quanta::Instant; +use snow::params::NoiseParams; +use tokio::sync::{Mutex, OwnedMutexGuard, oneshot}; + +use crate::{ + config::PeerId, + foundation::time::{Duration, timeout}, + packet::{PacketType, ZCPacket}, + peers::{ + conn::{ + peer_map::PeerMap, + peer_session::{PeerSession, PeerSessionAction, PeerSessionStore, SessionKey}, + }, + context::ArcPeerContext, + error::Error, + foreign_network::client::ForeignNetworkClient, + route::NextHopPolicy, + util::shrink_dashmap, + }, + proto::peer_rpc::RoutePeerInfo, + proto::peer_rpc::{PeerConnSessionActionPb, RelayNoiseMsg1Pb, RelayNoiseMsg2Pb}, +}; + +const RELAY_NOISE_VERSION: u32 = 1; +const RELAY_NOISE_PROLOGUE: &[u8] = b"easytier-relay-noise"; +const HANDSHAKE_TIMEOUT_SECS: u64 = 5; +const HANDSHAKE_RETRY_BASE_MS: u64 = 200; +const HANDSHAKE_MAX_ATTEMPTS: u32 = 3; +const MAX_PENDING_PACKETS_PER_PEER: usize = 32; + +#[derive(Clone)] +pub struct RelayPeerState { + pub last_active_at: Instant, + pub failure_count: u32, + pub next_retry_at: Option, +} + +impl Default for RelayPeerState { + fn default() -> Self { + Self { + last_active_at: Instant::now(), + failure_count: 0, + next_retry_at: None, + } + } +} + +pub struct RelayPeerMap { + route_transport: Arc, + context: ArcPeerContext, + metric_network_name: String, + my_peer_id: PeerId, + peer_session_store: Arc, + states: DashMap, + pending_handshakes: DashMap>, + handshake_locks: DashMap>>, + pub(crate) pending_packets: DashMap>, + + is_secure_mode_enabled: bool, +} + +#[async_trait::async_trait] +#[auto_impl::auto_impl(Arc)] +pub trait RelayRouteTransport: Send + Sync { + async fn get_route_peer_info(&self, peer_id: PeerId) -> Option; + + async fn send_msg_to_next_hop( + &self, + msg: ZCPacket, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result<(), Error>; +} + +pub struct PeerMapRelayRouteTransport { + peer_map: Arc, + foreign_network_client: Option>, +} + +#[async_trait::async_trait] +impl RelayRouteTransport for PeerMapRelayRouteTransport { + async fn get_route_peer_info(&self, peer_id: PeerId) -> Option { + self.peer_map.get_route_peer_info(peer_id).await + } + + async fn send_msg_to_next_hop( + &self, + msg: ZCPacket, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result<(), Error> { + let Some(next_hop) = self.peer_map.get_gateway_peer_id(dst_peer_id, policy).await else { + return Err(Error::RouteError(Some(format!( + "next hop not found in route for peer {dst_peer_id:?}" + )))); + }; + if self.peer_map.has_peer(next_hop) { + self.peer_map.send_msg_directly(msg, next_hop).await + } else if let Some(foreign_network_client) = &self.foreign_network_client { + foreign_network_client.send_msg(msg, next_hop).await + } else { + Err(Error::RouteError(Some(format!( + "next hop not found in direct peer map: {next_hop:?}" + )))) + } + } +} + +pub fn new_relay_peer_map( + peer_map: Arc, + foreign_network_client: Option>, + context: ArcPeerContext, + my_peer_id: PeerId, + peer_session_store: Arc, +) -> Arc { + RelayPeerMap::new( + Arc::new(PeerMapRelayRouteTransport { + peer_map, + foreign_network_client, + }), + context, + my_peer_id, + peer_session_store, + ) +} + +impl RelayPeerMap { + pub(crate) fn new( + route_transport: Arc, + context: ArcPeerContext, + my_peer_id: PeerId, + peer_session_store: Arc, + ) -> Arc { + let is_secure_mode_enabled = context + .secure_mode() + .map(|cfg| cfg.enabled) + .unwrap_or(false); + let metric_network_name = context.network_name(); + Arc::new(Self { + route_transport, + context, + metric_network_name, + my_peer_id, + peer_session_store, + states: DashMap::new(), + pending_handshakes: DashMap::new(), + handshake_locks: DashMap::new(), + pending_packets: DashMap::new(), + is_secure_mode_enabled, + }) + } + + pub fn is_secure_mode_enabled(&self) -> bool { + self.is_secure_mode_enabled + } + + fn get_local_keypair(&self) -> Result<(Vec, Vec), Error> { + let cfg = self + .context + .secure_mode() + .ok_or_else(|| Error::RouteError(Some("secure mode config not set".to_string())))?; + let private = cfg + .private_key() + .map_err(|e| Error::RouteError(Some(format!("invalid private key: {e:?}"))))?; + let public = cfg + .public_key() + .map_err(|e| Error::RouteError(Some(format!("invalid public key: {e:?}"))))?; + Ok((private.as_bytes().to_vec(), public.as_bytes().to_vec())) + } + + async fn get_remote_static_pubkey(&self, peer_id: PeerId) -> Result, Error> { + let info = self + .route_transport + .get_route_peer_info(peer_id) + .await + .ok_or_else(|| Error::RouteError(Some("route peer info not found".to_string())))?; + if info.noise_static_pubkey.is_empty() { + return Err(Error::RouteError(Some( + "remote static pubkey not found".to_string(), + ))); + } + Ok(info.noise_static_pubkey) + } + + fn get_handshake_lock(&self, peer_id: PeerId) -> Arc> { + self.handshake_locks + .entry(peer_id) + .or_insert_with(|| Arc::new(Mutex::new(()))) + .clone() + } + + async fn send_handshake_packet( + &self, + payload: Vec, + packet_type: PacketType, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result<(), Error> { + let mut pkt = ZCPacket::new_with_payload(&payload); + pkt.fill_peer_manager_hdr(self.my_peer_id, dst_peer_id, packet_type as u8); + pkt.mut_peer_manager_header() + .unwrap() + .set_latency_first(matches!(&policy, NextHopPolicy::LeastCost)); + let pkt_len = pkt.buf_len() as u64; + self.send_via_next_hop(pkt, dst_peer_id, policy).await?; + self.context + .record_control_tx(&self.metric_network_name, pkt_len); + Ok(()) + } + + async fn send_via_next_hop( + &self, + msg: ZCPacket, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result<(), Error> { + self.route_transport + .send_msg_to_next_hop(msg, dst_peer_id, policy) + .await + } + + pub async fn send_msg( + self: &Arc, + mut msg: ZCPacket, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result<(), Error> { + // Forwarded packets belong to the original sender's end-to-end session. + // Do not establish another session or encrypt them at this hop. + if msg + .peer_manager_header() + .is_some_and(|hdr| hdr.from_peer_id.get() != self.my_peer_id) + { + return self.send_via_next_hop(msg, dst_peer_id, policy).await; + } + + let now = Instant::now(); + + self.states.entry(dst_peer_id).or_default().last_active_at = now; + + if self.is_secure_mode_enabled() { + match self.ensure_session(dst_peer_id, policy.clone()).await { + Ok(session) => { + let my_peer_id = self.my_peer_id; + session + .encrypt_payload(my_peer_id, dst_peer_id, &mut msg) + .map_err(|e| Error::RouteError(Some(format!("{e:?}"))))?; + } + Err(_) => { + // Handshake in progress, buffer the packet instead of dropping it + self.buffer_pending_packet(dst_peer_id, msg, policy); + return Ok(()); + } + } + } + + self.send_via_next_hop(msg, dst_peer_id, policy).await + } + + fn buffer_pending_packet(&self, dst_peer_id: PeerId, pkt: ZCPacket, policy: NextHopPolicy) { + let mut entry = self.pending_packets.entry(dst_peer_id).or_default(); + if entry.len() < MAX_PENDING_PACKETS_PER_PEER { + entry.push((pkt, policy)); + } + // silently drop when buffer is full + } + + async fn flush_pending_packets(&self, dst_peer_id: PeerId, session: Arc) { + let packets = self.pending_packets.remove(&dst_peer_id).map(|(_, v)| v); + let Some(packets) = packets else { return }; + if packets.is_empty() { + return; + } + + tracing::debug!( + ?dst_peer_id, + count = packets.len(), + "flushing pending packets after relay handshake" + ); + + for (mut pkt, policy) in packets { + if session + .encrypt_payload(self.my_peer_id, dst_peer_id, &mut pkt) + .is_err() + { + continue; + } + let _ = self.send_via_next_hop(pkt, dst_peer_id, policy).await; + } + } + + pub fn has_session(&self, dst_peer_id: PeerId) -> bool { + self.peer_session_store + .get(&SessionKey::new( + self.context.network_identity().network_name, + dst_peer_id, + )) + .is_some() + } + + pub async fn ensure_session( + self: &Arc, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result, Error> { + let network = self.context.network_identity(); + let key = SessionKey::new(network.network_name.clone(), dst_peer_id); + if let Some(session) = self.peer_session_store.get(&key) { + return Ok(session); + } + + let lock = self.get_handshake_lock(dst_peer_id); + if let Ok(guard) = lock.try_lock_owned() { + let self_clone = self.clone(); + tokio::spawn(async move { + self_clone + .handshake_session(dst_peer_id, policy, Some(guard)) + .await + }); + }; + Err(Error::RouteError(Some( + "relay handshake in progress".to_string(), + ))) + } + + #[tracing::instrument(skip(self, _lock_guard), level = "debug", ret)] + pub async fn handshake_session( + &self, + dst_peer_id: PeerId, + policy: NextHopPolicy, + _lock_guard: Option>, + ) -> Result<(), Error> { + let network = self.context.network_identity(); + let key = SessionKey::new(network.network_name.clone(), dst_peer_id); + if let Some(session) = self.peer_session_store.get(&key) { + self.flush_pending_packets(dst_peer_id, session).await; + return Ok(()); + } + + if let Some(next_retry_at) = self.states.get(&dst_peer_id).and_then(|v| v.next_retry_at) + && Instant::now() < next_retry_at + { + self.pending_packets.remove(&dst_peer_id); + return Err(Error::RouteError(Some( + "relay handshake backoff".to_string(), + ))); + } + + let mut last_err = None; + for attempt in 0..HANDSHAKE_MAX_ATTEMPTS { + let ret = self + .handshake_session_once(dst_peer_id, policy.clone()) + .await; + match ret { + Ok(session) => { + self.register_handshake_success(dst_peer_id); + self.flush_pending_packets(dst_peer_id, session).await; + return Ok(()); + } + Err(e) => { + last_err = Some(e); + self.register_handshake_failure(dst_peer_id, attempt); + if attempt + 1 < HANDSHAKE_MAX_ATTEMPTS { + let backoff = HANDSHAKE_RETRY_BASE_MS.saturating_mul(1 << attempt); + crate::foundation::time::sleep(Duration::from_millis(backoff)).await; + } + } + } + } + + // All attempts failed, drop buffered packets + self.pending_packets.remove(&dst_peer_id); + + Err(last_err + .unwrap_or_else(|| Error::RouteError(Some("relay handshake failed".to_string())))) + } + + #[tracing::instrument(skip(self), level = "debug", ret)] + async fn handshake_session_once( + &self, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result, Error> { + let network = self.context.network_identity(); + let session_key = SessionKey::new(network.network_name.clone(), dst_peer_id); + let (local_private_key, _local_public_key) = self.get_local_keypair()?; + let remote_static = self.get_remote_static_pubkey(dst_peer_id).await?; + let params: NoiseParams = "Noise_IK_25519_ChaChaPoly_SHA256" + .parse() + .map_err(|e| Error::RouteError(Some(format!("parse noise params failed: {e:?}"))))?; + + let builder = snow::Builder::new(params); + let mut hs = builder + .prologue(RELAY_NOISE_PROLOGUE) + .map_err(|e| Error::RouteError(Some(format!("set prologue failed: {e:?}"))))? + .local_private_key(&local_private_key) + .map_err(|e| Error::RouteError(Some(format!("set local key failed: {e:?}"))))? + .remote_public_key(&remote_static) + .map_err(|e| Error::RouteError(Some(format!("set remote key failed: {e:?}"))))? + .build_initiator() + .map_err(|e| Error::RouteError(Some(format!("build initiator failed: {e:?}"))))?; + + let a_session_generation = self + .peer_session_store + .get(&session_key) + .map(|s| s.session_generation()); + let a_conn_id = uuid::Uuid::new_v4(); + let msg1_pb = RelayNoiseMsg1Pb { + version: RELAY_NOISE_VERSION, + a_session_generation, + a_conn_id: Some(a_conn_id.into()), + client_encryption_algorithm: self.context.flags().encryption_algorithm, + }; + let payload = msg1_pb.encode_to_vec(); + let mut out = vec![0u8; 4096]; + let out_len = hs + .write_message(&payload, &mut out) + .map_err(|e| Error::RouteError(Some(format!("noise write msg1 failed: {e:?}"))))?; + let (tx, rx) = oneshot::channel(); + self.pending_handshakes.insert(dst_peer_id, tx); + + let send_res = self + .send_handshake_packet( + out[..out_len].to_vec(), + PacketType::RelayHandshake, + dst_peer_id, + policy, + ) + .await; + + if send_res.is_err() { + self.pending_handshakes.remove(&dst_peer_id); + } + send_res?; + let msg2_pkt = match timeout(Duration::from_secs(HANDSHAKE_TIMEOUT_SECS), rx).await { + Ok(Ok(pkt)) => pkt, + Ok(Err(_)) => { + self.pending_handshakes.remove(&dst_peer_id); + return Err(Error::RouteError(Some( + "relay handshake canceled".to_string(), + ))); + } + Err(_) => { + self.pending_handshakes.remove(&dst_peer_id); + return Err(Error::RouteError(Some( + "relay handshake timeout".to_string(), + ))); + } + }; + + let msg2_pb = self.decode_handshake_message::( + PacketType::RelayHandshakeAck, + &mut hs, + msg2_pkt, + )?; + if msg2_pb.a_conn_id_echo != Some(a_conn_id.into()) { + return Err(Error::RouteError(Some( + "relay msg2 conn_id_echo mismatch".to_string(), + ))); + } + + let action = PeerConnSessionActionPb::try_from(msg2_pb.action) + .map_err(|_| Error::RouteError(Some("invalid session action".to_string())))?; + let session_action = match action { + PeerConnSessionActionPb::Join => PeerSessionAction::Join, + PeerConnSessionActionPb::Sync => PeerSessionAction::Sync, + PeerConnSessionActionPb::Create => PeerSessionAction::Create, + }; + let remote_static_key = if remote_static.len() == 32 { + let mut key = [0u8; 32]; + key.copy_from_slice(&remote_static); + Some(key) + } else { + None + }; + let root_key_bytes = msg2_pb + .root_key_32 + .as_deref() + .filter(|v| v.len() == 32) + .map(|v| { + let mut key_bytes = [0u8; 32]; + key_bytes.copy_from_slice(v); + key_bytes + }); + let algo = self.context.flags().encryption_algorithm; + let session = self + .peer_session_store + .apply_initiator_action( + &session_key, + session_action, + msg2_pb.b_session_generation, + root_key_bytes, + msg2_pb.initial_epoch, + algo, + msg2_pb.server_encryption_algorithm.clone(), + remote_static_key, + ) + .map_err(|e| Error::RouteError(Some(format!("{e:?}"))))?; + + Ok(session) + } + + fn register_handshake_success(&self, dst_peer_id: PeerId) { + let mut entry = self.states.entry(dst_peer_id).or_default(); + entry.failure_count = 0; + entry.next_retry_at = None; + } + + fn register_handshake_failure(&self, dst_peer_id: PeerId, attempt: u32) { + let mut entry = self.states.entry(dst_peer_id).or_default(); + entry.failure_count = entry.failure_count.saturating_add(1); + let backoff = HANDSHAKE_RETRY_BASE_MS.saturating_mul(1 << attempt); + entry.next_retry_at = Some(Instant::now() + Duration::from_millis(backoff)); + } + + fn decode_handshake_message( + &self, + expected_type: PacketType, + hs: &mut snow::HandshakeState, + pkt: ZCPacket, + ) -> Result { + let hdr = pkt.peer_manager_header().ok_or_else(|| { + Error::RouteError(Some("packet without peer manager header".to_string())) + })?; + if hdr.packet_type != expected_type as u8 { + return Err(Error::RouteError(Some("packet type mismatch".to_string()))); + } + let mut out = vec![0u8; 4096]; + let out_len = hs + .read_message(pkt.payload(), &mut out) + .map_err(|e| Error::RouteError(Some(format!("noise read msg failed: {e:?}"))))?; + let msg = MsgT::decode(&out[..out_len]) + .map_err(|e| Error::RouteError(Some(format!("decode message failed: {e:?}"))))?; + Ok(msg) + } + + pub async fn handle_handshake_packet(&self, packet: ZCPacket) -> Result<(), Error> { + let hdr = packet + .peer_manager_header() + .ok_or_else(|| Error::RouteError(Some("packet without header".to_string())))?; + let src_peer_id = hdr.from_peer_id.get(); + self.context + .record_control_rx(&self.metric_network_name, packet.buf_len() as u64); + match hdr.packet_type { + x if x == PacketType::RelayHandshake as u8 => { + tracing::debug!("handle_relay_msg1 from {:?}", src_peer_id); + self.handle_relay_msg1(packet, src_peer_id).await + } + x if x == PacketType::RelayHandshakeAck as u8 => { + if let Some((_, sender)) = self.pending_handshakes.remove(&src_peer_id) { + let _ = sender.send(packet); + } + Ok(()) + } + _ => Ok(()), + } + } + + async fn handle_relay_msg1(&self, msg1: ZCPacket, remote_peer_id: PeerId) -> Result<(), Error> { + let header = msg1 + .peer_manager_header() + .ok_or_else(|| Error::RouteError(Some("packet without header".to_string())))?; + let ack_policy = if header.is_latency_first() || header.forward_counter > 0 { + // Older peers do not mark latency-first handshakes. A forwarded + // request must still avoid the stale direct-peer shortcut. + NextHopPolicy::LeastCost + } else { + NextHopPolicy::LeastHop + }; + + // Check for bidirectional handshake race condition. + // If we are also waiting for a RelayHandshakeAck from this peer, + // use deterministic rule: the peer with smaller peer_id becomes initiator. + if self.pending_handshakes.contains_key(&remote_peer_id) { + // We have a pending handshake as initiator. + // If remote_peer_id < my_peer_id, remote should be initiator, we should be responder. + // Cancel our pending handshake and proceed as responder. + if remote_peer_id < self.my_peer_id { + tracing::debug!( + ?remote_peer_id, + my_peer_id = ?self.my_peer_id, + "bidirectional handshake race: yielding initiator role to smaller peer_id" + ); + // Remove our pending handshake + self.pending_handshakes.remove(&remote_peer_id); + } else { + // We have smaller peer_id, we should remain initiator. + // Ignore this RelayHandshake and let our initiator flow complete. + tracing::debug!( + ?remote_peer_id, + my_peer_id = ?self.my_peer_id, + "bidirectional handshake race: keeping initiator role due to smaller peer_id" + ); + return Err(Error::RouteError(Some( + "bidirectional handshake race: we are initiator".to_string(), + ))); + } + } + + let (local_private_key, _local_public_key) = self.get_local_keypair()?; + let params: NoiseParams = "Noise_IK_25519_ChaChaPoly_SHA256" + .parse() + .map_err(|e| Error::RouteError(Some(format!("parse noise params failed: {e:?}"))))?; + let builder = snow::Builder::new(params); + let mut hs = builder + .prologue(RELAY_NOISE_PROLOGUE) + .map_err(|e| Error::RouteError(Some(format!("set prologue failed: {e:?}"))))? + .local_private_key(&local_private_key) + .map_err(|e| Error::RouteError(Some(format!("set local key failed: {e:?}"))))? + .build_responder() + .map_err(|e| Error::RouteError(Some(format!("build responder failed: {e:?}"))))?; + + let msg1_pb = self.decode_handshake_message::( + PacketType::RelayHandshake, + &mut hs, + msg1, + )?; + let remote_static = hs + .get_remote_static() + .map(|x: &[u8]| x.to_vec()) + .unwrap_or_default(); + let remote_static_key = if remote_static.len() == 32 { + let mut key = [0u8; 32]; + key.copy_from_slice(&remote_static); + Some(key) + } else { + None + }; + + // Verify initiator's static public key matches the expected key from route info + let expected_pubkey = self.get_remote_static_pubkey(remote_peer_id).await?; + if remote_static != expected_pubkey { + return Err(Error::RouteError(Some(format!( + "responder: initiator static pubkey mismatch for peer {}, expected {} bytes, got {} bytes", + remote_peer_id, + expected_pubkey.len(), + remote_static.len() + )))); + } + + let server_network_name = self.context.network_name(); + let algo = self.context.flags().encryption_algorithm; + let key = SessionKey::new(server_network_name.clone(), remote_peer_id); + let upsert = self + .peer_session_store + .upsert_responder_session( + &key, + msg1_pb.a_session_generation, + algo.clone(), + msg1_pb.client_encryption_algorithm.clone(), + remote_static_key, + ) + .map_err(|e| Error::RouteError(Some(format!("{e:?}"))))?; + let msg2_pb = RelayNoiseMsg2Pb { + action: match upsert.action { + PeerSessionAction::Join => PeerConnSessionActionPb::Join as i32, + PeerSessionAction::Sync => PeerConnSessionActionPb::Sync as i32, + PeerSessionAction::Create => PeerConnSessionActionPb::Create as i32, + }, + b_session_generation: upsert.session_generation, + root_key_32: upsert.root_key.map(|k| k.to_vec()), + initial_epoch: upsert.initial_epoch, + b_conn_id: Some(uuid::Uuid::new_v4().into()), + a_conn_id_echo: msg1_pb.a_conn_id, + server_encryption_algorithm: algo, + }; + let payload = msg2_pb.encode_to_vec(); + let mut out = vec![0u8; 4096]; + let out_len = hs + .write_message(&payload, &mut out) + .map_err(|e| Error::RouteError(Some(format!("noise write msg2 failed: {e:?}"))))?; + + self.register_handshake_success(remote_peer_id); + + self.send_handshake_packet( + out[..out_len].to_vec(), + PacketType::RelayHandshakeAck, + remote_peer_id, + ack_policy, + ) + .await?; + + // Flush any packets buffered while waiting for the handshake to complete + self.flush_pending_packets(remote_peer_id, upsert.session) + .await; + + Ok(()) + } + + pub async fn decrypt_if_needed(self: &Arc, packet: &mut ZCPacket) -> Result { + if !self.is_secure_mode_enabled() { + return Ok(false); + } + let hdr = packet + .peer_manager_header() + .ok_or_else(|| Error::RouteError(Some("packet without header".to_string())))?; + let from_peer_id = hdr.from_peer_id.get(); + let handshake_policy = if hdr.is_latency_first() || hdr.forward_counter > 0 { + NextHopPolicy::LeastCost + } else { + NextHopPolicy::LeastHop + }; + let network = self.context.network_identity(); + let key = SessionKey::new(network.network_name.clone(), from_peer_id); + let Some(session) = self.peer_session_store.get(&key) else { + tracing::debug!( + "relay session not found for peer {}, try handshake", + from_peer_id + ); + self.ensure_session(from_peer_id, handshake_policy).await?; + return Ok(false); + }; + let now = Instant::now(); + let mut entry = self.states.entry(from_peer_id).or_default(); + entry.last_active_at = now; + session.decrypt_payload(from_peer_id, self.my_peer_id, packet)?; + Ok(true) + } + + pub fn evict_idle_sessions(&self, idle: Duration) { + let now = Instant::now(); + let mut to_remove = Vec::new(); + for entry in self.states.iter() { + if now.duration_since(entry.last_active_at) > idle { + to_remove.push(*entry.key()); + } + } + for peer_id in to_remove { + self.states.remove(&peer_id); + self.pending_handshakes.remove(&peer_id); + self.handshake_locks.remove(&peer_id); + self.pending_packets.remove(&peer_id); + } + shrink_dashmap(&self.states, None); + shrink_dashmap(&self.pending_handshakes, None); + shrink_dashmap(&self.handshake_locks, None); + shrink_dashmap(&self.pending_packets, None); + } + + pub fn has_state(&self, peer_id: PeerId) -> bool { + self.states.contains_key(&peer_id) + } + + /// Remove relay-specific state for a specific peer. + /// This does NOT remove the session from PeerSessionStore, because the + /// session lifecycle is independent of any particular connection type + /// (relay or direct). The session may still be used by direct connections + /// or for fast reconnection (Join instead of Create). + pub fn remove_peer(&self, peer_id: PeerId) { + self.states.remove(&peer_id); + self.pending_handshakes.remove(&peer_id); + self.handshake_locks.remove(&peer_id); + self.pending_packets.remove(&peer_id); + shrink_dashmap(&self.states, None); + shrink_dashmap(&self.pending_handshakes, None); + shrink_dashmap(&self.handshake_locks, None); + shrink_dashmap(&self.pending_packets, None); + + tracing::debug!(?peer_id, "RelayPeerMap removed peer relay state"); + } +} + +#[cfg(test)] +mod tests { + use std::sync::{Mutex as StdMutex, Weak}; + + use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; + use x25519_dalek::{PublicKey, StaticSecret}; + + use super::*; + use crate::{ + peers::context::{ArcPeerContext, NetworkIdentity, PeerContext}, + proto::common::{FlagsInConfig, SecureModeConfig}, + }; + + struct RelayTestContext { + network_identity: NetworkIdentity, + secure_mode: SecureModeConfig, + flags: FlagsInConfig, + } + + impl PeerContext for RelayTestContext { + fn network_identity(&self) -> NetworkIdentity { + self.network_identity.clone() + } + + fn secure_mode(&self) -> Option { + Some(self.secure_mode.clone()) + } + + fn flags(&self) -> FlagsInConfig { + self.flags.clone() + } + } + + struct TestRelayTransport { + remote: StdMutex>>, + remote_pubkey: Vec, + ack_policies: StdMutex>, + } + + impl TestRelayTransport { + fn new(remote_pubkey: Vec) -> Self { + Self { + remote: StdMutex::new(None), + remote_pubkey, + ack_policies: StdMutex::new(Vec::new()), + } + } + + fn set_remote(&self, remote: &Arc) { + *self.remote.lock().unwrap() = Some(Arc::downgrade(remote)); + } + } + + #[async_trait::async_trait] + impl RelayRouteTransport for TestRelayTransport { + async fn get_route_peer_info(&self, peer_id: PeerId) -> Option { + Some(RoutePeerInfo { + peer_id, + noise_static_pubkey: self.remote_pubkey.clone(), + ..Default::default() + }) + } + + async fn send_msg_to_next_hop( + &self, + msg: ZCPacket, + _dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result<(), Error> { + let packet_type = msg.peer_manager_header().unwrap().packet_type; + if packet_type == PacketType::RelayHandshakeAck as u8 { + self.ack_policies.lock().unwrap().push(policy.clone()); + if matches!(policy, NextHopPolicy::LeastHop) { + return Ok(()); + } + } + + let remote = self + .remote + .lock() + .unwrap() + .as_ref() + .and_then(Weak::upgrade) + .ok_or_else(|| Error::RouteError(Some("test relay is unavailable".to_owned())))?; + remote.handle_handshake_packet(msg).await + } + } + + fn relay_test_context(seed: u8) -> (ArcPeerContext, Vec) { + let private = StaticSecret::from([seed; 32]); + let public = PublicKey::from(&private); + let context = RelayTestContext { + network_identity: NetworkIdentity { + network_name: "test".to_owned(), + network_secret: Some("secret".to_owned()), + network_secret_digest: None, + }, + secure_mode: SecureModeConfig { + enabled: true, + local_private_key: Some(BASE64_STANDARD.encode(private.as_bytes())), + local_public_key: Some(BASE64_STANDARD.encode(public.as_bytes())), + }, + flags: FlagsInConfig { + encryption_algorithm: "aes-gcm".to_owned(), + ..Default::default() + }, + }; + (Arc::new(context), public.as_bytes().to_vec()) + } + + #[derive(Default)] + struct ForwardedPacketTransport { + packets: StdMutex>, + } + + #[async_trait::async_trait] + impl RelayRouteTransport for ForwardedPacketTransport { + async fn get_route_peer_info(&self, _peer_id: PeerId) -> Option { + None + } + + async fn send_msg_to_next_hop( + &self, + msg: ZCPacket, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Result<(), Error> { + self.packets + .lock() + .unwrap() + .push((msg, dst_peer_id, policy)); + Ok(()) + } + } + + #[tokio::test] + async fn secure_relay_forwards_remote_packets_without_changing_payload() { + let (context, _) = relay_test_context(2); + let transport = Arc::new(ForwardedPacketTransport::default()); + let relay = RelayPeerMap::new( + transport.clone(), + context, + 2, + Arc::new(PeerSessionStore::new()), + ); + + for packet_type in [ + PacketType::RelayHandshake, + PacketType::RelayHandshakeAck, + PacketType::Data, + ] { + let mut packet = ZCPacket::new_with_payload(b"end-to-end payload"); + packet.fill_peer_manager_hdr(1, 3, packet_type as u8); + if matches!(packet_type, PacketType::Data) { + packet + .mut_peer_manager_header() + .unwrap() + .set_encrypted(true); + } + let expected = packet.clone(); + relay + .send_msg(packet, 3, NextHopPolicy::LeastCost) + .await + .unwrap(); + + let mut packets = transport.packets.lock().unwrap(); + assert_eq!( + packets.len(), + 1, + "forwarded packet was held for a local handshake" + ); + let (forwarded, destination, policy) = packets.pop().unwrap(); + assert_eq!(forwarded.into_bytes(), expected.into_bytes()); + assert_eq!(destination, 3); + assert!(matches!(policy, NextHopPolicy::LeastCost)); + } + } + + #[tokio::test] + async fn latency_first_handshake_returns_ack_over_least_cost_route() { + let (context_a, pubkey_a) = relay_test_context(1); + let (context_b, pubkey_b) = relay_test_context(2); + let transport_a = Arc::new(TestRelayTransport::new(pubkey_b)); + let transport_b = Arc::new(TestRelayTransport::new(pubkey_a)); + let relay_a = RelayPeerMap::new( + transport_a.clone(), + context_a, + 1, + Arc::new(PeerSessionStore::new()), + ); + let relay_b = RelayPeerMap::new( + transport_b.clone(), + context_b, + 2, + Arc::new(PeerSessionStore::new()), + ); + transport_a.set_remote(&relay_b); + transport_b.set_remote(&relay_a); + + tokio::time::timeout( + std::time::Duration::from_secs(1), + relay_a.handshake_session(2, NextHopPolicy::LeastCost, None), + ) + .await + .expect("relay handshake ack used the blackholed least-hop route") + .unwrap(); + + assert!(relay_a.has_session_without_touch(2)); + assert!(relay_b.has_session_without_touch(1)); + assert!( + transport_b + .ack_policies + .lock() + .unwrap() + .iter() + .all(|policy| matches!(policy, NextHopPolicy::LeastCost)) + ); + } +} + +#[cfg(any(test, feature = "test-utils"))] +mod test_utils { + use super::*; + + impl RelayPeerMap { + #[doc(hidden)] + pub(crate) fn has_session_without_touch(&self, dst_peer_id: PeerId) -> bool { + self.peer_session_store.contains_valid(&SessionKey::new( + self.context.network_identity().network_name, + dst_peer_id, + )) + } + } +} diff --git a/vendor/easytier/easytier-core/src/peers/route/graph_algo.rs b/vendor/easytier/easytier-core/src/peers/route/graph_algo.rs new file mode 100644 index 0000000..333bcf5 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/route/graph_algo.rs @@ -0,0 +1,176 @@ +use core::cmp::Ordering; +use petgraph::{ + algo::Measure, + visit::{EdgeRef, IntoEdges, VisitMap, Visitable}, +}; +use std::collections::HashMap; +use std::collections::hash_map::Entry::{Occupied, Vacant}; +use std::{collections::BinaryHeap, hash::Hash}; + +/// `MinScored` holds a score `K` and a scored object `T` in +/// a pair for use with a `BinaryHeap`. +/// +/// `MinScored` compares in reverse order by the score, so that we can +/// use `BinaryHeap` as a min-heap to extract the score-value pair with the +/// least score. +/// +/// **Note:** `MinScored` implements a total order (`Ord`), so that it is +/// possible to use float types as scores. +#[derive(Copy, Clone, Debug)] +pub struct MinScored(pub K, pub T); + +impl PartialEq for MinScored { + #[inline] + fn eq(&self, other: &MinScored) -> bool { + self.cmp(other) == Ordering::Equal + } +} + +impl Eq for MinScored {} + +impl PartialOrd for MinScored { + #[inline] + fn partial_cmp(&self, other: &MinScored) -> Option { + Some(self.cmp(other)) + } +} + +impl Ord for MinScored { + #[inline] + fn cmp(&self, other: &MinScored) -> Ordering { + let a = &self.0; + let b = &other.0; + if a == b { + Ordering::Equal + } else if a < b { + Ordering::Greater + } else if a > b { + Ordering::Less + } else if a.ne(a) && b.ne(b) { + // these are the NaN cases + Ordering::Equal + } else if a.ne(a) { + // Order NaN less, so that it is last in the MinScore order + Ordering::Less + } else { + Ordering::Greater + } + } +} + +pub type DijkstraResult = (HashMap, HashMap); + +pub fn dijkstra_with_first_hop( + graph: G, + start: G::NodeId, + mut edge_cost: F, +) -> DijkstraResult +where + G: IntoEdges + Visitable, + G::NodeId: Eq + Hash + Clone, + F: FnMut(G::EdgeRef) -> K, + K: Measure + Copy, +{ + let mut visited = graph.visit_map(); + let mut scores = HashMap::new(); + let mut first_hop = HashMap::new(); + let mut visit_next = BinaryHeap::new(); + let zero_score = K::default(); + scores.insert(start, zero_score); + visit_next.push(MinScored(zero_score, start)); + first_hop.insert(start, (start, 0)); + + while let Some(MinScored(node_score, node)) = visit_next.pop() { + if visited.is_visited(&node) { + continue; + } + for edge in graph.edges(node) { + let next = edge.target(); + if visited.is_visited(&next) { + continue; + } + let next_score = node_score + edge_cost(edge); + match scores.entry(next) { + Occupied(mut ent) => { + if next_score < *ent.get() { + *ent.get_mut() = next_score; + visit_next.push(MinScored(next_score, next)); + // 继承前驱的 first_hop,或自己就是第一跳 + let hop = if node == start { + (next, 0) + } else { + first_hop[&node] + }; + first_hop.insert(next, (hop.0, hop.1 + 1)); + } + } + Vacant(ent) => { + ent.insert(next_score); + visit_next.push(MinScored(next_score, next)); + let hop = if node == start { + (next, 0) + } else { + first_hop[&node] + }; + first_hop.insert(next, (hop.0, hop.1 + 1)); + } + } + } + visited.visit(node); + } + + (scores, first_hop) +} + +#[cfg(test)] +mod tests { + use super::*; + use petgraph::graph::DiGraph; + + #[test] + fn test_dijkstra_with_first_hop_4node() { + let mut graph = DiGraph::<&str, u32>::new(); + let a = graph.add_node("a"); + let b = graph.add_node("b"); + let c = graph.add_node("c"); + let d = graph.add_node("d"); + + graph.extend_with_edges([(a, b, 1)]); + graph.extend_with_edges([(b, c, 1)]); + graph.extend_with_edges([(c, d, 2)]); + + let (scores, first_hop) = dijkstra_with_first_hop(&graph, a, |edge| *edge.weight()); + + assert_eq!(scores[&b], 1); + assert_eq!(scores[&c], 2); + assert_eq!(scores[&d], 4); + + assert_eq!(first_hop[&b], (b, 1)); + assert_eq!(first_hop[&c], (b, 2)); + assert_eq!(first_hop[&d], (b, 3)); + } + + #[test] + fn test_dijkstra_with_first_hop() { + let mut graph = DiGraph::<&str, u32>::new(); + let a = graph.add_node("a"); + let b = graph.add_node("b"); + let c = graph.add_node("c"); + let d = graph.add_node("d"); + let e = graph.add_node("e"); + + graph.extend_with_edges([(a, b, 1), (a, c, 2), (b, d, 1), (c, d, 3), (d, e, 1)]); + + let (scores, first_hop) = dijkstra_with_first_hop(&graph, a, |edge| *edge.weight()); + + assert_eq!(scores[&b], 1); + assert_eq!(scores[&c], 2); + assert_eq!(scores[&d], 2); + assert_eq!(scores[&e], 3); + + assert_eq!(first_hop[&b], (b, 1)); + assert_eq!(first_hop[&c], (c, 1)); + assert_eq!(first_hop[&d], (b, 2)); // d is reached via b + assert_eq!(first_hop[&e], (b, 3)); // e is reached via d + } +} diff --git a/vendor/easytier/easytier-core/src/peers/route/mod.rs b/vendor/easytier/easytier-core/src/peers/route/mod.rs new file mode 100644 index 0000000..e182195 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/route/mod.rs @@ -0,0 +1,238 @@ +//! Route trait surface shared by the peer domain, plus the OSPF route +//! implementation and the graph algorithms backing it. + +pub(crate) mod graph_algo; +pub(crate) mod peer_ospf_route; +mod route_peer_wire; + +use cidr::Ipv6Inet; +use cidr::{Ipv4Cidr, Ipv6Cidr}; +use dashmap::DashMap; +use quanta::Instant; +use std::{ + collections::BTreeSet, + net::{Ipv4Addr, Ipv6Addr}, + sync::Arc, +}; + +use crate::{ + config::PeerId, + peers::context::NetworkIdentity, + proto::{ + core_peer::peer::{ListPublicIpv6InfoResponse, Route as CoreRoute}, + peer_rpc::{ + ForeignNetworkRouteInfoEntry, ForeignNetworkRouteInfoKey, PeerIdentityType, + RouteForeignNetworkInfos, RouteForeignNetworkSummary, RoutePeerInfo, + }, + }, +}; + +#[derive(Clone, Debug, Default)] +pub enum NextHopPolicy { + #[default] + LeastHop, + LeastCost, +} + +pub type ForeignNetworkRouteInfoMap = + DashMap; + +#[async_trait::async_trait] +pub trait RouteInterface { + async fn list_peers(&self) -> Vec; + fn my_peer_id(&self) -> PeerId; + fn need_periodic_requery_peers(&self) -> bool { + false + } + async fn close_peer(&self, _peer_id: PeerId) {} + async fn get_peer_public_key(&self, _peer_id: PeerId) -> Option> { + None + } + async fn get_peer_identity_type(&self, _peer_id: PeerId) -> Option { + None + } + async fn list_foreign_networks(&self) -> ForeignNetworkRouteInfoMap { + DashMap::new() + } +} + +pub type RouteInterfaceBox = Box; + +#[auto_impl::auto_impl(Box , &mut)] +pub trait RouteCostCalculatorInterface: Send + Sync { + fn begin_update(&mut self) {} + fn end_update(&mut self) {} + + fn calculate_cost(&self, _src: PeerId, _dst: PeerId) -> i32 { + 1 + } + + fn need_update(&self) -> bool { + false + } + + fn dump(&self) -> String { + "All routes have cost 1".to_string() + } +} + +#[derive(Clone, Debug, Default)] +pub struct DefaultRouteCostCalculator; + +impl RouteCostCalculatorInterface for DefaultRouteCostCalculator {} + +pub type RouteCostCalculator = Box; + +#[async_trait::async_trait] +#[auto_impl::auto_impl(Box, Arc)] +pub trait Route { + async fn open(&self, interface: RouteInterfaceBox) -> Result; + async fn close(&self); + + async fn get_next_hop(&self, peer_id: PeerId) -> Option; + async fn get_next_hop_with_policy( + &self, + peer_id: PeerId, + _policy: NextHopPolicy, + ) -> Option { + self.get_next_hop(peer_id).await + } + + async fn list_routes(&self) -> Vec; + + // TODO: rewrite route management, remove this + async fn list_proxy_cidrs(&self) -> BTreeSet; + + // TODO: rewrite route management, remove this + async fn list_proxy_cidrs_v6(&self) -> BTreeSet; + + async fn list_public_ipv6_routes(&self) -> BTreeSet { + BTreeSet::new() + } + + async fn get_my_public_ipv6_addr(&self) -> Option { + None + } + + async fn get_public_ipv6_gateway_peer_id(&self) -> Option { + None + } + + async fn get_local_public_ipv6_info(&self) -> ListPublicIpv6InfoResponse { + ListPublicIpv6InfoResponse::default() + } + + async fn get_peer_id_by_ipv4(&self, _ipv4: &Ipv4Addr) -> Option { + None + } + + async fn get_peer_id_by_ipv6(&self, _ipv6: &Ipv6Addr) -> Option { + None + } + + async fn get_peer_id_by_ip(&self, ip: &std::net::IpAddr) -> Option { + match ip { + std::net::IpAddr::V4(v4) => self.get_peer_id_by_ipv4(v4).await, + std::net::IpAddr::V6(v6) => self.get_peer_id_by_ipv6(v6).await, + } + } + + async fn list_peers_own_foreign_network( + &self, + _network_identity: &NetworkIdentity, + ) -> Vec { + vec![] + } + + async fn list_foreign_network_info(&self) -> RouteForeignNetworkInfos { + Default::default() + } + + async fn get_foreign_network_summary(&self) -> RouteForeignNetworkSummary { + Default::default() + } + + // my peer id in foreign network is different from the one in local network + // this function is used to get the peer id in local network + async fn get_origin_my_peer_id( + &self, + _network_name: &str, + _foreign_my_peer_id: PeerId, + ) -> Option { + None + } + + async fn set_route_cost_fn(&self, _cost_fn: RouteCostCalculator) {} + + async fn get_peer_info(&self, peer_id: PeerId) -> Option; + + async fn get_peer_info_last_update_time(&self) -> Instant; + + fn get_peer_groups(&self, peer_id: PeerId) -> Arc>; + + async fn refresh_acl_groups(&self) {} + + async fn get_peer_groups_by_ip(&self, ip: &std::net::IpAddr) -> Arc> { + match self.get_peer_id_by_ip(ip).await { + Some(peer_id) => self.get_peer_groups(peer_id), + None => Arc::new(Vec::new()), + } + } + + async fn dump(&self) -> String { + "this route implementation does not support dump".to_string() + } +} + +pub type ArcRoute = Arc; + +pub(crate) struct DisabledRoute; + +#[async_trait::async_trait] +impl Route for DisabledRoute { + async fn open(&self, _interface: RouteInterfaceBox) -> Result { + panic!("mock route") + } + + async fn close(&self) { + panic!("mock route") + } + + async fn get_next_hop(&self, _peer_id: PeerId) -> Option { + panic!("mock route") + } + + async fn list_routes(&self) -> Vec { + panic!("mock route") + } + + // TODO: rewrite route management, remove this + async fn list_proxy_cidrs(&self) -> BTreeSet { + unimplemented!() + } + + // TODO: rewrite route management, remove this + async fn list_proxy_cidrs_v6(&self) -> BTreeSet { + unimplemented!() + } + + async fn list_public_ipv6_routes(&self) -> BTreeSet { + unimplemented!() + } + + async fn get_my_public_ipv6_addr(&self) -> Option { + panic!("mock route") + } + + async fn get_peer_info(&self, _peer_id: PeerId) -> Option { + panic!("mock route") + } + + async fn get_peer_info_last_update_time(&self) -> Instant { + panic!("mock route") + } + + fn get_peer_groups(&self, _peer_id: PeerId) -> Arc> { + panic!("mock route") + } +} diff --git a/vendor/easytier/easytier-core/src/peers/route/peer_ospf_route.rs b/vendor/easytier/easytier-core/src/peers/route/peer_ospf_route.rs new file mode 100644 index 0000000..9973c65 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/route/peer_ospf_route.rs @@ -0,0 +1,6523 @@ +use std::{ + collections::{BTreeMap, BTreeSet, HashMap, HashSet}, + fmt::Debug, + net::{IpAddr, Ipv4Addr, Ipv6Addr}, + sync::{ + Arc, Weak, + atomic::{AtomicBool, AtomicU32, Ordering}, + }, + time::{Duration, SystemTime}, +}; + +use arc_swap::ArcSwap; +use atomic_shim::AtomicU64; +use cidr::{IpCidr, Ipv4Cidr, Ipv6Cidr, Ipv6Inet}; +use crossbeam_utils::atomic::AtomicCell; +use dashmap::DashMap; +use ordered_hash_map::OrderedHashMap; +use parking_lot::{RwLock, lock_api::RwLockUpgradableReadGuard}; +use petgraph::{ + Directed, + algo::dijkstra, + graph::{Graph, NodeIndex}, + visit::{EdgeRef, IntoNodeReferences}, +}; +use prefix_trie::PrefixMap; +use prost::Message; +use quanta::Instant; +use tokio::{ + select, + sync::{Mutex, RwLock as AsyncRwLock}, + task::{JoinHandle, JoinSet}, +}; + +use crate::{ + config::PeerId, + config::peers::PeerGroupIdentity, + peers::{ + PeerPacketFilter, + context::{ + ArcPeerContext, NetworkIdentity as CoreNetworkIdentity, PeerContext, PeerContextEvent, + TrustedKeyMetadata, TrustedKeySource, + }, + peer_rpc::PeerRpcManager, + public_ipv6::{ + PublicIpv6PeerRouteInfo, PublicIpv6RouteControl, PublicIpv6Runtime, PublicIpv6Service, + PublicIpv6SyncTrigger, + }, + util::shrink_dashmap, + }, + proto::{ + common::{NatType, RuntimeTimestamp as Timestamp, TimestampExt}, + core_peer::peer::{ + ListPublicIpv6InfoResponse as CoreListPublicIpv6InfoResponse, + PublicIpv6LeaseInfo as CorePublicIpv6LeaseInfo, Route as CoreRouteInfo, + }, + peer_rpc::{ + ForeignNetworkRouteInfoEntry, ForeignNetworkRouteInfoKey, OspfRouteRpc, + OspfRouteRpcClientFactory, OspfRouteRpcServer, PeerGroupInfo, PeerIdVersion, + PeerIdentityType, PublicIpv6AddrRpcServer, RouteForeignNetworkInfos, + RouteForeignNetworkSummary, RoutePeerInfo, RoutePeerInfos, SyncRouteInfoError, + SyncRouteInfoRequest, SyncRouteInfoResponse, TrustedCredentialPubkey, + TrustedCredentialPubkeyProof, route_foreign_network_infos, + route_foreign_network_summary, sync_route_info_request::ConnInfo, + }, + rpc_types::{ + self, + controller::{BaseController, Controller}, + }, + }, +}; + +use super::{ + DefaultRouteCostCalculator, ForeignNetworkRouteInfoMap, NextHopPolicy, Route, + RouteCostCalculator, RouteCostCalculatorInterface, RouteInterfaceBox, + graph_algo::dijkstra_with_first_hop, + route_peer_wire::{ + self, RawRoutePeerInfo, extract_route_peer_infos, patch_credential_route_peer_info, + raw_credential_bytes, raw_route_peer_info, + }, +}; + +pub type Version = u32; + +// the cost (latency between two peers) is i32, i32::MAX is large enough. +const AVOID_RELAY_COST: usize = i32::MAX as usize; + +/// Check if `child` CIDR is a subset of `parent` CIDR. +/// Returns true if `child` is contained within `parent`, or if they are equal. +pub fn cidr_is_subset(child: &IpCidr, parent: &IpCidr) -> bool { + match (child, parent) { + (IpCidr::V4(c), IpCidr::V4(p)) => { + p.first_address() <= c.first_address() && c.last_address() <= p.last_address() + } + (IpCidr::V6(c), IpCidr::V6(p)) => { + p.first_address() <= c.first_address() && c.last_address() <= p.last_address() + } + _ => false, // mixed v4/v6 + } +} + +/// Check if `child` CIDR is a subset of `parent` CIDR (both as string representations). +pub fn cidr_is_subset_str(child: &str, parent: &str) -> bool { + let Ok(child_cidr) = child.parse::() else { + return false; + }; + let Ok(parent_cidr) = parent.parse::() else { + return false; + }; + cidr_is_subset(&child_cidr, &parent_cidr) +} + +#[derive(Debug, Clone)] +pub struct AtomicVersion(Arc); + +impl AtomicVersion { + pub fn new() -> Self { + AtomicVersion(Arc::new(AtomicU32::new(0))) + } + + pub fn get(&self) -> Version { + self.0.load(Ordering::Relaxed) + } + + pub fn inc(&self) -> Version { + self.0.fetch_add(1, Ordering::Relaxed) + 1 + } + + pub fn set_if_larger(&self, version: Version) -> bool { + // return true if the version is set. + self.0.fetch_max(version, Ordering::Relaxed) < version + } +} + +impl From for AtomicVersion { + fn from(version: Version) -> Self { + AtomicVersion(Arc::new(AtomicU32::new(version))) + } +} + +#[derive(Debug, Clone)] +pub struct OspfPeerInfo { + pub peer_id: PeerId, + pub info: RoutePeerInfo, +} + +#[derive(Debug, Clone)] +pub struct OspfPeerConnInfo { + pub peer_id: PeerId, + pub connected_peers: BTreeSet, +} + +#[derive(Debug, Clone)] +pub struct OspfRouteSnapshot { + pub peer_infos: Vec, + pub conn_map: Vec, + pub suppressed_peer_ids: BTreeSet, + pub version: Version, +} + +impl OspfRouteSnapshot { + fn lookup(&self) -> OspfRouteSnapshotLookup<'_> { + OspfRouteSnapshotLookup { + peer_infos: self + .peer_infos + .iter() + .map(|entry| (entry.peer_id, &entry.info)) + .collect(), + conn_map: self + .conn_map + .iter() + .map(|entry| (entry.peer_id, entry)) + .collect(), + } + } +} + +struct OspfRouteSnapshotLookup<'a> { + peer_infos: HashMap, + conn_map: HashMap, +} + +impl OspfRouteSnapshotLookup<'_> { + fn peer_info(&self, peer_id: PeerId) -> Option<&RoutePeerInfo> { + self.peer_infos.get(&peer_id).copied() + } + + fn connected_peers>(&self, peer_id: PeerId) -> Option { + self.conn_map + .get(&peer_id) + .map(|entry| entry.connected_peers.iter().copied().collect()) + } + + fn get_avoid_relay_data(&self, peer_id: PeerId) -> bool { + // if avoid relay, just set all outgoing edges to a large value: AVOID_RELAY_COST. + self.peer_info(peer_id) + .and_then(|x| x.feature_flag) + .map(|x| x.avoid_relay_data) + .unwrap_or_default() + } +} + +type PeerGraph = Graph; +type PeerIdToNodeIdxMap = DashMap; + +#[derive(Debug, Clone, Copy)] +pub struct OspfNextHopInfo { + pub next_hop_peer_id: PeerId, + pub path_latency: i32, + pub path_len: usize, // path includes src and dst. + pub version: Version, +} + +type NextHopMap = DashMap; + +// computed with SyncedRouteInfo snapshot. used to get next hop. +#[derive(Debug)] +pub struct OspfRouteTable { + peer_infos: DashMap, + next_hop_map: NextHopMap, + suppressed_peer_ids: DashMap, + ipv4_peer_id_map: DashMap, + ipv6_peer_id_map: DashMap, + cidr_peer_id_map: ArcSwap>, + cidr_v6_peer_id_map: ArcSwap>, + next_hop_map_version: AtomicVersion, +} + +impl OspfRouteTable { + pub fn new() -> Self { + OspfRouteTable { + peer_infos: DashMap::new(), + next_hop_map: DashMap::new(), + suppressed_peer_ids: DashMap::new(), + ipv4_peer_id_map: DashMap::new(), + ipv6_peer_id_map: DashMap::new(), + cidr_peer_id_map: ArcSwap::new(Arc::new(PrefixMap::new())), + cidr_v6_peer_id_map: ArcSwap::new(Arc::new(PrefixMap::new())), + next_hop_map_version: AtomicVersion::new(), + } + } + + pub fn get_next_hop(&self, dst_peer_id: PeerId) -> Option { + if self.suppressed_peer_ids.contains_key(&dst_peer_id) { + return None; + } + self.get_topology_next_hop(dst_peer_id) + } + + pub fn get_topology_next_hop(&self, dst_peer_id: PeerId) -> Option { + let cur_version = self.next_hop_map_version.get(); + self.next_hop_map.get(&dst_peer_id).and_then(|x| { + if x.version >= cur_version { + Some(*x) + } else { + None + } + }) + } + + pub fn peer_reachable(&self, peer_id: PeerId) -> bool { + self.get_next_hop(peer_id).is_some() + } + + pub fn topology_peer_reachable(&self, peer_id: PeerId) -> bool { + self.get_topology_next_hop(peer_id).is_some() + } + + pub fn get_udp_nat_type(&self, peer_id: PeerId) -> Option { + self.peer_infos + .get(&peer_id) + .map(|x| NatType::try_from(x.udp_nat_type).unwrap_or_default()) + } + + pub fn get_peer_info(&self, peer_id: PeerId) -> Option { + self.peer_infos.get(&peer_id).map(|x| x.clone()) + } + + pub fn get_peer_id_by_ipv4(&self, ipv4_addr: &Ipv4Addr) -> Option { + self.ipv4_peer_id_map.get(ipv4_addr).map(|p| p.peer_id) + } + + pub fn get_peer_id_by_ipv6(&self, ipv6_addr: &Ipv6Addr) -> Option { + self.ipv6_peer_id_map.get(ipv6_addr).map(|p| p.peer_id) + } + + fn sync_suppressed_peer_ids(&self, snapshot: &OspfRouteSnapshot) { + self.suppressed_peer_ids + .retain(|peer_id, _| snapshot.suppressed_peer_ids.contains(peer_id)); + for peer_id in &snapshot.suppressed_peer_ids { + self.suppressed_peer_ids.insert(*peer_id, ()); + } + } + + // return graph and start node index (node of my peer id). + fn build_peer_graph_from_snapshot( + my_peer_id: PeerId, + snapshot: &OspfRouteSnapshot, + lookup: &OspfRouteSnapshotLookup<'_>, + cost_calc: &T, + ) -> (PeerGraph, NodeIndex) { + let mut graph: PeerGraph = PeerGraph::new(); + + let mut start_node_idx = None; + let peer_id_to_node_index: PeerIdToNodeIdxMap = DashMap::new(); + for entry in &snapshot.peer_infos { + let peer_id = entry.peer_id; + + if entry.info.version == 0 { + continue; + } + + let node_idx = graph.add_node(peer_id); + + peer_id_to_node_index.insert(peer_id, node_idx); + if peer_id == my_peer_id { + start_node_idx = Some(node_idx); + } + } + + if start_node_idx.is_none() { + return (graph, NodeIndex::end()); + } + + for item in peer_id_to_node_index.iter() { + let src_peer_id = *item.key(); + if src_peer_id != my_peer_id && snapshot.suppressed_peer_ids.contains(&src_peer_id) { + continue; + } + let src_node_idx = item.value(); + let connected_peers: BTreeSet<_> = + lookup.connected_peers(src_peer_id).unwrap_or_default(); + + // if avoid relay, just set all outgoing edges to a large value: AVOID_RELAY_COST. + let peer_avoid_relay_data = lookup.get_avoid_relay_data(src_peer_id); + + for dst_peer_id in connected_peers.iter() { + let Some(dst_node_idx) = peer_id_to_node_index.get(dst_peer_id) else { + continue; + }; + + let mut cost = cost_calc.calculate_cost(src_peer_id, *dst_peer_id) as usize; + if peer_avoid_relay_data { + cost += AVOID_RELAY_COST; + } + + graph.add_edge(*src_node_idx, *dst_node_idx, cost); + } + } + + (graph, start_node_idx.unwrap()) + } + + pub fn clean_expired_route_info(&self) { + let cur_version = self.next_hop_map_version.get(); + self.next_hop_map.retain(|_, v| { + // remove next hop map for peers we cannot reach. + v.version >= cur_version + }); + self.peer_infos.retain(|k, _| { + // remove peer info for peers we cannot forward to. + self.peer_reachable(*k) + }); + self.ipv4_peer_id_map.retain(|_, v| { + // remove ipv4 map for peers we cannot forward to. + self.peer_reachable(v.peer_id) + }); + self.ipv6_peer_id_map.retain(|_, v| { + // remove ipv6 map for peers we cannot forward to. + self.peer_reachable(v.peer_id) + }); + + shrink_dashmap(&self.peer_infos, None); + shrink_dashmap(&self.next_hop_map, None); + shrink_dashmap(&self.suppressed_peer_ids, None); + shrink_dashmap(&self.ipv4_peer_id_map, None); + shrink_dashmap(&self.ipv6_peer_id_map, None); + } + + fn gen_next_hop_map_with_least_hop( + &self, + graph: &PeerGraph, + start_node: &NodeIndex, + version: Version, + ) { + if graph.node_weight(*start_node).is_none() { + tracing::warn!( + ?start_node, + version, + "invalid start node for least-hop route rebuild" + ); + return; + } + let normalize_edge_cost = |e: petgraph::graph::EdgeReference| { + if *e.weight() >= AVOID_RELAY_COST { + AVOID_RELAY_COST + 1 + } else { + 1 + } + }; + // Step 1: first Dijkstra, compute shortest hop count. + let path_len_map = dijkstra(graph, *start_node, None, normalize_edge_cost); + + // Step 2: build subgraph containing only shortest-hop and AVOID RELAY edges. + let mut subgraph: PeerGraph = PeerGraph::new(); + let mut start_node_idx = None; + for (node_idx, peer_id) in graph.node_references() { + let new_node_idx = subgraph.add_node(*peer_id); + if node_idx == *start_node { + start_node_idx = Some(new_node_idx); + } + } + + for edge in graph.edge_references() { + let (src, tgt) = graph.edge_endpoints(edge.id()).unwrap(); + let Some(src_path_len) = path_len_map.get(&src) else { + continue; + }; + let Some(tgt_path_len) = path_len_map.get(&tgt) else { + continue; + }; + if *src_path_len + normalize_edge_cost(edge) == *tgt_path_len { + subgraph.add_edge(src, tgt, *edge.weight()); + } + } + + // Step 3: second Dijkstra on subgraph, choose least-cost among shortest-hop paths. + self.gen_next_hop_map_with_least_cost(&subgraph, &start_node_idx.unwrap(), version); + } + + fn gen_next_hop_map_with_least_cost( + &self, + graph: &PeerGraph, + start_node: &NodeIndex, + version: Version, + ) { + if graph.node_weight(*start_node).is_none() { + tracing::warn!( + ?start_node, + version, + "invalid start node for least-cost route rebuild" + ); + return; + } + let (costs, next_hops) = dijkstra_with_first_hop(graph, *start_node, |e| *e.weight()); + + for (dst, (next_hop, path_len)) in next_hops.iter() { + let info = OspfNextHopInfo { + next_hop_peer_id: *graph.node_weight(*next_hop).unwrap(), + path_latency: (*costs.get(dst).unwrap() % AVOID_RELAY_COST) as i32, + path_len: *path_len, + version, + }; + let dst_peer_id = *graph.node_weight(*dst).unwrap(); + self.next_hop_map + .entry(dst_peer_id) + .and_modify(|x| { + if x.version < version { + *x = info; + } + }) + .or_insert(info); + } + + self.next_hop_map_version.set_if_larger(version); + } + + pub fn build_from_snapshot( + &self, + my_peer_id: PeerId, + snapshot: &OspfRouteSnapshot, + policy: NextHopPolicy, + cost_calc: &T, + ) { + let version = snapshot.version; + self.sync_suppressed_peer_ids(snapshot); + let lookup = snapshot.lookup(); + + let local_proxy_cidrs = lookup + .peer_info(my_peer_id) + .into_iter() + .flat_map(|info| &info.proxy_cidrs) + .filter_map(|cidr| cidr.parse::().ok()) + .collect::>(); + + // build next hop map + let (graph, start_node) = + Self::build_peer_graph_from_snapshot(my_peer_id, snapshot, &lookup, cost_calc); + + if graph.node_count() == 0 { + tracing::warn!("no peer in graph, cannot build next hop map"); + self.next_hop_map_version.set_if_larger(version); + self.clean_expired_route_info(); + return; + } + if start_node == NodeIndex::end() { + tracing::warn!( + ?my_peer_id, + version, + "my peer id is missing in graph, skip next-hop rebuild this round" + ); + self.next_hop_map_version.set_if_larger(version); + self.clean_expired_route_info(); + return; + } + + if matches!(policy, NextHopPolicy::LeastHop) { + self.gen_next_hop_map_with_least_hop(&graph, &start_node, version); + } else { + self.gen_next_hop_map_with_least_cost(&graph, &start_node, version); + }; + + let mut new_cidr_prefix_trie = PrefixMap::new(); + let mut new_cidr_v6_prefix_trie = PrefixMap::new(); + + // build peer_infos, ipv4_peer_id_map, cidr_peer_id_map + // only set map for peers we can reach. + for item in self.next_hop_map.iter() { + if item.version < version { + // skip if the next hop entry is outdated. (peer is unreachable) + continue; + } + + let peer_id = item.key(); + if !self.peer_reachable(*peer_id) { + continue; + } + + let Some(info) = lookup.peer_info(*peer_id).cloned() else { + continue; + }; + + self.peer_infos.insert(*peer_id, info.clone()); + + let peer_id_and_version = PeerIdVersion { + peer_id: *peer_id, + version, + }; + + let is_new_peer_better = |old_peer: &PeerIdVersion| -> bool { + if peer_id_and_version.version > old_peer.version { + return true; + } + if peer_id_and_version.peer_id == old_peer.peer_id { + return false; + } + let old_next_hop = self.get_next_hop(old_peer.peer_id); + let new_next_hop = item.value(); + old_next_hop.is_none() || new_next_hop.path_len < old_next_hop.unwrap().path_len + }; + + if let Some(ipv4_addr) = info.ipv4_addr { + self.ipv4_peer_id_map + .entry(ipv4_addr.into()) + .and_modify(|v| { + if is_new_peer_better(v) { + *v = peer_id_and_version; + } + }) + .or_insert(peer_id_and_version); + } + + if let Some(ipv6_addr) = info.ipv6_addr.and_then(|x| x.address) { + self.ipv6_peer_id_map + .entry(ipv6_addr.into()) + .and_modify(|v| { + if is_new_peer_better(v) { + *v = peer_id_and_version; + } + }) + .or_insert(peer_id_and_version); + } + + if let Some(ipv6_addr) = info + .ipv6_public_addr_lease + .as_ref() + .and_then(|addr| addr.address) + { + self.ipv6_peer_id_map + .entry(ipv6_addr.into()) + .and_modify(|v| { + if is_new_peer_better(v) { + *v = peer_id_and_version; + } + }) + .or_insert(peer_id_and_version); + } + + for cidr in info.proxy_cidrs.iter() { + let Ok(cidr) = cidr.parse::() else { + tracing::warn!("invalid proxy cidr: {:?}, from peer: {:?}", cidr, peer_id); + continue; + }; + + if *peer_id != my_peer_id + && local_proxy_cidrs + .iter() + .any(|local_cidr| cidr_is_subset(&cidr, local_cidr)) + { + tracing::debug!( + ?peer_id, + ?my_peer_id, + ?local_proxy_cidrs, + ?cidr, + "skip remote proxy cidr covered by local announced proxy cidr while building route table" + ); + continue; + } + match cidr { + IpCidr::V4(cidr) => { + new_cidr_prefix_trie + .entry(cidr) + .and_modify(|e| { + // if ourself has same cidr, ensure here put my peer id, so we can know deadloop may happen. + if *peer_id == my_peer_id || is_new_peer_better(e) { + *e = peer_id_and_version; + } + }) + .or_insert(peer_id_and_version); + } + + IpCidr::V6(cidr) => { + new_cidr_v6_prefix_trie + .entry(cidr) + .and_modify(|e| { + // if ourself has same cidr, ensure here put my peer id, so we can know deadloop may happen. + if *peer_id == my_peer_id || is_new_peer_better(e) { + *e = peer_id_and_version; + } + }) + .or_insert(peer_id_and_version); + } + } + tracing::debug!( + "add cidr: {:?} to peer: {:?}, my peer id: {:?}", + cidr, + peer_id, + my_peer_id + ); + } + } + + self.cidr_peer_id_map.store(Arc::new(new_cidr_prefix_trie)); + self.cidr_v6_peer_id_map + .store(Arc::new(new_cidr_v6_prefix_trie)); + tracing::trace!( + my_peer_id = my_peer_id, + cidrs = ?self.cidr_peer_id_map.load(), + cidrs_v6 = ?self.cidr_v6_peer_id_map.load(), + "update peer cidr map" + ); + self.clean_expired_route_info(); + } + + pub fn get_peer_id_for_proxy(&self, ip: &IpAddr) -> Option { + match ip { + IpAddr::V4(ipv4) => self + .cidr_peer_id_map + .load() + .get_lpm(&Ipv4Cidr::new(*ipv4, 32).unwrap()) + .map(|x| x.1.peer_id), + IpAddr::V6(ipv6) => self + .cidr_v6_peer_id_map + .load() + .get_lpm(&Ipv6Cidr::new(*ipv6, 128).unwrap()) + .map(|x| x.1.peer_id), + } + } + + pub fn list_routes( + &self, + my_peer_id: PeerId, + route_table_with_cost: &Self, + ) -> Vec { + let mut routes = Vec::new(); + for item in self.peer_infos.iter() { + if *item.key() == my_peer_id { + continue; + } + let Some(next_hop_peer) = self.get_next_hop(*item.key()) else { + continue; + }; + let next_hop_peer_latency_first = route_table_with_cost.get_next_hop(*item.key()); + let mut route: CoreRouteInfo = item.value().clone().into(); + route.next_hop_peer_id = next_hop_peer.next_hop_peer_id; + route.cost = next_hop_peer.path_len as i32; + route.path_latency = next_hop_peer.path_latency; + + route.next_hop_peer_id_latency_first = + next_hop_peer_latency_first.map(|x| x.next_hop_peer_id); + route.cost_latency_first = next_hop_peer_latency_first.map(|x| x.path_len as i32); + route.path_latency_latency_first = next_hop_peer_latency_first.map(|x| x.path_latency); + + route.feature_flag = item.feature_flag; + + routes.push(route); + } + routes + } + + pub fn list_proxy_cidrs_excluding(&self, peer_id: PeerId) -> BTreeSet { + self.cidr_peer_id_map + .load() + .iter() + .filter(|(_, pv)| pv.peer_id != peer_id) + .map(|(cidr, _)| cidr) + .collect() + } + + pub fn list_proxy_cidrs_v6_excluding(&self, peer_id: PeerId) -> BTreeSet { + self.cidr_v6_peer_id_map + .load() + .iter() + .filter(|(_, pv)| pv.peer_id != peer_id) + .map(|(cidr, _)| cidr) + .collect() + } +} + +static UPDATE_PEER_INFO_PERIOD: Duration = Duration::from_secs(3600); +static REMOVE_DEAD_PEER_INFO_AFTER: Duration = Duration::from_secs(3660); +static FORCE_USE_CONN_LIST: AtomicBool = AtomicBool::new(false); + +// if a peer is unreachable for `REMOVE_UNREACHABLE_PEER_INFO_AFTER` time, we can remove it because +// 1. all the ospf sessions between two zone are already destroy, new created session will resend the peer info. +// 2. all the dst_saved_peer_info_version in all sessions already remove the peer info, the peer info will be propagated +// in another zone when two zone restore the conneciton. +static REMOVE_UNREACHABLE_PEER_INFO_AFTER: Duration = Duration::from_secs(90); + +fn route_peer_inst_id(info: &RoutePeerInfo) -> Option { + info.inst_id.map(Into::into) +} + +fn is_foreign_network_info_newer( + next: &ForeignNetworkRouteInfoEntry, + prev: &ForeignNetworkRouteInfoEntry, +) -> Option { + Some( + SystemTime::try_from(next.last_update?).ok()? + > SystemTime::try_from(prev.last_update?).ok()?, + ) +} + +#[allow(deprecated)] +fn new_route_peer_info_with_version(easytier_version: String) -> RoutePeerInfo { + RoutePeerInfo { + peer_id: 0, + inst_id: Some(uuid::Uuid::nil().into()), + cost: 0, + ipv4_addr: None, + proxy_cidrs: Vec::new(), + hostname: None, + udp_nat_type: 0, + tcp_nat_type: 0, + // ensure this is updated when the peer_infos/conn_info/foreign_network lock is acquired. + // else we may assign a older timestamp than iterate time. + last_update: None, + version: 0, + easytier_version, + feature_flag: None, + peer_route_id: 0, + network_length: 24, + ipv6_addr: None, + groups: Vec::new(), + + quic_port: None, + noise_static_pubkey: Vec::new(), + trusted_credential_pubkeys: Vec::new(), + ipv6_public_addr_prefix: None, + ipv6_public_addr_lease: None, + } +} + +/// Creates a new `RoutePeerInfo` instance with updated information from the given context. +pub fn new_updated_self_route_peer_info( + my_peer_id: PeerId, + peer_route_id: u64, + context: &dyn PeerContext, + public_ipv6_addr_lease: Option, +) -> RoutePeerInfo { + let stun_info = context.stun_info(); + let network_identity = context.network_identity(); + let ipv4 = context.ipv4(); + let noise_static_pubkey = context + .secure_mode() + .and_then(|cfg| cfg.public_key().ok()) + .map(|pk| pk.as_bytes().to_vec()) + .unwrap_or_default(); + RoutePeerInfo { + peer_id: my_peer_id, + inst_id: Some(context.instance_id().into()), + cost: 0, + ipv4_addr: ipv4.as_ref().map(|x| x.address().into()), + proxy_cidrs: context + .proxy_cidrs() + .into_iter() + .map(|x| x.to_string()) + .collect(), + hostname: Some(context.hostname()), + udp_nat_type: stun_info.udp_nat_type, + tcp_nat_type: stun_info.tcp_nat_type, + + // these two fields should not participate in comparison. + last_update: None, + version: 0, + + easytier_version: context.easytier_version(), + feature_flag: Some(context.feature_flags()), + peer_route_id, + network_length: ipv4 + .as_ref() + .map(|x| x.network_length() as u32) + .unwrap_or(24), + + ipv6_addr: context.ipv6().map(|x| x.into()), + ipv6_public_addr_prefix: context.advertised_ipv6_public_addr_prefix().map(|prefix| { + Ipv6Inet::new(prefix.first_address(), prefix.network_length()) + .unwrap() + .into() + }), + ipv6_public_addr_lease: public_ipv6_addr_lease.map(Into::into), + + groups: context.peer_groups(my_peer_id), + + noise_static_pubkey, + + // Only admin nodes (holding network_secret) publish trusted credential pubkeys + trusted_credential_pubkeys: if let Some(network_secret) = + network_identity.network_secret.as_deref() + { + context.trusted_credential_pubkeys(network_secret) + } else { + Vec::new() + }, + + ..Default::default() + } +} + +type RouteConnBitmap = crate::proto::peer_rpc::RouteConnBitmap; +type RouteConnPeerList = crate::proto::peer_rpc::RouteConnPeerList; +type PeerConnInfo = crate::proto::peer_rpc::route_conn_peer_list::PeerConnInfo; + +/// Attempts to update the `new` RoutePeerInfo based on the `old` RoutePeerInfo. +fn try_update_new_peer_info(old: &RoutePeerInfo, new: &mut RoutePeerInfo) -> bool { + let need_update_periodically = if let Ok(Ok(d)) = + SystemTime::try_from(old.last_update.unwrap_or_default()).map(|x| x.elapsed()) + { + d > UPDATE_PEER_INFO_PERIOD + } else { + true + }; + + // these two fields should not participate in comparison. + new.version = old.version; + new.last_update = old.last_update; + + if *new != *old || need_update_periodically { + new.version += 1; + true + } else { + false + } +} + +type Error = SyncRouteInfoError; + +#[derive(Debug, Clone)] +struct RouteConnInfo { + connected_peers: BTreeSet, + version: AtomicVersion, + last_update: SystemTime, +} + +impl Default for RouteConnInfo { + fn default() -> Self { + Self { + connected_peers: BTreeSet::new(), + version: AtomicVersion::new(), + last_update: SystemTime::now(), + } + } +} + +#[derive(Debug, Clone, Default)] +struct InterfacePeerSnapshot { + generation: u64, + peers: BTreeSet, + identity_types: BTreeMap>, + public_keys: BTreeMap>>, +} + +// constructed with all infos synced from all peers. +struct SyncedRouteInfo { + default_easytier_version: String, + peer_infos: RwLock>, + // Keep the original protobuf bytes so unknown fields survive multi-hop propagation. + raw_peer_infos: DashMap, + conn_map: RwLock>, + foreign_network: DashMap, + group_trust_map: DashMap>>, + group_trust_map_cache: DashMap>>, // cache for group trust map, should sync with group_trust_map + // Serializes every read-modify-write of the derived group maps. Both + // proof verification and credential grants update these maps. + group_trust_update_lock: parking_lot::Mutex<()>, + + // Aggregated trusted credential pubkeys from all admin nodes + // Maps pubkey bytes -> TrustedCredentialPubkey + trusted_credential_pubkeys: RwLock, TrustedCredentialPubkey>>, + // Tracks the currently accepted peer for non-reusable credentials. + // Maps credential pubkey bytes -> peer_id. + non_reusable_credential_owners: DashMap, PeerId>, + // Duplicate non-reusable credential peers are kept for OSPF sync and topology + // reachability, but excluded from forwarding until owner election selects them. + suppressed_non_reusable_credential_peers: DashMap, + + version: AtomicVersion, +} + +impl Debug for SyncedRouteInfo { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("SyncedRouteInfo") + .field("default_easytier_version", &self.default_easytier_version) + .field("peer_infos", &self.peer_infos) + .field("conn_map", &self.conn_map) + .field("foreign_network", &self.foreign_network) + .field("group_trust_map", &self.group_trust_map) + .field("version", &self.version.get()) + .finish() + } +} + +#[allow(dead_code)] +impl SyncedRouteInfo { + // Must be called with group_trust_update_lock held. + fn set_peer_groups_locked(&self, peer_id: PeerId, groups: HashMap>) { + if groups.is_empty() { + self.group_trust_map.remove(&peer_id); + self.group_trust_map_cache.remove(&peer_id); + return; + } + + let group_names = groups.keys().cloned().collect(); + self.group_trust_map.insert(peer_id, groups); + self.group_trust_map_cache + .insert(peer_id, Arc::new(group_names)); + } + + // Must be called with group_trust_update_lock held. + fn get_proof_groups_locked(&self, peer_id: PeerId) -> HashMap> { + self.group_trust_map + .get(&peer_id) + .map(|groups| { + groups + .iter() + .filter(|(_, proof)| !proof.is_empty()) + .map(|(group, proof)| (group.clone(), proof.clone())) + .collect() + }) + .unwrap_or_default() + } + + fn mark_credential_peer(info: &mut RoutePeerInfo, is_credential_peer: bool) { + let mut feature_flag = info.feature_flag.unwrap_or_default(); + feature_flag.is_credential_peer = is_credential_peer; + info.feature_flag = Some(feature_flag); + } + + fn is_credential_peer_info(info: &RoutePeerInfo) -> bool { + info.feature_flag + .as_ref() + .map(|x| x.is_credential_peer) + .unwrap_or(false) + } + + fn credential_is_reusable(info: &TrustedCredentialPubkey) -> bool { + info.reusable.unwrap_or(true) + } + + fn credential_proof_is_valid( + &self, + raw_route_info: Option<&RawRoutePeerInfo>, + proof_idx: usize, + proof: &TrustedCredentialPubkeyProof, + network_secret: Option<&str>, + ) -> bool { + network_secret + .map(|secret| { + let Some(raw_route_info) = raw_route_info else { + return proof.verify_credential_hmac(secret); + }; + match raw_credential_bytes(raw_route_info, proof_idx) { + Ok(Some(raw_credential_bytes)) => { + proof.verify_credential_hmac_with_bytes(&raw_credential_bytes, secret) + } + Ok(None) | Err(_) => false, + } + }) + .unwrap_or(true) + } + + fn collect_trusted_credentials( + &self, + peer_infos: &OrderedHashMap, + network_secret: Option<&str>, + now: i64, + ) -> ( + HashMap, TrustedCredentialPubkey>, + HashMap, TrustedKeyMetadata>, + ) { + let mut all_trusted = HashMap::new(); + let mut global_trusted_keys = HashMap::new(); + + for (peer_id, info) in peer_infos.iter() { + if !self.is_admin_peer(info) { + continue; + } + + if !info.noise_static_pubkey.is_empty() { + global_trusted_keys.insert( + info.noise_static_pubkey.clone(), + TrustedKeyMetadata { + source: TrustedKeySource::OspfNode, + expiry_unix: None, + }, + ); + } + + let raw_route_info = self.raw_peer_infos.get(peer_id); + let raw_route_info = raw_route_info.as_deref(); + + for (proof_idx, proof) in info.trusted_credential_pubkeys.iter().enumerate() { + if !self.credential_proof_is_valid(raw_route_info, proof_idx, proof, network_secret) + { + continue; + } + + let Some(credential) = proof.credential.as_ref() else { + continue; + }; + if credential.expiry_unix <= now { + continue; + } + + all_trusted + .entry(credential.pubkey.clone()) + .or_insert_with(|| credential.clone()); + global_trusted_keys.insert( + credential.pubkey.clone(), + TrustedKeyMetadata { + source: TrustedKeySource::OspfCredential, + expiry_unix: Some(credential.expiry_unix), + }, + ); + } + } + + (all_trusted, global_trusted_keys) + } + + fn replace_trusted_credential_pubkeys( + &self, + all_trusted: &HashMap, TrustedCredentialPubkey>, + ) -> HashSet> { + let mut trusted = self.trusted_credential_pubkeys.write(); + let prev_trusted = trusted.keys().cloned().collect(); + *trusted = all_trusted.clone(); + + prev_trusted + } + + fn collect_non_reusable_credential_owners( + &self, + peer_infos: &OrderedHashMap, + all_trusted: &HashMap, TrustedCredentialPubkey>, + mut is_peer_active: F, + ) -> (HashMap, PeerId>, BTreeSet) + where + F: FnMut(PeerId) -> bool, + { + let mut candidates: BTreeMap, BTreeSet> = BTreeMap::new(); + + for (peer_id, info) in peer_infos.iter() { + if info.noise_static_pubkey.is_empty() { + continue; + } + + let Some(credential) = all_trusted.get(&info.noise_static_pubkey) else { + continue; + }; + if Self::credential_is_reusable(credential) { + continue; + } + if !is_peer_active(*peer_id) { + continue; + } + + candidates + .entry(info.noise_static_pubkey.clone()) + .or_default() + .insert(*peer_id); + } + + let mut active_owners = HashMap::new(); + let mut duplicate_untrusted_peers = BTreeSet::new(); + + for (pubkey, candidate_peer_ids) in candidates { + let Some(owner_peer_id) = candidate_peer_ids.iter().next().copied() else { + continue; + }; + active_owners.insert(pubkey, owner_peer_id); + + duplicate_untrusted_peers.extend( + candidate_peer_ids + .into_iter() + .filter(|peer_id| *peer_id != owner_peer_id), + ); + } + + (active_owners, duplicate_untrusted_peers) + } + + fn replace_non_reusable_credential_owners(&self, active_owners: HashMap, PeerId>) { + self.non_reusable_credential_owners + .retain(|pubkey, _| active_owners.contains_key(pubkey)); + + for (pubkey, peer_id) in active_owners { + self.non_reusable_credential_owners.insert(pubkey, peer_id); + } + } + + fn replace_suppressed_non_reusable_credential_peers( + &self, + suppressed_peers: BTreeSet, + ) -> bool { + let current: BTreeSet<_> = self + .suppressed_non_reusable_credential_peers + .iter() + .map(|entry| *entry.key()) + .collect(); + if current == suppressed_peers { + return false; + } + + self.suppressed_non_reusable_credential_peers + .retain(|peer_id, _| suppressed_peers.contains(peer_id)); + + for peer_id in suppressed_peers { + self.suppressed_non_reusable_credential_peers + .insert(peer_id, ()); + } + + self.version.inc(); + true + } + + fn update_credential_groups( + &self, + peer_infos: &OrderedHashMap, + all_trusted: &HashMap, TrustedCredentialPubkey>, + ) { + let _group_trust_lock = self.group_trust_update_lock.lock(); + for (_, info) in peer_infos.iter() { + if info.noise_static_pubkey.is_empty() { + continue; + } + + let Some(credential) = all_trusted.get(&info.noise_static_pubkey) else { + continue; + }; + let mut group_map = self.get_proof_groups_locked(info.peer_id); + for group in &credential.groups { + group_map.entry(group.clone()).or_default(); + } + self.set_peer_groups_locked(info.peer_id, group_map); + } + } + + fn collect_revoked_credential_peers( + peer_infos: &OrderedHashMap, + prev_trusted: &HashSet>, + all_trusted: &HashMap, TrustedCredentialPubkey>, + ) -> BTreeSet { + let mut untrusted_peers = BTreeSet::new(); + + for (peer_id, info) in peer_infos.iter() { + if info.noise_static_pubkey.is_empty() || info.version == 0 { + continue; + } + + if prev_trusted.contains(&info.noise_static_pubkey) + && !all_trusted.contains_key(&info.noise_static_pubkey) + { + untrusted_peers.insert(*peer_id); + } + } + + untrusted_peers + } + + fn get_connected_peers>(&self, peer_id: PeerId) -> Option { + self.conn_map + .read() + .get(&peer_id) + .map(|x| x.connected_peers.iter().copied().collect()) + } + + fn route_snapshot(&self) -> OspfRouteSnapshot { + let version = self.version.get(); + OspfRouteSnapshot { + peer_infos: self + .peer_infos + .read() + .iter() + .map(|(peer_id, info)| OspfPeerInfo { + peer_id: *peer_id, + info: info.clone(), + }) + .collect(), + conn_map: self + .conn_map + .read() + .iter() + .map(|(peer_id, info)| OspfPeerConnInfo { + peer_id: *peer_id, + connected_peers: info.connected_peers.clone(), + }) + .collect(), + suppressed_peer_ids: self + .suppressed_non_reusable_credential_peers + .iter() + .map(|entry| *entry.key()) + .collect(), + version, + } + } + + fn remove_peer(&self, peer_id: PeerId) { + self.remove_peers([peer_id]); + } + + fn remove_peers(&self, peer_ids: I) + where + I: IntoIterator, + { + let peer_ids: HashSet<_> = peer_ids.into_iter().collect(); + if peer_ids.is_empty() { + return; + } + + for peer_id in &peer_ids { + tracing::warn!(?peer_id, "remove_peer from synced_route_info"); + } + + { + let mut peer_infos = self.peer_infos.write(); + let mut conn_map = self.conn_map.write(); + for peer_id in &peer_ids { + peer_infos.remove(peer_id); + conn_map.remove(peer_id); + } + } + + { + let _group_trust_lock = self.group_trust_update_lock.lock(); + for peer_id in &peer_ids { + self.group_trust_map.remove(peer_id); + self.group_trust_map_cache.remove(peer_id); + } + shrink_dashmap(&self.group_trust_map, None); + shrink_dashmap(&self.group_trust_map_cache, None); + } + for peer_id in &peer_ids { + self.raw_peer_infos.remove(peer_id); + } + self.foreign_network + .retain(|k, _| !peer_ids.contains(&k.peer_id)); + + shrink_dashmap(&self.raw_peer_infos, None); + shrink_dashmap(&self.foreign_network, None); + self.version.inc(); + } + + fn fill_empty_peer_info(&self, peer_ids: &BTreeSet) { + let mut need_inc_version = false; + for peer_id in peer_ids { + let guard = self.peer_infos.upgradable_read(); + if !guard.contains_key(peer_id) { + let mut peer_info = + new_route_peer_info_with_version(self.default_easytier_version.clone()); + let mut guard = RwLockUpgradableReadGuard::upgrade(guard); + peer_info.last_update = Some(Timestamp::now()); + guard.insert(*peer_id, peer_info); + need_inc_version = true; + } else { + drop(guard); + } + + let guard = self.conn_map.upgradable_read(); + if !guard.contains_key(peer_id) { + let mut guard = RwLockUpgradableReadGuard::upgrade(guard); + guard.insert(*peer_id, RouteConnInfo::default()); + need_inc_version = true; + } else { + drop(guard); + } + } + if need_inc_version { + self.version.inc(); + } + } + + fn get_peer_info_version_with_default(&self, peer_id: PeerId) -> Version { + self.peer_infos + .read() + .get(&peer_id) + .map(|x| x.version) + .unwrap_or(0) + } + + fn get_avoid_relay_data(&self, peer_id: PeerId) -> bool { + // if avoid relay, just set all outgoing edges to a large value: AVOID_RELAY_COST. + self.peer_infos + .read() + .get(&peer_id) + .and_then(|x| x.feature_flag) + .map(|x| x.avoid_relay_data) + .unwrap_or_default() + } + + fn check_duplicate_peer_id( + &self, + my_peer_id: PeerId, + my_peer_route_id: u64, + dst_peer_id: PeerId, + dst_peer_route_id: Option, + info: &RoutePeerInfo, + ) -> Result<(), Error> { + // 1. check if we are duplicated. + if info.peer_id == my_peer_id { + if info.peer_route_id != my_peer_route_id + && info.version > self.get_peer_info_version_with_default(info.peer_id) + { + // if dst peer send to us with higher version info of my peer, our peer id is duplicated + // TODO: handle this better. restart peer manager? + panic!("my peer id is duplicated"); + // return Err(Error::DuplicatePeerId); + } + } else if info.peer_id == dst_peer_id { + let Some(dst_peer_route_id) = dst_peer_route_id else { + return Ok(()); + }; + + if dst_peer_route_id != info.peer_route_id + && info.version < self.get_peer_info_version_with_default(info.peer_id) + { + // if dst peer send to us with lower version info of dst peer, dst peer id is duplicated + return Err(Error::DuplicatePeerId); + } + } + + Ok(()) + } + + fn update_peer_infos( + &self, + my_peer_id: PeerId, + my_peer_route_id: u64, + dst_peer_id: PeerId, + peer_infos: &[RoutePeerInfo], + raw_peer_infos: &[RawRoutePeerInfo], + ) -> Result<(), Error> { + let mut need_inc_version = false; + for (idx, route_info) in peer_infos.iter().enumerate() { + let mut route_info = route_info.clone(); + let raw_route_info = &raw_peer_infos[idx]; + self.check_duplicate_peer_id( + my_peer_id, + my_peer_route_id, + dst_peer_id, + if route_info.peer_id == dst_peer_id { + self.peer_infos + .read() + .get(&dst_peer_id) + .map(|x| x.peer_route_id) + } else { + None + }, + &route_info, + )?; + + let mut guard = self.peer_infos.write(); + // time between peers may not be synchronized, so update last_update to local now. + // note only last_update with larger version will be updated to local saved peer info. + route_info.last_update = Some(Timestamp::now()); + if guard + .get_mut(&route_info.peer_id) + .is_none_or(|old| route_info.version > old.version) + { + self.raw_peer_infos + .insert(route_info.peer_id, raw_route_info.clone()); + guard.insert(route_info.peer_id, route_info); + need_inc_version = true; + } + } + if need_inc_version { + self.version.inc(); + } + Ok(()) + } + + fn update_conn_info_one_peer( + &self, + peer_id_version: &PeerIdVersion, + connected_peers: BTreeSet, + ) -> bool { + let mut guard = self.conn_map.write(); + if guard + .get_mut(&peer_id_version.peer_id) + .is_none_or(|old| peer_id_version.version > old.version.get()) + { + guard.insert( + peer_id_version.peer_id, + RouteConnInfo { + connected_peers, + version: peer_id_version.version.into(), + last_update: SystemTime::now(), + }, + ); + return true; + } + + false + } + + fn update_conn_info_with_bitmap(&self, conn_bitmap: &RouteConnBitmap) { + self.fill_empty_peer_info(&conn_bitmap.peer_ids.iter().map(|x| x.peer_id).collect()); + + let mut need_inc_version = false; + + for (peer_idx, peer_id_version) in conn_bitmap.peer_ids.iter().enumerate() { + let connceted_peers = conn_bitmap.get_connected_peers(peer_idx); + self.fill_empty_peer_info(&connceted_peers); + need_inc_version |= self.update_conn_info_one_peer(peer_id_version, connceted_peers); + } + if need_inc_version { + self.version.inc(); + } + } + + fn update_conn_info_with_list(&self, conn_peer_list: &RouteConnPeerList) { + let mut need_inc_version = false; + + for peer_conn_info in &conn_peer_list.peer_conn_infos { + let Some(peer_id_version) = peer_conn_info.peer_id else { + continue; + }; + let connected_peers: BTreeSet = + peer_conn_info.connected_peer_ids.iter().copied().collect(); + + self.fill_empty_peer_info(&connected_peers); + need_inc_version |= self.update_conn_info_one_peer(&peer_id_version, connected_peers); + } + if need_inc_version { + self.version.inc(); + } + } + + fn update_conn_info(&self, conn_info: &ConnInfo) { + match conn_info { + ConnInfo::ConnBitmap(conn_bitmap) => { + self.update_conn_info_with_bitmap(conn_bitmap); + } + ConnInfo::ConnPeerList(conn_peer_list) => { + self.update_conn_info_with_list(conn_peer_list); + } + } + } + + fn update_foreign_network(&self, foreign_network: &RouteForeignNetworkInfos) -> bool { + let mut changed = false; + for item in foreign_network.infos.iter().map(Clone::clone) { + let Some(key) = item.key else { + continue; + }; + let Some(mut entry) = item.value else { + continue; + }; + + entry.last_update = Some(Timestamp::now()); + + self.foreign_network + .entry(key.clone()) + .and_modify(|old_entry| { + if entry.version > old_entry.version { + *old_entry = entry.clone(); + changed = true; + } + }) + .or_insert_with(|| { + changed = true; + entry.clone() + }); + } + changed + } + + fn update_my_peer_info( + &self, + my_peer_id: PeerId, + my_peer_route_id: u64, + context: &dyn PeerContext, + public_ipv6_addr_lease: Option, + ) -> bool { + let mut new = new_updated_self_route_peer_info( + my_peer_id, + my_peer_route_id, + context, + public_ipv6_addr_lease, + ); + let mut guard = self.peer_infos.upgradable_read(); + let old = guard.get(&my_peer_id); + let new_version = old.map(|x| x.version).unwrap_or(0) + 1; + let need_insert_new = if let Some(old) = old { + try_update_new_peer_info(old, &mut new) + } else { + true + }; + + if need_insert_new { + let acl_groups = if old.map(|x| x.groups != new.groups).unwrap_or(true) { + Some(new.groups.clone()) + } else { + None + }; + + guard.with_upgraded(|peer_infos| { + new.last_update = Some(Timestamp::now()); + new.version = new_version; + peer_infos.insert(my_peer_id, new) + }); + drop(guard); + + if let Some(acl_groups) = acl_groups { + self.update_my_group_trusts(my_peer_id, &acl_groups); + } + + self.version.inc(); + true + } else { + false + } + } + + fn update_my_conn_info(&self, my_peer_id: PeerId, connected_peers: BTreeSet) -> bool { + self.fill_empty_peer_info(&connected_peers); + + let guard = self.conn_map.upgradable_read(); + let my_conn_info = guard.get(&my_peer_id); + let new_version = my_conn_info.map(|x| x.version.get()).unwrap_or(0) + 1; + + if my_conn_info.is_none_or(|old| old.connected_peers != connected_peers) { + let mut guard = RwLockUpgradableReadGuard::upgrade(guard); + guard.insert( + my_peer_id, + RouteConnInfo { + connected_peers, + version: new_version.into(), + last_update: SystemTime::now(), + }, + ); + self.version.inc(); + true + } else { + false + } + } + + fn update_my_foreign_network( + &self, + my_peer_id: PeerId, + foreign_networks: ForeignNetworkRouteInfoMap, + ) -> bool { + let now = SystemTime::now(); + let now_version = now + .duration_since(SystemTime::UNIX_EPOCH) + .unwrap() + .as_secs() as Version; + let mut updated = false; + for mut item in self + .foreign_network + .iter_mut() + .filter(|x| x.key().peer_id == my_peer_id) + { + let (key, entry) = item.pair_mut(); + if let Some(mut new_entry) = foreign_networks.get_mut(key) { + assert!(!new_entry.foreign_peer_ids.is_empty()); + if let Some(is_newer) = is_foreign_network_info_newer(&new_entry, entry) { + let need_renew = is_newer + || now + .duration_since(entry.last_update.unwrap().try_into().unwrap()) + .unwrap_or(Duration::from_secs(0)) + > UPDATE_PEER_INFO_PERIOD; + if need_renew { + new_entry.version = std::cmp::max(new_entry.version + 1, now_version); + *entry = new_entry.clone(); + updated = true; + } + } + drop(new_entry); + foreign_networks.remove(key).unwrap(); + } else if !item.foreign_peer_ids.is_empty() { + item.foreign_peer_ids.clear(); + item.last_update = Some(Timestamp::now()); + item.version = std::cmp::max(item.version + 1, now_version); + updated = true; + } + } + + for item in foreign_networks.iter() { + assert!(!item.value().foreign_peer_ids.is_empty()); + self.foreign_network + .entry(item.key().clone()) + .and_modify(|old_entry| { + if item.value().version > old_entry.version { + *old_entry = item.value().clone(); + } + }) + .or_insert_with(|| { + let mut v = item.value().clone(); + v.version = now_version; + v + }); + updated = true; + } + + if updated { + self.version.inc(); + } + + updated + } + + fn get_next_last_sync_succ_timestamp(&self) -> SystemTime { + let _peer_info_lock = self.peer_infos.read(); + let _conn_info_lock = self.conn_map.read(); + // TODO: add conn and foreign network lock + + SystemTime::now() + } + + fn verify_and_update_group_trusts( + &self, + peer_infos: &[RoutePeerInfo], + local_group_declarations: &[PeerGroupIdentity], + trust_admin_groups_without_proof: bool, + ) { + let _group_trust_lock = self.group_trust_update_lock.lock(); + let local_group_declarations = local_group_declarations + .iter() + .map(|g| (g.group_name.as_str(), g.group_secret.as_str())) + .collect::>(); + + let verify_groups = |info: &RoutePeerInfo| -> HashMap> { + let mut trusted_groups_for_peer: HashMap> = HashMap::new(); + + for group_proof in &info.groups { + let name = &group_proof.group_name; + let proof_bytes = group_proof.group_proof.clone(); + + if let Some(&local_secret) = + local_group_declarations.get(group_proof.group_name.as_str()) + { + if group_proof.verify(local_secret, info.peer_id) { + trusted_groups_for_peer.insert(name.clone(), proof_bytes); + } else { + tracing::warn!( + peer_id = info.peer_id, + group = %group_proof.group_name, + "Group proof verification failed" + ); + } + } + } + + if trust_admin_groups_without_proof && self.is_admin_peer(info) { + for group_proof in &info.groups { + trusted_groups_for_peer + .entry(group_proof.group_name.clone()) + .or_default(); + } + } + + trusted_groups_for_peer + }; + + for info in peer_infos { + match self.group_trust_map.entry(info.peer_id) { + dashmap::mapref::entry::Entry::Occupied(mut entry) => { + let trusted_groups_for_peer = verify_groups(info); + + if trusted_groups_for_peer.is_empty() { + entry.remove(); + self.group_trust_map_cache.remove(&info.peer_id); + } else { + let group_names = trusted_groups_for_peer.keys().cloned().collect(); + self.group_trust_map_cache + .insert(info.peer_id, Arc::new(group_names)); + *entry.get_mut() = trusted_groups_for_peer; + } + } + dashmap::mapref::entry::Entry::Vacant(entry) => { + let trusted_groups_for_peer = verify_groups(info); + + if !trusted_groups_for_peer.is_empty() { + let group_names = trusted_groups_for_peer.keys().cloned().collect(); + self.group_trust_map_cache + .insert(info.peer_id, Arc::new(group_names)); + entry.insert(trusted_groups_for_peer); + } + } + } + } + } + + fn verify_and_update_current_group_trusts( + &self, + received_peer_infos: &[RoutePeerInfo], + local_group_declarations: &[PeerGroupIdentity], + trust_admin_groups_without_proof: bool, + ) { + let peer_ids: HashSet<_> = received_peer_infos + .iter() + .map(|info| info.peer_id) + .collect(); + let peer_infos_guard = self.peer_infos.read(); + let current_peer_infos: Vec<_> = peer_ids + .iter() + .filter_map(|peer_id| peer_infos_guard.get(peer_id).cloned()) + .collect(); + self.verify_and_update_group_trusts( + ¤t_peer_infos, + local_group_declarations, + trust_admin_groups_without_proof, + ); + // Keep the authoritative peer-info snapshot locked until its derived + // ACL cache has been updated, so another sync cannot interleave a + // newer peer version and then be overwritten by this one. + drop(peer_infos_guard); + } + + fn verify_and_update_all_current_group_trusts( + &self, + local_group_declarations: &[PeerGroupIdentity], + trust_admin_groups_without_proof: bool, + ) { + let peer_infos_guard = self.peer_infos.read(); + let current_peer_infos: Vec<_> = peer_infos_guard + .iter() + .map(|(_, info)| info.clone()) + .collect(); + self.verify_and_update_group_trusts( + ¤t_peer_infos, + local_group_declarations, + trust_admin_groups_without_proof, + ); + drop(peer_infos_guard); + } + + fn update_my_group_trusts(&self, my_peer_id: PeerId, groups: &[PeerGroupInfo]) { + let _group_trust_lock = self.group_trust_update_lock.lock(); + let mut my_group_map = HashMap::new(); + + for group in groups.iter() { + my_group_map.insert(group.group_name.clone(), group.group_proof.clone()); + } + + self.set_peer_groups_locked(my_peer_id, my_group_map); + } + + /// Collect trusted credential pubkeys from admin nodes (network_secret holders) + /// and verify credential peers. Returns set of peer_ids that should be removed. + /// Also returns trusted-key metadata for the core trust-state update. + fn verify_and_update_credential_trusts( + &self, + network_secret: Option<&str>, + ) -> (Vec, HashMap, TrustedKeyMetadata>) { + self.verify_and_update_credential_trusts_with_active_peers(network_secret, |_| true) + } + + fn verify_and_update_credential_trusts_with_active_peers( + &self, + network_secret: Option<&str>, + is_peer_active: F, + ) -> (Vec, HashMap, TrustedKeyMetadata>) + where + F: FnMut(PeerId) -> bool, + { + let (untrusted_peers, global_trusted_keys, _) = self + .verify_and_update_credential_trusts_with_active_peers_protecting( + network_secret, + is_peer_active, + None, + ); + (untrusted_peers, global_trusted_keys) + } + + fn verify_and_update_credential_trusts_with_active_peers_protecting( + &self, + network_secret: Option<&str>, + is_peer_active: F, + protected_peer_id: Option, + ) -> (Vec, HashMap, TrustedKeyMetadata>, bool) + where + F: FnMut(PeerId) -> bool, + { + let now = std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .unwrap() + .as_secs() as i64; + + let peer_infos = self.peer_infos.read(); + let (all_trusted, global_trusted_keys) = + self.collect_trusted_credentials(&peer_infos, network_secret, now); + let prev_trusted = self.replace_trusted_credential_pubkeys(&all_trusted); + let (active_non_reusable_owners, mut duplicate_untrusted_peers) = + self.collect_non_reusable_credential_owners(&peer_infos, &all_trusted, is_peer_active); + if let Some(protected_peer_id) = protected_peer_id { + duplicate_untrusted_peers.remove(&protected_peer_id); + } + self.replace_non_reusable_credential_owners(active_non_reusable_owners); + let suppressed_changed = + self.replace_suppressed_non_reusable_credential_peers(duplicate_untrusted_peers); + self.update_credential_groups(&peer_infos, &all_trusted); + + let mut untrusted_peers = + Self::collect_revoked_credential_peers(&peer_infos, &prev_trusted, &all_trusted); + if let Some(protected_peer_id) = protected_peer_id { + untrusted_peers.remove(&protected_peer_id); + } + + // Remove untrusted peers from peer_infos so they won't appear in route graph + if !untrusted_peers.is_empty() { + drop(peer_infos); // release read lock before writing + for peer_id in &untrusted_peers { + tracing::warn!(?peer_id, "removing untrusted peer from route info"); + } + self.remove_peers(untrusted_peers.iter().copied()); + } + + ( + untrusted_peers.into_iter().collect(), + global_trusted_keys, + suppressed_changed, + ) + } + + fn is_admin_peer(&self, info: &RoutePeerInfo) -> bool { + if info.version == 0 { + return false; + } + !Self::is_credential_peer_info(info) + } + + fn is_credential_peer(&self, peer_id: PeerId) -> bool { + let peer_infos = self.peer_infos.read(); + peer_infos + .get(&peer_id) + .map(Self::is_credential_peer_info) + .unwrap_or(false) + } + + fn get_credential_info_by_pubkey(&self, peer_pubkey: &[u8]) -> Option { + if peer_pubkey.is_empty() { + return None; + } + self.trusted_credential_pubkeys + .read() + .get(peer_pubkey) + .cloned() + } +} + +type SessionId = u64; + +type AtomicSessionId = atomic_shim::AtomicU64; + +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +struct SyncRequestSnapshot { + my_session_id: SessionId, + state_revision: u64, + is_initiator: bool, +} + +struct SessionTask { + my_peer_id: PeerId, + task: Arc>>>, +} + +impl SessionTask { + fn new(my_peer_id: PeerId) -> Self { + SessionTask { + my_peer_id, + task: Arc::new(std::sync::Mutex::new(None)), + } + } + + fn set_task(&self, task: JoinHandle<()>) { + if let Some(old) = self.task.lock().unwrap().replace(task) { + old.abort(); + } + } + + fn is_running(&self) -> bool { + if let Some(task) = self.task.lock().unwrap().as_ref() { + !task.is_finished() + } else { + false + } + } + + async fn stop(&self) { + let task = self.task.lock().unwrap().take(); + if let Some(task) = task { + task.abort(); + let _ = task.await; + } + } +} + +impl Drop for SessionTask { + fn drop(&mut self) { + if let Some(task) = self.task.lock().unwrap().take() { + task.abort(); + } + tracing::debug!(my_peer_id = self.my_peer_id, "drop SessionTask"); + } +} + +impl Debug for SessionTask { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("SessionTask") + .field("is_running", &self.is_running()) + .finish() + } +} + +#[derive(Debug)] +struct VersionAndTouchTime { + version: AtomicVersion, + touch_time: AtomicCell, +} + +impl Default for VersionAndTouchTime { + fn default() -> Self { + VersionAndTouchTime { + version: AtomicVersion::new(), + touch_time: AtomicCell::new(Instant::now()), + } + } +} + +impl VersionAndTouchTime { + fn touch(&self) { + self.touch_time.store(Instant::now()); + } + + fn get(&self) -> Version { + self.version.get() + } + + fn set_if_larger(&self, version: Version) { + self.version.set_if_larger(version); + } + + fn is_expired(&self) -> bool { + self.touch_time.load().elapsed() > Duration::from_secs(60) + } +} + +// A responder session sends no keepalives when there is no new route data, +// so the only sign that the initiator still owns the session is its +// periodic inbound syncs (forced at least every ~10s by session_task). +// Treat a longer silence as the initiator having lost this session (e.g. +// restarted) without telling us. +const INITIATOR_SESSION_LIVENESS_TIMEOUT: Duration = Duration::from_secs(45); + +// if we need to sync route info with one peer, we create a SyncRouteSession with that peer. +#[derive(Debug)] +#[allow(dead_code)] +struct SyncRouteSession { + my_peer_id: PeerId, + dst_peer_id: PeerId, + dst_saved_peer_info_versions: DashMap, + dst_saved_conn_info_version: DashMap, + dst_saved_foreign_network_versions: DashMap, + + // we don't want to send unreachable peer infos / conn infos to peer, so we keep track of them. + unreachable_peers_for_peer_info: parking_lot::Mutex>, + unreachable_peers_for_conn_info: parking_lot::Mutex>, + + // Keep requests until the data arrives, including when an RPC response is lost. + missing_peer_ids: parking_lot::Mutex>, + + last_sync_succ_timestamp: AtomicCell>, + + // Last time any sync interaction (inbound request or successful + // response) confirmed the peer still holds this session. Drives the + // responder liveness timeout; initialized at session creation. + last_contact_instant: AtomicCell, + + my_session_id: AtomicSessionId, + dst_session_id: AtomicSessionId, + + // every node should have exactly one initator session to one other non-initiator peer. + we_are_initiator: AtomicBool, + dst_is_initiator: AtomicBool, + + // Serializes the compound session state observed by an outbound RPC. + // A response may only commit while this revision still matches the + // request snapshot captured before the await. + state_revision: AtomicU64, + + need_sync_initiator_info: AtomicBool, + + rpc_tx_count: AtomicU32, + rpc_rx_count: AtomicU32, + + task: SessionTask, + + lock: parking_lot::Mutex<()>, +} + +impl SyncRouteSession { + fn new(my_peer_id: PeerId, dst_peer_id: PeerId) -> Self { + SyncRouteSession { + my_peer_id, + dst_peer_id, + dst_saved_peer_info_versions: DashMap::new(), + dst_saved_conn_info_version: DashMap::new(), + dst_saved_foreign_network_versions: DashMap::new(), + + unreachable_peers_for_peer_info: parking_lot::Mutex::new(BTreeMap::new()), + unreachable_peers_for_conn_info: parking_lot::Mutex::new(BTreeMap::new()), + + missing_peer_ids: parking_lot::Mutex::new(BTreeSet::new()), + + last_sync_succ_timestamp: AtomicCell::new(None), + + last_contact_instant: AtomicCell::new(Instant::now()), + + my_session_id: AtomicSessionId::new(rand::random()), + dst_session_id: AtomicSessionId::new(0), + + we_are_initiator: AtomicBool::new(false), + dst_is_initiator: AtomicBool::new(false), + state_revision: AtomicU64::new(0), + + need_sync_initiator_info: AtomicBool::new(false), + + rpc_tx_count: AtomicU32::new(0), + rpc_rx_count: AtomicU32::new(0), + + task: SessionTask::new(my_peer_id), + + lock: parking_lot::Mutex::new(()), + } + } + + fn check_saved_peer_info_update_to_date(&self, peer_id: PeerId, version: Version) -> bool { + if version == 0 || peer_id == self.dst_peer_id { + // never send version 0 peer info to dst peer. + return true; + } + self.dst_saved_peer_info_versions + .get(&peer_id) + .map(|v| { + v.touch(); + v.get() >= version + }) + .unwrap_or(false) + } + + fn check_saved_conn_version_update_to_date(&self, peer_id: PeerId, version: Version) -> bool { + if version == 0 || peer_id == self.dst_peer_id { + // never send version 0 conn bitmap to dst peer. + return true; + } + self.dst_saved_conn_info_version + .get(&peer_id) + .map(|v| { + v.touch(); + v.get() >= version + }) + .unwrap_or(false) + } + + fn check_saved_foreign_network_version_update_to_date( + &self, + foreign_network_key: &ForeignNetworkRouteInfoKey, + version: Version, + ) -> bool { + if version == 0 || foreign_network_key.peer_id == self.dst_peer_id { + // never send version 0 foreign network to dst peer. + return true; + } + + self.dst_saved_foreign_network_versions + .get(foreign_network_key) + .map(|x| { + x.touch(); + x.get() >= version + }) + .unwrap_or(false) + } + + fn update_dst_saved_peer_info_version(&self, infos: &[RoutePeerInfo], dst_peer_id: PeerId) { + for info in infos.iter() { + if info.peer_id == dst_peer_id { + // we never send dst peer info to dst peer, so no need to store it. + continue; + } + + self.dst_saved_peer_info_versions + .entry(info.peer_id) + .or_default() + .set_if_larger(info.version); + } + } + + fn update_dst_saved_conn_bitmap_version( + &self, + conn_bitmap: &RouteConnBitmap, + dst_peer_id: PeerId, + ) { + for peer_id_version in conn_bitmap.peer_ids.iter() { + if peer_id_version.peer_id == dst_peer_id { + continue; + } + + self.dst_saved_conn_info_version + .entry(peer_id_version.peer_id) + .or_default() + .set_if_larger(peer_id_version.version); + } + } + + fn update_dst_saved_conn_peer_list_version( + &self, + conn_peer_list: &RouteConnPeerList, + dst_peer_id: PeerId, + ) { + for peer_conn_info in &conn_peer_list.peer_conn_infos { + let Some(peer_id_version) = peer_conn_info.peer_id else { + continue; + }; + if peer_id_version.peer_id == dst_peer_id { + continue; + } + + self.dst_saved_conn_info_version + .entry(peer_id_version.peer_id) + .or_default() + .set_if_larger(peer_id_version.version); + } + } + + fn update_dst_saved_conn_info_version(&self, conn_info: &ConnInfo, dst_peer_id: PeerId) { + match conn_info { + ConnInfo::ConnBitmap(conn_bitmap) => { + self.update_dst_saved_conn_bitmap_version(conn_bitmap, dst_peer_id); + } + ConnInfo::ConnPeerList(peer_list) => { + self.update_dst_saved_conn_peer_list_version(peer_list, dst_peer_id); + } + } + } + + fn update_dst_saved_foreign_network_version( + &self, + foreign_network: &RouteForeignNetworkInfos, + dst_peer_id: PeerId, + ) { + for item in foreign_network.infos.iter() { + if item.key.as_ref().unwrap().peer_id == dst_peer_id { + continue; + } + self.dst_saved_foreign_network_versions + .entry(item.key.clone().unwrap()) + .or_default() + .set_if_larger(item.value.as_ref().unwrap().version); + } + } + + fn update_initiator_flag(&self, is_initiator: bool) { + let _session_lock = self.lock.lock(); + if self.we_are_initiator.load(Ordering::Relaxed) != is_initiator { + self.we_are_initiator.store(is_initiator, Ordering::Relaxed); + self.state_revision.fetch_add(1, Ordering::Relaxed); + } + self.need_sync_initiator_info.store(true, Ordering::Relaxed); + } + + // Must be called with the session lock held. + fn update_remote_state_locked(&self, session_id: SessionId, is_initiator: bool) { + let session_id_changed = session_id != self.dst_session_id.load(Ordering::Relaxed); + let initiator_changed = is_initiator != self.dst_is_initiator.load(Ordering::Relaxed); + + if session_id_changed { + tracing::warn!(?self, ?session_id, "session id mismatch, clear saved info."); + self.dst_session_id.store(session_id, Ordering::Relaxed); + self.dst_saved_conn_info_version.clear(); + self.dst_saved_peer_info_versions.clear(); + self.dst_saved_foreign_network_versions.clear(); + + self.last_sync_succ_timestamp.store(None); + self.unreachable_peers_for_peer_info.lock().clear(); + self.unreachable_peers_for_conn_info.lock().clear(); + self.missing_peer_ids.lock().clear(); + } + + if initiator_changed { + self.dst_is_initiator.store(is_initiator, Ordering::Relaxed); + } + + if session_id_changed || initiator_changed { + self.state_revision.fetch_add(1, Ordering::Relaxed); + } + } + + // Must be called with the session lock held. A different generation may + // only take over through an initiator request after the previous remote + // initiator role has been relinquished or expired. + fn admit_inbound_locked(&self, session_id: SessionId, is_initiator: bool) -> bool { + let current_session_id = self.dst_session_id.load(Ordering::Relaxed); + if session_id == current_session_id { + self.update_remote_state_locked(session_id, is_initiator); + return true; + } + + if current_session_id == 0 && !is_initiator && self.we_are_initiator.load(Ordering::Relaxed) + { + // The responder can send its first reverse sync before our + // initiating RPC response arrives and teaches us its session ID. + self.update_remote_state_locked(session_id, false); + return true; + } + + if !is_initiator || self.dst_is_initiator.load(Ordering::Relaxed) { + return false; + } + + self.update_remote_state_locked(session_id, true); + true + } + + // Must be called with the session lock held. + fn request_snapshot_locked(&self) -> SyncRequestSnapshot { + SyncRequestSnapshot { + my_session_id: self.my_session_id.load(Ordering::Relaxed), + state_revision: self.state_revision.load(Ordering::Relaxed), + is_initiator: self.we_are_initiator.load(Ordering::Relaxed), + } + } + + // Must be called with the session lock held. + fn request_is_current_locked(&self, snapshot: SyncRequestSnapshot) -> bool { + snapshot.my_session_id == self.my_session_id.load(Ordering::Relaxed) + && snapshot.state_revision == self.state_revision.load(Ordering::Relaxed) + && snapshot.is_initiator == self.we_are_initiator.load(Ordering::Relaxed) + } + + // Must be called with the session lock held. + fn clear_dst_initiator_if_session_unchanged_locked( + &self, + expected_dst_session_id: SessionId, + ) -> bool { + if self.dst_session_id.load(Ordering::Relaxed) != expected_dst_session_id { + return false; + } + + self.update_remote_state_locked(expected_dst_session_id, false); + true + } + + // Responder sessions have no outbound keepalive, so the only sign that + // the initiator still owns the session is its periodic inbound syncs. + // If no sync interaction arrived within INITIATOR_SESSION_LIVENESS_TIMEOUT, + // assume the initiator lost this session without telling us and clear the + // stale role so the election loop can re-establish the edge. Only the + // flag is cleared; the election loop takes over from there. Returns true + // if the initiator role was cleared. + fn clear_stale_dst_initiator(&self) -> bool { + let _session_lock = self.lock.lock(); + if !self.dst_is_initiator.load(Ordering::Relaxed) + || self.we_are_initiator.load(Ordering::Relaxed) + { + return false; + } + + if self.last_contact_instant.load().elapsed() < INITIATOR_SESSION_LIVENESS_TIMEOUT { + return false; + } + + let session_id = self.dst_session_id.load(Ordering::Relaxed); + self.update_remote_state_locked(session_id, false); + true + } + + fn clean_dst_saved_map(&self) { + self.dst_saved_peer_info_versions + .retain(|_, v| !v.is_expired()); + self.dst_saved_peer_info_versions.shrink_to_fit(); + + self.dst_saved_conn_info_version + .retain(|_, v| !v.is_expired()); + self.dst_saved_conn_info_version.shrink_to_fit(); + + self.dst_saved_foreign_network_versions + .retain(|_, v| !v.is_expired()); + self.dst_saved_foreign_network_versions.shrink_to_fit(); + } + + fn update_last_sync_succ_timestamp(&self, next_last_sync_succ_timestamp: SystemTime) { + let _ = self.last_sync_succ_timestamp.fetch_update(|x| { + if x.is_none_or(|old| old < next_last_sync_succ_timestamp) { + Some(Some(next_last_sync_succ_timestamp)) + } else { + None + } + }); + } + + fn short_debug_string(&self) -> String { + format!( + "session_dst_peer: {:?}, my_session_id: {:?}, dst_session_id: {:?}, we_are_initiator: {:?}, dst_is_initiator: {:?}, rpc_tx_count: {:?}, rpc_rx_count: {:?}, task: {:?}", + self.dst_peer_id, + self.my_session_id, + self.dst_session_id, + self.we_are_initiator, + self.dst_is_initiator, + self.rpc_tx_count, + self.rpc_rx_count, + self.task + ) + } +} + +impl Drop for SyncRouteSession { + fn drop(&mut self) { + tracing::debug!(?self, "drop SyncRouteSession"); + } +} + +struct PeerRouteServiceImpl { + my_peer_id: PeerId, + my_peer_route_id: u64, + context: ArcPeerContext, + sessions: DashMap>, + stopped: AtomicBool, + session_operation: AsyncRwLock<()>, + + interface: Mutex>, + + cost_calculator: std::sync::RwLock>, + route_table: OspfRouteTable, + route_table_with_cost: OspfRouteTable, + foreign_network_owner_map: DashMap>, + foreign_network_my_peer_id_map: DashMap<(String, PeerId), PeerId>, + synced_route_info: SyncedRouteInfo, + public_ipv6_service: std::sync::Mutex>, + self_public_ipv6_addr_lease: std::sync::Mutex>, + cached_local_conn_map: std::sync::Mutex, + cached_local_conn_map_version: AtomicVersion, + cached_interface_peer_snapshot: std::sync::Mutex>, + interface_peers_generation: AtomicU64, + applied_interface_peers_generation: AtomicU64, + applied_interface_peers: std::sync::Mutex>, + self_conn_info_withdrawn: AtomicBool, + + last_update_my_foreign_network: AtomicCell>, + + peer_info_last_update: AtomicCell, +} + +impl Debug for PeerRouteServiceImpl { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PeerRouteServiceImpl") + .field("my_peer_id", &self.my_peer_id) + .field("my_peer_route_id", &self.my_peer_route_id) + .field("network", &self.context.network_identity()) + .field("sessions", &self.sessions) + .field("route_table", &self.route_table) + .field("route_table_with_cost", &self.route_table_with_cost) + .field("synced_route_info", &self.synced_route_info) + .field("foreign_network_owner_map", &self.foreign_network_owner_map) + .field( + "foreign_network_my_peer_id_map", + &self.foreign_network_my_peer_id_map, + ) + .field( + "cached_local_conn_map", + &self.cached_local_conn_map.lock().unwrap(), + ) + .finish() + } +} + +#[allow(dead_code)] +impl PeerRouteServiceImpl { + fn new(my_peer_id: PeerId, context: ArcPeerContext) -> Self { + PeerRouteServiceImpl { + my_peer_id, + my_peer_route_id: rand::random(), + context: context.clone(), + sessions: DashMap::new(), + stopped: AtomicBool::new(false), + session_operation: AsyncRwLock::new(()), + + interface: Mutex::new(None), + + cost_calculator: std::sync::RwLock::new(Some(Box::new(DefaultRouteCostCalculator))), + + route_table: OspfRouteTable::new(), + route_table_with_cost: OspfRouteTable::new(), + foreign_network_owner_map: DashMap::new(), + foreign_network_my_peer_id_map: DashMap::new(), + + synced_route_info: SyncedRouteInfo { + default_easytier_version: context.easytier_version(), + peer_infos: RwLock::new(OrderedHashMap::new()), + raw_peer_infos: DashMap::new(), + conn_map: RwLock::new(OrderedHashMap::new()), + foreign_network: DashMap::new(), + group_trust_map: DashMap::new(), + group_trust_map_cache: DashMap::new(), + group_trust_update_lock: parking_lot::Mutex::new(()), + trusted_credential_pubkeys: RwLock::new(HashMap::new()), + non_reusable_credential_owners: DashMap::new(), + suppressed_non_reusable_credential_peers: DashMap::new(), + version: AtomicVersion::new(), + }, + public_ipv6_service: std::sync::Mutex::new(Weak::new()), + self_public_ipv6_addr_lease: std::sync::Mutex::new(None), + cached_local_conn_map: std::sync::Mutex::new(RouteConnBitmap::default()), + cached_local_conn_map_version: AtomicVersion::new(), + cached_interface_peer_snapshot: std::sync::Mutex::new(Arc::new( + InterfacePeerSnapshot::default(), + )), + interface_peers_generation: AtomicU64::new(1), + applied_interface_peers_generation: AtomicU64::new(0), + applied_interface_peers: std::sync::Mutex::new(BTreeSet::new()), + self_conn_info_withdrawn: AtomicBool::new(false), + + last_update_my_foreign_network: AtomicCell::new(None), + + peer_info_last_update: AtomicCell::new(Instant::now()), + } + } + + fn is_credential_node(&self) -> bool { + self.context.network_identity().network_secret.is_none() + && self + .context + .secure_mode() + .map(|c| c.enabled) + .unwrap_or(false) + } + + fn peer_relay_projection_enabled(&self) -> bool { + self.context.flags().prefer_peer_relay && !self.is_credential_node() + } + + fn set_public_ipv6_service(&self, service: Weak) { + *self.public_ipv6_service.lock().unwrap() = service; + } + + fn public_ipv6_service(&self) -> Option> { + self.public_ipv6_service.lock().unwrap().upgrade() + } + + fn notify_public_ipv6_route_change(&self) -> bool { + self.public_ipv6_service() + .map(|service| service.handle_route_change()) + .unwrap_or(false) + } + + fn get_or_create_session(&self, dst_peer_id: PeerId) -> Arc { + self.sessions + .entry(dst_peer_id) + .or_insert_with(|| Arc::new(SyncRouteSession::new(self.my_peer_id, dst_peer_id))) + .value() + .clone() + } + + fn get_session(&self, dst_peer_id: PeerId) -> Option> { + self.sessions.get(&dst_peer_id).map(|x| x.value().clone()) + } + + fn is_current_session(&self, dst_peer_id: PeerId, expected: &Arc) -> bool { + self.sessions + .get(&dst_peer_id) + .is_some_and(|current| Arc::ptr_eq(current.value(), expected)) + } + + // Must be called with the expected session lock held. remove_session + // takes the same lock before changing the map, so this check remains + // valid until the caller finishes committing the RPC result. + fn sync_request_is_current_locked( + &self, + dst_peer_id: PeerId, + expected: &Arc, + snapshot: SyncRequestSnapshot, + ) -> bool { + self.is_current_session(dst_peer_id, expected) + && expected.request_is_current_locked(snapshot) + } + + fn remove_session(&self, dst_peer_id: PeerId) { + let Some(session) = self.get_session(dst_peer_id) else { + return; + }; + let _session_lock = session.lock.lock(); + self.sessions + .remove_if(&dst_peer_id, |_, current| Arc::ptr_eq(current, &session)); + shrink_dashmap(&self.sessions, None); + } + + fn list_session_peers(&self) -> Vec { + self.sessions.iter().map(|x| *x.key()).collect() + } + + pub fn mark_interface_peers_dirty(&self) { + self.interface_peers_generation + .fetch_add(1, Ordering::Relaxed); + } + + async fn interface_peer_snapshot_uncached(&self) -> InterfacePeerSnapshot { + let interface = self.interface.lock().await; + let interface = interface.as_ref().unwrap(); + + let peers: BTreeSet<_> = interface.list_peers().await.into_iter().collect(); + let mut identity_types = BTreeMap::new(); + let mut public_keys = BTreeMap::new(); + for peer_id in peers.iter().copied() { + identity_types.insert(peer_id, interface.get_peer_identity_type(peer_id).await); + if self.peer_relay_projection_enabled() { + public_keys.insert(peer_id, interface.get_peer_public_key(peer_id).await); + } + } + + InterfacePeerSnapshot { + generation: 0, + peers, + identity_types, + public_keys, + } + } + + async fn interface_peer_snapshot(&self) -> Arc { + loop { + let start_generation = self.interface_peers_generation.load(Ordering::Acquire); + { + let cached = self.cached_interface_peer_snapshot.lock().unwrap(); + if cached.generation == start_generation { + return cached.clone(); + } + } + + let mut snapshot = self.interface_peer_snapshot_uncached().await; + let end_generation = self.interface_peers_generation.load(Ordering::Acquire); + if start_generation == end_generation { + snapshot.generation = end_generation; + let snapshot = Arc::new(snapshot); + *self.cached_interface_peer_snapshot.lock().unwrap() = snapshot.clone(); + return snapshot; + } + } + } + + async fn get_peer_identity_type_from_interface( + &self, + peer_id: PeerId, + ) -> Option { + let snapshot = self.interface_peer_snapshot().await; + if let Some(identity_type) = snapshot.identity_types.get(&peer_id) { + return *identity_type; + } + + self.interface + .lock() + .await + .as_ref() + .unwrap() + .get_peer_identity_type(peer_id) + .await + } + + async fn get_peer_public_key_from_interface(&self, peer_id: PeerId) -> Option> { + let snapshot = self.interface_peer_snapshot().await; + if let Some(public_key) = snapshot.public_keys.get(&peer_id) { + return public_key.clone(); + } + + self.interface + .lock() + .await + .as_ref() + .unwrap() + .get_peer_public_key(peer_id) + .await + } + + fn derive_advertised_connected_peers( + &self, + snapshot: &InterfacePeerSnapshot, + ) -> BTreeSet { + if self.self_conn_info_withdrawn.load(Ordering::Acquire) { + return BTreeSet::new(); + } + + if !self.peer_relay_projection_enabled() { + return snapshot.peers.clone(); + } + + let is_credential_peer = |peer_id: PeerId| { + matches!( + snapshot.identity_types.get(&peer_id), + Some(Some(PeerIdentityType::Credential)) + ) + }; + + let eligible_relays: BTreeSet<_> = { + let peer_infos = self.synced_route_info.peer_infos.read(); + snapshot + .peers + .iter() + .copied() + .filter(|peer_id| is_credential_peer(*peer_id)) + .filter(|peer_id| { + !self + .synced_route_info + .suppressed_non_reusable_credential_peers + .contains_key(peer_id) + }) + .filter(|peer_id| { + let Some(Some(public_key)) = snapshot.public_keys.get(peer_id) else { + return false; + }; + if peer_infos + .get(peer_id) + .and_then(|info| info.feature_flag) + .is_some_and(|flags| flags.avoid_relay_data) + { + return false; + } + + self.synced_route_info + .get_credential_info_by_pubkey(public_key) + .is_some_and(|credential| credential.allow_relay) + }) + .collect() + }; + + if eligible_relays.is_empty() { + return snapshot.peers.clone(); + } + + let conn_map = self.synced_route_info.conn_map.read(); + let mut covered_targets = BTreeSet::new(); + for relay_peer_id in &eligible_relays { + let Some(relay_conn_info) = conn_map.get(relay_peer_id) else { + continue; + }; + for target_peer_id in &relay_conn_info.connected_peers { + if snapshot.peers.contains(target_peer_id) + && is_credential_peer(*target_peer_id) + && !eligible_relays.contains(target_peer_id) + && !self + .synced_route_info + .suppressed_non_reusable_credential_peers + .contains_key(target_peer_id) + { + covered_targets.insert(*target_peer_id); + } + } + } + + snapshot + .peers + .difference(&covered_targets) + .copied() + .collect() + } + + fn reconcile_my_conn_info( + &self, + snapshot: &InterfacePeerSnapshot, + interface_snapshot_changed: bool, + ) -> bool { + let advertised_peers = self.derive_advertised_connected_peers(snapshot); + if self + .synced_route_info + .update_my_conn_info(self.my_peer_id, advertised_peers) + { + return true; + } + + if interface_snapshot_changed && self.peer_relay_projection_enabled() { + self.synced_route_info.version.inc(); + return true; + } + + false + } + + fn update_my_peer_info(&self) -> bool { + self.synced_route_info.update_my_peer_info( + self.my_peer_id, + self.my_peer_route_id, + self.context.as_ref(), + *self.self_public_ipv6_addr_lease.lock().unwrap(), + ) + } + + async fn update_my_conn_info(&self) -> bool { + let current_generation = self.interface_peers_generation.load(Ordering::Acquire); + let generation_applied = self + .applied_interface_peers_generation + .load(Ordering::Acquire) + == current_generation; + if generation_applied { + let need_periodic_requery = self + .interface + .lock() + .await + .as_ref() + .map(|x| x.need_periodic_requery_peers()) + .unwrap_or(false); + let snapshot = self.cached_interface_peer_snapshot.lock().unwrap().clone(); + let need_peer_relay_metadata = self.peer_relay_projection_enabled() + && snapshot.public_keys.len() != snapshot.peers.len(); + if !need_periodic_requery && !need_peer_relay_metadata { + return self.reconcile_my_conn_info(&snapshot, false); + } + + self.mark_interface_peers_dirty(); + } + + let snapshot = self.interface_peer_snapshot().await; + let generation = snapshot.generation; + let interface_snapshot_changed = { + let mut applied_peers = self.applied_interface_peers.lock().unwrap(); + if *applied_peers == snapshot.peers { + false + } else { + *applied_peers = snapshot.peers.clone(); + true + } + }; + let updated = self.reconcile_my_conn_info(&snapshot, interface_snapshot_changed); + self.applied_interface_peers_generation + .store(generation, Ordering::Release); + updated + } + + async fn update_my_foreign_network(&self) -> bool { + let last_time = self.last_update_my_foreign_network.load(); + if last_time.is_some() + && last_time.unwrap().elapsed().as_secs() + < self.context.ospf_update_my_foreign_network_interval_sec() + { + return false; + } + + self.last_update_my_foreign_network + .store(Some(Instant::now())); + + let foreign_networks = self + .interface + .lock() + .await + .as_ref() + .unwrap() + .list_foreign_networks() + .await; + + // do not need update owner map because we always filter out my peer id. + + self.synced_route_info + .update_my_foreign_network(self.my_peer_id, foreign_networks) + } + + fn local_route_snapshot(&self) -> OspfRouteSnapshot { + let mut snapshot = self.synced_route_info.route_snapshot(); + if !self.peer_relay_projection_enabled() + && !self.self_conn_info_withdrawn.load(Ordering::Acquire) + { + return snapshot; + } + + let local_connected_peers = self + .cached_interface_peer_snapshot + .lock() + .unwrap() + .peers + .clone(); + if let Some(self_row) = snapshot + .conn_map + .iter_mut() + .find(|row| row.peer_id == self.my_peer_id) + { + self_row.connected_peers = local_connected_peers; + } + snapshot + } + + fn update_route_table(&self) { + self.cost_calculator + .write() + .unwrap() + .as_mut() + .unwrap() + .begin_update(); + + let calc_locked = self.cost_calculator.read().unwrap(); + let route_snapshot = self.local_route_snapshot(); + + self.route_table.build_from_snapshot( + self.my_peer_id, + &route_snapshot, + NextHopPolicy::LeastHop, + calc_locked.as_ref().unwrap(), + ); + + self.route_table_with_cost.build_from_snapshot( + self.my_peer_id, + &route_snapshot, + NextHopPolicy::LeastCost, + calc_locked.as_ref().unwrap(), + ); + + drop(calc_locked); + + self.cost_calculator + .write() + .unwrap() + .as_mut() + .unwrap() + .end_update(); + } + + fn update_foreign_network_owner_map(&self) { + self.foreign_network_my_peer_id_map.clear(); + self.foreign_network_owner_map.clear(); + for item in self.synced_route_info.foreign_network.iter() { + let key = item.key(); + let entry = item.value(); + if key.peer_id == self.my_peer_id + || !self.route_table.peer_reachable(key.peer_id) + || entry.foreign_peer_ids.is_empty() + { + continue; + } + let network_identity = CoreNetworkIdentity { + network_name: key.network_name.clone(), + network_secret: None, + network_secret_digest: Some( + entry + .network_secret_digest + .clone() + .try_into() + .unwrap_or_default(), + ), + }; + self.foreign_network_owner_map + .entry(network_identity) + .or_default() + .push(entry.my_peer_id_for_this_network); + + self.foreign_network_my_peer_id_map.insert( + (key.network_name.clone(), entry.my_peer_id_for_this_network), + key.peer_id, + ); + } + } + + fn cost_calculator_need_update(&self) -> bool { + self.cost_calculator + .read() + .unwrap() + .as_ref() + .map(|x| x.need_update()) + .unwrap_or(false) + } + + fn handle_peer_context_event(&self, _event: &PeerContextEvent) { + self.mark_interface_peers_dirty(); + } + + fn update_route_table_and_cached_local_conn_bitmap(&self) { + self.update_peer_info_last_update(); + + // update route table first because we want to filter out unreachable peers. + self.update_route_table(); + + let synced_version = self.synced_route_info.version.get(); + + // the conn_bitmap should contain complete list of directly connected peers. + // use union of dst peers can preserve this property. + let mut all_peer_ids: BTreeMap = BTreeMap::new(); + let mut add_to_all_peer_ids = |peer_id: PeerId, version: Version| { + all_peer_ids + .entry(peer_id) + .and_modify(|x| { + if *x < version { + *x = version; + } + }) + .or_insert(version); + }; + for item in self.synced_route_info.conn_map.read().iter() { + let src_peer_id = *item.0; + if !self.route_table.topology_peer_reachable(src_peer_id) { + continue; + } + add_to_all_peer_ids(src_peer_id, item.1.version.get()); + for dst_peer_id in item.1.connected_peers.iter() { + add_to_all_peer_ids(*dst_peer_id, 0); + } + } + + let mut conn_bitmap = RouteConnBitmap { + bitmap: vec![0; (all_peer_ids.len() * all_peer_ids.len()).div_ceil(8)], + peer_ids: all_peer_ids + .iter() + .map(|x| PeerIdVersion { + peer_id: *x.0, + version: *x.1, + }) + .collect(), + }; + + let locked_conn_map = self.synced_route_info.conn_map.read(); + let all_peer_ids = &conn_bitmap.peer_ids; + for (peer_idx, peer_id_version) in all_peer_ids.iter().enumerate() { + let Some(connected) = locked_conn_map.get(&peer_id_version.peer_id) else { + continue; + }; + + for (idx, other_peer_id_version) in all_peer_ids.iter().enumerate() { + if connected + .connected_peers + .contains(&other_peer_id_version.peer_id) + { + let bit_idx = peer_idx * all_peer_ids.len() + idx; + conn_bitmap.bitmap[bit_idx / 8] |= 1 << (bit_idx % 8); + } + } + } + drop(locked_conn_map); + + let mut locked = self.cached_local_conn_map.lock().unwrap(); + if self + .cached_local_conn_map_version + .set_if_larger(synced_version) + { + *locked = conn_bitmap; + } + } + + fn collect_missing_peer_ids( + &self, + session: &SyncRouteSession, + conn_info: Option<&ConnInfo>, + from_is_credential: bool, + untrusted_peers: &[PeerId], + ) -> (Vec, Vec) { + let mut missing = session.missing_peer_ids.lock(); + match conn_info { + Some(ConnInfo::ConnBitmap(bitmap)) => { + missing.extend(bitmap.peer_ids.iter().map(|p| p.peer_id)); + } + Some(ConnInfo::ConnPeerList(list)) => { + for row in &list.peer_conn_infos { + if let Some(peer) = row.peer_id { + missing.insert(peer.peer_id); + missing.extend(row.connected_peer_ids.iter().copied()); + } + } + } + None => {} + } + if missing.is_empty() { + return (Vec::new(), Vec::new()); + } + + let mut missing_peer_ids = Vec::new(); + let mut missing_conn_peer_ids = Vec::new(); + let peer_infos = self.synced_route_info.peer_infos.read(); + let conn_map = self.synced_route_info.conn_map.read(); + missing.retain(|peer_id| { + if *peer_id == self.my_peer_id + || (from_is_credential && *peer_id != session.dst_peer_id) + || untrusted_peers.contains(peer_id) + { + return false; + } + let info = peer_infos.get(peer_id); + let conn = conn_map.get(peer_id); + // GC and trust rejection remove both records. Do not resurrect them + // unless a later accepted topology update references this peer again. + if info.is_none() && conn.is_none() { + return false; + } + let missing_info = info.is_none_or(|p| p.version == 0); + // Non-relaying credential nodes do not advertise connection rows. + let needs_conn = info.is_none_or(|p| { + !SyncedRouteInfo::is_credential_peer_info(p) + || self + .synced_route_info + .get_credential_info_by_pubkey(&p.noise_static_pubkey) + .is_some_and(|credential| credential.allow_relay) + }); + let missing_conn = needs_conn && conn.is_none_or(|c| c.version.get() == 0); + if missing_info { + missing_peer_ids.push(*peer_id); + } + if missing_conn { + missing_conn_peer_ids.push(*peer_id); + } + missing_info || missing_conn + }); + (missing_peer_ids, missing_conn_peer_ids) + } + + // Called with the session lock held, after acknowledging the outgoing data. + fn request_missing_peer_infos( + &self, + session: &SyncRouteSession, + response: &SyncRouteInfoResponse, + ) { + if response.missing_peer_ids.is_empty() && response.missing_conn_peer_ids.is_empty() { + return; + } + let peer_infos = self.synced_route_info.peer_infos.read(); + let mut pending = session.unreachable_peers_for_peer_info.lock(); + let conn_map = self.synced_route_info.conn_map.read(); + let mut pending_conn = session.unreachable_peers_for_conn_info.lock(); + for peer_id in &response.missing_peer_ids { + if *peer_id == session.dst_peer_id { + continue; + } + let Some(info) = peer_infos.get(peer_id).filter(|p| p.version != 0) else { + continue; + }; + // Invalidate only this peer's acknowledgement. The existing pending + // paths bypass the time cursor and retry until a sync succeeds. + session.dst_saved_peer_info_versions.remove(peer_id); + pending.insert(*peer_id, info.version); + } + for peer_id in &response.missing_conn_peer_ids { + if *peer_id == session.dst_peer_id { + continue; + } + if let Some(conn) = conn_map.get(peer_id).filter(|c| c.version.get() != 0) { + session.dst_saved_conn_info_version.remove(peer_id); + pending_conn.insert(*peer_id, conn.version.get()); + } + } + } + + fn build_route_info(&self, session: &SyncRouteSession) -> Option> { + let mut route_infos = Vec::new(); + let mut included_peer_ids = HashSet::new(); + let peer_infos = self.synced_route_info.peer_infos.read(); + let mut unreachable_peers_for_peer_info = session.unreachable_peers_for_peer_info.lock(); + let last_sync_succ_timestamp = session.last_sync_succ_timestamp.load(); + for (peer_id, peer_info) in peer_infos.iter().rev() { + // stop iter if last_update of peer info is older than session.last_sync_succ_timestamp + if let Some(last_update) = peer_info.last_update { + let last_update = SystemTime::try_from(last_update).unwrap(); + if last_sync_succ_timestamp.is_some_and(|t| last_update < t) { + break; + } + } + + if session.check_saved_peer_info_update_to_date(peer_info.peer_id, peer_info.version) { + continue; + } + + // do not send unreachable peer info to dst peer. + if !self.route_table.topology_peer_reachable(*peer_id) { + unreachable_peers_for_peer_info.insert(*peer_id, peer_info.version); + continue; + } + + included_peer_ids.insert(*peer_id); + route_infos.push(peer_info.clone()); + } + + unreachable_peers_for_peer_info.retain(|peer_id, version| { + if session.check_saved_peer_info_update_to_date(*peer_id, *version) { + // if saved peer info is up-to-date, forget this peer id. + return false; + } + let Some(peer_info) = peer_infos.get(peer_id) else { + // if not found in peer info map, forget this peer id. + return false; + }; + + if self.route_table.topology_peer_reachable(*peer_id) + && included_peer_ids.insert(*peer_id) + { + route_infos.push(peer_info.clone()); + } + + // this round rpc may fail, so keep it and remove the id only when it's in dst_saved_map + true + }); + + if route_infos.is_empty() { + None + } else { + Some(route_infos) + } + } + + fn build_conn_peer_list( + &self, + session: &SyncRouteSession, + estimated_size: &mut usize, + ) -> Option { + let last_sync_succ_timestamp = session.last_sync_succ_timestamp.load(); + let mut peer_conn_infos = Vec::new(); + let mut included_peer_ids = HashSet::new(); + *estimated_size = 0; + + let conn_map = self.synced_route_info.conn_map.read(); + let mut unreachable_peers_for_conn_info = session.unreachable_peers_for_conn_info.lock(); + + let mut add_to_conn_peer_list = |peer_id: PeerId, conn_info: &RouteConnInfo| { + if !included_peer_ids.insert(peer_id) { + return; + } + peer_conn_infos.push(PeerConnInfo { + peer_id: Some(PeerIdVersion { + peer_id, + version: conn_info.version.get(), + }), + connected_peer_ids: conn_info.connected_peers.iter().copied().collect(), + }); + *estimated_size += std::mem::size_of::() + + conn_info.connected_peers.len() * std::mem::size_of::(); + }; + + for (peer_id, conn_info) in conn_map.iter().rev() { + // stop iter if last_update of conn info is older than session.last_sync_succ_timestamp + let last_update = TryInto::::try_into(conn_info.last_update).unwrap(); + if last_sync_succ_timestamp.is_some_and(|t| last_update < t) { + break; + } + + if session.check_saved_conn_version_update_to_date(*peer_id, conn_info.version.get()) { + continue; + } + + if !self.route_table.topology_peer_reachable(*peer_id) { + unreachable_peers_for_conn_info.insert(*peer_id, conn_info.version.get()); + continue; + } + + add_to_conn_peer_list(*peer_id, conn_info); + } + + unreachable_peers_for_conn_info.retain(|peer_id, version| { + if session.check_saved_conn_version_update_to_date(*peer_id, *version) { + // if saved conn info is up-to-date, forget this peer id. + return false; + } + let Some(conn_info) = conn_map.get(peer_id) else { + // if not found in peer info map, forget this peer id. + return false; + }; + + if self.route_table.topology_peer_reachable(*peer_id) { + add_to_conn_peer_list(*peer_id, conn_info); + } + + // this round rpc may fail, so keep it and remove the id only when it's in dst_saved_map + true + }); + + if peer_conn_infos.is_empty() { + return None; + } + + Some(RouteConnPeerList { peer_conn_infos }) + } + + fn build_conn_bitmap(&self) -> RouteConnBitmap { + self.cached_local_conn_map.lock().unwrap().clone() + } + + fn estimate_conn_bitmap_size(&self) -> usize { + let cached_conn_map = self.cached_local_conn_map.lock().unwrap(); + cached_conn_map.bitmap.len() + + (cached_conn_map.peer_ids.len() * std::mem::size_of::()) + } + + fn build_foreign_network_info( + &self, + session: &SyncRouteSession, + ) -> Option { + let mut foreign_networks = RouteForeignNetworkInfos::default(); + for item in self.synced_route_info.foreign_network.iter() { + if session.check_saved_foreign_network_version_update_to_date( + item.key(), + item.value().version, + ) { + continue; + } + + foreign_networks + .infos + .push(route_foreign_network_infos::Info { + key: Some(item.key().clone()), + value: Some(item.value().clone()), + }); + } + + if foreign_networks.infos.is_empty() { + None + } else { + Some(foreign_networks) + } + } + + async fn update_my_infos(&self) -> bool { + let my_peer_info_updated = self.update_my_peer_info(); + let my_conn_info_updated = self.update_my_conn_info().await; + let my_foreign_network_updated = self.update_my_foreign_network().await; + let mut untrusted_changed = false; + if my_peer_info_updated || my_conn_info_updated { + untrusted_changed = self.refresh_credential_trusts_and_disconnect().await; + } + + let mut public_ipv6_state_updated = false; + if my_peer_info_updated || my_conn_info_updated || untrusted_changed { + self.update_route_table_and_cached_local_conn_bitmap(); + self.update_foreign_network_owner_map(); + public_ipv6_state_updated = self.notify_public_ipv6_route_change(); + } + if my_peer_info_updated { + self.update_peer_info_last_update(); + } + my_peer_info_updated + || my_conn_info_updated + || my_foreign_network_updated + || public_ipv6_state_updated + } + + async fn refresh_acl_groups(&self) -> bool { + let my_peer_info_updated = self.update_my_peer_info(); + let trust_admin_groups_without_proof = + self.context.network_identity().network_secret.is_none(); + + self.synced_route_info + .verify_and_update_all_current_group_trusts( + &self.context.acl_group_declarations(), + trust_admin_groups_without_proof, + ); + + let untrusted = self.refresh_credential_trusts_with_current_topology(); + self.disconnect_untrusted_peers(&untrusted).await; + + let mut public_ipv6_state_updated = false; + if my_peer_info_updated || !untrusted.is_empty() { + self.update_route_table_and_cached_local_conn_bitmap(); + self.update_foreign_network_owner_map(); + public_ipv6_state_updated = self.notify_public_ipv6_route_change(); + } + if my_peer_info_updated { + self.update_peer_info_last_update(); + } + + my_peer_info_updated || !untrusted.is_empty() || public_ipv6_state_updated + } + + fn refresh_credential_trusts(&self) -> Vec { + let network_identity = self.context.network_identity(); + let (untrusted, global_trusted_keys, _) = self + .synced_route_info + .verify_and_update_credential_trusts_with_active_peers_protecting( + network_identity.network_secret.as_deref(), + |_| true, + Some(self.my_peer_id), + ); + PeerContext::update_trusted_keys( + self.context.as_ref(), + global_trusted_keys, + &network_identity.network_name, + ); + + untrusted + } + + fn refresh_credential_trusts_with_current_topology(&self) -> Vec { + let network_identity = self.context.network_identity(); + + // Non-reusable credential owner election depends on reachability, so rebuild the + // route table from the latest synced peer/conn state before checking active peers. + self.update_route_table_and_cached_local_conn_bitmap(); + + let (untrusted, global_trusted_keys, suppressed_changed) = self + .synced_route_info + .verify_and_update_credential_trusts_with_active_peers_protecting( + network_identity.network_secret.as_deref(), + |peer_id| { + peer_id == self.my_peer_id || self.route_table.topology_peer_reachable(peer_id) + }, + Some(self.my_peer_id), + ); + PeerContext::update_trusted_keys( + self.context.as_ref(), + global_trusted_keys, + &network_identity.network_name, + ); + + if !untrusted.is_empty() || suppressed_changed { + self.update_route_table_and_cached_local_conn_bitmap(); + } + untrusted + } + + async fn refresh_credential_trusts_and_disconnect(&self) -> bool { + let untrusted = self.refresh_credential_trusts_with_current_topology(); + self.disconnect_untrusted_peers(&untrusted).await; + !untrusted.is_empty() + } + + async fn disconnect_untrusted_peers(&self, untrusted_peers: &[PeerId]) { + if untrusted_peers.is_empty() { + return; + } + + let interface = self.interface.lock().await; + let Some(interface) = interface.as_ref() else { + return; + }; + + for peer_id in untrusted_peers { + tracing::warn!(?peer_id, "disconnecting untrusted peer"); + interface.close_peer(*peer_id).await; + } + } + + fn build_sync_request( + &self, + session: &SyncRouteSession, + dst_peer_id: PeerId, + ) -> ( + Option>, + Option, + Option, + ) { + let route_infos = self.build_route_info(session); + let conn_info = self.build_conn_info(session, dst_peer_id); + let foreign_network = self.build_foreign_network_info(session); + + (route_infos, conn_info, foreign_network) + } + + fn build_conn_info( + &self, + session: &SyncRouteSession, + dst_peer_id: PeerId, + ) -> Option { + // Check if destination peer supports selective peer list sync + let dst_supports_peer_list = self + .synced_route_info + .peer_infos + .read() + .get(&dst_peer_id) + .and_then(|p| p.feature_flag) + .map(|x| x.support_conn_list_sync) + .unwrap_or(false) + || FORCE_USE_CONN_LIST.load(Ordering::Relaxed); + + // Both formats are supported, choose the more efficient one + let mut conn_list_estimated_size = 0; + let peer_list = self.build_conn_peer_list(session, &mut conn_list_estimated_size)?; + let bitmap_size = self.estimate_conn_bitmap_size(); + + if conn_list_estimated_size < bitmap_size && dst_supports_peer_list { + Some(peer_list.into()) + } else { + Some(self.build_conn_bitmap().into()) + } + } + + async fn clear_expired_peer(&self) { + let now = SystemTime::now(); + let mut to_remove = Vec::new(); + for (peer_id, peer_info) in self.synced_route_info.peer_infos.read().iter() { + if let Ok(d) = now.duration_since(peer_info.last_update.unwrap().try_into().unwrap()) + && (d > REMOVE_DEAD_PEER_INFO_AFTER + || (d > REMOVE_UNREACHABLE_PEER_INFO_AFTER + && !self.route_table.topology_peer_reachable(*peer_id))) + { + to_remove.push(*peer_id); + } + } + + self.synced_route_info + .remove_peers(to_remove.iter().copied()); + + // clear expired foreign network info + let mut to_remove = Vec::new(); + for item in self.synced_route_info.foreign_network.iter() { + let Some(since_last_update) = item + .value() + .last_update + .and_then(|x| SystemTime::try_from(x).ok()) + .and_then(|x| now.duration_since(x).ok()) + else { + to_remove.push(item.key().clone()); + continue; + }; + + if since_last_update > REMOVE_DEAD_PEER_INFO_AFTER { + to_remove.push(item.key().clone()); + } + } + + for p in to_remove.iter() { + self.synced_route_info.foreign_network.remove(p); + } + + self.refresh_credential_trusts_and_disconnect().await; + self.route_table.clean_expired_route_info(); + self.route_table_with_cost.clean_expired_route_info(); + } + + fn build_sync_route_raw_req( + req: &SyncRouteInfoRequest, + raw_peer_infos: &DashMap, + ) -> Result, route_peer_wire::WireError> { + let infos = req + .peer_infos + .as_ref() + .map(|peer_infos| { + peer_infos + .items + .iter() + .map(|peer_info| { + raw_peer_infos + .get(&peer_info.peer_id) + .map(|raw| raw.clone()) + .unwrap_or_else(|| raw_route_peer_info(peer_info)) + }) + .collect::>() + }) + .unwrap_or_default(); + route_peer_wire::encode_sync_route_request(req, &infos) + } + + async fn sync_route_with_peer( + &self, + dst_peer_id: PeerId, + peer_rpc: Arc, + sync_as_initiator: bool, + ) -> bool { + let Some(session) = self.get_session(dst_peer_id) else { + // if session not exist, exit the sync loop. + return true; + }; + + let _session_lock = session.lock.lock(); + + let my_peer_id = self.my_peer_id; + + let next_last_sync_succ_timestamp = + self.synced_route_info.get_next_last_sync_succ_timestamp(); + let request_snapshot = session.request_snapshot_locked(); + let expected_dst_session_id = session.dst_session_id.load(Ordering::Relaxed); + let (peer_infos, conn_info, foreign_network) = + self.build_sync_request(&session, dst_peer_id); + if peer_infos.is_none() + && conn_info.is_none() + && foreign_network.is_none() + && !session.need_sync_initiator_info.load(Ordering::Relaxed) + && !(sync_as_initiator && session.we_are_initiator.load(Ordering::Relaxed)) + { + return true; + } + + tracing::debug!( + ?foreign_network, + "sync_route request need send to peer. my_id {:?}, dst_peer_id: {:?}, peer_infos: {:?}, conn_info: {:?}, synced_route_info: {:?} session: {:?}", + my_peer_id, + dst_peer_id, + peer_infos, + conn_info, + self.synced_route_info, + session + ); + + session + .need_sync_initiator_info + .store(false, Ordering::Relaxed); + + let rpc_stub = peer_rpc + .rpc_client() + .scoped_client::>( + self.my_peer_id, + dst_peer_id, + self.context.network_name(), + ); + + let sync_route_info_req = SyncRouteInfoRequest { + my_peer_id, + my_session_id: request_snapshot.my_session_id, + is_initiator: request_snapshot.is_initiator, + peer_infos: peer_infos.clone().map(|x| RoutePeerInfos { items: x }), + conn_info: conn_info.clone(), + foreign_network_infos: foreign_network.clone(), + }; + + let mut ctrl = BaseController::default(); + ctrl.set_timeout_ms(3000); + let raw_request = match Self::build_sync_route_raw_req( + &sync_route_info_req, + &self.synced_route_info.raw_peer_infos, + ) { + Ok(raw_request) => raw_request, + Err(error) => { + tracing::error!(?error, "failed to encode raw OSPF route request"); + return false; + } + }; + ctrl.set_raw_input(raw_request.into()); + + drop(_session_lock); + let ret = rpc_stub + .sync_route_info(ctrl, SyncRouteInfoRequest::default()) + .await; + let _session_lock = session.lock.lock(); + + tracing::debug!( + "sync_route_info resp: {:?}, req: {:?}, session: {:?}, my_info: {:?}, next_last_sync_succ_timestamp: {:?}", + ret, + sync_route_info_req, + session, + self.context.network_identity(), + next_last_sync_succ_timestamp + ); + + if !self.sync_request_is_current_locked(dst_peer_id, &session, request_snapshot) { + tracing::debug!( + ?my_peer_id, + ?dst_peer_id, + ?request_snapshot, + "discard stale route sync response" + ); + return false; + } + + match ret.as_ref() { + Err(e) => { + tracing::error!( + ?ret, + ?my_peer_id, + ?dst_peer_id, + ?e, + "sync_route_info failed" + ); + session + .need_sync_initiator_info + .store(true, Ordering::Relaxed); + } + Ok(resp) => { + if let Some(err) = resp.error { + if err == Error::Stopped as i32 && !sync_route_info_req.is_initiator { + let cleared = session.clear_dst_initiator_if_session_unchanged_locked( + expected_dst_session_id, + ); + tracing::debug!( + ?my_peer_id, + ?dst_peer_id, + ?cleared, + "stale non-initiator route sync rejected" + ); + } else if err == Error::DuplicatePeerId as i32 { + if !self.context.feature_flags().is_public_server { + panic!("duplicate peer id"); + } + } else { + tracing::error!(?ret, ?my_peer_id, ?dst_peer_id, "sync_route_info failed"); + session + .need_sync_initiator_info + .store(true, Ordering::Relaxed); + } + } else { + session.rpc_tx_count.fetch_add(1, Ordering::Relaxed); + session.last_contact_instant.store(Instant::now()); + + session.update_remote_state_locked(resp.session_id, resp.is_initiator); + + if let Some(peer_infos) = &peer_infos { + session.update_dst_saved_peer_info_version(peer_infos, dst_peer_id); + } + + if let Some(conn_info) = &conn_info { + session.update_dst_saved_conn_info_version(conn_info, dst_peer_id); + } + + if let Some(foreign_network) = &foreign_network { + session + .update_dst_saved_foreign_network_version(foreign_network, dst_peer_id); + } + session.update_last_sync_succ_timestamp(next_last_sync_succ_timestamp); + self.request_missing_peer_infos(&session, resp); + } + } + } + false + } + + fn update_peer_info_last_update(&self) { + tracing::debug!( + "update_peer_info_last_update, my_peer_id: {:?}, prev: {:?}, new: {:?}", + self.my_peer_id, + self.peer_info_last_update.load(), + Instant::now() + ); + self.peer_info_last_update.store(Instant::now()); + } + + fn get_peer_info_last_update(&self) -> Instant { + self.peer_info_last_update.load() + } + + fn get_peer_groups(&self, peer_id: PeerId) -> Arc> { + self.synced_route_info + .group_trust_map_cache + .get(&peer_id) + .map(|groups| groups.value().clone()) + .unwrap_or_default() + } + + fn clean_dst_saved_map(&self, dst_peer_id: PeerId) { + let Some(session) = self.get_session(dst_peer_id) else { + return; + }; + + session.clean_dst_saved_map(); + } +} + +impl Drop for PeerRouteServiceImpl { + fn drop(&mut self) { + tracing::debug!(?self, "drop PeerRouteServiceImpl"); + } +} + +#[derive(Clone)] +struct RouteSessionManager { + service_impl: Weak, + peer_rpc: Weak, + + sync_now_broadcast: tokio::sync::broadcast::Sender<()>, +} + +impl Debug for RouteSessionManager { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("RouteSessionManager") + .field("dump_sessions", &self.dump_sessions()) + .finish() + } +} + +#[async_trait::async_trait] +impl OspfRouteRpc for RouteSessionManager { + type Controller = BaseController; + async fn sync_route_info( + &self, + ctrl: BaseController, + request: SyncRouteInfoRequest, + ) -> Result { + let from_peer_id = request.my_peer_id; + let from_session_id = request.my_session_id; + let is_initiator = request.is_initiator; + let peer_infos = request.peer_infos.map(|x| x.items); + let conn_info = request.conn_info; + let foreign_network = request.foreign_network_infos; + let raw_peer_infos = if let Some(peer_infos_ref) = &peer_infos { + let raw_input = ctrl.get_raw_input().ok_or_else(|| { + rpc_types::error::Error::MalformatRpcPacket( + "OSPF route request is missing raw protobuf input".to_owned(), + ) + })?; + let r = extract_route_peer_infos(&raw_input).map_err(anyhow::Error::new)?; + let raw_matches_decoded = r.len() == peer_infos_ref.len() + && r.iter().zip(peer_infos_ref).all(|(raw, decoded)| { + RoutePeerInfo::decode(raw.clone()) + .map(|raw_decoded| raw_decoded.peer_id == decoded.peer_id) + .unwrap_or(false) + }); + if !raw_matches_decoded { + return Err(rpc_types::error::Error::MalformatRpcPacket( + "raw and decoded OSPF RoutePeerInfo values do not match".to_owned(), + )); + } + Some(r) + } else { + None + }; + + let ret = self + .do_sync_route_info( + from_peer_id, + from_session_id, + is_initiator, + peer_infos, + raw_peer_infos, + conn_info, + foreign_network, + ) + .await; + + Ok(match ret { + Ok(v) => v, + Err(e) => SyncRouteInfoResponse { + error: Some(e as i32), + ..Default::default() + }, + }) + } +} + +#[allow(dead_code)] +impl RouteSessionManager { + fn new(service_impl: Arc, peer_rpc: Arc) -> Self { + RouteSessionManager { + service_impl: Arc::downgrade(&service_impl), + peer_rpc: Arc::downgrade(&peer_rpc), + + sync_now_broadcast: tokio::sync::broadcast::channel(100).0, + } + } + + async fn session_task( + peer_rpc: Weak, + service_impl: Weak, + dst_peer_id: PeerId, + mut sync_now: tokio::sync::broadcast::Receiver<()>, + ) { + const RETRY_BASE_MS: u64 = 50; + const RETRY_MAX_MS: u64 = 5000; + + let mut last_sync = Instant::now(); + let mut last_clean_dst_saved_map = Instant::now(); + // Keep retry_delay_ms across outer iterations so that rapid + // connect/disconnect flaps don't fully reset the backoff. + let mut retry_delay_ms = RETRY_BASE_MS; + loop { + loop { + let Some(service_impl) = service_impl.clone().upgrade() else { + return; + }; + + let Some(peer_rpc) = peer_rpc.clone().upgrade() else { + return; + }; + + // if we are initiator, we should ensure the dst has the session. + let sync_as_initiator = if last_sync.elapsed().as_secs() > 10 { + last_sync = Instant::now(); + true + } else { + false + }; + + if service_impl + .sync_route_with_peer(dst_peer_id, peer_rpc.clone(), sync_as_initiator) + .await + { + if last_clean_dst_saved_map.elapsed().as_secs() > 60 { + last_clean_dst_saved_map = Instant::now(); + service_impl.clean_dst_saved_map(dst_peer_id); + } + // Successful sync: decay backoff towards base so the next + // real failure still starts at a reasonable level, but + // don't fully reset to avoid 50ms bursts during flapping. + retry_delay_ms = (retry_delay_ms / 2).max(RETRY_BASE_MS); + break; + } + + drop(service_impl); + drop(peer_rpc); + + crate::foundation::time::sleep(Duration::from_millis(retry_delay_ms)).await; + retry_delay_ms = (retry_delay_ms * 2).min(RETRY_MAX_MS); + } + + sync_now = sync_now.resubscribe(); + + select! { + _ = crate::foundation::time::sleep(Duration::from_secs(1)) => {} + ret = sync_now.recv() => if let Err(e) = ret { + tracing::debug!(?e, "session_task sync_now recv failed, ospf route may exit"); + break; + } + } + } + } + + fn stop_session(&self, peer_id: PeerId) -> Result<(), Error> { + tracing::warn!(?peer_id, "stop ospf sync session"); + let Some(service_impl) = self.service_impl.upgrade() else { + return Err(Error::Stopped); + }; + service_impl.remove_session(peer_id); + Ok(()) + } + + fn start_session_task(&self, session: &SyncRouteSession) { + if !session.task.is_running() { + session.task.set_task(tokio::spawn(Self::session_task( + self.peer_rpc.clone(), + self.service_impl.clone(), + session.dst_peer_id, + self.sync_now_broadcast.subscribe(), + ))); + } + } + + fn get_or_start_session(&self, peer_id: PeerId) -> Result, Error> { + let Some(service_impl) = self.service_impl.upgrade() else { + return Err(Error::Stopped); + }; + if service_impl.stopped.load(Ordering::Acquire) { + return Err(Error::Stopped); + } + + tracing::info!(?service_impl.my_peer_id, ?peer_id, "start ospf sync session"); + + let session = service_impl.get_or_create_session(peer_id); + self.start_session_task(&session); + Ok(session) + } + + async fn maintain_sessions(&self, service_impl: Arc) -> bool { + let mut cur_dst_peer_id_to_initiate = None; + let mut next_sleep_ms = 0; + loop { + let mut recv = self.sync_now_broadcast.subscribe(); + select! { + _ = crate::foundation::time::sleep(Duration::from_millis(next_sleep_ms)) => {} + _ = recv.recv() => {} + } + + let interface_snapshot = service_impl.interface_peer_snapshot().await; + let peers = &interface_snapshot.peers; + let session_peers = self.list_session_peer_set(); + for peer_id in session_peers.iter() { + if !peers.contains(peer_id) { + if Some(*peer_id) == cur_dst_peer_id_to_initiate { + cur_dst_peer_id_to_initiate = None; + } + let _ = self.stop_session(*peer_id); + } + } + + // Detect responder sessions whose initiator silently lost the + // session (e.g. restarted and elected someone else). Without + // this, a responder with no new route data could wait forever + // for an initiator that no longer syncs with us. Clearing the + // stale role makes the peer an initiator candidate again below. + for peer_id in session_peers.iter() { + if let Some(session) = service_impl.get_session(*peer_id) + && session.clear_stale_dst_initiator() + { + tracing::warn!( + ?peer_id, + my_peer_id = ?service_impl.my_peer_id, + "initiator route sync liveness timeout, clearing stale initiator role" + ); + } + } + + // find peer_ids that are not initiators. + let mut initiator_candidates = Vec::new(); + for peer_id in peers.iter().copied() { + // Step 9a: Filter OSPF session candidates based on direct auth level. + // - Credential nodes only initiate sessions to admin nodes (not other credential nodes) + // - Admin nodes don't initiate sessions to credential nodes + let identity_type = interface_snapshot + .identity_types + .get(&peer_id) + .copied() + .flatten() + .unwrap_or(PeerIdentityType::Admin); + if matches!(identity_type, PeerIdentityType::Credential) { + continue; + } + + let Some(session) = service_impl.get_session(peer_id) else { + initiator_candidates.push(peer_id); + continue; + }; + + if !session.dst_is_initiator.load(Ordering::Relaxed) { + initiator_candidates.push(peer_id); + } + } + + if initiator_candidates.is_empty() { + next_sleep_ms = 1000; + continue; + } + + let mut new_initiator_dst = None; + // if any peer has NoPAT or OpenInternet stun type, we should use it. + for peer_id in initiator_candidates.iter() { + let Some(nat_type) = service_impl.route_table.get_udp_nat_type(*peer_id) else { + continue; + }; + if nat_type == NatType::NoPat || nat_type == NatType::OpenInternet { + new_initiator_dst = Some(*peer_id); + break; + } + } + if new_initiator_dst.is_none() { + new_initiator_dst = Some(*initiator_candidates.first().unwrap()); + } + + if new_initiator_dst != cur_dst_peer_id_to_initiate { + tracing::warn!( + "new_initiator: {:?}, prev: {:?}, my_id: {:?}", + new_initiator_dst, + cur_dst_peer_id_to_initiate, + service_impl.my_peer_id + ); + // update initiator flag for previous session + if let Some(cur_peer_id_to_initiate) = cur_dst_peer_id_to_initiate + && let Some(session) = service_impl.get_session(cur_peer_id_to_initiate) + { + session.update_initiator_flag(false); + } + + cur_dst_peer_id_to_initiate = new_initiator_dst; + // update initiator flag for new session + let Ok(session) = self.get_or_start_session(new_initiator_dst.unwrap()) else { + tracing::warn!("get_or_start_session failed"); + continue; + }; + session.update_initiator_flag(true); + self.sync_now("update_initiator_flag"); + } + + // clear sessions that are neither dst_initiator or we_are_initiator. + for peer_id in session_peers.iter() { + if let Some(session) = service_impl.get_session(*peer_id) { + if (session.dst_is_initiator.load(Ordering::Relaxed) + || session.we_are_initiator.load(Ordering::Relaxed) + || session.need_sync_initiator_info.load(Ordering::Relaxed)) + && session.task.is_running() + { + continue; + } + let _ = self.stop_session(*peer_id); + } + } + + next_sleep_ms = 1000; + } + } + + fn list_session_peers(&self) -> Vec { + let Some(service_impl) = self.service_impl.upgrade() else { + return vec![]; + }; + + service_impl.list_session_peers() + } + + fn list_session_peer_set(&self) -> BTreeSet { + let Some(service_impl) = self.service_impl.upgrade() else { + return BTreeSet::new(); + }; + + service_impl.list_session_peers().into_iter().collect() + } + + fn dump_sessions(&self) -> Result { + let Some(service_impl) = self.service_impl.upgrade() else { + return Err(Error::Stopped); + }; + + let mut ret = format!("my_peer_id: {:?}\n", service_impl.my_peer_id); + for item in service_impl.sessions.iter() { + ret += format!( + " session: {}, {}\n", + item.key(), + item.value().short_debug_string() + ) + .as_str(); + } + + Ok(ret.to_string()) + } + + fn sync_now(&self, reason: &str) { + let ret = self.sync_now_broadcast.send(()); + tracing::debug!(?ret, ?reason, "sync_now_broadcast.send"); + } + + fn extract_credential_peer_info( + &self, + from_peer_id: PeerId, + peer_infos: &[RoutePeerInfo], + raw_peer_infos: &[RawRoutePeerInfo], + credential: &TrustedCredentialPubkey, + ) -> Option<(RoutePeerInfo, RawRoutePeerInfo)> { + let info_idx = peer_infos.iter().position(|p| p.peer_id == from_peer_id)?; + let mut info = peer_infos[info_idx].clone(); + let raw_info = raw_peer_infos[info_idx].clone(); + let allowed_cidrs = &credential.allowed_proxy_cidrs; + // Filter proxy_cidrs to only those allowed by credential + if !allowed_cidrs.is_empty() { + info.proxy_cidrs.retain(|cidr| { + allowed_cidrs + .iter() + .any(|allowed| cidr_is_subset_str(cidr, allowed)) + }); + } else { + // No allowed_proxy_cidrs → no proxy_cidrs allowed + info.proxy_cidrs.clear(); + } + SyncedRouteInfo::mark_credential_peer(&mut info, true); + let raw_info = patch_credential_route_peer_info(&raw_info, &info.proxy_cidrs).ok()?; + Some((info, raw_info)) + } + + #[allow(clippy::too_many_arguments)] + async fn do_sync_route_info( + &self, + from_peer_id: PeerId, + from_session_id: SessionId, + is_initiator: bool, + peer_infos: Option>, + raw_peer_infos: Option>, + conn_info: Option, + foreign_network: Option, + ) -> Result { + let Some(service_impl) = self.service_impl.upgrade() else { + return Err(Error::Stopped); + }; + let _session_operation = service_impl.session_operation.read().await; + if service_impl.stopped.load(Ordering::Acquire) { + return Err(Error::Stopped); + } + + let my_peer_id = service_impl.my_peer_id; + let session = if let Some(session) = service_impl.get_session(from_peer_id) { + session + } else if is_initiator { + self.get_or_start_session(from_peer_id)? + } else { + tracing::debug!( + ?from_peer_id, + "ignore stale route sync from non-initiator without a session" + ); + return Err(Error::Stopped); + }; + + let from_identity_type = service_impl + .get_peer_identity_type_from_interface(from_peer_id) + .await + .unwrap_or(PeerIdentityType::Admin); + let from_is_credential = matches!(from_identity_type, PeerIdentityType::Credential); + let credential_info = if from_is_credential { + service_impl + .get_peer_public_key_from_interface(from_peer_id) + .await + .and_then(|pubkey| { + service_impl + .synced_route_info + .get_credential_info_by_pubkey(&pubkey) + }) + } else { + None + }; + if from_is_credential && credential_info.is_none() { + // no credential found + return Err(Error::Stopped); + } + + let _session_lock = session.lock.lock(); + + if !service_impl.is_current_session(from_peer_id, &session) + || !session.admit_inbound_locked(from_session_id, is_initiator) + { + tracing::debug!( + ?from_peer_id, + ?from_session_id, + ?is_initiator, + "ignore route sync from a stale session generation" + ); + return Err(Error::Stopped); + } + + session.rpc_rx_count.fetch_add(1, Ordering::Relaxed); + session.last_contact_instant.store(Instant::now()); + + let mut need_update_route_table = false; + let mut untrusted_peers = Vec::new(); + let mut accepted_conn_info = None; + + if let Some(peer_infos) = &peer_infos { + // Step 9b: credential peers can only propagate their own route info + let (pi, rpi) = if from_is_credential { + if let Some(ret) = self.extract_credential_peer_info( + from_peer_id, + peer_infos, + raw_peer_infos.as_deref().unwrap(), + credential_info.as_ref().unwrap(), + ) { + (&vec![ret.0], &vec![ret.1]) + } else { + (&vec![], &vec![]) + } + } else { + (peer_infos, raw_peer_infos.as_ref().unwrap()) + }; + if !pi.is_empty() { + let trust_admin_groups_without_proof = service_impl + .context + .network_identity() + .network_secret + .is_none(); + service_impl.synced_route_info.update_peer_infos( + my_peer_id, + service_impl.my_peer_route_id, + from_peer_id, + pi, + rpi, + )?; + service_impl + .synced_route_info + .verify_and_update_current_group_trusts( + pi, + &service_impl.context.acl_group_declarations(), + trust_admin_groups_without_proof, + ); + session.update_dst_saved_peer_info_version(pi, from_peer_id); + need_update_route_table = true; + } + } + + // Step 9b: credential peers' conn_info depends on allow_relay flag + if let Some(conn_info) = &conn_info { + let accept_conn_info = + !from_is_credential || credential_info.map(|tc| tc.allow_relay).unwrap_or(false); + if accept_conn_info { + service_impl.synced_route_info.update_conn_info(conn_info); + session.update_dst_saved_conn_info_version(conn_info, from_peer_id); + accepted_conn_info = Some(conn_info); + need_update_route_table = true; + } + } + + if need_update_route_table { + untrusted_peers = service_impl.refresh_credential_trusts_with_current_topology(); + } + + let mut foreign_network_changed = false; + if let Some(foreign_network) = &foreign_network { + // Step 9b: credential peers' foreign_network_infos are always ignored + if !from_is_credential { + foreign_network_changed = service_impl + .synced_route_info + .update_foreign_network(foreign_network); + session.update_dst_saved_foreign_network_version(foreign_network, from_peer_id); + } + } + + if need_update_route_table || foreign_network_changed { + service_impl.update_route_table_and_cached_local_conn_bitmap(); + service_impl.update_foreign_network_owner_map(); + if need_update_route_table + && let Some(public_ipv6_service) = service_impl.public_ipv6_service() + { + public_ipv6_service.handle_route_change(); + } + } + + tracing::debug!( + "handling sync_route_info rpc: from_peer_id: {:?}, is_initiator: {:?}, peer_infos: {:?}, conn_info: {:?}, synced_route_info: {:?} session: {:?}, new_route_table: {:?}", + from_peer_id, + is_initiator, + peer_infos, + conn_info, + service_impl.synced_route_info, + session, + service_impl.route_table + ); + + let is_initiator = session.we_are_initiator.load(Ordering::Relaxed); + let session_id = session.my_session_id.load(Ordering::Relaxed); + let (missing_peer_ids, missing_conn_peer_ids) = service_impl.collect_missing_peer_ids( + &session, + accepted_conn_info, + from_is_credential, + &untrusted_peers, + ); + + drop(_session_lock); + service_impl + .disconnect_untrusted_peers(&untrusted_peers) + .await; + + // Only trigger reverse sync when we actually received new data that + // needs to be propagated to other peers. Previously this was + // unconditional, which created an A→B→A→B ping-pong storm even when + // there was nothing new to propagate. + if need_update_route_table || foreign_network_changed { + self.sync_now("sync_route_info"); + } + + Ok(SyncRouteInfoResponse { + is_initiator, + session_id, + error: None, + missing_peer_ids, + missing_conn_peer_ids, + }) + } +} + +struct OspfPublicIpv6RouteHandle { + service_impl: Weak, +} + +impl PublicIpv6RouteControl for OspfPublicIpv6RouteHandle { + fn my_peer_id(&self) -> PeerId { + self.service_impl + .upgrade() + .map(|service_impl| service_impl.my_peer_id) + .unwrap_or_default() + } + + fn peer_route_snapshot(&self) -> Vec { + let Some(service_impl) = self.service_impl.upgrade() else { + return Vec::new(); + }; + + service_impl + .synced_route_info + .peer_infos + .read() + .iter() + .map(|(peer_id, info)| PublicIpv6PeerRouteInfo { + peer_id: *peer_id, + inst_id: route_peer_inst_id(info), + is_provider: info + .feature_flag + .as_ref() + .map(|flags| flags.ipv6_public_addr_provider) + .unwrap_or(false), + prefix: info + .ipv6_public_addr_prefix + .map(Into::into) + .map(|prefix: Ipv6Inet| prefix.network()), + lease: info.ipv6_public_addr_lease.map(Into::into), + reachable: *peer_id == service_impl.my_peer_id + || service_impl.route_table.peer_reachable(*peer_id), + }) + .collect() + } + + fn publish_self_public_ipv6_lease(&self, lease: Option) -> bool { + let Some(service_impl) = self.service_impl.upgrade() else { + return false; + }; + + let mut current = service_impl.self_public_ipv6_addr_lease.lock().unwrap(); + if *current == lease { + return false; + } + *current = lease; + drop(current); + + let changed = service_impl.update_my_peer_info(); + if changed { + service_impl.update_route_table_and_cached_local_conn_bitmap(); + service_impl.update_foreign_network_owner_map(); + } + changed + } +} + +#[derive(Clone)] +struct OspfPublicIpv6SyncTrigger { + session_mgr: RouteSessionManager, +} + +impl PublicIpv6SyncTrigger for OspfPublicIpv6SyncTrigger { + fn sync_now(&self, reason: &str) { + self.session_mgr.sync_now(reason); + } +} + +pub struct PeerRoute { + my_peer_id: PeerId, + context: ArcPeerContext, + peer_rpc: Weak, + + service_impl: Arc, + public_ipv6_service: Arc, + session_mgr: RouteSessionManager, + + tasks: std::sync::Mutex>, +} + +impl Debug for PeerRoute { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PeerRoute") + .field("my_peer_id", &self.my_peer_id) + .field("service_impl", &self.service_impl) + .field("session_mgr", &self.session_mgr) + .finish() + } +} + +impl PeerRoute { + pub(crate) async fn withdraw_self_conn_info(&self) -> bool { + if self.service_impl.stopped.load(Ordering::Acquire) { + return true; + } + if self.service_impl.interface.lock().await.is_none() { + return true; + } + + self.service_impl + .self_conn_info_withdrawn + .store(true, Ordering::Release); + self.service_impl.mark_interface_peers_dirty(); + let direct_peers = self.service_impl.interface_peer_snapshot().await; + self.service_impl.update_my_infos().await; + + let Some(conn_info_version) = self + .service_impl + .synced_route_info + .conn_map + .read() + .get(&self.my_peer_id) + .map(|info| info.version.get()) + else { + return false; + }; + let sessions = direct_peers + .peers + .iter() + .filter_map(|peer_id| { + self.service_impl + .get_session(*peer_id) + .map(|session| (*peer_id, session)) + }) + .collect::>(); + if sessions.is_empty() { + return true; + } + + let Some(peer_rpc) = self.peer_rpc.upgrade() else { + return false; + }; + let synchronized = crate::foundation::time::timeout(Duration::from_secs(1), async { + futures::future::join_all(sessions.iter().map(|(peer_id, _)| { + self.service_impl + .sync_route_with_peer(*peer_id, peer_rpc.clone(), false) + })) + .await; + + sessions.iter().all(|(_, session)| { + session.check_saved_conn_version_update_to_date(self.my_peer_id, conn_info_version) + }) + }) + .await; + + matches!(synchronized, Ok(true)) + } + + pub fn new( + my_peer_id: PeerId, + context: ArcPeerContext, + public_ipv6_runtime: Arc, + peer_rpc: Arc, + ) -> Arc { + let service_impl = Arc::new(PeerRouteServiceImpl::new(my_peer_id, context.clone())); + let session_mgr = RouteSessionManager::new(service_impl.clone(), peer_rpc.clone()); + let public_ipv6_service = Arc::new(PublicIpv6Service::new( + public_ipv6_runtime, + Arc::downgrade(&peer_rpc), + Arc::new(OspfPublicIpv6RouteHandle { + service_impl: Arc::downgrade(&service_impl), + }), + Arc::new(OspfPublicIpv6SyncTrigger { + session_mgr: session_mgr.clone(), + }), + )); + service_impl.set_public_ipv6_service(Arc::downgrade(&public_ipv6_service)); + + Arc::new(PeerRoute { + my_peer_id, + context, + peer_rpc: Arc::downgrade(&peer_rpc), + + service_impl, + public_ipv6_service, + session_mgr, + + tasks: std::sync::Mutex::new(JoinSet::new()), + }) + } + + async fn clear_expired_peer(service_impl: Arc) { + loop { + crate::foundation::time::sleep(Duration::from_secs(60)).await; + service_impl.clear_expired_peer().await; + // TODO: use debug log level for this. + tracing::debug!(?service_impl, "clear_expired_peer"); + } + } + + async fn maintain_session_tasks( + session_mgr: RouteSessionManager, + service_impl: Arc, + ) { + session_mgr.maintain_sessions(service_impl).await; + } + + async fn update_my_peer_info_routine( + service_impl: Arc, + session_mgr: RouteSessionManager, + ) { + let mut peer_event_receiver = service_impl.context.subscribe_peer_events(); + let mut runtime_change_receiver = service_impl.context.subscribe_runtime_changes(); + service_impl.mark_interface_peers_dirty(); + loop { + if service_impl.update_my_infos().await { + session_mgr.sync_now("update_my_infos"); + } + + if service_impl.cost_calculator_need_update() { + tracing::debug!("cost_calculator_need_update"); + service_impl.synced_route_info.version.inc(); + service_impl.update_route_table(); + if let Some(public_ipv6_service) = service_impl.public_ipv6_service() { + public_ipv6_service.handle_route_change(); + } + } + + let peer_event = async { + match peer_event_receiver.as_mut() { + Some(receiver) => Some(receiver.recv().await), + None => std::future::pending().await, + } + }; + let runtime_change = async { + match runtime_change_receiver.as_mut() { + Some(receiver) => Some(receiver.changed().await), + None => std::future::pending().await, + } + }; + + select! { + Some(ev) = peer_event => { + if let Ok(ev_ref) = &ev { + service_impl.handle_peer_context_event(ev_ref); + } else { + service_impl.mark_interface_peers_dirty(); + peer_event_receiver = service_impl.context.subscribe_peer_events(); + } + tracing::info!( + ?ev, + "peer context event received in update_my_peer_info_routine" + ); + } + Some(change) = runtime_change => { + if change.is_err() { + runtime_change_receiver = + service_impl.context.subscribe_runtime_changes(); + } + } + _ = crate::foundation::time::sleep(Duration::from_secs(1)) => {} + } + } + } + + async fn start(&self) { + let Some(peer_rpc) = self.peer_rpc.upgrade() else { + return; + }; + + // make sure my_peer_id is in the peer_infos. + self.service_impl.update_my_infos().await; + self.public_ipv6_service.handle_route_change(); + + peer_rpc.rpc_server().registry().register( + OspfRouteRpcServer::new(self.session_mgr.clone()), + &self.context.network_name(), + ); + peer_rpc.rpc_server().registry().register( + PublicIpv6AddrRpcServer::new(self.public_ipv6_service.rpc_server()), + &self.context.network_name(), + ); + + self.tasks + .lock() + .unwrap() + .spawn(Self::update_my_peer_info_routine( + self.service_impl.clone(), + self.session_mgr.clone(), + )); + + self.tasks + .lock() + .unwrap() + .spawn(Self::maintain_session_tasks( + self.session_mgr.clone(), + self.service_impl.clone(), + )); + + self.tasks + .lock() + .unwrap() + .spawn(Self::clear_expired_peer(self.service_impl.clone())); + + self.tasks + .lock() + .unwrap() + .spawn(self.public_ipv6_service.clone().provider_gc_routine()); + + self.tasks + .lock() + .unwrap() + .spawn(self.public_ipv6_service.clone().client_routine()); + } + + fn unregister_rpc_services(&self) { + let Some(peer_rpc) = self.peer_rpc.upgrade() else { + return; + }; + + peer_rpc.rpc_server().registry().unregister( + OspfRouteRpcServer::new(self.session_mgr.clone()), + &self.context.network_name(), + ); + peer_rpc.rpc_server().registry().unregister( + PublicIpv6AddrRpcServer::new(self.public_ipv6_service.rpc_server()), + &self.context.network_name(), + ); + } + + async fn stop(&self) { + self.service_impl.stopped.store(true, Ordering::Release); + self.unregister_rpc_services(); + + let mut tasks = { + let mut tasks = self.tasks.lock().unwrap(); + std::mem::replace(&mut *tasks, JoinSet::new()) + }; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + + let _session_operation = self.service_impl.session_operation.write().await; + let sessions = self + .service_impl + .sessions + .iter() + .map(|session| session.value().clone()) + .collect::>(); + self.service_impl.sessions.clear(); + self.service_impl.sessions.shrink_to_fit(); + for session in sessions { + session.task.stop().await; + } + + *self.service_impl.interface.lock().await = None; + } +} + +impl Drop for PeerRoute { + fn drop(&mut self) { + tracing::debug!( + self.my_peer_id, + network = ?self.context.network_identity(), + service = ?self.service_impl, + "PeerRoute drop" + ); + + self.unregister_rpc_services(); + } +} + +#[async_trait::async_trait] +impl Route for PeerRoute { + async fn open(&self, interface: RouteInterfaceBox) -> Result { + *self.service_impl.interface.lock().await = Some(interface); + self.start().await; + Ok(1) + } + + async fn close(&self) { + self.stop().await; + } + + async fn get_next_hop(&self, dst_peer_id: PeerId) -> Option { + let route_table = &self.service_impl.route_table; + route_table + .get_next_hop(dst_peer_id) + .map(|x| x.next_hop_peer_id) + } + + async fn get_next_hop_with_policy( + &self, + dst_peer_id: PeerId, + policy: NextHopPolicy, + ) -> Option { + let route_table = if matches!(policy, NextHopPolicy::LeastCost) { + &self.service_impl.route_table_with_cost + } else { + &self.service_impl.route_table + }; + route_table + .get_next_hop(dst_peer_id) + .map(|x| x.next_hop_peer_id) + } + + async fn list_routes(&self) -> Vec { + self.service_impl + .route_table + .list_routes(self.my_peer_id, &self.service_impl.route_table_with_cost) + } + + async fn list_proxy_cidrs(&self) -> BTreeSet { + self.service_impl + .route_table + .list_proxy_cidrs_excluding(self.my_peer_id) + } + + async fn list_proxy_cidrs_v6(&self) -> BTreeSet { + self.service_impl + .route_table + .list_proxy_cidrs_v6_excluding(self.my_peer_id) + } + + async fn list_public_ipv6_routes(&self) -> BTreeSet { + self.public_ipv6_service.list_routes() + } + + async fn get_my_public_ipv6_addr(&self) -> Option { + self.public_ipv6_service.my_addr() + } + + async fn get_public_ipv6_gateway_peer_id(&self) -> Option { + self.public_ipv6_service.provider_peer_id_for_client() + } + + async fn get_local_public_ipv6_info(&self) -> CoreListPublicIpv6InfoResponse { + let Some((provider, leases)) = self.public_ipv6_service.local_provider_state() else { + return CoreListPublicIpv6InfoResponse::default(); + }; + + CoreListPublicIpv6InfoResponse { + provider_prefix: Some( + Ipv6Inet::new( + provider.prefix.first_address(), + provider.prefix.network_length(), + ) + .unwrap() + .into(), + ), + provider_leases: leases + .into_iter() + .map(|lease| CorePublicIpv6LeaseInfo { + peer_id: lease.peer_id, + inst_id: lease.inst_id.to_string(), + leased_addr: Some(lease.addr.into()), + valid_until_unix_seconds: lease + .valid_until + .duration_since(std::time::UNIX_EPOCH) + .unwrap_or_default() + .as_secs() as i64, + reused: lease.reused, + }) + .collect(), + } + } + + async fn get_peer_id_by_ipv4(&self, ipv4_addr: &Ipv4Addr) -> Option { + let route_table = &self.service_impl.route_table; + if let Some(peer_id) = route_table.get_peer_id_by_ipv4(ipv4_addr) { + return Some(peer_id); + } + + // only get peer id for proxy when the dst ipv4 is not in same network with us + if PeerContext::is_ip_in_same_network(self.context.as_ref(), &IpAddr::V4(*ipv4_addr)) { + tracing::trace!(?ipv4_addr, "ipv4 addr is in same network with us"); + return None; + } + + if let Some(peer_id) = route_table.get_peer_id_for_proxy(&IpAddr::V4(*ipv4_addr)) { + return Some(peer_id); + } + + tracing::debug!(?ipv4_addr, "no peer id for ipv4"); + None + } + + async fn get_peer_id_by_ipv6(&self, ipv6_addr: &Ipv6Addr) -> Option { + let route_table = &self.service_impl.route_table; + if let Some(peer_id) = route_table.get_peer_id_by_ipv6(ipv6_addr) { + return Some(peer_id); + } + + // only get peer id for proxy when the dst ipv4 is not in same network with us + if PeerContext::is_ip_in_same_network(self.context.as_ref(), &IpAddr::V6(*ipv6_addr)) { + tracing::trace!(?ipv6_addr, "ipv6 addr is in same network with us"); + return None; + } + + if let Some(peer_id) = route_table.get_peer_id_for_proxy(&IpAddr::V6(*ipv6_addr)) { + return Some(peer_id); + } + + tracing::debug!(?ipv6_addr, "no peer id for ipv6"); + None + } + + async fn set_route_cost_fn(&self, _cost_fn: RouteCostCalculator) { + *self.service_impl.cost_calculator.write().unwrap() = Some(_cost_fn); + self.service_impl.synced_route_info.version.inc(); + self.service_impl.update_route_table(); + } + + async fn dump(&self) -> String { + format!("{:#?}", self) + } + + async fn list_foreign_network_info(&self) -> RouteForeignNetworkInfos { + let route_table = &self.service_impl.route_table; + let mut foreign_networks = RouteForeignNetworkInfos::default(); + for item in self + .service_impl + .synced_route_info + .foreign_network + .iter() + .filter(|x| !x.value().foreign_peer_ids.is_empty()) + .filter(|x| route_table.peer_reachable(x.key().peer_id)) + { + foreign_networks + .infos + .push(route_foreign_network_infos::Info { + key: Some(item.key().clone()), + value: Some(item.value().clone()), + }); + } + foreign_networks + } + + async fn get_foreign_network_summary(&self) -> RouteForeignNetworkSummary { + let mut info_map: BTreeMap = BTreeMap::new(); + for item in self.service_impl.synced_route_info.foreign_network.iter() { + let entry = info_map.entry(item.key().peer_id).or_default(); + entry.network_count += 1; + entry.peer_count += item.value().foreign_peer_ids.len() as u32; + } + RouteForeignNetworkSummary { info_map } + } + + async fn list_peers_own_foreign_network( + &self, + network_identity: &CoreNetworkIdentity, + ) -> Vec { + self.service_impl + .foreign_network_owner_map + .get(network_identity) + .map(|x| x.clone()) + .unwrap_or_default() + } + + async fn get_origin_my_peer_id( + &self, + network_name: &str, + foreign_my_peer_id: PeerId, + ) -> Option { + self.service_impl + .foreign_network_my_peer_id_map + .get(&(network_name.to_string(), foreign_my_peer_id)) + .map(|x| *x) + } + + async fn get_peer_info(&self, peer_id: PeerId) -> Option { + self.service_impl.route_table.get_peer_info(peer_id) + } + + async fn get_peer_info_last_update_time(&self) -> Instant { + self.service_impl.get_peer_info_last_update() + } + + fn get_peer_groups(&self, peer_id: PeerId) -> Arc> { + self.service_impl.get_peer_groups(peer_id) + } + + async fn refresh_acl_groups(&self) { + if self.service_impl.refresh_acl_groups().await { + self.session_mgr.sync_now("refresh_acl_groups"); + } + } +} + +impl PeerPacketFilter for PeerRoute {} + +#[cfg(test)] +mod tests { + use super::*; + use crate::packet::ZCPacket; + use crate::peers::peer_rpc::PeerRpcManagerTransport; + use crate::peers::route::{DefaultRouteCostCalculator, RouteInterface}; + use crate::peers::test_support::NoopPeerContext; + use parking_lot::Mutex; + use tokio::sync::Notify; + + impl PeerRouteServiceImpl { + pub(crate) async fn list_peers_from_interface>(&self) -> T { + self.interface_peer_snapshot() + .await + .peers + .iter() + .copied() + .collect() + } + } + + impl PeerRoute { + pub(crate) fn task_count(&self) -> usize { + let route_tasks = self.tasks.lock().unwrap().len(); + let session_tasks = self + .service_impl + .sessions + .iter() + .filter(|session| session.task.is_running()) + .count(); + route_tasks + session_tasks + } + } + + struct CountingInterface { + my_peer_id: PeerId, + peers: Arc>>, + peer_identity_types: Arc>>>, + list_peers_calls: Arc, + get_peer_identity_type_calls: Arc, + } + + struct PeriodicRequeryInterface { + peers: Vec, + list_peers_calls: Arc, + } + + struct BlockingInterface { + entered: Arc, + release: Arc, + } + + #[derive(Default)] + struct TogglePeerRelayContext { + enabled: AtomicBool, + } + + impl PeerContext for TogglePeerRelayContext { + fn network_identity(&self) -> CoreNetworkIdentity { + CoreNetworkIdentity::default() + } + + fn flags(&self) -> crate::proto::common::FlagsInConfig { + crate::proto::common::FlagsInConfig { + prefer_peer_relay: self.enabled.load(Ordering::Relaxed), + ..Default::default() + } + } + } + + #[async_trait::async_trait] + impl RouteInterface for BlockingInterface { + async fn list_peers(&self) -> Vec { + self.entered.notify_one(); + self.release.notified().await; + vec![2] + } + + async fn get_peer_identity_type(&self, _peer_id: PeerId) -> Option { + Some(PeerIdentityType::Admin) + } + + fn my_peer_id(&self) -> PeerId { + 1 + } + } + + struct TestPeerRpcTransport; + + #[async_trait::async_trait] + impl PeerRpcManagerTransport for TestPeerRpcTransport { + fn my_peer_id(&self) -> PeerId { + 1 + } + + async fn send(&self, _msg: ZCPacket, _dst_peer_id: PeerId) -> anyhow::Result<()> { + Ok(()) + } + + async fn recv(&self) -> anyhow::Result { + std::future::pending().await + } + } + + struct TestPublicIpv6Runtime; + + #[async_trait::async_trait] + impl PublicIpv6Runtime for TestPublicIpv6Runtime { + fn ipv6_public_addr_auto(&self) -> bool { + false + } + + fn ipv6_public_addr_provider(&self) -> bool { + false + } + + fn instance_id(&self) -> uuid::Uuid { + uuid::Uuid::nil() + } + + fn network_name(&self) -> String { + "default".to_owned() + } + + async fn collect_reserved_public_ipv6_addrs(&self, _prefix: Ipv6Cidr) -> HashSet { + HashSet::new() + } + + fn public_ipv6_lease_changed(&self, _old: Option, _new: Option) {} + + fn public_ipv6_routes_changed(&self, _added: Vec, _removed: Vec) {} + } + + #[async_trait::async_trait] + impl RouteInterface for CountingInterface { + async fn list_peers(&self) -> Vec { + self.list_peers_calls.fetch_add(1, Ordering::Relaxed); + self.peers.lock().clone() + } + + async fn get_peer_identity_type(&self, peer_id: PeerId) -> Option { + self.get_peer_identity_type_calls + .fetch_add(1, Ordering::Relaxed); + self.peer_identity_types + .lock() + .get(&peer_id) + .copied() + .flatten() + } + + async fn get_peer_public_key(&self, peer_id: PeerId) -> Option> { + Some(vec![peer_id as u8; 32]) + } + + fn my_peer_id(&self) -> PeerId { + self.my_peer_id + } + } + + #[async_trait::async_trait] + impl RouteInterface for PeriodicRequeryInterface { + async fn list_peers(&self) -> Vec { + self.list_peers_calls.fetch_add(1, Ordering::Relaxed); + self.peers.clone() + } + + fn my_peer_id(&self) -> PeerId { + 1 + } + + fn need_periodic_requery_peers(&self) -> bool { + true + } + + async fn get_peer_identity_type(&self, _peer_id: PeerId) -> Option { + Some(PeerIdentityType::Admin) + } + + async fn get_peer_public_key(&self, peer_id: PeerId) -> Option> { + Some(vec![peer_id as u8; 32]) + } + } + + fn test_service_impl(my_peer_id: PeerId) -> PeerRouteServiceImpl { + PeerRouteServiceImpl::new(my_peer_id, Arc::new(NoopPeerContext::default())) + } + + fn test_peer_relay_service_impl(my_peer_id: PeerId) -> PeerRouteServiceImpl { + let flags = crate::proto::common::FlagsInConfig { + prefer_peer_relay: true, + ..Default::default() + }; + PeerRouteServiceImpl::new( + my_peer_id, + Arc::new(NoopPeerContext::default().with_flags(flags)), + ) + } + + fn interface_peer_snapshot( + peers: impl IntoIterator>)>, + ) -> InterfacePeerSnapshot { + let peers: Vec<_> = peers.into_iter().collect(); + InterfacePeerSnapshot { + generation: 1, + peers: peers.iter().map(|(peer_id, _, _)| *peer_id).collect(), + identity_types: peers + .iter() + .map(|(peer_id, identity, _)| (*peer_id, Some(*identity))) + .collect(), + public_keys: peers + .into_iter() + .map(|(peer_id, _, public_key)| (peer_id, public_key)) + .collect(), + } + } + + fn install_peer_info( + service_impl: &PeerRouteServiceImpl, + peer_id: PeerId, + advertised_public_key: Vec, + avoid_relay_data: bool, + ) { + let feature_flag = crate::proto::common::PeerFeatureFlag { + avoid_relay_data, + ..Default::default() + }; + service_impl.synced_route_info.peer_infos.write().insert( + peer_id, + RoutePeerInfo { + peer_id, + version: 1, + feature_flag: Some(feature_flag), + noise_static_pubkey: advertised_public_key, + ..Default::default() + }, + ); + } + + fn install_credential_grant( + service_impl: &PeerRouteServiceImpl, + public_key: Vec, + allow_relay: bool, + ) { + service_impl + .synced_route_info + .trusted_credential_pubkeys + .write() + .insert( + public_key, + TrustedCredentialPubkey { + allow_relay, + ..Default::default() + }, + ); + } + + fn install_conn_row( + service_impl: &PeerRouteServiceImpl, + peer_id: PeerId, + connected_peers: impl IntoIterator, + ) { + service_impl.synced_route_info.conn_map.write().insert( + peer_id, + RouteConnInfo { + connected_peers: connected_peers.into_iter().collect(), + version: 1.into(), + last_update: SystemTime::now(), + }, + ); + } + + async fn test_route_with_admin_peer( + context: ArcPeerContext, + ) -> (Arc, Arc) { + let peer_rpc = Arc::new(PeerRpcManager::new(TestPeerRpcTransport)); + let route = PeerRoute::new( + 1, + context, + Arc::new(TestPublicIpv6Runtime), + peer_rpc.clone(), + ); + *route.service_impl.interface.lock().await = Some(Box::new(CountingInterface { + my_peer_id: 1, + peers: Arc::new(Mutex::new(vec![2])), + peer_identity_types: Arc::new(Mutex::new(HashMap::from([( + 2, + Some(PeerIdentityType::Admin), + )]))), + list_peers_calls: Arc::new(AtomicU32::new(0)), + get_peer_identity_type_calls: Arc::new(AtomicU32::new(0)), + })); + (route, peer_rpc) + } + + fn peer(peer_id: PeerId) -> OspfPeerInfo { + OspfPeerInfo { + peer_id, + info: RoutePeerInfo { + peer_id, + version: 1, + ..Default::default() + }, + } + } + + fn connected( + peer_id: PeerId, + connected_peers: impl IntoIterator, + ) -> OspfPeerConnInfo { + OspfPeerConnInfo { + peer_id, + connected_peers: connected_peers.into_iter().collect(), + } + } + + #[test] + fn trusted_credential_replacement_is_atomic_for_readers() { + const CREDENTIAL_COUNT: u32 = 16_384; + const REPLACEMENT_COUNT: usize = 16; + + let service_impl = test_service_impl(1); + let credentials: HashMap<_, _> = (0..CREDENTIAL_COUNT) + .map(|id| { + ( + id.to_le_bytes().to_vec(), + TrustedCredentialPubkey { + allow_relay: true, + ..Default::default() + }, + ) + }) + .collect(); + service_impl + .synced_route_info + .replace_trusted_credential_pubkeys(&credentials); + + let keys: Vec<_> = credentials.keys().cloned().collect(); + let start = std::sync::Barrier::new(2); + + std::thread::scope(|scope| { + let writer = scope.spawn(|| { + start.wait(); + for _ in 0..REPLACEMENT_COUNT { + service_impl + .synced_route_info + .replace_trusted_credential_pubkeys(&credentials); + } + }); + + start.wait(); + let mut snapshots_read = 0; + while !writer.is_finished() { + assert!(keys.iter().all(|key| { + service_impl + .synced_route_info + .get_credential_info_by_pubkey(key) + .is_some() + })); + snapshots_read += 1; + } + writer.join().unwrap(); + assert!(snapshots_read > 0); + }); + } + + #[test] + fn peer_relay_projection_suppresses_only_covered_credential_leaves() { + let service_impl = test_peer_relay_service_impl(1); + let relay_key = vec![2; 32]; + let leaf_a_key = vec![3; 32]; + let leaf_b_key = vec![4; 32]; + let snapshot = interface_peer_snapshot([ + (2, PeerIdentityType::Credential, Some(relay_key.clone())), + (3, PeerIdentityType::Credential, Some(leaf_a_key.clone())), + (4, PeerIdentityType::Credential, Some(leaf_b_key.clone())), + (5, PeerIdentityType::Admin, None), + ]); + + for peer_id in 1..=5 { + install_peer_info(&service_impl, peer_id, vec![peer_id as u8; 32], false); + } + install_credential_grant(&service_impl, relay_key, true); + install_credential_grant(&service_impl, leaf_a_key, false); + install_credential_grant(&service_impl, leaf_b_key, false); + install_conn_row(&service_impl, 2, [3, 4]); + + assert!(service_impl.reconcile_my_conn_info(&snapshot, false)); + assert_eq!( + service_impl + .synced_route_info + .get_connected_peers::>(1), + Some(BTreeSet::from([2, 5])) + ); + + *service_impl.cached_interface_peer_snapshot.lock().unwrap() = Arc::new(snapshot.clone()); + let local_snapshot = service_impl.local_route_snapshot(); + assert_eq!( + local_snapshot + .conn_map + .iter() + .find(|row| row.peer_id == 1) + .unwrap() + .connected_peers, + snapshot.peers + ); + + service_impl.update_route_table(); + assert_eq!( + service_impl + .route_table + .get_next_hop(3) + .unwrap() + .next_hop_peer_id, + 3 + ); + } + + #[test] + fn peer_relay_projection_uses_authenticated_public_key() { + let service_impl = test_peer_relay_service_impl(1); + let authenticated_key = vec![2; 32]; + let forged_relay_key = vec![9; 32]; + let snapshot = interface_peer_snapshot([ + ( + 2, + PeerIdentityType::Credential, + Some(authenticated_key.clone()), + ), + (4, PeerIdentityType::Credential, Some(vec![4; 32])), + ]); + install_peer_info(&service_impl, 2, forged_relay_key.clone(), false); + install_credential_grant(&service_impl, authenticated_key, false); + install_credential_grant(&service_impl, forged_relay_key, true); + install_conn_row(&service_impl, 2, [4]); + + assert_eq!( + service_impl.derive_advertised_connected_peers(&snapshot), + snapshot.peers + ); + } + + #[test] + fn peer_relay_projection_is_disabled_by_default() { + let service_impl = test_service_impl(1); + let snapshot = interface_peer_snapshot([ + (2, PeerIdentityType::Credential, Some(vec![2; 32])), + (4, PeerIdentityType::Credential, Some(vec![4; 32])), + ]); + install_peer_info(&service_impl, 2, vec![2; 32], false); + install_credential_grant(&service_impl, vec![2; 32], true); + install_conn_row(&service_impl, 2, [4]); + + assert_eq!( + service_impl.derive_advertised_connected_peers(&snapshot), + snapshot.peers + ); + } + + #[test] + fn peer_relay_projection_restores_edges_after_last_coverage_disappears() { + let service_impl = test_peer_relay_service_impl(1); + let snapshot = interface_peer_snapshot([ + (2, PeerIdentityType::Credential, Some(vec![2; 32])), + (3, PeerIdentityType::Credential, Some(vec![3; 32])), + (4, PeerIdentityType::Credential, Some(vec![4; 32])), + (5, PeerIdentityType::Credential, Some(vec![5; 32])), + ]); + for relay_peer_id in [2, 3] { + install_peer_info( + &service_impl, + relay_peer_id, + vec![relay_peer_id as u8; 32], + false, + ); + install_credential_grant(&service_impl, vec![relay_peer_id as u8; 32], true); + } + install_conn_row(&service_impl, 2, [4]); + install_conn_row(&service_impl, 3, [4, 5]); + + assert!(service_impl.reconcile_my_conn_info(&snapshot, false)); + let first_version = service_impl + .synced_route_info + .conn_map + .read() + .get(&1) + .unwrap() + .version + .get(); + assert_eq!( + service_impl + .synced_route_info + .get_connected_peers::>(1), + Some(BTreeSet::from([2, 3])) + ); + + service_impl.synced_route_info.conn_map.write().remove(&2); + assert!(!service_impl.reconcile_my_conn_info(&snapshot, false)); + + service_impl.synced_route_info.conn_map.write().remove(&3); + assert!(service_impl.reconcile_my_conn_info(&snapshot, false)); + let self_row = service_impl.synced_route_info.conn_map.read(); + let self_row = self_row.get(&1).unwrap(); + assert_eq!(self_row.connected_peers, snapshot.peers); + assert_eq!(self_row.version.get(), first_version + 1); + } + + #[test] + fn peer_relay_projection_ignores_ineligible_relays() { + let service_impl = test_peer_relay_service_impl(1); + let snapshot = interface_peer_snapshot([ + (2, PeerIdentityType::Credential, Some(vec![2; 32])), + (3, PeerIdentityType::Credential, Some(vec![3; 32])), + (4, PeerIdentityType::Admin, Some(vec![4; 32])), + (5, PeerIdentityType::Credential, Some(vec![5; 32])), + (6, PeerIdentityType::Credential, Some(vec![6; 32])), + ]); + install_peer_info(&service_impl, 2, vec![2; 32], false); + install_peer_info(&service_impl, 3, vec![3; 32], true); + install_peer_info(&service_impl, 4, vec![4; 32], false); + install_peer_info(&service_impl, 5, vec![5; 32], false); + for peer_id in [2, 3, 4, 5] { + install_credential_grant(&service_impl, vec![peer_id as u8; 32], peer_id != 2); + install_conn_row(&service_impl, peer_id, [6]); + } + service_impl + .synced_route_info + .suppressed_non_reusable_credential_peers + .insert(5, ()); + + assert_eq!( + service_impl.derive_advertised_connected_peers(&snapshot), + snapshot.peers + ); + } + + #[test] + fn peer_relay_projection_refreshes_local_topology_when_advertisement_is_unchanged() { + let service_impl = test_peer_relay_service_impl(1); + install_peer_info(&service_impl, 2, vec![2; 32], false); + install_credential_grant(&service_impl, vec![2; 32], true); + install_conn_row(&service_impl, 2, [3, 4]); + let first = interface_peer_snapshot([ + (2, PeerIdentityType::Credential, Some(vec![2; 32])), + (3, PeerIdentityType::Credential, Some(vec![3; 32])), + ]); + assert!(service_impl.reconcile_my_conn_info(&first, false)); + let self_version = service_impl + .synced_route_info + .conn_map + .read() + .get(&1) + .unwrap() + .version + .get(); + let route_version = service_impl.synced_route_info.version.get(); + + let second = interface_peer_snapshot([ + (2, PeerIdentityType::Credential, Some(vec![2; 32])), + (4, PeerIdentityType::Credential, Some(vec![4; 32])), + ]); + assert!(service_impl.reconcile_my_conn_info(&second, true)); + assert_eq!( + service_impl + .synced_route_info + .conn_map + .read() + .get(&1) + .unwrap() + .version + .get(), + self_version + ); + assert_eq!( + service_impl.synced_route_info.version.get(), + route_version + 1 + ); + } + + #[tokio::test] + async fn peer_relay_projection_reconciles_forwarded_row_without_interface_change() { + let service_impl = test_peer_relay_service_impl(1); + let peers = Arc::new(Mutex::new(vec![2, 4])); + let list_peers_calls = Arc::new(AtomicU32::new(0)); + *service_impl.interface.lock().await = Some(Box::new(CountingInterface { + my_peer_id: 1, + peers, + peer_identity_types: Arc::new(Mutex::new(HashMap::from([ + (2, Some(PeerIdentityType::Credential)), + (4, Some(PeerIdentityType::Credential)), + ]))), + list_peers_calls: list_peers_calls.clone(), + get_peer_identity_type_calls: Arc::new(AtomicU32::new(0)), + })); + install_peer_info(&service_impl, 2, vec![2; 32], false); + install_credential_grant(&service_impl, vec![2; 32], true); + + assert!(service_impl.update_my_conn_info().await); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 1); + assert_eq!( + service_impl + .synced_route_info + .get_connected_peers::>(1), + Some(BTreeSet::from([2, 4])) + ); + + install_conn_row(&service_impl, 2, [4]); + assert!(service_impl.update_my_conn_info().await); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 1); + assert_eq!( + service_impl + .synced_route_info + .get_connected_peers::>(1), + Some(BTreeSet::from([2])) + ); + } + + #[tokio::test] + async fn interface_peer_cache_refreshes_only_when_marked_dirty() { + let service_impl = test_service_impl(1); + let peers = Arc::new(Mutex::new(vec![2, 3])); + let peer_identity_types = Arc::new(Mutex::new(HashMap::new())); + let list_peers_calls = Arc::new(AtomicU32::new(0)); + let get_peer_identity_type_calls = Arc::new(AtomicU32::new(0)); + *service_impl.interface.lock().await = Some(Box::new(CountingInterface { + my_peer_id: 1, + peers: peers.clone(), + peer_identity_types, + list_peers_calls: list_peers_calls.clone(), + get_peer_identity_type_calls, + })); + + let first: BTreeSet<_> = service_impl.list_peers_from_interface().await; + let second: BTreeSet<_> = service_impl.list_peers_from_interface().await; + + assert_eq!(first, BTreeSet::from([2, 3])); + assert_eq!(second, BTreeSet::from([2, 3])); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 1); + + *peers.lock() = vec![2, 4]; + service_impl.handle_peer_context_event(&PeerContextEvent::PeerConnAdded); + + let third: BTreeSet<_> = service_impl.list_peers_from_interface().await; + assert_eq!(third, BTreeSet::from([2, 4])); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 2); + } + + #[tokio::test] + async fn update_my_conn_info_skips_interface_scan_when_topology_is_unchanged() { + let service_impl = test_service_impl(1); + let peers = Arc::new(Mutex::new(vec![2, 3])); + let peer_identity_types = Arc::new(Mutex::new(HashMap::new())); + let list_peers_calls = Arc::new(AtomicU32::new(0)); + let get_peer_identity_type_calls = Arc::new(AtomicU32::new(0)); + *service_impl.interface.lock().await = Some(Box::new(CountingInterface { + my_peer_id: 1, + peers: peers.clone(), + peer_identity_types, + list_peers_calls: list_peers_calls.clone(), + get_peer_identity_type_calls: get_peer_identity_type_calls.clone(), + })); + + assert!(service_impl.update_my_conn_info().await); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 1); + assert_eq!(get_peer_identity_type_calls.load(Ordering::Relaxed), 2); + + assert!(!service_impl.update_my_conn_info().await); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 1); + assert_eq!(get_peer_identity_type_calls.load(Ordering::Relaxed), 2); + + *peers.lock() = vec![2, 4]; + service_impl.handle_peer_context_event(&PeerContextEvent::PeerConnRemoved); + + assert!(service_impl.update_my_conn_info().await); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 2); + assert_eq!(get_peer_identity_type_calls.load(Ordering::Relaxed), 4); + + assert!(!service_impl.update_my_conn_info().await); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 2); + assert_eq!(get_peer_identity_type_calls.load(Ordering::Relaxed), 4); + } + + #[tokio::test] + async fn shutdown_withdrawal_preserves_local_physical_routes() { + let (route, _peer_rpc) = + test_route_with_admin_peer(Arc::new(NoopPeerContext::default())).await; + + assert!(route.service_impl.update_my_infos().await); + assert_eq!( + route + .service_impl + .synced_route_info + .get_connected_peers::>(1), + Some(BTreeSet::from([2])) + ); + let previous_version = route + .service_impl + .synced_route_info + .conn_map + .read() + .get(&1) + .unwrap() + .version + .get(); + + assert!(route.withdraw_self_conn_info().await); + { + let conn_map = route.service_impl.synced_route_info.conn_map.read(); + let withdrawn = conn_map.get(&1).unwrap(); + assert!(withdrawn.connected_peers.is_empty()); + assert!(withdrawn.version.get() > previous_version); + } + + let local_snapshot = route.service_impl.local_route_snapshot(); + assert_eq!( + local_snapshot + .conn_map + .iter() + .find(|row| row.peer_id == 1) + .unwrap() + .connected_peers, + BTreeSet::from([2]) + ); + + route.service_impl.mark_interface_peers_dirty(); + assert!(!route.service_impl.update_my_conn_info().await); + assert!( + route + .service_impl + .synced_route_info + .get_connected_peers::>(1) + .unwrap() + .is_empty() + ); + } + + #[tokio::test] + async fn empty_self_conn_info_round_trips_through_list_and_bitmap() { + let source = test_service_impl(1); + *source.interface.lock().await = Some(Box::new(CountingInterface { + my_peer_id: 1, + peers: Arc::new(Mutex::new(vec![2])), + peer_identity_types: Arc::new(Mutex::new(HashMap::from([( + 2, + Some(PeerIdentityType::Admin), + )]))), + list_peers_calls: Arc::new(AtomicU32::new(0)), + get_peer_identity_type_calls: Arc::new(AtomicU32::new(0)), + })); + assert!(source.update_my_infos().await); + source + .self_conn_info_withdrawn + .store(true, Ordering::Release); + source.mark_interface_peers_dirty(); + assert!(source.update_my_infos().await); + + let session = SyncRouteSession::new(1, 2); + let mut estimated_size = 0; + let peer_list = source + .build_conn_peer_list(&session, &mut estimated_size) + .expect("withdrawn row should remain in the peer list"); + let listed = peer_list + .peer_conn_infos + .iter() + .find(|info| info.peer_id.is_some_and(|id| id.peer_id == 1)) + .expect("peer list should carry the withdrawn self row"); + assert!(listed.connected_peer_ids.is_empty()); + + let list_receiver = test_service_impl(2); + install_conn_row(&list_receiver, 1, [2]); + list_receiver + .synced_route_info + .update_conn_info_with_list(&peer_list); + assert!( + list_receiver + .synced_route_info + .get_connected_peers::>(1) + .unwrap() + .is_empty() + ); + + let bitmap = source.build_conn_bitmap(); + let self_index = bitmap + .peer_ids + .iter() + .position(|id| id.peer_id == 1) + .expect("bitmap should carry the withdrawn self row"); + assert!(bitmap.get_connected_peers(self_index).is_empty()); + + let bitmap_receiver = test_service_impl(2); + install_conn_row(&bitmap_receiver, 1, [2]); + bitmap_receiver + .synced_route_info + .update_conn_info_with_bitmap(&bitmap); + assert!( + bitmap_receiver + .synced_route_info + .get_connected_peers::>(1) + .unwrap() + .is_empty() + ); + } + + #[tokio::test] + async fn periodic_requery_without_peer_change_keeps_route_version_stable() { + let service_impl = test_peer_relay_service_impl(1); + let list_peers_calls = Arc::new(AtomicU32::new(0)); + *service_impl.interface.lock().await = Some(Box::new(PeriodicRequeryInterface { + peers: vec![2], + list_peers_calls: list_peers_calls.clone(), + })); + + assert!(service_impl.update_my_conn_info().await); + let route_version = service_impl.synced_route_info.version.get(); + + assert!(!service_impl.update_my_conn_info().await); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 2); + assert_eq!(service_impl.synced_route_info.version.get(), route_version); + } + + #[tokio::test] + async fn enabling_peer_relay_refreshes_authenticated_interface_metadata() { + let context = Arc::new(TogglePeerRelayContext::default()); + let service_impl = PeerRouteServiceImpl::new(1, context.clone()); + let peer_identity_types = Arc::new(Mutex::new(HashMap::from([ + (2, Some(PeerIdentityType::Credential)), + (3, Some(PeerIdentityType::Credential)), + ]))); + let list_peers_calls = Arc::new(AtomicU32::new(0)); + *service_impl.interface.lock().await = Some(Box::new(CountingInterface { + my_peer_id: 1, + peers: Arc::new(Mutex::new(vec![2, 3])), + peer_identity_types, + list_peers_calls: list_peers_calls.clone(), + get_peer_identity_type_calls: Arc::new(AtomicU32::new(0)), + })); + install_peer_info(&service_impl, 2, vec![2; 32], false); + install_credential_grant(&service_impl, vec![2; 32], true); + install_conn_row(&service_impl, 2, [3]); + + assert!(service_impl.update_my_conn_info().await); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 1); + assert_eq!( + service_impl + .synced_route_info + .get_connected_peers::>(1), + Some(BTreeSet::from([2, 3])) + ); + + context.enabled.store(true, Ordering::Relaxed); + + assert!(service_impl.update_my_conn_info().await); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 2); + assert_eq!( + service_impl + .synced_route_info + .get_connected_peers::>(1), + Some(BTreeSet::from([2])) + ); + } + + #[tokio::test] + async fn get_peer_identity_type_reuses_snapshot_until_topology_changes() { + let service_impl = test_service_impl(1); + let peers = Arc::new(Mutex::new(vec![2, 3])); + let peer_identity_types = Arc::new(Mutex::new(HashMap::from([ + (2, Some(PeerIdentityType::Credential)), + (3, Some(PeerIdentityType::Admin)), + (4, Some(PeerIdentityType::Admin)), + ]))); + let list_peers_calls = Arc::new(AtomicU32::new(0)); + let get_peer_identity_type_calls = Arc::new(AtomicU32::new(0)); + *service_impl.interface.lock().await = Some(Box::new(CountingInterface { + my_peer_id: 1, + peers: peers.clone(), + peer_identity_types: peer_identity_types.clone(), + list_peers_calls: list_peers_calls.clone(), + get_peer_identity_type_calls: get_peer_identity_type_calls.clone(), + })); + + assert_eq!( + service_impl.get_peer_identity_type_from_interface(2).await, + Some(PeerIdentityType::Credential) + ); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 1); + assert_eq!(get_peer_identity_type_calls.load(Ordering::Relaxed), 2); + + assert_eq!( + service_impl.get_peer_identity_type_from_interface(2).await, + Some(PeerIdentityType::Credential) + ); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 1); + assert_eq!(get_peer_identity_type_calls.load(Ordering::Relaxed), 2); + + *peers.lock() = vec![2, 4]; + service_impl.handle_peer_context_event(&PeerContextEvent::PeerConnRemoved); + + assert_eq!( + service_impl.get_peer_identity_type_from_interface(4).await, + Some(PeerIdentityType::Admin) + ); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 2); + assert_eq!(get_peer_identity_type_calls.load(Ordering::Relaxed), 4); + + assert_eq!( + service_impl.get_peer_identity_type_from_interface(4).await, + Some(PeerIdentityType::Admin) + ); + assert_eq!(list_peers_calls.load(Ordering::Relaxed), 2); + assert_eq!(get_peer_identity_type_calls.load(Ordering::Relaxed), 4); + } + + #[tokio::test] + async fn missing_peer_resync_recovers_expired_multihop_route() { + for use_bitmap in [false, true] { + // B(1) -- C(2) -- A(3) -- D(4). Only B expires A's old metadata. + let (receiver, _peer_rpc) = + test_route_with_admin_peer(Arc::new(NoopPeerContext::default())).await; + let service = &receiver.service_impl; + service.update_my_infos().await; + service.get_or_create_session(2); + let sender = test_service_impl(2); + let old = SystemTime::now() - Duration::from_secs(120); + for peer_id in 1..=4 { + install_peer_info(&sender, peer_id, Vec::new(), false); + if peer_id != 1 { + install_peer_info(service, peer_id, Vec::new(), false); + } + } + for (_, info) in sender.synced_route_info.peer_infos.write().iter_mut() { + info.last_update = Some(old.into()); + info.feature_flag.as_mut().unwrap().support_conn_list_sync = true; + } + for (peer_id, info) in service.synced_route_info.peer_infos.write().iter_mut() { + info.last_update = Some( + if *peer_id == 3 { + old + } else { + SystemTime::now() + } + .into(), + ); + } + for (peer_id, neighbors) in + [(1, vec![2]), (2, vec![1, 3]), (3, vec![2, 4]), (4, vec![3])] + { + install_conn_row(&sender, peer_id, neighbors.clone()); + install_conn_row(service, peer_id, neighbors); + } + install_conn_row(service, 2, [1]); + sender + .synced_route_info + .conn_map + .read() + .get(&2) + .unwrap() + .version + .set_if_larger(2); + service.update_route_table_and_cached_local_conn_bitmap(); + assert!(!service.route_table.topology_peer_reachable(3)); + service.clear_expired_peer().await; + assert!(!service.synced_route_info.peer_infos.read().contains_key(&3)); + + sender.synced_route_info.version.inc(); + sender.update_route_table_and_cached_local_conn_bitmap(); + let session = sender.get_or_create_session(1); + let infos: Vec<_> = sender + .synced_route_info + .peer_infos + .read() + .values() + .cloned() + .collect(); + session.update_dst_saved_peer_info_version(&infos, 1); + session.update_dst_saved_conn_info_version(&sender.build_conn_bitmap().into(), 1); + let cursor = SystemTime::now(); + session.update_last_sync_succ_timestamp(cursor); + assert!(sender.build_route_info(&session).is_none()); + + let conn_info = if use_bitmap { + sender.build_conn_bitmap().into() + } else { + RouteConnPeerList { + peer_conn_infos: vec![PeerConnInfo { + peer_id: Some(PeerIdVersion { + peer_id: 2, + version: 2, + }), + connected_peer_ids: vec![1, 3], + }], + } + .into() + }; + let response = receiver + .session_mgr + .do_sync_route_info(2, 10, true, None, None, Some(conn_info), None) + .await + .unwrap(); + assert_eq!(response.missing_peer_ids, vec![3]); + assert!(!service.route_table.topology_peer_reachable(4)); + + // Lose the first response. A retry/keepalive without topology still + // reports the missing peer; no periodic full topology scan is needed. + let response = receiver + .session_mgr + .do_sync_route_info(2, 10, true, None, None, None, None) + .await + .unwrap(); + assert_eq!(response.missing_peer_ids, vec![3]); + sender.request_missing_peer_infos(&session, &response); + assert_eq!(session.last_sync_succ_timestamp.load(), Some(cursor)); + assert!(session.check_saved_peer_info_update_to_date(4, 1)); + + let (infos, conn_info, foreign) = sender.build_sync_request(&session, 1); + let infos = infos.unwrap(); + assert_eq!(infos.iter().map(|p| p.peer_id).collect::>(), vec![3]); + assert!(foreign.is_none()); + if use_bitmap { + assert!(conn_info.is_none()); + } else { + let Some(ConnInfo::ConnPeerList(list)) = &conn_info else { + panic!("a single missing row should use the smaller incremental list"); + }; + assert_eq!(list.peer_conn_infos.len(), 1); + assert_eq!(list.peer_conn_infos[0].peer_id.unwrap().peer_id, 3); + assert_eq!(list.peer_conn_infos[0].connected_peer_ids, vec![2, 4]); + } + + // A failed supplement must remain eligible despite the old timestamp. + assert_eq!(sender.build_route_info(&session).unwrap(), infos); + assert_eq!(sender.build_conn_info(&session, 1), conn_info); + + // Metadata alone is insufficient when the connection row was also lost. + let response = receiver + .session_mgr + .do_sync_route_info( + 2, + 10, + true, + Some(infos.clone()), + Some(infos.iter().map(raw_route_peer_info).collect()), + None, + None, + ) + .await + .unwrap(); + assert!(response.missing_peer_ids.is_empty()); + assert_eq!( + response.missing_conn_peer_ids, + if use_bitmap { vec![] } else { vec![3] } + ); + session.update_dst_saved_peer_info_version(&infos, 1); + sender.request_missing_peer_infos(&session, &response); + assert!(sender.build_route_info(&session).is_none()); + if !use_bitmap { + assert!(!service.route_table.topology_peer_reachable(4)); + } + let response = receiver + .session_mgr + .do_sync_route_info(2, 10, true, None, None, conn_info.clone(), None) + .await + .unwrap(); + assert!(response.missing_peer_ids.is_empty()); + assert!(response.missing_conn_peer_ids.is_empty()); + assert!(service.route_table.topology_peer_reachable(4)); + assert_eq!( + service + .synced_route_info + .get_peer_info_version_with_default(3), + 1 + ); + + session.update_dst_saved_peer_info_version(&infos, 1); + if let Some(conn_info) = &conn_info { + session.update_dst_saved_conn_info_version(conn_info, 1); + } + sender.request_missing_peer_infos(&session, &response); + assert!(sender.build_route_info(&session).is_none()); + assert!(sender.build_conn_info(&session, 1).is_none()); + receiver.stop().await; + } + } + + #[test] + fn missing_peer_resync_discards_collected_and_rejected_peers() { + let service = test_service_impl(1); + let session = SyncRouteSession::new(1, 2); + let conn_info: ConnInfo = RouteConnPeerList { + peer_conn_infos: vec![PeerConnInfo { + peer_id: Some(PeerIdVersion { + peer_id: 2, + version: 1, + }), + connected_peer_ids: vec![1, 3, 4], + }], + } + .into(); + service.synced_route_info.update_conn_info(&conn_info); + assert_eq!( + service.collect_missing_peer_ids(&session, Some(&conn_info), false, &[4]), + (vec![2, 3], vec![3]) + ); + service.synced_route_info.remove_peer(3); + assert_eq!( + service.collect_missing_peer_ids(&session, None, false, &[]), + (vec![2], vec![]) + ); + // A credential peer cannot supply metadata for other nodes. + assert_eq!( + service.collect_missing_peer_ids(&session, Some(&conn_info), true, &[]), + (vec![2], vec![]) + ); + session.update_remote_state_locked(123, true); + assert!(session.missing_peer_ids.lock().is_empty()); + } + + #[test] + fn missing_peer_resync_does_not_repeat_metadata_for_absent_connection_rows() { + let service = test_service_impl(1); + for peer_id in 1..=3 { + install_peer_info(&service, peer_id, Vec::new(), false); + } + install_conn_row(&service, 1, [2]); + let conn_info: ConnInfo = RouteConnPeerList { + peer_conn_infos: vec![PeerConnInfo { + peer_id: Some(PeerIdVersion { + peer_id: 2, + version: 1, + }), + connected_peer_ids: vec![1, 3], + }], + } + .into(); + service.synced_route_info.update_conn_info(&conn_info); + service.update_route_table(); + let session = SyncRouteSession::new(1, 2); + let (missing_peer_ids, missing_conn_peer_ids) = + service.collect_missing_peer_ids(&session, Some(&conn_info), false, &[]); + assert!(missing_peer_ids.is_empty()); + assert_eq!(missing_conn_peer_ids, vec![3]); + + let sender_session = SyncRouteSession::new(1, 2); + let infos = service.build_route_info(&sender_session).unwrap(); + sender_session.update_dst_saved_peer_info_version(&infos, 2); + service.request_missing_peer_infos( + &sender_session, + &SyncRouteInfoResponse { + missing_peer_ids, + missing_conn_peer_ids, + ..Default::default() + }, + ); + assert!(service.build_route_info(&sender_session).is_none()); + assert!( + sender_session + .unreachable_peers_for_conn_info + .lock() + .is_empty() + ); + + // Credential endpoints without relay permission never publish a row. + service + .synced_route_info + .peer_infos + .write() + .get_mut(&3) + .unwrap() + .feature_flag + .as_mut() + .unwrap() + .is_credential_peer = true; + assert_eq!( + service.collect_missing_peer_ids(&session, None, false, &[]), + (vec![], vec![]) + ); + // A credential allowed to relay still needs its outgoing connections. + service + .synced_route_info + .peer_infos + .write() + .get_mut(&3) + .unwrap() + .noise_static_pubkey = vec![3; 32]; + install_credential_grant(&service, vec![3; 32], true); + assert_eq!( + service.collect_missing_peer_ids(&session, Some(&conn_info), false, &[]), + (vec![], vec![3]) + ); + } + + #[test] + fn missing_peer_resync_deduplicates_new_versions_and_waits_for_reachability() { + let service = test_service_impl(1); + for peer_id in 1..=3 { + install_peer_info(&service, peer_id, Vec::new(), false); + } + install_conn_row(&service, 1, [2]); + install_conn_row(&service, 2, [1]); + install_conn_row(&service, 3, [2]); + service.update_route_table_and_cached_local_conn_bitmap(); + let session = SyncRouteSession::new(1, 2); + service.request_missing_peer_infos( + &session, + &SyncRouteInfoResponse { + missing_peer_ids: vec![3, 3, 99, 2], + missing_conn_peer_ids: vec![3, 3, 99, 2], + ..Default::default() + }, + ); + assert_eq!(session.unreachable_peers_for_peer_info.lock().len(), 1); + assert!( + !service + .build_route_info(&session) + .unwrap() + .iter() + .any(|p| p.peer_id == 3) + ); + install_conn_row(&service, 2, [1, 3]); + service.update_route_table_and_cached_local_conn_bitmap(); + let infos = service.build_route_info(&session).unwrap(); + assert_eq!(infos.iter().filter(|p| p.peer_id == 3).count(), 1); + let list = service.build_conn_peer_list(&session, &mut 0).unwrap(); + assert_eq!( + list.peer_conn_infos + .iter() + .filter(|p| p.peer_id.unwrap().peer_id == 3) + .count(), + 1 + ); + } + + #[test] + fn stopped_sync_clears_matching_remote_initiator() { + let session = SyncRouteSession::new(1, 2); + let _session_lock = session.lock.lock(); + session.update_remote_state_locked(10, true); + + assert!(session.clear_dst_initiator_if_session_unchanged_locked(10)); + assert!(!session.dst_is_initiator.load(Ordering::Relaxed)); + } + + #[test] + fn stopped_sync_preserves_newer_remote_initiator() { + let session = SyncRouteSession::new(1, 2); + let _session_lock = session.lock.lock(); + session.update_remote_state_locked(10, true); + + session.update_remote_state_locked(11, true); + + assert!(!session.clear_dst_initiator_if_session_unchanged_locked(10)); + assert!(session.dst_is_initiator.load(Ordering::Relaxed)); + } + + #[test] + fn remote_state_change_invalidates_outbound_snapshot() { + let service_impl = Arc::new(test_service_impl(1)); + let session = service_impl.get_or_create_session(2); + let _session_lock = session.lock.lock(); + session.update_remote_state_locked(10, false); + let snapshot = session.request_snapshot_locked(); + + assert!(session.admit_inbound_locked(20, true)); + assert!(!service_impl.sync_request_is_current_locked(2, &session, snapshot)); + assert_eq!(session.dst_session_id.load(Ordering::Relaxed), 20); + assert!(session.dst_is_initiator.load(Ordering::Relaxed)); + assert_eq!(session.rpc_tx_count.load(Ordering::Relaxed), 0); + assert!(session.dst_saved_peer_info_versions.is_empty()); + } + + #[test] + fn replaced_session_invalidates_outbound_snapshot() { + let service_impl = Arc::new(test_service_impl(1)); + let old_session = service_impl.get_or_create_session(2); + let snapshot = { + let _session_lock = old_session.lock.lock(); + old_session.request_snapshot_locked() + }; + + service_impl.remove_session(2); + let new_session = service_impl.get_or_create_session(2); + let _old_session_lock = old_session.lock.lock(); + + assert!(!Arc::ptr_eq(&old_session, &new_session)); + assert!(!service_impl.sync_request_is_current_locked(2, &old_session, snapshot)); + } + + #[test] + fn active_remote_initiator_rejects_different_generation() { + let session = SyncRouteSession::new(1, 2); + { + let _session_lock = session.lock.lock(); + assert!(session.admit_inbound_locked(20, true)); + assert!(!session.admit_inbound_locked(10, true)); + assert_eq!(session.dst_session_id.load(Ordering::Relaxed), 20); + } + + session + .last_contact_instant + .store(Instant::now() - INITIATOR_SESSION_LIVENESS_TIMEOUT - Duration::from_secs(1)); + assert!(session.clear_stale_dst_initiator()); + + let _session_lock = session.lock.lock(); + assert!(session.admit_inbound_locked(10, true)); + assert_eq!(session.dst_session_id.load(Ordering::Relaxed), 10); + } + + #[test] + fn local_initiator_accepts_initial_responder_generation() { + let session = SyncRouteSession::new(1, 2); + session.update_initiator_flag(true); + + let _session_lock = session.lock.lock(); + assert!(session.admit_inbound_locked(20, false)); + assert_eq!(session.dst_session_id.load(Ordering::Relaxed), 20); + assert!(!session.dst_is_initiator.load(Ordering::Relaxed)); + } + + #[test] + fn stale_responder_session_clears_initiator_after_liveness_timeout() { + let session = SyncRouteSession::new(1, 2); + { + let _session_lock = session.lock.lock(); + session.update_remote_state_locked(10, true); + } + session + .last_contact_instant + .store(Instant::now() - INITIATOR_SESSION_LIVENESS_TIMEOUT - Duration::from_secs(1)); + + assert!(session.clear_stale_dst_initiator()); + assert!(!session.dst_is_initiator.load(Ordering::Relaxed)); + } + + #[test] + fn healthy_responder_session_keeps_initiator() { + let session = SyncRouteSession::new(1, 2); + { + let _session_lock = session.lock.lock(); + session.update_remote_state_locked(10, true); + } + + assert!(!session.clear_stale_dst_initiator()); + assert!(session.dst_is_initiator.load(Ordering::Relaxed)); + } + + #[test] + fn initiator_session_ignores_liveness_timeout() { + let session = SyncRouteSession::new(1, 2); + session.update_initiator_flag(true); + { + let _session_lock = session.lock.lock(); + session.update_remote_state_locked(10, true); + } + session + .last_contact_instant + .store(Instant::now() - INITIATOR_SESSION_LIVENESS_TIMEOUT - Duration::from_secs(1)); + + assert!(!session.clear_stale_dst_initiator()); + assert!(session.dst_is_initiator.load(Ordering::Relaxed)); + } + + #[tokio::test] + async fn initiator_sync_creates_session_and_marks_contact() { + let peer_rpc = Arc::new(PeerRpcManager::new(TestPeerRpcTransport)); + let route = PeerRoute::new( + 1, + Arc::new(NoopPeerContext::default()), + Arc::new(TestPublicIpv6Runtime), + peer_rpc, + ); + let peers = Arc::new(Mutex::new(vec![2])); + *route.service_impl.interface.lock().await = Some(Box::new(CountingInterface { + my_peer_id: 1, + peers, + peer_identity_types: Arc::new(Mutex::new(HashMap::from([( + 2, + Some(PeerIdentityType::Admin), + )]))), + list_peers_calls: Arc::new(AtomicU32::new(0)), + get_peer_identity_type_calls: Arc::new(AtomicU32::new(0)), + })); + + route + .session_mgr + .do_sync_route_info(2, 1, true, None, None, None, None) + .await + .expect("initiator sync should succeed"); + + let session = route + .service_impl + .get_session(2) + .expect("initiator sync should create the session"); + assert!(session.dst_is_initiator.load(Ordering::Relaxed)); + assert!( + session.last_contact_instant.load().elapsed() < Duration::from_secs(5), + "inbound sync should refresh the liveness timestamp" + ); + + route.stop().await; + assert!(route.service_impl.sessions.is_empty()); + assert_eq!(route.task_count(), 0); + } + + #[tokio::test] + async fn stale_non_initiator_sync_does_not_create_session() { + let peer_rpc = Arc::new(PeerRpcManager::new(TestPeerRpcTransport)); + let route = PeerRoute::new( + 1, + Arc::new(NoopPeerContext::default()), + Arc::new(TestPublicIpv6Runtime), + peer_rpc, + ); + let peers = Arc::new(Mutex::new(vec![2])); + *route.service_impl.interface.lock().await = Some(Box::new(CountingInterface { + my_peer_id: 1, + peers, + peer_identity_types: Arc::new(Mutex::new(HashMap::from([( + 2, + Some(PeerIdentityType::Admin), + )]))), + list_peers_calls: Arc::new(AtomicU32::new(0)), + get_peer_identity_type_calls: Arc::new(AtomicU32::new(0)), + })); + + let result = route + .session_mgr + .do_sync_route_info(2, 1, false, None, None, None, None) + .await; + + assert!(matches!(result, Err(Error::Stopped))); + assert!(route.service_impl.sessions.is_empty()); + assert_eq!(route.task_count(), 0); + } + + #[tokio::test] + async fn stale_non_initiator_sync_preserves_newer_session_generation() { + let (route, _peer_rpc) = + test_route_with_admin_peer(Arc::new(NoopPeerContext::default())).await; + let session = route.service_impl.get_or_create_session(2); + + route + .session_mgr + .do_sync_route_info(2, 22, true, None, None, None, None) + .await + .expect("new initiator generation should be accepted"); + let contact = session.last_contact_instant.load(); + let rx_count = session.rpc_rx_count.load(Ordering::Relaxed); + + let stale_peer_info = RoutePeerInfo { + peer_id: 3, + version: 1, + ..Default::default() + }; + let result = route + .session_mgr + .do_sync_route_info( + 2, + 11, + false, + Some(vec![stale_peer_info.clone()]), + Some(vec![raw_route_peer_info(&stale_peer_info)]), + None, + None, + ) + .await; + + assert!(matches!(result, Err(Error::Stopped))); + assert_eq!(session.dst_session_id.load(Ordering::Relaxed), 22); + assert!(session.dst_is_initiator.load(Ordering::Relaxed)); + assert_eq!(session.last_contact_instant.load(), contact); + assert_eq!(session.rpc_rx_count.load(Ordering::Relaxed), rx_count); + assert!( + !route + .service_impl + .synced_route_info + .peer_infos + .read() + .contains_key(&3) + ); + + route.stop().await; + } + + #[tokio::test] + async fn stale_peer_info_does_not_restore_removed_acl_group() { + let context = Arc::new(NoopPeerContext::new(CoreNetworkIdentity::new_credential( + "default".to_owned(), + ))); + let (route, _peer_rpc) = test_route_with_admin_peer(context).await; + route.service_impl.get_or_create_session(2); + + let peer_info = |version, groups| RoutePeerInfo { + peer_id: 3, + peer_route_id: 30, + version, + groups, + ..Default::default() + }; + let sync_peer_info = |info: RoutePeerInfo| { + let raw = raw_route_peer_info(&info); + (Some(vec![info]), Some(vec![raw])) + }; + + let v1 = peer_info( + 1, + vec![PeerGroupInfo { + group_name: "legacy".to_owned(), + group_proof: Vec::new(), + }], + ); + let (peer_infos, raw_peer_infos) = sync_peer_info(v1.clone()); + route + .session_mgr + .do_sync_route_info(2, 22, true, peer_infos, raw_peer_infos, None, None) + .await + .expect("v1 peer info should be accepted"); + assert_eq!(route.service_impl.get_peer_groups(3).as_ref(), &["legacy"]); + + let v2 = peer_info(2, Vec::new()); + let (peer_infos, raw_peer_infos) = sync_peer_info(v2); + route + .session_mgr + .do_sync_route_info(2, 22, true, peer_infos, raw_peer_infos, None, None) + .await + .expect("v2 peer info should be accepted"); + assert!(route.service_impl.get_peer_groups(3).is_empty()); + + let (peer_infos, raw_peer_infos) = sync_peer_info(v1); + route + .session_mgr + .do_sync_route_info(2, 22, true, peer_infos, raw_peer_infos, None, None) + .await + .expect("stale peer info should be ignored"); + + assert_eq!( + route + .service_impl + .synced_route_info + .peer_infos + .read() + .get(&3) + .expect("peer info should remain present") + .version, + 2 + ); + assert!(route.service_impl.get_peer_groups(3).is_empty()); + + route.stop().await; + } + + #[test] + fn credential_group_refresh_does_not_restore_removed_proof_group() { + let service_impl = Arc::new(test_service_impl(1)); + let mut peer_infos = OrderedHashMap::new(); + peer_infos.insert( + 3, + RoutePeerInfo { + peer_id: 3, + version: 3, + noise_static_pubkey: vec![3; 32], + ..Default::default() + }, + ); + let all_trusted = HashMap::from([( + vec![3; 32], + TrustedCredentialPubkey { + groups: vec!["credential".to_owned()], + ..Default::default() + }, + )]); + + let group_trust_lock = service_impl + .synced_route_info + .group_trust_update_lock + .lock(); + service_impl + .synced_route_info + .set_peer_groups_locked(3, HashMap::from([("legacy".to_owned(), vec![1])])); + + let (started_tx, started_rx) = std::sync::mpsc::channel(); + let credential_refresh = std::thread::spawn({ + let service_impl = service_impl.clone(); + move || { + started_tx.send(()).unwrap(); + service_impl + .synced_route_info + .update_credential_groups(&peer_infos, &all_trusted); + } + }); + started_rx.recv().unwrap(); + + service_impl + .synced_route_info + .set_peer_groups_locked(3, HashMap::new()); + drop(group_trust_lock); + credential_refresh.join().unwrap(); + + assert_eq!( + service_impl + .synced_route_info + .group_trust_map + .get(&3) + .as_deref(), + Some(&HashMap::from([("credential".to_owned(), Vec::new())])) + ); + } + + #[tokio::test] + async fn stop_waits_for_in_flight_route_sync_before_draining_sessions() { + let peer_rpc = Arc::new(PeerRpcManager::new(TestPeerRpcTransport)); + let route = PeerRoute::new( + 1, + Arc::new(NoopPeerContext::default()), + Arc::new(TestPublicIpv6Runtime), + peer_rpc, + ); + let entered = Arc::new(Notify::new()); + let release = Arc::new(Notify::new()); + *route.service_impl.interface.lock().await = Some(Box::new(BlockingInterface { + entered: entered.clone(), + release: release.clone(), + })); + + let sync_task = tokio::spawn({ + let session_mgr = route.session_mgr.clone(); + async move { + session_mgr + .do_sync_route_info(2, 1, true, None, None, None, None) + .await + } + }); + crate::foundation::time::timeout(Duration::from_secs(1), entered.notified()) + .await + .expect("route sync did not enter the interface call"); + + let stop_task = tokio::spawn({ + let route = route.clone(); + async move { route.stop().await } + }); + crate::foundation::time::timeout(Duration::from_secs(1), async { + while !route.service_impl.stopped.load(Ordering::Acquire) { + tokio::task::yield_now().await; + } + }) + .await + .expect("route did not enter the stopped state"); + + assert!(!stop_task.is_finished()); + assert!(matches!( + route.session_mgr.get_or_start_session(3), + Err(Error::Stopped) + )); + + release.notify_one(); + sync_task + .await + .expect("route sync task panicked") + .expect("in-flight route sync failed"); + crate::foundation::time::timeout(Duration::from_secs(1), stop_task) + .await + .expect("route stop did not finish") + .expect("route stop task panicked"); + + assert!(route.service_impl.sessions.is_empty()); + assert_eq!(route.task_count(), 0); + } + + #[test] + fn builds_next_hop_and_proxy_lookup_from_snapshot() { + let mut remote_proxy_peer = peer(3); + remote_proxy_peer + .info + .proxy_cidrs + .push("10.10.0.0/16".into()); + + let snapshot = OspfRouteSnapshot { + peer_infos: vec![peer(1), peer(2), remote_proxy_peer], + conn_map: vec![connected(1, [2]), connected(2, [1, 3]), connected(3, [2])], + suppressed_peer_ids: BTreeSet::new(), + version: 1, + }; + + let table = OspfRouteTable::new(); + table.build_from_snapshot( + 1, + &snapshot, + NextHopPolicy::LeastHop, + &DefaultRouteCostCalculator, + ); + + let next_hop = table.get_next_hop(3).unwrap(); + assert_eq!(next_hop.next_hop_peer_id, 2); + assert_eq!(next_hop.path_len, 2); + assert_eq!( + table.get_peer_id_for_proxy(&"10.10.1.1".parse::().unwrap()), + Some(3) + ); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/route/route_peer_wire.rs b/vendor/easytier/easytier-core/src/peers/route/route_peer_wire.rs new file mode 100644 index 0000000..5a5cddd --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/route/route_peer_wire.rs @@ -0,0 +1,399 @@ +//! Minimal protobuf wire editing used by OSPF route reflection. +//! +//! Route calculation uses generated prost types. This module only keeps the +//! original `RoutePeerInfo` bytes and replaces the two fields that credential +//! filtering is allowed to change, leaving every other field byte-for-byte +//! intact. + +use bytes::Bytes; +use prost::{ + Message, + encoding::{ + DecodeContext, WireType, decode_key, decode_varint, encode_key, encode_varint, skip_field, + }, +}; +use thiserror::Error; + +use crate::proto::peer_rpc::{RoutePeerInfo, SyncRouteInfoRequest}; + +const SYNC_ROUTE_PEER_INFOS_TAG: u32 = 4; +const ROUTE_PEER_INFOS_ITEM_TAG: u32 = 1; +const ROUTE_PEER_INFO_PROXY_CIDRS_TAG: u32 = 5; +const ROUTE_PEER_INFO_FEATURE_FLAG_TAG: u32 = 11; +const ROUTE_PEER_INFO_CREDENTIAL_PROOF_TAG: u32 = 19; +const FEATURE_FLAG_IS_CREDENTIAL_PEER_TAG: u32 = 8; +const CREDENTIAL_PROOF_CREDENTIAL_TAG: u32 = 1; + +pub(crate) type RawRoutePeerInfo = Bytes; + +#[derive(Debug, Error)] +pub(crate) enum WireError { + #[error(transparent)] + Decode(#[from] prost::DecodeError), + #[error("protobuf field {tag} has wire type {actual:?}, expected {expected:?}")] + WrongWireType { + tag: u32, + actual: WireType, + expected: WireType, + }, + #[error("protobuf length-delimited field is larger than the remaining input")] + TruncatedLengthDelimited, + #[error("raw RoutePeerInfo count does not match the decoded request")] + PeerInfoCountMismatch, +} + +type Result = std::result::Result; + +#[derive(Clone, Copy)] +struct WireField<'a> { + tag: u32, + wire_type: WireType, + encoded: &'a [u8], + length_delimited: Option<&'a [u8]>, +} + +fn parse_fields(message: &[u8]) -> Result>> { + let mut input = message; + let mut fields = Vec::new(); + + while !input.is_empty() { + let start = message.len() - input.len(); + let (tag, wire_type) = decode_key(&mut input)?; + let length_delimited = if wire_type == WireType::LengthDelimited { + let len = usize::try_from(decode_varint(&mut input)?) + .map_err(|_| WireError::TruncatedLengthDelimited)?; + if len > input.len() { + return Err(WireError::TruncatedLengthDelimited); + } + let (payload, remaining) = input.split_at(len); + input = remaining; + Some(payload) + } else { + skip_field(wire_type, tag, &mut input, DecodeContext::default())?; + None + }; + let end = message.len() - input.len(); + fields.push(WireField { + tag, + wire_type, + encoded: &message[start..end], + length_delimited, + }); + } + + Ok(fields) +} + +fn length_delimited_fields(message: &[u8], tag: u32) -> Result> { + parse_fields(message)? + .into_iter() + .filter(|field| field.tag == tag) + .map(|field| { + field.length_delimited.ok_or(WireError::WrongWireType { + tag, + actual: field.wire_type, + expected: WireType::LengthDelimited, + }) + }) + .collect() +} + +fn replace_fields( + message: &[u8], + tag: u32, + expected_wire_type: WireType, + replacement: &[u8], +) -> Result> { + let mut output = Vec::with_capacity(message.len() + replacement.len()); + for field in parse_fields(message)? { + if field.tag != tag { + output.extend_from_slice(field.encoded); + continue; + } + if field.wire_type != expected_wire_type { + return Err(WireError::WrongWireType { + tag, + actual: field.wire_type, + expected: expected_wire_type, + }); + } + } + output.extend_from_slice(replacement); + Ok(output) +} + +fn append_length_delimited_field(output: &mut Vec, tag: u32, payload: &[u8]) { + encode_key(tag, WireType::LengthDelimited, output); + encode_varint(payload.len() as u64, output); + output.extend_from_slice(payload); +} + +fn append_varint_field(output: &mut Vec, tag: u32, value: u64) { + encode_key(tag, WireType::Varint, output); + encode_varint(value, output); +} + +fn merged_length_delimited_field(message: &[u8], tag: u32) -> Result> { + let values = length_delimited_fields(message, tag)?; + let total_len = values.iter().map(|value| value.len()).sum(); + let mut merged = Vec::with_capacity(total_len); + for value in values { + merged.extend_from_slice(value); + } + Ok(merged) +} + +pub(crate) fn raw_route_peer_info(info: &RoutePeerInfo) -> RawRoutePeerInfo { + Bytes::from(info.encode_to_vec()) +} + +pub(crate) fn extract_route_peer_infos(request: &[u8]) -> Result> { + let mut result = Vec::new(); + for peer_infos in length_delimited_fields(request, SYNC_ROUTE_PEER_INFOS_TAG)? { + result.extend( + length_delimited_fields(peer_infos, ROUTE_PEER_INFOS_ITEM_TAG)? + .into_iter() + .map(Bytes::copy_from_slice), + ); + } + Ok(result) +} + +pub(crate) fn encode_sync_route_request( + request: &SyncRouteInfoRequest, + raw_peer_infos: &[RawRoutePeerInfo], +) -> Result> { + let decoded_count = request + .peer_infos + .as_ref() + .map(|peer_infos| peer_infos.items.len()) + .unwrap_or_default(); + if decoded_count != raw_peer_infos.len() { + return Err(WireError::PeerInfoCountMismatch); + } + + let mut request_without_peer_infos = request.clone(); + request_without_peer_infos.peer_infos = None; + let mut output = request_without_peer_infos.encode_to_vec(); + if request.peer_infos.is_some() { + let mut peer_infos = Vec::new(); + for info in raw_peer_infos { + append_length_delimited_field(&mut peer_infos, ROUTE_PEER_INFOS_ITEM_TAG, info); + } + append_length_delimited_field(&mut output, SYNC_ROUTE_PEER_INFOS_TAG, &peer_infos); + } + Ok(output) +} + +pub(crate) fn patch_credential_route_peer_info( + raw: &RawRoutePeerInfo, + proxy_cidrs: &[String], +) -> Result { + let mut proxy_cidr_fields = Vec::new(); + for cidr in proxy_cidrs { + append_length_delimited_field( + &mut proxy_cidr_fields, + ROUTE_PEER_INFO_PROXY_CIDRS_TAG, + cidr.as_bytes(), + ); + } + let route_info = replace_fields( + raw, + ROUTE_PEER_INFO_PROXY_CIDRS_TAG, + WireType::LengthDelimited, + &proxy_cidr_fields, + )?; + + // Singular message fields merge when they occur more than once. Concatenating + // their payloads preserves that protobuf behavior before changing tag 8. + let feature_flag = + merged_length_delimited_field(&route_info, ROUTE_PEER_INFO_FEATURE_FLAG_TAG)?; + let mut credential_flag = Vec::new(); + append_varint_field(&mut credential_flag, FEATURE_FLAG_IS_CREDENTIAL_PEER_TAG, 1); + let feature_flag = replace_fields( + &feature_flag, + FEATURE_FLAG_IS_CREDENTIAL_PEER_TAG, + WireType::Varint, + &credential_flag, + )?; + let mut feature_flag_field = Vec::new(); + append_length_delimited_field( + &mut feature_flag_field, + ROUTE_PEER_INFO_FEATURE_FLAG_TAG, + &feature_flag, + ); + + Ok(Bytes::from(replace_fields( + &route_info, + ROUTE_PEER_INFO_FEATURE_FLAG_TAG, + WireType::LengthDelimited, + &feature_flag_field, + )?)) +} + +pub(crate) fn raw_credential_bytes( + raw_route_info: &RawRoutePeerInfo, + proof_idx: usize, +) -> Result> { + let proofs = length_delimited_fields(raw_route_info, ROUTE_PEER_INFO_CREDENTIAL_PROOF_TAG)?; + let Some(proof) = proofs.get(proof_idx) else { + return Ok(None); + }; + let credentials = length_delimited_fields(proof, CREDENTIAL_PROOF_CREDENTIAL_TAG)?; + if credentials.is_empty() { + return Ok(None); + } + + // Multiple occurrences of a singular message field merge. Concatenation is + // the wire-equivalent merged message and keeps nested unknown fields intact. + let total_len = credentials.iter().map(|value| value.len()).sum(); + let mut merged = Vec::with_capacity(total_len); + for credential in credentials { + merged.extend_from_slice(credential); + } + Ok(Some(Bytes::from(merged))) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::proto::{ + common::PeerFeatureFlag, + peer_rpc::{RoutePeerInfos, TrustedCredentialPubkey, TrustedCredentialPubkeyProof}, + }; + + fn encoded_varint_field(tag: u32, value: u64) -> Vec { + let mut output = Vec::new(); + append_varint_field(&mut output, tag, value); + output + } + + fn encoded_length_delimited_field(tag: u32, payload: &[u8]) -> Vec { + let mut output = Vec::new(); + append_length_delimited_field(&mut output, tag, payload); + output + } + + fn encoded_fields(message: &[u8], tag: u32) -> Vec> { + parse_fields(message) + .unwrap() + .into_iter() + .filter(|field| field.tag == tag) + .map(|field| field.encoded.to_vec()) + .collect() + } + + #[test] + fn patch_preserves_top_level_and_nested_unknown_fields() { + const TOP_LEVEL_UNKNOWN_TAG: u32 = 100; + const FEATURE_UNKNOWN_TAG: u32 = 101; + + let mut feature_flag = PeerFeatureFlag { + avoid_relay_data: true, + ..Default::default() + } + .encode_to_vec(); + feature_flag.extend(encoded_varint_field(FEATURE_UNKNOWN_TAG, 42)); + + let info = RoutePeerInfo { + peer_id: 7, + proxy_cidrs: vec!["10.0.0.0/8".to_owned()], + ..Default::default() + }; + let mut raw = info.encode_to_vec(); + raw.extend(encoded_length_delimited_field( + ROUTE_PEER_INFO_FEATURE_FLAG_TAG, + &feature_flag, + )); + raw.extend(encoded_varint_field(TOP_LEVEL_UNKNOWN_TAG, 99)); + + let top_level_unknown = encoded_fields(&raw, TOP_LEVEL_UNKNOWN_TAG); + let nested_unknown = encoded_fields(&feature_flag, FEATURE_UNKNOWN_TAG); + let patched = + patch_credential_route_peer_info(&Bytes::from(raw), &["10.1.0.0/16".to_owned()]) + .unwrap(); + + assert_eq!( + encoded_fields(&patched, TOP_LEVEL_UNKNOWN_TAG), + top_level_unknown + ); + let patched_feature = + merged_length_delimited_field(&patched, ROUTE_PEER_INFO_FEATURE_FLAG_TAG).unwrap(); + assert_eq!( + encoded_fields(&patched_feature, FEATURE_UNKNOWN_TAG), + nested_unknown + ); + + let decoded = RoutePeerInfo::decode(patched).unwrap(); + assert_eq!(decoded.proxy_cidrs, ["10.1.0.0/16"]); + assert!(decoded.feature_flag.unwrap().is_credential_peer); + } + + #[test] + fn multi_hop_sync_keeps_raw_peer_info_exactly() { + let info = RoutePeerInfo { + peer_id: 9, + ..Default::default() + }; + let mut raw = info.encode_to_vec(); + raw.extend(encoded_length_delimited_field(120, b"future")); + let raw = Bytes::from(raw); + let request = SyncRouteInfoRequest { + my_peer_id: 1, + peer_infos: Some(RoutePeerInfos { items: vec![info] }), + ..Default::default() + }; + + let first_hop = encode_sync_route_request(&request, std::slice::from_ref(&raw)).unwrap(); + let first_hop_raw = extract_route_peer_infos(&first_hop).unwrap(); + assert_eq!(first_hop_raw.as_slice(), std::slice::from_ref(&raw)); + assert_eq!( + SyncRouteInfoRequest::decode(first_hop.as_slice()) + .unwrap() + .peer_infos, + request.peer_infos + ); + + let second_hop = encode_sync_route_request(&request, &first_hop_raw).unwrap(); + assert_eq!(extract_route_peer_infos(&second_hop).unwrap(), [raw]); + } + + #[test] + fn credential_hmac_uses_exact_nested_message_bytes() { + let secret = "wire-test-secret"; + let credential = TrustedCredentialPubkey { + pubkey: vec![3; 32], + ..Default::default() + }; + let mut raw_credential = credential.encode_to_vec(); + raw_credential.extend(encoded_varint_field(100, 1234)); + let hmac = TrustedCredentialPubkeyProof::generate_credential_hmac_from_bytes( + &raw_credential, + secret, + ); + + let mut raw_proof = + encoded_length_delimited_field(CREDENTIAL_PROOF_CREDENTIAL_TAG, &raw_credential); + raw_proof.extend(encoded_length_delimited_field(2, &hmac)); + let mut raw_route_info = RoutePeerInfo { + peer_id: 11, + ..Default::default() + } + .encode_to_vec(); + raw_route_info.extend(encoded_length_delimited_field( + ROUTE_PEER_INFO_CREDENTIAL_PROOF_TAG, + &raw_proof, + )); + + let extracted = raw_credential_bytes(&Bytes::from(raw_route_info), 0) + .unwrap() + .unwrap(); + assert_eq!(extracted, raw_credential); + + let proof = TrustedCredentialPubkeyProof { + credential: Some(credential), + credential_hmac: hmac, + }; + assert!(proof.verify_credential_hmac_with_bytes(&extracted, secret)); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/test_support.rs b/vendor/easytier/easytier-core/src/peers/test_support.rs new file mode 100644 index 0000000..16a4662 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/test_support.rs @@ -0,0 +1,111 @@ +//! Test-only peer-context fakes shared by peer-domain unit tests +//! (`peers::tests`, `peers::route::peer_ospf_route::tests`, and +//! `context::tests`). Kept out of `context.rs` so the context unit tests and +//! their consumers share one definition. + +use std::net::IpAddr; + +use cidr::{Ipv4Inet, Ipv6Inet}; +use easytier_proto::common::{FlagsInConfig, SecureModeConfig}; +use hmac::Hmac; +use sha2::Sha256; + +use crate::{ + config::peers::PeerRuntimeConfig, + config::{CoreConfig, IpPrefix, NodeConfig, PeerPolicyConfig, RouteConfig, TrafficConfig}, + peers::context::{NetworkIdentity, PeerContext, secret_proof_from_secret}, +}; + +pub(crate) trait PeerContextTestExt: PeerContext { + fn runtime_config(&self) -> PeerRuntimeConfig { + let network_identity = self.network_identity(); + let hostname = self.hostname(); + PeerRuntimeConfig { + core: CoreConfig { + node: NodeConfig { + peer_id: None, + instance_id: Some(*self.instance_id().as_bytes()), + hostname: (!hostname.is_empty()).then_some(hostname), + network_name: network_identity.network_name.clone(), + }, + routes: RouteConfig { + ipv4: self.ipv4().map(ipv4_inet_to_config), + ipv6: self.ipv6().map(ipv6_inet_to_config), + ..Default::default() + }, + peer_policy: PeerPolicyConfig::default(), + traffic: TrafficConfig::default(), + }, + network_identity, + stun_info: self.stun_info(), + feature_flags: self.feature_flags(), + secure_mode: self.secure_mode(), + host_routing: self.host_routing_policy(), + } + } +} + +fn ipv4_inet_to_config(value: Ipv4Inet) -> IpPrefix { + IpPrefix::new(IpAddr::V4(value.address()), value.network_length()) + .expect("Ipv4Inet should always have a valid IPv4 prefix length") +} + +fn ipv6_inet_to_config(value: Ipv6Inet) -> IpPrefix { + IpPrefix::new(IpAddr::V6(value.address()), value.network_length()) + .expect("Ipv6Inet should always have a valid IPv6 prefix length") +} + +#[derive(Debug, Clone)] +pub(crate) struct NoopPeerContext { + network_identity: NetworkIdentity, + flags: FlagsInConfig, + secure_mode: Option, +} + +impl NoopPeerContext { + pub(crate) fn new(network_identity: NetworkIdentity) -> Self { + Self { + network_identity, + flags: FlagsInConfig::default(), + secure_mode: None, + } + } + + pub(crate) fn with_secure_mode(mut self, secure_mode: SecureModeConfig) -> Self { + self.flags.encryption_algorithm = "aes-gcm".to_owned(); + self.secure_mode = Some(secure_mode); + self + } + + pub(crate) fn with_flags(mut self, flags: FlagsInConfig) -> Self { + self.flags = flags; + self + } +} + +impl Default for NoopPeerContext { + fn default() -> Self { + Self::new(NetworkIdentity::default()) + } +} + +impl PeerContext for NoopPeerContext { + fn network_identity(&self) -> NetworkIdentity { + self.network_identity.clone() + } + + fn flags(&self) -> FlagsInConfig { + self.flags.clone() + } + + fn secure_mode(&self) -> Option { + self.secure_mode.clone() + } + + fn secret_proof(&self, challenge: &[u8]) -> Option> { + let secret = self.network_identity.network_secret.as_ref()?; + secret_proof_from_secret(secret, challenge) + } +} + +impl PeerContextTestExt for NoopPeerContext {} diff --git a/vendor/easytier/easytier-core/src/peers/tests.rs b/vendor/easytier/easytier-core/src/peers/tests.rs new file mode 100644 index 0000000..ad1b55c --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/tests.rs @@ -0,0 +1,409 @@ +use std::sync::Arc; + +use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; +use x25519_dalek::{PublicKey, StaticSecret}; + +use crate::foundation::time::{Duration, timeout}; + +use crate::{ + foundation::token_bucket::{ArcByteLimiter, ByteLimiter}, + packet::{PacketType, ZCPacket}, + peers::{ + PeerConnectionOrigin, PeerPacketIngress, + conn::{ + peer_conn::{PeerConn, PeerConnId}, + peer_map::PeerMap, + peer_session::PeerSessionStore, + }, + context::{NetworkIdentity, PeerContext}, + create_packet_recv_chan, + error::Error, + recv_packet_envelope_from_chan, + test_support::NoopPeerContext, + }, + tunnel::ring::create_ring_tunnel_pair, +}; + +struct RejectingRecvLimiter; + +impl ByteLimiter for RejectingRecvLimiter { + fn try_consume(&self, _bytes: u64) -> bool { + false + } +} + +struct LimitedPeerContext { + limiter: ArcByteLimiter, +} + +impl PeerContext for LimitedPeerContext { + fn network_identity(&self) -> NetworkIdentity { + NetworkIdentity::default() + } + + fn recv_limiter( + &self, + _network_name: &str, + _is_foreign_network: bool, + ) -> Option { + Some(self.limiter.clone()) + } +} + +impl PeerConn { + #[tracing::instrument] + async fn do_handshake_as_server(&mut self) -> Result<(), Error> { + self.do_handshake_as_server_ext(|_, _| Ok(())).await + } +} + +#[tokio::test] +async fn peer_conn_handshake_over_memory_tunnel() { + let peer_session_store = Arc::new(PeerSessionStore::new()); + let (client_tunnel, server_tunnel) = create_ring_tunnel_pair(); + let client_ctx = Arc::new(NoopPeerContext::default()); + let server_ctx = Arc::new(NoopPeerContext::default()); + + let mut client = PeerConn::new(1, client_ctx, client_tunnel, peer_session_store.clone()); + let mut server = PeerConn::new(2, server_ctx, server_tunnel, peer_session_store); + + let (client_ret, server_ret) = tokio::join!( + client.do_handshake_as_client(), + server.do_handshake_as_server() + ); + + client_ret.unwrap(); + server_ret.unwrap(); + assert_eq!(client.get_peer_id(), 2); + assert_eq!(server.get_peer_id(), 1); + assert_eq!(client.get_conn_info().features, ["liveness-echo-v1"]); + assert_eq!(server.get_conn_info().features, ["liveness-echo-v1"]); +} + +#[tokio::test] +async fn peer_recv_limit_drops_excess_data_without_blocking_ping() { + let peer_session_store = Arc::new(PeerSessionStore::new()); + let (client_tunnel, server_tunnel) = create_ring_tunnel_pair(); + let client_ctx = Arc::new(NoopPeerContext::default()); + let server_ctx = Arc::new(LimitedPeerContext { + limiter: Arc::new(RejectingRecvLimiter), + }); + + let mut client = PeerConn::new(1, client_ctx, client_tunnel, peer_session_store.clone()); + let mut server = PeerConn::new(2, server_ctx, server_tunnel, peer_session_store); + + let (client_ret, server_ret) = tokio::join!( + client.do_handshake_as_client(), + server.do_handshake_as_server() + ); + client_ret.unwrap(); + server_ret.unwrap(); + + let (client_tx, _client_rx) = create_packet_recv_chan(); + let (server_tx, mut server_rx) = create_packet_recv_chan(); + client.start_recv_loop(client_tx).await; + server.start_recv_loop(server_tx).await; + + let client_rx_packets = client.get_stats().rx_packets; + + let mut data = ZCPacket::new_with_payload(b"over limit"); + data.fill_peer_manager_hdr(1, 2, PacketType::Data as u8); + client.send_msg(data).await.unwrap(); + + let mut ping = ZCPacket::new_with_payload(&[]); + ping.fill_peer_manager_hdr(1, 2, PacketType::Ping as u8); + client.send_msg(ping).await.unwrap(); + + timeout(Duration::from_secs(1), async { + while client.get_stats().rx_packets == client_rx_packets { + tokio::task::yield_now().await; + } + }) + .await + .expect("receive limiting must not block the following pong"); + + assert!( + timeout(Duration::from_millis(50), server_rx.recv()) + .await + .is_err(), + "over-limit data packet should be dropped" + ); +} + +#[tokio::test] +async fn peer_conn_noise_handshake_advertises_liveness_echo() { + fn context(peer_key: u8) -> Arc { + let private = StaticSecret::from([peer_key; 32]); + let public = PublicKey::from(&private); + Arc::new( + NoopPeerContext::new(NetworkIdentity { + network_name: "net".to_owned(), + network_secret: Some("secret".to_owned()), + network_secret_digest: None, + }) + .with_secure_mode(crate::proto::common::SecureModeConfig { + enabled: true, + local_private_key: Some(BASE64_STANDARD.encode(private.as_bytes())), + local_public_key: Some(BASE64_STANDARD.encode(public.as_bytes())), + }), + ) + } + + let (client_tunnel, server_tunnel) = create_ring_tunnel_pair(); + let mut client = PeerConn::new( + 1, + context(1), + client_tunnel, + Arc::new(PeerSessionStore::new()), + ); + let mut server = PeerConn::new( + 2, + context(2), + server_tunnel, + Arc::new(PeerSessionStore::new()), + ); + + let (client_ret, server_ret) = tokio::join!( + client.do_handshake_as_client(), + server.do_handshake_as_server() + ); + + client_ret.unwrap(); + server_ret.unwrap(); + assert_eq!(client.get_conn_info().features, ["liveness-echo-v1"]); + assert_eq!(server.get_conn_info().features, ["liveness-echo-v1"]); +} + +#[tokio::test] +async fn peer_conn_handshake_matches_plaintext_secret_identity() { + let peer_session_store = Arc::new(PeerSessionStore::new()); + let (client_tunnel, server_tunnel) = create_ring_tunnel_pair(); + let client_ctx = Arc::new(NoopPeerContext::new(NetworkIdentity { + network_name: "net".to_string(), + network_secret: Some("secret".to_string()), + network_secret_digest: None, + })); + let server_ctx = Arc::new(NoopPeerContext::new(NetworkIdentity { + network_name: "net".to_string(), + network_secret: Some("secret".to_string()), + network_secret_digest: None, + })); + + let mut client = PeerConn::new(1, client_ctx, client_tunnel, peer_session_store.clone()); + let mut server = PeerConn::new(2, server_ctx, server_tunnel, peer_session_store); + + let (client_ret, server_ret) = tokio::join!( + client.do_handshake_as_client(), + server.do_handshake_as_server() + ); + + client_ret.unwrap(); + server_ret.unwrap(); + assert!(client.matches_local_network_secret()); + assert!(server.matches_local_network_secret()); +} + +#[tokio::test] +async fn local_packet_channel_injection_has_no_attached_privilege() { + let (sender, mut receiver) = create_packet_recv_chan(); + let mut packet = ZCPacket::new_with_payload(b"local"); + packet.fill_peer_manager_hdr(77, 3, PacketType::Data as u8); + + sender.send(packet).await.unwrap(); + + let envelope = recv_packet_envelope_from_chan(&mut receiver).await.unwrap(); + let (_, ingress) = envelope.into_parts(); + assert_eq!(ingress, PeerPacketIngress::Local); + assert!(!ingress.is_attached()); +} + +#[tokio::test] +async fn peer_map_forwards_packet_over_memory_tunnel() { + let peer_session_store = Arc::new(PeerSessionStore::new()); + let (client_tunnel, server_tunnel) = create_ring_tunnel_pair(); + let client_ctx = Arc::new(NoopPeerContext::default()); + let server_ctx = Arc::new(NoopPeerContext::default()); + + let mut client_conn = PeerConn::new( + 1, + client_ctx.clone(), + client_tunnel, + peer_session_store.clone(), + ); + let mut server_conn = PeerConn::new(2, server_ctx.clone(), server_tunnel, peer_session_store); + + let (client_ret, server_ret) = tokio::join!( + client_conn.do_handshake_as_client(), + server_conn.do_handshake_as_server() + ); + client_ret.unwrap(); + server_ret.unwrap(); + + let (client_tx, _client_rx) = create_packet_recv_chan(); + let (server_tx, mut server_rx) = create_packet_recv_chan(); + let client_map = PeerMap::new(client_tx, client_ctx, 1); + let server_map = PeerMap::new(server_tx, server_ctx, 2); + + client_map.add_new_peer_conn(client_conn).await.unwrap(); + server_map.add_new_peer_conn(server_conn).await.unwrap(); + + let mut packet = ZCPacket::new_with_payload(b"hello"); + packet.fill_peer_manager_hdr(1, 2, PacketType::Data as u8); + client_map.send_msg_directly(packet, 2).await.unwrap(); + + let received = timeout(Duration::from_secs(1), server_rx.recv()) + .await + .unwrap() + .unwrap(); + assert_eq!(received.payload(), b"hello"); +} + +#[tokio::test] +async fn peer_channel_uses_admission_origin_instead_of_packet_header() { + let peer_session_store = Arc::new(PeerSessionStore::new()); + let (client_tunnel, server_tunnel) = create_ring_tunnel_pair(); + let client_ctx = Arc::new(NoopPeerContext::default()); + let server_ctx = Arc::new(NoopPeerContext::default()); + + let mut client_conn = PeerConn::new( + 1, + client_ctx.clone(), + client_tunnel, + peer_session_store.clone(), + ); + let mut server_conn = PeerConn::new_with_peer_id_hint_and_origin( + 2, + server_ctx.clone(), + server_tunnel, + None, + peer_session_store, + PeerConnectionOrigin::Attached, + ); + let (client_ret, server_ret) = tokio::join!( + client_conn.do_handshake_as_client(), + server_conn.do_handshake_as_server() + ); + client_ret.unwrap(); + server_ret.unwrap(); + let server_conn_id = server_conn.get_conn_id(); + + let (client_tx, _client_rx) = create_packet_recv_chan(); + let (server_tx, mut server_rx) = create_packet_recv_chan(); + let client_map = PeerMap::new(client_tx, client_ctx, 1); + let server_map = PeerMap::new(server_tx, server_ctx, 2); + client_map.add_new_peer_conn(client_conn).await.unwrap(); + server_map.add_new_peer_conn(server_conn).await.unwrap(); + assert!(server_map.has_direct_attached_peer(1)); + + let mut packet = ZCPacket::new_with_payload(b"forged source"); + packet.fill_peer_manager_hdr(77, 3, PacketType::Data as u8); + client_map.send_msg_directly(packet, 2).await.unwrap(); + + let envelope = timeout( + Duration::from_secs(1), + recv_packet_envelope_from_chan(&mut server_rx), + ) + .await + .unwrap() + .unwrap(); + let (received, ingress) = envelope.into_parts(); + assert_eq!( + received.peer_manager_header().unwrap().from_peer_id.get(), + 77 + ); + assert_eq!( + ingress, + PeerPacketIngress::Peer { + peer_id: 1, + conn_id: server_conn_id, + origin: PeerConnectionOrigin::Attached, + } + ); +} + +#[tokio::test] +async fn peer_map_reselects_cached_connection_after_close() { + let peer_session_store = Arc::new(PeerSessionStore::new()); + let (client_tunnel_a, server_tunnel_a) = create_ring_tunnel_pair(); + let (client_tunnel_b, server_tunnel_b) = create_ring_tunnel_pair(); + let client_ctx = Arc::new(NoopPeerContext::default()); + let server_ctx = Arc::new(NoopPeerContext::default()); + + let mut client_conn_a = PeerConn::new( + 1, + client_ctx.clone(), + client_tunnel_a, + peer_session_store.clone(), + ); + let mut server_conn_a = PeerConn::new( + 2, + server_ctx.clone(), + server_tunnel_a, + peer_session_store.clone(), + ); + let mut client_conn_b = PeerConn::new( + 1, + client_ctx.clone(), + client_tunnel_b, + peer_session_store.clone(), + ); + let mut server_conn_b = + PeerConn::new(2, server_ctx.clone(), server_tunnel_b, peer_session_store); + + let (client_a_ret, server_a_ret, client_b_ret, server_b_ret) = tokio::join!( + client_conn_a.do_handshake_as_client(), + server_conn_a.do_handshake_as_server(), + client_conn_b.do_handshake_as_client(), + server_conn_b.do_handshake_as_server(), + ); + client_a_ret.unwrap(); + server_a_ret.unwrap(); + client_b_ret.unwrap(); + server_b_ret.unwrap(); + + let (client_tx, _client_rx) = create_packet_recv_chan(); + let (server_tx, mut server_rx) = create_packet_recv_chan(); + let client_map = PeerMap::new(client_tx, client_ctx, 1); + let server_map = PeerMap::new(server_tx, server_ctx, 2); + + client_map.add_new_peer_conn(client_conn_a).await.unwrap(); + client_map.add_new_peer_conn(client_conn_b).await.unwrap(); + server_map.add_new_peer_conn(server_conn_a).await.unwrap(); + server_map.add_new_peer_conn(server_conn_b).await.unwrap(); + + let mut first_packet = ZCPacket::new_with_payload(b"first"); + first_packet.fill_peer_manager_hdr(1, 2, PacketType::Data as u8); + client_map.send_msg_directly(first_packet, 2).await.unwrap(); + let first_received = timeout(Duration::from_secs(1), server_rx.recv()) + .await + .unwrap() + .unwrap(); + assert_eq!(first_received.payload(), b"first"); + + let first_conn_id = client_map.get_peer_default_conn_id(2).await.unwrap(); + assert_ne!(first_conn_id, PeerConnId::default()); + client_map.close_peer_conn(2, &first_conn_id).await.unwrap(); + timeout(Duration::from_secs(1), async { + while client_map.get_peer_default_conn_id(2).await == Some(first_conn_id) { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + + let mut second_packet = ZCPacket::new_with_payload(b"second"); + second_packet.fill_peer_manager_hdr(1, 2, PacketType::Data as u8); + client_map + .send_msg_directly(second_packet, 2) + .await + .unwrap(); + let second_received = timeout(Duration::from_secs(1), server_rx.recv()) + .await + .unwrap() + .unwrap(); + assert_eq!(second_received.payload(), b"second"); + assert_ne!( + client_map.get_peer_default_conn_id(2).await, + Some(first_conn_id) + ); +} diff --git a/vendor/easytier/easytier-core/src/peers/traffic_metrics.rs b/vendor/easytier/easytier-core/src/peers/traffic_metrics.rs new file mode 100644 index 0000000..724bed6 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/traffic_metrics.rs @@ -0,0 +1,601 @@ +use std::{future::Future, sync::Arc}; + +use dashmap::DashMap; +use futures::future::BoxFuture; + +use crate::config::PeerId; +use crate::foundation::stats::{CounterHandle, LabelSet, LabelType, MetricName, StatsManager}; +use crate::packet::{PacketType, ZCPacket}; +use crate::peers::util::shrink_dashmap; +use crate::proto::peer_rpc::RoutePeerInfo; + +pub const UNKNOWN_INSTANCE_ID: &str = "unknown"; + +#[derive(Clone, Copy)] +pub enum InstanceLabelKind { + To, + From, +} + +#[derive(Clone)] +struct TrafficCounters { + bytes: CounterHandle, + packets: CounterHandle, +} + +impl TrafficCounters { + fn add_sample(&self, bytes: u64) { + self.bytes.add(bytes); + self.packets.inc(); + } +} + +#[derive(Clone)] +enum CachedPeerTrafficCounters { + Unknown(TrafficCounters), + Resolved(TrafficCounters), +} + +impl CachedPeerTrafficCounters { + fn add_sample(&self, bytes: u64) { + match self { + CachedPeerTrafficCounters::Unknown(counters) + | CachedPeerTrafficCounters::Resolved(counters) => counters.add_sample(bytes), + } + } + + fn counters(&self) -> TrafficCounters { + match self { + CachedPeerTrafficCounters::Unknown(counters) + | CachedPeerTrafficCounters::Resolved(counters) => counters.clone(), + } + } + + fn is_resolved(&self) -> bool { + matches!(self, CachedPeerTrafficCounters::Resolved(_)) + } +} + +pub struct LogicalTrafficMetrics { + stats_mgr: Arc, + network_name: String, + instance_bytes_metric: MetricName, + instance_packets_metric: MetricName, + label_kind: InstanceLabelKind, + total: TrafficCounters, + per_peer: DashMap, +} + +impl LogicalTrafficMetrics { + pub fn new( + stats_mgr: Arc, + network_name: String, + total_bytes_metric: MetricName, + total_packets_metric: MetricName, + instance_bytes_metric: MetricName, + instance_packets_metric: MetricName, + label_kind: InstanceLabelKind, + ) -> Self { + let label_set = + LabelSet::new().with_label_type(LabelType::NetworkName(network_name.clone())); + Self { + total: TrafficCounters { + bytes: stats_mgr.get_counter(total_bytes_metric, label_set.clone()), + packets: stats_mgr.get_counter(total_packets_metric, label_set), + }, + stats_mgr, + network_name, + instance_bytes_metric, + instance_packets_metric, + label_kind, + per_peer: DashMap::new(), + } + } + + pub async fn record_with_resolver(&self, peer_id: PeerId, bytes: u64, resolver: F) + where + F: FnOnce() -> Fut, + Fut: Future>, + { + self.total.add_sample(bytes); + + if let Some(entry) = self.per_peer.get(&peer_id) + && entry.value().is_resolved() + { + entry.value().add_sample(bytes); + return; + } + + let resolved_instance_id = resolver().await; + let counters = self.get_or_update_peer_counters(peer_id, resolved_instance_id.as_deref()); + counters.add_sample(bytes); + } + + fn get_or_update_peer_counters( + &self, + peer_id: PeerId, + resolved_instance_id: Option<&str>, + ) -> TrafficCounters { + match self.per_peer.entry(peer_id) { + dashmap::Entry::Occupied(mut entry) => { + if entry.get().is_resolved() || resolved_instance_id.is_none() { + return entry.get().counters(); + } + let counters = self.build_peer_counters(resolved_instance_id.unwrap()); + entry.insert(CachedPeerTrafficCounters::Resolved(counters.clone())); + counters + } + dashmap::Entry::Vacant(entry) => { + let counters = + self.build_peer_counters(resolved_instance_id.unwrap_or(UNKNOWN_INSTANCE_ID)); + let cached = if resolved_instance_id.is_some() { + CachedPeerTrafficCounters::Resolved(counters.clone()) + } else { + CachedPeerTrafficCounters::Unknown(counters.clone()) + }; + entry.insert(cached); + counters + } + } + } + + pub fn remove_peer(&self, peer_id: PeerId) { + self.per_peer.remove(&peer_id); + shrink_dashmap(&self.per_peer, None); + } + + pub fn clear_peer_cache(&self) { + self.per_peer.clear(); + shrink_dashmap(&self.per_peer, None); + } + + fn contains_peer_cache(&self, peer_id: PeerId) -> bool { + self.per_peer.contains_key(&peer_id) + } + + fn build_peer_counters(&self, instance_id: &str) -> TrafficCounters { + let instance_label = match self.label_kind { + InstanceLabelKind::To => LabelType::ToInstanceId(instance_id.to_string()), + InstanceLabelKind::From => LabelType::FromInstanceId(instance_id.to_string()), + }; + let label_set = LabelSet::new() + .with_label_type(LabelType::NetworkName(self.network_name.clone())) + .with_label_type(instance_label); + TrafficCounters { + bytes: self + .stats_mgr + .get_counter(self.instance_bytes_metric, label_set.clone()), + packets: self + .stats_mgr + .get_counter(self.instance_packets_metric, label_set), + } + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum TrafficKind { + Data, + Control, +} + +pub fn traffic_kind(packet_type: u8) -> TrafficKind { + if packet_type == PacketType::Data as u8 + || packet_type == PacketType::KcpSrc as u8 + || packet_type == PacketType::KcpDst as u8 + || packet_type == PacketType::QuicSrc as u8 + || packet_type == PacketType::QuicDst as u8 + || packet_type == PacketType::DataWithKcpSrcModified as u8 + || packet_type == PacketType::DataWithQuicSrcModified as u8 + { + TrafficKind::Data + } else { + TrafficKind::Control + } +} + +pub fn is_relay_data_packet_type(packet_type: u8) -> bool { + // Relay handshakes are control-plane setup; payload data is blocked by its + // original packet type after the session exists. + traffic_kind(packet_type) == TrafficKind::Data + || packet_type == PacketType::ForeignNetworkPacket as u8 +} + +pub(crate) fn data_packet_payload_len(packet: &ZCPacket) -> Option { + let header = packet.peer_manager_header()?; + if header.packet_type == PacketType::ForeignNetworkPacket as u8 { + if header.is_encrypted() { + return Some(packet.payload_len() as u64); + } + return match packet.foreign_network_inner_packet_info() { + Some((inner_header, payload_len)) + if traffic_kind(inner_header.packet_type) == TrafficKind::Data => + { + Some(payload_len as u64) + } + Some(_) => None, + None => Some(packet.payload_len() as u64), + }; + } + + (traffic_kind(header.packet_type) == TrafficKind::Data).then(|| packet.payload_len() as u64) +} + +#[derive(Clone)] +struct TrafficMetricGroup { + data: Arc, + control: Arc, +} + +impl TrafficMetricGroup { + fn select(&self, kind: TrafficKind) -> &Arc { + match kind { + TrafficKind::Data => &self.data, + TrafficKind::Control => &self.control, + } + } +} + +type InstanceIdResolver = dyn Fn(PeerId) -> BoxFuture<'static, Option> + Send + Sync; + +pub struct TrafficMetricRecorder { + my_peer_id: PeerId, + tx_metrics: TrafficMetricGroup, + rx_metrics: TrafficMetricGroup, + resolve_instance_id: Arc, +} + +impl TrafficMetricRecorder { + pub fn new( + my_peer_id: PeerId, + tx_data: Arc, + tx_control: Arc, + rx_data: Arc, + rx_control: Arc, + resolve_instance_id: F, + ) -> Self + where + F: Fn(PeerId) -> Fut + Send + Sync + 'static, + Fut: Future> + Send + 'static, + { + Self { + my_peer_id, + tx_metrics: TrafficMetricGroup { + data: tx_data, + control: tx_control, + }, + rx_metrics: TrafficMetricGroup { + data: rx_data, + control: rx_control, + }, + resolve_instance_id: Arc::new(move |peer_id| Box::pin(resolve_instance_id(peer_id))), + } + } + + pub async fn record_tx(&self, peer_id: PeerId, packet_type: u8, bytes: u64) { + if peer_id == self.my_peer_id { + return; + } + self.tx_metrics + .select(traffic_kind(packet_type)) + .record_with_resolver(peer_id, bytes, || self.resolve_instance_id(peer_id)) + .await; + } + + pub async fn record_rx(&self, peer_id: PeerId, packet_type: u8, bytes: u64) { + if peer_id == self.my_peer_id { + return; + } + self.rx_metrics + .select(traffic_kind(packet_type)) + .record_with_resolver(peer_id, bytes, || self.resolve_instance_id(peer_id)) + .await; + } + + pub fn remove_peer(&self, peer_id: PeerId) { + self.tx_metrics.data.remove_peer(peer_id); + self.tx_metrics.control.remove_peer(peer_id); + self.rx_metrics.data.remove_peer(peer_id); + self.rx_metrics.control.remove_peer(peer_id); + } + + pub fn clear_peer_cache(&self) { + self.tx_metrics.data.clear_peer_cache(); + self.tx_metrics.control.clear_peer_cache(); + self.rx_metrics.data.clear_peer_cache(); + self.rx_metrics.control.clear_peer_cache(); + } + + pub fn contains_peer_cache(&self, peer_id: PeerId) -> bool { + self.tx_metrics.data.contains_peer_cache(peer_id) + || self.tx_metrics.control.contains_peer_cache(peer_id) + || self.rx_metrics.data.contains_peer_cache(peer_id) + || self.rx_metrics.control.contains_peer_cache(peer_id) + } + + fn resolve_instance_id(&self, peer_id: PeerId) -> BoxFuture<'static, Option> { + (self.resolve_instance_id)(peer_id) + } +} + +pub fn route_peer_info_instance_id(route_peer_info: &RoutePeerInfo) -> Option { + let instance_id = route_peer_info.inst_id.as_ref()?; + let instance_id: uuid::Uuid = (*instance_id).into(); + if instance_id.is_nil() { + None + } else { + Some(instance_id.to_string()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + impl LogicalTrafficMetrics { + fn peer_cache_size(&self) -> usize { + self.per_peer.len() + } + } + + fn network_labels(network_name: &str) -> LabelSet { + LabelSet::new().with_label_type(LabelType::NetworkName(network_name.to_string())) + } + + fn to_instance_labels(network_name: &str, instance_id: &str) -> LabelSet { + LabelSet::new() + .with_label_type(LabelType::NetworkName(network_name.to_string())) + .with_label_type(LabelType::ToInstanceId(instance_id.to_string())) + } + + #[test] + fn relay_limiter_classifies_only_data_packets() { + for packet_type in [ + PacketType::Data, + PacketType::KcpSrc, + PacketType::KcpDst, + PacketType::QuicSrc, + PacketType::QuicDst, + PacketType::DataWithKcpSrcModified, + PacketType::DataWithQuicSrcModified, + PacketType::ForeignNetworkPacket, + ] { + assert!(is_relay_data_packet_type(packet_type as u8)); + } + + for packet_type in [ + PacketType::Ping, + PacketType::Pong, + PacketType::RpcReq, + PacketType::RpcResp, + PacketType::RelayHandshake, + PacketType::RelayHandshakeAck, + ] { + assert!(!is_relay_data_packet_type(packet_type as u8)); + } + } + + fn packet_with_type(packet_type: PacketType, payload_len: usize) -> ZCPacket { + let mut packet = ZCPacket::new_with_payload(&vec![0; payload_len]); + packet.fill_peer_manager_hdr(1, 2, packet_type as u8); + packet + } + + #[test] + fn data_packet_payload_len_uses_easytier_payload() { + let mut data_packet = packet_with_type(PacketType::Data, 1_024); + data_packet.mut_peer_manager_header().unwrap().len.set(0); + assert_eq!(data_packet_payload_len(&data_packet), Some(1_024)); + + let control_packet = packet_with_type(PacketType::RpcReq, 128); + assert_eq!(data_packet_payload_len(&control_packet), None); + } + + #[test] + fn data_packet_payload_len_unwraps_foreign_network_packet() { + let network_name = "foreign".to_string(); + let mut inner_data = packet_with_type(PacketType::Data, 1_024); + inner_data.mut_peer_manager_header().unwrap().len.set(0); + let foreign_data = ZCPacket::new_for_foreign_network(&network_name, 2, &inner_data); + assert!(!foreign_data.peer_manager_header().unwrap().is_encrypted()); + assert_eq!(data_packet_payload_len(&foreign_data), Some(1_024)); + + let inner_control = packet_with_type(PacketType::RpcReq, 128); + let foreign_control = ZCPacket::new_for_foreign_network(&network_name, 2, &inner_control); + assert_eq!(data_packet_payload_len(&foreign_control), None); + + let malformed_foreign = packet_with_type(PacketType::ForeignNetworkPacket, 7); + assert_eq!( + data_packet_payload_len(&malformed_foreign), + Some(malformed_foreign.payload_len() as u64) + ); + } + + #[test] + fn data_packet_payload_len_charges_encrypted_foreign_payload() { + let network_name = "foreign".to_string(); + let inner_control = packet_with_type(PacketType::RpcReq, 128); + let mut encrypted_foreign = + ZCPacket::new_for_foreign_network(&network_name, 2, &inner_control); + encrypted_foreign + .mut_peer_manager_header() + .unwrap() + .set_encrypted(true); + + assert_eq!( + data_packet_payload_len(&encrypted_foreign), + Some(encrypted_foreign.payload_len() as u64) + ); + } + + #[tokio::test] + async fn logical_traffic_metrics_upgrade_unknown_instance_label() { + let stats_mgr = Arc::new(StatsManager::new()); + let metrics = LogicalTrafficMetrics::new( + stats_mgr.clone(), + "default".to_string(), + MetricName::TrafficBytesTx, + MetricName::TrafficPacketsTx, + MetricName::TrafficBytesTxByInstance, + MetricName::TrafficPacketsTxByInstance, + InstanceLabelKind::To, + ); + let peer_id = 42; + let resolved_instance_id = "87ede5a2-9c3d-492d-9bbe-989b9d07e742"; + + metrics + .record_with_resolver(peer_id, 100, || async { None }) + .await; + metrics + .record_with_resolver(peer_id, 200, || async { + Some(resolved_instance_id.to_string()) + }) + .await; + + assert_eq!( + stats_mgr + .get_metric(MetricName::TrafficBytesTx, &network_labels("default")) + .unwrap() + .value, + 300 + ); + assert!( + stats_mgr + .get_metric( + MetricName::TrafficBytesTx, + &to_instance_labels("default", UNKNOWN_INSTANCE_ID), + ) + .is_none() + ); + assert!( + stats_mgr + .get_metric( + MetricName::TrafficBytesTx, + &to_instance_labels("default", resolved_instance_id), + ) + .is_none() + ); + assert_eq!( + stats_mgr + .get_metric( + MetricName::TrafficBytesTxByInstance, + &to_instance_labels("default", UNKNOWN_INSTANCE_ID), + ) + .unwrap() + .value, + 100 + ); + assert_eq!( + stats_mgr + .get_metric( + MetricName::TrafficBytesTxByInstance, + &to_instance_labels("default", resolved_instance_id), + ) + .unwrap() + .value, + 200 + ); + assert_eq!( + stats_mgr + .get_metric( + MetricName::TrafficPacketsTxByInstance, + &to_instance_labels("default", UNKNOWN_INSTANCE_ID), + ) + .unwrap() + .value, + 1 + ); + assert_eq!( + stats_mgr + .get_metric( + MetricName::TrafficPacketsTxByInstance, + &to_instance_labels("default", resolved_instance_id), + ) + .unwrap() + .value, + 1 + ); + } + + #[tokio::test] + async fn logical_traffic_metrics_remove_peer_clears_cached_counters() { + let stats_mgr = Arc::new(StatsManager::new()); + let metrics = LogicalTrafficMetrics::new( + stats_mgr.clone(), + "default".to_string(), + MetricName::TrafficBytesTx, + MetricName::TrafficPacketsTx, + MetricName::TrafficBytesTxByInstance, + MetricName::TrafficPacketsTxByInstance, + InstanceLabelKind::To, + ); + let peer_id = 42; + let resolved_instance_id = "87ede5a2-9c3d-492d-9bbe-989b9d07e742"; + + metrics + .record_with_resolver(peer_id, 100, || async { + Some(resolved_instance_id.to_string()) + }) + .await; + metrics.remove_peer(peer_id); + metrics + .record_with_resolver(peer_id, 200, || async { None }) + .await; + + assert_eq!( + stats_mgr + .get_metric(MetricName::TrafficBytesTx, &network_labels("default")) + .unwrap() + .value, + 300 + ); + assert_eq!( + stats_mgr + .get_metric( + MetricName::TrafficBytesTxByInstance, + &to_instance_labels("default", resolved_instance_id), + ) + .unwrap() + .value, + 100 + ); + assert_eq!( + stats_mgr + .get_metric( + MetricName::TrafficBytesTxByInstance, + &to_instance_labels("default", UNKNOWN_INSTANCE_ID), + ) + .unwrap() + .value, + 200 + ); + } + + #[tokio::test] + async fn logical_traffic_metrics_clear_peer_cache_resets_all_cached_peers() { + let stats_mgr = Arc::new(StatsManager::new()); + let metrics = LogicalTrafficMetrics::new( + stats_mgr, + "default".to_string(), + MetricName::TrafficBytesTx, + MetricName::TrafficPacketsTx, + MetricName::TrafficBytesTxByInstance, + MetricName::TrafficPacketsTxByInstance, + InstanceLabelKind::To, + ); + + metrics + .record_with_resolver(1, 100, || async { + Some("87ede5a2-9c3d-492d-9bbe-989b9d07e742".to_string()) + }) + .await; + metrics + .record_with_resolver(2, 200, || async { None }) + .await; + + assert_eq!(metrics.peer_cache_size(), 2); + + metrics.clear_peer_cache(); + + assert_eq!(metrics.peer_cache_size(), 0); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/util.rs b/vendor/easytier/easytier-core/src/peers/util.rs new file mode 100644 index 0000000..48718bf --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/util.rs @@ -0,0 +1,10 @@ +use std::hash::Hash; + +use dashmap::DashMap; + +pub(crate) fn shrink_dashmap(map: &DashMap, threshold: Option) { + let threshold = threshold.unwrap_or(16); + if map.capacity() - map.len() > threshold { + map.shrink_to_fit(); + } +} diff --git a/vendor/easytier/easytier-core/src/peers/whitelist.rs b/vendor/easytier/easytier-core/src/peers/whitelist.rs new file mode 100644 index 0000000..a7cb7e6 --- /dev/null +++ b/vendor/easytier/easytier-core/src/peers/whitelist.rs @@ -0,0 +1,18 @@ +//! Relay-network whitelist matching shared by the peer context and the +//! foreign-network manager. Kept in the peers kernel so both can depend on it +//! without depending on each other. + +pub(crate) fn check_network_in_relay_whitelist( + relay_network_whitelist: &str, + network_name: &str, +) -> Result<(), anyhow::Error> { + if relay_network_whitelist + .split(' ') + .map(wildmatch::WildMatch::new) + .any(|whitelist| whitelist.matches(network_name)) + { + Ok(()) + } else { + Err(anyhow::anyhow!("network {} not in whitelist", network_name)) + } +} diff --git a/vendor/easytier/easytier-core/src/process_runtime.rs b/vendor/easytier/easytier-core/src/process_runtime.rs new file mode 100644 index 0000000..1b84f24 --- /dev/null +++ b/vendor/easytier/easytier-core/src/process_runtime.rs @@ -0,0 +1,415 @@ +#![cfg_attr( + not(any(feature = "management", test, target_os = "wasi")), + allow(dead_code) +)] + +//! Host-domain portable resources shared by core instances. + +use std::{ + collections::HashMap, + sync::{Arc, Mutex}, +}; + +use crate::{ + connectivity::{ + manual::{ + ManualConnectorHost, ManualConnectorOptions, ManualTunnelConnector, + discovery::{CoreManualEndpointResolver, ManualEndpointDiscoveryConfig}, + }, + protocol::ClientProtocolUpgrader, + }, + host::dns::{DnsRecordResolver, DnsResolver}, + socket::SocketListener, + socket::{ring::RingSocketId, tcp::VirtualTcpSocketFactory}, + tunnel::{Tunnel, ring::RingTunnelRegistry}, +}; + +/// Owns portable resources whose identity is shared across core instances in +/// one native process or one instantiated WASI module. +/// +/// Native composition roots pass this handle around. The WASI lifecycle keeps +/// it module-local and never exposes it through the Go ABI. Neither host can +/// receive the internal managers it owns. +#[derive(Default)] +pub struct CoreProcessRuntime { + ring_registry: Arc, + protected_tcp_ports: Arc, +} + +#[derive(Default)] +pub(crate) struct ProtectedTcpPortRegistry { + ports: Mutex>, +} + +impl ProtectedTcpPortRegistry { + fn protect(self: &Arc, port: u16) -> ProtectedTcpPortLease { + let mut ports = self.ports.lock().unwrap(); + *ports.entry(port).or_default() += 1; + ProtectedTcpPortLease { + registry: self.clone(), + port, + } + } + + pub(crate) fn contains(&self, port: u16) -> bool { + self.ports.lock().unwrap().contains_key(&port) + } +} + +pub(crate) struct ProtectedTcpPortLease { + registry: Arc, + port: u16, +} + +impl Drop for ProtectedTcpPortLease { + fn drop(&mut self) { + let mut ports = self.registry.ports.lock().unwrap(); + let ref_count = ports + .get_mut(&self.port) + .expect("protected TCP port lease must have a registry entry"); + *ref_count -= 1; + if *ref_count == 0 { + ports.remove(&self.port); + } + } +} + +impl CoreProcessRuntime { + pub fn new() -> Arc { + Arc::new(Self::default()) + } + + pub(crate) fn ring_registry(&self) -> Arc { + self.ring_registry.clone() + } + + pub(crate) fn protected_tcp_ports(&self) -> Arc { + self.protected_tcp_ports.clone() + } + + pub(crate) fn protect_tcp_port(&self, port: u16) -> ProtectedTcpPortLease { + self.protected_tcp_ports.protect(port) + } + + /// Binds an application-level Ring listener without exposing the registry + /// that owns its process namespace. + pub fn bind_ring_tunnel( + &self, + local_id: RingSocketId, + ) -> anyhow::Result>>> { + Ok(Box::new(self.ring_registry.bind(local_id)?)) + } + + /// Connects an application-level Ring tunnel in this runtime's namespace. + pub fn connect_ring_tunnel(&self, remote_id: RingSocketId) -> anyhow::Result> { + Ok(self.ring_registry.connect(remote_id)?.into_tunnel()) + } + + pub fn manual_connector( + &self, + host: Arc, + dns: Arc, + dns_records: Arc, + protocol: Arc::Socket>>, + endpoint_discovery: ManualEndpointDiscoveryConfig, + options: ManualConnectorOptions, + ) -> ManualTunnelConnector + where + H: ManualConnectorHost, + { + let endpoint_resolver = Arc::new(CoreManualEndpointResolver::new( + host.clone(), + dns.clone(), + dns_records, + endpoint_discovery, + )); + ManualTunnelConnector::new(host, dns, endpoint_resolver, protocol, options) + .with_ring_registry(self.ring_registry()) + } +} + +#[cfg(test)] +mod tests { + use std::{ + io, + net::SocketAddr, + pin::Pin, + sync::Mutex, + task::{Context, Poll}, + }; + + use async_trait::async_trait; + use futures::{SinkExt, StreamExt}; + use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; + + use super::*; + use crate::{ + connectivity::{ + manual::ManualInterfaceAddrs, + protocol::{CoreClientProtocolConfig, CoreClientProtocolUpgrader}, + }, + host::dns::{DnsQuery, DnsRecordResolver, DnsSrvRecord}, + packet::ZCPacket, + socket::{ + IpVersion, NetNamespace, SocketContext, + tcp::{TcpConnectOptions, VirtualTcpSocket}, + udp::{UdpBindOptions, VirtualUdpSocket, VirtualUdpSocketFactory}, + }, + }; + + struct TestTcpSocket; + + #[test] + fn protected_tcp_port_leases_are_ref_counted_and_runtime_scoped() { + let runtime = CoreProcessRuntime::new(); + let other_runtime = CoreProcessRuntime::new(); + + let first = runtime.protect_tcp_port(15888); + let second = runtime.protect_tcp_port(15888); + assert!(runtime.protected_tcp_ports().contains(15888)); + assert!(!other_runtime.protected_tcp_ports().contains(15888)); + + drop(first); + assert!(runtime.protected_tcp_ports().contains(15888)); + + drop(second); + assert!(!runtime.protected_tcp_ports().contains(15888)); + } + + impl AsyncRead for TestTcpSocket { + fn poll_read( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + _buf: &mut ReadBuf<'_>, + ) -> Poll> { + Poll::Pending + } + } + + impl AsyncWrite for TestTcpSocket { + fn poll_write( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + _buf: &[u8], + ) -> Poll> { + Poll::Pending + } + + fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll> { + Poll::Ready(Ok(())) + } + + fn poll_shutdown(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll> { + Poll::Ready(Ok(())) + } + } + + impl VirtualTcpSocket for TestTcpSocket { + fn local_addr(&self) -> io::Result { + Ok("127.0.0.1:1".parse().unwrap()) + } + + fn peer_addr(&self) -> io::Result { + Ok("127.0.0.1:2".parse().unwrap()) + } + } + + struct TestUdpSocket; + + #[async_trait] + impl VirtualUdpSocket for TestUdpSocket { + fn local_addr(&self) -> io::Result { + Ok("127.0.0.1:1".parse().unwrap()) + } + + async fn send_to(&self, _data: &[u8], _addr: SocketAddr) -> io::Result { + unreachable!("Ring connector must not use UDP") + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + unreachable!("Ring connector must not use UDP") + } + } + + struct TestHost; + + #[async_trait] + impl VirtualTcpSocketFactory for TestHost { + type Socket = TestTcpSocket; + + async fn connect_tcp(&self, _options: TcpConnectOptions) -> anyhow::Result { + anyhow::bail!("Ring connector must not use TCP") + } + } + + #[async_trait] + impl VirtualUdpSocketFactory for TestHost { + type Socket = TestUdpSocket; + + async fn bind_udp(&self, _options: UdpBindOptions) -> anyhow::Result> { + anyhow::bail!("Ring connector must not use UDP") + } + } + + #[async_trait] + impl ManualConnectorHost for TestHost { + async fn local_addr_for_remote( + &self, + _remote_addr: SocketAddr, + _context: SocketContext, + ) -> anyhow::Result { + anyhow::bail!("Ring connector must not probe routes") + } + + async fn interface_addrs(&self) -> anyhow::Result { + anyhow::bail!("Ring connector must not collect interfaces") + } + } + + struct TestDns; + + #[async_trait] + impl DnsResolver for TestDns { + async fn resolve(&self, _query: DnsQuery) -> anyhow::Result> { + anyhow::bail!("Ring connector must not resolve DNS") + } + } + + #[async_trait] + impl DnsRecordResolver for TestDns { + async fn resolve_txt(&self, _query: DnsQuery) -> anyhow::Result { + anyhow::bail!("Ring connector must not resolve TXT records") + } + + async fn resolve_srv(&self, _query: DnsQuery) -> anyhow::Result> { + anyhow::bail!("Ring connector must not resolve SRV records") + } + } + + struct RecordingDnsRecords { + endpoint: String, + queries: Arc>>, + } + + #[async_trait] + impl DnsRecordResolver for RecordingDnsRecords { + async fn resolve_txt(&self, query: DnsQuery) -> anyhow::Result { + self.queries.lock().unwrap().push(query); + Ok(self.endpoint.clone()) + } + + async fn resolve_srv(&self, _query: DnsQuery) -> anyhow::Result> { + anyhow::bail!("TXT discovery must not resolve SRV records") + } + } + + fn manual_connector(runtime: &Arc) -> ManualTunnelConnector { + runtime.manual_connector( + Arc::new(TestHost), + Arc::new(TestDns), + Arc::new(TestDns), + Arc::new(CoreClientProtocolUpgrader::::new( + CoreClientProtocolConfig::default(), + )), + ManualEndpointDiscoveryConfig::default(), + ManualConnectorOptions::default(), + ) + } + + #[test] + fn instances_share_ring_state_only_through_the_process_runtime() { + let runtime = CoreProcessRuntime::new(); + + assert!(Arc::ptr_eq( + &runtime.ring_registry(), + &runtime.ring_registry() + )); + assert!(!Arc::ptr_eq( + &runtime.ring_registry(), + &CoreProcessRuntime::new().ring_registry() + )); + } + + #[tokio::test] + async fn one_shot_ring_connector_uses_its_process_runtime_namespace() { + let runtime = CoreProcessRuntime::new(); + let isolated = CoreProcessRuntime::new(); + let listener_id = uuid::Uuid::new_v4(); + let mut listener = runtime.bind_ring_tunnel(listener_id).unwrap(); + let url: url::Url = format!("ring://{listener_id}").parse().unwrap(); + + assert!( + manual_connector(&isolated) + .connect(url.clone(), IpVersion::Both) + .await + .is_err() + ); + + let client = manual_connector(&runtime) + .connect(url, IpVersion::Both) + .await + .unwrap(); + let server = listener.accept().await.unwrap(); + let (_client_stream, mut client_sink) = client.split(); + let (mut server_stream, _server_sink) = server.split(); + client_sink + .send(ZCPacket::new_with_payload(b"process-runtime")) + .await + .unwrap(); + + assert_eq!( + server_stream.next().await.unwrap().unwrap().payload(), + b"process-runtime" + ); + } + + #[cfg(feature = "endpoint-discovery")] + #[tokio::test] + async fn one_shot_connector_owns_endpoint_discovery_wiring() { + let runtime = CoreProcessRuntime::new(); + let listener_id = uuid::Uuid::new_v4(); + let mut listener = runtime.bind_ring_tunnel(listener_id).unwrap(); + let queries = Arc::new(Mutex::new(Vec::new())); + let dns_context = SocketContext::new() + .with_ip_version(IpVersion::V6) + .with_socket_mark(Some(42)) + .with_netns(Some(NetNamespace::new("discovery-netns"))); + let connector = runtime.manual_connector( + Arc::new(TestHost), + Arc::new(TestDns), + Arc::new(RecordingDnsRecords { + endpoint: format!("ring://{listener_id}"), + queries: queries.clone(), + }), + Arc::new(CoreClientProtocolUpgrader::::new( + CoreClientProtocolConfig::default(), + )), + ManualEndpointDiscoveryConfig { + dns_record_context: dns_context.clone(), + ..Default::default() + }, + ManualConnectorOptions::default(), + ); + + let client = connector + .connect("txt://bootstrap.example".parse().unwrap(), IpVersion::Both) + .await + .unwrap(); + let server = listener.accept().await.unwrap(); + + assert_eq!( + *queries.lock().unwrap(), + vec![DnsQuery::new("bootstrap.example", dns_context)] + ); + let (_client_stream, mut client_sink) = client.split(); + let (mut server_stream, _server_sink) = server.split(); + client_sink + .send(ZCPacket::new_with_payload(b"endpoint-discovery")) + .await + .unwrap(); + assert_eq!( + server_stream.next().await.unwrap().unwrap().payload(), + b"endpoint-discovery" + ); + } +} diff --git a/vendor/easytier/easytier-core/src/rpc/bidirect.rs b/vendor/easytier/easytier-core/src/rpc/bidirect.rs new file mode 100644 index 0000000..2d61b6c --- /dev/null +++ b/vendor/easytier/easytier-core/src/rpc/bidirect.rs @@ -0,0 +1,259 @@ +use std::sync::{ + Arc, Mutex, + atomic::{AtomicBool, Ordering}, +}; + +use futures::{SinkExt as _, StreamExt}; +use tokio::task::JoinSet; + +use crate::{ + foundation::{ + stats::{ArcRpcMetrics, RpcMetricsProvider}, + time::timeout, + }, + packet::PacketType, + proto::rpc_types::error::Error, + tunnel::{Tunnel, ring::create_ring_tunnel_pair}, +}; + +use super::{client::Client, server::Server, service_registry::ServiceRegistry}; + +pub struct BidirectRpcManager { + rpc_client: Client, + rpc_server: Server, + + rx_timeout: Option, + error: Arc>>, + tunnel: Mutex>>, + running: Arc, + + tasks: Mutex>>, +} + +impl Default for BidirectRpcManager { + fn default() -> Self { + Self::new() + } +} + +impl BidirectRpcManager { + pub fn new() -> Self { + Self { + rpc_client: Client::new(), + rpc_server: Server::new(), + + rx_timeout: None, + error: Arc::new(Mutex::new(None)), + tunnel: Mutex::new(None), + running: Arc::new(AtomicBool::new(false)), + + tasks: Mutex::new(None), + } + } + + pub fn new_with_stats_manager(stats_manager: T) -> Self + where + T: Clone + RpcMetricsProvider, + { + Self { + rpc_client: Client::new_with_stats_manager(stats_manager.clone()), + rpc_server: Server::new_with_registry_and_stats_manager( + Arc::new(ServiceRegistry::new()), + stats_manager, + ), + + rx_timeout: None, + error: Arc::new(Mutex::new(None)), + tunnel: Mutex::new(None), + running: Arc::new(AtomicBool::new(false)), + + tasks: Mutex::new(None), + } + } + + pub fn new_with_metrics(metrics: ArcRpcMetrics) -> Self { + Self { + rpc_client: Client::new_with_metrics(metrics.clone()), + rpc_server: Server::new_with_registry_and_metrics( + Arc::new(ServiceRegistry::new()), + metrics, + ), + + rx_timeout: None, + error: Arc::new(Mutex::new(None)), + tunnel: Mutex::new(None), + running: Arc::new(AtomicBool::new(false)), + + tasks: Mutex::new(None), + } + } + + pub fn set_rx_timeout(mut self, timeout: Option) -> Self { + self.rx_timeout = timeout; + self + } + + pub fn run_and_create_tunnel(&self) -> Box { + let (ret, inner) = create_ring_tunnel_pair(); + self.run_with_tunnel(inner); + ret + } + + pub fn run_with_tunnel(&self, inner: Box) { + let tunnel_info = inner.info(); + self.run_with_tunnel_info(inner, tunnel_info); + } + + pub(crate) fn run_with_tunnel_info( + &self, + inner: Box, + tunnel_info: Option, + ) { + let mut tasks = JoinSet::new(); + self.rpc_client.run(); + self.rpc_server.run_with_tunnel_info(tunnel_info); + self.running.store(true, Ordering::Relaxed); + + let (server_tx, mut server_rx) = ( + self.rpc_server.get_transport_sink(), + self.rpc_server.get_transport_stream(), + ); + let (client_tx, mut client_rx) = ( + self.rpc_client.get_transport_sink(), + self.rpc_client.get_transport_stream(), + ); + + let (mut inner_rx, mut inner_tx) = inner.split(); + self.tunnel.lock().unwrap().replace(inner); + + let e_clone = self.error.clone(); + let r_clone = self.running.clone(); + tasks.spawn(async move { + loop { + let packet = tokio::select! { + Some(Ok(packet)) = server_rx.next() => { + tracing::trace!(?packet, "recv rpc packet from server"); + packet + } + Some(Ok(packet)) = client_rx.next() => { + tracing::trace!(?packet, "recv rpc packet from client"); + packet + } + else => { + tracing::warn!("rpc transport read aborted, exiting"); + r_clone.store(false, Ordering::Relaxed); + break; + } + }; + + if let Err(e) = inner_tx.send(packet).await { + tracing::error!(error = ?e, "send to peer failed"); + e_clone.lock().unwrap().replace(Error::from(e)); + r_clone.store(false, Ordering::Relaxed); + break; + } + } + }); + + let recv_timeout = self.rx_timeout; + let e_clone = self.error.clone(); + let r_clone = self.running.clone(); + tasks.spawn(async move { + loop { + let ret = if let Some(recv_timeout) = recv_timeout { + match timeout(recv_timeout, inner_rx.next()).await { + Ok(ret) => ret, + Err(e) => { + e_clone.lock().unwrap().replace(e.into()); + r_clone.store(false, Ordering::Relaxed); + break; + } + } + } else { + inner_rx.next().await + }; + + let o = match ret { + Some(Ok(o)) => o, + Some(Err(e)) => { + tracing::error!(error = ?e, "recv from peer failed"); + e_clone.lock().unwrap().replace(Error::from(e)); + r_clone.store(false, Ordering::Relaxed); + break; + } + None => { + tracing::warn!("peer rpc transport read aborted, exiting"); + e_clone.lock().unwrap().replace(Error::Shutdown); + r_clone.store(false, Ordering::Relaxed); + break; + } + }; + + let Some(peer_manager_header) = o.peer_manager_header() else { + tracing::error!("peer manager header not found"); + continue; + }; + if peer_manager_header.packet_type == PacketType::RpcReq as u8 { + if let Err(e) = server_tx.send(o).await { + tracing::error!(error = ?e, "send rpc request to server failed"); + e_clone.lock().unwrap().replace(Error::from(e)); + r_clone.store(false, Ordering::Relaxed); + break; + } + continue; + } else if peer_manager_header.packet_type == PacketType::RpcResp as u8 { + if let Err(e) = client_tx.send(o).await { + tracing::error!(error = ?e, "send rpc response to client failed"); + e_clone.lock().unwrap().replace(Error::from(e)); + r_clone.store(false, Ordering::Relaxed); + break; + } + continue; + } + } + }); + + self.tasks.lock().unwrap().replace(tasks); + } + + pub fn rpc_client(&self) -> &Client { + &self.rpc_client + } + + pub fn rpc_server(&self) -> &Server { + &self.rpc_server + } + + pub async fn stop(&self) { + self.running.store(false, Ordering::Relaxed); + self.tunnel.lock().unwrap().take(); + self.rpc_client.stop().await; + self.rpc_server.stop().await; + let Some(mut tasks) = self.tasks.lock().unwrap().take() else { + return; + }; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + } + + pub fn take_error(&self) -> Option { + self.error.lock().unwrap().take() + } + + pub async fn wait(&self) { + let Some(mut tasks) = self.tasks.lock().unwrap().take() else { + return; + }; + while tasks.join_next().await.is_some() { + tasks.abort_all(); + } + self.running.store(false, Ordering::Relaxed); + self.tunnel.lock().unwrap().take(); + self.rpc_client.stop().await; + self.rpc_server.stop().await; + } + + pub fn is_running(&self) -> bool { + self.running.load(Ordering::Relaxed) + } +} diff --git a/vendor/easytier/easytier-core/src/rpc/client.rs b/vendor/easytier/easytier-core/src/rpc/client.rs new file mode 100644 index 0000000..f35b51b --- /dev/null +++ b/vendor/easytier/easytier-core/src/rpc/client.rs @@ -0,0 +1,448 @@ +use std::{ + marker::PhantomData, + pin::Pin, + sync::{Arc, LazyLock, Mutex, atomic::Ordering}, +}; + +use atomic_shim::AtomicI64; +use bytes::Bytes; +use dashmap::DashMap; +use futures::StreamExt; +use prost::Message; +use tokio::{sync::mpsc, task::JoinSet}; + +use crate::{ + config::PeerId, + foundation::{ + stats::{ArcRpcMetrics, RpcMetricLabels, RpcMetricsProvider}, + time::timeout, + }, + proto::{ + common::{RpcCompressionInfo, RpcDescriptor, RpcPacket, RpcRequest, RpcResponse}, + rpc_types::controller::Controller, + rpc_types::descriptor::MethodDescriptor, + rpc_types::error::{Error, Result}, + rpc_types::{__rt::RpcClientFactory, descriptor::ServiceDescriptor, handler::Handler}, + }, + rpc::packet::{ + BuildRpcPacketArgs, PacketMerger, accepted_compression_algo, build_rpc_packet, + compress_packet, decompress_packet, + }, + tunnel::{ + Tunnel, TunnelError, ZCPacketStream, + mpsc::{MpscTunnel, MpscTunnelSender}, + ring::create_ring_tunnel_pair, + }, +}; + +use super::{RpcTransactId, Transport}; + +static CUR_TID: LazyLock = LazyLock::new(|| AtomicI64::new(rand::random())); + +type RpcPacketSender = mpsc::UnboundedSender; +type RpcPacketReceiver = mpsc::UnboundedReceiver; + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +struct InflightRequestKey { + from_peer_id: PeerId, + to_peer_id: PeerId, + transaction_id: RpcTransactId, +} + +struct InflightRequest { + sender: RpcPacketSender, + merger: PacketMerger, + start_time: std::time::Instant, +} + +impl std::fmt::Debug for InflightRequest { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("InflightRequest") + .field("sender", &self.sender) + .field("start_time", &self.start_time) + .finish() + } +} + +struct InflightCleanup { + table: InflightRequestTable, + key: InflightRequestKey, +} + +impl Drop for InflightCleanup { + fn drop(&mut self) { + self.table.remove(&self.key); + if self.table.capacity() - self.table.len() > 4 { + self.table.shrink_to_fit(); + } + } +} + +#[derive(Debug, Clone, Default)] +pub struct PeerInfo { + pub peer_id: PeerId, + pub compression_info: RpcCompressionInfo, + pub last_active: Option, +} + +type InflightRequestTable = Arc>; +pub type PeerInfoTable = Arc>; + +pub struct Client { + mpsc: Mutex>>, + transport: Mutex, + inflight_requests: InflightRequestTable, + peer_info: PeerInfoTable, + tasks: Mutex>, + metrics: Option, +} + +impl Default for Client { + fn default() -> Self { + Self::new() + } +} + +impl Client { + pub fn new() -> Self { + let (ring_a, ring_b) = create_ring_tunnel_pair(); + Self { + mpsc: Mutex::new(MpscTunnel::new(ring_a, None)), + transport: Mutex::new(MpscTunnel::new(ring_b, None)), + inflight_requests: Arc::new(DashMap::new()), + peer_info: Arc::new(DashMap::new()), + tasks: Mutex::new(JoinSet::new()), + metrics: None, + } + } + + pub fn new_with_stats_manager(stats_manager: T) -> Self + where + T: RpcMetricsProvider, + { + let mut client = Self::new(); + client.metrics = stats_manager.into_rpc_metrics(); + client + } + + pub fn new_with_metrics(metrics: ArcRpcMetrics) -> Self { + let mut client = Self::new(); + client.metrics = Some(metrics); + client + } + + pub fn get_transport_sink(&self) -> MpscTunnelSender { + self.transport.lock().unwrap().get_sink() + } + + pub fn get_transport_stream(&self) -> Pin> { + self.transport.lock().unwrap().get_stream() + } + + pub fn run(&self) { + let mut tasks = self.tasks.lock().unwrap(); + + let peer_infos = self.peer_info.clone(); + tasks.spawn(async move { + loop { + crate::foundation::time::sleep(std::time::Duration::from_secs(30)).await; + let now = std::time::Instant::now(); + peer_infos.retain(|_, v| { + if let Some(last_active) = v.last_active { + return now.duration_since(last_active) + < std::time::Duration::from_secs(120); + } + true + }); + peer_infos.shrink_to_fit(); + } + }); + + let mut rx = self.mpsc.lock().unwrap().get_stream(); + let inflight_requests = self.inflight_requests.clone(); + tasks.spawn(async move { + while let Some(packet) = rx.next().await { + let packet = match packet { + Err(err) => { + tracing::error!(?err, "Failed to receive packet"); + continue; + } + Ok(packet) => packet, + }; + let packet = match RpcPacket::decode(packet.payload()) { + Err(err) => { + tracing::error!(?err, "Failed to decode packet"); + continue; + } + Ok(packet) => packet, + }; + + if packet.is_request { + tracing::warn!(?packet, "Received non-response packet"); + continue; + } + + let key = InflightRequestKey { + from_peer_id: packet.to_peer, + to_peer_id: packet.from_peer, + transaction_id: packet.transaction_id, + }; + + let Some(mut inflight_request) = inflight_requests.get_mut(&key) else { + tracing::warn!( + ?key, + ?inflight_requests, + "No inflight request found for key" + ); + continue; + }; + + tracing::trace!(?packet, "Received response packet"); + + let ret = inflight_request.merger.feed(packet); + match ret { + Ok(Some(rpc_packet)) => { + if let Err(err) = inflight_request.sender.send(rpc_packet) { + tracing::warn!( + ?err, + ?key, + "RPC response receiver is gone, removing inflight request" + ); + drop(inflight_request); + inflight_requests.remove(&key); + } + } + Ok(None) => {} + Err(err) => { + tracing::error!(?err, "Failed to feed packet to merger"); + } + } + } + }); + } + + pub fn scoped_client( + &self, + from_peer_id: PeerId, + to_peer_id: PeerId, + domain_name: String, + ) -> F::ClientImpl { + #[derive(Clone)] + struct HandlerImpl { + domain_name: String, + from_peer_id: PeerId, + to_peer_id: PeerId, + zc_packet_sender: MpscTunnelSender, + inflight_requests: InflightRequestTable, + peer_info: PeerInfoTable, + metrics: Option, + _phan: PhantomData, + } + + impl HandlerImpl { + async fn do_rpc( + &self, + packets: Vec, + rx: &mut RpcPacketReceiver, + ) -> Result { + for packet in packets { + self.zc_packet_sender.send(packet).await?; + } + + Ok(rx.recv().await.ok_or(TunnelError::Shutdown)?) + } + } + + #[async_trait::async_trait] + impl Handler for HandlerImpl { + type Descriptor = F::Descriptor; + type Controller = F::Controller; + + async fn call( + &self, + mut ctrl: Self::Controller, + method: ::Method, + input: Bytes, + ) -> Result { + let start_time = std::time::Instant::now(); + let transaction_id = CUR_TID.fetch_add(1, Ordering::Relaxed); + let (tx, mut rx) = mpsc::unbounded_channel(); + let key = InflightRequestKey { + from_peer_id: self.from_peer_id, + to_peer_id: self.to_peer_id, + transaction_id, + }; + let desc = self.service_descriptor(); + let labels = RpcMetricLabels { + network_name: self.domain_name.clone(), + src_peer_id: self.from_peer_id, + dst_peer_id: self.to_peer_id, + service_name: desc.name().to_string(), + method_name: method.name().to_string(), + }; + + self.inflight_requests.insert( + key.clone(), + InflightRequest { + sender: tx, + merger: PacketMerger::new(), + start_time, + }, + ); + let _cleanup = InflightCleanup { + table: self.inflight_requests.clone(), + key: key.clone(), + }; + + if let Some(metrics) = &self.metrics { + metrics.client_tx(&labels); + } + + let rpc_desc = RpcDescriptor { + domain_name: self.domain_name.clone(), + proto_name: desc.proto_name().to_string(), + service_name: desc.name().to_string(), + method_index: method.index() as u32, + }; + + let rpc_req = RpcRequest { + request: if let Some(raw_input) = ctrl.get_raw_input() { + raw_input.into() + } else { + input.into() + }, + timeout_ms: ctrl.timeout_ms(), + ..Default::default() + }; + + let peer_info = self + .peer_info + .get(&self.to_peer_id) + .map(|v| v.clone()) + .unwrap_or_default(); + let (buf, c_algo) = compress_packet( + peer_info.compression_info.accepted_algo(), + &rpc_req.encode_to_vec(), + ) + .await + .unwrap(); + + let packets = build_rpc_packet(BuildRpcPacketArgs { + from_peer: self.from_peer_id, + to_peer: self.to_peer_id, + rpc_desc, + transaction_id, + is_req: true, + content: &buf, + trace_id: ctrl.trace_id(), + compression_info: RpcCompressionInfo { + algo: c_algo.into(), + accepted_algo: accepted_compression_algo().into(), + }, + }); + let timeout_dur = std::time::Duration::from_millis(ctrl.timeout_ms() as u64); + let rpc_ret = timeout(timeout_dur, self.do_rpc(packets, &mut rx)).await; + let mut rpc_packet = match rpc_ret { + Ok(Ok(packet)) => packet, + Ok(Err(err)) => { + if let Some(metrics) = &self.metrics { + metrics.client_error( + &labels, + Some(format!("{:?}", err)), + start_time.elapsed().as_millis() as u64, + ); + } + return Err(err); + } + Err(err) => { + let err = Error::from(err); + if let Some(metrics) = &self.metrics { + metrics.client_error( + &labels, + Some(format!("{:?}", err)), + start_time.elapsed().as_millis() as u64, + ); + } + return Err(err); + } + }; + + if let Some(compression_info) = rpc_packet.compression_info { + self.peer_info.insert( + self.to_peer_id, + PeerInfo { + peer_id: self.to_peer_id, + compression_info, + last_active: Some(std::time::Instant::now()), + }, + ); + + rpc_packet.body = + decompress_packet(compression_info.algo(), &rpc_packet.body).await?; + } + + assert_eq!(rpc_packet.transaction_id, transaction_id); + + let rpc_resp = RpcResponse::decode(Bytes::from(rpc_packet.body))?; + + if let Some(err) = &rpc_resp.error { + if let Some(metrics) = &self.metrics { + metrics.client_error( + &labels, + Some(format!("{:?}", err.error_kind)), + start_time.elapsed().as_millis() as u64, + ); + } + return Err(err.into()); + } + + let raw_output = Bytes::from(rpc_resp.response); + ctrl.set_raw_output(raw_output.clone()); + + if let Some(metrics) = &self.metrics { + metrics.client_rx(&labels, start_time.elapsed().as_millis() as u64); + } + + Ok(raw_output) + } + } + + F::new(HandlerImpl:: { + domain_name, + from_peer_id, + to_peer_id, + zc_packet_sender: self.mpsc.lock().unwrap().get_sink(), + inflight_requests: self.inflight_requests.clone(), + peer_info: self.peer_info.clone(), + metrics: self.metrics.clone(), + _phan: PhantomData, + }) + } + + pub async fn stop(&self) { + self.transport.lock().unwrap().close(); + let mut tasks = { + let mut task_slot = self.tasks.lock().unwrap(); + std::mem::replace(&mut *task_slot, JoinSet::new()) + }; + tasks.abort_all(); + while tasks.join_next().await.is_some() {} + } +} + +#[cfg(any(test, feature = "test-utils"))] +mod test_utils { + use super::{Client, PeerInfoTable}; + + impl Client { + #[doc(hidden)] + pub fn inflight_count(&self) -> usize { + self.inflight_requests.len() + } + + #[doc(hidden)] + pub fn peer_info_table(&self) -> PeerInfoTable { + self.peer_info.clone() + } + } +} diff --git a/vendor/easytier/easytier-core/src/rpc/dispatch.rs b/vendor/easytier/easytier-core/src/rpc/dispatch.rs new file mode 100644 index 0000000..b6c6b99 --- /dev/null +++ b/vendor/easytier/easytier-core/src/rpc/dispatch.rs @@ -0,0 +1,50 @@ +//! Transport-neutral dispatch for one decoded RPC request. + +use bytes::Bytes; +use std::time::Duration; + +use crate::{ + foundation::time::timeout, + proto::{ + common::{RpcDescriptor, RpcRequest, TunnelInfo}, + rpc_types::{ + controller::{BaseController, Controller as _}, + error::Result, + }, + }, + rpc::service_registry::ServiceRegistry, +}; + +pub(crate) async fn dispatch_request( + registry: &ServiceRegistry, + descriptor: RpcDescriptor, + request: RpcRequest, + tunnel_info: Option, +) -> Result { + dispatch_payload( + registry, + descriptor, + Bytes::from(request.request), + Some(Duration::from_millis(request.timeout_ms as u64)), + tunnel_info, + ) + .await +} + +pub(crate) async fn dispatch_payload( + registry: &ServiceRegistry, + descriptor: RpcDescriptor, + raw_request: Bytes, + timeout_duration: Option, + tunnel_info: Option, +) -> Result { + let mut controller = BaseController::default(); + controller.set_raw_input(raw_request.clone()); + controller.set_tunnel_info(tunnel_info); + let call = registry.call_method(descriptor, controller.clone(), raw_request); + let response = match timeout_duration { + Some(duration) => timeout(duration, call).await??, + None => call.await?, + }; + Ok(controller.get_raw_output().unwrap_or(response)) +} diff --git a/vendor/easytier/easytier-core/src/rpc/mod.rs b/vendor/easytier/easytier-core/src/rpc/mod.rs new file mode 100644 index 0000000..3b35f3e --- /dev/null +++ b/vendor/easytier/easytier-core/src/rpc/mod.rs @@ -0,0 +1,16 @@ +use crate::tunnel::{Tunnel, mpsc::MpscTunnel}; + +pub type RpcController = crate::proto::rpc_types::controller::BaseController; + +pub mod bidirect; +pub mod client; +pub(crate) mod dispatch; +#[cfg(all(feature = "management-rpc", any(test, target_os = "wasi")))] +pub(crate) mod operation; +pub mod packet; +pub mod server; +pub mod service_registry; +pub mod standalone; + +pub type Transport = MpscTunnel>; +pub type RpcTransactId = i64; diff --git a/vendor/easytier/easytier-core/src/rpc/operation.rs b/vendor/easytier/easytier-core/src/rpc/operation.rs new file mode 100644 index 0000000..efbe55a --- /dev/null +++ b/vendor/easytier/easytier-core/src/rpc/operation.rs @@ -0,0 +1,430 @@ +//! Asynchronous local RPC operations backed by the shared operation broker. + +use std::sync::{Arc, Mutex}; + +use prost::Message; + +use crate::{ + foundation::operation_broker::{ + AccessError as BrokerAccessError, AdmissionError, OperationBroker, OperationId, + }, + proto::{ + common::{DirectRpcRequest, RpcResponse}, + rpc_types::error, + }, + rpc::{dispatch::dispatch_payload, service_registry::ServiceRegistry}, +}; + +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +#[repr(transparent)] +pub(crate) struct RpcOperationId(OperationId); + +impl RpcOperationId { + #[cfg(target_os = "wasi")] + pub(crate) fn from_raw(value: u64) -> Option { + OperationId::from_raw(value).map(Self) + } + + #[cfg(target_os = "wasi")] + pub(crate) fn get(self) -> u64 { + self.0.get() + } +} + +#[derive(Debug, thiserror::Error)] +pub(crate) enum RpcSubmitError { + #[error("invalid RPC request protobuf: {0}")] + Decode(#[from] prost::DecodeError), + #[error("RPC full method name is required")] + MissingMethod, + #[error("too many outstanding RPC operations")] + AtCapacity, + #[error("RPC operation ID space is exhausted")] + IdExhausted, + #[error("RPC submission requires an active Tokio runtime")] + ExecutorUnavailable, +} + +#[derive(Clone, Copy, Debug, Eq, PartialEq, thiserror::Error)] +pub(crate) enum RpcAccessError { + #[error("unknown RPC operation")] + Missing, + #[error("RPC response is pending")] + Pending, +} + +struct RpcOperationState { + broker: OperationBroker<(), Vec, ()>, +} + +pub(crate) struct RpcOperationSession { + registry: Arc, + state: Arc>, + max_response_len: usize, +} + +impl RpcOperationSession { + pub(crate) fn new( + registry: Arc, + max_operations: usize, + max_response_len: usize, + ) -> Self { + Self { + registry, + state: Arc::new(Mutex::new(RpcOperationState { + broker: OperationBroker::new(max_operations), + })), + max_response_len, + } + } + + pub(crate) fn submit_encoded( + &self, + encoded_request: &[u8], + ) -> Result { + let request = DirectRpcRequest::decode(encoded_request)?; + if request.full_method_name.is_empty() { + return Err(RpcSubmitError::MissingMethod); + } + let executor = tokio::runtime::Handle::try_current() + .map_err(|_| RpcSubmitError::ExecutorUnavailable)?; + let admission = self + .state + .lock() + .unwrap_or_else(|error| error.into_inner()) + .broker + .admit((), ()) + .map_err(|error| match error { + AdmissionError::AtCapacity => RpcSubmitError::AtCapacity, + AdmissionError::IdExhausted => RpcSubmitError::IdExhausted, + })?; + let operation_id = RpcOperationId(admission.id); + let cancellation = admission.cancellation; + let registry = self.registry.clone(); + let state = self.state.clone(); + let max_response_len = self.max_response_len; + + executor.spawn(async move { + let started = std::time::Instant::now(); + let response = tokio::select! { + _ = cancellation.cancelled() => None, + result = async { + let descriptor = registry + .resolve_method("", &request.full_method_name) + .ok_or_else(|| { + error::Error::InvalidServiceKey( + request.full_method_name.clone(), + String::new(), + ) + })?; + dispatch_payload( + registry.as_ref(), + descriptor, + request.request.into(), + request + .timeout_ms + .map(std::time::Duration::from_millis), + None, + ) + .await + } => { + Some(encode_response( + result, + started.elapsed().as_micros() as u64, + max_response_len, + )) + } + }; + let mut state = state.lock().unwrap_or_else(|error| error.into_inner()); + state + .broker + .complete_with(operation_id.0, |_, _| response.unwrap_or_default()); + }); + Ok(operation_id) + } + + pub(crate) fn response_len( + &self, + operation_id: RpcOperationId, + ) -> Result { + let mut state = self.state.lock().unwrap_or_else(|error| error.into_inner()); + state.broker.drain(usize::MAX, |_| ()); + state + .broker + .with_drained(operation_id.0, |_, _, response| response.len()) + .map_err(map_access_error) + } + + pub(crate) fn take_response_with( + &self, + operation_id: RpcOperationId, + take: impl FnOnce(&[u8]) -> Option, + ) -> Result, RpcAccessError> { + let mut state = self.state.lock().unwrap_or_else(|error| error.into_inner()); + state.broker.drain(usize::MAX, |_| ()); + state + .broker + .take_with(operation_id.0, |response| take(response)) + .map(|taken| taken.map(|taken| taken.value)) + .map_err(map_access_error) + } + + pub(crate) fn free(&self, operation_id: RpcOperationId) -> bool { + self.state + .lock() + .unwrap_or_else(|error| error.into_inner()) + .broker + .free(operation_id.0) + .is_some() + } + + #[cfg(target_os = "wasi")] + pub(crate) fn discard_all(&self) { + self.state + .lock() + .unwrap_or_else(|error| error.into_inner()) + .broker + .discard_all(); + } +} + +fn map_access_error(error: BrokerAccessError) -> RpcAccessError { + match error { + BrokerAccessError::Missing => RpcAccessError::Missing, + BrokerAccessError::NotDrained => RpcAccessError::Pending, + } +} + +fn encode_response( + result: error::Result, + runtime_us: u64, + max_response_len: usize, +) -> Vec { + let mut response = RpcResponse::default(); + match result { + Ok(bytes) => response.response = bytes.into(), + Err(error) => response.error = Some((&error).into()), + } + response.runtime_us = runtime_us; + let encoded = response.encode_to_vec(); + if encoded.len() <= max_response_len { + return encoded; + } + + let error = error::Error::ExecutionError(anyhow::anyhow!( + "RPC response length {} exceeds ABI limit {}", + encoded.len(), + max_response_len + )); + RpcResponse { + error: Some((&error).into()), + ..Default::default() + } + .encode_to_vec() +} + +#[cfg(test)] +mod tests { + use std::any::TypeId; + + use bytes::Bytes; + use easytier_proto::rpc_types::{ + controller::BaseController, + descriptor::{MethodDescriptor, ServiceDescriptor}, + handler::Handler, + }; + + use super::*; + + #[derive(Clone, Copy, Debug)] + enum TestMethod { + Echo, + } + + impl TryFrom for TestMethod { + type Error = (); + + fn try_from(index: u8) -> Result { + match index { + 0 => Ok(Self::Echo), + _ => Err(()), + } + } + } + + impl MethodDescriptor for TestMethod { + fn name(&self) -> &'static str { + "Echo" + } + + fn proto_name(&self) -> &'static str { + "Echo" + } + + fn input_type(&self) -> TypeId { + TypeId::of::>() + } + + fn input_proto_type(&self) -> &'static str { + "bytes" + } + + fn output_type(&self) -> TypeId { + TypeId::of::>() + } + + fn output_proto_type(&self) -> &'static str { + "bytes" + } + + fn index(&self) -> u8 { + 0 + } + } + + #[derive(Clone, Debug, Default)] + struct TestService; + + impl ServiceDescriptor for TestService { + type Method = TestMethod; + + fn name(&self) -> &'static str { + "EchoService" + } + + fn proto_name(&self) -> &'static str { + "test" + } + + fn methods(&self) -> &'static [Self::Method] { + &[TestMethod::Echo] + } + } + + #[derive(Clone)] + struct TestHandler; + + #[async_trait::async_trait] + impl Handler for TestHandler { + type Descriptor = TestService; + type Controller = BaseController; + + async fn call( + &self, + _: Self::Controller, + _: TestMethod, + input: Bytes, + ) -> error::Result { + if input == b"pending"[..] { + std::future::pending().await + } + Ok(input) + } + } + + fn request(full_method_name: &str, payload: &[u8]) -> Vec { + DirectRpcRequest { + full_method_name: full_method_name.to_owned(), + request: payload.to_vec(), + timeout_ms: None, + } + .encode_to_vec() + } + + fn session(max_operations: usize) -> RpcOperationSession { + let registry = Arc::new(ServiceRegistry::new()); + registry.register(TestHandler, ""); + RpcOperationSession::new(registry, max_operations, 1024) + } + + async fn wait_ready(session: &RpcOperationSession, operation: RpcOperationId) -> usize { + for _ in 0..16 { + match session.response_len(operation) { + Ok(length) => return length, + Err(RpcAccessError::Pending) => tokio::task::yield_now().await, + Err(error) => panic!("unexpected RPC access error: {error}"), + } + } + panic!("RPC operation did not complete"); + } + + #[tokio::test] + async fn dispatches_and_consumes_a_protobuf_rpc_response_once() { + let session = session(4); + let operation = session + .submit_encoded(&request("test.Echo", b"hello")) + .unwrap(); + let expected_len = wait_ready(&session, operation).await; + assert!( + session + .take_response_with(operation, |_| None::<()>) + .unwrap() + .is_none() + ); + assert_eq!(session.response_len(operation), Ok(expected_len)); + let mut encoded_response = Vec::new(); + let taken = session + .take_response_with(operation, |response| { + encoded_response.extend_from_slice(response); + Some(response.len()) + }) + .unwrap(); + + assert_eq!(taken, Some(expected_len)); + let response = RpcResponse::decode(encoded_response.as_slice()).unwrap(); + assert_eq!(response.response, b"hello"); + assert!(response.error.is_none()); + assert_eq!( + session.response_len(operation), + Err(RpcAccessError::Missing) + ); + } + + #[tokio::test] + async fn rpc_dispatch_errors_stay_inside_the_response_envelope() { + let session = session(4); + let operation = session + .submit_encoded(&request("test.Missing", b"request")) + .unwrap(); + wait_ready(&session, operation).await; + let mut encoded_response = Vec::new(); + session + .take_response_with(operation, |response| { + encoded_response.extend_from_slice(response); + Some(()) + }) + .unwrap(); + + let response = RpcResponse::decode(encoded_response.as_slice()).unwrap(); + assert!(response.error.is_some()); + } + + #[tokio::test] + async fn freeing_a_pending_operation_releases_capacity_after_cancellation() { + let session = session(1); + let operation = session + .submit_encoded(&request("test.Echo", b"pending")) + .unwrap(); + assert!(session.free(operation)); + tokio::task::yield_now().await; + tokio::task::yield_now().await; + + session + .submit_encoded(&request("test.Echo", b"next")) + .unwrap(); + } + + #[tokio::test] + async fn rejects_a_request_without_a_method() { + let encoded = DirectRpcRequest { + request: b"hello".to_vec(), + ..Default::default() + } + .encode_to_vec(); + + assert!(matches!( + session(1).submit_encoded(&encoded), + Err(RpcSubmitError::MissingMethod) + )); + } +} diff --git a/vendor/easytier/easytier-core/src/rpc/packet.rs b/vendor/easytier/easytier-core/src/rpc/packet.rs new file mode 100644 index 0000000..b9ba623 --- /dev/null +++ b/vendor/easytier/easytier-core/src/rpc/packet.rs @@ -0,0 +1,309 @@ +use prost::{Message as _, length_delimiter_len}; + +use crate::{ + config::PeerId, + packet::{CompressorAlgo, PacketType, TAIL_RESERVED_SIZE, ZCPacket, ZCPacketType}, + proto::{ + common::{CompressionAlgoPb, RpcCompressionInfo, RpcDescriptor, RpcPacket}, + rpc_types::error::Error, + }, +}; + +use super::RpcTransactId; + +const RPC_PACKET_UDP_PAYLOAD_BUDGET: usize = 1300; + +pub(crate) fn accepted_compression_algo() -> CompressionAlgoPb { + if CompressorAlgo::ZstdDefault.is_available() { + CompressionAlgoPb::Zstd + } else { + CompressionAlgoPb::None + } +} + +pub async fn compress_packet( + accepted_compression_algo: CompressionAlgoPb, + content: &[u8], +) -> Result<(Vec, CompressionAlgoPb), Error> { + let algo = CompressorAlgo::try_from(accepted_compression_algo) + .ok() + .filter(|algo| algo.is_available()) + .unwrap_or(CompressorAlgo::None); + let compressed = crate::packet::compressor::DefaultCompressor::new() + .compress_raw(content, algo) + .await + .map_err(Error::from)?; + if compressed.len() >= content.len() { + Ok((content.to_vec(), CompressionAlgoPb::None)) + } else { + Ok(( + compressed, + CompressionAlgoPb::try_from(algo).expect("CompressorAlgo should map to protobuf"), + )) + } +} + +pub async fn decompress_packet( + compression_algo: CompressionAlgoPb, + content: &[u8], +) -> Result, Error> { + let algo = CompressorAlgo::try_from(compression_algo).map_err(anyhow::Error::from)?; + crate::packet::compressor::DefaultCompressor::new() + .decompress_raw(content, algo) + .await + .map_err(Error::from) +} + +pub(crate) struct PacketMerger { + first_piece: Option, + pieces: Vec, + last_updated: std::time::Instant, +} + +impl Default for PacketMerger { + fn default() -> Self { + Self::new() + } +} + +impl PacketMerger { + pub fn new() -> Self { + Self { + first_piece: None, + pieces: Vec::new(), + last_updated: std::time::Instant::now(), + } + } + + fn try_merge_pieces(&self) -> Option { + if self.first_piece.is_none() || self.pieces.is_empty() { + return None; + } + + for p in &self.pieces { + if p.total_pieces == 0 { + return None; + } + } + + let mut body = Vec::new(); + for p in &self.pieces { + body.extend_from_slice(&p.body); + } + + let mut tmpl_packet = self.pieces[0].clone(); + tmpl_packet.total_pieces = 1; + tmpl_packet.piece_idx = 0; + tmpl_packet.body = body; + + Some(tmpl_packet) + } + + pub fn feed(&mut self, rpc_packet: RpcPacket) -> Result, Error> { + let total_pieces = rpc_packet.total_pieces; + let piece_idx = rpc_packet.piece_idx; + + if total_pieces == 0 && piece_idx == 0 { + return Ok(Some(rpc_packet)); + } + + if rpc_packet.piece_idx == 0 && rpc_packet.descriptor.is_none() { + return Err(Error::MalformatRpcPacket( + "descriptor is missing".to_owned(), + )); + } + + if total_pieces > 32 * 1024 || total_pieces == 0 { + return Err(Error::MalformatRpcPacket(format!( + "total_pieces is invalid: {}", + total_pieces + ))); + } + + if piece_idx >= total_pieces { + return Err(Error::MalformatRpcPacket( + "piece_idx >= total_pieces".to_owned(), + )); + } + + if self.first_piece.is_none() + || self.first_piece.as_ref().unwrap().transaction_id != rpc_packet.transaction_id + || self.first_piece.as_ref().unwrap().from_peer != rpc_packet.from_peer + { + self.first_piece = Some(rpc_packet.clone()); + self.pieces.clear(); + tracing::trace!(?rpc_packet, "got first piece"); + } + + self.pieces + .resize(total_pieces as usize, Default::default()); + self.pieces[piece_idx as usize] = rpc_packet; + + self.last_updated = std::time::Instant::now(); + + Ok(self.try_merge_pieces()) + } + + pub(crate) fn last_updated(&self) -> std::time::Instant { + self.last_updated + } +} + +pub struct BuildRpcPacketArgs<'a> { + pub from_peer: PeerId, + pub to_peer: PeerId, + pub rpc_desc: RpcDescriptor, + pub transaction_id: RpcTransactId, + pub is_req: bool, + pub content: &'a [u8], + pub trace_id: i32, + pub compression_info: RpcCompressionInfo, +} + +fn udp_rpc_tunnel_overhead() -> usize { + ZCPacketType::UDP.get_packet_offsets().payload_offset + TAIL_RESERVED_SIZE +} + +fn max_rpc_packet_encoded_len_for_udp() -> usize { + RPC_PACKET_UDP_PAYLOAD_BUDGET.saturating_sub(udp_rpc_tunnel_overhead()) +} + +fn build_rpc_piece( + args: &BuildRpcPacketArgs<'_>, + total_pieces: u32, + piece_idx: u32, + body: &[u8], +) -> RpcPacket { + RpcPacket { + from_peer: args.from_peer, + to_peer: args.to_peer, + descriptor: if piece_idx == 0 + || args.compression_info.algo == CompressionAlgoPb::None as i32 + { + Some(args.rpc_desc.clone()) + } else { + None + }, + is_request: args.is_req, + total_pieces, + piece_idx, + transaction_id: args.transaction_id, + body: body.to_vec(), + trace_id: args.trace_id, + compression_info: if piece_idx == 0 { + Some(args.compression_info) + } else { + None + }, + } +} + +fn pick_piece_len_for_budget( + base_encoded_len_without_body: usize, + remaining: usize, + max_encoded_len: usize, +) -> usize { + if remaining == 0 { + return 0; + } + + if base_encoded_len_without_body + 3 > max_encoded_len { + tracing::warn!( + base_encoded_len_without_body, + max_encoded_len, + "rpc metadata exceeds udp payload budget; falling back to a minimal piece" + ); + return 1; + } + + let budget = max_encoded_len - base_encoded_len_without_body; + let reserved_for_body_header = 1 + length_delimiter_len(budget); + remaining + .min(budget.saturating_sub(reserved_for_body_header)) + .max(1) +} + +fn split_rpc_content_for_udp_budget(args: &BuildRpcPacketArgs<'_>) -> Vec<(usize, usize)> { + if args.content.is_empty() { + return vec![(0, 0)]; + } + + let max_encoded_len = max_rpc_packet_encoded_len_for_udp().max(1); + let first_piece_base_len = build_rpc_piece(args, u32::MAX, 0, &[]).encoded_len(); + let other_piece_base_len = build_rpc_piece(args, u32::MAX, u32::MAX, &[]).encoded_len(); + + let mut pieces = Vec::new(); + let mut offset = 0usize; + while offset < args.content.len() { + let base_len = if pieces.is_empty() { + first_piece_base_len + } else { + other_piece_base_len + }; + let piece_len = + pick_piece_len_for_budget(base_len, args.content.len() - offset, max_encoded_len); + pieces.push((offset, piece_len)); + offset += piece_len; + } + + pieces +} + +pub fn build_rpc_packet(args: BuildRpcPacketArgs<'_>) -> Vec { + let mut ret = Vec::new(); + let pieces = split_rpc_content_for_udp_budget(&args); + let total_pieces = pieces.len() as u32; + for (piece_idx, (offset, len)) in pieces.into_iter().enumerate() { + let cur_packet = build_rpc_piece( + &args, + total_pieces, + piece_idx as u32, + &args.content[offset..offset + len], + ); + + let packet_type = if args.is_req { + PacketType::RpcReq + } else { + PacketType::RpcResp + }; + + let mut buf = Vec::new(); + cur_packet.encode(&mut buf).unwrap(); + let mut zc_packet = ZCPacket::new_with_payload(&buf); + zc_packet.fill_peer_manager_hdr(args.from_peer, args.to_peer, packet_type as u8); + ret.push(zc_packet); + } + + ret +} + +#[cfg(test)] +mod tests { + use crate::proto::common::CompressionAlgoPb; + + use super::accepted_compression_algo; + #[cfg(not(feature = "zstd"))] + use super::compress_packet; + + #[test] + fn accepted_compression_matches_build_capabilities() { + #[cfg(feature = "zstd")] + assert_eq!(accepted_compression_algo(), CompressionAlgoPb::Zstd); + + #[cfg(not(feature = "zstd"))] + assert_eq!(accepted_compression_algo(), CompressionAlgoPb::None); + } + + #[cfg(not(feature = "zstd"))] + #[tokio::test] + async fn compression_negotiation_falls_back_when_zstd_is_unavailable() { + assert_eq!(accepted_compression_algo(), CompressionAlgoPb::None); + + let (content, algorithm) = compress_packet(CompressionAlgoPb::Zstd, b"rpc body") + .await + .unwrap(); + + assert_eq!(content, b"rpc body"); + assert_eq!(algorithm, CompressionAlgoPb::None); + } +} diff --git a/vendor/easytier/easytier-core/src/rpc/server.rs b/vendor/easytier/easytier-core/src/rpc/server.rs new file mode 100644 index 0000000..796cd39 --- /dev/null +++ b/vendor/easytier/easytier-core/src/rpc/server.rs @@ -0,0 +1,342 @@ +use std::{ + pin::Pin, + sync::{ + Arc, Mutex, + atomic::{AtomicBool, Ordering}, + }, +}; + +use bytes::Bytes; +use dashmap::DashMap; +use futures::StreamExt; +use prost::Message; +use tokio::task::JoinSet; + +use crate::{ + foundation::{ + stats::{ArcRpcMetrics, RpcMetricLabels, RpcMetricsProvider}, + task::reap_joinset_background, + }, + proto::{ + common::{self, RpcCompressionInfo, RpcPacket, RpcRequest, RpcResponse, TunnelInfo}, + rpc_types::error::Result, + }, + rpc::packet::BuildRpcPacketArgs, + tunnel::{ + Tunnel, ZCPacketStream, + mpsc::{MpscTunnel, MpscTunnelSender}, + ring::create_ring_tunnel_pair, + }, +}; + +use super::{ + Transport, + dispatch::dispatch_request, + packet::{ + PacketMerger, accepted_compression_algo, build_rpc_packet, compress_packet, + decompress_packet, + }, + service_registry::ServiceRegistry, +}; + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +struct PacketMergerKey { + from_peer_id: crate::config::PeerId, + transaction_id: i64, +} + +pub struct Server { + registry: Arc, + mpsc: Mutex>>>, + transport: Mutex, + tasks: Arc>>, + handler_tasks: Arc>>, + stopped: Arc, + packet_mergers: Arc>, + metrics: Option, +} + +impl Default for Server { + fn default() -> Self { + Self::new() + } +} + +impl Server { + pub fn new() -> Self { + Server::new_with_registry(Arc::new(ServiceRegistry::new())) + } + + pub fn new_with_registry(registry: Arc) -> Self { + let (ring_a, ring_b) = create_ring_tunnel_pair(); + + Self { + registry, + mpsc: Mutex::new(Some(MpscTunnel::new(ring_a, None))), + transport: Mutex::new(MpscTunnel::new(ring_b, None)), + tasks: Arc::new(Mutex::new(JoinSet::new())), + handler_tasks: Arc::new(Mutex::new(JoinSet::new())), + stopped: Arc::new(AtomicBool::new(false)), + packet_mergers: Arc::new(DashMap::new()), + metrics: None, + } + } + + pub fn new_with_registry_and_stats_manager( + registry: Arc, + stats_manager: T, + ) -> Self + where + T: RpcMetricsProvider, + { + let mut server = Self::new_with_registry(registry); + server.metrics = stats_manager.into_rpc_metrics(); + server + } + + pub fn new_with_registry_and_metrics( + registry: Arc, + metrics: ArcRpcMetrics, + ) -> Self { + let mut server = Self::new_with_registry(registry); + server.metrics = Some(metrics); + server + } + + pub fn registry(&self) -> &ServiceRegistry { + &self.registry + } + + pub fn get_transport_sink(&self) -> MpscTunnelSender { + self.transport.lock().unwrap().get_sink() + } + + pub fn get_transport_stream(&self) -> Pin> { + self.transport.lock().unwrap().get_stream() + } + + pub fn run(&self) { + self.run_with_tunnel_info(None); + } + + pub(crate) fn run_with_tunnel_info(&self, tunnel_info: Option) { + self.stopped.store(false, Ordering::Relaxed); + let handler_tasks = self.handler_tasks.clone(); + self.tasks.lock().unwrap().spawn(reap_joinset_background( + Arc::downgrade(&handler_tasks), + "rpc server handlers", + )); + + let mpsc = self.mpsc.lock().unwrap().take().unwrap(); + + let packet_merges = self.packet_mergers.clone(); + let reg = self.registry.clone(); + let tunnel_info = tunnel_info.or_else(|| mpsc.tunnel_info()); + let metrics = self.metrics.clone(); + let handler_tasks_weak = Arc::downgrade(&handler_tasks); + let stopped = self.stopped.clone(); + self.tasks.lock().unwrap().spawn(async move { + let mut mpsc = mpsc; + let mut rx = mpsc.get_stream(); + + while let Some(packet) = rx.next().await { + let packet = match packet { + Err(err) => { + tracing::error!(?err, "Failed to receive packet"); + continue; + } + Ok(packet) => packet, + }; + let packet = match common::RpcPacket::decode(packet.payload()) { + Err(err) => { + tracing::error!(?err, "Failed to decode packet"); + continue; + } + Ok(packet) => packet, + }; + + if !packet.is_request { + tracing::warn!(?packet, "Received non-request packet"); + continue; + } + + let key = PacketMergerKey { + from_peer_id: packet.from_peer, + transaction_id: packet.transaction_id, + }; + + tracing::trace!(?key, ?packet, "Received request packet"); + + let ret = packet_merges.entry(key.clone()).or_default().feed(packet); + + match ret { + Ok(Some(packet)) => { + packet_merges.remove(&key); + let Some(handler_tasks) = handler_tasks_weak.upgrade() else { + tracing::error!("rpc server handler task set is dropped"); + return; + }; + let mut handler_tasks = handler_tasks.lock().unwrap(); + if stopped.load(Ordering::Relaxed) { + return; + } + handler_tasks.spawn(Self::handle_rpc( + mpsc.get_sink(), + packet, + reg.clone(), + tunnel_info.clone(), + metrics.clone(), + )); + } + Ok(None) => {} + Err(err) => { + tracing::error!("Failed to feed packet to merger, {}", err); + } + } + } + }); + + let packet_mergers = self.packet_mergers.clone(); + self.tasks.lock().unwrap().spawn(async move { + loop { + crate::foundation::time::sleep(crate::foundation::time::Duration::from_secs(5)) + .await; + packet_mergers.retain(|_, v| v.last_updated().elapsed().as_secs() < 10); + packet_mergers.shrink_to_fit(); + } + }); + } + + async fn handle_rpc_request( + packet: RpcPacket, + descriptor: common::RpcDescriptor, + reg: Arc, + tunnel_info: Option, + ) -> Result { + let body = if let Some(compression_info) = packet.compression_info { + decompress_packet( + compression_info.algo.try_into().unwrap_or_default(), + &packet.body, + ) + .await? + } else { + packet.body + }; + let rpc_request = RpcRequest::decode(Bytes::from(body))?; + dispatch_request(reg.as_ref(), descriptor, rpc_request, tunnel_info).await + } + + async fn handle_rpc( + sender: MpscTunnelSender, + packet: RpcPacket, + reg: Arc, + tunnel_info: Option, + metrics: Option, + ) { + let from_peer = packet.from_peer; + let to_peer = packet.to_peer; + let transaction_id = packet.transaction_id; + let trace_id = packet.trace_id; + let Some(desc) = packet.descriptor.clone() else { + tracing::warn!("received RPC request without a descriptor"); + return; + }; + let method_name = reg.get_method_name(&desc).unwrap_or("".to_owned()); + let labels = RpcMetricLabels { + network_name: desc.domain_name.clone(), + src_peer_id: from_peer, + dst_peer_id: to_peer, + service_name: desc.service_name.clone(), + method_name, + }; + + if let Some(metrics) = &metrics { + metrics.server_rx(&labels); + } + + let mut resp_msg = RpcResponse::default(); + let now = std::time::Instant::now(); + + let compression_info = packet.compression_info; + let resp_bytes = Self::handle_rpc_request(packet, desc.clone(), reg, tunnel_info).await; + + match &resp_bytes { + Ok(r) => { + resp_msg.response = r.clone().into(); + if let Some(metrics) = &metrics { + metrics.server_tx(&labels, now.elapsed().as_millis() as u64); + } + } + Err(err) => { + resp_msg.error = Some(err.into()); + if let Some(metrics) = &metrics { + metrics.server_error( + &labels, + Some(format!("{:?}", err)), + now.elapsed().as_millis() as u64, + ); + } + } + }; + resp_msg.runtime_us = now.elapsed().as_micros() as u64; + + let (compressed_resp, algo) = compress_packet( + compression_info.unwrap_or_default().accepted_algo(), + &resp_msg.encode_to_vec(), + ) + .await + .unwrap(); + + let packets = build_rpc_packet(BuildRpcPacketArgs { + from_peer: to_peer, + to_peer: from_peer, + rpc_desc: desc, + transaction_id, + is_req: false, + content: &compressed_resp, + trace_id, + compression_info: RpcCompressionInfo { + algo: algo.into(), + accepted_algo: accepted_compression_algo().into(), + }, + }); + for packet in packets { + if let Err(err) = sender.send(packet).await { + tracing::error!(?err, "Failed to send response packet"); + } + } + } + + pub fn close(&self) { + self.transport.lock().unwrap().close(); + } + + pub async fn stop(&self) { + self.stopped.store(true, Ordering::Relaxed); + self.close(); + let (mut tasks, mut handler_tasks) = { + let mut task_slot = self.tasks.lock().unwrap(); + let mut handler_task_slot = self.handler_tasks.lock().unwrap(); + ( + std::mem::replace(&mut *task_slot, JoinSet::new()), + std::mem::replace(&mut *handler_task_slot, JoinSet::new()), + ) + }; + tasks.abort_all(); + handler_tasks.abort_all(); + while tasks.join_next().await.is_some() {} + while handler_tasks.join_next().await.is_some() {} + } +} + +#[cfg(any(test, feature = "test-utils"))] +mod test_utils { + use super::Server; + + impl Server { + #[doc(hidden)] + pub fn inflight_count(&self) -> usize { + self.packet_mergers.len() + } + } +} diff --git a/vendor/easytier/easytier-core/src/rpc/service_registry.rs b/vendor/easytier/easytier-core/src/rpc/service_registry.rs new file mode 100644 index 0000000..60b47a8 --- /dev/null +++ b/vendor/easytier/easytier-core/src/rpc/service_registry.rs @@ -0,0 +1,184 @@ +use std::sync::Arc; + +use dashmap::DashMap; + +use crate::proto::common::RpcDescriptor; +use crate::proto::rpc_types; +#[cfg(all(feature = "management-rpc", any(test, target_os = "wasi")))] +use crate::proto::rpc_types::descriptor::MethodDescriptor; +use crate::proto::rpc_types::descriptor::ServiceDescriptor; +use crate::proto::rpc_types::handler::{Handler, HandlerExt}; + +use super::RpcController; + +#[derive(Clone, PartialEq, Eq, Debug, Hash)] +pub struct ServiceKey { + pub domain_name: String, + pub service_name: String, + pub proto_name: String, +} + +impl From<&RpcDescriptor> for ServiceKey { + fn from(desc: &RpcDescriptor) -> Self { + Self { + domain_name: desc.domain_name.to_string(), + service_name: desc.service_name.to_string(), + proto_name: desc.proto_name.to_string(), + } + } +} + +#[derive(Clone)] +struct ServiceEntry { + service: Arc>>, + #[cfg(all(feature = "management-rpc", any(test, target_os = "wasi")))] + methods: Arc<[(String, u8)]>, +} + +impl ServiceEntry { + fn new>(h: H) -> Self { + #[cfg(all(feature = "management-rpc", any(test, target_os = "wasi")))] + let descriptor = h.service_descriptor(); + #[cfg(all(feature = "management-rpc", any(test, target_os = "wasi")))] + let service_name = match descriptor.package() { + "" => descriptor.proto_name().to_owned(), + package => format!("{package}.{}", descriptor.proto_name()), + }; + #[cfg(all(feature = "management-rpc", any(test, target_os = "wasi")))] + let methods = descriptor + .methods() + .iter() + .map(|method| { + ( + format!("{service_name}.{}", method.proto_name()), + method.index(), + ) + }) + .collect::>() + .into(); + Self { + service: Arc::new(Box::new(h)), + #[cfg(all(feature = "management-rpc", any(test, target_os = "wasi")))] + methods, + } + } + + async fn call_method( + &self, + ctrl: RpcController, + method_index: u8, + input: bytes::Bytes, + ) -> rpc_types::error::Result { + self.service.call_method(ctrl, method_index, input).await + } +} + +pub struct ServiceRegistry { + table: DashMap, +} + +impl Default for ServiceRegistry { + fn default() -> Self { + Self::new() + } +} + +impl ServiceRegistry { + pub fn new() -> Self { + Self { + table: DashMap::new(), + } + } + + pub fn replace_registry(&self, registry: &ServiceRegistry) { + self.table.clear(); + for item in registry.table.iter() { + let (k, v) = item.pair(); + self.table.insert(k.clone(), v.clone()); + } + } + + pub fn register>(&self, h: H, domain_name: &str) { + let desc = h.service_descriptor(); + let key = ServiceKey { + domain_name: domain_name.to_string(), + service_name: desc.name().to_string(), + proto_name: desc.proto_name().to_string(), + }; + let entry = ServiceEntry::new(h); + self.table.insert(key, entry); + } + + pub fn get_method_name(&self, rpc_desc: &RpcDescriptor) -> Option { + let service_key = ServiceKey::from(rpc_desc); + let entry = self.table.get(&service_key)?; + let method_index = rpc_desc.method_index as u8; + let method_name = entry.service.get_method_name(method_index).ok()?; + Some(method_name) + } + + #[cfg(all(feature = "management-rpc", any(test, target_os = "wasi")))] + pub(crate) fn resolve_method( + &self, + domain_name: &str, + full_method_name: &str, + ) -> Option { + self.table.iter().find_map(|entry| { + if entry.key().domain_name != domain_name { + return None; + } + let method_index = entry + .value() + .methods + .iter() + .find_map(|(name, index)| (name == full_method_name).then_some(*index))?; + Some(RpcDescriptor { + domain_name: domain_name.to_owned(), + proto_name: entry.key().proto_name.clone(), + service_name: entry.key().service_name.clone(), + method_index: method_index.into(), + }) + }) + } + + pub fn unregister>( + &self, + h: H, + domain_name: &str, + ) -> Option<()> { + let desc = h.service_descriptor(); + let key = ServiceKey { + domain_name: domain_name.to_string(), + service_name: desc.name().to_string(), + proto_name: desc.proto_name().to_string(), + }; + self.table.remove(&key).map(|_| ()) + } + + pub fn unregister_by_domain(&self, domain_name: &str) { + self.table.retain(|k, _| k.domain_name != domain_name); + } + + pub fn unregister_all(&self) { + self.table.clear(); + } + + pub async fn call_method( + &self, + rpc_desc: RpcDescriptor, + ctrl: RpcController, + input: bytes::Bytes, + ) -> rpc_types::error::Result { + let service_key = ServiceKey::from(&rpc_desc); + let method_index = rpc_desc.method_index as u8; + let entry = self + .table + .get(&service_key) + .ok_or(rpc_types::error::Error::InvalidServiceKey( + service_key.service_name.clone(), + service_key.proto_name.clone(), + ))? + .clone(); + entry.call_method(ctrl, method_index, input).await + } +} diff --git a/vendor/easytier/easytier-core/src/rpc/standalone.rs b/vendor/easytier/easytier-core/src/rpc/standalone.rs new file mode 100644 index 0000000..5c8a93f --- /dev/null +++ b/vendor/easytier/easytier-core/src/rpc/standalone.rs @@ -0,0 +1,733 @@ +use std::{ + sync::{Arc, atomic::AtomicU32}, + time::Duration, +}; + +use anyhow::Context as _; +use tokio::task::JoinSet; + +use crate::{ + connectivity::protocol::raw::TunnelDialer, + proto::{ + common::TunnelInfo, + rpc_types::{__rt::RpcClientFactory, error::Error}, + }, + rpc::{bidirect::BidirectRpcManager, service_registry::ServiceRegistry}, + socket::SocketListener, + tunnel::Tunnel, +}; + +#[async_trait::async_trait] +#[auto_impl::auto_impl(Arc, Box)] +pub trait RpcServerHook: Send + Sync { + async fn on_new_client( + &self, + tunnel_info: Option, + ) -> Result, anyhow::Error> { + Ok(tunnel_info) + } + + async fn on_client_disconnected(&self, _tunnel_info: Option) {} +} + +struct DefaultHook; + +impl RpcServerHook for DefaultHook {} + +struct BoundListener { + listener: L, + // Release protection only after the listener has been dropped. + _guard: G, +} + +pub struct StandAloneServer { + registry: Arc, + listener: Option, + inflight_server: Arc, + tasks: JoinSet<()>, + hook: Option>, + rx_timeout: Option, +} + +impl StandAloneServer +where + L: SocketListener> + 'static, +{ + pub fn new(listener: L) -> Self { + Self { + registry: Arc::new(ServiceRegistry::new()), + listener: Some(listener), + inflight_server: Arc::new(AtomicU32::new(0)), + tasks: JoinSet::new(), + hook: None, + rx_timeout: Some(Duration::from_secs(60)), + } + } + + pub fn set_rx_timeout(&mut self, timeout: Option) { + self.rx_timeout = timeout; + } + + pub fn set_hook(&mut self, hook: Arc) { + self.hook = Some(hook); + } + + pub fn registry(&self) -> &ServiceRegistry { + &self.registry + } + + async fn serve_loop( + listener: &mut L, + inflight: Arc, + registry: Arc, + hook: Arc, + rx_timeout: Option, + ) -> Result<(), Error> { + let mut client_tasks = JoinSet::new(); + + loop { + let accepted = { + let accept = listener.accept(); + tokio::pin!(accept); + loop { + tokio::select! { + accepted = &mut accept => break accepted, + _ = client_tasks.join_next(), if !client_tasks.is_empty() => {} + } + } + }; + let tunnel = accepted?; + let tunnel_info = tunnel.info(); + let registry = registry.clone(); + let inflight_server = inflight.clone(); + let hook = hook.clone(); + + let tunnel_info = match hook.on_new_client(tunnel_info).await { + Ok(info) => info, + Err(error) => { + tracing::warn!(?error, "standalone hook.on_new_client failed"); + continue; + } + }; + + inflight_server.fetch_add(1, std::sync::atomic::Ordering::Relaxed); + client_tasks.spawn(async move { + let server = BidirectRpcManager::new().set_rx_timeout(rx_timeout); + server.rpc_server().registry().replace_registry(®istry); + server.run_with_tunnel_info(tunnel, tunnel_info.clone()); + server.wait().await; + hook.on_client_disconnected(tunnel_info).await; + inflight_server.fetch_sub(1, std::sync::atomic::Ordering::Relaxed); + }); + } + } + + async fn run_bound_listener( + mut bound_listener: BoundListener, + inflight_server: Arc, + registry: Arc, + hook: Arc, + rx_timeout: Option, + ) where + G: Send + 'static, + { + loop { + let ret = Self::serve_loop( + &mut bound_listener.listener, + inflight_server.clone(), + registry.clone(), + hook.clone(), + rx_timeout, + ) + .await; + if let Err(error) = ret { + tracing::error!( + ?error, + url = ?bound_listener.listener.local_url(), + "serve_loop exit unexpectedly" + ); + println!("standalone serve_loop exit unexpectedly: {error:?}"); + } + + crate::foundation::time::sleep(Duration::from_secs(1)).await; + } + } + + pub async fn serve(&mut self) -> Result<(), Error> { + self.serve_with_bound_listener((), |_| Ok(())).await + } + + #[cfg(feature = "management-rpc")] + pub(crate) fn listener_url(&self) -> url::Url { + self.listener + .as_ref() + .expect("standalone listener must be available before serve") + .local_url() + } + + pub(crate) async fn serve_with_bound_listener( + &mut self, + binding_guard: B, + on_bound: F, + ) -> Result<(), Error> + where + F: FnOnce(&url::Url) -> Result, + G: Send + 'static, + { + let mut listener = self.listener.take().unwrap(); + let hook = self.hook.take().unwrap_or_else(|| Arc::new(DefaultHook)); + let rx_timeout = self.rx_timeout; + + if let Err(error) = listener.listen().await.with_context(|| "failed to listen") { + drop(listener); + drop(binding_guard); + return Err(error.into()); + } + let guard = match on_bound(&listener.local_url()) { + Ok(guard) => guard, + Err(error) => { + drop(listener); + drop(binding_guard); + return Err(error); + } + }; + drop(binding_guard); + let bound_listener = BoundListener { + listener, + _guard: guard, + }; + + let registry = self.registry.clone(); + let inflight_server = self.inflight_server.clone(); + + self.tasks.spawn(Self::run_bound_listener( + bound_listener, + inflight_server, + registry, + hook, + rx_timeout, + )); + + Ok(()) + } + + pub fn inflight_server(&self) -> u32 { + self.inflight_server + .load(std::sync::atomic::Ordering::Relaxed) + } +} + +pub struct StandAloneClient { + connector: C, + client: Option, +} + +impl StandAloneClient { + pub fn new(connector: C) -> Self { + Self { + connector, + client: None, + } + } + + async fn connect(&mut self) -> Result, Error> { + Ok(self.connector.connect().await.with_context(|| { + format!( + "failed to connect to server: {:?}", + self.connector.remote_url() + ) + })?) + } + + pub async fn scoped_client( + &mut self, + domain_name: String, + ) -> Result { + let mut client = self.client.take(); + let error = client.as_ref().and_then(BidirectRpcManager::take_error); + if client.is_none() || error.is_some() { + tracing::info!(?error, "reconnect standalone RPC client"); + let tunnel = self.connect().await?; + let manager = BidirectRpcManager::new().set_rx_timeout(Some(Duration::from_secs(60))); + manager.run_with_tunnel(tunnel); + client = Some(manager); + } + + self.client = client; + + Ok(self + .client + .as_ref() + .unwrap() + .rpc_client() + .scoped_client::(1, 1, domain_name)) + } + + pub async fn wait(&mut self) { + if let Some(client) = self.client.take() { + client.wait().await; + } + } +} + +#[cfg(test)] +mod tests { + use std::{ + fmt, + sync::{ + Arc, Mutex, + atomic::{AtomicBool, AtomicU32, Ordering}, + }, + time::Duration, + }; + + use tokio::sync::mpsc; + use url::Url; + + use super::{RpcServerHook, StandAloneClient, StandAloneServer}; + use crate::{ + connectivity::protocol::raw::TunnelDialer, + foundation::time::{sleep, timeout}, + proto::{ + common::TunnelInfo, + peer_rpc::{ + GetGlobalPeerMapRequest, GetGlobalPeerMapResponse, PeerCenterRpc, + PeerCenterRpcClientFactory, PeerCenterRpcServer, ReportPeersRequest, + ReportPeersResponse, + }, + rpc_types::{ + controller::{BaseController, Controller as _}, + error, + }, + }, + socket::SocketListener, + tunnel::{ + Tunnel, + ring::{RING_TUNNEL_CAP, RingTunnel, create_ring_socket_pair, create_ring_tunnel_pair}, + }, + }; + + struct TestListener { + accepted: mpsc::Receiver>, + accept_tracker: Option>, + } + + struct BoundUrlListener { + listening: bool, + drop_order: Option>>>, + binding_guard_alive: Option>, + } + + struct TestProtectionLease(Arc>>); + + struct TestBindingGuard(Arc); + + #[derive(Default)] + struct AcceptTracker { + started: AtomicU32, + cancelled: AtomicU32, + } + + struct AcceptAttempt { + tracker: Arc, + completed: bool, + } + + impl Drop for AcceptAttempt { + fn drop(&mut self) { + if !self.completed { + self.tracker.cancelled.fetch_add(1, Ordering::Relaxed); + } + } + } + + impl fmt::Debug for TestListener { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter.debug_struct("TestListener").finish() + } + } + + impl fmt::Debug for BoundUrlListener { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter.debug_struct("BoundUrlListener").finish() + } + } + + impl Drop for BoundUrlListener { + fn drop(&mut self) { + if let Some(drop_order) = &self.drop_order { + drop_order.lock().unwrap().push("listener"); + } + } + } + + impl Drop for TestProtectionLease { + fn drop(&mut self) { + self.0.lock().unwrap().push("protection"); + } + } + + impl Drop for TestBindingGuard { + fn drop(&mut self) { + self.0.store(false, Ordering::Release); + } + } + + #[async_trait::async_trait] + impl SocketListener for TestListener { + type Accepted = Box; + + async fn listen(&mut self) -> anyhow::Result<()> { + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + let mut attempt = self.accept_tracker.as_ref().map(|tracker| { + tracker.started.fetch_add(1, Ordering::Relaxed); + AcceptAttempt { + tracker: tracker.clone(), + completed: false, + } + }); + let result = self + .accepted + .recv() + .await + .ok_or_else(|| anyhow::anyhow!("test listener closed")); + if let Some(attempt) = attempt.as_mut() { + attempt.completed = true; + } + result + } + + fn local_url(&self) -> Url { + "ring://standalone-rpc".parse().unwrap() + } + } + + #[async_trait::async_trait] + impl SocketListener for BoundUrlListener { + type Accepted = Box; + + async fn listen(&mut self) -> anyhow::Result<()> { + if let Some(alive) = &self.binding_guard_alive { + assert!(alive.load(Ordering::Acquire)); + } + self.listening = true; + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + std::future::pending().await + } + + fn local_url(&self) -> Url { + if self.listening { + "tcp://127.0.0.1:15888".parse().unwrap() + } else { + "tcp://127.0.0.1:0".parse().unwrap() + } + } + } + + struct TestDialer { + accepted: Arc>>>, + connections: Arc, + } + + #[async_trait::async_trait] + impl TunnelDialer for TestDialer { + async fn connect(&self) -> anyhow::Result> { + let (client_socket, accepted_socket) = create_ring_socket_pair(RING_TUNNEL_CAP); + let client = Box::new(RingTunnel::new(client_socket, None)); + let accepted = Box::new(RingTunnel::new( + accepted_socket, + Some(TunnelInfo { + tunnel_type: "tcp".to_owned(), + local_addr: Some("tcp://127.0.0.1:15888".parse::().unwrap().into()), + remote_addr: Some("tcp://127.0.0.1:40000".parse::().unwrap().into()), + resolved_remote_addr: Some( + "tcp://127.0.0.1:40000".parse::().unwrap().into(), + ), + }), + )); + let sender = self.accepted.lock().unwrap().clone(); + sender + .send(accepted) + .await + .map_err(|_| anyhow::anyhow!("test listener closed"))?; + self.connections.fetch_add(1, Ordering::Relaxed); + Ok(client) + } + + fn remote_url(&self) -> Url { + "ring://standalone-rpc".parse().unwrap() + } + } + + #[derive(Clone, Debug)] + struct TestRpcService; + + #[async_trait::async_trait] + impl PeerCenterRpc for TestRpcService { + type Controller = BaseController; + + async fn report_peers( + &self, + _controller: BaseController, + _request: ReportPeersRequest, + ) -> error::Result { + Ok(ReportPeersResponse::default()) + } + + async fn get_global_peer_map( + &self, + controller: BaseController, + _request: GetGlobalPeerMapRequest, + ) -> error::Result { + assert_eq!( + controller + .get_tunnel_info() + .map(|info| info.tunnel_type.as_str()), + Some("tcp") + ); + Ok(GetGlobalPeerMapResponse { + digest: Some(42), + ..Default::default() + }) + } + } + + #[derive(Default)] + struct CountingHook { + connected: AtomicU32, + disconnected: AtomicU32, + } + + #[async_trait::async_trait] + impl RpcServerHook for CountingHook { + async fn on_new_client( + &self, + tunnel_info: Option, + ) -> Result, anyhow::Error> { + self.connected.fetch_add(1, Ordering::Relaxed); + Ok(tunnel_info) + } + + async fn on_client_disconnected(&self, _tunnel_info: Option) { + self.disconnected.fetch_add(1, Ordering::Relaxed); + } + } + + #[tokio::test] + async fn serve_reports_the_actual_bound_listener_url() { + let mut server = StandAloneServer::new(BoundUrlListener { + listening: false, + drop_order: None, + binding_guard_alive: None, + }); + let mut bound_url = None; + + server + .serve_with_bound_listener((), |url| { + bound_url = Some(url.clone()); + Ok(()) + }) + .await + .unwrap(); + + assert_eq!( + bound_url.unwrap(), + "tcp://127.0.0.1:15888".parse::().unwrap() + ); + } + + #[tokio::test] + async fn binding_guard_covers_listen_and_bound_guard_creation() { + let binding_guard_alive = Arc::new(AtomicBool::new(true)); + let mut server = StandAloneServer::new(BoundUrlListener { + listening: false, + drop_order: None, + binding_guard_alive: Some(binding_guard_alive.clone()), + }); + + server + .serve_with_bound_listener(TestBindingGuard(binding_guard_alive.clone()), |_| { + assert!(binding_guard_alive.load(Ordering::Acquire)); + Ok(()) + }) + .await + .unwrap(); + + assert!(!binding_guard_alive.load(Ordering::Acquire)); + } + + #[tokio::test] + async fn listener_drops_before_its_bound_resource_guard() { + let drop_order = Arc::new(Mutex::new(Vec::new())); + let mut server = StandAloneServer::new(BoundUrlListener { + listening: false, + drop_order: Some(drop_order.clone()), + binding_guard_alive: None, + }); + server + .serve_with_bound_listener((), |_| Ok(TestProtectionLease(drop_order.clone()))) + .await + .unwrap(); + + drop(server); + timeout(Duration::from_secs(1), async { + loop { + if drop_order.lock().unwrap().len() == 2 { + break; + } + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + + assert_eq!(*drop_order.lock().unwrap(), ["listener", "protection"]); + } + + #[tokio::test] + async fn server_owns_accepted_client_lifecycle() { + let (sender, receiver) = mpsc::channel(1); + let hook = Arc::new(CountingHook::default()); + let mut server = StandAloneServer::new(TestListener { + accepted: receiver, + accept_tracker: None, + }); + server.set_hook(hook.clone()); + server.serve().await.unwrap(); + + let (client, accepted) = create_ring_tunnel_pair(); + sender.send(accepted).await.unwrap(); + + timeout(Duration::from_secs(1), async { + while server.inflight_server() != 1 { + sleep(Duration::from_millis(10)).await; + } + }) + .await + .unwrap(); + assert_eq!(hook.connected.load(Ordering::Relaxed), 1); + + drop(client); + timeout(Duration::from_secs(1), async { + while server.inflight_server() != 0 { + sleep(Duration::from_millis(10)).await; + } + }) + .await + .unwrap(); + assert_eq!(hook.disconnected.load(Ordering::Relaxed), 1); + } + + #[tokio::test] + async fn reaping_clients_does_not_cancel_an_in_progress_accept() { + let (sender, receiver) = mpsc::channel(1); + let tracker = Arc::new(AcceptTracker::default()); + let mut server = StandAloneServer::new(TestListener { + accepted: receiver, + accept_tracker: Some(tracker.clone()), + }); + server.serve().await.unwrap(); + + let (client, accepted) = create_ring_tunnel_pair(); + sender.send(accepted).await.unwrap(); + timeout(Duration::from_secs(1), async { + while tracker.started.load(Ordering::Relaxed) < 2 { + sleep(Duration::from_millis(10)).await; + } + }) + .await + .unwrap(); + + drop(client); + timeout(Duration::from_secs(1), async { + while server.inflight_server() != 0 { + sleep(Duration::from_millis(10)).await; + } + sleep(Duration::from_millis(20)).await; + }) + .await + .unwrap(); + + assert_eq!(tracker.started.load(Ordering::Relaxed), 2); + assert_eq!(tracker.cancelled.load(Ordering::Relaxed), 0); + } + + #[tokio::test] + async fn client_reuses_connection_and_reconnects_after_disconnect() { + let (sender, receiver) = mpsc::channel(2); + let accepted = Arc::new(Mutex::new(sender)); + let connections = Arc::new(AtomicU32::new(0)); + let dialer = TestDialer { + accepted: accepted.clone(), + connections: connections.clone(), + }; + let mut server = StandAloneServer::new(TestListener { + accepted: receiver, + accept_tracker: None, + }); + server + .registry() + .register(PeerCenterRpcServer::new(TestRpcService), "test"); + server.serve().await.unwrap(); + + let mut client = StandAloneClient::new(dialer); + let rpc = client + .scoped_client::>("test".to_string()) + .await + .unwrap(); + let response = rpc + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest::default(), + ) + .await + .unwrap(); + assert_eq!(response.digest, Some(42)); + + client + .scoped_client::>("test".to_string()) + .await + .unwrap(); + assert_eq!(connections.load(Ordering::Relaxed), 1); + + drop(server); + let (sender, receiver) = mpsc::channel(2); + *accepted.lock().unwrap() = sender; + let mut restarted_server = StandAloneServer::new(TestListener { + accepted: receiver, + accept_tracker: None, + }); + restarted_server + .registry() + .register(PeerCenterRpcServer::new(TestRpcService), "test"); + restarted_server.serve().await.unwrap(); + + let rpc = timeout(Duration::from_secs(1), async { + loop { + let rpc = client + .scoped_client::>("test".to_string()) + .await + .unwrap(); + if connections.load(Ordering::Relaxed) == 2 { + break rpc; + } + sleep(Duration::from_millis(10)).await; + } + }) + .await + .unwrap(); + + rpc.get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest::default(), + ) + .await + .unwrap(); + } +} diff --git a/vendor/easytier/easytier-core/src/socket/mod.rs b/vendor/easytier/easytier-core/src/socket/mod.rs new file mode 100644 index 0000000..d39164d --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/mod.rs @@ -0,0 +1,110 @@ +//! Core-visible socket primitives. +//! +//! This Module is below [`crate::tunnel`]. Sockets represent established or +//! bindable communication endpoints; tunnels are produced later by runtime +//! upgraders and can be handed to peers. Host capability seams (DNS, packet +//! egress, environment facts, and the WASI mechanism backend) live in +//! [`crate::host`]. + +pub mod ring; +pub mod tcp; +pub mod udp; + +/// Keep Rust constructors and deserialization consistent: host sockets normally +/// need VPN bypass; local/TUN-facing endpoint constructors explicitly opt out. +pub(crate) const fn default_need_protect() -> bool { + true +} + +use std::{fmt::Debug, sync::Arc}; + +use async_trait::async_trait; +use serde::{Deserialize, Serialize}; +use url::Url; + +pub trait ListenerConnectionCounter: Debug + Send + Sync { + fn get(&self) -> Option; +} + +#[derive(Debug)] +struct EmptyConnectionCounter; + +impl ListenerConnectionCounter for EmptyConnectionCounter { + fn get(&self) -> Option { + None + } +} + +#[async_trait] +#[auto_impl::auto_impl(Box)] +pub trait SocketListener: Debug + Send { + type Accepted: Send + 'static; + + async fn listen(&mut self) -> anyhow::Result<()>; + + async fn accept(&mut self) -> anyhow::Result; + + fn local_url(&self) -> Url; + + fn connection_counter(&self) -> Arc { + Arc::new(EmptyConnectionCounter) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub enum IpVersion { + V4, + V6, + Both, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct NetNamespace(String); + +impl NetNamespace { + pub fn new(token: impl Into) -> Self { + Self(token.into()) + } + + pub fn token(&self) -> &str { + &self.0 + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct SocketContext { + pub ip_version: IpVersion, + pub socket_mark: Option, + pub netns: Option, +} + +impl SocketContext { + pub fn new() -> Self { + Self::default() + } + + pub fn with_ip_version(mut self, ip_version: IpVersion) -> Self { + self.ip_version = ip_version; + self + } + + pub fn with_socket_mark(mut self, socket_mark: Option) -> Self { + self.socket_mark = socket_mark; + self + } + + pub fn with_netns(mut self, netns: Option) -> Self { + self.netns = netns; + self + } +} + +impl Default for SocketContext { + fn default() -> Self { + Self { + ip_version: IpVersion::Both, + socket_mark: None, + netns: None, + } + } +} diff --git a/vendor/easytier/easytier-core/src/socket/ring.rs b/vendor/easytier/easytier-core/src/socket/ring.rs new file mode 100644 index 0000000..1cf00ad --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/ring.rs @@ -0,0 +1,299 @@ +use std::{ + fmt::Debug, + pin::Pin, + sync::{Arc, Mutex}, + task::{Context, Poll, ready}, +}; + +use async_ringbuf::{AsyncHeapCons, AsyncHeapProd, AsyncHeapRb, traits::*}; +use futures::{Sink, SinkExt, Stream, StreamExt}; +use uuid::Uuid; + +pub const RING_SOCKET_CAPACITY: usize = 128; +const RING_SOCKET_RESERVED_CAPACITY: usize = 4; + +pub type RingSocketId = Uuid; + +#[derive(Debug, thiserror::Error, Clone, Copy, PartialEq, Eq)] +pub enum RingSocketError { + #[error("ring socket already split")] + AlreadySplit, + #[error("ring socket closed")] + Closed, + #[error("ring socket full")] + Full, +} + +#[derive(Debug, thiserror::Error, Clone, Copy, PartialEq, Eq)] +pub enum RingSocketSendError { + #[error("ring socket closed")] + Closed(T), + #[error("ring socket full")] + Full(T), +} + +pub type RingSocketStreamItem = Result; + +/// An in-process socket primitive. +/// +/// `RingSocket` is intentionally below `Tunnel`: it contains no tunnel schema, +/// no peer metadata, and no `TunnelInfo`. The core ring tunnel Module wraps it +/// into a `Tunnel` when a peer connection needs one. +pub struct RingSocket { + id: RingSocketId, + parts: Mutex>>, +} + +struct RingSocketParts { + recv: AsyncHeapCons, + send: AsyncHeapProd, +} + +impl RingSocket { + pub fn pair(capacity: usize) -> (Arc, Arc) { + Self::pair_with_ids(Uuid::new_v4(), Uuid::new_v4(), capacity) + } + + pub fn pair_with_ids( + first_id: RingSocketId, + second_id: RingSocketId, + capacity: usize, + ) -> (Arc, Arc) { + let capacity = std::cmp::max(RING_SOCKET_RESERVED_CAPACITY * 2, capacity); + let first_to_second = AsyncHeapRb::new(capacity); + let second_to_first = AsyncHeapRb::new(capacity); + let (first_to_second_send, first_to_second_recv) = first_to_second.split(); + let (second_to_first_send, second_to_first_recv) = second_to_first.split(); + + ( + Arc::new(Self { + id: first_id, + parts: Mutex::new(Some(RingSocketParts { + recv: second_to_first_recv, + send: first_to_second_send, + })), + }), + Arc::new(Self { + id: second_id, + parts: Mutex::new(Some(RingSocketParts { + recv: first_to_second_recv, + send: second_to_first_send, + })), + }), + ) + } + + pub fn id(&self) -> RingSocketId { + self.id + } + + pub fn split(&self) -> (RingSocketReceiver, RingSocketSender) { + self.try_split().expect("RingSocket can only be split once") + } + + pub fn try_split( + &self, + ) -> Result<(RingSocketReceiver, RingSocketSender), RingSocketError> { + let parts = self + .parts + .lock() + .unwrap() + .take() + .ok_or(RingSocketError::AlreadySplit)?; + + Ok(( + RingSocketReceiver { + id: self.id, + recv: parts.recv, + }, + RingSocketSender { + id: self.id, + send: parts.send, + }, + )) + } +} + +impl Debug for RingSocket { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("RingSocket") + .field("id", &self.id) + .finish_non_exhaustive() + } +} + +pub struct RingSocketReceiver { + id: RingSocketId, + recv: AsyncHeapCons, +} + +impl Stream for RingSocketReceiver { + type Item = RingSocketStreamItem; + + fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + match ready!(self.get_mut().recv.poll_next_unpin(cx)) { + Some(item) => Poll::Ready(Some(Ok(item))), + None => Poll::Ready(None), + } + } +} + +impl Debug for RingSocketReceiver { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("RingSocketReceiver") + .field("id", &self.id) + .field("len", &self.recv.base().occupied_len()) + .field("cap", &self.recv.base().capacity()) + .finish() + } +} + +pub struct RingSocketSender { + id: RingSocketId, + send: AsyncHeapProd, +} + +impl RingSocketSender { + pub fn try_send(&mut self, item: T) -> Result<(), RingSocketSendError> { + if self.send.is_closed() { + return Err(RingSocketSendError::Closed(item)); + } + + let base = self.send.base(); + if base.occupied_len() >= base.capacity().get() - RING_SOCKET_RESERVED_CAPACITY { + return Err(RingSocketSendError::Full(item)); + } + + self.send.try_push(item).map_err(|item| { + if self.send.is_closed() { + RingSocketSendError::Closed(item) + } else { + RingSocketSendError::Full(item) + } + }) + } + + pub fn force_send(&mut self, item: T) -> Result<(), RingSocketSendError> { + if self.send.is_closed() { + return Err(RingSocketSendError::Closed(item)); + } + + self.send.try_push(item).map_err(|item| { + if self.send.is_closed() { + RingSocketSendError::Closed(item) + } else { + RingSocketSendError::Full(item) + } + }) + } +} + +impl Sink for RingSocketSender { + type Error = RingSocketError; + + fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + ready!(self.get_mut().send.poll_ready_unpin(cx)).map_err(|_| RingSocketError::Closed)?; + Poll::Ready(Ok(())) + } + + fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error> { + self.get_mut() + .force_send(item) + .map_err(|error| match error { + RingSocketSendError::Closed(_) => RingSocketError::Closed, + RingSocketSendError::Full(_) => RingSocketError::Full, + }) + } + + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + ready!(self.get_mut().send.poll_flush_unpin(cx)).map_err(|_| RingSocketError::Closed)?; + Poll::Ready(Ok(())) + } + + fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + ready!(self.get_mut().send.poll_close_unpin(cx)).map_err(|_| RingSocketError::Closed)?; + Poll::Ready(Ok(())) + } +} + +impl Debug for RingSocketSender { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("RingSocketSender") + .field("id", &self.id) + .field("len", &self.send.base().occupied_len()) + .field("cap", &self.send.base().capacity()) + .finish() + } +} + +#[cfg(test)] +mod tests { + use futures::{SinkExt, StreamExt}; + + use crate::packet::ZCPacket; + + use super::*; + + #[tokio::test] + async fn ring_socket_pair_transfers_packets() { + let (left, right) = RingSocket::::pair(8); + let (_left_recv, mut left_send) = left.split(); + let (mut right_recv, _right_send) = right.split(); + + let packet = ZCPacket::new_with_payload(&[1, 2, 3]); + left_send.send(packet.clone()).await.unwrap(); + + let received = right_recv.next().await.unwrap().unwrap(); + assert_eq!(received.payload(), packet.payload()); + } + + #[test] + fn ring_socket_split_is_single_use() { + let (left, _right) = RingSocket::::pair(8); + + let _first = left.try_split().unwrap(); + assert_eq!(left.try_split().unwrap_err(), RingSocketError::AlreadySplit); + } + + #[test] + fn ring_socket_try_send_reserves_capacity() { + let (left, _right) = RingSocket::::pair(8); + let (_left_recv, mut left_send) = left.split(); + + for _ in 0..4 { + left_send + .try_send(ZCPacket::new_with_payload(&[1])) + .unwrap(); + } + + assert!( + left_send + .try_send(ZCPacket::new_with_payload(&[1])) + .is_err_and(|error| matches!(error, RingSocketSendError::Full(_))) + ); + assert!( + left_send + .force_send(ZCPacket::new_with_payload(&[1])) + .is_ok() + ); + } + + #[test] + fn ring_socket_sync_send_reports_closed_receiver() { + let (left, right) = RingSocket::::pair(8); + let (_left_recv, mut left_send) = left.split(); + let (right_recv, _right_send) = right.split(); + drop(right_recv); + + assert!( + left_send + .try_send(ZCPacket::new_with_payload(&[1])) + .is_err_and(|error| matches!(error, RingSocketSendError::Closed(_))) + ); + assert!( + left_send + .force_send(ZCPacket::new_with_payload(&[1])) + .is_err_and(|error| matches!(error, RingSocketSendError::Closed(_))) + ); + } +} diff --git a/vendor/easytier/easytier-core/src/socket/tcp.rs b/vendor/easytier/easytier-core/src/socket/tcp.rs new file mode 100644 index 0000000..1256ec3 --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/tcp.rs @@ -0,0 +1,753 @@ +use std::{fmt, io, net::SocketAddr, sync::Arc}; + +use async_trait::async_trait; +use serde::{Deserialize, Serialize}; +use tokio::io::{AsyncRead, AsyncWrite}; + +use crate::socket::{IpVersion, SocketContext, SocketListener}; + +pub type VirtualTcpReadHalf = Box; +pub type VirtualTcpWriteHalf = Box; +pub type VirtualTcpSplit = (VirtualTcpReadHalf, VirtualTcpWriteHalf); + +/// A core-visible TCP stream endpoint. +/// +/// Implementations are runtime adapters over concrete TCP stream types. This +/// trait deliberately stays below tunnel framing: it only exposes stream I/O and +/// socket addresses. +pub trait VirtualTcpSocket: AsyncRead + AsyncWrite + Unpin + Send + 'static { + /// Consumes the stream into independently owned read and write halves. + /// + /// Portable adapters may use the generic shared split. Native adapters + /// should override this when their runtime provides lock-free owned halves. + fn into_split(self) -> VirtualTcpSplit + where + Self: Sized, + { + let (reader, writer) = tokio::io::split(self); + (Box::new(reader), Box::new(writer)) + } + + fn local_addr(&self) -> io::Result; + + fn peer_addr(&self) -> io::Result; + + /// Optional host transport label retained in tunnel management metadata. + fn transport_label(&self) -> Option<&str> { + None + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum TcpSocketPurpose { + DirectConnect, + FakeTcp, + HolePunch, + ManualConnect, + ProxyNat, + StunProbe, + Socks5, + PortForward, + DataPlane, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct TcpBindOptions { + #[serde(default)] + pub context: SocketContext, + /// Request host VPN bypass during creation, before bind/connect/listen. + /// Hosts with a protection service must await its acknowledgement; local + /// listeners opt out explicitly. Defaults to true, including when omitted + /// from serialized options. Accepted children inherit this requirement. + #[serde(default = "super::default_need_protect")] + pub need_protect: bool, + pub local_addr: Option, + pub bind_device: Option, + /// `None` delegates the platform default to the host socket adapter. + pub reuse_addr: Option, + pub reuse_port: bool, + pub only_v6: bool, +} + +impl TcpBindOptions { + pub fn new() -> Self { + Self { + context: SocketContext::default(), + need_protect: super::default_need_protect(), + local_addr: None, + bind_device: None, + reuse_addr: None, + reuse_port: false, + only_v6: false, + } + } + + pub fn with_local_addr(mut self, local_addr: Option) -> Self { + self.local_addr = local_addr; + self + } + + pub fn with_socket_mark(mut self, socket_mark: Option) -> Self { + self.context.socket_mark = socket_mark; + self + } + + pub fn with_context(mut self, context: SocketContext) -> Self { + self.context = context; + self + } + + pub fn with_need_protect(mut self, need_protect: bool) -> Self { + self.need_protect = need_protect; + self + } + + pub fn with_ip_version(mut self, ip_version: IpVersion) -> Self { + self.context.ip_version = ip_version; + self + } + + pub fn with_bind_device(mut self, bind_device: Option) -> Self { + self.bind_device = bind_device; + self + } + + pub fn with_reuse_addr(mut self, reuse_addr: bool) -> Self { + self.reuse_addr = Some(reuse_addr); + self + } + + pub fn with_reuse_port(mut self, reuse_port: bool) -> Self { + self.reuse_port = reuse_port; + self + } + + pub fn with_only_v6(mut self, only_v6: bool) -> Self { + self.only_v6 = only_v6; + self + } +} + +impl Default for TcpBindOptions { + fn default() -> Self { + Self::new() + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct TcpConnectOptions { + pub remote_addr: SocketAddr, + pub bind: TcpBindOptions, + pub purpose: TcpSocketPurpose, +} + +impl TcpConnectOptions { + pub fn direct_connect(remote_addr: SocketAddr) -> Self { + Self { + remote_addr, + bind: TcpBindOptions::default(), + purpose: TcpSocketPurpose::DirectConnect, + } + } + + pub fn with_purpose(mut self, purpose: TcpSocketPurpose) -> Self { + self.purpose = purpose; + self + } + + pub fn hole_punch(remote_addr: SocketAddr, local_addr: Option) -> Self { + Self { + remote_addr, + bind: TcpBindOptions::default().with_local_addr(local_addr), + purpose: TcpSocketPurpose::HolePunch, + } + } + + pub fn manual_connect(remote_addr: SocketAddr, local_addr: Option) -> Self { + Self { + remote_addr, + bind: TcpBindOptions::default().with_local_addr(local_addr), + purpose: TcpSocketPurpose::ManualConnect, + } + } + + pub fn proxy_nat(remote_addr: SocketAddr) -> Self { + Self { + remote_addr, + bind: TcpBindOptions::default(), + purpose: TcpSocketPurpose::ProxyNat, + } + } + + pub fn stun_probe(remote_addr: SocketAddr, local_addr: SocketAddr) -> Self { + Self { + remote_addr, + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpSocketPurpose::StunProbe, + } + } + + pub fn socks5(remote_addr: SocketAddr) -> Self { + Self::direct_connect(remote_addr).with_purpose(TcpSocketPurpose::Socks5) + } + + pub fn port_forward(remote_addr: SocketAddr) -> Self { + Self::direct_connect(remote_addr).with_purpose(TcpSocketPurpose::PortForward) + } + + pub fn data_plane(remote_addr: SocketAddr) -> Self { + Self::direct_connect(remote_addr).with_purpose(TcpSocketPurpose::DataPlane) + } + + pub fn with_bind(mut self, bind: TcpBindOptions) -> Self { + self.bind = bind; + self + } +} + +#[async_trait] +pub trait VirtualTcpSocketFactory: Send + Sync + 'static { + type Socket: VirtualTcpSocket; + + async fn connect_tcp(&self, options: TcpConnectOptions) -> anyhow::Result; +} + +#[async_trait] +pub trait VirtualTcpListener: Send + Sync + 'static { + type Socket: VirtualTcpSocket; + + fn local_addr(&self) -> io::Result; + + async fn accept(&self) -> io::Result<(Self::Socket, SocketAddr)>; +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +pub enum TcpListenPurpose { + DirectConnect, + HolePunch, + ManualConnect, + ProxyNat, + Socks5, + PortForward, + PortLease, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct TcpListenOptions { + pub bind: TcpBindOptions, + pub purpose: TcpListenPurpose, +} + +impl TcpListenOptions { + pub fn direct_connect(local_addr: SocketAddr) -> Self { + Self { + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::DirectConnect, + } + } + + pub fn hole_punch(local_addr: SocketAddr) -> Self { + Self { + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::HolePunch, + } + } + + pub fn manual_connect(local_addr: SocketAddr) -> Self { + Self { + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::ManualConnect, + } + } + + pub fn proxy_nat(local_addr: SocketAddr) -> Self { + Self { + bind: TcpBindOptions::default() + .with_need_protect(false) + .with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::ProxyNat, + } + } + + pub fn socks5(local_addr: SocketAddr) -> Self { + Self { + bind: TcpBindOptions::default() + .with_need_protect(false) + .with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::Socks5, + } + } + + pub fn port_forward(local_addr: SocketAddr) -> Self { + Self { + bind: TcpBindOptions::default() + .with_need_protect(false) + .with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::PortForward, + } + } + + pub fn port_lease(local_addr: SocketAddr) -> Self { + Self { + bind: TcpBindOptions::default() + .with_need_protect(false) + .with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::PortLease, + } + } + + pub fn with_bind(mut self, bind: TcpBindOptions) -> Self { + self.bind = bind; + self + } +} + +#[async_trait] +pub trait VirtualTcpListenerFactory: Send + Sync + 'static { + type Listener: VirtualTcpListener; + + async fn bind_tcp(&self, options: TcpListenOptions) -> anyhow::Result>; +} + +type AcceptedTcpSocket = + <::Listener as VirtualTcpListener>::Socket; + +pub struct TcpSocketListener +where + F: VirtualTcpListenerFactory, +{ + url: url::Url, + options: TcpListenOptions, + factory: Arc, + listener: Option>, +} + +impl TcpSocketListener +where + F: VirtualTcpListenerFactory, +{ + pub fn new_with_options(url: url::Url, options: TcpListenOptions, factory: Arc) -> Self { + Self { + url, + options, + factory, + listener: None, + } + } + + fn listener(&self) -> anyhow::Result> { + self.listener + .clone() + .ok_or_else(|| anyhow::anyhow!("tcp socket listener is not started")) + } +} + +impl fmt::Debug for TcpSocketListener +where + F: VirtualTcpListenerFactory, +{ + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("TcpSocketListener") + .field("url", &self.url) + .field("options", &self.options) + .field("listening", &self.listener.is_some()) + .finish() + } +} + +#[async_trait] +impl SocketListener for TcpSocketListener +where + F: VirtualTcpListenerFactory, +{ + type Accepted = AcceptedTcpSocket; + + async fn listen(&mut self) -> anyhow::Result<()> { + if self.listener.is_some() { + return Ok(()); + } + + let listener = self.factory.bind_tcp(self.options.clone()).await?; + let local_addr = listener.local_addr()?; + self.url + .set_port(Some(local_addr.port())) + .map_err(|_| anyhow::anyhow!("failed to update tcp listener port for {}", self.url))?; + self.listener = Some(listener); + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + loop { + let listener = self.listener()?; + match listener.accept().await { + Ok((socket, _)) => return Ok(socket), + Err(error) if is_retryable_tcp_io_error(&error) => { + tracing::warn!(?error, "tcp accept failed with retryable error"); + } + Err(error) => { + tracing::warn!(?error, "tcp accept failed"); + return Err(error.into()); + } + } + } + } + + fn local_url(&self) -> url::Url { + self.url.clone() + } +} + +pub(crate) fn is_retryable_tcp_io_error(error: &io::Error) -> bool { + use io::ErrorKind::*; + matches!( + error.kind(), + NotConnected | ConnectionAborted | ConnectionRefused | ConnectionReset + ) +} + +#[cfg(test)] +mod tests { + use std::{ + collections::VecDeque, + pin::Pin, + sync::Mutex, + task::{Context, Poll}, + }; + + use tokio::io::{DuplexStream, ReadBuf}; + + use super::*; + + struct MockTcpSocket { + stream: DuplexStream, + local_addr: SocketAddr, + peer_addr: SocketAddr, + } + + impl MockTcpSocket { + fn new(local_addr: SocketAddr, peer_addr: SocketAddr) -> Self { + let (stream, _) = tokio::io::duplex(64); + Self { + stream, + local_addr, + peer_addr, + } + } + } + + impl AsyncRead for MockTcpSocket { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + Pin::new(&mut self.stream).poll_read(cx, buf) + } + } + + impl AsyncWrite for MockTcpSocket { + fn poll_write( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut self.stream).poll_write(cx, buf) + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_flush(cx) + } + + fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_shutdown(cx) + } + } + + impl VirtualTcpSocket for MockTcpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + fn peer_addr(&self) -> io::Result { + Ok(self.peer_addr) + } + } + + struct MockTcpListener { + local_addr: SocketAddr, + accepts: Mutex>>, + } + + impl MockTcpListener { + fn new(local_addr: SocketAddr, accepts: Vec>) -> Self { + Self { + local_addr, + accepts: Mutex::new(accepts.into()), + } + } + } + + #[async_trait::async_trait] + impl VirtualTcpListener for MockTcpListener { + type Socket = MockTcpSocket; + + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn accept(&self) -> io::Result<(Self::Socket, SocketAddr)> { + let result = self.accepts.lock().unwrap().pop_front(); + match result { + Some(Ok(socket)) => { + let peer_addr = socket.peer_addr()?; + Ok((socket, peer_addr)) + } + Some(Err(error)) => Err(error), + None => std::future::pending().await, + } + } + } + + struct MockTcpListenerFactory { + listener: Arc, + binds: Mutex>, + } + + impl MockTcpListenerFactory { + fn new(listener: Arc) -> Self { + Self { + listener, + binds: Mutex::new(Vec::new()), + } + } + } + + #[async_trait::async_trait] + impl VirtualTcpListenerFactory for MockTcpListenerFactory { + type Listener = MockTcpListener; + + async fn bind_tcp(&self, options: TcpListenOptions) -> anyhow::Result> { + self.binds.lock().unwrap().push(options); + Ok(self.listener.clone()) + } + } + + #[test] + fn tcp_connect_options_preserve_socket_purpose() { + let remote_addr = SocketAddr::from(([127, 0, 0, 1], 11010)); + let local_addr = SocketAddr::from(([0, 0, 0, 0], 0)); + + assert_eq!( + TcpConnectOptions::direct_connect(remote_addr), + TcpConnectOptions { + remote_addr, + bind: TcpBindOptions::default(), + purpose: TcpSocketPurpose::DirectConnect, + } + ); + assert_eq!( + TcpConnectOptions::hole_punch(remote_addr, Some(local_addr)), + TcpConnectOptions { + remote_addr, + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpSocketPurpose::HolePunch, + } + ); + assert_eq!( + TcpConnectOptions::manual_connect(remote_addr, Some(local_addr)), + TcpConnectOptions { + remote_addr, + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpSocketPurpose::ManualConnect, + } + ); + assert_eq!( + TcpConnectOptions::proxy_nat(remote_addr), + TcpConnectOptions { + remote_addr, + bind: TcpBindOptions::default(), + purpose: TcpSocketPurpose::ProxyNat, + } + ); + assert_eq!( + TcpConnectOptions::stun_probe(remote_addr, local_addr), + TcpConnectOptions { + remote_addr, + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpSocketPurpose::StunProbe, + } + ); + assert_eq!( + TcpConnectOptions::socks5(remote_addr).purpose, + TcpSocketPurpose::Socks5 + ); + assert_eq!( + TcpConnectOptions::port_forward(remote_addr).purpose, + TcpSocketPurpose::PortForward + ); + assert_eq!( + TcpConnectOptions::data_plane(remote_addr).purpose, + TcpSocketPurpose::DataPlane + ); + } + + #[test] + fn tcp_listen_options_preserve_socket_purpose() { + let local_addr = SocketAddr::from(([0, 0, 0, 0], 11010)); + + assert_eq!( + TcpListenOptions::socks5(local_addr).purpose, + TcpListenPurpose::Socks5 + ); + assert_eq!( + TcpListenOptions::port_forward(local_addr).purpose, + TcpListenPurpose::PortForward + ); + assert_eq!( + TcpListenOptions::port_lease(local_addr).purpose, + TcpListenPurpose::PortLease + ); + + assert_eq!( + TcpListenOptions::direct_connect(local_addr), + TcpListenOptions { + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::DirectConnect, + } + ); + assert_eq!( + TcpListenOptions::hole_punch(local_addr), + TcpListenOptions { + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::HolePunch, + } + ); + assert_eq!( + TcpListenOptions::manual_connect(local_addr), + TcpListenOptions { + bind: TcpBindOptions::default().with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::ManualConnect, + } + ); + assert_eq!( + TcpListenOptions::proxy_nat(local_addr), + TcpListenOptions { + bind: TcpBindOptions::default() + .with_need_protect(false) + .with_local_addr(Some(local_addr)), + purpose: TcpListenPurpose::ProxyNat, + } + ); + } + + #[test] + fn tcp_bind_options_preserve_socket_configuration() { + let local_addr = SocketAddr::from(([0, 0, 0, 0], 0)); + let options = TcpBindOptions::default() + .with_local_addr(Some(local_addr)) + .with_socket_mark(Some(7)) + .with_bind_device(Some("eth0".to_owned())) + .with_reuse_addr(true) + .with_reuse_port(true) + .with_only_v6(true); + + assert_eq!( + options, + TcpBindOptions { + context: SocketContext::default().with_socket_mark(Some(7)), + need_protect: true, + local_addr: Some(local_addr), + bind_device: Some("eth0".to_owned()), + reuse_addr: Some(true), + reuse_port: true, + only_v6: true, + } + ); + } + + #[test] + fn tcp_bind_default_delegates_reuse_addr_policy_to_host() { + assert_eq!(TcpBindOptions::default().reuse_addr, None); + assert!(TcpBindOptions::default().need_protect); + } + + #[test] + fn tcp_constructor_protection_defaults_match_endpoint_role() { + let remote = SocketAddr::from(([192, 0, 2, 1], 11010)); + let local = SocketAddr::from(([0, 0, 0, 0], 11010)); + + assert!(TcpConnectOptions::direct_connect(remote).bind.need_protect); + assert!(TcpConnectOptions::proxy_nat(remote).bind.need_protect); + assert!(TcpListenOptions::direct_connect(local).bind.need_protect); + assert!(TcpListenOptions::hole_punch(local).bind.need_protect); + assert!(TcpListenOptions::manual_connect(local).bind.need_protect); + assert!(!TcpListenOptions::proxy_nat(local).bind.need_protect); + assert!(!TcpListenOptions::socks5(local).bind.need_protect); + assert!(!TcpListenOptions::port_forward(local).bind.need_protect); + assert!(!TcpListenOptions::port_lease(local).bind.need_protect); + } + + #[test] + fn tcp_bind_serde_defaults_to_protected_and_preserves_opt_out() { + let options: TcpBindOptions = serde_json::from_str( + r#"{"local_addr":null,"bind_device":null,"reuse_addr":null,"reuse_port":false,"only_v6":false}"#, + ) + .unwrap(); + assert!(options.need_protect); + let local = TcpListenOptions::port_forward("0.0.0.0:15555".parse().unwrap()); + let restored: TcpListenOptions = + serde_json::from_str(&serde_json::to_string(&local).unwrap()).unwrap(); + assert_eq!(restored, local); + assert!(!restored.bind.need_protect); + } + + #[tokio::test] + async fn tcp_socket_listener_binds_and_accepts_socket() { + let requested_addr = SocketAddr::from(([127, 0, 0, 1], 0)); + let bound_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let options = TcpListenOptions::direct_connect(requested_addr); + let listener = Arc::new(MockTcpListener::new( + bound_addr, + vec![Ok(MockTcpSocket::new(bound_addr, peer_addr))], + )); + let factory = Arc::new(MockTcpListenerFactory::new(listener)); + let mut socket_listener = TcpSocketListener::new_with_options( + "tcp://127.0.0.1:0".parse().unwrap(), + options.clone(), + factory.clone(), + ); + + socket_listener.listen().await.unwrap(); + let accepted = socket_listener.accept().await.unwrap(); + + assert_eq!(socket_listener.local_url().port(), Some(bound_addr.port())); + assert_eq!(accepted.peer_addr().unwrap(), peer_addr); + assert_eq!(factory.binds.lock().unwrap().as_slice(), &[options]); + } + + #[tokio::test] + async fn tcp_socket_listener_retries_retryable_accept_error() { + let requested_addr = SocketAddr::from(([127, 0, 0, 1], 0)); + let bound_addr = SocketAddr::from(([127, 0, 0, 1], 12010)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12011)); + let listener = Arc::new(MockTcpListener::new( + bound_addr, + vec![ + Err(io::Error::new(io::ErrorKind::ConnectionReset, "reset")), + Ok(MockTcpSocket::new(bound_addr, peer_addr)), + ], + )); + let factory = Arc::new(MockTcpListenerFactory::new(listener)); + let mut socket_listener = TcpSocketListener::new_with_options( + "tcp://127.0.0.1:0".parse().unwrap(), + TcpListenOptions::direct_connect(requested_addr), + factory, + ); + + socket_listener.listen().await.unwrap(); + let accepted = socket_listener.accept().await.unwrap(); + + assert_eq!(accepted.peer_addr().unwrap(), peer_addr); + } +} diff --git a/vendor/easytier/easytier-core/src/socket/udp/layer.rs b/vendor/easytier/easytier-core/src/socket/udp/layer.rs new file mode 100644 index 0000000..ae2ab93 --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/udp/layer.rs @@ -0,0 +1,1170 @@ +use std::{ + io, + net::{SocketAddr, SocketAddrV4, SocketAddrV6}, + sync::{Arc, Mutex as StdMutex, atomic::Ordering}, +}; + +use async_trait::async_trait; +use bytes::BytesMut; +use dashmap::DashMap; +use tokio::{ + sync::{Mutex as TokioMutex, Semaphore, mpsc, watch}, + task::JoinHandle, +}; + +use crate::packet::{ZCPacket, new_hole_punch_packet}; + +use super::{ + UDP_SESSION_CONNECT_TIMEOUT, UDP_SESSION_QUEUE_CAPACITY, UDP_SESSION_RESEND_INTERVAL, + packet::{ + EasyTierUdpPacketKind, UdpDatagramClassification, UdpSessionPacketKind, + classify_session_udp_datagram, classify_udp_datagram, + extract_dst_addr_from_v4_hole_punch_packet, extract_v6_hole_punch_packet, new_sack_packet, + new_syn_packet, + }, + session::{ + ClassifiedUdpSessionAccept, ClassifiedUdpSessionAccepts, ClassifiedUdpSessionKey, + ClassifiedUdpSessionRegistry, PendingUdpSessionConnect, PendingUdpSessionConnects, + UdpConnectControl, UdpSession, UdpSessionClose, UdpSessionCodec, UdpSessionConnectError, + UdpSessionConnectRequest, UdpSessionConnector, UdpSessionDatagram, UdpSessionEnqueuePolicy, + UdpSessionKey, UdpSessionKind, UdpSessionLayerControl, UdpSessionProtocol, + UdpSessionRegistry, close_all_classified_udp_sessions, close_all_udp_sessions, + close_classified_udp_session, close_udp_session, create_udp_session_rings, + dispatch_payload_to_session, udp_session_registry_entry, + }, + virtual_socket::{ + MAX_UDP_SESSION_DATAGRAM_SIZE, NoopUdpSessionStunResponder, PreferredIpv6Source, + UdpSessionStunResponder, UdpSocketRecvMeta, UdpSocketSendMeta, VirtualUdpSocket, + VirtualUdpSocketFactory, + }, +}; + +pub(super) const UDP_SESSION_HOLE_PUNCH_PACKET_BODY_LEN: u16 = 32; + +#[derive(Debug)] +pub struct UdpSessionLayer { + socket: Arc, + _stun_responder: Arc, + pub(super) sessions: Arc, + classified_sessions: Arc, + pub(super) classified_accepts: Arc, + pub(super) pending_connects: Arc, + mux_accepted_rx: TokioMutex>, + _control_rx: TokioMutex>, + session_shutdown_tx: watch::Sender, + recv_task: JoinHandle<()>, +} + +pub(super) fn create_classified_udp_session_accepts() -> Arc { + let accepts = Arc::new(DashMap::new()); + for protocol in [UdpSessionProtocol::WireGuard, UdpSessionProtocol::Quic] { + let (accepted, accepted_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + accepts.insert( + protocol, + Arc::new(ClassifiedUdpSessionAccept { + accepted, + accepted_rx: TokioMutex::new(accepted_rx), + accept_enabled: std::sync::atomic::AtomicBool::new(false), + }), + ); + } + accepts +} + +impl UdpSessionLayer +where + S: VirtualUdpSocket, +{ + pub fn new(socket: Arc) -> Self { + Self::new_with_stun_responder(socket, Arc::new(NoopUdpSessionStunResponder)) + } +} + +impl UdpSessionLayer +where + S: VirtualUdpSocket, + R: UdpSessionStunResponder, +{ + pub fn new_with_stun_responder(socket: Arc, stun_responder: Arc) -> Self { + let sessions = Arc::new(DashMap::new()); + let classified_sessions = Arc::new(DashMap::new()); + let classified_accepts = create_classified_udp_session_accepts(); + let pending_connects = Arc::new(DashMap::new()); + let (mux_accepted_tx, mux_accepted_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (control_tx, control_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (session_shutdown_tx, _) = watch::channel(false); + let recv_task = tokio::spawn(udp_session_layer_recv_task( + socket.clone(), + sessions.clone(), + classified_sessions.clone(), + classified_accepts.clone(), + pending_connects.clone(), + mux_accepted_tx, + control_tx, + stun_responder.clone(), + session_shutdown_tx.clone(), + )); + + Self { + socket, + _stun_responder: stun_responder, + sessions, + classified_sessions, + classified_accepts, + pending_connects, + mux_accepted_rx: TokioMutex::new(mux_accepted_rx), + _control_rx: TokioMutex::new(control_rx), + session_shutdown_tx, + recv_task, + } + } + + pub fn local_addr(&self) -> io::Result { + self.socket.local_addr() + } + + pub fn active_session_count(&self) -> usize { + self.sessions.len() + } + + pub fn active_classified_session_count(&self) -> usize { + self.classified_sessions.len() + } + + pub fn open_classified_session( + &self, + protocol: UdpSessionProtocol, + remote_addr: SocketAddr, + ) -> io::Result { + let local_addr = self.socket.local_addr()?; + let key = ClassifiedUdpSessionKey::new(protocol, remote_addr); + let rings = create_udp_session_rings(); + match self.classified_sessions.entry(key) { + dashmap::mapref::entry::Entry::Vacant(entry) => { + entry.insert(udp_session_registry_entry(&rings)); + } + dashmap::mapref::entry::Entry::Occupied(_) => { + return Err(io::Error::new( + io::ErrorKind::AddrInUse, + format!("{protocol:?} udp session already exists for {remote_addr}"), + )); + } + } + + let close = UdpSessionClose::classified( + key, + rings.close_tx.clone(), + self.classified_sessions.clone(), + ); + Ok(UdpSession::new( + self.socket.clone(), + local_addr, + remote_addr, + protocol.session_kind(), + UdpSessionCodec::Identity, + rings, + close, + self.session_shutdown_tx.subscribe(), + )) + } + + pub async fn connect( + &self, + remote_addr: SocketAddr, + ) -> Result { + let local_addr = self.socket.local_addr()?; + let magic = rand::random(); + let (control_tx, mut control_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (sack_tx, mut sack_rx) = watch::channel(None); + let rings = create_udp_session_rings(); + let session_key = Arc::new(StdMutex::new(None)); + let conn_id = loop { + let conn_id = rand::random(); + if self + .sessions + .contains_key(&UdpSessionKey::new(remote_addr, conn_id)) + { + continue; + } + + let pending = PendingUdpSessionConnect { + expected_addr: remote_addr, + magic, + session_key: session_key.clone(), + entry: udp_session_registry_entry(&rings), + control: control_tx.clone(), + sack: sack_tx.clone(), + }; + if let dashmap::mapref::entry::Entry::Vacant(entry) = + self.pending_connects.entry(conn_id) + { + entry.insert(pending); + break conn_id; + } + }; + let mut cleanup_guard = PendingUdpSessionGuard::new( + self.sessions.clone(), + self.pending_connects.clone(), + session_key, + conn_id, + ); + + let result = self + .connect_with_registered_attempt( + remote_addr, + conn_id, + magic, + &mut control_rx, + &mut sack_rx, + ) + .await; + + match result { + Ok(recv_addr) => { + let key = UdpSessionKey::new(recv_addr, conn_id); + if cleanup_guard.session_key() != Some(key) { + return Err(UdpSessionConnectError::InvalidPacket(format!( + "udp session was not registered: {key:?}" + ))); + } + cleanup_guard.set_session_key(key); + cleanup_guard.disarm_keep_session(); + + let close = + UdpSessionClose::easy_tier(key, rings.close_tx.clone(), self.sessions.clone()); + Ok(UdpSession::new( + self.socket.clone(), + local_addr, + key.peer_addr, + UdpSessionKind::EasyTierMux, + UdpSessionCodec::EasyTierData { conn_id }, + rings, + close, + self.session_shutdown_tx.subscribe(), + )) + } + Err(err) => Err(err), + } + } + + pub async fn accept(&self) -> io::Result { + let mut mux_accepted_rx = self.mux_accepted_rx.lock().await; + mux_accepted_rx + .recv() + .await + .ok_or_else(|| io::Error::new(io::ErrorKind::UnexpectedEof, "udp listener closed")) + } + + fn classified_accept( + &self, + protocol: UdpSessionProtocol, + ) -> io::Result> { + self.classified_accepts + .get(&protocol) + .map(|entry| entry.value().clone()) + .ok_or_else(|| { + io::Error::new( + io::ErrorKind::InvalidInput, + format!("{protocol:?} udp listener is not registered"), + ) + }) + } + + pub fn enable_classified_accept(&self, protocol: UdpSessionProtocol) -> io::Result<()> { + let accept = self.classified_accept(protocol)?; + accept.accept_enabled.store(true, Ordering::Relaxed); + Ok(()) + } + + pub async fn accept_classified_session( + &self, + protocol: UdpSessionProtocol, + ) -> io::Result { + let accept = self.classified_accept(protocol)?; + accept.accept_enabled.store(true, Ordering::Relaxed); + let mut accepted_rx = accept.accepted_rx.lock().await; + accepted_rx.recv().await.ok_or_else(|| { + io::Error::new( + io::ErrorKind::UnexpectedEof, + format!("{protocol:?} udp listener closed"), + ) + }) + } + + async fn connect_with_registered_attempt( + &self, + remote_addr: SocketAddr, + conn_id: u32, + magic: u64, + control_rx: &mut mpsc::Receiver, + sack_rx: &mut watch::Receiver>, + ) -> Result { + let syn_packet = new_syn_packet(conn_id, magic).into_bytes(); + self.socket.send_to(&syn_packet, remote_addr).await?; + + let timeout = crate::foundation::time::sleep(UDP_SESSION_CONNECT_TIMEOUT); + let resend_sleep = crate::foundation::time::sleep(UDP_SESSION_RESEND_INTERVAL); + tokio::pin!(timeout); + tokio::pin!(resend_sleep); + + loop { + if let Some(recv_addr) = *sack_rx.borrow_and_update() { + return Ok(recv_addr); + } + + tokio::select! { + biased; + sack = sack_rx.changed() => { + if sack.is_err() { + return Err(UdpSessionConnectError::InvalidPacket( + "udp sack channel closed".to_owned(), + )); + } + if let Some(recv_addr) = *sack_rx.borrow_and_update() { + return Ok(recv_addr); + } + } + _ = &mut timeout => return Err(UdpSessionConnectError::Timeout), + _ = &mut resend_sleep => { + self.socket.send_to(&syn_packet, remote_addr).await?; + resend_sleep + .as_mut() + .reset(crate::foundation::time::Instant::now() + UDP_SESSION_RESEND_INTERVAL); + } + control = control_rx.recv() => { + match control { + Some(UdpConnectControl::HolePunch { recv_addr }) => { + self.socket.send_to(&syn_packet, recv_addr).await?; + } + Some(UdpConnectControl::InvalidPacket(reason)) => { + tracing::debug!(?reason, "udp wait sack error"); + } + None => { + return Err(UdpSessionConnectError::InvalidPacket( + "udp connect control channel closed".to_owned(), + )); + } + } + } + } + } + } +} + +impl Drop for UdpSessionLayer { + fn drop(&mut self) { + let _ = self.session_shutdown_tx.send(true); + self.pending_connects.clear(); + close_all_udp_sessions(&self.sessions); + close_all_classified_udp_sessions(&self.classified_sessions); + self.recv_task.abort(); + } +} + +struct PendingUdpSessionGuard { + sessions: Arc, + pending_connects: Arc, + session_key: Arc>>, + conn_id: u32, + active: bool, +} + +impl PendingUdpSessionGuard { + fn new( + sessions: Arc, + pending_connects: Arc, + session_key: Arc>>, + conn_id: u32, + ) -> Self { + Self { + sessions, + pending_connects, + session_key, + conn_id, + active: true, + } + } + + fn session_key(&self) -> Option { + *self.session_key.lock().unwrap() + } + + fn set_session_key(&mut self, session_key: UdpSessionKey) { + *self.session_key.lock().unwrap() = Some(session_key); + } + + fn disarm_keep_session(mut self) { + self.pending_connects.remove(&self.conn_id); + self.active = false; + } +} + +impl Drop for PendingUdpSessionGuard { + fn drop(&mut self) { + if self.active { + self.pending_connects.remove(&self.conn_id); + if let Some(session_key) = self.session_key() { + close_udp_session(&self.sessions, session_key); + } + } + } +} + +fn move_pending_udp_session_sender( + sessions: &UdpSessionRegistry, + pending: &PendingUdpSessionConnect, + new_key: UdpSessionKey, +) -> bool { + let mut current_key = pending.session_key.lock().unwrap(); + if let Some(current_key) = *current_key { + return current_key == new_key; + } + + match sessions.entry(new_key) { + dashmap::mapref::entry::Entry::Vacant(entry) => { + entry.insert(pending.entry.clone()); + *current_key = Some(new_key); + true + } + dashmap::mapref::entry::Entry::Occupied(_) => false, + } +} + +#[allow(clippy::too_many_arguments)] +pub(super) async fn udp_session_layer_recv_task( + socket: Arc, + sessions: Arc, + classified_sessions: Arc, + classified_accepts: Arc, + pending_connects: Arc, + mux_accepted: mpsc::Sender, + control: mpsc::Sender, + stun_responder: Arc, + session_shutdown_tx: watch::Sender, +) where + S: VirtualUdpSocket, + R: UdpSessionStunResponder, +{ + let control_permits = Arc::new(Semaphore::new(UDP_SESSION_QUEUE_CAPACITY)); + loop { + let datagram = match socket.recv_session_datagram().await { + Ok(datagram) => datagram, + Err(err) => { + tracing::debug!(?err, "udp session recv loop stopped"); + let _ = session_shutdown_tx.send(true); + pending_connects.clear(); + close_all_udp_sessions(&sessions); + close_all_classified_udp_sessions(&classified_sessions); + break; + } + }; + let payload = datagram.payload; + let remote_addr = datagram.remote_addr; + let recv_meta = datagram.meta; + if payload.len() > MAX_UDP_SESSION_DATAGRAM_SIZE { + tracing::debug!( + datagram_len = payload.len(), + max_datagram_len = MAX_UDP_SESSION_DATAGRAM_SIZE, + ?remote_addr, + "dropping oversized udp session datagram" + ); + continue; + } + let quic_key = ClassifiedUdpSessionKey::new(UdpSessionProtocol::Quic, remote_addr); + if classified_sessions.contains_key(&quic_key) { + dispatch_existing_classified_udp_datagram( + &classified_sessions, + quic_key, + UdpSessionDatagram::new(payload, recv_meta), + ); + continue; + } + match classify_udp_datagram(payload) { + UdpDatagramClassification::Stun(datagram_payload) => { + spawn_stun_control_handler( + socket.clone(), + stun_responder.clone(), + control_permits.clone(), + datagram_payload.clone(), + remote_addr, + ); + dispatch_control_packet( + &control, + UdpSessionLayerControl::Stun { + remote_addr, + datagram: datagram_payload, + }, + ); + } + UdpDatagramClassification::SessionPacket { + kind, + datagram: datagram_payload, + } => { + dispatch_session_udp_datagram( + socket.clone(), + &classified_sessions, + &classified_accepts, + session_shutdown_tx.subscribe(), + remote_addr, + kind, + UdpSessionDatagram::new(datagram_payload, recv_meta), + ); + } + UdpDatagramClassification::EasyTier { + kind, + conn_id, + packet, + } => { + let unconsumed = dispatch_easy_tier_udp_datagram( + &socket, + &sessions, + &pending_connects, + &mux_accepted, + &control, + &control_permits, + remote_addr, + kind, + conn_id, + packet, + recv_meta, + &session_shutdown_tx, + ); + if let Some(packet) = unconsumed { + let datagram = BytesMut::from(packet.into_bytes()); + let fallback = classify_session_udp_datagram(&datagram); + dispatch_session_udp_datagram( + socket.clone(), + &classified_sessions, + &classified_accepts, + session_shutdown_tx.subscribe(), + remote_addr, + fallback, + UdpSessionDatagram::new(datagram, recv_meta), + ); + } + } + } + } +} + +fn dispatch_existing_classified_udp_datagram( + classified_sessions: &Arc, + key: ClassifiedUdpSessionKey, + datagram: UdpSessionDatagram, +) { + let Some(entry) = classified_sessions.get(&key) else { + return; + }; + + let dispatched = + dispatch_payload_to_session(&entry.incoming, datagram, UdpSessionEnqueuePolicy::Reliable); + drop(entry); + if !dispatched { + close_classified_udp_session(classified_sessions, key); + tracing::debug!(?key, "classified udp session data queue closed"); + } +} + +#[allow(clippy::too_many_arguments)] +fn dispatch_easy_tier_udp_datagram( + socket: &Arc, + sessions: &Arc, + pending_connects: &Arc, + mux_accepted: &mpsc::Sender, + control: &mpsc::Sender, + control_permits: &Arc, + remote_addr: SocketAddr, + kind: EasyTierUdpPacketKind, + conn_id: u32, + packet: ZCPacket, + recv_meta: UdpSocketRecvMeta, + session_shutdown: &watch::Sender, +) -> Option +where + S: VirtualUdpSocket, +{ + let consumed = match kind { + EasyTierUdpPacketKind::Data => { + return dispatch_data_packet(sessions, remote_addr, conn_id, packet, recv_meta).err(); + } + EasyTierUdpPacketKind::Syn => handle_new_easy_tier_mux_connect( + socket.clone(), + sessions.clone(), + mux_accepted.clone(), + remote_addr, + conn_id, + &packet, + session_shutdown.subscribe(), + ), + EasyTierUdpPacketKind::Sack => { + dispatch_sack_packet(sessions, pending_connects, remote_addr, conn_id, &packet) + } + EasyTierUdpPacketKind::HolePunch => { + dispatch_hole_punch_packet(pending_connects, remote_addr) + } + EasyTierUdpPacketKind::V4HolePunch => dispatch_v4_hole_punch_control( + socket.clone(), + control_permits.clone(), + control, + remote_addr, + &packet, + ), + EasyTierUdpPacketKind::V6HolePunch => dispatch_v6_hole_punch_control( + socket.clone(), + control_permits.clone(), + control, + remote_addr, + &packet, + ), + }; + if consumed { None } else { Some(packet) } +} + +pub(super) fn dispatch_data_packet( + sessions: &UdpSessionRegistry, + peer_addr: SocketAddr, + conn_id: u32, + packet: ZCPacket, + recv_meta: UdpSocketRecvMeta, +) -> Result<(), ZCPacket> { + let key = UdpSessionKey::new(peer_addr, conn_id); + let Some(entry) = sessions.get(&key) else { + return Err(packet); + }; + + let policy = if packet.is_lossy() { + UdpSessionEnqueuePolicy::Lossy + } else { + UdpSessionEnqueuePolicy::Reliable + }; + let payload = UdpSessionDatagram::from_easytier_packet(packet, recv_meta); + let dispatched = dispatch_payload_to_session(&entry.incoming, payload, policy); + drop(entry); + if !dispatched { + close_udp_session(sessions, key); + tracing::debug!(?key, "udp session data queue closed"); + } + Ok(()) +} + +fn dispatch_session_udp_datagram( + socket: Arc, + classified_sessions: &Arc, + classified_accepts: &Arc, + session_shutdown: watch::Receiver, + remote_addr: SocketAddr, + kind: UdpSessionPacketKind, + datagram: UdpSessionDatagram, +) where + S: VirtualUdpSocket, +{ + match kind { + UdpSessionPacketKind::Classified(protocol) => dispatch_classified_udp_datagram( + socket, + classified_sessions, + classified_accepts, + protocol, + session_shutdown, + remote_addr, + datagram, + ), + UdpSessionPacketKind::Unknown => { + tracing::trace!(?remote_addr, "unknown udp packet has no session route"); + } + } +} + +fn dispatch_classified_udp_datagram( + socket: Arc, + classified_sessions: &Arc, + classified_accepts: &Arc, + protocol: UdpSessionProtocol, + session_shutdown: watch::Receiver, + remote_addr: SocketAddr, + datagram: UdpSessionDatagram, +) where + S: VirtualUdpSocket, +{ + let key = ClassifiedUdpSessionKey::new(protocol, remote_addr); + if let Some(entry) = classified_sessions.get(&key) { + let dispatched = dispatch_payload_to_session( + &entry.incoming, + datagram, + UdpSessionEnqueuePolicy::Reliable, + ); + drop(entry); + if !dispatched { + close_classified_udp_session(classified_sessions, key); + tracing::debug!(?key, "classified udp session data queue closed"); + } + return; + } + + let Some(accept) = classified_accepts + .get(&protocol) + .map(|entry| entry.value().clone()) + else { + tracing::trace!( + ?protocol, + ?remote_addr, + "classified udp accept is not registered" + ); + return; + }; + + if !accept.accept_enabled.load(Ordering::Relaxed) { + return; + } + + let accept_permit = match accept.accepted.clone().try_reserve_owned() { + Ok(permit) => permit, + Err(err) => { + tracing::debug!(?err, ?key, "classified udp accept queue unavailable"); + return; + } + }; + let local_addr = match socket.local_addr() { + Ok(addr) => addr, + Err(err) => { + tracing::debug!(?err, ?key, "classified udp get local addr error"); + return; + } + }; + let rings = create_udp_session_rings(); + match classified_sessions.entry(key) { + dashmap::mapref::entry::Entry::Vacant(entry) => { + entry.insert(udp_session_registry_entry(&rings)); + } + dashmap::mapref::entry::Entry::Occupied(entry) => { + let entry = entry.get().clone(); + let dispatched = dispatch_payload_to_session( + &entry.incoming, + datagram, + UdpSessionEnqueuePolicy::Reliable, + ); + if !dispatched { + close_classified_udp_session(classified_sessions, key); + tracing::debug!(?key, "classified udp session data queue closed"); + } + return; + } + } + if !dispatch_payload_to_session( + &rings.session_recv_tx, + datagram, + UdpSessionEnqueuePolicy::Reliable, + ) { + close_classified_udp_session(classified_sessions, key); + tracing::debug!(?key, "classified udp session data queue closed"); + return; + } + let close = + UdpSessionClose::classified(key, rings.close_tx.clone(), classified_sessions.clone()); + let session = UdpSession::new( + socket, + local_addr, + remote_addr, + protocol.session_kind(), + UdpSessionCodec::Identity, + rings, + close, + session_shutdown, + ); + accept_permit.send(session); +} + +pub(super) fn handle_new_easy_tier_mux_connect( + socket: Arc, + sessions: Arc, + mux_accepted: mpsc::Sender, + remote_addr: SocketAddr, + conn_id: u32, + packet: &ZCPacket, + session_shutdown: watch::Receiver, +) -> bool +where + S: VirtualUdpSocket, +{ + let payload = packet.udp_payload(); + if payload.len() != 8 { + tracing::warn!( + payload_len = payload.len(), + ?remote_addr, + ?conn_id, + "udp syn packet payload len not match", + ); + return false; + } + + let magic = u64::from_le_bytes(payload[..8].try_into().unwrap()); + let key = UdpSessionKey::new(remote_addr, conn_id); + let sack_packet = new_sack_packet(conn_id, magic).into_bytes(); + if sessions.contains_key(&key) { + let sessions = sessions.clone(); + tokio::spawn(async move { + if let Err(err) = socket.send_to(&sack_packet, remote_addr).await { + tracing::debug!(?err, ?key, "udp resend sack packet error"); + close_udp_session(&sessions, key); + } + }); + return true; + } + + let accept_permit = match mux_accepted.clone().try_reserve_owned() { + Ok(permit) => permit, + Err(err) => { + tracing::debug!(?err, ?key, "udp accept queue unavailable"); + return true; + } + }; + let local_addr = match socket.local_addr() { + Ok(addr) => addr, + Err(err) => { + tracing::debug!(?err, ?key, "udp get local addr for accepted session error"); + return true; + } + }; + let rings = create_udp_session_rings(); + sessions.insert(key, udp_session_registry_entry(&rings)); + let close = UdpSessionClose::easy_tier(key, rings.close_tx.clone(), sessions.clone()); + let session = UdpSession::new( + socket.clone(), + local_addr, + key.peer_addr, + UdpSessionKind::EasyTierMux, + UdpSessionCodec::EasyTierData { conn_id }, + rings, + close, + session_shutdown, + ); + tokio::spawn(async move { + if let Err(err) = socket.send_to(&sack_packet, remote_addr).await { + close_udp_session(&sessions, key); + tracing::debug!(?err, ?key, "udp send sack packet error"); + return; + } + + accept_permit.send(session); + }); + true +} + +pub(super) fn dispatch_sack_packet( + sessions: &UdpSessionRegistry, + pending_connects: &PendingUdpSessionConnects, + recv_addr: SocketAddr, + conn_id: u32, + packet: &ZCPacket, +) -> bool { + let payload = packet.udp_payload(); + if payload.len() != 8 { + if let Some(pending) = pending_connects + .get(&conn_id) + .map(|entry| entry.value().control.clone()) + { + let _ = pending.try_send(UdpConnectControl::InvalidPacket( + "udp sack packet payload len not match".to_owned(), + )); + return true; + } + return false; + } + + let magic = u64::from_le_bytes(payload[..8].try_into().unwrap()); + let Some((_, pending)) = pending_connects.remove_if(&conn_id, |_, pending| { + pending.magic == magic && (*pending.session_key.lock().unwrap()).is_none() + }) else { + if let Some(pending) = pending_connects + .get(&conn_id) + .map(|entry| entry.value().control.clone()) + { + let _ = pending.try_send(UdpConnectControl::InvalidPacket( + "udp sack magic not match".to_owned(), + )); + return true; + } + return false; + }; + + let new_key = UdpSessionKey::new(recv_addr, conn_id); + if !move_pending_udp_session_sender(sessions, &pending, new_key) { + let _ = pending.control.try_send(UdpConnectControl::InvalidPacket( + "udp session already exists".to_owned(), + )); + return true; + } + if pending.sack.send(Some(recv_addr)).is_err() { + close_udp_session(sessions, new_key); + } + true +} + +fn dispatch_hole_punch_packet( + pending_connects: &PendingUdpSessionConnects, + recv_addr: SocketAddr, +) -> bool { + let controls = pending_connects + .iter() + .filter(|entry| entry.value().expected_addr == recv_addr) + .map(|entry| entry.value().control.clone()) + .collect::>(); + if controls.is_empty() { + return false; + } + + for control in controls { + let _ = control.try_send(UdpConnectControl::HolePunch { recv_addr }); + } + true +} + +fn spawn_stun_control_handler( + socket: Arc, + stun_responder: Arc, + permits: Arc, + datagram: BytesMut, + remote_addr: SocketAddr, +) where + S: VirtualUdpSocket, + H: UdpSessionStunResponder, +{ + let Ok(permit) = permits.try_acquire_owned() else { + tracing::debug!(?remote_addr, "udp stun responder queue full"); + return; + }; + tokio::spawn(async move { + let _permit = permit; + if let Err(err) = stun_responder + .respond_stun(socket, &datagram, remote_addr) + .await + { + tracing::debug!(?err, ?remote_addr, "udp respond stun packet error"); + } + }); +} + +fn spawn_v4_hole_punch_control_handler( + socket: Arc, + permits: Arc, + remote_addr: SocketAddr, + dst_addr: SocketAddrV4, +) where + S: VirtualUdpSocket, +{ + let Ok(permit) = permits.try_acquire_owned() else { + tracing::debug!(?remote_addr, ?dst_addr, "udp control handler queue full"); + return; + }; + tokio::spawn(async move { + let _permit = permit; + let packet = new_hole_punch_packet(1, UDP_SESSION_HOLE_PUNCH_PACKET_BODY_LEN).into_bytes(); + if let Err(err) = socket + .send_to_with_meta( + &packet, + SocketAddr::V4(dst_addr), + UdpSocketSendMeta::default(), + ) + .await + { + tracing::debug!( + ?err, + ?remote_addr, + ?dst_addr, + "udp send v4 hole punch packet error" + ); + } + }); +} + +fn spawn_v6_hole_punch_control_handler( + socket: Arc, + permits: Arc, + remote_addr: SocketAddr, + dst_addr: SocketAddrV6, + preferred_src: Option, +) where + S: VirtualUdpSocket, +{ + let Ok(permit) = permits.try_acquire_owned() else { + tracing::debug!(?remote_addr, ?dst_addr, "udp control handler queue full"); + return; + }; + tokio::spawn(async move { + let _permit = permit; + let packet = new_hole_punch_packet(1, UDP_SESSION_HOLE_PUNCH_PACKET_BODY_LEN).into_bytes(); + if let Some(source) = preferred_src { + match socket + .send_to_with_meta( + &packet, + SocketAddr::V6(dst_addr), + UdpSocketSendMeta { + src_ip: Some(source.ip.into()), + src_ifindex: Some(source.ifindex), + }, + ) + .await + { + Ok(_) => return, + Err(error) => tracing::debug!( + ?source, + ?dst_addr, + ?error, + "udp preferred v6 source failed, falling back" + ), + } + } + if let Err(err) = socket + .send_to_with_meta( + &packet, + SocketAddr::V6(dst_addr), + UdpSocketSendMeta::default(), + ) + .await + { + tracing::debug!( + ?err, + ?remote_addr, + ?dst_addr, + ?preferred_src, + "udp send v6 hole punch packet error" + ); + } + }); +} + +pub(super) fn dispatch_v4_hole_punch_control( + socket: Arc, + permits: Arc, + control: &mpsc::Sender, + remote_addr: SocketAddr, + packet: &ZCPacket, +) -> bool +where + S: VirtualUdpSocket, +{ + if !remote_addr.ip().is_loopback() { + tracing::warn!(?remote_addr, "v4 hole punch packet should be from loopback"); + return false; + } + if !remote_addr.ip().is_ipv4() { + tracing::warn!( + ?remote_addr, + "v4 hole punch packet should be sent from ipv4" + ); + return false; + } + let Some(dst_addr) = extract_dst_addr_from_v4_hole_punch_packet(packet.udp_payload()) else { + tracing::debug!(?remote_addr, "invalid v4 hole punch packet"); + return false; + }; + spawn_v4_hole_punch_control_handler(socket, permits, remote_addr, dst_addr); + dispatch_control_packet( + control, + UdpSessionLayerControl::V4HolePunch { + remote_addr, + dst_addr, + }, + ); + true +} + +fn dispatch_v6_hole_punch_control( + socket: Arc, + permits: Arc, + control: &mpsc::Sender, + remote_addr: SocketAddr, + packet: &ZCPacket, +) -> bool +where + S: VirtualUdpSocket, +{ + if !remote_addr.ip().is_loopback() { + tracing::warn!(?remote_addr, "v6 hole punch packet should be from loopback"); + return false; + } + if !remote_addr.ip().is_ipv6() { + tracing::warn!( + ?remote_addr, + "v6 hole punch packet should be sent from ipv6" + ); + return false; + } + let Some((dst_addr, preferred_src)) = extract_v6_hole_punch_packet(packet.udp_payload()) else { + tracing::debug!(?remote_addr, "invalid v6 hole punch packet"); + return false; + }; + spawn_v6_hole_punch_control_handler(socket, permits, remote_addr, dst_addr, preferred_src); + dispatch_control_packet( + control, + UdpSessionLayerControl::V6HolePunch { + remote_addr, + dst_addr, + preferred_src, + }, + ); + true +} + +fn dispatch_control_packet( + control: &mpsc::Sender, + packet: UdpSessionLayerControl, +) { + if let Err(err) = control.try_send(packet) { + tracing::debug!(?err, "udp session control queue full"); + } +} + +#[derive(Debug)] +pub struct UdpSessionDialer { + factory: Arc, +} + +impl UdpSessionDialer +where + F: VirtualUdpSocketFactory, +{ + pub fn new(factory: Arc) -> Self { + Self { factory } + } +} + +#[async_trait] +impl UdpSessionConnector for UdpSessionDialer +where + F: VirtualUdpSocketFactory, +{ + type Session = UdpSession; + + async fn connect( + &mut self, + request: UdpSessionConnectRequest, + ) -> anyhow::Result { + let socket = self.factory.bind_udp(request.bind).await?; + let layer = Arc::new(UdpSessionLayer::new_with_stun_responder( + socket, + self.factory.clone(), + )); + let mut session = layer.open_classified_session(request.protocol, request.remote_addr)?; + session._cleanup.layer_guard = Some(Box::new(layer)); + Ok(session) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + impl UdpSessionLayer + where + S: VirtualUdpSocket, + R: UdpSessionStunResponder, + { + pub(crate) async fn recv_control(&self) -> io::Result { + let mut control_rx = self._control_rx.lock().await; + control_rx + .recv() + .await + .ok_or_else(|| io::Error::new(io::ErrorKind::UnexpectedEof, "udp listener closed")) + } + } +} diff --git a/vendor/easytier/easytier-core/src/socket/udp/listener.rs b/vendor/easytier/easytier-core/src/socket/udp/listener.rs new file mode 100644 index 0000000..27c4e63 --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/udp/listener.rs @@ -0,0 +1,205 @@ +use std::{ + fmt, io, + net::SocketAddr, + sync::{Arc, Mutex as StdMutex, Weak}, +}; + +use async_trait::async_trait; +use serde::{Deserialize, Serialize}; +use url::Url; + +use crate::socket::{ListenerConnectionCounter, SocketListener}; + +use super::{ + UdpBindOptions, UdpSession, UdpSessionLayer, UdpSessionListenRequest, UdpSessionProtocol, + UdpSessionStunResponder, VirtualUdpSocket, VirtualUdpSocketFactory, +}; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +pub enum UdpSessionAcceptKind { + EasyTierMux, + Classified(UdpSessionProtocol), +} + +pub async fn accept_udp_session( + layer: &Arc>, + accept_kind: UdpSessionAcceptKind, +) -> io::Result +where + S: VirtualUdpSocket, + R: UdpSessionStunResponder, +{ + match accept_kind { + UdpSessionAcceptKind::EasyTierMux => layer.accept().await, + UdpSessionAcceptKind::Classified(protocol) => { + layer.accept_classified_session(protocol).await + } + } +} + +type Layer = UdpSessionLayer<::Socket, F>; + +pub struct UdpSessionSocketListener +where + F: VirtualUdpSocketFactory, +{ + url: Url, + request: UdpSessionListenRequest, + accept_kind: UdpSessionAcceptKind, + factory: Arc, + socket: Option>, + layer: Option>>, + layer_ref: Arc>>>>, +} + +impl UdpSessionSocketListener +where + F: VirtualUdpSocketFactory, +{ + pub fn new(url: Url, local_addr: SocketAddr, factory: Arc) -> Self { + let request = UdpSessionListenRequest::new( + UdpBindOptions::port_bound_listener(local_addr).with_only_v6(true), + ); + Self::new_with_request(url, request, UdpSessionAcceptKind::EasyTierMux, factory) + } + + pub fn new_with_request( + url: Url, + request: UdpSessionListenRequest, + accept_kind: UdpSessionAcceptKind, + factory: Arc, + ) -> Self { + Self { + url, + request, + accept_kind, + factory, + socket: None, + layer: None, + layer_ref: Arc::new(StdMutex::new(None)), + } + } + + fn layer(&self) -> anyhow::Result>> { + self.layer + .clone() + .ok_or_else(|| anyhow::anyhow!("udp session listener is not started")) + } + + pub async fn accept_session(&self) -> anyhow::Result { + let layer = self.layer()?; + let mut session = accept_udp_session(&layer, self.accept_kind).await?; + session.keep_layer_alive(layer); + Ok(session) + } +} + +impl fmt::Debug for UdpSessionSocketListener +where + F: VirtualUdpSocketFactory, +{ + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("UdpSessionSocketListener") + .field("url", &self.url) + .field("request", &self.request) + .field("accept_kind", &self.accept_kind) + .field("listening", &self.socket.is_some()) + .finish() + } +} + +#[async_trait] +impl SocketListener for UdpSessionSocketListener +where + F: VirtualUdpSocketFactory, +{ + type Accepted = UdpSession; + + async fn listen(&mut self) -> anyhow::Result<()> { + if self.layer.is_some() { + return Ok(()); + } + + let socket = self.factory.bind_udp(self.request.bind.clone()).await?; + let local_addr = socket.local_addr()?; + self.url + .set_port(Some(local_addr.port())) + .map_err(|_| anyhow::anyhow!("failed to update udp listener port for {}", self.url))?; + + let layer = Arc::new(UdpSessionLayer::new_with_stun_responder( + socket.clone(), + self.factory.clone(), + )); + if let UdpSessionAcceptKind::Classified(protocol) = self.accept_kind { + layer.enable_classified_accept(protocol)?; + } + + *self.layer_ref.lock().unwrap() = Some(Arc::downgrade(&layer)); + self.socket = Some(socket); + self.layer = Some(layer); + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + self.accept_session().await + } + + fn local_url(&self) -> Url { + self.url.clone() + } + + fn connection_counter(&self) -> Arc { + Arc::new(UdpSessionConnectionCounter { + layer: self.layer_ref.clone(), + }) + } +} + +struct UdpSessionConnectionCounter +where + F: VirtualUdpSocketFactory, +{ + layer: Arc>>>>, +} + +impl fmt::Debug for UdpSessionConnectionCounter +where + F: VirtualUdpSocketFactory, +{ + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("UdpSessionConnectionCounter") + .field("active", &self.get()) + .finish() + } +} + +impl ListenerConnectionCounter for UdpSessionConnectionCounter +where + F: VirtualUdpSocketFactory, +{ + fn get(&self) -> Option { + let layer = self.layer.lock().unwrap(); + let Some(layer) = layer.as_ref().and_then(Weak::upgrade) else { + return Some(0); + }; + let active = layer.active_session_count() + layer.active_classified_session_count(); + Some(active as u32) + } +} + +#[cfg(any(test, feature = "test-utils"))] +mod test_utils { + use super::*; + + impl UdpSessionSocketListener + where + F: VirtualUdpSocketFactory, + { + #[doc(hidden)] + pub fn bound_socket(&self) -> anyhow::Result> { + self.socket + .clone() + .ok_or_else(|| anyhow::anyhow!("udp session listener is not started")) + } + } +} diff --git a/vendor/easytier/easytier-core/src/socket/udp/mod.rs b/vendor/easytier/easytier-core/src/socket/udp/mod.rs new file mode 100644 index 0000000..dd708c9 --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/udp/mod.rs @@ -0,0 +1,36 @@ +mod layer; +mod listener; +mod packet; +mod session; +mod virtual_socket; + +#[cfg(test)] +mod tests; + +const UDP_SESSION_RESEND_INTERVAL: std::time::Duration = std::time::Duration::from_millis(200); +const UDP_SESSION_CONNECT_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(3); +const UDP_SESSION_QUEUE_CAPACITY: usize = 128; + +pub use layer::{UdpSessionDialer, UdpSessionLayer}; +pub use listener::{UdpSessionAcceptKind, UdpSessionSocketListener, accept_udp_session}; +pub use packet::{ + UdpSessionPacketError, extract_dst_addr_from_v4_hole_punch_packet, + extract_v6_hole_punch_packet, is_stun_packet, new_sack_packet, new_syn_packet, + new_v4_hole_punch_packet, new_v6_hole_punch_packet, parse_quic_initial_dcid, + parse_udp_session_datagram, +}; +pub use session::{ + UdpSession, UdpSessionConnectError, UdpSessionConnectRequest, UdpSessionConnector, + UdpSessionKind, UdpSessionLayerControl, UdpSessionListenRequest, UdpSessionListener, + UdpSessionProtocol, UdpSessionRecvMeta, UdpSessionSocket, +}; +pub(crate) use session::{ + UdpSessionCleanup, UdpSessionCodec, UdpSessionDatagram, UdpSessionOutbound, + UdpSessionTunnelParts, +}; +pub use virtual_socket::{ + MAX_UDP_DATAGRAM_SIZE, MAX_UDP_SESSION_DATAGRAM_SIZE, NoopUdpSessionStunResponder, + PreferredIpv6Source, UdpBindOptions, UdpSessionStunResponder, UdpSocketDatagram, + UdpSocketPurpose, UdpSocketRecvMeta, UdpSocketSendMeta, VirtualUdpSocket, + VirtualUdpSocketFactory, send_v4_hole_punch_control_packet, send_v6_hole_punch_control_packet, +}; diff --git a/vendor/easytier/easytier-core/src/socket/udp/packet.rs b/vendor/easytier/easytier-core/src/socket/udp/packet.rs new file mode 100644 index 0000000..33f4d5e --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/udp/packet.rs @@ -0,0 +1,404 @@ +use std::{ + io, + net::{Ipv4Addr, Ipv6Addr, SocketAddrV4, SocketAddrV6}, +}; + +use bytes::BytesMut; +use zerocopy::{AsBytes, FromBytes}; + +use crate::packet::{ + UDP_TUNNEL_HEADER_SIZE, UDPTunnelHeader, UdpPacketType, V4HolePunchPacket, V6HolePunchPacket, + ZCPacket, ZCPacketType, +}; + +use super::{session::UdpSessionProtocol, virtual_socket::PreferredIpv6Source}; + +#[derive(Debug, thiserror::Error)] +pub enum UdpSessionPacketError { + #[error("udp packet size too small: {datagram_size:?}, packet: {packet:?}")] + TooSmall { + datagram_size: usize, + packet: BytesMut, + }, + #[error( + "udp packet payload len not match: header len: {header_len:?}, real len: {datagram_size:?}" + )] + PayloadLenMismatch { + header_len: usize, + datagram_size: usize, + }, +} + +pub(super) fn new_udp_packet(f: F, udp_body: &[u8]) -> ZCPacket +where + F: FnOnce(&mut UDPTunnelHeader), +{ + let mut buf = BytesMut::new(); + buf.resize(UDP_TUNNEL_HEADER_SIZE + udp_body.len(), 0); + buf[UDP_TUNNEL_HEADER_SIZE..].copy_from_slice(udp_body); + + let mut ret = ZCPacket::new_from_buf(buf, ZCPacketType::UDP); + let header = ret.mut_udp_tunnel_header().unwrap(); + f(header); + ret +} + +pub fn new_syn_packet(conn_id: u32, magic: u64) -> ZCPacket { + new_udp_packet( + |header| { + header.msg_type = UdpPacketType::Syn as u8; + header.conn_id.set(conn_id); + header.len.set(8); + }, + &magic.to_le_bytes(), + ) +} + +pub fn new_sack_packet(conn_id: u32, magic: u64) -> ZCPacket { + new_udp_packet( + |header| { + header.msg_type = UdpPacketType::Sack as u8; + header.conn_id.set(conn_id); + header.len.set(8); + }, + &magic.to_le_bytes(), + ) +} + +pub(super) fn new_data_packet(conn_id: u32, payload: &[u8]) -> io::Result { + let len = udp_session_payload_len(payload)?; + + Ok(new_udp_packet( + |header| { + header.msg_type = UdpPacketType::Data as u8; + header.conn_id.set(conn_id); + header.len.set(len); + }, + payload, + )) +} + +pub(super) fn udp_session_payload_len(payload: &[u8]) -> io::Result { + u16::try_from(payload.len()).map_err(|_| { + io::Error::new( + io::ErrorKind::InvalidInput, + format!("udp session payload too large: {}", payload.len()), + ) + }) +} + +pub fn new_v6_hole_punch_packet( + dst: &SocketAddrV6, + preferred_src: Option, +) -> ZCPacket { + let mut body = V6HolePunchPacket::default(); + body.dst_ipv6.copy_from_slice(&dst.ip().octets()); + body.dst_port.set(dst.port()); + if let Some(src) = preferred_src { + body.preferred_src_ipv6.copy_from_slice(&src.ip.octets()); + body.preferred_src_ifindex.set(src.ifindex); + } + new_udp_packet( + |header| { + header.msg_type = UdpPacketType::V6HolePunch as u8; + header.conn_id.set(dst.port() as u32); + header + .len + .set(std::mem::size_of::() as u16); + }, + body.as_bytes(), + ) +} + +pub fn new_v4_hole_punch_packet(dst: &SocketAddrV4) -> ZCPacket { + let mut body = V4HolePunchPacket::default(); + body.dst_ipv4.copy_from_slice(&dst.ip().octets()); + body.dst_port.set(dst.port()); + new_udp_packet( + |header| { + header.msg_type = UdpPacketType::V4HolePunch as u8; + header.conn_id.set(dst.port() as u32); + header + .len + .set(std::mem::size_of::() as u16); + }, + body.as_bytes(), + ) +} + +pub fn extract_dst_addr_from_v4_hole_punch_packet(buf: &[u8]) -> Option { + let body = V4HolePunchPacket::ref_from_prefix(buf)?; + let ip = Ipv4Addr::from(body.dst_ipv4); + Some(SocketAddrV4::new(ip, body.dst_port.get())) +} + +pub fn extract_v6_hole_punch_packet( + buf: &[u8], +) -> Option<(SocketAddrV6, Option)> { + let body = V6HolePunchPacket::ref_from_prefix(buf)?; + let ip = Ipv6Addr::from(body.dst_ipv6); + let preferred_src_ipv6 = Ipv6Addr::from(body.preferred_src_ipv6); + let preferred_src = (!preferred_src_ipv6.is_unspecified()).then_some(PreferredIpv6Source { + ip: preferred_src_ipv6, + ifindex: body.preferred_src_ifindex.get(), + }); + Some(( + SocketAddrV6::new(ip, body.dst_port.get(), 0, 0), + preferred_src, + )) +} + +pub fn is_stun_packet(data: &[u8]) -> bool { + data.len() >= UDP_TUNNEL_HEADER_SIZE + && data[4..8] == [0x21, 0x12, 0xA4, 0x42] + && data[0] & 0xC0 == 0 +} + +#[derive(Debug)] +pub(super) enum UdpDatagramClassification { + Stun(BytesMut), + EasyTier { + kind: EasyTierUdpPacketKind, + conn_id: u32, + packet: ZCPacket, + }, + SessionPacket { + kind: UdpSessionPacketKind, + datagram: BytesMut, + }, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(super) enum UdpSessionPacketKind { + Classified(UdpSessionProtocol), + Unknown, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(super) enum EasyTierUdpPacketKind { + Data, + Syn, + Sack, + HolePunch, + V4HolePunch, + V6HolePunch, +} + +impl EasyTierUdpPacketKind { + fn from_msg_type(msg_type: u8) -> Option { + match msg_type { + msg_type if msg_type == UdpPacketType::Data as u8 => Some(Self::Data), + msg_type if msg_type == UdpPacketType::Syn as u8 => Some(Self::Syn), + msg_type if msg_type == UdpPacketType::Sack as u8 => Some(Self::Sack), + msg_type if msg_type == UdpPacketType::HolePunch as u8 => Some(Self::HolePunch), + msg_type if msg_type == UdpPacketType::V4HolePunch as u8 => Some(Self::V4HolePunch), + msg_type if msg_type == UdpPacketType::V6HolePunch as u8 => Some(Self::V6HolePunch), + _ => None, + } + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(super) struct EasyTierUdpDatagramInfo { + pub(super) kind: EasyTierUdpPacketKind, + pub(super) conn_id: u32, +} + +#[derive(Debug)] +pub(super) enum EasyTierUdpDatagramInspectError { + TooSmall { + datagram_size: usize, + }, + PayloadLenMismatch { + header_len: usize, + datagram_size: usize, + }, +} + +pub(super) fn classify_session_udp_datagram(data: &[u8]) -> UdpSessionPacketKind { + if is_wireguard_packet(data) { + UdpSessionPacketKind::Classified(UdpSessionProtocol::WireGuard) + } else if is_quic_packet(data) { + UdpSessionPacketKind::Classified(UdpSessionProtocol::Quic) + } else { + UdpSessionPacketKind::Unknown + } +} + +fn is_wireguard_packet(data: &[u8]) -> bool { + if data.len() < 4 { + return false; + } + + let msg_type = u32::from_le_bytes(data[..4].try_into().unwrap()); + match msg_type { + 1 => data.len() == 148, + 2 => data.len() == 92, + 3 => data.len() == 64, + 4 => data.len() >= 32, + _ => false, + } +} + +fn parse_quic_varint(data: &[u8]) -> Option<(u64, usize)> { + let first = *data.first()?; + let len = 1usize << (first >> 6); + if data.len() < len { + return None; + } + + let mut value = u64::from(first & 0x3f); + for byte in &data[1..len] { + value = (value << 8) | u64::from(*byte); + } + Some((value, len)) +} + +pub fn parse_quic_initial_dcid(data: &[u8]) -> Option> { + const QUIC_INITIAL_HEADER_FORM_AND_FIXED_BIT: u8 = 0xC0; + const QUIC_LONG_PACKET_TYPE_MASK: u8 = 0x30; + const QUIC_MIN_INITIAL_DATAGRAM_LEN: usize = 1200; + const QUIC_MAX_CID_LEN: usize = 20; + + let first = *data.first()?; + if (first & QUIC_INITIAL_HEADER_FORM_AND_FIXED_BIT) != QUIC_INITIAL_HEADER_FORM_AND_FIXED_BIT + || (first & QUIC_LONG_PACKET_TYPE_MASK) != 0 + || data.len() < QUIC_MIN_INITIAL_DATAGRAM_LEN + { + return None; + } + + let version = data.get(1..5)?; + if version == [0, 0, 0, 0] { + return None; + } + + let dcid_len = usize::from(*data.get(5)?); + if dcid_len == 0 || dcid_len > QUIC_MAX_CID_LEN { + return None; + } + let dcid_start = 6; + let dcid_end = dcid_start + dcid_len; + let dcid = data.get(dcid_start..dcid_end)?; + + let scid_len = usize::from(*data.get(dcid_end)?); + if scid_len > QUIC_MAX_CID_LEN { + return None; + } + let token_len_offset = dcid_end + 1 + scid_len; + let (token_len, token_len_size) = parse_quic_varint(data.get(token_len_offset..)?)?; + let packet_len_offset = token_len_offset + token_len_size + usize::try_from(token_len).ok()?; + let (packet_len, packet_len_size) = parse_quic_varint(data.get(packet_len_offset..)?)?; + let packet_offset = packet_len_offset + packet_len_size; + if packet_len == 0 + || data.len().saturating_sub(packet_offset) < usize::try_from(packet_len).ok()? + { + return None; + } + + Some(dcid.to_vec()) +} + +fn is_quic_packet(data: &[u8]) -> bool { + parse_quic_initial_dcid(data).is_some() +} + +pub(super) fn inspect_easytier_udp_datagram( + data: &[u8], +) -> Result, EasyTierUdpDatagramInspectError> { + let datagram_size = data.len(); + if datagram_size < UDP_TUNNEL_HEADER_SIZE { + return Err(EasyTierUdpDatagramInspectError::TooSmall { datagram_size }); + } + + let header = UDPTunnelHeader::ref_from_prefix(data).unwrap(); + let header_len = header.len.get() as usize; + let real_len = datagram_size - UDP_TUNNEL_HEADER_SIZE; + if header_len != real_len { + return Err(EasyTierUdpDatagramInspectError::PayloadLenMismatch { + header_len, + datagram_size, + }); + } + + Ok( + EasyTierUdpPacketKind::from_msg_type(header.msg_type).map(|kind| EasyTierUdpDatagramInfo { + kind, + conn_id: header.conn_id.get(), + }), + ) +} + +pub(super) fn classify_udp_datagram(datagram: BytesMut) -> UdpDatagramClassification { + if is_stun_packet(&datagram) { + return UdpDatagramClassification::Stun(datagram); + } + + let easytier = match inspect_easytier_udp_datagram(&datagram) { + Ok(Some(easytier)) => easytier, + Ok(None) => { + return UdpDatagramClassification::SessionPacket { + kind: classify_session_udp_datagram(&datagram), + datagram, + }; + } + Err(err) => { + match err { + EasyTierUdpDatagramInspectError::TooSmall { datagram_size } => { + tracing::debug!(datagram_size, "udp session packet too small"); + } + EasyTierUdpDatagramInspectError::PayloadLenMismatch { + header_len, + datagram_size, + } => { + tracing::debug!( + header_len, + datagram_size, + "udp session packet payload len mismatch" + ); + } + } + return UdpDatagramClassification::SessionPacket { + kind: classify_session_udp_datagram(&datagram), + datagram, + }; + } + }; + let packet = ZCPacket::new_from_buf(datagram, ZCPacketType::UDP); + + UdpDatagramClassification::EasyTier { + kind: easytier.kind, + conn_id: easytier.conn_id, + packet, + } +} + +pub fn parse_udp_session_datagram( + buf: BytesMut, + allow_stun: bool, +) -> Result { + let datagram_size = buf.len(); + if datagram_size < UDP_TUNNEL_HEADER_SIZE { + return Err(UdpSessionPacketError::TooSmall { + datagram_size, + packet: buf, + }); + } + + if allow_stun && is_stun_packet(&buf[..UDP_TUNNEL_HEADER_SIZE]) { + return Ok(ZCPacket::new_from_buf(buf, ZCPacketType::UDP)); + } + + let zc_packet = ZCPacket::new_from_buf(buf, ZCPacketType::UDP); + let header = zc_packet.udp_tunnel_header().unwrap(); + let header_len = header.len.get() as usize; + let real_len = datagram_size - UDP_TUNNEL_HEADER_SIZE; + if header_len != real_len { + return Err(UdpSessionPacketError::PayloadLenMismatch { + header_len, + datagram_size, + }); + } + + Ok(zc_packet) +} diff --git a/vendor/easytier/easytier-core/src/socket/udp/session.rs b/vendor/easytier/easytier-core/src/socket/udp/session.rs new file mode 100644 index 0000000..4bc3f52 --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/udp/session.rs @@ -0,0 +1,894 @@ +use std::{ + io, + net::{IpAddr, SocketAddr, SocketAddrV4, SocketAddrV6}, + sync::{Arc, Mutex as StdMutex}, +}; + +use async_trait::async_trait; +use bytes::BytesMut; +use dashmap::DashMap; +use futures::{SinkExt, StreamExt}; +use serde::{Deserialize, Serialize}; +use tokio::{ + sync::{Mutex as TokioMutex, mpsc, oneshot, watch}, + task::JoinHandle, +}; + +use crate::{ + packet::{UdpPacketType, ZCPacket, ZCPacketType}, + socket::ring::{RingSocket, RingSocketReceiver, RingSocketSendError, RingSocketSender}, +}; + +use super::{ + MAX_UDP_SESSION_DATAGRAM_SIZE, UDP_SESSION_QUEUE_CAPACITY, + packet::{new_data_packet, udp_session_payload_len}, + virtual_socket::{PreferredIpv6Source, UdpBindOptions, UdpSocketRecvMeta, VirtualUdpSocket}, +}; + +#[derive(Debug)] +pub(crate) struct UdpSessionDatagram { + payload: UdpSessionDatagramPayload, + pub(crate) dst_ip: Option, +} + +#[derive(Debug)] +enum UdpSessionDatagramPayload { + Bytes(BytesMut), + EasyTierPacket(ZCPacket), +} + +impl UdpSessionDatagram { + pub(crate) fn new(payload: BytesMut, meta: UdpSocketRecvMeta) -> Self { + Self { + payload: UdpSessionDatagramPayload::Bytes(payload), + dst_ip: meta.dst_ip, + } + } + + pub(crate) fn from_easytier_packet(packet: ZCPacket, meta: UdpSocketRecvMeta) -> Self { + Self { + payload: UdpSessionDatagramPayload::EasyTierPacket(packet), + dst_ip: meta.dst_ip, + } + } + + pub(crate) fn payload(&self) -> &[u8] { + match &self.payload { + UdpSessionDatagramPayload::Bytes(payload) => payload, + UdpSessionDatagramPayload::EasyTierPacket(packet) => packet.udp_payload(), + } + } + + pub(crate) fn into_tunnel_packet(self) -> Result { + match self.payload { + UdpSessionDatagramPayload::Bytes(payload) => Err(payload), + UdpSessionDatagramPayload::EasyTierPacket(packet) => Ok(packet), + } + } +} + +impl From for UdpSessionDatagram { + fn from(payload: BytesMut) -> Self { + Self { + payload: UdpSessionDatagramPayload::Bytes(payload), + dst_ip: None, + } + } +} + +#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)] +pub struct UdpSessionRecvMeta { + pub dst_ip: Option, +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub enum UdpSessionKind { + EasyTierMux, + WireGuard, + Quic, +} + +#[derive(Debug, thiserror::Error)] +pub enum UdpSessionConnectError { + #[error("io error: {0}")] + Io(#[from] io::Error), + #[error("timeout")] + Timeout, + #[error("invalid packet: {0}")] + InvalidPacket(String), +} + +#[async_trait] +pub trait UdpSessionSocket: Send + Sync + 'static { + fn kind(&self) -> UdpSessionKind; + + fn local_addr(&self) -> std::io::Result; + + fn peer_addr(&self) -> std::io::Result; + + async fn send(&self, data: &[u8]) -> std::io::Result; + + async fn recv(&self, buf: &mut [u8]) -> std::io::Result; + + async fn recv_with_meta(&self, buf: &mut [u8]) -> std::io::Result<(usize, UdpSessionRecvMeta)> { + let len = self.recv(buf).await?; + Ok((len, UdpSessionRecvMeta::default())) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)] +pub enum UdpSessionProtocol { + WireGuard, + Quic, +} + +impl UdpSessionProtocol { + pub(super) fn session_kind(self) -> UdpSessionKind { + match self { + Self::WireGuard => UdpSessionKind::WireGuard, + Self::Quic => UdpSessionKind::Quic, + } + } +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct UdpSessionConnectRequest { + pub remote_addr: SocketAddr, + pub bind: UdpBindOptions, + pub protocol: UdpSessionProtocol, +} + +impl UdpSessionConnectRequest { + pub fn wireguard(remote_addr: SocketAddr) -> Self { + Self { + remote_addr, + bind: UdpBindOptions::direct_connect(), + protocol: UdpSessionProtocol::WireGuard, + } + } + + pub fn with_bind(mut self, bind: UdpBindOptions) -> Self { + self.bind = bind; + self + } +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct UdpSessionListenRequest { + pub bind: UdpBindOptions, +} + +impl UdpSessionListenRequest { + pub fn new(bind: UdpBindOptions) -> Self { + Self { bind } + } +} + +#[async_trait] +pub trait UdpSessionConnector: Send { + type Session: UdpSessionSocket; + + async fn connect(&mut self, request: UdpSessionConnectRequest) + -> anyhow::Result; +} + +#[async_trait] +pub trait UdpSessionListener: Send { + type Session: UdpSessionSocket; + + async fn listen(&mut self, request: UdpSessionListenRequest) -> anyhow::Result<()>; + + fn local_addr(&self) -> std::io::Result; + + async fn accept(&mut self) -> anyhow::Result; +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub(super) struct UdpSessionKey { + pub(super) peer_addr: SocketAddr, + pub(super) conn_id: u32, +} + +impl UdpSessionKey { + pub(super) fn new(peer_addr: SocketAddr, conn_id: u32) -> Self { + Self { peer_addr, conn_id } + } +} + +pub(super) type UdpSessionRegistry = DashMap; +pub(super) type ClassifiedUdpSessionRegistry = + DashMap; +pub(super) type ClassifiedUdpSessionAccepts = + DashMap>; +pub(super) type PendingUdpSessionConnects = DashMap; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] +pub(super) struct ClassifiedUdpSessionKey { + pub(super) protocol: UdpSessionProtocol, + pub(super) peer_addr: SocketAddr, +} + +impl ClassifiedUdpSessionKey { + pub(super) fn new(protocol: UdpSessionProtocol, peer_addr: SocketAddr) -> Self { + Self { + protocol, + peer_addr, + } + } +} + +#[derive(Debug)] +pub(super) struct ClassifiedUdpSessionAccept { + pub(super) accepted: mpsc::Sender, + pub(super) accepted_rx: TokioMutex>, + pub(super) accept_enabled: std::sync::atomic::AtomicBool, +} + +#[derive(Debug, Clone)] +pub(super) struct UdpSessionRegistryEntry { + pub(super) incoming: Arc>>, + pub(super) close: watch::Sender, +} + +#[derive(Debug, Clone)] +pub(super) struct PendingUdpSessionConnect { + pub(super) expected_addr: SocketAddr, + pub(super) magic: u64, + pub(super) session_key: Arc>>, + pub(super) entry: UdpSessionRegistryEntry, + pub(super) control: mpsc::Sender, + pub(super) sack: watch::Sender>, +} + +#[derive(Debug)] +pub(super) enum UdpConnectControl { + HolePunch { recv_addr: SocketAddr }, + InvalidPacket(String), +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum UdpSessionLayerControl { + Stun { + remote_addr: SocketAddr, + datagram: BytesMut, + }, + V4HolePunch { + remote_addr: SocketAddr, + dst_addr: SocketAddrV4, + }, + V6HolePunch { + remote_addr: SocketAddr, + dst_addr: SocketAddrV6, + preferred_src: Option, + }, +} + +#[derive(Debug)] +pub struct UdpSession { + local_addr: SocketAddr, + peer_addr: SocketAddr, + kind: UdpSessionKind, + codec: UdpSessionCodec, + incoming: TokioMutex>, + outgoing: TokioMutex>, + closed: watch::Receiver, + pub(super) _cleanup: UdpSessionCleanup, +} + +pub(crate) enum UdpSessionOutbound { + Datagram { + payload: BytesMut, + completion: oneshot::Sender>, + }, + TunnelPacket(ZCPacket), +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(crate) enum UdpSessionCodec { + EasyTierData { conn_id: u32 }, + Identity, +} + +impl UdpSessionCodec { + pub(crate) fn validate_payload(&self, payload: &[u8]) -> io::Result<()> { + self.validate_datagram_size(payload.len())?; + if matches!(self, Self::EasyTierData { .. }) { + udp_session_payload_len(payload)?; + } + Ok(()) + } + + fn validate_datagram_size(&self, payload_len: usize) -> io::Result<()> { + let header_len = match self { + Self::EasyTierData { .. } => crate::packet::UDP_TUNNEL_HEADER_SIZE, + Self::Identity => 0, + }; + let datagram_len = payload_len.checked_add(header_len).ok_or_else(|| { + io::Error::new( + io::ErrorKind::InvalidInput, + "udp session datagram size overflow", + ) + })?; + if datagram_len > MAX_UDP_SESSION_DATAGRAM_SIZE { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!( + "udp session datagram too large: {datagram_len}, max: \ + {MAX_UDP_SESSION_DATAGRAM_SIZE}" + ), + )); + } + Ok(()) + } + + fn encode(&self, payload: &[u8]) -> io::Result { + self.validate_payload(payload)?; + match self { + Self::EasyTierData { conn_id } => { + Ok(new_data_packet(*conn_id, payload)?.into_bytes().into()) + } + Self::Identity => Ok(BytesMut::from(payload)), + } + } + + fn encode_tunnel_packet(&self, packet: ZCPacket) -> io::Result { + let mut packet = packet.convert_type(ZCPacketType::UDP); + self.validate_datagram_size(packet.udp_payload().len())?; + match self { + Self::EasyTierData { conn_id } => { + let payload_len = udp_session_payload_len(packet.udp_payload())?; + let header = packet.mut_udp_tunnel_header().unwrap(); + header.conn_id.set(*conn_id); + header.msg_type = UdpPacketType::Data as u8; + header.padding = 0; + header.len.set(payload_len); + Ok(packet.into_bytes()) + } + Self::Identity => Ok(packet.udp_payload_bytes().freeze()), + } + } +} + +#[derive(Clone)] +enum UdpSessionCloseTarget { + #[cfg(test)] + SignalOnly, + EasyTier { + key: UdpSessionKey, + sessions: Arc, + }, + Classified { + key: ClassifiedUdpSessionKey, + sessions: Arc, + }, +} + +#[derive(Clone)] +pub(super) struct UdpSessionClose { + close: watch::Sender, + target: UdpSessionCloseTarget, +} + +impl UdpSessionClose { + pub(super) fn easy_tier( + key: UdpSessionKey, + close: watch::Sender, + sessions: Arc, + ) -> Self { + Self { + close, + target: UdpSessionCloseTarget::EasyTier { key, sessions }, + } + } + + pub(super) fn classified( + key: ClassifiedUdpSessionKey, + close: watch::Sender, + sessions: Arc, + ) -> Self { + Self { + close, + target: UdpSessionCloseTarget::Classified { key, sessions }, + } + } + + fn close(&self) { + match &self.target { + #[cfg(test)] + UdpSessionCloseTarget::SignalOnly => {} + UdpSessionCloseTarget::EasyTier { key, sessions } => { + close_udp_session(sessions, *key); + } + UdpSessionCloseTarget::Classified { key, sessions } => { + close_classified_udp_session(sessions, *key); + } + } + let _ = self.close.send(true); + } +} + +pub(crate) struct UdpSessionCleanup { + session_close: Option, + shutdown: Option>, + tasks: Vec>, + pub(super) layer_guard: Option>, +} + +impl std::fmt::Debug for UdpSessionCleanup { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("UdpSessionCleanup") + .field("has_session_close", &self.session_close.is_some()) + .field("has_shutdown", &self.shutdown.is_some()) + .field("tasks", &self.tasks.len()) + .field("has_layer_guard", &self.layer_guard.is_some()) + .finish() + } +} + +impl Drop for UdpSessionCleanup { + fn drop(&mut self) { + if let Some(shutdown) = &self.shutdown { + let _ = shutdown.send(true); + } + if let Some(close) = &self.session_close { + close.close(); + } + for task in &self.tasks { + task.abort(); + } + } +} + +impl UdpSession { + #[allow(clippy::too_many_arguments)] + pub(super) fn new( + socket: Arc, + local_addr: SocketAddr, + peer_addr: SocketAddr, + kind: UdpSessionKind, + codec: UdpSessionCodec, + rings: UdpSessionRingParts, + close: UdpSessionClose, + shutdown: watch::Receiver, + ) -> Self + where + S: VirtualUdpSocket, + { + if *shutdown.borrow() { + let _ = rings.close_tx.send(true); + } + let send_task = tokio::spawn(forward_udp_session_to_socket( + socket, + peer_addr, + codec, + rings.session_send_rx, + close.clone(), + )); + let shutdown_task = tokio::spawn(close_udp_session_on_shutdown( + shutdown, + close.clone(), + send_task.abort_handle(), + )); + + Self { + local_addr, + peer_addr, + kind, + codec, + incoming: TokioMutex::new(rings.session_recv_rx), + outgoing: TokioMutex::new(rings.session_send_tx), + closed: rings.close_rx, + _cleanup: UdpSessionCleanup { + session_close: Some(close), + shutdown: None, + tasks: vec![send_task, shutdown_task], + layer_guard: None, + }, + } + } + + pub(super) fn keep_layer_alive(&mut self, layer_guard: T) + where + T: Send + Sync + 'static, + { + self._cleanup.layer_guard = Some(Box::new(layer_guard)); + } + + pub(crate) fn into_tunnel_parts(self) -> UdpSessionTunnelParts { + let Self { + local_addr, + peer_addr, + kind, + codec, + incoming, + outgoing, + closed, + _cleanup, + } = self; + UdpSessionTunnelParts { + local_addr, + peer_addr, + kind, + codec, + session_recv_rx: incoming.into_inner(), + session_send_tx: outgoing.into_inner(), + closed, + cleanup: _cleanup, + } + } +} + +pub(crate) struct UdpSessionTunnelParts { + pub(crate) local_addr: SocketAddr, + pub(crate) peer_addr: SocketAddr, + pub(crate) kind: UdpSessionKind, + pub(crate) codec: UdpSessionCodec, + pub(crate) session_recv_rx: RingSocketReceiver, + pub(crate) session_send_tx: RingSocketSender, + pub(crate) closed: watch::Receiver, + pub(crate) cleanup: UdpSessionCleanup, +} + +#[async_trait] +impl UdpSessionSocket for UdpSession { + fn kind(&self) -> UdpSessionKind { + self.kind + } + + fn local_addr(&self) -> std::io::Result { + Ok(self.local_addr) + } + + fn peer_addr(&self) -> std::io::Result { + Ok(self.peer_addr) + } + + async fn send(&self, data: &[u8]) -> std::io::Result { + self.codec.validate_payload(data)?; + let mut closed = self.closed.clone(); + if *closed.borrow() { + return Err(udp_session_closed_error()); + } + let (completion, sent) = oneshot::channel(); + let outbound = UdpSessionOutbound::Datagram { + payload: BytesMut::from(data), + completion, + }; + tokio::select! { + biased; + _ = closed.changed() => return Err(udp_session_closed_error()), + ret = async { + let mut outgoing = self.outgoing.lock().await; + outgoing.send(outbound).await + } => ret.map_err(ring_socket_error_to_io)?, + } + + tokio::select! { + biased; + ret = sent => ret.map_err(|_| udp_session_closed_error())?, + _ = closed.changed() => Err(udp_session_closed_error()), + } + } + + async fn recv(&self, buf: &mut [u8]) -> std::io::Result { + self.recv_with_meta(buf).await.map(|(len, _meta)| len) + } + + async fn recv_with_meta(&self, buf: &mut [u8]) -> std::io::Result<(usize, UdpSessionRecvMeta)> { + let mut closed = self.closed.clone(); + if *closed.borrow() { + return Err(udp_session_closed_error()); + } + let mut incoming = self.incoming.lock().await; + let payload = tokio::select! { + biased; + _ = closed.changed() => return Err(udp_session_closed_error()), + payload = incoming.next() => payload + .ok_or_else(udp_session_closed_error)? + .map_err(ring_socket_error_to_io)?, + }; + let len = payload.payload().len().min(buf.len()); + buf[..len].copy_from_slice(&payload.payload()[..len]); + Ok(( + len, + UdpSessionRecvMeta { + dst_ip: payload.dst_ip, + }, + )) + } +} + +pub(super) struct UdpSessionRingParts { + pub(super) session_recv_rx: RingSocketReceiver, + pub(super) session_recv_tx: Arc>>, + pub(super) session_send_tx: RingSocketSender, + pub(super) session_send_rx: RingSocketReceiver, + pub(super) close_tx: watch::Sender, + pub(super) close_rx: watch::Receiver, +} + +pub(super) fn create_udp_session_rings() -> UdpSessionRingParts { + let (session_recv_rx_socket, session_recv_tx_socket) = + RingSocket::pair(UDP_SESSION_QUEUE_CAPACITY); + let (session_send_rx_socket, session_send_tx_socket) = + RingSocket::pair(UDP_SESSION_QUEUE_CAPACITY); + let (session_recv_rx, _unused_session_recv_tx) = session_recv_rx_socket.split(); + let (_unused_session_recv_peer_rx, session_recv_tx) = session_recv_tx_socket.split(); + let (session_send_rx, _unused_session_send_peer_tx) = session_send_rx_socket.split(); + let (_unused_session_send_rx, session_send_tx) = session_send_tx_socket.split(); + let (close_tx, close_rx) = watch::channel(false); + UdpSessionRingParts { + session_recv_rx, + session_recv_tx: Arc::new(StdMutex::new(session_recv_tx)), + session_send_tx, + session_send_rx, + close_tx, + close_rx, + } +} + +pub(super) fn udp_session_registry_entry(rings: &UdpSessionRingParts) -> UdpSessionRegistryEntry { + UdpSessionRegistryEntry { + incoming: rings.session_recv_tx.clone(), + close: rings.close_tx.clone(), + } +} + +pub(super) fn close_udp_session(sessions: &UdpSessionRegistry, key: UdpSessionKey) { + if let Some((_, entry)) = sessions.remove(&key) { + let _ = entry.close.send(true); + } +} + +pub(super) fn close_classified_udp_session( + classified_sessions: &ClassifiedUdpSessionRegistry, + key: ClassifiedUdpSessionKey, +) { + if let Some((_, entry)) = classified_sessions.remove(&key) { + let _ = entry.close.send(true); + } +} + +pub(super) fn close_all_udp_sessions(sessions: &UdpSessionRegistry) { + let close_senders = sessions + .iter() + .map(|entry| entry.value().close.clone()) + .collect::>(); + for close in close_senders { + let _ = close.send(true); + } + sessions.clear(); +} + +pub(super) fn close_all_classified_udp_sessions( + classified_sessions: &ClassifiedUdpSessionRegistry, +) { + let close_senders = classified_sessions + .iter() + .map(|entry| entry.value().close.clone()) + .collect::>(); + for close in close_senders { + let _ = close.send(true); + } + classified_sessions.clear(); +} + +fn ring_socket_error_to_io(error: crate::socket::ring::RingSocketError) -> io::Error { + let kind = match error { + crate::socket::ring::RingSocketError::Closed => io::ErrorKind::UnexpectedEof, + crate::socket::ring::RingSocketError::Full => io::ErrorKind::WouldBlock, + crate::socket::ring::RingSocketError::AlreadySplit => io::ErrorKind::Other, + }; + io::Error::new(kind, error.to_string()) +} + +fn udp_session_closed_error() -> io::Error { + io::Error::new(io::ErrorKind::UnexpectedEof, "udp session closed") +} + +#[derive(Debug, Clone, Copy)] +pub(super) enum UdpSessionEnqueuePolicy { + Lossy, + Reliable, +} + +async fn forward_udp_session_to_socket( + socket: Arc, + peer_addr: SocketAddr, + codec: UdpSessionCodec, + mut outgoing: RingSocketReceiver, + close: UdpSessionClose, +) where + S: VirtualUdpSocket, +{ + loop { + let Some(outbound) = outgoing.next().await else { + break; + }; + let outbound = match outbound { + Ok(outbound) => outbound, + Err(err) => { + tracing::debug!(?err, ?peer_addr, "udp session outgoing ring closed"); + close.close(); + break; + } + }; + let (datagram, completion) = match outbound { + UdpSessionOutbound::Datagram { + payload, + completion, + } => { + let payload_len = payload.len(); + let datagram = match codec.encode(&payload) { + Ok(datagram) => datagram.freeze(), + Err(err) => { + tracing::debug!( + ?err, + ?peer_addr, + ?codec, + "udp session datagram encode error" + ); + let _ = completion.send(Err(err)); + close.close(); + break; + } + }; + (datagram, Some((completion, payload_len))) + } + UdpSessionOutbound::TunnelPacket(packet) => { + let datagram = match codec.encode_tunnel_packet(packet) { + Ok(datagram) => datagram, + Err(err) => { + tracing::debug!(?err, ?peer_addr, ?codec, "udp tunnel packet encode error"); + close.close(); + break; + } + }; + (datagram, None) + } + }; + match socket.send_to(&datagram, peer_addr).await { + Ok(_) => { + if let Some((completion, payload_len)) = completion { + let _ = completion.send(Ok(payload_len)); + } + } + Err(err) => { + tracing::debug!(?err, ?peer_addr, "udp session send error"); + if let Some((completion, _)) = completion { + let _ = completion.send(Err(err)); + } + close.close(); + break; + } + } + } +} + +async fn close_udp_session_on_shutdown( + mut shutdown: watch::Receiver, + close: UdpSessionClose, + send_task: tokio::task::AbortHandle, +) { + if !*shutdown.borrow() { + let _ = shutdown.changed().await; + } + close.close(); + send_task.abort(); +} + +pub(super) fn dispatch_payload_to_session( + incoming: &Arc>>, + payload: impl Into, + policy: UdpSessionEnqueuePolicy, +) -> bool { + let payload = payload.into(); + let result = { + let mut incoming = incoming.lock().unwrap(); + match policy { + UdpSessionEnqueuePolicy::Lossy => incoming.try_send(payload), + UdpSessionEnqueuePolicy::Reliable => incoming.force_send(payload), + } + }; + match result { + Ok(()) => true, + Err(RingSocketSendError::Full(_)) => { + tracing::trace!(?policy, "udp session data queue full"); + true + } + Err(RingSocketSendError::Closed(_)) => false, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + impl UdpSessionClose { + fn signal_only(close: watch::Sender) -> Self { + Self { + close, + target: UdpSessionCloseTarget::SignalOnly, + } + } + } + + impl UdpSession { + pub(crate) fn identity_standalone( + socket: Arc, + peer_addr: SocketAddr, + kind: UdpSessionKind, + ) -> io::Result + where + S: VirtualUdpSocket, + { + let local_addr = socket.local_addr()?; + let rings = create_udp_session_rings(); + let (shutdown_tx, _) = watch::channel(false); + let close = UdpSessionClose::signal_only(rings.close_tx.clone()); + let recv_socket = socket.clone(); + let recv_task = tokio::spawn(forward_identity_socket_to_udp_session( + recv_socket, + peer_addr, + rings.session_recv_tx.clone(), + shutdown_tx.subscribe(), + close.clone(), + )); + let mut session = Self::new( + socket.clone(), + local_addr, + peer_addr, + kind, + UdpSessionCodec::Identity, + rings, + close, + shutdown_tx.subscribe(), + ); + session._cleanup.shutdown = Some(shutdown_tx); + session._cleanup.tasks.push(recv_task); + Ok(session) + } + } + + async fn forward_identity_socket_to_udp_session( + socket: Arc, + peer_addr: SocketAddr, + incoming: Arc>>, + mut shutdown: watch::Receiver, + close: UdpSessionClose, + ) where + S: VirtualUdpSocket, + { + let mut buf = [0u8; 65535]; + loop { + tokio::select! { + biased; + _ = shutdown.changed() => { + close.close(); + break; + } + ret = socket.recv_from(&mut buf) => { + let (len, remote_addr) = match ret { + Ok(ret) => ret, + Err(err) => { + tracing::debug!(?err, ?peer_addr, "identity udp session recv error"); + close.close(); + break; + } + }; + if remote_addr != peer_addr { + continue; + } + if !dispatch_payload_to_session( + &incoming, + BytesMut::from(&buf[..len]), + UdpSessionEnqueuePolicy::Reliable, + ) { + close.close(); + break; + } + } + } + } + } +} diff --git a/vendor/easytier/easytier-core/src/socket/udp/tests.rs b/vendor/easytier/easytier-core/src/socket/udp/tests.rs new file mode 100644 index 0000000..557854d --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/udp/tests.rs @@ -0,0 +1,2211 @@ +use std::{ + collections::VecDeque, + io, + net::{Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6}, + sync::{ + Arc, Mutex, Mutex as StdMutex, + atomic::{AtomicBool, AtomicU16, Ordering}, + }, + time::Duration, +}; + +use async_trait::async_trait; +use bytecodec::EncodeExt as _; +use bytes::BytesMut; +use dashmap::DashMap; +use futures::StreamExt; +use stun_codec::{Message, MessageClass, MessageEncoder, rfc5389::methods::BINDING}; +use tokio::sync::{Semaphore, mpsc, watch}; + +use crate::{ + packet::stun::{Attribute, ChangeRequest, u32_to_tid}, + packet::{UDP_TUNNEL_HEADER_SIZE, UdpPacketType, hole_punch_packet_tid}, + socket::{IpVersion, NetNamespace, SocketContext, SocketListener}, +}; + +use super::{layer::*, packet::*, session::*, virtual_socket::*, *}; + +#[test] +fn bind_options_constructors_describe_socket_purpose() { + let listener_addr = SocketAddr::from(([0, 0, 0, 0], 12345)); + + assert_eq!( + UdpBindOptions::hole_punch_control(), + UdpBindOptions { + context: SocketContext::default(), + local_addr: None, + bind_device: None, + reuse_addr: false, + reuse_port: false, + only_v6: false, + purpose: UdpSocketPurpose::HolePunchControl, + need_protect: true, + } + ); + assert_eq!( + UdpBindOptions::hole_punch_candidate(), + UdpBindOptions { + context: SocketContext::default(), + local_addr: None, + bind_device: None, + reuse_addr: false, + reuse_port: false, + only_v6: false, + purpose: UdpSocketPurpose::HolePunchCandidate, + need_protect: true, + } + ); + assert_eq!( + UdpBindOptions::direct_connect(), + UdpBindOptions { + context: SocketContext::default(), + local_addr: None, + bind_device: None, + reuse_addr: false, + reuse_port: false, + only_v6: false, + purpose: UdpSocketPurpose::DirectConnect, + need_protect: true, + } + ); + assert_eq!( + UdpBindOptions::port_bound_listener(listener_addr), + UdpBindOptions { + context: SocketContext::default(), + local_addr: Some(listener_addr), + bind_device: None, + reuse_addr: false, + reuse_port: false, + only_v6: false, + purpose: UdpSocketPurpose::PortBoundListener, + need_protect: true, + } + ); + assert_eq!( + UdpBindOptions::socks5(), + UdpBindOptions { + context: SocketContext::default(), + local_addr: None, + bind_device: None, + reuse_addr: false, + reuse_port: false, + only_v6: false, + purpose: UdpSocketPurpose::Socks5, + need_protect: true, + } + ); + assert_eq!( + UdpBindOptions::port_forward(listener_addr).purpose, + UdpSocketPurpose::PortForward + ); + assert_eq!( + UdpBindOptions::port_lease(listener_addr).purpose, + UdpSocketPurpose::PortLease + ); + assert_eq!( + UdpBindOptions::default(), + UdpBindOptions::hole_punch_control().with_need_protect(true) + ); +} + +#[test] +fn session_connect_request_keeps_peer_scoped_udp_shape() { + let remote_addr = SocketAddr::from(([192, 0, 2, 1], 11010)); + let bind_addr = SocketAddr::from(([0, 0, 0, 0], 22020)); + + let request = UdpSessionConnectRequest::wireguard(remote_addr) + .with_bind(UdpBindOptions::port_bound_listener(bind_addr)); + + assert_eq!(request.remote_addr, remote_addr); + assert_eq!(request.protocol, UdpSessionProtocol::WireGuard); + assert_eq!( + request.bind, + UdpBindOptions { + context: SocketContext::default(), + local_addr: Some(bind_addr), + bind_device: None, + reuse_addr: false, + reuse_port: false, + only_v6: false, + purpose: UdpSocketPurpose::PortBoundListener, + need_protect: true, + } + ); +} + +#[test] +fn session_listen_request_keeps_bind_options() { + let bind_addr = SocketAddr::from(([0, 0, 0, 0], 11010)); + let bind = UdpBindOptions::port_bound_listener(bind_addr); + + assert_eq!(UdpSessionListenRequest::new(bind.clone()).bind, bind); +} + +async fn drain_session_payloads(mut rings: UdpSessionRingParts) -> usize { + let mut count = 0; + while let Ok(Some(Ok(_))) = + tokio::time::timeout(Duration::from_millis(10), rings.session_recv_rx.next()).await + { + count += 1; + } + count +} + +#[tokio::test] +async fn lossy_udp_session_enqueue_preserves_reserved_capacity() { + const RING_RESERVED_CAPACITY: usize = 4; + + let rings = create_udp_session_rings(); + for _ in 0..UDP_SESSION_QUEUE_CAPACITY { + assert!(dispatch_payload_to_session( + &rings.session_recv_tx, + BytesMut::from("lossy"), + UdpSessionEnqueuePolicy::Lossy, + )); + } + assert_eq!( + drain_session_payloads(rings).await, + UDP_SESSION_QUEUE_CAPACITY - RING_RESERVED_CAPACITY + ); + + let rings = create_udp_session_rings(); + for _ in 0..UDP_SESSION_QUEUE_CAPACITY { + assert!(dispatch_payload_to_session( + &rings.session_recv_tx, + BytesMut::from("lossy"), + UdpSessionEnqueuePolicy::Lossy, + )); + } + for _ in 0..RING_RESERVED_CAPACITY { + assert!(dispatch_payload_to_session( + &rings.session_recv_tx, + BytesMut::from("reliable"), + UdpSessionEnqueuePolicy::Reliable, + )); + } + assert_eq!( + drain_session_payloads(rings).await, + UDP_SESSION_QUEUE_CAPACITY + ); +} + +struct MockUdpSessionSocket { + kind: UdpSessionKind, + local_addr: SocketAddr, + peer_addr: SocketAddr, + incoming: Mutex>, + sent: Mutex>, +} + +#[async_trait] +impl UdpSessionSocket for MockUdpSessionSocket { + fn kind(&self) -> UdpSessionKind { + self.kind + } + + fn local_addr(&self) -> std::io::Result { + Ok(self.local_addr) + } + + fn peer_addr(&self) -> std::io::Result { + Ok(self.peer_addr) + } + + async fn send(&self, data: &[u8]) -> std::io::Result { + self.sent.lock().unwrap().extend_from_slice(data); + Ok(data.len()) + } + + async fn recv(&self, buf: &mut [u8]) -> std::io::Result { + let incoming = self.incoming.lock().unwrap(); + let len = incoming.len().min(buf.len()); + buf[..len].copy_from_slice(&incoming[..len]); + Ok(len) + } +} + +#[tokio::test] +async fn udp_session_socket_is_peer_scoped() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 10000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 10001)); + let socket = MockUdpSessionSocket { + kind: UdpSessionKind::WireGuard, + local_addr, + peer_addr, + incoming: Mutex::new(b"pong".to_vec()), + sent: Mutex::new(Vec::new()), + }; + + assert_eq!(socket.kind(), UdpSessionKind::WireGuard); + assert_eq!(socket.local_addr().unwrap(), local_addr); + assert_eq!(socket.peer_addr().unwrap(), peer_addr); + assert_eq!(socket.send(b"ping").await.unwrap(), 4); + + let mut buf = [0; 8]; + let len = socket.recv(&mut buf).await.unwrap(); + + assert_eq!(&buf[..len], b"pong"); + assert_eq!(&*socket.sent.lock().unwrap(), b"ping"); +} + +struct MockUdpSessionListener { + local_addr: SocketAddr, + accepted: Option, +} + +#[async_trait] +impl UdpSessionListener for MockUdpSessionListener { + type Session = MockUdpSessionSocket; + + async fn listen(&mut self, request: UdpSessionListenRequest) -> anyhow::Result<()> { + if let Some(local_addr) = request.bind.local_addr { + self.local_addr = local_addr; + } + Ok(()) + } + + fn local_addr(&self) -> std::io::Result { + Ok(self.local_addr) + } + + async fn accept(&mut self) -> anyhow::Result { + self.accepted + .take() + .ok_or_else(|| anyhow::anyhow!("no accepted session")) + } +} + +#[tokio::test] +async fn udp_session_listener_reports_bound_local_addr_before_accept() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 10000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 10001)); + let mut listener = MockUdpSessionListener { + local_addr: SocketAddr::from(([0, 0, 0, 0], 0)), + accepted: Some(MockUdpSessionSocket { + kind: UdpSessionKind::EasyTierMux, + local_addr, + peer_addr, + incoming: Mutex::new(Vec::new()), + sent: Mutex::new(Vec::new()), + }), + }; + + listener + .listen(UdpSessionListenRequest::new( + UdpBindOptions::port_bound_listener(local_addr), + )) + .await + .unwrap(); + + assert_eq!(listener.local_addr().unwrap(), local_addr); + assert_eq!( + listener.accept().await.unwrap().peer_addr().unwrap(), + peer_addr + ); +} + +struct MockVirtualUdpSocket { + local_addr: SocketAddr, + incoming: Mutex, SocketAddr)>>, + recv_capacities: Mutex>, + sent: Mutex, SocketAddr)>>, + send_attempts: Mutex, SocketAddr, UdpSocketSendMeta)>>, + reject_preferred_source: AtomicBool, +} + +impl MockVirtualUdpSocket { + fn new(local_addr: SocketAddr, incoming: Vec<(Vec, SocketAddr)>) -> Self { + Self { + local_addr, + incoming: Mutex::new(incoming.into()), + recv_capacities: Mutex::new(Vec::new()), + sent: Mutex::new(Vec::new()), + send_attempts: Mutex::new(Vec::new()), + reject_preferred_source: AtomicBool::new(false), + } + } + + fn sent(&self) -> Vec<(Vec, SocketAddr)> { + self.sent.lock().unwrap().clone() + } + + fn send_attempts(&self) -> Vec<(Vec, SocketAddr, UdpSocketSendMeta)> { + self.send_attempts.lock().unwrap().clone() + } +} + +#[async_trait] +impl VirtualUdpSocket for MockVirtualUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> io::Result { + self.sent.lock().unwrap().push((data.to_vec(), addr)); + Ok(data.len()) + } + + async fn send_to_with_meta( + &self, + data: &[u8], + addr: SocketAddr, + meta: UdpSocketSendMeta, + ) -> io::Result { + self.send_attempts + .lock() + .unwrap() + .push((data.to_vec(), addr, meta)); + if meta.src_ip.is_some() && self.reject_preferred_source.load(Ordering::Relaxed) { + return Err(io::Error::new( + io::ErrorKind::AddrNotAvailable, + "injected preferred source failure", + )); + } + self.send_to(data, addr).await + } + + async fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + self.recv_capacities.lock().unwrap().push(buf.len()); + let (data, remote_addr) = + self.incoming.lock().unwrap().pop_front().ok_or_else(|| { + io::Error::new(io::ErrorKind::UnexpectedEof, "no incoming datagram") + })?; + let len = data.len().min(buf.len()); + buf[..len].copy_from_slice(&data[..len]); + Ok((len, remote_addr)) + } +} + +#[tokio::test] +async fn portable_udp_receive_keeps_general_and_session_capacities_separate() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = MockVirtualUdpSocket::new( + local_addr, + vec![ + (b"session".to_vec(), peer_addr), + (b"general".to_vec(), peer_addr), + ], + ); + + assert_eq!( + socket.recv_session_datagram().await.unwrap().payload, + b"session".as_slice() + ); + assert_eq!( + socket.recv_datagram().await.unwrap().payload, + b"general".as_slice() + ); + assert_eq!( + *socket.recv_capacities.lock().unwrap(), + [MAX_UDP_SESSION_DATAGRAM_SIZE + 1, MAX_UDP_DATAGRAM_SIZE] + ); +} + +fn easytier_stun_request(change_ip: bool, change_port: bool) -> Vec { + let mut request = Message::::new(MessageClass::Request, BINDING, u32_to_tid(7)); + if change_ip || change_port { + request.add_attribute(Attribute::ChangeRequest(ChangeRequest::new( + change_ip, + change_port, + ))); + } + MessageEncoder::new().encode_into_bytes(request).unwrap() +} + +struct FailingSendVirtualUdpSocket { + local_addr: SocketAddr, +} + +#[async_trait] +impl VirtualUdpSocket for FailingSendVirtualUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, _data: &[u8], _addr: SocketAddr) -> io::Result { + Err(io::Error::new( + io::ErrorKind::ConnectionRefused, + "injected send failure", + )) + } + + async fn recv_from(&self, _buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + std::future::pending().await + } +} + +#[derive(Debug, Default)] +struct BlockingUdpSessionStunResponder { + started: tokio::sync::Notify, + release: tokio::sync::Notify, +} + +#[async_trait] +impl UdpSessionStunResponder for BlockingUdpSessionStunResponder { + async fn respond_stun( + &self, + _socket: Arc, + _datagram: &[u8], + _remote_addr: SocketAddr, + ) -> io::Result<()> { + self.started.notify_waiters(); + self.release.notified().await; + Ok(()) + } +} + +struct AutoSackVirtualUdpSocket { + local_addr: SocketAddr, + incoming: Mutex, SocketAddr)>>, + sent: Mutex, SocketAddr)>>, + incoming_notify: tokio::sync::Notify, +} + +impl AutoSackVirtualUdpSocket { + fn new(local_addr: SocketAddr) -> Self { + Self { + local_addr, + incoming: Mutex::new(VecDeque::new()), + sent: Mutex::new(Vec::new()), + incoming_notify: tokio::sync::Notify::new(), + } + } + + fn sent(&self) -> Vec<(Vec, SocketAddr)> { + self.sent.lock().unwrap().clone() + } +} + +#[async_trait] +impl VirtualUdpSocket for AutoSackVirtualUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> io::Result { + self.sent.lock().unwrap().push((data.to_vec(), addr)); + if let Ok(packet) = parse_udp_session_datagram(BytesMut::from(data), false) { + let header = packet.udp_tunnel_header().unwrap(); + if header.msg_type == UdpPacketType::Syn as u8 && packet.udp_payload().len() == 8 { + let conn_id = header.conn_id.get(); + let magic = u64::from_le_bytes(packet.udp_payload()[..8].try_into().unwrap()); + self.incoming + .lock() + .unwrap() + .push_back((new_sack_packet(conn_id, magic).into_bytes().to_vec(), addr)); + self.incoming_notify.notify_one(); + } + } + Ok(data.len()) + } + + async fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + loop { + if let Some((data, remote_addr)) = self.incoming.lock().unwrap().pop_front() { + let len = data.len().min(buf.len()); + buf[..len].copy_from_slice(&data[..len]); + return Ok((len, remote_addr)); + } + self.incoming_notify.notified().await; + } + } +} + +#[async_trait] +impl UdpSessionStunResponder for BlockingUdpSessionStunResponder { + async fn respond_stun( + &self, + _socket: Arc, + _datagram: &[u8], + _remote_addr: SocketAddr, + ) -> io::Result<()> { + self.started.notify_waiters(); + self.release.notified().await; + Ok(()) + } +} + +fn create_test_easy_tier_mux_session( + socket: Arc, + key: UdpSessionKey, + sessions: Arc, +) -> (UdpSession, watch::Sender) +where + S: VirtualUdpSocket, +{ + let (shutdown_tx, shutdown_rx) = watch::channel(false); + ( + create_test_easy_tier_mux_session_with_shutdown(socket, key, sessions, shutdown_rx), + shutdown_tx, + ) +} + +fn create_test_easy_tier_mux_session_with_shutdown( + socket: Arc, + key: UdpSessionKey, + sessions: Arc, + shutdown: watch::Receiver, +) -> UdpSession +where + S: VirtualUdpSocket, +{ + let local_addr = socket.local_addr().unwrap(); + let rings = create_udp_session_rings(); + sessions.insert(key, udp_session_registry_entry(&rings)); + let close = UdpSessionClose::easy_tier(key, rings.close_tx.clone(), sessions); + UdpSession::new( + socket, + local_addr, + key.peer_addr, + UdpSessionKind::EasyTierMux, + UdpSessionCodec::EasyTierData { + conn_id: key.conn_id, + }, + rings, + close, + shutdown, + ) +} + +async fn wait_for_sent(mut sent: F, min_len: usize) -> Vec<(Vec, SocketAddr)> +where + F: FnMut() -> Vec<(Vec, SocketAddr)>, +{ + tokio::time::timeout(Duration::from_secs(1), async move { + loop { + let packets = sent(); + if packets.len() >= min_len { + return packets; + } + tokio::task::yield_now().await; + } + }) + .await + .unwrap() +} + +fn wireguard_transport_packet(payload: &[u8]) -> Vec { + let mut packet = vec![0; 32.max(4 + payload.len())]; + packet[..4].copy_from_slice(&4u32.to_le_bytes()); + packet[4..4 + payload.len()].copy_from_slice(payload); + packet +} + +fn wireguard_packet_with_easy_tier_data_header(payload: &[u8]) -> Vec { + let payload_len = 24.max(payload.len()); + let mut packet = vec![0; UDP_TUNNEL_HEADER_SIZE + payload_len]; + packet[..4].copy_from_slice(&4u32.to_le_bytes()); + packet[4] = UdpPacketType::Data as u8; + packet[6..8].copy_from_slice(&(payload_len as u16).to_le_bytes()); + packet[UDP_TUNNEL_HEADER_SIZE..UDP_TUNNEL_HEADER_SIZE + payload.len()].copy_from_slice(payload); + packet +} + +#[tokio::test] +async fn wireguard_udp_session_sends_to_peer_addr() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let session = + UdpSession::identity_standalone(socket.clone(), peer_addr, UdpSessionKind::WireGuard) + .unwrap(); + + assert_eq!(session.kind(), UdpSessionKind::WireGuard); + assert_eq!(session.local_addr().unwrap(), local_addr); + assert_eq!(session.peer_addr().unwrap(), peer_addr); + assert_eq!(session.send(b"hello").await.unwrap(), 5); + + let sent = wait_for_sent(|| socket.sent(), 1).await; + assert_eq!(sent, vec![(b"hello".to_vec(), peer_addr)]); +} + +#[tokio::test] +async fn wireguard_udp_session_receives_only_from_peer_addr() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let unexpected_addr = SocketAddr::from(([127, 0, 0, 1], 12002)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + socket.incoming.lock().unwrap().extend([ + (b"noise".to_vec(), unexpected_addr), + (b"payload".to_vec(), peer_addr), + ]); + socket.incoming_notify.notify_one(); + let session = + UdpSession::identity_standalone(socket, peer_addr, UdpSessionKind::WireGuard).unwrap(); + + let mut buf = [0; 16]; + let len = session.recv(&mut buf).await.unwrap(); + + assert_eq!(&buf[..len], b"payload"); +} + +#[tokio::test] +async fn wireguard_udp_session_send_failure_closes_recv() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(FailingSendVirtualUdpSocket { local_addr }); + let session = + UdpSession::identity_standalone(socket, peer_addr, UdpSessionKind::WireGuard).unwrap(); + + let err = tokio::time::timeout(Duration::from_secs(1), session.send(b"payload")) + .await + .unwrap() + .unwrap_err(); + assert_eq!(err.kind(), io::ErrorKind::ConnectionRefused); + + let mut buf = [0; 16]; + let err = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap_err(); + assert_eq!(err.kind(), io::ErrorKind::UnexpectedEof); +} + +#[tokio::test] +async fn udp_layer_routes_wireguard_packets_to_registered_wireguard_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = UdpSessionLayer::new(socket.clone()); + let session = layer + .open_classified_session(UdpSessionProtocol::WireGuard, peer_addr) + .unwrap(); + + assert_eq!(session.kind(), UdpSessionKind::WireGuard); + assert_eq!(session.send(b"outbound").await.unwrap(), 8); + let sent = wait_for_sent(|| socket.sent(), 1).await; + assert_eq!(sent, vec![(b"outbound".to_vec(), peer_addr)]); + + let inbound = wireguard_transport_packet(b"inbound"); + socket + .incoming + .lock() + .unwrap() + .push_back((inbound.clone(), peer_addr)); + socket.incoming_notify.notify_one(); + + let mut buf = [0; 64]; + let len = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap(); + + assert_eq!(&buf[..len], inbound.as_slice()); +} + +#[tokio::test] +async fn udp_layer_routes_unclaimed_easy_tier_shaped_wireguard_packet_to_wireguard_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = UdpSessionLayer::new(socket.clone()); + let session = layer + .open_classified_session(UdpSessionProtocol::WireGuard, peer_addr) + .unwrap(); + let packet = wireguard_packet_with_easy_tier_data_header(b"wireguard-collision"); + + socket + .incoming + .lock() + .unwrap() + .push_back((packet.clone(), peer_addr)); + socket.incoming_notify.notify_one(); + + let mut buf = [0; 64]; + let len = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap(); + + assert_eq!(&buf[..len], packet.as_slice()); + assert_eq!(layer.active_session_count(), 0); +} + +#[tokio::test] +async fn udp_layer_routes_claimed_easy_tier_data_to_mux_before_wireguard_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = UdpSessionLayer::new(socket.clone()); + let wireguard_session = layer + .open_classified_session(UdpSessionProtocol::WireGuard, peer_addr) + .unwrap(); + let key = UdpSessionKey::new(peer_addr, 4); + let (mux_session, _shutdown_tx) = + create_test_easy_tier_mux_session(socket.clone(), key, layer.sessions.clone()); + let packet = wireguard_packet_with_easy_tier_data_header(b"mux-payload"); + let mux_payload = packet[UDP_TUNNEL_HEADER_SIZE..].to_vec(); + + socket + .incoming + .lock() + .unwrap() + .push_back((packet, peer_addr)); + socket.incoming_notify.notify_one(); + + let mut mux_buf = [0; 32]; + let len = tokio::time::timeout(Duration::from_secs(1), mux_session.recv(&mut mux_buf)) + .await + .unwrap() + .unwrap(); + assert_eq!(&mux_buf[..len], mux_payload.as_slice()); + + let mut wireguard_buf = [0; 64]; + assert!( + tokio::time::timeout( + Duration::from_millis(100), + wireguard_session.recv(&mut wireguard_buf) + ) + .await + .is_err() + ); +} + +#[tokio::test] +async fn udp_layer_drops_unknown_datagram_instead_of_creating_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = Arc::new(UdpSessionLayer::new(socket.clone())); + let mut accept_task = tokio::spawn({ + let layer = layer.clone(); + async move { + layer + .accept_classified_session(UdpSessionProtocol::WireGuard) + .await + } + }); + + tokio::time::timeout(Duration::from_secs(1), async { + while !layer + .classified_accepts + .get(&UdpSessionProtocol::WireGuard) + .unwrap() + .accept_enabled + .load(Ordering::Relaxed) + { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + + socket + .incoming + .lock() + .unwrap() + .push_back((b"first".to_vec(), peer_addr)); + socket.incoming_notify.notify_one(); + + assert!( + tokio::time::timeout(Duration::from_millis(100), &mut accept_task) + .await + .is_err() + ); + accept_task.abort(); + assert_eq!(layer.active_classified_session_count(), 0); +} + +#[tokio::test] +async fn udp_layer_drops_malformed_quic_like_datagrams_instead_of_creating_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = Arc::new(UdpSessionLayer::new(socket.clone())); + let mut accept_task = tokio::spawn({ + let layer = layer.clone(); + async move { + layer + .accept_classified_session(UdpSessionProtocol::Quic) + .await + } + }); + + tokio::time::timeout(Duration::from_secs(1), async { + while !layer + .classified_accepts + .get(&UdpSessionProtocol::Quic) + .unwrap() + .accept_enabled + .load(Ordering::Relaxed) + { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + + socket + .incoming + .lock() + .unwrap() + .push_back((vec![0xc0; 32], peer_addr)); + socket + .incoming + .lock() + .unwrap() + .push_back((vec![0xc0; 1200], peer_addr)); + socket.incoming_notify.notify_one(); + + assert!( + tokio::time::timeout(Duration::from_millis(100), &mut accept_task) + .await + .is_err() + ); + accept_task.abort(); + assert_eq!(layer.active_classified_session_count(), 0); +} + +#[tokio::test] +async fn udp_layer_accepts_unclaimed_easy_tier_shaped_wireguard_packet_when_enabled() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = Arc::new(UdpSessionLayer::new(socket.clone())); + let accept_task = tokio::spawn({ + let layer = layer.clone(); + async move { + layer + .accept_classified_session(UdpSessionProtocol::WireGuard) + .await + } + }); + let packet = wireguard_packet_with_easy_tier_data_header(b"accepted-wireguard"); + + tokio::time::timeout(Duration::from_secs(1), async { + while !layer + .classified_accepts + .get(&UdpSessionProtocol::WireGuard) + .unwrap() + .accept_enabled + .load(Ordering::Relaxed) + { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + + socket + .incoming + .lock() + .unwrap() + .push_back((packet.clone(), peer_addr)); + socket.incoming_notify.notify_one(); + + let accepted = tokio::time::timeout(Duration::from_secs(1), accept_task) + .await + .unwrap() + .unwrap() + .unwrap(); + let mut buf = [0; 192]; + let len = accepted.recv(&mut buf).await.unwrap(); + + assert_eq!(accepted.peer_addr().unwrap(), peer_addr); + assert_eq!(&buf[..len], packet.as_slice()); + assert_eq!(layer.active_session_count(), 0); + assert_eq!(layer.active_classified_session_count(), 1); +} + +#[tokio::test] +async fn udp_layer_pre_enabled_classified_accept_queues_first_packet() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = UdpSessionLayer::new(socket.clone()); + let packet = wireguard_packet_with_easy_tier_data_header(b"pre-enabled-wireguard"); + + layer + .enable_classified_accept(UdpSessionProtocol::WireGuard) + .unwrap(); + socket + .incoming + .lock() + .unwrap() + .push_back((packet.clone(), peer_addr)); + socket.incoming_notify.notify_one(); + + let accepted = tokio::time::timeout( + Duration::from_secs(1), + layer.accept_classified_session(UdpSessionProtocol::WireGuard), + ) + .await + .unwrap() + .unwrap(); + let mut buf = [0; 192]; + let len = accepted.recv(&mut buf).await.unwrap(); + + assert_eq!(accepted.peer_addr().unwrap(), peer_addr); + assert_eq!(&buf[..len], packet.as_slice()); + assert_eq!(layer.active_session_count(), 0); + assert_eq!(layer.active_classified_session_count(), 1); +} + +#[tokio::test] +async fn udp_layer_routes_quic_like_easytier_packet_to_existing_quic_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = UdpSessionLayer::new(socket.clone()); + let session = layer + .open_classified_session(UdpSessionProtocol::Quic, peer_addr) + .unwrap(); + let packet = new_udp_packet( + |header| { + header.conn_id.set(0x40); + header.msg_type = UdpPacketType::Syn as u8; + header.len.set(8); + }, + b"12345678", + ) + .into_bytes() + .to_vec(); + + socket + .incoming + .lock() + .unwrap() + .push_back((packet.clone(), peer_addr)); + socket.incoming_notify.notify_one(); + + let mut buf = [0; 64]; + let len = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap(); + + assert_eq!(&buf[..len], packet.as_slice()); + assert_eq!(layer.active_session_count(), 0); + assert_eq!(layer.active_classified_session_count(), 1); +} + +#[tokio::test] +async fn udp_layer_drops_oversized_datagram_without_stopping_portable_socket() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = UdpSessionLayer::new(socket.clone()); + let session = layer + .open_classified_session(UdpSessionProtocol::Quic, peer_addr) + .unwrap(); + socket.incoming.lock().unwrap().extend([ + (vec![0xAA; MAX_UDP_SESSION_DATAGRAM_SIZE + 1], peer_addr), + (b"after-oversized".to_vec(), peer_addr), + ]); + socket.incoming_notify.notify_one(); + + let mut buf = [0; 32]; + let len = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap(); + + assert_eq!(&buf[..len], b"after-oversized"); +} + +#[tokio::test] +async fn udp_layer_keeps_easy_tier_syn_out_of_wireguard_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = UdpSessionLayer::new(socket.clone()); + let session = layer + .open_classified_session(UdpSessionProtocol::WireGuard, peer_addr) + .unwrap(); + let syn = new_syn_packet(0x1122_3344, 0x5566_7788).into_bytes(); + + socket + .incoming + .lock() + .unwrap() + .push_back((syn.to_vec(), peer_addr)); + socket.incoming_notify.notify_one(); + + tokio::time::timeout(Duration::from_secs(1), async { + while layer.active_session_count() == 0 { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + + let mut buf = [0; 16]; + assert!( + tokio::time::timeout(Duration::from_millis(50), session.recv(&mut buf)) + .await + .is_err() + ); +} + +#[tokio::test] +async fn easy_tier_mux_udp_session_wraps_sent_payloads() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let conn_id = 0x1122_3344; + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, Vec::new())); + let sessions = Arc::new(DashMap::new()); + let (session, _shutdown_tx) = create_test_easy_tier_mux_session( + socket.clone(), + UdpSessionKey::new(peer_addr, conn_id), + sessions, + ); + + assert_eq!(session.kind(), UdpSessionKind::EasyTierMux); + assert_eq!(session.send(b"payload").await.unwrap(), 7); + + let sent = wait_for_sent(|| socket.sent(), 1).await; + assert_eq!(sent.len(), 1); + assert_eq!(sent[0].1, peer_addr); + + let packet = parse_udp_session_datagram(BytesMut::from(sent[0].0.as_slice()), false) + .expect("sent datagram should keep EasyTier UDP packet shape"); + let header = packet.udp_tunnel_header().unwrap(); + assert_eq!(header.conn_id.get(), conn_id); + assert_eq!(header.msg_type, UdpPacketType::Data as u8); + assert_eq!(header.len.get(), 7); + assert_eq!(packet.udp_payload(), b"payload"); +} + +#[tokio::test] +async fn easy_tier_mux_udp_session_rejects_oversized_payload_before_enqueue() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let conn_id = 0x1122_3344; + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, Vec::new())); + let sessions = Arc::new(DashMap::new()); + let (session, _shutdown_tx) = create_test_easy_tier_mux_session( + socket.clone(), + UdpSessionKey::new(peer_addr, conn_id), + sessions, + ); + + let payload = vec![0; MAX_UDP_SESSION_DATAGRAM_SIZE - UDP_TUNNEL_HEADER_SIZE + 1]; + let err = session.send(&payload).await.unwrap_err(); + + assert_eq!(err.kind(), io::ErrorKind::InvalidInput); + assert!(socket.sent().is_empty()); +} + +#[test] +fn udp_session_codecs_enforce_datagram_boundary() { + let identity = UdpSessionCodec::Identity; + assert!( + identity + .validate_payload(&vec![0; MAX_UDP_SESSION_DATAGRAM_SIZE]) + .is_ok() + ); + let err = identity + .validate_payload(&vec![0; MAX_UDP_SESSION_DATAGRAM_SIZE + 1]) + .unwrap_err(); + assert_eq!(err.kind(), io::ErrorKind::InvalidInput); + + let easy_tier = UdpSessionCodec::EasyTierData { + conn_id: 0x1122_3344, + }; + let max_payload = MAX_UDP_SESSION_DATAGRAM_SIZE - UDP_TUNNEL_HEADER_SIZE; + assert!(easy_tier.validate_payload(&vec![0; max_payload]).is_ok()); + let err = easy_tier + .validate_payload(&vec![0; max_payload + 1]) + .unwrap_err(); + assert_eq!(err.kind(), io::ErrorKind::InvalidInput); +} + +#[tokio::test] +async fn easy_tier_mux_udp_session_send_failure_closes_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let conn_id = 0x1122_3344; + let key = UdpSessionKey::new(peer_addr, conn_id); + let socket = Arc::new(FailingSendVirtualUdpSocket { local_addr }); + let sessions = Arc::new(DashMap::new()); + let (session, _shutdown_tx) = create_test_easy_tier_mux_session(socket, key, sessions.clone()); + + let err = tokio::time::timeout(Duration::from_secs(1), session.send(b"payload")) + .await + .unwrap() + .unwrap_err(); + + assert_eq!(err.kind(), io::ErrorKind::ConnectionRefused); + tokio::time::timeout(Duration::from_secs(1), async { + while sessions.contains_key(&key) { + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + + let mut buf = [0; 16]; + let err = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap_err(); + assert_eq!(err.kind(), io::ErrorKind::UnexpectedEof); +} + +#[tokio::test] +async fn easy_tier_mux_udp_session_receives_only_peer_data_payloads() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let unexpected_addr = SocketAddr::from(([127, 0, 0, 1], 12002)); + let conn_id = 0x1122_3344; + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, Vec::new())); + let sessions = Arc::new(DashMap::new()); + let (session, _shutdown_tx) = create_test_easy_tier_mux_session( + socket, + UdpSessionKey::new(peer_addr, conn_id), + sessions.clone(), + ); + + assert!( + dispatch_data_packet( + &sessions, + unexpected_addr, + conn_id, + new_data_packet(conn_id, b"wrong-peer").unwrap(), + Default::default(), + ) + .is_err() + ); + assert!( + dispatch_data_packet( + &sessions, + peer_addr, + conn_id + 1, + new_data_packet(conn_id + 1, b"wrong-conn").unwrap(), + Default::default(), + ) + .is_err() + ); + assert!( + dispatch_data_packet( + &sessions, + peer_addr, + conn_id, + new_data_packet(conn_id, b"payload").unwrap(), + Default::default(), + ) + .is_ok() + ); + + let mut buf = [0; 16]; + let len = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap(); + + assert_eq!(&buf[..len], b"payload"); +} + +#[tokio::test] +async fn udp_session_layer_connects_with_shared_recv_loop() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = UdpSessionLayer::new(socket.clone()); + + let session = tokio::time::timeout(Duration::from_secs(1), layer.connect(peer_addr)) + .await + .unwrap() + .unwrap(); + + assert_eq!(layer.local_addr().unwrap(), local_addr); + assert_eq!(session.kind(), UdpSessionKind::EasyTierMux); + assert_eq!(session.peer_addr().unwrap(), peer_addr); + + let sent = socket.sent(); + assert!(!sent.is_empty()); + let packet = parse_udp_session_datagram(BytesMut::from(sent[0].0.as_slice()), false) + .expect("first sent datagram should be syn"); + assert_eq!( + packet.udp_tunnel_header().unwrap().msg_type, + UdpPacketType::Syn as u8 + ); +} + +#[tokio::test] +async fn cancelled_udp_session_connect_cleans_registered_state() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, Vec::new())); + let layer = UdpSessionLayer::new(socket); + + let result = tokio::time::timeout(Duration::from_millis(50), layer.connect(peer_addr)).await; + + assert!(result.is_err()); + assert!(layer.pending_connects.is_empty()); + assert!(layer.sessions.is_empty()); +} + +#[tokio::test] +async fn dropping_udp_session_layer_closes_session_recv() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + let layer = UdpSessionLayer::new(socket.clone()); + let session = layer.connect(peer_addr).await.unwrap(); + drop(layer); + + let mut buf = [0; 16]; + let err = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap_err(); + + assert_eq!(err.kind(), io::ErrorKind::UnexpectedEof); +} + +#[tokio::test] +async fn idle_udp_session_closes_when_shutdown_is_signaled() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let key = UdpSessionKey::new(peer_addr, 0x1122_3344); + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, Vec::new())); + let sessions = Arc::new(DashMap::new()); + let (session, shutdown_tx) = create_test_easy_tier_mux_session(socket, key, sessions.clone()); + + shutdown_tx.send(true).unwrap(); + + let mut buf = [0; 16]; + let err = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap_err(); + assert_eq!(err.kind(), io::ErrorKind::UnexpectedEof); + assert!(!sessions.contains_key(&key)); +} + +#[tokio::test] +async fn udp_session_recv_loop_error_closes_registered_sessions() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let conn_id = 0x1122_3344; + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, Vec::new())); + let sessions = Arc::new(DashMap::new()); + let (session_shutdown_tx, session_shutdown_rx) = watch::channel(false); + let session = create_test_easy_tier_mux_session_with_shutdown( + socket.clone(), + UdpSessionKey::new(peer_addr, conn_id), + sessions.clone(), + session_shutdown_rx, + ); + let pending_connects = Arc::new(DashMap::new()); + let classified_sessions = Arc::new(DashMap::new()); + let classified_accepts = create_classified_udp_session_accepts(); + let (mux_accepted_tx, _mux_accepted_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (control_tx, _control_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + + udp_session_layer_recv_task( + socket, + sessions.clone(), + classified_sessions.clone(), + classified_accepts, + pending_connects.clone(), + mux_accepted_tx, + control_tx, + Arc::new(NoopUdpSessionStunResponder), + session_shutdown_tx, + ) + .await; + + assert!(sessions.is_empty()); + assert!(classified_sessions.is_empty()); + assert!(pending_connects.is_empty()); + + let mut buf = [0; 16]; + let err = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap_err(); + assert_eq!(err.kind(), io::ErrorKind::UnexpectedEof); + + let err = tokio::time::timeout(Duration::from_secs(1), async { + loop { + if let Err(err) = session.send(b"payload").await { + return err; + } + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + assert_eq!(err.kind(), io::ErrorKind::UnexpectedEof); +} + +#[tokio::test] +async fn udp_session_layer_accepts_syn_and_sends_sack() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let conn_id = 0x1122_3344; + let magic = 0x0102_0304_0506_0708; + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, Vec::new())); + let sessions = Arc::new(DashMap::new()); + let (mux_accepted_tx, mut mux_accepted_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (_shutdown_tx, shutdown_rx) = watch::channel(false); + + handle_new_easy_tier_mux_connect( + socket.clone(), + sessions.clone(), + mux_accepted_tx, + peer_addr, + conn_id, + &new_syn_packet(conn_id, magic), + shutdown_rx, + ); + + let accepted = tokio::time::timeout(Duration::from_secs(1), mux_accepted_rx.recv()) + .await + .unwrap() + .unwrap(); + assert_eq!(accepted.kind(), UdpSessionKind::EasyTierMux); + assert_eq!(accepted.peer_addr().unwrap(), peer_addr); + assert!(sessions.contains_key(&UdpSessionKey::new(peer_addr, conn_id))); + + let sent = wait_for_sent(|| socket.sent(), 1).await; + assert_eq!(sent.len(), 1); + assert_eq!(sent[0].1, peer_addr); + let packet = parse_udp_session_datagram(BytesMut::from(sent[0].0.as_slice()), false) + .expect("sent datagram should be sack"); + let header = packet.udp_tunnel_header().unwrap(); + assert_eq!(header.conn_id.get(), conn_id); + assert_eq!(header.msg_type, UdpPacketType::Sack as u8); + assert_eq!(packet.udp_payload(), magic.to_le_bytes()); +} + +#[tokio::test] +async fn duplicate_syn_sack_send_failure_closes_existing_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let conn_id = 0x1122_3344; + let magic = 0x0102_0304_0506_0708; + let key = UdpSessionKey::new(peer_addr, conn_id); + let socket = Arc::new(FailingSendVirtualUdpSocket { local_addr }); + let sessions = Arc::new(DashMap::new()); + let (session, _shutdown_tx) = + create_test_easy_tier_mux_session(socket.clone(), key, sessions.clone()); + let (mux_accepted_tx, _mux_accepted_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (_session_shutdown_tx, session_shutdown_rx) = watch::channel(false); + + handle_new_easy_tier_mux_connect( + socket, + sessions.clone(), + mux_accepted_tx, + peer_addr, + conn_id, + &new_syn_packet(conn_id, magic), + session_shutdown_rx, + ); + + let mut buf = [0; 16]; + let err = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap_err(); + assert_eq!(err.kind(), io::ErrorKind::UnexpectedEof); + assert!(!sessions.contains_key(&key)); +} + +#[tokio::test] +async fn full_accept_queue_does_not_block_udp_session_recv_loop() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let conn_id = 0x1122_3344; + let magic = 0x0102_0304_0506_0708; + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, Vec::new())); + let sessions = Arc::new(DashMap::new()); + let full_sessions = Arc::new(DashMap::new()); + let (mux_accepted_tx, mut mux_accepted_rx) = mpsc::channel(1); + let (queued_session, _queued_shutdown_tx) = create_test_easy_tier_mux_session( + socket.clone(), + UdpSessionKey::new(SocketAddr::from(([127, 0, 0, 1], 12002)), 7), + full_sessions, + ); + mux_accepted_tx.try_send(queued_session).unwrap(); + let (_shutdown_tx, shutdown_rx) = watch::channel(false); + + handle_new_easy_tier_mux_connect( + socket.clone(), + sessions.clone(), + mux_accepted_tx, + peer_addr, + conn_id, + &new_syn_packet(conn_id, magic), + shutdown_rx, + ); + + assert!(mux_accepted_rx.try_recv().is_ok()); + assert!(!sessions.contains_key(&UdpSessionKey::new(peer_addr, conn_id))); + assert!(socket.sent().is_empty()); +} + +#[tokio::test] +async fn udp_session_layer_routes_stun_and_hole_punch_control_packets() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let stun_remote_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let change_stun_remote_addr = SocketAddr::from(([127, 0, 0, 1], 12004)); + let rejected_remote_addr = SocketAddr::from(([192, 0, 2, 1], 12001)); + let v4_remote_addr = SocketAddr::from(([127, 0, 0, 1], 12002)); + let v6_remote_addr = "[::1]:12003".parse::().unwrap(); + let dst_v4 = SocketAddrV4::new(Ipv4Addr::new(192, 0, 2, 10), 1234); + let dst_v6 = "[2001:db8::1]:2345".parse::().unwrap(); + let preferred_src = PreferredIpv6Source { + ip: "2001:db8::2".parse().unwrap(), + ifindex: 42, + }; + let stun = easytier_stun_request(false, false); + let change_stun = easytier_stun_request(true, false); + let socket = Arc::new(MockVirtualUdpSocket::new( + local_addr, + vec![ + (stun.clone(), stun_remote_addr), + (change_stun.clone(), change_stun_remote_addr), + ( + new_v4_hole_punch_packet(&dst_v4).into_bytes().to_vec(), + rejected_remote_addr, + ), + ( + new_v4_hole_punch_packet(&dst_v4).into_bytes().to_vec(), + v4_remote_addr, + ), + ( + new_v6_hole_punch_packet(&dst_v6, Some(preferred_src)) + .into_bytes() + .to_vec(), + v6_remote_addr, + ), + ], + )); + socket + .reject_preferred_source + .store(true, Ordering::Relaxed); + let stun_responder = Arc::new(MockVirtualUdpSocketFactory::new(13000)); + let layer = UdpSessionLayer::new_with_stun_responder(socket.clone(), stun_responder.clone()); + + let mut events = Vec::new(); + for _ in 0..4 { + events.push( + tokio::time::timeout(Duration::from_secs(1), layer.recv_control()) + .await + .unwrap() + .unwrap(), + ); + } + assert!(events.contains(&UdpSessionLayerControl::Stun { + remote_addr: stun_remote_addr, + datagram: BytesMut::from(stun.as_slice()), + })); + assert!(events.contains(&UdpSessionLayerControl::Stun { + remote_addr: change_stun_remote_addr, + datagram: BytesMut::from(change_stun.as_slice()), + })); + assert!(events.contains(&UdpSessionLayerControl::V4HolePunch { + remote_addr: v4_remote_addr, + dst_addr: dst_v4, + })); + assert!(events.contains(&UdpSessionLayerControl::V6HolePunch { + remote_addr: v6_remote_addr, + dst_addr: dst_v6, + preferred_src: Some(preferred_src), + })); + tokio::time::timeout(Duration::from_secs(1), async { + loop { + let responder_sockets = stun_responder.sockets(); + let send_attempts = socket.send_attempts(); + let hole_punch_attempts = send_attempts + .iter() + .filter(|attempt| { + matches!(attempt.1, SocketAddr::V4(addr) if addr == dst_v4) + || matches!(attempt.1, SocketAddr::V6(addr) if addr == dst_v6) + }) + .count(); + if responder_sockets + .first() + .is_some_and(|socket| !socket.sent().is_empty()) + && hole_punch_attempts == 3 + { + return; + } + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + assert_eq!( + stun_responder.bind_options(), + vec![ + UdpBindOptions::hole_punch_control().with_local_addr(Some(SocketAddr::V4( + SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0) + ))) + ] + ); + let responder_sockets = stun_responder.sockets(); + assert_eq!(responder_sockets.len(), 1); + assert_eq!( + responder_sockets[0].sent()[0].1, + change_stun_remote_addr, + "ChangeRequest STUN responses should be sent through a fresh socket" + ); + let attempts = socket + .send_attempts() + .into_iter() + .filter(|attempt| { + matches!(attempt.1, SocketAddr::V4(addr) if addr == dst_v4) + || matches!(attempt.1, SocketAddr::V6(addr) if addr == dst_v6) + }) + .collect::>(); + assert_eq!(attempts.len(), 3); + assert!(attempts.iter().all(|attempt| { + hole_punch_packet_tid(&attempt.0, UDP_SESSION_HOLE_PUNCH_PACKET_BODY_LEN) == Some(1) + })); + assert!(attempts.iter().any(|attempt| { + attempt.1 == SocketAddr::V4(dst_v4) && attempt.2 == UdpSocketSendMeta::default() + })); + let preferred_meta = UdpSocketSendMeta { + src_ip: Some(preferred_src.ip.into()), + src_ifindex: Some(preferred_src.ifindex), + }; + let preferred_index = attempts + .iter() + .position(|attempt| attempt.1 == SocketAddr::V6(dst_v6) && attempt.2 == preferred_meta) + .unwrap(); + let fallback_index = attempts + .iter() + .position(|attempt| { + attempt.1 == SocketAddr::V6(dst_v6) && attempt.2 == UdpSocketSendMeta::default() + }) + .unwrap(); + assert!(preferred_index < fallback_index); + assert_eq!(attempts[preferred_index].0, attempts[fallback_index].0); + assert!( + socket + .sent() + .iter() + .any(|(_, destination)| *destination == stun_remote_addr), + "normal STUN responses should use the listener socket" + ); +} + +#[tokio::test] +async fn udp_session_recv_loop_does_not_wait_for_stun_responder() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 12000)); + let stun_remote_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12002)); + let conn_id = 0x1122_3344; + let mut stun = vec![0; UDP_TUNNEL_HEADER_SIZE]; + stun[4..8].copy_from_slice(&[0x21, 0x12, 0xA4, 0x42]); + let socket = Arc::new(AutoSackVirtualUdpSocket::new(local_addr)); + socket.incoming.lock().unwrap().extend([ + (stun, stun_remote_addr), + ( + new_data_packet(conn_id, b"payload") + .unwrap() + .into_bytes() + .to_vec(), + peer_addr, + ), + ]); + socket.incoming_notify.notify_one(); + let sessions = Arc::new(DashMap::new()); + let (session, _shutdown_tx) = create_test_easy_tier_mux_session( + socket.clone(), + UdpSessionKey::new(peer_addr, conn_id), + sessions.clone(), + ); + let pending_connects = Arc::new(DashMap::new()); + let classified_sessions = Arc::new(DashMap::new()); + let classified_accepts = create_classified_udp_session_accepts(); + let (mux_accepted_tx, _mux_accepted_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (control_tx, _control_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let stun_responder = Arc::new(BlockingUdpSessionStunResponder::default()); + let (session_shutdown_tx, _) = watch::channel(false); + let recv_task = tokio::spawn(udp_session_layer_recv_task( + socket, + sessions, + classified_sessions, + classified_accepts, + pending_connects, + mux_accepted_tx, + control_tx, + stun_responder.clone(), + session_shutdown_tx, + )); + + tokio::time::timeout(Duration::from_secs(1), stun_responder.started.notified()) + .await + .unwrap(); + + let mut buf = [0; 16]; + let len = tokio::time::timeout(Duration::from_secs(1), session.recv(&mut buf)) + .await + .unwrap() + .unwrap(); + assert_eq!(&buf[..len], b"payload"); + + stun_responder.release.notify_waiters(); + recv_task.abort(); + let _ = recv_task.await; +} + +#[tokio::test] +async fn local_hole_punch_control_is_dispatched_to_control_queue() { + let remote_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let dst_addr = SocketAddrV4::new(Ipv4Addr::new(192, 0, 2, 10), 1234); + let (control_tx, mut control_rx) = mpsc::channel(1); + let socket = Arc::new(MockVirtualUdpSocket::new(remote_addr, vec![])); + + dispatch_v4_hole_punch_control( + socket, + Arc::new(Semaphore::new(UDP_SESSION_QUEUE_CAPACITY)), + &control_tx, + remote_addr, + &new_v4_hole_punch_packet(&dst_addr), + ); + + assert_eq!( + control_rx.recv().await.unwrap(), + UdpSessionLayerControl::V4HolePunch { + remote_addr, + dst_addr, + } + ); +} + +#[tokio::test] +async fn sack_from_actual_remote_rekeys_pending_session_before_data_dispatch() { + let expected_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let actual_addr = SocketAddr::from(([127, 0, 0, 1], 12002)); + let conn_id = 0x1122_3344; + let magic = 0x0102_0304_0506_0708; + let sessions = DashMap::new(); + let pending_connects = DashMap::new(); + let expected_key = UdpSessionKey::new(expected_addr, conn_id); + let actual_key = UdpSessionKey::new(actual_addr, conn_id); + let session_key = Arc::new(StdMutex::new(None)); + let rings = create_udp_session_rings(); + let entry = udp_session_registry_entry(&rings); + let mut incoming_rx = rings.session_recv_rx; + let (control_tx, _control_rx) = mpsc::channel(1); + let (sack_tx, mut sack_rx) = watch::channel(None); + control_tx + .try_send(UdpConnectControl::HolePunch { + recv_addr: expected_addr, + }) + .unwrap(); + pending_connects.insert( + conn_id, + PendingUdpSessionConnect { + expected_addr, + magic, + session_key: session_key.clone(), + entry, + control: control_tx, + sack: sack_tx, + }, + ); + + assert!( + dispatch_data_packet( + &sessions, + expected_addr, + conn_id, + new_data_packet(conn_id, b"pre-sack").unwrap(), + Default::default(), + ) + .is_err() + ); + dispatch_sack_packet( + &sessions, + &pending_connects, + actual_addr, + conn_id, + &new_sack_packet(conn_id, magic), + ); + assert!( + dispatch_data_packet( + &sessions, + actual_addr, + conn_id, + new_data_packet(conn_id, b"payload").unwrap(), + Default::default(), + ) + .is_ok() + ); + + assert!(sessions.contains_key(&actual_key)); + assert!(!sessions.contains_key(&expected_key)); + assert!(pending_connects.is_empty()); + assert_eq!(*session_key.lock().unwrap(), Some(actual_key)); + sack_rx.changed().await.unwrap(); + assert_eq!(*sack_rx.borrow_and_update(), Some(actual_addr)); + + let payload = futures::StreamExt::next(&mut incoming_rx) + .await + .unwrap() + .unwrap(); + assert_eq!(payload.payload(), b"payload"); +} + +#[tokio::test] +async fn replayed_sack_cannot_rekey_pending_session_after_first_success() { + let expected_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let first_addr = SocketAddr::from(([127, 0, 0, 1], 12002)); + let replay_addr = SocketAddr::from(([127, 0, 0, 1], 12003)); + let conn_id = 0x1122_3344; + let magic = 0x0102_0304_0506_0708; + let sessions = DashMap::new(); + let pending_connects = DashMap::new(); + let expected_key = UdpSessionKey::new(expected_addr, conn_id); + let first_key = UdpSessionKey::new(first_addr, conn_id); + let replay_key = UdpSessionKey::new(replay_addr, conn_id); + let session_key = Arc::new(StdMutex::new(None)); + let rings = create_udp_session_rings(); + let entry = udp_session_registry_entry(&rings); + let (control_tx, _control_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (sack_tx, mut sack_rx) = watch::channel(None); + pending_connects.insert( + conn_id, + PendingUdpSessionConnect { + expected_addr, + magic, + session_key: session_key.clone(), + entry, + control: control_tx, + sack: sack_tx, + }, + ); + + dispatch_sack_packet( + &sessions, + &pending_connects, + first_addr, + conn_id, + &new_sack_packet(conn_id, magic), + ); + dispatch_sack_packet( + &sessions, + &pending_connects, + replay_addr, + conn_id, + &new_sack_packet(conn_id, magic), + ); + + assert!(sessions.contains_key(&first_key)); + assert!(!sessions.contains_key(&expected_key)); + assert!(!sessions.contains_key(&replay_key)); + assert_eq!(*session_key.lock().unwrap(), Some(first_key)); + sack_rx.changed().await.unwrap(); + assert_eq!(*sack_rx.borrow_and_update(), Some(first_addr)); +} + +#[tokio::test] +async fn stale_sack_after_pending_removal_does_not_register_session() { + let expected_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let actual_addr = SocketAddr::from(([127, 0, 0, 1], 12002)); + let conn_id = 0x1122_3344; + let magic = 0x0102_0304_0506_0708; + let sessions = DashMap::new(); + let pending_connects = DashMap::new(); + let rings = create_udp_session_rings(); + let entry = udp_session_registry_entry(&rings); + let (control_tx, _control_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (sack_tx, sack_rx) = watch::channel(None); + pending_connects.insert( + conn_id, + PendingUdpSessionConnect { + expected_addr, + magic, + session_key: Arc::new(StdMutex::new(None)), + entry, + control: control_tx, + sack: sack_tx, + }, + ); + pending_connects.remove(&conn_id); + + dispatch_sack_packet( + &sessions, + &pending_connects, + actual_addr, + conn_id, + &new_sack_packet(conn_id, magic), + ); + + assert!(sessions.is_empty()); + assert_eq!(*sack_rx.borrow(), None); +} + +#[tokio::test] +async fn sack_after_connect_receiver_drop_removes_registered_session() { + let expected_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let actual_addr = SocketAddr::from(([127, 0, 0, 1], 12002)); + let conn_id = 0x1122_3344; + let magic = 0x0102_0304_0506_0708; + let sessions = DashMap::new(); + let pending_connects = DashMap::new(); + let rings = create_udp_session_rings(); + let entry = udp_session_registry_entry(&rings); + let (control_tx, _control_rx) = mpsc::channel(UDP_SESSION_QUEUE_CAPACITY); + let (sack_tx, sack_rx) = watch::channel(None); + drop(sack_rx); + pending_connects.insert( + conn_id, + PendingUdpSessionConnect { + expected_addr, + magic, + session_key: Arc::new(StdMutex::new(None)), + entry, + control: control_tx, + sack: sack_tx, + }, + ); + + dispatch_sack_packet( + &sessions, + &pending_connects, + actual_addr, + conn_id, + &new_sack_packet(conn_id, magic), + ); + + assert!(sessions.is_empty()); +} + +type MockIncomingDatagrams = VecDeque, SocketAddr)>>; + +struct MockVirtualUdpSocketFactory { + next_port: AtomicU16, + bind_options: Mutex>, + sockets: Mutex>>, + incoming: Mutex, +} + +impl MockVirtualUdpSocketFactory { + fn new(next_port: u16) -> Self { + Self { + next_port: AtomicU16::new(next_port), + bind_options: Mutex::new(Vec::new()), + sockets: Mutex::new(Vec::new()), + incoming: Mutex::new(VecDeque::new()), + } + } + + fn with_socket_incoming(next_port: u16, incoming: Vec<(Vec, SocketAddr)>) -> Self { + let factory = Self::new(next_port); + factory.incoming.lock().unwrap().push_back(incoming); + factory + } + + fn bind_options(&self) -> Vec { + self.bind_options.lock().unwrap().clone() + } + + fn sockets(&self) -> Vec> { + self.sockets.lock().unwrap().clone() + } +} + +#[async_trait] +impl VirtualUdpSocketFactory for MockVirtualUdpSocketFactory { + type Socket = MockVirtualUdpSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + self.bind_options.lock().unwrap().push(options.clone()); + let local_addr = options.local_addr.unwrap_or_else(|| { + SocketAddr::from(( + [127, 0, 0, 1], + self.next_port.fetch_add(1, Ordering::Relaxed), + )) + }); + let incoming = self + .incoming + .lock() + .unwrap() + .pop_front() + .unwrap_or_default(); + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, incoming)); + self.sockets.lock().unwrap().push(socket.clone()); + Ok(socket) + } +} + +#[tokio::test] +async fn udp_session_dialer_binds_socket_and_returns_wireguard_session() { + let factory = Arc::new(MockVirtualUdpSocketFactory::new(13000)); + let mut dialer = UdpSessionDialer::new(factory.clone()); + let remote_addr = SocketAddr::from(([192, 0, 2, 10], 11010)); + let bind_addr = SocketAddr::from(([127, 0, 0, 1], 14000)); + let request = UdpSessionConnectRequest::wireguard(remote_addr) + .with_bind(UdpBindOptions::port_bound_listener(bind_addr)); + let expected_bind = request.bind.clone(); + + let session = dialer.connect(request).await.unwrap(); + + assert_eq!(factory.bind_options(), vec![expected_bind]); + assert_eq!(session.kind(), UdpSessionKind::WireGuard); + assert_eq!(session.local_addr().unwrap(), bind_addr); + assert_eq!(session.peer_addr().unwrap(), remote_addr); +} + +#[tokio::test] +async fn udp_session_socket_listener_builds_port_bound_bind_options() { + let factory = Arc::new(MockVirtualUdpSocketFactory::new(13000)); + let local_addr = SocketAddr::from(([0, 0, 0, 0], 11010)); + let mut listener = UdpSessionSocketListener::new( + "udp://0.0.0.0:0".parse().unwrap(), + local_addr, + factory.clone(), + ); + + listener.listen().await.unwrap(); + + assert_eq!( + factory.bind_options(), + vec![UdpBindOptions::port_bound_listener(local_addr).with_only_v6(true)] + ); + assert_eq!(listener.local_url().port(), Some(11010)); + assert_eq!(listener.connection_counter().get(), Some(0)); + assert!(Arc::ptr_eq( + &listener.bound_socket().unwrap(), + &factory.sockets()[0] + )); +} + +#[tokio::test] +async fn udp_session_socket_listener_accepts_easy_tier_mux_session() { + let local_addr = SocketAddr::from(([127, 0, 0, 1], 11010)); + let peer_addr = SocketAddr::from(([127, 0, 0, 1], 12010)); + let factory = Arc::new(MockVirtualUdpSocketFactory::with_socket_incoming( + 13000, + vec![( + new_syn_packet(0x1122_3344, 0x5566_7788) + .into_bytes() + .to_vec(), + peer_addr, + )], + )); + let mut listener = + UdpSessionSocketListener::new("udp://127.0.0.1:0".parse().unwrap(), local_addr, factory); + + listener.listen().await.unwrap(); + let session = tokio::time::timeout(Duration::from_secs(1), listener.accept_session()) + .await + .unwrap() + .unwrap(); + + assert_eq!(session.kind(), UdpSessionKind::EasyTierMux); + assert_eq!(session.local_addr().unwrap(), local_addr); + assert_eq!(session.peer_addr().unwrap(), peer_addr); +} + +#[tokio::test] +async fn udp_session_dialer_uses_factory_as_stun_responder() { + let remote_addr = SocketAddr::from(([192, 0, 2, 10], 11010)); + let stun_remote_addr = SocketAddr::from(([127, 0, 0, 1], 12001)); + let request = UdpSessionConnectRequest::wireguard(remote_addr); + let expected_session_bind = request.bind.clone(); + let factory = Arc::new(MockVirtualUdpSocketFactory::with_socket_incoming( + 13000, + vec![(easytier_stun_request(true, false), stun_remote_addr)], + )); + let mut dialer = UdpSessionDialer::new(factory.clone()); + + let _session = dialer.connect(request).await.unwrap(); + + tokio::time::timeout(Duration::from_secs(1), async { + loop { + let sockets = factory.sockets(); + if sockets.len() == 2 && !sockets[1].sent().is_empty() { + return; + } + tokio::task::yield_now().await; + } + }) + .await + .unwrap(); + assert_eq!( + factory.bind_options(), + vec![ + expected_session_bind, + UdpBindOptions::hole_punch_control().with_local_addr(Some(SocketAddr::V4( + SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0) + ))) + ] + ); + let sockets = factory.sockets(); + assert_eq!(sockets[1].sent()[0].1, stun_remote_addr); +} + +#[tokio::test] +async fn v4_hole_punch_control_sender_uses_factory_socket() { + let factory = MockVirtualUdpSocketFactory::new(13000); + let dst_addr = SocketAddrV4::new(Ipv4Addr::new(192, 0, 2, 1), 11010); + let context = SocketContext::default() + .with_socket_mark(Some(0)) + .with_netns(Some(NetNamespace::new("instance-a"))); + + send_v4_hole_punch_control_packet(&factory, context.clone(), 22020, dst_addr) + .await + .unwrap(); + + assert_eq!( + factory.bind_options(), + vec![ + UdpBindOptions::hole_punch_control() + .with_need_protect(false) + .with_context(context.with_ip_version(IpVersion::V4)) + .with_local_addr(Some(SocketAddr::V4(SocketAddrV4::new( + Ipv4Addr::LOCALHOST, + 0 + )))) + ] + ); + let sockets = factory.sockets(); + assert_eq!(sockets.len(), 1); + assert_eq!( + sockets[0].sent(), + vec![( + new_v4_hole_punch_packet(&dst_addr).into_bytes().to_vec(), + SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, 22020)) + )] + ); +} + +#[tokio::test] +async fn v6_hole_punch_control_sender_uses_factory_socket() { + let factory = MockVirtualUdpSocketFactory::new(13000); + let dst_addr = "[2001:db8::1]:11010".parse::().unwrap(); + let preferred_src = PreferredIpv6Source { + ip: "2001:db8::2".parse().unwrap(), + ifindex: 42, + }; + let context = SocketContext::default() + .with_socket_mark(Some(0)) + .with_netns(Some(NetNamespace::new("instance-a"))); + + send_v6_hole_punch_control_packet( + &factory, + context.clone(), + 22020, + dst_addr, + Some(preferred_src), + ) + .await + .unwrap(); + + assert_eq!( + factory.bind_options(), + vec![ + UdpBindOptions::hole_punch_control() + .with_need_protect(false) + .with_context(context.with_ip_version(IpVersion::V6)) + .with_local_addr(Some(SocketAddr::V6(SocketAddrV6::new( + Ipv6Addr::LOCALHOST, + 0, + 0, + 0 + )))) + ] + ); + let sockets = factory.sockets(); + assert_eq!(sockets.len(), 1); + assert_eq!( + sockets[0].sent(), + vec![( + new_v6_hole_punch_packet(&dst_addr, Some(preferred_src)) + .into_bytes() + .to_vec(), + SocketAddr::V6(SocketAddrV6::new(Ipv6Addr::LOCALHOST, 22020, 0, 0)) + )] + ); +} + +#[test] +fn builds_syn_and_sack_packets_without_changing_wire_shape() { + let conn_id = 0x1234_5678; + let magic = 0x0102_0304_0506_0708; + + for (packet, msg_type) in [ + (new_syn_packet(conn_id, magic), UdpPacketType::Syn as u8), + (new_sack_packet(conn_id, magic), UdpPacketType::Sack as u8), + ] { + let header = packet.udp_tunnel_header().unwrap(); + assert_eq!(header.conn_id.get(), conn_id); + assert_eq!(header.msg_type, msg_type); + assert_eq!(header.len.get(), 8); + assert_eq!(packet.udp_payload(), magic.to_le_bytes()); + } +} + +#[test] +fn v6_hole_punch_packet_preserves_preferred_source() { + let dst_addr = "[2001:db8::1]:10001".parse::().unwrap(); + let preferred_src = PreferredIpv6Source { + ip: "2001:db8::2".parse().unwrap(), + ifindex: 42, + }; + + let packet = new_v6_hole_punch_packet(&dst_addr, Some(preferred_src)); + let (parsed_dst_addr, parsed_preferred_src) = + extract_v6_hole_punch_packet(packet.udp_payload()).unwrap(); + + assert_eq!(parsed_dst_addr, dst_addr); + assert_eq!(parsed_preferred_src, Some(preferred_src)); +} + +#[test] +fn parses_udp_session_datagram_and_rejects_bad_payload_len() { + let packet = new_syn_packet(7, 42).into_bytes(); + let parsed = parse_udp_session_datagram(packet.clone().into(), false).unwrap(); + assert_eq!(parsed.udp_tunnel_header().unwrap().conn_id.get(), 7); + + let mut bad_packet = packet.to_vec(); + bad_packet.pop(); + + assert!(matches!( + parse_udp_session_datagram(BytesMut::from(bad_packet.as_slice()), false), + Err(UdpSessionPacketError::PayloadLenMismatch { .. }) + )); +} + +#[test] +fn inspects_easytier_udp_datagram_without_owning_buffer() { + let packet = new_syn_packet(7, 42).into_bytes(); + let info = inspect_easytier_udp_datagram(&packet).unwrap().unwrap(); + + assert_eq!(info.kind, EasyTierUdpPacketKind::Syn); + assert_eq!(info.conn_id, 7); + + let unknown_packet = new_udp_packet( + |header| { + header.conn_id.set(9); + header.msg_type = 0xff; + header.len.set(0); + }, + &[], + ) + .into_bytes(); + assert_eq!( + inspect_easytier_udp_datagram(&unknown_packet).unwrap(), + None + ); + + let mut bad_packet = packet.to_vec(); + bad_packet.pop(); + + assert!(matches!( + inspect_easytier_udp_datagram(&bad_packet), + Err(EasyTierUdpDatagramInspectError::PayloadLenMismatch { .. }) + )); +} + +#[test] +fn stun_classifier_requires_cookie_and_stun_bits() { + let mut stun = [0; UDP_TUNNEL_HEADER_SIZE]; + stun[4..8].copy_from_slice(&[0x21, 0x12, 0xA4, 0x42]); + + assert!(is_stun_packet(&stun)); + + stun[0] = 0xC0; + assert!(!is_stun_packet(&stun)); + assert!(!is_stun_packet(&stun[..UDP_TUNNEL_HEADER_SIZE - 1])); +} diff --git a/vendor/easytier/easytier-core/src/socket/udp/virtual_socket.rs b/vendor/easytier/easytier-core/src/socket/udp/virtual_socket.rs new file mode 100644 index 0000000..ccea4ca --- /dev/null +++ b/vendor/easytier/easytier-core/src/socket/udp/virtual_socket.rs @@ -0,0 +1,374 @@ +use std::{ + io, + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6}, + sync::Arc, +}; + +use async_trait::async_trait; +use bytes::BytesMut; +use serde::{Deserialize, Serialize}; + +use crate::socket::{IpVersion, SocketContext}; + +use super::packet::{new_v4_hole_punch_packet, new_v6_hole_punch_packet}; + +#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)] +pub struct UdpSocketRecvMeta { + pub dst_ip: Option, +} + +#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)] +pub struct UdpSocketSendMeta { + pub src_ip: Option, + pub src_ifindex: Option, +} + +/// Largest UDP datagram that portable socket implementations must receive. +pub const MAX_UDP_DATAGRAM_SIZE: usize = u16::MAX as usize; + +/// Largest datagram accepted by the UDP session/multiplexer data plane. +/// +/// EasyTier, WireGuard, and QUIC datagrams are bounded by their transport MTU. +/// Keeping this capacity explicit avoids allocating the theoretical UDP maximum +/// for every packet on native hosts that can detect truncation. +pub const MAX_UDP_SESSION_DATAGRAM_SIZE: usize = 8 * 1024; + +#[derive(Debug)] +pub struct UdpSocketDatagram { + pub payload: BytesMut, + pub remote_addr: SocketAddr, + pub meta: UdpSocketRecvMeta, +} + +#[async_trait] +pub trait VirtualUdpSocket: Send + Sync + 'static { + fn local_addr(&self) -> std::io::Result; + + fn socket_context(&self) -> SocketContext { + SocketContext::default() + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> std::io::Result; + + async fn recv_from(&self, buf: &mut [u8]) -> std::io::Result<(usize, SocketAddr)>; + + async fn send_to_with_meta( + &self, + data: &[u8], + addr: SocketAddr, + meta: UdpSocketSendMeta, + ) -> std::io::Result { + let _ = meta; + self.send_to(data, addr).await + } + + async fn recv_from_with_meta( + &self, + buf: &mut [u8], + ) -> std::io::Result<(usize, SocketAddr, UdpSocketRecvMeta)> { + let (len, addr) = self.recv_from(buf).await?; + Ok((len, addr, UdpSocketRecvMeta::default())) + } + + /// Receives one datagram into an owned buffer. + /// + /// Portable hosts can use this default implementation. Native hosts should + /// override it when their socket API can write directly into owned storage, + /// avoiding a second allocation and copy at the Host boundary. + async fn recv_datagram(&self) -> std::io::Result { + recv_portable_datagram(self, MAX_UDP_DATAGRAM_SIZE).await + } + + /// Receives one datagram for the UDP session/multiplexer data plane. + /// + /// Portable hosts receive one byte past the session limit so a truncated + /// oversized datagram remains distinguishable from a valid maximum-sized + /// datagram. Native hosts may override this when they can detect truncation + /// without the extra byte. + async fn recv_session_datagram(&self) -> std::io::Result { + recv_portable_datagram(self, MAX_UDP_SESSION_DATAGRAM_SIZE + 1).await + } +} + +async fn recv_portable_datagram( + socket: &S, + capacity: usize, +) -> std::io::Result +where + S: VirtualUdpSocket + ?Sized, +{ + let mut payload = BytesMut::new(); + payload.resize(capacity, 0); + let (len, remote_addr, meta) = socket.recv_from_with_meta(&mut payload).await?; + payload.truncate(len); + Ok(UdpSocketDatagram { + payload, + remote_addr, + meta, + }) +} + +#[async_trait] +pub trait UdpSessionStunResponder: Send + Sync + 'static +where + S: VirtualUdpSocket, +{ + async fn respond_stun( + &self, + _socket: Arc, + _datagram: &[u8], + _remote_addr: SocketAddr, + ) -> io::Result<()> { + Ok(()) + } +} + +#[derive(Debug, Default)] +pub struct NoopUdpSessionStunResponder; + +#[async_trait] +impl UdpSessionStunResponder for NoopUdpSessionStunResponder where S: VirtualUdpSocket {} + +pub async fn send_v4_hole_punch_control_packet( + factory: &F, + context: SocketContext, + listener_port: u16, + dst_addr: SocketAddrV4, +) -> anyhow::Result<()> +where + F: VirtualUdpSocketFactory, +{ + let socket = factory + .bind_udp( + UdpBindOptions::hole_punch_control() + .with_need_protect(false) + .with_context(context.with_ip_version(IpVersion::V4)) + .with_local_addr(Some(SocketAddr::V4(SocketAddrV4::new( + Ipv4Addr::LOCALHOST, + 0, + )))), + ) + .await?; + let packet = new_v4_hole_punch_packet(&dst_addr).into_bytes(); + let listener_addr = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::LOCALHOST, listener_port)); + socket.send_to(&packet, listener_addr).await?; + Ok(()) +} + +pub async fn send_v6_hole_punch_control_packet( + factory: &F, + context: SocketContext, + listener_port: u16, + dst_addr: SocketAddrV6, + preferred_src: Option, +) -> anyhow::Result<()> +where + F: VirtualUdpSocketFactory, +{ + let socket = factory + .bind_udp( + UdpBindOptions::hole_punch_control() + .with_need_protect(false) + .with_context(context.with_ip_version(IpVersion::V6)) + .with_local_addr(Some(SocketAddr::V6(SocketAddrV6::new( + Ipv6Addr::LOCALHOST, + 0, + 0, + 0, + )))), + ) + .await?; + let packet = new_v6_hole_punch_packet(&dst_addr, preferred_src).into_bytes(); + let listener_addr = SocketAddr::V6(SocketAddrV6::new(Ipv6Addr::LOCALHOST, listener_port, 0, 0)); + socket.send_to(&packet, listener_addr).await?; + Ok(()) +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +pub enum UdpSocketPurpose { + HolePunchControl, + HolePunchCandidate, + DirectConnect, + PortBoundListener, + ProxyNat, + StunProbe, + Socks5, + PortForward, + PortLease, +} + +#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)] +pub struct UdpBindOptions { + #[serde(default)] + pub context: SocketContext, + /// Request host VPN bypass before bind or datagram I/O. Protection must be + /// acknowledged inside creation, not emitted as a fire-and-forget event. + /// Defaults to true; local/TUN-facing endpoints explicitly opt out. + #[serde(default = "crate::socket::default_need_protect")] + pub need_protect: bool, + pub local_addr: Option, + pub bind_device: Option, + pub reuse_addr: bool, + pub reuse_port: bool, + pub only_v6: bool, + pub purpose: UdpSocketPurpose, +} + +impl UdpBindOptions { + fn for_purpose(purpose: UdpSocketPurpose) -> Self { + Self { + context: SocketContext::default(), + need_protect: crate::socket::default_need_protect(), + local_addr: None, + bind_device: None, + reuse_addr: false, + reuse_port: false, + only_v6: false, + purpose, + } + } + + pub fn hole_punch_control() -> Self { + Self::for_purpose(UdpSocketPurpose::HolePunchControl) + } + + pub fn hole_punch_candidate() -> Self { + Self::for_purpose(UdpSocketPurpose::HolePunchCandidate) + } + + pub fn direct_connect() -> Self { + Self::for_purpose(UdpSocketPurpose::DirectConnect) + } + + pub fn port_bound_listener(local_addr: SocketAddr) -> Self { + Self { + local_addr: Some(local_addr), + ..Self::for_purpose(UdpSocketPurpose::PortBoundListener) + } + } + + pub fn proxy_nat() -> Self { + Self::for_purpose(UdpSocketPurpose::ProxyNat) + } + + pub fn stun_probe() -> Self { + Self::for_purpose(UdpSocketPurpose::StunProbe) + } + + pub fn socks5() -> Self { + Self::for_purpose(UdpSocketPurpose::Socks5) + } + + pub fn port_forward(local_addr: SocketAddr) -> Self { + Self::for_purpose(UdpSocketPurpose::PortForward) + .with_need_protect(false) + .with_local_addr(Some(local_addr)) + } + + pub fn port_lease(local_addr: SocketAddr) -> Self { + Self::for_purpose(UdpSocketPurpose::PortLease) + .with_need_protect(false) + .with_local_addr(Some(local_addr)) + } + + pub fn with_local_addr(mut self, local_addr: Option) -> Self { + self.local_addr = local_addr; + self + } + + pub fn with_socket_mark(mut self, socket_mark: Option) -> Self { + self.context.socket_mark = socket_mark; + self + } + + pub fn with_context(mut self, context: SocketContext) -> Self { + self.context = context; + self + } + + pub fn with_need_protect(mut self, need_protect: bool) -> Self { + self.need_protect = need_protect; + self + } + + pub fn with_ip_version(mut self, ip_version: IpVersion) -> Self { + self.context.ip_version = ip_version; + self + } + + pub fn with_bind_device(mut self, bind_device: Option) -> Self { + self.bind_device = bind_device; + self + } + + pub fn with_reuse_addr(mut self, reuse_addr: bool) -> Self { + self.reuse_addr = reuse_addr; + self + } + + pub fn with_reuse_port(mut self, reuse_port: bool) -> Self { + self.reuse_port = reuse_port; + self + } + + pub fn with_only_v6(mut self, only_v6: bool) -> Self { + self.only_v6 = only_v6; + self + } +} + +impl Default for UdpBindOptions { + fn default() -> Self { + // Preserve the existing default purpose/socket setup; local-only + // control packets opt out explicitly at their loopback call sites. + Self::for_purpose(UdpSocketPurpose::HolePunchControl) + } +} + +#[cfg(test)] +mod option_tests { + use super::*; + + #[test] + fn udp_constructor_protection_defaults_match_endpoint_role() { + let local = SocketAddr::from(([0, 0, 0, 0], 11010)); + + assert!(UdpBindOptions::default().need_protect); + assert!(UdpBindOptions::hole_punch_control().need_protect); + assert!(UdpBindOptions::hole_punch_candidate().need_protect); + assert!(UdpBindOptions::direct_connect().need_protect); + assert!(UdpBindOptions::port_bound_listener(local).need_protect); + assert!(UdpBindOptions::proxy_nat().need_protect); + assert!(UdpBindOptions::stun_probe().need_protect); + assert!(UdpBindOptions::socks5().need_protect); + assert!(!UdpBindOptions::port_forward(local).need_protect); + assert!(!UdpBindOptions::port_lease(local).need_protect); + } + + #[test] + fn udp_bind_serde_defaults_to_protected_and_preserves_opt_out() { + let options: UdpBindOptions = serde_json::from_str( + r#"{"local_addr":null,"bind_device":null,"reuse_addr":false,"reuse_port":false,"only_v6":false,"purpose":"DirectConnect"}"#, + ) + .unwrap(); + assert!(options.need_protect); + let local = UdpBindOptions::port_forward("0.0.0.0:15555".parse().unwrap()); + let restored: UdpBindOptions = + serde_json::from_str(&serde_json::to_string(&local).unwrap()).unwrap(); + assert_eq!(restored, local); + assert!(!restored.need_protect); + } +} + +#[async_trait] +pub trait VirtualUdpSocketFactory: Send + Sync + 'static { + type Socket: VirtualUdpSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result>; +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)] +pub struct PreferredIpv6Source { + pub ip: Ipv6Addr, + pub ifindex: u32, +} diff --git a/vendor/easytier/easytier-core/src/tunnel/buf.rs b/vendor/easytier/easytier-core/src/tunnel/buf.rs new file mode 100644 index 0000000..f6b3b85 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/buf.rs @@ -0,0 +1,156 @@ +use std::collections::VecDeque; +use std::io::IoSlice; + +use bytes::{Buf, BufMut, Bytes, BytesMut}; + +#[derive(Debug, Default)] +pub struct BufList { + bufs: VecDeque, +} + +impl BufList { + pub fn new() -> BufList { + BufList { + bufs: VecDeque::new(), + } + } + + #[inline(always)] + pub fn push(&mut self, buf: T) { + if buf.has_remaining() { + self.bufs.push_back(buf); + } + } + + #[inline(always)] + pub fn pop(&mut self) -> Option { + self.bufs.pop_front() + } + + #[inline(always)] + pub fn len(&self) -> usize { + self.bufs.len() + } + + #[inline(always)] + pub fn is_empty(&self) -> bool { + self.bufs.is_empty() + } +} + +impl Extend for BufList { + fn extend>(&mut self, iter: I) { + self.bufs + .extend(iter.into_iter().filter(Buf::has_remaining)); + } +} + +impl Buf for BufList { + #[inline] + fn remaining(&self) -> usize { + self.bufs.iter().map(Buf::remaining).sum() + } + + #[inline] + fn chunk(&self) -> &[u8] { + self.bufs.front().map(Buf::chunk).unwrap_or_default() + } + + #[inline] + fn chunks_vectored<'t>(&'t self, dst: &mut [IoSlice<'t>]) -> usize { + let mut vecs = 0; + + for buf in &self.bufs { + let n = buf.chunks_vectored(&mut dst[vecs..]); + vecs += n; + + if dst[vecs - n..vecs].iter().map(|s| s.len()).sum::() < buf.remaining() { + break; + } + } + + vecs + } + + #[inline] + fn advance(&mut self, mut cnt: usize) { + while cnt > 0 { + let front = &mut self.bufs[0]; + let rem = front.remaining(); + front.advance(cnt.min(rem)); + if rem > cnt { + return; + } + cnt -= rem; + self.bufs.pop_front(); + } + } + + #[inline] + fn copy_to_bytes(&mut self, len: usize) -> Bytes { + // Our inner buffer may have an optimized version of copy_to_bytes, and if the whole + // request can be fulfilled by the front buffer, we can take advantage. + if let Some(front) = self.bufs.front_mut() + && let rem = front.remaining() + && len <= rem + { + let bytes = front.copy_to_bytes(len); + if len == rem { + self.bufs.pop_front(); + } + return bytes; + } + + assert!(len <= self.remaining()); + let mut bytes = BytesMut::with_capacity(len); + bytes.put(self.take(len)); + bytes.freeze() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_buf_list() { + let mut list = BufList::new(); + list.push(Bytes::from_static(b"hello ")); + list.push(Bytes::from_static(b"world")); + assert_eq!(list.remaining(), 11); + let bytes = list.copy_to_bytes(11); + assert_eq!(&bytes[..], b"hello world"); + assert_eq!(list.remaining(), 0); + } + + #[test] + fn test_chunks_vectored_partial_inner_buf() { + #[derive(Debug)] + struct PartialBuf(&'static [u8]); + + impl Buf for PartialBuf { + fn remaining(&self) -> usize { + self.0.len() + } + + fn chunk(&self) -> &[u8] { + &self.0[..self.0.len().min(1)] + } + + fn advance(&mut self, cnt: usize) { + self.0 = &self.0[cnt..]; + } + } + + let mut list = BufList::new(); + list.push(PartialBuf(b"ab")); + list.push(PartialBuf(b"c")); + + let mut dst = [IoSlice::new(&[]); 3]; + + let n = list.chunks_vectored(&mut dst); + + assert_eq!(n, 1); + assert_eq!(&*dst[0], b"a"); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/encrypt/aes_gcm.rs b/vendor/easytier/easytier-core/src/tunnel/encrypt/aes_gcm.rs new file mode 100644 index 0000000..bf914ac --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/encrypt/aes_gcm.rs @@ -0,0 +1,196 @@ +use aes_gcm::{AeadInPlace, Aes128Gcm, Aes256Gcm, Key, KeyInit}; +use rand::{RngCore, rngs::OsRng}; +use zerocopy::{AsBytes, FromBytes}; + +use crate::packet::{StandardAeadTail, ZCPacket}; + +use super::{Encryptor, Error}; + +#[derive(Clone)] +pub struct AesGcmCipher { + pub(crate) cipher: AesGcmEnum, +} + +#[derive(Clone)] +pub enum AesGcmEnum { + AES128GCM(Box), + AES256GCM(Box), +} + +impl AesGcmCipher { + pub fn new_128(key: [u8; 16]) -> Self { + let key: &Key = &key.into(); + Self { + cipher: AesGcmEnum::AES128GCM(Box::new(Aes128Gcm::new(key))), + } + } + pub fn new_256(key: [u8; 32]) -> Self { + let key: &Key = &key.into(); + Self { + cipher: AesGcmEnum::AES256GCM(Box::new(Aes256Gcm::new(key))), + } + } +} + +impl Encryptor for AesGcmCipher { + fn decrypt(&self, zc_packet: &mut ZCPacket) -> Result<(), Error> { + let pm_header = zc_packet.peer_manager_header().unwrap(); + if !pm_header.is_encrypted() { + return Ok(()); + } + + let payload_len = zc_packet.payload().len(); + if payload_len < StandardAeadTail::SIZE { + return Err(Error::PacketTooShort(zc_packet.payload().len())); + } + + let text_len = payload_len - StandardAeadTail::SIZE; + + let aes_tail = StandardAeadTail::ref_from_suffix(zc_packet.payload()) + .unwrap() + .clone(); + + let nonce = aes_tail.nonce.into(); + let tag = aes_tail.tag.into(); + + let rs = match &self.cipher { + AesGcmEnum::AES128GCM(aes_gcm) => aes_gcm.decrypt_in_place_detached( + &nonce, + &[], + &mut zc_packet.mut_payload()[..text_len], + &tag, + ), + AesGcmEnum::AES256GCM(aes_gcm) => aes_gcm.decrypt_in_place_detached( + &nonce, + &[], + &mut zc_packet.mut_payload()[..text_len], + &tag, + ), + }; + + if let Err(e) = rs { + println!("error: {:?}", e.to_string()); + return Err(Error::DecryptionFailed); + } + + let pm_header = zc_packet.mut_peer_manager_header().unwrap(); + pm_header.set_encrypted(false); + let old_len = zc_packet.buf_len(); + zc_packet + .mut_inner() + .truncate(old_len - StandardAeadTail::SIZE); + Ok(()) + } + + fn encrypt(&self, zc_packet: &mut ZCPacket) -> Result<(), Error> { + self.encrypt_with_nonce(zc_packet, None) + } + + fn encrypt_with_nonce( + &self, + zc_packet: &mut ZCPacket, + nonce: Option<&[u8]>, + ) -> Result<(), Error> { + let pm_header = zc_packet.peer_manager_header().unwrap(); + if pm_header.is_encrypted() { + tracing::warn!(?zc_packet, "packet is already encrypted"); + return Ok(()); + } + + let nonce = nonce + .map(|n| { + <[u8; StandardAeadTail::NONCE_SIZE]>::try_from(n) + .map(Into::into) + .map_err(|_| Error::EncryptionFailed) + }) + .transpose()?; + + let (tag, nonce) = match &self.cipher { + AesGcmEnum::AES128GCM(aes_gcm) => { + let nonce = nonce.unwrap_or_else(|| { + let mut nonce = [0u8; StandardAeadTail::NONCE_SIZE]; + OsRng.fill_bytes(&mut nonce); + nonce.into() + }); + ( + aes_gcm.encrypt_in_place_detached(&nonce, &[], zc_packet.mut_payload()), + nonce, + ) + } + AesGcmEnum::AES256GCM(aes_gcm) => { + let nonce = nonce.unwrap_or_else(|| { + let mut nonce = [0u8; StandardAeadTail::NONCE_SIZE]; + OsRng.fill_bytes(&mut nonce); + nonce.into() + }); + ( + aes_gcm.encrypt_in_place_detached(&nonce, &[], zc_packet.mut_payload()), + nonce, + ) + } + }; + + let tail = StandardAeadTail { + tag: tag.map_err(|_| Error::EncryptionFailed)?.into(), + nonce: nonce.into(), + }; + + let pm_header = zc_packet.mut_peer_manager_header().unwrap(); + pm_header.set_encrypted(true); + zc_packet.mut_inner().extend_from_slice(tail.as_bytes()); + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use crate::{ + packet::{StandardAeadTail, ZCPacket}, + tunnel::encrypt::{Encryptor, aes_gcm::AesGcmCipher}, + }; + use zerocopy::FromBytes; + + #[test] + fn test_aes_gcm_cipher() { + let key = [0u8; 16]; + let cipher = AesGcmCipher::new_128(key); + let text = b"1234567"; + let mut packet = ZCPacket::new_with_payload(text); + packet.fill_peer_manager_hdr(0, 0, 0); + cipher.encrypt(&mut packet).unwrap(); + assert_eq!(packet.payload().len(), text.len() + StandardAeadTail::SIZE); + assert!(packet.peer_manager_header().unwrap().is_encrypted()); + + cipher.decrypt(&mut packet).unwrap(); + assert_eq!(packet.payload(), text); + assert!(!packet.peer_manager_header().unwrap().is_encrypted()); + } + + #[test] + fn test_aes_gcm_cipher_with_nonce() { + let key = [7u8; 16]; + let cipher = AesGcmCipher::new_128(key); + let text = b"Hello"; + let nonce = [3u8; 12]; + + let mut packet1 = ZCPacket::new_with_payload(text); + packet1.fill_peer_manager_hdr(0, 0, 0); + cipher + .encrypt_with_nonce(&mut packet1, Some(&nonce)) + .unwrap(); + + let mut packet2 = ZCPacket::new_with_payload(text); + packet2.fill_peer_manager_hdr(0, 0, 0); + cipher + .encrypt_with_nonce(&mut packet2, Some(&nonce)) + .unwrap(); + + assert_eq!(packet1.payload(), packet2.payload()); + + let tail = StandardAeadTail::ref_from_suffix(packet1.payload()).unwrap(); + assert_eq!(tail.nonce, nonce); + + cipher.decrypt(&mut packet1).unwrap(); + assert_eq!(packet1.payload(), text); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/encrypt/chacha20.rs b/vendor/easytier/easytier-core/src/tunnel/encrypt/chacha20.rs new file mode 100644 index 0000000..6c50e71 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/encrypt/chacha20.rs @@ -0,0 +1,154 @@ +use chacha20poly1305::{AeadInPlace, ChaCha20Poly1305, Key, KeyInit}; +use rand::{RngCore, rngs::OsRng}; +use zerocopy::{AsBytes, FromBytes}; + +use crate::packet::{StandardAeadTail, ZCPacket}; + +use super::{Encryptor, Error}; + +#[derive(Clone)] +pub struct ChaCha20Cipher { + cipher: Box, +} + +impl ChaCha20Cipher { + pub fn new(key: [u8; 32]) -> Self { + let key: &Key = &key.into(); + Self { + cipher: Box::new(ChaCha20Poly1305::new(key)), + } + } +} + +impl Encryptor for ChaCha20Cipher { + fn decrypt(&self, zc_packet: &mut ZCPacket) -> Result<(), Error> { + let pm_header = zc_packet.peer_manager_header().unwrap(); + if !pm_header.is_encrypted() { + return Ok(()); + } + + let payload_len = zc_packet.payload().len(); + if payload_len < StandardAeadTail::SIZE { + return Err(Error::PacketTooShort(zc_packet.payload().len())); + } + + let text_len = payload_len - StandardAeadTail::SIZE; + + let tail = StandardAeadTail::ref_from_suffix(zc_packet.payload()) + .unwrap() + .clone(); + + let nonce = tail.nonce.into(); + let tag = tail.tag.into(); + + self.cipher + .decrypt_in_place_detached(&nonce, &[], &mut zc_packet.mut_payload()[..text_len], &tag) + .map_err(|_| Error::DecryptionFailed)?; + + let pm_header = zc_packet.mut_peer_manager_header().unwrap(); + pm_header.set_encrypted(false); + let old_len = zc_packet.buf_len(); + zc_packet + .mut_inner() + .truncate(old_len - StandardAeadTail::SIZE); + Ok(()) + } + + fn encrypt(&self, zc_packet: &mut ZCPacket) -> Result<(), Error> { + self.encrypt_with_nonce(zc_packet, None) + } + + fn encrypt_with_nonce( + &self, + zc_packet: &mut ZCPacket, + nonce: Option<&[u8]>, + ) -> Result<(), Error> { + let pm_header = zc_packet.peer_manager_header().unwrap(); + if pm_header.is_encrypted() { + tracing::warn!(?zc_packet, "packet is already encrypted"); + return Ok(()); + } + + let nonce = nonce + .map(|n| { + <[u8; StandardAeadTail::NONCE_SIZE]>::try_from(n) + .map(Into::into) + .map_err(|_| Error::EncryptionFailed) + }) + .transpose()? + .unwrap_or_else(|| { + let mut nonce = [0u8; StandardAeadTail::NONCE_SIZE]; + OsRng.fill_bytes(&mut nonce); + nonce.into() + }); + + let tag = self + .cipher + .encrypt_in_place_detached(&nonce, &[], zc_packet.mut_payload()) + .map_err(|_| Error::EncryptionFailed)?; + + let tail = StandardAeadTail { + tag: tag.into(), + nonce: nonce.into(), + }; + + let pm_header = zc_packet.mut_peer_manager_header().unwrap(); + pm_header.set_encrypted(true); + zc_packet.mut_inner().extend_from_slice(tail.as_bytes()); + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use crate::{ + packet::{StandardAeadTail, ZCPacket}, + tunnel::encrypt::{Encryptor, chacha20::ChaCha20Cipher}, + }; + use zerocopy::FromBytes; + + #[test] + fn test_chacha20_cipher() { + let key = [7u8; 32]; + let cipher = ChaCha20Cipher::new(key); + let text = b"Hello, ChaCha20"; + let mut packet = ZCPacket::new_with_payload(text); + packet.fill_peer_manager_hdr(0, 0, 0); + + cipher.encrypt(&mut packet).unwrap(); + assert_eq!(packet.payload().len(), text.len() + StandardAeadTail::SIZE); + assert!(packet.peer_manager_header().unwrap().is_encrypted()); + + cipher.decrypt(&mut packet).unwrap(); + assert_eq!(packet.payload(), text); + assert!(!packet.peer_manager_header().unwrap().is_encrypted()); + } + + #[test] + fn test_chacha20_cipher_with_nonce() { + let key = [7u8; 32]; + let cipher = ChaCha20Cipher::new(key); + let text = b"Hello"; + let nonce = [3u8; 12]; + + let mut packet1 = ZCPacket::new_with_payload(text); + packet1.fill_peer_manager_hdr(0, 0, 0); + cipher + .encrypt_with_nonce(&mut packet1, Some(&nonce)) + .unwrap(); + + let mut packet2 = ZCPacket::new_with_payload(text); + packet2.fill_peer_manager_hdr(0, 0, 0); + cipher + .encrypt_with_nonce(&mut packet2, Some(&nonce)) + .unwrap(); + + assert_eq!(packet1.payload(), packet2.payload()); + + let tail = StandardAeadTail::ref_from_suffix(packet1.payload()).unwrap(); + assert_eq!(tail.nonce, nonce); + + cipher.decrypt(&mut packet1).unwrap(); + assert_eq!(packet1.payload(), text); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/encrypt/mod.rs b/vendor/easytier/easytier-core/src/tunnel/encrypt/mod.rs new file mode 100644 index 0000000..804ab81 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/encrypt/mod.rs @@ -0,0 +1,507 @@ +use crate::{config::EncryptionAlgorithm, packet::ZCPacket}; +use std::{collections::hash_map::DefaultHasher, hash::Hasher, sync::Arc}; + +#[cfg(feature = "aes-gcm")] +#[cfg_attr( + any(feature = "openssl-crypto", feature = "ring-crypto"), + allow(dead_code) +)] +pub mod aes_gcm; +#[cfg(feature = "chacha20")] +#[cfg_attr( + any(feature = "openssl-crypto", feature = "ring-crypto"), + allow(dead_code) +)] +pub mod chacha20; +#[cfg(feature = "openssl-crypto")] +mod openssl; +#[cfg(all(feature = "ring-crypto", any(not(feature = "openssl-crypto"), test)))] +mod ring; +#[cfg(all(target_os = "wasi", feature = "wasi-crypto-offload"))] +mod wasi_host; + +pub mod xor; + +// The disabled backends keep the same error Interface as the AEAD backends. +#[allow(dead_code)] +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error("packet is too short. len: {0}")] + PacketTooShort(usize), + #[error("decryption failed")] + DecryptionFailed, + #[error("encryption failed")] + EncryptionFailed, + #[error("invalid encryption algorithm: {0}")] + InvalidAlgorithm(String), + #[error("encryption algorithm is unavailable in this build: {0}")] + AlgorithmUnavailable(String), +} + +pub trait Encryptor: Send + Sync + 'static { + fn decrypt(&self, zc_packet: &mut ZCPacket) -> Result<(), Error>; + fn encrypt(&self, zc_packet: &mut ZCPacket) -> Result<(), Error>; + fn encrypt_with_nonce( + &self, + zc_packet: &mut ZCPacket, + _nonce: Option<&[u8]>, + ) -> Result<(), Error> { + self.encrypt(zc_packet) + } +} + +pub struct NullCipher; + +struct UnsupportedCipher { + algorithm: String, + unavailable: bool, +} + +pub fn derive_key_128(secret: &str) -> [u8; 16] { + let mut key = [0u8; 16]; + let mut hasher = DefaultHasher::new(); + hasher.write(secret.as_bytes()); + key[0..8].copy_from_slice(&hasher.finish().to_be_bytes()); + hasher.write(&key[0..8]); + key[8..16].copy_from_slice(&hasher.finish().to_be_bytes()); + hasher.write(&key); + key +} + +pub fn derive_key_256(secret: &str) -> [u8; 32] { + let mut key = [0u8; 32]; + let mut hasher = DefaultHasher::new(); + hasher.write(secret.as_bytes()); + hasher.write(b"easytier-256bit-key"); + for i in 0..4 { + let chunk_start = i * 8; + let chunk_end = chunk_start + 8; + hasher.write(&key[0..chunk_start]); + hasher.write(&[i as u8]); + key[chunk_start..chunk_end].copy_from_slice(&hasher.finish().to_be_bytes()); + } + key +} + +impl Encryptor for NullCipher { + fn decrypt(&self, zc_packet: &mut ZCPacket) -> Result<(), Error> { + let pm_header = zc_packet.peer_manager_header().unwrap(); + if pm_header.is_encrypted() { + Err(Error::DecryptionFailed) + } else { + Ok(()) + } + } + + fn encrypt(&self, _zc_packet: &mut ZCPacket) -> Result<(), Error> { + Ok(()) + } +} + +impl UnsupportedCipher { + fn error(&self) -> Error { + if self.unavailable { + Error::AlgorithmUnavailable(self.algorithm.clone()) + } else { + Error::InvalidAlgorithm(self.algorithm.clone()) + } + } +} + +impl Encryptor for UnsupportedCipher { + fn decrypt(&self, _zc_packet: &mut ZCPacket) -> Result<(), Error> { + Err(self.error()) + } + + fn encrypt(&self, _zc_packet: &mut ZCPacket) -> Result<(), Error> { + Err(self.error()) + } +} + +fn invalid_encryptor(algorithm: &str) -> Arc { + Arc::new(UnsupportedCipher { + algorithm: algorithm.to_owned(), + unavailable: false, + }) +} + +#[allow(dead_code)] // Selected disabled backends call this in reduced profiles. +fn unavailable_encryptor(algorithm: &str) -> Arc { + Arc::new(UnsupportedCipher { + algorithm: algorithm.to_owned(), + unavailable: true, + }) +} + +pub(crate) fn algorithm_is_available(algorithm: EncryptionAlgorithm) -> bool { + match algorithm { + EncryptionAlgorithm::Xor => true, + EncryptionAlgorithm::AesGcm | EncryptionAlgorithm::Aes256Gcm => cfg!(any( + feature = "aes-gcm", + feature = "openssl-crypto", + feature = "ring-crypto" + )), + EncryptionAlgorithm::ChaCha20 => cfg!(any( + feature = "chacha20", + feature = "openssl-crypto", + feature = "ring-crypto" + )), + } +} + +fn is_aead_algorithm(algorithm: EncryptionAlgorithm) -> bool { + matches!( + algorithm, + EncryptionAlgorithm::AesGcm + | EncryptionAlgorithm::Aes256Gcm + | EncryptionAlgorithm::ChaCha20 + ) +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum AeadBackend { + #[cfg(feature = "openssl-crypto")] + OpenSsl, + #[cfg(all(not(feature = "openssl-crypto"), feature = "ring-crypto"))] + Ring, + #[cfg(all( + not(feature = "openssl-crypto"), + not(feature = "ring-crypto"), + any(feature = "aes-gcm", feature = "chacha20") + ))] + RustCrypto, +} + +#[cfg(feature = "openssl-crypto")] +fn preferred_aead_backend(algorithm: EncryptionAlgorithm) -> Option { + is_aead_algorithm(algorithm).then_some(AeadBackend::OpenSsl) +} + +#[cfg(all(not(feature = "openssl-crypto"), feature = "ring-crypto"))] +fn preferred_aead_backend(algorithm: EncryptionAlgorithm) -> Option { + is_aead_algorithm(algorithm).then_some(AeadBackend::Ring) +} + +#[cfg(all( + not(feature = "openssl-crypto"), + not(feature = "ring-crypto"), + any(feature = "aes-gcm", feature = "chacha20") +))] +fn preferred_aead_backend(algorithm: EncryptionAlgorithm) -> Option { + (is_aead_algorithm(algorithm) && algorithm_is_available(algorithm)) + .then_some(AeadBackend::RustCrypto) +} + +#[cfg(not(any( + feature = "openssl-crypto", + feature = "ring-crypto", + feature = "aes-gcm", + feature = "chacha20" +)))] +fn preferred_aead_backend(_algorithm: EncryptionAlgorithm) -> Option { + None +} + +#[allow(unreachable_patterns)] +fn create_aes_128(key: [u8; 16]) -> Arc { + let fallback = match preferred_aead_backend(EncryptionAlgorithm::AesGcm) { + #[cfg(feature = "openssl-crypto")] + Some(AeadBackend::OpenSsl) => Arc::new(openssl::OpenSslCipher::new_aes128_gcm(key)), + #[cfg(all(not(feature = "openssl-crypto"), feature = "ring-crypto"))] + Some(AeadBackend::Ring) => Arc::new(ring::RingCipher::new_aes128_gcm(key)), + #[cfg(all( + not(feature = "openssl-crypto"), + not(feature = "ring-crypto"), + feature = "aes-gcm" + ))] + Some(AeadBackend::RustCrypto) => Arc::new(aes_gcm::AesGcmCipher::new_128(key)), + _ => unavailable_encryptor("aes-gcm"), + }; + maybe_offload_aead(EncryptionAlgorithm::AesGcm, &key, fallback) +} + +#[allow(unreachable_patterns)] +fn create_aes_256(key: [u8; 32]) -> Arc { + let fallback = match preferred_aead_backend(EncryptionAlgorithm::Aes256Gcm) { + #[cfg(feature = "openssl-crypto")] + Some(AeadBackend::OpenSsl) => Arc::new(openssl::OpenSslCipher::new_aes256_gcm(key)), + #[cfg(all(not(feature = "openssl-crypto"), feature = "ring-crypto"))] + Some(AeadBackend::Ring) => Arc::new(ring::RingCipher::new_aes256_gcm(key)), + #[cfg(all( + not(feature = "openssl-crypto"), + not(feature = "ring-crypto"), + feature = "aes-gcm" + ))] + Some(AeadBackend::RustCrypto) => Arc::new(aes_gcm::AesGcmCipher::new_256(key)), + _ => unavailable_encryptor("aes-256-gcm"), + }; + maybe_offload_aead(EncryptionAlgorithm::Aes256Gcm, &key, fallback) +} + +#[allow(unreachable_patterns)] +fn create_chacha20(key: [u8; 32]) -> Arc { + let fallback = match preferred_aead_backend(EncryptionAlgorithm::ChaCha20) { + #[cfg(feature = "openssl-crypto")] + Some(AeadBackend::OpenSsl) => Arc::new(openssl::OpenSslCipher::new_chacha20(key)), + #[cfg(all(not(feature = "openssl-crypto"), feature = "ring-crypto"))] + Some(AeadBackend::Ring) => Arc::new(ring::RingCipher::new_chacha20(key)), + #[cfg(all( + not(feature = "openssl-crypto"), + not(feature = "ring-crypto"), + feature = "chacha20" + ))] + Some(AeadBackend::RustCrypto) => Arc::new(chacha20::ChaCha20Cipher::new(key)), + _ => unavailable_encryptor("chacha20"), + }; + maybe_offload_aead(EncryptionAlgorithm::ChaCha20, &key, fallback) +} + +#[cfg(all(target_os = "wasi", feature = "wasi-crypto-offload"))] +fn maybe_offload_aead( + algorithm: EncryptionAlgorithm, + key: &[u8], + fallback: Arc, +) -> Arc { + Arc::new(wasi_host::WasiHostAead::new(algorithm, key, fallback)) +} + +#[cfg(not(all(target_os = "wasi", feature = "wasi-crypto-offload")))] +fn maybe_offload_aead( + _algorithm: EncryptionAlgorithm, + _key: &[u8], + fallback: Arc, +) -> Arc { + fallback +} + +pub(crate) fn validate_algorithm(algorithm: &str) -> Result<(), Error> { + let parsed = algorithm + .parse::() + .map_err(|()| Error::InvalidAlgorithm(algorithm.to_owned()))?; + if algorithm_is_available(parsed) { + Ok(()) + } else { + Err(Error::AlgorithmUnavailable(parsed.to_string())) + } +} + +pub(super) fn effective_algorithm_uses_xor(algorithm: &str) -> bool { + algorithm.parse() == Ok(EncryptionAlgorithm::Xor) +} + +/// Create an encryptor based on the algorithm name. +/// +/// Callers that accept user configuration validate it during construction. +/// Protocol paths remain infallible here and receive an encryptor that returns +/// an explicit error if a peer names an invalid or unavailable algorithm. +pub fn create_encryptor( + algorithm: &str, + key_128: [u8; 16], + key_256: [u8; 32], +) -> Arc { + let Ok(algorithm) = algorithm.parse::() else { + return invalid_encryptor(algorithm); + }; + + match algorithm { + EncryptionAlgorithm::Xor => Arc::new(xor::XorCipher::new(&key_128)), + EncryptionAlgorithm::AesGcm => create_aes_128(key_128), + EncryptionAlgorithm::Aes256Gcm => create_aes_256(key_256), + EncryptionAlgorithm::ChaCha20 => create_chacha20(key_256), + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::packet::{StandardAeadTail, ZCPacket}; + + fn assert_interoperable(left: &dyn Encryptor, right: &dyn Encryptor) { + let plaintext = b"cross-backend compatibility"; + let nonce = [9; StandardAeadTail::NONCE_SIZE]; + let mut left_packet = ZCPacket::new_with_payload(plaintext); + left_packet.fill_peer_manager_hdr(1, 2, 1); + let mut right_packet = ZCPacket::new_with_payload(plaintext); + right_packet.fill_peer_manager_hdr(1, 2, 1); + + left.encrypt_with_nonce(&mut left_packet, Some(&nonce)) + .unwrap(); + right + .encrypt_with_nonce(&mut right_packet, Some(&nonce)) + .unwrap(); + assert_eq!(left_packet.payload(), right_packet.payload()); + + left.decrypt(&mut right_packet).unwrap(); + right.decrypt(&mut left_packet).unwrap(); + assert_eq!(left_packet.payload(), plaintext); + assert_eq!(right_packet.payload(), plaintext); + } + + #[test] + fn network_secret_key_derivation_is_stable() { + assert_eq!( + derive_key_128("secret"), + [ + 86, 90, 25, 219, 78, 240, 193, 33, 168, 172, 88, 14, 218, 248, 78, 166, + ] + ); + assert_eq!( + derive_key_256("secret"), + [ + 199, 205, 248, 94, 194, 101, 97, 138, 79, 69, 167, 248, 140, 5, 165, 163, 192, 139, + 166, 217, 166, 152, 28, 230, 146, 109, 150, 196, 66, 242, 231, 140, + ] + ); + } + + #[test] + fn effective_algorithm_only_reports_explicit_xor() { + assert!(effective_algorithm_uses_xor("xor")); + assert!(!effective_algorithm_uses_xor("")); + assert!(!effective_algorithm_uses_xor("unsupported")); + assert!(!effective_algorithm_uses_xor("aes-gcm")); + } + + #[cfg(not(any( + feature = "aes-gcm", + feature = "openssl-crypto", + feature = "ring-crypto" + )))] + #[test] + fn unavailable_aes_is_known_but_rejected() { + assert_eq!( + validate_algorithm("aes-gcm").unwrap_err().to_string(), + "encryption algorithm is unavailable in this build: aes-gcm" + ); + } + + #[cfg(any( + feature = "aes-gcm", + feature = "openssl-crypto", + feature = "ring-crypto" + ))] + #[test] + fn compiled_aes_is_available() { + validate_algorithm("aes-gcm").unwrap(); + validate_algorithm("aes-256-gcm").unwrap(); + } + + #[cfg(not(any( + feature = "chacha20", + feature = "openssl-crypto", + feature = "ring-crypto" + )))] + #[test] + fn unavailable_chacha20_is_known_but_rejected() { + assert_eq!( + validate_algorithm("chacha20-poly1305") + .unwrap_err() + .to_string(), + "encryption algorithm is unavailable in this build: chacha20" + ); + } + + #[cfg(any( + feature = "chacha20", + feature = "openssl-crypto", + feature = "ring-crypto" + ))] + #[test] + fn compiled_chacha20_is_available() { + validate_algorithm("chacha20").unwrap(); + } + + #[test] + fn accelerated_backends_take_precedence_over_rustcrypto() { + #[cfg(feature = "openssl-crypto")] + assert_eq!( + preferred_aead_backend(EncryptionAlgorithm::AesGcm), + Some(AeadBackend::OpenSsl) + ); + + #[cfg(all(not(feature = "openssl-crypto"), feature = "ring-crypto"))] + assert_eq!( + preferred_aead_backend(EncryptionAlgorithm::AesGcm), + Some(AeadBackend::Ring) + ); + + #[cfg(all( + not(feature = "openssl-crypto"), + not(feature = "ring-crypto"), + feature = "aes-gcm" + ))] + assert_eq!( + preferred_aead_backend(EncryptionAlgorithm::AesGcm), + Some(AeadBackend::RustCrypto) + ); + } + + #[cfg(all(feature = "ring-crypto", feature = "aes-gcm"))] + #[test] + fn ring_and_rustcrypto_aes_are_interoperable() { + assert_interoperable( + &ring::RingCipher::new_aes128_gcm([1; 16]), + &aes_gcm::AesGcmCipher::new_128([1; 16]), + ); + assert_interoperable( + &ring::RingCipher::new_aes256_gcm([2; 32]), + &aes_gcm::AesGcmCipher::new_256([2; 32]), + ); + } + + #[cfg(all(feature = "ring-crypto", feature = "chacha20"))] + #[test] + fn ring_and_rustcrypto_chacha20_are_interoperable() { + assert_interoperable( + &ring::RingCipher::new_chacha20([3; 32]), + &chacha20::ChaCha20Cipher::new([3; 32]), + ); + } + + #[cfg(all(feature = "openssl-crypto", feature = "aes-gcm"))] + #[test] + fn openssl_and_rustcrypto_aes_are_interoperable() { + assert_interoperable( + &openssl::OpenSslCipher::new_aes128_gcm([1; 16]), + &aes_gcm::AesGcmCipher::new_128([1; 16]), + ); + assert_interoperable( + &openssl::OpenSslCipher::new_aes256_gcm([2; 32]), + &aes_gcm::AesGcmCipher::new_256([2; 32]), + ); + } + + #[cfg(all(feature = "openssl-crypto", feature = "chacha20"))] + #[test] + fn openssl_and_rustcrypto_chacha20_are_interoperable() { + assert_interoperable( + &openssl::OpenSslCipher::new_chacha20([3; 32]), + &chacha20::ChaCha20Cipher::new([3; 32]), + ); + } + + #[cfg(all(feature = "openssl-crypto", feature = "ring-crypto"))] + #[test] + fn openssl_and_ring_algorithms_are_interoperable() { + assert_interoperable( + &openssl::OpenSslCipher::new_aes128_gcm([1; 16]), + &ring::RingCipher::new_aes128_gcm([1; 16]), + ); + assert_interoperable( + &openssl::OpenSslCipher::new_aes256_gcm([2; 32]), + &ring::RingCipher::new_aes256_gcm([2; 32]), + ); + assert_interoperable( + &openssl::OpenSslCipher::new_chacha20([3; 32]), + &ring::RingCipher::new_chacha20([3; 32]), + ); + } + + #[test] + fn invalid_algorithm_is_rejected() { + assert_eq!( + validate_algorithm("rot13").unwrap_err().to_string(), + "invalid encryption algorithm: rot13" + ); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/encrypt/openssl.rs b/vendor/easytier/easytier-core/src/tunnel/encrypt/openssl.rs new file mode 100644 index 0000000..642b392 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/encrypt/openssl.rs @@ -0,0 +1,159 @@ +use openssl::symm::{Cipher, Crypter, Mode}; +use rand::RngCore as _; +use zerocopy::{AsBytes as _, FromBytes as _, FromZeroes as _}; + +use crate::packet::{StandardAeadTail, ZCPacket}; + +use super::{Encryptor, Error}; + +#[derive(Clone)] +pub struct OpenSslCipher { + cipher: OpenSslCipherKind, +} + +#[derive(Clone, Copy)] +enum OpenSslCipherKind { + Aes128Gcm([u8; 16]), + Aes256Gcm([u8; 32]), + ChaCha20Poly1305([u8; 32]), +} + +impl OpenSslCipher { + pub fn new_aes128_gcm(key: [u8; 16]) -> Self { + Self { + cipher: OpenSslCipherKind::Aes128Gcm(key), + } + } + + pub fn new_aes256_gcm(key: [u8; 32]) -> Self { + Self { + cipher: OpenSslCipherKind::Aes256Gcm(key), + } + } + + pub fn new_chacha20(key: [u8; 32]) -> Self { + Self { + cipher: OpenSslCipherKind::ChaCha20Poly1305(key), + } + } + + fn cipher_and_key(&self) -> (Cipher, &[u8]) { + match &self.cipher { + OpenSslCipherKind::Aes128Gcm(key) => (Cipher::aes_128_gcm(), key), + OpenSslCipherKind::Aes256Gcm(key) => (Cipher::aes_256_gcm(), key), + OpenSslCipherKind::ChaCha20Poly1305(key) => (Cipher::chacha20_poly1305(), key), + } + } +} + +impl Encryptor for OpenSslCipher { + fn decrypt(&self, packet: &mut ZCPacket) -> Result<(), Error> { + let header = packet.peer_manager_header().unwrap(); + if !header.is_encrypted() { + return Ok(()); + } + + let payload_len = packet.payload().len(); + if payload_len < StandardAeadTail::SIZE { + return Err(Error::PacketTooShort(payload_len)); + } + + let (cipher, key) = self.cipher_and_key(); + let tail = StandardAeadTail::ref_from_suffix(packet.payload()).unwrap(); + let mut decrypter = Crypter::new(cipher, Mode::Decrypt, key, Some(&tail.nonce)) + .map_err(|_| Error::DecryptionFailed)?; + decrypter + .set_tag(&tail.tag) + .map_err(|_| Error::DecryptionFailed)?; + + let text_len = payload_len - StandardAeadTail::SIZE; + let mut output = vec![0; text_len + cipher.block_size()]; + let mut written = decrypter + .update(&packet.payload()[..text_len], &mut output) + .map_err(|_| Error::DecryptionFailed)?; + written += decrypter + .finalize(&mut output[written..]) + .map_err(|_| Error::DecryptionFailed)?; + + packet.mut_payload()[..written].copy_from_slice(&output[..written]); + packet + .mut_peer_manager_header() + .unwrap() + .set_encrypted(false); + let old_len = packet.buf_len(); + packet + .mut_inner() + .truncate(old_len - (payload_len - written)); + Ok(()) + } + + fn encrypt(&self, packet: &mut ZCPacket) -> Result<(), Error> { + self.encrypt_with_nonce(packet, None) + } + + fn encrypt_with_nonce(&self, packet: &mut ZCPacket, nonce: Option<&[u8]>) -> Result<(), Error> { + let header = packet.peer_manager_header().unwrap(); + if header.is_encrypted() { + tracing::warn!(?packet, "packet is already encrypted"); + return Ok(()); + } + + let (cipher, key) = self.cipher_and_key(); + let mut tail = StandardAeadTail::new_zeroed(); + match nonce { + Some(nonce) => { + tail.nonce = nonce.try_into().map_err(|_| Error::EncryptionFailed)?; + } + None => rand::thread_rng().fill_bytes(&mut tail.nonce), + } + + let mut encrypter = Crypter::new(cipher, Mode::Encrypt, key, Some(&tail.nonce)) + .map_err(|_| Error::EncryptionFailed)?; + let payload_len = packet.payload().len(); + let mut output = vec![0; payload_len + cipher.block_size()]; + let mut written = encrypter + .update(packet.payload(), &mut output) + .map_err(|_| Error::EncryptionFailed)?; + written += encrypter + .finalize(&mut output[written..]) + .map_err(|_| Error::EncryptionFailed)?; + packet.mut_payload()[..written].copy_from_slice(&output[..written]); + encrypter + .get_tag(&mut tail.tag) + .map_err(|_| Error::EncryptionFailed)?; + + packet + .mut_peer_manager_header() + .unwrap() + .set_encrypted(true); + packet.mut_inner().extend_from_slice(tail.as_bytes()); + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn round_trip(cipher: OpenSslCipher) { + let plaintext = b"openssl accelerated packet"; + let mut packet = ZCPacket::new_with_payload(plaintext); + packet.fill_peer_manager_hdr(1, 2, 1); + + cipher + .encrypt_with_nonce(&mut packet, Some(&[3; StandardAeadTail::NONCE_SIZE])) + .unwrap(); + assert!(packet.peer_manager_header().unwrap().is_encrypted()); + + cipher.decrypt(&mut packet).unwrap(); + assert_eq!(packet.payload(), plaintext); + assert!(!packet.peer_manager_header().unwrap().is_encrypted()); + } + + #[test] + fn openssl_algorithms_round_trip() { + round_trip(OpenSslCipher::new_aes128_gcm([1; 16])); + round_trip(OpenSslCipher::new_aes256_gcm([2; 32])); + round_trip(OpenSslCipher::new_chacha20([3; 32])); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/encrypt/ring.rs b/vendor/easytier/easytier-core/src/tunnel/encrypt/ring.rs new file mode 100644 index 0000000..519af49 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/encrypt/ring.rs @@ -0,0 +1,194 @@ +use rand::RngCore as _; +use ring::aead::{self, LessSafeKey, UnboundKey}; +use zerocopy::{AsBytes as _, FromBytes as _, FromZeroes as _}; + +use crate::packet::{StandardAeadTail, ZCPacket}; + +use super::{Encryptor, Error}; + +#[derive(Clone)] +pub struct RingCipher { + cipher: RingCipherKind, +} + +enum RingCipherKind { + Aes128Gcm(LessSafeKey, [u8; 16]), + Aes256Gcm(LessSafeKey, [u8; 32]), + ChaCha20Poly1305(LessSafeKey, [u8; 32]), +} + +impl RingCipherKind { + fn key(&self) -> &LessSafeKey { + match self { + Self::Aes128Gcm(cipher, _) + | Self::Aes256Gcm(cipher, _) + | Self::ChaCha20Poly1305(cipher, _) => cipher, + } + } +} + +impl Clone for RingCipherKind { + fn clone(&self) -> Self { + match self { + Self::Aes128Gcm(_, key) => Self::Aes128Gcm( + LessSafeKey::new(UnboundKey::new(&aead::AES_128_GCM, key).unwrap()), + *key, + ), + Self::Aes256Gcm(_, key) => Self::Aes256Gcm( + LessSafeKey::new(UnboundKey::new(&aead::AES_256_GCM, key).unwrap()), + *key, + ), + Self::ChaCha20Poly1305(_, key) => Self::ChaCha20Poly1305( + LessSafeKey::new(UnboundKey::new(&aead::CHACHA20_POLY1305, key).unwrap()), + *key, + ), + } + } +} + +impl RingCipher { + pub fn new_aes128_gcm(key: [u8; 16]) -> Self { + Self { + cipher: RingCipherKind::Aes128Gcm( + LessSafeKey::new(UnboundKey::new(&aead::AES_128_GCM, &key).unwrap()), + key, + ), + } + } + + pub fn new_aes256_gcm(key: [u8; 32]) -> Self { + Self { + cipher: RingCipherKind::Aes256Gcm( + LessSafeKey::new(UnboundKey::new(&aead::AES_256_GCM, &key).unwrap()), + key, + ), + } + } + + pub fn new_chacha20(key: [u8; 32]) -> Self { + Self { + cipher: RingCipherKind::ChaCha20Poly1305( + LessSafeKey::new(UnboundKey::new(&aead::CHACHA20_POLY1305, &key).unwrap()), + key, + ), + } + } +} + +impl Encryptor for RingCipher { + fn decrypt(&self, packet: &mut ZCPacket) -> Result<(), Error> { + let header = packet.peer_manager_header().unwrap(); + if !header.is_encrypted() { + return Ok(()); + } + + let payload_len = packet.payload().len(); + if payload_len < StandardAeadTail::SIZE { + return Err(Error::PacketTooShort(payload_len)); + } + + let text_and_tag_len = payload_len - StandardAeadTail::SIZE + StandardAeadTail::TAG_SIZE; + let tail = StandardAeadTail::ref_from_suffix(packet.payload()).unwrap(); + let nonce = aead::Nonce::assume_unique_for_key(tail.nonce); + + self.cipher + .key() + .open_in_place( + nonce, + aead::Aad::empty(), + &mut packet.mut_payload()[..text_and_tag_len], + ) + .map_err(|_| Error::DecryptionFailed)?; + + packet + .mut_peer_manager_header() + .unwrap() + .set_encrypted(false); + let old_len = packet.buf_len(); + packet + .mut_inner() + .truncate(old_len - StandardAeadTail::SIZE); + Ok(()) + } + + fn encrypt(&self, packet: &mut ZCPacket) -> Result<(), Error> { + self.encrypt_with_nonce(packet, None) + } + + fn encrypt_with_nonce(&self, packet: &mut ZCPacket, nonce: Option<&[u8]>) -> Result<(), Error> { + let header = packet.peer_manager_header().unwrap(); + if header.is_encrypted() { + tracing::warn!(?packet, "packet is already encrypted"); + return Ok(()); + } + + let mut tail = StandardAeadTail::new_zeroed(); + match nonce { + Some(nonce) => { + tail.nonce = nonce.try_into().map_err(|_| Error::EncryptionFailed)?; + } + None => rand::thread_rng().fill_bytes(&mut tail.nonce), + } + + let nonce = aead::Nonce::assume_unique_for_key(tail.nonce); + let tag = self + .cipher + .key() + .seal_in_place_separate_tag(nonce, aead::Aad::empty(), packet.mut_payload()) + .map_err(|_| Error::EncryptionFailed)?; + tail.tag.copy_from_slice(tag.as_ref()); + + packet + .mut_peer_manager_header() + .unwrap() + .set_encrypted(true); + packet.mut_inner().extend_from_slice(tail.as_bytes()); + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn round_trip(cipher: RingCipher) { + let plaintext = b"ring accelerated packet"; + let mut packet = ZCPacket::new_with_payload(plaintext); + packet.fill_peer_manager_hdr(1, 2, 1); + + cipher + .encrypt_with_nonce(&mut packet, Some(&[3; StandardAeadTail::NONCE_SIZE])) + .unwrap(); + assert!(packet.peer_manager_header().unwrap().is_encrypted()); + + cipher.decrypt(&mut packet).unwrap(); + assert_eq!(packet.payload(), plaintext); + assert!(!packet.peer_manager_header().unwrap().is_encrypted()); + } + + #[test] + fn ring_algorithms_round_trip() { + round_trip(RingCipher::new_aes128_gcm([1; 16])); + round_trip(RingCipher::new_aes256_gcm([2; 32])); + round_trip(RingCipher::new_chacha20([3; 32])); + } + + #[test] + fn aes128_gcm_matches_standard_vector() { + let cipher = RingCipher::new_aes128_gcm([0; 16]); + let mut packet = ZCPacket::new_with_payload(&[0; 16]); + packet.fill_peer_manager_hdr(0, 0, 0); + cipher + .encrypt_with_nonce(&mut packet, Some(&[0; 12])) + .unwrap(); + + assert_eq!( + packet.payload(), + &[ + 0x03, 0x88, 0xda, 0xce, 0x60, 0xb6, 0xa3, 0x92, 0xf3, 0x28, 0xc2, 0xb9, 0x71, 0xb2, + 0xfe, 0x78, 0xab, 0x6e, 0x47, 0xd4, 0x2c, 0xec, 0x13, 0xbd, 0xf5, 0x3a, 0x67, 0xb2, + 0x12, 0x57, 0xbd, 0xdf, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, + ] + ); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/encrypt/wasi_host.rs b/vendor/easytier/easytier-core/src/tunnel/encrypt/wasi_host.rs new file mode 100644 index 0000000..92eb596 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/encrypt/wasi_host.rs @@ -0,0 +1,152 @@ +use std::sync::Arc; + +use rand::RngCore as _; +use zerocopy::FromBytes as _; + +use crate::{ + config::EncryptionAlgorithm, + packet::{StandardAeadTail, ZCPacket}, + wasi::{ + abi::{ + AEAD_AES_128_GCM, AEAD_AES_256_GCM, AEAD_CHACHA20_POLY1305, HOST_CRYPTO_AUTH_FAILED, + }, + imports::{crypto_aead_open, crypto_aead_seal}, + }, +}; + +use super::{Encryptor, Error}; + +pub(super) struct WasiHostAead { + algorithm: u32, + key: Box<[u8]>, + fallback: Arc, +} + +impl WasiHostAead { + pub(super) fn new( + algorithm: EncryptionAlgorithm, + key: &[u8], + fallback: Arc, + ) -> Self { + let algorithm = match algorithm { + EncryptionAlgorithm::AesGcm => AEAD_AES_128_GCM, + EncryptionAlgorithm::Aes256Gcm => AEAD_AES_256_GCM, + EncryptionAlgorithm::ChaCha20 => AEAD_CHACHA20_POLY1305, + EncryptionAlgorithm::Xor => unreachable!("XOR is not an AEAD algorithm"), + }; + Self { + algorithm, + key: key.into(), + fallback, + } + } + + fn call( + &self, + open: bool, + nonce: &[u8; StandardAeadTail::NONCE_SIZE], + buffer: &mut [u8], + text_len: usize, + ) -> i32 { + let key_len = u32::try_from(self.key.len()).expect("AEAD keys fit u32"); + let nonce_len = u32::try_from(nonce.len()).expect("AEAD nonces fit u32"); + let text_len = u32::try_from(text_len).expect("packet payloads fit u32"); + let function = if open { + crypto_aead_open + } else { + crypto_aead_seal + }; + unsafe { + function( + self.algorithm, + self.key.as_ptr() as u32, + key_len, + nonce.as_ptr() as u32, + nonce_len, + 0, + 0, + buffer.as_mut_ptr() as u32, + text_len, + ) + } + } +} + +impl Encryptor for WasiHostAead { + fn decrypt(&self, packet: &mut ZCPacket) -> Result<(), Error> { + let header = packet.peer_manager_header().unwrap(); + if !header.is_encrypted() { + return Ok(()); + } + + let payload_len = packet.payload().len(); + if payload_len < StandardAeadTail::SIZE { + return Err(Error::PacketTooShort(payload_len)); + } + + let text_len = payload_len - StandardAeadTail::SIZE; + let tail = StandardAeadTail::ref_from_suffix(packet.payload()) + .unwrap() + .clone(); + let status = self.call( + true, + &tail.nonce, + &mut packet.mut_payload()[..text_len + StandardAeadTail::TAG_SIZE], + text_len, + ); + if status == HOST_CRYPTO_AUTH_FAILED { + return Err(Error::DecryptionFailed); + } + if status != 0 { + return self.fallback.decrypt(packet); + } + + packet + .mut_peer_manager_header() + .unwrap() + .set_encrypted(false); + let old_len = packet.buf_len(); + packet + .mut_inner() + .truncate(old_len - StandardAeadTail::SIZE); + Ok(()) + } + + fn encrypt(&self, packet: &mut ZCPacket) -> Result<(), Error> { + self.encrypt_with_nonce(packet, None) + } + + fn encrypt_with_nonce(&self, packet: &mut ZCPacket, nonce: Option<&[u8]>) -> Result<(), Error> { + let header = packet.peer_manager_header().unwrap(); + if header.is_encrypted() { + tracing::warn!(?packet, "packet is already encrypted"); + return Ok(()); + } + + let mut nonce_bytes = [0; StandardAeadTail::NONCE_SIZE]; + match nonce { + Some(nonce) => { + nonce_bytes = nonce.try_into().map_err(|_| Error::EncryptionFailed)?; + } + None => rand::thread_rng().fill_bytes(&mut nonce_bytes), + } + + let text_len = packet.payload().len(); + let old_len = packet.buf_len(); + packet + .mut_inner() + .extend_from_slice(&[0; StandardAeadTail::TAG_SIZE]); + let status = self.call(false, &nonce_bytes, packet.mut_payload(), text_len); + if status != 0 { + packet.mut_inner().truncate(old_len); + return self.fallback.encrypt_with_nonce(packet, Some(&nonce_bytes)); + } + + packet.mut_inner().extend_from_slice(&nonce_bytes); + packet + .mut_peer_manager_header() + .unwrap() + .set_encrypted(true); + Ok(()) + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/encrypt/xor.rs b/vendor/easytier/easytier-core/src/tunnel/encrypt/xor.rs new file mode 100644 index 0000000..ad8b110 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/encrypt/xor.rs @@ -0,0 +1,83 @@ +use crate::packet::ZCPacket; + +use super::{Encryptor, Error}; + +#[derive(Clone)] +pub struct XorCipher { + pub(crate) key: Vec, +} + +impl XorCipher { + pub fn new(key: &[u8]) -> Self { + if key.is_empty() { + panic!("XOR key cannot be empty"); + } + Self { key: key.to_vec() } + } + + fn xor_data(&self, data: &mut [u8]) { + for (i, byte) in data.iter_mut().enumerate() { + *byte ^= self.key[i % self.key.len()]; + } + } +} + +impl Encryptor for XorCipher { + fn decrypt(&self, zc_packet: &mut ZCPacket) -> Result<(), Error> { + let pm_header = zc_packet.peer_manager_header().unwrap(); + if !pm_header.is_encrypted() { + return Ok(()); + } + + // XOR 解密(XOR是对称的,加密和解密操作相同) + self.xor_data(zc_packet.mut_payload()); + + let pm_header = zc_packet.mut_peer_manager_header().unwrap(); + pm_header.set_encrypted(false); + + Ok(()) + } + + fn encrypt(&self, zc_packet: &mut ZCPacket) -> Result<(), Error> { + let pm_header = zc_packet.peer_manager_header().unwrap(); + if pm_header.is_encrypted() { + tracing::warn!(?zc_packet, "packet is already encrypted"); + return Ok(()); + } + + // XOR 加密 + self.xor_data(zc_packet.mut_payload()); + + let pm_header = zc_packet.mut_peer_manager_header().unwrap(); + pm_header.set_encrypted(true); + + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use crate::{ + packet::ZCPacket, + tunnel::encrypt::{Encryptor, xor::XorCipher}, + }; + + #[test] + fn test_xor_cipher() { + let key = b"test_key_123456"; + let cipher = XorCipher::new(key); + let text = b"Hello, World! This is a test message."; + let mut packet = ZCPacket::new_with_payload(text); + packet.fill_peer_manager_hdr(0, 0, 0); + + // 加密 + cipher.encrypt(&mut packet).unwrap(); + assert!(packet.peer_manager_header().unwrap().is_encrypted()); + assert_ne!(packet.payload(), text); // 加密后数据应该不同 + + // 解密 + cipher.decrypt(&mut packet).unwrap(); + assert_eq!(packet.payload(), text); + assert!(!packet.peer_manager_header().unwrap().is_encrypted()); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/filter.rs b/vendor/easytier/easytier-core/src/tunnel/filter.rs new file mode 100644 index 0000000..4cb00ea --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/filter.rs @@ -0,0 +1,313 @@ +use std::{ + sync::Arc, + task::{Context, Poll}, +}; + +use auto_impl::auto_impl; +use futures::{Sink, SinkExt, Stream, StreamExt}; + +use crate::{ + packet::ZCPacket, + proto::common::TunnelInfo, + tunnel::{ + SinkError, SinkItem, StreamItem, Tunnel, ZCPacketSink, ZCPacketStream, stats::Throughput, + }, +}; + +#[auto_impl(Arc, Box)] +pub trait TunnelFilter: Send + Sync { + type FilterOutput; + + fn before_send(&self, data: SinkItem) -> Option { + Some(data) + } + + fn after_received(&self, data: StreamItem) -> Option { + match data { + Ok(v) => Some(Ok(v)), + Err(e) => Some(Err(e)), + } + } + + fn filter_output(&self) -> Self::FilterOutput; +} + +pub struct TunnelFilterChain { + a: A, + b: B, +} + +impl TunnelFilter for TunnelFilterChain +where + A: TunnelFilter, + B: TunnelFilter, +{ + type FilterOutput = (OA, OB); + + fn before_send(&self, data: SinkItem) -> Option { + let data = self.a.before_send(data)?; + self.b.before_send(data) + } + + fn after_received(&self, data: StreamItem) -> Option { + let data = self.b.after_received(data)?; + self.a.after_received(data) + } + + fn filter_output(&self) -> Self::FilterOutput { + (self.a.filter_output(), self.b.filter_output()) + } +} + +impl TunnelFilterChain { + pub fn new(a: A, b: B) -> Self { + Self { a, b } + } + + pub fn chain(self, c: T) -> TunnelFilterChain { + TunnelFilterChain::new(self, c) + } +} + +pub struct EmptyFilter; + +impl TunnelFilter for EmptyFilter { + type FilterOutput = (); + + fn filter_output(&self) {} +} + +pub trait ToTunnelChain { + fn to_chain(self) -> TunnelFilterChain + where + Self: Sized, + { + TunnelFilterChain::new(EmptyFilter, self) + } +} + +impl> ToTunnelChain for T {} + +pub struct TunnelWithFilter { + inner: T, + filter: Arc, +} + +impl TunnelWithFilter +where + T: Tunnel + Send + 'static, + F: TunnelFilter + Send + 'static, +{ + pub fn new(inner: T, filter: F) -> Self { + Self { + inner, + filter: Arc::new(filter), + } + } + + fn wrap_sink(filter: Arc, sink: S) -> impl ZCPacketSink { + struct SinkWrapper { + sink: S, + filter: Arc, + } + + impl Sink for SinkWrapper + where + F: TunnelFilter + 'static, + S: ZCPacketSink + 'static + Unpin, + { + type Error = SinkError; + + fn poll_ready( + self: std::pin::Pin<&mut Self>, + cx: &mut Context<'_>, + ) -> Poll> { + self.get_mut().sink.poll_ready_unpin(cx) + } + + fn start_send( + self: std::pin::Pin<&mut Self>, + item: ZCPacket, + ) -> Result<(), Self::Error> { + let Some(item) = self.filter.before_send(item) else { + return Ok(()); + }; + self.get_mut().sink.start_send_unpin(item) + } + + fn poll_flush( + self: std::pin::Pin<&mut Self>, + cx: &mut Context<'_>, + ) -> Poll> { + self.get_mut().sink.poll_flush_unpin(cx) + } + + fn poll_close( + self: std::pin::Pin<&mut Self>, + cx: &mut Context<'_>, + ) -> Poll> { + self.get_mut().sink.poll_close_unpin(cx) + } + } + + SinkWrapper { sink, filter } + } + + fn wrap_stream( + filter: Arc, + stream: S, + ) -> impl ZCPacketStream { + struct StreamWrapper { + stream: S, + filter: Arc, + } + + impl Stream for StreamWrapper + where + F: TunnelFilter + 'static, + S: ZCPacketStream + 'static + Unpin, + { + type Item = StreamItem; + + fn poll_next( + self: std::pin::Pin<&mut Self>, + cx: &mut Context<'_>, + ) -> Poll> { + let self_mut = self.get_mut(); + loop { + match self_mut.stream.poll_next_unpin(cx) { + Poll::Ready(Some(ret)) => { + let Some(ret) = self_mut.filter.after_received(ret) else { + continue; + }; + return Poll::Ready(Some(ret)); + } + Poll::Ready(None) => { + return Poll::Ready(None); + } + Poll::Pending => { + return Poll::Pending; + } + } + } + } + } + + StreamWrapper { stream, filter } + } +} + +impl Tunnel for TunnelWithFilter +where + T: Tunnel + Send + 'static, + F: TunnelFilter + Send + 'static, +{ + fn info(&self) -> Option { + self.inner.info() + } + + fn split( + &self, + ) -> ( + std::pin::Pin>, + std::pin::Pin>, + ) { + let (stream, sink) = self.inner.split(); + let filter = self.filter.clone(); + ( + Box::pin(Self::wrap_stream(filter.clone(), stream)), + Box::pin(Self::wrap_sink(filter, sink)), + ) + } +} + +pub struct PacketRecorderTunnelFilter { + pub received: Arc>>, + pub sent: Arc>>, +} + +impl TunnelFilter for PacketRecorderTunnelFilter { + type FilterOutput = (Vec, Vec); + + fn before_send(&self, data: SinkItem) -> Option { + self.sent.lock().unwrap().push(data.clone()); + Some(data) + } + + fn after_received(&self, data: StreamItem) -> Option { + match data { + Ok(v) => { + self.received.lock().unwrap().push(v.clone()); + Some(Ok(v)) + } + Err(e) => Some(Err(e)), + } + } + + fn filter_output(&self) -> Self::FilterOutput { + ( + self.sent.lock().unwrap().clone(), + self.received.lock().unwrap().clone(), + ) + } +} + +impl Default for PacketRecorderTunnelFilter { + fn default() -> Self { + Self::new() + } +} + +impl PacketRecorderTunnelFilter { + pub fn new() -> Self { + Self { + received: Arc::new(std::sync::Mutex::new(Vec::new())), + sent: Arc::new(std::sync::Mutex::new(Vec::new())), + } + } +} + +pub struct StatsRecorderTunnelFilter { + throughput: Arc, +} + +impl TunnelFilter for StatsRecorderTunnelFilter { + type FilterOutput = Arc; + + fn before_send(&self, data: SinkItem) -> Option { + self.throughput.record_tx_bytes(data.buf_len() as u64); + Some(data) + } + + fn after_received(&self, data: StreamItem) -> Option { + match data { + Ok(v) => { + self.throughput.record_rx_bytes(v.buf_len() as u64); + Some(Ok(v)) + } + Err(e) => Some(Err(e)), + } + } + + fn filter_output(&self) -> Self::FilterOutput { + self.throughput.clone() + } +} + +impl Default for StatsRecorderTunnelFilter { + fn default() -> Self { + Self::new() + } +} + +impl StatsRecorderTunnelFilter { + pub fn new() -> Self { + Self { + throughput: Arc::new(Throughput::new()), + } + } + + pub fn get_throughput(&self) -> Arc { + self.throughput.clone() + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/framed.rs b/vendor/easytier/easytier-core/src/tunnel/framed.rs new file mode 100644 index 0000000..76e5995 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/framed.rs @@ -0,0 +1,375 @@ +use std::{ + any::Any, + collections::VecDeque, + io::IoSlice, + pin::Pin, + task::{Poll, ready}, +}; + +use bytes::{Buf, BufMut, Bytes, BytesMut}; +use futures::{Sink, Stream}; +use pin_project_lite::pin_project; +use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; +use tokio_util::io::poll_write_buf; +use zerocopy::FromBytes as _; + +use crate::{ + packet::{ + PEER_MANAGER_HEADER_SIZE, TCP_TUNNEL_HEADER_SIZE, TCPTunnelHeader, ZCPacket, ZCPacketType, + }, + tunnel::{SinkError, SinkItem, StreamItem, TunnelError}, +}; + +pub const TCP_MTU_BYTES: usize = 2000; + +pub fn reserve_buf(buf: &mut BytesMut, min_size: usize, max_size: usize) { + if buf.capacity() < min_size { + buf.reserve(max_size); + } +} + +pin_project! { + pub struct FramedReader { + #[pin] + reader: R, + buf: BytesMut, + max_packet_size: usize, + _associate_data: Option>, + error: Option, + } +} + +impl FramedReader { + pub fn new(reader: R, max_packet_size: usize) -> Self { + Self::new_with_associate_data(reader, max_packet_size, None) + } + + pub fn new_with_associate_data( + reader: R, + max_packet_size: usize, + associate_data: Option>, + ) -> Self { + Self { + reader, + buf: BytesMut::with_capacity(max_packet_size), + max_packet_size, + _associate_data: associate_data, + error: None, + } + } + + pub fn extract_one_packet( + buf: &mut BytesMut, + max_packet_size: usize, + ) -> Option> { + if buf.len() < TCP_TUNNEL_HEADER_SIZE { + return None; + } + + let header = TCPTunnelHeader::ref_from_prefix(&buf[..]).unwrap(); + let body_len = header.len.get() as usize; + if body_len > max_packet_size { + return Some(Err(TunnelError::InvalidPacket("body too long".to_owned()))); + } + + if body_len < PEER_MANAGER_HEADER_SIZE { + return Some(Err(TunnelError::InvalidPacket("body too short".to_owned()))); + } + + if buf.len() < TCP_TUNNEL_HEADER_SIZE + body_len { + return None; + } + + let packet_buf = buf.split_to(TCP_TUNNEL_HEADER_SIZE + body_len); + Some(Ok(ZCPacket::new_from_buf(packet_buf, ZCPacketType::TCP))) + } +} + +impl Stream for FramedReader +where + R: AsyncRead + Send + 'static + Unpin, +{ + type Item = StreamItem; + + fn poll_next( + self: Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> Poll> { + let mut this = self.project(); + + loop { + if let Some(error) = this.error.as_ref() { + tracing::warn!("poll_next on a failed FramedReader, {:?}", error); + return Poll::Ready(None); + } + + if let Some(packet) = Self::extract_one_packet(this.buf, *this.max_packet_size) { + if let Err(TunnelError::InvalidPacket(msg)) = packet.as_ref() { + this.error.replace(TunnelError::InvalidPacket(msg.clone())); + } + return Poll::Ready(Some(packet)); + } + + reserve_buf(this.buf, *this.max_packet_size, *this.max_packet_size * 2); + + let cap = this.buf.capacity() - this.buf.len(); + let buf = this.buf.chunk_mut().as_mut_ptr(); + let buf = unsafe { std::slice::from_raw_parts_mut(buf, cap) }; + let mut buf = ReadBuf::new(buf); + + let ret = ready!(this.reader.as_mut().poll_read(cx, &mut buf)); + let len = buf.filled().len(); + unsafe { this.buf.advance_mut(len) }; + + match ret { + Ok(_) if len == 0 => return Poll::Ready(None), + Ok(_) => {} + Err(error) => return Poll::Ready(Some(Err(TunnelError::IOError(error)))), + } + } + } +} + +pub trait ZCPacketToBytes { + fn zcpacket_into_bytes(&self, zc_packet: ZCPacket) -> Result; +} + +pub struct TcpZCPacketToBytes; + +impl ZCPacketToBytes for TcpZCPacketToBytes { + fn zcpacket_into_bytes(&self, item: ZCPacket) -> Result { + let mut item = item.convert_type(ZCPacketType::TCP); + + let tcp_len = PEER_MANAGER_HEADER_SIZE + item.payload_len(); + let Some(header) = item.mut_tcp_tunnel_header() else { + return Err(TunnelError::InvalidPacket("packet too short".to_owned())); + }; + header.len.set(tcp_len.try_into().unwrap()); + + Ok(item.into_bytes()) + } +} + +struct SendBufs { + bufs: VecDeque, +} + +impl SendBufs { + fn new() -> Self { + Self { + bufs: VecDeque::new(), + } + } + + fn len(&self) -> usize { + self.bufs.len() + } + + fn push(&mut self, buf: Bytes) { + debug_assert!(buf.has_remaining()); + self.bufs.push_back(buf); + } +} + +impl Buf for SendBufs { + fn remaining(&self) -> usize { + self.bufs.iter().map(Buf::remaining).sum() + } + + fn chunk(&self) -> &[u8] { + self.bufs.front().map(Buf::chunk).unwrap_or_default() + } + + fn advance(&mut self, mut cnt: usize) { + while cnt > 0 { + let Some(front) = self.bufs.front_mut() else { + return; + }; + let rem = front.remaining(); + if rem > cnt { + front.advance(cnt); + return; + } + front.advance(rem); + cnt -= rem; + self.bufs.pop_front(); + } + } + + fn chunks_vectored<'a>(&'a self, dst: &mut [IoSlice<'a>]) -> usize { + if dst.is_empty() { + return 0; + } + + let mut count = 0; + for buf in &self.bufs { + count += buf.chunks_vectored(&mut dst[count..]); + if count == dst.len() { + break; + } + } + count + } + + fn copy_to_bytes(&mut self, len: usize) -> Bytes { + match self.bufs.front_mut() { + Some(front) if front.remaining() == len => { + let bytes = front.copy_to_bytes(len); + self.bufs.pop_front(); + bytes + } + Some(front) if front.remaining() > len => front.copy_to_bytes(len), + _ => { + assert!(len <= self.remaining(), "len greater than remaining"); + let mut bytes = BytesMut::with_capacity(len); + bytes.put(self.take(len)); + bytes.freeze() + } + } + } +} + +pin_project! { + pub struct FramedWriter { + #[pin] + writer: W, + sending_bufs: SendBufs, + _associate_data: Option>, + converter: C, + } +} + +impl FramedWriter { + fn max_buffer_count(&self) -> usize { + 64 + } +} + +impl FramedWriter { + pub fn new(writer: W) -> Self { + Self::new_with_associate_data(writer, None) + } + + pub fn new_with_associate_data( + writer: W, + associate_data: Option>, + ) -> Self { + Self { + writer, + sending_bufs: SendBufs::new(), + _associate_data: associate_data, + converter: TcpZCPacketToBytes, + } + } +} + +impl FramedWriter { + pub fn new_with_converter(writer: W, converter: C) -> Self { + Self::new_with_converter_and_associate_data(writer, converter, None) + } + + pub fn new_with_converter_and_associate_data( + writer: W, + converter: C, + associate_data: Option>, + ) -> Self { + Self { + writer, + sending_bufs: SendBufs::new(), + _associate_data: associate_data, + converter, + } + } +} + +impl Sink for FramedWriter +where + W: AsyncWrite + Send + 'static, + C: ZCPacketToBytes + Send + 'static, +{ + type Error = SinkError; + + fn poll_ready( + mut self: Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> Poll> { + let max_buffer_count = self.max_buffer_count(); + if self.sending_bufs.len() >= max_buffer_count { + self.as_mut().poll_flush(cx) + } else { + tracing::trace!(bufs_cnt = self.sending_bufs.len(), "ready to send"); + Poll::Ready(Ok(())) + } + } + + fn start_send(self: Pin<&mut Self>, item: SinkItem) -> Result<(), Self::Error> { + let this = self.project(); + this.sending_bufs + .push(this.converter.zcpacket_into_bytes(item)?); + Ok(()) + } + + fn poll_flush( + self: Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> Poll> { + let mut this = self.project(); + let mut remaining = this.sending_bufs.remaining(); + while remaining != 0 { + let n = ready!(poll_write_buf(this.writer.as_mut(), cx, this.sending_bufs))?; + if n == 0 { + return Poll::Ready(Err(TunnelError::IOError(std::io::Error::new( + std::io::ErrorKind::WriteZero, + "failed to write frame to transport", + )))); + } + remaining -= n; + } + + tracing::trace!(?remaining, "flushed"); + ready!(this.writer.poll_flush(cx))?; + Poll::Ready(Ok(())) + } + + fn poll_close( + mut self: Pin<&mut Self>, + cx: &mut std::task::Context<'_>, + ) -> Poll> { + ready!(self.as_mut().poll_flush(cx))?; + ready!(self.project().writer.poll_shutdown(cx))?; + Poll::Ready(Ok(())) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn framed_reader_rejects_short_peer_manager_body() { + let mut buf = BytesMut::new(); + buf.put_u32_le((PEER_MANAGER_HEADER_SIZE - 1) as u32); + buf.resize(TCP_TUNNEL_HEADER_SIZE + PEER_MANAGER_HEADER_SIZE - 1, 0); + + let ret = FramedReader::::extract_one_packet(&mut buf, 2000); + + assert!(matches!( + ret, + Some(Err(TunnelError::InvalidPacket(msg))) if msg == "body too short" + )); + } + + #[test] + fn send_bufs_exposes_all_queued_buffers_for_vectored_write() { + let mut bufs = SendBufs::new(); + bufs.push(Bytes::from_static(b"abc")); + bufs.push(Bytes::from_static(b"defg")); + + let mut slices = [IoSlice::new(&[]); 4]; + let count = bufs.chunks_vectored(&mut slices); + + assert_eq!(count, 2); + assert_eq!(&*slices[0], b"abc"); + assert_eq!(&*slices[1], b"defg"); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/host_tunnel.rs b/vendor/easytier/easytier-core/src/tunnel/host_tunnel.rs new file mode 100644 index 0000000..5f65ccb --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/host_tunnel.rs @@ -0,0 +1,221 @@ +//! EasyTier message tunnel over a host-owned transport. + +use std::{io, sync::Arc}; + +use futures::{sink, stream}; +use url::Url; + +use crate::{ + host::{ + socket::{HostSocketHandle, HostSocketRuntime}, + tunnel::{HostTunnelIo, MAX_HOST_TUNNEL_PAYLOAD_LEN}, + }, + packet::{ZCPacket, ZCPacketType}, + proto::common::TunnelInfo, +}; + +use super::{Tunnel, TunnelError, wrapper::TunnelWrapper}; + +struct HostTunnelResource { + io: Arc, + handle: HostSocketHandle, +} + +impl Drop for HostTunnelResource { + fn drop(&mut self) { + let _ = self.io.close(self.handle); + } +} + +/// Builds a message-preserving EasyTier tunnel around a host-owned transport. +pub fn new_host_tunnel( + runtime: HostSocketRuntime, + io: Arc, + handle: HostSocketHandle, + local_url: Url, + remote_url: Url, + resolved_remote_url: Option, +) -> Box { + let resource = Arc::new(HostTunnelResource { io, handle }); + let reader_resource = resource.clone(); + let reader_runtime = runtime.clone(); + let reader = stream::unfold( + (reader_runtime, reader_resource), + |(runtime, resource)| async move { + let result = runtime + .run_operation( + resource.io.clone(), + |io, operation| { + io.submit_receive(resource.handle, operation, MAX_HOST_TUNNEL_PAYLOAD_LEN) + }, + |io, operation| io.take_receive(operation), + |io, operation| io.cancel_operation(operation), + ) + .await; + let item = match result { + Ok(message) => Ok(ZCPacket::new_from_buf( + bytes::BytesMut::from(message.as_slice()), + ZCPacketType::DummyTunnel, + )), + Err(error) if error.kind() == io::ErrorKind::UnexpectedEof => return None, + Err(error) => Err(TunnelError::IOError(error)), + }; + Some((item, (runtime, resource))) + }, + ); + + let writer = sink::unfold( + (runtime, resource), + |(runtime, resource), packet: ZCPacket| async move { + let payload = packet.tunnel_payload_bytes(); + runtime + .run_operation( + resource.io.clone(), + |io, operation| io.submit_send(resource.handle, operation, &payload), + |io, operation| io.take_send(operation), + |io, operation| io.cancel_operation(operation), + ) + .await + .map_err(TunnelError::IOError)?; + Ok((runtime, resource)) + }, + ); + + let remote_addr = remote_url.clone().into(); + let resolved_remote_addr = resolved_remote_url + .unwrap_or_else(|| remote_url.clone()) + .into(); + let info = TunnelInfo { + tunnel_type: local_url.scheme().to_owned(), + local_addr: Some(local_url.into()), + remote_addr: Some(remote_addr), + resolved_remote_addr: Some(resolved_remote_addr), + }; + Box::new(TunnelWrapper::new(reader, writer, Some(info))) +} + +#[cfg(test)] +mod tests { + use std::{ + collections::{HashMap, VecDeque}, + sync::{ + Mutex, + atomic::{AtomicUsize, Ordering}, + }, + task::Poll, + }; + + use futures::{SinkExt as _, StreamExt as _}; + + use super::*; + use crate::host::socket::{HostOperationId, HostSocketIo}; + + #[derive(Default)] + struct MockTunnelIo { + incoming: Mutex>>>, + receives: Mutex>>>, + sends: Mutex>>, + sent: Mutex>>, + closes: AtomicUsize, + } + + impl HostSocketIo for MockTunnelIo { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.receives.lock().unwrap().remove(&operation); + self.sends.lock().unwrap().remove(&operation); + Ok(()) + } + + fn close(&self, _handle: HostSocketHandle) -> io::Result<()> { + self.closes.fetch_add(1, Ordering::SeqCst); + Ok(()) + } + } + + impl HostTunnelIo for MockTunnelIo { + fn submit_receive( + &self, + _handle: HostSocketHandle, + operation: HostOperationId, + _capacity: usize, + ) -> io::Result<()> { + let result = self.incoming.lock().unwrap().pop_front().unwrap(); + self.receives.lock().unwrap().insert(operation, result); + Ok(()) + } + + fn take_receive(&self, operation: HostOperationId) -> Poll>> { + Poll::Ready(self.receives.lock().unwrap().remove(&operation).unwrap()) + } + + fn submit_send( + &self, + _handle: HostSocketHandle, + operation: HostOperationId, + source: &[u8], + ) -> io::Result<()> { + self.sends + .lock() + .unwrap() + .insert(operation, source.to_vec()); + Ok(()) + } + + fn take_send(&self, operation: HostOperationId) -> Poll> { + let message = self.sends.lock().unwrap().remove(&operation).unwrap(); + self.sent.lock().unwrap().push(message); + Poll::Ready(Ok(())) + } + } + + fn tunnel(io: Arc) -> Box { + new_host_tunnel( + HostSocketRuntime::new(), + io, + HostSocketHandle(7), + Url::parse("test-tunnel://relay.example/").unwrap(), + Url::parse("test-tunnel://client.example/").unwrap(), + None, + ) + } + + #[test] + fn preserves_message_boundaries_and_closes_once() { + let io = Arc::new(MockTunnelIo::default()); + io.incoming.lock().unwrap().push_back(Ok(vec![1, 2, 3])); + io.incoming.lock().unwrap().push_back(Ok(vec![8, 9])); + let tunnel = tunnel(io.clone()); + assert_eq!(tunnel.info().unwrap().tunnel_type, "test-tunnel"); + let (mut reader, mut writer) = tunnel.split(); + + let first = futures::executor::block_on(reader.next()).unwrap().unwrap(); + let second = futures::executor::block_on(reader.next()).unwrap().unwrap(); + assert_eq!(first.tunnel_payload(), &[1, 2, 3]); + assert_eq!(second.tunnel_payload(), &[8, 9]); + + let packet = ZCPacket::new_from_buf( + bytes::BytesMut::from(&[4, 5, 6][..]), + ZCPacketType::DummyTunnel, + ); + futures::executor::block_on(writer.send(packet)).unwrap(); + assert_eq!(*io.sent.lock().unwrap(), vec![vec![4, 5, 6]]); + + drop(tunnel); + drop(reader); + drop(writer); + assert_eq!(io.closes.load(Ordering::SeqCst), 1); + } + + #[test] + fn maps_clean_remote_close_to_stream_eof() { + let io = Arc::new(MockTunnelIo::default()); + io.incoming + .lock() + .unwrap() + .push_back(Err(io::Error::new(io::ErrorKind::UnexpectedEof, "closed"))); + let tunnel = tunnel(io); + let (mut reader, _writer) = tunnel.split(); + + assert!(futures::executor::block_on(reader.next()).is_none()); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/mod.rs b/vendor/easytier/easytier-core/src/tunnel/mod.rs new file mode 100644 index 0000000..7ccc816 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/mod.rs @@ -0,0 +1,100 @@ +//! Shared tunnel contract and per-transport tunnel implementations. +//! +//! This root file declares the shared tunnel contract: [`TunnelError`], the +//! [`Tunnel`] trait, and the [`ZCPacket`] stream/sink aliases that tunnels +//! carry. The sibling files in this directory hold the per-transport tunnel +//! implementations (TCP, UDP, ring, mpsc), the filters and wrappers layered +//! on top of them, and the packet encryption primitives (`encrypt`, +//! `secure_datagram`) shared by tunnels and peer sessions. + +use std::{fmt::Debug, pin::Pin}; + +use futures::{Sink, Stream}; + +use crate::{foundation::time::error::Elapsed, packet::ZCPacket, proto::common::TunnelInfo}; + +pub use crate::socket::IpVersion; + +pub mod buf; +pub(crate) mod encrypt; +pub mod filter; +pub mod framed; +pub mod host_tunnel; +pub mod mpsc; +pub mod ring; +pub(crate) mod secure_datagram; +pub mod stats; +pub mod tcp; +pub mod udp; +pub mod web_security; +pub mod wrapper; + +/// Reports whether the configured name resolves to the insecure XOR cipher. +pub fn effective_encryption_uses_xor(algorithm: &str) -> bool { + encrypt::effective_algorithm_uses_xor(algorithm) +} + +#[derive(Debug, thiserror::Error)] +pub enum TunnelError { + #[error("io error: {0}")] + IOError(#[from] std::io::Error), + #[error("invalid packet. msg: {0}")] + InvalidPacket(String), + #[error("exceed max packet size. max: {0}, input: {1}")] + ExceedMaxPacketSize(usize, usize), + #[error("invalid protocol: {0}")] + InvalidProtocol(String), + #[error("invalid addr: {0}")] + InvalidAddr(String), + #[error("internal error {0}")] + InternalError(String), + #[error("conn id not match, expect: {0}, actual: {1}")] + ConnIdNotMatch(u32, u32), + #[error("buffer full")] + BufferFull, + #[error("timeout")] + Timeout(#[from] Elapsed), + #[error("anyhow error: {0}")] + Anyhow(#[from] anyhow::Error), + #[error("shutdown")] + Shutdown, + #[error("no dns record found")] + NoDnsRecordFound(IpVersion), + #[error("{0}")] + ProtocolError(String), + #[error("tunnel error: {0}")] + TunError(String), +} + +impl From for crate::proto::rpc_types::error::Error { + fn from(value: TunnelError) -> Self { + Self::TunnelError(value.to_string()) + } +} + +pub type StreamT = ZCPacket; +pub type StreamItem = Result; +pub type SinkItem = ZCPacket; +pub type SinkError = TunnelError; + +pub trait ZCPacketStream: Stream + Send {} +impl ZCPacketStream for T where T: Stream + Send {} + +pub trait ZCPacketSink: Sink + Send {} +impl ZCPacketSink for T where T: Sink + Send {} + +pub type SplitTunnel = (Pin>, Pin>); + +#[auto_impl::auto_impl(Box, Arc)] +pub trait Tunnel: Send { + fn split(&self) -> SplitTunnel; + fn info(&self) -> Option; +} + +impl std::fmt::Debug for dyn Tunnel { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("Tunnel") + .field("info", &self.info()) + .finish() + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/mpsc.rs b/vendor/easytier/easytier-core/src/tunnel/mpsc.rs new file mode 100644 index 0000000..72267c3 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/mpsc.rs @@ -0,0 +1,175 @@ +use std::{pin::Pin, time::Duration}; + +use futures::SinkExt; +use tokio::{ + sync::mpsc::{Receiver, Sender, channel, error::TrySendError}, + task::JoinHandle, +}; + +use crate::{ + foundation::time::timeout, + packet::ZCPacket, + proto::common::TunnelInfo, + tunnel::{Tunnel, TunnelError, ZCPacketSink, ZCPacketStream}, +}; + +#[derive(Clone)] +pub struct MpscTunnelSender(Sender); + +impl MpscTunnelSender { + pub async fn send(&self, item: ZCPacket) -> Result<(), TunnelError> { + match self.0.try_send(item) { + Ok(()) => Ok(()), + Err(TrySendError::Full(item)) => { + self.0.send(item).await.map_err(|_| TunnelError::Shutdown) + } + Err(TrySendError::Closed(_)) => Err(TunnelError::Shutdown), + } + } + + pub fn try_send(&self, item: ZCPacket) -> Result<(), TunnelError> { + self.0.try_send(item).map_err(|e| match e { + TrySendError::Full(_) => TunnelError::BufferFull, + TrySendError::Closed(_) => TunnelError::Shutdown, + }) + } +} + +pub struct MpscTunnel { + tx: Option>, + tunnel: T, + stream: Option>>, + task: JoinHandle<()>, +} + +impl MpscTunnel { + pub fn new(tunnel: T, send_timeout: Option) -> Self { + let (tx, mut rx) = channel(32); + let (stream, mut sink) = tunnel.split(); + + let task = tokio::spawn(async move { + loop { + if let Err(e) = Self::forward_one_round(&mut rx, &mut sink, send_timeout).await { + tracing::error!(?e, "forward error"); + break; + } + } + rx.close(); + let close_ret = timeout(Duration::from_secs(5), sink.close()).await; + tracing::warn!(?close_ret, "mpsc close sink"); + }); + + Self { + tx: Some(tx), + tunnel, + stream: Some(stream), + task, + } + } + + async fn forward_one_round( + rx: &mut Receiver, + sink: &mut Pin>, + send_timeout_ms: Option, + ) -> Result<(), TunnelError> { + let item = rx.recv().await.ok_or(TunnelError::Shutdown)?; + if let Some(timeout_ms) = send_timeout_ms { + Self::forward_one_round_with_timeout(rx, sink, item, timeout_ms).await + } else { + Self::forward_one_round_no_timeout(rx, sink, item).await + } + } + + async fn forward_one_round_no_timeout( + rx: &mut Receiver, + sink: &mut Pin>, + initial_item: ZCPacket, + ) -> Result<(), TunnelError> { + sink.feed(initial_item).await?; + + while let Ok(item) = rx.try_recv() { + if let Err(e) = sink.feed(item).await { + tracing::error!(?e, "feed error"); + return Err(e); + } + } + + sink.flush().await + } + + async fn forward_one_round_with_timeout( + rx: &mut Receiver, + sink: &mut Pin>, + initial_item: ZCPacket, + timeout_ms: Duration, + ) -> Result<(), TunnelError> { + match timeout(timeout_ms, async move { + Self::forward_one_round_no_timeout(rx, sink, initial_item).await + }) + .await + { + Ok(Ok(_)) => Ok(()), + Ok(Err(e)) => { + tracing::error!(?e, "forward error"); + Err(e) + } + Err(e) => { + tracing::error!(?e, "forward timeout"); + Err(e.into()) + } + } + } + + pub fn get_stream(&mut self) -> Pin> { + self.stream.take().unwrap() + } + + pub fn get_sink(&self) -> MpscTunnelSender { + MpscTunnelSender(self.tx.as_ref().unwrap().clone()) + } + + pub fn close(&mut self) { + self.tx.take(); + self.task.abort(); + } + + pub fn tunnel_info(&self) -> Option { + self.tunnel.info() + } +} + +impl Drop for MpscTunnel { + fn drop(&mut self) { + self.task.abort(); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[tokio::test] + async fn sender_falls_back_to_waiting_when_channel_is_full() { + let (tx, mut rx) = channel(1); + let sender = MpscTunnelSender(tx); + sender + .send(ZCPacket::new_with_payload(b"first")) + .await + .unwrap(); + + let blocked_send = sender.send(ZCPacket::new_with_payload(b"second")); + tokio::pin!(blocked_send); + assert!( + tokio::time::timeout(Duration::from_millis(10), &mut blocked_send) + .await + .is_err() + ); + + assert_eq!(rx.recv().await.unwrap().payload(), b"first"); + tokio::time::timeout(Duration::from_secs(1), &mut blocked_send) + .await + .unwrap() + .unwrap(); + assert_eq!(rx.recv().await.unwrap().payload(), b"second"); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/ring.rs b/vendor/easytier/easytier-core/src/tunnel/ring.rs new file mode 100644 index 0000000..5108677 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/ring.rs @@ -0,0 +1,591 @@ +use std::{ + collections::HashMap, + fmt::Debug, + io, + pin::Pin, + sync::{Arc, Mutex}, + task::{Context, Poll, ready}, +}; + +use async_trait::async_trait; +use futures::{Sink, Stream}; +use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; +use tokio::sync::mpsc::{UnboundedReceiver, UnboundedSender, unbounded_channel}; + +use crate::{ + proto::common::TunnelInfo, + socket::{ + SocketListener, + ring::{ + RING_SOCKET_CAPACITY, RingSocket, RingSocketId, RingSocketReceiver, + RingSocketSendError, RingSocketSender, + }, + }, + tunnel::{SinkError, SinkItem, StreamItem, Tunnel, TunnelError, ZCPacketSink, ZCPacketStream}, +}; + +pub const RING_TUNNEL_CAP: usize = RING_SOCKET_CAPACITY; + +type RingItem = SinkItem; +pub type RingTunnelSocket = RingSocket; +pub type RingSinkSendError = RingSocketSendError; + +pub struct RingByteStream { + receiver: RingSocketReceiver, + sender: RingSocketSender, + buffered: Option<(RingItem, usize)>, +} + +impl RingByteStream { + pub fn new(socket: Arc) -> io::Result { + let (receiver, sender) = socket + .try_split() + .map_err(|error| io::Error::other(error.to_string()))?; + Ok(Self { + receiver, + sender, + buffered: None, + }) + } +} + +impl AsyncRead for RingByteStream { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buffer: &mut ReadBuf<'_>, + ) -> Poll> { + if buffer.remaining() == 0 { + return Poll::Ready(Ok(())); + } + loop { + if let Some((packet, offset)) = &mut self.buffered { + if *offset == packet.payload().len() { + self.buffered = None; + continue; + } + let remaining = &packet.payload()[*offset..]; + let copy_len = remaining.len().min(buffer.remaining()); + buffer.put_slice(&remaining[..copy_len]); + *offset += copy_len; + return Poll::Ready(Ok(())); + } + + match ready!(Pin::new(&mut self.receiver).poll_next(cx)) { + Some(Ok(packet)) => self.buffered = Some((packet, 0)), + Some(Err(error)) => return Poll::Ready(Err(io::Error::other(error.to_string()))), + None => return Poll::Ready(Ok(())), + } + } + } +} + +impl AsyncWrite for RingByteStream { + fn poll_write( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buffer: &[u8], + ) -> Poll> { + if buffer.is_empty() { + return Poll::Ready(Ok(0)); + } + ready!(Pin::new(&mut self.sender).poll_ready(cx)) + .map_err(|error| io::Error::other(error.to_string()))?; + Pin::new(&mut self.sender) + .start_send(crate::packet::ZCPacket::new_with_payload(buffer)) + .map_err(|error| io::Error::other(error.to_string()))?; + Poll::Ready(Ok(buffer.len())) + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.sender) + .poll_flush(cx) + .map_err(|error| io::Error::other(error.to_string())) + } + + fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.sender) + .poll_close(cx) + .map_err(|error| io::Error::other(error.to_string())) + } +} + +#[derive(Debug, thiserror::Error)] +pub enum RingTunnelRegistryError { + #[error("ring listener already registered: {0}")] + AlreadyRegistered(RingSocketId), + #[error("ring listener not found: {0}")] + NotFound(RingSocketId), + #[error("ring listener closed: {0}")] + Closed(RingSocketId), + #[error("ring listener {listener_id} received socket for {socket_id}")] + SocketIdMismatch { + listener_id: RingSocketId, + socket_id: RingSocketId, + }, +} + +struct PendingRingConnection { + client: Arc, + server: Arc, +} + +type ConnectionMap = HashMap>>; + +#[derive(Default)] +pub(crate) struct RingTunnelRegistry { + connections: Mutex, +} + +impl RingTunnelRegistry { + pub(crate) fn bind( + self: &Arc, + local_id: RingSocketId, + ) -> Result { + let (conn_sender, conn_receiver) = unbounded_channel(); + let mut connections = self.connections.lock().unwrap(); + if connections.contains_key(&local_id) { + return Err(RingTunnelRegistryError::AlreadyRegistered(local_id)); + } + + connections.insert(local_id, conn_sender.clone()); + Ok(RingTunnelSocketListener { + registry: self.clone(), + local_id, + conn_sender, + conn_receiver, + }) + } + + pub(crate) fn connect( + &self, + remote_id: RingSocketId, + ) -> Result { + let conn_sender = self + .connections + .lock() + .unwrap() + .get(&remote_id) + .cloned() + .ok_or(RingTunnelRegistryError::NotFound(remote_id))?; + let (client, server) = + RingSocket::pair_with_ids(uuid::Uuid::new_v4(), remote_id, RING_TUNNEL_CAP); + let conn = Arc::new(PendingRingConnection { + client: client.clone(), + server, + }); + + conn_sender + .send(conn) + .map_err(|_| RingTunnelRegistryError::Closed(remote_id))?; + + Ok(DialedRingSocket { + local_id: client.id(), + socket: client, + remote_id, + }) + } +} + +pub struct AcceptedRingSocket { + pub socket: Arc, + pub local_id: RingSocketId, + pub remote_id: RingSocketId, +} + +impl AcceptedRingSocket { + pub fn into_tunnel(self) -> Box { + Box::new(RingTunnel::new( + self.socket, + Some(ring_tunnel_info(self.local_id, self.remote_id)), + )) + } +} + +pub struct DialedRingSocket { + pub socket: Arc, + pub local_id: RingSocketId, + pub remote_id: RingSocketId, +} + +impl DialedRingSocket { + pub fn into_tunnel(self) -> Box { + Box::new(RingTunnel::new( + self.socket, + Some(ring_tunnel_info(self.local_id, self.remote_id)), + )) + } +} + +pub struct RingTunnelSocketListener { + registry: Arc, + local_id: RingSocketId, + conn_sender: UnboundedSender>, + conn_receiver: UnboundedReceiver>, +} + +impl Debug for RingTunnelSocketListener { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("RingTunnelSocketListener") + .field("local_id", &self.local_id) + .finish_non_exhaustive() + } +} + +impl RingTunnelSocketListener { + pub fn local_id(&self) -> RingSocketId { + self.local_id + } + + pub async fn accept(&mut self) -> Result { + let conn = self + .conn_receiver + .recv() + .await + .ok_or(RingTunnelRegistryError::Closed(self.local_id))?; + + let socket_id = conn.server.id(); + if socket_id != self.local_id { + return Err(RingTunnelRegistryError::SocketIdMismatch { + listener_id: self.local_id, + socket_id, + }); + } + + Ok(AcceptedRingSocket { + socket: conn.server.clone(), + local_id: self.local_id, + remote_id: conn.client.id(), + }) + } +} + +#[async_trait] +impl SocketListener for RingTunnelSocketListener { + type Accepted = Box; + + async fn listen(&mut self) -> anyhow::Result<()> { + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + Ok(RingTunnelSocketListener::accept(self).await?.into_tunnel()) + } + + fn local_url(&self) -> url::Url { + ring_url(self.local_id) + } +} + +impl Drop for RingTunnelSocketListener { + fn drop(&mut self) { + let mut connections = self.registry.connections.lock().unwrap(); + if connections + .get(&self.local_id) + .is_some_and(|sender| sender.same_channel(&self.conn_sender)) + { + connections.remove(&self.local_id); + } + } +} + +pub struct RingStream { + id: RingSocketId, + inner: RingSocketReceiver, +} + +impl RingStream { + pub fn new(inner: RingSocketReceiver, id: RingSocketId) -> Self { + Self { id, inner } + } +} + +impl Stream for RingStream { + type Item = StreamItem; + + fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let ret = std::task::ready!(Pin::new(&mut self.get_mut().inner).poll_next(cx)); + Poll::Ready(ret.map(|item| item.map_err(|_| TunnelError::Shutdown))) + } +} + +impl Debug for RingStream { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("RingStream") + .field("id", &self.id) + .finish_non_exhaustive() + } +} + +pub struct RingSink { + id: RingSocketId, + inner: RingSocketSender, +} + +impl RingSink { + pub fn new(inner: RingSocketSender, id: RingSocketId) -> Self { + Self { id, inner } + } + + pub fn try_send(&mut self, item: RingItem) -> Result<(), RingSinkSendError> { + self.inner.try_send(item) + } + + pub fn force_send(&mut self, item: RingItem) -> Result<(), RingSinkSendError> { + self.inner.force_send(item) + } +} + +fn map_ring_send_error(error: RingSinkSendError) -> TunnelError { + match error { + RingSocketSendError::Closed(_) => TunnelError::Shutdown, + RingSocketSendError::Full(_) => TunnelError::BufferFull, + } +} + +impl Sink for RingSink { + type Error = SinkError; + + fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.get_mut().inner) + .poll_ready(cx) + .map_err(|_| TunnelError::Shutdown) + } + + fn start_send(self: Pin<&mut Self>, item: SinkItem) -> Result<(), Self::Error> { + self.get_mut() + .inner + .force_send(item) + .map_err(map_ring_send_error) + } + + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.get_mut().inner) + .poll_flush(cx) + .map_err(|_| TunnelError::Shutdown) + } + + fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.get_mut().inner) + .poll_close(cx) + .map_err(|_| TunnelError::Shutdown) + } +} + +impl Debug for RingSink { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("RingSink") + .field("id", &self.id) + .finish_non_exhaustive() + } +} + +pub fn create_ring_socket_pair(capacity: usize) -> (Arc, Arc) { + RingSocket::pair(capacity) +} + +pub fn split_ring_socket(socket: Arc) -> (RingStream, RingSink) { + let id = socket.id(); + let (recv, send) = socket.split(); + (RingStream::new(recv, id), RingSink::new(send, id)) +} + +pub struct RingTunnel { + socket: Arc, + info: Option, +} + +impl RingTunnel { + pub fn new(socket: Arc, info: Option) -> Self { + Self { socket, info } + } + + pub fn socket(&self) -> Arc { + self.socket.clone() + } +} + +impl Debug for RingTunnel { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("RingTunnel") + .field("socket", &self.socket) + .field("info", &self.info) + .finish() + } +} + +impl Tunnel for RingTunnel { + fn split(&self) -> (Pin>, Pin>) { + let (stream, sink) = split_ring_socket(self.socket.clone()); + (Box::pin(stream), Box::pin(sink)) + } + + fn info(&self) -> Option { + self.info.clone() + } +} + +fn ring_tunnel_info(local_id: RingSocketId, remote_id: RingSocketId) -> TunnelInfo { + TunnelInfo { + tunnel_type: "ring".to_owned(), + local_addr: Some(ring_url(local_id).into()), + remote_addr: Some(ring_url(remote_id).into()), + resolved_remote_addr: Some(ring_url(remote_id).into()), + } +} + +fn ring_url(id: RingSocketId) -> url::Url { + format!("ring://{id}") + .parse() + .expect("ring socket id should form a valid URL") +} + +pub fn create_ring_tunnel_pair() -> (Box, Box) { + let (first, second) = create_ring_socket_pair(RING_TUNNEL_CAP); + ( + Box::new(RingTunnel::new(first, None)), + Box::new(RingTunnel::new(second, None)), + ) +} + +#[cfg(test)] +mod tests { + use futures::{SinkExt, StreamExt}; + use tokio::{ + io::{AsyncReadExt, AsyncWriteExt}, + time::{Duration, timeout}, + }; + + use crate::packet::ZCPacket; + + use super::*; + + #[tokio::test] + async fn explicit_registries_isolate_ring_listener_namespaces() { + let listener_id = uuid::Uuid::new_v4(); + let first = Arc::new(RingTunnelRegistry::default()); + let second = Arc::new(RingTunnelRegistry::default()); + let mut listener = first.bind(listener_id).unwrap(); + + assert!(matches!( + second.connect(listener_id), + Err(RingTunnelRegistryError::NotFound(id)) if id == listener_id + )); + + let dialed = first.connect(listener_id).unwrap(); + let accepted = listener.accept().await.unwrap(); + assert_eq!(dialed.remote_id, listener_id); + assert_eq!(accepted.local_id, listener_id); + assert_eq!(accepted.remote_id, dialed.local_id); + + drop(listener); + assert!(matches!( + first.connect(listener_id), + Err(RingTunnelRegistryError::NotFound(id)) if id == listener_id + )); + } + + #[tokio::test] + async fn registry_endpoints_upgrade_to_packet_native_tunnels() { + let listener_id = uuid::Uuid::new_v4(); + let registry = Arc::new(RingTunnelRegistry::default()); + let mut listener = registry.bind(listener_id).unwrap(); + let client = registry.connect(listener_id).unwrap().into_tunnel(); + let server = listener.accept().await.unwrap().into_tunnel(); + let (_client_stream, mut client_sink) = client.split(); + let (mut server_stream, _server_sink) = server.split(); + + client_sink + .send(ZCPacket::new_with_payload(b"packet-native")) + .await + .unwrap(); + let packet = server_stream.next().await.unwrap().unwrap(); + assert_eq!(packet.payload(), b"packet-native"); + assert_eq!(client.info().unwrap().tunnel_type, "ring"); + } + + #[tokio::test] + async fn ring_tunnel_pair_transfers_packets() { + let (left, right) = create_ring_tunnel_pair(); + let (_left_stream, mut left_sink) = left.split(); + let (mut right_stream, _right_sink) = right.split(); + + let packet = ZCPacket::new_with_payload(&[1, 2, 3]); + left_sink.send(packet.clone()).await.unwrap(); + + let received = right_stream.next().await.unwrap().unwrap(); + assert_eq!(received.payload(), packet.payload()); + } + + #[tokio::test] + async fn ring_tunnel_observes_remote_close() { + let (left, right) = create_ring_tunnel_pair(); + drop(left); + + let (mut right_stream, _right_sink) = right.split(); + assert!(right_stream.next().await.is_none()); + } + + #[tokio::test] + async fn ring_stream_can_be_aborted_while_waiting() { + let (_left, right) = create_ring_tunnel_pair(); + let (mut right_stream, _right_sink) = right.split(); + let task = tokio::spawn(async move { right_stream.next().await }); + + tokio::task::yield_now().await; + task.abort(); + assert!(task.await.unwrap_err().is_cancelled()); + } + + #[tokio::test] + async fn ring_stream_wait_can_time_out() { + let (_left, right) = create_ring_tunnel_pair(); + let (mut right_stream, _right_sink) = right.split(); + + assert!( + timeout(Duration::from_millis(10), right_stream.next()) + .await + .is_err() + ); + } + + #[tokio::test] + async fn byte_stream_preserves_bytes_across_partial_reads() { + let (left, right) = RingTunnelSocket::pair(8); + let mut left = RingByteStream::new(left).unwrap(); + let mut right = RingByteStream::new(right).unwrap(); + + timeout(Duration::from_millis(50), right.read(&mut [])) + .await + .expect("zero-capacity read should not wait") + .unwrap(); + left.write_all(b"abcdef").await.unwrap(); + + let mut prefix = [0; 2]; + right.read_exact(&mut prefix).await.unwrap(); + let mut suffix = [0; 4]; + right.read_exact(&mut suffix).await.unwrap(); + assert_eq!(&prefix, b"ab"); + assert_eq!(&suffix, b"cdef"); + } + + #[tokio::test] + async fn byte_stream_skips_empty_packets_without_reporting_eof() { + let (left, right) = RingTunnelSocket::pair(8); + let (_left_receiver, mut left_sender) = left.split(); + let mut right = RingByteStream::new(right).unwrap(); + + left_sender + .send(crate::packet::ZCPacket::new_with_payload(b"")) + .await + .unwrap(); + left_sender + .send(crate::packet::ZCPacket::new_with_payload(b"data")) + .await + .unwrap(); + + let mut received = [0; 4]; + right.read_exact(&mut received).await.unwrap(); + assert_eq!(&received, b"data"); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/secure_datagram.rs b/vendor/easytier/easytier-core/src/tunnel/secure_datagram.rs new file mode 100644 index 0000000..db118a0 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/secure_datagram.rs @@ -0,0 +1,1042 @@ +use std::{ + sync::{ + Arc, Mutex, RwLock, + atomic::{AtomicBool, AtomicU32, Ordering}, + }, + time::{SystemTime, UNIX_EPOCH}, +}; + +use anyhow::anyhow; +use atomic_shim::AtomicU64; +use hmac::{Hmac, Mac as _}; +use rand::RngCore as _; +use sha2::Sha256; +use zerocopy::FromBytes; + +use crate::{ + packet::{StandardAeadTail, ZCPacket}, + tunnel::encrypt::{Encryptor, create_encryptor}, +}; + +type HmacSha256 = Hmac; + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum SecureDatagramDirection { + AToB, + BToA, +} + +impl SecureDatagramDirection { + fn idx(self) -> usize { + match self { + Self::AToB => 0, + Self::BToA => 1, + } + } +} + +#[derive(Clone, Default)] +struct EpochKeySlot { + epoch: u32, + generation: u32, + valid: bool, + send_cipher: Option>, + recv_cipher: Option>, +} + +impl std::fmt::Debug for EpochKeySlot { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("EpochKeySlot") + .field("epoch", &self.epoch) + .field("generation", &self.generation) + .field("valid", &self.valid) + .finish() + } +} + +impl EpochKeySlot { + fn get_encryptor(&self, is_send: bool) -> Arc { + if is_send { + self.send_cipher.as_ref().unwrap().clone() + } else { + self.recv_cipher.as_ref().unwrap().clone() + } + } +} + +#[derive(Debug, Clone, Copy, Default)] +struct ReplayWindow256 { + max_seq: u64, + bitmap: [u8; 32], + valid: bool, +} + +impl ReplayWindow256 { + fn clear(&mut self) { + self.max_seq = 0; + self.bitmap.fill(0); + self.valid = false; + } + + fn test_bit(&self, idx: usize) -> bool { + let byte = idx / 8; + let bit = idx % 8; + (self.bitmap[byte] >> bit) & 1 == 1 + } + + fn set_bit(&mut self, idx: usize) { + let byte = idx / 8; + let bit = idx % 8; + self.bitmap[byte] |= 1u8 << bit; + } + + fn shift_right(&mut self, shift: usize) { + if shift == 0 { + return; + } + let total_bits = 256usize; + if shift >= total_bits { + self.bitmap.fill(0); + return; + } + + let byte_shift = shift / 8; + let bit_shift = shift % 8; + + if byte_shift > 0 { + for i in (0..self.bitmap.len()).rev() { + self.bitmap[i] = if i >= byte_shift { + self.bitmap[i - byte_shift] + } else { + 0 + }; + } + } + + if bit_shift > 0 { + let mut carry = 0u8; + for b in self.bitmap.iter_mut() { + let new_carry = *b >> (8 - bit_shift); + *b = (*b << bit_shift) | carry; + carry = new_carry; + } + } + } + + fn accept(&mut self, seq: u64) -> bool { + if !self.valid { + self.valid = true; + self.max_seq = seq; + self.set_bit(0); + return true; + } + + if seq > self.max_seq { + let shift = (seq - self.max_seq) as usize; + self.shift_right(shift); + self.max_seq = seq; + self.set_bit(0); + return true; + } + + let delta = (self.max_seq - seq) as usize; + if delta >= 256 { + return false; + } + if self.test_bit(delta) { + return false; + } + self.set_bit(delta); + true + } + + fn can_accept(&self, seq: u64) -> bool { + if !self.valid || seq > self.max_seq { + return true; + } + + let delta = (self.max_seq - seq) as usize; + delta < 256 && !self.test_bit(delta) + } +} + +#[derive(Debug, Clone, Copy, Default)] +struct EpochRxSlot { + epoch: u32, + window: ReplayWindow256, + last_rx_ms: u64, + valid: bool, +} + +impl EpochRxSlot { + fn clear(&mut self) { + self.epoch = 0; + self.window.clear(); + self.last_rx_ms = 0; + self.valid = false; + } +} + +#[derive(Debug, Clone, Copy, Default)] +struct SyncRxGrace { + slots: [[EpochRxSlot; 2]; 2], + expires_at_ms: u64, + valid: bool, +} + +impl SyncRxGrace { + fn clear(&mut self) { + self.slots = [[EpochRxSlot::default(), EpochRxSlot::default()]; 2]; + self.expires_at_ms = 0; + self.valid = false; + } + + fn refresh(&mut self, slots: [[EpochRxSlot; 2]; 2], expires_at_ms: u64) { + self.slots = slots; + self.expires_at_ms = expires_at_ms; + self.valid = true; + } + + fn maybe_expire(&mut self, now_ms: u64) { + if self.valid && now_ms >= self.expires_at_ms { + self.clear(); + } + } +} + +pub struct SecureDatagramSession { + root_key: RwLock<[u8; 32]>, + session_generation: AtomicU32, + + send_epoch: AtomicU32, + send_seq: [AtomicU64; 2], + send_epoch_started_ms: AtomicU64, + send_packets_since_epoch: AtomicU64, + + rx_slots: Mutex<[[EpochRxSlot; 2]; 2]>, + key_cache: Mutex<[[EpochKeySlot; 2]; 2]>, + sync_rx_grace: Mutex, + sync_rx_grace_expires_at_ms: AtomicU64, + + send_cipher_algorithm: String, + recv_cipher_algorithm: String, + + invalidated: AtomicBool, + decrypt_fail_count: AtomicU32, +} + +impl std::fmt::Debug for SecureDatagramSession { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("SecureDatagramSession") + .field("root_key", &self.root_key) + .field("session_generation", &self.session_generation) + .field("send_epoch", &self.send_epoch) + .field("send_seq", &self.send_seq) + .field("send_epoch_started_ms", &self.send_epoch_started_ms) + .field("send_packets_since_epoch", &self.send_packets_since_epoch) + .field("rx_slots", &self.rx_slots) + .field("key_cache", &self.key_cache) + .field("sync_rx_grace", &self.sync_rx_grace) + .field( + "sync_rx_grace_expires_at_ms", + &self.sync_rx_grace_expires_at_ms, + ) + .field("send_cipher_algorithm", &self.send_cipher_algorithm) + .field("recv_cipher_algorithm", &self.recv_cipher_algorithm) + .finish() + } +} + +impl SecureDatagramSession { + const EVICT_IDLE_AFTER_MS: u64 = 30_000; + pub(crate) const SYNC_RX_GRACE_AFTER_MS: u64 = 5_000; + const ROTATE_AFTER_PACKETS: u64 = 1_000_000; + const ROTATE_AFTER_MS: u64 = 10 * 60 * 1000; + const MAX_ACCEPTED_RX_EPOCH_AHEAD: u32 = 3; + const DECRYPT_FAIL_THRESHOLD: u32 = 10; + + pub fn new( + root_key: [u8; 32], + session_generation: u32, + initial_epoch: u32, + send_cipher_algorithm: String, + recv_cipher_algorithm: String, + ) -> Self { + let rx_slots = [ + [EpochRxSlot::default(), EpochRxSlot::default()], + [EpochRxSlot::default(), EpochRxSlot::default()], + ]; + let key_cache = [ + [EpochKeySlot::default(), EpochKeySlot::default()], + [EpochKeySlot::default(), EpochKeySlot::default()], + ]; + let now_ms = now_ms(); + Self { + root_key: RwLock::new(root_key), + session_generation: AtomicU32::new(session_generation), + send_epoch: AtomicU32::new(initial_epoch), + send_seq: [AtomicU64::new(0), AtomicU64::new(0)], + send_epoch_started_ms: AtomicU64::new(now_ms), + send_packets_since_epoch: AtomicU64::new(0), + rx_slots: Mutex::new(rx_slots), + key_cache: Mutex::new(key_cache), + sync_rx_grace: Mutex::new(SyncRxGrace::default()), + sync_rx_grace_expires_at_ms: AtomicU64::new(0), + send_cipher_algorithm, + recv_cipher_algorithm, + invalidated: AtomicBool::new(false), + decrypt_fail_count: AtomicU32::new(0), + } + } + + pub fn invalidate(&self) { + self.invalidated.store(true, Ordering::Relaxed); + } + + pub fn is_valid(&self) -> bool { + !self.invalidated.load(Ordering::Relaxed) + } + + pub fn session_generation(&self) -> u32 { + self.session_generation.load(Ordering::Relaxed) + } + + pub fn root_key(&self) -> [u8; 32] { + *self.root_key.read().unwrap() + } + + pub fn new_root_key() -> [u8; 32] { + let mut out = [0u8; 32]; + rand::rngs::OsRng.fill_bytes(&mut out); + out + } + + pub fn next_sync_epoch(&self) -> u32 { + let send_epoch = self.send_epoch.load(Ordering::Relaxed); + let rx = self.rx_slots.lock().unwrap(); + let mut max_epoch = send_epoch; + for dir in 0..2 { + let cur = rx[dir][0]; + if cur.valid { + max_epoch = max_epoch.max(cur.epoch); + } + let prev = rx[dir][1]; + if prev.valid { + max_epoch = max_epoch.max(prev.epoch); + } + } + max_epoch.wrapping_add(1) + } + + pub fn check_encrypt_algo_same( + &self, + send_algorithm: &str, + recv_algorithm: &str, + ) -> Result<(), anyhow::Error> { + if self.send_cipher_algorithm != send_algorithm + || self.recv_cipher_algorithm != recv_algorithm + { + return Err(anyhow!("encrypt algorithm not same")); + } + Ok(()) + } + + pub fn sync_root_key( + &self, + root_key: [u8; 32], + session_generation: u32, + initial_epoch: u32, + preserve_rx_grace: bool, + ) { + let old_root_key = self.root_key(); + let can_preserve_rx_grace = preserve_rx_grace && old_root_key == root_key; + { + let mut g = self.root_key.write().unwrap(); + *g = root_key; + } + self.session_generation + .store(session_generation, Ordering::Relaxed); + + self.send_epoch.store(initial_epoch, Ordering::Relaxed); + self.send_seq[0].store(0, Ordering::Relaxed); + self.send_seq[1].store(0, Ordering::Relaxed); + self.send_epoch_started_ms + .store(now_ms(), Ordering::Relaxed); + self.send_packets_since_epoch.store(0, Ordering::Relaxed); + + { + let mut rx = self.rx_slots.lock().unwrap(); + let mut sync_rx_grace = self.sync_rx_grace.lock().unwrap(); + if can_preserve_rx_grace { + let expires_at_ms = now_ms().saturating_add(Self::SYNC_RX_GRACE_AFTER_MS); + sync_rx_grace.refresh(*rx, expires_at_ms); + self.sync_rx_grace_expires_at_ms + .store(expires_at_ms, Ordering::Relaxed); + } else { + sync_rx_grace.clear(); + self.sync_rx_grace_expires_at_ms.store(0, Ordering::Relaxed); + } + for dir in 0..2 { + rx[dir][0].clear(); + rx[dir][1].clear(); + } + } + + self.key_cache + .lock() + .unwrap() + .fill([EpochKeySlot::default(), EpochKeySlot::default()]); + } + + fn hkdf_traffic_key(&self, epoch: u32, dir: SecureDatagramDirection) -> [u8; 32] { + let root_key = self.root_key(); + let salt = [0u8; 32]; + let mut extract = HmacSha256::new_from_slice(&salt).unwrap(); + extract.update(&root_key); + let prk = extract.finalize().into_bytes(); + + let mut info = Vec::with_capacity(9 + 4 + 1); + info.extend_from_slice(b"et-traffic"); + info.extend_from_slice(&epoch.to_be_bytes()); + info.push(dir.idx() as u8); + + let mut expand = HmacSha256::new_from_slice(&prk).unwrap(); + expand.update(&info); + expand.update(&[1u8]); + let okm = expand.finalize().into_bytes(); + let mut key = [0u8; 32]; + key.copy_from_slice(&okm[..32]); + key + } + + fn get_or_create_encryptor( + &self, + epoch: u32, + dir: SecureDatagramDirection, + generation: u32, + is_send: bool, + ) -> Arc { + let dir_idx = dir.idx(); + let mut guard = self.key_cache.lock().unwrap(); + for slot in guard[dir_idx].iter_mut() { + if slot.valid && slot.epoch == epoch && slot.generation == generation { + return slot.get_encryptor(is_send); + } + } + + let key = self.hkdf_traffic_key(epoch, dir); + let mut key_128 = [0u8; 16]; + key_128.copy_from_slice(&key[..16]); + + let slot = EpochKeySlot { + epoch, + generation, + valid: true, + send_cipher: Some(create_encryptor(&self.send_cipher_algorithm, key_128, key)), + recv_cipher: Some(create_encryptor(&self.recv_cipher_algorithm, key_128, key)), + }; + let ret = slot.get_encryptor(is_send); + + if !guard[dir_idx][0].valid || guard[dir_idx][0].epoch == epoch { + guard[dir_idx][0] = slot; + } else { + guard[dir_idx][1] = slot; + } + + ret + } + + fn maybe_rotate_epoch(&self, now_ms: u64) { + let packets = self + .send_packets_since_epoch + .fetch_add(1, Ordering::Relaxed) + + 1; + let started = self.send_epoch_started_ms.load(Ordering::Relaxed); + if packets < Self::ROTATE_AFTER_PACKETS + && now_ms.saturating_sub(started) < Self::ROTATE_AFTER_MS + { + return; + } + + let cur = self.send_epoch.load(Ordering::Relaxed); + let next = cur.wrapping_add(1); + if self + .send_epoch + .compare_exchange(cur, next, Ordering::Relaxed, Ordering::Relaxed) + .is_ok() + { + self.send_epoch_started_ms.store(now_ms, Ordering::Relaxed); + self.send_packets_since_epoch.store(0, Ordering::Relaxed); + } + } + + fn next_nonce(&self, dir: SecureDatagramDirection) -> (u32, u64, [u8; 12]) { + let now_ms = now_ms(); + self.maybe_rotate_epoch(now_ms); + let epoch = self.send_epoch.load(Ordering::Relaxed); + let seq = self.send_seq[dir.idx()].fetch_add(1, Ordering::Relaxed); + let mut nonce = [0u8; 12]; + nonce[..4].copy_from_slice(&epoch.to_be_bytes()); + nonce[4..].copy_from_slice(&seq.to_be_bytes()); + (epoch, seq, nonce) + } + + fn parse_tail(payload: &[u8]) -> Option<[u8; 12]> { + let tail = StandardAeadTail::ref_from_suffix(payload)?; + Some(tail.nonce) + } + + fn evict_old_rx_slots(rx: &mut [[EpochRxSlot; 2]; 2], now_ms: u64) { + for dir_slots in rx.iter_mut() { + for slot in dir_slots.iter_mut() { + if !slot.valid { + continue; + } + let last = slot.last_rx_ms; + if last != 0 && now_ms.saturating_sub(last) > Self::EVICT_IDLE_AFTER_MS { + slot.clear(); + } + } + } + } + + fn epoch_in_slots(slots: &[EpochRxSlot; 2], epoch: u32) -> bool { + slots[0].valid && slots[0].epoch == epoch || slots[1].valid && slots[1].epoch == epoch + } + + fn sync_rx_grace_active(&self, now_ms: u64) -> bool { + let expires_at_ms = self.sync_rx_grace_expires_at_ms.load(Ordering::Relaxed); + if expires_at_ms == 0 { + return false; + } + if now_ms < expires_at_ms { + return true; + } + self.sync_rx_grace_expires_at_ms.store(0, Ordering::Relaxed); + false + } + + fn prune_key_cache(&self, rx: &[[EpochRxSlot; 2]; 2], sync_rx_grace: Option<&SyncRxGrace>) { + let send_epoch = self.send_epoch.load(Ordering::Relaxed); + let mut key_cache = self.key_cache.lock().unwrap(); + for d in 0..2 { + for s in 0..2 { + if !key_cache[d][s].valid { + continue; + } + let e = key_cache[d][s].epoch; + let allowed = e == send_epoch + || rx[d][0].valid && rx[d][0].epoch == e + || rx[d][1].valid && rx[d][1].epoch == e + || sync_rx_grace.is_some_and(|g| Self::epoch_in_slots(&g.slots[d], e)); + if !allowed { + key_cache[d][s].valid = false; + } + } + } + } + + fn precheck_replay( + &self, + epoch: u32, + seq: u64, + dir: SecureDatagramDirection, + now_ms: u64, + ) -> bool { + let dir_idx = dir.idx(); + let mut rx = self.rx_slots.lock().unwrap(); + Self::evict_old_rx_slots(&mut rx, now_ms); + let sync_rx_grace = if self.sync_rx_grace_active(now_ms) { + let mut sync_rx_grace = self.sync_rx_grace.lock().unwrap(); + sync_rx_grace.maybe_expire(now_ms); + if sync_rx_grace.valid { + Self::evict_old_rx_slots(&mut sync_rx_grace.slots, now_ms); + Some(sync_rx_grace) + } else { + self.sync_rx_grace_expires_at_ms.store(0, Ordering::Relaxed); + None + } + } else { + None + }; + + if sync_rx_grace + .as_ref() + .is_some_and(|g| Self::epoch_in_slots(&g.slots[dir_idx], epoch)) + { + for slot in sync_rx_grace.as_ref().unwrap().slots[dir_idx].iter() { + if slot.valid && slot.epoch == epoch { + return slot.window.can_accept(seq); + } + } + } + + if !rx[dir_idx][0].valid { + return true; + } + + if rx[dir_idx][0].valid && epoch == rx[dir_idx][0].epoch { + return rx[dir_idx][0].window.can_accept(seq); + } + + if rx[dir_idx][1].valid && epoch == rx[dir_idx][1].epoch { + return rx[dir_idx][1].window.can_accept(seq); + } + + if rx[dir_idx][0].valid && epoch > rx[dir_idx][0].epoch { + let mut baseline_epoch = self.send_epoch.load(Ordering::Relaxed); + if rx[dir_idx][0].valid { + baseline_epoch = baseline_epoch.max(rx[dir_idx][0].epoch); + } + if rx[dir_idx][1].valid { + baseline_epoch = baseline_epoch.max(rx[dir_idx][1].epoch); + } + let max_allowed_epoch = + baseline_epoch.saturating_add(Self::MAX_ACCEPTED_RX_EPOCH_AHEAD); + if epoch > max_allowed_epoch { + return false; + } + + return true; + } + + false + } + + fn commit_replay( + &self, + epoch: u32, + seq: u64, + dir: SecureDatagramDirection, + now_ms: u64, + ) -> bool { + let dir_idx = dir.idx(); + let mut rx = self.rx_slots.lock().unwrap(); + Self::evict_old_rx_slots(&mut rx, now_ms); + let mut sync_rx_grace = if self.sync_rx_grace_active(now_ms) { + let mut sync_rx_grace = self.sync_rx_grace.lock().unwrap(); + sync_rx_grace.maybe_expire(now_ms); + if sync_rx_grace.valid { + Self::evict_old_rx_slots(&mut sync_rx_grace.slots, now_ms); + Some(sync_rx_grace) + } else { + self.sync_rx_grace_expires_at_ms.store(0, Ordering::Relaxed); + None + } + } else { + None + }; + + let accepted = if sync_rx_grace + .as_ref() + .is_some_and(|g| Self::epoch_in_slots(&g.slots[dir_idx], epoch)) + { + let mut accepted = false; + for slot in sync_rx_grace.as_mut().unwrap().slots[dir_idx].iter_mut() { + if slot.valid && slot.epoch == epoch { + slot.last_rx_ms = now_ms; + accepted = slot.window.accept(seq); + break; + } + } + accepted + } else { + if !rx[dir_idx][0].valid { + rx[dir_idx][0] = EpochRxSlot { + epoch, + window: ReplayWindow256::default(), + last_rx_ms: now_ms, + valid: true, + }; + } + + if rx[dir_idx][0].valid && epoch == rx[dir_idx][0].epoch { + rx[dir_idx][0].last_rx_ms = now_ms; + rx[dir_idx][0].window.accept(seq) + } else if rx[dir_idx][1].valid && epoch == rx[dir_idx][1].epoch { + rx[dir_idx][1].last_rx_ms = now_ms; + rx[dir_idx][1].window.accept(seq) + } else if rx[dir_idx][0].valid && epoch > rx[dir_idx][0].epoch { + let mut baseline_epoch = self.send_epoch.load(Ordering::Relaxed); + if rx[dir_idx][0].valid { + baseline_epoch = baseline_epoch.max(rx[dir_idx][0].epoch); + } + if rx[dir_idx][1].valid { + baseline_epoch = baseline_epoch.max(rx[dir_idx][1].epoch); + } + let max_allowed_epoch = + baseline_epoch.saturating_add(Self::MAX_ACCEPTED_RX_EPOCH_AHEAD); + if epoch > max_allowed_epoch { + false + } else { + rx[dir_idx][1] = rx[dir_idx][0]; + rx[dir_idx][0] = EpochRxSlot { + epoch, + window: ReplayWindow256::default(), + last_rx_ms: now_ms, + valid: true, + }; + rx[dir_idx][0].window.accept(seq) + } + } else { + false + } + }; + + self.prune_key_cache(&rx, sync_rx_grace.as_deref()); + accepted + } + + pub fn encrypt_payload( + &self, + dir: SecureDatagramDirection, + pkt: &mut ZCPacket, + ) -> Result<(), anyhow::Error> { + if !self.is_valid() { + return Err(anyhow!("session invalidated")); + } + let (epoch, _seq, nonce_bytes) = self.next_nonce(dir); + let encryptor = self.get_or_create_encryptor(epoch, dir, self.session_generation(), true); + if let Err(e) = encryptor.encrypt_with_nonce(pkt, Some(nonce_bytes.as_slice())) { + tracing::warn!(?e, "secure datagram session encrypt failed, invalidating"); + self.invalidate(); + return Err(e.into()); + } + Ok(()) + } + + pub fn decrypt_payload( + &self, + dir: SecureDatagramDirection, + ciphertext_with_tail: &mut ZCPacket, + ) -> Result<(), anyhow::Error> { + if !self.is_valid() { + return Err(anyhow!("session invalidated")); + } + let nonce_bytes = + Self::parse_tail(ciphertext_with_tail.payload()).ok_or_else(|| anyhow!("no tail"))?; + let epoch = u32::from_be_bytes(nonce_bytes[..4].try_into().unwrap()); + let seq = u64::from_be_bytes(nonce_bytes[4..].try_into().unwrap()); + + let now_ms = now_ms(); + if !self.precheck_replay(epoch, seq, dir, now_ms) { + return Err(anyhow!("replay rejected")); + } + + let encryptor = self.get_or_create_encryptor(epoch, dir, self.session_generation(), false); + if let Err(e) = encryptor.decrypt(ciphertext_with_tail) { + let count = self.decrypt_fail_count.fetch_add(1, Ordering::Relaxed) + 1; + if count >= Self::DECRYPT_FAIL_THRESHOLD { + self.invalidate(); + tracing::warn!( + count, + "secure datagram session auto-invalidated after consecutive decrypt failures" + ); + } + return Err(e.into()); + } + self.decrypt_fail_count.store(0, Ordering::Relaxed); + + if !self.commit_replay(epoch, seq, dir, now_ms) { + return Err(anyhow!("replay rejected")); + } + + Ok(()) + } +} + +fn now_ms() -> u64 { + SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap_or_default() + .as_millis() as u64 +} + +#[cfg(test)] +mod tests { + use super::*; + #[cfg(all( + any( + feature = "aes-gcm", + feature = "openssl-crypto", + feature = "ring-crypto" + ), + any( + feature = "chacha20", + feature = "openssl-crypto", + feature = "ring-crypto" + ) + ))] + use crate::packet::PacketType; + + impl SecureDatagramSession { + fn check_replay_for_test( + &self, + epoch: u32, + seq: u64, + dir: SecureDatagramDirection, + now_ms: u64, + ) -> bool { + if self.precheck_replay(epoch, seq, dir, now_ms) { + return self.commit_replay(epoch, seq, dir, now_ms); + } + + false + } + } + + #[test] + #[cfg(all( + any( + feature = "aes-gcm", + feature = "openssl-crypto", + feature = "ring-crypto" + ), + any( + feature = "chacha20", + feature = "openssl-crypto", + feature = "ring-crypto" + ) + ))] + fn secure_datagram_supports_asymmetric_algorithms() { + let root_key = SecureDatagramSession::new_root_key(); + let generation = 1u32; + let initial_epoch = 0u32; + + let ab = SecureDatagramSession::new( + root_key, + generation, + initial_epoch, + "aes-256-gcm".to_string(), + "chacha20-poly1305".to_string(), + ); + let ba = SecureDatagramSession::new( + root_key, + generation, + initial_epoch, + "chacha20-poly1305".to_string(), + "aes-256-gcm".to_string(), + ); + + let plaintext1 = b"hello from a"; + let mut pkt1 = ZCPacket::new_with_payload(plaintext1); + pkt1.fill_peer_manager_hdr(10, 20, PacketType::Data as u8); + ab.encrypt_payload(SecureDatagramDirection::AToB, &mut pkt1) + .unwrap(); + ba.decrypt_payload(SecureDatagramDirection::AToB, &mut pkt1) + .unwrap(); + assert_eq!(pkt1.payload(), plaintext1); + + let plaintext2 = b"hello from b"; + let mut pkt2 = ZCPacket::new_with_payload(plaintext2); + pkt2.fill_peer_manager_hdr(20, 10, PacketType::Data as u8); + ba.encrypt_payload(SecureDatagramDirection::BToA, &mut pkt2) + .unwrap(); + ab.decrypt_payload(SecureDatagramDirection::BToA, &mut pkt2) + .unwrap(); + assert_eq!(pkt2.payload(), plaintext2); + } + + #[test] + fn replay_rejects_far_future_epoch_without_poisoning_window() { + let s = SecureDatagramSession::new( + SecureDatagramSession::new_root_key(), + 1, + 0, + "aes-256-gcm".to_string(), + "aes-256-gcm".to_string(), + ); + + let now = now_ms(); + + assert!(s.check_replay_for_test(0, 1, SecureDatagramDirection::AToB, now)); + assert!(s.check_replay_for_test(0, 2, SecureDatagramDirection::AToB, now)); + + assert!(!s.check_replay_for_test(1000, 1, SecureDatagramDirection::AToB, now)); + + assert!(s.check_replay_for_test(1, 1, SecureDatagramDirection::AToB, now + 1)); + assert!(s.check_replay_for_test(1, 2, SecureDatagramDirection::AToB, now + 2)); + } + + #[test] + #[cfg(any( + feature = "aes-gcm", + feature = "openssl-crypto", + feature = "ring-crypto" + ))] + fn failed_decrypt_does_not_poison_replay_window() { + use crate::packet::PacketType; + + let root_key = SecureDatagramSession::new_root_key(); + let sender = SecureDatagramSession::new( + root_key, + 1, + 0, + "aes-256-gcm".to_string(), + "aes-256-gcm".to_string(), + ); + let receiver = SecureDatagramSession::new( + root_key, + 1, + 0, + "aes-256-gcm".to_string(), + "aes-256-gcm".to_string(), + ); + + let mut pkt0 = ZCPacket::new_with_payload(b"pkt0"); + pkt0.fill_peer_manager_hdr(10, 20, PacketType::Data as u8); + sender + .encrypt_payload(SecureDatagramDirection::AToB, &mut pkt0) + .unwrap(); + receiver + .decrypt_payload(SecureDatagramDirection::AToB, &mut pkt0) + .unwrap(); + + let mut forged = ZCPacket::new_with_payload(b"forged"); + forged.fill_peer_manager_hdr(10, 20, PacketType::Data as u8); + sender + .encrypt_payload(SecureDatagramDirection::AToB, &mut forged) + .unwrap(); + + let mut poisoned_nonce = [0u8; StandardAeadTail::NONCE_SIZE]; + poisoned_nonce[..4].copy_from_slice(&0u32.to_be_bytes()); + poisoned_nonce[4..].copy_from_slice(&500u64.to_be_bytes()); + + let payload = forged.mut_payload(); + let nonce_offset = payload.len() - StandardAeadTail::NONCE_SIZE; + payload[nonce_offset..].copy_from_slice(&poisoned_nonce); + + assert!( + receiver + .decrypt_payload(SecureDatagramDirection::AToB, &mut forged) + .is_err() + ); + + let plaintext = b"pkt2"; + let mut pkt2 = ZCPacket::new_with_payload(plaintext); + pkt2.fill_peer_manager_hdr(10, 20, PacketType::Data as u8); + sender + .encrypt_payload(SecureDatagramDirection::AToB, &mut pkt2) + .unwrap(); + receiver + .decrypt_payload(SecureDatagramDirection::AToB, &mut pkt2) + .unwrap(); + assert_eq!(pkt2.payload(), plaintext); + } + + #[test] + fn replay_window_shift_preserves_bits() { + let mut w = ReplayWindow256::default(); + for i in 0..10u64 { + assert!(w.accept(i), "seq {i} should be accepted"); + } + assert_eq!(w.max_seq, 9); + + for i in 0..10u64 { + assert!(!w.accept(i), "seq {i} should be rejected as replay"); + } + + assert!(w.accept(10)); + } + + #[test] + fn replay_window_out_of_order_within_window() { + let mut w = ReplayWindow256::default(); + for i in (0..=20u64).step_by(2) { + assert!(w.accept(i), "seq {i} should be accepted"); + } + for i in (1..=19u64).step_by(2) { + assert!(w.accept(i), "seq {i} should be accepted (out of order)"); + } + for i in 0..=20u64 { + assert!(!w.accept(i), "seq {i} should be rejected as replay"); + } + } + + #[test] + fn sync_root_key_allows_any_epoch_from_remote() { + let s = SecureDatagramSession::new( + SecureDatagramSession::new_root_key(), + 1, + 0, + "aes-256-gcm".to_string(), + "aes-256-gcm".to_string(), + ); + + let root_key = s.root_key(); + let now = now_ms(); + assert!(s.check_replay_for_test(0, 0, SecureDatagramDirection::AToB, now)); + assert!(s.check_replay_for_test(0, 1, SecureDatagramDirection::AToB, now)); + + s.sync_root_key(root_key, 2, 2, true); + + assert!(s.check_replay_for_test(0, 10, SecureDatagramDirection::AToB, now + 1)); + } + + #[test] + fn sync_root_key_keeps_previous_epochs_during_grace_window() { + let s = SecureDatagramSession::new( + SecureDatagramSession::new_root_key(), + 1, + 0, + "aes-256-gcm".to_string(), + "aes-256-gcm".to_string(), + ); + + let root_key = s.root_key(); + let now = now_ms(); + assert!(s.check_replay_for_test(0, 0, SecureDatagramDirection::AToB, now)); + assert!(s.check_replay_for_test(1, 0, SecureDatagramDirection::AToB, now + 1)); + + s.sync_root_key(root_key, 2, 2, true); + + assert!(s.check_replay_for_test(2, 0, SecureDatagramDirection::AToB, now + 2)); + assert!(s.check_replay_for_test(1, 1, SecureDatagramDirection::AToB, now + 3)); + assert!(s.check_replay_for_test(0, 1, SecureDatagramDirection::AToB, now + 4)); + } + + #[test] + fn sync_root_key_expires_previous_epochs_after_grace_window() { + let s = SecureDatagramSession::new( + SecureDatagramSession::new_root_key(), + 1, + 0, + "aes-256-gcm".to_string(), + "aes-256-gcm".to_string(), + ); + + let root_key = s.root_key(); + let now = now_ms(); + assert!(s.check_replay_for_test(0, 0, SecureDatagramDirection::AToB, now)); + assert!(s.check_replay_for_test(1, 0, SecureDatagramDirection::AToB, now + 1)); + + s.sync_root_key(root_key, 2, 2, true); + assert!(s.check_replay_for_test(2, 0, SecureDatagramDirection::AToB, now + 2)); + + assert!(!s.check_replay_for_test( + 0, + 1, + SecureDatagramDirection::AToB, + now + SecureDatagramSession::SYNC_RX_GRACE_AFTER_MS + 3 + )); + } + + #[test] + fn sync_root_key_does_not_preserve_previous_epochs_when_root_key_changes() { + let s = SecureDatagramSession::new( + SecureDatagramSession::new_root_key(), + 1, + 0, + "aes-256-gcm".to_string(), + "aes-256-gcm".to_string(), + ); + + let now = now_ms(); + assert!(s.check_replay_for_test(0, 0, SecureDatagramDirection::AToB, now)); + assert!(s.check_replay_for_test(1, 0, SecureDatagramDirection::AToB, now + 1)); + + s.sync_root_key(SecureDatagramSession::new_root_key(), 2, 2, true); + assert!(s.check_replay_for_test(2, 0, SecureDatagramDirection::AToB, now + 2)); + assert!(!s.check_replay_for_test(1, 1, SecureDatagramDirection::AToB, now + 3)); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/stats.rs b/vendor/easytier/easytier-core/src/tunnel/stats.rs new file mode 100644 index 0000000..4149acd --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/stats.rs @@ -0,0 +1,131 @@ +use std::{ + cell::UnsafeCell, + sync::atomic::{AtomicU32, Ordering::Relaxed}, +}; + +pub struct WindowLatency { + latency_us_window: Vec, + latency_us_window_index: AtomicU32, + latency_us_window_size: u32, + + sum: AtomicU32, + count: AtomicU32, +} + +impl std::fmt::Debug for WindowLatency { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("WindowLatency") + .field("count", &self.count) + .field("window_size", &self.latency_us_window_size) + .field("window_latency", &self.get_latency_us::()) + .finish() + } +} + +impl WindowLatency { + pub fn new(window_size: u32) -> Self { + Self { + latency_us_window: (0..window_size).map(|_| AtomicU32::new(0)).collect(), + latency_us_window_index: AtomicU32::new(0), + latency_us_window_size: window_size, + + sum: AtomicU32::new(0), + count: AtomicU32::new(0), + } + } + + pub fn record_latency(&self, latency_us: u32) { + let index = self.latency_us_window_index.fetch_add(1, Relaxed); + if self.count.load(Relaxed) < self.latency_us_window_size { + self.count.fetch_add(1, Relaxed); + } + + let index = index % self.latency_us_window_size; + let old_lat = self.latency_us_window[index as usize].swap(latency_us, Relaxed); + + if old_lat < latency_us { + self.sum.fetch_add(latency_us - old_lat, Relaxed); + } else { + self.sum.fetch_sub(old_lat - latency_us, Relaxed); + } + } + + pub fn get_latency_us + std::ops::Div>(&self) -> T { + let count = self.count.load(Relaxed); + let sum = self.sum.load(Relaxed); + if count == 0 { + 0.into() + } else { + (T::from(sum)) / T::from(count) + } + } +} + +#[derive(Debug)] +pub struct Throughput { + tx_bytes: UnsafeCell, + rx_bytes: UnsafeCell, + tx_packets: UnsafeCell, + rx_packets: UnsafeCell, +} + +impl Clone for Throughput { + fn clone(&self) -> Self { + Self { + tx_bytes: UnsafeCell::new(unsafe { *self.tx_bytes.get() }), + rx_bytes: UnsafeCell::new(unsafe { *self.rx_bytes.get() }), + tx_packets: UnsafeCell::new(unsafe { *self.tx_packets.get() }), + rx_packets: UnsafeCell::new(unsafe { *self.rx_packets.get() }), + } + } +} + +unsafe impl Send for Throughput {} +unsafe impl Sync for Throughput {} + +impl Default for Throughput { + fn default() -> Self { + Self { + tx_bytes: UnsafeCell::new(0), + rx_bytes: UnsafeCell::new(0), + tx_packets: UnsafeCell::new(0), + rx_packets: UnsafeCell::new(0), + } + } +} + +impl Throughput { + pub fn new() -> Self { + Self::default() + } + + pub fn tx_bytes(&self) -> u64 { + unsafe { *self.tx_bytes.get() } + } + + pub fn rx_bytes(&self) -> u64 { + unsafe { *self.rx_bytes.get() } + } + + pub fn tx_packets(&self) -> u64 { + unsafe { *self.tx_packets.get() } + } + + pub fn rx_packets(&self) -> u64 { + unsafe { *self.rx_packets.get() } + } + + pub fn record_tx_bytes(&self, bytes: u64) { + unsafe { + *self.tx_bytes.get() += bytes; + *self.tx_packets.get() += 1; + } + } + + pub fn record_rx_bytes(&self, bytes: u64) { + unsafe { + *self.rx_bytes.get() += bytes; + *self.rx_packets.get() += 1; + } + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/tcp.rs b/vendor/easytier/easytier-core/src/tunnel/tcp.rs new file mode 100644 index 0000000..4dc8de6 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/tcp.rs @@ -0,0 +1,198 @@ +use std::sync::Mutex as StdMutex; + +use crate::{ + proto::common::TunnelInfo, + socket::tcp::VirtualTcpSocket, + tunnel::framed::{FramedReader, FramedWriter, TCP_MTU_BYTES}, + tunnel::{SplitTunnel, Tunnel, TunnelError}, +}; + +pub struct TcpTunnel { + info: Option, + socket: StdMutex>, + max_packet_size: usize, +} + +impl TcpTunnel { + fn new(socket: S, tunnel_info: TunnelInfo, max_packet_size: usize) -> Self { + Self { + info: Some(tunnel_info), + socket: StdMutex::new(Some(socket)), + max_packet_size, + } + } +} + +impl Tunnel for TcpTunnel +where + S: VirtualTcpSocket, +{ + fn split(&self) -> SplitTunnel { + let socket = self + .socket + .lock() + .unwrap() + .take() + .expect("TcpTunnel can only be split once"); + let (reader, writer) = socket.into_split(); + ( + Box::pin(FramedReader::new(reader, self.max_packet_size)), + Box::pin(FramedWriter::new(writer)), + ) + } + + fn info(&self) -> Option { + self.info.clone() + } +} + +pub struct TcpTunnelUpgrader { + tunnel_info: TunnelInfo, + max_packet_size: usize, +} + +impl TcpTunnelUpgrader { + pub fn new(tunnel_info: TunnelInfo) -> Self { + Self { + tunnel_info, + max_packet_size: TCP_MTU_BYTES, + } + } + + pub(crate) fn with_max_packet_size(mut self, max_packet_size: usize) -> Self { + self.max_packet_size = max_packet_size; + self + } + + pub fn upgrade(self, socket: S) -> Result, TunnelError> + where + S: VirtualTcpSocket, + { + Ok(Box::new(TcpTunnel::new( + socket, + self.tunnel_info, + self.max_packet_size, + ))) + } +} + +#[cfg(test)] +mod tests { + use std::{ + io, + net::SocketAddr, + pin::Pin, + task::{Context, Poll}, + }; + + use crate::packet::{PEER_MANAGER_HEADER_SIZE, ZCPacket, ZCPacketType}; + use futures::{SinkExt, StreamExt}; + use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt, DuplexStream, ReadBuf}; + + use super::*; + + struct MockTcpSocket { + stream: DuplexStream, + local_addr: SocketAddr, + peer_addr: SocketAddr, + } + + impl MockTcpSocket { + fn new(stream: DuplexStream, local_addr: SocketAddr, peer_addr: SocketAddr) -> Self { + Self { + stream, + local_addr, + peer_addr, + } + } + } + + impl AsyncRead for MockTcpSocket { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + Pin::new(&mut self.stream).poll_read(cx, buf) + } + } + + impl AsyncWrite for MockTcpSocket { + fn poll_write( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + Pin::new(&mut self.stream).poll_write(cx, buf) + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_flush(cx) + } + + fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.stream).poll_shutdown(cx) + } + } + + impl VirtualTcpSocket for MockTcpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + fn peer_addr(&self) -> io::Result { + Ok(self.peer_addr) + } + } + + fn set_tcp_tunnel_len(packet: &mut ZCPacket) { + let tcp_len = PEER_MANAGER_HEADER_SIZE + packet.payload_len(); + packet + .mut_tcp_tunnel_header() + .unwrap() + .len + .set(tcp_len.try_into().unwrap()); + } + + #[tokio::test] + async fn tcp_tunnel_upgrader_preserves_metadata_and_framing() { + let (socket_stream, mut peer_stream) = tokio::io::duplex(65536); + let socket = MockTcpSocket::new( + socket_stream, + "127.0.0.1:1000".parse().unwrap(), + "127.0.0.1:2000".parse().unwrap(), + ); + let info = TunnelInfo { + tunnel_type: "tcp".to_owned(), + local_addr: None, + remote_addr: None, + resolved_remote_addr: None, + }; + let tunnel = TcpTunnelUpgrader::new(info.clone()) + .upgrade(socket) + .unwrap(); + assert_eq!(tunnel.info(), Some(info)); + + let (mut stream, mut sink) = tunnel.split(); + let outbound = ZCPacket::new_with_payload(b"outbound"); + let mut expected = outbound.clone().convert_type(ZCPacketType::TCP); + set_tcp_tunnel_len(&mut expected); + let expected_raw = expected.into_bytes(); + let read_peer = tokio::spawn(async move { + let mut raw = vec![0; expected_raw.len()]; + peer_stream.read_exact(&mut raw).await.unwrap(); + assert_eq!(raw, expected_raw); + + let mut inbound = + ZCPacket::new_with_payload(b"inbound").convert_type(ZCPacketType::TCP); + set_tcp_tunnel_len(&mut inbound); + peer_stream.write_all(&inbound.into_bytes()).await.unwrap(); + }); + sink.send(outbound).await.unwrap(); + sink.flush().await.unwrap(); + + let packet = stream.next().await.unwrap().unwrap(); + assert_eq!(packet.payload(), b"inbound"); + read_peer.await.unwrap(); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/udp.rs b/vendor/easytier/easytier-core/src/tunnel/udp.rs new file mode 100644 index 0000000..94d18e2 --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/udp.rs @@ -0,0 +1,420 @@ +use std::{ + pin::Pin, + sync::{Arc, Mutex as StdMutex}, + task::{Context, Poll}, +}; + +use bytes::BytesMut; +use futures::{Sink, Stream}; +use tokio::sync::watch; + +use crate::{ + packet::{UDP_TUNNEL_HEADER_SIZE, UdpPacketType, ZCPacket, ZCPacketType}, + proto::common::TunnelInfo, + socket::{ + ring::{RingSocketError, RingSocketReceiver, RingSocketSendError, RingSocketSender}, + udp::{ + UdpSession, UdpSessionCleanup, UdpSessionCodec, UdpSessionDatagram, UdpSessionOutbound, + UdpSessionTunnelParts, + }, + }, + tunnel::{SinkError, SinkItem, SplitTunnel, StreamItem, Tunnel, TunnelError}, +}; + +fn zcpacket_from_udp_session_payload(payload: &[u8]) -> Result { + let payload_len = u16::try_from(payload.len()) + .map_err(|_| TunnelError::ExceedMaxPacketSize(u16::MAX as usize, payload.len()))?; + let mut buf = BytesMut::new(); + buf.resize(UDP_TUNNEL_HEADER_SIZE + payload.len(), 0); + buf[UDP_TUNNEL_HEADER_SIZE..].copy_from_slice(payload); + + let mut packet = ZCPacket::new_from_buf(buf, ZCPacketType::UDP); + let header = packet.mut_udp_tunnel_header().unwrap(); + header.msg_type = UdpPacketType::Data as u8; + header.len.set(payload_len); + Ok(packet) +} + +fn ring_socket_error_to_tunnel(error: RingSocketError) -> TunnelError { + match error { + RingSocketError::Closed => TunnelError::Shutdown, + RingSocketError::Full => TunnelError::BufferFull, + RingSocketError::AlreadySplit => { + TunnelError::InternalError("udp session ring already split".to_owned()) + } + } +} + +fn ring_send_error_to_tunnel(error: RingSocketSendError) -> TunnelError { + match error { + RingSocketSendError::Closed(_) => TunnelError::Shutdown, + RingSocketSendError::Full(_) => TunnelError::BufferFull, + } +} + +struct UdpTunnelSessionGuard { + cleanup: StdMutex>, + _layer_guard: Option>, +} + +impl UdpTunnelSessionGuard { + fn close_session(&self) { + drop(self.cleanup.lock().unwrap().take()); + } +} + +struct UdpTunnelStream { + session_recv_rx: RingSocketReceiver, + session_guard: Arc, +} + +impl Stream for UdpTunnelStream { + type Item = StreamItem; + + fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let ret = std::task::ready!(Pin::new(&mut self.get_mut().session_recv_rx).poll_next(cx)); + Poll::Ready(ret.map(|payload| { + payload + .map_err(ring_socket_error_to_tunnel) + .and_then(|datagram| match datagram.into_tunnel_packet() { + Ok(packet) => Ok(packet), + Err(payload) => zcpacket_from_udp_session_payload(&payload), + }) + })) + } +} + +impl Drop for UdpTunnelStream { + fn drop(&mut self) { + self.session_guard.close_session(); + } +} + +struct UdpTunnelSink { + codec: UdpSessionCodec, + session_send_tx: RingSocketSender, + closed: watch::Receiver, + session_guard: Arc, +} + +impl Sink for UdpTunnelSink { + type Error = SinkError; + + fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let this = self.get_mut(); + if *this.closed.borrow() { + return Poll::Ready(Err(TunnelError::Shutdown)); + } + Pin::new(&mut this.session_send_tx) + .poll_ready(cx) + .map_err(ring_socket_error_to_tunnel) + } + + fn start_send(self: Pin<&mut Self>, item: SinkItem) -> Result<(), Self::Error> { + let this = self.get_mut(); + if *this.closed.borrow() { + return Err(TunnelError::Shutdown); + } + + let packet = item.convert_type(ZCPacketType::UDP); + this.codec + .validate_payload(packet.udp_payload()) + .map_err(TunnelError::IOError)?; + let outbound = UdpSessionOutbound::TunnelPacket(packet); + this.session_send_tx + .force_send(outbound) + .map_err(ring_send_error_to_tunnel) + } + + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.get_mut().session_send_tx) + .poll_flush(cx) + .map_err(ring_socket_error_to_tunnel) + } + + fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let this = self.get_mut(); + let result = Pin::new(&mut this.session_send_tx) + .poll_close(cx) + .map_err(ring_socket_error_to_tunnel); + if result.is_ready() { + this.session_guard.close_session(); + } + result + } +} + +impl Drop for UdpTunnelSink { + fn drop(&mut self) { + self.session_guard.close_session(); + } +} + +struct UdpTunnelParts { + codec: UdpSessionCodec, + session_recv_rx: RingSocketReceiver, + session_send_tx: RingSocketSender, + closed: watch::Receiver, + cleanup: UdpSessionCleanup, + keep_alive: Option>, +} + +pub struct UdpTunnel { + info: Option, + parts: StdMutex>, +} + +impl UdpTunnel { + fn new( + tunnel_info: TunnelInfo, + session_parts: UdpSessionTunnelParts, + keep_alive: Option>, + ) -> Self { + let UdpSessionTunnelParts { + local_addr, + peer_addr, + kind, + codec, + session_recv_rx, + session_send_tx, + closed, + cleanup, + } = session_parts; + tracing::debug!( + ?local_addr, + ?peer_addr, + ?kind, + "udp build tunnel from session" + ); + Self { + info: Some(tunnel_info), + parts: StdMutex::new(Some(UdpTunnelParts { + codec, + session_recv_rx, + session_send_tx, + closed, + cleanup, + keep_alive, + })), + } + } +} + +impl Tunnel for UdpTunnel { + fn split(&self) -> SplitTunnel { + let parts = self + .parts + .lock() + .unwrap() + .take() + .expect("UdpTunnel can only be split once"); + let session_guard = Arc::new(UdpTunnelSessionGuard { + cleanup: StdMutex::new(Some(parts.cleanup)), + _layer_guard: parts.keep_alive, + }); + ( + Box::pin(UdpTunnelStream { + session_recv_rx: parts.session_recv_rx, + session_guard: session_guard.clone(), + }), + Box::pin(UdpTunnelSink { + codec: parts.codec, + session_send_tx: parts.session_send_tx, + closed: parts.closed, + session_guard, + }), + ) + } + + fn info(&self) -> Option { + self.info.clone() + } +} + +pub struct UdpTunnelUpgrader { + tunnel_info: TunnelInfo, + keep_alive: Option>, +} + +impl UdpTunnelUpgrader { + pub fn new(tunnel_info: TunnelInfo) -> Self { + Self { + tunnel_info, + keep_alive: None, + } + } + + pub fn with_keep_alive(tunnel_info: TunnelInfo, keep_alive: T) -> Self + where + T: Send + Sync + 'static, + { + Self { + tunnel_info, + keep_alive: Some(Box::new(keep_alive)), + } + } + + pub fn upgrade(self, session: UdpSession) -> Result, TunnelError> { + let Self { + tunnel_info, + keep_alive, + } = self; + Ok(Box::new(UdpTunnel::new( + tunnel_info, + session.into_tunnel_parts(), + keep_alive, + ))) + } +} + +#[cfg(test)] +mod tests { + use std::{ + io, + net::SocketAddr, + sync::{Arc, Mutex as StdMutex}, + time::Duration, + }; + + use async_trait::async_trait; + use futures::{SinkExt, StreamExt}; + use tokio::{ + sync::mpsc::{Receiver, channel}, + time::{sleep, timeout}, + }; + + use crate::socket::udp::{UdpSessionKind, VirtualUdpSocket}; + + use super::*; + + struct MockVirtualUdpSocket { + local_addr: SocketAddr, + inbound: tokio::sync::Mutex, SocketAddr)>>, + sent: StdMutex, SocketAddr)>>, + } + + impl MockVirtualUdpSocket { + fn new(local_addr: SocketAddr, inbound: Receiver<(Vec, SocketAddr)>) -> Self { + Self { + local_addr, + inbound: tokio::sync::Mutex::new(inbound), + sent: StdMutex::new(Vec::new()), + } + } + + fn sent(&self) -> Vec<(Vec, SocketAddr)> { + self.sent.lock().unwrap().clone() + } + } + + #[async_trait] + impl VirtualUdpSocket for MockVirtualUdpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> io::Result { + self.sent.lock().unwrap().push((data.to_vec(), addr)); + Ok(data.len()) + } + + async fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> { + let mut inbound = self.inbound.lock().await; + let Some((data, addr)) = inbound.recv().await else { + return Err(io::Error::new( + io::ErrorKind::UnexpectedEof, + "mock socket closed", + )); + }; + let len = data.len().min(buf.len()); + buf[..len].copy_from_slice(&data[..len]); + Ok((len, addr)) + } + } + + async fn wait_until(mut condition: F) + where + F: FnMut() -> bool, + { + timeout(Duration::from_secs(1), async { + loop { + if condition() { + return; + } + sleep(Duration::from_millis(10)).await; + } + }) + .await + .unwrap(); + } + + #[tokio::test] + async fn udp_tunnel_upgrader_consumes_udp_session_rings() { + let local_addr = "127.0.0.1:1".parse().unwrap(); + let peer_addr = "127.0.0.1:2".parse().unwrap(); + let (network_sender, network_recv) = channel(8); + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, network_recv)); + let session = + UdpSession::identity_standalone(socket.clone(), peer_addr, UdpSessionKind::Quic) + .unwrap(); + let tunnel = UdpTunnelUpgrader::new(TunnelInfo { + tunnel_type: "udp".to_owned(), + local_addr: None, + remote_addr: None, + resolved_remote_addr: None, + }) + .upgrade(session) + .unwrap(); + let (mut stream, mut sink) = tunnel.split(); + + let outbound_packet = ZCPacket::new_with_payload(b"outbound"); + let expected_session_payload = outbound_packet + .clone() + .convert_type(ZCPacketType::UDP) + .udp_payload() + .to_vec(); + sink.send(outbound_packet).await.unwrap(); + wait_until(|| !socket.sent().is_empty()).await; + assert_eq!(socket.sent(), vec![(expected_session_payload, peer_addr)]); + + network_sender + .send((b"inbound".to_vec(), peer_addr)) + .await + .unwrap(); + let packet = timeout(Duration::from_secs(1), stream.next()) + .await + .unwrap() + .unwrap() + .unwrap(); + + assert_eq!(packet.udp_payload(), b"inbound"); + } + + #[tokio::test] + async fn udp_tunnel_sink_close_closes_session() { + let local_addr = "127.0.0.1:1".parse().unwrap(); + let peer_addr = "127.0.0.1:2".parse().unwrap(); + let (_network_sender, network_recv) = channel(8); + let socket = Arc::new(MockVirtualUdpSocket::new(local_addr, network_recv)); + let session = + UdpSession::identity_standalone(socket, peer_addr, UdpSessionKind::Quic).unwrap(); + let tunnel = UdpTunnelUpgrader::new(TunnelInfo { + tunnel_type: "udp".to_owned(), + local_addr: None, + remote_addr: None, + resolved_remote_addr: None, + }) + .upgrade(session) + .unwrap(); + let (mut stream, mut sink) = tunnel.split(); + + sink.close().await.unwrap(); + let item = timeout(Duration::from_secs(1), stream.next()) + .await + .unwrap(); + assert!( + item.is_none() || matches!(item, Some(Err(TunnelError::Shutdown))), + "session stream must close after sink close" + ); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/web_security.rs b/vendor/easytier/easytier-core/src/tunnel/web_security.rs new file mode 100644 index 0000000..f95ebdd --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/web_security.rs @@ -0,0 +1,404 @@ +use std::sync::{Arc, Mutex}; + +use futures::{SinkExt, StreamExt}; +use snow::{Builder, params::NoiseParams}; + +use crate::{ + foundation::time::{Duration, timeout}, + packet::{PacketType, ZCPacket, ZCPacketType}, + proto::common::TunnelInfo, + tunnel::{ + SplitTunnel, StreamItem, Tunnel, TunnelError, ZCPacketSink, ZCPacketStream, + filter::{TunnelFilter, TunnelWithFilter}, + secure_datagram::{SecureDatagramDirection, SecureDatagramSession}, + }, +}; + +const NOISE_MAGIC: &[u8] = b"ET_WEB_NOISE_V1:"; +const NOISE_PROLOGUE: &[u8] = b"easytier-webclient-noise-v1"; +const NOISE_PATTERN: &str = "Noise_NN_25519_ChaChaPoly_SHA256"; +const WEB_SECURE_CIPHER_ALGORITHM: &str = "aes-gcm"; +const WEB_SESSION_GENERATION: u32 = 1; +const WEB_INITIAL_EPOCH: u32 = 0; +const WEB_SECURE_HANDSHAKE_TIMEOUT: Duration = Duration::from_secs(3); +const WEB_SECURE_ACCEPT_TIMEOUT: Duration = WEB_SECURE_HANDSHAKE_TIMEOUT; + +struct RawSplitTunnel { + info: Option, + split: Mutex>, +} + +impl RawSplitTunnel { + fn new( + info: Option, + stream: std::pin::Pin>, + sink: std::pin::Pin>, + ) -> Self { + Self { + info, + split: Mutex::new(Some((stream, sink))), + } + } +} + +impl Tunnel for RawSplitTunnel { + fn split(&self) -> SplitTunnel { + self.split + .lock() + .unwrap() + .take() + .expect("split can only be called once") + } + + fn info(&self) -> Option { + self.info.clone() + } +} + +#[derive(Clone, Copy)] +enum SecureTunnelRole { + Initiator, + Responder, +} + +impl SecureTunnelRole { + fn send_dir(self) -> SecureDatagramDirection { + match self { + Self::Initiator => SecureDatagramDirection::AToB, + Self::Responder => SecureDatagramDirection::BToA, + } + } + + fn recv_dir(self) -> SecureDatagramDirection { + match self { + Self::Initiator => SecureDatagramDirection::BToA, + Self::Responder => SecureDatagramDirection::AToB, + } + } +} + +struct SecureDatagramTunnelFilter { + session: Arc, + role: SecureTunnelRole, +} + +impl TunnelFilter for SecureDatagramTunnelFilter { + type FilterOutput = (); + + fn before_send(&self, data: ZCPacket) -> Option { + let mut packet = ZCPacket::new_with_payload(data.tunnel_payload()); + packet.fill_peer_manager_hdr(0, 0, PacketType::Data as u8); + self.session + .encrypt_payload(self.role.send_dir(), &mut packet) + .ok()?; + Some(packet) + } + + fn after_received(&self, data: StreamItem) -> Option { + let packet = match data { + Ok(v) => v, + Err(e) => return Some(Err(e)), + }; + + let payload = match checked_payload(&packet, "secure packet") { + Ok(v) => v, + Err(e) => return Some(Err(e)), + }; + let mut cipher = ZCPacket::new_with_payload(payload); + cipher.fill_peer_manager_hdr(0, 0, PacketType::Data as u8); + cipher + .mut_peer_manager_header() + .unwrap() + .set_encrypted(true); + if let Err(e) = self + .session + .decrypt_payload(self.role.recv_dir(), &mut cipher) + { + return Some(Err(TunnelError::InvalidPacket(format!( + "secure datagram decrypt failed: {e}" + )))); + } + + let packet = ZCPacket::new_from_buf(cipher.payload_bytes(), ZCPacketType::DummyTunnel); + if packet.peer_manager_header().is_none() { + return Some(Err(TunnelError::InvalidPacket( + "decrypted secure packet too short".to_string(), + ))); + } + + Some(Ok(packet)) + } + + fn filter_output(&self) {} +} + +fn checked_payload<'a>(packet: &'a ZCPacket, context: &str) -> Result<&'a [u8], TunnelError> { + if packet.peer_manager_header().is_none() { + return Err(TunnelError::InvalidPacket(format!("{context} too short"))); + } + + Ok(packet.payload()) +} + +fn pack_control_packet(payload: &[u8]) -> ZCPacket { + let mut packet = ZCPacket::new_with_payload(payload); + packet.fill_peer_manager_hdr(0, 0, PacketType::Data as u8); + packet +} + +fn encode_noise_payload(buf: &[u8]) -> Vec { + let mut payload = Vec::with_capacity(NOISE_MAGIC.len() + buf.len()); + payload.extend_from_slice(NOISE_MAGIC); + payload.extend_from_slice(buf); + payload +} + +fn decode_noise_payload(payload: &[u8]) -> Option<&[u8]> { + payload.strip_prefix(NOISE_MAGIC) +} + +pub fn web_secure_tunnel_supported() -> bool { + crate::tunnel::encrypt::algorithm_is_available(crate::config::EncryptionAlgorithm::AesGcm) +} + +fn web_secure_cipher_algorithm() -> Result<&'static str, TunnelError> { + if !web_secure_tunnel_supported() { + return Err(TunnelError::InternalError(format!( + "web secure tunnel requires {WEB_SECURE_CIPHER_ALGORITHM} support" + ))); + } + Ok(WEB_SECURE_CIPHER_ALGORITHM) +} + +fn new_web_secure_session(root_key: [u8; 32], algorithm: &str) -> Arc { + let algo = algorithm.to_string(); + Arc::new(SecureDatagramSession::new( + root_key, + WEB_SESSION_GENERATION, + WEB_INITIAL_EPOCH, + algo.clone(), + algo, + )) +} + +fn wrap_secure_tunnel( + info: Option, + stream: std::pin::Pin>, + sink: std::pin::Pin>, + session: Arc, + role: SecureTunnelRole, +) -> Box { + let raw = RawSplitTunnel::new(info, stream, sink); + Box::new(TunnelWithFilter::new( + raw, + SecureDatagramTunnelFilter { session, role }, + )) +} + +pub async fn upgrade_client_tunnel( + tunnel: Box, +) -> Result, TunnelError> { + let web_cipher_algorithm = web_secure_cipher_algorithm()?; + let info = tunnel.info(); + let (mut stream, mut sink) = tunnel.split(); + + let params: NoiseParams = NOISE_PATTERN + .parse() + .map_err(|e| TunnelError::InternalError(format!("parse noise params failed: {e}")))?; + let mut state = Builder::new(params) + .prologue(NOISE_PROLOGUE) + .map_err(|e| TunnelError::InternalError(format!("set prologue failed: {e}")))? + .build_initiator() + .map_err(|e| TunnelError::InternalError(format!("build initiator failed: {e}")))?; + + let mut msg1 = vec![0u8; 1024]; + let msg1_len = state + .write_message(&[], &mut msg1) + .map_err(|e| TunnelError::InternalError(format!("write noise msg1 failed: {e}")))?; + sink.send(pack_control_packet(&encode_noise_payload( + &msg1[..msg1_len], + ))) + .await?; + + let msg2_packet = match timeout(WEB_SECURE_HANDSHAKE_TIMEOUT, stream.next()).await { + Ok(Some(Ok(packet))) => packet, + Ok(Some(Err(error))) => return Err(error), + Ok(None) => return Err(TunnelError::Shutdown), + Err(error) => return Err(error.into()), + }; + let msg2_payload = checked_payload(&msg2_packet, "noise msg2 packet")?; + let msg2_cipher = decode_noise_payload(msg2_payload) + .ok_or_else(|| TunnelError::InvalidPacket("invalid noise msg2 magic".to_string()))?; + let mut root_key_buf = [0u8; 32]; + let root_key_len = state + .read_message(msg2_cipher, &mut root_key_buf) + .map_err(|e| TunnelError::InvalidPacket(format!("read noise msg2 failed: {e}")))?; + if root_key_len != root_key_buf.len() { + return Err(TunnelError::InvalidPacket(format!( + "invalid web secure root key len: {root_key_len}" + ))); + } + + Ok(wrap_secure_tunnel( + info, + stream, + sink, + new_web_secure_session(root_key_buf, web_cipher_algorithm), + SecureTunnelRole::Initiator, + )) +} + +pub async fn accept_or_upgrade_server_tunnel( + tunnel: Box, +) -> Result<(Box, bool), TunnelError> { + let info = tunnel.info(); + let (stream, sink) = tunnel.split(); + let mut stream = stream; + let mut sink = sink; + + let first_packet = match timeout(WEB_SECURE_ACCEPT_TIMEOUT, stream.next()).await { + Ok(Some(Ok(packet))) => packet, + Ok(Some(Err(error))) => return Err(error), + Ok(None) => return Err(TunnelError::Shutdown), + Err(_) => { + return Ok(( + Box::new(RawSplitTunnel::new(info, stream, sink)) as Box, + false, + )); + } + }; + let first_payload = checked_payload(&first_packet, "first packet")?; + let Some(msg1_cipher) = decode_noise_payload(first_payload) else { + let stream = Box::pin(futures::stream::once(async move { Ok(first_packet) }).chain(stream)); + return Ok(( + Box::new(RawSplitTunnel::new(info, stream, sink)) as Box, + false, + )); + }; + let web_cipher_algorithm = web_secure_cipher_algorithm()?; + + let params: NoiseParams = NOISE_PATTERN + .parse() + .map_err(|e| TunnelError::InternalError(format!("parse noise params failed: {e}")))?; + let mut state = Builder::new(params) + .prologue(NOISE_PROLOGUE) + .map_err(|e| TunnelError::InternalError(format!("set prologue failed: {e}")))? + .build_responder() + .map_err(|e| TunnelError::InternalError(format!("build responder failed: {e}")))?; + + let mut msg1 = vec![0u8; 1024]; + state + .read_message(msg1_cipher, &mut msg1) + .map_err(|e| TunnelError::InvalidPacket(format!("read noise msg1 failed: {e}")))?; + + let root_key = SecureDatagramSession::new_root_key(); + let mut msg2 = vec![0u8; 1024]; + let msg2_len = state + .write_message(&root_key, &mut msg2) + .map_err(|e| TunnelError::InternalError(format!("write noise msg2 failed: {e}")))?; + sink.send(pack_control_packet(&encode_noise_payload( + &msg2[..msg2_len], + ))) + .await?; + + Ok(( + wrap_secure_tunnel( + info, + stream, + sink, + new_web_secure_session(root_key, web_cipher_algorithm), + SecureTunnelRole::Responder, + ), + true, + )) +} + +#[cfg(test)] +mod tests { + use bytes::BytesMut; + + use crate::{foundation::time::sleep, tunnel::ring::create_ring_tunnel_pair}; + + use super::*; + + #[test] + fn web_secure_cipher_algorithm_matches_support_flag() { + let result = web_secure_cipher_algorithm(); + if web_secure_tunnel_supported() { + assert_eq!(result.unwrap(), WEB_SECURE_CIPHER_ALGORITHM); + } else { + assert!(matches!(result, Err(TunnelError::InternalError(_)))); + } + } + + #[test] + fn web_secure_session_uses_pinned_cipher_algorithm() { + if !web_secure_tunnel_supported() { + return; + } + + let session = new_web_secure_session( + SecureDatagramSession::new_root_key(), + web_secure_cipher_algorithm().unwrap(), + ); + session + .check_encrypt_algo_same(WEB_SECURE_CIPHER_ALGORITHM, WEB_SECURE_CIPHER_ALGORITHM) + .unwrap(); + } + + #[tokio::test] + async fn upgrade_client_tunnel_times_out_when_server_never_replies() { + if !web_secure_tunnel_supported() { + return; + } + + let (server_tunnel, client_tunnel) = create_ring_tunnel_pair(); + let _server_tunnel = server_tunnel; + + let err = upgrade_client_tunnel(client_tunnel).await.unwrap_err(); + assert!(matches!(err, TunnelError::Timeout(_))); + } + + #[tokio::test] + async fn accept_secure_tunnel_rejects_short_first_packet() { + let (server_tunnel, client_tunnel) = create_ring_tunnel_pair(); + + let server_task = + tokio::spawn(async move { accept_or_upgrade_server_tunnel(server_tunnel).await }); + + let (_stream, mut sink) = client_tunnel.split(); + sink.send(ZCPacket::new_from_buf( + BytesMut::from(&b"\x01"[..]), + ZCPacketType::TCP, + )) + .await + .unwrap(); + + let err = server_task.await.unwrap().unwrap_err(); + assert!(matches!( + err, + TunnelError::InvalidPacket(msg) if msg == "first packet too short" + )); + } + + #[tokio::test] + async fn accept_secure_tunnel_after_short_client_delay() { + if !web_secure_tunnel_supported() { + return; + } + + let (server_tunnel, client_tunnel) = create_ring_tunnel_pair(); + + let server_task = + tokio::spawn(async move { accept_or_upgrade_server_tunnel(server_tunnel).await }); + + sleep(Duration::from_millis(1500)).await; + + let client_task = tokio::spawn(async move { upgrade_client_tunnel(client_tunnel).await }); + + let (server_res, client_res) = tokio::join!(server_task, client_task); + let (_, secure) = server_res.unwrap().unwrap(); + assert!(secure); + assert!(client_res.unwrap().is_ok()); + } +} diff --git a/vendor/easytier/easytier-core/src/tunnel/wrapper.rs b/vendor/easytier/easytier-core/src/tunnel/wrapper.rs new file mode 100644 index 0000000..03af61e --- /dev/null +++ b/vendor/easytier/easytier-core/src/tunnel/wrapper.rs @@ -0,0 +1,52 @@ +use std::{ + any::Any, + pin::Pin, + sync::{Arc, Mutex}, +}; + +use crate::proto::common::TunnelInfo; + +use super::{Tunnel, ZCPacketSink, ZCPacketStream}; + +pub struct TunnelWrapper { + reader: Arc>>, + writer: Arc>>, + info: Option, + _associate_data: Option>, +} + +impl TunnelWrapper { + pub fn new(reader: R, writer: W, info: Option) -> Self { + Self::new_with_associate_data(reader, writer, info, None) + } + + pub fn new_with_associate_data( + reader: R, + writer: W, + info: Option, + associate_data: Option>, + ) -> Self { + Self { + reader: Arc::new(Mutex::new(Some(reader))), + writer: Arc::new(Mutex::new(Some(writer))), + info, + _associate_data: associate_data, + } + } +} + +impl Tunnel for TunnelWrapper +where + R: ZCPacketStream + Send + 'static, + W: ZCPacketSink + Send + 'static, +{ + fn split(&self) -> (Pin>, Pin>) { + let reader = self.reader.lock().unwrap().take().unwrap(); + let writer = self.writer.lock().unwrap().take().unwrap(); + (Box::pin(reader), Box::pin(writer)) + } + + fn info(&self) -> Option { + self.info.clone() + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/abi.rs b/vendor/easytier/easytier-core/src/wasi/abi.rs new file mode 100644 index 0000000..16d3e10 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/abi.rs @@ -0,0 +1,159 @@ +//! Stable ABI contract between the EasyTier WASI guest and its runtime. +//! +//! A runtime must provide every function in the `easytier_host` import module +//! and call the guest lifecycle exports listed in [`GUEST_EXPORTS`]. The raw +//! import declarations live in the target-only `imports` Module. +//! Rust visibility does not define this cross-language contract; the imported +//! and exported WebAssembly symbol names and signatures do. +//! +//! Every `u32` pointer is an offset in wasm32 guest linear memory, never a +//! native host pointer. The runtime must copy input bytes before an import +//! returns and may write result bytes only during the matching `take_*` call. +//! An operation ID belongs to core until a terminal `take_*` call consumes it +//! or the runtime receives the `cancel_operation` import. + +/// WebAssembly import module a WASI runtime must implement. +pub const HOST_IMPORT_MODULE: &str = "easytier_host"; + +/// AEAD algorithm identifiers accepted by the optional crypto imports. +pub const AEAD_AES_128_GCM: u32 = 1; +pub const AEAD_AES_256_GCM: u32 = 2; +pub const AEAD_CHACHA20_POLY1305: u32 = 3; + +/// The Host could not authenticate an AEAD record. +/// +/// Unlike other non-zero crypto statuses, this must not fall back to the +/// built-in implementation because an in-place open may have changed bytes. +pub const HOST_CRYPTO_AUTH_FAILED: i32 = -10; + +/// Version of the JSON document accepted by `easytier_instance_create`. +pub const CORE_INSTANCE_CONFIG_VERSION: u32 = 14; + +/// Version of the JSON document accepted by `easytier_web_client_create`. +#[cfg(feature = "management")] +pub const WEB_CLIENT_CONFIG_VERSION: u32 = 1; + +/// Version of the public data-plane guest export contract. +pub const DATA_PLANE_ABI_VERSION: u32 = 4; + +/// Version of the protobuf RPC guest export contract. +#[cfg(feature = "management-rpc")] +pub const RPC_ABI_VERSION: u32 = 2; + +/// `easytier_rpc_response_take` has not completed yet. +#[cfg(feature = "management-rpc")] +pub const RPC_STATUS_PENDING: i32 = -6; + +/// The guest exposes an instance-scoped data-plane operation broker. +pub const DATA_PLANE_CAPABILITY: u64 = 1 << 0; +/// The guest data plane supports TCP streams and listeners. +pub const DATA_PLANE_TCP_CAPABILITY: u64 = 1 << 1; +/// The guest data plane supports UDP sockets. +pub const DATA_PLANE_UDP_CAPABILITY: u64 = 1 << 2; +/// Update the read deadline in `easytier_data_plane_resource_deadline_set`. +pub const DATA_PLANE_DEADLINE_READ: u32 = 1 << 0; +/// Update the write deadline in `easytier_data_plane_resource_deadline_set`. +pub const DATA_PLANE_DEADLINE_WRITE: u32 = 1 << 1; +/// Version of the host tunnel metadata and export contract. +pub const HOST_TUNNEL_ABI_VERSION: u32 = 1; + +/// Guest exports a WASI runtime calls to manage a core instance. +/// +/// Buffer allocation precedes config, packet, and error-copy calls. Instance +/// creation and lifecycle use the returned instance handle. A runtime drives +/// all asynchronous guest work through `easytier_instance_drive` and host +/// completion notifications. +pub const GUEST_EXPORTS: &[&str] = &[ + // WASI command initialization. This only binds the runtime; core lifecycle + // still starts through the instance exports below. + "_start", + // Guest-memory buffers. + "easytier_buffer_alloc", + "easytier_buffer_free", + // Instance lifecycle and external runtime driving. + "easytier_instance_create", + "easytier_instance_start", + "easytier_instance_stop", + "easytier_instance_drive", + "easytier_instance_notify_completions", + "easytier_instance_state", + "easytier_instance_next_deadline_millis", + // Raw IP packet ingress and error retrieval. + "easytier_instance_send_packet", + "easytier_instance_drop", + "easytier_instance_error_len", + "easytier_instance_error_copy", +]; + +/// Guest exports present when process-level WebClient management is enabled. +#[cfg(feature = "management")] +pub const WEB_CLIENT_GUEST_EXPORTS: &[&str] = &[ + "easytier_web_client_create", + "easytier_web_client_drive", + "easytier_web_client_notify_completions", + "easytier_web_client_next_deadline_millis", + "easytier_web_client_is_connected", + "easytier_web_client_drop", +]; + +/// Guest exports present when protobuf management RPC is enabled. +/// +/// `easytier_rpc_request_submit` accepts a serialized +/// `common.DirectRpcRequest`. Its `full_method_name` uses the canonical +/// protobuf reflection name, and `request` contains the serialized protobuf +/// input. An absent `timeout_ms` means the dispatcher has no timeout. +/// `easytier_rpc_response_take` returns a serialized `common.RpcResponse`, +/// including any method error. +/// Submit writes an opaque big-endian `u64` operation ID. A response take +/// returns [`RPC_STATUS_PENDING`] while running; `(output, capacity) == (0, +/// 0)` probes the size, and an undersized buffer returns the required size +/// without consuming the response. Free cancels pending work and discards +/// any retained result. +#[cfg(feature = "management-rpc")] +pub const RPC_GUEST_EXPORTS: &[&str] = &[ + "easytier_rpc_abi_version", + "easytier_rpc_request_submit", + "easytier_rpc_response_take", + "easytier_rpc_operation_free", +]; + +/// Guest exports present with the host tunnel feature. +#[cfg(feature = "wasm-host-tunnel")] +pub const HOST_TUNNEL_GUEST_EXPORTS: &[&str] = &[ + "easytier_host_tunnel_abi_version", + "easytier_instance_accept_tunnel", +]; + +/// Guest exports present when the core is built with the smoltcp data plane. +#[cfg(feature = "proxy-smoltcp-stack")] +pub const DATA_PLANE_GUEST_EXPORTS: &[&str] = &[ + // ABI discovery. + "easytier_data_plane_abi_version", + "easytier_data_plane_capabilities", + // Data-plane operation submission. + "easytier_data_plane_tcp_connect_submit", + "easytier_data_plane_tcp_bind_submit", + "easytier_data_plane_tcp_accept_submit", + "easytier_data_plane_tcp_read_submit", + "easytier_data_plane_tcp_write_submit", + "easytier_data_plane_tcp_shutdown_write_submit", + "easytier_data_plane_udp_bind_submit", + "easytier_data_plane_udp_receive_submit", + "easytier_data_plane_udp_send_submit", + "easytier_data_plane_resource_deadline_set", + // Completion, result, and resource lifecycle. + "easytier_data_plane_completion_drain", + "easytier_data_plane_result_size", + "easytier_data_plane_tcp_connect_result_take", + "easytier_data_plane_tcp_bind_result_take", + "easytier_data_plane_tcp_accept_result_take", + "easytier_data_plane_tcp_read_result_take", + "easytier_data_plane_tcp_write_result_take", + "easytier_data_plane_tcp_shutdown_write_result_take", + "easytier_data_plane_udp_bind_result_take", + "easytier_data_plane_udp_receive_result_take", + "easytier_data_plane_udp_send_result_take", + "easytier_data_plane_operation_cancel", + "easytier_data_plane_operation_free", + "easytier_data_plane_resource_close", +]; diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/dns.rs b/vendor/easytier/easytier-core/src/wasi/adapter/dns.rs new file mode 100644 index 0000000..cc6478b --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/dns.rs @@ -0,0 +1,121 @@ +use std::{io, net::IpAddr, task::Poll}; + +use crate::{ + host::{ + dns::{DnsQuery, DnsSrvRecord, HostDnsIo}, + socket::HostOperationId, + }, + wasi::{ + imports::{ + HOST_PENDING, cancel_operation, start_dns_resolve, start_dns_srv, start_dns_txt, + take_dns_resolve, take_dns_srv, take_dns_txt, + }, + wire::{ + common::host_error, + dns::{decode_addresses, decode_srv, decode_txt, encode_query}, + }, + }, +}; + +const MAX_DNS_RESULT_LEN: usize = 1024 * 1024; + +#[derive(Default)] +pub struct WasiHostDnsIo; + +impl HostDnsIo for WasiHostDnsIo { + fn submit_resolve(&self, operation: HostOperationId, query: &DnsQuery) -> io::Result<()> { + submit_query("start_dns_resolve", operation, query, start_dns_resolve) + } + + fn take_resolve(&self, operation: HostOperationId) -> Poll>> { + take_result( + "take_dns_resolve", + operation, + take_dns_resolve, + decode_addresses, + ) + } + + fn submit_txt(&self, operation: HostOperationId, query: &DnsQuery) -> io::Result<()> { + submit_query("start_dns_txt", operation, query, start_dns_txt) + } + + fn take_txt(&self, operation: HostOperationId) -> Poll> { + take_result("take_dns_txt", operation, take_dns_txt, decode_txt) + } + + fn submit_srv(&self, operation: HostOperationId, query: &DnsQuery) -> io::Result<()> { + submit_query("start_dns_srv", operation, query, start_dns_srv) + } + + fn take_srv(&self, operation: HostOperationId) -> Poll>> { + take_result("take_dns_srv", operation, take_dns_srv, decode_srv) + } + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + host_status("cancel_operation", unsafe { cancel_operation(operation.0) }) + } +} + +fn submit_query( + name: &'static str, + operation: HostOperationId, + query: &DnsQuery, + submit: unsafe extern "C" fn(u64, u32, u32) -> i32, +) -> io::Result<()> { + let encoded = encode_query(query)?; + let length = u32::try_from(encoded.len()) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "DNS query is too long"))?; + host_status(name, unsafe { + submit(operation.0, encoded.as_ptr() as u32, length) + }) +} + +fn take_result( + name: &'static str, + operation: HostOperationId, + take: unsafe extern "C" fn(u64, u32, u32) -> i32, + decode: fn(&[u8]) -> io::Result, +) -> Poll> { + let required = unsafe { take(operation.0, 0, 0) }; + if required == HOST_PENDING { + return Poll::Pending; + } + if required <= 0 { + return Poll::Ready(Err(host_error(name, required))); + } + let required = usize::try_from(required).expect("positive i32 fits usize"); + if required > MAX_DNS_RESULT_LEN { + cancel_probed_result(operation); + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::InvalidData, + format!("host {name} result exceeds {MAX_DNS_RESULT_LEN} bytes"), + ))); + } + let mut encoded = vec![0_u8; required]; + let capacity = u32::try_from(required).expect("DNS result limit fits u32"); + let copied = unsafe { take(operation.0, encoded.as_mut_ptr() as u32, capacity) }; + if copied != i32::try_from(required).expect("positive DNS result length fits i32") { + cancel_probed_result(operation); + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::InvalidData, + format!("host {name} changed result length from {required} to {copied}"), + ))); + } + Poll::Ready(decode(&encoded)) +} + +fn cancel_probed_result(operation: HostOperationId) { + // The size probe does not consume host state. A second take may have + // consumed it before returning a malformed status, so this best-effort + // ownership cleanup must not hide the original protocol error. + let _ = unsafe { cancel_operation(operation.0) }; +} + +fn host_status(name: &'static str, result: i32) -> io::Result<()> { + if result == 0 { + Ok(()) + } else { + Err(host_error(name, result)) + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/environment.rs b/vendor/easytier/easytier-core/src/wasi/adapter/environment.rs new file mode 100644 index 0000000..33b9727 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/environment.rs @@ -0,0 +1,76 @@ +//! WASI imports for connector environment operations. + +use std::{io, net::SocketAddr, task::Poll}; + +use crate::socket::SocketContext; +use crate::{ + host::{environment::HostConnectorEnvironmentIo, socket::HostOperationId}, + wasi::{ + imports::{ + HOST_PENDING, cancel_operation, start_local_addr_for_remote, take_local_addr_for_remote, + }, + wire::{ + common::{host_error, status}, + options::encode_socket_context, + socket::{SOCKET_ADDRESS_LEN, decode_socket_address, encode_socket_address}, + }, + }, +}; + +#[derive(Default)] +pub struct WasiHostConnectorEnvironmentIo; + +impl HostConnectorEnvironmentIo for WasiHostConnectorEnvironmentIo { + fn submit_local_addr_for_remote( + &self, + operation: HostOperationId, + remote_addr: SocketAddr, + context: &SocketContext, + ) -> io::Result<()> { + let encoded = encode_socket_address(remote_addr); + let encoded_context = encode_socket_context(context)?; + status("start_local_addr_for_remote", unsafe { + start_local_addr_for_remote( + operation.0, + encoded.as_ptr() as u32, + SOCKET_ADDRESS_LEN as u32, + encoded_context.as_ptr() as u32, + encoded_context.len() as u32, + ) + }) + } + + fn take_local_addr_for_remote( + &self, + operation: HostOperationId, + ) -> Poll> { + take_address( + "take_local_addr_for_remote", + operation, + take_local_addr_for_remote, + ) + } + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + status("cancel_operation", unsafe { cancel_operation(operation.0) }) + } +} + +fn take_address( + name: &'static str, + operation: HostOperationId, + take: unsafe extern "C" fn(u64, u32, u32) -> i32, +) -> Poll> { + let mut encoded = [0_u8; SOCKET_ADDRESS_LEN]; + match unsafe { + take( + operation.0, + encoded.as_mut_ptr() as u32, + SOCKET_ADDRESS_LEN as u32, + ) + } { + HOST_PENDING => Poll::Pending, + 0 => Poll::Ready(decode_socket_address(&encoded)), + value => Poll::Ready(Err(host_error(name, value))), + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/event.rs b/vendor/easytier/easytier-core/src/wasi/adapter/event.rs new file mode 100644 index 0000000..8b5c139 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/event.rs @@ -0,0 +1,60 @@ +use crate::{ + events::{CoreEvent, CoreEventSink}, + wasi::imports::emit_event, +}; + +#[derive(Debug)] +pub struct WasiHostEventSink { + handle: u64, +} + +impl WasiHostEventSink { + pub fn new(handle: u64) -> Self { + Self { handle } + } +} + +impl CoreEventSink for WasiHostEventSink { + fn emit(&self, event: CoreEvent) { + let kind = event_kind(&event); + let message = format!("{event:?}"); + let _ = unsafe { + emit_event( + self.handle, + kind.as_ptr() as u32, + kind.len() as u32, + message.as_ptr() as u32, + message.len() as u32, + ) + }; + } +} + +fn event_kind(event: &CoreEvent) -> &'static str { + match event { + CoreEvent::PeerAdded(_) => "peer_added", + CoreEvent::PeerRemoved(_) => "peer_removed", + CoreEvent::PeerConnAdded(_) => "peer_connection_added", + CoreEvent::PeerConnRemoved(_) => "peer_connection_removed", + CoreEvent::CredentialChanged => "credential_changed", + CoreEvent::ManualConnecting { .. } => "connecting", + CoreEvent::ManualConnectError { .. } => "connect_error", + CoreEvent::ListenerPlanFailed { .. } => "listener_plan_failed", + CoreEvent::ListenerAdded { .. } => "listener_added", + CoreEvent::ListenerRemoved { .. } => "listener_removed", + CoreEvent::ListenerAddFailed { .. } => "listener_add_failed", + CoreEvent::ListenerAcceptFailed { .. } => "listener_accept_failed", + CoreEvent::ListenerSocketAccepted { .. } => "listener_socket_accepted", + CoreEvent::ListenerAcceptedSocketHandleFailed { .. } => "listener_socket_handle_failed", + CoreEvent::TunnelAccepted { .. } => "tunnel_accepted", + CoreEvent::TunnelAdmissionFailed { .. } => "tunnel_admission_failed", + CoreEvent::UdpPortMappingEstablished { .. } => "udp_port_mapping_established", + CoreEvent::ProxyCidrsUpdated { .. } => "proxy_cidrs_updated", + CoreEvent::PublicIpv6LeaseChanged { .. } => "public_ipv6_lease_changed", + CoreEvent::PublicIpv6RoutesChanged { .. } => "public_ipv6_routes_changed", + CoreEvent::VpnPortalStarted(_) => "vpn_portal_started", + CoreEvent::VpnPortalClientConnected { .. } => "vpn_portal_client_connected", + CoreEvent::VpnPortalClientDisconnected { .. } => "vpn_portal_client_disconnected", + CoreEvent::GatewayPortForwardAdded(_) => "gateway_port_forward_added", + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/management.rs b/vendor/easytier/easytier-core/src/wasi/adapter/management.rs new file mode 100644 index 0000000..a031659 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/management.rs @@ -0,0 +1,66 @@ +use std::{io, task::Poll}; + +use crate::{ + host::{management::HostManagementIo, socket::HostOperationId}, + wasi::{ + imports::{HOST_PENDING, cancel_operation, start_management_call, take_management_call}, + wire::common::{host_error, status}, + }, +}; + +const MAX_MANAGEMENT_RESULT_LEN: usize = 16 * 1024 * 1024; + +#[derive(Clone, Default)] +pub struct WasiHostManagementIo; + +impl HostManagementIo for WasiHostManagementIo { + fn submit_call(&self, operation: HostOperationId, request: &[u8]) -> io::Result<()> { + let length = u32::try_from(request.len()).map_err(|_| { + io::Error::new( + io::ErrorKind::InvalidInput, + "management request is too long", + ) + })?; + status("start_management_call", unsafe { + start_management_call(operation.0, request.as_ptr() as u32, length) + }) + } + + fn take_call(&self, operation: HostOperationId) -> Poll>> { + let required = unsafe { take_management_call(operation.0, 0, 0) }; + if required == HOST_PENDING { + return Poll::Pending; + } + if required <= 0 { + return Poll::Ready(Err(host_error("take_management_call", required))); + } + let required = usize::try_from(required).expect("positive i32 fits usize"); + if required > MAX_MANAGEMENT_RESULT_LEN { + let _ = unsafe { cancel_operation(operation.0) }; + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::InvalidData, + "host management response is too long", + ))); + } + let mut response = vec![0; required]; + let copied = unsafe { + take_management_call( + operation.0, + response.as_mut_ptr() as u32, + u32::try_from(required).expect("management result limit fits u32"), + ) + }; + if copied != i32::try_from(required).expect("management result length fits i32") { + let _ = unsafe { cancel_operation(operation.0) }; + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::InvalidData, + "host management response length changed", + ))); + } + Poll::Ready(Ok(response)) + } + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + status("cancel_operation", unsafe { cancel_operation(operation.0) }) + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/mod.rs b/vendor/easytier/easytier-core/src/wasi/adapter/mod.rs new file mode 100644 index 0000000..7ef44d1 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/mod.rs @@ -0,0 +1,11 @@ +//! Concrete implementations of portable Host capability seams for WASI. + +pub mod dns; +pub mod environment; +pub mod event; +#[cfg(feature = "management")] +pub mod management; +pub mod packet; +pub mod socket; +#[cfg(feature = "wasm-host-tunnel")] +pub mod tunnel; diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/packet.rs b/vendor/easytier/easytier-core/src/wasi/adapter/packet.rs new file mode 100644 index 0000000..0e5c56e --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/packet.rs @@ -0,0 +1,59 @@ +use std::{io, task::Poll}; + +use crate::{ + host::{ + packet::{HostPacketIo, HostPacketSinkHandle}, + socket::HostOperationId, + }, + wasi::{ + imports::{ + HOST_PENDING, HOST_WOULD_BLOCK, cancel_operation, start_packet_write_ready, + take_packet_write_ready, try_packet_write, + }, + wire::common::{host_error, status}, + }, +}; + +const MAX_HOST_PACKET_LEN: usize = 1024 * 1024; + +#[derive(Default)] +pub struct WasiHostPacketIo; + +impl HostPacketIo for WasiHostPacketIo { + fn try_write_packet(&self, handle: HostPacketSinkHandle, packet: &[u8]) -> io::Result<()> { + if packet.len() > MAX_HOST_PACKET_LEN { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("host packet exceeds {MAX_HOST_PACKET_LEN} bytes"), + )); + } + let length = u32::try_from(packet.len()).expect("host packet limit fits u32"); + match unsafe { try_packet_write(handle.0, packet.as_ptr() as u32, length) } { + 0 => Ok(()), + HOST_WOULD_BLOCK => Err(io::ErrorKind::WouldBlock.into()), + value => Err(host_error("try_packet_write", value)), + } + } + + fn submit_write_ready( + &self, + handle: HostPacketSinkHandle, + operation: HostOperationId, + ) -> io::Result<()> { + status("start_packet_write_ready", unsafe { + start_packet_write_ready(handle.0, operation.0) + }) + } + + fn take_write_ready(&self, operation: HostOperationId) -> Poll> { + match unsafe { take_packet_write_ready(operation.0) } { + HOST_PENDING => Poll::Pending, + 0 => Poll::Ready(Ok(())), + value => Poll::Ready(Err(host_error("take_packet_write_ready", value))), + } + } + + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + status("cancel_operation", unsafe { cancel_operation(operation.0) }) + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/socket/backend.rs b/vendor/easytier/easytier-core/src/wasi/adapter/socket/backend.rs new file mode 100644 index 0000000..4691488 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/socket/backend.rs @@ -0,0 +1,266 @@ +use std::{io, task::Poll}; + +use crate::host::socket::{ + HostOperationId, HostSocketHandle, HostSocketIo, HostTcpIo, + factory::{HostSocketFactoryIo, HostTcpConnectResult, HostUdpBindResult}, + listener::{HostTcpBindResult, HostTcpListenerIo}, + udp::{HostUdpDatagram, HostUdpIo}, +}; +use crate::socket::{ + tcp::{TcpConnectOptions, TcpListenOptions}, + udp::{UdpBindOptions, UdpSocketSendMeta}, +}; + +use crate::wasi::{ + imports::{ + HOST_PENDING, cancel_operation, close, start_tcp_accept, start_tcp_bind, start_tcp_connect, + start_udp_bind, take_tcp_accept, take_tcp_bind, take_tcp_connect, take_udp_bind, + }, + wire::{ + common::{host_error, status, tcp_connect_error}, + options::{ + BOUND_SOCKET_RESULT_LEN, TCP_SOCKET_RESULT_LEN, decode_tcp_bind_result, + decode_tcp_socket_result, decode_udp_bind_result, encode_tcp_connect_options, + encode_tcp_listen_options, encode_udp_bind_options, + }, + }, +}; + +use super::{WasiHostTcpIo, udp::WasiHostUdpIo}; + +#[derive(Default)] +pub struct WasiHostSocketBackend { + tcp: WasiHostTcpIo, + udp: WasiHostUdpIo, +} + +impl WasiHostSocketBackend { + fn decode_transferred(&self, encoded: &[u8], decoded: io::Result) -> io::Result { + match decoded { + Ok(result) => Ok(result), + Err(decode_error) => { + let handle = HostSocketHandle(u64::from_be_bytes(encoded[..8].try_into().unwrap())); + match self.close(handle) { + Ok(()) => Err(decode_error), + Err(close_error) => Err(io::Error::new( + decode_error.kind(), + format!( + "{decode_error}; additionally failed to close malformed host result: {close_error}" + ), + )), + } + } + } + } +} + +impl HostSocketIo for WasiHostSocketBackend { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.tcp.forget_operation(operation); + self.udp.forget_operation(operation); + status("cancel_operation", unsafe { cancel_operation(operation.0) }) + } + + fn close(&self, handle: HostSocketHandle) -> io::Result<()> { + status("close", unsafe { close(handle.0) }) + } +} + +impl HostTcpIo for WasiHostSocketBackend { + fn submit_read( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + capacity: usize, + ) -> io::Result<()> { + self.tcp.submit_read(handle, operation, capacity) + } + + fn take_read(&self, operation: HostOperationId) -> Poll>> { + self.tcp.take_read(operation) + } + + fn submit_write( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + source: &[u8], + ) -> io::Result<()> { + self.tcp.submit_write(handle, operation, source) + } + + fn take_write(&self, operation: HostOperationId) -> Poll> { + self.tcp.take_write(operation) + } +} + +impl HostUdpIo for WasiHostSocketBackend { + fn submit_recv( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + capacity: usize, + ) -> io::Result<()> { + self.udp.submit_recv(handle, operation, capacity) + } + + fn take_recv(&self, operation: HostOperationId) -> Poll> { + self.udp.take_recv(operation) + } + + fn try_send( + &self, + handle: HostSocketHandle, + source: &[u8], + peer_addr: std::net::SocketAddr, + meta: UdpSocketSendMeta, + ) -> io::Result<()> { + self.udp.try_send(handle, source, peer_addr, meta) + } + + fn submit_send_ready( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + ) -> io::Result<()> { + self.udp.submit_send_ready(handle, operation) + } + + fn take_send_ready(&self, operation: HostOperationId) -> Poll> { + self.udp.take_send_ready(operation) + } +} + +impl HostSocketFactoryIo for WasiHostSocketBackend { + fn submit_tcp_connect( + &self, + operation: HostOperationId, + options: &TcpConnectOptions, + ) -> io::Result<()> { + let encoded = encode_tcp_connect_options(options)?; + status("start_tcp_connect", unsafe { + start_tcp_connect( + operation.0, + encoded.as_ptr() as u32, + encoded_len("TCP connect options", &encoded)?, + ) + }) + } + + fn take_tcp_connect( + &self, + operation: HostOperationId, + ) -> Poll> { + let mut encoded = [0_u8; TCP_SOCKET_RESULT_LEN]; + match unsafe { + take_tcp_connect( + operation.0, + encoded.as_mut_ptr() as u32, + TCP_SOCKET_RESULT_LEN as u32, + ) + } { + HOST_PENDING => Poll::Pending, + 0 => Poll::Ready(self.decode_transferred(&encoded, decode_tcp_socket_result(&encoded))), + value => Poll::Ready(Err(tcp_connect_error(value))), + } + } + + fn submit_udp_bind( + &self, + operation: HostOperationId, + options: &UdpBindOptions, + ) -> io::Result<()> { + let encoded = encode_udp_bind_options(options)?; + status("start_udp_bind", unsafe { + start_udp_bind( + operation.0, + encoded.as_ptr() as u32, + encoded_len("UDP bind options", &encoded)?, + ) + }) + } + + fn take_udp_bind(&self, operation: HostOperationId) -> Poll> { + let mut encoded = [0_u8; BOUND_SOCKET_RESULT_LEN]; + match unsafe { + take_udp_bind( + operation.0, + encoded.as_mut_ptr() as u32, + BOUND_SOCKET_RESULT_LEN as u32, + ) + } { + HOST_PENDING => Poll::Pending, + 0 => Poll::Ready(self.decode_transferred(&encoded, decode_udp_bind_result(&encoded))), + value => Poll::Ready(Err(host_error("take_udp_bind", value))), + } + } +} + +impl HostTcpListenerIo for WasiHostSocketBackend { + fn submit_tcp_bind( + &self, + operation: HostOperationId, + options: &TcpListenOptions, + ) -> io::Result<()> { + let encoded = encode_tcp_listen_options(options)?; + status("start_tcp_bind", unsafe { + start_tcp_bind( + operation.0, + encoded.as_ptr() as u32, + encoded_len("TCP listen options", &encoded)?, + ) + }) + } + + fn take_tcp_bind(&self, operation: HostOperationId) -> Poll> { + let mut encoded = [0_u8; BOUND_SOCKET_RESULT_LEN]; + match unsafe { + take_tcp_bind( + operation.0, + encoded.as_mut_ptr() as u32, + BOUND_SOCKET_RESULT_LEN as u32, + ) + } { + HOST_PENDING => Poll::Pending, + 0 => Poll::Ready(self.decode_transferred(&encoded, decode_tcp_bind_result(&encoded))), + value => Poll::Ready(Err(host_error("take_tcp_bind", value))), + } + } + + fn submit_tcp_accept( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + ) -> io::Result<()> { + status("start_tcp_accept", unsafe { + start_tcp_accept(handle.0, operation.0) + }) + } + + fn take_tcp_accept( + &self, + operation: HostOperationId, + ) -> Poll> { + let mut encoded = [0_u8; TCP_SOCKET_RESULT_LEN]; + match unsafe { + take_tcp_accept( + operation.0, + encoded.as_mut_ptr() as u32, + TCP_SOCKET_RESULT_LEN as u32, + ) + } { + HOST_PENDING => Poll::Pending, + 0 => Poll::Ready(self.decode_transferred(&encoded, decode_tcp_socket_result(&encoded))), + value => Poll::Ready(Err(host_error("take_tcp_accept", value))), + } + } +} + +fn encoded_len(description: &str, encoded: &[u8]) -> io::Result { + u32::try_from(encoded.len()).map_err(|_| { + io::Error::new( + io::ErrorKind::InvalidInput, + format!("{description} exceed WASI guest memory"), + ) + }) +} diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/socket/mod.rs b/vendor/easytier/easytier-core/src/wasi/adapter/socket/mod.rs new file mode 100644 index 0000000..8f9d523 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/socket/mod.rs @@ -0,0 +1,124 @@ +//! WASI TCP adapter behind the portable host socket seams. +//! +//! [`WasiHostTcpIo`] implements the TCP half of the host socket I/O traits on +//! top of the `easytier_host` import module, and +//! [`backend::WasiHostSocketBackend`] composes the TCP, UDP, factory, and +//! listener imports into one host socket backend. Shared status mapping and +//! wire codecs live in [`crate::wasi::wire`]. + +pub mod backend; +pub mod udp; + +use std::{collections::HashMap, io, sync::Mutex, task::Poll}; + +use crate::{ + host::socket::{HostOperationId, HostSocketHandle, HostSocketIo, HostTcpIo}, + wasi::{ + imports::{ + HOST_PENDING, cancel_operation, close, start_read, start_write, take_read, take_write, + }, + wire::common::{host_error, status}, + }, +}; + +#[derive(Debug, Default)] +pub struct WasiHostTcpIo { + read_buffers: Mutex>>, +} + +impl WasiHostTcpIo { + pub(super) fn forget_operation(&self, operation: HostOperationId) { + self.read_buffers + .lock() + .expect("WASI read buffer registry poisoned") + .remove(&operation); + } +} + +impl HostSocketIo for WasiHostTcpIo { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.forget_operation(operation); + status("cancel_operation", unsafe { cancel_operation(operation.0) }) + } + + fn close(&self, handle: HostSocketHandle) -> io::Result<()> { + status("close", unsafe { close(handle.0) }) + } +} + +impl HostTcpIo for WasiHostTcpIo { + fn submit_read( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + capacity: usize, + ) -> io::Result<()> { + let capacity_u32 = u32::try_from(capacity) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "read buffer is too large"))?; + status("start_read", unsafe { + start_read(handle.0, operation.0, capacity_u32) + })?; + self.read_buffers + .lock() + .expect("WASI read buffer registry poisoned") + .insert(operation, vec![0; capacity]); + Ok(()) + } + + fn take_read(&self, operation: HostOperationId) -> Poll>> { + let mut buffers = self + .read_buffers + .lock() + .expect("WASI read buffer registry poisoned"); + let Some(buffer) = buffers.get_mut(&operation) else { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::NotFound, + "WASI read operation buffer is missing", + ))); + }; + let result = + unsafe { take_read(operation.0, buffer.as_mut_ptr() as u32, buffer.len() as u32) }; + match result { + HOST_PENDING => Poll::Pending, + value if value >= 0 => { + let length = value as usize; + if length > buffer.len() { + buffers.remove(&operation); + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::InvalidData, + "host read completion exceeds the submitted capacity", + ))); + } + let mut buffer = buffers.remove(&operation).unwrap(); + buffer.truncate(length); + Poll::Ready(Ok(buffer)) + } + value => { + buffers.remove(&operation); + Poll::Ready(Err(host_error("take_read", value))) + } + } + } + + fn submit_write( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + source: &[u8], + ) -> io::Result<()> { + let length = u32::try_from(source.len()).map_err(|_| { + io::Error::new(io::ErrorKind::InvalidInput, "write buffer is too large") + })?; + status("start_write", unsafe { + start_write(handle.0, operation.0, source.as_ptr() as u32, length) + }) + } + + fn take_write(&self, operation: HostOperationId) -> Poll> { + match unsafe { take_write(operation.0) } { + HOST_PENDING => Poll::Pending, + 0 => Poll::Ready(Ok(())), + value => Poll::Ready(Err(host_error("take_write", value))), + } + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/socket/udp.rs b/vendor/easytier/easytier-core/src/wasi/adapter/socket/udp.rs new file mode 100644 index 0000000..cffa052 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/socket/udp.rs @@ -0,0 +1,179 @@ +use std::{collections::HashMap, io, sync::Mutex, task::Poll}; + +use crate::socket::udp::{UdpSocketRecvMeta, UdpSocketSendMeta}; + +use crate::{ + host::{ + socket::udp::{HostUdpDatagram, HostUdpIo}, + socket::{HostOperationId, HostSocketHandle, HostSocketIo}, + }, + wasi::{ + imports::{ + HOST_PENDING, HOST_WOULD_BLOCK, cancel_operation, close, start_udp_recv, + start_udp_send_ready, take_udp_recv, take_udp_send_ready, try_udp_send, + }, + wire::{ + common::{host_error, status}, + socket::{UDP_METADATA_LEN, decode_udp_metadata, encode_udp_metadata}, + }, + }, +}; + +struct WasiUdpRecvBuffer { + data: Vec, + metadata: [u8; UDP_METADATA_LEN], +} + +#[derive(Default)] +pub struct WasiHostUdpIo { + recv_buffers: Mutex>, +} + +impl WasiHostUdpIo { + pub(super) fn forget_operation(&self, operation: HostOperationId) { + self.recv_buffers + .lock() + .expect("WASI UDP receive buffer registry poisoned") + .remove(&operation); + } +} + +impl HostSocketIo for WasiHostUdpIo { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.forget_operation(operation); + status("cancel_operation", unsafe { cancel_operation(operation.0) }) + } + + fn close(&self, handle: HostSocketHandle) -> io::Result<()> { + status("close", unsafe { close(handle.0) }) + } +} + +impl HostUdpIo for WasiHostUdpIo { + fn submit_recv( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + capacity: usize, + ) -> io::Result<()> { + let capacity_u32 = u32::try_from(capacity).map_err(|_| { + io::Error::new( + io::ErrorKind::InvalidInput, + "UDP receive buffer is too large", + ) + })?; + status("start_udp_recv", unsafe { + start_udp_recv(handle.0, operation.0, capacity_u32) + })?; + self.recv_buffers + .lock() + .expect("WASI UDP receive buffer registry poisoned") + .insert( + operation, + WasiUdpRecvBuffer { + data: vec![0; capacity], + metadata: [0; UDP_METADATA_LEN], + }, + ); + Ok(()) + } + + fn take_recv(&self, operation: HostOperationId) -> Poll> { + let mut buffers = self + .recv_buffers + .lock() + .expect("WASI UDP receive buffer registry poisoned"); + let Some(buffer) = buffers.get_mut(&operation) else { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::NotFound, + "WASI UDP receive operation buffer is missing", + ))); + }; + let result = unsafe { + take_udp_recv( + operation.0, + buffer.data.as_mut_ptr() as u32, + buffer.data.len() as u32, + buffer.metadata.as_mut_ptr() as u32, + UDP_METADATA_LEN as u32, + ) + }; + match result { + HOST_PENDING => Poll::Pending, + value if value >= 0 => { + let length = value as usize; + let mut buffer = buffers.remove(&operation).unwrap(); + if length > buffer.data.len() { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::InvalidData, + "host UDP receive completion exceeds the submitted capacity", + ))); + } + buffer.data.truncate(length); + let (peer_addr, dst_ip, _) = match decode_udp_metadata(&buffer.metadata) { + Ok(metadata) => metadata, + Err(error) => return Poll::Ready(Err(error)), + }; + Poll::Ready(Ok(HostUdpDatagram { + data: buffer.data, + peer_addr, + meta: UdpSocketRecvMeta { dst_ip }, + })) + } + value => { + buffers.remove(&operation); + Poll::Ready(Err(host_error("take_udp_recv", value))) + } + } + } + + fn try_send( + &self, + handle: HostSocketHandle, + source: &[u8], + peer_addr: std::net::SocketAddr, + meta: UdpSocketSendMeta, + ) -> io::Result<()> { + if meta.src_ifindex.is_some() && !matches!(meta.src_ip, Some(std::net::IpAddr::V6(_))) { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "UDP source interface index requires an IPv6 source address", + )); + } + let length = u32::try_from(source.len()).map_err(|_| { + io::Error::new(io::ErrorKind::InvalidInput, "UDP send buffer is too large") + })?; + let metadata = encode_udp_metadata(peer_addr, meta.src_ip, meta.src_ifindex); + match unsafe { + try_udp_send( + handle.0, + source.as_ptr() as u32, + length, + metadata.as_ptr() as u32, + UDP_METADATA_LEN as u32, + ) + } { + 0 => Ok(()), + HOST_WOULD_BLOCK => Err(io::ErrorKind::WouldBlock.into()), + value => Err(host_error("try_udp_send", value)), + } + } + + fn submit_send_ready( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + ) -> io::Result<()> { + status("start_udp_send_ready", unsafe { + start_udp_send_ready(handle.0, operation.0) + }) + } + + fn take_send_ready(&self, operation: HostOperationId) -> Poll> { + match unsafe { take_udp_send_ready(operation.0) } { + HOST_PENDING => Poll::Pending, + 0 => Poll::Ready(Ok(())), + value => Poll::Ready(Err(host_error("take_udp_send_ready", value))), + } + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/adapter/tunnel.rs b/vendor/easytier/easytier-core/src/wasi/adapter/tunnel.rs new file mode 100644 index 0000000..3510406 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/adapter/tunnel.rs @@ -0,0 +1,397 @@ +//! WASI imports for host-owned message tunnels. + +use std::{ + collections::HashMap, + io, + sync::{Arc, Mutex}, + task::Poll, +}; + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +use std::{fmt, marker::PhantomData}; + +use crate::{ + host::{ + socket::{HostOperationId, HostSocketHandle, HostSocketIo}, + tunnel::HostTunnelIo, + }, + tunnel::Tunnel, + wasi::{ + imports::{ + HOST_PENDING, HOST_TUNNEL_CLOSED, cancel_operation, close, start_tunnel_receive, + start_tunnel_send, take_tunnel_receive, take_tunnel_send, + }, + wire::common::{host_error, status}, + }, +}; + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +use crate::{ + listener::{ + ExternalListenerFactory, ExternalListenerRequest, queue::HostListenerQueue, + transport::AcceptedTransport, + }, + socket::{SocketListener, tcp::VirtualTcpSocket}, +}; + +#[cfg(feature = "wasm-host-tunnel-outbound")] +use crate::connectivity::manual::ExternalTunnelConnector; +#[cfg(feature = "wasm-host-tunnel-outbound")] +use crate::wasi::imports::{start_tunnel_connect, take_tunnel_connect}; + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +const MAX_PENDING_HOST_TUNNELS: usize = 256; + +#[derive(Default)] +pub struct WasiHostTunnelIo { + receive_capacities: Mutex>, +} + +impl WasiHostTunnelIo { + fn forget_operation(&self, operation: HostOperationId) { + self.receive_capacities.lock().unwrap().remove(&operation); + } +} + +impl HostSocketIo for WasiHostTunnelIo { + fn cancel_operation(&self, operation: HostOperationId) -> io::Result<()> { + self.forget_operation(operation); + status("cancel_operation", unsafe { cancel_operation(operation.0) }) + } + + fn close(&self, handle: HostSocketHandle) -> io::Result<()> { + status("close", unsafe { close(handle.0) }) + } +} + +impl HostTunnelIo for WasiHostTunnelIo { + fn submit_receive( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + capacity: usize, + ) -> io::Result<()> { + let capacity = u32::try_from(capacity).map_err(|_| { + io::Error::new( + io::ErrorKind::InvalidInput, + "host tunnel receive buffer is too large", + ) + })?; + status("start_tunnel_receive", unsafe { + start_tunnel_receive(handle.0, operation.0, capacity) + })?; + self.receive_capacities + .lock() + .unwrap() + .insert(operation, capacity as usize); + Ok(()) + } + + fn take_receive(&self, operation: HostOperationId) -> Poll>> { + let mut capacities = self.receive_capacities.lock().unwrap(); + let Some(&capacity) = capacities.get(&operation) else { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::NotFound, + "WASI host tunnel receive capacity is missing", + ))); + }; + let result = unsafe { take_tunnel_receive(operation.0, 0, 0) }; + match result { + HOST_PENDING => Poll::Pending, + HOST_TUNNEL_CLOSED => { + capacities.remove(&operation); + Poll::Ready(Err(io::Error::new( + io::ErrorKind::UnexpectedEof, + "host tunnel closed", + ))) + } + length if length >= 0 => { + let length = length as usize; + if length > capacity { + capacities.remove(&operation); + let _ = unsafe { cancel_operation(operation.0) }; + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::InvalidData, + "host tunnel payload exceeds submitted capacity", + ))); + } + let mut buffer = vec![0; length]; + let copied = unsafe { + take_tunnel_receive( + operation.0, + buffer.as_mut_ptr() as u32, + buffer.len() as u32, + ) + }; + capacities.remove(&operation); + if copied == length as i32 { + Poll::Ready(Ok(buffer)) + } else { + let _ = unsafe { cancel_operation(operation.0) }; + Poll::Ready(Err(host_error("take_tunnel_receive copy", copied))) + } + } + code => { + capacities.remove(&operation); + Poll::Ready(Err(host_error("take_tunnel_receive", code))) + } + } + } + + fn submit_send( + &self, + handle: HostSocketHandle, + operation: HostOperationId, + source: &[u8], + ) -> io::Result<()> { + let length = u32::try_from(source.len()).map_err(|_| { + io::Error::new( + io::ErrorKind::InvalidInput, + "host tunnel send buffer is too large", + ) + })?; + status("start_tunnel_send", unsafe { + start_tunnel_send(handle.0, operation.0, source.as_ptr() as u32, length) + }) + } + + fn take_send(&self, operation: HostOperationId) -> Poll> { + match unsafe { take_tunnel_send(operation.0) } { + HOST_PENDING => Poll::Pending, + 0 => Poll::Ready(Ok(())), + code => Poll::Ready(Err(host_error("take_tunnel_send", code))), + } + } +} + +#[cfg(feature = "wasm-host-tunnel-outbound")] +pub(crate) struct WasiHostTunnelConnector { + runtime: crate::host::socket::HostSocketRuntime, + io: Arc, + supported_schemes: Arc<[String]>, +} + +#[cfg(feature = "wasm-host-tunnel-outbound")] +impl WasiHostTunnelConnector { + pub(crate) fn new( + runtime: crate::host::socket::HostSocketRuntime, + io: Arc, + supported_schemes: Arc<[String]>, + ) -> Self { + Self { + runtime, + io, + supported_schemes, + } + } +} + +#[cfg(feature = "wasm-host-tunnel-outbound")] +#[async_trait::async_trait] +impl ExternalTunnelConnector for WasiHostTunnelConnector { + fn supports_scheme(&self, scheme: &str) -> bool { + self.supported_schemes + .iter() + .any(|supported| supported == scheme) + } + + async fn connect(&self, url: &url::Url) -> anyhow::Result> { + let encoded = url.as_str().as_bytes(); + let encoded_len = u32::try_from(encoded.len()) + .map_err(|_| anyhow::anyhow!("host tunnel URL exceeds WASI guest memory"))?; + let handle = self + .runtime + .run_operation( + self.io.clone(), + |_, operation| { + status("start_tunnel_connect", unsafe { + start_tunnel_connect(operation.0, encoded.as_ptr() as u32, encoded_len) + }) + }, + |_, operation| match unsafe { take_tunnel_connect(operation.0) } { + value if value == i64::from(HOST_PENDING) => Poll::Pending, + value if value > 0 => Poll::Ready(Ok(HostSocketHandle(value as u64))), + value => Poll::Ready(Err(host_error( + "take_tunnel_connect", + i32::try_from(value).unwrap_or(i32::MIN), + ))), + }, + |io, operation| io.cancel_operation(operation), + ) + .await?; + let local_url = url::Url::parse(&format!("{}://0.0.0.0:0", url.scheme()))?; + Ok(crate::tunnel::host_tunnel::new_host_tunnel( + self.runtime.clone(), + self.io.clone(), + handle, + local_url, + url.clone(), + None, + )) + } +} + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +type HostTunnelQueue = HostListenerQueue>; + +/// Owns the Host Tunnel I/O Adapter and its listener admission queue. +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +pub(crate) struct WasiHostTunnelIngress { + runtime: crate::host::socket::HostSocketRuntime, + io: Arc, + queue: Arc, + supported_schemes: Arc<[String]>, +} + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +impl WasiHostTunnelIngress { + pub(crate) fn new( + runtime: crate::host::socket::HostSocketRuntime, + supported_schemes: Arc<[String]>, + ) -> Self { + Self::with_io( + runtime, + Arc::new(WasiHostTunnelIo::default()), + supported_schemes, + ) + } + + pub(crate) fn with_io( + runtime: crate::host::socket::HostSocketRuntime, + io: Arc, + supported_schemes: Arc<[String]>, + ) -> Self { + Self { + runtime, + io, + queue: Arc::new(HostListenerQueue::new(MAX_PENDING_HOST_TUNNELS)), + supported_schemes, + } + } + + pub(crate) fn listener_factory( + &self, + ) -> Arc>> + where + TcpSocket: VirtualTcpSocket, + { + Arc::new(WasiHostTunnelListenerFactory { + queue: self.queue.clone(), + supported_schemes: self.supported_schemes.clone(), + }) + } + + pub(crate) fn accept( + &self, + handle: HostSocketHandle, + metadata: crate::wasi::schema::WasiHostTunnelMetadata, + ) -> anyhow::Result<()> { + let crate::wasi::schema::WasiHostTunnelMetadata { + local_url, + remote_url, + resolved_remote_url, + .. + } = metadata; + self.queue.enqueue_with(|| { + crate::tunnel::host_tunnel::new_host_tunnel( + self.runtime.clone(), + self.io.clone(), + handle, + local_url, + remote_url, + resolved_remote_url, + ) + }) + } +} + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +struct WasiHostTunnelListenerFactory { + queue: Arc, + supported_schemes: Arc<[String]>, +} + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +impl ExternalListenerFactory> + for WasiHostTunnelListenerFactory +where + TcpSocket: VirtualTcpSocket, +{ + fn supports_scheme(&self, scheme: &str) -> bool { + self.supported_schemes + .iter() + .any(|supported| supported == scheme) + } + + fn create( + &self, + request: ExternalListenerRequest, + ) -> Box>> { + Box::new(WasiHostTunnelListener { + registered: self.queue.register_listener(), + queue: self.queue.clone(), + local_url: request.url, + tcp_socket: PhantomData, + }) + } +} + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +struct WasiHostTunnelListener { + registered: bool, + queue: Arc, + local_url: url::Url, + tcp_socket: PhantomData TcpSocket>, +} + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +impl fmt::Debug for WasiHostTunnelListener { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("WasiHostTunnelListener") + .field("local_url", &self.local_url) + .field("registered", &self.registered) + .finish() + } +} + +#[async_trait::async_trait] +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +impl SocketListener for WasiHostTunnelListener +where + TcpSocket: VirtualTcpSocket, +{ + type Accepted = AcceptedTransport; + + async fn listen(&mut self) -> anyhow::Result<()> { + if !self.registered { + anyhow::bail!("Host Tunnel listener queue is closed"); + } + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + let tunnel = self + .queue + .accept() + .await + .ok_or_else(|| anyhow::anyhow!("Host Tunnel listener queue is closed"))?; + Ok(AcceptedTransport::Tunnel { + tunnel, + local_url: self.local_url.clone(), + }) + } + + fn local_url(&self) -> url::Url { + self.local_url.clone() + } +} + +#[cfg(not(feature = "wasm-host-tunnel-outbound"))] +impl Drop for WasiHostTunnelListener { + fn drop(&mut self) { + if self.registered { + self.queue.unregister_listener(); + } + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/imports.rs b/vendor/easytier/easytier-core/src/wasi/imports.rs new file mode 100644 index 0000000..c98f6b3 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/imports.rs @@ -0,0 +1,235 @@ +//! Raw `easytier_host` imports, compiled only for the WASI guest. +//! +//! [`crate::wasi::abi`] declares the shared contract metadata; each import +//! below documents its own ownership and completion rules. Concrete adapters +//! call these functions directly. + +pub(crate) const HOST_PENDING: i32 = -1; +pub(crate) const HOST_WOULD_BLOCK: i32 = -5; +#[cfg(feature = "wasm-host-tunnel")] +pub(crate) const HOST_TUNNEL_CLOSED: i32 = -10; + +#[link(wasm_import_module = "easytier_host")] +unsafe extern "C" { + /// Emits one best-effort instance event after the host copies both strings. + /// + /// The host must not block the guest. A non-zero status drops this event + /// without affecting core execution. + pub(crate) fn emit_event( + handle: u64, + kind: u32, + kind_len: u32, + message: u32, + message_len: u32, + ) -> i32; + + /// Encrypts `text_len` bytes in place and writes the AEAD tag immediately + /// after them. + /// + /// The guest reserves the algorithm's tag size in linear memory before + /// calling. Every non-zero result except + /// [`crate::wasi::abi::HOST_CRYPTO_AUTH_FAILED`] must leave the buffer + /// unchanged so the guest can use its built-in implementation. + #[cfg(feature = "wasi-crypto-offload")] + pub(crate) fn crypto_aead_seal( + algorithm: u32, + key: u32, + key_len: u32, + nonce: u32, + nonce_len: u32, + aad: u32, + aad_len: u32, + buffer: u32, + text_len: u32, + ) -> i32; + + /// Authenticates and decrypts `text_len` bytes in place using the AEAD tag + /// immediately after them. + /// + /// Authentication failure may change the buffer and must return + /// [`crate::wasi::abi::HOST_CRYPTO_AUTH_FAILED`]. Every other non-zero + /// result must leave the buffer unchanged so the guest can fall back. + #[cfg(feature = "wasi-crypto-offload")] + pub(crate) fn crypto_aead_open( + algorithm: u32, + key: u32, + key_len: u32, + nonce: u32, + nonce_len: u32, + aad: u32, + aad_len: u32, + buffer: u32, + text_len: u32, + ) -> i32; + + /// Starts one TCP read into a host-owned pending operation. + /// + /// The host records at most `capacity` bytes for `operation` and must not + /// write guest memory until [`take_read`] supplies a destination buffer. + pub(crate) fn start_read(handle: u64, operation: u64, capacity: u32) -> i32; + + /// Copies a completed TCP read into `destination`, returning its byte count. + /// + /// Returns [`HOST_PENDING`] while the operation is incomplete. A completed + /// read, including EOF with a zero length, consumes `operation`. + pub(crate) fn take_read(operation: u64, destination: u32, capacity: u32) -> i32; + + /// Starts one TCP write after copying `source[..length]` from guest memory. + pub(crate) fn start_write(handle: u64, operation: u64, source: u32, length: u32) -> i32; + + /// Reports completion of a TCP write and consumes `operation` on success or error. + pub(crate) fn take_write(operation: u64) -> i32; + + /// Starts receipt of one UDP datagram of at most `capacity` bytes. + pub(crate) fn start_udp_recv(handle: u64, operation: u64, capacity: u32) -> i32; + + /// Copies one completed UDP datagram and its metadata into guest memory. + /// + /// A non-pending result consumes `operation`; `metadata` has exactly + /// `metadata_len` bytes allocated by core for the socket wire format. + pub(crate) fn take_udp_recv( + operation: u64, + destination: u32, + capacity: u32, + metadata: u32, + metadata_len: u32, + ) -> i32; + + /// Attempts to enqueue one complete UDP datagram after copying its bytes and metadata. + /// + /// [`HOST_WOULD_BLOCK`] means the datagram was not accepted and has no + /// side effects. Any other success means the host owns a complete copy. + pub(crate) fn try_udp_send( + handle: u64, + source: u32, + length: u32, + metadata: u32, + metadata_len: u32, + ) -> i32; + + /// Starts waiting until another UDP send attempt may succeed. + pub(crate) fn start_udp_send_ready(handle: u64, operation: u64) -> i32; + + /// Reports UDP write readiness; readiness never sends a datagram itself. + pub(crate) fn take_udp_send_ready(operation: u64) -> i32; + + /// Starts a TCP connection using an encoded `TcpConnectOptions` document. + /// Requested socket protection must complete before the host connects. + pub(crate) fn start_tcp_connect(operation: u64, options: u32, options_len: u32) -> i32; + + /// Copies the completed TCP connection handle and addresses into `result`. + pub(crate) fn take_tcp_connect(operation: u64, result: u32, result_len: u32) -> i32; + + /// Starts a UDP bind using an encoded `UdpBindOptions` document. Requested + /// socket protection must complete before bind or datagram I/O. + pub(crate) fn start_udp_bind(operation: u64, options: u32, options_len: u32) -> i32; + + /// Copies the completed UDP socket handle and local address into `result`. + pub(crate) fn take_udp_bind(operation: u64, result: u32, result_len: u32) -> i32; + + /// Starts a TCP listener bind using an encoded `TcpListenOptions` document. + /// Requested socket protection must complete before bind/listen. + pub(crate) fn start_tcp_bind(operation: u64, options: u32, options_len: u32) -> i32; + + /// Copies the completed listener handle and local address into `result`. + pub(crate) fn take_tcp_bind(operation: u64, result: u32, result_len: u32) -> i32; + + /// Starts accepting one TCP stream from a listener handle. A protected + /// listener's accepted child must be protected before it is exposed. + pub(crate) fn start_tcp_accept(handle: u64, operation: u64) -> i32; + + /// Copies the accepted TCP stream handle and addresses into `result`. + pub(crate) fn take_tcp_accept(operation: u64, result: u32, result_len: u32) -> i32; + + /// Starts an address-record DNS lookup for an encoded [`crate::host::dns::DnsQuery`]. + /// When VPN bypass is active, the host must protect every underlying DNS + /// socket before sending a query or opening a DNS TCP connection. + pub(crate) fn start_dns_resolve(operation: u64, query: u32, query_len: u32) -> i32; + + /// Probes or copies the encoded DNS address result for `operation`. + /// + /// A zero-capacity call probes the required result length without consuming + /// it; a subsequent call with enough capacity copies and consumes it. + pub(crate) fn take_dns_resolve(operation: u64, result: u32, result_capacity: u32) -> i32; + + /// Starts a TXT-record DNS lookup for an encoded query. + pub(crate) fn start_dns_txt(operation: u64, query: u32, query_len: u32) -> i32; + + /// Probes or copies the encoded DNS TXT result using the DNS result protocol. + pub(crate) fn take_dns_txt(operation: u64, result: u32, result_capacity: u32) -> i32; + + /// Starts an SRV-record DNS lookup for an encoded query. + pub(crate) fn start_dns_srv(operation: u64, query: u32, query_len: u32) -> i32; + + /// Probes or copies the encoded DNS SRV result using the DNS result protocol. + pub(crate) fn take_dns_srv(operation: u64, result: u32, result_capacity: u32) -> i32; + + /// Starts finding the local address and source context needed to reach `remote_addr`. + /// When VPN bypass is active, the host must protect the underlying route- + /// probe socket before connecting or sending through it. + pub(crate) fn start_local_addr_for_remote( + operation: u64, + remote_addr: u32, + remote_addr_len: u32, + context: u32, + context_len: u32, + ) -> i32; + + /// Copies the resolved local socket address into the fixed-size `result` buffer. + pub(crate) fn take_local_addr_for_remote(operation: u64, result: u32, result_len: u32) -> i32; + + /// Starts one process-level WebClient management call after copying its request. + #[cfg(feature = "management")] + pub(crate) fn start_management_call(operation: u64, request: u32, request_len: u32) -> i32; + + /// Probes or copies the process-level management response for `operation`. + #[cfg(feature = "management")] + pub(crate) fn take_management_call(operation: u64, result: u32, result_capacity: u32) -> i32; + + /// Attempts to deliver one raw IP packet to a host packet sink. + /// + /// On success the host owns a complete copy. [`HOST_WOULD_BLOCK`] leaves + /// the packet unaccepted and requires core to wait for write readiness. + pub(crate) fn try_packet_write(handle: u64, packet: u32, packet_len: u32) -> i32; + + /// Starts waiting until another packet-sink admission attempt may succeed. + pub(crate) fn start_packet_write_ready(handle: u64, operation: u64) -> i32; + + /// Reports packet-sink write readiness; it never accepts a packet itself. + pub(crate) fn take_packet_write_ready(operation: u64) -> i32; + + #[cfg(feature = "wasm-host-tunnel")] + /// Starts receiving one complete host tunnel payload. + pub(crate) fn start_tunnel_receive(handle: u64, operation: u64, capacity: u32) -> i32; + + #[cfg(feature = "wasm-host-tunnel")] + /// Probes or copies one payload, or returns the closed sentinel. + /// + /// A null destination with zero capacity returns the payload length without + /// consuming it. A second call copies and consumes the payload. + pub(crate) fn take_tunnel_receive(operation: u64, destination: u32, capacity: u32) -> i32; + + #[cfg(feature = "wasm-host-tunnel")] + /// Starts sending one complete host tunnel payload. + pub(crate) fn start_tunnel_send(handle: u64, operation: u64, source: u32, length: u32) -> i32; + + #[cfg(feature = "wasm-host-tunnel")] + /// Reports completion of one host tunnel send. + pub(crate) fn take_tunnel_send(operation: u64) -> i32; + + #[cfg(feature = "wasm-host-tunnel-outbound")] + /// Starts opening one outbound host tunnel for the requested URL. + pub(crate) fn start_tunnel_connect(operation: u64, url: u32, url_len: u32) -> i32; + + #[cfg(feature = "wasm-host-tunnel-outbound")] + /// Returns the connected tunnel handle, or a negative host status. + pub(crate) fn take_tunnel_connect(operation: u64) -> i64; + + /// Cancels a pending or completed-but-unread operation and releases host state. + /// + /// Cancellation must be idempotent when the operation is already absent. + pub(crate) fn cancel_operation(operation: u64) -> i32; + + /// Closes a host socket or listener handle. Closing an already-closed handle is valid. + pub(crate) fn close(handle: u64) -> i32; +} diff --git a/vendor/easytier/easytier-core/src/wasi/mod.rs b/vendor/easytier/easytier-core/src/wasi/mod.rs new file mode 100644 index 0000000..0b80dce --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/mod.rs @@ -0,0 +1,26 @@ +//! WASI runtime integration for EasyTier core. +//! +//! Portable Host capability seams live in [`crate::host`]. This module owns +//! the concrete WASI adapters, the `easytier_host` import contract, and the +//! guest lifecycle ABI used by an externally driven WASI runtime. + +pub mod abi; + +/// Concrete adapters a WASI guest uses to connect portable Host seams to the +/// [`abi::HOST_IMPORT_MODULE`] runtime contract. +#[cfg(target_os = "wasi")] +pub mod adapter; +#[cfg(target_os = "wasi")] +pub(crate) mod imports; +#[cfg(target_os = "wasi")] +pub(crate) mod runtime; +#[cfg(any(test, target_os = "wasi"))] +pub(crate) mod runtime_driver; +#[cfg(any(test, target_os = "wasi"))] +pub(crate) mod schema; +#[cfg(any(test, target_os = "wasi"))] +pub(crate) mod time; +#[cfg(all(target_os = "wasi", feature = "management"))] +pub(crate) mod web_client; +#[cfg(any(test, target_os = "wasi"))] +pub(crate) mod wire; diff --git a/vendor/easytier/easytier-core/src/wasi/runtime.rs b/vendor/easytier/easytier-core/src/wasi/runtime.rs new file mode 100644 index 0000000..6adc3cf --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/runtime.rs @@ -0,0 +1,1017 @@ +//! Runtime implementation and lifecycle exports for a WASI core instance. + +use crate::{ + config::toml::TomlConfig, + connectivity::connector_host::HostConnectorEnvironmentSnapshot, + gateway::dhcp::{DhcpIpv4ApplyOutcome, DhcpIpv4Host}, + instance::{CorePacketPlane, InstanceRuntimeHost}, +}; + +struct WasiInstanceRuntimeHost; + +#[async_trait::async_trait] +impl DhcpIpv4Host for WasiInstanceRuntimeHost { + fn take_interface_closed(&self) -> bool { + false + } + + async fn apply_dhcp_ipv4( + &self, + _previous: Option, + next: Option, + ) -> DhcpIpv4ApplyOutcome { + DhcpIpv4ApplyOutcome::applied(next) + } +} + +#[async_trait::async_trait] +impl InstanceRuntimeHost for WasiInstanceRuntimeHost { + async fn prepare( + &self, + _packet_plane: std::sync::Arc, + ) -> anyhow::Result>> { + Ok(Some(std::sync::Arc::new(WasiInstanceRuntimeHost))) + } + + async fn shutdown(&self) {} +} + +pub(super) type WasiCore = crate::instance::CoreInstance< + crate::connectivity::connector_host::ConnectorHost< + crate::wasi::adapter::socket::backend::WasiHostSocketBackend, + crate::wasi::adapter::environment::WasiHostConnectorEnvironmentIo, + >, +>; + +pub(super) struct WasiCoreRuntime { + socket_runtime: crate::host::socket::HostSocketRuntime, + #[cfg(all( + feature = "wasm-host-tunnel", + not(feature = "wasm-host-tunnel-outbound") + ))] + tunnel_ingress: crate::wasi::adapter::tunnel::WasiHostTunnelIngress, + core: std::sync::Arc, +} + +impl WasiCoreRuntime { + pub(super) fn core(&self) -> &std::sync::Arc { + &self.core + } + + pub(super) fn notify_host_completions(&self) { + self.socket_runtime.notify_completions(); + } + + #[cfg(all( + feature = "wasm-host-tunnel", + not(feature = "wasm-host-tunnel-outbound") + ))] + pub(super) fn accept_tunnel( + &self, + handle: crate::host::socket::HostSocketHandle, + metadata: crate::wasi::schema::WasiHostTunnelMetadata, + ) -> anyhow::Result<()> { + self.tunnel_ingress.accept(handle, metadata) + } + + #[cfg(feature = "wasm-host-tunnel-outbound")] + pub(super) fn accept_tunnel( + &self, + _handle: crate::host::socket::HostSocketHandle, + _metadata: crate::wasi::schema::WasiHostTunnelMetadata, + ) -> anyhow::Result<()> { + anyhow::bail!("Host Tunnel admission is unavailable in outbound-only WASI") + } +} + +pub(super) fn new_wasi_core_runtime( + config: TomlConfig, + process_runtime: std::sync::Arc, + environment_snapshot: HostConnectorEnvironmentSnapshot, + packet_sink: crate::host::packet::HostPacketSinkHandle, + event_sink: u64, +) -> anyhow::Result { + use std::sync::Arc; + + use crate::host::{dns::HostDnsResolver, packet::HostPacketSink, socket::HostSocketRuntime}; + use crate::{ + instance::{CoreHostAdapters, CoreInstance}, + wasi::adapter::{ + dns::WasiHostDnsIo, environment::WasiHostConnectorEnvironmentIo, + event::WasiHostEventSink, packet::WasiHostPacketIo, + socket::backend::WasiHostSocketBackend, + }, + }; + + #[cfg(not(feature = "wasm-host-tunnel-outbound"))] + use crate::connectivity::connector_host::new_connector_host; + #[cfg(feature = "wasm-host-tunnel-outbound")] + use crate::connectivity::connector_host::new_connector_host_with_external_tunnel; + + let socket_runtime = HostSocketRuntime::new(); + let socket_backend = Arc::new(WasiHostSocketBackend::default()); + let environment_io = Arc::new(WasiHostConnectorEnvironmentIo); + #[cfg(feature = "wasm-host-tunnel")] + let host_tunnel_schemes: Arc<[String]> = Arc::from(["ws".to_owned(), "wss".to_owned()]); + #[cfg(feature = "wasm-host-tunnel-outbound")] + let tunnel_io = Arc::new(crate::wasi::adapter::tunnel::WasiHostTunnelIo::default()); + #[cfg(feature = "wasm-host-tunnel-outbound")] + let host = Arc::new(new_connector_host_with_external_tunnel( + socket_runtime.clone(), + socket_backend, + environment_snapshot, + environment_io, + Arc::new(crate::wasi::adapter::tunnel::WasiHostTunnelConnector::new( + socket_runtime.clone(), + tunnel_io, + host_tunnel_schemes.clone(), + )), + )); + #[cfg(not(feature = "wasm-host-tunnel-outbound"))] + let host = Arc::new(new_connector_host( + socket_runtime.clone(), + socket_backend, + environment_snapshot, + environment_io, + )); + let dns = Arc::new(HostDnsResolver::new( + socket_runtime.clone(), + Arc::new(WasiHostDnsIo), + )); + let packet_sink = Arc::new(HostPacketSink::new( + socket_runtime.clone(), + Arc::new(WasiHostPacketIo), + packet_sink, + )); + let mut adapters = CoreHostAdapters::new(host, dns, packet_sink, process_runtime); + adapters.instance_runtime = Arc::new(WasiInstanceRuntimeHost); + adapters.events = Arc::new(WasiHostEventSink::new(event_sink)); + #[cfg(feature = "wasm-host-tunnel-outbound")] + { + adapters.config.connectivity = crate::instance::CoreConnectivityMode::OutboundOnly; + adapters.config.smoltcp_available = true; + adapters.config.requires_smoltcp = true; + adapters.config.gateway_enabled = false; + adapters.config.proxy_enabled = false; + adapters.config.ignore_unsupported_config = true; + adapters.config.endpoint_protocols = host_tunnel_schemes.to_vec(); + } + #[cfg(feature = "wasm-host-tunnel")] + #[cfg(not(feature = "wasm-host-tunnel-outbound"))] + let tunnel_ingress = crate::wasi::adapter::tunnel::WasiHostTunnelIngress::new( + socket_runtime.clone(), + host_tunnel_schemes, + ); + #[cfg(feature = "wasm-host-tunnel")] + #[cfg(not(feature = "wasm-host-tunnel-outbound"))] + { + adapters.config.connectivity = crate::instance::CoreConnectivityMode::InboundOnly; + adapters.external_listener_factory = Some(tunnel_ingress.listener_factory()); + adapters + .host_listener_registrations + .push(crate::listener::ExternalListenerRequest { + url: "wss://0.0.0.0:443" + .parse() + .expect("Host Tunnel listener URL must be valid"), + socket_context: crate::socket::SocketContext::default(), + }); + } + let core = CoreInstance::from_toml(config, adapters)?; + + Ok(WasiCoreRuntime { + socket_runtime, + #[cfg(all( + feature = "wasm-host-tunnel", + not(feature = "wasm-host-tunnel-outbound") + ))] + tunnel_ingress, + core, + }) +} + +mod abi { + use std::{ + cell::RefCell, + collections::BTreeMap, + sync::{Arc, Mutex}, + }; + + use tokio::{runtime::Builder, task::JoinHandle}; + + use crate::{ + config::toml::{ConfigLoader as _, TomlConfig}, + foundation::time::{clear_domain, enter_domain, next_deadline_millis}, + host::packet::{HostPacket, HostPacketSinkHandle}, + instance::{ + CoreInstanceState, + manager::{InstanceFactory, ManagedInstance}, + }, + process_runtime::{CoreProcessRuntime, ProtectedTcpPortLease}, + wasi::runtime_driver::{RuntimeDriveOutcome, RuntimeDriver}, + }; + + use super::{WasiCoreRuntime, new_wasi_core_runtime}; + use crate::wasi::schema::WasiCoreInstanceCreateConfig; + #[cfg(feature = "wasm-host-tunnel")] + use crate::wasi::schema::WasiHostTunnelMetadata; + + #[cfg(feature = "proxy-smoltcp-stack")] + mod data_plane; + #[cfg(feature = "management-rpc")] + mod rpc; + #[cfg(feature = "management")] + mod web_client; + + const MAX_CREATE_CONFIG_LEN: usize = 16 * 1024 * 1024; + #[cfg(feature = "wasm-host-tunnel")] + const MAX_HOST_TUNNEL_METADATA_LEN: usize = 16 * 1024; + const MAX_GUEST_BUFFER_LEN: usize = MAX_CREATE_CONFIG_LEN; + #[cfg(feature = "management-rpc")] + const MAX_RPC_MESSAGE_LEN: usize = 16 * 1024 * 1024; + #[cfg(feature = "management-rpc")] + const MAX_RPC_OPERATIONS: usize = 256; + const INVALID_HANDLE: i32 = -1; + const INVALID_STATE: i32 = -2; + const INVALID_INPUT: i32 = -3; + const ASYNC_ERROR: i32 = -4; + const BUSY: i32 = -5; + + struct WasiAbiState { + next_handle: u64, + handles: BTreeMap, + buffers: BTreeMap>, + active_instance: bool, + global_error: String, + } + + struct WasiHandleState { + instance_id: uuid::Uuid, + error: String, + } + + impl Default for WasiAbiState { + fn default() -> Self { + Self { + next_handle: 0, + handles: BTreeMap::new(), + buffers: BTreeMap::new(), + active_instance: false, + global_error: String::new(), + } + } + } + + struct WasiContext { + factory: WasiInstanceFactory, + instances: RefCell>>, + #[cfg(feature = "management")] + web_client: RefCell>, + abi: RefCell, + } + + impl Default for WasiContext { + fn default() -> Self { + let factory = WasiInstanceFactory { + process_runtime: CoreProcessRuntime::new(), + }; + Self { + factory, + instances: RefCell::new(BTreeMap::new()), + #[cfg(feature = "management")] + web_client: RefCell::new(None), + abi: RefCell::new(WasiAbiState::default()), + } + } + } + + thread_local! { + static CONTEXT: WasiContext = WasiContext::default(); + } + + struct WasiInstanceFactory { + process_runtime: std::sync::Arc, + } + + struct WasiCreateContext { + domain: u64, + environment: crate::connectivity::connector_host::HostConnectorEnvironmentSnapshot, + packet_sink: HostPacketSinkHandle, + event_sink: u64, + } + + struct WasiInstance { + instance_id: uuid::Uuid, + domain: u64, + core: WasiCoreRuntime, + execution: Mutex, + #[cfg(feature = "management-rpc")] + rpc_operations: crate::rpc::operation::RpcOperationSession, + _protected_tcp_port_leases: Vec, + } + + struct WasiExecution { + runtime: tokio::runtime::Runtime, + runtime_driver: RuntimeDriver, + drive_again: bool, + start_task: Option>>, + stop_task: Option>, + } + + impl ManagedInstance for WasiInstance { + fn instance_id(&self) -> uuid::Uuid { + self.instance_id + } + } + + impl InstanceFactory for WasiInstanceFactory { + type Instance = WasiInstance; + type CreateContext = WasiCreateContext; + type Error = anyhow::Error; + + fn create( + &self, + config: TomlConfig, + context: Self::CreateContext, + ) -> Result, Self::Error> { + let instance_id = config.get_id(); + let protected_tcp_ports = context + .environment + .protected_tcp_ports + .iter() + .copied() + .map(|port| self.process_runtime.protect_tcp_port(port)) + .collect(); + let runtime_driver = RuntimeDriver::default(); + let park_driver = runtime_driver.clone(); + let runtime = Builder::new_current_thread() + .enable_time() + .on_thread_park(move || park_driver.on_thread_park()) + .build()?; + let core = { + let _domain = enter_domain(context.domain); + let _runtime = runtime.enter(); + new_wasi_core_runtime( + config, + self.process_runtime.clone(), + context.environment, + context.packet_sink, + context.event_sink, + )? + }; + #[cfg(feature = "management-rpc")] + let rpc_operations = { + let registry = Arc::new(crate::rpc::service_registry::ServiceRegistry::new()); + crate::management::register_bound_management_rpc( + core.core().clone(), + registry.as_ref(), + ); + crate::rpc::operation::RpcOperationSession::new( + registry, + MAX_RPC_OPERATIONS, + MAX_RPC_MESSAGE_LEN, + ) + }; + + Ok(Arc::new(WasiInstance { + instance_id, + domain: context.domain, + core, + execution: Mutex::new(WasiExecution { + runtime, + runtime_driver, + drive_again: false, + start_task: None, + stop_task: None, + }), + #[cfg(feature = "management-rpc")] + rpc_operations, + _protected_tcp_port_leases: protected_tcp_ports, + })) + } + } + + impl WasiAbiState { + fn allocate_handle(&mut self) -> Result { + if self.active_instance { + self.set_global_error("core instance lifecycle call is not reentrant"); + return Err(BUSY); + } + loop { + self.next_handle = self.next_handle.wrapping_add(1); + if self.next_handle != 0 && !self.handles.contains_key(&self.next_handle) { + return Ok(self.next_handle); + } + } + } + + fn set_global_error(&mut self, error: impl ToString) { + self.global_error = error.to_string(); + } + + fn set_handle_error(&mut self, handle: u64, error: impl ToString) { + if let Some(state) = self.handles.get_mut(&handle) { + state.error = error.to_string(); + } else { + self.set_global_error(error); + } + } + + fn error_for_handle(&self, handle: u64) -> &str { + self.handles + .get(&handle) + .map(|state| state.error.as_str()) + .unwrap_or(self.global_error.as_str()) + } + + fn begin_instance_call(&mut self, handle: u64) -> Result { + if self.active_instance { + self.set_handle_error(handle, "core instance lifecycle call is not reentrant"); + return Err(BUSY); + } + let Some(instance_id) = self.handles.get(&handle).map(|state| state.instance_id) else { + self.set_global_error(format!("unknown core instance handle: {handle}")); + return Err(INVALID_HANDLE); + }; + self.active_instance = true; + Ok(instance_id) + } + + fn begin_instance_drop(&mut self, handle: u64) -> Result { + self.begin_instance_call(handle) + } + + fn finish_instance_call(&mut self) { + debug_assert!(self.active_instance); + self.active_instance = false; + } + + fn finish_instance_drop(&mut self, handle: u64) { + debug_assert!(self.active_instance); + self.handles.remove(&handle); + self.active_instance = false; + } + + fn read_buffer(&self, pointer: u32, length: usize) -> anyhow::Result> { + let buffer = self + .buffers + .get(&pointer) + .ok_or_else(|| anyhow::anyhow!("unknown guest buffer: {pointer}"))?; + if length > buffer.len() { + anyhow::bail!( + "guest buffer length {length} exceeds allocation {}", + buffer.len() + ); + } + Ok(buffer[..length].to_vec()) + } + } + + impl WasiInstance { + fn start(&self) -> anyhow::Result<()> { + let mut execution = self.execution.lock().unwrap(); + if execution.start_task.is_some() + || execution.stop_task.is_some() + || self.core.core().state() != CoreInstanceState::Created + { + anyhow::bail!("core instance cannot schedule start from its current state"); + } + let instance = self.core.core().clone(); + execution.start_task = Some( + execution + .runtime + .spawn(async move { instance.start().await }), + ); + Ok(()) + } + + fn stop(&self) { + let mut execution = self.execution.lock().unwrap(); + if execution.stop_task.is_some() + || self.core.core().state() == CoreInstanceState::Stopped + { + return; + } + let instance = self.core.core().clone(); + execution.stop_task = Some(execution.runtime.spawn(async move { + instance.stop().await; + })); + } + + fn drive(&self) -> anyhow::Result<()> { + let _domain = enter_domain(self.domain); + let advance_timers = next_deadline_millis(self.domain) == Some(0); + let mut execution = self.execution.lock().unwrap(); + execution.drive_again = execution + .runtime_driver + .drive(&execution.runtime, advance_timers) + == RuntimeDriveOutcome::BudgetExhausted; + + if execution + .start_task + .as_ref() + .is_some_and(JoinHandle::is_finished) + { + let task = execution.start_task.take().unwrap(); + match execution.runtime.block_on(task) { + Ok(Ok(())) => {} + Ok(Err(error)) => return Err(error), + Err(error) => anyhow::bail!("core instance start task failed: {error}"), + } + } + if execution + .stop_task + .as_ref() + .is_some_and(JoinHandle::is_finished) + { + let task = execution.stop_task.take().unwrap(); + if let Err(error) = execution.runtime.block_on(task) { + anyhow::bail!("core instance stop task failed: {error}"); + } + } + Ok(()) + } + + fn state_code(&self) -> i32 { + let execution = self.execution.lock().unwrap(); + if execution.stop_task.is_some() { + return 3; + } + if execution.start_task.is_some() { + return 1; + } + match self.core.core().state() { + CoreInstanceState::Created => 0, + CoreInstanceState::Starting => 1, + CoreInstanceState::Running => 2, + CoreInstanceState::Stopping => 3, + CoreInstanceState::Stopped => 4, + } + } + + fn next_wait_millis(&self) -> Option { + let execution = self.execution.lock().unwrap(); + if execution.drive_again { + Some(0) + } else { + next_deadline_millis(self.domain) + } + } + + fn send_packet(&self, packet: Vec) { + let packet_plane = self.core.core().packet_plane(); + self.execution.lock().unwrap().runtime.spawn(async move { + if let Err(error) = packet_plane + .send_ip_packet(HostPacket::copy_from_payload(&packet)) + .await + { + tracing::warn!(?error, "host packet ingress failed"); + } + }); + } + + #[cfg(feature = "wasm-host-tunnel")] + fn accept_tunnel( + &self, + tunnel_handle: crate::host::socket::HostSocketHandle, + metadata: WasiHostTunnelMetadata, + ) -> anyhow::Result<()> { + if self.core.core().state() != CoreInstanceState::Running { + anyhow::bail!("core instance is not running"); + } + self.core.accept_tunnel(tunnel_handle, metadata) + } + } + + fn decode_create_config(encoded: &[u8]) -> anyhow::Result { + if encoded.is_empty() || encoded.len() > MAX_CREATE_CONFIG_LEN { + anyhow::bail!("invalid host core instance config buffer"); + } + let config: WasiCoreInstanceCreateConfig = serde_json::from_slice(encoded)?; + config.validate()?; + Ok(config) + } + + fn with_instance( + handle: u64, + operation: impl FnOnce(&WasiInstance) -> anyhow::Result, + ) -> i32 { + let instance_id = + match CONTEXT.with(|context| context.abi.borrow_mut().begin_instance_call(handle)) { + Ok(instance_id) => instance_id, + Err(status) => return status, + }; + let instance = manager_get(instance_id); + let status = match instance { + Some(instance) => match operation(&instance) { + Ok(status) => status, + Err(error) => { + CONTEXT.with(|context| { + context.abi.borrow_mut().set_handle_error(handle, error); + }); + ASYNC_ERROR + } + }, + None => { + CONTEXT.with(|context| { + context.abi.borrow_mut().set_handle_error( + handle, + format!("core instance {instance_id} is not registered"), + ); + }); + INVALID_STATE + } + }; + CONTEXT.with(|context| context.abi.borrow_mut().finish_instance_call()); + status + } + + fn with_abi_state(operation: impl FnOnce(&WasiAbiState) -> T) -> T { + CONTEXT.with(|context| operation(&context.abi.borrow())) + } + + fn with_abi_state_mut(operation: impl FnOnce(&mut WasiAbiState) -> T) -> T { + CONTEXT.with(|context| operation(&mut context.abi.borrow_mut())) + } + + fn set_abi_error(error: impl ToString) { + with_abi_state_mut(|state| state.set_global_error(error)); + } + + fn set_instance_error(handle: u64, error: impl ToString) { + with_abi_state_mut(|state| state.set_handle_error(handle, error)); + } + + fn manager_get(instance_id: uuid::Uuid) -> Option> { + CONTEXT.with(|context| context.instances.borrow().get(&instance_id).cloned()) + } + + fn manager_remove(instance_id: uuid::Uuid) -> Option> { + CONTEXT.with(|context| context.instances.borrow_mut().remove(&instance_id)) + } + + fn manager_create( + config: TomlConfig, + context: WasiCreateContext, + ) -> Result< + std::sync::Arc, + crate::instance::manager::InstanceCreateError, + > { + CONTEXT.with(|wasi| { + let instance = wasi + .factory + .create(config, context) + .map_err(crate::instance::manager::InstanceCreateError::Factory)?; + let instance_id = instance.instance_id(); + let mut instances = wasi.instances.borrow_mut(); + match instances.entry(instance_id) { + std::collections::btree_map::Entry::Vacant(entry) => { + entry.insert(instance.clone()); + Ok(instance) + } + std::collections::btree_map::Entry::Occupied(_) => Err( + crate::instance::manager::InstanceCreateError::AlreadyExists { instance_id }, + ), + } + }) + } + + fn read_guest_buffer(pointer: u32, length: u32, maximum: usize) -> anyhow::Result> { + let length = usize::try_from(length).expect("u32 fits usize on wasm32"); + if pointer == 0 || length == 0 || length > maximum { + anyhow::bail!("invalid guest buffer reference"); + } + with_abi_state(|state| state.read_buffer(pointer, length)) + } + + #[unsafe(no_mangle)] + /// WASI command entrypoint used only to initialize the host runtime. + pub extern "C" fn _start() {} + + #[unsafe(no_mangle)] + /// Allocates a guest-owned ABI buffer and returns its linear-memory offset. + /// + /// The runtime may write at most `length` bytes through wasm memory, then + /// pass the pointer to another lifecycle export and eventually free it. + pub extern "C" fn easytier_buffer_alloc(length: u32) -> u32 { + let length = usize::try_from(length).expect("u32 fits usize on wasm32"); + if length == 0 || length > MAX_GUEST_BUFFER_LEN { + set_abi_error("invalid guest buffer length"); + return 0; + } + let mut buffer = vec![0_u8; length].into_boxed_slice(); + let pointer = buffer.as_mut_ptr() as u32; + if pointer == 0 { + set_abi_error("guest buffer allocation failed"); + return 0; + } + with_abi_state_mut(|state| { + if state.buffers.contains_key(&pointer) { + state.set_global_error("guest buffer allocation collided with a live buffer"); + 0 + } else { + state.buffers.insert(pointer, buffer); + pointer + } + }) + } + + #[unsafe(no_mangle)] + /// Releases a buffer previously returned by [`easytier_buffer_alloc`]. + pub extern "C" fn easytier_buffer_free(pointer: u32) -> i32 { + with_abi_state_mut(|state| { + if state.buffers.remove(&pointer).is_some() { + 0 + } else { + state.set_global_error(format!("unknown guest buffer: {pointer}")); + INVALID_INPUT + } + }) + } + + #[unsafe(no_mangle)] + /// Creates one core instance from a versioned envelope containing TOML. + /// + /// `config_pointer` must name a live ABI buffer. `packet_sink_handle` and + /// `event_sink_handle` identify the host sinks used for locally delivered + /// raw IP packets and best-effort instance events. + /// Returns zero on failure; retrieve the reason through the error exports. + pub extern "C" fn easytier_instance_create( + config_pointer: u32, + config_length: u32, + packet_sink_handle: u64, + event_sink_handle: u64, + ) -> u64 { + let encoded = match read_guest_buffer(config_pointer, config_length, MAX_CREATE_CONFIG_LEN) + { + Ok(encoded) => encoded, + Err(error) => { + set_abi_error(error); + return 0; + } + }; + let create_config = match decode_create_config(&encoded) { + Ok(config) => config, + Err(error) => { + set_abi_error(error); + return 0; + } + }; + let config = match create_config.parse_config() { + Ok(config) => config, + Err(error) => { + set_abi_error(error); + return 0; + } + }; + let handle = match with_abi_state_mut(WasiAbiState::allocate_handle) { + Ok(handle) => handle, + Err(_) => return 0, + }; + let instance = manager_create( + config, + WasiCreateContext { + domain: handle, + environment: create_config.environment, + packet_sink: HostPacketSinkHandle(packet_sink_handle), + event_sink: event_sink_handle, + }, + ); + let instance = match instance { + Ok(instance) => instance, + Err(error) => { + clear_domain(handle); + set_abi_error(error); + return 0; + } + }; + + with_abi_state_mut(|state| { + let previous = state.handles.insert( + handle, + WasiHandleState { + instance_id: instance.instance_id(), + error: String::new(), + }, + ); + debug_assert!(previous.is_none()); + handle + }) + } + + #[unsafe(no_mangle)] + /// Schedules instance startup. Completion is advanced by subsequent drive calls. + pub extern "C" fn easytier_instance_start(handle: u64) -> i32 { + with_instance(handle, |instance| match instance.start() { + Ok(()) => Ok(0), + Err(error) => { + set_instance_error(handle, error); + Ok(INVALID_STATE) + } + }) + } + + #[unsafe(no_mangle)] + /// Requests graceful instance shutdown. Completion is advanced by drive calls. + pub extern "C" fn easytier_instance_stop(handle: u64) -> i32 { + with_instance(handle, |instance| { + instance.stop(); + Ok(0) + }) + } + + #[unsafe(no_mangle)] + /// Runs one bounded turn of the instance's externally driven Tokio runtime. + /// + /// The return value is the current lifecycle state code, or a negative ABI + /// status on failure. Call after a timer deadline or host completion. + pub extern "C" fn easytier_instance_drive(handle: u64) -> i32 { + with_instance(handle, |instance| { + instance.drive()?; + Ok(instance.state_code()) + }) + } + + #[unsafe(no_mangle)] + /// Wakes tasks whose host I/O operation may have completed. + /// + /// The runtime calls this after finishing one or more `easytier_host` + /// operations; it does not itself consume a host completion. + pub extern "C" fn easytier_instance_notify_completions(handle: u64) -> i32 { + with_instance(handle, |instance| { + instance.core.notify_host_completions(); + Ok(0) + }) + } + + #[unsafe(no_mangle)] + /// Returns the current lifecycle state code without running the instance. + pub extern "C" fn easytier_instance_state(handle: u64) -> i32 { + with_instance(handle, |instance| Ok(instance.state_code())) + } + + /// Returns milliseconds until the next required drive, rounded up. A zero + /// means lifecycle work remains locally runnable. `i64::MAX` means core is + /// waiting only for a host completion; negative values are ABI status codes. + #[unsafe(no_mangle)] + pub extern "C" fn easytier_instance_next_deadline_millis(handle: u64) -> i64 { + let instance_id = match with_abi_state_mut(|state| state.begin_instance_call(handle)) { + Ok(instance_id) => instance_id, + Err(status) => return i64::from(status), + }; + let result = match manager_get(instance_id) { + Some(instance) => instance + .next_wait_millis() + .map(|millis| i64::try_from(millis).unwrap_or(i64::MAX)) + .unwrap_or(i64::MAX), + None => { + set_instance_error( + handle, + format!("core instance {instance_id} is not registered"), + ); + i64::from(INVALID_STATE) + } + }; + with_abi_state_mut(WasiAbiState::finish_instance_call); + result + } + + #[unsafe(no_mangle)] + /// Copies a raw IP packet from a guest ABI buffer into EasyTier ingress. + /// + /// Packet processing is asynchronous; success only means the ingress task + /// was scheduled. The caller retains and may free the source buffer once + /// this function returns. + pub extern "C" fn easytier_instance_send_packet( + handle: u64, + packet_pointer: u32, + packet_length: u32, + ) -> i32 { + with_instance(handle, |instance| { + let packet = match read_guest_buffer(packet_pointer, packet_length, 1024 * 1024) { + Ok(packet) => packet, + Err(error) => { + set_instance_error(handle, error); + return Ok(INVALID_INPUT); + } + }; + instance.send_packet(packet); + Ok(0) + }) + } + + #[cfg(feature = "wasm-host-tunnel")] + #[unsafe(no_mangle)] + /// Returns the host tunnel ABI version implemented by this guest. + pub extern "C" fn easytier_host_tunnel_abi_version() -> u32 { + crate::wasi::abi::HOST_TUNNEL_ABI_VERSION + } + + #[cfg(feature = "wasm-host-tunnel")] + #[unsafe(no_mangle)] + /// Transfers one host-owned transport into server tunnel admission. + /// + /// `metadata` is a versioned JSON document. A zero return transfers + /// ownership of `tunnel_handle` to the guest; on failure the host keeps + /// ownership and must close it. Admission is scheduled and completed by + /// later drive calls so the export never waits for the peer handshake. + pub extern "C" fn easytier_instance_accept_tunnel( + handle: u64, + tunnel_handle: u64, + metadata_pointer: u32, + metadata_length: u32, + ) -> i32 { + if tunnel_handle == 0 { + set_instance_error(handle, "host tunnel handle must be non-zero"); + return INVALID_INPUT; + } + let encoded = match read_guest_buffer( + metadata_pointer, + metadata_length, + MAX_HOST_TUNNEL_METADATA_LEN, + ) { + Ok(encoded) => encoded, + Err(error) => { + set_instance_error(handle, error); + return INVALID_INPUT; + } + }; + let metadata: WasiHostTunnelMetadata = match serde_json::from_slice(&encoded) { + Ok(metadata) => metadata, + Err(error) => { + set_instance_error(handle, error); + return INVALID_INPUT; + } + }; + if let Err(error) = metadata.validate() { + set_instance_error(handle, error); + return INVALID_INPUT; + } + + with_instance(handle, |instance| { + instance.accept_tunnel( + crate::host::socket::HostSocketHandle(tunnel_handle), + metadata, + )?; + Ok(0) + }) + } + + #[unsafe(no_mangle)] + /// Destroys an instance and releases its lifecycle, timer, and runtime state. + pub extern "C" fn easytier_instance_drop(handle: u64) -> i32 { + let instance_id = match with_abi_state_mut(|state| state.begin_instance_drop(handle)) { + Ok(instance_id) => instance_id, + Err(status) => return status, + }; + let Some(instance) = manager_remove(instance_id) else { + set_instance_error( + handle, + format!("core instance {instance_id} is not registered"), + ); + with_abi_state_mut(WasiAbiState::finish_instance_call); + return INVALID_STATE; + }; + let domain = instance.domain; + #[cfg(feature = "management-rpc")] + instance.rpc_operations.discard_all(); + { + let _domain = enter_domain(domain); + drop(instance); + } + clear_domain(domain); + with_abi_state_mut(|state| state.finish_instance_drop(handle)); + 0 + } + + #[unsafe(no_mangle)] + /// Returns the byte length of the most recent lifecycle error for `handle`. + pub extern "C" fn easytier_instance_error_len(handle: u64) -> u32 { + with_abi_state(|state| { + u32::try_from(state.error_for_handle(handle).len()).unwrap_or(u32::MAX) + }) + } + + #[unsafe(no_mangle)] + /// Copies the most recent lifecycle error into a caller-owned ABI buffer. + /// + /// `capacity` must contain the whole error; on success returns the copied + /// byte count, otherwise a negative ABI status code. + pub extern "C" fn easytier_instance_error_copy( + handle: u64, + destination: u32, + capacity: u32, + ) -> i32 { + with_abi_state_mut(|state| { + let error = state.error_for_handle(handle).as_bytes().to_vec(); + let capacity = usize::try_from(capacity).expect("u32 fits usize on wasm32"); + let Some(destination) = state.buffers.get_mut(&destination) else { + return INVALID_INPUT; + }; + if capacity > destination.len() || capacity < error.len() { + return INVALID_INPUT; + } + destination[..error.len()].copy_from_slice(&error); + i32::try_from(error.len()).unwrap_or(INVALID_INPUT) + }) + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/runtime/abi/data_plane.rs b/vendor/easytier/easytier-core/src/wasi/runtime/abi/data_plane.rs new file mode 100644 index 0000000..90e1318 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/runtime/abi/data_plane.rs @@ -0,0 +1,790 @@ +//! Public data-plane guest exports backed by the instance operation broker. + +use std::{net::SocketAddr, time::Duration}; + +use crate::{ + gateway::{ + DataPlaneError, DataPlaneErrorKind, DataPlaneOperationId, DataPlaneOperationKind, + DataPlaneOperationResult, DataPlaneResourceId, DataPlaneSession, + }, + wasi::{ + abi::{ + DATA_PLANE_ABI_VERSION, DATA_PLANE_CAPABILITY, DATA_PLANE_DEADLINE_READ, + DATA_PLANE_DEADLINE_WRITE, DATA_PLANE_TCP_CAPABILITY, DATA_PLANE_UDP_CAPABILITY, + }, + wire::{ + data_plane::{ + COMPLETION_LEN, TCP_ACCEPT_RESULT_LEN, TCP_BIND_RESULT_LEN, TCP_CONNECT_RESULT_LEN, + TCP_READ_METADATA_LEN, UDP_BIND_RESULT_LEN, UDP_RECEIVE_METADATA_LEN, + decode_ipv4_socket_address, encode_completion, encode_resource_and_address, + encode_stream_addresses, encode_tcp_read_metadata, encode_udp_receive_metadata, + error_status, normalize_call_status, + }, + socket::SOCKET_ADDRESS_LEN, + }, + }, +}; + +use super::{WasiInstance, set_instance_error, with_abi_state, with_abi_state_mut, with_instance}; + +const OPERATION_ID_LEN: usize = 8; +const MAX_WRITE_LEN: usize = 1024 * 1024; + +type WasiDataPlaneSession = DataPlaneSession< + crate::connectivity::connector_host::ConnectorHost< + crate::wasi::adapter::socket::backend::WasiHostSocketBackend, + crate::wasi::adapter::environment::WasiHostConnectorEnvironmentIo, + >, +>; + +impl WasiInstance { + fn data_plane_session(&self) -> std::sync::Arc { + self.core.core().data_plane_session() + } + + fn submit_data_plane( + &self, + submit: impl FnOnce(&std::sync::Arc) -> Result, + ) -> Result { + let execution = self.execution.lock().unwrap(); + let _domain = crate::foundation::time::enter_domain(self.domain); + let _runtime = execution.runtime.enter(); + submit(&self.data_plane_session()) + } +} + +fn error(kind: DataPlaneErrorKind, message: impl Into) -> DataPlaneError { + DataPlaneError::new(kind, message) +} + +fn invalid_input(message: impl Into) -> DataPlaneError { + error(DataPlaneErrorKind::Io, message) +} + +fn timeout(timeout_ms: u64) -> Option { + (timeout_ms != u64::MAX).then(|| Duration::from_millis(timeout_ms)) +} + +fn operation_id(raw: u64) -> Result { + DataPlaneOperationId::from_raw(raw) + .ok_or_else(|| error(DataPlaneErrorKind::HandleClosed, "invalid operation ID")) +} + +fn resource_id(raw: u64) -> Result { + DataPlaneResourceId::from_raw(raw) + .ok_or_else(|| error(DataPlaneErrorKind::HandleClosed, "invalid resource ID")) +} + +fn validate_local_port(raw: u32) -> Result { + u16::try_from(raw).map_err(|_| invalid_input(format!("invalid local port {raw}"))) +} + +fn data_plane_call( + handle: u64, + operation: impl FnOnce(&WasiInstance) -> Result, +) -> i32 { + let mut entered = false; + let status = with_instance(handle, |instance| { + entered = true; + Ok(match operation(instance) { + Ok(status) => status, + Err(error) => { + let status = error_status(error.kind()); + set_instance_error(handle, error.message()); + status + } + }) + }); + normalize_call_status(entered, status) +} + +fn validate_output(pointer: u32, capacity: usize, required: usize) -> Result<(), DataPlaneError> { + if required == 0 && capacity == 0 && pointer == 0 { + return Ok(()); + } + if pointer == 0 { + return Err(invalid_input("guest output buffer pointer is zero")); + } + with_abi_state(|state| { + let buffer = state + .buffers + .get(&pointer) + .ok_or_else(|| invalid_input(format!("unknown guest buffer: {pointer}")))?; + if capacity > buffer.len() { + return Err(invalid_input(format!( + "guest output capacity {capacity} exceeds allocation {}", + buffer.len() + ))); + } + if required > capacity { + return Err(error( + DataPlaneErrorKind::BufferTooSmall, + format!("result requires {required} bytes, buffer has {capacity}"), + )); + } + Ok(()) + }) +} + +fn validate_fixed_output(pointer: u32, required: usize) -> Result<(), DataPlaneError> { + validate_output(pointer, required, required) +} + +fn write_output(pointer: u32, bytes: &[u8]) -> Result<(), DataPlaneError> { + if bytes.is_empty() && pointer == 0 { + return Ok(()); + } + with_abi_state_mut(|state| { + let buffer = state + .buffers + .get_mut(&pointer) + .ok_or_else(|| invalid_input(format!("unknown guest buffer: {pointer}")))?; + if bytes.len() > buffer.len() { + return Err(error( + DataPlaneErrorKind::BufferTooSmall, + format!( + "result requires {} bytes, allocation has {}", + bytes.len(), + buffer.len() + ), + )); + } + buffer[..bytes.len()].copy_from_slice(bytes); + Ok(()) + }) +} + +fn read_input(pointer: u32, length: u32, maximum: usize) -> Result, DataPlaneError> { + let length = usize::try_from(length).expect("u32 fits usize on wasm32"); + if length == 0 { + return Ok(Vec::new()); + } + if pointer == 0 || length > maximum { + return Err(invalid_input("invalid guest input buffer reference")); + } + with_abi_state(|state| { + state + .read_buffer(pointer, length) + .map_err(DataPlaneError::from) + }) +} + +fn read_ipv4_address(pointer: u32) -> Result { + let encoded = read_input(pointer, SOCKET_ADDRESS_LEN as u32, SOCKET_ADDRESS_LEN)?; + decode_ipv4_socket_address(&encoded).map_err(DataPlaneError::from) +} + +fn write_operation_id(pointer: u32, operation: DataPlaneOperationId) -> Result<(), DataPlaneError> { + write_output(pointer, &operation.get().to_be_bytes()) +} + +fn submit_operation( + handle: u64, + output: u32, + submit: impl FnOnce(&WasiInstance) -> Result, +) -> i32 { + data_plane_call(handle, |instance| { + validate_fixed_output(output, OPERATION_ID_LEN)?; + let operation = submit(instance)?; + if let Err(error) = write_operation_id(output, operation) { + instance.data_plane_session().free_operation(operation); + return Err(error); + } + Ok(0) + }) +} + +fn take_result( + session: &WasiDataPlaneSession, + operation: DataPlaneOperationId, + expected: DataPlaneOperationKind, + take: impl FnOnce(&DataPlaneOperationResult) -> Result, +) -> Result { + let actual = session.operation_kind(operation)?; + if actual != expected { + return Err(invalid_input(format!( + "operation kind mismatch: expected {expected:?}, got {actual:?}" + ))); + } + + let mut extraction_error = None; + let result = session.take_result_with(operation, |outcome| { + Some(match outcome { + Ok(result) => match take(result) { + Ok(value) => Ok(value), + Err(error) => { + extraction_error = Some(error); + return None; + } + }, + Err(kind) => Err(error( + *kind, + format!("data-plane operation failed with {kind:?}"), + )), + }) + })?; + if let Some(error) = extraction_error { + return Err(error); + } + result.ok_or_else(|| invalid_input("data-plane result could not be consumed"))? +} + +fn require_ipv4(address: SocketAddr) -> Result { + address.is_ipv4().then_some(address).ok_or_else(|| { + error( + DataPlaneErrorKind::AddressFamilyUnsupported, + "data-plane ABI supports IPv4 only", + ) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_abi_version() -> u32 { + DATA_PLANE_ABI_VERSION +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_capabilities() -> u64 { + DATA_PLANE_CAPABILITY | DATA_PLANE_TCP_CAPABILITY | DATA_PLANE_UDP_CAPABILITY +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_connect_submit( + handle: u64, + peer_address: u32, + timeout_ms: u64, + output_operation: u32, +) -> i32 { + let peer_address = match read_ipv4_address(peer_address) { + Ok(address) => address, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + submit_operation(handle, output_operation, |instance| { + instance.submit_data_plane(|session| { + session.submit_tcp_connect(peer_address, timeout(timeout_ms)) + }) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_bind_submit( + handle: u64, + local_port: u32, + timeout_ms: u64, + output_operation: u32, +) -> i32 { + let local_port = match validate_local_port(local_port) { + Ok(port) => port, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + submit_operation(handle, output_operation, |instance| { + instance + .submit_data_plane(|session| session.submit_tcp_bind(local_port, timeout(timeout_ms))) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_accept_submit( + handle: u64, + listener: u64, + timeout_ms: u64, + output_operation: u32, +) -> i32 { + let listener = match resource_id(listener) { + Ok(listener) => listener, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + submit_operation(handle, output_operation, |instance| { + instance + .submit_data_plane(|session| session.submit_tcp_accept(listener, timeout(timeout_ms))) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_read_submit( + handle: u64, + stream: u64, + max_len: u32, + output_operation: u32, +) -> i32 { + let stream = match resource_id(stream) { + Ok(stream) => stream, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + submit_operation(handle, output_operation, |instance| { + instance.submit_data_plane(|session| session.submit_tcp_read(stream, max_len as usize)) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_write_submit( + handle: u64, + stream: u64, + data_pointer: u32, + data_length: u32, + output_operation: u32, +) -> i32 { + let stream = match resource_id(stream) { + Ok(stream) => stream, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + let data = match read_input(data_pointer, data_length, MAX_WRITE_LEN) { + Ok(data) => data, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + submit_operation(handle, output_operation, |instance| { + instance.submit_data_plane(|session| session.submit_tcp_write(stream, data)) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_shutdown_write_submit( + handle: u64, + stream: u64, + output_operation: u32, +) -> i32 { + let stream = match resource_id(stream) { + Ok(stream) => stream, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + submit_operation(handle, output_operation, |instance| { + instance.submit_data_plane(|session| session.submit_tcp_shutdown_write(stream)) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_udp_bind_submit( + handle: u64, + local_port: u32, + timeout_ms: u64, + output_operation: u32, +) -> i32 { + let local_port = match validate_local_port(local_port) { + Ok(port) => port, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + submit_operation(handle, output_operation, |instance| { + instance + .submit_data_plane(|session| session.submit_udp_bind(local_port, timeout(timeout_ms))) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_udp_receive_submit( + handle: u64, + socket: u64, + max_len: u32, + output_operation: u32, +) -> i32 { + let socket = match resource_id(socket) { + Ok(socket) => socket, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + submit_operation(handle, output_operation, |instance| { + instance.submit_data_plane(|session| session.submit_udp_receive(socket, max_len as usize)) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_udp_send_submit( + handle: u64, + socket: u64, + peer_address: u32, + data_pointer: u32, + data_length: u32, + output_operation: u32, +) -> i32 { + let socket = match resource_id(socket) { + Ok(socket) => socket, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + let peer_address = match read_ipv4_address(peer_address) { + Ok(address) => address, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + let data = match read_input(data_pointer, data_length, MAX_WRITE_LEN) { + Ok(data) => data, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + submit_operation(handle, output_operation, |instance| { + instance.submit_data_plane(|session| session.submit_udp_send(socket, peer_address, data)) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_resource_deadline_set( + handle: u64, + resource: u64, + direction: u32, + timeout_ms: u64, +) -> i32 { + let resource = match resource_id(resource) { + Ok(resource) => resource, + Err(error) => { + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + }; + let read = direction & DATA_PLANE_DEADLINE_READ != 0; + let write = direction & DATA_PLANE_DEADLINE_WRITE != 0; + if direction == 0 || direction & !(DATA_PLANE_DEADLINE_READ | DATA_PLANE_DEADLINE_WRITE) != 0 { + let error = invalid_input(format!("invalid deadline direction {direction}")); + set_instance_error(handle, error.message()); + return error_status(error.kind()); + } + data_plane_call(handle, |instance| { + instance.submit_data_plane(|session| { + session.set_resource_deadline(resource, read, write, timeout(timeout_ms)) + })?; + Ok(0) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_operation_cancel(handle: u64, operation: u64) -> i32 { + data_plane_call(handle, |instance| { + instance + .data_plane_session() + .cancel_operation(operation_id(operation)?); + Ok(0) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_operation_free(handle: u64, operation: u64) -> i32 { + data_plane_call(handle, |instance| { + instance + .data_plane_session() + .free_operation(operation_id(operation)?); + Ok(0) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_resource_close(handle: u64, resource: u64) -> i32 { + data_plane_call(handle, |instance| { + instance + .data_plane_session() + .close_resource(resource_id(resource)?); + Ok(0) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_completion_drain( + handle: u64, + output: u32, + capacity: u32, +) -> i32 { + data_plane_call(handle, |instance| { + let capacity = usize::try_from(capacity).expect("u32 fits usize on wasm32"); + let required = capacity + .checked_mul(COMPLETION_LEN) + .ok_or_else(|| invalid_input("completion output size overflow"))?; + validate_output(output, required, required)?; + let completions = instance.data_plane_session().drain_completions(capacity); + let mut encoded = Vec::with_capacity(completions.len() * COMPLETION_LEN); + for completion in completions { + encoded.extend_from_slice(&encode_completion(completion)); + } + write_output(output, &encoded)?; + i32::try_from(encoded.len() / COMPLETION_LEN) + .map_err(|_| invalid_input("completion count exceeds i32")) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_result_size(handle: u64, operation: u64) -> i32 { + data_plane_call(handle, |instance| { + let size = instance + .data_plane_session() + .result_payload_bytes(operation_id(operation)?)?; + i32::try_from(size).map_err(|_| invalid_input("data-plane result size exceeds i32")) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_connect_result_take( + handle: u64, + operation: u64, + output: u32, +) -> i32 { + data_plane_call(handle, |instance| { + validate_fixed_output(output, TCP_CONNECT_RESULT_LEN)?; + let session = instance.data_plane_session(); + let wire = take_result( + &session, + operation_id(operation)?, + DataPlaneOperationKind::TcpConnect, + |result| match result { + DataPlaneOperationResult::TcpConnected { + stream, + local_addr, + peer_addr, + } => Ok(encode_stream_addresses( + stream.get(), + require_ipv4(*local_addr)?, + require_ipv4(*peer_addr)?, + )), + _ => Err(invalid_input("TCP connect result variant mismatch")), + }, + )?; + write_output(output, &wire)?; + Ok(0) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_bind_result_take( + handle: u64, + operation: u64, + output: u32, +) -> i32 { + data_plane_call(handle, |instance| { + validate_fixed_output(output, TCP_BIND_RESULT_LEN)?; + let session = instance.data_plane_session(); + let wire = take_result( + &session, + operation_id(operation)?, + DataPlaneOperationKind::TcpBind, + |result| match result { + DataPlaneOperationResult::TcpBound { + listener, + local_addr, + } => Ok(encode_resource_and_address( + listener.get(), + require_ipv4(*local_addr)?, + )), + _ => Err(invalid_input("TCP bind result variant mismatch")), + }, + )?; + write_output(output, &wire)?; + Ok(0) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_accept_result_take( + handle: u64, + operation: u64, + output: u32, +) -> i32 { + data_plane_call(handle, |instance| { + validate_fixed_output(output, TCP_ACCEPT_RESULT_LEN)?; + let session = instance.data_plane_session(); + let wire = take_result( + &session, + operation_id(operation)?, + DataPlaneOperationKind::TcpAccept, + |result| match result { + DataPlaneOperationResult::TcpAccepted { + stream, + local_addr, + peer_addr, + } => Ok(encode_stream_addresses( + stream.get(), + require_ipv4(*local_addr)?, + require_ipv4(*peer_addr)?, + )), + _ => Err(invalid_input("TCP accept result variant mismatch")), + }, + )?; + write_output(output, &wire)?; + Ok(0) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_read_result_take( + handle: u64, + operation: u64, + data_output: u32, + data_capacity: u32, + metadata_output: u32, +) -> i32 { + data_plane_call(handle, |instance| { + let session = instance.data_plane_session(); + let operation = operation_id(operation)?; + let required = session.result_payload_bytes(operation)?; + validate_output(data_output, data_capacity as usize, required)?; + validate_fixed_output(metadata_output, TCP_READ_METADATA_LEN)?; + take_result( + &session, + operation, + DataPlaneOperationKind::TcpRead, + |result| match result { + DataPlaneOperationResult::TcpRead { data, eof } => { + write_output(data_output, data)?; + write_output(metadata_output, &encode_tcp_read_metadata(*eof))?; + i32::try_from(data.len()) + .map_err(|_| invalid_input("TCP read result exceeds i32")) + } + _ => Err(invalid_input("TCP read result variant mismatch")), + }, + ) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_write_result_take(handle: u64, operation: u64) -> i32 { + data_plane_call(handle, |instance| { + let session = instance.data_plane_session(); + let len = take_result( + &session, + operation_id(operation)?, + DataPlaneOperationKind::TcpWrite, + |result| match result { + DataPlaneOperationResult::TcpWritten { len } => Ok(*len), + _ => Err(invalid_input("TCP write result variant mismatch")), + }, + )?; + i32::try_from(len).map_err(|_| invalid_input("TCP write result exceeds i32")) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_tcp_shutdown_write_result_take( + handle: u64, + operation: u64, +) -> i32 { + data_plane_call(handle, |instance| { + let session = instance.data_plane_session(); + take_result( + &session, + operation_id(operation)?, + DataPlaneOperationKind::TcpShutdownWrite, + |result| match result { + DataPlaneOperationResult::TcpWriteShutdown => Ok(()), + _ => Err(invalid_input("TCP write shutdown result variant mismatch")), + }, + )?; + Ok(0) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_udp_bind_result_take( + handle: u64, + operation: u64, + output: u32, +) -> i32 { + data_plane_call(handle, |instance| { + validate_fixed_output(output, UDP_BIND_RESULT_LEN)?; + let session = instance.data_plane_session(); + let wire = take_result( + &session, + operation_id(operation)?, + DataPlaneOperationKind::UdpBind, + |result| match result { + DataPlaneOperationResult::UdpBound { socket, local_addr } => Ok( + encode_resource_and_address(socket.get(), require_ipv4(*local_addr)?), + ), + _ => Err(invalid_input("UDP bind result variant mismatch")), + }, + )?; + write_output(output, &wire)?; + Ok(0) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_udp_receive_result_take( + handle: u64, + operation: u64, + data_output: u32, + data_capacity: u32, + metadata_output: u32, +) -> i32 { + data_plane_call(handle, |instance| { + let session = instance.data_plane_session(); + let operation = operation_id(operation)?; + let required = session.result_payload_bytes(operation)?; + validate_output(data_output, data_capacity as usize, required)?; + validate_fixed_output(metadata_output, UDP_RECEIVE_METADATA_LEN)?; + take_result( + &session, + operation, + DataPlaneOperationKind::UdpReceive, + |result| match result { + DataPlaneOperationResult::UdpReceived { + data, + peer_addr, + truncated, + } => { + write_output(data_output, data)?; + write_output( + metadata_output, + &encode_udp_receive_metadata(require_ipv4(*peer_addr)?, *truncated), + )?; + i32::try_from(data.len()) + .map_err(|_| invalid_input("UDP receive result exceeds i32")) + } + _ => Err(invalid_input("UDP receive result variant mismatch")), + }, + ) + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_data_plane_udp_send_result_take(handle: u64, operation: u64) -> i32 { + data_plane_call(handle, |instance| { + let session = instance.data_plane_session(); + let len = take_result( + &session, + operation_id(operation)?, + DataPlaneOperationKind::UdpSend, + |result| match result { + DataPlaneOperationResult::UdpSent { len } => Ok(*len), + _ => Err(invalid_input("UDP send result variant mismatch")), + }, + )?; + i32::try_from(len).map_err(|_| invalid_input("UDP send result exceeds i32")) + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn infinite_timeout_sentinel_is_distinct_from_zero() { + assert_eq!(timeout(u64::MAX), None); + assert_eq!(timeout(0), Some(Duration::ZERO)); + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/runtime/abi/rpc.rs b/vendor/easytier/easytier-core/src/wasi/runtime/abi/rpc.rs new file mode 100644 index 0000000..e5c8378 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/runtime/abi/rpc.rs @@ -0,0 +1,214 @@ +//! Protobuf RPC guest exports bound to one WASI core instance. + +use crate::{ + rpc::operation::{RpcAccessError, RpcOperationId, RpcSubmitError}, + wasi::abi::{RPC_ABI_VERSION, RPC_STATUS_PENDING}, +}; + +use super::{ + ASYNC_ERROR, BUSY, INVALID_INPUT, MAX_RPC_MESSAGE_LEN, WasiInstance, read_guest_buffer, + set_instance_error, with_abi_state, with_abi_state_mut, with_instance, +}; + +const OPERATION_ID_LEN: usize = 8; + +impl WasiInstance { + fn submit_rpc(&self, encoded_request: &[u8]) -> Result { + let execution = self.execution.lock().unwrap(); + let _domain = crate::foundation::time::enter_domain(self.domain); + let _runtime = execution.runtime.enter(); + self.rpc_operations.submit_encoded(encoded_request) + } +} + +fn operation_id(raw: u64) -> anyhow::Result { + RpcOperationId::from_raw(raw).ok_or_else(|| anyhow::anyhow!("invalid RPC operation ID")) +} + +fn validate_output(pointer: u32, capacity: usize) -> anyhow::Result<()> { + if pointer == 0 { + anyhow::bail!("guest RPC output buffer pointer is zero"); + } + with_abi_state(|state| { + let buffer = state + .buffers + .get(&pointer) + .ok_or_else(|| anyhow::anyhow!("unknown guest buffer: {pointer}"))?; + if capacity > buffer.len() { + anyhow::bail!( + "guest RPC output capacity {capacity} exceeds allocation {}", + buffer.len() + ); + } + Ok(()) + }) +} + +fn write_output(pointer: u32, bytes: &[u8]) -> anyhow::Result<()> { + with_abi_state_mut(|state| { + let buffer = state + .buffers + .get_mut(&pointer) + .ok_or_else(|| anyhow::anyhow!("unknown guest buffer: {pointer}"))?; + if bytes.len() > buffer.len() { + anyhow::bail!( + "RPC response requires {} bytes, allocation has {}", + bytes.len(), + buffer.len() + ); + } + buffer[..bytes.len()].copy_from_slice(bytes); + Ok(()) + }) +} + +fn submit_status(error: &RpcSubmitError) -> i32 { + match error { + RpcSubmitError::AtCapacity | RpcSubmitError::IdExhausted => BUSY, + RpcSubmitError::ExecutorUnavailable => ASYNC_ERROR, + RpcSubmitError::Decode(_) | RpcSubmitError::MissingMethod => INVALID_INPUT, + } +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_rpc_abi_version() -> u32 { + RPC_ABI_VERSION +} + +/// Submits one serialized `common.DirectRpcRequest`. +/// +/// The full protobuf method name is mandatory. On success, writes the opaque +/// operation ID as one big-endian `u64` to `output_operation`. +#[unsafe(no_mangle)] +pub extern "C" fn easytier_rpc_request_submit( + handle: u64, + request_pointer: u32, + request_length: u32, + output_operation: u32, +) -> i32 { + with_instance(handle, |instance| { + if let Err(error) = validate_output(output_operation, OPERATION_ID_LEN) { + set_instance_error(handle, error); + return Ok(INVALID_INPUT); + } + let request = match read_guest_buffer(request_pointer, request_length, MAX_RPC_MESSAGE_LEN) + { + Ok(request) => request, + Err(error) => { + set_instance_error(handle, error); + return Ok(INVALID_INPUT); + } + }; + let operation = match instance.submit_rpc(&request) { + Ok(operation) => operation, + Err(error) => { + let status = submit_status(&error); + set_instance_error(handle, error); + return Ok(status); + } + }; + if let Err(error) = write_output(output_operation, &operation.get().to_be_bytes()) { + instance.rpc_operations.free(operation); + set_instance_error(handle, error); + return Ok(INVALID_INPUT); + } + Ok(0) + }) +} + +/// Probes or consumes one serialized `common.RpcResponse`. +/// +/// Returns [`RPC_STATUS_PENDING`] while the operation is running. Passing +/// `(output, capacity) == (0, 0)` returns the required byte length without +/// consuming the response. If `capacity` is too small, the required length is +/// returned and the response remains available. Otherwise the response is +/// copied, consumed, and its byte length is returned. +#[unsafe(no_mangle)] +pub extern "C" fn easytier_rpc_response_take( + handle: u64, + operation: u64, + output: u32, + capacity: u32, +) -> i32 { + with_instance(handle, |instance| { + let operation = match operation_id(operation) { + Ok(operation) => operation, + Err(error) => { + set_instance_error(handle, error); + return Ok(INVALID_INPUT); + } + }; + let required = match instance.rpc_operations.response_len(operation) { + Ok(required) => required, + Err(RpcAccessError::Pending) => return Ok(RPC_STATUS_PENDING), + Err(error) => { + set_instance_error(handle, error); + return Ok(INVALID_INPUT); + } + }; + let required_i32 = match i32::try_from(required) { + Ok(required) => required, + Err(_) => { + set_instance_error(handle, "RPC response length exceeds i32"); + return Ok(ASYNC_ERROR); + } + }; + if output == 0 && capacity == 0 { + return Ok(required_i32); + } + let capacity = usize::try_from(capacity).expect("u32 fits usize on wasm32"); + if let Err(error) = validate_output(output, capacity) { + set_instance_error(handle, error); + return Ok(INVALID_INPUT); + } + if capacity < required { + return Ok(required_i32); + } + + let mut write_error = None; + let taken = instance + .rpc_operations + .take_response_with(operation, |response| { + if let Err(error) = write_output(output, response) { + write_error = Some(error); + return None; + } + Some(()) + }); + if let Some(error) = write_error { + set_instance_error(handle, error); + return Ok(INVALID_INPUT); + } + match taken { + Ok(Some(())) => Ok(required_i32), + Ok(None) => { + set_instance_error(handle, "RPC response could not be consumed"); + Ok(ASYNC_ERROR) + } + Err(RpcAccessError::Pending) => Ok(RPC_STATUS_PENDING), + Err(error) => { + set_instance_error(handle, error); + Ok(INVALID_INPUT) + } + } + }) +} + +/// Cancels and discards a pending operation, or discards an untaken response. +#[unsafe(no_mangle)] +pub extern "C" fn easytier_rpc_operation_free(handle: u64, operation: u64) -> i32 { + with_instance(handle, |instance| { + let operation = match operation_id(operation) { + Ok(operation) => operation, + Err(error) => { + set_instance_error(handle, error); + return Ok(INVALID_INPUT); + } + }; + if !instance.rpc_operations.free(operation) { + set_instance_error(handle, "unknown RPC operation"); + return Ok(INVALID_INPUT); + } + Ok(0) + }) +} diff --git a/vendor/easytier/easytier-core/src/wasi/runtime/abi/web_client.rs b/vendor/easytier/easytier-core/src/wasi/runtime/abi/web_client.rs new file mode 100644 index 0000000..157d943 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/runtime/abi/web_client.rs @@ -0,0 +1,121 @@ +use crate::{ + foundation::time::{clear_domain, enter_domain}, + wasi::{ + schema::WasiWebClientCreateConfig, + web_client::{WEB_CLIENT_DOMAIN, WasiWebClientRuntime}, + }, +}; + +use super::{ + ASYNC_ERROR, CONTEXT, INVALID_INPUT, INVALID_STATE, MAX_CREATE_CONFIG_LEN, read_guest_buffer, + set_abi_error, +}; + +fn with_web_client(operation: impl FnOnce(&WasiWebClientRuntime) -> i32) -> i32 { + CONTEXT.with(|context| { + let web_client = context.web_client.borrow(); + match web_client.as_ref() { + Some(web_client) => operation(web_client), + None => { + set_abi_error("WebClient is not running"); + INVALID_STATE + } + } + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_web_client_create(config_pointer: u32, config_length: u32) -> i32 { + let encoded = match read_guest_buffer(config_pointer, config_length, MAX_CREATE_CONFIG_LEN) { + Ok(encoded) => encoded, + Err(error) => { + set_abi_error(error); + return INVALID_INPUT; + } + }; + let config: WasiWebClientCreateConfig = match serde_json::from_slice(&encoded) { + Ok(config) => config, + Err(error) => { + set_abi_error(error); + return INVALID_INPUT; + } + }; + if let Err(error) = config.validate() { + set_abi_error(error); + return INVALID_INPUT; + } + let process_runtime = CONTEXT.with(|context| { + if context.web_client.borrow().is_some() { + return None; + } + Some(context.factory.process_runtime.clone()) + }); + let Some(process_runtime) = process_runtime else { + set_abi_error("WebClient is already running"); + return INVALID_STATE; + }; + let web_client = match WasiWebClientRuntime::new(config, process_runtime) { + Ok(web_client) => web_client, + Err(error) => { + set_abi_error(error); + return ASYNC_ERROR; + } + }; + CONTEXT.with(|context| { + *context.web_client.borrow_mut() = Some(web_client); + }); + 0 +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_web_client_drive() -> i32 { + with_web_client(|web_client| { + web_client.drive(); + 0 + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_web_client_notify_completions() -> i32 { + with_web_client(|web_client| { + web_client.notify_host_completions(); + 0 + }) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_web_client_next_deadline_millis() -> i64 { + let mut result = i64::from(INVALID_STATE); + let status = with_web_client(|web_client| { + result = web_client + .next_wait_millis() + .map(|millis| i64::try_from(millis).unwrap_or(i64::MAX)) + .unwrap_or(i64::MAX); + 0 + }); + if status == 0 { + result + } else { + i64::from(status) + } +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_web_client_is_connected() -> i32 { + with_web_client(|web_client| i32::from(web_client.is_connected())) +} + +#[unsafe(no_mangle)] +pub extern "C" fn easytier_web_client_drop() -> i32 { + let web_client = CONTEXT.with(|context| context.web_client.borrow_mut().take()); + let Some(web_client) = web_client else { + set_abi_error("WebClient is not running"); + return INVALID_STATE; + }; + { + let _domain = enter_domain(WEB_CLIENT_DOMAIN); + drop(web_client); + } + clear_domain(WEB_CLIENT_DOMAIN); + 0 +} diff --git a/vendor/easytier/easytier-core/src/wasi/runtime_driver.rs b/vendor/easytier/easytier-core/src/wasi/runtime_driver.rs new file mode 100644 index 0000000..38239e8 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/runtime_driver.rs @@ -0,0 +1,206 @@ +//! Bounded current-thread Tokio turns for externally driven runtimes. + +use std::{ + future::{Future, poll_fn}, + sync::{ + Arc, Mutex, + atomic::{AtomicBool, Ordering}, + }, + task::{Poll, Waker}, + time::Duration, +}; + +use tokio::runtime::Runtime; + +// A zero-duration timer can win before the executor's park hook observes +// quiescence, especially when JSPI resumes the guest on a slower embedder. +const DRIVE_BUDGET: Duration = Duration::from_millis(10); + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +pub(super) enum RuntimeDriveOutcome { + Quiescent, + BudgetExhausted, +} + +#[derive(Clone, Default)] +pub(super) struct RuntimeDriver { + state: Arc, +} + +#[derive(Default)] +struct RuntimeDriverState { + active: AtomicBool, + quiescent: AtomicBool, + waker: Mutex>, +} + +impl RuntimeDriver { + pub(super) fn on_thread_park(&self) { + if !self.state.active.load(Ordering::SeqCst) { + return; + } + self.state.quiescent.store(true, Ordering::SeqCst); + if let Some(waker) = self.state.waker.lock().unwrap().take() { + waker.wake(); + } + } + + pub(super) fn drive(&self, runtime: &Runtime, advance_timers: bool) -> RuntimeDriveOutcome { + if advance_timers { + // Give the timer driver a turn before enabling the quiescence hook + // so an expired timer can wake its task. + runtime.block_on(async { + tokio::time::sleep(Duration::ZERO).await; + }); + } + + let _active = RuntimeDriverGuard::activate(self.state.as_ref()); + runtime.block_on(async { + let budget = tokio::time::sleep(DRIVE_BUDGET); + tokio::pin!(budget); + poll_fn(|context| { + if self.state.poll_quiescent(context.waker()) { + return Poll::Ready(RuntimeDriveOutcome::Quiescent); + } + if budget.as_mut().poll(context).is_ready() { + return Poll::Ready(RuntimeDriveOutcome::BudgetExhausted); + } + Poll::Pending + }) + .await + }) + } +} + +impl RuntimeDriverState { + fn poll_quiescent(&self, waker: &Waker) -> bool { + if self.quiescent.load(Ordering::SeqCst) { + return true; + } + *self.waker.lock().unwrap() = Some(waker.clone()); + self.quiescent.load(Ordering::SeqCst) + } +} + +struct RuntimeDriverGuard<'a> { + state: &'a RuntimeDriverState, +} + +impl<'a> RuntimeDriverGuard<'a> { + fn activate(state: &'a RuntimeDriverState) -> Self { + state.quiescent.store(false, Ordering::SeqCst); + *state.waker.lock().unwrap() = None; + state.active.store(true, Ordering::SeqCst); + Self { state } + } +} + +impl Drop for RuntimeDriverGuard<'_> { + fn drop(&mut self) { + self.state.active.store(false, Ordering::SeqCst); + self.state.quiescent.store(false, Ordering::SeqCst); + *self.state.waker.lock().unwrap() = None; + } +} + +#[cfg(test)] +mod tests { + use std::{future::poll_fn, sync::Arc, task::Poll}; + + use tokio::{runtime::Builder, sync::Notify, time::Duration}; + + use super::{RuntimeDriveOutcome, RuntimeDriver}; + use crate::wasi::time::{enter_domain, next_deadline_millis}; + + fn runtime(driver: &RuntimeDriver) -> tokio::runtime::Runtime { + let park_driver = driver.clone(); + Builder::new_current_thread() + .enable_time() + .event_interval(3) + .on_thread_park(move || park_driver.on_thread_park()) + .build() + .unwrap() + } + + #[test] + fn reports_budget_exhaustion_for_a_continuously_runnable_task() { + let driver = RuntimeDriver::default(); + let runtime = runtime(&driver); + let task = runtime.spawn(poll_fn(|context| { + context.waker().wake_by_ref(); + Poll::<()>::Pending + })); + + assert_eq!( + driver.drive(&runtime, false), + RuntimeDriveOutcome::BudgetExhausted + ); + + task.abort(); + while driver.drive(&runtime, false) == RuntimeDriveOutcome::BudgetExhausted {} + assert!(task.is_finished()); + } + + #[test] + fn reports_quiescence_while_waiting_for_an_external_wake() { + let driver = RuntimeDriver::default(); + let runtime = runtime(&driver); + let notify = Arc::new(Notify::new()); + let task_notify = notify.clone(); + let task = runtime.spawn(async move { + task_notify.notified().await; + }); + + assert_eq!( + driver.drive(&runtime, false), + RuntimeDriveOutcome::Quiescent + ); + assert!(!task.is_finished()); + + notify.notify_one(); + while driver.drive(&runtime, false) == RuntimeDriveOutcome::BudgetExhausted {} + assert!(task.is_finished()); + } + + #[test] + fn advances_expired_timers_only_when_requested() { + let driver = RuntimeDriver::default(); + let runtime = runtime(&driver); + let task = runtime.spawn(async { + tokio::time::sleep(Duration::ZERO).await; + }); + + assert_eq!( + driver.drive(&runtime, false), + RuntimeDriveOutcome::Quiescent + ); + assert!(!task.is_finished()); + + assert_eq!(driver.drive(&runtime, true), RuntimeDriveOutcome::Quiescent); + assert!(task.is_finished()); + } + + #[test] + fn tracked_expired_timer_requests_advancement() { + let _domain = enter_domain(7); + let driver = RuntimeDriver::default(); + let runtime = runtime(&driver); + let task = runtime.spawn(async { + crate::foundation::time::sleep(Duration::ZERO).await; + }); + + assert_eq!( + driver.drive(&runtime, false), + RuntimeDriveOutcome::Quiescent + ); + assert_eq!(next_deadline_millis(7), Some(0)); + + let advance_timers = next_deadline_millis(7) == Some(0); + assert_eq!( + driver.drive(&runtime, advance_timers), + RuntimeDriveOutcome::Quiescent + ); + assert!(task.is_finished()); + assert_eq!(next_deadline_millis(7), None); + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/schema.rs b/vendor/easytier/easytier-core/src/wasi/schema.rs new file mode 100644 index 0000000..090dec8 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/schema.rs @@ -0,0 +1,99 @@ +//! Versioned, serialized inputs accepted by the WASI instance lifecycle ABI. + +use serde::{Deserialize, Serialize}; + +use crate::{ + config::toml::TomlConfig, connectivity::connector_host::HostConnectorEnvironmentSnapshot, +}; + +pub(crate) const WASI_CORE_INSTANCE_CONFIG_VERSION: u32 = + crate::wasi::abi::CORE_INSTANCE_CONFIG_VERSION; +#[cfg(all(target_os = "wasi", feature = "management"))] +pub(crate) const WASI_WEB_CLIENT_CONFIG_VERSION: u32 = crate::wasi::abi::WEB_CLIENT_CONFIG_VERSION; + +/// Versioned payload accepted by host-driven instance frontends. +#[derive(Debug, Clone, Serialize, Deserialize)] +pub(crate) struct WasiCoreInstanceCreateConfig { + pub version: u32, + pub config: String, + pub environment: HostConnectorEnvironmentSnapshot, +} + +impl WasiCoreInstanceCreateConfig { + pub fn validate(&self) -> anyhow::Result<()> { + if self.version != WASI_CORE_INSTANCE_CONFIG_VERSION { + anyhow::bail!( + "unsupported host core instance config version: {}", + self.version + ); + } + Ok(()) + } + + pub fn parse_config(&self) -> anyhow::Result { + TomlConfig::new_from_str_with_source("WASI create config", &self.config) + } +} + +#[cfg(all(target_os = "wasi", feature = "management"))] +#[derive(Debug, Clone, Serialize, Deserialize)] +pub(crate) struct WasiWebClientCreateConfig { + pub version: u32, + pub endpoint: String, + pub machine_id: String, + pub hostname: String, + pub secure_mode: bool, + pub os_type: String, + pub environment: HostConnectorEnvironmentSnapshot, +} + +#[cfg(all(target_os = "wasi", feature = "management"))] +impl WasiWebClientCreateConfig { + pub fn validate(&self) -> anyhow::Result<()> { + if self.version != WASI_WEB_CLIENT_CONFIG_VERSION { + anyhow::bail!( + "unsupported host WebClient config version: {}", + self.version + ); + } + uuid::Uuid::parse_str(&self.machine_id)?; + Ok(()) + } +} + +#[cfg(feature = "wasm-host-tunnel")] +#[derive(Debug, Clone, Serialize, Deserialize)] +pub(crate) struct WasiHostTunnelMetadata { + pub version: u32, + pub local_url: url::Url, + pub remote_url: url::Url, + #[serde(default)] + pub resolved_remote_url: Option, +} + +#[cfg(feature = "wasm-host-tunnel")] +impl WasiHostTunnelMetadata { + pub(crate) fn validate(&self) -> anyhow::Result<()> { + if self.version != crate::wasi::abi::HOST_TUNNEL_ABI_VERSION { + anyhow::bail!("unsupported host tunnel ABI version: {}", self.version); + } + Ok(()) + } +} + +#[cfg(all(test, feature = "wasm-host-tunnel"))] +mod tests { + use super::*; + + #[test] + fn host_tunnel_metadata_accepts_transport_neutral_urls() { + let metadata = WasiHostTunnelMetadata { + version: crate::wasi::abi::HOST_TUNNEL_ABI_VERSION, + local_url: "test-tunnel://listener.example/".parse().unwrap(), + remote_url: "test-tunnel://peer.example/".parse().unwrap(), + resolved_remote_url: None, + }; + + metadata.validate().unwrap(); + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/time.rs b/vendor/easytier/easytier-core/src/wasi/time.rs new file mode 100644 index 0000000..67d1ead --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/time.rs @@ -0,0 +1,318 @@ +//! Deadline-tracking Tokio time implementation for externally driven WASI runtimes. + +mod tracked { + use std::{ + cell::{Cell, RefCell}, + collections::BTreeMap, + future::{Future, IntoFuture}, + pin::Pin, + task::{Context, Poll}, + }; + + pub use tokio::time::{Duration, Instant, MissedTickBehavior, error}; + + thread_local! { + static CURRENT_DOMAIN: Cell> = const { Cell::new(None) }; + static DEADLINES: RefCell = RefCell::new(DeadlineRegistry::default()); + } + + #[derive(Default)] + struct DeadlineRegistry { + next_token: u64, + entries: BTreeMap, + } + + impl DeadlineRegistry { + fn insert(&mut self, domain: u64, deadline: Instant) -> u64 { + loop { + self.next_token = self.next_token.wrapping_add(1); + if self.next_token != 0 && !self.entries.contains_key(&self.next_token) { + self.entries.insert(self.next_token, (domain, deadline)); + return self.next_token; + } + } + } + } + + pub(crate) struct TimerDomainGuard(Option); + + impl Drop for TimerDomainGuard { + fn drop(&mut self) { + CURRENT_DOMAIN.set(self.0); + } + } + + pub(crate) fn enter_domain(domain: u64) -> TimerDomainGuard { + TimerDomainGuard(CURRENT_DOMAIN.replace(Some(domain))) + } + + pub(crate) fn clear_domain(domain: u64) { + DEADLINES.with_borrow_mut(|registry| { + registry + .entries + .retain(|_, (entry_domain, _)| *entry_domain != domain); + }); + } + + pub(crate) fn next_deadline_millis(domain: u64) -> Option { + let deadline = DEADLINES.with_borrow(|registry| { + registry + .entries + .values() + .filter_map(|(entry_domain, deadline)| { + (*entry_domain == domain).then_some(*deadline) + }) + .min() + })?; + let duration = deadline.saturating_duration_since(Instant::now()); + let nanos = duration.as_nanos(); + Some(u64::try_from(nanos.div_ceil(1_000_000)).unwrap_or(u64::MAX)) + } + + struct Registration { + token: Option, + deadline: Instant, + } + + impl Registration { + fn new(deadline: Instant) -> Self { + let mut registration = Self { + token: None, + deadline, + }; + registration.ensure(); + registration + } + + fn ensure(&mut self) { + if self.token.is_some() { + return; + } + let Some(domain) = CURRENT_DOMAIN.get() else { + return; + }; + self.token = + Some(DEADLINES.with_borrow_mut(|registry| registry.insert(domain, self.deadline))); + } + + fn reset(&mut self, deadline: Instant) { + self.remove(); + self.deadline = deadline; + self.ensure(); + } + + fn remove(&mut self) { + if let Some(token) = self.token.take() { + DEADLINES.with_borrow_mut(|registry| { + registry.entries.remove(&token); + }); + } + } + } + + impl Drop for Registration { + fn drop(&mut self) { + self.remove(); + } + } + + pub struct Sleep { + inner: Pin>, + registration: Registration, + } + + impl Sleep { + pub fn reset(mut self: Pin<&mut Self>, deadline: Instant) { + let this = self.as_mut().get_mut(); + this.inner.as_mut().reset(deadline); + this.registration.reset(deadline); + } + } + + impl Future for Sleep { + type Output = (); + + fn poll(mut self: Pin<&mut Self>, context: &mut Context<'_>) -> Poll { + let this = self.as_mut().get_mut(); + this.registration.ensure(); + let result = this.inner.as_mut().poll(context); + if result.is_ready() { + this.registration.remove(); + } + result + } + } + + pub fn sleep(duration: Duration) -> Sleep { + sleep_until(Instant::now() + duration) + } + + pub fn sleep_until(deadline: Instant) -> Sleep { + Sleep { + inner: Box::pin(tokio::time::sleep_until(deadline)), + registration: Registration::new(deadline), + } + } + + pub struct Interval { + inner: Pin>, + period: Duration, + next_deadline: Instant, + missed_tick_behavior: MissedTickBehavior, + registration: Registration, + } + + impl Interval { + pub async fn tick(&mut self) -> Instant { + self.registration.ensure(); + let tick = self.next_deadline; + self.inner.as_mut().await; + let now = Instant::now(); + self.next_deadline = if now > tick + Duration::from_millis(5) { + next_interval_deadline(self.missed_tick_behavior, tick, now, self.period) + } else { + tick + self.period + }; + self.inner.as_mut().reset(self.next_deadline); + self.registration.reset(self.next_deadline); + tick + } + } + + pub(super) fn next_interval_deadline( + behavior: MissedTickBehavior, + tick: Instant, + now: Instant, + period: Duration, + ) -> Instant { + match behavior { + MissedTickBehavior::Burst => tick + period, + MissedTickBehavior::Delay => now + period, + MissedTickBehavior::Skip => { + now + period + - Duration::from_nanos( + ((now - tick).as_nanos() % period.as_nanos()) + .try_into() + .expect("too much time has elapsed since the interval tick"), + ) + } + } + } + + pub fn interval(period: Duration) -> Interval { + interval_at(Instant::now(), period) + } + + pub fn interval_at(start: Instant, period: Duration) -> Interval { + assert!(period > Duration::ZERO, "`period` must be non-zero."); + Interval { + inner: Box::pin(tokio::time::sleep_until(start)), + period, + next_deadline: start, + missed_tick_behavior: MissedTickBehavior::Burst, + registration: Registration::new(start), + } + } + + pub async fn timeout(duration: Duration, future: F) -> Result + where + F: IntoFuture, + { + timeout_at(Instant::now() + duration, future).await + } + + pub async fn timeout_at(deadline: Instant, future: F) -> Result + where + F: IntoFuture, + { + let _registration = Registration::new(deadline); + tokio::time::timeout_at(deadline, future).await + } +} + +pub use tracked::{Duration, Instant, Interval, error, interval, sleep, sleep_until, timeout}; + +pub(crate) use tracked::{clear_domain, enter_domain, next_deadline_millis}; + +#[cfg(test)] +mod tests { + use super::tracked::MissedTickBehavior; + use super::*; + + #[tokio::test] + async fn tracks_reset_completion_and_drop_per_domain() { + let _domain = enter_domain(7); + { + let sleep = sleep(Duration::from_millis(50)); + tokio::pin!(sleep); + assert!(matches!(next_deadline_millis(7), Some(1..=50))); + assert_eq!(next_deadline_millis(8), None); + + sleep + .as_mut() + .reset(Instant::now() + Duration::from_millis(20)); + assert!(matches!(next_deadline_millis(7), Some(1..=20))); + } + assert_eq!(next_deadline_millis(7), None); + + let pending = sleep(Duration::from_secs(1)); + assert!(matches!(next_deadline_millis(7), Some(999..=1000))); + drop(pending); + assert_eq!(next_deadline_millis(7), None); + + sleep(Duration::ZERO).await; + assert_eq!(next_deadline_millis(7), None); + } + + #[tokio::test] + async fn tracks_interval_and_timeout_lifetimes() { + let _domain = enter_domain(9); + let mut ticker = interval(Duration::from_millis(40)); + assert_eq!(next_deadline_millis(9), Some(0)); + ticker.tick().await; + assert!(matches!(next_deadline_millis(9), Some(1..=40))); + drop(ticker); + assert_eq!(next_deadline_millis(9), None); + + let timeout = tokio::spawn(timeout( + Duration::from_millis(60), + std::future::pending::<()>(), + )); + tokio::task::yield_now().await; + assert!(matches!(next_deadline_millis(9), Some(1..=60))); + timeout.abort(); + let _ = timeout.await; + assert_eq!(next_deadline_millis(9), None); + } + + #[tokio::test] + async fn clears_all_deadlines_for_a_domain() { + let _domain = enter_domain(11); + let _timer = sleep(Duration::from_secs(1)); + assert!(next_deadline_millis(11).is_some()); + + clear_domain(11); + + assert_eq!(next_deadline_millis(11), None); + } + + #[test] + fn computes_missed_interval_deadlines_like_tokio() { + let tick = Instant::now(); + let now = tick + Duration::from_millis(250); + let period = Duration::from_millis(100); + + assert_eq!( + tracked::next_interval_deadline(MissedTickBehavior::Burst, tick, now, period), + tick + period + ); + assert_eq!( + tracked::next_interval_deadline(MissedTickBehavior::Delay, tick, now, period), + now + period + ); + assert_eq!( + tracked::next_interval_deadline(MissedTickBehavior::Skip, tick, now, period), + tick + Duration::from_millis(300) + ); + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/web_client.rs b/vendor/easytier/easytier-core/src/wasi/web_client.rs new file mode 100644 index 0000000..1b81493 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/web_client.rs @@ -0,0 +1,488 @@ +use std::sync::{Arc, Mutex}; + +use async_trait::async_trait; +use bytes::Bytes; +use prost::Message; +use tokio::runtime::Builder; +use url::Url; + +use crate::{ + config::{api_input::NetworkConfigExt, toml::ConfigLoader}, + connectivity::{ + connector_host::{ConnectorHost, new_connector_host}, + manual::{ + ManualConnectorOptions, ManualTunnelConnector, discovery::ManualEndpointDiscoveryConfig, + }, + protocol::{CoreClientProtocolConfig, CoreClientProtocolUpgrader, raw::TunnelDialer}, + }, + foundation::time::{enter_domain, next_deadline_millis}, + host::{dns::HostDnsResolver, management::HostManagementClient, socket::HostSocketRuntime}, + management::{ + ConfigServerEndpoint, ManagementRpcForwarder, WebClient, WebClientBackend, WebClientConfig, + config_source_from_rpc, register_forwarded_instance_management_rpc, + }, + process_runtime::CoreProcessRuntime, + proto::{ + api::manage::{ + ListNetworkInstanceRequest, NetworkConfig, NetworkingMethod, RunNetworkInstanceRequest, + ValidateConfigRequest, ValidateConfigResponse, WebClientService, + WebClientServiceClient, WebClientServiceDescriptor, WebClientServiceMethodDescriptor, + }, + common::{DirectRpcRequest, HostManagementRequest, RpcResponse}, + rpc_types::{ + controller::BaseController, + descriptor::{MethodDescriptor, ServiceDescriptor}, + error, + handler::Handler, + }, + web::DeviceOsInfo, + }, + rpc::service_registry::ServiceRegistry, + socket::IpVersion, + tunnel::Tunnel, + wasi::{ + adapter::{ + dns::WasiHostDnsIo, environment::WasiHostConnectorEnvironmentIo, + management::WasiHostManagementIo, socket::backend::WasiHostSocketBackend, + }, + runtime_driver::{RuntimeDriveOutcome, RuntimeDriver}, + schema::WasiWebClientCreateConfig, + }, +}; + +pub(super) const WEB_CLIENT_DOMAIN: u64 = u64::MAX; + +type WasiConnectorHost = ConnectorHost; + +fn supports_hosted_tunnel_url(value: &str) -> bool { + Url::parse(value).is_ok_and(|url| matches!(url.scheme(), "tcp" | "udp")) +} + +fn hosted_network_config(config: &NetworkConfig) -> NetworkConfig { + let public_server_url = config + .public_server_url + .as_ref() + .filter(|url| supports_hosted_tunnel_url(url)) + .cloned(); + let peers = config + .peers + .iter() + .filter(|peer| supports_hosted_tunnel_url(&peer.uri)) + .cloned() + .collect::>(); + let networking_method = + match NetworkingMethod::try_from(config.networking_method.unwrap_or_default()) { + Ok(NetworkingMethod::PublicServer) + if public_server_url.is_none() && peers.is_empty() => + { + NetworkingMethod::Standalone + } + Ok(method) => method, + Err(_) => NetworkingMethod::Standalone, + }; + + NetworkConfig { + instance_id: config.instance_id.clone(), + dhcp: config.dhcp, + virtual_ipv4: config.virtual_ipv4.clone(), + network_length: config.network_length, + hostname: config.hostname.clone(), + network_name: config.network_name.clone(), + network_secret: config.network_secret.clone(), + networking_method: Some(networking_method as i32), + public_server_url, + peer_urls: config + .peer_urls + .iter() + .filter(|url| supports_hosted_tunnel_url(url)) + .cloned() + .collect(), + proxy_cidrs: config.proxy_cidrs.clone(), + listener_urls: config + .listener_urls + .iter() + .filter(|url| supports_hosted_tunnel_url(url)) + .cloned() + .collect(), + latency_first: config.latency_first, + disable_ipv6: config.disable_ipv6, + disable_p2p: config.disable_p2p, + no_tun: config.no_tun, + relay_all_peer_rpc: config.relay_all_peer_rpc, + enable_relay_network_whitelist: config.enable_relay_network_whitelist, + relay_network_whitelist: config.relay_network_whitelist.clone(), + disable_encryption: config.disable_encryption, + disable_udp_hole_punching: config.disable_udp_hole_punching, + mtu: config.mtu, + enable_private_mode: config.enable_private_mode, + disable_sym_hole_punching: config.disable_sym_hole_punching, + p2p_only: config.p2p_only, + disable_tcp_hole_punching: config.disable_tcp_hole_punching, + secure_mode: config.secure_mode.clone(), + acl: config.acl.clone(), + port_forwards: config.port_forwards.clone(), + lazy_p2p: config.lazy_p2p, + need_p2p: config.need_p2p, + instance_recv_bps_limit: config.instance_recv_bps_limit, + disable_upnp: config.disable_upnp, + disable_relay_data: config.disable_relay_data, + prefer_peer_relay: config.prefer_peer_relay, + enable_udp_broadcast_relay: config.enable_udp_broadcast_relay, + managed_credentials: config.managed_credentials.clone(), + peers, + ..Default::default() + } +} + +struct WasiConfigServerConnector { + url: Url, + connector: ManualTunnelConnector, +} + +#[async_trait] +impl TunnelDialer for WasiConfigServerConnector { + async fn connect(&self) -> anyhow::Result> { + self.connector + .connect(self.url.clone(), IpVersion::Both) + .await + } + + fn remote_url(&self) -> Url { + self.url.clone() + } +} + +#[derive(Clone)] +struct HostManagementHandler { + client: HostManagementClient, +} + +impl HostManagementHandler { + async fn forward( + &self, + full_method_name: String, + request: Bytes, + prepared_config: Option, + prepared_instance_id: Option, + ) -> error::Result { + let request = HostManagementRequest { + rpc: Some(DirectRpcRequest { + full_method_name, + request: request.into(), + timeout_ms: None, + }), + prepared_config, + prepared_instance_id: prepared_instance_id.map(Into::into), + }; + let response = self + .client + .call(&request.encode_to_vec()) + .await + .map_err(|error| error::Error::ExecutionError(error.into()))?; + let response = RpcResponse::decode(response.as_slice())?; + if let Some(error) = response.error { + return Err((&error).into()); + } + Ok(response.response.into()) + } +} + +#[async_trait] +impl ManagementRpcForwarder for HostManagementHandler { + async fn forward(&self, full_method_name: String, input: Bytes) -> error::Result { + HostManagementHandler::forward(self, full_method_name, input, None, None).await + } +} + +#[async_trait] +impl Handler for HostManagementHandler { + type Descriptor = WebClientServiceDescriptor; + type Controller = BaseController; + + async fn call( + &self, + _: Self::Controller, + method: WebClientServiceMethodDescriptor, + input: Bytes, + ) -> error::Result { + let full_method_name = format!( + "{}.{}.{}", + WebClientServiceDescriptor.package(), + WebClientServiceDescriptor.proto_name(), + method.proto_name() + ); + match method { + WebClientServiceMethodDescriptor::ValidateConfig => { + let request = ValidateConfigRequest::decode(input)?; + let network_config = request.config.unwrap_or_default(); + let config = hosted_network_config(&network_config).gen_config()?; + Ok(ValidateConfigResponse { + toml_config: config.dump(), + } + .encode_to_vec() + .into()) + } + WebClientServiceMethodDescriptor::RunNetworkInstance => { + let request = RunNetworkInstanceRequest::decode(input.clone())?; + let network_config = request + .config + .as_ref() + .ok_or_else(|| anyhow::anyhow!("config is required"))?; + let config = hosted_network_config(&network_config).gen_config()?; + let instance_id = request + .inst_id + .map(Into::into) + .unwrap_or_else(|| config.get_id()); + config.set_id(instance_id); + config.set_network_config_source(config_source_from_rpc(request.source)); + self.forward( + full_method_name, + input, + Some(config.dump()), + Some(instance_id), + ) + .await + } + _ => self.forward(full_method_name, input, None, None).await, + } + } +} + +struct WasiWebClientBackend { + handler: HostManagementHandler, +} + +#[async_trait] +impl WebClientBackend for WasiWebClientBackend { + fn register(&self, registry: &ServiceRegistry) { + registry.register(self.handler.clone(), ""); + register_forwarded_instance_management_rpc(self.handler.clone(), registry); + } + + async fn instance_ids(&self) -> anyhow::Result> { + let response = WebClientServiceClient::new(self.handler.clone()) + .list_network_instance(BaseController::default(), ListNetworkInstanceRequest {}) + .await?; + Ok(response.inst_ids.into_iter().map(Into::into).collect()) + } + + fn failed_instance_ids(&self) -> Vec { + Vec::new() + } +} + +pub(super) struct WasiWebClientRuntime { + socket_runtime: HostSocketRuntime, + client: WebClient<()>, + execution: Mutex, +} + +struct WasiWebClientExecution { + runtime: tokio::runtime::Runtime, + runtime_driver: RuntimeDriver, + drive_again: bool, +} + +impl WasiWebClientRuntime { + pub(super) fn new( + config: WasiWebClientCreateConfig, + process_runtime: Arc, + ) -> anyhow::Result { + let endpoint = ConfigServerEndpoint::parse(&config.endpoint, |url| { + matches!(url.scheme(), "tcp" | "udp") + })?; + let machine_id = uuid::Uuid::parse_str(&config.machine_id)?; + let runtime_driver = RuntimeDriver::default(); + let park_driver = runtime_driver.clone(); + let runtime = Builder::new_current_thread() + .enable_time() + .on_thread_park(move || park_driver.on_thread_park()) + .build()?; + let socket_runtime = HostSocketRuntime::new(); + let client = { + let _domain = enter_domain(WEB_CLIENT_DOMAIN); + let _runtime = runtime.enter(); + let host = Arc::new(new_connector_host( + socket_runtime.clone(), + Arc::new(WasiHostSocketBackend::default()), + config.environment, + Arc::new(WasiHostConnectorEnvironmentIo), + )); + let dns = Arc::new(HostDnsResolver::new( + socket_runtime.clone(), + Arc::new(WasiHostDnsIo), + )); + let connector = process_runtime.manual_connector( + host, + dns.clone(), + dns, + Arc::new(CoreClientProtocolUpgrader::new( + CoreClientProtocolConfig::default(), + )), + ManualEndpointDiscoveryConfig::default(), + ManualConnectorOptions::default(), + ); + let backend = Arc::new(WasiWebClientBackend { + handler: HostManagementHandler { + client: HostManagementClient::new( + socket_runtime.clone(), + Arc::new(WasiHostManagementIo), + ), + }, + }); + WebClient::with_backend( + WasiConfigServerConnector { + url: endpoint.connect_url().clone(), + connector, + }, + WebClientConfig { + token: endpoint.token().to_owned(), + machine_id, + hostname: config.hostname, + device_os: DeviceOsInfo { + os_type: config.os_type, + version: String::new(), + distribution: String::new(), + }, + easytier_version: env!("CARGO_PKG_VERSION").to_owned(), + secure_mode: config.secure_mode, + }, + backend, + ) + }; + + Ok(Self { + socket_runtime, + client, + execution: Mutex::new(WasiWebClientExecution { + runtime, + runtime_driver, + drive_again: false, + }), + }) + } + + pub(super) fn drive(&self) { + let _domain = enter_domain(WEB_CLIENT_DOMAIN); + let advance_timers = next_deadline_millis(WEB_CLIENT_DOMAIN) == Some(0); + let mut execution = self.execution.lock().unwrap(); + execution.drive_again = execution + .runtime_driver + .drive(&execution.runtime, advance_timers) + == RuntimeDriveOutcome::BudgetExhausted; + } + + pub(super) fn notify_host_completions(&self) { + self.socket_runtime.notify_completions(); + } + + pub(super) fn next_wait_millis(&self) -> Option { + let execution = self.execution.lock().unwrap(); + if execution.drive_again { + Some(0) + } else { + next_deadline_millis(WEB_CLIENT_DOMAIN) + } + } + + pub(super) fn is_connected(&self) -> bool { + self.client.is_connected() + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::proto::{ + api::manage::{ManagedCredentialConfig, NetworkPeerConfig}, + common::{CompressionAlgoPb, SecureModeConfig}, + }; + + #[test] + fn hosted_config_keeps_supported_fields_and_filters_tunnel_urls() { + let original = NetworkConfig { + instance_id: Some(uuid::Uuid::new_v4().to_string()), + dhcp: Some(true), + network_name: Some("network".to_owned()), + network_secret: Some("secret".to_owned()), + networking_method: Some(NetworkingMethod::Manual as i32), + peer_urls: vec![ + "tcp://peer.example:11010".to_owned(), + "wg://peer.example:11011".to_owned(), + ], + listener_urls: vec![ + "udp://0.0.0.0:11010".to_owned(), + "wg://0.0.0.0:11011".to_owned(), + ], + peers: vec![ + NetworkPeerConfig { + uri: "tcp://peer.example:11010".to_owned(), + peer_public_key: Some("key".to_owned()), + }, + NetworkPeerConfig { + uri: "quic://peer.example:11010".to_owned(), + peer_public_key: None, + }, + ], + secure_mode: Some(SecureModeConfig { + enabled: true, + ..Default::default() + }), + enable_private_mode: Some(true), + disable_relay_data: Some(true), + prefer_peer_relay: Some(true), + proxy_cidrs: vec!["10.88.0.0/24".to_owned()], + managed_credentials: vec![ManagedCredentialConfig { + credential_id: "managed".to_owned(), + credential_secret: "secret".to_owned(), + ..Default::default() + }], + port_forwards: vec![crate::proto::api::manage::PortForwardConfig { + proto: "tcp".to_owned(), + bind_ip: "127.0.0.1".to_owned(), + bind_port: 18080, + dst_ip: "10.88.0.2".to_owned(), + dst_port: 80, + }], + enable_vpn_portal: Some(true), + data_compress_algo: Some(CompressionAlgoPb::Zstd as i32), + credential_file: Some("/unsupported".to_owned()), + ..Default::default() + }; + + let hosted = hosted_network_config(&original); + + assert_eq!( + hosted.peer_urls, + vec!["tcp://peer.example:11010".to_owned()] + ); + assert_eq!(hosted.listener_urls, vec!["udp://0.0.0.0:11010".to_owned()]); + assert_eq!(hosted.peers, original.peers[..1]); + assert_eq!(hosted.secure_mode, original.secure_mode); + assert_eq!(hosted.enable_private_mode, Some(true)); + assert_eq!(hosted.disable_relay_data, Some(true)); + assert_eq!(hosted.prefer_peer_relay, Some(true)); + assert_eq!(hosted.proxy_cidrs, original.proxy_cidrs); + assert_eq!(hosted.managed_credentials, original.managed_credentials); + assert_eq!(hosted.port_forwards, original.port_forwards); + assert_eq!(hosted.enable_vpn_portal, None); + assert_eq!(hosted.data_compress_algo, None); + assert_eq!(hosted.credential_file, None); + assert_eq!(original.listener_urls.len(), 2); + } + + #[test] + fn hosted_config_falls_back_to_standalone_without_a_supported_public_peer() { + let hosted = hosted_network_config(&NetworkConfig { + networking_method: Some(NetworkingMethod::PublicServer as i32), + public_server_url: Some("wg://peer.example:11010".to_owned()), + ..Default::default() + }); + + assert_eq!( + hosted.networking_method, + Some(NetworkingMethod::Standalone as i32) + ); + assert_eq!(hosted.public_server_url, None); + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/wire/common.rs b/vendor/easytier/easytier-core/src/wasi/wire/common.rs new file mode 100644 index 0000000..6531103 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/wire/common.rs @@ -0,0 +1,53 @@ +use std::io; + +pub(crate) fn status(operation: &str, result: i32) -> io::Result<()> { + if result == 0 { + Ok(()) + } else { + Err(host_error(operation, result)) + } +} + +pub(crate) fn host_error(operation: &str, code: i32) -> io::Error { + io::Error::other(format!("host {operation} failed with code {code}")) +} + +pub(crate) fn tcp_connect_error(code: i32) -> io::Error { + let kind = match code { + -6 => io::ErrorKind::ConnectionRefused, + -7 => io::ErrorKind::ConnectionAborted, + -8 => io::ErrorKind::ConnectionReset, + -9 => io::ErrorKind::NotConnected, + _ => return host_error("take_tcp_connect", code), + }; + io::Error::new(kind, format!("host TCP connect failed with code {code}")) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn tcp_connect_status_preserves_error_kinds() { + assert_eq!( + tcp_connect_error(-6).kind(), + io::ErrorKind::ConnectionRefused + ); + assert_eq!( + tcp_connect_error(-7).kind(), + io::ErrorKind::ConnectionAborted + ); + assert_eq!(tcp_connect_error(-8).kind(), io::ErrorKind::ConnectionReset); + assert_eq!(tcp_connect_error(-9).kind(), io::ErrorKind::NotConnected); + assert_eq!(tcp_connect_error(-3).kind(), io::ErrorKind::Other); + } + + #[test] + fn status_preserves_success_and_host_error_context() { + assert!(status("start_read", 0).is_ok()); + assert_eq!( + status("start_read", -3).unwrap_err().kind(), + io::ErrorKind::Other + ); + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/wire/data_plane.rs b/vendor/easytier/easytier-core/src/wasi/wire/data_plane.rs new file mode 100644 index 0000000..6817938 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/wire/data_plane.rs @@ -0,0 +1,161 @@ +//! Explicit big-endian wire records returned by data-plane guest exports. + +use std::{io, net::SocketAddr}; + +use crate::gateway::{DataPlaneCompletionDescriptor, DataPlaneErrorKind}; + +use super::socket::{SOCKET_ADDRESS_LEN, decode_socket_address, encode_socket_address}; + +pub(crate) const COMPLETION_LEN: usize = 12; +pub(crate) const TCP_CONNECT_RESULT_LEN: usize = 8 + SOCKET_ADDRESS_LEN * 2; +pub(crate) const TCP_BIND_RESULT_LEN: usize = 8 + SOCKET_ADDRESS_LEN; +pub(crate) const TCP_ACCEPT_RESULT_LEN: usize = TCP_CONNECT_RESULT_LEN; +pub(crate) const UDP_BIND_RESULT_LEN: usize = TCP_BIND_RESULT_LEN; +pub(crate) const TCP_READ_METADATA_LEN: usize = 1; +pub(crate) const UDP_RECEIVE_METADATA_LEN: usize = SOCKET_ADDRESS_LEN + 1; + +pub(crate) fn decode_ipv4_socket_address(wire: &[u8]) -> io::Result { + let wire = <&[u8; SOCKET_ADDRESS_LEN]>::try_from(wire).map_err(|_| { + io::Error::new(io::ErrorKind::InvalidInput, "invalid socket address length") + })?; + let address = decode_socket_address(wire)?; + if !address.is_ipv4() { + return Err(io::Error::new( + io::ErrorKind::Unsupported, + "data-plane ABI supports IPv4 only", + )); + } + Ok(address) +} + +pub(crate) fn encode_completion(completion: DataPlaneCompletionDescriptor) -> [u8; COMPLETION_LEN] { + let mut wire = [0; COMPLETION_LEN]; + wire[..8].copy_from_slice(&completion.operation_id.get().to_be_bytes()); + wire[8..10].copy_from_slice(&(completion.kind as u16).to_be_bytes()); + wire[10..12].copy_from_slice(&completion.status.code().to_be_bytes()); + wire +} + +pub(crate) fn encode_resource_and_address( + resource: u64, + address: SocketAddr, +) -> [u8; TCP_BIND_RESULT_LEN] { + let mut wire = [0; TCP_BIND_RESULT_LEN]; + wire[..8].copy_from_slice(&resource.to_be_bytes()); + wire[8..].copy_from_slice(&encode_socket_address(address)); + wire +} + +pub(crate) fn encode_stream_addresses( + stream: u64, + local_addr: SocketAddr, + peer_addr: SocketAddr, +) -> [u8; TCP_CONNECT_RESULT_LEN] { + let mut wire = [0; TCP_CONNECT_RESULT_LEN]; + wire[..8].copy_from_slice(&stream.to_be_bytes()); + wire[8..8 + SOCKET_ADDRESS_LEN].copy_from_slice(&encode_socket_address(local_addr)); + wire[8 + SOCKET_ADDRESS_LEN..].copy_from_slice(&encode_socket_address(peer_addr)); + wire +} + +pub(crate) fn encode_tcp_read_metadata(eof: bool) -> [u8; TCP_READ_METADATA_LEN] { + [u8::from(eof)] +} + +pub(crate) fn encode_udp_receive_metadata( + peer_addr: SocketAddr, + truncated: bool, +) -> [u8; UDP_RECEIVE_METADATA_LEN] { + let mut wire = [0; UDP_RECEIVE_METADATA_LEN]; + wire[..SOCKET_ADDRESS_LEN].copy_from_slice(&encode_socket_address(peer_addr)); + wire[SOCKET_ADDRESS_LEN] = u8::from(truncated); + wire +} + +pub(crate) fn error_status(kind: DataPlaneErrorKind) -> i32 { + -(kind as i32) +} + +pub(crate) fn normalize_call_status(entered: bool, status: i32) -> i32 { + if entered { + status + } else { + error_status(DataPlaneErrorKind::HandleClosed) + } +} + +#[cfg(test)] +mod tests { + use crate::gateway::{DataPlaneCompletionStatus, DataPlaneOperationId, DataPlaneOperationKind}; + + use super::*; + + #[test] + fn completion_record_has_no_native_padding() { + let completion = DataPlaneCompletionDescriptor { + operation_id: DataPlaneOperationId::from_raw(0x0102_0304_0506_0708).unwrap(), + kind: DataPlaneOperationKind::UdpReceive, + status: DataPlaneCompletionStatus::Error(DataPlaneErrorKind::BufferTooSmall), + }; + assert_eq!( + encode_completion(completion), + [1, 2, 3, 4, 5, 6, 7, 8, 0, 7, 0, 13] + ); + } + + #[test] + fn operation_result_records_have_stable_layouts() { + let local_addr = "192.0.2.1:1234".parse().unwrap(); + let peer_addr = "198.51.100.2:4321".parse().unwrap(); + let resource = 0x0102_0304_0506_0708; + + let resource_and_address = encode_resource_and_address(resource, local_addr); + assert_eq!(resource_and_address.len(), UDP_BIND_RESULT_LEN); + assert_eq!(&resource_and_address[..8], &resource.to_be_bytes()); + assert_eq!( + &resource_and_address[8..], + &encode_socket_address(local_addr) + ); + + let stream_addresses = encode_stream_addresses(resource, local_addr, peer_addr); + assert_eq!(stream_addresses.len(), TCP_ACCEPT_RESULT_LEN); + assert_eq!(&stream_addresses[..8], &resource.to_be_bytes()); + assert_eq!( + &stream_addresses[8..8 + SOCKET_ADDRESS_LEN], + &encode_socket_address(local_addr) + ); + assert_eq!( + &stream_addresses[8 + SOCKET_ADDRESS_LEN..], + &encode_socket_address(peer_addr) + ); + + assert_eq!(encode_tcp_read_metadata(false), [0]); + assert_eq!(encode_tcp_read_metadata(true), [1]); + + let udp_metadata = encode_udp_receive_metadata(peer_addr, true); + assert_eq!( + &udp_metadata[..SOCKET_ADDRESS_LEN], + &encode_socket_address(peer_addr) + ); + assert_eq!(udp_metadata[SOCKET_ADDRESS_LEN], 1); + } + + #[test] + fn public_address_decoder_rejects_ipv6() { + let address = "[2001:db8::1]:80".parse().unwrap(); + let error = decode_ipv4_socket_address(&encode_socket_address(address)).unwrap_err(); + assert_eq!(error.kind(), io::ErrorKind::Unsupported); + } + + #[test] + fn lifecycle_failures_use_data_plane_status_codes() { + assert_eq!( + normalize_call_status(false, -1), + error_status(DataPlaneErrorKind::HandleClosed) + ); + assert_eq!( + normalize_call_status(true, error_status(DataPlaneErrorKind::Cancelled)), + error_status(DataPlaneErrorKind::Cancelled) + ); + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/wire/dns.rs b/vendor/easytier/easytier-core/src/wasi/wire/dns.rs new file mode 100644 index 0000000..8007765 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/wire/dns.rs @@ -0,0 +1,248 @@ +use std::{io, net::IpAddr}; + +use crate::host::dns::{DnsQuery, DnsSrvRecord}; +use crate::socket::IpVersion; + +const DNS_WIRE_VERSION: u8 = 1; + +pub(crate) fn encode_query(query: &DnsQuery) -> io::Result> { + let host = query.host.as_bytes(); + let netns = query + .context + .netns + .as_ref() + .map(|netns| netns.token().as_bytes()); + let host_len = encoded_len("DNS host", host.len())?; + let netns_len = encoded_len("DNS netns token", netns.map_or(0, <[u8]>::len))?; + let mut encoded = Vec::with_capacity(16 + host.len() + netns.map_or(0, <[u8]>::len)); + encoded.push(DNS_WIRE_VERSION); + encoded.push(match query.context.ip_version { + IpVersion::V4 => 4, + IpVersion::V6 => 6, + IpVersion::Both => 0, + }); + encoded.push(u8::from(query.context.socket_mark.is_some())); + encoded.extend_from_slice(&query.context.socket_mark.unwrap_or_default().to_be_bytes()); + encoded.push(u8::from(netns.is_some())); + encoded.extend_from_slice(&netns_len.to_be_bytes()); + if let Some(netns) = netns { + encoded.extend_from_slice(netns); + } + encoded.extend_from_slice(&host_len.to_be_bytes()); + encoded.extend_from_slice(host); + Ok(encoded) +} + +pub(crate) fn decode_addresses(encoded: &[u8]) -> io::Result> { + let mut decoder = Decoder::new(encoded); + let count = decoder.take_count("DNS address count")?; + let mut addresses = Vec::with_capacity(count.min(64)); + for _ in 0..count { + let family = decoder.take_u8("DNS address family")?; + let address = match family { + 4 => IpAddr::V4(decoder.take_array::<4>("IPv4 address")?.into()), + 6 => IpAddr::V6(decoder.take_array::<16>("IPv6 address")?.into()), + _ => return Err(invalid_data("invalid DNS address family")), + }; + addresses.push(address); + } + decoder.finish()?; + Ok(addresses) +} + +pub(crate) fn decode_txt(encoded: &[u8]) -> io::Result { + let mut decoder = Decoder::new(encoded); + let length = decoder.take_count("DNS TXT length")?; + let text = decoder.take(length, "DNS TXT value")?; + decoder.finish()?; + String::from_utf8(text.to_vec()).map_err(|_| invalid_data("DNS TXT is not UTF-8")) +} + +pub(crate) fn decode_srv(encoded: &[u8]) -> io::Result> { + let mut decoder = Decoder::new(encoded); + let count = decoder.take_count("DNS SRV count")?; + let mut records = Vec::with_capacity(count.min(64)); + for _ in 0..count { + let priority = decoder.take_u16("DNS SRV priority")?; + let weight = decoder.take_u16("DNS SRV weight")?; + let port = decoder.take_u16("DNS SRV port")?; + let target_len = decoder.take_count("DNS SRV target length")?; + let target = String::from_utf8(decoder.take(target_len, "DNS SRV target")?.to_vec()) + .map_err(|_| invalid_data("DNS SRV target is not UTF-8"))?; + records.push(DnsSrvRecord { + priority, + weight, + port, + target, + }); + } + decoder.finish()?; + Ok(records) +} + +fn encoded_len(description: &str, length: usize) -> io::Result { + u32::try_from(length).map_err(|_| { + io::Error::new( + io::ErrorKind::InvalidInput, + format!("{description} is too long"), + ) + }) +} + +fn invalid_data(message: &'static str) -> io::Error { + io::Error::new(io::ErrorKind::InvalidData, message) +} + +struct Decoder<'a> { + encoded: &'a [u8], + offset: usize, +} + +impl<'a> Decoder<'a> { + fn new(encoded: &'a [u8]) -> Self { + Self { encoded, offset: 0 } + } + + fn take(&mut self, length: usize, description: &'static str) -> io::Result<&'a [u8]> { + let end = self + .offset + .checked_add(length) + .ok_or_else(|| invalid_data("DNS result length overflow"))?; + let value = self + .encoded + .get(self.offset..end) + .ok_or_else(|| invalid_data(description))?; + self.offset = end; + Ok(value) + } + + fn take_u8(&mut self, description: &'static str) -> io::Result { + Ok(self.take(1, description)?[0]) + } + + fn take_u16(&mut self, description: &'static str) -> io::Result { + Ok(u16::from_be_bytes(self.take_array::<2>(description)?)) + } + + fn take_count(&mut self, description: &'static str) -> io::Result { + usize::try_from(u32::from_be_bytes(self.take_array::<4>(description)?)) + .map_err(|_| invalid_data("DNS result count exceeds guest usize")) + } + + fn take_array(&mut self, description: &'static str) -> io::Result<[u8; N]> { + self.take(N, description)? + .try_into() + .map_err(|_| invalid_data(description)) + } + + fn finish(self) -> io::Result<()> { + if self.offset == self.encoded.len() { + Ok(()) + } else { + Err(invalid_data("DNS result has trailing bytes")) + } + } +} + +#[cfg(test)] +mod tests { + use crate::socket::{NetNamespace, SocketContext}; + + use super::*; + + #[test] + fn query_encoding_has_stable_versioned_layout() { + let query = DnsQuery::new( + "peer.example", + SocketContext { + ip_version: IpVersion::V6, + socket_mark: Some(0x01020304), + netns: Some(NetNamespace::new("netns0")), + }, + ); + let encoded = encode_query(&query).unwrap(); + + let mut expected = vec![DNS_WIRE_VERSION, 6, 1, 1, 2, 3, 4, 1]; + expected.extend_from_slice(&6_u32.to_be_bytes()); + expected.extend_from_slice(b"netns0"); + expected.extend_from_slice(&12_u32.to_be_bytes()); + expected.extend_from_slice(b"peer.example"); + assert_eq!(encoded, expected); + + let without_optional = encode_query(&DnsQuery::new( + "v4.example", + SocketContext { + ip_version: IpVersion::V4, + socket_mark: None, + netns: None, + }, + )) + .unwrap(); + assert_eq!( + &without_optional[..12], + &[1, 4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] + ); + assert_eq!(&without_optional[12..16], &10_u32.to_be_bytes()); + assert_eq!(&without_optional[16..], b"v4.example"); + } + + #[test] + fn decodes_owned_address_txt_and_srv_results() { + let mut addresses = 2_u32.to_be_bytes().to_vec(); + addresses.push(4); + addresses.extend_from_slice(&[192, 0, 2, 1]); + addresses.push(6); + addresses.extend_from_slice( + &"2001:db8::1" + .parse::() + .unwrap() + .octets(), + ); + assert_eq!( + decode_addresses(&addresses).unwrap(), + vec![ + "192.0.2.1".parse::().unwrap(), + "2001:db8::1".parse::().unwrap(), + ] + ); + + let mut txt = 12_u32.to_be_bytes().to_vec(); + txt.extend_from_slice(b"tcp://peer:1"); + assert_eq!(decode_txt(&txt).unwrap(), "tcp://peer:1"); + + let mut srv = 1_u32.to_be_bytes().to_vec(); + srv.extend_from_slice(&10_u16.to_be_bytes()); + srv.extend_from_slice(&20_u16.to_be_bytes()); + srv.extend_from_slice(&11010_u16.to_be_bytes()); + srv.extend_from_slice(&13_u32.to_be_bytes()); + srv.extend_from_slice(b"peer.example."); + assert_eq!( + decode_srv(&srv).unwrap(), + vec![DnsSrvRecord { + priority: 10, + weight: 20, + port: 11010, + target: "peer.example.".to_owned(), + }] + ); + } + + #[test] + fn rejects_malformed_results() { + assert!(decode_addresses(&[0, 0, 0]).is_err()); + assert!(decode_addresses(&[0, 0, 0, 1, 9]).is_err()); + assert!(decode_addresses(&[0, 0, 0, 0, 1]).is_err()); + + let mut invalid_txt = 1_u32.to_be_bytes().to_vec(); + invalid_txt.push(0xff); + assert!(decode_txt(&invalid_txt).is_err()); + + let mut truncated_srv = 1_u32.to_be_bytes().to_vec(); + truncated_srv.extend_from_slice(&10_u16.to_be_bytes()); + assert!(decode_srv(&truncated_srv).is_err()); + + let mut trailing_srv = 0_u32.to_be_bytes().to_vec(); + trailing_srv.push(0); + assert!(decode_srv(&trailing_srv).is_err()); + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/wire/mod.rs b/vendor/easytier/easytier-core/src/wasi/wire/mod.rs new file mode 100644 index 0000000..36cab44 --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/wire/mod.rs @@ -0,0 +1,8 @@ +//! WASI host ABI codecs shared by concrete adapters. + +pub(crate) mod common; +#[cfg(feature = "proxy-smoltcp-stack")] +pub(crate) mod data_plane; +pub(crate) mod dns; +pub(crate) mod options; +pub(crate) mod socket; diff --git a/vendor/easytier/easytier-core/src/wasi/wire/options.rs b/vendor/easytier/easytier-core/src/wasi/wire/options.rs new file mode 100644 index 0000000..1b5254a --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/wire/options.rs @@ -0,0 +1,425 @@ +use std::io; + +use crate::host::socket::{ + HostSocketHandle, + factory::{HostTcpConnectResult, HostUdpBindResult}, + listener::HostTcpBindResult, +}; +use crate::socket::{ + IpVersion, SocketContext, + tcp::{TcpConnectOptions, TcpListenOptions, TcpListenPurpose, TcpSocketPurpose}, + udp::{UdpBindOptions, UdpSocketPurpose}, +}; + +use super::socket::{SOCKET_ADDRESS_LEN, decode_socket_address, encode_socket_address}; + +const OPTIONS_VERSION: u8 = 3; +pub(crate) const TCP_SOCKET_RESULT_LEN: usize = 8 + SOCKET_ADDRESS_LEN * 2; +pub(crate) const BOUND_SOCKET_RESULT_LEN: usize = 8 + SOCKET_ADDRESS_LEN; + +pub(crate) fn encode_tcp_connect_options(options: &TcpConnectOptions) -> io::Result> { + let mut encoded = Vec::with_capacity( + 76 + context_variable_len(&options.bind.context) + + bind_device_len(&options.bind.bind_device), + ); + encoded.push(OPTIONS_VERSION); + encoded.extend_from_slice(&encode_socket_address(options.remote_addr)); + encode_optional_address(&mut encoded, options.bind.local_addr); + encode_context(&mut encoded, &options.bind.context)?; + encoded.push(match options.bind.reuse_addr { + None => 0, + Some(false) => 1, + Some(true) => 2, + }); + encoded.push(u8::from(options.bind.reuse_port)); + encoded.push(u8::from(options.bind.only_v6)); + encoded.push(match options.purpose { + TcpSocketPurpose::DirectConnect => 0, + TcpSocketPurpose::FakeTcp => 1, + TcpSocketPurpose::HolePunch => 2, + TcpSocketPurpose::ManualConnect => 3, + TcpSocketPurpose::ProxyNat => 4, + TcpSocketPurpose::StunProbe => 5, + TcpSocketPurpose::Socks5 => 6, + TcpSocketPurpose::PortForward => 7, + TcpSocketPurpose::DataPlane => 8, + }); + encoded.push(u8::from(options.bind.need_protect)); + encode_bind_device(&mut encoded, &options.bind.bind_device)?; + Ok(encoded) +} + +pub(crate) fn encode_udp_bind_options(options: &UdpBindOptions) -> io::Result> { + let mut encoded = Vec::with_capacity( + 49 + context_variable_len(&options.context) + bind_device_len(&options.bind_device), + ); + encoded.push(OPTIONS_VERSION); + encode_optional_address(&mut encoded, options.local_addr); + encode_context(&mut encoded, &options.context)?; + encoded.push(u8::from(options.reuse_addr)); + encoded.push(u8::from(options.reuse_port)); + encoded.push(u8::from(options.only_v6)); + encoded.push(match options.purpose { + UdpSocketPurpose::HolePunchControl => 0, + UdpSocketPurpose::HolePunchCandidate => 1, + UdpSocketPurpose::DirectConnect => 2, + UdpSocketPurpose::PortBoundListener => 3, + UdpSocketPurpose::ProxyNat => 4, + UdpSocketPurpose::StunProbe => 5, + UdpSocketPurpose::Socks5 => 6, + UdpSocketPurpose::PortForward => 7, + UdpSocketPurpose::PortLease => 8, + }); + encoded.push(u8::from(options.need_protect)); + encode_bind_device(&mut encoded, &options.bind_device)?; + Ok(encoded) +} + +pub(crate) fn encode_tcp_listen_options(options: &TcpListenOptions) -> io::Result> { + let mut encoded = Vec::with_capacity( + 49 + context_variable_len(&options.bind.context) + + bind_device_len(&options.bind.bind_device), + ); + encoded.push(OPTIONS_VERSION); + encode_optional_address(&mut encoded, options.bind.local_addr); + encode_context(&mut encoded, &options.bind.context)?; + encoded.push(match options.bind.reuse_addr { + None => 0, + Some(false) => 1, + Some(true) => 2, + }); + encoded.push(u8::from(options.bind.reuse_port)); + encoded.push(u8::from(options.bind.only_v6)); + encoded.push(match options.purpose { + TcpListenPurpose::DirectConnect => 0, + TcpListenPurpose::HolePunch => 1, + TcpListenPurpose::ManualConnect => 2, + TcpListenPurpose::ProxyNat => 3, + TcpListenPurpose::Socks5 => 4, + TcpListenPurpose::PortForward => 5, + TcpListenPurpose::PortLease => 6, + }); + encoded.push(u8::from(options.bind.need_protect)); + encode_bind_device(&mut encoded, &options.bind.bind_device)?; + Ok(encoded) +} + +pub(crate) fn decode_tcp_socket_result( + encoded: &[u8; TCP_SOCKET_RESULT_LEN], +) -> io::Result { + let local = <[u8; SOCKET_ADDRESS_LEN]>::try_from(&encoded[8..8 + SOCKET_ADDRESS_LEN]).unwrap(); + let peer = <[u8; SOCKET_ADDRESS_LEN]>::try_from(&encoded[8 + SOCKET_ADDRESS_LEN..]).unwrap(); + Ok(HostTcpConnectResult { + handle: HostSocketHandle(u64::from_be_bytes(encoded[..8].try_into().unwrap())), + local_addr: decode_socket_address(&local)?, + peer_addr: decode_socket_address(&peer)?, + transport_label: None, + }) +} + +pub(crate) fn decode_udp_bind_result( + encoded: &[u8; BOUND_SOCKET_RESULT_LEN], +) -> io::Result { + Ok(HostUdpBindResult { + handle: decode_bound_handle(encoded), + local_addr: decode_bound_address(encoded)?, + }) +} + +pub(crate) fn decode_tcp_bind_result( + encoded: &[u8; BOUND_SOCKET_RESULT_LEN], +) -> io::Result { + Ok(HostTcpBindResult { + handle: decode_bound_handle(encoded), + local_addr: decode_bound_address(encoded)?, + }) +} + +fn decode_bound_handle(encoded: &[u8; BOUND_SOCKET_RESULT_LEN]) -> HostSocketHandle { + HostSocketHandle(u64::from_be_bytes(encoded[..8].try_into().unwrap())) +} + +fn decode_bound_address( + encoded: &[u8; BOUND_SOCKET_RESULT_LEN], +) -> io::Result { + let address = <[u8; SOCKET_ADDRESS_LEN]>::try_from(&encoded[8..]).unwrap(); + decode_socket_address(&address) +} + +fn encode_optional_address(encoded: &mut Vec, address: Option) { + encoded.extend_from_slice( + &address + .map(encode_socket_address) + .unwrap_or([0; SOCKET_ADDRESS_LEN]), + ); +} + +fn encode_mark(encoded: &mut Vec, mark: Option) { + encoded.push(u8::from(mark.is_some())); + encoded.extend_from_slice(&mark.unwrap_or_default().to_be_bytes()); +} + +fn encode_context(encoded: &mut Vec, context: &SocketContext) -> io::Result<()> { + encoded.push(match context.ip_version { + IpVersion::V4 => 0, + IpVersion::V6 => 1, + IpVersion::Both => 2, + }); + encode_mark(encoded, context.socket_mark); + let netns = context.netns.as_ref().map(|netns| netns.token().as_bytes()); + encoded.push(u8::from(netns.is_some())); + let length = u32::try_from(netns.map_or(0, <[u8]>::len)) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "netns token is too long"))?; + encoded.extend_from_slice(&length.to_be_bytes()); + if let Some(netns) = netns { + encoded.extend_from_slice(netns); + } + Ok(()) +} + +pub(crate) fn encode_socket_context(context: &SocketContext) -> io::Result> { + let mut encoded = Vec::with_capacity(11 + context_variable_len(context)); + encode_context(&mut encoded, context)?; + Ok(encoded) +} + +fn encode_bind_device(encoded: &mut Vec, device: &Option) -> io::Result<()> { + let bytes = device.as_deref().unwrap_or_default().as_bytes(); + encoded.push(u8::from(device.is_some())); + let length = u32::try_from(bytes.len()) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "bind device is too long"))?; + encoded.extend_from_slice(&length.to_be_bytes()); + encoded.extend_from_slice(bytes); + Ok(()) +} + +fn bind_device_len(device: &Option) -> usize { + device.as_ref().map_or(0, String::len) +} + +fn context_variable_len(context: &SocketContext) -> usize { + context + .netns + .as_ref() + .map_or(0, |netns| netns.token().len()) +} + +#[cfg(test)] +mod tests { + use crate::socket::{NetNamespace, tcp::TcpBindOptions}; + + use super::*; + + #[test] + fn encodes_tcp_connect_options_with_stable_offsets() { + let options = TcpConnectOptions { + remote_addr: "192.0.2.2:11013".parse().unwrap(), + bind: TcpBindOptions::default() + .with_local_addr(Some("[2001:db8::1]:22026".parse().unwrap())) + .with_socket_mark(Some(0x01020304)) + .with_bind_device(Some("device0".to_owned())) + .with_reuse_addr(true) + .with_reuse_port(true) + .with_only_v6(true), + purpose: TcpSocketPurpose::ManualConnect, + }; + let encoded = encode_tcp_connect_options(&options).unwrap(); + assert_eq!(encoded.len(), 83); + assert_eq!(encoded[0], OPTIONS_VERSION); + assert_eq!(&encoded[55..66], &[2, 1, 1, 2, 3, 4, 0, 0, 0, 0, 0]); + assert_eq!(&encoded[66..71], &[2, 1, 1, 3, 1]); + assert_eq!(encoded[71], 1); + assert_eq!(&encoded[72..76], &7_u32.to_be_bytes()); + assert_eq!(&encoded[76..], b"device0"); + } + + #[test] + fn bind_device_presence_distinguishes_none_empty_and_named() { + let remote = "192.0.2.2:11013".parse().unwrap(); + let none = encode_tcp_connect_options(&TcpConnectOptions::direct_connect(remote)).unwrap(); + let empty = encode_tcp_connect_options( + &TcpConnectOptions::direct_connect(remote) + .with_bind(TcpBindOptions::default().with_bind_device(Some(String::new()))), + ) + .unwrap(); + assert_eq!(&none[71..76], &[0, 0, 0, 0, 0]); + assert_eq!(&empty[71..76], &[1, 0, 0, 0, 0]); + + let udp_none = encode_udp_bind_options(&UdpBindOptions::direct_connect()).unwrap(); + let udp_empty = encode_udp_bind_options( + &UdpBindOptions::direct_connect().with_bind_device(Some(String::new())), + ) + .unwrap(); + assert_eq!(&udp_none[44..49], &[0, 0, 0, 0, 0]); + assert_eq!(&udp_empty[44..49], &[1, 0, 0, 0, 0]); + + let listen_none = encode_tcp_listen_options(&TcpListenOptions::direct_connect( + "192.0.2.1:11013".parse().unwrap(), + )) + .unwrap(); + let listen_empty = encode_tcp_listen_options( + &TcpListenOptions::direct_connect("192.0.2.1:11013".parse().unwrap()) + .with_bind(TcpBindOptions::default().with_bind_device(Some(String::new()))), + ) + .unwrap(); + assert_eq!(&listen_none[44..49], &[0, 0, 0, 0, 0]); + assert_eq!(&listen_empty[44..49], &[1, 0, 0, 0, 0]); + } + + #[test] + fn encodes_socket_context_netns_and_zero_mark() { + let bind = TcpBindOptions::default().with_context( + SocketContext::default() + .with_ip_version(IpVersion::V6) + .with_socket_mark(Some(0)) + .with_netns(Some(NetNamespace::new("instance-a"))), + ); + let encoded = encode_tcp_connect_options( + &TcpConnectOptions::direct_connect("[2001:db8::2]:11013".parse().unwrap()) + .with_bind(bind), + ) + .unwrap(); + + assert_eq!(encoded[55], 1); + assert_eq!(&encoded[56..61], &[1, 0, 0, 0, 0]); + assert_eq!(encoded[61], 1); + assert_eq!(&encoded[62..66], &10_u32.to_be_bytes()); + assert_eq!(&encoded[66..76], b"instance-a"); + } + + #[test] + fn encodes_standalone_socket_context() { + let context = SocketContext::default().with_ip_version(IpVersion::V6); + + assert_eq!( + encode_socket_context(&context).unwrap(), + vec![1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] + ); + } + + #[test] + fn encodes_udp_proxy_nat_purpose() { + let encoded = encode_udp_bind_options(&UdpBindOptions::proxy_nat()).unwrap(); + assert_eq!(encoded[42], 4); + } + + #[test] + fn encodes_udp_socks5_purpose() { + let encoded = encode_udp_bind_options(&UdpBindOptions::socks5()).unwrap(); + assert_eq!(encoded[42], 6); + } + + #[test] + fn encodes_tcp_proxy_nat_purposes() { + let remote = "192.0.2.2:11013".parse().unwrap(); + let connect = encode_tcp_connect_options(&TcpConnectOptions::proxy_nat(remote)).unwrap(); + assert_eq!(connect[69], 4); + + let local = "0.0.0.0:0".parse().unwrap(); + let listen = encode_tcp_listen_options(&TcpListenOptions::proxy_nat(local)).unwrap(); + assert_eq!(listen[42], 3); + } + + #[test] + fn encodes_stun_probe_purposes() { + let remote = "192.0.2.2:3478".parse().unwrap(); + let local = "0.0.0.0:0".parse().unwrap(); + let tcp = + encode_tcp_connect_options(&TcpConnectOptions::stun_probe(remote, local)).unwrap(); + assert_eq!(tcp[69], 5); + + let udp = encode_udp_bind_options(&UdpBindOptions::stun_probe()).unwrap(); + assert_eq!(udp[42], 5); + } + + #[test] + fn encodes_socket_protection_request_in_existing_options() { + let remote = "192.0.2.2:11013".parse().unwrap(); + let local = "0.0.0.0:11013".parse().unwrap(); + + let tcp_true = + encode_tcp_connect_options(&TcpConnectOptions::direct_connect(remote)).unwrap(); + let tcp_false = encode_tcp_connect_options( + &TcpConnectOptions::direct_connect(remote) + .with_bind(TcpBindOptions::default().with_need_protect(false)), + ) + .unwrap(); + assert_eq!(tcp_true[70], 1); + assert_eq!(tcp_false[70], 0); + + let listen_true = + encode_tcp_listen_options(&TcpListenOptions::direct_connect(local)).unwrap(); + let listen_false = encode_tcp_listen_options(&TcpListenOptions::proxy_nat(local)).unwrap(); + assert_eq!(listen_true[43], 1); + assert_eq!(listen_false[43], 0); + + let udp_true = encode_udp_bind_options(&UdpBindOptions::direct_connect()).unwrap(); + let udp_false = + encode_udp_bind_options(&UdpBindOptions::socks5().with_need_protect(false)).unwrap(); + assert_eq!(udp_true[43], 1); + assert_eq!(udp_false[43], 0); + } + + #[test] + fn encodes_gateway_purposes_with_stable_values() { + let remote = "192.0.2.2:443".parse().unwrap(); + assert_eq!( + encode_tcp_connect_options(&TcpConnectOptions::socks5(remote)).unwrap()[69], + 6 + ); + assert_eq!( + encode_tcp_connect_options(&TcpConnectOptions::port_forward(remote)).unwrap()[69], + 7 + ); + assert_eq!( + encode_tcp_connect_options(&TcpConnectOptions::data_plane(remote)).unwrap()[69], + 8 + ); + + let local = "0.0.0.0:0".parse().unwrap(); + assert_eq!( + encode_tcp_listen_options(&TcpListenOptions::socks5(local)).unwrap()[42], + 4 + ); + assert_eq!( + encode_tcp_listen_options(&TcpListenOptions::port_forward(local)).unwrap()[42], + 5 + ); + assert_eq!( + encode_tcp_listen_options(&TcpListenOptions::port_lease(local)).unwrap()[42], + 6 + ); + assert_eq!( + encode_udp_bind_options(&UdpBindOptions::port_forward(local)).unwrap()[42], + 7 + ); + assert_eq!( + encode_udp_bind_options(&UdpBindOptions::port_lease(local)).unwrap()[42], + 8 + ); + } + + #[test] + fn decodes_fixed_socket_results() { + let mut tcp = [0_u8; TCP_SOCKET_RESULT_LEN]; + tcp[..8].copy_from_slice(&41_u64.to_be_bytes()); + tcp[8..35].copy_from_slice(&encode_socket_address("192.0.2.1:40100".parse().unwrap())); + tcp[35..].copy_from_slice(&encode_socket_address("192.0.2.2:11013".parse().unwrap())); + let result = decode_tcp_socket_result(&tcp).unwrap(); + assert_eq!(result.handle, HostSocketHandle(41)); + assert_eq!(result.local_addr, "192.0.2.1:40100".parse().unwrap()); + assert_eq!(result.peer_addr, "192.0.2.2:11013".parse().unwrap()); + + let mut bound = [0_u8; BOUND_SOCKET_RESULT_LEN]; + bound[..8].copy_from_slice(&42_u64.to_be_bytes()); + bound[8..].copy_from_slice(&encode_socket_address("[::]:22026".parse().unwrap())); + assert_eq!( + decode_udp_bind_result(&bound).unwrap().handle, + HostSocketHandle(42) + ); + assert_eq!( + decode_tcp_bind_result(&bound).unwrap().local_addr, + "[::]:22026".parse().unwrap() + ); + } +} diff --git a/vendor/easytier/easytier-core/src/wasi/wire/socket.rs b/vendor/easytier/easytier-core/src/wasi/wire/socket.rs new file mode 100644 index 0000000..e05201e --- /dev/null +++ b/vendor/easytier/easytier-core/src/wasi/wire/socket.rs @@ -0,0 +1,207 @@ +use std::{ + io, + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6}, +}; + +pub(crate) const SOCKET_ADDRESS_LEN: usize = 27; +pub(crate) const UDP_METADATA_LEN: usize = 48; + +const V4_FAMILY: u8 = 4; +const V6_FAMILY: u8 = 6; +const ADDRESS_FAMILY: usize = 0; +const ADDRESS_BYTES: std::ops::Range = 1..17; +const PORT_BYTES: std::ops::Range = 17..19; +const FLOWINFO_BYTES: std::ops::Range = 19..23; +const SCOPE_ID_BYTES: std::ops::Range = 23..27; +const OPTIONAL_IP_FAMILY: usize = 27; +const OPTIONAL_IP_BYTES: std::ops::Range = 28..44; +const OPTIONAL_IFINDEX_BYTES: std::ops::Range = 44..48; + +pub(crate) fn encode_udp_metadata( + peer_addr: SocketAddr, + optional_ip: Option, + optional_ifindex: Option, +) -> [u8; UDP_METADATA_LEN] { + let mut wire = [0_u8; UDP_METADATA_LEN]; + wire[..SOCKET_ADDRESS_LEN].copy_from_slice(&encode_socket_address(peer_addr)); + + match optional_ip { + None => {} + Some(IpAddr::V4(ip)) => { + wire[OPTIONAL_IP_FAMILY] = V4_FAMILY; + wire[OPTIONAL_IP_BYTES.start..OPTIONAL_IP_BYTES.start + 4] + .copy_from_slice(&ip.octets()); + } + Some(IpAddr::V6(ip)) => { + wire[OPTIONAL_IP_FAMILY] = V6_FAMILY; + wire[OPTIONAL_IP_BYTES].copy_from_slice(&ip.octets()); + } + } + if let Some(ifindex) = optional_ifindex { + wire[OPTIONAL_IFINDEX_BYTES].copy_from_slice(&ifindex.to_be_bytes()); + } + wire +} + +pub(crate) fn encode_socket_address(addr: SocketAddr) -> [u8; SOCKET_ADDRESS_LEN] { + let mut wire = [0_u8; SOCKET_ADDRESS_LEN]; + match addr { + SocketAddr::V4(addr) => { + wire[ADDRESS_FAMILY] = V4_FAMILY; + wire[ADDRESS_BYTES.start..ADDRESS_BYTES.start + 4].copy_from_slice(&addr.ip().octets()); + wire[PORT_BYTES].copy_from_slice(&addr.port().to_be_bytes()); + } + SocketAddr::V6(addr) => { + wire[ADDRESS_FAMILY] = V6_FAMILY; + wire[ADDRESS_BYTES].copy_from_slice(&addr.ip().octets()); + wire[PORT_BYTES].copy_from_slice(&addr.port().to_be_bytes()); + wire[FLOWINFO_BYTES].copy_from_slice(&addr.flowinfo().to_be_bytes()); + wire[SCOPE_ID_BYTES].copy_from_slice(&addr.scope_id().to_be_bytes()); + } + } + wire +} + +pub(crate) fn decode_udp_metadata( + wire: &[u8; UDP_METADATA_LEN], +) -> io::Result<(SocketAddr, Option, Option)> { + let address = <[u8; SOCKET_ADDRESS_LEN]>::try_from(&wire[..SOCKET_ADDRESS_LEN]).unwrap(); + let peer_addr = decode_socket_address(&address)?; + + let optional_ip = match wire[OPTIONAL_IP_FAMILY] { + 0 => { + require_zero(&wire[OPTIONAL_IP_BYTES], "absent optional IP")?; + require_zero( + &wire[OPTIONAL_IFINDEX_BYTES], + "absent optional IP interface index", + )?; + None + } + V4_FAMILY => { + require_zero( + &wire[OPTIONAL_IP_BYTES.start + 4..OPTIONAL_IP_BYTES.end], + "optional IPv4 padding", + )?; + require_zero( + &wire[OPTIONAL_IFINDEX_BYTES], + "optional IPv4 interface index", + )?; + Some(IpAddr::V4(Ipv4Addr::from( + <[u8; 4]>::try_from(&wire[OPTIONAL_IP_BYTES.start..OPTIONAL_IP_BYTES.start + 4]) + .unwrap(), + ))) + } + V6_FAMILY => Some(IpAddr::V6(Ipv6Addr::from( + <[u8; 16]>::try_from(&wire[OPTIONAL_IP_BYTES]).unwrap(), + ))), + family => return Err(invalid_family("optional IP", family)), + }; + let optional_ifindex = + match u32::from_be_bytes(wire[OPTIONAL_IFINDEX_BYTES].try_into().unwrap()) { + 0 => None, + ifindex => Some(ifindex), + }; + Ok((peer_addr, optional_ip, optional_ifindex)) +} + +pub(crate) fn decode_socket_address(wire: &[u8; SOCKET_ADDRESS_LEN]) -> io::Result { + let port = u16::from_be_bytes(wire[PORT_BYTES].try_into().unwrap()); + match wire[ADDRESS_FAMILY] { + V4_FAMILY => { + require_zero( + &wire[ADDRESS_BYTES.start + 4..ADDRESS_BYTES.end], + "IPv4 padding", + )?; + require_zero(&wire[FLOWINFO_BYTES], "IPv4 flowinfo")?; + require_zero(&wire[SCOPE_ID_BYTES], "IPv4 scope ID")?; + Ok(SocketAddr::V4(SocketAddrV4::new( + Ipv4Addr::from( + <[u8; 4]>::try_from(&wire[ADDRESS_BYTES.start..ADDRESS_BYTES.start + 4]) + .unwrap(), + ), + port, + ))) + } + V6_FAMILY => Ok(SocketAddr::V6(SocketAddrV6::new( + Ipv6Addr::from(<[u8; 16]>::try_from(&wire[ADDRESS_BYTES]).unwrap()), + port, + u32::from_be_bytes(wire[FLOWINFO_BYTES].try_into().unwrap()), + u32::from_be_bytes(wire[SCOPE_ID_BYTES].try_into().unwrap()), + ))), + family => Err(invalid_family("peer address", family)), + } +} + +fn require_zero(bytes: &[u8], field: &str) -> io::Result<()> { + if bytes.iter().all(|byte| *byte == 0) { + Ok(()) + } else { + Err(io::Error::new( + io::ErrorKind::InvalidData, + format!("host UDP metadata has nonzero {field}"), + )) + } +} + +fn invalid_family(field: &str, family: u8) -> io::Error { + io::Error::new( + io::ErrorKind::InvalidData, + format!("host UDP metadata has invalid {field} family {family}"), + ) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn round_trips_ipv4_address_and_optional_source() { + let peer = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(192, 0, 2, 1), 11013)); + let source = Some(IpAddr::V4(Ipv4Addr::new(198, 51, 100, 2))); + let expected = [ + 0x04, 0xc0, 0x00, 0x02, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x2b, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x04, + 0xc6, 0x33, 0x64, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + ]; + assert_eq!(encode_udp_metadata(peer, source, None), expected); + assert_eq!( + decode_udp_metadata(&expected).unwrap(), + (peer, source, None) + ); + } + + #[test] + fn round_trips_ipv6_flow_scope_and_optional_destination() { + let peer = SocketAddr::V6(SocketAddrV6::new( + "2001:db8::1".parse().unwrap(), + 22026, + 7, + 11, + )); + let destination = Some(IpAddr::V6("2001:db8::2".parse().unwrap())); + assert_eq!( + decode_udp_metadata(&encode_udp_metadata(peer, destination, Some(17))).unwrap(), + (peer, destination, Some(17)) + ); + } + + #[test] + fn rejects_noncanonical_or_unknown_families() { + let mut wire = encode_udp_metadata("192.0.2.1:11013".parse().unwrap(), None, None); + wire[ADDRESS_BYTES.start + 4] = 1; + assert!(decode_udp_metadata(&wire).is_err()); + + wire = encode_udp_metadata("192.0.2.1:11013".parse().unwrap(), None, None); + wire[OPTIONAL_IP_FAMILY] = 9; + assert!(decode_udp_metadata(&wire).is_err()); + + wire = encode_udp_metadata( + "192.0.2.1:11013".parse().unwrap(), + Some("192.0.2.2".parse().unwrap()), + None, + ); + wire[OPTIONAL_IFINDEX_BYTES.end - 1] = 1; + assert!(decode_udp_metadata(&wire).is_err()); + } +} diff --git a/vendor/easytier/easytier-core/testdata/wasi_core_instance_create.json b/vendor/easytier/easytier-core/testdata/wasi_core_instance_create.json new file mode 100644 index 0000000..e1806b4 --- /dev/null +++ b/vendor/easytier/easytier-core/testdata/wasi_core_instance_create.json @@ -0,0 +1,14 @@ +{ + "version": 14, + "config": "instance_id = \"018f4fb1-7a2c-7d1f-9d89-935b0ad7e135\"\ninstance_name = \"wasi-core\"\n\n[network_identity]\nnetwork_name = \"default\"\nnetwork_secret = \"test\"\n\n[flags]\ndisable_p2p = true\nenable_encryption = false\nbind_device = false\n", + "environment": { + "public_ipv4": null, + "interface_ipv4s": [], + "public_ipv6": null, + "interface_ipv6s": [], + "mapped_listeners": [], + "local_ips": [], + "protected_tcp_ports": [], + "preferred_ipv6_sources": [] + } +} diff --git a/vendor/easytier/easytier-core/tests/feature_profiles.rs b/vendor/easytier/easytier-core/tests/feature_profiles.rs new file mode 100644 index 0000000..718670f --- /dev/null +++ b/vendor/easytier/easytier-core/tests/feature_profiles.rs @@ -0,0 +1,21 @@ +#![cfg(all( + feature = "test-utils", + feature = "proxy-cidr-monitor", + not(feature = "wrapped-transport") +))] + +use easytier_core::{config::toml::TomlConfig, instance::CoreInstanceConfig}; + +#[test] +fn manual_routes_require_cidr_monitor_not_wrapped_transport() { + let toml = TomlConfig::new_from_str( + r#" + instance_name = "manual-routes-cidr-monitor" + routes = ["192.0.2.0/24"] + "#, + ) + .unwrap(); + let config = CoreInstanceConfig::from_toml(&toml).unwrap(); + + config.validate_build_capabilities_for_test().unwrap(); +} diff --git a/vendor/easytier/easytier-proto/Cargo.toml b/vendor/easytier/easytier-proto/Cargo.toml new file mode 100644 index 0000000..7f08082 --- /dev/null +++ b/vendor/easytier/easytier-proto/Cargo.toml @@ -0,0 +1,117 @@ +[package] +name = "easytier-proto" +description = "EasyTier protobuf and generated RPC types." +homepage = "https://github.com/EasyTier/EasyTier" +repository = "https://github.com/EasyTier/EasyTier" +version = "2.7.0" +edition.workspace = true +rust-version.workspace = true +authors = ["kkrainbow"] +keywords = ["vpn", "p2p", "network", "easytier"] +categories = ["network-programming"] +license-file = "../LICENSE" +build = "build/main.rs" + +[dependencies] +anyhow = { workspace = true, optional = true } +async-trait = { workspace = true, optional = true } +auto_impl = { workspace = true, optional = true } +base64 = { workspace = true, optional = true } +bytes = { workspace = true, optional = true } +chrono = { workspace = true, features = ["serde"], optional = true } +cidr = { workspace = true, features = ["serde"], optional = true } +hmac = { workspace = true, optional = true } +prost = { workspace = true, optional = true } +prost-types = { workspace = true, optional = true } +prost-wkt-types = { version = "0.7.2", optional = true } +pbjson = { version = "0.9.0", optional = true } +serde = { workspace = true, features = ["derive"], optional = true } +serde_json = { workspace = true, optional = true } +sha2 = { workspace = true, optional = true } +thiserror = { workspace = true, optional = true } +tokio = { workspace = true, features = ["time"], optional = true } +url = { workspace = true, features = ["serde"], optional = true } +uuid = { workspace = true, features = ["serde"], optional = true } +x25519-dalek = { workspace = true, features = ["static_secrets"], optional = true } + +[build-dependencies] +indoc.workspace = true +pbjson-build = "0.9.0" +proc-macro2 = "1" +prost-build = "0.14.4" +quote = "1" + +[target.'cfg(windows)'.build-dependencies] +reqwest = { workspace = true, default-features = true, features = ["blocking"] } +zip = "8.6.0" + +[dev-dependencies] +tokio = { workspace = true, features = [ + "macros", + "rt", +] } +uuid = { workspace = true, features = [ + "v4", + "fast-rng", +] } + +[features] +default = ["full"] +full = [ + "api", + "core", + "faketcp", + "magic-dns", + "quic", + "utils", + "websocket", + "wireguard", + "zstd", + "json-rpc", +] +api = ["core"] +core = [ + "dep:anyhow", + "dep:async-trait", + "dep:auto_impl", + "dep:base64", + "dep:bytes", + "dep:chrono", + "dep:cidr", + "dep:hmac", + "dep:pbjson", + "dep:prost", + "dep:prost-types", + "dep:serde", + "dep:serde_json", + "dep:sha2", + "dep:thiserror", + "dep:tokio", + "dep:url", + "dep:uuid", + "dep:x25519-dalek", +] +faketcp = [] +magic-dns = [] +quic = [] +utils = [] +websocket = [] +wireguard = [] +zstd = [] +json-rpc = ["dep:prost-wkt-types"] + +[package.metadata.cargo-machete] +ignored = [ + # Used by build/main.rs and build/rpc.rs, including the Windows protoc download. + "indoc", + "pbjson-build", + "proc-macro2", + "prost-build", + "quote", + "reqwest", + "zip", + # Referenced by generated protobuf, serde and RPC code. + "auto_impl", + "pbjson", + "serde", +] diff --git a/vendor/easytier/easytier-proto/proto/acl.proto b/vendor/easytier/easytier-proto/proto/acl.proto new file mode 100644 index 0000000..f8ea02e --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/acl.proto @@ -0,0 +1,144 @@ +syntax = "proto3"; + +import "common.proto"; + +package acl; + +// Enhanced protocol enum with more granular options +enum Protocol { + Unspecified = 0; + TCP = 1; + UDP = 2; + ICMP = 3; + ICMPv6 = 4; + Any = 5; +} + +enum Action { + Noop = 0; + Allow = 1; + Drop = 2; // Silent drop (no response) +} + +enum ChainType { + UnspecifiedChain = 0; + // send to this node + Inbound = 1; + // send from this node + Outbound = 2; + // subnet proxy + Forward = 3; +} + +// Time-based access control +message TimeWindow { + // Days of week: 0=Sunday, 1=Monday, ..., 6=Saturday + repeated uint32 days_of_week = 1; + // Time in minutes from midnight (0-1439) + uint32 start_time = 2; + uint32 end_time = 3; + // Timezone offset in minutes from UTC + int32 timezone_offset = 4; +} + +// Enhanced rule with priority and metadata +message Rule { + // Rule identification and metadata + string name = 1; // Human-readable rule name + string description = 2; // Rule description + uint32 priority = 3; // Higher number = higher priority (0-65535) + bool enabled = 4; // Rule enabled/disabled state + + // Core matching criteria + Protocol protocol = 5; + repeated string ports = 6; + repeated string source_ips = 7; // Source IP ranges + repeated string destination_ips = 8; // Destination IP ranges + + // Enhanced matching criteria + repeated string source_ports = 9; // Source port range + + // Action and logging + Action action = 10; + + // Rate limiting (packets per second) + uint32 rate_limit = 11; // 0 = no limit + uint32 burst_limit = 12; // Burst allowance + + // Connection tracking + bool stateful = 13; // Enable connection tracking + + // Group matching criteria + repeated string source_groups = 14; + repeated string destination_groups = 15; +} + +// Rule chain with metadata and optimization hints +message Chain { + // Chain identification + string name = 1; // Human-readable chain name + ChainType chain_type = 2; + string description = 3; // Chain description + bool enabled = 4; // Chain enabled/disabled state + + // Rules in priority order (highest priority first) + repeated Rule rules = 5; + + // Default action when no rules match + Action default_action = 6; +} + +message GroupInfo { + repeated GroupIdentity declares = 1; + repeated string members = 2; +} + +message GroupIdentity { + string group_name = 1; + string group_secret = 2; +} + +message AclV1 { + repeated Chain chains = 1; + GroupInfo group = 2; +} + +enum ConnState { + New = 0; + Established = 1; + Related = 2; + Invalid = 3; +} + +// Connection tracking entry for stateful ACLs +message ConnTrackEntry { + common.SocketAddr src_addr = 1; + common.SocketAddr dst_addr = 2; + Protocol protocol = 3; // IP protocol number (e.g., 6 = TCP, 17 = UDP) + ConnState state = 4; + uint64 created_at = 5; // Unix timestamp (seconds) + uint64 last_seen = 6; // Unix timestamp (seconds) + uint64 packet_count = 7; + uint64 byte_count = 8; +} + +// Top-level ACL configuration +message Acl { + AclV1 acl_v1 = 2; +} + +message StatItem { + uint64 packet_count = 1; + uint64 byte_count = 2; +} + +message RuleStats { + Rule rule = 1; + StatItem stat = 2; +} + +message AclStats { + repeated RuleStats rules = 1; + repeated ConnTrackEntry conn_track = 2; + map global = 3; +} diff --git a/vendor/easytier/easytier-proto/proto/api_config.proto b/vendor/easytier/easytier-proto/proto/api_config.proto new file mode 100644 index 0000000..ae299b7 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/api_config.proto @@ -0,0 +1,97 @@ +syntax = "proto3"; + +import "common.proto"; +import "acl.proto"; +import "api_instance.proto"; +import "api_manage.proto"; + +package api.config; + +enum ConfigPatchAction { + ADD = 0; + REMOVE = 1; + CLEAR = 2; +} + +message InstanceConfigPatch { + optional string hostname = 1; + optional common.Ipv4Inet ipv4 = 2; + optional common.Ipv6Inet ipv6 = 3; + repeated PortForwardPatch port_forwards = 4; + optional AclPatch acl = 5; + repeated ProxyNetworkPatch proxy_networks = 6; + repeated RoutePatch routes = 7; + repeated ExitNodePatch exit_nodes = 8; + repeated UrlPatch mapped_listeners = 9; + repeated UrlPatch connectors = 10; + optional bool ipv6_public_addr_provider = 11; + optional bool ipv6_public_addr_auto = 12; + optional string ipv6_public_addr_prefix = 13; + optional bool disable_relay_data = 14; + repeated VpnPortalClientPatch vpn_portal_clients = 15; + api.manage.ManagedCredentialSet managed_credentials = 16; + optional bool prefer_peer_relay = 17; +} + +message VpnPortalClientPatch { + ConfigPatchAction action = 1; + api.manage.VpnPortalClientConfig client = 2; +} + +message PortForwardPatch { + ConfigPatchAction action = 1; + common.PortForwardConfigPb cfg = 2; +} + +message StringPatch { + ConfigPatchAction action = 1; + string value = 2; +} + +message UrlPatch { + ConfigPatchAction action = 1; + common.Url url = 2; +} + +message AclPatch { + optional acl.Acl acl = 1; + repeated StringPatch tcp_whitelist = 2; + repeated StringPatch udp_whitelist = 3; +} + +message ProxyNetworkPatch { + ConfigPatchAction action = 1; + common.Ipv4Inet cidr = 2; + optional common.Ipv4Inet mapped_cidr = 3; +} + +message RoutePatch { + ConfigPatchAction action = 1; + common.Ipv4Inet cidr = 2; +} + +message ExitNodePatch { + ConfigPatchAction action = 1; + common.IpAddr node = 2; +} + +message PatchConfigRequest { + InstanceConfigPatch patch = 1; + api.instance.InstanceIdentifier instance = 2; +} + +message PatchConfigResponse {} + +message GetConfigRequest { + api.instance.InstanceIdentifier instance = 1; +} + +message GetConfigResponse { + api.manage.NetworkConfig config = 1; + string toml_config = 2; +} + +service ConfigRpc { + rpc PatchConfig(PatchConfigRequest) returns (PatchConfigResponse); + rpc GetConfig(GetConfigRequest) returns (GetConfigResponse); +} diff --git a/vendor/easytier/easytier-proto/proto/api_instance.proto b/vendor/easytier/easytier-proto/proto/api_instance.proto new file mode 100644 index 0000000..823e632 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/api_instance.proto @@ -0,0 +1,420 @@ +syntax = "proto3"; + +import "common.proto"; +import "peer_rpc.proto"; +import "acl.proto"; + +package api.instance; + +message InstanceIdentifier { + message InstanceSelector { optional string name = 1; } + + oneof selector { + common.UUID id = 1; + InstanceSelector instance_selector = 2; + } +} + +message Status { + int32 code = 1; + string message = 2; +} + +message PeerConnStats { + uint64 rx_bytes = 1; + uint64 tx_bytes = 2; + + uint64 rx_packets = 3; + uint64 tx_packets = 4; + + uint64 latency_us = 5; +} + +message PeerConnInfo { + string conn_id = 1; + uint32 my_peer_id = 2; + uint32 peer_id = 3; + repeated string features = 4; + common.TunnelInfo tunnel = 5; + PeerConnStats stats = 6; + float loss_rate = 7; + bool is_client = 8; + string network_name = 9; + bool is_closed = 10; + bytes noise_local_static_pubkey = 11; + bytes noise_remote_static_pubkey = 12; + peer_rpc.SecureAuthLevel secure_auth_level = 13; + peer_rpc.PeerIdentityType peer_identity_type = 14; +} + +message PeerInfo { + uint32 peer_id = 1; + repeated PeerConnInfo conns = 2; + common.UUID default_conn_id = 3; + repeated common.UUID directly_connected_conns = 4; +} + +message ListPeerRequest { InstanceIdentifier instance = 1; } + +message ListPeerResponse { + repeated PeerInfo peer_infos = 1; + NodeInfo my_info = 2; +} + +message Route { + uint32 peer_id = 1; + common.Ipv4Inet ipv4_addr = 2; + + uint32 next_hop_peer_id = 3; + int32 cost = 4; + int32 path_latency = 11; + + repeated string proxy_cidrs = 5; + string hostname = 6; + common.StunInfo stun_info = 7; + string inst_id = 8; + string version = 9; + common.PeerFeatureFlag feature_flag = 10; + + optional uint32 next_hop_peer_id_latency_first = 12; + optional int32 cost_latency_first = 13; + optional int32 path_latency_latency_first = 14; + + common.Ipv6Inet ipv6_addr = 15; + common.Ipv6Inet public_ipv6_addr = 16; + common.Ipv6Inet ipv6_public_addr_prefix = 17; +} + +message PeerRoutePair { + Route route = 1; + PeerInfo peer = 2; +} + +message NodeInfo { + uint32 peer_id = 1; + string ipv4_addr = 2; + repeated string proxy_cidrs = 3; + string hostname = 4; + common.StunInfo stun_info = 5; + string inst_id = 6; + repeated string listeners = 7; + string config = 8; + string version = 9; + common.PeerFeatureFlag feature_flag = 10; + peer_rpc.GetIpListResponse ip_list = 11; + common.Ipv6Inet public_ipv6_addr = 12; + common.Ipv6Inet ipv6_public_addr_prefix = 13; +} + +message ShowNodeInfoRequest { InstanceIdentifier instance = 1; } + +message ShowNodeInfoResponse { NodeInfo node_info = 1; } + +message PublicIpv6LeaseInfo { + uint32 peer_id = 1; + string inst_id = 2; + common.Ipv6Inet leased_addr = 3; + int64 valid_until_unix_seconds = 4; + bool reused = 5; +} + +message ListPublicIpv6InfoRequest { InstanceIdentifier instance = 1; } + +message ListPublicIpv6InfoResponse { + common.Ipv6Inet provider_prefix = 1; + repeated PublicIpv6LeaseInfo provider_leases = 2; +} + +message ListRouteRequest { InstanceIdentifier instance = 1; } + +message ListRouteResponse { repeated Route routes = 1; } + +message DumpRouteRequest { InstanceIdentifier instance = 1; } + +message DumpRouteResponse { string result = 1; } + +message ListForeignNetworkRequest { + InstanceIdentifier instance = 1; + bool include_trusted_keys = 2; +} + +enum TrustedKeySourcePb { + TRUSTED_KEY_SOURCE_PB_UNSPECIFIED = 0; + TRUSTED_KEY_SOURCE_PB_OSPF_NODE = 1; + TRUSTED_KEY_SOURCE_PB_OSPF_CREDENTIAL = 2; +} + +message TrustedKeyInfoPb { + bytes pubkey = 1; + TrustedKeySourcePb source = 2; + optional int64 expiry_unix = 3; +} + +message ForeignNetworkEntryPb { + repeated PeerInfo peers = 1; + bytes network_secret_digest = 2; + uint32 my_peer_id_for_this_network = 3; + repeated TrustedKeyInfoPb trusted_keys = 4; +} + +message ListForeignNetworkResponse { + // foreign network in local + map foreign_networks = 1; +} + +message ListGlobalForeignNetworkRequest { InstanceIdentifier instance = 1; } + +message ListGlobalForeignNetworkResponse { + // foreign network in the entire network + message OneForeignNetwork { + string network_name = 1; + repeated uint32 peer_ids = 2; + string last_updated = 3; + uint32 version = 4; + } + + message ForeignNetworks { repeated OneForeignNetwork foreign_networks = 1; } + + map foreign_networks = 1; +} + +message GetForeignNetworkSummaryRequest { InstanceIdentifier instance = 1; } + +message GetForeignNetworkSummaryResponse { + peer_rpc.RouteForeignNetworkSummary summary = 1; +} + +service PeerManageRpc { + rpc ListPeer(ListPeerRequest) returns (ListPeerResponse); + rpc ListPublicIpv6Info(ListPublicIpv6InfoRequest) + returns (ListPublicIpv6InfoResponse); + rpc ListRoute(ListRouteRequest) returns (ListRouteResponse); + rpc DumpRoute(DumpRouteRequest) returns (DumpRouteResponse); + rpc ListForeignNetwork(ListForeignNetworkRequest) + returns (ListForeignNetworkResponse); + rpc ListGlobalForeignNetwork(ListGlobalForeignNetworkRequest) + returns (ListGlobalForeignNetworkResponse); + rpc ShowNodeInfo(ShowNodeInfoRequest) returns (ShowNodeInfoResponse); + rpc GetForeignNetworkSummary(GetForeignNetworkSummaryRequest) + returns (GetForeignNetworkSummaryResponse); +} + +enum ConnectorStatus { + CONNECTED = 0; + DISCONNECTED = 1; + CONNECTING = 2; +} + +message Connector { + common.Url url = 1; + ConnectorStatus status = 2; +} + +message ListConnectorRequest { InstanceIdentifier instance = 1; } + +message ListConnectorResponse { repeated Connector connectors = 1; } + +service ConnectorManageRpc { + rpc ListConnector(ListConnectorRequest) returns (ListConnectorResponse); +} + +message MappedListener { common.Url url = 1; } + +message ListMappedListenerRequest { InstanceIdentifier instance = 1; } + +message ListMappedListenerResponse { + repeated MappedListener mappedlisteners = 1; +} + +service MappedListenerManageRpc { + rpc ListMappedListener(ListMappedListenerRequest) + returns (ListMappedListenerResponse); +} + +enum VpnPortalClientState { + VPN_PORTAL_CLIENT_STATE_UNSPECIFIED = 0; + VPN_PORTAL_CLIENT_STATE_OFFLINE = 1; + VPN_PORTAL_CLIENT_STATE_CONNECTING = 2; + VPN_PORTAL_CLIENT_STATE_ONLINE = 3; + VPN_PORTAL_CLIENT_STATE_ERROR = 4; +} + +message VpnPortalClientInfo { + string name = 1; + string virtual_ip = 2; + repeated string groups = 3; + VpnPortalClientState state = 4; + optional uint32 peer_id = 5; + optional string endpoint = 6; + optional string tunnel_ip = 7; + string client_config = 8; + optional string error = 9; +} + +message VpnPortalInfo { + string vpn_type = 1; + string client_config = 2 [deprecated = true]; + repeated string connected_clients = 3 [deprecated = true]; + repeated VpnPortalClientInfo clients = 4; + optional string listener = 5; +} + +message GetVpnPortalInfoRequest { InstanceIdentifier instance = 1; } +message GetVpnPortalInfoResponse { VpnPortalInfo vpn_portal_info = 1; } + +service VpnPortalRpc { + rpc GetVpnPortalInfo(GetVpnPortalInfoRequest) + returns (GetVpnPortalInfoResponse); +} + +enum TcpProxyEntryTransportType { + TCP = 0; + KCP = 1; + QUIC = 2; +} + +enum TcpProxyEntryState { + Unknown = 0; + // receive syn packet but not start connecting to dst + SynReceived = 1; + // connecting to dst + ConnectingDst = 2; + // connected to dst + Connected = 3; + // connection closed + Closed = 4; + // closing src + ClosingSrc = 5; + // closing dst + ClosingDst = 6; +} + +message TcpProxyEntry { + common.SocketAddr src = 1; + common.SocketAddr dst = 2; + uint64 start_time = 3; + TcpProxyEntryState state = 4; + TcpProxyEntryTransportType transport_type = 5; +} + +message ListTcpProxyEntryRequest { InstanceIdentifier instance = 1; } + +message ListTcpProxyEntryResponse { repeated TcpProxyEntry entries = 1; } + +service TcpProxyRpc { + rpc ListTcpProxyEntry(ListTcpProxyEntryRequest) + returns (ListTcpProxyEntryResponse); +} + +message GetAclStatsRequest { InstanceIdentifier instance = 1; } + +message GetAclStatsResponse { acl.AclStats acl_stats = 1; } + +service AclManageRpc { + rpc GetAclStats(GetAclStatsRequest) returns (GetAclStatsResponse); + rpc GetWhitelist(GetWhitelistRequest) returns (GetWhitelistResponse); +} + +message GetWhitelistRequest { InstanceIdentifier instance = 1; } + +message GetWhitelistResponse { + repeated string tcp_ports = 1; + repeated string udp_ports = 2; +} + +message ListPortForwardRequest { InstanceIdentifier instance = 1; } + +message ListPortForwardResponse { + repeated common.PortForwardConfigPb cfgs = 1; +} + +service PortForwardManageRpc { + rpc ListPortForward(ListPortForwardRequest) returns (ListPortForwardResponse); +} + +message MetricSnapshot { + string name = 1; + uint64 value = 2; + map labels = 3; +} + +message GetStatsRequest { InstanceIdentifier instance = 1; } + +message GetStatsResponse { repeated MetricSnapshot metrics = 1; } + +message GetPrometheusStatsRequest { InstanceIdentifier instance = 1; } + +message GetPrometheusStatsResponse { string prometheus_text = 1; } + +service StatsRpc { + rpc GetStats(GetStatsRequest) returns (GetStatsResponse); + rpc GetPrometheusStats(GetPrometheusStatsRequest) + returns (GetPrometheusStatsResponse); +} + +// Credential management messages + +message GenerateCredentialRequest { + repeated string groups = 1; // optional: ACL groups for this credential + bool allow_relay = 2; // optional: allow relay through credential node + repeated string allowed_proxy_cidrs = 3; // optional: restrict proxy_cidrs + int64 ttl_seconds = 4; // must be > 0: credential TTL in seconds (0 / omitted is invalid) + optional string credential_id = 5; // optional: user-specified credential id, reused if already exists + InstanceIdentifier instance = 6; // target network instance + optional bool reusable = 7; // default true: allow multiple peers to reuse this credential +} + +message GenerateCredentialResponse { + string credential_id = 1; // UUID + string credential_secret = 2; // private key base64 + int64 expiry_unix = 3; +} + +message UpsertCredentialRequest { + string credential_id = 1; + string credential_secret = 2; + repeated string groups = 3; + bool allow_relay = 4; + repeated string allowed_proxy_cidrs = 5; + int64 expiry_unix = 6; + optional bool reusable = 7; + InstanceIdentifier instance = 8; +} + +message UpsertCredentialResponse { + bool changed = 1; +} + +message RevokeCredentialRequest { + string credential_id = 1; + InstanceIdentifier instance = 2; // target network instance +} + +message RevokeCredentialResponse { + bool success = 1; +} + +message ListCredentialsRequest { + InstanceIdentifier instance = 1; // target network instance +} + +message CredentialInfo { + string credential_id = 1; // UUID + repeated string groups = 2; + bool allow_relay = 3; + int64 expiry_unix = 4; + repeated string allowed_proxy_cidrs = 5; + optional bool reusable = 6; + string public_key_fingerprint = 7; +} + +message ListCredentialsResponse { + repeated CredentialInfo credentials = 1; +} + +service CredentialManageRpc { + rpc GenerateCredential(GenerateCredentialRequest) returns (GenerateCredentialResponse); + rpc RevokeCredential(RevokeCredentialRequest) returns (RevokeCredentialResponse); + rpc ListCredentials(ListCredentialsRequest) returns (ListCredentialsResponse); + rpc UpsertCredential(UpsertCredentialRequest) returns (UpsertCredentialResponse); +} diff --git a/vendor/easytier/easytier-proto/proto/api_logger.proto b/vendor/easytier/easytier-proto/proto/api_logger.proto new file mode 100644 index 0000000..c738ba2 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/api_logger.proto @@ -0,0 +1,24 @@ +syntax = "proto3"; + +package api.logger; + +enum LogLevel { + DISABLED = 0; + ERROR = 1; + WARNING = 2; + INFO = 3; + DEBUG = 4; + TRACE = 5; +} + +message SetLoggerConfigRequest { LogLevel level = 1; } + +message SetLoggerConfigResponse {} + +message GetLoggerConfigRequest {} + +message GetLoggerConfigResponse { LogLevel level = 1; } +service LoggerRpc { + rpc SetLoggerConfig(SetLoggerConfigRequest) returns (SetLoggerConfigResponse); + rpc GetLoggerConfig(GetLoggerConfigRequest) returns (GetLoggerConfigResponse); +} diff --git a/vendor/easytier/easytier-proto/proto/api_manage.proto b/vendor/easytier/easytier-proto/proto/api_manage.proto new file mode 100644 index 0000000..af4f86d --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/api_manage.proto @@ -0,0 +1,247 @@ +syntax = "proto3"; + +import "common.proto"; +import "peer_rpc.proto"; +import "api_instance.proto"; +import "acl.proto"; + +package api.manage; + +enum NetworkingMethod { + PublicServer = 0; + Manual = 1; + Standalone = 2; +} + +enum ConfigSource { + ConfigSourceUnspecified = 0; + ConfigSourceUser = 1; + ConfigSourceWeb = 2; +} + +message NetworkConfig { + optional string instance_id = 1; + + optional bool dhcp = 2; + optional string virtual_ipv4 = 3; + optional int32 network_length = 4; + optional string hostname = 5; + optional string network_name = 6; + optional string network_secret = 7; + optional NetworkingMethod networking_method = 8; + + optional string public_server_url = 9; + repeated string peer_urls = 10; + + repeated string proxy_cidrs = 11; + + optional bool enable_vpn_portal = 12 [deprecated = true]; + optional int32 vpn_portal_listen_port = 13 [deprecated = true]; + optional string vpn_portal_client_network_addr = 14 [deprecated = true]; + optional int32 vpn_portal_client_network_len = 15 [deprecated = true]; + + optional bool advanced_settings = 16; + + repeated string listener_urls = 17; + // optional int32 rpc_port = 18; + optional bool latency_first = 19; + + optional string dev_name = 20; + + optional bool use_smoltcp = 21; + optional bool disable_ipv6 = 47; + optional bool enable_kcp_proxy = 22; + optional bool disable_kcp_input = 23; + optional bool disable_p2p = 24; + optional bool bind_device = 25; + optional bool no_tun = 26; + + optional bool enable_exit_node = 27; + optional bool relay_all_peer_rpc = 28; + optional bool multi_thread = 29; + optional bool enable_relay_network_whitelist = 30; + repeated string relay_network_whitelist = 31; + optional bool enable_manual_routes = 32; + repeated string routes = 33; + repeated string exit_nodes = 34; + optional bool proxy_forward_by_system = 35; + optional bool disable_encryption = 36; + optional bool enable_socks5 = 37; + optional int32 socks5_port = 38; + optional bool disable_udp_hole_punching = 39; + optional int32 mtu = 40; + repeated string mapped_listeners = 41; + + optional bool enable_magic_dns = 42; + optional bool enable_private_mode = 43; + + // repeated string rpc_portal_whitelists = 44; + + optional bool enable_quic_proxy = 45; + optional bool disable_quic_input = 46; + optional int32 quic_listen_port = 50 [deprecated = true]; + repeated PortForwardConfig port_forwards = 48; + + optional bool disable_sym_hole_punching = 49; + + optional bool p2p_only = 51; + optional common.CompressionAlgoPb data_compress_algo = 52; + optional string encryption_algorithm = 53; + optional bool disable_tcp_hole_punching = 54; + + common.SecureModeConfig secure_mode = 55; + optional acl.Acl acl = 56; + optional string credential_file = 57; + optional bool lazy_p2p = 58; + optional bool need_p2p = 59; + optional uint64 instance_recv_bps_limit = 60; + optional bool disable_upnp = 61; + optional bool ipv6_public_addr_provider = 62; + optional bool ipv6_public_addr_auto = 63; + optional string ipv6_public_addr_prefix = 64; + optional bool disable_relay_data = 65; + optional bool enable_udp_broadcast_relay = 66; + optional uint32 socket_mark = 67; + repeated NetworkPeerConfig peers = 68; + optional VpnPortalConfig vpn_portal_config = 69; + repeated ManagedCredentialConfig managed_credentials = 71; + optional bool prefer_peer_relay = 72; +} + +message ManagedCredentialConfig { + string credential_id = 1; + string credential_secret = 2; + repeated string groups = 3; + bool allow_relay = 4; + repeated string allowed_proxy_cidrs = 5; + int64 expiry_unix = 6; + optional bool reusable = 7; +} + +message ManagedCredentialSet { + repeated ManagedCredentialConfig entries = 1; +} + +message VpnPortalClientConfig { + string name = 1; + string virtual_ip = 2; + repeated string groups = 3; +} + +message VpnPortalConfig { + string wireguard_listen = 1; + optional string wireguard_private_key = 2; + repeated VpnPortalClientConfig clients = 3; + // Omitted in existing configurations, where the portal is enabled. + optional bool enabled = 4; +} + +message NetworkPeerConfig { + string uri = 1; + optional string peer_public_key = 2; +} + +message PortForwardConfig { + string bind_ip = 1; + uint32 bind_port = 2; + string dst_ip = 3; + uint32 dst_port = 4; + string proto = 5; +} + +message MyNodeInfo { + common.Ipv4Inet virtual_ipv4 = 1; + string hostname = 2; + string version = 3; + peer_rpc.GetIpListResponse ips = 4; + common.StunInfo stun_info = 5; + repeated common.Url listeners = 6; + optional string vpn_portal_cfg = 7 [deprecated = true]; + uint32 peer_id = 8; +} + +message NetworkInstanceRunningInfo { + string dev_name = 1; + MyNodeInfo my_node_info = 2; + repeated string events = 3; + repeated api.instance.Route routes = 4; + repeated api.instance.PeerInfo peers = 5; + repeated api.instance.PeerRoutePair peer_route_pairs = 6; + bool running = 7; + optional string error_msg = 8; + peer_rpc.RouteForeignNetworkSummary foreign_network_summary = 9; +} + +message NetworkInstanceRunningInfoMap { + map map = 1; +} + +message NetworkMeta { + common.UUID inst_id = 1; + string network_name = 2; + uint32 config_permission = 3; + string instance_name = 4; + ConfigSource source = 5; +} + +message ValidateConfigRequest { NetworkConfig config = 1; } + +message ValidateConfigResponse { string toml_config = 1; } + +message RunNetworkInstanceRequest { + common.UUID inst_id = 1; + NetworkConfig config = 2; + bool overwrite = 3; + ConfigSource source = 4; +} + +message RunNetworkInstanceResponse { common.UUID inst_id = 1; } + +message RetainNetworkInstanceRequest { repeated common.UUID inst_ids = 1; } + +message RetainNetworkInstanceResponse { + repeated common.UUID remain_inst_ids = 1; +} + +message CollectNetworkInfoRequest { repeated common.UUID inst_ids = 1; } + +message CollectNetworkInfoResponse { NetworkInstanceRunningInfoMap info = 1; } + +message ListNetworkInstanceRequest {} + +message ListNetworkInstanceResponse { repeated common.UUID inst_ids = 1; } + +message DeleteNetworkInstanceRequest { repeated common.UUID inst_ids = 1; } + +message DeleteNetworkInstanceResponse { + repeated common.UUID remain_inst_ids = 1; +} + +message GetNetworkInstanceConfigRequest { common.UUID inst_id = 1; } + +message GetNetworkInstanceConfigResponse { + NetworkConfig config = 1; + ConfigSource source = 2; +} + +message ListNetworkInstanceMetaRequest { repeated common.UUID inst_ids = 1; } + +message ListNetworkInstanceMetaResponse { repeated NetworkMeta metas = 1; } + +service WebClientService { + rpc ValidateConfig(ValidateConfigRequest) returns (ValidateConfigResponse) {} + rpc RunNetworkInstance(RunNetworkInstanceRequest) + returns (RunNetworkInstanceResponse) {} + rpc RetainNetworkInstance(RetainNetworkInstanceRequest) + returns (RetainNetworkInstanceResponse) {} + rpc CollectNetworkInfo(CollectNetworkInfoRequest) + returns (CollectNetworkInfoResponse) {} + rpc ListNetworkInstance(ListNetworkInstanceRequest) + returns (ListNetworkInstanceResponse) {} + rpc DeleteNetworkInstance(DeleteNetworkInstanceRequest) + returns (DeleteNetworkInstanceResponse) {} + rpc GetNetworkInstanceConfig(GetNetworkInstanceConfigRequest) + returns (GetNetworkInstanceConfigResponse) {} + rpc ListNetworkInstanceMeta(ListNetworkInstanceMetaRequest) + returns (ListNetworkInstanceMetaResponse) {} +} diff --git a/vendor/easytier/easytier-proto/proto/common.proto b/vendor/easytier/easytier-proto/proto/common.proto new file mode 100644 index 0000000..1ce8318 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/common.proto @@ -0,0 +1,283 @@ +syntax = "proto3"; + +import "error.proto"; + +package common; + +message FlagsInConfig { + string default_protocol = 1; + string dev_name = 2; + bool enable_encryption = 3; + bool enable_ipv6 = 4; + uint32 mtu = 5; + bool latency_first = 6; + bool enable_exit_node = 7; + bool no_tun = 8; + bool use_smoltcp = 9; + string relay_network_whitelist = 10; + bool disable_p2p = 11; + bool relay_all_peer_rpc = 12; + bool disable_udp_hole_punching = 13; + // string ipv6_listener = 14; [deprecated = true]; use -l udp://[::]:12345 + // instead + bool multi_thread = 15; + CompressionAlgoPb data_compress_algo = 16; + bool bind_device = 17; + + // should we convert all tcp streams into kcp streams + bool enable_kcp_proxy = 18; + // does this peer allow kcp input + bool disable_kcp_input = 19; + // disable relay local network kcp packets + bool disable_relay_kcp = 20; + bool proxy_forward_by_system = 21; + + // enable magic dns or not + bool accept_dns = 22; + // enable private mode + bool private_mode = 23; + + // should we convert all tcp streams into quic streams + bool enable_quic_proxy = 24; + // does this peer allow quic input + bool disable_quic_input = 25; + // disable relay local network quic packets + bool disable_relay_quic = 35; + + // quic listen port + uint32 quic_listen_port = 33 [deprecated = true]; + + // a global relay limit, only work for foreign network + uint64 foreign_relay_bps_limit = 26; + + uint32 multi_thread_count = 27; + + // enable relay foreign network kcp packets + bool enable_relay_foreign_network_kcp = 28; + + // enable relay foreign network quic packets + bool enable_relay_foreign_network_quic = 36; + + // encryption algorithm to use, empty string means default (aes-gcm) + string encryption_algorithm = 29; + + // disable symmetric nat hole punching, treat symmetric as cone when enabled + bool disable_sym_hole_punching = 30; + + // tld dns zone for magic dns + string tld_dns_zone = 31; + + bool p2p_only = 32; + + bool disable_tcp_hole_punching = 34; + + bool lazy_p2p = 37; + bool need_p2p = 38; + uint64 instance_recv_bps_limit = 39; + bool disable_upnp = 40; + bool disable_relay_data = 41; + bool enable_udp_broadcast_relay = 42; + + // Linux-only: SO_MARK (fwmark) value applied to every outbound underlay + // socket (TCP/UDP/QUIC/WS/WG connectors and listeners). Unset = leave + // SO_MARK untouched (kernel default 0). Any set value (including 0) is + // applied via setsockopt. Requires CAP_NET_ADMIN; silently ignored on + // non-Linux platforms. + optional uint32 socket_mark = 43; + + // Prefer direct credential peers that already relay to a destination over + // advertising another direct edge to the same destination. + bool prefer_peer_relay = 44; +} + +message RpcDescriptor { + // allow same service registered multiple times in different domain + string domain_name = 1; + + string proto_name = 2; + string service_name = 3; + uint32 method_index = 4; +} + +message RpcRequest { + RpcDescriptor descriptor = 1 [ deprecated = true ]; + + bytes request = 2; + int32 timeout_ms = 3; +} + +// One transport-neutral RPC invocation submitted through a direct ABI. +// +// full_method_name uses the protobuf reflection form: +// ".." or "." for an empty package. +message DirectRpcRequest { + string full_method_name = 1; + bytes request = 2; + optional uint64 timeout_ms = 3; +} + +// One process-level management call delegated by the WASI WebClient to its host. +message HostManagementRequest { + DirectRpcRequest rpc = 1; + optional string prepared_config = 2; + // Runtime identity paired with prepared_config without rewriting rpc.request. + UUID prepared_instance_id = 3; +} + +message RpcResponse { + bytes response = 1; + error.Error error = 2; + + uint64 runtime_us = 3; +} + +enum CompressionAlgoPb { + Invalid = 0; + None = 1; + Zstd = 2; +} + +message RpcCompressionInfo { + // use this to compress the content + CompressionAlgoPb algo = 1; + + // tell the peer which compression algo is used to compress the next + // response/request + CompressionAlgoPb accepted_algo = 2; +} + +message RpcPacket { + uint32 from_peer = 1; + uint32 to_peer = 2; + int64 transaction_id = 3; + + RpcDescriptor descriptor = 4; + bytes body = 5; + bool is_request = 6; + + uint32 total_pieces = 7; + uint32 piece_idx = 8; + + int32 trace_id = 9; + + RpcCompressionInfo compression_info = 10; +} + +message Void {} + +message UUID { + uint32 part1 = 1; + uint32 part2 = 2; + uint32 part3 = 3; + uint32 part4 = 4; +} + +enum NatType { + // has NAT; but own a single public IP, port is not changed + Unknown = 0; + OpenInternet = 1; + NoPAT = 2; + FullCone = 3; + Restricted = 4; + PortRestricted = 5; + Symmetric = 6; + SymUdpFirewall = 7; + SymmetricEasyInc = 8; + SymmetricEasyDec = 9; +} + +message Ipv4Addr { uint32 addr = 1; } + +message Ipv6Addr { + uint32 part1 = 1; + uint32 part2 = 2; + uint32 part3 = 3; + uint32 part4 = 4; +} + +message IpAddr { + oneof ip { + Ipv4Addr ipv4 = 1; + Ipv6Addr ipv6 = 2; + }; +} + +message Ipv4Inet { + Ipv4Addr address = 1; + uint32 network_length = 2; +} + +message Ipv6Inet { + Ipv6Addr address = 1; + uint32 network_length = 2; +} + +message IpInet { + oneof ip { + Ipv4Inet ipv4 = 1; + Ipv6Inet ipv6 = 2; + }; +} + +message Url { string url = 1; } + +message SocketAddr { + oneof ip { + Ipv4Addr ipv4 = 1; + Ipv6Addr ipv6 = 2; + }; + uint32 port = 3; +} + +message TunnelInfo { + string tunnel_type = 1; + common.Url local_addr = 2; + common.Url remote_addr = 3; + common.Url resolved_remote_addr = 4; +} + +message StunInfo { + NatType udp_nat_type = 1; + NatType tcp_nat_type = 2; + int64 last_update_time = 3; + repeated string public_ip = 4; + uint32 min_port = 5; + uint32 max_port = 6; +} + +message PeerFeatureFlag { + bool is_public_server = 1; + bool avoid_relay_data = 2; + bool kcp_input = 3; + bool no_relay_kcp = 4; + bool support_conn_list_sync = 5; + bool quic_input = 6; + bool no_relay_quic = 7; + bool is_credential_peer = 8; + bool need_p2p = 9; + bool disable_p2p = 10; + bool ipv6_public_addr_provider = 11; +} + +enum SocketType { + TCP = 0; + UDP = 1; +} + +message PortForwardConfigPb { + SocketAddr bind_addr = 1; + SocketAddr dst_addr = 2; + SocketType socket_type = 3; +} + +message ProxyDstInfo { SocketAddr dst_addr = 1; } + +message SecureModeConfig { + bool enabled = 1; + + // base64(X25519 private key), used by shared node to present a stable identity + optional string local_private_key = 2; + + // base64(X25519 public key), required if local_private_key is set + optional string local_public_key = 3; +} diff --git a/vendor/easytier/easytier-proto/proto/core_config.proto b/vendor/easytier/easytier-proto/proto/core_config.proto new file mode 100644 index 0000000..14d7093 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/core_config.proto @@ -0,0 +1,56 @@ +syntax = "proto3"; + +import "common.proto"; + +package core_config; + +message CoreConfig { + NodeConfig node = 1; + RouteConfig routes = 2; + PeerPolicyConfig peer_policy = 3; + TrafficConfig traffic = 4; +} + +message NodeConfig { + optional uint32 peer_id = 1; + optional common.UUID instance_id = 2; + optional string hostname = 3; + string network_name = 4; +} + +message RouteConfig { + optional IpPrefix ipv4 = 1; + optional IpPrefix ipv6 = 2; + repeated IpPrefix advertised_routes = 3; + repeated ProxyNetworkConfig proxy_networks = 4; + repeated ForeignNetworkConfig foreign_networks = 5; +} + +message IpPrefix { + common.IpAddr address = 1; + uint32 prefix_len = 2; +} + +message ProxyNetworkConfig { + IpPrefix real = 1; + optional IpPrefix mapped = 2; +} + +message ForeignNetworkConfig { + string name = 1; + repeated IpPrefix cidrs = 2; +} + +message PeerPolicyConfig { + optional bool p2p_enabled = 1; + optional bool relay_peer_rpc = 2; + optional bool relay_data = 3; + optional bool latency_first = 4; + optional bool encryption_required = 5; +} + +message TrafficConfig { + optional uint32 mtu = 1; + optional uint64 instance_recv_bps_limit = 2; + optional uint64 foreign_relay_bps_limit = 3; +} diff --git a/vendor/easytier/easytier-proto/proto/core_peer.proto b/vendor/easytier/easytier-proto/proto/core_peer.proto new file mode 100644 index 0000000..289966e --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/core_peer.proto @@ -0,0 +1,77 @@ +syntax = "proto3"; + +import "common.proto"; +import "peer_rpc.proto"; + +package core.peer; + +message PeerConnStats { + uint64 rx_bytes = 1; + uint64 tx_bytes = 2; + + uint64 rx_packets = 3; + uint64 tx_packets = 4; + + uint64 latency_us = 5; +} + +message PeerConnInfo { + string conn_id = 1; + uint32 my_peer_id = 2; + uint32 peer_id = 3; + repeated string features = 4; + common.TunnelInfo tunnel = 5; + PeerConnStats stats = 6; + float loss_rate = 7; + bool is_client = 8; + string network_name = 9; + bool is_closed = 10; + bytes noise_local_static_pubkey = 11; + bytes noise_remote_static_pubkey = 12; + peer_rpc.SecureAuthLevel secure_auth_level = 13; + peer_rpc.PeerIdentityType peer_identity_type = 14; +} + +message PeerInfo { + uint32 peer_id = 1; + repeated PeerConnInfo conns = 2; + common.UUID default_conn_id = 3; + repeated common.UUID directly_connected_conns = 4; +} + +message Route { + uint32 peer_id = 1; + common.Ipv4Inet ipv4_addr = 2; + + uint32 next_hop_peer_id = 3; + int32 cost = 4; + int32 path_latency = 11; + + repeated string proxy_cidrs = 5; + string hostname = 6; + common.StunInfo stun_info = 7; + string inst_id = 8; + string version = 9; + common.PeerFeatureFlag feature_flag = 10; + + optional uint32 next_hop_peer_id_latency_first = 12; + optional int32 cost_latency_first = 13; + optional int32 path_latency_latency_first = 14; + + common.Ipv6Inet ipv6_addr = 15; + common.Ipv6Inet public_ipv6_addr = 16; + common.Ipv6Inet ipv6_public_addr_prefix = 17; +} + +message PublicIpv6LeaseInfo { + uint32 peer_id = 1; + string inst_id = 2; + common.Ipv6Inet leased_addr = 3; + int64 valid_until_unix_seconds = 4; + bool reused = 5; +} + +message ListPublicIpv6InfoResponse { + common.Ipv6Inet provider_prefix = 1; + repeated PublicIpv6LeaseInfo provider_leases = 2; +} diff --git a/vendor/easytier/easytier-proto/proto/error.proto b/vendor/easytier/easytier-proto/proto/error.proto new file mode 100644 index 0000000..5b5f537 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/error.proto @@ -0,0 +1,34 @@ +syntax = "proto3"; +package error; + +message OtherError { string error_message = 1; } + +message InvalidMethodIndex { + string service_name = 1; + uint32 method_index = 2; +} + +message InvalidService { string service_name = 1; } + +message ProstDecodeError {} + +message ProstEncodeError {} + +message ExecuteError { string error_message = 1; } + +message MalformatRpcPacket { string error_message = 1; } + +message Timeout { string error_message = 1; } + +message Error { + oneof error_kind { + OtherError other_error = 1; + InvalidMethodIndex invalid_method_index = 2; + InvalidService invalid_service = 3; + ProstDecodeError prost_decode_error = 4; + ProstEncodeError prost_encode_error = 5; + ExecuteError execute_error = 6; + MalformatRpcPacket malformat_rpc_packet = 7; + Timeout timeout = 8; + } +} diff --git a/vendor/easytier/easytier-proto/proto/magic_dns.proto b/vendor/easytier/easytier-proto/proto/magic_dns.proto new file mode 100644 index 0000000..788ccc6 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/magic_dns.proto @@ -0,0 +1,49 @@ +syntax = "proto3"; + +import "google/protobuf/timestamp.proto"; +import "common.proto"; +import "api_instance.proto"; + +package magic_dns; + +message DnsRecordA { + string name = 1; + common.Ipv4Addr value = 2; + int32 ttl = 3; +} + +message DnsRecordSOA { + string name = 1; + string value = 2; +} + +message DnsRecord { + oneof record { + DnsRecordA a = 1; + DnsRecordSOA soa = 2; + } +} + +message DnsRecordList { + repeated DnsRecord records = 1; +} + +message UpdateDnsRecordRequest { + string zone = 1; + repeated api.instance.Route routes = 2; +} + +message GetDnsRecordResponse { + map records = 1; +} + +message HandshakeRequest {} + +message HandshakeResponse {} + +service MagicDnsServerRpc { + rpc Handshake(HandshakeRequest) returns (HandshakeResponse) {} + rpc Heartbeat(common.Void) returns (common.Void) {} + rpc UpdateDnsRecord(UpdateDnsRecordRequest) returns (common.Void) {} + rpc GetDnsRecord(common.Void) returns (GetDnsRecordResponse) {} +} diff --git a/vendor/easytier/easytier-proto/proto/peer_rpc.proto b/vendor/easytier/easytier-proto/proto/peer_rpc.proto new file mode 100644 index 0000000..e3e4f75 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/peer_rpc.proto @@ -0,0 +1,393 @@ +syntax = "proto3"; + +import "google/protobuf/timestamp.proto"; +import "common.proto"; + +package peer_rpc; + +message TrustedCredentialPubkey { + bytes pubkey = 1; // X25519 public key (32 bytes) + repeated string groups = 2; // ACL groups this credential belongs to + bool allow_relay = 3; // whether this credential node can relay data + int64 expiry_unix = 4; // expiry time (Unix timestamp) + repeated string allowed_proxy_cidrs = 5; // allowed proxy_cidrs ranges + optional bool reusable = 6; // whether multiple peers may use the same credential concurrently +} + +message TrustedCredentialPubkeyProof { + TrustedCredentialPubkey credential = 1; + bytes credential_hmac = 2; +} + +message RoutePeerInfo { + // means next hop in route table. + uint32 peer_id = 1; + common.UUID inst_id = 2; + uint32 cost = 3; + optional common.Ipv4Addr ipv4_addr = 4; + repeated string proxy_cidrs = 5; + optional string hostname = 6; + common.NatType udp_nat_type = 7; + google.protobuf.Timestamp last_update = 8; + uint32 version = 9; + + string easytier_version = 10; + common.PeerFeatureFlag feature_flag = 11; + uint64 peer_route_id = 12; + + uint32 network_length = 13; + + optional uint32 quic_port = 14 [deprecated = true]; + optional common.Ipv6Inet ipv6_addr = 15; + + repeated PeerGroupInfo groups = 16; + + common.NatType tcp_nat_type = 17; + bytes noise_static_pubkey = 18; + + // Trusted credential public keys published by admin nodes (holding network_secret) + repeated TrustedCredentialPubkeyProof trusted_credential_pubkeys = 19; + + optional common.Ipv6Inet ipv6_public_addr_prefix = 22; + optional common.Ipv6Inet ipv6_public_addr_lease = 24; +} + +message PeerIdVersion { + uint32 peer_id = 1; + uint32 version = 2; +} + +message RouteConnBitmap { + repeated PeerIdVersion peer_ids = 1; + bytes bitmap = 2; +} + +message RouteConnPeerList { + message PeerConnInfo { + PeerIdVersion peer_id = 1; + repeated uint32 connected_peer_ids = 2; + } + repeated PeerConnInfo peer_conn_infos = 1; +} + +message RoutePeerInfos { repeated RoutePeerInfo items = 1; } + +message ForeignNetworkRouteInfoKey { + uint32 peer_id = 1; + string network_name = 2; +} + +message ForeignNetworkRouteInfoEntry { + repeated uint32 foreign_peer_ids = 1; + google.protobuf.Timestamp last_update = 2; + uint32 version = 3; + bytes network_secret_digest = 4; + uint32 my_peer_id_for_this_network = 5; +} + +message RouteForeignNetworkInfos { + message Info { + ForeignNetworkRouteInfoKey key = 1; + ForeignNetworkRouteInfoEntry value = 2; + } + repeated Info infos = 1; +} + +message RouteForeignNetworkSummary { + message Info { + uint32 peer_id = 1; + uint32 network_count = 2; + uint32 peer_count = 3; + } + + map info_map = 1; +} + +message PeerGroupInfo { + string group_name = 1; + bytes group_proof = 2; +} + +message SyncRouteInfoRequest { + uint32 my_peer_id = 1; + uint64 my_session_id = 2; + bool is_initiator = 3; + RoutePeerInfos peer_infos = 4; + oneof conn_info { + RouteConnBitmap conn_bitmap = 5; + RouteConnPeerList conn_peer_list = 7; + } + RouteForeignNetworkInfos foreign_network_infos = 6; +} + +enum SyncRouteInfoError { + DuplicatePeerId = 0; + Stopped = 1; +} + +message SyncRouteInfoResponse { + bool is_initiator = 1; + uint64 session_id = 2; + optional SyncRouteInfoError error = 3; + // Missing data for peers referenced by accepted topology. Empty in steady state. + repeated uint32 missing_peer_ids = 4; + repeated uint32 missing_conn_peer_ids = 5; +} + +service OspfRouteRpc { + // Generates a "hello" greeting based on the supplied info. + rpc SyncRouteInfo(SyncRouteInfoRequest) returns (SyncRouteInfoResponse); +} + +message AcquireIpv6PublicAddrLeaseRequest { + uint32 peer_id = 1; + common.UUID inst_id = 2; +} + +message RenewIpv6PublicAddrLeaseRequest { + uint32 peer_id = 1; + common.UUID inst_id = 2; + common.Ipv6Inet leased_addr = 3; +} + +message ReleaseIpv6PublicAddrLeaseRequest { + uint32 peer_id = 1; + common.UUID inst_id = 2; +} + +message GetIpv6PublicAddrLeaseRequest { + uint32 peer_id = 1; + common.UUID inst_id = 2; +} + +message Ipv6PublicAddrLeaseReply { + uint32 provider_peer_id = 1; + common.UUID provider_inst_id = 2; + common.Ipv6Inet provider_prefix = 3; + common.Ipv6Inet leased_addr = 4; + google.protobuf.Timestamp valid_until = 5; + bool reused = 6; + optional string error_msg = 7; +} + +service PublicIpv6AddrRpc { + rpc AcquireLease(AcquireIpv6PublicAddrLeaseRequest) + returns (Ipv6PublicAddrLeaseReply); + rpc RenewLease(RenewIpv6PublicAddrLeaseRequest) + returns (Ipv6PublicAddrLeaseReply); + rpc ReleaseLease(ReleaseIpv6PublicAddrLeaseRequest) returns (common.Void); + rpc GetLease(GetIpv6PublicAddrLeaseRequest) returns (Ipv6PublicAddrLeaseReply); +} + +message GetIpListRequest {} + +message GetIpListResponse { + common.Ipv4Addr public_ipv4 = 1; + repeated common.Ipv4Addr interface_ipv4s = 2; + common.Ipv6Addr public_ipv6 = 3; + repeated common.Ipv6Addr interface_ipv6s = 4; + repeated common.Url listeners = 5; +} + +message SendUdpHolePunchPacketRequest { + common.SocketAddr connector_addr = 1; + uint32 listener_port = 2; + common.Ipv6Addr preferred_src_ipv6 = 3; + repeated common.SocketAddr connector_addrs = 4; +} + +service DirectConnectorRpc { + rpc GetIpList(GetIpListRequest) returns (GetIpListResponse); + rpc SendUdpHolePunchPacket(SendUdpHolePunchPacketRequest) returns (common.Void); +} + +message SelectPunchListenerRequest { + bool force_new = 1; + bool prefer_port_mapping = 2; +} + +message SelectPunchListenerResponse { + common.SocketAddr listener_mapped_addr = 1; +} + +message SendPunchPacketConeRequest { + common.SocketAddr listener_mapped_addr = 1; + common.SocketAddr dest_addr = 2; + uint32 transaction_id = 3; + // send this many packets in a batch + uint32 packet_count_per_batch = 4; + // send total this batch count, total packet count = packet_batch_size * packet_batch_count + uint32 packet_batch_count = 5; + // interval between each batch + uint32 packet_interval_ms = 6; +} + +message SendPunchPacketHardSymRequest { + common.SocketAddr listener_mapped_addr = 1; + + repeated common.Ipv4Addr public_ips = 2; + uint32 transaction_id = 3; + uint32 port_index = 4; + uint32 round = 5; +} + +message SendPunchPacketHardSymResponse { uint32 next_port_index = 1; } + +message SendPunchPacketEasySymRequest { + common.SocketAddr listener_mapped_addr = 1; + repeated common.Ipv4Addr public_ips = 2; + uint32 transaction_id = 3; + + uint32 base_port_num = 4; + uint32 max_port_num = 5; + bool is_incremental = 6; +} + +message SendPunchPacketBothEasySymRequest { + uint32 udp_socket_count = 1; + common.Ipv4Addr public_ip = 2; + uint32 transaction_id = 3; + + uint32 dst_port_num = 4; + uint32 wait_time_ms = 5; +} + +message SendPunchPacketBothEasySymResponse { + // is doing punch with other peer + bool is_busy = 1; + common.SocketAddr base_mapped_addr = 2; +} + +service UdpHolePunchRpc { + rpc SelectPunchListener(SelectPunchListenerRequest) + returns (SelectPunchListenerResponse); + + // send packet to one remote_addr, used by nat1-3 to nat1-3 + rpc SendPunchPacketCone(SendPunchPacketConeRequest) returns (common.Void); + + // send packet to multiple remote_addr (birthday attack), used by nat4 to nat1-3 + rpc SendPunchPacketHardSym(SendPunchPacketHardSymRequest) + returns (SendPunchPacketHardSymResponse); + rpc SendPunchPacketEasySym(SendPunchPacketEasySymRequest) + returns (common.Void); + + // nat4 to nat4 (both predictably) + rpc SendPunchPacketBothEasySym(SendPunchPacketBothEasySymRequest) + returns (SendPunchPacketBothEasySymResponse); +} + +message TcpHolePunchRequest { common.SocketAddr connector_mapped_addr = 1; } + +message TcpHolePunchResponse { common.SocketAddr listener_mapped_addr = 1; } + +service TcpHolePunchRpc { + rpc ExchangeMappedAddr(TcpHolePunchRequest) returns (TcpHolePunchResponse); +} + +message DirectConnectedPeerInfo { int32 latency_ms = 1; } + +message PeerInfoForGlobalMap { + map direct_peers = 1; +} + +message ReportPeersRequest { + uint32 my_peer_id = 1; + PeerInfoForGlobalMap peer_infos = 2; +} + +message ReportPeersResponse {} + +message GlobalPeerMap { map map = 1; } + +message GetGlobalPeerMapRequest { uint64 digest = 1; } + +message GetGlobalPeerMapResponse { + map global_peer_map = 1; + optional uint64 digest = 2; +} + +service PeerCenterRpc { + rpc ReportPeers(ReportPeersRequest) returns (ReportPeersResponse); + rpc GetGlobalPeerMap(GetGlobalPeerMapRequest) + returns (GetGlobalPeerMapResponse); +} + +message HandshakeRequest { + uint32 magic = 1; + uint32 my_peer_id = 2; + uint32 version = 3; + repeated string features = 4; + string network_name = 5; + bytes network_secret_digest = 6; +} + +message KcpConnData { + common.SocketAddr src = 1; + common.SocketAddr dst = 4; +} + +enum SecureAuthLevel { + None = 0; + EncryptedUnauthenticated = 1; + PeerVerified = 2; + NetworkSecretConfirmed = 3; +} + +enum PeerIdentityType { + Admin = 0; + Credential = 1; + SharedNode = 2; +} + +enum PeerConnSessionActionPb { + Join = 0; + Sync = 1; + Create = 2; +} + +message PeerConnNoiseMsg1Pb { + uint32 version = 1; + string a_network_name = 2; + optional uint32 a_session_generation = 3; + common.UUID a_conn_id = 4; + string client_encryption_algorithm = 5; + repeated string features = 6; +} + +message PeerConnNoiseMsg2Pb { + string b_network_name = 1; + uint32 role_hint = 2; + PeerConnSessionActionPb action = 3; + uint32 b_session_generation = 4; + optional bytes root_key_32 = 5; + uint32 initial_epoch = 6; + common.UUID b_conn_id = 7; + common.UUID a_conn_id_echo = 8; + optional bytes secret_proof_32 = 9; + string server_encryption_algorithm = 10; + repeated string features = 11; +} + +message RelayNoiseMsg1Pb { + uint32 version = 1; + optional uint32 a_session_generation = 3; + common.UUID a_conn_id = 4; + string client_encryption_algorithm = 5; +} + +message RelayNoiseMsg2Pb { + PeerConnSessionActionPb action = 3; + uint32 b_session_generation = 4; + optional bytes root_key_32 = 5; + uint32 initial_epoch = 6; + common.UUID b_conn_id = 7; + common.UUID a_conn_id_echo = 8; + string server_encryption_algorithm = 10; +} + +message PeerConnNoiseMsg3Pb { + common.UUID a_conn_id_echo = 1; + common.UUID b_conn_id_echo = 2; + optional bytes secret_proof_32 = 3; + bytes secret_digest = 4; +} diff --git a/vendor/easytier/easytier-proto/proto/tests.proto b/vendor/easytier/easytier-proto/proto/tests.proto new file mode 100644 index 0000000..a0c1fc8 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/tests.proto @@ -0,0 +1,24 @@ +syntax = "proto3"; + +package tests; + +/// The Greeting service. This service is used to generate greetings for various +/// use-cases. +service Greeting { + // Generates a "hello" greeting based on the supplied info. + rpc SayHello(SayHelloRequest) returns (SayHelloResponse); + // Generates a "goodbye" greeting based on the supplied info. + rpc SayGoodbye(SayGoodbyeRequest) returns (SayGoodbyeResponse); +} + +// The request for an `Greeting.SayHello` call. +message SayHelloRequest { string name = 1; } + +// The response for an `Greeting.SayHello` call. +message SayHelloResponse { string greeting = 1; } + +// The request for an `Greeting.SayGoodbye` call. +message SayGoodbyeRequest { string name = 1; } + +// The response for an `Greeting.SayGoodbye` call. +message SayGoodbyeResponse { string greeting = 1; } diff --git a/vendor/easytier/easytier-proto/proto/web.proto b/vendor/easytier/easytier-proto/proto/web.proto new file mode 100644 index 0000000..1ce6076 --- /dev/null +++ b/vendor/easytier/easytier-proto/proto/web.proto @@ -0,0 +1,43 @@ +syntax = "proto3"; + +import "common.proto"; + +package web; + +message DeviceOsInfo { + string os_type = 1; + string version = 2; + string distribution = 3; +} + +message HeartbeatRequest { + common.UUID machine_id = 1; + common.UUID inst_id = 2; + string user_token = 3; + + string easytier_version = 4; + string report_time = 5; + string hostname = 6; + + repeated common.UUID running_network_instances = 7; + DeviceOsInfo device_os = 8; + bool support_config_source = 9; + repeated common.UUID failed_network_instances = 10; + bool support_heartbeat_policy = 11; +} + +message HeartbeatResponse { + optional uint32 heartbeat_interval_ms = 1; + optional uint32 heartbeat_timeout_ms = 2; +} + +message GetFeatureRequest {} + +message GetFeatureResponse { + bool support_encryption = 1; +} + +service WebServerService { + rpc Heartbeat(HeartbeatRequest) returns (HeartbeatResponse); + rpc GetFeature(GetFeatureRequest) returns (GetFeatureResponse); +} diff --git a/vendor/easytier/easytier-proto/src/acl.rs b/vendor/easytier/easytier-proto/src/acl.rs new file mode 100644 index 0000000..4d086b9 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/acl.rs @@ -0,0 +1,118 @@ +use std::fmt::Display; + +include!(concat!(env!("OUT_DIR"), "/acl.rs")); +include!(concat!(env!("OUT_DIR"), "/acl.serde.rs")); + +impl Acl { + pub fn is_empty(&self) -> bool { + self.acl_v1.as_ref().map(|v1| v1.is_empty()).unwrap_or(true) + } +} + +impl AclV1 { + pub fn is_empty(&self) -> bool { + let has_chains = !self.chains.is_empty(); + let has_groups = self.group.as_ref().map(|g| !g.is_empty()).unwrap_or(false); + !has_chains && !has_groups + } +} + +impl GroupInfo { + pub fn is_empty(&self) -> bool { + self.declares.is_empty() && self.members.is_empty() + } +} + +#[cfg(feature = "api")] +impl Display for ConnTrackEntry { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let src = self + .src_addr + .as_ref() + .map(|a| a.to_string()) + .unwrap_or_else(|| "-".to_string()); + let dst = self + .dst_addr + .as_ref() + .map(|a| a.to_string()) + .unwrap_or_else(|| "-".to_string()); + let last_seen = chrono::DateTime::::from_timestamp(self.last_seen as i64, 0) + .unwrap() + .with_timezone(&chrono::Local); + let created_at = chrono::DateTime::::from_timestamp(self.created_at as i64, 0) + .unwrap() + .with_timezone(&chrono::Local); + write!( + f, + "[src: {}, dst: {}, proto: {:?}, state: {:?}, pkts: {}, bytes: {}, created: {}, last_seen: {}]", + src, + dst, + Protocol::try_from(self.protocol).unwrap_or(Protocol::Unspecified), + ConnState::try_from(self.state).unwrap_or(ConnState::Invalid), + self.packet_count, + self.byte_count, + created_at, + last_seen + ) + } +} + +impl Display for Rule { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!( + f, + "[name: '{}', prio: {}, action: {:?}, enabled: {}, proto: {:?}, ports: {:?}, src_ports: {:?}, src_ips: {:?}, dst_ips: {:?}, stateful: {}, rate: {}, burst: {}]", + self.name, + self.priority, + Action::try_from(self.action).unwrap_or(Action::Noop), + self.enabled, + Protocol::try_from(self.protocol).unwrap_or(Protocol::Unspecified), + self.ports, + self.source_ports, + self.source_ips, + self.destination_ips, + self.stateful, + self.rate_limit, + self.burst_limit + ) + } +} + +impl Display for StatItem { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!( + f, + "[pkts: {}, bytes: {}]", + self.packet_count, self.byte_count + ) + } +} + +#[cfg(feature = "api")] +impl Display for AclStats { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + writeln!(f, "AclStats:")?; + writeln!(f, " Global:")?; + for (k, v) in &self.global { + writeln!(f, " {}: {}", k, v)?; + } + writeln!(f, " ConnTrack:")?; + for entry in &self.conn_track { + writeln!(f, " {}", entry)?; + } + writeln!(f, " Rules:")?; + for rule_stat in &self.rules { + if let Some(rule) = &rule_stat.rule { + write!(f, " {} ", rule)?; + } else { + write!(f, " ")?; + } + if let Some(stat) = &rule_stat.stat { + writeln!(f, "{}", stat)?; + } else { + writeln!(f)?; + } + } + Ok(()) + } +} diff --git a/vendor/easytier/easytier-proto/src/api.rs b/vendor/easytier/easytier-proto/src/api.rs new file mode 100644 index 0000000..8b152f3 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/api.rs @@ -0,0 +1,610 @@ +pub mod config { + include!(concat!(env!("OUT_DIR"), "/api.config.rs")); + #[cfg(feature = "json-rpc")] + include!(concat!(env!("OUT_DIR"), "/api.config.serde.rs")); + + pub struct Patchable { + pub action: Option, + pub value: Option, + } + + impl From for Patchable { + fn from(value: RoutePatch) -> Self { + Patchable { + action: ConfigPatchAction::try_from(value.action).ok(), + value: value.cidr.map(Into::into), + } + } + } + + impl From for Patchable { + fn from(value: ExitNodePatch) -> Self { + Patchable { + action: ConfigPatchAction::try_from(value.action).ok(), + value: value.node.map(Into::into), + } + } + } + + impl From for Patchable { + fn from(value: StringPatch) -> Self { + Patchable { + action: ConfigPatchAction::try_from(value.action).ok(), + value: Some(value.value), + } + } + } + + impl From for Patchable { + fn from(value: UrlPatch) -> Self { + Patchable { + action: ConfigPatchAction::try_from(value.action).ok(), + value: value.url.map(Into::into), + } + } + } + + pub fn patch_vec(v: &mut Vec, patches: Vec>) + where + T: PartialEq, + { + for patch in patches { + match patch.action { + Some(ConfigPatchAction::Add) => { + if let Some(value) = patch.value { + v.push(value); + } + } + Some(ConfigPatchAction::Remove) => { + if let Some(value) = patch.value { + v.retain(|x| x != &value); + } + } + Some(ConfigPatchAction::Clear) => { + v.clear(); + } + None => {} + } + } + } +} + +pub mod instance { + use std::fmt::{Display, Formatter}; + + include!(concat!(env!("OUT_DIR"), "/api.instance.rs")); + #[cfg(feature = "json-rpc")] + include!(concat!(env!("OUT_DIR"), "/api.instance.serde.rs")); + + impl From for PeerConnStats { + fn from(value: crate::core_peer::peer::PeerConnStats) -> Self { + Self { + rx_bytes: value.rx_bytes, + tx_bytes: value.tx_bytes, + rx_packets: value.rx_packets, + tx_packets: value.tx_packets, + latency_us: value.latency_us, + } + } + } + + impl From for PeerConnInfo { + fn from(value: crate::core_peer::peer::PeerConnInfo) -> Self { + Self { + conn_id: value.conn_id, + my_peer_id: value.my_peer_id, + peer_id: value.peer_id, + features: value.features, + tunnel: value.tunnel, + stats: value.stats.map(Into::into), + loss_rate: value.loss_rate, + is_client: value.is_client, + network_name: value.network_name, + is_closed: value.is_closed, + noise_local_static_pubkey: value.noise_local_static_pubkey, + noise_remote_static_pubkey: value.noise_remote_static_pubkey, + secure_auth_level: value.secure_auth_level, + peer_identity_type: value.peer_identity_type, + } + } + } + + impl From for PeerInfo { + fn from(value: crate::core_peer::peer::PeerInfo) -> Self { + Self { + peer_id: value.peer_id, + conns: value.conns.into_iter().map(Into::into).collect(), + default_conn_id: value.default_conn_id, + directly_connected_conns: value.directly_connected_conns, + } + } + } + + impl From for Route { + fn from(value: crate::core_peer::peer::Route) -> Self { + Self { + peer_id: value.peer_id, + ipv4_addr: value.ipv4_addr, + next_hop_peer_id: value.next_hop_peer_id, + cost: value.cost, + path_latency: value.path_latency, + proxy_cidrs: value.proxy_cidrs, + hostname: value.hostname, + stun_info: value.stun_info, + inst_id: value.inst_id, + version: value.version, + feature_flag: value.feature_flag, + next_hop_peer_id_latency_first: value.next_hop_peer_id_latency_first, + cost_latency_first: value.cost_latency_first, + path_latency_latency_first: value.path_latency_latency_first, + ipv6_addr: value.ipv6_addr, + public_ipv6_addr: value.public_ipv6_addr, + ipv6_public_addr_prefix: value.ipv6_public_addr_prefix, + } + } + } + + impl From for PublicIpv6LeaseInfo { + fn from(value: crate::core_peer::peer::PublicIpv6LeaseInfo) -> Self { + Self { + peer_id: value.peer_id, + inst_id: value.inst_id, + leased_addr: value.leased_addr, + valid_until_unix_seconds: value.valid_until_unix_seconds, + reused: value.reused, + } + } + } + + impl From for ListPublicIpv6InfoResponse { + fn from(value: crate::core_peer::peer::ListPublicIpv6InfoResponse) -> Self { + Self { + provider_prefix: value.provider_prefix, + provider_leases: value.provider_leases.into_iter().map(Into::into).collect(), + } + } + } + + impl Display for PeerConnInfo { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.debug_struct("PeerConnInfo") + .field("my_peer_id", &self.my_peer_id) + .field("dst_peer_id", &self.peer_id) + .field("tunnel_info", &self.tunnel) + .finish() + } + } + + impl PeerRoutePair { + pub fn get_latency_ms(&self) -> Option { + let mut ret = u64::MAX; + let p = self.peer.as_ref()?; + let default_conn_id = p.default_conn_id.map(|id| id.to_string()); + for conn in p.conns.iter() { + let Some(stats) = &conn.stats else { + continue; + }; + if default_conn_id == Some(conn.conn_id.to_string()) { + return Some(f64::from(stats.latency_us as u32) / 1000.0); + } + ret = ret.min(stats.latency_us); + } + + if ret == u64::MAX { + None + } else { + Some(f64::from(ret as u32) / 1000.0) + } + } + + pub fn get_rx_bytes(&self) -> Option { + let mut ret = 0; + let p = self.peer.as_ref()?; + for conn in p.conns.iter() { + let Some(stats) = &conn.stats else { + continue; + }; + ret += stats.rx_bytes; + } + + if ret == 0 { None } else { Some(ret) } + } + + pub fn get_tx_bytes(&self) -> Option { + let mut ret = 0; + let p = self.peer.as_ref()?; + for conn in p.conns.iter() { + let Some(stats) = &conn.stats else { + continue; + }; + ret += stats.tx_bytes; + } + + if ret == 0 { None } else { Some(ret) } + } + + pub fn get_loss_rate(&self) -> Option { + let p = self.peer.as_ref()?; + let default_conn_id = p.default_conn_id.map(|id| id.to_string()); + let mut ret = None; + for conn in p.conns.iter() { + if default_conn_id == Some(conn.conn_id.to_string()) { + return Some(conn.loss_rate as f64); + } + + ret.get_or_insert(conn.loss_rate as f64); + } + + ret + } + + fn get_tunnel_proto_str(tunnel_info: &super::super::common::TunnelInfo) -> String { + tunnel_info.display_tunnel_type() + } + + pub fn get_conn_protos(&self) -> Option> { + let mut ret = vec![]; + let p = self.peer.as_ref()?; + for conn in p.conns.iter() { + let Some(tunnel_info) = &conn.tunnel else { + continue; + }; + // insert if not exists + let tunnel_type = Self::get_tunnel_proto_str(tunnel_info); + if !ret.contains(&tunnel_type) { + ret.push(tunnel_type); + } + } + + if ret.is_empty() { None } else { Some(ret) } + } + + pub fn get_udp_nat_type(&self) -> String { + use crate::proto::common::NatType; + let mut ret = NatType::Unknown; + if let Some(r) = &self.route.clone().unwrap_or_default().stun_info { + ret = NatType::try_from(r.udp_nat_type).unwrap(); + } + format!("{:?}", ret) + } + } + + pub fn list_peer_route_pair(peers: Vec, routes: Vec) -> Vec { + let mut pairs: Vec = vec![]; + + for route in routes.iter() { + let peer = peers.iter().find(|peer| peer.peer_id == route.peer_id); + let pair = PeerRoutePair { + route: Some(route.clone()), + peer: peer.cloned(), + }; + + pairs.push(pair); + } + + pairs.sort_by(|a, b| { + let a_is_public_server = a + .route + .as_ref() + .and_then(|r| r.feature_flag.as_ref()) + .is_some_and(|f| f.is_public_server); + + let b_is_public_server = b + .route + .as_ref() + .and_then(|r| r.feature_flag.as_ref()) + .is_some_and(|f| f.is_public_server); + + if a_is_public_server != b_is_public_server { + return if a_is_public_server { + std::cmp::Ordering::Less + } else { + std::cmp::Ordering::Greater + }; + } + + let a_ip = a + .route + .as_ref() + .and_then(|r| r.ipv4_addr.as_ref()) + .and_then(|ipv4| ipv4.address.as_ref()) + .map_or(0, |addr| addr.addr); + + let b_ip = b + .route + .as_ref() + .and_then(|r| r.ipv4_addr.as_ref()) + .and_then(|ipv4| ipv4.address.as_ref()) + .map_or(0, |addr| addr.addr); + + a_ip.cmp(&b_ip) + }); + + pairs + } +} + +pub mod logger { + include!(concat!(env!("OUT_DIR"), "/api.logger.rs")); + #[cfg(feature = "json-rpc")] + include!(concat!(env!("OUT_DIR"), "/api.logger.serde.rs")); +} + +pub mod manage { + include!(concat!(env!("OUT_DIR"), "/api.manage.rs")); + #[cfg(feature = "json-rpc")] + include!(concat!(env!("OUT_DIR"), "/api.manage.serde.rs")); + + impl std::fmt::Debug for ManagedCredentialConfig { + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("ManagedCredentialConfig") + .field("credential_id", &self.credential_id) + .field("credential_secret", &"") + .field("groups", &self.groups) + .field("allow_relay", &self.allow_relay) + .field("allowed_proxy_cidrs", &self.allowed_proxy_cidrs) + .field("expiry_unix", &self.expiry_unix) + .field("reusable", &self.reusable) + .finish() + } + } + + impl std::fmt::Debug for VpnPortalConfig { + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("VpnPortalConfig") + .field("wireguard_listen", &self.wireguard_listen) + .field( + "wireguard_private_key", + &self.wireguard_private_key.as_ref().map(|_| ""), + ) + .field("clients", &self.clients) + .finish() + } + } +} + +#[cfg(test)] +mod tests { + use bytes::Bytes; + use prost::Message; + + use super::instance::{PeerConnInfo, PeerInfo, PeerRoutePair}; + use super::manage::{ + ListNetworkInstanceRequest, ListNetworkInstanceResponse, WebClientService, + WebClientServiceClient, WebClientServiceDescriptor, WebClientServiceMethodDescriptor, + }; + use crate::proto::common::Uuid; + use crate::proto::rpc_types::controller::BaseController; + use crate::proto::rpc_types::descriptor::ServiceDescriptor; + use crate::proto::rpc_types::error::Error; + use crate::proto::rpc_types::handler::Handler; + + #[test] + fn vpn_portal_debug_redacts_private_key() { + let config = super::manage::VpnPortalConfig { + enabled: None, + wireguard_listen: "0.0.0.0:51820".to_owned(), + wireguard_private_key: Some("private-key-material".to_owned()), + clients: Vec::new(), + }; + + let debug = format!("{config:?}"); + assert!(debug.contains("")); + assert!(!debug.contains("private-key-material")); + } + + #[test] + fn managed_credential_debug_redacts_secret() { + let credential = super::manage::ManagedCredentialConfig { + credential_id: "managed".to_owned(), + credential_secret: "private-key-material".to_owned(), + ..Default::default() + }; + + let debug = format!("{credential:?}"); + assert!(debug.contains("")); + assert!(!debug.contains("private-key-material")); + } + + #[derive(Clone, Default)] + struct WebClientServiceJsonCallHandler; + + #[async_trait::async_trait] + impl Handler for WebClientServiceJsonCallHandler { + type Descriptor = WebClientServiceDescriptor; + type Controller = BaseController; + + async fn call( + &self, + _ctrl: Self::Controller, + method: ::Method, + input: Bytes, + ) -> crate::proto::rpc_types::error::Result { + match method { + WebClientServiceMethodDescriptor::ListNetworkInstance => { + let _req = ListNetworkInstanceRequest::decode(input.as_ref()).unwrap(); + let resp = ListNetworkInstanceResponse { + inst_ids: vec![Uuid { + part1: 1, + part2: 2, + part3: 3, + part4: 4, + }], + }; + Ok(Bytes::from(resp.encode_to_vec())) + } + _ => Err(Error::ExecutionError(anyhow::anyhow!( + "unsupported method in test handler" + ))), + } + } + } + + #[tokio::test] + async fn web_client_service_call_json_method_supports_snake_and_proto_method_name() { + let client = WebClientServiceClient::new(WebClientServiceJsonCallHandler); + + let snake_result = client + .json_call_method( + BaseController::default(), + "list_network_instance", + serde_json::json!({}), + ) + .await + .unwrap(); + assert_eq!( + snake_result["inst_ids"][0], + serde_json::json!({ + "part1": 1, + "part2": 2, + "part3": 3, + "part4": 4 + }) + ); + + let proto_result = client + .json_call_method( + BaseController::default(), + "ListNetworkInstance", + serde_json::json!({}), + ) + .await + .unwrap(); + assert_eq!(proto_result["inst_ids"].as_array().unwrap().len(), 1); + } + + #[tokio::test] + async fn web_client_service_call_json_method_rejects_unknown_method() { + let client = WebClientServiceClient::new(WebClientServiceJsonCallHandler); + let ret = client + .json_call_method( + BaseController::default(), + "not_exist_method", + serde_json::json!({}), + ) + .await; + assert!(ret.is_err()); + } + + #[test] + fn peer_route_pair_loss_rate_uses_default_conn() { + let default_conn_id = uuid::Uuid::new_v4(); + let pair = PeerRoutePair { + peer: Some(PeerInfo { + default_conn_id: Some(default_conn_id.into()), + conns: vec![ + PeerConnInfo { + conn_id: uuid::Uuid::new_v4().to_string(), + loss_rate: 0.8, + ..Default::default() + }, + PeerConnInfo { + conn_id: default_conn_id.to_string(), + loss_rate: 0.4, + ..Default::default() + }, + ], + ..Default::default() + }), + ..Default::default() + }; + + assert!( + pair.get_loss_rate() + .is_some_and(|loss_rate| (loss_rate - 0.4).abs() < 1e-6) + ); + } + + #[test] + fn peer_route_pair_loss_rate_falls_back_to_first_conn() { + let pair = PeerRoutePair { + peer: Some(PeerInfo { + conns: vec![ + PeerConnInfo { + conn_id: uuid::Uuid::new_v4().to_string(), + loss_rate: 0.0, + ..Default::default() + }, + PeerConnInfo { + conn_id: uuid::Uuid::new_v4().to_string(), + loss_rate: 0.7, + ..Default::default() + }, + ], + ..Default::default() + }), + ..Default::default() + }; + + assert_eq!(pair.get_loss_rate(), Some(0.0)); + } + + #[cfg(feature = "json-rpc")] + #[test] + fn peer_route_pair_json_omits_zero_loss_rate_and_preserves_nonzero_loss_rate() { + let pair = PeerRoutePair { + peer: Some(PeerInfo { + conns: vec![ + PeerConnInfo { + conn_id: "zero-loss".to_owned(), + loss_rate: 0.0, + ..Default::default() + }, + PeerConnInfo { + conn_id: "nonzero-loss".to_owned(), + loss_rate: 0.25, + ..Default::default() + }, + ], + ..Default::default() + }), + ..Default::default() + }; + + let json = serde_json::to_value(pair).unwrap(); + let conns = json["peer"]["conns"].as_array().unwrap(); + assert!(!conns[0].as_object().unwrap().contains_key("loss_rate")); + assert_eq!(conns[1]["loss_rate"], serde_json::json!(0.25)); + } + + #[cfg(feature = "json-rpc")] + #[test] + fn peer_route_pair_json_stun_info_uses_enum_names_and_omits_unknown_nat() { + use super::instance::Route; + use crate::proto::common::{NatType, StunInfo}; + + let known = PeerRoutePair { + route: Some(Route { + stun_info: Some(StunInfo { + udp_nat_type: NatType::FullCone as i32, + tcp_nat_type: NatType::NoPat as i32, + ..Default::default() + }), + ..Default::default() + }), + ..Default::default() + }; + let unknown = PeerRoutePair { + route: Some(Route { + stun_info: Some(StunInfo::default()), + ..Default::default() + }), + ..Default::default() + }; + + let known_json = serde_json::to_value(known).unwrap(); + assert_eq!( + known_json["route"]["stun_info"]["udp_nat_type"], + serde_json::json!("FullCone") + ); + assert_eq!( + known_json["route"]["stun_info"]["tcp_nat_type"], + serde_json::json!("NoPAT") + ); + + let unknown_json = serde_json::to_value(unknown).unwrap(); + assert_eq!(unknown_json["route"]["stun_info"], serde_json::json!({})); + } +} diff --git a/vendor/easytier/easytier-proto/src/common.rs b/vendor/easytier/easytier-proto/src/common.rs new file mode 100644 index 0000000..c2ad4d8 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/common.rs @@ -0,0 +1,659 @@ +use anyhow::Context; +use base64::{Engine as _, prelude::BASE64_STANDARD}; +use std::time::SystemTime; +use std::{ + fmt::{self, Display}, + str::FromStr, +}; + +const IP_SCHEMES: &[&str] = &["tcp", "udp", "wg", "quic", "ws", "wss", "faketcp"]; + +include!(concat!(env!("OUT_DIR"), "/common.rs")); +include!(concat!(env!("OUT_DIR"), "/common.serde.rs")); + +pub trait TimestampExt { + fn now() -> Self; +} + +#[cfg(feature = "json-rpc")] +pub type RuntimeTimestamp = prost_wkt_types::Timestamp; +#[cfg(not(feature = "json-rpc"))] +pub type RuntimeTimestamp = prost_types::Timestamp; + +impl TimestampExt for RuntimeTimestamp { + fn now() -> Self { + SystemTime::now().into() + } +} + +impl From for Uuid { + fn from(uuid: uuid::Uuid) -> Self { + let (high, low) = uuid.as_u64_pair(); + Uuid { + part1: (high >> 32) as u32, + part2: (high & 0xFFFFFFFF) as u32, + part3: (low >> 32) as u32, + part4: (low & 0xFFFFFFFF) as u32, + } + } +} + +impl From for uuid::Uuid { + fn from(uuid: Uuid) -> Self { + uuid::Uuid::from_u64_pair( + (u64::from(uuid.part1) << 32) | u64::from(uuid.part2), + (u64::from(uuid.part3) << 32) | u64::from(uuid.part4), + ) + } +} + +impl From for Uuid { + fn from(value: String) -> Self { + uuid::Uuid::parse_str(&value).unwrap().into() + } +} + +impl fmt::Display for Uuid { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", uuid::Uuid::from(*self)) + } +} + +impl fmt::Debug for Uuid { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", uuid::Uuid::from(*self)) + } +} + +impl From for Ipv4Addr { + fn from(value: std::net::Ipv4Addr) -> Self { + Self { + addr: u32::from_be_bytes(value.octets()), + } + } +} + +impl From for std::net::Ipv4Addr { + fn from(value: Ipv4Addr) -> Self { + std::net::Ipv4Addr::from(value.addr) + } +} + +impl Display for Ipv4Addr { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", std::net::Ipv4Addr::from(self.addr)) + } +} + +impl From for Ipv6Addr { + fn from(value: std::net::Ipv6Addr) -> Self { + let b = value.octets(); + Self { + part1: u32::from_be_bytes([b[0], b[1], b[2], b[3]]), + part2: u32::from_be_bytes([b[4], b[5], b[6], b[7]]), + part3: u32::from_be_bytes([b[8], b[9], b[10], b[11]]), + part4: u32::from_be_bytes([b[12], b[13], b[14], b[15]]), + } + } +} + +impl From for std::net::Ipv6Addr { + fn from(value: Ipv6Addr) -> Self { + let part1 = value.part1.to_be_bytes(); + let part2 = value.part2.to_be_bytes(); + let part3 = value.part3.to_be_bytes(); + let part4 = value.part4.to_be_bytes(); + std::net::Ipv6Addr::from([ + part1[0], part1[1], part1[2], part1[3], part2[0], part2[1], part2[2], part2[3], + part3[0], part3[1], part3[2], part3[3], part4[0], part4[1], part4[2], part4[3], + ]) + } +} + +impl Display for Ipv6Addr { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", std::net::Ipv6Addr::from(*self)) + } +} + +impl From for Ipv4Inet { + fn from(value: cidr::Ipv4Inet) -> Self { + Ipv4Inet { + address: Some(value.address().into()), + network_length: value.network_length() as u32, + } + } +} + +impl From for IpAddr { + fn from(value: std::net::IpAddr) -> Self { + match value { + std::net::IpAddr::V4(v4) => IpAddr { + ip: Some(ip_addr::Ip::Ipv4(Ipv4Addr::from(v4))), + }, + std::net::IpAddr::V6(v6) => IpAddr { + ip: Some(ip_addr::Ip::Ipv6(Ipv6Addr::from(v6))), + }, + } + } +} + +impl From for std::net::IpAddr { + fn from(value: IpAddr) -> Self { + match value.ip { + Some(ip_addr::Ip::Ipv4(v4)) => std::net::IpAddr::V4(v4.into()), + Some(ip_addr::Ip::Ipv6(v6)) => std::net::IpAddr::V6(v6.into()), + None => panic!("IpAddr is None"), + } + } +} + +impl Display for IpAddr { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", std::net::IpAddr::from(*self)) + } +} + +impl FromStr for IpAddr { + type Err = anyhow::Error; + + fn from_str(s: &str) -> Result { + Ok(IpAddr::from(std::net::IpAddr::from_str(s)?)) + } +} + +impl From for cidr::Ipv4Inet { + fn from(value: Ipv4Inet) -> Self { + cidr::Ipv4Inet::new( + value.address.unwrap_or_default().into(), + value.network_length as u8, + ) + .unwrap() + } +} + +impl From for cidr::Ipv4Cidr { + fn from(value: Ipv4Inet) -> Self { + cidr::Ipv4Cidr::new( + value.address.unwrap_or_default().into(), + value.network_length as u8, + ) + .unwrap() + } +} + +impl fmt::Display for Ipv4Inet { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", cidr::Ipv4Inet::from(*self)) + } +} + +impl FromStr for Ipv4Inet { + type Err = anyhow::Error; + + fn from_str(s: &str) -> Result { + Ok(Ipv4Inet::from( + cidr::Ipv4Inet::from_str(s).with_context(|| "Failed to parse Ipv4Inet")?, + )) + } +} + +impl From for Ipv6Inet { + fn from(value: cidr::Ipv6Inet) -> Self { + Ipv6Inet { + address: Some(value.address().into()), + network_length: value.network_length() as u32, + } + } +} + +impl From for cidr::Ipv6Inet { + fn from(value: Ipv6Inet) -> Self { + cidr::Ipv6Inet::new( + value.address.unwrap_or_default().into(), + value.network_length as u8, + ) + .unwrap() + } +} + +impl fmt::Display for Ipv6Inet { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", cidr::Ipv6Inet::from(*self)) + } +} + +impl FromStr for Ipv6Inet { + type Err = anyhow::Error; + + fn from_str(s: &str) -> Result { + Ok(Ipv6Inet::from( + cidr::Ipv6Inet::from_str(s).with_context(|| "Failed to parse Ipv6Inet")?, + )) + } +} + +impl From for IpInet { + fn from(value: cidr::IpInet) -> Self { + match value { + cidr::IpInet::V4(v4) => IpInet { + ip: Some(ip_inet::Ip::Ipv4(Ipv4Inet::from(v4))), + }, + cidr::IpInet::V6(v6) => IpInet { + ip: Some(ip_inet::Ip::Ipv6(Ipv6Inet::from(v6))), + }, + } + } +} + +impl From for cidr::IpInet { + fn from(value: IpInet) -> Self { + match value.ip { + Some(ip_inet::Ip::Ipv4(v4)) => cidr::IpInet::V4(v4.into()), + Some(ip_inet::Ip::Ipv6(v6)) => cidr::IpInet::V6(v6.into()), + None => panic!("IpInet is None"), + } + } +} + +impl Display for IpInet { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", cidr::IpInet::from(*self)) + } +} + +impl FromStr for IpInet { + type Err = anyhow::Error; + + fn from_str(s: &str) -> Result { + Ok(IpInet::from(cidr::IpInet::from_str(s)?)) + } +} + +impl From for Url { + fn from(value: url::Url) -> Self { + Url { url: value.into() } + } +} + +impl TryFrom<&Url> for url::Url { + type Error = url::ParseError; + + fn try_from(value: &Url) -> Result { + value.url.parse() + } +} + +impl From for url::Url { + fn from(value: Url) -> Self { + (&value).try_into().expect("failed to parse url") + } +} + +impl FromStr for Url { + type Err = url::ParseError; + + fn from_str(s: &str) -> Result { + url::Url::try_from(s).map(Into::into) + } +} + +impl fmt::Display for Url { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", self.url) + } +} + +fn split_tunnel_scheme(raw_scheme: &str) -> Option<(&str, &'static str, bool)> { + for &scheme in IP_SCHEMES { + if let Some(base) = raw_scheme.strip_suffix('6') + && let Some(prefix) = base.strip_suffix(scheme) + && (prefix.is_empty() || prefix.ends_with('-')) + { + return Some((prefix, scheme, true)); + } + + if let Some(prefix) = raw_scheme.strip_suffix(scheme) + && (prefix.is_empty() || prefix.ends_with('-')) + { + return Some((prefix, scheme, false)); + } + } + + None +} + +fn normalize_tunnel_scheme(raw_scheme: &str, is_ipv6: bool) -> Option { + let (prefix, scheme, had_ipv6_suffix) = split_tunnel_scheme(raw_scheme)?; + let suffix = if is_ipv6 || had_ipv6_suffix { "6" } else { "" }; + Some(format!("{prefix}{scheme}{suffix}")) +} + +fn infer_tunnel_ipv6(raw: &str) -> Option { + let (_, rest) = raw.split_once("://")?; + if rest.starts_with('[') { + return Some(true); + } + + match url::Url::parse(raw).ok()?.host() { + Some(url::Host::Ipv4(_)) => Some(false), + Some(url::Host::Ipv6(_)) => Some(true), + Some(url::Host::Domain(_)) | None => None, + } +} + +fn normalize_tunnel_port(raw_port: &str, is_ipv6: bool) -> Option { + if let Ok(port) = raw_port.parse::() { + return Some(port); + } + + if is_ipv6 && raw_port.ends_with('6') { + return raw_port[..raw_port.len() - 1].parse::().ok(); + } + + None +} + +fn normalize_tunnel_url(raw: &str, fallback_ipv6: Option) -> Option { + let (raw_scheme, rest) = raw.split_once("://")?; + + if let Some(rest) = rest.strip_prefix('[') { + let (host, remainder) = rest.split_once(']')?; + let scheme = normalize_tunnel_scheme(raw_scheme, true)?; + + if remainder.is_empty() { + return Some(format!("{scheme}://[{host}]")); + } + + let raw_port = remainder.strip_prefix(':')?; + let port = normalize_tunnel_port(raw_port, true)?; + return Some(format!("{scheme}://[{host}]:{port}")); + } + + let is_ipv6 = infer_tunnel_ipv6(raw).or(fallback_ipv6).unwrap_or(false); + let scheme = normalize_tunnel_scheme(raw_scheme, is_ipv6)?; + + if let Ok(url) = url::Url::parse(raw) { + let host = match url.host()? { + url::Host::Ipv4(host) => host.to_string(), + url::Host::Ipv6(host) => format!("[{host}]"), + url::Host::Domain(host) => host.to_string(), + }; + + return Some(match url.port_or_known_default() { + Some(port) => format!("{scheme}://{host}:{port}"), + None => format!("{scheme}://{host}"), + }); + } + + let (host, raw_port) = rest.rsplit_once(':')?; + let port = normalize_tunnel_port(raw_port, is_ipv6)?; + Some(format!("{scheme}://{host}:{port}")) +} + +impl Url { + pub fn is_ipv6_tunnel_endpoint(&self) -> bool { + infer_tunnel_ipv6(&self.url).unwrap_or(false) + } + + pub fn normalized_tunnel_display(&self) -> String { + normalize_tunnel_url(&self.url, None).unwrap_or_else(|| self.url.clone()) + } +} + +impl From for SocketAddr { + fn from(value: std::net::SocketAddr) -> Self { + match value { + std::net::SocketAddr::V4(v4) => SocketAddr { + ip: Some(socket_addr::Ip::Ipv4((*v4.ip()).into())), + port: v4.port() as u32, + }, + std::net::SocketAddr::V6(v6) => SocketAddr { + ip: Some(socket_addr::Ip::Ipv6((*v6.ip()).into())), + port: v6.port() as u32, + }, + } + } +} + +impl From for std::net::SocketAddr { + fn from(value: SocketAddr) -> Self { + if value.ip.is_none() { + return "0.0.0.0:0".parse().unwrap(); + } + match value.ip.unwrap() { + socket_addr::Ip::Ipv4(ip) => std::net::SocketAddr::V4(std::net::SocketAddrV4::new( + std::net::Ipv4Addr::from(ip), + value.port as u16, + )), + socket_addr::Ip::Ipv6(ip) => std::net::SocketAddr::V6(std::net::SocketAddrV6::new( + std::net::Ipv6Addr::from(ip), + value.port as u16, + 0, + 0, + )), + } + } +} + +impl Display for SocketAddr { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", std::net::SocketAddr::from(*self)) + } +} + +impl TunnelInfo { + pub fn effective_remote_addr(&self) -> Option<&Url> { + self.resolved_remote_addr + .as_ref() + .or(self.remote_addr.as_ref()) + } + + pub fn display_tunnel_type(&self) -> String { + let is_ipv6 = infer_tunnel_ipv6(&self.tunnel_type).or_else(|| { + self.resolved_remote_addr + .as_ref() + .or(self.local_addr.as_ref()) + .or(self.remote_addr.as_ref()) + .map(Url::is_ipv6_tunnel_endpoint) + }); + + if self.tunnel_type.contains("://") { + normalize_tunnel_url(&self.tunnel_type, is_ipv6) + .unwrap_or_else(|| self.tunnel_type.clone()) + } else { + is_ipv6 + .and_then(|is_ipv6| normalize_tunnel_scheme(&self.tunnel_type, is_ipv6)) + .unwrap_or_else(|| self.tunnel_type.clone()) + } + } + + pub fn display_remote_addr(&self) -> Option { + self.effective_remote_addr() + .map(Url::normalized_tunnel_display) + } +} + +impl fmt::Debug for Ipv4Addr { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + let std_ipv4_addr = std::net::Ipv4Addr::from(*self); + write!(f, "{}", std_ipv4_addr) + } +} + +impl fmt::Debug for Ipv6Addr { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + let std_ipv6_addr = std::net::Ipv6Addr::from(*self); + write!(f, "{}", std_ipv6_addr) + } +} + +impl SecureModeConfig { + pub fn private_key(&self) -> anyhow::Result { + let local_private_key = self + .local_private_key + .as_ref() + .ok_or_else(|| anyhow::anyhow!("local private key is not set"))?; + let k = BASE64_STANDARD + .decode(local_private_key) + .with_context(|| format!("failed to decode private key: {}", local_private_key))?; + // convert vec to 32b array + let len = k.len(); + let k: [u8; 32] = k + .try_into() + .map_err(|_| anyhow::anyhow!("invalid private key length: {}", len))?; + Ok(x25519_dalek::StaticSecret::from(k)) + } + + pub fn public_key(&self) -> anyhow::Result { + let local_public_key = self + .local_public_key + .as_ref() + .ok_or_else(|| anyhow::anyhow!("local public key is not set"))?; + let k = BASE64_STANDARD + .decode(local_public_key) + .with_context(|| format!("failed to decode public key: {}", local_public_key))?; + // convert vec to 32b array + let len = k.len(); + let k: [u8; 32] = k + .try_into() + .map_err(|_| anyhow::anyhow!("invalid public key length: {}", len))?; + Ok(x25519_dalek::PublicKey::from(k)) + } +} + +#[cfg(test)] +mod tests { + use super::{TunnelInfo, Url, normalize_tunnel_url}; + + fn assert_ipv6_tunnel_normalization(scheme: &str, port: u16) { + let expected = format!("{scheme}6://[2001:db8::1]:{port}"); + assert_eq!( + normalize_tunnel_url(&format!("{scheme}://[2001:db8::1]:{port}"), None).as_deref(), + Some(expected.as_str()) + ); + } + + #[test] + fn normalize_plain_ipv6_tunnel_url() { + let url = Url { + url: "tcp://[2001:db8::1]:11010".to_string(), + }; + + assert_eq!( + url.normalized_tunnel_display(), + "tcp6://[2001:db8::1]:11010" + ); + assert!(url.is_ipv6_tunnel_endpoint()); + } + + #[test] + fn normalize_all_ipv6_tunnel_urls() { + assert_ipv6_tunnel_normalization("tcp", 11010); + assert_ipv6_tunnel_normalization("udp", 11010); + assert_ipv6_tunnel_normalization("wg", 11011); + assert_ipv6_tunnel_normalization("quic", 11012); + assert_ipv6_tunnel_normalization("ws", 80); + assert_ipv6_tunnel_normalization("wss", 443); + assert_ipv6_tunnel_normalization("faketcp", 11013); + } + + #[test] + fn normalize_composite_ipv6_tunnel_url() { + assert_eq!( + normalize_tunnel_url("txt-tcp://[2001:db8::1]:11010", None).as_deref(), + Some("txt-tcp6://[2001:db8::1]:11010") + ); + } + + #[test] + fn recover_malformed_composite_ipv6_tunnel_url() { + assert_eq!( + normalize_tunnel_url("txt-tcp://[2001:db8::1]:110106", None).as_deref(), + Some("txt-tcp6://[2001:db8::1]:11010") + ); + } + + #[test] + fn keep_normalized_ipv6_tunnel_url_stable() { + assert_eq!( + normalize_tunnel_url("tcp6://[2001:db8::1]:11010", None).as_deref(), + Some("tcp6://[2001:db8::1]:11010") + ); + } + + #[test] + fn normalize_ipv6_tunnel_url_without_explicit_port() { + assert_eq!( + normalize_tunnel_url("tcp://[2001:db8::1]", None).as_deref(), + Some("tcp6://[2001:db8::1]") + ); + } + + #[test] + fn keep_domain_host_unbracketed_when_ipv6_falls_back() { + assert_eq!( + normalize_tunnel_url("tcp://localhost:11010", Some(true)).as_deref(), + Some("tcp6://localhost:11010") + ); + } + + #[test] + fn tunnel_info_display_tunnel_type_preserves_composite_prefix() { + let tunnel = TunnelInfo { + tunnel_type: "txt-tcp://[2001:db8::2]:110106".to_string(), + local_addr: None, + remote_addr: Some(Url { + url: "txt://et.example.com".to_string(), + }), + resolved_remote_addr: None, + }; + + assert_eq!( + tunnel.display_tunnel_type(), + "txt-tcp6://[2001:db8::2]:11010" + ); + } + + #[test] + fn tunnel_info_display_tunnel_type_uses_remote_addr_fallback() { + let tunnel = TunnelInfo { + tunnel_type: "tcp".to_string(), + local_addr: None, + remote_addr: Some(Url { + url: "tcp://[2001:db8::2]:11010".to_string(), + }), + resolved_remote_addr: None, + }; + + assert_eq!(tunnel.display_tunnel_type(), "tcp6"); + assert_eq!( + tunnel.display_remote_addr().as_deref(), + Some("tcp6://[2001:db8::2]:11010") + ); + } + + #[test] + fn tunnel_info_prefers_resolved_remote_addr() { + let tunnel = TunnelInfo { + tunnel_type: "txt-tcp".to_string(), + local_addr: None, + remote_addr: Some(Url { + url: "txt://et.example.com".to_string(), + }), + resolved_remote_addr: Some(Url { + url: "tcp://[2001:db8::3]:11010".to_string(), + }), + }; + + assert_eq!(tunnel.display_tunnel_type(), "txt-tcp6"); + assert_eq!( + tunnel.display_remote_addr().as_deref(), + Some("tcp6://[2001:db8::3]:11010") + ); + assert_eq!( + tunnel.effective_remote_addr().map(|url| url.url.as_str()), + Some("tcp://[2001:db8::3]:11010") + ); + } +} diff --git a/vendor/easytier/easytier-proto/src/core_config.rs b/vendor/easytier/easytier-proto/src/core_config.rs new file mode 100644 index 0000000..1076a78 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/core_config.rs @@ -0,0 +1,3 @@ +include!(concat!(env!("OUT_DIR"), "/core_config.rs")); +#[cfg(feature = "json-rpc")] +include!(concat!(env!("OUT_DIR"), "/core_config.serde.rs")); diff --git a/vendor/easytier/easytier-proto/src/core_peer.rs b/vendor/easytier/easytier-proto/src/core_peer.rs new file mode 100644 index 0000000..18fca64 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/core_peer.rs @@ -0,0 +1,5 @@ +pub mod peer { + include!(concat!(env!("OUT_DIR"), "/core.peer.rs")); + #[cfg(feature = "json-rpc")] + include!(concat!(env!("OUT_DIR"), "/core.peer.serde.rs")); +} diff --git a/vendor/easytier/easytier-proto/src/error.rs b/vendor/easytier/easytier-proto/src/error.rs new file mode 100644 index 0000000..712b4fe --- /dev/null +++ b/vendor/easytier/easytier-proto/src/error.rs @@ -0,0 +1,81 @@ +#![allow(clippy::module_inception)] + +use super::rpc_types; + +include!(concat!(env!("OUT_DIR"), "/error.rs")); +include!(concat!(env!("OUT_DIR"), "/error.serde.rs")); + +impl From<&rpc_types::error::Error> for Error { + fn from(e: &rpc_types::error::Error) -> Self { + use super::error::error::ErrorKind as ProtoError; + match e { + rpc_types::error::Error::ExecutionError(e) => Self { + error_kind: Some(ProtoError::ExecuteError(ExecuteError { + error_message: format!("{:?}", e), + })), + }, + rpc_types::error::Error::DecodeError => Self { + error_kind: Some(ProtoError::ProstDecodeError(ProstDecodeError {})), + }, + rpc_types::error::Error::EncodeError => Self { + error_kind: Some(ProtoError::ProstEncodeError(ProstEncodeError {})), + }, + rpc_types::error::Error::InvalidMethodIndex(m, s) => Self { + error_kind: Some(ProtoError::InvalidMethodIndex(InvalidMethodIndex { + method_index: *m as u32, + service_name: format!("{:?}", s), + })), + }, + rpc_types::error::Error::InvalidServiceKey(s, _) => Self { + error_kind: Some(ProtoError::InvalidService(InvalidService { + service_name: format!("{:?}", s), + })), + }, + rpc_types::error::Error::MalformatRpcPacket(e) => Self { + error_kind: Some(ProtoError::MalformatRpcPacket(MalformatRpcPacket { + error_message: format!("{:?}", e), + })), + }, + rpc_types::error::Error::Timeout(e) => Self { + error_kind: Some(ProtoError::Timeout(Timeout { + error_message: format!("{:?}", e), + })), + }, + #[allow(unreachable_patterns)] + e => Self { + error_kind: Some(ProtoError::OtherError(OtherError { + error_message: format!("{:?}", e), + })), + }, + } + } +} + +impl From<&Error> for rpc_types::error::Error { + fn from(e: &Error) -> Self { + use super::error::error::ErrorKind as ProtoError; + match &e.error_kind { + Some(ProtoError::ExecuteError(e)) => { + Self::ExecutionError(anyhow::anyhow!(e.error_message.clone())) + } + Some(ProtoError::ProstDecodeError(_)) => Self::DecodeError, + Some(ProtoError::ProstEncodeError(_)) => Self::EncodeError, + Some(ProtoError::InvalidMethodIndex(e)) => { + Self::InvalidMethodIndex(e.method_index as u8, e.service_name.clone()) + } + Some(ProtoError::InvalidService(e)) => { + Self::InvalidServiceKey(e.service_name.clone(), "".to_string()) + } + Some(ProtoError::MalformatRpcPacket(e)) => { + Self::MalformatRpcPacket(e.error_message.clone()) + } + Some(ProtoError::Timeout(e)) => { + Self::ExecutionError(anyhow::anyhow!(e.error_message.clone())) + } + Some(ProtoError::OtherError(e)) => { + Self::ExecutionError(anyhow::anyhow!(e.error_message.clone())) + } + None => Self::ExecutionError(anyhow::anyhow!("unknown error {:?}", e)), + } + } +} diff --git a/vendor/easytier/easytier-proto/src/lib.rs b/vendor/easytier/easytier-proto/src/lib.rs new file mode 100644 index 0000000..e99019f --- /dev/null +++ b/vendor/easytier/easytier-proto/src/lib.rs @@ -0,0 +1,33 @@ +#[cfg(feature = "core")] +pub mod rpc_types; + +#[cfg(feature = "core")] +pub mod acl; +#[cfg(feature = "api")] +pub mod api; +#[cfg(feature = "core")] +pub mod common; +#[cfg(feature = "core")] +pub mod core_config; +#[cfg(feature = "core")] +pub mod core_peer; +#[cfg(feature = "core")] +pub mod error; +#[cfg(all(feature = "api", feature = "magic-dns"))] +pub mod magic_dns; +#[cfg(feature = "core")] +pub mod peer_rpc; +#[cfg(feature = "api")] +pub mod tests; +#[cfg(feature = "api")] +pub mod web; + +pub const DESCRIPTOR_POOL_BYTES: &[u8] = + include_bytes!(concat!(env!("OUT_DIR"), "/file_descriptor_set.bin")); + +pub const ALL_DESCRIPTOR_BYTES: &[u8] = + include_bytes!(concat!(env!("OUT_DIR"), "/descriptors.bin")); + +pub mod proto { + pub use crate::*; +} diff --git a/vendor/easytier/easytier-proto/src/magic_dns.rs b/vendor/easytier/easytier-proto/src/magic_dns.rs new file mode 100644 index 0000000..bac0b1a --- /dev/null +++ b/vendor/easytier/easytier-proto/src/magic_dns.rs @@ -0,0 +1,3 @@ +include!(concat!(env!("OUT_DIR"), "/magic_dns.rs")); +#[cfg(feature = "json-rpc")] +include!(concat!(env!("OUT_DIR"), "/magic_dns.serde.rs")); diff --git a/vendor/easytier/easytier-proto/src/peer_rpc.rs b/vendor/easytier/easytier-proto/src/peer_rpc.rs new file mode 100644 index 0000000..93a8dae --- /dev/null +++ b/vendor/easytier/easytier-proto/src/peer_rpc.rs @@ -0,0 +1,512 @@ +use hmac::{Hmac, Mac}; +use prost::Message; +use sha2::Sha256; +#[cfg(feature = "api")] +use std::collections::BTreeMap; +use std::collections::BTreeSet; + +type PeerId = u32; + +include!(concat!(env!("OUT_DIR"), "/peer_rpc.rs")); +#[cfg(feature = "json-rpc")] +include!(concat!(env!("OUT_DIR"), "/peer_rpc.serde.rs")); + +impl PeerGroupInfo { + pub fn generate_with_proof(group_name: String, group_secret: String, peer_id: PeerId) -> Self { + let mut mac = Hmac::::new_from_slice(group_secret.as_bytes()) + .expect("HMAC can take key of any size"); + + let mut data_to_sign = group_name.as_bytes().to_vec(); + data_to_sign.push(0x00); // Add a delimiter byte + data_to_sign.extend_from_slice(&peer_id.to_be_bytes()); + + mac.update(&data_to_sign); + + let proof = mac.finalize().into_bytes().to_vec(); + + PeerGroupInfo { + group_name, + group_proof: proof, + } + } + + pub fn verify(&self, group_secret: &str, peer_id: PeerId) -> bool { + let mut verifier = Hmac::::new_from_slice(group_secret.as_bytes()) + .expect("HMAC can take key of any size"); + + let mut data_to_sign = self.group_name.as_bytes().to_vec(); + data_to_sign.push(0x00); // Add a delimiter byte + data_to_sign.extend_from_slice(&peer_id.to_be_bytes()); + + verifier.update(&data_to_sign); + + verifier.verify_slice(&self.group_proof).is_ok() + } +} + +impl TrustedCredentialPubkeyProof { + pub fn generate_credential_hmac_from_bytes( + credential_bytes: &[u8], + network_secret: &str, + ) -> Vec { + let mut mac = Hmac::::new_from_slice(network_secret.as_bytes()) + .expect("HMAC can take key of any size"); + mac.update(b"easytier credential proof"); + mac.update(credential_bytes); + mac.finalize().into_bytes().to_vec() + } + + pub fn generate_credential_hmac( + credential: &TrustedCredentialPubkey, + network_secret: &str, + ) -> Vec { + Self::generate_credential_hmac_from_bytes(&credential.encode_to_vec(), network_secret) + } + + pub fn new_signed(credential: TrustedCredentialPubkey, network_secret: &str) -> Self { + let credential_hmac = Self::generate_credential_hmac(&credential, network_secret); + Self { + credential: Some(credential), + credential_hmac, + } + } + + pub fn verify_credential_hmac(&self, network_secret: &str) -> bool { + let Some(credential) = self.credential.as_ref() else { + return false; + }; + self.verify_credential_hmac_with_bytes(&credential.encode_to_vec(), network_secret) + } + + pub fn verify_credential_hmac_with_bytes( + &self, + credential_bytes: &[u8], + network_secret: &str, + ) -> bool { + if self.credential_hmac.is_empty() { + return false; + } + + let mut mac = Hmac::::new_from_slice(network_secret.as_bytes()) + .expect("HMAC can take key of any size"); + mac.update(b"easytier credential proof"); + mac.update(credential_bytes); + mac.verify_slice(&self.credential_hmac).is_ok() + } +} + +impl From for sync_route_info_request::ConnInfo { + fn from(val: RouteConnBitmap) -> Self { + Self::ConnBitmap(val) + } +} + +impl From for sync_route_info_request::ConnInfo { + fn from(val: RouteConnPeerList) -> Self { + Self::ConnPeerList(val) + } +} + +#[cfg(feature = "api")] +impl From> for PeerInfoForGlobalMap { + fn from(peers: Vec) -> Self { + let mut peer_map = BTreeMap::new(); + for peer in peers { + let Some(min_lat) = peer + .conns + .iter() + .map(|conn| conn.stats.as_ref().unwrap().latency_us) + .min() + else { + continue; + }; + + let dp_info = DirectConnectedPeerInfo { + latency_ms: std::cmp::max(1, (min_lat as u32 / 1000) as i32), + }; + + peer_map.insert(peer.peer_id, dp_info); + } + PeerInfoForGlobalMap { + direct_peers: peer_map, + } + } +} + +impl From for crate::core_peer::peer::Route { + fn from(val: RoutePeerInfo) -> Self { + let network_length = if val.network_length == 0 { + 24 + } else { + val.network_length + }; + + crate::core_peer::peer::Route { + peer_id: val.peer_id, + ipv4_addr: val.ipv4_addr.map(|ipv4_addr| crate::common::Ipv4Inet { + address: Some(ipv4_addr), + network_length, + }), + next_hop_peer_id: 0, + cost: 0, + path_latency: 0, + proxy_cidrs: val.proxy_cidrs.clone(), + hostname: val.hostname.unwrap_or_default(), + stun_info: { + let mut stun_info = crate::common::StunInfo::default(); + if let Ok(udp_nat_type) = crate::common::NatType::try_from(val.udp_nat_type) { + stun_info.set_udp_nat_type(udp_nat_type); + } + if let Ok(tcp_nat_type) = crate::common::NatType::try_from(val.tcp_nat_type) { + stun_info.set_tcp_nat_type(tcp_nat_type); + } + Some(stun_info) + }, + inst_id: val.inst_id.map(|x| x.to_string()).unwrap_or_default(), + version: val.easytier_version, + feature_flag: val.feature_flag, + + next_hop_peer_id_latency_first: None, + cost_latency_first: None, + path_latency_latency_first: None, + + ipv6_addr: val.ipv6_addr, + public_ipv6_addr: val.ipv6_public_addr_lease, + ipv6_public_addr_prefix: val.ipv6_public_addr_prefix, + } + } +} + +#[cfg(feature = "api")] +impl From for crate::api::instance::Route { + fn from(val: RoutePeerInfo) -> Self { + let network_length = if val.network_length == 0 { + 24 + } else { + val.network_length + }; + + crate::api::instance::Route { + peer_id: val.peer_id, + ipv4_addr: val.ipv4_addr.map(|ipv4_addr| crate::common::Ipv4Inet { + address: Some(ipv4_addr), + network_length, + }), + next_hop_peer_id: 0, + cost: 0, + path_latency: 0, + proxy_cidrs: val.proxy_cidrs.clone(), + hostname: val.hostname.unwrap_or_default(), + stun_info: { + let mut stun_info = crate::common::StunInfo::default(); + if let Ok(udp_nat_type) = crate::common::NatType::try_from(val.udp_nat_type) { + stun_info.set_udp_nat_type(udp_nat_type); + } + if let Ok(tcp_nat_type) = crate::common::NatType::try_from(val.tcp_nat_type) { + stun_info.set_tcp_nat_type(tcp_nat_type); + } + Some(stun_info) + }, + inst_id: val.inst_id.map(|x| x.to_string()).unwrap_or_default(), + version: val.easytier_version, + feature_flag: val.feature_flag, + + next_hop_peer_id_latency_first: None, + cost_latency_first: None, + path_latency_latency_first: None, + + ipv6_addr: val.ipv6_addr, + public_ipv6_addr: val.ipv6_public_addr_lease, + ipv6_public_addr_prefix: val.ipv6_public_addr_prefix, + } + } +} + +impl RouteConnBitmap { + pub fn get_bit(&self, idx: usize) -> bool { + let byte_idx = idx / 8; + let bit_idx = idx % 8; + let byte = self.bitmap[byte_idx]; + (byte >> bit_idx) & 1 == 1 + } + + pub fn get_connected_peers(&self, peer_idx: usize) -> BTreeSet { + let mut connected_peers = BTreeSet::new(); + for (idx, peer_id_version) in self.peer_ids.iter().enumerate() { + if self.get_bit(peer_idx * self.peer_ids.len() + idx) { + connected_peers.insert(peer_id_version.peer_id); + } + } + connected_peers + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_peer_group_info_new() { + let group_name = "test_group".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name.clone(), group_secret, peer_id); + + assert_eq!(peer_group_info.group_name, group_name); + assert!(!peer_group_info.group_proof.is_empty()); + // HMAC-SHA256 produces a 32-byte output + assert_eq!(peer_group_info.group_proof.len(), 32); + } + + #[test] + fn test_peer_group_info_verify_valid() { + let group_name = "test_group".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name, group_secret.clone(), peer_id); + + // Verification should succeed using the same secret and peer_id + assert!(peer_group_info.verify(&group_secret, peer_id)); + } + + #[test] + fn test_peer_group_info_verify_invalid_secret() { + let group_name = "test_group".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + + let peer_group_info = PeerGroupInfo::generate_with_proof(group_name, group_secret, peer_id); + + // Verification should fail with a wrong secret + assert!(!peer_group_info.verify("wrong_secret", peer_id)); + } + + #[test] + fn test_peer_group_info_verify_invalid_peer_id() { + let group_name = "test_group".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name, group_secret.clone(), peer_id); + + // Verification should fail with a wrong peer_id + assert!(!peer_group_info.verify(&group_secret, 999u32)); + } + + #[test] + fn test_peer_group_info_different_groups_different_proofs() { + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + + let group1 = + PeerGroupInfo::generate_with_proof("group1".to_string(), group_secret.clone(), peer_id); + let group2 = + PeerGroupInfo::generate_with_proof("group2".to_string(), group_secret, peer_id); + + // Different group names should produce different proofs + assert_ne!(group1.group_proof, group2.group_proof); + } + + #[test] + fn test_peer_group_info_same_params_same_proof() { + let group_name = "test_group".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + + let group1 = + PeerGroupInfo::generate_with_proof(group_name.clone(), group_secret.clone(), peer_id); + let group2 = PeerGroupInfo::generate_with_proof(group_name, group_secret, peer_id); + + // Same parameters should produce the same proof + assert_eq!(group1.group_proof, group2.group_proof); + } + + #[test] + fn test_peer_group_info_empty_group_name() { + let group_name = "".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name.clone(), group_secret.clone(), peer_id); + + assert_eq!(peer_group_info.group_name, group_name); + assert!(peer_group_info.verify(&group_secret, peer_id)); + } + + #[test] + fn test_peer_group_info_empty_secret() { + let group_name = "test_group".to_string(); + let group_secret = "".to_string(); + let peer_id = 42u32; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name, group_secret.clone(), peer_id); + + assert!(peer_group_info.verify(&group_secret, peer_id)); + } + + #[test] + fn test_peer_group_info_unicode_group_name() { + let group_name = "测试组🚀".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name.clone(), group_secret.clone(), peer_id); + + assert_eq!(peer_group_info.group_name, group_name); + assert!(peer_group_info.verify(&group_secret, peer_id)); + } + + #[test] + fn test_peer_group_info_unicode_secret() { + let group_name = "test_group".to_string(); + let group_secret = "密码123🔐".to_string(); + let peer_id = 42u32; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name, group_secret.clone(), peer_id); + + assert!(peer_group_info.verify(&group_secret, peer_id)); + } + + #[test] + fn test_peer_group_info_zero_peer_id() { + let group_name = "test_group".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 0u32; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name, group_secret.clone(), peer_id); + + assert!(peer_group_info.verify(&group_secret, peer_id)); + } + + #[test] + fn test_peer_group_info_max_peer_id() { + let group_name = "test_group".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = u32::MAX; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name, group_secret.clone(), peer_id); + + assert!(peer_group_info.verify(&group_secret, peer_id)); + } + + #[test] + #[ignore] + fn perf_test_generate_with_proof() { + let group_name = "test_group".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + let iterations = 100000; + + let start = std::time::Instant::now(); + for _ in 0..iterations { + let _ = PeerGroupInfo::generate_with_proof( + group_name.clone(), + group_secret.clone(), + peer_id, + ); + } + let duration = start.elapsed(); + + println!( + "generate_with_proof took {:?} for {} iterations", + duration, iterations + ); + println!("Avg time per iteration: {:?}", duration / iterations as u32); + } + + #[test] + #[ignore] + fn perf_test_verify() { + let group_name = "test_group".to_string(); + let group_secret = "secret123".to_string(); + let peer_id = 42u32; + let iterations = 100000; + + let peer_group_info = + PeerGroupInfo::generate_with_proof(group_name, group_secret.clone(), peer_id); + + let start = std::time::Instant::now(); + for _ in 0..iterations { + assert!(peer_group_info.verify(&group_secret, peer_id)); + } + let duration = start.elapsed(); + + println!("verify took {:?} for {} iterations", duration, iterations); + println!("Avg time per iteration: {:?}", duration / iterations as u32); + } + + #[test] + fn test_trusted_credential_pubkey_hmac_valid() { + let credential = TrustedCredentialPubkey { + pubkey: vec![7u8; 32], + groups: vec!["ops".to_string(), "guest".to_string()], + allow_relay: true, + expiry_unix: 123456, + allowed_proxy_cidrs: vec!["10.0.0.0/24".to_string()], + reusable: Some(true), + }; + let tc = TrustedCredentialPubkeyProof::new_signed(credential, "sec-1"); + + assert!(tc.verify_credential_hmac("sec-1")); + assert!(!tc.verify_credential_hmac("sec-2")); + } + + #[test] + fn test_trusted_credential_pubkey_hmac_tampered() { + let credential = TrustedCredentialPubkey { + pubkey: vec![8u8; 32], + groups: vec!["g1".to_string()], + allow_relay: false, + expiry_unix: 1, + allowed_proxy_cidrs: vec![], + reusable: Some(true), + }; + let tc = TrustedCredentialPubkeyProof::new_signed(credential, "sec-1"); + + let mut tampered = tc.clone(); + tampered.credential.as_mut().unwrap().allow_relay = true; + assert!(!tampered.verify_credential_hmac("sec-1")); + } + + #[test] + fn test_trusted_credential_pubkey_hmac_with_raw_bytes() { + let credential = TrustedCredentialPubkey { + pubkey: vec![9u8; 32], + groups: vec!["raw".to_string()], + allow_relay: true, + expiry_unix: 123456, + allowed_proxy_cidrs: vec![], + reusable: Some(true), + }; + + let mut raw_credential_bytes = credential.encode_to_vec(); + prost::encoding::encode_key( + 9999, + prost::encoding::WireType::Varint, + &mut raw_credential_bytes, + ); + prost::encoding::encode_varint(42, &mut raw_credential_bytes); + + let proof = TrustedCredentialPubkeyProof { + credential: Some(credential), + credential_hmac: TrustedCredentialPubkeyProof::generate_credential_hmac_from_bytes( + &raw_credential_bytes, + "sec-1", + ), + }; + + assert!(proof.verify_credential_hmac_with_bytes(&raw_credential_bytes, "sec-1")); + assert!(!proof.verify_credential_hmac("sec-1")); + } +} diff --git a/vendor/easytier/easytier-proto/src/rpc_types/__rt.rs b/vendor/easytier/easytier-proto/src/rpc_types/__rt.rs new file mode 100644 index 0000000..edb967e --- /dev/null +++ b/vendor/easytier/easytier-proto/src/rpc_types/__rt.rs @@ -0,0 +1,56 @@ +//! Utility functions used by generated code; this is *not* part of the crate's public API! +use bytes; +use prost; + +use super::controller; +use super::descriptor; +use super::descriptor::ServiceDescriptor; +use super::error; +use super::handler; +use super::handler::Handler; + +/// Efficiently decode a particular message type from a byte buffer. +pub fn decode(buf: bytes::Bytes) -> error::Result +where + M: prost::Message + Default, +{ + let message = prost::Message::decode(buf)?; + Ok(message) +} + +/// Efficiently encode a particular message into a byte buffer. +pub fn encode(message: M) -> error::Result +where + M: prost::Message, +{ + let len = prost::Message::encoded_len(&message); + let mut buf = ::bytes::BytesMut::with_capacity(len); + prost::Message::encode(&message, &mut buf)?; + Ok(buf.freeze()) +} + +pub async fn call_method( + handler: H, + ctrl: H::Controller, + method: ::Method, + input: I, +) -> super::error::Result +where + H: handler::Handler, + I: prost::Message, + O: prost::Message + Default, +{ + let input_bytes = encode(input)?; + let ret_msg = handler.call(ctrl, method, input_bytes).await?; + decode(ret_msg) +} + +pub trait RpcClientFactory: Clone + Send + Sync + 'static { + type Descriptor: ServiceDescriptor + Default; + type ClientImpl; + type Controller: controller::Controller; + + fn new( + handler: impl Handler, + ) -> Self::ClientImpl; +} diff --git a/vendor/easytier/easytier-proto/src/rpc_types/controller.rs b/vendor/easytier/easytier-proto/src/rpc_types/controller.rs new file mode 100644 index 0000000..fe04b8e --- /dev/null +++ b/vendor/easytier/easytier-proto/src/rpc_types/controller.rs @@ -0,0 +1,105 @@ +use std::sync::{Arc, Mutex}; + +use bytes::Bytes; + +use crate::proto::common::TunnelInfo; + +// Controller must impl clone and all cloned controllers share the same data +pub trait Controller: Send + Sync + Clone + 'static { + fn timeout_ms(&self) -> i32 { + 5000 + } + + fn set_timeout_ms(&mut self, _timeout_ms: i32) {} + + fn set_trace_id(&mut self, _trace_id: i32) {} + + fn trace_id(&self) -> i32 { + 0 + } + + fn set_raw_input(&mut self, _raw_input: Bytes) {} + fn get_raw_input(&self) -> Option { + None + } + + fn set_tunnel_info(&mut self, _tunnel_info: Option) {} + fn get_tunnel_info(&self) -> Option<&TunnelInfo> { + None + } + + fn set_raw_output(&mut self, _raw_output: Bytes) {} + fn get_raw_output(&self) -> Option { + None + } +} + +#[derive(Debug)] +pub struct BaseControllerRawData { + pub raw_input: Option, + pub raw_output: Option, +} + +#[derive(Debug, Clone)] +pub struct BaseController { + pub timeout_ms: i32, + pub trace_id: i32, + pub raw_data: Arc>, + pub tunnel_info: Option, +} + +impl Controller for BaseController { + fn timeout_ms(&self) -> i32 { + self.timeout_ms + } + + fn set_timeout_ms(&mut self, timeout_ms: i32) { + self.timeout_ms = timeout_ms; + } + + fn set_trace_id(&mut self, trace_id: i32) { + self.trace_id = trace_id; + } + + fn trace_id(&self) -> i32 { + self.trace_id + } + + fn set_raw_input(&mut self, raw_input: Bytes) { + self.raw_data.lock().unwrap().raw_input = Some(raw_input); + } + + fn get_raw_input(&self) -> Option { + self.raw_data.lock().unwrap().raw_input.clone() + } + + fn set_raw_output(&mut self, raw_output: Bytes) { + self.raw_data.lock().unwrap().raw_output = Some(raw_output); + } + + fn get_raw_output(&self) -> Option { + self.raw_data.lock().unwrap().raw_output.clone() + } + + fn get_tunnel_info(&self) -> Option<&TunnelInfo> { + self.tunnel_info.as_ref() + } + + fn set_tunnel_info(&mut self, tunnel_info: Option) { + self.tunnel_info = tunnel_info; + } +} + +impl Default for BaseController { + fn default() -> Self { + Self { + timeout_ms: 5000, + trace_id: 0, + raw_data: Arc::new(Mutex::new(BaseControllerRawData { + raw_input: None, + raw_output: None, + })), + tunnel_info: None, + } + } +} diff --git a/vendor/easytier/easytier-proto/src/rpc_types/descriptor.rs b/vendor/easytier/easytier-proto/src/rpc_types/descriptor.rs new file mode 100644 index 0000000..c051db8 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/rpc_types/descriptor.rs @@ -0,0 +1,50 @@ +//! Traits for defining generic service descriptor definitions. +//! +//! These traits are built on the assumption that some form of code generation is being used (e.g. +//! using only `&'static str`s) but it's of course possible to implement these traits manually. +use std::any; +use std::fmt; + +/// A descriptor for an available RPC service. +pub trait ServiceDescriptor: Clone + fmt::Debug + Send + Sync { + /// The associated type of method descriptors. + type Method: MethodDescriptor + fmt::Debug + TryFrom; + + /// The name of the service, used in Rust code and perhaps for human readability. + fn name(&self) -> &'static str; + + /// The raw protobuf name of the service. + fn proto_name(&self) -> &'static str; + + /// The package name of the service. + fn package(&self) -> &'static str { + "" + } + + /// All of the available methods on the service. + fn methods(&self) -> &'static [Self::Method]; +} + +/// A descriptor for a method available on an RPC service. +pub trait MethodDescriptor: Clone + Copy + fmt::Debug + Send + Sync { + /// The name of the service, used in Rust code and perhaps for human readability. + fn name(&self) -> &'static str; + + /// The raw protobuf name of the service. + fn proto_name(&self) -> &'static str; + + /// The Rust `TypeId` for the input that this method accepts. + fn input_type(&self) -> any::TypeId; + + /// The raw protobuf name for the input type that this method accepts. + fn input_proto_type(&self) -> &'static str; + + /// The Rust `TypeId` for the output that this method produces. + fn output_type(&self) -> any::TypeId; + + /// The raw protobuf name for the output type that this method produces. + fn output_proto_type(&self) -> &'static str; + + /// The index of the method in the service descriptor. + fn index(&self) -> u8; +} diff --git a/vendor/easytier/easytier-proto/src/rpc_types/error.rs b/vendor/easytier/easytier-proto/src/rpc_types/error.rs new file mode 100644 index 0000000..235d5c8 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/rpc_types/error.rs @@ -0,0 +1,49 @@ +//! Error type definitions for errors that can occur during RPC interactions. +use std::result; + +use prost; +use thiserror; + +#[derive(Debug, thiserror::Error)] +pub enum Error { + #[error("Rust error: {0}")] + ExecutionError(#[from] anyhow::Error), + + #[error("Decode error")] + DecodeError, + + #[error("Encode error")] + EncodeError, + + #[error("Invalid method index: {0}, service: {1}")] + InvalidMethodIndex(u8, String), + + #[error("Invalid service name: {0}, proto name: {1}")] + InvalidServiceKey(String, String), + + #[error("Invalid packet: {0}")] + MalformatRpcPacket(String), + + #[error("Timeout: {0}")] + Timeout(#[from] tokio::time::error::Elapsed), + + #[error("Tunnel error: {0}")] + TunnelError(String), + + #[error("Shutdown")] + Shutdown, +} + +impl From for Error { + fn from(_: prost::DecodeError) -> Self { + Error::DecodeError + } +} + +impl From for Error { + fn from(_: prost::EncodeError) -> Self { + Error::EncodeError + } +} + +pub type Result = result::Result; diff --git a/vendor/easytier/easytier-proto/src/rpc_types/handler.rs b/vendor/easytier/easytier-proto/src/rpc_types/handler.rs new file mode 100644 index 0000000..7a2c531 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/rpc_types/handler.rs @@ -0,0 +1,76 @@ +//! Traits for defining generic RPC handlers. +use crate::proto::rpc_types::descriptor::MethodDescriptor; + +use super::{ + controller::Controller, + descriptor::{self, ServiceDescriptor}, +}; +use bytes; + +/// An implementation of a specific RPC handler. +/// +/// This can be an actual implementation of a service, or something that will send a request over +/// a network to fulfill a request. +#[async_trait::async_trait] +pub trait Handler: Clone + Send + Sync + 'static { + /// The service descriptor for the service whose requests this handler can handle. + type Descriptor: descriptor::ServiceDescriptor + Default; + + type Controller: super::controller::Controller; + + /// Perform a raw call to the specified service and method. + async fn call( + &self, + ctrl: Self::Controller, + method: ::Method, + input: bytes::Bytes, + ) -> super::error::Result; + + fn service_descriptor(&self) -> Self::Descriptor { + Self::Descriptor::default() + } + + fn get_method_from_index( + &self, + index: u8, + ) -> super::error::Result<::Method> { + let desc = self.service_descriptor(); + ::Method::try_from(index) + .map_err(|_| super::error::Error::InvalidMethodIndex(index, desc.name().to_string())) + } +} + +#[async_trait::async_trait] +pub trait HandlerExt: Send + Sync + 'static { + type Controller; + + async fn call_method( + &self, + ctrl: Self::Controller, + method_index: u8, + input: bytes::Bytes, + ) -> super::error::Result; + + fn get_method_name(&self, method_index: u8) -> super::error::Result; +} + +#[async_trait::async_trait] +impl> HandlerExt for T { + type Controller = C; + + async fn call_method( + &self, + ctrl: Self::Controller, + method_index: u8, + input: bytes::Bytes, + ) -> super::error::Result { + let method = self.get_method_from_index(method_index)?; + self.call(ctrl, method, input).await + } + + fn get_method_name(&self, method_index: u8) -> super::error::Result { + let method = self.get_method_from_index(method_index)?; + let name = method.name().to_string(); + Ok(name) + } +} diff --git a/vendor/easytier/easytier-proto/src/rpc_types/mod.rs b/vendor/easytier/easytier-proto/src/rpc_types/mod.rs new file mode 100644 index 0000000..1f78d92 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/rpc_types/mod.rs @@ -0,0 +1,5 @@ +pub mod __rt; +pub mod controller; +pub mod descriptor; +pub mod error; +pub mod handler; diff --git a/vendor/easytier/easytier-proto/src/tests.rs b/vendor/easytier/easytier-proto/src/tests.rs new file mode 100644 index 0000000..e69f103 --- /dev/null +++ b/vendor/easytier/easytier-proto/src/tests.rs @@ -0,0 +1,2 @@ +include!(concat!(env!("OUT_DIR"), "/tests.rs")); +include!(concat!(env!("OUT_DIR"), "/tests.serde.rs")); diff --git a/vendor/easytier/easytier-proto/src/web.rs b/vendor/easytier/easytier-proto/src/web.rs new file mode 100644 index 0000000..2058b6d --- /dev/null +++ b/vendor/easytier/easytier-proto/src/web.rs @@ -0,0 +1,2 @@ +include!(concat!(env!("OUT_DIR"), "/web.rs")); +include!(concat!(env!("OUT_DIR"), "/web.serde.rs")); diff --git a/vendor/easytier/easytier/.clippy.toml b/vendor/easytier/easytier/.clippy.toml new file mode 100644 index 0000000..9ee4678 --- /dev/null +++ b/vendor/easytier/easytier/.clippy.toml @@ -0,0 +1,11 @@ +disallowed-methods = [ + { path = "itertools::Itertools::map_into", reason = "Blocks underlying iterator optimizations. Use the native `.map(Into::into)` instead." }, + { path = "itertools::Itertools::map_ok", reason = "Blocks underlying iterator optimizations. Use the native `.map(|r| r.map(f))` instead." }, + { path = "itertools::Itertools::filter_ok", reason = "Blocks underlying iterator optimizations. Use a native approach, e.g., `.filter(|r| r.as_ref().map_or(true, condition))`." }, + { path = "itertools::Itertools::filter_map_ok", reason = "Blocks underlying iterator optimizations. Use native `.map()` and `.flatten()`, or extract logic into a standard `.filter_map()`." }, + + { path = "itertools::Itertools::collect_vec", reason = "Non-standard idiom. Directly use the standard library's `.collect::>()`." }, + { path = "itertools::Itertools::try_collect", reason = "Non-standard idiom. Standard `collect()` already supports Result/Option inversion; use `.collect::>()`." }, + { path = "itertools::Itertools::set_from", reason = "Non-standard idiom. Directly use the `.extend()` method provided by the standard library's `Extend` trait." }, + { path = "itertools::Itertools::concat", reason = "Non-standard idiom. Use native `.flatten().collect()` or a slice's `.concat()` instead." } +] \ No newline at end of file diff --git a/vendor/easytier/easytier/Cargo.toml b/vendor/easytier/easytier/Cargo.toml new file mode 100644 index 0000000..4faee85 --- /dev/null +++ b/vendor/easytier/easytier/Cargo.toml @@ -0,0 +1,465 @@ +[package] +name = "easytier" +description = "A full meshed p2p VPN, connecting all your devices in one network with one command." +homepage = "https://github.com/EasyTier/EasyTier" +repository = "https://github.com/EasyTier/EasyTier" +version = "2.7.0" +edition.workspace = true +rust-version.workspace = true +authors = ["kkrainbow"] +keywords = ["vpn", "p2p", "network", "easytier"] +categories = ["network-programming", "command-line-utilities"] +license-file = "LICENSE" +readme = "README.md" +build = "build/main.rs" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[[bin]] +name = "easytier-core" +path = "src/easytier-core.rs" +test = false +required-features = ["management"] + +[[bin]] +name = "easytier-cli" +path = "src/easytier-cli.rs" +required-features = ["management", "cli"] + +[lib] +name = "easytier" +path = "src/lib.rs" + +[[bench]] +name = "packet_bytes_extraction" +harness = false + +[dependencies] +easytier-core.workspace = true +easytier-proto = { workspace = true, features = ["api", "core"] } +git-version = "0.3.9" + +tracing.workspace = true +log = { workspace = true, features = ["std"] } +tracing-subscriber = { workspace = true, features = [ + "registry", +], optional = true } +derive_more = { version = "2.1.1", features = ["full"] } +console-subscriber = { version = "0.5.0", optional = true } +indoc.workspace = true +paste = "1.0" +thiserror.workspace = true +crossbeam.workspace = true +arc-swap.workspace = true +toml.workspace = true +chrono = { workspace = true, features = ["serde"] } + +guarden.workspace = true +quanta.workspace = true + +strum = { workspace = true, features = ["derive"] } + +gethostname.workspace = true + +futures = { workspace = true, features = ["default", "bilock", "unstable"] } + +tokio = { workspace = true, features = [ + "fs", + "io-util", + "macros", + "net", + "process", + "rt", + "signal", + "sync", + "time", +] } +tokio-util = { workspace = true, features = ["codec", "net", "io", "rt"] } + +async-trait.workspace = true + +dashmap.workspace = true +moka = { version = "0.12", features = ["future"] } +# for full-path zero-copy +zerocopy = { workspace = true, features = ["derive", "simd"] } +bytes.workspace = true +pin-project-lite.workspace = true + +atomic_refcell = "0.1.14" +atomic-write-file = { version = "0.3.1", optional = true } + +quinn = { version = "0.11.12", optional = true, features = ["ring"] } +quinn-proto = { version = "0.11.18", optional = true } +seahash = { version = "4.1.0", optional = true } + +rustls = { workspace = true, features = [ + "ring", "tls12" +], optional = true } + +# for websocket +tokio-websockets = { version = "0.13.2", git = "https://github.com/EasyTier/tokio-websockets", optional = true, features = [ + "rustls-webpki-roots", + "client", + "server", + "fastrand", + "ring", +] } +forwarded-header-value = { version = "0.1.1", optional = true } +http = { version = "1", default-features = false, features = [ + "std", +], optional = true } +rcgen = { version = "0.14.10", optional = true } +tokio-rustls = { workspace = true, optional = true } + +# for tap device +tun = { package = "tun-easytier", git = "https://github.com/EasyTier/rust-tun", features = [ + "async", +], optional = true } +# for net ns +nix = { version = "0.31.3", features = [ + "sched", + "socket", + "ioctl", + "net", + "fs", +] } + +uuid = { workspace = true, features = [ + "v4", + "fast-rng", + "macro-diagnostics", + "serde", +] } + +# for ring tunnel +once_cell.workspace = true + +# for rpc +prost.workspace = true +anyhow.workspace = true + +url = { workspace = true, features = ["serde"] } +percent-encoding.workspace = true + +# for tun packet +byteorder = "1.5.0" + +# for proxy +cidr = { workspace = true, features = ["serde"] } +socket2 = { version = "0.6.5", features = ["all"] } + +# for hole punching +rand.workspace = true + +serde = { workspace = true, features = ["derive"] } +pnet_datalink = { version = "0.35.0", optional = true } +smoltcp = { workspace = true, optional = true, features = [ + "std", + "medium-ethernet", + "proto-ipv4", + "proto-ipv6", + "socket-raw", +] } +serde_json.workspace = true + +clap = { workspace = true, features = [ + "string", + "unicode", + "derive", + "wrap_help", + "env", +] } +clap_complete = { version = "4.6.10" } +clap_complete_nushell = { version = "4.6.2" } + +async-recursion = "1.1.1" + +network-interface = "2.0.5" + +# for wireguard +boringtun = { package = "boringtun-easytier", version = "0.6.1", optional = true } +# Share the workspace HMAC/SHA2 digest generation for WireGuard key derivation. +hkdf = { version = "0.12.4", optional = true } +sha2 = { workspace = true, optional = true } + +# for cli +tabled = { version = "0.22", optional = true } +humansize = { version = "2.1.3", optional = true } +terminal_size = { version = "0.4", optional = true } +unicode-width = { version = "0.2", optional = true } + +base64.workspace = true + +mimalloc = { workspace = true, optional = true } + +# mips +atomic-shim.workspace = true + +parking_lot.workspace = true + + +rust-i18n.workspace = true +sys-locale.workspace = true + + +service-manager = { git = "https://github.com/EasyTier/service-manager-rs.git", branch = "main" } + +kcp-sys = { git = "https://github.com/EasyTier/kcp-sys", rev = "268533568d734ae89dc89603078da3ca522effe1", optional = true } + +# for dns connector +hickory-resolver = { version = "0.25.2", optional = true } +hickory-proto = { version = "0.25.2", optional = true } + +# for magic dns +hickory-client = { version = "0.25.2", optional = true } +hickory-server = { version = "0.25.2", features = [ + "resolver", +], optional = true } + +bon.workspace = true +derive_builder = { version = "0.20.2", optional = true } +humantime-serde = { version = "1.1.1", optional = true } +shellexpand = "3.1.2" + +# for fake tcp +flume = { version = "0.12", optional = true } + +# for upnp +http-body-util = { workspace = true, optional = true } +hyper = { workspace = true, features = ["client", "http1"], optional = true } +hyper-util = { workspace = true, features = ["tokio"], optional = true } +natpmp = { version = "0.5.0", optional = true } +xmltree = { version = "0.12", optional = true } + +[target.'cfg(any(target_os = "linux", target_os = "macos", target_os = "windows", target_os = "freebsd"))'.dependencies] +machine-uid = "0.6.0" + +[target.'cfg(any(target_os = "linux"))'.dependencies] +netlink-sys = { version = "0.9.0", optional = true } +[target.'cfg(all(windows, any(target_arch = "x86_64", target_arch = "x86")))'.dependencies] +windivert = { git = "https://github.com/EasyTier/windivert-rust.git", rev = "adcc56d1550f7b5377ec2b3429f413ee24a77375", features = [ + "static", +] } + +[target.'cfg(windows)'.dependencies] +windows = { workspace = true, features = [ + "Win32_Foundation", + "Win32_NetworkManagement_IpHelper", + "Win32_NetworkManagement_Ndis", + "Win32_NetworkManagement_WindowsFirewall", + "Win32_Networking", + "Win32_System_Com", + "Win32_System_Diagnostics", + "Win32_System_Diagnostics_Debug", + "Win32_System_Ole", + "Win32_System_Variant", + "Win32_Networking_WinSock", + "Win32_System_IO", +] } +encoding = "0.2" +winreg = "0.56" +windows-service = "0.8.1" +winapi = { workspace = true, features = ["impl-default"] } + +[target.'cfg(not(windows))'.dependencies] +jemallocator = { package = "tikv-jemallocator", version = "0.7.0", optional = true, features = [ + "unprefixed_malloc_on_supported_platforms", +] } +jemalloc-ctl = { package = "tikv-jemalloc-ctl", version = "0.7.0", optional = true, features = [ + "use_std", +] } + +[target.'cfg(not(target_os = "macos"))'.dependencies] +jemalloc-sys = { package = "tikv-jemalloc-sys", version = "0.7.1", features = [ + "background_threads_runtime_support", + "background_threads", +], optional = true } + +[target.'cfg(target_os = "macos")'.dependencies] +jemalloc-sys = { package = "tikv-jemalloc-sys", version = "0.7.1", features = [ +], optional = true } + +[build-dependencies] +cfg_aliases = "0.2.2" +globwalk = "0.9.1" +regex = "1" +thunk-rs = { workspace = true, features = [ + "win7", +] } + + +[dev-dependencies] +criterion = "0.8.2" +easytier-core = { workspace = true, features = [ + "test-utils", +] } +serial_test = "4.0.1" +rstest = "0.27.0" +maplit = "1.0.2" +tempfile.workspace = true +stun_codec.workspace = true +bytecodec.workspace = true +x25519-dalek = { workspace = true, features = ["static_secrets"] } +smoltcp = { workspace = true, features = [ + "std", + "medium-ethernet", + "proto-ipv4", + "proto-ipv6", + "socket-raw", +] } + +[target.'cfg(target_os = "linux")'.dev-dependencies] +defguard_wireguard_rs = "0.12.0" +tokio-socks = "0.5.3" + + +[features] +default = [ + "cli", + "wireguard", + "websocket", + "smoltcp", + "tun", + "socks5", + "kcp", + "quic", + "faketcp", + "magic-dns", + "zstd", + "upnp", + "icmp-proxy", + "management", + "endpoint-discovery", + "extended-services", + "linux-netlink", + "tcp-hole-punch", +] +full = [ + "cli", + "websocket", + "wireguard", + "aes-gcm", + "openssl-crypto", + "smoltcp", + "tun", + "socks5", + "kcp", + "quic", + "faketcp", + "magic-dns", + "zstd", + "upnp", + "icmp-proxy", + "management", + "endpoint-discovery", + "extended-services", + "tcp-hole-punch", +] +cli = ["management", "dep:tabled", "dep:humansize", "dep:terminal_size", "dep:unicode-width"] +wireguard = ["vpn-portal", "dep:boringtun", "dep:hkdf", "dep:sha2", "ring-crypto", "easytier-proto/wireguard"] +quic = ["wrapped-transport", "easytier-core/proxy-packet", "dep:quinn", "dep:quinn-proto", "dep:seahash", "dep:rustls", "easytier-proto/quic"] +kcp = ["wrapped-transport", "easytier-core/proxy-packet", "dep:kcp-sys"] +mimalloc = ["dep:mimalloc"] +aes-gcm = ["easytier-core/aes-gcm"] +openssl-crypto = ["easytier-core/openssl-crypto"] +ring-crypto = ["easytier-core/ring-crypto"] +tun = ["dep:tun", "linux-netlink"] +linux-netlink = ["dep:netlink-sys"] +proxy-packet = ["easytier-core/proxy-packet"] +proxy-cidr-monitor = ["easytier-core/proxy-cidr-monitor"] +websocket = [ + "dep:tokio-websockets", + "dep:forwarded-header-value", + "dep:http", + "dep:rcgen", + "dep:tokio-rustls", + "dep:rustls", + "easytier-proto/websocket", +] +smoltcp = ["easytier-core/proxy-smoltcp-stack"] +icmp-proxy = ["easytier-core/proxy-packet"] +socks5 = ["smoltcp"] +ffi-dataplane = ["socks5"] +jemalloc = ["dep:jemallocator"] +jemalloc-prof = [ + "jemalloc", + "dep:jemalloc-ctl", + "jemalloc-ctl/stats", + "jemalloc-sys/profiling", + "jemalloc-sys/stats", +] +tracing = ["tokio/tracing", "dep:console-subscriber", "dep:tracing-subscriber"] +tracing-log = ["tracing/log", "easytier-core/tracing-log"] +logging = [] +dns-resolver = ["dep:hickory-proto", "dep:hickory-resolver"] +magic-dns = [ + "dep:derive_builder", + "dep:humantime-serde", + "dns-resolver", + "dep:hickory-client", + "dep:hickory-server", + "easytier-core/proxy-packet", + "easytier-proto/magic-dns", +] +faketcp = [ + "dep:flume", + "dep:pnet_datalink", + "dep:smoltcp", + "easytier-proto/faketcp", +] +zstd = ["easytier-core/zstd", "easytier-proto/zstd"] +upnp = [ + "dep:http-body-util", + "dep:hyper", + "dep:hyper-util", + "dep:natpmp", + "dep:xmltree", +] +endpoint-discovery = [ + "dns-resolver", + "dep:rustls", + "easytier-core/endpoint-discovery", +] +dhcp-ipv4 = ["easytier-core/dhcp-ipv4"] +public-ipv6-provider = ["linux-netlink", "easytier-core/public-ipv6-provider"] +vpn-portal = ["easytier-core/vpn-portal"] +wrapped-transport = ["easytier-core/wrapped-transport"] +extended-services = [ + "dhcp-ipv4", + "public-ipv6-provider", + "vpn-portal", + "wrapped-transport", + "proxy-cidr-monitor", +] +management = [ + "dep:atomic-write-file", + "web-client", + "logging", + "easytier-core/management", + "easytier-proto/json-rpc", + "easytier-proto/utils", + "tokio/full", +] +management-rpc = ["easytier-core/management-rpc"] +web-client = ["management-rpc", "easytier-core/web-client"] +tcp-hole-punch = ["easytier-core/tcp-hole-punch"] +# Deprecated: hotpath profiling has been removed. These feature aliases are +# retained as no-ops so existing build scripts using `--features hotpath*` +# continue to work without pulling in any dependencies. +hotpath = [] +hotpath-cpu = ["hotpath"] +hotpath-alloc = ["hotpath"] +# For Network Extension on macOS +macos-ne = [] + +[package.metadata.cargo-machete] +ignored = [ + # Used by build/main.rs, including the Windows-only thunk setup. + "cfg_aliases", + "globwalk", + "regex", + "thunk-rs", + # Referenced by serde attributes or enabled for allocator feature unification. + "humantime-serde", + "jemalloc-sys", +] diff --git a/vendor/easytier/easytier/LICENSE b/vendor/easytier/easytier/LICENSE new file mode 120000 index 0000000..ea5b606 --- /dev/null +++ b/vendor/easytier/easytier/LICENSE @@ -0,0 +1 @@ +../LICENSE \ No newline at end of file diff --git a/vendor/easytier/easytier/README.md b/vendor/easytier/easytier/README.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/vendor/easytier/easytier/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/vendor/easytier/easytier/README_CN.md b/vendor/easytier/easytier/README_CN.md new file mode 120000 index 0000000..d7212ef --- /dev/null +++ b/vendor/easytier/easytier/README_CN.md @@ -0,0 +1 @@ +../README_CN.md \ No newline at end of file diff --git a/vendor/easytier/easytier/assets b/vendor/easytier/easytier/assets new file mode 120000 index 0000000..ec2e4be --- /dev/null +++ b/vendor/easytier/easytier/assets @@ -0,0 +1 @@ +../assets \ No newline at end of file diff --git a/vendor/easytier/easytier/benches/README.md b/vendor/easytier/easytier/benches/README.md new file mode 100644 index 0000000..34b4dee --- /dev/null +++ b/vendor/easytier/easytier/benches/README.md @@ -0,0 +1,39 @@ +# Benchmarks + +Criterion benchmarks for EasyTier hot paths. + +| Bench | What it measures | +| ------------------------- | ------------------------------------------------------------------------------- | +| `packet_bytes_extraction` | `ZCPacket::payload_bytes` / `tunnel_payload_bytes` extraction (advance hot path) | + +## Packet Bytes Extraction + +Criterion benchmark for `ZCPacket` bytes extraction — the methods touched by the +`advance`-based slicing refactor. Measures `payload_bytes` and +`tunnel_payload_bytes` at two payload sizes (1280, 4096). Setup +(`ZCPacket::new_with_payload`) runs in the benchmark harness's preparation +phase and is excluded from the timed region, so the numbers reflect only the +extraction call. + +### Quick start + +```bash +cargo bench --bench packet_bytes_extraction +``` + +Smoke run: + +```bash +PACKET_BYTES_MEASUREMENT_SECS=2 \ +PACKET_BYTES_WARMUP_SECS=1 \ +PACKET_BYTES_SAMPLE_SIZE=10 \ +cargo bench --bench packet_bytes_extraction -- --quiet +``` + +### Environment variables + +| Variable | Default | Notes | +| ------------------------------- | ------- | ---------------------------- | +| `PACKET_BYTES_MEASUREMENT_SECS` | `10` | Criterion `measurement_time` | +| `PACKET_BYTES_WARMUP_SECS` | `3` | Criterion `warm_up_time` | +| `PACKET_BYTES_SAMPLE_SIZE` | `10` | Criterion `sample_size` (min 10) | diff --git a/vendor/easytier/easytier/benches/packet_bytes_extraction.rs b/vendor/easytier/easytier/benches/packet_bytes_extraction.rs new file mode 100644 index 0000000..a7c5bc3 --- /dev/null +++ b/vendor/easytier/easytier/benches/packet_bytes_extraction.rs @@ -0,0 +1,65 @@ +use std::hint::black_box; +use std::time::Duration; + +use criterion::{BatchSize, Criterion, Throughput, criterion_group, criterion_main}; + +use easytier_core::packet::ZCPacket; + +const PAYLOAD_SIZES: &[usize] = &[1280, 4096]; + +fn env_parse(key: &str, default: T) -> T { + std::env::var(key) + .ok() + .and_then(|v| v.parse().ok()) + .unwrap_or(default) +} + +fn bench_payload_bytes(c: &mut Criterion) { + let mut group = c.benchmark_group("payload_bytes"); + for &size in PAYLOAD_SIZES { + let data = vec![0u8; size]; + group.throughput(Throughput::Bytes(size as u64)); + group.bench_with_input(format!("{size}"), &data, |b, data| { + b.iter_batched( + || ZCPacket::new_with_payload(black_box(data)), + |p| black_box(p).payload_bytes(), + BatchSize::SmallInput, + ) + }); + } + group.finish(); +} + +fn bench_tunnel_payload_bytes(c: &mut Criterion) { + let mut group = c.benchmark_group("tunnel_payload_bytes"); + for &size in PAYLOAD_SIZES { + let data = vec![0u8; size]; + group.throughput(Throughput::Bytes(size as u64)); + group.bench_with_input(format!("{size}"), &data, |b, data| { + b.iter_batched( + || ZCPacket::new_with_payload(black_box(data)), + |p| black_box(p).tunnel_payload_bytes(), + BatchSize::SmallInput, + ) + }); + } + group.finish(); +} + +fn criterion_config() -> Criterion { + let measurement_secs = env_parse("PACKET_BYTES_MEASUREMENT_SECS", 10u64); + let warmup_secs = env_parse("PACKET_BYTES_WARMUP_SECS", 3u64); + let sample_size = env_parse("PACKET_BYTES_SAMPLE_SIZE", 10usize).max(10); + + Criterion::default() + .measurement_time(Duration::from_secs(measurement_secs)) + .warm_up_time(Duration::from_secs(warmup_secs)) + .sample_size(sample_size) +} + +criterion_group! { + name = benches; + config = criterion_config(); + targets = bench_payload_bytes, bench_tunnel_payload_bytes +} +criterion_main!(benches); diff --git a/vendor/easytier/easytier/docs/credential_peer.md b/vendor/easytier/easytier/docs/credential_peer.md new file mode 100644 index 0000000..b75bca9 --- /dev/null +++ b/vendor/easytier/easytier/docs/credential_peer.md @@ -0,0 +1,724 @@ +# 临时凭据(Credential)系统实现计划 + +## Context + +EasyTier 的 secure mode 已实现 Noise XX 握手 + X25519 静态公钥认证。当前节点通过 `network_secret` 双向确认身份。用户需要一种"临时凭据"机制: + +- **管理节点**(任何持有 network_secret 的节点)可为当前网络生成凭据 +- **新节点**可使用凭据代替 `network_secret` 加入网络 +- **管理节点**可撤销凭据 +- **撤销后**,使用该凭据接入的节点被全网踢出 + +**核心设计**:凭据 = X25519 密钥对。完全复用现有 Noise `Noise_XX_25519_ChaChaPoly_SHA256` 握手流程,无需修改握手消息格式。通过 OSPF 路由同步传播可信公钥列表,撤销时全网自然断开。 + +## 整体架构 + +``` +凭据 = X25519 密钥对 + - 管理节点生成密钥对,将公钥加入可信列表 + - 临时节点持有私钥,用作 Noise static key + - 全网通过 OSPF 路由同步可信公钥列表 + +管理节点 (持有 network_secret): + 1. generate_credential() → 生成 X25519 密钥对 + 2. 公钥记入 trusted_credential_pubkeys → 随 RoutePeerInfo 通过 OSPF 传播 + 3. revoke → 从 trusted 列表移除 → OSPF 同步 → 全网感知 + +临时节点 (持有凭据私钥): + 1. 使用凭据私钥作为 SecureModeConfig.local_private_key + 2. Noise 握手完全走现有流程(XX 模式交换 static pubkey) + 3. 不持有 network_secret,secret_proof 验证会失败,但公钥在可信列表中即可 + 4. RoutePeerInfo.noise_static_pubkey 自然携带凭据公钥 + +校验逻辑(每个节点在路由同步时执行): + 1. 从全网 RoutePeerInfo 中收集管理节点的 trusted_credential_pubkeys(取并集) + **安全约束: 仅信任 secure_auth_level=NetworkSecretConfirmed 的节点发布的列表** + 临时节点(CredentialAuthenticated)发布的 trusted_credential_pubkeys 必须被忽略 + 2. 对每个 peer,如果其 secure_auth_level < NetworkSecretConfirmed: + - 检查其 noise_static_pubkey 是否在可信公钥集合中 + - 不在 → 从路由表移除 → 断开连接 +``` + +## 详细设计 + +### Step 1: Protobuf 定义 + +**文件: `easytier/src/proto/peer_rpc.proto`** + +在 `RoutePeerInfo` 新增字段(利用已有 `noise_static_pubkey` 字段 #18): +```protobuf +message TrustedCredentialPubkey { + bytes pubkey = 1; // X25519 公钥 (32 bytes) + repeated string groups = 2; // 该凭据所属的 ACL group(管理节点声明,无需 proof) + bool allow_relay = 3; // 是否允许该临时节点提供 peer relay 能力 + int64 expiry_unix = 4; // 必选:过期时间(Unix timestamp),过期后自动失效 + repeated string allowed_proxy_cidrs = 5; // 允许该临时节点声明的 proxy_cidrs 范围 +} + +message RoutePeerInfo { + // ... existing fields 1-18 ... + // 管理节点发布的可信凭据公钥列表(含 group 关联) + repeated TrustedCredentialPubkey trusted_credential_pubkeys = 19; +} +``` + +临时节点无需新字段——其 `noise_static_pubkey`(字段 18)已经在 OSPF 中传播,只需在校验端判断该公钥是否在可信列表中。 + +新增 `SecureAuthLevel` 枚举值: +```protobuf +enum SecureAuthLevel { + None = 0; + EncryptedUnauthenticated = 1; + SharedNodePubkeyVerified = 2; + NetworkSecretConfirmed = 3; + CredentialAuthenticated = 4; // 新增:凭据公钥已验证 +} +``` + +**文件: `easytier/src/proto/api_instance.proto`** + +新增凭据管理 RPC: +```protobuf +message GenerateCredentialRequest { + repeated string groups = 1; // 可选: 凭据关联的 ACL group + bool allow_relay = 2; // 可选: 是否允许该临时节点提供 peer relay + repeated string allowed_proxy_cidrs = 3; // 可选: 限制可声明的 proxy_cidrs + int64 ttl_seconds = 4; // 必选: 凭据有效期(秒) +} +message GenerateCredentialResponse { + string credential_id = 1; // 公钥的 base64 + string credential_secret = 2; // 私钥的 base64 +} +message RevokeCredentialRequest { string credential_id = 1; } +message RevokeCredentialResponse { bool success = 1; } +message ListCredentialsRequest {} +message CredentialInfo { + string credential_id = 1; // 公钥 base64 + google.protobuf.Timestamp created_at = 2; +} +message ListCredentialsResponse { repeated CredentialInfo credentials = 1; } + +service CredentialManageRpc { + rpc GenerateCredential(GenerateCredentialRequest) returns (GenerateCredentialResponse); + rpc RevokeCredential(RevokeCredentialRequest) returns (RevokeCredentialResponse); + rpc ListCredentials(ListCredentialsRequest) returns (ListCredentialsResponse); +} +``` + +### Step 2: 凭据管理模块 + +**新文件: `easytier/src/peers/credential_manager.rs`** + +```rust +use x25519_dalek::{StaticSecret, PublicKey}; + +pub struct CredentialManager { + // 本节点管理的可信凭据 + credentials: DashMap, // credential_id (pubkey base64) -> entry + storage_path: Option, // 可选: 凭据 JSON 文件路径 +} + +struct CredentialEntry { + pubkey_bytes: [u8; 32], + groups: Vec, // 关联的 ACL group(管理节点声明) + allow_relay: bool, // 是否允许 relay + allowed_proxy_cidrs: Vec, // 允许声明的 proxy_cidrs 范围 + expiry: SystemTime, // 过期时间(必选) + created_at: SystemTime, +} + +impl CredentialManager { + /// 生成新凭据(含 group 关联) + /// 返回 (credential_id=公钥base64, credential_secret=私钥base64) + pub fn generate_credential(&self, groups: Vec, allow_relay: bool, expiry: SystemTime) -> (String, String) { + let private = StaticSecret::random_from_rng(OsRng); + let public = PublicKey::from(&private); + let id = BASE64_STANDARD.encode(public.as_bytes()); + let secret = BASE64_STANDARD.encode(private.as_bytes()); + self.credentials.insert(id.clone(), CredentialEntry { + pubkey_bytes: *public.as_bytes(), + groups, + allow_relay, + expiry, // 由调用方传入 + created_at: SystemTime::now(), + }); + self.save_to_disk(); // 持久化 + (id, secret) + } + + /// 撤销凭据 + pub fn revoke_credential(&self, credential_id: &str) -> bool; + + /// 获取可信凭据列表(用于 RoutePeerInfo.trusted_credential_pubkeys) + pub fn get_trusted_pubkeys(&self) -> Vec; + + /// 列出所有凭据 + pub fn list_credentials(&self) -> Vec; +} +``` + +### Step 3: Noise 握手适配(最小改动) + +**文件: `easytier/src/peers/peer_conn.rs`** + +临时节点的握手流程**完全不需要修改**,因为: +- 临时节点配置 `SecureModeConfig { enabled: true, local_private_key: 凭据私钥, local_public_key: 凭据公钥 }` +- `get_keypair()` (line 434) 自然返回凭据密钥对 +- Noise XX 握手正常交换 static pubkey +- 唯一区别:`secret_proof_32` 验证会失败(临时节点没有 network_secret) + +需要修改 `do_noise_handshake_as_server()` (line 934): +- **当前行为**: `secret_proof` 验证失败 → 返回错误断开连接 (line 1059) +- **修改为**: `secret_proof` 验证失败时,不立即断开,而是将 `secure_auth_level` 保持为 `EncryptedUnauthenticated` +- 后续由 OSPF 路由同步阶段决定该 peer 是否可信(公钥是否在 trusted 列表中) + +同样修改 `do_noise_handshake_as_client()` (line 680): +- 当临时节点连接管理节点时,`secret_proof` 验证失败不应报错 +- 临时节点可以通过 `pinned_remote_pubkey` 或不验证来处理 + +**NoiseHandshakeResult** 新增: +```rust +// 标记此连接使用了凭据而非 network_secret +is_credential_conn: bool, +``` + +### Step 4: RoutePeerInfo 传播凭据信息 + +**文件: `easytier/src/peers/peer_ospf_route.rs`** + +修改 `RoutePeerInfo::new_updated_self()` (line 164): +- 管理节点(持有 network_secret): 从 `CredentialManager.get_trusted_pubkeys()` 获取列表,填入 `trusted_credential_pubkeys` +- 临时节点: **不填写 `trusted_credential_pubkeys`**(该字段留空),即使收到其他管理节点传播的列表也不转发 + - 实现方式: 在 `new_updated_self()` 中检查节点身份,临时节点跳过 trusted_credential_pubkeys 填充 +- 临时节点: 无需额外操作,`noise_static_pubkey` 已自然包含凭据公钥 + +### Step 5: 全网校验与自动踢出(核心逻辑) + +**文件: `easytier/src/peers/peer_ospf_route.rs`** + +在 `SyncedRouteInfo` 中新增: +```rust +// 从全网管理节点汇总的可信凭据公钥集合 +trusted_credential_pubkeys: DashSet>, // pubkey bytes +``` + +新增校验方法(类似 `verify_and_update_group_trusts` line 743): +```rust +fn verify_credential_peers(&self, peer_infos: &[RoutePeerInfo]) { + // 1. 收集管理节点的 trusted_credential_pubkeys(取并集) + // **安全约束: 仅信任 secret_digest 与本网络匹配的节点(即持有 network_secret 的管理节点)** + // 临时节点的 trusted_credential_pubkeys 直接忽略,防止恶意临时节点自我授权 + let mut all_trusted = HashSet::new(); + for info in peer_infos { + if self.is_peer_secret_verified(info.peer_id) { + // 该 peer 通过了 network_secret 双向确认,是合法管理节点 + for tc in &info.trusted_credential_pubkeys { + all_trusted.insert(tc.pubkey.clone()); + } + } + // else: 该 peer 未通过 network_secret 确认(含临时节点),忽略其 trusted 列表 + } + self.trusted_credential_pubkeys = all_trusted; + + // 2. 检查所有 peer 的凭据状态 + for info in peer_infos { + if !self.is_peer_secret_verified(info.peer_id) + && !info.noise_static_pubkey.is_empty() + { + if !self.trusted_credential_pubkeys.contains(&info.noise_static_pubkey) { + // 该 peer 既不持有 network_secret,其公钥也不在可信列表中 + // → 标记为不可信,后续从路由表移除 + self.mark_peer_untrusted(info.peer_id); + } + } + } +} +``` + +在 `do_sync_route_info()` (line 2614) 中调用此校验。 + +在路由表构建中(`update_route_table_and_cached_local_conn_bitmap()`): +- 不可信 peer 不加入路由图 +- 已连接的不可信 peer 调用 `PeerMap::close_peer()` 断开 + +**判断 peer 是否持有 network_secret**: 利用现有 `secret_digest` 字段。管理节点的 `RoutePeerInfo` 中 `secret_digest` 与本节点匹配,说明双方持有相同的 network_secret。 + +### Step 6: GlobalCtx / Config 集成 + +**文件: `easytier/src/common/global_ctx.rs`** + +在 `GlobalCtx` 新增: +```rust +credential_manager: Arc, // 所有节点都持有,管理节点用于生成/撤销 +``` + +**文件: `easytier/src/common/global_ctx.rs` - `GlobalCtxEvent`** + +新增: +```rust +CredentialChanged, // 触发 OSPF 立即同步 +``` + +**文件: `easytier/src/common/config.rs`** + +临时节点的配置方式: 直接使用凭据私钥作为 `SecureModeConfig.local_private_key`。 +可在 `TomlConfigLoader` 中新增便捷字段或 CLI 参数: +- `--credential <私钥base64>`: 临时节点使用凭据私钥加入网络 +- `--credential-file `: 管理节点指定凭据存储 JSON 文件路径 + +### Step 7: RPC 服务 + CLI + +**文件: `easytier/src/peers/rpc_service.rs`** + +实现 `CredentialManageRpc`,参考 `PeerManagerRpcService` 模式。 + +**CLI** (`easytier-cli`): +``` +easytier-cli credential generate + 输出: credential_id=<公钥base64> credential_secret=<私钥base64> + +easytier-cli credential revoke +easytier-cli credential list +``` + +**临时节点启动**: +```bash +# 方式1: 直接传入凭据私钥 +easytier-core --network-name test \ + --secure-mode \ + --credential <私钥base64> \ + --peers tcp://管理节点:11010 + +# 内部实现: 将凭据私钥设为 SecureModeConfig.local_private_key +``` + +### Step 8: 连接时验证(握手后快速拒绝,必选) + +在 `do_noise_handshake_as_server()` 完成后,**必须**进行快速检查: +- 如果对端 `secret_proof` 验证失败(非管理节点),且对端 `noise_static_pubkey` 不在本节点已知的 `trusted_credential_pubkeys` 中 +- 立即断开连接 + +这是**必选的安全措施**(非可选优化)。因为 Step 3 放宽了 secret_proof 失败的处理,如果不做快速拒绝,任何随机节点都能与管理节点建立加密连接并持有,浪费资源。 + +```rust +// 在 handshake 完成后 +if !secret_proof_verified { + let remote_pubkey = handshake_result.remote_static_pubkey; + if !self.global_ctx.credential_manager.is_pubkey_trusted(&remote_pubkey) { + return Err(Error::AuthError("unknown credential".to_string())); + } + // 公钥在 trusted 列表中 → 允许连接,标记为 CredentialAuthenticated + handshake_result.secure_auth_level = SecureAuthLevel::CredentialAuthenticated; +} +``` + +## 关键文件清单 + +| 文件 | 修改内容 | +|------|----------| +| `easytier/src/proto/peer_rpc.proto` | `RoutePeerInfo` 加 `trusted_credential_pubkeys`; `SecureAuthLevel` 加 `CredentialAuthenticated` | +| `easytier/src/proto/api_instance.proto` | 新增 `CredentialManageRpc` 服务及消息定义 | +| `easytier/src/peers/credential_manager.rs` | **新文件** — 凭据管理器(密钥对生成/撤销/列表) | +| `easytier/src/peers/mod.rs` | 导出 credential_manager | +| `easytier/src/peers/peer_ospf_route.rs` | `new_updated_self()` 填 trusted_pubkeys; 新增 `verify_credential_peers()`; 路由表过滤 | +| `easytier/src/peers/peer_conn.rs` | `do_noise_handshake_as_server()` 放宽 secret_proof 失败为非致命; 可选握手阶段快速拒绝 | +| `easytier/src/peers/peer_manager.rs` | 集成 CredentialManager; 不可信 peer 断连逻辑 | +| `easytier/src/common/global_ctx.rs` | 持有 CredentialManager; 新增 CredentialChanged 事件 | +| `easytier/src/common/config.rs` | 新增 `--credential` 参数处理 | +| `easytier/src/peers/rpc_service.rs` | 实现 CredentialManageRpc | +| `easytier/src/proto/common.rs` | SecureModeConfig 可选: credential 模式识别 | + +## 复用现有机制 + +| 现有机制 | 路径 | 复用方式 | +|----------|------|----------| +| Noise XX 握手 | `peer_conn.rs:680,934` | 临时节点直接使用凭据密钥对走完整 Noise 流程 | +| `SecureModeConfig` | `proto/common.rs:367` | 临时节点的凭据私钥直接设为 local_private_key | +| `noise_static_pubkey` | `RoutePeerInfo` 字段 18 | 临时节点的凭据公钥已在 OSPF 中传播 | +| `verify_and_update_group_trusts()` | `peer_ospf_route.rs:743` | 凭据校验逻辑参考此模式 | +| `PeerMap::close_peer()` | `peer_map.rs:317` | 断开不可信 peer | +| OSPF 路由同步 | `SyncRouteInfoRequest` | 可信公钥列表随 RoutePeerInfo 自然传播 | +| `PeerManagerRpcService` | `rpc_service.rs:24` | RPC 服务实现模式 | +| `GlobalCtxEvent` | `global_ctx.rs:32` | 新增事件触发同步 | + +## 验证方案 + +1. **单元测试**: + - `credential_manager.rs`: 密钥对生成、撤销、列表 + - `peer_conn.rs`: 凭据节点 Noise 握手成功(无 network_secret) + +2. **集成测试** (参考 `tests/three_node.rs`): + - 3 节点: A + B (管理节点, network_secret) + C (临时节点, credential) + - A 生成凭据(groups=["guest"])→ C 使用凭据连接 → 验证 C 加入路由表、可达 + - 验证 C 的 ACL group 为 "guest",配置 group ACL 规则后生效 + - A 撤销凭据 → 等待 OSPF 同步 (~1-3s) → 验证 C 被 A 和 B 断开 + - C 尝试重连 → 验证握手阶段被拒 + +3. **手动测试**: + ```bash + # A: 管理节点 + easytier-core -n test -s secret --secure-mode --listeners tcp://0.0.0.0:11010 + easytier-cli credential generate # → credential_id + credential_secret + + # C: 临时节点 + easytier-core -n test --secure-mode --credential <私钥base64> --peers tcp://A:11010 + + # 验证后撤销 + easytier-cli credential revoke + # C 数秒内被踢出 + ``` + +### Step 9: 临时节点 OSPF 路由限制 + +**约束**: 临时节点传播的路由信息不可信,需严格限制。 + +#### 9a. 管理节点不主动发起到临时节点的 OSPF session + +**核心原则**: OSPF `maintain_sessions()` 构建最小生成树时,只在管理节点之间选择 initiator,不将临时节点纳入 `dst_peer_id_to_initiate`。但管理节点**被动接受**临时节点发起的 session。 + +**文件: `easytier/src/peers/peer_ospf_route.rs`** + +修改 `maintain_sessions()` (line 2485): +- 在构建 `dst_peer_id_to_initiate` 候选列表时,过滤掉临时节点 +- 管理节点之间的 MST 不受影响 + +```rust +// 在 maintain_sessions() 中,构建 initiator 候选时过滤临时节点 +let peers: Vec = peers.into_iter().filter(|peer_id| { + // 只主动发起到管理节点的 session,不主动连临时节点 + !self.is_credential_peer(*peer_id) +}).collect(); +``` + +- **临时节点自身**: 在 `maintain_sessions()` 中只将管理节点作为 initiator 候选,跳过其他临时节点 + +```rust +// 临时节点侧: 只主动连管理节点 +if self.is_credential_node() { + let peers: Vec = peers.into_iter().filter(|peer_id| { + !self.is_credential_peer(*peer_id) // 只连管理节点 + }).collect(); +} +``` + +**session 建立方式**: +- **管理节点 → 管理节点**: 正常 MST initiator 选择(不变) +- **临时节点 → 管理节点**: 临时节点主动发起 session,管理节点被动接受 +- **临时节点 → 临时节点**: 不建立(双方都过滤掉对方) +- **管理节点 → 临时节点**: 不主动发起(不在 initiator 候选中) + +**路由信息传播**: 临时节点通过其主动发起的 session 调用 `sync_route_info` 推送自身 RoutePeerInfo。管理节点在正常 OSPF sync 中将其代理传播给其他管理节点。管理节点也通过该 session 向临时节点推送完整路由表。 + +#### 9b. 管理节点只选择性接收临时节点的路由信息 + +**文件: `easytier/src/peers/peer_ospf_route.rs`** + +临时节点通过其主动发起的 session 调用 `sync_route_info`,管理节点在处理时需做过滤: + +- 只接收该临时节点**自己的** `RoutePeerInfo`(`route_info.peer_id == dst_peer_id`),丢弃其声称的其他 peer 的路由信息 +- 对临时节点自身的 RoutePeerInfo,过滤其 `proxy_cidrs`:只保留在 `TrustedCredentialPubkey.allowed_proxy_cidrs` 范围内的网段,移除超出范围的声明 +- 临时节点的 `foreign_network_infos` 应忽略 +- 临时节点的 `conn_info`(连接拓扑)**根据 `allow_relay` 标志决定**(见下方) + +修改 `update_peer_infos()` (line 461): + +```rust +fn update_peer_infos( + &self, my_peer_id, my_peer_route_id, dst_peer_id, + peer_infos, raw_peer_infos, +) -> Result<(), Error> { + let dst_is_credential_peer = self.is_credential_peer(dst_peer_id); + + for (idx, route_info) in peer_infos.iter().enumerate() { + // 临时节点只允许传播自己的路由信息 + if dst_is_credential_peer && route_info.peer_id != dst_peer_id { + tracing::debug!( + ?dst_peer_id, peer_id=?route_info.peer_id, + "ignoring route info from credential peer for other peer" + ); + continue; + } + + // 过滤临时节点的 proxy_cidrs,只保留凭据允许的范围 + if dst_is_credential_peer { + let allowed = self.get_credential_allowed_proxy_cidrs(dst_peer_id); + if let Some(allowed_cidrs) = allowed { + route_info.proxy_cidrs.retain(|cidr| { + allowed_cidrs.iter().any(|a| cidr_is_subset(cidr, a)) + }); + } + } + // ... existing logic ... + } +} +``` + +修改 `do_sync_route_info()` (line 2614): + +```rust +// 在 do_sync_route_info 中 +let from_is_credential = self.is_credential_peer(from_peer_id); +let credential_allows_relay = from_is_credential + && self.is_credential_relay_allowed(from_peer_id); + +if let Some(peer_infos) = &peer_infos { + // update_peer_infos 内部会过滤临时节点的非自身信息 + service_impl.synced_route_info.update_peer_infos(...); +} + +// 临时节点的 conn_info: 仅当 allow_relay=true 时接收 +if let Some(conn_info) = &conn_info { + if !from_is_credential || credential_allows_relay { + service_impl.synced_route_info.update_conn_info(conn_info); + } +} + +// 临时节点的 foreign_network_infos 始终不接收 +if let Some(foreign_network) = &foreign_network { + if !from_is_credential { + service_impl.synced_route_info.update_foreign_network(foreign_network); + } +} +``` + +**conn_info 处理**: +- 临时节点的 `conn_info`: 根据凭据的 `allow_relay` 标志决定是否接收 + - `allow_relay = true`: 管理节点接收并传播该临时节点的 conn_info,使其参与路由图,可作为 relay 转发数据 + - `allow_relay = false`(默认): 忽略 conn_info,该临时节点不参与中继(仅作为叶子节点存在于路由图中) +- 临时节点的 `foreign_network_infos` 始终忽略 + +**`is_credential_relay_allowed()` 实现**: +```rust +fn is_credential_relay_allowed(&self, peer_id: PeerId) -> bool { + // 从全网汇总的 trusted_credential_pubkeys 中查找该 peer 的凭据 + // 检查对应 TrustedCredentialPubkey.allow_relay 标志 + let peer_info = self.peer_infos.read(); + if let Some(info) = peer_info.get(&peer_id) { + for tc in &self.all_trusted_credentials { + if tc.pubkey == info.noise_static_pubkey { + return tc.allow_relay; + } + } + } + false +} +``` + +**注意**: 即使 `allow_relay=true`,临时节点仍然不能转发握手包(Step 10b 限制不变),因此不会有新节点通过 relay 临时节点接入网络。relay 能力仅用于已建立连接的 peer 之间的数据转发。 + +#### 9c. 临时节点的 `RoutePeerInfo` 中的 `trusted_credential_pubkeys` 被忽略 + +已在 Step 5 中说明:只信任 `secret_digest` 匹配的管理节点发布的 trusted 列表。 + +#### 判断 peer 是否为临时节点的方法 + +在 `SyncedRouteInfo` / `PeerRouteServiceImpl` 中新增: +```rust +fn is_credential_peer(&self, peer_id: PeerId) -> bool { + // 方法: 检查该 peer 的 RoutePeerInfo + // 1. 如果 peer 的 noise_static_pubkey 在 trusted_credential_pubkeys 中 → 是临时节点 + // 2. 如果 peer 通过了 network_secret 确认 (secret_digest 匹配) → 是管理节点 + // 3. 在 peer_conn 握手后,可以记录 secure_auth_level 到连接信息中 + let peer_info = self.synced_route_info.peer_infos.read(); + if let Some(info) = peer_info.get(&peer_id) { + if !info.noise_static_pubkey.is_empty() + && self.trusted_credential_pubkeys.contains(&info.noise_static_pubkey) { + return true; + } + } + false +} +``` + +对于直连 peer,也可以在握手阶段直接记录 `secure_auth_level`,用于快速判断。 + +### Step 10: 禁止通过临时节点接入网络 + +**约束**: 不得有新节点(无论是否持有 network_secret)通过临时节点的 listener 接入网络。但允许通过管理节点中继后建立 P2P 连接。 + +#### 10a. 临时节点天然无法接受新节点接入(无需额外代码) + +临时节点作为 listener 时,新节点的连接会**自然失败**,因为: +1. 临时节点没有 `network_secret`,无法验证对端的 `secret_proof` → 无法确认对端是管理节点 +2. 临时节点不发布 `trusted_credential_pubkeys` → 对端公钥不在可信列表中 +3. 对端也无法验证临时节点的 `secret_proof`(临时节点没有 network_secret) + +因此 **不需要在 `add_tunnel_as_server()` 中添加显式拦截逻辑**。已有的 Noise 握手 + 凭据校验机制已足够阻止新节点通过临时节点接入。 + +**例外**: 已知的管理节点可以连接到临时节点(如 P2P hole punch 场景),因为管理节点的公钥已通过 OSPF 同步被临时节点知晓,握手可以成功。 + +#### 10b. 临时节点不转发来自未知 peer 的连接请求 + +**文件: `easytier/src/peers/peer_manager.rs`** + +在 packet forwarding 路径 (line 718-766) 中: +- 临时节点不应转发 `HandShake` / `NoiseHandshakeMsg*` 类型的包 +- 这防止新节点通过临时节点的中继接入网络 + +```rust +// 在 peer_recv 循环的 forward 分支中 +if to_peer_id != my_peer_id { + // 临时节点不转发握手包(阻止新节点通过临时节点接入) + if is_credential_node && ( + hdr.packet_type == PacketType::HandShake as u8 + || hdr.packet_type == PacketType::NoiseHandshakeMsg1 as u8 + || hdr.packet_type == PacketType::NoiseHandshakeMsg2 as u8 + || hdr.packet_type == PacketType::NoiseHandshakeMsg3 as u8 + ) { + tracing::debug!("credential node dropping forwarded handshake packet"); + continue; + } + // ... existing forward logic ... +} +``` + +#### 10c. P2P 连接通过管理节点中继仍然允许 + +P2P hole punch 的流程: +1. 两个节点通过管理节点交换打洞信息(RPC) +2. 建立直接 P2P tunnel +3. 在 P2P tunnel 上握手 + +这个流程不受影响,因为: +- 打洞信息交换通过管理节点中继(RPC),不经过临时节点 +- P2P tunnel 建立后的握手是直连,不通过临时节点的 listener +- 来源为 `TcpHolePunch` 或 `UdpHolePunch` 的连接可以被临时节点接受 + +**设计思路**: 将凭据映射为 ACL Group,复用现有的 group-based ACL 规则系统。 + +现有 ACL 系统已支持基于 group 的规则匹配: +- `Rule.source_groups` / `Rule.destination_groups` (acl.proto:72-73) +- `PeerGroupInfo` 通过 HMAC proof 验证 peer 所属 group (peer_rpc.rs:8-38) +- `verify_and_update_group_trusts()` 在 OSPF 同步时更新 group trust map (peer_ospf_route.rs:743) +- `get_peer_groups()` 返回 peer 所属的 group 列表,用于 ACL 匹配 (peer_ospf_route.rs:2287) + +**方案**: 生成凭据时,为每个凭据创建一个隐式 ACL Group。 + +1. **凭据生成时**: 管理节点为凭据创建一个关联的 group: + - group_name = `"credential:"` 或用户自定义名称 + - group_secret = 由 credential_secret 派生的密钥 + - 可选:指定凭据所属的 group_name(批量管理,如 `"guest"`, `"contractor"`) + +2. **临时节点加入时**: 临时节点使用凭据私钥连接。其 group 归属由管理节点在 `TrustedCredentialPubkey.groups` 中声明(无需临时节点自己提供 group proof)。验证节点在 `verify_credential_peers()` 中匹配公钥后,直接将声明的 groups 加入 `group_trust_map`。 + +3. **ACL 规则配置**: 管理员可配置基于 group 的 ACL 规则: + ```toml + # 示例配置: 限制 "guest" group 只能访问特定子网 + [[acl.acl_v1.chains]] + name = "inbound" + chain_type = "Inbound" + default_action = "Allow" + + [[acl.acl_v1.chains.rules]] + name = "restrict_guest" + source_groups = ["guest"] + destination_ips = ["10.0.0.0/24"] + action = "Drop" + ``` + +4. **管理节点发布 group 信息**: + - 在 `RoutePeerInfo.trusted_credential_pubkeys` 中传播可信公钥时,同时包含关联的 group 信息 + - 扩展 proto: + (使用 Step 1 中定义的 `TrustedCredentialPubkey`,group 归属由管理节点声明,无需 proof 验证) + - 替换 `repeated bytes trusted_credential_pubkeys` 为 `repeated TrustedCredentialPubkey trusted_credential_pubkeys` + +5. **校验节点处理**: 在 `verify_credential_peers()` 中: + - 验证凭据公钥在可信列表中后 + - 直接将 `TrustedCredentialPubkey.groups` 中声明的 group 加入 `group_trust_map` / `group_trust_map_cache`(无需验证 group proof,因为管理节点的声明已是可信的) + - ACL filter 在处理数据包时自动基于 group 匹配规则 + +**API 扩展**: + +生成凭据时可指定 group: +```protobuf +message GenerateCredentialRequest { + repeated string groups = 1; // 可选: 为该凭据关联的 group 名称 + bool allow_relay = 2; // 可选: 是否允许 relay + repeated string allowed_proxy_cidrs = 3; // 可选: 限制可声明的 proxy_cidrs + int64 ttl_seconds = 4; // 必选: 凭据有效期(秒) +} +``` + +CLI: +```bash +# 生成带 group 的凭据,有效期 24 小时 +easytier-cli credential generate --groups guest,restricted --ttl 86400 + +# 生成允许 relay 的凭据,有效期 7 天 +easytier-cli credential generate --groups relay-node --allow-relay --ttl 604800 + +# 最简用法(默认 group 名为 "credential") +easytier-cli credential generate --ttl 3600 +``` + +## 安全审查 + +### 已覆盖的安全性 + +- **端到端加密**: 数据包在源端加密、目的端解密,relay 节点(含 `allow_relay` 的临时节点)无法看到明文 +- **临时节点自我授权防护**: 只信任 `secret_digest` 匹配的管理节点发布的 `trusted_credential_pubkeys` +- **临时节点路由篡改防护**: 只接收临时节点自身的 RoutePeerInfo,忽略其转发的其他路由 +- **临时节点网络接入防护**: 临时节点天然无法接受新节点接入(无 network_secret、不发布 trusted 列表) + +### 需要关注的安全问题 + +**1. Step 8 握手后快速拒绝应为必选(非可选)** + +当前 Step 8 标记为"可选优化",但实际上是**必须的安全措施**。如果不做快速拒绝: +- 任何随机节点(无 credential、无 network_secret)都能完成 Noise 握手(因为 Step 3 放宽了 secret_proof 失败) +- 在等待 OSPF 同步验证期间,该节点持有一个有效的加密连接,浪费资源 +- **修改**: Step 8 改为必选。握手完成后立即检查:对端 secret_proof 失败 + 公钥不在本节点已知的 trusted 列表中 → 立即断开 + +**2. Group proof 验证机制需要明确** + +当前方案:临时节点在 `RoutePeerInfo.groups` 中携带 `PeerGroupInfo`(HMAC proof),管理节点在 `TrustedCredentialPubkey` 中传播 `group_secret_hash`。 + +问题:HMAC 验证需要**原始 secret**,不是 hash。验证节点如何知道 credential 的 group secret? + +**解决方案**: `TrustedCredentialPubkey.group_secret_hash` 改为 `group_secret_digest`,使用与现有 `NetworkIdentity.network_secret_digest` 相同的 digest 算法。验证时: +- 管理节点在 `TrustedCredentialPubkey` 中包含 `group_secret_digest` +- 临时节点发送的 `PeerGroupInfo` 中包含 `group_proof`(HMAC) +- 验证节点无法直接验证 HMAC(没有原始 secret),但可以信任管理节点的声明:如果管理节点在 `TrustedCredentialPubkey.groups` 中列出了某个 group,且临时节点的公钥匹配,就直接信任该 group 归属 +- 即:**group 归属由管理节点在 `TrustedCredentialPubkey` 中声明,无需临时节点提供 proof** +- 这简化了实现,且安全性不降低(管理节点已是可信源) + +**3. 凭据持久化** + +`CredentialManager` 当前设计为内存存储。管理节点重启后所有凭据丢失,导致使用这些凭据的临时节点被踢出。 + +**解决方案**: +- 管理节点可配置凭据存储的 JSON 文件路径(如 `--credential-file /path/to/credentials.json`) +- `CredentialManager` 启动时从该文件加载已有凭据 +- 生成/撤销凭据时自动写入该文件 +- 未配置文件路径时,凭据仅存内存(重启丢失) + +**4. 同一凭据多节点复用** + +同一个 credential 私钥可以被多个节点同时使用。它们有不同的 `peer_id` 但相同的 `noise_static_pubkey`。这会导致: +- 路由表中多个 RoutePeerInfo 有相同的 `noise_static_pubkey` +- 撤销时所有使用该凭据的节点同时被踢出(符合预期) +- **这是预期行为**,但应在文档中说明 + +**5. 临时节点 proxy_cidrs 限制** + +临时节点可能声明虚假的 `proxy_cidrs`(子网代理),导致流量黑洞。 + +**解决方案**(已纳入设计): +- 生成凭据时通过 `allowed_proxy_cidrs` 字段限制该凭据可声明的网段范围 +- 管理节点在 Step 9b 的 `update_peer_infos()` 中过滤:只保留临时节点声明的 proxy_cidrs 中属于 `allowed_proxy_cidrs` 子集的网段 +- 未配置 `allowed_proxy_cidrs` 时(空列表),临时节点不允许声明任何 proxy_cidrs + +**6. 凭据过期时间(TTL)** + +凭据必须设置过期时间。过期后自动失效,等同于被撤销。 +- 生成凭据时必须指定 `--ttl` 或 `--expiry` +- `verify_credential_peers()` 中检查 `expiry_unix`,过期的凭据从可信列表中移除 +- 过期检查在每次路由同步时执行,无需额外定时器 + +## 优势 + +- **最小改动**: Noise 握手消息格式不变,完全复用现有流程 +- **安全性**: X25519 密钥对提供强身份认证,不弱于 network_secret;端到端加密保护 relay 场景 +- **自然传播**: 利用 OSPF 已有基础设施,无需新 RPC +- **去中心化撤销**: 任何管理节点都可撤销,全网通过路由同步感知 +- **ACL 复用**: 凭据映射为 ACL Group,完全复用现有 group-based ACL 规则系统,无需新的 ACL 机制 diff --git a/vendor/easytier/easytier/docs/peer_conn_secure_mode_v3.md b/vendor/easytier/easytier/docs/peer_conn_secure_mode_v3.md new file mode 100644 index 0000000..571180d --- /dev/null +++ b/vendor/easytier/easytier/docs/peer_conn_secure_mode_v3.md @@ -0,0 +1,509 @@ +# PeerConn Secure Mode(乱序隧道友好) + +本文是对“PeerConn 安全模式”下一阶段协议的完整规格草案,目标是在底层 `Tunnel` **不保证顺序交付**(可能乱序/丢包)的前提下: + +- 仍使用 Noise 进行握手(加密、认证、channel binding) +- 数据面不使用 `snow::TransportState` 逐包加解密(因为它隐式递增 nonce,要求有序) +- 在数据包尾部携带 **12B 明文 nonce**(与项目当前的“包尾 nonce”加密格式对齐),并把 **epoch 编进 nonce** +- 以尽可能低的内存开销实现 anti-replay(默认窗口 256) +- 多条 PeerConn 之间复用同一份 Peer 级安全会话(PeerSession) + +该文档只描述协议与数据结构;实现时以本文为准做迭代。 + +--- + +## 背景 + +### 节点角色 + +系统中常见两类角色(由配置与信任锚点决定,而非代码里硬编码的“节点类型”): + +- **用户节点(同网节点)**:通常持有 `network_secret`,期望与同一 `network_name` 的其他节点建立强认证连接。 +- **共享节点(基础设施节点)**:通常不持有用户的 `network_secret`,用于为多个用户网络提供转发/中继能力;客户端可通过 pinning 共享节点的长期 static 公钥获得“服务器认证”。 + +基于握手中交换的 `network_name` 可以得到 **角色提示(role hint)**: + +- `a_network_name == b_network_name`:同网提示 +- 否则:共享节点/外网提示 + +但 `network_name` 不是认证锚点;安全决策应基于 pinning 或 `network_secret_confirmed`(见 8)。 + +### 连接方式与 PeerConn + +在实现中,“peer 与 peer 之间的连接”由 `PeerConn` 表示,它绑定一条底层 `Tunnel`(可能是 tcp/udp/quic/wg/ring 等),并以 `PeerManagerHeader` 承载上层消息: + +- `PacketType::HandShake`:传统 PeerConn 握手 +- `PacketType::NoiseHandshake`:安全模式下的 Noise 握手 + +参考:[packet_def.rs](file:///data/project/EasyTier/easytier/src/tunnel/packet_def.rs#L59-L77)。 + +PeerManager 会在连接建立时走不同入口: + +- 主动方:`add_client_tunnel` -> `PeerConn::do_handshake_as_client` +- 被动方:`add_tunnel_as_server` -> `PeerConn::do_handshake_as_server` + +参考:[peer_manager.rs](file:///data/project/EasyTier/easytier/src/peers/peer_manager.rs#L361-L379)。 + +### 多连接与 foreign network + +同一对 peer 之间可能出现多条 PeerConn(多路径、多协议、重连等),因此需要一个 Peer 级别的“安全会话”来复用认证结果与数据面密钥(见 7.3 的 PeerSession)。 + +此外,当握手得到的对端 `network_name` 与本地不一致时,PeerManager 会将该连接纳入 foreign network 相关逻辑(例如 foreign network client/manager)以支持“共享节点”模式与跨网络转发: + +参考:[peer_manager.rs](file:///data/project/EasyTier/easytier/src/peers/peer_manager.rs#L361-L377)。 + +### 为什么需要本方案 + +若数据面直接使用 `snow::TransportState` 逐包加解密,会隐式递增 nonce,从而要求底层按序交付。由于本项目的数据加密格式本就采用“包尾明文 nonce”(例如 `AesGcmTail.nonce[12]`,以及 ring ChaCha20-Poly1305 的同形 tail),因此本文延续“尾部 nonce”风格,并将 nonce 结构化为 `epoch||seq`,以满足: + +- 乱序可解密 +- 低内存 anti-replay +- epoch/key 轮换 +- 多 PeerConn 复用 PeerSession + +参考:[packet_def.rs:AesGcmTail](file:///data/project/EasyTier/easytier/src/tunnel/packet_def.rs#L266-L273)、[ring_chacha20.rs](file:///data/project/EasyTier/easytier/src/peers/encrypt/ring_chacha20.rs#L69-L93)。 + +--- + +## 0. 约束与假设 + +- 底层 tunnel 可能乱序/丢包;因此数据面必须支持乱序解密。 +- 外层已有 `PeerManagerHeader`,包含 `from_peer_id` / `to_peer_id`,可作为对端身份索引,数据面无需额外携带 `session_id`。 +- 保持既有的安全语义目标: + - 共享节点 pinning(基于对端 Noise static pubkey) + - network_secret 的 channel binding 确认(`handshake_hash`) + - “尽早交换 network_name”用于角色判断(同网/共享节点) + +--- + +## 1. 术语 + +- **PeerConn**:一条具体的底层连接/路径(可能同一对 peer 存在多条)。 +- **PeerSession**:Peer 级别的安全会话状态(密钥、epoch、nonce、anti-replay、认证等级等)。 +- **epoch**:数据面密钥版本号(key id)。编码进 12B nonce 的高 4B。 +- **seq**:发送序号(per-direction 单调递增 u64)。编码进 12B nonce 的低 8B。 +- **nonce12**:明文 12B nonce,按 `epoch||seq` 编码,附在密文尾部。 +- **AAD**:AEAD 的附加认证数据。本文建议使用空 AAD(与项目当前的 ring/openssl 加密实现一致),未来可扩展为覆盖部分 header。 + +--- + +## 2. 关键 wire 结构(参考) + +### 2.1 PeerManagerHeader(16B) + +来自 [packet_def.rs](file:///data/project/EasyTier/easytier/src/tunnel/packet_def.rs#L93-L105): + +| 字段 | 类型 | 大小 | +| --------------- | -------: | ------: | +| from_peer_id | u32 (LE) | 4 | +| to_peer_id | u32 (LE) | 4 | +| packet_type | u8 | 1 | +| flags | u8 | 1 | +| forward_counter | u8 | 1 | +| reserved | u8 | 1 | +| len | u32 (LE) | 4 | +| **合计** | | **16B** | + +### 2.2 AES-GCM 包尾(28B) + +来自 [packet_def.rs](file:///data/project/EasyTier/easytier/src/tunnel/packet_def.rs#L266-L273): + +```text +AesGcmTail { + tag: [u8; 16] // 16B + nonce: [u8; 12] // 12B +} // 合计 28B +``` + +ring ChaCha20-Poly1305 的尾部结构与之同形: +[ring_chacha20.rs](file:///data/project/EasyTier/easytier/src/peers/encrypt/ring_chacha20.rs#L8-L16)。 + +--- + +## 3. 数据面:nonce/epoch/seq 规格 + +### 3.1 Nonce12(12B,明文附在包尾) + +定义: + +| 字段 | 编码 | 大小 | +| -------- | -------------- | ------: | +| epoch | u32 big-endian | 4 | +| seq | u64 big-endian | 8 | +| **合计** | | **12B** | + +记为: + +```text +nonce12 = epoch_be_u32 || seq_be_u64 +``` + +### 3.2 发送端规则(每方向) + +- `seq`:u64 单调递增,从 0 开始,每发送一个包 `seq += 1`。 +- `epoch`:u32,初始为 0。轮换时 `epoch += 1` 并切换到新 key。 +- `nonce12`:按 `epoch||seq` 生成,作为 AEAD nonce,同时明文写入包尾。 + +**安全性要求**:同一把 data key 下,`nonce12` 必须不重复。该要求通过“epoch 变化必然对应 key 变化 + 同一 epoch 内 seq 单调递增”保证。 + +### 3.3 接收端规则(每方向) + +通信是双向的:双方都会为每个对端 peer 维护一份 `PeerSession`。其中发送方向状态用于生成 `nonce12`(见 3.2),接收方向状态用于乱序解密与 anti-replay(见本节与第 5 节)。本节仅描述“接收路径”的处理流程: + +1. 从包尾读取 `nonce12`,解析出 `(epoch, seq)`。 +2. 选择对应 epoch 的 data key(允许短期保留多个 epoch,见 6.2)。 +3. 执行 anti-replay 检查(见 5)。 +4. AEAD 解密 payload(tag 校验失败视为丢包)。 + +--- + +## 4. 数据面:AEAD 封装 + +### 4.1 选择算法 + +本文以“尾部 tag(16) + nonce(12)”为基准,兼容: + +- AES-256-GCM(tag=16, nonce=12, key=32) +- ChaCha20-Poly1305(tag=16, nonce=12, key=32) + +### 4.2 密文布局(以 AEAD tail 形式描述) + +```text +wire_payload = ciphertext || tag16 || nonce12 +``` + +其中: + +- `ciphertext`:对原 payload 的加密结果(与原明文等长) +- `tag16`:AEAD tag(16B) +- `nonce12`:明文(12B),用于乱序解密与 anti-replay + +### 4.3 AAD + +默认:`AAD = empty`(与项目当前 ring encryptor 一致)。 + +扩展(可选):未来可把 `PeerManagerHeader` 的部分字段纳入 AAD(例如 from/to/packet_type/flags),以抵御“改 header 不改密文”的攻击面。该扩展不影响 nonce/epoch/seq 设计。 + +--- + +## 5. anti-replay(最小内存配置) + +### 5.1 默认窗口参数 + +- `window_size = 256` +- `keep_epochs = 2`(current + previous) +- `evict_idle_after = 30s`(某 epoch 长时间无包则回收其窗口与 key) + +### 5.2 ReplayWindow256(概念结构与大小) + +按“尽可能低内存”为目标,建议使用固定大小窗口(bitmap): + +```text +ReplayWindow256 { + max_seq: u64 // 8B + bitmap: [u8; 32] // 256bit = 32B +} // 合计 40B(按字段大小计,不含语言实现的对齐/额外元数据) +``` + +说明: + +- `bitmap` 的第 0 位表示 `max_seq` 是否已见;第 i 位表示 `max_seq - i` 是否已见。 +- 若 `seq > max_seq`:右移窗口并置位。 +- 若 `seq <= max_seq`:计算 `delta = max_seq - seq`,若 `delta >= 256` 丢弃(视为太旧);否则检查 bitmap 是否已置位,已置位则丢弃(重放),未置位则接受并置位。 + +### 5.3 ReplayState(每个对端、每个方向、每个 epoch) + +为减少内存,可用“固定 2 个 epoch 槽位”而非 HashMap: + +```text +EpochRxSlot { + epoch: u32 // 4B + window: ReplayWindow256 // 40B + last_rx_ms: u64 // 8B(用于 30s 淘汰) + valid: bool // 1B(实现细节) +} +``` + +每个对端、每个方向保留 2 个 `EpochRxSlot`: + +- current_epoch_slot +- previous_epoch_slot + +内存量级(按字段大小粗算): + +- 单方向:约 2 * (4 + 40 + 8 + 1) ≈ 106B +- 双方向:约 212B + +加上 epoch key 缓存(见 6.2)仍处于“每对端几百字节”级别。 + +--- + +## 6. epoch 与密钥派生/轮换 + +### 6.1 密钥层次 + +推荐将 Noise 仅用于握手与认证绑定,数据面 key 由一个会话根密钥 `root_key` 派生: + +```text +root_key: [u8; 32] // 会话根密钥材料 +``` + +随后对每个 epoch 与方向派生 traffic key: + +```text +k(epoch, dir) = HKDF(root_key, "et-traffic" || epoch_u32_be || dir_byte) +``` + +- `dir_byte`:发送方向标识(例如 0=tx, 1=rx) +- 输出长度:32B(用于 AES-256-GCM 或 ChaCha20-Poly1305) + +### 6.2 key 缓存(keep_epochs = 2) + +对每个对端 peer、每个方向,缓存 2 个 epoch 的 key: + +```text +EpochKeySlot { + epoch: u32 + key: [u8; 32] // 32B + valid: bool +} +``` + +接收时按 `(epoch)` 选择 key;若 epoch 是 current 或 previous 则可解密,否则丢弃(或可选:尝试少量临近 epoch,代价是试解密)。 + +### 6.3 轮换策略(默认无额外控制消息) + +为减少协议复杂度,默认策略: + +- 发送端在满足“包数阈值”或“时间阈值”时将 `epoch += 1` 并开始使用新 key。 +- 接收端不需要提前知道轮换点:从明文 `nonce12.epoch` 即可选择正确 key。 +- 接收端保留 `keep_epochs=2`,保证轮换期间乱序旧包仍可解密。 + +可选增强(未来): + +- 若希望更强一致性,可定义一个控制包通告 `epoch_advance`,但不是本方案的必要条件。 + +--- + +## 7. 握手层:Noise_XX + 角色/认证/会话根密钥 + +### 7.1 目标 + +在每条 PeerConn 建立时运行 Noise_XX 握手,完成: + +- 交换 `network_name`(尽早判断同网/共享节点) +- 完成共享节点 pubkey pinning(若配置) +- 完成 `network_secret_confirmed`(若双方都有 secret) +- 协商 PeerSession(join 或 create),并在需要时同步 `root_key` 与 `epoch` 起点 + +### 7.2 prologue + +prologue 固定为协议版本字符串,不包含 `network_name`,以避免跨 network_name 的连接被拒绝: + +```text +prologue = "easytier-peerconn-noise" +``` + +### 7.3 PeerSession:join / create / sync 规则 + +本文引入 Peer 级会话 `PeerSession`(每个对端 peer 一份),用于跨多条 PeerConn 复用数据面密钥与 anti-replay 状态。 + +#### 7.3.1 PeerSession 的身份字段 + +数据面不携带 `session_id`,因此会话的“索引键”是外层 `PeerManagerHeader.from_peer_id`(对端 peer_id)。但为了在握手阶段判断 join/create/sync,需要额外维护: + +```text +PeerSessionMeta { + session_generation: u32 // 4B,单调递增,会话根密钥 root_key 的版本号 + auth_level: u8 // 1B,对齐 secure_auth_level 的枚举语义 +} +``` + +语义: + +- `session_generation` 变化表示 `root_key` 发生轮换(create)。 +- `session_generation` 不变表示复用已有 `root_key`(join)。 + +#### 7.3.2 参与方角色 + +- Initiator:发起连接的一方(A) +- Responder:接收连接的一方(B) + +在本方案中,**Responder 对会话选择具有权威性**:最终使用哪一代 `root_key` 以 msg2 返回为准。 + +#### 7.3.3 Responder 的决策(核心) + +Responder 在收到 msg1 后,读取 Initiator 提供的 `a_session_generation`(可选)并与本地 PeerSession 进行对比,按以下优先级决策: + +1. **本地不存在 PeerSession**:执行 `CREATE`(生成新的 `root_key` 与 `session_generation=1`)。 +2. **本地存在 PeerSession 且 a_session_generation 与本地一致**:执行 `JOIN`(不轮换 root_key)。 +3. **本地存在 PeerSession 但 a_session_generation 缺失或不一致**:执行 `SYNC`(不轮换 root_key,但在 msg2 中携带当前 `root_key` 与 `session_generation`,使对端同步到本地会话)。 + +安全性与 DoS 说明: + +- 默认不允许对端通过握手触发 root_key 轮换(避免对端反复拨号导致会话重置)。 +- 只有在“本地不存在会话”或“本地策略显式要求轮换”(例如人工触发、密钥泄露处置)时才执行 `CREATE`。 + +#### 7.3.4 Initiator 的行为 + +Initiator 在握手开始前读取本地是否已有对端 PeerSession: + +- 若存在:在 msg1 中携带本地 `a_session_generation`。 +- 若不存在:msg1 不携带 `a_session_generation`。 + +Initiator 在收到 msg2 后: + +- 若 msg2 为 `JOIN`:继续使用本地 `root_key` 与 `session_generation`(不重置 epoch/seq)。 +- 若 msg2 为 `SYNC` / `CREATE` 且携带 `root_key`:用 msg2 携带的 `root_key` 覆盖本地会话,并将数据面计数器重置为 `initial_epoch`、`seq=0`,重放窗口清空。 + +### 7.4 握手 payload 编码:protobuf vs 固定布局 + +推荐使用 protobuf(pb)来编码 Noise 握手消息的 payload,原因: + +- 易演进(字段可选、可扩展、兼容旧版本) +- 项目内已广泛使用 pb(例如 `HandshakeRequest`) +- 开销可控:除去字符串外,核心字段均为固定长度 bytes(16/32/12),pb 仅增加少量 tag/len varint + +可选方案:固定布局。若你追求极致性能/可预测大小,可将同等字段按固定布局编码。本文以下默认以 protobuf 形式定义字段;固定布局可按同样字段直接平铺实现。 + +### 7.5 握手消息(Noise_XX 的 3 条消息) + +记: + +- msg1: A -> B(payload 明文) +- msg2: B -> A(payload 加密) +- msg3: A -> B(payload 加密) + +#### 7.5.1 pb 定义(字段类型与语义大小) + +下述为“协议级定义”(概念 proto),不要求立刻落入代码生成;实现可在 proto 中新增 message,或先在 Rust 侧用 prost 定义本地 message。 + +```proto +message PeerConnNoiseMsg1Pb { + uint32 version = 1; // varint + string a_network_name = 2; // len <= 64 bytes (建议约束) + optional uint32 a_session_generation = 3; // varint,可选 + bytes a_conn_id = 4; // 16B (UUID) +} + +enum PeerConnSessionActionPb { + JOIN = 0; // 不发送 root_key,表示“继续使用既有会话” + SYNC = 1; // 发送 root_key,用于对端同步到本地会话 + CREATE = 2; // 发送 root_key,表示本地新建会话 +} + +message PeerConnNoiseMsg2Pb { + string b_network_name = 1; // len <= 64 bytes + uint32 role_hint = 2; // 1=同网提示, 2=共享节点/外网提示 + + PeerConnSessionActionPb action = 3; // JOIN/SYNC/CREATE + uint32 b_session_generation = 4; // varint + + optional bytes root_key_32 = 5; // 32B,当 action=SYNC/CREATE 时必须存在 + uint32 initial_epoch = 6; // u32(编码为 varint 或 fixed32 均可),建议语义为 BE u32 值 + + bytes b_conn_id = 7; // 16B (UUID) + bytes a_conn_id_echo = 8; // 16B (UUID) +} + +message PeerConnNoiseMsg3Pb { + bytes a_conn_id_echo = 1; // 16B + bytes b_conn_id_echo = 2; // 16B + + // 可选:network_secret_confirmed 的 proof + optional bytes secret_proof_32 = 3; // 32B +} +``` + +字段语义大小(不含 pb tag/len): + +- UUID:16B +- root_key:32B +- secret_proof:32B +- initial_epoch:4B(逻辑大小;pb 编码本身为 varint/fixed32,wire 大小可变或 4B) + +#### 7.5.2 msg1 payload(A -> B,明文) + +```text +payload_bytes = PeerConnNoiseMsg1Pb.encode_to_vec() +``` + +说明: + +- 该 payload 为明文,因此不放 `root_key` 等敏感材料。 +- `a_network_name` 用于角色提示。 +- `a_session_generation` 用于 Responder 做 join/sync/create 决策。 +- `a_conn_id` 用于本次连接绑定(防拼接),将在 msg2/msg3 回显。 + +#### 7.5.3 msg2 payload(B -> A,加密) + +```text +payload_bytes = PeerConnNoiseMsg2Pb.encode_to_vec() +``` + +说明: + +- `action` 决定本次握手是否会更新会话根密钥: + - `JOIN`:不发送 `root_key_32`,表示“继续使用既有会话” + - `SYNC`:发送 `root_key_32`,用于对端同步到本地既有会话 + - `CREATE`:发送 `root_key_32`,表示本地创建新会话 +- `initial_epoch` 默认 0;若需要随机化,可设置为随机 u32,但需要接收端 key/窗口缓存支持更复杂的淘汰策略。 +- `a_conn_id_echo` 与 `b_conn_id` 用于连接绑定;msg3 将回显两者以确认双方看到同一组值。 + +#### 7.5.4 msg3 payload(A -> B,加密) + +```text +payload_bytes = PeerConnNoiseMsg3Pb.encode_to_vec() +``` + +`secret_proof_32`(可选)用于 `network_secret_confirmed`: + +```text +secret_proof = HMAC-SHA256( + key = derive(network_secret), + data = role_byte || handshake_hash +) +``` + +其中 `handshake_hash` 由 Noise 提供,`role_byte` 用于区分双方角色(client/server)。 + +### 7.6 pinning(共享节点) + +- 配置位置:`PeerConfig.peer_public_key`(base64,32B)。 +- 校验时机:Noise 握手结束后,A 读取 `remote_static_pubkey`,若配置了 pinned 则必须匹配,否则断连。 + +--- + +## 8. 角色判断与安全语义 + +- `network_name` 的比较足以用于 **角色提示**: + - `a_network_name == b_network_name`:同网提示 + - 否则:共享节点/外网提示 +- 但 `network_name` **不是认证锚点**。安全决策仅应基于: + - 共享节点 pinning 成功(`shared_node_pubkey_verified`) + - 或 network_secret_confirmed 成功(`network_secret_confirmed`) +- 在未完成上述任一认证前,连接为 `encrypted_unauthenticated`:仅保证机密性/完整性,不保证对端身份,存在 MITM 风险。 + +--- + +## 9. 与包尾 nonce 加密格式的关系 + +项目当前的 ring chacha20 加密实现使用随机 nonce 并将 nonce 明文附在包尾: +[ring_chacha20.rs](file:///data/project/EasyTier/easytier/src/peers/encrypt/ring_chacha20.rs#L69-L93) + +本文将随机 nonce 替换为结构化 `epoch||seq`: + +- 仍为 12B +- 仍明文放包尾 +- 但语义从“随机唯一”变为“可乱序解密 + 可 anti-replay + 可轮换” + +--- + +## 10. 默认参数汇总 + +- nonce:12B = epoch(u32 BE) + seq(u64 BE) +- tag:16B +- key:32B(AES-256-GCM 或 ChaCha20-Poly1305) +- replay window:256(bitmap 32B) +- keep_epochs:2(current + previous) +- evict_idle_after:30s diff --git a/vendor/easytier/easytier/docs/relay_peer_manager_design.md b/vendor/easytier/easytier/docs/relay_peer_manager_design.md new file mode 100644 index 0000000..3be4fb0 --- /dev/null +++ b/vendor/easytier/easytier/docs/relay_peer_manager_design.md @@ -0,0 +1,177 @@ +# Relay Peer 管理模块设计文档 + +## 背景与现状 + +当前出站转发路径中,PeerManager 根据路由直接选择下一跳并发送,转发路径以“取下一跳 → 发送”为核心流程: + +- 发送内部路径:[peer_manager.rs:L1053-L1082](file:///data/project/EasyTier/easytier/src/peers/peer_manager.rs#L1053-L1082) +- 数据面发送入口:[peer_manager.rs:L1187-L1238](file:///data/project/EasyTier/easytier/src/peers/peer_manager.rs#L1187-L1238) + +现状缺少面向“非直连目标”的统一管理模块,无法对 Relay Peer 进行会话、状态与策略层面的治理。 + +## 设计目标 + +- 对非直连 Relay Peer 做生命周期管理 +- 提供统一的会话(如 PeerSession)与路径选择入口 +- 与现有路由模块解耦,只消费下一跳候选与路由变更信息 +- 不改变现有数据面主路径流程 + +## 架构设计 + +### 模块命名 + +**RelayPeerMap** + +### 引用关系 + +- **PeerManager**: 作为顶层协调者,同时持有 `Arc` 和 `Arc`。 +- **RelayPeerMap**: 持有 `Arc`(或 `Weak`),用于在决策后调用底层发送能力。 +- **PeerMap**: 专注直连 Peer 管理与基础路由表维护,不直接持有 RelayPeerMap(避免循环依赖)。 + +### 职责划分 + +- **PeerManager**: + - 发送入口。 + - 判断目标是否直连: + - 若目标在 PeerMap:直接调用 `PeerMap` 发送。 + - 若目标不在 PeerMap:调用 `RelayPeerMap` 处理。 +- **RelayPeerMap**: + - 维护非直连 Peer 的状态(会话、健康度)。 + - 决策下一跳(Next Hop)。 + - 调用 `PeerMap` 将数据包发送给下一跳。 +- **ForeignNetworkManager**: + - 拥有独立的 RelayPeerMap 实例,用于 foreign network 的非直连转发。 +- **PeerMap**: + - 维护直连 Peer 连接。 + - 提供基础路由表查询。 + - 执行向直连邻居的物理发送。 + +## 数据模型 + +### RelayPeerKey + +- **dst_peer_id** (PeerId) +- 注:RelayPeerMap 实例隶属于特定网络上下文,因此 Key 仅需 PeerId。 + +### RelayPeerState + +- selected_next_hop: PeerId +- session: Option +- last_active_at: Instant +- path_metrics: latency, loss, hop_count (可选) + +### RelayPathCandidate + +- next_hop_peer_id +- cost / latency / availability + +## 简化状态管理 + +不再引入复杂状态机(如 Establishing/Suspect 等),仅依赖以下状态判断: + +- **会话是否存在**:`session.is_some()` +- **会话是否有效**:检查 session 过期时间或 generation +- **路由是否可达**:检查路由表中是否有 next hop + +## 关键流程 + +### 出站发送流程(非直连) + +1. **PeerManager** 接收发送请求(目标 `dst_peer_id`)。 +2. **PeerManager** 检查 `PeerMap` 是否直连 `dst_peer_id`。 +3. 若非直连,**PeerManager** 将请求转交给 **RelayPeerMap**。 +4. **RelayPeerMap** 处理: + - 查找 `RelayPeerState`。 + - 若首次与该 Relay Peer 通信,创建 RelayPeerState 并进入握手流程。 + - 确保会话存在(若无则触发握手与同步)。 + - 选择下一跳(由 RelayPeerMap 决策)。 + - 调用 **PeerMap** 的 `send_msg_directly(next_hop, packet)`。 + +### Relay 数据面握手出站流程(Relay Peer 特例) + +说明:Relay Peer 初次通信前必须先完成基于数据面消息的 Noise 握手,否则无法安全发送加密数据面包。握手消息通过普通数据面路径转发,但其目标是创建会话而非携带业务数据。 + +流程要点(发起方视角): + +1. 发送路径命中 `dst_peer_id` 为非直连目标后,进入 RelayPeerMap 流程。 +2. 若目标会话不存在或已失效,则发送 **RelayHandshake** 消息(携带 `m1`),通过 `send_msg_directly(next_hop, packet)` 转发给对端。 +3. 对端收到后返回 **RelayHandshakeAck**(携带 `m2`)沿原路径回传,双方派生会话并落库。 +4. 握手完成后,使用已建立会话的密钥对数据面包加密/鉴别,再走正常转发流程。 +5. 若握手失败或控制面公钥信息缺失,则不进入数据发送,返回可重试的错误(由上层决定重试节奏)。 + +### Relay 会话建立流程(数据面 + Noise 1-RTT) + +背景:直连 Peer 的 Noise 握手在 `PeerConn` 内完成;Relay Peer 没有 `PeerConn`,因此无法复用该握手逻辑。Relay 会话需要通过 **数据面握手消息** 完成握手与密钥派生,并把结果落到 `PeerSessionStore`(或等价的会话存储)中供数据面复用。 + +关键假设:Relay Peer 握手前即可拿到对端静态公钥(通过 OSPF 等控制面传播),因此可选用 **1-RTT 的 Noise 握手模式**(例如 IK/KK 一类的两报文握手),并将“两报文”映射为 **RelayHandshake / RelayHandshakeAck** 两种数据面消息。 + +建议流程(以本端作为 initiator 为例): + +1. `ensure_session(dst_peer_id)` 发现无可用会话,触发一次握手流程(可选:对并发请求做 in-flight 去重)。 +2. 从控制面缓存中读取 `dst_peer_id` 的静态公钥(若不存在则等待控制面收敛,或退化为非 1-RTT 的握手模式)。 +3. 生成 Noise 握手首报文 `m1`(包含必要的认证信息与抗重放字段,例如 session generation / nonce / 时间窗等)。 +4. 发送 `RelayHandshake(m1)`,对端返回 `RelayHandshakeAck(m2)`。 +5. initiator 处理 `m2`,双方派生出相同的会话密钥与会话标识,将会话写入 `PeerSessionStore`,供后续发送复用。 +6. 后续 Relay 数据面包使用该会话密钥进行加解密/鉴别(具体包格式不在本层定义,保持与直连会话的语义一致)。 + +实现要点: + +- **角色确定**:为避免并发双向握手导致的竞态,可使用确定性规则选择 initiator(如 `min(peer_id)` 发起),或由第一次发送方发起并在冲突时做幂等合并。 +- **幂等与重试**:数据面握手应支持重试(同一 generation/nonce 重放可安全拒绝或复用),并与路由收敛解耦。 +- **会话绑定**:握手需绑定 `dst_peer_id` 与其静态公钥指纹,避免控制面短暂不一致造成的密钥混用。 + +### 会话管理 + +- PeerSessionStore 仅用于 secure mode,会话创建与密钥派生在该模式下生效。 +- 在发送时若发现无会话,则触发 Create/Join/Sync 逻辑。 +- 对于 Relay Peer,会话创建阶段由 **数据面握手消息承载 Noise 握手**(见上节),以替代直连 `PeerConn` 内的握手流程。 + +### PacketType 规划(新增) + +- 新增 PacketType: + - `RelayHandshake`:承载 `m1`(initiator -> responder) + - `RelayHandshakeAck`:承载 `m2`(responder -> initiator) +- 载荷建议: + - `RelayHandshake`: `RelayNoiseMsg1Pb`(包含 a_session_generation/conn_id/算法等字段) + - `RelayHandshakeAck`: `RelayNoiseMsg2Pb`(包含 b_session_generation/root_key/initial_epoch/算法等字段) +- 约束: + - 两类包应与普通 Data 包一样可被转发,但不应被当作业务数据消费。 + - 需要在路由转发链路中识别为“握手控制类”消息。 + +## 策略设计 + +- 下一跳策略由 RelayPeerMap 决策,可结合 latency_first 选择 LeastHop 或 LatencyFirst。 +- 握手策略:优先采用“已知对端静态公钥”的 **1-RTT Noise 握手**,并通过 **RelayHandshake/RelayHandshakeAck** 消息触发会话建立。 +- 失败处理:依赖上层重试或底层路由收敛,暂不在此层做复杂的 Failover 状态流转。 +- 公钥来源:对端静态公钥以控制面传播为准;在控制面信息缺失或变更时,应阻止复用旧会话或触发重新握手。 + +## 接口草案 + +### RelayPeerMap 接口 + +- `send_msg(packet, dst_peer_id)`: 处理非直连发送逻辑。 +- `ensure_session(dst_peer_id)`: 确保会话可用。 +- `handshake_session(dst_peer_id)`: 通过握手消息完成 Relay 会话握手(对上层透明,可由 `ensure_session` 内部调用)。 +- `remove_peer(dst_peer_id)`: 删除已经失效的 Peer。 +## 监控与指标建议 + +- Relay 会话数 +- Relay 发送成功/失败计数 + +## 渐进式落地计划 + +### 阶段 1:基础能力 + +- 引入 RelayPeerMap 结构。 +- 在 PeerManager 中集成 RelayPeerMap。 +- 实现基础的“非直连转发”委托逻辑。 + +## 兼容性说明 + +- 需要新增 PacketType 用于 RelayHandshake/RelayHandshakeAck。 +- 在 secure mode 下,压缩由 PeerManager 完成;加密由 PeerConn(直连)或 RelayPeer(非直连)完成。 +- RelayPeer 在 secure mode 下需要提供会话级加密/解密入口: + - 发送:在 RelayPeerMap 决策完成后、调用 `send_msg_directly` 前,用 Relay 会话密钥加密。 + - 接收:在数据面包进入业务处理前,按 `from_peer_id/to_peer_id` 定位会话并解密。 +- PeerSessionStore 为 secure mode 的会话兼容性保留,非 secure mode 仅保持现有行为。 +- 不改变路由模块的计算结果。 diff --git a/vendor/easytier/easytier/locales/app.yml b/vendor/easytier/easytier/locales/app.yml new file mode 100644 index 0000000..d20b243 --- /dev/null +++ b/vendor/easytier/easytier/locales/app.yml @@ -0,0 +1,306 @@ +_version: 2 + +core_clap: + config_server: + en: |+ + config server address, must be a full URL: + --config-server udp://127.0.0.1:22020/admin, 'udp' can be replaced with tcp, ws, wss (when config server ws is proxied to wss) + zh-CN: |+ + 配置服务器地址,必须使用完整 URL: + --config-server udp://127.0.0.1:22020/admin,udp 可以根据配置服务器替换为 tcp、ws、wss(配置服务器 ws 被代理为 wss 时) + machine_id: + en: |+ + the machine id to identify this machine, used for config recovery after disconnection, must be unique and fixed. by default it is loaded from persisted local state; on first start it may be migrated from system information or generated, then remains fixed. + zh-CN: |+ + Web 配置服务器通过 machine id 来识别机器,用于断线重连后的配置恢复,需要保证唯一且固定不变。默认从本地持久化状态读取;首次启动时可能基于系统信息迁移或生成,之后保持固定不变。 + config_file: + en: "path to the config file, NOTE: the options set by cmdline args will override options in config file" + zh-CN: "配置文件路径,注意:命令行中的配置的选项会覆盖配置文件中的选项" + config_dir: + en: "Load all .toml files in the directory to start network instances, and store the received configurations in this directory." + zh-CN: "加载目录中的所有 .toml 文件以启动网络实例,并将下发的配置保存在此目录中。" + disable_env_parsing: + en: "disable environment variable parsing in config file" + zh-CN: "禁用配置文件中的环境变量解析" + generate_completions: + en: "generate shell completions" + zh-CN: "生成 shell 补全脚本" + network_name: + en: "network name to identify this vpn network" + zh-CN: "用于标识此VPN网络的网络名称" + network_secret: + en: "network secret to verify this node belongs to the vpn network" + zh-CN: "网络密钥,用于验证此节点属于VPN网络" + ipv4: + en: "ipv4 address of this vpn node, if empty, this node will only forward packets and no TUN device will be created" + zh-CN: "此VPN节点的IPv4地址,如果为空,则此节点将仅转发数据包,不会创建TUN设备" + ipv6: + en: "ipv6 address of this vpn node, can be used together with ipv4 for dual-stack operation" + zh-CN: "此VPN节点的IPv6地址,可与IPv4一起使用以进行双栈操作" + ipv6_public_addr_provider: + en: "share this node's public IPv6 subnet with other peers so they can obtain public IPv6 addresses (Linux only)" + zh-CN: "将此节点的公网 IPv6 子网共享给其他节点,使它们也能获得公网 IPv6 地址(仅 Linux 支持)" + ipv6_public_addr_auto: + en: "auto-obtain a public IPv6 address from a peer that shares its IPv6 subnet" + zh-CN: "自动从共享了 IPv6 子网的对等节点获取一个公网 IPv6 地址" + ipv6_public_addr_prefix: + en: "manually specify the public IPv6 subnet to share, instead of auto-detecting from system routes" + zh-CN: "手动指定要共享的公网 IPv6 子网,不自动从系统路由检测" + dhcp: + en: "automatically determine and set IP address by Easytier, and the IP address starts from 10.0.0.1 by default. Warning, if there is an IP conflict in the network when using DHCP, the IP will be automatically changed." + zh-CN: "由Easytier自动确定并设置IP地址,默认从10.0.0.1开始。警告:在使用DHCP时,如果网络中出现IP冲突,IP将自动更改。" + peers: + en: "peers to connect initially" + zh-CN: "最初要连接的对等节点" + external_node: + en: "use a public shared node to discover peers" + zh-CN: "使用公共共享节点来发现对等节点" + proxy_networks: + en: |+ + export local networks to other peers in the vpn, e.g.: 10.0.0.0/24. + also support mapping proxy network to other cidr, e.g.: 10.0.0.0/24->192.168.0.0/24 + other peers can access 10.0.0.1 with ip 192.168.0.1 + zh-CN: |+ + 将本地网络导出到VPN中的其他对等节点,例如:10.0.0.0/24。 + 还支持将代理网络映射到其他CIDR,例如:10.0.0.0/24->192.168.0.0/24 + 其他对等节点可以通过 IP 192.168.0.1 来访问 10.0.0.1 + rpc_portal: + en: "rpc portal address to listen for management. 0 means random port, 12345 means listen on 12345 of localhost, 0.0.0.0:12345 means listen on 12345 of all interfaces. default is 0 and will try 15888 first" + zh-CN: "用于管理的RPC门户地址。0表示随机端口,12345表示在localhost的12345上监听,0.0.0.0:12345表示在所有接口的12345上监听。默认是0,首先尝试15888" + rpc_portal_whitelist: + en: "rpc portal whitelist, only allow these addresses to access rpc portal, e.g.: 127.0.0.1,127.0.0.0/8,::1/128" + zh-CN: "RPC门户白名单,仅允许这些地址访问RPC门户,例如:127.0.0.1/32,127.0.0.0/8,::1/128" + listeners: + en: |+ + listeners to accept connections, allow format: + port number: <11010>. means tcp/udp will listen on 11010, ws/wss will listen on 11010 and 11011, wg will listen on 11011 + url: . tcp can be tcp, udp, ring, wg, ws, wss, quic, faketcp\n + proto & port pair: . wg:11011, means listen on 11011 with wireguard protocol url and proto:port can occur multiple times. + zh-CN: |+ + 监听器用于接受连接,允许以下格式: + 端口号:<11010>,意味着tcp/udp将在11010端口监听,ws/wss将在11010和11011端口监听,wg将在11011端口监听。 + url:,其中tcp可以是tcp、udp、ring、wg、ws、wss、quic、faketcp协议。 + 协议和端口对:,例如wg:11011,表示使用WireGuard协议在11011端口监听。URL 和 协议端口对 可以多次出现。 + no_listener: + en: "do not listen on any port, only connect to peers" + zh-CN: "不监听任何端口,只连接到对等节点" + console_log_level: + en: "console log level" + zh-CN: "控制台日志级别" + file_log_level: + en: "file log level" + zh-CN: "文件日志级别" + file_log_dir: + en: "directory to store log files" + zh-CN: "存储日志文件的目录" + hostname: + en: "host name to identify this device" + zh-CN: "用于标识此设备的主机名" + instance_name: + en: "instance name to identify this vpn node in same machine" + zh-CN: "实例名称,用于在同一台机器上标识此VPN节点" + vpn_portal: + en: "WireGuard VPN portal listener URL, for example wg://0.0.0.0:51820" + zh-CN: "WireGuard VPN 门户监听 URL,例如 wg://0.0.0.0:51820" + vpn_portal_private_key: + en: "base64 WireGuard server private key (prefer ET_VPN_PORTAL_PRIVATE_KEY over command-line exposure)" + zh-CN: "Base64 WireGuard 服务端私钥(建议通过 ET_VPN_PORTAL_PRIVATE_KEY 传入,避免命令行暴露)" + vpn_portal_client: + en: "named VPN portal client in NAME=CIDR form, for example alice=10.144.0.5/16; may be repeated" + zh-CN: "NAME=CIDR 格式的具名 VPN 门户客户端,例如 alice=10.144.0.5/16;可重复指定" + vpn_portal_client_group: + en: "VPN portal client group membership in NAME=GROUP form; may be repeated" + zh-CN: "NAME=GROUP 格式的 VPN 门户客户端组成员关系;可重复指定" + default_protocol: + en: "default protocol to use when connecting to peers" + zh-CN: "连接到对等节点时使用的默认协议" + disable_encryption: + en: "disable encryption for peers communication, default is false, must be same with peers" + zh-CN: "禁用对等节点通信的加密,默认为false,必须与对等节点相同" + encryption_algorithm: + en: "encryption algorithm to use, supported: '', 'xor', 'chacha20', 'aes-gcm', 'aes-gcm-256', 'openssl-aes128-gcm', 'openssl-aes256-gcm', 'openssl-chacha20'. Empty string means default (aes-gcm)" + zh-CN: "要使用的加密算法,支持:''(默认aes-gcm)、'xor'、'chacha20'、'aes-gcm'、'aes-gcm-256'、'openssl-aes128-gcm'、'openssl-aes256-gcm'、'openssl-chacha20'" + multi_thread: + en: "use multi-thread runtime, default is single-thread" + zh-CN: "使用多线程运行时,默认为单线程" + multi_thread_count: + en: "the number of threads to use, default is 2, only effective when multi-thread is enabled, must be greater than 2" + zh-CN: "使用的线程数,默认为2,仅在多线程模式下有效。取值必须大于2" + disable_ipv6: + en: "do not use ipv6" + zh-CN: "不使用IPv6" + dev_name: + en: "optional tun interface name" + zh-CN: "可选的TUN接口名称" + mtu: + en: "mtu of the TUN device, default is 1380 for non-encryption, 1360 for encryption" + zh-CN: "TUN设备的MTU,默认为非加密时为1380,加密时为1360" + latency_first: + en: "latency first mode, will try to relay traffic with lowest latency path, default is using shortest path" + zh-CN: "延迟优先模式,将尝试使用最低延迟路径转发流量,默认使用最短路径" + exit_nodes: + en: "exit nodes to forward all traffic to, a virtual ipv4 address, priority is determined by the order of the list" + zh-CN: "转发所有流量的出口节点,虚拟IPv4地址,优先级由列表顺序决定" + enable_exit_node: + en: "allow this node to be an exit node" + zh-CN: "允许此节点成为出口节点" + proxy_forward_by_system: + en: "forward packet to proxy networks via system kernel, disable internal nat for network proxy" + zh-CN: "通过系统内核转发子网代理数据包,禁用内置NAT" + no_tun: + en: "do not create TUN device, can use subnet proxy to access node" + zh-CN: "不创建TUN设备,可以使用子网代理访问节点" + use_smoltcp: + en: "enable smoltcp stack for subnet proxy and kcp proxy" + zh-CN: "为子网代理和 KCP 代理启用smoltcp堆栈" + manual_routes: + en: "assign routes cidr manually, will disable subnet proxy and wireguard routes propagated from peers. e.g.: 192.168.0.0/16" + zh-CN: "手动分配路由CIDR,将禁用子网代理和从对等节点传播的wireguard路由。例如:192.168.0.0/16" + relay_network_whitelist: + en: |+ + only forward traffic from the whitelist networks, supporting wildcard strings, multiple network names can be separated by spaces. + if local network (assigned with network_name) is not in the whitelist, the traffic can still be forwarded if no other route path is available. + if this parameter is empty, forwarding is disabled. by default, all networks are allowed. + e.g.: '*' (all networks), 'def*' (networks with the prefix 'def'), 'net1 net2' (only allow net1 and net2)" + zh-CN: |+ + 仅转发白名单网络的流量,支持通配符字符串。多个网络名称间可以使用英文空格间隔。 + 如果本地网络(使用 network_name 分配)不在白名单中,如果没有其他路由路径可用,流量仍然可以转发。 + 如果该参数为空,则禁用转发。默认允许所有网络。 + 例如:'*'(所有网络),'def*'(以def为前缀的网络),'net1 net2'(只允许net1和net2)" + disable_p2p: + en: "disable ordinary automatic p2p; still establish p2p with peers marked as need-p2p, and other peers should not proactively connect to this node" + zh-CN: "禁用普通自动P2P;仍会与标记为 need-p2p 的节点建立P2P连接,其他节点不应主动与当前节点建立P2P" + p2p_only: + en: "only communicate with peers that already establish p2p connection" + zh-CN: "仅与已经建立P2P连接的对等节点通信" + lazy_p2p: + en: "only try to establish p2p when traffic actually needs the peer; peers marked as need-p2p are still connected proactively" + zh-CN: "仅在实际流量需要某个对等节点时才尝试建立P2P;被标记为 need-p2p 的节点仍会主动建立连接" + need_p2p: + en: "announce that other peers should proactively establish p2p connections to this node even when they enable lazy-p2p" + zh-CN: "声明即使其他节点启用了 lazy-p2p,也应主动与当前节点建立P2P连接" + disable_tcp_hole_punching: + en: "disable tcp hole punching" + zh-CN: "禁用TCP打洞功能" + disable_udp_hole_punching: + en: "disable udp hole punching" + zh-CN: "禁用UDP打洞功能" + disable_sym_hole_punching: + en: "if true, disable udp nat hole punching for symmetric nat (NAT4), which is based on birthday attack and may be blocked by ISP." + zh-CN: "如果为true,则禁用基于生日攻击的对称NAT (NAT4) UDP 打洞功能,该打洞方式可能会被运营商封锁" + disable_upnp: + en: "disable runtime UPnP/NAT-PMP port mapping for eligible listeners; automatic port mapping is enabled by default" + zh-CN: "禁用符合条件监听器的运行时 UPnP/NAT-PMP 端口映射;自动端口映射默认开启" + enable_udp_broadcast_relay: + en: "Windows only: capture local UDP broadcast packets from physical interfaces and forward them to EasyTier peers. Helps games to find rooms in local network. Requires administrator privileges." + zh-CN: "仅 Windows:捕获物理网卡上的本机 UDP 广播包并转发给 EasyTier 对等节点,帮助局域网游戏发现房间。需要管理员权限。" + relay_all_peer_rpc: + en: "relay all peer rpc packets, even if the peer is not in the relay network whitelist. this can help peers not in relay network whitelist to establish p2p connection." + zh-CN: "转发所有对等节点的RPC数据包,即使对等节点不在转发网络白名单中。这可以帮助白名单外网络中的对等节点建立P2P连接。" + socks5: + en: "enable socks5 server, allow socks5 client to access virtual network. format: , e.g.: 1080" + zh-CN: "启用 socks5 服务器,允许 socks5 客户端访问虚拟网络. 格式: <端口>,例如:1080" + ipv6_listener: + en: "the url of the ipv6 listener, e.g.: tcp://[::]:11010, if not set, will listen on random udp port" + zh-CN: "IPv6 监听器的URL,例如:tcp://[::]:11010,如果未设置,将在随机UDP端口上监听" + compression: + en: "compression algorithm to use, support none, zstd. default is none" + zh-CN: "要使用的压缩算法,支持 none、zstd。默认为 none" + mapped_listeners: + en: "manually specify the public address of the listener, other nodes can use this address to connect to this node. e.g.: tcp://123.123.123.123:11223, can specify multiple." + zh-CN: "手动指定监听器的公网地址,其他节点可以使用该地址连接到本节点。例如:tcp://123.123.123.123:11223,可以指定多个。" + bind_device: + en: "bind the connector socket to physical devices to avoid routing issues. e.g.: subnet proxy segment conflicts with a node's segment, after binding the physical device, it can communicate with the node normally." + zh-CN: "将连接器的套接字绑定到物理设备以避免路由问题。比如子网代理网段与某节点的网段冲突,绑定物理设备后可以与该节点正常通信。" + socket_mark: + en: "Linux only: set SO_MARK (fwmark) on EasyTier's underlay sockets (TCP, UDP, QUIC, WebSocket, WireGuard, and the FakeTCP decoy socket) so the host can policy-route or filter them with 'ip rule fwmark ...', nftables ('meta mark'), or iptables ('-m mark'). Any value is applied verbatim (0 is a valid mark); omit the flag to leave SO_MARK untouched. Requires CAP_NET_ADMIN. Note: FakeTCP payload travels via raw TUN writes which the kernel does not tag — mark those separately on the TUN device if needed." + zh-CN: "仅 Linux: 在 EasyTier 的底层套接字 (TCP、UDP、QUIC、WebSocket、WireGuard 以及 FakeTCP 诱饵套接字) 上设置 SO_MARK (fwmark),使主机能用 'ip rule fwmark ...'、nftables ('meta mark') 或 iptables ('-m mark') 策略路由/过滤这些数据包。任何值都会原样应用 (0 也是合法的 mark);不传该参数即保持 SO_MARK 不变。需要 CAP_NET_ADMIN 权限。注意:FakeTCP 的实际载荷通过原始 TUN 写入,内核不会为其打标记;如有需要请在 TUN 设备上单独打标记。" + enable_kcp_proxy: + en: "proxy tcp streams with kcp, improving the latency and throughput on the network with udp packet loss." + zh-CN: "使用 KCP 代理 TCP 流,提高在 UDP 丢包网络上的延迟和吞吐量。" + disable_kcp_input: + en: "do not allow other nodes to use kcp to proxy tcp streams to this node. when a node with kcp proxy enabled accesses this node, the original tcp connection is preserved." + zh-CN: "不允许其他节点使用 KCP 代理 TCP 流到此节点。开启 KCP 代理的节点访问此节点时,依然使用原始 TCP 连接。" + enable_quic_proxy: + en: "proxy tcp streams with QUIC, improving the latency and throughput on the network with udp packet loss." + zh-CN: "使用 QUIC 代理 TCP 流,提高在 UDP 丢包网络上的延迟和吞吐量。" + disable_quic_input: + en: "do not allow other nodes to use QUIC to proxy tcp streams to this node. when a node with QUIC proxy enabled accesses this node, the original tcp connection is preserved." + zh-CN: "不允许其他节点使用 QUIC 代理 TCP 流到此节点。开启 QUIC 代理的节点访问此节点时,依然使用原始 TCP 连接。" + port_forward: + en: "forward local port to remote port in virtual network. e.g.: udp://0.0.0.0:12345/10.126.126.1:23456, means forward local udp port 12345 to 10.126.126.1:23456 in the virtual network. can specify multiple." + zh-CN: "将本地端口转发到虚拟网络中的远程端口。例如:udp://0.0.0.0:12345/10.126.126.1:23456,表示将本地UDP端口12345转发到虚拟网络中的10.126.126.1:23456。可以指定多个。" + accept_dns: + en: "if true, enable magic dns. with magic dns, you can access other nodes with a domain name, e.g.: .et.net. magic dns will modify your system dns settings, enable it carefully." + zh-CN: "如果为true,则启用魔法DNS。使用魔法DNS,您可以使用域名访问其他节点,例如:.et.net。魔法DNS将修改您的系统DNS设置,请谨慎启用。" + tld_dns_zone: + en: "specify the top-level domain zone for magic DNS. if not provided, defaults to the value from dns_server module (et.net.). only used when accept_dns is true." + zh-CN: "指定魔法DNS的顶级域名区域。如果未提供,默认使用dns_server模块中的值(et.net.)。仅在accept_dns为true时使用。" + private_mode: + en: "if true, foreign networks are only allowed when this node can verify they use the same network secret, or when a foreign credential node is already trusted via admin-issued credential propagation; different or missing secrets are otherwise rejected." + zh-CN: "如果为true,则仅允许两类 foreign network 接入:本节点能验证其使用相同 network secret 的节点,或已通过 foreign network 管理节点传播而被信任的 credential 节点;否则 secret 不同或缺失时会被拒绝。" + foreign_relay_bps_limit: + en: "the maximum bps limit for foreign network relay, default is no limit. unit: BPS (bytes per second)" + zh-CN: "作为共享节点时,限制非本地网络的流量转发速率,默认无限制,单位 BPS (字节每秒)" + instance_recv_bps_limit: + en: "the maximum total receive bps limit for this instance, default is no limit. unit: BPS (bytes per second)" + zh-CN: "限制当前网络实例整体入站流量的总接收速率,默认无限制,单位 BPS (字节每秒)" + tcp_whitelist: + en: "tcp port whitelist. Supports single ports (80) and ranges (8000-9000)" + zh-CN: "TCP 端口白名单。支持单个端口(80)和范围(8000-9000)" + udp_whitelist: + en: "udp port whitelist. Supports single ports (53) and ranges (5000-6000)" + zh-CN: "UDP 端口白名单。支持单个端口(53)和范围(5000-6000)" + disable_relay_kcp: + en: "if true, disable relay kcp packets. avoid consuming too many bandwidth. default is false" + zh-CN: "如果为true,则禁止节点转发 KCP 数据包,防止过度消耗流量。默认值为false" + disable_relay_quic: + en: "if true, disable relay quic packets. avoid consuming too many bandwidth. default is false" + zh-CN: "如果为true,则禁止节点转发 QUIC 数据包,防止过度消耗流量。默认值为false" + enable_relay_foreign_network_kcp: + en: "if true, allow relay kcp packets from foreign network. default is false (not forward foreign network kcp packets)" + zh-CN: "如果为true,则作为共享节点时也可以转发其他网络的 KCP 数据包。默认值为false(不转发)" + enable_relay_foreign_network_quic: + en: "if true, allow relay quic packets from foreign network. default is false (not forward foreign network quic packets)" + zh-CN: "如果为true,则作为共享节点时也可以转发其他网络的 QUIC 数据包。默认值为false(不转发)" + stun_servers: + en: "Override default UDP STUN servers. TCP STUN also uses this list when tcp-stun-servers is unset. If configured but empty, UDP STUN and fallback TCP/IPv6 STUN are disabled" + zh-CN: "覆盖内置的默认 UDP STUN server 列表;未设置 tcp-stun-servers 时,TCP STUN 也使用此列表;如果设置了但是为空,则禁用 UDP STUN 以及回退的 TCP/IPv6 STUN" + stun_servers_v6: + en: "Override default IPv6 STUN servers. If unset while stun-servers is configured, IPv6 STUN is disabled. If configured but empty, IPv6 STUN servers are not used" + zh-CN: "覆盖内置的默认 IPv6 STUN server 列表;如果未设置但已设置 stun-servers,则禁用 IPv6 STUN;如果设置了但是为空,则不使用 IPv6 STUN servers" + tcp_stun_servers: + en: "Override default TCP STUN servers. If unset, TCP STUN uses stun-servers when configured, otherwise default TCP STUN servers. If configured but empty, TCP STUN is disabled" + zh-CN: "覆盖内置的默认 TCP STUN server 列表;如果未设置,TCP STUN 会优先使用 stun-servers,否则使用默认 TCP STUN server 列表;如果设置了但是为空,则禁用 TCP STUN" + secure_mode: + en: "if true, enable secure mode. default is false" + zh-CN: "如果为true,则启用安全模式。默认值为false" + local_private_key: + en: "local private key for secure mode. if not provided, a random key will be generated" + zh-CN: "安全模式下的本地私钥。如果未提供,则会随机生成一个密钥" + local_public_key: + en: "local public key for secure mode. if not provided, a random key will be generated, or use local private key to derive public key" + zh-CN: "安全模式下的本地公钥。如果未提供,则会随机生成一个密钥,或者使用本地私钥派生公钥" + credential: + en: "credential secret (base64-encoded private key) for joining network as a temporary node without network_secret" + zh-CN: "凭据密钥(base64编码的私钥),用于作为临时节点加入网络,无需 network_secret" + credential_file: + en: "path to credential storage file for persisting generated credentials across restarts (admin nodes)" + zh-CN: "凭据存储文件路径,用于在管理节点重启后保留已生成的凭据" + check_config: + en: Check config validity without starting the network + zh-CN: 检查配置文件的有效性并退出 + daemon: + en: Run in daemon mode + zh-CN: 以守护进程模式运行 + file_log_size_mb: + en: "per file log size in MB, default is 100MB" + zh-CN: "单个文件日志大小,单位 MB,默认值为 100MB" + file_log_count: + en: "max file log count, default is 10" + zh-CN: "最大文件日志数量,默认值为 10" + +core_app: + panic_backtrace_save: + en: "backtrace saved to easytier-panic.log" + zh-CN: "回溯信息已保存到easytier-panic.log" diff --git a/vendor/easytier/easytier/src/arch/mod.rs b/vendor/easytier/easytier/src/arch/mod.rs new file mode 100644 index 0000000..581af77 --- /dev/null +++ b/vendor/easytier/easytier/src/arch/mod.rs @@ -0,0 +1,2 @@ +#[cfg(target_os = "windows")] +pub mod windows; diff --git a/vendor/easytier/easytier/src/arch/windows.rs b/vendor/easytier/easytier/src/arch/windows.rs new file mode 100644 index 0000000..d8e113f --- /dev/null +++ b/vendor/easytier/easytier/src/arch/windows.rs @@ -0,0 +1,535 @@ +use std::{io, mem::ManuallyDrop, net::SocketAddr, os::windows::io::AsRawSocket}; + +use anyhow::Context; +use network_interface::NetworkInterfaceConfig; +use windows::{ + Win32::{ + Foundation::FALSE, + NetworkManagement::WindowsFirewall::{ + INetFwPolicy2, INetFwRule, NET_FW_ACTION_ALLOW, NET_FW_PROFILE2_DOMAIN, + NET_FW_PROFILE2_PRIVATE, NET_FW_PROFILE2_PUBLIC, NET_FW_RULE_DIR_IN, + NET_FW_RULE_DIR_OUT, + }, + Networking::WinSock::{ + IP_UNICAST_IF, IPPROTO_IP, IPPROTO_IPV6, IPV6_UNICAST_IF, SIO_UDP_CONNRESET, SOCKET, + SOCKET_ERROR, WSAGetLastError, WSAIoctl, htonl, setsockopt, + }, + System::Com::{ + CLSCTX_ALL, COINIT_MULTITHREADED, CoCreateInstance, CoInitializeEx, CoUninitialize, + }, + System::Ole::{SafeArrayCreateVector, SafeArrayPutElement}, + System::Variant::{VARENUM, VARIANT, VT_ARRAY, VT_BSTR, VT_VARIANT}, + }, + core::{BOOL, BSTR}, +}; + +pub fn disable_connection_reset(socket: &S) -> io::Result<()> { + let handle = SOCKET(socket.as_raw_socket() as usize); + + unsafe { + // Ignoring UdpSocket's WSAECONNRESET error + // https://github.com/shadowsocks/shadowsocks-rust/issues/179 + // https://stackoverflow.com/questions/30749423/is-winsock-error-10054-wsaeconnreset-normal-with-udp-to-from-localhost + // + // This is because `UdpSocket::recv_from` may return WSAECONNRESET + // if you called `UdpSocket::send_to` a destination that is not existed (may be closed). + // + // It is not an error. Could be ignored completely. + // We have to ignore it here because it will crash the server. + + let mut bytes_returned: u32 = 0; + let enable: BOOL = FALSE; + + let ret = WSAIoctl( + handle, + SIO_UDP_CONNRESET, + Some(&enable as *const _ as *const std::ffi::c_void), + std::mem::size_of_val(&enable) as u32, + None, + 0, + &mut bytes_returned as *mut _, + None, + None, + ); + + if ret == SOCKET_ERROR { + let err_code = WSAGetLastError(); + return Err(std::io::Error::from_raw_os_error(err_code.0)); + } + } + + Ok(()) +} + +pub fn interface_count() -> io::Result { + let ifaces = network_interface::NetworkInterface::show().map_err(|e| { + io::Error::new( + io::ErrorKind::NotFound, + format!("Failed to get interfaces. error: {}", e), + ) + })?; + Ok(ifaces.len()) +} + +pub fn find_interface_index(iface_name: &str) -> io::Result { + let ifaces = network_interface::NetworkInterface::show().map_err(|e| { + io::Error::new( + io::ErrorKind::NotFound, + format!("Failed to get interfaces. {}, error: {}", iface_name, e), + ) + })?; + if let Some(iface) = ifaces.iter().find(|iface| iface.name == iface_name) { + return Ok(iface.index); + } + tracing::error!("Failed to find interface index for {}", iface_name); + Err(io::Error::new( + io::ErrorKind::NotFound, + iface_name.to_string(), + )) +} + +pub fn set_ip_unicast_if(socket: SOCKET, addr: &SocketAddr, iface: &str) -> io::Result<()> { + let if_index = find_interface_index(iface)?; + + unsafe { + // https://docs.microsoft.com/en-us/windows/win32/winsock/ipproto-ip-socket-options + let ret = match addr { + SocketAddr::V4(..) => { + let if_index = htonl(if_index); + let if_index_bytes = if_index.to_ne_bytes(); + setsockopt(socket, IPPROTO_IP.0, IP_UNICAST_IF, Some(&if_index_bytes)) + } + SocketAddr::V6(..) => { + let if_index_bytes = if_index.to_ne_bytes(); + setsockopt( + socket, + IPPROTO_IPV6.0, + IPV6_UNICAST_IF, + Some(&if_index_bytes), + ) + } + }; + + if ret == SOCKET_ERROR { + let err = std::io::Error::from_raw_os_error(WSAGetLastError().0); + tracing::error!( + "set IP_UNICAST_IF / IPV6_UNICAST_IF interface: {}, index: {}, error: {}", + iface, + if_index, + err + ); + return Err(err); + } + } + + Ok(()) +} + +pub fn setup_socket_for_win( + socket: &S, + bind_addr: &SocketAddr, + bind_dev: Option, + is_udp: bool, +) -> io::Result<()> { + if is_udp { + disable_connection_reset(socket)?; + } + + let socket = SOCKET(socket.as_raw_socket() as usize); + + // let optval = 1_i32.to_ne_bytes(); + // unsafe { + // if setsockopt(socket, SOL_SOCKET, SO_EXCLUSIVEADDRUSE, Some(&optval)) == SOCKET_ERROR { + // return Err(io::Error::last_os_error()); + // } + // } + + if let Some(iface) = bind_dev { + set_ip_unicast_if(socket, bind_addr, &iface)?; + } + + Ok(()) +} + +struct ComInitializer; + +impl ComInitializer { + fn new() -> windows::core::Result { + unsafe { CoInitializeEx(None, COINIT_MULTITHREADED).ok()? }; + Ok(Self) + } +} + +impl Drop for ComInitializer { + fn drop(&mut self) { + unsafe { + CoUninitialize(); + } + } +} + +pub fn do_add_self_to_firewall_allowlist(inbound: bool) -> anyhow::Result<()> { + let _com = ComInitializer::new()?; + // Create firewall policy instance + let policy: INetFwPolicy2 = unsafe { + CoCreateInstance( + &windows::Win32::NetworkManagement::WindowsFirewall::NetFwPolicy2, + None, + CLSCTX_ALL, + ) + }?; + + // Create firewall rule instance + let rule: INetFwRule = unsafe { + CoCreateInstance( + &windows::Win32::NetworkManagement::WindowsFirewall::NetFwRule, + None, + CLSCTX_ALL, + ) + }?; + + // Set rule properties + let exe_path = std::env::current_exe() + .with_context(|| "Failed to get current executable path when adding firewall rule")? + .to_string_lossy() + .replace(r"\\?\", ""); + + let name = BSTR::from(format!( + "EasyTier {} ({})", + exe_path, + if inbound { "Inbound" } else { "Outbound" } + )); + let desc = BSTR::from("Allow EasyTier to do subnet proxy and kcp proxy"); + let app_path = BSTR::from(&exe_path); + + unsafe { + rule.SetName(&name)?; + rule.SetDescription(&desc)?; + rule.SetApplicationName(&app_path)?; + rule.SetAction(NET_FW_ACTION_ALLOW)?; + if inbound { + rule.SetDirection(NET_FW_RULE_DIR_IN)?; // Allow inbound connections + } else { + rule.SetDirection(NET_FW_RULE_DIR_OUT)?; // Allow outbound connections + } + rule.SetEnabled(windows::Win32::Foundation::VARIANT_TRUE)?; + rule.SetProfiles( + NET_FW_PROFILE2_PRIVATE.0 | NET_FW_PROFILE2_PUBLIC.0 | NET_FW_PROFILE2_DOMAIN.0, + )?; + rule.SetGrouping(&BSTR::from("EasyTier"))?; + + // Get rule collection and add new rule + let rules = policy.Rules()?; + rules.Remove(&name)?; // Remove existing rule with same name first + rules.Add(&rule)?; + } + + Ok(()) +} + +pub fn add_self_to_firewall_allowlist() -> anyhow::Result<()> { + do_add_self_to_firewall_allowlist(true)?; + do_add_self_to_firewall_allowlist(false)?; + Ok(()) +} + +/// Add firewall rules for specified network interface to allow all traffic +pub fn add_interface_to_firewall_allowlist(interface_name: &str) -> anyhow::Result<()> { + let _com = ComInitializer::new()?; + + // Create firewall policy instance + let policy: INetFwPolicy2 = unsafe { + CoCreateInstance( + &windows::Win32::NetworkManagement::WindowsFirewall::NetFwPolicy2, + None, + CLSCTX_ALL, + ) + }?; + + tracing::info!( + "Adding comprehensive firewall rules for interface: {}", + interface_name + ); + + // Create rules for each protocol type + add_protocol_firewall_rules(&policy, interface_name, "TCP", Some(6))?; // TCP protocol number 6 + tracing::debug!("Added TCP firewall rules for interface: {}", interface_name); + + add_protocol_firewall_rules(&policy, interface_name, "UDP", Some(17))?; // UDP protocol number 17 + tracing::debug!("Added UDP firewall rules for interface: {}", interface_name); + + add_protocol_firewall_rules(&policy, interface_name, "ICMP", Some(1))?; // ICMP protocol number 1 + tracing::debug!( + "Added ICMP firewall rules for interface: {}", + interface_name + ); + + // Add fallback rules for all protocols + add_protocol_firewall_rules(&policy, interface_name, "ALL", None)?; + tracing::debug!( + "Added fallback all-protocols rules for interface: {}", + interface_name + ); + + tracing::info!( + "Successfully created all firewall rules for interface: {}", + interface_name + ); + + Ok(()) +} + +/// Add firewall rules for a specific protocol +fn add_protocol_firewall_rules( + policy: &INetFwPolicy2, + interface_name: &str, + protocol_name: &str, + protocol_number: Option, +) -> anyhow::Result<()> { + // Create rules for both inbound and outbound traffic + for (is_inbound, direction_name) in [(true, "Inbound"), (false, "Outbound")] { + // Create firewall rule instance + let rule: INetFwRule = unsafe { + CoCreateInstance( + &windows::Win32::NetworkManagement::WindowsFirewall::NetFwRule, + None, + CLSCTX_ALL, + ) + }?; + + let rule_name = format!( + "EasyTier {} - {} Protocol ({})", + interface_name, protocol_name, direction_name + ); + let description = format!( + "Allow {} traffic on EasyTier interface {}", + protocol_name, interface_name + ); + + let name_bstr = BSTR::from(&rule_name); + let desc_bstr = BSTR::from(&description); + + unsafe { + rule.SetName(&name_bstr)?; + rule.SetDescription(&desc_bstr)?; + if let Some(protocol_number) = protocol_number { + rule.SetProtocol(protocol_number)?; + } + rule.SetAction(NET_FW_ACTION_ALLOW)?; + + if is_inbound { + rule.SetDirection(NET_FW_RULE_DIR_IN)?; + } else { + rule.SetDirection(NET_FW_RULE_DIR_OUT)?; + } + + rule.SetEnabled(windows::Win32::Foundation::VARIANT_TRUE)?; + rule.SetProfiles( + NET_FW_PROFILE2_PRIVATE.0 | NET_FW_PROFILE2_PUBLIC.0 | NET_FW_PROFILE2_DOMAIN.0, + )?; + rule.SetGrouping(&BSTR::from("EasyTier"))?; + + // Set the interface for this rule to apply to the specific network interface + // According to Microsoft docs, interfaces should be represented by their friendly name + // We need to create a SAFEARRAY of VARIANT strings containing the interface name + let interface_bstr = BSTR::from(interface_name); + + // Create a SAFEARRAY containing one interface name + let interface_array = SafeArrayCreateVector(VT_VARIANT, 0, 1); + if interface_array.is_null() { + return Err(anyhow::anyhow!("Failed to create SAFEARRAY")); + } + + let index = 0i32; + let mut variant_interface = VARIANT::default(); + (*variant_interface.Anonymous.Anonymous).vt = VT_BSTR; + (*variant_interface.Anonymous.Anonymous).Anonymous.bstrVal = + ManuallyDrop::new(interface_bstr); + + SafeArrayPutElement( + interface_array, + &index as *const _, + &variant_interface as *const _ as *const std::ffi::c_void, + )?; + + // Create the VARIANT that contains the SAFEARRAY + let mut interface_variant = VARIANT::default(); + (*interface_variant.Anonymous.Anonymous).vt = VARENUM(VT_ARRAY.0 | VT_VARIANT.0); + (*interface_variant.Anonymous.Anonymous).Anonymous.parray = interface_array; + + rule.SetInterfaces(&interface_variant)?; + + // Get rule collection and add new rule + let rules = policy.Rules()?; + rules.Remove(&name_bstr)?; // Remove existing rule with same name first + rules.Add(&rule)?; + } + } + + Ok(()) +} + +/// Remove firewall rules for specified interface +pub fn remove_interface_firewall_rules(interface_name: &str) -> anyhow::Result<()> { + let _com = ComInitializer::new()?; + + let policy: INetFwPolicy2 = unsafe { + CoCreateInstance( + &windows::Win32::NetworkManagement::WindowsFirewall::NetFwPolicy2, + None, + CLSCTX_ALL, + ) + }?; + + let rules = unsafe { policy.Rules()? }; + + for protocol_name in ["TCP", "UDP", "ICMP", "ALL"] { + for direction in ["Inbound", "Outbound"] { + let rule_name = format!( + "EasyTier {} - {} Protocol ({})", + interface_name, protocol_name, direction + ); + let name_bstr = BSTR::from(&rule_name); + unsafe { + let _ = rules.Remove(&name_bstr); // Ignore errors, rule might not exist + } + } + } + + Ok(()) +} + +/// List EasyTier firewall rules for specified interface (for debugging) +#[allow(dead_code)] +pub fn list_interface_firewall_rules(interface_name: &str) -> anyhow::Result> { + let _com = ComInitializer::new()?; + + let policy: INetFwPolicy2 = unsafe { + CoCreateInstance( + &windows::Win32::NetworkManagement::WindowsFirewall::NetFwPolicy2, + None, + CLSCTX_ALL, + ) + }?; + + let rules = unsafe { policy.Rules()? }; + let mut found_rules = Vec::new(); + + // Check protocol-specific rules + for protocol_name in ["TCP", "UDP", "ICMP"] { + for direction in ["Inbound", "Outbound"] { + let rule_name = format!( + "EasyTier {} - {} Protocol ({})", + interface_name, protocol_name, direction + ); + if check_rule_exists(&rules, &rule_name)? { + found_rules.push(rule_name); + } + } + } + + // Check fallback protocol rules + for direction in ["Inbound", "Outbound"] { + let rule_name = format!( + "EasyTier {} - All Protocols ({})", + interface_name, direction + ); + if check_rule_exists(&rules, &rule_name)? { + found_rules.push(rule_name); + } + } + + Ok(found_rules) +} + +/// Check if a firewall rule with specified name exists +fn check_rule_exists( + rules: &windows::Win32::NetworkManagement::WindowsFirewall::INetFwRules, + rule_name: &str, +) -> anyhow::Result { + let name_bstr = BSTR::from(rule_name); + unsafe { + match rules.Item(&name_bstr) { + Ok(_) => Ok(true), + Err(_) => Ok(false), + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_add_self_to_firewall_allowlist() { + let res = add_self_to_firewall_allowlist(); + assert!(res.is_ok()); + } + + #[test] + #[ignore] // Requires administrator privileges, ignored by default + fn test_interface_firewall_rules() { + let test_interface = "test_interface"; + + // Add firewall rules + let add_result = add_interface_to_firewall_allowlist(test_interface); + assert!( + add_result.is_ok(), + "Failed to add interface firewall rules: {:?}", + add_result + ); + + println!( + "✓ Added comprehensive firewall rules for interface: {}", + test_interface + ); + + // Verify rules were created + let rules = list_interface_firewall_rules(test_interface).unwrap(); + println!("Created {} firewall rules:", rules.len()); + for rule in &rules { + println!(" - {}", rule); + } + + // Verify required protocol rules are all created + let expected_protocols = ["TCP", "UDP", "ICMP"]; + let expected_directions = ["Inbound", "Outbound"]; + + for protocol in &expected_protocols { + for direction in &expected_directions { + let rule_name = format!( + "EasyTier {} - {} Protocol ({})", + test_interface, protocol, direction + ); + assert!( + rules.contains(&rule_name), + "Missing required rule: {}", + rule_name + ); + } + } + + println!("✓ All required protocol rules (TCP/UDP/ICMP) are present"); + + // Remove firewall rules + let remove_result = remove_interface_firewall_rules(test_interface); + assert!( + remove_result.is_ok(), + "Failed to remove interface firewall rules: {:?}", + remove_result + ); + + // Verify rules were removed + let remaining_rules = list_interface_firewall_rules(test_interface).unwrap(); + assert!( + remaining_rules.is_empty(), + "Some rules were not removed: {:?}", + remaining_rules + ); + + println!( + "✓ Successfully removed all firewall rules for interface: {}", + test_interface + ); + } +} diff --git a/vendor/easytier/easytier/src/common/config.rs b/vendor/easytier/easytier/src/common/config.rs new file mode 100644 index 0000000..7c45c63 --- /dev/null +++ b/vendor/easytier/easytier/src/common/config.rs @@ -0,0 +1,705 @@ +//! Native Adapters around the core-owned TOML configuration model. + +use std::path::PathBuf; + +use anyhow::Context as _; +use strum::VariantArray as _; +#[cfg(feature = "management")] +use tokio::io::AsyncReadExt as _; + +use easytier_core::config::MappedListenerPolicy; +#[cfg(feature = "management")] +pub use easytier_core::config::api_input::{ + NetworkConfig, NetworkConfigExt, NetworkingMethod, add_proxy_network_to_config, +}; +pub use easytier_core::config::toml::*; + +#[cfg(feature = "management")] +use crate::common::env_parser; +use crate::tunnel::IpScheme; + +#[cfg(feature = "management")] +pub use easytier_core::management::{config_source_from_rpc, config_source_to_rpc}; + +pub fn parse_mapped_listener_urls( + mapped_listeners: &[String], +) -> Result, anyhow::Error> { + MappedListenerPolicy::new(IpScheme::VARIANTS.iter().map(ToString::to_string)) + .parse_urls(mapped_listeners) +} + +pub fn parse_encryption_algorithm(value: &str) -> Result { + value + .parse() + .map_err(|_| format!("'{value}' is not a valid encryption algorithm")) +} + +pub fn load_toml_config_from_path(path: &PathBuf) -> Result { + let config = std::fs::read_to_string(path) + .with_context(|| format!("failed to read config file: {}", path.display()))?; + TomlConfigLoader::new_from_str_with_source(&path.display().to_string(), &config) +} + +#[cfg(feature = "management-rpc")] +pub use easytier_core::management::{ConfigFileControl, ConfigFilePermission}; + +#[cfg(feature = "management")] +pub async fn config_file_control_from_path(path: PathBuf) -> ConfigFileControl { + let read_only = tokio::fs::metadata(&path) + .await + .map(|metadata| metadata.permissions().readonly()) + .unwrap_or(true); + ConfigFileControl::new( + Some(path), + if read_only { + ConfigFilePermission::from(ConfigFilePermission::READ_ONLY) + } else { + ConfigFilePermission::default() + }, + ) +} + +#[cfg(feature = "management")] +pub async fn load_config_from_file( + config_file: &PathBuf, + config_dir: Option<&PathBuf>, + disable_env_parsing: bool, +) -> Result<(TomlConfigLoader, ConfigFileControl), anyhow::Error> { + if config_file.as_os_str() == "-" { + let mut stdin = String::new(); + tokio::io::stdin() + .read_to_string(&mut stdin) + .await + .context("failed to read config from stdin")?; + let config = TomlConfigLoader::new_from_str_with_source("stdin", &stdin)?; + return Ok((config, ConfigFileControl::STATIC_CONFIG)); + } + + let config_str = tokio::fs::read_to_string(config_file) + .await + .with_context(|| format!("failed to read config file: {}", config_file.display()))?; + let (expanded_config_str, uses_env_vars) = if disable_env_parsing { + (config_str, false) + } else { + env_parser::expand_env_vars(&config_str) + }; + + if disable_env_parsing { + tracing::info!(?config_file, "environment variable parsing is disabled"); + } else if uses_env_vars { + tracing::info!(?config_file, "environment variables detected and expanded"); + } + + let source_name = config_file.display().to_string(); + let config = TomlConfigLoader::new_from_str_with_source(&source_name, &expanded_config_str)?; + let mut control = config_file_control_from_path(config_file.clone()).await; + + if uses_env_vars { + control.set_read_only(true); + control.set_no_delete(true); + } else if control.is_read_only() { + control.set_no_delete(true); + } else if let Some(config_dir) = config_dir { + let is_managed_file = config_file.parent() == Some(config_dir.as_path()) + && config_file.file_stem() == Some(config.get_id().to_string().as_ref()) + && config_file.extension() == Some(std::ffi::OsStr::new("toml")); + control.set_no_delete(!is_managed_file); + } else { + control.set_no_delete(true); + } + + Ok((config, control)) +} + +#[cfg(test)] +mod tests { + use std::io::Write as _; + + use tempfile::NamedTempFile; + + use super::*; + + #[test] + fn path_adapter_preserves_file_name_in_parse_error() { + let mut file = NamedTempFile::new().unwrap(); + writeln!(file, "dhcp = \"yes\"").unwrap(); + + let error = load_toml_config_from_path(&file.path().to_path_buf()) + .unwrap_err() + .to_string(); + + assert!(error.contains(file.path().to_string_lossy().as_ref())); + assert!(error.contains("dhcp = \"yes\"")); + } + + #[tokio::test] + async fn file_adapter_keeps_os_metadata_outside_core_config() { + let mut file = NamedTempFile::new().unwrap(); + writeln!(file, "instance_name = \"from-file\"").unwrap(); + + let (config, control) = load_config_from_file(&file.path().to_path_buf(), None, true) + .await + .unwrap(); + + assert_eq!(config.get_inst_name(), "from-file"); + assert_eq!(control.path.as_deref(), Some(file.path())); + } +} + +#[cfg(test)] +mod compatibility_tests { + use std::{io::Write as _, path::PathBuf}; + + use tempfile::NamedTempFile; + + use super::*; + use crate::tests::{remove_env_var, set_env_var}; + /// 配置文件环境变量解析功能的集成测试 + /// + /// 测试范围: + /// 1. 配置加载功能测试(环境变量替换、权限标记) + /// 2. RPC API 安全测试(只读配置保护) + /// 3. CLI 参数测试(--disable-env-parsing 开关) + /// 4. 多实例隔离测试 + /// 5. 实际配置字段测试(network_secret、peer.uri 等) + /// 配置加载功能测试(环境变量替换、权限标记) + /// + /// 验证: + /// - 环境变量能正确替换到配置中 + /// - 包含环境变量的配置文件自动标记为只读和禁止删除 + #[tokio::test] + async fn test_env_var_expansion_and_readonly_flag() { + // 设置测试环境变量 + set_env_var("TEST_SECRET", "my-test-secret-123"); + set_env_var("TEST_NETWORK", "test-network"); + + // 创建临时配置文件,包含环境变量占位符 + let mut temp_file = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "test-instance" + +[network_identity] +network_name = "${TEST_NETWORK}" +network_secret = "${TEST_SECRET}" +"#; + temp_file.write_all(config_content.as_bytes()).unwrap(); + temp_file.flush().unwrap(); + + let config_path = PathBuf::from(temp_file.path()); + + // 加载配置(启用环境变量解析) + let (config, control) = load_config_from_file(&config_path, None, false) + .await + .unwrap(); + + // 验证环境变量已被替换 + let network_identity = config.get_network_identity(); + assert_eq!(network_identity.network_name, "test-network"); + assert_eq!( + network_identity.network_secret.as_ref().unwrap(), + "my-test-secret-123" + ); + + // 验证权限标记:包含环境变量的配置应被标记为只读和禁止删除 + assert!( + control.is_read_only(), + "Config with env vars should be marked as READ_ONLY" + ); + assert!( + control.is_no_delete(), + "Config with env vars should be marked as NO_DELETE" + ); + + // 清理环境变量 + remove_env_var("TEST_SECRET"); + remove_env_var("TEST_NETWORK"); + } + + /// RPC API 安全测试(只读配置保护) + /// + /// 验证: + /// - 只读配置不会通过 RPC API 暴露给远程调用 + /// - 这需要测试 get_network_instance_config 拒绝返回只读配置 + /// + /// 注:这个测试验证权限标记的正确设置,实际的 RPC API 保护已在 + /// `easytier/src/rpc_service/instance_manage.rs` 中实现 + #[tokio::test] + async fn test_readonly_config_api_protection() { + set_env_var("API_TEST_SECRET", "secret-value"); + + // 创建包含环境变量的配置 + let mut temp_file = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "api-test" + +[network_identity] +network_name = "api-network" +network_secret = "${API_TEST_SECRET}" +"#; + temp_file.write_all(config_content.as_bytes()).unwrap(); + temp_file.flush().unwrap(); + + let config_path = PathBuf::from(temp_file.path()); + + // 加载配置 + let (_config, control) = load_config_from_file(&config_path, None, false) + .await + .unwrap(); + + // 验证只读标记已设置(这是 RPC API 保护的前提) + assert!( + control.is_read_only(), + "Config should be marked as READ_ONLY for RPC protection" + ); + assert!( + control.permission.has_flag(ConfigFilePermission::READ_ONLY), + "Permission flag should be set correctly" + ); + + remove_env_var("API_TEST_SECRET"); + } + + /// CLI 参数测试(--disable-env-parsing 开关) + /// + /// 验证: + /// - disable_env_parsing = true 时,环境变量不会被替换 + /// - 配置不会被标记为只读 + #[tokio::test] + async fn test_disable_env_parsing_flag() { + set_env_var("DISABLED_TEST_VAR", "should-not-expand"); + + // 创建包含环境变量占位符的配置 + let mut temp_file = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "disable-test" + +[network_identity] +network_name = "test" +network_secret = "${DISABLED_TEST_VAR}" +"#; + temp_file.write_all(config_content.as_bytes()).unwrap(); + temp_file.flush().unwrap(); + + let config_path = PathBuf::from(temp_file.path()); + + // 以 disable_env_parsing = true 加载配置 + let (config, control) = load_config_from_file(&config_path, None, true) + .await + .unwrap(); + + // 验证环境变量未被替换(保持原样) + let network_identity = config.get_network_identity(); + assert_eq!( + network_identity.network_secret.as_ref().unwrap(), + "${DISABLED_TEST_VAR}", + "Env var should not be expanded when parsing is disabled" + ); + + assert!(!control.is_read_only()); + assert!( + control.is_no_delete(), + "Config should be NO_DELETE due to no config_dir, not env vars" + ); + + remove_env_var("DISABLED_TEST_VAR"); + } + + /// 多实例隔离测试 + /// + /// 验证: + /// - 不同实例可以使用不同的环境变量值 + /// - 环境变量在运行时被解析,支持动态切换 + #[tokio::test] + async fn test_multiple_instances_with_different_env_vars() { + // 实例1:使用第一组环境变量 + set_env_var("INSTANCE_SECRET", "instance1-secret"); + set_env_var("INSTANCE_NAME", "instance-one"); + + let mut temp_file1 = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "${INSTANCE_NAME}" + +[network_identity] +network_name = "multi-test" +network_secret = "${INSTANCE_SECRET}" +"#; + temp_file1.write_all(config_content.as_bytes()).unwrap(); + temp_file1.flush().unwrap(); + + let config_path1 = PathBuf::from(temp_file1.path()); + let (config1, _) = load_config_from_file(&config_path1, None, false) + .await + .unwrap(); + + // 验证实例1的配置 + assert_eq!(config1.get_inst_name(), "instance-one"); + assert_eq!( + config1 + .get_network_identity() + .network_secret + .as_ref() + .unwrap(), + "instance1-secret" + ); + + // 实例2:修改环境变量后加载同一模板 + set_env_var("INSTANCE_SECRET", "instance2-secret"); + set_env_var("INSTANCE_NAME", "instance-two"); + + let mut temp_file2 = NamedTempFile::new().unwrap(); + temp_file2.write_all(config_content.as_bytes()).unwrap(); + temp_file2.flush().unwrap(); + + let config_path2 = PathBuf::from(temp_file2.path()); + let (config2, _) = load_config_from_file(&config_path2, None, false) + .await + .unwrap(); + + // 验证实例2使用了不同的环境变量值 + assert_eq!(config2.get_inst_name(), "instance-two"); + assert_eq!( + config2 + .get_network_identity() + .network_secret + .as_ref() + .unwrap(), + "instance2-secret" + ); + + // 验证两个实例的配置确实不同 + assert_ne!(config1.get_inst_name(), config2.get_inst_name()); + assert_ne!( + config1.get_network_identity().network_secret, + config2.get_network_identity().network_secret + ); + + // 清理 + remove_env_var("INSTANCE_SECRET"); + remove_env_var("INSTANCE_NAME"); + } + + /// 实际配置字段测试(network_secret、peer.uri 等) + /// + /// 验证: + /// - network_secret 字段支持环境变量 + /// - peer.uri 字段支持环境变量 + /// - listeners 字段支持环境变量 + /// - 其他实际使用的配置字段 + #[tokio::test] + async fn test_real_config_fields_expansion() { + // 设置各种实际场景的环境变量 + set_env_var("CONFIG_REAL_SECRET", "production-secret-key"); + set_env_var("PEER_HOST", "peer.example.com"); + set_env_var("PEER_PORT", "11011"); + set_env_var("LISTEN_PORT", "11010"); + set_env_var("NETWORK_NAME", "prod-network"); + + // 创建包含多个实际字段的完整配置 + let mut temp_file = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "production" +ipv4 = "10.144.144.1" +listeners = ["tcp://0.0.0.0:${LISTEN_PORT}"] + +[network_identity] +network_name = "${NETWORK_NAME}" +network_secret = "${CONFIG_REAL_SECRET}" + +[[peer]] +uri = "tcp://${PEER_HOST}:${PEER_PORT}" +"#; + temp_file.write_all(config_content.as_bytes()).unwrap(); + temp_file.flush().unwrap(); + + let config_path = PathBuf::from(temp_file.path()); + + let (config, control) = load_config_from_file(&config_path, None, false) + .await + .unwrap(); + + // 验证 network_identity 字段 + let identity = config.get_network_identity(); + assert_eq!(identity.network_name, "prod-network"); + assert_eq!( + identity.network_secret.as_ref().unwrap(), + "production-secret-key" + ); + + // 验证 listeners 字段 + let listeners = config.get_listener_uris(); + assert_eq!(listeners.len(), 1); + assert_eq!(listeners[0].to_string(), "tcp://0.0.0.0:11010"); + + // 验证 peer 字段 + let peers = config.get_peers(); + assert_eq!(peers.len(), 1); + assert_eq!(peers[0].uri.to_string(), "tcp://peer.example.com:11011"); + + // 验证配置被正确标记 + assert!(control.is_read_only()); + assert!(control.is_no_delete()); + + // 清理环境变量 + remove_env_var("CONFIG_REAL_SECRET"); + remove_env_var("PEER_HOST"); + remove_env_var("PEER_PORT"); + remove_env_var("LISTEN_PORT"); + remove_env_var("NETWORK_NAME"); + } + + /// 带默认值的环境变量 + /// + /// 验证: + /// - ${VAR:-default} 语法在变量未定义时使用默认值 + #[tokio::test] + async fn test_env_var_with_default_value() { + // 确保变量未定义 + remove_env_var("UNDEFINED_PORT"); + remove_env_var("UNDEFINED_SECRET"); + + let mut temp_file = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "default-test" +listeners = ["tcp://0.0.0.0:${UNDEFINED_PORT:-11010}"] + +[network_identity] +network_name = "test" +network_secret = "${UNDEFINED_SECRET:-default-secret}" +"#; + temp_file.write_all(config_content.as_bytes()).unwrap(); + temp_file.flush().unwrap(); + + let config_path = PathBuf::from(temp_file.path()); + + let (config, _) = load_config_from_file(&config_path, None, false) + .await + .unwrap(); + + // 验证使用了默认值 + assert_eq!( + config + .get_network_identity() + .network_secret + .as_ref() + .unwrap(), + "default-secret" + ); + assert_eq!( + config.get_listener_uris()[0].to_string(), + "tcp://0.0.0.0:11010" + ); + } + + /// 环境变量未定义且无默认值的情况 + /// + /// 验证: + /// - 未定义的环境变量保持原样(shellexpand 的默认行为) + #[tokio::test] + async fn test_undefined_env_var_without_default() { + remove_env_var("COMPLETELY_UNDEFINED"); + + let mut temp_file = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "undefined-test" + +[network_identity] +network_name = "test" +network_secret = "${COMPLETELY_UNDEFINED}" +"#; + temp_file.write_all(config_content.as_bytes()).unwrap(); + temp_file.flush().unwrap(); + + let config_path = PathBuf::from(temp_file.path()); + let (config, control) = load_config_from_file(&config_path, None, false) + .await + .unwrap(); + + // 验证变量保持原样 + assert_eq!( + config + .get_network_identity() + .network_secret + .as_ref() + .unwrap(), + "${COMPLETELY_UNDEFINED}" + ); + + assert!(!control.is_read_only()); + assert!(control.is_no_delete()); + } + + /// 布尔类型环境变量 + /// + /// 验证: + /// - 布尔类型的环境变量能正确解析和反序列化 + /// - TOML 解析器能将字符串 "true"/"false" 转换为布尔值 + #[tokio::test] + async fn test_boolean_type_env_vars() { + // 设置布尔类型的环境变量 + set_env_var("ENABLE_DHCP", "true"); + set_env_var("ENABLE_ENCRYPTION", "false"); + set_env_var("ENABLE_IPV6", "true"); + + let mut temp_file = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "bool-test" +dhcp = ${ENABLE_DHCP} + +[network_identity] +network_name = "test" +network_secret = "secret" + +[flags] +enable_encryption = ${ENABLE_ENCRYPTION} +enable_ipv6 = ${ENABLE_IPV6} +"#; + temp_file.write_all(config_content.as_bytes()).unwrap(); + temp_file.flush().unwrap(); + + let config_path = PathBuf::from(temp_file.path()); + let (config, control) = load_config_from_file(&config_path, None, false) + .await + .unwrap(); + + // 验证布尔值被正确解析 + assert!(config.get_dhcp(), "dhcp should be true"); + + let flags = config.get_flags(); + assert!( + !flags.enable_encryption, + "enable_encryption should be false" + ); + assert!(flags.enable_ipv6, "enable_ipv6 should be true"); + + // 验证使用环境变量的配置被标记为只读 + assert!(control.is_read_only()); + assert!(control.is_no_delete()); + + // 清理 + remove_env_var("ENABLE_DHCP"); + remove_env_var("ENABLE_ENCRYPTION"); + remove_env_var("ENABLE_IPV6"); + } + + /// 数字类型环境变量 + /// + /// 验证: + /// - 数字类型(整数、端口号)的环境变量能正确解析和反序列化 + /// - TOML 解析器能将字符串 "1380" 转换为整数 + #[tokio::test] + async fn test_numeric_type_env_vars() { + // 设置数字类型的环境变量 + set_env_var("MTU_VALUE", "1400"); + set_env_var("THREAD_COUNT", "4"); + + let mut temp_file = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "numeric-test" + +[network_identity] +network_name = "test" +network_secret = "secret" + +[flags] +mtu = ${MTU_VALUE} +multi_thread_count = ${THREAD_COUNT} +"#; + temp_file.write_all(config_content.as_bytes()).unwrap(); + temp_file.flush().unwrap(); + + let config_path = PathBuf::from(temp_file.path()); + let (config, control) = load_config_from_file(&config_path, None, false) + .await + .unwrap(); + + // 验证数字值被正确解析 + let flags = config.get_flags(); + assert_eq!(flags.mtu, 1400, "mtu should be 1400"); + assert_eq!( + flags.multi_thread_count, 4, + "multi_thread_count should be 4" + ); + + // 验证使用环境变量的配置被标记为只读 + assert!(control.is_read_only()); + assert!(control.is_no_delete()); + + // 清理 + remove_env_var("MTU_VALUE"); + remove_env_var("THREAD_COUNT"); + } + + /// 混合类型环境变量 + /// + /// 验证: + /// - 字符串、布尔、数字类型的环境变量可以同时使用 + /// - 所有类型都能正确解析和反序列化 + /// - 模拟真实的复杂配置场景 + #[tokio::test] + async fn test_mixed_type_env_vars() { + // 设置不同类型的环境变量 + set_env_var("MIXED_SECRET", "mixed-secret-key"); + set_env_var("MIXED_NETWORK", "production"); + set_env_var("MIXED_DHCP", "true"); + set_env_var("MIXED_MTU", "1500"); + set_env_var("MIXED_ENCRYPTION", "false"); + set_env_var("MIXED_LISTEN_PORT", "12345"); + + let mut temp_file = NamedTempFile::new().unwrap(); + let config_content = r#" +instance_name = "mixed-test" +ipv4 = "10.0.0.1" +dhcp = ${MIXED_DHCP} +listeners = ["tcp://0.0.0.0:${MIXED_LISTEN_PORT}"] + +[network_identity] +network_name = "${MIXED_NETWORK}" +network_secret = "${MIXED_SECRET}" + +[flags] +mtu = ${MIXED_MTU} +enable_encryption = ${MIXED_ENCRYPTION} +"#; + temp_file.write_all(config_content.as_bytes()).unwrap(); + temp_file.flush().unwrap(); + + let config_path = PathBuf::from(temp_file.path()); + let (config, control) = load_config_from_file(&config_path, None, false) + .await + .unwrap(); + + // 验证字符串类型 + let identity = config.get_network_identity(); + assert_eq!(identity.network_name, "production"); + assert_eq!( + identity.network_secret.as_ref().unwrap(), + "mixed-secret-key" + ); + + // 验证布尔类型 + assert!(config.get_dhcp()); + + let flags = config.get_flags(); + assert!(!flags.enable_encryption); + + // 验证数字类型 + assert_eq!(flags.mtu, 1500); + + // 验证 URL 中的端口号(数字) + let listeners = config.get_listener_uris(); + assert_eq!(listeners.len(), 1); + assert_eq!(listeners[0].to_string(), "tcp://0.0.0.0:12345"); + + // 验证配置被标记为只读 + assert!(control.is_read_only()); + assert!(control.is_no_delete()); + + // 清理 + remove_env_var("MIXED_SECRET"); + remove_env_var("MIXED_NETWORK"); + remove_env_var("MIXED_DHCP"); + remove_env_var("MIXED_MTU"); + remove_env_var("MIXED_ENCRYPTION"); + remove_env_var("MIXED_LISTEN_PORT"); + } +} diff --git a/vendor/easytier/easytier/src/common/constants.rs b/vendor/easytier/easytier/src/common/constants.rs new file mode 100644 index 0000000..5262bb7 --- /dev/null +++ b/vendor/easytier/easytier/src/common/constants.rs @@ -0,0 +1,19 @@ +pub const MANUAL_CONNECTOR_RECONNECT_INTERVAL_MS: u64 = 1000; + +pub const OSPF_UPDATE_MY_GLOBAL_FOREIGN_NETWORK_INTERVAL_SEC: u64 = 10; + +pub const MAX_DIRECT_CONNS_PER_PEER_IN_FOREIGN_NETWORK: u32 = 3; + +pub const DIRECT_CONNECT_TO_PUBLIC_SERVER: bool = true; + +// must make it true in future. +pub const HMAC_SECRET_DIGEST: bool = false; + +pub const WIN_SERVICE_WORK_DIR_REG_KEY: &str = "SOFTWARE\\EasyTier\\Service\\WorkDir"; + +pub const EASYTIER_VERSION: &str = git_version::git_version!( + args = ["--abbrev=8", "--always", "--dirty=~"], + prefix = concat!(env!("CARGO_PKG_VERSION"), "-"), + suffix = "", + fallback = env!("CARGO_PKG_VERSION") +); diff --git a/vendor/easytier/easytier/src/common/credential_manager.rs b/vendor/easytier/easytier/src/common/credential_manager.rs new file mode 100644 index 0000000..7bd270f --- /dev/null +++ b/vendor/easytier/easytier/src/common/credential_manager.rs @@ -0,0 +1,87 @@ +use std::{io::Write, path::PathBuf, sync::Arc}; + +use atomic_write_file::{AtomicWriteFile, OpenOptions}; +use easytier_core::peers::credential_manager::CredentialStorage; + +struct FileCredentialStorage { + path: PathBuf, +} + +impl CredentialStorage for FileCredentialStorage { + fn load(&self) -> anyhow::Result> { + let serialized = match std::fs::read_to_string(&self.path) { + Ok(serialized) => serialized, + Err(error) if error.kind() == std::io::ErrorKind::NotFound => return Ok(None), + Err(error) => return Err(error.into()), + }; + tracing::info!(path = %self.path.display(), "loaded credentials"); + Ok(Some(serialized)) + } + + fn store(&self, serialized_credentials: &str) -> anyhow::Result<()> { + let mut file = restricted_atomic_file(&self.path)?; + file.write_all(serialized_credentials.as_bytes())?; + file.commit()?; + Ok(()) + } +} + +fn restricted_atomic_file(path: &std::path::Path) -> std::io::Result { + let mut options = OpenOptions::new(); + #[cfg(unix)] + { + atomic_write_file::unix::OpenOptionsExt::preserve_mode(&mut options, false); + std::os::unix::fs::OpenOptionsExt::mode(&mut options, 0o600); + } + options.open(path) +} + +pub(crate) fn runtime_credential_storage( + path: Option, +) -> Option> { + path.map(|path| Arc::new(FileCredentialStorage { path }) as Arc) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn file_storage_round_trips_serialized_credentials() { + let directory = tempfile::tempdir().unwrap(); + let storage = FileCredentialStorage { + path: directory.path().join("credentials.json"), + }; + + assert_eq!(storage.load().unwrap(), None); + storage.store("{\"credential\":true}").unwrap(); + storage.store("{\"credential\":false}").unwrap(); + assert_eq!( + storage.load().unwrap().as_deref(), + Some("{\"credential\":false}") + ); + #[cfg(unix)] + { + use std::os::unix::fs::PermissionsExt as _; + + assert_eq!( + std::fs::metadata(&storage.path) + .unwrap() + .permissions() + .mode() + & 0o777, + 0o600 + ); + } + } + + #[test] + fn file_storage_reports_read_errors() { + let directory = tempfile::tempdir().unwrap(); + let storage = FileCredentialStorage { + path: directory.path().to_path_buf(), + }; + + assert!(storage.load().is_err()); + } +} diff --git a/vendor/easytier/easytier/src/common/dns.rs b/vendor/easytier/easytier/src/common/dns.rs new file mode 100644 index 0000000..1c5fbe7 --- /dev/null +++ b/vendor/easytier/easytier/src/common/dns.rs @@ -0,0 +1,648 @@ +use std::net::{IpAddr, SocketAddr, ToSocketAddrs as _}; +#[cfg(feature = "dns-resolver")] +use std::{future::Future, io, pin::Pin, sync::Arc, time::Duration}; + +use anyhow::Context; +use async_trait::async_trait; +use easytier_core::host::dns::{DnsQuery, DnsRecordResolver, DnsResolver, DnsSrvRecord}; +use easytier_core::socket::SocketContext; +#[cfg(feature = "dns-resolver")] +use hickory_proto::runtime::{RuntimeProvider, TokioRuntimeProvider, iocompat::AsyncIoTokioAsStd}; +#[cfg(feature = "dns-resolver")] +use hickory_proto::xfer::Protocol; +#[cfg(feature = "dns-resolver")] +use hickory_resolver::config::{LookupIpStrategy, NameServerConfig, ResolverConfig, ResolverOpts}; +#[cfg(feature = "dns-resolver")] +use hickory_resolver::name_server::{GenericConnector, TokioConnectionProvider}; +#[cfg(feature = "dns-resolver")] +use hickory_resolver::system_conf::read_system_conf; +#[cfg(feature = "dns-resolver")] +use hickory_resolver::{Resolver, TokioResolver}; +#[cfg(feature = "dns-resolver")] +use once_cell::sync::Lazy; +use tokio::net::lookup_host; +#[cfg(feature = "dns-resolver")] +use tokio::net::{TcpStream, UdpSocket}; +#[cfg(feature = "dns-resolver")] +use tokio::sync::Semaphore; + +use super::error::Error; +use super::netns::NetNS; +#[cfg(feature = "dns-resolver")] +use crate::{ + socket::{tcp::create_tcp_socket, udp::create_udp_socket}, + socket_protector::native_socket_protection_available, +}; +#[cfg(feature = "dns-resolver")] +use easytier_core::socket::{NetNamespace, tcp::TcpBindOptions, udp::UdpBindOptions}; + +#[cfg(feature = "dns-resolver")] +pub fn get_default_resolver_config() -> ResolverConfig { + let mut default_resolve_config = ResolverConfig::new(); + default_resolve_config.add_name_server(NameServerConfig::new( + "223.5.5.5:53".parse().unwrap(), + Protocol::Udp, + )); + default_resolve_config.add_name_server(NameServerConfig::new( + "180.184.1.1:53".parse().unwrap(), + Protocol::Udp, + )); + default_resolve_config +} + +#[cfg(feature = "dns-resolver")] +fn resolver_config() -> (ResolverConfig, ResolverOpts) { + let system_cfg = read_system_conf(); + let mut config = get_default_resolver_config(); + let mut options = ResolverOpts::default(); + if let Ok(system) = system_cfg { + for name_server in system.0.name_servers() { + config.add_name_server(name_server.clone()); + } + options = system.1; + } + options.ip_strategy = LookupIpStrategy::Ipv4AndIpv6; + (config, options) +} + +#[cfg(feature = "dns-resolver")] +static RESOLVER: Lazy>>> = Lazy::new(|| { + let (config, options) = resolver_config(); + let builder = TokioResolver::builder_with_config(config, TokioConnectionProvider::default()) + .with_options(options); + Arc::new(builder.build()) +}); + +#[cfg(feature = "dns-resolver")] +const SYSTEM_DNS_LOOKUP_TIMEOUT: Duration = Duration::from_millis(800); + +#[cfg(feature = "dns-resolver")] +#[derive(Debug)] +struct SystemDnsResolver { + lookup_slot: Arc, + timeout: Duration, +} + +#[cfg(feature = "dns-resolver")] +impl Default for SystemDnsResolver { + fn default() -> Self { + Self::new(SYSTEM_DNS_LOOKUP_TIMEOUT) + } +} + +#[cfg(feature = "dns-resolver")] +impl SystemDnsResolver { + fn new(timeout: Duration) -> Self { + Self { + lookup_slot: Arc::new(Semaphore::new(1)), + timeout, + } + } + + async fn resolve( + &self, + system_lookup: SystemFuture, + fallback_lookup: FallbackFuture, + ) -> anyhow::Result> + where + SystemFuture: Future>> + Send + 'static, + FallbackFuture: Future>> + Send, + { + // Tokio runs getaddrinfo on its blocking pool and cannot cancel it. + // Keep the permit in a detached task after a timeout so reconnects do + // not accumulate blocked system lookups. Once it finishes, later + // requests can use the system resolver again. + let lookup_slot = self.lookup_slot.clone(); + let system_attempt = async move { + let permit = lookup_slot + .acquire_owned() + .await + .context("system DNS lookup slot closed")?; + tokio::spawn(async move { + let _permit = permit; + system_lookup.await + }) + .await + .context("system DNS lookup task failed")? + }; + + match tokio::time::timeout(self.timeout, system_attempt).await { + Ok(Ok(addresses)) => { + tracing::debug!(?addresses, "system dns lookup done"); + return Ok(addresses); + } + Ok(Err(error)) => { + tracing::warn!(?error, "system dns lookup failed, fallback to hickory"); + } + Err(_) => { + tracing::warn!( + timeout = ?self.timeout, + "system dns lookup timed out, fallback to hickory" + ); + } + } + + fallback_lookup.await + } +} + +#[derive(Clone, Debug, PartialEq, Eq, Hash)] +struct RuntimeDnsIoContext { + netns: Option, + socket_mark: Option, +} + +impl RuntimeDnsIoContext { + fn from_socket_context(context: &SocketContext) -> Self { + Self { + netns: context + .netns + .as_ref() + .map(|namespace| namespace.token().to_owned()), + socket_mark: context.socket_mark, + } + } + + fn netns(&self) -> NetNS { + NetNS::new(self.netns.clone()) + } + + #[cfg(feature = "dns-resolver")] + fn is_process_default(&self) -> bool { + self.netns.is_none() && self.socket_mark.is_none() && !native_socket_protection_available() + } + + #[cfg(feature = "dns-resolver")] + fn socket_context(&self) -> SocketContext { + SocketContext::default() + .with_netns(self.netns.clone().map(NetNamespace::new)) + .with_socket_mark(self.socket_mark) + } +} + +#[cfg(feature = "dns-resolver")] +#[derive(Clone)] +struct RuntimeDnsIoProvider { + inner: TokioRuntimeProvider, + context: RuntimeDnsIoContext, +} + +#[cfg(feature = "dns-resolver")] +impl RuntimeDnsIoProvider { + fn new(context: RuntimeDnsIoContext) -> Self { + Self { + inner: TokioRuntimeProvider::new(), + context, + } + } +} + +#[cfg(feature = "dns-resolver")] +impl RuntimeProvider for RuntimeDnsIoProvider { + type Handle = ::Handle; + type Timer = ::Timer; + type Udp = UdpSocket; + type Tcp = AsyncIoTokioAsStd; + + fn create_handle(&self) -> Self::Handle { + self.inner.create_handle() + } + + fn connect_tcp( + &self, + server_addr: SocketAddr, + bind_addr: Option, + wait_for: Option, + ) -> Pin>>> { + let options = TcpBindOptions::default() + .with_context(self.context.socket_context()) + .with_local_addr(bind_addr) + .with_bind_device(Some(String::new())) + .with_reuse_addr(false); + Box::pin(async move { + let wait_for = wait_for.unwrap_or(Duration::from_secs(5)); + let connect = async { + let socket = create_tcp_socket(server_addr, &options) + .await + .map_err(io::Error::other)?; + socket.set_nodelay(true)?; + socket.connect(server_addr).await + }; + match tokio::time::timeout(wait_for, connect).await { + Ok(Ok(stream)) => Ok(AsyncIoTokioAsStd(stream)), + Ok(Err(error)) => Err(error), + Err(_) => Err(io::Error::new( + io::ErrorKind::TimedOut, + format!("connection to {server_addr:?} timed out after {wait_for:?}"), + )), + } + }) + } + + fn bind_udp( + &self, + local_addr: SocketAddr, + _server_addr: SocketAddr, + ) -> Pin>>> { + let options = UdpBindOptions::default() + .with_context(self.context.socket_context()) + .with_local_addr(Some(local_addr)); + Box::pin(async move { create_udp_socket(&options).await.map_err(io::Error::other) }) + } +} + +#[cfg(feature = "dns-resolver")] +type ContextualResolver = Resolver>; + +#[derive(Debug, Default)] +pub(crate) struct RuntimeDnsResolver { + #[cfg(feature = "dns-resolver")] + system_dns: SystemDnsResolver, +} + +impl RuntimeDnsResolver { + pub(crate) fn new() -> Self { + Self::default() + } + + // A netns token can be deleted and recreated. Keep contextual resolvers + // request-scoped so pooled DNS sockets cannot outlive that namespace. + #[cfg(feature = "dns-resolver")] + fn contextual_resolver(context: RuntimeDnsIoContext) -> ContextualResolver { + let (config, options) = resolver_config(); + let provider = GenericConnector::new(RuntimeDnsIoProvider::new(context)); + Resolver::builder_with_config(config, provider) + .with_options(options) + .build() + } + + #[cfg(feature = "dns-resolver")] + async fn resolve_contextual_with_hickory( + context: RuntimeDnsIoContext, + host: String, + ) -> anyhow::Result> { + let resolver = Self::contextual_resolver(context); + let response = resolver + .lookup_ip(&host) + .await + .with_context(|| format!("contextual hickory lookup_ip failed, host: {host}"))?; + Ok(response.iter().collect()) + } + + #[cfg(feature = "dns-resolver")] + async fn resolve_process_ips(&self, host: &str) -> anyhow::Result> { + let system_host = host.to_owned(); + self.system_dns + .resolve( + async move { + let addresses = lookup_host((system_host.as_str(), 0)) + .await? + .map(|address| address.ip()) + .collect(); + Ok(addresses) + }, + async { + let response = RESOLVER + .lookup_ip(host) + .await + .with_context(|| format!("hickory dns lookup_ip failed, host: {host}"))?; + Ok(response.iter().collect()) + }, + ) + .await + } + + #[cfg(feature = "dns-resolver")] + async fn resolve_contextual_ips( + &self, + context: RuntimeDnsIoContext, + host: String, + ) -> anyhow::Result> { + if context.socket_mark.is_some() || native_socket_protection_available() { + return Self::resolve_contextual_with_hickory(context, host).await; + } + + // libc DNS cannot attach SO_MARK. It remains usable for a + // namespace-only context when confined to one blocking thread. + let system_context = context.clone(); + let system_host = host.clone(); + self.system_dns + .resolve( + async move { + let netns = system_context.netns(); + let addresses = tokio::task::spawn_blocking(move || { + netns.run(|| { + (system_host.as_str(), 0) + .to_socket_addrs() + .map(|addrs| addrs.map(|addr| addr.ip()).collect()) + }) + }) + .await + .context("contextual system DNS task failed")??; + Ok(addresses) + }, + Self::resolve_contextual_with_hickory(context, host), + ) + .await + } +} + +#[async_trait] +impl DnsResolver for RuntimeDnsResolver { + async fn resolve(&self, query: DnsQuery) -> anyhow::Result> { + let context = RuntimeDnsIoContext::from_socket_context(&query.context); + #[cfg(feature = "dns-resolver")] + { + if context.is_process_default() { + return self.resolve_process_ips(&query.host).await; + } + return self.resolve_contextual_ips(context, query.host).await; + } + #[cfg(not(feature = "dns-resolver"))] + { + if context.socket_mark.is_some() + || crate::socket_protector::native_socket_protection_available() + { + anyhow::bail!("socket-marked or VPN-protected DNS requires DNS resolver support"); + } + if context.netns.is_none() { + return Ok(resolve_ips(&query.host).await?); + } + let host = query.host; + let netns = context.netns(); + return tokio::task::spawn_blocking(move || { + netns.run(|| { + (host.as_str(), 0) + .to_socket_addrs() + .map(|addrs| addrs.map(|addr| addr.ip()).collect()) + }) + }) + .await + .context("contextual system DNS task failed")? + .map_err(Into::into); + } + } +} + +#[cfg(feature = "dns-resolver")] +#[async_trait] +impl DnsRecordResolver for RuntimeDnsResolver { + async fn resolve_txt(&self, query: DnsQuery) -> anyhow::Result { + let context = RuntimeDnsIoContext::from_socket_context(&query.context); + if context.is_process_default() { + return Ok(resolve_txt_record(&query.host).await?); + } + + let resolver = Self::contextual_resolver(context); + let response = resolver + .txt_lookup(&query.host) + .await + .with_context(|| format!("txt_lookup failed, domain_name: {}", query.host))?; + let record = response + .iter() + .next() + .with_context(|| format!("no txt record found, domain_name: {}", query.host))?; + let data = record + .txt_data() + .first() + .with_context(|| format!("empty txt record, domain_name: {}", query.host))?; + Ok(String::from_utf8_lossy(data).into_owned()) + } + + async fn resolve_srv(&self, query: DnsQuery) -> anyhow::Result> { + let context = RuntimeDnsIoContext::from_socket_context(&query.context); + let response = if context.is_process_default() { + RESOLVER.srv_lookup(&query.host).await? + } else { + Self::contextual_resolver(context) + .srv_lookup(&query.host) + .await? + }; + Ok(response + .iter() + .map(|record| DnsSrvRecord { + priority: record.priority(), + weight: record.weight(), + port: record.port(), + target: record.target().to_utf8(), + }) + .collect()) + } +} + +#[cfg(not(feature = "dns-resolver"))] +#[async_trait] +impl DnsRecordResolver for RuntimeDnsResolver { + async fn resolve_txt(&self, _query: DnsQuery) -> anyhow::Result { + anyhow::bail!("this build does not include TXT DNS resolution") + } + + async fn resolve_srv(&self, _query: DnsQuery) -> anyhow::Result> { + anyhow::bail!("this build does not include SRV DNS resolution") + } +} + +#[cfg(feature = "dns-resolver")] +async fn resolve_txt_record(domain_name: &str) -> Result { + let r = RESOLVER.clone(); + let response = r + .txt_lookup(domain_name) + .await + .with_context(|| format!("txt_lookup failed, domain_name: {}", domain_name))?; + + let txt_record = response + .iter() + .next() + .with_context(|| format!("no txt record found, domain_name: {}", domain_name))?; + + let txt_data = String::from_utf8_lossy(&txt_record.txt_data()[0]); + tracing::info!(?txt_data, ?domain_name, "get txt record"); + + Ok(txt_data.to_string()) +} + +pub async fn socket_addrs( + url: &url::Url, + default_port_number: impl Fn() -> Option, +) -> Result, Error> { + socket_addrs_with_system_resolver(url, default_port_number, true).await +} + +async fn socket_addrs_with_system_resolver( + url: &url::Url, + default_port_number: impl Fn() -> Option, + allow_system_resolver: bool, +) -> Result, Error> { + let host = url.host().ok_or(Error::InvalidUrl(url.to_string()))?; + let port = url + .port() + .or_else(default_port_number) + .ok_or(Error::InvalidUrl(url.to_string()))?; + + // if host is an ip address, return it directly + match host { + url::Host::Ipv4(ip) => return Ok(vec![SocketAddr::new(std::net::IpAddr::V4(ip), port)]), + url::Host::Ipv6(ip) => return Ok(vec![SocketAddr::new(std::net::IpAddr::V6(ip), port)]), + _ => {} + } + let host = host.to_string(); + + if allow_system_resolver { + let socket_addr = format!("{}:{}", host, port); + match lookup_host(socket_addr).await { + Ok(a) => { + let a = a.collect(); + tracing::debug!(?a, "system dns lookup done"); + return Ok(a); + } + Err(e) => { + tracing::error!(?e, "system dns lookup failed"); + #[cfg(not(feature = "dns-resolver"))] + return Err(e.into()); + } + } + } + + // use hickory_resolver + #[cfg(feature = "dns-resolver")] + { + let ret = RESOLVER.lookup_ip(&host).await.with_context(|| { + format!( + "hickory dns lookup_ip failed, host: {}, port: {}", + host, port + ) + })?; + Ok(ret + .iter() + .map(|ip| SocketAddr::new(ip, port)) + .collect::>()) + } + #[cfg(not(feature = "dns-resolver"))] + unreachable!("the system resolver error returns above") +} + +#[cfg(not(feature = "dns-resolver"))] +async fn resolve_ips(host: &str) -> Result, Error> { + Ok(lookup_host((host, 0)) + .await? + .map(|addr| addr.ip()) + .collect()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[cfg(feature = "dns-resolver")] + #[tokio::test] + async fn timed_out_system_lookup_is_not_retried() { + use std::sync::atomic::{AtomicUsize, Ordering}; + + let resolver = SystemDnsResolver::new(Duration::from_millis(10)); + let system_calls = Arc::new(AtomicUsize::new(0)); + let fallback_calls = AtomicUsize::new(0); + let expected = vec![IpAddr::V4(std::net::Ipv4Addr::LOCALHOST)]; + + let first_system_calls = system_calls.clone(); + let first = resolver + .resolve( + async move { + first_system_calls.fetch_add(1, Ordering::Relaxed); + std::future::pending::>>().await + }, + async { + fallback_calls.fetch_add(1, Ordering::Relaxed); + Ok(expected.clone()) + }, + ) + .await; + let second_system_calls = system_calls.clone(); + let second = resolver + .resolve( + async move { + second_system_calls.fetch_add(1, Ordering::Relaxed); + std::future::pending::>>().await + }, + async { + fallback_calls.fetch_add(1, Ordering::Relaxed); + Ok(expected.clone()) + }, + ) + .await; + + assert_eq!(first.unwrap(), expected); + assert_eq!(second.unwrap(), expected); + assert_eq!(system_calls.load(Ordering::Relaxed), 1); + assert_eq!(fallback_calls.load(Ordering::Relaxed), 2); + } + + #[cfg(feature = "dns-resolver")] + #[tokio::test] + async fn successful_system_lookup_skips_hickory() { + use std::sync::atomic::{AtomicUsize, Ordering}; + + let resolver = SystemDnsResolver::new(Duration::from_millis(10)); + let fallback_calls = AtomicUsize::new(0); + let expected = vec![IpAddr::V4(std::net::Ipv4Addr::LOCALHOST)]; + let system_result = expected.clone(); + + let addresses = resolver + .resolve(async move { Ok(system_result) }, async { + fallback_calls.fetch_add(1, Ordering::Relaxed); + Ok(Vec::new()) + }) + .await + .unwrap(); + + assert_eq!(addresses, expected); + assert_eq!(fallback_calls.load(Ordering::Relaxed), 0); + } + + #[test] + fn runtime_dns_context_preserves_process_routing_inputs() { + let context = SocketContext::default() + .with_socket_mark(Some(0)) + .with_netns(Some(easytier_core::socket::NetNamespace::new("instance-a"))); + + assert_eq!( + RuntimeDnsIoContext::from_socket_context(&context), + RuntimeDnsIoContext { + netns: Some("instance-a".to_owned()), + socket_mark: Some(0), + } + ); + } + + #[tokio::test] + async fn test_socket_addrs() { + let url = url::Url::parse("tcp://github-ci-test.easytier.cn:80").unwrap(); + let addrs = socket_addrs(&url, || Some(80)).await.unwrap(); + assert_eq!(2, addrs.len(), "addrs: {:?}", addrs); + println!("addrs: {:?}", addrs); + + let addrs = socket_addrs_with_system_resolver(&url, || Some(80), false) + .await + .unwrap(); + assert_eq!(2, addrs.len(), "addrs: {:?}", addrs); + println!("addrs2: {:?}", addrs); + } + + #[tokio::test] + async fn socket_addrs_preserves_explicit_zero_port() { + let cases = [ + ("ws://127.0.0.1:0", 80, 0), + ("wss://127.0.0.1:0", 443, 0), + ("ws://127.0.0.1", 80, 80), + ("wss://127.0.0.1", 443, 443), + ]; + + for (raw_url, default_port, expected_port) in cases { + let url = url::Url::parse(raw_url).unwrap(); + let addrs = socket_addrs(&url, || Some(default_port)).await.unwrap(); + assert_eq!( + addrs, + vec![SocketAddr::from(([127, 0, 0, 1], expected_port))] + ); + } + } +} diff --git a/vendor/easytier/easytier/src/common/env_parser.rs b/vendor/easytier/easytier/src/common/env_parser.rs new file mode 100644 index 0000000..15fcf5d --- /dev/null +++ b/vendor/easytier/easytier/src/common/env_parser.rs @@ -0,0 +1,248 @@ +//! 环境变量解析模块 +//! +//! 提供配置文件中环境变量占位符的解析功能 +//! 支持 Shell 风格的语法:${VAR}、$VAR、${VAR:-default} 等 + +use std::borrow::Cow; + +/// 解析字符串中的环境变量占位符 +/// +/// 支持的语法: +/// - `${VAR_NAME}` - 标准格式(推荐) +/// - `$VAR_NAME` - 简写格式 +/// - `${VAR_NAME:-default}` - 带默认值(bash 标准语法) +/// +/// # 参数 +/// - `text`: 待解析的字符串 +/// +/// # 返回值 +/// - `String`: 替换后的字符串 +/// - `bool`: 是否检测到并替换了环境变量 +pub fn expand_env_vars(text: &str) -> (String, bool) { + // 使用 shellexpand::env() 解析环境变量 + // 该函数仅处理环境变量,不处理 tilde (~) 扩展,适合配置文件场景 + match shellexpand::env(text) { + Ok(expanded) => { + // 通过比较原始字符串和扩展后的字符串判断是否发生了替换 + let changed = match &expanded { + Cow::Borrowed(_) => false, // 未发生变化,仍是借用 + Cow::Owned(_) => true, // 发生了变化,产生了新字符串 + }; + + (expanded.into_owned(), changed) + } + Err(e) => { + // 如果解析失败(例如变量引用语法错误),记录警告并返回原字符串 + tracing::warn!("Failed to expand environment variables in config: {}", e); + (text.to_string(), false) + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::tests::{remove_env_var, set_env_var}; + + #[test] + fn test_expand_standard_syntax() { + set_env_var("TEST_VAR_STANDARD", "test_value"); + let (result, changed) = expand_env_vars("secret=${TEST_VAR_STANDARD}"); + assert_eq!(result, "secret=test_value"); + assert!(changed); + } + + #[test] + fn test_expand_short_syntax() { + set_env_var("TEST_VAR_SHORT", "short_value"); + let (result, changed) = expand_env_vars("key=$TEST_VAR_SHORT"); + assert_eq!(result, "key=short_value"); + assert!(changed); + } + + #[test] + fn test_expand_with_default() { + // 确保变量未定义 + remove_env_var("UNDEFINED_VAR_WITH_DEFAULT"); + let (result, changed) = expand_env_vars("port=${UNDEFINED_VAR_WITH_DEFAULT:-8080}"); + assert_eq!(result, "port=8080"); + assert!(changed); + } + + #[test] + fn test_no_env_vars() { + let (result, changed) = expand_env_vars("plain text without variables"); + assert_eq!(result, "plain text without variables"); + assert!(!changed); + } + + #[test] + fn test_empty_string() { + let (result, changed) = expand_env_vars(""); + assert_eq!(result, ""); + assert!(!changed); + } + + #[test] + fn test_multiple_vars() { + set_env_var("VAR1", "value1"); + set_env_var("VAR2", "value2"); + let (result, changed) = expand_env_vars("${VAR1} and ${VAR2}"); + assert_eq!(result, "value1 and value2"); + assert!(changed); + } + + #[test] + fn test_undefined_var_without_default() { + // 确保变量未定义 + remove_env_var("COMPLETELY_UNDEFINED_VAR"); + let (result, changed) = expand_env_vars("value=${COMPLETELY_UNDEFINED_VAR}"); + // shellexpand::env 对未定义的变量会保持原样 + assert_eq!(result, "value=${COMPLETELY_UNDEFINED_VAR}"); + assert!(!changed); + } + + #[test] + fn test_complex_toml_config() { + set_env_var("ET_SECRET", "my-secret-key"); + set_env_var("ET_PORT", "11010"); + + let config = r#" +[network_identity] +network_name = "test-network" +network_secret = "${ET_SECRET}" + +[[peer]] +uri = "tcp://127.0.0.1:${ET_PORT}" +"#; + + let (result, changed) = expand_env_vars(config); + assert!(changed); + assert!(result.contains(r#"network_secret = "my-secret-key""#)); + assert!(result.contains(r#"uri = "tcp://127.0.0.1:11010""#)); + } + + #[test] + fn test_escape_syntax_double_dollar() { + set_env_var("ESCAPED_VAR", "should_not_expand"); + // shellexpand 使用 $$ 作为转义序列,表示字面量的单个 $ + // $$ 会被转义为单个 $,不会触发变量扩展 + let (result, changed) = expand_env_vars("value=$${ESCAPED_VAR}"); + assert_eq!(result, "value=${ESCAPED_VAR}"); + assert!(changed); // $$ -> $ 被视为一次变换 + } + + #[test] + fn test_escape_syntax_backslash() { + set_env_var("ESCAPED_VAR", "should_not_expand"); + // shellexpand 中反斜杠转义的行为:\$ 会展开为 \<变量值> + // 这不是推荐的转义方式,此测试仅为记录实际行为 + let (result, changed) = expand_env_vars(r"value=\${ESCAPED_VAR}"); + assert_eq!(result, r"value=\should_not_expand"); + assert!(changed); + } + + #[test] + fn test_multiple_dollar_signs() { + set_env_var("TEST_VAR", "value"); + // 测试多个连续的 $ 符号 + let (result1, changed1) = expand_env_vars("$$"); + assert_eq!(result1, "$"); + assert!(changed1); + + let (result2, changed2) = expand_env_vars("$$$$"); + assert_eq!(result2, "$$"); + assert!(changed2); + + // $$ 后跟变量扩展 + let (result3, changed3) = expand_env_vars("$$$TEST_VAR"); + assert_eq!(result3, "$value"); + assert!(changed3); + } + + #[test] + fn test_empty_var_value() { + set_env_var("EMPTY_VAR", ""); + let (result, changed) = expand_env_vars("value=${EMPTY_VAR}"); + // 变量存在但值为空 + assert_eq!(result, "value="); + assert!(changed); + } + + #[test] + fn test_default_with_special_chars() { + remove_env_var("UNDEFINED_SPECIAL"); + // 测试默认值包含冒号、等号、空格等特殊字符 + let (result, changed) = expand_env_vars("url=${UNDEFINED_SPECIAL:-http://localhost:8080}"); + assert_eq!(result, "url=http://localhost:8080"); + assert!(changed); + + let (result2, changed2) = expand_env_vars("key=${UNDEFINED_SPECIAL:-name=value}"); + assert_eq!(result2, "key=name=value"); + assert!(changed2); + + let (result3, changed3) = expand_env_vars("msg=${UNDEFINED_SPECIAL:-hello world}"); + assert_eq!(result3, "msg=hello world"); + assert!(changed3); + } + + #[test] + fn test_var_name_with_numbers_underscores() { + set_env_var("VAR_123", "num_value"); + set_env_var("_VAR", "underscore_prefix"); + set_env_var("VAR_", "underscore_suffix"); + + let (result1, changed1) = expand_env_vars("${VAR_123}"); + assert_eq!(result1, "num_value"); + assert!(changed1); + + let (result2, changed2) = expand_env_vars("${_VAR}"); + assert_eq!(result2, "underscore_prefix"); + assert!(changed2); + + let (result3, changed3) = expand_env_vars("${VAR_}"); + assert_eq!(result3, "underscore_suffix"); + assert!(changed3); + } + + #[test] + fn test_invalid_syntax() { + // 测试无效语法的处理 + let (result1, changed1) = expand_env_vars("${}"); + // shellexpand 会保留无效语法原样 + assert_eq!(result1, "${}"); + assert!(!changed1); + + // 注意:未闭合的 ${VAR 实际上 shellexpand 会当作普通文本处理 + // 它会尝试查找名为 "VAR" 的环境变量(到字符串末尾) + remove_env_var("VAR"); + let (result2, _changed2) = expand_env_vars("incomplete ${VAR"); + // 如果 VAR 未定义,shellexpand 会返回错误或保持原样 + assert_eq!(result2, "incomplete ${VAR"); + // 注意:changed2 的值取决于 shellexpand 是否认为这是有效语法 + // 因此不对 changed2 做断言 + } + + #[test] + fn test_mixed_defined_undefined_vars() { + set_env_var("DEFINED_VAR", "defined"); + remove_env_var("UNDEFINED_VAR"); + + // 混合已定义和未定义的变量 + // shellexpand::env 在遇到未定义变量时会返回错误(默认行为) + // 因此整个字符串会保持不变 + let (result, changed) = expand_env_vars("${DEFINED_VAR} and ${UNDEFINED_VAR}"); + assert_eq!(result, "${DEFINED_VAR} and ${UNDEFINED_VAR}"); + assert!(!changed); + } + + #[test] + fn test_nested_braces() { + set_env_var("OUTER", "outer_value"); + // 嵌套的大括号是无效语法,shellexpand::env 会返回错误 + let (result, changed) = expand_env_vars("${OUTER} and ${{INNER}}"); + // 由于语法错误,整个字符串保持不变 + assert_eq!(result, "${OUTER} and ${{INNER}}"); + assert!(!changed); + } +} diff --git a/vendor/easytier/easytier/src/common/error.rs b/vendor/easytier/easytier/src/common/error.rs new file mode 100644 index 0000000..e6209f3 --- /dev/null +++ b/vendor/easytier/easytier/src/common/error.rs @@ -0,0 +1,29 @@ +use std::{io, result}; +use thiserror::Error; + +use easytier_core::tunnel::TunnelError; + +#[derive(Error, Debug)] +pub enum Error { + #[error("io error")] + IOError(#[from] io::Error), + + #[cfg(feature = "tun")] + #[error("rust tun error {0}")] + TunError(#[from] tun::Error), + + #[error("tunnel error {0}")] + TunnelError(#[from] TunnelError), + #[error("Not found")] + NotFound, + #[error("Invalid Url: {0}")] + InvalidUrl(String), + #[error("Shell Command error: {0}")] + ShellCommandError(String), + #[error("Timeout error: {0}")] + Timeout(#[from] tokio::time::error::Elapsed), + #[error("anyhow error: {0}")] + AnyhowError(#[from] anyhow::Error), +} + +pub type Result = result::Result; diff --git a/vendor/easytier/easytier/src/common/global_ctx.rs b/vendor/easytier/easytier/src/common/global_ctx.rs new file mode 100644 index 0000000..f3000d0 --- /dev/null +++ b/vendor/easytier/easytier/src/common/global_ctx.rs @@ -0,0 +1,498 @@ +use std::{ + collections::HashSet, + net::{IpAddr, Ipv6Addr}, + sync::{Arc, Mutex}, +}; + +use arc_swap::ArcSwap; +use async_trait::async_trait; +use easytier_core::connectivity::composite::ConnectorRuntime as _; +use easytier_core::peers::public_ipv6::PublicIpv6Host; +use easytier_core::socket::{NetNamespace, SocketContext}; +use easytier_core::tunnel::effective_encryption_uses_xor; +use easytier_core::{ + config::{PeerId, peers::PeerRuntimeSnapshot, runtime::CoreInstanceRuntimeConfig}, + instance::{CoreInstanceConfig, CoreInstanceHostConfig}, +}; + +use super::{ + config::{ConfigLoader, Flags, NetworkIdentity}, + netns::NetNS, +}; +#[cfg(feature = "management")] +use crate::proto::api::config::InstanceConfigPatch; +use crate::proto::api::instance::PeerConnInfo; +use crate::proto::common::PortForwardConfigPb; +use crossbeam::atomic::AtomicCell; + +#[derive(Debug, Clone, PartialEq)] +#[cfg_attr(feature = "management", derive(serde::Serialize, serde::Deserialize))] +pub enum GlobalCtxEvent { + TunDeviceReady(String), + TunDeviceError(String), + + PeerAdded(PeerId), + PeerRemoved(PeerId), + PeerConnAdded(PeerConnInfo), + PeerConnRemoved(PeerConnInfo), + + ListenerAdded(url::Url), + ListenerAddFailed(url::Url, String), // (url, error message) + ListenerAcceptFailed(url::Url, String), // (url, error message) + ConnectionAccepted(String, String), // (local url, remote url) + ConnectionError(String, String, String), // (local url, remote url, error message) + ListenerPortMappingEstablished { + local_listener: url::Url, + mapped_listener: url::Url, + backend: String, + }, + + Connecting(url::Url), + ConnectError(String, String, String), // (dst, ip version, error message) + + VpnPortalStarted(String), // (portal) + VpnPortalClientConnected(String, String), // (portal, client ip) + VpnPortalClientDisconnected(String, String), // (portal, client ip) + + DhcpIpv4Changed(Option, Option), // (old, new) + DhcpIpv4Conflicted(Option), + PublicIpv6Changed(Option, Option), // (old, new) + PublicIpv6RoutesUpdated(Vec, Vec), // (added, removed) + + PortForwardAdded(PortForwardConfigPb), + + #[cfg(feature = "management")] + ConfigPatched(InstanceConfigPatch), + + ProxyCidrsUpdated(Vec, Vec), // (added, removed) + + UdpBroadcastRelayStartResult { + capture_backend: Option, + error: Option, + }, + + CredentialChanged, +} + +pub type EventBus = tokio::sync::broadcast::Sender; +pub type EventBusSubscriber = tokio::sync::broadcast::Receiver; + +pub struct GlobalCtx { + pub inst_name: String, + pub id: uuid::Uuid, + pub config: Box, + pub net_ns: NetNS, + pub network: NetworkIdentity, + + event_bus: EventBus, + + cached_ipv4: AtomicCell>, + cached_ipv6: AtomicCell>, + hostname: Mutex, + + tun_device_name: Mutex>, + + flags: ArcSwap, + runtime_endpoint_protocols: Option>, +} + +impl std::fmt::Debug for GlobalCtx { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("GlobalCtx") + .field("inst_name", &self.inst_name) + .field("id", &self.id) + .field("net_ns", &self.net_ns.name()) + .field("event_bus", &"EventBus") + .field("ipv4", &self.cached_ipv4) + .finish() + } +} + +pub type ArcGlobalCtx = std::sync::Arc; + +#[async_trait] +impl PublicIpv6Host for GlobalCtx { + async fn collect_reserved_public_ipv6_addrs( + &self, + prefix: cidr::Ipv6Cidr, + ) -> HashSet { + let context = SocketContext::default() + .with_socket_mark(self.get_flags().socket_mark) + .with_netns(self.net_ns.name().map(NetNamespace::new)); + let ip_list = crate::host_runtime::native_host_runtime() + .collect_ip_addrs(&context) + .await; + let mut reserved = HashSet::new(); + reserved.extend( + ip_list + .interface_ipv6s + .into_iter() + .map(Ipv6Addr::from) + .filter(|addr| prefix.contains(addr)), + ); + reserved.extend( + ip_list + .public_ipv6 + .into_iter() + .map(Ipv6Addr::from) + .filter(|addr| prefix.contains(addr)), + ); + reserved + } +} + +impl GlobalCtx { + pub fn new(config_fs: impl ConfigLoader + 'static) -> Self { + Self::new_inner(config_fs, None, None) + } + + pub(crate) fn new_with_runtime_config( + config_fs: impl ConfigLoader + 'static, + runtime: &CoreInstanceConfig, + host: &CoreInstanceHostConfig, + ) -> Self { + let runtime = CoreInstanceRuntimeConfig { + services: runtime.connectivity.runtime.clone(), + peer: Arc::new(runtime.peer.snapshot.clone()), + }; + let protocols = host.ignore_unsupported_config.then(|| { + host.endpoint_protocols + .iter() + .map(|protocol| protocol.to_ascii_lowercase()) + .collect() + }); + Self::new_inner(config_fs, Some(&runtime), protocols) + } + + fn new_inner( + config_fs: impl ConfigLoader + 'static, + runtime: Option<&CoreInstanceRuntimeConfig>, + runtime_endpoint_protocols: Option>, + ) -> Self { + let id = config_fs.get_id(); + let network = config_fs.get_network_identity(); + let net_ns = NetNS::new(config_fs.get_netns()); + let hostname = runtime + .and_then(|runtime| runtime.peer.runtime.core.node.hostname.clone()) + .unwrap_or_else(|| match config_fs.get_hostname() { + hostname if !hostname.is_empty() => hostname, + _ => gethostname::gethostname().to_string_lossy().to_string(), + }); + let flags = runtime + .map(|runtime| runtime.peer.flags.clone()) + .unwrap_or_else(|| config_fs.get_flags()); + let ipv4 = runtime + .map(|runtime| Self::runtime_ipv4(&runtime.peer)) + .unwrap_or_else(|| config_fs.get_ipv4()); + let ipv6 = runtime + .map(|runtime| Self::runtime_ipv6(&runtime.peer)) + .unwrap_or_else(|| config_fs.get_ipv6()); + if flags.enable_encryption && effective_encryption_uses_xor(&flags.encryption_algorithm) { + tracing::warn!("using insecure XOR because no AEAD encryption is configured"); + } + + let (event_bus, _) = tokio::sync::broadcast::channel(16); + GlobalCtx { + inst_name: config_fs.get_inst_name(), + id, + config: Box::new(config_fs), + net_ns: net_ns.clone(), + network, + + event_bus, + cached_ipv4: AtomicCell::new(ipv4), + cached_ipv6: AtomicCell::new(ipv6), + hostname: Mutex::new(hostname), + + tun_device_name: Mutex::new(None), + + flags: ArcSwap::new(Arc::new(flags)), + runtime_endpoint_protocols, + } + } + + pub(crate) fn runtime_ipv4(peer: &PeerRuntimeSnapshot) -> Option { + let prefix = peer.runtime.core.routes.ipv4.as_ref()?; + let IpAddr::V4(address) = prefix.address else { + return None; + }; + cidr::Ipv4Inet::new(address, prefix.prefix_len).ok() + } + + pub(crate) fn runtime_ipv6(peer: &PeerRuntimeSnapshot) -> Option { + let prefix = peer.runtime.core.routes.ipv6.as_ref()?; + let IpAddr::V6(address) = prefix.address else { + return None; + }; + cidr::Ipv6Inet::new(address, prefix.prefix_len).ok() + } + + pub fn subscribe(&self) -> EventBusSubscriber { + self.event_bus.subscribe() + } + + pub fn issue_event(&self, event: GlobalCtxEvent) { + if let Err(e) = self.event_bus.send(event.clone()) { + tracing::warn!( + "Failed to send event: {:?}, error: {:?}, receiver count: {}", + event, + e, + self.event_bus.receiver_count() + ); + } + } + + #[cfg(any(feature = "tun", test))] + fn set_tun_device_name(&self, name: Option) { + *self.tun_device_name.lock().unwrap() = name; + } + + #[cfg(any(feature = "tun", test))] + pub(crate) fn set_tun_device_ready(&self, name: String) { + self.set_tun_device_name(Some(name.clone())); + self.issue_event(GlobalCtxEvent::TunDeviceReady(name)); + } + + #[cfg(any(feature = "tun", test))] + pub(crate) fn set_tun_device_error(&self, error: String) { + self.set_tun_device_name(None); + self.issue_event(GlobalCtxEvent::TunDeviceError(error)); + } + + pub fn get_tun_device_name(&self) -> Option { + self.tun_device_name.lock().unwrap().clone() + } + + pub fn get_ipv4(&self) -> Option { + self.cached_ipv4.load() + } + + pub fn set_ipv4(&self, addr: Option) { + self.cached_ipv4.store(addr); + } + + pub fn get_ipv6(&self) -> Option { + self.cached_ipv6.load() + } + + pub fn set_ipv6(&self, addr: Option) { + self.cached_ipv6.store(addr); + } + + pub fn is_ip_local_ipv6(&self, ip: &std::net::Ipv6Addr) -> bool { + self.get_ipv6().map(|x| x.address() == *ip).unwrap_or(false) + } + + pub fn get_id(&self) -> uuid::Uuid { + self.config.get_id() + } + + pub fn is_ip_in_same_network(&self, ip: &IpAddr) -> bool { + match ip { + IpAddr::V4(v4) => self.get_ipv4().map(|x| x.contains(v4)).unwrap_or(false), + IpAddr::V6(v6) => self.get_ipv6().map(|x| x.contains(v6)).unwrap_or(false), + } + } + + pub fn is_ip_local_virtual_ip(&self, ip: &IpAddr) -> bool { + match ip { + IpAddr::V4(v4) => self.get_ipv4().map(|x| x.address() == *v4).unwrap_or(false), + IpAddr::V6(v6) => self.is_ip_local_ipv6(v6), + } + } + + pub fn get_network_identity(&self) -> NetworkIdentity { + self.config.get_network_identity() + } + + pub fn get_network_name(&self) -> String { + self.get_network_identity().network_name + } + + pub fn get_hostname(&self) -> String { + return self.hostname.lock().unwrap().clone(); + } + + pub fn set_hostname(&self, hostname: String) { + *self.hostname.lock().unwrap() = hostname; + } + + pub fn get_flags(&self) -> Flags { + self.flags.load().as_ref().clone() + } + + pub fn set_flags(&self, flags: Flags) { + self.flags.store(Arc::new(flags)); + } + + pub fn flags_arc(&self) -> Arc { + self.flags.load_full() + } + + pub fn enable_exit_node(&self) -> bool { + self.flags.load().enable_exit_node || cfg!(target_env = "ohos") + } + + pub fn proxy_forward_by_system(&self) -> bool { + self.flags.load().proxy_forward_by_system + } + + pub fn no_tun(&self) -> bool { + self.flags.load().no_tun + } + + pub fn runtime_mapped_listeners(&self) -> Vec { + let listeners = self.config.get_mapped_listeners(); + let Some(protocols) = &self.runtime_endpoint_protocols else { + return listeners; + }; + listeners + .into_iter() + .filter(|listener| protocols.contains(&listener.scheme().to_ascii_lowercase())) + .collect() + } +} + +#[cfg(test)] +pub mod tests { + use crate::common::config::TomlConfigLoader; + + use super::*; + + #[tokio::test] + async fn test_global_ctx() { + let config = TomlConfigLoader::default(); + let global_ctx = GlobalCtx::new(config); + + let mut subscriber = global_ctx.subscribe(); + let peer_id = rand::random(); + global_ctx.issue_event(GlobalCtxEvent::PeerAdded(peer_id)); + global_ctx.issue_event(GlobalCtxEvent::PeerRemoved(peer_id)); + global_ctx.issue_event(GlobalCtxEvent::PeerConnAdded(PeerConnInfo::default())); + global_ctx.issue_event(GlobalCtxEvent::PeerConnRemoved(PeerConnInfo::default())); + + assert_eq!( + subscriber.recv().await.unwrap(), + GlobalCtxEvent::PeerAdded(peer_id) + ); + assert_eq!( + subscriber.recv().await.unwrap(), + GlobalCtxEvent::PeerRemoved(peer_id) + ); + assert_eq!( + subscriber.recv().await.unwrap(), + GlobalCtxEvent::PeerConnAdded(PeerConnInfo::default()) + ); + assert_eq!( + subscriber.recv().await.unwrap(), + GlobalCtxEvent::PeerConnRemoved(PeerConnInfo::default()) + ); + } + + #[tokio::test] + async fn test_tun_device_name_tracks_explicit_runtime_state() { + let config = TomlConfigLoader::default(); + let global_ctx = GlobalCtx::new(config); + + assert_eq!(global_ctx.get_tun_device_name(), None); + + global_ctx.issue_event(GlobalCtxEvent::TunDeviceReady("ignored".to_string())); + assert_eq!(global_ctx.get_tun_device_name(), None); + + let mut subscriber = global_ctx.subscribe(); + + global_ctx.set_tun_device_ready("easytier0".to_string()); + assert_eq!( + global_ctx.get_tun_device_name(), + Some("easytier0".to_string()) + ); + assert_eq!( + subscriber.recv().await.unwrap(), + GlobalCtxEvent::TunDeviceReady("easytier0".to_string()) + ); + + global_ctx.set_tun_device_error("closed".to_string()); + assert_eq!(global_ctx.get_tun_device_name(), None); + assert_eq!( + subscriber.recv().await.unwrap(), + GlobalCtxEvent::TunDeviceError("closed".to_string()) + ); + } + + #[test] + fn host_hostname_fallback_does_not_materialize_in_toml() { + let config = TomlConfigLoader::default(); + let global_ctx = GlobalCtx::new(config.clone()); + + assert!(!global_ctx.get_hostname().is_empty()); + assert!(!config.dump().contains("hostname")); + } + + #[test] + fn active_dhcp_ipv4_survives_declarative_config_replacement() { + let config = TomlConfigLoader::default(); + config.set_dhcp(true); + let global_ctx = GlobalCtx::new(config.clone()); + let lease = "10.144.144.7/24".parse().unwrap(); + + global_ctx.set_ipv4(Some(lease)); + config.set_ipv4(None); + + assert_eq!(global_ctx.get_ipv4(), Some(lease)); + } + + #[test] + fn runtime_state_does_not_rewrite_toml_config() { + let config = TomlConfigLoader::default(); + let global_ctx = GlobalCtx::new(config.clone()); + let mut runtime_flags = global_ctx.get_flags(); + runtime_flags.enable_exit_node = true; + + global_ctx.set_ipv4(Some("10.144.144.7/24".parse().unwrap())); + global_ctx.set_ipv6(Some("fd00::7/64".parse().unwrap())); + global_ctx.set_flags(runtime_flags); + + assert_eq!(config.get_ipv4(), None); + assert_eq!(config.get_ipv6(), None); + assert!(!config.get_flags().enable_exit_node); + assert_eq!( + global_ctx.get_ipv4(), + Some("10.144.144.7/24".parse().unwrap()) + ); + assert_eq!(global_ctx.get_ipv6(), Some("fd00::7/64".parse().unwrap())); + assert!(global_ctx.get_flags().enable_exit_node); + } + + #[test] + fn compact_runtime_does_not_advertise_unsupported_mapped_listeners() { + let config = TomlConfigLoader::default(); + config.set_mapped_listeners(Some(vec![ + "tcp://127.0.0.1:11010".parse().unwrap(), + "quic://127.0.0.1:11011".parse().unwrap(), + ])); + let host = crate::instance::config::compact_runtime_core_host_config(); + let normalized = + easytier_core::instance::CoreInstanceConfig::from_toml_with_host(&config, &host) + .unwrap(); + + let global_ctx = GlobalCtx::new_with_runtime_config(config.clone(), &normalized, &host); + + assert_eq!(config.get_mapped_listeners().len(), 2); + assert_eq!(global_ctx.runtime_mapped_listeners().len(), 1); + assert_eq!(global_ctx.runtime_mapped_listeners()[0].scheme(), "tcp"); + } + + pub fn get_mock_global_ctx_with_network( + network_identy: Option, + ) -> ArcGlobalCtx { + let config_fs = TomlConfigLoader::default(); + config_fs.set_inst_name(format!("test_{}", config_fs.get_id())); + config_fs.set_network_identity(network_identy.unwrap_or_default()); + + Arc::new(GlobalCtx::new(config_fs)) + } + + pub fn get_mock_global_ctx() -> ArcGlobalCtx { + get_mock_global_ctx_with_network(None) + } +} diff --git a/vendor/easytier/easytier/src/common/ifcfg/darwin.rs b/vendor/easytier/easytier/src/common/ifcfg/darwin.rs new file mode 100644 index 0000000..0412d9e --- /dev/null +++ b/vendor/easytier/easytier/src/common/ifcfg/darwin.rs @@ -0,0 +1,136 @@ +use std::net::Ipv4Addr; + +use super::{Error, IfConfiguerTrait, cidr_to_subnet_mask, run_shell_cmd}; +use async_trait::async_trait; +use cidr::{Ipv4Inet, Ipv6Inet}; + +pub struct MacIfConfiger {} +#[async_trait] +impl IfConfiguerTrait for MacIfConfiger { + async fn add_ipv4_route( + &self, + name: &str, + address: Ipv4Addr, + cidr_prefix: u8, + cost: Option, + ) -> Result<(), Error> { + run_shell_cmd( + format!( + "route -n add {} -netmask {} -interface {} -hopcount {}", + address, + cidr_to_subnet_mask(cidr_prefix), + name, + cost.unwrap_or(7) + ) + .as_str(), + ) + .await + } + + async fn remove_ipv4_route( + &self, + name: &str, + address: Ipv4Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + run_shell_cmd( + format!( + "route -n delete {} -netmask {} -interface {}", + address, + cidr_to_subnet_mask(cidr_prefix), + name + ) + .as_str(), + ) + .await + } + + async fn add_ipv4_ip( + &self, + name: &str, + address: Ipv4Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + run_shell_cmd( + format!( + "ifconfig {} {:?}/{:?} {:?} up", + name, address, cidr_prefix, address, + ) + .as_str(), + ) + .await + } + + async fn set_link_status(&self, name: &str, up: bool) -> Result<(), Error> { + run_shell_cmd(format!("ifconfig {} {}", name, if up { "up" } else { "down" }).as_str()) + .await + } + + async fn remove_ip(&self, name: &str, ip: Option) -> Result<(), Error> { + if let Some(ip) = ip { + run_shell_cmd(format!("ifconfig {} inet {} delete", name, ip.address()).as_str()).await + } else { + run_shell_cmd(format!("ifconfig {} inet delete", name).as_str()).await + } + } + + async fn set_mtu(&self, name: &str, mtu: u32) -> Result<(), Error> { + run_shell_cmd(format!("ifconfig {} mtu {}", name, mtu).as_str()).await + } + + async fn add_ipv6_ip( + &self, + name: &str, + address: std::net::Ipv6Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + run_shell_cmd(format!("ifconfig {} inet6 {}/{} add", name, address, cidr_prefix).as_str()) + .await + } + + async fn remove_ipv6(&self, name: &str, ip: Option) -> Result<(), Error> { + if let Some(ip) = ip { + run_shell_cmd(format!("ifconfig {} inet6 {} delete", name, ip.address()).as_str()).await + } else { + // Remove all IPv6 addresses is more complex on macOS, just succeed + Ok(()) + } + } + + async fn add_ipv6_route( + &self, + name: &str, + address: std::net::Ipv6Addr, + cidr_prefix: u8, + cost: Option, + ) -> Result<(), Error> { + let cmd = if let Some(cost) = cost { + format!( + "route -n add -inet6 {}/{} -interface {} -hopcount {}", + address, cidr_prefix, name, cost + ) + } else { + format!( + "route -n add -inet6 {}/{} -interface {}", + address, cidr_prefix, name + ) + }; + run_shell_cmd(cmd.as_str()).await + } + + async fn remove_ipv6_route( + &self, + name: &str, + address: std::net::Ipv6Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + run_shell_cmd( + format!( + "route -n delete -inet6 {}/{} -interface {}", + address, cidr_prefix, name + ) + .as_str(), + ) + .await + } +} diff --git a/vendor/easytier/easytier/src/common/ifcfg/mod.rs b/vendor/easytier/easytier/src/common/ifcfg/mod.rs new file mode 100644 index 0000000..e93a72f --- /dev/null +++ b/vendor/easytier/easytier/src/common/ifcfg/mod.rs @@ -0,0 +1,242 @@ +#![cfg_attr( + not(any(feature = "public-ipv6-provider", feature = "tun")), + allow(dead_code) +)] + +#[cfg(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" +))] +mod darwin; +#[cfg(all(target_os = "linux", feature = "linux-netlink"))] +mod netlink; +#[cfg(all(target_os = "linux", feature = "linux-netlink"))] +mod netlink_wire; +#[cfg(target_os = "windows")] +mod win; +#[cfg(target_os = "windows")] +mod windows; + +use std::net::{Ipv4Addr, Ipv6Addr}; + +use async_trait::async_trait; +use cidr::{Ipv4Inet, Ipv6Inet}; +#[cfg(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" +))] +#[cfg(not(target_os = "macos"))] +use tokio::process::Command; + +use super::error::Error; + +#[async_trait] +pub trait IfConfiguerTrait: Send + Sync { + async fn add_ipv4_route( + &self, + _name: &str, + _address: Ipv4Addr, + _cidr_prefix: u8, + _cost: Option, + ) -> Result<(), Error> { + Ok(()) + } + async fn remove_ipv4_route( + &self, + _name: &str, + _address: Ipv4Addr, + _cidr_prefix: u8, + ) -> Result<(), Error> { + Ok(()) + } + async fn add_ipv4_ip( + &self, + _name: &str, + _address: Ipv4Addr, + _cidr_prefix: u8, + ) -> Result<(), Error> { + Ok(()) + } + async fn add_ipv6_route( + &self, + _name: &str, + _address: Ipv6Addr, + _cidr_prefix: u8, + _cost: Option, + ) -> Result<(), Error> { + Ok(()) + } + async fn remove_ipv6_route( + &self, + _name: &str, + _address: Ipv6Addr, + _cidr_prefix: u8, + ) -> Result<(), Error> { + Ok(()) + } + async fn add_ipv6_ip( + &self, + _name: &str, + _address: Ipv6Addr, + _cidr_prefix: u8, + ) -> Result<(), Error> { + Ok(()) + } + async fn set_link_status(&self, _name: &str, _up: bool) -> Result<(), Error> { + Ok(()) + } + async fn remove_ip(&self, _name: &str, _ip: Option) -> Result<(), Error> { + Ok(()) + } + async fn remove_ipv6(&self, _name: &str, _ip: Option) -> Result<(), Error> { + Ok(()) + } + async fn wait_interface_show(&self, _name: &str) -> Result<(), Error> { + return Ok(()); + } + async fn set_mtu(&self, _name: &str, _mtu: u32) -> Result<(), Error> { + Ok(()) + } +} + +#[cfg(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" +))] +fn cidr_to_subnet_mask(prefix_length: u8) -> Ipv4Addr { + if prefix_length > 32 { + panic!("Invalid CIDR prefix length"); + } + + let subnet_mask: u32 = (!0u32) + .checked_shl(32 - u32::from(prefix_length)) + .unwrap_or(0); + Ipv4Addr::new( + ((subnet_mask >> 24) & 0xFF) as u8, + ((subnet_mask >> 16) & 0xFF) as u8, + ((subnet_mask >> 8) & 0xFF) as u8, + (subnet_mask & 0xFF) as u8, + ) +} + +#[cfg(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" +))] +async fn run_shell_cmd(cmd: &str) -> Result<(), Error> { + let cmd_out: std::process::Output; + let stdout: String; + let stderr: String; + #[cfg(target_os = "windows")] + { + const CREATE_NO_WINDOW: u32 = 0x08000000; + cmd_out = Command::new("cmd") + .stdin(std::process::Stdio::null()) + .arg("/C") + .arg(cmd) + .creation_flags(CREATE_NO_WINDOW) + .output() + .await?; + stdout = crate::utils::string::utf8_or_gbk_to_string(cmd_out.stdout.as_slice()); + stderr = crate::utils::string::utf8_or_gbk_to_string(cmd_out.stderr.as_slice()); + }; + + #[cfg(not(target_os = "windows"))] + { + // macOS interface setup must not depend on Tokio's process-wide SIGCHLD + // registration: an embedding host can own other runtimes/signal handlers. + #[cfg(target_os = "macos")] + { + let command = cmd.to_owned(); + cmd_out = tokio::task::spawn_blocking(move || { + std::process::Command::new("/bin/sh") + .arg("-c") + .arg(command) + .stdin(std::process::Stdio::null()) + .output() + }) + .await + .map_err(|error| Error::ShellCommandError(error.to_string()))??; + } + #[cfg(not(target_os = "macos"))] + { + cmd_out = Command::new("sh").arg("-c").arg(cmd).output().await?; + } + stdout = String::from_utf8_lossy(cmd_out.stdout.as_slice()).to_string(); + stderr = String::from_utf8_lossy(cmd_out.stderr.as_slice()).to_string(); + }; + + let ec = cmd_out.status.code(); + let succ = cmd_out.status.success(); + tracing::info!(?cmd, ?ec, ?succ, ?stdout, ?stderr, "run shell cmd"); + + if !cmd_out.status.success() { + return Err(Error::ShellCommandError(stdout + &stderr)); + } + Ok(()) +} + +pub struct DummyIfConfiger {} +#[async_trait] +impl IfConfiguerTrait for DummyIfConfiger {} + +#[cfg(all(target_os = "linux", feature = "linux-netlink"))] +pub type IfConfiger = netlink::NetlinkIfConfiger; +#[cfg(all(target_os = "linux", not(feature = "linux-netlink")))] +pub type IfConfiger = DummyIfConfiger; + +#[cfg(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" +))] +pub type IfConfiger = darwin::MacIfConfiger; + +#[cfg(target_os = "windows")] +pub type IfConfiger = windows::WindowsIfConfiger; + +#[cfg(not(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "linux", + target_os = "windows", + target_os = "freebsd", +)))] +pub type IfConfiger = DummyIfConfiger; + +#[cfg(target_os = "windows")] +pub use windows::RegistryManager; + +#[cfg(all(target_os = "linux", feature = "linux-netlink"))] +pub(crate) use netlink_wire::RouteMessage; +#[cfg(all( + target_os = "linux", + feature = "linux-netlink", + feature = "public-ipv6-provider" +))] +pub(crate) use netlink_wire::RouteType; + +#[cfg(all(target_os = "linux", feature = "linux-netlink"))] +pub(crate) fn list_ipv6_route_messages() -> Result, Error> { + netlink::NetlinkIfConfiger::list_ipv6_route_messages() +} + +#[cfg(all(target_os = "linux", feature = "linux-netlink"))] +pub(crate) fn get_interface_index(name: &str) -> Result { + netlink::NetlinkIfConfiger::get_interface_index(name) +} + +#[cfg(all(target_os = "linux", feature = "linux-netlink"))] +pub(crate) fn add_ipv6_ndp_proxy(name: &str, address: Ipv6Addr) -> Result<(), Error> { + netlink::NetlinkIfConfiger::add_ipv6_ndp_proxy(name, address) +} + +#[cfg(all(target_os = "linux", feature = "linux-netlink"))] +pub(crate) fn remove_ipv6_ndp_proxy(name: &str, address: Ipv6Addr) -> Result<(), Error> { + netlink::NetlinkIfConfiger::remove_ipv6_ndp_proxy(name, address) +} + +#[cfg(all(target_os = "linux", feature = "linux-netlink"))] +pub(crate) fn list_ipv6_ndp_proxy( + name: &str, +) -> Result, Error> { + netlink::NetlinkIfConfiger::list_ipv6_ndp_proxy(name) +} diff --git a/vendor/easytier/easytier/src/common/ifcfg/netlink.rs b/vendor/easytier/easytier/src/common/ifcfg/netlink.rs new file mode 100644 index 0000000..a401e74 --- /dev/null +++ b/vendor/easytier/easytier/src/common/ifcfg/netlink.rs @@ -0,0 +1,799 @@ +#![cfg_attr( + not(any(feature = "public-ipv6-provider", feature = "tun")), + allow(dead_code) +)] + +use std::{ + collections::BTreeSet, + ffi::CString, + fmt::Debug, + net::{IpAddr, Ipv4Addr, Ipv6Addr}, + os::fd::AsRawFd, +}; + +use super::{ + Error, IfConfiguerTrait, + netlink_wire::{ + AddressMessage, MessageBuilder, MessageIter, NLM_F_ACK, NLM_F_CREATE, NLM_F_DUMP, + NLM_F_DUMP_INTR, NLM_F_EXCL, NLM_F_REQUEST, NLMSG_DONE, NLMSG_ERROR, NeighborMessage, + NetlinkDecode, NetlinkEncode, RTM_DELADDR, RTM_DELNEIGH, RTM_DELROUTE, RTM_GETNEIGH, + RTM_GETROUTE, RTM_NEWADDR, RTM_NEWNEIGH, RTM_NEWROUTE, RouteMessage, RouteMessageBuilder, + RouteType, netlink_error_code, + }, +}; +use crate::common::network::ip_mask_to_prefix; +use anyhow::Context; +use async_trait::async_trait; +use cidr::{IpInet, Ipv4Inet, Ipv6Inet}; +use netlink_sys::{Socket, SocketAddr, protocols::NETLINK_ROUTE}; +#[cfg(test)] +use nix::libc::SIOCGIFMTU; +use nix::{ + ifaddrs::getifaddrs, + libc::{self, Ioctl, SIOCGIFFLAGS, SIOCSIFFLAGS, SIOCSIFMTU, ifreq, ioctl}, + net::if_::InterfaceFlags, + sys::socket::SockaddrLike as _, +}; + +pub(crate) fn dummy_socket() -> Result { + Ok(std::net::UdpSocket::bind("0:0")?) +} + +fn build_ifreq(name: &str) -> ifreq { + let c_str = CString::new(name).unwrap(); + let mut ifr: ifreq = unsafe { std::mem::zeroed() }; + let name_bytes = c_str.as_bytes_with_nul(); + for (i, &b) in name_bytes.iter().enumerate() { + ifr.ifr_name[i] = b as libc::c_char; + } + ifr +} + +fn send_netlink_req(builder: MessageBuilder) -> Result { + let mut socket = Socket::new(NETLINK_ROUTE)?; + socket.bind_auto()?; + socket.connect(&SocketAddr::new(0, 0))?; + + let buf = builder.finish()?; + tracing::debug!(request_len = buf.len(), "sending netlink request"); + socket.send(&buf, 0)?; + + Ok(socket) +} + +fn send_netlink_req_and_wait_ack(builder: MessageBuilder) -> Result<(), Error> { + let socket = send_netlink_req(builder)?; + loop { + let (response, _) = socket.recv_from_full()?; + for frame in MessageIter::new(&response) { + let (header, payload) = frame?; + if header.message_type == NLMSG_ERROR { + return match netlink_error_code(payload)? { + 0 => Ok(()), + errno => Err(std::io::Error::from_raw_os_error(errno.abs()).into()), + }; + } + if header.message_type == NLMSG_DONE { + return Ok(()); + } + } + } +} + +fn message_request( + message_type: u16, + flags: u16, + message: &T, +) -> Result { + let mut builder = MessageBuilder::new(message_type, flags); + let mut message_bytes = Vec::new(); + message.write_to(&mut message_bytes)?; + builder.append_bytes(&message_bytes); + Ok(builder) +} + +fn receive_netlink_dump(builder: MessageBuilder) -> Result, Error> { + let socket = send_netlink_req(builder)?; + let mut messages = Vec::new(); + + loop { + let (response, _) = socket.recv_from_full()?; + for frame in MessageIter::new(&response) { + let (header, payload) = frame?; + if header.flags & NLM_F_DUMP_INTR != 0 { + return Err(std::io::Error::new( + std::io::ErrorKind::Interrupted, + "netlink dump was interrupted", + ) + .into()); + } + if header.message_type == NLMSG_DONE { + return Ok(messages); + } + if header.message_type == NLMSG_ERROR { + let error = netlink_error_code(payload)?; + if error == 0 { + continue; + } + return Err(std::io::Error::from_raw_os_error(error.abs()).into()); + } + if header.message_type == T::MESSAGE_TYPE { + messages.push(T::from_bytes(payload)?); + } + } + } +} + +fn dump_netlink_messages( + message_type: u16, + dump_header: &[u8], +) -> Result, Error> { + let mut builder = MessageBuilder::new(message_type, NLM_F_REQUEST | NLM_F_DUMP); + builder.append_bytes(dump_header); + receive_netlink_dump(builder) +} + +pub struct NetlinkIfConfiger {} + +impl NetlinkIfConfiger { + pub(crate) fn get_interface_index(name: &str) -> Result { + let name = CString::new(name).with_context(|| "failed to convert interface name")?; + match unsafe { libc::if_nametoindex(name.as_ptr()) } { + 0 => Err(std::io::Error::last_os_error().into()), + n => Ok(n), + } + } + + fn get_prefix_len(name: &str, ip: Ipv4Addr) -> Result { + let addrs = Self::list_addresses(name)?; + for addr in addrs { + if addr.address() == IpAddr::V4(ip) { + return Ok(addr.network_length()); + } + } + Err(Error::NotFound) + } + + fn remove_one_ip(name: &str, ip: Ipv4Addr, prefix_len: u8) -> Result<(), Error> { + let message = AddressMessage::new( + libc::AF_INET as u8, + Self::get_interface_index(name)?, + prefix_len, + IpAddr::V4(ip), + ); + let request = message_request(RTM_DELADDR, NLM_F_ACK | NLM_F_REQUEST, &message)?; + send_netlink_req_and_wait_ack(request) + } + + fn get_prefix_len_ipv6(name: &str, ip: Ipv6Addr) -> Result { + let addrs = Self::list_addresses(name)?; + for addr in addrs { + if addr.address() == IpAddr::V6(ip) { + return Ok(addr.network_length()); + } + } + Err(Error::NotFound) + } + + fn remove_one_ipv6(name: &str, ip: Ipv6Addr, prefix_len: u8) -> Result<(), Error> { + let message = AddressMessage::new( + libc::AF_INET6 as u8, + Self::get_interface_index(name)?, + prefix_len, + IpAddr::V6(ip), + ); + let request = message_request(RTM_DELADDR, NLM_F_ACK | NLM_F_REQUEST, &message)?; + send_netlink_req_and_wait_ack(request) + } + + pub(crate) fn mtu_op>( + name: &str, + op: T, + value: libc::c_int, + ) -> Result + where + >::Error: Debug, + { + let dummy_socket = dummy_socket()?; + + let mut ifr: ifreq = build_ifreq(name); + + unsafe { + ifr.ifr_ifru.ifru_mtu = value; + + // 使用ioctl获取MTU + if ioctl(dummy_socket.as_raw_fd(), op.try_into().unwrap(), &ifr) != 0 { + return Err(std::io::Error::last_os_error().into()); + } + } + + Ok(unsafe { ifr.ifr_ifru.ifru_mtu as u32 }) + } + + #[cfg(test)] + fn mtu(name: &str) -> Result { + Self::mtu_op(name, SIOCGIFMTU, 0) + } + + pub fn list_addresses(name: &str) -> Result, Error> { + let mut result = vec![]; + + for interface in getifaddrs() + .with_context(|| "failed to call getifaddrs")? + .filter(|x| x.interface_name == name) + { + let (Some(address), Some(netmask)) = (interface.address, interface.netmask) else { + continue; + }; + + use nix::sys::socket::AddressFamily::{Inet, Inet6}; + + let (address, netmask) = match (address.family(), netmask.family()) { + (Some(Inet), Some(Inet)) => ( + IpAddr::V4(address.as_sockaddr_in().unwrap().ip()), + IpAddr::V4(netmask.as_sockaddr_in().unwrap().ip()), + ), + (Some(Inet6), Some(Inet6)) => ( + IpAddr::V6(address.as_sockaddr_in6().unwrap().ip()), + IpAddr::V6(netmask.as_sockaddr_in6().unwrap().ip()), + ), + (_, _) => continue, + }; + + let prefix = ip_mask_to_prefix(netmask).unwrap(); + + result.push(IpInet::new(address, prefix).unwrap()); + } + Ok(result) + } + + pub(crate) fn set_flags_op>( + name: &str, + op: T, + flags: InterfaceFlags, + ) -> Result + where + >::Error: Debug, + { + let mut req = build_ifreq(name); + req.ifr_ifru.ifru_flags = flags.bits() as _; + + let socket = dummy_socket()?; + + unsafe { + if ioctl(socket.as_raw_fd(), op.try_into().unwrap(), &req) != 0 { + return Err(std::io::Error::last_os_error().into()); + } + Ok(InterfaceFlags::from_bits_truncate( + req.ifr_ifru.ifru_flags as _, + )) + } + } + + pub(crate) fn set_flags(name: &str, flags: InterfaceFlags) -> Result { + Self::set_flags_op(name, SIOCSIFFLAGS, flags) + } + + pub(crate) fn get_flags(name: &str) -> Result { + Self::set_flags_op(name, SIOCGIFFLAGS, InterfaceFlags::empty()) + } + + fn list_route_messages(address_family: u8) -> Result, Error> { + Ok( + dump_netlink_messages::(RTM_GETROUTE, &RouteMessage::dump_header())? + .into_iter() + .filter(|message| message.family() == address_family) + .collect(), + ) + } + + fn list_routes() -> Result, Error> { + Self::list_route_messages(libc::AF_INET as u8) + } + + pub(crate) fn list_ipv6_route_messages() -> Result, Error> { + Self::list_route_messages(libc::AF_INET6 as u8) + } + + fn ipv6_ndp_proxy_message(name: &str, address: Ipv6Addr) -> Result { + Ok(NeighborMessage::proxy( + Self::get_interface_index(name)?, + address, + )) + } + + pub(crate) fn add_ipv6_ndp_proxy(name: &str, address: Ipv6Addr) -> Result<(), Error> { + let message = Self::ipv6_ndp_proxy_message(name, address)?; + let request = message_request( + RTM_NEWNEIGH, + NLM_F_ACK | NLM_F_CREATE | NLM_F_EXCL | NLM_F_REQUEST, + &message, + )?; + send_netlink_req_and_wait_ack(request) + } + + pub(crate) fn remove_ipv6_ndp_proxy(name: &str, address: Ipv6Addr) -> Result<(), Error> { + let message = Self::ipv6_ndp_proxy_message(name, address)?; + let request = message_request(RTM_DELNEIGH, NLM_F_ACK | NLM_F_REQUEST, &message)?; + send_netlink_req_and_wait_ack(request) + } + + fn list_neighbour_messages(address_family: u8) -> Result, Error> { + let mut builder = MessageBuilder::new(RTM_GETNEIGH, NLM_F_REQUEST | NLM_F_DUMP); + builder.append_bytes(&NeighborMessage::proxy_dump_header(address_family)); + receive_netlink_dump(builder) + } + + pub(crate) fn list_ipv6_ndp_proxy(name: &str) -> Result, Error> { + let ifindex = Self::get_interface_index(name)?; + Ok(Self::list_neighbour_messages(libc::AF_INET6 as u8)? + .into_iter() + .filter(|message| message.ifindex() == ifindex && message.is_proxy()) + .filter_map(|message| match message.destination() { + Some(IpAddr::V6(address)) => Some(*address), + _ => None, + }) + .collect()) + } +} + +#[async_trait] +impl IfConfiguerTrait for NetlinkIfConfiger { + async fn add_ipv4_route( + &self, + name: &str, + address: Ipv4Addr, + cidr_prefix: u8, + cost: Option, + ) -> Result<(), Error> { + let message = RouteMessageBuilder::new(libc::AF_INET as u8) + .destination(IpAddr::V4(address), cidr_prefix) + .oif(Self::get_interface_index(name)?) + .priority(cost.unwrap_or(65535) as u32) + .table(libc::RT_TABLE_MAIN.into()) + .static_protocol() + .universe_scope() + .route_type(RouteType::Unicast) + .build(); + let request = message_request( + RTM_NEWROUTE, + NLM_F_ACK | NLM_F_CREATE | NLM_F_EXCL | NLM_F_REQUEST, + &message, + )?; + send_netlink_req_and_wait_ack(request) + } + + async fn remove_ipv4_route( + &self, + name: &str, + address: Ipv4Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + let routes = Self::list_routes()?; + let ifidx = NetlinkIfConfiger::get_interface_index(name)?; + + for msg in routes { + let destination = msg + .destination() + .copied() + .unwrap_or(IpAddr::V4(Ipv4Addr::UNSPECIFIED)); + if destination == IpAddr::V4(address) + && msg.dst_len() == cidr_prefix + && msg.oif() == Some(ifidx) + { + let request = message_request(RTM_DELROUTE, NLM_F_ACK | NLM_F_REQUEST, &msg)?; + send_netlink_req_and_wait_ack(request)?; + return Ok(()); + } + } + + Ok(()) + } + + async fn add_ipv4_ip( + &self, + name: &str, + address: Ipv4Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + let broadcast = if cidr_prefix == 32 { + address + } else { + let ip_addr = u32::from(address); + Ipv4Addr::from((0xffff_ffff_u32) >> u32::from(cidr_prefix) | ip_addr) + }; + let message = AddressMessage::new( + libc::AF_INET as u8, + Self::get_interface_index(name)?, + cidr_prefix, + IpAddr::V4(address), + ) + .local(IpAddr::V4(address)) + .broadcast(broadcast); + let request = message_request( + RTM_NEWADDR, + NLM_F_ACK | NLM_F_CREATE | NLM_F_EXCL | NLM_F_REQUEST, + &message, + )?; + send_netlink_req_and_wait_ack(request) + } + + async fn set_link_status(&self, name: &str, up: bool) -> Result<(), Error> { + let mut flags = Self::get_flags(name)?; + flags.set(InterfaceFlags::IFF_UP, up); + Self::set_flags(name, flags)?; + Ok(()) + } + + async fn remove_ip(&self, name: &str, ip: Option) -> Result<(), Error> { + if let Some(ip) = ip { + let prefix_len = Self::get_prefix_len(name, ip.address())?; + Self::remove_one_ip(name, ip.address(), prefix_len)?; + } else { + let addrs = Self::list_addresses(name)?; + for addr in addrs { + if let IpAddr::V4(ipv4) = addr.address() { + Self::remove_one_ip(name, ipv4, addr.network_length())?; + } + } + } + + Ok(()) + } + + async fn set_mtu(&self, name: &str, mtu: u32) -> Result<(), Error> { + Self::mtu_op(name, SIOCSIFMTU, mtu as libc::c_int)?; + + Ok(()) + } + + async fn add_ipv6_ip( + &self, + name: &str, + address: std::net::Ipv6Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + let message = AddressMessage::new( + libc::AF_INET6 as u8, + Self::get_interface_index(name)?, + cidr_prefix, + IpAddr::V6(address), + ); + let request = message_request( + RTM_NEWADDR, + NLM_F_ACK | NLM_F_CREATE | NLM_F_EXCL | NLM_F_REQUEST, + &message, + )?; + send_netlink_req_and_wait_ack(request) + } + + async fn remove_ipv6(&self, name: &str, ip: Option) -> Result<(), Error> { + if let Some(ipv6) = ip { + let prefix_len = Self::get_prefix_len_ipv6(name, ipv6.address())?; + Self::remove_one_ipv6(name, ipv6.address(), prefix_len)?; + } else { + let addrs = Self::list_addresses(name)?; + for addr in addrs { + if let IpAddr::V6(ipv6) = addr.address() { + let prefix_len = addr.network_length(); + Self::remove_one_ipv6(name, ipv6, prefix_len)?; + } + } + } + + Ok(()) + } + + async fn add_ipv6_route( + &self, + name: &str, + address: std::net::Ipv6Addr, + cidr_prefix: u8, + cost: Option, + ) -> Result<(), Error> { + let mut builder = RouteMessageBuilder::new(libc::AF_INET6 as u8) + .oif(Self::get_interface_index(name)?) + .priority(cost.unwrap_or(65535) as u32) + .table(libc::RT_TABLE_MAIN.into()) + .static_protocol() + .universe_scope() + .route_type(RouteType::Unicast); + if cidr_prefix != 0 { + builder = builder.destination(IpAddr::V6(address), cidr_prefix); + } + let message = builder.build(); + let request = message_request( + RTM_NEWROUTE, + NLM_F_ACK | NLM_F_CREATE | NLM_F_EXCL | NLM_F_REQUEST, + &message, + )?; + send_netlink_req_and_wait_ack(request) + } + + async fn remove_ipv6_route( + &self, + name: &str, + address: std::net::Ipv6Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + let routes = Self::list_route_messages(libc::AF_INET6 as u8)?; + let ifidx = NetlinkIfConfiger::get_interface_index(name)?; + + for msg in routes { + let destination = msg + .destination() + .copied() + .unwrap_or(IpAddr::V6(Ipv6Addr::UNSPECIFIED)); + if destination == IpAddr::V6(address) + && msg.dst_len() == cidr_prefix + && msg.oif() == Some(ifidx) + { + let request = message_request(RTM_DELROUTE, NLM_F_ACK | NLM_F_REQUEST, &msg)?; + send_netlink_req_and_wait_ack(request)?; + return Ok(()); + } + } + + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::process::Command; + + const DUMMY_IFACE_NAME: &str = "dummy"; + + fn run_cmd(cmd: &str) -> String { + let output = Command::new("sh") + .arg("-c") + .arg(cmd) + .output() + .expect("failed to execute process"); + assert!( + output.status.success(), + "command failed: {cmd}\nstdout: {}\nstderr: {}", + String::from_utf8_lossy(&output.stdout), + String::from_utf8_lossy(&output.stderr), + ); + String::from_utf8(output.stdout).unwrap() + } + + fn run_ip(args: &[&str]) { + let output = Command::new("ip") + .args(args) + .output() + .expect("failed to execute ip process"); + assert!( + output.status.success(), + "ip command failed: {:?}\nstdout: {}\nstderr: {}", + args, + String::from_utf8_lossy(&output.stdout), + String::from_utf8_lossy(&output.stderr), + ); + } + + fn test_iface_name(tag: &str) -> String { + format!("et{}{:x}", tag, std::process::id() & 0xffff) + } + + struct ScopedDummyLink { + name: String, + } + + impl ScopedDummyLink { + fn new(name: &str) -> Self { + let _ = Command::new("ip").args(["link", "del", name]).output(); + run_ip(&["link", "add", name, "type", "dummy"]); + run_ip(&["link", "set", name, "up"]); + Self { + name: name.to_string(), + } + } + } + + impl Drop for ScopedDummyLink { + fn drop(&mut self) { + let _ = Command::new("ip") + .args(["link", "del", &self.name]) + .output(); + } + } + + struct PrepareEnv {} + impl PrepareEnv { + fn new() -> Self { + let _ = Command::new("ip") + .args(["link", "del", DUMMY_IFACE_NAME]) + .output(); + let _ = run_cmd(&format!("ip link add {} type dummy", DUMMY_IFACE_NAME)); + PrepareEnv {} + } + } + + impl Drop for PrepareEnv { + fn drop(&mut self) { + let _ = Command::new("ip") + .args(["link", "del", DUMMY_IFACE_NAME]) + .output(); + } + } + + #[serial_test::serial] + #[tokio::test] + async fn addr_test() { + let _prepare_env = PrepareEnv::new(); + let ifcfg = NetlinkIfConfiger {}; + tokio::time::sleep(std::time::Duration::from_secs(1)).await; + ifcfg + .add_ipv4_ip(DUMMY_IFACE_NAME, "10.44.44.4".parse().unwrap(), 24) + .await + .unwrap(); + + let addrs = NetlinkIfConfiger::list_addresses(DUMMY_IFACE_NAME).unwrap(); + assert_eq!(addrs.len(), 1); + assert_eq!( + addrs[0].address(), + IpAddr::V4("10.44.44.4".parse().unwrap()) + ); + assert_eq!(addrs[0].network_length(), 24); + + NetlinkIfConfiger::remove_one_ip(DUMMY_IFACE_NAME, "10.44.44.4".parse().unwrap(), 24) + .unwrap(); + + let addrs = NetlinkIfConfiger::list_addresses(DUMMY_IFACE_NAME).unwrap(); + assert_eq!(addrs.len(), 0); + + let old_mtu = NetlinkIfConfiger::mtu(DUMMY_IFACE_NAME).unwrap(); + assert_ne!(old_mtu, 0); + + let new_mtu = old_mtu + 1; + ifcfg.set_mtu(DUMMY_IFACE_NAME, new_mtu).await.unwrap(); + + let mtu = NetlinkIfConfiger::mtu(DUMMY_IFACE_NAME).unwrap(); + assert_eq!(mtu, new_mtu); + + ifcfg + .set_link_status(DUMMY_IFACE_NAME, false) + .await + .unwrap(); + ifcfg.set_link_status(DUMMY_IFACE_NAME, true).await.unwrap(); + } + + #[serial_test::serial] + #[tokio::test] + async fn route_test() { + let _prepare_env = PrepareEnv::new(); + let ret = NetlinkIfConfiger::list_routes().unwrap(); + + let ifcfg = NetlinkIfConfiger {}; + println!("{:?}", ret); + + ifcfg.set_link_status(DUMMY_IFACE_NAME, true).await.unwrap(); + + ifcfg + .add_ipv4_route(DUMMY_IFACE_NAME, "10.5.5.0".parse().unwrap(), 24, None) + .await + .unwrap(); + + let routes = NetlinkIfConfiger::list_routes() + .unwrap() + .into_iter() + .filter_map(|route| route.destination().copied()) + .collect::>(); + assert!(routes.contains(&IpAddr::V4("10.5.5.0".parse().unwrap()))); + + ifcfg + .remove_ipv4_route(DUMMY_IFACE_NAME, "10.5.5.0".parse().unwrap(), 24) + .await + .unwrap(); + let routes = NetlinkIfConfiger::list_routes() + .unwrap() + .into_iter() + .filter_map(|route| route.destination().copied()) + .collect::>(); + assert!(!routes.contains(&IpAddr::V4("10.5.5.0".parse().unwrap()))); + } + + #[serial_test::serial] + #[tokio::test] + async fn ipv6_addr_readback_test() { + let iface = test_iface_name("a"); + let _link = ScopedDummyLink::new(&iface); + run_ip(&["-6", "addr", "add", "2001:db8:1234::2/64", "dev", &iface]); + + let addrs = NetlinkIfConfiger::list_addresses(&iface).unwrap(); + assert!(addrs.iter().any(|addr| { + addr.address() == IpAddr::V6("2001:db8:1234::2".parse().unwrap()) + && addr.network_length() == 64 + })); + } + + #[serial_test::serial] + #[tokio::test] + async fn ipv6_route_readback_test() { + let wan_if = test_iface_name("rw"); + let lan_if = test_iface_name("rl"); + let _wan = ScopedDummyLink::new(&wan_if); + let _lan = ScopedDummyLink::new(&lan_if); + run_ip(&[ + "-6", + "addr", + "add", + "2001:db8:100:ffff::2/64", + "dev", + &wan_if, + ]); + run_ip(&[ + "-6", + "route", + "add", + "default", + "from", + "2001:db8:100::/56", + "dev", + &wan_if, + ]); + run_ip(&["-6", "route", "add", "2001:db8:100::/56", "dev", &lan_if]); + + let wan_ifindex = NetlinkIfConfiger::get_interface_index(&wan_if).unwrap(); + let lan_ifindex = NetlinkIfConfiger::get_interface_index(&lan_if).unwrap(); + let routes = NetlinkIfConfiger::list_ipv6_route_messages().unwrap(); + + assert!(routes.iter().any(|route| { + route.route_type() == RouteType::Unicast + && route.src_len() == 56 + && route.source() + == Some(&IpAddr::V6( + "2001:db8:100::".parse::().unwrap(), + )) + && route.oif() == Some(wan_ifindex) + && route.destination().is_none() + })); + + assert!(routes.iter().any(|route| { + route.route_type() == RouteType::Unicast + && route.dst_len() == 56 + && route.destination() + == Some(&IpAddr::V6( + "2001:db8:100::".parse::().unwrap(), + )) + && route.oif() == Some(lan_ifindex) + })); + } + + #[serial_test::serial] + #[tokio::test] + async fn ipv6_route_remove_test() { + let iface = test_iface_name("rr"); + let _link = ScopedDummyLink::new(&iface); + let ifcfg = NetlinkIfConfiger {}; + let route_addr = "2001:db8:200::".parse::().unwrap(); + + ifcfg + .add_ipv6_route(&iface, route_addr, 56, None) + .await + .unwrap(); + + let ifindex = NetlinkIfConfiger::get_interface_index(&iface).unwrap(); + let has_route = |routes: &[RouteMessage]| { + routes.iter().any(|route| { + route.dst_len() == 56 + && route.destination() == Some(&IpAddr::V6(route_addr)) + && route.oif() == Some(ifindex) + }) + }; + + let routes = NetlinkIfConfiger::list_ipv6_route_messages().unwrap(); + assert!(has_route(&routes)); + + ifcfg + .remove_ipv6_route(&iface, route_addr, 56) + .await + .unwrap(); + + let routes = NetlinkIfConfiger::list_ipv6_route_messages().unwrap(); + assert!(!has_route(&routes)); + } +} diff --git a/vendor/easytier/easytier/src/common/ifcfg/netlink_wire.rs b/vendor/easytier/easytier/src/common/ifcfg/netlink_wire.rs new file mode 100644 index 0000000..6bd9292 --- /dev/null +++ b/vendor/easytier/easytier/src/common/ifcfg/netlink_wire.rs @@ -0,0 +1,682 @@ +use std::{ + io, + net::{IpAddr, Ipv4Addr, Ipv6Addr}, +}; + +use nix::libc; + +// Minimal Linux rtnetlink wire support used by ifcfg. Fixed headers and integer +// attributes use native byte order; IP address attributes contain network-order octets. +pub(crate) const NLM_F_REQUEST: u16 = 0x01; +pub(crate) const NLM_F_ACK: u16 = 0x04; +pub(crate) const NLM_F_DUMP_INTR: u16 = 0x10; +pub(crate) const NLM_F_DUMP: u16 = 0x300; +pub(crate) const NLM_F_EXCL: u16 = 0x200; +pub(crate) const NLM_F_CREATE: u16 = 0x400; + +pub(crate) const NLMSG_ERROR: u16 = 2; +pub(crate) const NLMSG_DONE: u16 = 3; +pub(crate) const RTM_NEWADDR: u16 = 20; +pub(crate) const RTM_DELADDR: u16 = 21; +pub(crate) const RTM_NEWROUTE: u16 = 24; +pub(crate) const RTM_DELROUTE: u16 = 25; +pub(crate) const RTM_GETROUTE: u16 = 26; +pub(crate) const RTM_NEWNEIGH: u16 = 28; +pub(crate) const RTM_DELNEIGH: u16 = 29; +pub(crate) const RTM_GETNEIGH: u16 = 30; + +const NLMSG_HEADER_LEN: usize = 16; +const ATTRIBUTE_HEADER_LEN: usize = 4; +const NLA_TYPE_MASK: u16 = 0x3fff; + +const IFA_ADDRESS: u16 = 1; +const IFA_LOCAL: u16 = 2; +const IFA_BROADCAST: u16 = 4; + +const RTA_DST: u16 = 1; +const RTA_SRC: u16 = 2; +const RTA_OIF: u16 = 4; +const RTA_PRIORITY: u16 = 6; +const RTA_TABLE: u16 = 15; + +const NDA_DST: u16 = 1; +const NTF_PROXY: u8 = 0x08; +const NUD_PERMANENT: u16 = 0x80; + +fn align4(len: usize) -> Option { + len.checked_add(3).map(|len| len & !3) +} + +fn invalid_data(message: &'static str) -> io::Error { + io::Error::new(io::ErrorKind::InvalidData, message) +} + +fn read_u16(bytes: &[u8]) -> io::Result { + bytes + .get(..2) + .and_then(|bytes| bytes.try_into().ok()) + .map(u16::from_ne_bytes) + .ok_or_else(|| invalid_data("truncated netlink u16")) +} + +fn read_u32(bytes: &[u8]) -> io::Result { + bytes + .get(..4) + .and_then(|bytes| bytes.try_into().ok()) + .map(u32::from_ne_bytes) + .ok_or_else(|| invalid_data("truncated netlink u32")) +} + +fn read_i32(bytes: &[u8]) -> io::Result { + bytes + .get(..4) + .and_then(|bytes| bytes.try_into().ok()) + .map(i32::from_ne_bytes) + .ok_or_else(|| invalid_data("truncated netlink i32")) +} + +#[derive(Debug)] +pub(crate) struct MessageBuilder { + bytes: Vec, +} + +impl MessageBuilder { + pub(crate) fn new(message_type: u16, flags: u16) -> Self { + let mut bytes = Vec::with_capacity(64); + bytes.extend_from_slice(&0_u32.to_ne_bytes()); + bytes.extend_from_slice(&message_type.to_ne_bytes()); + bytes.extend_from_slice(&flags.to_ne_bytes()); + bytes.extend_from_slice(&0_u32.to_ne_bytes()); + bytes.extend_from_slice(&0_u32.to_ne_bytes()); + Self { bytes } + } + + pub(crate) fn append_bytes(&mut self, bytes: &[u8]) { + self.bytes.extend_from_slice(bytes); + } + + pub(crate) fn finish(mut self) -> io::Result> { + let len = u32::try_from(self.bytes.len()) + .map_err(|_| invalid_data("netlink message is too large"))?; + self.bytes[..4].copy_from_slice(&len.to_ne_bytes()); + Ok(self.bytes) + } +} + +#[derive(Clone, Copy, Debug)] +pub(crate) struct MessageHeader { + pub(crate) message_type: u16, + pub(crate) flags: u16, +} + +pub(crate) struct MessageIter<'a> { + bytes: &'a [u8], +} + +impl<'a> MessageIter<'a> { + pub(crate) fn new(bytes: &'a [u8]) -> Self { + Self { bytes } + } +} + +impl<'a> Iterator for MessageIter<'a> { + type Item = io::Result<(MessageHeader, &'a [u8])>; + + fn next(&mut self) -> Option { + if self.bytes.is_empty() { + return None; + } + if self.bytes.len() < NLMSG_HEADER_LEN { + self.bytes = &[]; + return Some(Err(invalid_data("truncated netlink header"))); + } + + let len = match read_u32(self.bytes) { + Ok(len) => len as usize, + Err(err) => { + self.bytes = &[]; + return Some(Err(err)); + } + }; + if len < NLMSG_HEADER_LEN || len > self.bytes.len() { + self.bytes = &[]; + return Some(Err(invalid_data("invalid netlink message length"))); + } + let aligned_len = match align4(len) { + Some(len) => len, + None => { + self.bytes = &[]; + return Some(Err(invalid_data("netlink message length overflow"))); + } + }; + if aligned_len > self.bytes.len() { + self.bytes = &[]; + return Some(Err(invalid_data("truncated netlink message padding"))); + } + + let message_type = read_u16(&self.bytes[4..]).expect("header length checked"); + let flags = read_u16(&self.bytes[6..]).expect("header length checked"); + let payload = &self.bytes[NLMSG_HEADER_LEN..len]; + self.bytes = &self.bytes[aligned_len..]; + Some(Ok(( + MessageHeader { + message_type, + flags, + }, + payload, + ))) + } +} + +pub(crate) fn netlink_error_code(payload: &[u8]) -> io::Result { + read_i32(payload) +} + +#[derive(Clone, Debug)] +struct Attribute { + kind: u16, + value: Vec, +} + +impl Attribute { + fn new(kind: u16, value: impl Into>) -> Self { + Self { + kind, + value: value.into(), + } + } + + fn write_to(&self, bytes: &mut Vec) -> io::Result<()> { + let len = ATTRIBUTE_HEADER_LEN + .checked_add(self.value.len()) + .ok_or_else(|| invalid_data("netlink attribute length overflow"))?; + let len = u16::try_from(len).map_err(|_| invalid_data("netlink attribute is too large"))?; + bytes.extend_from_slice(&len.to_ne_bytes()); + bytes.extend_from_slice(&self.kind.to_ne_bytes()); + bytes.extend_from_slice(&self.value); + let aligned_len = align4(bytes.len()) + .ok_or_else(|| invalid_data("netlink attribute alignment overflow"))?; + bytes.resize(aligned_len, 0); + Ok(()) + } +} + +fn parse_attributes(mut bytes: &[u8]) -> io::Result> { + let mut attributes = Vec::new(); + while !bytes.is_empty() { + if bytes.len() < ATTRIBUTE_HEADER_LEN { + return Err(invalid_data("truncated netlink attribute header")); + } + let len = read_u16(bytes)? as usize; + if len < ATTRIBUTE_HEADER_LEN || len > bytes.len() { + return Err(invalid_data("invalid netlink attribute length")); + } + let kind = read_u16(&bytes[2..])?; + attributes.push(Attribute::new( + kind, + bytes[ATTRIBUTE_HEADER_LEN..len].to_vec(), + )); + + let aligned_len = + align4(len).ok_or_else(|| invalid_data("netlink attribute length overflow"))?; + if aligned_len > bytes.len() { + return Err(invalid_data("truncated netlink attribute padding")); + } + bytes = &bytes[aligned_len..]; + } + Ok(attributes) +} + +fn write_attributes(attributes: &[Attribute], bytes: &mut Vec) -> io::Result<()> { + for attribute in attributes { + attribute.write_to(bytes)?; + } + Ok(()) +} + +fn ip_bytes(address: IpAddr) -> Vec { + match address { + IpAddr::V4(address) => address.octets().to_vec(), + IpAddr::V6(address) => address.octets().to_vec(), + } +} + +fn parse_ip(family: u8, bytes: &[u8]) -> Option { + match family as i32 { + libc::AF_INET if bytes.len() == 4 => Some(IpAddr::V4(Ipv4Addr::new( + bytes[0], bytes[1], bytes[2], bytes[3], + ))), + libc::AF_INET6 if bytes.len() == 16 => Some(IpAddr::V6(Ipv6Addr::from( + <[u8; 16]>::try_from(bytes).ok()?, + ))), + _ => None, + } +} + +pub(crate) trait NetlinkEncode { + fn write_to(&self, bytes: &mut Vec) -> io::Result<()>; +} + +pub(crate) trait NetlinkDecode: Sized { + const MESSAGE_TYPE: u16; + + fn from_bytes(bytes: &[u8]) -> io::Result; +} + +#[derive(Clone, Debug)] +pub(crate) struct AddressMessage { + family: u8, + prefix_len: u8, + ifindex: u32, + attributes: Vec, +} + +impl AddressMessage { + pub(crate) fn new(family: u8, ifindex: u32, prefix_len: u8, address: IpAddr) -> Self { + Self { + family, + prefix_len, + ifindex, + attributes: vec![Attribute::new(IFA_ADDRESS, ip_bytes(address))], + } + } + + pub(crate) fn local(mut self, address: IpAddr) -> Self { + self.attributes + .push(Attribute::new(IFA_LOCAL, ip_bytes(address))); + self + } + + pub(crate) fn broadcast(mut self, address: Ipv4Addr) -> Self { + self.attributes + .push(Attribute::new(IFA_BROADCAST, address.octets().to_vec())); + self + } +} + +impl NetlinkEncode for AddressMessage { + fn write_to(&self, bytes: &mut Vec) -> io::Result<()> { + bytes.extend_from_slice(&[self.family, self.prefix_len, 0, 0]); + bytes.extend_from_slice(&self.ifindex.to_ne_bytes()); + write_attributes(&self.attributes, bytes) + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub(crate) enum RouteType { + Unicast, + Blackhole, + Other(u8), +} + +impl RouteType { + fn from_raw(value: u8) -> Self { + match value { + 1 => Self::Unicast, + 6 => Self::Blackhole, + value => Self::Other(value), + } + } + + fn raw(self) -> u8 { + match self { + Self::Unicast => 1, + Self::Blackhole => 6, + Self::Other(value) => value, + } + } +} + +#[derive(Clone, Debug)] +pub(crate) struct RouteMessage { + family: u8, + dst_len: u8, + src_len: u8, + tos: u8, + table: u8, + protocol: u8, + scope: u8, + route_type: u8, + flags: u32, + attributes: Vec, + destination: Option, + source: Option, + oif: Option, +} + +impl RouteMessage { + pub(crate) fn family(&self) -> u8 { + self.family + } + + pub(crate) fn dst_len(&self) -> u8 { + self.dst_len + } + + pub(crate) fn src_len(&self) -> u8 { + self.src_len + } + + pub(crate) fn route_type(&self) -> RouteType { + RouteType::from_raw(self.route_type) + } + + pub(crate) fn destination(&self) -> Option<&IpAddr> { + self.destination.as_ref() + } + + pub(crate) fn source(&self) -> Option<&IpAddr> { + self.source.as_ref() + } + + pub(crate) fn oif(&self) -> Option { + self.oif + } +} + +impl RouteMessage { + pub(crate) fn dump_header() -> Vec { + vec![0; 12] + } +} + +impl NetlinkDecode for RouteMessage { + const MESSAGE_TYPE: u16 = RTM_NEWROUTE; + + fn from_bytes(bytes: &[u8]) -> io::Result { + if bytes.len() < 12 { + return Err(invalid_data("truncated route message")); + } + let family = bytes[0]; + let attributes = parse_attributes(&bytes[12..])?; + let destination = attributes + .iter() + .find(|attribute| attribute.kind & NLA_TYPE_MASK == RTA_DST) + .and_then(|attribute| parse_ip(family, &attribute.value)); + let source = attributes + .iter() + .find(|attribute| attribute.kind & NLA_TYPE_MASK == RTA_SRC) + .and_then(|attribute| parse_ip(family, &attribute.value)); + let oif = attributes + .iter() + .find(|attribute| attribute.kind & NLA_TYPE_MASK == RTA_OIF) + .and_then(|attribute| read_u32(&attribute.value).ok()); + + Ok(Self { + family, + dst_len: bytes[1], + src_len: bytes[2], + tos: bytes[3], + table: bytes[4], + protocol: bytes[5], + scope: bytes[6], + route_type: bytes[7], + flags: read_u32(&bytes[8..])?, + attributes, + destination, + source, + oif, + }) + } +} + +impl NetlinkEncode for RouteMessage { + fn write_to(&self, bytes: &mut Vec) -> io::Result<()> { + bytes.extend_from_slice(&[ + self.family, + self.dst_len, + self.src_len, + self.tos, + self.table, + self.protocol, + self.scope, + self.route_type, + ]); + bytes.extend_from_slice(&self.flags.to_ne_bytes()); + write_attributes(&self.attributes, bytes) + } +} + +#[derive(Debug)] +pub(crate) struct RouteMessageBuilder { + message: RouteMessage, +} + +impl RouteMessageBuilder { + pub(crate) fn new(family: u8) -> Self { + Self { + message: RouteMessage { + family, + dst_len: 0, + src_len: 0, + tos: 0, + table: 0, + protocol: 0, + scope: 0, + route_type: 0, + flags: 0, + attributes: Vec::new(), + destination: None, + source: None, + oif: None, + }, + } + } + + pub(crate) fn destination(mut self, address: IpAddr, prefix_len: u8) -> Self { + self.message.dst_len = prefix_len; + self.message.destination = Some(address); + self.message + .attributes + .push(Attribute::new(RTA_DST, ip_bytes(address))); + self + } + + pub(crate) fn oif(mut self, ifindex: u32) -> Self { + self.message.oif = Some(ifindex); + self.message + .attributes + .push(Attribute::new(RTA_OIF, ifindex.to_ne_bytes().to_vec())); + self + } + + pub(crate) fn priority(mut self, priority: u32) -> Self { + self.message.attributes.push(Attribute::new( + RTA_PRIORITY, + priority.to_ne_bytes().to_vec(), + )); + self + } + + pub(crate) fn table(mut self, table: u32) -> Self { + if let Ok(table) = u8::try_from(table) { + self.message.table = table; + } else { + self.message + .attributes + .push(Attribute::new(RTA_TABLE, table.to_ne_bytes().to_vec())); + } + self + } + + pub(crate) fn static_protocol(mut self) -> Self { + self.message.protocol = libc::RTPROT_STATIC; + self + } + + pub(crate) fn universe_scope(mut self) -> Self { + self.message.scope = libc::RT_SCOPE_UNIVERSE; + self + } + + pub(crate) fn route_type(mut self, route_type: RouteType) -> Self { + self.message.route_type = route_type.raw(); + self + } + + pub(crate) fn build(self) -> RouteMessage { + self.message + } +} + +#[derive(Clone, Debug)] +pub(crate) struct NeighborMessage { + family: u8, + ifindex: u32, + state: u16, + flags: u8, + kind: u8, + attributes: Vec, + destination: Option, +} + +impl NeighborMessage { + pub(crate) fn proxy(ifindex: u32, address: Ipv6Addr) -> Self { + Self { + family: libc::AF_INET6 as u8, + ifindex, + state: NUD_PERMANENT, + flags: NTF_PROXY, + kind: 0, + attributes: vec![Attribute::new(NDA_DST, address.octets().to_vec())], + destination: Some(IpAddr::V6(address)), + } + } + + pub(crate) fn proxy_dump_header(family: u8) -> Vec { + let mut bytes = vec![family, 0, 0, 0]; + bytes.extend_from_slice(&0_u32.to_ne_bytes()); + bytes.extend_from_slice(&0_u16.to_ne_bytes()); + bytes.extend_from_slice(&[NTF_PROXY, 0]); + bytes + } + + pub(crate) fn ifindex(&self) -> u32 { + self.ifindex + } + + pub(crate) fn is_proxy(&self) -> bool { + self.flags & NTF_PROXY != 0 + } + + pub(crate) fn destination(&self) -> Option<&IpAddr> { + self.destination.as_ref() + } +} + +impl NetlinkDecode for NeighborMessage { + const MESSAGE_TYPE: u16 = RTM_NEWNEIGH; + + fn from_bytes(bytes: &[u8]) -> io::Result { + if bytes.len() < 12 { + return Err(invalid_data("truncated neighbor message")); + } + let family = bytes[0]; + let attributes = parse_attributes(&bytes[12..])?; + let destination = attributes + .iter() + .find(|attribute| attribute.kind & NLA_TYPE_MASK == NDA_DST) + .and_then(|attribute| parse_ip(family, &attribute.value)); + Ok(Self { + family, + ifindex: read_u32(&bytes[4..])?, + state: read_u16(&bytes[8..])?, + flags: bytes[10], + kind: bytes[11], + attributes, + destination, + }) + } +} + +impl NetlinkEncode for NeighborMessage { + fn write_to(&self, bytes: &mut Vec) -> io::Result<()> { + bytes.extend_from_slice(&[self.family, 0, 0, 0]); + bytes.extend_from_slice(&self.ifindex.to_ne_bytes()); + bytes.extend_from_slice(&self.state.to_ne_bytes()); + bytes.extend_from_slice(&[self.flags, self.kind]); + write_attributes(&self.attributes, bytes) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn encode(message: &T) -> Vec { + let mut bytes = Vec::new(); + message.write_to(&mut bytes).unwrap(); + bytes + } + + #[test] + fn route_round_trip_preserves_unknown_attributes() { + let mut message = RouteMessageBuilder::new(libc::AF_INET6 as u8) + .destination("2001:db8::".parse().unwrap(), 64) + .oif(7) + .priority(42) + .table(libc::RT_TABLE_MAIN.into()) + .static_protocol() + .universe_scope() + .route_type(RouteType::Unicast) + .build(); + message + .attributes + .push(Attribute::new(0x4321, vec![1, 2, 3, 4, 5])); + + let bytes = encode(&message); + let decoded = RouteMessage::from_bytes(&bytes).unwrap(); + assert_eq!(decoded.destination(), message.destination()); + assert_eq!(decoded.oif(), Some(7)); + assert_eq!(decoded.route_type(), RouteType::Unicast); + assert_eq!(encode(&decoded), bytes); + } + + #[test] + fn route_parser_reads_ipv6_source_prefix() { + let mut bytes = vec![ + libc::AF_INET6 as u8, + 0, + 56, + 0, + libc::RT_TABLE_MAIN, + libc::RTPROT_STATIC, + libc::RT_SCOPE_UNIVERSE, + RouteType::Unicast.raw(), + ]; + bytes.extend_from_slice(&0_u32.to_ne_bytes()); + Attribute::new( + RTA_SRC, + "2001:db8:1::" + .parse::() + .unwrap() + .octets() + .to_vec(), + ) + .write_to(&mut bytes) + .unwrap(); + + let message = RouteMessage::from_bytes(&bytes).unwrap(); + assert_eq!(message.src_len(), 56); + assert_eq!(message.source(), Some(&"2001:db8:1::".parse().unwrap())); + } + + #[test] + fn neighbor_proxy_round_trip() { + let message = NeighborMessage::proxy(9, "2001:db8::1".parse().unwrap()); + let decoded = NeighborMessage::from_bytes(&encode(&message)).unwrap(); + assert_eq!(decoded.ifindex(), 9); + assert!(decoded.is_proxy()); + assert_eq!(decoded.destination(), message.destination()); + } + + #[test] + fn message_iterator_rejects_truncated_padding() { + let mut bytes = MessageBuilder::new(RTM_GETROUTE, NLM_F_REQUEST) + .finish() + .unwrap(); + bytes[0..4].copy_from_slice(&17_u32.to_ne_bytes()); + bytes.push(0); + assert!(MessageIter::new(&bytes).next().unwrap().is_err()); + } +} diff --git a/vendor/easytier/easytier/src/common/ifcfg/route.rs b/vendor/easytier/easytier/src/common/ifcfg/route.rs new file mode 100644 index 0000000..d3bd788 --- /dev/null +++ b/vendor/easytier/easytier/src/common/ifcfg/route.rs @@ -0,0 +1,46 @@ +use std::net::IpAddr; + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct Route { + /// Network address of the destination. `0.0.0.0` with a prefix of `0` is considered a default route. + pub destination: IpAddr, + + /// Length of network prefix in the destination address. + pub prefix: u8, + + /// The address of the next hop of this route. + /// + /// On macOS, this must be `Some` if ifindex is `None` + pub gateway: Option, + + /// The index of the local interface through which the next hop of this route may be reached. + /// + /// On macOS, this must be `Some` if gateway is `None` + pub ifindex: Option, + + #[cfg(target_os = "linux")] + /// The routing table this route belongs to. + pub table: u8, + + /// Network address of the source. + #[cfg(target_os = "linux")] + pub source: Option, + + /// Prefix length of the source address. + #[cfg(target_os = "linux")] + pub source_prefix: u8, + + /// Source address hint. Does not influence routing. + #[cfg(target_os = "linux")] + pub source_hint: Option, + + #[cfg(any(target_os = "windows", target_os = "linux"))] + /// The route metric offset value for this route. + pub metric: Option, + + #[cfg(target_os = "windows")] + /// Luid of the local interface through which the next hop of this route may be reached. + /// + /// If luid is specified, ifindex is optional. + pub luid: Option, +} diff --git a/vendor/easytier/easytier/src/common/ifcfg/win/luid.rs b/vendor/easytier/easytier/src/common/ifcfg/win/luid.rs new file mode 100644 index 0000000..d4832e2 --- /dev/null +++ b/vendor/easytier/easytier/src/common/ifcfg/win/luid.rs @@ -0,0 +1,365 @@ +// +// Port supporting code from wireguard-windows, as used by 3rd-party/wireguard-go, to Rust +// This file implements functionality similar to: wireguard-windows/tunnel/winipcfg/luid.go +// +// ATTENTION: NOT included are DNS() and SetDNS() - functions to query and set DNS servers for a network interface. +// + +use super::types::*; +use cidr::Ipv4Inet; +use cidr::Ipv6Inet; +use std::net::{Ipv4Addr, Ipv6Addr}; +use std::ptr; +use winapi::shared::{ifdef::NET_LUID, netioapi::*, nldef::*, winerror::*, ws2def::*}; + +pub struct InterfaceLuid { + luid: NET_LUID, +} + +impl InterfaceLuid { + /// luid_from_index function converts a local index for a network interface to the locally unique identifier (LUID) for the interface. + /// https://docs.microsoft.com/en-us/windows/desktop/api/netioapi/nf-netioapi-convertinterfaceindextoluid + pub fn luid_from_index(interface_index: u32) -> Result { + let mut interface_luid = NET_LUID::default(); + + let result = unsafe { ConvertInterfaceIndexToLuid(interface_index, &mut interface_luid) }; + + if NO_ERROR == result { + Ok(Self { + luid: interface_luid, + }) + } else { + Err(result) + } + } + + /// add_ipv4_address method adds new unicast IP address to the interface. Corresponds to CreateUnicastIpAddressEntry function + /// (https://docs.microsoft.com/en-us/windows/desktop/api/netioapi/nf-netioapi-createunicastipaddressentry). + pub fn add_ipv4_address(&self, address: &Ipv4Inet) -> Result<(), NETIO_STATUS> { + let mut row = MIB_UNICASTIPADDRESS_ROW::default(); + unsafe { InitializeUnicastIpAddressEntry(&mut row) }; + + row.InterfaceLuid = self.luid; + row.DadState = IpDadStatePreferred; + row.ValidLifetime = 0xffffffff; + row.PreferredLifetime = 0xffffffff; + + unsafe { *row.Address.Ipv4_mut() = convert_ipv4addr_to_sockaddr(&address.address()) }; + row.OnLinkPrefixLength = address.network_length(); + + let result = unsafe { CreateUnicastIpAddressEntry(&row) }; + + if NO_ERROR == result { + Ok(()) + } else { + Err(result) + } + } + + /// add_ipv6_address method adds new unicast IP address to the interface. Corresponds to CreateUnicastIpAddressEntry function + /// (https://docs.microsoft.com/en-us/windows/desktop/api/netioapi/nf-netioapi-createunicastipaddressentry). + pub fn add_ipv6_address(&self, address: &Ipv6Inet) -> Result<(), NETIO_STATUS> { + let mut row = MIB_UNICASTIPADDRESS_ROW::default(); + unsafe { InitializeUnicastIpAddressEntry(&mut row) }; + + row.InterfaceLuid = self.luid; + row.DadState = IpDadStatePreferred; + row.ValidLifetime = 0xffffffff; + row.PreferredLifetime = 0xffffffff; + + unsafe { *row.Address.Ipv6_mut() = convert_ipv6addr_to_sockaddr(&address.address()) }; + row.OnLinkPrefixLength = address.network_length(); + + let result = unsafe { CreateUnicastIpAddressEntry(&row) }; + + if NO_ERROR == result { + Ok(()) + } else { + Err(result) + } + } + + /// delete_ipv4_address method deletes interface's unicast IP address. Corresponds to DeleteUnicastIpAddressEntry function + /// (https://docs.microsoft.com/en-us/windows/desktop/api/netioapi/nf-netioapi-deleteunicastipaddressentry). + pub fn delete_ipv4_address(&self, address: &Ipv4Inet) -> Result<(), NETIO_STATUS> { + let mut row = MIB_UNICASTIPADDRESS_ROW::default(); + unsafe { InitializeUnicastIpAddressEntry(&mut row) }; + + row.InterfaceLuid = self.luid; + row.DadState = IpDadStatePreferred; + row.ValidLifetime = 0xffffffff; + row.PreferredLifetime = 0xffffffff; + + unsafe { *row.Address.Ipv4_mut() = convert_ipv4addr_to_sockaddr(&address.address()) }; + row.OnLinkPrefixLength = address.network_length(); + + let result = unsafe { DeleteUnicastIpAddressEntry(&row) }; + + if NO_ERROR == result { + Ok(()) + } else { + Err(result) + } + } + + /// delete_ipv6_address method deletes interface's unicast IP address. Corresponds to DeleteUnicastIpAddressEntry function + /// (https://docs.microsoft.com/en-us/windows/desktop/api/netioapi/nf-netioapi-deleteunicastipaddressentry). + pub fn delete_ipv6_address(&self, address: &Ipv6Inet) -> Result<(), NETIO_STATUS> { + let mut row = MIB_UNICASTIPADDRESS_ROW::default(); + unsafe { InitializeUnicastIpAddressEntry(&mut row) }; + + row.InterfaceLuid = self.luid; + row.DadState = IpDadStatePreferred; + row.ValidLifetime = 0xffffffff; + row.PreferredLifetime = 0xffffffff; + + unsafe { *row.Address.Ipv6_mut() = convert_ipv6addr_to_sockaddr(&address.address()) }; + row.OnLinkPrefixLength = address.network_length(); + + let result = unsafe { DeleteUnicastIpAddressEntry(&row) }; + + if NO_ERROR == result { + Ok(()) + } else { + Err(result) + } + } + + /// flush_ip_addresses method deletes all interface's unicast IP addresses. + pub fn flush_ip_addresses(&self, address_family: ADDRESS_FAMILY) -> Result<(), NETIO_STATUS> { + let mut p_table: PMIB_UNICASTIPADDRESS_TABLE = ptr::null_mut(); + let result = unsafe { GetUnicastIpAddressTable(address_family, &mut p_table) }; + if NO_ERROR != result { + return Err(result); + } + + assert!(!p_table.is_null()); + let num_entries = unsafe { *p_table }.NumEntries; + let x_table = unsafe { *p_table }.Table.as_ptr(); + for i in 0..num_entries { + let current_entry = unsafe { x_table.add(i as _) }; + if unsafe { (*current_entry).InterfaceLuid.Value } == self.luid.Value { + unsafe { DeleteUnicastIpAddressEntry(current_entry) }; + } + } + + unsafe { FreeMibTable(p_table as _) }; + + Ok(()) + } + + /// flush_ipv4_addresses method deletes all interface's unicast IP addresses. + pub fn flush_ipv4_addresses(&self) -> Result<(), NETIO_STATUS> { + self.flush_ip_addresses(AF_INET as _) + } + + /// flush_ipv6_addresses method deletes all interface's unicast IP addresses. + pub fn flush_ipv6_addresses(&self) -> Result<(), NETIO_STATUS> { + self.flush_ip_addresses(AF_INET6 as _) + } + + /// add_route_ipv4 method adds a route to the interface. Corresponds to CreateIpForwardEntry2 function, with added splitDefault feature. + /// (https://docs.microsoft.com/en-us/windows/desktop/api/netioapi/nf-netioapi-createipforwardentry2) + pub fn add_route_ipv4( + &self, + destination: &Ipv4Inet, + next_hop: &Ipv4Addr, + metric: u32, + ) -> Result<(), NETIO_STATUS> { + let mut row = MIB_IPFORWARD_ROW2::default(); + unsafe { InitializeIpForwardEntry(&mut row) }; + + row.InterfaceLuid = self.luid; + row.ValidLifetime = 0xffffffff; + row.PreferredLifetime = 0xffffffff; + + unsafe { + *row.DestinationPrefix.Prefix.Ipv4_mut() = + convert_ipv4addr_to_sockaddr(&destination.address()) + }; + row.DestinationPrefix.PrefixLength = destination.network_length(); + + unsafe { *row.NextHop.Ipv4_mut() = convert_ipv4addr_to_sockaddr(next_hop) }; + + row.Metric = metric; + + let result = unsafe { CreateIpForwardEntry2(&row) }; + + if NO_ERROR == result { + Ok(()) + } else { + Err(result) + } + } + + /// add_route_ipv6 method adds a route to the interface. Corresponds to CreateIpForwardEntry2 function, with added splitDefault feature. + /// (https://docs.microsoft.com/en-us/windows/desktop/api/netioapi/nf-netioapi-createipforwardentry2) + pub fn add_route_ipv6( + &self, + destination: &Ipv6Inet, + next_hop: &Ipv6Addr, + metric: u32, + ) -> Result<(), NETIO_STATUS> { + let mut row = MIB_IPFORWARD_ROW2::default(); + unsafe { InitializeIpForwardEntry(&mut row) }; + + row.InterfaceLuid = self.luid; + row.ValidLifetime = 0xffffffff; + row.PreferredLifetime = 0xffffffff; + + unsafe { + *row.DestinationPrefix.Prefix.Ipv6_mut() = + convert_ipv6addr_to_sockaddr(&destination.address()) + }; + row.DestinationPrefix.PrefixLength = destination.network_length(); + + unsafe { *row.NextHop.Ipv6_mut() = convert_ipv6addr_to_sockaddr(next_hop) }; + + row.Metric = metric; + + let result = unsafe { CreateIpForwardEntry2(&row) }; + + if NO_ERROR == result { + Ok(()) + } else { + Err(result) + } + } + + /// add_routes_ipv4 method adds multiple routes to the interface + pub fn add_routes_ipv4( + &self, + routes_data: impl IntoIterator, + ) -> Result<(), NETIO_STATUS> { + for rd in routes_data.into_iter().enumerate() { + self.add_route_ipv4(&rd.1.destination, &rd.1.next_hop, rd.1.metric)?; + } + Ok(()) + } + + /// add_routes_ipv6 method adds multiple routes to the interface + pub fn add_routes_ipv6( + &self, + routes_data: impl IntoIterator, + ) -> Result<(), NETIO_STATUS> { + for rd in routes_data.into_iter().enumerate() { + self.add_route_ipv6(&rd.1.destination, &rd.1.next_hop, rd.1.metric)?; + } + Ok(()) + } + + /// delete_route_ipv4 method deletes a route that matches the criteria. Corresponds to DeleteIpForwardEntry2 function + /// (https://docs.microsoft.com/en-us/windows/desktop/api/netioapi/nf-netioapi-deleteipforwardentry2). + pub fn delete_route_ipv4( + &self, + destination: &Ipv4Inet, + next_hop: &Ipv4Addr, + ) -> Result<(), NETIO_STATUS> { + let mut row = MIB_IPFORWARD_ROW2::default(); + unsafe { InitializeIpForwardEntry(&mut row) }; + + row.InterfaceLuid = self.luid; + + unsafe { + *row.DestinationPrefix.Prefix.Ipv4_mut() = + convert_ipv4addr_to_sockaddr(&destination.address()) + }; + row.DestinationPrefix.PrefixLength = destination.network_length(); + + unsafe { *row.NextHop.Ipv4_mut() = convert_ipv4addr_to_sockaddr(next_hop) }; + + let result = unsafe { GetIpForwardEntry2(&mut row) }; + if NO_ERROR != result { + return Err(result); + } + + let result = unsafe { DeleteIpForwardEntry2(&row) }; + if NO_ERROR == result { + Ok(()) + } else { + Err(result) + } + } + + /// delete_route_ipv6 method deletes a route that matches the criteria. Corresponds to DeleteIpForwardEntry2 function + /// (https://docs.microsoft.com/en-us/windows/desktop/api/netioapi/nf-netioapi-deleteipforwardentry2). + pub fn delete_route_ipv6( + &self, + destination: &Ipv6Inet, + next_hop: &Ipv6Addr, + ) -> Result<(), NETIO_STATUS> { + let mut row = MIB_IPFORWARD_ROW2::default(); + unsafe { InitializeIpForwardEntry(&mut row) }; + + row.InterfaceLuid = self.luid; + + unsafe { + *row.DestinationPrefix.Prefix.Ipv6_mut() = + convert_ipv6addr_to_sockaddr(&destination.address()) + }; + row.DestinationPrefix.PrefixLength = destination.network_length(); + + unsafe { *row.NextHop.Ipv6_mut() = convert_ipv6addr_to_sockaddr(next_hop) }; + + let result = unsafe { GetIpForwardEntry2(&mut row) }; + if NO_ERROR != result { + return Err(result); + } + + let result = unsafe { DeleteIpForwardEntry2(&row) }; + + if NO_ERROR == result { + Ok(()) + } else { + Err(result) + } + } + + /// Sets MTU on the interface + /// TODO: Set IP and other things in here too, so the code is more organized + pub fn set_iface_config(&self, mtu: u32) -> Result<(), NETIO_STATUS> { + // SAFETY: Both NET_LUID_LH unions should be the same. We're just copying out + // the u64 value and re-wrapping it, since wintun doesn't refer to the windows + // crate's version of NET_LUID_LH. + if let Err(e) = self.try_set_mtu(AF_INET as ADDRESS_FAMILY, mtu) { + tracing::warn!("Failed to set IPv4 MTU: {:?}", e); + } + if let Err(e) = self.try_set_mtu(AF_INET6 as ADDRESS_FAMILY, mtu) { + tracing::warn!("Failed to set IPv6 MTU: {:?}", e); + } + Ok(()) + } + + fn try_set_mtu(&self, family: ADDRESS_FAMILY, mut mtu: u32) -> Result<(), NETIO_STATUS> { + let mut row = MIB_IPINTERFACE_ROW { + Family: family, + InterfaceLuid: self.luid, + ..Default::default() + }; + + // SAFETY: TODO + let error = unsafe { GetIpInterfaceEntry(&mut row) }; + if error != NO_ERROR { + if family == (AF_INET6 as ADDRESS_FAMILY) && error == ERROR_NOT_FOUND { + tracing::debug!(?family, "Couldn't set MTU, maybe IPv6 is disabled."); + } else { + tracing::warn!(?family, "Couldn't set MTU: {}", error); + } + return Err(error); + } + + if family == (AF_INET6 as ADDRESS_FAMILY) { + // ipv6 mtu must be at least 1280 + mtu = 1280.max(mtu); + } + + // https://stackoverflow.com/questions/54857292/setipinterfaceentry-returns-error-invalid-parameter + row.SitePrefixLength = 0; + + row.NlMtu = mtu; + + // SAFETY: TODO + let ret = unsafe { SetIpInterfaceEntry(&mut row) }; + if NO_ERROR == ret { Ok(()) } else { Err(ret) } + } +} diff --git a/vendor/easytier/easytier/src/common/ifcfg/win/mod.rs b/vendor/easytier/easytier/src/common/ifcfg/win/mod.rs new file mode 100644 index 0000000..a24fe62 --- /dev/null +++ b/vendor/easytier/easytier/src/common/ifcfg/win/mod.rs @@ -0,0 +1,2 @@ +pub mod luid; +pub mod types; diff --git a/vendor/easytier/easytier/src/common/ifcfg/win/types.rs b/vendor/easytier/easytier/src/common/ifcfg/win/types.rs new file mode 100644 index 0000000..1e54702 --- /dev/null +++ b/vendor/easytier/easytier/src/common/ifcfg/win/types.rs @@ -0,0 +1,66 @@ +// +// Port supporting code for wireguard-nt from wireguard-windows v0.5.3 to Rust +// This file replicates parts of wireguard-windows/tunnel/winipcfg/types.go +// + +use cidr::{Ipv4Inet, Ipv6Inet}; +use std::net::{Ipv4Addr, Ipv6Addr}; +use winapi::shared::ws2def::*; +use winapi::shared::ws2ipdef::*; + +#[derive(Hash, Eq, PartialEq, Debug)] +pub struct RouteDataIpv4 { + pub destination: Ipv4Inet, + pub next_hop: Ipv4Addr, + pub metric: u32, +} + +#[derive(Hash, Eq, PartialEq, Debug)] +pub struct RouteDataIpv6 { + pub destination: Ipv6Inet, + pub next_hop: Ipv6Addr, + pub metric: u32, +} + +/// This function converts std::net::Ipv4Addr to winapi::shared::inaddr::in_addr +#[inline] +pub fn convert_ipv4addr_to_inaddr(ip: &Ipv4Addr) -> winapi::shared::inaddr::in_addr { + let mut winaddr = winapi::shared::inaddr::in_addr::default(); + + let s_un_b = unsafe { winaddr.S_un.S_un_b_mut() }; + s_un_b.s_b1 = ip.octets()[0]; + s_un_b.s_b2 = ip.octets()[1]; + s_un_b.s_b3 = ip.octets()[2]; + s_un_b.s_b4 = ip.octets()[3]; + + winaddr +} + +/// This function converts std::net::Ipv6Addr to winapi::shared::in6addr::in6_addr +#[inline] +pub fn convert_ipv6addr_to_inaddr(ip: &Ipv6Addr) -> winapi::shared::in6addr::in6_addr { + let mut winaddr = winapi::shared::in6addr::in6_addr::default(); + let octets = ip.octets(); + for (i, &octet) in octets.iter().enumerate() { + unsafe { winaddr.u.Byte_mut()[i] = octet }; + } + winaddr +} + +/// This function converts std::net::Ipv4Addr to winapi::shared::ws2def::SOCKADDR_IN +pub fn convert_ipv4addr_to_sockaddr(ip: &Ipv4Addr) -> SOCKADDR_IN { + SOCKADDR_IN { + sin_family: AF_INET as ADDRESS_FAMILY, + sin_addr: convert_ipv4addr_to_inaddr(ip), + ..Default::default() + } +} + +/// This function converts ipnet::Ipv6Addr to winapi::shared::ws2ipdef::SOCKADDR_IN6 +pub fn convert_ipv6addr_to_sockaddr(ip: &Ipv6Addr) -> SOCKADDR_IN6 { + SOCKADDR_IN6 { + sin6_family: AF_INET6 as ADDRESS_FAMILY, + sin6_addr: convert_ipv6addr_to_inaddr(ip), + ..Default::default() + } +} diff --git a/vendor/easytier/easytier/src/common/ifcfg/windows.rs b/vendor/easytier/easytier/src/common/ifcfg/windows.rs new file mode 100644 index 0000000..15e4b23 --- /dev/null +++ b/vendor/easytier/easytier/src/common/ifcfg/windows.rs @@ -0,0 +1,532 @@ +use crate::common::ifcfg::win::types::{RouteDataIpv4, RouteDataIpv6}; + +use super::win::luid::InterfaceLuid; +use async_trait::async_trait; +use cidr::{Ipv4Inet, Ipv6Inet}; +use std::{ + io, + net::{Ipv4Addr, Ipv6Addr}, +}; +use windows::Win32::NetworkManagement::IpHelper::INTERNAL_IF_OPER_STATUS; +use windows::Win32::{ + Foundation::NO_ERROR, + NetworkManagement::IpHelper::{GetIfEntry, MIB_IFROW, SetIfEntry}, + System::Diagnostics::Debug::{ + FORMAT_MESSAGE_FROM_SYSTEM, FORMAT_MESSAGE_IGNORE_INSERTS, FormatMessageW, + }, +}; +use windows::core::PWSTR; +use winreg::{ + RegKey, + enums::{HKEY_LOCAL_MACHINE, KEY_READ, KEY_WRITE}, +}; + +use super::{Error, IfConfiguerTrait}; +pub struct WindowsIfConfiger {} + +fn format_win_error(error: u32) -> String { + // use FormatMessageW to get the error message + let mut buffer = vec![0; 1024]; + let size = buffer.len() as u32; + let flags = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS; + + unsafe { + FormatMessageW( + flags, + None, + error, + 0, + PWSTR(buffer.as_mut_ptr()), + size, + None, + ); + } + let str_end = buffer.iter().position(|&b| b == 0).unwrap_or(buffer.len()); + format!( + "{} (code: {})", + String::from_utf16_lossy(&buffer[..str_end]).trim(), + error + ) +} + +impl WindowsIfConfiger { + pub fn get_interface_index(name: &str) -> Option { + crate::arch::windows::find_interface_index(name).ok() + } + + #[tracing::instrument(err, ret)] + async fn add_ip_address(name: &str, addr: Ipv4Inet) -> Result<(), Error> { + let if_index = Self::get_interface_index(name).ok_or(Error::NotFound)?; + let luid = InterfaceLuid::luid_from_index(if_index).map_err(|e| { + anyhow::anyhow!("Failed to get interface luid: {}", format_win_error(e)) + })?; + luid.add_ipv4_address(&addr) + .map_err(|e| anyhow::anyhow!("Failed to add IPv4 address: {}", format_win_error(e)))?; + Ok(()) + } + + #[tracing::instrument(err, ret)] + async fn remove_ip_address(name: &str, addr: Option) -> Result<(), Error> { + let Some(if_index) = Self::get_interface_index(name) else { + return Err(Error::NotFound); + }; + let luid = InterfaceLuid::luid_from_index(if_index).map_err(|e| { + anyhow::anyhow!("Failed to get interface luid: {}", format_win_error(e)) + })?; + if let Some(addr) = addr { + luid.delete_ipv4_address(&addr).map_err(|e| { + anyhow::anyhow!("Failed to delete IPv4 address: {}", format_win_error(e)) + })?; + } else { + luid.flush_ipv4_addresses().map_err(|e| { + anyhow::anyhow!("Failed to flush IPv4 addresses: {}", format_win_error(e)) + })?; + } + Ok(()) + } + + #[tracing::instrument(err, ret)] + async fn set_interface_status(name: &str, up: bool) -> Result<(), Error> { + let Some(if_index) = Self::get_interface_index(name) else { + return Err(Error::NotFound); + }; + + unsafe { + let mut if_row = MIB_IFROW { + wszName: [0; 256], + dwIndex: if_index, + dwType: 0, + dwMtu: 0, + dwSpeed: 0, + dwPhysAddrLen: 0, + bPhysAddr: [0; 8], + dwAdminStatus: if up { 1 } else { 2 }, // 1 = up, 2 = down + dwOperStatus: INTERNAL_IF_OPER_STATUS(0), + dwLastChange: 0, + dwInOctets: 0, + dwInUcastPkts: 0, + dwInNUcastPkts: 0, + dwInDiscards: 0, + dwInErrors: 0, + dwInUnknownProtos: 0, + dwOutOctets: 0, + dwOutUcastPkts: 0, + dwOutNUcastPkts: 0, + dwOutDiscards: 0, + dwOutErrors: 0, + dwOutQLen: 0, + dwDescrLen: 0, + bDescr: [0; 256], + }; + + if GetIfEntry(&mut if_row) == NO_ERROR.0 { + if SetIfEntry(&if_row) == NO_ERROR.0 { + Ok(()) + } else { + Err(anyhow::anyhow!("Failed to set interface status").into()) + } + } else { + Err(anyhow::anyhow!("Failed to get interface entry").into()) + } + } + } + + #[tracing::instrument(err, ret)] + async fn set_interface_mtu(name: &str, mtu: u32) -> Result<(), Error> { + let Some(if_index) = Self::get_interface_index(name) else { + return Err(Error::NotFound); + }; + let luid = InterfaceLuid::luid_from_index(if_index).map_err(|e| { + anyhow::anyhow!("Failed to get interface luid: {}", format_win_error(e)) + })?; + luid.set_iface_config(mtu).map_err(|e| { + anyhow::anyhow!("Failed to set interface config: {}", format_win_error(e)) + })?; + Ok(()) + } + + #[tracing::instrument(err, ret)] + async fn add_ipv6_address(name: &str, addr: Ipv6Inet) -> Result<(), Error> { + let Some(if_index) = Self::get_interface_index(name) else { + return Err(Error::NotFound); + }; + let luid = InterfaceLuid::luid_from_index(if_index).map_err(|e| { + anyhow::anyhow!("Failed to get interface luid: {}", format_win_error(e)) + })?; + luid.add_ipv6_address(&addr) + .map_err(|e| anyhow::anyhow!("Failed to add IPv6 address: {}", format_win_error(e)))?; + Ok(()) + } + + #[tracing::instrument(err, ret)] + async fn remove_ipv6_address(name: &str, addr: Option) -> Result<(), Error> { + let Some(if_index) = Self::get_interface_index(name) else { + return Err(Error::NotFound); + }; + let luid = InterfaceLuid::luid_from_index(if_index).map_err(|e| { + anyhow::anyhow!("Failed to get interface luid: {}", format_win_error(e)) + })?; + if let Some(addr) = addr { + luid.delete_ipv6_address(&addr).map_err(|e| { + anyhow::anyhow!("Failed to delete IPv6 address: {}", format_win_error(e)) + })?; + } else { + luid.flush_ipv6_addresses().map_err(|e| { + anyhow::anyhow!("Failed to flush IPv6 addresses: {}", format_win_error(e)) + })?; + } + Ok(()) + } +} + +#[async_trait] +impl IfConfiguerTrait for WindowsIfConfiger { + async fn add_ipv4_route( + &self, + name: &str, + address: Ipv4Addr, + cidr_prefix: u8, + cost: Option, + ) -> Result<(), Error> { + let Some(if_index) = Self::get_interface_index(name) else { + return Err(Error::NotFound); + }; + let luid = InterfaceLuid::luid_from_index(if_index).map_err(|e| { + anyhow::anyhow!("Failed to get interface luid: {}", format_win_error(e)) + })?; + + luid.add_routes_ipv4([RouteDataIpv4 { + destination: Ipv4Inet::new(address, cidr_prefix).unwrap(), + next_hop: Ipv4Addr::UNSPECIFIED, + metric: cost.unwrap_or(9000) as u32, + }]) + .map_err(|e| anyhow::anyhow!("Failed to add route: {}", format_win_error(e)))?; + Ok(()) + } + + async fn remove_ipv4_route( + &self, + name: &str, + address: Ipv4Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + let Some(if_index) = Self::get_interface_index(name) else { + return Err(Error::NotFound); + }; + let luid = InterfaceLuid::luid_from_index(if_index).map_err(|e| { + anyhow::anyhow!("Failed to get interface luid: {}", format_win_error(e)) + })?; + luid.delete_route_ipv4( + &Ipv4Inet::new(address, cidr_prefix).unwrap(), + &Ipv4Addr::UNSPECIFIED, + ) + .map_err(|e| anyhow::anyhow!("Failed to delete route: {}", format_win_error(e)))?; + Ok(()) + } + + async fn add_ipv4_ip( + &self, + name: &str, + address: Ipv4Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + Self::add_ip_address(name, Ipv4Inet::new(address, cidr_prefix).unwrap()).await + } + + async fn set_link_status(&self, name: &str, up: bool) -> Result<(), Error> { + Self::set_interface_status(name, up).await + } + + async fn remove_ip(&self, name: &str, ip: Option) -> Result<(), Error> { + Self::remove_ip_address(name, ip).await + } + + async fn wait_interface_show(&self, name: &str) -> Result<(), Error> { + loop { + if let Some(idx) = Self::get_interface_index(name) { + tracing::info!(?name, ?idx, "Interface found"); + return Ok(()); + } + tokio::time::sleep(std::time::Duration::from_millis(100)).await; + } + } + + async fn set_mtu(&self, name: &str, mtu: u32) -> Result<(), Error> { + Self::set_interface_mtu(name, mtu).await + } + + async fn add_ipv6_ip( + &self, + name: &str, + address: Ipv6Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + Self::add_ipv6_address(name, Ipv6Inet::new(address, cidr_prefix).unwrap()).await + } + + async fn remove_ipv6(&self, name: &str, ip: Option) -> Result<(), Error> { + Self::remove_ipv6_address(name, ip).await + } + + async fn add_ipv6_route( + &self, + name: &str, + address: Ipv6Addr, + cidr_prefix: u8, + cost: Option, + ) -> Result<(), Error> { + let Some(if_index) = Self::get_interface_index(name) else { + return Err(Error::NotFound); + }; + + let luid = InterfaceLuid::luid_from_index(if_index).map_err(|e| { + anyhow::anyhow!("Failed to get interface luid: {}", format_win_error(e)) + })?; + + luid.add_routes_ipv6([RouteDataIpv6 { + destination: Ipv6Inet::new(address, cidr_prefix).unwrap(), + next_hop: Ipv6Addr::UNSPECIFIED, + metric: cost.unwrap_or(9000) as u32, + }]) + .map_err(|e| anyhow::anyhow!("Failed to add route: {}", format_win_error(e)))?; + Ok(()) + } + + async fn remove_ipv6_route( + &self, + name: &str, + address: Ipv6Addr, + cidr_prefix: u8, + ) -> Result<(), Error> { + let Some(if_index) = Self::get_interface_index(name) else { + return Err(Error::NotFound); + }; + + let luid = InterfaceLuid::luid_from_index(if_index).map_err(|e| { + anyhow::anyhow!("Failed to get interface luid: {}", format_win_error(e)) + })?; + + luid.delete_route_ipv6( + &Ipv6Inet::new(address, cidr_prefix).unwrap(), + &Ipv6Addr::UNSPECIFIED, + ) + .map_err(|e| anyhow::anyhow!("Failed to delete route: {}", format_win_error(e)))?; + Ok(()) + } +} + +pub struct RegistryManager; + +impl RegistryManager { + pub const IPV4_TCPIP_INTERFACE_PREFIX: &str = + r"SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\Interfaces\"; + pub const IPV6_TCPIP_INTERFACE_PREFIX: &str = + r"SYSTEM\CurrentControlSet\Services\Tcpip6\Parameters\Interfaces\"; + pub const NETBT_INTERFACE_PREFIX: &str = + r"SYSTEM\CurrentControlSet\Services\NetBT\Parameters\Interfaces\Tcpip_"; + + pub fn reg_delete_obsoleted_items(dev_name: &str) -> io::Result<()> { + use winreg::{RegKey, enums::HKEY_LOCAL_MACHINE, enums::KEY_ALL_ACCESS}; + let hklm = RegKey::predef(HKEY_LOCAL_MACHINE); + let profiles_key = hklm.open_subkey_with_flags( + "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\NetworkList\\Profiles", + KEY_ALL_ACCESS, + )?; + let unmanaged_key = hklm.open_subkey_with_flags( + "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\NetworkList\\Signatures\\Unmanaged", + KEY_ALL_ACCESS, + )?; + // collect subkeys to delete + let mut keys_to_delete = Vec::new(); + let mut keys_to_delete_unmanaged = Vec::new(); + for subkey_name in profiles_key.enum_keys().filter_map(Result::ok) { + let subkey = profiles_key.open_subkey(&subkey_name)?; + // check if ProfileName contains "et" + match subkey.get_value::("ProfileName") { + Ok(profile_name) => { + if profile_name.contains("et_") + || (!dev_name.is_empty() && dev_name == profile_name) + { + keys_to_delete.push(subkey_name); + } + } + Err(e) => { + tracing::error!( + "Failed to read ProfileName for subkey {}: {}", + subkey_name, + e + ); + } + } + } + for subkey_name in unmanaged_key.enum_keys().filter_map(Result::ok) { + let subkey = unmanaged_key.open_subkey(&subkey_name)?; + // check if ProfileName contains "et" + match subkey.get_value::("Description") { + Ok(profile_name) => { + if profile_name.contains("et_") + || (!dev_name.is_empty() && dev_name == profile_name) + { + keys_to_delete_unmanaged.push(subkey_name); + } + } + Err(e) => { + tracing::error!( + "Failed to read ProfileName for subkey {}: {}", + subkey_name, + e + ); + } + } + } + // delete collected subkeys + if !keys_to_delete.is_empty() { + for subkey_name in keys_to_delete { + match profiles_key.delete_subkey_all(&subkey_name) { + Ok(_) => tracing::trace!("Successfully deleted subkey: {}", subkey_name), + Err(e) => tracing::error!("Failed to delete subkey {}: {}", subkey_name, e), + } + } + } + if !keys_to_delete_unmanaged.is_empty() { + for subkey_name in keys_to_delete_unmanaged { + match unmanaged_key.delete_subkey_all(&subkey_name) { + Ok(_) => tracing::trace!("Successfully deleted subkey: {}", subkey_name), + Err(e) => tracing::error!("Failed to delete subkey {}: {}", subkey_name, e), + } + } + } + Ok(()) + } + + pub fn reg_change_catrgory_in_profile(dev_name: &str) -> io::Result<()> { + use winreg::{RegKey, enums::HKEY_LOCAL_MACHINE, enums::KEY_ALL_ACCESS}; + let hklm = RegKey::predef(HKEY_LOCAL_MACHINE); + let profiles_key = hklm.open_subkey_with_flags( + "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\NetworkList\\Profiles", + KEY_ALL_ACCESS, + )?; + + for subkey_name in profiles_key.enum_keys().filter_map(Result::ok) { + let subkey = profiles_key.open_subkey_with_flags(&subkey_name, KEY_ALL_ACCESS)?; + match subkey.get_value::("ProfileName") { + Ok(profile_name) => { + if !dev_name.is_empty() && dev_name == profile_name { + match subkey.set_value("Category", &1u32) { + Ok(_) => tracing::trace!("Successfully set Category in registry"), + Err(e) => tracing::error!("Failed to set Category in registry: {}", e), + } + } + } + Err(e) => { + tracing::error!( + "Failed to read ProfileName for subkey {}: {}", + subkey_name, + e + ); + } + } + } + Ok(()) + } + + // 根据接口名称查找 GUID + pub fn find_interface_guid(interface_name: &str) -> io::Result { + // 注册表路径:所有网络接口的根目录 + let network_key_path = + r"SYSTEM\CurrentControlSet\Control\Network\{4D36E972-E325-11CE-BFC1-08002BE10318}"; + + let hklm = RegKey::predef(HKEY_LOCAL_MACHINE); + let network_key = hklm.open_subkey_with_flags(network_key_path, KEY_READ)?; + + // 遍历该路径下的所有 GUID 子键 + for guid in network_key.enum_keys().map_while(Result::ok) { + if let Ok(guid_key) = network_key.open_subkey_with_flags(&guid, KEY_READ) { + // 检查 Connection/Name 是否匹配目标接口名 + if let Ok(conn_key) = guid_key.open_subkey_with_flags("Connection", KEY_READ) + && let Ok(name) = conn_key.get_value::("Name") + && name == interface_name + { + return Ok(guid); + } + } + } + + // 如果没有找到对应的接口 + Err(io::Error::new( + io::ErrorKind::NotFound, + "Interface not found", + )) + } + + // 打开注册表键 + pub fn open_interface_key(interface_guid: &str, prefix: &str) -> io::Result { + let path = format!(r"{}{}", prefix, interface_guid); + let hkey_local_machine = RegKey::predef(HKEY_LOCAL_MACHINE); + hkey_local_machine.open_subkey_with_flags(&path, KEY_WRITE) + } + + // 禁用动态 DNS 更新 + // disableDynamicUpdates sets the appropriate registry values to prevent the + // Windows DHCP client from sending dynamic DNS updates for our interface to + // AD domain controllers. + pub fn disable_dynamic_updates(interface_guid: &str) -> io::Result<()> { + let prefixes = [ + Self::IPV4_TCPIP_INTERFACE_PREFIX, + Self::IPV6_TCPIP_INTERFACE_PREFIX, + ]; + + for prefix in &prefixes { + let key = match Self::open_interface_key(interface_guid, prefix) { + Ok(k) => k, + Err(e) => { + // 模拟 mute-key-not-found-if-closing 行为 + if matches!(e.kind(), io::ErrorKind::NotFound) { + continue; + } else { + return Err(e); + } + } + }; + + key.set_value("RegistrationEnabled", &0u32)?; + key.set_value("DisableDynamicUpdate", &1u32)?; + key.set_value("MaxNumberOfAddressesToRegister", &0u32)?; + } + + Ok(()) + } + + // 设置单个 DWORD 值到指定的注册表路径下 + fn set_single_dword( + interface_guid: &str, + prefix: &str, + value_name: &str, + data: u32, + ) -> io::Result<()> { + let key = match Self::open_interface_key(interface_guid, prefix) { + Ok(k) => k, + Err(e) => { + // 模拟 muteKeyNotFoundIfClosing 行为:忽略 Key Not Found 错误 + return if matches!(e.kind(), io::ErrorKind::NotFound) { + Ok(()) + } else { + Err(e) + }; + } + }; + + key.set_value(value_name, &data)?; + Ok(()) + } + + // 禁用 NetBIOS 名称解析请求 + pub fn disable_netbios(interface_guid: &str) -> io::Result<()> { + Self::set_single_dword( + interface_guid, + Self::NETBT_INTERFACE_PREFIX, + "NetbiosOptions", + 2, + ) + } +} diff --git a/vendor/easytier/easytier/src/common/log/file.rs b/vendor/easytier/easytier/src/common/log/file.rs new file mode 100644 index 0000000..fadc2f1 --- /dev/null +++ b/vendor/easytier/easytier/src/common/log/file.rs @@ -0,0 +1,221 @@ +use std::sync::atomic::AtomicU8; + +#[cfg(feature = "management")] +use anyhow::Context as _; +use log::{Level, LevelFilter}; +#[cfg(feature = "management")] +use std::sync::atomic::Ordering; + +#[cfg(feature = "management")] +use crate::common::{ + config::FileLoggerConfig, + tracing_rolling_appender::{FileAppenderWrapper, RollingFileAppenderBase}, +}; + +use super::level_rank; +#[cfg(feature = "management")] +use super::{TargetFilter, format_line, level_is_enabled, parse_level}; + +#[cfg(feature = "management")] +pub(super) struct FileSink { + output: Option, + reload: bool, +} + +#[cfg(not(feature = "management"))] +pub(super) struct FileSink; + +#[cfg(feature = "management")] +struct FileOutput { + appender: FileAppenderWrapper, + max_level: AtomicU8, + state: parking_lot::RwLock, +} + +#[cfg(feature = "management")] +struct FileState { + level: LevelFilter, + filter: TargetFilter, +} + +#[cfg(feature = "management")] +impl FileSink { + pub(super) fn disabled() -> Self { + Self { + output: None, + reload: false, + } + } + + pub(super) fn from_config(config: FileLoggerConfig, reload: bool) -> anyhow::Result { + let level = config + .level + .as_deref() + .map(parse_level) + .transpose() + .context("invalid file log level")? + .unwrap_or(LevelFilter::Off); + if level == LevelFilter::Off && !reload { + return Ok(Self::disabled()); + } + + let dir = config.dir.as_deref().unwrap_or("."); + let file = config.file.as_deref().unwrap_or("easytier.log"); + let path = std::path::Path::new(dir).join(file); + let file_appender = RollingFileAppenderBase::builder() + .filename(path.to_string_lossy().into_owned()) + .condition_daily() + .max_filecount(config.count.unwrap_or(10)) + .condition_max_file_size(config.size_mb.unwrap_or(100) * 1024 * 1024) + .build() + .context("failed to initialize rolling file appender")?; + + let filter = file_filter(level)?; + let max_level = AtomicU8::new(level_rank(filter.max_level())); + Ok(Self { + output: Some(FileOutput { + appender: FileAppenderWrapper::new(file_appender), + max_level, + state: parking_lot::RwLock::new(FileState { level, filter }), + }), + reload, + }) + } + + pub(super) fn enabled(&self, target: &str, level: Level) -> bool { + self.output.as_ref().is_some_and(|output| { + level_is_enabled(output.max_level.load(Ordering::Acquire), level) + && output.state.read().filter.enabled(target, level) + }) + } + + pub(super) fn max_level(&self) -> LevelFilter { + self.output + .as_ref() + .map(|output| output.state.read().filter.max_level()) + .unwrap_or(LevelFilter::Off) + } + + pub(super) fn max_level_rank(&self) -> u8 { + self.output + .as_ref() + .map(|output| output.max_level.load(Ordering::Relaxed)) + .unwrap_or_else(|| level_rank(LevelFilter::Off)) + } + + pub(super) fn dynamic(&self) -> bool { + self.reload && self.output.is_some() + } + + pub(super) fn emit(&self, timestamp: &str, level: Level, target: &str, message: &str) { + if let Some(output) = &self.output { + let line = format_line(timestamp, level, target, message, false); + let _ = output.appender.write_all(line.as_bytes()); + } + } + + pub(super) fn set_level( + &self, + level: LevelFilter, + console_max_level: LevelFilter, + active_max_level: &AtomicU8, + ) -> anyhow::Result<()> { + let output = self + .output + .as_ref() + .filter(|_| self.reload) + .context("logger reloader is not initialized")?; + let filter = file_filter(level)?; + let file_max_filter = filter.max_level(); + let file_max_level = level_rank(file_max_filter); + let active_max_filter = console_max_level.max(file_max_filter); + + let mut state = output.state.write(); + *state = FileState { level, filter }; + output.max_level.store(file_max_level, Ordering::Release); + active_max_level.store(level_rank(active_max_filter), Ordering::Release); + log::set_max_level(active_max_filter); + drop(state); + Ok(()) + } + + pub(super) fn level(&self) -> LevelFilter { + self.output + .as_ref() + .map(|output| output.state.read().level) + .unwrap_or(LevelFilter::Info) + } + + pub(super) fn flush(&self) { + if let Some(output) = &self.output { + let _ = output.appender.flush(); + } + } + + #[cfg(test)] + pub(super) fn is_open(&self) -> bool { + self.output.is_some() + } + + #[cfg(test)] + pub(super) fn assert_level_state(&self, console_max_level: u8, active_max_level: u8) { + let output = self.output.as_ref().expect("file logger is open"); + let state = output.state.read(); + let file_max_level = level_rank(state.filter.max_level()); + assert_eq!(output.max_level.load(Ordering::Relaxed), file_max_level); + assert_eq!(active_max_level, console_max_level.max(file_max_level)); + assert_eq!( + level_rank(log::max_level()), + console_max_level.max(file_max_level) + ); + } +} + +#[cfg(not(feature = "management"))] +impl FileSink { + pub(super) fn disabled() -> Self { + Self + } + + pub(super) fn enabled(&self, _target: &str, _level: Level) -> bool { + false + } + + pub(super) fn max_level(&self) -> LevelFilter { + LevelFilter::Off + } + + pub(super) fn max_level_rank(&self) -> u8 { + level_rank(LevelFilter::Off) + } + + pub(super) fn dynamic(&self) -> bool { + false + } + + pub(super) fn emit(&self, _timestamp: &str, _level: Level, _target: &str, _message: &str) {} + + pub(super) fn set_level( + &self, + _level: LevelFilter, + _console_max_level: LevelFilter, + _active_max_level: &AtomicU8, + ) -> anyhow::Result<()> { + anyhow::bail!("file logging is not available in this build") + } + + pub(super) fn level(&self) -> LevelFilter { + LevelFilter::Info + } + + pub(super) fn flush(&self) {} +} + +#[cfg(feature = "management")] +fn file_filter(level: LevelFilter) -> anyhow::Result { + if level == LevelFilter::Off { + Ok(TargetFilter::off()) + } else { + TargetFilter::from_environment(TargetFilter::with_default(level)) + } +} diff --git a/vendor/easytier/easytier/src/common/log/management.rs b/vendor/easytier/easytier/src/common/log/management.rs new file mode 100644 index 0000000..2c22007 --- /dev/null +++ b/vendor/easytier/easytier/src/common/log/management.rs @@ -0,0 +1,27 @@ +use anyhow::Context as _; + +use crate::common::config::LoggingConfigLoader; + +use super::{FileSink, Logger, TargetFilter, install, parse_level}; + +pub fn init(config: impl LoggingConfigLoader, reload: bool) -> anyhow::Result<()> { + init_with_default_console_targets(config, reload, &[super::LOG_TARGET]) +} + +pub fn init_with_default_console_targets( + config: impl LoggingConfigLoader, + reload: bool, + default_targets: &[&str], +) -> anyhow::Result<()> { + let console_config = config.get_console_logger_config(); + let console_level = console_config + .level + .as_deref() + .map(parse_level) + .transpose() + .context("invalid console log level")?; + let console = TargetFilter::console_with_default_targets(console_level, default_targets)?; + let file = FileSink::from_config(config.get_file_logger_config(), reload)?; + + install(Logger::new(console, file)) +} diff --git a/vendor/easytier/easytier/src/common/log/mod.rs b/vendor/easytier/easytier/src/common/log/mod.rs new file mode 100644 index 0000000..4f1efa1 --- /dev/null +++ b/vendor/easytier/easytier/src/common/log/mod.rs @@ -0,0 +1,662 @@ +use std::{ + fmt::{self, Write as _}, + io::{self, IsTerminal, Write as _}, + sync::{ + OnceLock, + atomic::{AtomicU8, Ordering}, + }, + time::{SystemTime, UNIX_EPOCH}, +}; + +use anyhow::Context as _; +use log::{Level, LevelFilter, Metadata as LogMetadata, Record as LogRecord}; +use paste::paste; +use tracing::{ + Event, + field::{Field, Visit}, +}; + +mod file; +#[cfg(feature = "management")] +mod management; +#[cfg(feature = "management")] +pub use management::{init, init_with_default_console_targets}; +mod tracing_backend; + +use file::FileSink; + +macro_rules! __log__ { + (const $var:ident = $target:expr) => { + const $var: &'static str = $target; + __log__!(@impl $target, $); + }; + + (@impl $target:expr, $_:tt) => { + __log__!(@impl $_, $target, error, warn, info, debug, trace); + }; + + (@impl $_:tt, $target:expr, $($lvl:ident),+) => { + paste! { + $( + macro_rules! [< __ $lvl __ >] { + (category: $cat:expr, $_ ($arg:tt)+) => { + tracing::$lvl!(target: concat!($target, "::", $cat), $_ ($arg)+) + }; + ($_ ($arg:tt)+) => { + tracing::$lvl!(target: $target, $_ ($arg)+) + }; + } + + #[allow(unused_imports)] + pub(crate) use [< __ $lvl __ >] as $lvl; + )+ + } + }; +} + +__log__!(const LOG_TARGET = "CORE"); + +static LOGGER: OnceLock = OnceLock::new(); + +pub fn init_console() -> anyhow::Result<()> { + install(Logger::new( + TargetFilter::console(Some(LevelFilter::Info))?, + FileSink::disabled(), + )) +} + +pub fn set_file_level(level: &str) -> anyhow::Result<()> { + let level = parse_level(level).context("invalid file log level")?; + LOGGER + .get() + .context("logger is not initialized")? + .set_file_level(level) +} + +pub fn file_level() -> String { + LOGGER + .get() + .map(Logger::file_level) + .unwrap_or(LevelFilter::Info) + .to_string() + .to_ascii_lowercase() +} + +fn install(logger: Logger) -> anyhow::Result<()> { + LOGGER + .set(logger) + .map_err(|_| anyhow::anyhow!("logger is already initialized"))?; + let logger = LOGGER.get().expect("logger was just initialized"); + + log::set_logger(logger).map_err(|_| anyhow::anyhow!("a log logger is already installed"))?; + log::set_max_level(logger.max_level()); + tracing_backend::install(logger).context("failed to install tracing subscriber") +} + +fn parse_level(level: &str) -> anyhow::Result { + level + .parse() + .map_err(|error| anyhow::anyhow!("{error}: {level:?}")) +} + +#[derive(Clone, Debug)] +struct TargetFilter { + default: LevelFilter, + targets: Vec<(Box, LevelFilter)>, +} + +impl TargetFilter { + fn console(level: Option) -> anyhow::Result { + Self::console_with_default_targets(level, &[LOG_TARGET]) + } + + fn console_with_default_targets( + level: Option, + default_targets: &[&str], + ) -> anyhow::Result { + if level == Some(LevelFilter::Off) { + return Ok(Self::off()); + } + + let fallback = match level { + Some(level) => Self::with_default(level), + None => Self { + default: LevelFilter::Off, + targets: default_targets + .iter() + .map(|target| ((*target).into(), LevelFilter::Info)) + .collect(), + }, + }; + Self::from_environment(fallback) + } + + fn off() -> Self { + Self::with_default(LevelFilter::Off) + } + + fn with_default(default: LevelFilter) -> Self { + Self { + default, + targets: Vec::new(), + } + } + + fn from_environment(fallback: Self) -> anyhow::Result { + let spec = std::env::var("RUST_LOG").unwrap_or_default(); + Self::parse(&spec).map(|filter| filter.unwrap_or(fallback)) + } + + fn parse(spec: &str) -> anyhow::Result> { + let mut filter = Self::off(); + let mut found = false; + + for directive in spec.split(',').map(str::trim).filter(|s| !s.is_empty()) { + found = true; + if directive.contains(['[', ']', '{', '}']) { + anyhow::bail!( + "span and field filters are not supported in RUST_LOG: {directive:?}" + ); + } + + if let Some((target, level)) = directive.rsplit_once('=') { + let target = target.trim(); + if target.is_empty() { + anyhow::bail!("missing target in RUST_LOG directive: {directive:?}"); + } + filter + .targets + .push((target.into(), parse_level(level.trim())?)); + } else if let Ok(level) = directive.parse() { + filter.default = level; + } else { + if directive.chars().any(char::is_whitespace) { + anyhow::bail!("invalid RUST_LOG directive: {directive:?}"); + } + filter.targets.push((directive.into(), LevelFilter::Trace)); + } + } + + Ok(found.then_some(filter)) + } + + fn enabled(&self, target: &str, level: Level) -> bool { + let mut selected = self.default; + let mut selected_len = 0; + for (prefix, filter) in &self.targets { + if prefix.len() >= selected_len && target.starts_with(prefix.as_ref()) { + selected = *filter; + selected_len = prefix.len(); + } + } + selected >= level.to_level_filter() + } + + fn max_level(&self) -> LevelFilter { + self.targets + .iter() + .map(|(_, level)| *level) + .fold(self.default, std::cmp::max) + } +} + +struct Logger { + console: TargetFilter, + console_max_level: u8, + active_max_level: AtomicU8, + color: bool, + file: FileSink, +} + +impl Logger { + fn new(console: TargetFilter, file: FileSink) -> Self { + let console_max_level = level_rank(console.max_level()); + let active_max_level = console_max_level.max(file.max_level_rank()); + Self { + console, + console_max_level, + active_max_level: AtomicU8::new(active_max_level), + color: io::stderr().is_terminal() && std::env::var_os("NO_COLOR").is_none(), + file, + } + } + + fn enabled(&self, target: &str, level: Level) -> bool { + level_is_enabled(self.active_max_level.load(Ordering::Acquire), level) + && (self.console_enabled(target, level) || self.file.enabled(target, level)) + } + + fn console_enabled(&self, target: &str, level: Level) -> bool { + level_is_enabled(self.console_max_level, level) && self.console.enabled(target, level) + } + + fn max_level(&self) -> LevelFilter { + self.console.max_level().max(self.file.max_level()) + } + + fn emit(&self, level: Level, target: &str, message: &str) { + let console_enabled = self.console_enabled(target, level); + let file_enabled = self.file.enabled(target, level); + if !console_enabled && !file_enabled { + return; + } + + let timestamp = timestamp_rfc3339_utc(); + if console_enabled { + let line = format_line(×tamp, level, target, message, self.color); + let _ = if matches!(level, Level::Error | Level::Warn) { + io::stderr().lock().write_all(line.as_bytes()) + } else { + io::stdout().lock().write_all(line.as_bytes()) + }; + } + + if file_enabled { + self.file.emit(×tamp, level, target, message); + } + } + + fn set_file_level(&self, level: LevelFilter) -> anyhow::Result<()> { + self.file + .set_level(level, self.console.max_level(), &self.active_max_level) + } + + fn file_level(&self) -> LevelFilter { + self.file.level() + } + + fn flush_file(&self) { + self.file.flush(); + } +} + +fn level_rank(level: LevelFilter) -> u8 { + match level { + LevelFilter::Off => 0, + LevelFilter::Error => 1, + LevelFilter::Warn => 2, + LevelFilter::Info => 3, + LevelFilter::Debug => 4, + LevelFilter::Trace => 5, + } +} + +fn level_is_enabled(max_level: u8, level: Level) -> bool { + max_level >= level_rank(level.to_level_filter()) +} + +impl log::Log for Logger { + fn enabled(&self, metadata: &LogMetadata<'_>) -> bool { + self.enabled(metadata.target(), metadata.level()) + } + + fn log(&self, record: &LogRecord<'_>) { + if self.enabled(record.target(), record.level()) { + self.emit(record.level(), record.target(), &record.args().to_string()); + } + } + + fn flush(&self) { + self.flush_file(); + } +} + +fn format_line(timestamp: &str, level: Level, target: &str, message: &str, color: bool) -> String { + let mut line = String::with_capacity(timestamp.len() + target.len() + message.len() + 32); + if color { + let color = match level { + Level::Error => "\x1b[31m", + Level::Warn => "\x1b[33m", + Level::Info => "\x1b[32m", + Level::Debug => "\x1b[34m", + Level::Trace => "\x1b[90m", + }; + let _ = writeln!( + line, + "{timestamp} {color}{level:<5}\x1b[0m {target}: {message}" + ); + } else { + let _ = writeln!(line, "{timestamp} {level:<5} {target}: {message}"); + } + line +} + +fn timestamp_rfc3339_utc() -> String { + let duration = SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap_or_default(); + let seconds = duration.as_secs(); + let seconds_of_day = seconds % 86_400; + let (year, month, day) = civil_date_from_unix_days((seconds / 86_400) as i64); + let hour = seconds_of_day / 3_600; + let minute = seconds_of_day % 3_600 / 60; + let second = seconds_of_day % 60; + + format!( + "{year:04}-{month:02}-{day:02}T{hour:02}:{minute:02}:{second:02}.{:03}Z", + duration.subsec_millis() + ) +} + +fn civil_date_from_unix_days(days: i64) -> (i64, i64, i64) { + let days = days + 719_468; + let era = if days >= 0 { days } else { days - 146_096 } / 146_097; + let day_of_era = days - era * 146_097; + let year_of_era = + (day_of_era - day_of_era / 1_460 + day_of_era / 36_524 - day_of_era / 146_096) / 365; + let mut year = year_of_era + era * 400; + let day_of_year = day_of_era - (365 * year_of_era + year_of_era / 4 - year_of_era / 100); + let month_prime = (5 * day_of_year + 2) / 153; + let day = day_of_year - (153 * month_prime + 2) / 5 + 1; + let month = month_prime + if month_prime < 10 { 3 } else { -9 }; + year += i64::from(month <= 2); + (year, month, day) +} + +fn tracing_level(level: &tracing::Level) -> Level { + match *level { + tracing::Level::ERROR => Level::Error, + tracing::Level::WARN => Level::Warn, + tracing::Level::INFO => Level::Info, + tracing::Level::DEBUG => Level::Debug, + tracing::Level::TRACE => Level::Trace, + } +} + +fn emit_event(logger: &Logger, event: &Event<'_>) { + let metadata = event.metadata(); + let level = tracing_level(metadata.level()); + if !logger.enabled(metadata.target(), level) { + return; + } + + let mut fields = EventFields::default(); + event.record(&mut fields); + logger.emit(level, metadata.target(), &fields.finish()); +} + +#[derive(Default)] +struct EventFields { + message: Option, + fields: String, +} + +impl EventFields { + fn write_field(&mut self, field: &Field, value: impl fmt::Display) { + if !self.fields.is_empty() { + self.fields.push(' '); + } + let _ = write!(self.fields, "{}={value}", field.name()); + } + + fn finish(self) -> String { + match (self.message, self.fields.is_empty()) { + (Some(message), false) => format!("{message} {}", self.fields), + (Some(message), true) => message, + (None, _) => self.fields, + } + } +} + +impl Visit for EventFields { + fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) { + if field.name() == "message" { + self.message = Some(format!("{value:?}")); + } else { + self.write_field(field, format_args!("{value:?}")); + } + } + + fn record_str(&mut self, field: &Field, value: &str) { + if field.name() == "message" { + self.message = Some(value.to_owned()); + } else { + self.write_field(field, format_args!("{value:?}")); + } + } + + fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) { + self.write_field(field, value); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[cfg(feature = "management")] + use crate::common::config::FileLoggerConfig; + + struct EnvVarGuard { + previous: Option, + } + + impl EnvVarGuard { + fn set(value: Option<&str>) -> Self { + let previous = std::env::var_os("RUST_LOG"); + match value { + Some(value) => unsafe { std::env::set_var("RUST_LOG", value) }, + None => unsafe { std::env::remove_var("RUST_LOG") }, + } + Self { previous } + } + } + + impl Drop for EnvVarGuard { + fn drop(&mut self) { + match &self.previous { + Some(value) => unsafe { std::env::set_var("RUST_LOG", value) }, + None => unsafe { std::env::remove_var("RUST_LOG") }, + } + } + } + + #[test] + #[serial_test::serial] + fn default_console_only_enables_core_info() { + let _env = EnvVarGuard::set(None); + let filter = TargetFilter::console(None).unwrap(); + + assert!(filter.enabled("CORE::peer", Level::Info)); + assert!(!filter.enabled("CORE", Level::Debug)); + assert!(!filter.enabled("other", Level::Error)); + } + + #[test] + #[serial_test::serial] + fn additional_default_console_targets_are_scoped() { + let _env = EnvVarGuard::set(None); + let filter = + TargetFilter::console_with_default_targets(None, &[LOG_TARGET, "easytier_web"]) + .unwrap(); + + assert!(filter.enabled("CORE::peer", Level::Info)); + assert!(filter.enabled("easytier_web::client_manager", Level::Info)); + assert!(!filter.enabled("easytier_web", Level::Debug)); + assert!(!filter.enabled("other", Level::Error)); + } + + #[test] + fn rust_log_supports_global_and_target_levels() { + let filter = TargetFilter::parse("warn,easytier_core=debug,hyper=off") + .unwrap() + .unwrap(); + + assert!(filter.enabled("easytier_core::peers", Level::Debug)); + assert!(!filter.enabled("hyper::client", Level::Error)); + assert!(!filter.enabled("other", Level::Info)); + assert!(filter.enabled("other", Level::Warn)); + } + + #[test] + fn rust_log_target_without_level_enables_trace() { + let filter = TargetFilter::parse("easytier_core").unwrap().unwrap(); + + assert!(filter.enabled("easytier_core::peer", Level::Trace)); + assert!(!filter.enabled("other", Level::Error)); + } + + #[test] + fn formatting_is_compact_and_color_is_optional() { + let plain = format_line( + "2026-07-22T12:00:00+08:00", + Level::Info, + "CORE", + "ready", + false, + ); + let colored = format_line( + "2026-07-22T12:00:00+08:00", + Level::Info, + "CORE", + "ready", + true, + ); + + assert_eq!(plain, "2026-07-22T12:00:00+08:00 INFO CORE: ready\n"); + assert!(colored.contains("\x1b[32mINFO \x1b[0m")); + } + + #[test] + fn unix_day_conversion_matches_known_dates() { + assert_eq!(civil_date_from_unix_days(0), (1970, 1, 1)); + assert_eq!(civil_date_from_unix_days(20_656), (2026, 7, 22)); + } + + #[test] + #[cfg(feature = "management")] + fn default_file_logger_is_not_opened_without_reload() { + let file = FileSink::from_config(FileLoggerConfig::default(), false).unwrap(); + assert!(!file.is_open()); + } + + #[test] + #[cfg(feature = "management")] + #[serial_test::serial] + fn file_logger_uses_rust_log_when_enabled() { + let _env = EnvVarGuard::set(Some("debug")); + let temp_dir = tempfile::tempdir().unwrap(); + let log_path = temp_dir.path().join("env-filter.log"); + let config = FileLoggerConfig { + level: Some("info".to_owned()), + file: Some("env-filter.log".to_owned()), + dir: Some(temp_dir.path().to_string_lossy().into_owned()), + ..Default::default() + }; + let file = FileSink::from_config(config, true).unwrap(); + let logger = Logger::new(TargetFilter::off(), file); + + logger.emit(Level::Debug, LOG_TARGET, "env-filter-marker"); + logger.flush_file(); + + let content = std::fs::read_to_string(log_path).unwrap(); + assert!(content.contains("env-filter-marker")); + } + + #[test] + #[cfg(feature = "management")] + #[serial_test::serial] + fn reloading_file_logger_preserves_rust_log_and_supports_off() { + let _env = EnvVarGuard::set(Some("debug")); + let temp_dir = tempfile::tempdir().unwrap(); + let log_path = temp_dir.path().join("reload.log"); + let config = FileLoggerConfig { + file: Some("reload.log".to_owned()), + dir: Some(temp_dir.path().to_string_lossy().into_owned()), + ..Default::default() + }; + let file = FileSink::from_config(config, true).unwrap(); + let logger = std::sync::Arc::new(Logger::new(TargetFilter::off(), file)); + + assert_eq!( + logger.active_max_level.load(Ordering::Relaxed), + level_rank(LevelFilter::Off) + ); + + let barrier = std::sync::Arc::new(std::sync::Barrier::new(9)); + let threads = (0..8) + .map(|thread_index| { + let logger = logger.clone(); + let barrier = barrier.clone(); + std::thread::spawn(move || { + barrier.wait(); + for iteration in 0..500 { + let level = if (thread_index + iteration) % 2 == 0 { + LevelFilter::Info + } else { + LevelFilter::Off + }; + logger.set_file_level(level).unwrap(); + } + }) + }) + .collect::>(); + barrier.wait(); + for thread in threads { + thread.join().unwrap(); + } + + logger.file.assert_level_state( + logger.console_max_level, + logger.active_max_level.load(Ordering::Relaxed), + ); + + logger.set_file_level(LevelFilter::Info).unwrap(); + assert_eq!( + logger.active_max_level.load(Ordering::Relaxed), + level_rank(LevelFilter::Debug) + ); + assert_eq!(logger.file.max_level_rank(), level_rank(LevelFilter::Debug)); + logger.emit(Level::Debug, LOG_TARGET, "enabled-by-env"); + logger.set_file_level(LevelFilter::Off).unwrap(); + assert_eq!( + logger.active_max_level.load(Ordering::Relaxed), + level_rank(LevelFilter::Off) + ); + logger.emit(Level::Error, LOG_TARGET, "disabled-despite-env"); + logger.flush_file(); + + let content = std::fs::read_to_string(log_path).unwrap(); + assert!(content.contains("enabled-by-env")); + assert!(!content.contains("disabled-despite-env")); + assert_eq!(logger.file_level(), LevelFilter::Off); + } + + #[test] + #[cfg(all(feature = "management", not(feature = "tracing")))] + #[serial_test::serial] + fn tracing_events_and_direct_log_records_share_the_file_sink() { + let _env = EnvVarGuard::set(None); + let temp_dir = tempfile::tempdir().unwrap(); + let log_path = temp_dir.path().join("shared-sink.log"); + let config = FileLoggerConfig { + level: Some("info".to_owned()), + file: Some("shared-sink.log".to_owned()), + dir: Some(temp_dir.path().to_string_lossy().into_owned()), + ..Default::default() + }; + let file = FileSink::from_config(config, false).unwrap(); + let logger = Box::leak(Box::new(Logger::new(TargetFilter::off(), file))); + let dispatch = tracing::Dispatch::new(tracing_backend::EventSubscriber::new(logger)); + + tracing::dispatcher::with_default(&dispatch, || { + let span = tracing::info_span!(target: LOG_TARGET, "ignored-span", peer = 7); + let _entered = span.enter(); + tracing::info!(target: LOG_TARGET, answer = 42, "tracing-event"); + }); + log::Log::log( + logger, + &LogRecord::builder() + .level(Level::Info) + .target("dependency") + .args(format_args!("direct-log-record")) + .build(), + ); + logger.flush_file(); + + let content = std::fs::read_to_string(log_path).unwrap(); + assert!(content.contains("tracing-event answer=42")); + assert!(content.contains("direct-log-record")); + assert!(!content.contains("ignored-span")); + } +} diff --git a/vendor/easytier/easytier/src/common/log/tracing_backend.rs b/vendor/easytier/easytier/src/common/log/tracing_backend.rs new file mode 100644 index 0000000..4d2842f --- /dev/null +++ b/vendor/easytier/easytier/src/common/log/tracing_backend.rs @@ -0,0 +1,121 @@ +#[cfg(not(feature = "tracing"))] +use std::sync::atomic::{AtomicUsize, Ordering}; + +#[cfg(feature = "tracing")] +use tracing::{Event, subscriber::SetGlobalDefaultError}; +#[cfg(not(feature = "tracing"))] +use tracing::{ + Metadata, + span::{Attributes, Id, Record as SpanRecord}, + subscriber::{Interest, SetGlobalDefaultError}, +}; +#[cfg(feature = "tracing")] +use tracing_subscriber::prelude::*; + +#[cfg(not(feature = "tracing"))] +use super::tracing_level; +use super::{Logger, emit_event}; + +#[cfg(not(feature = "tracing"))] +pub(super) fn install(logger: &'static Logger) -> Result<(), SetGlobalDefaultError> { + tracing::subscriber::set_global_default(EventSubscriber::new(logger)) +} + +#[cfg(feature = "tracing")] +pub(super) fn install(logger: &'static Logger) -> Result<(), SetGlobalDefaultError> { + let subscriber = tracing_subscriber::registry() + .with(console_subscriber::ConsoleLayer::builder().spawn()) + .with(EventLayer(logger)); + tracing::subscriber::set_global_default(subscriber) +} + +#[cfg(feature = "tracing")] +struct EventLayer(&'static Logger); + +#[cfg(feature = "tracing")] +impl tracing_subscriber::Layer for EventLayer +where + S: tracing::Subscriber, +{ + fn on_event(&self, event: &Event<'_>, _ctx: tracing_subscriber::layer::Context<'_, S>) { + emit_event(self.0, event); + } +} + +#[cfg(not(feature = "tracing"))] +pub(super) struct EventSubscriber { + logger: &'static Logger, + next_span_id: AtomicUsize, +} + +#[cfg(not(feature = "tracing"))] +impl EventSubscriber { + pub(super) fn new(logger: &'static Logger) -> Self { + Self { + logger, + next_span_id: AtomicUsize::new(1), + } + } +} + +#[cfg(not(feature = "tracing"))] +impl tracing::Subscriber for EventSubscriber { + fn enabled(&self, metadata: &Metadata<'_>) -> bool { + metadata.is_event() + && self + .logger + .enabled(metadata.target(), tracing_level(metadata.level())) + } + + fn new_span(&self, _attributes: &Attributes<'_>) -> Id { + let id = self + .next_span_id + .fetch_update(Ordering::Relaxed, Ordering::Relaxed, |id| { + Some(if id == usize::MAX { 1 } else { id + 1 }) + }) + .expect("span id update always succeeds"); + Id::from_u64(id as u64) + } + + fn record(&self, _span: &Id, _values: &SpanRecord<'_>) {} + + fn record_follows_from(&self, _span: &Id, _follows: &Id) {} + + fn event(&self, event: &tracing::Event<'_>) { + emit_event(self.logger, event); + } + + fn enter(&self, _span: &Id) {} + + fn exit(&self, _span: &Id) {} + + fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest { + if metadata.is_event() { + Interest::sometimes() + } else { + Interest::never() + } + } + + fn max_level_hint(&self) -> Option { + if self.logger.file.dynamic() { + return Some(tracing::level_filters::LevelFilter::TRACE); + } + Some(match self.logger.max_level() { + log::LevelFilter::Off => tracing::level_filters::LevelFilter::OFF, + log::LevelFilter::Error => tracing::level_filters::LevelFilter::ERROR, + log::LevelFilter::Warn => tracing::level_filters::LevelFilter::WARN, + log::LevelFilter::Info => tracing::level_filters::LevelFilter::INFO, + log::LevelFilter::Debug => tracing::level_filters::LevelFilter::DEBUG, + log::LevelFilter::Trace => tracing::level_filters::LevelFilter::TRACE, + }) + } + + fn clone_span(&self, id: &Id) -> Id { + id.clone() + } + + fn try_close(&self, _id: Id) -> bool { + true + } +} diff --git a/vendor/easytier/easytier/src/common/machine_id.rs b/vendor/easytier/easytier/src/common/machine_id.rs new file mode 100644 index 0000000..ce90424 --- /dev/null +++ b/vendor/easytier/easytier/src/common/machine_id.rs @@ -0,0 +1,596 @@ +use std::{ + env, + ffi::OsString, + io::Write as _, + path::{Path, PathBuf}, + time::{Duration, Instant}, +}; + +use anyhow::Context as _; +#[cfg(unix)] +use nix::{ + errno::Errno, + fcntl::{Flock, FlockArg}, +}; + +#[derive(Debug, Clone, Default)] +pub struct MachineIdOptions { + pub explicit_machine_id: Option, + pub state_dir: Option, +} + +pub fn resolve_machine_id(opts: &MachineIdOptions) -> anyhow::Result { + if let Some(explicit_machine_id) = opts.explicit_machine_id.as_deref() { + return Ok(parse_or_hash_machine_id(explicit_machine_id)); + } + + let state_file = resolve_machine_id_state_file(opts.state_dir.as_deref())?; + let allow_legacy_machine_uid_migration = + should_attempt_legacy_machine_uid_migration(&state_file); + if let Some(machine_id) = read_state_machine_id(&state_file)? { + return Ok(machine_id); + } + + if let Some(machine_id) = read_legacy_machine_id_file() { + return persist_machine_id(&state_file, machine_id); + } + + if allow_legacy_machine_uid_migration + && let Some(machine_id) = resolve_legacy_machine_uid_hash() + { + return persist_machine_id(&state_file, machine_id); + } + + let machine_id = resolve_new_machine_id().unwrap_or_else(uuid::Uuid::new_v4); + persist_machine_id(&state_file, machine_id) +} + +fn parse_or_hash_machine_id(raw: &str) -> uuid::Uuid { + if let Ok(mid) = uuid::Uuid::parse_str(raw.trim()) { + return mid; + } + digest_uuid_from_str(raw) +} + +fn digest_uuid_from_str(raw: &str) -> uuid::Uuid { + let mut b = [0u8; 16]; + crate::tunnel::generate_digest_from_str("", raw, &mut b); + uuid::Uuid::from_bytes(b) +} + +fn resolve_machine_id_state_file(state_dir: Option<&Path>) -> anyhow::Result { + let state_dir = match state_dir { + Some(dir) => dir.to_path_buf(), + None => default_machine_id_state_dir()?, + }; + Ok(state_dir.join("machine_id")) +} + +fn non_empty_os_string(value: Option) -> Option { + value.filter(|value| !value.is_empty()) +} + +#[cfg(target_os = "linux")] +fn default_linux_machine_id_state_dir( + xdg_data_home: Option, + home: Option, +) -> PathBuf { + if let Some(path) = non_empty_os_string(xdg_data_home) { + return PathBuf::from(path).join("easytier"); + } + + if let Some(home) = non_empty_os_string(home) { + return PathBuf::from(home) + .join(".local") + .join("share") + .join("easytier"); + } + + PathBuf::from("/var/lib/easytier") +} + +fn default_machine_id_state_dir() -> anyhow::Result { + cfg_select! { + target_os = "linux" => Ok(default_linux_machine_id_state_dir( + env::var_os("XDG_DATA_HOME"), + env::var_os("HOME"), + )), + all(target_os = "macos", not(feature = "macos-ne")) => { + let home = non_empty_os_string(env::var_os("HOME")) + .ok_or_else(|| anyhow::anyhow!("HOME is not set, cannot resolve machine id state directory"))?; + Ok(PathBuf::from(home) + .join("Library") + .join("Application Support") + .join("com.easytier")) + }, + target_os = "windows" => { + let local_app_data = non_empty_os_string(env::var_os("LOCALAPPDATA")).ok_or_else(|| { + anyhow::anyhow!("LOCALAPPDATA is not set, cannot resolve machine id state directory") + })?; + Ok(PathBuf::from(local_app_data).join("easytier")) + }, + target_os = "freebsd" => { + let home = non_empty_os_string(env::var_os("HOME")) + .ok_or_else(|| anyhow::anyhow!("HOME is not set, cannot resolve machine id state directory"))?; + Ok(PathBuf::from(home).join(".local").join("share").join("easytier")) + }, + target_os = "android" => { + anyhow::bail!("machine id state directory must be provided explicitly on Android"); + }, + _ => anyhow::bail!("machine id state directory is unsupported on this platform"), + } +} + +fn read_state_machine_id(path: &Path) -> anyhow::Result> { + let Some(contents) = read_optional_file(path)? else { + return Ok(None); + }; + + let machine_id = uuid::Uuid::parse_str(contents.trim()) + .with_context(|| format!("invalid machine id in state file {}", path.display()))?; + Ok(Some(machine_id)) +} + +fn read_legacy_machine_id_file() -> Option { + let path = legacy_machine_id_file_path()?; + read_legacy_machine_id_file_at(&path) +} + +fn read_legacy_machine_id_file_at(path: &Path) -> Option { + let contents = match std::fs::read_to_string(path) { + Ok(contents) => contents, + Err(err) if err.kind() == std::io::ErrorKind::NotFound => return None, + Err(err) => { + tracing::warn!( + path = %path.display(), + %err, + "ignoring unreadable legacy machine id file" + ); + return None; + } + }; + + match uuid::Uuid::parse_str(contents.trim()) { + Ok(machine_id) => Some(machine_id), + Err(err) => { + tracing::warn!( + path = %path.display(), + %err, + "ignoring invalid legacy machine id file" + ); + None + } + } +} + +fn legacy_machine_id_file_path() -> Option { + std::env::current_exe() + .ok() + .map(|path| path.with_file_name("et_machine_id")) +} + +fn read_optional_file(path: &Path) -> anyhow::Result> { + match std::fs::read_to_string(path) { + Ok(contents) => Ok(Some(contents)), + Err(err) if err.kind() == std::io::ErrorKind::NotFound => Ok(None), + Err(err) => Err(err).with_context(|| format!("failed to read {}", path.display())), + } +} + +fn should_attempt_legacy_machine_uid_migration(state_file: &Path) -> bool { + let Some(state_dir) = state_file.parent() else { + return false; + }; + + let Ok(mut entries) = std::fs::read_dir(state_dir) else { + return false; + }; + entries.any(|entry| entry.is_ok()) +} + +fn resolve_legacy_machine_uid_hash() -> Option { + machine_uid_seed().map(|seed| digest_uuid_from_str(seed.as_str())) +} + +fn resolve_new_machine_id() -> Option { + let seed = machine_uid_seed()?; + + #[cfg(target_os = "linux")] + { + let seed = linux_machine_id_seed(&seed); + Some(digest_uuid_from_str(&seed)) + } + + #[cfg(not(target_os = "linux"))] + { + Some(digest_uuid_from_str(&seed)) + } +} + +#[cfg(any( + target_os = "linux", + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "windows", + target_os = "freebsd" +))] +fn machine_uid_seed() -> Option { + machine_uid::get() + .ok() + .filter(|value| !value.trim().is_empty()) +} + +#[cfg(not(any( + target_os = "linux", + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "windows", + target_os = "freebsd" +)))] +fn machine_uid_seed() -> Option { + None +} + +#[cfg(target_os = "linux")] +fn linux_machine_id_seed(machine_uid: &str) -> String { + let mut seed = format!("machine_uid={machine_uid}"); + + let hostname = gethostname::gethostname() + .to_string_lossy() + .trim() + .to_string(); + if !hostname.is_empty() { + seed.push_str("\nhostname="); + seed.push_str(&hostname); + } + + let mac_addresses = collect_linux_mac_addresses(); + if !mac_addresses.is_empty() { + seed.push_str("\nmacs="); + seed.push_str(&mac_addresses.join(",")); + } + + seed +} + +#[cfg(target_os = "linux")] +fn collect_linux_mac_addresses() -> Vec { + let mut macs = Vec::new(); + let Ok(entries) = std::fs::read_dir("/sys/class/net") else { + return macs; + }; + + for entry in entries.flatten() { + let Ok(name) = entry.file_name().into_string() else { + continue; + }; + if name == "lo" { + continue; + } + + let address_path = entry.path().join("address"); + let Ok(address) = std::fs::read_to_string(address_path) else { + continue; + }; + let address = address.trim().to_ascii_lowercase(); + if address.is_empty() || address == "00:00:00:00:00:00" { + continue; + } + macs.push(address); + } + + macs.sort(); + macs.dedup(); + macs.truncate(3); + macs +} + +fn persist_machine_id(path: &Path, machine_id: uuid::Uuid) -> anyhow::Result { + if let Some(existing) = read_state_machine_id(path)? { + return Ok(existing); + } + + let _lock = MachineIdWriteLock::acquire(path)?; + + if let Some(existing) = read_state_machine_id(path)? { + return Ok(existing); + } + + write_uuid_file_atomically(path, machine_id)?; + Ok(machine_id) +} + +fn write_uuid_file_atomically(path: &Path, machine_id: uuid::Uuid) -> anyhow::Result<()> { + let parent = path.parent().ok_or_else(|| { + anyhow::anyhow!( + "machine id state file {} has no parent directory", + path.display() + ) + })?; + std::fs::create_dir_all(parent).with_context(|| { + format!( + "failed to create machine id state directory {}", + parent.display() + ) + })?; + + let tmp_path = parent.join(format!( + ".machine_id.tmp-{}-{}", + std::process::id(), + uuid::Uuid::new_v4() + )); + { + let mut file = std::fs::OpenOptions::new() + .write(true) + .create_new(true) + .open(&tmp_path) + .with_context(|| format!("failed to create {}", tmp_path.display()))?; + file.write_all(machine_id.to_string().as_bytes()) + .with_context(|| format!("failed to write {}", tmp_path.display()))?; + file.sync_all() + .with_context(|| format!("failed to flush {}", tmp_path.display()))?; + } + + if let Err(err) = std::fs::rename(&tmp_path, path) { + let _ = std::fs::remove_file(&tmp_path); + return Err(err).with_context(|| { + format!( + "failed to move machine id state file into place at {}", + path.display() + ) + }); + } + + Ok(()) +} + +struct MachineIdWriteLock { + #[cfg(unix)] + _lock: Flock, + #[cfg(not(unix))] + path: PathBuf, +} + +impl MachineIdWriteLock { + fn acquire(path: &Path) -> anyhow::Result { + let parent = path.parent().ok_or_else(|| { + anyhow::anyhow!( + "machine id state file {} has no parent directory", + path.display() + ) + })?; + std::fs::create_dir_all(parent).with_context(|| { + format!( + "failed to create machine id state directory {}", + parent.display() + ) + })?; + + #[cfg(unix)] + { + Self::acquire_unix(path) + } + + #[cfg(not(unix))] + { + Self::acquire_fallback(path) + } + } + + #[cfg(unix)] + fn acquire_unix(path: &Path) -> anyhow::Result { + let lock_path = path.with_extension("lock"); + let deadline = Instant::now() + Duration::from_secs(5); + let mut lock_file = std::fs::OpenOptions::new() + .read(true) + .write(true) + .create(true) + .truncate(false) + .open(&lock_path) + .with_context(|| format!("failed to open machine id lock {}", lock_path.display()))?; + + loop { + match Flock::lock(lock_file, FlockArg::LockExclusiveNonblock) { + Ok(lock) => return Ok(Self { _lock: lock }), + Err((file, Errno::EAGAIN)) => { + if Instant::now() >= deadline { + anyhow::bail!( + "timed out waiting for machine id lock {}", + lock_path.display() + ); + } + lock_file = file; + std::thread::sleep(Duration::from_millis(50)); + } + Err((_file, err)) => { + anyhow::bail!( + "failed to acquire machine id lock {}: {}", + lock_path.display(), + err + ); + } + } + } + } + + #[cfg(not(unix))] + fn acquire_fallback(path: &Path) -> anyhow::Result { + let lock_path = path.with_extension("lock"); + let deadline = Instant::now() + Duration::from_secs(5); + + loop { + match std::fs::OpenOptions::new() + .write(true) + .create_new(true) + .open(&lock_path) + { + Ok(mut file) => { + writeln!(file, "pid={}", std::process::id()).ok(); + return Ok(Self { path: lock_path }); + } + Err(err) if err.kind() == std::io::ErrorKind::AlreadyExists => { + if should_reap_stale_lock_file(&lock_path) { + let _ = std::fs::remove_file(&lock_path); + continue; + } + if Instant::now() >= deadline { + anyhow::bail!( + "timed out waiting for machine id lock {}", + lock_path.display() + ); + } + std::thread::sleep(Duration::from_millis(50)); + } + Err(err) => { + return Err(err).with_context(|| { + format!("failed to acquire machine id lock {}", lock_path.display()) + }); + } + } + } + } +} + +#[cfg(not(unix))] +fn should_reap_stale_lock_file(lock_path: &Path) -> bool { + const STALE_LOCK_AGE: Duration = Duration::from_secs(30); + + let Ok(metadata) = std::fs::metadata(lock_path) else { + return false; + }; + let Ok(modified) = metadata.modified() else { + return false; + }; + modified + .elapsed() + .is_ok_and(|elapsed| elapsed >= STALE_LOCK_AGE) +} + +impl Drop for MachineIdWriteLock { + fn drop(&mut self) { + #[cfg(not(unix))] + let _ = std::fs::remove_file(&self.path); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_resolve_machine_id_uses_uuid_seed_verbatim() { + let raw = "33333333-3333-3333-3333-333333333333".to_string(); + let opts = MachineIdOptions { + explicit_machine_id: Some(raw.clone()), + state_dir: None, + }; + assert_eq!( + resolve_machine_id(&opts).unwrap(), + uuid::Uuid::parse_str(&raw).unwrap() + ); + } + + #[test] + fn test_resolve_machine_id_reads_state_file() { + let temp_dir = tempfile::tempdir().unwrap(); + let expected = uuid::Uuid::new_v4(); + std::fs::write(temp_dir.path().join("machine_id"), expected.to_string()).unwrap(); + + let opts = MachineIdOptions { + explicit_machine_id: None, + state_dir: Some(temp_dir.path().to_path_buf()), + }; + + assert_eq!(resolve_machine_id(&opts).unwrap(), expected); + } + + #[test] + fn test_read_legacy_machine_id_file_ignores_read_errors() { + let temp_dir = tempfile::tempdir().unwrap(); + + assert_eq!(read_legacy_machine_id_file_at(temp_dir.path()), None); + } + + #[test] + fn test_write_uuid_file_atomically_writes_expected_contents() { + let temp_dir = tempfile::tempdir().unwrap(); + let machine_id = uuid::Uuid::new_v4(); + let state_file = temp_dir.path().join("machine_id"); + + write_uuid_file_atomically(&state_file, machine_id).unwrap(); + + assert_eq!( + std::fs::read_to_string(state_file).unwrap(), + machine_id.to_string() + ); + } + + #[test] + fn test_non_empty_os_string_filters_empty_values() { + assert_eq!(non_empty_os_string(Some(OsString::new())), None); + assert_eq!( + non_empty_os_string(Some(OsString::from("foo"))), + Some(OsString::from("foo")) + ); + } + + #[cfg(target_os = "linux")] + #[test] + fn test_default_linux_machine_id_state_dir_falls_back_in_order() { + assert_eq!( + default_linux_machine_id_state_dir( + Some(OsString::from("/tmp/xdg")), + Some(OsString::from("/tmp/home")) + ), + PathBuf::from("/tmp/xdg").join("easytier") + ); + assert_eq!( + default_linux_machine_id_state_dir( + Some(OsString::new()), + Some(OsString::from("/tmp/home")) + ), + PathBuf::from("/tmp/home") + .join(".local") + .join("share") + .join("easytier") + ); + assert_eq!( + default_linux_machine_id_state_dir(Some(OsString::new()), Some(OsString::new())), + PathBuf::from("/var/lib/easytier") + ); + } + + #[test] + fn test_persist_machine_id_creates_missing_state_dir() { + let temp_dir = tempfile::tempdir().unwrap(); + let state_file = temp_dir.path().join("nested").join("machine_id"); + let machine_id = uuid::Uuid::new_v4(); + + assert_eq!( + persist_machine_id(&state_file, machine_id).unwrap(), + machine_id + ); + assert_eq!( + std::fs::read_to_string(state_file).unwrap(), + machine_id.to_string() + ); + } + + #[test] + fn test_legacy_machine_uid_migration_requires_existing_state_dir_content() { + let temp_dir = tempfile::tempdir().unwrap(); + let missing_state_file = temp_dir.path().join("missing").join("machine_id"); + assert!(!should_attempt_legacy_machine_uid_migration( + &missing_state_file + )); + + let empty_dir = temp_dir.path().join("empty"); + std::fs::create_dir_all(&empty_dir).unwrap(); + assert!(!should_attempt_legacy_machine_uid_migration( + &empty_dir.join("machine_id") + )); + + std::fs::write(empty_dir.join("config.toml"), "x=1").unwrap(); + assert!(should_attempt_legacy_machine_uid_migration( + &empty_dir.join("machine_id") + )); + } +} diff --git a/vendor/easytier/easytier/src/common/mod.rs b/vendor/easytier/easytier/src/common/mod.rs new file mode 100644 index 0000000..aa88b3e --- /dev/null +++ b/vendor/easytier/easytier/src/common/mod.rs @@ -0,0 +1,34 @@ +pub mod config; +pub mod constants; +#[cfg(feature = "management")] +pub mod credential_manager; +pub mod dns; +#[cfg(feature = "management")] +pub mod env_parser; +pub mod error; +pub mod global_ctx; +pub mod ifcfg; +#[cfg(feature = "logging")] +pub mod log; +pub mod machine_id; +pub mod netns; +pub mod network; +#[cfg(feature = "management")] +pub mod os_info; +pub mod stun; +#[cfg(feature = "management")] +pub mod tracing_rolling_appender; +#[cfg(feature = "upnp")] +pub mod upnp; + +pub use machine_id::{MachineIdOptions, resolve_machine_id}; + +pub fn shrink_dashmap( + map: &dashmap::DashMap, + threshold: Option, +) { + let threshold = threshold.unwrap_or(16); + if map.capacity() - map.len() > threshold { + map.shrink_to_fit(); + } +} diff --git a/vendor/easytier/easytier/src/common/netns.rs b/vendor/easytier/easytier/src/common/netns.rs new file mode 100644 index 0000000..a998e38 --- /dev/null +++ b/vendor/easytier/easytier/src/common/netns.rs @@ -0,0 +1,123 @@ +use easytier_core::socket::SocketContext; +use futures::Future; + +#[cfg(target_os = "linux")] +use nix::sched::{CloneFlags, setns}; +#[cfg(target_os = "linux")] +use std::os::fd::AsFd; + +pub struct NetNSGuard { + #[cfg(target_os = "linux")] + old_ns: Option, +} + +pub static ROOT_NETNS_NAME: &str = "_root_ns"; + +#[cfg(target_os = "linux")] +impl NetNSGuard { + pub fn new(ns: Option) -> Box { + let old_ns = if ns.is_some() { + let old_ns = if cfg!(target_os = "linux") { + Some(std::fs::File::open("/proc/self/ns/net").unwrap()) + } else { + None + }; + Self::switch_ns(ns); + old_ns + } else { + None + }; + Box::new(NetNSGuard { old_ns }) + } + + fn switch_ns(name: Option) { + if name.is_none() { + return; + } + + let name = name.unwrap(); + let ns_path: String = if name == ROOT_NETNS_NAME { + "/proc/1/ns/net".to_string() + } else { + format!("/var/run/netns/{}", name) + }; + + let ns = std::fs::File::open(ns_path).unwrap(); + tracing::info!( + "[INIT NS] switching to new ns_name: {:?}, ns_file: {:?}", + name, + ns + ); + + setns(ns.as_fd(), CloneFlags::CLONE_NEWNET).unwrap(); + } +} + +#[cfg(target_os = "linux")] +impl Drop for NetNSGuard { + fn drop(&mut self) { + if self.old_ns.is_none() { + return; + } + tracing::info!("[INIT NS] switching back to old ns, ns: {:?}", self.old_ns); + setns( + self.old_ns.as_ref().unwrap().as_fd(), + CloneFlags::CLONE_NEWNET, + ) + .unwrap(); + } +} + +#[cfg(not(target_os = "linux"))] +impl NetNSGuard { + pub fn new(_ns: Option) -> Box { + Box::new(NetNSGuard {}) + } +} + +#[derive(Clone, Debug, PartialEq, Eq, Hash)] +pub struct NetNS { + name: Option, +} + +impl NetNS { + pub fn new(name: Option) -> Self { + NetNS { name } + } + + pub fn from_socket_context(context: &SocketContext) -> Self { + Self::new( + context + .netns + .as_ref() + .map(|namespace| namespace.token().to_owned()), + ) + } + + pub async fn run_async(&self, f: F) -> Ret + where + F: FnOnce() -> Fut, + Fut: Future, + { + // TODO: do we really need this lock + // let _lock = LOCK.lock().await; + let _guard = NetNSGuard::new(self.name.clone()); + f().await + } + + pub fn run(&self, f: F) -> Ret + where + F: FnOnce() -> Ret, + { + let _guard = NetNSGuard::new(self.name.clone()); + f() + } + + pub fn guard(&self) -> Box { + NetNSGuard::new(self.name.clone()) + } + + pub fn name(&self) -> Option { + self.name.clone() + } +} diff --git a/vendor/easytier/easytier/src/common/network.rs b/vendor/easytier/easytier/src/common/network.rs new file mode 100644 index 0000000..c0089f4 --- /dev/null +++ b/vendor/easytier/easytier/src/common/network.rs @@ -0,0 +1,513 @@ +use std::{collections::HashMap, net::IpAddr}; + +use network_interface::{NetworkInterface, NetworkInterfaceConfig}; +#[cfg(all(target_os = "macos", not(feature = "macos-ne")))] +use tokio::sync::Mutex; + +use crate::proto::peer_rpc::GetIpListResponse; + +use super::netns::NetNS; + +#[derive(Clone, Copy, Debug, Default)] +struct InterfaceState { + is_point_to_point: bool, + is_loopback: bool, + is_up: bool, + #[cfg(target_os = "linux")] + is_lower_up: bool, +} + +#[cfg(any( + all(target_os = "linux", not(target_env = "ohos")), + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" +))] +fn collect_interface_states() -> HashMap { + let mut states = HashMap::new(); + if let Ok(interfaces) = nix::ifaddrs::getifaddrs() { + use nix::net::if_::InterfaceFlags; + + for interface in interfaces { + let flags = interface.flags; + #[cfg(target_os = "linux")] + let is_lower_up = flags.contains(InterfaceFlags::IFF_LOWER_UP); + states.insert( + interface.interface_name, + InterfaceState { + is_point_to_point: flags.contains(InterfaceFlags::IFF_POINTOPOINT), + is_loopback: flags.contains(InterfaceFlags::IFF_LOOPBACK), + is_up: flags.contains(InterfaceFlags::IFF_UP), + #[cfg(target_os = "linux")] + is_lower_up, + }, + ); + } + } + states +} + +#[cfg(not(any( + all(target_os = "linux", not(target_env = "ohos")), + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" +)))] +fn collect_interface_states() -> HashMap { + HashMap::new() +} + +#[cfg(any(target_os = "freebsd", target_os = "windows"))] +fn has_nonzero_mac(iface: &NetworkInterface) -> bool { + iface.mac_addr.as_deref().is_some_and(|mac| { + let mut octets = mac.split([':', '-']); + let mut nonzero = false; + for _ in 0..6 { + let Some(value) = octets + .next() + .and_then(|octet| u8::from_str_radix(octet, 16).ok()) + else { + return false; + }; + nonzero |= value != 0; + } + octets.next().is_none() && nonzero + }) +} + +#[allow(dead_code)] +pub(crate) fn ip_mask_to_prefix(mask: IpAddr) -> Result { + match mask { + IpAddr::V4(mask) => { + let raw = u32::from(mask); + let prefix = raw.leading_ones() as u8; + let expected = if prefix == 0 { + 0 + } else { + u32::MAX << (32 - prefix) + }; + (raw == expected).then_some(prefix).ok_or(()) + } + IpAddr::V6(mask) => { + let raw = u128::from(mask); + let prefix = raw.leading_ones() as u8; + let expected = if prefix == 0 { + 0 + } else { + u128::MAX << (128 - prefix) + }; + (raw == expected).then_some(prefix).ok_or(()) + } + } +} + +struct InterfaceFilter { + iface: NetworkInterface, + state: InterfaceState, +} + +fn interface_state( + iface: &NetworkInterface, + states: &HashMap, +) -> InterfaceState { + states.get(&iface.name).copied().unwrap_or(InterfaceState { + is_loopback: iface.internal, + is_up: true, + #[cfg(target_os = "linux")] + is_lower_up: true, + ..Default::default() + }) +} + +#[cfg(any( + target_os = "android", + target_os = "ios", + all(target_os = "macos", feature = "macos-ne"), + target_env = "ohos" +))] +impl InterfaceFilter { + async fn filter_iface(&self) -> bool { + true + } +} + +#[cfg(all(target_os = "linux", not(target_env = "ohos")))] +impl InterfaceFilter { + async fn is_tun_tap_device(&self) -> bool { + let path = format!("/sys/class/net/{}/tun_flags", self.iface.name); + tokio::fs::metadata(&path).await.is_ok() + } + + async fn has_valid_ip(&self) -> bool { + self.iface + .addr + .iter() + .map(|ip| ip.ip()) + .any(|ip| !ip.is_loopback() && !ip.is_unspecified() && !ip.is_multicast()) + } + + async fn filter_iface(&self) -> bool { + tracing::trace!( + "filter linux iface: {:?}, is_point_to_point: {}, is_loopback: {}, is_up: {}, is_lower_up: {}, is_tun: {}, has_valid_ip: {}", + self.iface, + self.state.is_point_to_point, + self.state.is_loopback, + self.state.is_up, + self.state.is_lower_up, + self.is_tun_tap_device().await, + self.has_valid_ip().await + ); + + !self.state.is_point_to_point + && !self.state.is_loopback + && self.state.is_up + && self.state.is_lower_up + && !self.is_tun_tap_device().await + && self.has_valid_ip().await + } +} + +// Cache for networksetup command output +#[cfg(all(target_os = "macos", not(feature = "macos-ne")))] +static NETWORKSETUP_CACHE: std::sync::OnceLock> = + std::sync::OnceLock::new(); + +#[cfg(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" +))] +impl InterfaceFilter { + #[cfg(all(target_os = "macos", not(feature = "macos-ne")))] + async fn get_networksetup_output() -> String { + use anyhow::Context; + use std::time::{Duration, Instant}; + let cache = NETWORKSETUP_CACHE.get_or_init(|| Mutex::new((String::new(), Instant::now()))); + let mut cache_guard = cache.lock().await; + + // Check if cache is still valid (less than 1 minute old) + if cache_guard.1.elapsed() < Duration::from_secs(60) && !cache_guard.0.is_empty() { + return cache_guard.0.clone(); + } + + // Cache is expired or empty, fetch new data + // The embedding application may own SIGCHLD handlers or other Tokio + // runtimes. Reap this child on the blocking pool, as for macOS ifcfg. + let stdout = tokio::task::spawn_blocking(|| { + std::process::Command::new("/usr/sbin/networksetup") + .args(["-listallhardwareports"]) + .stdin(std::process::Stdio::null()) + .output() + }) + .await + .with_context(|| "Failed to join networksetup task") + .and_then(|result| result.with_context(|| "Failed to execute networksetup command")) + .with_context(|| "Failed to execute networksetup command") + .and_then(|output| { + anyhow::ensure!(output.status.success(), "networksetup command failed"); + std::str::from_utf8(&output.stdout) + .map(|s| s.to_string()) + .with_context(|| "Failed to convert networksetup output to string") + }) + .unwrap_or_else(|e| { + tracing::error!("Failed to execute networksetup command: {:?}", e); + String::new() + }); + + // Update cache + cache_guard.0 = stdout.clone(); + cache_guard.1 = Instant::now(); + + stdout + } + + #[cfg(all(target_os = "macos", not(feature = "macos-ne")))] + async fn is_interface_physical(&self) -> bool { + let interface_name = &self.iface.name; + let stdout = Self::get_networksetup_output().await; + + let lines: Vec<&str> = stdout.lines().collect(); + + for i in 0..lines.len() { + let line = lines[i]; + + if line.trim().strip_prefix("Device:").map(str::trim) == Some(interface_name) { + return lines + .get(i + 1) + .is_some_and(|next_line| !next_line.contains("Virtual Interface")); + } + } + + false + } + + #[cfg(target_os = "freebsd")] + async fn is_interface_physical(&self) -> bool { + // if mac addr is not zero, then it's physical interface + has_nonzero_mac(&self.iface) + } + + async fn filter_iface(&self) -> bool { + !self.state.is_point_to_point + && !self.state.is_loopback + && self.state.is_up + && self.is_interface_physical().await + } +} + +#[cfg(target_os = "windows")] +impl InterfaceFilter { + async fn filter_iface(&self) -> bool { + tracing::debug!( + "iface_name: {:?}, p2p: {:?}, is_up: {:?}, iface: {:?}", + self.iface.name, + self.state.is_point_to_point, + self.state.is_up, + self.iface + ); + !self.state.is_point_to_point + && !self.state.is_loopback + && self + .iface + .addr + .iter() + .map(|ip| ip.ip()) + .any(|ip| !ip.is_loopback() && !ip.is_unspecified() && !ip.is_multicast()) + && has_nonzero_mac(&self.iface) + } +} + +pub async fn local_ipv4() -> std::io::Result { + let socket = tokio::net::UdpSocket::bind("0.0.0.0:0").await?; + socket.connect("8.8.8.8:80").await?; + let addr = socket.local_addr()?; + match addr.ip() { + std::net::IpAddr::V4(ip) => Ok(ip), + std::net::IpAddr::V6(_) => Err(std::io::Error::new( + std::io::ErrorKind::AddrNotAvailable, + "no ipv4 address", + )), + } +} + +pub async fn local_ipv6() -> std::io::Result { + let socket = tokio::net::UdpSocket::bind("[::]:0").await?; + socket + .connect("[2001:4860:4860:0000:0000:0000:0000:8888]:80") + .await?; + let addr = socket.local_addr()?; + match addr.ip() { + std::net::IpAddr::V6(ip) => Ok(ip), + std::net::IpAddr::V4(_) => Err(std::io::Error::new( + std::io::ErrorKind::AddrNotAvailable, + "no ipv4 address", + )), + } +} + +pub(crate) async fn collect_interfaces(net_ns: NetNS, filter: bool) -> Vec { + #[cfg(target_os = "linux")] + { + run_in_namespace(net_ns, move || async move { + collect_interfaces_in_current_namespace(filter).await + }) + .await + } + + #[cfg(not(target_os = "linux"))] + { + let _g = net_ns.guard(); + collect_interfaces_in_current_namespace(filter).await + } +} + +#[cfg(feature = "faketcp")] +fn convert_pnet_interface(iface: pnet_datalink::NetworkInterface) -> NetworkInterface { + let internal = iface.is_loopback(); + let addr = iface + .ips + .into_iter() + .filter_map(|network| match (network.ip(), network.mask()) { + (IpAddr::V4(ip), IpAddr::V4(netmask)) => { + Some(network_interface::Addr::V4(network_interface::V4IfAddr { + ip, + broadcast: None, + netmask: Some(netmask), + })) + } + (IpAddr::V6(ip), IpAddr::V6(netmask)) => { + Some(network_interface::Addr::V6(network_interface::V6IfAddr { + ip, + broadcast: None, + netmask: Some(netmask), + })) + } + _ => None, + }) + .collect(); + NetworkInterface { + name: iface.name, + addr, + mac_addr: iface.mac.map(|mac| mac.to_string()), + index: iface.index, + internal, + } +} + +async fn collect_interfaces_in_current_namespace(filter: bool) -> Vec { + let ifaces = match NetworkInterface::show() { + Ok(ifaces) => ifaces, + Err(error) => { + tracing::warn!(?error, "failed to enumerate network interfaces"); + #[cfg(feature = "faketcp")] + { + match std::panic::catch_unwind(pnet_datalink::interfaces) { + Ok(ifaces) => ifaces.into_iter().map(convert_pnet_interface).collect(), + Err(_) => { + tracing::error!( + "failed to enumerate network interfaces via network-interface and pnet" + ); + return Vec::new(); + } + } + } + #[cfg(not(feature = "faketcp"))] + return Vec::new(); + } + }; + let states = collect_interface_states(); + let mut ret = vec![]; + for iface in ifaces { + let f = InterfaceFilter { + iface: iface.clone(), + state: interface_state(&iface, &states), + }; + + if filter && !f.filter_iface().await { + continue; + } + + ret.push(iface); + } + + ret +} + +#[cfg(target_os = "linux")] +async fn run_in_namespace(net_ns: NetNS, operation: F) -> T +where + T: Send + 'static, + F: FnOnce() -> Fut + Send + 'static, + Fut: std::future::Future + 'static, +{ + tokio::task::spawn_blocking(move || { + let runtime = tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + .expect("build namespace-local runtime"); + net_ns.run(|| runtime.block_on(operation())) + }) + .await + .expect("namespace-local network operation panicked") +} + +#[tracing::instrument(skip(net_ns))] +pub(crate) async fn collect_local_ip_addrs(net_ns: NetNS) -> GetIpListResponse { + #[cfg(target_os = "linux")] + { + return run_in_namespace(net_ns, || async { + collect_local_ip_addrs_in_current_namespace().await + }) + .await; + } + + #[cfg(not(target_os = "linux"))] + { + let _g = net_ns.guard(); + collect_local_ip_addrs_in_current_namespace().await + } +} + +async fn collect_local_ip_addrs_in_current_namespace() -> GetIpListResponse { + let mut ret = GetIpListResponse::default(); + + let ifaces = collect_interfaces_in_current_namespace(true).await; + for iface in ifaces { + for ip in iface.addr { + let ip: std::net::IpAddr = ip.ip(); + if let std::net::IpAddr::V4(v4) = ip { + if ip.is_loopback() || ip.is_multicast() { + continue; + } + ret.interface_ipv4s.push(v4.into()); + } + } + } + + // On macOS, both address families must obey the physical-interface policy. + // A proxy TUN may carry globally scoped IPv6 addresses too. + let physical_only = cfg!(all(target_os = "macos", not(feature = "macos-ne"))); + let ifaces = collect_interfaces_in_current_namespace(physical_only).await; + for iface in ifaces { + for ip in iface.addr { + let ip: std::net::IpAddr = ip.ip(); + if let std::net::IpAddr::V6(v6) = ip { + if v6.is_multicast() || v6.is_loopback() || v6.is_unicast_link_local() { + continue; + } + ret.interface_ipv6s.push(v6.into()); + } + } + } + + // Route probes can select another VPN's TUN. Do not reintroduce that + // interface after filtering it out above on desktop macOS. + #[cfg(not(all(target_os = "macos", not(feature = "macos-ne"))))] + if let Ok(v4_addr) = local_ipv4().await { + tracing::trace!("got local ipv4: {}", v4_addr); + if !ret.interface_ipv4s.contains(&v4_addr.into()) { + ret.interface_ipv4s.push(v4_addr.into()); + } + } + + #[cfg(not(all(target_os = "macos", not(feature = "macos-ne"))))] + if let Ok(v6_addr) = local_ipv6().await { + tracing::trace!("got local ipv6: {}", v6_addr); + if !ret.interface_ipv6s.contains(&v6_addr.into()) { + ret.interface_ipv6s.push(v6_addr.into()); + } + } + + ret +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn converts_contiguous_ip_masks_to_prefixes() { + assert_eq!( + ip_mask_to_prefix(IpAddr::V4("255.255.254.0".parse().unwrap())), + Ok(23) + ); + assert_eq!( + ip_mask_to_prefix(IpAddr::V6("ffff:ffff:ffff:ffff::".parse().unwrap())), + Ok(64) + ); + assert_eq!( + ip_mask_to_prefix(IpAddr::V4("255.0.255.0".parse().unwrap())), + Err(()) + ); + } + + #[cfg(target_os = "linux")] + #[tokio::test] + async fn namespace_operation_does_not_migrate_between_os_threads() { + let (before, after) = run_in_namespace(NetNS::new(None), || async { + let before = std::thread::current().id(); + tokio::task::yield_now().await; + (before, std::thread::current().id()) + }) + .await; + + assert_eq!(before, after); + } +} diff --git a/vendor/easytier/easytier/src/common/os_info.rs b/vendor/easytier/easytier/src/common/os_info.rs new file mode 100644 index 0000000..dcd78a3 --- /dev/null +++ b/vendor/easytier/easytier/src/common/os_info.rs @@ -0,0 +1,144 @@ +use std::{collections::HashMap, fs, process::Command}; + +use crate::proto::web::DeviceOsInfo; + +pub fn collect_device_os_info() -> DeviceOsInfo { + let os_type = normalize_os_type(std::env::consts::OS); + let (version, distribution) = detect_os_version_and_distribution(&os_type); + + DeviceOsInfo { + os_type, + version, + distribution, + } +} + +fn normalize_os_type(raw: &str) -> String { + match raw { + "macos" => "macos".to_string(), + "windows" => "windows".to_string(), + "linux" => "linux".to_string(), + "android" => "android".to_string(), + "ios" => "ios".to_string(), + "freebsd" => "freebsd".to_string(), + other => other.to_string(), + } +} + +fn detect_os_version_and_distribution(os_type: &str) -> (String, String) { + match os_type { + "linux" | "android" => linux_version_and_distribution(os_type), + "macos" => ( + first_non_empty([ + command_output("sw_vers", &["-productVersion"]), + unix_kernel_release(), + ]), + "macOS".to_string(), + ), + "windows" => ( + first_non_empty([windows_version(), None]), + "Windows".to_string(), + ), + "freebsd" => ( + first_non_empty([ + command_output("freebsd-version", &[]), + unix_kernel_release(), + ]), + "FreeBSD".to_string(), + ), + other => ( + unix_kernel_release().unwrap_or_else(|| "unknown".to_string()), + other.to_string(), + ), + } +} + +fn linux_version_and_distribution(os_type: &str) -> (String, String) { + let os_release = parse_os_release().unwrap_or_default(); + let version = first_non_empty([ + os_release.get("VERSION_ID").cloned(), + os_release.get("VERSION").cloned(), + unix_kernel_release(), + ]); + let distribution = first_non_empty([ + os_release.get("NAME").cloned(), + os_release.get("ID").cloned().map(title_case), + Some(if os_type == "android" { + "Android".to_string() + } else { + "Linux".to_string() + }), + ]); + (version, distribution) +} + +fn parse_os_release() -> Option> { + ["/etc/os-release", "/usr/lib/os-release"] + .into_iter() + .find_map(|path| fs::read_to_string(path).ok()) + .map(|content| { + content + .lines() + .filter_map(|line| { + let line = line.trim(); + if line.is_empty() || line.starts_with('#') { + return None; + } + let (key, value) = line.split_once('=')?; + Some((key.to_string(), trim_os_release_value(value))) + }) + .collect() + }) +} + +fn trim_os_release_value(value: &str) -> String { + value + .trim() + .trim_matches('"') + .trim_matches('\'') + .to_string() +} + +fn unix_kernel_release() -> Option { + command_output("uname", &["-r"]) +} + +fn windows_version() -> Option { + let output = command_output("cmd", &["/C", "ver"])?; + output + .split("Version") + .nth(1) + .map(str::trim) + .map(|part| part.trim_matches(&['[', ']'][..]).to_string()) + .filter(|value| !value.is_empty()) +} + +fn command_output(program: &str, args: &[&str]) -> Option { + let output = Command::new(program).args(args).output().ok()?; + if !output.status.success() { + return None; + } + let value = String::from_utf8(output.stdout).ok()?; + let value = value.trim(); + if value.is_empty() { + None + } else { + Some(value.to_string()) + } +} + +fn first_non_empty(values: [Option; N]) -> String { + values + .into_iter() + .flatten() + .find(|value| !value.trim().is_empty()) + .unwrap_or_else(|| "unknown".to_string()) +} + +fn title_case(value: String) -> String { + let mut chars = value.chars(); + let Some(first) = chars.next() else { + return value; + }; + first.to_uppercase().collect::() + chars.as_str() +} diff --git a/vendor/easytier/easytier/src/common/stun.rs b/vendor/easytier/easytier/src/common/stun.rs new file mode 100644 index 0000000..dfaf3f7 --- /dev/null +++ b/vendor/easytier/easytier/src/common/stun.rs @@ -0,0 +1,250 @@ +//! Native composition for the portable core STUN collector. + +#[cfg(test)] +use std::{net::SocketAddr, sync::Arc}; + +#[cfg(test)] +use async_trait::async_trait; +#[cfg(test)] +use easytier_core::connectivity::stun::{StunInfoProvider, StunSocketMapper}; +use easytier_core::{ + connectivity::stun::StunInfoCollector as CoreStunInfoCollector, socket::SocketContext, +}; +#[cfg(test)] +use easytier_proto::common::{NatType, StunInfo}; + +use crate::host_runtime::{NativeHostRuntime, native_host_runtime}; +#[cfg(test)] +use crate::socket::udp::RuntimeUdpSocket; + +pub type StunInfoCollector = CoreStunInfoCollector; + +pub fn default_udp_stun_servers() -> Vec { + if cfg!(test) { + Vec::new() + } else { + StunInfoCollector::get_default_servers() + } +} + +pub fn default_tcp_stun_servers() -> Vec { + if cfg!(test) { + Vec::new() + } else { + StunInfoCollector::get_default_tcp_servers() + } +} + +pub fn default_udp_v6_stun_servers() -> Vec { + if cfg!(test) { + Vec::new() + } else { + StunInfoCollector::get_default_servers_v6() + } +} + +#[cfg(test)] +pub struct MockStunInfoCollector { + pub udp_nat_type: NatType, +} + +#[cfg(test)] +#[async_trait] +impl StunInfoProvider for MockStunInfoCollector { + fn get_stun_info(&self) -> StunInfo { + StunInfo { + udp_nat_type: self.udp_nat_type as i32, + tcp_nat_type: NatType::Unknown as i32, + last_update_time: unix_timestamp(), + min_port: 100, + max_port: 200, + public_ip: vec!["127.0.0.1".to_owned(), "::1".to_owned()], + } + } + + async fn get_udp_port_mapping(&self, mut port: u16) -> anyhow::Result { + if port == 0 { + port = 40144; + } + Ok(SocketAddr::from(([127, 0, 0, 1], port))) + } + + async fn get_tcp_port_mapping(&self, mut port: u16) -> anyhow::Result { + if port == 0 { + port = 40144; + } + Ok(SocketAddr::from(([127, 0, 0, 1], port))) + } + + fn update_stun_info(&self) {} +} + +#[cfg(test)] +#[async_trait] +impl StunSocketMapper for MockStunInfoCollector { + async fn get_udp_port_mapping_with_socket( + &self, + socket: Arc, + ) -> anyhow::Result { + use easytier_core::socket::udp::VirtualUdpSocket as _; + self.get_udp_port_mapping(socket.local_addr()?.port()).await + } +} + +pub fn runtime_stun_info_collector(socket_context: SocketContext) -> StunInfoCollector { + let runtime = native_host_runtime(); + StunInfoCollector::new( + runtime.clone(), + runtime, + socket_context, + default_udp_stun_servers(), + default_tcp_stun_servers(), + default_udp_v6_stun_servers(), + ) +} + +#[cfg(test)] +fn unix_timestamp() -> i64 { + std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .unwrap_or_default() + .as_secs() as i64 +} + +#[cfg(test)] +mod tests { + use std::time::Duration; + + use bytecodec::{DecodeExt as _, EncodeExt as _}; + use easytier_core::{ + connectivity::stun::{TcpNatTypeDetector, UdpNatTypeDetector}, + packet::stun::Attribute, + socket::SocketListener, + socket::{NetNamespace, udp::VirtualUdpSocketFactory}, + }; + use stun_codec::rfc5389::{attributes::XorMappedAddress, methods::BINDING}; + use stun_codec::{Message, MessageClass, MessageDecoder, MessageEncoder}; + use tokio::{ + io::{AsyncReadExt as _, AsyncWriteExt as _}, + task::JoinSet, + }; + use tokio_util::task::AbortOnDropHandle; + + use crate::{ + host_runtime::native_host_runtime, proto::rpc::standalone::runtime_udp_tunnel_listener, + }; + + use super::*; + + #[tokio::test] + async fn runtime_collector_starts_with_native_runtime() { + let context = SocketContext::default() + .with_socket_mark(Some(0)) + .with_netns(Some(NetNamespace::new("instance-a"))); + let collector = runtime_stun_info_collector(context); + + assert_eq!( + StunInfoProvider::get_stun_info(&collector), + StunInfo::default() + ); + } + + #[test] + fn native_runtime_supports_collector_socket() { + fn assert_factory>() {} + assert_factory::(); + } + + #[tokio::test] + async fn native_udp_runtime_drives_core_stun_detector() { + let mut first = runtime_udp_tunnel_listener( + "udp://127.0.0.1:0".parse().unwrap(), + "127.0.0.1:0".parse().unwrap(), + ); + let mut second = runtime_udp_tunnel_listener( + "udp://127.0.0.1:0".parse().unwrap(), + "127.0.0.1:0".parse().unwrap(), + ); + first.listen().await.unwrap(); + second.listen().await.unwrap(); + let servers = vec![ + SocketAddr::from(([127, 0, 0, 1], first.local_url().port().unwrap())).to_string(), + SocketAddr::from(([127, 0, 0, 1], second.local_url().port().unwrap())).to_string(), + ]; + let mut tasks = JoinSet::new(); + tasks.spawn(async move { + loop { + first.accept().await.unwrap(); + } + }); + tasks.spawn(async move { + loop { + second.accept().await.unwrap(); + } + }); + + let runtime = native_host_runtime(); + let detector = UdpNatTypeDetector::new( + runtime.clone(), + runtime, + SocketContext::default(), + servers, + 1, + ); + let result = detector.detect_nat_type(0).await.unwrap(); + + assert_eq!(result.nat_type(), NatType::Restricted); + tasks.abort_all(); + } + + #[tokio::test] + async fn native_tcp_runtime_drives_core_stun_detector() { + async fn spawn_server() -> (SocketAddr, AbortOnDropHandle<()>) { + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let address = listener.local_addr().unwrap(); + let task = tokio::spawn(async move { + let (mut stream, peer_addr) = listener.accept().await.unwrap(); + let mut header = [0_u8; 20]; + stream.read_exact(&mut header).await.unwrap(); + let payload_len = u16::from_be_bytes([header[2], header[3]]) as usize; + let mut bytes = vec![0_u8; 20 + payload_len]; + bytes[..20].copy_from_slice(&header); + stream.read_exact(&mut bytes[20..]).await.unwrap(); + let request = MessageDecoder::::new() + .decode_from_bytes(&bytes) + .unwrap() + .unwrap(); + let mut response = Message::::new( + MessageClass::SuccessResponse, + BINDING, + request.transaction_id(), + ); + response.add_attribute(Attribute::XorMappedAddress(XorMappedAddress::new( + peer_addr, + ))); + let bytes = MessageEncoder::new().encode_into_bytes(response).unwrap(); + stream.write_all(&bytes).await.unwrap(); + }); + (address, AbortOnDropHandle::new(task)) + } + + let (first, _first_task) = spawn_server().await; + let (second, _second_task) = spawn_server().await; + let runtime = native_host_runtime(); + let detector = TcpNatTypeDetector::new( + runtime.clone(), + runtime, + SocketContext::default(), + vec![first.to_string(), second.to_string()], + 1, + ); + + let result = tokio::time::timeout(Duration::from_secs(5), detector.detect_nat_type(0)) + .await + .unwrap() + .unwrap(); + + assert_eq!(result.nat_type(), NatType::OpenInternet); + assert_eq!(result.usable_stun_resp_count(), 2); + } +} diff --git a/vendor/easytier/easytier/src/common/tracing_rolling_appender/LICENSE b/vendor/easytier/easytier/src/common/tracing_rolling_appender/LICENSE new file mode 100644 index 0000000..3872c78 --- /dev/null +++ b/vendor/easytier/easytier/src/common/tracing_rolling_appender/LICENSE @@ -0,0 +1,242 @@ +This module is copied and modified from https://github.com/cavivie/tracing-rolling-file + +tracing-rolling-file is dual-licensed under The MIT License [1] and +Apache 2.0 License [2]. + +Copyright (c) 2021 Cavivie and contributors. + +This is same as the Rust Project's own license. + + +[1]: , which is reproduced below: + +~~~~ +The MIT License (MIT) + +Copyright (c) 2021, eFolder Inc dba Axcient. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. +~~~~ + + +[2]: , which is reproduced below: + +~~~~ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +~~~~ \ No newline at end of file diff --git a/vendor/easytier/easytier/src/common/tracing_rolling_appender/base.rs b/vendor/easytier/easytier/src/common/tracing_rolling_appender/base.rs new file mode 100644 index 0000000..2e4d8c5 --- /dev/null +++ b/vendor/easytier/easytier/src/common/tracing_rolling_appender/base.rs @@ -0,0 +1,519 @@ +use super::*; +use anyhow::anyhow; + +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub struct RollingConditionBase { + last_write_opt: Option>, + frequency_opt: Option, + max_size_opt: Option, +} + +impl RollingConditionBase { + /// Constructs a new struct that does not yet have any condition set. + pub fn new() -> RollingConditionBase { + RollingConditionBase { + last_write_opt: None, + frequency_opt: None, + max_size_opt: None, + } + } + + /// Sets a condition to rollover on the given frequency + pub fn frequency(mut self, x: RollingFrequency) -> RollingConditionBase { + self.frequency_opt = Some(x); + self + } + + /// Sets a condition to rollover when the date changes + pub fn daily(mut self) -> RollingConditionBase { + self.frequency_opt = Some(RollingFrequency::EveryDay); + self + } + + /// Sets a condition to rollover when the date or hour changes + pub fn hourly(mut self) -> RollingConditionBase { + self.frequency_opt = Some(RollingFrequency::EveryHour); + self + } + + /// Sets a condition to rollover when the date or minute changes + pub fn minutely(mut self) -> RollingConditionBase { + self.frequency_opt = Some(RollingFrequency::EveryMinute); + self + } + + /// Sets a condition to rollover when a certain size is reached + pub fn max_size(mut self, x: u64) -> RollingConditionBase { + self.max_size_opt = Some(x); + self + } +} + +impl Default for RollingConditionBase { + fn default() -> Self { + RollingConditionBase::new().frequency(RollingFrequency::EveryDay) + } +} + +impl RollingCondition for RollingConditionBase { + fn should_rollover(&mut self, now: &DateTime, current_filesize: u64) -> bool { + let mut rollover = false; + if let Some(frequency) = self.frequency_opt.as_ref() + && let Some(last_write) = self.last_write_opt.as_ref() + && frequency.equivalent_datetime(now) != frequency.equivalent_datetime(last_write) + { + rollover = true; + } + if let Some(max_size) = self.max_size_opt.as_ref() + && current_filesize >= *max_size + { + rollover = true; + } + self.last_write_opt = Some(*now); + rollover + } +} + +pub struct RollingFileAppenderBaseBuilder { + condition: RollingConditionBase, + filename: String, + max_filecount: usize, + current_filesize: u64, + writer_opt: Option>, +} + +impl Default for RollingFileAppenderBaseBuilder { + fn default() -> Self { + RollingFileAppenderBaseBuilder { + condition: RollingConditionBase::default(), + filename: String::new(), + max_filecount: 10, + current_filesize: 0, + writer_opt: None, + } + } +} + +impl RollingFileAppenderBaseBuilder { + /// Sets the log filename. Uses absolute path if provided, otherwise + /// creates files in the current working directory. + pub fn filename(mut self, filename: String) -> Self { + self.filename = filename; + self + } + + /// Sets a condition for the maximum number of files to create before rolling + /// over and deleting the oldest one. + pub fn max_filecount(mut self, max_filecount: usize) -> Self { + self.max_filecount = max_filecount; + self + } + + /// Sets a condition to rollover on a daily basis + pub fn condition_daily(mut self) -> Self { + self.condition.frequency_opt = Some(RollingFrequency::EveryDay); + self + } + + /// Sets a condition to rollover when the date or hour changes + pub fn condition_hourly(mut self) -> Self { + self.condition.frequency_opt = Some(RollingFrequency::EveryHour); + self + } + + /// Sets a condition to rollover when the date or minute changes + pub fn condition_minutely(mut self) -> Self { + self.condition.frequency_opt = Some(RollingFrequency::EveryMinute); + self + } + + /// Sets a condition to rollover when a certain size is reached + pub fn condition_max_file_size(mut self, x: u64) -> Self { + self.condition.max_size_opt = Some(x); + self + } + + /// Builds a RollingFileAppenderBase instance from the current settings. + /// + /// Returns an error if the filename is empty. + pub fn build(self) -> anyhow::Result { + if self.filename.is_empty() { + return Err(anyhow!( + "A filename is required to be set and can not be blank" + )); + } + Ok(RollingFileAppenderBase { + condition: self.condition, + filename: self.filename, + max_filecount: self.max_filecount, + current_filesize: self.current_filesize, + writer_opt: self.writer_opt, + }) + } +} + +impl RollingFileAppenderBase { + /// Creates a new rolling file appender builder instance with the default + /// settings without a filename set. + pub fn builder() -> RollingFileAppenderBaseBuilder { + RollingFileAppenderBaseBuilder::default() + } +} + +/// A rolling file appender with a rolling condition based on date/time or size. +pub type RollingFileAppenderBase = RollingFileAppender; + +// LCOV_EXCL_START +#[cfg(test)] +mod test { + use super::*; + + struct Context { + _tempdir: tempfile::TempDir, + rolling: RollingFileAppenderBase, + } + + impl Context { + fn verify_contains(&mut self, needle: &str, n: usize) { + self.rolling.flush().unwrap(); + let p = self.rolling.filename_for(n); + let haystack = fs::read_to_string(&p).unwrap(); + if !haystack.contains(needle) { + panic!("file {:?} did not contain expected contents {}", p, needle); + } + } + } + + fn build_context(condition: RollingConditionBase, max_files: usize) -> Context { + let tempdir = tempfile::tempdir().unwrap(); + let filename = tempdir.path().join("test.log"); + let rolling = RollingFileAppenderBase::new(filename, condition, max_files).unwrap(); + Context { + _tempdir: tempdir, + rolling, + } + } + + fn build_builder_context(mut builder: RollingFileAppenderBaseBuilder) -> Context { + if builder.filename.is_empty() { + builder = builder.filename(String::from("test.log")); + } + let tempdir = tempfile::tempdir().unwrap(); + let filename = tempdir.path().join(&builder.filename); + builder = builder.filename(String::from(filename.as_os_str().to_str().unwrap())); + Context { + _tempdir: tempdir, + rolling: builder.build().unwrap(), + } + } + + #[test] + fn frequency_every_day() { + let mut c = build_context(RollingConditionBase::new().daily(), 9); + c.rolling + .write_with_datetime( + b"Line 1\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 2, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 2\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 3, 0).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 3\n", + &Local.with_ymd_and_hms(2021, 3, 31, 1, 4, 0).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 4\n", + &Local.with_ymd_and_hms(2021, 5, 31, 1, 4, 0).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 5\n", + &Local.with_ymd_and_hms(2022, 5, 31, 1, 4, 0).unwrap(), + ) + .unwrap(); + assert!(!AsRef::::as_ref(&c.rolling.filename_for(4)).exists()); + c.verify_contains("Line 1", 3); + c.verify_contains("Line 2", 3); + c.verify_contains("Line 3", 2); + c.verify_contains("Line 4", 1); + c.verify_contains("Line 5", 0); + } + + #[test] + fn frequency_every_day_limited_files() { + let mut c = build_context(RollingConditionBase::new().daily(), 2); + c.rolling + .write_with_datetime( + b"Line 1\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 2, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 2\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 3, 0).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 3\n", + &Local.with_ymd_and_hms(2021, 3, 31, 1, 4, 0).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 4\n", + &Local.with_ymd_and_hms(2021, 5, 31, 1, 4, 0).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 5\n", + &Local.with_ymd_and_hms(2022, 5, 31, 1, 4, 0).unwrap(), + ) + .unwrap(); + assert!(!AsRef::::as_ref(&c.rolling.filename_for(4)).exists()); + assert!(!AsRef::::as_ref(&c.rolling.filename_for(3)).exists()); + c.verify_contains("Line 3", 2); + c.verify_contains("Line 4", 1); + c.verify_contains("Line 5", 0); + } + + #[test] + fn frequency_every_hour() { + let mut c = build_context(RollingConditionBase::new().hourly(), 9); + c.rolling + .write_with_datetime( + b"Line 1\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 2, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 2\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 3, 2).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 3\n", + &Local.with_ymd_and_hms(2021, 3, 30, 2, 1, 0).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 4\n", + &Local.with_ymd_and_hms(2021, 3, 31, 2, 1, 0).unwrap(), + ) + .unwrap(); + assert!(!AsRef::::as_ref(&c.rolling.filename_for(3)).exists()); + c.verify_contains("Line 1", 2); + c.verify_contains("Line 2", 2); + c.verify_contains("Line 3", 1); + c.verify_contains("Line 4", 0); + } + + #[test] + fn frequency_every_minute() { + let mut c = build_context( + RollingConditionBase::new().frequency(RollingFrequency::EveryMinute), + 9, + ); + c.rolling + .write_with_datetime( + b"Line 1\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 2, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 2\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 2, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 3\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 2, 4).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 4\n", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 3, 0).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 5\n", + &Local.with_ymd_and_hms(2021, 3, 30, 2, 3, 0).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"Line 6\n", + &Local.with_ymd_and_hms(2022, 3, 30, 2, 3, 0).unwrap(), + ) + .unwrap(); + assert!(!AsRef::::as_ref(&c.rolling.filename_for(4)).exists()); + c.verify_contains("Line 1", 3); + c.verify_contains("Line 2", 3); + c.verify_contains("Line 3", 3); + c.verify_contains("Line 4", 2); + c.verify_contains("Line 5", 1); + c.verify_contains("Line 6", 0); + } + + #[test] + fn max_size() { + let mut c = build_context(RollingConditionBase::new().max_size(10), 9); + c.rolling + .write_with_datetime( + b"12345", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 2, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"6789", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 3, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime(b"0", &Local.with_ymd_and_hms(2021, 3, 30, 2, 3, 3).unwrap()) + .unwrap(); + c.rolling + .write_with_datetime( + b"abcdefghijkl", + &Local.with_ymd_and_hms(2021, 3, 31, 2, 3, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"ZZZ", + &Local.with_ymd_and_hms(2022, 3, 31, 1, 2, 3).unwrap(), + ) + .unwrap(); + assert!(!AsRef::::as_ref(&c.rolling.filename_for(3)).exists()); + c.verify_contains("1234567890", 2); + c.verify_contains("abcdefghijkl", 1); + c.verify_contains("ZZZ", 0); + } + + #[test] + fn max_size_existing() { + let mut c = build_context(RollingConditionBase::new().max_size(10), 9); + c.rolling + .write_with_datetime( + b"12345", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 2, 3).unwrap(), + ) + .unwrap(); + // close the file and make sure that it can re-open it, and that it + // resets the file size properly. + c.rolling.writer_opt.take(); + c.rolling.current_filesize = 0; + c.rolling + .write_with_datetime( + b"6789", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 3, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime(b"0", &Local.with_ymd_and_hms(2021, 3, 30, 2, 3, 3).unwrap()) + .unwrap(); + c.rolling + .write_with_datetime( + b"abcdefghijkl", + &Local.with_ymd_and_hms(2021, 3, 31, 2, 3, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"ZZZ", + &Local.with_ymd_and_hms(2022, 3, 31, 1, 2, 3).unwrap(), + ) + .unwrap(); + assert!(!AsRef::::as_ref(&c.rolling.filename_for(3)).exists()); + c.verify_contains("1234567890", 2); + c.verify_contains("abcdefghijkl", 1); + c.verify_contains("ZZZ", 0); + } + + #[test] + fn daily_and_max_size() { + let mut c = build_context(RollingConditionBase::new().daily().max_size(10), 9); + c.rolling + .write_with_datetime( + b"12345", + &Local.with_ymd_and_hms(2021, 3, 30, 1, 2, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"6789", + &Local.with_ymd_and_hms(2021, 3, 30, 2, 3, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime(b"0", &Local.with_ymd_and_hms(2021, 3, 31, 2, 3, 3).unwrap()) + .unwrap(); + c.rolling + .write_with_datetime( + b"abcdefghijkl", + &Local.with_ymd_and_hms(2021, 3, 31, 3, 3, 3).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"ZZZ", + &Local.with_ymd_and_hms(2021, 3, 31, 4, 4, 4).unwrap(), + ) + .unwrap(); + assert!(!AsRef::::as_ref(&c.rolling.filename_for(3)).exists()); + c.verify_contains("123456789", 2); + c.verify_contains("0abcdefghijkl", 1); + c.verify_contains("ZZZ", 0); + } + + #[test] + fn rolling_file_appender_builder() { + let builder = RollingFileAppender::builder(); + + let builder = builder.condition_daily().condition_max_file_size(10); + let mut c = build_builder_context(builder); + c.rolling + .write_with_datetime( + b"abcdefghijklmnop", + &Local.with_ymd_and_hms(2021, 3, 31, 4, 4, 4).unwrap(), + ) + .unwrap(); + c.rolling + .write_with_datetime( + b"12345678", + &Local.with_ymd_and_hms(2021, 3, 31, 5, 4, 4).unwrap(), + ) + .unwrap(); + assert!(AsRef::::as_ref(&c.rolling.filename_for(1)).exists()); + assert!(Path::new(&c.rolling.filename_for(0)).exists()); + c.verify_contains("abcdefghijklmnop", 1); + c.verify_contains("12345678", 0); + } + + #[test] + fn rolling_file_appender_builder_no_filename() { + let builder = RollingFileAppender::builder(); + let appender = builder.condition_daily().build(); + assert!(appender.is_err()); + } +} +// LCOV_EXCL_STOP diff --git a/vendor/easytier/easytier/src/common/tracing_rolling_appender/mod.rs b/vendor/easytier/easytier/src/common/tracing_rolling_appender/mod.rs new file mode 100644 index 0000000..8f7231f --- /dev/null +++ b/vendor/easytier/easytier/src/common/tracing_rolling_appender/mod.rs @@ -0,0 +1,205 @@ +#![deny(warnings)] + +use chrono::prelude::*; +use std::{ + convert::TryFrom, + fs::{self, File, OpenOptions}, + io::{self, BufWriter, Write}, + path::Path, +}; + +/// Determines when a file should be "rolled over". +pub trait RollingCondition { + /// Determine and return whether or not the file should be rolled over. + fn should_rollover(&mut self, now: &DateTime, current_filesize: u64) -> bool; +} + +/// Determines how often a file should be rolled over +#[derive(Copy, Clone, Debug, Eq, PartialEq)] +pub enum RollingFrequency { + EveryDay, + EveryHour, + EveryMinute, +} + +impl RollingFrequency { + /// Calculates a datetime that will be different if data should be in + /// different files. + pub fn equivalent_datetime(&self, dt: &DateTime) -> DateTime { + let (year, month, day) = (dt.year(), dt.month(), dt.day()); + let (hour, min, sec) = match self { + RollingFrequency::EveryDay => (0, 0, 0), + RollingFrequency::EveryHour => (dt.hour(), 0, 0), + RollingFrequency::EveryMinute => (dt.hour(), dt.minute(), 0), + }; + Local + .with_ymd_and_hms(year, month, day, hour, min, sec) + .unwrap() + } +} + +/// Writes data to a file, and "rolls over" to preserve older data in +/// a separate set of files. Old files have a Debian-style naming scheme +/// where we have base_filename, base_filename.1, ..., base_filename.N +/// where N is the maximum number of rollover files to keep. +#[derive(Debug)] +pub struct RollingFileAppender +where + RC: RollingCondition, +{ + condition: RC, + filename: String, + max_filecount: usize, + current_filesize: u64, + writer_opt: Option>, +} + +impl RollingFileAppender +where + RC: RollingCondition, +{ + /// Creates a new rolling file appender with the given condition. + /// The filename parent path must already exist. + pub fn new( + filename: impl AsRef, + condition: RC, + max_filecount: usize, + ) -> io::Result> { + let filename = filename.as_ref().to_str().unwrap().to_string(); + let mut appender = RollingFileAppender { + condition, + filename, + max_filecount, + current_filesize: 0, + writer_opt: None, + }; + // Fail if we can't open the file initially... + appender.open_writer_if_needed()?; + Ok(appender) + } + + /// Determines the final filename, where n==0 indicates the current file + fn filename_for(&self, n: usize) -> String { + let f = self.filename.clone(); + if n > 0 { format!("{}.{}", f, n) } else { f } + } + + /// Rotates old files to make room for a new one. + /// This may result in the deletion of the oldest file + fn rotate_files(&self) -> io::Result<()> { + // ignore any failure removing the oldest file (may not exist) + let _ = fs::remove_file(self.filename_for(self.max_filecount.max(1))); + let mut r = Ok(()); + for i in (0..self.max_filecount.max(1)).rev() { + let rotate_from = self.filename_for(i); + let rotate_to = self.filename_for(i + 1); + if let Err(e) = fs::rename(&rotate_from, &rotate_to).or_else(|e| match e.kind() { + io::ErrorKind::NotFound => Ok(()), + _ => Err(e), + }) { + // capture the error, but continue the loop, + // to maximize ability to rename everything + r = Err(e); + } + } + r + } + + /// Forces a rollover to happen immediately. + pub fn rollover(&mut self) -> io::Result<()> { + // Before closing, make sure all data is flushed successfully. + self.flush()?; + // We must close the current file before rotating files + self.writer_opt.take(); + self.current_filesize = 0; + self.rotate_files()?; + self.open_writer_if_needed() + } + + /// Opens a writer for the current file. + fn open_writer_if_needed(&mut self) -> io::Result<()> { + if self.writer_opt.is_none() { + let path = self.filename_for(0); + let path = Path::new(&path); + let mut open_options = OpenOptions::new(); + open_options.append(true).create(true); + let new_file = match open_options.open(path) { + Ok(new_file) => new_file, + Err(err) => { + let Some(parent) = path.parent() else { + return Err(err); + }; + fs::create_dir_all(parent)?; + open_options.open(path)? + } + }; + self.writer_opt = Some(BufWriter::new(new_file)); + self.current_filesize = path.metadata().map_or(0, |m| m.len()); + } + Ok(()) + } + + /// Writes data using the given datetime to calculate the rolling condition + pub fn write_with_datetime(&mut self, buf: &[u8], now: &DateTime) -> io::Result { + if self.condition.should_rollover(now, self.current_filesize) + && let Err(e) = self.rollover() + { + // If we can't rollover, just try to continue writing anyway + // (better than missing data). + // This will likely used to implement logging, so + // avoid using log::warn and log to stderr directly + eprintln!("WARNING: Failed to rotate logfile {}: {}", self.filename, e); + } + self.open_writer_if_needed()?; + if let Some(writer) = self.writer_opt.as_mut() { + let buf_len = buf.len(); + writer.write_all(buf).map(|_| { + self.current_filesize += u64::try_from(buf_len).unwrap_or(u64::MAX); + buf_len + }) + } else { + Err(io::Error::other("unexpected condition: writer is missing")) + } + } +} + +impl io::Write for RollingFileAppender +where + RC: RollingCondition, +{ + fn write(&mut self, buf: &[u8]) -> io::Result { + let now = Local::now(); + self.write_with_datetime(buf, &now) + } + + fn flush(&mut self) -> io::Result<()> { + if let Some(writer) = self.writer_opt.as_mut() { + writer.flush()?; + } + Ok(()) + } +} + +#[derive(Debug, Clone)] +pub struct FileAppenderWrapper { + appender: std::sync::Arc>, +} + +impl FileAppenderWrapper { + pub fn new(appender: RollingFileAppenderBase) -> Self { + Self { + appender: std::sync::Arc::new(parking_lot::Mutex::new(appender)), + } + } + + pub fn write_all(&self, buf: &[u8]) -> std::io::Result<()> { + self.appender.lock().write_all(buf) + } + + pub fn flush(&self) -> std::io::Result<()> { + self.appender.lock().flush() + } +} + +pub mod base; +pub use base::*; diff --git a/vendor/easytier/easytier/src/common/upnp.rs b/vendor/easytier/easytier/src/common/upnp.rs new file mode 100644 index 0000000..d53b268 --- /dev/null +++ b/vendor/easytier/easytier/src/common/upnp.rs @@ -0,0 +1,585 @@ +use std::{ + fmt, + net::{Ipv4Addr, SocketAddr, SocketAddrV4}, + time::Duration, +}; + +use anyhow::{Context, anyhow, bail}; +use async_trait::async_trait; +use easytier_core::connectivity::hole_punch::port_mapping::{ + ActiveUdpPortMapping as CoreActiveUdpPortMapping, UdpPortMappingAttemptError, + UdpPortMappingBackend, UdpPortMappingLifecycle, +}; +use natpmp::{ + Protocol as NatPmpProtocol, Response as NatPmpResponse, get_default_gateway, + new_natpmp_async_with, +}; +use tokio::net::UdpSocket; + +use crate::igd_next::{ + AddAnyPortError, Gateway, PortMappingProtocol, SearchOptions, search_gateway, +}; + +use super::netns::NetNS; + +const UPNP_SEARCH_TIMEOUT: Duration = Duration::from_secs(1); +const UPNP_SEARCH_RESPONSE_TIMEOUT: Duration = Duration::from_millis(300); +const NAT_PMP_RESPONSE_TIMEOUT: Duration = Duration::from_secs(1); +const UPNP_LEASE_DURATION_SECS: u32 = 300; +const UPNP_DESCRIPTION: &str = "EasyTier udp hole punch"; + +async fn new_protected_natpmp( + gateway: Option, +) -> anyhow::Result> { + let gateway = gateway + .map(Ok) + .unwrap_or_else(|| get_default_gateway().map_err(anyhow::Error::from))?; + let gateway_addr = SocketAddr::V4(SocketAddrV4::new(gateway, natpmp::NATPMP_PORT)); + let socket = crate::socket::udp::create_udp_socket( + &easytier_core::socket::udp::UdpBindOptions::direct_connect() + .with_local_addr(Some("0.0.0.0:0".parse().unwrap())), + ) + .await + .context("create protected nat-pmp socket")?; + socket + .connect(gateway_addr) + .await + .with_context(|| format!("connect nat-pmp socket to gateway {gateway}"))?; + Ok(new_natpmp_async_with(socket, gateway)) +} + +enum PortMappingBackend { + NatPmp { gateway: Ipv4Addr }, + Igd { gateway: Gateway }, +} + +struct ActiveUdpPortMapping { + backend: PortMappingBackend, + local_listener: url::Url, + local_addr: SocketAddr, + gateway_external_port: u16, +} + +impl fmt::Debug for ActiveUdpPortMapping { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("ActiveUdpPortMapping") + .field("backend", &self.core_backend()) + .field("local_listener", &self.local_listener) + .field("local_addr", &self.local_addr) + .field("gateway_external_port", &self.gateway_external_port) + .finish() + } +} + +impl ActiveUdpPortMapping { + fn core_backend(&self) -> UdpPortMappingBackend { + match self.backend { + PortMappingBackend::Igd { .. } => UdpPortMappingBackend::Igd, + PortMappingBackend::NatPmp { .. } => UdpPortMappingBackend::NatPmp, + } + } + + async fn discover_nat_pmp_gateway( + local_listener: &url::Url, + ) -> anyhow::Result<(Ipv4Addr, SocketAddr)> { + let client = new_protected_natpmp(None) + .await + .context("create nat-pmp client")?; + let gateway = *client.gateway(); + let gateway_addr = SocketAddr::V4(SocketAddrV4::new(gateway, natpmp::NATPMP_PORT)); + let local_addr = resolve_internal_addr(gateway_addr, local_listener).await?; + Ok((gateway, local_addr)) + } + + async fn establish_via_nat_pmp( + local_listener: &url::Url, + gateway: Ipv4Addr, + local_addr: SocketAddr, + ) -> anyhow::Result { + let gateway_external_port = + add_udp_mapping_port_nat_pmp(gateway, local_addr, local_listener) + .await + .with_context(|| { + format!("map udp socket for {local_listener} via nat-pmp gateway {gateway}") + })?; + + Ok(Self { + backend: PortMappingBackend::NatPmp { gateway }, + local_listener: local_listener.clone(), + local_addr, + gateway_external_port, + }) + } + + async fn discover_igd_gateway( + net_ns: &NetNS, + local_listener: &url::Url, + ) -> anyhow::Result<(Gateway, SocketAddr)> { + let _g = net_ns.guard(); + let gateway = search_gateway(SearchOptions { + timeout: Some(UPNP_SEARCH_TIMEOUT), + single_search_timeout: Some(UPNP_SEARCH_RESPONSE_TIMEOUT), + ..Default::default() + }) + .await + .with_context(|| format!("search igd gateway for {local_listener}"))?; + let local_addr = resolve_internal_addr(gateway.addr, local_listener).await?; + + Ok((gateway, local_addr)) + } + + async fn establish_via_igd( + local_listener: &url::Url, + gateway: Gateway, + local_addr: SocketAddr, + ) -> anyhow::Result { + let gateway_external_port = add_udp_mapping_port_igd(&gateway, local_addr, local_listener) + .await + .with_context(|| { + format!( + "map udp socket for {local_listener} via gateway {}", + gateway.addr + ) + })?; + + Ok(Self { + backend: PortMappingBackend::Igd { gateway }, + local_listener: local_listener.clone(), + local_addr, + gateway_external_port, + }) + } + + async fn renew(&self) -> anyhow::Result<()> { + match &self.backend { + PortMappingBackend::NatPmp { gateway } => { + renew_udp_mapping_nat_pmp( + *gateway, + self.local_addr, + self.gateway_external_port, + &self.local_listener, + ) + .await + } + PortMappingBackend::Igd { gateway } => { + renew_udp_mapping_igd( + gateway, + self.local_addr, + self.gateway_external_port, + &self.local_listener, + ) + .await + } + } + } + + async fn remove(&self) -> anyhow::Result<()> { + match &self.backend { + PortMappingBackend::NatPmp { gateway } => { + remove_udp_mapping_nat_pmp( + *gateway, + self.local_addr, + self.gateway_external_port, + &self.local_listener, + ) + .await + } + PortMappingBackend::Igd { gateway } => { + remove_udp_mapping_igd(gateway, self.gateway_external_port, &self.local_listener) + .await + } + } + } +} + +#[async_trait] +impl CoreActiveUdpPortMapping for ActiveUdpPortMapping { + fn backend(&self) -> UdpPortMappingBackend { + self.core_backend() + } + + fn local_addr(&self) -> SocketAddr { + self.local_addr + } + + fn gateway_external_port(&self) -> u16 { + self.gateway_external_port + } + + async fn renew(&self) -> anyhow::Result<()> { + ActiveUdpPortMapping::renew(self).await + } + + async fn remove(&self) -> anyhow::Result<()> { + ActiveUdpPortMapping::remove(self).await + } +} + +pub(crate) async fn establish_udp_port_mapping( + net_ns: NetNS, + backend: UdpPortMappingBackend, + local_listener: url::Url, +) -> Result, UdpPortMappingAttemptError> { + let mapping = match backend { + UdpPortMappingBackend::Igd => { + let (gateway, local_addr) = + discover_igd_gateway_in_netns(net_ns.clone(), local_listener.clone()) + .await + .map_err(UdpPortMappingAttemptError::discovery)?; + establish_igd_mapping_in_netns(net_ns, local_listener, gateway, local_addr) + .await + .map_err(UdpPortMappingAttemptError::establishment)? + } + UdpPortMappingBackend::NatPmp => { + let (gateway, local_addr) = + discover_nat_pmp_gateway_in_netns(net_ns.clone(), local_listener.clone()) + .await + .map_err(UdpPortMappingAttemptError::discovery)?; + establish_nat_pmp_mapping_in_netns(net_ns, local_listener, gateway, local_addr) + .await + .map_err(UdpPortMappingAttemptError::establishment)? + } + }; + Ok(Box::new(mapping)) +} + +pub(crate) fn spawn_udp_port_mapping_lifecycle( + net_ns: NetNS, + local_listener: url::Url, + lifecycle: UdpPortMappingLifecycle, +) { + if should_run_port_mapping_in_dedicated_thread(&net_ns) { + tokio::task::spawn_blocking(move || { + let _g = net_ns.guard(); + match tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + { + Ok(runtime) => runtime.block_on(lifecycle), + Err(err) => tracing::error!( + ?err, + %local_listener, + "failed to build runtime for udp port mapping renew task" + ), + } + }); + } else { + tokio::spawn(lifecycle); + } +} + +async fn discover_igd_gateway_in_netns( + net_ns: NetNS, + local_listener: url::Url, +) -> anyhow::Result<(Gateway, SocketAddr)> { + if !should_run_port_mapping_in_dedicated_thread(&net_ns) { + return ActiveUdpPortMapping::discover_igd_gateway(&net_ns, &local_listener).await; + } + + tokio::task::spawn_blocking(move || { + let _g = net_ns.guard(); + tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + .context("build runtime for igd gateway discovery")? + .block_on(ActiveUdpPortMapping::discover_igd_gateway( + &net_ns, + &local_listener, + )) + }) + .await + .context("join igd gateway discovery task")? +} + +async fn establish_igd_mapping_in_netns( + net_ns: NetNS, + local_listener: url::Url, + gateway: Gateway, + local_addr: SocketAddr, +) -> anyhow::Result { + if !should_run_port_mapping_in_dedicated_thread(&net_ns) { + return ActiveUdpPortMapping::establish_via_igd(&local_listener, gateway, local_addr).await; + } + + tokio::task::spawn_blocking(move || { + let _g = net_ns.guard(); + tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + .context("build runtime for igd mapping establishment")? + .block_on(ActiveUdpPortMapping::establish_via_igd( + &local_listener, + gateway, + local_addr, + )) + }) + .await + .context("join igd mapping establishment task")? +} + +async fn discover_nat_pmp_gateway_in_netns( + net_ns: NetNS, + local_listener: url::Url, +) -> anyhow::Result<(Ipv4Addr, SocketAddr)> { + if !should_run_port_mapping_in_dedicated_thread(&net_ns) { + return ActiveUdpPortMapping::discover_nat_pmp_gateway(&local_listener).await; + } + + tokio::task::spawn_blocking(move || { + let _g = net_ns.guard(); + tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + .context("build runtime for nat-pmp gateway discovery")? + .block_on(ActiveUdpPortMapping::discover_nat_pmp_gateway( + &local_listener, + )) + }) + .await + .context("join nat-pmp gateway discovery task")? +} + +async fn establish_nat_pmp_mapping_in_netns( + net_ns: NetNS, + local_listener: url::Url, + gateway: Ipv4Addr, + local_addr: SocketAddr, +) -> anyhow::Result { + if !should_run_port_mapping_in_dedicated_thread(&net_ns) { + return ActiveUdpPortMapping::establish_via_nat_pmp(&local_listener, gateway, local_addr) + .await; + } + + tokio::task::spawn_blocking(move || { + let _g = net_ns.guard(); + tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + .context("build runtime for nat-pmp mapping establishment")? + .block_on(ActiveUdpPortMapping::establish_via_nat_pmp( + &local_listener, + gateway, + local_addr, + )) + }) + .await + .context("join nat-pmp mapping establishment task")? +} + +fn should_run_port_mapping_in_dedicated_thread(net_ns: &NetNS) -> bool { + net_ns.name().is_some() +} + +async fn add_udp_mapping_port_igd( + gateway: &Gateway, + local_addr: SocketAddr, + local_listener: &url::Url, +) -> anyhow::Result { + match gateway + .add_any_port( + PortMappingProtocol::Udp, + local_addr, + UPNP_LEASE_DURATION_SECS, + UPNP_DESCRIPTION, + ) + .await + { + Ok(external_port) => Ok(external_port), + Err(AddAnyPortError::RequestError(err)) => { + tracing::debug!( + ?err, + %local_listener, + gateway = %gateway.addr, + %local_addr, + "igd any-port udp mapping failed, retry with same-port mapping" + ); + + gateway + .add_port( + PortMappingProtocol::Udp, + local_addr.port(), + local_addr, + UPNP_LEASE_DURATION_SECS, + UPNP_DESCRIPTION, + ) + .await + .map(|_| local_addr.port()) + .map_err(|same_port_err| { + anyhow!( + "igd udp mapping failed for {local_listener}: any-port error: {err}; same-port error: {same_port_err}" + ) + }) + } + Err(err) => Err(err.into()), + } +} + +async fn add_udp_mapping_port_nat_pmp( + gateway: Ipv4Addr, + local_addr: SocketAddr, + local_listener: &url::Url, +) -> anyhow::Result { + match request_nat_pmp_mapping(gateway, local_addr.port(), 0, UPNP_LEASE_DURATION_SECS).await { + Ok(external_port) => Ok(external_port), + Err(any_port_err) => { + tracing::debug!( + ?any_port_err, + %local_listener, + gateway = %gateway, + %local_addr, + "nat-pmp any-port udp mapping failed, retry with same-port mapping" + ); + + request_nat_pmp_mapping( + gateway, + local_addr.port(), + local_addr.port(), + UPNP_LEASE_DURATION_SECS, + ) + .await + .map_err(|same_port_err| { + anyhow!( + "nat-pmp udp mapping failed for {local_listener}: any-port error: {any_port_err}; same-port error: {same_port_err}" + ) + }) + } + } +} + +async fn request_nat_pmp_mapping( + gateway: Ipv4Addr, + private_port: u16, + public_port: u16, + lifetime_secs: u32, +) -> anyhow::Result { + let client = new_protected_natpmp(Some(gateway)) + .await + .with_context(|| format!("create nat-pmp client for gateway {gateway}"))?; + client + .send_port_mapping_request( + NatPmpProtocol::UDP, + private_port, + public_port, + lifetime_secs, + ) + .await + .with_context(|| { + format!( + "send nat-pmp udp mapping request private_port={private_port} public_port={public_port} gateway={gateway}" + ) + })?; + + let response = tokio::time::timeout(NAT_PMP_RESPONSE_TIMEOUT, client.read_response_or_retry()) + .await + .with_context(|| { + format!( + "wait nat-pmp udp mapping response private_port={private_port} gateway={gateway}" + ) + })? + .map_err(anyhow::Error::from) + .with_context(|| { + format!( + "read nat-pmp udp mapping response private_port={private_port} gateway={gateway}" + ) + })?; + + match response { + NatPmpResponse::UDP(mapping) | NatPmpResponse::TCP(mapping) => Ok(mapping.public_port()), + NatPmpResponse::Gateway(_) => { + bail!("unexpected nat-pmp gateway response for udp mapping request") + } + } +} + +async fn renew_udp_mapping_nat_pmp( + gateway: Ipv4Addr, + local_addr: SocketAddr, + external_port: u16, + local_listener: &url::Url, +) -> anyhow::Result<()> { + request_nat_pmp_mapping( + gateway, + local_addr.port(), + external_port, + UPNP_LEASE_DURATION_SECS, + ) + .await + .map(|_| ()) + .with_context(|| format!("renew udp port mapping {local_listener}")) +} + +async fn remove_udp_mapping_nat_pmp( + gateway: Ipv4Addr, + local_addr: SocketAddr, + external_port: u16, + local_listener: &url::Url, +) -> anyhow::Result<()> { + request_nat_pmp_mapping(gateway, local_addr.port(), external_port, 0) + .await + .map(|_| ()) + .with_context(|| format!("remove udp port mapping {local_listener}")) +} + +fn listener_ipv4_host(local_listener: &url::Url) -> Option { + local_listener.host_str()?.parse().ok() +} + +async fn resolve_internal_addr( + gateway_addr: SocketAddr, + local_listener: &url::Url, +) -> anyhow::Result { + let port = local_listener + .port() + .ok_or_else(|| anyhow!("listener port is missing"))?; + let host = + listener_ipv4_host(local_listener).ok_or_else(|| anyhow!("listener must be ipv4"))?; + + let ip = if host.is_unspecified() { + let options = easytier_core::socket::udp::UdpBindOptions::default() + .with_local_addr(Some("0.0.0.0:0".parse().unwrap())); + let udp = crate::socket::udp::create_udp_socket(&options) + .await + .context("create protected probe socket for gateway route")?; + udp.connect(gateway_addr) + .await + .with_context(|| format!("connect probe socket to gateway {gateway_addr}"))?; + let SocketAddr::V4(local_addr) = udp.local_addr().context("get probe socket local addr")? + else { + bail!("gateway route selected a non-ipv4 local address"); + }; + *local_addr.ip() + } else { + host + }; + + Ok(SocketAddr::new(ip.into(), port)) +} + +async fn renew_udp_mapping_igd( + gateway: &Gateway, + local_addr: SocketAddr, + external_port: u16, + local_listener: &url::Url, +) -> anyhow::Result<()> { + gateway + .add_port( + PortMappingProtocol::Udp, + external_port, + local_addr, + UPNP_LEASE_DURATION_SECS, + UPNP_DESCRIPTION, + ) + .await + .with_context(|| format!("renew udp port mapping {local_listener}")) +} + +async fn remove_udp_mapping_igd( + gateway: &Gateway, + external_port: u16, + local_listener: &url::Url, +) -> anyhow::Result<()> { + gateway + .remove_port(PortMappingProtocol::Udp, external_port) + .await + .with_context(|| format!("remove udp port mapping {local_listener}")) +} diff --git a/vendor/easytier/easytier/src/core.rs b/vendor/easytier/easytier/src/core.rs new file mode 100644 index 0000000..f2adf9e --- /dev/null +++ b/vendor/easytier/easytier/src/core.rs @@ -0,0 +1,2170 @@ +use crate::{ + ShellType, + common::{ + config::{ + ConfigFileControl, ConfigLoader, ConsoleLoggerConfig, EncryptionAlgorithm, + FileLoggerConfig, LoggingConfigLoader, NetworkIdentity, PeerConfig, PortForwardConfig, + TomlConfigLoader, VpnPortalClientConfig, VpnPortalConfig, add_proxy_network_to_config, + load_config_from_file, load_toml_config_from_path, parse_mapped_listener_urls, + }, + constants::EASYTIER_VERSION, + log, + }, + instance::factory::native_cli_instance_manager, + proto::common::{CompressionAlgoPb, SecureModeConfig}, + rpc_service::ApiRpcServer, + utils::panic::setup_panic_handler, + web_client, +}; +use anyhow::Context; +use cidr::IpCidr; +use clap::{CommandFactory, Parser}; +use easytier_core::config::normalize_secure_mode_config; +use guarden::defer; +use rust_i18n::t; +use std::{ + net::{IpAddr, SocketAddr}, + path::PathBuf, + process::ExitCode, + sync::{Arc, atomic::AtomicBool}, +}; +use strum::VariantArray; +use tokio::io::AsyncReadExt; + +use crate::tunnel::IpScheme; +#[cfg(feature = "jemalloc-prof")] +use jemalloc_ctl::{Access as _, AsName as _, epoch, stats}; + +#[cfg(target_os = "windows")] +windows_service::define_windows_service!(ffi_service_main, win_service_main); + +fn set_prof_active(_active: bool) { + #[cfg(feature = "jemalloc-prof")] + { + const PROF_ACTIVE: &[u8] = b"prof.active\0"; + let name = PROF_ACTIVE.name(); + name.write(_active).expect("Should succeed to set prof"); + } +} + +#[cfg(feature = "jemalloc-prof")] +fn get_dump_profile_path(cur_allocated: usize, suffix: &str) -> String { + format!( + "profile-{}-{}.{}", + cur_allocated, + chrono::Local::now().format("%Y-%m-%d-%H-%M-%S"), + suffix + ) +} + +fn dump_profile(_cur_allocated: usize) { + #[cfg(feature = "jemalloc-prof")] + { + const PROF_DUMP: &[u8] = b"prof.dump\0"; + static mut PROF_DUMP_FILE_NAME: [u8; 128] = [0; 128]; + let file_name_str = get_dump_profile_path(_cur_allocated, "out"); + // copy file name to PROF_DUMP + let file_name = file_name_str.as_bytes(); + let len = file_name.len(); + if len > 127 { + panic!("file name too long"); + } + unsafe { + PROF_DUMP_FILE_NAME[..len].copy_from_slice(file_name); + // set the last byte to 0 + PROF_DUMP_FILE_NAME[len] = 0; + + let name = PROF_DUMP.name(); + name.write(&PROF_DUMP_FILE_NAME[..len + 1]) + .expect("Should succeed to dump profile"); + println!("dump profile to: {}", file_name_str); + } + } +} + +#[derive(Parser, Debug)] +#[command(name = "easytier-core", author, version = EASYTIER_VERSION , about, long_about = None)] +struct Cli { + #[arg( + short = 'w', + long, + env = "ET_CONFIG_SERVER", + help = t!("core_clap.config_server").to_string() + )] + config_server: Option, + + #[arg( + long, + env = "ET_MACHINE_ID", + help = t!("core_clap.machine_id").to_string() + )] + machine_id: Option, + + #[arg( + short, + long, + env = "ET_CONFIG_FILE", + value_delimiter = ',', + help = t!("core_clap.config_file").to_string(), + num_args = 1.., + )] + config_file: Option>, + + #[arg( + long, + env = "ET_CONFIG_DIR", + help = t!("core_clap.config_dir").to_string() + )] + config_dir: Option, + + #[command(flatten)] + network_options: NetworkOptions, + + #[command(flatten)] + logging_options: LoggingOptions, + + #[command(flatten)] + rpc_portal_options: RpcPortalOptions, + + #[clap(long, help = t!("core_clap.generate_completions").to_string())] + gen_autocomplete: Option, + + #[clap(long, help = t!("core_clap.check_config").to_string())] + check_config: bool, + + #[clap(long, help = t!("core_clap.daemon").to_string())] + daemon: bool, + + #[clap(long, help = t!("core_clap.disable_env_parsing").to_string())] + disable_env_parsing: bool, +} + +#[derive(Parser, Debug, Default, PartialEq, Eq)] +struct NetworkOptions { + #[arg( + long, + env = "ET_NETWORK_NAME", + help = t!("core_clap.network_name").to_string(), + )] + network_name: Option, + + #[arg( + long, + env = "ET_NETWORK_SECRET", + help = t!("core_clap.network_secret").to_string(), + )] + network_secret: Option, + + #[arg( + short, + long, + env = "ET_IPV4", + help = t!("core_clap.ipv4").to_string() + )] + ipv4: Option, + + #[arg( + long, + env = "ET_IPV6", + help = t!("core_clap.ipv6").to_string() + )] + ipv6: Option, + + #[arg( + long, + env = "ET_IPV6_PUBLIC_ADDR_PROVIDER", + help = t!("core_clap.ipv6_public_addr_provider").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + ipv6_public_addr_provider: Option, + + #[arg( + long, + env = "ET_IPV6_PUBLIC_ADDR_AUTO", + help = t!("core_clap.ipv6_public_addr_auto").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + ipv6_public_addr_auto: Option, + + #[arg( + long, + env = "ET_IPV6_PUBLIC_ADDR_PREFIX", + help = t!("core_clap.ipv6_public_addr_prefix").to_string() + )] + ipv6_public_addr_prefix: Option, + + #[arg( + short, + long, + env = "ET_DHCP", + help = t!("core_clap.dhcp").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + dhcp: Option, + + #[arg( + short, + long, + env = "ET_PEERS", + value_delimiter = ',', + help = t!("core_clap.peers").to_string(), + num_args = 0.. + )] + peers: Vec, + + #[arg( + short, + long, + env = "ET_EXTERNAL_NODE", + help = t!("core_clap.external_node").to_string() + )] + external_node: Option, + + #[arg( + short = 'n', + long, + env = "ET_PROXY_NETWORKS", + value_delimiter = ',', + help = t!("core_clap.proxy_networks").to_string() + )] + proxy_networks: Vec, + + #[arg( + short, + long, + env = "ET_LISTENERS", + value_delimiter = ',', + help = t!("core_clap.listeners").to_string(), + num_args = 0.. + )] + listeners: Vec, + + #[arg( + long, + env = "ET_MAPPED_LISTENERS", + value_delimiter = ',', + help = t!("core_clap.mapped_listeners").to_string(), + num_args = 0.. + )] + mapped_listeners: Vec, + + #[arg( + long, + env = "ET_NO_LISTENER", + help = t!("core_clap.no_listener").to_string(), + default_value = "false", + )] + no_listener: bool, + + #[arg( + long, + env = "ET_HOSTNAME", + help = t!("core_clap.hostname").to_string() + )] + hostname: Option, + + #[arg( + short = 'm', + long, + env = "ET_INSTANCE_NAME", + help = t!("core_clap.instance_name").to_string(), + )] + instance_name: Option, + + #[arg( + long, + env = "ET_VPN_PORTAL", + help = t!("core_clap.vpn_portal").to_string() + )] + vpn_portal: Option, + + #[arg( + long, + env = "ET_VPN_PORTAL_PRIVATE_KEY", + help = t!("core_clap.vpn_portal_private_key").to_string() + )] + vpn_portal_private_key: Option, + + #[arg( + long = "vpn-portal-client", + env = "ET_VPN_PORTAL_CLIENT", + value_delimiter = ',', + help = t!("core_clap.vpn_portal_client").to_string() + )] + vpn_portal_clients: Vec, + + #[arg( + long = "vpn-portal-client-group", + env = "ET_VPN_PORTAL_CLIENT_GROUP", + value_delimiter = ',', + help = t!("core_clap.vpn_portal_client_group").to_string() + )] + vpn_portal_client_groups: Vec, + + #[arg( + long, + env = "ET_DEFAULT_PROTOCOL", + help = t!("core_clap.default_protocol").to_string() + )] + default_protocol: Option, + + #[arg( + short = 'u', + long, + env = "ET_DISABLE_ENCRYPTION", + help = t!("core_clap.disable_encryption").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_encryption: Option, + + #[arg( + long, + env = "ET_ENCRYPTION_ALGORITHM", + help = t!("core_clap.encryption_algorithm").to_string(), + value_parser = crate::common::config::parse_encryption_algorithm, + )] + encryption_algorithm: Option, + + #[arg( + long, + env = "ET_MULTI_THREAD", + help = t!("core_clap.multi_thread").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + multi_thread: Option, + + #[arg( + long, + env = "ET_MULTI_THREAD_COUNT", + help = t!("core_clap.multi_thread_count").to_string(), + )] + multi_thread_count: Option, + + #[arg( + long, + env = "ET_DISABLE_IPV6", + help = t!("core_clap.disable_ipv6").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_ipv6: Option, + + #[arg( + long, + env = "ET_DEV_NAME", + help = t!("core_clap.dev_name").to_string() + )] + dev_name: Option, + + #[arg( + long, + env = "ET_MTU", + help = t!("core_clap.mtu").to_string() + )] + mtu: Option, + + #[arg( + long, + env = "ET_LATENCY_FIRST", + help = t!("core_clap.latency_first").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + latency_first: Option, + + #[arg( + long, + env = "ET_EXIT_NODES", + value_delimiter = ',', + help = t!("core_clap.exit_nodes").to_string(), + num_args = 0.. + )] + exit_nodes: Vec, + + #[arg( + long, + env = "ET_ENABLE_EXIT_NODE", + help = t!("core_clap.enable_exit_node").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + enable_exit_node: Option, + + #[arg( + long, + env = "ET_PROXY_FORWARD_BY_SYSTEM", + help = t!("core_clap.proxy_forward_by_system").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + proxy_forward_by_system: Option, + + #[arg( + long, + env = "ET_NO_TUN", + help = t!("core_clap.no_tun").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + no_tun: Option, + + #[arg( + long, + env = "ET_USE_SMOLTCP", + help = t!("core_clap.use_smoltcp").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + use_smoltcp: Option, + + #[arg( + long, + env = "ET_MANUAL_ROUTES", + value_delimiter = ',', + help = t!("core_clap.manual_routes").to_string(), + num_args = 0.. + )] + manual_routes: Option>, + + // if not in relay_network_whitelist: + // for foreign virtual network, will refuse the incoming connection + // for local virtual network, will refuse to relay tun packets + #[arg( + long, + env = "ET_RELAY_NETWORK_WHITELIST", + value_delimiter = ',', + help = t!("core_clap.relay_network_whitelist").to_string(), + num_args = 0.. + )] + relay_network_whitelist: Option>, + + #[arg( + long, + env = "ET_P2P_ONLY", + help = t!("core_clap.p2p_only").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + p2p_only: Option, + + #[arg( + long, + env = "ET_LAZY_P2P", + help = t!("core_clap.lazy_p2p").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + lazy_p2p: Option, + + #[arg( + long, + env = "ET_DISABLE_P2P", + help = t!("core_clap.disable_p2p").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_p2p: Option, + + #[arg( + long, + env = "ET_DISABLE_UDP_HOLE_PUNCHING", + help = t!("core_clap.disable_udp_hole_punching").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_udp_hole_punching: Option, + + #[arg( + long, + env = "ET_DISABLE_TCP_HOLE_PUNCHING", + help = t!("core_clap.disable_tcp_hole_punching").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_tcp_hole_punching: Option, + + #[arg( + long, + env = "ET_DISABLE_SYM_HOLE_PUNCHING", + help = t!("core_clap.disable_sym_hole_punching").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_sym_hole_punching: Option, + + #[arg( + long, + env = "ET_DISABLE_UPNP", + help = t!("core_clap.disable_upnp").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_upnp: Option, + + #[arg( + long, + env = "ET_ENABLE_UDP_BROADCAST_RELAY", + help = t!("core_clap.enable_udp_broadcast_relay").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + enable_udp_broadcast_relay: Option, + + #[arg( + long, + env = "ET_RELAY_ALL_PEER_RPC", + help = t!("core_clap.relay_all_peer_rpc").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + relay_all_peer_rpc: Option, + + #[arg( + long, + env = "ET_NEED_P2P", + help = t!("core_clap.need_p2p").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + need_p2p: Option, + + #[cfg(feature = "socks5")] + #[arg( + long, + env = "ET_SOCKS5", + help = t!("core_clap.socks5").to_string() + )] + socks5: Option, + + #[arg( + long, + env = "ET_COMPRESSION", + help = t!("core_clap.compression").to_string(), + )] + compression: Option, + + #[arg( + long, + env = "ET_BIND_DEVICE", + help = t!("core_clap.bind_device").to_string() + )] + bind_device: Option, + + // SO_MARK (fwmark) is a Linux-family kernel feature. Gate the flag out + // entirely on other targets so users on Windows/macOS/BSD don't see a + // `--socket-mark` they can't act on. + #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))] + #[arg( + long, + env = "ET_SOCKET_MARK", + help = t!("core_clap.socket_mark").to_string() + )] + socket_mark: Option, + + #[arg( + long, + env = "ET_ENABLE_KCP_PROXY", + help = t!("core_clap.enable_kcp_proxy").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + enable_kcp_proxy: Option, + + #[arg( + long, + env = "ET_DISABLE_KCP_INPUT", + help = t!("core_clap.disable_kcp_input").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_kcp_input: Option, + + #[arg( + long, + env = "ET_ENABLE_QUIC_PROXY", + help = t!("core_clap.enable_quic_proxy").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + enable_quic_proxy: Option, + + #[arg( + long, + env = "ET_DISABLE_QUIC_INPUT", + help = t!("core_clap.disable_quic_input").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_quic_input: Option, + + #[arg( + long, + env = "ET_PORT_FORWARD", + value_delimiter = ',', + help = t!("core_clap.port_forward").to_string(), + num_args = 1.. + )] + port_forward: Vec, + + #[arg( + long, + env = "ET_ACCEPT_DNS", + help = t!("core_clap.accept_dns").to_string(), + )] + accept_dns: Option, + + #[arg( + long = "tld-dns-zone", + env = "ET_TLD_DNS_ZONE", + help = t!("core_clap.tld_dns_zone").to_string())] + tld_dns_zone: Option, + + #[arg( + long, + env = "ET_PRIVATE_MODE", + help = t!("core_clap.private_mode").to_string(), + )] + private_mode: Option, + + #[arg( + long, + env = "ET_FOREIGN_RELAY_BPS_LIMIT", + help = t!("core_clap.foreign_relay_bps_limit").to_string(), + )] + foreign_relay_bps_limit: Option, + + #[arg( + long, + env = "ET_INSTANCE_RECV_BPS_LIMIT", + help = t!("core_clap.instance_recv_bps_limit").to_string(), + )] + instance_recv_bps_limit: Option, + + #[arg( + long, + value_delimiter = ',', + help = t!("core_clap.tcp_whitelist").to_string(), + num_args = 0.. + )] + tcp_whitelist: Vec, + + #[arg( + long, + value_delimiter = ',', + help = t!("core_clap.udp_whitelist").to_string(), + num_args = 0.. + )] + udp_whitelist: Vec, + + #[arg( + long, + env = "ET_DISABLE_RELAY_KCP", + help = t!("core_clap.disable_relay_kcp").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_relay_kcp: Option, + + #[arg( + long, + env = "ET_DISABLE_RELAY_QUIC", + help = t!("core_clap.disable_relay_quic").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + disable_relay_quic: Option, + + #[arg( + long, + env = "ET_ENABLE_RELAY_FOREIGN_NETWORK_KCP", + help = t!("core_clap.enable_relay_foreign_network_kcp").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + enable_relay_foreign_network_kcp: Option, + + #[arg( + long, + env = "ET_ENABLE_RELAY_FOREIGN_NETWORK_QUIC", + help = t!("core_clap.enable_relay_foreign_network_quic").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + enable_relay_foreign_network_quic: Option, + + #[arg( + long, + env = "ET_STUN_SERVERS", + value_delimiter = ',', + help = t!("core_clap.stun_servers").to_string(), + num_args = 0.. + )] + stun_servers: Option>, + + #[arg( + long, + env = "ET_STUN_SERVERS_V6", + value_delimiter = ',', + help = t!("core_clap.stun_servers_v6").to_string(), + num_args = 0.. + )] + stun_servers_v6: Option>, + + #[arg( + long, + env = "ET_TCP_STUN_SERVERS", + value_delimiter = ',', + help = t!("core_clap.tcp_stun_servers").to_string(), + num_args = 0.. + )] + tcp_stun_servers: Option>, + + #[arg( + long, + env = "ET_SECURE_MODE", + help = t!("core_clap.secure_mode").to_string(), + num_args = 0..=1, + default_missing_value = "true" + )] + secure_mode: Option, + + #[arg( + long, + env = "ET_LOCAL_PRIVATE_KEY", + help = t!("core_clap.local_private_key").to_string() + )] + local_private_key: Option, + + #[arg( + long, + env = "ET_LOCAL_PUBLIC_KEY", + help = t!("core_clap.local_public_key").to_string() + )] + local_public_key: Option, + + #[arg( + long, + env = "ET_CREDENTIAL", + help = t!("core_clap.credential").to_string() + )] + credential: Option, + + #[arg( + long, + env = "ET_CREDENTIAL_FILE", + help = t!("core_clap.credential_file").to_string() + )] + credential_file: Option, +} + +#[derive(Parser, Debug)] +struct LoggingOptions { + #[arg( + long, + env = "ET_CONSOLE_LOG_LEVEL", + help = t!("core_clap.console_log_level").to_string() + )] + console_log_level: Option, + + #[arg( + long, + env = "ET_FILE_LOG_LEVEL", + help = t!("core_clap.file_log_level").to_string() + )] + file_log_level: Option, + + #[arg( + long, + env = "ET_FILE_LOG_DIR", + help = t!("core_clap.file_log_dir").to_string() + )] + file_log_dir: Option, + + #[arg( + long, + env = "ET_FILE_LOG_SIZE", + help = t!("core_clap.file_log_size_mb").to_string() + )] + file_log_size: Option, + + #[arg( + long, + env = "ET_FILE_LOG_COUNT", + help = t!("core_clap.file_log_count").to_string() + )] + file_log_count: Option, +} + +#[derive(Parser, Debug)] +struct RpcPortalOptions { + #[arg( + short, + long, + env = "ET_RPC_PORTAL", + help = t!("core_clap.rpc_portal").to_string(), + )] + rpc_portal: Option, + + #[arg( + long, + env = "ET_RPC_PORTAL_WHITELIST", + value_delimiter = ',', + help = t!("core_clap.rpc_portal_whitelist").to_string(), + )] + rpc_portal_whitelist: Option>, +} + +impl Cli { + fn gen_listeners(addr: SocketAddr) -> impl Iterator { + let dynamic = addr.port() == 0; + IpScheme::VARIANTS.iter().map(move |proto| { + let mut addr = addr; + if !dynamic { + addr.set_port(addr.port() + proto.port_offset()); + } + format!("{}://{}", proto, addr) + }) + } + + fn parse_listeners(no_listener: bool, listeners: Vec) -> anyhow::Result> { + if no_listener || listeners.is_empty() { + return Ok(vec![]); + } + + let mut parsed = vec![]; + + for l in listeners.into_iter() { + if let Ok(port) = l.parse::() { + parsed.extend(Self::gen_listeners(SocketAddr::new( + "0.0.0.0".parse()?, + port, + ))); + continue; + } + + if let Ok(ip) = l.trim_matches(|c| c == '[' || c == ']').parse::() { + parsed.extend(Self::gen_listeners(SocketAddr::new(ip, 11010))); + continue; + } + + if let Ok(addr) = l.parse::() { + parsed.extend(Self::gen_listeners(addr)); + continue; + } + + let (scheme, rest) = l.split_once(':').unwrap_or((&l, "")); + let Ok(scheme) = scheme.parse::() else { + anyhow::bail!("invalid listener: {}", l); + }; + + if rest.is_empty() { + parsed.push(format!( + "{}://0.0.0.0:{}", + scheme, + 11010 + scheme.port_offset() + )); + continue; + } + + if let Ok(port) = rest.parse::() { + parsed.push(format!("{}://0.0.0.0:{}", scheme, port)); + continue; + } + + if !l.parse::()?.has_authority() { + anyhow::bail!("invalid listener: {}", l); + } + parsed.push(l); + } + + Ok(parsed) + } +} + +impl NetworkOptions { + fn parse_vpn_portal_listener(value: &str) -> anyhow::Result { + let url: url::Url = value + .parse() + .with_context(|| format!("failed to parse vpn portal url: {value}"))?; + if url.scheme() != "wg" { + anyhow::bail!("vpn portal URL must use the wg scheme: {value}"); + } + if !url.path().is_empty() { + anyhow::bail!( + "legacy VPN portal CIDR paths are no longer supported; use wg://host:port and configure --vpn-portal-client NAME=CIDR" + ); + } + if !url.username().is_empty() + || url.password().is_some() + || url.query().is_some() + || url.fragment().is_some() + { + anyhow::bail!("vpn portal URL must have the form wg://host:port"); + } + + let host: IpAddr = url + .host_str() + .ok_or_else(|| anyhow::anyhow!("vpn portal url missing host"))? + .parse() + .with_context(|| "vpn portal listener host must be an IP address")?; + let port = url + .port() + .ok_or_else(|| anyhow::anyhow!("vpn portal url missing port"))?; + Ok(SocketAddr::new(host, port)) + } + + fn parse_vpn_portal_clients(&self) -> anyhow::Result> { + let mut clients = self + .vpn_portal_clients + .iter() + .map(|value| { + let (name, virtual_ip) = value.split_once('=').ok_or_else(|| { + anyhow::anyhow!("invalid vpn portal client {value:?}; expected NAME=CIDR") + })?; + if name.is_empty() { + anyhow::bail!("vpn portal client name cannot be empty"); + } + if !virtual_ip.contains('/') { + anyhow::bail!( + "invalid vpn portal client {value:?}; expected NAME=CIDR, for example alice=10.144.0.5/16" + ); + } + Ok(VpnPortalClientConfig { + name: name.to_owned(), + virtual_ip: virtual_ip.parse().with_context(|| { + format!("invalid virtual CIDR for vpn portal client {name}: {virtual_ip}") + })?, + groups: Vec::new(), + }) + }) + .collect::>>()?; + + for value in &self.vpn_portal_client_groups { + let (name, group) = value.split_once('=').ok_or_else(|| { + anyhow::anyhow!("invalid vpn portal client group {value:?}; expected NAME=GROUP") + })?; + if name.is_empty() || group.is_empty() { + anyhow::bail!("vpn portal client group name and group cannot be empty"); + } + let client = clients + .iter_mut() + .find(|client| client.name == name) + .ok_or_else(|| { + anyhow::anyhow!("vpn portal client group references unknown CLI client: {name}") + })?; + client.groups.push(group.to_owned()); + } + + Ok(clients) + } + + fn can_merge( + &self, + cfg: &TomlConfigLoader, + source: ConfigFileSource, + explicit_config_file_count: usize, + config_dir_file_count: usize, + ) -> bool { + if (*self) == NetworkOptions::default() { + return false; + } + + if source == ConfigFileSource::CliConfigFile + && explicit_config_file_count == 1 + && config_dir_file_count == 0 + { + return true; + } + + let Some(network_name) = &self.network_name else { + return false; + }; + + if source == ConfigFileSource::ConfigDir { + return cfg.get_network_identity().network_name == *network_name; + } + + cfg.get_network_identity().network_name == *network_name + } + + fn merge_into(&self, cfg: &TomlConfigLoader) -> anyhow::Result<()> { + if self.hostname.is_some() { + cfg.set_hostname(self.hostname.clone()); + } + + let old_ns = cfg.get_network_identity(); + let network_name = self + .network_name + .clone() + .unwrap_or_else(|| old_ns.network_name.clone()); + + if self.credential.is_some() { + // Credential mode: no network_secret, authenticate via credential keypair + cfg.set_network_identity(NetworkIdentity::new_credential(network_name)); + } else if let Some(network_secret) = &self.network_secret { + cfg.set_network_identity(NetworkIdentity::new(network_name, network_secret.clone())); + } else if let Some(network_secret) = old_ns.network_secret { + cfg.set_network_identity(NetworkIdentity::new(network_name, network_secret)); + } else { + cfg.set_network_identity(NetworkIdentity::new_credential(network_name)); + } + + if let Some(dhcp) = self.dhcp { + cfg.set_dhcp(dhcp); + } + + if let Some(ipv4) = &self.ipv4 { + cfg.set_ipv4(Some(ipv4.parse().with_context(|| { + format!("failed to parse ipv4 address: {}", ipv4) + })?)) + } + + if let Some(ipv6) = &self.ipv6 { + cfg.set_ipv6(Some(ipv6.parse().with_context(|| { + format!("failed to parse ipv6 address: {}", ipv6) + })?)) + } + + if let Some(enabled) = self.ipv6_public_addr_provider { + cfg.set_ipv6_public_addr_provider(enabled); + } + + if let Some(enabled) = self.ipv6_public_addr_auto { + cfg.set_ipv6_public_addr_auto(enabled); + } + + if let Some(prefix) = &self.ipv6_public_addr_prefix { + cfg.set_ipv6_public_addr_prefix(Some(prefix.parse().with_context(|| { + format!("failed to parse ipv6 public address prefix: {}", prefix) + })?)); + } + + if !self.peers.is_empty() { + let mut peers = cfg.get_peers(); + peers.reserve(peers.len() + self.peers.len()); + for p in &self.peers { + peers.push(PeerConfig { + uri: p + .parse() + .with_context(|| format!("failed to parse peer uri: {}", p))?, + peer_public_key: None, + }); + } + cfg.set_peers(peers); + } + + if self.no_listener || !self.listeners.is_empty() { + cfg.set_listeners( + Cli::parse_listeners(self.no_listener, self.listeners.clone()) + .with_context(|| format!("failed to parse listeners: {:?}", self.listeners))? + .into_iter() + .map(|s| s.parse().unwrap()) + .collect(), + ); + } else if cfg.get_listeners().is_none() { + cfg.set_listeners( + Cli::parse_listeners(false, vec!["11010".to_string()])? + .into_iter() + .map(|s| s.parse().unwrap()) + .collect(), + ); + } + + if !self.mapped_listeners.is_empty() { + cfg.set_mapped_listeners(Some(parse_mapped_listener_urls(&self.mapped_listeners)?)); + } + + for n in self.proxy_networks.iter() { + add_proxy_network_to_config(n, cfg)?; + } + + if let Some(external_nodes) = self.external_node.as_ref() { + let mut old_peers = cfg.get_peers(); + old_peers.push(PeerConfig { + uri: external_nodes.parse().with_context(|| { + format!("failed to parse external node uri: {}", external_nodes) + })?, + peer_public_key: None, + }); + cfg.set_peers(old_peers); + } + + if let Some(inst_name) = &self.instance_name { + cfg.set_inst_name(inst_name.clone()); + } + + let has_vpn_portal_overrides = self.vpn_portal.is_some() + || self.vpn_portal_private_key.is_some() + || !self.vpn_portal_clients.is_empty() + || !self.vpn_portal_client_groups.is_empty(); + if has_vpn_portal_overrides { + if self.vpn_portal_clients.is_empty() && !self.vpn_portal_client_groups.is_empty() { + anyhow::bail!( + "--vpn-portal-client-group requires at least one --vpn-portal-client" + ); + } + + let existing = cfg.get_vpn_portal_config(); + let wireguard_listen = match self.vpn_portal.as_deref() { + Some(value) => Self::parse_vpn_portal_listener(value)?, + None => existing + .as_ref() + .map(|portal| portal.wireguard_listen) + .ok_or_else(|| { + anyhow::anyhow!("--vpn-portal is required when no vpn_portal_config exists") + })?, + }; + let wireguard_private_key = self + .vpn_portal_private_key + .clone() + .or_else(|| existing.as_ref()?.wireguard_private_key.clone()); + let enabled = if self.vpn_portal.is_some() { + Some(true) + } else { + existing.as_ref().and_then(|portal| portal.enabled) + }; + let clients = if self.vpn_portal_clients.is_empty() { + existing.map_or_else(Vec::new, |portal| portal.clients) + } else { + self.parse_vpn_portal_clients()? + }; + + cfg.set_vpn_portal_config(VpnPortalConfig { + enabled, + wireguard_listen, + wireguard_private_key, + clients, + }); + } + + if let Some(manual_routes) = self.manual_routes.as_ref() { + let mut routes = Vec::::with_capacity(manual_routes.len()); + for r in manual_routes { + routes.push( + r.parse() + .with_context(|| format!("failed to parse route: {}", r))?, + ); + } + cfg.set_routes(Some(routes)); + } + + #[cfg(feature = "socks5")] + if let Some(socks5_proxy) = self.socks5 { + cfg.set_socks5_portal(Some( + format!("socks5://0.0.0.0:{}", socks5_proxy) + .parse() + .unwrap(), + )); + } + + for port_forward in self.port_forward.iter() { + let example_str = ", example: udp://0.0.0.0:12345/10.126.126.1:12345"; + + let bind_addr = format!( + "{}:{}", + port_forward.host_str().expect("local bind host is missing"), + port_forward.port().expect("local bind port is missing") + ) + .parse() + .unwrap_or_else(|_| panic!("failed to parse local bind addr {}", example_str)); + + let dst_addr = port_forward + .path_segments() + .unwrap_or_else(|| panic!("remote destination addr is missing {}", example_str)) + .next() + .unwrap_or_else(|| panic!("remote destination addr is missing {}", example_str)) + .to_string() + .parse() + .unwrap_or_else(|_| { + panic!("failed to parse remote destination addr {}", example_str) + }); + + let port_forward_item = PortForwardConfig { + bind_addr, + dst_addr, + proto: port_forward.scheme().to_string(), + }; + + let mut old = cfg.get_port_forwards(); + old.push(port_forward_item); + cfg.set_port_forwards(old); + } + + if let Some(ref credential_file) = self.credential_file { + cfg.set_credential_file(Some(credential_file.clone())); + } + + if let Some(ref credential_secret) = self.credential { + // --credential implies --secure-mode and sets the credential private key + let c = SecureModeConfig { + enabled: true, + local_private_key: Some(credential_secret.clone()), + local_public_key: None, + }; + cfg.set_secure_mode(Some(normalize_secure_mode_config(c)?)); + } else if let Some(secure_mode) = self.secure_mode + && secure_mode + { + // CLI key options replace the file's [secure_mode] keypair as a unit; + // without them the keys already loaded from the config file win. + let cli_private_key = self.local_private_key.clone().filter(|k| !k.is_empty()); + let cli_public_key = self.local_public_key.clone().filter(|k| !k.is_empty()); + let (local_private_key, local_public_key) = + if cli_private_key.is_some() || cli_public_key.is_some() { + (cli_private_key, cli_public_key) + } else { + cfg.get_secure_mode() + .map_or((None, None), |c| (c.local_private_key, c.local_public_key)) + }; + let c = SecureModeConfig { + enabled: secure_mode, + local_private_key, + local_public_key, + }; + cfg.set_secure_mode(Some(normalize_secure_mode_config(c)?)); + } + + let mut f = cfg.get_flags(); + if let Some(default_protocol) = &self.default_protocol { + f.default_protocol = default_protocol.clone() + }; + if let Some(v) = self.disable_encryption { + f.enable_encryption = !v; + } + if let Some(algorithm) = &self.encryption_algorithm { + f.encryption_algorithm = algorithm.to_string(); + } + if let Some(v) = self.disable_ipv6 { + f.enable_ipv6 = !v; + } + f.latency_first = self.latency_first.unwrap_or(f.latency_first); + if let Some(dev_name) = &self.dev_name { + f.dev_name = dev_name.clone() + } + if let Some(mtu) = self.mtu { + f.mtu = mtu as u32; + } + f.enable_exit_node = self.enable_exit_node.unwrap_or(f.enable_exit_node); + f.proxy_forward_by_system = self + .proxy_forward_by_system + .unwrap_or(f.proxy_forward_by_system); + f.no_tun = self.no_tun.unwrap_or(f.no_tun) || cfg!(not(feature = "tun")); + f.use_smoltcp = self.use_smoltcp.unwrap_or(f.use_smoltcp); + if let Some(wl) = self.relay_network_whitelist.as_ref() { + f.relay_network_whitelist = wl.join(" "); + } + f.disable_p2p = self.disable_p2p.unwrap_or(f.disable_p2p); + f.p2p_only = self.p2p_only.unwrap_or(f.p2p_only); + f.lazy_p2p = self.lazy_p2p.unwrap_or(f.lazy_p2p); + f.disable_tcp_hole_punching = self + .disable_tcp_hole_punching + .unwrap_or(f.disable_tcp_hole_punching); + f.disable_udp_hole_punching = self + .disable_udp_hole_punching + .unwrap_or(f.disable_udp_hole_punching); + f.relay_all_peer_rpc = self.relay_all_peer_rpc.unwrap_or(f.relay_all_peer_rpc); + f.need_p2p = self.need_p2p.unwrap_or(f.need_p2p); + f.multi_thread = self.multi_thread.unwrap_or(f.multi_thread); + if let Some(compression) = &self.compression { + f.data_compress_algo = match compression.as_str() { + "none" => CompressionAlgoPb::None, + "zstd" => CompressionAlgoPb::Zstd, + _ => panic!( + "unknown compression algorithm: {}, supported: none, zstd", + compression + ), + } + .into(); + } + f.bind_device = self.bind_device.unwrap_or(f.bind_device); + #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))] + { + f.socket_mark = self.socket_mark.or(f.socket_mark); + } + f.enable_kcp_proxy = self.enable_kcp_proxy.unwrap_or(f.enable_kcp_proxy); + f.disable_kcp_input = self.disable_kcp_input.unwrap_or(f.disable_kcp_input); + f.enable_quic_proxy = self.enable_quic_proxy.unwrap_or(f.enable_quic_proxy); + f.disable_quic_input = self.disable_quic_input.unwrap_or(f.disable_quic_input); + f.accept_dns = self.accept_dns.unwrap_or(f.accept_dns); + f.private_mode = self.private_mode.unwrap_or(f.private_mode); + f.foreign_relay_bps_limit = self + .foreign_relay_bps_limit + .unwrap_or(f.foreign_relay_bps_limit); + f.instance_recv_bps_limit = self + .instance_recv_bps_limit + .unwrap_or(f.instance_recv_bps_limit); + f.multi_thread_count = self.multi_thread_count.unwrap_or(f.multi_thread_count); + f.disable_relay_kcp = self.disable_relay_kcp.unwrap_or(f.disable_relay_kcp); + f.disable_relay_quic = self.disable_relay_quic.unwrap_or(f.disable_relay_quic); + f.enable_relay_foreign_network_kcp = self + .enable_relay_foreign_network_kcp + .unwrap_or(f.enable_relay_foreign_network_kcp); + f.enable_relay_foreign_network_quic = self + .enable_relay_foreign_network_quic + .unwrap_or(f.enable_relay_foreign_network_quic); + f.disable_sym_hole_punching = self + .disable_sym_hole_punching + .unwrap_or(f.disable_sym_hole_punching); + f.disable_upnp = self.disable_upnp.unwrap_or(f.disable_upnp); + f.enable_udp_broadcast_relay = self + .enable_udp_broadcast_relay + .unwrap_or(f.enable_udp_broadcast_relay); + // Configure tld_dns_zone: use provided value if set + if let Some(tld_dns_zone) = &self.tld_dns_zone { + f.tld_dns_zone = tld_dns_zone.clone(); + } + cfg.set_flags(f); + + if !self.exit_nodes.is_empty() { + cfg.set_exit_nodes(self.exit_nodes.clone()); + } + + let mut old_tcp_whitelist = cfg.get_tcp_whitelist(); + old_tcp_whitelist.extend(self.tcp_whitelist.clone()); + cfg.set_tcp_whitelist(old_tcp_whitelist); + + let mut old_udp_whitelist = cfg.get_udp_whitelist(); + old_udp_whitelist.extend(self.udp_whitelist.clone()); + cfg.set_udp_whitelist(old_udp_whitelist); + + if let Some(stun_servers) = &self.stun_servers { + if stun_servers.is_empty() { + cfg.set_stun_servers(Some(Vec::new())); + } else { + let mut old_stun_servers = cfg.get_stun_servers().unwrap_or_default(); + old_stun_servers.extend(stun_servers.iter().cloned()); + cfg.set_stun_servers(Some(old_stun_servers)); + } + } + + if let Some(stun_servers_v6) = &self.stun_servers_v6 { + if stun_servers_v6.is_empty() { + cfg.set_stun_servers_v6(Some(Vec::new())); + } else { + let mut old_stun_servers_v6 = cfg.get_stun_servers_v6().unwrap_or_default(); + old_stun_servers_v6.extend(stun_servers_v6.iter().cloned()); + cfg.set_stun_servers_v6(Some(old_stun_servers_v6)); + } + } + + if let Some(tcp_stun_servers) = &self.tcp_stun_servers { + if tcp_stun_servers.is_empty() { + cfg.set_tcp_stun_servers(Some(Vec::new())); + } else { + let mut old_tcp_stun_servers = cfg.get_tcp_stun_servers().unwrap_or_default(); + old_tcp_stun_servers.extend(tcp_stun_servers.iter().cloned()); + cfg.set_tcp_stun_servers(Some(old_tcp_stun_servers)); + } + } + Ok(()) + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum ConfigFileSource { + CliConfigFile, + ConfigDir, +} + +impl LoggingConfigLoader for &LoggingOptions { + fn get_console_logger_config(&self) -> ConsoleLoggerConfig { + ConsoleLoggerConfig { + level: self.console_log_level.clone(), + } + } + + fn get_file_logger_config(&self) -> FileLoggerConfig { + FileLoggerConfig { + level: self.file_log_level.clone(), + dir: self.file_log_dir.clone(), + file: None, + size_mb: self.file_log_size, + count: self.file_log_count, + } + } +} + +#[cfg(target_os = "windows")] +fn win_service_set_work_dir(service_name: &std::ffi::OsString) -> anyhow::Result<()> { + use crate::common::constants::WIN_SERVICE_WORK_DIR_REG_KEY; + use winreg::{RegKey, enums::*}; + + let hklm = RegKey::predef(HKEY_LOCAL_MACHINE); + let key = hklm.open_subkey_with_flags(WIN_SERVICE_WORK_DIR_REG_KEY, KEY_READ)?; + let dir_pat_str = key.get_value::(service_name)?; + let dir_path = std::fs::canonicalize(dir_pat_str)?; + + std::env::set_current_dir(dir_path)?; + + Ok(()) +} + +#[cfg(target_os = "windows")] +fn win_service_event_loop( + stop_notify: std::sync::Arc, + cli: Cli, + status_handle: windows_service::service_control_handler::ServiceStatusHandle, +) { + use std::time::Duration; + use tokio::runtime::Runtime; + use windows_service::service::*; + + let normal_status = ServiceStatus { + service_type: ServiceType::OWN_PROCESS, + current_state: ServiceState::Running, + controls_accepted: ServiceControlAccept::STOP, + exit_code: ServiceExitCode::Win32(0), + checkpoint: 0, + wait_hint: Duration::default(), + process_id: None, + }; + let error_status = ServiceStatus { + service_type: ServiceType::OWN_PROCESS, + current_state: ServiceState::Stopped, + controls_accepted: ServiceControlAccept::empty(), + exit_code: ServiceExitCode::ServiceSpecific(1u32), + checkpoint: 0, + wait_hint: Duration::default(), + process_id: None, + }; + + std::thread::spawn(move || { + let rt = Runtime::new().unwrap(); + rt.block_on(async move { + tokio::select! { + res = run_main(cli) => { + match res { + Ok(_) => { + status_handle.set_service_status(normal_status).unwrap(); + std::process::exit(0); + } + Err(error) => { + status_handle.set_service_status(error_status).unwrap(); + log::error!(?error); + // exit with non-zero code so the SCM treats this as + // a non-crash failure and applies the configured + // failure actions; staying alive would leave a + // zombie process until the SCM force-kills it. + std::process::exit(1); + } + } + }, + _ = stop_notify.notified() => { + _ = status_handle.set_service_status(normal_status); + std::process::exit(0); + } + } + }); + }); +} + +fn parse_cli() -> Cli { + let mut cli = Cli::parse(); + // for --stun-servers="", we want vec![], but clap will give vec![""], hack for that + if let Some(stun_servers) = &mut cli.network_options.stun_servers { + stun_servers.retain(|s| !s.trim().is_empty()); + } + if let Some(stun_servers_v6) = &mut cli.network_options.stun_servers_v6 { + stun_servers_v6.retain(|s| !s.trim().is_empty()); + } + if let Some(tcp_stun_servers) = &mut cli.network_options.tcp_stun_servers { + tcp_stun_servers.retain(|s| !s.trim().is_empty()); + } + cli +} + +#[cfg(target_os = "windows")] +fn win_service_main(arg: Vec) { + use std::{sync::Arc, time::Duration}; + use tokio::sync::Notify; + use windows_service::{service::*, service_control_handler::*}; + + _ = win_service_set_work_dir(&arg[0]); + + let cli = parse_cli(); + + let stop_notify_send = Arc::new(Notify::new()); + let stop_notify_recv = Arc::clone(&stop_notify_send); + let event_handler = move |control_event| -> ServiceControlHandlerResult { + match control_event { + ServiceControl::Interrogate => ServiceControlHandlerResult::NoError, + ServiceControl::Stop => { + stop_notify_send.notify_one(); + ServiceControlHandlerResult::NoError + } + _ => ServiceControlHandlerResult::NotImplemented, + } + }; + let status_handle = register(String::new(), event_handler).expect("register service fail"); + let next_status = ServiceStatus { + service_type: ServiceType::OWN_PROCESS, + current_state: ServiceState::Running, + controls_accepted: ServiceControlAccept::STOP, + exit_code: ServiceExitCode::Win32(0), + checkpoint: 0, + wait_hint: Duration::default(), + process_id: None, + }; + status_handle + .set_service_status(next_status) + .expect("set service status fail"); + + win_service_event_loop(stop_notify_recv, cli, status_handle); +} + +async fn run_main(cli: Cli) -> anyhow::Result<()> { + defer!(dump_profile(0);); + log::init(&cli.logging_options, true)?; + + let manager = Arc::new(native_cli_instance_manager().with_config_path(cli.config_dir.clone())); + + let _rpc_server = ApiRpcServer::new( + cli.rpc_portal_options.rpc_portal, + cli.rpc_portal_options.rpc_portal_whitelist, + manager.clone(), + )? + .serve() + .await?; + + let _web_client = if let Some(config_server_url_s) = cli.config_server.as_ref() { + let wc = web_client::run_web_client( + config_server_url_s, + crate::common::MachineIdOptions { + explicit_machine_id: cli.machine_id.clone(), + state_dir: None, + }, + cli.network_options.hostname.clone(), + cli.network_options.secure_mode.unwrap_or(false), + manager.clone(), + None, + ) + .await + .inspect(|_| { + log::info!( + server = config_server_url_s, + "Web client started successfully...", + ); + + log::info!("Official config website: https://easytier.cn/web"); + })?; + + Some(wc) + } else { + None + }; + + let _daemon_guard = if cli.daemon { + Some(manager.register_daemon()) + } else { + None + }; + + let explicit_config_file_count = cli.config_file.as_ref().map_or(0, |files| files.len()); + let mut config_dir_file_count = 0; + let mut config_files = if let Some(v) = cli.config_file { + v.iter() + .cloned() + .map(|path| (path, ConfigFileSource::CliConfigFile)) + .collect() + } else { + vec![] + }; + if let Some(config_dir) = cli.config_dir.as_ref() { + if !config_dir.is_dir() { + anyhow::bail!("config_dir {} is not a directory", config_dir.display()); + } + + for entry in std::fs::read_dir(config_dir)? { + let entry = entry?; + let path = entry.path(); + if !path.is_file() { + continue; + } + let Some(ext) = path.extension() else { + continue; + }; + if ext != "toml" { + continue; + } + config_dir_file_count += 1; + config_files.push((path, ConfigFileSource::ConfigDir)); + } + } + let config_file_count = config_files.len(); + let mut crate_cli_network = { + if cli.daemon { + false + } else if config_file_count == 0 && cli.config_server.is_none() { + true + } else { + cli.network_options.network_name.is_some() + } + }; + for (config_file, source) in config_files { + let (cfg, mut control) = load_config_from_file( + &config_file, + cli.config_dir.as_ref(), + cli.disable_env_parsing, + ) + .await?; + + if cli.network_options.can_merge( + &cfg, + source, + explicit_config_file_count, + config_dir_file_count, + ) { + cli.network_options + .merge_into(&cfg) + .with_context(|| format!("failed to merge config from cli: {:?}", config_file))?; + crate_cli_network = false; + control.set_read_only(true); + control.set_no_delete(true); + } + + log::info!( + "\ + Starting easytier from config file {:?}({:?}) with config:\n\ + ############### TOML ###############\n\ + {}\n\ + -----------------------------------\n\ + ", + config_file, + control.permission, + cfg.dump_redacted() + ); + manager.run_network_instance(cfg, control)?; + } + + if crate_cli_network { + let cfg = TomlConfigLoader::default(); + cli.network_options + .merge_into(&cfg) + .with_context(|| "failed to create config from cli".to_string())?; + log::info!( + "\ + Starting easytier from cli with config:\n\ + ############### TOML ###############\n\ + {}\n\ + -----------------------------------\n\ + ", + cfg.dump_redacted() + ); + manager.run_network_instance(cfg, ConfigFileControl::STATIC_CONFIG)?; + } + + #[cfg(unix)] + let mut sigterm = tokio::signal::unix::signal(tokio::signal::unix::SignalKind::terminate())?; + #[cfg(unix)] + let sigterm = sigterm.recv(); + #[cfg(not(unix))] + let sigterm = std::future::pending::<()>(); + + tokio::select! { + _ = manager.wait() => { + let infos = manager.collect_network_infos().await?; + if infos + .into_values() + .filter_map(|info| info.error_msg).next().is_some() { + return Err(anyhow::anyhow!("some instances stopped with errors")); + } + } + _ = tokio::signal::ctrl_c() => { + log::info!("ctrl-c received, exiting..."); + } + + _ = sigterm, if cfg!(unix) => { + log::warn!("terminate signal received, exiting..."); + } + } + Ok(()) +} + +fn memory_monitor(_force_dump: Arc) { + #[cfg(feature = "jemalloc-prof")] + { + let mut last_peak_size = 0; + let e = epoch::mib().unwrap(); + let allocated_stats = stats::allocated::mib().unwrap(); + + loop { + e.advance().unwrap(); + let new_heap_size = allocated_stats.read().unwrap(); + + log::debug!("heap size: {} bytes", new_heap_size); + + // dump every 75MB + if (last_peak_size > 0 + && new_heap_size > last_peak_size + && new_heap_size - last_peak_size > 10 * 1024 * 1024) + || _force_dump.load(std::sync::atomic::Ordering::Relaxed) + { + log::debug!( + "heap size increased: {} bytes", + new_heap_size - last_peak_size, + ); + dump_profile(new_heap_size); + last_peak_size = new_heap_size; + if _force_dump.load(std::sync::atomic::Ordering::Relaxed) { + // also dump whole jemalloc stats + use jemalloc_ctl::stats_print::stats_print; + let tmp_file = get_dump_profile_path(new_heap_size, "stats"); + let mut file = std::fs::File::create(tmp_file).unwrap(); + let _ = stats_print(&mut file, Default::default()); + _force_dump.store(false, std::sync::atomic::Ordering::Relaxed); + } + } + + if last_peak_size == 0 { + last_peak_size = new_heap_size; + } + + std::thread::sleep(std::time::Duration::from_secs(5)); + } + } +} + +pub async fn main() -> ExitCode { + let locale = sys_locale::get_locale().unwrap_or_else(|| String::from("en-US")); + rust_i18n::set_locale(&locale); + setup_panic_handler(); + crate::utils::init_crypto_provider(); + + #[cfg(target_os = "windows")] + match windows_service::service_dispatcher::start(String::new(), ffi_service_main) { + Ok(_) => std::thread::park(), + Err(e) => { + let should_panic = if let windows_service::Error::Winapi(ref io_error) = e { + io_error.raw_os_error() != Some(0x427) // ERROR_FAILED_SERVICE_CONTROLLER_CONNECT + } else { + true + }; + + if should_panic { + panic!("SCM start an error: {}", e); + } + } + }; + + set_prof_active(true); + // register a signal handler to set force dump when signal usr1 is received + let force_dump = Arc::new(AtomicBool::new(false)); + #[cfg(all(feature = "jemalloc-prof", not(target_os = "windows")))] + { + let force_dump_clone = force_dump.clone(); + let mut sigusr1 = + tokio::signal::unix::signal(tokio::signal::unix::SignalKind::user_defined1()).unwrap(); + tokio::task::spawn(async move { + while sigusr1.recv().await.is_some() { + force_dump_clone.store(true, std::sync::atomic::Ordering::Relaxed); + } + }); + } + let _monitor = std::thread::spawn(move || memory_monitor(force_dump)); + + let cli = parse_cli(); + + if let Some(shell) = cli.gen_autocomplete { + let mut cmd = Cli::command(); + if let Some(shell) = shell.to_shell() { + crate::print_completions(shell, &mut cmd, "easytier-core"); + } else { + // Handle Nushell + crate::print_nushell_completions(&mut cmd, "easytier-core"); + } + return ExitCode::SUCCESS; + } + + // Verify configurations + if cli.check_config { + if let Err(error) = validate_config(&cli).await { + log::error!(%error, "Config validation failed"); + return ExitCode::FAILURE; + } else { + return ExitCode::SUCCESS; + } + } + + let mut ret_code = 0; + + if let Err(error) = run_main(cli).await { + log::error!(%error); + ret_code = 1; + } + + log::info!("Stopping easytier..."); + set_prof_active(false); + + ExitCode::from(ret_code) +} + +async fn validate_config(cli: &Cli) -> anyhow::Result<()> { + // Check if a config file is provided + let config_files = cli + .config_file + .as_ref() + .ok_or_else(|| anyhow::anyhow!("--config-file is required when using --check-config"))?; + + for config_file in config_files { + if config_file == &PathBuf::from("-") { + let mut stdin = String::new(); + _ = tokio::io::stdin() + .read_to_string(&mut stdin) + .await + .context("failed to read config from stdin")?; + TomlConfigLoader::new_from_str_with_source("stdin", stdin.as_str())?; + } else { + load_toml_config_from_path(config_file)?; + }; + } + + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_parse_listeners() { + type IpSchemeMap = fn(&IpScheme) -> String; + + let cases: [(&str, IpSchemeMap); _] = [ + ("0", |s| format!("{}://0.0.0.0:0", s)), + ("11010", |s| { + format!("{}://0.0.0.0:{}", s, 11010 + s.port_offset()) + }), + ("1.1.1.1", |s| { + format!("{}://1.1.1.1:{}", s, 11010 + s.port_offset()) + }), + ("1.1.1.1:50000", |s| { + format!("{}://1.1.1.1:{}", s, 50000 + s.port_offset()) + }), + ("[::1]", |s| { + format!("{}://[::1]:{}", s, 11010 + s.port_offset()) + }), + ("[::1]:50000", |s| { + format!("{}://[::1]:{}", s, 50000 + s.port_offset()) + }), + ]; + + for (input, output) in cases { + assert_eq!( + Cli::parse_listeners(false, vec![input.to_string()]).unwrap(), + IpScheme::VARIANTS.iter().map(output).collect::>() + ); + } + + let input = cases.iter().map(|(i, _)| i.to_string()).collect::>(); + let output = cases + .iter() + .flat_map(|(_, o)| IpScheme::VARIANTS.iter().map(o)) + .collect::>(); + assert_eq!(Cli::parse_listeners(false, input).unwrap(), output); + + let cases: [(IpSchemeMap, IpSchemeMap); _] = [ + ( + |s| format!("{}", s), + |s| format!("{}://0.0.0.0:{}", s, 11010 + s.port_offset()), + ), + ( + |s| format!("{}:50000", s), + |s| format!("{}://0.0.0.0:50000", s), + ), + ( + |s| format!("{}://1.1.1.1:50000", s), + |s| format!("{}://1.1.1.1:50000", s), + ), + ]; + + for (input, output) in cases { + assert_eq!( + Cli::parse_listeners( + false, + IpScheme::VARIANTS.iter().map(input).collect::>(), + ) + .unwrap(), + IpScheme::VARIANTS.iter().map(output).collect::>() + ); + } + + let input = cases + .iter() + .flat_map(|(i, _)| IpScheme::VARIANTS.iter().map(i)) + .collect::>(); + let output = cases + .iter() + .flat_map(|(_, o)| IpScheme::VARIANTS.iter().map(o)) + .collect::>(); + assert_eq!(Cli::parse_listeners(false, input).unwrap(), output); + + let cases = ["tcp://[::1", "xxx", "tcp:/abc", "tcp:abc"]; + for input in cases { + assert!( + Cli::parse_listeners(false, vec![input.to_string()]).is_err(), + "input: {}", + input + ); + } + } + + #[test] + fn test_network_options_merge_preserves_credential_identity() { + let cfg = TomlConfigLoader::new_from_str( + r#" +[network_identity] +network_name = "credential-network" +network_secret = "" + +[secure_mode] +enabled = true +"#, + ) + .unwrap(); + assert_eq!(cfg.get_network_identity().network_secret, None); + + NetworkOptions { + hostname: Some("override-host".to_string()), + ..Default::default() + } + .merge_into(&cfg) + .unwrap(); + + let identity = cfg.get_network_identity(); + assert_eq!(identity.network_name, "credential-network"); + assert_eq!(identity.network_secret, None); + assert_eq!(identity.network_secret_digest, None); + assert_eq!(cfg.get_hostname(), "override-host"); + } + + #[test] + fn secure_mode_cli_flag_preserves_config_file_keypair() { + use base64::{Engine as _, prelude::BASE64_STANDARD}; + let private = x25519_dalek::StaticSecret::random_from_rng(rand::rngs::OsRng); + let cfg = TomlConfigLoader::new_from_str(&format!( + r#" +[secure_mode] +enabled = true +local_private_key = "{}" +"#, + BASE64_STANDARD.encode(private.as_bytes()) + )) + .unwrap(); + let file_keypair = cfg.get_secure_mode().unwrap(); + + NetworkOptions { + secure_mode: Some(true), + ..Default::default() + } + .merge_into(&cfg) + .unwrap(); + + let merged = cfg.get_secure_mode().unwrap(); + assert!(merged.enabled); + assert_eq!(merged.local_private_key, file_keypair.local_private_key); + assert_eq!(merged.local_public_key, file_keypair.local_public_key); + assert_eq!(merged.private_key().unwrap().as_bytes(), private.as_bytes()); + } + + #[test] + fn secure_mode_cli_key_replaces_config_file_keypair() { + use base64::{Engine as _, prelude::BASE64_STANDARD}; + let cfg = TomlConfigLoader::new_from_str( + r#" +[secure_mode] +enabled = true +"#, + ) + .unwrap(); + let cli_private = x25519_dalek::StaticSecret::random_from_rng(rand::rngs::OsRng); + + NetworkOptions { + secure_mode: Some(true), + local_private_key: Some(BASE64_STANDARD.encode(cli_private.as_bytes())), + ..Default::default() + } + .merge_into(&cfg) + .unwrap(); + + let merged = cfg.get_secure_mode().unwrap(); + assert_eq!( + merged.private_key().unwrap().as_bytes(), + cli_private.as_bytes() + ); + assert_eq!( + merged.public_key().unwrap().as_bytes(), + x25519_dalek::PublicKey::from(&cli_private).as_bytes() + ); + } + + #[test] + fn empty_stun_server_options_clear_existing_config() { + let cfg = TomlConfigLoader::new_from_str( + r#" +stun_servers = ["udp.example.com:3478"] +stun_servers_v6 = ["v6.example.com:3478"] +tcp_stun_servers = ["tcp.example.com:3478"] +"#, + ) + .unwrap(); + + NetworkOptions { + stun_servers: Some(Vec::new()), + stun_servers_v6: Some(Vec::new()), + tcp_stun_servers: Some(Vec::new()), + ..Default::default() + } + .merge_into(&cfg) + .unwrap(); + + assert_eq!(cfg.get_stun_servers(), Some(Vec::new())); + assert_eq!(cfg.get_stun_servers_v6(), Some(Vec::new())); + assert_eq!(cfg.get_tcp_stun_servers(), Some(Vec::new())); + } + + #[test] + fn vpn_portal_cli_uses_named_clients_and_preserves_unset_fields() { + let cfg = TomlConfigLoader::new_from_str( + r#" +[vpn_portal_config] +wireguard_listen = "127.0.0.1:51820" +wireguard_private_key = "existing-key" + +[[vpn_portal_config.clients]] +name = "existing" +virtual_ip = "10.144.144.9/24" +"#, + ) + .unwrap(); + + NetworkOptions { + vpn_portal: Some("wg://0.0.0.0:51821".to_owned()), + ..Default::default() + } + .merge_into(&cfg) + .unwrap(); + let preserved = cfg.get_vpn_portal_config().unwrap(); + assert_eq!(preserved.wireguard_listen, "0.0.0.0:51821".parse().unwrap()); + assert_eq!( + preserved.wireguard_private_key.as_deref(), + Some("existing-key") + ); + assert_eq!(preserved.clients[0].name, "existing"); + + NetworkOptions { + vpn_portal_private_key: Some("replacement-key".to_owned()), + vpn_portal_clients: vec![ + "alice=10.144.144.10/24".to_owned(), + "bob=10.144.144.11/24".to_owned(), + ], + vpn_portal_client_groups: vec!["alice=staff".to_owned(), "alice=dev".to_owned()], + ..Default::default() + } + .merge_into(&cfg) + .unwrap(); + + let replaced = cfg.get_vpn_portal_config().unwrap(); + assert_eq!(replaced.wireguard_listen, "0.0.0.0:51821".parse().unwrap()); + assert_eq!( + replaced.wireguard_private_key.as_deref(), + Some("replacement-key") + ); + assert_eq!( + replaced + .clients + .iter() + .map(|client| client.name.as_str()) + .collect::>(), + vec!["alice", "bob"] + ); + assert_eq!( + replaced.clients[0].groups, + vec!["staff".to_owned(), "dev".to_owned()] + ); + assert!(replaced.clients[1].groups.is_empty()); + } + + #[test] + fn vpn_portal_cli_rejects_legacy_path_and_invalid_group_mapping() { + let error = NetworkOptions::parse_vpn_portal_listener("wg://0.0.0.0:51820/10.14.14.0/24") + .unwrap_err() + .to_string(); + assert!(error.contains("legacy VPN portal CIDR"), "{error}"); + + let cfg = TomlConfigLoader::default(); + let missing_clients = NetworkOptions { + vpn_portal: Some("wg://0.0.0.0:51820".to_owned()), + vpn_portal_client_groups: vec!["alice=staff".to_owned()], + ..Default::default() + } + .merge_into(&cfg) + .unwrap_err() + .to_string(); + assert!( + missing_clients.contains("requires at least one --vpn-portal-client"), + "{missing_clients}" + ); + + let unknown_client = NetworkOptions { + vpn_portal: Some("wg://0.0.0.0:51820".to_owned()), + vpn_portal_clients: vec!["alice=10.144.144.10/24".to_owned()], + vpn_portal_client_groups: vec!["bob=staff".to_owned()], + ..Default::default() + } + .merge_into(&TomlConfigLoader::default()) + .unwrap_err() + .to_string(); + assert!( + unknown_client.contains("unknown CLI client: bob"), + "{unknown_client}" + ); + + let bare_ip = NetworkOptions { + vpn_portal_clients: vec!["alice=10.144.144.10".to_owned()], + ..Default::default() + } + .parse_vpn_portal_clients() + .unwrap_err() + .to_string(); + assert!(bare_ip.contains("expected NAME=CIDR"), "{bare_ip}"); + } + + #[test] + fn vpn_portal_cli_repeat_flags_use_singular_names() { + let cli = Cli::try_parse_from([ + "easytier-core", + "--vpn-portal", + "wg://0.0.0.0:51820", + "--vpn-portal-private-key", + "private-key", + "--vpn-portal-client", + "alice=10.144.144.10", + "--vpn-portal-client", + "bob=10.144.144.11", + "--vpn-portal-client-group", + "alice=staff", + ]) + .unwrap(); + + assert_eq!( + cli.network_options.vpn_portal_clients, + vec![ + "alice=10.144.144.10".to_owned(), + "bob=10.144.144.11".to_owned() + ] + ); + assert_eq!( + cli.network_options.vpn_portal_client_groups, + vec!["alice=staff".to_owned()] + ); + assert_eq!( + cli.network_options.vpn_portal_private_key.as_deref(), + Some("private-key") + ); + } +} diff --git a/vendor/easytier/easytier/src/easytier-cli.rs b/vendor/easytier/easytier/src/easytier-cli.rs new file mode 100644 index 0000000..bcb2fa8 --- /dev/null +++ b/vendor/easytier/easytier/src/easytier-cli.rs @@ -0,0 +1,3702 @@ +#![cfg(feature = "cli")] + +use std::{ + collections::{BTreeMap, HashMap}, + ffi::OsString, + future::Future, + net::{IpAddr, SocketAddr}, + path::PathBuf, + pin::Pin, + str::FromStr, + sync::Arc, + time::Duration, + vec, +}; + +use anyhow::Context; +use base64::Engine as _; +use base64::prelude::BASE64_STANDARD; +use cidr::Ipv4Inet; +use clap::{ArgAction, Args, CommandFactory, Parser, Subcommand, builder::BoolishValueParser}; +use dashmap::DashMap; +use easytier::ShellType; +use easytier_core::connectivity::stun::StunInfoProvider as _; +use humansize::format_size; +use rust_i18n::t; +use service_manager::*; +use tabled::settings::{Modify, Remove, Style, Width, location::ByColumnName, object::Columns}; +use terminal_size::{Width as TerminalWidth, terminal_size}; +use unicode_width::UnicodeWidthStr; + +use easytier::service_manager::{Service, ServiceInstallOptions}; +use tokio::time::timeout; + +use easytier::{ + common::{constants::EASYTIER_VERSION, stun::runtime_stun_info_collector}, + proto::{ + acl::{Acl, AclStats}, + api::{ + config::{ + AclPatch, ConfigPatchAction, ConfigRpc, ConfigRpcClientFactory, + InstanceConfigPatch, PatchConfigRequest, PortForwardPatch, StringPatch, UrlPatch, + VpnPortalClientPatch, + }, + instance::{ + AclManageRpc, AclManageRpcClientFactory, Connector, ConnectorManageRpc, + ConnectorManageRpcClientFactory, CredentialManageRpc, + CredentialManageRpcClientFactory, DumpRouteRequest, ForeignNetworkEntryPb, + GenerateCredentialRequest, GetAclStatsRequest, GetPrometheusStatsRequest, + GetStatsRequest, GetVpnPortalInfoRequest, GetWhitelistRequest, + GetWhitelistResponse, InstanceIdentifier, ListConnectorRequest, + ListCredentialsRequest, ListCredentialsResponse, ListForeignNetworkRequest, + ListGlobalForeignNetworkRequest, ListMappedListenerRequest, ListPeerRequest, + ListPeerResponse, ListPortForwardRequest, ListPortForwardResponse, + ListPublicIpv6InfoRequest, ListPublicIpv6InfoResponse, ListRouteRequest, + ListRouteResponse, MappedListener, MappedListenerManageRpc, + MappedListenerManageRpcClientFactory, MetricSnapshot, NodeInfo, PeerManageRpc, + PeerManageRpcClientFactory, PortForwardManageRpc, + PortForwardManageRpcClientFactory, RevokeCredentialRequest, Route as ApiRoute, + ShowNodeInfoRequest, StatsRpc, StatsRpcClientFactory, TcpProxyEntryState, + TcpProxyEntryTransportType, TcpProxyRpc, TcpProxyRpcClientFactory, + TrustedKeySourcePb, VpnPortalInfo, VpnPortalRpc, VpnPortalRpcClientFactory, + instance_identifier::{InstanceSelector, Selector}, + list_global_foreign_network_response, list_peer_route_pair, + }, + logger::{ + GetLoggerConfigRequest, LogLevel, LoggerRpc, LoggerRpcClientFactory, + SetLoggerConfigRequest, + }, + manage::{ + ListNetworkInstanceMetaRequest, ListNetworkInstanceRequest, + VpnPortalClientConfig as ManageVpnPortalClientConfig, WebClientService, + WebClientServiceClientFactory, + }, + }, + common::{NatType, PortForwardConfigPb, SocketType}, + peer_rpc::{GetGlobalPeerMapRequest, PeerCenterRpc, PeerCenterRpcClientFactory}, + rpc::standalone::{RuntimeRpcClient, runtime_rpc_client}, + rpc_types::{controller::BaseController, error::Error as RpcError}, + }, + tunnel::TunnelScheme, + utils::{PeerRoutePair, string::cost_to_str}, +}; + +rust_i18n::i18n!("locales", fallback = "en"); + +#[derive(Parser, Debug)] +#[command(name = "easytier-cli", author, version = EASYTIER_VERSION, about, long_about = None)] +struct Cli { + #[arg( + short = 'p', + long, + default_value = "127.0.0.1:15888", + help = "easytier-core rpc portal address" + )] + rpc_portal: SocketAddr, + + #[arg(short, long, default_value = "false", help = "verbose output")] + verbose: bool, + + #[arg( + short = 'o', + long = "output", + value_enum, + default_value = "table", + help = "output format" + )] + output_format: OutputFormat, + + #[arg( + long = "no-trunc", + default_value = "false", + help = "disable column truncation" + )] + no_trunc: bool, + + #[command(flatten)] + instance_select: InstanceSelectArgs, + + #[command(subcommand)] + sub_command: SubCommand, +} + +#[derive(Subcommand, Debug)] +enum SubCommand { + #[command(about = "show peers info")] + Peer(PeerArgs), + #[command(about = "manage connectors")] + Connector(ConnectorArgs), + #[command(about = "manage mapped listeners")] + MappedListener(MappedListenerArgs), + #[command(about = "do stun test")] + Stun, + #[command(about = "show route info")] + Route(RouteArgs), + #[command(about = "show global peers info")] + PeerCenter, + #[command(about = "manage vpn portal (wireguard) clients")] + VpnPortal(VpnPortalArgs), + #[command(about = "inspect self easytier-core status")] + Node(NodeArgs), + #[command(about = "manage easytier-core as a system service")] + Service(ServiceArgs), + #[command(about = "show tcp/kcp proxy status")] + Proxy, + #[command(about = "show ACL rules statistics")] + Acl(AclArgs), + #[command(about = "manage port forwarding")] + PortForward(PortForwardArgs), + #[command(about = "manage TCP/UDP whitelist")] + Whitelist(WhitelistArgs), + #[command(about = "show statistics information")] + Stats(StatsArgs), + #[command(about = "manage logger configuration")] + Logger(LoggerArgs), + #[command(about = "manage temporary credentials")] + Credential(CredentialArgs), + #[command(about = t!("core_clap.generate_completions").to_string())] + GenAutocomplete { shell: ShellType }, +} + +#[derive(clap::ValueEnum, Debug, Clone, PartialEq)] +enum OutputFormat { + Table, + Json, +} + +#[derive(Parser, Debug)] +struct InstanceSelectArgs { + #[arg(short = 'i', long = "instance-id", help = "the instance id")] + id: Option, + + #[arg(short = 'n', long = "instance-name", help = "the instance name")] + name: Option, +} + +impl From<&InstanceSelectArgs> for InstanceIdentifier { + fn from(args: &InstanceSelectArgs) -> Self { + InstanceIdentifier { + selector: match args.id { + Some(id) => Some(Selector::Id(id.into())), + None => Some(Selector::InstanceSelector(InstanceSelector { + name: args.name.clone(), + })), + }, + } + } +} + +#[derive(Args, Debug)] +struct PeerArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Subcommand, Debug)] +enum PeerSubCommand { + /// List connected peers + List, + /// Show public IPv6 address information + Ipv6, + /// List foreign networks discovered by this instance + ListForeign { + #[arg( + long, + default_value = "false", + help = "include trusted keys for each foreign network" + )] + trusted_keys: bool, + }, + /// List global foreign networks from the peer center + ListGlobalForeign, +} + +#[derive(Args, Debug)] +struct RouteArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Subcommand, Debug)] +enum RouteSubCommand { + /// List routes propagated by peers + List, + /// Dump routes in CIDR format + Dump, +} + +#[derive(Args, Debug)] +struct ConnectorArgs { + #[arg(short, long, help = "filter connectors by virtual IPv4 address")] + ipv4: Option, + + #[arg(short, long, help = "filter connectors by peer URL")] + peers: Vec, + + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Subcommand, Debug)] +enum ConnectorSubCommand { + /// Add a connector + Add { + #[arg(help = "connector url, e.g., tcp://1.2.3.4:11010")] + url: String, + }, + /// Remove a connector + Remove { + #[arg(help = "connector url, e.g., tcp://1.2.3.4:11010")] + url: String, + }, + /// List connectors + List, +} + +#[derive(Args, Debug)] +struct MappedListenerArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Subcommand, Debug)] +enum MappedListenerSubCommand { + /// Add Mapped Listerner + Add { url: String }, + /// Remove Mapped Listener + Remove { url: String }, + /// List Existing Mapped Listener + List, +} + +#[derive(Args, Debug)] +struct VpnPortalArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Subcommand, Debug)] +enum VpnPortalSubCommand { + /// Add a WireGuard portal client + AddClient { + #[arg(help = "client name")] + name: String, + #[arg(long, help = "client virtual IPv4 CIDR inside the mesh network")] + virtual_ip: String, + #[arg(long, help = "ACL groups assigned to the client")] + groups: Vec, + }, + /// Remove a WireGuard portal client + RemoveClient { + #[arg(help = "client name")] + name: String, + }, + /// Remove all WireGuard portal clients + ClearClients, +} + +#[derive(Subcommand, Debug)] +enum NodeSubCommand { + #[command(about = "show node info")] + Info, + #[command(about = "show node config")] + Config, +} + +#[derive(Args, Debug)] +struct NodeArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Args, Debug)] +struct AclArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Args, Debug)] +struct AclSetArgs { + /// Full ACL as a TOML string, or a path to a TOML file prefixed by '@'. + /// + /// The TOML uses the same shape as the `[acl]` section of an easytier + /// configuration file, for example: + /// + /// ```toml + /// [acl.acl_v1] + /// [[acl.acl_v1.chains]] + /// name = "Inbound" + /// chain_type = 1 + /// enabled = true + /// default_action = 2 + /// [[acl.acl_v1.chains.rules]] + /// protocol = 3 + /// action = 1 + /// ``` + /// + /// Using `@/path/to/acl.toml` makes it easy to manage and debug the full + /// ACL offline. The whole ACL is replaced at runtime without restarting + /// easytier-core. + #[arg(help = "full ACL TOML string or '@path/to/acl.toml'")] + acl: String, +} + +#[derive(Subcommand, Debug)] +enum AclSubCommand { + /// Show ACL rule hit statistics + Stats, + /// Replace the whole ACL at runtime without restarting easytier-core + Set(AclSetArgs), +} + +#[derive(Args, Debug)] +struct PortForwardArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Subcommand, Debug)] +enum PortForwardSubCommand { + /// Add port forward rule + Add { + #[arg(help = "Protocol (tcp/udp)")] + protocol: String, + #[arg(help = "Local bind address (e.g., 0.0.0.0:8080)")] + bind_addr: String, + #[arg(help = "Destination address (e.g., 10.1.1.1:80)")] + dst_addr: String, + }, + /// Remove port forward rule + Remove { + #[arg(help = "Protocol (tcp/udp)")] + protocol: String, + #[arg(help = "Local bind address (e.g., 0.0.0.0:8080)")] + bind_addr: String, + #[arg(help = "Optional Destination address (e.g., 10.1.1.1:80)")] + dst_addr: Option, + }, + /// List port forward rules + List, +} + +#[derive(Args, Debug)] +struct WhitelistArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Subcommand, Debug)] +enum WhitelistSubCommand { + /// Set TCP port whitelist + SetTcp { + #[arg(help = "TCP ports (e.g., 80,443,8000-9000)")] + ports: String, + }, + /// Set UDP port whitelist + SetUdp { + #[arg(help = "UDP ports (e.g., 53,5000-6000)")] + ports: String, + }, + /// Clear TCP whitelist + ClearTcp, + /// Clear UDP whitelist + ClearUdp, + /// Show current whitelist configuration + Show, +} + +#[derive(Args, Debug)] +struct StatsArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Subcommand, Debug)] +enum StatsSubCommand { + /// Show general statistics + Show, + /// Show statistics in Prometheus format + Prometheus, +} + +#[derive(Args, Debug)] +struct LoggerArgs { + #[command(subcommand)] + sub_command: Option, +} + +#[derive(Subcommand, Debug)] +enum LoggerSubCommand { + /// Get current logger configuration + Get, + /// Set logger level + Set { + #[arg(help = "Log level (disabled, error, warning, info, debug, trace)")] + level: String, + }, +} + +#[derive(Args, Debug)] +struct CredentialArgs { + #[command(subcommand)] + sub_command: CredentialSubCommand, +} + +#[derive(Subcommand, Debug)] +enum CredentialSubCommand { + /// Generate a new temporary credential + Generate { + #[arg(long, help = "TTL in seconds (required)")] + ttl: i64, + #[arg( + long, + help = "custom credential ID, return existing credential if already generated" + )] + credential_id: Option, + #[arg(long, value_delimiter = ',', help = "ACL groups (comma-separated)")] + groups: Option>, + #[arg( + long, + default_value = "false", + help = "allow relay through this credential node" + )] + allow_relay: bool, + #[arg( + long, + value_delimiter = ',', + help = "allowed proxy CIDRs (comma-separated)" + )] + allowed_proxy_cidrs: Option>, + #[arg( + long, + action = ArgAction::Set, + default_value = "true", + value_parser = BoolishValueParser::new(), + help = "whether this credential may be reused by multiple peers concurrently" + )] + reusable: bool, + }, + /// Revoke a credential by its ID + Revoke { + #[arg(help = "credential ID (UUID)")] + credential_id: String, + }, + /// List all active credentials + List, +} + +#[derive(Args, Debug)] +struct ServiceArgs { + #[arg(short, long, default_value = env!("CARGO_PKG_NAME"), help = "service name")] + name: String, + + #[command(subcommand)] + sub_command: ServiceSubCommand, +} + +#[derive(Subcommand, Debug)] +enum ServiceSubCommand { + #[command(about = "register easytier-core as a system service")] + Install(InstallArgs), + #[command(about = "unregister easytier-core system service")] + Uninstall, + #[command(about = "check easytier-core system service status")] + Status, + #[command(about = "start easytier-core system service")] + Start, + #[command(about = "stop easytier-core system service")] + Stop, +} + +#[derive(Args, Debug)] +struct InstallArgs { + #[arg(long, default_value = env!("CARGO_PKG_DESCRIPTION"), help = "service description")] + description: String, + + #[arg(long, help = "display name shown by the service manager")] + display_name: Option, + + #[arg( + long, + help = "whether to disable starting the service automatically on boot (true/false)" + )] + disable_autostart: Option, + + #[arg( + long, + help = "whether to disable automatic restart when the service fails (true/false)" + )] + disable_restart_on_failure: Option, + + #[arg(long, help = "path to easytier-core binary")] + core_path: Option, + + #[arg(long, help = "working directory for the easytier-core service")] + service_work_dir: Option, + + #[arg( + long, + num_args = 1.., + allow_hyphen_values = true, + help = "args to pass to easytier-core, must be the last option of install" + )] + core_args: Option>, +} + +type Error = anyhow::Error; + +#[derive(Clone, Debug)] +struct InstanceTarget { + identifier: InstanceIdentifier, + instance_id: String, + instance_name: String, +} + +struct InstanceResult { + target: Option, + value: T, +} + +impl InstanceTarget { + fn label(&self) -> String { + match (self.instance_name.is_empty(), self.instance_id.is_empty()) { + (false, false) => format!("{} ({})", self.instance_name, self.instance_id), + (false, true) => self.instance_name.clone(), + (true, false) => self.instance_id.clone(), + (true, true) => "selected instance".to_string(), + } + } +} + +impl InstanceResult { + fn new(target: Option, value: T) -> Self { + Self { target, value } + } + + fn map(self, f: impl FnOnce(T) -> U) -> InstanceResult { + InstanceResult { + target: self.target, + value: f(self.value), + } + } +} + +struct CommandHandler<'a> { + client: Arc>, + verbose: bool, + output_format: &'a OutputFormat, + no_trunc: bool, + instance_select: &'a InstanceSelectArgs, + instance_selector: InstanceIdentifier, + resolved_target: Option, +} + +type RpcClient = RuntimeRpcClient; +type LocalBoxFuture<'a, T> = Pin> + 'a>>; +type ForeignNetworkMap = BTreeMap; +type GlobalForeignNetworkMap = BTreeMap; + +const ROUTE_OPTIONAL_COLUMNS: &[&str] = &["hostname"]; +const ROUTE_DROP_COLUMNS: &[&str] = &[ + "version", + "next_hop_hostname_lat_first", + "next_hop_ipv4_lat_first", + "path_len_lat_first", + "path_latency_lat_first", + "next_hop_hostname", + "next_hop_lat", +]; + +fn is_missing_web_client_service(error: &RpcError) -> bool { + matches!( + error, + RpcError::InvalidServiceKey(service_name, _) + if service_name.trim_matches('"') == "WebClientService" + ) +} + +fn parse_vpn_portal_client_cidr(value: &str) -> anyhow::Result { + let value = value.trim(); + if !value.contains('/') { + anyhow::bail!("client virtual IPv4 must include its network prefix"); + } + value + .parse::() + .map_err(|error| anyhow::anyhow!("invalid client virtual IPv4 CIDR ({value}): {error}")) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn missing_web_client_service_matches_raw_service_name() { + let error = RpcError::InvalidServiceKey("WebClientService".to_string(), "".to_string()); + + assert!(is_missing_web_client_service(&error)); + } + + #[test] + fn missing_web_client_service_matches_serialized_service_name() { + let error = RpcError::InvalidServiceKey("\"WebClientService\"".to_string(), "".to_string()); + + assert!(is_missing_web_client_service(&error)); + } + + #[test] + fn missing_web_client_service_rejects_other_services() { + let error = RpcError::InvalidServiceKey("PeerManageRpc".to_string(), "".to_string()); + + assert!(!is_missing_web_client_service(&error)); + } + + #[test] + fn vpn_portal_client_requires_a_complete_ipv4_cidr() { + let client = parse_vpn_portal_client_cidr("10.90.0.2/16").unwrap(); + assert_eq!(client.to_string(), "10.90.0.2/16"); + assert!(parse_vpn_portal_client_cidr("10.90.0.2").is_err()); + } + + #[test] + fn proxy_cidrs_are_displayed_one_per_line() { + assert_eq!( + format_proxy_cidrs("10.0.0.0/24, 192.168.0.0/16"), + "10.0.0.0/24\n192.168.0.0/16" + ); + assert_eq!(format_proxy_cidrs("10.0.0.0/24"), "10.0.0.0/24"); + assert_eq!(format_proxy_cidrs(""), ""); + } + + #[test] + fn route_column_priority_preserves_proxy_cidrs() { + let headers = [ + "ipv4", + "hostname", + "proxy_cidrs", + "next_hop_ipv4", + "next_hop_hostname", + "next_hop_lat", + "path_len", + "path_latency", + "next_hop_ipv4_lat_first", + "next_hop_hostname_lat_first", + "path_len_lat_first", + "path_latency_lat_first", + "version", + ] + .map(str::to_string); + let col_widths = headers + .iter() + .map(|header| text_width(header)) + .collect::>(); + let drop_indices = header_indices(&headers, ROUTE_DROP_COLUMNS); + + let (active, dropped, total_width) = + select_columns_to_drop(Some(79), &drop_indices, &col_widths); + + let proxy_index = headers + .iter() + .position(|header| header == "proxy_cidrs") + .unwrap(); + assert!(active[proxy_index]); + assert!(!dropped.contains(&proxy_index)); + assert!(total_width <= 79); + } + + fn parse_install_core_args(argv: &[&str]) -> Vec { + let cli = Cli::try_parse_from(argv).expect("failed to parse cli"); + let SubCommand::Service(service_args) = cli.sub_command else { + panic!("not a service subcommand"); + }; + let ServiceSubCommand::Install(install_args) = service_args.sub_command else { + panic!("not an install subcommand"); + }; + install_args.core_args.expect("no core args") + } + + #[test] + fn install_core_args_do_not_include_the_flag_itself() { + // trailing_var_arg used to collect the "--core-args" token itself into + // the value, breaking the installed service's command line. + let args = parse_install_core_args(&[ + "easytier-cli", + "service", + "install", + "--core-args", + "--daemon", + "--config-dir", + "/nonexistent", + ]); + assert_eq!(args, vec!["--daemon", "--config-dir", "/nonexistent"]); + } + + #[test] + fn install_core_args_support_equals_form() { + let args = parse_install_core_args(&[ + "easytier-cli", + "service", + "install", + "--core-args=--daemon", + ]); + assert_eq!(args, vec!["--daemon"]); + } + + #[test] + fn install_options_before_core_args_still_parse() { + let cli = Cli::try_parse_from([ + "easytier-cli", + "service", + "install", + "--disable-autostart", + "true", + "--core-args", + "--daemon", + ]) + .expect("failed to parse cli"); + let SubCommand::Service(service_args) = cli.sub_command else { + panic!("not a service subcommand"); + }; + let ServiceSubCommand::Install(install_args) = service_args.sub_command else { + panic!("not an install subcommand"); + }; + assert_eq!(install_args.disable_autostart, Some(true)); + assert_eq!( + install_args.core_args.expect("no core args"), + vec!["--daemon"] + ); + } +} + +fn format_proxy_cidrs(value: &str) -> String { + value + .split(',') + .map(str::trim) + .collect::>() + .join("\n") +} + +#[derive(serde::Serialize)] +struct PeerListData { + node_info: NodeInfo, + peer_routes: Vec, +} + +#[derive(serde::Serialize)] +struct RouteListData { + node_info: NodeInfo, + peer_routes: Vec, +} + +struct PeerIpv6DataRaw { + node_info: NodeInfo, + routes: Vec, + provider_info: ListPublicIpv6InfoResponse, +} + +#[derive(serde::Serialize)] +struct PeerCenterRowData { + node_id: String, + hostname: String, + ipv4: String, + direct_peers: Vec, +} + +#[derive(serde::Serialize)] +struct PeerCenterDirectPeerData { + node_id: String, + hostname: String, + ipv4: String, + latency_ms: i32, +} + +impl<'a> CommandHandler<'a> { + fn has_explicit_instance_selector(&self) -> bool { + self.instance_select.id.is_some() || self.instance_select.name.is_some() + } + + fn scoped_to_instance(&self, target: &InstanceTarget) -> Self { + Self { + client: self.client.clone(), + verbose: self.verbose, + output_format: self.output_format, + no_trunc: self.no_trunc, + instance_select: self.instance_select, + instance_selector: target.identifier.clone(), + resolved_target: Some(target.clone()), + } + } + + fn print_target_header(&self, target: &InstanceTarget) { + println!("== {} ==", target.label()); + } + + async fn get_manage_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get manage client")?) + } + + async fn fanout_targets(&self) -> Result>, Error> { + if self.resolved_target.is_some() || self.has_explicit_instance_selector() { + return Ok(None); + } + + let client = self.get_manage_client().await?; + let list_response = match client + .list_network_instance(BaseController::default(), ListNetworkInstanceRequest {}) + .await + { + Ok(response) => response, + Err(error) if is_missing_web_client_service(&error) => return Ok(None), + Err(error) => return Err(error.into()), + }; + let inst_ids = list_response + .inst_ids + .into_iter() + .map(uuid::Uuid::from) + .collect::>(); + + if inst_ids.is_empty() { + return Err(anyhow::anyhow!("no running instances found")); + } + + let metas = client + .list_network_instance_meta( + BaseController::default(), + ListNetworkInstanceMetaRequest { + inst_ids: inst_ids.iter().cloned().map(Into::into).collect(), + }, + ) + .await? + .metas; + + let mut name_map = HashMap::new(); + for meta in metas { + if let Some(inst_id) = meta.inst_id { + name_map.insert( + uuid::Uuid::from(inst_id), + if meta.instance_name.is_empty() { + meta.network_name + } else { + meta.instance_name + }, + ); + } + } + + let mut targets = inst_ids + .into_iter() + .map(|inst_id| InstanceTarget { + identifier: InstanceIdentifier { + selector: Some(Selector::Id(inst_id.into())), + }, + instance_id: inst_id.to_string(), + instance_name: name_map.remove(&inst_id).unwrap_or_default(), + }) + .collect::>(); + + targets.sort_by_key(|a| a.label()); + Ok(Some(targets)) + } + + async fn collect_instance_results( + &self, + fetch: F, + ) -> Result>, Error> + where + F: for<'b> Fn(&'b CommandHandler<'a>) -> LocalBoxFuture<'b, T>, + { + if let Some(targets) = self.fanout_targets().await? { + let mut results = Vec::with_capacity(targets.len()); + for target in targets { + let scoped = self.scoped_to_instance(&target); + let value = fetch(&scoped) + .await + .with_context(|| format!("instance {}", target.label()))?; + results.push(InstanceResult::new(Some(target), value)); + } + Ok(results) + } else { + Ok(vec![InstanceResult::new(None, fetch(self).await?)]) + } + } + + async fn apply_to_instances(&self, apply: F) -> Result<(), Error> + where + F: for<'b> Fn(&'b CommandHandler<'a>) -> LocalBoxFuture<'b, ()>, + { + self.collect_instance_results(apply).await?; + Ok(()) + } + + fn print_results( + &self, + results: &[InstanceResult], + mut render: impl FnMut(&T) -> Result<(), Error>, + ) -> Result<(), Error> { + let multi = results.len() > 1; + for (idx, result) in results.iter().enumerate() { + if multi { + if idx > 0 { + println!(); + } + if let Some(target) = result.target.as_ref() { + self.print_target_header(target); + } + } + render(&result.value)?; + } + Ok(()) + } + + fn print_json_results( + &self, + results: Vec>, + ) -> Result<(), Error> { + if results.len() == 1 { + println!("{}", serde_json::to_string_pretty(&results[0].value)?); + return Ok(()); + } + + let wrapped = results + .into_iter() + .map(|result| { + let target = result + .target + .ok_or_else(|| anyhow::anyhow!("missing instance target for multi-result"))?; + Ok(serde_json::json!({ + "instance_id": target.instance_id, + "instance_name": target.instance_name, + "result": result.value, + })) + }) + .collect::, Error>>()?; + println!("{}", serde_json::to_string_pretty(&wrapped)?); + Ok(()) + } + + async fn get_peer_manager_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get peer manager client")?) + } + + async fn get_connector_manager_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get connector manager client")?) + } + + async fn get_mapped_listener_manager_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get mapped listener manager client")?) + } + + async fn get_peer_center_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get peer center client")?) + } + + async fn get_vpn_portal_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get vpn portal client")?) + } + + async fn get_acl_manager_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get acl manager client")?) + } + + async fn get_tcp_proxy_client( + &self, + transport_type: &str, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>(transport_type.to_string()) + .await + .with_context(|| "failed to get vpn portal client")?) + } + + async fn get_port_forward_manager_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get port forward manager client")?) + } + + async fn get_stats_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get stats client")?) + } + + async fn get_logger_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get logger client")?) + } + + async fn get_config_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get config client")?) + } + + async fn get_credential_client( + &self, + ) -> Result>, Error> { + Ok(self + .client + .lock() + .await + .scoped_client::>("".to_string()) + .await + .with_context(|| "failed to get credential client")?) + } + + async fn list_peers(&self) -> Result { + let client = self.get_peer_manager_client().await?; + let request = ListPeerRequest { + instance: Some(self.instance_selector.clone()), + }; + let response = client.list_peer(BaseController::default(), request).await?; + Ok(response) + } + + async fn list_routes(&self) -> Result { + let client = self.get_peer_manager_client().await?; + let request = ListRouteRequest { + instance: Some(self.instance_selector.clone()), + }; + let response = client + .list_route(BaseController::default(), request) + .await?; + Ok(response) + } + + async fn list_peer_route_pair(&self) -> Result, Error> { + let peers = self.list_peers().await?.peer_infos; + let routes = self.list_routes().await?.routes; + Ok(list_peer_route_pair(peers, routes)) + } + + async fn fetch_node_info(&self) -> Result { + self.get_peer_manager_client() + .await? + .show_node_info( + BaseController::default(), + ShowNodeInfoRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await? + .node_info + .ok_or(anyhow::anyhow!("node info not found")) + } + + async fn fetch_peer_list_data(&self) -> Result { + Ok(PeerListData { + node_info: self.fetch_node_info().await?, + peer_routes: self.list_peer_route_pair().await?, + }) + } + + async fn fetch_route_dump(&self) -> Result { + Ok(self + .get_peer_manager_client() + .await? + .dump_route( + BaseController::default(), + DumpRouteRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await? + .result) + } + + async fn fetch_foreign_networks( + &self, + include_trusted_keys: bool, + ) -> Result { + Ok(self + .get_peer_manager_client() + .await? + .list_foreign_network( + BaseController::default(), + ListForeignNetworkRequest { + instance: Some(self.instance_selector.clone()), + include_trusted_keys, + }, + ) + .await? + .foreign_networks) + } + + async fn fetch_global_foreign_networks(&self) -> Result { + Ok(self + .get_peer_manager_client() + .await? + .list_global_foreign_network( + BaseController::default(), + ListGlobalForeignNetworkRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await? + .foreign_networks) + } + + async fn fetch_route_list_data(&self) -> Result { + Ok(RouteListData { + node_info: self.fetch_node_info().await?, + peer_routes: self.list_peer_route_pair().await?, + }) + } + + async fn fetch_local_public_ipv6_info(&self) -> Result { + Ok(self + .get_peer_manager_client() + .await? + .list_public_ipv6_info( + BaseController::default(), + ListPublicIpv6InfoRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await?) + } + + async fn fetch_peer_ipv6_data(&self) -> Result { + Ok(PeerIpv6DataRaw { + node_info: self.fetch_node_info().await?, + routes: self.list_routes().await?.routes, + provider_info: self.fetch_local_public_ipv6_info().await?, + }) + } + + async fn fetch_connector_list(&self) -> Result, Error> { + Ok(self + .get_connector_manager_client() + .await? + .list_connector( + BaseController::default(), + ListConnectorRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await? + .connectors) + } + + async fn fetch_acl_stats(&self) -> Result, Error> { + Ok(self + .get_acl_manager_client() + .await? + .get_acl_stats( + BaseController::default(), + GetAclStatsRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await? + .acl_stats) + } + + async fn fetch_mapped_listener_list(&self) -> Result, Error> { + Ok(self + .get_mapped_listener_manager_client() + .await? + .list_mapped_listener( + BaseController::default(), + ListMappedListenerRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await? + .mappedlisteners) + } + + async fn fetch_port_forward_list(&self) -> Result { + Ok(self + .get_port_forward_manager_client() + .await? + .list_port_forward( + BaseController::default(), + ListPortForwardRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await?) + } + + async fn fetch_whitelist(&self) -> Result { + Ok(self + .get_acl_manager_client() + .await? + .get_whitelist( + BaseController::default(), + GetWhitelistRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await?) + } + + async fn fetch_credential_list(&self) -> Result { + Ok(self + .get_credential_client() + .await? + .list_credentials( + BaseController::default(), + ListCredentialsRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await?) + } + + async fn fetch_peer_center_rows(&self) -> Result, Error> { + struct PeerCenterNodeInfo { + hostname: String, + ipv4: String, + } + + let resp = self + .get_peer_center_client() + .await? + .get_global_peer_map( + BaseController::default(), + GetGlobalPeerMapRequest::default(), + ) + .await?; + let route_infos = self.list_peer_route_pair().await?; + let node_id_to_node_info = DashMap::new(); + let node_info = self.fetch_node_info().await?; + node_id_to_node_info.insert( + node_info.peer_id, + PeerCenterNodeInfo { + hostname: node_info.hostname.clone(), + ipv4: node_info.ipv4_addr, + }, + ); + for route_info in route_infos { + let Some(peer_id) = route_info.route.as_ref().map(|x| x.peer_id) else { + continue; + }; + node_id_to_node_info.insert( + peer_id, + PeerCenterNodeInfo { + hostname: route_info + .route + .as_ref() + .map(|x| x.hostname.clone()) + .unwrap_or_default(), + ipv4: route_info + .route + .as_ref() + .and_then(|x| x.ipv4_addr) + .map(|x| x.to_string()) + .unwrap_or_default(), + }, + ); + } + + Ok(resp + .global_peer_map + .iter() + .map(|(node_id, directs)| PeerCenterRowData { + node_id: node_id.to_string(), + hostname: node_id_to_node_info + .get(node_id) + .map(|x| x.hostname.clone()) + .unwrap_or_default(), + ipv4: node_id_to_node_info + .get(node_id) + .map(|x| x.ipv4.clone()) + .unwrap_or_default(), + direct_peers: directs + .direct_peers + .iter() + .map(|(k, v)| PeerCenterDirectPeerData { + node_id: k.to_string(), + hostname: node_id_to_node_info + .get(k) + .map(|x| x.hostname.clone()) + .unwrap_or_default(), + ipv4: node_id_to_node_info + .get(k) + .map(|x| x.ipv4.clone()) + .unwrap_or_default(), + latency_ms: v.latency_ms, + }) + .collect(), + }) + .collect()) + } + + async fn fetch_vpn_portal_info(&self) -> Result { + Ok(self + .get_vpn_portal_client() + .await? + .get_vpn_portal_info( + BaseController::default(), + GetVpnPortalInfoRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await? + .vpn_portal_info + .unwrap_or_default()) + } + + async fn fetch_stats(&self) -> Result, Error> { + Ok(self + .get_stats_client() + .await? + .get_stats( + BaseController::default(), + GetStatsRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await? + .metrics) + } + + async fn fetch_prometheus_stats(&self) -> Result { + Ok(self + .get_stats_client() + .await? + .get_prometheus_stats( + BaseController::default(), + GetPrometheusStatsRequest { + instance: Some(self.instance_selector.clone()), + }, + ) + .await? + .prometheus_text) + } + + fn connector_validate_url(url: &str) -> Result { + let url = url::Url::parse(url).map_err(|e| anyhow::anyhow!("invalid url ({url}): {e}"))?; + TunnelScheme::try_from(&url).map_err(|_| { + anyhow::anyhow!("unsupported scheme \"{}\" in url ({url})", url.scheme()) + })?; + Ok(url) + } + + async fn apply_connector_modify( + &self, + url: &str, + action: ConfigPatchAction, + ) -> Result<(), Error> { + let url = match action { + ConfigPatchAction::Add => Self::connector_validate_url(url)?, + ConfigPatchAction::Remove => { + url::Url::parse(url).map_err(|e| anyhow::anyhow!("invalid url ({url}): {e}"))? + } + ConfigPatchAction::Clear => { + return Err(anyhow::anyhow!( + "unsupported connector patch action: {:?}", + action + )); + } + }; + let client = self.get_config_client().await?; + let request = PatchConfigRequest { + instance: Some(self.instance_selector.clone()), + patch: Some(InstanceConfigPatch { + connectors: vec![UrlPatch { + action: action.into(), + url: Some(url.into()), + }], + ..Default::default() + }), + }; + let _response = client + .patch_config(BaseController::default(), request) + .await?; + Ok(()) + } + + async fn handle_connector_modify( + &self, + url: &str, + action: ConfigPatchAction, + ) -> Result<(), Error> { + let url = url.to_string(); + self.apply_to_instances(|handler| { + let url = url.clone(); + Box::pin(async move { handler.apply_connector_modify(&url, action).await }) + }) + .await + } + + async fn handle_peer_list(&self) -> Result<(), Error> { + #[derive(tabled::Tabled, serde::Serialize)] + struct PeerTableItem { + #[tabled(rename = "ipv4")] + cidr: String, + #[tabled(skip)] + ipv4: String, + hostname: String, + cost: String, + #[tabled(rename = "lat(ms)")] + lat_ms: String, + #[tabled(rename = "loss")] + loss_rate: String, + #[tabled(rename = "rx")] + rx_bytes: String, + #[tabled(rename = "tx")] + tx_bytes: String, + #[tabled(rename = "tunnel")] + tunnel_proto: String, + #[tabled(rename = "NAT")] + nat_type: String, + #[tabled(skip)] + id: String, + version: String, + } + + impl From for PeerTableItem { + fn from(p: PeerRoutePair) -> Self { + let route = p.route.clone().unwrap_or_default(); + let lat_ms = if route.cost == 1 { + p.get_latency_ms().unwrap_or(0.0) + } else { + route.path_latency_latency_first() as f64 + }; + PeerTableItem { + cidr: route.ipv4_addr.map(|ip| ip.to_string()).unwrap_or_default(), + ipv4: route + .ipv4_addr + .map(|ip: easytier::proto::common::Ipv4Inet| ip.address.unwrap_or_default()) + .map(|ip| ip.to_string()) + .unwrap_or_default(), + hostname: route.hostname.clone(), + cost: cost_to_str(route.cost), + lat_ms: format!("{:.2}", lat_ms), + loss_rate: format!("{:.1}%", p.get_loss_rate().unwrap_or(0.0) * 100.0), + rx_bytes: format_size(p.get_rx_bytes().unwrap_or(0), humansize::DECIMAL), + tx_bytes: format_size(p.get_tx_bytes().unwrap_or(0), humansize::DECIMAL), + tunnel_proto: p.get_conn_protos().unwrap_or_default().join(","), + nat_type: p.get_udp_nat_type(), + id: route.peer_id.to_string(), + version: if route.version.is_empty() { + "unknown".to_string() + } else { + route.version + }, + } + } + } + + impl From for PeerTableItem { + fn from(p: NodeInfo) -> Self { + PeerTableItem { + cidr: p.ipv4_addr.clone(), + ipv4: Ipv4Inet::from_str(&p.ipv4_addr) + .map(|ip| ip.address().to_string()) + .unwrap_or_default(), + hostname: p.hostname.clone(), + cost: "Local".to_string(), + lat_ms: "-".to_string(), + loss_rate: "-".to_string(), + rx_bytes: "-".to_string(), + tx_bytes: "-".to_string(), + tunnel_proto: "-".to_string(), + nat_type: if let Some(info) = p.stun_info { + info.udp_nat_type().as_str_name().to_string() + } else { + "Unknown".to_string() + }, + id: p.peer_id.to_string(), + version: p.version, + } + } + } + + let build_items = |data: &PeerListData| { + let mut items = Vec::with_capacity(data.peer_routes.len() + 1); + items.push(PeerTableItem::from(data.node_info.clone())); + items.extend(data.peer_routes.iter().cloned().map(Into::into)); + items.sort_by(|a, b| { + use std::net::{IpAddr, Ipv4Addr}; + + let a_is_local = a.cost == "Local"; + let b_is_local = b.cost == "Local"; + if a_is_local != b_is_local { + return if a_is_local { + std::cmp::Ordering::Less + } else { + std::cmp::Ordering::Greater + }; + } + + let a_is_public = a.hostname.starts_with( + easytier_core::peers::foreign_network::PUBLIC_SERVER_HOSTNAME_PREFIX, + ); + let b_is_public = b.hostname.starts_with( + easytier_core::peers::foreign_network::PUBLIC_SERVER_HOSTNAME_PREFIX, + ); + if a_is_public != b_is_public { + return if a_is_public { + std::cmp::Ordering::Less + } else { + std::cmp::Ordering::Greater + }; + } + + let a_ip = IpAddr::from_str(&a.ipv4).unwrap_or(IpAddr::V4(Ipv4Addr::UNSPECIFIED)); + let b_ip = IpAddr::from_str(&b.ipv4).unwrap_or(IpAddr::V4(Ipv4Addr::UNSPECIFIED)); + match a_ip.cmp(&b_ip) { + std::cmp::Ordering::Equal => a.hostname.cmp(&b.hostname), + other => other, + } + }); + items + }; + + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_peer_list_data())) + .await?; + + if self.verbose { + return self.print_json_results( + results + .into_iter() + .map(|result| result.map(|data| data.peer_routes)) + .collect(), + ); + } + if *self.output_format == OutputFormat::Json { + return self.print_json_results( + results + .into_iter() + .map(|result| result.map(|data| build_items(&data))) + .collect(), + ); + } + + self.print_results(&results, |data| { + let items = build_items(data); + print_output( + &items, + self.output_format, + &["tunnel", "version"], + &["version", "tunnel", "nat", "tx", "rx", "loss", "lat(ms)"], + self.no_trunc, + ) + }) + } + + async fn handle_peer_ipv6(&self) -> Result<(), Error> { + #[derive(tabled::Tabled, serde::Serialize)] + struct PeerIpv6NodeRow { + peer_id: u32, + hostname: String, + inst_id: String, + ipv4: String, + public_ipv6_addr: String, + provider_prefix: String, + } + + #[derive(tabled::Tabled, serde::Serialize)] + struct ProviderLeaseRow { + peer_id: u32, + inst_id: String, + leased_addr: String, + valid_until: String, + reused: bool, + } + + #[derive(serde::Serialize)] + struct ProviderLeaseSection { + provider_prefix: String, + leases: Vec, + } + + #[derive(serde::Serialize)] + struct PeerIpv6View { + nodes: Vec, + local_provider: Option, + } + + fn fmt_ipv6_inet(value: Option) -> String { + value + .map(|value| value.to_string()) + .unwrap_or_else(|| "-".to_string()) + } + + fn fmt_valid_until(unix_seconds: i64) -> String { + chrono::DateTime::::from_timestamp(unix_seconds, 0) + .map(|ts| { + ts.with_timezone(&chrono::Local) + .format("%Y-%m-%d %H:%M:%S") + .to_string() + }) + .unwrap_or_else(|| unix_seconds.to_string()) + } + + let build_view = |data: &PeerIpv6DataRaw| { + let mut nodes = Vec::with_capacity(data.routes.len() + 1); + nodes.push(PeerIpv6NodeRow { + peer_id: data.node_info.peer_id, + hostname: data.node_info.hostname.clone(), + inst_id: data.node_info.inst_id.clone(), + ipv4: data.node_info.ipv4_addr.clone(), + public_ipv6_addr: fmt_ipv6_inet(data.node_info.public_ipv6_addr), + provider_prefix: fmt_ipv6_inet(data.node_info.ipv6_public_addr_prefix), + }); + nodes.extend(data.routes.iter().map(|route| { + PeerIpv6NodeRow { + peer_id: route.peer_id, + hostname: route.hostname.clone(), + inst_id: route.inst_id.clone(), + ipv4: route + .ipv4_addr + .map(|ipv4| ipv4.to_string()) + .unwrap_or_else(|| "-".to_string()), + public_ipv6_addr: fmt_ipv6_inet(route.public_ipv6_addr), + provider_prefix: fmt_ipv6_inet(route.ipv6_public_addr_prefix), + } + })); + nodes.sort_by_key(|row| { + ( + row.peer_id != data.node_info.peer_id, + row.peer_id, + row.inst_id.clone(), + ) + }); + + let local_provider = data.provider_info.provider_prefix.map(|provider_prefix| { + let mut leases = data + .provider_info + .provider_leases + .iter() + .map(|lease| ProviderLeaseRow { + peer_id: lease.peer_id, + inst_id: lease.inst_id.clone(), + leased_addr: fmt_ipv6_inet(lease.leased_addr), + valid_until: fmt_valid_until(lease.valid_until_unix_seconds), + reused: lease.reused, + }) + .collect::>(); + leases.sort_by_key(|lease| { + ( + lease.peer_id, + lease.inst_id.clone(), + lease.leased_addr.clone(), + ) + }); + ProviderLeaseSection { + provider_prefix: provider_prefix.to_string(), + leases, + } + }); + + PeerIpv6View { + nodes, + local_provider, + } + }; + + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_peer_ipv6_data())) + .await?; + + if self.verbose || *self.output_format == OutputFormat::Json { + return self.print_json_results( + results + .into_iter() + .map(|result| result.map(|data| build_view(&data))) + .collect(), + ); + } + + self.print_results(&results, |data| { + let view = build_view(data); + print_output(&view.nodes, self.output_format, &[], &[], self.no_trunc)?; + + if let Some(local_provider) = view.local_provider { + println!(); + println!("Local provider prefix: {}", local_provider.provider_prefix); + if local_provider.leases.is_empty() { + println!("No active provider leases"); + } else { + print_output( + &local_provider.leases, + self.output_format, + &[], + &[], + self.no_trunc, + )?; + } + } + + Ok(()) + }) + } + + async fn handle_route_dump(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_route_dump())) + .await?; + if self.verbose || *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + self.print_results(&results, |result| { + println!("response: {}", result); + Ok(()) + }) + } + + async fn handle_foreign_network_list(&self, include_trusted_keys: bool) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| { + Box::pin(handler.fetch_foreign_networks(include_trusted_keys)) + }) + .await?; + if self.verbose || *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + self.print_results(&results, |networks| { + for (idx, (k, v)) in networks.iter().enumerate() { + println!("{} Network Name: {}", idx + 1, k); + for peer in v.peers.iter() { + println!( + " peer_id: {}, peer_conn_count: {}, conns: [ {} ]", + peer.peer_id, + peer.conns.len(), + peer.conns + .iter() + .map(|conn| format!( + "remote_addr: {}, rx_bytes: {}, tx_bytes: {}, latency_us: {}", + conn.tunnel + .as_ref() + .and_then(|t| t.display_remote_addr()) + .unwrap_or_default(), + conn.stats.as_ref().map(|s| s.rx_bytes).unwrap_or_default(), + conn.stats.as_ref().map(|s| s.tx_bytes).unwrap_or_default(), + conn.stats + .as_ref() + .map(|s| s.latency_us) + .unwrap_or_default(), + )) + .collect::>() + .join("; ") + ); + } + if include_trusted_keys { + println!(" trusted_keys:"); + for trusted_key in &v.trusted_keys { + let source = TrustedKeySourcePb::try_from(trusted_key.source) + .map(|source| source.as_str_name()) + .unwrap_or("TRUSTED_KEY_SOURCE_PB_UNSPECIFIED"); + let expiry = trusted_key + .expiry_unix + .map(|value| value.to_string()) + .unwrap_or_else(|| "-".to_string()); + println!( + " source: {}, expiry_unix: {}, pubkey: {}", + source, + expiry, + BASE64_STANDARD.encode(&trusted_key.pubkey), + ); + } + } + } + Ok(()) + }) + } + + async fn handle_global_foreign_network_list(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_global_foreign_networks())) + .await?; + if self.verbose || *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + self.print_results(&results, |networks| { + for (k, v) in networks.iter() { + println!("Peer ID: {}", k); + for n in v.foreign_networks.iter() { + println!( + " Network Name: {}, Last Updated: {}, Version: {}, PeerIds: {:?}", + n.network_name, n.last_updated, n.version, n.peer_ids + ); + } + } + Ok(()) + }) + } + + async fn handle_route_list(&self) -> Result<(), Error> { + #[derive(tabled::Tabled, serde::Serialize)] + struct RouteTableItem { + ipv4: String, + hostname: String, + #[tabled(display("format_proxy_cidrs"))] + proxy_cidrs: String, + + next_hop_ipv4: String, + next_hop_hostname: String, + next_hop_lat: f64, + path_len: i32, + path_latency: i32, + + next_hop_ipv4_lat_first: String, + next_hop_hostname_lat_first: String, + path_len_lat_first: i32, + path_latency_lat_first: i32, + + version: String, + } + + let build_items = |data: &RouteListData| { + let mut items = vec![RouteTableItem { + ipv4: data.node_info.ipv4_addr.clone(), + hostname: data.node_info.hostname.clone(), + proxy_cidrs: data.node_info.proxy_cidrs.join(", "), + next_hop_ipv4: "-".to_string(), + next_hop_hostname: "Local".to_string(), + next_hop_lat: 0.0, + path_len: 0, + path_latency: 0, + next_hop_ipv4_lat_first: "-".to_string(), + next_hop_hostname_lat_first: "Local".to_string(), + path_len_lat_first: 0, + path_latency_lat_first: 0, + version: data.node_info.version.clone(), + }]; + + for p in data.peer_routes.iter() { + let Some(next_hop_pair) = data.peer_routes.iter().find(|pair| { + pair.route.clone().unwrap_or_default().peer_id + == p.route.clone().unwrap_or_default().next_hop_peer_id + }) else { + continue; + }; + + let next_hop_pair_latency_first = data.peer_routes.iter().find(|pair| { + pair.route.clone().unwrap_or_default().peer_id + == p.route + .clone() + .unwrap_or_default() + .next_hop_peer_id_latency_first + .unwrap_or_default() + }); + + let route = p.route.clone().unwrap_or_default(); + items.push(RouteTableItem { + ipv4: route.ipv4_addr.map(|ip| ip.to_string()).unwrap_or_default(), + hostname: route.hostname.clone(), + proxy_cidrs: route.proxy_cidrs.clone().join(","), + next_hop_ipv4: if route.cost == 1 { + "DIRECT".to_string() + } else { + next_hop_pair + .route + .clone() + .unwrap_or_default() + .ipv4_addr + .map(|ip| ip.to_string()) + .unwrap_or_default() + }, + next_hop_hostname: if route.cost == 1 { + "DIRECT".to_string() + } else { + next_hop_pair.route.clone().unwrap_or_default().hostname + }, + next_hop_lat: next_hop_pair.get_latency_ms().unwrap_or(0.0), + path_len: route.cost, + path_latency: route.path_latency, + next_hop_ipv4_lat_first: if route.cost_latency_first.unwrap_or_default() == 1 { + "DIRECT".to_string() + } else { + next_hop_pair_latency_first + .map(|pair| pair.route.clone().unwrap_or_default().ipv4_addr) + .unwrap_or_default() + .map(|ip| ip.to_string()) + .unwrap_or_default() + }, + next_hop_hostname_lat_first: if route.cost_latency_first.unwrap_or_default() + == 1 + { + "DIRECT".to_string() + } else { + next_hop_pair_latency_first + .map(|pair| pair.route.clone().unwrap_or_default().hostname) + .unwrap_or_default() + }, + path_latency_lat_first: route.path_latency_latency_first.unwrap_or_default(), + path_len_lat_first: route.cost_latency_first.unwrap_or_default(), + version: if route.version.is_empty() { + "unknown".to_string() + } else { + route.version + }, + }); + } + + items + }; + + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_route_list_data())) + .await?; + + if self.verbose { + return self.print_json_results(results); + } + if *self.output_format == OutputFormat::Json { + return self.print_json_results( + results + .into_iter() + .map(|result| result.map(|data| build_items(&data))) + .collect(), + ); + } + + self.print_results(&results, |data| { + let items = build_items(data); + print_output( + &items, + self.output_format, + ROUTE_OPTIONAL_COLUMNS, + ROUTE_DROP_COLUMNS, + self.no_trunc, + ) + }) + } + + async fn handle_connector_list(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_connector_list())) + .await?; + if self.verbose || *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + self.print_results(&results, |connectors| { + println!("response: {:#?}", connectors); + Ok(()) + }) + } + + async fn handle_acl_stats(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_acl_stats())) + .await?; + if *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + self.print_results(&results, |acl_stats| { + if let Some(acl_stats) = acl_stats { + println!("{}", acl_stats); + } else { + println!("No ACL statistics available"); + } + Ok(()) + }) + } + + async fn apply_acl_set(&self, acl: Acl) -> Result<(), Error> { + // tcp_whitelist/udp_whitelist are separate config knobs that remain in + // effect alongside the ACL; updating them is out of scope for `acl set`. + let client = self.get_config_client().await?; + let request = PatchConfigRequest { + instance: Some(self.instance_selector.clone()), + patch: Some(InstanceConfigPatch { + acl: Some(AclPatch { + acl: Some(acl), + ..Default::default() + }), + ..Default::default() + }), + }; + let _response = client + .patch_config(BaseController::default(), request) + .await?; + Ok(()) + } + + async fn handle_acl_set(&self, raw: &str) -> Result<(), Error> { + // Load the content either from a file (`@path`) or inline. + let text = if let Some(path) = raw.strip_prefix('@') { + tokio::fs::read_to_string(path) + .await + .with_context(|| format!("failed to read ACL file `{path}`"))? + } else { + raw.to_string() + }; + + // Try parsing as JSON first, then fallback to TOML if JSON parsing fails. + #[derive(serde::Deserialize, Default)] + struct AclWrapper { + acl: Option, + } + + // Your JSON file includes a full PatchConfigRequest structure: {"instance": ..., "patch": {"acl": {"acl": ...}}} + // Let's support parsing full PatchConfigRequest or patch payload or Acl directly. + #[derive(serde::Deserialize, Default)] + struct PatchRequestJson { + patch: Option, + } + + let acl = if let Ok(parsed_req) = serde_json::from_str::(&text) { + parsed_req + .patch + .and_then(|p| p.acl) + .and_then(|a| a.acl) + .unwrap_or_default() + } else if let Ok(parsed_json) = serde_json::from_str::(&text) { + parsed_json.acl.unwrap_or_default() + } else if let Ok(parsed_json_direct) = serde_json::from_str::(&text) { + parsed_json_direct + } else { + // Fallback to TOML + #[derive(serde::Deserialize, Default)] + struct AclToml { + acl: Option, + } + let parsed_toml: AclToml = toml::from_str(&text).with_context( + || "failed to parse ACL as either JSON or TOML (expected `[acl.acl_v1]` structure)", + )?; + parsed_toml.acl.unwrap_or_default() + }; + if acl.is_empty() { + anyhow::bail!( + "parsed ACL is empty; provide at least one chain or a non-empty group under `[acl.acl_v1]`" + ); + } + + // Redact group secrets before any JSON echo so credentials are never + // written to stdout or captured logs (matches core's dump redaction). + let mut sanitized = acl.clone(); + if let Some(group) = sanitized.acl_v1.as_mut().and_then(|v| v.group.as_mut()) { + for declaration in group.declares.iter_mut() { + if !declaration.group_secret.is_empty() { + declaration.group_secret = "".to_string(); + } + } + } + + let chain_count = acl + .acl_v1 + .as_ref() + .map(|v| v.chains.len()) + .unwrap_or_default(); + + // Apply to each selected instance, collecting per-instance outcomes so + // a failure on one instance does not leave others partially or + // silently updated. + let outcomes: Vec<(String, Result<(), Error>)> = match self.fanout_targets().await? { + Some(targets) => { + let mut list = Vec::with_capacity(targets.len()); + for target in targets { + let label = target.label(); + let scoped = self.scoped_to_instance(&target); + list.push((label, scoped.apply_acl_set(acl.clone()).await)); + } + list + } + None => vec![( + "selected instance".to_string(), + self.apply_acl_set(acl.clone()).await, + )], + }; + + let mut failures: Vec<(String, Error)> = Vec::new(); + let mut ok = 0usize; + for (label, result) in outcomes { + match result { + Ok(()) => { + ok += 1; + if *self.output_format == OutputFormat::Json { + println!( + "{}", + serde_json::to_string_pretty(&serde_json::json!({ + "instance": label, + "success": true, + "chains": chain_count, + "acl": &sanitized, + }))? + ); + } else { + println!("== {} ==", label); + println!("ACL updated successfully ({chain_count} chain(s))"); + } + } + Err(e) => { + if *self.output_format == OutputFormat::Json { + let _ = serde_json::to_writer( + std::io::stdout(), + &serde_json::json!({ + "instance": label, + "success": false, + "error": e.to_string(), + }), + ); + } else { + println!("== {} ==", label); + println!("ACL update failed: {e:#}"); + } + failures.push((label, e)); + } + } + } + + if ok == 0 { + return Err(anyhow::anyhow!( + "ACL update failed on all {} selected instance(s)", + failures.len() + )); + } + if !failures.is_empty() { + return Err(anyhow::anyhow!( + "ACL update failed on {} of {} selected instance(s): {}", + failures.len(), + ok + failures.len(), + failures + .iter() + .map(|(label, _)| label.as_str()) + .collect::>() + .join(", ") + )); + } + Ok(()) + } + + async fn handle_mapped_listener_list(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_mapped_listener_list())) + .await?; + if self.verbose || *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + self.print_results(&results, |listeners| { + println!("response: {:#?}", listeners); + Ok(()) + }) + } + + async fn apply_mapped_listener_modify( + &self, + url: &str, + action: ConfigPatchAction, + ) -> Result<(), Error> { + let url = Self::mapped_listener_validate_url(url)?; + let client = self.get_config_client().await?; + let request = PatchConfigRequest { + instance: Some(self.instance_selector.clone()), + patch: Some(InstanceConfigPatch { + mapped_listeners: vec![UrlPatch { + action: action.into(), + url: Some(url.into()), + }], + ..Default::default() + }), + }; + let _response = client + .patch_config(BaseController::default(), request) + .await?; + Ok(()) + } + + async fn handle_mapped_listener_modify( + &self, + url: &str, + action: ConfigPatchAction, + ) -> Result<(), Error> { + let url = url.to_string(); + self.apply_to_instances(|handler| { + let url = url.clone(); + Box::pin(async move { handler.apply_mapped_listener_modify(&url, action).await }) + }) + .await + } + + fn mapped_listener_validate_url(url: &str) -> Result { + let url = url::Url::parse(url)?; + if url.scheme() != "tcp" && url.scheme() != "udp" { + return Err(anyhow::anyhow!( + "Url ({url}) must start with tcp:// or udp://" + )); + } else if url.port().is_none() { + return Err(anyhow::anyhow!("Url ({url}) is missing port num")); + } + Ok(url) + } + + async fn apply_port_forward_modify( + &self, + action: ConfigPatchAction, + protocol: &str, + bind_addr: &str, + dst_addr: Option<&str>, + ) -> Result<(), Error> { + let bind_addr: std::net::SocketAddr = bind_addr + .parse() + .with_context(|| format!("Invalid bind address: {}", bind_addr))?; + + let socket_type = match protocol { + "tcp" => SocketType::Tcp, + "udp" => SocketType::Udp, + _ => return Err(anyhow::anyhow!("Protocol must be 'tcp' or 'udp'")), + }; + + let client = self.get_config_client().await?; + let request = PatchConfigRequest { + instance: Some(self.instance_selector.clone()), + patch: Some(InstanceConfigPatch { + port_forwards: vec![PortForwardPatch { + action: action.into(), + cfg: Some(PortForwardConfigPb { + bind_addr: Some(bind_addr.into()), + dst_addr: dst_addr.map(|s| s.parse::().unwrap().into()), + socket_type: socket_type.into(), + }), + }], + ..Default::default() + }), + }; + + client + .patch_config(BaseController::default(), request) + .await?; + println!( + "Port forward rule {}: {} {}", + action.as_str_name().to_lowercase(), + protocol, + bind_addr + ); + Ok(()) + } + + async fn handle_port_forward_modify( + &self, + action: ConfigPatchAction, + protocol: &str, + bind_addr: &str, + dst_addr: Option<&str>, + ) -> Result<(), Error> { + let protocol = protocol.to_string(); + let bind_addr = bind_addr.to_string(); + let dst_addr = dst_addr.map(str::to_string); + self.apply_to_instances(|handler| { + let protocol = protocol.clone(); + let bind_addr = bind_addr.clone(); + let dst_addr = dst_addr.clone(); + Box::pin(async move { + handler + .apply_port_forward_modify(action, &protocol, &bind_addr, dst_addr.as_deref()) + .await + }) + }) + .await + } + + async fn handle_port_forward_list(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_port_forward_list())) + .await?; + if self.verbose || *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + #[derive(tabled::Tabled, serde::Serialize)] + struct PortForwardTableItem { + protocol: String, + bind_addr: String, + dst_addr: String, + } + + self.print_results(&results, |response| { + let items: Vec = response + .cfgs + .iter() + .cloned() + .map(|rule| PortForwardTableItem { + protocol: format!( + "{:?}", + SocketType::try_from(rule.socket_type).unwrap_or(SocketType::Tcp) + ), + bind_addr: rule + .bind_addr + .map(|addr| addr.to_string()) + .unwrap_or_default(), + dst_addr: rule + .dst_addr + .map(|addr| addr.to_string()) + .unwrap_or_default(), + }) + .collect(); + + print_output(&items, self.output_format, &[], &[], self.no_trunc) + }) + } + + async fn apply_whitelist_set(&self, ports: &str, is_tcp: bool) -> Result<(), Error> { + let mut whitelist = Self::parse_port_list(ports)? + .into_iter() + .map(|p| StringPatch { + action: ConfigPatchAction::Add.into(), + value: p, + }) + .collect::>(); + whitelist.insert( + 0, + StringPatch { + action: ConfigPatchAction::Clear.into(), + value: "".to_string(), + }, + ); + let client = self.get_config_client().await?; + + let request = PatchConfigRequest { + instance: Some(self.instance_selector.clone()), + patch: Some(InstanceConfigPatch { + acl: Some(AclPatch { + tcp_whitelist: if is_tcp { whitelist.clone() } else { vec![] }, + udp_whitelist: if is_tcp { vec![] } else { whitelist }, + ..Default::default() + }), + ..Default::default() + }), + }; + + client + .patch_config(BaseController::default(), request) + .await?; + Ok(()) + } + + async fn handle_whitelist_set_tcp(&self, ports: &str) -> Result<(), Error> { + let ports = ports.to_string(); + self.apply_to_instances(|handler| { + let ports = ports.clone(); + Box::pin(async move { handler.apply_whitelist_set(&ports, true).await }) + }) + .await?; + println!("TCP whitelist updated: {}", ports); + Ok(()) + } + + async fn handle_whitelist_set_udp(&self, ports: &str) -> Result<(), Error> { + let ports = ports.to_string(); + self.apply_to_instances(|handler| { + let ports = ports.clone(); + Box::pin(async move { handler.apply_whitelist_set(&ports, false).await }) + }) + .await?; + println!("UDP whitelist updated: {}", ports); + Ok(()) + } + + async fn apply_whitelist_clear(&self, is_tcp: bool) -> Result<(), Error> { + let client = self.get_config_client().await?; + + let request = PatchConfigRequest { + instance: Some(self.instance_selector.clone()), + patch: Some(InstanceConfigPatch { + acl: Some(AclPatch { + tcp_whitelist: if is_tcp { + vec![StringPatch { + action: ConfigPatchAction::Clear.into(), + value: "".to_string(), + }] + } else { + vec![] + }, + udp_whitelist: if is_tcp { + vec![] + } else { + vec![StringPatch { + action: ConfigPatchAction::Clear.into(), + value: "".to_string(), + }] + }, + ..Default::default() + }), + ..Default::default() + }), + }; + + client + .patch_config(BaseController::default(), request) + .await?; + Ok(()) + } + + async fn handle_whitelist_clear_tcp(&self) -> Result<(), Error> { + self.apply_to_instances(|handler| Box::pin(handler.apply_whitelist_clear(true))) + .await?; + println!("TCP whitelist cleared"); + Ok(()) + } + + async fn handle_whitelist_clear_udp(&self) -> Result<(), Error> { + self.apply_to_instances(|handler| Box::pin(handler.apply_whitelist_clear(false))) + .await?; + println!("UDP whitelist cleared"); + Ok(()) + } + + async fn handle_whitelist_show(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_whitelist())) + .await?; + if self.verbose || *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + self.print_results(&results, |response| { + println!( + "TCP Whitelist: {}", + if response.tcp_ports.is_empty() { + "None".to_string() + } else { + response.tcp_ports.join(", ") + } + ); + + println!( + "UDP Whitelist: {}", + if response.udp_ports.is_empty() { + "None".to_string() + } else { + response.udp_ports.join(", ") + } + ); + Ok(()) + }) + } + + async fn handle_logger_get(&self) -> Result<(), Error> { + let client = self.get_logger_client().await?; + let request = GetLoggerConfigRequest::default(); + let response = client + .get_logger_config(BaseController::default(), request) + .await?; + + match self.output_format { + OutputFormat::Table => { + let level_str = match response.level() { + LogLevel::Disabled => "disabled", + LogLevel::Error => "error", + LogLevel::Warning => "warning", + LogLevel::Info => "info", + LogLevel::Debug => "debug", + LogLevel::Trace => "trace", + }; + println!("Current Log Level: {}", level_str); + } + OutputFormat::Json => { + let json = serde_json::to_string_pretty(&response)?; + println!("{}", json); + } + } + + Ok(()) + } + + async fn handle_logger_set(&self, level: &str) -> Result<(), Error> { + let log_level = match level.to_lowercase().as_str() { + "disabled" => LogLevel::Disabled, + "error" => LogLevel::Error, + "warning" => LogLevel::Warning, + "info" => LogLevel::Info, + "debug" => LogLevel::Debug, + "trace" => LogLevel::Trace, + _ => { + return Err(anyhow::anyhow!( + "Invalid log level: {}. Valid levels are: disabled, error, warning, info, debug, trace", + level + )); + } + }; + + let client = self.get_logger_client().await?; + let request = SetLoggerConfigRequest { + level: log_level.into(), + }; + let response = client + .set_logger_config(BaseController::default(), request) + .await?; + + match self.output_format { + OutputFormat::Table => { + println!("Log level successfully set to: {}", level); + } + OutputFormat::Json => { + let json = serde_json::to_string_pretty(&response)?; + println!("{}", json); + } + } + + Ok(()) + } + + async fn handle_credential_generate( + &self, + ttl: i64, + credential_id: Option, + groups: Vec, + allow_relay: bool, + allowed_proxy_cidrs: Vec, + reusable: bool, + ) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| { + let credential_id = credential_id.clone(); + let groups = groups.clone(); + let allowed_proxy_cidrs = allowed_proxy_cidrs.clone(); + Box::pin(async move { + handler + .get_credential_client() + .await? + .generate_credential( + BaseController::default(), + GenerateCredentialRequest { + credential_id, + groups, + allow_relay, + allowed_proxy_cidrs, + ttl_seconds: ttl, + instance: Some(handler.instance_selector.clone()), + reusable: Some(reusable), + }, + ) + .await + .map_err(Into::into) + }) + }) + .await?; + + if *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + self.print_results(&results, |response| { + println!("Credential generated successfully:"); + println!(" credential_id: {}", response.credential_id); + println!(" credential_secret: {}", response.credential_secret); + println!(); + println!("To use this credential on a new node:"); + println!( + " easytier-core --network-name --secure-mode --credential {} -p ", + response.credential_secret + ); + Ok(()) + }) + } + + async fn handle_credential_revoke(&self, credential_id: &str) -> Result<(), Error> { + let credential_id = credential_id.to_string(); + let results = self + .collect_instance_results(|handler| { + let credential_id = credential_id.clone(); + Box::pin(async move { + handler + .get_credential_client() + .await? + .revoke_credential( + BaseController::default(), + RevokeCredentialRequest { + credential_id, + instance: Some(handler.instance_selector.clone()), + }, + ) + .await + .map_err(Into::into) + }) + }) + .await?; + + if *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + self.print_results(&results, |response| { + if response.success { + println!("Credential revoked successfully"); + } else { + println!("Credential not found"); + } + Ok(()) + }) + } + + async fn handle_credential_list(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_credential_list())) + .await?; + + if *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + self.print_results(&results, |response| { + if response.credentials.is_empty() { + println!("No active credentials"); + } else { + use tabled::{builder::Builder, settings::Style}; + let mut builder = Builder::default(); + builder.push_record([ + "ID", + "Groups", + "Relay", + "Reusable", + "Expiry", + "Allowed CIDRs", + ]); + for cred in &response.credentials { + let expiry = { + let secs = cred.expiry_unix; + let remaining = secs + - std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .unwrap() + .as_secs() as i64; + if remaining > 0 { + format!("{}s remaining", remaining) + } else { + "expired".to_string() + } + }; + builder.push_record([ + &cred.credential_id[..], + &cred.groups.join(","), + if cred.allow_relay { "yes" } else { "no" }, + if cred.reusable.unwrap_or(true) { + "yes" + } else { + "no" + }, + &expiry, + &cred.allowed_proxy_cidrs.join(","), + ]); + } + let table = builder.build().with(Style::rounded()).to_string(); + println!("{}", table); + } + Ok(()) + }) + } + + async fn handle_peer_center(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_peer_center_rows())) + .await?; + + if *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + #[derive(tabled::Tabled, serde::Serialize)] + struct PeerCenterTableItem { + node_id: String, + hostname: String, + ipv4: String, + #[tabled(rename = "direct_peers")] + direct_peers_str: String, + } + + self.print_results(&results, |rows| { + let table_rows = rows + .iter() + .map(|row| PeerCenterTableItem { + node_id: row.node_id.clone(), + hostname: row.hostname.clone(), + ipv4: row.ipv4.clone(), + direct_peers_str: row + .direct_peers + .iter() + .map(|x| { + format!( + "{}({}[{}]): {}ms", + x.node_id, x.hostname, x.ipv4, x.latency_ms, + ) + }) + .collect::>() + .join("\n"), + }) + .collect::>(); + print_output( + &table_rows, + self.output_format, + &["direct_peers"], + &["direct_peers"], + self.no_trunc, + ) + }) + } + + async fn apply_vpn_portal_client_patch( + &self, + patch: VpnPortalClientPatch, + ) -> Result<(), Error> { + let client = self.get_config_client().await?; + let request = PatchConfigRequest { + instance: Some(self.instance_selector.clone()), + patch: Some(InstanceConfigPatch { + vpn_portal_clients: vec![patch], + ..Default::default() + }), + }; + let _response = client + .patch_config(BaseController::default(), request) + .await?; + Ok(()) + } + + async fn handle_vpn_portal_add_client( + &self, + name: String, + virtual_ip: String, + groups: Vec, + ) -> Result<(), Error> { + let virtual_ip = parse_vpn_portal_client_cidr(&virtual_ip)?.to_string(); + self.apply_to_instances(|handler| { + let name = name.clone(); + let virtual_ip = virtual_ip.clone(); + let groups = groups.clone(); + Box::pin(async move { + handler + .apply_vpn_portal_client_patch(VpnPortalClientPatch { + action: ConfigPatchAction::Add as i32, + client: Some(ManageVpnPortalClientConfig { + name, + virtual_ip, + groups, + }), + }) + .await + }) + }) + .await + } + + async fn handle_vpn_portal_remove_client(&self, name: String) -> Result<(), Error> { + self.apply_to_instances(|handler| { + let name = name.clone(); + Box::pin(async move { + handler + .apply_vpn_portal_client_patch(VpnPortalClientPatch { + action: ConfigPatchAction::Remove as i32, + client: Some(ManageVpnPortalClientConfig { + name, + virtual_ip: String::new(), + groups: Vec::new(), + }), + }) + .await + }) + }) + .await + } + + async fn handle_vpn_portal_clear_clients(&self) -> Result<(), Error> { + self.apply_to_instances(|handler| { + Box::pin(async move { + handler + .apply_vpn_portal_client_patch(VpnPortalClientPatch { + action: ConfigPatchAction::Clear as i32, + client: None, + }) + .await + }) + }) + .await + } + + async fn handle_vpn_portal(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_vpn_portal_info())) + .await?; + + if *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + self.print_results(&results, |resp| { + println!("portal_name: {}", resp.vpn_type); + if let Some(listener) = &resp.listener { + println!("listener: {listener}"); + } + for client in &resp.clients { + let state = easytier_proto::api::instance::VpnPortalClientState::try_from( + client.state, + ) + .map_or("UNKNOWN", |state| state.as_str_name()); + println!( + "\nclient: {}\nvirtual_ip: {}\nstate: {}\npeer_id: {}\nendpoint: {}\ntunnel_ip: {}\ngroups: {}", + client.name, + client.virtual_ip, + state, + client + .peer_id + .map(|value| value.to_string()) + .unwrap_or_else(|| "-".to_owned()), + client.endpoint.as_deref().unwrap_or("-"), + client.tunnel_ip.as_deref().unwrap_or("-"), + client.groups.join(", "), + ); + println!( + "############### client_config_start ###############\n{}############### client_config_end ###############", + client.client_config + ); + if let Some(error) = &client.error { + println!("error: {error}"); + } + } + Ok(()) + }) + } + + async fn handle_node(&self, sub_command: Option<&NodeSubCommand>) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_node_info())) + .await?; + + if self.verbose || *self.output_format == OutputFormat::Json { + return match sub_command { + Some(NodeSubCommand::Config) => self.print_json_results( + results + .into_iter() + .map(|result| result.map(|node| node.config)) + .collect(), + ), + _ => self.print_json_results(results), + }; + } + + self.print_results(&results, |node_info| match sub_command { + Some(NodeSubCommand::Config) => { + println!("{}", node_info.config); + Ok(()) + } + Some(NodeSubCommand::Info) | None => { + let stun_info = node_info.stun_info.clone().unwrap_or_default(); + let ip_list = node_info.ip_list.clone().unwrap_or_default(); + + let mut builder = tabled::builder::Builder::default(); + builder.push_record(vec!["Virtual IP", node_info.ipv4_addr.as_str()]); + builder.push_record(vec!["Hostname", node_info.hostname.as_str()]); + builder.push_record(vec![ + "Proxy CIDRs", + node_info.proxy_cidrs.join(", ").as_str(), + ]); + builder.push_record(vec!["Peer ID", node_info.peer_id.to_string().as_str()]); + stun_info.public_ip.iter().for_each(|ip| { + let Ok(ip) = ip.parse::() else { + return; + }; + if ip.is_ipv4() { + builder.push_record(vec!["Public IPv4", ip.to_string().as_str()]); + } else { + builder.push_record(vec!["Public IPv6", ip.to_string().as_str()]); + } + }); + builder.push_record(vec![ + "UDP Stun Type", + format!("{:?}", stun_info.udp_nat_type()).as_str(), + ]); + ip_list.interface_ipv4s.iter().for_each(|ip| { + builder.push_record(vec!["Interface IPv4", ip.to_string().as_str()]); + }); + ip_list.interface_ipv6s.iter().for_each(|ip| { + builder.push_record(vec!["Interface IPv6", ip.to_string().as_str()]); + }); + for (idx, l) in node_info.listeners.iter().enumerate() { + if l.starts_with("ring") { + continue; + } + builder.push_record(vec![format!("Listener {}", idx).as_str(), l]); + } + + println!("{}", builder.build().with(Style::markdown())); + Ok(()) + } + }) + } + + async fn handle_stats_show(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_stats())) + .await?; + + if *self.output_format == OutputFormat::Json { + return self.print_json_results(results); + } + + #[derive(tabled::Tabled, serde::Serialize)] + struct StatsTableRow { + #[tabled(rename = "Metric Name")] + name: String, + #[tabled(rename = "Value")] + value: String, + #[tabled(rename = "Labels")] + labels: String, + } + + self.print_results(&results, |metrics| { + let table_rows: Vec = metrics + .iter() + .map(|metric| { + let labels_str = if metric.labels.is_empty() { + "-".to_string() + } else { + metric + .labels + .iter() + .map(|(k, v)| format!("{}={}", k, v)) + .collect::>() + .join(", ") + }; + + let formatted_value = if metric.name.contains("bytes") { + format_size(metric.value, humansize::BINARY) + } else if metric.name.contains("duration") { + format!("{} ms", metric.value) + } else { + metric.value.to_string() + }; + + StatsTableRow { + name: metric.name.clone(), + value: formatted_value, + labels: labels_str, + } + }) + .collect(); + + print_output( + &table_rows, + self.output_format, + &["labels"], + &["labels"], + self.no_trunc, + ) + }) + } + + async fn handle_stats_prometheus(&self) -> Result<(), Error> { + let results = self + .collect_instance_results(|handler| Box::pin(handler.fetch_prometheus_stats())) + .await?; + + if *self.output_format == OutputFormat::Json { + return self.print_json_results( + results + .into_iter() + .map(|result| result.map(|text| serde_json::json!({ "prometheus_text": text }))) + .collect(), + ); + } + + self.print_results(&results, |text| { + println!("{}", text); + Ok(()) + }) + } + + fn parse_port_list(ports_str: &str) -> Result, Error> { + let mut ports = Vec::new(); + for port_spec in ports_str.split(',') { + let port_spec = port_spec.trim(); + if port_spec.contains('-') { + // Handle port range + let parts: Vec<&str> = port_spec.split('-').collect(); + if parts.len() != 2 { + return Err(anyhow::anyhow!("Invalid port range: {}", port_spec)); + } + let start: u16 = parts[0] + .parse() + .with_context(|| format!("Invalid start port: {}", parts[0]))?; + let end: u16 = parts[1] + .parse() + .with_context(|| format!("Invalid end port: {}", parts[1]))?; + if start > end { + return Err(anyhow::anyhow!("Invalid port range: start > end")); + } + ports.push(format!("{}-{}", start, end)); + } else { + // Handle single port + let port: u16 = port_spec + .parse() + .with_context(|| format!("Invalid port number: {}", port_spec))?; + ports.push(port.to_string()); + } + } + Ok(ports) + } +} + +fn print_output( + items: &[T], + format: &OutputFormat, + optional_columns: &[&str], + drop_columns: &[&str], + no_trunc: bool, +) -> Result<(), Error> +where + T: tabled::Tabled + serde::Serialize, +{ + match format { + OutputFormat::Table => { + let mut table = tabled::Table::new(items); + table.with(Style::markdown()); + if no_trunc { + println!("{}", table); + return Ok(()); + } + let headers = T::headers() + .iter() + .map(|header| header.as_ref().to_string()) + .collect::>(); + let col_widths = compute_column_widths(items); + let terminal_width = terminal_table_width(); + let drop_indices = header_indices(&headers, drop_columns); + let optional_indices = header_indices(&headers, optional_columns); + let (active, drop_indices, total_width) = + select_columns_to_drop(terminal_width, &drop_indices, &col_widths); + apply_column_drops(&mut table, &drop_indices); + apply_optional_column_truncation( + &mut table, + terminal_width, + &headers, + &optional_indices, + &col_widths, + &active, + total_width, + ); + println!("{}", table); + } + OutputFormat::Json => { + println!("{}", serde_json::to_string_pretty(items)?); + } + } + Ok(()) +} + +fn terminal_table_width() -> Option { + let (TerminalWidth(width), _) = terminal_size()?; + let width = width as usize; + // Avoid wrapping at the last column which can still trigger a hard line break. + width.checked_sub(1) +} + +fn apply_optional_column_truncation( + table: &mut tabled::Table, + terminal_width: Option, + headers: &[String], + optional_indices: &[usize], + col_widths: &[usize], + active: &[bool], + total_width: usize, +) { + let Some(terminal_width) = terminal_width else { + return; + }; + if optional_indices.is_empty() || total_width <= terminal_width { + return; + } + + let targets = optional_column_targets(terminal_width, optional_indices, col_widths, active); + for (index, width) in targets { + if let Some(name) = headers.get(index) { + table.with( + Modify::new(ByColumnName::new(name)).with(Width::truncate(width).suffix("...")), + ); + } + } +} + +fn apply_column_drops(table: &mut tabled::Table, drop_indices: &[usize]) { + let mut indices = drop_indices.to_vec(); + indices.sort_unstable_by(|a, b| b.cmp(a)); + for index in indices { + table.with(Remove::column(Columns::one(index))); + } +} + +fn compute_column_widths(items: &[T]) -> Vec +where + T: tabled::Tabled, +{ + let mut widths = vec![0usize; T::LENGTH]; + for (idx, header) in T::headers().iter().enumerate() { + widths[idx] = widths[idx].max(text_width(header.as_ref())); + } + for item in items { + for (idx, field) in item.fields().iter().enumerate() { + widths[idx] = widths[idx].max(text_width(field.as_ref())); + } + } + widths +} + +fn text_width(text: &str) -> usize { + text.split('\n') + .map(UnicodeWidthStr::width) + .max() + .unwrap_or(0) +} + +fn header_indices(headers: &[String], names: &[&str]) -> Vec { + let mut indices = Vec::new(); + for name in names { + if let Some(index) = headers + .iter() + .position(|header| header.eq_ignore_ascii_case(name)) + && !indices.contains(&index) + { + indices.push(index); + } + } + indices +} + +fn select_columns_to_drop( + terminal_width: Option, + drop_indices: &[usize], + col_widths: &[usize], +) -> (Vec, Vec, usize) { + let mut active = vec![true; col_widths.len()]; + let Some(terminal_width) = terminal_width else { + let total = table_total_width(col_widths, &active); + return (active, vec![], total); + }; + + let mut total = table_total_width(col_widths, &active); + if total <= terminal_width { + return (active, vec![], total); + } + + let mut dropped = vec![]; + for &index in drop_indices { + if total <= terminal_width { + break; + } + if active[index] { + active[index] = false; + dropped.push(index); + total = table_total_width(col_widths, &active); + } + } + + (active, dropped, total) +} + +fn table_total_width(col_widths: &[usize], active: &[bool]) -> usize { + let col_count = active.iter().filter(|value| **value).count(); + if col_count == 0 { + return 0; + } + let content_width = col_widths + .iter() + .zip(active.iter()) + .filter_map(|(width, keep)| keep.then_some(*width)) + .sum::(); + content_width + 3 * col_count + 1 +} + +fn optional_column_targets( + terminal_width: usize, + optional_indices: &[usize], + col_widths: &[usize], + active: &[bool], +) -> Vec<(usize, usize)> { + if optional_indices.is_empty() { + return vec![]; + } + + let mut is_optional = vec![false; col_widths.len()]; + for &index in optional_indices { + if let Some(flag) = is_optional.get_mut(index) { + *flag = true; + } + } + + let optional_indices = optional_indices + .iter() + .copied() + .filter(|idx| active.get(*idx).copied().unwrap_or(false)) + .collect::>(); + if optional_indices.is_empty() { + return vec![]; + } + + let col_count = active.iter().filter(|value| **value).count(); + let overhead = 3 * col_count + 1; + let mut required_width = overhead; + for (idx, width) in col_widths.iter().enumerate() { + if active.get(idx).copied().unwrap_or(false) && !is_optional[idx] { + required_width += *width; + } + } + + let remaining = terminal_width.saturating_sub(required_width); + let min_width = 6usize; + let per_column = if remaining == 0 { + min_width + } else { + (remaining / optional_indices.len()).clamp(min_width, 24) + }; + + optional_indices + .into_iter() + .map(|idx| (idx, col_widths[idx].min(per_column))) + .collect() +} + +#[tokio::main] +#[tracing::instrument] +async fn main() -> Result<(), Error> { + let locale = sys_locale::get_locale().unwrap_or_else(|| String::from("en-US")); + rust_i18n::set_locale(&locale); + let cli = Cli::parse(); + + let client = runtime_rpc_client( + format!("tcp://{}:{}", cli.rpc_portal.ip(), cli.rpc_portal.port()) + .parse() + .unwrap(), + ); + let handler = CommandHandler { + client: Arc::new(tokio::sync::Mutex::new(client)), + verbose: cli.verbose, + output_format: &cli.output_format, + no_trunc: cli.no_trunc, + instance_select: &cli.instance_select, + instance_selector: (&cli.instance_select).into(), + resolved_target: None, + }; + + match cli.sub_command { + SubCommand::Peer(peer_args) => match &peer_args.sub_command { + Some(PeerSubCommand::List) => { + handler.handle_peer_list().await?; + } + Some(PeerSubCommand::Ipv6) => { + handler.handle_peer_ipv6().await?; + } + Some(PeerSubCommand::ListForeign { trusted_keys }) => { + handler.handle_foreign_network_list(*trusted_keys).await?; + } + Some(PeerSubCommand::ListGlobalForeign) => { + handler.handle_global_foreign_network_list().await?; + } + None => { + handler.handle_peer_list().await?; + } + }, + SubCommand::Connector(conn_args) => match conn_args.sub_command { + Some(ConnectorSubCommand::Add { url }) => { + handler + .handle_connector_modify(&url, ConfigPatchAction::Add) + .await?; + println!("connector add applied to selected instance(s): {url}"); + } + Some(ConnectorSubCommand::Remove { url }) => { + handler + .handle_connector_modify(&url, ConfigPatchAction::Remove) + .await?; + println!("connector remove applied to selected instance(s): {url}"); + } + Some(ConnectorSubCommand::List) => { + handler.handle_connector_list().await?; + } + None => { + handler.handle_connector_list().await?; + } + }, + SubCommand::MappedListener(mapped_listener_args) => { + match mapped_listener_args.sub_command { + Some(MappedListenerSubCommand::Add { url }) => { + handler + .handle_mapped_listener_modify(&url, ConfigPatchAction::Add) + .await?; + println!("add mapped listener: {url}"); + } + Some(MappedListenerSubCommand::Remove { url }) => { + handler + .handle_mapped_listener_modify(&url, ConfigPatchAction::Remove) + .await?; + println!("remove mapped listener: {url}"); + } + Some(MappedListenerSubCommand::List) | None => { + handler.handle_mapped_listener_list().await?; + } + } + } + SubCommand::Route(route_args) => match route_args.sub_command { + Some(RouteSubCommand::List) | None => handler.handle_route_list().await?, + Some(RouteSubCommand::Dump) => handler.handle_route_dump().await?, + }, + SubCommand::Stun => { + timeout(Duration::from_secs(25), async move { + let collector = runtime_stun_info_collector(Default::default()); + loop { + let ret = collector.get_stun_info(); + if ret.udp_nat_type != NatType::Unknown as i32 + && ret.tcp_nat_type != NatType::Unknown as i32 + { + if cli.output_format == OutputFormat::Json { + match serde_json::to_string_pretty(&ret) { + Ok(json) => println!("{}", json), + Err(e) => eprintln!("Error serializing to JSON: {}", e), + } + } else { + println!("stun info: {:#?}", ret); + } + break; + } + tokio::time::sleep(Duration::from_millis(200)).await; + } + }) + .await + .unwrap(); + } + SubCommand::PeerCenter => { + handler.handle_peer_center().await?; + } + SubCommand::VpnPortal(args) => match args.sub_command { + None => handler.handle_vpn_portal().await?, + Some(VpnPortalSubCommand::AddClient { + name, + virtual_ip, + groups, + }) => { + handler + .handle_vpn_portal_add_client(name, virtual_ip, groups) + .await?; + } + Some(VpnPortalSubCommand::RemoveClient { name }) => { + handler.handle_vpn_portal_remove_client(name).await?; + } + Some(VpnPortalSubCommand::ClearClients) => { + handler.handle_vpn_portal_clear_clients().await?; + } + }, + SubCommand::Node(sub_cmd) => { + handler.handle_node(sub_cmd.sub_command.as_ref()).await?; + } + SubCommand::Service(service_args) => { + let service = Service::new(service_args.name)?; + match service_args.sub_command { + ServiceSubCommand::Install(install_args) => { + let bin_path = install_args.core_path.unwrap_or_else(|| { + let mut ret = std::env::current_exe() + .unwrap() + .parent() + .unwrap() + .join("easytier-core"); + + if cfg!(target_os = "windows") { + ret.set_extension("exe"); + } + + ret + }); + let bin_path = std::fs::canonicalize(bin_path).map_err(|e| { + anyhow::anyhow!("failed to get easytier core application: {}", e) + })?; + let bin_args = install_args.core_args.unwrap_or_default(); + let work_dir = install_args.service_work_dir.unwrap_or_else(|| { + if cfg!(target_os = "windows") { + bin_path.parent().unwrap().to_path_buf() + } else { + std::env::temp_dir() + } + }); + + let work_dir = std::fs::canonicalize(&work_dir).map_err(|e| { + anyhow::anyhow!( + "failed to get service work directory[{}]: {}", + work_dir.display(), + e + ) + })?; + + if !work_dir.is_dir() { + return Err(anyhow::anyhow!("work directory is not a directory")); + } + + let install_options = ServiceInstallOptions { + program: bin_path, + args: bin_args, + work_directory: work_dir, + environment: None, + disable_autostart: install_args.disable_autostart.unwrap_or(false), + description: Some(install_args.description), + display_name: install_args.display_name, + disable_restart_on_failure: install_args + .disable_restart_on_failure + .unwrap_or(false), + }; + println!("install_options: {:#?}", install_options); + service.install(&install_options)?; + } + ServiceSubCommand::Uninstall => { + service.uninstall()?; + } + ServiceSubCommand::Status => { + let status = service.status()?; + match status { + ServiceStatus::Running => println!("Service is running"), + ServiceStatus::Stopped(_) => println!("Service is stopped"), + ServiceStatus::NotInstalled => println!("Service is not installed"), + } + } + ServiceSubCommand::Start => { + service.start()?; + } + ServiceSubCommand::Stop => { + service.stop()?; + } + } + } + SubCommand::Proxy => { + let mut entries = vec![]; + + for client_type in &["tcp", "kcp_src", "kcp_dst", "quic_src", "quic_dst"] { + let client = handler.get_tcp_proxy_client(client_type).await?; + let ret = client + .list_tcp_proxy_entry(BaseController::default(), Default::default()) + .await; + entries.extend(ret.unwrap_or_default().entries); + } + + if cli.verbose { + println!("{}", serde_json::to_string_pretty(&entries)?); + return Ok(()); + } + + #[derive(tabled::Tabled, serde::Serialize)] + struct TableItem { + src: String, + dst: String, + start_time: String, + state: String, + transport_type: String, + } + + let table_rows = entries + .iter() + .map(|e| TableItem { + src: SocketAddr::from(e.src.unwrap_or_default()).to_string(), + dst: SocketAddr::from(e.dst.unwrap_or_default()).to_string(), + start_time: chrono::DateTime::::from_timestamp_millis( + (e.start_time * 1000) as i64, + ) + .unwrap() + .with_timezone(&chrono::Local) + .format("%Y-%m-%d %H:%M:%S") + .to_string(), + state: format!("{:?}", TcpProxyEntryState::try_from(e.state).unwrap()), + transport_type: format!( + "{:?}", + TcpProxyEntryTransportType::try_from(e.transport_type).unwrap() + ), + }) + .collect::>(); + + print_output( + &table_rows, + &cli.output_format, + &["start_time", "state", "transport_type"], + &["start_time", "state", "transport_type"], + cli.no_trunc, + )?; + } + SubCommand::Acl(acl_args) => match &acl_args.sub_command { + Some(AclSubCommand::Stats) | None => { + handler.handle_acl_stats().await?; + } + Some(AclSubCommand::Set(args)) => { + handler.handle_acl_set(&args.acl).await?; + } + }, + SubCommand::PortForward(port_forward_args) => match &port_forward_args.sub_command { + Some(PortForwardSubCommand::Add { + protocol, + bind_addr, + dst_addr, + }) => { + handler + .handle_port_forward_modify( + ConfigPatchAction::Add, + protocol, + bind_addr, + Some(dst_addr), + ) + .await?; + } + Some(PortForwardSubCommand::Remove { + protocol, + bind_addr, + dst_addr, + }) => { + handler + .handle_port_forward_modify( + ConfigPatchAction::Remove, + protocol, + bind_addr, + dst_addr.as_deref(), + ) + .await?; + } + Some(PortForwardSubCommand::List) | None => { + handler.handle_port_forward_list().await?; + } + }, + SubCommand::Whitelist(whitelist_args) => match &whitelist_args.sub_command { + Some(WhitelistSubCommand::SetTcp { ports }) => { + handler.handle_whitelist_set_tcp(ports).await?; + } + Some(WhitelistSubCommand::SetUdp { ports }) => { + handler.handle_whitelist_set_udp(ports).await?; + } + Some(WhitelistSubCommand::ClearTcp) => { + handler.handle_whitelist_clear_tcp().await?; + } + Some(WhitelistSubCommand::ClearUdp) => { + handler.handle_whitelist_clear_udp().await?; + } + Some(WhitelistSubCommand::Show) | None => { + handler.handle_whitelist_show().await?; + } + }, + SubCommand::Stats(stats_args) => match &stats_args.sub_command { + Some(StatsSubCommand::Show) | None => { + handler.handle_stats_show().await?; + } + Some(StatsSubCommand::Prometheus) => { + handler.handle_stats_prometheus().await?; + } + }, + SubCommand::Logger(logger_args) => match &logger_args.sub_command { + Some(LoggerSubCommand::Get) | None => { + handler.handle_logger_get().await?; + } + Some(LoggerSubCommand::Set { level }) => { + handler.handle_logger_set(level).await?; + } + }, + SubCommand::Credential(credential_args) => match &credential_args.sub_command { + CredentialSubCommand::Generate { + ttl, + credential_id, + groups, + allow_relay, + allowed_proxy_cidrs, + reusable, + } => { + handler + .handle_credential_generate( + *ttl, + credential_id.clone(), + groups.clone().unwrap_or_default(), + *allow_relay, + allowed_proxy_cidrs.clone().unwrap_or_default(), + *reusable, + ) + .await?; + } + CredentialSubCommand::Revoke { credential_id } => { + handler.handle_credential_revoke(credential_id).await?; + } + CredentialSubCommand::List => { + handler.handle_credential_list().await?; + } + }, + SubCommand::GenAutocomplete { shell } => { + let mut cmd = Cli::command(); + if let Some(shell) = shell.to_shell() { + easytier::print_completions(shell, &mut cmd, "easytier-cli"); + } else { + // Handle Nushell + easytier::print_nushell_completions(&mut cmd, "easytier-cli"); + } + } + } + + Ok(()) +} diff --git a/vendor/easytier/easytier/src/easytier-core.rs b/vendor/easytier/easytier/src/easytier-core.rs new file mode 100644 index 0000000..ca175f6 --- /dev/null +++ b/vendor/easytier/easytier/src/easytier-core.rs @@ -0,0 +1,29 @@ +use easytier::core; + +#[cfg(all(feature = "mimalloc", not(feature = "jemalloc")))] +use mimalloc::MiMalloc; + +#[cfg(all(feature = "mimalloc", not(feature = "jemalloc")))] +#[global_allocator] +static GLOBAL_MIMALLOC: MiMalloc = MiMalloc; + +#[cfg(feature = "jemalloc")] +#[global_allocator] +static ALLOC: jemallocator::Jemalloc = jemallocator::Jemalloc; + +#[cfg(feature = "jemalloc-prof")] +#[allow(non_upper_case_globals)] +#[unsafe(export_name = "malloc_conf")] +pub static malloc_conf: &[u8] = b"prof:true,prof_active:true,lg_prof_sample:19,dirty_decay_ms:1000,muzzy_decay_ms:1000,retain:false\0"; + +#[cfg(not(feature = "jemalloc-prof"))] +#[allow(non_upper_case_globals)] +#[unsafe(export_name = "malloc_conf")] +pub static malloc_conf: &[u8] = b"dirty_decay_ms:1000,muzzy_decay_ms:1000,retain:false\0"; + +rust_i18n::i18n!("locales", fallback = "en"); + +#[tokio::main(flavor = "current_thread")] +async fn main() -> std::process::ExitCode { + core::main().await +} diff --git a/vendor/easytier/easytier/src/gateway/fast_socks5/LICENSE b/vendor/easytier/easytier/src/gateway/fast_socks5/LICENSE new file mode 100644 index 0000000..943eda1 --- /dev/null +++ b/vendor/easytier/easytier/src/gateway/fast_socks5/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Jonathan Dizdarevic + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/vendor/easytier/easytier/src/gateway/fast_socks5/README.md b/vendor/easytier/easytier/src/gateway/fast_socks5/README.md new file mode 100644 index 0000000..2f4f517 --- /dev/null +++ b/vendor/easytier/easytier/src/gateway/fast_socks5/README.md @@ -0,0 +1 @@ +Code is modified from https://github.com/dizda/fast-socks5 diff --git a/vendor/easytier/easytier/src/gateway/hedge.rs b/vendor/easytier/easytier/src/gateway/hedge.rs new file mode 100644 index 0000000..52e9622 --- /dev/null +++ b/vendor/easytier/easytier/src/gateway/hedge.rs @@ -0,0 +1,95 @@ +use std::{ + fmt::{self, Display}, + future::Future, + time::Duration, +}; + +use futures::{StreamExt, stream::FuturesUnordered}; +use tokio::time::sleep; + +#[derive(Debug)] +pub(super) struct ErrorCollection { + errors: Vec, +} + +impl ErrorCollection { + fn new() -> Self { + Self { errors: Vec::new() } + } + + fn push(&mut self, error: E) { + self.errors.push(error); + } +} + +impl Display for ErrorCollection { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + if self.errors.is_empty() { + return write!(f, "No errors"); + } + + write!(f, "{} error(s) occurred:", self.errors.len())?; + for (i, err) in self.errors.iter().enumerate() { + writeln!(f)?; + write!(f, " {}. {}", i + 1, err)?; + } + + Ok(()) + } +} + +impl std::error::Error for ErrorCollection {} + +pub(super) trait HedgeExt: Iterator + Sized { + async fn hedge(self, delay: Duration) -> Result> + where + Self::Item: Future>; +} + +impl HedgeExt for I +where + I: Iterator, +{ + async fn hedge(mut self, delay: Duration) -> Result> + where + Self::Item: Future>, + { + let mut tasks = FuturesUnordered::new(); + let mut errors = ErrorCollection::new(); + let mut exhausted = false; + + macro_rules! spawn { + () => { + if let Some(fut) = self.next() { + tasks.push(fut); + } else { + exhausted = true; + } + }; + } + + spawn!(); + + while !tasks.is_empty() { + tokio::select! { + res = tasks.next() => { + match res { + Some(Ok(v)) => return Ok(v), + Some(Err(e)) => errors.push(e), + None => unreachable!(), + } + + if !exhausted { + spawn!(); + } + } + + _ = sleep(delay), if !exhausted => { + spawn!(); + } + } + } + + Err(errors) + } +} diff --git a/vendor/easytier/easytier/src/gateway/icmp_proxy.rs b/vendor/easytier/easytier/src/gateway/icmp_proxy.rs new file mode 100644 index 0000000..4cc8f01 --- /dev/null +++ b/vendor/easytier/easytier/src/gateway/icmp_proxy.rs @@ -0,0 +1,91 @@ +use std::{ + mem::MaybeUninit, + net::{IpAddr, Ipv4Addr, SocketAddrV4}, + sync::Arc, +}; + +use easytier_core::{ + gateway::proxy::icmp_host::{IcmpProxyHost, IcmpProxySocket, ProxyRuntimeError}, + socket::SocketContext, +}; +use socket2::Socket; + +use crate::common::netns::NetNS; + +#[derive(Debug, Default)] +pub(crate) struct RuntimeIcmpProxyHost; + +impl RuntimeIcmpProxyHost { + fn create_raw_socket(context: &SocketContext) -> Result { + let _guard = NetNS::from_socket_context(context).guard(); + let socket = Socket::new( + socket2::Domain::IPV4, + socket2::Type::RAW, + Some(socket2::Protocol::ICMPV4), + )?; + socket.bind(&socket2::SockAddr::from(SocketAddrV4::new( + Ipv4Addr::UNSPECIFIED, + 0, + )))?; + Ok(socket) + } +} + +#[derive(Debug)] +struct RuntimeIcmpSocket { + socket: Arc, +} + +#[async_trait::async_trait] +impl IcmpProxySocket for RuntimeIcmpSocket { + async fn send(&self, destination: Ipv4Addr, packet: &[u8]) -> Result<(), ProxyRuntimeError> { + self.socket + .send_to(packet, &SocketAddrV4::new(destination, 0).into())?; + Ok(()) + } + + async fn recv(&self) -> Result<(IpAddr, Vec), ProxyRuntimeError> { + let socket = self.socket.clone(); + tokio::task::spawn_blocking(move || { + let mut buffer = vec![0_u8; 8192]; + let uninitialized: &mut [MaybeUninit] = + unsafe { std::mem::transmute(&mut buffer[..]) }; + let (length, peer_ip) = socket_recv(&socket, uninitialized)?; + buffer.truncate(length); + Ok((peer_ip, buffer)) + }) + .await + .map_err(|error| ProxyRuntimeError::Other(error.into()))? + } + + fn close(&self) { + let _ = self.socket.shutdown(std::net::Shutdown::Both); + } +} + +#[async_trait::async_trait] +impl IcmpProxyHost for RuntimeIcmpProxyHost { + async fn open_icmp_v4( + &self, + context: SocketContext, + ) -> Result, ProxyRuntimeError> { + let socket = Self::create_raw_socket(&context).inspect_err(|error| { + tracing::warn!(?error, "create ICMP socket failed"); + })?; + Ok(Arc::new(RuntimeIcmpSocket { + socket: Arc::new(socket), + })) + } +} + +fn socket_recv( + socket: &Socket, + buffer: &mut [MaybeUninit], +) -> Result<(usize, IpAddr), std::io::Error> { + let (size, address) = socket.recv_from(buffer)?; + let peer_ip = address + .as_socket() + .map(|address| address.ip()) + .unwrap_or(IpAddr::V4(Ipv4Addr::UNSPECIFIED)); + Ok((size, peer_ip)) +} diff --git a/vendor/easytier/easytier/src/gateway/kcp_proxy.rs b/vendor/easytier/easytier/src/gateway/kcp_proxy.rs new file mode 100644 index 0000000..e54e777 --- /dev/null +++ b/vendor/easytier/easytier/src/gateway/kcp_proxy.rs @@ -0,0 +1,368 @@ +use std::{net::SocketAddr, sync::Arc, time::Duration}; + +use anyhow::{Context, anyhow}; +use bytes::Bytes; +use kcp_sys::{ + endpoint::{KcpEndpoint, KcpPacketReceiver}, + ffi_safe::KcpConfig, + packet_def::KcpPacket, + stream::KcpStream, +}; +use prost::Message; +use tokio::{ + sync::Mutex, + task::{JoinHandle, JoinSet}, +}; +use tokio_util::sync::CancellationToken; + +use easytier_core::{ + gateway::proxy::traits::TcpProxyStream, + gateway::proxy::wrapped_transport::{ + WrappedTransportAcceptedStream, WrappedTransportConnect, WrappedTransportDatagram, + WrappedTransportDatagramBuffer, WrappedTransportDestinationIngress, WrappedTransportEngine, + WrappedTransportEngineStart, WrappedTransportKind, WrappedTransportRole, + }, +}; + +use super::hedge::HedgeExt; +use crate::proto::peer_rpc::KcpConnData; + +fn create_kcp_endpoint() -> KcpEndpoint { + let mut kcp_endpoint = KcpEndpoint::new(); + kcp_endpoint.set_kcp_config_factory(Box::new(|conv| { + let mut cfg = KcpConfig::new_turbo(conv); + cfg.interval = Some(5); + cfg + })); + kcp_endpoint +} + +#[tracing::instrument] +async fn handle_kcp_output( + mut output_receiver: KcpPacketReceiver, + role: WrappedTransportRole, + datagrams: tokio::sync::mpsc::Sender, +) { + while let Some(packet) = output_receiver.recv().await { + let peer_id = match role { + WrappedTransportRole::Source => packet.header().dst_session_id(), + WrappedTransportRole::Destination => packet.header().src_session_id(), + }; + if datagrams + .send(WrappedTransportDatagram { + transport: WrappedTransportKind::Kcp, + role, + peer_id, + buffer: WrappedTransportDatagramBuffer::copy_from_payload(&packet.inner().freeze()), + }) + .await + .is_err() + { + break; + } + } +} + +async fn connect_kcp_source( + kcp_endpoint: Arc, + my_peer_id: u32, + dst_peer_id: u32, + src: SocketAddr, + dst: SocketAddr, +) -> anyhow::Result { + let conn_data = KcpConnData { + src: Some(src.into()), + dst: Some(dst.into()), + }; + + (0..5) + .map(|_| { + let kcp_endpoint = kcp_endpoint.clone(); + async move { + let conn_id = kcp_endpoint + .connect( + Duration::from_secs(10), + my_peer_id, + dst_peer_id, + Bytes::from(conn_data.encode_to_vec()), + ) + .await?; + + KcpStream::new(&kcp_endpoint, conn_id).context("failed to create kcp stream") + } + }) + .hedge(Duration::from_millis(200)) + .await + .context("failed to connect to peer") +} + +pub struct KcpProxySrc { + kcp_endpoint: Arc, + tasks: JoinSet<()>, +} + +impl KcpProxySrc { + pub async fn new(datagrams: tokio::sync::mpsc::Sender) -> Self { + let mut kcp_endpoint = create_kcp_endpoint(); + kcp_endpoint.run().await; + + let output_receiver = kcp_endpoint.output_receiver().unwrap(); + let mut tasks = JoinSet::new(); + + tasks.spawn(handle_kcp_output( + output_receiver, + WrappedTransportRole::Source, + datagrams, + )); + + let kcp_endpoint = Arc::new(kcp_endpoint); + + Self { + kcp_endpoint, + tasks, + } + } + + pub fn get_kcp_endpoint(&self) -> Arc { + self.kcp_endpoint.clone() + } + + async fn stop(&mut self) { + self.tasks.shutdown().await; + } +} + +pub struct KcpProxyDst { + kcp_endpoint: Arc, + destination_ingress: WrappedTransportDestinationIngress, + tasks: JoinSet<()>, + accept_cancel: CancellationToken, + accept_task: Option>, +} + +impl KcpProxyDst { + pub async fn new( + destination_ingress: WrappedTransportDestinationIngress, + datagrams: tokio::sync::mpsc::Sender, + ) -> Self { + let mut kcp_endpoint = create_kcp_endpoint(); + kcp_endpoint.run().await; + + let mut tasks = JoinSet::new(); + let output_receiver = kcp_endpoint.output_receiver().unwrap(); + tasks.spawn(handle_kcp_output( + output_receiver, + WrappedTransportRole::Destination, + datagrams, + )); + Self { + kcp_endpoint: Arc::new(kcp_endpoint), + destination_ingress, + tasks, + accept_cancel: CancellationToken::new(), + accept_task: None, + } + } + + #[tracing::instrument(ret, skip(destination_ingress))] + async fn handle_one_in_stream( + kcp_stream: KcpStream, + destination_ingress: WrappedTransportDestinationIngress, + ) -> anyhow::Result<()> { + let mut conn_data = kcp_stream.conn_data().clone(); + let parsed_conn_data = KcpConnData::decode(&mut conn_data) + .with_context(|| format!("failed to decode kcp conn data: {:?}", conn_data))?; + let dst_socket: SocketAddr = parsed_conn_data + .dst + .ok_or(anyhow::anyhow!( + "failed to get dst socket from kcp conn data: {:?}", + parsed_conn_data + ))? + .into(); + let src_socket: SocketAddr = parsed_conn_data.src.unwrap_or_default().into(); + + destination_ingress + .submit(WrappedTransportAcceptedStream { + src: src_socket, + dst: dst_socket, + initial_acl_packet_size: conn_data.len(), + stream: Box::new(kcp_stream), + }) + .await + } + + async fn run_accept_task(&mut self) { + let kcp_endpoint = self.kcp_endpoint.clone(); + let destination_ingress = self.destination_ingress.clone(); + let cancel = self.accept_cancel.clone(); + self.accept_task = Some(tokio::spawn(async move { + let mut streams = JoinSet::new(); + loop { + tokio::select! { + biased; + _ = cancel.cancelled() => { + streams.shutdown().await; + break; + } + accepted = kcp_endpoint.accept() => { + let Ok(conn) = accepted else { + streams.shutdown().await; + break; + }; + let Some(stream) = KcpStream::new(&kcp_endpoint, conn) else { + tracing::warn!("failed to create accepted kcp stream"); + continue; + }; + + let destination_ingress = destination_ingress.clone(); + streams.spawn(async move { + let _ = Self::handle_one_in_stream(stream, destination_ingress).await; + }); + } + _ = streams.join_next(), if !streams.is_empty() => {} + } + } + })); + } + + pub async fn start(&mut self) { + self.run_accept_task().await; + } + + async fn stop(&mut self) { + self.accept_cancel.cancel(); + if let Some(task) = self.accept_task.as_mut() { + let _ = task.await; + } + self.accept_task.take(); + self.tasks.shutdown().await; + } +} + +#[derive(Default)] +struct KcpProxyServiceState { + src: Option, + dst: Option, +} + +impl KcpProxyServiceState { + async fn stop(&mut self) { + if let Some(dst) = &mut self.dst { + dst.stop().await; + } + if let Some(src) = &mut self.src { + src.stop().await; + } + } +} + +pub struct KcpProxyService { + state: Mutex>, +} + +impl KcpProxyService { + pub fn new() -> Self { + Self { + state: Mutex::new(None), + } + } +} + +#[async_trait::async_trait] +impl WrappedTransportEngine for KcpProxyService { + async fn prepare(&self, options: WrappedTransportEngineStart) -> anyhow::Result<()> { + let mut state = self.state.lock().await; + if state.is_some() { + return Ok(()); + } + let directions = options.directions; + + let src = if directions.source { + let src = KcpProxySrc::new(options.datagrams.clone()).await; + Some(src) + } else { + None + }; + let dst = if directions.destination { + let destination_ingress = options + .destination_ingress + .ok_or_else(|| anyhow!("KCP destination ingress is required"))?; + let dst = KcpProxyDst::new(destination_ingress, options.datagrams).await; + Some(dst) + } else { + None + }; + + *state = Some(KcpProxyServiceState { src, dst }); + Ok(()) + } + + async fn activate(&self) -> anyhow::Result<()> { + let mut state = self.state.lock().await; + let state = state + .as_mut() + .ok_or_else(|| anyhow!("KCP engine is not prepared"))?; + if let Some(dst) = state.dst.as_mut() { + dst.start().await; + } + Ok(()) + } + + async fn inject_peer_datagram( + &self, + role: WrappedTransportRole, + _from_peer_id: u32, + payload: Bytes, + ) -> anyhow::Result<()> { + let endpoint = { + let state = self.state.lock().await; + match (state.as_ref(), role) { + (Some(state), WrappedTransportRole::Source) => { + state.src.as_ref().map(KcpProxySrc::get_kcp_endpoint) + } + (Some(state), WrappedTransportRole::Destination) => { + state.dst.as_ref().map(|dst| dst.kcp_endpoint.clone()) + } + (None, _) => None, + } + } + .ok_or_else(|| anyhow!("KCP {role:?} endpoint is not active"))?; + + endpoint + .input_sender_ref() + .send(KcpPacket::from(bytes::BytesMut::from(payload))) + .await + .map_err(|error| anyhow!("failed to inject KCP datagram: {error}")) + } + + async fn connect_source( + &self, + request: WrappedTransportConnect, + ) -> anyhow::Result> { + let endpoint = { + let state = self.state.lock().await; + state + .as_ref() + .and_then(|state| state.src.as_ref()) + .map(KcpProxySrc::get_kcp_endpoint) + } + .ok_or_else(|| anyhow!("KCP source endpoint is not prepared"))?; + let stream = connect_kcp_source( + endpoint, + request.my_peer_id, + request.dst_peer_id, + request.src, + request.dst, + ) + .await?; + Ok(Box::new(stream)) + } + + async fn stop(&self) { + let mut state = self.state.lock().await; + if let Some(active) = state.as_mut() { + active.stop().await; + } + state.take(); + } +} diff --git a/vendor/easytier/easytier/src/gateway/mod.rs b/vendor/easytier/easytier/src/gateway/mod.rs new file mode 100644 index 0000000..c0e3e36 --- /dev/null +++ b/vendor/easytier/easytier/src/gateway/mod.rs @@ -0,0 +1,11 @@ +#[cfg(any(feature = "kcp", feature = "quic"))] +mod hedge; + +#[cfg(feature = "icmp-proxy")] +pub mod icmp_proxy; + +#[cfg(feature = "kcp")] +pub mod kcp_proxy; + +#[cfg(feature = "quic")] +pub mod quic_proxy; diff --git a/vendor/easytier/easytier/src/gateway/quic_proxy.rs b/vendor/easytier/easytier/src/gateway/quic_proxy.rs new file mode 100644 index 0000000..bd44f37 --- /dev/null +++ b/vendor/easytier/easytier/src/gateway/quic_proxy.rs @@ -0,0 +1,1492 @@ +use super::hedge::{ErrorCollection, HedgeExt}; +use crate::proto::peer_rpc::KcpConnData as QuicConnData; +use crate::tunnel::quic::{ + QUIC_VERSION_ETQ1, client_config, endpoint_config, etq1_client_config, server_config, +}; +use crate::utils::buf::{BufMargins, BufPool}; +use anyhow::{Context, Error, anyhow, ensure}; +use atomic_refcell::AtomicRefCell; +use bytes::{BufMut, Bytes, BytesMut}; +use derive_more::{Constructor, Deref, DerefMut, From, Into}; +use easytier_core::config::PeerId; +use easytier_core::packet::{PacketType, TAIL_RESERVED_SIZE, ZCPacket, ZCPacketType}; +use moka::future::Cache; +use prost::Message; +use quinn::udp::{EcnCodepoint, RecvMeta, Transmit}; +use quinn::{ + AsyncUdpSocket, Connection, ConnectionError, Endpoint, RecvStream, SendStream, UdpPoller, + WriteError, default_runtime, +}; +use std::cmp::min; +use std::future::Future; +use std::io::IoSliceMut; +use std::net::{IpAddr, Ipv4Addr, SocketAddr}; +use std::pin::Pin; +use std::sync::Arc; +use std::task::Poll; +use std::time::Duration; +use tokio::io::{AsyncReadExt, Join, join}; +use tokio::select; +use tokio::sync::Mutex; +use tokio::sync::mpsc::error::TrySendError; +use tokio::sync::mpsc::{Receiver, Sender, channel}; +use tokio::task::{JoinHandle, JoinSet}; +use tokio::time::timeout; +use tokio_util::sync::{CancellationToken, PollSender}; +use tracing::{debug, error, info, instrument, trace, warn}; + +use easytier_core::{ + foundation::expiring_set::ExpiringSet, + gateway::proxy::traits::TcpProxyStream, + gateway::proxy::wrapped_transport::{ + WrappedTransportAcceptedStream, WrappedTransportConnect, WrappedTransportDatagram, + WrappedTransportDatagramBuffer, WrappedTransportDestinationIngress, WrappedTransportEngine, + WrappedTransportEngineStart, WrappedTransportKind, WrappedTransportRole, + }, +}; + +//region packet +#[derive(Debug, Constructor)] +struct QuicPacket { + addr: SocketAddr, + payload: BytesMut, + segment: Option, + ecn: Option, +} + +type PacketMargins = BufMargins; +//endregion + +//region socket +#[derive(Debug)] +struct QuicSocketPoller { + tx: PollSender, +} + +impl UdpPoller for QuicSocketPoller { + fn poll_writable( + self: Pin<&mut Self>, + cx: &mut std::task::Context, + ) -> Poll> { + let tx = &mut self.get_mut().tx; + + let poll = tx.poll_reserve(cx); + if let Poll::Ready(Ok(_)) = poll { + tx.abort_send(); + } + + poll.map_err(|e| std::io::Error::new(std::io::ErrorKind::BrokenPipe, e)) + } +} + +#[derive(Debug)] +pub struct QuicSocket { + addr: SocketAddr, + rx: AtomicRefCell>, + tx: Sender, + margins: PacketMargins, +} + +impl AsyncUdpSocket for QuicSocket { + fn create_io_poller(self: Arc) -> Pin> { + Box::into_pin(Box::new(QuicSocketPoller { + tx: PollSender::new(self.tx.clone()), + })) + } + + fn try_send(&self, transmit: &Transmit) -> std::io::Result<()> { + match transmit.destination { + SocketAddr::V4(addr) => { + let len = transmit.contents.len(); + trace!("{:?} sending {:?} bytes to {:?}", self.addr, len, addr); + + let permit = self.tx.try_reserve().map_err(|e| match e { + TrySendError::Full(_) => std::io::ErrorKind::WouldBlock, + TrySendError::Closed(_) => std::io::ErrorKind::BrokenPipe, + })?; + + let segment_size = transmit.segment_size.unwrap_or(len); + let chunks = transmit.contents.chunks(segment_size); + let segment = segment_size + self.margins.size(); + + // The length of the last chunk could be smaller than segment_size + let mut payload = BufPool::new(chunks.len() * segment); + for chunk in chunks { + payload.write(chunk, self.margins); + } + + permit.send(QuicPacket { + addr: transmit.destination, + payload: payload.split(), + segment: Some(segment), + ecn: transmit.ecn, + }); + + Ok(()) + } + _ => Err(std::io::ErrorKind::ConnectionRefused.into()), + } + } + + fn poll_recv( + &self, + cx: &mut std::task::Context, + bufs: &mut [IoSliceMut<'_>], + meta: &mut [RecvMeta], + ) -> Poll> { + if bufs.is_empty() || meta.is_empty() { + return Poll::Ready(Ok(0)); + } + + let mut rx = self.rx.borrow_mut(); + let mut count = 0; + + for (buf, meta) in bufs.iter_mut().zip(meta.iter_mut()) { + match rx.poll_recv(cx) { + Poll::Ready(Some(packet)) => { + let len = packet.payload.len(); + if len > buf.len() { + warn!( + "buffer too small for packet: {:?} < {:?}, dropped", + buf.len(), + len, + ); + continue; + } + trace!( + "{:?} received {:?} bytes from {:?}", + self.addr, len, packet.addr + ); + buf[0..len].copy_from_slice(&packet.payload); + *meta = RecvMeta { + addr: packet.addr, + len, + stride: len, + ecn: packet.ecn, + dst_ip: None, + }; + count += 1; + } + Poll::Ready(None) if count > 0 => break, + Poll::Ready(None) => { + return Poll::Ready(Err(std::io::Error::new( + std::io::ErrorKind::ConnectionAborted, + "socket closed", + ))); + } + Poll::Pending => break, + } + } + + if count > 0 { + Poll::Ready(Ok(count)) + } else { + Poll::Pending + } + } + + fn local_addr(&self) -> std::io::Result { + Ok(self.addr) + } +} +//endregion + +//region addr +#[derive(Debug, Clone, Copy, Constructor)] +struct QuicAddr { + peer_id: PeerId, + packet_type: PacketType, +} + +impl From for SocketAddr { + #[inline] + fn from(value: QuicAddr) -> Self { + SocketAddr::new(IpAddr::V4(value.peer_id.into()), value.packet_type as u16) + } +} + +impl TryFrom for QuicAddr { + type Error = (); + + #[inline] + fn try_from(value: SocketAddr) -> Result { + let IpAddr::V4(ipv4) = value.ip() else { + return Err(()); + }; + let peer_id = ipv4.into(); + + let packet_type = match value.port() { + p if p == PacketType::QuicSrc as u16 => PacketType::QuicSrc, + p if p == PacketType::QuicDst as u16 => PacketType::QuicDst, + _ => return Err(()), + }; + + Ok(Self { + peer_id, + packet_type, + }) + } +} +//endregion + +//region stream +type QuicStreamInner = Join; +#[derive(Debug, Deref, DerefMut, From, Into)] +struct QuicStream { + #[deref] + #[deref_mut] + inner: QuicStreamInner, +} + +impl From<(SendStream, RecvStream)> for QuicStream { + #[inline] + fn from(value: (SendStream, RecvStream)) -> Self { + join(value.1, value.0).into() + } +} +//endregion + +/// How long to keep dialing a peer with legacy QUIC version 1 after it +/// rejected `QUIC_VERSION_ETQ1`, before probing ETQ1 again. Bounds the set +/// and lets peers that upgrade mid-flight pick up the fix. +const LEGACY_VERSION_TTL: Duration = Duration::from_secs(3600); + +#[derive(Debug, Clone)] +pub struct NatDstQuicConnector { + pub(crate) endpoint: Endpoint, + pub(crate) conn_map: Cache, + /// Peers that recently rejected `QUIC_VERSION_ETQ1` via version + /// negotiation and are dialed with legacy version 1 until the entry + /// expires. + pub(crate) legacy_version_peers: Arc>, +} + +impl NatDstQuicConnector { + fn connect_hedge( + &self, + dst_peer: PeerId, + version: u32, + ) -> impl Future>> + '_ { + let endpoint = self.endpoint.clone(); + let legacy_version_peers = self.legacy_version_peers.clone(); + (0..5) + .map(move |_| { + let endpoint = endpoint.clone(); + let legacy_version_peers = legacy_version_peers.clone(); + async move { + let config = if version == QUIC_VERSION_ETQ1 { + etq1_client_config() + } else { + client_config() + }; + let ret = endpoint + .connect_with( + config, + QuicAddr::new(dst_peer, PacketType::QuicSrc).into(), + "", + ) + .context("failed to create connection")? + .await + .context("connection failed"); + if let Some(ConnectionError::VersionMismatch) = + ret.as_ref().err().and_then(|e| e.downcast_ref()) + { + // Remote only supports legacy version 1; remember it + // so later connects skip the rejected version for a + // while. + legacy_version_peers.insert(dst_peer, LEGACY_VERSION_TTL); + } + ret + } + }) + .hedge(Duration::from_millis(200)) + } + + async fn connect(&self, dst_peer: PeerId) -> anyhow::Result { + self.conn_map.invalidate(&dst_peer).await; + self.legacy_version_peers.cleanup(); + + if !self.legacy_version_peers.contains(&dst_peer) { + let result = self + .conn_map + .try_get_with(dst_peer, self.connect_hedge(dst_peer, QUIC_VERSION_ETQ1)) + .await; + match result { + Ok(conn) => return Ok(conn), + Err(_) if self.legacy_version_peers.contains(&dst_peer) => { + debug!( + ?dst_peer, + "remote rejected ETQ1, falling back to quic version 1" + ); + } + Err(errors) => return Err(anyhow!("failed to connect to peer: {errors}")), + } + } + + self.conn_map + .try_get_with(dst_peer, self.connect_hedge(dst_peer, 1)) + .await + .map_err(|errors| anyhow!("failed to connect to peer: {errors}")) + } + + async fn connect_to_peer( + &self, + dst_peer: PeerId, + src: SocketAddr, + nat_dst: SocketAddr, + ) -> anyhow::Result { + tracing::trace!(?nat_dst, ?dst_peer, "quic nat"); + + let header = { + let conn_data = QuicConnData { + src: Some(src.into()), + dst: Some(nat_dst.into()), + }; + + let len = conn_data.encoded_len(); + ensure!(len <= u16::MAX as usize, "conn data too large: {len}"); + + let mut buf = BytesMut::with_capacity(2 + len); + + buf.put_u16(len as u16); + conn_data.encode(&mut buf)?; + + buf.freeze() + }; + + let reconnect = || async move { self.connect(dst_peer).await }; + + let mut reconnected = false; + + let mut connection = if let Some(connection) = self.conn_map.get(&dst_peer).await + && connection.close_reason().is_none() + { + connection + } else { + reconnected = true; + reconnect().await? + }; + + loop { + let is_retryable = |error: &ConnectionError| { + matches!( + error, + ConnectionError::ConnectionClosed(_) + | ConnectionError::ApplicationClosed(_) + | ConnectionError::Reset + | ConnectionError::TimedOut + ) + }; + let mut retry = !reconnected; + let header = header.clone(); + let result = async { + let mut stream: QuicStream = connection + .open_bi() + .await + .inspect_err(|error| retry &= is_retryable(error))? + .into(); + stream + .writer_mut() + .write_chunk(header) + .await + .inspect_err(|error| { + retry &= matches!(error, WriteError::ConnectionLost(error) if is_retryable(error)) + })?; + Ok(stream.into()) + } + .await; + + if let Err(error) = &result { + if retry { + debug!(?error, "failed to open quic stream, retrying..."); + reconnected = true; + connection = reconnect().await?; + continue; + } else { + self.conn_map.invalidate(&dst_peer).await; + } + } + + break result; + } + } +} + +#[derive(Debug)] +enum QuicProxyRole { + Src, + Dst, +} + +impl QuicProxyRole { + #[inline] + const fn outgoing(&self) -> PacketType { + match self { + QuicProxyRole::Src => PacketType::QuicSrc, + QuicProxyRole::Dst => PacketType::QuicDst, + } + } +} + +// Send to peers packets received from the QUIC endpoint +#[derive(Debug)] +struct QuicPacketSender { + datagrams: Sender, + rx: Receiver, + + header: Bytes, + zc_packet_type: ZCPacketType, + margins: PacketMargins, +} + +impl QuicPacketSender { + #[instrument] + pub async fn run(mut self) { + while let Some(packet) = self.rx.recv().await { + let Ok(addr) = QuicAddr::try_from(packet.addr) else { + error!("invalid quic packet addr: {:?}", packet.addr); + continue; + }; + + let mut payload = packet.payload; + let segment = packet + .segment + .expect("segment size must be set for outgoing quic packet"); + + while !payload.is_empty() { + let len = min(payload.len(), segment); + let mut payload = payload.split_to(len); + payload[..self.margins.header].copy_from_slice(&self.header); + payload.truncate(len - self.margins.trailer); + let role = match addr.packet_type { + PacketType::QuicSrc => WrappedTransportRole::Source, + PacketType::QuicDst => WrappedTransportRole::Destination, + packet_type => { + error!(?packet_type, "invalid QUIC proxy output packet type"); + continue; + } + }; + if self + .datagrams + .send(WrappedTransportDatagram { + transport: WrappedTransportKind::Quic, + role, + peer_id: addr.peer_id, + buffer: WrappedTransportDatagramBuffer::from_packet_buffer( + payload, + self.zc_packet_type, + ), + }) + .await + .is_err() + { + break; + } + } + } + } +} + +struct QuicStreamReceiver { + endpoint: Endpoint, + tasks: JoinSet<()>, + destination_ingress: WrappedTransportDestinationIngress, + cancel: CancellationToken, +} + +impl QuicStreamReceiver { + async fn run(mut self) { + loop { + select! { + biased; + + _ = self.cancel.cancelled() => break, + + Some(incoming) = self.endpoint.accept() => { + let addr = incoming.remote_address(); + let connection = match incoming.accept() { + Ok(connection) => connection, + Err(e) => { + error!("failed to accept quic connection from {:?}: {:?}", addr, e); + continue; + } + }; + + let addr = connection.remote_address(); + let connection = select! { + biased; + _ = self.cancel.cancelled() => break, + result = connection => { + match result { + Ok(connection) => connection, + Err(e) => { + error!("failed to accept quic connection from {:?}: {:?}", addr, e); + continue; + } + } + } + }; + + let destination_ingress = self.destination_ingress.clone(); + let cancel = self.cancel.clone(); + self.tasks.spawn(async move { + let mut tasks = JoinSet::new(); + loop { + select! { + biased; + + _ = cancel.cancelled() => break, + + e = connection.closed() => { + info!("connection to {:?} closed: {:?}", addr, e); + break; + } + + stream = connection.accept_bi() => { + let stream = match stream { + Ok(stream) => stream.into(), + Err(e) => { + warn!("failed to accept bi stream from {:?}: {:?}", connection.remote_address(), e); + break; + } + }; + + let destination_ingress = destination_ingress.clone(); + tasks.spawn(async move { + if let Err(e) = Self::submit_stream(stream, destination_ingress).await { + warn!("failed to submit quic stream: {:?}", e); + } + }); + } + + res = tasks.join_next(), if !tasks.is_empty() => { + debug!("quic stream task completed for {:?}: {:?}", addr, res); + } + } + } + + tasks.shutdown().await; + connection.close(1u32.into(), b"error"); + }); + } + + _ = self.tasks.join_next(), if !self.tasks.is_empty() => {} + + else => { + info!("quic stream receiver endpoint closed, exiting"); + break; + } + } + } + if self.cancel.is_cancelled() { + while self.tasks.join_next().await.is_some() {} + } else { + self.tasks.shutdown().await; + } + } + + async fn read_stream_header(stream: &mut QuicStream) -> Result { + const STREAM_HEADER_READ_TIMEOUT: Duration = Duration::from_secs(5); + const STREAM_HEADER_LIMIT: u16 = 512; + let len = timeout(STREAM_HEADER_READ_TIMEOUT, stream.read_u16()) + .await + .context("timeout reading header length")??; + if len > STREAM_HEADER_LIMIT { + return Err(anyhow::anyhow!("stream header too long")); + } + let mut header = Vec::with_capacity(len as usize); + timeout( + STREAM_HEADER_READ_TIMEOUT, + stream + .reader_mut() + .take(len as u64) + .read_to_end(&mut header), + ) + .await + .context("timeout reading header")??; + Ok(header.into()) + } + + async fn submit_stream( + mut stream: QuicStream, + destination_ingress: WrappedTransportDestinationIngress, + ) -> Result<(), Error> { + let conn_data = Self::read_stream_header(&mut stream).await?; + let conn_data_parsed = QuicConnData::decode(conn_data.as_ref()) + .context("failed to decode quic stream header")?; + + let src_socket: SocketAddr = conn_data_parsed + .src + .ok_or_else(|| anyhow!("missing src addr in quic stream header"))? + .into(); + let dst_socket: SocketAddr = conn_data_parsed + .dst + .ok_or_else(|| anyhow!("missing dst addr in quic stream header"))? + .into(); + + destination_ingress + .submit(WrappedTransportAcceptedStream { + src: src_socket, + dst: dst_socket, + initial_acl_packet_size: conn_data.len(), + stream: Box::new(stream.inner), + }) + .await + } +} + +pub struct QuicProxy { + endpoint: Option, + input_tx: Option>>, + + source_connector: Option, + destination_ingress: Option, + + tasks: JoinSet<()>, + stream_cancel: CancellationToken, + stream_task: Option>, +} + +impl QuicProxy { + pub fn new() -> Self { + Self { + endpoint: None, + input_tx: None, + source_connector: None, + destination_ingress: None, + tasks: JoinSet::new(), + stream_cancel: CancellationToken::new(), + stream_task: None, + } + } + + pub async fn prepare( + &mut self, + my_peer_id: u32, + src: bool, + destination_ingress: Option, + datagrams: Sender, + ) { + trace!("quic proxy starting"); + + if self.endpoint.is_some() { + error!("quic proxy already running"); + return; + } + + let (header, zc_packet_type) = { + let header = ZCPacket::new_with_payload(&[]); + let zc_packet_type = header.packet_type(); + let payload_offset = header.payload_offset(); + ( + header.inner().split_to(payload_offset).freeze(), + zc_packet_type, + ) + }; + + let margins = (header.len(), TAIL_RESERVED_SIZE).into(); + + let (in_tx, in_rx) = channel(1024); + let in_tx = Arc::new(in_tx); + self.input_tx = Some(in_tx.clone()); + let (out_tx, out_rx) = channel(1024); + + let socket = QuicSocket { + addr: SocketAddr::new(Ipv4Addr::from(my_peer_id).into(), 0), + rx: AtomicRefCell::new(in_rx), + tx: out_tx, + margins, + }; + + let mut endpoint = Endpoint::new_with_abstract_socket( + endpoint_config(), + Some(server_config()), + Arc::new(socket), + default_runtime().unwrap(), + ) + .unwrap(); // TODO: maybe a different transport config + // Default stays on legacy version 1; ETQ1 is negotiated per attempt in + // NatDstQuicConnector so that peers which only speak version 1 keep + // working. + endpoint.set_default_client_config(client_config()); + self.endpoint = Some(endpoint.clone()); + + self.tasks.spawn( + QuicPacketSender { + datagrams, + rx: out_rx, + header, + zc_packet_type, + margins, + } + .run(), + ); + + if src { + if self.source_connector.is_some() { + error!("quic proxy src already running"); + return; + } + + self.source_connector = Some(NatDstQuicConnector { + endpoint: endpoint.clone(), + conn_map: Cache::builder() + .max_capacity(u8::MAX.into()) // cf. quinn transport config (max_concurrent_bidi_streams) + .time_to_idle(Duration::from_secs(600)) // cf. quinn transport config (max_idle_timeout) + .build(), + legacy_version_peers: Arc::new(ExpiringSet::default()), + }); + } + + if let Some(destination_ingress) = destination_ingress { + if self.destination_ingress.is_some() { + error!("quic proxy dst already running"); + return; + } + self.destination_ingress = Some(destination_ingress); + } + } + + async fn activate(&mut self) -> anyhow::Result<()> { + if let Some(destination_ingress) = self.destination_ingress.as_ref() { + let endpoint = self + .endpoint + .as_ref() + .cloned() + .ok_or_else(|| anyhow!("QUIC endpoint is not prepared"))?; + self.stream_task = Some(tokio::spawn( + QuicStreamReceiver { + endpoint, + tasks: JoinSet::new(), + destination_ingress: destination_ingress.clone(), + cancel: self.stream_cancel.clone(), + } + .run(), + )); + } + Ok(()) + } + + async fn stop(&mut self) { + self.stream_cancel.cancel(); + if let Some(task) = self.stream_task.as_mut() { + let _ = task.await; + } + self.stream_task.take(); + self.tasks.shutdown().await; + if let Some(endpoint) = self.endpoint.take() { + endpoint.close(1u32.into(), b"stopped"); + } + } +} + +pub struct QuicProxyService { + state: Mutex>, +} + +impl QuicProxyService { + pub fn new() -> Self { + Self { + state: Mutex::new(None), + } + } +} + +#[async_trait::async_trait] +impl WrappedTransportEngine for QuicProxyService { + async fn prepare(&self, options: WrappedTransportEngineStart) -> anyhow::Result<()> { + let mut state = self.state.lock().await; + if state.is_some() { + return Ok(()); + } + let directions = options.directions; + let destination_ingress = if directions.destination { + Some( + options + .destination_ingress + .ok_or_else(|| anyhow!("QUIC destination ingress is required"))?, + ) + } else { + None + }; + + let mut proxy = QuicProxy::new(); + if directions.source || directions.destination { + proxy + .prepare( + options.my_peer_id, + directions.source, + destination_ingress, + options.datagrams, + ) + .await; + } + + *state = Some(proxy); + Ok(()) + } + + async fn activate(&self) -> anyhow::Result<()> { + let mut state = self.state.lock().await; + state + .as_mut() + .ok_or_else(|| anyhow!("QUIC engine is not prepared"))? + .activate() + .await + } + + async fn inject_peer_datagram( + &self, + role: WrappedTransportRole, + from_peer_id: u32, + payload: Bytes, + ) -> anyhow::Result<()> { + let tx = { + let state = self.state.lock().await; + state.as_ref().and_then(|proxy| proxy.input_tx.clone()) + } + .ok_or_else(|| anyhow!("QUIC endpoint is not active"))?; + let role = match role { + WrappedTransportRole::Source => QuicProxyRole::Src, + WrappedTransportRole::Destination => QuicProxyRole::Dst, + }; + tx.try_send(QuicPacket::new( + QuicAddr::new(from_peer_id, role.outgoing()).into(), + payload.into(), + None, + None, + )) + .map_err(|error| anyhow!("failed to inject QUIC datagram: {error}")) + } + + async fn connect_source( + &self, + request: WrappedTransportConnect, + ) -> anyhow::Result> { + let connector = { + let state = self.state.lock().await; + state + .as_ref() + .and_then(|proxy| proxy.source_connector.clone()) + } + .ok_or_else(|| anyhow!("QUIC source endpoint is not prepared"))?; + let stream = connector + .connect_to_peer(request.dst_peer_id, request.src, request.dst) + .await?; + Ok(Box::new(stream)) + } + + async fn stop(&self) { + let mut state = self.state.lock().await; + if let Some(active) = state.as_mut() { + active.stop().await; + } + state.take(); + } +} + +#[cfg(test)] +mod tests { + use super::*; + use bytes::Buf; + use quanta::Instant; + use quinn::EndpointConfig; + + use crate::tunnel::quic::{connect_with_etq1, endpoint_config_with_versions}; + + /// Helper function: Create a pair of interconnected QuicSockets. + /// Data sent by socket_a will enter socket_b's rx, and vice versa. + fn make_socket_pair() -> (QuicSocket, QuicSocket) { + let addr_a: SocketAddr = "127.0.0.1:5000".parse().unwrap(); + let addr_b: SocketAddr = "127.0.0.1:5001".parse().unwrap(); + + // Bidirectional channels: A->B and B->A + // Sufficient capacity to prevent packet loss during high concurrency + let (tx_a_out, rx_a_out) = channel::(50_000); + let (tx_b_in, rx_b_in) = channel::(50_000); + + let (tx_b_out, rx_b_out) = channel::(50_000); + let (tx_a_in, rx_a_in) = channel::(50_000); + + let margins = (20, 25).into(); + + forward(rx_a_out, tx_b_in, addr_a, margins); + forward(rx_b_out, tx_a_in, addr_b, margins); + + let socket_a = QuicSocket { + addr: addr_a, + rx: AtomicRefCell::new(rx_a_in), + tx: tx_a_out, + margins, + }; + + let socket_b = QuicSocket { + addr: addr_b, + rx: AtomicRefCell::new(rx_b_in), + tx: tx_b_out, + margins, + }; + + (socket_a, socket_b) + } + + fn endpoint() -> (Endpoint, Endpoint) { + let endpoint_config = endpoint_config(); + let server_config = server_config(); + let client_config = client_config(); + + // 1. Create an in-memory Socket pair + let (socket_client, socket_server) = make_socket_pair(); + let socket_client = Arc::new(socket_client); + let socket_server = Arc::new(socket_server); + + // 3. Configure Client Endpoint + let mut client_endpoint = Endpoint::new_with_abstract_socket( + endpoint_config.clone(), + Some(server_config.clone()), + socket_client.clone(), + default_runtime().unwrap(), + ) + .unwrap(); + client_endpoint.set_default_client_config(client_config.clone()); + + // 2. Configure Server Endpoint + let mut server_endpoint = Endpoint::new_with_abstract_socket( + endpoint_config.clone(), + Some(server_config.clone()), + socket_server.clone(), + default_runtime().unwrap(), + ) + .unwrap(); + server_endpoint.set_default_client_config(client_config.clone()); + + (client_endpoint, server_endpoint) + } + + fn forward( + mut rx: Receiver, + tx: Sender, + addr: SocketAddr, + margins: PacketMargins, + ) { + const BATCH_SIZE: usize = 128; + tokio::spawn(async move { + // Key optimization: use buffer for batch processing + let mut buffer = Vec::with_capacity(BATCH_SIZE); + + // recv_many wakes up when data is available, taking up to 100 packets at a time + // This reduces context switch overhead by 99 times compared to taking 1 packet at a time + while rx.recv_many(&mut buffer, BATCH_SIZE).await > 0 { + for packet in buffer.iter_mut() { + // [Filter Logic]: Modify address here + packet.addr = addr; + packet.payload.advance(margins.header); + packet + .payload + .truncate(packet.payload.len() - margins.trailer); + } + // Batch forward + for packet in buffer.drain(..) { + if let Err(e) = tx.send(packet).await { + info!("{:?}", e); + return; // Channel closed + } + } + } + }); + } + + #[tokio::test] + async fn test_ping() -> anyhow::Result<()> { + let (client_endpoint, server_endpoint) = endpoint(); + let server_addr = server_endpoint.local_addr()?; + + // 4. Server receive task + let server_handle = tokio::spawn(async move { + println!("Server: Waiting for connection..."); + if let Some(conn) = server_endpoint.accept().await { + let connection = conn.await.unwrap(); + println!( + "Server: Connection accepted from {}", + connection.remote_address() + ); + + // Accept bidirectional stream + let (mut send, mut recv) = connection.accept_bi().await.unwrap(); + + // Read data + let mut buf = vec![0u8; 10]; + recv.read_exact(&mut buf).await.unwrap(); + assert_eq!(&buf, b"ping______"); + println!("Server: Received 'ping______'"); + + // Send reply + send.write_all(b"pong______").await.unwrap(); + send.finish().unwrap(); + + let _ = connection.closed().await; + } + }); + + // 5. Client initiates connection + // Note: The connect address here must be V4, because try_send is limited to SocketAddr::V4 + println!("Client: Connecting..."); + let connection = client_endpoint.connect(server_addr, "localhost")?.await?; + println!("Client: Connected!"); + + // Open a stream and send data + let (mut send, mut recv) = connection.open_bi().await?; + send.write_all(b"ping______").await?; + send.finish()?; + + // Read reply + let mut buf = vec![0u8; 10]; + recv.read_exact(&mut buf).await?; + assert_eq!(&buf, b"pong______"); + println!("Client: Received 'pong______'"); + + // 6. Cleanup + connection.close(0u32.into(), b"done"); + // Wait for Server to finish + let _ = tokio::time::timeout(Duration::from_secs(2), server_handle).await; + + Ok(()) + } + + #[tokio::test] + #[ignore = "consumes massive memory (~16GB)"] + async fn test_bandwidth() -> anyhow::Result<()> { + // --- 3. Define test data volume --- + // Total test size: 512 MB + const TOTAL_SIZE: usize = 32768 * 1024 * 1024; + // Write chunk size: 1 MB (simulate large chunk write) + const CHUNK_SIZE: usize = 1024 * 1024; + + let (client_endpoint, server_endpoint) = endpoint(); + let server_addr = server_endpoint.local_addr()?; + + // --- 4. Server side (receive and timing) --- + let server_handle = tokio::spawn(async move { + if let Some(conn) = server_endpoint.accept().await { + let connection = conn.await.unwrap(); + // Accept unidirectional stream + let mut recv = connection.accept_uni().await.unwrap(); + + let start = Instant::now(); + let mut received = 0; + + // Loop read until the stream ends + // read_chunk performs slightly better than read_exact because it reduces internal buffer copying + while let Some(chunk) = recv.read_chunk(usize::MAX, true).await.unwrap() { + received += chunk.bytes.len(); + } + + let duration = start.elapsed(); + assert_eq!(received, TOTAL_SIZE, "Data length mismatch"); + + let seconds = duration.as_secs_f64(); + let mbps = (received as f64 * 8.0) / (1_000_000.0 * seconds); + let gbps = mbps / 1000.0; + + println!("--------------------------------------------------"); + println!("Server Recv Statistics:"); + println!(" Total Data: {} MB", received / 1024 / 1024); + println!(" Duration : {:.2?}", duration); + println!(" Throughput: {:.2} Gbps ({:.2} Mbps)", gbps, mbps); + println!("--------------------------------------------------"); + + // Keep connection until the Client disconnects + let _ = connection.closed().await; + } + }); + + // --- 5. Client side (send) --- + let connection = client_endpoint.connect(server_addr, "localhost")?.await?; + let mut send = connection.open_uni().await?; + + // Construct a 1MB data chunk + let data_chunk = vec![0u8; CHUNK_SIZE]; + let bytes_data = Bytes::from(data_chunk); // Use Bytes to avoid repeated allocation + + println!("Client: Start sending {} MB...", TOTAL_SIZE / 1024 / 1024); + let start_send = Instant::now(); + + let chunks = TOTAL_SIZE / CHUNK_SIZE; + for _ in 0..chunks { + // write_chunk is most efficient when used with Bytes + send.write_chunk(bytes_data.clone()).await?; + } + + // Tell peer sending is finished + send.finish()?; + // Wait for the stream to close completely (ensure peer received FIN) + send.stopped().await?; + + let send_duration = start_send.elapsed(); + println!("Client: Send finished in {:.2?}", send_duration); + + // Close connection + connection.close(0u32.into(), b"done"); + + // Wait for Server to print results + let _ = tokio::time::timeout(Duration::from_secs(5), server_handle).await; + + Ok(()) + } + + #[tokio::test] + #[ignore = "consumes massive memory (~16GB)"] + async fn test_bandwidth_parallel() -> anyhow::Result<()> { + // --- 1. Configuration parameters --- + const STREAM_COUNT: usize = 16; // Number of concurrent streams + const STREAM_SIZE: usize = 1024 * 1024 * 1024; // Each stream sends 1GB + + let (client_endpoint, server_endpoint) = endpoint(); + let server_addr = server_endpoint.local_addr()?; + + // --- 3. Server side (concurrent receiver) --- + let server_handle = tokio::spawn(async move { + if let Some(conn) = server_endpoint.accept().await { + let connection = conn.await.unwrap(); + println!("Server: Accepted connection"); + + let mut stream_handles = Vec::new(); + let start = Instant::now(); + + // Accept an expected number of streams + for i in 0..STREAM_COUNT { + match connection.accept_uni().await { + Ok(mut recv) => { + // Start an independent processing task for each stream + let handle = tokio::spawn(async move { + // Read all data + match recv.read_to_end(usize::MAX).await { + Ok(data) => { + // Verify length + assert_eq!( + data.len(), + STREAM_SIZE, + "Stream {} length mismatch", + i + ); + // Verify data content (verify data isolation) + // We agree that the first byte of data is (stream_index % 255) + // This ensures stream data is not mixed + let expected_byte = data[0] as usize; // Get the actual received marker + // Simple check of head and tail here, CRC can be used in production + if data[data.len() - 1] != data[0] { + panic!("Stream data corruption"); + } + expected_byte // Return marker for statistics + } + Err(e) => panic!("Stream read error: {}", e), + } + }); + stream_handles.push(handle); + } + Err(e) => panic!("Failed to accept stream {}: {}", i, e), + } + } + + // Wait for all streams to finish processing + let results = futures::future::join_all(stream_handles).await; + let duration = start.elapsed(); + + let speed = ((STREAM_COUNT * STREAM_SIZE) as f64 * 8.0) + / (duration.as_secs_f64() * 1_000_000.0); + + println!("--------------------------------------------------"); + println!("Server: All {} streams received processing.", results.len()); + println!("Total Time: {:.2?}", duration); + println!( + "Total Data: {} MB", + (STREAM_COUNT * STREAM_SIZE) / 1024 / 1024 + ); + println!( + "Average Speed: {:.2} Gbps ({:.2} Mbps)", + speed / 1024.0, + speed + ); + println!("--------------------------------------------------"); + + // Keep connection until the Client disconnects + let _ = connection.closed().await; + } + }); + + // --- 4. Client side (concurrent sender) --- + let connection = client_endpoint.connect(server_addr, "localhost")?.await?; + println!( + "Client: Connected, starting {} parallel streams...", + STREAM_COUNT + ); + + let start_send = Instant::now(); + let mut client_tasks = Vec::new(); + + // Start sending tasks concurrently + for i in 0..STREAM_COUNT { + let conn = connection.clone(); + client_tasks.push(tokio::spawn(async move { + // Open unidirectional stream + let mut send = conn.open_uni().await.expect("Failed to open stream"); + + // Construct data: use i as the padding marker to verify isolation + // All bytes are filled with (i % 255) + let fill_byte = (i % 255) as u8; + let data = vec![fill_byte; STREAM_SIZE]; + let bytes_data = Bytes::from(data); + + send.write_chunk(bytes_data).await.expect("Write failed"); + send.finish().expect("Finish failed"); + // Wait for Server to acknowledge receipt of FIN + send.stopped().await.expect("Stopped failed"); + })); + } + + // Wait for all sending tasks to complete + futures::future::join_all(client_tasks).await; + + let send_duration = start_send.elapsed(); + println!("Client: All streams sent in {:.2?}", send_duration); + + // Close connection + connection.close(0u32.into(), b"done"); + + // Wait for Server to finish + let _ = tokio::time::timeout(Duration::from_secs(10), server_handle).await; + + Ok(()) + } + + #[tokio::test] + async fn test_gso() { + let margins = PacketMargins { + header: 20, + trailer: 25, + }; + let (tx, rx) = channel(10); + + let socket = QuicSocket { + addr: "127.0.0.1:0".parse().unwrap(), + rx: AtomicRefCell::new(rx), + tx, + margins, + }; + + let total_len = 3000; + let segment_size = 1000; + let mut contents = Vec::with_capacity(total_len); + + contents.extend(vec![1u8; 1000]); + contents.extend(vec![2u8; 1000]); + contents.extend(vec![3u8; 1000]); + + let transmit = Transmit { + destination: "127.0.0.1:8000".parse().unwrap(), + ecn: None, + contents: &contents, + segment_size: Some(segment_size), + src_ip: None, + }; + + socket.try_send(&transmit).unwrap(); + + let mut rx = socket.rx.into_inner(); + let packet = rx.recv().await.unwrap(); + + let actual_segment_size = segment_size + margins.size(); + let payload = packet.payload; + + let chunk1_start = margins.header; + let chunk1_data = &payload[chunk1_start..chunk1_start + segment_size]; + assert_eq!(chunk1_data[0], 1u8, "Chunk 1 corrupted"); + + let chunk2_start = actual_segment_size + margins.header; + let chunk2_data = &payload[chunk2_start..chunk2_start + segment_size]; + assert_eq!(chunk2_data[0], 2u8, "Chunk 2 corrupted"); + + let chunk3_start = actual_segment_size * 2 + margins.header; + let chunk3_data = &payload[chunk3_start..chunk3_start + segment_size]; + assert_eq!(chunk3_data[0], 3u8, "Chunk 3 corrupted"); + } + + fn endpoint_pair_with_configs( + client_endpoint_config: EndpointConfig, + server_endpoint_config: EndpointConfig, + ) -> (Endpoint, Endpoint) { + let server_config = server_config(); + let client_config = client_config(); + + let (socket_client, socket_server) = make_socket_pair(); + + let mut client_endpoint = Endpoint::new_with_abstract_socket( + client_endpoint_config, + Some(server_config.clone()), + Arc::new(socket_client), + default_runtime().unwrap(), + ) + .unwrap(); + client_endpoint.set_default_client_config(client_config.clone()); + + let mut server_endpoint = Endpoint::new_with_abstract_socket( + server_endpoint_config, + Some(server_config), + Arc::new(socket_server), + default_runtime().unwrap(), + ) + .unwrap(); + server_endpoint.set_default_client_config(client_config); + + (client_endpoint, server_endpoint) + } + + async fn assert_stream_roundtrip(connection: &Connection) -> anyhow::Result<()> { + let (mut send, mut recv) = connection.open_bi().await?; + send.write_all(b"ping").await?; + send.finish()?; + let mut buf = vec![0u8; 4]; + recv.read_exact(&mut buf).await?; + assert_eq!(&buf, b"ping"); + Ok(()) + } + + #[tokio::test] + async fn etq1_handshake_streams_both_ways() -> anyhow::Result<()> { + // New client and new server negotiate ETQ1 and echo a stream in both + // directions, exercising the packet-number-bound checksum on + // Initial, Handshake and 1-RTT packets. + let (client_endpoint, server_endpoint) = + endpoint_pair_with_configs(endpoint_config(), endpoint_config()); + let server_addr = server_endpoint.local_addr()?; + + let server = tokio::spawn(async move { + let Some(incoming) = server_endpoint.accept().await else { + panic!("no incoming connection"); + }; + let connection = incoming.await.unwrap(); + let (mut send, mut recv) = connection.accept_bi().await.unwrap(); + let mut buf = vec![0u8; 4]; + recv.read_exact(&mut buf).await.unwrap(); + send.write_all(&buf).await.unwrap(); + send.finish().unwrap(); + let _ = connection.closed().await; + }); + + let connection = client_endpoint + .connect_with(etq1_client_config(), server_addr, "localhost")? + .await?; + + let (mut send, mut recv) = connection.open_bi().await?; + send.write_all(b"ping").await?; + send.finish()?; + let mut buf = vec![0u8; 4]; + recv.read_exact(&mut buf).await?; + assert_eq!(&buf, b"ping"); + + connection.close(0u32.into(), b"done"); + let _ = tokio::time::timeout(Duration::from_secs(2), server).await; + Ok(()) + } + + #[tokio::test] + async fn etq1_against_legacy_server_falls_back_to_version_1() -> anyhow::Result<()> { + // A new client dialing a legacy (version 1 only) server must see + // VersionMismatch for ETQ1 and succeed after falling back to the + // legacy client config, mirroring NatDstQuicConnector::connect. + let (client_endpoint, server_endpoint) = + endpoint_pair_with_configs(endpoint_config(), endpoint_config_with_versions(vec![1])); + let server_addr = server_endpoint.local_addr()?; + + let server = tokio::spawn(async move { + let Some(incoming) = server_endpoint.accept().await else { + return; + }; + let connection = incoming.await.unwrap(); + if let Ok((mut send, mut recv)) = connection.accept_bi().await { + let mut buf = vec![0u8; 4]; + recv.read_exact(&mut buf).await.unwrap(); + send.write_all(&buf).await.unwrap(); + send.finish().unwrap(); + } + let _ = connection.closed().await; + }); + + let err = client_endpoint + .connect_with(etq1_client_config(), server_addr, "localhost")? + .await + .expect_err("legacy server must reject ETQ1"); + assert!( + matches!(err, ConnectionError::VersionMismatch), + "unexpected error: {err:?}" + ); + + let connection = client_endpoint + .connect_with(client_config(), server_addr, "localhost")? + .await?; + assert_stream_roundtrip(&connection).await?; + + connection.close(0u32.into(), b"done"); + let _ = tokio::time::timeout(Duration::from_secs(2), server).await; + Ok(()) + } + + #[tokio::test] + async fn legacy_client_against_etq1_server() -> anyhow::Result<()> { + // An old client keeps working against a new (dual version) server. + let (client_endpoint, server_endpoint) = + endpoint_pair_with_configs(endpoint_config_with_versions(vec![1]), endpoint_config()); + let server_addr = server_endpoint.local_addr()?; + + let server = tokio::spawn(async move { + let Some(incoming) = server_endpoint.accept().await else { + return; + }; + let connection = incoming.await.unwrap(); + if let Ok((mut send, mut recv)) = connection.accept_bi().await { + let mut buf = vec![0u8; 4]; + recv.read_exact(&mut buf).await.unwrap(); + send.write_all(&buf).await.unwrap(); + send.finish().unwrap(); + } + let _ = connection.closed().await; + }); + + let connection = client_endpoint.connect(server_addr, "localhost")?.await?; + assert_stream_roundtrip(&connection).await?; + + connection.close(0u32.into(), b"done"); + let _ = tokio::time::timeout(Duration::from_secs(2), server).await; + Ok(()) + } + #[tokio::test] + async fn connect_with_etq1_falls_back_for_legacy_server() -> anyhow::Result<()> { + // The shared ETQ1-first dial helper used by the quic:// tunnel: a + // legacy server rejects ETQ1 via version negotiation and the helper + // must transparently fall back to version 1. + let (client_endpoint, server_endpoint) = + endpoint_pair_with_configs(endpoint_config(), endpoint_config_with_versions(vec![1])); + let server_addr = server_endpoint.local_addr()?; + + let server = tokio::spawn(async move { + let Some(incoming) = server_endpoint.accept().await else { + return; + }; + let connection = incoming.await.unwrap(); + if let Ok((mut send, mut recv)) = connection.accept_bi().await { + let mut buf = vec![0u8; 4]; + recv.read_exact(&mut buf).await.unwrap(); + send.write_all(&buf).await.unwrap(); + send.finish().unwrap(); + } + let _ = connection.closed().await; + }); + + let connection = connect_with_etq1(&client_endpoint, server_addr, "localhost").await?; + assert_stream_roundtrip(&connection).await?; + + connection.close(0u32.into(), b"done"); + let _ = tokio::time::timeout(Duration::from_secs(2), server).await; + Ok(()) + } +} diff --git a/vendor/easytier/easytier/src/host_runtime.rs b/vendor/easytier/easytier/src/host_runtime.rs new file mode 100644 index 0000000..f3cfad0 --- /dev/null +++ b/vendor/easytier/easytier/src/host_runtime.rs @@ -0,0 +1,229 @@ +use std::{ + net::{IpAddr, SocketAddr, SocketAddrV4, SocketAddrV6}, + sync::{Arc, OnceLock}, +}; + +use async_trait::async_trait; +use easytier_core::{ + connectivity::{composite::ConnectorRuntime, transport::ConnectedByteStream}, + host::dns::{DnsQuery, DnsRecordResolver, DnsResolver, DnsSrvRecord}, + socket::{ + SocketContext, + tcp::{ + TcpConnectOptions, TcpListenOptions, TcpSocketPurpose, VirtualTcpListenerFactory, + VirtualTcpSocketFactory, + }, + udp::{PreferredIpv6Source, UdpBindOptions, VirtualUdpSocketFactory}, + }, +}; + +use crate::{ + common::{ + dns::RuntimeDnsResolver, + netns::NetNS, + network::{collect_interfaces, collect_local_ip_addrs}, + }, + proto::peer_rpc::GetIpListResponse, + socket::{ + tcp::{RuntimeTcpListener, RuntimeTcpSocket}, + udp::{RuntimeUdpSocket, RuntimeUdpSocketFactory}, + }, +}; + +/// Process-wide native implementation of the host capabilities consumed by core. +/// +/// Instance-specific policy is carried by each request's socket context so a +/// process-wide service never captures one instance's namespace or mark. +#[derive(Debug)] +pub struct NativeHostRuntime { + udp_sockets: RuntimeUdpSocketFactory, + dns: RuntimeDnsResolver, +} + +static NATIVE_HOST_RUNTIME: OnceLock> = OnceLock::new(); + +pub(crate) fn native_host_runtime() -> Arc { + NATIVE_HOST_RUNTIME + .get_or_init(|| { + Arc::new(NativeHostRuntime { + udp_sockets: RuntimeUdpSocketFactory::new(), + dns: RuntimeDnsResolver::new(), + }) + }) + .clone() +} + +#[async_trait] +impl VirtualTcpSocketFactory for NativeHostRuntime { + type Socket = RuntimeTcpSocket; + + async fn connect_tcp(&self, options: TcpConnectOptions) -> anyhow::Result { + #[cfg(feature = "faketcp")] + if options.purpose == TcpSocketPurpose::FakeTcp { + let remote_addr = options.remote_addr; + let socket_mark = options.bind.context.socket_mark; + let net_ns = NetNS::from_socket_context(&options.bind.context); + let socket = + crate::socket::fake_tcp::connect_socket(remote_addr, socket_mark, net_ns).await?; + return Ok(RuntimeTcpSocket::from_fake_tcp(socket)); + } + + #[cfg(not(feature = "faketcp"))] + if options.purpose == TcpSocketPurpose::FakeTcp { + anyhow::bail!("FakeTCP socket support is disabled") + } + + crate::socket::tcp::connect_tcp(options) + .await + .map_err(anyhow::Error::from) + } +} + +#[async_trait] +impl ConnectorRuntime for NativeHostRuntime { + async fn connect_byte_stream( + &self, + url: &url::Url, + ) -> anyhow::Result> { + #[cfg(unix)] + if url.scheme() == "unix" { + let stream = tokio::net::UnixStream::connect(url.path()).await?; + let local_url = stream + .local_addr() + .ok() + .and_then(crate::socket::tcp::url_from_unix_socket_addr); + return Ok(ConnectedByteStream::new( + RuntimeTcpSocket::from_unix(stream), + local_url, + url.clone(), + Some(url.clone()), + )); + } + + anyhow::bail!("unsupported runtime byte stream: {url}") + } + + async fn local_addr_for_remote( + &self, + remote_addr: SocketAddr, + context: SocketContext, + ) -> anyhow::Result { + let bind_addr = match remote_addr { + SocketAddr::V4(_) => { + SocketAddr::V4(SocketAddrV4::new(std::net::Ipv4Addr::UNSPECIFIED, 0)) + } + SocketAddr::V6(_) => { + SocketAddr::V6(SocketAddrV6::new(std::net::Ipv6Addr::UNSPECIFIED, 0, 0, 0)) + } + }; + let options = UdpBindOptions::default() + .with_context(context) + .with_local_addr(Some(bind_addr)); + let socket = crate::socket::udp::create_udp_socket(&options).await?; + socket.connect(remote_addr).await?; + Ok(socket.local_addr()?) + } + + async fn preferred_ipv6_source( + &self, + ip: std::net::Ipv6Addr, + context: SocketContext, + ) -> Option { + collect_interfaces(NetNS::from_socket_context(&context), false) + .await + .into_iter() + .find(|interface| { + interface + .addr + .iter() + .any(|local| matches!(local.ip(), IpAddr::V6(local_ip) if local_ip == ip)) + }) + .map(|interface| PreferredIpv6Source { + ip, + ifindex: interface.index, + }) + } + + async fn collect_ip_addrs(&self, context: &SocketContext) -> GetIpListResponse { + collect_local_ip_addrs(NetNS::from_socket_context(context)).await + } +} + +impl NativeHostRuntime { + pub(crate) fn is_local_ip(&self, ip: &IpAddr, context: &SocketContext) -> bool { + NetNS::from_socket_context(context) + .run(|| std::net::UdpSocket::bind(format!("{ip}:0")).is_ok()) + } +} + +#[async_trait] +impl VirtualTcpListenerFactory for NativeHostRuntime { + type Listener = RuntimeTcpListener; + + async fn bind_tcp(&self, options: TcpListenOptions) -> anyhow::Result> { + Ok(Arc::new( + crate::socket::tcp::bind_tcp_listener(options).await?, + )) + } +} + +#[async_trait] +impl VirtualUdpSocketFactory for NativeHostRuntime { + type Socket = RuntimeUdpSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + let socket = self.udp_sockets.bind_udp(options).await?; + #[cfg(target_os = "windows")] + crate::arch::windows::disable_connection_reset(socket.socket().as_ref())?; + Ok(socket) + } +} + +#[async_trait] +impl DnsResolver for NativeHostRuntime { + async fn resolve(&self, query: DnsQuery) -> anyhow::Result> { + self.dns.resolve(query).await + } +} + +#[async_trait] +impl DnsRecordResolver for NativeHostRuntime { + async fn resolve_txt(&self, query: DnsQuery) -> anyhow::Result { + self.dns.resolve_txt(query).await + } + + async fn resolve_srv(&self, query: DnsQuery) -> anyhow::Result> { + self.dns.resolve_srv(query).await + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn native_host_runtime_is_process_wide() { + assert!(Arc::ptr_eq(&native_host_runtime(), &native_host_runtime())); + } + + #[test] + fn native_local_ip_probe_uses_process_runtime() { + assert!(native_host_runtime().is_local_ip( + &IpAddr::V4(std::net::Ipv4Addr::LOCALHOST), + &SocketContext::default(), + )); + } + + #[tokio::test] + async fn native_route_probe_uses_remote_address_family() { + let local_addr = native_host_runtime() + .local_addr_for_remote( + SocketAddr::from(([127, 0, 0, 1], 9)), + SocketContext::default(), + ) + .await + .unwrap(); + + assert!(local_addr.is_ipv4()); + } +} diff --git a/vendor/easytier/easytier/src/igd_next/LICENSE b/vendor/easytier/easytier/src/igd_next/LICENSE new file mode 100644 index 0000000..68a7db0 --- /dev/null +++ b/vendor/easytier/easytier/src/igd_next/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2015 Simon Bernier St-Pierre + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/vendor/easytier/easytier/src/igd_next/errors.rs b/vendor/easytier/easytier/src/igd_next/errors.rs new file mode 100644 index 0000000..1bffe0f --- /dev/null +++ b/vendor/easytier/easytier/src/igd_next/errors.rs @@ -0,0 +1,126 @@ +use std::{io, string::FromUtf8Error}; + +use easytier_core::tunnel::TunnelError; + +#[derive(Debug, thiserror::Error)] +pub(crate) enum HttpTransportError { + #[error("socket error: {0}")] + Socket(#[from] TunnelError), + #[error("HTTP request error: {0}")] + Http(#[from] hyper::http::Error), + #[error("HTTP connection error: {0}")] + Hyper(#[from] hyper::Error), + #[error("HTTP response is not UTF-8: {0}")] + Utf8(#[from] FromUtf8Error), + #[error("HTTP request timed out")] + TimedOut, + #[error("invalid HTTP response: {0}")] + InvalidResponse(String), +} + +#[derive(Debug, thiserror::Error)] +pub(crate) enum RequestError { + #[error(transparent)] + Http(#[from] HttpTransportError), + #[error("invalid response from gateway: {0}")] + InvalidResponse(String), + #[error("gateway response error {0}: {1}")] + ErrorCode(u16, String), + #[error("gateway does not support action: {0}")] + UnsupportedAction(String), +} + +#[derive(Debug, thiserror::Error)] +pub(crate) enum SearchError { + #[error("invalid response")] + InvalidResponse, + #[error("no response within timeout")] + NoResponseWithinTimeout, + #[error("I/O error: {0}")] + Io(#[from] io::Error), + #[error("UTF-8 error: {0}")] + Utf8(#[from] std::str::Utf8Error), + #[error("XML error: {0}")] + Xml(#[from] xmltree::ParseError), + #[error(transparent)] + Http(#[from] HttpTransportError), +} + +#[derive(Debug, thiserror::Error)] +pub(crate) enum AddAnyPortError { + #[error("the client is not authorized to map this port")] + ActionNotAuthorized, + #[error("cannot add a mapping for local port 0")] + InternalPortZeroInvalid, + #[error("the gateway does not have any free ports")] + NoPortsAvailable, + #[error("the required same-numbered external port is in use")] + ExternalPortInUse, + #[error("the gateway only supports permanent leases")] + OnlyPermanentLeasesSupported, + #[error("the description was too long for the gateway")] + DescriptionTooLong, + #[error("request error: {0}")] + RequestError(#[from] RequestError), +} + +#[derive(Debug, thiserror::Error)] +pub(crate) enum AddPortError { + #[error("the client is not authorized to map this port")] + ActionNotAuthorized, + #[error("cannot add a mapping for local port 0")] + InternalPortZeroInvalid, + #[error("external port 0 is invalid")] + ExternalPortZeroInvalid, + #[error("the requested port is in use")] + PortInUse, + #[error("the gateway requires matching internal and external ports")] + SamePortValuesRequired, + #[error("the gateway only supports permanent leases")] + OnlyPermanentLeasesSupported, + #[error("the description was too long for the gateway")] + DescriptionTooLong, + #[error("request error: {0}")] + RequestError(#[source] RequestError), +} + +#[derive(Debug, thiserror::Error)] +pub(crate) enum RemovePortError { + #[error("the client is not authorized to remove the port")] + ActionNotAuthorized, + #[error("the port was not mapped")] + NoSuchPortMapping, + #[error("request error: {0}")] + RequestError(#[source] RequestError), +} + +#[derive(Debug, thiserror::Error)] +#[cfg(test)] +pub(crate) enum GetExternalIpError { + #[error("the client is not authorized to get the external IP address")] + ActionNotAuthorized, + #[error("request error: {0}")] + RequestError(#[source] RequestError), +} + +#[derive(Debug, thiserror::Error)] +#[cfg(test)] +pub(crate) enum GetGenericPortMappingEntryError { + #[error("the client is not authorized to look up port mappings")] + ActionNotAuthorized, + #[error("the provided mapping index is invalid")] + SpecifiedArrayIndexInvalid, + #[error("request error: {0}")] + RequestError(#[source] RequestError), +} + +#[cfg(test)] +impl From for GetGenericPortMappingEntryError { + fn from(error: RequestError) -> Self { + match error { + RequestError::ErrorCode(606, _) => Self::ActionNotAuthorized, + RequestError::ErrorCode(713, _) => Self::SpecifiedArrayIndexInvalid, + other => Self::RequestError(other), + } + } +} diff --git a/vendor/easytier/easytier/src/igd_next/messages.rs b/vendor/easytier/easytier/src/igd_next/messages.rs new file mode 100644 index 0000000..8e019f5 --- /dev/null +++ b/vendor/easytier/easytier/src/igd_next/messages.rs @@ -0,0 +1,218 @@ +use std::net::SocketAddr; + +use super::PortMappingProtocol; + +pub(super) const SEARCH_REQUEST: &str = "M-SEARCH * HTTP/1.1\r +Host:239.255.255.250:1900\r +ST:urn:schemas-upnp-org:device:InternetGatewayDevice:1\r +Man:\"ssdp:discover\"\r +MX:3\r\n\r\n"; + +#[cfg(test)] +pub(super) const GET_EXTERNAL_IP_ACTION: &str = "GetExternalIPAddress"; +pub(super) const ADD_ANY_PORT_MAPPING_ACTION: &str = "AddAnyPortMapping"; +pub(super) const ADD_PORT_MAPPING_ACTION: &str = "AddPortMapping"; +pub(super) const DELETE_PORT_MAPPING_ACTION: &str = "DeletePortMapping"; +#[cfg(test)] +pub(super) const GET_GENERIC_PORT_MAPPING_ENTRY_ACTION: &str = "GetGenericPortMappingEntry"; + +const MESSAGE_HEAD: &str = r#" + +"#; +const MESSAGE_TAIL: &str = r#" +"#; + +pub(super) fn soap_action(service_type: &str, action: &str) -> String { + format!("\"{service_type}#{action}\"") +} + +fn format_message(body: String) -> String { + format!("{MESSAGE_HEAD}{body}{MESSAGE_TAIL}") +} + +fn xml_escape(input: &str) -> String { + let mut output = String::with_capacity(input.len()); + for character in input.chars() { + match character { + '&' => output.push_str("&"), + '<' => output.push_str("<"), + '>' => output.push_str(">"), + '"' => output.push_str("""), + '\'' => output.push_str("'"), + _ => output.push(character), + } + } + output +} + +#[cfg(test)] +pub(super) fn format_get_external_ip_message(service_type: &str) -> String { + format_message(format!( + r#" + "# + )) +} + +pub(super) fn format_add_any_port_mapping_message( + service_type: &str, + schema: &[String], + protocol: PortMappingProtocol, + external_port: u16, + local_addr: SocketAddr, + lease_duration: u32, + description: &str, +) -> String { + let arguments = format_mapping_arguments( + schema, + protocol, + external_port, + local_addr, + lease_duration, + description, + ); + format_message(format!( + r#" + {arguments} + "# + )) +} + +pub(super) fn format_add_port_mapping_message( + service_type: &str, + schema: &[String], + protocol: PortMappingProtocol, + external_port: u16, + local_addr: SocketAddr, + lease_duration: u32, + description: &str, +) -> String { + let arguments = format_mapping_arguments( + schema, + protocol, + external_port, + local_addr, + lease_duration, + description, + ); + format_message(format!( + r#" + {arguments} + "# + )) +} + +fn format_mapping_arguments( + schema: &[String], + protocol: PortMappingProtocol, + external_port: u16, + local_addr: SocketAddr, + lease_duration: u32, + description: &str, +) -> String { + schema + .iter() + .filter_map(|argument| { + let value = match argument.as_str() { + "NewEnabled" => "1".to_owned(), + "NewExternalPort" => external_port.to_string(), + "NewInternalClient" => local_addr.ip().to_string(), + "NewInternalPort" => local_addr.port().to_string(), + "NewLeaseDuration" => lease_duration.to_string(), + "NewPortMappingDescription" => description.to_owned(), + "NewProtocol" => protocol.to_string(), + "NewRemoteHost" => String::new(), + unknown => { + tracing::warn!(argument = unknown, "unknown IGD SOAP argument"); + return None; + } + }; + Some(format!("<{argument}>{}", xml_escape(&value))) + }) + .collect::>() + .join("\n") +} + +pub(super) fn format_delete_port_message( + service_type: &str, + schema: &[String], + protocol: PortMappingProtocol, + external_port: u16, +) -> String { + let arguments = schema + .iter() + .filter_map(|argument| { + let value = match argument.as_str() { + "NewExternalPort" => external_port.to_string(), + "NewProtocol" => protocol.to_string(), + "NewRemoteHost" => String::new(), + unknown => { + tracing::warn!(argument = unknown, "unknown IGD SOAP argument"); + return None; + } + }; + Some(format!("<{argument}>{}", xml_escape(&value))) + }) + .collect::>() + .join("\n"); + + format_message(format!( + r#" + {arguments} + "# + )) +} + +#[cfg(test)] +pub(super) fn format_get_generic_port_mapping_entry_message( + service_type: &str, + port_mapping_index: u32, +) -> String { + format_message(format!( + r#" + {port_mapping_index} + "# + )) +} + +#[cfg(test)] +mod tests { + use super::*; + + const PPP_SERVICE: &str = "urn:schemas-upnp-org:service:WANPPPConnection:1"; + + #[test] + fn soap_action_and_body_use_discovered_service_type() { + assert_eq!( + soap_action(PPP_SERVICE, ADD_PORT_MAPPING_ACTION), + "\"urn:schemas-upnp-org:service:WANPPPConnection:1#AddPortMapping\"" + ); + + let body = format_add_port_mapping_message( + PPP_SERVICE, + &["NewProtocol".to_owned(), "NewExternalPort".to_owned()], + PortMappingProtocol::Udp, + 12345, + "192.168.1.5:80".parse().unwrap(), + 0, + "test", + ); + assert!(body.contains(r#"xmlns:u="urn:schemas-upnp-org:service:WANPPPConnection:1""#)); + assert!(body.contains("UDP")); + assert!(body.contains("12345")); + } + + #[test] + fn mapping_description_is_xml_escaped() { + let body = format_add_port_mapping_message( + PPP_SERVICE, + &["NewPortMappingDescription".to_owned()], + PortMappingProtocol::Udp, + 12345, + "192.168.1.5:80".parse().unwrap(), + 0, + "Bob & Alice ", + ); + assert!(body.contains("Bob & Alice </NewPortMappingDescription><evil>")); + assert!(!body.contains("")); + } +} diff --git a/vendor/easytier/easytier/src/igd_next/mod.rs b/vendor/easytier/easytier/src/igd_next/mod.rs new file mode 100644 index 0000000..2d90648 --- /dev/null +++ b/vendor/easytier/easytier/src/igd_next/mod.rs @@ -0,0 +1,485 @@ +// Derived from igd-next 0.17.0 and upstream commit +// bb335d60348386526684d9249d7ae733772279e4, with its network transport +// replaced by EasyTier's socket factories. See LICENSE in this +// directory for the upstream license. + +mod errors; +mod messages; +mod parsing; + +use std::{collections::HashMap, fmt, net::SocketAddr, time::Duration}; + +#[cfg(test)] +use std::net::IpAddr; + +use bytes::Bytes; +use easytier_core::socket::{ + tcp::TcpConnectOptions, + udp::{UdpBindOptions, VirtualUdpSocket, VirtualUdpSocketFactory}, +}; +use http_body_util::{BodyExt as _, Full, Limited}; +use hyper::{ + Method, Request, + client::conn::http1, + header::{CONNECTION, CONTENT_LENGTH, CONTENT_TYPE, HOST}, +}; +use hyper_util::rt::TokioIo; +use rand::Rng as _; +use tokio::time::timeout; + +pub(crate) use errors::AddAnyPortError; +#[cfg(test)] +use errors::GetExternalIpError; +#[cfg(test)] +pub(crate) use errors::GetGenericPortMappingEntryError; +use errors::{AddPortError, HttpTransportError, RemovePortError, RequestError, SearchError}; + +use crate::socket::{tcp::connect_tcp, udp::RuntimeUdpSocketFactory}; + +const DEFAULT_SEARCH_TIMEOUT: Duration = Duration::from_secs(10); +const DEFAULT_RESPONSE_TIMEOUT: Duration = Duration::from_secs(5); +const DEFAULT_REQUEST_TIMEOUT: Duration = Duration::from_secs(10); +const MAX_SSDP_RESPONSE_SIZE: usize = 1500; +const MAX_HTTP_RESPONSE_SIZE: usize = 1024 * 1024; + +#[derive(Clone, Copy, Debug, Eq, PartialEq)] +pub(crate) enum PortMappingProtocol { + #[cfg(test)] + Tcp, + Udp, +} + +impl fmt::Display for PortMappingProtocol { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter.write_str(match self { + #[cfg(test)] + Self::Tcp => "TCP", + Self::Udp => "UDP", + }) + } +} + +pub(crate) struct SearchOptions { + pub(crate) bind_addr: SocketAddr, + pub(crate) broadcast_address: SocketAddr, + pub(crate) timeout: Option, + pub(crate) single_search_timeout: Option, +} + +impl Default for SearchOptions { + fn default() -> Self { + Self { + bind_addr: "0.0.0.0:0".parse().unwrap(), + broadcast_address: "239.255.255.250:1900".parse().unwrap(), + timeout: Some(DEFAULT_SEARCH_TIMEOUT), + single_search_timeout: Some(DEFAULT_RESPONSE_TIMEOUT), + } + } +} + +#[derive(Debug)] +pub(crate) struct Gateway { + pub(crate) addr: SocketAddr, + control_url: String, + control_schema: HashMap>, + service_type: String, +} + +#[cfg(test)] +pub(crate) struct PortMappingEntry { + pub(crate) external_port: u16, + pub(crate) protocol: PortMappingProtocol, + pub(crate) internal_port: u16, + pub(crate) internal_client: String, + pub(crate) port_mapping_description: String, +} + +pub(crate) async fn search_gateway(options: SearchOptions) -> Result { + let search_timeout = options.timeout.unwrap_or(DEFAULT_SEARCH_TIMEOUT); + timeout(search_timeout, search_gateway_inner(options)) + .await + .map_err(|_| SearchError::NoResponseWithinTimeout)? +} + +async fn search_gateway_inner(options: SearchOptions) -> Result { + let bind_options = UdpBindOptions::direct_connect().with_local_addr(Some(options.bind_addr)); + let socket = RuntimeUdpSocketFactory::new() + .bind_udp(bind_options) + .await + .map_err(|error| SearchError::Io(std::io::Error::other(error.to_string())))?; + socket + .send_to( + messages::SEARCH_REQUEST.as_bytes(), + options.broadcast_address, + ) + .await?; + + let response_timeout = options + .single_search_timeout + .unwrap_or(DEFAULT_RESPONSE_TIMEOUT); + loop { + let mut buffer = [0_u8; MAX_SSDP_RESPONSE_SIZE]; + let (length, from) = match timeout(response_timeout, socket.recv_from(&mut buffer)).await { + Ok(Ok(response)) => response, + Ok(Err(error)) => { + tracing::debug!(?error, "failed to receive IGD discovery response"); + continue; + } + Err(_) => { + tracing::debug!("timed out waiting for IGD discovery response"); + continue; + } + }; + let response = match std::str::from_utf8(&buffer[..length]) { + Ok(response) => response, + Err(error) => { + tracing::debug!(?error, %from, "invalid IGD discovery response encoding"); + continue; + } + }; + let (addr, root_url) = match parsing::parse_search_result(response) { + Ok(result) => result, + Err(error) => { + tracing::debug!(?error, %from, "invalid IGD discovery response"); + continue; + } + }; + let (service_type, schema_url, control_url) = match get_control_urls(addr, &root_url).await + { + Ok(urls) => urls, + Err(error) => { + tracing::debug!(?error, %addr, "failed to read IGD device description"); + continue; + } + }; + let control_schema = match get_control_schema(addr, &schema_url).await { + Ok(schema) => schema, + Err(error) => { + tracing::debug!(?error, %addr, "failed to read IGD control schema"); + continue; + } + }; + return Ok(Gateway { + addr, + control_url, + control_schema, + service_type, + }); + } +} + +async fn get_control_urls( + addr: SocketAddr, + root_url: &str, +) -> Result<(String, String, String), SearchError> { + let response = send_http_request(addr, root_url, Method::GET, None, String::new()).await?; + parsing::parse_control_urls(response.as_ref()) +} + +async fn get_control_schema( + addr: SocketAddr, + schema_url: &str, +) -> Result>, SearchError> { + let response = send_http_request(addr, schema_url, Method::GET, None, String::new()).await?; + parsing::parse_schemas(response.as_ref()) +} + +async fn send_http_request( + addr: SocketAddr, + path: &str, + method: Method, + soap_action: Option<&str>, + body: String, +) -> Result { + timeout( + DEFAULT_REQUEST_TIMEOUT, + send_http_request_inner(addr, path, method, soap_action, body), + ) + .await + .map_err(|_| HttpTransportError::TimedOut)? +} + +async fn send_http_request_inner( + addr: SocketAddr, + path: &str, + method: Method, + soap_action: Option<&str>, + body: String, +) -> Result { + let stream = connect_tcp(TcpConnectOptions::direct_connect(addr)).await?; + let (mut sender, connection) = http1::handshake(TokioIo::new(stream)).await?; + let body = Bytes::from(body); + let mut request = Request::builder() + .method(method) + .uri(path) + .header(HOST, addr.to_string()) + .header(CONNECTION, "close") + .header(CONTENT_LENGTH, body.len() as u64); + if let Some(action) = soap_action { + request = request + .header("SOAPAction", action) + .header(CONTENT_TYPE, "text/xml; charset=utf-8"); + } + let request = request.body(Full::new(body))?; + + let response = async move { + let response = sender.send_request(request).await?; + let body = Limited::new(response.into_body(), MAX_HTTP_RESPONSE_SIZE) + .collect() + .await + .map_err(|error| HttpTransportError::InvalidResponse(error.to_string()))? + .to_bytes(); + Ok::<_, HttpTransportError>(body) + }; + tokio::pin!(response); + tokio::pin!(connection); + tokio::select! { + biased; + result = &mut response => result, + result = &mut connection => { + result?; + response.await + } + } +} + +impl Gateway { + async fn perform_request( + &self, + action: &str, + body: &str, + expected_response: &str, + ) -> parsing::RequestResult { + let soap_action = messages::soap_action(&self.service_type, action); + let response = send_http_request( + self.addr, + &self.control_url, + Method::POST, + Some(&soap_action), + body.to_owned(), + ) + .await?; + let response = String::from_utf8(response.to_vec()).map_err(HttpTransportError::from)?; + parsing::parse_response(response, expected_response) + } + + #[cfg(test)] + pub(crate) async fn get_external_ip(&self) -> Result { + let result = self + .perform_request( + messages::GET_EXTERNAL_IP_ACTION, + &messages::format_get_external_ip_message(&self.service_type), + "GetExternalIPAddressResponse", + ) + .await; + parsing::parse_get_external_ip_response(result) + } + + pub(crate) async fn add_any_port( + &self, + protocol: PortMappingProtocol, + local_addr: SocketAddr, + lease_duration: u32, + description: &str, + ) -> Result { + if local_addr.port() == 0 { + return Err(AddAnyPortError::InternalPortZeroInvalid); + } + + if let Some(schema) = self + .control_schema + .get(messages::ADD_ANY_PORT_MAPPING_ACTION) + { + let external_port = random_port(); + let result = self + .perform_request( + messages::ADD_ANY_PORT_MAPPING_ACTION, + &messages::format_add_any_port_mapping_message( + &self.service_type, + schema, + protocol, + external_port, + local_addr, + lease_duration, + description, + ), + "AddAnyPortMappingResponse", + ) + .await; + return parsing::parse_add_any_port_mapping_response(result); + } + + self.retry_add_random_port_mapping(protocol, local_addr, lease_duration, description) + .await + } + + async fn retry_add_random_port_mapping( + &self, + protocol: PortMappingProtocol, + local_addr: SocketAddr, + lease_duration: u32, + description: &str, + ) -> Result { + for _ in 0..20 { + match self + .add_random_port_mapping(protocol, local_addr, lease_duration, description) + .await + { + Err(AddAnyPortError::NoPortsAvailable) => continue, + result => return result, + } + } + Err(AddAnyPortError::NoPortsAvailable) + } + + async fn add_random_port_mapping( + &self, + protocol: PortMappingProtocol, + local_addr: SocketAddr, + lease_duration: u32, + description: &str, + ) -> Result { + let external_port = random_port(); + match self + .add_port_mapping( + protocol, + external_port, + local_addr, + lease_duration, + description, + ) + .await + { + Ok(()) => Ok(external_port), + Err(error) => match parsing::convert_add_random_port_mapping_error(error) { + Some(error) => Err(error), + None => { + self.add_same_port_mapping(protocol, local_addr, lease_duration, description) + .await + } + }, + } + } + + async fn add_same_port_mapping( + &self, + protocol: PortMappingProtocol, + local_addr: SocketAddr, + lease_duration: u32, + description: &str, + ) -> Result { + self.add_port_mapping( + protocol, + local_addr.port(), + local_addr, + lease_duration, + description, + ) + .await + .map(|()| local_addr.port()) + .map_err(parsing::convert_add_same_port_mapping_error) + } + + async fn add_port_mapping( + &self, + protocol: PortMappingProtocol, + external_port: u16, + local_addr: SocketAddr, + lease_duration: u32, + description: &str, + ) -> Result<(), RequestError> { + let schema = self + .control_schema + .get(messages::ADD_PORT_MAPPING_ACTION) + .ok_or_else(|| { + RequestError::UnsupportedAction(messages::ADD_PORT_MAPPING_ACTION.to_owned()) + })?; + self.perform_request( + messages::ADD_PORT_MAPPING_ACTION, + &messages::format_add_port_mapping_message( + &self.service_type, + schema, + protocol, + external_port, + local_addr, + lease_duration, + description, + ), + "AddPortMappingResponse", + ) + .await?; + Ok(()) + } + + pub(crate) async fn add_port( + &self, + protocol: PortMappingProtocol, + external_port: u16, + local_addr: SocketAddr, + lease_duration: u32, + description: &str, + ) -> Result<(), AddPortError> { + if external_port == 0 { + return Err(AddPortError::ExternalPortZeroInvalid); + } + if local_addr.port() == 0 { + return Err(AddPortError::InternalPortZeroInvalid); + } + self.add_port_mapping( + protocol, + external_port, + local_addr, + lease_duration, + description, + ) + .await + .map_err(parsing::convert_add_port_error) + } + + pub(crate) async fn remove_port( + &self, + protocol: PortMappingProtocol, + external_port: u16, + ) -> Result<(), RemovePortError> { + let schema = self + .control_schema + .get(messages::DELETE_PORT_MAPPING_ACTION) + .ok_or_else(|| { + RemovePortError::RequestError(RequestError::UnsupportedAction( + messages::DELETE_PORT_MAPPING_ACTION.to_owned(), + )) + })?; + let result = self + .perform_request( + messages::DELETE_PORT_MAPPING_ACTION, + &messages::format_delete_port_message( + &self.service_type, + schema, + protocol, + external_port, + ), + "DeletePortMappingResponse", + ) + .await; + parsing::parse_delete_port_mapping_response(result) + } + + #[cfg(test)] + pub(crate) async fn get_generic_port_mapping_entry( + &self, + index: u32, + ) -> Result { + let result = self + .perform_request( + messages::GET_GENERIC_PORT_MAPPING_ENTRY_ACTION, + &messages::format_get_generic_port_mapping_entry_message(&self.service_type, index), + "GetGenericPortMappingEntryResponse", + ) + .await; + parsing::parse_get_generic_port_mapping_entry(result) + } +} + +fn random_port() -> u16 { + rand::thread_rng().gen_range(32_768..65_535) +} diff --git a/vendor/easytier/easytier/src/igd_next/parsing.rs b/vendor/easytier/easytier/src/igd_next/parsing.rs new file mode 100644 index 0000000..8e11e9d --- /dev/null +++ b/vendor/easytier/easytier/src/igd_next/parsing.rs @@ -0,0 +1,401 @@ +use std::{collections::HashMap, io, net::SocketAddr}; + +#[cfg(test)] +use std::str::FromStr; + +use url::Url; +use xmltree::Element; + +use super::errors::{AddAnyPortError, AddPortError, RemovePortError, RequestError, SearchError}; +#[cfg(test)] +use super::{ + PortMappingEntry, PortMappingProtocol, + errors::{GetExternalIpError, GetGenericPortMappingEntryError}, +}; + +pub(super) fn parse_search_result(text: &str) -> Result<(SocketAddr, String), SearchError> { + for line in text.lines().map(str::trim) { + let Some((name, value)) = line.split_once(':') else { + continue; + }; + if !name.eq_ignore_ascii_case("location") { + continue; + } + + let url = Url::parse(value.trim()).map_err(|_| SearchError::InvalidResponse)?; + let host = url.host_str().ok_or(SearchError::InvalidResponse)?; + let ip = host.parse().map_err(|_| SearchError::InvalidResponse)?; + let port = url + .port_or_known_default() + .ok_or(SearchError::InvalidResponse)?; + let mut path = url.path().to_owned(); + if let Some(query) = url.query() { + path.push('?'); + path.push_str(query); + } + return Ok((SocketAddr::new(ip, port), path)); + } + Err(SearchError::InvalidResponse) +} + +pub(super) fn parse_control_urls(response: R) -> Result<(String, String, String), SearchError> +where + R: io::Read, +{ + let root = Element::parse(response)?; + root.children + .iter() + .filter_map(|child| child.as_element()) + .find(|child| child.name == "device") + .and_then(parse_device) + .ok_or(SearchError::InvalidResponse) +} + +fn parse_device(device: &Element) -> Option<(String, String, String)> { + let service = device.get_child("serviceList").and_then(|list| { + list.children + .iter() + .filter_map(|child| child.as_element()) + .filter(|child| child.name == "service") + .find_map(parse_service) + }); + service.or_else(|| { + device.get_child("deviceList").and_then(|list| { + list.children + .iter() + .filter_map(|child| child.as_element()) + .filter(|child| child.name == "device") + .find_map(parse_device) + }) + }) +} + +fn parse_service(service: &Element) -> Option<(String, String, String)> { + let service_type = service.get_child("serviceType")?.get_text()?.into_owned(); + if ![ + "urn:schemas-upnp-org:service:WANPPPConnection:1", + "urn:schemas-upnp-org:service:WANIPConnection:1", + "urn:schemas-upnp-org:service:WANIPConnection:2", + ] + .contains(&service_type.as_str()) + { + return None; + } + + let schema_url = service.get_child("SCPDURL")?.get_text()?.into_owned(); + let control_url = service.get_child("controlURL")?.get_text()?.into_owned(); + Some((service_type, schema_url, control_url)) +} + +pub(super) fn parse_schemas(response: R) -> Result>, SearchError> +where + R: io::Read, +{ + let root = Element::parse(response)?; + root.children + .iter() + .filter_map(|child| child.as_element()) + .find(|child| child.name == "actionList") + .map(parse_action_list) + .ok_or(SearchError::InvalidResponse) +} + +fn parse_action_list(action_list: &Element) -> HashMap> { + action_list + .children + .iter() + .filter_map(|child| child.as_element()) + .filter(|child| child.name == "action") + .filter_map(parse_action) + .collect() +} + +fn parse_action(action: &Element) -> Option<(String, Vec)> { + let name = action.get_child("name")?.get_text()?.into_owned(); + let arguments = action + .get_child("argumentList")? + .children + .iter() + .filter_map(|child| child.as_element()) + .filter(|child| child.name == "argument") + .filter_map(parse_input_argument) + .collect(); + Some((name, arguments)) +} + +fn parse_input_argument(argument: &Element) -> Option { + if argument.get_child("direction")?.get_text()?.as_ref() != "in" { + return None; + } + argument + .get_child("name")? + .get_text() + .map(|name| name.into_owned()) +} + +pub(super) struct RequestResponse { + text: String, + xml: Element, +} + +pub(super) type RequestResult = Result; + +pub(super) fn parse_response(text: String, expected: &str) -> RequestResult { + let mut xml = + Element::parse(text.as_bytes()).map_err(|_| RequestError::InvalidResponse(text.clone()))?; + let body = xml + .get_mut_child("Body") + .ok_or_else(|| RequestError::InvalidResponse(text.clone()))?; + if let Some(response) = body.take_child(expected) { + return Ok(RequestResponse { + text, + xml: response, + }); + } + + let upnp_error = body + .get_child("Fault") + .and_then(|fault| fault.get_child("detail")) + .and_then(|detail| detail.get_child("UPnPError")) + .ok_or_else(|| RequestError::InvalidResponse(text.clone()))?; + let code = upnp_error + .get_child("errorCode") + .and_then(Element::get_text) + .and_then(|value| value.parse::().ok()) + .ok_or_else(|| RequestError::InvalidResponse(text.clone()))?; + let description = upnp_error + .get_child("errorDescription") + .and_then(Element::get_text) + .map(|value| value.into_owned()) + .ok_or_else(|| RequestError::InvalidResponse(text.clone()))?; + Err(RequestError::ErrorCode(code, description)) +} + +#[cfg(test)] +pub(super) fn parse_get_external_ip_response( + result: RequestResult, +) -> Result { + match result { + Ok(response) => response + .xml + .get_child("NewExternalIPAddress") + .and_then(Element::get_text) + .and_then(|text| text.parse().ok()) + .ok_or_else(|| { + GetExternalIpError::RequestError(RequestError::InvalidResponse(response.text)) + }), + Err(RequestError::ErrorCode(606, _)) => Err(GetExternalIpError::ActionNotAuthorized), + Err(error) => Err(GetExternalIpError::RequestError(error)), + } +} + +pub(super) fn parse_add_any_port_mapping_response( + result: RequestResult, +) -> Result { + match result { + Ok(response) => response + .xml + .get_child("NewReservedPort") + .and_then(Element::get_text) + .and_then(|text| text.parse().ok()) + .ok_or_else(|| { + AddAnyPortError::RequestError(RequestError::InvalidResponse(response.text)) + }), + Err(error) => Err(match error { + RequestError::ErrorCode(605, _) => AddAnyPortError::DescriptionTooLong, + RequestError::ErrorCode(606, _) => AddAnyPortError::ActionNotAuthorized, + RequestError::ErrorCode(728, _) => AddAnyPortError::NoPortsAvailable, + other => AddAnyPortError::RequestError(other), + }), + } +} + +pub(super) fn convert_add_random_port_mapping_error( + error: RequestError, +) -> Option { + match error { + RequestError::ErrorCode(724, _) => None, + RequestError::ErrorCode(605, _) => Some(AddAnyPortError::DescriptionTooLong), + RequestError::ErrorCode(606, _) => Some(AddAnyPortError::ActionNotAuthorized), + RequestError::ErrorCode(718, _) => Some(AddAnyPortError::NoPortsAvailable), + RequestError::ErrorCode(725, _) => Some(AddAnyPortError::OnlyPermanentLeasesSupported), + other => Some(AddAnyPortError::RequestError(other)), + } +} + +pub(super) fn convert_add_same_port_mapping_error(error: RequestError) -> AddAnyPortError { + match error { + RequestError::ErrorCode(606, _) => AddAnyPortError::ActionNotAuthorized, + RequestError::ErrorCode(718, _) => AddAnyPortError::ExternalPortInUse, + RequestError::ErrorCode(725, _) => AddAnyPortError::OnlyPermanentLeasesSupported, + other => AddAnyPortError::RequestError(other), + } +} + +pub(super) fn convert_add_port_error(error: RequestError) -> AddPortError { + match error { + RequestError::ErrorCode(605, _) => AddPortError::DescriptionTooLong, + RequestError::ErrorCode(606, _) => AddPortError::ActionNotAuthorized, + RequestError::ErrorCode(718, _) => AddPortError::PortInUse, + RequestError::ErrorCode(724, _) => AddPortError::SamePortValuesRequired, + RequestError::ErrorCode(725, _) => AddPortError::OnlyPermanentLeasesSupported, + other => AddPortError::RequestError(other), + } +} + +pub(super) fn parse_delete_port_mapping_response( + result: RequestResult, +) -> Result<(), RemovePortError> { + match result { + Ok(_) => Ok(()), + Err(RequestError::ErrorCode(606, _)) => Err(RemovePortError::ActionNotAuthorized), + Err(RequestError::ErrorCode(714, _)) => Err(RemovePortError::NoSuchPortMapping), + Err(error) => Err(RemovePortError::RequestError(error)), + } +} + +#[cfg(test)] +pub(super) fn parse_get_generic_port_mapping_entry( + result: RequestResult, +) -> Result { + let response = result?; + let xml = response.xml; + let invalid = |message: String| { + GetGenericPortMappingEntryError::RequestError(RequestError::InvalidResponse(message)) + }; + let field = |name: &str| { + xml.get_child(name) + .ok_or_else(|| invalid(format!("{name} is missing"))) + }; + field("NewRemoteHost")?; + let external_port = parse_number(&xml, "NewExternalPort")?; + let protocol = match field("NewProtocol")?.get_text().as_deref() { + Some("UDP") => PortMappingProtocol::Udp, + Some("TCP") => PortMappingProtocol::Tcp, + _ => return Err(invalid("NewProtocol is invalid".to_owned())), + }; + let internal_port = parse_number(&xml, "NewInternalPort")?; + let internal_client = field("NewInternalClient")? + .get_text() + .map(|text| text.into_owned()) + .ok_or_else(|| invalid("NewInternalClient is empty".to_owned()))?; + match parse_number::(&xml, "NewEnabled")? { + 0 | 1 => {} + _ => return Err(invalid("NewEnabled is invalid".to_owned())), + } + let port_mapping_description = field("NewPortMappingDescription")? + .get_text() + .map(|text| text.into_owned()) + .unwrap_or_default(); + parse_number::(&xml, "NewLeaseDuration")?; + + Ok(PortMappingEntry { + external_port, + protocol, + internal_port, + internal_client, + port_mapping_description, + }) +} + +#[cfg(test)] +fn parse_number( + xml: &Element, + name: &str, +) -> Result { + xml.get_child(name) + .and_then(Element::get_text) + .and_then(|text| text.parse().ok()) + .ok_or_else(|| { + GetGenericPortMappingEntryError::RequestError(RequestError::InvalidResponse(format!( + "{name} is missing or invalid" + ))) + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn search_location_is_case_insensitive_and_keeps_query() { + let (address, path) = parse_search_result( + "HTTP/1.1 200 OK\r\nLOCATION: http://192.168.1.1:5431/root.xml?v=2\r\n", + ) + .unwrap(); + assert_eq!(address, "192.168.1.1:5431".parse().unwrap()); + assert_eq!(path, "/root.xml?v=2"); + } + + #[test] + fn nested_ppp_service_is_discovered() { + let description = r#" + + + urn:schemas-upnp-org:service:WANPPPConnection:1 + /control + /schema.xml + + + "#; + assert_eq!( + parse_control_urls(description.as_bytes()).unwrap(), + ( + "urn:schemas-upnp-org:service:WANPPPConnection:1".to_owned(), + "/schema.xml".to_owned(), + "/control".to_owned(), + ) + ); + } + + #[test] + fn device_description_uses_declared_xml_encoding() { + let description = r#" + + urn:schemas-upnp-org:service:WANIPConnection:1 + /control + /schema.xml + "#; + let mut encoded = vec![0xff, 0xfe]; + for code_unit in description.encode_utf16() { + encoded.extend_from_slice(&code_unit.to_le_bytes()); + } + + assert_eq!( + parse_control_urls(encoded.as_slice()).unwrap(), + ( + "urn:schemas-upnp-org:service:WANIPConnection:1".to_owned(), + "/schema.xml".to_owned(), + "/control".to_owned(), + ) + ); + } + + #[test] + fn schema_contains_only_input_arguments() { + let schema = r#" + AddPortMapping + NewExternalPortin + Resultout + NewProtocolin + + "#; + assert_eq!( + parse_schemas(schema.as_bytes()).unwrap()["AddPortMapping"], + ["NewExternalPort", "NewProtocol"] + ); + } + + #[test] + fn soap_fault_preserves_error_code() { + let response = r#" + + 713SpecifiedArrayIndexInvalid + + "#; + assert!(matches!( + parse_response(response.to_owned(), "GetGenericPortMappingEntryResponse"), + Err(RequestError::ErrorCode(713, _)) + )); + } +} diff --git a/vendor/easytier/easytier/src/instance/cli_event_logger.rs b/vendor/easytier/easytier/src/instance/cli_event_logger.rs new file mode 100644 index 0000000..f88c4df --- /dev/null +++ b/vendor/easytier/easytier/src/instance/cli_event_logger.rs @@ -0,0 +1,272 @@ +use std::fmt::{Display, Formatter}; + +use uuid::Uuid; + +use crate::{ + common::{ + global_ctx::{EventBusSubscriber, GlobalCtxEvent}, + log, + }, + proto, +}; + +struct DisplayPeerConnInfo<'a>(&'a proto::api::instance::PeerConnInfo); + +impl Display for DisplayPeerConnInfo<'_> { + fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("PeerConnInfo") + .field("my_peer_id", &self.0.my_peer_id) + .field("dst_peer_id", &self.0.peer_id) + .field("tunnel_info", &self.0.tunnel) + .finish() + } +} + +macro_rules! event { + ($lvl:ident, category: $cat:expr, $($args:tt)+) => { + event!(@impl $lvl, concat!("INSTANCE::", $cat), $($args)+) + }; + + ($lvl:ident, $($args:tt)+) => { + event!(@impl $lvl, "INSTANCE", $($args)+) + }; + + (@impl $lvl:ident, $cat:expr, $($args:tt)+) => { + log::$lvl!( + category: $cat, + $($args)+ + ); + }; +} + +pub(super) fn spawn(instance_id: Uuid, events: EventBusSubscriber) { + drop(tokio::spawn(log_events(instance_id, events))); +} + +async fn log_events(instance_id: Uuid, mut events: EventBusSubscriber) { + loop { + match events.recv().await { + Ok(event) => log_event(instance_id, event), + Err(tokio::sync::broadcast::error::RecvError::Closed) => return, + Err(tokio::sync::broadcast::error::RecvError::Lagged(_)) => continue, + } + } +} + +fn log_event(instance_id: Uuid, event: GlobalCtxEvent) { + match event { + GlobalCtxEvent::PeerAdded(peer_id) => { + event!(info, peer_id, "[{}] new peer added", instance_id); + } + GlobalCtxEvent::PeerRemoved(peer_id) => { + event!(info, peer_id, "[{}] peer removed", instance_id); + } + GlobalCtxEvent::PeerConnAdded(conn_info) => { + let conn_info = DisplayPeerConnInfo(&conn_info); + event!( + info, + category: "CONNECTION", + %conn_info, + "[{}] new peer connection added", + instance_id, + ); + } + GlobalCtxEvent::PeerConnRemoved(conn_info) => { + let conn_info = DisplayPeerConnInfo(&conn_info); + event!( + info, + category: "CONNECTION", + %conn_info, + "[{}] peer connection removed", + instance_id, + ); + } + GlobalCtxEvent::ListenerAddFailed(listener, msg) => { + event!(warn, %listener, msg, "[{}] listener add failed", instance_id); + } + GlobalCtxEvent::ListenerAcceptFailed(listener, msg) => { + event!(warn, %listener, msg, "[{}] listener accept failed", instance_id); + } + GlobalCtxEvent::ListenerAdded(listener) => { + if listener.scheme() == "ring" { + return; + } + event!( + info, + %listener, + "[{}] new listener added", + instance_id + ); + } + GlobalCtxEvent::ConnectionAccepted(local, remote) => { + event!( + info, + category: "CONNECTION", + local, + remote, + "[{}] new connection accepted", + instance_id + ); + } + GlobalCtxEvent::ConnectionError(local, remote, err) => { + event!( + info, + category: "CONNECTION", + local, + remote, + err, + "[{}] connection error", + instance_id + ); + } + GlobalCtxEvent::ListenerPortMappingEstablished { + local_listener, + mapped_listener, + backend, + } => { + event!( + info, + %local_listener, + %mapped_listener, + backend, + "[{}] listener port mapping established", + instance_id + ); + } + GlobalCtxEvent::TunDeviceReady(dev) => { + event!(info, dev, "[{}] tun device ready", instance_id); + } + GlobalCtxEvent::TunDeviceError(err) => { + event!(error, %err, "[{}] tun device error", instance_id); + } + GlobalCtxEvent::Connecting(dst) => { + event!( + info, + category: "CONNECTION", + %dst, + "[{}] connecting to peer", + instance_id + ); + } + GlobalCtxEvent::ConnectError(dst, ip_version, error) => { + event!( + info, + category: "CONNECTION", + dst, + ip_version, + %error, + "[{}] connect to peer error", + instance_id + ); + } + GlobalCtxEvent::VpnPortalStarted(portal) => { + event!(info, portal, "[{}] vpn portal started", instance_id); + } + GlobalCtxEvent::VpnPortalClientConnected(portal, client_addr) => { + event!( + info, + portal, + client_addr, + "[{}] vpn portal client connected", + instance_id + ); + } + GlobalCtxEvent::VpnPortalClientDisconnected(portal, client_addr) => { + event!( + info, + portal, + client_addr, + "[{}] vpn portal client disconnected", + instance_id + ); + } + GlobalCtxEvent::DhcpIpv4Changed(old, new) => { + event!(info, ?old, ?new, "[{}] dhcp ip changed", instance_id); + } + GlobalCtxEvent::DhcpIpv4Conflicted(ip) => { + event!(info, ?ip, "[{}] dhcp ip conflict", instance_id); + } + GlobalCtxEvent::PublicIpv6Changed(old, new) => { + event!(info, ?old, ?new, "[{}] public ipv6 changed", instance_id); + } + GlobalCtxEvent::PublicIpv6RoutesUpdated(added, removed) => { + event!( + info, + ?added, + ?removed, + "[{}] public ipv6 routes updated", + instance_id + ); + } + GlobalCtxEvent::PortForwardAdded(cfg) => { + event!( + info, + local = %cfg.bind_addr.unwrap(), + remote = %cfg.dst_addr.unwrap(), + proto = %cfg.socket_type().as_str_name(), + "[{}] port forward added", + instance_id, + ); + } + #[cfg(feature = "management")] + GlobalCtxEvent::ConfigPatched(patch) => { + event!(info, ?patch, "[{}] config patched", instance_id); + } + GlobalCtxEvent::ProxyCidrsUpdated(added, removed) => { + event!( + info, + ?added, + ?removed, + "[{}] proxy CIDRs updated", + instance_id + ); + } + GlobalCtxEvent::UdpBroadcastRelayStartResult { + capture_backend, + error, + } => { + if let Some(error) = error { + event!( + warn, + ?capture_backend, + %error, + "[{}] UDP broadcast relay start failed", + instance_id + ); + } else { + event!( + info, + ?capture_backend, + "[{}] UDP broadcast relay started", + instance_id + ); + } + } + GlobalCtxEvent::CredentialChanged => { + event!(info, "[{}] credential changed", instance_id); + } + } +} + +#[cfg(test)] +mod tests { + use std::time::Duration; + + use tokio::sync::broadcast; + + use super::*; + + #[tokio::test] + async fn event_loop_stops_when_the_instance_closes() { + let (sender, events) = broadcast::channel(1); + let task = tokio::spawn(log_events(Uuid::new_v4(), events)); + + sender.send(GlobalCtxEvent::CredentialChanged).unwrap(); + drop(sender); + tokio::time::timeout(Duration::from_secs(1), task) + .await + .unwrap() + .unwrap(); + } +} diff --git a/vendor/easytier/easytier/src/instance/composition.rs b/vendor/easytier/easytier/src/instance/composition.rs new file mode 100644 index 0000000..05e8ba7 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/composition.rs @@ -0,0 +1,584 @@ +use std::sync::Arc; + +#[cfg(feature = "wrapped-transport")] +use easytier_core::gateway::proxy::wrapped_transport::WrappedTransportEngines; +#[cfg(feature = "wireguard")] +use easytier_core::gateway::vpn_portal::PortalHost; +#[cfg(test)] +use easytier_core::host::packet::{HostPacket, PacketSink}; +#[cfg(feature = "web-client")] +use easytier_core::{ + connectivity::manual::ManualTunnelConnector, + host::dns::{DnsRecordResolver, DnsResolver}, +}; +use easytier_core::{ + events::{CoreEvent, CoreEventSink}, + instance::{CoreHostAdapters, CoreInstance, CoreInstanceConfig, PacketEgressHost}, + process_runtime::CoreProcessRuntime, +}; + +use crate::common::global_ctx::GlobalCtxEvent; +#[cfg(feature = "public-ipv6-provider")] +use crate::instance::public_ipv6_provider::runtime_public_ipv6_provider_platform; +use crate::{ + common::global_ctx::ArcGlobalCtx, + common::{config::TomlConfig, global_ctx::GlobalCtx}, + host_runtime::native_host_runtime, + instance::config::{ + compact_runtime_core_host_config, runtime_core_host_config, runtime_peer_credential_storage, + }, + instance::listeners::RuntimeExternalListenerFactory, + instance::runtime_host::NativeInstanceRuntimeHost, +}; + +use super::host::{NativeInstanceHost, native_instance_host}; +#[cfg(feature = "kcp")] +use crate::gateway::kcp_proxy::KcpProxyService; +#[cfg(feature = "quic")] +use crate::gateway::quic_proxy::QuicProxyService; +use crate::tunnel::protocol::{runtime_client_protocol_upgrader, runtime_server_protocol_upgrader}; +#[cfg(any(feature = "kcp", feature = "quic"))] +use easytier_core::gateway::proxy::wrapped_transport::WrappedTransportEngine; + +pub(crate) type NativeCoreInstance = CoreInstance; + +pub(crate) fn compose_native_core_instance( + toml_config: TomlConfig, + process_runtime: Arc, + compact_runtime: bool, +) -> anyhow::Result> { + let host_config = if compact_runtime { + compact_runtime_core_host_config() + } else { + runtime_core_host_config() + }; + let normalized = CoreInstanceConfig::from_toml_with_host(&toml_config, &host_config)?; + let global_ctx = Arc::new(GlobalCtx::new_with_runtime_config( + toml_config.clone(), + &normalized, + &host_config, + )); + let runtime_host = NativeInstanceRuntimeHost::new(global_ctx.clone()); + let mut adapters = runtime_core_host_adapters_with_packet_egress_and_config( + global_ctx.clone(), + process_runtime, + runtime_host.clone(), + host_config, + ); + adapters.instance_runtime = runtime_host; + NativeCoreInstance::from_toml(toml_config, adapters) +} + +impl CoreEventSink for GlobalCtx { + fn emit(&self, event: CoreEvent) { + let event = match event { + CoreEvent::PeerAdded(peer_id) => GlobalCtxEvent::PeerAdded(peer_id), + CoreEvent::PeerRemoved(peer_id) => GlobalCtxEvent::PeerRemoved(peer_id), + CoreEvent::PeerConnAdded(info) => GlobalCtxEvent::PeerConnAdded(info.into()), + CoreEvent::PeerConnRemoved(info) => GlobalCtxEvent::PeerConnRemoved(info.into()), + CoreEvent::CredentialChanged => GlobalCtxEvent::CredentialChanged, + CoreEvent::ManualConnecting { url } => GlobalCtxEvent::Connecting(url), + CoreEvent::ManualConnectError { + url, + ip_version, + error, + } => GlobalCtxEvent::ConnectError(url.to_string(), format!("{ip_version:?}"), error), + CoreEvent::ListenerPlanFailed { url, error } => { + GlobalCtxEvent::ListenerAddFailed(url, error) + } + CoreEvent::ListenerAdded { url, .. } => GlobalCtxEvent::ListenerAdded(url), + CoreEvent::ListenerRemoved { .. } | CoreEvent::ListenerSocketAccepted { .. } => return, + CoreEvent::ListenerAddFailed { + url, + error, + will_retry, + .. + } => { + let message = if will_retry { + format!("error: {error}, retry listen later...") + } else { + format!("error: {error}") + }; + GlobalCtxEvent::ListenerAddFailed(url, message) + } + CoreEvent::ListenerAcceptFailed { url, error } => GlobalCtxEvent::ListenerAcceptFailed( + url, + format!("error: {error}, retry listen later..."), + ), + CoreEvent::ListenerAcceptedSocketHandleFailed { url, error } => { + tracing::error!(%url, %error, "accepted socket handler failed"); + return; + } + CoreEvent::TunnelAccepted { + local_url, + remote_url, + } => GlobalCtxEvent::ConnectionAccepted(local_url, remote_url), + CoreEvent::TunnelAdmissionFailed { + local_url, + remote_url, + error, + } => GlobalCtxEvent::ConnectionError(local_url, remote_url, error), + CoreEvent::UdpPortMappingEstablished { + local_listener, + mapped_listener, + backend, + } => GlobalCtxEvent::ListenerPortMappingEstablished { + local_listener, + mapped_listener, + backend, + }, + CoreEvent::ProxyCidrsUpdated { added, removed } => { + GlobalCtxEvent::ProxyCidrsUpdated(added, removed) + } + CoreEvent::PublicIpv6LeaseChanged { old, new } => { + GlobalCtxEvent::PublicIpv6Changed(old, new) + } + CoreEvent::PublicIpv6RoutesChanged { added, removed } => { + GlobalCtxEvent::PublicIpv6RoutesUpdated(added, removed) + } + CoreEvent::VpnPortalStarted(portal) => GlobalCtxEvent::VpnPortalStarted(portal), + CoreEvent::VpnPortalClientConnected { portal, client } => { + GlobalCtxEvent::VpnPortalClientConnected(portal, client) + } + CoreEvent::VpnPortalClientDisconnected { portal, client } => { + GlobalCtxEvent::VpnPortalClientDisconnected(portal, client) + } + CoreEvent::GatewayPortForwardAdded(config) => { + GlobalCtxEvent::PortForwardAdded(config.into()) + } + }; + self.issue_event(event); + } +} + +#[cfg(feature = "wrapped-transport")] +fn runtime_wrapped_transport_engines( + config: &easytier_core::instance::CoreInstanceHostConfig, +) -> WrappedTransportEngines { + #[cfg(feature = "kcp")] + let kcp = config + .kcp_enabled + .then(|| Arc::new(KcpProxyService::new()) as Arc); + #[cfg(not(feature = "kcp"))] + let kcp = None; + #[cfg(feature = "quic")] + let quic = config + .quic_enabled + .then(|| Arc::new(QuicProxyService::new()) as Arc); + #[cfg(not(feature = "quic"))] + let quic = None; + + WrappedTransportEngines { kcp, quic } +} + +#[cfg(test)] +pub(crate) fn runtime_core_host_adapters( + global_ctx: ArcGlobalCtx, + process_runtime: Arc, + packet_sink: Arc, +) -> CoreHostAdapters { + let host = native_instance_host(global_ctx.clone()); + let runtime_dns = native_host_runtime(); + let adapters = CoreHostAdapters::new(host, runtime_dns, packet_sink, process_runtime); + configure_runtime_core_host_adapters(global_ctx, adapters, runtime_core_host_config()) +} + +#[cfg(test)] +pub(crate) fn runtime_core_host_adapters_with_packet_egress( + global_ctx: ArcGlobalCtx, + process_runtime: Arc, + packet_egress: Arc, +) -> CoreHostAdapters { + let host = native_instance_host(global_ctx.clone()); + let runtime_dns = native_host_runtime(); + let adapters = + CoreHostAdapters::new_with_packet_egress(host, runtime_dns, packet_egress, process_runtime); + configure_runtime_core_host_adapters(global_ctx, adapters, runtime_core_host_config()) +} + +fn runtime_core_host_adapters_with_packet_egress_and_config( + global_ctx: ArcGlobalCtx, + process_runtime: Arc, + packet_egress: Arc, + host_config: easytier_core::instance::CoreInstanceHostConfig, +) -> CoreHostAdapters { + let host = native_instance_host(global_ctx.clone()); + let runtime_dns = native_host_runtime(); + let adapters = + CoreHostAdapters::new_with_packet_egress(host, runtime_dns, packet_egress, process_runtime); + configure_runtime_core_host_adapters(global_ctx, adapters, host_config) +} + +fn configure_runtime_core_host_adapters( + global_ctx: ArcGlobalCtx, + mut adapters: CoreHostAdapters, + host_config: easytier_core::instance::CoreInstanceHostConfig, +) -> CoreHostAdapters { + #[cfg(test)] + adapters.replace_stun_provider(Arc::new(crate::common::stun::MockStunInfoCollector { + udp_nat_type: crate::proto::common::NatType::Unknown, + })); + adapters.config = host_config.clone(); + adapters.credential_storage = (!host_config.ignore_unsupported_config) + .then(|| runtime_peer_credential_storage(&global_ctx)) + .flatten(); + adapters.events = global_ctx.clone(); + #[cfg(feature = "wrapped-transport")] + { + adapters.wrapped_transports = runtime_wrapped_transport_engines(&host_config); + } + adapters.protocol = Some(runtime_client_protocol_upgrader(global_ctx.clone())); + adapters.external_listener_factory = Some(Arc::new(RuntimeExternalListenerFactory)); + adapters.server_protocol = Some(runtime_server_protocol_upgrader(global_ctx.clone())); + #[cfg(feature = "upnp")] + if host_config.upnp_enabled { + adapters.udp_hole_punch_platform = Some( + crate::instance::udp_hole_punch::runtime_udp_hole_punch_platform( + global_ctx.net_ns.clone(), + ), + ); + } + #[cfg(feature = "icmp-proxy")] + { + adapters.icmp_proxy_host = Some(Arc::new(crate::gateway::icmp_proxy::RuntimeIcmpProxyHost)); + } + #[cfg(feature = "proxy-cidr-monitor")] + { + adapters.proxy_cidr_monitor_enabled = true; + } + #[cfg(feature = "public-ipv6-provider")] + if host_config.public_ipv6_provider_supported { + adapters.public_ipv6_host = Some(global_ctx.clone()); + adapters.public_ipv6_provider = Some(runtime_public_ipv6_provider_platform(&global_ctx)); + } + #[cfg(feature = "wireguard")] + if host_config.vpn_portal_enabled { + use crate::common::config::ConfigLoader as _; + + if let Some(config) = global_ctx + .config + .get_vpn_portal_config() + .filter(|config| config.enabled != Some(false)) + { + adapters.vpn_portal = Some(crate::vpn_portal::wireguard::WireGuardPortalHost::new( + global_ctx.clone(), + config, + ) as Arc); + } + } + adapters +} + +#[cfg(feature = "web-client")] +pub(crate) fn runtime_one_shot_manual_connector( + global_ctx: ArcGlobalCtx, + config: &TomlConfig, + process_runtime: Arc, +) -> anyhow::Result> { + let normalized = CoreInstanceConfig::from_toml_with_host(config, &runtime_core_host_config())?; + let host = native_instance_host(global_ctx.clone()); + let runtime_dns = native_host_runtime(); + let dns: Arc = runtime_dns.clone(); + let dns_records: Arc = runtime_dns; + Ok(process_runtime.manual_connector( + host, + dns, + dns_records, + runtime_client_protocol_upgrader(global_ctx.clone()), + normalized.connectivity.endpoint_discovery, + normalized.connectivity.manual, + )) +} + +#[cfg(test)] +mod tests { + use std::sync::Arc; + + #[cfg(feature = "kcp")] + use easytier_core::gateway::proxy::wrapped_transport::{ + WrappedTransportConnect, WrappedTransportEngine, + }; + use easytier_core::listener::plan::ListenerRuntimeConfig; + use smoltcp::wire::{IpAddress, IpProtocol, Ipv4Packet, UdpPacket}; + #[cfg(feature = "kcp")] + use tokio::io::{AsyncReadExt, AsyncWriteExt}; + + #[cfg(feature = "kcp")] + use crate::gateway::kcp_proxy::KcpProxyService; + use crate::{ + common::{config::NetworkIdentity, global_ctx::tests::get_mock_global_ctx_with_network}, + instance::config::test_core_instance_config, + }; + + use super::*; + + fn create_host_packet_channel() -> ( + tokio::sync::mpsc::Sender>, + tokio::sync::mpsc::Receiver>, + ) { + tokio::sync::mpsc::channel(16) + } + + #[cfg(feature = "kcp")] + fn build_native_kcp_test_instance( + global_ctx: ArcGlobalCtx, + packet_sink: tokio::sync::mpsc::Sender>, + listeners: Option, + ) -> anyhow::Result<(Arc, Arc)> { + let mut adapters = runtime_core_host_adapters( + global_ctx.clone(), + CoreProcessRuntime::new(), + Arc::new(packet_sink), + ); + adapters.proxy_cidr_monitor_enabled = false; + let service = Arc::new(KcpProxyService::new()); + adapters.wrapped_transports = WrappedTransportEngines { + kcp: Some(service.clone()), + quic: None, + }; + + let mut config = test_core_instance_config(&global_ctx); + config.connectivity.listeners = listeners; + config.connectivity.startup_plan.gateway = false; + config.connectivity.stun.udp_servers.clear(); + config.connectivity.stun.tcp_servers.clear(); + config.connectivity.stun.udp_v6_servers.clear(); + config.connectivity.manual = Default::default(); + config.connectivity.direct.testing = true; + + let instance = NativeCoreInstance::new(config, adapters)?; + Ok((instance, service)) + } + + #[cfg(feature = "kcp")] + #[tokio::test] + async fn native_kcp_engine_round_trips_through_portable_cores() { + tokio::time::timeout(std::time::Duration::from_secs(20), async { + const REQUEST: &[u8] = b"native-kcp-request"; + const REPLY: &[u8] = b"native-kcp-reply"; + + let global_a = get_mock_global_ctx_with_network(Some(NetworkIdentity::new( + "native-kcp-round-trip".to_owned(), + "shared-secret".to_owned(), + ))); + let global_b = get_mock_global_ctx_with_network(Some(NetworkIdentity::new( + "native-kcp-round-trip".to_owned(), + "shared-secret".to_owned(), + ))); + global_a.set_ipv4(Some("10.250.0.1/24".parse().unwrap())); + global_b.set_ipv4(Some("10.250.0.2/24".parse().unwrap())); + + let mut flags_a = global_a.get_flags(); + flags_a.enable_kcp_proxy = true; + flags_a.disable_kcp_input = true; + flags_a.disable_tcp_hole_punching = true; + flags_a.disable_udp_hole_punching = true; + flags_a.disable_sym_hole_punching = true; + flags_a.disable_upnp = true; + global_a.set_flags(flags_a); + + let mut flags_b = global_b.get_flags(); + flags_b.enable_kcp_proxy = false; + flags_b.disable_kcp_input = false; + flags_b.disable_tcp_hole_punching = true; + flags_b.disable_udp_hole_punching = true; + flags_b.disable_sym_hole_punching = true; + flags_b.disable_upnp = true; + global_b.set_flags(flags_b); + + let (packet_sink_a, _packet_receiver_a) = create_host_packet_channel(); + let (packet_sink_b, _packet_receiver_b) = create_host_packet_channel(); + let (instance_a, kcp_a) = build_native_kcp_test_instance( + global_a.clone(), + packet_sink_a, + Some(ListenerRuntimeConfig::new( + vec!["tcp://127.0.0.1:0".parse().unwrap()], + false, + test_core_instance_config(&global_a) + .connectivity + .direct + .tcp_bind + .context, + )), + ) + .unwrap(); + let (instance_b, _kcp_b) = + build_native_kcp_test_instance(global_b, packet_sink_b, None).unwrap(); + + let (start_a, start_b) = tokio::join!(instance_a.start(), instance_b.start()); + start_a.unwrap(); + start_b.unwrap(); + + let listener = instance_a.running_listeners().pop().unwrap(); + instance_b.add_connector(listener).unwrap(); + let peer_a_id = instance_a.peer_id(); + let peer_b_id = instance_b.peer_id(); + loop { + let a_peers = instance_a.connected_peers().await; + let b_peers = instance_b.connected_peers().await; + if a_peers.contains(&peer_b_id) && b_peers.contains(&peer_a_id) { + break; + } + tokio::time::sleep(std::time::Duration::from_millis(20)).await; + } + + let echo_listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let echo_addr = echo_listener.local_addr().unwrap(); + let responder = tokio::spawn(async move { + let (mut socket, _) = echo_listener.accept().await.unwrap(); + let mut request = [0; REQUEST.len()]; + socket.read_exact(&mut request).await.unwrap(); + assert_eq!(&request, REQUEST); + socket.write_all(REPLY).await.unwrap(); + }); + + let mut stream = kcp_a + .connect_source(WrappedTransportConnect { + my_peer_id: peer_a_id, + dst_peer_id: peer_b_id, + src: "10.250.0.1:40000".parse().unwrap(), + dst: echo_addr, + }) + .await + .unwrap(); + stream.write_all(REQUEST).await.unwrap(); + let mut reply = [0; REPLY.len()]; + stream.read_exact(&mut reply).await.unwrap(); + assert_eq!(&reply, REPLY); + responder.await.unwrap(); + + instance_b.stop().await; + instance_a.stop().await; + }) + .await + .expect("native KCP round trip timed out"); + } + + #[tokio::test] + async fn portable_core_instances_connect_through_core_tcp_listener() { + let global_a = get_mock_global_ctx_with_network(Some(NetworkIdentity::new( + "portable-connect-listen".to_owned(), + "shared-secret".to_owned(), + ))); + let global_b = get_mock_global_ctx_with_network(Some(NetworkIdentity::new( + "portable-connect-listen".to_owned(), + "shared-secret".to_owned(), + ))); + global_a.set_ipv4(Some("10.250.0.1/24".parse().unwrap())); + global_b.set_ipv4(Some("10.250.0.2/24".parse().unwrap())); + let (packet_sink_a, _packet_receiver_a) = create_host_packet_channel(); + let (packet_sink_b, mut packet_receiver_b) = create_host_packet_channel(); + let mut config_a = test_core_instance_config(&global_a); + config_a.connectivity.initial_peers.clear(); + config_a.connectivity.listeners = Some(ListenerRuntimeConfig::new( + vec!["tcp://127.0.0.1:0".parse().unwrap()], + false, + config_a.connectivity.direct.tcp_bind.context.clone(), + )); + config_a.connectivity.runtime = Default::default(); + config_a.connectivity.stun.udp_servers.clear(); + config_a.connectivity.stun.tcp_servers.clear(); + config_a.connectivity.stun.udp_v6_servers.clear(); + config_a.connectivity.manual = Default::default(); + config_a.connectivity.direct.testing = true; + let instance_a = NativeCoreInstance::new( + config_a, + runtime_core_host_adapters( + global_a.clone(), + CoreProcessRuntime::new(), + Arc::new(packet_sink_a), + ), + ) + .unwrap(); + + let mut config_b = test_core_instance_config(&global_b); + config_b.connectivity.initial_peers.clear(); + config_b.connectivity.listeners = None; + config_b.connectivity.runtime = Default::default(); + config_b.connectivity.stun.udp_servers.clear(); + config_b.connectivity.stun.tcp_servers.clear(); + config_b.connectivity.stun.udp_v6_servers.clear(); + config_b.connectivity.manual = Default::default(); + config_b.connectivity.direct.testing = true; + let instance_b = NativeCoreInstance::new( + config_b, + runtime_core_host_adapters( + global_b.clone(), + CoreProcessRuntime::new(), + Arc::new(packet_sink_b), + ), + ) + .unwrap(); + + let (start_a, start_b) = tokio::join!(instance_a.start(), instance_b.start()); + start_a.unwrap(); + start_b.unwrap(); + let listener = instance_a.running_listeners().pop().unwrap(); + instance_b.add_connector(listener).unwrap(); + + let peer_a_id = instance_a.peer_id(); + let peer_b_id = instance_b.peer_id(); + tokio::time::timeout(std::time::Duration::from_secs(10), async { + loop { + let a_peers = instance_a.connected_peers().await; + let b_peers = instance_b.connected_peers().await; + if a_peers.contains(&peer_b_id) && b_peers.contains(&peer_a_id) { + break; + } + tokio::time::sleep(std::time::Duration::from_millis(20)).await; + } + }) + .await + .expect("portable core instances did not connect through the core listener"); + + let source_ip = "10.250.0.1".parse().unwrap(); + let destination_ip = "10.250.0.2".parse().unwrap(); + let mut ip_packet = vec![0u8; 28]; + { + let mut ipv4 = Ipv4Packet::new_unchecked(&mut ip_packet); + ipv4.set_version(4); + ipv4.set_header_len(20); + ipv4.set_total_len(28); + ipv4.set_hop_limit(64); + ipv4.set_next_header(IpProtocol::Udp); + ipv4.set_src_addr(source_ip); + ipv4.set_dst_addr(destination_ip); + } + { + let mut udp = UdpPacket::new_unchecked(&mut ip_packet[20..]); + udp.set_src_port(10000); + udp.set_dst_port(10001); + udp.set_len(8); + udp.fill_checksum( + &IpAddress::Ipv4(source_ip), + &IpAddress::Ipv4(destination_ip), + ); + } + Ipv4Packet::new_unchecked(&mut ip_packet).fill_checksum(); + let received = tokio::time::timeout(std::time::Duration::from_secs(10), async { + loop { + instance_a + .packet_plane() + .send_ip_packet(HostPacket::copy_from_payload(&ip_packet)) + .await + .unwrap(); + match tokio::time::timeout( + std::time::Duration::from_millis(100), + packet_receiver_b.recv(), + ) + .await + { + Ok(Some(packet)) => break packet, + Ok(None) => panic!("portable host packet sink closed"), + Err(_) => {} + } + } + }) + .await + .expect("portable host packet sink did not receive the IP packet"); + assert_eq!(received, ip_packet); + + instance_b.stop().await; + instance_a.stop().await; + } +} diff --git a/vendor/easytier/easytier/src/instance/config.rs b/vendor/easytier/easytier/src/instance/config.rs new file mode 100644 index 0000000..1716b1e --- /dev/null +++ b/vendor/easytier/easytier/src/instance/config.rs @@ -0,0 +1,224 @@ +use std::sync::Arc; + +use easytier_core::{ + config::peers::HostRoutingPolicy, + instance::{CoreConnectivityMode, CoreInstanceHostConfig}, + peers::credential_manager::CredentialStorage, +}; +use strum::VariantArray as _; + +#[cfg(feature = "management")] +use crate::common::credential_manager::runtime_credential_storage; +#[cfg(test)] +use crate::common::global_ctx::GlobalCtxEvent; +use crate::{ + common::{constants::EASYTIER_VERSION, global_ctx::ArcGlobalCtx}, + tunnel::IpScheme, +}; + +/// Projects only native Host policy and build capabilities. All TOML-derived +/// Instance configuration is normalized by `easytier-core`. +pub(crate) fn runtime_core_host_config() -> CoreInstanceHostConfig { + let hostname = gethostname::gethostname().to_string_lossy().to_string(); + CoreInstanceHostConfig { + hostname_fallback: (!hostname.is_empty()).then_some(hostname), + host_routing: HostRoutingPolicy { + local_exit_node_fallback: cfg!(target_env = "ohos"), + }, + force_exit_node: cfg!(target_env = "ohos"), + allow_interface_bind: !cfg!(any( + target_os = "android", + target_os = "ios", + all(target_os = "macos", feature = "macos-ne"), + target_env = "ohos" + )), + smoltcp_available: cfg!(feature = "smoltcp"), + requires_smoltcp: cfg!(any( + target_os = "android", + target_os = "ios", + all(target_os = "macos", feature = "macos-ne"), + target_env = "ohos" + )), + icmp_failure_is_fatal: cfg!(not(any( + target_os = "android", + target_os = "ios", + all(target_os = "macos", feature = "macos-ne"), + target_env = "ohos" + ))), + public_ipv6_provider_supported: cfg!(all( + target_os = "linux", + feature = "public-ipv6-provider" + )), + gateway_enabled: cfg!(feature = "socks5"), + proxy_enabled: cfg!(any( + feature = "kcp", + feature = "quic", + feature = "proxy-packet" + )), + vpn_portal_enabled: cfg!(feature = "wireguard"), + magic_dns_enabled: cfg!(feature = "magic-dns"), + kcp_enabled: cfg!(feature = "kcp"), + quic_enabled: cfg!(feature = "quic"), + udp_broadcast_enabled: cfg!(all(target_os = "windows", feature = "tun")), + upnp_enabled: cfg!(feature = "upnp"), + tcp_hole_punching_enabled: cfg!(feature = "tcp-hole-punch"), + ignore_unsupported_config: false, + connectivity: CoreConnectivityMode::Full, + easytier_version: EASYTIER_VERSION.to_owned(), + endpoint_protocols: IpScheme::VARIANTS.iter().map(ToString::to_string).collect(), + } +} + +pub(crate) fn compact_runtime_core_host_config() -> CoreInstanceHostConfig { + let mut config = runtime_core_host_config(); + config.force_exit_node = false; + config.host_routing.local_exit_node_fallback = false; + config.public_ipv6_provider_supported = false; + config.gateway_enabled = false; + config.proxy_enabled = false; + config.vpn_portal_enabled = false; + config.magic_dns_enabled = false; + config.kcp_enabled = false; + config.quic_enabled = false; + config.udp_broadcast_enabled = false; + config.upnp_enabled = false; + config.tcp_hole_punching_enabled = false; + config.ignore_unsupported_config = true; + config.endpoint_protocols = vec!["tcp".to_owned(), "udp".to_owned()]; + config +} + +pub(crate) fn runtime_peer_credential_storage( + global_ctx: &ArcGlobalCtx, +) -> Option> { + #[cfg(not(feature = "management"))] + { + let _ = global_ctx; + None + } + #[cfg(feature = "management")] + runtime_credential_storage(global_ctx.config.get_credential_file()) +} + +#[cfg(test)] +pub(crate) fn test_core_instance_config( + global_ctx: &ArcGlobalCtx, +) -> easytier_core::instance::CoreInstanceConfig { + use easytier_core::config::toml::{ConfigLoader as _, TomlConfig}; + + let config = TomlConfig::new_from_str(&global_ctx.config.dump()) + .expect("test configuration should round-trip through TOML"); + config.set_ipv4(global_ctx.get_ipv4()); + config.set_ipv6(global_ctx.get_ipv6()); + config.set_flags(global_ctx.get_flags()); + let mut host = runtime_core_host_config(); + let hostname = global_ctx.get_hostname(); + host.hostname_fallback = (!hostname.is_empty()).then_some(hostname); + easytier_core::instance::CoreInstanceConfig::from_toml_with_host(&config, &host) + .expect("test configuration should normalize") +} + +#[cfg(test)] +pub(crate) fn test_runtime_instance_config( + global_ctx: &ArcGlobalCtx, +) -> easytier_core::config::runtime::CoreInstanceRuntimeConfig { + let config = test_core_instance_config(global_ctx); + easytier_core::config::runtime::CoreInstanceRuntimeConfig { + services: config.connectivity.runtime, + peer: Arc::new(config.peer.snapshot), + } +} + +#[cfg(test)] +mod tests { + use easytier_core::{ + config::toml::TomlConfig, + events::{CoreEvent, CoreEventSink}, + }; + + use crate::common::global_ctx::tests::get_mock_global_ctx; + + use super::*; + + #[test] + fn native_host_config_contains_only_platform_policy() { + let config = runtime_core_host_config(); + let hostname = gethostname::gethostname().to_string_lossy().to_string(); + + assert_eq!( + config.hostname_fallback, + (!hostname.is_empty()).then_some(hostname) + ); + assert_eq!(config.gateway_enabled, cfg!(feature = "socks5")); + assert_eq!(config.smoltcp_available, cfg!(feature = "smoltcp")); + assert_eq!( + config.public_ipv6_provider_supported, + cfg!(all(target_os = "linux", feature = "public-ipv6-provider")) + ); + assert_eq!(config.easytier_version, EASYTIER_VERSION); + } + + #[test] + fn clearing_configured_hostname_does_not_reuse_the_old_value() { + let host = runtime_core_host_config(); + let initial = TomlConfig::new_from_str("hostname = \"configured-host\"").unwrap(); + let cleared = TomlConfig::new_from_str("hostname = \"\"").unwrap(); + + let initial = + easytier_core::instance::CoreInstanceConfig::from_toml_with_host(&initial, &host) + .unwrap(); + let cleared = + easytier_core::instance::CoreInstanceConfig::from_toml_with_host(&cleared, &host) + .unwrap(); + + assert_eq!( + initial.peer.snapshot.runtime.core.node.hostname.as_deref(), + Some("configured-host") + ); + assert_ne!( + cleared.peer.snapshot.runtime.core.node.hostname.as_deref(), + Some("configured-host") + ); + assert_eq!( + cleared.peer.snapshot.runtime.core.node.hostname.as_deref(), + host.hostname_fallback.as_deref() + ); + } + + #[test] + fn test_config_uses_current_global_context_hostname_as_fallback() { + let global_ctx = get_mock_global_ctx(); + global_ctx.set_hostname("test-hostname".to_owned()); + + let config = test_core_instance_config(&global_ctx); + + assert_eq!( + config.peer.snapshot.runtime.core.node.hostname.as_deref(), + Some("test-hostname") + ); + } + + #[tokio::test] + async fn core_event_sink_projects_peer_events_to_global_context() { + let global_ctx = get_mock_global_ctx(); + let mut events = global_ctx.subscribe(); + CoreEventSink::emit(global_ctx.as_ref(), CoreEvent::PeerAdded(7)); + + assert!(matches!( + events.recv().await.unwrap(), + GlobalCtxEvent::PeerAdded(7) + )); + } + + #[tokio::test] + async fn core_event_sink_projects_credential_changes_to_global_context() { + let global_ctx = get_mock_global_ctx(); + let mut events = global_ctx.subscribe(); + CoreEventSink::emit(global_ctx.as_ref(), CoreEvent::CredentialChanged); + + assert!(matches!( + events.recv().await.unwrap(), + GlobalCtxEvent::CredentialChanged + )); + } +} diff --git a/vendor/easytier/easytier/src/instance/config_storage.rs b/vendor/easytier/easytier/src/instance/config_storage.rs new file mode 100644 index 0000000..c76a1d8 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/config_storage.rs @@ -0,0 +1,82 @@ +use std::{io::Write as _, path::Path}; + +use atomic_write_file::{AtomicWriteFile, OpenOptions}; + +use easytier_core::management::{ConfigFileControl, ConfigFilePermission, ConfigFileStorage}; + +#[derive(Default)] +pub(crate) struct NativeConfigFileStorage; + +#[async_trait::async_trait] +impl ConfigFileStorage for NativeConfigFileStorage { + async fn inspect(&self, path: &Path) -> ConfigFileControl { + let read_only = tokio::fs::metadata(path) + .await + .map(|metadata| metadata.permissions().readonly()) + .unwrap_or(true); + ConfigFileControl::new( + Some(path.to_owned()), + if read_only { + ConfigFilePermission::from(ConfigFilePermission::READ_ONLY) + } else { + ConfigFilePermission::default() + }, + ) + } + + async fn read(&self, path: &Path) -> anyhow::Result>> { + match tokio::fs::read(path).await { + Ok(contents) => Ok(Some(contents)), + Err(error) if error.kind() == std::io::ErrorKind::NotFound => Ok(None), + Err(error) => Err(error.into()), + } + } + + async fn write(&self, path: &Path, contents: &[u8]) -> anyhow::Result<()> { + let path = path.to_owned(); + let contents = contents.to_owned(); + tokio::task::spawn_blocking(move || { + let mut options = OpenOptions::new(); + #[cfg(unix)] + { + atomic_write_file::unix::OpenOptionsExt::preserve_mode(&mut options, false); + std::os::unix::fs::OpenOptionsExt::mode(&mut options, 0o600); + } + let mut file: AtomicWriteFile = options.open(path)?; + file.write_all(&contents)?; + file.commit() + }) + .await??; + Ok(()) + } + + async fn remove(&self, path: &Path) -> anyhow::Result<()> { + tokio::fs::remove_file(path).await?; + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[tokio::test] + async fn config_write_is_atomic_and_private() { + let directory = tempfile::tempdir().unwrap(); + let path = directory.path().join("instance.toml"); + let storage = NativeConfigFileStorage; + + storage.write(&path, b"first").await.unwrap(); + storage.write(&path, b"second").await.unwrap(); + assert_eq!(std::fs::read_to_string(&path).unwrap(), "second"); + #[cfg(unix)] + { + use std::os::unix::fs::PermissionsExt as _; + + assert_eq!( + std::fs::metadata(path).unwrap().permissions().mode() & 0o777, + 0o600 + ); + } + } +} diff --git a/vendor/easytier/easytier/src/instance/dns_server/client_instance.rs b/vendor/easytier/easytier/src/instance/dns_server/client_instance.rs new file mode 100644 index 0000000..a9c7c11 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/client_instance.rs @@ -0,0 +1,118 @@ +use std::{sync::Arc, time::Duration}; + +use easytier_core::gateway::magic_dns::{ + MagicDnsRoutePublisher, MagicDnsRouteSnapshot, run_magic_dns_route_publisher, +}; +use easytier_core::instance::CorePacketPlane; +use tokio::task::JoinSet; + +use crate::proto::{ + api::instance::Route, + common::Void, + magic_dns::{ + HandshakeRequest, MagicDnsServerRpc, MagicDnsServerRpcClientFactory, UpdateDnsRecordRequest, + }, + rpc::standalone::{RuntimeRpcClient, runtime_rpc_client}, + rpc_types::controller::BaseController, +}; + +use super::MAGIC_DNS_INSTANCE_ADDR; + +pub struct MagicDnsClientInstance { + rpc_client: RuntimeRpcClient, + rpc_stub: Option + Send>>, + route_source: Arc, + tasks: JoinSet<()>, +} + +struct RpcMagicDnsRoutePublisher { + rpc_stub: Box + Send>, +} + +#[async_trait::async_trait] +impl MagicDnsRoutePublisher for RpcMagicDnsRoutePublisher { + async fn handshake(&mut self) -> anyhow::Result<()> { + self.rpc_stub + .handshake(BaseController::default(), HandshakeRequest::default()) + .await?; + Ok(()) + } + + async fn heartbeat(&mut self) -> anyhow::Result<()> { + self.rpc_stub + .heartbeat(BaseController::default(), Void::default()) + .await?; + Ok(()) + } + + async fn publish(&mut self, snapshot: &MagicDnsRouteSnapshot) -> anyhow::Result<()> { + let request = UpdateDnsRecordRequest { + routes: snapshot + .routes + .iter() + .map(|route| Route { + hostname: route.hostname.clone(), + ipv4_addr: route.ipv4_addr, + ..Default::default() + }) + .collect(), + zone: snapshot.zone.clone(), + }; + tracing::debug!( + "MagicDnsClientInstance::update_dns_task: update dns records: {:?}", + request + ); + self.rpc_stub + .update_dns_record(BaseController::default(), request) + .await?; + Ok(()) + } +} + +impl MagicDnsClientInstance { + pub(crate) async fn new(route_source: Arc) -> Result { + let mut rpc_client = runtime_rpc_client(MAGIC_DNS_INSTANCE_ADDR.parse().unwrap()); + let rpc_stub = rpc_client + .scoped_client::>("".to_string()) + .await?; + Ok(MagicDnsClientInstance { + rpc_client, + rpc_stub: Some(rpc_stub), + route_source, + tasks: JoinSet::new(), + }) + } + + async fn update_dns_task( + route_source: Arc, + rpc_stub: Box + Send>, + ) -> Result<(), anyhow::Error> { + let mut publisher = RpcMagicDnsRoutePublisher { rpc_stub }; + run_magic_dns_route_publisher( + route_source.as_ref(), + &mut publisher, + Duration::from_millis(500), + ) + .await + } + + pub async fn run_and_wait(&mut self) { + let rpc_stub = self.rpc_stub.take().unwrap(); + let route_source = self.route_source.clone(); + self.tasks.spawn(async move { + let ret = Self::update_dns_task(route_source, rpc_stub).await; + if let Err(e) = ret { + tracing::error!("MagicDnsServerInstanceData::run_and_wait: {:?}", e); + } + }); + + tokio::select! { + _ = self.tasks.join_next() => { + tracing::warn!("MagicDnsServerInstanceData::run_and_wait: dns record update task exited"); + } + _ = self.rpc_client.wait() => { + tracing::warn!("MagicDnsServerInstanceData::run_and_wait: rpc client exited"); + } + } + } +} diff --git a/vendor/easytier/easytier/src/instance/dns_server/config.rs b/vendor/easytier/easytier/src/instance/dns_server/config.rs new file mode 100644 index 0000000..d00f8a3 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/config.rs @@ -0,0 +1,193 @@ +use hickory_proto::rr; +use hickory_proto::rr::RData; +use serde::{Deserialize, Serialize}; +use std::collections::HashMap; +use std::net::{IpAddr, Ipv4Addr}; +use std::str::FromStr; +use std::time::Duration; + +#[derive(Serialize, Deserialize, Debug, Clone, derive_builder::Builder)] +pub struct RunConfig { + general: GeneralConfig, + + #[builder(default = HashMap::new())] + zones: Zone, + + #[builder(default = Vec::new())] + #[serde(default)] + excluded_forward_nameservers: Vec, +} + +impl RunConfig { + pub fn general(&self) -> &GeneralConfig { + &self.general + } + + pub fn zones(&self) -> &Zone { + &self.zones + } + + pub fn excluded_forward_nameservers(&self) -> &Vec { + &self.excluded_forward_nameservers + } +} + +#[derive(Serialize, Deserialize, Debug, Clone, derive_builder::Builder)] +pub struct GeneralConfig { + #[builder(setter(into, strip_option), default = None)] + listen_tcp: Option, + + #[builder(setter(into, strip_option), default = None)] + listen_udp: Option, +} + +impl GeneralConfig { + pub fn listen_tcp(&self) -> &Option { + &self.listen_tcp + } + + pub fn listen_udp(&self) -> &Option { + &self.listen_udp + } +} + +pub type Zone = HashMap>; // domain -> records + +pub type RecordType = rr::RecordType; + +#[derive(Serialize, Deserialize, Debug, Clone, derive_builder::Builder)] +pub struct Record { + #[serde(rename = "type")] + rr_type: RecordType, + + name: String, + value: String, + + #[serde(with = "humantime_serde")] + ttl: Duration, +} + +impl Record { + pub fn name(&self) -> anyhow::Result { + let name = rr::Name::from_str(self.name.as_str())?; + Ok(name) + } + + fn rr_type(&self) -> rr::RecordType { + self.rr_type + } +} + +impl TryFrom for rr::Record { + type Error = anyhow::Error; + + fn try_from(value: Record) -> Result { + let r: rr::Record = (&value).try_into()?; + Ok(r) + } +} + +impl TryFrom<&Record> for rr::Record { + type Error = anyhow::Error; + + fn try_from(value: &Record) -> Result { + let name = value.name()?; + let mut record = Self::update0(name, value.ttl.as_secs() as u32, value.rr_type()); + record.set_dns_class(rr::DNSClass::IN); + match value.rr_type { + RecordType::A => { + let addr: Ipv4Addr = value.value.parse()?; + record.set_data(RData::A(rr::rdata::a::A(addr))); + } + RecordType::SOA => { + let soa = value.value.split_whitespace().collect::>(); + if soa.len() != 7 { + return Err(anyhow::anyhow!("invalid SOA record")); + } + let mname = rr::Name::from_str(soa[0])?; + let rname = rr::Name::from_str(soa[1])?; + let serial: u32 = soa[2].parse()?; + let refresh: u32 = soa[3].parse()?; + let retry: u32 = soa[4].parse()?; + let expire: u32 = soa[5].parse()?; + let minimum: u32 = soa[6].parse()?; + record.set_data(RData::SOA(rr::rdata::soa::SOA::new( + mname, + rname, + serial, + refresh.try_into().unwrap(), + retry.try_into().unwrap(), + expire.try_into().unwrap(), + minimum, + ))); + } + _ => todo!(), + } + Ok(record) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use anyhow::anyhow; + + #[tokio::test] + async fn it_works() -> anyhow::Result<()> { + let text = r#" +[general] +listen_tcp = "127.0.0.1:5300" +listen_udp = "127.0.0.1:5353" + +[[zones."et.internal"]] +type = "A" +name = "www" +value = "123.123.123.123" +ttl = "60s" + +[[zones."et.top"]] +type = "A" +name = "@" +value = "100.100.100.100" +ttl = "61s" + +"#; + + let config = toml::from_str::(text)?; + assert_eq!( + config.general.listen_tcp().clone().unwrap(), + "127.0.0.1:5300" + ); + assert_eq!( + config.general.listen_udp().clone().unwrap(), + "127.0.0.1:5353" + ); + assert_eq!(config.zones.len(), 2); + + let (domain, records) = config + .zones + .get_key_value("et.internal") + .ok_or(anyhow!("et.internal not found"))?; + assert_eq!(domain, "et.internal"); + assert_eq!(records.len(), 1); + let record = &records[0]; + assert_eq!(record.rr_type, RecordType::A); + assert_eq!(record.name, "www"); + assert_eq!(record.value, "123.123.123.123"); + assert_eq!(record.ttl.as_secs(), 60); + + let (domain, records) = config + .zones + .get_key_value("et.top") + .ok_or(anyhow!("et.top not found"))?; + assert_eq!(domain, "et.top"); + assert_eq!(records.len(), 1); + let record = &records[0]; + assert_eq!(record.rr_type, RecordType::A); + assert_eq!(record.name, "@"); + assert_eq!(record.value, "100.100.100.100"); + assert_eq!(record.ttl.as_secs(), 61); + + Ok(()) + } +} diff --git a/vendor/easytier/easytier/src/instance/dns_server/mod.rs b/vendor/easytier/easytier/src/instance/dns_server/mod.rs new file mode 100644 index 0000000..4719a1d --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/mod.rs @@ -0,0 +1,22 @@ +// This module is copy and modified from https://github.com/fanyang89/libdns +#[cfg(all(feature = "magic-dns", feature = "tun"))] +pub(crate) mod config; +#[cfg(all(feature = "magic-dns", feature = "tun"))] +pub(crate) mod server; + +#[cfg(all(feature = "magic-dns", feature = "tun"))] +pub mod client_instance; +#[cfg(all(feature = "magic-dns", feature = "tun"))] +pub mod runner; +#[cfg(all(feature = "magic-dns", feature = "tun"))] +pub mod server_instance; +#[cfg(all(feature = "magic-dns", feature = "tun"))] +pub mod system_config; + +#[cfg(all(test, feature = "tun", feature = "magic-dns"))] +mod tests; + +pub static MAGIC_DNS_INSTANCE_ADDR: &str = "tcp://127.0.0.1:49813"; +pub static MAGIC_DNS_INSTANCE_SOCKET_ADDR: &str = "127.0.0.1:49813"; +pub static MAGIC_DNS_FAKE_IP: &str = "100.100.100.101"; +pub use easytier_core::config::toml::DEFAULT_ET_DNS_ZONE; diff --git a/vendor/easytier/easytier/src/instance/dns_server/runner.rs b/vendor/easytier/easytier/src/instance/dns_server/runner.rs new file mode 100644 index 0000000..76791c6 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/runner.rs @@ -0,0 +1,98 @@ +use cidr::Ipv4Inet; +use tokio_util::sync::CancellationToken; + +use std::{net::Ipv4Addr, sync::Arc, time::Duration}; + +use easytier_core::instance::CorePacketPlane; + +use crate::common::global_ctx::ArcGlobalCtx; + +use super::{client_instance::MagicDnsClientInstance, server_instance::MagicDnsServerInstance}; + +pub struct DnsRunner { + client: Option, + server: Option, + packet_plane: Arc, + global_ctx: ArcGlobalCtx, + tun_dev: Option, + tun_inet: Ipv4Inet, + fake_ip: Ipv4Addr, +} + +impl DnsRunner { + pub(crate) fn new( + packet_plane: Arc, + global_ctx: ArcGlobalCtx, + tun_dev: Option, + tun_inet: Ipv4Inet, + fake_ip: Ipv4Addr, + ) -> Self { + Self { + client: None, + server: None, + packet_plane, + global_ctx, + tun_dev, + tun_inet, + fake_ip, + } + } + + async fn clean_env(&mut self) { + if let Some(server) = self.server.take() { + server.clean_env().await; + } + self.client.take(); + } + + async fn run_once(&mut self) -> anyhow::Result<()> { + // try server first + match MagicDnsServerInstance::new( + self.packet_plane.clone(), + self.global_ctx.clone(), + self.tun_dev.clone(), + self.tun_inet, + self.fake_ip, + ) + .await + { + Ok(server) => { + self.server = Some(server); + tracing::info!("DnsRunner::run_once: server started"); + } + Err(e) => { + tracing::error!("DnsRunner::run_once: {:?}", e); + } + } + + // every runner must run a client + let client = MagicDnsClientInstance::new(self.packet_plane.clone()).await?; + self.client = Some(client); + self.client.as_mut().unwrap().run_and_wait().await; + + Err(anyhow::anyhow!("Client instance exit")) + } + + pub async fn run(&mut self, canel_token: CancellationToken) { + loop { + tracing::info!("DnsRunner::run: start"); + tokio::select! { + _ = canel_token.cancelled() => { + self.clean_env().await; + tracing::info!("DnsRunner::run: cancelled"); + return; + } + + ret = self.run_once() => { + self.clean_env().await; + if let Err(e) = ret { + tracing::error!("DnsRunner::run: {:?}", e); + } else { + tracing::info!("DnsRunner::run: unexpected exit, server may be down"); + } + tokio::time::sleep(Duration::from_millis(500)).await; + } + } + } + } +} diff --git a/vendor/easytier/easytier/src/instance/dns_server/server.rs b/vendor/easytier/easytier/src/instance/dns_server/server.rs new file mode 100644 index 0000000..e9cd5ad --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/server.rs @@ -0,0 +1,290 @@ +use anyhow::{Context, Result}; +use hickory_proto::rr; +use hickory_proto::rr::LowerName; +use hickory_resolver::config::ResolverOpts; +use hickory_resolver::name_server::TokioConnectionProvider; +use hickory_resolver::system_conf::read_system_conf; +use hickory_server::ServerFuture; +use hickory_server::authority::{AuthorityObject, Catalog, ZoneType}; +use hickory_server::server::{Request, RequestHandler, ResponseHandler, ResponseInfo}; +use hickory_server::store::forwarder::ForwardConfig; +use hickory_server::store::{forwarder::ForwardAuthority, in_memory::InMemoryAuthority}; +use std::net::SocketAddr; +use std::str::FromStr; +use std::sync::Arc; +use std::time::Duration; +use tokio::net::{TcpListener, UdpSocket}; +use tokio::sync::{RwLock, RwLockReadGuard}; + +use crate::common::dns::get_default_resolver_config; + +use super::config::{GeneralConfig, Record, RunConfig}; + +pub struct Server { + server: ServerFuture, + catalog: Arc>, + general_config: GeneralConfig, + udp_local_addr: Option, +} + +struct CatalogRequestHandler { + catalog: Arc>, +} + +impl CatalogRequestHandler { + fn new(catalog: Arc>) -> CatalogRequestHandler { + // let system_conf = read_system_conf(); + // let recursor = match system_conf { + // Ok((conf, _)) => RecursorBuilder::default().build(conf), + // Err(_) => RecursorBuilder::default().build(get_default_resolver_config()), + // } + // // policy is security unware, this will never return an error + // .unwrap(); + + Self { catalog } + } +} + +#[async_trait::async_trait] +impl RequestHandler for CatalogRequestHandler { + async fn handle_request( + &self, + request: &Request, + response_handle: R, + ) -> ResponseInfo { + self.catalog + .read() + .await + .handle_request(request, response_handle) + .await + } +} + +pub fn build_authority(domain: &str, records: &[Record]) -> Result { + let zone = rr::Name::from_str(domain)?; + let mut authority = InMemoryAuthority::empty(zone, ZoneType::Primary, false); + for record in records.iter() { + let r = record.try_into()?; + authority.upsert_mut(r, 0); + } + Ok(authority) +} + +impl Server { + pub fn new(config: RunConfig) -> Self { + Self::try_new(config).unwrap() + } + + fn try_new(config: RunConfig) -> Result { + let mut catalog = Catalog::new(); + for (domain, records) in config.zones().iter() { + let zone = rr::Name::from_str(domain.as_str())?; + let authroty = build_authority(domain, records)?; + catalog.upsert(zone.clone().into(), vec![Arc::new(authroty)]); + } + + // use forwarder authority for the root zone + let system_conf = + read_system_conf().unwrap_or((get_default_resolver_config(), ResolverOpts::default())); + let forward_config = ForwardConfig { + name_servers: system_conf + .0 + .name_servers() + .iter() + .filter(|&x| { + !config + .excluded_forward_nameservers() + .contains(&x.socket_addr.ip()) + }) + .cloned() + .collect::>() + .into(), + options: Some(system_conf.1), + }; + let auth = ForwardAuthority::builder_with_config( + forward_config, + TokioConnectionProvider::default(), + ) + .build() + .unwrap(); + + catalog.upsert(rr::Name::from_str(".")?.into(), vec![Arc::new(auth)]); + + let catalog = Arc::new(RwLock::new(catalog)); + let handler = CatalogRequestHandler::new(catalog.clone()); + let server = ServerFuture::new(handler); + + Ok(Self { + server, + catalog, + general_config: config.general().clone(), + udp_local_addr: None, + }) + } + + #[cfg(test)] + pub fn udp_local_addr(&self) -> Option { + self.udp_local_addr + } + + pub async fn register_udp_socket(&mut self, address: String) -> Result { + let bind_addr = SocketAddr::from_str(&address) + .with_context(|| format!("DNS Server failed to parse address {}", address))?; + let socket = socket2::Socket::new( + socket2::Domain::IPV4, + socket2::Type::DGRAM, + Some(socket2::Protocol::UDP), + ) + .with_context(|| { + format!( + "DNS Server failed to create UDP socket for address {}", + address + ) + })?; + socket2::SockRef::from(&socket) + .set_reuse_address(true) + .with_context(|| { + format!( + "DNS Server failed to set reuse address on socket {}", + address + ) + })?; + socket.bind(&bind_addr.into()).with_context(|| { + format!("DNS Server failed to bind socket to address {}", bind_addr) + })?; + socket + .set_nonblocking(true) + .with_context(|| "DNS Server failed to set socket to non-blocking".to_string())?; + let socket = UdpSocket::from_std(socket.into()).with_context(|| { + format!( + "DNS Server failed to convert socket to UdpSocket for address {}", + address + ) + })?; + + let local_addr = socket + .local_addr() + .with_context(|| "DNS Server failed to get local address".to_string())?; + self.server.register_socket(socket); + + Ok(local_addr) + } + + pub async fn run(&mut self) -> Result<()> { + if let Some(address) = self.general_config.listen_tcp() { + let tcp_listener = TcpListener::bind(address.clone()) + .await + .with_context(|| format!("DNS Server failed to bind TCP address {}", address))?; + self.server + .register_listener(tcp_listener, Duration::from_secs(5)); + } + + if let Some(address) = self.general_config.listen_udp() { + let local_addr = self.register_udp_socket(address.clone()).await?; + self.udp_local_addr = Some(local_addr); + }; + + Ok(()) + } + + #[cfg(test)] + pub async fn shutdown(&mut self) -> Result<()> { + self.server.shutdown_gracefully().await?; + Ok(()) + } + + pub async fn upsert(&self, name: LowerName, authority: Arc) { + self.catalog.write().await.upsert(name, vec![authority]); + } + + pub async fn read_catalog(&self) -> RwLockReadGuard<'_, Catalog> { + self.catalog.read().await + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::instance::dns_server::config::{ + GeneralConfigBuilder, RecordBuilder, RecordType, RunConfigBuilder, + }; + use anyhow::Result; + use hickory_client::client::{Client, ClientHandle}; + use hickory_proto::rr; + use hickory_proto::runtime::TokioRuntimeProvider; + use hickory_proto::udp::UdpClientStream; + use maplit::hashmap; + use std::time::Duration; + + #[tokio::test] + async fn it_works() -> Result<()> { + let mut server = Server::new( + RunConfigBuilder::default() + .general(GeneralConfigBuilder::default().build()?) + .build()?, + ); + server.run().await?; + server.shutdown().await?; + Ok(()) + } + + #[tokio::test] + async fn can_resolve_records() -> Result<()> { + let configured_record = RecordBuilder::default() + .rr_type(RecordType::A) + .name("www.et.internal.".to_string()) + .value("123.123.123.123".to_string()) + .ttl(Duration::from_secs(60)) + .build()?; + let configured_record2 = RecordBuilder::default() + .rr_type(RecordType::A) + .name("中文.et.internal.".to_string()) + .value("123.123.123.123".to_string()) + .ttl(Duration::from_secs(60)) + .build()?; + let soa_record = RecordBuilder::default() + .rr_type(RecordType::SOA) + .name("et.internal.".to_string()) + .value( + "ns.et.internal. hostmaster.et.internal. 2023101001 7200 3600 1209600 86400" + .to_string(), + ) + .ttl(Duration::from_secs(60)) + .build()?; + let config = RunConfigBuilder::default() + .general( + GeneralConfigBuilder::default() + .listen_udp("127.0.0.1:0") + .build()?, + ) + .zones(hashmap! { + "et.internal.".to_string() => vec![configured_record.clone(), soa_record.clone(), configured_record2.clone()], + }) + .build()?; + + let mut server = Server::new(config); + server.run().await?; + + let local_addr = server.udp_local_addr().unwrap(); + let stream = UdpClientStream::builder(local_addr, TokioRuntimeProvider::default()).build(); + let (mut client, background) = Client::connect(stream).await?; + let background_task = tokio::spawn(background); + let response = client + .query( + rr::Name::from_str("www.et.internal")?, + rr::DNSClass::IN, + rr::RecordType::A, + ) + .await?; + drop(background_task); + + println!("Response: {:?}", response); + + assert_eq!(response.answers().len(), 1); + let expected_record: rr::Record = configured_record.try_into()?; + assert_eq!(response.answers().first().unwrap(), &expected_record); + + server.shutdown().await?; + Ok(()) + } +} diff --git a/vendor/easytier/easytier/src/instance/dns_server/server_instance.rs b/vendor/easytier/easytier/src/instance/dns_server/server_instance.rs new file mode 100644 index 0000000..4c1c3c0 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/server_instance.rs @@ -0,0 +1,457 @@ +// single-instance server in one machine, every easytier instance that has ip address and tun device will try to create a server instance. + +// magic dns client will connect to this server to update the dns records. +// magic dns server will add the dns server ip address to the tun device, and forward the dns request to the dns server + +// magic dns client will establish a long live tcp connection to the magic dns server, and when the server stops or crashes, +// all the clients will exit and let the easytier instance to launch a new server instance. + +use super::{ + MAGIC_DNS_INSTANCE_SOCKET_ADDR, + config::{GeneralConfigBuilder, RunConfigBuilder}, + server::Server, + system_config::{OSConfig, SystemConfig}, +}; +use crate::{ + common::{ + global_ctx::ArcGlobalCtx, + ifcfg::{IfConfiger, IfConfiguerTrait}, + }, + instance::dns_server::{ + config::{Record, RecordBuilder, RecordType}, + server::build_authority, + }, + proto::{ + common::{TunnelInfo, Void}, + magic_dns::{ + DnsRecord, DnsRecordA, DnsRecordList, GetDnsRecordResponse, HandshakeRequest, + HandshakeResponse, MagicDnsServerRpc, MagicDnsServerRpcServer, UpdateDnsRecordRequest, + dns_record::{self}, + }, + rpc::standalone::{ + RpcServerHook, RuntimeRpcListener, StandAloneServer, runtime_rpc_listener, + }, + rpc_types::controller::{BaseController, Controller}, + }, +}; +use anyhow::Context; +use cidr::Ipv4Inet; +use easytier_core::gateway::magic_dns::{ + MagicDnsQuery, MagicDnsQueryResolver, MagicDnsRecordStore, MagicDnsResolverRegistration, + MagicDnsRoute, +}; +use easytier_core::instance::CorePacketPlane; +use hickory_proto::rr::LowerName; +use hickory_proto::serialize::binary::{BinDecodable, BinEncoder}; +use hickory_server::authority::{MessageRequest, MessageResponse}; +use hickory_server::server::{Request, RequestHandler, ResponseHandler, ResponseInfo}; +use std::sync::Mutex; +use std::{collections::BTreeMap, io, net::Ipv4Addr, str::FromStr, sync::Arc, time::Duration}; + +pub(super) struct MagicDnsServerInstanceData { + dns_server: Server, + tun_dev: Option, + fake_ip: Ipv4Addr, + route_store: MagicDnsRecordStore, + record_apply: tokio::sync::Mutex<()>, + + system_config: Option>, +} + +impl MagicDnsServerInstanceData { + pub async fn update_dns_records<'a, T: Iterator>( + &self, + routes: T, + zone: &str, + ) -> Result<(), anyhow::Error> { + let mut records: Vec = vec![]; + for route in routes { + if route.hostname.is_empty() { + continue; + } + + let Some(ipv4_addr) = route.ipv4_addr else { + continue; + }; + + let record = RecordBuilder::default() + .rr_type(RecordType::A) + .name(format!("{}.{}", route.hostname, zone)) + .value(ipv4_addr.to_string()) + .ttl(Duration::from_secs(1)) + .build()?; + + // check record name valid for dns + if let Err(e) = record.name() { + tracing::error!("Invalid subdomain label: {}", e); + continue; + } + + records.push(record); + } + + let soa_record = RecordBuilder::default() + .rr_type(RecordType::SOA) + .name(zone.to_string()) + .value(format!( + "ns.{} hostmaster.{} 2023101001 7200 3600 1209600 86400", + zone, zone + )) + .ttl(Duration::from_secs(60)) + .build()?; + records.push(soa_record); + + let authority = build_authority(zone, &records)?; + + self.dns_server + .upsert( + LowerName::from_str(zone) + .with_context(|| "Invalid zone name, expect format like \"et.net.\"")?, + Arc::new(authority), + ) + .await; + + tracing::debug!("Updated DNS records for zone {}: {:?}", zone, records); + + Ok(()) + } + + pub async fn update(&self) { + let snapshot = self.route_store.snapshot(); + for (zone, routes) in &snapshot.zones { + if let Err(e) = self.update_dns_records(routes.iter(), zone).await { + tracing::error!("Failed to update DNS records for zone {}: {:?}", zone, e); + } + } + } + + async fn keep_zone_authoritative(&self, zone: &str) { + if let Err(e) = self + .update_dns_records(std::iter::empty::<&MagicDnsRoute>(), zone) + .await + { + tracing::error!( + "Failed to keep DNS zone {} authoritative after route prune: {:?}", + zone, + e + ); + } + } + + fn do_system_config(&self, zone: &str) -> Result<(), anyhow::Error> { + if let Some(c) = &self.system_config { + c.set_dns(&OSConfig { + nameservers: vec![self.fake_ip.to_string()], + search_domains: vec![zone.to_string()], + match_domains: vec![zone.to_string()], + })?; + } + Ok(()) + } +} + +#[async_trait::async_trait] +impl MagicDnsServerRpc for MagicDnsServerInstanceData { + type Controller = BaseController; + async fn handshake( + &self, + _ctrl: Self::Controller, + _input: HandshakeRequest, + ) -> crate::proto::rpc_types::error::Result { + Ok(Default::default()) + } + + async fn heartbeat( + &self, + _ctrl: Self::Controller, + _input: Void, + ) -> crate::proto::rpc_types::error::Result { + Ok(Default::default()) + } + + async fn update_dns_record( + &self, + ctrl: Self::Controller, + input: UpdateDnsRecordRequest, + ) -> crate::proto::rpc_types::error::Result { + let Some(tunnel_info) = ctrl.get_tunnel_info() else { + return Err(anyhow::anyhow!("No tunnel info").into()); + }; + let Some(remote_addr) = &tunnel_info.remote_addr else { + return Err(anyhow::anyhow!("No remote addr").into()); + }; + let _apply = self.record_apply.lock().await; + let zone = input.zone.clone(); + let remote_addr: url::Url = remote_addr.clone().into(); + let routes = input + .routes + .into_iter() + .map(|route| MagicDnsRoute { + hostname: route.hostname, + ipv4_addr: route.ipv4_addr.unwrap_or_default().address.map(Into::into), + }) + .collect(); + let zone_removed = + self.route_store + .replace_client_routes(zone.clone(), remote_addr.to_string(), routes); + + if zone_removed { + self.keep_zone_authoritative(&zone).await; + } + + self.update().await; + Ok(Default::default()) + } + + async fn get_dns_record( + &self, + _ctrl: Self::Controller, + _input: Void, + ) -> crate::proto::rpc_types::error::Result { + let mut ret = BTreeMap::new(); + for (zone, routes) in self.route_store.snapshot().zones { + let mut dns_records = DnsRecordList::default(); + for route in routes { + dns_records.records.push(DnsRecord { + record: Some(dns_record::Record::A(DnsRecordA { + name: format!("{}.{}", route.hostname, zone), + value: route.ipv4_addr.map(Into::into), + ttl: 1, + })), + }); + } + ret.insert(zone, dns_records); + } + Ok(GetDnsRecordResponse { records: ret }) + } +} + +// This should only be used for UDP response. +// For other protocols, the variable `max_size` in `send_response` should be u16::MAX. +#[derive(Clone)] +struct ResponseWrapper { + response: Arc>>, +} + +trait RecordIter<'a>: Iterator + Send + 'a {} +impl<'a, T> RecordIter<'a> for T where T: Iterator + Send + 'a {} + +#[async_trait::async_trait] +impl ResponseHandler for ResponseWrapper { + async fn send_response<'a>( + &mut self, + response: MessageResponse< + '_, + 'a, + impl RecordIter<'a>, + impl RecordIter<'a>, + impl RecordIter<'a>, + impl RecordIter<'a>, + >, + ) -> io::Result { + let mut buffer = self + .response + .lock() + .map_err(|_| io::Error::other("lock poisoned"))?; + + let mut encoder = BinEncoder::new(&mut buffer); + + // `max_size` should be u16::MAX for protocol other than UDP. + let max_size = if let Some(edns) = response.get_edns() { + edns.max_payload() + } else { + hickory_proto::udp::MAX_RECEIVE_BUFFER_SIZE as u16 + }; + + encoder.set_max_size(max_size); + response + .destructive_emit(&mut encoder) + .map_err(io::Error::other) + } +} + +impl MagicDnsServerInstanceData { + async fn resolve_query_inner(&self, query: MagicDnsQuery) -> Option> { + let request = Request::new( + MessageRequest::from_bytes(&query.payload).ok()?, + query.source, + hickory_proto::xfer::Protocol::Udp, + ); + let response = Arc::new(Mutex::new(Vec::with_capacity(512))); + + self.dns_server + .read_catalog() + .await + .handle_request( + &request, + ResponseWrapper { + response: response.clone(), + }, + ) + .await; + + Arc::into_inner(response)?.into_inner().ok() + } +} + +#[async_trait::async_trait] +impl MagicDnsQueryResolver for MagicDnsServerInstanceData { + async fn resolve(&self, query: MagicDnsQuery) -> Option> { + self.resolve_query_inner(query).await + } +} + +#[async_trait::async_trait] +impl RpcServerHook for MagicDnsServerInstanceData { + async fn on_new_client( + &self, + tunnel_info: Option, + ) -> Result, anyhow::Error> { + tracing::info!(?tunnel_info, "New client connected"); + Ok(tunnel_info) + } + + async fn on_client_disconnected(&self, tunnel_info: Option) { + tracing::info!(?tunnel_info, "Client disconnected"); + let Some(tunnel_info) = tunnel_info else { + return; + }; + let Some(remote_addr) = tunnel_info.remote_addr else { + return; + }; + let _apply = self.record_apply.lock().await; + let remote_addr: url::Url = remote_addr.into(); + for zone in self.route_store.remove_client(remote_addr.as_ref()) { + self.keep_zone_authoritative(&zone).await; + } + self.update().await; + } +} + +pub struct MagicDnsServerInstance { + _rpc_server: StandAloneServer, + pub(super) data: Arc, + packet_filter: MagicDnsResolverRegistration, + tun_inet: Ipv4Inet, +} + +fn get_system_config( + _tun_name: Option<&str>, +) -> Result>, anyhow::Error> { + #[cfg(target_os = "windows")] + { + use super::system_config::windows::WindowsDNSManager; + let tun_name = _tun_name.ok_or_else(|| anyhow::anyhow!("No tun name"))?; + return Ok(Some(Box::new(WindowsDNSManager::new(tun_name)?))); + } + + #[cfg(all(target_os = "macos", not(feature = "macos-ne")))] + { + use super::system_config::darwin::DarwinConfigurator; + return Ok(Some(Box::new(DarwinConfigurator::new()))); + } + + #[allow(unreachable_code)] + Ok(None) +} + +impl MagicDnsServerInstance { + pub(crate) async fn new( + packet_plane: Arc, + global_ctx: ArcGlobalCtx, + tun_dev: Option, + tun_inet: Ipv4Inet, + fake_ip: Ipv4Addr, + ) -> Result { + let tcp_listener = runtime_rpc_listener(MAGIC_DNS_INSTANCE_SOCKET_ADDR.parse()?); + let mut rpc_server = StandAloneServer::new(tcp_listener); + rpc_server.serve().await?; + + let dns_config = RunConfigBuilder::default() + .general(GeneralConfigBuilder::default().build()?) + .excluded_forward_nameservers(vec![fake_ip.into()]) + .build()?; + let mut dns_server = Server::new(dns_config); + dns_server.run().await?; + + if !tun_inet.contains(&fake_ip) + && let Some(tun_dev_name) = &tun_dev + { + let cost = if cfg!(target_os = "windows") { + Some(4) + } else { + None + }; + let ifcfg = IfConfiger {}; + ifcfg + .add_ipv4_route(tun_dev_name, fake_ip, 32, cost) + .await?; + } + + let data = Arc::new(MagicDnsServerInstanceData { + dns_server, + tun_dev: tun_dev.clone(), + fake_ip, + route_store: MagicDnsRecordStore::default(), + record_apply: tokio::sync::Mutex::new(()), + system_config: get_system_config(tun_dev.as_deref())?, + }); + + rpc_server + .registry() + .register(MagicDnsServerRpcServer::new_arc(data.clone()), ""); + rpc_server.set_hook(data.clone()); + + // Use configured tld_dns_zone or fall back to DEFAULT_ET_DNS_ZONE if empty + let flags = global_ctx.get_flags(); + let tld_dns_zone_clone = flags.tld_dns_zone.clone(); + + data.update_dns_records(std::iter::empty(), &tld_dns_zone_clone) + .await + .context("Failed to initialize DNS zone")?; + + let data_clone = data.clone(); + tokio::task::spawn_blocking(move || data_clone.do_system_config(&tld_dns_zone_clone)) + .await + .context("Failed to configure system")??; + + // Install the resolver only after all fallible initialization has + // completed, so construction failure cannot leave a managed pipeline + // registration that never reaches async cleanup. + let packet_filter = packet_plane + .register_magic_dns_resolver(fake_ip, data.clone()) + .await; + + Ok(Self { + _rpc_server: rpc_server, + data, + packet_filter, + tun_inet, + }) + } + + pub async fn clean_env(&self) { + if let Some(configer) = &self.data.system_config { + let ret = configer.close(); + if let Err(e) = ret { + tracing::error!("Failed to close system config: {:?}", e); + } + if !self.tun_inet.contains(&self.data.fake_ip) + && let Some(tun_dev_name) = &self.data.tun_dev + { + let ifcfg = IfConfiger {}; + let _ = ifcfg + .remove_ipv4_route(tun_dev_name, self.data.fake_ip, 32) + .await; + } + } + + self.packet_filter.close().await; + } +} + +impl Drop for MagicDnsServerInstance { + fn drop(&mut self) { + println!("MagicDnsServerInstance dropped"); + } +} diff --git a/vendor/easytier/easytier/src/instance/dns_server/system_config/darwin.rs b/vendor/easytier/easytier/src/instance/dns_server/system_config/darwin.rs new file mode 100644 index 0000000..028c29a --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/system_config/darwin.rs @@ -0,0 +1,135 @@ +use std::{ + collections::HashSet, + fs::{self, OpenOptions}, + io::{self, Write}, + os::unix::fs::PermissionsExt, + path::Path, +}; + +use super::{OSConfig, SystemConfig}; + +const MAC_RESOLVER_FILE_HEADER: &str = "# Added by easytier\n"; +const ETC_RESOLVER: &str = "/etc/resolver"; +const ETC_RESOLV_CONF: &str = "/etc/resolv.conf"; + +#[derive(Default)] +pub struct DarwinConfigurator {} +impl DarwinConfigurator { + pub fn new() -> Self { + DarwinConfigurator {} + } + + pub fn do_close(&self) -> io::Result<()> { + self.remove_resolver_files(|_| true) + } + + pub fn supports_split_dns(&self) -> bool { + true + } + + pub fn do_set_dns(&self, cfg: &OSConfig) -> io::Result<()> { + fs::create_dir_all(ETC_RESOLVER)?; + let mut keep = HashSet::new(); + + // 写 search.easytier 文件 + if !cfg.search_domains.is_empty() { + let search_file = "search.easytier"; + keep.insert(search_file.to_string()); + let mut content = String::from(MAC_RESOLVER_FILE_HEADER); + content.push_str("search"); + for domain in &cfg.search_domains { + content.push(' '); + content.push_str(domain.trim_end_matches('.')); + } + content.push('\n'); + Self::write_resolver_file(search_file, &content)?; + } + + // 写 match_domains 文件 + let mut ns_content = String::from(MAC_RESOLVER_FILE_HEADER); + for ns in &cfg.nameservers { + ns_content.push_str(&format!("nameserver {}\n", ns)); + } + for domain in &cfg.match_domains { + let file_base = domain.trim_end_matches('.'); + keep.insert(file_base.to_string()); + Self::write_resolver_file(file_base, &ns_content)?; + } + // 删除未保留的 resolver 文件 + self.remove_resolver_files(|domain| !keep.contains(domain))?; + + Ok(()) + } + + fn write_resolver_file(file_name: &str, content: &str) -> io::Result<()> { + let path = Path::new(ETC_RESOLVER).join(file_name); + let mut file = OpenOptions::new() + .create(true) + .truncate(true) + .write(true) + .open(&path)?; + file.set_permissions(fs::Permissions::from_mode(0o644))?; + file.write_all(content.as_bytes())?; + Ok(()) + } + + fn remove_resolver_files(&self, should_delete: F) -> io::Result<()> + where + F: Fn(&str) -> bool, + { + let entries = match fs::read_dir(ETC_RESOLVER) { + Ok(e) => e, + Err(e) if e.kind() == io::ErrorKind::NotFound => return Ok(()), + Err(e) => return Err(e), + }; + for entry in entries { + let entry = entry?; + let file_type = entry.file_type()?; + if !file_type.is_file() { + continue; + } + let name = entry.file_name(); + let name_str = name.to_string_lossy(); + if !should_delete(&name_str) { + continue; + } + let full_path = entry.path(); + let content = fs::read_to_string(&full_path)?; + if !content.starts_with(MAC_RESOLVER_FILE_HEADER) { + continue; + } + fs::remove_file(&full_path)?; + } + Ok(()) + } +} + +impl SystemConfig for DarwinConfigurator { + fn set_dns(&self, cfg: &OSConfig) -> io::Result<()> { + self.do_set_dns(cfg) + } + + fn close(&self) -> io::Result<()> { + self.do_close() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[tokio::test] + async fn set_dns_test() -> io::Result<()> { + let config = OSConfig { + nameservers: vec!["8.8.8.8".into()], + search_domains: vec!["example.com".into()], + match_domains: vec!["test.local".into()], + }; + let configurator = DarwinConfigurator::new(); + + configurator.set_dns(&config)?; + configurator.close()?; + + Ok(()) + } +} diff --git a/vendor/easytier/easytier/src/instance/dns_server/system_config/mod.rs b/vendor/easytier/easytier/src/instance/dns_server/system_config/mod.rs new file mode 100644 index 0000000..6ec0d36 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/system_config/mod.rs @@ -0,0 +1,17 @@ +#[cfg(target_os = "windows")] +pub mod windows; + +#[cfg(all(target_os = "macos", not(feature = "macos-ne")))] +pub mod darwin; + +#[derive(Default, Debug)] +pub struct OSConfig { + pub nameservers: Vec, + pub search_domains: Vec, + pub match_domains: Vec, +} + +pub trait SystemConfig: Send + Sync { + fn set_dns(&self, cfg: &OSConfig) -> std::io::Result<()>; + fn close(&self) -> std::io::Result<()>; +} diff --git a/vendor/easytier/easytier/src/instance/dns_server/system_config/windows.rs b/vendor/easytier/easytier/src/instance/dns_server/system_config/windows.rs new file mode 100644 index 0000000..030b60e --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/system_config/windows.rs @@ -0,0 +1,249 @@ +use std::net::IpAddr; +use std::process::Command; + +use std::io; +use winreg::RegKey; + +use crate::common::ifcfg::RegistryManager; + +use super::{OSConfig, SystemConfig}; + +pub fn is_windows_10_or_better() -> io::Result { + let hklm = winreg::enums::HKEY_LOCAL_MACHINE; + let key_path = "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion"; + let key = winreg::RegKey::predef(hklm).open_subkey(key_path)?; + + // check CurrentMajorVersionNumber, which only exists on Windows 10 and later + let value_name = "CurrentMajorVersionNumber"; + key.get_raw_value(value_name).map(|_| true) +} + +// 假设 interface_guid 是你的网络接口 GUID +pub struct InterfaceControl { + interface_guid: String, +} + +impl InterfaceControl { + // 构造函数 + pub fn new(interface_guid: &str) -> Self { + InterfaceControl { + interface_guid: interface_guid.to_string(), + } + } + + // 删除注册表值(模拟 delValue) + fn delete_value(key: &RegKey, value_name: &str) -> io::Result<()> { + match key.delete_value(value_name) { + Ok(_) => Ok(()), + Err(e) => { + if matches!(e.kind(), io::ErrorKind::NotFound) { + Ok(()) // 忽略不存在的值 + } else { + Err(e) + } + } + } + } + + pub fn set_primary_dns(&self, resolvers: &[IpAddr], domains: &[String]) -> io::Result<()> { + let (ipsv4, ipsv6): (Vec, Vec) = resolvers + .iter() + .map(|ip| ip.to_string()) + .partition(|ip| ip.contains('.')); + + let dom_strs: Vec = domains + .iter() + .map(|d| d.trim_end_matches('.').to_string()) + .collect(); + + // IPv4 处理 + if let Ok(key4) = RegistryManager::open_interface_key( + &self.interface_guid, + RegistryManager::IPV4_TCPIP_INTERFACE_PREFIX, + ) { + if ipsv4.is_empty() { + Self::delete_value(&key4, "NameServer")?; + } else { + key4.set_value("NameServer", &ipsv4.join(","))?; + } + + if dom_strs.is_empty() { + Self::delete_value(&key4, "SearchList")?; + } else { + key4.set_value("SearchList", &dom_strs.join(","))?; + } + + // 禁用 LLMNR(通过 DisableMulticast) + key4.set_value("EnableMulticast", &0u32)?; + } + + // IPv6 处理 + if let Ok(key6) = RegistryManager::open_interface_key( + &self.interface_guid, + RegistryManager::IPV6_TCPIP_INTERFACE_PREFIX, + ) { + if ipsv6.is_empty() { + Self::delete_value(&key6, "NameServer")?; + } else { + key6.set_value("NameServer", &ipsv6.join(","))?; + } + + if dom_strs.is_empty() { + Self::delete_value(&key6, "SearchList")?; + } else { + key6.set_value("SearchList", &dom_strs.join(","))?; + } + key6.set_value("EnableMulticast", &0u32)?; + } + + Ok(()) + } + + fn flush_dns(&self) -> io::Result<()> { + // 刷新 DNS 缓存 + let output = Command::new("ipconfig") + .arg("/flushdns") + .output() + .expect("failed to execute process"); + if !output.status.success() { + return Err(io::Error::other("Failed to flush DNS cache")); + } + Ok(()) + } + + // re-register DNS + pub fn re_register_dns(&self) -> io::Result<()> { + // ipconfig /registerdns + let output = Command::new("ipconfig") + .arg("/registerdns") + .output() + .expect("failed to execute process"); + if !output.status.success() { + return Err(io::Error::other("Failed to register DNS")); + } + Ok(()) + } +} + +pub struct WindowsDNSManager { + interface_control: InterfaceControl, +} + +impl WindowsDNSManager { + pub fn new(tun_dev_name: &str) -> io::Result { + let interface_guid = RegistryManager::find_interface_guid(tun_dev_name)?; + Ok(WindowsDNSManager { + interface_control: InterfaceControl::new(&interface_guid), + }) + } + + pub fn set_primary_dns(&self, resolvers: &[IpAddr], domains: &[String]) -> io::Result<()> { + self.interface_control.set_primary_dns(resolvers, domains)?; + self.interface_control.flush_dns()?; + Ok(()) + } +} + +impl SystemConfig for WindowsDNSManager { + fn set_dns(&self, cfg: &OSConfig) -> io::Result<()> { + self.set_primary_dns( + &cfg.nameservers + .iter() + .map(|s| s.parse::().unwrap()) + .collect::>(), + &cfg.match_domains, + )?; + Ok(()) + } + + fn close(&self) -> io::Result<()> { + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use cidr::Ipv4Inet; + + #[cfg(target_os = "windows")] + #[tokio::test] + async fn test_windows_set_primary_server() { + use std::{net::Ipv4Addr, str::FromStr as _, time::Duration}; + + use tokio_util::sync::CancellationToken; + + use crate::instance::dns_server::{ + runner::DnsRunner, + tests::{check_dns_record, prepare_env}, + }; + + let tun_ip = Ipv4Inet::from_str("10.144.144.10/24").unwrap(); + let (global_ctx, core_instance, virtual_nic) = prepare_env("test1", tun_ip).await; + let tun_name = virtual_nic.ifname().await.unwrap(); + + println!("dev_name: {}", tun_name); + let fake_ip = Ipv4Addr::from_str("100.100.100.101").unwrap(); + let mut dns_runner = DnsRunner::new( + core_instance.packet_plane(), + global_ctx, + Some(tun_name.clone()), + tun_ip, + fake_ip, + ); + + let cancel_token = CancellationToken::new(); + let cancel_token_clone = cancel_token.clone(); + let t = tokio::spawn(async move { + dns_runner.run(cancel_token_clone).await; + }); + + // windows is slow to add a ip address, wait for a longer time for dns server ready ,with ping + let now = std::time::Instant::now(); + while now.elapsed() < Duration::from_secs(15) { + tokio::time::sleep(Duration::from_secs(1)).await; + if let Ok(o) = tokio::process::Command::new("ping") + .arg("-n") + .arg("1") + .arg("-w") + .arg("100") + .arg(fake_ip.to_string()) + .output() + .await + && o.status.success() + { + break; + } + } + + check_dns_record(&fake_ip, "test1.et.net", "10.144.144.10").await; + + let dns_mgr = super::WindowsDNSManager::new(&tun_name).unwrap(); + println!("dev_name: {}", tun_name); + println!("guid: {}", dns_mgr.interface_control.interface_guid); + + dns_mgr + .interface_control + .set_primary_dns( + &["100.100.100.101".parse().unwrap()], + &[".et.net.".to_string()], + ) + .unwrap(); + dns_mgr.interface_control.flush_dns().unwrap(); + + tracing::info!("check dns record with nslookup"); + + // nslookup should return 10.144.144.10 + let ret = tokio::process::Command::new("nslookup") + .arg("test1.et.net") + .output() + .await + .expect("failed to execute process"); + assert!(ret.status.success()); + let output = String::from_utf8_lossy(&ret.stdout); + println!("nslookup output: {}", output); + assert!(output.contains("10.144.144.10")); + + cancel_token.cancel(); + let _ = t.await; + } +} diff --git a/vendor/easytier/easytier/src/instance/dns_server/tests.rs b/vendor/easytier/easytier/src/instance/dns_server/tests.rs new file mode 100644 index 0000000..2f5a3d8 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/dns_server/tests.rs @@ -0,0 +1,331 @@ +use std::net::{Ipv4Addr, SocketAddr}; +use std::str::FromStr as _; +use std::sync::Arc; +use std::time::Duration; + +use cidr::Ipv4Inet; +use easytier_core::{ + gateway::magic_dns::MagicDnsRoute, + host::packet::{HostPacket, HostPacketChannelSink, HostPacketReceiver}, + process_runtime::CoreProcessRuntime, +}; +use hickory_client::client::{Client, ClientHandle as _}; +use hickory_proto::rr; +use hickory_proto::runtime::TokioRuntimeProvider; +use hickory_proto::udp::UdpClientStream; +use tokio::sync::Notify; +use tokio_util::sync::CancellationToken; + +use crate::common::global_ctx::{ArcGlobalCtx, tests::get_mock_global_ctx}; +use crate::instance::{ + composition::{NativeCoreInstance, runtime_core_host_adapters}, + config::test_core_instance_config, +}; + +use crate::instance::dns_server::runner::DnsRunner; +use crate::instance::dns_server::server_instance::MagicDnsServerInstance; +use crate::instance::dns_server::{DEFAULT_ET_DNS_ZONE, MAGIC_DNS_FAKE_IP}; +use crate::instance::virtual_nic::NicCtx; +use crate::proto::api::instance::Route; +use crate::proto::magic_dns::{MagicDnsServerRpc as _, UpdateDnsRecordRequest}; +use crate::proto::rpc_types::controller::{BaseController, Controller as _}; + +pub async fn prepare_env( + dns_name: &str, + tun_ip: Ipv4Inet, +) -> (ArcGlobalCtx, Arc, NicCtx) { + prepare_env_with_tld_dns_zone(dns_name, tun_ip, None).await +} + +async fn build_test_core(ctx: ArcGlobalCtx) -> (Arc, HostPacketReceiver) { + let (packet_sink, packet_receiver) = tokio::sync::mpsc::channel::(128); + let adapters = runtime_core_host_adapters( + ctx.clone(), + CoreProcessRuntime::new(), + Arc::new(HostPacketChannelSink::new(packet_sink)), + ); + let core_instance = NativeCoreInstance::new(test_core_instance_config(&ctx), adapters).unwrap(); + core_instance.start().await.unwrap(); + (core_instance, HostPacketReceiver::new(packet_receiver)) +} + +pub async fn prepare_env_with_tld_dns_zone( + dns_name: &str, + tun_ip: Ipv4Inet, + tld_dns_zone: Option<&str>, +) -> (ArcGlobalCtx, Arc, NicCtx) { + let ctx = get_mock_global_ctx(); + ctx.set_hostname(dns_name.to_owned()); + ctx.set_ipv4(Some(tun_ip)); + + if tld_dns_zone.is_some() { + let mut flags = ctx.config.get_flags(); + flags.accept_dns = true; // Enable DNS + if let Some(zone) = tld_dns_zone { + flags.tld_dns_zone = zone.to_string(); + } + ctx.set_flags(flags); + } + + let (core_instance, host_packet_rx) = build_test_core(ctx.clone()).await; + let host_packet_rx = Arc::new(tokio::sync::Mutex::new(host_packet_rx)); + let mut virtual_nic = NicCtx::new( + ctx.clone(), + core_instance.packet_plane(), + host_packet_rx, + Arc::new(Notify::new()), + ); + virtual_nic.run(Some(tun_ip), None).await.unwrap(); + + (ctx, core_instance, virtual_nic) +} + +pub async fn check_dns_record(fake_ip: &Ipv4Addr, domain: &str, expected_ip: &str) { + let stream = UdpClientStream::builder( + SocketAddr::new((*fake_ip).into(), 53), + TokioRuntimeProvider::default(), + ) + .build(); + let (mut client, background) = Client::connect(stream).await.unwrap(); + let background_task = tokio::spawn(background); + let response = client + .query( + rr::Name::from_str(domain).unwrap(), + rr::DNSClass::IN, + rr::RecordType::A, + ) + .await + .unwrap_or_else(|e| panic!("DNS query failed unexpectedly for domain '{domain}': {e}")); + background_task.abort(); + let _ = background_task.await; + + println!("Response: {:?}", response); + + assert_eq!(response.answers().len(), 1, "{:?}", response.answers()); + let resp = response.answers().first().unwrap(); + assert_eq!( + resp.clone().into_parts().rdata.into_a().unwrap().0, + expected_ip.parse::().unwrap() + ); +} + +#[tokio::test] +async fn test_magic_dns_server_instance() { + let tun_ip = Ipv4Inet::from_str("10.144.144.10/24").unwrap(); + let (global_ctx, core_instance, virtual_nic) = prepare_env("test1", tun_ip).await; + let tun_name = virtual_nic.ifname().await.unwrap(); + let fake_ip = Ipv4Addr::from_str("100.100.100.101").unwrap(); + let dns_server_inst = MagicDnsServerInstance::new( + core_instance.packet_plane(), + global_ctx, + Some(tun_name), + tun_ip, + fake_ip, + ) + .await + .unwrap(); + + let routes = [ + MagicDnsRoute { + hostname: "test1".to_string(), + ipv4_addr: Some("8.8.8.8".parse().unwrap()), + }, + MagicDnsRoute { + hostname: "中文".to_string(), + ipv4_addr: Some("8.8.8.8".parse().unwrap()), + }, + MagicDnsRoute { + hostname: ".invalid".to_string(), + ipv4_addr: Some("8.8.8.8".parse().unwrap()), + }, + ]; + dns_server_inst + .data + .update_dns_records(routes.iter(), DEFAULT_ET_DNS_ZONE) + .await + .unwrap(); + + check_dns_record(&fake_ip, "test1.et.net", "8.8.8.8").await; + check_dns_record(&fake_ip, "中文.et.net", "8.8.8.8").await; +} + +#[tokio::test] +async fn test_magic_dns_runner() { + // Test first runner with default DNS settings + { + let tun_ip = Ipv4Inet::from_str("10.144.144.10/24").unwrap(); + let (global_ctx, core_instance, virtual_nic) = prepare_env("test1", tun_ip).await; + let tun_name = virtual_nic.ifname().await.unwrap(); + let fake_ip = Ipv4Addr::from_str(MAGIC_DNS_FAKE_IP).unwrap(); + let mut dns_runner = DnsRunner::new( + core_instance.packet_plane(), + global_ctx, + Some(tun_name), + tun_ip, + fake_ip, + ); + + let cancel_token = CancellationToken::new(); + let cancel_token_clone = cancel_token.clone(); + let t = tokio::spawn(async move { + dns_runner.run(cancel_token_clone).await; + }); + tokio::time::sleep(Duration::from_secs(3)).await; + + // Test default settings: query should resolve test1.et.net to tunnel IP via default fake IP + check_dns_record(&fake_ip, "test1.et.net", "10.144.144.10").await; + + cancel_token.cancel(); + t.await.unwrap(); + + // Wait a bit for cleanup + tokio::time::sleep(Duration::from_secs(1)).await; + } + + // Test second runner with different TLD zone + { + let tun_ip = Ipv4Inet::from_str("10.144.144.20/24").unwrap(); + // NOTE: Using same fake IP to avoid system DNS configuration conflicts + let custom_tld_zone = "custom.local."; // Different TLD zone is safer + let (global_ctx, core_instance, virtual_nic) = + prepare_env_with_tld_dns_zone("test2", tun_ip, Some(custom_tld_zone)).await; + let tun_name = virtual_nic.ifname().await.unwrap(); + let fake_ip = Ipv4Addr::from_str(MAGIC_DNS_FAKE_IP).unwrap(); + let mut dns_runner = DnsRunner::new( + core_instance.packet_plane(), + global_ctx, + Some(tun_name), + tun_ip, + fake_ip, + ); + + let cancel_token = CancellationToken::new(); + let cancel_token_clone = cancel_token.clone(); + let t = tokio::spawn(async move { + dns_runner.run(cancel_token_clone).await; + }); + tokio::time::sleep(Duration::from_secs(3)).await; + + // Test with same fake IP but different TLD zone + check_dns_record(&fake_ip, "test2.custom.local", "10.144.144.20").await; + + cancel_token.cancel(); + t.await.unwrap(); + } +} + +#[tokio::test] +async fn test_magic_dns_update_replaces_records_for_same_client() { + let tun_ip = Ipv4Inet::from_str("100.100.100.0/24").unwrap(); + let ctx = get_mock_global_ctx(); + ctx.set_hostname("test1".to_string()); + ctx.set_ipv4(Some(tun_ip)); + + let (core_instance, _packet_receiver) = build_test_core(ctx.clone()).await; + + let fake_ip = Ipv4Addr::from_str(MAGIC_DNS_FAKE_IP).unwrap(); + let dns_server_inst = + MagicDnsServerInstance::new(core_instance.packet_plane(), ctx, None, tun_ip, fake_ip) + .await + .unwrap(); + + let mut ctrl = BaseController::default(); + ctrl.set_tunnel_info(Some(crate::proto::common::TunnelInfo { + tunnel_type: "tcp".to_string(), + local_addr: None, + remote_addr: Some(crate::proto::common::Url { + url: "tcp://127.0.0.1:54321".to_string(), + }), + resolved_remote_addr: None, + })); + + dns_server_inst + .data + .update_dns_record( + ctrl.clone(), + UpdateDnsRecordRequest { + zone: DEFAULT_ET_DNS_ZONE.to_string(), + routes: vec![Route { + hostname: "test1".to_string(), + ipv4_addr: Some(Ipv4Inet::from_str("8.8.8.8/32").unwrap().into()), + ..Default::default() + }], + }, + ) + .await + .unwrap(); + + dns_server_inst + .data + .update_dns_record( + ctrl, + UpdateDnsRecordRequest { + zone: DEFAULT_ET_DNS_ZONE.to_string(), + routes: vec![Route { + hostname: "test1".to_string(), + ipv4_addr: Some(Ipv4Inet::from_str("1.1.1.1/32").unwrap().into()), + ..Default::default() + }], + }, + ) + .await + .unwrap(); + + let dns_records = dns_server_inst + .data + .get_dns_record( + BaseController::default(), + crate::proto::common::Void::default(), + ) + .await + .unwrap(); + let zone_records = dns_records.records.get(DEFAULT_ET_DNS_ZONE).unwrap(); + let a_records = zone_records + .records + .iter() + .filter_map(|record| match record.record.as_ref() { + Some(crate::proto::magic_dns::dns_record::Record::A(a)) + if a.name == "test1.et.net." => + { + Some(a) + } + _ => None, + }) + .collect::>(); + + assert_eq!(a_records.len(), 1, "{a_records:?}"); + let resolved_ip = Ipv4Addr::from(a_records[0].value.unwrap_or_default()); + assert_eq!(resolved_ip, Ipv4Addr::new(1, 1, 1, 1)); + + let mut ctrl = BaseController::default(); + ctrl.set_tunnel_info(Some(crate::proto::common::TunnelInfo { + tunnel_type: "tcp".to_string(), + local_addr: None, + remote_addr: Some(crate::proto::common::Url { + url: "tcp://127.0.0.1:54321".to_string(), + }), + resolved_remote_addr: None, + })); + + dns_server_inst + .data + .update_dns_record( + ctrl, + UpdateDnsRecordRequest { + zone: DEFAULT_ET_DNS_ZONE.to_string(), + routes: vec![], + }, + ) + .await + .unwrap(); + + let dns_records = dns_server_inst + .data + .get_dns_record( + BaseController::default(), + crate::proto::common::Void::default(), + ) + .await + .unwrap(); + assert!(!dns_records.records.contains_key(DEFAULT_ET_DNS_ZONE)); +} diff --git a/vendor/easytier/easytier/src/instance/factory.rs b/vendor/easytier/easytier/src/instance/factory.rs new file mode 100644 index 0000000..67dfb98 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/factory.rs @@ -0,0 +1,224 @@ +use std::sync::Arc; + +#[cfg(any(feature = "management-rpc", test))] +use easytier_core::instance::manager::InstanceManager; +#[cfg(feature = "management-rpc")] +use easytier_core::management::ProcessRuntimeProvider; +use easytier_core::{ + config::toml::TomlConfig, + instance::{CoreInstance, manager::InstanceFactory}, + process_runtime::CoreProcessRuntime, +}; + +use crate::common::global_ctx::EventBusSubscriber; + +use super::{ + composition::compose_native_core_instance, host::NativeInstanceHost, + runtime_host::NativeInstanceRuntimeHost, +}; + +pub type NativeCoreInstance = CoreInstance; +#[cfg(feature = "management-rpc")] +pub type NativeInstanceManager = InstanceManager; +#[cfg(feature = "management")] +pub type NativeProcessManagement = + easytier_core::management::ProcessManagement; + +#[cfg(feature = "management-rpc")] +pub fn native_instance_manager() -> NativeInstanceManager { + native_instance_manager_with_optional_runtime(None) +} + +#[cfg(feature = "management")] +pub fn native_cli_instance_manager() -> NativeInstanceManager { + let process_runtime = CoreProcessRuntime::new(); + InstanceManager::new( + NativeInstanceFactory::new(process_runtime).with_cli_event_logging(), + None, + ) +} + +pub fn create_native_instance(config: TomlConfig) -> anyhow::Result> { + NativeInstanceFactory::new(CoreProcessRuntime::new()).create(config, ()) +} + +/// Subscribes to native presentation events owned by this instance's runtime. +pub fn subscribe_native_instance_event( + instance: &NativeCoreInstance, +) -> Option { + instance + .runtime_host::() + .map(NativeInstanceRuntimeHost::subscribe_event) +} + +#[cfg(feature = "management-rpc")] +pub fn native_instance_manager_with_runtime( + runtime_handle: tokio::runtime::Handle, +) -> NativeInstanceManager { + native_instance_manager_with_optional_runtime(Some(runtime_handle)) +} + +#[cfg(feature = "management-rpc")] +pub fn native_compact_instance_manager_with_runtime( + runtime_handle: tokio::runtime::Handle, +) -> NativeInstanceManager { + let process_runtime = CoreProcessRuntime::new(); + let factory = NativeInstanceFactory::new(process_runtime) + .with_runtime_handle(Some(runtime_handle.clone())) + .with_compact_runtime(); + #[cfg(feature = "logging")] + let factory = factory.with_cli_event_logging(); + InstanceManager::new(factory, Some(runtime_handle)) +} + +#[cfg(feature = "management")] +pub fn native_process_management( + instances: Arc, + hooks: Arc, +) -> NativeProcessManagement { + NativeProcessManagement::new( + instances, + hooks, + Arc::new(easytier_core::management::UnsupportedConfigFileStorage), + ) +} + +#[cfg(feature = "management-rpc")] +fn native_instance_manager_with_optional_runtime( + runtime_handle: Option, +) -> NativeInstanceManager { + let process_runtime = CoreProcessRuntime::new(); + InstanceManager::new( + NativeInstanceFactory::new(process_runtime).with_runtime_handle(runtime_handle.clone()), + runtime_handle, + ) +} + +/// Native construction Adapter for the canonical core InstanceManager. +pub struct NativeInstanceFactory { + process_runtime: Arc, + runtime_handle: Option, + compact_runtime: bool, + #[cfg(feature = "logging")] + log_cli_events: bool, +} + +impl NativeInstanceFactory { + pub fn new(process_runtime: Arc) -> Self { + Self { + process_runtime, + runtime_handle: None, + compact_runtime: false, + #[cfg(feature = "logging")] + log_cli_events: false, + } + } + + #[cfg(feature = "logging")] + fn with_cli_event_logging(mut self) -> Self { + self.log_cli_events = true; + self + } + + #[cfg(feature = "management-rpc")] + fn with_runtime_handle(mut self, runtime_handle: Option) -> Self { + self.runtime_handle = runtime_handle; + self + } + + fn with_compact_runtime(mut self) -> Self { + self.compact_runtime = true; + self + } +} + +impl InstanceFactory for NativeInstanceFactory { + type Instance = NativeCoreInstance; + type CreateContext = (); + type Error = anyhow::Error; + + fn create( + &self, + config: TomlConfig, + (): Self::CreateContext, + ) -> Result, Self::Error> { + let _runtime = self + .runtime_handle + .as_ref() + .map(tokio::runtime::Handle::enter); + let instance = compose_native_core_instance( + config, + self.process_runtime.clone(), + self.compact_runtime, + )?; + #[cfg(feature = "logging")] + if self.log_cli_events { + let events = subscribe_native_instance_event(&instance) + .ok_or_else(|| anyhow::anyhow!("native instance runtime host is unavailable"))?; + super::cli_event_logger::spawn(instance.instance_id(), events); + } + Ok(instance) + } +} + +#[cfg(feature = "management-rpc")] +impl ProcessRuntimeProvider for NativeInstanceFactory { + fn process_runtime(&self) -> Arc { + self.process_runtime.clone() + } +} + +#[cfg(test)] +mod tests { + use easytier_core::{config::toml::ConfigLoader as _, instance::CoreInstanceState}; + + use super::*; + + #[tokio::test] + async fn core_manager_stores_and_runs_native_core_instance_directly() { + let factory = NativeInstanceFactory::new(CoreProcessRuntime::new()); + let manager = InstanceManager::new(factory, None); + let config = TomlConfig::default(); + let mut flags = config.get_flags(); + flags.no_tun = true; + config.set_flags(flags); + config.set_listeners(Vec::new()); + + let instance = manager.create(config, ()).unwrap(); + instance.start().await.unwrap(); + assert_eq!(instance.state(), CoreInstanceState::Running); + + manager + .delete_network_instances([instance.instance_id()]) + .await + .unwrap(); + assert_eq!(instance.state(), CoreInstanceState::Stopped); + } + + #[test] + fn configured_runtime_supports_synchronous_instance_construction() { + let runtime = tokio::runtime::Runtime::new().unwrap(); + let factory = NativeInstanceFactory::new(CoreProcessRuntime::new()) + .with_runtime_handle(Some(runtime.handle().clone())); + let manager = InstanceManager::new(factory, Some(runtime.handle().clone())); + let config = TomlConfig::default(); + config.set_listeners(Vec::new()); + + let instance = manager.create(config, ()).unwrap(); + + drop(instance); + } + + #[test] + fn event_subscription_is_recovered_from_the_native_runtime() { + let runtime = tokio::runtime::Runtime::new().unwrap(); + let factory = NativeInstanceFactory::new(CoreProcessRuntime::new()) + .with_runtime_handle(Some(runtime.handle().clone())); + let manager = InstanceManager::new(factory, Some(runtime.handle().clone())); + let config = TomlConfig::default(); + config.set_listeners(Vec::new()); + + let instance = manager.create(config, ()).unwrap(); + assert!(subscribe_native_instance_event(&instance).is_some()); + } +} diff --git a/vendor/easytier/easytier/src/instance/host.rs b/vendor/easytier/easytier/src/instance/host.rs new file mode 100644 index 0000000..5b4b2b5 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/host.rs @@ -0,0 +1,59 @@ +use std::{net::IpAddr, sync::Arc}; + +use easytier_core::{ + connectivity::composite::{ConnectorEnvironment, ConnectorHostAdapter}, + socket::{NetNamespace, SocketContext}, +}; + +use crate::{ + common::global_ctx::ArcGlobalCtx, + host_runtime::{NativeHostRuntime, native_host_runtime}, +}; + +pub type NativeInstanceHost = ConnectorHostAdapter; + +/// Instance facts queried by portable connector policy. +/// +/// This Adapter never creates or operates sockets. Mechanical network I/O is +/// owned by the process-wide [`NativeHostRuntime`] composed beside it. +pub struct NativeInstanceEnvironment { + global_ctx: ArcGlobalCtx, + runtime: Arc, + socket_context: SocketContext, +} + +impl NativeInstanceEnvironment { + fn new(global_ctx: ArcGlobalCtx, runtime: Arc) -> Self { + let socket_context = SocketContext::default() + .with_socket_mark(global_ctx.get_flags().socket_mark) + .with_netns(global_ctx.net_ns.name().map(NetNamespace::new)); + Self { + global_ctx, + runtime, + socket_context, + } + } +} + +pub(crate) fn native_instance_host(global_ctx: ArcGlobalCtx) -> Arc { + let runtime = native_host_runtime(); + Arc::new(ConnectorHostAdapter::new( + runtime.clone(), + Arc::new(NativeInstanceEnvironment::new(global_ctx, runtime)), + )) +} + +impl ConnectorEnvironment for NativeInstanceEnvironment { + fn socket_context(&self) -> SocketContext { + self.socket_context.clone() + } + + fn mapped_listeners(&self) -> Vec { + self.global_ctx.runtime_mapped_listeners() + } + + fn is_local_ip(&self, ip: &IpAddr) -> bool { + self.global_ctx.is_ip_local_virtual_ip(ip) + || self.runtime.is_local_ip(ip, &self.socket_context) + } +} diff --git a/vendor/easytier/easytier/src/instance/listeners.rs b/vendor/easytier/easytier/src/instance/listeners.rs new file mode 100644 index 0000000..1192e83 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/listeners.rs @@ -0,0 +1,224 @@ +use std::fmt::Debug; + +use async_trait::async_trait; +use easytier_core::listener::{ + ExternalListenerFactory, ExternalListenerRequest, transport::AcceptedTransport, +}; +use easytier_core::socket::SocketListener; + +#[cfg(feature = "faketcp")] +use crate::common::netns::NetNS; +use crate::socket::tcp::RuntimeTcpSocket; + +pub(crate) struct RuntimeExternalListenerFactory; + +impl ExternalListenerFactory> + for RuntimeExternalListenerFactory +{ + #[allow(clippy::match_like_matches_macro)] + fn supports_scheme(&self, scheme: &str) -> bool { + match scheme { + "faketcp" => cfg!(feature = "faketcp"), + "unix" => cfg!(unix), + _ => false, + } + } + + fn create( + &self, + request: ExternalListenerRequest, + ) -> Box>> { + match request.url.scheme() { + #[cfg(feature = "faketcp")] + "faketcp" => Box::new(RuntimeFakeTcpSocketListener::new( + request.url, + NetNS::from_socket_context(&request.socket_context), + )), + #[cfg(unix)] + "unix" => Box::new(RuntimeUnixStreamListener::new(request.url)), + scheme => unreachable!("core requested unsupported external listener: {scheme}"), + } + } +} + +#[cfg(unix)] +struct RuntimeUnixStreamListener { + url: url::Url, + inner: Option, +} + +#[cfg(unix)] +impl RuntimeUnixStreamListener { + fn new(url: url::Url) -> Self { + Self { url, inner: None } + } +} + +#[cfg(unix)] +fn unix_stream_remote_url(remote_addr: tokio::net::unix::SocketAddr) -> url::Url { + crate::socket::tcp::url_from_unix_socket_addr(remote_addr).unwrap_or_else(|| { + format!("unix://anonymous/{}", uuid::Uuid::new_v4()) + .parse() + .expect("synthetic Unix stream URL should be valid") + }) +} + +#[cfg(unix)] +impl Debug for RuntimeUnixStreamListener { + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("RuntimeUnixStreamListener") + .field("url", &self.url) + .field("listening", &self.inner.is_some()) + .finish() + } +} + +#[cfg(unix)] +#[async_trait] +impl SocketListener for RuntimeUnixStreamListener { + type Accepted = AcceptedTransport; + + async fn listen(&mut self) -> anyhow::Result<()> { + if self.inner.is_none() { + self.inner = Some(tokio::net::UnixListener::bind(self.url.path())?); + } + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + let (stream, remote_addr) = self + .inner + .as_ref() + .ok_or_else(|| anyhow::anyhow!("Unix stream listener is not started"))? + .accept() + .await?; + Ok(AcceptedTransport::ByteStream { + socket: RuntimeTcpSocket::from_unix(stream), + local_url: self.url.clone(), + remote_url: Some(unix_stream_remote_url(remote_addr)), + }) + } + + fn local_url(&self) -> url::Url { + self.url.clone() + } +} + +#[cfg(unix)] +impl Drop for RuntimeUnixStreamListener { + fn drop(&mut self) { + let _ = std::fs::remove_file(self.url.path()); + } +} + +#[cfg(feature = "faketcp")] +struct RuntimeFakeTcpSocketListener { + net_ns: NetNS, + inner: crate::socket::fake_tcp::FakeTcpSocketListener, +} + +#[cfg(feature = "faketcp")] +impl RuntimeFakeTcpSocketListener { + fn new(url: url::Url, net_ns: NetNS) -> Self { + Self { + net_ns, + inner: crate::socket::fake_tcp::FakeTcpSocketListener::new(url), + } + } +} + +#[cfg(feature = "faketcp")] +impl Debug for RuntimeFakeTcpSocketListener { + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("RuntimeFakeTcpSocketListener") + .field("url", &SocketListener::local_url(&self.inner)) + .finish() + } +} + +#[cfg(feature = "faketcp")] +#[async_trait] +impl SocketListener for RuntimeFakeTcpSocketListener { + type Accepted = AcceptedTransport; + + async fn listen(&mut self) -> anyhow::Result<()> { + let _guard = self.net_ns.guard(); + SocketListener::listen(&mut self.inner).await?; + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + let local_url = SocketListener::local_url(&self.inner); + let socket = self.inner.accept_socket().await?; + Ok(AcceptedTransport::Tcp { + socket: RuntimeTcpSocket::from_fake_tcp(socket), + local_url, + upgrade_permit: None, + }) + } + + fn local_url(&self) -> url::Url { + SocketListener::local_url(&self.inner) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn external_listener_capabilities_follow_native_build() { + let factory = RuntimeExternalListenerFactory; + + assert_eq!( + factory.supports_scheme("faketcp"), + cfg!(feature = "faketcp") + ); + assert_eq!(factory.supports_scheme("unix"), cfg!(unix)); + assert!(!factory.supports_scheme("tcp")); + } + + #[cfg(unix)] + #[tokio::test] + async fn unix_adapters_exchange_bytes_and_unlink_listener() { + use easytier_core::connectivity::composite::ConnectorRuntime; + use tokio::io::{AsyncReadExt, AsyncWriteExt}; + + let directory = tempfile::tempdir().unwrap(); + let path = directory.path().join("easytier.sock"); + let url: url::Url = format!("unix://{}", path.display()).parse().unwrap(); + let mut listener = RuntimeUnixStreamListener::new(url.clone()); + SocketListener::listen(&mut listener).await.unwrap(); + + let runtime = crate::host_runtime::native_host_runtime(); + let (accepted, connected) = tokio::join!( + SocketListener::accept(&mut listener), + runtime.connect_byte_stream(&url), + ); + let AcceptedTransport::ByteStream { + socket: mut server, + local_url, + .. + } = accepted.unwrap() + else { + panic!("Unix listener returned a non-byte-stream transport"); + }; + let (mut client, _, _, _) = connected.unwrap().into_parts(); + assert_eq!(local_url, url); + + client.write_all(b"ping").await.unwrap(); + let mut request = [0; 4]; + server.read_exact(&mut request).await.unwrap(); + assert_eq!(&request, b"ping"); + + server.write_all(b"pong").await.unwrap(); + let mut response = [0; 4]; + client.read_exact(&mut response).await.unwrap(); + assert_eq!(&response, b"pong"); + + drop(listener); + assert!(!path.exists()); + } +} diff --git a/vendor/easytier/easytier/src/instance/mod.rs b/vendor/easytier/easytier/src/instance/mod.rs new file mode 100644 index 0000000..39dc320 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/mod.rs @@ -0,0 +1,25 @@ +#[cfg(feature = "logging")] +pub(crate) mod cli_event_logger; +pub(crate) mod composition; +pub(crate) mod config; +#[cfg(feature = "management")] +pub(crate) mod config_storage; +pub mod dns_server; +pub mod factory; +pub mod host; +pub(crate) mod runtime_host; +#[cfg(test)] +pub(crate) mod test_instance; +#[cfg(feature = "upnp")] +pub(crate) mod udp_hole_punch; + +pub(crate) mod listeners; + +#[cfg(feature = "public-ipv6-provider")] +pub(crate) mod public_ipv6_provider; + +#[cfg(feature = "tun")] +pub mod virtual_nic; + +#[cfg(any(all(windows, feature = "tun"), test))] +pub(crate) mod windows_udp_broadcast; diff --git a/vendor/easytier/easytier/src/instance/public_ipv6_provider.rs b/vendor/easytier/easytier/src/instance/public_ipv6_provider.rs new file mode 100644 index 0000000..839a687 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/public_ipv6_provider.rs @@ -0,0 +1,71 @@ +use crate::common::global_ctx::GlobalCtxEvent; + +#[cfg(target_os = "linux")] +#[path = "public_ipv6_provider/linux.rs"] +mod platform; +#[cfg(not(target_os = "linux"))] +#[path = "public_ipv6_provider/unsupported.rs"] +mod platform; + +pub(crate) use platform::runtime_public_ipv6_provider_platform; + +fn should_reconcile_immediately(event: &GlobalCtxEvent) -> bool { + match event { + #[cfg(feature = "management")] + GlobalCtxEvent::ConfigPatched(_) => true, + GlobalCtxEvent::TunDeviceReady(_) + | GlobalCtxEvent::TunDeviceError(_) + | GlobalCtxEvent::PublicIpv6RoutesUpdated(_, _) => true, + _ => false, + } +} + +pub(super) async fn wait_for_public_ipv6_provider_reconcile_event( + event_receiver: &mut tokio::sync::broadcast::Receiver, +) -> bool { + loop { + match event_receiver.recv().await { + Ok(event) if should_reconcile_immediately(&event) => return true, + Ok(_) => {} + Err(tokio::sync::broadcast::error::RecvError::Closed) => return false, + Err(tokio::sync::broadcast::error::RecvError::Lagged(_)) => { + *event_receiver = event_receiver.resubscribe(); + return true; + } + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[tokio::test] + async fn wait_for_reconcile_ignores_unrelated_events() { + let (tx, mut rx) = tokio::sync::broadcast::channel(16); + let trigger_tx = tx.clone(); + let spam_task = tokio::spawn(async move { + loop { + if tx.send(GlobalCtxEvent::PeerAdded(1)).is_err() { + break; + } + tokio::time::sleep(std::time::Duration::from_millis(5)).await; + } + }); + let trigger_task = tokio::spawn(async move { + tokio::time::sleep(std::time::Duration::from_millis(50)).await; + let _ = trigger_tx.send(GlobalCtxEvent::TunDeviceReady("et-test".to_owned())); + }); + + let reconciled = tokio::time::timeout( + std::time::Duration::from_millis(250), + wait_for_public_ipv6_provider_reconcile_event(&mut rx), + ) + .await + .expect("a relevant event should wake the reconcile loop"); + + spam_task.abort(); + trigger_task.await.unwrap(); + assert!(reconciled); + } +} diff --git a/vendor/easytier/easytier/src/instance/public_ipv6_provider/linux.rs b/vendor/easytier/easytier/src/instance/public_ipv6_provider/linux.rs new file mode 100644 index 0000000..f6052ee --- /dev/null +++ b/vendor/easytier/easytier/src/instance/public_ipv6_provider/linux.rs @@ -0,0 +1,1487 @@ +use std::path::Path; +use std::sync::Arc; + +use super::wait_for_public_ipv6_provider_reconcile_event; + +use crate::common::ifcfg::{ + RouteMessage, RouteType, add_ipv6_ndp_proxy, get_interface_index, list_ipv6_ndp_proxy, + list_ipv6_route_messages, remove_ipv6_ndp_proxy, +}; +use crate::common::netns::NetNS; +use crate::common::{ + error::Error, + global_ctx::{ArcGlobalCtx, GlobalCtxEvent}, +}; +use anyhow::Context; +use cidr::{Ipv6Cidr, Ipv6Inet}; +use easytier_core::config::peers::PublicIpv6ProviderConfig; +use easytier_core::peers::public_ipv6::is_global_routable_public_ipv6_prefix; +use easytier_core::peers::public_ipv6::provider::PublicIpv6NdpTarget; +use easytier_core::peers::public_ipv6::provider::{ + PublicIpv6NdpDesired, PublicIpv6PlatformError, PublicIpv6PlatformObservation, + PublicIpv6ProviderPlatform, +}; + +#[cfg(test)] +fn ensure_public_ipv6_provider_supported() -> Result<(), Error> { + PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: None, + provider_supported: cfg!(target_os = "linux"), + } + .validate() + .map_err(|error| anyhow::Error::new(error).into()) +} + +fn read_linux_proc_bool(path: &Path) -> Result { + let value = std::fs::read_to_string(path) + .with_context(|| format!("failed to read {}", path.display()))?; + match value.trim() { + "0" => Ok(false), + "1" => Ok(true), + other => Err(anyhow::anyhow!("unexpected value '{}' in {}", other, path.display()).into()), + } +} + +fn write_linux_proc_bool(path: &Path, enabled: bool) -> Result<(), Error> { + let value = if enabled { "1\n" } else { "0\n" }; + std::fs::write(path, value).with_context(|| format!("failed to write {}", path.display()))?; + Ok(()) +} + +fn ensure_linux_ipv6_forwarding_at_paths( + all_path: &Path, + default_path: &Path, +) -> Result { + let all_enabled = read_linux_proc_bool(all_path)?; + let default_enabled = read_linux_proc_bool(default_path)?; + let mut changed = false; + + if !all_enabled { + write_linux_proc_bool(all_path, true)?; + changed = true; + } + + if !default_enabled { + write_linux_proc_bool(default_path, true)?; + changed = true; + } + + if !read_linux_proc_bool(all_path)? || !read_linux_proc_bool(default_path)? { + return Err(anyhow::anyhow!( + "failed to enable Linux IPv6 forwarding in {} and {}", + all_path.display(), + default_path.display() + ) + .into()); + } + + Ok(changed) +} + +fn ensure_linux_ipv6_forwarding() -> Result { + let all_path = Path::new("/proc/sys/net/ipv6/conf/all/forwarding"); + let default_path = Path::new("/proc/sys/net/ipv6/conf/default/forwarding"); + + ensure_linux_ipv6_forwarding_at_paths(all_path, default_path).map_err(|err| { + anyhow::anyhow!( + "public IPv6 provider requires Linux IPv6 forwarding; failed to enable net.ipv6.conf.all.forwarding=1 and net.ipv6.conf.default.forwarding=1 automatically: {}. run with sufficient privileges or set them manually", + err + ) + .into() + }) +} + +#[derive(Clone, Debug, PartialEq, Eq)] +struct DetectedIpv6Route { + dst: Option, + src: Option, + ifindex: Option, + kind: RouteType, +} + +#[derive(Clone, Debug, PartialEq, Eq)] +struct DetectedPublicIpv6Prefix { + prefix: Ipv6Cidr, + ndp_target: Option, +} + +fn ipv6_cidr_from_route_addr(addr: &std::net::IpAddr, prefix_len: u8) -> Option { + match addr { + std::net::IpAddr::V6(addr) => Ipv6Cidr::new(*addr, prefix_len).ok(), + _ => None, + } +} + +impl TryFrom for DetectedIpv6Route { + type Error = Error; + + fn try_from(message: RouteMessage) -> Result { + let dst = message + .destination() + .and_then(|addr| ipv6_cidr_from_route_addr(addr, message.dst_len())); + let src = message + .source() + .and_then(|addr| ipv6_cidr_from_route_addr(addr, message.src_len())); + + Ok(Self { + dst, + src, + ifindex: message.oif(), + kind: message.route_type(), + }) + } +} + +fn is_ipv6_default_route(dst: Option) -> bool { + dst.is_none() || dst == Some(Ipv6Cidr::new(std::net::Ipv6Addr::UNSPECIFIED, 0).unwrap()) +} + +fn detect_public_ipv6_prefix_from_routes( + routes: &[DetectedIpv6Route], + loopback_ifindex: u32, +) -> Option { + routes + .iter() + .filter_map(|route| { + if !is_ipv6_default_route(route.dst) || route.kind != RouteType::Unicast { + return None; + } + + let prefix = route.src?; + let wan_ifindex = route.ifindex?; + if !is_global_routable_public_ipv6_prefix(prefix) { + return None; + } + + let delegated = routes.iter().any(|candidate| { + candidate.dst == Some(prefix) + && candidate.ifindex.is_some() + && candidate.ifindex != Some(wan_ifindex) + && candidate.ifindex != Some(loopback_ifindex) + && candidate.kind == RouteType::Unicast + }); + + delegated.then_some(DetectedPublicIpv6Prefix { + prefix, + ndp_target: None, + }) + }) + .min_by_key(|detected| detected.prefix.network_length()) +} + +#[derive(Clone, Debug, PartialEq, Eq)] +struct DetectedDefaultRouteIpv6Interface { + interface_name: String, + ifindex: u32, + address: std::net::Ipv6Addr, + prefix: Ipv6Cidr, +} + +#[derive(Clone, Debug, PartialEq, Eq)] +struct DefaultRouteIpv6InterfaceCandidate { + interface_name: String, + ifindex: u32, + address: std::net::Ipv6Addr, + prefix_len: u8, +} + +fn default_route_ifindices(routes: &[DetectedIpv6Route]) -> std::collections::BTreeSet { + routes + .iter() + .filter(|route| is_ipv6_default_route(route.dst) && route.kind == RouteType::Unicast) + .filter_map(|route| route.ifindex) + .collect() +} + +fn select_default_route_ipv6_interfaces( + candidates: impl IntoIterator, + wan_ifindices: &std::collections::BTreeSet, + max_prefix_len: u8, +) -> Vec { + candidates + .into_iter() + .filter_map(|candidate| { + if !wan_ifindices.contains(&candidate.ifindex) { + return None; + } + + if candidate.address.is_loopback() + || candidate.address.is_multicast() + || candidate.address.is_unicast_link_local() + || candidate.address.is_unique_local() + || candidate.address.is_unspecified() + { + return None; + } + + if candidate.prefix_len == 0 || candidate.prefix_len > max_prefix_len { + return None; + } + + let prefix = Ipv6Inet::new(candidate.address, candidate.prefix_len) + .ok() + .map(|inet| inet.network())?; + + Some(DetectedDefaultRouteIpv6Interface { + interface_name: candidate.interface_name, + ifindex: candidate.ifindex, + address: candidate.address, + prefix, + }) + }) + .collect() +} + +fn detect_default_route_ipv6_interfaces( + routes: &[DetectedIpv6Route], + max_prefix_len: u8, +) -> Vec { + use crate::common::network::ip_mask_to_prefix; + use nix::ifaddrs::getifaddrs; + use nix::sys::socket::SockaddrLike; + + let wan_ifindices = default_route_ifindices(routes); + if wan_ifindices.is_empty() { + return Vec::new(); + } + + let Ok(interfaces) = getifaddrs() else { + return Vec::new(); + }; + + let candidates = interfaces + .filter_map(|iface| { + let address = iface.address?; + let netmask = iface.netmask?; + let ifindex = get_interface_index(&iface.interface_name).ok()?; + + if address.family()? != nix::sys::socket::AddressFamily::Inet6 { + return None; + } + + let ipv6_addr = address.as_sockaddr_in6()?.ip(); + let netmask_ip = netmask.as_sockaddr_in6()?.ip(); + let prefix_len = ip_mask_to_prefix(std::net::IpAddr::V6(netmask_ip)).ok()?; + + Some(DefaultRouteIpv6InterfaceCandidate { + interface_name: iface.interface_name, + ifindex, + address: ipv6_addr, + prefix_len, + }) + }) + .collect::>(); + + select_default_route_ipv6_interfaces(candidates, &wan_ifindices, max_prefix_len) +} + +fn select_public_ipv6_prefix_from_default_route_interfaces( + candidates: impl IntoIterator, +) -> Option { + let iface = candidates + .into_iter() + .min_by_key(|iface| (iface.prefix.network_length(), iface.ifindex))?; + Some(DetectedPublicIpv6Prefix { + prefix: iface.prefix, + ndp_target: Some(PublicIpv6NdpTarget { + wan_interface: iface.interface_name, + }), + }) +} + +fn detect_public_ipv6_prefix_from_interfaces( + routes: &[DetectedIpv6Route], +) -> Option { + select_public_ipv6_prefix_from_default_route_interfaces(detect_default_route_ipv6_interfaces( + routes, 64, + )) +} + +fn ipv6_cidr_contains_cidr(outer: Ipv6Cidr, inner: Ipv6Cidr) -> bool { + outer.contains(&inner.first_address()) && outer.contains(&inner.last_address()) +} + +fn detect_configured_prefix_ndp_proxy_target( + routes: &[DetectedIpv6Route], + prefix: Ipv6Cidr, +) -> Option { + let wan_ifindices = default_route_ifindices(routes); + if wan_ifindices.is_empty() { + return None; + } + + let loopback_ifindex = get_interface_index("lo").ok(); + let routed = routes.iter().any(|route| { + route.dst == Some(prefix) + && route.kind == RouteType::Unicast + && route.ifindex.is_some_and(|ifindex| { + !wan_ifindices.contains(&ifindex) && Some(ifindex) != loopback_ifindex + }) + }); + if routed { + return None; + } + + detect_default_route_ipv6_interfaces(routes, 128) + .into_iter() + .filter(|iface| { + ipv6_cidr_contains_cidr(iface.prefix, prefix) + || (iface.prefix.network_length() == 128 && prefix.contains(&iface.address)) + }) + .min_by_key(|iface| (iface.prefix.network_length(), iface.ifindex)) + .map(|iface| PublicIpv6NdpTarget { + wan_interface: iface.interface_name, + }) +} + +fn list_detected_ipv6_routes() -> Result, Error> { + let routes = list_ipv6_route_messages().with_context(|| "failed to query linux ipv6 routes")?; + routes + .iter() + .cloned() + .map(DetectedIpv6Route::try_from) + .collect::, _>>() +} + +fn detect_public_ipv6_prefix_linux() -> Result, Error> { + let routes = list_detected_ipv6_routes()?; + let loopback_ifindex = + get_interface_index("lo").with_context(|| "failed to resolve linux loopback ifindex")?; + + if let Some(prefix) = detect_public_ipv6_prefix_from_routes(&routes, loopback_ifindex) { + return Ok(Some(prefix)); + } + + // Fallback for DHCPv6 IA_NA / SLAAC — see https://github.com/EasyTier/EasyTier/issues/2333 + Ok(detect_public_ipv6_prefix_from_interfaces(&routes)) +} + +#[derive(Default)] +struct NdpProxyRuntime { + wan_iface: Option, + applied: std::collections::BTreeSet, +} + +impl NdpProxyRuntime { + fn reconcile( + &mut self, + global_ctx: &ArcGlobalCtx, + desired: Option<&PublicIpv6NdpDesired>, + ) -> bool { + let Some(desired) = desired else { + return !self.clear_current(global_ctx); + }; + + let Some(tun_iface) = global_ctx.get_tun_device_name() else { + self.clear_current(global_ctx); + tracing::debug!("waiting for tun device before syncing NDP proxy entries"); + return self.cleanup_pending(); + }; + + let _g = global_ctx.net_ns.guard(); + + if self.wan_iface.as_deref() != Some(desired.target.wan_interface.as_str()) { + if !self.clear_current_locked() { + tracing::warn!( + old_wan_iface = ?self.wan_iface, + new_wan_iface = %desired.target.wan_interface, + remaining_entries = self.applied.len(), + "waiting to remove old NDP proxy entries before switching WAN interface" + ); + return true; + } + self.wan_iface = Some(desired.target.wan_interface.clone()); + } + + if let Err(err) = sync_ndp_proxy_entries( + desired.target.wan_interface.as_str(), + tun_iface.as_str(), + desired.prefix, + &mut self.applied, + ) { + tracing::warn!( + wan_iface = %desired.target.wan_interface, + tun_iface = %tun_iface, + ?err, + "failed to sync NDP proxy entries" + ); + } + self.cleanup_pending() + } + + fn clear_current(&mut self, global_ctx: &ArcGlobalCtx) -> bool { + self.clear_current_in_netns(&global_ctx.net_ns) + } + + fn clear_current_in_netns(&mut self, net_ns: &NetNS) -> bool { + let _g = net_ns.guard(); + self.clear_current_locked() + } + + fn clear_current_locked(&mut self) -> bool { + let Some(wan_iface) = self.wan_iface.clone() else { + return self.applied.is_empty(); + }; + + match list_ipv6_ndp_proxy(wan_iface.as_str()) { + Ok(current) => { + let candidates = self.applied.iter().copied().collect::>(); + clear_owned_ndp_proxy_entries( + wan_iface.as_str(), + ¤t, + &mut self.applied, + candidates, + ); + } + Err(err) if is_linux_missing_netlink_object_error(&err) => { + tracing::trace!( + wan_iface = %wan_iface, + ?err, + "forgetting NDP proxy ownership because WAN interface is gone" + ); + self.applied.clear(); + } + Err(err) => { + tracing::trace!( + wan_iface = %wan_iface, + ?err, + "failed to list NDP proxy entries before cleanup" + ); + } + } + + if self.applied.is_empty() { + self.wan_iface = None; + true + } else { + false + } + } + + fn cleanup_pending(&self) -> bool { + self.wan_iface.is_some() && !self.applied.is_empty() + } +} + +fn is_linux_missing_netlink_object_error(err: &Error) -> bool { + match err { + Error::IOError(err) => { + err.kind() == std::io::ErrorKind::NotFound + || matches!( + err.raw_os_error(), + Some(nix::libc::ESRCH | nix::libc::ENODEV | nix::libc::ENXIO) + ) + } + _ => false, + } +} + +fn clear_owned_ndp_proxy_entries( + wan_iface: &str, + current: &std::collections::BTreeSet, + applied: &mut std::collections::BTreeSet, + candidates: Vec, +) -> Option { + let mut first_err = None; + for addr in candidates { + if !current.contains(&addr) { + applied.remove(&addr); + continue; + } + + if let Err(err) = remove_ipv6_ndp_proxy(wan_iface, addr) { + if is_linux_missing_netlink_object_error(&err) { + applied.remove(&addr); + } else { + tracing::trace!( + wan_iface = %wan_iface, + addr = %addr, + ?err, + "failed to remove NDP proxy entry" + ); + first_err.get_or_insert(err); + } + } else { + applied.remove(&addr); + } + } + first_err +} + +fn ensure_linux_ndp_proxy_enabled(wan_iface: &str) -> Result<(), Error> { + let path = Path::new("/proc/sys/net/ipv6/conf") + .join(wan_iface) + .join("proxy_ndp"); + if !read_linux_proc_bool(&path)? { + write_linux_proc_bool(&path, true)?; + tracing::info!(wan_iface = %wan_iface, "enabled Linux NDP proxy"); + } + Ok(()) +} + +fn collect_public_ipv6_tun_routes( + tun_iface: &str, + prefix: Ipv6Cidr, +) -> Result, Error> { + let tun_ifindex = match get_interface_index(tun_iface) { + Ok(ifindex) => ifindex, + Err(err) if is_linux_missing_netlink_object_error(&err) => { + tracing::debug!( + tun_iface = %tun_iface, + ?err, + "treating missing tun interface as empty public IPv6 route set" + ); + return Ok(Default::default()); + } + Err(err) => return Err(err), + }; + Ok(list_ipv6_route_messages()? + .into_iter() + .filter(|route| route.dst_len() == 128 && route.route_type() == RouteType::Unicast) + .filter(|route| route.oif() == Some(tun_ifindex)) + .filter_map(|route| match route.destination() { + Some(std::net::IpAddr::V6(addr)) => Some(*addr), + _ => None, + }) + .filter(|addr| !addr.is_unicast_link_local() && prefix.contains(addr)) + .collect()) +} + +fn sync_ndp_proxy_entries( + wan_iface: &str, + tun_iface: &str, + prefix: Ipv6Cidr, + applied: &mut std::collections::BTreeSet, +) -> Result<(), Error> { + ensure_linux_ndp_proxy_enabled(wan_iface)?; + + let wanted = collect_public_ipv6_tun_routes(tun_iface, prefix)?; + let current = list_ipv6_ndp_proxy(wan_iface)?; + + let mut first_err = None; + for addr in wanted.difference(¤t) { + if let Err(err) = add_ipv6_ndp_proxy(wan_iface, *addr) { + first_err.get_or_insert(err); + } else { + applied.insert(*addr); + tracing::debug!(wan_iface = %wan_iface, addr = %addr, "added NDP proxy entry"); + } + } + + let stale = applied.difference(&wanted).copied().collect::>(); + let stale_cleanup_err = + clear_owned_ndp_proxy_entries(wan_iface, ¤t, applied, stale.clone()); + if !stale.is_empty() { + tracing::debug!( + wan_iface = %wan_iface, + stale_count = stale.len(), + remaining_count = stale.iter().filter(|addr| applied.contains(addr)).count(), + "synced stale NDP proxy entries" + ); + } + if let Some(err) = first_err.or(stale_cleanup_err) { + return Err(err); + } + + Ok(()) +} + +fn cleanup_ndp_proxy_runtime(runtime: &mut NdpProxyRuntime, net_ns: &NetNS) -> bool { + let complete = runtime.clear_current_in_netns(net_ns); + if !complete { + tracing::warn!( + remaining_entries = runtime.applied.len(), + wan_iface = ?runtime.wan_iface, + "failed to clean all NDP proxy entries before stopping public IPv6 provider task" + ); + } + complete +} + +pub(super) struct RuntimePublicIpv6ProviderPlatform { + global_ctx: std::sync::Weak, + net_ns: NetNS, + event_receiver: tokio::sync::Mutex>, + ndp_proxy: std::sync::Mutex, +} + +impl RuntimePublicIpv6ProviderPlatform { + pub(super) fn new(global_ctx: &ArcGlobalCtx) -> Arc { + Arc::new(Self { + global_ctx: Arc::downgrade(global_ctx), + net_ns: global_ctx.net_ns.clone(), + event_receiver: tokio::sync::Mutex::new(global_ctx.subscribe()), + ndp_proxy: std::sync::Mutex::new(NdpProxyRuntime::default()), + }) + } +} + +#[async_trait::async_trait] +impl PublicIpv6ProviderPlatform for RuntimePublicIpv6ProviderPlatform { + fn inspect( + &self, + config: PublicIpv6ProviderConfig, + ) -> Result { + let Some(global_ctx) = self.global_ctx.upgrade() else { + return Err(PublicIpv6PlatformError::Unavailable); + }; + + let _guard = global_ctx.net_ns.guard(); + ensure_linux_ipv6_forwarding() + .map_err(|error| PublicIpv6PlatformError::Failed(error.to_string()))?; + + if let Some(prefix) = config.configured_prefix { + let ndp_target = match list_detected_ipv6_routes() { + Ok(routes) => detect_configured_prefix_ndp_proxy_target(&routes, prefix), + Err(error) => { + tracing::warn!( + %prefix, + ?error, + "failed to detect NDP proxy target for configured public IPv6 prefix" + ); + None + } + }; + return Ok(PublicIpv6PlatformObservation { + detected_prefix: None, + ndp_target, + }); + } + + detect_public_ipv6_prefix_linux() + .map(|detected| PublicIpv6PlatformObservation { + detected_prefix: detected.as_ref().map(|detected| detected.prefix), + ndp_target: detected.and_then(|detected| detected.ndp_target), + }) + .map_err(|error| PublicIpv6PlatformError::Failed(error.to_string())) + } + + fn sync_ndp( + &self, + desired: Option, + ) -> Result<(), PublicIpv6PlatformError> { + let mut runtime = self.ndp_proxy.lock().unwrap(); + if let Some(global_ctx) = self.global_ctx.upgrade() { + let cleanup_pending = runtime.reconcile(&global_ctx, desired.as_ref()); + if desired.is_none() && cleanup_pending { + return Err(PublicIpv6PlatformError::Failed(format!( + "failed to clean all public IPv6 NDP proxy entries (remaining: {})", + runtime.applied.len() + ))); + } + return Ok(()); + } + if desired.is_none() { + return cleanup_ndp_proxy_runtime(&mut runtime, &self.net_ns) + .then_some(()) + .ok_or_else(|| { + PublicIpv6PlatformError::Failed(format!( + "failed to clean all public IPv6 NDP proxy entries (remaining: {})", + runtime.applied.len() + )) + }); + } + Err(PublicIpv6PlatformError::Unavailable) + } + + async fn wait_for_change(&self) -> bool { + let mut event_receiver = self.event_receiver.lock().await; + wait_for_public_ipv6_provider_reconcile_event(&mut event_receiver).await + } +} + +pub(crate) fn runtime_public_ipv6_provider_platform( + global_ctx: &ArcGlobalCtx, +) -> Arc { + RuntimePublicIpv6ProviderPlatform::new(global_ctx) +} + +#[cfg(test)] +mod tests { + use std::fs; + use std::path::PathBuf; + use std::process::Command; + use std::sync::Arc; + + use crate::common::ifcfg::RouteType; + + use super::{ + DefaultRouteIpv6InterfaceCandidate, DetectedIpv6Route, + detect_public_ipv6_prefix_from_interfaces, detect_public_ipv6_prefix_from_routes, + detect_public_ipv6_prefix_linux, ensure_linux_ipv6_forwarding_at_paths, + ensure_public_ipv6_provider_supported, select_default_route_ipv6_interfaces, + select_public_ipv6_prefix_from_default_route_interfaces, sync_ndp_proxy_entries, + }; + + use super::PublicIpv6ProviderConfig; + use crate::common::{ + config::{ConfigLoader, TomlConfigLoader}, + error::Error, + global_ctx::GlobalCtx, + }; + use crate::instance::config::test_core_instance_config; + + fn run_ip(args: &[&str]) { + let output = Command::new("ip") + .args(args) + .output() + .expect("failed to execute ip process"); + assert!( + output.status.success(), + "ip command failed: {:?}\nstdout: {}\nstderr: {}", + args, + String::from_utf8_lossy(&output.stdout), + String::from_utf8_lossy(&output.stderr), + ); + } + + fn test_iface_name(tag: &str) -> String { + format!("et{}{:x}", tag, std::process::id() & 0xffff) + } + + struct ScopedDummyLink { + name: String, + } + + impl ScopedDummyLink { + fn new(name: &str) -> Self { + let _ = Command::new("ip").args(["link", "del", name]).output(); + run_ip(&["link", "add", name, "type", "dummy"]); + run_ip(&["link", "set", name, "up"]); + Self { + name: name.to_string(), + } + } + } + + impl Drop for ScopedDummyLink { + fn drop(&mut self) { + let _ = Command::new("ip") + .args(["link", "del", &self.name]) + .output(); + } + } + + fn temp_forwarding_paths( + all_value: &str, + default_value: &str, + ) -> (tempfile::TempDir, PathBuf, PathBuf) { + let dir = tempfile::tempdir().unwrap(); + let all_path = dir.path().join("all_forwarding"); + let default_path = dir.path().join("default_forwarding"); + fs::write(&all_path, all_value).unwrap(); + fs::write(&default_path, default_value).unwrap(); + (dir, all_path, default_path) + } + + fn route( + dst: Option<&str>, + src: Option<&str>, + ifindex: Option, + kind: RouteType, + ) -> DetectedIpv6Route { + DetectedIpv6Route { + dst: dst.map(|cidr| cidr.parse().unwrap()), + src: src.map(|cidr| cidr.parse().unwrap()), + ifindex, + kind, + } + } + + fn detected_prefix( + detected: Option, + ) -> Option { + detected.map(|detected| detected.prefix) + } + + fn iface_candidate( + interface_name: &str, + ifindex: u32, + address: &str, + prefix_len: u8, + ) -> DefaultRouteIpv6InterfaceCandidate { + DefaultRouteIpv6InterfaceCandidate { + interface_name: interface_name.to_string(), + ifindex, + address: address.parse().unwrap(), + prefix_len, + } + } + + #[test] + fn test_detect_public_ipv6_prefix_from_routes_selects_delegated_prefix() { + let routes = vec![ + route(None, Some("2001:db8:1::/56"), Some(2), RouteType::Unicast), + route(Some("2001:db8:1::/56"), None, Some(3), RouteType::Unicast), + ]; + + assert_eq!( + detected_prefix(detect_public_ipv6_prefix_from_routes(&routes, 1)), + Some("2001:db8:1::/56".parse().unwrap()) + ); + } + + #[test] + fn test_detect_public_ipv6_prefix_from_routes_rejects_non_public_prefixes() { + let routes = vec![ + route(Some("::/0"), Some("fd00::/48"), Some(2), RouteType::Unicast), + route(Some("fd00::/48"), None, Some(3), RouteType::Unicast), + route(None, Some("fe80::/64"), Some(4), RouteType::Unicast), + route(Some("fe80::/64"), None, Some(5), RouteType::Unicast), + route(None, Some("ff00::/8"), Some(6), RouteType::Unicast), + route(Some("ff00::/8"), None, Some(7), RouteType::Unicast), + route(None, Some("::/0"), Some(8), RouteType::Unicast), + route(Some("::/0"), None, Some(9), RouteType::Unicast), + ]; + + assert_eq!( + detected_prefix(detect_public_ipv6_prefix_from_routes(&routes, 1)), + None + ); + } + + #[test] + fn test_detect_public_ipv6_prefix_from_routes_requires_delegated_route() { + let routes = vec![route( + None, + Some("2001:db8:1::/56"), + Some(2), + RouteType::Unicast, + )]; + + assert_eq!( + detected_prefix(detect_public_ipv6_prefix_from_routes(&routes, 1)), + None + ); + } + + #[test] + fn test_detect_public_ipv6_prefix_from_routes_rejects_non_unicast_default_route() { + let routes = vec![ + route(None, Some("2001:db8:1::/56"), Some(2), RouteType::Blackhole), + route(Some("2001:db8:1::/56"), None, Some(3), RouteType::Unicast), + ]; + + assert_eq!( + detected_prefix(detect_public_ipv6_prefix_from_routes(&routes, 1)), + None + ); + } + + #[test] + fn test_detect_public_ipv6_prefix_from_routes_rejects_loopback_delegation() { + let routes = vec![ + route(None, Some("2001:db8:1::/56"), Some(2), RouteType::Unicast), + route(Some("2001:db8:1::/56"), None, Some(1), RouteType::Unicast), + ]; + + assert_eq!( + detected_prefix(detect_public_ipv6_prefix_from_routes(&routes, 1)), + None + ); + } + + #[test] + fn test_detect_public_ipv6_prefix_from_routes_prefers_shortest_prefix() { + let routes = vec![ + route(None, Some("2001:db8:1::/56"), Some(2), RouteType::Unicast), + route(Some("2001:db8:1::/56"), None, Some(3), RouteType::Unicast), + route(None, Some("2001:db8::/48"), Some(4), RouteType::Unicast), + route(Some("2001:db8::/48"), None, Some(5), RouteType::Unicast), + ]; + + assert_eq!( + detected_prefix(detect_public_ipv6_prefix_from_routes(&routes, 1)), + Some("2001:db8::/48".parse().unwrap()) + ); + } + + #[test] + fn test_detect_public_ipv6_prefix_from_routes_rejects_non_unicast_delegation() { + let routes = vec![ + route(None, Some("2001:db8:1::/56"), Some(2), RouteType::Unicast), + route(Some("2001:db8:1::/56"), None, Some(3), RouteType::Blackhole), + ]; + + assert_eq!( + detected_prefix(detect_public_ipv6_prefix_from_routes(&routes, 1)), + None + ); + } + + fn test_global_ctx() -> Arc { + Arc::new(GlobalCtx::new(TomlConfigLoader::default())) + } + + #[tokio::test] + async fn test_runtime_public_ipv6_provider_config_reads_provider_fields() { + let global_ctx = test_global_ctx(); + let prefix = "2001:db8::/48".parse().unwrap(); + global_ctx.config.set_ipv6_public_addr_provider(true); + global_ctx.config.set_ipv6_public_addr_prefix(Some(prefix)); + + assert_eq!( + test_core_instance_config(&global_ctx) + .connectivity + .runtime + .public_ipv6_provider, + PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: Some(prefix), + provider_supported: cfg!(target_os = "linux"), + } + ); + } + + #[test] + fn test_public_ipv6_provider_platform_check_accepts_linux() { + assert!(ensure_public_ipv6_provider_supported().is_ok()); + } + + #[test] + fn test_ensure_linux_ipv6_forwarding_enables_all_and_default() { + let (_dir, all_path, default_path) = temp_forwarding_paths("0\n", "0\n"); + + let changed = ensure_linux_ipv6_forwarding_at_paths(&all_path, &default_path).unwrap(); + + assert!(changed); + assert_eq!(fs::read_to_string(&all_path).unwrap(), "1\n"); + assert_eq!(fs::read_to_string(&default_path).unwrap(), "1\n"); + } + + #[test] + fn test_ensure_linux_ipv6_forwarding_is_noop_when_already_enabled() { + let (_dir, all_path, default_path) = temp_forwarding_paths("1\n", "1\n"); + + let changed = ensure_linux_ipv6_forwarding_at_paths(&all_path, &default_path).unwrap(); + + assert!(!changed); + assert_eq!(fs::read_to_string(&all_path).unwrap(), "1\n"); + assert_eq!(fs::read_to_string(&default_path).unwrap(), "1\n"); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_detect_public_ipv6_prefix_linux_reads_netlink_routes_from_kernel() { + let wan_if = test_iface_name("dw"); + let lan_if = test_iface_name("dl"); + let _wan = ScopedDummyLink::new(&wan_if); + let _lan = ScopedDummyLink::new(&lan_if); + + run_ip(&[ + "-6", + "addr", + "add", + "2001:db8:100:ffff::1/64", + "dev", + &wan_if, + ]); + run_ip(&[ + "-6", + "route", + "add", + "default", + "from", + "2001:db8:100::/56", + "dev", + &wan_if, + ]); + run_ip(&["-6", "route", "add", "2001:db8:100::/56", "dev", &lan_if]); + + assert_eq!( + detected_prefix(detect_public_ipv6_prefix_linux().unwrap()), + Some("2001:db8:100::/56".parse().unwrap()) + ); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_detect_public_ipv6_prefix_linux_dhcpv6_ia_na_fallback() { + // DHCPv6 IA_NA scenario: prefix is directly on the WAN interface, + // with no delegated route on a LAN interface. + // The route-based detection should fail, and the interface-scanning + // fallback should pick up the prefix from the WAN address. + let wan_if = test_iface_name("ia"); + let _wan = ScopedDummyLink::new(&wan_if); + + run_ip(&[ + "-6", + "addr", + "add", + "2001:db8:aaaa:ffff::1/64", + "dev", + &wan_if, + ]); + run_ip(&[ + "-6", + "route", + "add", + "default", + "from", + "2001:db8:aaaa::/64", + "dev", + &wan_if, + ]); + // Also add a /48 address+route pair to verify shortest-prefix preference + run_ip(&["-6", "addr", "add", "2001:db8:bbbb::1/48", "dev", &wan_if]); + run_ip(&[ + "-6", + "route", + "add", + "default", + "from", + "2001:db8::/48", + "dev", + &wan_if, + ]); + + // NO delegated route on a LAN interface — this is the IA_NA case + // The fallback should find both prefixes via interface scanning and + // prefer the shorter /48. + let detected = detect_public_ipv6_prefix_linux().unwrap().unwrap(); + assert_eq!(detected.prefix, "2001:db8:bbbb::/48".parse().unwrap()); + assert_eq!(detected.ndp_target.unwrap().wan_interface, wan_if); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_detect_public_ipv6_prefix_from_interfaces_uses_default_route_iface() { + let wan_if = test_iface_name("dw"); + let other_if = test_iface_name("do"); + let _wan = ScopedDummyLink::new(&wan_if); + let _other = ScopedDummyLink::new(&other_if); + + run_ip(&["-6", "addr", "add", "2001:db8:dddd::1/64", "dev", &wan_if]); + run_ip(&["-6", "addr", "add", "2001:db8::1/48", "dev", &other_if]); + + let wan_ifindex = crate::common::ifcfg::get_interface_index(&wan_if).unwrap(); + let other_ifindex = crate::common::ifcfg::get_interface_index(&other_if).unwrap(); + let routes = vec![ + route(None, None, Some(wan_ifindex), RouteType::Unicast), + route( + Some("2001:db8::/48"), + None, + Some(other_ifindex), + RouteType::Unicast, + ), + ]; + + let detected = detect_public_ipv6_prefix_from_interfaces(&routes) + .expect("fallback should select the default-route interface"); + assert_eq!(detected.prefix, "2001:db8:dddd::/64".parse().unwrap()); + assert_eq!(detected.ndp_target.unwrap().wan_interface, wan_if); + } + + #[test] + fn test_select_default_route_ipv6_interfaces_filters_candidates() { + let wan_ifindices = [2u32].into_iter().collect(); + let candidates = vec![ + iface_candidate("wan0", 2, "2001:db8:100::1", 64), + iface_candidate("nonwan0", 9, "2001:db8:200::1", 64), + iface_candidate("loopback0", 2, "::1", 128), + iface_candidate("linklocal0", 2, "fe80::1", 64), + iface_candidate("ula0", 2, "fd00::1", 64), + iface_candidate("multicast0", 2, "ff02::1", 64), + iface_candidate("unspecified0", 2, "::", 64), + iface_candidate("empty0", 2, "2001:db8:300::1", 0), + iface_candidate("host0", 2, "2001:db8:400::1", 128), + ]; + + let selected = select_default_route_ipv6_interfaces(candidates, &wan_ifindices, 64); + + assert_eq!(selected.len(), 1); + assert_eq!(selected[0].interface_name, "wan0"); + assert_eq!(selected[0].prefix, "2001:db8:100::/64".parse().unwrap()); + } + + #[test] + fn test_select_default_route_ipv6_interfaces_strips_host_bits() { + let wan_ifindices = [2u32].into_iter().collect(); + let candidates = vec![iface_candidate("wan0", 2, "2001:db8:aaaa::abcd", 64)]; + + let selected = select_default_route_ipv6_interfaces(candidates, &wan_ifindices, 64); + + assert_eq!(selected.len(), 1); + assert_eq!(selected[0].prefix, "2001:db8:aaaa::/64".parse().unwrap()); + } + + #[test] + fn test_select_public_ipv6_prefix_tie_breaks_by_lowest_ifindex() { + let wan_ifindices = [2u32, 3, 5].into_iter().collect(); + let candidates = vec![ + iface_candidate("wan5", 5, "2001:db8:5555::1", 48), + iface_candidate("wan64", 3, "2001:db8:3333::1", 64), + iface_candidate("wan2", 2, "2001:db9:2222::1", 48), + ]; + let interfaces = select_default_route_ipv6_interfaces(candidates, &wan_ifindices, 64); + + let detected = select_public_ipv6_prefix_from_default_route_interfaces(interfaces) + .expect("default-route public IPv6 prefix should be selected"); + + assert_eq!(detected.prefix, "2001:db9:2222::/48".parse().unwrap()); + assert_eq!(detected.ndp_target.unwrap().wan_interface, "wan2"); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_configured_prefix_on_default_iface_gets_ndp_proxy_target() { + let wan_if = test_iface_name("cp"); + let _wan = ScopedDummyLink::new(&wan_if); + let configured_prefix = "2001:db8:feed::/64".parse().unwrap(); + + run_ip(&["-6", "addr", "add", "2001:db8:feed::1/128", "dev", &wan_if]); + + let ifindex = crate::common::ifcfg::get_interface_index(&wan_if).unwrap(); + let routes = vec![route(None, None, Some(ifindex), RouteType::Unicast)]; + + let target = super::detect_configured_prefix_ndp_proxy_target(&routes, configured_prefix) + .expect("configured on-link prefix should require NDP proxy"); + assert_eq!(target.wan_interface, wan_if); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_configured_prefix_broader_than_default_iface_does_not_get_ndp_proxy_target() { + let wan_if = test_iface_name("cb"); + let _wan = ScopedDummyLink::new(&wan_if); + let configured_prefix = "2001:db8:beef::/48".parse().unwrap(); + + run_ip(&["-6", "addr", "add", "2001:db8:beef:1::1/64", "dev", &wan_if]); + + let ifindex = crate::common::ifcfg::get_interface_index(&wan_if).unwrap(); + let routes = vec![route(None, None, Some(ifindex), RouteType::Unicast)]; + + assert_eq!( + super::detect_configured_prefix_ndp_proxy_target(&routes, configured_prefix), + None + ); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_detect_public_ipv6_prefix_linux_dhcpv6_ia_na_single_prefix() { + // DHCPv6 IA_NA: the WAN interface has a global prefix with a + // default route. Use a /48 dummy prefix so the fallback prefers it + // over any real /64 on the test machine. + let wan_if = test_iface_name("ib"); + let _wan = ScopedDummyLink::new(&wan_if); + + run_ip(&["-6", "addr", "add", "2001:db8:cccc::1/48", "dev", &wan_if]); + run_ip(&["-6", "route", "add", "default", "dev", &wan_if]); + + let detected = detect_public_ipv6_prefix_linux().unwrap().unwrap(); + assert_eq!(detected.prefix, "2001:db8:cccc::/48".parse().unwrap()); + assert_eq!(detected.ndp_target.unwrap().wan_interface, wan_if); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_detect_public_ipv6_prefix_from_interfaces_skips_non_global() { + // Create a dummy interface with only a link-local address. + // The interface fallback should return None because there is no + // global unicast address. + let iface = test_iface_name("ng"); + let _link = ScopedDummyLink::new(&iface); + + // Bring up the interface so it auto-configures a link-local address + run_ip(&["link", "set", &iface, "up"]); + let ifindex = crate::common::ifcfg::get_interface_index(&iface).unwrap(); + let routes = vec![route(None, None, Some(ifindex), RouteType::Unicast)]; + + // No global address added — only link-local should be present + let result = detect_public_ipv6_prefix_from_interfaces(&routes); + assert_eq!(detected_prefix(result), None); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_ndp_proxy_sync_uses_configured_tun_iface_without_shell_neigh() { + let wan_if = test_iface_name("nw"); + let tun_if = test_iface_name("nt"); + let _wan = ScopedDummyLink::new(&wan_if); + let _tun = ScopedDummyLink::new(&tun_if); + let addr = "2001:db8:abcd::123".parse::().unwrap(); + let prefix = "2001:db8:abcd::/64".parse().unwrap(); + let mut applied = std::collections::BTreeSet::new(); + + run_ip(&["-6", "route", "add", &format!("{addr}/128"), "dev", &tun_if]); + + sync_ndp_proxy_entries(&wan_if, &tun_if, prefix, &mut applied).unwrap(); + assert!( + crate::common::ifcfg::list_ipv6_ndp_proxy(&wan_if) + .unwrap() + .contains(&addr) + ); + assert!(applied.contains(&addr)); + + run_ip(&["-6", "route", "del", &format!("{addr}/128"), "dev", &tun_if]); + sync_ndp_proxy_entries(&wan_if, &tun_if, prefix, &mut applied).unwrap(); + assert!( + !crate::common::ifcfg::list_ipv6_ndp_proxy(&wan_if) + .unwrap() + .contains(&addr) + ); + assert!(!applied.contains(&addr)); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_ndp_proxy_sync_does_not_delete_preexisting_proxy_entry() { + let wan_if = test_iface_name("pw"); + let tun_if = test_iface_name("pt"); + let _wan = ScopedDummyLink::new(&wan_if); + let _tun = ScopedDummyLink::new(&tun_if); + let addr = "2001:db8:beef::123".parse::().unwrap(); + let prefix = "2001:db8:beef::/64".parse().unwrap(); + let mut applied = std::collections::BTreeSet::new(); + + super::ensure_linux_ndp_proxy_enabled(&wan_if).unwrap(); + crate::common::ifcfg::add_ipv6_ndp_proxy(&wan_if, addr).unwrap(); + run_ip(&["-6", "route", "add", &format!("{addr}/128"), "dev", &tun_if]); + + sync_ndp_proxy_entries(&wan_if, &tun_if, prefix, &mut applied).unwrap(); + assert!( + crate::common::ifcfg::list_ipv6_ndp_proxy(&wan_if) + .unwrap() + .contains(&addr) + ); + assert!(!applied.contains(&addr)); + + run_ip(&["-6", "route", "del", &format!("{addr}/128"), "dev", &tun_if]); + sync_ndp_proxy_entries(&wan_if, &tun_if, prefix, &mut applied).unwrap(); + assert!( + crate::common::ifcfg::list_ipv6_ndp_proxy(&wan_if) + .unwrap() + .contains(&addr) + ); + assert!(!applied.contains(&addr)); + + crate::common::ifcfg::remove_ipv6_ndp_proxy(&wan_if, addr).unwrap(); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_ndp_proxy_sync_removes_owned_entry_when_tun_iface_is_gone() { + let wan_if = test_iface_name("gw"); + let _wan = ScopedDummyLink::new(&wan_if); + let addr = "2001:db8:face::123".parse::().unwrap(); + let prefix = "2001:db8:face::/64".parse().unwrap(); + let mut applied = std::collections::BTreeSet::from([addr]); + + super::ensure_linux_ndp_proxy_enabled(&wan_if).unwrap(); + crate::common::ifcfg::add_ipv6_ndp_proxy(&wan_if, addr).unwrap(); + + sync_ndp_proxy_entries(&wan_if, "missing-easytier-tun", prefix, &mut applied).unwrap(); + assert!( + !crate::common::ifcfg::list_ipv6_ndp_proxy(&wan_if) + .unwrap() + .contains(&addr) + ); + assert!(applied.is_empty()); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_cleanup_ndp_proxy_runtime_removes_owned_entry_on_task_exit() { + let wan_if = test_iface_name("cw"); + let _wan = ScopedDummyLink::new(&wan_if); + let addr = "2001:db8:cafe::123".parse::().unwrap(); + let mut runtime = super::NdpProxyRuntime { + wan_iface: Some(wan_if.clone()), + applied: std::collections::BTreeSet::from([addr]), + }; + + super::ensure_linux_ndp_proxy_enabled(&wan_if).unwrap(); + crate::common::ifcfg::add_ipv6_ndp_proxy(&wan_if, addr).unwrap(); + + assert!(super::cleanup_ndp_proxy_runtime( + &mut runtime, + &crate::common::netns::NetNS::new(None) + )); + assert!( + !crate::common::ifcfg::list_ipv6_ndp_proxy(&wan_if) + .unwrap() + .contains(&addr) + ); + assert!(!runtime.cleanup_pending()); + } + + async fn wait_for_ndp_proxy_entry(wan_if: &str, addr: std::net::Ipv6Addr, present: bool) { + for _ in 0..50 { + let current = crate::common::ifcfg::list_ipv6_ndp_proxy(wan_if).unwrap(); + if current.contains(&addr) == present { + return; + } + tokio::time::sleep(std::time::Duration::from_millis(20)).await; + } + + let current = crate::common::ifcfg::list_ipv6_ndp_proxy(wan_if).unwrap(); + assert_eq!(current.contains(&addr), present); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_reconcile_task_shutdown_removes_owned_ndp_proxy_entry() { + let wan_if = test_iface_name("tw"); + let tun_if = test_iface_name("tt"); + let _wan = ScopedDummyLink::new(&wan_if); + let _tun = ScopedDummyLink::new(&tun_if); + let prefix = "2001:db8:fade::/64".parse().unwrap(); + let wan_addr = "2001:db8:fade::1"; + let leased_addr = "2001:db8:fade::123".parse::().unwrap(); + let global_ctx = test_global_ctx(); + + run_ip(&[ + "-6", + "addr", + "add", + &format!("{wan_addr}/128"), + "dev", + &wan_if, + ]); + run_ip(&["-6", "route", "add", "default", "dev", &wan_if]); + run_ip(&[ + "-6", + "route", + "add", + &format!("{leased_addr}/128"), + "dev", + &tun_if, + ]); + + global_ctx.config.set_ipv6_public_addr_provider(true); + global_ctx.config.set_ipv6_public_addr_prefix(Some(prefix)); + global_ctx.set_tun_device_ready(tun_if); + + let platform = super::RuntimePublicIpv6ProviderPlatform::new(&global_ctx); + let runtime_config = easytier_core::config::runtime::CoreRuntimeConfigStore::new( + easytier_core::config::runtime::CoreRuntimeConfig { + public_ipv6_provider: test_core_instance_config(&global_ctx) + .connectivity + .runtime + .public_ipv6_provider, + ..Default::default() + }, + Arc::new(easytier_core::config::peers::PeerRuntimeSnapshot::default()), + ); + let runtime = easytier_core::peers::public_ipv6::CorePublicIpv6Runtime::new( + runtime_config.clone(), + global_ctx.clone(), + global_ctx.clone(), + ); + let service = easytier_core::peers::public_ipv6::provider::PublicIpv6ProviderService::new( + platform, + runtime_config, + runtime, + ); + service.start().await; + wait_for_ndp_proxy_entry(&wan_if, leased_addr, true).await; + + service.stop().await; + wait_for_ndp_proxy_entry(&wan_if, leased_addr, false).await; + } + + #[test] + fn test_missing_netlink_object_errors_release_ndp_ownership() { + for errno in [ + nix::libc::ENOENT, + nix::libc::ESRCH, + nix::libc::ENODEV, + nix::libc::ENXIO, + ] { + let err = Error::IOError(std::io::Error::from_raw_os_error(errno)); + assert!(super::is_linux_missing_netlink_object_error(&err)); + } + } + + #[test] + fn test_clear_owned_ndp_proxy_entries_forgets_already_absent_entry() { + let addr = "2001:db8:dead::111".parse::().unwrap(); + let mut applied = std::collections::BTreeSet::from([addr]); + let current = std::collections::BTreeSet::new(); + + assert!( + super::clear_owned_ndp_proxy_entries("missing", ¤t, &mut applied, vec![addr],) + .is_none() + ); + assert!(!applied.contains(&addr)); + } + + #[test] + fn test_ndp_proxy_runtime_forgets_entries_when_wan_interface_is_gone() { + let addr = "2001:db8:dead::123".parse::().unwrap(); + let mut runtime = super::NdpProxyRuntime { + wan_iface: Some(test_iface_name("missing")), + applied: std::collections::BTreeSet::from([addr]), + }; + + assert!(runtime.clear_current_locked()); + assert!(runtime.wan_iface.is_none()); + assert!(runtime.applied.is_empty()); + } + + #[tokio::test] + async fn test_ndp_proxy_runtime_finishes_cleanup_when_wan_interface_is_gone_after_disable() { + let addr = "2001:db8:dead::456".parse::().unwrap(); + let global_ctx = test_global_ctx(); + let mut runtime = super::NdpProxyRuntime { + wan_iface: Some(test_iface_name("missing")), + applied: std::collections::BTreeSet::from([addr]), + }; + + assert!(!runtime.reconcile(&global_ctx, None)); + assert!(!runtime.cleanup_pending()); + } + + #[serial_test::serial] + #[tokio::test] + async fn test_detect_public_ipv6_prefix_linux_prefers_shortest_prefix_from_kernel() { + let wan_if_1 = test_iface_name("sw1"); + let lan_if_1 = test_iface_name("sl1"); + let wan_if_2 = test_iface_name("sw2"); + let lan_if_2 = test_iface_name("sl2"); + let _wan_1 = ScopedDummyLink::new(&wan_if_1); + let _lan_1 = ScopedDummyLink::new(&lan_if_1); + let _wan_2 = ScopedDummyLink::new(&wan_if_2); + let _lan_2 = ScopedDummyLink::new(&lan_if_2); + + run_ip(&[ + "-6", + "addr", + "add", + "2001:db8:3000:ffff::1/64", + "dev", + &wan_if_1, + ]); + run_ip(&[ + "-6", + "route", + "add", + "default", + "from", + "2001:db8:3000::/56", + "dev", + &wan_if_1, + ]); + run_ip(&["-6", "route", "add", "2001:db8:3000::/56", "dev", &lan_if_1]); + + run_ip(&["-6", "addr", "add", "2001:db9:ffff::1/64", "dev", &wan_if_2]); + run_ip(&[ + "-6", + "route", + "add", + "default", + "from", + "2001:db9::/48", + "dev", + &wan_if_2, + ]); + run_ip(&["-6", "route", "add", "2001:db9::/48", "dev", &lan_if_2]); + + assert_eq!( + detected_prefix(detect_public_ipv6_prefix_linux().unwrap()), + Some("2001:db9::/48".parse().unwrap()) + ); + } +} diff --git a/vendor/easytier/easytier/src/instance/public_ipv6_provider/unsupported.rs b/vendor/easytier/easytier/src/instance/public_ipv6_provider/unsupported.rs new file mode 100644 index 0000000..c0513cb --- /dev/null +++ b/vendor/easytier/easytier/src/instance/public_ipv6_provider/unsupported.rs @@ -0,0 +1,79 @@ +use std::sync::Arc; + +use easytier_core::{ + config::peers::PublicIpv6ProviderConfig, + peers::public_ipv6::provider::{ + PublicIpv6NdpDesired, PublicIpv6PlatformError, PublicIpv6PlatformObservation, + PublicIpv6ProviderPlatform, + }, +}; + +use super::wait_for_public_ipv6_provider_reconcile_event; +use crate::common::global_ctx::{ArcGlobalCtx, GlobalCtxEvent}; + +pub(super) struct RuntimePublicIpv6ProviderPlatform { + global_ctx: std::sync::Weak, + event_receiver: tokio::sync::Mutex>, +} + +impl RuntimePublicIpv6ProviderPlatform { + pub(super) fn new(global_ctx: &ArcGlobalCtx) -> Arc { + Arc::new(Self { + global_ctx: Arc::downgrade(global_ctx), + event_receiver: tokio::sync::Mutex::new(global_ctx.subscribe()), + }) + } +} + +#[async_trait::async_trait] +impl PublicIpv6ProviderPlatform for RuntimePublicIpv6ProviderPlatform { + fn inspect( + &self, + config: PublicIpv6ProviderConfig, + ) -> Result { + let Some(global_ctx) = self.global_ctx.upgrade() else { + return Err(PublicIpv6PlatformError::Unavailable); + }; + let _ = (global_ctx, config); + Ok(PublicIpv6PlatformObservation::default()) + } + + fn sync_ndp( + &self, + desired: Option, + ) -> Result<(), PublicIpv6PlatformError> { + let _ = desired; + Ok(()) + } + + async fn wait_for_change(&self) -> bool { + let mut event_receiver = self.event_receiver.lock().await; + wait_for_public_ipv6_provider_reconcile_event(&mut event_receiver).await + } +} + +pub(crate) fn runtime_public_ipv6_provider_platform( + global_ctx: &ArcGlobalCtx, +) -> Arc { + RuntimePublicIpv6ProviderPlatform::new(global_ctx) +} + +#[cfg(test)] +mod tests { + use easytier_core::config::peers::PublicIpv6ProviderConfig; + + #[test] + fn public_ipv6_provider_platform_check_reports_linux_only() { + let err = PublicIpv6ProviderConfig { + provider_enabled: true, + configured_prefix: None, + provider_supported: false, + } + .validate() + .unwrap_err(); + let msg = err.to_string(); + + assert!(msg.contains("Linux"), "{msg}"); + assert!(msg.contains("ipv6-public-addr-auto"), "{msg}"); + } +} diff --git a/vendor/easytier/easytier/src/instance/runtime_host.rs b/vendor/easytier/easytier/src/instance/runtime_host.rs new file mode 100644 index 0000000..93c0d7f --- /dev/null +++ b/vendor/easytier/easytier/src/instance/runtime_host.rs @@ -0,0 +1,227 @@ +use std::sync::Arc; + +use easytier_core::{ + config::runtime::CoreInstanceRuntimeConfig, gateway::dhcp::DhcpIpv4Host, + host::packet::HostPacketReceiver, instance::CorePacketPlane, +}; +use tokio::sync::Mutex; +use tokio_util::sync::CancellationToken; + +use crate::common::global_ctx::ArcGlobalCtx; + +mod event_journal; +mod implementation; +#[cfg(feature = "tun")] +mod magic_dns; +#[cfg(feature = "tun")] +mod tun_common; +#[cfg(not(feature = "tun"))] +#[path = "runtime_host/tun_disabled.rs"] +mod tun_runtime; +#[cfg(all(feature = "tun", not(mobile)))] +#[path = "runtime_host/tun_desktop.rs"] +mod tun_runtime; +#[cfg(all(feature = "tun", mobile))] +#[path = "runtime_host/tun_mobile.rs"] +mod tun_runtime; + +use event_journal::EventJournal; +#[cfg(feature = "tun")] +use magic_dns::MagicDnsRuntime; +use tun_runtime::NativeTunRuntime; + +pub(crate) struct NativeInstanceRuntimeHost { + global_ctx: ArcGlobalCtx, + operation: Arc>, + cancel: CancellationToken, + event_journal: EventJournal, + tun: NativeTunRuntime, +} + +impl NativeInstanceRuntimeHost { + pub(crate) fn new(global_ctx: ArcGlobalCtx) -> Arc { + let cancel = CancellationToken::new(); + let tun = NativeTunRuntime::new(global_ctx.clone(), cancel.clone()); + let event_journal = EventJournal::new(&global_ctx); + Arc::new(Self { + global_ctx, + event_journal, + operation: Arc::new(Mutex::new(())), + cancel, + tun, + }) + } + + async fn prepare_runtime( + &self, + packet_plane: Arc, + ) -> anyhow::Result>> { + self.event_journal.start(self.cancel.clone()).await; + self.tun.prepare(packet_plane.clone()).await?; + Ok(Some( + self.tun.dhcp_host(self.operation.clone(), packet_plane), + )) + } + + async fn shutdown_runtime(&self) { + self.cancel.cancel(); + let _operation = self.operation.lock().await; + self.event_journal.stop().await; + self.tun.shutdown().await; + } + + fn request_runtime_shutdown(&self) { + self.cancel.cancel(); + } + + fn management_events_snapshot(&self) -> Vec { + self.event_journal.events() + } + + #[cfg(feature = "web-client")] + fn synchronize_global_ctx_config( + &self, + patch: &crate::proto::api::config::InstanceConfigPatch, + config: &CoreInstanceRuntimeConfig, + ) { + if patch.hostname.is_some() { + self.global_ctx.set_hostname( + config + .peer + .runtime + .core + .node + .hostname + .clone() + .unwrap_or_default(), + ); + } + if patch.ipv4.is_some() && !config.services.dhcp_ipv4 { + self.global_ctx + .set_ipv4(crate::common::global_ctx::GlobalCtx::runtime_ipv4( + &config.peer, + )); + } + if patch.ipv6.is_some() { + self.global_ctx + .set_ipv6(crate::common::global_ctx::GlobalCtx::runtime_ipv6( + &config.peer, + )); + } + if patch.disable_relay_data.is_some() || patch.prefer_peer_relay.is_some() { + self.global_ctx.set_flags(config.peer.flags.clone()); + } + } + + pub(crate) fn subscribe_event(&self) -> crate::common::global_ctx::EventBusSubscriber { + self.global_ctx.subscribe() + } + + fn attach_runtime_tun_fd(&self, fd: i32) -> anyhow::Result<()> { + self.tun.attach_fd(fd) + } + + fn install_packet_receiver(&self, receiver: HostPacketReceiver) -> anyhow::Result<()> { + self.tun.install_packet_receiver(receiver) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::common::{ + config::TomlConfig, + global_ctx::{GlobalCtx, GlobalCtxEvent}, + }; + + #[cfg(feature = "web-client")] + fn runtime_config(config: &TomlConfig) -> CoreInstanceRuntimeConfig { + let normalized = easytier_core::instance::CoreInstanceConfig::from_toml(config).unwrap(); + CoreInstanceRuntimeConfig { + services: normalized.connectivity.runtime, + peer: Arc::new(normalized.peer.snapshot), + } + } + + #[test] + fn runtime_host_owns_event_subscription_context() { + let global_ctx = Arc::new(GlobalCtx::new(TomlConfig::default())); + let runtime_host = NativeInstanceRuntimeHost::new(global_ctx.clone()); + let mut events = runtime_host.subscribe_event(); + + global_ctx.issue_event(GlobalCtxEvent::CredentialChanged); + + assert_eq!( + events.try_recv().unwrap(), + GlobalCtxEvent::CredentialChanged + ); + } + + #[cfg(feature = "web-client")] + #[test] + fn runtime_host_synchronizes_normalized_config_without_management() { + use easytier_core::{config::toml::ConfigLoader as _, instance::InstanceRuntimeHost as _}; + + let config = TomlConfig::default(); + config.set_hostname(Some("before".to_owned())); + config.set_ipv4(Some("10.20.0.1/24".parse().unwrap())); + config.set_ipv6(Some("fd00::1/64".parse().unwrap())); + let global_ctx = Arc::new(GlobalCtx::new(config.clone())); + let runtime_host = NativeInstanceRuntimeHost::new(global_ctx.clone()); + + assert_eq!(global_ctx.get_hostname(), "before"); + assert_eq!(global_ctx.get_ipv4(), Some("10.20.0.1/24".parse().unwrap())); + assert_eq!(global_ctx.get_ipv6(), Some("fd00::1/64".parse().unwrap())); + assert!(!global_ctx.get_flags().disable_relay_data); + assert!(!global_ctx.get_flags().prefer_peer_relay); + + config.set_hostname(Some("after".to_owned())); + config.set_ipv4(Some("10.20.0.2/24".parse().unwrap())); + config.set_ipv6(Some("fd00::2/64".parse().unwrap())); + let mut flags = config.get_flags(); + flags.disable_relay_data = true; + flags.prefer_peer_relay = true; + config.set_flags(flags); + runtime_host.synchronize_config( + &crate::proto::api::config::InstanceConfigPatch { + hostname: Some("ignored-raw-hostname".to_owned()), + ipv4: Some("10.99.0.1/24".parse::().unwrap().into()), + ipv6: Some("fd99::1/64".parse::().unwrap().into()), + disable_relay_data: Some(false), + prefer_peer_relay: Some(false), + ..Default::default() + }, + &runtime_config(&config), + ); + + assert_eq!(global_ctx.get_hostname(), "after"); + assert_eq!(global_ctx.get_ipv4(), Some("10.20.0.2/24".parse().unwrap())); + assert_eq!(global_ctx.get_ipv6(), Some("fd00::2/64".parse().unwrap())); + assert!(global_ctx.get_flags().disable_relay_data); + assert!(global_ctx.get_flags().prefer_peer_relay); + } + + #[cfg(feature = "web-client")] + #[test] + fn runtime_host_preserves_dhcp_ipv4_during_config_synchronization() { + use easytier_core::{config::toml::ConfigLoader as _, instance::InstanceRuntimeHost as _}; + + let config = TomlConfig::default(); + config.set_dhcp(true); + let global_ctx = Arc::new(GlobalCtx::new(config.clone())); + let runtime_host = NativeInstanceRuntimeHost::new(global_ctx.clone()); + let lease = "10.20.0.7/24".parse().unwrap(); + global_ctx.set_ipv4(Some(lease)); + + config.set_ipv4(None); + runtime_host.synchronize_config( + &crate::proto::api::config::InstanceConfigPatch { + ipv4: Some("10.99.0.1/24".parse::().unwrap().into()), + ..Default::default() + }, + &runtime_config(&config), + ); + + assert_eq!(global_ctx.get_ipv4(), Some(lease)); + } +} diff --git a/vendor/easytier/easytier/src/instance/runtime_host/event_journal.rs b/vendor/easytier/easytier/src/instance/runtime_host/event_journal.rs new file mode 100644 index 0000000..3d2814a --- /dev/null +++ b/vendor/easytier/easytier/src/instance/runtime_host/event_journal.rs @@ -0,0 +1,110 @@ +#[cfg(feature = "management")] +use std::{ + collections::VecDeque, + sync::{Arc, RwLock}, +}; + +#[cfg(feature = "management")] +use tokio::sync::Mutex; +use tokio_util::sync::CancellationToken; +#[cfg(feature = "management")] +use tokio_util::task::AbortOnDropHandle; + +use crate::common::global_ctx::ArcGlobalCtx; +#[cfg(feature = "management")] +use crate::common::global_ctx::{EventBusSubscriber, GlobalCtxEvent}; + +#[cfg(feature = "management")] +#[derive(serde::Serialize)] +struct ManagementEvent { + time: chrono::DateTime, + event: GlobalCtxEvent, +} + +#[cfg(feature = "management")] +pub(super) struct EventJournal { + global_ctx: ArcGlobalCtx, + events: Arc>>, + receiver: Mutex>, + task: Mutex>>, +} + +#[cfg(not(feature = "management"))] +pub(super) struct EventJournal; + +#[cfg(feature = "management")] +impl EventJournal { + pub(super) fn new(global_ctx: &ArcGlobalCtx) -> Self { + Self { + global_ctx: global_ctx.clone(), + events: Arc::new(RwLock::new(VecDeque::new())), + receiver: Mutex::new(Some(global_ctx.subscribe())), + task: Mutex::new(None), + } + } + + pub(super) async fn start(&self, cancel: CancellationToken) { + let Some(mut receiver) = self.receiver.lock().await.take() else { + return; + }; + let events = self.events.clone(); + let task = tokio::spawn(async move { + loop { + let event = tokio::select! { + _ = cancel.cancelled() => return, + event = receiver.recv() => match event { + Ok(event) => event, + Err(tokio::sync::broadcast::error::RecvError::Closed) => return, + Err(tokio::sync::broadcast::error::RecvError::Lagged(_)) => continue, + }, + }; + let event = ManagementEvent { + time: chrono::Local::now(), + event, + }; + let Ok(event) = serde_json::to_string(&event) else { + continue; + }; + let mut events = events.write().unwrap(); + events.push_front(event); + if events.len() > 20 { + events.pop_back(); + } + } + }); + self.task.lock().await.replace(AbortOnDropHandle::new(task)); + } + + pub(super) async fn stop(&self) { + if let Some(task) = self.task.lock().await.take() { + let _ = task.await; + } + } + + pub(super) fn events(&self) -> Vec { + self.events.read().unwrap().iter().cloned().collect() + } + + pub(super) fn publish_config_patch( + &self, + patch: crate::proto::api::config::InstanceConfigPatch, + ) { + self.global_ctx + .issue_event(GlobalCtxEvent::ConfigPatched(patch)); + } +} + +#[cfg(not(feature = "management"))] +impl EventJournal { + pub(super) fn new(_global_ctx: &ArcGlobalCtx) -> Self { + Self + } + + pub(super) async fn start(&self, _cancel: CancellationToken) {} + + pub(super) async fn stop(&self) {} + + pub(super) fn events(&self) -> Vec { + Vec::new() + } +} diff --git a/vendor/easytier/easytier/src/instance/runtime_host/implementation.rs b/vendor/easytier/easytier/src/instance/runtime_host/implementation.rs new file mode 100644 index 0000000..9484f3d --- /dev/null +++ b/vendor/easytier/easytier/src/instance/runtime_host/implementation.rs @@ -0,0 +1,65 @@ +use std::sync::Arc; + +use easytier_core::{ + gateway::dhcp::DhcpIpv4Host, + host::packet::HostPacketReceiver, + instance::{CorePacketPlane, InstanceRuntimeHost, PacketEgressHost}, +}; + +use super::NativeInstanceRuntimeHost; + +#[async_trait::async_trait] +impl InstanceRuntimeHost for NativeInstanceRuntimeHost { + async fn prepare( + &self, + packet_plane: Arc, + ) -> anyhow::Result>> { + self.prepare_runtime(packet_plane).await + } + + async fn shutdown(&self) { + self.shutdown_runtime().await; + } + + fn request_shutdown(&self) { + self.request_runtime_shutdown(); + } + + fn management_events(&self) -> Vec { + self.management_events_snapshot() + } + + #[cfg(feature = "web-client")] + fn synchronize_config( + &self, + patch: &crate::proto::api::config::InstanceConfigPatch, + config: &easytier_core::config::runtime::CoreInstanceRuntimeConfig, + ) { + self.synchronize_global_ctx_config(patch, config); + } + + #[cfg(feature = "web-client")] + fn publish_config_patch(&self, patch: crate::proto::api::config::InstanceConfigPatch) { + #[cfg(feature = "management")] + self.event_journal.publish_config_patch(patch); + #[cfg(not(feature = "management"))] + let _ = patch; + } + + fn attach_tun_fd(&self, fd: i32) -> anyhow::Result<()> { + self.attach_runtime_tun_fd(fd) + } +} + +#[async_trait::async_trait] +impl PacketEgressHost for NativeInstanceRuntimeHost { + async fn start(&self, receiver: HostPacketReceiver) -> anyhow::Result<()> { + self.install_packet_receiver(receiver) + } + + async fn stop(&self) {} + + fn request_stop(&self) { + self.request_runtime_shutdown(); + } +} diff --git a/vendor/easytier/easytier/src/instance/runtime_host/magic_dns.rs b/vendor/easytier/easytier/src/instance/runtime_host/magic_dns.rs new file mode 100644 index 0000000..8ee1704 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/runtime_host/magic_dns.rs @@ -0,0 +1,71 @@ +use cidr::Ipv4Inet; +use easytier_core::instance::CorePacketPlane; +#[cfg(feature = "magic-dns")] +use tokio_util::{sync::CancellationToken, task::AbortOnDropHandle}; + +use crate::common::global_ctx::ArcGlobalCtx; +#[cfg(feature = "magic-dns")] +use crate::instance::dns_server::{MAGIC_DNS_FAKE_IP, runner::DnsRunner}; + +#[derive(Default)] +pub(super) struct MagicDnsRuntime { + #[cfg(feature = "magic-dns")] + active: Option, +} + +#[cfg(feature = "magic-dns")] +struct MagicDnsTask { + task: AbortOnDropHandle<()>, + cancel: CancellationToken, +} + +impl MagicDnsRuntime { + #[cfg(feature = "magic-dns")] + pub(super) fn start( + global_ctx: ArcGlobalCtx, + packet_plane: std::sync::Arc, + tun_dev: Option, + tun_ip: Ipv4Inet, + ) -> Self { + let active = global_ctx.get_flags().accept_dns.then(|| { + let mut runner = DnsRunner::new( + packet_plane, + global_ctx, + tun_dev, + tun_ip, + MAGIC_DNS_FAKE_IP.parse().unwrap(), + ); + let cancel = CancellationToken::new(); + let task_cancel = cancel.clone(); + let task = tokio::spawn(async move { + let _ = runner.run(task_cancel).await; + }); + MagicDnsTask { + task: AbortOnDropHandle::new(task), + cancel, + } + }); + Self { active } + } + + #[cfg(not(feature = "magic-dns"))] + pub(super) fn start( + _global_ctx: ArcGlobalCtx, + _packet_plane: std::sync::Arc, + _tun_dev: Option, + _tun_ip: Ipv4Inet, + ) -> Self { + Self::default() + } + + #[cfg(feature = "magic-dns")] + pub(super) async fn stop(&mut self) { + if let Some(active) = self.active.take() { + active.cancel.cancel(); + let _ = active.task.await; + } + } + + #[cfg(not(feature = "magic-dns"))] + pub(super) async fn stop(&mut self) {} +} diff --git a/vendor/easytier/easytier/src/instance/runtime_host/tun_common.rs b/vendor/easytier/easytier/src/instance/runtime_host/tun_common.rs new file mode 100644 index 0000000..a86aead --- /dev/null +++ b/vendor/easytier/easytier/src/instance/runtime_host/tun_common.rs @@ -0,0 +1,91 @@ +use std::{ + any::Any, + sync::{Arc, OnceLock}, +}; + +use easytier_core::host::packet::HostPacketReceiver; +use tokio::{sync::Mutex, task::JoinSet}; + +use super::MagicDnsRuntime; +use crate::instance::virtual_nic::NicCtx; + +struct NicCtxContainer { + _nic_ctx: Option>, + magic_dns: MagicDnsRuntime, +} + +impl NicCtxContainer { + fn new(nic_ctx: NicCtx, magic_dns: MagicDnsRuntime) -> Self { + Self { + _nic_ctx: Some(Box::new(nic_ctx)), + magic_dns, + } + } + + fn packet_drain(tasks: JoinSet<()>) -> Self { + Self { + _nic_ctx: Some(Box::new(tasks)), + magic_dns: MagicDnsRuntime::default(), + } + } +} + +#[derive(Clone)] +pub(super) struct TunNicState { + nic_ctx: Arc>>, + receiver: Arc>>>, +} + +impl TunNicState { + pub(super) fn empty() -> Self { + Self { + nic_ctx: Arc::new(Mutex::new(None)), + receiver: Arc::new(OnceLock::new()), + } + } + + pub(super) fn install_receiver(&self, receiver: HostPacketReceiver) -> anyhow::Result<()> { + self.receiver + .set(Arc::new(Mutex::new(receiver))) + .map_err(|_| anyhow::anyhow!("native packet receiver is already installed")) + } + + pub(super) fn receiver(&self) -> Arc> { + self.receiver + .get() + .expect("packet receiver must be installed before preparing TUN") + .clone() + } + + pub(super) async fn stop(&self) { + let mut old = self.nic_ctx.lock().await.take(); + if let Some(nic) = old.as_mut() { + nic.magic_dns.stop().await; + } + drop(old); + } + + pub(super) async fn drain(&self) { + self.stop().await; + let receiver = self.receiver(); + let mut tasks = JoinSet::new(); + tasks.spawn(async move { + let mut receiver = receiver.lock().await; + while let Some(packet) = receiver.recv().await { + tracing::trace!(?packet, "discarded packet without a native interface"); + } + }); + self.nic_ctx + .lock() + .await + .replace(NicCtxContainer::packet_drain(tasks)); + } + + pub(super) async fn install(&self, nic: NicCtx, magic_dns: MagicDnsRuntime) { + self.stop().await; + self.nic_ctx + .lock() + .await + .replace(NicCtxContainer::new(nic, magic_dns)); + } +} diff --git a/vendor/easytier/easytier/src/instance/runtime_host/tun_desktop.rs b/vendor/easytier/easytier/src/instance/runtime_host/tun_desktop.rs new file mode 100644 index 0000000..94629a3 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/runtime_host/tun_desktop.rs @@ -0,0 +1,256 @@ +use std::{sync::Arc, time::Duration}; + +use anyhow::Context as _; +use cidr::Ipv4Inet; +use easytier_core::{ + gateway::dhcp::{DhcpIpv4ApplyOutcome, DhcpIpv4ApplyPermit, DhcpIpv4Host}, + host::packet::HostPacketReceiver, + instance::CorePacketPlane, +}; +use futures::FutureExt as _; +use tokio::{ + sync::{Mutex, Notify, oneshot}, + task::JoinHandle, +}; +use tokio_util::sync::CancellationToken; + +use super::{MagicDnsRuntime, tun_common::TunNicState}; +use crate::{ + common::{ + error::Error, + global_ctx::{ArcGlobalCtx, GlobalCtxEvent}, + }, + instance::virtual_nic::NicCtx, +}; + +pub(super) struct NativeTunRuntime { + global_ctx: ArcGlobalCtx, + cancel: CancellationToken, + nic: TunNicState, + static_ip_task: Mutex>>, +} + +impl NativeTunRuntime { + pub(super) fn new(global_ctx: ArcGlobalCtx, cancel: CancellationToken) -> Self { + Self { + global_ctx, + cancel, + nic: TunNicState::empty(), + static_ip_task: Mutex::new(None), + } + } + + pub(super) fn install_packet_receiver( + &self, + receiver: HostPacketReceiver, + ) -> anyhow::Result<()> { + self.nic.install_receiver(receiver) + } + + fn report_static_ip_cancelled(output: &mut Option>>) { + if let Some(output) = output.take() { + let _ = output.send(Err(anyhow::anyhow!( + "instance is closing; static IP setup cancelled" + ) + .into())); + } + } + + async fn start_static_ip(&self, packet_plane: Arc) -> anyhow::Result<()> { + let ipv4 = self.global_ctx.get_ipv4(); + let ipv6 = self.global_ctx.get_ipv6(); + if ipv4.is_none() && ipv6.is_none() { + return Ok(()); + } + + let nic_state = self.nic.clone(); + let cancel = self.cancel.clone(); + let global_ctx = self.global_ctx.clone(); + let receiver = self.nic.receiver(); + let (output, first_round) = oneshot::channel(); + let task = tokio::spawn(async move { + let mut output = Some(output); + loop { + if cancel.is_cancelled() { + Self::report_static_ip_cancelled(&mut output); + return; + } + let closed = Arc::new(Notify::new()); + let mut nic = NicCtx::new( + global_ctx.clone(), + packet_plane.clone(), + receiver.clone(), + closed.clone(), + ); + let result = tokio::select! { + biased; + _ = cancel.cancelled() => { + Self::report_static_ip_cancelled(&mut output); + return; + } + result = nic.run(ipv4, ipv6) => result, + }; + if let Err(error) = result { + if let Some(output) = output.take() { + let _ = output.send(Err(error)); + return; + } + tracing::error!(?error, "failed to create native interface"); + tokio::select! { + _ = cancel.cancelled() => return, + _ = tokio::time::sleep(Duration::from_secs(1)) => {} + } + continue; + } + + let magic_dns = if let Some(ip) = ipv4 { + MagicDnsRuntime::start( + global_ctx.clone(), + packet_plane.clone(), + nic.ifname().await, + ip, + ) + } else { + MagicDnsRuntime::default() + }; + nic_state.install(nic, magic_dns).await; + if let Some(output) = output.take() { + let _ = output.send(Ok(())); + } + tokio::select! { + _ = cancel.cancelled() => return, + _ = closed.notified() => {} + } + } + }); + self.static_ip_task.lock().await.replace(task); + first_round + .await + .context("static IP setup task stopped")??; + Ok(()) + } + + pub(super) async fn prepare(&self, packet_plane: Arc) -> anyhow::Result<()> { + self.nic.drain().await; + if !self.global_ctx.get_flags().no_tun { + self.start_static_ip(packet_plane).await?; + } + Ok(()) + } + + pub(super) async fn shutdown(&self) { + if let Some(task) = self.static_ip_task.lock().await.take() { + let _ = task.await; + } + self.nic.stop().await; + } + + pub(super) fn attach_fd(&self, _fd: i32) -> anyhow::Result<()> { + anyhow::bail!("external TUN attachment is only supported on mobile Hosts") + } + + pub(super) fn dhcp_host( + &self, + operation: Arc>, + packet_plane: Arc, + ) -> Arc { + Arc::new(NativeDhcpIpv4Host { + global_ctx: self.global_ctx.clone(), + operation, + cancel: self.cancel.clone(), + nic: self.nic.clone(), + closed: Arc::new(Notify::new()), + packet_plane, + }) + } +} + +struct NativeDhcpIpv4Host { + global_ctx: ArcGlobalCtx, + operation: Arc>, + cancel: CancellationToken, + nic: TunNicState, + closed: Arc, + packet_plane: Arc, +} + +impl NativeDhcpIpv4Host { + fn ensure_open(&self) -> anyhow::Result<()> { + if self.cancel.is_cancelled() { + anyhow::bail!("instance is closing; DHCP update cancelled"); + } + Ok(()) + } + + async fn apply(&self, next: Option) -> anyhow::Result> { + self.ensure_open()?; + tokio::select! { + _ = self.cancel.cancelled() => anyhow::bail!("instance is closing; DHCP update cancelled"), + _ = self.nic.drain() => {} + } + self.ensure_open()?; + + let Some(ip) = next else { + self.global_ctx.set_ipv4(None); + return Ok(None); + }; + if self.global_ctx.no_tun() { + self.global_ctx.set_ipv4(Some(ip)); + return Ok(Some(ip)); + } + + let mut nic = NicCtx::new( + self.global_ctx.clone(), + self.packet_plane.clone(), + self.nic.receiver(), + self.closed.clone(), + ); + tokio::select! { + _ = self.cancel.cancelled() => anyhow::bail!("instance is closing; DHCP update cancelled"), + result = nic.run(Some(ip), self.global_ctx.get_ipv6()) => result?, + } + let magic_dns = MagicDnsRuntime::start( + self.global_ctx.clone(), + self.packet_plane.clone(), + nic.ifname().await, + ip, + ); + self.nic.install(nic, magic_dns).await; + self.global_ctx.set_ipv4(Some(ip)); + Ok(Some(ip)) + } +} + +#[async_trait::async_trait] +impl DhcpIpv4Host for NativeDhcpIpv4Host { + fn take_interface_closed(&self) -> bool { + self.closed.notified().now_or_never().is_some() + } + + async fn apply_dhcp_ipv4( + &self, + _previous: Option, + next: Option, + ) -> DhcpIpv4ApplyOutcome { + let permit = self.operation.clone().lock_owned().await; + let outcome = match self.apply(next).await { + Ok(actual) => DhcpIpv4ApplyOutcome::applied(actual), + Err(error) => DhcpIpv4ApplyOutcome::failed(self.global_ctx.get_ipv4(), error), + }; + outcome.with_permit(DhcpIpv4ApplyPermit::new(permit)) + } + + fn publish_dhcp_ipv4( + &self, + previous: Option, + requested: Option, + actual: Option, + ) { + let event = if requested.is_none() { + GlobalCtxEvent::DhcpIpv4Conflicted(previous) + } else { + GlobalCtxEvent::DhcpIpv4Changed(previous, actual) + }; + self.global_ctx.issue_event(event); + } +} diff --git a/vendor/easytier/easytier/src/instance/runtime_host/tun_disabled.rs b/vendor/easytier/easytier/src/instance/runtime_host/tun_disabled.rs new file mode 100644 index 0000000..6de9c9d --- /dev/null +++ b/vendor/easytier/easytier/src/instance/runtime_host/tun_disabled.rs @@ -0,0 +1,112 @@ +use std::sync::Arc; + +use cidr::Ipv4Inet; +use easytier_core::{ + gateway::dhcp::{DhcpIpv4ApplyOutcome, DhcpIpv4ApplyPermit, DhcpIpv4Host}, + host::packet::HostPacketReceiver, + instance::CorePacketPlane, +}; +use tokio::sync::Mutex; +use tokio_util::sync::CancellationToken; + +use crate::common::global_ctx::{ArcGlobalCtx, GlobalCtxEvent}; + +pub(super) struct NativeTunRuntime { + global_ctx: ArcGlobalCtx, + cancel: CancellationToken, +} + +impl NativeTunRuntime { + pub(super) fn new(global_ctx: ArcGlobalCtx, cancel: CancellationToken) -> Self { + Self { global_ctx, cancel } + } + + pub(super) fn install_packet_receiver( + &self, + receiver: HostPacketReceiver, + ) -> anyhow::Result<()> { + drop(receiver); + Ok(()) + } + + pub(super) async fn prepare(&self, _packet_plane: Arc) -> anyhow::Result<()> { + Ok(()) + } + + pub(super) async fn shutdown(&self) {} + + pub(super) fn attach_fd(&self, _fd: i32) -> anyhow::Result<()> { + anyhow::bail!("external TUN attachment is only supported on mobile Hosts") + } + + pub(super) fn dhcp_host( + &self, + operation: Arc>, + _packet_plane: Arc, + ) -> Arc { + Arc::new(NativeDhcpIpv4Host { + global_ctx: self.global_ctx.clone(), + operation, + cancel: self.cancel.clone(), + }) + } +} + +struct NativeDhcpIpv4Host { + global_ctx: ArcGlobalCtx, + operation: Arc>, + cancel: CancellationToken, +} + +impl NativeDhcpIpv4Host { + fn ensure_open(&self) -> anyhow::Result<()> { + if self.cancel.is_cancelled() { + anyhow::bail!("instance is closing; DHCP update cancelled"); + } + Ok(()) + } + + async fn apply(&self, next: Option) -> anyhow::Result> { + self.ensure_open()?; + let Some(ip) = next else { + self.global_ctx.set_ipv4(None); + return Ok(None); + }; + self.global_ctx.set_ipv4(Some(ip)); + Ok(Some(ip)) + } +} + +#[async_trait::async_trait] +impl DhcpIpv4Host for NativeDhcpIpv4Host { + fn take_interface_closed(&self) -> bool { + false + } + + async fn apply_dhcp_ipv4( + &self, + _previous: Option, + next: Option, + ) -> DhcpIpv4ApplyOutcome { + let permit = self.operation.clone().lock_owned().await; + let outcome = match self.apply(next).await { + Ok(actual) => DhcpIpv4ApplyOutcome::applied(actual), + Err(error) => DhcpIpv4ApplyOutcome::failed(self.global_ctx.get_ipv4(), error), + }; + outcome.with_permit(DhcpIpv4ApplyPermit::new(permit)) + } + + fn publish_dhcp_ipv4( + &self, + previous: Option, + requested: Option, + actual: Option, + ) { + let event = if requested.is_none() { + GlobalCtxEvent::DhcpIpv4Conflicted(previous) + } else { + GlobalCtxEvent::DhcpIpv4Changed(previous, actual) + }; + self.global_ctx.issue_event(event); + } +} diff --git a/vendor/easytier/easytier/src/instance/runtime_host/tun_mobile.rs b/vendor/easytier/easytier/src/instance/runtime_host/tun_mobile.rs new file mode 100644 index 0000000..4f45932 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/runtime_host/tun_mobile.rs @@ -0,0 +1,197 @@ +use std::sync::Arc; + +use anyhow::Context as _; +use cidr::Ipv4Inet; +use easytier_core::{ + gateway::dhcp::{DhcpIpv4ApplyOutcome, DhcpIpv4ApplyPermit, DhcpIpv4Host}, + host::packet::HostPacketReceiver, + instance::CorePacketPlane, +}; +use futures::FutureExt as _; +use tokio::sync::{Mutex, Notify, mpsc}; +use tokio_util::sync::CancellationToken; + +use super::{MagicDnsRuntime, tun_common::TunNicState}; +use crate::{ + common::global_ctx::{ArcGlobalCtx, GlobalCtxEvent}, + instance::virtual_nic::NicCtx, +}; + +pub(super) struct NativeTunRuntime { + global_ctx: ArcGlobalCtx, + cancel: CancellationToken, + nic: TunNicState, + tun_fd: mpsc::Sender, + tun_fd_receiver: Mutex>>, + task: Mutex>>, +} + +impl NativeTunRuntime { + pub(super) fn new(global_ctx: ArcGlobalCtx, cancel: CancellationToken) -> Self { + let (tun_fd, tun_fd_receiver) = mpsc::channel(16); + Self { + global_ctx, + cancel, + nic: TunNicState::empty(), + tun_fd, + tun_fd_receiver: Mutex::new(Some(tun_fd_receiver)), + task: Mutex::new(None), + } + } + + pub(super) fn install_packet_receiver( + &self, + receiver: HostPacketReceiver, + ) -> anyhow::Result<()> { + self.nic.install_receiver(receiver) + } + + async fn install_mobile_tun( + nic_state: TunNicState, + global_ctx: ArcGlobalCtx, + packet_plane: Arc, + fd: i32, + ) -> anyhow::Result<()> { + nic_state.drain().await; + if fd <= 0 { + return Ok(()); + } + let closed = Arc::new(Notify::new()); + let mut nic = NicCtx::new( + global_ctx.clone(), + packet_plane.clone(), + nic_state.receiver(), + closed, + ); + nic.run_for_mobile(fd).await.context("add ip failed")?; + let magic_dns = global_ctx + .get_ipv4() + .map(|ip| MagicDnsRuntime::start(global_ctx, packet_plane, None, ip)) + .unwrap_or_default(); + nic_state.install(nic, magic_dns).await; + Ok(()) + } + + pub(super) async fn prepare(&self, packet_plane: Arc) -> anyhow::Result<()> { + self.nic.drain().await; + let Some(mut tun_fds) = self.tun_fd_receiver.lock().await.take() else { + return Ok(()); + }; + let nic_state = self.nic.clone(); + let global_ctx = self.global_ctx.clone(); + let cancel = self.cancel.clone(); + self.task.lock().await.replace(tokio::spawn(async move { + loop { + let fd = tokio::select! { + _ = cancel.cancelled() => return, + fd = tun_fds.recv() => match fd { Some(fd) => fd, None => return }, + }; + if let Err(error) = Self::install_mobile_tun( + nic_state.clone(), + global_ctx.clone(), + packet_plane.clone(), + fd, + ) + .await + { + tracing::error!(?error, "failed to attach mobile TUN fd"); + } + } + })); + Ok(()) + } + + pub(super) async fn shutdown(&self) { + if let Some(task) = self.task.lock().await.take() { + let _ = task.await; + } + self.nic.stop().await; + } + + pub(super) fn attach_fd(&self, fd: i32) -> anyhow::Result<()> { + self.tun_fd + .try_send(fd) + .map_err(|error| anyhow::anyhow!("failed to send TUN fd: {error}")) + } + + pub(super) fn dhcp_host( + &self, + operation: Arc>, + _packet_plane: Arc, + ) -> Arc { + Arc::new(NativeDhcpIpv4Host { + global_ctx: self.global_ctx.clone(), + operation, + cancel: self.cancel.clone(), + nic: self.nic.clone(), + closed: Arc::new(Notify::new()), + }) + } +} + +struct NativeDhcpIpv4Host { + global_ctx: ArcGlobalCtx, + operation: Arc>, + cancel: CancellationToken, + nic: TunNicState, + closed: Arc, +} + +impl NativeDhcpIpv4Host { + fn ensure_open(&self) -> anyhow::Result<()> { + if self.cancel.is_cancelled() { + anyhow::bail!("instance is closing; DHCP update cancelled"); + } + Ok(()) + } + + async fn apply(&self, next: Option) -> anyhow::Result> { + self.ensure_open()?; + tokio::select! { + _ = self.cancel.cancelled() => anyhow::bail!("instance is closing; DHCP update cancelled"), + _ = self.nic.drain() => {} + } + self.ensure_open()?; + + let Some(ip) = next else { + self.global_ctx.set_ipv4(None); + return Ok(None); + }; + self.global_ctx.set_ipv4(Some(ip)); + Ok(Some(ip)) + } +} + +#[async_trait::async_trait] +impl DhcpIpv4Host for NativeDhcpIpv4Host { + fn take_interface_closed(&self) -> bool { + self.closed.notified().now_or_never().is_some() + } + + async fn apply_dhcp_ipv4( + &self, + _previous: Option, + next: Option, + ) -> DhcpIpv4ApplyOutcome { + let permit = self.operation.clone().lock_owned().await; + let outcome = match self.apply(next).await { + Ok(actual) => DhcpIpv4ApplyOutcome::applied(actual), + Err(error) => DhcpIpv4ApplyOutcome::failed(self.global_ctx.get_ipv4(), error), + }; + outcome.with_permit(DhcpIpv4ApplyPermit::new(permit)) + } + + fn publish_dhcp_ipv4( + &self, + previous: Option, + requested: Option, + actual: Option, + ) { + let event = if requested.is_none() { + GlobalCtxEvent::DhcpIpv4Conflicted(previous) + } else { + GlobalCtxEvent::DhcpIpv4Changed(previous, actual) + }; + self.global_ctx.issue_event(event); + } +} diff --git a/vendor/easytier/easytier/src/instance/test_instance.rs b/vendor/easytier/easytier/src/instance/test_instance.rs new file mode 100644 index 0000000..3d81595 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/test_instance.rs @@ -0,0 +1,134 @@ +//! Test-only convenience around the production CoreInstance composition. + +use std::sync::Arc; + +use easytier_core::{ + config::toml::TomlConfig, connectivity::stun::StunSocketMapper, instance::CoreInstance, + process_runtime::CoreProcessRuntime, +}; + +use crate::{ + common::global_ctx::{ArcGlobalCtx, GlobalCtx}, + instance::{ + composition::{NativeCoreInstance, runtime_core_host_adapters_with_packet_egress}, + runtime_host::NativeInstanceRuntimeHost, + }, + socket::udp::RuntimeUdpSocket, +}; + +pub(crate) struct TestInstance { + core: Arc, + global_ctx: ArcGlobalCtx, +} + +impl TestInstance { + pub fn new_with_process_runtime( + config: TomlConfig, + process_runtime: Arc, + ) -> Self { + Self::compose(config, process_runtime, |_| {}) + } + + pub fn new_with_process_runtime_and_stun_provider( + config: TomlConfig, + process_runtime: Arc, + provider: Box>, + ) -> Self { + let provider: Arc> = Arc::from(provider); + Self::compose(config, process_runtime, move |adapters| { + adapters.replace_stun_provider(provider); + }) + } + + fn compose( + config: TomlConfig, + process_runtime: Arc, + customize: impl FnOnce( + &mut easytier_core::instance::CoreHostAdapters< + crate::instance::host::NativeInstanceHost, + >, + ), + ) -> Self { + let global_ctx = Arc::new(GlobalCtx::new(config.clone())); + let runtime_host = NativeInstanceRuntimeHost::new(global_ctx.clone()); + let mut adapters = runtime_core_host_adapters_with_packet_egress( + global_ctx.clone(), + process_runtime, + runtime_host.clone(), + ); + customize(&mut adapters); + adapters.instance_runtime = runtime_host; + let core = CoreInstance::from_toml(config, adapters) + .expect("test CoreInstance composition should be valid"); + Self { core, global_ctx } + } + + pub async fn run(&mut self) -> anyhow::Result<()> { + self.core.start().await + } + + pub async fn clear_resources(&mut self) { + self.core.stop().await; + } + + pub fn get_core_instance(&self) -> Arc { + self.core.clone() + } + + pub fn get_global_ctx(&self) -> ArcGlobalCtx { + self.global_ctx.clone() + } + + pub fn get_config_patcher(&self) -> TestConfigPatcher { + TestConfigPatcher { + core: self.core.clone(), + } + } +} + +pub(crate) struct TestConfigPatcher { + core: Arc, +} + +impl TestConfigPatcher { + pub async fn apply_patch( + &self, + patch: crate::proto::api::config::InstanceConfigPatch, + ) -> anyhow::Result<()> { + easytier_core::management::apply_config_patch(&self.core, patch, None).await + } +} + +#[cfg(test)] +mod tests { + use easytier_core::config::{ + normalize_secure_mode_config, + toml::{ConfigLoader as _, TomlConfig}, + }; + + use super::*; + + #[tokio::test] + async fn composition_preserves_secure_admin_identity() { + let config = TomlConfig::default(); + config.set_secure_mode(Some( + normalize_secure_mode_config(crate::proto::common::SecureModeConfig { + enabled: true, + ..Default::default() + }) + .unwrap(), + )); + + let instance = TestInstance::new_with_process_runtime(config, CoreProcessRuntime::new()); + + assert_eq!( + instance + .get_global_ctx() + .config + .get_network_identity() + .network_secret + .as_deref(), + Some("") + ); + } +} diff --git a/vendor/easytier/easytier/src/instance/udp_hole_punch.rs b/vendor/easytier/easytier/src/instance/udp_hole_punch.rs new file mode 100644 index 0000000..2e15972 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/udp_hole_punch.rs @@ -0,0 +1,41 @@ +//! Native UDP hole-punch platform adapter. +//! +//! Peer selection, signaling, RPC registration, socket/session ownership and +//! lifecycle live in `easytier-core`. Native only supplies OS port mapping. + +use std::sync::Arc; + +use async_trait::async_trait; +use easytier_core::connectivity::hole_punch::port_mapping::{ + ActiveUdpPortMapping, UdpPortMappingAttemptError, UdpPortMappingBackend, + UdpPortMappingLifecycle, UdpPortMappingPlatform, +}; + +use crate::common::{netns::NetNS, upnp}; + +struct RuntimeUdpHolePunchPlatform { + net_ns: NetNS, +} + +#[async_trait] +impl UdpPortMappingPlatform for RuntimeUdpHolePunchPlatform { + async fn establish_udp_port_mapping( + &self, + backend: UdpPortMappingBackend, + local_listener: &url::Url, + ) -> Result, UdpPortMappingAttemptError> { + upnp::establish_udp_port_mapping(self.net_ns.clone(), backend, local_listener.clone()).await + } + + fn spawn_udp_port_mapping_lifecycle( + &self, + local_listener: url::Url, + lifecycle: UdpPortMappingLifecycle, + ) { + upnp::spawn_udp_port_mapping_lifecycle(self.net_ns.clone(), local_listener, lifecycle); + } +} + +pub(crate) fn runtime_udp_hole_punch_platform(net_ns: NetNS) -> Arc { + Arc::new(RuntimeUdpHolePunchPlatform { net_ns }) +} diff --git a/vendor/easytier/easytier/src/instance/virtual_nic.rs b/vendor/easytier/easytier/src/instance/virtual_nic.rs new file mode 100644 index 0000000..17e3bf4 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/virtual_nic.rs @@ -0,0 +1,1352 @@ +use std::{ + collections::BTreeSet, + io, + net::{Ipv4Addr, Ipv6Addr}, + pin::Pin, + sync::Arc, + task::{Context, Poll}, +}; + +use crate::common::{ + error::Error, + global_ctx::{ArcGlobalCtx, GlobalCtxEvent}, + ifcfg::{IfConfiger, IfConfiguerTrait}, +}; + +use easytier_core::{ + host::packet::{HostPacket, HostPacketReceiver}, + instance::CorePacketPlane, + packet::{TAIL_RESERVED_SIZE, ZCPacket, ZCPacketType}, + tunnel::{ + StreamItem, Tunnel, TunnelError, ZCPacketSink, ZCPacketStream, + framed::{FramedWriter, ZCPacketToBytes, reserve_buf}, + wrapper::TunnelWrapper, + }, +}; + +use byteorder::WriteBytesExt as _; +use bytes::{Buf, BufMut, BytesMut}; +use cidr::{Ipv4Inet, Ipv6Inet}; +use futures::{SinkExt, Stream, StreamExt, lock::BiLock, ready}; +use pin_project_lite::pin_project; +use tokio::{ + io::{AsyncRead, AsyncWrite, ReadBuf}, + sync::{Mutex, Notify}, + task::JoinSet, +}; +use tokio_util::bytes::Bytes; +#[cfg(target_os = "windows")] +use tokio_util::task::AbortOnDropHandle; +use tun::{AbstractDevice, AsyncDevice, Configuration, Layer}; +use zerocopy::{NativeEndian, NetworkEndian}; + +#[cfg(target_os = "windows")] +use crate::common::ifcfg::RegistryManager; + +pin_project! { + pub struct TunStream { + #[pin] + l: BiLock, + cur_buf: BytesMut, + has_packet_info: bool, + payload_offset: usize, + } +} + +impl TunStream { + pub fn new(l: BiLock, has_packet_info: bool) -> Self { + let mut payload_offset = ZCPacketType::NIC.get_packet_offsets().payload_offset; + if has_packet_info { + payload_offset -= 4; + } + Self { + l, + cur_buf: BytesMut::new(), + has_packet_info, + payload_offset, + } + } +} + +impl Stream for TunStream { + type Item = StreamItem; + + fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let self_mut = self.project(); + let mut g = ready!(self_mut.l.poll_lock(cx)); + reserve_buf(self_mut.cur_buf, 2500, 4 * 1024); + if self_mut.cur_buf.is_empty() { + unsafe { + self_mut.cur_buf.set_len(*self_mut.payload_offset); + } + } + let buf = self_mut.cur_buf.chunk_mut().as_mut_ptr(); + let buf = unsafe { std::slice::from_raw_parts_mut(buf, 2500) }; + let mut buf = ReadBuf::new(buf); + + let ret = ready!(g.as_pin_mut().poll_read(cx, &mut buf)); + let len = buf.filled().len(); + if len == 0 { + return Poll::Ready(None); + } + unsafe { self_mut.cur_buf.advance_mut(len + TAIL_RESERVED_SIZE) }; + + let mut ret_buf = self_mut.cur_buf.split(); + let cur_len = ret_buf.len(); + ret_buf.truncate(cur_len - TAIL_RESERVED_SIZE); + + match ret { + Ok(_) => Poll::Ready(Some(Ok(ZCPacket::new_from_buf(ret_buf, ZCPacketType::NIC)))), + Err(err) => { + tracing::error!("tun stream error: {:?}", err); + Poll::Ready(None) + } + } + } +} + +#[derive(Debug, Clone, Copy, Default)] +enum PacketProtocol { + #[default] + IPv4, + IPv6, + Other, +} + +// Note: the protocol in the packet information header is platform dependent. +impl PacketProtocol { + #[cfg(any(target_os = "linux", target_os = "android", target_env = "ohos"))] + fn into_pi_field(self) -> Result { + use nix::libc; + match self { + PacketProtocol::IPv4 => Ok(libc::ETH_P_IP as u16), + PacketProtocol::IPv6 => Ok(libc::ETH_P_IPV6 as u16), + PacketProtocol::Other => Err(io::Error::other("neither an IPv4 nor IPv6 packet")), + } + } + + #[cfg(any(target_os = "macos", target_os = "ios", target_os = "freebsd"))] + fn into_pi_field(self) -> Result { + use nix::libc; + match self { + PacketProtocol::IPv4 => Ok(libc::PF_INET as u16), + PacketProtocol::IPv6 => Ok(libc::PF_INET6 as u16), + PacketProtocol::Other => Err(io::Error::other("neither an IPv4 nor IPv6 packet")), + } + } + + #[cfg(target_os = "windows")] + fn into_pi_field(self) -> Result { + unimplemented!() + } +} + +/// Infer the protocol based on the first nibble in the packet buffer. +fn infer_proto(buf: &[u8]) -> PacketProtocol { + match buf[0] >> 4 { + 4 => PacketProtocol::IPv4, + 6 => PacketProtocol::IPv6, + _ => PacketProtocol::Other, + } +} + +struct TunZCPacketToBytes { + has_packet_info: bool, +} + +impl TunZCPacketToBytes { + pub fn new(has_packet_info: bool) -> Self { + Self { has_packet_info } + } + + pub fn fill_packet_info( + &self, + mut buf: &mut [u8], + proto: PacketProtocol, + ) -> Result<(), io::Error> { + // flags is always 0 + buf.write_u16::(0)?; + // write the protocol as network byte order + buf.write_u16::(proto.into_pi_field()?)?; + Ok(()) + } +} + +impl ZCPacketToBytes for TunZCPacketToBytes { + fn zcpacket_into_bytes(&self, zc_packet: ZCPacket) -> Result { + let payload_offset = zc_packet.payload_offset(); + let mut inner = zc_packet.inner(); + // we have peer manager header, so payload offset must larger than 4 + assert!(payload_offset >= 4); + + let ret = if self.has_packet_info { + inner.advance(payload_offset - 4); + let proto = infer_proto(&inner[4..]); + self.fill_packet_info(&mut inner[0..4], proto)?; + inner + } else { + inner.advance(payload_offset); + inner + }; + + tracing::debug!(?ret, ?payload_offset, "convert zc packet to tun packet"); + + Ok(ret.into()) + } +} + +pin_project! { + pub struct TunAsyncWrite { + #[pin] + l: BiLock, + } +} + +impl AsyncWrite for TunAsyncWrite { + fn poll_write( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + let self_mut = self.project(); + let mut g = ready!(self_mut.l.poll_lock(cx)); + g.as_pin_mut().poll_write(cx, buf) + } + + fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let self_mut = self.project(); + let mut g = ready!(self_mut.l.poll_lock(cx)); + g.as_pin_mut().poll_flush(cx) + } + + fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + let self_mut = self.project(); + let mut g = ready!(self_mut.l.poll_lock(cx)); + g.as_pin_mut().poll_shutdown(cx) + } + + fn poll_write_vectored( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + bufs: &[io::IoSlice<'_>], + ) -> Poll> { + let self_mut = self.project(); + let mut g = ready!(self_mut.l.poll_lock(cx)); + g.as_pin_mut().poll_write_vectored(cx, bufs) + } + + fn is_write_vectored(&self) -> bool { + true + } +} + +pub struct VirtualNic { + global_ctx: ArcGlobalCtx, + + ifname: Option, + ifcfg: Box, +} + +impl Drop for VirtualNic { + fn drop(&mut self) { + #[cfg(target_os = "windows")] + { + if let Some(ref ifname) = self.ifname { + // Try to clean up firewall rules, but don't panic in destructor + if let Err(error) = crate::arch::windows::remove_interface_firewall_rules(ifname) { + tracing::warn!( + %error, + "failed to remove firewall rules for interface {}", + ifname + ); + } + } + } + } +} + +impl VirtualNic { + pub fn new(global_ctx: ArcGlobalCtx) -> Self { + Self { + global_ctx, + ifname: None, + ifcfg: Box::new(IfConfiger {}), + } + } + + /// Check and create TUN device node if necessary on Linux systems + #[cfg(target_os = "linux")] + async fn ensure_tun_device_node() { + const TUN_DEV_PATH: &str = "/dev/net/tun"; + const TUN_DIR_PATH: &str = "/dev/net"; + + // Check if /dev/net/tun already exists + if tokio::fs::metadata(TUN_DEV_PATH).await.is_ok() { + tracing::debug!("TUN device node {} already exists", TUN_DEV_PATH); + return; + } + + tracing::info!( + "TUN device node {} not found, attempting to create", + TUN_DEV_PATH + ); + + // Check if TUN kernel module is available + let tun_module_available = tokio::fs::metadata("/proc/net/dev").await.is_ok() + && (tokio::fs::read_to_string("/proc/modules").await) + .map(|content| content.contains("tun")) + .unwrap_or(false); + + if !tun_module_available { + tracing::warn!("TUN kernel module may not be available."); + tracing::warn!("\tYou may need to load it with: sudo modprobe tun."); + } + + // Try to create /dev/net directory if it doesn't exist + if tokio::fs::metadata(TUN_DIR_PATH).await.is_err() { + if let Err(error) = tokio::fs::create_dir_all(TUN_DIR_PATH).await { + tracing::warn!( + ?error, + "Failed to create directory {}. TUN device creation may fail. Continuing anyway.", + TUN_DIR_PATH + ); + tracing::warn!( + "\tYou may need to run with root privileges or manually create the TUN device." + ); + Self::print_troubleshooting_info(); + return; + } + tracing::info!("Created directory {}", TUN_DIR_PATH); + } + + // Try to create the TUN device node + // Major number 10, minor number 200 for /dev/net/tun + let dev_node = nix::sys::stat::makedev(10, 200); + + match nix::sys::stat::mknod( + TUN_DEV_PATH, + nix::sys::stat::SFlag::S_IFCHR, + nix::sys::stat::Mode::from_bits(0o600).unwrap(), + dev_node, + ) { + Ok(_) => { + tracing::info!("Successfully created TUN device node {}", TUN_DEV_PATH); + } + Err(error) => { + tracing::warn!( + %error, + "Failed to create TUN device node {}. Continuing anyway.", + TUN_DEV_PATH, + ); + Self::print_troubleshooting_info(); + } + } + } + + /// Print troubleshooting information for TUN device issues + #[cfg(target_os = "linux")] + fn print_troubleshooting_info() { + tracing::info!( + "Possible solutions:\ + \n\t1. Run with root privileges: sudo ./easytier-core [options]\ + \n\t2. Manually create TUN device: sudo mkdir -p /dev/net && sudo mknod /dev/net/tun c 10 200\ + \n\t3. Load TUN kernel module: sudo modprobe tun\ + \n\t4. Use --no-tun flag if TUN functionality is not needed\ + \n\t5. Check if your system/container supports TUN devices\ + \nNote: TUN functionality may still work if the kernel supports dynamic device creation." + ); + } + + /// FreeBSD specific: Rename a TUN interface + #[cfg(target_os = "freebsd")] + async fn rename_tun_interface(old_name: &str, new_name: &str) -> Result<(), Error> { + let output = tokio::process::Command::new("ifconfig") + .arg(old_name) + .arg("name") + .arg(new_name) + .output() + .await?; + + if output.status.success() { + tracing::info!( + "Successfully renamed interface {} to {}", + old_name, + new_name + ); + Ok(()) + } else { + let stderr = String::from_utf8_lossy(&output.stderr); + tracing::warn!( + "Failed to rename interface {} to {}: {}", + old_name, + new_name, + stderr + ); + // Return Ok even if rename fails, as it's not critical + Ok(()) + } + } + + /// FreeBSD specific: List all TUN interface names + #[cfg(target_os = "freebsd")] + async fn list_tun_names() -> Result, Error> { + let output = tokio::process::Command::new("ifconfig") + .arg("-g") + .arg("tun") + .output() + .await?; + + if output.status.success() { + let stdout = String::from_utf8_lossy(&output.stdout); + let tun_names: Vec = stdout + .trim() + .split_whitespace() + .map(|s| s.to_string()) + .collect(); + tracing::debug!("Found TUN interfaces: {:?}", tun_names); + Ok(tun_names) + } else { + let stderr = String::from_utf8_lossy(&output.stderr); + tracing::warn!("Failed to list TUN interfaces: {}", stderr); + Ok(Vec::new()) + } + } + + /// FreeBSD specific: Get interface information + #[cfg(target_os = "freebsd")] + async fn get_interface_info(ifname: &str) -> Result { + let output = tokio::process::Command::new("ifconfig") + .arg("-v") + .arg(ifname) + .output() + .await?; + + if output.status.success() { + Ok(String::from_utf8_lossy(&output.stdout).to_string()) + } else { + let stderr = String::from_utf8_lossy(&output.stderr); + Err( + anyhow::anyhow!("Failed to get interface details for {}: {}", ifname, stderr) + .into(), + ) + } + } + + /// FreeBSD specific: Extract original name from interface information + #[cfg(target_os = "freebsd")] + fn extract_original_name(ifinfo: &str) -> Option { + ifinfo + .lines() + .find(|line| line.trim().starts_with("drivername:")) + .and_then(|line| line.trim().split_whitespace().nth(1)) + .map(|name| name.to_string()) + } + + /// FreeBSD specific: Check if interface is used by any process + #[cfg(target_os = "freebsd")] + fn is_interface_used(ifinfo: &str) -> bool { + ifinfo.contains("Opened by PID") + } + + /// FreeBSD specific: Restore TUN interface name to its original value + #[cfg(target_os = "freebsd")] + async fn restore_tun_name(dev_name: &str) -> Result<(), Error> { + let tun_names = Self::list_tun_names().await?; + + // Check if desired dev_name is in use + if tun_names.iter().any(|name| name == dev_name) { + tracing::debug!( + "Desired dev_name {} is in TUN interfaces list, checking if it can be renamed", + dev_name + ); + + let ifinfo = Self::get_interface_info(dev_name).await?; + + // Check if interface is not occupied + if !Self::is_interface_used(&ifinfo) { + // Extract original name + if let Some(orig_name) = Self::extract_original_name(&ifinfo) { + if orig_name != dev_name { + tracing::info!( + "Restoring dev_name {} to original name {}", + dev_name, + orig_name + ); + // Rename interface + Self::rename_tun_interface(dev_name, &orig_name).await?; + } + } + } else { + tracing::debug!( + "Interface {} is opened by a process, skipping rename", + dev_name + ); + } + } + + Ok(()) + } + + async fn create_tun(&self) -> Result { + let mut config = Configuration::default(); + config.layer(Layer::L3); + + // FreeBSD specific: Check and restore TUN interfaces before creating new one + #[cfg(target_os = "freebsd")] + { + let dev_name = self.global_ctx.get_flags().dev_name; + + if !dev_name.is_empty() { + // Restore TUN interface name if needed, ignoring errors as it's not critical + let _ = Self::restore_tun_name(&dev_name).await; + } + } + + #[cfg(target_os = "linux")] + { + // Check and create TUN device node if necessary (Linux only) + Self::ensure_tun_device_node().await; + + let dev_name = self.global_ctx.get_flags().dev_name; + if !dev_name.is_empty() { + config.tun_name(&dev_name); + } + } + + #[cfg(all(target_os = "macos", not(feature = "macos-ne")))] + config.platform_config(|config| { + // disable packet information so we can process the header by ourselves, see tun2 impl for more details + config.packet_information(false); + }); + + #[cfg(target_os = "windows")] + { + let dev_name = self.global_ctx.get_flags().dev_name; + + match crate::arch::windows::add_self_to_firewall_allowlist() { + Ok(_) => tracing::info!("add_self_to_firewall_allowlist successful!"), + Err(error) => { + tracing::warn!(%error, "Failed to add Easytier to firewall allowlist, Subnet proxy and KCP proxy may not work properly."); + tracing::warn!( + "You can add firewall rules manually, or use --use-smoltcp to run with user-space TCP/IP stack." + ); + } + } + + match RegistryManager::reg_delete_obsoleted_items(&dev_name) { + Ok(_) => tracing::trace!("delete successful!"), + Err(e) => tracing::error!("An error occurred: {}", e), + } + + if !dev_name.is_empty() { + config.tun_name(&dev_name); + } else { + use rand::distributions::Distribution as _; + let c = crate::arch::windows::interface_count()?; + let mut rng = rand::thread_rng(); + let s: String = rand::distributions::Alphanumeric + .sample_iter(&mut rng) + .take(4) + .map(char::from) + .collect::() + .to_lowercase(); + + let random_dev_name = format!("et_{}_{}", c, s); + config.tun_name(random_dev_name.clone()); + + let mut flags = self.global_ctx.get_flags(); + flags.dev_name = random_dev_name.clone(); + self.global_ctx.set_flags(flags); + } + + config.platform_config(|config| { + config.skip_config(true); + config.ring_cap(Some(std::cmp::min( + config.min_ring_cap() * 32, + config.max_ring_cap(), + ))); + }); + } + + config.up(); + + let _g = self.global_ctx.net_ns.guard(); + Ok(tun::create(&config)?) + } + + #[cfg(mobile)] + pub async fn create_dev_for_mobile( + &mut self, + tun_fd: std::os::fd::RawFd, + ) -> Result, Error> { + tracing::debug!(%tun_fd); + let mut config = Configuration::default(); + config.layer(Layer::L3); + + #[cfg(any(target_os = "ios", all(target_os = "macos", feature = "macos-ne")))] + config.platform_config(|config| { + // disable packet information so we can process the header by ourselves, see tun2 impl for more details + config.packet_information(false); + }); + + config.raw_fd(tun_fd); + config.close_fd_on_drop(false); + config.up(); + + let has_packet_info = cfg!(any( + target_os = "ios", + all(target_os = "macos", feature = "macos-ne") + )); + let dev = tun::create(&config)?; + let dev = AsyncDevice::new(dev)?; + let (a, b) = BiLock::new(dev); + let ft = TunnelWrapper::new( + TunStream::new(a, has_packet_info), + FramedWriter::new_with_converter( + TunAsyncWrite { l: b }, + TunZCPacketToBytes::new(has_packet_info), + ), + None, + ); + + self.ifname = Some(format!("tunfd_{}", tun_fd)); + + Ok(Box::new(ft)) + } + + pub async fn create_dev(&mut self) -> Result, Error> { + let dev = self.create_tun().await?; + + #[cfg(not(target_os = "freebsd"))] + let ifname = dev.tun_name()?; + + #[cfg(target_os = "freebsd")] + let mut ifname = dev.tun_name()?; + self.ifcfg.wait_interface_show(ifname.as_str()).await?; + + // FreeBSD TUN interface rename functionality + #[cfg(target_os = "freebsd")] + { + let dev_name = self.global_ctx.get_flags().dev_name; + + if !dev_name.is_empty() && dev_name != ifname { + // Use ifconfig to rename the TUN interface + if Self::rename_tun_interface(&ifname, &dev_name).await.is_ok() { + ifname = dev_name; + } + } + } + + #[cfg(target_os = "windows")] + { + if let Ok(guid) = RegistryManager::find_interface_guid(&ifname) { + if let Err(e) = RegistryManager::disable_dynamic_updates(&guid) { + tracing::error!( + "Failed to disable dhcp for interface {} {}: {}", + ifname, + guid, + e + ); + } + + // Disable NetBIOS over TCP/IP + if let Err(e) = RegistryManager::disable_netbios(&guid) { + tracing::error!( + "Failed to disable netbios for interface {} {}: {}", + ifname, + guid, + e + ); + } + } + } + + let dev = AsyncDevice::new(dev)?; + + let flags = self.global_ctx.get_flags(); + let mut mtu_in_config = flags.mtu; + if flags.enable_encryption { + mtu_in_config -= 20; + } + { + // set mtu by ourselves, rust-tun does not handle it correctly on windows + let _g = self.global_ctx.net_ns.guard(); + self.ifcfg.set_mtu(ifname.as_str(), mtu_in_config).await?; + } + + let has_packet_info = cfg!(all(target_os = "macos", not(feature = "macos-ne"))); + let (a, b) = BiLock::new(dev); + let ft = TunnelWrapper::new( + TunStream::new(a, has_packet_info), + FramedWriter::new_with_converter( + TunAsyncWrite { l: b }, + TunZCPacketToBytes::new(has_packet_info), + ), + None, + ); + + self.ifname = Some(ifname.to_owned()); + + #[cfg(target_os = "windows")] + { + // Add firewall rules for virtual NIC interface to allow all traffic + match crate::arch::windows::add_interface_to_firewall_allowlist(&ifname) { + Ok(_) => { + tracing::info!( + "Successfully configured Windows Firewall for interface: {}", + ifname + ); + tracing::info!( + "All protocols (TCP/UDP/ICMP) are now allowed on interface: {}", + ifname + ); + } + Err(error) => { + tracing::warn!(%error, "Failed to configure Windows Firewall for interface {}\ + \n\tThis may cause connectivity issues with ping and other network functions.\ + \n\tPlease run as Administrator or manually configure Windows Firewall.\ + \n\tAlternatively, you can disable Windows Firewall for testing purposes.", ifname); + } + } + } + + Ok(Box::new(ft)) + } + + pub fn ifname(&self) -> &str { + self.ifname.as_ref().unwrap().as_str() + } + + pub async fn link_up(&self) -> Result<(), Error> { + let _g = self.global_ctx.net_ns.guard(); + self.ifcfg.set_link_status(self.ifname(), true).await?; + Ok(()) + } + + pub async fn add_route(&self, address: Ipv4Addr, cidr: u8) -> Result<(), Error> { + let _g = self.global_ctx.net_ns.guard(); + self.ifcfg + .add_ipv4_route(self.ifname(), address, cidr, None) + .await?; + Ok(()) + } + + pub async fn add_ipv6_route(&self, address: Ipv6Addr, cidr: u8) -> Result<(), Error> { + self.add_ipv6_route_with_cost(address, cidr, None).await + } + + pub async fn add_ipv6_route_with_cost( + &self, + address: Ipv6Addr, + cidr: u8, + cost: Option, + ) -> Result<(), Error> { + let _g = self.global_ctx.net_ns.guard(); + self.ifcfg + .add_ipv6_route(self.ifname(), address, cidr, cost) + .await?; + Ok(()) + } + + pub async fn remove_ipv6_route(&self, address: Ipv6Addr, cidr: u8) -> Result<(), Error> { + let _g = self.global_ctx.net_ns.guard(); + self.ifcfg + .remove_ipv6_route(self.ifname(), address, cidr) + .await?; + Ok(()) + } + + pub async fn remove_ip(&self, ip: Option) -> Result<(), Error> { + let _g = self.global_ctx.net_ns.guard(); + self.ifcfg.remove_ip(self.ifname(), ip).await?; + Ok(()) + } + + pub async fn remove_ipv6(&self, ip: Option) -> Result<(), Error> { + let _g = self.global_ctx.net_ns.guard(); + self.ifcfg.remove_ipv6(self.ifname(), ip).await?; + Ok(()) + } + + pub async fn add_ip(&self, ip: Ipv4Addr, cidr: i32) -> Result<(), Error> { + let _g = self.global_ctx.net_ns.guard(); + self.ifcfg + .add_ipv4_ip(self.ifname(), ip, cidr as u8) + .await?; + Ok(()) + } + + pub async fn add_ipv6(&self, ip: Ipv6Addr, cidr: i32) -> Result<(), Error> { + let _g = self.global_ctx.net_ns.guard(); + self.ifcfg + .add_ipv6_ip(self.ifname(), ip, cidr as u8) + .await?; + Ok(()) + } + + pub fn get_ifcfg(&self) -> impl IfConfiguerTrait + use<> { + IfConfiger {} + } +} + +pub struct NicCtx { + global_ctx: ArcGlobalCtx, + packet_plane: Arc, + peer_packet_receiver: Arc>, + + close_notifier: Arc, + + nic: Arc>, + tasks: JoinSet<()>, + + #[cfg(target_os = "windows")] + windows_udp_broadcast_relay: Option>, +} + +impl NicCtx { + pub(crate) fn new( + global_ctx: ArcGlobalCtx, + packet_plane: Arc, + peer_packet_receiver: Arc>, + close_notifier: Arc, + ) -> Self { + NicCtx { + global_ctx: global_ctx.clone(), + packet_plane, + peer_packet_receiver, + + close_notifier, + + nic: Arc::new(Mutex::new(VirtualNic::new(global_ctx))), + tasks: JoinSet::new(), + + #[cfg(target_os = "windows")] + windows_udp_broadcast_relay: None, + } + } + + pub async fn ifname(&self) -> Option { + let nic = self.nic.lock().await; + nic.ifname.as_ref().map(|s| s.to_owned()) + } + + pub async fn assign_ipv4_to_tun_device(&self, ipv4_addr: cidr::Ipv4Inet) -> Result<(), Error> { + let nic = self.nic.lock().await; + nic.link_up().await?; + nic.remove_ip(None).await?; + nic.add_ip(ipv4_addr.address(), ipv4_addr.network_length() as i32) + .await?; + #[cfg(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" + ))] + { + nic.add_route(ipv4_addr.first_address(), ipv4_addr.network_length()) + .await?; + } + Ok(()) + } + + pub async fn assign_ipv6_to_tun_device(&self, ipv6_addr: cidr::Ipv6Inet) -> Result<(), Error> { + let nic = self.nic.lock().await; + nic.link_up().await?; + nic.remove_ipv6(None).await?; + nic.add_ipv6(ipv6_addr.address(), ipv6_addr.network_length() as i32) + .await?; + #[cfg(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" + ))] + { + nic.add_ipv6_route(ipv6_addr.first_address(), ipv6_addr.network_length()) + .await?; + } + Ok(()) + } + + async fn do_forward_nic_to_peers(ret: ZCPacket, packet_plane: &CorePacketPlane) { + if ret.payload().is_empty() { + return; + } + tracing::trace!( + ?ret, + "[USER_PACKET] recv new packet from tun device and forward to peers." + ); + if let Err(error) = packet_plane + .send_ip_packet(HostPacket::from_tun_packet(ret)) + .await + { + tracing::trace!(?error, "[USER_PACKET] send_msg failed"); + } + } + + fn do_forward_nic_to_peers_task( + &mut self, + mut stream: Pin>, + ) -> Result<(), Error> { + // read from nic and write to corresponding tunnel + let packet_plane = self.packet_plane.clone(); + let close_notifier = self.close_notifier.clone(); + self.tasks.spawn(async move { + while let Some(ret) = stream.next().await { + if ret.is_err() { + tracing::error!("read from nic failed: {:?}", ret); + break; + } + Self::do_forward_nic_to_peers(ret.unwrap(), packet_plane.as_ref()).await; + } + close_notifier.notify_one(); + tracing::error!("nic closed when recving from it"); + }); + + Ok(()) + } + + fn do_forward_peers_to_nic(&mut self, mut sink: Pin>) { + let channel = self.peer_packet_receiver.clone(); + let close_notifier = self.close_notifier.clone(); + self.tasks.spawn(async move { + // unlock until coroutine finished + let mut channel = channel.lock().await; + while let Some(packet) = channel.recv().await { + tracing::trace!( + "[USER_PACKET] forward packet from peers to nic. packet: {:?}", + packet + ); + let ret = sink.send(packet.into_tun_packet()).await; + if ret.is_err() { + tracing::error!(?ret, "do_forward_tunnel_to_nic sink error"); + } + } + close_notifier.notify_one(); + tracing::error!("nic closed when sending to it"); + }); + } + + #[cfg(target_os = "windows")] + fn start_windows_udp_broadcast_relay(&mut self, virtual_ipv4: Ipv4Inet) { + if !self.global_ctx.get_flags().enable_udp_broadcast_relay { + return; + } + + match super::windows_udp_broadcast::start( + self.packet_plane.clone(), + self.global_ctx.clone(), + virtual_ipv4, + ) { + Ok(handle) => { + self.windows_udp_broadcast_relay = Some(handle); + tracing::info!("Windows UDP broadcast relay started"); + } + Err(err) => { + tracing::warn!( + ?err, + "failed to start Windows UDP broadcast relay; administrator privileges are required" + ); + } + } + } + + async fn apply_route_changes( + ifcfg: &impl IfConfiguerTrait, + ifname: &str, + net_ns: &crate::common::netns::NetNS, + cur_proxy_cidrs: &mut BTreeSet, + added: Vec, + removed: Vec, + ) { + tracing::debug!(?added, ?removed, "applying proxy_cidrs route changes"); + + // Remove routes + for cidr in removed { + if !cur_proxy_cidrs.contains(&cidr) { + continue; + } + let _g = net_ns.guard(); + let ret = ifcfg + .remove_ipv4_route(ifname, cidr.first_address(), cidr.network_length()) + .await; + + if ret.is_err() { + tracing::trace!( + cidr = ?cidr, + err = ?ret, + "remove route failed.", + ); + } + cur_proxy_cidrs.remove(&cidr); + } + + // Add routes + for cidr in added { + if cur_proxy_cidrs.contains(&cidr) { + continue; + } + let _g = net_ns.guard(); + let ret = ifcfg + .add_ipv4_route(ifname, cidr.first_address(), cidr.network_length(), None) + .await; + + if ret.is_err() { + tracing::trace!( + cidr = ?cidr, + err = ?ret, + "add route failed.", + ); + } + if ret.is_ok() { + cur_proxy_cidrs.insert(cidr); + } + } + } + + async fn apply_public_ipv6_route_changes( + ifcfg: &impl IfConfiguerTrait, + ifname: &str, + net_ns: &crate::common::netns::NetNS, + cur_routes: &mut BTreeSet, + added: Vec, + removed: Vec, + ) { + for route in removed { + if !cur_routes.contains(&route) { + continue; + } + let _g = net_ns.guard(); + let ret = ifcfg + .remove_ipv6_route(ifname, route.address(), route.network_length()) + .await; + if ret.is_err() { + tracing::trace!(route = ?route, err = ?ret, "remove public ipv6 route failed"); + } + cur_routes.remove(&route); + } + + for route in added { + if cur_routes.contains(&route) { + continue; + } + let _g = net_ns.guard(); + let ret = ifcfg + .add_ipv6_route(ifname, route.address(), route.network_length(), None) + .await; + if ret.is_err() { + tracing::trace!(route = ?route, err = ?ret, "add public ipv6 route failed"); + } else { + cur_routes.insert(route); + } + } + } + + async fn run_proxy_cidrs_route_updater(&mut self) -> Result<(), Error> { + let packet_plane = self.packet_plane.clone(); + let global_ctx = self.global_ctx.clone(); + let net_ns = self.global_ctx.net_ns.clone(); + let nic = self.nic.lock().await; + let ifcfg = nic.get_ifcfg(); + let ifname = nic.ifname().to_owned(); + let mut event_receiver = global_ctx.subscribe(); + + self.tasks.spawn(async move { + let mut cur_proxy_cidrs = BTreeSet::::new(); + + // Initial sync: get current proxy_cidrs state and apply routes + let Some(diff) = packet_plane.proxy_cidr_diff(&cur_proxy_cidrs).await else { + tracing::error!("proxy CIDR monitor host is unavailable"); + return; + }; + Self::apply_route_changes( + &ifcfg, + &ifname, + &net_ns, + &mut cur_proxy_cidrs, + diff.added, + diff.removed, + ) + .await; + + let mut refresh = tokio::time::interval(std::time::Duration::from_secs(2)); + refresh.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip); + loop { + tokio::select! { + _ = refresh.tick() => {}, + event = event_receiver.recv() => match event { + Ok(GlobalCtxEvent::ProxyCidrsUpdated(..)) => {}, + Ok(_) => continue, + Err(tokio::sync::broadcast::error::RecvError::Closed) => break, + Err(tokio::sync::broadcast::error::RecvError::Lagged(_)) => {}, + } + } + // Always recompute the host-filtered projection, including after lag + // and local interface changes. Raw event deltas bypass host policy. + let Some(diff) = packet_plane.proxy_cidr_diff(&cur_proxy_cidrs).await else { + return; + }; + Self::apply_route_changes( + &ifcfg, + &ifname, + &net_ns, + &mut cur_proxy_cidrs, + diff.added, + diff.removed, + ) + .await; + } + }); + + Ok(()) + } + + async fn run_public_ipv6_route_updater(&mut self) -> Result<(), Error> { + let packet_plane = self.packet_plane.clone(); + let global_ctx = self.global_ctx.clone(); + let net_ns = self.global_ctx.net_ns.clone(); + let nic = self.nic.lock().await; + let ifcfg = nic.get_ifcfg(); + let ifname = nic.ifname().to_owned(); + let mut event_receiver = global_ctx.subscribe(); + + self.tasks.spawn(async move { + let mut cur_routes = BTreeSet::::new(); + let initial_routes = packet_plane.public_ipv6_routes().await; + let initial_added = initial_routes.iter().copied().collect::>(); + Self::apply_public_ipv6_route_changes( + &ifcfg, + &ifname, + &net_ns, + &mut cur_routes, + initial_added, + Vec::new(), + ) + .await; + + loop { + let event = match event_receiver.recv().await { + Ok(event) => event, + Err(tokio::sync::broadcast::error::RecvError::Closed) => break, + Err(tokio::sync::broadcast::error::RecvError::Lagged(_)) => { + event_receiver = event_receiver.resubscribe(); + let latest = packet_plane.public_ipv6_routes().await; + let added = latest.difference(&cur_routes).copied().collect::>(); + let removed = cur_routes.difference(&latest).copied().collect::>(); + GlobalCtxEvent::PublicIpv6RoutesUpdated(added, removed) + } + }; + + let (added, removed) = match event { + GlobalCtxEvent::PublicIpv6RoutesUpdated(added, removed) => (added, removed), + _ => continue, + }; + + Self::apply_public_ipv6_route_changes( + &ifcfg, + &ifname, + &net_ns, + &mut cur_routes, + added, + removed, + ) + .await; + } + }); + + Ok(()) + } + + async fn run_public_ipv6_addr_updater(&mut self) -> Result<(), Error> { + let packet_plane = self.packet_plane.clone(); + let global_ctx = self.global_ctx.clone(); + let nic = self.nic.clone(); + let mut event_receiver = global_ctx.subscribe(); + + self.tasks.spawn(async move { + let mut current_addr = packet_plane.public_ipv6_addr().await; + if let Some(addr) = current_addr { + let nic = nic.lock().await; + if let Err(err) = nic.link_up().await { + tracing::warn!(?err, "failed to bring public ipv6 nic link up"); + } + if let Err(err) = nic.add_ipv6(addr.address(), addr.network_length() as i32).await { + tracing::warn!(addr = ?addr, ?err, "failed to add public ipv6 address"); + } + if let Err(err) = nic + .add_ipv6_route_with_cost(Ipv6Addr::UNSPECIFIED, 0, Some(5)) + .await + { + tracing::warn!(route = %Ipv6Addr::UNSPECIFIED, prefix = 0, ?err, "failed to add default public ipv6 route"); + } + } + + loop { + let event = match event_receiver.recv().await { + Ok(event) => event, + Err(tokio::sync::broadcast::error::RecvError::Closed) => break, + Err(tokio::sync::broadcast::error::RecvError::Lagged(_)) => { + event_receiver = event_receiver.resubscribe(); + let latest = packet_plane.public_ipv6_addr().await; + GlobalCtxEvent::PublicIpv6Changed(current_addr, latest) + } + }; + + let (old, new) = match event { + GlobalCtxEvent::PublicIpv6Changed(old, new) => (old, new), + _ => continue, + }; + + current_addr = new; + let nic = nic.lock().await; + if let Err(err) = nic.link_up().await { + tracing::warn!(?err, "failed to bring public ipv6 nic link up"); + } + if let Some(old) = old { + if let Err(err) = nic.remove_ipv6_route(Ipv6Addr::UNSPECIFIED, 0).await { + tracing::warn!(route = %Ipv6Addr::UNSPECIFIED, prefix = 0, ?err, "failed to remove default public ipv6 route"); + } + if let Err(err) = nic.remove_ipv6(Some(old)).await { + tracing::warn!(addr = ?old, ?err, "failed to remove old public ipv6 address"); + } + } + if let Some(new) = new { + if let Err(err) = nic.add_ipv6(new.address(), new.network_length() as i32).await + { + tracing::warn!(addr = ?new, ?err, "failed to add public ipv6 address"); + } + if let Err(err) = nic + .add_ipv6_route_with_cost(Ipv6Addr::UNSPECIFIED, 0, Some(5)) + .await + { + tracing::warn!(route = %Ipv6Addr::UNSPECIFIED, prefix = 0, ?err, "failed to add default public ipv6 route"); + } + } + } + }); + + Ok(()) + } + + pub async fn run( + &mut self, + ipv4_addr: Option, + ipv6_addr: Option, + ) -> Result<(), Error> { + let tunnel = { + let mut nic = self.nic.lock().await; + match nic.create_dev().await { + Ok(ret) => { + #[cfg(target_os = "windows")] + { + let dev_name = self.global_ctx.get_flags().dev_name; + let _ = RegistryManager::reg_change_catrgory_in_profile(&dev_name); + } + + #[cfg(any( + all(target_os = "macos", not(feature = "macos-ne")), + target_os = "freebsd" + ))] + { + // remove the 10.0.0.0/24 route (which is added by rust-tun by default) + let _ = nic + .ifcfg + .remove_ipv4_route(nic.ifname(), "10.0.0.0".parse().unwrap(), 24) + .await; + } + + self.global_ctx + .set_tun_device_ready(nic.ifname().to_string()); + ret + } + Err(err) => { + self.global_ctx.set_tun_device_error(err.to_string()); + return Err(err); + } + } + }; + + let (stream, sink) = tunnel.split(); + + self.do_forward_nic_to_peers_task(stream)?; + self.do_forward_peers_to_nic(sink); + + // Assign IPv4 address if provided + if let Some(ipv4_addr) = ipv4_addr { + self.assign_ipv4_to_tun_device(ipv4_addr).await?; + #[cfg(target_os = "windows")] + self.start_windows_udp_broadcast_relay(ipv4_addr); + } + + // Assign IPv6 address if provided + if let Some(ipv6_addr) = ipv6_addr { + self.assign_ipv6_to_tun_device(ipv6_addr).await?; + } + + self.run_proxy_cidrs_route_updater().await?; + self.run_public_ipv6_route_updater().await?; + // Keep the updater running so runtime config patches can enable auto mode + // without recreating the NIC. + self.run_public_ipv6_addr_updater().await?; + + Ok(()) + } + + #[cfg(mobile)] + pub async fn run_for_mobile(&mut self, tun_fd: std::os::fd::RawFd) -> Result<(), Error> { + let tunnel = { + let mut nic = self.nic.lock().await; + match nic.create_dev_for_mobile(tun_fd).await { + Ok(ret) => { + self.global_ctx + .set_tun_device_ready(nic.ifname().to_string()); + ret + } + Err(err) => { + self.global_ctx.set_tun_device_error(err.to_string()); + return Err(err); + } + } + }; + + let (stream, sink) = tunnel.split(); + + self.do_forward_nic_to_peers_task(stream)?; + self.do_forward_peers_to_nic(sink); + + Ok(()) + } +} + +#[cfg(test)] +mod tests { + use crate::common::{error::Error, global_ctx::tests::get_mock_global_ctx}; + + use super::VirtualNic; + + async fn run_test_helper() -> Result { + let mut dev = VirtualNic::new(get_mock_global_ctx()); + let _tunnel = dev.create_dev().await?; + + tokio::time::sleep(tokio::time::Duration::from_secs(1)).await; + + dev.link_up().await?; + dev.remove_ip(None).await?; + dev.add_ip("10.144.111.1".parse().unwrap(), 24).await?; + Ok(dev) + } + + #[tokio::test] + async fn tun_test() { + let _dev = run_test_helper().await.unwrap(); + + // let mut stream = nic.pin_recv_stream(); + // while let Some(item) = stream.next().await { + // println!("item: {:?}", item); + // } + + // let framed = dev.into_framed(); + // let (mut s, mut b) = framed.split(); + // loop { + // let tmp = b.next().await.unwrap().unwrap(); + // let tmp = EthernetPacket::new(tmp.get_bytes()); + // println!("ret: {:?}", tmp.unwrap()); + // } + } +} diff --git a/vendor/easytier/easytier/src/instance/windows_udp_broadcast.rs b/vendor/easytier/easytier/src/instance/windows_udp_broadcast.rs new file mode 100644 index 0000000..583a113 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/windows_udp_broadcast.rs @@ -0,0 +1,76 @@ +use std::net::Ipv4Addr; + +use easytier_core::gateway::udp_broadcast::PhysicalInterface; + +#[cfg(all(windows, feature = "tun"))] +mod runtime; +#[cfg(all(windows, feature = "tun"))] +pub(crate) use runtime::start; + +fn join_addr_equals(field: &str, addrs: &[Ipv4Addr]) -> String { + addrs + .iter() + .map(|addr| format!("{field} == {addr}")) + .collect::>() + .join(" or ") +} + +fn build_windivert_udp_filter(physical_interfaces: &[PhysicalInterface]) -> String { + let mut src_addrs = Vec::new(); + let mut directed_broadcasts = Vec::new(); + + for iface in physical_interfaces { + if !src_addrs.contains(&iface.address()) { + src_addrs.push(iface.address()); + } + if !directed_broadcasts.contains(&iface.directed_broadcast()) { + directed_broadcasts.push(iface.directed_broadcast()); + } + } + + if src_addrs.is_empty() { + return "false".to_owned(); + } + + let src_filter = join_addr_equals("ip.SrcAddr", &src_addrs); + let mut dst_filters = vec!["ip.DstAddr == 255.255.255.255".to_owned()]; + if !directed_broadcasts.is_empty() { + dst_filters.push(join_addr_equals("ip.DstAddr", &directed_broadcasts)); + } + dst_filters.push("(ip.DstAddr >= 224.0.0.0 and ip.DstAddr <= 239.255.255.255)".to_owned()); + + format!( + // Windows can report a local loopback copy of outgoing broadcasts as + // outbound too. Capture only the non-loopback copy; payload-based + // deduplication would also discard legitimate discovery retries. + "outbound and not loopback and ip and udp and ({}) and ({})", + src_filter, + dst_filters.join(" or ") + ) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn windows_udp_broadcast_windivert_filter_is_constrained() { + let interfaces = vec![ + PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(192, 168, 1, 7), 24).unwrap(), + PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(169, 254, 13, 10), 16).unwrap(), + PhysicalInterface::from_ip_and_prefix(Ipv4Addr::new(169, 254, 156, 121), 16).unwrap(), + ]; + + let filter = build_windivert_udp_filter(&interfaces); + + assert!(filter.starts_with("outbound and not loopback and ip and udp and ")); + assert!(filter.contains("ip.SrcAddr == 192.168.1.7")); + assert!(filter.contains("ip.SrcAddr == 169.254.13.10")); + assert!(filter.contains("ip.DstAddr == 255.255.255.255")); + assert!(filter.contains("ip.DstAddr == 192.168.1.255")); + assert!(filter.contains("ip.DstAddr == 169.254.255.255")); + assert!(filter.contains("ip.DstAddr >= 224.0.0.0")); + assert!(filter.contains("ip.DstAddr <= 239.255.255.255")); + assert_eq!(filter.matches("ip.DstAddr == 169.254.255.255").count(), 1); + } +} diff --git a/vendor/easytier/easytier/src/instance/windows_udp_broadcast/capture_raw.rs b/vendor/easytier/easytier/src/instance/windows_udp_broadcast/capture_raw.rs new file mode 100644 index 0000000..90758b0 --- /dev/null +++ b/vendor/easytier/easytier/src/instance/windows_udp_broadcast/capture_raw.rs @@ -0,0 +1,21 @@ +use super::{BroadcastRelayConfig, RawUdpCaptureSocket}; + +pub(super) struct CaptureSocket(RawUdpCaptureSocket); + +impl CaptureSocket { + pub(super) async fn recv(&mut self) -> std::io::Result<&[u8]> { + self.0.recv().await + } + + pub(super) fn backend_name(&self) -> &'static str { + "raw_socket" + } + + pub(super) fn fallback_to_raw(&mut self) -> anyhow::Result { + Ok(false) + } +} + +pub(super) fn open_capture_socket(_config: &BroadcastRelayConfig) -> anyhow::Result { + RawUdpCaptureSocket::open().map(CaptureSocket) +} diff --git a/vendor/easytier/easytier/src/instance/windows_udp_broadcast/capture_windivert.rs b/vendor/easytier/easytier/src/instance/windows_udp_broadcast/capture_windivert.rs new file mode 100644 index 0000000..ebb074a --- /dev/null +++ b/vendor/easytier/easytier/src/instance/windows_udp_broadcast/capture_windivert.rs @@ -0,0 +1,173 @@ +use std::{io, sync::Arc}; + +use anyhow::Context; +use windivert::{ + WinDivert, + error::WinDivertError, + layer, + packet::WinDivertPacket, + prelude::{WinDivertFlags, WinDivertShutdownMode}, +}; + +use super::{BroadcastRelayConfig, RawUdpCaptureSocket}; +use crate::instance::windows_udp_broadcast::build_windivert_udp_filter; + +struct WinDivertCaptureReader { + inner: std::cell::UnsafeCell>, +} + +unsafe impl Send for WinDivertCaptureReader {} +unsafe impl Sync for WinDivertCaptureReader {} + +impl WinDivertCaptureReader { + fn new(inner: WinDivert) -> Self { + Self { + inner: std::cell::UnsafeCell::new(inner), + } + } + + fn recv<'a>( + &self, + buffer: Option<&'a mut [u8]>, + ) -> Result, WinDivertError> { + let inner = unsafe { &*self.inner.get() }; + inner.recv(buffer) + } + + fn shutdown(&self) -> anyhow::Result<()> { + let inner = unsafe { &mut *self.inner.get() }; + inner + .shutdown(WinDivertShutdownMode::Recv) + .with_context(|| "WinDivert UDP broadcast capture shutdown failed")?; + Ok(()) + } + + fn close(&self) -> anyhow::Result<()> { + let inner = unsafe { &mut *self.inner.get() }; + inner + .close(windivert::CloseAction::Nothing) + .with_context(|| "WinDivert UDP broadcast capture close failed")?; + Ok(()) + } +} + +impl Drop for WinDivertCaptureReader { + fn drop(&mut self) { + if let Err(err) = self.close() { + tracing::error!(?err, "WinDivert UDP broadcast capture close failed"); + } + } +} + +pub(super) struct WinDivertCaptureSocket { + rx: tokio::sync::mpsc::Receiver>, + reader: Arc, + buf: Vec, +} + +impl WinDivertCaptureSocket { + const CHANNEL_CAPACITY: usize = 1024; + const MAX_PACKET_LEN: usize = 65_535; + + fn open(config: &BroadcastRelayConfig) -> anyhow::Result { + let filter = build_windivert_udp_filter(config.physical_interfaces()); + tracing::debug!( + filter = %filter, + "opening WinDivert UDP broadcast capture backend" + ); + + let flags = WinDivertFlags::default().set_sniff(); + let reader = WinDivert::network(&filter, 0, flags) + .map_err(io::Error::other) + .with_context(|| "failed to open WinDivert UDP broadcast capture")?; + let reader = Arc::new(WinDivertCaptureReader::new(reader)); + let reader_clone = reader.clone(); + let (tx, rx) = tokio::sync::mpsc::channel(Self::CHANNEL_CAPACITY); + + std::thread::Builder::new() + .name("easytier-udp-broadcast-windivert".to_owned()) + .spawn(move || { + let mut buffer = vec![0; Self::MAX_PACKET_LEN]; + loop { + match reader_clone.recv(Some(&mut buffer)) { + Ok(packet) => { + if tx.blocking_send(packet.data.to_vec()).is_err() { + break; + } + } + Err(err) => { + tracing::warn!(?err, "WinDivert UDP broadcast capture receive failed"); + break; + } + } + } + }) + .with_context(|| "failed to spawn WinDivert UDP broadcast capture thread")?; + + Ok(Self { + rx, + reader, + buf: Vec::new(), + }) + } + + async fn recv(&mut self) -> io::Result<&[u8]> { + self.buf = self.rx.recv().await.ok_or_else(|| { + io::Error::new( + io::ErrorKind::BrokenPipe, + "WinDivert UDP broadcast capture stopped", + ) + })?; + Ok(&self.buf) + } +} + +impl Drop for WinDivertCaptureSocket { + fn drop(&mut self) { + if let Err(err) = self.reader.shutdown() { + tracing::debug!(?err, "WinDivert UDP broadcast capture shutdown failed"); + } + } +} + +pub(super) enum CaptureSocket { + Raw(RawUdpCaptureSocket), + WinDivert(WinDivertCaptureSocket), +} + +impl CaptureSocket { + pub(super) async fn recv(&mut self) -> io::Result<&[u8]> { + match self { + Self::Raw(socket) => socket.recv().await, + Self::WinDivert(socket) => socket.recv().await, + } + } + + pub(super) fn backend_name(&self) -> &'static str { + match self { + Self::Raw(_) => "raw_socket", + Self::WinDivert(_) => "windivert", + } + } + + pub(super) fn fallback_to_raw(&mut self) -> anyhow::Result { + if matches!(self, Self::WinDivert(_)) { + *self = Self::Raw(RawUdpCaptureSocket::open()?); + return Ok(true); + } + Ok(false) + } +} + +pub(super) fn open_capture_socket(config: &BroadcastRelayConfig) -> anyhow::Result { + match WinDivertCaptureSocket::open(config) { + Ok(socket) => Ok(CaptureSocket::WinDivert(socket)), + Err(err) => { + tracing::warn!( + ?err, + "WinDivert UDP broadcast capture unavailable; falling back to raw socket" + ); + RawUdpCaptureSocket::open().map(CaptureSocket::Raw) + } + } +} diff --git a/vendor/easytier/easytier/src/instance/windows_udp_broadcast/runtime.rs b/vendor/easytier/easytier/src/instance/windows_udp_broadcast/runtime.rs new file mode 100644 index 0000000..59c32bc --- /dev/null +++ b/vendor/easytier/easytier/src/instance/windows_udp_broadcast/runtime.rs @@ -0,0 +1,362 @@ +use std::net::Ipv4Addr; + +use cidr::Ipv4Inet; +use easytier_core::gateway::udp_broadcast::PhysicalInterface; +use easytier_core::gateway::udp_broadcast::{ + BroadcastRelayConfig, NormalizedPacket, UdpBroadcastPacketRejection, UdpPacketSummary, + normalize_udp_broadcast_packet, +}; + +use { + crate::common::global_ctx::{ArcGlobalCtx, GlobalCtxEvent}, + anyhow::Context, + easytier_core::{ + gateway::udp_broadcast::UdpBroadcastRelayStats, host::packet::HostPacket, + instance::CorePacketPlane, + }, + network_interface::{Addr, NetworkInterface, NetworkInterfaceConfig}, + socket2::{Domain, Protocol, SockAddr, Socket, Type}, + std::{ + io, + net::{SocketAddrV4, UdpSocket as StdUdpSocket}, + sync::Arc, + }, + tokio_util::task::AbortOnDropHandle, +}; + +#[cfg(not(any(target_arch = "x86_64", target_arch = "x86")))] +#[path = "capture_raw.rs"] +mod capture; +#[cfg(any(target_arch = "x86_64", target_arch = "x86"))] +#[path = "capture_windivert.rs"] +mod capture; + +use capture::{CaptureSocket, open_capture_socket}; + +fn log_ignored_udp_packet(packet: &[u8], rejection: UdpBroadcastPacketRejection) { + let reason = rejection.reason(); + if let Some(summary) = UdpPacketSummary::parse(packet) { + tracing::debug!( + src = %summary.src, + dst = %summary.dst, + src_port = summary.src_port, + dst_port = summary.dst_port, + ip_len = summary.ip_len, + udp_len = summary.udp_len, + payload_len = summary.payload_len, + reason, + "ignored Windows UDP broadcast packet" + ); + } else { + tracing::debug!( + packet_len = packet.len(), + reason, + "ignored malformed Windows UDP raw packet" + ); + } +} + +fn log_normalized_udp_packet( + packet: &[u8], + config: &BroadcastRelayConfig, + normalized: &NormalizedPacket, +) { + let Some(summary) = UdpPacketSummary::parse(packet) else { + return; + }; + + tracing::debug!( + src = %summary.src, + dst = %summary.dst, + src_port = summary.src_port, + dst_port = summary.dst_port, + ip_len = summary.ip_len, + udp_len = summary.udp_len, + payload_len = summary.payload_len, + normalized_src = %config.virtual_ipv4().address(), + normalized_dst = %normalized.destination, + "normalized Windows UDP broadcast packet" + ); +} + +fn log_captured_udp_packet(packet: &[u8]) { + if let Some(summary) = UdpPacketSummary::parse(packet) { + tracing::debug!( + src = %summary.src, + dst = %summary.dst, + src_port = summary.src_port, + dst_port = summary.dst_port, + ip_len = summary.ip_len, + udp_len = summary.udp_len, + payload_len = summary.payload_len, + "captured Windows UDP broadcast candidate" + ); + } else { + tracing::debug!( + packet_len = packet.len(), + "captured malformed Windows UDP broadcast candidate" + ); + } +} + +fn collect_physical_interfaces(virtual_ipv4: Ipv4Inet) -> anyhow::Result> { + let mut ret = Vec::new(); + for iface in NetworkInterface::show().context("failed to list Windows network interfaces")? { + for addr in iface.addr { + let Addr::V4(v4) = addr else { + continue; + }; + let physical = match PhysicalInterface::from_observation( + v4.ip, + v4.netmask, + iface.internal, + virtual_ipv4.address(), + ) { + Ok(Some(physical)) => physical, + Ok(None) => continue, + Err(non_contiguous) => { + tracing::debug!( + iface = %iface.name, + ip = %v4.ip, + mask = %non_contiguous.netmask(), + "ignoring interface with non-contiguous IPv4 netmask" + ); + continue; + } + }; + ret.push(physical); + } + } + Ok(ret) +} + +fn open_raw_udp_socket() -> io::Result { + let socket = Socket::new(Domain::IPV4, Type::RAW, Some(Protocol::UDP))?; + // Match ubihazard/broadcast: use one raw UDP listener on loopback, then + // inspect the IPv4 header to identify the real physical source interface. + socket.bind(&SockAddr::from(SocketAddrV4::new(Ipv4Addr::LOCALHOST, 0)))?; + socket.set_nonblocking(true)?; + Ok(socket) +} + +fn socket2_into_udp_socket(socket: Socket) -> StdUdpSocket { + use std::os::windows::io::{FromRawSocket, IntoRawSocket}; + + // The raw socket handle came from socket2 and is transferred exactly once. + unsafe { StdUdpSocket::from_raw_socket(socket.into_raw_socket()) } +} + +struct RawUdpCaptureSocket { + socket: tokio::net::UdpSocket, + buf: Vec, +} + +impl RawUdpCaptureSocket { + const MAX_PACKET_LEN: usize = 65_535; + + fn open() -> anyhow::Result { + let socket = open_raw_udp_socket().with_context(|| { + "failed to open Windows raw UDP broadcast listener; administrator privileges are required" + })?; + let socket = socket2_into_udp_socket(socket); + let socket = tokio::net::UdpSocket::from_std(socket) + .context("failed to register Windows raw UDP broadcast listener with Tokio")?; + + Ok(Self { + socket, + buf: vec![0; Self::MAX_PACKET_LEN], + }) + } + + async fn recv(&mut self) -> io::Result<&[u8]> { + let len = self.socket.recv(&mut self.buf).await?; + Ok(&self.buf[..len]) + } +} + +fn issue_start_result_event( + global_ctx: &ArcGlobalCtx, + capture_backend: Option<&str>, + error: Option, +) { + global_ctx.issue_event(GlobalCtxEvent::UdpBroadcastRelayStartResult { + capture_backend: capture_backend.map(str::to_owned), + error, + }); +} + +async fn forward_normalized_packet( + packet_plane: &CorePacketPlane, + normalized: NormalizedPacket, + stats: &UdpBroadcastRelayStats, +) { + let ret = packet_plane + .send_local_ip_packet(HostPacket::copy_from_payload(&normalized.packet)) + .await; + + let summary = UdpPacketSummary::parse(&normalized.packet); + match ret { + Ok(_) => { + stats.record_forwarded(); + + if let Some(summary) = summary { + tracing::debug!( + src = %summary.src, + dst = %summary.dst, + src_port = summary.src_port, + dst_port = summary.dst_port, + ip_len = summary.ip_len, + udp_len = summary.udp_len, + payload_len = summary.payload_len, + peer_dst = %normalized.destination, + broadcast = true, + "forwarded Windows UDP broadcast packet" + ); + } else { + tracing::debug!( + packet_len = normalized.packet.len(), + peer_dst = %normalized.destination, + broadcast = true, + "forwarded Windows UDP broadcast packet" + ); + } + } + Err(err) => { + stats.record_forward_failed(); + + if let Some(summary) = summary { + tracing::debug!( + src = %summary.src, + dst = %summary.dst, + src_port = summary.src_port, + dst_port = summary.dst_port, + ip_len = summary.ip_len, + udp_len = summary.udp_len, + payload_len = summary.payload_len, + peer_dst = %normalized.destination, + broadcast = true, + ?err, + "failed to forward Windows UDP broadcast packet" + ); + } else { + tracing::debug!( + packet_len = normalized.packet.len(), + peer_dst = %normalized.destination, + broadcast = true, + ?err, + "failed to forward Windows UDP broadcast packet" + ); + } + } + } +} + +async fn capture_loop( + packet_plane: Arc, + config: BroadcastRelayConfig, + mut socket: CaptureSocket, + stats: UdpBroadcastRelayStats, +) { + let mut capture_backend = socket.backend_name(); + + loop { + let normalized = match socket.recv().await { + Ok(packet) => { + stats.record_captured(); + if tracing::enabled!(tracing::Level::DEBUG) { + log_captured_udp_packet(packet); + } + let normalized = match normalize_udp_broadcast_packet(packet, &config) { + Ok(normalized) => { + if tracing::enabled!(tracing::Level::DEBUG) { + log_normalized_udp_packet(packet, &config, &normalized); + } + Some(normalized) + } + Err(rejection) => { + if tracing::enabled!(tracing::Level::DEBUG) { + log_ignored_udp_packet(packet, rejection); + } + None + } + }; + if normalized.is_none() { + stats.record_ignored(); + } + normalized + } + Err(err) => { + tracing::warn!( + ?err, + capture_backend, + "Windows UDP broadcast capture receive failed" + ); + match socket.fallback_to_raw() { + Ok(true) => { + let old_backend = capture_backend; + capture_backend = socket.backend_name(); + tracing::warn!( + old_backend, + new_backend = capture_backend, + "Windows UDP broadcast capture backend fell back" + ); + } + Ok(false) => {} + Err(fallback_err) => { + tracing::error!( + ?fallback_err, + "Windows UDP broadcast raw socket fallback failed; stopping relay" + ); + break; + } + } + continue; + } + }; + + if let Some(normalized) = normalized { + forward_normalized_packet(&packet_plane, normalized, &stats).await; + } + } +} + +pub(crate) fn start( + packet_plane: Arc, + global_ctx: ArcGlobalCtx, + virtual_ipv4: Ipv4Inet, +) -> anyhow::Result> { + let physical_interfaces = match collect_physical_interfaces(virtual_ipv4) { + Ok(interfaces) => interfaces, + Err(err) => { + issue_start_result_event(&global_ctx, None, Some(format!("{err:#}"))); + return Err(err); + } + }; + let config = BroadcastRelayConfig::new(virtual_ipv4, physical_interfaces); + if config.physical_interfaces().is_empty() { + let msg = "no physical IPv4 interface is available for UDP broadcast relay"; + issue_start_result_event(&global_ctx, None, Some(msg.to_owned())); + anyhow::bail!(msg); + } + + let socket = match open_capture_socket(&config) { + Ok(socket) => socket, + Err(err) => { + issue_start_result_event(&global_ctx, None, Some(format!("{err:#}"))); + return Err(err); + } + }; + let capture_backend = socket.backend_name(); + issue_start_result_event(&global_ctx, Some(capture_backend), None); + + tracing::debug!( + virtual_ipv4 = %config.virtual_ipv4(), + physical_interfaces = ?config.physical_interfaces(), + capture_backend, + "starting Windows UDP broadcast relay" + ); + + let stats = packet_plane.udp_broadcast_relay_stats(); + let task = tokio::spawn(capture_loop(packet_plane, config, socket, stats)); + Ok(AbortOnDropHandle::new(task)) +} diff --git a/vendor/easytier/easytier/src/lib.rs b/vendor/easytier/easytier/src/lib.rs new file mode 100644 index 0000000..f782395 --- /dev/null +++ b/vendor/easytier/easytier/src/lib.rs @@ -0,0 +1,69 @@ +use std::io; + +use clap::Command; +use clap_complete::{Generator, Shell}; + +mod arch; +mod gateway; +mod host_runtime; +pub mod instance; +mod vpn_portal; + +pub mod common; +#[cfg(feature = "management")] +pub mod core; +#[cfg(feature = "upnp")] +pub(crate) mod igd_next; +pub mod proto; +#[cfg(feature = "management-rpc")] +pub mod rpc_service; +#[cfg(feature = "management")] +pub mod service_manager; +pub(crate) mod socket; +pub mod socket_protector; +pub mod tunnel; +pub mod utils; +#[cfg(feature = "web-client")] +pub mod web_client; + +#[cfg(test)] +mod tests; + +pub const VERSION: &str = common::constants::EASYTIER_VERSION; +rust_i18n::i18n!("locales", fallback = "en"); + +#[derive(clap::ValueEnum, Debug, Clone, PartialEq)] +pub enum ShellType { + Bash, + Elvish, + Fish, + Powershell, + Zsh, + Nu, +} + +impl ShellType { + pub fn to_shell(&self) -> Option { + match self { + ShellType::Bash => Some(Shell::Bash), + ShellType::Elvish => Some(Shell::Elvish), + ShellType::Fish => Some(Shell::Fish), + ShellType::Powershell => Some(Shell::PowerShell), + ShellType::Zsh => Some(Shell::Zsh), + ShellType::Nu => None, + } + } +} + +pub fn print_completions(generator: G, cmd: &mut Command, bin_name: &str) { + clap_complete::generate(generator, cmd, bin_name, &mut io::stdout()); +} + +pub fn print_nushell_completions(cmd: &mut Command, bin_name: &str) { + clap_complete::generate( + clap_complete_nushell::Nushell, + cmd, + bin_name, + &mut io::stdout(), + ); +} diff --git a/vendor/easytier/easytier/src/proto/mod.rs b/vendor/easytier/easytier/src/proto/mod.rs new file mode 100644 index 0000000..efe71fa --- /dev/null +++ b/vendor/easytier/easytier/src/proto/mod.rs @@ -0,0 +1,14 @@ +pub use easytier_proto::api; +#[cfg(feature = "web-client")] +pub use easytier_proto::web; +pub use easytier_proto::{ + ALL_DESCRIPTOR_BYTES, acl, common, core_config, error, peer_rpc, rpc_types, +}; + +#[cfg(feature = "magic-dns")] +pub use easytier_proto::magic_dns; + +#[cfg(test)] +pub mod tests; + +pub mod rpc; diff --git a/vendor/easytier/easytier/src/proto/rpc/mod.rs b/vendor/easytier/easytier/src/proto/rpc/mod.rs new file mode 100644 index 0000000..02c6940 --- /dev/null +++ b/vendor/easytier/easytier/src/proto/rpc/mod.rs @@ -0,0 +1,3 @@ +pub mod standalone; + +pub use easytier_core::rpc::{RpcController, bidirect, client, server, service_registry}; diff --git a/vendor/easytier/easytier/src/proto/rpc/standalone.rs b/vendor/easytier/easytier/src/proto/rpc/standalone.rs new file mode 100644 index 0000000..9341f04 --- /dev/null +++ b/vendor/easytier/easytier/src/proto/rpc/standalone.rs @@ -0,0 +1,117 @@ +use easytier_core::{ + connectivity::protocol::raw::{ + TcpTunnelDialer, TcpTunnelListener, TunnelDialer, UdpTunnelDialer, UdpTunnelListener, + }, + rpc::standalone::StandAloneClient, + socket::SocketListener, + socket::tcp::TcpBindOptions, + socket::udp::{UdpBindOptions, UdpSessionListenRequest}, + tunnel::Tunnel, +}; + +use crate::{ + host_runtime::{NativeHostRuntime, native_host_runtime}, + tunnel::TunnelUrl, +}; + +pub use easytier_core::rpc::standalone::{RpcServerHook, StandAloneServer}; + +pub type RuntimeRpcDialer = TcpTunnelDialer; +pub type RuntimeRpcListener = TcpTunnelListener; +pub type RuntimeRpcClient = StandAloneClient; + +pub fn runtime_rpc_dialer(remote_url: url::Url) -> RuntimeRpcDialer { + TcpTunnelDialer::new(remote_url, native_host_runtime(), native_host_runtime()) +} + +pub fn runtime_rpc_client(remote_url: url::Url) -> RuntimeRpcClient { + StandAloneClient::new(runtime_rpc_dialer(remote_url)) +} + +pub fn runtime_rpc_listener(local_addr: std::net::SocketAddr) -> RuntimeRpcListener { + // RPC clients may arrive through TUN; their replies must retain VPN routing. + let bind = TcpBindOptions::default() + .with_local_addr(Some(local_addr)) + .with_only_v6(true) + .with_need_protect(false); + TcpTunnelListener::new_with_bind(local_addr, bind, native_host_runtime()) +} + +pub fn runtime_udp_tunnel_dialer(remote_url: url::Url) -> impl TunnelDialer { + UdpTunnelDialer::new(remote_url, native_host_runtime(), native_host_runtime()) +} + +pub fn runtime_udp_tunnel_listener( + local_url: url::Url, + local_addr: std::net::SocketAddr, +) -> impl SocketListener> { + let bind = UdpBindOptions::port_bound_listener(local_addr) + .with_bind_device(TunnelUrl::from(local_url.clone()).bind_dev()) + .with_only_v6(true); + UdpTunnelListener::new_with_request( + local_url, + UdpSessionListenRequest::new(bind), + native_host_runtime(), + ) +} + +#[cfg(test)] +mod tests { + use easytier_core::{ + connectivity::protocol::raw::TunnelDialer as _, socket::SocketListener as _, + }; + + use crate::proto::rpc::standalone::{ + StandAloneServer, runtime_rpc_dialer, runtime_rpc_listener, runtime_udp_tunnel_dialer, + runtime_udp_tunnel_listener, + }; + + #[tokio::test] + async fn standalone_exit_on_drop() { + let addr = "0.0.0.0:53884".parse().unwrap(); + let tunnel = runtime_rpc_listener(addr); + let mut server = StandAloneServer::new(tunnel); + server.serve().await.unwrap(); + drop(server); + + // tcp should closed + let connector = runtime_rpc_dialer("tcp://0.0.0.0:53884".parse().unwrap()); + connector.connect().await.unwrap_err(); + } + + #[tokio::test] + async fn standalone_ipv4_and_ipv6_listeners_share_port() { + let mut ipv6 = runtime_rpc_listener("[::]:0".parse().unwrap()); + ipv6.listen().await.unwrap(); + let port = ipv6.local_url().port().unwrap(); + + let mut ipv4 = runtime_rpc_listener(format!("0.0.0.0:{port}").parse().unwrap()); + ipv4.listen().await.unwrap(); + } + + #[tokio::test] + async fn runtime_udp_tunnel_endpoints_connect() { + let local_url = "udp://127.0.0.1:0".parse().unwrap(); + let mut listener = runtime_udp_tunnel_listener(local_url, "127.0.0.1:0".parse().unwrap()); + listener.listen().await.unwrap(); + let listener_url = listener.local_url(); + let dialer = runtime_udp_tunnel_dialer(listener_url.clone()); + + let (accepted, connected) = + tokio::time::timeout(std::time::Duration::from_secs(5), async { + tokio::try_join!(listener.accept(), dialer.connect()) + }) + .await + .unwrap() + .unwrap(); + + assert_eq!( + accepted.info().unwrap().local_addr.unwrap().url, + listener_url.as_str() + ); + assert_eq!( + connected.info().unwrap().remote_addr.unwrap().url, + listener_url.as_str() + ); + } +} diff --git a/vendor/easytier/easytier/src/proto/tests.rs b/vendor/easytier/easytier/src/proto/tests.rs new file mode 100644 index 0000000..2c97b1c --- /dev/null +++ b/vendor/easytier/easytier/src/proto/tests.rs @@ -0,0 +1,449 @@ +pub use easytier_proto::tests::*; + +use std::sync::{Arc, Mutex}; + +use futures::StreamExt as _; +use tokio::task::JoinSet; + +use super::rpc::RpcController; + +#[derive(Clone, Default)] +struct GreetingJsonCallHandler; + +#[async_trait::async_trait] +impl crate::proto::rpc_types::handler::Handler for GreetingJsonCallHandler { + type Descriptor = GreetingDescriptor; + type Controller = crate::proto::rpc_types::controller::BaseController; + + async fn call( + &self, + _ctrl: Self::Controller, + method: ::Method, + input: bytes::Bytes, + ) -> crate::proto::rpc_types::error::Result { + use prost::Message; + match method { + GreetingMethodDescriptor::SayHello => { + let req = SayHelloRequest::decode(input)?; + let resp = SayHelloResponse { + greeting: format!("Hello {}!", req.name), + }; + Ok(bytes::Bytes::from(resp.encode_to_vec())) + } + GreetingMethodDescriptor::SayGoodbye => { + let req = SayGoodbyeRequest::decode(input)?; + let resp = SayGoodbyeResponse { + greeting: format!("Goodbye, {}!", req.name), + }; + Ok(bytes::Bytes::from(resp.encode_to_vec())) + } + } + } +} + +#[tokio::test] +async fn greeting_client_json_call_method_supports_snake_and_proto_method_name() { + let client = GreetingClient::new(GreetingJsonCallHandler); + + let snake = client + .json_call_method( + crate::proto::rpc_types::controller::BaseController::default(), + "say_hello", + serde_json::json!({"name": "world"}), + ) + .await + .unwrap(); + assert_eq!(snake["greeting"], serde_json::json!("Hello world!")); + + let proto = client + .json_call_method( + crate::proto::rpc_types::controller::BaseController::default(), + "SayHello", + serde_json::json!({"name": "world"}), + ) + .await + .unwrap(); + assert_eq!(proto["greeting"], serde_json::json!("Hello world!")); +} + +#[tokio::test] +async fn greeting_client_json_call_method_rejects_invalid_json() { + let client = GreetingClient::new(GreetingJsonCallHandler); + + let err = client + .json_call_method( + crate::proto::rpc_types::controller::BaseController::default(), + "say_hello", + serde_json::json!({"name": 123}), + ) + .await + .unwrap_err(); + assert!(matches!( + err, + crate::proto::rpc_types::error::Error::MalformatRpcPacket(_) + )); +} + +#[tokio::test] +async fn greeting_client_json_call_method_rejects_unknown_method() { + let client = GreetingClient::new(GreetingJsonCallHandler); + + let err = client + .json_call_method( + crate::proto::rpc_types::controller::BaseController::default(), + "not_exist_method", + serde_json::json!({"name": "world"}), + ) + .await + .unwrap_err(); + assert!(matches!( + err, + crate::proto::rpc_types::error::Error::InvalidMethodIndex(0, _) + )); +} + +#[derive(Clone)] +pub struct GreetingService { + pub delay_ms: u64, + pub prefix: String, +} + +#[async_trait::async_trait] +impl Greeting for GreetingService { + type Controller = RpcController; + async fn say_hello( + &self, + _ctrl: Self::Controller, + input: SayHelloRequest, + ) -> crate::proto::rpc_types::error::Result { + let resp = SayHelloResponse { + greeting: format!("{} {}!", self.prefix, input.name), + }; + tokio::time::sleep(std::time::Duration::from_millis(self.delay_ms)).await; + Ok(resp) + } + /// Generates a "goodbye" greeting based on the supplied info. + async fn say_goodbye( + &self, + _ctrl: Self::Controller, + input: SayGoodbyeRequest, + ) -> crate::proto::rpc_types::error::Result { + let resp = SayGoodbyeResponse { + greeting: format!("Goodbye, {}!", input.name), + }; + tokio::time::sleep(std::time::Duration::from_millis(self.delay_ms)).await; + Ok(resp) + } +} + +use crate::proto::common::{CompressionAlgoPb, RpcCompressionInfo}; +use crate::proto::rpc::client::Client; +use crate::proto::rpc::server::Server; + +struct TestContext { + client: Client, + server: Server, + _tasks: Arc>>, +} + +impl TestContext { + fn new() -> Self { + let rpc_server = Server::new(); + rpc_server.run(); + + let client = Client::new(); + client.run(); + + let tasks = Arc::new(Mutex::new(JoinSet::new())); + let (mut rx, tx) = ( + rpc_server.get_transport_stream(), + client.get_transport_sink(), + ); + + tasks.lock().unwrap().spawn(async move { + while let Some(Ok(packet)) = rx.next().await { + if let Err(err) = tx.send(packet).await { + println!("{:?}", err); + break; + } + } + }); + + let (mut rx, tx) = ( + client.get_transport_stream(), + rpc_server.get_transport_sink(), + ); + tasks.lock().unwrap().spawn(async move { + while let Some(Ok(packet)) = rx.next().await { + if let Err(err) = tx.send(packet).await { + println!("{:?}", err); + break; + } + } + }); + + Self { + client, + server: rpc_server, + _tasks: tasks, + } + } +} + +fn random_string(len: usize) -> String { + use rand::Rng; + use rand::distributions::Alphanumeric; + let mut rng = rand::thread_rng(); + let s: Vec = std::iter::repeat(()) + .map(|()| rng.sample(Alphanumeric)) + .take(len) + .collect(); + String::from_utf8(s).unwrap() +} + +#[tokio::test] +async fn rpc_basic_test() { + // enable_log(); + let ctx = TestContext::new(); + + let server = GreetingServer::new(GreetingService { + delay_ms: 0, + prefix: "Hello".to_string(), + }); + ctx.server.registry().register(server, ""); + + let out = ctx + .client + .scoped_client::>(1, 1, "".to_string()); + + // // small size req and resp + + let ctrl = RpcController::default(); + let input = SayHelloRequest { + name: "world".to_string(), + }; + let ret = out.say_hello(ctrl, input).await; + assert_eq!(ret.unwrap().greeting, "Hello world!"); + + assert_eq!(1, ctx.client.peer_info_table().len()); + let first_peer_info = ctx.client.peer_info_table().iter().next().unwrap().clone(); + assert_eq!( + first_peer_info.compression_info.accepted_algo(), + CompressionAlgoPb::Zstd, + ); + + println!("{:?}", ctx.client.peer_info_table()); + + let ctrl = RpcController::default(); + let input = SayGoodbyeRequest { + name: "world".to_string(), + }; + let ret = out.say_goodbye(ctrl, input).await; + assert_eq!(ret.unwrap().greeting, "Goodbye, world!"); + + // large size req and resp + let ctrl = RpcController::default(); + let name = random_string(20 * 1024 * 1024); + let input = SayGoodbyeRequest { name: name.clone() }; + let ret = out.say_goodbye(ctrl, input).await; + assert_eq!(ret.unwrap().greeting, format!("Goodbye, {}!", name)); + + assert_eq!(0, ctx.client.inflight_count()); + assert_eq!(0, ctx.server.inflight_count()); + + let first_peer_info = ctx.client.peer_info_table().iter().next().unwrap().clone(); + assert_eq!( + first_peer_info.compression_info, + RpcCompressionInfo { + algo: CompressionAlgoPb::Zstd.into(), + accepted_algo: CompressionAlgoPb::Zstd.into(), + } + ); +} + +#[tokio::test] +async fn rpc_timeout_test() { + let ctx = TestContext::new(); + + let server = GreetingServer::new(GreetingService { + delay_ms: 10000, + prefix: "Hello".to_string(), + }); + ctx.server.registry().register(server, "test"); + + let out = ctx + .client + .scoped_client::>(1, 1, "test".to_string()); + + let ctrl = RpcController::default(); + let input = SayHelloRequest { + name: "world".to_string(), + }; + let ret = out.say_hello(ctrl, input).await; + assert!(ret.is_err()); + assert!(matches!( + ret.unwrap_err(), + crate::proto::rpc_types::error::Error::Timeout(_) + )); + + assert_eq!(0, ctx.client.inflight_count()); + assert_eq!(0, ctx.server.inflight_count()); +} + +#[tokio::test] +async fn rpc_tunnel_stuck_test() { + use crate::proto::rpc_types; + use easytier_core::tunnel::ring::RING_TUNNEL_CAP; + + let rpc_server = Server::new(); + rpc_server.run(); + let server = GreetingServer::new(GreetingService { + delay_ms: 0, + prefix: "Hello".to_string(), + }); + rpc_server.registry().register(server, "test"); + + let client = Client::new(); + client.run(); + + let rpc_tasks = Arc::new(Mutex::new(JoinSet::new())); + let (mut rx, tx) = ( + rpc_server.get_transport_stream(), + client.get_transport_sink(), + ); + + rpc_tasks.lock().unwrap().spawn(async move { + while let Some(Ok(packet)) = rx.next().await { + if let Err(err) = tx.send(packet).await { + println!("{:?}", err); + break; + } + } + }); + + // mock server is stuck (no task to do forwards) + + let mut tasks = JoinSet::new(); + for _ in 0..RING_TUNNEL_CAP + 15 { + let out = + client.scoped_client::>(1, 1, "test".to_string()); + tasks.spawn(async move { + let ctrl = RpcController { + timeout_ms: 1000, + ..Default::default() + }; + + let input = SayHelloRequest { + name: "world".to_string(), + }; + + out.say_hello(ctrl, input).await + }); + } + while let Some(ret) = tasks.join_next().await { + assert!(matches!(ret, Ok(Err(rpc_types::error::Error::Timeout(_))))); + } + + // start server consumer, new requests should be processed + let (mut rx, tx) = ( + client.get_transport_stream(), + rpc_server.get_transport_sink(), + ); + rpc_tasks.lock().unwrap().spawn(async move { + while let Some(Ok(packet)) = rx.next().await { + if let Err(err) = tx.send(packet).await { + println!("{:?}", err); + break; + } + } + }); + + let out = + client.scoped_client::>(1, 1, "test".to_string()); + let ctrl = RpcController { + timeout_ms: 1000, + ..Default::default() + }; + let input = SayHelloRequest { + name: "fuck world".to_string(), + }; + let ret = out.say_hello(ctrl, input).await.unwrap(); + assert_eq!(ret.greeting, "Hello fuck world!"); +} + +#[tokio::test] +async fn test_bidirect_rpc_manager() { + use crate::proto::rpc::bidirect::BidirectRpcManager; + use crate::proto::rpc::standalone::{runtime_rpc_dialer, runtime_rpc_listener}; + use easytier_core::{connectivity::protocol::raw::TunnelDialer, socket::SocketListener}; + use tokio::sync::Notify; + use tokio_util::task::AbortOnDropHandle; + + let c = BidirectRpcManager::new(); + let s = BidirectRpcManager::new(); + + let service = GreetingServer::new(GreetingService { + delay_ms: 0, + prefix: "Hello Client".to_string(), + }); + c.rpc_server().registry().register(service, "test"); + + let service = GreetingServer::new(GreetingService { + delay_ms: 0, + prefix: "Hello Server".to_string(), + }); + s.rpc_server().registry().register(service, "test"); + + let server_test_done = Arc::new(Notify::new()); + let server_test_done_clone = server_test_done.clone(); + let mut tcp_listener = runtime_rpc_listener("0.0.0.0:55443".parse().unwrap()); + let s_task = AbortOnDropHandle::new(tokio::spawn(async move { + tcp_listener.listen().await.unwrap(); + let tunnel = tcp_listener.accept().await.unwrap(); + s.run_with_tunnel(tunnel); + + let s_c = s + .rpc_client() + .scoped_client::>(1, 1, "test".to_string()); + let ret = s_c + .say_hello( + RpcController::default(), + SayHelloRequest { + name: "world".to_string(), + }, + ) + .await + .unwrap(); + assert_eq!(ret.greeting, "Hello Client world!"); + println!("server done, {:?}", ret); + + server_test_done_clone.notify_one(); + + s.wait().await; + })); + + tokio::time::sleep(std::time::Duration::from_secs(1)).await; + + let tcp_connector = runtime_rpc_dialer("tcp://0.0.0.0:55443".parse().unwrap()); + let c_tunnel = tcp_connector.connect().await.unwrap(); + c.run_with_tunnel(c_tunnel); + + let c_c = c + .rpc_client() + .scoped_client::>(1, 1, "test".to_string()); + let ret = c_c + .say_hello( + RpcController::default(), + SayHelloRequest { + name: "world".to_string(), + }, + ) + .await + .unwrap(); + assert_eq!(ret.greeting, "Hello Server world!"); + println!("client done, {:?}", ret); + + server_test_done.notified().await; + drop(c); + s_task.await.unwrap(); +} diff --git a/vendor/easytier/easytier/src/rpc_service/api.rs b/vendor/easytier/easytier/src/rpc_service/api.rs new file mode 100644 index 0000000..cb732e8 --- /dev/null +++ b/vendor/easytier/easytier/src/rpc_service/api.rs @@ -0,0 +1,241 @@ +use std::{net::SocketAddr, sync::Arc}; + +use anyhow::Context; +use cidr::IpCidr; +#[cfg(feature = "management")] +use easytier_core::management::ManagementServer; +use easytier_core::{management::ReadOnlyManagementServer, socket::SocketListener, tunnel::Tunnel}; + +#[cfg(feature = "management")] +use crate::{ + instance::config_storage::NativeConfigFileStorage, rpc_service::logger::NativeLoggerControl, + web_client::DefaultHooks, +}; +use crate::{ + instance::factory::NativeInstanceManager, + proto::{ + rpc::standalone::{RuntimeRpcListener, runtime_rpc_listener}, + rpc_types::error::Error, + }, +}; + +#[cfg(feature = "management")] +pub struct ApiRpcServer +where + T: SocketListener> + 'static, +{ + rpc_server: ManagementServer, +} + +#[cfg(feature = "management")] +impl ApiRpcServer { + pub fn new( + rpc_portal: Option, + rpc_portal_whitelist: Option>, + instance_manager: Arc, + ) -> anyhow::Result { + let rpc_addr = parse_rpc_portal(rpc_portal)?; + let mut server = Self::from_tunnel(runtime_rpc_listener(rpc_addr), instance_manager); + server.rpc_server.set_whitelist(rpc_portal_whitelist); + + Ok(server) + } +} + +#[cfg(feature = "management")] +impl ApiRpcServer +where + T: SocketListener> + 'static, +{ + pub fn from_tunnel(tunnel: T, instance_manager: Arc) -> Self { + let rpc_server = ManagementServer::new( + tunnel, + instance_manager, + Arc::new(DefaultHooks), + Arc::new(NativeConfigFileStorage), + Arc::new(NativeLoggerControl), + ); + Self { rpc_server } + } +} + +#[cfg(feature = "management")] +impl ApiRpcServer +where + T: SocketListener> + 'static, +{ + pub async fn serve(mut self) -> Result { + self.rpc_server.serve().await?; + Ok(self) + } + + pub fn with_rx_timeout(mut self, timeout: Option) -> Self { + self.rpc_server.set_rx_timeout(timeout); + self + } +} + +pub struct ReadOnlyApiRpcServer +where + T: SocketListener> + 'static, +{ + rpc_server: ReadOnlyManagementServer, +} + +impl ReadOnlyApiRpcServer { + pub fn new( + rpc_portal: Option, + rpc_portal_whitelist: Option>, + instance_manager: Arc, + ) -> anyhow::Result { + let rpc_addr = parse_rpc_portal(rpc_portal)?; + let mut server = Self::from_tunnel(runtime_rpc_listener(rpc_addr), instance_manager); + server.rpc_server.set_whitelist(rpc_portal_whitelist); + Ok(server) + } +} + +impl ReadOnlyApiRpcServer +where + T: SocketListener> + 'static, +{ + pub fn from_tunnel(tunnel: T, instance_manager: Arc) -> Self { + Self { + rpc_server: ReadOnlyManagementServer::new(tunnel, instance_manager), + } + } + + pub async fn serve(mut self) -> Result { + self.rpc_server.serve().await?; + Ok(self) + } + + pub fn with_rx_timeout(mut self, timeout: Option) -> Self { + self.rpc_server.set_rx_timeout(timeout); + self + } +} + +fn parse_rpc_portal(rpc_portal: Option) -> anyhow::Result { + let mut rpc_addr = if let Some(Ok(port)) = rpc_portal.as_ref().map(|s| s.parse::()) { + Some(SocketAddr::from(([0, 0, 0, 0], port))) + } else { + rpc_portal + .map(|addr| { + addr.parse::() + .context("failed to parse rpc portal address") + }) + .transpose()? + }; + select_proper_rpc_port(&mut rpc_addr)?; + rpc_addr.ok_or_else(|| anyhow::anyhow!("failed to parse rpc portal address")) +} + +fn select_proper_rpc_port(addr: &mut Option) -> anyhow::Result<()> { + match addr { + None => { + *addr = Some(SocketAddr::from(([0, 0, 0, 0], 0))); + select_proper_rpc_port(addr)?; + Ok(()) + } + Some(addr) => { + if addr.port() == 0 { + let Some(port) = crate::utils::find_free_tcp_port(15888..15900) else { + tracing::warn!( + "No free port found for RPC portal, skipping setting RPC portal" + ); + return Err(anyhow::anyhow!("No free port found for RPC portal")); + }; + addr.set_port(port); + } + Ok(()) + } + } +} + +#[cfg(all(test, feature = "management"))] +mod tests { + use std::{fmt, sync::Arc, time::Duration}; + + use easytier_core::{ + rpc::bidirect::BidirectRpcManager, + socket::SocketListener, + tunnel::{Tunnel, ring::create_ring_tunnel_pair}, + }; + use tokio::sync::mpsc; + + use crate::{ + instance::factory::native_instance_manager, + proto::{ + api::logger::{GetLoggerConfigRequest, LoggerRpc, LoggerRpcClientFactory}, + rpc_types::controller::BaseController, + }, + }; + + use super::{ApiRpcServer, parse_rpc_portal}; + + #[test] + fn zero_rpc_portal_is_resolved_before_listener_binding() { + assert_ne!(parse_rpc_portal(Some("0".to_owned())).unwrap().port(), 0); + } + + struct RingListener { + accepted: mpsc::Receiver>, + } + + impl fmt::Debug for RingListener { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter.debug_struct("RingListener").finish() + } + } + + #[async_trait::async_trait] + impl SocketListener for RingListener { + type Accepted = Box; + + async fn listen(&mut self) -> anyhow::Result<()> { + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + self.accepted + .recv() + .await + .ok_or_else(|| anyhow::anyhow!("ring test listener closed")) + } + + fn local_url(&self) -> url::Url { + "ring://management-test".parse().unwrap() + } + } + + #[tokio::test] + async fn trusted_ring_management_transport_does_not_require_an_ip_host() { + let (client_tunnel, server_tunnel) = create_ring_tunnel_pair(); + let (accepted, receiver) = mpsc::channel(1); + accepted.send(server_tunnel).await.unwrap(); + let server = ApiRpcServer::from_tunnel( + RingListener { accepted: receiver }, + Arc::new(native_instance_manager()), + ) + .with_rx_timeout(Some(Duration::from_secs(1))) + .serve() + .await + .unwrap(); + let client = BidirectRpcManager::new().set_rx_timeout(Some(Duration::from_secs(1))); + client.run_with_tunnel(client_tunnel); + let logger = client + .rpc_client() + .scoped_client::>(1, 1, String::new()); + + tokio::time::timeout( + Duration::from_secs(1), + logger.get_logger_config(BaseController::default(), GetLoggerConfigRequest::default()), + ) + .await + .unwrap() + .unwrap(); + + drop(server); + } +} diff --git a/vendor/easytier/easytier/src/rpc_service/logger.rs b/vendor/easytier/easytier/src/rpc_service/logger.rs new file mode 100644 index 0000000..a0badc8 --- /dev/null +++ b/vendor/easytier/easytier/src/rpc_service/logger.rs @@ -0,0 +1,14 @@ +use easytier_core::management::LoggerControl; + +#[derive(Clone, Default)] +pub struct NativeLoggerControl; + +impl LoggerControl for NativeLoggerControl { + fn set_level(&self, level: &str) -> anyhow::Result<()> { + crate::common::log::set_file_level(level) + } + + fn level(&self) -> String { + crate::common::log::file_level() + } +} diff --git a/vendor/easytier/easytier/src/rpc_service/mod.rs b/vendor/easytier/easytier/src/rpc_service/mod.rs new file mode 100644 index 0000000..5a79dbb --- /dev/null +++ b/vendor/easytier/easytier/src/rpc_service/mod.rs @@ -0,0 +1,9 @@ +pub mod api; +#[cfg(feature = "management")] +pub mod logger; +#[cfg(feature = "management")] +pub use easytier_core::management::remote_client; + +#[cfg(feature = "management")] +pub type ApiRpcServer = self::api::ApiRpcServer; +pub type ReadOnlyApiRpcServer = self::api::ReadOnlyApiRpcServer; diff --git a/vendor/easytier/easytier/src/service_manager/mod.rs b/vendor/easytier/easytier/src/service_manager/mod.rs new file mode 100644 index 0000000..9bb4866 --- /dev/null +++ b/vendor/easytier/easytier/src/service_manager/mod.rs @@ -0,0 +1,597 @@ +use std::ffi::OsString; +use std::fmt::Write; +use std::path::PathBuf; + +use service_manager::ServiceManager as _; + +use crate::common::log; + +#[derive(Debug)] +pub struct ServiceInstallOptions { + pub program: PathBuf, + pub args: Vec, + pub work_directory: PathBuf, + pub environment: Option>, + pub disable_autostart: bool, + pub description: Option, + pub display_name: Option, + pub disable_restart_on_failure: bool, +} + +pub type ServiceStatus = service_manager::ServiceStatus; + +trait ServiceManager: service_manager::ServiceManager { + fn update(&self, ctx: service_manager::ServiceInstallCtx) -> std::io::Result<()>; +} +impl ServiceManager for service_manager::TypedServiceManager { + fn update(&self, ctx: service_manager::ServiceInstallCtx) -> std::io::Result<()> { + let status = self.status(service_manager::ServiceStatusCtx { + label: ctx.label.clone(), + })?; + if status == ServiceStatus::Running { + self.stop(service_manager::ServiceStopCtx { + label: ctx.label.clone(), + })?; + } + if status != ServiceStatus::NotInstalled { + self.uninstall(service_manager::ServiceUninstallCtx { + label: ctx.label.clone(), + })?; + } + self.install(ctx) + } +} + +pub struct Service { + label: service_manager::ServiceLabel, + kind: service_manager::ServiceManagerKind, + service_manager: Box, +} + +impl Service { + pub fn new(name: String) -> Result { + #[cfg(target_os = "windows")] + let service_manager = Box::new(self::win_service_manager::WinServiceManager::new()?); + #[cfg(all(target_os = "macos", not(feature = "macos-ne")))] + let service_manager: Box = + Box::new(service_manager::TypedServiceManager::Launchd( + service_manager::LaunchdServiceManager::system().with_config( + service_manager::LaunchdConfig { + install: service_manager::LaunchdInstallConfig { + keep_alive: service_manager::KeepAlive::conditions() + .crashed(true) + .successful_exit(false), + }, + }, + ), + )); + + #[cfg(not(any( + target_os = "windows", + all(target_os = "macos", not(feature = "macos-ne")) + )))] + let service_manager: Box = + Box::new(service_manager::TypedServiceManager::native()?); + + let kind = service_manager::ServiceManagerKind::native()?; + + log::info!("service manager kind: {:?}", kind); + + Ok(Self { + label: name.parse()?, + kind, + service_manager, + }) + } + + pub fn install(&self, options: &ServiceInstallOptions) -> Result<(), anyhow::Error> { + let ctx = service_manager::ServiceInstallCtx { + label: self.label.clone(), + program: options.program.clone(), + args: options.args.clone(), + contents: self.make_install_content_option(options), + autostart: !options.disable_autostart, + username: None, + working_directory: Some(options.work_directory.clone()), + environment: options.environment.clone(), + disable_restart_on_failure: options.disable_restart_on_failure, + }; + + if self.status()? != service_manager::ServiceStatus::NotInstalled { + self.service_manager + .update(ctx) + .map_err(|e| anyhow::anyhow!("failed to update service: {:?}", e))?; + log::info!("Service updated successfully! Service Name: {}", self.label); + return Ok(()); + } + + self.service_manager + .install(ctx) + .map_err(|e| anyhow::anyhow!("failed to install service: {:?}", e))?; + + log::info!( + "Service installed successfully! Service Name: {}", + self.label + ); + + Ok(()) + } + + pub fn uninstall(&self) -> Result<(), anyhow::Error> { + let ctx = service_manager::ServiceUninstallCtx { + label: self.label.clone(), + }; + let status = self.status()?; + + if status == service_manager::ServiceStatus::NotInstalled { + return Err(anyhow::anyhow!("Service is not installed")); + } + + if status == service_manager::ServiceStatus::Running { + self.service_manager.stop(service_manager::ServiceStopCtx { + label: self.label.clone(), + })?; + } + + self.service_manager + .uninstall(ctx) + .map_err(|e| anyhow::anyhow!("failed to uninstall service: {}", e)) + } + + pub fn status(&self) -> Result { + let ctx = service_manager::ServiceStatusCtx { + label: self.label.clone(), + }; + let status = self.service_manager.status(ctx)?; + + Ok(status) + } + + pub fn start(&self) -> Result<(), anyhow::Error> { + let ctx = service_manager::ServiceStartCtx { + label: self.label.clone(), + }; + let status = self.status()?; + + match status { + service_manager::ServiceStatus::Running => { + Err(anyhow::anyhow!("Service is already running"))? + } + service_manager::ServiceStatus::Stopped(_) => { + self.service_manager + .start(ctx) + .map_err(|e| anyhow::anyhow!("failed to start service: {}", e))?; + Ok(()) + } + service_manager::ServiceStatus::NotInstalled => { + Err(anyhow::anyhow!("Service is not installed"))? + } + } + } + + pub fn stop(&self) -> Result<(), anyhow::Error> { + let ctx = service_manager::ServiceStopCtx { + label: self.label.clone(), + }; + let status = self.status()?; + + match status { + service_manager::ServiceStatus::Running => { + self.service_manager + .stop(ctx) + .map_err(|e| anyhow::anyhow!("failed to stop service: {}", e))?; + Ok(()) + } + service_manager::ServiceStatus::Stopped(_) => { + Err(anyhow::anyhow!("Service is already stopped"))? + } + service_manager::ServiceStatus::NotInstalled => { + Err(anyhow::anyhow!("Service is not installed"))? + } + } + } + + fn make_install_content_option(&self, options: &ServiceInstallOptions) -> Option { + match self.kind { + service_manager::ServiceManagerKind::Systemd => { + Some(self.make_systemd_unit(options).unwrap()) + } + service_manager::ServiceManagerKind::Rcd => { + Some(self.make_rcd_script(options).unwrap()) + } + service_manager::ServiceManagerKind::OpenRc => { + Some(self.make_open_rc_script(options).unwrap()) + } + service_manager::ServiceManagerKind::Launchd => { + None // 使用 service-manager-rs 的默认 plist 生成 + } + _ => { + #[cfg(target_os = "windows")] + { + let win_options = self::win_service_manager::WinServiceInstallOptions { + description: options.description.clone(), + display_name: options.display_name.clone(), + dependencies: Some(vec!["rpcss".to_string(), "dnscache".to_string()]), + }; + + Some(serde_json::to_string(&win_options).unwrap()) + } + + #[cfg(not(target_os = "windows"))] + None + } + } + } + + fn make_systemd_unit( + &self, + options: &ServiceInstallOptions, + ) -> Result { + let args = options + .args + .iter() + .map(|a| a.to_string_lossy()) + .collect::>() + .join(" "); + let target_app = options.program.display().to_string(); + let work_dir = options.work_directory.display().to_string(); + let mut unit_content = String::new(); + + writeln!(unit_content, "[Unit]")?; + writeln!(unit_content, "After=network.target syslog.target")?; + if let Some(ref d) = options.description { + writeln!(unit_content, "Description={d}")?; + } + writeln!(unit_content, "StartLimitIntervalSec=0")?; + writeln!(unit_content)?; + writeln!(unit_content, "[Service]")?; + writeln!(unit_content, "Type=simple")?; + writeln!(unit_content, "WorkingDirectory={work_dir}")?; + writeln!(unit_content, "ExecStart={target_app} {args}")?; + writeln!(unit_content, "Restart=always")?; + writeln!(unit_content, "RestartSec=1")?; + writeln!(unit_content, "LimitNOFILE=infinity")?; + writeln!(unit_content)?; + writeln!(unit_content, "[Install]")?; + writeln!(unit_content, "WantedBy=multi-user.target")?; + + std::result::Result::Ok(unit_content) + } + + fn make_rcd_script(&self, options: &ServiceInstallOptions) -> Result { + let name = self.label.to_qualified_name(); + let args = options + .args + .iter() + .map(|a| a.to_string_lossy()) + .collect::>() + .join(" "); + let target_app = options.program.display().to_string(); + let work_dir = options.work_directory.display().to_string(); + let mut script = String::new(); + + writeln!(script, "#!/bin/sh")?; + writeln!(script, "#")?; + writeln!(script, "# PROVIDE: {name}")?; + writeln!(script, "# REQUIRE: LOGIN FILESYSTEMS NETWORKING ")?; + writeln!(script, "# KEYWORD: shutdown")?; + writeln!(script)?; + writeln!(script, ". /etc/rc.subr")?; + writeln!(script)?; + writeln!(script, "name=\"{name}\"")?; + if let Some(ref d) = options.description { + writeln!(script, "desc=\"{d}\"")?; + } + writeln!(script, "rcvar=\"{name}_enable\"")?; + writeln!(script)?; + writeln!(script, "load_rc_config ${{name}}")?; + writeln!(script)?; + writeln!(script, ": ${{{name}_options=\"{args}\"}}")?; + writeln!(script)?; + writeln!(script, "{name}_chdir=\"{work_dir}\"")?; + writeln!(script, "pidfile=\"/var/run/${{name}}.pid\"")?; + writeln!(script, "procname=\"{target_app}\"")?; + writeln!(script, "command=\"/usr/sbin/daemon\"")?; + writeln!( + script, + "command_args=\"-c -S -T ${{name}} -p ${{pidfile}} ${{procname}} ${{{name}_options}}\"" + )?; + writeln!(script)?; + writeln!(script, "run_rc_command \"$1\"")?; + + std::result::Result::Ok(script) + } + + fn make_open_rc_script( + &self, + options: &ServiceInstallOptions, + ) -> Result { + let args = options + .args + .iter() + .map(|a| a.to_string_lossy()) + .collect::>() + .join(" "); + let target_app = options.program.display().to_string(); + let work_dir = options.work_directory.display().to_string(); + let mut script = String::new(); + + writeln!(script, "#!/sbin/openrc-run")?; + writeln!(script)?; + if let Some(ref d) = options.description { + writeln!(script, "description=\"{d}\"")?; + } + writeln!(script, "command=\"{target_app}\"")?; + writeln!(script, "command_args=\"{args}\"")?; + writeln!(script, "pidfile=\"/run/${{RC_SVCNAME}}.pid\"")?; + writeln!(script, "command_background=\"yes\"")?; + writeln!(script, "directory=\"{work_dir}\"")?; + writeln!(script)?; + writeln!(script, "depend() {{")?; + writeln!(script, " need net")?; + writeln!(script, " use looger")?; + writeln!(script, "}}")?; + + std::result::Result::Ok(script) + } +} + +#[cfg(target_os = "windows")] +mod win_service_manager { + use std::{ffi::OsStr, ffi::OsString, io, path::PathBuf, time::Duration}; + use windows_service::{ + service::{ + Service, ServiceAccess, ServiceAction, ServiceActionType, ServiceDependency, + ServiceErrorControl, ServiceFailureActions, ServiceFailureResetPeriod, ServiceInfo, + ServiceStartType, ServiceType, + }, + service_manager::{ServiceManager, ServiceManagerAccess}, + }; + + use service_manager::{ + ServiceInstallCtx, ServiceLevel, ServiceStartCtx, ServiceStatus, ServiceStatusCtx, + ServiceStopCtx, ServiceUninstallCtx, + }; + + use winreg::{RegKey, enums::*}; + + use crate::common::constants::WIN_SERVICE_WORK_DIR_REG_KEY; + + use serde::{Deserialize, Serialize}; + + #[derive(Serialize, Deserialize)] + pub struct WinServiceInstallOptions { + pub dependencies: Option>, + pub description: Option, + pub display_name: Option, + } + + pub struct WinServiceManager { + service_manager: ServiceManager, + } + + fn generate_service_info(ctx: &ServiceInstallCtx) -> (ServiceInfo, Option) { + let start_type = if ctx.autostart { + ServiceStartType::AutoStart + } else { + ServiceStartType::OnDemand + }; + let srv_name = OsString::from(ctx.label.to_qualified_name()); + let mut dis_name = srv_name.clone(); + let mut description: Option = None; + let mut dependencies = Vec::::new(); + + if let Some(s) = ctx.contents.as_ref() { + let options: WinServiceInstallOptions = serde_json::from_str(s.as_str()).unwrap(); + if let Some(d) = options.dependencies { + dependencies = d + .iter() + .map(|dep| ServiceDependency::Service(OsString::from(dep.clone()))) + .collect::>(); + } + if let Some(d) = options.description { + description = Some(OsString::from(d)); + } + if let Some(d) = options.display_name { + dis_name = OsString::from(d); + } + } + + let service_info = ServiceInfo { + name: srv_name, + display_name: dis_name, + service_type: ServiceType::OWN_PROCESS, + start_type, + error_control: ServiceErrorControl::Normal, + executable_path: ctx.program.clone(), + launch_arguments: ctx.args.clone(), + dependencies: dependencies.clone(), + account_name: None, + account_password: None, + }; + + (service_info, description) + } + + impl WinServiceManager { + pub fn new() -> Result { + let service_manager = + ServiceManager::local_computer(None::<&str>, ServiceManagerAccess::ALL_ACCESS)?; + Ok(Self { service_manager }) + } + } + impl service_manager::ServiceManager for WinServiceManager { + fn available(&self) -> io::Result { + Ok(true) + } + + fn install(&self, ctx: ServiceInstallCtx) -> io::Result<()> { + let (service_info, description) = generate_service_info(&ctx); + + let service = self + .service_manager + .create_service(&service_info, ServiceAccess::ALL_ACCESS) + .map_err(io::Error::other)?; + + if let Some(s) = description { + service + .set_description(s.clone()) + .map_err(io::Error::other)?; + } + + if let Some(work_dir) = ctx.working_directory { + set_service_work_directory(&ctx.label.to_qualified_name(), work_dir)?; + } + + configure_failure_actions(&service, ctx.disable_restart_on_failure)?; + + Ok(()) + } + + fn uninstall(&self, ctx: ServiceUninstallCtx) -> io::Result<()> { + let service = self + .service_manager + .open_service(ctx.label.to_qualified_name(), ServiceAccess::ALL_ACCESS) + .map_err(io::Error::other)?; + + service.delete().map_err(io::Error::other) + } + + fn start(&self, ctx: ServiceStartCtx) -> io::Result<()> { + let service = self + .service_manager + .open_service(ctx.label.to_qualified_name(), ServiceAccess::ALL_ACCESS) + .map_err(io::Error::other)?; + + service.start(&[] as &[&OsStr]).map_err(io::Error::other) + } + + fn stop(&self, ctx: ServiceStopCtx) -> io::Result<()> { + let service = self + .service_manager + .open_service(ctx.label.to_qualified_name(), ServiceAccess::ALL_ACCESS) + .map_err(io::Error::other)?; + + _ = service.stop().map_err(io::Error::other)?; + + Ok(()) + } + + fn level(&self) -> ServiceLevel { + ServiceLevel::System + } + + fn set_level(&mut self, level: ServiceLevel) -> io::Result<()> { + match level { + ServiceLevel::System => Ok(()), + _ => Err(io::Error::other("Unsupported service level")), + } + } + + fn status(&self, ctx: ServiceStatusCtx) -> io::Result { + let service = match self + .service_manager + .open_service(ctx.label.to_qualified_name(), ServiceAccess::QUERY_STATUS) + { + Ok(s) => s, + Err(e) => { + if let windows_service::Error::Winapi(ref win_err) = e + && win_err.raw_os_error() == Some(0x424) + { + return Ok(ServiceStatus::NotInstalled); + } + return Err(io::Error::other(e)); + } + }; + + let status = service.query_status().map_err(io::Error::other)?; + + match status.current_state { + windows_service::service::ServiceState::Stopped => Ok(ServiceStatus::Stopped(None)), + _ => Ok(ServiceStatus::Running), + } + } + } + + impl super::ServiceManager for WinServiceManager { + fn update(&self, ctx: service_manager::ServiceInstallCtx) -> io::Result<()> { + let (service_info, description) = generate_service_info(&ctx); + + let service = self + .service_manager + .open_service(ctx.label.to_qualified_name(), ServiceAccess::ALL_ACCESS) + .map_err(io::Error::other)?; + + service + .change_config(&service_info) + .map_err(io::Error::other)?; + + if let Some(s) = description { + service + .set_description(s.clone()) + .map_err(io::Error::other)?; + } + + if let Some(work_dir) = ctx.working_directory { + set_service_work_directory(&ctx.label.to_qualified_name(), work_dir)?; + } + + configure_failure_actions(&service, ctx.disable_restart_on_failure)?; + + Ok(()) + } + } + + fn set_service_work_directory(service_name: &str, work_directory: PathBuf) -> io::Result<()> { + let (reg_key, _) = + RegKey::predef(HKEY_LOCAL_MACHINE).create_subkey(WIN_SERVICE_WORK_DIR_REG_KEY)?; + reg_key + .set_value::(service_name, &work_directory.as_os_str().to_os_string())?; + Ok(()) + } + + fn configure_failure_actions( + service: &Service, + disable_restart_on_failure: bool, + ) -> io::Result<()> { + // the SCM repeats the last action once the failure count exceeds the + // actions array, so Restart actions retry indefinitely. + let actions = if disable_restart_on_failure { + // empty actions clear previously configured ones + Vec::new() + } else { + vec![ + ServiceAction { + action_type: ServiceActionType::Restart, + delay: Duration::from_secs(1), + }, + ServiceAction { + action_type: ServiceActionType::Restart, + delay: Duration::from_secs(5), + }, + ServiceAction { + action_type: ServiceActionType::Restart, + delay: Duration::from_secs(10), + }, + ] + }; + + service + .update_failure_actions(ServiceFailureActions { + reset_period: ServiceFailureResetPeriod::Never, + reboot_msg: None, + command: None, + actions: Some(actions), + }) + .map_err(io::Error::other)?; + + // by default the SCM only performs failure actions on crashes; our + // service reports SERVICE_STOPPED with a non-zero exit code on + // failure, which requires this flag to be treated as a failure. + service + .set_failure_actions_on_non_crash_failures(!disable_restart_on_failure) + .map_err(io::Error::other)?; + + Ok(()) + } +} diff --git a/vendor/easytier/easytier/src/socket/fake_tcp/LICENSE b/vendor/easytier/easytier/src/socket/fake_tcp/LICENSE new file mode 100644 index 0000000..e1b074a --- /dev/null +++ b/vendor/easytier/easytier/src/socket/fake_tcp/LICENSE @@ -0,0 +1,6 @@ +Copyright 2021-2025 Datong Sun dndx@idndx.com + +Licensed under the Apache License, Version 2.0 or the MIT license , at your option. Files in the project may +not be copied, modified, or distributed except according to those terms. \ No newline at end of file diff --git a/vendor/easytier/easytier/src/socket/fake_tcp/mod.rs b/vendor/easytier/easytier/src/socket/fake_tcp/mod.rs new file mode 100644 index 0000000..65f2b95 --- /dev/null +++ b/vendor/easytier/easytier/src/socket/fake_tcp/mod.rs @@ -0,0 +1,543 @@ +mod netfilter; +mod packet; +mod stack; + +use bytes::BytesMut; +use network_interface::NetworkInterfaceConfig; +use std::{ + io, + net::{IpAddr, Ipv4Addr, SocketAddr, UdpSocket}, + pin::Pin, + sync::Arc, + task::{Context as TaskContext, Poll}, +}; +use tokio::{ + io::{AsyncRead, AsyncReadExt, AsyncWrite, ReadBuf}, + net::TcpStream, +}; + +use easytier_core::{ + socket::tcp::VirtualTcpSocket, + tunnel::{IpVersion, TunnelError}, +}; + +use crate::{common::netns::NetNS, tunnel::FromUrl}; + +use self::netfilter::create_tun; +use self::packet::MacAddr; + +use futures::Future; +use tokio_util::task::AbortOnDropHandle; + +use dashmap::DashMap; + +struct IpToIfNameCache { + ip_to_ifname: DashMap)>, +} + +fn parse_mac_addr(value: &str) -> Option { + let mut bytes = [0; 6]; + let mut octets = value.split([':', '-']); + for byte in &mut bytes { + *byte = u8::from_str_radix(octets.next()?, 16).ok()?; + } + octets.next().is_none().then(|| MacAddr::from_bytes(&bytes)) +} + +impl IpToIfNameCache { + fn new() -> Self { + Self { + ip_to_ifname: DashMap::new(), + } + } + + fn reload_ip_to_ifname(&self) { + self.ip_to_ifname.clear(); + let Ok(interfaces) = network_interface::NetworkInterface::show() else { + tracing::warn!("failed to enumerate interfaces when reloading faketcp ip cache"); + return; + }; + for iface in interfaces { + let mac = iface.mac_addr.as_deref().and_then(|mac| { + parse_mac_addr(mac).or_else(|| { + tracing::debug!(iface = %iface.name, mac, "failed to parse interface mac"); + None + }) + }); + for ip in iface.addr.iter() { + self.ip_to_ifname.insert(ip.ip(), (iface.name.clone(), mac)); + } + } + } + + fn get_ifname(&self, ip: &IpAddr) -> Option<(String, Option)> { + if let Some(ifname) = self.ip_to_ifname.get(ip) { + Some(ifname.clone()) + } else { + self.reload_ip_to_ifname(); + self.ip_to_ifname.get(ip).map(|s| s.clone()) + } + } +} + +fn faketcp_transport_label(driver_type: &str) -> String { + format!("faketcp_{}", driver_type) +} + +async fn create_tun_off_runtime( + interface_name: String, + src_addr: Option, + dst_addr: SocketAddr, + net_ns: NetNS, +) -> Result, TunnelError> { + tokio::task::spawn_blocking(move || { + net_ns.run(|| create_tun(&interface_name, src_addr, dst_addr)) + }) + .await + .map_err(|e| TunnelError::InternalError(format!("faketcp create_tun task failed: {e}")))? + .map_err(Into::into) +} + +pub(crate) struct FakeTcpSocketListener { + addr: url::Url, + os_listener: Option, + // interface_name -> fake tcp stack + stack_map: DashMap>, + // a cache from ip addr to interface name + ip_to_ifname: IpToIfNameCache, +} + +impl std::fmt::Debug for FakeTcpSocketListener { + fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("FakeTcpSocketListener") + .field("addr", &self.addr) + .field("listening", &self.os_listener.is_some()) + .finish() + } +} + +impl FakeTcpSocketListener { + pub(crate) fn new(addr: url::Url) -> Self { + FakeTcpSocketListener { + addr, + os_listener: None, + stack_map: DashMap::new(), + ip_to_ifname: IpToIfNameCache::new(), + } + } + + async fn do_accept(&mut self) -> Result { + loop { + match self.os_listener.as_mut().unwrap().accept().await { + Ok((s, remote_addr)) => { + let Ok(local_addr) = s.local_addr() else { + tracing::warn!("accept fail with local_addr error"); + continue; + }; + let Some((interface_name, mac)) = + self.ip_to_ifname.get_ifname(&local_addr.ip()) + else { + tracing::warn!("accept fail with interface_name error"); + continue; + }; + return Ok(AcceptResult { + socket: s, + local_addr, + remote_addr, + interface_name, + mac, + }); + } + Err(e) => { + use std::io::ErrorKind::*; + if matches!( + e.kind(), + NotConnected | ConnectionAborted | ConnectionRefused | ConnectionReset + ) { + tracing::warn!(?e, "accept fail with retryable error: {:?}", e); + continue; + } + tracing::warn!(?e, "accept fail"); + return Err(e.into()); + } + } + } + } + + async fn get_stack( + &self, + accept_result: &AcceptResult, + ) -> Result, TunnelError> { + let local_socket_addr = accept_result.local_addr; + + let interface_name = &accept_result.interface_name; + + if let Some(entry) = self.stack_map.get(interface_name) { + let stack = entry.clone(); + drop(entry); + + if !stack.is_closed() { + return Ok(stack); + } + + tracing::warn!( + interface_name, + "fake_tcp stack reader_task finished, recreating stack" + ); + self.stack_map.remove(interface_name); + } + + let tun = create_tun_off_runtime( + interface_name.to_string(), + None, + local_socket_addr, + NetNS::new(None), + ) + .await?; + tracing::info!( + ?local_socket_addr, + "create new stack with interface_name: {:?}", + interface_name + ); + let stack = Arc::new(stack::Stack::new(tun, accept_result.mac)); + self.stack_map + .insert(interface_name.to_string(), stack.clone()); + + Ok(stack) + } +} + +fn build_os_socket_reader_task(mut socket: TcpStream) -> AbortOnDropHandle<()> { + AbortOnDropHandle::new(tokio::spawn(async move { + // read the os socket until it's closed + let mut buf = [0u8; 1024]; + while let Ok(size) = socket.read(&mut buf).await { + tracing::trace!("read {} bytes from os socket", size); + if size == 0 { + break; + } + } + tracing::info!("FakeTcpSocketListener os socket closed"); + })) +} + +type FakeTcpReadFuture = Pin> + Send + Sync + 'static>>; + +enum FakeTcpReadState { + Buffered(BytesMut), + Receiving(FakeTcpReadFuture), + Closed, +} + +pub(crate) struct FakeTcpSocket { + socket: Arc, + read_state: FakeTcpReadState, + transport_label: String, + _lifetime_guard: Box, +} + +impl FakeTcpSocket { + fn new(socket: stack::Socket, transport_label: String, lifetime_guard: T) -> Self + where + T: Send + Sync + 'static, + { + Self { + socket: Arc::new(socket), + read_state: FakeTcpReadState::Buffered(BytesMut::new()), + transport_label, + _lifetime_guard: Box::new(lifetime_guard), + } + } +} + +impl AsyncRead for FakeTcpSocket { + fn poll_read( + self: Pin<&mut Self>, + context: &mut TaskContext<'_>, + output: &mut ReadBuf<'_>, + ) -> Poll> { + let this = self.get_mut(); + loop { + let state = std::mem::replace(&mut this.read_state, FakeTcpReadState::Closed); + match state { + FakeTcpReadState::Buffered(mut buffer) if !buffer.is_empty() => { + let length = buffer.len().min(output.remaining()); + output.put_slice(&buffer.split_to(length)); + this.read_state = FakeTcpReadState::Buffered(buffer); + return Poll::Ready(Ok(())); + } + FakeTcpReadState::Buffered(_) => { + let socket = this.socket.clone(); + this.read_state = FakeTcpReadState::Receiving(Box::pin(async move { + let mut buffer = BytesMut::new(); + socket.recv(&mut buffer).await.map(|_| buffer) + })); + } + FakeTcpReadState::Receiving(mut receive) => match receive.as_mut().poll(context) { + Poll::Ready(Some(buffer)) => { + this.read_state = FakeTcpReadState::Buffered(buffer); + } + Poll::Ready(None) => { + this.read_state = FakeTcpReadState::Closed; + return Poll::Ready(Ok(())); + } + Poll::Pending => { + this.read_state = FakeTcpReadState::Receiving(receive); + return Poll::Pending; + } + }, + FakeTcpReadState::Closed => return Poll::Ready(Ok(())), + } + } + } +} + +impl AsyncWrite for FakeTcpSocket { + fn poll_write( + self: Pin<&mut Self>, + _context: &mut TaskContext<'_>, + buffer: &[u8], + ) -> Poll> { + if self.socket.try_send(buffer).is_none() { + // Preserve FakeTCP's existing lossy send behavior. A temporary + // driver lock conflict is indistinguishable from a closed stack + // here, and the former must not tear down the peer connection. + tracing::trace!( + len = buffer.len(), + "FakeTCP socket dropped an outgoing frame" + ); + } + Poll::Ready(Ok(buffer.len())) + } + + fn poll_flush(self: Pin<&mut Self>, _context: &mut TaskContext<'_>) -> Poll> { + Poll::Ready(Ok(())) + } + + fn poll_shutdown(self: Pin<&mut Self>, _context: &mut TaskContext<'_>) -> Poll> { + self.socket.close(); + Poll::Ready(Ok(())) + } +} + +impl VirtualTcpSocket for FakeTcpSocket { + fn local_addr(&self) -> io::Result { + Ok(self.socket.local_addr()) + } + + fn peer_addr(&self) -> io::Result { + Ok(self.socket.remote_addr()) + } + + fn transport_label(&self) -> Option<&str> { + Some(&self.transport_label) + } +} + +#[derive(Debug)] +struct AcceptResult { + socket: TcpStream, + local_addr: SocketAddr, + remote_addr: SocketAddr, + interface_name: String, + mac: Option, +} + +impl FakeTcpSocketListener { + pub(crate) async fn accept_socket(&mut self) -> Result { + tracing::debug!("FakeTcpSocketListener waiting for accept"); + let (res, stack, socket) = loop { + let res = self.do_accept().await?; + let stack = self.get_stack(&res).await?; + let socket = stack.try_alloc_established_socket( + res.local_addr, + res.remote_addr, + stack::State::Established, + ); + let Some(socket) = socket else { + tracing::warn!( + interface_name = res.interface_name, + "fake_tcp stack closed while accepting connection, dropping accepted socket" + ); + self.stack_map.remove(&res.interface_name); + continue; + }; + break (res, stack, socket); + }; + + tracing::info!( + ?res, + remote = socket.remote_addr().to_string(), + "FakeTcpSocketListener accepted connection" + ); + + let transport_label = faketcp_transport_label(stack.driver_type()); + Ok(FakeTcpSocket::new( + socket, + transport_label, + (build_os_socket_reader_task(res.socket), stack), + )) + } + + async fn listen_socket(&mut self) -> Result<(), TunnelError> { + let port = self.addr.port().unwrap_or(0); + let bind_addr = SocketAddr::from_url(self.addr.clone(), IpVersion::Both).await?; + let os_listener = tokio::net::TcpListener::bind(bind_addr).await?; + tracing::info!(port, "FakeTcpSocketListener listening"); + self.os_listener = Some(os_listener); + Ok(()) + } +} + +#[async_trait::async_trait] +impl easytier_core::socket::SocketListener for FakeTcpSocketListener { + type Accepted = FakeTcpSocket; + + async fn listen(&mut self) -> anyhow::Result<()> { + Ok(self.listen_socket().await?) + } + + async fn accept(&mut self) -> anyhow::Result { + Ok(self.accept_socket().await?) + } + + fn local_url(&self) -> url::Url { + self.addr.clone() + } +} + +fn get_local_ip_for_destination(destination: IpAddr) -> Option { + // 使用一个不可路由的、私有的、或回环地址创建一个临时的 socket,让内核自动选择源接口。 + // 对于 IPv4,使用 0.0.0.0; 对于 IPv6,使用 :: + let bind_addr = if destination.is_ipv4() { + IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)) + } else { + IpAddr::V6(std::net::Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)) + }; + + // 绑定到一个临时端口 (0) + let socket = UdpSocket::bind((bind_addr, 0)).ok()?; + + // 尝试连接到目标地址。这不会真正发送数据包,只是让内核确定路由。 + socket.connect((destination, 80)).ok()?; // 使用一个常见的端口,例如 80 + + // 获取 socket 的本地地址信息 + socket.local_addr().map(|addr| addr.ip()).ok() +} + +async fn connect_socket_with_cache( + remote_addr: SocketAddr, + socket_mark: Option, + ip_to_if_name: &IpToIfNameCache, + net_ns: NetNS, +) -> Result { + let (local_addr, interface_name, mac, os_socket) = net_ns.run(|| { + let local_ip = get_local_ip_for_destination(remote_addr.ip()) + .ok_or(TunnelError::InternalError("Failed to get local ip".into()))?; + + let os_socket = tokio::net::TcpSocket::new_v4()?; + // SO_MARK applies only to the kernel-visible "decoy" socket below. + // The actual FakeTCP payload travels via crafted segments written + // straight to the TUN device, which the kernel doesn't tag with + // SO_MARK. Operators relying on fwmark for FakeTCP must mark the + // TUN device's traffic with a separate nftables/iptables rule. + crate::tunnel::common::apply_socket_mark(&socket2::SockRef::from(&os_socket), socket_mark)?; + os_socket.bind("0.0.0.0:0".parse().unwrap())?; + let local_addr = SocketAddr::new(local_ip, os_socket.local_addr()?.port()); + + let (interface_name, mac) = + ip_to_if_name + .get_ifname(&local_ip) + .ok_or(TunnelError::InternalError( + "Failed to get interface name".into(), + ))?; + Ok::<_, TunnelError>((local_addr, interface_name, mac, os_socket)) + })?; + + let tun = create_tun_off_runtime(interface_name, Some(remote_addr), local_addr, net_ns).await?; + let stack = stack::Stack::new(tun, mac); + let transport_label = faketcp_transport_label(stack.driver_type()); + + let socket = stack + .try_alloc_established_socket(local_addr, remote_addr, stack::State::SynSent) + .ok_or(TunnelError::InternalError( + "FakeTCP stack closed while allocating socket".into(), + ))?; + + let os_stream = os_socket.connect(remote_addr).await?; + + tracing::info!(?remote_addr, "FakeTCP socket connecting"); + + let mut buf = BytesMut::new(); + socket + .recv(&mut buf) + .await + .ok_or(TunnelError::InternalError( + "Failed to recv bytes to establish connection".into(), + ))?; + + tracing::info!(local_addr = ?socket.local_addr(), "FakeTCP socket connected"); + + Ok(FakeTcpSocket::new( + socket, + transport_label, + (build_os_socket_reader_task(os_stream), stack), + )) +} + +pub(crate) async fn connect_socket( + remote_addr: SocketAddr, + socket_mark: Option, + net_ns: NetNS, +) -> Result { + connect_socket_with_cache(remote_addr, socket_mark, &IpToIfNameCache::new(), net_ns).await +} + +#[cfg(test)] +mod tests { + use easytier_core::socket::SocketListener; + use tokio::io::{AsyncReadExt, AsyncWriteExt}; + + use super::*; + + #[tokio::test] + async fn faketcp_socket_pingpong() { + tokio::time::timeout(std::time::Duration::from_secs(5), async { + #[cfg(target_family = "unix")] + { + if unsafe { nix::libc::geteuid() } != 0 { + return; + } + } + + let mut listener = + FakeTcpSocketListener::new("faketcp://0.0.0.0:31011".parse().unwrap()); + listener.listen().await.unwrap(); + let (server_ready_tx, server_ready_rx) = tokio::sync::oneshot::channel(); + + let server = tokio::spawn(async move { + let mut socket = listener.accept().await.unwrap(); + server_ready_tx.send(()).unwrap(); + let mut request = [0; 4]; + socket.read_exact(&mut request).await.unwrap(); + assert_eq!(&request, b"ping"); + socket.write_all(b"pong").await.unwrap(); + }); + + let mut socket = + connect_socket("127.0.0.1:31011".parse().unwrap(), None, NetNS::new(None)) + .await + .unwrap(); + server_ready_rx.await.unwrap(); + socket.write_all(b"ping").await.unwrap(); + let mut response = [0; 4]; + socket.read_exact(&mut response).await.unwrap(); + assert_eq!(&response, b"pong"); + + server.await.unwrap(); + }) + .await + .expect("FakeTCP socket ping-pong timed out"); + } +} diff --git a/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/linux_bpf.rs b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/linux_bpf.rs new file mode 100644 index 0000000..4ae106c --- /dev/null +++ b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/linux_bpf.rs @@ -0,0 +1,1315 @@ +use bytes::Bytes; +use bytes::BytesMut; +use nix::libc; +use std::ffi::CString; +use std::io; +use std::mem; +use std::net::IpAddr; +use std::net::SocketAddr; +use std::os::fd::{AsRawFd, FromRawFd, OwnedFd}; +use std::sync::Arc; +use std::sync::atomic::{AtomicBool, Ordering as AtomicOrdering}; +use std::time::{Duration, Instant}; +use tokio::sync::Mutex; + +use crate::socket::fake_tcp::stack; + +const ETH_HDR_LEN: usize = 14; +const ETHERTYPE_IPV4: u16 = 0x0800; +const ETHERTYPE_IPV6: u16 = 0x86DD; +const IPPROTO_TCP_U32: u32 = 6; + +const BPF_LD: u16 = 0x00; +const BPF_LDX: u16 = 0x01; +const BPF_JMP: u16 = 0x05; +const BPF_RET: u16 = 0x06; + +const BPF_W: u16 = 0x00; +const BPF_H: u16 = 0x08; +const BPF_B: u16 = 0x10; + +const BPF_ABS: u16 = 0x20; +const BPF_IND: u16 = 0x40; +const BPF_MSH: u16 = 0xa0; + +const BPF_JA: u16 = 0x00; +const BPF_JEQ: u16 = 0x10; +const BPF_JSET: u16 = 0x40; + +const BPF_K: u16 = 0x00; + +const SOL_PACKET: i32 = 263; +const PACKET_STATISTICS: i32 = 6; + +const DEFAULT_RCVBUF_BYTES: i32 = 32 * 1024 * 1024; +const IPV4_FRAGMENT_OFFSET_MASK: u32 = 0x1fff; + +fn stmt(code: u16, k: u32) -> libc::sock_filter { + libc::sock_filter { + code, + jt: 0, + jf: 0, + k, + } +} + +fn jeq(k: u32, jt: u8, jf: u8) -> libc::sock_filter { + libc::sock_filter { + code: BPF_JMP | BPF_JEQ | BPF_K, + jt, + jf, + k, + } +} + +fn jset(k: u32, jt: u8, jf: u8) -> libc::sock_filter { + libc::sock_filter { + code: BPF_JMP | BPF_JSET | BPF_K, + jt, + jf, + k, + } +} + +fn ja(k: u32) -> libc::sock_filter { + libc::sock_filter { + code: BPF_JMP | BPF_JA, + jt: 0, + jf: 0, + k, + } +} + +#[derive(Clone, Copy)] +struct Label(usize); + +struct ConditionalJumpPatch { + idx: usize, + t: Label, + f: Label, +} + +struct JaPatch { + idx: usize, + target: Label, +} + +struct BpfBuilder { + insns: Vec, + labels: Vec>, + conditional_jump_patches: Vec, + ja_patches: Vec, +} + +impl BpfBuilder { + fn new() -> Self { + Self { + insns: Vec::new(), + labels: Vec::new(), + conditional_jump_patches: Vec::new(), + ja_patches: Vec::new(), + } + } + + fn new_label(&mut self) -> Label { + let idx = self.labels.len(); + self.labels.push(None); + Label(idx) + } + + fn set_label(&mut self, label: Label) { + self.labels[label.0] = Some(self.insns.len()); + } + + fn push(&mut self, insn: libc::sock_filter) { + self.insns.push(insn); + } + + fn push_jeq(&mut self, k: u32, t: Label, f: Label) { + let idx = self.insns.len(); + self.insns.push(jeq(k, 0, 0)); + self.conditional_jump_patches + .push(ConditionalJumpPatch { idx, t, f }); + } + + fn push_jset(&mut self, k: u32, t: Label, f: Label) { + let idx = self.insns.len(); + self.insns.push(jset(k, 0, 0)); + self.conditional_jump_patches + .push(ConditionalJumpPatch { idx, t, f }); + } + + fn push_ja(&mut self, target: Label) { + let idx = self.insns.len(); + self.insns.push(ja(0)); + self.ja_patches.push(JaPatch { idx, target }); + } + + fn finish(mut self) -> io::Result> { + for patch in self.conditional_jump_patches { + let ConditionalJumpPatch { idx, t, f } = patch; + let cur = idx + 1; + let t_pos = + self.labels.get(t.0).and_then(|v| *v).ok_or_else(|| { + io::Error::new(io::ErrorKind::InvalidInput, "unresolved label") + })?; + let f_pos = + self.labels.get(f.0).and_then(|v| *v).ok_or_else(|| { + io::Error::new(io::ErrorKind::InvalidInput, "unresolved label") + })?; + + if t_pos < cur || f_pos < cur { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "backward bpf jump", + )); + } + + let jt: u8 = (t_pos - cur) + .try_into() + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "bpf jump too far"))?; + let jf: u8 = (f_pos - cur) + .try_into() + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "bpf jump too far"))?; + + self.insns[idx].jt = jt; + self.insns[idx].jf = jf; + } + + for patch in self.ja_patches { + let JaPatch { idx, target } = patch; + let cur = idx + 1; + let t_pos = + self.labels.get(target.0).and_then(|v| *v).ok_or_else(|| { + io::Error::new(io::ErrorKind::InvalidInput, "unresolved label") + })?; + if t_pos < cur { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "backward bpf jump", + )); + } + self.insns[idx].k = (t_pos - cur) as u32; + } + + Ok(self.insns) + } +} + +fn build_tcp_filter( + src_addr: Option, + dst_addr: SocketAddr, +) -> io::Result> { + if let Some(src) = src_addr + && src.is_ipv4() != dst_addr.is_ipv4() + { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "src/dst addr family mismatch", + )); + } + + let mut b = BpfBuilder::new(); + let l_accept = b.new_label(); + let l_reject = b.new_label(); + + if dst_addr.is_ipv4() { + let l_v4_proto_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_B | BPF_ABS, 9)); + b.push_jeq(IPPROTO_TCP_U32, l_v4_proto_ok, l_reject); + + b.set_label(l_v4_proto_ok); + let l_v4_fragment_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_H | BPF_ABS, 6)); + b.push_jset(IPV4_FRAGMENT_OFFSET_MASK, l_reject, l_v4_fragment_ok); + + b.set_label(l_v4_fragment_ok); + let dst_ip = match dst_addr.ip() { + IpAddr::V4(ip) => u32::from(ip), + _ => unreachable!(), + }; + let l_v4_dstip_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, 16)); + b.push_jeq(dst_ip, l_v4_dstip_ok, l_reject); + + b.set_label(l_v4_dstip_ok); + if let Some(src) = src_addr { + let src_ip = match src.ip() { + IpAddr::V4(ip) => u32::from(ip), + _ => unreachable!(), + }; + let l_v4_srcip_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, 12)); + b.push_jeq(src_ip, l_v4_srcip_ok, l_reject); + b.set_label(l_v4_srcip_ok); + } + + b.push(stmt(BPF_LDX | BPF_B | BPF_MSH, 0)); + + let l_v4_dstport_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_H | BPF_IND, 2)); + b.push_jeq(dst_addr.port() as u32, l_v4_dstport_ok, l_reject); + + b.set_label(l_v4_dstport_ok); + if let Some(src) = src_addr { + b.push(stmt(BPF_LD | BPF_H | BPF_IND, 0)); + b.push_jeq(src.port() as u32, l_accept, l_reject); + } else { + b.push_ja(l_accept); + } + } else { + let l_v6_proto_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_B | BPF_ABS, 6)); + b.push_jeq(IPPROTO_TCP_U32, l_v6_proto_ok, l_reject); + + b.set_label(l_v6_proto_ok); + let dst_ip = match dst_addr.ip() { + IpAddr::V6(ip) => ip.octets(), + _ => unreachable!(), + }; + for (i, chunk) in dst_ip.as_chunks::<4>().0.iter().enumerate() { + let off = 24 + (i * 4); + let v = u32::from_be_bytes(*chunk); + let l_v6_dstip_word_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, off as u32)); + b.push_jeq(v, l_v6_dstip_word_ok, l_reject); + b.set_label(l_v6_dstip_word_ok); + } + + if let Some(src) = src_addr { + let src_ip = match src.ip() { + IpAddr::V6(ip) => ip.octets(), + _ => unreachable!(), + }; + for (i, chunk) in src_ip.as_chunks::<4>().0.iter().enumerate() { + let off = 8 + (i * 4); + let v = u32::from_be_bytes(*chunk); + let l_v6_srcip_word_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, off as u32)); + b.push_jeq(v, l_v6_srcip_word_ok, l_reject); + b.set_label(l_v6_srcip_word_ok); + } + } + + let l_v6_dstport_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_H | BPF_ABS, 42)); + b.push_jeq(dst_addr.port() as u32, l_v6_dstport_ok, l_reject); + + b.set_label(l_v6_dstport_ok); + if let Some(src) = src_addr { + b.push(stmt(BPF_LD | BPF_H | BPF_ABS, 40)); + b.push_jeq(src.port() as u32, l_accept, l_reject); + } else { + b.push_ja(l_accept); + } + } + + b.set_label(l_accept); + b.push(stmt(BPF_RET | BPF_K, 0xFFFF)); + + b.set_label(l_reject); + b.push(stmt(BPF_RET | BPF_K, 0)); + + b.finish() +} + +fn ether_type_for_ip(packet: &[u8]) -> io::Result { + match packet.first().map(|byte| byte >> 4) { + Some(4) => Ok(ETHERTYPE_IPV4), + Some(6) => Ok(ETHERTYPE_IPV6), + _ => Err(io::Error::new( + io::ErrorKind::InvalidData, + "packet has no valid IP header", + )), + } +} + +fn normalize_rx_packet(packet: &[u8], link_addr: &libc::sockaddr_ll) -> io::Result> { + let ether_type = ether_type_for_ip(packet)?; + let mut frame = vec![0; ETH_HDR_LEN + packet.len()]; + if link_addr.sll_halen == 6 { + frame[6..12].copy_from_slice(&link_addr.sll_addr[..6]); + } + frame[12..14].copy_from_slice(ðer_type.to_be_bytes()); + frame[ETH_HDR_LEN..].copy_from_slice(packet); + Ok(frame) +} + +#[repr(C)] +#[derive(Clone, Copy, Default)] +struct PacketSocketStats { + tp_packets: u32, + tp_drops: u32, +} + +fn set_socket_rcvbuf(fd: i32, desired_bytes: i32) -> io::Result { + let ret = unsafe { + libc::setsockopt( + fd, + libc::SOL_SOCKET, + libc::SO_RCVBUF, + &desired_bytes as *const _ as *const libc::c_void, + mem::size_of_val(&desired_bytes) as u32, + ) + }; + if ret != 0 { + return Err(io::Error::last_os_error()); + } + + let mut actual: i32 = 0; + let mut len = mem::size_of_val(&actual) as libc::socklen_t; + let ret = unsafe { + libc::getsockopt( + fd, + libc::SOL_SOCKET, + libc::SO_RCVBUF, + &mut actual as *mut _ as *mut libc::c_void, + &mut len as *mut _, + ) + }; + if ret != 0 { + return Err(io::Error::last_os_error()); + } + + Ok(actual) +} + +fn read_packet_socket_stats(fd: i32) -> io::Result { + let mut stats = PacketSocketStats::default(); + let mut len = mem::size_of_val(&stats) as libc::socklen_t; + let ret = unsafe { + libc::getsockopt( + fd, + SOL_PACKET, + PACKET_STATISTICS, + &mut stats as *mut _ as *mut libc::c_void, + &mut len as *mut _, + ) + }; + if ret != 0 { + return Err(io::Error::last_os_error()); + } + Ok(stats) +} + +pub struct LinuxBpfTun { + fd: Arc, + ifindex: i32, + stop: Arc, + worker: Option>, + recv_queue: Mutex>>, +} + +impl LinuxBpfTun { + pub fn new( + interface_name: &str, + src_addr: Option, + dst_addr: SocketAddr, + ) -> io::Result { + let c_ifname = CString::new(interface_name) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid interface name"))?; + let ifindex = unsafe { libc::if_nametoindex(c_ifname.as_ptr()) as i32 }; + if ifindex <= 0 { + return Err(io::Error::new( + io::ErrorKind::NotFound, + "interface not found", + )); + } + + let protocol = match dst_addr { + SocketAddr::V4(_) => ETHERTYPE_IPV4, + SocketAddr::V6(_) => ETHERTYPE_IPV6, + }; + let proto = protocol.to_be() as i32; + let fd = unsafe { libc::socket(libc::AF_PACKET, libc::SOCK_DGRAM, proto) }; + if fd < 0 { + return Err(io::Error::last_os_error()); + } + let fd = Arc::new(unsafe { OwnedFd::from_raw_fd(fd) }); + + let mut addr: libc::sockaddr_ll = unsafe { mem::zeroed() }; + addr.sll_family = libc::AF_PACKET as u16; + addr.sll_protocol = protocol.to_be(); + addr.sll_ifindex = ifindex; + + let bind_ret = unsafe { + libc::bind( + fd.as_ref().as_raw_fd(), + &addr as *const _ as *const libc::sockaddr, + mem::size_of::() as u32, + ) + }; + if bind_ret != 0 { + return Err(io::Error::last_os_error()); + } + + let actual_rcvbuf = set_socket_rcvbuf(fd.as_ref().as_raw_fd(), DEFAULT_RCVBUF_BYTES)?; + + let filter = build_tcp_filter(src_addr, dst_addr)?; + let mut prog = libc::sock_fprog { + len: filter + .len() + .try_into() + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "bpf program too long"))?, + filter: filter.as_ptr() as *mut libc::sock_filter, + }; + let opt_ret = unsafe { + libc::setsockopt( + fd.as_ref().as_raw_fd(), + libc::SOL_SOCKET, + libc::SO_ATTACH_FILTER, + &mut prog as *mut _ as *mut libc::c_void, + mem::size_of::() as u32, + ) + }; + if opt_ret != 0 { + return Err(io::Error::last_os_error()); + } + + let timeout = libc::timeval { + tv_sec: 0, + tv_usec: 200_000, + }; + let _ = unsafe { + libc::setsockopt( + fd.as_ref().as_raw_fd(), + libc::SOL_SOCKET, + libc::SO_RCVTIMEO, + &timeout as *const _ as *const libc::c_void, + mem::size_of::() as u32, + ) + }; + + let stop = Arc::new(AtomicBool::new(false)); + let (tx, rx) = tokio::sync::mpsc::channel(1024); + let stop_clone = stop.clone(); + let read_fd = fd.as_ref().as_raw_fd(); + let fd_guard = fd.clone(); + let interface_name_for_worker = interface_name.to_string(); + + let worker = std::thread::spawn(move || { + // Keep the packet socket alive until the detached worker actually exits. + let _fd_guard = fd_guard; + let mut buf = vec![0u8; 65536]; + let mut stats_enabled = true; + let mut total_packets: u64 = 0; + let mut total_drops: u64 = 0; + let mut total_bytes: u64 = 0; + let mut dropped_by_queue_full: u64 = 0; + let mut last_stats_log = Instant::now(); + while !stop_clone.load(AtomicOrdering::Relaxed) { + let mut link_addr: libc::sockaddr_ll = unsafe { mem::zeroed() }; + let mut link_addr_len = mem::size_of::() as libc::socklen_t; + let n = unsafe { + libc::recvfrom( + read_fd, + buf.as_mut_ptr() as *mut libc::c_void, + buf.len(), + 0, + &mut link_addr as *mut _ as *mut libc::sockaddr, + &mut link_addr_len, + ) + }; + if n < 0 { + let err = io::Error::last_os_error(); + if matches!( + err.kind(), + io::ErrorKind::Interrupted | io::ErrorKind::WouldBlock + ) { + continue; + } + break; + } + if n == 0 { + continue; + } + let Ok(data) = normalize_rx_packet(&buf[..n as usize], &link_addr) else { + continue; + }; + total_bytes = total_bytes.wrapping_add(n as u64); + match tx.try_send(data) { + Ok(()) => {} + Err(tokio::sync::mpsc::error::TrySendError::Full(_)) => { + dropped_by_queue_full = dropped_by_queue_full.wrapping_add(1); + } + Err(tokio::sync::mpsc::error::TrySendError::Closed(_)) => break, + } + + if last_stats_log.elapsed() >= Duration::from_secs(1) { + if stats_enabled { + match read_packet_socket_stats(read_fd) { + Ok(delta) => { + total_packets = total_packets.wrapping_add(delta.tp_packets as u64); + total_drops = total_drops.wrapping_add(delta.tp_drops as u64); + + let denom = + (delta.tp_packets as u64).saturating_add(delta.tp_drops as u64); + let drop_rate = if denom == 0 { + 0.0 + } else { + (delta.tp_drops as f64) / (denom as f64) + }; + + tracing::debug!( + "{}: delta_packets = {}, delta_drops = {}, delta_drop_rate = {}, total_packets = {}, total_drops = {}, total_bytes = {}, dropped_by_queue_full = {}", + interface_name_for_worker, + delta.tp_packets, + delta.tp_drops, + drop_rate, + total_packets, + total_drops, + total_bytes, + dropped_by_queue_full, + ); + } + Err(e) => { + stats_enabled = false; + tracing::warn!( + ?e, + interface_name_for_worker, + "LinuxBpfTun failed to read PACKET_STATISTICS, stats disabled" + ); + } + } + } else { + tracing::debug!( + "{}: total_bytes = {}, dropped_by_queue_full = {}", + interface_name_for_worker, + total_bytes, + dropped_by_queue_full, + ); + } + last_stats_log = Instant::now(); + } + } + }); + + tracing::info!( + interface_name, + ifindex, + desired_rcvbuf = DEFAULT_RCVBUF_BYTES, + actual_rcvbuf, + "LinuxBpfTun created with filter {:?}", + filter + ); + + Ok(Self { + fd, + ifindex, + stop, + worker: Some(worker), + recv_queue: Mutex::new(rx), + }) + } +} + +impl Drop for LinuxBpfTun { + fn drop(&mut self) { + self.stop.store(true, AtomicOrdering::Relaxed); + let _ = unsafe { libc::shutdown(self.fd.as_ref().as_raw_fd(), libc::SHUT_RD) }; + if let Some(worker) = self.worker.take() { + // Dropping the JoinHandle detaches the worker. The worker holds its own Arc + // clone, so the packet socket stays valid until recv wakes up and the thread exits. + drop(worker); + } + } +} + +#[async_trait::async_trait] +impl stack::Tun for LinuxBpfTun { + async fn recv(&self, packet: &mut BytesMut) -> Result { + let mut rx = self.recv_queue.lock().await; + match rx.recv().await { + Some(data) => { + packet.extend_from_slice(&data); + Ok(data.len()) + } + None => Err(std::io::Error::new( + std::io::ErrorKind::BrokenPipe, + "LinuxBpfTun channel closed", + )), + } + } + + fn try_send(&self, packet: &Bytes) -> Result<(), std::io::Error> { + if packet.len() < ETH_HDR_LEN { + return Err(std::io::Error::new( + std::io::ErrorKind::InvalidData, + "packet too short", + )); + } + let payload = &packet[ETH_HDR_LEN..]; + let protocol = ether_type_for_ip(payload)?; + let frame_protocol = u16::from_be_bytes([packet[12], packet[13]]); + if frame_protocol != protocol { + return Err(io::Error::new( + io::ErrorKind::InvalidData, + "Ethernet and IP protocol mismatch", + )); + } + + let mut addr: libc::sockaddr_ll = unsafe { mem::zeroed() }; + addr.sll_family = libc::AF_PACKET as u16; + addr.sll_protocol = protocol.to_be(); + addr.sll_ifindex = self.ifindex; + addr.sll_halen = 6; + addr.sll_addr[..6].copy_from_slice(&packet[..6]); + + let ret = unsafe { + libc::sendto( + self.fd.as_ref().as_raw_fd(), + payload.as_ptr() as *const libc::c_void, + payload.len(), + 0, + &addr as *const _ as *const libc::sockaddr, + mem::size_of::() as u32, + ) + }; + if ret < 0 { + return Err(std::io::Error::last_os_error()); + } + if ret as usize != payload.len() { + return Err(io::Error::new( + io::ErrorKind::WriteZero, + "partial packet socket write", + )); + } + Ok(()) + } + + fn driver_type(&self) -> &'static str { + "linux_bpf" + } +} + +#[cfg(all(test, target_os = "linux"))] +mod tests { + use super::*; + + use crate::socket::fake_tcp::packet::{MacAddr, TCP_FLAG_SYN, build_tcp_packet}; + use crate::socket::fake_tcp::stack::Tun; + use pnet_datalink as datalink; + use rand::Rng; + use serial_test::serial; + use std::env; + use std::process::Command; + use tokio::time::{Duration, timeout}; + + fn is_root() -> bool { + unsafe { libc::geteuid() == 0 } + } + + fn linux_bpf_integration_enabled(test_name: &str) -> bool { + if env::var_os("EASYTIER_LINUX_BPF_INTEGRATION").is_none() { + eprintln!("{test_name}: skipped (EASYTIER_LINUX_BPF_INTEGRATION not set)"); + return false; + } + assert!( + is_root(), + "{test_name}: EASYTIER_LINUX_BPF_INTEGRATION requires root" + ); + true + } + + fn run_ip(args: &[&str]) -> io::Result<()> { + let output = Command::new("ip").args(args).output()?; + if output.status.success() { + return Ok(()); + } + Err(io::Error::other(format!( + "ip {} failed: {}", + args.join(" "), + String::from_utf8_lossy(&output.stderr) + ))) + } + + fn test_frame(src_addr: SocketAddr, dst_addr: SocketAddr) -> Bytes { + build_tcp_packet( + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 1]), + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 2]), + src_addr, + dst_addr, + 1, + 0, + TCP_FLAG_SYN, + Some(b"test"), + ) + } + + fn set_ipv4_fragment_offset(packet: &mut [u8], fragment_offset: u16) { + assert_eq!(packet[0] >> 4, 4); + let header_len = usize::from(packet[0] & 0x0f) * 4; + packet[6..8].copy_from_slice(&(fragment_offset & 0x1fff).to_be_bytes()); + packet[10..12].fill(0); + + let mut sum = 0u32; + for word in packet[..header_len].as_chunks::<2>().0 { + sum += u32::from(u16::from_be_bytes([word[0], word[1]])); + } + while sum > u16::MAX as u32 { + sum = (sum & u16::MAX as u32) + (sum >> 16); + } + packet[10..12].copy_from_slice(&(!(sum as u16)).to_be_bytes()); + } + + const TUN_DEV_PATH: &str = "/dev/net/tun"; + + struct TestTun { + name: String, + fd: OwnedFd, + } + + impl TestTun { + fn create() -> io::Result { + let name = format!("etlb{}", rand::thread_rng().gen_range(10000..99999)); + let path = CString::new(TUN_DEV_PATH) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid tun path"))?; + let fd = unsafe { libc::open(path.as_ptr(), libc::O_RDWR | libc::O_CLOEXEC) }; + if fd < 0 { + return Err(io::Error::last_os_error()); + } + let fd = unsafe { OwnedFd::from_raw_fd(fd) }; + + let mut ifr: libc::ifreq = unsafe { mem::zeroed() }; + for (index, byte) in name.bytes().enumerate() { + ifr.ifr_name[index] = byte as libc::c_char; + } + ifr.ifr_ifru.ifru_flags = (libc::IFF_TUN | libc::IFF_NO_PI) as libc::c_short; + + let ret = unsafe { libc::ioctl(fd.as_raw_fd(), libc::TUNSETIFF, &mut ifr) }; + if ret != 0 { + return Err(io::Error::last_os_error()); + } + run_ip(&["link", "set", "dev", &name, "up"])?; + Ok(Self { name, fd }) + } + + fn write_packet(&self, packet: &[u8]) -> io::Result<()> { + let ret = unsafe { + libc::write( + self.fd.as_raw_fd(), + packet.as_ptr() as *const libc::c_void, + packet.len(), + ) + }; + if ret < 0 { + return Err(io::Error::last_os_error()); + } + if ret as usize != packet.len() { + return Err(io::Error::new( + io::ErrorKind::WriteZero, + "partial tun packet write", + )); + } + Ok(()) + } + + fn read_matching_packet(&self, expected: &[u8]) -> io::Result> { + let deadline = Instant::now() + Duration::from_secs(2); + loop { + let remaining = deadline.saturating_duration_since(Instant::now()); + if remaining.is_zero() { + return Err(io::Error::new( + io::ErrorKind::TimedOut, + "timed out waiting for matching TUN packet", + )); + } + + let mut pollfd = libc::pollfd { + fd: self.fd.as_raw_fd(), + events: libc::POLLIN, + revents: 0, + }; + let timeout_ms = remaining.as_millis().min(i32::MAX as u128) as i32; + let ready = unsafe { libc::poll(&mut pollfd, 1, timeout_ms) }; + if ready < 0 { + let error = io::Error::last_os_error(); + if error.kind() == io::ErrorKind::Interrupted { + continue; + } + return Err(error); + } + if ready == 0 { + continue; + } + + let mut packet = vec![0; 65_536]; + let len = unsafe { + libc::read( + self.fd.as_raw_fd(), + packet.as_mut_ptr() as *mut libc::c_void, + packet.len(), + ) + }; + if len < 0 { + return Err(io::Error::last_os_error()); + } + packet.truncate(len as usize); + if packet == expected { + return Ok(packet); + } + } + } + } + + impl Drop for TestTun { + fn drop(&mut self) { + let _ = run_ip(&["link", "del", "dev", &self.name]); + } + } + + struct TestVeth { + capture_name: String, + sender_name: String, + capture_mac: MacAddr, + sender_mac: MacAddr, + } + + impl TestVeth { + fn create() -> io::Result { + let suffix = rand::thread_rng().gen_range(10000..99999); + let capture_name = format!("elbc{suffix}"); + let sender_name = format!("elbs{suffix}"); + run_ip(&[ + "link", + "add", + &capture_name, + "type", + "veth", + "peer", + "name", + &sender_name, + ])?; + + let setup_result = (|| { + run_ip(&["link", "set", "dev", &capture_name, "up"])?; + run_ip(&["link", "set", "dev", &sender_name, "up"])?; + let interfaces = datalink::interfaces(); + let find_mac = |name: &str| { + interfaces + .iter() + .find(|interface| interface.name == name) + .and_then(|interface| interface.mac) + .map(|mac| MacAddr::from_bytes(&mac.octets())) + .ok_or_else(|| { + io::Error::new(io::ErrorKind::NotFound, "veth MAC address not found") + }) + }; + Ok((find_mac(&capture_name)?, find_mac(&sender_name)?)) + })(); + + let (capture_mac, sender_mac) = match setup_result { + Ok(macs) => macs, + Err(error) => { + let _ = run_ip(&["link", "del", "dev", &capture_name]); + return Err(error); + } + }; + + Ok(Self { + capture_name, + sender_name, + capture_mac, + sender_mac, + }) + } + } + + impl Drop for TestVeth { + fn drop(&mut self) { + let _ = run_ip(&["link", "del", "dev", &self.capture_name]); + } + } + + fn open_datalink_channel( + interface_name: &str, + ) -> io::Result<( + Box, + Box, + )> { + let interface = datalink::interfaces() + .into_iter() + .find(|interface| interface.name == interface_name) + .ok_or_else(|| io::Error::new(io::ErrorKind::NotFound, "interface not found"))?; + let config = datalink::Config { + read_timeout: Some(Duration::from_millis(100)), + ..Default::default() + }; + match datalink::channel(&interface, config).map_err(io::Error::other)? { + datalink::Channel::Ethernet(sender, receiver) => Ok((sender, receiver)), + _ => Err(io::Error::other("unsupported datalink channel")), + } + } + + #[tokio::test] + #[serial(linux_bpf_cooked)] + async fn linux_bpf_tun_receives_ipv4_from_l3_interface() -> io::Result<()> { + let test_name = "linux_bpf_tun_receives_ipv4_from_l3_interface"; + if !linux_bpf_integration_enabled(test_name) { + return Ok(()); + } + + let test_tun = TestTun::create()?; + let src_addr: SocketAddr = "192.0.2.10:12345".parse().unwrap(); + let dst_addr: SocketAddr = "198.51.100.20:23456".parse().unwrap(); + let frame = test_frame(src_addr, dst_addr); + let tun = LinuxBpfTun::new(&test_tun.name, None, dst_addr)?; + + test_tun.write_packet(&frame[ETH_HDR_LEN..])?; + + let mut received = BytesMut::new(); + let n = timeout(Duration::from_secs(2), tun.recv(&mut received)) + .await + .expect("timed out waiting for packet")?; + assert_eq!(n, frame.len()); + assert!(received[..12].iter().all(|byte| *byte == 0)); + assert_eq!(&received[12..14], &frame[12..14]); + assert_eq!(&received[ETH_HDR_LEN..], &frame[ETH_HDR_LEN..]); + + Ok(()) + } + + #[tokio::test] + #[serial(linux_bpf_cooked)] + async fn linux_bpf_tun_sends_ipv4_to_l3_interface() -> io::Result<()> { + let test_name = "linux_bpf_tun_sends_ipv4_to_l3_interface"; + if !linux_bpf_integration_enabled(test_name) { + return Ok(()); + } + + let test_tun = TestTun::create()?; + let src_addr: SocketAddr = "192.0.2.30:34567".parse().unwrap(); + let dst_addr: SocketAddr = "198.51.100.40:45678".parse().unwrap(); + let frame = test_frame(src_addr, dst_addr); + let tun = LinuxBpfTun::new(&test_tun.name, None, dst_addr)?; + + tun.try_send(&frame)?; + + let packet = test_tun.read_matching_packet(&frame[ETH_HDR_LEN..])?; + assert_eq!(packet, &frame[ETH_HDR_LEN..]); + + Ok(()) + } + + #[tokio::test] + #[serial(linux_bpf_cooked)] + async fn linux_bpf_tun_rejects_non_initial_ipv4_fragment() -> io::Result<()> { + let test_name = "linux_bpf_tun_rejects_non_initial_ipv4_fragment"; + if !linux_bpf_integration_enabled(test_name) { + return Ok(()); + } + + let test_tun = TestTun::create()?; + let src_addr: SocketAddr = "192.0.2.50:12345".parse().unwrap(); + let dst_addr: SocketAddr = "198.51.100.60:23456".parse().unwrap(); + let frame = test_frame(src_addr, dst_addr); + let tun = LinuxBpfTun::new(&test_tun.name, None, dst_addr)?; + + let mut fragment = frame[ETH_HDR_LEN..].to_vec(); + set_ipv4_fragment_offset(&mut fragment, 1); + test_tun.write_packet(&fragment)?; + + let mut received = BytesMut::new(); + assert!( + timeout(Duration::from_millis(400), tun.recv(&mut received)) + .await + .is_err(), + "non-initial IPv4 fragment passed the TCP port filter" + ); + + test_tun.write_packet(&frame[ETH_HDR_LEN..])?; + let mut received = BytesMut::new(); + timeout(Duration::from_secs(2), tun.recv(&mut received)) + .await + .expect("timed out waiting for unfragmented packet")?; + + Ok(()) + } + + #[tokio::test] + #[serial(linux_bpf_cooked)] + async fn linux_bpf_tun_filters_ipv4_tuple_on_l3_interface() -> io::Result<()> { + let test_name = "linux_bpf_tun_filters_ipv4_tuple_on_l3_interface"; + if !linux_bpf_integration_enabled(test_name) { + return Ok(()); + } + + let test_tun = TestTun::create()?; + let src_addr: SocketAddr = "192.0.2.70:12345".parse().unwrap(); + let dst_addr: SocketAddr = "198.51.100.80:23456".parse().unwrap(); + let tun = LinuxBpfTun::new(&test_tun.name, Some(src_addr), dst_addr)?; + + let wrong_src_port = test_frame("192.0.2.70:12346".parse().unwrap(), dst_addr); + let wrong_src_ip = test_frame("192.0.2.71:12345".parse().unwrap(), dst_addr); + let wrong_dst_port = test_frame(src_addr, "198.51.100.80:23457".parse().unwrap()); + for frame in [&wrong_src_port, &wrong_src_ip, &wrong_dst_port] { + test_tun.write_packet(&frame[ETH_HDR_LEN..])?; + } + + let mut received = BytesMut::new(); + assert!( + timeout(Duration::from_millis(400), tun.recv(&mut received)) + .await + .is_err(), + "packet outside the configured IPv4 tuple passed the filter" + ); + + let matching = test_frame(src_addr, dst_addr); + test_tun.write_packet(&matching[ETH_HDR_LEN..])?; + let mut received = BytesMut::new(); + timeout(Duration::from_secs(2), tun.recv(&mut received)) + .await + .expect("timed out waiting for matching IPv4 packet")?; + assert_eq!(&received[ETH_HDR_LEN..], &matching[ETH_HDR_LEN..]); + + Ok(()) + } + + #[tokio::test] + #[serial(linux_bpf_cooked)] + async fn linux_bpf_tun_receives_ipv6_from_l3_interface() -> io::Result<()> { + let test_name = "linux_bpf_tun_receives_ipv6_from_l3_interface"; + if !linux_bpf_integration_enabled(test_name) { + return Ok(()); + } + + let test_tun = TestTun::create()?; + let src_addr: SocketAddr = "[2001:db8::10]:12345".parse().unwrap(); + let dst_addr: SocketAddr = "[2001:db8::20]:23456".parse().unwrap(); + let frame = test_frame(src_addr, dst_addr); + let tun = LinuxBpfTun::new(&test_tun.name, None, dst_addr)?; + + test_tun.write_packet(&frame[ETH_HDR_LEN..])?; + + let mut received = BytesMut::new(); + timeout(Duration::from_secs(2), tun.recv(&mut received)) + .await + .expect("timed out waiting for IPv6 packet")?; + assert!(received[..12].iter().all(|byte| *byte == 0)); + assert_eq!(&received[12..14], &frame[12..14]); + assert_eq!(&received[ETH_HDR_LEN..], &frame[ETH_HDR_LEN..]); + + Ok(()) + } + + #[tokio::test] + #[serial(linux_bpf_cooked)] + async fn linux_bpf_tun_sends_ipv6_to_l3_interface() -> io::Result<()> { + let test_name = "linux_bpf_tun_sends_ipv6_to_l3_interface"; + if !linux_bpf_integration_enabled(test_name) { + return Ok(()); + } + + let test_tun = TestTun::create()?; + let src_addr: SocketAddr = "[2001:db8::30]:34567".parse().unwrap(); + let dst_addr: SocketAddr = "[2001:db8::40]:45678".parse().unwrap(); + let frame = test_frame(src_addr, dst_addr); + let tun = LinuxBpfTun::new(&test_tun.name, None, dst_addr)?; + + tun.try_send(&frame)?; + + let packet = test_tun.read_matching_packet(&frame[ETH_HDR_LEN..])?; + assert_eq!(packet, &frame[ETH_HDR_LEN..]); + + Ok(()) + } + + fn send_raw_frame(interface_name: &str, frame: &[u8]) -> io::Result<()> { + if frame.len() < ETH_HDR_LEN { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "frame too short", + )); + } + + let c_ifname = CString::new(interface_name) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid interface name"))?; + let ifindex = unsafe { libc::if_nametoindex(c_ifname.as_ptr()) as i32 }; + if ifindex <= 0 { + return Err(io::Error::new( + io::ErrorKind::NotFound, + "interface not found", + )); + } + + let frame_protocol = u16::from_be_bytes([frame[12], frame[13]]); + let proto = frame_protocol.to_be() as i32; + let fd = unsafe { libc::socket(libc::AF_PACKET, libc::SOCK_RAW, proto) }; + if fd < 0 { + return Err(io::Error::last_os_error()); + } + let fd = unsafe { OwnedFd::from_raw_fd(fd) }; + + let mut addr: libc::sockaddr_ll = unsafe { mem::zeroed() }; + addr.sll_family = libc::AF_PACKET as u16; + addr.sll_protocol = frame_protocol.to_be(); + addr.sll_ifindex = ifindex; + addr.sll_halen = 6; + addr.sll_addr[..6].copy_from_slice(&frame[..6]); + + let ret = unsafe { + libc::sendto( + fd.as_raw_fd(), + frame.as_ptr() as *const libc::c_void, + frame.len(), + 0, + &addr as *const _ as *const libc::sockaddr, + mem::size_of::() as u32, + ) + }; + if ret < 0 { + return Err(io::Error::last_os_error()); + } + + Ok(()) + } + + #[tokio::test] + #[serial(linux_bpf_cooked)] + async fn linux_bpf_tun_receives_matching_ipv4_frame() -> io::Result<()> { + let test_name = "linux_bpf_tun_receives_matching_ipv4_frame"; + if !linux_bpf_integration_enabled(test_name) { + return Ok(()); + } + + let veth = TestVeth::create()?; + let src_addr: SocketAddr = "192.0.2.90:12345".parse().unwrap(); + let dst_addr: SocketAddr = "198.51.100.100:23456".parse().unwrap(); + let tun = LinuxBpfTun::new(&veth.capture_name, None, dst_addr)?; + let frame = build_tcp_packet( + veth.sender_mac, + veth.capture_mac, + src_addr, + dst_addr, + 1, + 0, + TCP_FLAG_SYN, + Some(b"ping"), + ); + + send_raw_frame(&veth.sender_name, &frame)?; + + let mut received = BytesMut::new(); + let n = timeout(Duration::from_secs(2), tun.recv(&mut received)) + .await + .expect("timed out waiting for Ethernet packet")?; + assert_eq!(n, frame.len()); + assert!(received[..6].iter().all(|byte| *byte == 0)); + assert_eq!(&received[6..12], &frame[6..12]); + assert_eq!(&received[12..14], &frame[12..14]); + assert_eq!(&received[ETH_HDR_LEN..], &frame[ETH_HDR_LEN..]); + + Ok(()) + } + + #[tokio::test] + #[serial(linux_bpf_cooked)] + async fn linux_bpf_tun_filters_out_non_matching_ipv4_frame() -> io::Result<()> { + let test_name = "linux_bpf_tun_filters_out_non_matching_ipv4_frame"; + if !linux_bpf_integration_enabled(test_name) { + return Ok(()); + } + + let veth = TestVeth::create()?; + let src_addr: SocketAddr = "192.0.2.110:12345".parse().unwrap(); + let dst_addr: SocketAddr = "198.51.100.120:23456".parse().unwrap(); + let non_matching_dst: SocketAddr = "198.51.100.120:23457".parse().unwrap(); + let tun = LinuxBpfTun::new(&veth.capture_name, None, dst_addr)?; + let non_matching = build_tcp_packet( + veth.sender_mac, + veth.capture_mac, + src_addr, + non_matching_dst, + 1, + 0, + TCP_FLAG_SYN, + Some(b"nope"), + ); + send_raw_frame(&veth.sender_name, &non_matching)?; + + let mut received = BytesMut::new(); + assert!( + timeout(Duration::from_millis(400), tun.recv(&mut received)) + .await + .is_err() + ); + + let matching = build_tcp_packet( + veth.sender_mac, + veth.capture_mac, + src_addr, + dst_addr, + 2, + 0, + TCP_FLAG_SYN, + Some(b"ok"), + ); + send_raw_frame(&veth.sender_name, &matching)?; + + let mut received = BytesMut::new(); + let n = timeout(Duration::from_secs(2), tun.recv(&mut received)) + .await + .expect("timed out waiting for matching Ethernet packet")?; + assert_eq!(n, matching.len()); + assert_eq!(&received[ETH_HDR_LEN..], &matching[ETH_HDR_LEN..]); + + Ok(()) + } + + #[tokio::test] + #[serial(linux_bpf_cooked)] + async fn linux_bpf_tun_sends_ipv4_frame_to_ethernet_interface() -> io::Result<()> { + let test_name = "linux_bpf_tun_sends_ipv4_frame_to_ethernet_interface"; + if !linux_bpf_integration_enabled(test_name) { + return Ok(()); + } + + let veth = TestVeth::create()?; + let (_sender, mut receiver) = open_datalink_channel(&veth.sender_name)?; + let src_addr: SocketAddr = "192.0.2.130:12345".parse().unwrap(); + let dst_addr: SocketAddr = "198.51.100.140:23456".parse().unwrap(); + let frame = build_tcp_packet( + veth.capture_mac, + veth.sender_mac, + src_addr, + dst_addr, + 1, + 0, + TCP_FLAG_SYN, + Some(b"ethernet send"), + ); + let tun = LinuxBpfTun::new(&veth.capture_name, None, dst_addr)?; + + tun.try_send(&frame)?; + + let deadline = Instant::now() + Duration::from_secs(2); + loop { + match receiver.next() { + Ok(received) + if received.len() >= ETH_HDR_LEN + && received[ETH_HDR_LEN..] == frame[ETH_HDR_LEN..] => + { + assert_eq!(&received[..ETH_HDR_LEN], &frame[..ETH_HDR_LEN]); + break; + } + Ok(_) => {} + Err(error) + if matches!( + error.kind(), + io::ErrorKind::Interrupted + | io::ErrorKind::TimedOut + | io::ErrorKind::WouldBlock + ) => {} + Err(error) => return Err(error), + } + if Instant::now() >= deadline { + return Err(io::Error::new( + io::ErrorKind::TimedOut, + "timed out waiting for Ethernet frame", + )); + } + } + + Ok(()) + } +} diff --git a/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/macos_bpf.rs b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/macos_bpf.rs new file mode 100644 index 0000000..987717d --- /dev/null +++ b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/macos_bpf.rs @@ -0,0 +1,1122 @@ +use bytes::Bytes; +use bytes::BytesMut; +use nix::libc; +use std::ffi::CString; +use std::io; +use std::mem; +use std::net::IpAddr; +use std::net::SocketAddr; +use std::os::fd::{AsRawFd, FromRawFd, OwnedFd}; +use std::sync::Arc; +use std::sync::atomic::{AtomicBool, Ordering as AtomicOrdering}; +use tokio::sync::Mutex; +use tracing::{debug, info, warn}; + +use crate::socket::fake_tcp::stack; + +const ETH_HDR_LEN: usize = 14; +const ETH_TYPE_OFFSET: u32 = 12; +const ETHERTYPE_IPV4: u32 = 0x0800; +const ETHERTYPE_IPV6: u32 = 0x86DD; +const IPPROTO_TCP_U32: u32 = 6; + +const DLT_EN10MB: u32 = 1; +const DLT_NULL: u32 = 4; +const DLT_RAW: u32 = 12; +const DLT_LOOP: u32 = 108; + +const BPF_LD: u16 = 0x00; +const BPF_LDX: u16 = 0x01; +const BPF_JMP: u16 = 0x05; +const BPF_RET: u16 = 0x06; + +const BPF_W: u16 = 0x00; +const BPF_H: u16 = 0x08; +const BPF_B: u16 = 0x10; + +const BPF_ABS: u16 = 0x20; +const BPF_IND: u16 = 0x40; +const BPF_MSH: u16 = 0xa0; + +const BPF_JA: u16 = 0x00; +const BPF_JEQ: u16 = 0x10; + +const BPF_K: u16 = 0x00; + +const BPF_GROUP: u8 = b'B'; + +const BIOCGBLEN_NUM: u8 = 102; +const BIOCSBLEN_NUM: u8 = 102; +const BIOCSETF_NUM: u8 = 103; +const BIOCFLUSH_NUM: u8 = 104; +const BIOCGDLT_NUM: u8 = 106; +const BIOCSETIF_NUM: u8 = 108; +const BIOCSRTIMEOUT_NUM: u8 = 109; +const BIOCIMMEDIATE_NUM: u8 = 112; +const BIOCSHDRCMPLT_NUM: u8 = 117; +const BIOCSSEESENT_NUM: u8 = 119; + +const IOCPARM_MASK: u32 = 0x1fff; +const IOC_VOID: u32 = 0x2000_0000; +const IOC_OUT: u32 = 0x4000_0000; +const IOC_IN: u32 = 0x8000_0000; +const IOC_INOUT: u32 = IOC_IN | IOC_OUT; + +#[derive(Clone, Copy)] +enum LinkType { + En10Mb, + Null, + Raw, + Loop, + Utun, +} + +impl LinkType { + fn from_dlt(dlt: u32) -> Option { + match dlt { + DLT_EN10MB => Some(Self::En10Mb), + DLT_NULL => Some(Self::Null), + DLT_RAW => Some(Self::Raw), + DLT_LOOP => Some(Self::Loop), + _ => None, + } + } +} + +fn looks_like_ip(packet: &[u8]) -> bool { + matches!(packet.first().map(|b| b >> 4), Some(4 | 6)) +} + +fn maybe_unwrap_utun_payload(packet: &[u8]) -> Option<&[u8]> { + if looks_like_ip(packet) { + return Some(packet); + } + if packet.len() < 5 { + return None; + } + let payload = &packet[4..]; + if !looks_like_ip(payload) { + return None; + } + Some(payload) +} + +fn ether_type_from_ip_packet(ip: &[u8]) -> Option { + let v = *ip.first()?; + match v >> 4 { + 4 => Some(0x0800), + 6 => Some(0x86DD), + _ => None, + } +} + +fn wrap_ip_with_ethernet(ip: &[u8]) -> Option> { + let ether_type = ether_type_from_ip_packet(ip)?; + let mut out = vec![0u8; ETH_HDR_LEN + ip.len()]; + out[12..14].copy_from_slice(ðer_type.to_be_bytes()); + out[ETH_HDR_LEN..].copy_from_slice(ip); + Some(out) +} + +fn family_word_for_null(family: u32) -> u32 { + u32::from_be_bytes(family.to_ne_bytes()) +} + +#[repr(C)] +#[derive(Clone, Copy)] +struct BpfInsn { + code: u16, + jt: u8, + jf: u8, + k: u32, +} + +#[repr(C)] +struct BpfProgram { + bf_len: u32, + bf_insns: *mut BpfInsn, +} + +fn read_u16_ne(bytes: &[u8]) -> u16 { + u16::from_ne_bytes([bytes[0], bytes[1]]) +} + +fn read_u32_ne(bytes: &[u8]) -> u32 { + u32::from_ne_bytes([bytes[0], bytes[1], bytes[2], bytes[3]]) +} + +fn bpf_word_align_with(align: usize, x: usize) -> usize { + (x + (align - 1)) & !(align - 1) +} + +fn parse_bpf_record(buf: &[u8], align: usize) -> Option<(usize, std::ops::Range, u16, u32)> { + let max_shift = std::cmp::min(align, buf.len()); + for shift in 0..max_shift { + let rest = &buf[shift..]; + + let try_ts8 = || -> Option<(usize, std::ops::Range, u16, u32)> { + let base_hdr_len = 18usize; + if rest.len() < base_hdr_len { + return None; + } + let caplen = read_u32_ne(rest.get(8..12)?) as usize; + let datalen = read_u32_ne(rest.get(12..16)?) as usize; + let hdrlen = read_u16_ne(rest.get(16..18)?) as usize; + if hdrlen < base_hdr_len || hdrlen > 512 { + return None; + } + if caplen > datalen { + return None; + } + let pkt_start = shift + hdrlen; + let pkt_end = pkt_start.checked_add(caplen)?; + if pkt_end > buf.len() { + return None; + } + let advance = shift + bpf_word_align_with(align, hdrlen + caplen); + Some((advance, pkt_start..pkt_end, hdrlen as u16, caplen as u32)) + }; + + if let Some(v) = try_ts8() { + return Some(v); + } + + let try_ts16 = || -> Option<(usize, std::ops::Range, u16, u32)> { + let base_hdr_len = 26usize; + if rest.len() < base_hdr_len { + return None; + } + let caplen = read_u32_ne(rest.get(16..20)?) as usize; + let datalen = read_u32_ne(rest.get(20..24)?) as usize; + let hdrlen = read_u16_ne(rest.get(24..26)?) as usize; + if hdrlen < base_hdr_len || hdrlen > 512 { + return None; + } + if caplen > datalen { + return None; + } + let pkt_start = shift + hdrlen; + let pkt_end = pkt_start.checked_add(caplen)?; + if pkt_end > buf.len() { + return None; + } + let advance = shift + bpf_word_align_with(align, hdrlen + caplen); + Some((advance, pkt_start..pkt_end, hdrlen as u16, caplen as u32)) + }; + + if let Some(v) = try_ts16() { + return Some(v); + } + } + None +} + +fn ioc(inout: u32, group: u8, num: u8, len: u32) -> libc::c_ulong { + (inout | ((len & IOCPARM_MASK) << 16) | ((group as u32) << 8) | (num as u32)) as libc::c_ulong +} + +fn io(group: u8, num: u8) -> libc::c_ulong { + ioc(IOC_VOID, group, num, 0) +} + +fn ior(group: u8, num: u8) -> libc::c_ulong { + ioc(IOC_OUT, group, num, mem::size_of::() as u32) +} + +fn iow(group: u8, num: u8) -> libc::c_ulong { + ioc(IOC_IN, group, num, mem::size_of::() as u32) +} + +fn iowr(group: u8, num: u8) -> libc::c_ulong { + ioc(IOC_INOUT, group, num, mem::size_of::() as u32) +} + +unsafe fn ioctl_ptr(fd: libc::c_int, req: libc::c_ulong, arg: *mut T) -> io::Result<()> { + let ret = libc::ioctl(fd, req, arg); + if ret < 0 { + return Err(io::Error::last_os_error()); + } + Ok(()) +} + +unsafe fn ioctl_void(fd: libc::c_int, req: libc::c_ulong) -> io::Result<()> { + let ret = libc::ioctl(fd, req); + if ret < 0 { + return Err(io::Error::last_os_error()); + } + Ok(()) +} + +fn stmt(code: u16, k: u32) -> BpfInsn { + BpfInsn { + code, + jt: 0, + jf: 0, + k, + } +} + +fn jeq(k: u32, jt: u8, jf: u8) -> BpfInsn { + BpfInsn { + code: BPF_JMP | BPF_JEQ | BPF_K, + jt, + jf, + k, + } +} + +fn ja(k: u32) -> BpfInsn { + BpfInsn { + code: BPF_JMP | BPF_JA, + jt: 0, + jf: 0, + k, + } +} + +#[derive(Clone, Copy)] +struct Label(usize); + +struct JeqPatch { + idx: usize, + t: Label, + f: Label, +} + +struct JaPatch { + idx: usize, + target: Label, +} + +struct BpfBuilder { + insns: Vec, + labels: Vec>, + jeq_patches: Vec, + ja_patches: Vec, +} + +impl BpfBuilder { + fn new() -> Self { + Self { + insns: Vec::new(), + labels: Vec::new(), + jeq_patches: Vec::new(), + ja_patches: Vec::new(), + } + } + + fn new_label(&mut self) -> Label { + let idx = self.labels.len(); + self.labels.push(None); + Label(idx) + } + + fn set_label(&mut self, label: Label) { + self.labels[label.0] = Some(self.insns.len()); + } + + fn push(&mut self, insn: BpfInsn) { + self.insns.push(insn); + } + + fn push_jeq(&mut self, k: u32, t: Label, f: Label) { + let idx = self.insns.len(); + self.insns.push(jeq(k, 0, 0)); + self.jeq_patches.push(JeqPatch { idx, t, f }); + } + + fn push_ja(&mut self, target: Label) { + let idx = self.insns.len(); + self.insns.push(ja(0)); + self.ja_patches.push(JaPatch { idx, target }); + } + + fn finish(mut self) -> io::Result> { + for patch in self.jeq_patches { + let JeqPatch { idx, t, f } = patch; + let cur = idx + 1; + let t_pos = + self.labels.get(t.0).and_then(|v| *v).ok_or_else(|| { + io::Error::new(io::ErrorKind::InvalidInput, "unresolved label") + })?; + let f_pos = + self.labels.get(f.0).and_then(|v| *v).ok_or_else(|| { + io::Error::new(io::ErrorKind::InvalidInput, "unresolved label") + })?; + + if t_pos < cur || f_pos < cur { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "backward bpf jump", + )); + } + + let jt: u8 = (t_pos - cur) + .try_into() + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "bpf jump too far"))?; + let jf: u8 = (f_pos - cur) + .try_into() + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "bpf jump too far"))?; + + self.insns[idx].jt = jt; + self.insns[idx].jf = jf; + } + + for patch in self.ja_patches { + let JaPatch { idx, target } = patch; + let cur = idx + 1; + let t_pos = + self.labels.get(target.0).and_then(|v| *v).ok_or_else(|| { + io::Error::new(io::ErrorKind::InvalidInput, "unresolved label") + })?; + if t_pos < cur { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "backward bpf jump", + )); + } + self.insns[idx].k = (t_pos - cur) as u32; + } + + Ok(self.insns) + } +} + +fn build_tcp_filter_ethernet( + src_addr: Option, + dst_addr: SocketAddr, +) -> io::Result> { + if let Some(src) = src_addr { + if src.is_ipv4() != dst_addr.is_ipv4() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "src/dst addr family mismatch", + )); + } + } + + let mut b = BpfBuilder::new(); + let l_check_ipv6 = b.new_label(); + let l_ipv4 = b.new_label(); + let l_ipv6 = b.new_label(); + let l_accept = b.new_label(); + let l_reject = b.new_label(); + + b.push(stmt(BPF_LD | BPF_H | BPF_ABS, ETH_TYPE_OFFSET)); + b.push_jeq(ETHERTYPE_IPV4, l_ipv4, l_check_ipv6); + + b.set_label(l_check_ipv6); + b.push_jeq(ETHERTYPE_IPV6, l_ipv6, l_reject); + + if dst_addr.is_ipv4() { + b.set_label(l_ipv4); + let l_v4_proto_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_B | BPF_ABS, (ETH_HDR_LEN + 9) as u32)); + b.push_jeq(IPPROTO_TCP_U32, l_v4_proto_ok, l_reject); + + b.set_label(l_v4_proto_ok); + let dst_ip = match dst_addr.ip() { + IpAddr::V4(ip) => u32::from(ip), + _ => unreachable!(), + }; + let l_v4_dstip_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, (ETH_HDR_LEN + 16) as u32)); + b.push_jeq(dst_ip, l_v4_dstip_ok, l_reject); + + b.set_label(l_v4_dstip_ok); + if let Some(src) = src_addr { + let src_ip = match src.ip() { + IpAddr::V4(ip) => u32::from(ip), + _ => unreachable!(), + }; + let l_v4_srcip_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, (ETH_HDR_LEN + 12) as u32)); + b.push_jeq(src_ip, l_v4_srcip_ok, l_reject); + b.set_label(l_v4_srcip_ok); + } + + b.push(stmt(BPF_LDX | BPF_B | BPF_MSH, ETH_HDR_LEN as u32)); + + let l_v4_dstport_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_H | BPF_IND, (ETH_HDR_LEN + 2) as u32)); + b.push_jeq(dst_addr.port() as u32, l_v4_dstport_ok, l_reject); + + b.set_label(l_v4_dstport_ok); + if let Some(src) = src_addr { + b.push(stmt(BPF_LD | BPF_H | BPF_IND, ETH_HDR_LEN as u32)); + b.push_jeq(src.port() as u32, l_accept, l_reject); + } else { + b.push_ja(l_accept); + } + } else { + b.set_label(l_ipv6); + let l_v6_proto_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_B | BPF_ABS, (ETH_HDR_LEN + 6) as u32)); + b.push_jeq(IPPROTO_TCP_U32, l_v6_proto_ok, l_reject); + + b.set_label(l_v6_proto_ok); + let dst_ip = match dst_addr.ip() { + IpAddr::V6(ip) => ip.octets(), + _ => unreachable!(), + }; + for (i, chunk) in dst_ip.chunks_exact(4).enumerate() { + let off = ETH_HDR_LEN + 24 + (i * 4); + let v = u32::from_be_bytes(chunk.try_into().unwrap()); + let l_v6_dstip_word_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, off as u32)); + b.push_jeq(v, l_v6_dstip_word_ok, l_reject); + b.set_label(l_v6_dstip_word_ok); + } + + if let Some(src) = src_addr { + let src_ip = match src.ip() { + IpAddr::V6(ip) => ip.octets(), + _ => unreachable!(), + }; + for (i, chunk) in src_ip.chunks_exact(4).enumerate() { + let off = ETH_HDR_LEN + 8 + (i * 4); + let v = u32::from_be_bytes(chunk.try_into().unwrap()); + let l_v6_srcip_word_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, off as u32)); + b.push_jeq(v, l_v6_srcip_word_ok, l_reject); + b.set_label(l_v6_srcip_word_ok); + } + } + + let l_v6_dstport_ok = b.new_label(); + b.push(stmt( + BPF_LD | BPF_H | BPF_ABS, + (ETH_HDR_LEN + 40 + 2) as u32, + )); + b.push_jeq(dst_addr.port() as u32, l_v6_dstport_ok, l_reject); + + b.set_label(l_v6_dstport_ok); + if let Some(src) = src_addr { + b.push(stmt(BPF_LD | BPF_H | BPF_ABS, (ETH_HDR_LEN + 40) as u32)); + b.push_jeq(src.port() as u32, l_accept, l_reject); + } else { + b.push_ja(l_accept); + } + } + + b.set_label(l_accept); + b.push(stmt(BPF_RET | BPF_K, 0xFFFF)); + + b.set_label(l_reject); + if dst_addr.is_ipv4() { + b.set_label(l_ipv6); + } else { + b.set_label(l_ipv4); + } + b.push(stmt(BPF_RET | BPF_K, 0)); + + b.finish() +} + +fn build_tcp_filter_ip( + base: u32, + src_addr: Option, + dst_addr: SocketAddr, + family_word: Option, +) -> io::Result> { + if let Some(src) = src_addr { + if src.is_ipv4() != dst_addr.is_ipv4() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "src/dst addr family mismatch", + )); + } + } + + let mut b = BpfBuilder::new(); + let l_accept = b.new_label(); + let l_reject = b.new_label(); + + if let Some(family_word) = family_word { + let l_family_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, 0)); + b.push_jeq(family_word, l_family_ok, l_reject); + b.set_label(l_family_ok); + } + + if dst_addr.is_ipv4() { + let l_v4_proto_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_B | BPF_ABS, base + 9)); + b.push_jeq(IPPROTO_TCP_U32, l_v4_proto_ok, l_reject); + + b.set_label(l_v4_proto_ok); + let dst_ip = match dst_addr.ip() { + IpAddr::V4(ip) => u32::from(ip), + _ => unreachable!(), + }; + let l_v4_dstip_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, base + 16)); + b.push_jeq(dst_ip, l_v4_dstip_ok, l_reject); + + b.set_label(l_v4_dstip_ok); + if let Some(src) = src_addr { + let src_ip = match src.ip() { + IpAddr::V4(ip) => u32::from(ip), + _ => unreachable!(), + }; + let l_v4_srcip_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, base + 12)); + b.push_jeq(src_ip, l_v4_srcip_ok, l_reject); + b.set_label(l_v4_srcip_ok); + } + + b.push(stmt(BPF_LDX | BPF_B | BPF_MSH, base)); + + let l_v4_dstport_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_H | BPF_IND, base + 2)); + b.push_jeq(dst_addr.port() as u32, l_v4_dstport_ok, l_reject); + + b.set_label(l_v4_dstport_ok); + if let Some(src) = src_addr { + b.push(stmt(BPF_LD | BPF_H | BPF_IND, base)); + b.push_jeq(src.port() as u32, l_accept, l_reject); + } else { + b.push_ja(l_accept); + } + } else { + let l_v6_proto_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_B | BPF_ABS, base + 6)); + b.push_jeq(IPPROTO_TCP_U32, l_v6_proto_ok, l_reject); + + b.set_label(l_v6_proto_ok); + let dst_ip = match dst_addr.ip() { + IpAddr::V6(ip) => ip.octets(), + _ => unreachable!(), + }; + for (i, chunk) in dst_ip.chunks_exact(4).enumerate() { + let off = base + 24 + (i * 4) as u32; + let v = u32::from_be_bytes(chunk.try_into().unwrap()); + let l_v6_dstip_word_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, off)); + b.push_jeq(v, l_v6_dstip_word_ok, l_reject); + b.set_label(l_v6_dstip_word_ok); + } + + if let Some(src) = src_addr { + let src_ip = match src.ip() { + IpAddr::V6(ip) => ip.octets(), + _ => unreachable!(), + }; + for (i, chunk) in src_ip.chunks_exact(4).enumerate() { + let off = base + 8 + (i * 4) as u32; + let v = u32::from_be_bytes(chunk.try_into().unwrap()); + let l_v6_srcip_word_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_W | BPF_ABS, off)); + b.push_jeq(v, l_v6_srcip_word_ok, l_reject); + b.set_label(l_v6_srcip_word_ok); + } + } + + let l_v6_dstport_ok = b.new_label(); + b.push(stmt(BPF_LD | BPF_H | BPF_ABS, base + 40 + 2)); + b.push_jeq(dst_addr.port() as u32, l_v6_dstport_ok, l_reject); + + b.set_label(l_v6_dstport_ok); + if let Some(src) = src_addr { + b.push(stmt(BPF_LD | BPF_H | BPF_ABS, base + 40)); + b.push_jeq(src.port() as u32, l_accept, l_reject); + } else { + b.push_ja(l_accept); + } + } + + b.set_label(l_accept); + b.push(stmt(BPF_RET | BPF_K, 0xFFFF)); + + b.set_label(l_reject); + b.push(stmt(BPF_RET | BPF_K, 0)); + + b.finish() +} + +fn build_tcp_filter_utun( + src_addr: Option, + dst_addr: SocketAddr, +) -> io::Result> { + let raw = build_tcp_filter_ip(0, src_addr, dst_addr, None)?; + + let family = if dst_addr.is_ipv4() { + libc::AF_INET as u32 + } else { + libc::AF_INET6 as u32 + }; + let family_hdr = + build_tcp_filter_ip(4, src_addr, dst_addr, Some(family_word_for_null(family)))?; + + if raw.is_empty() { + return Ok(family_hdr); + } + + let mut combined = raw; + if let Some(last) = combined.last_mut() { + if last.code == (BPF_RET | BPF_K) && last.k == 0 { + *last = ja(0); + } else { + combined.push(ja(0)); + } + } + combined.extend(family_hdr); + Ok(combined) +} + +fn build_tcp_filter( + link_type: LinkType, + src_addr: Option, + dst_addr: SocketAddr, +) -> io::Result> { + match link_type { + LinkType::En10Mb => build_tcp_filter_ethernet(src_addr, dst_addr), + LinkType::Raw => build_tcp_filter_ip(0, src_addr, dst_addr, None), + LinkType::Null => { + let family = if dst_addr.is_ipv4() { + libc::AF_INET as u32 + } else { + libc::AF_INET6 as u32 + }; + build_tcp_filter_ip(4, src_addr, dst_addr, Some(family_word_for_null(family))) + } + LinkType::Loop => { + let family = if dst_addr.is_ipv4() { + libc::AF_INET as u32 + } else { + libc::AF_INET6 as u32 + }; + build_tcp_filter_ip(4, src_addr, dst_addr, Some(family)) + } + LinkType::Utun => build_tcp_filter_utun(src_addr, dst_addr), + } +} + +fn open_bpf_device() -> io::Result { + let mut last_err: Option = None; + for i in 0..256 { + let path = format!("/dev/bpf{}", i); + let c_path = CString::new(path.as_str()) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "path"))?; + let fd = unsafe { libc::open(c_path.as_ptr(), libc::O_RDWR) }; + if fd >= 0 { + debug!(path, "opened bpf device"); + return Ok(unsafe { OwnedFd::from_raw_fd(fd) }); + } + let err = io::Error::last_os_error(); + if err.raw_os_error() == Some(libc::EBUSY) { + last_err = Some(err); + continue; + } + last_err = Some(err); + } + Err(last_err + .unwrap_or_else(|| io::Error::new(io::ErrorKind::NotFound, "no available /dev/bpf device"))) +} + +fn set_ifreq_name(ifr: &mut libc::ifreq, interface_name: &str) -> io::Result<()> { + let bytes = interface_name.as_bytes(); + let ifnamsiz = libc::IFNAMSIZ; + if bytes.len() >= ifnamsiz { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "interface name too long", + )); + } + for i in 0..ifnamsiz { + ifr.ifr_name[i] = 0; + } + for (i, &b) in bytes.iter().enumerate() { + ifr.ifr_name[i] = b as libc::c_char; + } + Ok(()) +} + +pub struct MacosBpfTun { + fd: OwnedFd, + link_type: LinkType, + stop: Arc, + worker: Option>, + recv_queue: Mutex>>, +} + +impl MacosBpfTun { + pub fn new( + interface_name: &str, + src_addr: Option, + dst_addr: SocketAddr, + ) -> io::Result { + let fd = open_bpf_device()?; + let raw_fd = fd.as_raw_fd(); + + let mut buf_len: libc::c_uint = 0; + unsafe { + ioctl_ptr( + raw_fd, + ior::(BPF_GROUP, BIOCGBLEN_NUM), + &mut buf_len, + ) + }?; + if buf_len == 0 { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "bpf buffer length is zero", + )); + } + + let mut desired_buf_len: libc::c_uint = buf_len; + let _ = unsafe { + ioctl_ptr( + raw_fd, + iowr::(BPF_GROUP, BIOCSBLEN_NUM), + &mut desired_buf_len, + ) + }; + + let mut immediate: libc::c_uint = 1; + unsafe { + ioctl_ptr( + raw_fd, + iow::(BPF_GROUP, BIOCIMMEDIATE_NUM), + &mut immediate, + ) + }?; + + let mut seesent: libc::c_uint = 0; + unsafe { + ioctl_ptr( + raw_fd, + iow::(BPF_GROUP, BIOCSSEESENT_NUM), + &mut seesent, + ) + }?; + + let mut hdr_complete: libc::c_uint = 1; + match unsafe { + ioctl_ptr( + raw_fd, + iow::(BPF_GROUP, BIOCSHDRCMPLT_NUM), + &mut hdr_complete, + ) + } { + Ok(()) => {} + Err(e) if e.raw_os_error() == Some(libc::EINVAL) => {} + Err(e) => return Err(e), + } + + let timeout = libc::timeval { + tv_sec: 0, + tv_usec: 200_000, + }; + let mut timeout_mut = timeout; + unsafe { + ioctl_ptr( + raw_fd, + iow::(BPF_GROUP, BIOCSRTIMEOUT_NUM), + &mut timeout_mut, + ) + }?; + + unsafe { ioctl_void(raw_fd, io(BPF_GROUP, BIOCFLUSH_NUM)) }?; + + let mut ifr: libc::ifreq = unsafe { mem::zeroed() }; + set_ifreq_name(&mut ifr, interface_name)?; + unsafe { + ioctl_ptr( + raw_fd, + iow::(BPF_GROUP, BIOCSETIF_NUM), + &mut ifr, + ) + }?; + + let mut dlt: libc::c_uint = 0; + unsafe { + ioctl_ptr( + raw_fd, + ior::(BPF_GROUP, BIOCGDLT_NUM), + &mut dlt, + ) + }?; + + let link_type = if interface_name.starts_with("utun") { + LinkType::Utun + } else { + LinkType::from_dlt(dlt as u32).ok_or_else(|| { + io::Error::new( + io::ErrorKind::InvalidInput, + format!("unsupported datalink type {}", dlt), + ) + })? + }; + + let filter = build_tcp_filter(link_type, src_addr, dst_addr)?; + + let mut bpf_insns: Vec = filter; + let mut prog = BpfProgram { + bf_len: bpf_insns + .len() + .try_into() + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "bpf program too long"))?, + bf_insns: bpf_insns.as_mut_ptr(), + }; + unsafe { + ioctl_ptr( + raw_fd, + iow::(BPF_GROUP, BIOCSETF_NUM), + &mut prog, + ) + }?; + + info!( + interface_name, + ?src_addr, + ?dst_addr, + dlt, + link_type = match link_type { + LinkType::En10Mb => "en10mb", + LinkType::Null => "null", + LinkType::Raw => "raw", + LinkType::Loop => "loop", + LinkType::Utun => "utun", + }, + filter_len = bpf_insns.len(), + buf_len, + desired_buf_len, + "MacosBpfTun created" + ); + + let stop = Arc::new(AtomicBool::new(false)); + let (tx, rx) = tokio::sync::mpsc::channel(1024); + let stop_clone = stop.clone(); + let read_fd = raw_fd; + let worker_link_type = link_type; + let worker = std::thread::spawn(move || { + let mut buf = vec![0u8; desired_buf_len as usize]; + let mut wrap_fail_logs_left: u8 = 5; + let mut bad_record_logs_left: u8 = 8; + let mut shifted_record_logs_left: u8 = 8; + let align = mem::size_of::(); + while !stop_clone.load(AtomicOrdering::Relaxed) { + let n = unsafe { + libc::read(read_fd, buf.as_mut_ptr() as *mut libc::c_void, buf.len()) + }; + if n < 0 { + let err = io::Error::last_os_error(); + if matches!( + err.kind(), + io::ErrorKind::Interrupted | io::ErrorKind::WouldBlock + ) { + continue; + } + warn!(?err, "MacosBpfTun bpf read failed"); + break; + } + if n == 0 { + continue; + } + let mut off = 0usize; + let n = n as usize; + while off < n { + let window = &buf[off..n]; + let Some((advance, pkt_range, hdr_len, cap_len)) = + parse_bpf_record(window, align) + else { + if bad_record_logs_left > 0 { + bad_record_logs_left -= 1; + let preview_len = std::cmp::min(window.len(), 48); + let preview = &window[..preview_len]; + warn!(off, read_len = n, preview = ?preview, "MacosBpfTun failed to parse bpf records"); + } + break; + }; + + let pkt_start = off + pkt_range.start; + let pkt_end = off + pkt_range.end; + let shift = pkt_range.start.saturating_sub(hdr_len as usize); + if shift != 0 && shifted_record_logs_left > 0 { + shifted_record_logs_left -= 1; + warn!( + off, + record_start = off + shift, + shift, + hdr_len, + cap_len, + read_len = n, + "MacosBpfTun parsed bpf record with non-zero offset" + ); + } + + let packet = &buf[pkt_start..pkt_end]; + let framed = match worker_link_type { + LinkType::En10Mb => Some(packet.to_vec()), + LinkType::Raw => wrap_ip_with_ethernet(packet), + LinkType::Null | LinkType::Loop => { + if packet.len() < 4 { + None + } else { + wrap_ip_with_ethernet(&packet[4..]) + } + } + LinkType::Utun => { + maybe_unwrap_utun_payload(packet).and_then(wrap_ip_with_ethernet) + } + }; + if let Some(framed) = framed { + if tx.blocking_send(framed).is_err() { + return; + } + } else if wrap_fail_logs_left > 0 { + wrap_fail_logs_left -= 1; + warn!( + link_type = match worker_link_type { + LinkType::En10Mb => "en10mb", + LinkType::Null => "null", + LinkType::Raw => "raw", + LinkType::Loop => "loop", + LinkType::Utun => "utun", + }, + packet_len = packet.len(), + "MacosBpfTun failed to wrap packet" + ); + } + if advance == 0 { + break; + } + off = off.saturating_add(advance); + } + } + }); + + Ok(Self { + fd, + link_type, + stop, + worker: Some(worker), + recv_queue: Mutex::new(rx), + }) + } +} + +impl Drop for MacosBpfTun { + fn drop(&mut self) { + self.stop.store(true, AtomicOrdering::Relaxed); + if let Some(worker) = self.worker.take() { + let _ = worker.join(); + } + } +} + +#[async_trait::async_trait] +impl stack::Tun for MacosBpfTun { + async fn recv(&self, packet: &mut BytesMut) -> Result { + let mut rx = self.recv_queue.lock().await; + match rx.recv().await { + Some(data) => { + packet.extend_from_slice(&data); + Ok(data.len()) + } + None => Err(std::io::Error::new( + std::io::ErrorKind::BrokenPipe, + "MacosBpfTun channel closed", + )), + } + } + + #[tracing::instrument(ret, skip(self))] + fn try_send(&self, packet: &Bytes) -> Result<(), std::io::Error> { + if packet.len() < ETH_HDR_LEN { + return Err(std::io::Error::new( + std::io::ErrorKind::InvalidData, + "packet too short", + )); + } + let payload = &packet[ETH_HDR_LEN..]; + let write_all = |ptr: *const u8, len: usize| -> Result<(), std::io::Error> { + let ret = unsafe { libc::write(self.fd.as_raw_fd(), ptr as *const libc::c_void, len) }; + if ret < 0 { + return Err(std::io::Error::last_os_error()); + } + Ok(()) + }; + + let mut out_len: usize; + let res = match self.link_type { + LinkType::En10Mb => { + out_len = packet.len(); + write_all(packet.as_ptr(), packet.len()) + } + LinkType::Raw => { + out_len = payload.len(); + write_all(payload.as_ptr(), payload.len()) + } + LinkType::Null | LinkType::Loop | LinkType::Utun => { + let family = match payload.first().map(|b| b >> 4) { + Some(4) => libc::AF_INET as u32, + Some(6) => libc::AF_INET6 as u32, + _ => { + warn!( + first_byte = payload.first().copied(), + payload_len = payload.len(), + "MacosBpfTun try_send invalid ip version" + ); + return Err(std::io::Error::new( + std::io::ErrorKind::InvalidData, + "invalid ip version", + )); + } + }; + + let primary_hdr = match self.link_type { + LinkType::Null => family.to_ne_bytes(), + LinkType::Loop => family.to_be_bytes(), + LinkType::Utun => family.to_ne_bytes(), + _ => unreachable!(), + }; + + let mut out = vec![0u8; 4 + payload.len()]; + out[..4].copy_from_slice(&primary_hdr); + out[4..].copy_from_slice(payload); + out_len = out.len(); + + match write_all(out.as_ptr(), out.len()) { + Ok(()) => Ok(()), + Err(e) + if matches!(self.link_type, LinkType::Utun) + && e.raw_os_error() == Some(libc::EINVAL) + && primary_hdr != family.to_be_bytes() => + { + let mut out = vec![0u8; 4 + payload.len()]; + out[..4].copy_from_slice(&family.to_be_bytes()); + out[4..].copy_from_slice(payload); + out_len = out.len(); + write_all(out.as_ptr(), out.len()) + } + Err(e) => Err(e), + } + } + }; + + if let Err(err) = res { + warn!( + ?err, + link_type = match self.link_type { + LinkType::En10Mb => "en10mb", + LinkType::Null => "null", + LinkType::Raw => "raw", + LinkType::Loop => "loop", + LinkType::Utun => "utun", + }, + in_len = packet.len(), + out_len, + "MacosBpfTun bpf write failed" + ); + return Err(err); + } + + Ok(()) + } + + fn driver_type(&self) -> &'static str { + "macos_bpf" + } +} diff --git a/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/mod.rs b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/mod.rs new file mode 100644 index 0000000..9817bfb --- /dev/null +++ b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/mod.rs @@ -0,0 +1,93 @@ +pub mod pnet; + +use std::{io, net::SocketAddr, sync::Arc}; + +cfg_select! { + target_os = "linux" => { + pub mod linux_bpf; + + pub fn create_tun( + interface_name: &str, + src_addr: Option, + dst_addr: SocketAddr, + ) -> io::Result> { + match linux_bpf::LinuxBpfTun::new(interface_name, src_addr, dst_addr) { + Ok(tun) => Ok(Arc::new(tun)), + Err(e) => { + tracing::warn!( + ?e, + interface_name, + "LinuxBpfTun init failed, falling back to PnetTun" + ); + Ok(Arc::new(pnet::PnetTun::new( + interface_name, + pnet::create_packet_filter(src_addr, dst_addr), + )?)) + } + } + } + } + + all(target_os = "macos", not(feature = "macos-ne")) => { + pub mod macos_bpf; + + pub fn create_tun( + interface_name: &str, + src_addr: Option, + dst_addr: SocketAddr, + ) -> io::Result> { + match macos_bpf::MacosBpfTun::new(interface_name, src_addr, dst_addr) { + Ok(tun) => Ok(Arc::new(tun)), + Err(e) => { + tracing::warn!( + ?e, + interface_name, + "MacosBpfTun init failed, falling back to PnetTun" + ); + Ok(Arc::new(pnet::PnetTun::new( + interface_name, + pnet::create_packet_filter(src_addr, dst_addr), + )?)) + } + } + } + } + + all(windows, any(target_arch = "x86_64", target_arch = "x86")) => { + pub mod windivert; + + pub fn create_tun( + interface_name: &str, + src_addr: Option, + dst_addr: SocketAddr, + ) -> io::Result> { + match windivert::WinDivertTun::new(src_addr, dst_addr) { + Ok(tun) => Ok(Arc::new(tun)), + Err(e) => { + tracing::warn!( + ?e, + ?dst_addr, + "WinDivertTun init failed, falling back to PnetTun" + ); + Ok(Arc::new(pnet::PnetTun::new( + interface_name, + pnet::create_packet_filter(src_addr, dst_addr), + )?)) + } + } + } + } + + _ => { + pub fn create_tun( + interface_name: &str, + src_addr: Option, + dst_addr: SocketAddr, + ) -> io::Result> { + Ok(Arc::new(pnet::PnetTun::new( + interface_name, + pnet::create_packet_filter(src_addr, dst_addr), + )?)) + } + } +} diff --git a/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/pnet.rs b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/pnet.rs new file mode 100644 index 0000000..c561813 --- /dev/null +++ b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/pnet.rs @@ -0,0 +1,330 @@ +use std::{ + io, + net::{IpAddr, SocketAddr}, + sync::{ + Arc, Weak, + atomic::{AtomicU32, Ordering}, + }, +}; + +use bytes::{Bytes, BytesMut}; +use dashmap::DashMap; +use once_cell::sync::Lazy; +use pnet_datalink::{self as datalink, DataLinkSender, NetworkInterface}; +use smoltcp::wire::{ + EthernetFrame, EthernetProtocol, IpProtocol, Ipv4Packet, Ipv6Packet, TcpPacket, +}; +#[cfg(target_os = "linux")] +use std::os::unix::fs::MetadataExt; +use tokio::sync::Mutex; + +use crate::socket::fake_tcp::stack; + +type PacketFilter = Box bool + Send + Sync>; + +fn filter_tcp_packet( + packet: &[u8], + src_addr: Option<&SocketAddr>, + dst_addr: Option<&SocketAddr>, +) -> bool { + let Ok(ethernet) = EthernetFrame::new_checked(packet) else { + return false; + }; + + match ethernet.ethertype() { + EthernetProtocol::Ipv4 => { + let Ok(ipv4) = Ipv4Packet::new_checked(ethernet.payload()) else { + return false; + }; + + if ipv4.next_header() != IpProtocol::Tcp { + return false; + } + + let Ok(tcp) = TcpPacket::new_checked(ipv4.payload()) else { + return false; + }; + + if let Some(src_addr) = src_addr { + if IpAddr::V4(ipv4.src_addr()) != src_addr.ip() { + return false; + } + if tcp.src_port() != src_addr.port() { + return false; + } + } + + if let Some(dst_addr) = dst_addr { + if IpAddr::V4(ipv4.dst_addr()) != dst_addr.ip() { + return false; + } + if tcp.dst_port() != dst_addr.port() { + return false; + } + } + + tracing::trace!( + ?tcp, + "FakeTcpSocketListener packet matched filter, dispatching, src_addr: {:?}, dst_addr: {:?}, packet_src_ip: {:?}, packet_dst_ip: {:?}, packet_src_port: {:?}, packet_dst_port: {:?}", + src_addr, + dst_addr, + ipv4.src_addr(), + ipv4.dst_addr(), + tcp.src_port(), + tcp.dst_port(), + ); + } + EthernetProtocol::Ipv6 => { + let Ok(ipv6) = Ipv6Packet::new_checked(ethernet.payload()) else { + return false; + }; + + if ipv6.next_header() != IpProtocol::Tcp { + return false; + } + + let Ok(tcp) = TcpPacket::new_checked(ipv6.payload()) else { + return false; + }; + + if let Some(src_addr) = src_addr { + if IpAddr::V6(ipv6.src_addr()) != src_addr.ip() { + return false; + } + if tcp.src_port() != src_addr.port() { + return false; + } + } + + if let Some(dst_addr) = dst_addr { + if IpAddr::V6(ipv6.dst_addr()) != dst_addr.ip() { + return false; + } + if tcp.dst_port() != dst_addr.port() { + return false; + } + } + + tracing::trace!( + ?tcp, + "FakeTcpSocketListener packet matched filter, dispatching" + ); + } + _ => return false, + } + + true +} + +pub fn create_packet_filter(src_addr: Option, dst_addr: SocketAddr) -> PacketFilter { + Box::new(move |packet: &[u8]| -> bool { + filter_tcp_packet(packet, src_addr.as_ref(), Some(&dst_addr)) + }) +} + +struct Subscriber { + filter: PacketFilter, + sender: tokio::sync::mpsc::Sender>, +} + +struct InterfaceWorker { + tx: Mutex>, + subscribers: Arc>, +} + +impl InterfaceWorker { + fn new(interface: NetworkInterface) -> io::Result> { + let (tx, mut rx) = match datalink::channel(&interface, Default::default()) { + Ok(datalink::Channel::Ethernet(tx, rx)) => (tx, rx), + Ok(_) => return Err(io::Error::other("Unhandled channel type")), + Err(e) => return Err(io::Error::other(e)), + }; + + let subscribers = Arc::new(DashMap::::new()); + let subscribers_clone = subscribers.clone(); + + std::thread::spawn(move || { + loop { + match rx.next() { + Ok(packet) => { + // Iterate over subscribers and send packet if filter matches + // Note: DashMap iteration might be slow if many subscribers, but usually few per interface. + // For high performance we might need a better structure or read-copy-update. + for r in subscribers_clone.iter() { + let subscriber = r.value(); + if (subscriber.filter)(packet) { + tracing::trace!( + ?packet, + "InterfaceWorker packet matched filter, dispatching" + ); + // Try send, ignore errors (best effort) + let _ = subscriber.sender.try_send(packet.to_vec()); + } + } + } + Err(e) => { + tracing::error!("InterfaceWorker read error: {}", e); + // If interface goes down, we might need to handle it. + // For now just break and maybe the worker is dead. + break; + } + } + } + }); + + Ok(Arc::new(Self { + tx: Mutex::new(tx), + subscribers, + })) + } + + fn subscribe(&self, filter: PacketFilter, sender: tokio::sync::mpsc::Sender>) -> u32 { + static ID_GEN: AtomicU32 = AtomicU32::new(0); + let id = ID_GEN.fetch_add(1, Ordering::Relaxed); + self.subscribers.insert(id, Subscriber { filter, sender }); + id + } + + fn unsubscribe(&self, id: u32) { + self.subscribers.remove(&id); + } +} + +#[derive(Clone, Debug, PartialEq, Eq, Hash)] +enum NetworkNamespaceId { + #[cfg(target_os = "linux")] + LinuxInode(u64), + #[cfg(not(target_os = "linux"))] + Unsupported, +} + +type InterfaceWorkerKey = (NetworkNamespaceId, String); + +static INTERFACE_MANAGERS: Lazy>> = + Lazy::new(DashMap::new); + +fn current_network_namespace_id() -> Option { + #[cfg(target_os = "linux")] + { + match std::fs::metadata("/proc/thread-self/ns/net") { + Ok(metadata) => Some(NetworkNamespaceId::LinuxInode(metadata.ino())), + Err(error) => { + tracing::warn!( + ?error, + "failed to identify current network namespace; disabling FakeTCP pnet worker sharing" + ); + None + } + } + } + + #[cfg(not(target_os = "linux"))] + Some(NetworkNamespaceId::Unsupported) +} + +fn get_or_create_worker(interface_name: &str) -> io::Result> { + let key = current_network_namespace_id() + .map(|namespace_id| (namespace_id, interface_name.to_owned())); + // Check if we have an active worker + if let Some(worker) = key + .as_ref() + .and_then(|key| INTERFACE_MANAGERS.get(key)) + .and_then(|worker| worker.upgrade()) + { + return Ok(worker); + } + + // Need to create new worker. + // Lock effectively by using entry API? DashMap entry API might not be enough for complex init. + // Let's use a double-check locking style or just accept race condition (creating two workers and one wins). + // DashMap doesn't support easy "compute_if_absent" with async or heavy logic without blocking the map shard. + + // But creation is rare. + // Let's find interface first. + let interfaces = std::panic::catch_unwind(datalink::interfaces) + .map_err(|_| io::Error::other("failed to enumerate network interfaces: pnet panicked"))?; + let interface = interfaces + .into_iter() + .find(|iface| iface.name == interface_name) + .ok_or_else(|| { + io::Error::new( + io::ErrorKind::NotFound, + format!("Network interface '{}' not found", interface_name), + ) + })?; + + let worker = InterfaceWorker::new(interface)?; + if let Some(key) = key { + INTERFACE_MANAGERS.insert(key, Arc::downgrade(&worker)); + } + Ok(worker) +} + +pub struct PnetTun { + worker: Arc, + subscription_id: u32, + recv_queue: Mutex>>, +} + +impl PnetTun { + pub fn new(interface_name: &str, filter: PacketFilter) -> io::Result { + tracing::debug!(interface_name, "Creating new PnetTun"); + let worker = get_or_create_worker(interface_name)?; + let (tx, rx) = tokio::sync::mpsc::channel(1024); + let id = worker.subscribe(filter, tx); + + Ok(Self { + worker, + subscription_id: id, + recv_queue: Mutex::new(rx), + }) + } +} + +impl Drop for PnetTun { + fn drop(&mut self) { + tracing::debug!(subscription_id = self.subscription_id, "Dropping PnetTun"); + self.worker.unsubscribe(self.subscription_id); + } +} + +#[async_trait::async_trait] +impl stack::Tun for PnetTun { + async fn recv(&self, packet: &mut BytesMut) -> Result { + let mut rx = self.recv_queue.lock().await; + match rx.recv().await { + Some(data) => { + tracing::trace!(?data, "PnetTun received packet"); + packet.extend_from_slice(&data); + Ok(data.len()) + } + None => { + tracing::warn!("PnetTun recv channel closed"); + Err(std::io::Error::new( + std::io::ErrorKind::BrokenPipe, + "PnetTun channel closed", + )) + } + } + } + + fn try_send(&self, packet: &Bytes) -> Result<(), std::io::Error> { + tracing::trace!(len = packet.len(), "PnetTun try_sending packet"); + // We need async lock for tx. + // try_send is sync. We can use try_lock if available or blocking lock. + // tokio::sync::Mutex::try_lock is available. + if let Ok(mut tx) = self.worker.tx.try_lock() { + tx.send_to(packet, None) + .ok_or(std::io::Error::other("send_to failed"))? + } else { + Err(std::io::Error::new( + std::io::ErrorKind::WouldBlock, + "PnetTun tx lock busy", + )) + } + } + + fn driver_type(&self) -> &'static str { + "pnet" + } +} diff --git a/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/windivert.rs b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/windivert.rs new file mode 100644 index 0000000..58ffc14 --- /dev/null +++ b/vendor/easytier/easytier/src/socket/fake_tcp/netfilter/windivert.rs @@ -0,0 +1,225 @@ +use std::cell::UnsafeCell; +use std::io; +use std::net::SocketAddr; +use std::sync::Arc; + +use anyhow::Context as _; +use bytes::{Bytes, BytesMut}; +use tokio::sync::Mutex; +use windivert::error::WinDivertError; +use windivert::packet::WinDivertPacket; +use windivert::prelude::{WinDivertFlags, WinDivertShutdownMode}; +use windivert::{WinDivert, layer}; + +use crate::socket::fake_tcp::stack; + +struct WinDivertReader { + inner: UnsafeCell>, +} + +unsafe impl Send for WinDivertReader {} +unsafe impl Sync for WinDivertReader {} + +impl WinDivertReader { + fn new(inner: WinDivert) -> Self { + Self { + inner: UnsafeCell::new(inner), + } + } + + fn recv<'a>( + &self, + buffer: Option<&'a mut [u8]>, + ) -> Result, WinDivertError> { + let inner = unsafe { &*self.inner.get() }; + inner.recv(buffer) + } + + fn shutdown(&self) -> anyhow::Result<()> { + let inner = unsafe { &mut *self.inner.get() }; + inner + .shutdown(WinDivertShutdownMode::Recv) + .with_context(|| "WinDivertReader shutdown failed")?; + Ok(()) + } + + fn close(&self) -> anyhow::Result<()> { + let inner = unsafe { &mut *self.inner.get() }; + inner + .close(windivert::CloseAction::Nothing) + .with_context(|| "WinDivertReader close failed")?; + Ok(()) + } +} + +impl Drop for WinDivertReader { + fn drop(&mut self) { + if let Err(e) = self.close() { + tracing::error!("WinDivertReader close failed: {:?}", e); + } + } +} + +pub struct WinDivertTun { + recv_queue: Mutex>>, + sender: Arc>>, + reader: Arc, +} + +impl Drop for WinDivertTun { + fn drop(&mut self) { + if let Ok(mut sender) = self.sender.lock() + && let Err(e) = sender.close(windivert::CloseAction::Nothing) + { + tracing::error!("WinDivertSender close failed: {:?}", e); + } + if let Err(e) = self.reader.shutdown() { + tracing::error!("WinDivertReader shutdown failed: {:?}", e); + } + } +} + +impl WinDivertTun { + pub fn new(src_addr: Option, dst_addr: SocketAddr) -> io::Result { + let (tx, rx) = tokio::sync::mpsc::channel(1024); + + let filter = build_filter(src_addr, dst_addr)?; + tracing::debug!(%filter, "WinDivertTun created with filter"); + + // Sniff mode: 1 (WINDIVERT_FLAG_SNIFF) + // Layer: Network (0) + // Priority: 0 + let flags = WinDivertFlags::default().set_sniff(); + let reader = WinDivert::network(&filter, 0, flags).map_err(io::Error::other)?; + let reader = Arc::new(WinDivertReader::new(reader)); + let reader_clone = reader.clone(); + + std::thread::spawn(move || { + let reader = reader_clone; + let mut buffer = vec![0u8; 65536]; + loop { + match reader.recv(Some(&mut buffer)) { + Ok(packet) => { + let data = &packet.data; + + let mut eth_data = vec![0u8; 14 + data.len()]; + // Set EtherType + if !data.is_empty() && data[0] >> 4 == 4 { + eth_data[12] = 0x08; + eth_data[13] = 0x00; + } else { + eth_data[12] = 0x86; + eth_data[13] = 0xDD; + } + eth_data[14..].copy_from_slice(data); + + if tx.blocking_send(eth_data).is_err() { + break; + } + } + Err(error) => { + tracing::error!(?error, "WinDivert recv failed"); + break; + } + } + } + }); + + // Sender: non-sniff, empty filter? + // Use "false" to avoid capturing anything. + // Flags: 0 + let sender = + WinDivert::network("false", 0, WinDivertFlags::default()).map_err(io::Error::other)?; + + Ok(Self { + recv_queue: Mutex::new(rx), + sender: Arc::new(std::sync::Mutex::new(sender)), + reader, + }) + } +} + +fn build_filter(src_addr: Option, dst_addr: SocketAddr) -> io::Result { + if let Some(src_addr) = src_addr + && src_addr.is_ipv4() != dst_addr.is_ipv4() + { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "src/dst addr family mismatch", + )); + } + + let mut filters = Vec::with_capacity(5); + filters.push("tcp".to_owned()); + + match dst_addr { + SocketAddr::V4(addr) => { + filters.push(format!("ip.DstAddr == {}", addr.ip())); + filters.push(format!("tcp.DstPort == {}", addr.port())); + } + SocketAddr::V6(addr) => { + filters.push(format!("ipv6.DstAddr == {}", addr.ip())); + filters.push(format!("tcp.DstPort == {}", addr.port())); + } + } + + if let Some(src_addr) = src_addr { + match src_addr { + SocketAddr::V4(addr) => { + filters.push(format!("ip.SrcAddr == {}", addr.ip())); + filters.push(format!("tcp.SrcPort == {}", addr.port())); + } + SocketAddr::V6(addr) => { + filters.push(format!("ipv6.SrcAddr == {}", addr.ip())); + filters.push(format!("tcp.SrcPort == {}", addr.port())); + } + } + } + + Ok(filters.join(" and ")) +} + +#[async_trait::async_trait] +impl stack::Tun for WinDivertTun { + async fn recv(&self, packet: &mut BytesMut) -> Result { + let mut rx = self.recv_queue.lock().await; + match rx.recv().await { + Some(data) => { + packet.extend_from_slice(&data); + Ok(data.len()) + } + None => Err(std::io::Error::new( + std::io::ErrorKind::BrokenPipe, + "Channel closed", + )), + } + } + + fn try_send(&self, packet: &Bytes) -> Result<(), std::io::Error> { + // Strip ethernet header + if packet.len() < 14 { + return Err(std::io::Error::new( + std::io::ErrorKind::InvalidData, + "Packet too short", + )); + } + let ip_data = &packet[14..]; + + let Ok(sender) = self.sender.try_lock() else { + return Err(std::io::Error::other("WinDivert sender lock failed")); + }; + + let mut pkt = unsafe { WinDivertPacket::::new(ip_data.to_vec()) }; + pkt.address.set_outbound(true); + + sender + .send(&pkt) + .map_err(|e| std::io::Error::other(format!("WinDivert send failed: {}", e)))?; + + Ok(()) + } + + fn driver_type(&self) -> &'static str { + "windivert" + } +} diff --git a/vendor/easytier/easytier/src/socket/fake_tcp/packet.rs b/vendor/easytier/easytier/src/socket/fake_tcp/packet.rs new file mode 100644 index 0000000..e36884d --- /dev/null +++ b/vendor/easytier/easytier/src/socket/fake_tcp/packet.rs @@ -0,0 +1,409 @@ +use bytes::{Bytes, BytesMut}; +use smoltcp::wire::{ + ETHERNET_HEADER_LEN, EthernetAddress, EthernetFrame, EthernetProtocol, IpAddress, IpProtocol, + Ipv4Packet, Ipv6Packet, TCP_HEADER_LEN, TcpPacket, TcpSeqNumber, +}; +use std::net::{IpAddr, SocketAddr}; + +use smoltcp::wire::{IPV4_HEADER_LEN, IPV6_HEADER_LEN}; + +pub type MacAddr = EthernetAddress; + +pub const TCP_FLAG_FIN: u8 = 0x01; +pub const TCP_FLAG_SYN: u8 = 0x02; +pub const TCP_FLAG_RST: u8 = 0x04; +pub const TCP_FLAG_PSH: u8 = 0x08; +pub const TCP_FLAG_ACK: u8 = 0x10; +pub const TCP_FLAG_URG: u8 = 0x20; +pub const TCP_FLAG_ECE: u8 = 0x40; +pub const TCP_FLAG_CWR: u8 = 0x80; + +#[derive(Debug)] +pub enum IPPacket<'p> { + V4(Ipv4Packet<&'p [u8]>), + V6(Ipv6Packet<&'p [u8]>), +} + +impl IPPacket<'_> { + pub fn get_source(&self) -> IpAddr { + match self { + IPPacket::V4(p) => IpAddr::V4(p.src_addr()), + IPPacket::V6(p) => IpAddr::V6(p.src_addr()), + } + } + + pub fn get_destination(&self) -> IpAddr { + match self { + IPPacket::V4(p) => IpAddr::V4(p.dst_addr()), + IPPacket::V6(p) => IpAddr::V6(p.dst_addr()), + } + } +} + +fn set_tcp_flags + AsMut<[u8]>>(tcp: &mut TcpPacket, flags: u8) { + tcp.set_fin(flags & TCP_FLAG_FIN != 0); + tcp.set_syn(flags & TCP_FLAG_SYN != 0); + tcp.set_rst(flags & TCP_FLAG_RST != 0); + tcp.set_psh(flags & TCP_FLAG_PSH != 0); + tcp.set_ack(flags & TCP_FLAG_ACK != 0); + tcp.set_urg(flags & TCP_FLAG_URG != 0); + tcp.set_ece(flags & TCP_FLAG_ECE != 0); + tcp.set_cwr(flags & TCP_FLAG_CWR != 0); +} + +#[cfg(test)] +pub fn tcp_flags>(tcp: &TcpPacket) -> u8 { + u8::from(tcp.fin()) + | (u8::from(tcp.syn()) << 1) + | (u8::from(tcp.rst()) << 2) + | (u8::from(tcp.psh()) << 3) + | (u8::from(tcp.ack()) << 4) + | (u8::from(tcp.urg()) << 5) + | (u8::from(tcp.ece()) << 6) + | (u8::from(tcp.cwr()) << 7) +} + +#[allow(clippy::too_many_arguments)] +pub fn build_tcp_packet( + src_mac: MacAddr, + dst_mac: MacAddr, + local_addr: SocketAddr, + remote_addr: SocketAddr, + seq: u32, + ack: u32, + flags: u8, + payload: Option<&[u8]>, +) -> Bytes { + let ip_header_len = match local_addr { + SocketAddr::V4(_) => IPV4_HEADER_LEN, + SocketAddr::V6(_) => IPV6_HEADER_LEN, + }; + let wscale = flags & TCP_FLAG_SYN != 0; + let tcp_header_len = TCP_HEADER_LEN + if wscale { 4 } else { 0 }; // nop + wscale + let tcp_total_len = tcp_header_len + payload.map_or(0, |payload| payload.len()); + let total_len = ip_header_len + tcp_total_len; + let mut buf = BytesMut::zeroed(ETHERNET_HEADER_LEN + total_len); + + let mut eth_buf = buf.split_to(ETHERNET_HEADER_LEN); + let mut ip_buf = buf.split_to(ip_header_len); + let mut tcp_buf = buf.split_to(tcp_total_len); + assert_eq!(0, buf.len()); + + let mut tcp = TcpPacket::new_unchecked(&mut tcp_buf); + tcp.set_window_len(0xffff); + tcp.set_src_port(local_addr.port()); + tcp.set_dst_port(remote_addr.port()); + tcp.set_seq_number(TcpSeqNumber(seq as i32)); + tcp.set_ack_number(TcpSeqNumber(ack as i32)); + set_tcp_flags(&mut tcp, flags); + tcp.set_header_len(tcp_header_len as u8); + if wscale { + tcp.options_mut().copy_from_slice(&[1, 3, 3, 14]); + } + + if let Some(payload) = payload { + tcp.payload_mut().copy_from_slice(payload); + } + + let mut ethernet = EthernetFrame::new_unchecked(&mut eth_buf); + ethernet.set_dst_addr(dst_mac); + ethernet.set_src_addr(src_mac); + ethernet.set_ethertype(match local_addr { + SocketAddr::V4(_) => EthernetProtocol::Ipv4, + SocketAddr::V6(_) => EthernetProtocol::Ipv6, + }); + + match (local_addr, remote_addr) { + (SocketAddr::V4(local), SocketAddr::V4(remote)) => { + let mut v4 = Ipv4Packet::new_unchecked(&mut ip_buf); + v4.set_version(4); + v4.set_header_len(IPV4_HEADER_LEN as u8); + v4.set_next_header(IpProtocol::Tcp); + v4.set_hop_limit(64); + v4.set_src_addr(*local.ip()); + v4.set_dst_addr(*remote.ip()); + v4.set_total_len(total_len.try_into().unwrap()); + v4.set_dont_frag(true); + + tcp.fill_checksum( + &IpAddress::Ipv4(*local.ip()), + &IpAddress::Ipv4(*remote.ip()), + ); + v4.fill_checksum(); + } + (SocketAddr::V6(local), SocketAddr::V6(remote)) => { + let mut v6 = Ipv6Packet::new_unchecked(&mut ip_buf); + v6.set_version(6); + v6.set_payload_len(tcp_total_len.try_into().unwrap()); + v6.set_next_header(IpProtocol::Tcp); + v6.set_hop_limit(64); + v6.set_src_addr(*local.ip()); + v6.set_dst_addr(*remote.ip()); + + tcp.fill_checksum( + &IpAddress::Ipv6(*local.ip()), + &IpAddress::Ipv6(*remote.ip()), + ); + } + _ => unreachable!(), + }; + + ip_buf.unsplit(tcp_buf); + eth_buf.unsplit(ip_buf); + eth_buf.freeze() +} + +pub fn parse_ip_packet(buf: &Bytes) -> Option<(MacAddr, MacAddr, IPPacket<'_>, TcpPacket<&[u8]>)> { + let eth = EthernetFrame::new_checked(buf.as_ref()).ok()?; + let src_mac = eth.src_addr(); + let dst_mac = eth.dst_addr(); + let ethertype = eth.ethertype(); + + tracing::trace!("Parsing IP packet: {:?}", eth); + + let ip_payload = eth.payload(); + + match ethertype { + EthernetProtocol::Ipv4 => { + let v4 = Ipv4Packet::new_checked(ip_payload).ok()?; + if usize::from(v4.header_len()) < IPV4_HEADER_LEN { + return None; + } + if v4.next_header() != IpProtocol::Tcp { + return None; + } + let tcp = TcpPacket::new_checked(v4.payload()).ok()?; + Some((src_mac, dst_mac, IPPacket::V4(v4), tcp)) + } + EthernetProtocol::Ipv6 => { + let v6 = Ipv6Packet::new_checked(ip_payload).ok()?; + if v6.next_header() != IpProtocol::Tcp { + return None; + } + let tcp = TcpPacket::new_checked(v6.payload()).ok()?; + Some((src_mac, dst_mac, IPPacket::V6(v6), tcp)) + } + _ => None, + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn parse_ipv4_packet_round_trip() { + let src_mac = MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 1]); + let dst_mac = MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 2]); + let local_addr: SocketAddr = "192.0.2.1:12345".parse().unwrap(); + let remote_addr: SocketAddr = "198.51.100.2:23456".parse().unwrap(); + let payload = b"hello fake tcp"; + + let packet = build_tcp_packet( + src_mac, + dst_mac, + local_addr, + remote_addr, + 10, + 20, + TCP_FLAG_ACK, + Some(payload), + ); + + let (parsed_src_mac, parsed_dst_mac, ip_packet, tcp_packet) = + parse_ip_packet(&packet).unwrap(); + + assert_eq!(parsed_src_mac, src_mac); + assert_eq!(parsed_dst_mac, dst_mac); + assert_eq!(ip_packet.get_source(), local_addr.ip()); + assert_eq!(ip_packet.get_destination(), remote_addr.ip()); + assert_eq!(tcp_packet.src_port(), local_addr.port()); + assert_eq!(tcp_packet.dst_port(), remote_addr.port()); + assert_eq!(tcp_packet.payload(), payload); + } + + #[test] + fn build_and_parse_ipv6_packet_round_trip() { + let src_mac = MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 3]); + let dst_mac = MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 4]); + let local_addr: SocketAddr = "[2001:db8::1]:12345".parse().unwrap(); + let remote_addr: SocketAddr = "[2001:db8::2]:23456".parse().unwrap(); + let payload = b"ipv6 payload"; + + let packet = build_tcp_packet( + src_mac, + dst_mac, + local_addr, + remote_addr, + 30, + 40, + TCP_FLAG_ACK, + Some(payload), + ); + + let ethernet = EthernetFrame::new_checked(packet.as_ref()).unwrap(); + assert_eq!(ethernet.ethertype(), EthernetProtocol::Ipv6); + + let (parsed_src_mac, parsed_dst_mac, ip_packet, tcp_packet) = + parse_ip_packet(&packet).unwrap(); + + assert_eq!(parsed_src_mac, src_mac); + assert_eq!(parsed_dst_mac, dst_mac); + assert_eq!(ip_packet.get_source(), local_addr.ip()); + assert_eq!(ip_packet.get_destination(), remote_addr.ip()); + assert_eq!(tcp_packet.src_port(), local_addr.port()); + assert_eq!(tcp_packet.dst_port(), remote_addr.port()); + assert_eq!(tcp_packet.payload(), payload); + } + + #[test] + fn parse_rejects_short_ethernet_frame() { + let packet = Bytes::from_static(&[0u8; ETHERNET_HEADER_LEN - 1]); + assert!(parse_ip_packet(&packet).is_none()); + } + + #[test] + fn parse_rejects_truncated_ipv4_tcp_packet() { + let packet = build_tcp_packet( + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 5]), + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 6]), + "192.0.2.10:1111".parse().unwrap(), + "198.51.100.20:2222".parse().unwrap(), + 1, + 2, + TCP_FLAG_ACK, + None, + ); + let truncated = + Bytes::copy_from_slice(&packet[..ETHERNET_HEADER_LEN + IPV4_HEADER_LEN + 10]); + + assert!(parse_ip_packet(&truncated).is_none()); + } + + #[test] + fn parse_rejects_ipv4_header_shorter_than_minimum() { + let packet = build_tcp_packet( + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 5]), + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 6]), + "192.0.2.10:1111".parse().unwrap(), + "198.51.100.20:2222".parse().unwrap(), + 1, + 0x5000_0000, + TCP_FLAG_ACK, + None, + ); + let mut malformed = BytesMut::from(packet.as_ref()); + Ipv4Packet::new_unchecked(&mut malformed[ETHERNET_HEADER_LEN..]) + .set_header_len((IPV4_HEADER_LEN - 4) as u8); + let malformed = malformed.freeze(); + + assert!(parse_ip_packet(&malformed).is_none()); + } + + #[test] + fn parse_rejects_truncated_ipv6_header() { + let packet = build_tcp_packet( + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 7]), + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 8]), + "[2001:db8::10]:1111".parse().unwrap(), + "[2001:db8::20]:2222".parse().unwrap(), + 1, + 2, + TCP_FLAG_ACK, + None, + ); + let truncated = + Bytes::copy_from_slice(&packet[..ETHERNET_HEADER_LEN + IPV6_HEADER_LEN - 1]); + + assert!(parse_ip_packet(&truncated).is_none()); + } + + #[test] + fn syn_packet_preserves_wire_format_and_unsigned_sequence() { + let packet = build_tcp_packet( + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 1]), + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 2]), + "192.0.2.1:12345".parse().unwrap(), + "198.51.100.2:23456".parse().unwrap(), + 0x8000_0001, + 0xffff_fffe, + TCP_FLAG_SYN | TCP_FLAG_ACK, + None, + ); + + assert_eq!( + &packet[..ETHERNET_HEADER_LEN], + &[0x02, 0, 0, 0, 0, 2, 0x02, 0, 0, 0, 0, 1, 0x08, 0x00] + ); + let (_, _, IPPacket::V4(ipv4), tcp) = parse_ip_packet(&packet).unwrap() else { + panic!("expected IPv4 packet"); + }; + assert_eq!(ipv4.header_len(), IPV4_HEADER_LEN as u8); + assert!(ipv4.dont_frag()); + assert_eq!(ipv4.hop_limit(), 64); + assert!(ipv4.verify_checksum()); + assert_eq!(tcp.header_len(), (TCP_HEADER_LEN + 4) as u8); + assert_eq!(tcp.options(), &[1, 3, 3, 14]); + assert_eq!(tcp_flags(&tcp), TCP_FLAG_SYN | TCP_FLAG_ACK); + assert_eq!(tcp.seq_number().0 as u32, 0x8000_0001); + assert_eq!(tcp.ack_number().0 as u32, 0xffff_fffe); + assert!(tcp.verify_checksum( + &IpAddress::Ipv4(ipv4.src_addr()), + &IpAddress::Ipv4(ipv4.dst_addr()), + )); + } + + #[test] + fn ethernet_padding_is_not_tcp_payload() { + let packet = build_tcp_packet( + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 1]), + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 2]), + "192.0.2.1:12345".parse().unwrap(), + "198.51.100.2:23456".parse().unwrap(), + 1, + 2, + TCP_FLAG_ACK, + Some(b"payload"), + ); + let mut padded = BytesMut::from(packet.as_ref()); + padded.extend_from_slice(&[0; 16]); + let padded = padded.freeze(); + + let (_, _, _, tcp) = parse_ip_packet(&padded).unwrap(); + assert_eq!(tcp.payload(), b"payload"); + } + + #[test] + fn ipv4_options_do_not_shift_tcp_payload() { + let packet = build_tcp_packet( + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 1]), + MacAddr::from_bytes(&[0x02, 0, 0, 0, 0, 2]), + "192.0.2.1:12345".parse().unwrap(), + "198.51.100.2:23456".parse().unwrap(), + 1, + 2, + TCP_FLAG_ACK, + Some(b"payload"), + ); + let ip_start = ETHERNET_HEADER_LEN; + let tcp_start = ip_start + IPV4_HEADER_LEN; + let mut with_options = Vec::with_capacity(packet.len() + 4); + with_options.extend_from_slice(&packet[..tcp_start]); + with_options.extend_from_slice(&[1, 1, 1, 0]); + with_options.extend_from_slice(&packet[tcp_start..]); + { + let total_len = with_options.len() - ip_start; + let mut ipv4 = Ipv4Packet::new_unchecked(&mut with_options[ip_start..]); + ipv4.set_header_len((IPV4_HEADER_LEN + 4) as u8); + ipv4.set_total_len(total_len as u16); + ipv4.fill_checksum(); + } + let with_options = Bytes::from(with_options); + + let (_, _, IPPacket::V4(ipv4), tcp) = parse_ip_packet(&with_options).unwrap() else { + panic!("expected IPv4 packet"); + }; + assert_eq!(ipv4.header_len(), (IPV4_HEADER_LEN + 4) as u8); + assert_eq!(tcp.payload(), b"payload"); + } +} diff --git a/vendor/easytier/easytier/src/socket/fake_tcp/stack.rs b/vendor/easytier/easytier/src/socket/fake_tcp/stack.rs new file mode 100644 index 0000000..b474f94 --- /dev/null +++ b/vendor/easytier/easytier/src/socket/fake_tcp/stack.rs @@ -0,0 +1,743 @@ +//! A minimum, userspace TCP based datagram stack +//! +//! # Overview +//! +//! `fake-tcp` is a reusable library that implements a minimum TCP stack in +//! user space using the Tun interface. It allows programs to send datagrams +//! as if they are part of a TCP connection. `fake-tcp` has been tested to +//! be able to pass through a variety of NAT and stateful firewalls while +//! fully preserves certain desirable behavior such as out of order delivery +//! and no congestion/flow controls. +//! +//! # Core Concepts +//! +//! The core of the `fake-tcp` crate compose of two structures. [`Stack`] and +//! [`Socket`]. +//! +//! ## [`Stack`] +//! +//! [`Stack`] represents a virtual TCP stack that operates at +//! Layer 3. It is responsible for: +//! +//! * TCP active and passive open and handshake +//! * `RST` handling +//! * Interact with the Tun interface at Layer 3 +//! * Distribute incoming datagrams to corresponding [`Socket`] +//! +//! ## [`Socket`] +//! +//! [`Socket`] represents a TCP connection. It registers the identifying +//! tuple `(src_ip, src_port, dest_ip, dest_port)` inside the [`Stack`] so +//! so that incoming packets can be distributed to the right [`Socket`] with +//! using a channel. It is also what the client should use for +//! sending/receiving datagrams. +//! +//! # Examples +//! +//! Please see [`client.rs`](https://github.com/dndx/phantun/blob/main/phantun/src/bin/client.rs) +//! and [`server.rs`](https://github.com/dndx/phantun/blob/main/phantun/src/bin/server.rs) files +//! from the `phantun` crate for how to use this library in client/server mode, respectively. + +use super::packet::*; +use bytes::{Bytes, BytesMut}; +use crossbeam::atomic::AtomicCell; +use std::collections::HashMap; +use std::fmt; +#[cfg(test)] +use std::net::Ipv4Addr; +use std::net::SocketAddr; +use std::sync::{ + Arc, RwLock, + atomic::{AtomicU32, Ordering}, +}; +use tokio::sync::broadcast; +use tokio::time; +use tokio_util::task::AbortOnDropHandle; +use tracing::{error, info, trace, warn}; + +const TIMEOUT: time::Duration = time::Duration::from_secs(1); +const MPMC_BUFFER_LEN: usize = 512; +const TCP_OPTION_END: u8 = 0; +const TCP_OPTION_NOP: u8 = 1; +const TCP_OPTION_SACK: u8 = 5; + +struct TcpOptionIter<'a> { + remaining: &'a [u8], +} + +impl<'a> TcpOptionIter<'a> { + fn new(options: &'a [u8]) -> Self { + Self { remaining: options } + } +} + +impl<'a> Iterator for TcpOptionIter<'a> { + type Item = (u8, &'a [u8]); + + fn next(&mut self) -> Option { + let kind = *self.remaining.first()?; + if kind == TCP_OPTION_END { + self.remaining = &[]; + return None; + } + if kind == TCP_OPTION_NOP { + self.remaining = &self.remaining[1..]; + return Some((kind, &[])); + } + let Some(&length) = self.remaining.get(1) else { + self.remaining = &[]; + return None; + }; + let length = usize::from(length); + if length < 2 || length > self.remaining.len() { + self.remaining = &[]; + return None; + } + let payload = &self.remaining[2..length]; + self.remaining = &self.remaining[length..]; + Some((kind, payload)) + } +} + +#[async_trait::async_trait] +pub trait Tun: Send + Sync + 'static { + async fn recv(&self, packet: &mut BytesMut) -> Result; + fn try_send(&self, packet: &Bytes) -> Result<(), std::io::Error>; + fn driver_type(&self) -> &'static str; +} + +#[derive(Hash, Eq, PartialEq, Clone, Debug)] +struct AddrTuple { + local_addr: SocketAddr, + remote_addr: SocketAddr, +} + +impl AddrTuple { + fn new(local_addr: SocketAddr, remote_addr: SocketAddr) -> AddrTuple { + AddrTuple { + local_addr, + remote_addr, + } + } +} + +#[derive(Default)] +struct StackState { + tuples: HashMap>, + closed: bool, +} + +struct Shared { + state: RwLock, + tun: Arc, + tuples_purge: broadcast::Sender, +} + +impl Shared { + fn is_closed(&self) -> bool { + self.state.read().unwrap().closed + } + + fn mark_closed_and_clear_tuples(&self) -> usize { + let mut state = self.state.write().unwrap(); + state.closed = true; + let len = state.tuples.len(); + state.tuples.clear(); + len + } +} + +pub struct Stack { + shared: Arc, + local_mac: MacAddr, + reader_task: AbortOnDropHandle<()>, +} + +#[derive(Hash, Eq, PartialEq, Clone, Copy, Debug)] +pub enum State { + Idle, + SynSent, + Established, +} + +pub struct Socket { + shared: Arc, + tun: Arc, + incoming: flume::Receiver, + local_addr: SocketAddr, + remote_addr: SocketAddr, + local_mac: MacAddr, + remote_mac: AtomicCell>, + seq: AtomicU32, + ack: AtomicU32, + last_ack: AtomicU32, + state: AtomicCell, +} + +/// A socket that represents a unique TCP connection between a server and client. +/// +/// The `Socket` object itself satisfies `Sync` and `Send`, which means it can +/// be safely called within an async future. +/// +/// To close a TCP connection that is no longer needed, simply drop this object +/// out of scope. +impl Socket { + #[allow(clippy::too_many_arguments)] + fn new( + shared: Arc, + tun: Arc, + local_addr: SocketAddr, + remote_addr: SocketAddr, + local_mac: MacAddr, + remote_mac: Option, + ack: Option, + state: State, + ) -> (Socket, flume::Sender) { + let (incoming_tx, incoming_rx) = flume::bounded(MPMC_BUFFER_LEN); + + ( + Socket { + shared, + tun, + incoming: incoming_rx, + local_addr, + remote_addr, + local_mac, + remote_mac: AtomicCell::new(remote_mac), + seq: AtomicU32::new(0), + ack: AtomicU32::new(ack.unwrap_or(0)), + last_ack: AtomicU32::new(ack.unwrap_or(0)), + state: AtomicCell::new(state), + }, + incoming_tx, + ) + } + + fn build_tcp_packet(&self, flags: u8, payload: Option<&[u8]>) -> Bytes { + let ack = self.ack.load(Ordering::Relaxed); + self.last_ack.store(ack, Ordering::Relaxed); + + build_tcp_packet( + self.local_mac, + self.remote_mac.load().unwrap_or_default(), + self.local_addr, + self.remote_addr, + self.seq.load(Ordering::Relaxed), + ack, + flags, + payload, + ) + } + + /// Sends a datagram to the other end. + /// + /// This method takes `&self`, and it can be called safely by multiple threads + /// at the same time. + /// + /// A return of `None` means the Tun socket returned an error + /// and this socket must be closed. + pub fn try_send(&self, payload: &[u8]) -> Option<()> { + match self.state.load() { + State::Established => { + let buf = self.build_tcp_packet(TCP_FLAG_ACK, Some(payload)); + self.seq.fetch_add(payload.len() as u32, Ordering::Relaxed); + self.tun.try_send(&buf).ok().and(Some(())) + } + _ => unreachable!(), + } + } + + pub fn close(&self) { + if self.state.load() != State::Idle { + let buf = self.build_tcp_packet(TCP_FLAG_RST, None); + let _ = self.tun.try_send(&buf); + self.state.store(State::Idle); + } + } + + /// Attempt to receive a datagram from the other end. + /// + /// This method takes `&self`, and it can be called safely by multiple threads + /// at the same time. + /// + /// A return of `None` means the TCP connection is broken + /// and this socket must be closed. + pub async fn recv(&self, buf: &mut BytesMut) -> Option { + tracing::trace!( + "Socket recv called, local_addr: {:?}, remote_addr: {:?}", + self.local_addr, + self.remote_addr + ); + loop { + match self.state.load() { + State::Established => { + let Ok(raw_buf) = self.incoming.recv_async().await else { + info!("Connection {} recv error", self); + return None; + }; + + let Some((src_mac, dst_mac, _v4_packet, tcp_packet)) = + parse_ip_packet(&raw_buf) + else { + trace!("Dropping malformed fake tcp packet for established socket"); + continue; + }; + + tracing::trace!( + "Socket received TCP packet from {}({:?}) to {}({:?}): {:?}", + self.remote_addr, + src_mac, + self.local_addr, + dst_mac, + tcp_packet + ); + + self.remote_mac.store(Some(src_mac)); + + if tcp_packet.rst() { + info!("Connection {} reset by peer", self); + return None; + } + + if tcp_packet.ack() && tcp_packet.payload().is_empty() { + self.seq + .store(tcp_packet.ack_number().0 as u32, Ordering::Relaxed); + } + + let payload = tcp_packet.payload(); + + let new_ack = + (tcp_packet.seq_number().0 as u32).wrapping_add(payload.len() as u32); + self.ack.store(new_ack, Ordering::Relaxed); + + for (kind, option_payload) in TcpOptionIter::new(tcp_packet.options()) { + if kind == TCP_OPTION_SACK { + // SACK 选项类型为 5 + for chunk in option_payload.chunks(8) { + if chunk.len() != 8 { + continue; + } + let left = tcp_packet.ack_number().0 as u32; + let right = u32::from_be_bytes(chunk[0..4].try_into().unwrap()); + let len = right.wrapping_sub(left); + + let sack_end = u32::from_be_bytes(chunk[4..8].try_into().unwrap()); + if len == 0 || sack_end <= left { + continue; + } + + let send_len = std::cmp::min(len, 1400) as usize; + let data = vec![0u8; send_len]; + + let buf = build_tcp_packet( + self.local_mac, + self.remote_mac.load().unwrap_or_default(), + self.local_addr, + self.remote_addr, + left, + self.ack.load(Ordering::Relaxed), + TCP_FLAG_ACK, + Some(&data), + ); + + if let Err(e) = self.tun.try_send(&buf) { + tracing::error!("Failed to send SACK response: {}", e); + } + break; + } + } + } + + if payload.is_empty() { + continue; + } + + buf.extend_from_slice(payload); + + return Some(payload.len()); + } + State::SynSent => { + let Ok(Ok(buf)) = time::timeout(TIMEOUT, self.incoming.recv_async()).await + else { + info!("Waiting for client SYN + ACK timed out"); + return None; + }; + let Some((src_mac, _dst_mac, _v4_packet, tcp_packet)) = parse_ip_packet(&buf) + else { + trace!("Dropping malformed fake tcp packet during handshake"); + continue; + }; + + if tcp_packet.rst() { + tracing::trace!("Connection {} reset by peer", self); + return None; + } + + if tcp_packet.syn() && tcp_packet.ack() { + // found our SYN + ACK + self.seq + .store(tcp_packet.ack_number().0 as u32, Ordering::Relaxed); + self.ack.store( + (tcp_packet.seq_number().0 as u32).wrapping_add(1), + Ordering::Relaxed, + ); + self.remote_mac.store(Some(src_mac)); + self.state.store(State::Established); + return Some(0); + } + } + + _ => unreachable!(), + } + } + } + + pub fn local_addr(&self) -> SocketAddr { + self.local_addr + } + + pub fn remote_addr(&self) -> SocketAddr { + self.remote_addr + } +} + +impl Drop for Socket { + /// Drop the socket and close the TCP connection + fn drop(&mut self) { + let tuple = AddrTuple::new(self.local_addr, self.remote_addr); + // dissociates ourself from the dispatch map + let (removed, closed) = { + let mut state = self.shared.state.write().unwrap(); + (state.tuples.remove(&tuple).is_some(), state.closed) + }; + if !removed { + if closed { + trace!(?tuple, "Fake TCP tuple already removed after stack closed"); + } else { + warn!(?tuple, "Fake TCP tuple missing while dropping socket"); + } + } + // purge cache + let _ = self.shared.tuples_purge.send(tuple); + + let buf = build_tcp_packet( + self.local_mac, + self.remote_mac.load().unwrap_or_default(), + self.local_addr, + self.remote_addr, + self.seq.load(Ordering::Relaxed), + 0, + TCP_FLAG_RST, + None, + ); + if let Err(e) = self.tun.try_send(&buf) { + warn!("Unable to send RST to remote end: {}", e); + } + + info!("Fake TCP connection to {} closed", self); + } +} + +impl fmt::Display for Socket { + /// User-friendly string representation of the socket + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!( + f, + "(Fake TCP connection from {} to {})", + self.local_addr, self.remote_addr + ) + } +} + +/// A userspace TCP state machine +impl Stack { + /// Create a new stack, `tun` is an array of [`Tun`](tokio_tun::Tun). + /// When more than one [`Tun`](tokio_tun::Tun) object is passed in, same amount + /// of reader will be spawned later. This allows user to utilize the performance + /// benefit of Multiqueue Tun support on machines with SMP. + pub fn new(tun: Arc, local_mac: Option) -> Stack { + let (tuples_purge_tx, _tuples_purge_rx) = broadcast::channel(16); + let shared = Arc::new(Shared { + state: RwLock::new(StackState::default()), + tun: tun.clone(), + tuples_purge: tuples_purge_tx.clone(), + }); + + let t = tokio::spawn(Stack::reader_task( + tun, + shared.clone(), + tuples_purge_tx.subscribe(), + )); + + Stack { + shared, + local_mac: local_mac.unwrap_or_default(), + reader_task: AbortOnDropHandle::new(t), + } + } + + /// Returns the driver type of the stack. + pub fn driver_type(&self) -> &'static str { + self.shared.tun.driver_type() + } + + pub fn is_closed(&self) -> bool { + self.shared.is_closed() || self.reader_task.is_finished() + } + + pub fn try_alloc_established_socket( + &self, + local_addr: SocketAddr, + remote_addr: SocketAddr, + state: State, + ) -> Option { + let tuple = AddrTuple::new(local_addr, remote_addr); + let mut stack_state = self.shared.state.write().unwrap(); + if stack_state.closed || self.reader_task.is_finished() { + stack_state.closed = true; + warn!( + ?tuple, + "fake_tcp stack is closed, refusing to allocate socket" + ); + return None; + } + let (sock, incoming) = Socket::new( + self.shared.clone(), + // self.shared.tun.choose(&mut rng).unwrap().clone(), + self.shared.tun.clone(), // Simplification: just use the first tun + local_addr, + remote_addr, + self.local_mac, + None, + Some(0), // Initial ACK + state, + ); + assert!(stack_state.tuples.insert(tuple, incoming).is_none()); + Some(sock) + } + + async fn reader_task( + tun: Arc, + shared: Arc, + mut tuples_purge: broadcast::Receiver, + ) { + let mut tuples: HashMap> = HashMap::new(); + + loop { + let mut buf = BytesMut::new(); + + tokio::select! { + size = tun.recv(&mut buf) => { + let size = match size { + Ok(size) => size, + Err(e) => { + let shared_tuple_count = shared.mark_closed_and_clear_tuples(); + let cached_tuple_count = tuples.len(); + tuples.clear(); + error!( + ?e, + driver_type = tun.driver_type(), + shared_tuple_count, + cached_tuple_count, + "fake_tcp tun recv failed, reader_task exiting" + ); + break; + } + }; + tracing::trace!(len = size, ?buf, "PnetTun received packet"); + let buf = buf.split().freeze(); + + match parse_ip_packet(&buf) { + Some((_src_mac, _dst_mac, ip_packet, tcp_packet)) => { + let local_addr = SocketAddr::new( + ip_packet.get_destination(), + tcp_packet.dst_port(), + ); + let remote_addr = SocketAddr::new( + ip_packet.get_source(), + tcp_packet.src_port(), + ); + + let tuple = AddrTuple::new(local_addr, remote_addr); + if let Some(c) = tuples.get(&tuple) { + if c.send_async(buf).await.is_err() { + trace!("Cache hit, but receiver already closed, dropping packet"); + } + + continue; + + // If not Ok, receiver has been closed and just fall through to the slow + // path below + } else { + trace!("Cache miss, checking the shared tuples table for connection"); + let sender = { + let state = shared.state.read().unwrap(); + state.tuples.get(&tuple).cloned() + }; + + if let Some(c) = sender { + trace!("Storing connection information into local tuples"); + tuples.insert(tuple, c.clone()); + if let Err(e) = c.send_async(buf).await { + trace!("Error sending packet to connection: {:?}", e); + } + continue; + } + } + + if tcp_packet.rst() { + info!("Unknown RST TCP packet from {}, ignoring", remote_addr); + continue; + } else { + trace!("Unknown TCP packet from {}, ignoring", remote_addr); + continue; + } + } + None => { + trace!("Dropping packet with no IP/TCP header"); + continue; + } + } + }, + tuple = tuples_purge.recv() => { + match tuple { + Ok(tuple) => { + tuples.remove(&tuple); + trace!("Removed cached tuple: {:?}", tuple); + } + Err(broadcast::error::RecvError::Lagged(skipped)) => { + let cached_tuple_count = tuples.len(); + tuples.clear(); + warn!( + skipped, + cached_tuple_count, + "fake_tcp tuples purge receiver lagged, cleared local cache" + ); + } + Err(broadcast::error::RecvError::Closed) => { + let shared_tuple_count = shared.mark_closed_and_clear_tuples(); + let cached_tuple_count = tuples.len(); + tuples.clear(); + warn!( + shared_tuple_count, + cached_tuple_count, + "fake_tcp tuples purge channel closed, reader_task exiting" + ); + break; + } + } + } + } + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + use std::io; + use tokio::{ + sync::Notify, + time::{Duration, timeout}, + }; + + #[test] + fn tcp_option_iterator_preserves_all_sack_blocks() { + for block_count in 1..=4_u32 { + let mut options = vec![TCP_OPTION_NOP, TCP_OPTION_SACK, (2 + block_count * 8) as u8]; + for block in 0..block_count { + options.extend_from_slice(&(100 + block * 10).to_be_bytes()); + options.extend_from_slice(&(110 + block * 10).to_be_bytes()); + } + options.push(TCP_OPTION_END); + + let parsed = TcpOptionIter::new(&options).collect::>(); + assert_eq!(parsed[0], (TCP_OPTION_NOP, &[][..])); + assert_eq!(parsed[1].0, TCP_OPTION_SACK); + assert_eq!(parsed[1].1.len(), block_count as usize * 8); + let last = parsed[1].1.len() - 8; + assert_eq!( + u32::from_be_bytes(parsed[1].1[last..last + 4].try_into().unwrap()), + 100 + (block_count - 1) * 10 + ); + assert_eq!( + u32::from_be_bytes(parsed[1].1[last + 4..last + 8].try_into().unwrap()), + 110 + (block_count - 1) * 10 + ); + } + } + + #[test] + fn tcp_option_iterator_stops_at_end_or_malformed_length() { + assert_eq!( + TcpOptionIter::new(&[TCP_OPTION_END, TCP_OPTION_SACK, 2]).count(), + 0 + ); + assert_eq!(TcpOptionIter::new(&[TCP_OPTION_SACK]).count(), 0); + assert_eq!(TcpOptionIter::new(&[TCP_OPTION_SACK, 1]).count(), 0); + assert_eq!(TcpOptionIter::new(&[TCP_OPTION_SACK, 10, 0, 0]).count(), 0); + } + + #[derive(Default)] + struct FailingTun { + fail: Notify, + } + + impl FailingTun { + fn fail(&self) { + self.fail.notify_one(); + } + } + + #[async_trait::async_trait] + impl Tun for FailingTun { + async fn recv(&self, _packet: &mut BytesMut) -> Result { + self.fail.notified().await; + Err(io::Error::new(io::ErrorKind::BrokenPipe, "test tun closed")) + } + + fn try_send(&self, _packet: &Bytes) -> Result<(), io::Error> { + Ok(()) + } + + fn driver_type(&self) -> &'static str { + "test" + } + } + + #[tokio::test] + async fn reader_task_closes_sockets_on_tun_recv_error() { + let tun = Arc::new(FailingTun::default()); + let mut stack = Stack::new(tun.clone(), None); + let socket = stack + .try_alloc_established_socket( + SocketAddr::new(Ipv4Addr::LOCALHOST.into(), 10_000), + SocketAddr::new(Ipv4Addr::new(192, 0, 2, 1).into(), 20_000), + State::Established, + ) + .expect("socket allocation should succeed before tun failure"); + + tun.fail(); + + let join_result = timeout(Duration::from_secs(1), &mut stack.reader_task) + .await + .expect("reader task should exit after tun recv error"); + assert!(join_result.is_ok()); + assert!(stack.is_closed()); + + let mut buf = BytesMut::new(); + let recv_result = timeout(Duration::from_secs(1), socket.recv(&mut buf)) + .await + .expect("socket recv should not hang after reader task exits"); + assert_eq!(recv_result, None); + + let new_socket = stack.try_alloc_established_socket( + SocketAddr::new(Ipv4Addr::LOCALHOST.into(), 10_001), + SocketAddr::new(Ipv4Addr::new(192, 0, 2, 1).into(), 20_001), + State::Established, + ); + assert!(new_socket.is_none()); + + drop(socket); + } +} diff --git a/vendor/easytier/easytier/src/socket/mod.rs b/vendor/easytier/easytier/src/socket/mod.rs new file mode 100644 index 0000000..5acb760 --- /dev/null +++ b/vendor/easytier/easytier/src/socket/mod.rs @@ -0,0 +1,5 @@ +#[cfg(feature = "faketcp")] +pub(crate) mod fake_tcp; +pub(crate) mod tcp; +pub(crate) mod udp; +pub(crate) mod udp_src; diff --git a/vendor/easytier/easytier/src/socket/tcp.rs b/vendor/easytier/easytier/src/socket/tcp.rs new file mode 100644 index 0000000..e3c8f04 --- /dev/null +++ b/vendor/easytier/easytier/src/socket/tcp.rs @@ -0,0 +1,416 @@ +use std::{ + io, + net::{IpAddr, SocketAddr}, + pin::Pin, + task::{Context, Poll}, + time::Duration, +}; + +use easytier_core::{ + socket::tcp::{ + TcpBindOptions, TcpConnectOptions, TcpListenOptions, TcpListenPurpose, TcpSocketPurpose, + VirtualTcpListener, VirtualTcpSocket, VirtualTcpSplit, + }, + tunnel::TunnelError, +}; +use socket2::{SockRef, TcpKeepalive}; +#[cfg(unix)] +use tokio::net::UnixStream; +use tokio::{ + io::{AsyncRead, AsyncWrite, ReadBuf}, + net::{TcpListener, TcpSocket, TcpStream}, +}; + +use crate::{ + common::netns::NetNS, + socket_protector::protect_native_socket, + tunnel::common::{BindDev, apply_socket_mark, bind}, +}; + +enum RuntimeTcpSocketInner { + Tcp(TcpStream), + #[cfg(unix)] + Unix(UnixStream), + #[cfg(feature = "faketcp")] + FakeTcp(crate::socket::fake_tcp::FakeTcpSocket), +} + +pub struct RuntimeTcpSocket { + inner: RuntimeTcpSocketInner, +} + +impl RuntimeTcpSocket { + pub(crate) fn new(stream: TcpStream) -> Self { + if let Err(error) = stream.set_nodelay(true) { + tracing::warn!(?error, "set_nodelay failed for tcp stream"); + } + Self { + inner: RuntimeTcpSocketInner::Tcp(stream), + } + } + + #[cfg(unix)] + pub(crate) fn from_unix(stream: UnixStream) -> Self { + Self { + inner: RuntimeTcpSocketInner::Unix(stream), + } + } + + #[cfg(feature = "faketcp")] + pub(crate) fn from_fake_tcp(socket: crate::socket::fake_tcp::FakeTcpSocket) -> Self { + Self { + inner: RuntimeTcpSocketInner::FakeTcp(socket), + } + } +} + +#[cfg(unix)] +pub(crate) fn url_from_unix_socket_addr(addr: tokio::net::unix::SocketAddr) -> Option { + addr.as_pathname() + .and_then(|path| path.to_str()) + .and_then(|path| format!("unix://{path}").parse().ok()) +} + +impl AsyncRead for RuntimeTcpSocket { + fn poll_read( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + match &mut self.inner { + RuntimeTcpSocketInner::Tcp(stream) => Pin::new(stream).poll_read(cx, buf), + #[cfg(unix)] + RuntimeTcpSocketInner::Unix(stream) => Pin::new(stream).poll_read(cx, buf), + #[cfg(feature = "faketcp")] + RuntimeTcpSocketInner::FakeTcp(socket) => Pin::new(socket).poll_read(cx, buf), + } + } +} + +impl AsyncWrite for RuntimeTcpSocket { + fn poll_write( + mut self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + match &mut self.inner { + RuntimeTcpSocketInner::Tcp(stream) => Pin::new(stream).poll_write(cx, buf), + #[cfg(unix)] + RuntimeTcpSocketInner::Unix(stream) => Pin::new(stream).poll_write(cx, buf), + #[cfg(feature = "faketcp")] + RuntimeTcpSocketInner::FakeTcp(socket) => Pin::new(socket).poll_write(cx, buf), + } + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + match &mut self.inner { + RuntimeTcpSocketInner::Tcp(stream) => Pin::new(stream).poll_flush(cx), + #[cfg(unix)] + RuntimeTcpSocketInner::Unix(stream) => Pin::new(stream).poll_flush(cx), + #[cfg(feature = "faketcp")] + RuntimeTcpSocketInner::FakeTcp(socket) => Pin::new(socket).poll_flush(cx), + } + } + + fn poll_shutdown(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + match &mut self.inner { + RuntimeTcpSocketInner::Tcp(stream) => Pin::new(stream).poll_shutdown(cx), + #[cfg(unix)] + RuntimeTcpSocketInner::Unix(stream) => Pin::new(stream).poll_shutdown(cx), + #[cfg(feature = "faketcp")] + RuntimeTcpSocketInner::FakeTcp(socket) => Pin::new(socket).poll_shutdown(cx), + } + } +} + +impl VirtualTcpSocket for RuntimeTcpSocket { + fn into_split(self) -> VirtualTcpSplit { + match self.inner { + RuntimeTcpSocketInner::Tcp(stream) => { + let (reader, writer) = stream.into_split(); + (Box::new(reader), Box::new(writer)) + } + #[cfg(unix)] + RuntimeTcpSocketInner::Unix(stream) => { + let (reader, writer) = stream.into_split(); + (Box::new(reader), Box::new(writer)) + } + #[cfg(feature = "faketcp")] + RuntimeTcpSocketInner::FakeTcp(socket) => { + let (reader, writer) = tokio::io::split(socket); + (Box::new(reader), Box::new(writer)) + } + } + } + + fn local_addr(&self) -> io::Result { + match &self.inner { + RuntimeTcpSocketInner::Tcp(stream) => stream.local_addr(), + #[cfg(unix)] + RuntimeTcpSocketInner::Unix(_) => Err(io::Error::new( + io::ErrorKind::Unsupported, + "Unix stream has no IP local address", + )), + #[cfg(feature = "faketcp")] + RuntimeTcpSocketInner::FakeTcp(socket) => socket.local_addr(), + } + } + + fn peer_addr(&self) -> io::Result { + match &self.inner { + RuntimeTcpSocketInner::Tcp(stream) => stream.peer_addr(), + #[cfg(unix)] + RuntimeTcpSocketInner::Unix(_) => Err(io::Error::new( + io::ErrorKind::Unsupported, + "Unix stream has no IP peer address", + )), + #[cfg(feature = "faketcp")] + RuntimeTcpSocketInner::FakeTcp(socket) => socket.peer_addr(), + } + } + + fn transport_label(&self) -> Option<&str> { + match &self.inner { + #[cfg(feature = "faketcp")] + RuntimeTcpSocketInner::FakeTcp(socket) => socket.transport_label(), + RuntimeTcpSocketInner::Tcp(_) => None, + #[cfg(unix)] + RuntimeTcpSocketInner::Unix(_) => None, + } + } +} + +#[derive(Debug)] +pub struct RuntimeTcpListener { + listener: TcpListener, + purpose: TcpListenPurpose, + need_protect: bool, +} + +#[async_trait::async_trait] +impl VirtualTcpListener for RuntimeTcpListener { + type Socket = RuntimeTcpSocket; + + fn local_addr(&self) -> io::Result { + self.listener.local_addr() + } + + async fn accept(&self) -> io::Result<(Self::Socket, SocketAddr)> { + let (stream, addr) = self.listener.accept().await?; + protect_native_socket(&SockRef::from(&stream), self.need_protect).await?; + if self.purpose == TcpListenPurpose::ProxyNat { + prepare_proxy_tcp_socket(&stream)?; + } + Ok((RuntimeTcpSocket::new(stream), addr)) + } +} + +fn unspecified_bind_addr(remote_addr: SocketAddr) -> SocketAddr { + match remote_addr { + SocketAddr::V4(_) => SocketAddr::new(IpAddr::from([0, 0, 0, 0]), 0), + SocketAddr::V6(_) => SocketAddr::new(IpAddr::from([0, 0, 0, 0, 0, 0, 0, 0]), 0), + } +} + +fn bind_dev_from_options(options: &TcpBindOptions, local_addr_was_defaulted: bool) -> BindDev { + options + .bind_device + .clone() + .map(BindDev::from) + .unwrap_or_else(|| { + if local_addr_was_defaulted { + BindDev::Disabled + } else { + BindDev::Auto + } + }) +} + +async fn bind_tcp_socket( + remote_addr: SocketAddr, + bind_options: &TcpBindOptions, +) -> Result { + let (bind_addr, local_addr_was_defaulted) = match bind_options.local_addr { + Some(addr) => (addr, false), + None => (unspecified_bind_addr(remote_addr), true), + }; + let bind_dev = bind_dev_from_options(bind_options, local_addr_was_defaulted); + + bind::() + .addr(bind_addr) + .dev(bind_dev) + .net_ns(NetNS::from_socket_context(&bind_options.context)) + .only_v6(bind_options.only_v6) + .reuse_addr(native_reuse_addr(bind_options)) + .reuse_port(bind_options.reuse_port) + .maybe_socket_mark(bind_options.context.socket_mark) + .need_protect(bind_options.need_protect) + .call() + .await +} + +pub(crate) async fn create_tcp_socket( + remote_addr: SocketAddr, + bind_options: &TcpBindOptions, +) -> Result { + if must_bind_before_connect(bind_options) { + return bind_tcp_socket(remote_addr, bind_options).await; + } + // A network namespace is a thread property, but the socket retains its + // namespace after creation. Never keep the guard across connect().await. + let socket = + NetNS::from_socket_context(&bind_options.context).run(|| -> Result<_, TunnelError> { + let socket = if remote_addr.is_ipv4() { + TcpSocket::new_v4()? + } else { + TcpSocket::new_v6()? + }; + apply_socket_mark( + &socket2::SockRef::from(&socket), + bind_options.context.socket_mark, + )?; + Ok(socket) + })?; + protect_native_socket(&SockRef::from(&socket), bind_options.need_protect).await?; + Ok(socket) +} + +fn must_bind_before_connect(bind_options: &TcpBindOptions) -> bool { + bind_options.local_addr.is_some() + || bind_options.bind_device.is_some() + || bind_options.reuse_port + || bind_options.only_v6 + || bind_options + .reuse_addr + .is_some_and(|reuse_addr| reuse_addr != native_reuse_addr_default()) +} + +fn native_reuse_addr_default() -> bool { + !cfg!(target_os = "windows") +} + +fn native_reuse_addr(bind_options: &TcpBindOptions) -> bool { + bind_options + .reuse_addr + .unwrap_or_else(native_reuse_addr_default) +} + +pub(crate) async fn bind_tcp_listener( + options: TcpListenOptions, +) -> Result { + let purpose = options.purpose; + let mut bind_options = options.bind; + let addr = bind_options.local_addr.ok_or_else(|| { + TunnelError::InvalidAddr("tcp listener requires a local bind address".to_owned()) + })?; + if bind_options.bind_device.is_none() && purpose == TcpListenPurpose::PortLease { + bind_options.bind_device = Some(String::new()); + } + let listener = create_tcp_socket(addr, &bind_options).await?.listen(1024)?; + Ok(RuntimeTcpListener { + listener, + purpose, + need_protect: bind_options.need_protect, + }) +} + +pub(crate) async fn connect_tcp( + options: TcpConnectOptions, +) -> Result { + let remote_addr = options.remote_addr; + let purpose = options.purpose; + let bind_options = options.bind; + + let socket = create_tcp_socket(remote_addr, &bind_options).await?; + let stream = socket.connect(remote_addr).await?; + prepare_connected_tcp_socket(&stream, purpose)?; + Ok(RuntimeTcpSocket::new(stream)) +} + +fn prepare_connected_tcp_socket(stream: &TcpStream, purpose: TcpSocketPurpose) -> io::Result<()> { + match purpose { + TcpSocketPurpose::ProxyNat => prepare_proxy_tcp_socket(stream), + TcpSocketPurpose::StunProbe => SockRef::from(stream).set_linger(Some(Duration::ZERO)), + _ => Ok(()), + } +} + +pub(crate) fn prepare_proxy_tcp_socket(stream: &TcpStream) -> io::Result<()> { + const TCP_KEEPALIVE_TIME: std::time::Duration = std::time::Duration::from_secs(5); + const TCP_KEEPALIVE_INTERVAL: std::time::Duration = std::time::Duration::from_secs(2); + #[cfg(not(target_os = "windows"))] + const TCP_KEEPALIVE_RETRIES: u32 = 2; + + let keepalive = TcpKeepalive::new() + .with_time(TCP_KEEPALIVE_TIME) + .with_interval(TCP_KEEPALIVE_INTERVAL); + + #[cfg(not(target_os = "windows"))] + let keepalive = keepalive.with_retries(TCP_KEEPALIVE_RETRIES); + + let socket = SockRef::from(stream); + socket.set_tcp_keepalive(&keepalive)?; + if let Err(error) = socket.set_tcp_nodelay(true) { + tracing::warn!(?error, "set_nodelay failed, ignore it"); + } + + Ok(()) +} + +#[cfg(test)] +mod tests { + use tokio::io::{AsyncReadExt as _, AsyncWriteExt as _}; + + use super::*; + + #[tokio::test] + async fn runtime_tcp_owned_split_preserves_full_duplex_and_shutdown() { + let listener = TcpListener::bind("127.0.0.1:0").await.unwrap(); + let address = listener.local_addr().unwrap(); + let (client, accepted) = tokio::join!(TcpStream::connect(address), listener.accept()); + let client = client.unwrap(); + let (mut server, _) = accepted.unwrap(); + let (mut reader, mut writer) = RuntimeTcpSocket::new(client).into_split(); + + writer.write_all(b"client-to-server").await.unwrap(); + let mut from_client = [0; 16]; + server.read_exact(&mut from_client).await.unwrap(); + assert_eq!(&from_client, b"client-to-server"); + + server.write_all(b"server-to-client").await.unwrap(); + let mut from_server = [0; 16]; + reader.read_exact(&mut from_server).await.unwrap(); + assert_eq!(&from_server, b"server-to-client"); + + writer.shutdown().await.unwrap(); + let mut after_shutdown = [0; 1]; + assert_eq!(server.read(&mut after_shutdown).await.unwrap(), 0); + } + + #[test] + fn tcp_connect_binds_when_socket_option_requires_pre_connect_setup() { + assert!(must_bind_before_connect( + &TcpBindOptions::default().with_local_addr(Some("127.0.0.1:0".parse().unwrap())) + )); + assert!(must_bind_before_connect( + &TcpBindOptions::default().with_reuse_port(true) + )); + assert!(must_bind_before_connect( + &TcpBindOptions::default().with_only_v6(true) + )); + assert!(must_bind_before_connect( + &TcpBindOptions::default().with_bind_device(Some("eth0".to_owned())) + )); + assert!(!must_bind_before_connect(&TcpBindOptions::default())); + assert!(!must_bind_before_connect( + &TcpBindOptions::default().with_reuse_addr(native_reuse_addr_default()) + )); + assert!(must_bind_before_connect( + &TcpBindOptions::default().with_reuse_addr(!native_reuse_addr_default()) + )); + assert_eq!( + native_reuse_addr(&TcpBindOptions::default()), + native_reuse_addr_default() + ); + } +} diff --git a/vendor/easytier/easytier/src/socket/udp.rs b/vendor/easytier/easytier/src/socket/udp.rs new file mode 100644 index 0000000..0f413c7 --- /dev/null +++ b/vendor/easytier/easytier/src/socket/udp.rs @@ -0,0 +1,419 @@ +use std::{ + net::{IpAddr, Ipv4Addr, SocketAddr, SocketAddrV4}, + sync::Arc, +}; + +use async_trait::async_trait; +#[cfg(any(feature = "wireguard", test))] +use easytier_core::socket::{ + NetNamespace, + udp::{UdpSessionAcceptKind, UdpSessionListenRequest, UdpSessionSocketListener}, +}; +use easytier_core::socket::{ + SocketContext, + udp::{ + MAX_UDP_DATAGRAM_SIZE, MAX_UDP_SESSION_DATAGRAM_SIZE, UdpBindOptions, UdpSocketDatagram, + UdpSocketPurpose, UdpSocketRecvMeta, UdpSocketSendMeta, VirtualUdpSocket, + VirtualUdpSocketFactory, + }, +}; +use tokio::net::UdpSocket; + +#[cfg(any(feature = "wireguard", test))] +use crate::host_runtime::{NativeHostRuntime, native_host_runtime}; +use crate::{ + common::netns::NetNS, + tunnel::common::{BindDev, bind}, +}; + +use super::udp_src; + +#[cfg(any(feature = "wireguard", test))] +pub(crate) type RuntimeUdpSessionSocketListener = UdpSessionSocketListener; + +#[cfg(any(feature = "wireguard", test))] +pub(crate) fn new_runtime_udp_session_listener( + url: url::Url, + mut request: UdpSessionListenRequest, + accept_kind: UdpSessionAcceptKind, + net_ns: NetNS, +) -> RuntimeUdpSessionSocketListener { + request.bind.context.netns = net_ns.name().map(NetNamespace::new); + let runtime = native_host_runtime(); + UdpSessionSocketListener::new_with_request(url, request, accept_kind, runtime) +} + +pub struct RuntimeUdpSocket { + socket: Arc, + context: SocketContext, +} + +impl RuntimeUdpSocket { + #[cfg(test)] + fn new(socket: Arc) -> Self { + Self::new_with_context(socket, SocketContext::default()) + } + + pub(crate) fn new_with_context(socket: Arc, context: SocketContext) -> Self { + if let Err(err) = udp_src::enable_recv_pktinfo(&socket) { + tracing::debug!(?err, "enable udp pktinfo failed"); + } + Self { socket, context } + } + + #[cfg(target_os = "windows")] + pub(crate) fn socket(&self) -> Arc { + self.socket.clone() + } +} + +#[async_trait] +impl VirtualUdpSocket for RuntimeUdpSocket { + fn local_addr(&self) -> std::io::Result { + self.socket.local_addr() + } + + fn socket_context(&self) -> SocketContext { + self.context.clone() + } + + async fn send_to(&self, data: &[u8], addr: SocketAddr) -> std::io::Result { + self.socket.send_to(data, addr).await + } + + async fn recv_from(&self, buf: &mut [u8]) -> std::io::Result<(usize, SocketAddr)> { + self.socket.recv_from(buf).await + } + + async fn send_to_with_meta( + &self, + data: &[u8], + addr: SocketAddr, + meta: UdpSocketSendMeta, + ) -> std::io::Result { + if let (Some(IpAddr::V6(src)), Some(ifindex), SocketAddr::V6(dst)) = + (meta.src_ip, meta.src_ifindex, addr) + { + return udp_src::send_to_with_src_ipv6(&self.socket, src, ifindex, dst, data); + } + if let Some(src_ip) = meta.src_ip { + return udp_src::send_to_with_src_ip(&self.socket, src_ip, addr, data).await; + } + self.socket.try_send_to(data, addr) + } + + async fn recv_from_with_meta( + &self, + buf: &mut [u8], + ) -> std::io::Result<(usize, SocketAddr, UdpSocketRecvMeta)> { + let (len, addr, dst_ip) = udp_src::recv_from_with_dst_ip(&self.socket, buf).await?; + Ok((len, addr, UdpSocketRecvMeta { dst_ip })) + } + + #[cfg(unix)] + async fn recv_datagram(&self) -> std::io::Result { + let (payload, remote_addr, dst_ip) = + udp_src::recv_datagram_with_dst_ip(&self.socket, MAX_UDP_DATAGRAM_SIZE).await?; + Ok(UdpSocketDatagram { + payload, + remote_addr, + meta: UdpSocketRecvMeta { dst_ip }, + }) + } + + #[cfg(unix)] + async fn recv_session_datagram(&self) -> std::io::Result { + let (payload, remote_addr, dst_ip) = + udp_src::recv_datagram_with_dst_ip(&self.socket, MAX_UDP_SESSION_DATAGRAM_SIZE).await?; + Ok(UdpSocketDatagram { + payload, + remote_addr, + meta: UdpSocketRecvMeta { dst_ip }, + }) + } +} + +#[derive(Debug, Clone, Copy, Default)] +pub(crate) struct RuntimeUdpSocketFactory; + +impl RuntimeUdpSocketFactory { + pub(crate) fn new() -> Self { + Self + } + + fn bind_device_for(&self, options: &UdpBindOptions) -> BindDev { + if let Some(bind_device) = &options.bind_device { + return BindDev::from(bind_device.as_str()); + } + + if matches!( + options.purpose, + UdpSocketPurpose::DirectConnect + | UdpSocketPurpose::PortBoundListener + | UdpSocketPurpose::PortForward + ) { + return BindDev::Auto; + } + + BindDev::Disabled + } + + fn reuse_addr_for(&self, options: &UdpBindOptions) -> bool { + options.reuse_addr + || (matches!( + options.purpose, + UdpSocketPurpose::PortBoundListener + | UdpSocketPurpose::ProxyNat + | UdpSocketPurpose::PortForward + ) && !cfg!(target_os = "windows")) + } +} + +/// Creates a host-owned UDP socket, including any required protection, before +/// it can be used by DNS, a route probe, or a virtual socket adapter. +pub(crate) async fn create_udp_socket(options: &UdpBindOptions) -> anyhow::Result { + let factory = RuntimeUdpSocketFactory::new(); + let bind_addr = options + .local_addr + .unwrap_or_else(|| SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0))); + Ok(bind::() + .addr(bind_addr) + .dev(factory.bind_device_for(options)) + .net_ns(NetNS::from_socket_context(&options.context)) + .only_v6(options.only_v6) + .reuse_addr(factory.reuse_addr_for(options)) + .reuse_port(options.reuse_port) + .maybe_socket_mark(options.context.socket_mark) + .need_protect(options.need_protect) + .call() + .await?) +} + +#[async_trait] +impl VirtualUdpSocketFactory for RuntimeUdpSocketFactory { + type Socket = RuntimeUdpSocket; + + async fn bind_udp(&self, options: UdpBindOptions) -> anyhow::Result> { + let socket = create_udp_socket(&options).await?; + Ok(Arc::new(RuntimeUdpSocket::new_with_context( + Arc::new(socket), + options.context, + ))) + } +} + +#[cfg(test)] +mod tests { + use easytier_core::{ + socket::SocketListener, + socket::udp::{ + UdpSessionListenRequest, send_v4_hole_punch_control_packet, + send_v6_hole_punch_control_packet, + }, + }; + + use crate::host_runtime::native_host_runtime; + + use super::*; + + #[cfg(any(target_os = "linux", target_os = "android"))] + #[tokio::test] + async fn runtime_udp_socket_reports_ipv4_destination_ip() { + let socket = Arc::new(UdpSocket::bind("0.0.0.0:0").await.unwrap()); + let runtime_socket = RuntimeUdpSocket::new(socket.clone()); + let client = UdpSocket::bind("127.0.0.1:0").await.unwrap(); + client + .send_to( + b"pktinfo", + SocketAddr::from(([127, 0, 0, 1], socket.local_addr().unwrap().port())), + ) + .await + .unwrap(); + + let mut buf = [0; 32]; + let (len, _peer, meta) = runtime_socket.recv_from_with_meta(&mut buf).await.unwrap(); + + assert_eq!(&buf[..len], b"pktinfo"); + assert_eq!(meta.dst_ip, Some(std::net::IpAddr::V4(Ipv4Addr::LOCALHOST))); + } + + #[cfg(unix)] + #[tokio::test] + async fn runtime_udp_socket_receives_owned_datagram_with_destination_ip() { + let socket = Arc::new(UdpSocket::bind("0.0.0.0:0").await.unwrap()); + let runtime_socket = RuntimeUdpSocket::new(socket.clone()); + let client = UdpSocket::bind("127.0.0.1:0").await.unwrap(); + client + .send_to( + b"owned-pktinfo", + SocketAddr::from(([127, 0, 0, 1], socket.local_addr().unwrap().port())), + ) + .await + .unwrap(); + + let datagram = runtime_socket.recv_datagram().await.unwrap(); + + assert_eq!(datagram.payload, b"owned-pktinfo".as_slice()); + assert_eq!( + datagram.meta.dst_ip, + Some(std::net::IpAddr::V4(Ipv4Addr::LOCALHOST)) + ); + } + + #[cfg(unix)] + #[tokio::test] + async fn runtime_udp_socket_drops_truncated_datagrams() { + let socket = Arc::new(UdpSocket::bind("127.0.0.1:0").await.unwrap()); + let runtime_socket = RuntimeUdpSocket::new(socket.clone()); + let client = UdpSocket::bind("127.0.0.1:0").await.unwrap(); + let server_addr = socket.local_addr().unwrap(); + + client + .send_to(&vec![0xAA; MAX_UDP_SESSION_DATAGRAM_SIZE + 1], server_addr) + .await + .unwrap(); + client + .send_to(b"after-oversized", server_addr) + .await + .unwrap(); + + let datagram = tokio::time::timeout( + std::time::Duration::from_secs(1), + runtime_socket.recv_session_datagram(), + ) + .await + .unwrap() + .unwrap(); + + assert_eq!(datagram.payload, b"after-oversized".as_slice()); + } + + #[tokio::test] + async fn runtime_v4_hole_punch_control_packet_is_forwarded() { + let local_addr = SocketAddr::from(([0, 0, 0, 0], 0)); + let mut listener = new_runtime_udp_session_listener( + "udp://0.0.0.0:0".parse().unwrap(), + UdpSessionListenRequest::new(UdpBindOptions::port_bound_listener(local_addr)), + UdpSessionAcceptKind::EasyTierMux, + NetNS::new(None), + ); + listener.listen().await.unwrap(); + + let receiver = UdpSocket::bind("127.0.0.1:0").await.unwrap(); + let runtime = native_host_runtime(); + send_v4_hole_punch_control_packet( + runtime.as_ref(), + SocketContext::default(), + listener.local_url().port().unwrap(), + match receiver.local_addr().unwrap() { + SocketAddr::V4(addr) => addr, + SocketAddr::V6(_) => unreachable!(), + }, + ) + .await + .unwrap(); + + let mut buf = [0; 128]; + tokio::time::timeout( + std::time::Duration::from_secs(2), + receiver.recv_from(&mut buf), + ) + .await + .expect("timeout waiting for v4 hole-punch packet") + .unwrap(); + } + + #[tokio::test] + async fn runtime_v6_hole_punch_control_packet_is_forwarded() { + let local_addr = "[::]:0".parse().unwrap(); + let mut listener = new_runtime_udp_session_listener( + "udp://[::]:0".parse().unwrap(), + UdpSessionListenRequest::new(UdpBindOptions::port_bound_listener(local_addr)), + UdpSessionAcceptKind::EasyTierMux, + NetNS::new(None), + ); + listener.listen().await.unwrap(); + + let receiver = UdpSocket::bind("[::]:0").await.unwrap(); + let runtime = native_host_runtime(); + send_v6_hole_punch_control_packet( + runtime.as_ref(), + SocketContext::default(), + listener.local_url().port().unwrap(), + match receiver.local_addr().unwrap() { + SocketAddr::V6(addr) => addr, + SocketAddr::V4(_) => unreachable!(), + }, + None, + ) + .await + .unwrap(); + + let mut buf = [0; 128]; + tokio::time::timeout( + std::time::Duration::from_secs(2), + receiver.recv_from(&mut buf), + ) + .await + .expect("timeout waiting for v6 hole-punch packet") + .unwrap(); + } + + #[test] + fn factory_interprets_bind_defaults_by_purpose() { + let listener_addr = SocketAddr::from(([0, 0, 0, 0], 11010)); + let factory = RuntimeUdpSocketFactory::new(); + + assert!(matches!( + factory.bind_device_for(&UdpBindOptions::port_bound_listener(listener_addr)), + BindDev::Auto + )); + assert!(matches!( + factory.bind_device_for(&UdpBindOptions::direct_connect()), + BindDev::Auto + )); + assert!(matches!( + factory.bind_device_for(&UdpBindOptions::port_forward(listener_addr)), + BindDev::Auto + )); + assert!(matches!( + factory.bind_device_for(&UdpBindOptions::port_lease(listener_addr)), + BindDev::Disabled + )); + assert!(matches!( + factory.bind_device_for(&UdpBindOptions::hole_punch_control()), + BindDev::Disabled + )); + assert_eq!( + factory.reuse_addr_for(&UdpBindOptions::port_bound_listener(listener_addr)), + !cfg!(target_os = "windows") + ); + assert!(!factory.reuse_addr_for(&UdpBindOptions::hole_punch_control())); + assert_eq!( + factory.reuse_addr_for(&UdpBindOptions::proxy_nat()), + !cfg!(target_os = "windows") + ); + assert_eq!( + factory.reuse_addr_for(&UdpBindOptions::port_forward(listener_addr)), + !cfg!(target_os = "windows") + ); + assert!(!factory.reuse_addr_for(&UdpBindOptions::port_lease(listener_addr))); + } + + #[test] + fn factory_applies_listener_bind_device_option() { + let listener_addr = SocketAddr::from(([0, 0, 0, 0], 11010)); + let factory = RuntimeUdpSocketFactory::new(); + let options = UdpBindOptions::port_bound_listener(listener_addr) + .with_bind_device(Some("eth0".to_owned())); + + match factory.bind_device_for(&options) { + BindDev::Custom(dev) => assert_eq!(dev, "eth0"), + bind_device => panic!("unexpected bind device: {bind_device:?}"), + } + assert!(matches!( + factory.bind_device_for(&UdpBindOptions::hole_punch_control()), + BindDev::Disabled + )); + } +} diff --git a/vendor/easytier/easytier/src/socket/udp_src.rs b/vendor/easytier/easytier/src/socket/udp_src.rs new file mode 100644 index 0000000..f6e2355 --- /dev/null +++ b/vendor/easytier/easytier/src/socket/udp_src.rs @@ -0,0 +1,13 @@ +#[cfg(unix)] +#[path = "udp_src/unix.rs"] +mod platform; + +#[cfg(windows)] +#[path = "udp_src/windows.rs"] +mod platform; + +#[cfg(not(any(unix, windows)))] +#[path = "udp_src/fallback.rs"] +mod platform; + +pub(crate) use platform::*; diff --git a/vendor/easytier/easytier/src/socket/udp_src/fallback.rs b/vendor/easytier/easytier/src/socket/udp_src/fallback.rs new file mode 100644 index 0000000..a5857da --- /dev/null +++ b/vendor/easytier/easytier/src/socket/udp_src/fallback.rs @@ -0,0 +1,81 @@ +use std::{ + io, + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6}, +}; + +use tokio::net::UdpSocket; + +pub(crate) fn enable_recv_pktinfo(_socket: &UdpSocket) -> io::Result<()> { + Ok(()) +} + +pub(crate) async fn recv_from_with_dst_ip( + socket: &UdpSocket, + buf: &mut [u8], +) -> io::Result<(usize, SocketAddr, Option)> { + let (len, addr) = socket.recv_from(buf).await?; + Ok((len, addr, None)) +} + +pub(crate) async fn send_to_with_src_ip( + socket: &UdpSocket, + src_ip: IpAddr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + match (src_ip, dst_addr) { + (IpAddr::V4(src), SocketAddr::V4(dst)) => { + send_to_with_src_ipv4(socket, src, dst, buf).await + } + (IpAddr::V4(src), SocketAddr::V6(dst)) => { + let Some(mapped_dst) = dst.ip().to_ipv4_mapped() else { + return Err(source_address_family_mismatch(src, dst)); + }; + send_to_with_src_ipv4(socket, src, SocketAddrV4::new(mapped_dst, dst.port()), buf).await + } + (IpAddr::V6(src), SocketAddr::V6(dst)) => { + socket + .async_io(tokio::io::Interest::WRITABLE, || { + send_to_with_src_ipv6(socket, src, 0, dst, buf) + }) + .await + } + (src, dst) => Err(source_address_family_mismatch(src, dst)), + } +} + +async fn send_to_with_src_ipv4( + socket: &UdpSocket, + _src_ip: Ipv4Addr, + dst_addr: SocketAddrV4, + buf: &[u8], +) -> io::Result { + socket + .async_io(tokio::io::Interest::WRITABLE, || { + socket.try_send_to(buf, SocketAddr::V4(dst_addr)) + }) + .await +} + +fn send_to_with_src_ipv6( + _socket: &UdpSocket, + _src_ip: Ipv6Addr, + _src_ifindex: u32, + _dst_addr: SocketAddrV6, + _buf: &[u8], +) -> io::Result { + Err(io::Error::new( + io::ErrorKind::Unsupported, + "sending UDP with a selected IPv6 source is not supported on this platform", + )) +} + +fn source_address_family_mismatch( + src: impl std::fmt::Display, + dst: impl std::fmt::Display, +) -> io::Error { + io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src} does not match destination {dst} family"), + ) +} diff --git a/vendor/easytier/easytier/src/socket/udp_src/unix.rs b/vendor/easytier/easytier/src/socket/udp_src/unix.rs new file mode 100644 index 0000000..3aa6a6c --- /dev/null +++ b/vendor/easytier/easytier/src/socket/udp_src/unix.rs @@ -0,0 +1,611 @@ +use std::{ + io, + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6}, +}; + +use bytes::BytesMut; +use tokio::net::UdpSocket; + +pub(crate) fn enable_recv_pktinfo(socket: &UdpSocket) -> io::Result<()> { + use std::os::fd::AsRawFd; + + use nix::libc; + + let fd = socket.as_raw_fd(); + let enabled: libc::c_int = 1; + unsafe { + #[cfg(any(target_os = "linux", target_os = "android"))] + let _ = libc::setsockopt( + fd, + libc::IPPROTO_IP, + libc::IP_PKTINFO, + &enabled as *const _ as *const libc::c_void, + std::mem::size_of_val(&enabled) as libc::socklen_t, + ); + #[cfg(any( + target_os = "freebsd", + target_os = "openbsd", + target_os = "netbsd", + target_os = "macos", + target_os = "ios" + ))] + let _ = libc::setsockopt( + fd, + libc::IPPROTO_IP, + libc::IP_RECVDSTADDR, + &enabled as *const _ as *const libc::c_void, + std::mem::size_of_val(&enabled) as libc::socklen_t, + ); + let _ = libc::setsockopt( + fd, + libc::IPPROTO_IPV6, + libc::IPV6_RECVPKTINFO, + &enabled as *const _ as *const libc::c_void, + std::mem::size_of_val(&enabled) as libc::socklen_t, + ); + } + Ok(()) +} + +#[cfg(not(any(unix, windows)))] +pub(crate) fn enable_recv_pktinfo(_socket: &UdpSocket) -> io::Result<()> { + Ok(()) +} + +pub(crate) async fn recv_from_with_dst_ip( + socket: &UdpSocket, + buf: &mut [u8], +) -> io::Result<(usize, SocketAddr, Option)> { + socket + .async_io(tokio::io::Interest::READABLE, || { + loop { + match recv_from_with_dst_ip_once(socket, buf) { + Err(err) if err.kind() == io::ErrorKind::Interrupted => continue, + ret => break ret, + } + } + }) + .await +} + +pub(crate) async fn recv_datagram_with_dst_ip( + socket: &UdpSocket, + capacity: usize, +) -> io::Result<(BytesMut, SocketAddr, Option)> { + let mut payload = BytesMut::with_capacity(capacity); + let (len, remote_addr, dst_ip) = socket + .async_io(tokio::io::Interest::READABLE, || { + loop { + let ret = unsafe { + recv_from_with_dst_ip_raw(socket, payload.as_mut_ptr(), payload.capacity()) + }; + match ret { + Err(err) if err.kind() == io::ErrorKind::Interrupted => continue, + Ok((_len, _remote_addr, _dst_ip, true)) => { + tracing::debug!(capacity, "dropping oversized udp session datagram"); + } + Ok((len, remote_addr, dst_ip, false)) => { + break Ok((len, remote_addr, dst_ip)); + } + Err(err) => break Err(err), + } + } + }) + .await?; + unsafe { + payload.set_len(len); + } + Ok((payload, remote_addr, dst_ip)) +} + +#[cfg(not(any(unix, windows)))] +pub(crate) async fn recv_from_with_dst_ip( + socket: &UdpSocket, + buf: &mut [u8], +) -> io::Result<(usize, SocketAddr, Option)> { + let (len, addr) = socket.recv_from(buf).await?; + Ok((len, addr, None)) +} + +fn recv_from_with_dst_ip_once( + socket: &UdpSocket, + buf: &mut [u8], +) -> io::Result<(usize, SocketAddr, Option)> { + unsafe { recv_from_with_dst_ip_raw(socket, buf.as_mut_ptr(), buf.len()) } + .map(|(len, remote_addr, dst_ip, _truncated)| (len, remote_addr, dst_ip)) +} + +unsafe fn recv_from_with_dst_ip_raw( + socket: &UdpSocket, + buf_ptr: *mut u8, + buf_len: usize, +) -> io::Result<(usize, SocketAddr, Option, bool)> { + use std::{mem, os::fd::AsRawFd}; + + use nix::libc; + + #[repr(align(8))] + struct ControlBuffer([u8; 256]); + + fn sockaddr_to_socket_addr( + storage: &libc::sockaddr_storage, + len: libc::socklen_t, + ) -> io::Result { + match storage.ss_family as libc::c_int { + libc::AF_INET => { + if (len as usize) < mem::size_of::() { + return Err(io::Error::new( + io::ErrorKind::InvalidData, + "short IPv4 sockaddr", + )); + } + let addr = unsafe { &*(storage as *const _ as *const libc::sockaddr_in) }; + let ip = Ipv4Addr::from(u32::from_be(addr.sin_addr.s_addr)); + let port = u16::from_be(addr.sin_port); + Ok(SocketAddr::V4(SocketAddrV4::new(ip, port))) + } + libc::AF_INET6 => { + if (len as usize) < mem::size_of::() { + return Err(io::Error::new( + io::ErrorKind::InvalidData, + "short IPv6 sockaddr", + )); + } + let addr = unsafe { &*(storage as *const _ as *const libc::sockaddr_in6) }; + let ip = Ipv6Addr::from(addr.sin6_addr.s6_addr); + let port = u16::from_be(addr.sin6_port); + Ok(SocketAddr::V6(SocketAddrV6::new( + ip, + port, + addr.sin6_flowinfo, + addr.sin6_scope_id, + ))) + } + _ => Err(io::Error::new( + io::ErrorKind::InvalidData, + "unsupported UDP sockaddr family", + )), + } + } + + let mut iov = libc::iovec { + iov_base: buf_ptr as *mut libc::c_void, + iov_len: buf_len, + }; + let mut name = unsafe { mem::zeroed::() }; + let mut control = ControlBuffer([0u8; 256]); + let mut msg = unsafe { mem::zeroed::() }; + msg.msg_name = &mut name as *mut _ as *mut libc::c_void; + msg.msg_namelen = mem::size_of::() as _; + msg.msg_iov = &mut iov; + msg.msg_iovlen = 1; + msg.msg_control = control.0.as_mut_ptr() as *mut libc::c_void; + msg.msg_controllen = control.0.len() as _; + + let len = unsafe { libc::recvmsg(socket.as_raw_fd(), &mut msg, 0) }; + if len < 0 { + return Err(io::Error::last_os_error()); + } + + let remote_addr = sockaddr_to_socket_addr(&name, msg.msg_namelen)?; + let mut dst_ip = None; + unsafe { + let mut cmsg = libc::CMSG_FIRSTHDR(&msg); + while !cmsg.is_null() { + #[cfg(any(target_os = "linux", target_os = "android"))] + { + if (*cmsg).cmsg_level == libc::IPPROTO_IP && (*cmsg).cmsg_type == libc::IP_PKTINFO { + let pktinfo = &*(libc::CMSG_DATA(cmsg) as *const libc::in_pktinfo); + dst_ip = Some(IpAddr::V4(Ipv4Addr::from(u32::from_be( + pktinfo.ipi_addr.s_addr, + )))); + } + } + #[cfg(any( + target_os = "freebsd", + target_os = "openbsd", + target_os = "netbsd", + target_os = "macos", + target_os = "ios" + ))] + { + if (*cmsg).cmsg_level == libc::IPPROTO_IP + && (*cmsg).cmsg_type == libc::IP_RECVDSTADDR + { + let addr = &*(libc::CMSG_DATA(cmsg) as *const libc::in_addr); + dst_ip = Some(IpAddr::V4(Ipv4Addr::from(u32::from_be(addr.s_addr)))); + } + } + if (*cmsg).cmsg_level == libc::IPPROTO_IPV6 && (*cmsg).cmsg_type == libc::IPV6_PKTINFO { + let pktinfo = &*(libc::CMSG_DATA(cmsg) as *const libc::in6_pktinfo); + dst_ip = Some(IpAddr::V6(Ipv6Addr::from(pktinfo.ipi6_addr.s6_addr))); + } + cmsg = libc::CMSG_NXTHDR(&msg, cmsg); + } + } + + let truncated = msg.msg_flags & libc::MSG_TRUNC != 0; + Ok((len as usize, remote_addr, dst_ip, truncated)) +} + +#[cfg(any(target_os = "linux", target_os = "android"))] +pub(crate) async fn send_to_with_src_ip( + socket: &UdpSocket, + src_ip: IpAddr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + socket + .async_io(tokio::io::Interest::WRITABLE, || { + send_to_with_src_ip_raw(socket, src_ip, dst_addr, buf) + }) + .await +} + +#[cfg(not(any(target_os = "linux", target_os = "android")))] +pub(crate) async fn send_to_with_src_ip( + socket: &UdpSocket, + src_ip: IpAddr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + match (src_ip, dst_addr) { + (IpAddr::V4(src), SocketAddr::V4(dst)) => { + socket + .async_io(tokio::io::Interest::WRITABLE, || { + send_to_with_src_ipv4_to_addr(socket, src, SocketAddr::V4(dst), buf) + }) + .await + } + (IpAddr::V4(src), SocketAddr::V6(dst)) => { + if dst.ip().to_ipv4_mapped().is_none() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src} does not match destination {dst} family"), + )); + } + socket + .async_io(tokio::io::Interest::WRITABLE, || { + send_to_with_src_ipv4_to_addr(socket, src, SocketAddr::V6(dst), buf) + }) + .await + } + (IpAddr::V6(src), SocketAddr::V6(dst)) => { + socket + .async_io(tokio::io::Interest::WRITABLE, || { + send_to_with_src_ipv6(socket, src, 0, dst, buf) + }) + .await + } + (src, dst) => Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src} does not match destination {dst} family"), + )), + } +} + +#[cfg(not(any(target_os = "linux", target_os = "android")))] +fn send_to_with_src_ipv4_to_addr( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + match dst_addr { + SocketAddr::V4(dst) => send_to_with_src_ipv4(socket, src_ip, dst, buf), + SocketAddr::V6(dst) => { + let Some(mapped_dst) = dst.ip().to_ipv4_mapped() else { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src_ip} does not match destination {dst} family"), + )); + }; + send_to_with_src_ipv4_mapped_v6(socket, src_ip, dst, mapped_dst, buf) + } + } +} + +#[cfg(not(any(target_os = "linux", target_os = "android", windows)))] +fn send_to_with_src_ipv4_mapped_v6( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddrV6, + mapped_dst: Ipv4Addr, + buf: &[u8], +) -> io::Result { + send_to_with_src_ipv4( + socket, + src_ip, + SocketAddrV4::new(mapped_dst, dst_addr.port()), + buf, + ) +} + +#[cfg(any(target_os = "linux", target_os = "android"))] +fn send_to_with_src_ip_raw( + socket: &UdpSocket, + src_ip: IpAddr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + match (src_ip, dst_addr) { + (IpAddr::V4(src), SocketAddr::V4(dst)) => send_to_with_src_ipv4(socket, src, dst, buf), + (IpAddr::V4(src), SocketAddr::V6(dst)) => { + let Some(mapped_dst) = dst.ip().to_ipv4_mapped() else { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src} does not match destination {dst} family"), + )); + }; + send_to_with_src_ipv4(socket, src, SocketAddrV4::new(mapped_dst, dst.port()), buf) + } + (IpAddr::V6(src), SocketAddr::V6(dst)) => send_to_with_src_ipv6(socket, src, 0, dst, buf), + (src, dst) => Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src} does not match destination {dst} family"), + )), + } +} + +#[cfg(any(target_os = "linux", target_os = "android"))] +fn send_to_with_src_ipv4( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddrV4, + buf: &[u8], +) -> io::Result { + use std::{mem, os::fd::AsRawFd, ptr}; + + use nix::libc; + + #[repr(align(8))] + struct ControlBuffer([u8; 128]); + + let pktinfo = libc::in_pktinfo { + ipi_ifindex: 0, + ipi_spec_dst: libc::in_addr { + s_addr: u32::from(src_ip).to_be(), + }, + ipi_addr: libc::in_addr { s_addr: 0 }, + }; + let mut iov = libc::iovec { + iov_base: buf.as_ptr() as *mut libc::c_void, + iov_len: buf.len(), + }; + let dst_addr = socket2::SockAddr::from(std::net::SocketAddr::V4(dst_addr)); + let control_len = + unsafe { libc::CMSG_SPACE(mem::size_of::() as libc::c_uint) as usize }; + let mut control = ControlBuffer([0u8; 128]); + if control_len > control.0.len() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv4 packet info control buffer is too small", + )); + } + + let mut msg = unsafe { mem::zeroed::() }; + msg.msg_name = dst_addr.as_ptr() as *mut libc::c_void; + msg.msg_namelen = dst_addr.len() as _; + msg.msg_iov = &mut iov; + msg.msg_iovlen = 1; + msg.msg_control = control.0.as_mut_ptr() as *mut libc::c_void; + msg.msg_controllen = control_len as _; + + unsafe { + let cmsg = libc::CMSG_FIRSTHDR(&msg); + if cmsg.is_null() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv4 packet info control buffer is invalid", + )); + } + (*cmsg).cmsg_level = libc::IPPROTO_IP; + (*cmsg).cmsg_type = libc::IP_PKTINFO; + (*cmsg).cmsg_len = libc::CMSG_LEN(mem::size_of::() as libc::c_uint) as _; + ptr::write(libc::CMSG_DATA(cmsg) as *mut libc::in_pktinfo, pktinfo); + + let ret = libc::sendmsg(socket.as_raw_fd(), &msg, 0); + if ret < 0 { + Err(io::Error::last_os_error()) + } else { + Ok(ret as usize) + } + } +} + +#[cfg(any( + target_os = "freebsd", + target_os = "openbsd", + target_os = "netbsd", + target_os = "macos", + target_os = "ios" +))] +fn send_to_with_src_ipv4( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddrV4, + buf: &[u8], +) -> io::Result { + use std::{mem, os::fd::AsRawFd, ptr}; + + use nix::libc; + + #[repr(align(8))] + struct ControlBuffer([u8; 128]); + + if let Ok(SocketAddr::V4(local_addr)) = socket.local_addr() { + if !local_addr.ip().is_unspecified() { + return socket.try_send_to(buf, SocketAddr::V4(dst_addr)); + } + } + + let src_addr = libc::in_addr { + s_addr: u32::from(src_ip).to_be(), + }; + let mut iov = libc::iovec { + iov_base: buf.as_ptr() as *mut libc::c_void, + iov_len: buf.len(), + }; + let dst_addr = socket2::SockAddr::from(std::net::SocketAddr::V4(dst_addr)); + let control_len = + unsafe { libc::CMSG_SPACE(mem::size_of::() as libc::c_uint) as usize }; + let mut control = ControlBuffer([0u8; 128]); + if control_len > control.0.len() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv4 source address control buffer is too small", + )); + } + + let mut msg = unsafe { mem::zeroed::() }; + msg.msg_name = dst_addr.as_ptr() as *mut libc::c_void; + msg.msg_namelen = dst_addr.len() as _; + msg.msg_iov = &mut iov; + msg.msg_iovlen = 1; + msg.msg_control = control.0.as_mut_ptr() as *mut libc::c_void; + msg.msg_controllen = control_len as _; + + unsafe { + let cmsg = libc::CMSG_FIRSTHDR(&msg); + if cmsg.is_null() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv4 source address control buffer is invalid", + )); + } + (*cmsg).cmsg_level = libc::IPPROTO_IP; + (*cmsg).cmsg_type = libc::IP_RECVDSTADDR; + (*cmsg).cmsg_len = libc::CMSG_LEN(mem::size_of::() as libc::c_uint) as _; + ptr::write(libc::CMSG_DATA(cmsg) as *mut libc::in_addr, src_addr); + + let ret = libc::sendmsg(socket.as_raw_fd(), &msg, 0); + if ret < 0 { + Err(io::Error::last_os_error()) + } else { + Ok(ret as usize) + } + } +} + +#[cfg(not(any( + target_os = "linux", + target_os = "android", + target_os = "freebsd", + target_os = "openbsd", + target_os = "netbsd", + target_os = "macos", + target_os = "ios", + windows +)))] +fn send_to_with_src_ipv4( + socket: &UdpSocket, + _src_ip: Ipv4Addr, + dst_addr: SocketAddrV4, + buf: &[u8], +) -> io::Result { + socket.try_send_to(buf, SocketAddr::V4(dst_addr)) +} + +pub(crate) fn send_to_with_src_ipv6( + socket: &UdpSocket, + src_ip: Ipv6Addr, + src_ifindex: u32, + dst_addr: SocketAddrV6, + buf: &[u8], +) -> io::Result { + #[cfg(target_env = "ohos")] + { + let _ = (socket, src_ip, src_ifindex, dst_addr, buf); + return Err(io::Error::new( + io::ErrorKind::Unsupported, + "sending UDP with a selected IPv6 source is not supported on OHOS", + )); + } + + #[cfg(not(target_env = "ohos"))] + { + use std::{mem, os::fd::AsRawFd, ptr}; + + use nix::libc; + + #[repr(align(8))] + struct ControlBuffer([u8; 128]); + + #[cfg(target_os = "android")] + let ipi6_ifindex: libc::c_int = i32::try_from(src_ifindex).map_err(|_| { + io::Error::new( + io::ErrorKind::InvalidInput, + "IPv6 source interface index is out of range", + ) + })?; + #[cfg(not(target_os = "android"))] + let ipi6_ifindex: libc::c_uint = src_ifindex; + + let pktinfo = libc::in6_pktinfo { + ipi6_addr: libc::in6_addr { + s6_addr: src_ip.octets(), + }, + ipi6_ifindex, + }; + let mut iov = libc::iovec { + iov_base: buf.as_ptr() as *mut libc::c_void, + iov_len: buf.len(), + }; + let dst_addr = socket2::SockAddr::from(std::net::SocketAddr::V6(dst_addr)); + let control_len = unsafe { + libc::CMSG_SPACE(mem::size_of::() as libc::c_uint) as usize + }; + let mut control = ControlBuffer([0u8; 128]); + if control_len > control.0.len() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv6 packet info control buffer is too small", + )); + } + + let mut msg = unsafe { mem::zeroed::() }; + msg.msg_name = dst_addr.as_ptr() as *mut libc::c_void; + msg.msg_namelen = dst_addr.len() as _; + msg.msg_iov = &mut iov; + msg.msg_iovlen = 1; + msg.msg_control = control.0.as_mut_ptr() as *mut libc::c_void; + msg.msg_controllen = control_len as _; + msg.msg_flags = 0; + + unsafe { + let cmsg = libc::CMSG_FIRSTHDR(&msg); + if cmsg.is_null() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv6 packet info control buffer is invalid", + )); + } + (*cmsg).cmsg_level = libc::IPPROTO_IPV6; + (*cmsg).cmsg_type = libc::IPV6_PKTINFO; + (*cmsg).cmsg_len = + libc::CMSG_LEN(mem::size_of::() as libc::c_uint) as _; + ptr::write(libc::CMSG_DATA(cmsg) as *mut libc::in6_pktinfo, pktinfo); + + let ret = libc::sendmsg(socket.as_raw_fd(), &msg, 0); + if ret < 0 { + Err(io::Error::last_os_error()) + } else { + Ok(ret as usize) + } + } + } +} + +#[cfg(not(any(unix, windows)))] +pub(crate) fn send_to_with_src_ipv6( + _socket: &UdpSocket, + _src_ip: Ipv6Addr, + _src_ifindex: u32, + _dst_addr: SocketAddrV6, + _buf: &[u8], +) -> io::Result { + Err(io::Error::new( + io::ErrorKind::Unsupported, + "sending UDP with a selected IPv6 source is not supported on this platform", + )) +} diff --git a/vendor/easytier/easytier/src/socket/udp_src/windows.rs b/vendor/easytier/easytier/src/socket/udp_src/windows.rs new file mode 100644 index 0000000..813d429 --- /dev/null +++ b/vendor/easytier/easytier/src/socket/udp_src/windows.rs @@ -0,0 +1,716 @@ +use std::{ + io, + net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6}, +}; + +use std::sync::OnceLock; + +use tokio::net::UdpSocket; + +pub(crate) fn enable_recv_pktinfo(socket: &UdpSocket) -> io::Result<()> { + use std::os::windows::io::AsRawSocket; + + use windows::Win32::Networking::WinSock::{ + IP_PKTINFO, IPPROTO_IP, IPPROTO_IPV6, IPV6_PKTINFO, SOCKET, setsockopt, + }; + + let enabled = 1u32.to_ne_bytes(); + unsafe { + let _ = setsockopt( + SOCKET(socket.as_raw_socket() as usize), + IPPROTO_IP.0, + IP_PKTINFO, + Some(&enabled), + ); + let _ = setsockopt( + SOCKET(socket.as_raw_socket() as usize), + IPPROTO_IPV6.0, + IPV6_PKTINFO, + Some(&enabled), + ); + } + Ok(()) +} + +#[cfg(not(any(unix, windows)))] +pub(crate) fn enable_recv_pktinfo(_socket: &UdpSocket) -> io::Result<()> { + Ok(()) +} + +pub(crate) async fn recv_from_with_dst_ip( + socket: &UdpSocket, + buf: &mut [u8], +) -> io::Result<(usize, SocketAddr, Option)> { + socket + .async_io(tokio::io::Interest::READABLE, || { + loop { + match recv_from_with_dst_ip_once(socket, buf) { + Err(err) if err.kind() == io::ErrorKind::Interrupted => continue, + ret => break ret, + } + } + }) + .await +} + +#[cfg(not(any(unix, windows)))] +pub(crate) async fn recv_from_with_dst_ip( + socket: &UdpSocket, + buf: &mut [u8], +) -> io::Result<(usize, SocketAddr, Option)> { + let (len, addr) = socket.recv_from(buf).await?; + Ok((len, addr, None)) +} + +fn windows_cmsghdr_align(length: usize) -> usize { + use windows::Win32::Networking::WinSock::CMSGHDR; + + (length + std::mem::align_of::() - 1) & !(std::mem::align_of::() - 1) +} + +fn windows_cmsgdata_align(length: usize) -> usize { + (length + std::mem::align_of::() - 1) & !(std::mem::align_of::() - 1) +} + +fn windows_cmsg_len(length: usize) -> usize { + use windows::Win32::Networking::WinSock::CMSGHDR; + + windows_cmsgdata_align(std::mem::size_of::()) + length +} + +fn windows_cmsg_space(length: usize) -> usize { + use windows::Win32::Networking::WinSock::CMSGHDR; + + windows_cmsgdata_align(std::mem::size_of::() + windows_cmsghdr_align(length)) +} + +fn windows_cmsg_data(cmsg: *mut windows::Win32::Networking::WinSock::CMSGHDR) -> *mut u8 { + (cmsg as usize + + windows_cmsgdata_align(std::mem::size_of::< + windows::Win32::Networking::WinSock::CMSGHDR, + >())) as *mut u8 +} + +fn wsa_recvmsg_ptr() -> windows::Win32::Networking::WinSock::LPFN_WSARECVMSG { + use std::mem; + + use windows::Win32::Networking::WinSock::{ + AF_INET, INVALID_SOCKET, IPPROTO_UDP, SIO_GET_EXTENSION_FUNCTION_POINTER, SOCK_DGRAM, + WSAID_WSARECVMSG, WSAIoctl, closesocket, socket, + }; + + static WSA_RECVMSG: OnceLock = + OnceLock::new(); + + *WSA_RECVMSG.get_or_init(|| unsafe { + let Ok(socket) = socket(AF_INET.0.into(), SOCK_DGRAM, IPPROTO_UDP.0) else { + return None; + }; + if socket == INVALID_SOCKET { + return None; + } + + let guid = WSAID_WSARECVMSG; + let mut recvmsg = None; + let mut len = 0; + let ret = WSAIoctl( + socket, + SIO_GET_EXTENSION_FUNCTION_POINTER, + Some(&guid as *const _ as *const _), + mem::size_of_val(&guid) as u32, + Some(&mut recvmsg as *mut _ as *mut _), + mem::size_of_val(&recvmsg) as u32, + &mut len, + None, + None, + ); + closesocket(socket); + if ret == -1 || len as usize != mem::size_of_val(&recvmsg) { + None + } else { + recvmsg + } + }) +} + +fn sockaddr_inet_to_socket_addr( + addr: &windows::Win32::Networking::WinSock::SOCKADDR_INET, +) -> io::Result { + use windows::Win32::Networking::WinSock::{AF_INET, AF_INET6}; + + let family = unsafe { addr.si_family }; + if family == AF_INET { + let addr = unsafe { addr.Ipv4 }; + let ip = Ipv4Addr::from(u32::from_be(unsafe { addr.sin_addr.S_un.S_addr })); + let port = u16::from_be(addr.sin_port); + return Ok(SocketAddr::V4(SocketAddrV4::new(ip, port))); + } + if family == AF_INET6 { + let addr = unsafe { addr.Ipv6 }; + let ip = Ipv6Addr::from(unsafe { addr.sin6_addr.u.Byte }); + let port = u16::from_be(addr.sin6_port); + let scope_id = unsafe { addr.Anonymous.sin6_scope_id }; + return Ok(SocketAddr::V6(SocketAddrV6::new( + ip, + port, + addr.sin6_flowinfo, + scope_id, + ))); + } + Err(io::Error::new( + io::ErrorKind::InvalidData, + "unsupported UDP sockaddr family", + )) +} + +fn recv_from_with_dst_ip_once( + socket: &UdpSocket, + buf: &mut [u8], +) -> io::Result<(usize, SocketAddr, Option)> { + use std::{mem, os::windows::io::AsRawSocket, ptr}; + + use windows::{ + Win32::Networking::WinSock::{ + CMSGHDR, IN_PKTINFO, IN6_PKTINFO, IP_PKTINFO, IPPROTO_IP, IPPROTO_IPV6, IPV6_PKTINFO, + SOCKADDR_INET, SOCKET, SOCKET_ERROR, WSABUF, WSAGetLastError, WSAMSG, + }, + core::PSTR, + }; + + #[repr(align(8))] + struct ControlBuffer([u8; 256]); + + let Some(wsa_recvmsg) = wsa_recvmsg_ptr() else { + return Err(io::Error::new( + io::ErrorKind::Unsupported, + "WSARecvMsg is not supported", + )); + }; + + let mut source = unsafe { mem::zeroed::() }; + let mut data = WSABUF { + len: buf.len() as u32, + buf: PSTR(buf.as_mut_ptr()), + }; + let mut control = ControlBuffer([0u8; 256]); + let mut msg = WSAMSG { + name: &mut source as *mut _ as *mut _, + namelen: mem::size_of_val(&source) as i32, + lpBuffers: &mut data, + dwBufferCount: 1, + Control: WSABUF { + len: control.0.len() as u32, + buf: PSTR(control.0.as_mut_ptr()), + }, + dwFlags: 0, + }; + + let mut len = 0; + let ret = unsafe { + wsa_recvmsg( + SOCKET(socket.as_raw_socket() as usize), + &mut msg, + &mut len, + ptr::null_mut(), + None, + ) + }; + if ret == SOCKET_ERROR { + return Err(io::Error::from_raw_os_error(unsafe { WSAGetLastError().0 })); + } + + let remote_addr = sockaddr_inet_to_socket_addr(&source)?; + let mut dst_ip = None; + let control_start = msg.Control.buf.0 as usize; + let control_end = control_start + msg.Control.len as usize; + let mut cmsg_ptr = control_start; + while cmsg_ptr + mem::size_of::() <= control_end { + let cmsg = cmsg_ptr as *const CMSGHDR; + let cmsg_len = unsafe { (*cmsg).cmsg_len }; + if cmsg_len < mem::size_of::() || cmsg_ptr + cmsg_len > control_end { + break; + } + match (unsafe { (*cmsg).cmsg_level }, unsafe { (*cmsg).cmsg_type }) { + (level, cmsg_type) if level == IPPROTO_IP.0 && cmsg_type == IP_PKTINFO => { + let pktinfo = unsafe { &*(windows_cmsg_data(cmsg as *mut _) as *const IN_PKTINFO) }; + dst_ip = Some(IpAddr::V4(Ipv4Addr::from(u32::from_be(unsafe { + pktinfo.ipi_addr.S_un.S_addr + })))); + } + (level, cmsg_type) if level == IPPROTO_IPV6.0 && cmsg_type == IPV6_PKTINFO => { + let pktinfo = + unsafe { &*(windows_cmsg_data(cmsg as *mut _) as *const IN6_PKTINFO) }; + dst_ip = Some(IpAddr::V6(Ipv6Addr::from(unsafe { + pktinfo.ipi6_addr.u.Byte + }))); + } + _ => {} + } + cmsg_ptr += windows_cmsghdr_align(cmsg_len); + } + + Ok((len as usize, remote_addr, dst_ip)) +} + +#[cfg(any(target_os = "linux", target_os = "android"))] +pub(crate) async fn send_to_with_src_ip( + socket: &UdpSocket, + src_ip: IpAddr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + socket + .async_io(tokio::io::Interest::WRITABLE, || { + send_to_with_src_ip_raw(socket, src_ip, dst_addr, buf) + }) + .await +} + +#[cfg(not(any(target_os = "linux", target_os = "android")))] +pub(crate) async fn send_to_with_src_ip( + socket: &UdpSocket, + src_ip: IpAddr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + match (src_ip, dst_addr) { + (IpAddr::V4(src), SocketAddr::V4(dst)) => { + socket + .async_io(tokio::io::Interest::WRITABLE, || { + send_to_with_src_ipv4_to_addr(socket, src, SocketAddr::V4(dst), buf) + }) + .await + } + (IpAddr::V4(src), SocketAddr::V6(dst)) => { + if dst.ip().to_ipv4_mapped().is_none() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src} does not match destination {dst} family"), + )); + } + socket + .async_io(tokio::io::Interest::WRITABLE, || { + send_to_with_src_ipv4_to_addr(socket, src, SocketAddr::V6(dst), buf) + }) + .await + } + (IpAddr::V6(src), SocketAddr::V6(dst)) => { + socket + .async_io(tokio::io::Interest::WRITABLE, || { + send_to_with_src_ipv6(socket, src, 0, dst, buf) + }) + .await + } + (src, dst) => Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src} does not match destination {dst} family"), + )), + } +} + +#[cfg(not(any(target_os = "linux", target_os = "android")))] +fn send_to_with_src_ipv4_to_addr( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + match dst_addr { + SocketAddr::V4(dst) => send_to_with_src_ipv4(socket, src_ip, dst, buf), + SocketAddr::V6(dst) => { + let Some(mapped_dst) = dst.ip().to_ipv4_mapped() else { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src_ip} does not match destination {dst} family"), + )); + }; + send_to_with_src_ipv4_mapped_v6(socket, src_ip, dst, mapped_dst, buf) + } + } +} + +fn send_to_with_src_ipv4_mapped_v6( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddrV6, + _mapped_dst: Ipv4Addr, + buf: &[u8], +) -> io::Result { + send_to_with_src_ipv4_windows(socket, src_ip, SocketAddr::V6(dst_addr), buf) +} + +#[cfg(not(any(target_os = "linux", target_os = "android", windows)))] +fn send_to_with_src_ipv4_mapped_v6( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddrV6, + mapped_dst: Ipv4Addr, + buf: &[u8], +) -> io::Result { + send_to_with_src_ipv4( + socket, + src_ip, + SocketAddrV4::new(mapped_dst, dst_addr.port()), + buf, + ) +} + +#[cfg(any(target_os = "linux", target_os = "android"))] +fn send_to_with_src_ip_raw( + socket: &UdpSocket, + src_ip: IpAddr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + match (src_ip, dst_addr) { + (IpAddr::V4(src), SocketAddr::V4(dst)) => send_to_with_src_ipv4(socket, src, dst, buf), + (IpAddr::V4(src), SocketAddr::V6(dst)) => { + let Some(mapped_dst) = dst.ip().to_ipv4_mapped() else { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src} does not match destination {dst} family"), + )); + }; + send_to_with_src_ipv4(socket, src, SocketAddrV4::new(mapped_dst, dst.port()), buf) + } + (IpAddr::V6(src), SocketAddr::V6(dst)) => send_to_with_src_ipv6(socket, src, 0, dst, buf), + (src, dst) => Err(io::Error::new( + io::ErrorKind::InvalidInput, + format!("source address {src} does not match destination {dst} family"), + )), + } +} + +#[cfg(any(target_os = "linux", target_os = "android"))] +fn send_to_with_src_ipv4( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddrV4, + buf: &[u8], +) -> io::Result { + use std::{mem, os::fd::AsRawFd, ptr}; + + use nix::libc; + + #[repr(align(8))] + struct ControlBuffer([u8; 128]); + + let pktinfo = libc::in_pktinfo { + ipi_ifindex: 0, + ipi_spec_dst: libc::in_addr { + s_addr: u32::from(src_ip).to_be(), + }, + ipi_addr: libc::in_addr { s_addr: 0 }, + }; + let mut iov = libc::iovec { + iov_base: buf.as_ptr() as *mut libc::c_void, + iov_len: buf.len(), + }; + let dst_addr = socket2::SockAddr::from(std::net::SocketAddr::V4(dst_addr)); + let control_len = + unsafe { libc::CMSG_SPACE(mem::size_of::() as libc::c_uint) as usize }; + let mut control = ControlBuffer([0u8; 128]); + if control_len > control.0.len() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv4 packet info control buffer is too small", + )); + } + + let mut msg = unsafe { mem::zeroed::() }; + msg.msg_name = dst_addr.as_ptr() as *mut libc::c_void; + msg.msg_namelen = dst_addr.len() as _; + msg.msg_iov = &mut iov; + msg.msg_iovlen = 1; + msg.msg_control = control.0.as_mut_ptr() as *mut libc::c_void; + msg.msg_controllen = control_len as _; + + unsafe { + let cmsg = libc::CMSG_FIRSTHDR(&msg); + if cmsg.is_null() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv4 packet info control buffer is invalid", + )); + } + (*cmsg).cmsg_level = libc::IPPROTO_IP; + (*cmsg).cmsg_type = libc::IP_PKTINFO; + (*cmsg).cmsg_len = libc::CMSG_LEN(mem::size_of::() as libc::c_uint) as _; + ptr::write(libc::CMSG_DATA(cmsg) as *mut libc::in_pktinfo, pktinfo); + + let ret = libc::sendmsg(socket.as_raw_fd(), &msg, 0); + if ret < 0 { + Err(io::Error::last_os_error()) + } else { + Ok(ret as usize) + } + } +} + +#[cfg(any( + target_os = "freebsd", + target_os = "openbsd", + target_os = "netbsd", + target_os = "macos", + target_os = "ios" +))] +fn send_to_with_src_ipv4( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddrV4, + buf: &[u8], +) -> io::Result { + use std::{mem, os::fd::AsRawFd, ptr}; + + use nix::libc; + + #[repr(align(8))] + struct ControlBuffer([u8; 128]); + + if let Ok(SocketAddr::V4(local_addr)) = socket.local_addr() { + if !local_addr.ip().is_unspecified() { + return socket.try_send_to(buf, SocketAddr::V4(dst_addr)); + } + } + + let src_addr = libc::in_addr { + s_addr: u32::from(src_ip).to_be(), + }; + let mut iov = libc::iovec { + iov_base: buf.as_ptr() as *mut libc::c_void, + iov_len: buf.len(), + }; + let dst_addr = socket2::SockAddr::from(std::net::SocketAddr::V4(dst_addr)); + let control_len = + unsafe { libc::CMSG_SPACE(mem::size_of::() as libc::c_uint) as usize }; + let mut control = ControlBuffer([0u8; 128]); + if control_len > control.0.len() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv4 source address control buffer is too small", + )); + } + + let mut msg = unsafe { mem::zeroed::() }; + msg.msg_name = dst_addr.as_ptr() as *mut libc::c_void; + msg.msg_namelen = dst_addr.len() as _; + msg.msg_iov = &mut iov; + msg.msg_iovlen = 1; + msg.msg_control = control.0.as_mut_ptr() as *mut libc::c_void; + msg.msg_controllen = control_len as _; + + unsafe { + let cmsg = libc::CMSG_FIRSTHDR(&msg); + if cmsg.is_null() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv4 source address control buffer is invalid", + )); + } + (*cmsg).cmsg_level = libc::IPPROTO_IP; + (*cmsg).cmsg_type = libc::IP_RECVDSTADDR; + (*cmsg).cmsg_len = libc::CMSG_LEN(mem::size_of::() as libc::c_uint) as _; + ptr::write(libc::CMSG_DATA(cmsg) as *mut libc::in_addr, src_addr); + + let ret = libc::sendmsg(socket.as_raw_fd(), &msg, 0); + if ret < 0 { + Err(io::Error::last_os_error()) + } else { + Ok(ret as usize) + } + } +} + +fn send_to_with_src_ipv4( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddrV4, + buf: &[u8], +) -> io::Result { + send_to_with_src_ipv4_windows(socket, src_ip, SocketAddr::V4(dst_addr), buf) +} + +fn send_to_with_src_ipv4_windows( + socket: &UdpSocket, + src_ip: Ipv4Addr, + dst_addr: SocketAddr, + buf: &[u8], +) -> io::Result { + use std::{mem, os::windows::io::AsRawSocket, ptr}; + + use windows::{ + Win32::Networking::WinSock::{ + CMSGHDR, IN_ADDR, IN_ADDR_0, IN_PKTINFO, IP_PKTINFO, IPPROTO_IP, SOCKET, SOCKET_ERROR, + WSABUF, WSAGetLastError, WSAMSG, WSASendMsg, + }, + core::PSTR, + }; + + #[repr(align(8))] + struct ControlBuffer([u8; 128]); + + let dst = socket2::SockAddr::from(dst_addr); + let mut data = WSABUF { + len: buf.len() as u32, + buf: PSTR(buf.as_ptr() as *mut u8), + }; + let control_len = windows_cmsg_space(mem::size_of::()); + let mut control = ControlBuffer([0u8; 128]); + if control_len > control.0.len() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv4 packet info control buffer is too small", + )); + } + let msg = WSAMSG { + name: dst.as_ptr() as *mut _, + namelen: dst.len(), + lpBuffers: &mut data, + dwBufferCount: 1, + Control: WSABUF { + len: control_len as u32, + buf: PSTR(control.0.as_mut_ptr()), + }, + dwFlags: 0, + }; + + let pktinfo = IN_PKTINFO { + ipi_addr: IN_ADDR { + S_un: IN_ADDR_0 { + S_addr: u32::from(src_ip).to_be(), + }, + }, + ipi_ifindex: 0, + }; + + unsafe { + let cmsg = control.0.as_mut_ptr() as *mut CMSGHDR; + (*cmsg).cmsg_level = IPPROTO_IP.0; + (*cmsg).cmsg_type = IP_PKTINFO; + (*cmsg).cmsg_len = windows_cmsg_len(mem::size_of::()); + ptr::write(windows_cmsg_data(cmsg) as *mut IN_PKTINFO, pktinfo); + + let mut sent = 0; + let ret = WSASendMsg( + SOCKET(socket.as_raw_socket() as usize), + &msg, + 0, + Some(&mut sent), + None, + None, + ); + if ret == SOCKET_ERROR { + return Err(io::Error::from_raw_os_error(WSAGetLastError().0)); + } + Ok(sent as usize) + } +} + +#[cfg(not(any( + target_os = "linux", + target_os = "android", + target_os = "freebsd", + target_os = "openbsd", + target_os = "netbsd", + target_os = "macos", + target_os = "ios", + windows +)))] +fn send_to_with_src_ipv4( + socket: &UdpSocket, + _src_ip: Ipv4Addr, + dst_addr: SocketAddrV4, + buf: &[u8], +) -> io::Result { + socket.try_send_to(buf, SocketAddr::V4(dst_addr)) +} + +pub(crate) fn send_to_with_src_ipv6( + socket: &UdpSocket, + src_ip: Ipv6Addr, + src_ifindex: u32, + dst_addr: SocketAddrV6, + buf: &[u8], +) -> io::Result { + use std::{mem, os::windows::io::AsRawSocket, ptr}; + + use windows::{ + Win32::Networking::WinSock::{ + CMSGHDR, IN6_ADDR, IN6_ADDR_0, IN6_PKTINFO, IPPROTO_IPV6, IPV6_PKTINFO, SOCKET, + SOCKET_ERROR, WSABUF, WSAGetLastError, WSAMSG, WSASendMsg, + }, + core::PSTR, + }; + + #[repr(align(8))] + struct ControlBuffer([u8; 128]); + + let dst = socket2::SockAddr::from(std::net::SocketAddr::V6(dst_addr)); + let mut data = WSABUF { + len: buf.len() as u32, + buf: PSTR(buf.as_ptr() as *mut u8), + }; + let control_len = windows_cmsg_space(mem::size_of::()); + let mut control = ControlBuffer([0u8; 128]); + if control_len > control.0.len() { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "IPv6 packet info control buffer is too small", + )); + } + let msg = WSAMSG { + name: dst.as_ptr() as *mut _, + namelen: dst.len(), + lpBuffers: &mut data, + dwBufferCount: 1, + Control: WSABUF { + len: control_len as u32, + buf: PSTR(control.0.as_mut_ptr()), + }, + dwFlags: 0, + }; + + let pktinfo = IN6_PKTINFO { + ipi6_addr: IN6_ADDR { + u: IN6_ADDR_0 { + Byte: src_ip.octets(), + }, + }, + ipi6_ifindex: src_ifindex, + }; + + unsafe { + let cmsg = control.0.as_mut_ptr() as *mut CMSGHDR; + (*cmsg).cmsg_level = IPPROTO_IPV6.0; + (*cmsg).cmsg_type = IPV6_PKTINFO; + (*cmsg).cmsg_len = windows_cmsg_len(mem::size_of::()); + ptr::write(windows_cmsg_data(cmsg) as *mut IN6_PKTINFO, pktinfo); + let mut sent = 0; + let ret = WSASendMsg( + SOCKET(socket.as_raw_socket() as usize), + &msg, + 0, + Some(&mut sent), + None, + None, + ); + if ret == SOCKET_ERROR { + return Err(io::Error::from_raw_os_error(WSAGetLastError().0)); + } + Ok(sent as usize) + } +} + +#[cfg(not(any(unix, windows)))] +pub(crate) fn send_to_with_src_ipv6( + _socket: &UdpSocket, + _src_ip: Ipv6Addr, + _src_ifindex: u32, + _dst_addr: SocketAddrV6, + _buf: &[u8], +) -> io::Result { + Err(io::Error::new( + io::ErrorKind::Unsupported, + "sending UDP with a selected IPv6 source is not supported on this platform", + )) +} diff --git a/vendor/easytier/easytier/src/socket_protector.rs b/vendor/easytier/easytier/src/socket_protector.rs new file mode 100644 index 0000000..0806533 --- /dev/null +++ b/vendor/easytier/easytier/src/socket_protector.rs @@ -0,0 +1,235 @@ +use std::{ + io, + sync::{Arc, RwLock}, +}; + +use async_trait::async_trait; + +#[cfg(unix)] +use std::os::fd::AsRawFd; +#[cfg(windows)] +use std::os::windows::io::AsRawSocket; + +/// Native-only platform callback used by socket creation when `need_protect` +/// is set. The future must resolve only after protection is actually applied; +/// emitting an event without awaiting its acknowledgement is not sufficient. +/// Errors fail creation before bind/connect/listen or exposing an accepted child. +/// +/// WASI embedders implement the same contract inside their existing host socket +/// creation operations, using core's encoded bind options, not this raw-FD API. +#[async_trait] +pub trait NativeSocketProtector: Send + Sync + 'static { + async fn protect(&self, socket_handle: u64) -> io::Result<()>; +} + +static NATIVE_SOCKET_PROTECTOR: RwLock>> = RwLock::new(None); + +/// Installs or removes the process-wide native socket protection capability. +/// +/// Instance-specific routing policy still travels in socket options; this hook +/// only exposes a platform service such as Android/iOS/HarmonyOS VPN bypass. +pub fn set_native_socket_protector(protector: Option>) { + let mut guard = NATIVE_SOCKET_PROTECTOR + .write() + .unwrap_or_else(std::sync::PoisonError::into_inner); + *guard = protector; +} + +fn native_socket_protector() -> Option> { + #[cfg(all(test, unix))] + if let Ok(protector) = TEST_SOCKET_PROTECTOR.try_with(Arc::clone) { + return Some(protector); + } + NATIVE_SOCKET_PROTECTOR + .read() + .unwrap_or_else(std::sync::PoisonError::into_inner) + .clone() +} + +// Isolate factory ordering tests from other tests' sockets in the same process. +#[cfg(all(test, unix))] +tokio::task_local! { + static TEST_SOCKET_PROTECTOR: Arc; +} + +pub(crate) fn native_socket_protection_available() -> bool { + native_socket_protector().is_some() +} + +// socket2 owns the platform-specific handle; SockRef adapts Tokio sockets here. +pub(crate) async fn protect_native_socket( + socket: &socket2::Socket, + need_protect: bool, +) -> io::Result<()> { + if !need_protect { + return Ok(()); + } + let Some(protector) = native_socket_protector() else { + return Ok(()); + }; + #[cfg(unix)] + let handle = u64::try_from(socket.as_raw_fd()) + .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "invalid socket fd"))?; + #[cfg(windows)] + let handle = socket.as_raw_socket() as u64; + protector.protect(handle).await +} + +#[cfg(all(test, unix))] +mod tests { + use super::*; + use easytier_core::socket::{ + SocketListener, + tcp::{TcpBindOptions, TcpConnectOptions, TcpListenOptions, VirtualTcpListener}, + udp::UdpBindOptions, + }; + use std::{ + os::fd::BorrowedFd, + sync::atomic::{AtomicUsize, Ordering}, + time::Duration, + }; + use tokio::sync::Semaphore; + + struct GateProtector { + calls: AtomicUsize, + gate: Semaphore, + fail: bool, + expect_unbound: bool, + } + + impl GateProtector { + fn new(fail: bool, expect_unbound: bool) -> Arc { + Arc::new(Self { + calls: AtomicUsize::new(0), + gate: Semaphore::new(0), + fail, + expect_unbound, + }) + } + } + + #[async_trait] + impl NativeSocketProtector for GateProtector { + async fn protect(&self, handle: u64) -> io::Result<()> { + // The caller keeps the socket alive while this borrowed callback runs. + let fd = unsafe { BorrowedFd::borrow_raw(i32::try_from(handle).unwrap()) }; + let socket = socket2::SockRef::from(&fd); + if self.expect_unbound || self.calls.load(Ordering::SeqCst) == 0 { + assert_eq!(socket.local_addr()?.as_socket().unwrap().port(), 0); + assert!( + socket.peer_addr().is_err(), + "connect must wait for protect completion" + ); + } + self.calls.fetch_add(1, Ordering::SeqCst); + if self.fail { + return Err(io::Error::new( + io::ErrorKind::PermissionDenied, + "test protection failure", + )); + } + self.gate.acquire().await.unwrap().forget(); + Ok(()) + } + } + + #[tokio::test] + async fn tcp_connect_waits_for_protection_ack() { + let protector = GateProtector::new(false, true); + TEST_SOCKET_PROTECTOR + .scope(protector.clone(), async { + let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap(); + let options = TcpConnectOptions::direct_connect(listener.local_addr().unwrap()); + let connect = crate::socket::tcp::connect_tcp(options); + tokio::pin!(connect); + assert!(futures::poll!(&mut connect).is_pending()); + assert_eq!(protector.calls.load(Ordering::SeqCst), 1); + assert!( + tokio::time::timeout(Duration::from_millis(20), listener.accept()) + .await + .is_err() + ); + protector.gate.add_permits(1); + let _client = connect.await.unwrap(); + listener.accept().await.unwrap(); + }) + .await; + } + + #[tokio::test] + async fn protection_failure_blocks_creation_and_explicit_false_bypasses_callback() { + let protector = GateProtector::new(true, true); + TEST_SOCKET_PROTECTOR + .scope(protector.clone(), async { + let local = "127.0.0.1:0".parse().unwrap(); + let bind = TcpBindOptions::default().with_local_addr(Some(local)); + assert!( + crate::socket::tcp::create_tcp_socket(local, &bind) + .await + .is_err() + ); + assert!( + crate::socket::tcp::bind_tcp_listener(TcpListenOptions::direct_connect(local)) + .await + .is_err() + ); + let udp = UdpBindOptions::direct_connect().with_local_addr(Some(local)); + assert!(crate::socket::udp::create_udp_socket(&udp).await.is_err()); + assert_eq!(protector.calls.load(Ordering::SeqCst), 3); + + for options in [ + TcpListenOptions::proxy_nat(local), + TcpListenOptions::socks5(local), + TcpListenOptions::port_forward(local), + TcpListenOptions::port_lease(local), + ] { + let listener = crate::socket::tcp::bind_tcp_listener(options) + .await + .unwrap(); + let connect = TcpConnectOptions::direct_connect(listener.local_addr().unwrap()) + .with_bind(TcpBindOptions::default().with_need_protect(false)); + let _client = crate::socket::tcp::connect_tcp(connect).await.unwrap(); + listener.accept().await.unwrap(); + } + let udp = udp.with_need_protect(false); + crate::socket::udp::create_udp_socket(&udp).await.unwrap(); + let mut rpc = crate::proto::rpc::standalone::runtime_rpc_listener(local); + rpc.listen().await.unwrap(); + let rpc_addr = rpc.local_url().socket_addrs(|| None).unwrap()[0]; + let _client = tokio::net::TcpStream::connect(rpc_addr).await.unwrap(); + rpc.accept().await.unwrap(); + assert_eq!(protector.calls.load(Ordering::SeqCst), 3); + }) + .await; + } + + #[tokio::test] + async fn accepted_child_waits_for_inherited_protection() { + let protector = GateProtector::new(false, false); + TEST_SOCKET_PROTECTOR + .scope(protector.clone(), async { + let bind = crate::socket::tcp::bind_tcp_listener(TcpListenOptions::direct_connect( + "127.0.0.1:0".parse().unwrap(), + )); + tokio::pin!(bind); + assert!(futures::poll!(&mut bind).is_pending()); + assert_eq!(protector.calls.load(Ordering::SeqCst), 1); + protector.gate.add_permits(1); + let listener = bind.await.unwrap(); + let _client = tokio::net::TcpStream::connect(listener.local_addr().unwrap()) + .await + .unwrap(); + let accept = listener.accept(); + tokio::pin!(accept); + assert!( + tokio::time::timeout(Duration::from_millis(20), &mut accept) + .await + .is_err() + ); + assert_eq!(protector.calls.load(Ordering::SeqCst), 2); + protector.gate.add_permits(1); + accept.await.unwrap(); + }) + .await; + } +} diff --git a/vendor/easytier/easytier/src/tests/credential_tests.rs b/vendor/easytier/easytier/src/tests/credential_tests.rs new file mode 100644 index 0000000..3b86efa --- /dev/null +++ b/vendor/easytier/easytier/src/tests/credential_tests.rs @@ -0,0 +1,2847 @@ +//! Credential system integration tests +//! +//! These tests verify the credential-based authentication system where: +//! - Admin nodes hold network_secret and can generate credentials +//! - Credential nodes use X25519 keypairs to authenticate without network_secret +//! - Credentials can be revoked and propagate across the network + +use std::time::Duration; + +use easytier_core::{ + foundation::stats::{LabelSet, LabelType, MetricName}, + peers::credential_manager::CredentialCreateOptions, + process_runtime::CoreProcessRuntime, +}; + +#[cfg(feature = "wireguard")] +use crate::{ + common::config::{VpnPortalClientConfig, VpnPortalConfig}, + tests::three_node::{run_wireguard_client, wireguard_ifname}, + vpn_portal::wireguard::test_wireguard_keys, +}; +use crate::{ + common::{ + config::{ConfigLoader, NetworkIdentity, PeerConfig, TomlConfigLoader}, + global_ctx::GlobalCtxEvent, + }, + instance::test_instance::TestInstance as Instance, + proto::api::config::InstanceConfigPatch, + tests::three_node::{generate_secure_mode_config, generate_secure_mode_config_with_key}, + tunnel::common::tests::wait_for_condition, +}; +#[cfg(feature = "wireguard")] +use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; +#[cfg(feature = "wireguard")] +use defguard_wireguard_rs::key::Key; +#[cfg(feature = "wireguard")] +use easytier_core::gateway::vpn_portal::PortalClientState; + +use super::{ + InstanceTestExt as _, add_ns_to_bridge, create_netns, del_netns, drop_insts, ping_test, +}; + +use rstest::rstest; + +const PUBLIC_SERVER_NETWORK_NAME: &str = "__public_server__"; +const PUBLIC_SERVER_SHARED_SECRET: &str = "public-server-shared-secret"; +const NEED_P2P_ADMIN_NETWORK_NAME: &str = "need_p2p_credential_test_network"; + +async fn generate_credential( + admin: &Instance, + groups: Vec, + allow_relay: bool, + allowed_proxy_cidrs: Vec, + ttl: Duration, +) -> (String, String) { + generate_credential_with_options( + admin, + groups, + allow_relay, + allowed_proxy_cidrs, + ttl, + None, + true, + ) + .await +} + +async fn generate_credential_with_options( + admin: &Instance, + groups: Vec, + allow_relay: bool, + allowed_proxy_cidrs: Vec, + ttl: Duration, + credential_id: Option, + reusable: bool, +) -> (String, String) { + let generated = admin + .get_core_instance() + .generate_credential(CredentialCreateOptions { + groups, + allow_relay, + allowed_proxy_cidrs, + ttl, + credential_id, + reusable, + }) + .unwrap(); + (generated.credential_id, generated.secret) +} + +fn disable_p2p(config: &TomlConfigLoader) { + let mut flags = config.get_flags(); + flags.disable_p2p = true; + config.set_flags(flags); +} + +async fn set_prefer_peer_relay(inst: &Instance, prefer_peer_relay: bool) { + inst.get_config_patcher() + .apply_patch(InstanceConfigPatch { + prefer_peer_relay: Some(prefer_peer_relay), + ..Default::default() + }) + .await + .unwrap(); + assert_eq!( + inst.get_global_ctx().get_flags().prefer_peer_relay, + prefer_peer_relay + ); +} + +fn forwarded_data_packets_for_network(inst: &Instance, network_name: &str) -> u64 { + let labels = LabelSet::new().with_label_type(LabelType::NetworkName(network_name.to_owned())); + inst.get_core_instance() + .metric_snapshots() + .into_iter() + .find(|metric| { + metric.name == MetricName::TrafficPacketsForwarded && metric.labels == labels + }) + .map_or(0, |metric| metric.value) +} + +fn forwarded_data_packets(inst: &Instance) -> u64 { + forwarded_data_packets_for_network( + inst, + &inst.get_global_ctx().get_network_identity().network_name, + ) +} + +async fn assert_ping_forwarded_by( + src_ns: &str, + dst_ip: &str, + expected_forwarder: &Instance, + forbidden_forwarders: &[&Instance], +) { + wait_ping_reachability(src_ns, dst_ip, true, Duration::from_secs(10)).await; + let expected_before = forwarded_data_packets(expected_forwarder); + let forbidden_before: Vec<_> = forbidden_forwarders + .iter() + .map(|inst| forwarded_data_packets(inst)) + .collect(); + for _ in 0..3 { + assert!(ping_test(src_ns, dst_ip, None).await); + } + wait_for_condition( + || async { forwarded_data_packets(expected_forwarder) > expected_before }, + Duration::from_secs(5), + ) + .await; + for (forbidden_forwarder, forwarded_before) in forbidden_forwarders.iter().zip(forbidden_before) + { + assert_eq!( + forwarded_data_packets(forbidden_forwarder), + forwarded_before, + "data packets unexpectedly traversed a forbidden forwarder" + ); + } +} + +async fn wait_route_next_hop( + inst: &Instance, + peer_id: u32, + next_hop_peer_id: u32, + timeout: Duration, + label: &str, +) { + wait_for_condition( + || async { + let routes = inst.get_core_instance().route_snapshots().await; + let next_hop = routes + .iter() + .find(|route| route.peer_id == peer_id) + .map(|route| route.next_hop_peer_id); + println!( + "{label}: next_hop={next_hop:?}, target={peer_id}, expected={next_hop_peer_id}" + ); + next_hop == Some(next_hop_peer_id) + }, + timeout, + ) + .await; +} + +async fn disconnect_connector(inst: &Instance, url: &url::Url, peer_id: u32) { + assert!(inst.get_core_instance().remove_connector(url)); + let conn_ids = inst + .get_core_instance() + .peer_snapshots() + .await + .into_iter() + .find(|peer| peer.peer_id == peer_id) + .map(|peer| peer.directly_connected_conns) + .unwrap_or_default(); + assert!( + !conn_ids.is_empty(), + "direct peer has no connection to close" + ); + for conn_id in conn_ids { + let _ = inst + .get_core_instance() + .close_peer_conn(peer_id, &conn_id) + .await; + } + wait_for_condition( + || async { + !inst + .get_core_instance() + .connected_peers() + .await + .contains(&peer_id) + }, + Duration::from_secs(10), + ) + .await; +} + +/// Prepare network namespaces for credential tests +/// Topology: +/// br_a (10.1.1.0/24): ns_adm (10.1.1.1), ns_c1 (10.1.1.2), ns_c2 (10.1.1.3), ns_c3 (10.1.1.4), ns_c4 (10.1.1.5) +/// br_b (10.1.2.0/24): ns_adm2 (10.1.2.1) - for multi-admin tests +/// Note: Using short names (max 15 chars for veth interfaces) +pub fn prepare_credential_network() { + // Clean up any existing namespaces + for ns in ["ns_adm", "ns_c1", "ns_c2", "ns_c3", "ns_c4", "ns_adm2"] { + del_netns(ns); + } + + // Create bridge br_a for admin and credentials + let _ = std::process::Command::new("ip") + .args(["link", "del", "br_a"]) + .output(); + let _ = std::process::Command::new("brctl") + .args(["delbr", "br_a"]) + .output(); + let _ = std::process::Command::new("brctl") + .args(["addbr", "br_a"]) + .output() + .expect("Failed to create br_a"); + let _ = std::process::Command::new("ip") + .args(["link", "set", "br_a", "up"]) + .output(); + + // Create namespaces and add to bridge + create_netns("ns_adm", "10.1.1.1/24", "fd11::1/64"); + add_ns_to_bridge("br_a", "ns_adm"); + + create_netns("ns_c1", "10.1.1.2/24", "fd11::2/64"); + add_ns_to_bridge("br_a", "ns_c1"); + + create_netns("ns_c2", "10.1.1.3/24", "fd11::3/64"); + add_ns_to_bridge("br_a", "ns_c2"); + + // Create ns_c3 for relay tests (needs 4 nodes) + create_netns("ns_c3", "10.1.1.4/24", "fd11::4/64"); + add_ns_to_bridge("br_a", "ns_c3"); + + // Create ns_c4 for multi-admin credential tests (needs 5 nodes) + create_netns("ns_c4", "10.1.1.5/24", "fd11::5/64"); + add_ns_to_bridge("br_a", "ns_c4"); + + // Create bridge br_b for second admin (multi-admin tests) + let _ = std::process::Command::new("ip") + .args(["link", "del", "br_b"]) + .output(); + let _ = std::process::Command::new("brctl") + .args(["delbr", "br_b"]) + .output(); + let _ = std::process::Command::new("brctl") + .args(["addbr", "br_b"]) + .output() + .expect("Failed to create br_b"); + let _ = std::process::Command::new("ip") + .args(["link", "set", "br_b", "up"]) + .output(); + + create_netns("ns_adm2", "10.1.2.1/24", "fd12::1/64"); + add_ns_to_bridge("br_b", "ns_adm2"); +} + +fn credential_private_key_from_secret(credential_secret: &str) -> x25519_dalek::StaticSecret { + use base64::Engine as _; + + let privkey_bytes: [u8; 32] = base64::prelude::BASE64_STANDARD + .decode(credential_secret) + .unwrap() + .try_into() + .unwrap(); + + x25519_dalek::StaticSecret::from(privkey_bytes) +} + +fn build_credential_config( + network_name: String, + private_key: &x25519_dalek::StaticSecret, + inst_name: &str, + ns: Option<&str>, + ipv4: &str, + ipv6: &str, +) -> TomlConfigLoader { + let config = TomlConfigLoader::default(); + config.set_inst_name(inst_name.to_owned()); + config.set_netns(ns.map(|s| s.to_owned())); + config.set_ipv4(Some(ipv4.parse().unwrap())); + config.set_ipv6(Some(ipv6.parse().unwrap())); + config.set_listeners(vec![]); + config.set_network_identity(NetworkIdentity::new_credential(network_name)); + config.set_secure_mode(Some(generate_secure_mode_config_with_key(private_key))); + + config +} + +/// Helper: Create credential node config with generated credential +async fn create_credential_config( + admin_inst: &Instance, + inst_name: &str, + ns: Option<&str>, + ipv4: &str, + ipv6: &str, +) -> TomlConfigLoader { + let (_cred_id, cred_secret) = + generate_credential(admin_inst, vec![], false, vec![], Duration::from_secs(3600)).await; + + build_credential_config( + admin_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(), + &credential_private_key_from_secret(&cred_secret), + inst_name, + ns, + ipv4, + ipv6, + ) +} + +fn create_credential_config_from_secret( + network_name: String, + credential_secret: &str, + inst_name: &str, + ns: Option<&str>, + ipv4: &str, + ipv6: &str, +) -> TomlConfigLoader { + build_credential_config( + network_name, + &credential_private_key_from_secret(credential_secret), + inst_name, + ns, + ipv4, + ipv6, + ) +} + +/// Helper: Create credential node config with a random, unknown key +fn create_unknown_credential_config( + network_name: String, + inst_name: &str, + ns: Option<&str>, + ipv4: &str, + ipv6: &str, +) -> TomlConfigLoader { + let random_private = x25519_dalek::StaticSecret::random_from_rng(rand::rngs::OsRng); + build_credential_config(network_name, &random_private, inst_name, ns, ipv4, ipv6) +} + +/// Helper: Create admin node config +fn create_admin_config( + inst_name: &str, + ns: Option<&str>, + ipv4: &str, + ipv6: &str, +) -> TomlConfigLoader { + let config = TomlConfigLoader::default(); + config.set_inst_name(inst_name.to_owned()); + config.set_netns(ns.map(|s| s.to_owned())); + config.set_ipv4(Some(ipv4.parse().unwrap())); + config.set_ipv6(Some(ipv6.parse().unwrap())); + config.set_listeners(vec![ + "tcp://0.0.0.0:11010".parse().unwrap(), + "udp://0.0.0.0:11010".parse().unwrap(), + ]); + config.set_network_identity(NetworkIdentity::new( + "test_network".to_string(), + "test_secret".to_string(), + )); + config.set_secure_mode(Some(generate_secure_mode_config())); + + config +} + +fn create_shared_config( + inst_name: &str, + ns: Option<&str>, + ipv4: &str, + ipv6: &str, +) -> TomlConfigLoader { + let config = TomlConfigLoader::default(); + config.set_inst_name(inst_name.to_owned()); + config.set_netns(ns.map(|s| s.to_owned())); + config.set_ipv4(Some(ipv4.parse().unwrap())); + config.set_ipv6(Some(ipv6.parse().unwrap())); + config.set_listeners(vec![ + "tcp://0.0.0.0:11010".parse().unwrap(), + "udp://0.0.0.0:11010".parse().unwrap(), + ]); + config.set_network_identity(NetworkIdentity::new( + "shared_network".to_string(), + "".to_string(), + )); + config.set_secure_mode(Some(generate_secure_mode_config())); + config +} + +fn create_public_server_config() -> TomlConfigLoader { + let config = TomlConfigLoader::default(); + config.set_inst_name(PUBLIC_SERVER_NETWORK_NAME.to_string()); + config.set_hostname(Some("public-server".to_string())); + config.set_netns(Some("ns_adm".to_string())); + config.set_listeners(vec!["udp://0.0.0.0:11010".parse().unwrap()]); + config.set_network_identity(NetworkIdentity::new( + PUBLIC_SERVER_NETWORK_NAME.to_string(), + PUBLIC_SERVER_SHARED_SECRET.to_string(), + )); + config.set_secure_mode(Some(generate_secure_mode_config())); + + let mut flags = config.get_flags(); + flags.no_tun = true; + flags.private_mode = true; + flags.relay_all_peer_rpc = true; + flags.relay_network_whitelist = "".to_string(); + config.set_flags(flags); + + config +} + +fn create_need_p2p_admin_config(listener_scheme: &str) -> TomlConfigLoader { + let config = TomlConfigLoader::default(); + config.set_inst_name(NEED_P2P_ADMIN_NETWORK_NAME.to_string()); + config.set_hostname(Some("need-p2p-admin".to_string())); + config.set_netns(Some("ns_c3".to_string())); + config.set_listeners(vec![ + format!("{listener_scheme}://0.0.0.0:0").parse().unwrap(), + ]); + config.set_network_identity(NetworkIdentity::new( + NEED_P2P_ADMIN_NETWORK_NAME.to_string(), + PUBLIC_SERVER_SHARED_SECRET.to_string(), + )); + config.set_secure_mode(Some(generate_secure_mode_config())); + + let mut flags = config.get_flags(); + flags.no_tun = true; + flags.relay_all_peer_rpc = true; + flags.need_p2p = true; + flags.disable_udp_hole_punching = true; + flags.disable_tcp_hole_punching = true; + flags.disable_sym_hole_punching = true; + config.set_flags(flags); + + config +} + +#[allow(clippy::too_many_arguments)] +fn create_public_server_credential_config( + credential_secret: &str, + inst_name: &str, + hostname: &str, + ns: &str, + ipv4: &str, + ipv6: &str, + tcp_listener_port: u16, + udp_listener_port: u16, + proxy_cidrs: &[&str], +) -> TomlConfigLoader { + let config = create_credential_config_from_secret( + NEED_P2P_ADMIN_NETWORK_NAME.to_string(), + credential_secret, + inst_name, + Some(ns), + ipv4, + ipv6, + ); + config.set_hostname(Some(hostname.to_string())); + config.set_listeners(vec![ + format!("tcp://0.0.0.0:{tcp_listener_port}") + .parse() + .unwrap(), + format!("udp://0.0.0.0:{udp_listener_port}") + .parse() + .unwrap(), + ]); + for cidr in proxy_cidrs { + config + .add_proxy_cidr((*cidr).parse().unwrap(), None) + .unwrap(); + } + + let mut flags = config.get_flags(); + flags.disable_p2p = true; + config.set_flags(flags); + + config +} + +async fn wait_direct_peer(inst: &Instance, peer_id: u32, timeout: Duration, label: &str) { + wait_for_condition( + || async { + let peers = inst.get_core_instance().connected_peers().await; + let connected = peers.contains(&peer_id); + println!("{label}: direct peers={:?}, target={}", peers, peer_id); + connected + }, + timeout, + ) + .await; +} + +async fn wait_running_listener(inst: &Instance, scheme: &str, timeout: Duration, label: &str) { + wait_for_condition( + || async { + let listeners = inst.get_core_instance().running_listeners(); + let matched = listeners.iter().any(|listener| { + listener.scheme() == scheme && listener.port().is_some_and(|p| p != 0) + }); + println!("{label}: running listeners={:?}", listeners); + matched + }, + timeout, + ) + .await; +} + +async fn wait_route_cost(inst: &Instance, peer_id: u32, cost: i32, timeout: Duration, label: &str) { + wait_for_condition( + || async { + let routes = inst.get_core_instance().route_snapshots().await; + let matched = routes + .iter() + .any(|route| route.peer_id == peer_id && route.cost == cost); + println!( + "{label}: routes={:?}, target={}, cost={}", + routes + .iter() + .map(|route| (route.peer_id, route.cost)) + .collect::>(), + peer_id, + cost + ); + matched + }, + timeout, + ) + .await; +} + +async fn wait_foreign_network_count(inst: &Instance, expected: usize, timeout: Duration) { + wait_for_condition( + || async { + let foreign_networks = inst + .get_core_instance() + .foreign_network_snapshots(false) + .await; + println!("foreign networks: {:?}", foreign_networks); + foreign_networks.len() == expected + }, + timeout, + ) + .await; +} + +/// Regression coverage for a public-server-mediated credential topology: +/// Public server <- admin peer (need_p2p) <- two credential peers. +/// +/// Credential peers set `disable_p2p=true`, while the admin peer advertises `need_p2p=true`. +/// The credential peers should still proactively build direct peers with the admin peer through +/// peer RPC forwarded by the public server, even when the admin listener binds an ephemeral port. +#[rstest] +#[case("quic")] +#[case("wss")] +#[case("tcp")] +#[case("udp")] +#[tokio::test] +#[serial_test::serial] +async fn credential_peers_p2p_to_need_p2p_admin_through_public_server( + #[case] admin_listener_scheme: &str, +) { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + let mut public_server_inst = + Instance::new_with_process_runtime(create_public_server_config(), process_runtime.clone()); + public_server_inst.run().await.unwrap(); + + let mut admin_inst = Instance::new_with_process_runtime( + create_need_p2p_admin_config(admin_listener_scheme), + process_runtime.clone(), + ); + admin_inst.run().await.unwrap(); + wait_running_listener( + &admin_inst, + admin_listener_scheme, + Duration::from_secs(10), + "admin ephemeral listener", + ) + .await; + admin_inst.add_connector_url("udp://10.1.1.1:11010".parse().unwrap()); + + wait_foreign_network_count(&public_server_inst, 1, Duration::from_secs(10)).await; + + let (_credential_a_id, credential_a_secret) = generate_credential_with_options( + &admin_inst, + vec![], + false, + vec!["10.1.0.0/24".to_string()], + Duration::from_secs(3600), + Some("credential-peer-a".to_string()), + false, + ) + .await; + let (_credential_b_id, credential_b_secret) = generate_credential_with_options( + &admin_inst, + vec![], + false, + vec![], + Duration::from_secs(3600), + Some("credential-peer-b".to_string()), + false, + ) + .await; + admin_inst + .get_global_ctx() + .issue_event(GlobalCtxEvent::CredentialChanged); + + wait_foreign_network_count(&public_server_inst, 1, Duration::from_secs(10)).await; + + let mut credential_a_inst = Instance::new_with_process_runtime( + create_public_server_credential_config( + &credential_a_secret, + "credential-peer-a", + "credential-a", + "ns_c1", + "10.154.0.1", + "fd00::1/64", + 11030, + 11031, + &["10.1.0.0/24"], + ), + process_runtime.clone(), + ); + let mut credential_b_inst = Instance::new_with_process_runtime( + create_public_server_credential_config( + &credential_b_secret, + "credential-peer-b", + "credential-b", + "ns_c2", + "10.154.0.2", + "fd00::2/64", + 11040, + 11041, + &[], + ), + process_runtime.clone(), + ); + credential_a_inst.run().await.unwrap(); + credential_b_inst.run().await.unwrap(); + + credential_a_inst.add_connector_url("udp://10.1.1.1:11010".parse().unwrap()); + credential_b_inst.add_connector_url("udp://10.1.1.1:11010".parse().unwrap()); + + let admin_peer_id = admin_inst.peer_id(); + let credential_a_peer_id = credential_a_inst.peer_id(); + let credential_b_peer_id = credential_b_inst.peer_id(); + println!( + "admin={}, credential_a={}, credential_b={}, admin_listener_scheme={}", + admin_peer_id, credential_a_peer_id, credential_b_peer_id, admin_listener_scheme + ); + + wait_direct_peer( + &credential_a_inst, + admin_peer_id, + Duration::from_secs(30), + "credential_a -> admin", + ) + .await; + wait_direct_peer( + &credential_b_inst, + admin_peer_id, + Duration::from_secs(30), + "credential_b -> admin", + ) + .await; + wait_direct_peer( + &admin_inst, + credential_a_peer_id, + Duration::from_secs(10), + "admin -> credential_a", + ) + .await; + wait_direct_peer( + &admin_inst, + credential_b_peer_id, + Duration::from_secs(10), + "admin -> credential_b", + ) + .await; + wait_route_cost( + &credential_a_inst, + admin_peer_id, + 1, + Duration::from_secs(10), + "credential_a route to admin", + ) + .await; + wait_route_cost( + &credential_b_inst, + admin_peer_id, + 1, + Duration::from_secs(10), + "credential_b route to admin", + ) + .await; + + drop_insts(vec![ + public_server_inst, + admin_inst, + credential_a_inst, + credential_b_inst, + ]) + .await; +} + +#[cfg(feature = "wireguard")] +#[tokio::test] +#[serial_test::serial] +async fn credential_peer_reconnects_to_admin_with_portal_client_online() { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + let public_server_config = create_public_server_config(); + let mut public_server_flags = public_server_config.get_flags(); + public_server_flags.disable_relay_data = true; + public_server_config.set_flags(public_server_flags); + let mut public_server_inst = + Instance::new_with_process_runtime(public_server_config, process_runtime.clone()); + public_server_inst.run().await.unwrap(); + + let admin_config = create_need_p2p_admin_config("udp"); + admin_config.set_vpn_portal_config(VpnPortalConfig { + enabled: None, + wireguard_listen: "0.0.0.0:22121".parse().unwrap(), + wireguard_private_key: Some(BASE64_STANDARD.encode([42u8; 32])), + clients: vec![VpnPortalClientConfig { + name: "portal-client".to_owned(), + virtual_ip: "10.154.0.10/24".parse().unwrap(), + groups: Vec::new(), + }], + }); + let mut admin_inst = Instance::new_with_process_runtime(admin_config, process_runtime.clone()); + admin_inst.run().await.unwrap(); + admin_inst.add_connector_url("udp://10.1.1.1:11010".parse().unwrap()); + wait_foreign_network_count(&public_server_inst, 1, Duration::from_secs(10)).await; + + let (_credential_id, credential_secret) = generate_credential_with_options( + &admin_inst, + Vec::new(), + false, + Vec::new(), + Duration::from_secs(3600), + Some("portal-p2p-credential".to_owned()), + false, + ) + .await; + admin_inst + .get_global_ctx() + .issue_event(GlobalCtxEvent::CredentialChanged); + + let credential_config = create_public_server_credential_config( + &credential_secret, + "portal-credential-peer", + "portal-credential-peer", + "ns_c1", + "10.154.0.1", + "fd00::1/64", + 11030, + 11031, + &[], + ); + let mut credential_inst = + Instance::new_with_process_runtime(credential_config, process_runtime); + credential_inst.run().await.unwrap(); + credential_inst.add_connector_url("udp://10.1.1.1:11010".parse().unwrap()); + + let admin_peer_id = admin_inst.peer_id(); + let credential_peer_id = credential_inst.peer_id(); + wait_direct_peer( + &credential_inst, + admin_peer_id, + Duration::from_secs(30), + "credential -> admin before portal client", + ) + .await; + wait_direct_peer( + &admin_inst, + credential_peer_id, + Duration::from_secs(10), + "admin -> credential before portal client", + ) + .await; + wait_route_cost( + &credential_inst, + admin_peer_id, + 1, + Duration::from_secs(10), + "credential route to admin before portal client", + ) + .await; + + let portal_config = admin_inst + .get_global_ctx() + .config + .get_vpn_portal_config() + .unwrap(); + let (server_public, client_private) = + test_wireguard_keys(&portal_config, "portal-client").unwrap(); + { + let net_ns = crate::common::netns::NetNS::new(Some("ns_c4".to_owned())); + let _guard = net_ns.guard(); + run_wireguard_client( + &wireguard_ifname("wg0"), + "10.1.1.4:22121".parse().unwrap(), + Key::try_from(server_public.as_slice()).unwrap(), + Key::try_from(client_private.as_slice()).unwrap(), + vec!["10.154.0.0/24".to_owned()], + "10.154.0.10".to_owned(), + ) + .unwrap(); + } + + let public_server_forwarded_before = + forwarded_data_packets_for_network(&public_server_inst, NEED_P2P_ADMIN_NETWORK_NAME); + wait_for_condition( + || async { + ping_test("ns_c4", "10.154.0.1", None).await; + admin_inst + .get_core_instance() + .vpn_portal_info() + .await + .clients + .iter() + .any(|client| client.state == PortalClientState::Online) + }, + Duration::from_secs(10), + ) + .await; + + let old_conn_ids = credential_inst + .get_core_instance() + .peer_snapshots() + .await + .into_iter() + .find(|peer| peer.peer_id == admin_peer_id) + .map(|peer| peer.directly_connected_conns) + .unwrap_or_default(); + assert!( + !old_conn_ids.is_empty(), + "credential peer must have a direct admin connection to replace" + ); + for conn_id in &old_conn_ids { + credential_inst + .get_core_instance() + .close_peer_conn(admin_peer_id, conn_id) + .await + .unwrap(); + } + + wait_for_condition( + || async { + let has_new_connection = credential_inst + .get_core_instance() + .peer_snapshots() + .await + .into_iter() + .find(|peer| peer.peer_id == admin_peer_id) + .is_some_and(|peer| { + peer.directly_connected_conns + .iter() + .any(|conn_id| !old_conn_ids.contains(conn_id)) + }); + let has_direct_route = credential_inst + .get_core_instance() + .route_snapshots() + .await + .iter() + .any(|route| { + route.peer_id == admin_peer_id + && route.next_hop_peer_id == admin_peer_id + && route.cost == 1 + }); + has_new_connection && has_direct_route + }, + Duration::from_secs(30), + ) + .await; + + wait_ping_reachability("ns_c1", "10.154.0.10", true, Duration::from_secs(10)).await; + for _ in 0..3 { + assert!(ping_test("ns_c1", "10.154.0.10", None).await); + } + assert_eq!( + forwarded_data_packets_for_network(&public_server_inst, NEED_P2P_ADMIN_NETWORK_NAME), + public_server_forwarded_before, + "public server forwarded data despite disable_relay_data" + ); + + drop_insts(vec![public_server_inst, admin_inst, credential_inst]).await; +} + +async fn create_generated_credential_config( + admin_inst: &Instance, + inst_name: &str, + ns: Option<&str>, + ipv4: &str, + ipv6: &str, +) -> (TomlConfigLoader, String) { + let (cred_id, cred_secret) = + generate_credential(admin_inst, vec![], false, vec![], Duration::from_secs(3600)).await; + let config = build_credential_config( + admin_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(), + &credential_private_key_from_secret(&cred_secret), + inst_name, + ns, + ipv4, + ipv6, + ); + + (config, cred_id) +} + +async fn wait_ping_reachability(src_ns: &str, dst_ip: &str, reachable: bool, timeout: Duration) { + wait_for_condition( + || async { + let ping_result = ping_test(src_ns, dst_ip, None).await; + if reachable { ping_result } else { !ping_result } + }, + timeout, + ) + .await; +} + +async fn wait_route_presence_on_admins( + admin_a_inst: &Instance, + admin_c_inst: &Instance, + peer_id: u32, + should_exist: bool, + timeout: Duration, +) { + wait_for_condition( + || async { + let admin_a_routes = admin_a_inst.get_core_instance().route_snapshots().await; + let admin_c_routes = admin_c_inst.get_core_instance().route_snapshots().await; + let admin_a_has = admin_a_routes.iter().any(|r| r.peer_id == peer_id); + let admin_c_has = admin_c_routes.iter().any(|r| r.peer_id == peer_id); + if should_exist { + admin_a_has || admin_c_has + } else { + !admin_a_has && !admin_c_has + } + }, + timeout, + ) + .await; +} + +async fn assert_shared_visibility_stable( + admin_a_inst: &Instance, + admin_c_inst: &Instance, + peer_id: u32, + peer_ip: &str, + should_exist: bool, + label: &str, +) { + for _ in 0..5 { + let admin_a_routes = admin_a_inst.get_core_instance().route_snapshots().await; + let admin_c_routes = admin_c_inst.get_core_instance().route_snapshots().await; + let admin_a_has = admin_a_routes.iter().any(|r| r.peer_id == peer_id); + let admin_c_has = admin_c_routes.iter().any(|r| r.peer_id == peer_id); + if should_exist { + assert!( + admin_a_has || admin_c_has, + "{} should exist via shared path but routes are admin_a={:?} admin_c={:?}", + label, + admin_a_routes.iter().map(|r| r.peer_id).collect::>(), + admin_c_routes.iter().map(|r| r.peer_id).collect::>() + ); + } else { + assert!( + !admin_a_has && !admin_c_has, + "{} should be absent via shared path but routes are admin_a={:?} admin_c={:?}", + label, + admin_a_routes.iter().map(|r| r.peer_id).collect::>(), + admin_c_routes.iter().map(|r| r.peer_id).collect::>() + ); + } + + let ping_from_admin_a = ping_test("ns_adm", peer_ip, None).await; + let ping_from_admin_c = ping_test("ns_c3", peer_ip, None).await; + if should_exist { + assert!(ping_from_admin_a, "admin_a should reach {}", label); + assert!(ping_from_admin_c, "admin_c should reach {}", label); + } else { + assert!(!ping_from_admin_a, "admin_a should not reach {}", label); + assert!(!ping_from_admin_c, "admin_c should not reach {}", label); + } + + tokio::time::sleep(Duration::from_secs(1)).await; + } +} + +async fn wait_stable_single_visible_peer_on_admins( + admin_a_inst: &Instance, + admin_c_inst: &Instance, + peer_a_id: u32, + peer_b_id: u32, + timeout: Duration, +) -> u32 { + let start = std::time::Instant::now(); + let mut stable_winner = None; + let mut stable_samples = 0; + + loop { + let admin_a_routes = admin_a_inst.get_core_instance().route_snapshots().await; + let admin_c_routes = admin_c_inst.get_core_instance().route_snapshots().await; + + let admin_a_has_a = admin_a_routes.iter().any(|r| r.peer_id == peer_a_id); + let admin_a_has_b = admin_a_routes.iter().any(|r| r.peer_id == peer_b_id); + let admin_c_has_a = admin_c_routes.iter().any(|r| r.peer_id == peer_a_id); + let admin_c_has_b = admin_c_routes.iter().any(|r| r.peer_id == peer_b_id); + + let current_winner = if admin_a_has_a && admin_c_has_a && !admin_a_has_b && !admin_c_has_b { + Some(peer_a_id) + } else if admin_a_has_b && admin_c_has_b && !admin_a_has_a && !admin_c_has_a { + Some(peer_b_id) + } else { + None + }; + + println!( + "single-visible routes: a={:?} c={:?} winner={:?}", + admin_a_routes.iter().map(|r| r.peer_id).collect::>(), + admin_c_routes.iter().map(|r| r.peer_id).collect::>(), + current_winner + ); + + match current_winner { + Some(winner) if stable_winner == Some(winner) => stable_samples += 1, + Some(winner) => { + stable_winner = Some(winner); + stable_samples = 1; + } + None => { + stable_winner = None; + stable_samples = 0; + } + } + + if stable_samples >= 3 { + return stable_winner.unwrap(); + } + + assert!( + start.elapsed() < timeout, + "timed out waiting for a stable single visible peer on both admins after {:?}: a_has_a={} a_has_b={} c_has_a={} c_has_b={} a={:?} c={:?}", + start.elapsed(), + admin_a_has_a, + admin_a_has_b, + admin_c_has_a, + admin_c_has_b, + admin_a_routes.iter().map(|r| r.peer_id).collect::>(), + admin_c_routes.iter().map(|r| r.peer_id).collect::>() + ); + + tokio::time::sleep(Duration::from_secs(1)).await; + } +} + +async fn wait_stable_failover_visibility_on_admins( + admin_a_inst: &Instance, + admin_c_inst: &Instance, + present_peer_id: u32, + absent_peer_id: u32, + timeout: Duration, +) { + let start = std::time::Instant::now(); + let mut stable_samples = 0; + + loop { + let admin_a_routes = admin_a_inst.get_core_instance().route_snapshots().await; + let admin_c_routes = admin_c_inst.get_core_instance().route_snapshots().await; + + let admin_a_has_present = admin_a_routes.iter().any(|r| r.peer_id == present_peer_id); + let admin_c_has_present = admin_c_routes.iter().any(|r| r.peer_id == present_peer_id); + let admin_a_has_absent = admin_a_routes.iter().any(|r| r.peer_id == absent_peer_id); + let admin_c_has_absent = admin_c_routes.iter().any(|r| r.peer_id == absent_peer_id); + + let failover_stable = admin_a_has_present + && admin_c_has_present + && !admin_a_has_absent + && !admin_c_has_absent; + + println!( + "failover visibility: present={} a_has_present={} c_has_present={} absent={} a_has_absent={} c_has_absent={} stable={} samples={}", + present_peer_id, + admin_a_has_present, + admin_c_has_present, + absent_peer_id, + admin_a_has_absent, + admin_c_has_absent, + failover_stable, + stable_samples + ); + + if failover_stable { + stable_samples += 1; + } else { + stable_samples = 0; + } + + if stable_samples >= 3 { + return; + } + + assert!( + start.elapsed() < timeout, + "timed out waiting for stable failover visibility on both admins after {:?}: present={} a_has_present={} c_has_present={} absent={} a_has_absent={} c_has_absent={} a={:?} c={:?}", + start.elapsed(), + present_peer_id, + admin_a_has_present, + admin_c_has_present, + absent_peer_id, + admin_a_has_absent, + admin_c_has_absent, + admin_a_routes.iter().map(|r| r.peer_id).collect::>(), + admin_c_routes.iter().map(|r| r.peer_id).collect::>() + ); + + tokio::time::sleep(Duration::from_secs(1)).await; + } +} + +/// Test 1: Basic credential node connectivity with and without an admin key pin +/// Topology: Admin ← Credential +/// Verifies that a credential node can connect to an admin node and appears in routes +#[rstest] +#[case(false)] +#[case(true)] +#[tokio::test] +#[serial_test::serial] +async fn credential_basic_connectivity(#[case] pin_admin: bool) { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + // Create admin node + let admin_config = create_admin_config("admin", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let admin_public_key = admin_config + .get_secure_mode() + .and_then(|config| config.local_public_key) + .unwrap(); + let mut admin_inst = Instance::new_with_process_runtime(admin_config, process_runtime.clone()); + admin_inst.run().await.unwrap(); + + // Create credential node + let cred_config = create_credential_config( + &admin_inst, + "cred", + Some("ns_c1"), + "10.144.144.2", + "fd00::2/64", + ) + .await; + if pin_admin { + cred_config.set_peers(vec![PeerConfig { + uri: "tcp://10.1.1.1:11010".parse().unwrap(), + peer_public_key: Some(admin_public_key), + }]); + } + let mut cred_inst = Instance::new_with_process_runtime(cred_config, process_runtime.clone()); + cred_inst.run().await.unwrap(); + + // Credential connects to admin + if !pin_admin { + cred_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + } + + let cred_peer_id = cred_inst.peer_id(); + let admin_peer_id = admin_inst.peer_id(); + println!( + "Admin peer_id: {}, Credential peer_id: {}", + admin_peer_id, cred_peer_id + ); + + // Wait a bit for connection attempt + tokio::time::sleep(Duration::from_secs(2)).await; + + // Check peers and connections + let admin_peers = admin_inst.get_core_instance().connected_peers().await; + let cred_peers = cred_inst.get_core_instance().connected_peers().await; + println!("Admin peers: {:?}", admin_peers); + println!("Credential peers: {:?}", cred_peers); + + // Wait for credential to appear in admin's route table + wait_for_condition( + || async { + let routes = admin_inst.get_core_instance().route_snapshots().await; + let cred_routes = cred_inst.get_core_instance().route_snapshots().await; + let admin_peers = admin_inst.get_core_instance().connected_peers().await; + let cred_peers = cred_inst.get_core_instance().connected_peers().await; + println!( + "Admin peers: {:?}, routes: {:?}", + admin_peers, + routes + .iter() + .map(|r| (r.peer_id, r.ipv4_addr)) + .collect::>() + ); + println!( + "Credential peers: {:?}, routes: {:?}", + cred_peers, + cred_routes + .iter() + .map(|r| (r.peer_id, r.ipv4_addr)) + .collect::>() + ); + routes.iter().any(|r| r.peer_id == cred_peer_id) + }, + Duration::from_secs(10), + ) + .await; + + // Verify connectivity + wait_for_condition( + || async { ping_test("ns_adm", "10.144.144.2", None).await }, + Duration::from_secs(10), + ) + .await; + + wait_for_condition( + || async { ping_test("ns_c1", "10.144.144.1", None).await }, + Duration::from_secs(10), + ) + .await; + + drop_insts(vec![admin_inst, cred_inst]).await; +} + +/// A credential node must reject an admin whose Noise key does not match its pin. +#[tokio::test] +#[serial_test::serial] +async fn credential_rejects_incorrect_admin_pin() { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + let admin_config = create_admin_config("admin", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let admin_public_key = admin_config + .get_secure_mode() + .and_then(|config| config.local_public_key) + .unwrap(); + let mut admin_inst = Instance::new_with_process_runtime(admin_config, process_runtime.clone()); + admin_inst.run().await.unwrap(); + + let cred_config = create_credential_config( + &admin_inst, + "cred", + Some("ns_c1"), + "10.144.144.2", + "fd00::2/64", + ) + .await; + let incorrect_admin_public_key = generate_secure_mode_config().local_public_key.unwrap(); + assert_ne!(incorrect_admin_public_key, admin_public_key); + cred_config.set_peers(vec![PeerConfig { + uri: "tcp://10.1.1.1:11010".parse().unwrap(), + peer_public_key: Some(incorrect_admin_public_key), + }]); + + let mut cred_inst = Instance::new_with_process_runtime(cred_config, process_runtime.clone()); + cred_inst.run().await.unwrap(); + + let admin_peer_id = admin_inst.peer_id(); + let cred_peer_id = cred_inst.peer_id(); + for _ in 0..5 { + let admin_peers = admin_inst.get_core_instance().connected_peers().await; + let cred_peers = cred_inst.get_core_instance().connected_peers().await; + let admin_routes = admin_inst.get_core_instance().route_snapshots().await; + let cred_routes = cred_inst.get_core_instance().route_snapshots().await; + + assert!(!admin_peers.contains(&cred_peer_id)); + assert!(!cred_peers.contains(&admin_peer_id)); + assert!( + !admin_routes + .iter() + .any(|route| route.peer_id == cred_peer_id) + ); + assert!( + !cred_routes + .iter() + .any(|route| route.peer_id == admin_peer_id) + ); + + tokio::time::sleep(Duration::from_secs(1)).await; + } + + drop_insts(vec![admin_inst, cred_inst]).await; +} + +/// Test 5-6: Prefer Peer Relay with one admin and an allow_relay credential +/// Topology: Admin ← Credential_A, Admin ← Credential_B, Admin ← Credential_C(listener, allow_relay) +/// Verifies routing behavior based on allow_relay flag: +/// - allow_relay=true: A→B route goes through C (cost 2 via C) +/// - allow_relay=false: A→B route goes through Admin (cost 2 via Admin) +#[rstest] +#[case(true)] +#[case(false)] +#[tokio::test] +#[serial_test::serial] +async fn prefer_peer_relay_single_admin(#[case] allow_relay: bool) { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + // Create admin node + let admin_config = create_admin_config("admin", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let mut admin_inst = Instance::new_with_process_runtime(admin_config, process_runtime.clone()); + admin_inst.run().await.unwrap(); + + let admin_peer_id = admin_inst.peer_id(); + + // Generate credentials for A, B, C + // C has configurable allow_relay + let (_cred_a_id, cred_a_secret) = generate_credential( + &admin_inst, + vec![], + false, + vec![], + Duration::from_secs(3600), + ) + .await; + + let (_cred_b_id, cred_b_secret) = generate_credential( + &admin_inst, + vec![], + false, + vec![], + Duration::from_secs(3600), + ) + .await; + + let (_cred_c_id, cred_c_secret) = generate_credential( + &admin_inst, + vec![], + allow_relay, + vec![], + Duration::from_secs(3600), + ) + .await; + + // Create credential A on ns_c1 + let cred_a_config = { + use base64::Engine as _; + let privkey_bytes: [u8; 32] = base64::prelude::BASE64_STANDARD + .decode(&cred_a_secret) + .unwrap() + .try_into() + .unwrap(); + let private = x25519_dalek::StaticSecret::from(privkey_bytes); + let config = TomlConfigLoader::default(); + config.set_inst_name("cred_a".to_string()); + config.set_netns(Some("ns_c1".to_string())); + config.set_ipv4(Some("10.144.144.2".parse().unwrap())); + config.set_ipv6(Some("fd00::2/64".parse().unwrap())); + config.set_network_identity(NetworkIdentity::new_credential( + admin_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(), + )); + config.set_secure_mode(Some(generate_secure_mode_config_with_key(&private))); + disable_p2p(&config); + config + }; + let mut cred_a_inst = + Instance::new_with_process_runtime(cred_a_config, process_runtime.clone()); + cred_a_inst.run().await.unwrap(); + + // Create credential B on ns_c2 + let cred_b_config = { + use base64::Engine as _; + let privkey_bytes: [u8; 32] = base64::prelude::BASE64_STANDARD + .decode(&cred_b_secret) + .unwrap() + .try_into() + .unwrap(); + let private = x25519_dalek::StaticSecret::from(privkey_bytes); + let config = TomlConfigLoader::default(); + config.set_inst_name("cred_b".to_string()); + config.set_netns(Some("ns_c2".to_string())); + config.set_ipv4(Some("10.144.144.3".parse().unwrap())); + config.set_ipv6(Some("fd00::3/64".parse().unwrap())); + config.set_network_identity(NetworkIdentity::new_credential( + admin_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(), + )); + config.set_secure_mode(Some(generate_secure_mode_config_with_key(&private))); + disable_p2p(&config); + config + }; + let mut cred_b_inst = + Instance::new_with_process_runtime(cred_b_config, process_runtime.clone()); + cred_b_inst.run().await.unwrap(); + + // Create credential C on ns_c3 WITH listener (so A and B can connect to it) + let cred_c_config = { + use base64::Engine as _; + let privkey_bytes: [u8; 32] = base64::prelude::BASE64_STANDARD + .decode(&cred_c_secret) + .unwrap() + .try_into() + .unwrap(); + let private = x25519_dalek::StaticSecret::from(privkey_bytes); + let config = TomlConfigLoader::default(); + config.set_inst_name("cred_c".to_string()); + config.set_netns(Some("ns_c3".to_string())); + config.set_ipv4(Some("10.144.144.4".parse().unwrap())); + config.set_ipv6(Some("fd00::4/64".parse().unwrap())); + // C has listener so A and B can connect to it + config.set_listeners(vec!["tcp://0.0.0.0:11020".parse().unwrap()]); + config.set_network_identity(NetworkIdentity::new_credential( + admin_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(), + )); + config.set_secure_mode(Some(generate_secure_mode_config_with_key(&private))); + disable_p2p(&config); + config + }; + let mut cred_c_inst = + Instance::new_with_process_runtime(cred_c_config, process_runtime.clone()); + cred_c_inst.run().await.unwrap(); + + let cred_a_peer_id = cred_a_inst.peer_id(); + let cred_b_peer_id = cred_b_inst.peer_id(); + let cred_c_peer_id = cred_c_inst.peer_id(); + + // All credentials connect to admin + cred_a_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + cred_b_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + cred_c_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + + // B connects to C first. A remains Admin-only so changing the Admin's + // advertised edge produces an observable 2 -> 3 -> 2 transition. + cred_b_inst.add_connector_url("tcp://10.1.1.4:11020".parse().unwrap()); + // print all peer ids + println!("Admin peer id: {:?}", admin_peer_id); + println!("Cred A peer id: {:?}", cred_a_peer_id); + println!("Cred B peer id: {:?}", cred_b_peer_id); + println!("Cred C peer id: {:?}", cred_c_peer_id); + + // Wait for all nodes to appear in admin's route table + wait_for_condition( + || async { + let routes = admin_inst.get_core_instance().route_snapshots().await; + let has_a = routes.iter().any(|r| r.peer_id == cred_a_peer_id); + let has_b = routes.iter().any(|r| r.peer_id == cred_b_peer_id); + let has_c = routes.iter().any(|r| r.peer_id == cred_c_peer_id); + println!("Admin routes: a={}, b={}, c={}", has_a, has_b, has_c); + has_a && has_b && has_c + }, + Duration::from_secs(30), + ) + .await; + + // Wait for B and C to establish the candidate relay edge. + wait_for_condition( + || async { + let peers_b = cred_b_inst.get_core_instance().connected_peers().await; + let peers_c = cred_c_inst.get_core_instance().connected_peers().await; + + let b_connected_c = peers_b.contains(&cred_c_peer_id); + let c_connected_b = peers_c.contains(&cred_b_peer_id); + + println!( + "P2P: B->C={}, C->B={}, allow_relay={}", + b_connected_c, c_connected_b, allow_relay + ); + b_connected_c && c_connected_b + }, + Duration::from_secs(30), + ) + .await; + + wait_route_cost( + &cred_a_inst, + cred_b_peer_id, + 2, + Duration::from_secs(15), + "preference disabled on converged single-admin topology", + ) + .await; + + set_prefer_peer_relay(&admin_inst, true).await; + wait_route_cost( + &cred_a_inst, + cred_b_peer_id, + if allow_relay { 3 } else { 2 }, + Duration::from_secs(20), + "enabling preference projects only authorized relay coverage", + ) + .await; + + if allow_relay { + set_prefer_peer_relay(&admin_inst, false).await; + wait_route_cost( + &cred_a_inst, + cred_b_peer_id, + 2, + Duration::from_secs(20), + "disabling preference restores the admin edge", + ) + .await; + set_prefer_peer_relay(&admin_inst, true).await; + wait_route_cost( + &cred_a_inst, + cred_b_peer_id, + 3, + Duration::from_secs(20), + "re-enabling preference removes the admin edge again", + ) + .await; + + cred_a_inst.add_connector_url("tcp://10.1.1.4:11020".parse().unwrap()); + wait_direct_peer( + &cred_a_inst, + cred_c_peer_id, + Duration::from_secs(10), + "credential A -> relay C", + ) + .await; + } + + let expected_next_hop = if allow_relay { + cred_c_peer_id + } else { + admin_peer_id + }; + wait_route_next_hop( + &cred_a_inst, + cred_b_peer_id, + expected_next_hop, + Duration::from_secs(20), + "single-admin data path", + ) + .await; + wait_route_next_hop( + &cred_b_inst, + cred_a_peer_id, + expected_next_hop, + Duration::from_secs(20), + "single-admin return data path", + ) + .await; + + wait_route_cost( + &admin_inst, + cred_b_peer_id, + 1, + Duration::from_secs(10), + "admin retains its direct credential route", + ) + .await; + + let (expected_forwarder, forbidden_forwarder) = if allow_relay { + (&cred_c_inst, &admin_inst) + } else { + (&admin_inst, &cred_c_inst) + }; + assert_ping_forwarded_by( + "ns_c1", + "10.144.144.3", + expected_forwarder, + &[forbidden_forwarder], + ) + .await; + + // Cleanup + drop_insts(vec![admin_inst, cred_a_inst, cred_b_inst, cred_c_inst]).await; +} + +/// Both admins must project coverage from a credential relay even though the +/// credential only maintains one OSPF initiator session. The other admin gets +/// the relay's source row through admin-to-admin propagation. After projection +/// is proven, the source connects to the credential relay and sends data +/// through it. Routing must keep working after one admin stops. +/// +/// Initially source, target, and relay each connect to both admins, while the +/// target also connects to the relay. After both admins project the relay's +/// coverage, the source connects directly to the relay for the data-path probe. +/// +/// The source connects to both admins. Therefore its route to the target only +/// grows from two to three hops when both admins suppress their direct target +/// edge. Each admin must still retain its own direct fallback route. +#[tokio::test] +#[serial_test::serial] +async fn prefer_peer_relay_uses_forwarded_coverage_across_two_admins() { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + let admin_a_config = + create_admin_config("admin_a", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let mut admin_a_inst = + Instance::new_with_process_runtime(admin_a_config, process_runtime.clone()); + admin_a_inst.run().await.unwrap(); + + let admin_b_config = + create_admin_config("admin_b", Some("ns_c3"), "10.144.144.4", "fd00::4/64"); + let mut admin_b_inst = + Instance::new_with_process_runtime(admin_b_config, process_runtime.clone()); + admin_b_inst.run().await.unwrap(); + + admin_a_inst.add_connector_url("tcp://10.1.1.4:11010".parse().unwrap()); + let admin_a_peer_id = admin_a_inst.peer_id(); + let admin_b_peer_id = admin_b_inst.peer_id(); + wait_direct_peer( + &admin_a_inst, + admin_b_peer_id, + Duration::from_secs(10), + "admin_a -> admin_b", + ) + .await; + + let (_, relay_secret) = generate_credential( + &admin_a_inst, + vec![], + true, + vec![], + Duration::from_secs(3600), + ) + .await; + let (_, target_secret) = generate_credential( + &admin_a_inst, + vec![], + false, + vec![], + Duration::from_secs(3600), + ) + .await; + let (_, source_secret) = generate_credential( + &admin_a_inst, + vec![], + false, + vec![], + Duration::from_secs(3600), + ) + .await; + admin_a_inst + .get_global_ctx() + .issue_event(GlobalCtxEvent::CredentialChanged); + + let network_name = admin_a_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(); + let relay_config = create_credential_config_from_secret( + network_name.clone(), + &relay_secret, + "relay", + Some("ns_c1"), + "10.144.144.2", + "fd00::2/64", + ); + relay_config.set_listeners(vec!["tcp://0.0.0.0:11020".parse().unwrap()]); + disable_p2p(&relay_config); + + let target_config = create_credential_config_from_secret( + network_name.clone(), + &target_secret, + "target", + Some("ns_c2"), + "10.144.144.3", + "fd00::3/64", + ); + disable_p2p(&target_config); + + let source_config = create_credential_config_from_secret( + network_name, + &source_secret, + "source", + Some("ns_c4"), + "10.144.144.5", + "fd00::5/64", + ); + disable_p2p(&source_config); + + let mut relay_inst = Instance::new_with_process_runtime(relay_config, process_runtime.clone()); + let mut target_inst = + Instance::new_with_process_runtime(target_config, process_runtime.clone()); + let mut source_inst = + Instance::new_with_process_runtime(source_config, process_runtime.clone()); + relay_inst.run().await.unwrap(); + target_inst.run().await.unwrap(); + source_inst.run().await.unwrap(); + + let relay_listener_url: url::Url = "tcp://10.1.1.2:11020".parse().unwrap(); + relay_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + relay_inst.add_connector_url("tcp://10.1.1.4:11010".parse().unwrap()); + target_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + target_inst.add_connector_url("tcp://10.1.1.4:11010".parse().unwrap()); + target_inst.add_connector_url(relay_listener_url.clone()); + source_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + source_inst.add_connector_url("tcp://10.1.1.4:11010".parse().unwrap()); + + let relay_peer_id = relay_inst.peer_id(); + let target_peer_id = target_inst.peer_id(); + let source_peer_id = source_inst.peer_id(); + for (admin, label) in [(&admin_a_inst, "admin_a"), (&admin_b_inst, "admin_b")] { + wait_direct_peer( + admin, + relay_peer_id, + Duration::from_secs(30), + &format!("{label} -> relay"), + ) + .await; + wait_direct_peer( + admin, + target_peer_id, + Duration::from_secs(30), + &format!("{label} -> target"), + ) + .await; + wait_direct_peer( + admin, + source_peer_id, + Duration::from_secs(30), + &format!("{label} -> source"), + ) + .await; + } + wait_direct_peer( + &relay_inst, + admin_a_peer_id, + Duration::from_secs(10), + "relay -> admin_a", + ) + .await; + wait_direct_peer( + &relay_inst, + admin_b_peer_id, + Duration::from_secs(10), + "relay -> admin_b", + ) + .await; + wait_direct_peer( + &relay_inst, + target_peer_id, + Duration::from_secs(10), + "relay -> target", + ) + .await; + + wait_route_cost( + &source_inst, + target_peer_id, + 2, + Duration::from_secs(30), + "source uses an admin direct target edge", + ) + .await; + wait_ping_reachability("ns_c4", "10.144.144.3", true, Duration::from_secs(10)).await; + + for admin in [&admin_a_inst, &admin_b_inst] { + set_prefer_peer_relay(admin, true).await; + } + + wait_route_cost( + &source_inst, + target_peer_id, + 3, + Duration::from_secs(30), + "both admins use credential relay coverage", + ) + .await; + wait_route_cost( + &admin_a_inst, + target_peer_id, + 1, + Duration::from_secs(10), + "admin_a retains direct fallback", + ) + .await; + wait_route_cost( + &admin_b_inst, + target_peer_id, + 1, + Duration::from_secs(10), + "admin_b retains direct fallback", + ) + .await; + + source_inst.add_connector_url(relay_listener_url.clone()); + wait_direct_peer( + &source_inst, + relay_peer_id, + Duration::from_secs(10), + "source -> relay before admin shutdown", + ) + .await; + wait_route_next_hop( + &source_inst, + target_peer_id, + relay_peer_id, + Duration::from_secs(20), + "dual-admin data path before one admin stops", + ) + .await; + wait_route_next_hop( + &target_inst, + source_peer_id, + relay_peer_id, + Duration::from_secs(20), + "dual-admin return data path before one admin stops", + ) + .await; + assert_ping_forwarded_by( + "ns_c4", + "10.144.144.3", + &relay_inst, + &[&admin_a_inst, &admin_b_inst], + ) + .await; + + // Equivalent admin candidates are ordered by peer id. Stop the first + // credential OSPF initiator so every credential must use the survivor. + let (stopped_admin, surviving_admin) = if admin_a_peer_id < admin_b_peer_id { + (admin_a_inst, admin_b_inst) + } else { + (admin_b_inst, admin_a_inst) + }; + let stopped_admin_peer_id = stopped_admin.peer_id(); + let surviving_admin_peer_id = surviving_admin.peer_id(); + drop_insts(vec![stopped_admin]).await; + + wait_for_condition( + || async { + let peers = source_inst.get_core_instance().connected_peers().await; + !peers.contains(&stopped_admin_peer_id) && peers.contains(&surviving_admin_peer_id) + }, + Duration::from_secs(15), + ) + .await; + wait_route_next_hop( + &source_inst, + target_peer_id, + relay_peer_id, + Duration::from_secs(20), + "dual-admin data path remains on relay after one admin stops", + ) + .await; + wait_route_next_hop( + &target_inst, + source_peer_id, + relay_peer_id, + Duration::from_secs(20), + "dual-admin return path remains on relay after one admin stops", + ) + .await; + assert_ping_forwarded_by("ns_c4", "10.144.144.3", &relay_inst, &[&surviving_admin]).await; + wait_route_cost( + &surviving_admin, + target_peer_id, + 1, + Duration::from_secs(10), + "surviving admin retains direct fallback", + ) + .await; + + // Removing and restoring the Peer Relay's target edge changes its + // source-owned connection row. The post-shutdown relay -> admin -> relay + // next-hop transition proves that fresh rows pass through the surviving + // admin; stale state cannot satisfy both observations. + disconnect_connector(&target_inst, &relay_listener_url, relay_peer_id).await; + wait_for_condition( + || async { + !relay_inst + .get_core_instance() + .connected_peers() + .await + .contains(&target_peer_id) + }, + Duration::from_secs(10), + ) + .await; + wait_route_next_hop( + &source_inst, + target_peer_id, + surviving_admin_peer_id, + Duration::from_secs(30), + "relay edge removal restores the surviving admin data path", + ) + .await; + wait_route_next_hop( + &target_inst, + source_peer_id, + surviving_admin_peer_id, + Duration::from_secs(30), + "relay edge removal restores the surviving admin return path", + ) + .await; + assert_ping_forwarded_by("ns_c4", "10.144.144.3", &surviving_admin, &[&relay_inst]).await; + + target_inst.add_connector_url(relay_listener_url.clone()); + wait_direct_peer( + &target_inst, + relay_peer_id, + Duration::from_secs(10), + "target -> relay after admin shutdown", + ) + .await; + wait_direct_peer( + &relay_inst, + target_peer_id, + Duration::from_secs(10), + "relay -> target after admin shutdown", + ) + .await; + wait_route_next_hop( + &source_inst, + target_peer_id, + relay_peer_id, + Duration::from_secs(30), + "relay edge restoration restores the Peer Relay data path", + ) + .await; + wait_route_next_hop( + &target_inst, + source_peer_id, + relay_peer_id, + Duration::from_secs(30), + "relay edge restoration restores the Peer Relay return path", + ) + .await; + assert_ping_forwarded_by("ns_c4", "10.144.144.3", &relay_inst, &[&surviving_admin]).await; + + drop_insts(vec![surviving_admin, relay_inst, target_inst, source_inst]).await; +} + +/// Test 2: Two credential nodes connect to same admin +/// Topology: Admin ← Credential_A, Admin ← Credential_B +/// Verifies that multiple credential nodes can connect to the same admin +#[tokio::test] +#[serial_test::serial] +async fn credential_two_credentials_communicate_tcp() { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + // Create admin node + let admin_config = create_admin_config("admin", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let mut admin_inst = Instance::new_with_process_runtime(admin_config, process_runtime.clone()); + admin_inst.run().await.unwrap(); + + // Create credential1 on ns_c1 + let cred1_config = create_credential_config( + &admin_inst, + "cred1", + Some("ns_c1"), + "10.144.144.2", + "fd00::2/64", + ) + .await; + let mut cred1_inst = Instance::new_with_process_runtime(cred1_config, process_runtime.clone()); + cred1_inst.run().await.unwrap(); + + // Create credential2 on ns_c2 + let cred2_config = create_credential_config( + &admin_inst, + "cred2", + Some("ns_c2"), + "10.144.144.3", + "fd00::3/64", + ) + .await; + let mut cred2_inst = Instance::new_with_process_runtime(cred2_config, process_runtime.clone()); + cred2_inst.run().await.unwrap(); + + // Both credentials connect to admin + cred1_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + cred2_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + + let cred1_peer_id = cred1_inst.peer_id(); + let cred2_peer_id = cred2_inst.peer_id(); + + // Wait for both credentials to appear in admin's route table + wait_for_condition( + || async { + let routes = admin_inst.get_core_instance().route_snapshots().await; + routes.iter().any(|r| r.peer_id == cred1_peer_id) + && routes.iter().any(|r| r.peer_id == cred2_peer_id) + }, + Duration::from_secs(10), + ) + .await; + + // Verify admin can ping both credentials + wait_for_condition( + || async { ping_test("ns_adm", "10.144.144.2", None).await }, + Duration::from_secs(10), + ) + .await; + + wait_for_condition( + || async { ping_test("ns_adm", "10.144.144.3", None).await }, + Duration::from_secs(10), + ) + .await; + + drop_insts(vec![admin_inst, cred1_inst, cred2_inst]).await; +} + +/// Test 3: Credential revocation removes credential from route table +/// Topology: Admin ← Credential +/// Verifies that when credential is revoked, it's removed from admin's route table +#[tokio::test] +#[serial_test::serial] +async fn credential_revocation_propagates() { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + // Create admin on ns_adm (10.1.1.1) + let admin_config = create_admin_config("admin", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let mut admin_inst = Instance::new_with_process_runtime(admin_config, process_runtime.clone()); + admin_inst.run().await.unwrap(); + + // Generate credential on admin + let (cred_id, cred_secret) = generate_credential( + &admin_inst, + vec![], + false, + vec![], + Duration::from_secs(3600), + ) + .await; + + // Create credential node + let cred_config = { + use base64::Engine as _; + let privkey_bytes: [u8; 32] = base64::prelude::BASE64_STANDARD + .decode(&cred_secret) + .unwrap() + .try_into() + .unwrap(); + let private = x25519_dalek::StaticSecret::from(privkey_bytes); + + let config = TomlConfigLoader::default(); + config.set_inst_name("cred".to_string()); + config.set_netns(Some("ns_c1".to_string())); + config.set_ipv4(Some("10.144.144.2".parse().unwrap())); + config.set_ipv6(Some("fd00::2/64".parse().unwrap())); + config.set_listeners(vec![]); + config.set_network_identity(NetworkIdentity::new_credential( + admin_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(), + )); + config.set_secure_mode(Some(generate_secure_mode_config_with_key(&private))); + config + }; + + let mut cred_inst = Instance::new_with_process_runtime(cred_config, process_runtime.clone()); + cred_inst.run().await.unwrap(); + + // Credential connects to admin + cred_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + + let cred_peer_id = cred_inst.peer_id(); + + // Wait for credential to appear in admin's route table + wait_for_condition( + || async { + admin_inst + .get_core_instance() + .route_snapshots() + .await + .iter() + .any(|r| r.peer_id == cred_peer_id) + }, + Duration::from_secs(10), + ) + .await; + + // Verify connectivity before revocation + wait_for_condition( + || async { ping_test("ns_adm", "10.144.144.2", None).await }, + Duration::from_secs(10), + ) + .await; + + // Revoke the credential + assert!( + admin_inst + .get_core_instance() + .revoke_credential(&cred_id) + .unwrap(), + "Credential should be revoked successfully" + ); + + // Trigger OSPF sync + admin_inst + .get_global_ctx() + .issue_event(GlobalCtxEvent::CredentialChanged); + + // Wait for credential to disappear from admin's route table + wait_for_condition( + || async { + !admin_inst + .get_core_instance() + .route_snapshots() + .await + .iter() + .any(|r| r.peer_id == cred_peer_id) + }, + Duration::from_secs(15), + ) + .await; + + wait_for_condition( + || async { !ping_test("ns_adm", "10.144.144.2", None).await }, + Duration::from_secs(10), + ) + .await; + + wait_for_condition( + || async { !ping_test("ns_c1", "10.144.144.1", None).await }, + Duration::from_secs(10), + ) + .await; + + drop_insts(vec![admin_inst, cred_inst]).await; +} + +/// Test: A non-reusable credential only allows one peer at a time. +#[tokio::test] +#[serial_test::serial] +async fn credential_non_reusable_allows_only_one_peer() { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + let admin_config = create_admin_config("admin", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let mut admin_inst = Instance::new_with_process_runtime(admin_config, process_runtime.clone()); + admin_inst.run().await.unwrap(); + + let (_cred_id, cred_secret) = generate_credential_with_options( + &admin_inst, + vec![], + false, + vec![], + Duration::from_secs(3600), + None, + false, + ) + .await; + + let network_name = admin_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(); + let cred1_config = create_credential_config_from_secret( + network_name.clone(), + &cred_secret, + "cred1_single", + Some("ns_c1"), + "10.144.144.2", + "fd00::2/64", + ); + let cred2_config = create_credential_config_from_secret( + network_name, + &cred_secret, + "cred2_single", + Some("ns_c2"), + "10.144.144.3", + "fd00::3/64", + ); + + let mut cred1_inst = Some(Instance::new_with_process_runtime( + cred1_config, + process_runtime.clone(), + )); + cred1_inst.as_mut().unwrap().run().await.unwrap(); + cred1_inst + .as_ref() + .unwrap() + .add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + + let cred1_peer_id = cred1_inst.as_ref().unwrap().peer_id(); + wait_for_condition( + || async { + admin_inst + .get_core_instance() + .route_snapshots() + .await + .iter() + .any(|r| r.peer_id == cred1_peer_id) + }, + Duration::from_secs(10), + ) + .await; + wait_ping_reachability("ns_adm", "10.144.144.2", true, Duration::from_secs(10)).await; + + let mut cred2_inst = Some(Instance::new_with_process_runtime( + cred2_config, + process_runtime.clone(), + )); + cred2_inst.as_mut().unwrap().run().await.unwrap(); + cred2_inst + .as_ref() + .unwrap() + .add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + + let cred2_peer_id = cred2_inst.as_ref().unwrap().peer_id(); + tokio::time::sleep(Duration::from_secs(3)).await; + + // The non-reusable credential owner is elected by lowest peer_id, so either cred1 or cred2 + // may win. Determine the winner and loser dynamically. + let admin_routes = admin_inst.get_core_instance().route_snapshots().await; + let (winner_peer_id, winner_ip, winner_inst, loser_peer_id, loser_ip, loser_inst) = + if admin_routes.iter().any(|r| r.peer_id == cred1_peer_id) { + ( + cred1_peer_id, + "10.144.144.2", + &mut cred1_inst, + cred2_peer_id, + "10.144.144.3", + &mut cred2_inst, + ) + } else if admin_routes.iter().any(|r| r.peer_id == cred2_peer_id) { + ( + cred2_peer_id, + "10.144.144.3", + &mut cred2_inst, + cred1_peer_id, + "10.144.144.2", + &mut cred1_inst, + ) + } else { + panic!( + "neither credential peer is present in routes: {:?}", + admin_routes.iter().map(|r| r.peer_id).collect::>() + ); + }; + + for _ in 0..5 { + let admin_routes = admin_inst.get_core_instance().route_snapshots().await; + assert!( + admin_routes.iter().any(|r| r.peer_id == winner_peer_id), + "winning credential peer should remain present: {:?}", + admin_routes.iter().map(|r| r.peer_id).collect::>() + ); + assert!( + ping_test("ns_adm", winner_ip, None).await, + "admin should still reach the winning credential peer" + ); + tokio::time::sleep(Duration::from_secs(1)).await; + } + + for _ in 0..5 { + let admin_routes = admin_inst.get_core_instance().route_snapshots().await; + assert!( + !admin_routes.iter().any(|r| r.peer_id == loser_peer_id), + "losing credential peer should not appear in routes: {:?}", + admin_routes.iter().map(|r| r.peer_id).collect::>() + ); + assert!( + !ping_test("ns_adm", loser_ip, None).await, + "admin should not reach the losing credential peer" + ); + tokio::time::sleep(Duration::from_secs(1)).await; + } + + drop_insts(vec![winner_inst.take().unwrap()]).await; + + wait_for_condition( + || async { + let routes = admin_inst.get_core_instance().route_snapshots().await; + !routes.iter().any(|r| r.peer_id == winner_peer_id) + && routes.iter().any(|r| r.peer_id == loser_peer_id) + }, + Duration::from_secs(20), + ) + .await; + wait_ping_reachability("ns_adm", loser_ip, true, Duration::from_secs(20)).await; + + drop_insts(vec![admin_inst, loser_inst.take().unwrap()]).await; +} + +/// Test 4: Unknown credential (not in trusted list) is rejected +/// Topology: Admin +/// Verifies that credential nodes with unknown/random keys cannot connect +#[tokio::test] +#[serial_test::serial] +async fn credential_unknown_rejected() { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + // Create admin node + let admin_config = create_admin_config("admin", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let mut admin_inst = Instance::new_with_process_runtime(admin_config, process_runtime.clone()); + admin_inst.run().await.unwrap(); + + // Create credential node with random key (not generated by admin) + let random_private = x25519_dalek::StaticSecret::random_from_rng(rand::rngs::OsRng); + let cred_config = { + let config = TomlConfigLoader::default(); + config.set_inst_name("cred".to_string()); + config.set_netns(Some("ns_c1".to_string())); + config.set_ipv4(Some("10.144.144.2".parse().unwrap())); + config.set_ipv6(Some("fd00::2/64".parse().unwrap())); + config.set_listeners(vec![]); + config.set_network_identity(NetworkIdentity::new_credential( + admin_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(), + )); + config.set_secure_mode(Some(generate_secure_mode_config_with_key(&random_private))); + config + }; + + let mut cred_inst = Instance::new_with_process_runtime(cred_config, process_runtime.clone()); + cred_inst.run().await.unwrap(); + + // Attempt to connect to admin + cred_inst.add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + + let cred_peer_id = cred_inst.peer_id(); + + // Wait a bit for connection attempt + tokio::time::sleep(Duration::from_secs(5)).await; + + // Verify credential does NOT appear in admin's route table + let routes = admin_inst.get_core_instance().route_snapshots().await; + assert!( + !routes.iter().any(|r| r.peer_id == cred_peer_id), + "Unknown credential node should NOT appear in admin's route table" + ); + + // Verify no connectivity + let ping_result = ping_test("ns_adm", "10.144.144.2", None).await; + assert!( + !ping_result, + "Should NOT be able to ping unknown credential node" + ); + + drop_insts(vec![admin_inst, cred_inst]).await; +} + +/// Regression test: an unknown credential must still be rejected when it first connects via a +/// shared node. If this fails, the shared path is incorrectly admitting the node into the target +/// network's route domain. +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +async fn credential_unknown_via_shared_rejected(#[values(true, false)] test_revoke: bool) { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + let admin_a_config = + create_admin_config("admin_a", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let mut admin_a_inst = + Instance::new_with_process_runtime(admin_a_config, process_runtime.clone()); + admin_a_inst.run().await.unwrap(); + + let shared_b_config = + create_shared_config("shared_b", Some("ns_c1"), "10.144.144.2", "fd00::2/64"); + let mut shared_b_inst = + Instance::new_with_process_runtime(shared_b_config, process_runtime.clone()); + shared_b_inst.run().await.unwrap(); + + let admin_c_config = + create_admin_config("admin_c", Some("ns_c3"), "10.144.144.4", "fd00::4/64"); + let mut admin_c_inst = + Instance::new_with_process_runtime(admin_c_config, process_runtime.clone()); + admin_c_inst.run().await.unwrap(); + + admin_a_inst.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + admin_c_inst.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + + let admin_c_peer_id = admin_c_inst.peer_id(); + wait_for_condition( + || async { + let a_routes = admin_a_inst.get_core_instance().route_snapshots().await; + let c_routes = admin_c_inst.get_core_instance().route_snapshots().await; + a_routes.iter().any(|r| r.peer_id == admin_c_peer_id) + || c_routes.iter().any(|r| r.peer_id == admin_a_inst.peer_id()) + }, + Duration::from_secs(10), + ) + .await; + + let (credential_config, credential_id) = if test_revoke { + let (config, cred_id) = create_generated_credential_config( + &admin_a_inst, + "cred_d", + Some("ns_c2"), + "10.144.144.5", + "fd00::5/64", + ) + .await; + (config, Some(cred_id)) + } else { + ( + create_unknown_credential_config( + admin_a_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(), + "unknown_d", + Some("ns_c2"), + "10.144.144.5", + "fd00::5/64", + ), + None, + ) + }; + let mut unknown_inst = + Instance::new_with_process_runtime(credential_config, process_runtime.clone()); + unknown_inst.run().await.unwrap(); + + unknown_inst.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + + let unknown_peer_id = unknown_inst.peer_id(); + + println!("unknown_peer_id: {:?}", unknown_peer_id); + + if test_revoke { + wait_route_presence_on_admins( + &admin_a_inst, + &admin_c_inst, + unknown_peer_id, + true, + Duration::from_secs(30), + ) + .await; + wait_ping_reachability("ns_adm", "10.144.144.5", true, Duration::from_secs(20)).await; + wait_ping_reachability("ns_c3", "10.144.144.5", true, Duration::from_secs(20)).await; + + assert!( + admin_a_inst + .get_core_instance() + .revoke_credential(credential_id.as_ref().unwrap()) + .unwrap(), + "credential should be revoked successfully" + ); + admin_a_inst + .get_global_ctx() + .issue_event(GlobalCtxEvent::CredentialChanged); + + wait_route_presence_on_admins( + &admin_a_inst, + &admin_c_inst, + unknown_peer_id, + false, + Duration::from_secs(30), + ) + .await; + wait_ping_reachability("ns_adm", "10.144.144.5", false, Duration::from_secs(5)).await; + wait_ping_reachability("ns_c3", "10.144.144.5", false, Duration::from_secs(5)).await; + + unknown_inst.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + + assert_shared_visibility_stable( + &admin_a_inst, + &admin_c_inst, + unknown_peer_id, + "10.144.144.5", + false, + "revoked credential", + ) + .await; + } else { + assert_shared_visibility_stable( + &admin_a_inst, + &admin_c_inst, + unknown_peer_id, + "10.144.144.5", + false, + "unknown credential", + ) + .await; + } + + println!("drop all"); + + drop_insts(vec![ + admin_a_inst, + shared_b_inst, + admin_c_inst, + unknown_inst, + ]) + .await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +async fn credential_admin_shared_admin_credential_connectivity( + #[values(true, false)] connect_to_admin: bool, +) { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + // Keep traffic on the shared/admin relay path; direct P2P would bypass it. + + // 10.1.1.1 + let admin_a_config = + create_admin_config("admin_a", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + disable_p2p(&admin_a_config); + let mut admin_a_inst = + Instance::new_with_process_runtime(admin_a_config, process_runtime.clone()); + admin_a_inst.run().await.unwrap(); + + // 10.1.1.2 + let shared_b_config = + create_shared_config("shared_b", Some("ns_c1"), "10.144.144.2", "fd00::2/64"); + disable_p2p(&shared_b_config); + let mut shared_b_inst = + Instance::new_with_process_runtime(shared_b_config, process_runtime.clone()); + shared_b_inst.run().await.unwrap(); + + // 10.1.1.4 + let admin_c_config = + create_admin_config("admin_c", Some("ns_c3"), "10.144.144.4", "fd00::4/64"); + disable_p2p(&admin_c_config); + let mut admin_c_inst = + Instance::new_with_process_runtime(admin_c_config, process_runtime.clone()); + admin_c_inst.run().await.unwrap(); + + admin_a_inst.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + admin_c_inst.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + + // print all peer ids + println!("admin_a_peer_id: {:?}", admin_a_inst.peer_id()); + println!("shared_b_peer_id: {:?}", shared_b_inst.peer_id()); + println!("admin_c_peer_id: {:?}", admin_c_inst.peer_id()); + + let admin_c_peer_id = admin_c_inst.peer_id(); + wait_for_condition( + || async { + let a_routes = admin_a_inst.get_core_instance().route_snapshots().await; + let c_routes = admin_c_inst.get_core_instance().route_snapshots().await; + println!( + "bootstrap routes: a={:?} c={:?}", + a_routes.iter().map(|r| r.peer_id).collect::>(), + c_routes.iter().map(|r| r.peer_id).collect::>() + ); + a_routes.iter().any(|r| r.peer_id == admin_c_peer_id) + || c_routes.iter().any(|r| r.peer_id == admin_a_inst.peer_id()) + }, + Duration::from_secs(3), + ) + .await; + + let cred_d_config = create_credential_config( + &admin_a_inst, + "cred_d", + Some("ns_c2"), + "10.144.144.5", + "fd00::5/64", + ) + .await; + admin_a_inst + .get_global_ctx() + .issue_event(GlobalCtxEvent::CredentialChanged); + + disable_p2p(&cred_d_config); + let mut cred_d_inst = + Instance::new_with_process_runtime(cred_d_config, process_runtime.clone()); + cred_d_inst.run().await.unwrap(); + let cred_d_peer_id = cred_d_inst.peer_id(); + + cred_d_inst.add_connector_url(if !connect_to_admin { + // connect to shared node + "tcp://10.1.1.2:11010".parse().unwrap() + } else { + // connect to admin node + "tcp://10.1.1.4:11010".parse().unwrap() + }); + // print all peer ids + println!("cred_d_peer_id: {:?}", cred_d_peer_id); + + wait_for_condition( + || async { + admin_c_inst + .get_core_instance() + .route_snapshots() + .await + .iter() + .any(|r| r.peer_id == cred_d_peer_id) + }, + Duration::from_secs(60), + ) + .await; + + wait_for_condition( + || async { ping_test("ns_c3", "10.144.144.5", None).await }, + Duration::from_secs(15), + ) + .await; + + wait_for_condition( + || async { ping_test("ns_adm", "10.144.144.5", None).await }, + Duration::from_secs(15), + ) + .await; + + wait_for_condition( + || async { ping_test("ns_c2", "10.144.144.4", None).await }, + Duration::from_secs(15), + ) + .await; + + drop_insts(vec![admin_a_inst, shared_b_inst, admin_c_inst, cred_d_inst]).await; +} + +#[tokio::test] +#[serial_test::serial] +async fn credential_non_reusable_across_two_admins_allows_only_one_peer() { + prepare_credential_network(); + let process_runtime = CoreProcessRuntime::new(); + + let admin_a_config = + create_admin_config("admin_a", Some("ns_adm"), "10.144.144.1", "fd00::1/64"); + let mut admin_a_inst = + Instance::new_with_process_runtime(admin_a_config, process_runtime.clone()); + admin_a_inst.run().await.unwrap(); + + let shared_b_config = + create_shared_config("shared_b", Some("ns_c1"), "10.144.144.2", "fd00::2/64"); + let mut shared_b_inst = + Instance::new_with_process_runtime(shared_b_config, process_runtime.clone()); + shared_b_inst.run().await.unwrap(); + + let admin_c_config = + create_admin_config("admin_c", Some("ns_c3"), "10.144.144.4", "fd00::4/64"); + let mut admin_c_inst = + Instance::new_with_process_runtime(admin_c_config, process_runtime.clone()); + admin_c_inst.run().await.unwrap(); + + admin_a_inst.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + admin_c_inst.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + + let admin_c_peer_id = admin_c_inst.peer_id(); + wait_for_condition( + || async { + let a_routes = admin_a_inst.get_core_instance().route_snapshots().await; + let c_routes = admin_c_inst.get_core_instance().route_snapshots().await; + a_routes.iter().any(|r| r.peer_id == admin_c_peer_id) + && c_routes.iter().any(|r| r.peer_id == admin_a_inst.peer_id()) + }, + Duration::from_secs(20), + ) + .await; + + let (_cred_id, cred_secret) = generate_credential_with_options( + &admin_a_inst, + vec![], + false, + vec![], + Duration::from_secs(3600), + None, + false, + ) + .await; + admin_a_inst + .get_global_ctx() + .issue_event(GlobalCtxEvent::CredentialChanged); + + let network_name = admin_a_inst + .get_global_ctx() + .get_network_identity() + .network_name + .clone(); + let cred_left_config = create_credential_config_from_secret( + network_name.clone(), + &cred_secret, + "cred_left", + Some("ns_c2"), + "10.144.144.5", + "fd00::5/64", + ); + let cred_right_config = create_credential_config_from_secret( + network_name, + &cred_secret, + "cred_right", + Some("ns_c4"), + "10.144.144.6", + "fd00::6/64", + ); + + let mut cred_left_inst = Some(Instance::new_with_process_runtime( + cred_left_config, + process_runtime.clone(), + )); + cred_left_inst.as_mut().unwrap().run().await.unwrap(); + cred_left_inst + .as_ref() + .unwrap() + .add_connector_url("tcp://10.1.1.1:11010".parse().unwrap()); + + let mut cred_right_inst = Some(Instance::new_with_process_runtime( + cred_right_config, + process_runtime.clone(), + )); + cred_right_inst.as_mut().unwrap().run().await.unwrap(); + cred_right_inst + .as_ref() + .unwrap() + .add_connector_url("tcp://10.1.1.4:11010".parse().unwrap()); + + let cred_left_peer_id = cred_left_inst.as_ref().unwrap().peer_id(); + let cred_right_peer_id = cred_right_inst.as_ref().unwrap().peer_id(); + let winner_peer_id = wait_stable_single_visible_peer_on_admins( + &admin_a_inst, + &admin_c_inst, + cred_left_peer_id, + cred_right_peer_id, + Duration::from_secs(60), + ) + .await; + + let (winner_peer_id, winner_ip, loser_peer_id, loser_ip) = + if winner_peer_id == cred_left_peer_id { + ( + cred_left_peer_id, + "10.144.144.5", + cred_right_peer_id, + "10.144.144.6", + ) + } else { + ( + cred_right_peer_id, + "10.144.144.6", + cred_left_peer_id, + "10.144.144.5", + ) + }; + + wait_ping_reachability("ns_adm", winner_ip, true, Duration::from_secs(20)).await; + wait_ping_reachability("ns_c3", winner_ip, true, Duration::from_secs(20)).await; + wait_ping_reachability("ns_adm", loser_ip, false, Duration::from_secs(5)).await; + wait_ping_reachability("ns_c3", loser_ip, false, Duration::from_secs(5)).await; + + assert_shared_visibility_stable( + &admin_a_inst, + &admin_c_inst, + winner_peer_id, + winner_ip, + true, + "winning credential", + ) + .await; + assert_shared_visibility_stable( + &admin_a_inst, + &admin_c_inst, + loser_peer_id, + loser_ip, + false, + "losing credential", + ) + .await; + + if winner_peer_id == cred_left_peer_id { + drop_insts(vec![cred_left_inst.take().unwrap()]).await; + } else { + drop_insts(vec![cred_right_inst.take().unwrap()]).await; + } + + wait_stable_failover_visibility_on_admins( + &admin_a_inst, + &admin_c_inst, + loser_peer_id, + winner_peer_id, + Duration::from_secs(60), + ) + .await; + + wait_ping_reachability("ns_adm", loser_ip, true, Duration::from_secs(20)).await; + wait_ping_reachability("ns_c3", loser_ip, true, Duration::from_secs(20)).await; + wait_ping_reachability("ns_adm", winner_ip, false, Duration::from_secs(5)).await; + wait_ping_reachability("ns_c3", winner_ip, false, Duration::from_secs(5)).await; + + assert_shared_visibility_stable( + &admin_a_inst, + &admin_c_inst, + loser_peer_id, + loser_ip, + true, + "failover credential", + ) + .await; + assert_shared_visibility_stable( + &admin_a_inst, + &admin_c_inst, + winner_peer_id, + winner_ip, + false, + "removed winning credential", + ) + .await; + + if winner_peer_id == cred_left_peer_id { + drop_insts(vec![ + admin_a_inst, + shared_b_inst, + admin_c_inst, + cred_right_inst.take().unwrap(), + ]) + .await; + } else { + drop_insts(vec![ + admin_a_inst, + shared_b_inst, + admin_c_inst, + cred_left_inst.take().unwrap(), + ]) + .await; + } +} diff --git a/vendor/easytier/easytier/src/tests/ipv6_test.rs b/vendor/easytier/easytier/src/tests/ipv6_test.rs new file mode 100644 index 0000000..c21a7dd --- /dev/null +++ b/vendor/easytier/easytier/src/tests/ipv6_test.rs @@ -0,0 +1,41 @@ +use crate::{ + common::config::{ConfigLoader, TomlConfigLoader}, + common::global_ctx::tests::get_mock_global_ctx, +}; + +#[tokio::test] +async fn test_ipv6_config_support() { + let config = TomlConfigLoader::default(); + + // Test IPv6 configuration setting and getting + let ipv6_cidr = "fd00::1/64".parse().unwrap(); + config.set_ipv6(Some(ipv6_cidr)); + + assert_eq!(config.get_ipv6(), Some(ipv6_cidr)); +} + +#[tokio::test] +async fn test_global_ctx_ipv6() { + let global_ctx = get_mock_global_ctx(); + + // Test setting and getting IPv6 from global context + let ipv6_cidr = "fd00::1/64".parse().unwrap(); + global_ctx.set_ipv6(Some(ipv6_cidr)); + + assert_eq!(global_ctx.get_ipv6(), Some(ipv6_cidr)); +} + +#[tokio::test] +async fn native_peer_config_normalizes_ipv6_route() { + let global_ctx = get_mock_global_ctx(); + + // Set IPv6 address in global context + let ipv6_cidr = "fd00::1/64".parse().unwrap(); + global_ctx.set_ipv6(Some(ipv6_cidr)); + + let config = crate::instance::config::test_core_instance_config(&global_ctx).peer; + let ipv6 = config.snapshot.runtime.core.routes.ipv6.unwrap(); + + assert_eq!(ipv6.address, std::net::IpAddr::V6(ipv6_cidr.address())); + assert_eq!(ipv6.prefix_len, ipv6_cidr.network_length()); +} diff --git a/vendor/easytier/easytier/src/tests/mod.rs b/vendor/easytier/easytier/src/tests/mod.rs new file mode 100644 index 0000000..623ca55 --- /dev/null +++ b/vendor/easytier/easytier/src/tests/mod.rs @@ -0,0 +1,279 @@ +#[cfg(target_os = "linux")] +mod three_node; + +mod ipv6_test; + +#[cfg(target_os = "linux")] +mod credential_tests; + +#[cfg(target_os = "linux")] +#[cfg(feature = "upnp")] +mod upnp_test; + +use crate::instance::test_instance::TestInstance as Instance; +use easytier_core::config::PeerId; + +trait InstanceTestExt { + fn add_connector_url(&self, url: url::Url); + + fn peer_id(&self) -> PeerId; + + fn ring_listener_url(&self) -> url::Url; +} + +impl InstanceTestExt for Instance { + fn add_connector_url(&self, url: url::Url) { + self.get_core_instance() + .add_connector(url) + .expect("test connector URL should be supported"); + } + + fn peer_id(&self) -> PeerId { + self.get_core_instance().peer_id() + } + + fn ring_listener_url(&self) -> url::Url { + self.get_core_instance() + .running_listeners() + .into_iter() + .find(|url| url.scheme() == "ring") + .expect("test instance has no running Ring listener") + } +} + +pub fn set_env_var, V: AsRef>(key: K, value: V) { + unsafe { std::env::set_var(key, value) } +} + +pub fn remove_env_var>(key: K) { + unsafe { std::env::remove_var(key) } +} + +pub fn get_guest_veth_name(net_ns: &str) -> &str { + Box::leak(format!("veth_{}_g", net_ns).into_boxed_str()) +} + +pub fn get_host_veth_name(net_ns: &str) -> &str { + Box::leak(format!("veth_{}_h", net_ns).into_boxed_str()) +} + +pub fn del_netns(name: &str) { + // del veth host + let _ = std::process::Command::new("ip") + .args(["link", "del", get_host_veth_name(name)]) + .output(); + + let _ = std::process::Command::new("ip") + .args(["netns", "del", name]) + .output(); +} + +pub fn create_netns(name: &str, ipv4: &str, ipv6: &str) { + // create netns + let _ = std::process::Command::new("ip") + .args(["netns", "add", name]) + .output() + .unwrap(); + + // set lo up + let _ = std::process::Command::new("ip") + .args(["netns", "exec", name, "ip", "link", "set", "lo", "up"]) + .output() + .unwrap(); + + let _ = std::process::Command::new("ip") + .args([ + "link", + "add", + get_host_veth_name(name), + "type", + "veth", + "peer", + "name", + get_guest_veth_name(name), + ]) + .output() + .unwrap(); + + let _ = std::process::Command::new("ip") + .args(["link", "set", get_guest_veth_name(name), "netns", name]) + .output() + .unwrap(); + + let _ = std::process::Command::new("ip") + .args([ + "netns", + "exec", + name, + "ip", + "link", + "set", + get_guest_veth_name(name), + "up", + ]) + .output() + .unwrap(); + + let _ = std::process::Command::new("ip") + .args(["link", "set", get_host_veth_name(name), "up"]) + .output() + .unwrap(); + + for ip in [ipv4, ipv6] { + let _ = std::process::Command::new("ip") + .args([ + "netns", + "exec", + name, + "ip", + "addr", + "add", + ip, + "dev", + get_guest_veth_name(name), + ]) + .output() + .unwrap(); + } +} + +pub fn prepare_bridge(name: &str) { + // del bridge with brctl + let _ = std::process::Command::new("brctl") + .args(["delbr", name]) + .output(); + + // create new br + let _ = std::process::Command::new("brctl") + .args(["addbr", name]) + .output(); +} + +pub fn add_ns_to_bridge(br_name: &str, ns_name: &str) { + // use brctl to add ns to bridge + let _ = std::process::Command::new("brctl") + .args(["addif", br_name, get_host_veth_name(ns_name)]) + .output() + .unwrap(); + + // set bridge up + let _ = std::process::Command::new("ip") + .args(["link", "set", br_name, "up"]) + .output() + .unwrap(); +} + +fn check_route( + ipv4: &str, + dst_peer_id: PeerId, + routes: Vec, +) { + let mut found = false; + for r in routes.iter() { + if r.ipv4_addr == Some(ipv4.parse().unwrap()) { + found = true; + assert_eq!(r.peer_id, dst_peer_id, "{:?}", routes); + } + } + assert!( + found, + "routes: {:?}, dst_peer_id: {}, ipv4: {}", + routes, dst_peer_id, ipv4 + ); +} + +fn check_route_ex( + routes: Vec, + peer_id: PeerId, + checker: impl Fn(&easytier_proto::core_peer::peer::Route) -> bool, +) { + let mut found = false; + for r in routes.iter() { + if r.peer_id == peer_id { + found = true; + assert!(checker(r), "{:?}", routes); + } + } + assert!(found, "routes: {:?}, dst_peer_id: {}", routes, peer_id); +} + +async fn wait_proxy_route_appear( + core: &std::sync::Arc, + ipv4: &str, + dst_peer_id: PeerId, + proxy_cidr: &str, +) { + let now = std::time::Instant::now(); + loop { + for r in core.route_snapshots().await.iter() { + if r.proxy_cidrs.contains(&proxy_cidr.to_owned()) { + assert_eq!(r.peer_id, dst_peer_id); + assert_eq!(r.ipv4_addr, Some(ipv4.parse().unwrap())); + return; + } + } + if now.elapsed().as_secs() > 5 { + panic!("wait proxy route appear timeout"); + } + tokio::time::sleep(tokio::time::Duration::from_millis(100)).await; + } +} + +fn set_link_status(net_ns: &str, up: bool) { + let ret = std::process::Command::new("ip") + .args([ + "netns", + "exec", + net_ns, + "ip", + "link", + "set", + get_guest_veth_name(net_ns), + if up { "up" } else { "down" }, + ]) + .output() + .unwrap(); + tracing::info!("set link status: {:?}, net_ns: {}, up: {}", ret, net_ns, up); +} + +pub async fn drop_insts(insts: Vec) { + let mut set = tokio::task::JoinSet::new(); + for mut inst in insts { + set.spawn(async move { + inst.clear_resources().await; + let core = std::sync::Arc::downgrade(&inst.get_core_instance()); + drop(inst); + let now = std::time::Instant::now(); + while now.elapsed().as_secs() < 5 && core.strong_count() > 0 { + tokio::time::sleep(std::time::Duration::from_millis(50)).await; + } + assert_eq!(core.strong_count(), 0, "CoreInstance should be dropped"); + }); + } + while set.join_next().await.is_some() {} +} + +pub async fn ping_test(from_netns: &str, target_ip: &str, payload_size: Option) -> bool { + use crate::common::netns::{NetNS, ROOT_NETNS_NAME}; + let _g = NetNS::new(Some(ROOT_NETNS_NAME.to_owned())).guard(); + let code = tokio::process::Command::new("ip") + .args([ + "netns", + "exec", + from_netns, + "ping", + "-c", + "1", + "-s", + payload_size.unwrap_or(56).to_string().as_str(), + "-W", + "1", + target_ip.to_string().as_str(), + ]) + .stdout(std::process::Stdio::null()) + .stderr(std::process::Stdio::null()) + .status() + .await + .unwrap(); + code.code().unwrap() == 0 +} diff --git a/vendor/easytier/easytier/src/tests/three_node.rs b/vendor/easytier/easytier/src/tests/three_node.rs new file mode 100644 index 0000000..1ea68ee --- /dev/null +++ b/vendor/easytier/easytier/src/tests/three_node.rs @@ -0,0 +1,5028 @@ +#![allow(clippy::too_many_arguments)] + +use core::panic; +use std::{ + future::Future, + sync::{Arc, atomic::AtomicU32}, + time::Duration, +}; + +#[cfg(feature = "wireguard")] +use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; +use easytier_core::{ + connectivity::protocol::raw::TunnelDialer, + foundation::stats::{LabelSet, LabelType, MetricName, MetricSnapshot}, + process_runtime::CoreProcessRuntime, + socket::SocketListener, + tunnel::Tunnel, +}; +use rand::{Rng, rngs::OsRng}; +use tokio::{net::UdpSocket, task::JoinSet}; +use x25519_dalek::StaticSecret; + +use super::*; + +// TODO: 需要加一个单测,确保 socks5 + exit node == self || proxy_cidr == 0.0.0.0/0 时,可以实现出口节点的能力。 + +use crate::{ + common::{ + config::{ConfigLoader, NetworkIdentity, PortForwardConfig, TomlConfigLoader}, + netns::{NetNS, ROOT_NETNS_NAME}, + }, + instance::config::test_runtime_instance_config, + instance::test_instance::TestInstance as Instance, + proto::{ + api::instance::TcpProxyEntryTransportType, + common::{CompressionAlgoPb, SecureModeConfig}, + rpc::standalone::{ + RuntimeRpcDialer, RuntimeRpcListener, runtime_rpc_dialer, runtime_rpc_listener, + runtime_udp_tunnel_dialer, runtime_udp_tunnel_listener, + }, + }, + tunnel::common::tests::{ + _tunnel_bench_netns, _tunnel_pingpong_netns_with_timeout, wait_for_condition, + }, +}; + +fn metric_value(metrics: &[MetricSnapshot], name: MetricName, labels: &LabelSet) -> Option { + metrics + .iter() + .find(|metric| metric.name == name && metric.labels == *labels) + .map(|metric| metric.value) +} + +fn core_tcp_listener(url: url::Url) -> RuntimeRpcListener { + let addr = url + .socket_addrs(|| Some(11010)) + .expect("test TCP listener URL should resolve") + .into_iter() + .next() + .expect("test TCP listener URL should have an address"); + runtime_rpc_listener(addr) +} + +fn core_tcp_dialer(url: url::Url) -> RuntimeRpcDialer { + runtime_rpc_dialer(url) +} + +fn core_udp_listener(url: url::Url) -> impl SocketListener> + Sync { + let addr = url + .socket_addrs(|| Some(11010)) + .expect("test UDP listener URL should resolve") + .into_iter() + .next() + .expect("test UDP listener URL should have an address"); + runtime_udp_tunnel_listener(url, addr) +} + +fn core_udp_dialer(url: url::Url) -> impl TunnelDialer { + runtime_udp_tunnel_dialer(url) +} + +async fn reload_instance_acl(inst: &Instance, acl: Option<&crate::proto::acl::Acl>) { + let mut config = test_runtime_instance_config(&inst.get_global_ctx()); + config.services.acl = easytier_core::config::peers::AclRuleConfig { + acl: acl.cloned(), + ..Default::default() + }; + inst.get_core_instance() + .update_runtime_config(config) + .await + .unwrap(); +} + +async fn set_foreign_network_refresh_interval(inst: &Instance, seconds: u64) { + let mut config = test_runtime_instance_config(&inst.get_global_ctx()); + Arc::make_mut(&mut config.peer).ospf_update_my_foreign_network_interval_sec = seconds; + inst.get_core_instance() + .update_runtime_config(config) + .await + .unwrap(); +} + +#[cfg(feature = "wireguard")] +use crate::{ + common::config::{VpnPortalClientConfig, VpnPortalConfig}, + vpn_portal::wireguard::test_wireguard_keys, +}; + +#[cfg(feature = "wireguard")] +use easytier_core::gateway::vpn_portal::PortalClientState; +#[cfg(feature = "wireguard")] +use easytier_proto::api::{ + config::{ConfigPatchAction, InstanceConfigPatch, VpnPortalClientPatch}, + manage::VpnPortalClientConfig as VpnPortalClientConfigPb, +}; + +pub fn prepare_linux_namespaces() { + del_netns("net_a"); + del_netns("net_b"); + del_netns("net_c"); + del_netns("net_d"); + del_netns("net_e"); + del_netns("net_f"); + + create_netns("net_a", "10.1.1.1/24", "fd11::1/64"); + create_netns("net_b", "10.1.1.2/24", "fd11::2/64"); + create_netns("net_c", "10.1.2.3/24", "fd12::3/64"); + create_netns("net_d", "10.1.2.4/24", "fd12::4/64"); + create_netns("net_e", "10.1.1.3/24", "fd11::3/64"); + create_netns("net_f", "10.1.2.5/24", "fd12::5/64"); + + prepare_bridge("br_a"); + prepare_bridge("br_b"); + + add_ns_to_bridge("br_a", "net_a"); + add_ns_to_bridge("br_a", "net_b"); + add_ns_to_bridge("br_a", "net_e"); + add_ns_to_bridge("br_b", "net_c"); + add_ns_to_bridge("br_b", "net_d"); + add_ns_to_bridge("br_b", "net_f"); +} + +pub fn get_inst_config( + inst_name: &str, + ns: Option<&str>, + ipv4: &str, + ipv6: &str, +) -> TomlConfigLoader { + let config = TomlConfigLoader::default(); + config.set_inst_name(inst_name.to_owned()); + config.set_netns(ns.map(|s| s.to_owned())); + config.set_ipv4(Some(ipv4.parse().unwrap())); + config.set_ipv6(Some(ipv6.parse().unwrap())); + config.set_listeners(vec![ + "tcp://0.0.0.0:11010".parse().unwrap(), + "udp://0.0.0.0:11010".parse().unwrap(), + "wg://0.0.0.0:11011".parse().unwrap(), + "ws://0.0.0.0:11011".parse().unwrap(), + "wss://0.0.0.0:11012".parse().unwrap(), + ]); + config.set_socks5_portal(Some("socks5://0.0.0.0:12345".parse().unwrap())); + config +} + +pub async fn init_three_node(proto: &str) -> Vec { + init_three_node_with_process_runtime(proto, CoreProcessRuntime::new()).await +} + +async fn init_three_node_with_process_runtime( + proto: &str, + process_runtime: Arc, +) -> Vec { + init_three_node_ex_with_inst3( + proto, + |cfg| cfg, + false, + "net_c", + "10.144.144.3", + "fd00::3/64", + process_runtime, + ) + .await +} + +async fn init_three_node_ex_with_inst3 TomlConfigLoader>( + proto: &str, + cfg_cb: F, + use_public_server: bool, + inst3_ns: &str, + inst3_ipv4: &str, + inst3_ipv6: &str, + process_runtime: Arc, +) -> Vec { + prepare_linux_namespaces(); + + let mut inst1 = Instance::new_with_process_runtime( + cfg_cb(get_inst_config( + "inst1", + Some("net_a"), + "10.144.144.1", + "fd00::1/64", + )), + process_runtime.clone(), + ); + let mut inst2 = Instance::new_with_process_runtime( + cfg_cb(get_inst_config( + "inst2", + Some("net_b"), + "10.144.144.2", + "fd00::2/64", + )), + process_runtime.clone(), + ); + let mut inst3 = Instance::new_with_process_runtime( + cfg_cb(get_inst_config( + "inst3", + Some(inst3_ns), + inst3_ipv4, + inst3_ipv6, + )), + process_runtime.clone(), + ); + + inst1.run().await.unwrap(); + inst2.run().await.unwrap(); + inst3.run().await.unwrap(); + + if proto == "tcp" { + inst1.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + } else if proto == "udp" { + inst1.add_connector_url("udp://10.1.1.2:11010".parse().unwrap()); + } else if proto == "wg" { + #[cfg(feature = "wireguard")] + inst1.add_connector_url("wg://10.1.1.2:11011".parse().unwrap()); + } else if proto == "ws" { + #[cfg(feature = "websocket")] + inst1.add_connector_url("ws://10.1.1.2:11011".parse().unwrap()); + } else if proto == "wss" { + #[cfg(feature = "websocket")] + inst1.add_connector_url("wss://10.1.1.2:11012".parse().unwrap()); + } + + inst3.add_connector_url(inst2.ring_listener_url()); + + // wait inst2 have two route. + wait_for_condition( + || async { + if !use_public_server { + inst2.get_core_instance().route_snapshots().await.len() == 2 + } else { + inst2 + .get_core_instance() + .foreign_network_snapshots(false) + .await + .len() + == 1 + } + }, + Duration::from_secs(5), + ) + .await; + + wait_for_condition( + || async { + let routes = inst1.get_core_instance().route_snapshots().await; + println!("routes: {:?}", routes); + routes.len() == 2 + }, + Duration::from_secs(5), + ) + .await; + + wait_for_condition( + || async { + let routes = inst3.get_core_instance().route_snapshots().await; + println!("routes: {:?}", routes); + routes.len() == 2 + }, + Duration::from_secs(5), + ) + .await; + + vec![inst1, inst2, inst3] +} + +pub async fn init_three_node_ex TomlConfigLoader>( + proto: &str, + cfg_cb: F, + use_public_server: bool, +) -> Vec { + init_three_node_ex_with_inst3( + proto, + cfg_cb, + use_public_server, + "net_c", + "10.144.144.3", + "fd00::3/64", + CoreProcessRuntime::new(), + ) + .await +} + +async fn init_lazy_p2p_three_node_ex TomlConfigLoader>( + proto: &str, + cfg_cb: F, +) -> Vec { + init_three_node_ex_with_inst3( + proto, + cfg_cb, + false, + "net_e", + "10.144.144.3", + "fd00::3/64", + CoreProcessRuntime::new(), + ) + .await +} + +pub async fn drop_insts(insts: Vec) { + let mut set = JoinSet::new(); + for mut inst in insts { + set.spawn(async move { + inst.clear_resources().await; + let core = Arc::downgrade(&inst.get_core_instance()); + drop(inst); + let now = std::time::Instant::now(); + while now.elapsed().as_secs() < 5 && core.strong_count() > 0 { + tokio::time::sleep(std::time::Duration::from_millis(50)).await; + } + + debug_assert_eq!(core.strong_count(), 0, "CoreInstance should be dropped"); + }); + } + while set.join_next().await.is_some() {} +} + +async fn ping_test(from_netns: &str, target_ip: &str, payload_size: Option) -> bool { + let _g = NetNS::new(Some(ROOT_NETNS_NAME.to_owned())).guard(); + let code = tokio::process::Command::new("ip") + .args([ + "netns", + "exec", + from_netns, + "ping", + "-c", + "1", + "-s", + payload_size.unwrap_or(56).to_string().as_str(), + "-W", + "1", + target_ip.to_string().as_str(), + ]) + .stdout(std::process::Stdio::null()) + .stderr(std::process::Stdio::null()) + .status() + .await + .unwrap(); + code.code().unwrap() == 0 +} + +async fn ping6_test(from_netns: &str, target_ip: &str, payload_size: Option) -> bool { + let _g = NetNS::new(Some(ROOT_NETNS_NAME.to_owned())).guard(); + let code = tokio::process::Command::new("ip") + .args([ + "netns", + "exec", + from_netns, + "ping6", + "-c", + "1", + "-s", + payload_size.unwrap_or(56).to_string().as_str(), + "-W", + "1", + target_ip.to_string().as_str(), + ]) + .stdout(std::process::Stdio::null()) + .stderr(std::process::Stdio::null()) + .status() + .await + .unwrap(); + code.code().unwrap() == 0 +} + +fn run_cmd(program: &str, args: &[&str]) { + let output = std::process::Command::new(program) + .args(args) + .output() + .unwrap(); + assert!( + output.status.success(), + "{} {:?} failed: stdout={}, stderr={}", + program, + args, + String::from_utf8_lossy(&output.stdout), + String::from_utf8_lossy(&output.stderr) + ); +} + +fn run_cmd_output(program: &str, args: &[&str]) -> String { + let output = std::process::Command::new(program) + .args(args) + .output() + .unwrap(); + assert!( + output.status.success(), + "{} {:?} failed: stdout={}, stderr={}", + program, + args, + String::from_utf8_lossy(&output.stdout), + String::from_utf8_lossy(&output.stderr) + ); + String::from_utf8(output.stdout).unwrap() +} + +fn run_ip(args: &[&str]) { + run_cmd("ip", args); +} + +fn run_ip_in_ns(ns: &str, args: &[&str]) { + let mut cmd = vec!["netns", "exec", ns, "ip"]; + cmd.extend_from_slice(args); + run_cmd("ip", &cmd); +} + +fn run_ip_in_ns_output(ns: &str, args: &[&str]) -> String { + let mut cmd = vec!["netns", "exec", ns, "ip"]; + cmd.extend_from_slice(args); + run_cmd_output("ip", &cmd) +} + +fn run_sysctl_in_ns(ns: &str, assignment: &str) { + run_cmd("ip", &["netns", "exec", ns, "sysctl", "-qw", assignment]); +} + +fn create_empty_netns(name: &str) { + del_netns(name); + run_ip(&["netns", "add", name]); + run_ip(&["netns", "exec", name, "ip", "link", "set", "lo", "up"]); +} + +fn connect_ns_to_bridge(ns: &str, guest_if: &str, host_if: &str, bridge: &str) { + let _ = std::process::Command::new("ip") + .args(["link", "del", host_if]) + .status(); + run_ip(&[ + "link", "add", host_if, "type", "veth", "peer", "name", guest_if, + ]); + run_ip(&["link", "set", guest_if, "netns", ns]); + run_ip(&["link", "set", host_if, "up"]); + run_cmd("brctl", &["addif", bridge, host_if]); + run_ip(&["netns", "exec", ns, "ip", "link", "set", guest_if, "up"]); +} + +struct PublicIpv6Lab { + extra_namespaces: [&'static str; 2], + extra_bridges: [&'static str; 2], +} + +#[derive(Clone, Copy)] +enum PublicIpv6LabTopology { + DelegatedPrefix, + OnLinkPrefix, +} + +impl PublicIpv6Lab { + const PROVIDER_NS: &'static str = "net_a"; + const CLIENT_NS: &'static str = "net_b"; + const UPSTREAM_NS: &'static str = "net_pubgw"; + const SERVER_NS: &'static str = "net_pubsrv"; + const WAN_BRIDGE: &'static str = "br_pubwan"; + const SERVER_BRIDGE: &'static str = "br_pubsrv"; + const PROVIDER_TUN: &'static str = "etpubv6p"; + const CLIENT_TUN: &'static str = "etpubv6c"; + const PROVIDER_PREFIX: &'static str = "2001:db8:100::/64"; + const PROVIDER_DEFAULT_FROM: &'static str = "2001:db8:100::/64"; + const PROVIDER_WAN_ADDR: &'static str = "2001:db8:ffff:1::2/64"; + const UPSTREAM_WAN_ADDR: &'static str = "2001:db8:ffff:1::1/64"; + const ON_LINK_PROVIDER_WAN_ADDR: &'static str = "2001:db8:100::2/64"; + const ON_LINK_UPSTREAM_WAN_ADDR: &'static str = "2001:db8:100::1/64"; + const UPSTREAM_SERVER_ADDR: &'static str = "2001:db8:ffff:2::1/64"; + const SERVER_ADDR: &'static str = "2001:db8:ffff:2::100/64"; + const SERVER_IP: &'static str = "2001:db8:ffff:2::100"; + + fn setup_with_topology(topology: PublicIpv6LabTopology) -> Self { + prepare_linux_namespaces(); + + del_netns(Self::UPSTREAM_NS); + del_netns(Self::SERVER_NS); + let _ = std::process::Command::new("ip") + .args(["link", "del", Self::WAN_BRIDGE]) + .status(); + let _ = std::process::Command::new("ip") + .args(["link", "del", Self::SERVER_BRIDGE]) + .status(); + let _ = std::process::Command::new("brctl") + .args(["delbr", Self::WAN_BRIDGE]) + .status(); + let _ = std::process::Command::new("brctl") + .args(["delbr", Self::SERVER_BRIDGE]) + .status(); + + create_empty_netns(Self::UPSTREAM_NS); + create_empty_netns(Self::SERVER_NS); + prepare_bridge(Self::WAN_BRIDGE); + prepare_bridge(Self::SERVER_BRIDGE); + run_ip(&["link", "set", Self::WAN_BRIDGE, "up"]); + run_ip(&["link", "set", Self::SERVER_BRIDGE, "up"]); + + connect_ns_to_bridge( + Self::PROVIDER_NS, + "pubwan0", + "veth_pubwan_p", + Self::WAN_BRIDGE, + ); + connect_ns_to_bridge( + Self::UPSTREAM_NS, + "upwan0", + "veth_pubwan_u", + Self::WAN_BRIDGE, + ); + connect_ns_to_bridge( + Self::UPSTREAM_NS, + "upsrv0", + "veth_pubsrv_u", + Self::SERVER_BRIDGE, + ); + connect_ns_to_bridge( + Self::SERVER_NS, + "srv0", + "veth_pubsrv_s", + Self::SERVER_BRIDGE, + ); + + let (provider_wan_addr, upstream_wan_addr) = match topology { + PublicIpv6LabTopology::DelegatedPrefix => { + (Self::PROVIDER_WAN_ADDR, Self::UPSTREAM_WAN_ADDR) + } + PublicIpv6LabTopology::OnLinkPrefix => ( + Self::ON_LINK_PROVIDER_WAN_ADDR, + Self::ON_LINK_UPSTREAM_WAN_ADDR, + ), + }; + + run_ip_in_ns( + Self::PROVIDER_NS, + &["addr", "add", provider_wan_addr, "dev", "pubwan0"], + ); + run_ip_in_ns( + Self::UPSTREAM_NS, + &["addr", "add", upstream_wan_addr, "dev", "upwan0"], + ); + run_ip_in_ns( + Self::UPSTREAM_NS, + &["addr", "add", Self::UPSTREAM_SERVER_ADDR, "dev", "upsrv0"], + ); + run_ip_in_ns( + Self::SERVER_NS, + &["addr", "add", Self::SERVER_ADDR, "dev", "srv0"], + ); + + match topology { + PublicIpv6LabTopology::DelegatedPrefix => { + run_ip_in_ns( + Self::PROVIDER_NS, + &["link", "add", "pubprefix0", "type", "dummy"], + ); + run_ip_in_ns(Self::PROVIDER_NS, &["link", "set", "pubprefix0", "up"]); + run_ip_in_ns( + Self::PROVIDER_NS, + &[ + "-6", + "route", + "add", + Self::PROVIDER_PREFIX, + "dev", + "pubprefix0", + ], + ); + run_ip_in_ns( + Self::PROVIDER_NS, + &[ + "-6", + "route", + "add", + "default", + "from", + Self::PROVIDER_DEFAULT_FROM, + "via", + "2001:db8:ffff:1::1", + "dev", + "pubwan0", + ], + ); + } + PublicIpv6LabTopology::OnLinkPrefix => { + run_ip_in_ns( + Self::PROVIDER_NS, + &[ + "-6", + "route", + "add", + "default", + "via", + "2001:db8:100::1", + "dev", + "pubwan0", + ], + ); + } + } + + run_ip_in_ns( + Self::SERVER_NS, + &[ + "-6", + "route", + "add", + "default", + "via", + "2001:db8:ffff:2::1", + "dev", + "srv0", + ], + ); + if matches!(topology, PublicIpv6LabTopology::DelegatedPrefix) { + run_ip_in_ns( + Self::UPSTREAM_NS, + &[ + "-6", + "route", + "add", + Self::PROVIDER_PREFIX, + "via", + "2001:db8:ffff:1::2", + "dev", + "upwan0", + ], + ); + } + + run_sysctl_in_ns(Self::PROVIDER_NS, "net.ipv6.conf.all.forwarding=1"); + run_sysctl_in_ns(Self::UPSTREAM_NS, "net.ipv6.conf.all.forwarding=1"); + + Self { + extra_namespaces: [Self::UPSTREAM_NS, Self::SERVER_NS], + extra_bridges: [Self::WAN_BRIDGE, Self::SERVER_BRIDGE], + } + } +} + +impl Drop for PublicIpv6Lab { + fn drop(&mut self) { + for ns in self.extra_namespaces { + del_netns(ns); + } + for bridge in self.extra_bridges { + let _ = std::process::Command::new("ip") + .args(["link", "del", bridge]) + .status(); + let _ = std::process::Command::new("brctl") + .args(["delbr", bridge]) + .status(); + } + } +} + +fn get_public_ipv6_config( + inst_name: &str, + netns: &str, + ipv4: &str, + dev_name: &str, + inst_id: uuid::Uuid, +) -> TomlConfigLoader { + let config = get_inst_config(inst_name, Some(netns), ipv4, "fd00::1/64"); + config.set_id(inst_id); + config.set_ipv6(None); + config.set_socks5_portal(None); + config.set_network_identity(NetworkIdentity { + network_name: "public_ipv6_auto_addr_test".to_string(), + network_secret: Some("public_ipv6_auto_addr_secret".to_string()), + network_secret_digest: None, + }); + config.set_listeners(vec!["tcp://0.0.0.0:11010".parse().unwrap()]); + let mut flags = config.get_flags(); + flags.dev_name = dev_name.to_string(); + config.set_flags(flags); + config +} + +async fn init_public_ipv6_two_node( + client_inst_id: uuid::Uuid, +) -> (PublicIpv6Lab, Arc, Instance, Instance) { + init_public_ipv6_two_node_with_topology(client_inst_id, PublicIpv6LabTopology::DelegatedPrefix) + .await +} + +async fn init_public_ipv6_two_node_with_topology( + client_inst_id: uuid::Uuid, + topology: PublicIpv6LabTopology, +) -> (PublicIpv6Lab, Arc, Instance, Instance) { + let lab = PublicIpv6Lab::setup_with_topology(topology); + let process_runtime = CoreProcessRuntime::new(); + + let provider_cfg = get_public_ipv6_config( + "provider_public_ipv6", + PublicIpv6Lab::PROVIDER_NS, + "10.144.144.1", + PublicIpv6Lab::PROVIDER_TUN, + uuid::Uuid::parse_str("11111111-1111-1111-1111-111111111111").unwrap(), + ); + provider_cfg.set_ipv6_public_addr_provider(true); + + let client_cfg = get_public_ipv6_config( + "client_public_ipv6", + PublicIpv6Lab::CLIENT_NS, + "10.144.144.2", + PublicIpv6Lab::CLIENT_TUN, + client_inst_id, + ); + client_cfg.set_ipv6_public_addr_auto(true); + + let mut provider = Instance::new_with_process_runtime(provider_cfg, process_runtime.clone()); + let mut client = Instance::new_with_process_runtime(client_cfg, process_runtime.clone()); + + provider.run().await.unwrap(); + client.run().await.unwrap(); + + provider.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + + wait_for_condition( + || async { + provider.get_core_instance().route_snapshots().await.len() == 1 + && client.get_core_instance().route_snapshots().await.len() == 1 + }, + Duration::from_secs(8), + ) + .await; + + (lab, process_runtime, provider, client) +} + +async fn wait_for_public_ipv6_addr(inst: &Instance) -> cidr::Ipv6Inet { + wait_for_condition( + || async { + inst.get_core_instance() + .packet_plane() + .public_ipv6_addr() + .await + .is_some() + }, + Duration::from_secs(10), + ) + .await; + inst.get_core_instance() + .packet_plane() + .public_ipv6_addr() + .await + .unwrap() +} + +async fn wait_for_public_ipv6_route(inst: &Instance, target: cidr::Ipv6Inet) { + wait_for_condition( + || async { + inst.get_core_instance() + .packet_plane() + .public_ipv6_routes() + .await + .contains(&target) + }, + Duration::from_secs(10), + ) + .await; +} + +fn route_exists_in_ns(ns: &str, needle: &str) -> bool { + run_ip_in_ns_output(ns, &["-6", "route", "show"]) + .lines() + .any(|line| line.contains(needle)) +} + +fn addr_exists_in_ns(ns: &str, dev: &str, needle: &str) -> bool { + run_ip_in_ns_output(ns, &["-6", "addr", "show", "dev", dev]).contains(needle) +} + +fn ndp_proxy_exists_in_ns(ns: &str, dev: &str, addr: std::net::Ipv6Addr) -> bool { + let addr = addr.to_string(); + run_ip_in_ns_output(ns, &["-6", "neigh", "show", "proxy", "dev", dev]) + .lines() + .any(|line| line.split_whitespace().next() == Some(addr.as_str())) +} + +#[tokio::test] +#[serial_test::serial] +pub async fn public_ipv6_auto_addr_end_to_end() { + let client_id = uuid::Uuid::parse_str("22222222-2222-2222-2222-222222222222").unwrap(); + let (_lab, _process_runtime, provider, client) = init_public_ipv6_two_node(client_id).await; + + wait_for_condition( + || async { + provider + .get_core_instance() + .node_snapshot() + .await + .ipv6_public_addr_prefix + == Some(PublicIpv6Lab::PROVIDER_PREFIX.parse().unwrap()) + }, + Duration::from_secs(10), + ) + .await; + + let leased = wait_for_public_ipv6_addr(&client).await; + wait_for_public_ipv6_route(&provider, leased).await; + + assert_eq!( + provider + .get_global_ctx() + .config + .get_ipv6_public_addr_prefix(), + None + ); + assert_eq!( + provider + .get_core_instance() + .node_snapshot() + .await + .ipv6_public_addr_prefix, + Some(PublicIpv6Lab::PROVIDER_PREFIX.parse().unwrap()) + ); + let provider_prefix = PublicIpv6Lab::PROVIDER_PREFIX + .parse::() + .unwrap(); + assert_eq!( + provider + .get_core_instance() + .node_snapshot() + .await + .ipv6_public_addr_prefix, + Some( + cidr::Ipv6Inet::new( + provider_prefix.first_address(), + provider_prefix.network_length() + ) + .unwrap() + ) + ); + let provider_info = provider.get_core_instance().local_public_ipv6_info().await; + let client_peer_id = client.get_core_instance().node_snapshot().await.peer_id; + assert_eq!( + provider_info.provider_prefix, + Some( + cidr::Ipv6Inet::new( + provider_prefix.first_address(), + provider_prefix.network_length() + ) + .unwrap() + .into() + ) + ); + assert_eq!(provider_info.provider_leases.len(), 1); + assert_eq!(provider_info.provider_leases[0].peer_id, client_peer_id); + assert_eq!( + provider_info.provider_leases[0].inst_id, + client_id.to_string() + ); + assert_eq!( + provider_info.provider_leases[0].leased_addr, + Some(leased.into()) + ); + assert!( + leased.address().segments()[0] & 0xfe00 != 0xfc00, + "leased address should not be unique-local: {leased}" + ); + + wait_for_condition( + || async { + addr_exists_in_ns( + PublicIpv6Lab::CLIENT_NS, + PublicIpv6Lab::CLIENT_TUN, + &leased.to_string(), + ) && route_exists_in_ns( + PublicIpv6Lab::CLIENT_NS, + &format!("default dev {}", PublicIpv6Lab::CLIENT_TUN), + ) && route_exists_in_ns( + PublicIpv6Lab::PROVIDER_NS, + &format!("{} dev {}", leased.address(), PublicIpv6Lab::PROVIDER_TUN), + ) + }, + Duration::from_secs(10), + ) + .await; + + wait_for_condition( + || async { ping6_test(PublicIpv6Lab::CLIENT_NS, PublicIpv6Lab::SERVER_IP, None).await }, + Duration::from_secs(10), + ) + .await; + + wait_for_condition( + || async { + ping6_test( + PublicIpv6Lab::SERVER_NS, + leased.address().to_string().as_str(), + None, + ) + .await + }, + Duration::from_secs(10), + ) + .await; + + drop_insts(vec![provider, client]).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn public_ipv6_auto_addr_on_link_ndp_proxy_end_to_end() { + let client_id = uuid::Uuid::parse_str("44444444-4444-4444-4444-444444444444").unwrap(); + let (_lab, _process_runtime, provider, client) = + init_public_ipv6_two_node_with_topology(client_id, PublicIpv6LabTopology::OnLinkPrefix) + .await; + + wait_for_condition( + || async { + provider + .get_core_instance() + .node_snapshot() + .await + .ipv6_public_addr_prefix + == Some(PublicIpv6Lab::PROVIDER_PREFIX.parse().unwrap()) + }, + Duration::from_secs(10), + ) + .await; + + let leased = wait_for_public_ipv6_addr(&client).await; + wait_for_public_ipv6_route(&provider, leased).await; + + wait_for_condition( + || async { + addr_exists_in_ns( + PublicIpv6Lab::CLIENT_NS, + PublicIpv6Lab::CLIENT_TUN, + &leased.to_string(), + ) && route_exists_in_ns( + PublicIpv6Lab::PROVIDER_NS, + &format!("{} dev {}", leased.address(), PublicIpv6Lab::PROVIDER_TUN), + ) + }, + Duration::from_secs(10), + ) + .await; + + wait_for_condition( + || async { + ndp_proxy_exists_in_ns(PublicIpv6Lab::PROVIDER_NS, "pubwan0", leased.address()) + }, + Duration::from_secs(20), + ) + .await; + + wait_for_condition( + || async { + ping6_test( + PublicIpv6Lab::SERVER_NS, + leased.address().to_string().as_str(), + None, + ) + .await + }, + Duration::from_secs(20), + ) + .await; + + drop_insts(vec![provider, client]).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn public_ipv6_auto_addr_reconnect_reuses_same_address() { + let client_id = uuid::Uuid::parse_str("33333333-3333-3333-3333-333333333333").unwrap(); + let (_lab, process_runtime, provider, client) = init_public_ipv6_two_node(client_id).await; + let first = wait_for_public_ipv6_addr(&client).await; + + drop_insts(vec![client]).await; + + let client_cfg = get_public_ipv6_config( + "client_public_ipv6_reconnect", + PublicIpv6Lab::CLIENT_NS, + "10.144.144.2", + PublicIpv6Lab::CLIENT_TUN, + client_id, + ); + client_cfg.set_ipv6_public_addr_auto(true); + let mut client = Instance::new_with_process_runtime(client_cfg, process_runtime.clone()); + client.run().await.unwrap(); + provider.add_connector_url("tcp://10.1.1.2:11010".parse().unwrap()); + + wait_for_condition( + || async { + provider.get_core_instance().route_snapshots().await.len() == 1 + && client.get_core_instance().route_snapshots().await.len() == 1 + }, + Duration::from_secs(8), + ) + .await; + + let second = wait_for_public_ipv6_addr(&client).await; + assert_eq!(first, second); + + wait_for_condition( + || async { ping6_test(PublicIpv6Lab::CLIENT_NS, PublicIpv6Lab::SERVER_IP, None).await }, + Duration::from_secs(10), + ) + .await; + + drop_insts(vec![provider, client]).await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn basic_three_node_test( + #[values("tcp", "udp", "wg", "ws", "wss")] proto: &str, + #[values( + ["aes-gcm", "aes-gcm"], + ["aes-256-gcm", "aes-256-gcm"], + ["chacha20", "chacha20"], + ["xor", "xor"], + ["openssl-chacha20", "openssl-chacha20"], + ["openssl-aes-gcm", "openssl-aes-gcm"], + ["openssl-aes-256-gcm", "openssl-aes-256-gcm"], + ["aes-gcm", "openssl-aes-gcm"], + ["openssl-aes-gcm", "aes-gcm"], + ["aes-256-gcm", "openssl-aes-256-gcm"], + ["openssl-aes-256-gcm", "aes-256-gcm"], + ["chacha20", "openssl-chacha20"], + ["openssl-chacha20", "chacha20"], + )] + encrypt_algorithm_pair: [&str; 2], +) { + let insts = init_three_node_ex( + proto, + |cfg| { + let mut flags = cfg.get_flags(); + if cfg.get_inst_name() == "inst0" { + flags.encryption_algorithm = encrypt_algorithm_pair[0].to_string(); + } else { + flags.encryption_algorithm = encrypt_algorithm_pair[1].to_string(); + } + cfg.set_flags(flags); + cfg + }, + false, + ) + .await; + + check_route( + "10.144.144.2/24", + insts[1].peer_id(), + insts[0].get_core_instance().route_snapshots().await, + ); + + check_route( + "10.144.144.3/24", + insts[2].peer_id(), + insts[0].get_core_instance().route_snapshots().await, + ); + + // Test IPv4 connectivity + wait_for_condition( + || async { ping_test("net_c", "10.144.144.1", None).await }, + Duration::from_secs(5000), + ) + .await; + + // Test IPv6 connectivity + wait_for_condition( + || async { ping6_test("net_c", "fd00::1", None).await }, + Duration::from_secs(5), + ) + .await; + + wait_for_condition( + || async { ping6_test("net_a", "fd00::3", None).await }, + Duration::from_secs(5), + ) + .await; + + drop_insts(insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn ping_own_virtual_ip_should_work() { + let insts = init_three_node("udp").await; + + wait_for_condition( + || async { ping_test("net_a", "10.144.144.1", None).await }, + Duration::from_secs(5), + ) + .await; + + wait_for_condition( + || async { ping6_test("net_a", "fd00::1", None).await }, + Duration::from_secs(5), + ) + .await; + + drop_insts(insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn subnet_proxy_loop_prevention_test() { + // 测试场景:inst1 和 inst2 都代理了 10.1.2.0/24 网段, + // inst1 发起对 10.1.2.5 的 ping,不应该出现环路 + let insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst1" { + // inst1 代理 10.1.2.0/24 网段 + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + } else if cfg.get_inst_name() == "inst2" { + // inst2 也代理相同的 10.1.2.0/24 网段 + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + } + cfg + }, + false, + ) + .await; + + // 等待代理路由出现 - inst1 应该看到 inst2 的代理路由 + wait_proxy_route_appear( + &insts[0].get_core_instance(), + "10.144.144.2/24", + insts[1].peer_id(), + "10.1.2.0/24", + ) + .await; + + // 等待代理路由出现 - inst2 应该看到 inst1 的代理路由 + wait_proxy_route_appear( + &insts[1].get_core_instance(), + "10.144.144.1/24", + insts[0].peer_id(), + "10.1.2.0/24", + ) + .await; + + // 从 inst1 (net_a) 发起对 10.1.2.5 的 ping 测试 + // 这应该失败,并且不会产生环路 + let now = std::time::Instant::now(); + while now.elapsed().as_secs() < 10 { + ping_test("net_a", "10.1.2.5", None).await; + tokio::time::sleep(Duration::from_secs(1)).await; + } + + println!( + "inst0 metrics: {:?}", + insts[0].get_core_instance().prometheus_metrics() + ); + + let all_metrics = insts[0].get_core_instance().metric_snapshots(); + for metric in all_metrics { + if metric.name == MetricName::TrafficPacketsSelfTx { + assert!(metric.value < 40); + } + } + + drop_insts(insts).await; +} + +async fn subnet_proxy_test_udp(listen_ip: &str, target_ip: &str, timeout: Duration) { + use crate::tunnel::common::tests::_tunnel_pingpong_netns_with_timeout; + use rand::Rng; + + let udp_listener = core_udp_listener(format!("udp://{}:22233", listen_ip).parse().unwrap()); + let udp_connector = core_udp_dialer(format!("udp://{}:22233", target_ip).parse().unwrap()); + + // NOTE: this should not excced udp tunnel max buffer size + let mut buf = vec![0; 7 * 1024]; + rand::thread_rng().fill(&mut buf[..]); + + let ns_name = if target_ip == "10.144.144.3" { + "net_c" + } else { + "net_d" + }; + + let result = _tunnel_pingpong_netns_with_timeout( + udp_listener, + udp_connector, + NetNS::new(Some(ns_name.into())), + NetNS::new(Some("net_a".into())), + buf, + timeout, + ) + .await; + assert!(result.is_ok(), "{}", result.unwrap_err()); + + // no fragment + let udp_listener = core_udp_listener(format!("udp://{}:22233", listen_ip).parse().unwrap()); + let udp_connector = core_udp_dialer(format!("udp://{}:22233", target_ip).parse().unwrap()); + + let mut buf = vec![0; 1024]; + rand::thread_rng().fill(&mut buf[..]); + + let result = _tunnel_pingpong_netns_with_timeout( + udp_listener, + udp_connector, + NetNS::new(Some(ns_name.into())), + NetNS::new(Some("net_a".into())), + buf, + timeout, + ) + .await; + assert!(result.is_ok(), "{}", result.unwrap_err()); +} + +async fn subnet_proxy_test_tcp(listen_ip: &str, connect_ip: &str, timeout: Duration) { + use crate::tunnel::common::tests::_tunnel_pingpong_netns_with_timeout; + use rand::Rng; + + let tcp_listener = core_tcp_listener(format!("tcp://{listen_ip}:22223").parse().unwrap()); + let tcp_connector = core_tcp_dialer(format!("tcp://{}:22223", connect_ip).parse().unwrap()); + + let mut buf = vec![0; 32]; + rand::thread_rng().fill(&mut buf[..]); + + let ns_name = if connect_ip == "10.144.144.3" { + "net_c" + } else { + "net_d" + }; + + let result = _tunnel_pingpong_netns_with_timeout( + tcp_listener, + tcp_connector, + NetNS::new(Some(ns_name.into())), + NetNS::new(Some("net_a".into())), + buf, + timeout, + ) + .await; + assert!(result.is_ok(), "{}", result.unwrap_err()); +} + +async fn subnet_proxy_test_icmp(target_ip: &str, timeout: Duration) { + wait_for_condition( + || async { ping_test("net_a", target_ip, None).await }, + timeout, + ) + .await; + + wait_for_condition( + || async { ping_test("net_a", target_ip, Some(5 * 1024)).await }, + timeout, + ) + .await; +} + +#[tokio::test] +pub async fn quic_proxy() { + let insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst3" { + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + } else if cfg.get_inst_name() == "inst1" { + let mut flags = cfg.get_flags(); + flags.enable_quic_proxy = true; + cfg.set_flags(flags); + } + cfg + }, + false, + ) + .await; + + assert_eq!(insts[2].get_global_ctx().config.get_proxy_cidrs().len(), 1); + + wait_proxy_route_appear( + &insts[0].get_core_instance(), + "10.144.144.3/24", + insts[2].peer_id(), + "10.1.2.0/24", + ) + .await; + + let target_ip = "10.1.2.4"; + + subnet_proxy_test_icmp(target_ip, Duration::from_secs(5)).await; + subnet_proxy_test_icmp("10.144.144.3", Duration::from_secs(5)).await; + subnet_proxy_test_tcp(target_ip, target_ip, Duration::from_secs(5)).await; + subnet_proxy_test_tcp("0.0.0.0", "10.144.144.3", Duration::from_secs(5)).await; + + let metrics = insts[0] + .get_core_instance() + .metric_snapshots() + .into_iter() + .filter(|metric| metric.name == MetricName::TcpProxyConnect) + .collect::>(); + assert_eq!(metrics.len(), 2); + assert_eq!(1, metrics[0].value); + assert_eq!(1, metrics[1].value); + + drop_insts(insts).await; +} + +#[rstest::rstest] +#[serial_test::serial] +#[tokio::test] +pub async fn subnet_proxy_three_node_test( + #[values(true, false)] no_tun: bool, + #[values(true, false)] relay_by_public_server: bool, + #[values(true, false)] enable_kcp_proxy: bool, + #[values(true, false)] enable_quic_proxy: bool, + #[values(true, false)] disable_kcp_input: bool, + #[values(true, false)] disable_quic_input: bool, + #[values(true, false)] dst_enable_kcp_proxy: bool, + #[values(true, false)] dst_enable_quic_proxy: bool, +) { + let insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst3" { + let mut flags = cfg.get_flags(); + flags.no_tun = no_tun; + flags.disable_kcp_input = disable_kcp_input; + flags.enable_kcp_proxy = dst_enable_kcp_proxy; + flags.disable_quic_input = disable_quic_input; + flags.enable_quic_proxy = dst_enable_quic_proxy; + cfg.set_flags(flags); + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + cfg.add_proxy_cidr( + "10.1.2.0/24".parse().unwrap(), + Some("10.1.3.0/24".parse().unwrap()), + ) + .unwrap(); + } + + if cfg.get_inst_name() == "inst2" && relay_by_public_server { + cfg.set_network_identity(NetworkIdentity::new( + "public".to_string(), + "public".to_string(), + )); + } + + if cfg.get_inst_name() == "inst1" { + let mut flags = cfg.get_flags(); + if enable_kcp_proxy { + flags.enable_kcp_proxy = true; + } + if enable_quic_proxy { + flags.enable_quic_proxy = true; + } + cfg.set_flags(flags); + } + + cfg + }, + relay_by_public_server, + ) + .await; + + assert_eq!(insts[2].get_global_ctx().config.get_proxy_cidrs().len(), 2); + + wait_proxy_route_appear( + &insts[0].get_core_instance(), + "10.144.144.3/24", + insts[2].peer_id(), + "10.1.2.0/24", + ) + .await; + wait_proxy_route_appear( + &insts[0].get_core_instance(), + "10.144.144.3/24", + insts[2].peer_id(), + "10.1.3.0/24", + ) + .await; + + for target_ip in ["10.1.3.4", "10.1.2.4", "10.144.144.3"] { + subnet_proxy_test_icmp(target_ip, Duration::from_secs(5)).await; + let listen_ip = if target_ip == "10.144.144.3" { + "0.0.0.0" + } else { + "10.1.2.4" + }; + subnet_proxy_test_tcp(listen_ip, target_ip, Duration::from_secs(5)).await; + subnet_proxy_test_udp(listen_ip, target_ip, Duration::from_secs(5)).await; + } + if enable_quic_proxy && !disable_quic_input { + let metrics = insts[0] + .get_core_instance() + .metric_snapshots() + .into_iter() + .filter(|metric| metric.name == MetricName::TcpProxyConnect) + .collect::>(); + assert_eq!(metrics.len(), 3); + for metric in metrics { + assert_eq!(1, metric.value); + assert!(metric.labels.labels().iter().any(|l| { + let t = + LabelType::Protocol(TcpProxyEntryTransportType::Quic.as_str_name().to_string()); + t.key() == l.key && t.value() == l.value + })); + } + } else if enable_kcp_proxy && !disable_kcp_input { + let metrics = insts[0] + .get_core_instance() + .metric_snapshots() + .into_iter() + .filter(|metric| metric.name == MetricName::TcpProxyConnect) + .collect::>(); + assert_eq!(metrics.len(), 3); + for metric in metrics { + assert_eq!(1, metric.value); + assert!(metric.labels.labels().iter().any(|l| { + let t = + LabelType::Protocol(TcpProxyEntryTransportType::Kcp.as_str_name().to_string()); + t.key() == l.key && t.value() == l.value + })); + } + } else { + // tcp subnet proxy + let metrics = insts[2] + .get_core_instance() + .metric_snapshots() + .into_iter() + .filter(|metric| metric.name == MetricName::TcpProxyConnect) + .collect::>(); + if no_tun { + assert_eq!(metrics.len(), 3); + } else { + assert_eq!(metrics.len(), 2); + } + for metric in metrics { + assert_eq!(1, metric.value); + assert!(metric.labels.labels().iter().any(|l| { + let t = + LabelType::Protocol(TcpProxyEntryTransportType::Tcp.as_str_name().to_string()); + t.key() == l.key && t.value() == l.value + })); + } + } + + drop_insts(insts).await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn subnet_proxy_half_close_test( + #[values("tcp", "kcp", "quic")] transport: &str, + #[values(false, true)] use_smoltcp: bool, +) { + use tokio::io::{AsyncReadExt, AsyncWriteExt}; + + let insts = init_three_node_ex( + "udp", + |cfg| { + let mut flags = cfg.get_flags(); + flags.use_smoltcp = use_smoltcp; + if cfg.get_inst_name() == "inst1" { + flags.enable_kcp_proxy = transport == "kcp"; + flags.enable_quic_proxy = transport == "quic"; + } + cfg.set_flags(flags); + if cfg.get_inst_name() == "inst3" { + cfg.add_proxy_cidr( + "10.1.2.0/24".parse().unwrap(), + Some("10.1.3.0/24".parse().unwrap()), + ) + .unwrap(); + } + cfg + }, + false, + ) + .await; + wait_proxy_route_appear( + &insts[0].get_core_instance(), + "10.144.144.3/24", + insts[2].peer_id(), + "10.1.3.0/24", + ) + .await; + + // The advertised route can precede installation of the host TUN route. + wait_for_condition( + || async { ping_test("net_a", "10.1.3.4", None).await }, + Duration::from_secs(5), + ) + .await; + + let result = tokio::time::timeout(Duration::from_secs(10), async { + let listener = NetNS::new(Some("net_d".into())).run(|| { + let listener = std::net::TcpListener::bind("10.1.2.4:22224").unwrap(); + listener.set_nonblocking(true).unwrap(); + tokio::net::TcpListener::from_std(listener).unwrap() + }); + for (source_closes_first, request_size) in + [(true, 0), (false, 0), (true, 64 * 1024), (false, 64 * 1024)] + { + let socket = + NetNS::new(Some("net_a".into())).run(|| tokio::net::TcpSocket::new_v4().unwrap()); + let (client, (server, _)) = tokio::try_join!( + socket.connect("10.1.3.4:22224".parse().unwrap()), + listener.accept(), + ) + .expect("failed to establish the proxied connection"); + let (mut requester, mut responder) = if source_closes_first { + (client, server) + } else { + (server, client) + }; + let request = vec![0x35; request_size]; + let response = vec![0xa7; 128 * 1024]; + tokio::join!( + async { + requester.write_all(&request).await.unwrap(); + requester.shutdown().await.unwrap(); + let mut received = Vec::new(); + requester.read_to_end(&mut received).await.unwrap(); + assert_eq!(received, response); + }, + async { + let mut received = Vec::new(); + responder.read_to_end(&mut received).await.unwrap(); + assert_eq!(received, request); + responder.write_all(&response).await.unwrap(); + responder.shutdown().await.unwrap(); + }, + ); + } + }) + .await; + drop_insts(insts).await; + result.expect("proxy did not forward the response after half-close"); +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn data_compress( + #[values(true, false)] inst1_compress: bool, + #[values(true, false)] inst2_compress: bool, +) { + let _insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst1" && inst1_compress { + let mut flags = cfg.get_flags(); + flags.data_compress_algo = CompressionAlgoPb::Zstd.into(); + cfg.set_flags(flags); + } + + if cfg.get_inst_name() == "inst3" && inst2_compress { + let mut flags = cfg.get_flags(); + flags.data_compress_algo = CompressionAlgoPb::Zstd.into(); + cfg.set_flags(flags); + } + + cfg + }, + false, + ) + .await; + + wait_for_condition( + || async { ping_test("net_a", "10.144.144.3", None).await }, + Duration::from_secs(5), + ) + .await; + + wait_for_condition( + || async { ping_test("net_a", "10.144.144.3", Some(5 * 1024)).await }, + Duration::from_secs(5), + ) + .await; + + drop_insts(_insts).await; +} + +#[cfg(feature = "wireguard")] +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn proxy_three_node_disconnect_test(#[values("tcp", "wg")] proto: &str) { + use tokio_util::task::AbortOnDropHandle; + + let process_runtime = CoreProcessRuntime::new(); + let insts = init_three_node_with_process_runtime(proto, process_runtime.clone()).await; + let mut inst4 = Instance::new_with_process_runtime( + get_inst_config("inst4", Some("net_d"), "10.144.144.4", "fd00::4/64"), + process_runtime.clone(), + ); + if proto == "tcp" { + inst4.add_connector_url("tcp://10.1.2.3:11010".parse().unwrap()); + } else if proto == "wg" { + inst4.add_connector_url("wg://10.1.2.3:11011".parse().unwrap()); + } else { + unreachable!("not support"); + } + inst4.run().await.unwrap(); + + tracing::info!("inst1 peer id: {:?}", insts[0].peer_id()); + tracing::info!("inst2 peer id: {:?}", insts[1].peer_id()); + tracing::info!("inst3 peer id: {:?}", insts[2].peer_id()); + tracing::info!("inst4 peer id: {:?}", inst4.peer_id()); + + let task = tokio::spawn(async move { + for _ in 1..=2 { + // inst4 should be in inst1's route list + wait_for_condition( + || async { + insts[0] + .get_core_instance() + .route_snapshots() + .await + .iter() + .any(|r| r.peer_id == inst4.peer_id()) + }, + Duration::from_secs(8), + ) + .await; + + set_link_status("net_d", false); + let _t = AbortOnDropHandle::new(tokio::spawn(async move { + // do some ping in net_a to trigger net_c pingpong + loop { + ping_test("net_a", "10.144.144.4", Some(1)).await; + } + })); + wait_for_condition( + || async { + !insts[2] + .get_core_instance() + .connected_peers() + .await + .iter() + .any(|r| *r == inst4.peer_id()) + }, + // 0 down, assume last packet is recv in -0.01 + // one ping outstanding at a time, each waits up to 2s: + // 5 consecutive failures close the connection at ~[4, 11) + Duration::from_secs(15), + ) + .await; + + wait_for_condition( + || async { + !insts[0] + .get_core_instance() + .route_snapshots() + .await + .iter() + .any(|r| r.peer_id == inst4.peer_id()) + }, + Duration::from_secs(7), + ) + .await; + + set_link_status("net_d", true); + } + + drop_insts(insts).await; + }); + + let (ret,) = tokio::join!(task); + assert!(ret.is_ok()); +} + +#[tokio::test] +#[serial_test::serial] +pub async fn udp_broadcast_test() { + let _insts = init_three_node("tcp").await; + + let udp_broadcast_responder = |net_ns: NetNS, counter: Arc| async move { + let _g = net_ns.guard(); + let socket: UdpSocket = UdpSocket::bind("0.0.0.0:22111").await.unwrap(); + socket.set_broadcast(true).unwrap(); + + println!("Awaiting responses..."); // self.recv_buff is a [u8; 8092] + let mut recv_buff = [0; 8092]; + while let Ok((n, addr)) = socket.recv_from(&mut recv_buff).await { + println!("{} bytes response from {:?}", n, addr); + counter.fetch_add(1, std::sync::atomic::Ordering::Relaxed); + // Remaining code not directly relevant to the question + } + }; + + let mut tasks = JoinSet::new(); + let counter = Arc::new(AtomicU32::new(0)); + tasks.spawn(udp_broadcast_responder( + NetNS::new(Some("net_b".into())), + counter.clone(), + )); + tasks.spawn(udp_broadcast_responder( + NetNS::new(Some("net_c".into())), + counter.clone(), + )); + + tokio::time::sleep(tokio::time::Duration::from_secs(1)).await; + + // send broadcast + let net_ns = NetNS::new(Some("net_a".into())); + let _g = net_ns.guard(); + let socket: UdpSocket = UdpSocket::bind("0.0.0.0:0").await.unwrap(); + socket.set_broadcast(true).unwrap(); + // socket.connect(("10.144.144.255", 22111)).await.unwrap(); + let call: Vec = vec![1; 1024]; + println!("Sending call, {} bytes", call.len()); + if let Err(e) = socket.send_to(&call, "10.144.144.255:22111").await { + panic!("Error sending call: {:?}", e) + } + + tokio::time::sleep(tokio::time::Duration::from_secs(2)).await; + assert_eq!(counter.load(std::sync::atomic::Ordering::Relaxed), 2); + + drop_insts(_insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn foreign_network_forward_nic_data() { + prepare_linux_namespaces(); + let process_runtime = CoreProcessRuntime::new(); + + let center_node_config = get_inst_config("inst1", Some("net_a"), "10.144.144.1", "fd00::1/64"); + center_node_config + .set_network_identity(NetworkIdentity::new("center".to_string(), "".to_string())); + let mut center_inst = + Instance::new_with_process_runtime(center_node_config, process_runtime.clone()); + + let mut inst1 = Instance::new_with_process_runtime( + get_inst_config("inst1", Some("net_b"), "10.144.145.1", "fd00:1::1/64"), + process_runtime.clone(), + ); + let mut inst2 = Instance::new_with_process_runtime( + get_inst_config("inst2", Some("net_c"), "10.144.145.2", "fd00:1::2/64"), + process_runtime, + ); + + center_inst.run().await.unwrap(); + inst1.run().await.unwrap(); + inst2.run().await.unwrap(); + + assert_ne!(inst1.ring_listener_url(), center_inst.ring_listener_url()); + assert_ne!(inst2.ring_listener_url(), center_inst.ring_listener_url()); + + inst1.add_connector_url(center_inst.ring_listener_url()); + + inst2.add_connector_url(center_inst.ring_listener_url()); + + wait_for_condition( + || async { + inst1.get_core_instance().route_snapshots().await.len() == 2 + && inst2.get_core_instance().route_snapshots().await.len() == 2 + }, + Duration::from_secs(5), + ) + .await; + + wait_for_condition( + || async { ping_test("net_b", "10.144.145.2", None).await }, + Duration::from_secs(5), + ) + .await; + + drop_insts(vec![center_inst, inst1, inst2]).await; +} + +use std::{net::SocketAddr, str::FromStr}; + +use defguard_wireguard_rs::{ + InterfaceConfiguration, Kernel, WGApi, WireguardInterfaceApi, key::Key, net::IpAddrMask, + peer::Peer, +}; + +pub(super) fn wireguard_ifname(base: &str) -> String { + if cfg!(target_os = "linux") || cfg!(target_os = "freebsd") { + base.to_owned() + } else { + "utun3".into() + } +} + +#[allow(clippy::too_many_arguments)] +pub(super) fn run_wireguard_client( + ifname: &str, + endpoint: SocketAddr, + peer_public_key: Key, + client_private_key: Key, + allowed_ips: Vec, + client_ip: String, +) -> Result<(), Box> { + // Create new API object for interface + let mut wgapi = WGApi::::new(ifname.to_owned())?; + + // create interface + wgapi.create_interface()?; + + // Peer secret key + let mut peer = Peer::new(peer_public_key.clone()); + + tracing::info!("endpoint"); + // Peer endpoint and interval + peer.endpoint = Some(endpoint); + peer.persistent_keepalive_interval = Some(1); + for ip in allowed_ips { + peer.allowed_ips.push(IpAddrMask::from_str(ip.as_str())?); + } + + // interface configuration + let interface_config = InterfaceConfiguration { + name: ifname.to_owned(), + prvkey: client_private_key.to_string(), + addresses: vec![IpAddrMask::from_str(client_ip.as_str())?], + port: 12345, + peers: vec![peer], + mtu: None, + fwmark: None, + }; + + #[cfg(not(windows))] + wgapi.configure_interface(&interface_config)?; + #[cfg(windows)] + wgapi.configure_interface(&interface_config, &[])?; + // These split-tunnel clients reach the endpoint through an existing route. + // defguard 0.12 also rewrites endpoint routes (or blackholes them without a + // default gateway), so pass only the allowed IPs to its routing helper. + // The actual WireGuard peer above retains its endpoint. + let mut routing_peers = interface_config.peers.clone(); + for peer in &mut routing_peers { + peer.endpoint = None; + } + wgapi.configure_peer_routing(&routing_peers)?; + Ok(()) +} + +#[cfg(feature = "wireguard")] +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn wireguard_vpn_portal(#[values(true, false)] test_v6: bool) { + let insts = init_three_node_ex( + "tcp", + |config| { + let identity = config.get_network_identity(); + config.set_network_identity(NetworkIdentity::new( + identity.network_name, + "wireguard-portal-test".to_owned(), + )); + if config.get_inst_name() == "inst1" { + config + .add_proxy_cidr("198.51.100.0/24".parse().unwrap(), None) + .unwrap(); + } + if config.get_inst_name() == "inst3" { + config.set_vpn_portal_config(VpnPortalConfig { + enabled: None, + wireguard_listen: "0.0.0.0:22121".parse().unwrap(), + wireguard_private_key: Some(BASE64_STANDARD.encode([42u8; 32])), + clients: vec![VpnPortalClientConfig { + name: "test-client".to_owned(), + virtual_ip: "10.144.144.4/24".parse().unwrap(), + groups: Vec::new(), + }], + }); + } + config + }, + false, + ) + .await; + + if test_v6 { + ping6_test("net_d", "fd12::3", None).await; + } else { + ping_test("net_d", "10.1.2.3", None).await; + } + + let dst_socket_addr = if test_v6 { + "[fd12::3]:22121".parse().unwrap() + } else { + "10.1.2.3:22121".parse().unwrap() + }; + + let net_ns = NetNS::new(Some("net_d".into())); + let _g = net_ns.guard(); + let portal_config = insts[2] + .get_global_ctx() + .config + .get_vpn_portal_config() + .unwrap(); + let portal_info = insts[2].get_core_instance().vpn_portal_info().await; + assert_eq!(portal_info.clients.len(), 1); + let client_info = portal_info + .clients + .iter() + .find(|client| client.name == "test-client") + .expect("configured client must be reported"); + assert!( + client_info.client_config.contains("198.51.100.0/24"), + "client config must include remote proxy CIDRs" + ); + assert!( + client_info + .client_config + .contains("Address = 10.144.144.4/32"), + "client config must assign the attached peer virtual IP" + ); + let (server_public, client_private) = + test_wireguard_keys(&portal_config, "test-client").unwrap(); + run_wireguard_client( + &wireguard_ifname("wg0"), + dst_socket_addr, + Key::try_from(server_public.as_slice()).unwrap(), + Key::try_from(client_private.as_slice()).unwrap(), + vec!["10.144.144.0/24".to_string()], + "10.144.144.4".to_owned(), + ) + .unwrap(); + + // ping other node in network + wait_for_condition( + || async { ping_test("net_d", "10.144.144.1", None).await }, + Duration::from_secs(5), + ) + .await; + wait_for_condition( + || async { ping_test("net_d", "10.144.144.2", None).await }, + Duration::from_secs(5), + ) + .await; + + // ping portal node + wait_for_condition( + || async { ping_test("net_d", "10.144.144.3", None).await }, + Duration::from_secs(5), + ) + .await; + + drop_insts(insts).await; +} + +#[cfg(feature = "wireguard")] +#[tokio::test] +#[serial_test::serial] +pub async fn wireguard_vpn_portal_multi_client() { + use rand::Rng as _; + use tokio::{ + io::{AsyncReadExt, AsyncWriteExt}, + net::{TcpListener, TcpStream}, + }; + + let insts = init_three_node_ex( + "tcp", + |config| { + let identity = config.get_network_identity(); + config.set_network_identity(NetworkIdentity::new( + identity.network_name, + "wireguard-portal-multi-client-test".to_owned(), + )); + if config.get_inst_name() == "inst3" { + config.set_vpn_portal_config(VpnPortalConfig { + enabled: None, + wireguard_listen: "0.0.0.0:22121".parse().unwrap(), + wireguard_private_key: Some(BASE64_STANDARD.encode([42u8; 32])), + clients: vec![ + VpnPortalClientConfig { + name: "client-a".to_owned(), + virtual_ip: "10.144.144.4/24".parse().unwrap(), + groups: Vec::new(), + }, + VpnPortalClientConfig { + name: "client-b".to_owned(), + virtual_ip: "10.144.144.5/24".parse().unwrap(), + groups: Vec::new(), + }, + ], + }); + } + config + }, + false, + ) + .await; + + let portal_config = insts[2] + .get_global_ctx() + .config + .get_vpn_portal_config() + .unwrap(); + + for (ns, client_name, virtual_ip) in [ + ("net_d", "client-a", "10.144.144.4"), + ("net_f", "client-b", "10.144.144.5"), + ] { + let net_ns = NetNS::new(Some(ns.into())); + let _g = net_ns.guard(); + let (server_public, client_private) = + test_wireguard_keys(&portal_config, client_name).unwrap(); + run_wireguard_client( + &wireguard_ifname("wg0"), + "10.1.2.3:22121".parse().unwrap(), + Key::try_from(server_public.as_slice()).unwrap(), + Key::try_from(client_private.as_slice()).unwrap(), + vec!["10.144.144.0/24".to_string()], + virtual_ip.to_owned(), + ) + .unwrap(); + } + + // 两个客户端各自 ping mesh 内节点 + for ns in ["net_d", "net_f"] { + wait_for_condition( + || async { ping_test(ns, "10.144.144.1", None).await }, + Duration::from_secs(10), + ) + .await; + wait_for_condition( + || async { ping_test(ns, "10.144.144.2", None).await }, + Duration::from_secs(10), + ) + .await; + } + + // 跨客户端互 ping 对方的虚拟 IP,验证 WireGuard 地址与 attached + // peer 地址相同且双向数据包无需地址改写。 + wait_for_condition( + || async { ping_test("net_d", "10.144.144.5", None).await }, + Duration::from_secs(10), + ) + .await; + wait_for_condition( + || async { ping_test("net_f", "10.144.144.4", None).await }, + Duration::from_secs(10), + ) + .await; + + // TCP 数据面:node1 侧看到的连接源地址必须是 client-a 的虚拟 IP, + // 并做一段随机数据回环,验证传输层校验和保持不变。 + let mut buf = vec![0u8; 1024]; + rand::thread_rng().fill(&mut buf[..]); + let expected = buf.clone(); + let echo_task = tokio::spawn(async move { + let net_ns = NetNS::new(Some("net_a".into())); + let _g = net_ns.guard(); + let socket = TcpListener::bind("0.0.0.0:22222").await.unwrap(); + let (mut st, addr) = socket.accept().await.unwrap(); + assert_eq!(addr.ip().to_string(), "10.144.144.4".to_string()); + let mut rbuf = vec![0u8; 1024]; + st.read_exact(&mut rbuf).await.unwrap(); + assert_eq!(rbuf, expected); + st.write_all(&rbuf).await.unwrap(); + }); + { + let net_ns = NetNS::new(Some("net_d".into())); + let _g = net_ns.guard(); + let mut stream = TcpStream::connect("10.144.144.1:22222").await.unwrap(); + stream.write_all(&buf).await.unwrap(); + let mut rbuf = vec![0u8; 1024]; + stream.read_exact(&mut rbuf).await.unwrap(); + assert_eq!(rbuf, buf); + } + echo_task.await.unwrap(); + + // portal 状态:两个客户端均在线,隧道地址等于各自的 attached peer + // 虚拟 IP,peer_id 互不相同。 + let portal_info = insts[2].get_core_instance().vpn_portal_info().await; + assert_eq!(portal_info.clients.len(), 2); + let client_a = portal_info + .clients + .iter() + .find(|client| client.name == "client-a") + .expect("client-a must be reported"); + let client_b = portal_info + .clients + .iter() + .find(|client| client.name == "client-b") + .expect("client-b must be reported"); + for client in [client_a, client_b] { + assert_eq!(client.state, PortalClientState::Online); + assert!(client.peer_id.is_some()); + } + assert_ne!(client_a.peer_id, client_b.peer_id); + assert_eq!(client_a.tunnel_ip, Some("10.144.144.4".parse().unwrap())); + assert_eq!(client_b.tunnel_ip, Some("10.144.144.5".parse().unwrap())); + + drop_insts(insts).await; +} + +#[cfg(feature = "wireguard")] +#[tokio::test] +#[serial_test::serial] +pub async fn wireguard_vpn_portal_client_roaming() { + let insts = init_three_node_ex( + "tcp", + |config| { + let identity = config.get_network_identity(); + config.set_network_identity(NetworkIdentity::new( + identity.network_name, + "wireguard-portal-roaming-test".to_owned(), + )); + if config.get_inst_name() == "inst3" { + config.set_vpn_portal_config(VpnPortalConfig { + enabled: None, + wireguard_listen: "0.0.0.0:22121".parse().unwrap(), + wireguard_private_key: Some(BASE64_STANDARD.encode([42u8; 32])), + clients: vec![VpnPortalClientConfig { + name: "roaming-client".to_owned(), + virtual_ip: "10.144.144.4/24".parse().unwrap(), + groups: Vec::new(), + }], + }); + } + config + }, + false, + ) + .await; + + let portal_config = insts[2] + .get_global_ctx() + .config + .get_vpn_portal_config() + .unwrap(); + { + let net_ns = NetNS::new(Some("net_d".into())); + let _g = net_ns.guard(); + let (server_public, client_private) = + test_wireguard_keys(&portal_config, "roaming-client").unwrap(); + run_wireguard_client( + &wireguard_ifname("wg0"), + "10.1.2.3:22121".parse().unwrap(), + Key::try_from(server_public.as_slice()).unwrap(), + Key::try_from(client_private.as_slice()).unwrap(), + vec!["10.144.144.0/24".to_string()], + "10.144.144.4".to_owned(), + ) + .unwrap(); + } + + // 客户端在 net_d(源地址 10.1.2.4)上线 + wait_for_condition( + || async { ping_test("net_d", "10.144.144.1", None).await }, + Duration::from_secs(10), + ) + .await; + let peer_id = { + let info = insts[2].get_core_instance().vpn_portal_info().await; + let client = info + .clients + .iter() + .find(|client| client.name == "roaming-client") + .expect("roaming client must be reported"); + assert_eq!(client.state, PortalClientState::Online); + assert!( + client + .endpoint + .as_deref() + .is_some_and(|endpoint| endpoint.starts_with("10.1.2.4:")), + "unexpected endpoint before roaming: {:?}", + client.endpoint + ); + client.peer_id + }; + assert!(peer_id.is_some()); + + // 模拟客户端换网络:net_d 把地址从 10.1.2.4 换成 10.1.2.9。内核 + // WireGuard 为 peer endpoint 缓存的源地址随旧地址一起失效,客户端 + // 不重建 peer、不重新握手,直接用原 session 从新源继续发数据包, + // portal 应在数据路径上更新 endpoint + for args in [ + vec![ + "netns".to_owned(), + "exec".to_owned(), + "net_d".to_owned(), + "ip".to_owned(), + "addr".to_owned(), + "del".to_owned(), + "10.1.2.4/24".to_owned(), + "dev".to_owned(), + get_guest_veth_name("net_d").to_owned(), + ], + vec![ + "netns".to_owned(), + "exec".to_owned(), + "net_d".to_owned(), + "ip".to_owned(), + "addr".to_owned(), + "add".to_owned(), + "10.1.2.9/24".to_owned(), + "dev".to_owned(), + get_guest_veth_name("net_d").to_owned(), + ], + ] { + let ret = std::process::Command::new("ip") + .args(&args) + .output() + .unwrap(); + assert!( + ret.status.success(), + "ip {args:?} failed: {}", + String::from_utf8_lossy(&ret.stderr) + ); + } + + // 驱动流量(ping 经内核 WireGuard 加密后从新源发出),portal 应在 + // 同一个 peer 上更新 endpoint:peer_id 不变说明是同代漫游,客户端没有掉线重连 + wait_for_condition( + || async { + ping_test("net_d", "10.144.144.1", None).await; + let info = insts[2].get_core_instance().vpn_portal_info().await; + info.clients.iter().any(|client| { + client.name == "roaming-client" + && client.state == PortalClientState::Online + && client.peer_id == peer_id + && client + .endpoint + .as_deref() + .is_some_and(|endpoint| endpoint.starts_with("10.1.2.9:")) + }) + }, + Duration::from_secs(20), + ) + .await; + + // 漫游后连通性保持 + wait_for_condition( + || async { ping_test("net_d", "10.144.144.1", None).await }, + Duration::from_secs(10), + ) + .await; + wait_for_condition( + || async { ping_test("net_d", "10.144.144.3", None).await }, + Duration::from_secs(10), + ) + .await; + + drop_insts(insts).await; +} + +#[cfg(feature = "wireguard")] +#[tokio::test] +#[serial_test::serial] +pub async fn wireguard_vpn_portal_dynamic_clients() { + let insts = init_three_node_ex( + "tcp", + |config| { + let identity = config.get_network_identity(); + config.set_network_identity(NetworkIdentity::new( + identity.network_name, + "wireguard-portal-dynamic-clients-test".to_owned(), + )); + if config.get_inst_name() == "inst3" { + config.set_vpn_portal_config(VpnPortalConfig { + enabled: None, + wireguard_listen: "0.0.0.0:22121".parse().unwrap(), + wireguard_private_key: Some(BASE64_STANDARD.encode([42u8; 32])), + clients: vec![VpnPortalClientConfig { + name: "client-a".to_owned(), + virtual_ip: "10.144.144.4/24".parse().unwrap(), + groups: Vec::new(), + }], + }); + } + config + }, + false, + ) + .await; + + let core = insts[2].get_core_instance(); + let portal_config = insts[2] + .get_global_ctx() + .config + .get_vpn_portal_config() + .unwrap(); + + // 初始客户端上线 + { + let net_ns = NetNS::new(Some("net_d".into())); + let _g = net_ns.guard(); + let (server_public, client_private) = + test_wireguard_keys(&portal_config, "client-a").unwrap(); + run_wireguard_client( + &wireguard_ifname("wg0"), + "10.1.2.3:22121".parse().unwrap(), + Key::try_from(server_public.as_slice()).unwrap(), + Key::try_from(client_private.as_slice()).unwrap(), + vec!["10.144.144.0/24".to_string()], + "10.144.144.4".to_owned(), + ) + .unwrap(); + } + wait_for_condition( + || async { ping_test("net_d", "10.144.144.1", None).await }, + Duration::from_secs(10), + ) + .await; + + // 不重启实例,通过配置补丁动态添加第二个客户端 + easytier_core::management::apply_config_patch( + &core, + InstanceConfigPatch { + vpn_portal_clients: vec![VpnPortalClientPatch { + action: ConfigPatchAction::Add as i32, + client: Some(VpnPortalClientConfigPb { + name: "client-b".to_owned(), + virtual_ip: "10.144.144.5/24".to_owned(), + groups: Vec::new(), + }), + }], + ..Default::default() + }, + None, + ) + .await + .unwrap(); + assert_eq!( + insts[2] + .get_global_ctx() + .config + .get_vpn_portal_config() + .unwrap() + .clients + .len(), + 2, + "shared TOML model must reflect the runtime update" + ); + + // 拒绝的补丁不能污染共享 TOML 模型:重复添加 client-b 必须整体失败 + let error = easytier_core::management::apply_config_patch( + &core, + InstanceConfigPatch { + vpn_portal_clients: vec![VpnPortalClientPatch { + action: ConfigPatchAction::Add as i32, + client: Some(VpnPortalClientConfigPb { + name: "client-b".to_owned(), + virtual_ip: "10.144.144.9/24".to_owned(), + groups: Vec::new(), + }), + }], + ..Default::default() + }, + None, + ) + .await + .unwrap_err(); + assert!( + error + .to_string() + .contains("duplicate VPN portal client name"), + "unexpected rejection reason: {error:#}" + ); + assert_eq!( + insts[2] + .get_global_ctx() + .config + .get_vpn_portal_config() + .unwrap() + .clients + .len(), + 2, + "rejected patch must leave the shared TOML model unchanged" + ); + + // 新客户端立即可以握手上线,原客户端不受影响 + { + let net_ns = NetNS::new(Some("net_f".into())); + let _g = net_ns.guard(); + let (server_public, client_private) = + test_wireguard_keys(&portal_config, "client-b").unwrap(); + run_wireguard_client( + &wireguard_ifname("wg0"), + "10.1.2.3:22121".parse().unwrap(), + Key::try_from(server_public.as_slice()).unwrap(), + Key::try_from(client_private.as_slice()).unwrap(), + vec!["10.144.144.0/24".to_string()], + "10.144.144.5".to_owned(), + ) + .unwrap(); + } + wait_for_condition( + || async { ping_test("net_f", "10.144.144.1", None).await }, + Duration::from_secs(10), + ) + .await; + wait_for_condition( + || async { ping_test("net_d", "10.144.144.1", None).await }, + Duration::from_secs(10), + ) + .await; + + // 动态移除 client-a:其会话被拆除,client-b 保持在线 + easytier_core::management::apply_config_patch( + &core, + InstanceConfigPatch { + vpn_portal_clients: vec![VpnPortalClientPatch { + action: ConfigPatchAction::Remove as i32, + client: Some(VpnPortalClientConfigPb { + name: "client-a".to_owned(), + virtual_ip: String::new(), + groups: Vec::new(), + }), + }], + ..Default::default() + }, + None, + ) + .await + .unwrap(); + + wait_for_condition( + || async { !ping_test("net_d", "10.144.144.1", None).await }, + Duration::from_secs(20), + ) + .await; + wait_for_condition( + || async { ping_test("net_f", "10.144.144.1", None).await }, + Duration::from_secs(10), + ) + .await; + + let info = core.vpn_portal_info().await; + assert_eq!(info.clients.len(), 1); + assert_eq!(info.clients[0].name, "client-b"); + assert_eq!(info.clients[0].state, PortalClientState::Online); + assert_eq!( + info.clients[0].tunnel_ip, + Some("10.144.144.5".parse().unwrap()) + ); + + // Release the held CoreInstance Arc so drop_insts can observe a clean + // drop instead of swallowing its debug assertion. + drop(core); + drop_insts(insts).await; +} + +#[cfg(feature = "wireguard")] +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn socks5_vpn_portal( + #[values("10.144.144.1", "10.144.144.3", "10.1.2.4")] dst_addr: &str, +) { + use rand::Rng as _; + use tokio::{ + io::{AsyncReadExt, AsyncWriteExt}, + net::{TcpListener, TcpStream}, + }; + use tokio_socks::tcp::socks5::Socks5Stream; + + let _insts = init_three_node_ex( + "tcp", + |cfg| { + if cfg.get_inst_name() == "inst3" { + // 添加子网代理配置 + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + } + cfg + }, + false, + ) + .await; + + let mut buf = vec![0u8; 1024]; + rand::thread_rng().fill(&mut buf[..]); + + let buf_clone = buf.clone(); + let dst_addr_clone = dst_addr.to_owned(); + let task = tokio::spawn(async move { + let net_ns = if dst_addr_clone == "10.144.144.1" { + NetNS::new(Some("net_a".into())) + } else if dst_addr_clone == "10.144.144.3" { + NetNS::new(Some("net_c".into())) + } else { + NetNS::new(Some("net_d".into())) + }; + + let _g = net_ns.guard(); + + let socket = TcpListener::bind("0.0.0.0:22222").await.unwrap(); + let (mut st, addr) = socket.accept().await.unwrap(); + + if dst_addr_clone == "10.144.144.1" { + assert_eq!(addr.ip().to_string(), "127.0.0.1".to_string()); + } else if dst_addr_clone == "10.144.144.3" { + assert_eq!(addr.ip().to_string(), "10.144.144.1".to_string()); + } else { + assert_eq!(addr.ip().to_string(), "10.1.2.3".to_string()); + } + + let rbuf = &mut [0u8; 1024]; + st.read_exact(rbuf).await.unwrap(); + assert_eq!(rbuf, buf_clone.as_slice()); + }); + + let net_ns = if dst_addr == "10.1.2.4" { + NetNS::new(Some("net_c".into())) + } else { + NetNS::new(Some("net_a".into())) + }; + let _g = net_ns.guard(); + + println!("connect to socks5 portal"); + let stream = TcpStream::connect("127.0.0.1:12345").await.unwrap(); + println!("connect to socks5 portal done"); + + stream.set_nodelay(true).unwrap(); + let mut conn = Socks5Stream::connect_with_socket(stream, format!("{}:22222", dst_addr)) + .await + .unwrap(); + + conn.write_all(&buf).await.unwrap(); + drop(conn); + + tokio::join!(task).0.unwrap(); + + drop_insts(_insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn foreign_network_functional_cluster() { + prepare_linux_namespaces(); + let process_runtime = CoreProcessRuntime::new(); + + let center_node_config1 = get_inst_config("inst1", Some("net_a"), "10.144.144.1", "fd00::1/64"); + center_node_config1 + .set_network_identity(NetworkIdentity::new("center".to_string(), "".to_string())); + let mut center_inst1 = + Instance::new_with_process_runtime(center_node_config1, process_runtime.clone()); + + let center_node_config2 = get_inst_config("inst2", Some("net_b"), "10.144.144.2", "fd00::2/64"); + center_node_config2 + .set_network_identity(NetworkIdentity::new("center".to_string(), "".to_string())); + let mut center_inst2 = + Instance::new_with_process_runtime(center_node_config2, process_runtime.clone()); + + let inst1_config = get_inst_config("inst1", Some("net_c"), "10.144.145.1", "fd00:2::1/64"); + inst1_config.set_listeners(vec![]); + let mut inst1 = Instance::new_with_process_runtime(inst1_config, process_runtime.clone()); + + let mut inst2 = Instance::new_with_process_runtime( + get_inst_config("inst2", Some("net_d"), "10.144.145.2", "fd00:2::2/64"), + process_runtime, + ); + + center_inst1.run().await.unwrap(); + center_inst2.run().await.unwrap(); + inst1.run().await.unwrap(); + inst2.run().await.unwrap(); + + for instance in [¢er_inst1, ¢er_inst2, &inst1, &inst2] { + set_foreign_network_refresh_interval(instance, 1).await; + } + + center_inst1.add_connector_url(center_inst2.ring_listener_url()); + + inst1.add_connector_url(center_inst1.ring_listener_url()); + + inst2.add_connector_url(center_inst2.ring_listener_url()); + + println!( + "inst1 peer map: {:?}", + inst1.get_core_instance().route_snapshots().await + ); + + wait_for_condition( + || async { ping_test("net_c", "10.144.145.2", None).await }, + Duration::from_secs(5), + ) + .await; + + // connect to two centers, ping should work + inst1.add_connector_url(center_inst2.ring_listener_url()); + tokio::time::sleep(tokio::time::Duration::from_secs(5)).await; + wait_for_condition( + || async { ping_test("net_c", "10.144.145.2", None).await }, + Duration::from_secs(5), + ) + .await; + + drop_insts(vec![center_inst1, center_inst2, inst1, inst2]).await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn manual_reconnector(#[values(true, false)] is_foreign: bool) { + prepare_linux_namespaces(); + let process_runtime = CoreProcessRuntime::new(); + + let center_node_config = get_inst_config("inst1", Some("net_a"), "10.144.144.1", "fd00::1/64"); + if is_foreign { + center_node_config + .set_network_identity(NetworkIdentity::new("center".to_string(), "".to_string())); + } + let mut center_inst = + Instance::new_with_process_runtime(center_node_config, process_runtime.clone()); + + let inst1_config = get_inst_config("inst1", Some("net_b"), "10.144.145.1", "fd00:1::1/64"); + inst1_config.set_listeners(vec![]); + let mut inst1 = Instance::new_with_process_runtime(inst1_config, process_runtime.clone()); + + let mut inst2 = Instance::new_with_process_runtime( + get_inst_config("inst2", Some("net_c"), "10.144.145.2", "fd00:1::2/64"), + process_runtime, + ); + + center_inst.run().await.unwrap(); + inst1.run().await.unwrap(); + inst2.run().await.unwrap(); + + assert_ne!(inst1.ring_listener_url(), center_inst.ring_listener_url()); + assert_ne!(inst2.ring_listener_url(), center_inst.ring_listener_url()); + + inst1.add_connector_url(center_inst.ring_listener_url()); + + inst2.add_connector_url(center_inst.ring_listener_url()); + + tokio::time::sleep(tokio::time::Duration::from_secs(5)).await; + + let center_inst_peer_id = if !is_foreign { + center_inst.peer_id() + } else { + let network_name = inst1.get_global_ctx().get_network_identity().network_name; + center_inst + .get_core_instance() + .foreign_network_snapshots(false) + .await + .get(&network_name) + .map(|network| network.my_peer_id_for_this_network) + .unwrap() + }; + + let conns_len = inst1 + .get_core_instance() + .peer_snapshots() + .await + .into_iter() + .find(|peer| peer.peer_id == center_inst_peer_id) + .map_or(0, |peer| peer.conns.len()); + + assert!(conns_len > 0); + + wait_for_condition( + || async { ping_test("net_b", "10.144.145.2", None).await }, + Duration::from_secs(5), + ) + .await; + + drop_insts(vec![center_inst, inst1, inst2]).await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn port_forward_test( + #[values(true, false)] no_tun: bool, + #[values(64, 1900)] buf_size: u64, + #[values(true, false)] enable_kcp: bool, + #[values(true, false)] dst_disable_kcp_input: bool, + #[values(true, false)] disable_relay_kcp: bool, +) { + prepare_linux_namespaces(); + + let _insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst1" { + cfg.set_port_forwards(vec![ + // test port forward to other virtual node + PortForwardConfig { + bind_addr: "0.0.0.0:23456".parse().unwrap(), + dst_addr: "10.144.144.3:23456".parse().unwrap(), + proto: "tcp".to_string(), + }, + // test port forward to subnet proxy + PortForwardConfig { + bind_addr: "0.0.0.0:23457".parse().unwrap(), + dst_addr: "10.1.2.4:23457".parse().unwrap(), + proto: "tcp".to_string(), + }, + // test udp port forward to other virtual node + PortForwardConfig { + bind_addr: "0.0.0.0:23458".parse().unwrap(), + dst_addr: "10.144.144.3:23458".parse().unwrap(), + proto: "udp".to_string(), + }, + // test udp port forward to subnet proxy + PortForwardConfig { + bind_addr: "0.0.0.0:23459".parse().unwrap(), + dst_addr: "10.1.2.4:23459".parse().unwrap(), + proto: "udp".to_string(), + }, + ]); + + let mut flags = cfg.get_flags(); + flags.no_tun = no_tun; + flags.enable_kcp_proxy = enable_kcp; + cfg.set_flags(flags); + } else if cfg.get_inst_name() == "inst3" { + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + let mut flags = cfg.get_flags(); + flags.disable_kcp_input = dst_disable_kcp_input; + cfg.set_flags(flags); + } else if cfg.get_inst_name() == "inst2" { + let mut flags = cfg.get_flags(); + flags.disable_relay_kcp = disable_relay_kcp; + cfg.set_flags(flags); + } + + cfg + }, + false, + ) + .await; + + let tcp_listener = core_tcp_listener("tcp://0.0.0.0:23456".parse().unwrap()); + let tcp_connector = core_tcp_dialer("tcp://127.0.0.1:23456".parse().unwrap()); + + let mut buf = vec![0; buf_size as usize]; + rand::thread_rng().fill(&mut buf[..]); + + _tunnel_pingpong_netns_with_timeout( + tcp_listener, + tcp_connector, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf, + Duration::from_secs(1), + ) + .await + .unwrap(); + + let tcp_listener = core_tcp_listener("tcp://0.0.0.0:23457".parse().unwrap()); + let tcp_connector = core_tcp_dialer("tcp://127.0.0.1:23457".parse().unwrap()); + + let mut buf = vec![0; buf_size as usize]; + rand::thread_rng().fill(&mut buf[..]); + + _tunnel_pingpong_netns_with_timeout( + tcp_listener, + tcp_connector, + NetNS::new(Some("net_d".into())), + NetNS::new(Some("net_a".into())), + buf, + Duration::from_secs(1), + ) + .await + .unwrap(); + + let udp_listener = core_udp_listener("udp://0.0.0.0:23458".parse().unwrap()); + let udp_connector = core_udp_dialer("udp://127.0.0.1:23458".parse().unwrap()); + + let mut buf = vec![0; buf_size as usize]; + rand::thread_rng().fill(&mut buf[..]); + + _tunnel_pingpong_netns_with_timeout( + udp_listener, + udp_connector, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf, + Duration::from_secs(1), + ) + .await + .unwrap(); + + let udp_listener = core_udp_listener("udp://0.0.0.0:23459".parse().unwrap()); + let udp_connector = core_udp_dialer("udp://127.0.0.1:23459".parse().unwrap()); + + let mut buf = vec![0; buf_size as usize]; + rand::thread_rng().fill(&mut buf[..]); + + _tunnel_pingpong_netns_with_timeout( + udp_listener, + udp_connector, + NetNS::new(Some("net_d".into())), + NetNS::new(Some("net_a".into())), + buf, + Duration::from_secs(1), + ) + .await + .unwrap(); + + drop_insts(_insts).await; +} + +#[rstest::rstest] +#[case(false, false)] +#[case(true, false)] +#[case(true, true)] +#[serial_test::serial] +#[tokio::test] +pub async fn port_forward_with_inbound_default_drop_acl_test( + #[case] dhcp: bool, + #[case] enable_quic_proxy: bool, +) { + use crate::proto::acl::*; + + let acl = Acl { + acl_v1: Some(AclV1 { + chains: vec![Chain { + name: "drop_unsolicited_inbound".to_string(), + chain_type: ChainType::Inbound as i32, + enabled: true, + default_action: Action::Drop as i32, + ..Default::default() + }], + ..Default::default() + }), + }; + + let insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst1" { + if dhcp { + cfg.set_ipv4(None); + cfg.set_dhcp(true); + } + cfg.set_acl(Some(acl.clone())); + cfg.set_port_forwards(vec![ + PortForwardConfig { + bind_addr: "0.0.0.0:23456".parse().unwrap(), + dst_addr: "10.144.144.3:23456".parse().unwrap(), + proto: "tcp".to_string(), + }, + PortForwardConfig { + bind_addr: "0.0.0.0:23457".parse().unwrap(), + dst_addr: "10.1.2.4:23457".parse().unwrap(), + proto: "tcp".to_string(), + }, + ]); + + let mut flags = cfg.get_flags(); + flags.no_tun = true; + flags.enable_kcp_proxy = false; + flags.enable_quic_proxy = enable_quic_proxy; + cfg.set_flags(flags); + } else if cfg.get_inst_name() == "inst3" { + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + + let mut flags = cfg.get_flags(); + flags.disable_kcp_input = true; + flags.disable_quic_input = !enable_quic_proxy; + cfg.set_flags(flags); + } else if cfg.get_inst_name() == "inst2" { + let mut flags = cfg.get_flags(); + flags.disable_relay_kcp = true; + cfg.set_flags(flags); + } + + cfg + }, + false, + ) + .await; + + if dhcp { + wait_for_condition( + || async { insts[0].get_global_ctx().get_ipv4().is_some() }, + Duration::from_secs(5), + ) + .await; + } + + for (bind_port, server_ns) in [(23456, "net_c"), (23457, "net_d")] { + let tcp_listener = core_tcp_listener(format!("tcp://0.0.0.0:{bind_port}").parse().unwrap()); + let tcp_connector = + core_tcp_dialer(format!("tcp://127.0.0.1:{bind_port}").parse().unwrap()); + + let mut buf = vec![0; 64]; + rand::thread_rng().fill(&mut buf[..]); + + let result = _tunnel_pingpong_netns_with_timeout( + tcp_listener, + tcp_connector, + NetNS::new(Some(server_ns.into())), + NetNS::new(Some("net_a".into())), + buf, + Duration::from_secs(1), + ) + .await; + + let stats = insts[0].get_core_instance().acl_stats(); + println!( + "port forward source bind_port={} dhcp={} enable_quic_proxy={} ACL stats: {}", + bind_port, dhcp, enable_quic_proxy, stats + ); + + assert!( + result.is_ok(), + "port-forward TCP should complete through outbound ACL state, bind_port={}, dhcp={}, enable_quic_proxy={}; stats: {}", + bind_port, + dhcp, + enable_quic_proxy, + stats, + ); + } + + drop_insts(insts).await; +} + +#[rstest::rstest] +#[serial_test::serial] +#[tokio::test] +pub async fn relay_bps_limit_test(#[values(100, 200, 400, 800)] bps_limit: u64) { + let insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst2" { + cfg.set_network_identity(NetworkIdentity::new( + "public".to_string(), + "public".to_string(), + )); + let mut f = cfg.get_flags(); + f.foreign_relay_bps_limit = bps_limit * 1024; + cfg.set_flags(f); + } + cfg + }, + true, + ) + .await; + + // connect to virtual ip (no tun mode) + let tcp_listener = core_tcp_listener("tcp://0.0.0.0:22223".parse().unwrap()); + let tcp_connector = core_tcp_dialer("tcp://10.144.144.3:22223".parse().unwrap()); + + let bps = _tunnel_bench_netns( + tcp_listener, + tcp_connector, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + ) + .await; + + println!("bps: {}", bps); + + let bps = bps as u64 / 1024; + assert_limited_payload_bps(bps, bps_limit); + + drop_insts(insts).await; +} + +#[rstest::rstest] +#[serial_test::serial] +#[tokio::test] +pub async fn instance_recv_bps_limit_test(#[values(100, 800)] bps_limit: u64) { + let insts = init_three_node_ex( + "tcp", + |cfg| { + if cfg.get_inst_name() == "inst2" { + let mut f = cfg.get_flags(); + f.instance_recv_bps_limit = bps_limit * 1024; + cfg.set_flags(f); + } + cfg + }, + false, + ) + .await; + + let tcp_listener = core_tcp_listener("tcp://0.0.0.0:22223".parse().unwrap()); + let tcp_connector = core_tcp_dialer("tcp://10.144.144.3:22223".parse().unwrap()); + + let bps = _tunnel_bench_netns( + tcp_listener, + tcp_connector, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + ) + .await; + + println!("bps: {}", bps); + + let bps = bps as u64 / 1024; + assert_limited_payload_bps(bps, bps_limit); + + drop_insts(insts).await; +} + +fn assert_limited_payload_bps(bps: u64, bps_limit: u64) { + // The benchmark measures TCP application payload while the limiter counts + // EasyTier data payload, including the inner IP and transport headers. + let min_bps = bps_limit.saturating_sub((bps_limit / 10).max(50)); + let max_bps = bps_limit + 50; + assert!( + bps >= min_bps && bps <= max_bps, + "bps: {}, expected: {}..={}", + bps, + min_bps, + max_bps + ); +} + +async fn assert_peer_admission_blocked(inst: &Instance, url: url::Url) { + let ip = url + .host_str() + .expect("test URL should have a host") + .parse() + .expect("test URL should have a literal IP"); + let target = std::net::SocketAddr::new(ip, url.port().expect("test URL should have a port")); + let host = crate::instance::host::native_instance_host(inst.get_global_ctx()); + let protocol = crate::tunnel::protocol::runtime_client_protocol_upgrader(inst.get_global_ctx()); + let core = inst.get_core_instance(); + let connect = async { + let connected = match url.scheme() { + "tcp" => easytier_core::connectivity::transport::ConnectedTransport::Tcp( + easytier_core::socket::tcp::VirtualTcpSocketFactory::connect_tcp( + host.as_ref(), + easytier_core::socket::tcp::TcpConnectOptions::direct_connect(target), + ) + .await?, + ), + "udp" => easytier_core::connectivity::transport::ConnectedTransport::Udp( + easytier_core::connectivity::transport::connect_udp( + host, + target, + Vec::new(), + easytier_core::socket::udp::UdpBindOptions::direct_connect(), + easytier_core::connectivity::transport::UdpSessionMode::EasyTierMux, + ) + .await?, + ), + scheme => panic!("unsupported test scheme: {scheme}"), + }; + let tunnel = easytier_core::connectivity::protocol::ClientProtocolUpgrader::upgrade_client( + protocol.as_ref(), + connected, + url, + ) + .await?; + core.admit_client_tunnel_for_test(tunnel) + .await + .map(|_| ()) + .map_err(anyhow::Error::from) + }; + let result = tokio::time::timeout(Duration::from_millis(100), connect).await; + assert!(matches!(result, Err(_) | Ok(Err(_)))); +} + +use std::fs; +use std::io; + +fn print_all_fds() -> io::Result<()> { + let fd_dir = "/proc/self/fd"; + + // 读取 /proc/self/fd 目录中的所有条目 + for entry in fs::read_dir(fd_dir)? { + let entry = entry?; + let file_name = entry.file_name(); + let fd_str = file_name.to_string_lossy(); + + // 尝试解析为数字(跳过 . 和 ..) + if let Ok(fd_num) = fd_str.parse::() { + // 获取文件描述符指向的文件路径(如果可能) + let target_path = format!("{}/{}", fd_dir, fd_num); + match fs::read_link(&target_path) { + Ok(target) => { + println!("FD {}: {}", fd_num, target.to_string_lossy()); + } + Err(e) => { + println!("FD {}: (unreadable: {})", fd_num, e); + } + } + } + } + Ok(()) +} + +#[rstest::rstest] +#[serial_test::serial] +#[tokio::test] +async fn avoid_tunnel_loop_back_to_virtual_network( + #[values(true, false)] no_tun: bool, + #[values(true, false)] enable_kcp_proxy: bool, + #[values(true, false)] enable_quic_proxy: bool, +) { + if enable_kcp_proxy && enable_quic_proxy { + return; + } + + let insts = init_three_node_ex( + "udp", + |cfg| { + if matches!(cfg.get_inst_name().as_str(), "inst2" | "inst3") { + let mut flags = cfg.get_flags(); + flags.no_tun = no_tun; + cfg.set_flags(flags); + } + + if cfg.get_inst_name().as_str() == "inst1" { + let mut flags = cfg.get_flags(); + flags.enable_kcp_proxy = enable_kcp_proxy; + flags.enable_quic_proxy = enable_quic_proxy; + cfg.set_flags(flags); + } + + if cfg.get_inst_name().as_str() == "inst3" { + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + } + + cfg + }, + false, + ) + .await; + + assert_peer_admission_blocked(&insts[0], "tcp://10.144.144.2:11010".parse().unwrap()).await; + + assert_peer_admission_blocked(&insts[0], "udp://10.144.144.3:11010".parse().unwrap()).await; + + assert_peer_admission_blocked(&insts[0], "tcp://10.1.2.3:11010".parse().unwrap()).await; + + assert_peer_admission_blocked(&insts[0], "udp://10.1.2.3:11010".parse().unwrap()).await; + + drop_insts(insts).await; + + let _ = print_all_fds(); +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn acl_rule_test_inbound( + #[values(true, false)] enable_kcp_proxy: bool, + #[values(true, false)] enable_quic_proxy: bool, +) { + use crate::tunnel::common::tests::_tunnel_pingpong_netns_with_timeout; + use rand::Rng; + let insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst1" { + let mut flags = cfg.get_flags(); + flags.enable_kcp_proxy = enable_kcp_proxy; + flags.enable_quic_proxy = enable_quic_proxy; + cfg.set_flags(flags); + } + cfg + }, + false, + ) + .await; + + // 构造 ACL 配置 + use crate::proto::acl::*; + let mut acl = Acl::default(); + let mut acl_v1 = AclV1::default(); + + let mut chain = Chain { + name: "test_inbound".to_string(), + chain_type: ChainType::Inbound as i32, + enabled: true, + ..Default::default() + }; + + // 禁止 8080 + let deny_rule = Rule { + name: "deny_8080".to_string(), + priority: 200, + enabled: true, + action: Action::Drop as i32, + protocol: Protocol::Any as i32, + ports: vec!["8080".to_string()], + ..Default::default() + }; + chain.rules.push(deny_rule); + + // 允许其他 + let allow_rule = Rule { + name: "allow_all".to_string(), + priority: 100, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + stateful: true, + ..Default::default() + }; + chain.rules.push(allow_rule); + + // 禁止 src ip 为 10.144.144.2 的流量 + let deny_rule = Rule { + name: "deny_10.144.144.2".to_string(), + priority: 200, + enabled: true, + action: Action::Drop as i32, + protocol: Protocol::Any as i32, + source_ips: vec!["10.144.144.2/32".to_string()], + ..Default::default() + }; + chain.rules.push(deny_rule); + + acl_v1.chains.push(chain); + acl.acl_v1 = Some(acl_v1); + + // convert acl to to toml + let acl_toml = toml::to_string(&acl).unwrap(); + println!("ACL TOML: {}", acl_toml); + + reload_instance_acl(&insts[2], Some(&acl)).await; + + // TCP 测试部分 + { + // 2. 在 inst2 上监听 8080 和 8081 + let listener_8080 = core_tcp_listener("tcp://0.0.0.0:8080".parse().unwrap()); + let listener_8081 = core_tcp_listener("tcp://0.0.0.0:8081".parse().unwrap()); + let listener_8082 = core_tcp_listener("tcp://0.0.0.0:8082".parse().unwrap()); + + // 3. inst1 作为客户端,尝试连接 inst2 的 8080(应被拒绝)和 8081(应被允许) + let connector_8080 = + core_tcp_dialer(format!("tcp://{}:8080", "10.144.144.3").parse().unwrap()); + let connector_8081 = + core_tcp_dialer(format!("tcp://{}:8081", "10.144.144.3").parse().unwrap()); + let connector_8082 = + core_tcp_dialer(format!("tcp://{}:8082", "10.144.144.3").parse().unwrap()); + + // 4. 构造测试数据 + let mut buf = vec![0; 32]; + rand::thread_rng().fill(&mut buf[..]); + + // 5. 8081 应该可以 pingpong 成功 + let result = _tunnel_pingpong_netns_with_timeout( + listener_8081, + connector_8081, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + Duration::from_secs(5), + ) + .await; + assert!(result.is_ok(), "{}", result.unwrap_err()); + + // 6. 8080 应该连接失败(被 ACL 拦截) + let result = _tunnel_pingpong_netns_with_timeout( + listener_8080, + connector_8080, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + Duration::from_millis(500), + ) + .await; + + assert!(result.is_err(), "TCP 连接 8080 应被 ACL 拦截,不能成功"); + + // 7. 从 10.144.144.2 连接 8082 应该连接失败(被 ACL 拦截) + let result = _tunnel_pingpong_netns_with_timeout( + listener_8082, + connector_8082, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_b".into())), + buf.clone(), + Duration::from_millis(500), + ) + .await; + + assert!(result.is_err(), "TCP 连接 8082 应被 ACL 拦截,不能成功"); + + let stats = insts[2].get_core_instance().acl_stats(); + println!("stats: {:?}", stats); + } + + // UDP 测试部分 + { + // 1. 在 inst2 上监听 UDP 8080 和 8081 + let listener_8080 = core_udp_listener("udp://0.0.0.0:8080".parse().unwrap()); + let listener_8081 = core_udp_listener("udp://0.0.0.0:8081".parse().unwrap()); + + // 2. inst1 作为客户端,尝试连接 inst2 的 8080(应被拒绝)和 8081(应被允许) + let connector_8080 = + core_udp_dialer(format!("udp://{}:8080", "10.144.144.3").parse().unwrap()); + let connector_8081 = + core_udp_dialer(format!("udp://{}:8081", "10.144.144.3").parse().unwrap()); + + // 3. 构造测试数据 + let mut buf = vec![0; 32]; + rand::thread_rng().fill(&mut buf[..]); + + // 4. 8081 应该可以 pingpong 成功 + let result = _tunnel_pingpong_netns_with_timeout( + listener_8081, + connector_8081, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + Duration::from_secs(5), + ) + .await; + assert!(result.is_ok(), "{}", result.unwrap_err()); + + // 5. 8080 应该连接失败(被 ACL 拦截) + let result = _tunnel_pingpong_netns_with_timeout( + listener_8080, + connector_8080, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + Duration::from_millis(500), + ) + .await; + + assert!(result.is_err(), "UDP 连接 8080 应被 ACL 拦截,不能成功"); + + let stats = insts[2].get_core_instance().acl_stats(); + println!("stats: {}", stats); + } + + // remove acl, 8080 should succ + reload_instance_acl(&insts[2], None).await; + + drop_insts(insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn acl_inbound_default_drop_blocks_bidirectional_icmp() { + use crate::proto::acl::*; + + let insts = init_three_node("udp").await; + let mut acl = Acl::default(); + let mut acl_v1 = AclV1::default(); + acl_v1.chains.push(Chain { + name: "drop_inbound".to_string(), + chain_type: ChainType::Inbound as i32, + enabled: true, + default_action: Action::Drop as i32, + ..Default::default() + }); + acl.acl_v1 = Some(acl_v1); + + reload_instance_acl(&insts[0], Some(&acl)).await; + reload_instance_acl(&insts[1], Some(&acl)).await; + + for payload_size in [None, Some(5 * 1024)] { + for _ in 0..2 { + assert!(!ping_test("net_a", "10.144.144.2", payload_size).await); + assert!(!ping_test("net_b", "10.144.144.1", payload_size).await); + } + } + + reload_instance_acl(&insts[1], None).await; + for payload_size in [None, Some(5 * 1024)] { + wait_for_condition( + || async { ping_test("net_a", "10.144.144.2", payload_size).await }, + Duration::from_secs(5), + ) + .await; + assert!(!ping_test("net_b", "10.144.144.1", payload_size).await); + } + + drop_insts(insts).await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn acl_rule_test_subnet_proxy( + #[values(true, false)] enable_kcp_proxy: bool, + #[values(true, false)] enable_quic_proxy: bool, +) { + use crate::tunnel::common::tests::_tunnel_pingpong_netns_with_timeout; + use rand::Rng; + + let insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst1" { + let mut flags = cfg.get_flags(); + flags.enable_kcp_proxy = enable_kcp_proxy; + flags.enable_quic_proxy = enable_quic_proxy; + cfg.set_flags(flags); + } else if cfg.get_inst_name() == "inst3" { + // 添加子网代理配置 + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + } + cfg + }, + false, + ) + .await; + + // 等待代理路由出现 + wait_proxy_route_appear( + &insts[0].get_core_instance(), + "10.144.144.3/24", + insts[2].peer_id(), + "10.1.2.0/24", + ) + .await; + + // Test IPv4 connectivity + wait_for_condition( + || async { ping_test("net_a", "10.1.2.4", None).await }, + Duration::from_secs(5), + ) + .await; + + // 构造 ACL 配置 - 针对子网代理流量 + use crate::proto::acl::*; + let mut acl = Acl::default(); + let mut acl_v1 = AclV1::default(); + + let mut chain = Chain { + name: "test_subnet_proxy_inbound".to_string(), + chain_type: ChainType::Forward as i32, + enabled: true, + ..Default::default() + }; + + // 禁止访问子网代理中的 8080 端口 + let deny_rule = Rule { + name: "deny_subnet_8080".to_string(), + priority: 200, + enabled: true, + action: Action::Drop as i32, + protocol: Protocol::Any as i32, + ports: vec!["8080".to_string()], + destination_ips: vec!["10.1.2.0/24".to_string()], + ..Default::default() + }; + chain.rules.push(deny_rule); + + // 禁止来自 inst1 (10.144.144.1) 访问子网代理中的 8081 端口 + let deny_src_rule = Rule { + name: "deny_inst1_to_subnet_8081".to_string(), + priority: 200, + enabled: true, + action: Action::Drop as i32, + protocol: Protocol::Any as i32, + ports: vec!["8081".to_string()], + source_ips: vec!["10.144.144.1/32".to_string()], + destination_ips: vec!["10.1.2.0/24".to_string()], + ..Default::default() + }; + chain.rules.push(deny_src_rule); + + // 允许其他流量 + let allow_rule = Rule { + name: "allow_all".to_string(), + priority: 100, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + stateful: true, + ..Default::default() + }; + chain.rules.push(allow_rule); + + acl_v1.chains.push(chain); + acl.acl_v1 = Some(acl_v1); + + // 在 inst3 上应用 ACL 规则 + reload_instance_acl(&insts[2], Some(&acl)).await; + + // TCP 测试部分 - 测试子网代理的 ACL 规则 + { + // 在 net_d (10.1.2.4) 上监听多个端口 + let listener_8080 = core_tcp_listener("tcp://0.0.0.0:8080".parse().unwrap()); + let listener_8081 = core_tcp_listener("tcp://0.0.0.0:8081".parse().unwrap()); + let listener_8082 = core_tcp_listener("tcp://0.0.0.0:8082".parse().unwrap()); + + // 从 inst1 (net_a) 连接到子网代理 + let connector_8080 = core_tcp_dialer("tcp://10.1.2.4:8080".parse().unwrap()); + let connector_8081 = core_tcp_dialer("tcp://10.1.2.4:8081".parse().unwrap()); + let connector_8082 = core_tcp_dialer("tcp://10.1.2.4:8082".parse().unwrap()); + + let mut buf = vec![0; 32]; + rand::thread_rng().fill(&mut buf[..]); + + // 8082 应该可以连接成功(不被 ACL 拦截) + let result = _tunnel_pingpong_netns_with_timeout( + listener_8082, + connector_8082, + NetNS::new(Some("net_d".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + Duration::from_secs(5), + ) + .await; + assert!(result.is_ok(), "{}", result.unwrap_err()); + + // 8080 应该连接失败(被 ACL 拦截 - 禁止访问子网代理的 8080) + let result = _tunnel_pingpong_netns_with_timeout( + listener_8080, + connector_8080, + NetNS::new(Some("net_d".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + Duration::from_millis(500), + ) + .await; + + assert!( + result.is_err(), + "TCP 连接子网代理 8080 应被 ACL 拦截,不能成功" + ); + + // 8081 应该连接失败(被 ACL 拦截 - 禁止 inst1 访问子网代理的 8081) + let result = _tunnel_pingpong_netns_with_timeout( + listener_8081, + connector_8081, + NetNS::new(Some("net_d".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + Duration::from_millis(500), + ) + .await; + + assert!( + result.is_err(), + "TCP 连接子网代理 8081 应被 ACL 拦截,不能成功" + ); + + let stats = insts[2].get_core_instance().acl_stats(); + println!("ACL stats after TCP tests: {:?}", stats); + } + + // UDP 测试部分 - 测试子网代理的 ACL 规则 + { + let listener_8080 = core_udp_listener("udp://0.0.0.0:8080".parse().unwrap()); + let listener_8082 = core_udp_listener("udp://0.0.0.0:8082".parse().unwrap()); + + let connector_8080 = core_udp_dialer("udp://10.1.2.4:8080".parse().unwrap()); + let connector_8082 = core_udp_dialer("udp://10.1.2.4:8082".parse().unwrap()); + + let mut buf = vec![0; 32]; + rand::thread_rng().fill(&mut buf[..]); + + // 8082 应该可以连接成功 + let result = _tunnel_pingpong_netns_with_timeout( + listener_8082, + connector_8082, + NetNS::new(Some("net_d".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + Duration::from_secs(5), + ) + .await; + assert!(result.is_ok(), "{}", result.unwrap_err()); + + // 8080 应该连接失败(被 ACL 拦截) + let result = _tunnel_pingpong_netns_with_timeout( + listener_8080, + connector_8080, + NetNS::new(Some("net_d".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + Duration::from_millis(500), + ) + .await; + + let stats = insts[2].get_core_instance().acl_stats(); + println!("ACL stats after UDP tests: {}", stats); + + assert!( + result.is_err(), + "UDP 连接子网代理 8080 应被 ACL 拦截,不能成功" + ); + } + + // 测试 ICMP 到子网代理(应该被拒绝,因为 Any 协议被拒绝) + tokio::spawn(wait_for_condition( + || async { ping_test("net_a", "10.1.2.4", None).await }, + Duration::from_secs(1), + )) + .await + .unwrap_err(); + + // 移除 ACL 规则 + reload_instance_acl(&insts[2], None).await; + + // 验证移除 ACL 后,ICMP 可以正常工作 + wait_for_condition( + || async { ping_test("net_a", "10.1.2.4", None).await }, + Duration::from_secs(5), + ) + .await; + + drop_insts(insts).await; +} + +async fn assert_panics_ext(f: F, expect_panic: bool) +where + F: FnOnce() -> Fut + Send + 'static, + Fut: Future + Send + 'static, +{ + // Run the async function in a separate task so panics surface as JoinError + let res = tokio::spawn(async move { + f().await; + }) + .await; + + if expect_panic { + assert!( + res.is_err() && res.as_ref().unwrap_err().is_panic(), + "Expected function to panic, but it didn't", + ); + } else { + assert!(res.is_ok(), "Expected function not to panic, but it did"); + } +} + +async fn wait_route_cost(inst: &Instance, peer_id: u32, cost: i32, timeout: Duration) { + let core = inst.get_core_instance(); + wait_for_condition( + move || { + let core = core.clone(); + async move { + core.route_snapshots() + .await + .iter() + .any(|route| route.peer_id == peer_id && route.cost == cost) + } + }, + timeout, + ) + .await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn p2p_only_test( + #[values(true, false)] has_p2p_conn: bool, + #[values(true, false)] enable_kcp_proxy: bool, + #[values(true, false)] enable_quic_proxy: bool, +) { + let insts = init_three_node_ex( + "udp", + |cfg| { + if cfg.get_inst_name() == "inst1" { + let mut flags = cfg.get_flags(); + flags.enable_kcp_proxy = enable_kcp_proxy; + flags.enable_quic_proxy = enable_quic_proxy; + flags.disable_p2p = true; + flags.p2p_only = true; + cfg.set_flags(flags); + } else if cfg.get_inst_name() == "inst3" { + // 添加子网代理配置 + cfg.add_proxy_cidr("10.1.2.0/24".parse().unwrap(), None) + .unwrap(); + } + cfg + }, + false, + ) + .await; + + if has_p2p_conn { + insts[2].add_connector_url(insts[0].ring_listener_url()); + wait_route_cost(&insts[2], insts[0].peer_id(), 1, Duration::from_secs(5)).await; + } + + let target_ip = "10.1.2.4"; + + for target_ip in ["10.144.144.3", target_ip] { + assert_panics_ext( + || async { + subnet_proxy_test_icmp(target_ip, Duration::from_millis(100)).await; + }, + !has_p2p_conn, + ) + .await; + + let listen_ip = if target_ip == "10.144.144.3" { + "0.0.0.0" + } else { + "10.1.2.4" + }; + assert_panics_ext( + || async { + subnet_proxy_test_tcp(listen_ip, target_ip, Duration::from_millis(100)).await; + }, + !has_p2p_conn, + ) + .await; + + assert_panics_ext( + || async { + subnet_proxy_test_udp(listen_ip, target_ip, Duration::from_millis(100)).await; + }, + !has_p2p_conn, + ) + .await; + } +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn acl_group_base_test( + #[values("tcp", "udp")] protocol: &str, + #[values(true, false)] enable_kcp_proxy: bool, + #[values(true, false)] enable_quic_proxy: bool, +) { + use crate::tunnel::common::tests::_tunnel_pingpong_netns_with_timeout; + use rand::Rng; + + // 构造 ACL 配置,包含组信息 + use crate::proto::acl::*; + + // 设置组信息 + let group_declares = vec![ + GroupIdentity { + group_name: "admin".to_string(), + group_secret: "admin-secret".to_string(), + }, + GroupIdentity { + group_name: "user".to_string(), + group_secret: "user-secret".to_string(), + }, + ]; + + let mut chain = Chain { + name: "group_acl_test".to_string(), + chain_type: ChainType::Inbound as i32, + enabled: true, + default_action: Action::Drop as i32, + ..Default::default() + }; + + // 规则1: 允许admin组访问所有端口 + let admin_allow_rule = Rule { + name: "allow_admin_all".to_string(), + priority: 300, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + source_groups: vec!["admin".to_string()], + stateful: true, + ..Default::default() + }; + chain.rules.push(admin_allow_rule); + + // 规则2: 允许user组访问8080端口 + let user_8080_rule = Rule { + name: "allow_user_8080".to_string(), + priority: 200, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + source_groups: vec!["user".to_string()], + ports: vec!["8080".to_string()], + stateful: true, + ..Default::default() + }; + chain.rules.push(user_8080_rule); + + let acl_admin = Acl { + acl_v1: Some(AclV1 { + group: Some(GroupInfo { + declares: group_declares.clone(), + members: vec!["admin".to_string()], + }), + ..AclV1::default() + }), + }; + + let acl_user = Acl { + acl_v1: Some(AclV1 { + group: Some(GroupInfo { + declares: group_declares.clone(), + members: vec!["user".to_string()], + }), + ..AclV1::default() + }), + }; + + let acl_target = Acl { + acl_v1: Some(AclV1 { + chains: vec![chain.clone()], + group: Some(GroupInfo { + declares: group_declares.clone(), + members: vec![], + }), + }), + }; + + let insts = init_three_node_ex( + protocol, + move |cfg| { + match cfg.get_inst_name().as_str() { + "inst1" => { + cfg.set_acl(Some(acl_admin.clone())); + } + "inst2" => { + cfg.set_acl(Some(acl_user.clone())); + } + "inst3" => { + cfg.set_acl(Some(acl_target.clone())); + } + _ => {} + } + + let mut flags = cfg.get_flags(); + flags.enable_kcp_proxy = enable_kcp_proxy; + flags.enable_quic_proxy = enable_quic_proxy; + cfg.set_flags(flags); + + cfg + }, + false, + ) + .await; + + println!("Testing group-based ACL rules..."); + + let make_listener = |port: u16| -> Box> + Sync> { + match protocol { + "tcp" => Box::new(core_tcp_listener( + format!("tcp://0.0.0.0:{}", port).parse().unwrap(), + )), + "udp" => Box::new(core_udp_listener( + format!("udp://0.0.0.0:{}", port).parse().unwrap(), + )), + _ => panic!("unsupported protocol: {}", protocol), + } + }; + + let make_connector = |port: u16| -> Box { + match protocol { + "tcp" => Box::new(core_tcp_dialer( + format!("tcp://10.144.144.3:{}", port).parse().unwrap(), + )), + "udp" => Box::new(core_udp_dialer( + format!("udp://10.144.144.3:{}", port).parse().unwrap(), + )), + _ => panic!("unsupported protocol: {}", protocol), + } + }; + + // 构造测试数据 + let mut buf = vec![0; 32]; + rand::thread_rng().fill(&mut buf[..]); + + // 测试1: inst1 (admin组) 访问8080 - 应该成功 + let result = _tunnel_pingpong_netns_with_timeout( + make_listener(8080), + make_connector(8080), + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + std::time::Duration::from_millis(30000), + ) + .await; + assert!( + result.is_ok(), + "Admin group access to port 8080 should be allowed (protocol={})", + protocol + ); + println!( + "✓ Admin group access to port 8080 succeeded ({})\n", + protocol + ); + + // 测试2: inst1 (admin组) 访问8081 - 应该成功 + let result = _tunnel_pingpong_netns_with_timeout( + make_listener(8081), + make_connector(8081), + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + std::time::Duration::from_millis(30000), + ) + .await; + assert!( + result.is_ok(), + "Admin group access to port 8081 should be allowed (protocol={})", + protocol + ); + println!( + "✓ Admin group access to port 8081 succeeded ({})\n", + protocol + ); + + // 测试3: inst2 (user组) 访问8080 - 应该成功 + let result = _tunnel_pingpong_netns_with_timeout( + make_listener(8080), + make_connector(8080), + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_b".into())), + buf.clone(), + std::time::Duration::from_millis(30000), + ) + .await; + assert!( + result.is_ok(), + "User group access to port 8080 should be allowed (protocol={})", + protocol + ); + println!( + "✓ User group access to port 8080 succeeded ({})\n", + protocol + ); + + // 测试4: inst2 (user组) 访问8081 - 应该失败 + let result = _tunnel_pingpong_netns_with_timeout( + make_listener(8081), + make_connector(8081), + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_b".into())), + buf.clone(), + std::time::Duration::from_millis(200), + ) + .await; + assert!( + result.is_err(), + "User group access to port 8081 should be blocked (protocol={})", + protocol + ); + println!( + "✓ User group access to port 8081 blocked as expected ({})\n", + protocol + ); + + let stats = insts[2].get_core_instance().acl_stats(); + println!("ACL stats after group {} tests: {:?}", protocol, stats); + + println!("✓ All group-based ACL tests completed successfully"); + + drop_insts(insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn lazy_p2p_builds_direct_connection_on_demand() { + let insts = init_lazy_p2p_three_node_ex("udp", |cfg| { + if cfg.get_inst_name() == "inst1" { + let mut flags = cfg.get_flags(); + flags.lazy_p2p = true; + cfg.set_flags(flags); + } + cfg + }) + .await; + + let inst3_peer_id = insts[2].peer_id(); + assert!( + !insts[0] + .get_core_instance() + .connected_peers() + .await + .contains(&inst3_peer_id), + "inst1 should not proactively connect to inst3 when lazy_p2p is enabled" + ); + wait_route_cost(&insts[0], inst3_peer_id, 2, Duration::from_secs(5)).await; + + assert!( + ping_test("net_a", "10.144.144.3", None).await, + "initial relay traffic should still succeed" + ); + + wait_for_condition( + || async { + insts[0] + .get_core_instance() + .connected_peers() + .await + .contains(&inst3_peer_id) + }, + Duration::from_secs(10), + ) + .await; + wait_route_cost(&insts[0], inst3_peer_id, 1, Duration::from_secs(10)).await; + + drop_insts(insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn need_p2p_overrides_lazy_p2p() { + let insts = init_lazy_p2p_three_node_ex("udp", |cfg| { + let mut flags = cfg.get_flags(); + if cfg.get_inst_name() == "inst1" { + flags.lazy_p2p = true; + } + if cfg.get_inst_name() == "inst3" { + flags.need_p2p = true; + } + cfg.set_flags(flags); + cfg + }) + .await; + + let inst3_peer_id = insts[2].peer_id(); + wait_route_cost(&insts[0], inst3_peer_id, 2, Duration::from_secs(5)).await; + wait_for_condition( + || async { + insts[0] + .get_core_instance() + .connected_peers() + .await + .contains(&inst3_peer_id) + }, + Duration::from_secs(10), + ) + .await; + wait_route_cost(&insts[0], inst3_peer_id, 1, Duration::from_secs(10)).await; + + drop_insts(insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn disable_p2p_still_connects_to_need_p2p_peers() { + let insts = init_lazy_p2p_three_node_ex("udp", |cfg| { + let mut flags = cfg.get_flags(); + if cfg.get_inst_name() == "inst1" { + flags.disable_p2p = true; + } + if cfg.get_inst_name() == "inst3" { + flags.need_p2p = true; + } + cfg.set_flags(flags); + cfg + }) + .await; + + let inst3_peer_id = insts[2].peer_id(); + wait_route_cost(&insts[0], inst3_peer_id, 2, Duration::from_secs(5)).await; + wait_for_condition( + || async { + insts[0] + .get_core_instance() + .connected_peers() + .await + .contains(&inst3_peer_id) + }, + Duration::from_secs(10), + ) + .await; + wait_route_cost(&insts[0], inst3_peer_id, 1, Duration::from_secs(10)).await; + + drop_insts(insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn ordinary_nodes_do_not_proactively_connect_to_disable_p2p_peers() { + let insts = init_lazy_p2p_three_node_ex("udp", |cfg| { + if cfg.get_inst_name() == "inst3" { + let mut flags = cfg.get_flags(); + flags.disable_p2p = true; + cfg.set_flags(flags); + } + cfg + }) + .await; + + let inst3_peer_id = insts[2].peer_id(); + wait_route_cost(&insts[0], inst3_peer_id, 2, Duration::from_secs(5)).await; + assert!( + ping_test("net_a", "10.144.144.3", None).await, + "relay traffic to disable-p2p peers should still succeed" + ); + + tokio::time::sleep(Duration::from_secs(3)).await; + + assert!( + !insts[0] + .get_core_instance() + .connected_peers() + .await + .contains(&inst3_peer_id), + "ordinary nodes should not proactively establish p2p with disable-p2p peers" + ); + wait_route_cost(&insts[0], inst3_peer_id, 2, Duration::from_secs(3)).await; + + drop_insts(insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn lazy_p2p_warms_up_before_p2p_only_send() { + let insts = init_lazy_p2p_three_node_ex("udp", |cfg| { + if cfg.get_inst_name() == "inst1" { + let mut flags = cfg.get_flags(); + flags.lazy_p2p = true; + flags.p2p_only = true; + cfg.set_flags(flags); + } + cfg + }) + .await; + + let inst3_peer_id = insts[2].peer_id(); + wait_route_cost(&insts[0], inst3_peer_id, 2, Duration::from_secs(5)).await; + assert!( + !ping_test("net_a", "10.144.144.3", None).await, + "the first send should still fail under p2p_only before direct connectivity exists" + ); + + wait_for_condition( + || async { + insts[0] + .get_core_instance() + .connected_peers() + .await + .contains(&inst3_peer_id) + }, + Duration::from_secs(10), + ) + .await; + wait_route_cost(&insts[0], inst3_peer_id, 1, Duration::from_secs(10)).await; + + wait_for_condition( + || async { ping_test("net_a", "10.144.144.3", None).await }, + Duration::from_secs(6), + ) + .await; + + drop_insts(insts).await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn acl_group_self_test( + #[values("tcp", "udp")] protocol: &str, + #[values(true, false)] enable_kcp_proxy: bool, + #[values(true, false)] enable_quic_proxy: bool, +) { + use crate::tunnel::common::tests::_tunnel_pingpong_netns_with_timeout; + use rand::Rng; + + // 构造 ACL 配置,包含组信息 + use crate::proto::acl::*; + + // 设置组信息 + let group_declares = vec![GroupIdentity { + group_name: "admin".to_string(), + group_secret: "admin-secret".to_string(), + }]; + + let mut chain = Chain { + name: "group_acl_test".to_string(), + chain_type: ChainType::Inbound as i32, + enabled: true, + default_action: Action::Drop as i32, + ..Default::default() + }; + + // 规则1: 允许admin组访问admin组 + let admin_allow_rule = Rule { + name: "allow_admin_admin".to_string(), + priority: 300, + enabled: true, + action: Action::Allow as i32, + protocol: Protocol::Any as i32, + source_groups: vec!["admin".to_string()], + destination_groups: vec!["admin".to_string()], + stateful: true, + ..Default::default() + }; + chain.rules.push(admin_allow_rule); + + let acl_admin = Acl { + acl_v1: Some(AclV1 { + chains: vec![chain.clone()], + group: Some(GroupInfo { + declares: group_declares.clone(), + members: vec!["admin".to_string()], + }), + }), + }; + + let acl_common = Acl { + acl_v1: Some(AclV1 { + chains: vec![chain.clone()], + group: Some(GroupInfo { + declares: group_declares.clone(), + members: vec![], + }), + }), + }; + + let insts = init_three_node_ex( + protocol, + move |cfg| { + match cfg.get_inst_name().as_str() { + "inst1" => { + cfg.set_acl(Some(acl_admin.clone())); + } + "inst2" => { + cfg.set_acl(Some(acl_common.clone())); + } + "inst3" => { + cfg.set_acl(Some(acl_admin.clone())); + } + _ => {} + } + + let mut flags = cfg.get_flags(); + flags.enable_kcp_proxy = enable_kcp_proxy; + flags.enable_quic_proxy = enable_quic_proxy; + cfg.set_flags(flags); + + cfg + }, + false, + ) + .await; + + println!("Testing group-based ACL rules..."); + + let make_listener = |port: u16| -> Box> + Sync> { + match protocol { + "tcp" => Box::new(core_tcp_listener( + format!("tcp://0.0.0.0:{}", port).parse().unwrap(), + )), + "udp" => Box::new(core_udp_listener( + format!("udp://0.0.0.0:{}", port).parse().unwrap(), + )), + _ => panic!("unsupported protocol: {}", protocol), + } + }; + + let make_connector = |port: u16| -> Box { + match protocol { + "tcp" => Box::new(core_tcp_dialer( + format!("tcp://10.144.144.3:{}", port).parse().unwrap(), + )), + "udp" => Box::new(core_udp_dialer( + format!("udp://10.144.144.3:{}", port).parse().unwrap(), + )), + _ => panic!("unsupported protocol: {}", protocol), + } + }; + + // 构造测试数据 + let mut buf = vec![0; 32]; + rand::thread_rng().fill(&mut buf[..]); + + // 测试1: inst1 (admin组) 访问inst3 (admin组) - 应该成功 + let result = _tunnel_pingpong_netns_with_timeout( + make_listener(8080), + make_connector(8080), + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + std::time::Duration::from_millis(30000), + ) + .await; + assert!( + result.is_ok(), + "Admin group access to Admin group should be allowed (protocol={})", + protocol + ); + println!( + "✓ Admin group access to Admin group succeeded ({})\n", + protocol + ); + + // 测试2: inst2 (无组) 访问inst3 (admin组) - 应该失败 + let result = _tunnel_pingpong_netns_with_timeout( + make_listener(8080), + make_connector(8080), + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_b".into())), + buf.clone(), + std::time::Duration::from_millis(200), + ) + .await; + assert!( + result.is_err(), + "None group access to inst3 (admin group) should be blocked (protocol={})", + protocol + ); + println!( + "✓ None group access to inst3 (admin group) blocked as expected ({})\n", + protocol + ); + + let stats = insts[2].get_core_instance().acl_stats(); + println!("ACL stats after group {} tests: {:?}", protocol, stats); + + println!("✓ All group-based ACL tests completed successfully"); + + drop_insts(insts).await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn whitelist_test( + #[values("tcp", "udp")] protocol: &str, + #[values(true, false)] test_outbound_allow_list: bool, +) { + let port = 44553; + let acl_configured_inst = if test_outbound_allow_list { + "inst1" + } else { + "inst3" + }; + let insts = init_three_node_ex( + protocol, + move |cfg| { + let port = if test_outbound_allow_list { 0 } else { port }; + if cfg.get_inst_name() == acl_configured_inst { + if protocol == "tcp" { + cfg.set_tcp_whitelist(vec![format!("{}", port)]); + } else if protocol == "udp" { + cfg.set_udp_whitelist(vec![format!("{}", port)]); + } + } + cfg + }, + false, + ) + .await; + + use crate::tunnel::common::tests::_tunnel_pingpong_netns_with_timeout; + use rand::Rng; + + let make_listener = + |protocol: &str, port: u16| -> Box> + Sync> { + match protocol { + "tcp" => Box::new(core_tcp_listener( + format!("tcp://0.0.0.0:{}", port).parse().unwrap(), + )), + "udp" => Box::new(core_udp_listener( + format!("udp://0.0.0.0:{}", port).parse().unwrap(), + )), + _ => panic!("unsupported protocol: {}", protocol), + } + }; + + let make_connector = |protocol: &str, port: u16| -> Box { + match protocol { + "tcp" => Box::new(core_tcp_dialer( + format!("tcp://10.144.144.3:{}", port).parse().unwrap(), + )), + "udp" => Box::new(core_udp_dialer( + format!("udp://10.144.144.3:{}", port).parse().unwrap(), + )), + _ => panic!("unsupported protocol: {}", protocol), + } + }; + + let mut buf = vec![0; 32]; + rand::thread_rng().fill(&mut buf[..]); + + for p in &["tcp", "udp"] { + _tunnel_pingpong_netns_with_timeout( + make_listener(p, port), + make_connector(p, port), + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + std::time::Duration::from_millis(100), + ) + .await + .unwrap_or_else(|_| panic!("{} should be allowed", p)); + } + + if test_outbound_allow_list { + return; + } + + // test other port + let other_port = port + 1; + for p in ["tcp", "udp"] { + let r = _tunnel_pingpong_netns_with_timeout( + make_listener(p, other_port), + make_connector(p, other_port), + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + std::time::Duration::from_millis(100), + ) + .await; + + if p != protocol { + assert!(r.is_ok(), "{} should be allowed", p); + } else { + assert!(r.is_err(), "{} should be blocked", p); + } + } + + drop_insts(insts).await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn config_patch_test() { + use crate::proto::{ + api::config::{ + ConfigPatchAction, InstanceConfigPatch, PortForwardPatch, ProxyNetworkPatch, + }, + common::{PortForwardConfigPb, SocketType}, + }; + use crate::tunnel::common::tests::_tunnel_pingpong_netns_with_timeout; + + let insts = init_three_node_ex( + "udp", + |cfg| { + cfg.set_ipv6(None); + cfg + }, + false, + ) + .await; + + check_route( + "10.144.144.2/24", + insts[1].peer_id(), + insts[0].get_core_instance().route_snapshots().await, + ); + + check_route( + "10.144.144.3/24", + insts[2].peer_id(), + insts[0].get_core_instance().route_snapshots().await, + ); + + // 测试1: 修改hostname、ip、子网代理 + let patch = InstanceConfigPatch { + hostname: Some("new_inst1".to_string()), + ipv4: Some("10.144.144.22/24".parse().unwrap()), + proxy_networks: vec![ProxyNetworkPatch { + action: ConfigPatchAction::Add as i32, + cidr: Some("10.144.145.0/24".parse().unwrap()), + mapped_cidr: None, + }], + ..Default::default() + }; + insts[1] + .get_config_patcher() + .apply_patch(patch) + .await + .unwrap(); + assert_eq!(insts[1].get_global_ctx().get_hostname(), "new_inst1"); + assert_eq!( + insts[1].get_global_ctx().get_ipv4().unwrap(), + "10.144.144.22/24".parse().unwrap() + ); + tokio::time::sleep(Duration::from_secs(1)).await; + check_route_ex( + insts[0].get_core_instance().route_snapshots().await, + insts[1].peer_id(), + |r| { + assert_eq!(r.hostname, "new_inst1"); + assert_eq!(r.ipv4_addr, Some("10.144.144.22/24".parse().unwrap())); + assert_eq!(r.proxy_cidrs[0], "10.144.145.0/24"); + true + }, + ); + let patch = InstanceConfigPatch { + proxy_networks: vec![ProxyNetworkPatch { + action: ConfigPatchAction::Clear as i32, + ..Default::default() + }], + ..Default::default() + }; + insts[1] + .get_config_patcher() + .apply_patch(patch) + .await + .unwrap(); + assert!( + insts[1] + .get_global_ctx() + .config + .get_proxy_cidrs() + .is_empty() + ); + + // 测试1.1:修改公网 IPv6 provider 相关配置 + let public_prefix = "2001:db8:100::/64"; + let patch = InstanceConfigPatch { + ipv6_public_addr_provider: Some(true), + ipv6_public_addr_auto: Some(true), + ipv6_public_addr_prefix: Some(public_prefix.to_string()), + ..Default::default() + }; + insts[1] + .get_config_patcher() + .apply_patch(patch) + .await + .unwrap(); + assert!( + insts[1] + .get_global_ctx() + .config + .get_ipv6_public_addr_provider() + ); + assert!(insts[1].get_global_ctx().config.get_ipv6_public_addr_auto()); + assert_eq!( + insts[1] + .get_global_ctx() + .config + .get_ipv6_public_addr_prefix(), + Some(public_prefix.parse().unwrap()) + ); + assert!( + insts[1] + .get_core_instance() + .node_snapshot() + .await + .feature_flags + .ipv6_public_addr_provider + ); + assert_eq!( + insts[1] + .get_core_instance() + .node_snapshot() + .await + .ipv6_public_addr_prefix, + Some(public_prefix.parse().unwrap()) + ); + + // 测试2: 端口转发 + let patch = InstanceConfigPatch { + port_forwards: vec![PortForwardPatch { + action: ConfigPatchAction::Add as i32, + cfg: Some(PortForwardConfigPb { + bind_addr: Some("0.0.0.0:23458".parse::().unwrap().into()), + dst_addr: Some("10.144.144.3:23457".parse::().unwrap().into()), + socket_type: SocketType::Tcp as i32, + }), + }], + ..Default::default() + }; + insts[0] + .get_config_patcher() + .apply_patch(patch) + .await + .unwrap(); + + let mut buf = vec![0; 32]; + rand::thread_rng().fill(&mut buf[..]); + let tcp_listener = core_tcp_listener("tcp://0.0.0.0:23457".parse().unwrap()); + let tcp_connector = core_tcp_dialer("tcp://127.0.0.1:23458".parse().unwrap()); + let result = _tunnel_pingpong_netns_with_timeout( + tcp_listener, + tcp_connector, + NetNS::new(Some("net_c".into())), + NetNS::new(Some("net_a".into())), + buf.clone(), + std::time::Duration::from_millis(30000), + ) + .await; + assert!(result.is_ok(), "Port forward pingpong should succeed"); + + drop_insts(insts).await; +} + +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn config_patch_disable_relay_data_test() { + use crate::proto::api::config::InstanceConfigPatch; + + let insts = init_three_node_ex( + "udp", + |cfg| { + cfg.set_ipv6(None); + cfg + }, + false, + ) + .await; + + let relay_peer_id = insts[1].peer_id(); + let dst_peer_id = insts[2].peer_id(); + assert!(!insts[1].get_global_ctx().get_flags().disable_relay_data); + assert!( + !insts[1] + .get_core_instance() + .node_snapshot() + .await + .feature_flags + .avoid_relay_data + ); + + check_route_ex( + insts[0].get_core_instance().route_snapshots().await, + dst_peer_id, + |route| { + assert_eq!(route.next_hop_peer_id, relay_peer_id); + true + }, + ); + + wait_for_condition( + || async { ping_test("net_a", "10.144.144.3", None).await }, + Duration::from_secs(5), + ) + .await; + + insts[1] + .get_config_patcher() + .apply_patch(InstanceConfigPatch { + disable_relay_data: Some(true), + ..Default::default() + }) + .await + .unwrap(); + + assert!(insts[1].get_global_ctx().get_flags().disable_relay_data); + assert!( + insts[1] + .get_global_ctx() + .config + .get_flags() + .disable_relay_data + ); + assert!( + insts[1] + .get_core_instance() + .node_snapshot() + .await + .feature_flags + .avoid_relay_data + ); + + wait_for_condition( + || { + let core = insts[0].get_core_instance(); + async move { + core.route_snapshots().await.iter().any(|route| { + route.peer_id == relay_peer_id + && route + .feature_flag + .as_ref() + .map(|flag| flag.avoid_relay_data) + .unwrap_or(false) + }) + } + }, + Duration::from_secs(5), + ) + .await; + + check_route_ex( + insts[0].get_core_instance().route_snapshots().await, + dst_peer_id, + |route| { + assert_eq!(route.next_hop_peer_id, relay_peer_id); + true + }, + ); + assert!( + !ping_test("net_a", "10.144.144.3", None).await, + "traffic from inst1 to inst3 should be blocked while inst2 relay data is disabled" + ); + + insts[1] + .get_config_patcher() + .apply_patch(InstanceConfigPatch { + disable_relay_data: Some(false), + ..Default::default() + }) + .await + .unwrap(); + + assert!(!insts[1].get_global_ctx().get_flags().disable_relay_data); + assert!( + !insts[1] + .get_global_ctx() + .config + .get_flags() + .disable_relay_data + ); + assert!( + !insts[1] + .get_core_instance() + .node_snapshot() + .await + .feature_flags + .avoid_relay_data + ); + + wait_for_condition( + || { + let core = insts[0].get_core_instance(); + async move { + core.route_snapshots().await.iter().any(|route| { + route.peer_id == relay_peer_id + && route + .feature_flag + .as_ref() + .map(|flag| !flag.avoid_relay_data) + .unwrap_or(false) + }) + } + }, + Duration::from_secs(5), + ) + .await; + + wait_for_condition( + || async { ping_test("net_a", "10.144.144.3", None).await }, + Duration::from_secs(5), + ) + .await; + + drop_insts(insts).await; +} + +/// Generate SecureModeConfig with specified x25519 private key +pub fn generate_secure_mode_config_with_key( + private_key: &x25519_dalek::StaticSecret, +) -> SecureModeConfig { + use base64::{Engine, prelude::BASE64_STANDARD}; + use x25519_dalek::PublicKey; + + let public = PublicKey::from(private_key); + + SecureModeConfig { + enabled: true, + local_private_key: Some(BASE64_STANDARD.encode(private_key.as_bytes())), + local_public_key: Some(BASE64_STANDARD.encode(public.as_bytes())), + } +} + +/// Generate SecureModeConfig with random x25519 keypair +pub fn generate_secure_mode_config() -> SecureModeConfig { + let private = StaticSecret::random_from_rng(OsRng); + generate_secure_mode_config_with_key(&private) +} + +/// Test relay peer end-to-end encryption with TCP +#[rstest::rstest] +#[tokio::test] +#[serial_test::serial] +pub async fn relay_peer_e2e_encryption(#[values("tcp", "udp")] proto: &str) { + let insts = init_three_node_ex( + proto, + |cfg| { + cfg.set_secure_mode(Some(generate_secure_mode_config())); + cfg + }, + false, + ) + .await; + + let inst1_peer_id = insts[0].peer_id(); + let inst2_peer_id = insts[1].peer_id(); + let inst3_peer_id = insts[2].peer_id(); + + println!( + "Test topology: inst1({}) <-> inst2({}) <-> inst3({})", + inst1_peer_id, inst2_peer_id, inst3_peer_id + ); + + // Check secure mode is enabled + let secure_mode_1 = insts[0].get_global_ctx().config.get_secure_mode(); + let secure_mode_2 = insts[1].get_global_ctx().config.get_secure_mode(); + let secure_mode_3 = insts[2].get_global_ctx().config.get_secure_mode(); + println!( + "Secure mode enabled: inst1={}, inst2={}, inst3={}", + secure_mode_1.is_some(), + secure_mode_2.is_some(), + secure_mode_3.is_some() + ); + + // Wait for routes to be established + wait_for_condition( + || async { + let routes = insts[0].get_core_instance().route_snapshots().await; + routes.len() == 2 + }, + Duration::from_secs(10), + ) + .await; + + // Verify inst1 sees inst3 via inst2 (non-direct path) + let next_hop_to_inst3 = insts[0] + .get_core_instance() + .route_snapshots() + .await + .into_iter() + .find(|route| route.peer_id == inst3_peer_id) + .map(|route| route.next_hop_peer_id); + println!("Next hop from inst1 to inst3: {:?}", next_hop_to_inst3); + assert_eq!( + next_hop_to_inst3, + Some(inst2_peer_id), + "inst1 should reach inst3 via inst2 (relay)" + ); + + // Verify inst1 has no direct connection to inst3 + assert!( + !insts[0] + .get_core_instance() + .connected_peers() + .await + .contains(&inst3_peer_id), + "inst1 should NOT have direct connection to inst3" + ); + + // Check if noise_static_pubkey is available for relay handshake + let route_has_static_key = insts[0] + .get_core_instance() + .relay_route_has_static_key_for_test(inst3_peer_id) + .await; + println!( + "Route info for inst3 on inst1 has a relay static key: {}", + route_has_static_key + ); + + // Wait until relay route info includes inst3 static pubkey for IK handshake. + wait_for_condition( + || async { + insts[0] + .get_core_instance() + .relay_route_has_static_key_for_test(inst3_peer_id) + .await + }, + Duration::from_secs(10), + ) + .await; + + // Test basic connectivity through relay + println!("Starting ping test from net_a to 10.144.144.3..."); + + assert!( + ping_test("net_a", "10.144.144.3", None).await, + "Ping from net_a to inst3 should succeed" + ); + + // Verify relay sessions are established + let relay_1 = insts[0] + .get_core_instance() + .relay_session_snapshot_for_test(inst3_peer_id); + let relay_3 = insts[2] + .get_core_instance() + .relay_session_snapshot_for_test(inst1_peer_id); + + println!( + "Relay states after ping: inst1->inst3: {}, inst3->inst1: {}", + relay_1.has_state, relay_3.has_state + ); + + // Test bidirectional connectivity + assert!( + ping_test("net_a", "10.144.144.3", None).await, + "Ping from net_a to inst3 should work" + ); + assert!( + ping_test("net_c", "10.144.144.1", None).await, + "Ping from net_c to inst1 should work" + ); + + println!("Test completed successfully!"); + drop_insts(insts).await; +} + +#[tokio::test] +#[serial_test::serial] +pub async fn relay_peer_e2e_encryption_udp() { + let insts = init_three_node_ex( + "udp", + |cfg| { + cfg.set_secure_mode(Some(generate_secure_mode_config())); + cfg + }, + false, + ) + .await; + + let inst1_id = insts[0].get_global_ctx().get_id().to_string(); + let inst3_id = insts[2].get_global_ctx().get_id().to_string(); + let network_name = insts[0].get_global_ctx().get_network_name(); + let total_labels = + LabelSet::new().with_label_type(LabelType::NetworkName(network_name.clone())); + + wait_for_condition( + || async { + let routes = insts[0].get_core_instance().route_snapshots().await; + routes.len() == 2 + }, + Duration::from_secs(10), + ) + .await; + + wait_for_condition( + || async { ping_test("net_a", "10.144.144.3", None).await }, + Duration::from_secs(6), + ) + .await; + + let tx_labels = LabelSet::new() + .with_label_type(LabelType::NetworkName(network_name.clone())) + .with_label_type(LabelType::ToInstanceId(inst3_id.clone())); + let rx_labels = LabelSet::new() + .with_label_type(LabelType::NetworkName(network_name.clone())) + .with_label_type(LabelType::FromInstanceId(inst1_id.clone())); + + wait_for_condition( + || async { + let metrics = insts[0].get_core_instance().metric_snapshots(); + metric_value(&metrics, MetricName::TrafficBytesTx, &tx_labels).is_none() + && metric_value(&metrics, MetricName::TrafficPacketsTx, &tx_labels).is_none() + && metric_value(&metrics, MetricName::TrafficBytesTx, &total_labels) + .is_some_and(|value| value > 0) + && metric_value(&metrics, MetricName::TrafficPacketsTx, &total_labels) + .is_some_and(|value| value > 0) + && metric_value(&metrics, MetricName::TrafficBytesTxByInstance, &tx_labels) + .is_some_and(|value| value > 0) + && metric_value(&metrics, MetricName::TrafficPacketsTxByInstance, &tx_labels) + .is_some_and(|value| value > 0) + }, + Duration::from_secs(10), + ) + .await; + + wait_for_condition( + || async { + let metrics = insts[2].get_core_instance().metric_snapshots(); + metric_value(&metrics, MetricName::TrafficBytesRx, &rx_labels).is_none() + && metric_value(&metrics, MetricName::TrafficPacketsRx, &rx_labels).is_none() + && metric_value(&metrics, MetricName::TrafficBytesRx, &total_labels) + .is_some_and(|value| value > 0) + && metric_value(&metrics, MetricName::TrafficPacketsRx, &total_labels) + .is_some_and(|value| value > 0) + && metric_value(&metrics, MetricName::TrafficBytesRxByInstance, &rx_labels) + .is_some_and(|value| value > 0) + && metric_value(&metrics, MetricName::TrafficPacketsRxByInstance, &rx_labels) + .is_some_and(|value| value > 0) + }, + Duration::from_secs(10), + ) + .await; + + drop_insts(insts).await; +} + +/// Test Relay Peer session cleanup on relay failure - TCP +#[tokio::test] +#[serial_test::serial] +pub async fn relay_peer_session_cleanup() { + let mut insts = init_three_node_ex( + "tcp", + |cfg| { + cfg.set_secure_mode(Some(generate_secure_mode_config())); + cfg + }, + false, + ) + .await; + + let inst2_peer_id = insts[1].peer_id(); + let inst3_peer_id = insts[2].peer_id(); + let core_1 = insts[0].get_core_instance(); + + wait_for_condition( + || async { ping_test("net_a", "10.144.144.3", None).await }, + Duration::from_secs(6), + ) + .await; + + wait_for_condition( + || async { + let relay = core_1.relay_session_snapshot_for_test(inst3_peer_id); + relay.has_state && relay.has_session + }, + Duration::from_secs(3), + ) + .await; + + let next_hop = insts[0] + .get_core_instance() + .route_snapshots() + .await + .into_iter() + .find(|route| route.peer_id == inst3_peer_id) + .map(|route| route.next_hop_peer_id); + assert_eq!(next_hop, Some(inst2_peer_id)); + + let mut inst2 = insts.remove(1); + inst2.clear_resources().await; + drop(inst2); + + wait_for_condition( + || async { + let routes = insts[0].get_core_instance().route_snapshots().await; + !routes.iter().any(|r| r.peer_id == inst3_peer_id) + }, + Duration::from_secs(6), + ) + .await; + + core_1.evict_idle_relay_sessions_for_test(Duration::from_millis(0)); + assert!( + !core_1 + .relay_session_snapshot_for_test(inst3_peer_id) + .has_state + ); + + core_1.evict_unused_peer_sessions_for_test(Duration::from_millis(0)); + + wait_for_condition( + || async { + !core_1 + .relay_session_snapshot_for_test(inst3_peer_id) + .has_session + }, + Duration::from_secs(1), + ) + .await; + + drop(core_1); + drop_insts(insts).await; +} diff --git a/vendor/easytier/easytier/src/tests/upnp_test.rs b/vendor/easytier/easytier/src/tests/upnp_test.rs new file mode 100644 index 0000000..d888641 --- /dev/null +++ b/vendor/easytier/easytier/src/tests/upnp_test.rs @@ -0,0 +1,1214 @@ +use std::{ + ffi::OsStr, + net::{IpAddr, Ipv4Addr, SocketAddr}, + path::{Path, PathBuf}, + process::{Child, Command, Stdio}, + sync::Arc, + time::Duration, +}; + +use crate::igd_next::{ + GetGenericPortMappingEntryError, PortMappingEntry, PortMappingProtocol, SearchOptions, + search_gateway, +}; +use anyhow::{Context, anyhow, bail}; +use easytier_core::{ + connectivity::stun::{StunInfoProvider, StunSocketMapper}, + process_runtime::CoreProcessRuntime, +}; +use tempfile::TempDir; + +use super::{ + InstanceTestExt as _, create_netns, del_netns, drop_insts, get_host_veth_name, ping_test, +}; +use crate::{ + common::{ + config::{ConfigLoader, TomlConfigLoader}, + error::Error, + global_ctx::GlobalCtxEvent, + netns::NetNS, + stun::MockStunInfoCollector, + }, + instance::test_instance::TestInstance as Instance, + proto::common::{NatType, StunInfo}, + tunnel::common::tests::wait_for_condition, +}; + +const TEST_IGD_DESCRIPTION: &str = "EasyTier udp hole punch"; + +const DUAL_NS_A: &str = "upnp2_a"; +const DUAL_NS_C: &str = "upnp2_c"; +const DUAL_LAN_A_BRIDGE: &str = "br_upnp2_a"; +const DUAL_LAN_C_BRIDGE: &str = "br_upnp2_c"; +const DUAL_WAN_BRIDGE: &str = "br_upnp2_wan"; +const DUAL_GATEWAY_A_IP: Ipv4Addr = Ipv4Addr::new(172, 30, 1, 1); +const DUAL_GATEWAY_C_IP: Ipv4Addr = Ipv4Addr::new(172, 30, 2, 1); +const DUAL_CLIENT_A_IP: Ipv4Addr = Ipv4Addr::new(172, 30, 1, 2); +const DUAL_CLIENT_C_IP: Ipv4Addr = Ipv4Addr::new(172, 30, 2, 2); +const DUAL_EXTERNAL_A_IP: Ipv4Addr = Ipv4Addr::new(11, 22, 33, 1); +const DUAL_EXTERNAL_C_IP: Ipv4Addr = Ipv4Addr::new(11, 22, 33, 2); +const DUAL_GATEWAY_A_PORT: u16 = 5001; +const DUAL_GATEWAY_C_PORT: u16 = 5002; +const DUAL_WAN_IF_A: &str = "upnp2_wan_a"; +const DUAL_WAN_IF_A_PEER: &str = "upnp2_wan_a_p"; +const DUAL_WAN_IF_C: &str = "upnp2_wan_c"; +const DUAL_WAN_IF_C_PEER: &str = "upnp2_wan_c_p"; +const DUAL_GW_NS_A: &str = "upnp2_gw_a"; +const DUAL_GW_NS_C: &str = "upnp2_gw_c"; + +struct DualGatewayUpnpIntegrationEnv { + _tempdir: TempDir, + children: Vec, +} + +struct DualGatewayConfig<'a> { + name: &'a str, + ext_if: &'a str, + listening_ip: &'a str, + port: u16, + ext_ip: Ipv4Addr, + uuid: &'a str, + chain_name: &'a str, + postrouting_chain_name: &'a str, + allow_subnet: &'a str, +} + +impl DualGatewayUpnpIntegrationEnv { + async fn new() -> anyhow::Result { + cleanup_miniupnpd_processes(); + cleanup_dual_gateway_test_net(); + create_dual_gateway_test_net()?; + + let tempdir = tempfile::tempdir().context("create dual miniupnpd tempdir")?; + let gateway_a = write_dual_gateway_config( + tempdir.path(), + DualGatewayConfig { + name: "gateway_a", + ext_if: DUAL_WAN_IF_A, + listening_ip: DUAL_LAN_A_BRIDGE, + port: DUAL_GATEWAY_A_PORT, + ext_ip: DUAL_EXTERNAL_A_IP, + uuid: "9f0c5a3a-c4f0-4f1e-b4df-8a8c7b1e2d01", + chain_name: "MINIUPNPD_A", + postrouting_chain_name: "MINIUPNPD_A-POSTROUTING", + allow_subnet: "172.30.1.0/24", + }, + )?; + let gateway_c = write_dual_gateway_config( + tempdir.path(), + DualGatewayConfig { + name: "gateway_c", + ext_if: DUAL_WAN_IF_C, + listening_ip: DUAL_LAN_C_BRIDGE, + port: DUAL_GATEWAY_C_PORT, + ext_ip: DUAL_EXTERNAL_C_IP, + uuid: "9f0c5a3a-c4f0-4f1e-b4df-8a8c7b1e2d02", + chain_name: "MINIUPNPD_C", + postrouting_chain_name: "MINIUPNPD_C-POSTROUTING", + allow_subnet: "172.30.2.0/24", + }, + )?; + let pid_a = tempdir.path().join("gateway_a.pid"); + let pid_c = tempdir.path().join("gateway_c.pid"); + + let miniupnpd_bin = find_miniupnpd_bin()?; + let miniupnpd_bin_str = miniupnpd_bin + .to_str() + .ok_or_else(|| anyhow!("non-utf8 miniupnpd path: {}", miniupnpd_bin.display()))?; + let pid_a_str = pid_a + .to_str() + .ok_or_else(|| anyhow!("non-utf8 pid path: {}", pid_a.display()))?; + let pid_c_str = pid_c + .to_str() + .ok_or_else(|| anyhow!("non-utf8 pid path: {}", pid_c.display()))?; + let child_a = Command::new("ip") + .args([ + "netns", + "exec", + DUAL_GW_NS_A, + miniupnpd_bin_str, + "-d", + "-P", + pid_a_str, + "-f", + ]) + .arg(&gateway_a) + .stdin(Stdio::null()) + .stdout(Stdio::inherit()) + .stderr(Stdio::inherit()) + .spawn() + .context("spawn gateway a miniupnpd")?; + let child_c = Command::new("ip") + .args([ + "netns", + "exec", + DUAL_GW_NS_C, + miniupnpd_bin_str, + "-d", + "-P", + pid_c_str, + "-f", + ]) + .arg(&gateway_c) + .stdin(Stdio::null()) + .stdout(Stdio::inherit()) + .stderr(Stdio::inherit()) + .spawn() + .context("spawn gateway c miniupnpd")?; + + let env = Self { + _tempdir: tempdir, + children: vec![child_a, child_c], + }; + env.wait_ready().await?; + Ok(env) + } + + async fn wait_ready(&self) -> anyhow::Result<()> { + wait_for_condition( + || async { + tcp_connect_in_ns(DUAL_NS_A, DUAL_GATEWAY_A_IP, DUAL_GATEWAY_A_PORT) + .await + .is_ok() + && tcp_connect_in_ns(DUAL_NS_C, DUAL_GATEWAY_C_IP, DUAL_GATEWAY_C_PORT) + .await + .is_ok() + }, + Duration::from_secs(10), + ) + .await; + Ok(()) + } +} + +impl Drop for DualGatewayUpnpIntegrationEnv { + fn drop(&mut self) { + for child in &mut self.children { + let _ = child.kill(); + let _ = child.wait(); + } + cleanup_miniupnpd_processes(); + cleanup_dual_gateway_test_net(); + } +} + +#[derive(Clone)] +struct GatewayBackedStunCollector { + netns: &'static str, + client_ip: Ipv4Addr, + external_ip: Ipv4Addr, +} + +#[async_trait::async_trait] +impl StunInfoProvider for GatewayBackedStunCollector { + fn get_stun_info(&self) -> StunInfo { + StunInfo { + udp_nat_type: NatType::PortRestricted as i32, + tcp_nat_type: NatType::Unknown as i32, + last_update_time: 0, + min_port: 0, + max_port: 0, + public_ip: vec![self.external_ip.to_string()], + } + } + + async fn get_udp_port_mapping(&self, local_port: u16) -> anyhow::Result { + Ok(query_udp_mapping(self.netns, self.external_ip, self.client_ip, local_port).await?) + } + + async fn get_tcp_port_mapping(&self, local_port: u16) -> anyhow::Result { + Ok(SocketAddr::new(IpAddr::V4(self.external_ip), local_port)) + } + + fn update_stun_info(&self) {} +} + +#[async_trait::async_trait] +impl StunSocketMapper for GatewayBackedStunCollector { + async fn get_udp_port_mapping_with_socket( + &self, + udp: Arc, + ) -> anyhow::Result { + use easytier_core::socket::udp::VirtualUdpSocket as _; + Ok(query_udp_mapping( + self.netns, + self.external_ip, + self.client_ip, + udp.local_addr()?.port(), + ) + .await?) + } +} + +fn write_dual_gateway_config(dir: &Path, config: DualGatewayConfig<'_>) -> anyhow::Result { + let conf_path = dir.join(format!("{}.conf", config.name)); + let lease_path = dir.join(format!("{}.leases", config.name)); + std::fs::write(&lease_path, "") + .with_context(|| format!("create lease file for {}", config.name))?; + std::fs::write( + &conf_path, + format!( + "\ +ext_ifname={ext_if} +listening_ip={listening_ip} +port={port} +enable_natpmp=no +enable_upnp=yes +secure_mode=no +system_uptime=yes +lease_file={} +ext_ip={ext_ip} +friendly_name=EasyTier Test IGD {name} +model_name=EasyTier Test +serial=12345678 +uuid={uuid} +upnp_forward_chain={chain_name} +upnp_nat_chain={chain_name} +upnp_nat_postrouting_chain={postrouting_chain_name} +allow 1024-65535 {allow_subnet} 1024-65535 +deny 0-65535 0.0.0.0/0 0-65535 +", + lease_path.display(), + ext_if = config.ext_if, + listening_ip = config.listening_ip, + port = config.port, + ext_ip = config.ext_ip, + name = config.name, + uuid = config.uuid, + chain_name = config.chain_name, + postrouting_chain_name = config.postrouting_chain_name, + allow_subnet = config.allow_subnet, + ), + ) + .with_context(|| format!("write config for {}", config.name))?; + Ok(conf_path) +} + +async fn tcp_connect_in_ns(netns: &'static str, ip: Ipv4Addr, port: u16) -> anyhow::Result<()> { + tokio::task::spawn_blocking(move || { + let _g = NetNS::new(Some(netns.to_owned())).guard(); + tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + .context("build runtime for tcp connect in netns")? + .block_on(async move { + tokio::net::TcpStream::connect((ip, port)) + .await + .map(|_| ()) + .context("tcp connect in netns") + }) + }) + .await + .context("join tcp connect in netns task")? +} + +fn create_empty_netns(name: &str) -> anyhow::Result<()> { + run_cmd("ip", &["netns", "add", name])?; + run_cmd( + "ip", + &["netns", "exec", name, "ip", "link", "set", "lo", "up"], + )?; + Ok(()) +} + +fn run_cmd_in_netns>(netns: &str, cmd: S, args: &[&str]) -> anyhow::Result<()> { + let cmd = cmd.as_ref(); + let cmd_str = cmd + .to_str() + .ok_or_else(|| anyhow!("non-utf8 command path: {}", Path::new(cmd).display()))?; + let mut full_args = vec!["netns", "exec", netns, cmd_str]; + full_args.extend_from_slice(args); + run_cmd("ip", &full_args) +} + +fn create_dual_gateway_test_net() -> anyhow::Result<()> { + create_netns(DUAL_NS_A, &format!("{DUAL_CLIENT_A_IP}/24"), "fd20::2/64"); + create_netns(DUAL_NS_C, &format!("{DUAL_CLIENT_C_IP}/24"), "fd21::2/64"); + create_empty_netns(DUAL_GW_NS_A)?; + create_empty_netns(DUAL_GW_NS_C)?; + + run_cmd( + "ip", + &[ + "link", + "set", + get_host_veth_name(DUAL_NS_A), + "netns", + DUAL_GW_NS_A, + ], + )?; + run_cmd( + "ip", + &[ + "link", + "set", + get_host_veth_name(DUAL_NS_C), + "netns", + DUAL_GW_NS_C, + ], + )?; + + run_cmd_in_netns( + DUAL_GW_NS_A, + "ip", + &["link", "add", "name", DUAL_LAN_A_BRIDGE, "type", "bridge"], + )?; + run_cmd_in_netns( + DUAL_GW_NS_C, + "ip", + &["link", "add", "name", DUAL_LAN_C_BRIDGE, "type", "bridge"], + )?; + run_cmd( + "ip", + &["link", "add", "name", DUAL_WAN_BRIDGE, "type", "bridge"], + )?; + + run_cmd_in_netns( + DUAL_GW_NS_A, + "ip", + &[ + "link", + "set", + get_host_veth_name(DUAL_NS_A), + "master", + DUAL_LAN_A_BRIDGE, + ], + )?; + run_cmd_in_netns( + DUAL_GW_NS_C, + "ip", + &[ + "link", + "set", + get_host_veth_name(DUAL_NS_C), + "master", + DUAL_LAN_C_BRIDGE, + ], + )?; + run_cmd_in_netns( + DUAL_GW_NS_A, + "ip", + &[ + "addr", + "add", + &format!("{DUAL_GATEWAY_A_IP}/24"), + "dev", + DUAL_LAN_A_BRIDGE, + ], + )?; + run_cmd_in_netns( + DUAL_GW_NS_C, + "ip", + &[ + "addr", + "add", + &format!("{DUAL_GATEWAY_C_IP}/24"), + "dev", + DUAL_LAN_C_BRIDGE, + ], + )?; + + run_cmd( + "ip", + &[ + "link", + "add", + DUAL_WAN_IF_A, + "type", + "veth", + "peer", + "name", + DUAL_WAN_IF_A_PEER, + ], + )?; + run_cmd( + "ip", + &[ + "link", + "add", + DUAL_WAN_IF_C, + "type", + "veth", + "peer", + "name", + DUAL_WAN_IF_C_PEER, + ], + )?; + run_cmd("ip", &["link", "set", DUAL_WAN_IF_A, "netns", DUAL_GW_NS_A])?; + run_cmd("ip", &["link", "set", DUAL_WAN_IF_C, "netns", DUAL_GW_NS_C])?; + run_cmd( + "ip", + &["link", "set", DUAL_WAN_IF_A_PEER, "master", DUAL_WAN_BRIDGE], + )?; + run_cmd( + "ip", + &["link", "set", DUAL_WAN_IF_C_PEER, "master", DUAL_WAN_BRIDGE], + )?; + run_cmd_in_netns( + DUAL_GW_NS_A, + "ip", + &[ + "addr", + "add", + &format!("{DUAL_EXTERNAL_A_IP}/24"), + "dev", + DUAL_WAN_IF_A, + ], + )?; + run_cmd_in_netns( + DUAL_GW_NS_C, + "ip", + &[ + "addr", + "add", + &format!("{DUAL_EXTERNAL_C_IP}/24"), + "dev", + DUAL_WAN_IF_C, + ], + )?; + run_cmd("ip", &["link", "set", DUAL_WAN_BRIDGE, "up"])?; + run_cmd("ip", &["link", "set", DUAL_WAN_IF_A_PEER, "up"])?; + run_cmd("ip", &["link", "set", DUAL_WAN_IF_C_PEER, "up"])?; + run_cmd_in_netns( + DUAL_GW_NS_A, + "ip", + &["link", "set", DUAL_LAN_A_BRIDGE, "up"], + )?; + run_cmd_in_netns( + DUAL_GW_NS_A, + "ip", + &["link", "set", get_host_veth_name(DUAL_NS_A), "up"], + )?; + run_cmd_in_netns(DUAL_GW_NS_A, "ip", &["link", "set", DUAL_WAN_IF_A, "up"])?; + run_cmd_in_netns( + DUAL_GW_NS_C, + "ip", + &["link", "set", DUAL_LAN_C_BRIDGE, "up"], + )?; + run_cmd_in_netns( + DUAL_GW_NS_C, + "ip", + &["link", "set", get_host_veth_name(DUAL_NS_C), "up"], + )?; + run_cmd_in_netns(DUAL_GW_NS_C, "ip", &["link", "set", DUAL_WAN_IF_C, "up"])?; + + setup_gateway_iptables_rules_in_netns( + DUAL_GW_NS_A, + DUAL_WAN_IF_A, + DUAL_LAN_A_BRIDGE, + "MINIUPNPD_A", + "MINIUPNPD_A-POSTROUTING", + )?; + setup_gateway_iptables_rules_in_netns( + DUAL_GW_NS_C, + DUAL_WAN_IF_C, + DUAL_LAN_C_BRIDGE, + "MINIUPNPD_C", + "MINIUPNPD_C-POSTROUTING", + )?; + + run_cmd( + "ip", + &[ + "netns", + "exec", + DUAL_NS_A, + "ip", + "route", + "add", + "default", + "via", + &DUAL_GATEWAY_A_IP.to_string(), + "dev", + "veth_upnp2_a_g", + ], + )?; + run_cmd( + "ip", + &[ + "netns", + "exec", + DUAL_NS_C, + "ip", + "route", + "add", + "default", + "via", + &DUAL_GATEWAY_C_IP.to_string(), + "dev", + "veth_upnp2_c_g", + ], + )?; + run_cmd_in_netns(DUAL_GW_NS_A, "sysctl", &["-w", "net.ipv4.ip_forward=1"])?; + run_cmd_in_netns(DUAL_GW_NS_C, "sysctl", &["-w", "net.ipv4.ip_forward=1"])?; + Ok(()) +} + +fn cleanup_dual_gateway_test_net() { + cleanup_gateway_iptables_rules_in_netns( + DUAL_GW_NS_A, + DUAL_WAN_IF_A, + DUAL_LAN_A_BRIDGE, + "MINIUPNPD_A", + "MINIUPNPD_A-POSTROUTING", + ); + cleanup_gateway_iptables_rules_in_netns( + DUAL_GW_NS_C, + DUAL_WAN_IF_C, + DUAL_LAN_C_BRIDGE, + "MINIUPNPD_C", + "MINIUPNPD_C-POSTROUTING", + ); + + del_netns(DUAL_NS_A); + del_netns(DUAL_NS_C); + del_netns(DUAL_GW_NS_A); + del_netns(DUAL_GW_NS_C); + for iface in [DUAL_WAN_BRIDGE, DUAL_WAN_IF_A_PEER, DUAL_WAN_IF_C_PEER] { + let _ = Command::new("ip").args(["link", "del", iface]).output(); + } +} + +fn cleanup_miniupnpd_processes() { + let _ = Command::new("pkill").args(["-x", "miniupnpd"]).output(); +} + +fn setup_gateway_iptables_rules_in_netns( + netns: &str, + ext_if: &str, + lan_bridge: &str, + chain_name: &str, + postrouting_chain_name: &str, +) -> anyhow::Result<()> { + cleanup_gateway_iptables_rules_in_netns( + netns, + ext_if, + lan_bridge, + chain_name, + postrouting_chain_name, + ); + let iptables = find_iptables_legacy_bin()?; + + run_cmd_in_netns(netns, &iptables, &["-t", "nat", "-N", chain_name])?; + run_cmd_in_netns( + netns, + &iptables, + &[ + "-t", + "nat", + "-A", + "PREROUTING", + "-i", + ext_if, + "-j", + chain_name, + ], + )?; + run_cmd_in_netns( + netns, + &iptables, + &["-t", "nat", "-N", postrouting_chain_name], + )?; + run_cmd_in_netns( + netns, + &iptables, + &[ + "-t", + "nat", + "-A", + "POSTROUTING", + "-o", + ext_if, + "-j", + postrouting_chain_name, + ], + )?; + run_cmd_in_netns(netns, &iptables, &["-t", "mangle", "-N", chain_name])?; + run_cmd_in_netns( + netns, + &iptables, + &[ + "-t", + "mangle", + "-A", + "PREROUTING", + "-i", + ext_if, + "-j", + chain_name, + ], + )?; + run_cmd_in_netns(netns, &iptables, &["-N", chain_name])?; + run_cmd_in_netns( + netns, + &iptables, + &[ + "-A", "FORWARD", "-i", ext_if, "!", "-o", ext_if, "-j", chain_name, + ], + )?; + run_cmd_in_netns( + netns, + &iptables, + &[ + "-A", "FORWARD", "-i", lan_bridge, "-o", ext_if, "-j", "ACCEPT", + ], + )?; + Ok(()) +} + +fn cleanup_gateway_iptables_rules_in_netns( + netns: &str, + ext_if: &str, + lan_bridge: &str, + chain_name: &str, + postrouting_chain_name: &str, +) { + let Ok(iptables) = find_iptables_legacy_bin() else { + return; + }; + + let _ = run_cmd_in_netns( + netns, + &iptables, + &[ + "-t", + "nat", + "-D", + "PREROUTING", + "-i", + ext_if, + "-j", + chain_name, + ], + ); + let _ = run_cmd_in_netns( + netns, + &iptables, + &[ + "-t", + "nat", + "-D", + "POSTROUTING", + "-o", + ext_if, + "-j", + postrouting_chain_name, + ], + ); + let _ = run_cmd_in_netns( + netns, + &iptables, + &[ + "-t", + "mangle", + "-D", + "PREROUTING", + "-i", + ext_if, + "-j", + chain_name, + ], + ); + let _ = run_cmd_in_netns( + netns, + &iptables, + &[ + "-D", "FORWARD", "-i", ext_if, "!", "-o", ext_if, "-j", chain_name, + ], + ); + let _ = run_cmd_in_netns( + netns, + &iptables, + &[ + "-D", "FORWARD", "-i", lan_bridge, "-o", ext_if, "-j", "ACCEPT", + ], + ); + let _ = run_cmd_in_netns(netns, &iptables, &["-F", chain_name]); + let _ = run_cmd_in_netns(netns, &iptables, &["-X", chain_name]); + let _ = run_cmd_in_netns(netns, &iptables, &["-t", "mangle", "-F", chain_name]); + let _ = run_cmd_in_netns(netns, &iptables, &["-t", "mangle", "-X", chain_name]); + let _ = run_cmd_in_netns(netns, &iptables, &["-t", "nat", "-F", chain_name]); + let _ = run_cmd_in_netns(netns, &iptables, &["-t", "nat", "-X", chain_name]); + let _ = run_cmd_in_netns( + netns, + &iptables, + &["-t", "nat", "-F", postrouting_chain_name], + ); + let _ = run_cmd_in_netns( + netns, + &iptables, + &["-t", "nat", "-X", postrouting_chain_name], + ); +} + +fn run_cmd>(cmd: S, args: &[&str]) -> anyhow::Result<()> { + let cmd = cmd.as_ref(); + let output = Command::new(cmd) + .args(args) + .output() + .with_context(|| format!("run command {}", Path::new(cmd).display()))?; + if output.status.success() { + return Ok(()); + } + + Err(anyhow!( + "{} {:?} failed: stdout={}, stderr={}", + Path::new(cmd).display(), + args, + String::from_utf8_lossy(&output.stdout), + String::from_utf8_lossy(&output.stderr) + )) +} + +fn find_miniupnpd_bin() -> anyhow::Result { + for candidate in ["miniupnpd", "/usr/sbin/miniupnpd", "/sbin/miniupnpd"] { + let path = Path::new(candidate); + if candidate.contains('/') { + if path.exists() { + return Ok(path.to_path_buf()); + } + continue; + } + + if Command::new("sh") + .args(["-c", &format!("command -v {candidate}")]) + .stdout(Stdio::null()) + .stderr(Stdio::null()) + .status() + .map(|status| status.success()) + .unwrap_or(false) + { + return Ok(path.to_path_buf()); + } + } + + bail!("miniupnpd binary not found; install miniupnpd and miniupnpd-iptables") +} + +fn find_iptables_legacy_bin() -> anyhow::Result { + for candidate in [ + "/usr/sbin/iptables-legacy", + "/sbin/iptables-legacy", + "iptables-legacy", + ] { + let path = Path::new(candidate); + if candidate.contains('/') { + if path.exists() { + return Ok(path.to_path_buf()); + } + continue; + } + + if Command::new("sh") + .args(["-c", &format!("command -v {candidate}")]) + .stdout(Stdio::null()) + .stderr(Stdio::null()) + .status() + .map(|status| status.success()) + .unwrap_or(false) + { + return Ok(path.to_path_buf()); + } + } + + bail!("iptables-legacy binary not found; install iptables legacy backend") +} + +async fn query_mappings( + query_netns: &'static str, + expected_external_ip: Ipv4Addr, +) -> Result, Error> { + tokio::task::spawn_blocking(move || { + let _g = NetNS::new(Some(query_netns.to_owned())).guard(); + tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + .context("build runtime for test igd query")? + .block_on(async move { + let gateway = search_gateway(SearchOptions { + timeout: Some(Duration::from_secs(1)), + single_search_timeout: Some(Duration::from_millis(300)), + ..Default::default() + }) + .await + .context("discover igd gateway")?; + + let external_ip = + match gateway.get_external_ip().await.context("get external ip")? { + IpAddr::V4(ip) => ip, + ip => return Err(anyhow!("unexpected external ip family: {ip}")), + }; + + let mut entries = Vec::new(); + for index in 0..64 { + match gateway.get_generic_port_mapping_entry(index).await { + Ok(entry) => { + if entry.protocol == PortMappingProtocol::Udp + && entry.port_mapping_description == TEST_IGD_DESCRIPTION + { + entries.push(entry); + } + } + Err(GetGenericPortMappingEntryError::SpecifiedArrayIndexInvalid) => break, + Err(err) => return Err(anyhow!(err.to_string())), + } + } + + if external_ip != expected_external_ip { + return Err(anyhow!( + "unexpected external ip from gateway: expected {expected_external_ip}, got {external_ip}" + )); + } + + Ok(entries) + }) + }) + .await + .context("join test igd query task") + .map_err(Error::from)? + .map_err(Error::from) +} + +async fn query_udp_mapping( + query_netns: &'static str, + expected_external_ip: Ipv4Addr, + client_ip: Ipv4Addr, + local_port: u16, +) -> Result { + let entries = query_mappings(query_netns, expected_external_ip).await?; + let client_ip = client_ip.to_string(); + let entry = entries + .into_iter() + .find(|entry| entry.internal_client == client_ip && entry.internal_port == local_port) + .ok_or_else(|| Error::from(anyhow!("udp mapping not found for local port {local_port}")))?; + Ok(SocketAddr::new( + IpAddr::V4(expected_external_ip), + entry.external_port, + )) +} + +fn create_test_instance_config( + inst_name: &str, + netns: Option<&str>, + ipv4: &str, + ipv6: &str, +) -> TomlConfigLoader { + let config = TomlConfigLoader::default(); + config.set_inst_name(inst_name.to_owned()); + config.set_netns(netns.map(ToOwned::to_owned)); + config.set_ipv4(Some(ipv4.parse().unwrap())); + config.set_ipv6(Some(ipv6.parse().unwrap())); + config.set_listeners(vec!["udp://0.0.0.0:11010".parse().unwrap()]); + config +} + +fn create_test_instance_with_process_runtime( + inst_name: &str, + netns: Option<&str>, + ipv4: &str, + ipv6: &str, + stun_collector: Box>, + configure_flags: impl FnOnce(&mut crate::common::config::Flags), + process_runtime: Arc, +) -> Instance { + let config = create_test_instance_config(inst_name, netns, ipv4, ipv6); + let mut flags = config.get_flags(); + flags.disable_tcp_hole_punching = true; + configure_flags(&mut flags); + config.set_flags(flags); + + Instance::new_with_process_runtime_and_stun_provider(config, process_runtime, stun_collector) +} + +async fn wait_for_port_mapping_event( + receiver: &mut tokio::sync::broadcast::Receiver, +) -> GlobalCtxEvent { + tokio::time::timeout(Duration::from_secs(10), async { + loop { + match receiver.recv().await.unwrap() { + event @ GlobalCtxEvent::ListenerPortMappingEstablished { .. } => return event, + _ => continue, + } + } + }) + .await + .expect("timed out waiting for port mapping event") +} + +async fn timeout_stage(stage: &str, duration: Duration, fut: F) -> T +where + F: std::future::Future, +{ + tokio::time::timeout(duration, fut) + .await + .unwrap_or_else(|_| panic!("timed out at stage: {stage}")) +} + +async fn peer_has_udp_conn_to_remote_addr( + core: Arc, + peer_id: u32, + expected_remote_addr: SocketAddr, +) -> bool { + let Some(peer) = core + .peer_snapshots() + .await + .into_iter() + .find(|peer| peer.peer_id == peer_id) + else { + return false; + }; + + peer.conns.iter().any(|conn| { + let Some(tunnel) = conn.tunnel.as_ref() else { + return false; + }; + if tunnel.tunnel_type != "udp" { + return false; + } + + let Some(remote_addr) = tunnel.effective_remote_addr() else { + return false; + }; + let remote_addr: url::Url = remote_addr.clone().into(); + let Some(host) = remote_addr.host_str() else { + return false; + }; + let Ok(remote_ip) = host.parse::() else { + return false; + }; + + remote_ip == expected_remote_addr.ip() + && remote_addr.port() == Some(expected_remote_addr.port()) + }) +} + +async fn wait_instance_route( + inst: &Instance, + peer_id: u32, + cost: Option, +) -> Result<(), Error> { + let core = inst.get_core_instance(); + let now = std::time::Instant::now(); + while now.elapsed() < Duration::from_secs(5) { + if core + .route_snapshots() + .await + .iter() + .any(|route| route.peer_id == peer_id && cost.is_none_or(|cost| route.cost == cost)) + { + return Ok(()); + } + tokio::time::sleep(Duration::from_millis(50)).await; + } + Err(Error::NotFound) +} + +#[tokio::test] +#[serial_test::serial(upnp)] +async fn instances_build_direct_connection_via_upnp_udp_hole_punch() { + let _env = DualGatewayUpnpIntegrationEnv::new().await.unwrap(); + let process_runtime = CoreProcessRuntime::new(); + + let mut inst_a = create_test_instance_with_process_runtime( + "upnp-inst-a", + Some(DUAL_NS_A), + "10.144.200.1/24", + "fd20::1/64", + Box::new(GatewayBackedStunCollector { + netns: DUAL_NS_A, + client_ip: DUAL_CLIENT_A_IP, + external_ip: DUAL_EXTERNAL_A_IP, + }), + |flags| flags.need_p2p = true, + process_runtime.clone(), + ); + let mut event_rx_a = inst_a.get_global_ctx().subscribe(); + + let mut inst_b = create_test_instance_with_process_runtime( + "upnp-inst-b", + None, + "10.144.200.2/24", + "fd20::2/64", + Box::new(MockStunInfoCollector { + udp_nat_type: NatType::Unknown, + }), + |_| {}, + process_runtime.clone(), + ); + + let mut inst_c = create_test_instance_with_process_runtime( + "upnp-inst-c", + Some(DUAL_NS_C), + "10.144.200.3/24", + "fd20::3/64", + Box::new(GatewayBackedStunCollector { + netns: DUAL_NS_C, + client_ip: DUAL_CLIENT_C_IP, + external_ip: DUAL_EXTERNAL_C_IP, + }), + |flags| flags.need_p2p = true, + process_runtime, + ); + let mut event_rx_c = inst_c.get_global_ctx().subscribe(); + + inst_a.run().await.unwrap(); + inst_b.run().await.unwrap(); + inst_c.run().await.unwrap(); + + inst_a.add_connector_url(inst_b.ring_listener_url()); + inst_c.add_connector_url(inst_b.ring_listener_url()); + + timeout_stage( + "wait_route_appear(inst_a, inst_c)", + Duration::from_secs(10), + async { + wait_instance_route(&inst_a, inst_c.peer_id(), None).await?; + wait_instance_route(&inst_c, inst_a.peer_id(), None).await + }, + ) + .await + .unwrap(); + timeout_stage( + "wait_route_cost_2(inst_a -> inst_c)", + Duration::from_secs(10), + wait_instance_route(&inst_a, inst_c.peer_id(), Some(2)), + ) + .await + .unwrap(); + + timeout_stage( + "ping_over_relay_before_p2p", + Duration::from_secs(10), + wait_for_condition( + || async { ping_test(DUAL_NS_A, "10.144.200.3", None).await }, + Duration::from_secs(10), + ), + ) + .await; + + let event_a = timeout_stage( + "wait_instance_port_mapping_event(a)", + Duration::from_secs(15), + wait_for_port_mapping_event(&mut event_rx_a), + ) + .await; + let event_c = timeout_stage( + "wait_instance_port_mapping_event(c)", + Duration::from_secs(15), + wait_for_port_mapping_event(&mut event_rx_c), + ) + .await; + + let (local_port_a, mapped_port_a) = match event_a { + GlobalCtxEvent::ListenerPortMappingEstablished { + local_listener, + mapped_listener, + backend, + } => { + assert_eq!(backend, "igd"); + ( + local_listener.port().unwrap(), + mapped_listener.port().unwrap(), + ) + } + other => panic!("unexpected instance event for a: {other:?}"), + }; + let (local_port_c, mapped_port_c) = match event_c { + GlobalCtxEvent::ListenerPortMappingEstablished { + local_listener, + mapped_listener, + backend, + } => { + assert_eq!(backend, "igd"); + ( + local_listener.port().unwrap(), + mapped_listener.port().unwrap(), + ) + } + other => panic!("unexpected instance event for c: {other:?}"), + }; + + assert_ne!(mapped_port_a, local_port_a); + assert_ne!(mapped_port_c, local_port_c); + + let mapped_addr_a = timeout_stage( + "query_instance_udp_mapping(a)", + Duration::from_secs(10), + query_udp_mapping( + DUAL_NS_A, + DUAL_EXTERNAL_A_IP, + DUAL_CLIENT_A_IP, + local_port_a, + ), + ) + .await + .unwrap(); + let mapped_addr_c = timeout_stage( + "query_instance_udp_mapping(c)", + Duration::from_secs(10), + query_udp_mapping( + DUAL_NS_C, + DUAL_EXTERNAL_C_IP, + DUAL_CLIENT_C_IP, + local_port_c, + ), + ) + .await + .unwrap(); + + assert_eq!(mapped_addr_a.port(), mapped_port_a); + assert_eq!(mapped_addr_c.port(), mapped_port_c); + + timeout_stage( + "wait_instance_direct_peer_via_upnp_and_route_cost_1", + Duration::from_secs(20), + wait_for_condition( + || { + let core_a = inst_a.get_core_instance(); + let core_c = inst_c.get_core_instance(); + let peer_id_a = inst_a.peer_id(); + let peer_id_c = inst_c.peer_id(); + async move { + core_a.connected_peers().await.contains(&peer_id_c) + && core_c.connected_peers().await.contains(&peer_id_a) + && core_a + .route_snapshots() + .await + .iter() + .any(|route| route.peer_id == peer_id_c && route.cost == 1) + && core_c + .route_snapshots() + .await + .iter() + .any(|route| route.peer_id == peer_id_a && route.cost == 1) + && peer_has_udp_conn_to_remote_addr( + core_a.clone(), + peer_id_c, + mapped_addr_c, + ) + .await + && peer_has_udp_conn_to_remote_addr( + core_c.clone(), + peer_id_a, + mapped_addr_a, + ) + .await + } + }, + Duration::from_secs(20), + ), + ) + .await; + + timeout_stage( + "ping_over_direct_p2p_after_upnp", + Duration::from_secs(10), + wait_for_condition( + || async { ping_test(DUAL_NS_A, "10.144.200.3", None).await }, + Duration::from_secs(10), + ), + ) + .await; + + drop_insts(vec![inst_a, inst_b, inst_c]).await; +} diff --git a/vendor/easytier/easytier/src/tunnel/common.rs b/vendor/easytier/easytier/src/tunnel/common.rs new file mode 100644 index 0000000..71e8f44 --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/common.rs @@ -0,0 +1,559 @@ +use bon::builder; +use network_interface::NetworkInterfaceConfig as _; +use std::net::{IpAddr, SocketAddr}; + +use crate::common::netns::NetNS; +use easytier_core::tunnel::TunnelError; +use tokio::net::{TcpListener, TcpSocket, UdpSocket}; + +pub(crate) fn get_interface_name_by_ip(local_ip: &IpAddr) -> Option { + if local_ip.is_unspecified() || local_ip.is_multicast() { + return None; + } + let ifaces = network_interface::NetworkInterface::show().ok()?; + for iface in ifaces { + for addr in iface.addr { + if addr.ip() == *local_ip { + return Some(iface.name); + } + } + } + + tracing::error!(?local_ip, "can not find interface name by ip"); + None +} + +// region bind + +pub trait Bindable: Sized { + const TYPE: socket2::Type; + const PROTOCOL: Option; + + fn finalize(socket: socket2::Socket) -> Result; +} + +impl Bindable for TcpSocket { + const TYPE: socket2::Type = socket2::Type::STREAM; + const PROTOCOL: Option = Some(socket2::Protocol::TCP); + + fn finalize(socket: socket2::Socket) -> Result { + let socket = TcpSocket::from_std_stream(socket.into()); + + if let Err(error) = socket.set_nodelay(true) { + tracing::warn!(?error, "set_nodelay failed for tcp socket"); + } + + Ok(socket) + } +} + +impl Bindable for TcpListener { + const TYPE: socket2::Type = socket2::Type::STREAM; + const PROTOCOL: Option = Some(socket2::Protocol::TCP); + + fn finalize(socket: socket2::Socket) -> Result { + Ok(TcpSocket::finalize(socket)?.listen(1024)?) + } +} + +impl Bindable for UdpSocket { + const TYPE: socket2::Type = socket2::Type::DGRAM; + const PROTOCOL: Option = Some(socket2::Protocol::UDP); + + fn finalize(socket: socket2::Socket) -> Result { + Ok(UdpSocket::from_std(socket.into())?) + } +} + +fn setup_socket2_ext( + socket2_socket: &socket2::Socket, + bind_addr: &SocketAddr, + #[allow(unused_variables)] bind_dev: Option, + only_v6: bool, + reuse_addr: bool, + reuse_port: bool, +) -> Result<(), TunnelError> { + #[cfg(target_os = "windows")] + { + let is_udp = matches!(socket2_socket.r#type()?, socket2::Type::DGRAM); + crate::arch::windows::setup_socket_for_win(socket2_socket, bind_addr, bind_dev, is_udp)?; + } + + if bind_addr.is_ipv6() { + socket2_socket.set_only_v6(only_v6)?; + } + + socket2_socket.set_nonblocking(true)?; + socket2_socket.set_reuse_address(reuse_addr)?; + #[cfg(all(unix, not(target_os = "solaris"), not(target_os = "illumos")))] + if reuse_port { + socket2_socket.set_reuse_port(true)?; + } + #[cfg(not(all(unix, not(target_os = "solaris"), not(target_os = "illumos"))))] + { + let _ = reuse_port; + } + + if let Err(e) = socket2_socket.bind(&socket2::SockAddr::from(*bind_addr)) { + if bind_addr.is_ipv4() { + return Err(e.into()); + } else { + tracing::warn!(?e, "bind failed, do not return error for ipv6"); + } + } + + // linux/mac does not use interface of bind_addr to send packet, so we need to bind device + // win can handle this with bind correctly + #[cfg(any(target_os = "ios", target_os = "macos"))] + if let Some(dev_name) = bind_dev { + // use IP_BOUND_IF to bind device + let c_dev_name = std::ffi::CString::new(dev_name.clone()).map_err(|err| { + TunnelError::InvalidAddr(format!("invalid interface name {dev_name}: {err}")) + })?; + let dev_idx = unsafe { nix::libc::if_nametoindex(c_dev_name.as_ptr()) }; + let Some(dev_idx) = std::num::NonZeroU32::new(dev_idx) else { + return Err(TunnelError::InvalidAddr(format!( + "network interface not found: {dev_name}" + ))); + }; + tracing::warn!(?dev_idx, ?dev_name, "bind device"); + if bind_addr.is_ipv4() { + socket2_socket.bind_device_by_index_v4(Some(dev_idx))?; + } else { + socket2_socket.bind_device_by_index_v6(Some(dev_idx))?; + } + tracing::warn!(?dev_idx, ?dev_name, "bind device done"); + } + + #[cfg(any( + target_os = "android", + target_os = "fuchsia", + target_os = "linux", + target_env = "ohos" + ))] + if let Some(dev_name) = bind_dev { + tracing::trace!(dev_name = ?dev_name, "bind device"); + socket2_socket.bind_device(Some(dev_name.as_bytes()))?; + } + + Ok(()) +} + +/// Apply Linux SO_MARK (a.k.a. fwmark) to a `socket2::Socket`. `None` leaves +/// SO_MARK untouched (kernel default 0); `Some(mark)` applies that exact value +/// — including `Some(0)`, which is a legitimate mark. On non-Linux platforms +/// this is unconditionally a no-op. +/// +/// Exposed so transports that bypass [`bind`] (currently the WebSocket +/// default-bind path and FakeTCP) can apply the same mark. +pub fn apply_socket_mark( + socket: &socket2::Socket, + socket_mark: Option, +) -> Result<(), TunnelError> { + #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))] + if let Some(mark) = socket_mark { + tracing::trace!(socket_mark = mark, "set SO_MARK on socket"); + socket.set_mark(mark)?; + } + #[cfg(not(any(target_os = "android", target_os = "fuchsia", target_os = "linux")))] + { + let _ = (socket, socket_mark); + } + Ok(()) +} + +#[derive(Debug, Default, Clone)] +pub enum BindDev { + #[default] + Auto, + Disabled, + Custom(String), +} + +impl From for BindDev { + fn from(value: String) -> Self { + if value.is_empty() { + Self::Disabled + } else { + Self::Custom(value) + } + } +} + +impl From<&str> for BindDev { + fn from(value: &str) -> Self { + value.to_string().into() + } +} + +/// Binds a socket to a specific address and optionally a network interface. +/// +/// This function creates a new socket, applies specific configurations (such as +/// binding to a device or setting IPv6-only flags), and finalizes it into the +/// requested [`Bindable`] type. +/// Protection is acknowledged before bind/listen; namespace guards never cross +/// an await. Failures drop the unbound socket instead of allowing early I/O. +/// +/// # Arguments +/// +/// * `addr` - The `SocketAddr` to bind the socket to. +/// * `dev` - The name of the network interface to bind to: +/// * **(default) `BindDev::Auto`**: Enables **auto-discovery**. The function will attempt to automatically +/// resolve the interface name associated with the provided `addr.ip()`. +/// * **empty string or `BindDev::Disabled`**: **Disables** auto-discovery and +/// explicitly chooses **not** to bind to any specific device. The routing will be +/// left entirely to the OS. +/// * **non-empty string or `BindDev::Custom(..)`**: Skips auto-discovery and explicitly binds to +/// the specified interface. +/// * `net_ns` - An optional network namespace to switch into before creating the socket. +/// * `only_v6` - If `true`, sets the `IPV6_V6ONLY` flag on the socket. +/// +/// # Errors +/// +/// Returns a [`TunnelError`] if socket creation, configuration, or finalization fails. +#[builder] +pub async fn bind( + addr: SocketAddr, + #[builder(default, into)] dev: BindDev, + net_ns: Option, + #[builder(default)] only_v6: bool, + #[builder(default = !cfg!(target_os = "windows"))] reuse_addr: bool, + #[builder(default)] reuse_port: bool, + /// Linux SO_MARK (fwmark) to apply to the socket. `None` leaves SO_MARK + /// untouched; `Some(mark)` applies that exact value, including `Some(0)`. + socket_mark: Option, + #[builder(default)] need_protect: bool, +) -> Result { + let (socket, dev) = { + let _g = net_ns.as_ref().map(|n| n.guard()); + let dev = match dev { + BindDev::Auto => get_interface_name_by_ip(&addr.ip()), + BindDev::Disabled => None, + BindDev::Custom(s) => Some(s), + }; + let socket = + socket2::Socket::new(socket2::Domain::for_address(addr), B::TYPE, B::PROTOCOL)?; + // A platform protector may set its own routing mark. Never overwrite + // that mark with caller options after its acknowledgement. + apply_socket_mark(&socket, socket_mark)?; + (socket, dev) + }; + crate::socket_protector::protect_native_socket(&socket, need_protect).await?; + // Restore the requested namespace for synchronous bind/device lookup only. + let _g = net_ns.as_ref().map(|n| n.guard()); + setup_socket2_ext(&socket, &addr, dev, only_v6, reuse_addr, reuse_port)?; + B::finalize(socket) +} + +// endregion + +#[cfg(test)] +pub(crate) mod tests { + use atomic_shim::AtomicU64; + use std::{sync::Arc, time::Instant}; + + use futures::{Future, SinkExt, StreamExt}; + use tokio_util::bytes::{BufMut, Bytes, BytesMut}; + + use easytier_core::{ + connectivity::protocol::raw::TunnelDialer, packet::ZCPacket, socket::SocketListener, + tunnel::Tunnel, + }; + + use crate::common::netns::NetNS; + + #[cfg(any(target_os = "android", target_os = "fuchsia", target_os = "linux"))] + #[test] + fn apply_socket_mark_none_is_noop_and_does_not_error() { + // The contract for `None` is "no syscall is made and no error is + // returned" — must not require CAP_NET_ADMIN to call. + let socket = socket2::Socket::new( + socket2::Domain::IPV4, + socket2::Type::DGRAM, + Some(socket2::Protocol::UDP), + ) + .unwrap(); + super::apply_socket_mark(&socket, None).unwrap(); + } + + #[cfg(target_os = "linux")] + #[test] + #[ignore = "requires CAP_NET_ADMIN; run as root or with sudo -E cargo test"] + fn apply_socket_mark_sets_so_mark_when_capable() { + use nix::libc; + use std::os::fd::AsRawFd; + + fn read_so_mark(s: &socket2::Socket) -> u32 { + let mut value: libc::c_int = 0; + let mut len = std::mem::size_of::() as libc::socklen_t; + let r = unsafe { + libc::getsockopt( + s.as_raw_fd(), + libc::SOL_SOCKET, + libc::SO_MARK, + &mut value as *mut _ as *mut libc::c_void, + &mut len, + ) + }; + assert_eq!(r, 0, "getsockopt(SO_MARK) failed"); + value as u32 + } + + let socket = socket2::Socket::new( + socket2::Domain::IPV4, + socket2::Type::DGRAM, + Some(socket2::Protocol::UDP), + ) + .unwrap(); + super::apply_socket_mark(&socket, Some(0x1234)) + .expect("set_mark failed; need CAP_NET_ADMIN"); + assert_eq!(read_so_mark(&socket), 0x1234); + + // Some(0) is a legitimate value: it must reach setsockopt and clear + // the mark, distinct from None which makes no syscall. + super::apply_socket_mark(&socket, Some(0)).expect("set_mark(0) failed"); + assert_eq!(read_so_mark(&socket), 0); + } + + #[cfg(any( + target_os = "android", + target_os = "fuchsia", + target_os = "linux", + target_env = "ohos" + ))] + #[tokio::test] + async fn bind_custom_device_is_applied_for_unspecified_addr() { + use std::net::SocketAddr; + use tokio::net::UdpSocket; + + let addr: SocketAddr = "0.0.0.0:0".parse().unwrap(); + let _err = super::bind::() + .addr(addr) + .dev("et/invalid-device-name") + .call() + .await + .expect_err("custom device must not be skipped for unspecified bind addr"); + } + + pub async fn _tunnel_echo_server(tunnel: Box, once: bool) { + let (mut recv, mut send) = tunnel.split(); + + if !once { + while let Some(item) = recv.next().await { + let Ok(msg) = item else { + continue; + }; + tracing::debug!(?msg, "recv a msg, try echo back"); + if send.send(msg).await.is_err() { + break; + } + } + } else { + let Some(ret) = recv.next().await else { + panic!("recv error"); + }; + + if ret.is_err() { + tracing::debug!(?ret, "recv error"); + return; + } + + let res = ret.unwrap(); + tracing::debug!(?res, "recv a msg, try echo back"); + send.send(res).await.unwrap(); + } + let _ = send.flush().await; + let _ = send.close().await; + + tracing::warn!("echo server exit..."); + } + + async fn _tunnel_pingpong_netns( + mut listener: L, + connector: C, + l_netns: NetNS, + c_netns: NetNS, + buf: Vec, + ) where + L: SocketListener> + Sync + 'static, + C: TunnelDialer, + { + l_netns + .run_async(|| async { + listener.listen().await.unwrap(); + }) + .await; + + let lis = tokio::spawn(async move { + let ret = listener.accept().await.unwrap(); + println!("accept: {:?}", ret.info()); + assert_eq!( + url::Url::from(ret.info().unwrap().local_addr.unwrap()), + listener.local_url() + ); + _tunnel_echo_server(ret, false).await + }); + + let tunnel = c_netns.run_async(|| connector.connect()).await.unwrap(); + println!("connect: {:?}", tunnel.info()); + + if connector.remote_url().scheme() == "faketcp" { + // listener need some time to start capturing packet + tokio::time::sleep(std::time::Duration::from_millis(100)).await; + } + + assert_eq!( + url::Url::from(tunnel.info().unwrap().remote_addr.unwrap()), + connector.remote_url(), + ); + + let (mut recv, mut send) = tunnel.split(); + + send.send(ZCPacket::new_with_payload(buf.as_slice())) + .await + .unwrap(); + + let ret = tokio::time::timeout(tokio::time::Duration::from_secs(1), recv.next()) + .await + .unwrap() + .unwrap() + .unwrap(); + println!("echo back: {:?}", ret); + assert_eq!(ret.payload(), Bytes::from(buf)); + + send.close().await.unwrap(); + + if ["udp", "wg"].contains(&connector.remote_url().scheme()) { + lis.abort(); + } else { + // lis should finish in 1 second + let ret = tokio::time::timeout(tokio::time::Duration::from_secs(1), lis).await; + assert!(ret.is_ok()); + } + } + + pub(crate) async fn _tunnel_pingpong_netns_with_timeout( + listener: L, + connector: C, + l_netns: NetNS, + c_netns: NetNS, + buf: Vec, + timeout: std::time::Duration, + ) -> Result<(), anyhow::Error> + where + L: SocketListener> + Sync + 'static, + C: TunnelDialer, + { + let handle = tokio::spawn(async move { + _tunnel_pingpong_netns(listener, connector, l_netns, c_netns, buf).await; + }); + + match tokio::time::timeout(timeout, handle).await { + Ok(join_res) => match join_res { + Ok(_) => Ok(()), + Err(join_err) => { + if join_err.is_panic() { + let payload = join_err.into_panic(); + let msg = match payload.downcast::() { + Ok(s) => *s, + Err(payload) => match payload.downcast::<&str>() { + Ok(s) => (*s).to_string(), + Err(_) => "non-string panic payload".to_string(), + }, + }; + Err(anyhow::anyhow!("task panicked: {}", msg)) + } else { + Err(anyhow::anyhow!("task cancelled")) + } + } + }, + Err(elapsed) => Err(elapsed.into()), + } + } + + pub(crate) async fn _tunnel_bench_netns( + mut listener: L, + connector: C, + netns_l: NetNS, + netns_c: NetNS, + ) -> usize + where + L: SocketListener> + Sync + 'static, + C: TunnelDialer, + { + { + let _g = netns_l.guard(); + listener.listen().await.unwrap(); + } + + let bps = Arc::new(AtomicU64::new(0)); + let bps_clone = bps.clone(); + + let lis = tokio::spawn(async move { + let ret = listener.accept().await.unwrap(); + // _tunnel_echo_server(ret, false).await + let (mut r, _s) = ret.split(); + let now = Instant::now(); + let mut count = 0; + let warmup = std::time::Duration::from_secs(1); + while let Some(Ok(p)) = r.next().await { + let elapsed = now.elapsed(); + if elapsed < warmup { + continue; + } + count += p.payload_len(); + let elapsed = (elapsed - warmup).as_secs(); + if elapsed >= 1 { + bps_clone.store(count as u64 / elapsed, std::sync::atomic::Ordering::Relaxed); + } + } + }); + + let tunnel = { + let _g = netns_c.guard(); + connector.connect().await.unwrap() + }; + + let (_recv, mut send) = tunnel.split(); + + // prepare a 4k buffer with random data + let mut send_buf = BytesMut::new(); + for _ in 0..64 { + send_buf.put_i128(rand::random::()); + } + + let now = Instant::now(); + while now.elapsed().as_secs() < 10 { + // send.feed(item) + let item = ZCPacket::new_with_payload(send_buf.as_ref()); + send.feed(item).await.unwrap(); + } + + send.close().await.unwrap(); + drop(send); + drop(connector); + drop(tunnel); + + tracing::warn!("wait for recv to finish..."); + let bps = bps.load(std::sync::atomic::Ordering::Acquire); + println!("bps: {}", bps); + + lis.abort(); + bps as usize + } + + pub async fn wait_for_condition(mut condition: F, timeout: std::time::Duration) + where + F: FnMut() -> FRet + Send, + FRet: Future, + { + let now = std::time::Instant::now(); + while now.elapsed() < timeout { + if condition().await { + return; + } + tokio::time::sleep(std::time::Duration::from_millis(50)).await; + } + assert!(condition().await, "Timeout") + } +} diff --git a/vendor/easytier/easytier/src/tunnel/mod.rs b/vendor/easytier/easytier/src/tunnel/mod.rs new file mode 100644 index 0000000..5106c23 --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/mod.rs @@ -0,0 +1,186 @@ +use std::{collections::hash_map::DefaultHasher, hash::Hasher, net::SocketAddr}; + +#[cfg(any(feature = "faketcp", feature = "websocket", feature = "wireguard"))] +use crate::common::dns::socket_addrs; +use crate::common::error::Error; +use derive_more::{From, TryInto}; +#[cfg(any(feature = "faketcp", feature = "websocket", feature = "wireguard"))] +use easytier_core::tunnel::{IpVersion, TunnelError}; +use strum::{Display, EnumString, IntoStaticStr, VariantArray}; + +pub mod common; +pub(crate) mod protocol; + +#[cfg(feature = "wireguard")] +pub mod wireguard; + +#[cfg(feature = "quic")] +pub mod quic; + +#[cfg(feature = "websocket")] +pub mod websocket; + +pub fn build_url_from_socket_addr(addr: &String, scheme: &str) -> url::Url { + if let Ok(sock_addr) = addr.parse::() { + let url_str = format!("{}://0.0.0.0", scheme); + let mut ret_url = url::Url::parse(url_str.as_str()) + .unwrap_or_else(|_| panic!("invalid url: {}", url_str)); + ret_url.set_ip_host(sock_addr.ip()).unwrap(); + ret_url.set_port(Some(sock_addr.port())).unwrap(); + ret_url + } else { + url::Url::parse(format!("{}://{}", scheme, addr).as_str()).unwrap() + } +} + +#[async_trait::async_trait] +#[cfg(any(feature = "faketcp", feature = "websocket", feature = "wireguard"))] +pub(crate) trait FromUrl { + async fn from_url(url: url::Url, ip_version: IpVersion) -> Result + where + Self: Sized; +} + +#[async_trait::async_trait] +#[cfg(any(feature = "faketcp", feature = "websocket", feature = "wireguard"))] +impl FromUrl for SocketAddr { + async fn from_url(url: url::Url, ip_version: IpVersion) -> Result { + let addrs = socket_addrs(&url, || { + (&url) + .try_into() + .ok() + .and_then(|s: TunnelScheme| s.try_into().ok()) + .map(IpScheme::default_port) + }) + .await + .map_err(|e| { + TunnelError::InvalidAddr(format!( + "failed to resolve socket addr, url: {}, error: {}", + url, e + )) + })?; + tracing::debug!(?addrs, ?ip_version, ?url, "convert url to socket addrs"); + let addrs = addrs + .into_iter() + .filter(|addr| match ip_version { + IpVersion::V4 => addr.is_ipv4(), + IpVersion::V6 => addr.is_ipv6(), + IpVersion::Both => true, + }) + .collect::>(); + + use rand::seq::SliceRandom; + // randomly select one address + addrs + .choose(&mut rand::thread_rng()) + .copied() + .ok_or(TunnelError::NoDnsRecordFound(ip_version)) + } +} + +pub struct TunnelUrl { + inner: url::Url, +} + +impl From for TunnelUrl { + fn from(url: url::Url) -> Self { + TunnelUrl { inner: url } + } +} + +impl From for url::Url { + fn from(url: TunnelUrl) -> Self { + url.into_inner() + } +} + +impl TunnelUrl { + pub fn into_inner(self) -> url::Url { + self.inner + } + + pub fn bind_dev(&self) -> Option { + self.inner.path().strip_prefix("/").and_then(|s| { + if s.is_empty() { + None + } else { + Some(String::from_utf8(percent_encoding::percent_decode_str(s).collect()).unwrap()) + } + }) + } +} + +pub fn generate_digest_from_str(str1: &str, str2: &str, digest: &mut [u8]) { + let mut hasher = DefaultHasher::new(); + hasher.write(str1.as_bytes()); + hasher.write(str2.as_bytes()); + + assert_eq!(digest.len() % 8, 0, "digest length must be multiple of 8"); + + let shard_count = digest.len() / 8; + for i in 0..shard_count { + digest[i * 8..(i + 1) * 8].copy_from_slice(&hasher.finish().to_be_bytes()); + hasher.write(&digest[..(i + 1) * 8]); + } +} + +#[derive(Debug, Clone, Copy, PartialEq, Display, EnumString, IntoStaticStr, VariantArray)] +#[strum(serialize_all = "lowercase")] +pub enum IpScheme { + Tcp, + Udp, + #[cfg(feature = "wireguard")] + Wg, + #[cfg(feature = "quic")] + Quic, + #[cfg(feature = "websocket")] + Ws, + #[cfg(feature = "websocket")] + Wss, + #[cfg(feature = "faketcp")] + FakeTcp, +} + +impl IpScheme { + pub fn port_offset(self) -> u16 { + let scheme: &'static str = self.into(); + easytier_core::connectivity::protocol::protocol_port_offset(scheme) + .expect("IpScheme must have core protocol metadata") + } + + pub fn default_port(self) -> u16 { + let scheme: &'static str = self.into(); + easytier_core::connectivity::protocol::protocol_default_port(scheme) + .expect("IpScheme must have core protocol metadata") + } +} + +#[derive(Debug, Clone, Copy, PartialEq, EnumString, From, TryInto)] +#[strum(serialize_all = "lowercase")] +pub enum TunnelScheme { + #[strum(disabled)] + Ip(IpScheme), + #[cfg(unix)] + Unix, + // Only for connector + Http, + Https, + Ring, + Txt, + Srv, +} + +impl TryFrom<&url::Url> for TunnelScheme { + type Error = Error; + + fn try_from(value: &url::Url) -> Result { + let scheme = value.scheme(); + scheme.parse().or_else(|_| { + Ok(TunnelScheme::Ip( + scheme + .parse() + .map_err(|_| Error::InvalidUrl(value.to_string()))?, + )) + }) + } +} diff --git a/vendor/easytier/easytier/src/tunnel/protocol.rs b/vendor/easytier/easytier/src/tunnel/protocol.rs new file mode 100644 index 0000000..1666cd4 --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/protocol.rs @@ -0,0 +1,481 @@ +use std::sync::Arc; + +use async_trait::async_trait; +use easytier_core::{ + connectivity::{ + protocol::{ + ClientProtocolUpgrader, CoreClientProtocolConfig, CoreClientProtocolUpgrader, + CoreServerProtocolConfig, CoreServerProtocolUpgrader, ServerProtocolAdmission, + ServerProtocolUpgrade, ServerProtocolUpgrader, + }, + transport::ConnectedTransport, + }, + socket::udp::UdpSession, + tunnel::Tunnel, +}; + +use crate::{common::global_ctx::ArcGlobalCtx, socket::tcp::RuntimeTcpSocket}; + +mod adapters; + +pub(crate) struct RuntimeClientProtocolUpgrader { + adapters: Vec, +} + +pub(crate) struct RuntimeServerProtocolUpgrader { + adapters: Vec, +} + +fn runtime_client_protocol_adapter(global_ctx: &ArcGlobalCtx) -> RuntimeClientProtocolUpgrader { + RuntimeClientProtocolUpgrader { + adapters: adapters::client_adapters(global_ctx), + } +} + +fn runtime_server_protocol_adapter(global_ctx: &ArcGlobalCtx) -> RuntimeServerProtocolUpgrader { + RuntimeServerProtocolUpgrader { + adapters: adapters::server_adapters(global_ctx), + } +} + +pub(crate) fn runtime_client_protocol_upgrader( + global_ctx: ArcGlobalCtx, +) -> Arc> { + Arc::new(CoreClientProtocolUpgrader::with_external( + CoreClientProtocolConfig { + unix: cfg!(unix), + faketcp: cfg!(feature = "faketcp"), + }, + Arc::new(runtime_client_protocol_adapter(&global_ctx)), + )) +} + +pub(crate) fn runtime_server_protocol_upgrader( + global_ctx: ArcGlobalCtx, +) -> Arc> { + Arc::new(CoreServerProtocolUpgrader::with_external( + CoreServerProtocolConfig { + unix: cfg!(unix), + faketcp: cfg!(feature = "faketcp"), + }, + Arc::new(runtime_server_protocol_adapter(&global_ctx)), + )) +} + +#[async_trait] +impl ClientProtocolUpgrader for RuntimeClientProtocolUpgrader { + fn supports_scheme(&self, scheme: &str) -> bool { + self.adapters + .iter() + .any(|adapter| adapter.supports_scheme(scheme)) + } + + fn connect_timeout(&self, scheme: &str) -> Option { + self.adapters + .iter() + .find(|adapter| adapter.supports_scheme(scheme)) + .and_then(|adapter| adapter.connect_timeout(scheme)) + } + + async fn upgrade_client( + &self, + connected: ConnectedTransport, + requested_url: url::Url, + ) -> anyhow::Result> { + let scheme = requested_url.scheme().to_owned(); + let adapter = self + .adapters + .iter() + .find(|adapter| adapter.supports_scheme(&scheme)) + .ok_or_else(|| anyhow::anyhow!("unsupported client protocol upgrader: {scheme}"))?; + adapter.upgrade_client(connected, requested_url).await + } +} + +#[async_trait] +impl ServerProtocolUpgrader for RuntimeServerProtocolUpgrader { + fn supports_scheme(&self, scheme: &str) -> bool { + self.adapters + .iter() + .any(|adapter| adapter.supports_scheme(scheme)) + } + + fn max_pending_tcp_upgrades(&self, scheme: &str) -> Option { + self.adapters + .iter() + .find(|adapter| adapter.supports_scheme(scheme)) + .and_then(|adapter| adapter.max_pending_tcp_upgrades(scheme)) + } + + async fn upgrade_tcp( + &self, + socket: RuntimeTcpSocket, + local_url: url::Url, + ) -> anyhow::Result { + let scheme = local_url.scheme().to_owned(); + let adapter = self + .adapters + .iter() + .find(|adapter| adapter.supports_scheme(&scheme)) + .ok_or_else(|| { + anyhow::anyhow!("unsupported native TCP server protocol upgrader: {scheme}") + })?; + adapter.upgrade_tcp(socket, local_url).await + } + + async fn upgrade_udp( + &self, + session: UdpSession, + local_url: url::Url, + admission: Option, + ) -> anyhow::Result { + let scheme = local_url.scheme().to_owned(); + let adapter = self + .adapters + .iter() + .find(|adapter| adapter.supports_scheme(&scheme)) + .ok_or_else(|| { + anyhow::anyhow!("unsupported native UDP server protocol upgrader: {scheme}") + })?; + adapter.upgrade_udp(session, local_url, admission).await + } + + async fn upgrade_byte_stream( + &self, + socket: RuntimeTcpSocket, + local_url: url::Url, + remote_url: Option, + ) -> anyhow::Result { + let scheme = local_url.scheme().to_owned(); + let adapter = self + .adapters + .iter() + .find(|adapter| adapter.supports_scheme(&scheme)) + .ok_or_else(|| { + anyhow::anyhow!("unsupported native byte-stream server protocol upgrader: {scheme}") + })?; + adapter + .upgrade_byte_stream(socket, local_url, remote_url) + .await + } +} + +#[cfg(test)] +mod tests { + use crate::common::global_ctx::tests::get_mock_global_ctx; + + use super::*; + + #[tokio::test] + async fn protocol_capabilities_follow_enabled_features() { + let global_ctx = get_mock_global_ctx(); + let external = runtime_client_protocol_adapter(&global_ctx); + + assert!(!external.supports_scheme("tcp")); + assert!(!external.supports_scheme("faketcp")); + assert_eq!(external.supports_scheme("ws"), cfg!(feature = "websocket")); + assert_eq!(external.supports_scheme("wss"), cfg!(feature = "websocket")); + assert_eq!(external.supports_scheme("wg"), cfg!(feature = "wireguard")); + assert_eq!(external.supports_scheme("quic"), cfg!(feature = "quic")); + + let upgrader = runtime_client_protocol_upgrader(global_ctx.clone()); + + assert!(upgrader.supports_scheme("tcp")); + assert!(upgrader.supports_scheme("udp")); + assert!(upgrader.supports_scheme("ring")); + assert_eq!(upgrader.supports_scheme("unix"), cfg!(unix)); + assert_eq!(upgrader.supports_scheme("ws"), cfg!(feature = "websocket")); + assert_eq!(upgrader.supports_scheme("wss"), cfg!(feature = "websocket")); + assert_eq!(upgrader.supports_scheme("wg"), cfg!(feature = "wireguard")); + assert_eq!(upgrader.supports_scheme("quic"), cfg!(feature = "quic")); + assert_eq!( + upgrader.supports_scheme("faketcp"), + cfg!(feature = "faketcp") + ); + + let server_external = runtime_server_protocol_adapter(&global_ctx); + assert!(!server_external.supports_scheme("tcp")); + assert!(!server_external.supports_scheme("udp")); + assert!(!server_external.supports_scheme("ring")); + assert_eq!( + server_external.supports_scheme("ws"), + cfg!(feature = "websocket") + ); + assert_eq!( + server_external.max_pending_tcp_upgrades("ws"), + cfg!(feature = "websocket").then_some(std::num::NonZeroUsize::MIN) + ); + assert_eq!( + server_external.supports_scheme("wg"), + cfg!(feature = "wireguard") + ); + assert_eq!( + server_external.supports_scheme("quic"), + cfg!(feature = "quic") + ); + + let server = runtime_server_protocol_upgrader(global_ctx); + assert!(server.supports_scheme("tcp")); + assert!(server.supports_scheme("udp")); + assert!(server.supports_scheme("ring")); + assert_eq!(server.supports_scheme("unix"), cfg!(unix)); + assert_eq!(server.supports_scheme("ws"), cfg!(feature = "websocket")); + assert_eq!(server.supports_scheme("wg"), cfg!(feature = "wireguard")); + assert_eq!(server.supports_scheme("quic"), cfg!(feature = "quic")); + } + + #[cfg(feature = "websocket")] + #[rstest::rstest] + #[case("ws")] + #[case("wss")] + #[tokio::test] + async fn runtime_websocket_upgraders_share_one_native_engine(#[case] scheme: &str) { + use easytier_core::packet::ZCPacket; + use futures::{SinkExt, StreamExt}; + + let listener = tokio::net::TcpListener::bind(("127.0.0.1", 0)) + .await + .unwrap(); + let addr = listener.local_addr().unwrap(); + let url: url::Url = format!("{scheme}://{addr}").parse().unwrap(); + let global_ctx = get_mock_global_ctx(); + let server = runtime_server_protocol_upgrader(global_ctx.clone()); + let client = runtime_client_protocol_upgrader(global_ctx); + + assert_eq!( + client.connect_timeout(scheme), + Some(crate::tunnel::websocket::CONNECT_TIMEOUT) + ); + + let server_url = url.clone(); + let server_task = tokio::spawn(async move { + let (socket, _) = listener.accept().await.unwrap(); + let ServerProtocolUpgrade::Tunnel(tunnel) = server + .upgrade_tcp(RuntimeTcpSocket::new(socket), server_url) + .await + .unwrap() + else { + panic!("WebSocket must upgrade directly to a tunnel"); + }; + crate::tunnel::common::tests::_tunnel_echo_server(tunnel, true).await; + }); + + tokio::time::timeout(std::time::Duration::from_secs(5), async { + let socket = tokio::net::TcpStream::connect(addr).await.unwrap(); + let tunnel = client + .upgrade_client(ConnectedTransport::Tcp(RuntimeTcpSocket::new(socket)), url) + .await + .unwrap(); + let (mut recv, mut send) = tunnel.split(); + send.send(ZCPacket::new_with_payload(b"runtime websocket seam")) + .await + .unwrap(); + let packet = recv.next().await.unwrap().unwrap(); + assert_eq!(packet.payload(), b"runtime websocket seam".as_slice()); + send.close().await.unwrap(); + server_task.await.unwrap(); + }) + .await + .unwrap(); + } + + #[cfg(feature = "websocket")] + #[tokio::test] + async fn runtime_websocket_upgraders_reject_ws_client_for_wss_server() { + let listener = tokio::net::TcpListener::bind(("127.0.0.1", 0)) + .await + .unwrap(); + let addr = listener.local_addr().unwrap(); + let server_url: url::Url = format!("wss://{addr}").parse().unwrap(); + let client_url: url::Url = format!("ws://{addr}").parse().unwrap(); + let global_ctx = get_mock_global_ctx(); + let server = runtime_server_protocol_upgrader(global_ctx.clone()); + let client = runtime_client_protocol_upgrader(global_ctx); + + let server_task = tokio::spawn(async move { + let (socket, _) = listener.accept().await.unwrap(); + assert!( + server + .upgrade_tcp(RuntimeTcpSocket::new(socket), server_url) + .await + .is_err() + ); + }); + + tokio::time::timeout(std::time::Duration::from_secs(5), async { + let socket = tokio::net::TcpStream::connect(addr).await.unwrap(); + assert!( + client + .upgrade_client( + ConnectedTransport::Tcp(RuntimeTcpSocket::new(socket)), + client_url, + ) + .await + .is_err() + ); + server_task.await.unwrap(); + }) + .await + .unwrap(); + } + + #[cfg(feature = "wireguard")] + #[rstest::rstest] + #[case("127.0.0.1:0")] + #[case("[::1]:0")] + #[tokio::test] + async fn runtime_wireguard_upgraders_consume_core_udp_sessions(#[case] bind_addr: &str) { + use crate::{ + common::netns::NetNS, host_runtime::native_host_runtime, + socket::udp::new_runtime_udp_session_listener, + }; + use easytier_core::{ + connectivity::transport::{UdpSessionMode, connect_udp}, + packet::ZCPacket, + socket::SocketListener, + socket::udp::{ + UdpBindOptions, UdpSessionAcceptKind, UdpSessionListenRequest, UdpSessionProtocol, + VirtualUdpSocket, + }, + }; + use futures::{SinkExt, StreamExt}; + + let bind_addr = bind_addr.parse().unwrap(); + let mut listener = new_runtime_udp_session_listener( + format!("wg://{bind_addr}").parse().unwrap(), + UdpSessionListenRequest::new( + UdpBindOptions::port_bound_listener(bind_addr).with_only_v6(bind_addr.is_ipv6()), + ), + UdpSessionAcceptKind::Classified(UdpSessionProtocol::WireGuard), + NetNS::new(None), + ); + listener.listen().await.unwrap(); + let remote_addr = listener.bound_socket().unwrap().local_addr().unwrap(); + let remote_url: url::Url = format!("wg://{remote_addr}").parse().unwrap(); + + let global_ctx = get_mock_global_ctx(); + let server = runtime_server_protocol_upgrader(global_ctx.clone()); + let client = runtime_client_protocol_upgrader(global_ctx); + let server_url = remote_url.clone(); + let server_task = tokio::spawn(async move { + let session = listener.accept().await.unwrap(); + let ServerProtocolUpgrade::Tunnel(tunnel) = + server.upgrade_udp(session, server_url, None).await.unwrap() + else { + panic!("WireGuard must upgrade directly to a tunnel"); + }; + crate::tunnel::common::tests::_tunnel_echo_server(tunnel, false).await; + }); + + tokio::time::timeout(std::time::Duration::from_secs(5), async { + let connected = connect_udp( + native_host_runtime(), + remote_addr, + Vec::new(), + UdpBindOptions::direct_connect(), + UdpSessionMode::Classified(UdpSessionProtocol::WireGuard), + ) + .await + .unwrap(); + let tunnel = client + .upgrade_client(ConnectedTransport::Udp(connected), remote_url) + .await + .unwrap(); + let (mut recv, mut send) = tunnel.split(); + send.send(ZCPacket::new_with_payload(b"runtime WireGuard seam")) + .await + .unwrap(); + let packet = recv.next().await.unwrap().unwrap(); + assert_eq!(packet.payload(), b"runtime WireGuard seam".as_slice()); + let _ = send.close().await; + server_task.abort(); + let _ = server_task.await; + }) + .await + .unwrap(); + } + + #[cfg(feature = "quic")] + #[rstest::rstest] + #[case("127.0.0.1:0")] + #[case("[::1]:0")] + #[tokio::test] + async fn runtime_quic_upgraders_consume_core_udp_sessions(#[case] bind_addr: &str) { + use crate::{ + common::netns::NetNS, host_runtime::native_host_runtime, + socket::udp::new_runtime_udp_session_listener, + }; + use easytier_core::{ + connectivity::{ + protocol::ServerProtocolAdmissionController, + transport::{UdpSessionMode, connect_udp}, + }, + packet::ZCPacket, + socket::SocketListener, + socket::udp::{ + UdpBindOptions, UdpSessionAcceptKind, UdpSessionListenRequest, UdpSessionProtocol, + VirtualUdpSocket, + }, + }; + use futures::{SinkExt, StreamExt}; + + let bind_addr = bind_addr.parse().unwrap(); + let mut listener = new_runtime_udp_session_listener( + format!("quic://{bind_addr}").parse().unwrap(), + UdpSessionListenRequest::new( + UdpBindOptions::port_bound_listener(bind_addr).with_only_v6(bind_addr.is_ipv6()), + ), + UdpSessionAcceptKind::Classified(UdpSessionProtocol::Quic), + NetNS::new(None), + ); + listener.listen().await.unwrap(); + let remote_addr = listener.bound_socket().unwrap().local_addr().unwrap(); + let remote_url: url::Url = format!("quic://{remote_addr}").parse().unwrap(); + + let global_ctx = get_mock_global_ctx(); + let server = runtime_server_protocol_upgrader(global_ctx.clone()); + let client = runtime_client_protocol_upgrader(global_ctx); + let server_url = remote_url.clone(); + let server_task = tokio::spawn(async move { + let session = listener.accept().await.unwrap(); + let admission = ServerProtocolAdmissionController::quic() + .try_admit() + .unwrap(); + let ServerProtocolUpgrade::Acceptor(mut accepted) = server + .upgrade_udp(session, server_url, Some(admission)) + .await + .unwrap() + else { + panic!("QUIC must keep accepting connections from its UDP session"); + }; + let tunnel = accepted.accept().await.unwrap(); + crate::tunnel::common::tests::_tunnel_echo_server(tunnel, false).await; + }); + + tokio::time::timeout(std::time::Duration::from_secs(5), async { + let connected = connect_udp( + native_host_runtime(), + remote_addr, + Vec::new(), + UdpBindOptions::direct_connect(), + UdpSessionMode::Classified(UdpSessionProtocol::Quic), + ) + .await + .unwrap(); + let tunnel = client + .upgrade_client(ConnectedTransport::Udp(connected), remote_url) + .await + .unwrap(); + let (mut recv, mut send) = tunnel.split(); + send.send(ZCPacket::new_with_payload(b"runtime QUIC seam")) + .await + .unwrap(); + let packet = recv.next().await.unwrap().unwrap(); + assert_eq!(packet.payload(), b"runtime QUIC seam".as_slice()); + let _ = send.close().await; + server_task.await.unwrap(); + }) + .await + .unwrap(); + } +} diff --git a/vendor/easytier/easytier/src/tunnel/protocol/adapters/mod.rs b/vendor/easytier/easytier/src/tunnel/protocol/adapters/mod.rs new file mode 100644 index 0000000..b103972 --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/protocol/adapters/mod.rs @@ -0,0 +1,43 @@ +use std::sync::Arc; + +use easytier_core::connectivity::protocol::{ClientProtocolUpgrader, ServerProtocolUpgrader}; + +use crate::{common::global_ctx::ArcGlobalCtx, socket::tcp::RuntimeTcpSocket}; + +#[cfg(feature = "quic")] +mod quic; +#[cfg(feature = "websocket")] +mod websocket; +#[cfg(feature = "wireguard")] +mod wireguard; + +pub(super) type ClientAdapter = Arc>; +pub(super) type ServerAdapter = Arc>; + +pub(super) fn client_adapters(global_ctx: &ArcGlobalCtx) -> Vec { + let _ = global_ctx; + [ + #[cfg(feature = "websocket")] + websocket::client_adapter(global_ctx), + #[cfg(feature = "wireguard")] + wireguard::client_adapter(global_ctx), + #[cfg(feature = "quic")] + quic::client_adapter(global_ctx), + ] + .into_iter() + .collect() +} + +pub(super) fn server_adapters(global_ctx: &ArcGlobalCtx) -> Vec { + let _ = global_ctx; + [ + #[cfg(feature = "websocket")] + websocket::server_adapter(global_ctx), + #[cfg(feature = "wireguard")] + wireguard::server_adapter(global_ctx), + #[cfg(feature = "quic")] + quic::server_adapter(global_ctx), + ] + .into_iter() + .collect() +} diff --git a/vendor/easytier/easytier/src/tunnel/protocol/adapters/quic.rs b/vendor/easytier/easytier/src/tunnel/protocol/adapters/quic.rs new file mode 100644 index 0000000..9c1e6bc --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/protocol/adapters/quic.rs @@ -0,0 +1,88 @@ +use std::sync::Arc; + +use async_trait::async_trait; +use easytier_core::{ + connectivity::{ + protocol::{ + ClientProtocolUpgrader, ServerProtocolAdmission, ServerProtocolUpgrade, + ServerProtocolUpgrader, + }, + transport::ConnectedTransport, + }, + socket::udp::UdpSession, + tunnel::Tunnel, +}; + +use crate::{ + common::global_ctx::ArcGlobalCtx, + socket::tcp::RuntimeTcpSocket, + tunnel::quic::{QuicAcceptedSession, upgrade_connected}, +}; + +use super::{ClientAdapter, ServerAdapter}; + +#[derive(Default)] +struct QuicAdapter; + +pub(super) fn client_adapter(_global_ctx: &ArcGlobalCtx) -> ClientAdapter { + Arc::new(QuicAdapter) +} + +pub(super) fn server_adapter(_global_ctx: &ArcGlobalCtx) -> ServerAdapter { + Arc::new(QuicAdapter) +} + +#[async_trait] +impl ClientProtocolUpgrader for QuicAdapter { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "quic" + } + + async fn upgrade_client( + &self, + connected: ConnectedTransport, + requested_url: url::Url, + ) -> anyhow::Result> { + let ConnectedTransport::Udp(session) = connected else { + anyhow::bail!("QUIC protocol requires a UDP session"); + }; + Ok(upgrade_connected(session, requested_url).await?) + } +} + +#[async_trait] +impl ServerProtocolUpgrader for QuicAdapter { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "quic" + } + + async fn upgrade_tcp( + &self, + _socket: RuntimeTcpSocket, + _local_url: url::Url, + ) -> anyhow::Result { + anyhow::bail!("unsupported native TCP server protocol upgrader: quic") + } + + async fn upgrade_udp( + &self, + session: UdpSession, + local_url: url::Url, + admission: Option, + ) -> anyhow::Result { + let admission = + admission.ok_or_else(|| anyhow::anyhow!("QUIC server admission permit is missing"))?; + Ok(ServerProtocolUpgrade::Acceptor(Box::new( + QuicAcceptedSession::new(session, local_url, admission)?, + ))) + } + + async fn upgrade_byte_stream( + &self, + _socket: RuntimeTcpSocket, + _local_url: url::Url, + _remote_url: Option, + ) -> anyhow::Result { + anyhow::bail!("unsupported native byte-stream server protocol upgrader: quic") + } +} diff --git a/vendor/easytier/easytier/src/tunnel/protocol/adapters/websocket.rs b/vendor/easytier/easytier/src/tunnel/protocol/adapters/websocket.rs new file mode 100644 index 0000000..891f2b2 --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/protocol/adapters/websocket.rs @@ -0,0 +1,104 @@ +use std::{num::NonZeroUsize, sync::Arc, time::Duration}; + +use async_trait::async_trait; +use easytier_core::{ + connectivity::{ + protocol::{ + ClientProtocolUpgrader, ServerProtocolAdmission, ServerProtocolUpgrade, + ServerProtocolUpgrader, + }, + transport::ConnectedTransport, + }, + socket::udp::UdpSession, + tunnel::Tunnel, +}; + +use crate::{ + common::global_ctx::ArcGlobalCtx, + socket::tcp::RuntimeTcpSocket, + tunnel::websocket::{ + CONNECT_TIMEOUT, SERVER_HANDSHAKE_TIMEOUT, upgrade_accepted, upgrade_connected, + }, +}; + +use super::{ClientAdapter, ServerAdapter}; + +#[derive(Default)] +struct WebSocketAdapter; + +fn supports_scheme(scheme: &str) -> bool { + matches!(scheme, "ws" | "wss") +} + +pub(super) fn client_adapter(_global_ctx: &ArcGlobalCtx) -> ClientAdapter { + Arc::new(WebSocketAdapter) +} + +pub(super) fn server_adapter(_global_ctx: &ArcGlobalCtx) -> ServerAdapter { + Arc::new(WebSocketAdapter) +} + +#[async_trait] +impl ClientProtocolUpgrader for WebSocketAdapter { + fn supports_scheme(&self, scheme: &str) -> bool { + supports_scheme(scheme) + } + + fn connect_timeout(&self, scheme: &str) -> Option { + supports_scheme(scheme).then_some(CONNECT_TIMEOUT) + } + + async fn upgrade_client( + &self, + connected: ConnectedTransport, + requested_url: url::Url, + ) -> anyhow::Result> { + let ConnectedTransport::Tcp(socket) = connected else { + anyhow::bail!("WebSocket protocol requires a TCP transport"); + }; + Ok(upgrade_connected(socket, requested_url).await?) + } +} + +#[async_trait] +impl ServerProtocolUpgrader for WebSocketAdapter { + fn supports_scheme(&self, scheme: &str) -> bool { + supports_scheme(scheme) + } + + fn max_pending_tcp_upgrades(&self, scheme: &str) -> Option { + supports_scheme(scheme).then_some(NonZeroUsize::MIN) + } + + async fn upgrade_tcp( + &self, + socket: RuntimeTcpSocket, + local_url: url::Url, + ) -> anyhow::Result { + Ok(ServerProtocolUpgrade::Tunnel( + tokio::time::timeout( + SERVER_HANDSHAKE_TIMEOUT, + upgrade_accepted(socket, local_url), + ) + .await??, + )) + } + + async fn upgrade_udp( + &self, + _session: UdpSession, + _local_url: url::Url, + _admission: Option, + ) -> anyhow::Result { + anyhow::bail!("WebSocket protocol requires a TCP transport") + } + + async fn upgrade_byte_stream( + &self, + _socket: RuntimeTcpSocket, + _local_url: url::Url, + _remote_url: Option, + ) -> anyhow::Result { + anyhow::bail!("WebSocket protocol requires a TCP transport") + } +} diff --git a/vendor/easytier/easytier/src/tunnel/protocol/adapters/wireguard.rs b/vendor/easytier/easytier/src/tunnel/protocol/adapters/wireguard.rs new file mode 100644 index 0000000..a891994 --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/protocol/adapters/wireguard.rs @@ -0,0 +1,100 @@ +use std::sync::Arc; + +use async_trait::async_trait; +use easytier_core::{ + connectivity::{ + protocol::{ + ClientProtocolUpgrader, ServerProtocolAdmission, ServerProtocolUpgrade, + ServerProtocolUpgrader, + }, + transport::ConnectedTransport, + }, + socket::udp::UdpSession, + tunnel::Tunnel, +}; + +use crate::{ + common::global_ctx::ArcGlobalCtx, + socket::tcp::RuntimeTcpSocket, + tunnel::wireguard::{WgConfig, upgrade_accepted, upgrade_connected}, +}; + +use super::{ClientAdapter, ServerAdapter}; + +struct WireGuardAdapter { + config: WgConfig, +} + +impl WireGuardAdapter { + fn new(global_ctx: &ArcGlobalCtx) -> Self { + let identity = global_ctx.get_network_identity(); + Self { + config: WgConfig::new_from_network_identity( + &identity.network_name, + &identity.network_secret.unwrap_or_default(), + ), + } + } +} + +pub(super) fn client_adapter(global_ctx: &ArcGlobalCtx) -> ClientAdapter { + Arc::new(WireGuardAdapter::new(global_ctx)) +} + +pub(super) fn server_adapter(global_ctx: &ArcGlobalCtx) -> ServerAdapter { + Arc::new(WireGuardAdapter::new(global_ctx)) +} + +#[async_trait] +impl ClientProtocolUpgrader for WireGuardAdapter { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "wg" + } + + async fn upgrade_client( + &self, + connected: ConnectedTransport, + requested_url: url::Url, + ) -> anyhow::Result> { + let ConnectedTransport::Udp(session) = connected else { + anyhow::bail!("WireGuard protocol requires a UDP session"); + }; + Ok(upgrade_connected(session, requested_url, self.config.clone()).await?) + } +} + +#[async_trait] +impl ServerProtocolUpgrader for WireGuardAdapter { + fn supports_scheme(&self, scheme: &str) -> bool { + scheme == "wg" + } + + async fn upgrade_tcp( + &self, + _socket: RuntimeTcpSocket, + _local_url: url::Url, + ) -> anyhow::Result { + anyhow::bail!("unsupported native TCP server protocol upgrader: wg") + } + + async fn upgrade_udp( + &self, + session: UdpSession, + _local_url: url::Url, + _admission: Option, + ) -> anyhow::Result { + Ok(ServerProtocolUpgrade::Tunnel(upgrade_accepted( + session, + self.config.clone(), + )?)) + } + + async fn upgrade_byte_stream( + &self, + _socket: RuntimeTcpSocket, + _local_url: url::Url, + _remote_url: Option, + ) -> anyhow::Result { + anyhow::bail!("unsupported native byte-stream server protocol upgrader: wg") + } +} diff --git a/vendor/easytier/easytier/src/tunnel/quic.rs b/vendor/easytier/easytier/src/tunnel/quic.rs new file mode 100644 index 0000000..339b82a --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/quic.rs @@ -0,0 +1,789 @@ +//! This example demonstrates how to make a QUIC connection that ignores the server certificate. +//! +//! Checkout the `README.md` for guidance. + +use crate::proto::common::TunnelInfo; +use anyhow::Context; +use easytier_core::{ + connectivity::{ + protocol::{ServerProtocolAdmission, ServerTunnelAcceptor}, + transport::ConnectedUdpSession, + }, + socket::udp::UdpSession, + tunnel::{ + Tunnel, TunnelError, + framed::{FramedReader, FramedWriter}, + wrapper::TunnelWrapper, + }, +}; +use quinn::{ + AsyncUdpSocket, ClientConfig, Connecting, Connection, ConnectionError, Endpoint, + EndpointConfig, Incoming, ServerConfig, TransportConfig, congestion::BbrConfig, + default_runtime, +}; +use std::{net::SocketAddr, sync::Arc, time::Duration}; +use tokio::{ + sync::{ + OwnedSemaphorePermit, Semaphore, + mpsc::{Receiver, Sender, channel}, + }, + task::JoinSet, +}; +use tokio_util::task::AbortOnDropHandle; + +mod session_socket; +pub(crate) use session_socket::QuicUdpSessionSocket; + +// region config +mod crypto { + use crate::tunnel::quic::QUIC_VERSION_ETQ1; + use crate::utils::BoxExt; + use bytes::{Buf, BytesMut}; + use quinn_proto::crypto::{ + ClientConfig, ExportKeyingMaterialError, KeyPair, Keys, ServerConfig, Session, + UnsupportedVersion, + }; + use quinn_proto::transport_parameters::TransportParameters; + use quinn_proto::{ + ConnectError, ConnectionId, Side, TransportError, + crypto::{CryptoError, HeaderKey, PacketKey}, + }; + use seahash::SeaHasher; + use std::any::Any; + use std::{hash::Hasher, sync::Arc}; + use tracing::{error, instrument, trace}; + + #[derive(Debug, Clone, Copy)] + struct CryptoKey { + /// Bind the packet checksum to the packet number so that a truncated + /// packet number decoded out of window (RFC 9000 Appendix A) fails + /// authentication instead of acknowledging an unsent packet number. + pn_bound: bool, + } + + impl CryptoKey { + fn for_version(version: u32) -> Self { + Self { + pn_bound: version == QUIC_VERSION_ETQ1, + } + } + + fn header(self) -> KeyPair> { + KeyPair { + local: Box::new(self), + remote: Box::new(self), + } + } + + fn packet(self) -> KeyPair> { + KeyPair { + local: Box::new(self), + remote: Box::new(self), + } + } + + fn keys(self) -> Keys { + Keys { + header: self.header(), + packet: self.packet(), + } + } + } + + impl HeaderKey for CryptoKey { + fn decrypt(&self, _: usize, _: &mut [u8]) {} + fn encrypt(&self, _: usize, _: &mut [u8]) {} + fn sample_size(&self) -> usize { + 0 + } + } + + impl CryptoKey { + fn checksum(slices: &[&[u8]]) -> u64 { + let mut hasher = SeaHasher::default(); + for slice in slices { + hasher.write(&(slice.len() as u64).to_le_bytes()); + hasher.write(slice); + } + hasher.finish() + } + + // The packet number is mixed into the checksum before the slices. Real + // QUIC derives the AEAD nonce from the packet number, so a number + // decoded differently from how it was encoded fails authentication; + // this mirrors that property for the SeaHash integrity check. + fn checksum_with_packet(packet: u64, slices: &[&[u8]]) -> u64 { + let mut hasher = SeaHasher::default(); + hasher.write(&packet.to_le_bytes()); + for slice in slices { + hasher.write(&(slice.len() as u64).to_le_bytes()); + hasher.write(slice); + } + hasher.finish() + } + + fn checksum_for(&self, packet: u64, slices: &[&[u8]]) -> u64 { + if self.pn_bound { + Self::checksum_with_packet(packet, slices) + } else { + Self::checksum(slices) + } + } + } + + impl PacketKey for CryptoKey { + #[instrument(level = "trace")] + fn encrypt(&self, packet: u64, buf: &mut [u8], header_len: usize) { + let (header, rest) = buf.split_at_mut(header_len); + let (payload, tag) = rest.split_at_mut(rest.len() - self.tag_len()); + let checksum = self.checksum_for(packet, &[header, payload]); + tag.copy_from_slice(&checksum.to_be_bytes()); + trace!(checksum, ?header, ?payload, ?tag); + } + + #[instrument(level = "trace")] + fn decrypt( + &self, + packet: u64, + header: &[u8], + payload: &mut BytesMut, + ) -> Result<(), CryptoError> { + let tag = payload.split_off(payload.len() - self.tag_len()).get_u64(); + trace!(tag, ?payload); + let checksum = self.checksum_for(packet, &[header, payload]); + if checksum != tag { + error!(tag, checksum, "checksum mismatch"); + return Err(CryptoError); + } + Ok(()) + } + + fn tag_len(&self) -> usize { + 8 + } + + fn confidentiality_limit(&self) -> u64 { + u64::MAX + } + + fn integrity_limit(&self) -> u64 { + 1 << 36 + } + } + + #[derive(Debug, Clone, Copy, PartialEq, Eq)] + enum HandshakeState { + EmitInitial, + EmitHandshake, + Done, + } + + #[derive(Debug)] + struct QuicSession { + side: Side, + key: CryptoKey, + state: HandshakeState, + local: TransportParameters, + remote: Option, + } + + impl QuicSession { + fn new(side: Side, version: u32, params: TransportParameters) -> Self { + Self { + side, + key: CryptoKey::for_version(version), + state: HandshakeState::EmitInitial, + local: params, + remote: None, + } + } + } + + impl Session for QuicSession { + fn initial_keys(&self, _: &ConnectionId, _: Side) -> Keys { + self.key.keys() + } + + fn handshake_data(&self) -> Option> { + self.remote.map(|params| params.boxed() as _) + } + + fn peer_identity(&self) -> Option> { + None + } + + fn early_crypto(&self) -> Option<(Box, Box)> { + None + } + + fn early_data_accepted(&self) -> Option { + Some(false) + } + + #[instrument(level = "trace")] + fn is_handshaking(&self) -> bool { + self.remote.is_none() || self.state != HandshakeState::Done + } + + #[instrument(level = "trace")] + fn read_handshake(&mut self, mut buf: &[u8]) -> Result { + if self.remote.is_none() { + self.remote = Some( + TransportParameters::read(self.side, &mut buf) + .expect("failed to read transport parameters"), + ); + } + Ok(true) + } + + #[instrument(level = "trace")] + fn transport_parameters(&self) -> Result, TransportError> { + Ok(self.remote) + } + + #[instrument(level = "trace")] + fn write_handshake(&mut self, buf: &mut Vec) -> Option { + match self.state { + HandshakeState::EmitInitial => { + if self.side.is_client() { + self.local.write(buf); + } + self.state = HandshakeState::EmitHandshake; + Some(self.key.keys()) + } + HandshakeState::EmitHandshake => { + if self.side.is_server() { + self.local.write(buf); + } + self.state = HandshakeState::Done; + Some(self.key.keys()) + } + HandshakeState::Done => None, + } + } + + fn next_1rtt_keys(&mut self) -> Option>> { + Some(self.key.packet()) + } + + fn is_valid_retry(&self, _: &ConnectionId, _: &[u8], _: &[u8]) -> bool { + true + } + + fn export_keying_material( + &self, + _: &mut [u8], + _: &[u8], + _: &[u8], + ) -> Result<(), ExportKeyingMaterialError> { + Ok(()) + } + } + + #[derive(Debug)] + pub struct CryptoConfig; + + impl ClientConfig for CryptoConfig { + #[instrument(level = "trace")] + fn start_session( + self: Arc, + version: u32, + server_name: &str, + params: &TransportParameters, + ) -> Result, ConnectError> { + Ok(Box::new(QuicSession::new(Side::Client, version, *params))) + } + } + + impl ServerConfig for CryptoConfig { + fn initial_keys(&self, version: u32, _: &ConnectionId) -> Result { + Ok(CryptoKey::for_version(version).keys()) + } + + fn retry_tag(&self, _: u32, _: &ConnectionId, _: &[u8]) -> [u8; 16] { + [0u8; 16] + } + + #[instrument(level = "trace")] + fn start_session( + self: Arc, + version: u32, + params: &TransportParameters, + ) -> Box { + Box::new(QuicSession::new(Side::Server, version, *params)) + } + } + + #[cfg(test)] + mod tests { + use super::*; + + fn roundtrip(pn_bound: bool, encrypt_pn: u64, decrypt_pn: u64) -> Result<(), CryptoError> { + let key = CryptoKey { pn_bound }; + let mut buf = vec![7u8; 8 + 32 + key.tag_len()]; + quinn_proto::crypto::PacketKey::encrypt(&key, encrypt_pn, &mut buf, 8); + let header = buf[..8].to_vec(); + let mut payload = BytesMut::from(&buf[8..]); + quinn_proto::crypto::PacketKey::decrypt(&key, decrypt_pn, &header, &mut payload) + } + + #[test] + fn legacy_checksum_ignores_packet_number() { + // Documents the original flaw: a packet number decoded differently + // from how it was encoded still passes authentication. + assert!(roundtrip(false, 100, 356).is_ok()); + } + + #[test] + fn pn_bound_checksum_rejects_shifted_packet_number() { + assert!(roundtrip(true, 100, 100).is_ok()); + // A 1-byte truncated packet number decoded one window (+256) ahead, + // as happens when reordering exceeds the RFC 9000 Appendix A + // decode window, must fail authentication. + assert!(roundtrip(true, 100, 356).is_err()); + } + } +} + +/// EasyTier custom QUIC version "ETQ1" (0x45545131, outside the reserved +/// `0x??a?a?a?a` grease pattern). +/// +/// Connections negotiated on this version bind the packet integrity checksum +/// to the packet number. With the legacy checksum, a 1-byte-encoded packet +/// number that arrives re-ordered beyond the decode window (RFC 9000 +/// Appendix A) is decoded as a future packet number; the checksum still +/// passes, the peer ACKs a number that was never sent, and the connection is +/// torn down with `PROTOCOL_VIOLATION("unsent packet acked")`. Binding the +/// checksum to the packet number makes such a misdecode fail authentication, +/// mirroring real QUIC where the AEAD nonce is derived from the packet +/// number. +/// +/// Used by both the QUIC proxy and the quic:// tunnel. Peers that only speak +/// version 1 reject it via version negotiation, so dialers must fall back to +/// [`client_config`] on `VersionMismatch` (see [`connect_with_etq1`]). +pub const QUIC_VERSION_ETQ1: u32 = 0x45545131; + +pub fn transport_config() -> Arc { + let mut config = TransportConfig::default(); + + config + .max_concurrent_bidi_streams(u8::MAX.into()) + .max_concurrent_uni_streams(0u8.into()) + .keep_alive_interval(Some(Duration::from_secs(5))) + .initial_mtu(1200) + .min_mtu(1200) + .enable_segmentation_offload(true) + .congestion_controller_factory(Arc::new(BbrConfig::default())); + + Arc::new(config) +} + +pub fn server_config() -> ServerConfig { + let mut config = ServerConfig::with_crypto(Arc::new(crypto::CryptoConfig)); + config.transport_config(transport_config()); + config +} + +pub fn client_config() -> ClientConfig { + let mut config = ClientConfig::new(Arc::new(crypto::CryptoConfig)); + config.transport_config(transport_config()); + config +} + +/// Client config negotiating [`QUIC_VERSION_ETQ1`], the first choice of +/// dialers that support the fallback (see [`connect_with_etq1`]). +pub fn etq1_client_config() -> ClientConfig { + let mut config = client_config(); + config.version(QUIC_VERSION_ETQ1); + config +} + +pub(crate) fn endpoint_config_with_versions(versions: Vec) -> EndpointConfig { + let mut config = EndpointConfig::default(); + config.max_udp_payload_size(1200).unwrap(); + config.supported_versions(versions); + config +} + +/// Endpoint config accepting both [`QUIC_VERSION_ETQ1`] and legacy version +/// 1, so new dialers negotiate ETQ1 while old peers keep working. +pub fn endpoint_config() -> EndpointConfig { + endpoint_config_with_versions(vec![QUIC_VERSION_ETQ1, 1]) +} + +/// Dial `endpoint` preferring [`QUIC_VERSION_ETQ1`], falling back to legacy +/// version 1 when the remote rejects ETQ1 via version negotiation. +pub(crate) async fn connect_with_etq1( + endpoint: &Endpoint, + addr: SocketAddr, + server_name: &str, +) -> anyhow::Result { + match endpoint + .connect_with(etq1_client_config(), addr, server_name) + .with_context(|| format!("failed to start connection to {addr}"))? + .await + { + Ok(connection) => Ok(connection), + Err(ConnectionError::VersionMismatch) => endpoint + .connect_with(client_config(), addr, server_name) + .with_context(|| format!("failed to start connection to {addr}"))? + .await + .with_context(|| format!("failed to connect to {addr}")), + Err(error) => Err(error).with_context(|| format!("failed to connect to {addr}")), + } +} +//endregion + +const QUIC_ACCEPT_COMPLETION_TIMEOUT: Duration = Duration::from_secs(10); + +struct ConnWrapper { + conn: Connection, + _endpoint: Endpoint, +} + +impl Drop for ConnWrapper { + fn drop(&mut self) { + self.conn.close(0u32.into(), b"done"); + } +} + +pub(crate) async fn upgrade_connected( + connected: ConnectedUdpSession, + remote_url: url::Url, +) -> Result, TunnelError> { + let socket = Arc::new(QuicUdpSessionSocket::new(connected)?); + let local_addr = socket.local_addr()?; + let remote_addr = socket.peer_addr(); + let runtime = default_runtime().ok_or(TunnelError::InternalError( + "no async runtime found".to_owned(), + ))?; + let mut endpoint = + Endpoint::new_with_abstract_socket(endpoint_config(), None, socket, runtime)?; + endpoint.set_default_client_config(client_config()); + let connection = connect_with_etq1(&endpoint, remote_addr, "localhost").await?; + let (write, read) = connection + .open_bi() + .await + .with_context(|| "open_bi failed")?; + let resolved_remote_addr = connection.remote_address(); + let connection = Arc::new(ConnWrapper { + conn: connection, + _endpoint: endpoint, + }); + let info = TunnelInfo { + tunnel_type: "quic".to_owned(), + local_addr: Some(super::build_url_from_socket_addr(&local_addr.to_string(), "quic").into()), + remote_addr: Some(remote_url.into()), + resolved_remote_addr: Some( + super::build_url_from_socket_addr(&resolved_remote_addr.to_string(), "quic").into(), + ), + }; + Ok(Box::new(TunnelWrapper::new( + FramedReader::new_with_associate_data(read, 4500, Some(Box::new(connection.clone()))), + FramedWriter::new_with_associate_data(write, Some(Box::new(connection))), + Some(info), + ))) +} + +struct PendingQuicSessionTunnel { + connecting: Connecting, + endpoint: Endpoint, + local_url: url::Url, + remote_addr: SocketAddr, + _handshake_permit: OwnedSemaphorePermit, +} + +async fn finish_quic_session_tunnel( + pending: PendingQuicSessionTunnel, +) -> Result, TunnelError> { + let PendingQuicSessionTunnel { + connecting, + endpoint, + local_url, + remote_addr, + _handshake_permit, + } = pending; + let connection = tokio::time::timeout(QUIC_ACCEPT_COMPLETION_TIMEOUT, connecting) + .await + .map_err(TunnelError::Timeout)? + .with_context(|| "accept connection failed")?; + let (write, read) = + tokio::time::timeout(QUIC_ACCEPT_COMPLETION_TIMEOUT, connection.accept_bi()) + .await + .map_err(TunnelError::Timeout)? + .with_context(|| "accept_bi failed")?; + let connection = Arc::new(ConnWrapper { + conn: connection, + _endpoint: endpoint, + }); + let remote_url = super::build_url_from_socket_addr(&remote_addr.to_string(), "quic"); + let info = TunnelInfo { + tunnel_type: "quic".to_owned(), + local_addr: Some(local_url.into()), + remote_addr: Some(remote_url.clone().into()), + resolved_remote_addr: Some(remote_url.into()), + }; + Ok(Box::new(TunnelWrapper::new( + FramedReader::new_with_associate_data(read, 2000, Some(Box::new(connection.clone()))), + FramedWriter::new_with_associate_data(write, Some(Box::new(connection))), + Some(info), + ))) +} + +async fn run_quic_accepted_session( + endpoint: Endpoint, + local_url: url::Url, + handshakes: Arc, + completed: Sender, TunnelError>>, +) { + let mut complete_tasks = JoinSet::new(); + let mut pending_incoming: Option = None; + loop { + tokio::select! { + Some(result) = complete_tasks.join_next(), if !complete_tasks.is_empty() => { + let result = match result { + Ok(result) => result, + Err(error) => Err(TunnelError::InternalError( + format!("quic accept task failed: {error}"), + )), + }; + if completed.send(result).await.is_err() { + break; + } + } + incoming = endpoint.accept(), if pending_incoming.is_none() => { + match incoming { + Some(incoming) => pending_incoming = Some(incoming), + None => break, + } + } + permit = handshakes.clone().acquire_owned(), if pending_incoming.is_some() => { + let Ok(handshake_permit) = permit else { + break; + }; + let incoming = pending_incoming.take().unwrap(); + let remote_addr = incoming.remote_address(); + match incoming.accept() { + Ok(connecting) => { + complete_tasks.spawn(finish_quic_session_tunnel( + PendingQuicSessionTunnel { + connecting, + endpoint: endpoint.clone(), + local_url: local_url.clone(), + remote_addr, + _handshake_permit: handshake_permit, + }, + )); + } + Err(error) => { + drop(handshake_permit); + if completed + .send(Err(anyhow::Error::new(error) + .context("quic accept connection failed") + .into())) + .await + .is_err() + { + break; + } + } + } + } + } + } +} + +pub(crate) struct QuicAcceptedSession { + completed: Receiver, TunnelError>>, + _accept_task: AbortOnDropHandle<()>, +} + +impl QuicAcceptedSession { + pub(crate) fn new( + session: UdpSession, + local_url: url::Url, + admission: ServerProtocolAdmission, + ) -> Result { + let (active_session, handshake_slots) = admission.into_parts(); + Self::new_with_admission_parts(session, local_url, active_session, handshake_slots) + } + + fn new_with_admission_parts( + session: UdpSession, + local_url: url::Url, + active_session: OwnedSemaphorePermit, + handshakes: Arc, + ) -> Result { + let socket = Arc::new(QuicUdpSessionSocket::from_accepted( + session, + active_session, + )?); + let runtime = default_runtime().ok_or(TunnelError::InternalError( + "no async runtime found".to_owned(), + ))?; + let endpoint = Endpoint::new_with_abstract_socket( + endpoint_config(), + Some(server_config()), + socket, + runtime, + )?; + let (completed_tx, completed) = channel(100); + let accept_task = AbortOnDropHandle::new(tokio::spawn(run_quic_accepted_session( + endpoint, + local_url, + handshakes, + completed_tx, + ))); + Ok(Self { + completed, + _accept_task: accept_task, + }) + } + + pub(crate) async fn accept(&mut self) -> Result, TunnelError> { + while let Some(result) = self.completed.recv().await { + match result { + Ok(tunnel) => return Ok(tunnel), + Err(error) => { + tracing::warn!(?error, "QUIC session connection failed"); + } + } + } + Err(TunnelError::Shutdown) + } +} + +#[async_trait::async_trait] +impl ServerTunnelAcceptor for QuicAcceptedSession { + async fn accept(&mut self) -> anyhow::Result> { + Ok(QuicAcceptedSession::accept(self).await?) + } +} + +#[cfg(test)] +mod tests { + use std::{net::SocketAddr, sync::Arc, time::Duration}; + + use easytier_core::{ + connectivity::{ + protocol::ServerProtocolAdmissionController, + transport::{UdpSessionMode, connect_udp}, + }, + packet::ZCPacket, + socket::SocketListener, + socket::udp::{ + UdpBindOptions, UdpSessionAcceptKind, UdpSessionListenRequest, UdpSessionProtocol, + VirtualUdpSocket, + }, + }; + use futures::{SinkExt, StreamExt}; + + use crate::{ + common::netns::NetNS, host_runtime::native_host_runtime, + socket::udp::new_runtime_udp_session_listener, tunnel::common::tests::_tunnel_echo_server, + }; + + use super::*; + + #[tokio::test(flavor = "multi_thread")] + async fn accepted_udp_session_supports_multiple_quic_connections() { + tokio::time::timeout(Duration::from_secs(5), async { + let bind_addr: SocketAddr = "127.0.0.1:0".parse().unwrap(); + let mut listener = new_runtime_udp_session_listener( + format!("quic://{bind_addr}").parse().unwrap(), + UdpSessionListenRequest::new( + UdpBindOptions::port_bound_listener(bind_addr).with_only_v6(false), + ), + UdpSessionAcceptKind::Classified(UdpSessionProtocol::Quic), + NetNS::new(None), + ); + listener.listen().await.unwrap(); + let remote_addr = listener.bound_socket().unwrap().local_addr().unwrap(); + let local_url = listener.local_url(); + + let connected = connect_udp( + native_host_runtime(), + remote_addr, + Vec::new(), + UdpBindOptions::direct_connect(), + UdpSessionMode::Classified(UdpSessionProtocol::Quic), + ) + .await + .unwrap(); + let socket = Arc::new(QuicUdpSessionSocket::new(connected).unwrap()); + let runtime = default_runtime().unwrap(); + let mut endpoint = + Endpoint::new_with_abstract_socket(endpoint_config(), None, socket, runtime) + .unwrap(); + endpoint.set_default_client_config(client_config()); + + let server_task = tokio::spawn(async move { + let session = listener.accept().await.unwrap(); + let admission = ServerProtocolAdmissionController::new(1, 2) + .try_admit() + .unwrap(); + let mut accepted = QuicAcceptedSession::new(session, local_url, admission).unwrap(); + let first = accepted.accept().await.unwrap(); + let second = accepted.accept().await.unwrap(); + assert!( + tokio::time::timeout(Duration::from_millis(50), listener.accept()) + .await + .is_err(), + "both QUIC connections must use the first accepted UDP session" + ); + (first, second) + }); + + let first_connection = endpoint + .connect(remote_addr, "localhost") + .unwrap() + .await + .unwrap(); + let (first_write, first_read) = first_connection.open_bi().await.unwrap(); + let mut first_send = FramedWriter::new(first_write); + first_send + .send(ZCPacket::new_with_payload(b"first QUIC connection")) + .await + .unwrap(); + let second_connection = endpoint + .connect(remote_addr, "localhost") + .unwrap() + .await + .unwrap(); + let (second_write, second_read) = second_connection.open_bi().await.unwrap(); + let mut second_send = FramedWriter::new(second_write); + second_send + .send(ZCPacket::new_with_payload(b"second QUIC connection ready")) + .await + .unwrap(); + let (first_server, second_server) = server_task.await.unwrap(); + + drop(first_send); + drop(first_read); + drop(first_server); + first_connection.close(0u32.into(), b"first connection done"); + + let echo_task = tokio::spawn(_tunnel_echo_server(second_server, false)); + let mut recv = FramedReader::new(second_read, 4500); + let ready = recv.next().await.unwrap().unwrap(); + assert_eq!(ready.payload(), b"second QUIC connection ready".as_slice()); + second_send + .send(ZCPacket::new_with_payload( + b"second QUIC connection after first closed", + )) + .await + .unwrap(); + let packet = recv.next().await.unwrap().unwrap(); + assert_eq!( + packet.payload(), + b"second QUIC connection after first closed".as_slice() + ); + let _ = second_send.close().await; + echo_task.await.unwrap(); + second_connection.close(0u32.into(), b"second connection done"); + endpoint.close(0u32.into(), b"test done"); + }) + .await + .unwrap(); + } +} diff --git a/vendor/easytier/easytier/src/tunnel/quic/session_socket.rs b/vendor/easytier/easytier/src/tunnel/quic/session_socket.rs new file mode 100644 index 0000000..06b6fdf --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/quic/session_socket.rs @@ -0,0 +1,279 @@ +use std::{ + fmt, + future::Future, + io::{self, IoSliceMut}, + pin::Pin, + sync::{Arc, Mutex}, + task::{Context, Poll}, +}; + +use easytier_core::{ + connectivity::transport::ConnectedUdpSession, + socket::udp::{UdpSession, UdpSessionSocket}, +}; +use quinn::{ + AsyncUdpSocket, UdpPoller, + udp::{RecvMeta, Transmit}, +}; +use tokio::sync::mpsc::{self, Receiver, Sender, error::TrySendError}; +use tokio_util::task::AbortOnDropHandle; + +const DATAGRAM_QUEUE_CAPACITY: usize = 1024; + +type SendBatch = Vec>; +type WritableFuture = Pin> + Send>>; + +struct ReceivedDatagram { + payload: Vec, + dst_ip: Option, +} + +pub(crate) struct QuicUdpSessionSocket { + _session: Arc, + local_addr: std::net::SocketAddr, + peer_addr: std::net::SocketAddr, + incoming: Mutex>>, + outgoing: Sender, + _recv_task: AbortOnDropHandle<()>, + _send_task: AbortOnDropHandle<()>, + _session_guard: Box, +} + +impl fmt::Debug for QuicUdpSessionSocket { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("QuicUdpSessionSocket") + .field("local_addr", &self.local_addr) + .field("peer_addr", &self.peer_addr) + .finish_non_exhaustive() + } +} + +impl QuicUdpSessionSocket { + pub(crate) fn new(connected: ConnectedUdpSession) -> io::Result { + let (session, session_guard) = connected.into_parts(); + Self::from_session(Arc::new(session), session_guard) + } + + pub(crate) fn from_accepted(session: UdpSession, session_guard: T) -> io::Result + where + T: Send + Sync + 'static, + { + Self::from_session(Arc::new(session), Box::new(session_guard)) + } + + fn from_session( + session: Arc, + session_guard: Box, + ) -> io::Result { + let local_addr = session.local_addr()?; + let peer_addr = session.peer_addr()?; + let (incoming_tx, incoming) = mpsc::channel(DATAGRAM_QUEUE_CAPACITY); + let (outgoing, mut outgoing_rx) = mpsc::channel::(DATAGRAM_QUEUE_CAPACITY); + + let recv_session = session.clone(); + let recv_errors = incoming_tx.clone(); + let recv_task = AbortOnDropHandle::new(tokio::spawn(async move { + let mut buffer = vec![0; 64 * 1024]; + loop { + match recv_session.recv_with_meta(&mut buffer).await { + Ok((length, meta)) => { + let datagram = ReceivedDatagram { + payload: buffer[..length].to_vec(), + dst_ip: meta.dst_ip, + }; + if incoming_tx.send(Ok(datagram)).await.is_err() { + break; + } + } + Err(error) => { + let _ = incoming_tx.send(Err(error)).await; + break; + } + } + } + })); + + let send_session = session.clone(); + let send_task = AbortOnDropHandle::new(tokio::spawn(async move { + while let Some(batch) = outgoing_rx.recv().await { + for datagram in batch { + match send_session.send(&datagram).await { + Ok(length) if length == datagram.len() => {} + Ok(_) => { + let _ = recv_errors + .send(Err(io::Error::new( + io::ErrorKind::WriteZero, + "QUIC UDP session partially sent a datagram", + ))) + .await; + return; + } + Err(error) => { + let _ = recv_errors.send(Err(error)).await; + return; + } + } + } + } + })); + + Ok(Self { + _session: session, + local_addr, + peer_addr, + incoming: Mutex::new(incoming), + outgoing, + _recv_task: recv_task, + _send_task: send_task, + _session_guard: session_guard, + }) + } + + pub(crate) fn peer_addr(&self) -> std::net::SocketAddr { + self.peer_addr + } + + fn send_batch(&self, transmit: &Transmit<'_>) -> io::Result<()> { + if transmit.destination != self.peer_addr { + return Err(io::Error::new( + io::ErrorKind::AddrNotAvailable, + format!( + "QUIC UDP session is connected to {}, not {}", + self.peer_addr, transmit.destination + ), + )); + } + + let batch = match transmit.segment_size { + Some(0) => { + return Err(io::Error::new( + io::ErrorKind::InvalidInput, + "QUIC segment size cannot be zero", + )); + } + Some(segment_size) => transmit + .contents + .chunks(segment_size) + .map(<[u8]>::to_vec) + .collect(), + None => vec![transmit.contents.to_vec()], + }; + self.outgoing.try_send(batch).map_err(map_try_send_error) + } +} + +fn map_try_send_error(error: TrySendError) -> io::Error { + match error { + TrySendError::Full(_) => io::Error::new(io::ErrorKind::WouldBlock, "QUIC send queue full"), + TrySendError::Closed(_) => { + io::Error::new(io::ErrorKind::BrokenPipe, "QUIC UDP session closed") + } + } +} + +struct QuicUdpSessionPoller { + outgoing: Sender, + writable: Mutex>, +} + +impl fmt::Debug for QuicUdpSessionPoller { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("QuicUdpSessionPoller") + .finish_non_exhaustive() + } +} + +impl UdpPoller for QuicUdpSessionPoller { + fn poll_writable(self: Pin<&mut Self>, context: &mut Context<'_>) -> Poll> { + let mut writable = self.writable.lock().unwrap(); + if writable.is_none() { + let outgoing = self.outgoing.clone(); + *writable = Some(Box::pin(async move { + let permit = outgoing.reserve_owned().await.map_err(|_| { + io::Error::new(io::ErrorKind::BrokenPipe, "QUIC UDP session closed") + })?; + drop(permit); + Ok(()) + })); + } + + match writable.as_mut().unwrap().as_mut().poll(context) { + Poll::Ready(result) => { + *writable = None; + Poll::Ready(result) + } + Poll::Pending => Poll::Pending, + } + } +} + +impl AsyncUdpSocket for QuicUdpSessionSocket { + fn create_io_poller(self: Arc) -> Pin> { + Box::pin(QuicUdpSessionPoller { + outgoing: self.outgoing.clone(), + writable: Mutex::new(None), + }) + } + + fn try_send(&self, transmit: &Transmit<'_>) -> io::Result<()> { + self.send_batch(transmit) + } + + fn poll_recv( + &self, + context: &mut Context<'_>, + buffers: &mut [IoSliceMut<'_>], + meta: &mut [RecvMeta], + ) -> Poll> { + if buffers.is_empty() || meta.is_empty() { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::InvalidInput, + "QUIC UDP recv buffers are empty", + ))); + } + + let mut incoming = self.incoming.lock().unwrap(); + loop { + match Pin::new(&mut *incoming).poll_recv(context) { + Poll::Ready(Some(Ok(datagram))) => { + if buffers[0].len() < datagram.payload.len() { + tracing::debug!( + payload_len = datagram.payload.len(), + recv_buf_len = buffers[0].len(), + peer_addr = ?self.peer_addr, + "drop oversized QUIC UDP session datagram" + ); + continue; + } + buffers[0][..datagram.payload.len()].copy_from_slice(&datagram.payload); + meta[0] = RecvMeta { + addr: self.peer_addr, + len: datagram.payload.len(), + stride: datagram.payload.len(), + ecn: None, + dst_ip: datagram.dst_ip, + }; + return Poll::Ready(Ok(1)); + } + Poll::Ready(Some(Err(error))) => return Poll::Ready(Err(error)), + Poll::Ready(None) => { + return Poll::Ready(Err(io::Error::new( + io::ErrorKind::UnexpectedEof, + "QUIC UDP session closed", + ))); + } + Poll::Pending => return Poll::Pending, + } + } + } + + fn local_addr(&self) -> io::Result { + Ok(self.local_addr) + } + + fn may_fragment(&self) -> bool { + false + } +} diff --git a/vendor/easytier/easytier/src/tunnel/websocket.rs b/vendor/easytier/easytier/src/tunnel/websocket.rs new file mode 100644 index 0000000..bfd80aa --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/websocket.rs @@ -0,0 +1,531 @@ +use super::FromUrl; +use crate::tunnel::common::bind; +use crate::{proto::common::TunnelInfo, socket::tcp::RuntimeTcpSocket}; +use anyhow::Context as _; +use bytes::BytesMut; +use cidr::IpCidr; +use easytier_core::{ + packet::{ZCPacket, ZCPacketType}, + socket::tcp::VirtualTcpSocket, + tunnel::{IpVersion, Tunnel, TunnelError, wrapper::TunnelWrapper}, +}; +use forwarded_header_value::ForwardedHeaderValue; +use futures::{Sink, StreamExt}; +use std::{ + net::{IpAddr, SocketAddr}, + pin::Pin, + sync::{Arc, LazyLock}, + task::{Context, Poll}, + time::Duration, +}; +use tokio::{net::TcpListener, time::timeout}; +use tokio_rustls::TlsAcceptor; +use tokio_util::either::Either; +use tokio_websockets::{ClientBuilder, Limits, MaybeTlsStream, Message, ServerBuilder}; +use zerocopy::AsBytes as _; + +pub(crate) const CONNECT_TIMEOUT: Duration = Duration::from_secs(20); +pub(crate) const SERVER_HANDSHAKE_TIMEOUT: Duration = Duration::from_secs(3); + +static TRUSTED_PROXIES: LazyLock> = LazyLock::new(|| { + [ + "127.0.0.0/8", + "10.0.0.0/8", + "172.16.0.0/12", + "192.168.0.0/16", + "::1/128", + "fc00::/7", + ] + .into_iter() + .map(|cidr| cidr.parse().unwrap()) + .collect() +}); + +fn trusted_proxy_contains(ip: IpAddr) -> bool { + TRUSTED_PROXIES.iter().any(|cidr| match (cidr, ip) { + (IpCidr::V4(cidr), IpAddr::V4(ip)) => cidr.contains(&ip), + (IpCidr::V6(cidr), IpAddr::V6(ip)) => cidr.contains(&ip), + _ => false, + }) +} + +fn websocket_error(error: impl std::fmt::Display) -> TunnelError { + TunnelError::ProtocolError(format!("websocket error: {error}")) +} + +fn is_wss(url: &url::Url) -> Result { + match url.scheme() { + "ws" => Ok(false), + "wss" => Ok(true), + scheme => Err(TunnelError::InvalidProtocol(scheme.to_owned())), + } +} + +struct WebSocketPacketSink { + inner: S, +} + +impl WebSocketPacketSink { + fn new(inner: S) -> Self { + Self { inner } + } +} + +impl Sink for WebSocketPacketSink +where + S: Sink + Unpin, + E: std::fmt::Display, +{ + type Error = TunnelError; + + fn poll_ready(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.inner) + .poll_ready(cx) + .map(|result| result.map_err(websocket_error)) + } + + fn start_send(mut self: Pin<&mut Self>, packet: ZCPacket) -> Result<(), Self::Error> { + Pin::new(&mut self.inner) + .start_send(Message::binary(packet.tunnel_payload_bytes().freeze())) + .map_err(websocket_error) + } + + fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.inner) + .poll_flush(cx) + .map(|result| result.map_err(websocket_error)) + } + + fn poll_close(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> { + Pin::new(&mut self.inner) + .poll_close(cx) + .map(|result| result.map_err(websocket_error)) + } +} + +async fn map_from_ws_message( + message: Result, +) -> Option> { + let message = match message { + Ok(message) => message, + Err(error) => { + tracing::error!(?error, "recv from websocket error"); + return Some(Err(websocket_error(error))); + } + }; + if message.is_close() { + tracing::warn!("recv close message from websocket"); + return None; + } + if !message.is_binary() { + let message = format!("{message:?}"); + tracing::error!(?message, "Invalid packet"); + return Some(Err(TunnelError::InvalidPacket(message))); + } + Some(Ok(ZCPacket::new_from_buf( + BytesMut::from(message.into_payload().as_bytes()), + ZCPacketType::DummyTunnel, + ))) +} + +#[derive(Debug)] +struct SkipServerVerification(Arc); + +impl SkipServerVerification { + fn new(provider: Arc) -> Arc { + Arc::new(Self(provider)) + } +} + +impl rustls::client::danger::ServerCertVerifier for SkipServerVerification { + fn verify_server_cert( + &self, + _end_entity: &rustls::pki_types::CertificateDer<'_>, + _intermediates: &[rustls::pki_types::CertificateDer<'_>], + _server_name: &rustls::pki_types::ServerName<'_>, + _ocsp: &[u8], + _now: rustls::pki_types::UnixTime, + ) -> Result { + Ok(rustls::client::danger::ServerCertVerified::assertion()) + } + + fn verify_tls12_signature( + &self, + message: &[u8], + cert: &rustls::pki_types::CertificateDer<'_>, + dss: &rustls::DigitallySignedStruct, + ) -> Result { + rustls::crypto::verify_tls12_signature( + message, + cert, + dss, + &self.0.signature_verification_algorithms, + ) + } + + fn verify_tls13_signature( + &self, + message: &[u8], + cert: &rustls::pki_types::CertificateDer<'_>, + dss: &rustls::DigitallySignedStruct, + ) -> Result { + rustls::crypto::verify_tls13_signature( + message, + cert, + dss, + &self.0.signature_verification_algorithms, + ) + } + + fn supported_verify_schemes(&self) -> Vec { + self.0.signature_verification_algorithms.supported_schemes() + } +} + +fn get_insecure_tls_client_config() -> rustls::ClientConfig { + // Library callers may not have initialized a process-wide provider. + // Use the same explicit backend for TLS and signature verification. + let provider = Arc::new(rustls::crypto::ring::default_provider()); + let mut config = rustls::ClientConfig::builder_with_provider(provider.clone()) + .with_safe_default_protocol_versions() + .expect("ring supports the default TLS protocol versions") + .dangerous() + .with_custom_certificate_verifier(SkipServerVerification::new(provider)) + .with_no_client_auth(); + config.enable_sni = true; + config.enable_early_data = false; + config +} + +fn get_insecure_tls_cert<'a>() -> ( + Vec>, + rustls::pki_types::PrivateKeyDer<'a>, +) { + let cert = rcgen::generate_simple_self_signed(vec!["localhost".into()]).unwrap(); + let cert_der = cert.cert.der().clone(); + let private_key = cert.signing_key.serialize_der(); + let private_key = rustls::pki_types::PrivatePkcs8KeyDer::from(private_key); + (vec![cert_der], private_key.into()) +} + +pub(crate) async fn upgrade_accepted( + stream: S, + local_url: url::Url, +) -> Result, TunnelError> +where + S: VirtualTcpSocket, +{ + let peer_addr = stream.peer_addr()?; + let mut remote_url = socket_url(local_url.scheme(), peer_addr); + let stream = if is_wss(&local_url)? { + let (certificates, private_key) = get_insecure_tls_cert(); + // Do not rely on another tunnel initializing the global provider. + let config = rustls::ServerConfig::builder_with_provider(Arc::new( + rustls::crypto::ring::default_provider(), + )) + .with_safe_default_protocol_versions() + .with_context(|| "Failed to select TLS protocol versions")? + .with_no_client_auth() + .with_single_cert(certificates, private_key) + .with_context(|| "Failed to create server config")?; + Either::Left(TlsAcceptor::from(Arc::new(config)).accept(stream).await?) + } else { + Either::Right(stream) + }; + + let (request, stream) = ServerBuilder::new() + .limits(Limits::unlimited()) + .max_headers(128) + .accept(stream) + .await + .map_err(websocket_error)?; + + if trusted_proxy_contains(peer_addr.ip()) + && let Some(forwarded) = request + .headers() + .get("Forwarded") + .and_then(|value| value.to_str().ok()) + .and_then(|value| ForwardedHeaderValue::from_forwarded(value).ok()) + .or_else(|| { + request + .headers() + .get("X-Forwarded-For") + .and_then(|value| value.to_str().ok()) + .and_then(|value| ForwardedHeaderValue::from_x_forwarded_for(value).ok()) + }) + && let Some(ip) = forwarded.remotest_forwarded_for_ip() + { + remote_url + .set_host(Some(&ip.to_string())) + .map_err(|_| TunnelError::InvalidAddr(format!("invalid forwarded ip {ip}")))?; + remote_url + .query_pairs_mut() + .append_pair("proxy", &peer_addr.to_string()); + } + + let (write, read) = stream.split(); + let remote_url: crate::proto::common::Url = remote_url.into(); + let info = TunnelInfo { + tunnel_type: local_url.scheme().to_owned(), + local_addr: Some(local_url.into()), + remote_addr: Some(remote_url.clone()), + resolved_remote_addr: Some(remote_url), + }; + Ok(Box::new(TunnelWrapper::new( + read.filter_map(map_from_ws_message), + WebSocketPacketSink::new(write), + Some(info), + ))) +} + +fn socket_url(scheme: &str, addr: SocketAddr) -> url::Url { + let mut url = url::Url::parse(&format!("{scheme}://0.0.0.0")) + .expect("WebSocket transport scheme should be a valid URL scheme"); + url.set_ip_host(addr.ip()).unwrap(); + url.set_port(Some(addr.port())).unwrap(); + url +} + +#[derive(Debug)] +pub struct WsTunnelListener { + addr: url::Url, + listener: Option, + socket_mark: Option, +} + +impl WsTunnelListener { + pub fn new(addr: url::Url) -> Self { + WsTunnelListener { + addr, + listener: None, + socket_mark: None, + } + } + + pub fn set_socket_mark(&mut self, socket_mark: Option) { + self.socket_mark = socket_mark; + } + + async fn listen_tunnel(&mut self) -> Result<(), TunnelError> { + self.listener = None; + + let addr = SocketAddr::from_url(self.addr.clone(), IpVersion::Both).await?; + let listener = bind::() + .addr(addr) + .only_v6(true) + .maybe_socket_mark(self.socket_mark) + .call() + .await?; + + self.addr + .set_port(Some(listener.local_addr()?.port())) + .unwrap(); + self.listener = Some(listener); + + Ok(()) + } + + async fn accept_tunnel(&mut self) -> Result, TunnelError> { + loop { + let listener = self.listener.as_ref().unwrap(); + // only fail on tcp accept error + let (stream, _) = listener.accept().await?; + stream.set_nodelay(true).unwrap(); + match timeout( + SERVER_HANDSHAKE_TIMEOUT, + upgrade_accepted(RuntimeTcpSocket::new(stream), self.addr.clone()), + ) + .await + { + Ok(Ok(tunnel)) => return Ok(tunnel), + e => { + tracing::error!(?e, ?self, "Failed to accept ws/wss tunnel"); + continue; + } + } + } + } +} + +#[async_trait::async_trait] +impl easytier_core::socket::SocketListener for WsTunnelListener { + type Accepted = Box; + + async fn listen(&mut self) -> anyhow::Result<()> { + Ok(self.listen_tunnel().await?) + } + + async fn accept(&mut self) -> anyhow::Result { + Ok(self.accept_tunnel().await?) + } + + fn local_url(&self) -> url::Url { + self.addr.clone() + } +} + +pub(crate) async fn upgrade_connected( + stream: S, + remote_url: url::Url, +) -> Result, TunnelError> +where + S: VirtualTcpSocket, +{ + let is_wss = is_wss(&remote_url)?; + let local_addr = stream.local_addr()?; + let resolved_remote_addr = stream.peer_addr()?; + let info = TunnelInfo { + tunnel_type: remote_url.scheme().to_owned(), + local_addr: Some( + super::build_url_from_socket_addr(&local_addr.to_string(), remote_url.scheme()).into(), + ), + remote_addr: Some(remote_url.clone().into()), + resolved_remote_addr: Some( + super::build_url_from_socket_addr( + &resolved_remote_addr.to_string(), + remote_url.scheme(), + ) + .into(), + ), + }; + + let client = ClientBuilder::from_uri(http::Uri::try_from(remote_url.to_string()).unwrap()) + .max_headers(128); + let stream: MaybeTlsStream = if is_wss { + let tls = tokio_rustls::TlsConnector::from(Arc::new(get_insecure_tls_client_config())); + let sni = remote_url.domain().unwrap_or("localhost").to_owned(); + let server_name = rustls::pki_types::ServerName::try_from(sni) + .map_err(|_| TunnelError::InvalidProtocol("Invalid SNI".to_owned()))?; + MaybeTlsStream::Rustls(tls.connect(server_name, stream).await?) + } else { + MaybeTlsStream::Plain(stream) + }; + + let (client, _) = client.connect_on(stream).await.map_err(websocket_error)?; + let (write, read) = client.split(); + Ok(Box::new(TunnelWrapper::new( + read.filter_map(map_from_ws_message), + WebSocketPacketSink::new(write), + Some(info), + ))) +} + +#[cfg(test)] +pub mod tests { + use super::*; + use easytier_core::socket::SocketListener; + use futures::SinkExt; + use std::io; + use tokio::{ + io::{AsyncReadExt, AsyncWriteExt}, + net::TcpSocket, + }; + + struct FailingWebSocketSink { + close_called: bool, + } + + impl Sink for FailingWebSocketSink { + type Error = io::Error; + + fn poll_ready( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + ) -> Poll> { + Poll::Ready(Ok(())) + } + + fn start_send(self: Pin<&mut Self>, _item: Message) -> Result<(), Self::Error> { + Ok(()) + } + + fn poll_flush( + self: Pin<&mut Self>, + _cx: &mut Context<'_>, + ) -> Poll> { + Poll::Ready(Err(io::Error::new( + io::ErrorKind::BrokenPipe, + "send failed", + ))) + } + + fn poll_close( + mut self: Pin<&mut Self>, + _cx: &mut Context<'_>, + ) -> Poll> { + self.close_called = true; + Poll::Ready(Err(io::Error::new( + io::ErrorKind::BrokenPipe, + "close failed", + ))) + } + } + + #[tokio::test] + async fn packet_sink_maps_send_and_close_errors_independently() { + let mut sink = WebSocketPacketSink::new(FailingWebSocketSink { + close_called: false, + }); + + sink.send(ZCPacket::new_with_payload(b"packet")) + .await + .expect_err("send should fail"); + sink.close().await.expect_err("close should fail"); + assert!(sink.inner.close_called); + } + + #[tokio::test] + async fn ws_forwarded() { + let mut listener = WsTunnelListener::new("ws://127.0.0.1:25559".parse().unwrap()); + listener.listen().await.unwrap(); + + let server_task = tokio::spawn(async move { + let tunnel = listener.accept().await.unwrap(); + + let remote_addr = tunnel + .info() + .unwrap() + .remote_addr + .unwrap() + .url + .parse::() + .unwrap(); + + assert_eq!(remote_addr.host_str().unwrap(), "203.0.113.5"); + let proxy_addr = remote_addr + .query_pairs() + .find(|(k, _)| k == "proxy") + .map(|(_, v)| v.into_owned()) + .unwrap(); + assert_eq!(proxy_addr, "127.0.0.1:25560"); + + tunnel + }); + + let socket = TcpSocket::new_v4().unwrap(); + socket.bind("127.0.0.1:25560".parse().unwrap()).unwrap(); + let mut stream = socket + .connect("127.0.0.1:25559".parse().unwrap()) + .await + .unwrap(); + + let handshake = "GET / HTTP/1.1\r\n\ + Host: 127.0.0.1:25559\r\n\ + Upgrade: websocket\r\n\ + Connection: Upgrade\r\n\ + Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r\n\ + Sec-WebSocket-Version: 13\r\n\ + X-Forwarded-For: 203.0.113.5, 192.168.1.1\r\n\ + \r\n"; + + stream.write_all(handshake.as_bytes()).await.unwrap(); + + let mut buf = [0u8; 1024]; + let bytes_read = stream.read(&mut buf).await.unwrap(); + let response = String::from_utf8_lossy(&buf[..bytes_read]); + + assert!(response.contains("101 Switching Protocols")); + + let _tunnel = server_task.await.unwrap(); + } +} diff --git a/vendor/easytier/easytier/src/tunnel/wireguard.rs b/vendor/easytier/easytier/src/tunnel/wireguard.rs new file mode 100644 index 0000000..8336a52 --- /dev/null +++ b/vendor/easytier/easytier/src/tunnel/wireguard.rs @@ -0,0 +1,871 @@ +use std::{ + fmt::{Debug, Formatter}, + net::SocketAddr, + pin::Pin, + sync::{Arc, atomic::AtomicBool}, + time::Duration, +}; + +use quanta::Instant; + +use super::FromUrl; +use crate::{ + common::{netns::NetNS, shrink_dashmap}, + proto::common::TunnelInfo, + socket::udp::{RuntimeUdpSessionSocketListener, new_runtime_udp_session_listener}, + tunnel::{TunnelUrl, build_url_from_socket_addr}, +}; +use anyhow::Context; +use async_recursion::async_recursion; +use async_trait::async_trait; +use boringtun::{ + noise::{Tunn, TunnResult, errors::WireGuardError}, + x25519::{PublicKey, StaticSecret}, +}; +use bytes::BytesMut; +use crossbeam::atomic::AtomicCell; +use dashmap::DashMap; +use easytier_core::tunnel::ring::create_ring_tunnel_pair; +use easytier_core::tunnel::{IpVersion, Tunnel, TunnelError, ZCPacketSink, ZCPacketStream}; +use easytier_core::{ + connectivity::transport::ConnectedUdpSession, + packet::{PEER_MANAGER_HEADER_SIZE, WG_TUNNEL_HEADER_SIZE, ZCPacket, ZCPacketType}, + socket::udp::{ + UdpBindOptions, UdpSession, UdpSessionAcceptKind, UdpSessionListenRequest, + UdpSessionProtocol, UdpSessionSocket, + }, + tunnel::wrapper::TunnelWrapper, +}; +use futures::{SinkExt, StreamExt}; +use rand::RngCore; +use tokio::{ + sync::{Mutex, mpsc::unbounded_channel}, + task::JoinSet, +}; + +use crate::utils::buf::FixedBufPool; +use std::sync::LazyLock; + +/// Maximum size of a single WireGuard UDP packet (payload + headers + auth tag). +/// Standard Ethernet MTU is 1500; 2048 safely accommodates any WireGuard datagram. +pub const WG_MAX_PACKET_SIZE: usize = 2048; + +static WG_BUF_POOL: LazyLock> = + LazyLock::new(|| FixedBufPool::new(64)); + +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +enum WgType { + InternalUse, + ExternalUse, +} + +#[derive(Clone)] +pub struct WgConfig { + my_secret_key: StaticSecret, + my_public_key: PublicKey, + peer_secret_key: StaticSecret, + peer_public_key: PublicKey, + wg_type: WgType, +} + +impl WgConfig { + pub fn new_from_network_identity(network_name: &str, network_secret: &str) -> Self { + let mut secret = [0u8; 32]; + super::generate_digest_from_str(network_name, network_secret, &mut secret); + Self::new_internal(secret, secret) + } + + pub fn new_for_portal(server_key_seed: &str, client_key_seed: &str) -> Self { + let server_cfg = Self::new_from_network_identity("server", server_key_seed); + let client_cfg = Self::new_from_network_identity("client", client_key_seed); + Self { + my_secret_key: server_cfg.my_secret_key, + my_public_key: server_cfg.my_public_key, + peer_secret_key: client_cfg.my_secret_key, + peer_public_key: client_cfg.my_public_key, + wg_type: WgType::ExternalUse, + } + } + + pub fn new_internal(my_secret_key: [u8; 32], peer_secret_key: [u8; 32]) -> Self { + let my_secret_key = StaticSecret::from(my_secret_key); + let my_public_key = PublicKey::from(&my_secret_key); + let peer_secret_key = StaticSecret::from(peer_secret_key); + let peer_public_key = PublicKey::from(&peer_secret_key); + Self { + my_secret_key, + my_public_key, + peer_secret_key, + peer_public_key, + wg_type: WgType::InternalUse, + } + } + + pub fn my_secret_key(&self) -> &[u8] { + self.my_secret_key.as_bytes() + } + + pub fn peer_secret_key(&self) -> &[u8] { + self.peer_secret_key.as_bytes() + } + + pub fn my_public_key(&self) -> &[u8] { + self.my_public_key.as_bytes() + } + + pub fn peer_public_key(&self) -> &[u8] { + self.peer_public_key.as_bytes() + } + + pub fn is_internal(&self) -> bool { + self.wg_type == WgType::InternalUse + } +} + +#[cfg(test)] +mod config_tests { + use super::*; + + #[test] + fn network_identity_produces_matching_internal_key_pairs() { + let config = WgConfig::new_from_network_identity("network", "secret"); + + assert!(config.is_internal()); + assert_eq!(config.my_secret_key(), config.peer_secret_key()); + assert_eq!(config.my_public_key(), config.peer_public_key()); + assert_eq!( + PublicKey::from(&StaticSecret::from( + <[u8; 32]>::try_from(config.my_secret_key()).unwrap() + )) + .as_bytes(), + config.my_public_key() + ); + } + + #[test] + fn portal_uses_distinct_external_key_pairs() { + let config = WgConfig::new_for_portal("server-seed", "client-seed"); + + assert!(!config.is_internal()); + assert_ne!(config.my_secret_key(), config.peer_secret_key()); + assert_ne!(config.my_public_key(), config.peer_public_key()); + } +} + +#[derive(Clone)] +struct WgPeerData { + session: Arc, + endpoint: SocketAddr, + tunn: Arc>, + internal_use: bool, + access_time: Arc>, + stopped: Arc, +} + +impl Debug for WgPeerData { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + f.debug_struct("WgPeerData") + .field("endpoint", &self.endpoint) + .field("local", &self.session.local_addr()) + .finish() + } +} + +impl WgPeerData { + #[tracing::instrument] + async fn handle_one_packet_from_me(&self, zc_packet: ZCPacket) -> Result<(), anyhow::Error> { + let mut send_buf = WG_BUF_POOL.acquire(); + + let packet = if self.internal_use { + let mut zc_packet = zc_packet.convert_type(ZCPacketType::WG); + Self::fill_ip_header(&mut zc_packet); + zc_packet.into_bytes() + } else { + zc_packet.convert_type(ZCPacketType::WG).into_bytes() + }; + tracing::trace!(?packet, "Sending packet to peer"); + + let encapsulate_result = { + let mut peer = self.tunn.lock().await; + peer.encapsulate(&packet, &mut send_buf) + }; + + tracing::trace!( + ?encapsulate_result, + "Received {} bytes from me", + packet.len() + ); + + match encapsulate_result { + TunnResult::WriteToNetwork(packet) => { + self.session + .send(packet) + .await + .context("Failed to send encrypted IP packet to WireGuard endpoint.")?; + tracing::debug!( + "Sent {} bytes to WireGuard endpoint (encrypted IP packet)", + packet.len() + ); + } + TunnResult::Err(e) => { + tracing::error!("Failed to encapsulate IP packet: {:?}", e); + } + TunnResult::Done => { + // Ignored + } + other => { + tracing::error!( + "Unexpected WireGuard state during encapsulation: {:?}", + other + ); + } + }; + Ok(()) + } + + /// WireGuard consumption task. Receives encrypted packets from the WireGuard endpoint, + /// decapsulates them, and dispatches newly received IP packets. + #[tracing::instrument(skip(sink))] + pub async fn handle_one_packet_from_peer( + &self, + mut sink: S, + recv_buf: &[u8], + ) { + self.access_time.store(Instant::now()); + let mut send_buf = WG_BUF_POOL.acquire(); + let data = recv_buf; + let decapsulate_result = { + let mut peer = self.tunn.lock().await; + peer.decapsulate(None, data, &mut send_buf) + }; + + tracing::debug!("Decapsulation result: {:?}", decapsulate_result); + + match decapsulate_result { + TunnResult::WriteToNetwork(packet) => { + match self.session.send(packet).await { + Ok(_) => {} + Err(e) => { + tracing::error!( + "Failed to send decapsulation-instructed packet to WireGuard endpoint: {:?}", + e + ); + return; + } + }; + let mut peer = self.tunn.lock().await; + loop { + let mut send_buf = WG_BUF_POOL.acquire(); + match peer.decapsulate(None, &[], &mut send_buf) { + TunnResult::WriteToNetwork(packet) => { + match self.session.send(packet).await { + Ok(_) => {} + Err(e) => { + tracing::error!( + "Failed to send decapsulation-instructed packet to WireGuard endpoint: {:?}", + e + ); + break; + } + }; + } + _ => { + break; + } + } + } + } + TunnResult::WriteToTunnelV4(packet, _) | TunnResult::WriteToTunnelV6(packet, _) => { + tracing::debug!( + ?packet, + "receive IP packet from peer: {} bytes", + packet.len() + ); + let mut b = BytesMut::new(); + if self.internal_use { + b.resize(WG_TUNNEL_HEADER_SIZE, 0); + b.extend_from_slice(self.remove_ip_header(packet, packet[0] >> 4 == 4)); + } else { + b.extend_from_slice(packet); + }; + let zc_packet = ZCPacket::new_from_buf(b, ZCPacketType::WG); + tracing::trace!(?zc_packet, "forward zc_packet to sink"); + let ret = sink.send(zc_packet).await; + if ret.is_err() { + tracing::error!("Failed to send packet to tunnel: {:?}", ret); + } + } + _ => { + tracing::debug!( + "Unexpected WireGuard state during decapsulation: {:?}", + decapsulate_result + ); + } + } + } + + #[tracing::instrument] + #[async_recursion] + async fn handle_routine_tun_result<'a: 'async_recursion>(&self, result: TunnResult<'a>) -> () { + match result { + TunnResult::WriteToNetwork(packet) => { + tracing::debug!( + "Sending routine packet of {} bytes to WireGuard endpoint", + packet.len() + ); + match self.session.send(packet).await { + Ok(_) => {} + Err(e) => { + tracing::error!( + "Failed to send routine packet to WireGuard endpoint: {:?}", + e + ); + } + }; + } + TunnResult::Err(WireGuardError::ConnectionExpired) => { + tracing::warn!("Wireguard handshake has expired!"); + + let mut buf = WG_BUF_POOL.acquire(); + let result = self + .tunn + .lock() + .await + .format_handshake_initiation(&mut buf[..], false); + + self.handle_routine_tun_result(result).await + } + TunnResult::Err(e) => { + tracing::error!( + "Failed to prepare routine packet for WireGuard endpoint: {:?}", + e + ); + } + TunnResult::Done => { + // Sleep for a bit + tokio::time::sleep(Duration::from_millis(250)).await; + } + other => { + tracing::warn!("Unexpected WireGuard routine task state: {:?}", other); + tokio::time::sleep(Duration::from_millis(250)).await; + } + }; + } + + /// WireGuard Routine task. Handles Handshake, keep-alive, etc. + pub async fn routine_task(self) { + loop { + let mut send_buf = WG_BUF_POOL.acquire(); + let tun_result = { self.tunn.lock().await.update_timers(&mut send_buf) }; + self.handle_routine_tun_result(tun_result).await; + } + } + + fn fill_ip_header(zc_packet: &mut ZCPacket) { + let len = zc_packet.payload_len() + PEER_MANAGER_HEADER_SIZE; + let ip_header = &mut zc_packet.mut_wg_tunnel_header().unwrap().ipv4_header; + ip_header[0] = 0x45; + ip_header[1] = 0; + ip_header[2..4].copy_from_slice(&((len + 20) as u16).to_be_bytes()); + ip_header[4..6].copy_from_slice(&0u16.to_be_bytes()); + ip_header[6..8].copy_from_slice(&0u16.to_be_bytes()); + ip_header[8] = 64; + ip_header[9] = 0; + ip_header[10..12].copy_from_slice(&0u16.to_be_bytes()); + ip_header[12..16].copy_from_slice(&0u32.to_be_bytes()); + ip_header[16..20].copy_from_slice(&0u32.to_be_bytes()); + } + + fn remove_ip_header<'a>(&self, packet: &'a [u8], is_v4: bool) -> &'a [u8] { + if is_v4 { &packet[20..] } else { &packet[40..] } + } +} + +struct WgPeer { + tunn: Option>, + _session_guard: Box, + session: Arc, + config: WgConfig, + endpoint: SocketAddr, + + sink: std::sync::Mutex>>>, + + data: Option, + tasks: JoinSet<()>, + + access_time: Arc>, +} + +impl WgPeer { + fn new( + session_guard: Box, + session: Arc, + config: WgConfig, + endpoint: SocketAddr, + ) -> Self { + WgPeer { + tunn: Some(Mutex::new(Tunn::new( + StaticSecret::from(<[u8; 32]>::try_from(config.my_secret_key()).unwrap()), + PublicKey::from(<[u8; 32]>::try_from(config.peer_public_key()).unwrap()), + None, + None, + rand::thread_rng().next_u32(), + None, + ))), + + _session_guard: session_guard, + session, + config, + endpoint, + sink: std::sync::Mutex::new(None), + + data: None, + tasks: JoinSet::new(), + + access_time: Arc::new(AtomicCell::new(Instant::now())), + } + } + + async fn handle_packet_from_me(mut stream: S, data: WgPeerData) { + while let Some(Ok(packet)) = stream.next().await { + let ret = data.handle_one_packet_from_me(packet).await; + if let Err(e) = ret { + tracing::error!("Failed to handle packet from me: {}", e); + } + } + data.stopped + .store(true, std::sync::atomic::Ordering::Relaxed); + } + + fn start_and_get_tunnel(&mut self) -> Box { + let (stunnel, ctunnel) = create_ring_tunnel_pair(); + + let (stream, sink) = stunnel.split(); + + let data = WgPeerData { + session: self.session.clone(), + endpoint: self.endpoint, + tunn: Arc::new(self.tunn.take().unwrap()), + internal_use: self.config.is_internal(), + access_time: self.access_time.clone(), + stopped: Arc::new(AtomicBool::new(false)), + }; + + self.data = Some(data.clone()); + self.sink.lock().unwrap().replace(sink); + + self.tasks + .spawn(Self::handle_packet_from_me(stream, data.clone())); + self.tasks.spawn(data.routine_task()); + + ctunnel + } + + fn stopped(&self) -> bool { + self.data + .as_ref() + .unwrap() + .stopped + .load(std::sync::atomic::Ordering::Relaxed) + } + + async fn create_handshake_init(&self) -> Vec { + let mut dst = vec![0u8; 2048]; + let handshake_init = self + .tunn + .as_ref() + .unwrap() + .lock() + .await + .format_handshake_initiation(&mut dst, false); + assert!(matches!(handshake_init, TunnResult::WriteToNetwork(_))); + let handshake_init = if let TunnResult::WriteToNetwork(sent) = handshake_init { + sent + } else { + unreachable!(); + }; + + handshake_init.into() + } + + fn spawn_session_recv_task(&mut self, first_packet: Option>) { + let session = self.session.clone(); + let data = self.data.as_ref().unwrap().clone(); + let mut sink = self.sink.lock().unwrap().take().unwrap(); + self.tasks.spawn(async move { + if let Some(packet) = first_packet { + data.handle_one_packet_from_peer(&mut sink, &packet).await; + } + + let mut buf = vec![0u8; WG_MAX_PACKET_SIZE]; + loop { + let n = match session.recv(&mut buf).await { + Ok(n) => n, + Err(e) => { + tracing::error!("Failed to receive wg packet: {}", e); + data.stopped + .store(true, std::sync::atomic::Ordering::Relaxed); + break; + } + }; + data.handle_one_packet_from_peer(&mut sink, &buf[..n]).await; + } + }); + } +} + +type ConnSender = tokio::sync::mpsc::UnboundedSender>; +type ConnReceiver = tokio::sync::mpsc::UnboundedReceiver>; + +pub struct WgTunnelListener { + addr: url::Url, + session_listener: Option>, + socket_mark: Option, + config: WgConfig, + + conn_recv: ConnReceiver, + conn_send: Option, + + wg_peer_map: Arc>>, + + tasks: JoinSet<()>, +} + +impl Debug for WgTunnelListener { + fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result { + formatter + .debug_struct("WgTunnelListener") + .field("addr", &self.addr) + .field("listening", &self.session_listener.is_some()) + .finish() + } +} + +impl WgTunnelListener { + pub fn new(addr: url::Url, config: WgConfig) -> Self { + let (conn_send, conn_recv) = unbounded_channel(); + WgTunnelListener { + addr, + session_listener: None, + socket_mark: None, + config, + + conn_recv, + conn_send: Some(conn_send), + + wg_peer_map: Arc::new(DashMap::new()), + + tasks: JoinSet::new(), + } + } + + pub fn set_socket_mark(&mut self, socket_mark: Option) { + self.socket_mark = socket_mark; + } + + async fn accept_udp_sessions( + session_listener: Arc, + config: WgConfig, + conn_sender: ConnSender, + peer_map: Arc>>, + ) { + let mut tasks = JoinSet::new(); + + let peer_map_clone: Arc>> = peer_map.clone(); + tasks.spawn(async move { + loop { + peer_map_clone.retain(|_, peer| { + peer.access_time.load().elapsed().as_secs() < 61 && !peer.stopped() + }); + shrink_dashmap(&peer_map_clone, None); + tokio::time::sleep(Duration::from_secs(1)).await; + } + }); + + loop { + let session = match session_listener.accept_session().await { + Ok(session) => Arc::new(session) as Arc, + Err(e) => { + tracing::error!("Failed to accept wg udp session: {}", e); + break; + } + }; + let addr = match session.peer_addr() { + Ok(addr) => addr, + Err(e) => { + tracing::error!("Failed to get wg session peer addr: {}", e); + continue; + } + }; + if peer_map.contains_key(&addr) { + continue; + } + let local_addr = match session.local_addr() { + Ok(addr) => addr, + Err(e) => { + tracing::error!("Failed to get wg session local addr: {}", e); + continue; + } + }; + + tracing::info!("New peer: {}", addr); + let mut wg = WgPeer::new( + Box::new(session_listener.clone()), + session, + config.clone(), + addr, + ); + let (stream, sink) = wg.start_and_get_tunnel().split(); + wg.spawn_session_recv_task(None); + let tunnel = Box::new(TunnelWrapper::new( + stream, + sink, + Some(TunnelInfo { + tunnel_type: "wg".to_owned(), + local_addr: Some( + build_url_from_socket_addr(&local_addr.to_string(), "wg").into(), + ), + remote_addr: Some(build_url_from_socket_addr(&addr.to_string(), "wg").into()), + resolved_remote_addr: Some( + build_url_from_socket_addr(&addr.to_string(), "wg").into(), + ), + }), + )); + if let Err(e) = conn_sender.send(tunnel) { + tracing::error!("Failed to send tunnel to conn_sender: {}", e); + break; + } + peer_map.insert(addr, Arc::new(wg)); + } + } + + async fn listen_tunnel(&mut self) -> Result<(), TunnelError> { + if self.session_listener.is_some() { + return Ok(()); + } + + let local_addr = SocketAddr::from_url(self.addr.clone(), IpVersion::Both).await?; + let bind = UdpBindOptions::port_bound_listener(local_addr) + .with_socket_mark(self.socket_mark) + .with_bind_device(TunnelUrl::from(self.addr.clone()).bind_dev()) + .with_only_v6(true); + let mut session_listener = new_runtime_udp_session_listener( + self.addr.clone(), + UdpSessionListenRequest::new(bind), + UdpSessionAcceptKind::Classified(UdpSessionProtocol::WireGuard), + NetNS::new(None), + ); + easytier_core::socket::SocketListener::listen(&mut session_listener).await?; + let session_listener = Arc::new(session_listener); + + self.tasks.spawn(Self::accept_udp_sessions( + session_listener.clone(), + self.config.clone(), + self.conn_send.take().unwrap(), + self.wg_peer_map.clone(), + )); + self.session_listener = Some(session_listener); + + Ok(()) + } + + async fn accept_tunnel(&mut self) -> Result, TunnelError> { + if let Some(tunnel) = self.conn_recv.recv().await { + tracing::info!(?tunnel, "Accepted tunnel"); + return Ok(tunnel); + } + Err(TunnelError::Shutdown) + } +} + +#[async_trait] +impl easytier_core::socket::SocketListener for WgTunnelListener { + type Accepted = Box; + + async fn listen(&mut self) -> anyhow::Result<()> { + Ok(self.listen_tunnel().await?) + } + + async fn accept(&mut self) -> anyhow::Result { + Ok(self.accept_tunnel().await?) + } + + fn local_url(&self) -> url::Url { + self.session_listener + .as_ref() + .map(|listener| easytier_core::socket::SocketListener::local_url(listener.as_ref())) + .unwrap_or_else(|| self.addr.clone()) + } +} + +pub(crate) async fn upgrade_connected( + connected: ConnectedUdpSession, + addr_url: url::Url, + config: WgConfig, +) -> Result, TunnelError> { + let (session, session_guard) = connected.into_parts(); + let session = Arc::new(session) as Arc; + let addr = session.peer_addr()?; + let local_addr = session + .local_addr() + .with_context(|| "Failed to get local addr")? + .to_string(); + + let mut wg_peer = WgPeer::new(session_guard, session.clone(), config.clone(), addr); + + // do handshake here so we will return after receive first packet + let handshake = wg_peer.create_handshake_init().await; + session.send(&handshake).await?; + let mut buf = [0u8; WG_MAX_PACKET_SIZE]; + let n = match session.recv(&mut buf).await { + Ok(ret) => ret, + Err(e) => { + tracing::error!("Failed to receive handshake response: {}", e); + return Err(TunnelError::IOError(e)); + } + }; + + let tunnel = wg_peer.start_and_get_tunnel(); + wg_peer.spawn_session_recv_task(Some(buf[..n].to_vec())); + + let (stream, sink) = tunnel.split(); + let ret = Box::new(TunnelWrapper::new_with_associate_data( + stream, + sink, + Some(TunnelInfo { + tunnel_type: "wg".to_owned(), + local_addr: Some(super::build_url_from_socket_addr(&local_addr, "wg").into()), + remote_addr: Some(addr_url.into()), + resolved_remote_addr: Some( + super::build_url_from_socket_addr(&addr.to_string(), "wg").into(), + ), + }), + Some(Box::new(wg_peer)), + )); + + Ok(ret) +} + +pub(crate) fn upgrade_accepted( + session: UdpSession, + config: WgConfig, +) -> Result, TunnelError> { + let session = Arc::new(session) as Arc; + let remote_addr = session.peer_addr()?; + let local_addr = session.local_addr()?; + let mut wg_peer = WgPeer::new(Box::new(()), session, config, remote_addr); + let tunnel = wg_peer.start_and_get_tunnel(); + wg_peer.spawn_session_recv_task(None); + + let (stream, sink) = tunnel.split(); + let remote_url = build_url_from_socket_addr(&remote_addr.to_string(), "wg"); + Ok(Box::new(TunnelWrapper::new_with_associate_data( + stream, + sink, + Some(TunnelInfo { + tunnel_type: "wg".to_owned(), + local_addr: Some(build_url_from_socket_addr(&local_addr.to_string(), "wg").into()), + remote_addr: Some(remote_url.clone().into()), + resolved_remote_addr: Some(remote_url.into()), + }), + Some(Box::new(wg_peer)), + ))) +} + +#[cfg(test)] +pub mod tests { + use super::*; + use crate::{ + common::global_ctx::tests::get_mock_global_ctx, host_runtime::native_host_runtime, + tunnel::protocol::runtime_client_protocol_upgrader, + }; + use easytier_core::{ + connectivity::transport::{ConnectedTransport, UdpSessionMode, connect_udp}, + socket::SocketListener, + socket::udp::{UdpBindOptions, UdpSessionProtocol}, + }; + + fn test_wg_config() -> WgConfig { + WgConfig::new_from_network_identity("test", "secret") + } + + #[tokio::test] + async fn wg_server_erase_from_map_after_close() { + let global_ctx = get_mock_global_ctx(); + let identity = global_ctx.get_network_identity(); + let server_cfg = WgConfig::new_from_network_identity( + &identity.network_name, + &identity.network_secret.unwrap_or_default(), + ); + let client = runtime_client_protocol_upgrader(global_ctx); + let mut listener = WgTunnelListener::new("wg://127.0.0.1:0".parse().unwrap(), server_cfg); + listener.listen().await.unwrap(); + let remote_url = listener.local_url(); + let remote_addr = remote_url.socket_addrs(|| None).unwrap()[0]; + + const CONN_COUNT: usize = 10; + + let client_task = tokio::spawn(async move { + let mut tunnels = Vec::with_capacity(CONN_COUNT); + for _ in 0..CONN_COUNT { + let connected = connect_udp( + native_host_runtime(), + remote_addr, + Vec::new(), + UdpBindOptions::direct_connect(), + UdpSessionMode::Classified(UdpSessionProtocol::WireGuard), + ) + .await + .unwrap(); + let tunnel = client + .upgrade_client(ConnectedTransport::Udp(connected), remote_url.clone()) + .await + .unwrap(); + let (_stream, mut sink) = tunnel.split(); + sink.send(ZCPacket::new_with_payload(b"payload")) + .await + .unwrap(); + tunnels.push(tunnel); + } + tokio::time::sleep(Duration::from_secs(1)).await; + }); + + for _ in 0..CONN_COUNT { + let tunnel = listener.accept().await.unwrap(); + let (mut stream, _sink) = tunnel.split(); + let packet = stream.next().await.unwrap().unwrap(); + assert_eq!(packet.payload(), b"payload"); + } + + client_task.await.unwrap(); + tokio::time::sleep(Duration::from_secs(2)).await; + assert!(listener.wg_peer_map.is_empty()); + } + + #[tokio::test] + async fn bind_same_port() { + let server_cfg = test_wg_config(); + let mut listener = WgTunnelListener::new("wg://[::1]:31015".parse().unwrap(), server_cfg); + let server_cfg = test_wg_config(); + let mut listener2 = WgTunnelListener::new("wg://[::1]:31015".parse().unwrap(), server_cfg); + listener.listen().await.unwrap(); + listener2.listen().await.unwrap(); + } + + #[tokio::test] + async fn test_alloc_port() { + // v4 + let server_cfg = test_wg_config(); + let mut listener = WgTunnelListener::new("wg://0.0.0.0:0".parse().unwrap(), server_cfg); + listener.listen().await.unwrap(); + let port = listener.local_url().port().unwrap(); + assert!(port > 0); + + // v6 + let server_cfg = test_wg_config(); + let mut listener = WgTunnelListener::new("wg://[::]:0".parse().unwrap(), server_cfg); + listener.listen().await.unwrap(); + let port = listener.local_url().port().unwrap(); + assert!(port > 0); + } +} diff --git a/vendor/easytier/easytier/src/utils/buf.rs b/vendor/easytier/easytier/src/utils/buf.rs new file mode 100644 index 0000000..5bc3290 --- /dev/null +++ b/vendor/easytier/easytier/src/utils/buf.rs @@ -0,0 +1,259 @@ +use bytes::{BufMut, BytesMut}; +use derive_more::{AsMut, AsRef, Deref, DerefMut, From, Into}; +use std::mem::{MaybeUninit, take}; +use std::ptr::copy_nonoverlapping; + +pub use easytier_core::tunnel::buf::BufList; + +#[derive(Debug, Clone, Copy, Default, From, Into, PartialEq, Eq)] +pub struct BufMargins { + pub header: usize, + pub trailer: usize, +} + +impl BufMargins { + #[inline(always)] + pub fn size(&self) -> usize { + self.header.checked_add(self.trailer).unwrap() + } +} + +/// A reusable packet buffer pool. +/// +/// # Initialization contract +/// +/// Buffers may contain uninitialized bytes in their [`BufMargins::header`] and +/// [`BufMargins::trailer`] regions. These regions must be fully initialized +/// before they are read or otherwise consumed. +#[derive(Debug)] +pub struct BufPool { + pool: BytesMut, + pub min_capacity: usize, +} + +impl BufPool { + #[inline(always)] + pub fn new(min_capacity: usize) -> Self { + Self { + pool: BytesMut::with_capacity(min_capacity), + min_capacity, + } + } + + #[inline(always)] + pub fn reserve(&mut self, additional: usize) { + if self.pool.capacity() - self.pool.len() < additional { + self.pool.reserve(additional.max(self.min_capacity)); + } + } + + /// Returns the accumulated buffer. + /// + /// The caller must ensure all reserved header and trailer regions have been + /// initialized before reading or consuming the returned buffer. + #[inline(always)] + pub fn split(&mut self) -> BytesMut { + self.pool.split() + } + + #[inline] + pub fn write(&mut self, chunk: &[u8], margins: BufMargins) { + let len = margins.size().checked_add(chunk.len()).unwrap(); + self.reserve(len); + // Header and trailer are intentionally left uninitialized. Users of this + // buffer must initialize both regions before reading or consuming it. + unsafe { + copy_nonoverlapping( + chunk.as_ptr(), + self.pool.chunk_mut().as_mut_ptr().add(margins.header), + chunk.len(), + ); + self.pool.advance_mut(len); + } + } + + /// Writes `chunk` with the requested margins and returns the resulting buffer. + /// + /// The header and trailer regions are left uninitialized and must be filled + /// before the returned buffer is read or consumed. + #[inline(always)] + pub fn buf(&mut self, chunk: &[u8], margins: BufMargins) -> BytesMut { + self.write(chunk, margins); + self.pool.split() + } + + #[inline(always)] + pub fn writer(&mut self, capacity: usize, margins: BufMargins) -> BufPoolWriter<'_> { + assert!(capacity >= margins.size()); + self.reserve(capacity); + BufPoolWriter { + pool: self, + capacity, + margins, + } + } +} + +/// A writer into a [`BufPool`]. +/// +/// # Initialization contract +/// +/// Committing data does not initialize the reserved header or trailer regions. +/// They must be fully initialized before the resulting buffer is read or consumed. +#[derive(Debug)] +pub struct BufPoolWriter<'t> { + pool: &'t mut BufPool, + capacity: usize, + margins: BufMargins, +} + +impl<'t> BufPoolWriter<'t> { + #[inline(always)] + pub fn reserve(&mut self, additional: usize) { + let capacity = self.capacity.checked_add(additional).unwrap(); + self.pool.reserve(capacity); + self.capacity = capacity; + } + + /// Returns the accumulated buffer. + /// + /// Reserved header and trailer regions must be initialized before the returned + /// buffer is read or consumed. + #[inline(always)] + pub fn split(&mut self) -> BytesMut { + self.pool.split() + } + + #[inline(always)] + pub fn remaining(&self) -> usize { + self.capacity.saturating_sub(self.margins.size()) + } + + #[inline(always)] + pub fn as_slice(&mut self) -> &mut [MaybeUninit] { + let remaining = self.remaining(); + if remaining == 0 { + &mut [] + } else { + &mut self.pool.pool.spare_capacity_mut() + [self.margins.header..self.margins.header + remaining] + } + } + + #[inline(always)] + pub fn commit(&mut self, written: usize) { + let len = self.margins.size().checked_add(written).unwrap(); + assert!(self.capacity >= len); + self.capacity -= len; + // `commit` marks the margins as part of the buffer without initializing them. + // They must be initialized before the resulting buffer is consumed. + unsafe { + self.pool.pool.advance_mut(len); + } + } +} + +/// A lock-free object pool for fixed-capacity reusable scratch buffers. +#[derive(Debug)] +pub struct FixedBufPool { + queue: crossbeam::queue::ArrayQueue>, +} + +impl FixedBufPool { + pub fn new(capacity: usize) -> Self { + Self { + queue: crossbeam::queue::ArrayQueue::new(capacity), + } + } + + pub fn acquire(&self) -> FixedBufGuard<'_, SIZE> { + let buf = self.queue.pop().unwrap_or_else(|| vec![0u8; SIZE]); + FixedBufGuard { pool: self, buf } + } +} + +#[derive(Debug, Deref, DerefMut, AsRef, AsMut)] +pub struct FixedBufGuard<'p, const SIZE: usize> { + pool: &'p FixedBufPool, + #[deref(forward)] + #[deref_mut(forward)] + #[as_ref([u8])] + #[as_mut([u8])] + buf: Vec, +} + +impl<'p, const SIZE: usize> Drop for FixedBufGuard<'p, SIZE> { + #[inline(always)] + fn drop(&mut self) { + let _ = self.pool.queue.push(take(&mut self.buf)); + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_buf_pool_write() { + let mut pool = BufPool::new(1024); + let margins = BufMargins { + header: 4, + trailer: 2, + }; + let data = b"hello world"; + pool.write(data, margins); + let buf = pool.split(); + assert_eq!(buf.len(), 4 + data.len() + 2); + assert_eq!(&buf[4..4 + data.len()], data); + } + + #[test] + fn test_buf_pool_writer() { + let mut pool = BufPool::new(1024); + let margins = BufMargins { + header: 10, + trailer: 6, + }; + let mut writer = pool.writer(64, margins); + let slice = writer.as_slice(); + assert_eq!(slice.len(), 64 - 10 - 6); + let data = b"packet content"; + unsafe { + std::ptr::copy_nonoverlapping(data.as_ptr(), slice.as_mut_ptr() as *mut u8, data.len()); + } + writer.commit(data.len()); + let buf = writer.split(); + assert_eq!(buf.len(), 10 + data.len() + 6); + assert_eq!(&buf[10..10 + data.len()], data); + } + + #[test] + fn test_fixed_buf_pool() { + let pool = FixedBufPool::<2048>::new(2); + + // 1. Acquire and verify size + let ptr1; + { + let mut buf1 = pool.acquire(); + assert_eq!(buf1.len(), 2048); + buf1[0] = 42; + ptr1 = buf1.as_ptr(); + } + + // 2. Re-acquire: should reuse the recycled buffer from the pool + { + let buf2 = pool.acquire(); + assert_eq!(buf2.len(), 2048); + assert_eq!(buf2[0], 42); // Same underlying memory was recycled + assert_eq!(buf2.as_ptr(), ptr1); + } + + // 3. Exceed pool capacity + let b1 = pool.acquire(); + let b2 = pool.acquire(); + let b3 = pool.acquire(); // exceeds capacity=2, allocates on demand + assert_eq!(b1.len(), 2048); + assert_eq!(b2.len(), 2048); + assert_eq!(b3.len(), 2048); + } +} diff --git a/vendor/easytier/easytier/src/utils/mod.rs b/vendor/easytier/easytier/src/utils/mod.rs new file mode 100644 index 0000000..ceb6085 --- /dev/null +++ b/vendor/easytier/easytier/src/utils/mod.rs @@ -0,0 +1,47 @@ +pub mod buf; +#[cfg(feature = "management")] +pub mod panic; +pub mod string; + +use std::net::{IpAddr, Ipv4Addr, SocketAddr, TcpListener}; +use std::sync::{Arc, Weak}; + +#[cfg(feature = "management")] +pub type PeerRoutePair = crate::proto::api::instance::PeerRoutePair; + +/// Select the process-wide TLS backend before starting application services. +pub fn init_crypto_provider() { + #[cfg(any( + feature = "endpoint-discovery", + feature = "quic", + feature = "websocket" + ))] + { + // Cargo features are additive: another dependency can enable aws-lc + // alongside ring, making rustls's automatic selection panic (#2607). + // Keep an existing provider chosen by an embedding application. + let _ = rustls::crypto::ring::default_provider().install_default(); + } +} + +pub fn check_tcp_available(port: u16) -> bool { + let s = SocketAddr::new(IpAddr::V4(Ipv4Addr::UNSPECIFIED), port); + TcpListener::bind(s).is_ok() +} + +pub fn find_free_tcp_port(mut range: std::ops::Range) -> Option { + range.find(|&port| check_tcp_available(port)) +} + +pub fn weak_upgrade(weak: &Weak) -> anyhow::Result> { + weak.upgrade() + .ok_or_else(|| anyhow::anyhow!("{} not available", std::any::type_name::())) +} + +pub trait BoxExt: Sized { + fn boxed(self) -> Box { + Box::new(self) + } +} + +impl BoxExt for T {} diff --git a/vendor/easytier/easytier/src/utils/panic.rs b/vendor/easytier/easytier/src/utils/panic.rs new file mode 100644 index 0000000..6421824 --- /dev/null +++ b/vendor/easytier/easytier/src/utils/panic.rs @@ -0,0 +1,99 @@ +use crate::common::log; +use indoc::formatdoc; +use std::fs::OpenOptions; +use std::str::FromStr; +use std::{backtrace, io::Write}; + +thread_local! { + static PANIC_COUNT : std::cell::RefCell = const { std::cell::RefCell::new(0) }; +} + +pub fn setup_panic_handler() { + std::panic::set_hook(Box::new(|info| { + let mut stderr = std::io::stderr(); + let sep = format!("{}\n", "=======".repeat(10)); + let _ = stderr.write_all(format!("{sep}{}\n{sep}", "!PANIC!".repeat(10)).as_bytes()); + + PANIC_COUNT.with(|c| { + let mut count = c.borrow_mut(); + *count += 1; + }); + let panic_count = PANIC_COUNT.with(|c| *c.borrow()); + if panic_count > 1 { + log::error!("panic happened more than once, exit immediately"); + std::process::exit(1); + } + + let payload = info.payload(); + let payload_str: Option<&str> = if let Some(s) = payload.downcast_ref::<&str>() { + Some(s) + } else if let Some(s) = payload.downcast_ref::() { + Some(s) + } else { + None + }; + let payload_str = payload_str.unwrap_or(""); + // The current implementation always returns `Some`. + let location = info.location().unwrap(); + let thread = std::thread::current(); + let thread = thread.name().unwrap_or(""); + + let tmp_path = std::env::temp_dir().join("easytier-panic.log"); + let candidate_path = [ + std::path::PathBuf::from_str("easytier-panic.log").ok(), + Some(tmp_path), + ]; + let mut file = None; + let mut file_path = None; + for path in candidate_path.iter().filter_map(|p| p.clone()) { + file = OpenOptions::new() + .create(true) + .append(true) + .open(path.clone()) + .ok(); + if file.is_some() { + file_path = Some(path); + break; + } + } + + log::error!("{}", rust_i18n::t!("core_app.panic_backtrace_save")); + + // write str to stderr & file + let mut write_err = |s: String| { + let _ = stderr.write_all(s.as_bytes()); + if let Some(mut f) = file.as_ref() { + let _ = f.write_all(s.as_bytes()); + } + }; + + let msg = formatdoc! {" + panic occurred, if this is a bug, please report this issue on github (https://github.com/easytier/easytier/issues) + easytier version: {version} + os: {os} + arch: {arch} + panic is recorded in: {file} + thread: {thread} + time: {time} + location: {location} + panic info: {payload} + ", + version = crate::VERSION, + os = std::env::consts::OS, + arch = std::env::consts::ARCH, + file = file_path + .and_then(|p| p.to_str().map(|x| x.to_string())) + .unwrap_or("".to_string()), + thread = thread, + time = chrono::Local::now(), + location = location, + payload = payload_str, + }; + + write_err(msg); + write_err(sep); + write_err(format!("{:#?}", backtrace::Backtrace::force_capture())); + + std::process::exit(1); + })); +} diff --git a/vendor/easytier/easytier/src/utils/string.rs b/vendor/easytier/easytier/src/utils/string.rs new file mode 100644 index 0000000..d04ef68 --- /dev/null +++ b/vendor/easytier/easytier/src/utils/string.rs @@ -0,0 +1,22 @@ +pub fn cost_to_str(cost: i32) -> String { + if cost == 1 { + "p2p".to_string() + } else { + format!("relay({})", cost) + } +} + +#[cfg(target_os = "windows")] +pub fn utf8_or_gbk_to_string(s: &[u8]) -> String { + use encoding::{DecoderTrap, Encoding, all::GBK}; + if let Ok(utf8_str) = String::from_utf8(s.to_vec()) { + utf8_str + } else { + // 如果解码失败,则尝试使用GBK解码 + if let Ok(gbk_str) = GBK.decode(s, DecoderTrap::Strict) { + gbk_str + } else { + String::from_utf8_lossy(s).to_string() + } + } +} diff --git a/vendor/easytier/easytier/src/vpn_portal/mod.rs b/vendor/easytier/easytier/src/vpn_portal/mod.rs new file mode 100644 index 0000000..afaec49 --- /dev/null +++ b/vendor/easytier/easytier/src/vpn_portal/mod.rs @@ -0,0 +1,2 @@ +#[cfg(feature = "wireguard")] +pub mod wireguard; diff --git a/vendor/easytier/easytier/src/vpn_portal/wireguard.rs b/vendor/easytier/easytier/src/vpn_portal/wireguard.rs new file mode 100644 index 0000000..5fa52c1 --- /dev/null +++ b/vendor/easytier/easytier/src/vpn_portal/wireguard.rs @@ -0,0 +1,479 @@ +//! Native WireGuard Adapter for the VPN portal. +//! +//! One UDP socket and one shared MAC/cookie limiter demultiplex all configured +//! public keys. Per-client slots keep rekeys and endpoint roaming within one +//! authenticated generation; Core receives a new session only after the prior +//! generation has expired and been detached atomically. + +mod engine; + +use std::{ + collections::{BTreeMap, BTreeSet}, + fmt, + net::{Ipv6Addr, SocketAddr, SocketAddrV6}, + sync::{Arc, Mutex as StdMutex, RwLock, Weak}, +}; + +use anyhow::Context as _; +use base64::{Engine as _, engine::general_purpose::STANDARD as BASE64_STANDARD}; +use boringtun::x25519::{PublicKey, StaticSecret}; +use easytier_core::{ + config::toml::VpnPortalConfig, + gateway::vpn_portal::{ + PortalClientConfig, PortalClientConfigPlan, PortalHost, PortalListener, PortalSession, + }, + socket::{ + ListenerConnectionCounter, NetNamespace, SocketContext, SocketListener, + udp::{UdpBindOptions, VirtualUdpSocket, VirtualUdpSocketFactory}, + }, +}; +use hkdf::Hkdf; +use sha2::Sha256; +use tokio::{sync::mpsc, task::JoinSet}; + +use crate::{ + common::global_ctx::ArcGlobalCtx, + host_runtime::{NativeHostRuntime, native_host_runtime}, + socket::udp::RuntimeUdpSocket, +}; + +use self::engine::{DerivedClient, PortalEngine}; + +struct WireGuardPortalListener { + url: url::Url, + sockets: Vec>, + receiver: mpsc::UnboundedReceiver, + engine: Arc, + tasks: JoinSet>, + listened: bool, +} + +impl fmt::Debug for WireGuardPortalListener { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter + .debug_struct("WireGuardPortalListener") + .field("url", &self.url) + .finish_non_exhaustive() + } +} + +#[async_trait::async_trait] +impl SocketListener for WireGuardPortalListener { + type Accepted = PortalSession; + + async fn listen(&mut self) -> anyhow::Result<()> { + if self.listened { + return Ok(()); + } + self.listened = true; + for socket in &self.sockets { + let socket = socket.clone(); + let engine = self.engine.clone(); + self.tasks.spawn(async move { + loop { + let datagram = socket + .recv_session_datagram() + .await + .context("WireGuard portal UDP receive failed")?; + engine + .handle_datagram(socket.clone(), datagram.remote_addr, &datagram.payload) + .await; + } + }); + } + let engine = self.engine.clone(); + self.tasks.spawn(async move { + engine.run_timers().await; + Ok(()) + }); + Ok(()) + } + + async fn accept(&mut self) -> anyhow::Result { + let tasks_active = !self.tasks.is_empty(); + tokio::select! { + biased; + task = self.tasks.join_next(), if tasks_active => { + let error = match task { + Some(Ok(Err(error))) => { + anyhow::anyhow!("WireGuard portal reader stopped: {error:#}") + } + Some(Ok(Ok(()))) => { + anyhow::anyhow!("WireGuard portal task stopped unexpectedly") + } + Some(Err(error)) => { + anyhow::anyhow!("WireGuard portal task failed: {error}") + } + None => anyhow::anyhow!("WireGuard portal listener stopped"), + }; + self.engine.cancel(); + self.tasks.abort_all(); + Err(error) + } + session = self.receiver.recv() => { + session.ok_or_else(|| anyhow::anyhow!("WireGuard portal listener stopped")) + } + } + } + + fn local_url(&self) -> url::Url { + self.url.clone() + } + + fn connection_counter(&self) -> Arc { + Arc::new(PortalConnectionCounter(self.engine.clone())) + } +} + +impl Drop for WireGuardPortalListener { + fn drop(&mut self) { + self.engine.cancel(); + self.tasks.abort_all(); + } +} + +struct PortalConnectionCounter(Arc); + +impl fmt::Debug for PortalConnectionCounter { + fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter.debug_struct("PortalConnectionCounter").finish() + } +} + +impl ListenerConnectionCounter for PortalConnectionCounter { + fn get(&self) -> Option { + Some(self.0.connection_count()) + } +} + +pub struct WireGuardPortalHost { + global_ctx: ArcGlobalCtx, + config: VpnPortalConfig, + setup: Result, + engine: StdMutex>>, +} + +struct WireGuardPortalSetup { + server_private: [u8; 32], + server_public: PublicKey, + clients: RwLock>, +} + +impl WireGuardPortalHost { + pub fn new(global_ctx: ArcGlobalCtx, config: VpnPortalConfig) -> Arc { + let setup = (|| -> anyhow::Result<_> { + // The derivation master equals the server private key. + let (_, server_private) = portal_master_and_server_key(&config)?; + let server_public = PublicKey::from(&StaticSecret::from(server_private)); + let mut clients = BTreeMap::new(); + for client in &config.clients { + let client = PortalClientConfig { + name: client.name.clone(), + virtual_ip: client.virtual_ip, + groups: client.groups.clone(), + }; + clients.insert(client.name.clone(), derive_client(server_private, &client)?); + } + Ok(WireGuardPortalSetup { + server_private, + server_public, + clients: RwLock::new(clients), + }) + })() + .map_err(|error| error.to_string()); + Arc::new(Self { + global_ctx, + config, + setup, + engine: StdMutex::new(None), + }) + } + + async fn bind_socket( + &self, + runtime: &NativeHostRuntime, + address: SocketAddr, + only_v6: bool, + ) -> anyhow::Result> { + let context = SocketContext::default() + .with_socket_mark(self.global_ctx.get_flags().socket_mark) + .with_netns(self.global_ctx.net_ns.name().map(NetNamespace::new)); + runtime + .bind_udp( + UdpBindOptions::port_bound_listener(address) + .with_context(context) + .with_only_v6(only_v6), + ) + .await + } + + async fn apply_client_updates(&self, clients: &[PortalClientConfig]) -> anyhow::Result<()> { + let setup = self + .setup + .as_ref() + .map_err(|error| anyhow::anyhow!(error.clone()))?; + let engine = self + .engine + .lock() + .unwrap() + .clone() + .and_then(|engine| engine.upgrade()) + .ok_or_else(|| anyhow::anyhow!("WireGuard VPN portal is not running"))?; + + let desired: BTreeSet<&str> = clients.iter().map(|client| client.name.as_str()).collect(); + let stale: Vec = setup + .clients + .read() + .unwrap() + .keys() + .filter(|name| !desired.contains(name.as_str())) + .cloned() + .collect(); + for name in &stale { + engine.remove_client(name).await; + setup.clients.write().unwrap().remove(name); + } + for client in clients { + if setup + .clients + .read() + .unwrap() + .get(&client.name) + .is_some_and(|existing| existing.config == *client) + { + continue; + } + // A changed client keeps its WireGuard identity (keys derive from + // the name), but its attached peer must be rebuilt with the new + // virtual IP or groups. Expiring the session makes the client + // re-handshake into a fresh Core generation. + engine.remove_client(&client.name).await; + let derived = derive_client(setup.server_private, client)?; + engine.add_client(derived.clone())?; + setup + .clients + .write() + .unwrap() + .insert(client.name.clone(), derived); + } + Ok(()) + } +} + +fn derive_client(master: [u8; 32], client: &PortalClientConfig) -> anyhow::Result { + let wireguard_private = derive_named_key(&master, b"wireguard-client", &client.name)?; + Ok(DerivedClient { + config: client.clone(), + wireguard_private, + wireguard_public: PublicKey::from(&StaticSecret::from(wireguard_private)), + }) +} +fn secondary_ipv6_bind_address(address: SocketAddr, primary_port: u16) -> Option { + let SocketAddr::V4(address) = address else { + return None; + }; + address + .ip() + .is_unspecified() + .then(|| SocketAddr::V6(SocketAddrV6::new(Ipv6Addr::UNSPECIFIED, primary_port, 0, 0))) +} + +#[async_trait::async_trait] +impl PortalHost for WireGuardPortalHost { + async fn start_listeners(&self) -> anyhow::Result> { + let setup = self + .setup + .as_ref() + .map_err(|error| anyhow::anyhow!(error.clone()))?; + let runtime = native_host_runtime(); + let primary = self + .bind_socket(&runtime, self.config.wireguard_listen, false) + .await + .context("failed to bind WireGuard VPN portal")?; + let local = primary.local_addr()?; + let mut sockets = vec![primary.clone()]; + if let Some(v6_address) = + secondary_ipv6_bind_address(self.config.wireguard_listen, local.port()) + && let Ok(v6) = self.bind_socket(&runtime, v6_address, true).await + { + sockets.push(v6); + } + let url = url::Url::parse(&format!("wg://{local}"))?; + let (accepted, receiver) = mpsc::unbounded_channel(); + let engine = PortalEngine::new( + setup.server_private, + setup.clients.read().unwrap().values().cloned().collect(), + accepted, + ); + *self.engine.lock().unwrap() = Some(Arc::downgrade(&engine)); + Ok(vec![Box::new(WireGuardPortalListener { + url, + sockets, + receiver, + engine, + tasks: JoinSet::new(), + listened: false, + })]) + } + + fn name(&self) -> String { + "wireguard".to_owned() + } + + async fn update_clients(&self, clients: &[PortalClientConfig]) -> anyhow::Result<()> { + self.apply_client_updates(clients).await + } + + fn render_client_config(&self, plan: &PortalClientConfigPlan) -> String { + let setup = self + .setup + .as_ref() + .expect("client config is rendered only after successful startup"); + let clients = setup.clients.read().unwrap(); + let Some(client) = clients.get(&plan.name) else { + return String::new(); + }; + let endpoint = &plan.listener_url[url::Position::BeforeHost..url::Position::AfterPort]; + format!( + "[Interface]\nPrivateKey = {}\nAddress = {}/32\n\n[Peer]\nPublicKey = {}\nAllowedIPs = {}\nEndpoint = {} # replace wildcard with the public address\nPersistentKeepalive = 25\n", + BASE64_STANDARD.encode(client.wireguard_private), + plan.address, + BASE64_STANDARD.encode(setup.server_public.as_bytes()), + plan.allowed_ips.join(", "), + endpoint, + ) + } +} + +fn portal_master_and_server_key(config: &VpnPortalConfig) -> anyhow::Result<([u8; 32], [u8; 32])> { + let encoded = config + .wireguard_private_key + .as_deref() + .filter(|key| !key.is_empty()) + .ok_or_else(|| anyhow::anyhow!("WireGuard portal requires a dedicated private key"))?; + let decoded = BASE64_STANDARD + .decode(encoded) + .context("invalid base64 WireGuard portal private key")?; + let key: [u8; 32] = decoded + .try_into() + .map_err(|_| anyhow::anyhow!("WireGuard portal private key must be 32 bytes"))?; + Ok((key, key)) +} + +fn derive_named_key(master: &[u8; 32], domain: &[u8], name: &str) -> anyhow::Result<[u8; 32]> { + let mut context = Vec::new(); + append_label(&mut context, domain); + append_label(&mut context, name.as_bytes()); + let hkdf = Hkdf::::new(Some(b"easytier/wireguard-portal/v1"), master); + let mut output = [0u8; 32]; + hkdf.expand(&context, &mut output) + .map_err(|_| anyhow::anyhow!("failed to derive portal client key"))?; + Ok(output) +} + +fn append_label(output: &mut Vec, label: &[u8]) { + output.extend_from_slice(&(label.len() as u32).to_be_bytes()); + output.extend_from_slice(label); +} + +#[cfg(test)] +pub(crate) fn test_wireguard_keys( + config: &VpnPortalConfig, + client_name: &str, +) -> anyhow::Result<([u8; 32], [u8; 32])> { + let (master, server_private) = portal_master_and_server_key(config)?; + let client_private = derive_named_key(&master, b"wireguard-client", client_name)?; + let server_public = *PublicKey::from(&StaticSecret::from(server_private)).as_bytes(); + Ok((server_public, client_private)) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn named_wireguard_keys_are_stable_and_client_scoped() { + let master = [7; 32]; + let client = derive_named_key(&master, b"wireguard-client", "laptop").unwrap(); + // Pin the derived key across crypto dependency upgrades/downgrades. + // Independently calculated with RFC 5869 HKDF-SHA256. + assert_eq!( + client, + [ + 5, 98, 244, 32, 245, 111, 41, 24, 163, 149, 201, 218, 22, 228, 8, 224, 134, 16, + 173, 29, 62, 138, 202, 41, 172, 230, 189, 237, 207, 100, 51, 236, + ] + ); + assert_eq!( + client, + derive_named_key(&master, b"wireguard-client", "laptop").unwrap() + ); + assert_ne!( + client, + derive_named_key(&master, b"wireguard-client", "phone").unwrap() + ); + } + + #[test] + fn explicit_server_key_is_the_derivation_master() { + let key = [9; 32]; + let config = VpnPortalConfig { + enabled: None, + wireguard_listen: "127.0.0.1:51820".parse().unwrap(), + wireguard_private_key: Some(BASE64_STANDARD.encode(key)), + clients: Vec::new(), + }; + assert_eq!(portal_master_and_server_key(&config).unwrap(), (key, key)); + } + + #[test] + fn portal_key_has_no_network_secret_fallback() { + let config = VpnPortalConfig { + enabled: None, + wireguard_listen: "127.0.0.1:51820".parse().unwrap(), + wireguard_private_key: None, + clients: Vec::new(), + }; + assert!( + portal_master_and_server_key(&config) + .unwrap_err() + .to_string() + .contains("dedicated private key") + ); + } + + #[test] + fn ipv6_wildcard_reuses_primary_ephemeral_port() { + assert_eq!( + secondary_ipv6_bind_address("0.0.0.0:0".parse().unwrap(), 43123), + Some("[::]:43123".parse().unwrap()) + ); + assert_eq!( + secondary_ipv6_bind_address("127.0.0.1:0".parse().unwrap(), 43123), + None + ); + } + + #[tokio::test] + async fn reader_failure_terminates_listener_accept() { + let (accepted, receiver) = mpsc::unbounded_channel(); + let engine = PortalEngine::new([11; 32], Vec::new(), accepted); + let mut tasks: JoinSet> = JoinSet::new(); + tasks.spawn(async { anyhow::bail!("UDP receive failed") }); + let mut listener = WireGuardPortalListener { + url: "wg://127.0.0.1:51820".parse().unwrap(), + sockets: Vec::new(), + receiver, + engine, + tasks, + listened: true, + }; + + let error = tokio::time::timeout(std::time::Duration::from_secs(1), listener.accept()) + .await + .expect("listener accept ignored reader failure") + .unwrap_err(); + + assert!(error.to_string().contains("UDP receive failed")); + } +} diff --git a/vendor/easytier/easytier/src/vpn_portal/wireguard/engine.rs b/vendor/easytier/easytier/src/vpn_portal/wireguard/engine.rs new file mode 100644 index 0000000..a10a71c --- /dev/null +++ b/vendor/easytier/easytier/src/vpn_portal/wireguard/engine.rs @@ -0,0 +1,602 @@ +//! Shared WireGuard packet engine for named portal clients. + +use atomic_shim::AtomicU64; +use std::{ + collections::{BTreeSet, HashMap}, + net::SocketAddr, + sync::{ + Arc, RwLock, + atomic::{AtomicBool, Ordering}, + }, + time::Duration, +}; + +use boringtun::{ + noise::{ + Packet, Tunn, TunnResult, errors::WireGuardError, handshake::parse_handshake_anon, + rate_limiter::RateLimiter, + }, + x25519::{PublicKey, StaticSecret}, +}; +use easytier_core::{ + gateway::vpn_portal::{PortalClientConfig, PortalSession}, + socket::udp::VirtualUdpSocket, +}; +use rand::rngs::OsRng; +use tokio::{ + sync::{Mutex, mpsc, watch}, + task::JoinSet, +}; +use tokio_util::sync::CancellationToken; + +use crate::socket::udp::RuntimeUdpSocket; +const MIN_WIREGUARD_PACKET_CAPACITY: usize = 148; +// We pre-verify through this shared limiter and BoringTun verifies again inside +// each Tunn. Doubling the threshold preserves the intended 100 datagrams/s +// transition to cookies while retaining the upstream security ordering. +const DOUBLE_VERIFY_HANDSHAKE_LIMIT: u64 = 200; +const TIMER_INTERVAL: Duration = Duration::from_millis(250); +const PORTAL_PACKET_CAPACITY: usize = 128; +#[derive(Clone)] +pub(super) struct DerivedClient { + pub(super) config: PortalClientConfig, + pub(super) wireguard_private: [u8; 32], + pub(super) wireguard_public: PublicKey, +} + +struct PortalChannels { + endpoint: watch::Receiver, + from_client: mpsc::Receiver>, + to_client: mpsc::Sender>, +} + +struct ClientSession { + generation: u64, + identity_private_key: [u8; 32], + endpoint: Option, + endpoint_updates: watch::Sender, + tunnel: Tunn, + from_client: mpsc::Sender>, + portal_channels: Option, + drain_capacity: usize, + tasks: JoinSet<()>, +} + +struct ClientSlot { + client: DerivedClient, + index: u32, + next_generation: AtomicU64, + session: Mutex>, + retired: AtomicBool, +} + +#[derive(Default)] +struct EngineSlots { + by_name: HashMap>, + by_public_key: HashMap<[u8; 32], Arc>, + by_index: HashMap>, + free_indices: BTreeSet, + highest_index: u32, +} + +impl EngineSlots { + fn allocate_index(&mut self) -> anyhow::Result { + if let Some(index) = self.free_indices.pop_first() { + return Ok(index); + } + let next = self + .highest_index + .checked_add(1) + .ok_or_else(|| anyhow::anyhow!("WireGuard portal client index space is exhausted"))?; + self.highest_index = next; + Ok(next) + } +} + +#[derive(Clone)] +struct Endpoint { + socket: Arc, + remote: SocketAddr, +} + +impl ClientSession { + fn update_endpoint(&mut self, socket: Arc, remote: SocketAddr) { + let changed = self + .endpoint + .as_ref() + .is_none_or(|endpoint| endpoint.remote != remote); + self.endpoint = Some(Endpoint { socket, remote }); + if changed { + self.endpoint_updates.send_replace(remote.to_string()); + } + } +} + +pub(super) struct PortalEngine { + server_private: StaticSecret, + server_public: PublicKey, + rate_limiter: Arc, + slots: RwLock, + accepted: mpsc::UnboundedSender, + cancel: CancellationToken, +} + +impl PortalEngine { + pub(super) fn new( + server_private: [u8; 32], + clients: Vec, + accepted: mpsc::UnboundedSender, + ) -> Arc { + let server_private = StaticSecret::from(server_private); + let server_public = PublicKey::from(&server_private); + let mut slots = EngineSlots::default(); + for client in clients { + let public = *client.wireguard_public.as_bytes(); + let index = slots + .allocate_index() + .expect("initial portal clients fit the index space"); + let slot = Arc::new(ClientSlot { + client, + index, + next_generation: AtomicU64::new(1), + session: Mutex::new(None), + retired: AtomicBool::new(false), + }); + slots + .by_name + .insert(slot.client.config.name.clone(), slot.clone()); + slots.by_public_key.insert(public, slot.clone()); + slots.by_index.insert(index, slot); + } + Arc::new(Self { + server_private, + server_public, + rate_limiter: Arc::new(RateLimiter::new( + &server_public, + DOUBLE_VERIFY_HANDSHAKE_LIMIT, + )), + slots: RwLock::new(slots), + accepted, + cancel: CancellationToken::new(), + }) + } + + pub(super) fn add_client(&self, client: DerivedClient) -> anyhow::Result<()> { + let public = *client.wireguard_public.as_bytes(); + let name = client.config.name.clone(); + let mut slots = self.slots.write().unwrap(); + if slots.by_name.contains_key(&name) || slots.by_public_key.contains_key(&public) { + anyhow::bail!("WireGuard portal client {name} already exists"); + } + let index = slots.allocate_index()?; + let slot = Arc::new(ClientSlot { + client, + index, + next_generation: AtomicU64::new(1), + session: Mutex::new(None), + retired: AtomicBool::new(false), + }); + slots.by_name.insert(name, slot.clone()); + slots.by_public_key.insert(public, slot.clone()); + slots.by_index.insert(index, slot); + Ok(()) + } + + /// Removes a client by name. Any active session is expired so Core tears + /// down the attached peer through its regular channel-close path. + pub(super) async fn remove_client(&self, name: &str) -> bool { + let slot = { + let mut slots = self.slots.write().unwrap(); + slots.by_name.remove(name).inspect(|slot| { + slot.retired.store(true, Ordering::Relaxed); + let public = *slot.client.wireguard_public.as_bytes(); + slots.by_public_key.remove(&public); + slots.by_index.remove(&slot.index); + slots.free_indices.insert(slot.index); + }) + }; + let Some(slot) = slot else { + return false; + }; + let expired = slot.session.lock().await.take(); + Self::retire_session(expired); + true + } + + pub(super) fn cancel(&self) { + self.cancel.cancel(); + } + pub(super) fn connection_count(&self) -> u32 { + let slots = self.slots.read().unwrap(); + slots + .by_index + .values() + .filter(|slot| { + slot.session.try_lock().is_ok_and(|guard| { + guard + .as_ref() + .is_some_and(|session| session.portal_channels.is_none()) + }) + }) + .count() as u32 + } + + pub(super) async fn handle_datagram( + self: &Arc, + socket: Arc, + remote: SocketAddr, + datagram: &[u8], + ) { + let mut cookie = [0u8; 148]; + let parsed = match self + .rate_limiter + .verify_packet(Some(remote.ip()), datagram, &mut cookie) + { + Ok(packet) => packet, + Err(TunnResult::WriteToNetwork(reply)) => { + let _ = socket.send_to(reply, remote).await; + return; + } + Err(_) => return, + }; + let slot = match &parsed { + Packet::HandshakeInit(init) => { + parse_handshake_anon(&self.server_private, &self.server_public, init) + .ok() + .and_then(|handshake| { + self.slots + .read() + .unwrap() + .by_public_key + .get(&handshake.peer_static_public) + .cloned() + }) + } + Packet::HandshakeResponse(response) => self.slot_by_receiver(response.receiver_idx), + Packet::PacketCookieReply(reply) => self.slot_by_receiver(reply.receiver_idx), + Packet::PacketData(data) => self.slot_by_receiver(data.receiver_idx), + }; + let Some(slot) = slot else { return }; + if slot.retired.load(Ordering::Relaxed) { + return; + } + + let mut session = slot.session.lock().await; + // Re-check after acquiring the lock: remove_client retires the slot + // and drains the session under this same lock, so a datagram that + // raced with removal cannot resurrect a session here. + if slot.retired.load(Ordering::Relaxed) { + return; + } + if session.is_none() { + if !matches!(parsed, Packet::HandshakeInit(_)) { + return; + } + *session = Some(self.new_session(&slot, socket.clone(), remote)); + } + let current = session.as_mut().expect("created above"); + let is_data = matches!(&parsed, Packet::PacketData(_)); + let is_handshake_response = matches!(&parsed, Packet::HandshakeResponse(_)); + + // The shared pre-verification establishes the correct upstream order. + // Tunn::decapsulate performs a second MAC/cookie check because the + // dependency's verified-dispatch method is not public. Size the first + // output to the datagram: unauthenticated transport packets must not + // amplify a tiny allocation into a full-size IP buffer. + let mut output = vec![0u8; datagram.len().max(MIN_WIREGUARD_PACKET_CAPACITY)]; + let mut result = current + .tunnel + .decapsulate(Some(remote.ip()), datagram, &mut output); + let mut first_result = true; + loop { + match result { + TunnResult::Done => { + if is_data { + current.update_endpoint(socket.clone(), remote); + self.activate_client(&slot, current); + } + current.drain_capacity = MIN_WIREGUARD_PACKET_CAPACITY; + break; + } + TunnResult::Err(WireGuardError::ConnectionExpired) => { + let expired = session.take(); + drop(session); + Self::retire_session(expired); + return; + } + TunnResult::Err(_) => break, + TunnResult::WriteToNetwork(packet) => { + if (first_result && is_handshake_response && is_transport_data_packet(packet)) + || is_handshake_response_packet(packet) + { + current.update_endpoint(socket.clone(), remote); + } + let _ = socket.send_to(packet, remote).await; + + // BoringTun queues a Core packet while it establishes a + // session. Its contract requires empty decapsulate calls + // after every network write until Done releases that queue. + first_result = false; + if output.len() < current.drain_capacity { + output.resize(current.drain_capacity, 0); + } + result = current.tunnel.decapsulate(None, &[], &mut output); + } + TunnResult::WriteToTunnelV4(packet, _) => { + current.update_endpoint(socket.clone(), remote); + self.activate_client(&slot, current); + match current.from_client.try_send(packet.to_vec()) { + Ok(()) => {} + Err(mpsc::error::TrySendError::Full(_)) => { + tracing::debug!( + client = %slot.client.config.name, + "dropping WireGuard packet because the client queue is full" + ); + } + Err(mpsc::error::TrySendError::Closed(_)) => { + let generation = current.generation; + drop(session); + self.expire_if_current(slot, generation).await; + return; + } + } + break; + } + TunnResult::WriteToTunnelV6(_, _) => { + // Portal traffic is deliberately IPv4-only. + break; + } + } + } + } + + fn activate_client(&self, slot: &ClientSlot, session: &mut ClientSession) { + let Some(channels) = session.portal_channels.take() else { + return; + }; + let _ = self.accepted.send(PortalSession { + client_name: slot.client.config.name.clone(), + endpoint: channels.endpoint, + identity_private_key: session.identity_private_key, + from_client: channels.from_client, + to_client: channels.to_client, + }); + } + + fn slot_by_receiver(&self, receiver: u32) -> Option> { + self.slots + .read() + .unwrap() + .by_index + .get(&(receiver >> 8)) + .cloned() + } + + fn new_session( + self: &Arc, + slot: &Arc, + socket: Arc, + remote: SocketAddr, + ) -> ClientSession { + let generation = slot.next_generation.fetch_add(1, Ordering::Relaxed); + let (from_client, portal_from_client) = mpsc::channel(PORTAL_PACKET_CAPACITY); + let (portal_to_client, mut to_client) = mpsc::channel::>(PORTAL_PACKET_CAPACITY); + let (endpoint_updates, portal_endpoint) = watch::channel(remote.to_string()); + let engine = Arc::downgrade(self); + let slot_for_task = Arc::downgrade(slot); + let mut tasks = JoinSet::new(); + tasks.spawn(async move { + while let Some(payload) = to_client.recv().await { + let Some(engine) = engine.upgrade() else { + return; + }; + let Some(slot) = slot_for_task.upgrade() else { + return; + }; + engine + .encapsulate_for_client(&slot, generation, &payload) + .await; + } + if let (Some(engine), Some(slot)) = (engine.upgrade(), slot_for_task.upgrade()) { + engine.expire_if_current(slot, generation).await; + } + }); + ClientSession { + generation, + identity_private_key: new_attached_identity_private_key(), + endpoint: Some(Endpoint { socket, remote }), + endpoint_updates, + tunnel: Tunn::new( + self.server_private.clone(), + slot.client.wireguard_public, + None, + None, + slot.index, + Some(self.rate_limiter.clone()), + ), + from_client, + portal_channels: Some(PortalChannels { + endpoint: portal_endpoint, + from_client: portal_from_client, + to_client: portal_to_client, + }), + drain_capacity: MIN_WIREGUARD_PACKET_CAPACITY, + tasks, + } + } + + async fn encapsulate_for_client( + self: &Arc, + slot: &Arc, + generation: u64, + payload: &[u8], + ) { + let mut output = vec![0u8; payload.len().saturating_add(148).max(148)]; + let mut guard = slot.session.lock().await; + let Some(session) = guard + .as_mut() + .filter(|session| session.generation == generation) + else { + return; + }; + match session.tunnel.encapsulate(payload, &mut output) { + TunnResult::WriteToNetwork(packet) => { + if is_handshake_initiation(packet) { + session.drain_capacity = + session.drain_capacity.max(payload.len().saturating_add(32)); + } + if let Some(endpoint) = session.endpoint.clone() { + let _ = endpoint.socket.send_to(packet, endpoint.remote).await; + } + } + TunnResult::Done => { + session.drain_capacity = + session.drain_capacity.max(payload.len().saturating_add(32)); + } + TunnResult::Err(WireGuardError::ConnectionExpired) => { + drop(guard); + self.expire_if_current(slot.clone(), generation).await; + } + _ => {} + } + } + + async fn expire_if_current(self: &Arc, slot: Arc, generation: u64) { + let expired = { + let mut guard = slot.session.lock().await; + if guard + .as_ref() + .is_some_and(|session| session.generation == generation) + { + guard.take() + } else { + None + } + }; + Self::retire_session(expired); + } + + fn retire_session(expired: Option) { + if let Some(mut expired) = expired { + expired.tasks.abort_all(); + // Dropping the ring sink atomically disconnects the matching Core + // generation. A newer generation, if any, owns a different ring. + } + } + + pub(super) async fn run_timers(self: Arc) { + let mut interval = tokio::time::interval(TIMER_INTERVAL); + loop { + tokio::select! { + _ = self.cancel.cancelled() => return, + _ = interval.tick() => {} + } + self.rate_limiter.reset_count(); + let slots = self + .slots + .read() + .unwrap() + .by_index + .values() + .cloned() + .collect::>(); + for slot in slots { + let mut output = [0u8; 148]; + let mut guard = slot.session.lock().await; + let Some(session) = guard.as_mut() else { + continue; + }; + match session.tunnel.update_timers(&mut output) { + TunnResult::WriteToNetwork(packet) => { + if let Some(endpoint) = session.endpoint.clone() { + let _ = endpoint.socket.send_to(packet, endpoint.remote).await; + } + } + TunnResult::Err(WireGuardError::ConnectionExpired) => { + let expired = guard.take(); + drop(guard); + Self::retire_session(expired); + } + _ => {} + } + } + } + } +} + +fn new_attached_identity_private_key() -> [u8; 32] { + StaticSecret::random_from_rng(OsRng).to_bytes() +} + +fn is_handshake_initiation(packet: &[u8]) -> bool { + packet.len() == 148 && packet.get(..4) == Some(&1u32.to_le_bytes()) +} + +fn is_handshake_response_packet(packet: &[u8]) -> bool { + packet.len() == 92 && packet.get(..4) == Some(&2u32.to_le_bytes()) +} + +fn is_transport_data_packet(packet: &[u8]) -> bool { + packet.len() >= 32 && packet.get(..4) == Some(&4u32.to_le_bytes()) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn derived(name: &str, seed: u8) -> DerivedClient { + let secret = StaticSecret::from([seed; 32]); + DerivedClient { + config: PortalClientConfig { + name: name.to_owned(), + virtual_ip: "10.82.0.2/24".parse().unwrap(), + groups: Vec::new(), + }, + wireguard_private: secret.to_bytes(), + wireguard_public: PublicKey::from(&secret), + } + } + + #[test] + fn attached_identity_is_unique_to_each_live_session() { + assert_ne!( + new_attached_identity_private_key(), + new_attached_identity_private_key() + ); + } + + fn slot_index(engine: &PortalEngine, name: &str) -> Option { + engine + .slots + .read() + .unwrap() + .by_name + .get(name) + .map(|slot| slot.index) + } + + #[tokio::test] + async fn remove_client_drops_slot_and_recycles_index() { + let (accepted, _receiver) = mpsc::unbounded_channel(); + let engine = PortalEngine::new([1; 32], vec![derived("a", 10), derived("b", 11)], accepted); + assert_eq!(slot_index(&engine, "a"), Some(1)); + assert_eq!(slot_index(&engine, "b"), Some(2)); + + assert!(engine.remove_client("a").await); + assert!(!engine.remove_client("a").await); + + engine.add_client(derived("c", 12)).unwrap(); + assert_eq!(slot_index(&engine, "c"), Some(1), "freed index is reused"); + assert!( + engine.add_client(derived("c", 13)).is_err(), + "duplicate client name is rejected" + ); + assert!( + engine.add_client(derived("d", 11)).is_err(), + "duplicate client public key is rejected" + ); + + engine.add_client(derived("d", 14)).unwrap(); + assert_eq!(slot_index(&engine, "d"), Some(3)); + } +} diff --git a/vendor/easytier/easytier/src/web_client/mod.rs b/vendor/easytier/easytier/src/web_client/mod.rs new file mode 100644 index 0000000..c809681 --- /dev/null +++ b/vendor/easytier/easytier/src/web_client/mod.rs @@ -0,0 +1,221 @@ +use std::sync::Arc; + +use anyhow::{Context as _, Result}; +use async_trait::async_trait; +use easytier_core::{ + config::toml::ConfigLoader as _, + connectivity::{manual::ManualTunnelConnector, protocol::raw::TunnelDialer}, + management::{ConfigServerEndpoint, WebClientConfig}, + socket::IpVersion, + tunnel::Tunnel, +}; +use url::Url; + +#[cfg(feature = "management")] +use crate::{ + common::os_info::collect_device_os_info, instance::config_storage::NativeConfigFileStorage, + rpc_service::logger::NativeLoggerControl, +}; +use crate::{ + common::{ + MachineIdOptions, config::TomlConfigLoader, constants::EASYTIER_VERSION, + global_ctx::GlobalCtx, resolve_machine_id, + }, + instance::{ + composition::runtime_one_shot_manual_connector, + factory::{NativeInstanceFactory, NativeInstanceManager}, + host::NativeInstanceHost, + }, + tunnel::TunnelScheme, +}; + +pub use easytier_core::management::InstanceMutationHooks as WebClientHooks; + +pub struct WebClient { + inner: easytier_core::management::WebClient, +} + +impl WebClient { + pub fn new( + connector: T, + token: S, + machine_id: uuid::Uuid, + hostname: H, + secure_mode: bool, + manager: Arc, + hooks: Option>, + ) -> Self + where + T: TunnelDialer + 'static, + S: ToString, + H: ToString, + { + let config = WebClientConfig { + token: token.to_string(), + machine_id, + hostname: hostname.to_string(), + device_os: web_client_device_os_info(), + easytier_version: EASYTIER_VERSION.to_owned(), + secure_mode, + }; + #[cfg(feature = "management")] + let inner = easytier_core::management::WebClient::new( + connector, + config, + manager, + hooks.unwrap_or_else(|| Arc::new(DefaultHooks)), + Arc::new(NativeConfigFileStorage), + Arc::new(NativeLoggerControl), + ); + #[cfg(not(feature = "management"))] + let inner = easytier_core::management::WebClient::new( + connector, + config, + manager, + hooks.unwrap_or_else(|| Arc::new(DefaultHooks)), + Arc::new(easytier_core::management::UnsupportedConfigFileStorage), + ); + Self { inner } + } + + pub fn is_connected(&self) -> bool { + self.inner.is_connected() + } +} + +#[cfg(feature = "management")] +fn web_client_device_os_info() -> easytier_proto::web::DeviceOsInfo { + collect_device_os_info() +} + +#[cfg(not(feature = "management"))] +fn web_client_device_os_info() -> easytier_proto::web::DeviceOsInfo { + easytier_proto::web::DeviceOsInfo { + os_type: std::env::consts::OS.to_owned(), + version: String::new(), + distribution: String::new(), + } +} + +pub struct DefaultHooks; + +#[async_trait] +impl WebClientHooks for DefaultHooks {} + +struct ConfigServerConnector { + url: Url, + connector: ManualTunnelConnector, +} + +#[async_trait] +impl TunnelDialer for ConfigServerConnector { + async fn connect(&self) -> anyhow::Result> { + self.connector + .connect(self.url.clone(), IpVersion::Both) + .await + } + + fn remote_url(&self) -> Url { + self.url.clone() + } +} + +pub fn parse_config_server_endpoint(input: &str) -> anyhow::Result { + ConfigServerEndpoint::parse(input, |url| TunnelScheme::try_from(url).is_ok()) +} + +pub async fn run_web_client( + config_server_url: &str, + machine_id_options: MachineIdOptions, + hostname: Option, + secure_mode: bool, + manager: Arc, + hooks: Option>, +) -> Result { + let machine_id = resolve_machine_id(&machine_id_options) + .with_context(|| "failed to resolve machine id for web client")?; + let endpoint = parse_config_server_endpoint(config_server_url)?; + + let config = TomlConfigLoader::default(); + let global_ctx = Arc::new(GlobalCtx::new(config.clone())); + let mut flags = global_ctx.get_flags(); + flags.bind_device = false; + config.set_flags(flags.clone()); + global_ctx.set_flags(flags); + let hostname = + hostname.unwrap_or_else(|| gethostname::gethostname().to_string_lossy().to_string()); + let connector = + runtime_one_shot_manual_connector(global_ctx, &config, manager.process_runtime())?; + + Ok(WebClient::new( + ConfigServerConnector { + url: endpoint.connect_url().clone(), + connector, + }, + endpoint.token(), + machine_id, + hostname, + secure_mode, + manager, + hooks, + )) +} + +#[cfg(test)] +mod tests { + use std::sync::{Arc, atomic::AtomicBool}; + + use crate::{common::MachineIdOptions, instance::factory::native_instance_manager}; + + #[tokio::test] + async fn test_manager_wait() { + let manager = Arc::new(native_instance_manager()); + let temp_dir = tempfile::tempdir().unwrap(); + let client = super::run_web_client( + format!("ring://{}/test", uuid::Uuid::new_v4()).as_str(), + MachineIdOptions { + explicit_machine_id: None, + state_dir: Some(temp_dir.path().to_path_buf()), + }, + None, + false, + manager.clone(), + None, + ) + .await + .unwrap(); + let sleep_finish = Arc::new(AtomicBool::new(false)); + let sleep_finish_clone = sleep_finish.clone(); + + tokio::spawn(async move { + tokio::time::sleep(std::time::Duration::from_secs(3)).await; + sleep_finish_clone.store(true, std::sync::atomic::Ordering::Relaxed); + drop(client); + }); + + manager.wait().await; + assert!(sleep_finish.load(std::sync::atomic::Ordering::Relaxed)); + } + + #[tokio::test] + async fn test_run_web_client_with_unreachable_config_server() { + let manager = Arc::new(native_instance_manager()); + let temp_dir = tempfile::tempdir().unwrap(); + let client = super::run_web_client( + "udp://config-server.invalid:22020/test", + MachineIdOptions { + explicit_machine_id: None, + state_dir: Some(temp_dir.path().to_path_buf()), + }, + None, + false, + manager, + None, + ) + .await + .unwrap(); + + tokio::time::sleep(std::time::Duration::from_millis(100)).await; + assert!(!client.is_connected()); + } +} diff --git a/vendor/easytier/easytier/third_party/arm64/Packet.lib b/vendor/easytier/easytier/third_party/arm64/Packet.lib new file mode 100644 index 0000000..45ab1b0 Binary files /dev/null and b/vendor/easytier/easytier/third_party/arm64/Packet.lib differ diff --git a/vendor/easytier/easytier/third_party/arm64/WinDivert64.sys b/vendor/easytier/easytier/third_party/arm64/WinDivert64.sys new file mode 100644 index 0000000..ea9865f --- /dev/null +++ b/vendor/easytier/easytier/third_party/arm64/WinDivert64.sys @@ -0,0 +1 @@ +WinDivert doesn't support aarch64, this is a placeholder file to make tauri happy. diff --git a/vendor/easytier/easytier/third_party/i686/Packet.lib b/vendor/easytier/easytier/third_party/i686/Packet.lib new file mode 100644 index 0000000..23d2cfc Binary files /dev/null and b/vendor/easytier/easytier/third_party/i686/Packet.lib differ diff --git a/vendor/easytier/easytier/third_party/i686/WinDivert32.sys b/vendor/easytier/easytier/third_party/i686/WinDivert32.sys new file mode 100644 index 0000000..d06738c Binary files /dev/null and b/vendor/easytier/easytier/third_party/i686/WinDivert32.sys differ diff --git a/vendor/easytier/easytier/third_party/x86_64/Packet.lib b/vendor/easytier/easytier/third_party/x86_64/Packet.lib new file mode 100644 index 0000000..30c1540 Binary files /dev/null and b/vendor/easytier/easytier/third_party/x86_64/Packet.lib differ diff --git a/vendor/easytier/easytier/third_party/x86_64/WinDivert64.sys b/vendor/easytier/easytier/third_party/x86_64/WinDivert64.sys new file mode 100644 index 0000000..218ccaf Binary files /dev/null and b/vendor/easytier/easytier/third_party/x86_64/WinDivert64.sys differ