From bc3eabee28dfe8ab80be67dff0a536d0c0f09ec3 Mon Sep 17 00:00:00 2001 From: Hatter Jiang Date: Fri, 25 Jul 2025 23:44:04 +0800 Subject: [PATCH] feat: clone from https://github.com/dndx/uip --- Cargo.toml | 28 +++++++ LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 27 +++++++ README.md | 90 +++++++++++++++++++++- src/main.rs | 88 ++++++++++++++++++++++ 5 files changed, 433 insertions(+), 1 deletion(-) create mode 100644 Cargo.toml create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 src/main.rs diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..90fa920 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,28 @@ +[package] +name = "uip" +version = "0.1.6" +edition = "2021" +authors = ["Datong Sun "] +license = "MIT OR Apache-2.0" +repository = "https://github.com/dndx/uip" +readme = "README.md" +description = """ +A tool to quickly determine the public IP address of a machine behind +NAT with the help of STUN servers. +""" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +clap = { version = "4.2", features = ["cargo"] } +log = "0.4" +stun = "0.4" +tokio = "1.27" +pretty_env_logger = "0.5" + +[profile.release] +strip = true +opt-level = "z" # Optimize for size. +lto = true +panic = "abort" +codegen-units = 1 diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..99b9d54 --- /dev/null +++ b/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 2021-2022 Datong Sun (dndx@idndx.com) + +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/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..47790f3 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,27 @@ +MIT License + +Copyright (c) 2021-2022 Datong Sun (dndx@idndx.com) + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index bea5f0a..53a1129 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,91 @@ # uip -Clone from: https://github.com/dndx/uip \ No newline at end of file +A tool to quickly determine the public IP address of a machine behind +NAT with the help of STUN servers. + +# Overview + +This tool is as simple as it sounds, when executed, it outputs the current machine's +public IP address by sending a binding request to the STUN server and displaying the +`XOR-MAPPED-ADDRESS` or `MAPPED-ADDRESS` attribute returned by the STUN server. + +# Install + +Either download pre-built binaries from the release page, or use `cargo install uip` to install it. + +# Usage + +``` +$ uip -h +A tool to quickly determine the public IP address of a machine behind +NAT with the help of STUN servers. + + +Usage: uip [OPTIONS] [HOST:PORT] + +Arguments: + [HOST:PORT] STUN server host and port. If PORT is omitted, it defaults to 3478 [default: stun.cloudflare.com] + +Options: + -4, --ipv4-only Do not use IPv6 addresses when connecting to STUN server + -h, --help Print help + -V, --version Print version +``` + +## Default port (UDP 3478): + +``` +$ uip stun.cloudflare.com +203.0.113.1 +``` + +## Custom port: + +``` +$ uip stun.l.google.com:19302 +203.0.113.1 +``` + +This program use return code `0` to indicate success and a valid IP has been returned. +All other return code indicates error. + +The program timeouts after `5` seconds in case a response can not be received. + +To debug, run it with `RUST_LOG=debug uip`. + +# Public STUN servers + +* `stun.cloudflare.com` +* `stun.l.google.com` +* `stun1.l.google.com` +* `stun2.l.google.com` +* `stun3.l.google.com` +* `stun4.l.google.com` +* `stun.syncthing.net` +* `stun.xten.com` + +## Servers in China + +* `stun.qq.com` +* `stun.miwifi.com` +* `stun.chat.bilibili.com` + +[public-stun-list.txt](https://gist.github.com/mondain/b0ec1cf5f60ae726202e) (Unverified) + +# Credits + +This script was modified from the [`stun_client.rs`](https://github.com/webrtc-rs/webrtc/blob/master/stun/examples/stun_client.rs) +example of the [WebRTC.rs project](https://github.com/webrtc-rs/webrtc) by Rain Liu . + +`uip` added better error handling, more friendly command line interface and fallback to `MAPPED-ADDRESS` attribute +in case `XOR-MAPPED-ADDRESS` can not be found since some servers that I tested does not return `XOR-MAPPED-ADDRESS`. + +# License + +Copyright 2023 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. diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..feaae8f --- /dev/null +++ b/src/main.rs @@ -0,0 +1,88 @@ +use log::info; +use stun::addr::*; +use stun::agent::*; +use stun::client::*; +use stun::message::*; +use stun::xoraddr::*; +use stun::Error; + +use clap::{arg, command, Arg, ArgAction}; +use std::sync::Arc; +use tokio::net::{lookup_host, UdpSocket}; + +#[tokio::main] +async fn main() -> Result<(), Error> { + pretty_env_logger::init(); + + let matches = command!() // requires `cargo` feature + .arg( + arg!([SERVER] "STUN server host and port. If PORT is omitted, it defaults to 3478") + .value_name("HOST:PORT") + .default_value("stun.cloudflare.com"), + ) + .arg( + Arg::new("ipv4_only") + .long("ipv4-only") + .short('4') + .required(false) + .help("Do not use IPv6 addresses when connecting to STUN server") + .action(ArgAction::SetTrue), + ) + .get_matches(); + + let (handler_tx, mut handler_rx) = tokio::sync::mpsc::unbounded_channel(); + + let mut server = matches.get_one::("SERVER").unwrap().clone(); + if server.as_str().starts_with('[') { + // IPv6 literal + if !server.contains("]:") { + server.push_str(":3478"); + } + } else if !server.contains(':') { + server.push_str(":3478"); + } + + let ipv4_only = matches.get_flag("ipv4_only"); + + let addr = lookup_host(server) + .await + .expect("failed to parse/resolve server address and port number") + .find(|addr| !ipv4_only || addr.is_ipv4()) + .expect("unable to resolve remote host name"); + + info!("Server address is: {}", addr); + + let conn = UdpSocket::bind(if addr.is_ipv4() { + "0.0.0.0:0" + } else { + "[::]:0" + }) + .await?; + + conn.connect(addr).await?; + + let mut client = ClientBuilder::new().with_conn(Arc::new(conn)).build()?; + + let mut msg = Message::new(); + msg.build(&[Box::::default(), Box::new(BINDING_REQUEST)])?; + + client.send(&msg, Some(Arc::new(handler_tx))).await?; + + if let Some(event) = handler_rx.recv().await { + let msg = event.event_body?; + let mut xor_addr = XorMappedAddress::default(); + if xor_addr.get_from(&msg).is_ok() { + println!("{}", xor_addr.ip); + } else { + info!("XOR-MAPPED-ADDRESS attribute does not exist, trying MAPPED-ADDRESS instead"); + + let mut addr = MappedAddress::default(); + addr.get_from(&msg)?; + println!("{}", addr.ip); + } + } + + client.close().await?; + + Ok(()) +}