Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hwchen/secret-service-rs
Rust library for interfacing with Secret Service API
https://github.com/hwchen/secret-service-rs
Last synced: about 2 months ago
JSON representation
Rust library for interfacing with Secret Service API
- Host: GitHub
- URL: https://github.com/hwchen/secret-service-rs
- Owner: hwchen
- License: apache-2.0
- Created: 2016-01-19T03:19:17.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-21T02:11:25.000Z (7 months ago)
- Last Synced: 2024-07-18T09:59:10.103Z (6 months ago)
- Language: Rust
- Size: 2.68 MB
- Stars: 71
- Watchers: 6
- Forks: 28
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Secret Service
[](https://crates.io/crates/secret-service)
[](https://docs.rs/secret-service)
[](https://crates.io/crates/secret-service)
A rust library for interacting with the FreeDesktop Secret Service API through DBus.
### Basic Usage
`secret-service` is implemented in pure Rust by default, so it doesn't require any system libraries
such as `libdbus-1-dev` or `libdbus-1-3` on Ubuntu.
In Cargo.toml:
When adding the crate, you must select a feature representing your selected runtime and cryptography backend.
For example:
```toml
[dependencies]
secret-service = { version = "4.0.0", features = ["rt-tokio-crypto-rust"] }
```
Available feature flags:
- `rt-async-io-crypto-rust`: Uses the `async-std` runtime and pure Rust crytography via `RustCrypto`.
- `rt-async-io-crypto-openssl`: Uses the `async-std` runtime and OpenSSL as the cryptography provider.
- `rt-tokio-crypto-rust`: Uses the `tokio` runtime and pure Rust cryptography via `RustCrypto`.
- `rt-tokio-crypto-openssl`: Uses the `tokio` runtime and OpenSSL as the cryptography provider.
Note that the `-openssl` feature sets require OpenSSL to be available on your system, or the `bundled` feature
of `openssl` crate must be activated in your `cargo` dependency tree instead.
In source code (below example is for `--bin`, not `--lib`). This example uses `tokio` as
the async runtime.
```rust
use secret_service::SecretService;
use secret_service::EncryptionType;
use std::{collections::HashMap, error::Error};
#[tokio::main]
async fn main() -> Result<(), Box> {
// initialize secret service (dbus connection and encryption session)
let ss = SecretService::connect(EncryptionType::Dh).await?;
// get default collection
let collection = ss.get_default_collection().await?;
// create new item
collection.create_item(
"test_label", // label
HashMap::from([("test", "test_value")]), // properties
b"test_secret", // secret
false, // replace item with same attributes
"text/plain" // secret content type
).await?;
// search items by properties
let search_items = ss.search_items(
HashMap::from([("test", "test_value")])
).await?;
let item = search_items.unlocked.first().ok_or("Not found!")?;
// retrieve secret from item
let secret = item.get_secret().await?;
assert_eq!(secret, b"test_secret");
// delete item (deletes the dbus object, not the struct instance)
item.delete().await?;
Ok(())
}
```
### Functionality
- SecretService: initialize dbus, create plain/encrypted session.
- Collections: create, delete, search.
- Items: create, delete, search, get/set secret.
### Changelog
See [the list of GitHub releases and their release notes](https://github.com/hwchen/secret-service-rs/releases)
### Versioning
This library is feature complete, has stabilized its API for the most part. However, as this
crate is almost soley reliable on the `zbus` crate, we try and match major version releases
with theirs to handle breaking changes and move with the wider `zbus` ecosystem.
## 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.