Pavão

~ A Rust client library for SMB ~

Get started · Crates.io · Documentation

Developed by @veeso

• Pavão
  • About Pavão 🦚
    • SMB Rust client for Windows
  • Get started 🏁
    • Add pavao to your Cargo.toml 🦀
    • Install pavao C dependencies on your system 🖥️ (not vendored)
      • MacOS 🍎
      • Debian based systems 🐧
      • RedHat based systems 🐧
      • OpenBSD 🐡
      • Termux 🤖
      • Build from sources 📁
    • Select SMB dialect bounds
    • Thread safety and performance
  • Vendored libsmbclient
    • Create a pavao application
    • Run examples
  • Documentation 📚
  • Contributing and issues 🤝🏻
  • Changelog ⏳
  • License 📃

Pavão (/pɐ.ˈvɐ̃w̃/) is a Rust client library for SMB versions 1, 2, and 3, where SMB1 support is explicit opt-in via dialect bounds. It exposes type-safe functions to interact with the C libsmbclient.

SMB is natively supported on Windows by the fs module. If you're looking on how to use SMB on Windows with Rust, please check out this article https://blog.veeso.dev/blog/en/how-to-access-an-smb-share-with-rust-on-windows/ or consider adopting remotefs-smb.

pavao = "0.3"

Install samba with brew:

brew install samba

Install libsmbclient with apt:

apt install -y libsmbclient-dev libsmbclient

⚠️ libsmbclient-dev is required only on the machine where you build the application

Install libsmbclient with dnf:

dnf install libsmbclient-devel libsmbclient

⚠️ libsmbclient-devel is required only on the machine where you build the application

Install samba with pkg_add:

pkg_add samba

Install samba with pkg:

pkg install samba

Install libsmbclient building from sources:

wget -O samba.tar.gz https://github.com/samba-team/samba/archive/refs/tags/samba-4.23.0.tar.gz
mkdir -p samba/
tar  xzvf samba.tar.gz -C samba/ --strip-components=1
rm samba.tar.gz
cd samba/
./configure
make
make install
cd ..
rm -rf samba/

use pavao::{SmbClient, SmbCredentials, SmbDialect, SmbOptions};

let client = SmbClient::new(
    SmbCredentials::default()
        .server("smb://localhost:445")
        .share("/temp"),
    SmbOptions::default()
        .min_protocol(SmbDialect::Smb202)
        .max_protocol(SmbDialect::Smb311),
)?;

Default options keep smb.conf negotiation. SmbDialect::Nt1 (SMB1/CIFS) is deprecated and insecure and must be requested explicitly for both bounds to reach SMB1-only devices.

All simultaneously live Pavão clients must use the exact same minimum and maximum dialect bounds. Default bounds (None, None) and partial bounds are exact policies and conflict with any different pair. After every client using one policy is dropped, a later client may select another policy.

Pavão serializes all native libsmbclient calls across every client in the process. Multiple clients with different credentials and other per-context options may coexist, but they cannot perform SMB work in parallel. One blocking operation delays every other Pavão SMB operation.

Direct FFI calls through SmbClient::ctx() or pavao-sys bypass Pavão's synchronization. They must never race Pavão operations or other raw libsmbclient calls.

It is possible to build libsmbclient statically when building pavao.

To do so it is enough to enable the vendored feature for the pavao crate in your Cargo.toml:

pavao = { version = "0.3", features = ["vendored"] }

Non-vendored builds require libsmbclient ABI 0.5 (Samba 4.10+) or newer.

In order to build and run with the vendored feature YOU MUST have the following libraries in your LD_LIBRARY_PATH:

see DEPENDENCIES

use pavao::{SmbClient, SmbCredentials, SmbOptions, SmbOpenOptions};

// Initialize a new client
let client = SmbClient::new(
    SmbCredentials::default()
        .server(server)
        .share(share)
        .password(password)
        .username(username)
        .workgroup(workgroup),
    SmbOptions::default().one_share_per_server(true),
)
.unwrap();
// do anything you want here with client
let mut file = client.open_with("/abc/test.txt", SmbOpenOptions::default().read(true)).unwrap();
// read file...
drop(file);
// disconnect from server
drop(client);

Two examples are provided along with this repository and can be found under the examples/ directory.

The tree example can be used to get a fs tree of the smb share and can be run with:

cargo run --example tree -- -u <username> -w <workspace> -s <share> -P <password> smb://<hostname>

while the transfer example shows how to write a file to the remote host and can be run with:

cargo run --example transfer -- -i <file_on_local> -o <file_to_write> -u <username> -w <workspace> -s <share> -P <password> smb://<hostname>

The developer documentation can be found on Rust Docs at https://docs.rs/pavao

Contributions, bug reports, new features and questions are welcome! 😉 If you have any question or concern, or you want to suggest a new feature, or you want just want to improve pavao, feel free to open an issue or a PR.

Please follow our contributing guidelines

View Pavão's changelog HERE

Pavão is licensed under the MIT license.

You can read the entire license HERE