Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fubarnetes/libjail-rs

Rust implementation of a FreeBSD jail library
https://github.com/fubarnetes/libjail-rs

freebsd freebsd-jail-manager freebsd-jails jails rust rust-library

Last synced: 29 days ago
JSON representation

Rust implementation of a FreeBSD jail library

Host: GitHub
URL: https://github.com/fubarnetes/libjail-rs
Owner: fubarnetes
License: bsd-3-clause
Created: 2018-05-16T22:09:26.000Z (over 6 years ago)
Default Branch: dev
Last Pushed: 2023-06-17T11:11:16.000Z (over 1 year ago)
Last Synced: 2024-04-14T17:01:35.224Z (8 months ago)
Topics: freebsd, freebsd-jail-manager, freebsd-jails, jails, rust, rust-library
Language: Rust
Homepage: https://crates.io/crates/jail
Size: 9.14 MB
Stars: 49
Watchers: 8
Forks: 12
Open Issues: 14
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-rust-cn - fubarnetes/libjail-rs

README

        # libjail-rs

[![Crates.io](https://img.shields.io/crates/v/jail.svg?style=flat-square)](https://crates.io/crates/jail)

[![](https://tokei.rs/b1/github/fubarnetes/libjail-rs)](https://github.com/fubarnetes/libjail-rs)

[![GitHub last commit](https://img.shields.io/github/last-commit/fubarnetes/libjail-rs.svg?style=flat-square)](https://github.com/fubarnetes/libjail-rs/commits/master)

[![Gitter](https://img.shields.io/gitter/room/fubarnetes/libjail-rs.js.svg?style=flat-square)](https://gitter.im/fubarnetes/libjail-rs)

[![Libraries.io for

releases](https://img.shields.io/librariesio/release/cargo/jail.svg?style=flat-square)](https://libraries.io/cargo/jail/)

[![Crates.io](https://img.shields.io/crates/d/jail.svg?style=flat-square)](https://crates.io/crates/jail)

[![Crates.io](https://img.shields.io/crates/l/jail.svg?style=flat-square)](https://crates.io/crates/jail)

[![Docs: x86_64-unknown-freebsd](https://img.shields.io/badge/docs-x86__64--unknown--freebsd-blue.svg?style=flat-square)](https://fubarnetes.github.io/libjail-rs/x86_64-unknown-freebsd/jail/index.html)

[![Docs: i686-unknown-freebsd](https://img.shields.io/badge/docs-i686--unknown--freebsd-blue.svg?style=flat-square)](https://fubarnetes.github.io/libjail-rs/i686-unknown-freebsd/jail/index.html)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Ffubarnetes%2Flibjail-rs.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Ffubarnetes%2Flibjail-rs?ref=badge_shield)

libjail-rs aims to be a rust implementation of the FreeBSD [jail(3)](https://www.freebsd.org/cgi/man.cgi?query=jail&sektion=3&manpath=FreeBSD+11.1-stable) library. While feature parity is a goal, a one-to-one implementation of all functions in [jail(3)](https://www.freebsd.org/cgi/man.cgi?query=jail&sektion=3&manpath=FreeBSD+11.1-stable) is not.

# Is it any good?

[Yes.](https://news.ycombinator.com/item?id=3067434)

# Can I use it?

This library is still under heavy development, but seems to work so far.

No stability guarantees are made.

# How do I use it?

```

jail = "*"

```

Execute a command in a jail:

```rust

use jail::process::Jailed;

use jail::StoppedJail;

use std::process::Command;

fn main() {

    let stopped = StoppedJail::new("/path/to/root")

        .name("alcatraz")

        .ip("127.0.1.2".parse().unwrap())

        .ip("fe80::2".parse().unwrap * ())

        .param("allow.raw_sockets", param::Value::Int(1));

    let running = stopped.start().expect("Couldn't start Jail");

    let output = Command::new("hostname")

        .jail(&running)

        .output()

        .expect("Failed to execute command");

    println!("output: {:?}", output.stdout);

    running.kill();

}

```

# Is it fast?

There are a few benchmarks included. Run them with `sudo cargo bench` (yes,

starting a jail requires being `root`).

These are some results on my laptop, on slow, spinning disks:

```

test echo_helloworld_free       ... bench:     271,418 ns/iter (+/- 17,522)

test echo_helloworld_jailed     ... bench:     461,749 ns/iter (+/- 26,267)

test get_ips                    ... bench:      29,591 ns/iter (+/- 3,315)

test start_echo_helloworld_stop ... bench:     504,978 ns/iter (+/- 23,717)

test start_stop_ipjail          ... bench:      27,220 ns/iter (+/- 2,141)

test start_stop_ipv4jail        ... bench:      26,307 ns/iter (+/- 2,159)

test start_stop_ipv6jail        ... bench:      26,988 ns/iter (+/- 2,486)

test start_stop_jail            ... bench:      25,760 ns/iter (+/- 2,244)

```

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Ffubarnetes%2Flibjail-rs.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Ffubarnetes%2Flibjail-rs?ref=badge_large)