diff --git a/Cargo.toml b/Cargo.toml index 9f45316..35a885f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,16 +1,6 @@ -[package] -name = "phantom" -version = "0.1.0" -edition = "2018" +[workspace] -[dependencies] -bytes = "1" -pnet = "0.28.0" -tokio-tun = "0.3.15" -tokio = { version = "1.11.0", features = ["full"] } -lru_time_cache = "0.11.11" -rand = { version = "0.8.4", features = ["small_rng"] } -clap = "2.33.3" -log = "0.4" -pretty_env_logger = "0.4.0" -socket2 = { version = "0.4.2", features = ["all"] } +members = [ + "fake-tcp", + "phantun", +] diff --git a/README.md b/README.md new file mode 100644 index 0000000..39cb2e6 --- /dev/null +++ b/README.md @@ -0,0 +1,146 @@ +# Phantun + +A lightweight and fast UDP to TCP obfuscator. + +## Overview + +Phanton is a project that obfuscated UDP packets into TCP connections. It aims to +achieve maximum performance with minimum processing and encapsulation overhead. + +It is commonly used in environments where UDP is blocked/throttled but TCP is allowed through. + +Phanton simply converts a stream of UDP packets into obfuscated TCP stream packets. The TCP stack +used by Phantun is designed to pass through most L3/L4 stateful/stateless firewalls/NAT +devices. It will **not** be able to pass through L7 proxies. +However, the advantage of this approach is that none of the common UDP over TCP performance killer +such as retransmissions and flow control will occur. The underlying UDP properties such as +out-of-order delivery are fully preserved even if the connection ends up looking like a TCP +connection from the perspective of firewalls/NAT devices. + +![Traffic flow diagram](images/traffic-flow.png) + +## Usage + +Phantun creates TUN interface for both the Client and Server. For Client, Phantun assigns itself the IP address +`192.168.200.2` and for Server, it assigns `192.168.201.2`. Therefore, your Kernel must have +`net.ipv4.ip_forward` enabled and setup appropriate iptables rules for NAT between your physical +NIC address and Phantun's TUN interface address. + +### Enable Kernel IP forwarding + +Edit `/etc/sysctl.conf`, add `net.ipv4.ip_forward=1` and run `sudo sysctl -p /etc/sysctl.conf`. + +### Add required firewall rules (using nftables as an example) + +#### Client + +Client simply need SNAT enabled on the physical interface to translate Phantun's address into +one that can be used on the physical network. This can be done simply with masquerade. + +Note: change `eth0` to whatever actual physical interface name is + +``` +table inet nat { + chain postrouting { + type nat hook postrouting priority srcnat; policy accept; + iifname tun0 oif eth0 masquerade + } +} +``` + +#### Server + +Server needs to DNAT the TCP listening port to Phantun's TUN interface address. + +Note: change `eth0` to whatever actual physical interface name is and `4567` to +actual TCP port number used by Phanton server + +``` +table ip nat { + chain prerouting { + type nat hook prerouting priority dstnat; policy accept; + iif eth0 tcp dport 4567 dnat to 192.168.201.2 + } +} +``` + +### Give Phantun binaries required capability to it can be run as non-root (Optional) + +It is ill-advised to run network facing applications as root user. Phantun can be run fully +as non-root user with the `cap_net_admin` capability. + +``` +sudo setcap cap_net_admin=+pe phantun_server +sudo setcap cap_net_admin=+pe phantun_client +``` + + +### Start + +#### Server + +Note: `4567` is the TCP port Phantun should listen on and must corresponds to the DNAT +rule specified above. `127.0.0.1:1234` is the UDP Server to connect to for new connections. + +``` +RUST_LOG=info /usr/local/bin/phantun_server --local 4567 --remote 127.0.0.1:1234 +``` + +#### Client + +Note: `127.0.0.1:1234` is the UDP address and port Phantun should listen on. `10.0.0.1:4567` is +the Phantun Server to connect. + +``` +RUST_LOG=info /usr/local/bin/phantun_client --local 127.0.0.1:1234 --remote 10.0.0.1:4567 +``` + +## MTU overhead + +Phantun aims to keep tunneling overhead to the minimum. The overhead compared to a plain UDP packet +is the following: + +Plain UDP packet: 20 byte IP header + 8 byte UDP header = 28 bytes +Phantun obfuscated UDP packet: 20 byte IP header + 20 byte TCP header = 40 bytes + +Phantun's additional overhead: 12 bytes. I other words, when using Phantun, the usable payload for +UDP packet is reduced by 12 bytes. This is the minimum overhead possible when doing such kind +of obfuscation. + +## Version compatibility + +While the TCP stack is fairly stable, the general expectation is that you should run same minor versions +of Server/Client of Phantun on both ends to ensure maximum compatibility. + +## Compariation to udp2raw +[udp2raw](https://github.com/wangyu-/udp2raw-tunnel) is another popular project by [@wangyu-](https://github.com/wangyu-) +that is very similiar to what Phantun can do. In fact I took inspirations of Phantun from udp2raw. The biggest reason for +developing Phanton is because of lack of performance when running udp2raw (especially on multi-core systems such as Raspberry Pi). +However, the goal is never to be as feature complete as udp2raw and only support the most common use cases. Most notably, UDP over ICMP +and UDP over UDP mode are not supported and there is no anti-replay nor encryption support. The benefit of this is much better +performance overall and less MTU overhead because lack of additional headers inside the TCP payload. + +Here is a quick overview of comparison between those two to help you choose: + +| | Phantun | udp2raw | +|--------------------------------------------------|:-------------:|:-----------------:| +| UDP over FakeTCP obfuscation | ✅ | ✅ | +| UDP over ICMP obfuscation | ❌ | ✅ | +| UDP over UDP obfuscation | ❌ | ✅ | +| Multi-threaded | ✅ | ❌ | +| Throughput | Better | Good | +| Raw IP mode | TUN interface | Raw sockets + BPF | +| Tunneling MTU overhead | 12 bytes | 44 bytes | +| Seprate TCP connections for each UDP connection | Client/Server | Server only | +| Anti-replay, encryption | ❌ | ✅ | +| IPv6 | Planned | ✅ | + +## License + +Copyright 2021 Datong Sun + +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. diff --git a/fake-tcp/Cargo.toml b/fake-tcp/Cargo.toml new file mode 100644 index 0000000..3b05661 --- /dev/null +++ b/fake-tcp/Cargo.toml @@ -0,0 +1,19 @@ +[package] +name = "fake-tcp" +version = "0.1.0" +edition = "2018" +authors = ["Datong Sun "] +license = "MIT OR Apache-2.0" +repository = "https://github.com/dndx/phantun" +readme = "README.md" +description = """ +A TUN interface based, user space, asynchronous and high performance TCP stack that allows +packet oriented tunneling with minimum overhead. +""" +[dependencies] +bytes = "1" +pnet = "0.28.0" +tokio-tun = "0.3.15" +tokio = { version = "1.11.0", features = ["full"] } +rand = { version = "0.8.4", features = ["small_rng"] } +log = "0.4" diff --git a/fake-tcp/LICENSE-APACHE b/fake-tcp/LICENSE-APACHE new file mode 100644 index 0000000..04169a4 --- /dev/null +++ b/fake-tcp/LICENSE-APACHE @@ -0,0 +1,201 @@ + 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 2014-2021 The Rust Project Developers + +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. diff --git a/fake-tcp/LICENSE-MIT b/fake-tcp/LICENSE-MIT new file mode 100644 index 0000000..90a2d39 --- /dev/null +++ b/fake-tcp/LICENSE-MIT @@ -0,0 +1,27 @@ +MIT License + +Copyright (c) 2014-2021 The Rust Project Developers + +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/fake-tcp/README.md b/fake-tcp/README.md new file mode 100644 index 0000000..5aa6bb5 --- /dev/null +++ b/fake-tcp/README.md @@ -0,0 +1,14 @@ +# fake-tcp + +A TUN interface based, user space, asynchronous and high performance TCP stack that allows +packet oriented tunneling with minimum overhead. + +## License + +Copyright 2021 Datong Sun + +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. diff --git a/src/fake_tcp/mod.rs b/fake-tcp/src/lib.rs similarity index 100% rename from src/fake_tcp/mod.rs rename to fake-tcp/src/lib.rs diff --git a/src/fake_tcp/packet.rs b/fake-tcp/src/packet.rs similarity index 100% rename from src/fake_tcp/packet.rs rename to fake-tcp/src/packet.rs diff --git a/images/traffic-flow.png b/images/traffic-flow.png new file mode 100644 index 0000000..e34e7ae Binary files /dev/null and b/images/traffic-flow.png differ diff --git a/phantun/Cargo.toml b/phantun/Cargo.toml new file mode 100644 index 0000000..a655072 --- /dev/null +++ b/phantun/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "phantun" +version = "0.1.0" +edition = "2018" +authors = ["Datong Sun "] +license = "MIT OR Apache-2.0" +repository = "https://github.com/dndx/phantun" +readme = "README.md" +description = """ +Turns transforms UDP stream into (fake) TCP streams that can go through +Layer 4 firewalls. +""" +[dependencies] +clap = "2.33.3" +socket2 = { version = "0.4.2", features = ["all"] } +fake-tcp = { path = "../fake-tcp" } +tokio-tun = "0.3.15" +tokio = { version = "1.11.0", features = ["full"] } +log = "0.4" +pretty_env_logger = "0.4.0" diff --git a/phantun/LICENSE-APACHE b/phantun/LICENSE-APACHE new file mode 100644 index 0000000..04169a4 --- /dev/null +++ b/phantun/LICENSE-APACHE @@ -0,0 +1,201 @@ + 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 2014-2021 The Rust Project Developers + +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. diff --git a/phantun/LICENSE-MIT b/phantun/LICENSE-MIT new file mode 100644 index 0000000..90a2d39 --- /dev/null +++ b/phantun/LICENSE-MIT @@ -0,0 +1,27 @@ +MIT License + +Copyright (c) 2014-2021 The Rust Project Developers + +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/phantun/README.md b/phantun/README.md new file mode 100644 index 0000000..46476e4 --- /dev/null +++ b/phantun/README.md @@ -0,0 +1,13 @@ +# Phantun + +Client/Server crate, see [Phantun Project README.md](https://github.com/dndx/phantun/blob/main/README.md) for more information. + +## License + +Copyright 2021 Datong Sun + +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. diff --git a/src/bin/client.rs b/phantun/src/bin/client.rs similarity index 98% rename from src/bin/client.rs rename to phantun/src/bin/client.rs index 8f1e241..85a9539 100644 --- a/src/bin/client.rs +++ b/phantun/src/bin/client.rs @@ -1,7 +1,7 @@ use clap::{App, Arg}; +use fake_tcp::packet::MAX_PACKET_LEN; +use fake_tcp::{Socket, Stack}; use log::{debug, error, info}; -use phantom::fake_tcp::packet::MAX_PACKET_LEN; -use phantom::fake_tcp::{Socket, Stack}; use std::collections::HashMap; use std::convert::TryInto; use std::net::{SocketAddr, SocketAddrV4}; diff --git a/src/bin/server.rs b/phantun/src/bin/server.rs similarity index 97% rename from src/bin/server.rs rename to phantun/src/bin/server.rs index b0d7f7f..f713e88 100644 --- a/src/bin/server.rs +++ b/phantun/src/bin/server.rs @@ -1,7 +1,7 @@ use clap::{App, Arg}; +use fake_tcp::packet::MAX_PACKET_LEN; +use fake_tcp::Stack; use log::info; -use phantom::fake_tcp::packet::MAX_PACKET_LEN; -use phantom::fake_tcp::Stack; use std::net::SocketAddrV4; use tokio::net::UdpSocket; use tokio::time::{self, Duration}; diff --git a/src/lib.rs b/src/lib.rs deleted file mode 100644 index 186356f..0000000 --- a/src/lib.rs +++ /dev/null @@ -1 +0,0 @@ -pub mod fake_tcp;