Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tormol/uds
A unix domain sockets Rust library
https://github.com/tormol/uds
mio rust-library unix-domain-socket
Last synced: 2 days ago
JSON representation
A unix domain sockets Rust library
- Host: GitHub
- URL: https://github.com/tormol/uds
- Owner: tormol
- License: apache-2.0
- Created: 2019-11-23T19:18:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-10T14:48:05.000Z (5 months ago)
- Last Synced: 2024-12-15T05:08:52.142Z (9 days ago)
- Topics: mio, rust-library, unix-domain-socket
- Language: Rust
- Homepage:
- Size: 338 KB
- Stars: 21
- Watchers: 3
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# uds
A unix domain sockets Rust library that supports abstract addresses, fd-passing, SOCK_SEQPACKET sockets and more.
[](https://crates.io/crates/uds)  [](https://docs.rs/uds/) [](https://cirrus-ci.com/github/tormol/uds) [](https://builds.sr.ht/~sircmpwn/builds.sr.ht?)
When possible, features are implemented via extension traits for [`std::os::unix::net`](https://doc.rust-lang.org/std/os/unix/net/index.html) types (and optionally [mio](https://crates.io/crates/mio)'s uds types) instead of exposing new structs.
The only new socket structs this crate exposes are those for seqpacket sockets.
Ancillary credentials and timestamps are not yet supported.
## Example
(only runs sucessfully on Linux)
```rust
extern crate uds;
let addr = uds::UnixSocketAddr::from_abstract(b"not a file!")
.expect("create abstract socket address");
let listener = uds::UnixSeqpacketListener::bind_unix_addr(&addr)
.expect("create seqpacket listener");
let client = uds::UnixSeqpacketConn::connect_unix_addr(&addr)
.expect("connect to listener");
client.send_fds(b"Here I come", &[0, 1, 2])
.expect("send stdin, stdout and stderr");
let (server_side, _) = listener.accept_unix_addr()
.expect("accept connection");
let creds: uds::ConnCredentials = server_side.initial_peer_credentials()
.expect("get peer credentials");
if creds.euid() == 0 {
let mut fd_buf = [-1; 3];
let (_, _, fds) = server_side.recv_fds(&mut[0u8; 1], &mut fd_buf
).expect("receive with fd capacity");
if fds == 3 {
/* do something with the file descriptors */
}
/* remember to close the file descripts */
} else {
server_side.send(b"go away!\n").expect("send response");
}
```
## Portability
macOS doesn't support SOCK_SEQPACKET sockets, and abstract socket addresses is Linux-only, so if you don't want to bother with supporting non-portable features you are probably better off only using what std or mio provides.
If you're writing a datagram server though, using std or mio means you can't respond to abstract adresses, forcing clients to use path addresses and deal with cleaning up the socket file after themselves.
Even when all operating systems you care about supports something, they might behave differently:
On Linux file descriptors are cloned when they are sent, but macOS and the BSDs first clones them when they are received. This means that if a FD is closed before the peer receives it you have a problem.
Also, some OSes might return the original file descriptor without cloning it if it's received within the same process as it was sent from. (DragonFly BSD, possibly macOS and maybe FreeBSD).
| | Linux | macOS | FreeBSD | OpenBSD | DragonFly BSD | NetBSD | Illumos |
|-|-|-|-|-|-|-|-|
| **Seqpacket** | Yes | N/A | Yes | Yes | Yes | Yes | N/A |
| **fd-passing** | Yes | Yes | Yes | Yes | Yes | Yes | No |
| **abstract addresses** | Yes | N/A | N/A | N/A | N/A | N/A | N/A |
| **mio 0.8** | Yes | Yes | Yes | Yes | Yes | Yes | Yes |
| **tokio 1.0** | Yes | Yes | Yes | Yes | Yes | Yes | No |
| **Tested?** | Locally + CI | CI | CI | CI | Manually\* | Manually\* | Manually\* |
\*: Not tested since v0.2.6. (but (cross)checked on CI.)
### Other OSes
* Android: I haven't tested on it, but I assume there are no differences from regular Linux.
* Windows 10: While it added some unix socket features, Windows support is not a priority. (PRs are welcome though).
* Solaris: Treated identically as Illumos. mio 0.8 doesn't support it.
## mio integration
The `mio_08` feature makes the seqpacket types usable with [mio](https://github.com/tokio-rs/mio) version 0.8 (by implementing its `Source` trait for them),
and implements this crates extension traits for the unix socket types in [`mio::net`](https://docs.rs/mio/latest/mio/net/index.html).
To enable it, add this to Cargo.toml:
```toml
[dependencies]
uds = {version="0.4.0", features=["mio_08"]}
```
## tokio integration
The `tokio` feature adds [`async`-based seqpacket types](https://docs.rs/uds/latest/uds/tokio/index.html) for use with [tokio](https://github.com/tokio-rs/tokio) version 1.\*:
To enable it, add this to Cargo.toml:
```toml
[dependencies]
uds = {version="0.4.2", features=["tokio"]}
```
## Minimum Rust version
The minimum Rust version is 1.63.
Older versions might work, but might break in a minor release.
## `unsafe` usage
This crate calls many C functions, which are all `unsafe` (even ones as simple as `socket()`).
The public interface is safe (except for `FromRawFd`), so if you find something unsound (even internal functions that aren't marked `unsafe`) please open an issue.
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.