Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmgilman/vaultrs
An asynchronous Rust client library for the Hashicorp Vault API
https://github.com/jmgilman/vaultrs
client hashicorp http rust vault
Last synced: about 20 hours ago
JSON representation
An asynchronous Rust client library for the Hashicorp Vault API
- Host: GitHub
- URL: https://github.com/jmgilman/vaultrs
- Owner: jmgilman
- License: mit
- Created: 2021-08-10T03:56:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T09:05:22.000Z (18 days ago)
- Last Synced: 2025-01-19T06:01:58.242Z (8 days ago)
- Topics: client, hashicorp, http, rust, vault
- Language: Rust
- Homepage: https://docs.rs/vaultrs
- Size: 584 KB
- Stars: 102
- Watchers: 6
- Forks: 66
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# vaultrs
> An asynchronous Rust client library for the [Hashicorp Vault][1] API
The following features are currently supported:
- Auth
- [AppRole](https://developer.hashicorp.com/vault/docs/auth/approle)
- [AWS](https://developer.hashicorp.com/vault/docs/auth/aws)
- [JWT/OIDC](https://developer.hashicorp.com/vault/api-docs/auth/jwt)
- [Kubernetes](https://developer.hashicorp.com/vault/docs/auth/kubernetes)
- [Token](https://developer.hashicorp.com/vault/docs/auth/token)
- [Certificate](https://developer.hashicorp.com/vault/docs/auth/cert)
- [Userpass](https://developer.hashicorp.com/vault/docs/auth/userpass)
- Secrets
- [AWS](https://developer.hashicorp.com/vault/docs/secrets/aws)
- [Databases](https://developer.hashicorp.com/vault/api-docs/secret/databases)
- [KV v1](https://developer.hashicorp.com/vault/docs/secrets/kv/kv-v1)
- [KV v2](https://developer.hashicorp.com/vault/docs/secrets/kv/kv-v2)
- [PKI](https://developer.hashicorp.com/vault/docs/secrets/pki)
- [SSH](https://developer.hashicorp.com/vault/docs/secrets/ssh)
- [Transit](https://developer.hashicorp.com/vault/api-docs/secret/transit)
- Sys
- [Health](https://developer.hashicorp.com/vault/api-docs/system/health)
- [Policies](https://developer.hashicorp.com/vault/api-docs/system/policy)
- [Sealing](https://developer.hashicorp.com/vault/api-docs/system/seal)
- [Wrapping](https://developer.hashicorp.com/vault/docs/concepts/response-wrapping)
See something missing?
[Open an issue](https://github.com/jmgilman/vaultrs/issues/new).
## Installation
First, choose one of the two TLS implementations for `vaultrs`' connection to
Vault:
- `rustls` (default) to use [Rustls](https://github.com/rustls/rustls)
- `native-tls` to use
[rust-native-tls](https://github.com/sfackler/rust-native-tls), which builds
on your platform-specific TLS implementation.
Then, add `vaultrs` as a dependency to your cargo.toml:
1. To use [Rustls](https://github.com/rustls/rustls), import as follows:
```toml
[dependencies]
vaultrs = "0.7.3"
```
2. To use [rust-native-tls](https://github.com/sfackler/rust-native-tls), which
builds on your platform-specific TLS implementation, specify:
```toml
[dependencies]
vaultrs = { version = "0.7.3", default-features = false, features = [ "native-tls" ] }
```
## Usage
### Setup the client
The client is used to configure the connection to Vault and is required to be
passed to all API calls for execution. Behind the scenes it uses an asynchronous
client from [Reqwest](https://docs.rs/reqwest/) for communicating to Vault.
```rust
use vaultrs::client::{VaultClient, VaultClientSettingsBuilder};
// Create a client
let client = VaultClient::new(
VaultClientSettingsBuilder::default()
.address("https://127.0.0.1:8200")
.token("TOKEN")
.build()
.unwrap()
).unwrap();
```
For more usages, take a look at [the documentation][6]
## Error Handling and Tracing
All errors generated by this crate are wrapped in the `ClientError` enum
provided by the crate. API warnings are automatically captured via `tracing` and
API errors are captured and returned as their own variant. Connection related
errors from `rustify` are wrapped and returned as a single variant.
All top level API operations are instrumented with `tracing`'s `#[instrument]`
attribute.
## Testing
See the the [tests][3] directory for tests. Run tests with `cargo test`.
**Note**: All tests rely on bringing up a local Vault development server using
Docker. In order to run tests Docker must be running locally (Docker Desktop
works). The first run will be longer than other because it will fetch images.
Some long-running tests are ignored by default locally. To run them do:
```sh
cargo test -- --include-ignored
```
## Contributing
Check out the [issues][2] for items needing attention or submit your own and
then:
1. Fork the repo ()
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request
See [CONTRIBUTING][5] for extensive documentation on the
architecture of this library and how to add additional functionality to it.
[1]: https://developer.hashicorp.com/vault/
[2]: https://github.com/jmgilman/vaultrs/issues
[3]: https://github.com/jmgilman/vaultrs/tree/master/vaultrs-tests/tests/api_tests
[5]: https://github.com/jmgilman/vaultrs/tree/master/CONTRIBUTING.md
[6]: https://docs.rs/vaultrs