This crate provides a simple CLI for the Rust keyring ecosystem. It also provides sample Rust code for developers who are looking to use the keyring infrastructure in their projects and an inventory of available credential store modules.
This crate has a long history. It was first written by Walther Chen as an "API library plus credential store" combination. Currently maintained by Dan Brotsky, it is now just a "sample code" crate, with the library/API parts now part of the keyring-core crate and the credential stores all in separate crates of their own. The Contributors file lists the many, many people who have contributed to all generations of this crate.
If you are writing an application that uses keyring-compatible credential stores, you should not take a depedency on this crate!! You should instead be relying on the keyring-core crate.
If you have an existing application that relies on v3.x of this crate, do not update it to use v4 of this crate! Instead replace your dependency on this crate with a dependency on the keyring-core crate. The docs for that crate explain the changes you will need to make in your application.
The keyring binary produced by building this crate is a command-line interface for issuing one keyring call at a time and examining its results. Issue the command
keyring --helpfor usage information.
The CLI provided by this crate is neither efficient nor convenient for scripting, because each invocation loads a credential store, issues just one command against it, and then outputs the results in a format that is hard to parse. If you are looking to do scripting of keyring commands, you are better off using the Python wrapper for this crate available on PyPI in the rust-native-keyring project. Use the shell command
pip install rust-native-keyringto install it and
import rust_native_keyringto load it into your Python REPL. The sources for this Python module are built using PyO3 and can be found in this repository.
There is a Tauri 2.0 cross-platform GUI for Keyring in this repository. This GUI allows you to poke around in any of the keyring-compatible credential stores available on your platform. This GUI is currently in public beta testing on iOS, macOS, and Android (instructions here for iOS/macOS and here for Android), and it’s available for MacOS (not sandboxed), Linux, and Windows on CrabNebula.
If you are a credential store module developer, you are strongly encouraged to contribute a connector for your module to the library in this crate, thus making it available to users (in the test apps) and application developers (via sample code). See the module documentation for details.
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
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.