diff --git a/crates/ng/Cargo.toml b/crates/ng/Cargo.toml index b10389d..033cdec 100644 --- a/crates/ng/Cargo.toml +++ b/crates/ng/Cargo.toml @@ -1,14 +1,15 @@ [package] name = "ng" version = "0.1.0" edition = "2024" +license = "BSD 3-Clause" [dependencies] errno = "*" socket2 = "*" libc = "*" log = "0.4.27" thiserror = "2.0.12" [build-dependencies] bindgen = "0.71.1" diff --git a/crates/ng/LICENSE b/crates/ng/LICENSE index 174b1bc..6f557b4 100644 --- a/crates/ng/LICENSE +++ b/crates/ng/LICENSE @@ -1,29 +1,30 @@ BSD 3-Clause License Copyright (c) 2022, Jan-willem De Bleser +Copyright (c) 2025, Jordan Bracco All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/crates/ng/README.md b/crates/ng/README.md index 267730a..5c588e3 100644 --- a/crates/ng/README.md +++ b/crates/ng/README.md @@ -1,4 +1,8 @@ +# ng + +Rust library for manipulating the FreeBSD Netgraph, forked from `ngctl-rs`. + # ngctl-rs Rust tool for manipulating the FreeBSD Netgraph. This started as a tool for easily creating new ng_eiface nodes conneced to a named ng_bridge, for use as part of a custom jail setup with networking provided via Netgraph. Bindgen is used to wrap the Netgraph API, and and Rust wrappers have been written for part of the API. Given a Netgraph path, the tool will check that it is a bridge, find the first available link# hook, attach a new ng_eiface's ether hook to it, and return the interface name of the new ng_eiface. This interface can then be given to a jail via vnet, optionally renaming the interface and/or node for convenience.