https://github.com/veeso/pavao
A Rust client library for SMB 🦚
https://github.com/veeso/pavao
libsmbclient rust rust-lang rust-smb smb smbclient
Last synced: 22 days ago
JSON representation
A Rust client library for SMB 🦚
- Host: GitHub
- URL: https://github.com/veeso/pavao
- Owner: veeso
- License: gpl-3.0
- Created: 2021-05-25T14:53:12.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-20T13:49:22.000Z (about 1 month ago)
- Last Synced: 2025-03-28T16:04:37.616Z (29 days ago)
- Topics: libsmbclient, rust, rust-lang, rust-smb, smb, smbclient
- Language: Rust
- Homepage:
- Size: 8.62 MB
- Stars: 69
- Watchers: 2
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Pavão
~ A Rust client library for SMB ~
Get started
·
Crates.io
·
Documentation
Developed by @veeso
Current version: 0.2.12 (19/03/2025)
---
- [Pavão](#pavão)
- [About Pavão 🦚](#about-pavão-)
- [SMB Rust client for Windows](#smb-rust-client-for-windows)
- [Get started 🏁](#get-started-)
- [Add pavao to your Cargo.toml 🦀](#add-pavao-to-your-cargotoml-)
- [Install pavao C dependencies on your system 🖥️](#install-pavao-c-dependencies-on-your-system-️)
- [MacOS 🍎](#macos-)
- [Debian based systems 🐧](#debian-based-systems-)
- [RedHat based systems 🐧](#redhat-based-systems-)
- [OpenBSD 🐡](#openbsd-)
- [Termux 🤖](#termux-)
- [Build from sources 📁](#build-from-sources-)
- [Vendored libsmbclient](#vendored-libsmbclient)
- [Create a pavao application](#create-a-pavao-application)
- [Run examples](#run-examples)
- [Documentation 📚](#documentation-)
- [Support the developer ☕](#support-the-developer-)
- [Contributing and issues 🤝🏻](#contributing-and-issues-)
- [Changelog ⏳](#changelog-)
- [License 📃](#license-)
---
## About Pavão 🦚
Pavão (/pɐ.ˈvɐ̃w̃/) is a Rust client library for SMB version 2 and 3 which exposes type-safe functions to interact with the C libsmbclient.
### SMB Rust client for Windows
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 or consider adopting [remotefs-smb](https://github.com/veeso/remotefs-rs-smb).
---
## Get started 🏁
### Add pavao to your Cargo.toml 🦀
```toml
pavao = "0.2"
```
### Install pavao C dependencies on your system 🖥️
#### MacOS 🍎
Install samba with brew:
```sh
brew install samba
```
#### Debian based systems 🐧
Install libsmbclient with apt:
```sh
apt install -y libsmbclient-dev libsmbclient
```
⚠️ `libsmbclient-dev` is required only on the machine where you build the application
#### RedHat based systems 🐧
Install libsmbclient with dnf:
```sh
dnf install libsmbclient-devel libsmbclient
```
⚠️ `libsmbclient-devel` is required only on the machine where you build the application
#### OpenBSD 🐡
Install samba with pkg_add:
```sh
pkg_add samba
```
#### Termux 🤖
Install samba with pkg:
```sh
pkg install samba
```
#### Build from sources 📁
Install libsmbclient building from sources:
```sh
wget -O samba.tar.gz https://github.com/samba-team/samba/archive/refs/tags/samba-4.16.1.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/
```
---
## Vendored libsmbclient
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`:
```toml
pavao = { version = "0.2", features = ["vendored"] }
```
> [!CAUTION]
> Mind that libsmbclient is a bloated library with tons of dependencies, so the vendored feature will increase the size of the final binary and may not work on all platforms.
In order to build and run with the `vendored` feature YOU MUST have the following libraries in your **LD_LIBRARY_PATH**:
see [DEPENDENCIES](./pavao-src/README.md)
---
### Create a pavao application
```rust
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);
```
### Run examples
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:
```sh
cargo run --example tree -- -u -w -s -P smb://
```
while the `transfer` example shows how to write a file to the remote host and can be run with:
```sh
cargo run --example transfer -- -i -o -u -w -s -P smb://
```
---
## Documentation 📚
The developer documentation can be found on Rust Docs at
---
## Support the developer ☕
If you like Pavão and you're grateful for the work I've done, please consider a little donation 🥳
You can make a donation with one of these platforms:
[](https://ko-fi.com/veeso)
[](https://www.paypal.me/chrisintin)
---
## Contributing and issues 🤝🏻
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](CONTRIBUTING.md)
---
## Changelog ⏳
View Pavão's changelog [HERE](CHANGELOG.md)
---
## License 📃
Pavão is licensed under the GPLv3 license.
You can read the entire license [HERE](LICENSE)