# Keyweave

[<img alt="github" src="https://img.shields.io/badge/github-bartvdbraak/keyweave-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/bartvdbraak/keyweave)
[<img alt="crates.io" src="https://img.shields.io/crates/v/keyweave.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/keyweave)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-keyweave-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/keyweave)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/bartvdbraak/keyweave/checks.yml?style=for-the-badge&branch=main" height="20">](https://github.com/bartvdbraak/keyweave/actions/workflows/checks.yml)
[<img alt="test status" src="https://img.shields.io/github/actions/workflow/status/bartvdbraak/keyweave/tests.yml?style=for-the-badge&label=tests&branch=main" height="20">](https://github.com/bartvdbraak/keyweave/actions/workflows/tests.yml)

<img align="right" src="https://github.com/bartvdbraak/keyweave/assets/3996360/5461f53a-5cef-4bde-908a-b8d3bc1c71c5" alt="Keyweave" width="30%">

Keyweave is an open-source tool crafted to seamlessly fetch secrets from Azure Key Vault and weave them into a convenient `.env` file. Developed in Rust, Keyweave stands out for its efficiency and user-friendly design, making it an ideal choice for managing your application's secrets.

## Features

- **Fetch Secrets**: Retrieve secrets securely from Azure Key Vault.
- **Filtering**: Optionally filter the secrets to be retrieved by name.
- **Output Customization**: Choose the name of the output file, defaulting to `.env`.
- **Azure Default Credentials**: Utilizes Azure default credentials for authentication.

## Prerequisites

Before diving into Keyweave, ensure you have the following prerequisites:

- Logged into the right Azure tenant:

  ```bash
  az login --tenant "your-tenant-guid"
  ```

- The identity you logged in with has `Get` and `List` Secret Permissions in the Access Policies of the Key Vault.

## Installation 

### Cargo

Keyweave is built with [Cargo](https://doc.rust-lang.org/cargo/), the Rust package manager. It can also be used to install from [crates.io](https://crates.io/crates/keyweave):

```bash
cargo install keyweave
```

### Homebrew (MacOS, Linux)

For MacOS and Linux systems, installation is a breeze with [Homebrew](https://brew.sh/). Simply run:

```bash
brew tap bartvdbraak/keyweave
brew install keyweave
```

### Manual Download

If you prefer manual installation or need binaries for different platforms (including an executable for Windows), visit the [Releases](/releases) page of this GitHub repository.

```powershell
Invoke-WebRequest -Uri 'https://github.com/bartvdbraak/keyweave/releases/latest/download/keyweave.exe' -OutFile 'keyweave.exe'
```

## Building from Source

To build Keyweave from source, follow these steps:

```sh
git clone https://github.com/bartvdbraak/keyweave.git
cd keyweave
cargo build --release
```

Once built, run Keyweave using Cargo:

```sh
cargo run -- --vault-name <VAULT_NAME> [--output <FILE>] [--filter <FILTER>]
```

## Usage

With the binary on your `PATH`, run Keyweave as follows:

```sh
keyweave --vault-name <VAULT_NAME> [--output <FILE>] [--filter <FILTER>]
```

- `--vault-name <VAULT_NAME>`: Sets the name of the Azure Key Vault.
- `--output <FILE>`: (Optional) Sets the name of the output file (default: `.env`).
- `--filter <FILTER>`: (Optional) Filters the secrets to be retrieved by name.

### Example

```sh
keyweave --vault-name my-key-vault --output my-env-file.env --filter my-secret
```

## Documentation

Additional documentation for this package can be found on [docs.rs](https://docs.rs/keyweave).

## License

Keyweave is licensed under the GPLv3 License. See [LICENSE](LICENSE) for more details.

## Contributing

We welcome contributions! Feel free to submit pull requests, report issues, or suggest new features. Your input helps make Keyweave even better.