Skip to content

open-source-cooperative/dbus-secret-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dbus-secret-service

build dependencies crates.io docs.rs

This crate started as a knock-off of the secret-service crate, which uses zbus to access the secret service. The basic collection, item and search APIs in this crate are meant to work the same as the blocking APIs in the zbus-based crate. If they don't, please file a bug.

Why do a knock-off? So that folks who write synchronous Rust apps that access the secret service (for example, Keyring clients) are not required to add an async runtime. Because this knock-off uses lib-dbus, it doesn't require an async runtime.

Usage

For code usage examples, see the documentation and the example program.

This crate has no default features, and requires no features to run. If you want your secrets to be encrypted on their way to and from the secret service (highly recommended), then add one of the crypto features:

  • crypto-rust uses pure Rust crates for encryption.
  • crypto-openssl uses the openssl libraries for encryption (which must be installed).

See the documentation for details on how to connect to the Secret Service with an encrypted session.

To build a project that uses this crate, your development machine will need to have the dbus development headers installed, and the openssl development headers for the crypto-openssl feature. To run an application that uses this crate, your machine will need to have libdbus installed (almost all do), and the openssl libraries for the crypto-openssl feature. If you want to avoid this runtime requirement on clients, you can specify the vendored feature at build time: this will build and statically link the needed libraries with your executable.

Functionality

  • SecretService: initialize dbus, create plain or encrypted session connection.
  • Collections: create, delete, search.
  • Items: create, delete, search, get/set secret.

Change History

See CHANGELOG.md.

License

The copyright to all material in this repository belongs to the collective of contributors who have checked material into this repository.

All material is this repository is licensed under either of

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.

About

Synchronous dbus-based API clone of zbus-based crate secret-service

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Packages

No packages published

Contributors 19

Languages