config-vault 0.2.0

An extension for the config crate that allows loading configurations from HashiCorp Vault
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

# config-vault

[![Crates.io](https://img.shields.io/crates/v/config-vault.svg)](https://crates.io/crates/config-vault)
[![Documentation](https://docs.rs/config-vault/badge.svg)](https://docs.rs/config-vault)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

An extension for the `config` crate that allows loading configurations from HashiCorp Vault.

## Features

- Integration with the `config` crate through a custom `VaultSource`
- Support for HashiCorp Vault's KV1 & KV2 engine
- Secure loading of secrets through Vault's REST API

## Installation

Add the dependency to your `Cargo.toml`:

```toml
[dependencies]
config-vault = "0.1.0"
config = "0.15.11" # The version compatible with config-vault
```

## Basic Usage

```rust
use config::{Config, ConfigError};
use config_vault::VaultSource;

fn load_config() -> Result<Config, ConfigError> {
    let vault_source = VaultSource::new(
        "http://127.0.0.1:8200".to_string(),  // Vault address
        "hvs.EXAMPLE_TOKEN".to_string(),      // Vault token
        "secret".to_string(),                 // KV mount name
        "dev".to_string(),        // Secret path
    );

    vault_source.set_kv_version(KvVersion::V1); // change kv_version to KV1 if required

    // Build configuration incorporating Vault and other sources
    Config::builder()
        .add_source(vault_source)
        // You can add other configuration sources
        // .add_source(config::File::with_name("config/default"))
        // .add_source(config::Environment::with_prefix("APP"))
        .build()
}

fn main() -> Result<(), ConfigError> {
    let config = load_config()?;
    
    // Use the configuration as usual
    let db_url = config.get_string("database.url")?;
    println!("Database URL: {}", db_url);
    
    Ok(())
}
```

## Documentation

For more information, check the [complete documentation](https://docs.rs/config-vault).

## Requirements

- Rust 1.60 or higher
- An accessible HashiCorp Vault server or compatible like [RustyVault](https://github.com/Tongsuo-Project/RustyVault)

## License

This project is licensed under the MIT License - see the LICENSE file for details.