gethostname-0.4.3/.cargo_vcs_info.json0000644000000001360000000000100133560ustar { "git": { "sha1": "9b4ffb2275aaf7c9fd48099810c99e5c9dc3efd8" }, "path_in_vcs": "" }gethostname-0.4.3/.github/dependabot.yml000064400000000000000000000004161046102023000163370ustar 00000000000000version: 2 updates: # Check for updates of github actions every month; we don't check for rust # packages because that's mostly a nuisance, and covered by cargo update. - package-ecosystem: "github-actions" directory: "/" schedule: interval: monthly gethostname-0.4.3/.github/workflows/ci.yml000064400000000000000000000025401046102023000166620ustar 00000000000000name: CI on: push: # Don't build tags; that's redundant with pushes to main normally. tags-ignore: '*' # Only build main, for all other branches rely on pull requests. This # avoids duplicate builds for pull requests. branches: main # Don't build for trivial changes paths-ignore: - '*.md' - 'LICENSE' pull_request: jobs: cargo-deny: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - uses: EmbarkStudios/cargo-deny-action@v1 test: name: test runs-on: ${{ matrix.os }} strategy: matrix: os: [ubuntu-latest, windows-latest, macOS-latest] rust: # Our minimal supported version - '1.64.0' # The standard Rust version - stable steps: - uses: actions/checkout@v3 - uses: dtolnay/rust-toolchain@master with: toolchain: ${{ matrix.rust }} components: clippy,rustfmt - run: cargo test # Run tests with fixed hostname on Unix systems - run: sudo hostname hostname-for-testing if: "!contains(matrix.os, 'windows')" - run: cargo test -- --ignored if: "!contains(matrix.os, 'windows')" - run: cargo clippy --all-targets if: matrix.rust == 'stable' - run: cargo fmt --check if: matrix.rust == 'stable' - run: cargo doc gethostname-0.4.3/.gitignore000064400000000000000000000000361046102023000141350ustar 00000000000000/target **/*.rs.bk Cargo.lock gethostname-0.4.3/CHANGELOG.md000064400000000000000000000044151046102023000137630ustar 00000000000000# Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ## [0.4.3] – 2023-05-13 ### Changed - Removed the `windows` dependency in favor of using embedded bindings, see [GH-11]. [GH-11]: https://github.com/swsnr/gethostname.rs/pull/11 ## [0.4.2] – 2023-04-13 ### Changed - Update dependencies. ## [0.4.1] – 2022-12-01 ### Changed - Update repository URL to . ## [0.4.0] – 2022-10-28 ### Changed - Replace `winapi` with windows-rs, see [GH-7]. - Bump MSRV to 1.64 as required by windows-rs, see [GH-7]. [GH-7]: https://github.com/swsnr/gethostname.rs/pull/7 ## [0.3.0] – 2022-10-09 ### Changed - Bump MSRV to 1.56. ## [0.2.3] – 2022-03-12 ### Changed - Limit `gethostname()` to `cfg(unix)` and `cfg(windows)` to provide more useful build failures on other platforms (see [CB-7]). [CB-7]: https://codeberg.org/flausch/gethostname.rs/issues/7 ## [0.2.2] – 2022-01-14 ## [0.2.1] – 2019-12-18 ### Changed - Consolidate documetation. - Update crates.io metadata. ## [0.2.0] – 2019-01-22 ### Added - Add Windows implementation (see [GH-1]). [GH-1]: https://github.com/swsnr/gethostname.rs/pull/1 ### Changed - Pin supported Rust version to 1.31 ## 0.1.0 – 2019-01-20 Initial release. ### Added - `gethostname()` for non-Windows platforms. [Unreleased]: https://github.com/swsnr/gethostname.rs/compare/v0.4.3...HEAD [0.4.3]: https://github.com/swsnr/gethostname.rs/compare/v0.4.2...v0.4.3 [0.4.2]: https://github.com/swsnr/gethostname.rs/compare/v0.4.1...v0.4.2 [0.4.1]: https://github.com/swsnr/gethostname.rs/compare/v0.4.0...v0.4.1 [0.4.0]: https://github.com/swsnr/gethostname.rs/compare/v0.3.0...v0.4.0 [0.3.0]: https://github.com/swsnr/gethostname.rs/compare/v0.2.3...v0.3.0 [0.2.3]: https://github.com/swsnr/gethostname.rs/compare/v0.2.2...v0.2.3 [0.2.2]: https://github.com/swsnr/gethostname.rs/compare/gethostname-0.2.1...v0.2.2 [0.2.0]: https://github.com/swsnr/gethostname.rs/compare/gethostname-0.1.0...gethostname-0.2.0 [0.2.1]: https://github.com/swsnr/gethostname.rs/compare/gethostname-0.2.0...gethostname-0.2.1 gethostname-0.4.3/Cargo.toml0000644000000021170000000000100113550ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" rust-version = "1.64" name = "gethostname" version = "0.4.3" authors = ["Sebastian Wiesner "] description = "gethostname for all platforms" homepage = "https://github.com/swsnr/gethostname.rs" documentation = "https://docs.rs/gethostname" readme = "README.md" keywords = [ "gethostname", "DNS", "hostname", ] categories = [ "os", "api-bindings", ] license = "Apache-2.0" repository = "https://github.com/swsnr/gethostname.rs.git" [target."cfg(not(windows))".dependencies.libc] version = "0.2.141" [target."cfg(windows)".dependencies.windows-targets] version = "0.48" gethostname-0.4.3/Cargo.toml.orig000064400000000000000000000011221046102023000150310ustar 00000000000000[package] name = "gethostname" description = "gethostname for all platforms" readme = "README.md" homepage = "https://github.com/swsnr/gethostname.rs" repository = "https://github.com/swsnr/gethostname.rs.git" documentation = "https://docs.rs/gethostname" version = "0.4.3" authors = ["Sebastian Wiesner "] edition = "2021" license = "Apache-2.0" keywords = ["gethostname", "DNS", "hostname"] categories = ["os", "api-bindings"] rust-version = "1.64" [target.'cfg(not(windows))'.dependencies] libc = "0.2.141" [target.'cfg(windows)'.dependencies] windows-targets = "0.48" gethostname-0.4.3/LICENSE000064400000000000000000000251371046102023000131630ustar 00000000000000 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. gethostname-0.4.3/README.md000064400000000000000000000020331046102023000134230ustar 00000000000000# gethostname.rs [![Current release](https://img.shields.io/crates/v/gethostname.svg)][crates] [![Documentation](https://docs.rs/gethostname/badge.svg)][docs] [gethostname()][ghn] for all platforms. ```rust use gethostname::gethostname; println!("Hostname: {:?}", gethostname()); ``` [crates]: https://crates.io/crates/gethostname [docs]: https://docs.rs/gethostname [ghn]: http://pubs.opengroup.org/onlinepubs/9699919799/functions/gethostname.html ## License Copyright 2019–2023 Sebastian Wiesner 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 . 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. gethostname-0.4.3/deny.toml000064400000000000000000000012501046102023000140000ustar 00000000000000targets = [ # These are the targets we test for { triple = "x86_64-unknown-linux-gnu" }, { triple = "x86_64-apple-darwin" }, { triple = "x86_64-pc-windows-msvc" }, ] [advisories] db-path = "~/.cargo/advisory-db" db-urls = ["https://github.com/rustsec/advisory-db"] vulnerability = "deny" unmaintained = "deny" yanked = "deny" notice = "warn" ignore = [] [licenses] unlicensed = "deny" allow = ["MIT", "Apache-2.0"] deny = [] # Deny all copyleft license except the ones above. copyleft = "deny" allow-osi-fsf-free = "neither" default = "deny" confidence-threshold = 0.8 [sources] unknown-registry = "deny" unknown-git = "deny" [bans] multiple-versions = "deny" gethostname-0.4.3/release.toml000064400000000000000000000010761046102023000144670ustar 00000000000000pre-release-commit-message = "Release {{version}}" tag-prefix = "" tag-message = "Version {{tag_name}}" pre-release-replacements = [ # Update the changelog { file = "CHANGELOG.md", search = "## \\[Unreleased\\]", replace = "## [Unreleased]\n\n## [{{version}}] – {{date}}", exactly = 1 }, { file = "CHANGELOG.md", search = "HEAD", replace = "{{tag_name}}", exactly = 1 }, { file = "CHANGELOG.md", search = "\\[Unreleased\\]: ", replace = "[Unreleased]: https://github.com/swsnr/gethostname.rs/compare/{{tag_name}}...HEAD\n[{{version}}]: ", exactly = 1 }, ] gethostname-0.4.3/src/lib.rs000064400000000000000000000154551046102023000140630ustar 00000000000000// Copyright 2019–2023 Sebastian Wiesner // 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. //! [gethostname()][ghn] for all platforms. //! //! ``` //! use gethostname::gethostname; //! //! println!("Hostname: {:?}", gethostname()); //! ``` //! //! [ghn]: http://pubs.opengroup.org/onlinepubs/9699919799/functions/gethostname.html #![deny(warnings, missing_docs, clippy::all)] use std::ffi::OsString; /// Get the standard host name for the current machine. /// /// On Unix simply wrap POSIX [gethostname] in a safe interface. On Windows /// return the DNS host name of the local computer, as returned by /// [GetComputerNameExW] with `ComputerNamePhysicalDnsHostname` as `NameType`. /// /// This function panics if the buffer allocated for the hostname result of the /// operating system is too small; however we take great care to allocate a /// buffer of sufficient size: /// /// * On Unix we allocate the buffer using the maximum permitted hostname size, /// as returned by [sysconf] via `sysconf(_SC_HOST_NAME_MAX)`, plus an extra /// byte for the trailing NUL byte. A hostname cannot exceed this limit, so /// this function can't realistically panic. /// * On Windows we call `GetComputerNameExW` with a NULL buffer first, which /// makes it return the length of the current host name. We then use this /// length to allocate a buffer for the actual result; this leaves a tiny /// tiny race condition in case the hostname changes to a longer name right /// in between those two calls but that's a risk we don't consider of any /// practical relevance. /// /// Hence _if_ this function does panic please [report an issue][new]. /// /// [gethostname]: http://pubs.opengroup.org/onlinepubs/9699919799/functions/gethostname.html /// [sysconf]: http://pubs.opengroup.org/onlinepubs/9699919799/functions/sysconf.html /// [GetComputerNameExW]: https://docs.microsoft.com/en-us/windows/desktop/api/sysinfoapi/nf-sysinfoapi-getcomputernameexw /// [new]: https://github.com/swsnr/gethostname.rs/issues/new pub fn gethostname() -> OsString { gethostname_impl() } #[cfg(unix)] #[inline] fn gethostname_impl() -> OsString { use libc::{c_char, sysconf, _SC_HOST_NAME_MAX}; use std::os::unix::ffi::OsStringExt; // Get the maximum size of host names on this system, and account for the // trailing NUL byte. let hostname_max = unsafe { sysconf(_SC_HOST_NAME_MAX) }; let mut buffer = vec![0; (hostname_max as usize) + 1]; let returncode = unsafe { libc::gethostname(buffer.as_mut_ptr() as *mut c_char, buffer.len()) }; if returncode != 0 { // There are no reasonable failures, so lets panic panic!( "gethostname failed: {} Please report an issue to !", std::io::Error::last_os_error() ); } // We explicitly search for the trailing NUL byte and cap at the buffer // length: If the buffer's too small (which shouldn't happen since we // explicitly use the max hostname size above but just in case) POSIX // doesn't specify whether there's a NUL byte at the end, so if we didn't // check we might read from memory that's not ours. let end = buffer.iter().position(|&b| b == 0).unwrap_or(buffer.len()); buffer.resize(end, 0); OsString::from_vec(buffer) } #[cfg(windows)] #[inline] fn gethostname_impl() -> OsString { use std::os::windows::ffi::OsStringExt; // The DNS host name of the local computer. If the local computer is a node // in a cluster, lpBuffer receives the DNS host name of the local computer, // not the name of the cluster virtual server. pub const COMPUTER_NAME_PHYSICAL_DNS_HOSTNAME: i32 = 5; // https://learn.microsoft.com/en-us/windows/win32/api/sysinfoapi/nf-sysinfoapi-getcomputernameexw ::windows_targets::link!("kernel32.dll" "system" fn GetComputerNameExW(nametype: i32, lpbuffer: *mut u16, nsize: *mut u32) -> i32); let mut buffer_size: u32 = 0; unsafe { // This call always fails with ERROR_MORE_DATA, because we pass NULL to // get the required buffer size. GetComputerNameExW then fills buffer_size with the size // of the host name string plus a trailing zero byte. GetComputerNameExW( COMPUTER_NAME_PHYSICAL_DNS_HOSTNAME, std::ptr::null_mut(), &mut buffer_size, ) }; assert!( 0 < buffer_size, "GetComputerNameExW did not provide buffer size" ); let mut buffer = vec![0_u16; buffer_size as usize]; unsafe { if GetComputerNameExW( COMPUTER_NAME_PHYSICAL_DNS_HOSTNAME, buffer.as_mut_ptr(), &mut buffer_size, ) == 0 { panic!( "GetComputerNameExW failed to read hostname. Please report this issue to !" ); } } assert!( // GetComputerNameExW returns the size _without_ the trailing zero byte on the second call buffer_size as usize == buffer.len() - 1, "GetComputerNameExW changed the buffer size unexpectedly" ); let end = buffer.iter().position(|&b| b == 0).unwrap_or(buffer.len()); OsString::from_wide(&buffer[0..end]) } #[cfg(test)] mod tests { use std::process::Command; #[test] fn gethostname_matches_system_hostname() { let output = Command::new("hostname") .output() .expect("failed to get hostname"); if output.status.success() { let hostname = String::from_utf8_lossy(&output.stdout); assert!( !hostname.is_empty(), "Failed to get hostname: hostname empty?" ); // Convert both sides to lowercase; hostnames are case-insensitive // anyway. assert_eq!( super::gethostname().into_string().unwrap().to_lowercase(), hostname.trim_end().to_lowercase() ); } else { panic!( "Failed to get hostname! {}", String::from_utf8_lossy(&output.stderr) ); } } #[test] #[ignore] fn gethostname_matches_fixed_hostname() { assert_eq!( super::gethostname().into_string().unwrap().to_lowercase(), "hostname-for-testing" ); } }