Compare commits
30 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f0fc829a73 | ||
|
|
ba0f108aa8 | ||
| 6daa6fd2f2 | |||
| 5fa4dbfe89 | |||
| bdcd496046 | |||
|
|
e37b80a262 | ||
| 3ce62c272e | |||
| 21b771507c | |||
| 508c8b7feb | |||
|
|
33a889fa67 | ||
|
|
7ddb7812fc | ||
| 9e11648a7c | |||
|
|
ed79af2a8a | ||
|
|
443fbcf305 | ||
| 78d7e90e68 | |||
| 01d4819160 | |||
|
|
e200a32f5a | ||
| 008b33b044 | |||
|
|
f35afac20f | ||
| 262a3d6435 | |||
| eb9e671818 | |||
| efc8af2c93 | |||
| 3d38ac9b51 | |||
|
|
8d40c3773f | ||
|
|
16ce245218 | ||
| a64f4dbf79 | |||
| 1b83d9b199 | |||
| f006503736 | |||
| 9abd2f88cf | |||
| 29acad5eed |
+30
-1
@@ -5,7 +5,36 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
## [0.0.1] - 2025-09-10
|
## v0.2.3 (2025-10-14)
|
||||||
|
|
||||||
|
### Refactor
|
||||||
|
|
||||||
|
- Refactored the library for gman so that it dynamically names config and password files to be used across any application
|
||||||
|
|
||||||
|
## v0.2.2 (2025-09-30)
|
||||||
|
|
||||||
|
### Refactor
|
||||||
|
|
||||||
|
- Environment variable interpolation in config file works globally, not based on type
|
||||||
|
|
||||||
|
## v0.2.1 (2025-09-30)
|
||||||
|
|
||||||
|
### Feat
|
||||||
|
|
||||||
|
- Environment variable interpolation in the Gman configuration file
|
||||||
|
|
||||||
|
### Fix
|
||||||
|
|
||||||
|
- Corrected tab completions for the provider flag
|
||||||
|
|
||||||
|
## v0.2.0 (2025-09-30)
|
||||||
|
|
||||||
|
### Feat
|
||||||
|
|
||||||
|
- gopass support
|
||||||
|
- Added command aliases to make the CLI more universal
|
||||||
|
- Added dynamic tab completions for the profile, providers, and the secrets in any given secret manager
|
||||||
|
- Users can now specify a default provider to use with each run config, so they don't need to explicitly specify which to use when wanting to run different applications.
|
||||||
|
|
||||||
## v0.1.0 (2025-09-17)
|
## v0.1.0 (2025-09-17)
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -60,7 +60,7 @@ representative at an online or offline event.
|
|||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
reported to the community leaders responsible for enforcement at
|
reported to the community leaders responsible for enforcement at
|
||||||
d4udts@gmail.com.
|
alex.j.tusa@gmail.com.
|
||||||
All complaints will be reviewed and investigated promptly and fairly.
|
All complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
All community leaders are obligated to respect the privacy and security of the
|
All community leaders are obligated to respect the privacy and security of the
|
||||||
|
|||||||
Generated
+423
-322
File diff suppressed because it is too large
Load Diff
+12
-4
@@ -1,10 +1,16 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "gman"
|
name = "gman"
|
||||||
version = "0.1.0"
|
version = "0.2.3"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
authors = ["Alex Clarke <alex.j.tusa@gmail.com>"]
|
authors = ["Alex Clarke <alex.j.tusa@gmail.com>"]
|
||||||
description = "Universal command line secret management and injection tool"
|
description = "Universal command line secret management and injection tool"
|
||||||
keywords = ["cli", "secrets-manager", "secret-injection", "command-runner", "vault"]
|
keywords = [
|
||||||
|
"cli",
|
||||||
|
"secrets-manager",
|
||||||
|
"secret-injection",
|
||||||
|
"command-runner",
|
||||||
|
"vault",
|
||||||
|
]
|
||||||
documentation = "https://github.com/Dark-Alex-17/gman"
|
documentation = "https://github.com/Dark-Alex-17/gman"
|
||||||
repository = "https://github.com/Dark-Alex-17/gman"
|
repository = "https://github.com/Dark-Alex-17/gman"
|
||||||
homepage = "https://github.com/Dark-Alex-17/gman"
|
homepage = "https://github.com/Dark-Alex-17/gman"
|
||||||
@@ -25,7 +31,7 @@ clap = { version = "4.5.47", features = [
|
|||||||
"env",
|
"env",
|
||||||
"wrap_help",
|
"wrap_help",
|
||||||
] }
|
] }
|
||||||
clap_complete = "4.5.57"
|
clap_complete = { version = "4.5.57", features = ["unstable-dynamic"] }
|
||||||
confy = { version = "1.0.0", default-features = false, features = [
|
confy = { version = "1.0.0", default-features = false, features = [
|
||||||
"yaml_conf",
|
"yaml_conf",
|
||||||
] }
|
] }
|
||||||
@@ -59,6 +65,8 @@ crc32c = "0.6.8"
|
|||||||
azure_identity = "0.27.0"
|
azure_identity = "0.27.0"
|
||||||
azure_security_keyvault_secrets = "0.6.0"
|
azure_security_keyvault_secrets = "0.6.0"
|
||||||
aws-lc-sys = { version = "0.31.0", features = ["bindgen"] }
|
aws-lc-sys = { version = "0.31.0", features = ["bindgen"] }
|
||||||
|
which = "8.0.0"
|
||||||
|
once_cell = "1.21.3"
|
||||||
|
|
||||||
[target.'cfg(all(target_os="linux", target_env="musl"))'.dependencies]
|
[target.'cfg(all(target_os="linux", target_env="musl"))'.dependencies]
|
||||||
openssl = { version = "0.10", features = ["vendored"] }
|
openssl = { version = "0.10", features = ["vendored"] }
|
||||||
@@ -71,7 +79,7 @@ pretty_assertions = "1.4.1"
|
|||||||
proptest = "1.5.0"
|
proptest = "1.5.0"
|
||||||
assert_cmd = "2.0.16"
|
assert_cmd = "2.0.16"
|
||||||
predicates = "3.1.2"
|
predicates = "3.1.2"
|
||||||
|
serial_test = "3.2.0"
|
||||||
|
|
||||||
[[bin]]
|
[[bin]]
|
||||||
bench = false
|
bench = false
|
||||||
|
|||||||
@@ -89,12 +89,15 @@ gman aws sts get-caller-identity
|
|||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
|
- [Environment Variable Interpolation](#environment-variable-interpolation)
|
||||||
- [Providers](#providers)
|
- [Providers](#providers)
|
||||||
- [Local](#provider-local)
|
- [Local](#provider-local)
|
||||||
- [AWS Secrets Manager](#provider-aws_secrets_manager)
|
- [AWS Secrets Manager](#provider-aws_secrets_manager)
|
||||||
- [GCP Secret Manager](#provider-gcp_secret_manager)
|
- [GCP Secret Manager](#provider-gcp_secret_manager)
|
||||||
- [Azure Key Vault](#provider-azure_key_vault)
|
- [Azure Key Vault](#provider-azure_key_vault)
|
||||||
|
- [Gopass](#provider-gopass)
|
||||||
- [Run Configurations](#run-configurations)
|
- [Run Configurations](#run-configurations)
|
||||||
|
- [Specifying a Default Provider per Run Config](#specifying-a-default-provider-per-run-config)
|
||||||
- [Environment Variable Secret Injection](#environment-variable-secret-injection)
|
- [Environment Variable Secret Injection](#environment-variable-secret-injection)
|
||||||
- [Inject Secrets via Command-Line Flags](#inject-secrets-via-command-line-flags)
|
- [Inject Secrets via Command-Line Flags](#inject-secrets-via-command-line-flags)
|
||||||
- [Inject Secrets into Files](#inject-secrets-into-files)
|
- [Inject Secrets into Files](#inject-secrets-into-files)
|
||||||
@@ -174,6 +177,22 @@ To use a binary from the releases page on Linux/MacOS, do the following:
|
|||||||
3. Extract the binary with `tar -C /usr/local/bin -xzf gman-<arch>.tar.gz` (Note: This may require `sudo`)
|
3. Extract the binary with `tar -C /usr/local/bin -xzf gman-<arch>.tar.gz` (Note: This may require `sudo`)
|
||||||
4. Now you can run `gman`!
|
4. Now you can run `gman`!
|
||||||
|
|
||||||
|
### Enable Tab Completion
|
||||||
|
`gman` supports shell tab completion for `bash`, `zsh`, and `fish`. To enable it, run the following command for your
|
||||||
|
shell:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# Bash
|
||||||
|
echo 'source <(COMPLETE=bash gman)' >> ~/.bashrc
|
||||||
|
# Zsh
|
||||||
|
echo 'source <(COMPLETE=zsh gman)' >> ~/.zshrc
|
||||||
|
# Fish
|
||||||
|
echo 'COMPLETE=fish gman | source' >> ~/.config/fish/config.fish
|
||||||
|
```
|
||||||
|
|
||||||
|
Then restart your shell or `source` the appropriate config file.
|
||||||
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
`gman` reads a YAML configuration file located at an OS-specific path:
|
`gman` reads a YAML configuration file located at an OS-specific path:
|
||||||
@@ -224,6 +243,28 @@ providers:
|
|||||||
run_configs: []
|
run_configs: []
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Environment Variable Interpolation
|
||||||
|
The config file supports environment variable interpolation using `${VAR_NAME}` syntax. For example, to use an
|
||||||
|
AWS profile from your environment:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
providers:
|
||||||
|
- name: aws
|
||||||
|
type: aws_secrets_manager
|
||||||
|
aws_profile: ${AWS_PROFILE} # Uses the AWS_PROFILE env var
|
||||||
|
aws_region: us-east-1
|
||||||
|
```
|
||||||
|
|
||||||
|
Or to set a default profile to use when `AWS_PROFILE` is unset:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
providers:
|
||||||
|
- name: aws
|
||||||
|
type: aws_secrets_manager
|
||||||
|
aws_profile: ${AWS_PROFILE:-default} # Uses 'default' if AWS_PROFILE is unset
|
||||||
|
aws_region: us-east-1
|
||||||
|
```
|
||||||
|
|
||||||
## Providers
|
## Providers
|
||||||
`gman` supports multiple providers for secret storage. The default provider is `local`, which stores secrets in an
|
`gman` supports multiple providers for secret storage. The default provider is `local`, which stores secrets in an
|
||||||
encrypted file on your filesystem. The CLI and config format are designed to be extensible so new providers can be
|
encrypted file on your filesystem. The CLI and config format are designed to be extensible so new providers can be
|
||||||
@@ -245,6 +286,7 @@ documented and added without breaking existing setups. The following table shows
|
|||||||
| [`hashicorp_vault`](https://www.hashicorp.com/en/products/vault) | 🕒 | | |
|
| [`hashicorp_vault`](https://www.hashicorp.com/en/products/vault) | 🕒 | | |
|
||||||
| [`azure_key_vault`](https://azure.microsoft.com/en-us/products/key-vault/) | ✅ | [Azure Key Vault](#provider-azure_key_vault) | |
|
| [`azure_key_vault`](https://azure.microsoft.com/en-us/products/key-vault/) | ✅ | [Azure Key Vault](#provider-azure_key_vault) | |
|
||||||
| [`gcp_secret_manager`](https://cloud.google.com/security/products/secret-manager?hl=en) | ✅ | [GCP Secret Manager](#provider-gcp_secret_manager) | |
|
| [`gcp_secret_manager`](https://cloud.google.com/security/products/secret-manager?hl=en) | ✅ | [GCP Secret Manager](#provider-gcp_secret_manager) | |
|
||||||
|
| [`gopass`](https://www.gopass.pw/) | ✅ | | |
|
||||||
| [`1password`](https://1password.com/) | 🕒 | | |
|
| [`1password`](https://1password.com/) | 🕒 | | |
|
||||||
| [`bitwarden`](https://bitwarden.com/) | 🕒 | | |
|
| [`bitwarden`](https://bitwarden.com/) | 🕒 | | |
|
||||||
| [`dashlane`](https://www.dashlane.com/) | 🕒 | | Waiting for CLI support for adding secrets |
|
| [`dashlane`](https://www.dashlane.com/) | 🕒 | | Waiting for CLI support for adding secrets |
|
||||||
@@ -388,6 +430,26 @@ Important notes:
|
|||||||
- Ensure your identity has the necessary Key Vault permissions (RBAC such as `Key Vault Secrets User`/`Administrator`,
|
- Ensure your identity has the necessary Key Vault permissions (RBAC such as `Key Vault Secrets User`/`Administrator`,
|
||||||
or appropriate access policies) for get/set/list/delete.
|
or appropriate access policies) for get/set/list/delete.
|
||||||
|
|
||||||
|
### Provider: `gopass`
|
||||||
|
The `gopass` provider uses [gopass](https://www.gopass.pw/) as the backing storage location for secrets.
|
||||||
|
|
||||||
|
- Optional: `store` (string) to specify a particular gopass store if you have multiple.
|
||||||
|
|
||||||
|
Configuration example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
default_provider: gopass
|
||||||
|
providers:
|
||||||
|
- name: gopass
|
||||||
|
type: gopass
|
||||||
|
store: my-store # Optional; if omitted, uses the default configured gopass store
|
||||||
|
```
|
||||||
|
|
||||||
|
Important notes:
|
||||||
|
- Ensure `gopass` is installed and initialized on your system.
|
||||||
|
- Secrets are managed using gopass's native commands; `gman` acts as a wrapper to interface with gopass.
|
||||||
|
- Updates overwrite existing secrets
|
||||||
|
- If no store is specified, the default gopass store is used and `gman sync` will sync with all configured stores.
|
||||||
## Run Configurations
|
## Run Configurations
|
||||||
|
|
||||||
Run configurations (or "profiles") tell `gman` how to inject secrets into a command. Three modes of secret injection are
|
Run configurations (or "profiles") tell `gman` how to inject secrets into a command. Three modes of secret injection are
|
||||||
@@ -404,6 +466,45 @@ will error out and report that it could not find the run config with that name.
|
|||||||
You can manually specify which run configuration to use with the `--profile` flag. Again, if no profile is found with
|
You can manually specify which run configuration to use with the `--profile` flag. Again, if no profile is found with
|
||||||
that name, `gman` will error out.
|
that name, `gman` will error out.
|
||||||
|
|
||||||
|
|
||||||
|
### Specifying a Default Provider per Run Config
|
||||||
|
All run configs also support the `provider` field, which lets you override the default provider for that specific
|
||||||
|
profile. This is useful if you have multiple providers configured and want to use a different one for a specific command
|
||||||
|
, but that provider may not be the `default_provider`, and you don't want to have to specify `--provider` on the command
|
||||||
|
line every time.
|
||||||
|
|
||||||
|
For Example:
|
||||||
|
```yaml
|
||||||
|
default_provider: local
|
||||||
|
run_configs:
|
||||||
|
# `gman aws ...` uses the `aws` provider instead of `local` if no
|
||||||
|
# `--provider` is given.
|
||||||
|
- name: aws
|
||||||
|
# Can be overridden by explicitly specifying a `--provider`
|
||||||
|
provider: aws
|
||||||
|
secrets:
|
||||||
|
- DB_USERNAME
|
||||||
|
- DB_PASSWORD
|
||||||
|
# `gman docker ...` uses the default_provider `local` because no
|
||||||
|
# `provider` is specified.
|
||||||
|
- name: docker
|
||||||
|
secrets:
|
||||||
|
- MY_APP_API_KEY
|
||||||
|
- MY_APP_DB_PASSWORD
|
||||||
|
# `gman managarr ...` uses the `local` provider; This is useful
|
||||||
|
# if you change the default provider to something else.
|
||||||
|
- name: managarr
|
||||||
|
provider: local
|
||||||
|
secrets:
|
||||||
|
- RADARR_API_KEY
|
||||||
|
- SONARR_API_KEY
|
||||||
|
files:
|
||||||
|
- /home/user/.config/managarr/config.yml
|
||||||
|
```
|
||||||
|
|
||||||
|
**Important Note:** Any run config with a `provider` field can be overridden by specifying `--provider` on the command
|
||||||
|
line.
|
||||||
|
|
||||||
### Environment Variable Secret Injection
|
### Environment Variable Secret Injection
|
||||||
|
|
||||||
By default, secrets are injected as environment variables. The two required fields are `name` and `secrets`.
|
By default, secrets are injected as environment variables. The two required fields are `name` and `secrets`.
|
||||||
|
|||||||
+205
-35
@@ -1,21 +1,22 @@
|
|||||||
use crate::command::preview_command;
|
use crate::command::preview_command;
|
||||||
use anyhow::{Context, Result, anyhow};
|
use anyhow::{Context, Result, anyhow};
|
||||||
|
use clap_complete::CompletionCandidate;
|
||||||
use futures::future::join_all;
|
use futures::future::join_all;
|
||||||
use gman::config::{Config, RunConfig};
|
use gman::config::{Config, RunConfig, load_config};
|
||||||
use gman::providers::SecretProvider;
|
|
||||||
use log::{debug, error};
|
use log::{debug, error};
|
||||||
use regex::Regex;
|
use regex::Regex;
|
||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
use std::ffi::OsString;
|
use std::ffi::{OsStr, OsString};
|
||||||
use std::fs;
|
use std::fs;
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
use std::process::Command;
|
use std::process::Command;
|
||||||
|
use tokio::runtime::Handle;
|
||||||
|
|
||||||
const ARG_FORMAT_PLACEHOLDER_KEY: &str = "{{key}}";
|
const ARG_FORMAT_PLACEHOLDER_KEY: &str = "{{key}}";
|
||||||
const ARG_FORMAT_PLACEHOLDER_VALUE: &str = "{{value}}";
|
const ARG_FORMAT_PLACEHOLDER_VALUE: &str = "{{value}}";
|
||||||
|
|
||||||
pub async fn wrap_and_run_command(
|
pub async fn wrap_and_run_command(
|
||||||
secrets_provider: &mut dyn SecretProvider,
|
provider: Option<String>,
|
||||||
config: &Config,
|
config: &Config,
|
||||||
tokens: Vec<OsString>,
|
tokens: Vec<OsString>,
|
||||||
profile_name: Option<String>,
|
profile_name: Option<String>,
|
||||||
@@ -36,6 +37,9 @@ pub async fn wrap_and_run_command(
|
|||||||
.find(|c| c.name.as_deref() == Some(run_config_profile_name))
|
.find(|c| c.name.as_deref() == Some(run_config_profile_name))
|
||||||
});
|
});
|
||||||
if let Some(run_cfg) = run_config_opt {
|
if let Some(run_cfg) = run_config_opt {
|
||||||
|
let mut provider_config =
|
||||||
|
config.extract_provider_config(provider.or(run_cfg.provider.clone()))?;
|
||||||
|
let secrets_provider = provider_config.extract_provider();
|
||||||
let secrets_result_futures = run_cfg
|
let secrets_result_futures = run_cfg
|
||||||
.secrets
|
.secrets
|
||||||
.as_ref()
|
.as_ref()
|
||||||
@@ -163,7 +167,7 @@ fn generate_files_secret_injections(
|
|||||||
secrets: HashMap<&str, String>,
|
secrets: HashMap<&str, String>,
|
||||||
run_config: &RunConfig,
|
run_config: &RunConfig,
|
||||||
) -> Result<Vec<(PathBuf, String, String)>> {
|
) -> Result<Vec<(PathBuf, String, String)>> {
|
||||||
let re = Regex::new(r"\{\{(.+)\}\}")?;
|
let re = Regex::new(r"\{\{(.+)}}")?;
|
||||||
let mut results = Vec::new();
|
let mut results = Vec::new();
|
||||||
for file in run_config
|
for file in run_config
|
||||||
.files
|
.files
|
||||||
@@ -251,34 +255,82 @@ pub fn parse_args(
|
|||||||
Ok(args)
|
Ok(args)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn run_config_completer(current: &OsStr) -> Vec<CompletionCandidate> {
|
||||||
|
let cur = current.to_string_lossy();
|
||||||
|
match load_config(true) {
|
||||||
|
Ok(config) => {
|
||||||
|
if let Some(run_configs) = config.run_configs {
|
||||||
|
run_configs
|
||||||
|
.iter()
|
||||||
|
.filter(|rc| {
|
||||||
|
rc.name
|
||||||
|
.as_ref()
|
||||||
|
.expect("run config has no name")
|
||||||
|
.starts_with(&*cur)
|
||||||
|
})
|
||||||
|
.map(|rc| {
|
||||||
|
CompletionCandidate::new(rc.name.as_ref().expect("run config has no name"))
|
||||||
|
})
|
||||||
|
.collect()
|
||||||
|
} else {
|
||||||
|
vec![]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(_) => vec![],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn provider_completer(current: &OsStr) -> Vec<CompletionCandidate> {
|
||||||
|
let cur = current.to_string_lossy();
|
||||||
|
match load_config(true) {
|
||||||
|
Ok(config) => config
|
||||||
|
.providers
|
||||||
|
.iter()
|
||||||
|
.filter(|pc| {
|
||||||
|
pc.name
|
||||||
|
.as_ref()
|
||||||
|
.expect("run config has no name")
|
||||||
|
.starts_with(&*cur)
|
||||||
|
})
|
||||||
|
.map(|pc| CompletionCandidate::new(pc.name.as_ref().expect("provider has no name")))
|
||||||
|
.collect(),
|
||||||
|
Err(_) => vec![],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn secrets_completer(current: &OsStr) -> Vec<CompletionCandidate> {
|
||||||
|
let cur = current.to_string_lossy();
|
||||||
|
match load_config(true) {
|
||||||
|
Ok(config) => {
|
||||||
|
let mut provider_config = match config.extract_provider_config(None) {
|
||||||
|
Ok(pc) => pc,
|
||||||
|
Err(_) => return vec![],
|
||||||
|
};
|
||||||
|
let secrets_provider = provider_config.extract_provider();
|
||||||
|
let h = Handle::current();
|
||||||
|
tokio::task::block_in_place(|| h.block_on(secrets_provider.list_secrets()))
|
||||||
|
.unwrap_or_default()
|
||||||
|
.into_iter()
|
||||||
|
.filter(|s| s.starts_with(&*cur))
|
||||||
|
.map(CompletionCandidate::new)
|
||||||
|
.collect()
|
||||||
|
}
|
||||||
|
Err(_) => vec![],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
use crate::cli::generate_files_secret_injections;
|
use crate::cli::generate_files_secret_injections;
|
||||||
|
use gman::config::get_config_file_path;
|
||||||
use gman::config::{Config, RunConfig};
|
use gman::config::{Config, RunConfig};
|
||||||
use pretty_assertions::{assert_eq, assert_str_eq};
|
use pretty_assertions::{assert_eq, assert_str_eq};
|
||||||
|
use serial_test::serial;
|
||||||
use std::collections::HashMap;
|
use std::collections::HashMap;
|
||||||
|
use std::env as std_env;
|
||||||
use std::ffi::OsString;
|
use std::ffi::OsString;
|
||||||
|
use tempfile::tempdir;
|
||||||
struct DummyProvider;
|
|
||||||
#[async_trait::async_trait]
|
|
||||||
impl SecretProvider for DummyProvider {
|
|
||||||
fn name(&self) -> &'static str {
|
|
||||||
"Dummy"
|
|
||||||
}
|
|
||||||
async fn get_secret(&self, key: &str) -> Result<String> {
|
|
||||||
Ok(format!("{}_VAL", key))
|
|
||||||
}
|
|
||||||
async fn set_secret(&self, _key: &str, _value: &str) -> Result<()> {
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
async fn delete_secret(&self, _key: &str) -> Result<()> {
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
async fn sync(&mut self) -> Result<()> {
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_generate_files_secret_injections() {
|
fn test_generate_files_secret_injections() {
|
||||||
@@ -290,6 +342,7 @@ mod tests {
|
|||||||
|
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["testing/SOME-secret".to_string()]),
|
secrets: Some(vec!["testing/SOME-secret".to_string()]),
|
||||||
files: Some(vec![file_path.clone()]),
|
files: Some(vec![file_path.clone()]),
|
||||||
flag: None,
|
flag: None,
|
||||||
@@ -309,6 +362,7 @@ mod tests {
|
|||||||
fn test_parse_args_insert_and_append() {
|
fn test_parse_args_insert_and_append() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("docker".into()),
|
name: Some("docker".into()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["api_key".into()]),
|
secrets: Some(vec!["api_key".into()]),
|
||||||
files: None,
|
files: None,
|
||||||
flag: Some("-e".into()),
|
flag: Some("-e".into()),
|
||||||
@@ -347,10 +401,8 @@ mod tests {
|
|||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn test_wrap_and_run_command_no_profile() {
|
async fn test_wrap_and_run_command_no_profile() {
|
||||||
let cfg = Config::default();
|
let cfg = Config::default();
|
||||||
let mut dummy = DummyProvider;
|
|
||||||
let prov: &mut dyn SecretProvider = &mut dummy;
|
|
||||||
let tokens = vec![OsString::from("echo"), OsString::from("hi")];
|
let tokens = vec![OsString::from("echo"), OsString::from("hi")];
|
||||||
let err = wrap_and_run_command(prov, &cfg, tokens, None, true)
|
let err = wrap_and_run_command(None, &cfg, tokens, None, true)
|
||||||
.await
|
.await
|
||||||
.unwrap_err();
|
.unwrap_err();
|
||||||
assert!(err.to_string().contains("No run profile found"));
|
assert!(err.to_string().contains("No run profile found"));
|
||||||
@@ -361,6 +413,7 @@ mod tests {
|
|||||||
// Create a config with a matching run profile for command "echo"
|
// Create a config with a matching run profile for command "echo"
|
||||||
let run_cfg = RunConfig {
|
let run_cfg = RunConfig {
|
||||||
name: Some("echo".into()),
|
name: Some("echo".into()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["api_key".into()]),
|
secrets: Some(vec!["api_key".into()]),
|
||||||
files: None,
|
files: None,
|
||||||
flag: None,
|
flag: None,
|
||||||
@@ -371,14 +424,131 @@ mod tests {
|
|||||||
run_configs: Some(vec![run_cfg]),
|
run_configs: Some(vec![run_cfg]),
|
||||||
..Config::default()
|
..Config::default()
|
||||||
};
|
};
|
||||||
let mut dummy = DummyProvider;
|
|
||||||
let prov: &mut dyn SecretProvider = &mut dummy;
|
|
||||||
|
|
||||||
// Capture stderr for dry_run preview
|
|
||||||
let tokens = vec![OsString::from("echo"), OsString::from("hello")];
|
let tokens = vec![OsString::from("echo"), OsString::from("hello")];
|
||||||
// Best-effort: ensure function does not error under dry_run
|
let err = wrap_and_run_command(None, &cfg, tokens, None, true)
|
||||||
let res = wrap_and_run_command(prov, &cfg, tokens, None, true).await;
|
.await
|
||||||
assert!(res.is_ok());
|
.expect_err("expected failed secret resolution in dry_run");
|
||||||
// Not asserting output text to keep test platform-agnostic
|
assert!(err.to_string().contains("Failed to fetch"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[serial]
|
||||||
|
fn test_run_config_completer_filters_by_prefix() {
|
||||||
|
let td = tempdir().unwrap();
|
||||||
|
let xdg = td.path().join("xdg");
|
||||||
|
unsafe { std_env::set_var("XDG_CONFIG_HOME", &xdg) };
|
||||||
|
let cfg_path = get_config_file_path().unwrap();
|
||||||
|
let app_dir = cfg_path.parent().unwrap().to_path_buf();
|
||||||
|
fs::create_dir_all(&app_dir).unwrap();
|
||||||
|
|
||||||
|
let yaml = indoc::indoc! {
|
||||||
|
"---
|
||||||
|
default_provider: local
|
||||||
|
providers:
|
||||||
|
- name: local
|
||||||
|
type: local
|
||||||
|
run_configs:
|
||||||
|
- name: echo
|
||||||
|
secrets: [API_KEY]
|
||||||
|
- name: docker
|
||||||
|
secrets: [DB_PASSWORD]
|
||||||
|
- name: aws
|
||||||
|
secrets: [AWS_ACCESS_KEY_ID]
|
||||||
|
"
|
||||||
|
};
|
||||||
|
fs::write(app_dir.join("config.yml"), yaml).unwrap();
|
||||||
|
|
||||||
|
let out = run_config_completer(OsStr::new("do"));
|
||||||
|
assert_eq!(out.len(), 1);
|
||||||
|
// Compare via debug string to avoid depending on crate internals
|
||||||
|
let rendered = format!("{:?}", &out[0]);
|
||||||
|
assert!(rendered.contains("docker"), "got: {}", rendered);
|
||||||
|
|
||||||
|
unsafe { std_env::remove_var("XDG_CONFIG_HOME") };
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[serial]
|
||||||
|
fn test_provider_completer_lists_matching_providers() {
|
||||||
|
let td = tempdir().unwrap();
|
||||||
|
let xdg = td.path().join("xdg");
|
||||||
|
unsafe { std_env::set_var("XDG_CONFIG_HOME", &xdg) };
|
||||||
|
let cfg_path = get_config_file_path().unwrap();
|
||||||
|
let app_dir = cfg_path.parent().unwrap().to_path_buf();
|
||||||
|
fs::create_dir_all(&app_dir).unwrap();
|
||||||
|
|
||||||
|
let yaml = indoc::indoc! {
|
||||||
|
"---
|
||||||
|
default_provider: local
|
||||||
|
providers:
|
||||||
|
- name: local
|
||||||
|
type: local
|
||||||
|
- name: prod
|
||||||
|
type: local
|
||||||
|
run_configs:
|
||||||
|
- name: echo
|
||||||
|
secrets: [API_KEY]
|
||||||
|
"
|
||||||
|
};
|
||||||
|
fs::write(app_dir.join("config.yml"), yaml).unwrap();
|
||||||
|
|
||||||
|
// Prefix 'p' should match only 'prod'
|
||||||
|
let out = provider_completer(OsStr::new("p"));
|
||||||
|
assert_eq!(out.len(), 1);
|
||||||
|
let rendered = format!("{:?}", &out[0]);
|
||||||
|
assert!(rendered.contains("prod"), "got: {}", rendered);
|
||||||
|
|
||||||
|
// Empty prefix returns at least both providers
|
||||||
|
let out_all = provider_completer(OsStr::new(""));
|
||||||
|
assert!(out_all.len() >= 2);
|
||||||
|
|
||||||
|
unsafe { std_env::remove_var("XDG_CONFIG_HOME") };
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test(flavor = "multi_thread")]
|
||||||
|
#[serial]
|
||||||
|
async fn test_secrets_completer_filters_keys_by_prefix() {
|
||||||
|
let td = tempdir().unwrap();
|
||||||
|
let xdg = td.path().join("xdg");
|
||||||
|
unsafe { std_env::set_var("XDG_CONFIG_HOME", &xdg) };
|
||||||
|
let cfg_path = get_config_file_path().unwrap();
|
||||||
|
let app_dir = cfg_path.parent().unwrap().to_path_buf();
|
||||||
|
fs::create_dir_all(&app_dir).unwrap();
|
||||||
|
|
||||||
|
let yaml = indoc::indoc! {
|
||||||
|
"---
|
||||||
|
default_provider: local
|
||||||
|
providers:
|
||||||
|
- name: local
|
||||||
|
type: local
|
||||||
|
run_configs:
|
||||||
|
- name: echo
|
||||||
|
secrets: [API_KEY]
|
||||||
|
"
|
||||||
|
};
|
||||||
|
fs::write(app_dir.join("config.yml"), yaml).unwrap();
|
||||||
|
|
||||||
|
// Seed a minimal vault with keys (values are irrelevant for listing)
|
||||||
|
let vault_yaml = indoc::indoc! {
|
||||||
|
"---
|
||||||
|
API_KEY: dummy
|
||||||
|
DB_PASSWORD: dummy
|
||||||
|
AWS_ACCESS_KEY_ID: dummy
|
||||||
|
"
|
||||||
|
};
|
||||||
|
fs::write(app_dir.join("vault.yml"), vault_yaml).unwrap();
|
||||||
|
|
||||||
|
let out = secrets_completer(OsStr::new("AWS"));
|
||||||
|
assert_eq!(out.len(), 1);
|
||||||
|
let rendered = format!("{:?}", &out[0]);
|
||||||
|
assert!(rendered.contains("AWS_ACCESS_KEY_ID"), "got: {}", rendered);
|
||||||
|
|
||||||
|
let out2 = secrets_completer(OsStr::new("DB_"));
|
||||||
|
assert_eq!(out2.len(), 1);
|
||||||
|
let rendered2 = format!("{:?}", &out2[0]);
|
||||||
|
assert!(rendered2.contains("DB_PASSWORD"), "got: {}", rendered2);
|
||||||
|
|
||||||
|
unsafe { std_env::remove_var("XDG_CONFIG_HOME") };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+18
-18
@@ -1,8 +1,12 @@
|
|||||||
|
use crate::cli::provider_completer;
|
||||||
|
use crate::cli::run_config_completer;
|
||||||
|
use crate::cli::secrets_completer;
|
||||||
use anyhow::{Context, Result};
|
use anyhow::{Context, Result};
|
||||||
use clap::Subcommand;
|
use clap::Subcommand;
|
||||||
use clap::{
|
use clap::{
|
||||||
CommandFactory, Parser, ValueEnum, crate_authors, crate_description, crate_name, crate_version,
|
CommandFactory, Parser, ValueEnum, crate_authors, crate_description, crate_name, crate_version,
|
||||||
};
|
};
|
||||||
|
use clap_complete::{ArgValueCompleter, CompleteEnv};
|
||||||
use crossterm::execute;
|
use crossterm::execute;
|
||||||
use crossterm::terminal::{LeaveAlternateScreen, disable_raw_mode};
|
use crossterm::terminal::{LeaveAlternateScreen, disable_raw_mode};
|
||||||
use gman::config::{Config, get_config_file_path, load_config};
|
use gman::config::{Config, get_config_file_path, load_config};
|
||||||
@@ -48,11 +52,11 @@ struct Cli {
|
|||||||
output: Option<OutputFormat>,
|
output: Option<OutputFormat>,
|
||||||
|
|
||||||
/// Specify the secret provider to use (defaults to 'default_provider' in config (usually 'local'))
|
/// Specify the secret provider to use (defaults to 'default_provider' in config (usually 'local'))
|
||||||
#[arg(long, value_enum, global = true, env = "GMAN_PROVIDER")]
|
#[arg(long, global = true, env = "GMAN_PROVIDER", add = ArgValueCompleter::new(provider_completer))]
|
||||||
provider: Option<String>,
|
provider: Option<String>,
|
||||||
|
|
||||||
/// Specify a run profile to use when wrapping a command
|
/// Specify a run profile to use when wrapping a command
|
||||||
#[arg(long, short)]
|
#[arg(long, short, add = ArgValueCompleter::new(run_config_completer))]
|
||||||
profile: Option<String>,
|
profile: Option<String>,
|
||||||
|
|
||||||
/// Output the command that will be run instead of executing it
|
/// Output the command that will be run instead of executing it
|
||||||
@@ -74,14 +78,17 @@ struct Cli {
|
|||||||
#[derive(Subcommand, Clone, Debug)]
|
#[derive(Subcommand, Clone, Debug)]
|
||||||
enum Commands {
|
enum Commands {
|
||||||
/// Add a secret to the configured secret provider
|
/// Add a secret to the configured secret provider
|
||||||
|
#[clap(aliases = &["set", "create"])]
|
||||||
Add {
|
Add {
|
||||||
/// Name of the secret to store
|
/// Name of the secret to store
|
||||||
name: String,
|
name: String,
|
||||||
},
|
},
|
||||||
|
|
||||||
/// Decrypt a secret and print the plaintext
|
/// Decrypt a secret and print the plaintext
|
||||||
|
#[clap(alias = "show")]
|
||||||
Get {
|
Get {
|
||||||
/// Name of the secret to retrieve
|
/// Name of the secret to retrieve
|
||||||
|
#[arg(add = ArgValueCompleter::new(secrets_completer))]
|
||||||
name: String,
|
name: String,
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -89,17 +96,21 @@ enum Commands {
|
|||||||
/// If a provider does not support updating secrets, this command will return an error.
|
/// If a provider does not support updating secrets, this command will return an error.
|
||||||
Update {
|
Update {
|
||||||
/// Name of the secret to update
|
/// Name of the secret to update
|
||||||
|
#[arg(add = ArgValueCompleter::new(secrets_completer))]
|
||||||
name: String,
|
name: String,
|
||||||
},
|
},
|
||||||
|
|
||||||
/// Delete a secret from the configured secret provider
|
/// Delete a secret from the configured secret provider
|
||||||
|
#[clap(aliases = &["remove", "rm"])]
|
||||||
Delete {
|
Delete {
|
||||||
/// Name of the secret to delete
|
/// Name of the secret to delete
|
||||||
|
#[arg(add = ArgValueCompleter::new(secrets_completer))]
|
||||||
name: String,
|
name: String,
|
||||||
},
|
},
|
||||||
|
|
||||||
/// List all secrets stored in the configured secret provider (if supported by the provider)
|
/// List all secrets stored in the configured secret provider (if supported by the provider)
|
||||||
/// If a provider does not support listing secrets, this command will return an error.
|
/// If a provider does not support listing secrets, this command will return an error.
|
||||||
|
#[clap(alias = "ls")]
|
||||||
List {},
|
List {},
|
||||||
|
|
||||||
/// Sync secrets with remote storage (if supported by the provider)
|
/// Sync secrets with remote storage (if supported by the provider)
|
||||||
@@ -112,13 +123,6 @@ enum Commands {
|
|||||||
/// configured in a corresponding run profile
|
/// configured in a corresponding run profile
|
||||||
#[command(external_subcommand)]
|
#[command(external_subcommand)]
|
||||||
External(Vec<OsString>),
|
External(Vec<OsString>),
|
||||||
|
|
||||||
/// Generate shell completion scripts
|
|
||||||
Completions {
|
|
||||||
/// The shell to generate the script for
|
|
||||||
#[arg(value_enum)]
|
|
||||||
shell: clap_complete::Shell,
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tokio::main]
|
#[tokio::main]
|
||||||
@@ -129,6 +133,7 @@ async fn main() -> Result<()> {
|
|||||||
panic::set_hook(Box::new(|info| {
|
panic::set_hook(Box::new(|info| {
|
||||||
panic_hook(info);
|
panic_hook(info);
|
||||||
}));
|
}));
|
||||||
|
CompleteEnv::with_factory(Cli::command).complete();
|
||||||
let cli = Cli::parse();
|
let cli = Cli::parse();
|
||||||
|
|
||||||
if cli.show_log_path {
|
if cli.show_log_path {
|
||||||
@@ -145,7 +150,7 @@ async fn main() -> Result<()> {
|
|||||||
exit(1);
|
exit(1);
|
||||||
}
|
}
|
||||||
|
|
||||||
let config = load_config()?;
|
let config = load_config(true)?;
|
||||||
let mut provider_config = config.extract_provider_config(cli.provider.clone())?;
|
let mut provider_config = config.extract_provider_config(cli.provider.clone())?;
|
||||||
let secrets_provider = provider_config.extract_provider();
|
let secrets_provider = provider_config.extract_provider();
|
||||||
|
|
||||||
@@ -226,7 +231,8 @@ async fn main() -> Result<()> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
Commands::Config {} => {
|
Commands::Config {} => {
|
||||||
let config_yaml = serde_yaml::to_string(&config)
|
let uninterpolated_config = load_config(false)?;
|
||||||
|
let config_yaml = serde_yaml::to_string(&uninterpolated_config)
|
||||||
.with_context(|| "failed to serialize existing configuration")?;
|
.with_context(|| "failed to serialize existing configuration")?;
|
||||||
let new_config = Editor::new()
|
let new_config = Editor::new()
|
||||||
.edit(&config_yaml)
|
.edit(&config_yaml)
|
||||||
@@ -253,13 +259,7 @@ async fn main() -> Result<()> {
|
|||||||
})?;
|
})?;
|
||||||
}
|
}
|
||||||
Commands::External(tokens) => {
|
Commands::External(tokens) => {
|
||||||
wrap_and_run_command(secrets_provider, &config, tokens, cli.profile, cli.dry_run)
|
wrap_and_run_command(cli.provider, &config, tokens, cli.profile, cli.dry_run).await?;
|
||||||
.await?;
|
|
||||||
}
|
|
||||||
Commands::Completions { shell } => {
|
|
||||||
let mut cmd = Cli::command();
|
|
||||||
let bin_name = cmd.get_name().to_string();
|
|
||||||
clap_complete::generate(shell, &mut cmd, bin_name, &mut io::stdout());
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ pub fn init_logging_config() -> log4rs::Config {
|
|||||||
|
|
||||||
pub fn get_log_path() -> PathBuf {
|
pub fn get_log_path() -> PathBuf {
|
||||||
let base_dir = dirs::cache_dir().unwrap_or_else(env::temp_dir);
|
let base_dir = dirs::cache_dir().unwrap_or_else(env::temp_dir);
|
||||||
let log_dir = base_dir.join("gman");
|
let log_dir = base_dir.join(env!("CARGO_CRATE_NAME"));
|
||||||
|
|
||||||
let dir = if let Err(e) = fs::create_dir_all(&log_dir) {
|
let dir = if let Err(e) = fs::create_dir_all(&log_dir) {
|
||||||
eprintln!(
|
eprintln!(
|
||||||
@@ -77,7 +77,7 @@ pub fn persist_config_file(config: &Config) -> Result<()> {
|
|||||||
fs::write(&config_path, s)
|
fs::write(&config_path, s)
|
||||||
.with_context(|| format!("failed to write {}", config_path.display()))?;
|
.with_context(|| format!("failed to write {}", config_path.display()))?;
|
||||||
} else {
|
} else {
|
||||||
confy::store("gman", "config", config)
|
confy::store(env!("CARGO_CRATE_NAME"), "config", config)
|
||||||
.with_context(|| "failed to save updated config via confy")?;
|
.with_context(|| "failed to save updated config via confy")?;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+132
-21
@@ -11,6 +11,7 @@
|
|||||||
//!
|
//!
|
||||||
//! let rc = RunConfig{
|
//! let rc = RunConfig{
|
||||||
//! name: Some("echo".into()),
|
//! name: Some("echo".into()),
|
||||||
|
//! provider: None,
|
||||||
//! secrets: Some(vec!["api_key".into()]),
|
//! secrets: Some(vec!["api_key".into()]),
|
||||||
//! files: None,
|
//! files: None,
|
||||||
//! flag: None,
|
//! flag: None,
|
||||||
@@ -20,11 +21,13 @@
|
|||||||
//! rc.validate().unwrap();
|
//! rc.validate().unwrap();
|
||||||
//! ```
|
//! ```
|
||||||
|
|
||||||
|
use crate::calling_app_name;
|
||||||
use crate::providers::local::LocalProvider;
|
use crate::providers::local::LocalProvider;
|
||||||
use crate::providers::{SecretProvider, SupportedProvider};
|
use crate::providers::{SecretProvider, SupportedProvider};
|
||||||
use anyhow::{Context, Result};
|
use anyhow::{Context, Result};
|
||||||
use collections::HashSet;
|
use collections::HashSet;
|
||||||
use log::debug;
|
use log::debug;
|
||||||
|
use regex::Regex;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use serde_with::serde_as;
|
use serde_with::serde_as;
|
||||||
use serde_with::skip_serializing_none;
|
use serde_with::skip_serializing_none;
|
||||||
@@ -45,6 +48,7 @@ use validator::{Validate, ValidationError};
|
|||||||
pub struct RunConfig {
|
pub struct RunConfig {
|
||||||
#[validate(required)]
|
#[validate(required)]
|
||||||
pub name: Option<String>,
|
pub name: Option<String>,
|
||||||
|
pub provider: Option<String>,
|
||||||
#[validate(required)]
|
#[validate(required)]
|
||||||
pub secrets: Option<Vec<String>>,
|
pub secrets: Option<Vec<String>>,
|
||||||
pub files: Option<Vec<PathBuf>>,
|
pub files: Option<Vec<PathBuf>>,
|
||||||
@@ -161,6 +165,10 @@ impl ProviderConfig {
|
|||||||
debug!("Using Azure Key Vault provider");
|
debug!("Using Azure Key Vault provider");
|
||||||
provider_def
|
provider_def
|
||||||
}
|
}
|
||||||
|
SupportedProvider::Gopass { provider_def } => {
|
||||||
|
debug!("Using Gopass provider");
|
||||||
|
provider_def
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -261,48 +269,49 @@ impl Config {
|
|||||||
|
|
||||||
/// Discover the default password file for the local provider.
|
/// Discover the default password file for the local provider.
|
||||||
///
|
///
|
||||||
/// On most systems this resolves to `~/.gman_password` when the file
|
/// On most systems this resolves to `~/.<executable_name>_password`
|
||||||
/// exists, otherwise `None`.
|
pub fn local_provider_password_file() -> PathBuf {
|
||||||
pub fn local_provider_password_file() -> Option<PathBuf> {
|
dirs::home_dir()
|
||||||
let candidate = dirs::home_dir().map(|p| p.join(".gman_password"));
|
.map(|p| p.join(format!(".{}_password", calling_app_name())))
|
||||||
match candidate {
|
.expect("unable to determine home directory for local provider password file")
|
||||||
Some(p) if p.exists() => Some(p),
|
|
||||||
_ => None,
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Load and validate the application configuration.
|
/// Load and validate the application configuration.
|
||||||
///
|
///
|
||||||
/// This uses the `confy` crate to load the configuration from a file
|
/// This uses the `confy` crate to load the configuration from a file
|
||||||
/// (e.g. `~/.config/gman/config.yaml`). If the file does
|
/// (e.g. `~/.config/<executable_name>/config.yaml`). If the file does
|
||||||
/// not exist, a default configuration is created and saved.
|
/// not exist, a default configuration is created and saved.
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// # use gman::config::load_config;
|
/// # use gman::config::load_config;
|
||||||
/// let config = load_config().unwrap();
|
/// // Load config with environment variable interpolation enabled
|
||||||
|
/// let config = load_config(true).unwrap();
|
||||||
/// println!("loaded config: {:?}", config);
|
/// println!("loaded config: {:?}", config);
|
||||||
/// ```
|
/// ```
|
||||||
pub fn load_config() -> Result<Config> {
|
pub fn load_config(interpolate: bool) -> Result<Config> {
|
||||||
let xdg_path = env::var_os("XDG_CONFIG_HOME").map(PathBuf::from);
|
let xdg_path = env::var_os("XDG_CONFIG_HOME").map(PathBuf::from);
|
||||||
|
|
||||||
let mut config: Config = if let Some(base) = xdg_path.as_ref() {
|
let mut config: Config = if let Some(base) = xdg_path.as_ref() {
|
||||||
let app_dir = base.join("gman");
|
let app_dir = base.join(calling_app_name());
|
||||||
let yml = app_dir.join("config.yml");
|
let yml = app_dir.join("config.yml");
|
||||||
let yaml = app_dir.join("config.yaml");
|
let yaml = app_dir.join("config.yaml");
|
||||||
if yml.exists() || yaml.exists() {
|
if yml.exists() || yaml.exists() {
|
||||||
let load_path = if yml.exists() { &yml } else { &yaml };
|
let load_path = if yml.exists() { &yml } else { &yaml };
|
||||||
let content = fs::read_to_string(load_path)
|
let mut content = fs::read_to_string(load_path)
|
||||||
.with_context(|| format!("failed to read config file '{}'", load_path.display()))?;
|
.with_context(|| format!("failed to read config file '{}'", load_path.display()))?;
|
||||||
|
if interpolate {
|
||||||
|
content = interpolate_env_vars(&content);
|
||||||
|
}
|
||||||
let cfg: Config = serde_yaml::from_str(&content).with_context(|| {
|
let cfg: Config = serde_yaml::from_str(&content).with_context(|| {
|
||||||
format!("failed to parse YAML config at '{}'", load_path.display())
|
format!("failed to parse YAML config at '{}'", load_path.display())
|
||||||
})?;
|
})?;
|
||||||
cfg
|
cfg
|
||||||
} else {
|
} else {
|
||||||
confy::load("gman", "config")?
|
load_confy_config(interpolate)?
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
confy::load("gman", "config")?
|
load_confy_config(interpolate)?
|
||||||
};
|
};
|
||||||
|
|
||||||
config.validate()?;
|
config.validate()?;
|
||||||
@@ -316,26 +325,128 @@ pub fn load_config() -> Result<Config> {
|
|||||||
ref mut provider_def,
|
ref mut provider_def,
|
||||||
} = p.provider_type
|
} = p.provider_type
|
||||||
&& provider_def.password_file.is_none()
|
&& provider_def.password_file.is_none()
|
||||||
&& let Some(local_password_file) = Config::local_provider_password_file()
|
&& Config::local_provider_password_file().exists()
|
||||||
{
|
{
|
||||||
provider_def.password_file = Some(local_password_file);
|
provider_def.password_file = Some(Config::local_provider_password_file());
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
Ok(config)
|
Ok(config)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the configuration file path that `confy` will use for this app.
|
fn load_confy_config(interpolate: bool) -> Result<Config> {
|
||||||
|
let load_path = confy::get_configuration_file_path(&calling_app_name(), "config")?;
|
||||||
|
let mut content = fs::read_to_string(&load_path)
|
||||||
|
.with_context(|| format!("failed to read config file '{}'", load_path.display()))?;
|
||||||
|
if interpolate {
|
||||||
|
content = interpolate_env_vars(&content);
|
||||||
|
}
|
||||||
|
let cfg: Config = serde_yaml::from_str(&content)
|
||||||
|
.with_context(|| format!("failed to parse YAML config at '{}'", load_path.display()))?;
|
||||||
|
|
||||||
|
Ok(cfg)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the configuration file path that `confy` will use
|
||||||
pub fn get_config_file_path() -> Result<PathBuf> {
|
pub fn get_config_file_path() -> Result<PathBuf> {
|
||||||
if let Some(base) = env::var_os("XDG_CONFIG_HOME").map(PathBuf::from) {
|
if let Some(base) = env::var_os("XDG_CONFIG_HOME").map(PathBuf::from) {
|
||||||
let dir = base.join("gman");
|
let dir = base.join(calling_app_name());
|
||||||
let yml = dir.join("config.yml");
|
let yml = dir.join("config.yml");
|
||||||
let yaml = dir.join("config.yaml");
|
let yaml = dir.join("config.yaml");
|
||||||
if yml.exists() || yaml.exists() {
|
if yml.exists() || yaml.exists() {
|
||||||
return Ok(if yml.exists() { yml } else { yaml });
|
return Ok(if yml.exists() { yml } else { yaml });
|
||||||
}
|
}
|
||||||
// Prefer .yml if creating anew
|
|
||||||
return Ok(dir.join("config.yml"));
|
return Ok(dir.join("config.yml"));
|
||||||
}
|
}
|
||||||
Ok(confy::get_configuration_file_path("gman", "config")?)
|
Ok(confy::get_configuration_file_path(
|
||||||
|
&calling_app_name(),
|
||||||
|
"config",
|
||||||
|
)?)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn interpolate_env_vars(s: &str) -> String {
|
||||||
|
let result = s.to_string();
|
||||||
|
let scrubbing_regex = Regex::new(r#"[\s{}^()\[\]\\|`'"]+"#).unwrap();
|
||||||
|
let var_regex = Regex::new(r"\$\{(.*?)(:-.+)?}").unwrap();
|
||||||
|
|
||||||
|
var_regex
|
||||||
|
.replace_all(s, |caps: ®ex::Captures<'_>| {
|
||||||
|
if let Some(mat) = caps.get(1) {
|
||||||
|
if let Ok(value) = env::var(mat.as_str()) {
|
||||||
|
return scrubbing_regex.replace_all(&value, "").to_string();
|
||||||
|
} else if let Some(default_value) = caps.get(2) {
|
||||||
|
return scrubbing_regex
|
||||||
|
.replace_all(
|
||||||
|
default_value
|
||||||
|
.as_str()
|
||||||
|
.strip_prefix(":-")
|
||||||
|
.expect("unable to strip ':-' prefix from default value"),
|
||||||
|
"",
|
||||||
|
)
|
||||||
|
.to_string();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
scrubbing_regex.replace_all(&result, "").to_string()
|
||||||
|
})
|
||||||
|
.to_string()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use pretty_assertions::assert_str_eq;
|
||||||
|
use serial_test::serial;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_interpolate_env_vars_defaults_to_original_string_if_not_in_yaml_interpolation_format() {
|
||||||
|
let var = interpolate_env_vars("TEST_VAR_INTERPOLATION_NON_YAML");
|
||||||
|
|
||||||
|
assert_str_eq!(var, "TEST_VAR_INTERPOLATION_NON_YAML");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[serial]
|
||||||
|
fn test_interpolate_env_vars_scrubs_all_unnecessary_characters() {
|
||||||
|
unsafe {
|
||||||
|
env::set_var(
|
||||||
|
"TEST_VAR_INTERPOLATION_UNNECESSARY_CHARACTERS",
|
||||||
|
r#"""
|
||||||
|
`"'https://dontdo:this@testing.com/query?test=%20query#results'"` {([\|])}
|
||||||
|
"""#,
|
||||||
|
)
|
||||||
|
};
|
||||||
|
|
||||||
|
let var = interpolate_env_vars("${TEST_VAR_INTERPOLATION_UNNECESSARY_CHARACTERS}");
|
||||||
|
|
||||||
|
assert_str_eq!(
|
||||||
|
var,
|
||||||
|
"https://dontdo:this@testing.com/query?test=%20query#results"
|
||||||
|
);
|
||||||
|
unsafe { env::remove_var("TEST_VAR_INTERPOLATION_UNNECESSARY_CHARACTERS") };
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[serial]
|
||||||
|
fn test_interpolate_env_vars_scrubs_all_unnecessary_characters_for_default_values() {
|
||||||
|
let var = interpolate_env_vars(
|
||||||
|
r#"${UNSET:-`"'https://dontdo:this@testing.com/query?test=%20query#results'"` {([\|])}}"#,
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_str_eq!(
|
||||||
|
var,
|
||||||
|
"https://dontdo:this@testing.com/query?test=%20query#results"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_interpolate_env_vars_scrubs_all_unnecessary_characters_from_non_environment_variable() {
|
||||||
|
let var =
|
||||||
|
interpolate_env_vars("https://dontdo:this@testing.com/query?test=%20query#results");
|
||||||
|
|
||||||
|
assert_str_eq!(
|
||||||
|
var,
|
||||||
|
"https://dontdo:this@testing.com/query?test=%20query#results"
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+10
@@ -20,6 +20,7 @@
|
|||||||
//! The `config` and `providers` modules power the CLI. They can be embedded
|
//! The `config` and `providers` modules power the CLI. They can be embedded
|
||||||
//! in other programs, but many functions interact with the user or the
|
//! in other programs, but many functions interact with the user or the
|
||||||
//! filesystem. Prefer `no_run` doctests for those.
|
//! filesystem. Prefer `no_run` doctests for those.
|
||||||
|
|
||||||
use anyhow::{Context, Result, anyhow, bail};
|
use anyhow::{Context, Result, anyhow, bail};
|
||||||
use argon2::{
|
use argon2::{
|
||||||
Algorithm, Argon2, Params, Version,
|
Algorithm, Argon2, Params, Version,
|
||||||
@@ -31,6 +32,7 @@ use chacha20poly1305::{
|
|||||||
aead::{Aead, KeyInit, OsRng},
|
aead::{Aead, KeyInit, OsRng},
|
||||||
};
|
};
|
||||||
use secrecy::{ExposeSecret, SecretString};
|
use secrecy::{ExposeSecret, SecretString};
|
||||||
|
use std::path::PathBuf;
|
||||||
use zeroize::Zeroize;
|
use zeroize::Zeroize;
|
||||||
/// Configuration structures and helpers used by the CLI and library.
|
/// Configuration structures and helpers used by the CLI and library.
|
||||||
pub mod config;
|
pub mod config;
|
||||||
@@ -207,6 +209,14 @@ pub fn decrypt_string(password: impl Into<SecretString>, envelope: &str) -> Resu
|
|||||||
Ok(s)
|
Ok(s)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub(crate) fn calling_app_name() -> String {
|
||||||
|
let exe: PathBuf = std::env::current_exe().expect("unable to get current exe path");
|
||||||
|
exe.file_stem()
|
||||||
|
.and_then(|s| s.to_str())
|
||||||
|
.map(|s| s.to_owned())
|
||||||
|
.expect("executable name not valid UTF-8")
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
use crate::calling_app_name;
|
||||||
use anyhow::{Context, Result, anyhow};
|
use anyhow::{Context, Result, anyhow};
|
||||||
use chrono::Utc;
|
use chrono::Utc;
|
||||||
use dialoguer::Confirm;
|
use dialoguer::Confirm;
|
||||||
@@ -25,7 +26,7 @@ pub fn sync_and_push(opts: &SyncOpts<'_>) -> Result<()> {
|
|||||||
opts.validate()
|
opts.validate()
|
||||||
.with_context(|| "invalid git sync options")?;
|
.with_context(|| "invalid git sync options")?;
|
||||||
let commit_message = format!("chore: sync @ {}", Utc::now().to_rfc3339());
|
let commit_message = format!("chore: sync @ {}", Utc::now().to_rfc3339());
|
||||||
let config_dir = confy::get_configuration_file_path("gman", "vault")
|
let config_dir = confy::get_configuration_file_path(&calling_app_name(), "vault")
|
||||||
.with_context(|| "get config dir")?
|
.with_context(|| "get config dir")?
|
||||||
.parent()
|
.parent()
|
||||||
.map(Path::to_path_buf)
|
.map(Path::to_path_buf)
|
||||||
@@ -37,7 +38,7 @@ pub fn sync_and_push(opts: &SyncOpts<'_>) -> Result<()> {
|
|||||||
fs::create_dir_all(&repo_dir).with_context(|| format!("create {}", repo_dir.display()))?;
|
fs::create_dir_all(&repo_dir).with_context(|| format!("create {}", repo_dir.display()))?;
|
||||||
|
|
||||||
// Move the default vault into the repo dir on first sync so only vault.yml is tracked.
|
// Move the default vault into the repo dir on first sync so only vault.yml is tracked.
|
||||||
let default_vault = confy::get_configuration_file_path("gman", "vault")
|
let default_vault = confy::get_configuration_file_path(&calling_app_name(), "vault")
|
||||||
.with_context(|| "get default vault path")?;
|
.with_context(|| "get default vault path")?;
|
||||||
let repo_vault = repo_dir.join("vault.yml");
|
let repo_vault = repo_dir.join("vault.yml");
|
||||||
if default_vault.exists() && !repo_vault.exists() {
|
if default_vault.exists() && !repo_vault.exists() {
|
||||||
|
|||||||
@@ -0,0 +1,190 @@
|
|||||||
|
use crate::providers::{ENV_PATH, SecretProvider};
|
||||||
|
use anyhow::{Context, Result, anyhow};
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use serde_with::skip_serializing_none;
|
||||||
|
use std::io::{Read, Write};
|
||||||
|
use std::process::{Command, Stdio};
|
||||||
|
use validator::Validate;
|
||||||
|
|
||||||
|
#[skip_serializing_none]
|
||||||
|
/// Gopass-based secret provider
|
||||||
|
/// See [Gopass](https://gopass.pw/) for more information.
|
||||||
|
///
|
||||||
|
/// You must already have gopass installed and configured on your system.
|
||||||
|
///
|
||||||
|
/// This provider stores secrets in a gopass store. It requires
|
||||||
|
/// an optional store name to be specified. If no store name is
|
||||||
|
/// specified, the default store will be used.
|
||||||
|
///
|
||||||
|
/// Example
|
||||||
|
/// ```no_run
|
||||||
|
/// use gman::providers::gopass::GopassProvider;
|
||||||
|
/// use gman::providers::{SecretProvider, SupportedProvider};
|
||||||
|
/// use gman::config::Config;
|
||||||
|
///
|
||||||
|
/// let provider = GopassProvider::default();
|
||||||
|
/// let _ = provider.set_secret("MY_SECRET", "value");
|
||||||
|
/// ```
|
||||||
|
#[derive(Debug, Default, Clone, Validate, Serialize, Deserialize, PartialEq, Eq)]
|
||||||
|
#[serde(deny_unknown_fields)]
|
||||||
|
pub struct GopassProvider {
|
||||||
|
pub store: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait::async_trait]
|
||||||
|
impl SecretProvider for GopassProvider {
|
||||||
|
fn name(&self) -> &'static str {
|
||||||
|
"GopassProvider"
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn get_secret(&self, key: &str) -> Result<String> {
|
||||||
|
ensure_gopass_installed()?;
|
||||||
|
|
||||||
|
let mut child = Command::new("gopass")
|
||||||
|
.args(["show", "-yfon", key])
|
||||||
|
.env("PATH", ENV_PATH.as_ref().expect("No ENV_PATH set"))
|
||||||
|
.stdin(Stdio::inherit())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::inherit())
|
||||||
|
.spawn()
|
||||||
|
.context("Failed to spawn gopass command")?;
|
||||||
|
|
||||||
|
let mut output = String::new();
|
||||||
|
child
|
||||||
|
.stdout
|
||||||
|
.as_mut()
|
||||||
|
.expect("Failed to open gopass stdout")
|
||||||
|
.read_to_string(&mut output)
|
||||||
|
.context("Failed to read gopass output")?;
|
||||||
|
|
||||||
|
let status = child.wait().context("Failed to wait on gopass process")?;
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("gopass command failed with status: {}", status));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(output.trim_end_matches(&['\r', '\n'][..]).to_string())
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn set_secret(&self, key: &str, value: &str) -> Result<()> {
|
||||||
|
ensure_gopass_installed()?;
|
||||||
|
|
||||||
|
let mut child = Command::new("gopass")
|
||||||
|
.args(["insert", "-f", key])
|
||||||
|
.env("PATH", ENV_PATH.as_ref().expect("No ENV_PATH set"))
|
||||||
|
.stdin(Stdio::piped())
|
||||||
|
.stdout(Stdio::inherit())
|
||||||
|
.stderr(Stdio::inherit())
|
||||||
|
.spawn()
|
||||||
|
.context("Failed to spawn gopass command")?;
|
||||||
|
|
||||||
|
{
|
||||||
|
let stdin = child.stdin.as_mut().expect("Failed to open gopass stdin");
|
||||||
|
stdin
|
||||||
|
.write_all(value.as_bytes())
|
||||||
|
.context("Failed to write to gopass stdin")?;
|
||||||
|
}
|
||||||
|
|
||||||
|
let status = child.wait().context("Failed to wait on gopass process")?;
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("gopass command failed with status: {}", status));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn update_secret(&self, key: &str, value: &str) -> Result<()> {
|
||||||
|
ensure_gopass_installed()?;
|
||||||
|
|
||||||
|
self.set_secret(key, value).await
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn delete_secret(&self, key: &str) -> Result<()> {
|
||||||
|
ensure_gopass_installed()?;
|
||||||
|
|
||||||
|
let mut child = Command::new("gopass")
|
||||||
|
.args(["rm", "-f", key])
|
||||||
|
.env("PATH", ENV_PATH.as_ref().expect("No ENV_PATH set"))
|
||||||
|
.stdin(Stdio::inherit())
|
||||||
|
.stdout(Stdio::inherit())
|
||||||
|
.stderr(Stdio::inherit())
|
||||||
|
.spawn()
|
||||||
|
.context("Failed to spawn gopass command")?;
|
||||||
|
|
||||||
|
let status = child.wait().context("Failed to wait on gopass process")?;
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("gopass command failed with status: {}", status));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn list_secrets(&self) -> Result<Vec<String>> {
|
||||||
|
ensure_gopass_installed()?;
|
||||||
|
|
||||||
|
let mut child = Command::new("gopass")
|
||||||
|
.args(["ls", "-f"])
|
||||||
|
.env("PATH", ENV_PATH.as_ref().expect("No ENV_PATH set"))
|
||||||
|
.stdin(Stdio::inherit())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::inherit())
|
||||||
|
.spawn()
|
||||||
|
.context("Failed to spawn gopass command")?;
|
||||||
|
|
||||||
|
let mut output = String::new();
|
||||||
|
child
|
||||||
|
.stdout
|
||||||
|
.as_mut()
|
||||||
|
.expect("Failed to open gopass stdout")
|
||||||
|
.read_to_string(&mut output)
|
||||||
|
.context("Failed to read gopass output")?;
|
||||||
|
|
||||||
|
let status = child.wait().context("Failed to wait on gopass process")?;
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("gopass command failed with status: {}", status));
|
||||||
|
}
|
||||||
|
|
||||||
|
let secrets: Vec<String> = output
|
||||||
|
.lines()
|
||||||
|
.map(|line| line.trim().to_string())
|
||||||
|
.filter(|line| !line.is_empty())
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
Ok(secrets)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn sync(&mut self) -> Result<()> {
|
||||||
|
ensure_gopass_installed()?;
|
||||||
|
let mut child = Command::new("gopass");
|
||||||
|
child.arg("sync");
|
||||||
|
|
||||||
|
if let Some(store) = &self.store {
|
||||||
|
child.args(["-s", store]);
|
||||||
|
}
|
||||||
|
|
||||||
|
let status = child
|
||||||
|
.env("PATH", ENV_PATH.as_ref().expect("No ENV_PATH set"))
|
||||||
|
.stdin(Stdio::inherit())
|
||||||
|
.stdout(Stdio::inherit())
|
||||||
|
.stderr(Stdio::inherit())
|
||||||
|
.spawn()
|
||||||
|
.context("Failed to spawn gopass command")?
|
||||||
|
.wait()
|
||||||
|
.context("Failed to wait on gopass process")?;
|
||||||
|
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("gopass command failed with status: {}", status));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn ensure_gopass_installed() -> Result<()> {
|
||||||
|
if which::which("gopass").is_err() {
|
||||||
|
Err(anyhow!(
|
||||||
|
"Gopass is not installed or not found in PATH. Please install Gopass from https://gopass.pw/"
|
||||||
|
))
|
||||||
|
} else {
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
+13
-6
@@ -13,6 +13,7 @@ use crate::providers::git_sync::{
|
|||||||
use crate::providers::{SecretProvider, SupportedProvider};
|
use crate::providers::{SecretProvider, SupportedProvider};
|
||||||
use crate::{
|
use crate::{
|
||||||
ARGON_M_COST_KIB, ARGON_P, ARGON_T_COST, HEADER, KDF, KEY_LEN, NONCE_LEN, SALT_LEN, VERSION,
|
ARGON_M_COST_KIB, ARGON_P, ARGON_T_COST, HEADER, KDF, KEY_LEN, NONCE_LEN, SALT_LEN, VERSION,
|
||||||
|
calling_app_name,
|
||||||
};
|
};
|
||||||
use anyhow::Result;
|
use anyhow::Result;
|
||||||
use argon2::{Algorithm, Argon2, Params, Version};
|
use argon2::{Algorithm, Argon2, Params, Version};
|
||||||
@@ -63,8 +64,13 @@ pub struct LocalProvider {
|
|||||||
|
|
||||||
impl Default for LocalProvider {
|
impl Default for LocalProvider {
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
|
let password_file = match Config::local_provider_password_file() {
|
||||||
|
p if p.exists() => Some(p),
|
||||||
|
_ => None,
|
||||||
|
};
|
||||||
|
|
||||||
Self {
|
Self {
|
||||||
password_file: Config::local_provider_password_file(),
|
password_file,
|
||||||
git_branch: Some("main".into()),
|
git_branch: Some("main".into()),
|
||||||
git_remote_url: None,
|
git_remote_url: None,
|
||||||
git_user_name: None,
|
git_user_name: None,
|
||||||
@@ -247,7 +253,7 @@ impl LocalProvider {
|
|||||||
fn persist_git_settings_to_config(&self) -> Result<()> {
|
fn persist_git_settings_to_config(&self) -> Result<()> {
|
||||||
debug!("Saving updated config (only current local provider)");
|
debug!("Saving updated config (only current local provider)");
|
||||||
|
|
||||||
let mut cfg = load_config().with_context(|| "failed to load existing config")?;
|
let mut cfg = load_config(true).with_context(|| "failed to load existing config")?;
|
||||||
|
|
||||||
let target_name = self.runtime_provider_name.clone();
|
let target_name = self.runtime_provider_name.clone();
|
||||||
let mut updated = false;
|
let mut updated = false;
|
||||||
@@ -286,7 +292,7 @@ impl LocalProvider {
|
|||||||
let s = serde_yaml::to_string(&cfg)?;
|
let s = serde_yaml::to_string(&cfg)?;
|
||||||
fs::write(&path, s).with_context(|| format!("failed to write {}", path.display()))?;
|
fs::write(&path, s).with_context(|| format!("failed to write {}", path.display()))?;
|
||||||
} else {
|
} else {
|
||||||
confy::store("gman", "config", &cfg)
|
confy::store(&calling_app_name(), "config", &cfg)
|
||||||
.with_context(|| "failed to save updated config via confy")?;
|
.with_context(|| "failed to save updated config via confy")?;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -335,10 +341,11 @@ fn default_vault_path() -> Result<PathBuf> {
|
|||||||
let xdg_path = env::var_os("XDG_CONFIG_HOME").map(PathBuf::from);
|
let xdg_path = env::var_os("XDG_CONFIG_HOME").map(PathBuf::from);
|
||||||
|
|
||||||
if let Some(xdg) = xdg_path {
|
if let Some(xdg) = xdg_path {
|
||||||
return Ok(xdg.join("gman").join("vault.yml"));
|
return Ok(xdg.join(calling_app_name()).join("vault.yml"));
|
||||||
}
|
}
|
||||||
|
|
||||||
confy::get_configuration_file_path("gman", "vault").with_context(|| "get config dir")
|
confy::get_configuration_file_path(&calling_app_name(), "vault")
|
||||||
|
.with_context(|| "get config dir")
|
||||||
}
|
}
|
||||||
|
|
||||||
fn base_config_dir() -> Result<PathBuf> {
|
fn base_config_dir() -> Result<PathBuf> {
|
||||||
@@ -560,7 +567,7 @@ mod tests {
|
|||||||
fn persist_only_target_local_provider_git_settings() {
|
fn persist_only_target_local_provider_git_settings() {
|
||||||
let td = tempdir().unwrap();
|
let td = tempdir().unwrap();
|
||||||
let xdg = td.path().join("xdg");
|
let xdg = td.path().join("xdg");
|
||||||
let app_dir = xdg.join("gman");
|
let app_dir = xdg.join(calling_app_name());
|
||||||
fs::create_dir_all(&app_dir).unwrap();
|
fs::create_dir_all(&app_dir).unwrap();
|
||||||
unsafe {
|
unsafe {
|
||||||
std_env::set_var("XDG_CONFIG_HOME", &xdg);
|
std_env::set_var("XDG_CONFIG_HOME", &xdg);
|
||||||
|
|||||||
+16
-3
@@ -6,17 +6,24 @@ pub mod aws_secrets_manager;
|
|||||||
pub mod azure_key_vault;
|
pub mod azure_key_vault;
|
||||||
pub mod gcp_secret_manager;
|
pub mod gcp_secret_manager;
|
||||||
mod git_sync;
|
mod git_sync;
|
||||||
|
pub mod gopass;
|
||||||
pub mod local;
|
pub mod local;
|
||||||
|
|
||||||
|
use crate::providers::gopass::GopassProvider;
|
||||||
use crate::providers::local::LocalProvider;
|
use crate::providers::local::LocalProvider;
|
||||||
use anyhow::{Result, anyhow};
|
use anyhow::{Context, Result, anyhow};
|
||||||
use aws_secrets_manager::AwsSecretsManagerProvider;
|
use aws_secrets_manager::AwsSecretsManagerProvider;
|
||||||
|
use azure_key_vault::AzureKeyVaultProvider;
|
||||||
use gcp_secret_manager::GcpSecretManagerProvider;
|
use gcp_secret_manager::GcpSecretManagerProvider;
|
||||||
|
use once_cell::sync::Lazy;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use std::fmt;
|
|
||||||
use std::fmt::{Display, Formatter};
|
use std::fmt::{Display, Formatter};
|
||||||
|
use std::{env, fmt};
|
||||||
use validator::{Validate, ValidationErrors};
|
use validator::{Validate, ValidationErrors};
|
||||||
|
|
||||||
|
pub(in crate::providers) static ENV_PATH: Lazy<Result<String>> =
|
||||||
|
Lazy::new(|| env::var("PATH").context("No PATH environment variable"));
|
||||||
|
|
||||||
/// A secret storage backend capable of CRUD, with optional
|
/// A secret storage backend capable of CRUD, with optional
|
||||||
/// update, listing, and sync support.
|
/// update, listing, and sync support.
|
||||||
#[async_trait::async_trait]
|
#[async_trait::async_trait]
|
||||||
@@ -63,7 +70,11 @@ pub enum SupportedProvider {
|
|||||||
},
|
},
|
||||||
AzureKeyVault {
|
AzureKeyVault {
|
||||||
#[serde(flatten)]
|
#[serde(flatten)]
|
||||||
provider_def: azure_key_vault::AzureKeyVaultProvider,
|
provider_def: AzureKeyVaultProvider,
|
||||||
|
},
|
||||||
|
Gopass {
|
||||||
|
#[serde(flatten)]
|
||||||
|
provider_def: GopassProvider,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -74,6 +85,7 @@ impl Validate for SupportedProvider {
|
|||||||
SupportedProvider::AwsSecretsManager { provider_def } => provider_def.validate(),
|
SupportedProvider::AwsSecretsManager { provider_def } => provider_def.validate(),
|
||||||
SupportedProvider::GcpSecretManager { provider_def } => provider_def.validate(),
|
SupportedProvider::GcpSecretManager { provider_def } => provider_def.validate(),
|
||||||
SupportedProvider::AzureKeyVault { provider_def } => provider_def.validate(),
|
SupportedProvider::AzureKeyVault { provider_def } => provider_def.validate(),
|
||||||
|
SupportedProvider::Gopass { provider_def } => provider_def.validate(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -93,6 +105,7 @@ impl Display for SupportedProvider {
|
|||||||
SupportedProvider::AwsSecretsManager { .. } => write!(f, "aws_secrets_manager"),
|
SupportedProvider::AwsSecretsManager { .. } => write!(f, "aws_secrets_manager"),
|
||||||
SupportedProvider::GcpSecretManager { .. } => write!(f, "gcp_secret_manager"),
|
SupportedProvider::GcpSecretManager { .. } => write!(f, "gcp_secret_manager"),
|
||||||
SupportedProvider::AzureKeyVault { .. } => write!(f, "azure_key_vault"),
|
SupportedProvider::AzureKeyVault { .. } => write!(f, "azure_key_vault"),
|
||||||
|
SupportedProvider::Gopass { .. } => write!(f, "gopass"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -130,18 +130,6 @@ fn cli_shows_help() {
|
|||||||
.stdout(predicate::str::contains("Usage").or(predicate::str::contains("Add")));
|
.stdout(predicate::str::contains("Usage").or(predicate::str::contains("Add")));
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn cli_completions_bash() {
|
|
||||||
let (_td, cfg, cache) = setup_env();
|
|
||||||
let mut cmd = Command::cargo_bin("gman").unwrap();
|
|
||||||
cmd.env("XDG_CACHE_HOME", &cache)
|
|
||||||
.env("XDG_CONFIG_HOME", &cfg)
|
|
||||||
.args(["completions", "bash"]);
|
|
||||||
cmd.assert()
|
|
||||||
.success()
|
|
||||||
.stdout(predicate::str::contains("_gman").or(predicate::str::contains("complete -F")));
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn cli_add_get_list_update_delete_roundtrip() {
|
fn cli_add_get_list_update_delete_roundtrip() {
|
||||||
let (td, xdg_cfg, xdg_cache) = setup_env();
|
let (td, xdg_cfg, xdg_cache) = setup_env();
|
||||||
|
|||||||
+19
-10
@@ -9,6 +9,7 @@ mod tests {
|
|||||||
fn test_run_config_valid() {
|
fn test_run_config_valid() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: None,
|
flag: None,
|
||||||
flag_position: None,
|
flag_position: None,
|
||||||
@@ -23,6 +24,7 @@ mod tests {
|
|||||||
fn test_run_config_missing_name() {
|
fn test_run_config_missing_name() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: None,
|
name: None,
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: None,
|
flag: None,
|
||||||
flag_position: None,
|
flag_position: None,
|
||||||
@@ -37,6 +39,7 @@ mod tests {
|
|||||||
fn test_run_config_missing_secrets() {
|
fn test_run_config_missing_secrets() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: None,
|
secrets: None,
|
||||||
flag: None,
|
flag: None,
|
||||||
flag_position: None,
|
flag_position: None,
|
||||||
@@ -51,6 +54,7 @@ mod tests {
|
|||||||
fn test_run_config_invalid_flag_position() {
|
fn test_run_config_invalid_flag_position() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: Some("--test-flag".to_string()),
|
flag: Some("--test-flag".to_string()),
|
||||||
flag_position: Some(0),
|
flag_position: Some(0),
|
||||||
@@ -65,6 +69,7 @@ mod tests {
|
|||||||
fn test_run_config_flags_or_none_all_some() {
|
fn test_run_config_flags_or_none_all_some() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: Some("--test-flag".to_string()),
|
flag: Some("--test-flag".to_string()),
|
||||||
flag_position: Some(1),
|
flag_position: Some(1),
|
||||||
@@ -79,6 +84,7 @@ mod tests {
|
|||||||
fn test_run_config_flags_or_none_all_none() {
|
fn test_run_config_flags_or_none_all_none() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: None,
|
flag: None,
|
||||||
flag_position: None,
|
flag_position: None,
|
||||||
@@ -93,6 +99,7 @@ mod tests {
|
|||||||
fn test_run_config_flags_or_none_partial_some() {
|
fn test_run_config_flags_or_none_partial_some() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: Some("--test-flag".to_string()),
|
flag: Some("--test-flag".to_string()),
|
||||||
flag_position: None,
|
flag_position: None,
|
||||||
@@ -107,6 +114,7 @@ mod tests {
|
|||||||
fn test_run_config_flags_or_none_missing_placeholder() {
|
fn test_run_config_flags_or_none_missing_placeholder() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: Some("--test-flag".to_string()),
|
flag: Some("--test-flag".to_string()),
|
||||||
flag_position: Some(1),
|
flag_position: Some(1),
|
||||||
@@ -121,6 +129,7 @@ mod tests {
|
|||||||
fn test_run_config_flags_or_files_all_none() {
|
fn test_run_config_flags_or_files_all_none() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: None,
|
flag: None,
|
||||||
flag_position: None,
|
flag_position: None,
|
||||||
@@ -135,6 +144,7 @@ mod tests {
|
|||||||
fn test_run_config_flags_or_files_files_is_some() {
|
fn test_run_config_flags_or_files_files_is_some() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: None,
|
flag: None,
|
||||||
flag_position: None,
|
flag_position: None,
|
||||||
@@ -149,6 +159,7 @@ mod tests {
|
|||||||
fn test_run_config_flags_or_files_all_some() {
|
fn test_run_config_flags_or_files_all_some() {
|
||||||
let run_config = RunConfig {
|
let run_config = RunConfig {
|
||||||
name: Some("test".to_string()),
|
name: Some("test".to_string()),
|
||||||
|
provider: None,
|
||||||
secrets: Some(vec!["secret1".to_string()]),
|
secrets: Some(vec!["secret1".to_string()]),
|
||||||
flag: Some("--test-flag".to_string()),
|
flag: Some("--test-flag".to_string()),
|
||||||
flag_position: Some(1),
|
flag_position: Some(1),
|
||||||
@@ -241,16 +252,14 @@ mod tests {
|
|||||||
#[test]
|
#[test]
|
||||||
fn test_config_local_provider_password_file() {
|
fn test_config_local_provider_password_file() {
|
||||||
let path = Config::local_provider_password_file();
|
let path = Config::local_provider_password_file();
|
||||||
let expected_path = dirs::home_dir().map(|p| p.join(".gman_password"));
|
// Derive expected filename based on current test executable name
|
||||||
if let Some(p) = &expected_path {
|
let exe = std::env::current_exe().expect("current_exe");
|
||||||
if !p.exists() {
|
let stem = exe
|
||||||
assert_eq!(path, None);
|
.file_stem()
|
||||||
} else {
|
.and_then(|s| s.to_str())
|
||||||
assert_eq!(path, expected_path);
|
.expect("utf-8 file stem");
|
||||||
}
|
let expected = dirs::home_dir().map(|p| p.join(format!(".{}_password", stem)));
|
||||||
} else {
|
assert_eq!(Some(path), expected);
|
||||||
assert_eq!(path, None);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
|||||||
@@ -0,0 +1,53 @@
|
|||||||
|
use gman::config::{Config, ProviderConfig};
|
||||||
|
use gman::providers::{SecretProvider, SupportedProvider};
|
||||||
|
use pretty_assertions::{assert_eq, assert_str_eq};
|
||||||
|
use validator::Validate;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_gopass_supported_provider_display_and_validate_from_yaml() {
|
||||||
|
// Build a SupportedProvider via YAML to avoid direct type import
|
||||||
|
let yaml = r#"---
|
||||||
|
type: gopass
|
||||||
|
store: personal
|
||||||
|
"#;
|
||||||
|
|
||||||
|
let sp: SupportedProvider = serde_yaml::from_str(yaml).expect("valid supported provider yaml");
|
||||||
|
// Validate delegates to inner provider (no required fields)
|
||||||
|
assert!(sp.validate().is_ok());
|
||||||
|
// Display formatting for the enum variant
|
||||||
|
assert_eq!(sp.to_string(), "gopass");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_provider_config_with_gopass_deserialize_and_extract() {
|
||||||
|
// Minimal ProviderConfig YAML using the gopass variant
|
||||||
|
let yaml = r#"---
|
||||||
|
name: gopass
|
||||||
|
type: gopass
|
||||||
|
"#;
|
||||||
|
|
||||||
|
let pc: ProviderConfig = serde_yaml::from_str(yaml).expect("valid provider config yaml");
|
||||||
|
// Gopass has no required fields, so validation should pass
|
||||||
|
assert!(pc.validate().is_ok());
|
||||||
|
|
||||||
|
// Extract the provider and inspect its name via the trait
|
||||||
|
let mut pc_owned = pc.clone();
|
||||||
|
let provider: &mut dyn SecretProvider = pc_owned.extract_provider();
|
||||||
|
assert_str_eq!(provider.name(), "GopassProvider");
|
||||||
|
|
||||||
|
// Round-trip through Config with default_provider
|
||||||
|
let cfg_yaml = r#"---
|
||||||
|
default_provider: gopass
|
||||||
|
providers:
|
||||||
|
- name: gopass
|
||||||
|
type: gopass
|
||||||
|
store: personal
|
||||||
|
"#;
|
||||||
|
let cfg: Config = serde_yaml::from_str(cfg_yaml).expect("valid config yaml");
|
||||||
|
assert!(cfg.validate().is_ok());
|
||||||
|
|
||||||
|
let extracted = cfg
|
||||||
|
.extract_provider_config(None)
|
||||||
|
.expect("should find default provider");
|
||||||
|
assert_eq!(extracted.name.as_deref(), Some("gopass"));
|
||||||
|
}
|
||||||
@@ -58,10 +58,11 @@ fn test_local_provider_invalid_email() {
|
|||||||
#[test]
|
#[test]
|
||||||
fn test_local_provider_default() {
|
fn test_local_provider_default() {
|
||||||
let provider = LocalProvider::default();
|
let provider = LocalProvider::default();
|
||||||
assert_eq!(
|
let expected_pw = {
|
||||||
provider.password_file,
|
let p = Config::local_provider_password_file();
|
||||||
Config::local_provider_password_file()
|
if p.exists() { Some(p) } else { None }
|
||||||
);
|
};
|
||||||
|
assert_eq!(provider.password_file, expected_pw);
|
||||||
assert_eq!(provider.git_branch, Some("main".into()));
|
assert_eq!(provider.git_branch, Some("main".into()));
|
||||||
assert_eq!(provider.git_remote_url, None);
|
assert_eq!(provider.git_remote_url, None);
|
||||||
assert_eq!(provider.git_user_name, None);
|
assert_eq!(provider.git_user_name, None);
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
mod aws_secrets_manager_tests;
|
mod aws_secrets_manager_tests;
|
||||||
mod azure_key_vault_tests;
|
mod azure_key_vault_tests;
|
||||||
mod gcp_secret_manager_tests;
|
mod gcp_secret_manager_tests;
|
||||||
|
mod gopass_tests;
|
||||||
mod local_tests;
|
mod local_tests;
|
||||||
mod provider_tests;
|
mod provider_tests;
|
||||||
|
|||||||
Reference in New Issue
Block a user