enable HttpConnector::interface on macOS and Solarish systems
#176
+119
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This points the `socket2` dependency at rust-lang/socket2@d95e914 temporarily so that we can use these APIs on Solarish operating systems.
7 tasks
|
LGTM, thanks! Will just wait till that socket2 release :) |
Yup, no rush --- just wanted to get this ready to go when that's out. :) |
seanmonstar
approved these changes
Mar 31, 2025
|
Haha, I was just about to leave a comment mentioning that the |
hawkw
added a commit
to hawkw/reqwest
that referenced
this pull request
Mar 31, 2025
The `ClientBuilder` type has an `interface` method that sets the name of a specific network interface to bind TCP connections on. This method is currently only enabled on Linux, Android, and Fuchsia, as it uses the `SO_BINDTODEVICE` socket option, which only exists on those systems. Upstream changes to `socket2` (rust-lang/socket2#561) and `hyper-util` (hyperium/hyper-util#176) have added support for similar functionality on macOS (and other Apple operating systems, such as iOS, watchOS, tvOS, and visionOS), and Solaris and Solaris-like systems like illumos, using the `IP_BOUND_IF`/`IPV6_BOUND_IF` socket options on those systems. This branch enables the `ClientBuilder::interface` API on these additional target OSes. Note that this presently requires a Cargo patch to take a Git dependency on hyperium/hyper-util@5831ace. Once that commit is published, the patch can be removed. This PR should not be merged until then. Fixes seanmonstar#2571
seanmonstar
pushed a commit
to seanmonstar/reqwest
that referenced
this pull request
Apr 9, 2025
The `ClientBuilder` type has an `interface` method that sets the name of a specific network interface to bind TCP connections on. This method is currently only enabled on Linux, Android, and Fuchsia, as it uses the `SO_BINDTODEVICE` socket option, which only exists on those systems. Upstream changes to `socket2` (rust-lang/socket2#561) and `hyper-util` (hyperium/hyper-util#176) have added support for similar functionality on macOS (and other Apple operating systems, such as iOS, watchOS, tvOS, and visionOS), and Solaris and Solaris-like systems like illumos, using the `IP_BOUND_IF`/`IPV6_BOUND_IF` socket options on those systems. This branch enables the `ClientBuilder::interface` API on these additional target OSes. Fixes #2571
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
client::legacy::connect::HttpConnectortype has a methodset_interfacethat configures the connector to bind TCP connectionsonly on the provided interface name. Presently, this is enabled only on
Linux, Android, and Fuchsia, as it uses the Linux-only socket option
SO_BINDTODEVICE.On macOS (and other Apple operating systems such as iOS, watchOS,
etc), and Solaris and Solaris-like systems like illumos, the Solaris
socket option [
IP_BOUND_IF] provides similar functionality toSO_BINDTODEVICE, as it also restricts connections to a particularnetwork itnerface. Unlike the Linux socket option,
IP_BOUND_IFtakesthe numeric index of the interface, so in order to accept a string
interface name similarly to the Linux implementation, we must use
if_nametoindex(3socket)from libc to determine the indexcorresponding to the interface name. This is done every time we open a
connection, to avoid TOCTOU issues in case interface indices or names
change.
Note that this PR currently requires an unreleased change in
socket2(rust-lang/socket2#566) to enable
IP_BOUND_IFon Solarish operatingsystems. We will need to remove the Cargo patch for
socket2once thatchange is released, prior to merging this PR.