Compare commits
48 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9f63ee8265 | ||
|
6cba3d6d0b
|
|||
|
b2a51dc1b1
|
|||
|
|
cc44fca54e | ||
|
9a678ae67d
|
|||
|
66b950991c
|
|||
| e8e0bd02e9 | |||
|
ed5a7308be
|
|||
|
044d5960eb
|
|||
|
|
c0aa379b20 | ||
|
f9fd9692aa
|
|||
| 2615b23d6e | |||
| 628a13011e | |||
| cff4420ee0 | |||
| 9944e29ef0 | |||
| c95bae1761 | |||
| 21da7b782e | |||
| d038930ce5 | |||
|
|
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 |
@@ -0,0 +1,11 @@
|
|||||||
|
### AI assistance (if any):
|
||||||
|
- List tools here and files touched by them
|
||||||
|
|
||||||
|
### Authorship & Understanding
|
||||||
|
|
||||||
|
- [ ] I wrote or heavily modified this code myself
|
||||||
|
- [ ] I understand how it works end-to-end
|
||||||
|
- [ ] I can maintain this code in the future
|
||||||
|
- [ ] No undisclosed AI-generated code was used
|
||||||
|
- [ ] If AI assistance was used, it is documented below
|
||||||
|
|
||||||
+52
-1
@@ -5,7 +5,58 @@ 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.4.1 (2026-03-20)
|
||||||
|
|
||||||
|
### Feat
|
||||||
|
|
||||||
|
- Upgraded aws-lc-sys version to address high severity CWE-295
|
||||||
|
|
||||||
|
## v0.4.0 (2026-03-09)
|
||||||
|
|
||||||
|
### Feat
|
||||||
|
|
||||||
|
- Added 1password support
|
||||||
|
- sort local keys alphabetically when listing them
|
||||||
|
|
||||||
|
## v0.3.0 (2026-02-02)
|
||||||
|
|
||||||
|
### Fix
|
||||||
|
|
||||||
|
- Upgraded AWS dependencies to address CWE-20
|
||||||
|
- A critical security flaw was discovered that essentially had all local secrets be encrypted with an all-zero key
|
||||||
|
- Addressed XNonce::from_slice deprecation warning
|
||||||
|
- Secrets are now stored exactly as passed without newlines stripped
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|||||||
+9
-1
@@ -48,7 +48,8 @@ cz commit
|
|||||||
1. Clone this repo
|
1. Clone this repo
|
||||||
2. Run `cargo test` to set up hooks
|
2. Run `cargo test` to set up hooks
|
||||||
3. Make changes
|
3. Make changes
|
||||||
4. Run the application using `make run` or `cargo run`
|
4. Run the application using `just run` or `just run`
|
||||||
|
- Install `just` (`cargo install just`) if you haven't already to use the [justfile](./justfile) in this project.
|
||||||
5. Commit changes. This will trigger pre-commit hooks that will run format, test and lint. If there are errors or
|
5. Commit changes. This will trigger pre-commit hooks that will run format, test and lint. If there are errors or
|
||||||
warnings from Clippy, please fix them.
|
warnings from Clippy, please fix them.
|
||||||
6. Push your code to a new branch named after the feature/bug/etc. you're adding. This will trigger pre-push hooks that
|
6. Push your code to a new branch named after the feature/bug/etc. you're adding. This will trigger pre-push hooks that
|
||||||
@@ -75,6 +76,13 @@ Then, you can run workflows locally without having to commit and see if the GitH
|
|||||||
act -W .github/workflows/release.yml --input_type bump=minor
|
act -W .github/workflows/release.yml --input_type bump=minor
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Authorship Policy
|
||||||
|
|
||||||
|
All code in this repository is written and reviewed by humans. AI-generated code (e.g., Copilot, ChatGPT,
|
||||||
|
Claude, etc.) is not permitted unless explicitly disclosed and approved.
|
||||||
|
|
||||||
|
Submissions must certify that the contributor understands and can maintain the code they submit.
|
||||||
|
|
||||||
## Questions? Reach out to me!
|
## Questions? Reach out to me!
|
||||||
If you encounter any questions while developing G-Man, please don't hesitate to reach out to me at
|
If you encounter any questions while developing G-Man, please don't hesitate to reach out to me at
|
||||||
alex.j.tusa@gmail.com. I'm happy to help contributors in any way I can, regardless of if they're new or experienced!
|
alex.j.tusa@gmail.com. I'm happy to help contributors in any way I can, regardless of if they're new or experienced!
|
||||||
|
|||||||
Generated
+1105
-774
File diff suppressed because it is too large
Load Diff
+20
-11
@@ -1,10 +1,16 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "gman"
|
name = "gman"
|
||||||
version = "0.1.0"
|
version = "0.4.1"
|
||||||
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,8 +31,8 @@ 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 = "2.0.0", default-features = false, features = [
|
||||||
"yaml_conf",
|
"yaml_conf",
|
||||||
] }
|
] }
|
||||||
crossterm = "0.29.0"
|
crossterm = "0.29.0"
|
||||||
@@ -47,18 +53,21 @@ indoc = "2.0.6"
|
|||||||
regex = "1.11.2"
|
regex = "1.11.2"
|
||||||
serde_yaml = "0.9.34"
|
serde_yaml = "0.9.34"
|
||||||
tempfile = "3.22.0"
|
tempfile = "3.22.0"
|
||||||
aws-sdk-secretsmanager = "1.88.0"
|
aws-sdk-secretsmanager = "1.98.0"
|
||||||
tokio = { version = "1.47.1", features = ["full"] }
|
tokio = { version = "1.47.1", features = ["full"] }
|
||||||
aws-config = { version = "1.8.6", features = ["behavior-version-latest"] }
|
aws-config = { version = "1.8.12", features = ["behavior-version-latest"] }
|
||||||
async-trait = "0.1.89"
|
async-trait = "0.1.89"
|
||||||
futures = "0.3.31"
|
futures = "0.3.31"
|
||||||
gcloud-sdk = { version = "0.28.1", features = [
|
gcloud-sdk = { version = "0.28.5", features = [
|
||||||
"google-cloud-secretmanager-v1",
|
"google-cloud-secretmanager-v1",
|
||||||
] }
|
] }
|
||||||
crc32c = "0.6.8"
|
crc32c = "0.6.8"
|
||||||
azure_identity = "0.27.0"
|
azure_core = "0.31.0"
|
||||||
azure_security_keyvault_secrets = "0.6.0"
|
azure_identity = "0.31.0"
|
||||||
aws-lc-sys = { version = "0.31.0", features = ["bindgen"] }
|
azure_security_keyvault_secrets = "0.10.0"
|
||||||
|
aws-lc-sys = { version = "0.39.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 +80,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
|
||||||
|
|||||||
@@ -1,40 +0,0 @@
|
|||||||
#!make
|
|
||||||
default: run
|
|
||||||
|
|
||||||
.PHONY: test test-cov build run lint lint-fix fmt minimal-versions analyze release delete-tag
|
|
||||||
|
|
||||||
test:
|
|
||||||
@cargo test --all
|
|
||||||
|
|
||||||
## Run all tests with coverage - `cargo install cargo-tarpaulin`
|
|
||||||
test-cov:
|
|
||||||
@cargo tarpaulin
|
|
||||||
|
|
||||||
build: test
|
|
||||||
@cargo build --release
|
|
||||||
|
|
||||||
run:
|
|
||||||
@CARGO_INCREMENTAL=1 cargo fmt && make lint && cargo run
|
|
||||||
|
|
||||||
lint:
|
|
||||||
@find . | grep '\.\/src\/.*\.rs$$' | xargs touch && CARGO_INCREMENTAL=0 cargo clippy --all-targets --workspace
|
|
||||||
|
|
||||||
lint-fix:
|
|
||||||
@cargo fix
|
|
||||||
|
|
||||||
fmt:
|
|
||||||
@cargo fmt
|
|
||||||
|
|
||||||
minimal-versions:
|
|
||||||
@cargo +nightly update -Zdirect-minimal-versions
|
|
||||||
|
|
||||||
## Analyze for unsafe usage - `cargo install cargo-geiger`
|
|
||||||
analyze:
|
|
||||||
@cargo geiger
|
|
||||||
|
|
||||||
release:
|
|
||||||
@git tag -a ${V} -m "Release ${V}" && git push origin ${V}
|
|
||||||
|
|
||||||
delete-tag:
|
|
||||||
@git tag -d ${V} && git push --delete origin ${V}
|
|
||||||
|
|
||||||
@@ -14,8 +14,8 @@ files or sprinkling environment variables everywhere.
|
|||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
`gman` acts as a universal wrapper for any command that needs credentials. Store your secrets—API tokens, passwords,
|
`gman` acts as a universal wrapper for any command that needs credentials. Store your secrets (e.g. API tokens, passwords,
|
||||||
certs—with a provider, then either fetch them directly or run your command through `gman` to inject what it needs as
|
certs, etc.) with a provider, then either fetch them directly or run your command through `gman` to inject what it needs as
|
||||||
environment variables, flags, or file content.
|
environment variables, flags, or file content.
|
||||||
|
|
||||||
## Quick Examples: Before vs After
|
## Quick Examples: Before vs After
|
||||||
@@ -89,12 +89,16 @@ 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)
|
||||||
|
- [1Password](#provider-one_password)
|
||||||
- [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)
|
||||||
@@ -139,7 +143,7 @@ You can use the following command to run a bash script that downloads and instal
|
|||||||
OS (Linux/MacOS) and architecture (x86_64/arm64):
|
OS (Linux/MacOS) and architecture (x86_64/arm64):
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
curl -fsSL https://raw.githubusercontent.com/Dark-Alex-17/gman/main/install.sh | bash
|
curl -fsSL https://raw.githubusercontent.com/Dark-Alex-17/gman/main/install_gman.sh | bash
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Windows/Linux/MacOS (`PowerShell`)
|
#### Windows/Linux/MacOS (`PowerShell`)
|
||||||
@@ -174,6 +178,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 +244,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,7 +287,8 @@ 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) | |
|
||||||
| [`1password`](https://1password.com/) | 🕒 | | |
|
| [`gopass`](https://www.gopass.pw/) | ✅ | | |
|
||||||
|
| [`1password`](https://1password.com/) | ✅ | [1Password](#provider-one_password) | |
|
||||||
| [`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 |
|
||||||
| [`lastpass`](https://www.lastpass.com/) | 🕒 | | |
|
| [`lastpass`](https://www.lastpass.com/) | 🕒 | | |
|
||||||
@@ -388,6 +431,62 @@ 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.
|
||||||
|
|
||||||
|
### Provider: `one_password`
|
||||||
|
The `one_password` provider uses the [1Password CLI (`op`)](https://developer.1password.com/docs/cli/) as the backing
|
||||||
|
storage location for secrets.
|
||||||
|
|
||||||
|
- Optional: `vault` (string) to specify which 1Password vault to use. If omitted, the default vault is used.
|
||||||
|
- Optional: `account` (string) to specify which 1Password account to use. Useful if you have multiple accounts. If
|
||||||
|
omitted, the default signed-in account is used.
|
||||||
|
|
||||||
|
Configuration example:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
default_provider: op
|
||||||
|
providers:
|
||||||
|
- name: op
|
||||||
|
type: one_password
|
||||||
|
vault: Production # Optional; if omitted, uses the default vault
|
||||||
|
account: my.1password.com # Optional; if omitted, uses the default account
|
||||||
|
```
|
||||||
|
|
||||||
|
Authentication:
|
||||||
|
- **Interactive**: Run `op signin` to sign in interactively.
|
||||||
|
- **Service Account**: Set the `OP_SERVICE_ACCOUNT_TOKEN` environment variable for non-interactive/CI usage.
|
||||||
|
- **Desktop App Integration**: If the 1Password desktop app is installed and configured, the CLI can use biometric
|
||||||
|
authentication (Touch ID, Windows Hello, etc.).
|
||||||
|
|
||||||
|
Important notes:
|
||||||
|
- Ensure the 1Password CLI (`op`) is installed on your system. Install instructions are at
|
||||||
|
https://developer.1password.com/docs/cli/get-started/.
|
||||||
|
- Secrets are stored as 1Password Password items. The item title is the secret name and the `password` field holds the
|
||||||
|
secret value.
|
||||||
|
- **Deletions are permanent. Deleted items are not archived.**
|
||||||
|
- `add` creates a new Password item. If an item with the same title already exists in the vault, `op` will create a
|
||||||
|
duplicate. Use `update` to change an existing secret value.
|
||||||
|
- `list` returns the titles of all items in the configured vault.
|
||||||
|
|
||||||
## 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 +503,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`.
|
||||||
@@ -556,7 +694,7 @@ gman managarr
|
|||||||
|
|
||||||
### Multiple Providers and Switching
|
### Multiple Providers and Switching
|
||||||
|
|
||||||
You can define multiple providers—even multiple of the same type—and switch between them per command.
|
You can define multiple providers (even multiple of the same type) and switch between them per command.
|
||||||
|
|
||||||
Example: two AWS Secrets Manager providers named `lab` and `prod`.
|
Example: two AWS Secrets Manager providers named `lab` and `prod`.
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,35 @@
|
|||||||
|
# List all recipes
|
||||||
|
default:
|
||||||
|
@just --list
|
||||||
|
|
||||||
|
# Format all files
|
||||||
|
[group: 'style']
|
||||||
|
fmt:
|
||||||
|
@cargo fmt --all
|
||||||
|
|
||||||
|
alias clippy := lint
|
||||||
|
# Run Clippy to inspect all files
|
||||||
|
[group: 'style']
|
||||||
|
lint:
|
||||||
|
@cargo clippy --all
|
||||||
|
|
||||||
|
alias clippy-fix := lint-fix
|
||||||
|
# Automatically fix clippy issues where possible
|
||||||
|
[group: 'style']
|
||||||
|
lint-fix:
|
||||||
|
@cargo fix
|
||||||
|
|
||||||
|
# Run all tests
|
||||||
|
[group: 'test']
|
||||||
|
test:
|
||||||
|
@cargo test --all
|
||||||
|
|
||||||
|
# Build and run the binary for the current system
|
||||||
|
run:
|
||||||
|
@cargo run
|
||||||
|
|
||||||
|
# Build the project for the current system architecture
|
||||||
|
[group: 'build']
|
||||||
|
[arg('build_type', pattern="debug|release")]
|
||||||
|
build build_type='debug':
|
||||||
|
@cargo build {{ if build_type == "release" { "--release" } else { "" } }}
|
||||||
+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") };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+69
-20
@@ -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,22 +96,32 @@ 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)
|
||||||
Sync {},
|
Sync {},
|
||||||
|
|
||||||
|
// TODO: Remove once all users have migrated their local vaults
|
||||||
|
/// Migrate local vault secrets to the current secure encryption format.
|
||||||
|
/// This is only needed if you have secrets encrypted with older versions of gman.
|
||||||
|
/// Only works with the local provider.
|
||||||
|
Migrate {},
|
||||||
|
|
||||||
/// Open and edit the config file in the default text editor
|
/// Open and edit the config file in the default text editor
|
||||||
Config {},
|
Config {},
|
||||||
|
|
||||||
@@ -112,13 +129,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 +139,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 +156,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();
|
||||||
|
|
||||||
@@ -154,7 +165,7 @@ async fn main() -> Result<()> {
|
|||||||
let plaintext =
|
let plaintext =
|
||||||
read_all_stdin().with_context(|| "unable to read plaintext from stdin")?;
|
read_all_stdin().with_context(|| "unable to read plaintext from stdin")?;
|
||||||
secrets_provider
|
secrets_provider
|
||||||
.set_secret(&name, plaintext.trim_end())
|
.set_secret(&name, &plaintext)
|
||||||
.await
|
.await
|
||||||
.map(|_| match cli.output {
|
.map(|_| match cli.output {
|
||||||
Some(_) => (),
|
Some(_) => (),
|
||||||
@@ -185,7 +196,7 @@ async fn main() -> Result<()> {
|
|||||||
let plaintext =
|
let plaintext =
|
||||||
read_all_stdin().with_context(|| "unable to read plaintext from stdin")?;
|
read_all_stdin().with_context(|| "unable to read plaintext from stdin")?;
|
||||||
secrets_provider
|
secrets_provider
|
||||||
.update_secret(&name, plaintext.trim_end())
|
.update_secret(&name, &plaintext)
|
||||||
.await
|
.await
|
||||||
.map(|_| match cli.output {
|
.map(|_| match cli.output {
|
||||||
Some(_) => (),
|
Some(_) => (),
|
||||||
@@ -226,7 +237,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)
|
||||||
@@ -252,14 +264,51 @@ async fn main() -> Result<()> {
|
|||||||
}
|
}
|
||||||
})?;
|
})?;
|
||||||
}
|
}
|
||||||
Commands::External(tokens) => {
|
// TODO: Remove once all users have migrated their local vaults
|
||||||
wrap_and_run_command(secrets_provider, &config, tokens, cli.profile, cli.dry_run)
|
Commands::Migrate {} => {
|
||||||
.await?;
|
use gman::providers::SupportedProvider;
|
||||||
|
use gman::providers::local::LocalProvider;
|
||||||
|
|
||||||
|
let provider_config_for_migrate =
|
||||||
|
config.extract_provider_config(cli.provider.clone())?;
|
||||||
|
|
||||||
|
let local_provider: LocalProvider = match provider_config_for_migrate.provider_type {
|
||||||
|
SupportedProvider::Local { provider_def } => provider_def,
|
||||||
|
_ => {
|
||||||
|
anyhow::bail!("The migrate command only works with the local provider.");
|
||||||
}
|
}
|
||||||
Commands::Completions { shell } => {
|
};
|
||||||
let mut cmd = Cli::command();
|
|
||||||
let bin_name = cmd.get_name().to_string();
|
println!("Migrating vault secrets to current secure format...");
|
||||||
clap_complete::generate(shell, &mut cmd, bin_name, &mut io::stdout());
|
let result = local_provider.migrate_vault().await?;
|
||||||
|
|
||||||
|
if result.total == 0 {
|
||||||
|
println!("Vault is empty, nothing to migrate.");
|
||||||
|
} else {
|
||||||
|
println!(
|
||||||
|
"Migration complete: {} total, {} migrated, {} already current",
|
||||||
|
result.total, result.migrated, result.already_current
|
||||||
|
);
|
||||||
|
|
||||||
|
if !result.failed.is_empty() {
|
||||||
|
eprintln!("\n⚠ Failed to migrate {} secret(s):", result.failed.len());
|
||||||
|
for (key, error) in &result.failed {
|
||||||
|
eprintln!(" - {}: {}", key, error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if result.migrated > 0 {
|
||||||
|
println!(
|
||||||
|
"\n✓ Successfully migrated {} secret(s) to the secure format.",
|
||||||
|
result.migrated
|
||||||
|
);
|
||||||
|
} else if result.failed.is_empty() {
|
||||||
|
println!("\n✓ All secrets are already using the current secure format.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Commands::External(tokens) => {
|
||||||
|
wrap_and_run_command(cli.provider, &config, tokens, cli.profile, cli.dry_run).await?;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -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")?;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+136
-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,14 @@ 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
|
||||||
|
}
|
||||||
|
SupportedProvider::OnePassword { provider_def } => {
|
||||||
|
debug!("Using 1Password provider");
|
||||||
|
provider_def
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -261,48 +273,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 +329,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"
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+73
-31
@@ -20,17 +20,16 @@
|
|||||||
//! 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, password_hash::rand_core::RngCore};
|
||||||
Algorithm, Argon2, Params, Version,
|
|
||||||
password_hash::{SaltString, rand_core::RngCore},
|
|
||||||
};
|
|
||||||
use base64::{Engine as _, engine::general_purpose::STANDARD as B64};
|
use base64::{Engine as _, engine::general_purpose::STANDARD as B64};
|
||||||
use chacha20poly1305::{
|
use chacha20poly1305::{
|
||||||
Key, XChaCha20Poly1305, XNonce,
|
Key, XChaCha20Poly1305, XNonce,
|
||||||
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;
|
||||||
@@ -41,8 +40,8 @@ pub(crate) const HEADER: &str = "$VAULT";
|
|||||||
pub(crate) const VERSION: &str = "v1";
|
pub(crate) const VERSION: &str = "v1";
|
||||||
pub(crate) const KDF: &str = "argon2id";
|
pub(crate) const KDF: &str = "argon2id";
|
||||||
|
|
||||||
pub(crate) const ARGON_M_COST_KIB: u32 = 19_456;
|
pub(crate) const ARGON_M_COST_KIB: u32 = 65_536;
|
||||||
pub(crate) const ARGON_T_COST: u32 = 2;
|
pub(crate) const ARGON_T_COST: u32 = 3;
|
||||||
pub(crate) const ARGON_P: u32 = 1;
|
pub(crate) const ARGON_P: u32 = 1;
|
||||||
|
|
||||||
pub(crate) const SALT_LEN: usize = 16;
|
pub(crate) const SALT_LEN: usize = 16;
|
||||||
@@ -59,7 +58,7 @@ fn derive_key(password: &SecretString, salt: &[u8]) -> Result<Key> {
|
|||||||
.hash_password_into(password.expose_secret().as_bytes(), salt, &mut key_bytes)
|
.hash_password_into(password.expose_secret().as_bytes(), salt, &mut key_bytes)
|
||||||
.map_err(|e| anyhow!("argon2 into error: {:?}", e))?;
|
.map_err(|e| anyhow!("argon2 into error: {:?}", e))?;
|
||||||
|
|
||||||
let key = *Key::from_slice(&key_bytes);
|
let key: Key = key_bytes.into();
|
||||||
key_bytes.zeroize();
|
key_bytes.zeroize();
|
||||||
Ok(key)
|
Ok(key)
|
||||||
}
|
}
|
||||||
@@ -82,20 +81,28 @@ fn derive_key(password: &SecretString, salt: &[u8]) -> Result<Key> {
|
|||||||
pub fn encrypt_string(password: impl Into<SecretString>, plaintext: &str) -> Result<String> {
|
pub fn encrypt_string(password: impl Into<SecretString>, plaintext: &str) -> Result<String> {
|
||||||
let password = password.into();
|
let password = password.into();
|
||||||
|
|
||||||
let salt = SaltString::generate(&mut OsRng);
|
if password.expose_secret().is_empty() {
|
||||||
|
bail!("password cannot be empty");
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut salt = [0u8; SALT_LEN];
|
||||||
|
OsRng.fill_bytes(&mut salt);
|
||||||
let mut nonce_bytes = [0u8; NONCE_LEN];
|
let mut nonce_bytes = [0u8; NONCE_LEN];
|
||||||
OsRng.fill_bytes(&mut nonce_bytes);
|
OsRng.fill_bytes(&mut nonce_bytes);
|
||||||
|
|
||||||
let key = derive_key(&password, salt.as_str().as_bytes())?;
|
let mut key = derive_key(&password, &salt)?;
|
||||||
let cipher = XChaCha20Poly1305::new(&key);
|
let cipher = XChaCha20Poly1305::new(&key);
|
||||||
|
|
||||||
let aad = format!("{};{}", HEADER, VERSION);
|
let aad = format!(
|
||||||
|
"{};{};{};m={},t={},p={}",
|
||||||
|
HEADER, VERSION, KDF, ARGON_M_COST_KIB, ARGON_T_COST, ARGON_P
|
||||||
|
);
|
||||||
|
|
||||||
let nonce = XNonce::from_slice(&nonce_bytes);
|
let nonce: XNonce = nonce_bytes.into();
|
||||||
let mut pt = plaintext.as_bytes().to_vec();
|
let mut pt = plaintext.as_bytes().to_vec();
|
||||||
let ct = cipher
|
let ct = cipher
|
||||||
.encrypt(
|
.encrypt(
|
||||||
nonce,
|
&nonce,
|
||||||
chacha20poly1305::aead::Payload {
|
chacha20poly1305::aead::Payload {
|
||||||
msg: &pt,
|
msg: &pt,
|
||||||
aad: aad.as_bytes(),
|
aad: aad.as_bytes(),
|
||||||
@@ -113,13 +120,14 @@ pub fn encrypt_string(password: impl Into<SecretString>, plaintext: &str) -> Res
|
|||||||
m = ARGON_M_COST_KIB,
|
m = ARGON_M_COST_KIB,
|
||||||
t = ARGON_T_COST,
|
t = ARGON_T_COST,
|
||||||
p = ARGON_P,
|
p = ARGON_P,
|
||||||
salt = B64.encode(salt.as_str().as_bytes()),
|
salt = B64.encode(salt),
|
||||||
nonce = B64.encode(nonce_bytes),
|
nonce = B64.encode(nonce_bytes),
|
||||||
ct = B64.encode(&ct),
|
ct = B64.encode(&ct),
|
||||||
);
|
);
|
||||||
|
|
||||||
drop(cipher);
|
drop(cipher);
|
||||||
let _ = key;
|
key.zeroize();
|
||||||
|
salt.zeroize();
|
||||||
nonce_bytes.zeroize();
|
nonce_bytes.zeroize();
|
||||||
|
|
||||||
Ok(env)
|
Ok(env)
|
||||||
@@ -130,6 +138,9 @@ pub fn encrypt_string(password: impl Into<SecretString>, plaintext: &str) -> Res
|
|||||||
/// Returns the original plaintext on success or an error if the password is
|
/// Returns the original plaintext on success or an error if the password is
|
||||||
/// wrong, the envelope was tampered with, or the input is malformed.
|
/// wrong, the envelope was tampered with, or the input is malformed.
|
||||||
///
|
///
|
||||||
|
/// This function supports both the current format (with KDF params in AAD) and
|
||||||
|
/// the legacy format (without KDF params in AAD) for backwards compatibility.
|
||||||
|
///
|
||||||
/// Example
|
/// Example
|
||||||
/// ```
|
/// ```
|
||||||
/// use gman::{encrypt_string, decrypt_string};
|
/// use gman::{encrypt_string, decrypt_string};
|
||||||
@@ -143,6 +154,10 @@ pub fn encrypt_string(password: impl Into<SecretString>, plaintext: &str) -> Res
|
|||||||
pub fn decrypt_string(password: impl Into<SecretString>, envelope: &str) -> Result<String> {
|
pub fn decrypt_string(password: impl Into<SecretString>, envelope: &str) -> Result<String> {
|
||||||
let password = password.into();
|
let password = password.into();
|
||||||
|
|
||||||
|
if password.expose_secret().is_empty() {
|
||||||
|
bail!("password cannot be empty");
|
||||||
|
}
|
||||||
|
|
||||||
let parts: Vec<&str> = envelope.split(';').collect();
|
let parts: Vec<&str> = envelope.split(';').collect();
|
||||||
if parts.len() < 7 {
|
if parts.len() < 7 {
|
||||||
bail!("invalid envelope format");
|
bail!("invalid envelope format");
|
||||||
@@ -176,37 +191,66 @@ pub fn decrypt_string(password: impl Into<SecretString>, envelope: &str) -> Resu
|
|||||||
let nonce_b64 = parts[5].strip_prefix("nonce=").context("missing nonce")?;
|
let nonce_b64 = parts[5].strip_prefix("nonce=").context("missing nonce")?;
|
||||||
let ct_b64 = parts[6].strip_prefix("ct=").context("missing ct")?;
|
let ct_b64 = parts[6].strip_prefix("ct=").context("missing ct")?;
|
||||||
|
|
||||||
let salt_bytes = B64.decode(salt_b64).context("bad salt b64")?;
|
let mut salt_bytes = B64.decode(salt_b64).context("bad salt b64")?;
|
||||||
let mut nonce_bytes = B64.decode(nonce_b64).context("bad nonce b64")?;
|
let nonce_bytes = B64.decode(nonce_b64).context("bad nonce b64")?;
|
||||||
let mut ct = B64.decode(ct_b64).context("bad ct b64")?;
|
let mut ct = B64.decode(ct_b64).context("bad ct b64")?;
|
||||||
|
|
||||||
if nonce_bytes.len() != NONCE_LEN {
|
if nonce_bytes.len() != NONCE_LEN {
|
||||||
bail!("nonce length mismatch");
|
bail!("nonce length mismatch");
|
||||||
}
|
}
|
||||||
|
|
||||||
let key = derive_key(&password, &salt_bytes)?;
|
let mut key = derive_key(&password, &salt_bytes)?;
|
||||||
|
|
||||||
let cipher = XChaCha20Poly1305::new(&key);
|
let cipher = XChaCha20Poly1305::new(&key);
|
||||||
|
|
||||||
let aad = format!("{};{}", HEADER, VERSION);
|
let aad_new = format!("{};{};{};m={},t={},p={}", HEADER, VERSION, KDF, m, t, p);
|
||||||
let nonce = XNonce::from_slice(&nonce_bytes);
|
let aad_legacy = format!("{};{}", HEADER, VERSION);
|
||||||
let pt = cipher
|
|
||||||
.decrypt(
|
let mut nonce_arr: [u8; NONCE_LEN] = nonce_bytes
|
||||||
nonce,
|
.try_into()
|
||||||
|
.map_err(|_| anyhow!("invalid nonce length"))?;
|
||||||
|
let nonce: XNonce = nonce_arr.into();
|
||||||
|
|
||||||
|
let decrypt_result = cipher.decrypt(
|
||||||
|
&nonce,
|
||||||
chacha20poly1305::aead::Payload {
|
chacha20poly1305::aead::Payload {
|
||||||
msg: &ct,
|
msg: &ct,
|
||||||
aad: aad.as_bytes(),
|
aad: aad_new.as_bytes(),
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut pt = match decrypt_result {
|
||||||
|
Ok(pt) => pt,
|
||||||
|
Err(_) => cipher
|
||||||
|
.decrypt(
|
||||||
|
&nonce,
|
||||||
|
chacha20poly1305::aead::Payload {
|
||||||
|
msg: &ct,
|
||||||
|
aad: aad_legacy.as_bytes(),
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
.map_err(|_| anyhow!("decryption failed (wrong password or corrupted data)"))?;
|
.map_err(|_| anyhow!("decryption failed (wrong password or corrupted data)"))?,
|
||||||
|
};
|
||||||
|
|
||||||
nonce_bytes.zeroize();
|
let s = String::from_utf8(pt.clone()).context("plaintext not valid UTF-8")?;
|
||||||
|
|
||||||
|
key.zeroize();
|
||||||
|
salt_bytes.zeroize();
|
||||||
|
nonce_arr.zeroize();
|
||||||
ct.zeroize();
|
ct.zeroize();
|
||||||
|
pt.zeroize();
|
||||||
|
|
||||||
let s = String::from_utf8(pt).context("plaintext not valid UTF-8")?;
|
|
||||||
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::*;
|
||||||
@@ -237,12 +281,10 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn empty_password() {
|
fn empty_password_rejected() {
|
||||||
let pw = SecretString::new("".into());
|
let pw = SecretString::new("".into());
|
||||||
let msg = "hello";
|
let msg = "hello";
|
||||||
let env = encrypt_string(pw.clone(), msg).unwrap();
|
assert!(encrypt_string(pw.clone(), msg).is_err());
|
||||||
let out = decrypt_string(pw, &env).unwrap();
|
|
||||||
assert_eq!(msg, out);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -264,7 +306,7 @@ mod tests {
|
|||||||
let mut ct = base64::engine::general_purpose::STANDARD
|
let mut ct = base64::engine::general_purpose::STANDARD
|
||||||
.decode(ct_b64)
|
.decode(ct_b64)
|
||||||
.unwrap();
|
.unwrap();
|
||||||
ct[0] ^= 0x01; // Flip a bit
|
ct[0] ^= 0x01;
|
||||||
let new_ct_b64 = base64::engine::general_purpose::STANDARD.encode(&ct);
|
let new_ct_b64 = base64::engine::general_purpose::STANDARD.encode(&ct);
|
||||||
let new_ct_part = format!("ct={}", new_ct_b64);
|
let new_ct_part = format!("ct={}", new_ct_b64);
|
||||||
parts[6] = &new_ct_part;
|
parts[6] = &new_ct_part;
|
||||||
|
|||||||
@@ -1,11 +1,13 @@
|
|||||||
use crate::providers::SecretProvider;
|
use crate::providers::SecretProvider;
|
||||||
use anyhow::{Context, Result};
|
use anyhow::{Context, Result};
|
||||||
use azure_identity::DefaultAzureCredential;
|
use azure_core::credentials::TokenCredential;
|
||||||
|
use azure_identity::DeveloperToolsCredential;
|
||||||
use azure_security_keyvault_secrets::models::SetSecretParameters;
|
use azure_security_keyvault_secrets::models::SetSecretParameters;
|
||||||
use azure_security_keyvault_secrets::{ResourceExt, SecretClient};
|
use azure_security_keyvault_secrets::{ResourceExt, SecretClient};
|
||||||
use futures::TryStreamExt;
|
use futures::TryStreamExt;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use serde_with::skip_serializing_none;
|
use serde_with::skip_serializing_none;
|
||||||
|
use std::sync::Arc;
|
||||||
use validator::Validate;
|
use validator::Validate;
|
||||||
|
|
||||||
#[skip_serializing_none]
|
#[skip_serializing_none]
|
||||||
@@ -40,12 +42,8 @@ impl SecretProvider for AzureKeyVaultProvider {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async fn get_secret(&self, key: &str) -> Result<String> {
|
async fn get_secret(&self, key: &str) -> Result<String> {
|
||||||
let body = self
|
let response = self.get_client()?.get_secret(key, None).await?;
|
||||||
.get_client()?
|
let body = response.into_model()?;
|
||||||
.get_secret(key, "", None)
|
|
||||||
.await?
|
|
||||||
.into_body()
|
|
||||||
.await?;
|
|
||||||
|
|
||||||
body.value
|
body.value
|
||||||
.with_context(|| format!("Secret '{}' not found", key))
|
.with_context(|| format!("Secret '{}' not found", key))
|
||||||
@@ -60,8 +58,7 @@ impl SecretProvider for AzureKeyVaultProvider {
|
|||||||
self.get_client()?
|
self.get_client()?
|
||||||
.set_secret(key, params.try_into()?, None)
|
.set_secret(key, params.try_into()?, None)
|
||||||
.await?
|
.await?
|
||||||
.into_body()
|
.into_model()?;
|
||||||
.await?;
|
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
@@ -77,10 +74,7 @@ impl SecretProvider for AzureKeyVaultProvider {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async fn list_secrets(&self) -> Result<Vec<String>> {
|
async fn list_secrets(&self) -> Result<Vec<String>> {
|
||||||
let mut pager = self
|
let mut pager = self.get_client()?.list_secret_properties(None)?;
|
||||||
.get_client()?
|
|
||||||
.list_secret_properties(None)?
|
|
||||||
.into_stream();
|
|
||||||
let mut secrets = Vec::new();
|
let mut secrets = Vec::new();
|
||||||
while let Some(props) = pager.try_next().await? {
|
while let Some(props) = pager.try_next().await? {
|
||||||
let name = props.resource_id()?.name;
|
let name = props.resource_id()?.name;
|
||||||
@@ -93,7 +87,7 @@ impl SecretProvider for AzureKeyVaultProvider {
|
|||||||
|
|
||||||
impl AzureKeyVaultProvider {
|
impl AzureKeyVaultProvider {
|
||||||
fn get_client(&self) -> Result<SecretClient> {
|
fn get_client(&self) -> Result<SecretClient> {
|
||||||
let credential = DefaultAzureCredential::new()?;
|
let credential: Arc<dyn TokenCredential> = DeveloperToolsCredential::new(None)?;
|
||||||
let client = SecretClient::new(
|
let client = SecretClient::new(
|
||||||
format!(
|
format!(
|
||||||
"https://{}.vault.azure.net",
|
"https://{}.vault.azure.net",
|
||||||
|
|||||||
@@ -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(())
|
||||||
|
}
|
||||||
|
}
|
||||||
+295
-43
@@ -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,
|
||||||
@@ -152,7 +158,8 @@ impl SecretProvider for LocalProvider {
|
|||||||
async fn list_secrets(&self) -> Result<Vec<String>> {
|
async fn list_secrets(&self) -> Result<Vec<String>> {
|
||||||
let vault_path = self.active_vault_path()?;
|
let vault_path = self.active_vault_path()?;
|
||||||
let vault: HashMap<String, String> = load_vault(&vault_path).unwrap_or_default();
|
let vault: HashMap<String, String> = load_vault(&vault_path).unwrap_or_default();
|
||||||
let keys: Vec<String> = vault.keys().cloned().collect();
|
let mut keys: Vec<String> = vault.keys().cloned().collect();
|
||||||
|
keys.sort();
|
||||||
|
|
||||||
Ok(keys)
|
Ok(keys)
|
||||||
}
|
}
|
||||||
@@ -247,7 +254,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 +293,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")?;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -315,6 +322,22 @@ impl LocalProvider {
|
|||||||
|
|
||||||
fn get_password(&self) -> Result<SecretString> {
|
fn get_password(&self) -> Result<SecretString> {
|
||||||
if let Some(password_file) = &self.password_file {
|
if let Some(password_file) = &self.password_file {
|
||||||
|
#[cfg(unix)]
|
||||||
|
{
|
||||||
|
use std::os::unix::fs::PermissionsExt;
|
||||||
|
let metadata = fs::metadata(password_file).with_context(|| {
|
||||||
|
format!("failed to read password file metadata {:?}", password_file)
|
||||||
|
})?;
|
||||||
|
let mode = metadata.permissions().mode();
|
||||||
|
if mode & 0o077 != 0 {
|
||||||
|
bail!(
|
||||||
|
"password file {:?} has insecure permissions {:o} (should be 0600 or 0400)",
|
||||||
|
password_file,
|
||||||
|
mode & 0o777
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
let password = SecretString::new(
|
let password = SecretString::new(
|
||||||
fs::read_to_string(password_file)
|
fs::read_to_string(password_file)
|
||||||
.with_context(|| format!("failed to read password file {:?}", password_file))?
|
.with_context(|| format!("failed to read password file {:?}", password_file))?
|
||||||
@@ -335,10 +358,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> {
|
||||||
@@ -362,24 +386,41 @@ fn store_vault(path: &Path, map: &HashMap<String, String>) -> Result<()> {
|
|||||||
fs::create_dir_all(parent).with_context(|| format!("create {}", parent.display()))?;
|
fs::create_dir_all(parent).with_context(|| format!("create {}", parent.display()))?;
|
||||||
}
|
}
|
||||||
let s = serde_yaml::to_string(map).with_context(|| "serialize vault")?;
|
let s = serde_yaml::to_string(map).with_context(|| "serialize vault")?;
|
||||||
fs::write(path, s).with_context(|| format!("write {}", path.display()))
|
fs::write(path, &s).with_context(|| format!("write {}", path.display()))?;
|
||||||
|
|
||||||
|
#[cfg(unix)]
|
||||||
|
{
|
||||||
|
use std::os::unix::fs::PermissionsExt;
|
||||||
|
fs::set_permissions(path, fs::Permissions::from_mode(0o600))
|
||||||
|
.with_context(|| format!("set permissions on {}", path.display()))?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn encrypt_string(password: &SecretString, plaintext: &str) -> Result<String> {
|
fn encrypt_string(password: &SecretString, plaintext: &str) -> Result<String> {
|
||||||
|
if password.expose_secret().is_empty() {
|
||||||
|
bail!("password cannot be empty");
|
||||||
|
}
|
||||||
|
|
||||||
let mut salt = [0u8; SALT_LEN];
|
let mut salt = [0u8; SALT_LEN];
|
||||||
OsRng.fill_bytes(&mut salt);
|
OsRng.fill_bytes(&mut salt);
|
||||||
let mut nonce_bytes = [0u8; NONCE_LEN];
|
let mut nonce_bytes = [0u8; NONCE_LEN];
|
||||||
OsRng.fill_bytes(&mut nonce_bytes);
|
OsRng.fill_bytes(&mut nonce_bytes);
|
||||||
|
|
||||||
let key = derive_key(password, &salt)?;
|
let mut key = derive_key(password, &salt)?;
|
||||||
let cipher = XChaCha20Poly1305::new(&key);
|
let cipher = XChaCha20Poly1305::new(&key);
|
||||||
let aad = format!("{};{}", HEADER, VERSION);
|
|
||||||
|
|
||||||
let nonce = XNonce::from_slice(&nonce_bytes);
|
let aad = format!(
|
||||||
|
"{};{};{};m={},t={},p={}",
|
||||||
|
HEADER, VERSION, KDF, ARGON_M_COST_KIB, ARGON_T_COST, ARGON_P
|
||||||
|
);
|
||||||
|
|
||||||
|
let nonce: XNonce = nonce_bytes.into();
|
||||||
let mut pt = plaintext.as_bytes().to_vec();
|
let mut pt = plaintext.as_bytes().to_vec();
|
||||||
let ct = cipher
|
let ct = cipher
|
||||||
.encrypt(
|
.encrypt(
|
||||||
nonce,
|
&nonce,
|
||||||
chacha20poly1305::aead::Payload {
|
chacha20poly1305::aead::Payload {
|
||||||
msg: &pt,
|
msg: &pt,
|
||||||
aad: aad.as_bytes(),
|
aad: aad.as_bytes(),
|
||||||
@@ -402,6 +443,7 @@ fn encrypt_string(password: &SecretString, plaintext: &str) -> Result<String> {
|
|||||||
);
|
);
|
||||||
|
|
||||||
drop(cipher);
|
drop(cipher);
|
||||||
|
key.zeroize();
|
||||||
salt.zeroize();
|
salt.zeroize();
|
||||||
nonce_bytes.zeroize();
|
nonce_bytes.zeroize();
|
||||||
|
|
||||||
@@ -422,16 +464,30 @@ fn derive_key_with_params(
|
|||||||
argon
|
argon
|
||||||
.hash_password_into(password.expose_secret().as_bytes(), salt, &mut key_bytes)
|
.hash_password_into(password.expose_secret().as_bytes(), salt, &mut key_bytes)
|
||||||
.map_err(|e| anyhow!("argon2 derive error: {:?}", e))?;
|
.map_err(|e| anyhow!("argon2 derive error: {:?}", e))?;
|
||||||
|
let key: Key = key_bytes.into();
|
||||||
key_bytes.zeroize();
|
key_bytes.zeroize();
|
||||||
let key = Key::from_slice(&key_bytes);
|
Ok(key)
|
||||||
Ok(*key)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn derive_key(password: &SecretString, salt: &[u8]) -> Result<Key> {
|
fn derive_key(password: &SecretString, salt: &[u8]) -> Result<Key> {
|
||||||
derive_key_with_params(password, salt, ARGON_M_COST_KIB, ARGON_T_COST, ARGON_P)
|
derive_key_with_params(password, salt, ARGON_M_COST_KIB, ARGON_T_COST, ARGON_P)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn decrypt_string(password: &SecretString, envelope: &str) -> Result<String> {
|
/// Attempts to decrypt with the given cipher, nonce, ciphertext, and AAD.
|
||||||
|
fn try_decrypt(
|
||||||
|
cipher: &XChaCha20Poly1305,
|
||||||
|
nonce: &XNonce,
|
||||||
|
ct: &[u8],
|
||||||
|
aad: &[u8],
|
||||||
|
) -> std::result::Result<Vec<u8>, chacha20poly1305::aead::Error> {
|
||||||
|
cipher.decrypt(nonce, chacha20poly1305::aead::Payload { msg: ct, aad })
|
||||||
|
}
|
||||||
|
|
||||||
|
type EnvelopeComponents = (u32, u32, u32, Vec<u8>, [u8; NONCE_LEN], Vec<u8>);
|
||||||
|
|
||||||
|
/// Parse an envelope string and extract its components.
|
||||||
|
/// Returns (m, t, p, salt, nonce_arr, ct) on success.
|
||||||
|
fn parse_envelope(envelope: &str) -> Result<EnvelopeComponents> {
|
||||||
let parts: Vec<&str> = envelope.trim().split(';').collect();
|
let parts: Vec<&str> = envelope.trim().split(';').collect();
|
||||||
if parts.len() < 7 {
|
if parts.len() < 7 {
|
||||||
debug!("Invalid envelope format: {:?}", parts);
|
debug!("Invalid envelope format: {:?}", parts);
|
||||||
@@ -473,40 +529,202 @@ fn decrypt_string(password: &SecretString, envelope: &str) -> Result<String> {
|
|||||||
.with_context(|| "missing nonce")?;
|
.with_context(|| "missing nonce")?;
|
||||||
let ct_b64 = parts[6].strip_prefix("ct=").with_context(|| "missing ct")?;
|
let ct_b64 = parts[6].strip_prefix("ct=").with_context(|| "missing ct")?;
|
||||||
|
|
||||||
let mut salt = B64.decode(salt_b64).with_context(|| "bad salt b64")?;
|
let salt = B64.decode(salt_b64).with_context(|| "bad salt b64")?;
|
||||||
let mut nonce_bytes = B64.decode(nonce_b64).with_context(|| "bad nonce b64")?;
|
let nonce_bytes = B64.decode(nonce_b64).with_context(|| "bad nonce b64")?;
|
||||||
let mut ct = B64.decode(ct_b64).with_context(|| "bad ct b64")?;
|
let ct = B64.decode(ct_b64).with_context(|| "bad ct b64")?;
|
||||||
|
|
||||||
if salt.len() != SALT_LEN || nonce_bytes.len() != NONCE_LEN {
|
if nonce_bytes.len() != NONCE_LEN {
|
||||||
debug!(
|
debug!("Nonce length mismatch: {}", nonce_bytes.len());
|
||||||
"Salt/nonce length mismatch: salt {}, nonce {}",
|
bail!("nonce length mismatch");
|
||||||
salt.len(),
|
|
||||||
nonce_bytes.len()
|
|
||||||
);
|
|
||||||
bail!("salt/nonce length mismatch");
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let key = derive_key_with_params(password, &salt, m, t, p)?;
|
let nonce_arr: [u8; NONCE_LEN] = nonce_bytes
|
||||||
|
.try_into()
|
||||||
|
.map_err(|_| anyhow!("invalid nonce length"))?;
|
||||||
|
|
||||||
|
Ok((m, t, p, salt, nonce_arr, ct))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn decrypt_string(password: &SecretString, envelope: &str) -> Result<String> {
|
||||||
|
if password.expose_secret().is_empty() {
|
||||||
|
bail!("password cannot be empty");
|
||||||
|
}
|
||||||
|
|
||||||
|
let (m, t, p, mut salt, mut nonce_arr, mut ct) = parse_envelope(envelope)?;
|
||||||
|
let nonce: XNonce = nonce_arr.into();
|
||||||
|
|
||||||
|
let aad_current = format!("{};{};{};m={},t={},p={}", HEADER, VERSION, KDF, m, t, p);
|
||||||
|
|
||||||
|
let mut key = derive_key_with_params(password, &salt, m, t, p)?;
|
||||||
let cipher = XChaCha20Poly1305::new(&key);
|
let cipher = XChaCha20Poly1305::new(&key);
|
||||||
let aad = format!("{};{}", HEADER, VERSION);
|
|
||||||
let nonce = XNonce::from_slice(&nonce_bytes);
|
|
||||||
|
|
||||||
let pt = cipher
|
|
||||||
.decrypt(
|
|
||||||
nonce,
|
|
||||||
chacha20poly1305::aead::Payload {
|
|
||||||
msg: &ct,
|
|
||||||
aad: aad.as_bytes(),
|
|
||||||
},
|
|
||||||
)
|
|
||||||
.map_err(|_| anyhow!("decryption failed (wrong password or corrupted data)"))?;
|
|
||||||
|
|
||||||
|
if let Ok(pt) = try_decrypt(&cipher, &nonce, &ct, aad_current.as_bytes()) {
|
||||||
|
let s = String::from_utf8(pt.clone()).with_context(|| "plaintext not valid UTF-8")?;
|
||||||
|
key.zeroize();
|
||||||
salt.zeroize();
|
salt.zeroize();
|
||||||
nonce_bytes.zeroize();
|
nonce_arr.zeroize();
|
||||||
|
ct.zeroize();
|
||||||
|
return Ok(s);
|
||||||
|
}
|
||||||
|
|
||||||
|
key.zeroize();
|
||||||
|
salt.zeroize();
|
||||||
|
nonce_arr.zeroize();
|
||||||
ct.zeroize();
|
ct.zeroize();
|
||||||
|
|
||||||
let s = String::from_utf8(pt).with_context(|| "plaintext not valid UTF-8")?;
|
// TODO: Remove once all users have migrated their local vaults
|
||||||
Ok(s)
|
if let Ok(plaintext) = legacy::decrypt_string_legacy(password, envelope) {
|
||||||
|
return Ok(plaintext);
|
||||||
|
}
|
||||||
|
|
||||||
|
bail!("decryption failed (wrong password or corrupted data)")
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: Remove this entire module once all users have migrated their vaults.
|
||||||
|
mod legacy {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
fn legacy_aad() -> String {
|
||||||
|
format!("{};{}", HEADER, VERSION)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn decrypt_string_legacy(password: &SecretString, envelope: &str) -> Result<String> {
|
||||||
|
if password.expose_secret().is_empty() {
|
||||||
|
bail!("password cannot be empty");
|
||||||
|
}
|
||||||
|
|
||||||
|
let (m, t, p, mut salt, mut nonce_arr, mut ct) = parse_envelope(envelope)?;
|
||||||
|
let nonce: XNonce = nonce_arr.into();
|
||||||
|
let aad = legacy_aad();
|
||||||
|
|
||||||
|
let mut key = derive_key_with_params(password, &salt, m, t, p)?;
|
||||||
|
let cipher = XChaCha20Poly1305::new(&key);
|
||||||
|
|
||||||
|
if let Ok(pt) = try_decrypt(&cipher, &nonce, &ct, aad.as_bytes()) {
|
||||||
|
let s = String::from_utf8(pt.clone()).with_context(|| "plaintext not valid UTF-8")?;
|
||||||
|
key.zeroize();
|
||||||
|
salt.zeroize();
|
||||||
|
nonce_arr.zeroize();
|
||||||
|
ct.zeroize();
|
||||||
|
return Ok(s);
|
||||||
|
}
|
||||||
|
|
||||||
|
key.zeroize();
|
||||||
|
|
||||||
|
let mut zeros_key: Key = [0u8; KEY_LEN].into();
|
||||||
|
let zeros_cipher = XChaCha20Poly1305::new(&zeros_key);
|
||||||
|
|
||||||
|
if let Ok(pt) = try_decrypt(&zeros_cipher, &nonce, &ct, aad.as_bytes()) {
|
||||||
|
debug!("Decrypted using legacy all-zeros key - secret needs migration");
|
||||||
|
let s = String::from_utf8(pt.clone()).with_context(|| "plaintext not valid UTF-8")?;
|
||||||
|
zeros_key.zeroize();
|
||||||
|
salt.zeroize();
|
||||||
|
nonce_arr.zeroize();
|
||||||
|
ct.zeroize();
|
||||||
|
return Ok(s);
|
||||||
|
}
|
||||||
|
|
||||||
|
zeros_key.zeroize();
|
||||||
|
salt.zeroize();
|
||||||
|
nonce_arr.zeroize();
|
||||||
|
ct.zeroize();
|
||||||
|
|
||||||
|
bail!("legacy decryption failed")
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn is_current_format(password: &SecretString, envelope: &str) -> Result<bool> {
|
||||||
|
if password.expose_secret().is_empty() {
|
||||||
|
bail!("password cannot be empty");
|
||||||
|
}
|
||||||
|
|
||||||
|
let (m, t, p, salt, nonce_arr, ct) = parse_envelope(envelope)?;
|
||||||
|
let nonce: XNonce = nonce_arr.into();
|
||||||
|
|
||||||
|
let aad_current = format!("{};{};{};m={},t={},p={}", HEADER, VERSION, KDF, m, t, p);
|
||||||
|
let key = derive_key_with_params(password, &salt, m, t, p)?;
|
||||||
|
let cipher = XChaCha20Poly1305::new(&key);
|
||||||
|
|
||||||
|
Ok(try_decrypt(&cipher, &nonce, &ct, aad_current.as_bytes()).is_ok())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: Remove once all users have migrated their local vaults
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub enum SecretStatus {
|
||||||
|
Current,
|
||||||
|
NeedsMigration,
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: Remove once all users have migrated their local vaults
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct MigrationResult {
|
||||||
|
pub total: usize,
|
||||||
|
pub migrated: usize,
|
||||||
|
pub already_current: usize,
|
||||||
|
pub failed: Vec<(String, String)>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl LocalProvider {
|
||||||
|
// TODO: Remove once all users have migrated their local vaults
|
||||||
|
pub async fn migrate_vault(&self) -> Result<MigrationResult> {
|
||||||
|
let vault_path = self.active_vault_path()?;
|
||||||
|
let vault: HashMap<String, String> = load_vault(&vault_path).unwrap_or_default();
|
||||||
|
|
||||||
|
if vault.is_empty() {
|
||||||
|
return Ok(MigrationResult {
|
||||||
|
total: 0,
|
||||||
|
migrated: 0,
|
||||||
|
already_current: 0,
|
||||||
|
failed: vec![],
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
let password = self.get_password()?;
|
||||||
|
let mut migrated_vault = HashMap::new();
|
||||||
|
let mut migrated_count = 0;
|
||||||
|
let mut already_current_count = 0;
|
||||||
|
let mut failed = vec![];
|
||||||
|
|
||||||
|
for (key, envelope) in &vault {
|
||||||
|
match legacy::is_current_format(&password, envelope) {
|
||||||
|
Ok(true) => {
|
||||||
|
migrated_vault.insert(key.clone(), envelope.clone());
|
||||||
|
already_current_count += 1;
|
||||||
|
}
|
||||||
|
Ok(false) => match decrypt_string(&password, envelope) {
|
||||||
|
Ok(plaintext) => match encrypt_string(&password, &plaintext) {
|
||||||
|
Ok(new_envelope) => {
|
||||||
|
migrated_vault.insert(key.clone(), new_envelope);
|
||||||
|
migrated_count += 1;
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
failed.push((key.clone(), format!("re-encryption failed: {}", e)));
|
||||||
|
migrated_vault.insert(key.clone(), envelope.clone());
|
||||||
|
}
|
||||||
|
},
|
||||||
|
Err(e) => {
|
||||||
|
failed.push((key.clone(), format!("decryption failed: {}", e)));
|
||||||
|
migrated_vault.insert(key.clone(), envelope.clone());
|
||||||
|
}
|
||||||
|
},
|
||||||
|
Err(e) => {
|
||||||
|
failed.push((key.clone(), format!("status check failed: {}", e)));
|
||||||
|
migrated_vault.insert(key.clone(), envelope.clone());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if migrated_count > 0 {
|
||||||
|
store_vault(&vault_path, &migrated_vault)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(MigrationResult {
|
||||||
|
total: vault.len(),
|
||||||
|
migrated: migrated_count,
|
||||||
|
already_current: already_current_count,
|
||||||
|
failed,
|
||||||
|
})
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
@@ -522,7 +740,7 @@ mod tests {
|
|||||||
let password = SecretString::new("test_password".to_string().into());
|
let password = SecretString::new("test_password".to_string().into());
|
||||||
let salt = [0u8; 16];
|
let salt = [0u8; 16];
|
||||||
let key = derive_key(&password, &salt).unwrap();
|
let key = derive_key(&password, &salt).unwrap();
|
||||||
assert_eq!(key.as_slice().len(), 32);
|
assert_eq!(key.len(), 32);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -530,7 +748,7 @@ mod tests {
|
|||||||
let password = SecretString::new("test_password".to_string().into());
|
let password = SecretString::new("test_password".to_string().into());
|
||||||
let salt = [0u8; 16];
|
let salt = [0u8; 16];
|
||||||
let key = derive_key_with_params(&password, &salt, 10, 1, 1).unwrap();
|
let key = derive_key_with_params(&password, &salt, 10, 1, 1).unwrap();
|
||||||
assert_eq!(key.as_slice().len(), 32);
|
assert_eq!(key.len(), 32);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -543,6 +761,40 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
#[cfg(unix)]
|
||||||
|
fn get_password_reads_password_file() {
|
||||||
|
use std::os::unix::fs::PermissionsExt;
|
||||||
|
let dir = tempdir().unwrap();
|
||||||
|
let file = dir.path().join("pw.txt");
|
||||||
|
fs::write(&file, "secretpw\n").unwrap();
|
||||||
|
fs::set_permissions(&file, fs::Permissions::from_mode(0o600)).unwrap();
|
||||||
|
let provider = LocalProvider {
|
||||||
|
password_file: Some(file),
|
||||||
|
runtime_provider_name: None,
|
||||||
|
..LocalProvider::default()
|
||||||
|
};
|
||||||
|
let pw = provider.get_password().unwrap();
|
||||||
|
assert_eq!(pw.expose_secret(), "secretpw");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[cfg(unix)]
|
||||||
|
fn get_password_rejects_insecure_file() {
|
||||||
|
use std::os::unix::fs::PermissionsExt;
|
||||||
|
let dir = tempdir().unwrap();
|
||||||
|
let file = dir.path().join("pw.txt");
|
||||||
|
fs::write(&file, "secretpw\n").unwrap();
|
||||||
|
fs::set_permissions(&file, fs::Permissions::from_mode(0o644)).unwrap();
|
||||||
|
let provider = LocalProvider {
|
||||||
|
password_file: Some(file),
|
||||||
|
runtime_provider_name: None,
|
||||||
|
..LocalProvider::default()
|
||||||
|
};
|
||||||
|
assert!(provider.get_password().is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[cfg(not(unix))]
|
||||||
fn get_password_reads_password_file() {
|
fn get_password_reads_password_file() {
|
||||||
let dir = tempdir().unwrap();
|
let dir = tempdir().unwrap();
|
||||||
let file = dir.path().join("pw.txt");
|
let file = dir.path().join("pw.txt");
|
||||||
@@ -560,7 +812,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);
|
||||||
|
|||||||
+24
-3
@@ -6,17 +6,26 @@ 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;
|
||||||
|
pub mod one_password;
|
||||||
|
|
||||||
|
use crate::providers::gopass::GopassProvider;
|
||||||
use crate::providers::local::LocalProvider;
|
use crate::providers::local::LocalProvider;
|
||||||
use anyhow::{Result, anyhow};
|
use crate::providers::one_password::OnePasswordProvider;
|
||||||
|
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 +72,15 @@ pub enum SupportedProvider {
|
|||||||
},
|
},
|
||||||
AzureKeyVault {
|
AzureKeyVault {
|
||||||
#[serde(flatten)]
|
#[serde(flatten)]
|
||||||
provider_def: azure_key_vault::AzureKeyVaultProvider,
|
provider_def: AzureKeyVaultProvider,
|
||||||
|
},
|
||||||
|
Gopass {
|
||||||
|
#[serde(flatten)]
|
||||||
|
provider_def: GopassProvider,
|
||||||
|
},
|
||||||
|
OnePassword {
|
||||||
|
#[serde(flatten)]
|
||||||
|
provider_def: OnePasswordProvider,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -74,6 +91,8 @@ 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(),
|
||||||
|
SupportedProvider::OnePassword { provider_def } => provider_def.validate(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -93,6 +112,8 @@ 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"),
|
||||||
|
SupportedProvider::OnePassword { .. } => write!(f, "one_password"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,199 @@
|
|||||||
|
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;
|
||||||
|
use std::process::{Command, Stdio};
|
||||||
|
use validator::Validate;
|
||||||
|
|
||||||
|
#[skip_serializing_none]
|
||||||
|
/// 1Password-based secret provider.
|
||||||
|
/// See [1Password CLI](https://developer.1password.com/docs/cli/) for more
|
||||||
|
/// information.
|
||||||
|
///
|
||||||
|
/// You must already have the 1Password CLI (`op`) installed and configured
|
||||||
|
/// on your system.
|
||||||
|
///
|
||||||
|
/// This provider stores secrets as 1Password Password items. It requires
|
||||||
|
/// an optional vault name and an optional account identifier to be specified.
|
||||||
|
/// If no vault is specified, the user's default vault is used. If no account
|
||||||
|
/// is specified, the default signed-in account is used.
|
||||||
|
///
|
||||||
|
/// Example
|
||||||
|
/// ```no_run
|
||||||
|
/// use gman::providers::one_password::OnePasswordProvider;
|
||||||
|
/// use gman::providers::{SecretProvider, SupportedProvider};
|
||||||
|
/// use gman::config::Config;
|
||||||
|
///
|
||||||
|
/// let provider = OnePasswordProvider::default();
|
||||||
|
/// let _ = provider.set_secret("MY_SECRET", "value");
|
||||||
|
/// ```
|
||||||
|
#[derive(Debug, Default, Clone, Validate, Serialize, Deserialize, PartialEq, Eq)]
|
||||||
|
#[serde(deny_unknown_fields)]
|
||||||
|
pub struct OnePasswordProvider {
|
||||||
|
pub vault: Option<String>,
|
||||||
|
pub account: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl OnePasswordProvider {
|
||||||
|
fn base_command(&self) -> Command {
|
||||||
|
let mut cmd = Command::new("op");
|
||||||
|
cmd.env("PATH", ENV_PATH.as_ref().expect("No ENV_PATH set"));
|
||||||
|
if let Some(account) = &self.account {
|
||||||
|
cmd.args(["--account", account]);
|
||||||
|
}
|
||||||
|
cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
fn vault_args(&self) -> Vec<&str> {
|
||||||
|
match &self.vault {
|
||||||
|
Some(vault) => vec!["--vault", vault],
|
||||||
|
None => vec![],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait::async_trait]
|
||||||
|
impl SecretProvider for OnePasswordProvider {
|
||||||
|
fn name(&self) -> &'static str {
|
||||||
|
"OnePasswordProvider"
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn get_secret(&self, key: &str) -> Result<String> {
|
||||||
|
ensure_op_installed()?;
|
||||||
|
|
||||||
|
let mut cmd = self.base_command();
|
||||||
|
cmd.args(["item", "get", key, "--fields", "password", "--reveal"]);
|
||||||
|
cmd.args(self.vault_args());
|
||||||
|
cmd.stdin(Stdio::inherit())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::inherit());
|
||||||
|
|
||||||
|
let mut child = cmd.spawn().context("Failed to spawn op command")?;
|
||||||
|
|
||||||
|
let mut output = String::new();
|
||||||
|
child
|
||||||
|
.stdout
|
||||||
|
.as_mut()
|
||||||
|
.expect("Failed to open op stdout")
|
||||||
|
.read_to_string(&mut output)
|
||||||
|
.context("Failed to read op output")?;
|
||||||
|
|
||||||
|
let status = child.wait().context("Failed to wait on op process")?;
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("op 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_op_installed()?;
|
||||||
|
|
||||||
|
let mut cmd = self.base_command();
|
||||||
|
cmd.args(["item", "create", "--category", "password", "--title", key]);
|
||||||
|
cmd.args(self.vault_args());
|
||||||
|
cmd.arg(format!("password={}", value));
|
||||||
|
cmd.stdin(Stdio::inherit())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::inherit());
|
||||||
|
|
||||||
|
let mut child = cmd.spawn().context("Failed to spawn op command")?;
|
||||||
|
|
||||||
|
let status = child.wait().context("Failed to wait on op process")?;
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("op command failed with status: {}", status));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn update_secret(&self, key: &str, value: &str) -> Result<()> {
|
||||||
|
ensure_op_installed()?;
|
||||||
|
|
||||||
|
let mut cmd = self.base_command();
|
||||||
|
cmd.args(["item", "edit", key]);
|
||||||
|
cmd.args(self.vault_args());
|
||||||
|
cmd.arg(format!("password={}", value));
|
||||||
|
cmd.stdin(Stdio::inherit())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::inherit());
|
||||||
|
|
||||||
|
let mut child = cmd.spawn().context("Failed to spawn op command")?;
|
||||||
|
|
||||||
|
let status = child.wait().context("Failed to wait on op process")?;
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("op command failed with status: {}", status));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn delete_secret(&self, key: &str) -> Result<()> {
|
||||||
|
ensure_op_installed()?;
|
||||||
|
|
||||||
|
let mut cmd = self.base_command();
|
||||||
|
cmd.args(["item", "delete", key]);
|
||||||
|
cmd.args(self.vault_args());
|
||||||
|
cmd.stdin(Stdio::inherit())
|
||||||
|
.stdout(Stdio::inherit())
|
||||||
|
.stderr(Stdio::inherit());
|
||||||
|
|
||||||
|
let mut child = cmd.spawn().context("Failed to spawn op command")?;
|
||||||
|
|
||||||
|
let status = child.wait().context("Failed to wait on op process")?;
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("op command failed with status: {}", status));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn list_secrets(&self) -> Result<Vec<String>> {
|
||||||
|
ensure_op_installed()?;
|
||||||
|
|
||||||
|
let mut cmd = self.base_command();
|
||||||
|
cmd.args(["item", "list", "--format", "json"]);
|
||||||
|
cmd.args(self.vault_args());
|
||||||
|
cmd.stdin(Stdio::inherit())
|
||||||
|
.stdout(Stdio::piped())
|
||||||
|
.stderr(Stdio::inherit());
|
||||||
|
|
||||||
|
let mut child = cmd.spawn().context("Failed to spawn op command")?;
|
||||||
|
|
||||||
|
let mut output = String::new();
|
||||||
|
child
|
||||||
|
.stdout
|
||||||
|
.as_mut()
|
||||||
|
.expect("Failed to open op stdout")
|
||||||
|
.read_to_string(&mut output)
|
||||||
|
.context("Failed to read op output")?;
|
||||||
|
|
||||||
|
let status = child.wait().context("Failed to wait on op process")?;
|
||||||
|
if !status.success() {
|
||||||
|
return Err(anyhow!("op command failed with status: {}", status));
|
||||||
|
}
|
||||||
|
|
||||||
|
let items: Vec<serde_json::Value> =
|
||||||
|
serde_json::from_str(&output).context("Failed to parse op item list JSON output")?;
|
||||||
|
|
||||||
|
let secrets: Vec<String> = items
|
||||||
|
.iter()
|
||||||
|
.filter_map(|item| item.get("title").and_then(|t| t.as_str()))
|
||||||
|
.map(|s| s.to_string())
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
Ok(secrets)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn ensure_op_installed() -> Result<()> {
|
||||||
|
if which::which("op").is_err() {
|
||||||
|
Err(anyhow!(
|
||||||
|
"1Password CLI (op) is not installed or not found in PATH. \
|
||||||
|
Please install it from https://developer.1password.com/docs/cli/get-started/"
|
||||||
|
))
|
||||||
|
} else {
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
+73
-43
@@ -1,3 +1,8 @@
|
|||||||
|
//! CLI integration tests that execute the gman binary.
|
||||||
|
//!
|
||||||
|
//! These tests are skipped when cross-compiling because the compiled binary
|
||||||
|
//! cannot be executed on a different architecture (e.g., ARM64 binary on x86_64 host).
|
||||||
|
|
||||||
use assert_cmd::prelude::*;
|
use assert_cmd::prelude::*;
|
||||||
use predicates::prelude::*;
|
use predicates::prelude::*;
|
||||||
use std::fs;
|
use std::fs;
|
||||||
@@ -7,6 +12,20 @@ use std::path::{Path, PathBuf};
|
|||||||
use std::process::{Command, Stdio};
|
use std::process::{Command, Stdio};
|
||||||
use tempfile::TempDir;
|
use tempfile::TempDir;
|
||||||
|
|
||||||
|
fn gman_bin() -> PathBuf {
|
||||||
|
PathBuf::from(env!("CARGO_BIN_EXE_gman"))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Check if the gman binary can be executed on this system.
|
||||||
|
/// Returns false when cross-compiling (e.g., ARM64 binary on x86_64 host).
|
||||||
|
fn can_execute_binary() -> bool {
|
||||||
|
Command::new(gman_bin())
|
||||||
|
.arg("--version")
|
||||||
|
.output()
|
||||||
|
.map(|o| o.status.success())
|
||||||
|
.unwrap_or(false)
|
||||||
|
}
|
||||||
|
|
||||||
fn setup_env() -> (TempDir, PathBuf, PathBuf) {
|
fn setup_env() -> (TempDir, PathBuf, PathBuf) {
|
||||||
let td = tempfile::tempdir().expect("tempdir");
|
let td = tempfile::tempdir().expect("tempdir");
|
||||||
let cfg_home = td.path().join("config");
|
let cfg_home = td.path().join("config");
|
||||||
@@ -46,27 +65,38 @@ providers:
|
|||||||
password_file.display()
|
password_file.display()
|
||||||
)
|
)
|
||||||
};
|
};
|
||||||
// Confy with yaml feature typically uses .yml; write both to be safe.
|
|
||||||
fs::write(app_dir.join("config.yml"), &cfg).unwrap();
|
fs::write(app_dir.join("config.yml"), &cfg).unwrap();
|
||||||
fs::write(app_dir.join("config.yaml"), &cfg).unwrap();
|
fs::write(app_dir.join("config.yaml"), &cfg).unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn create_password_file(path: &Path, content: &[u8]) {
|
||||||
|
fs::write(path, content).unwrap();
|
||||||
|
#[cfg(unix)]
|
||||||
|
{
|
||||||
|
fs::set_permissions(path, fs::Permissions::from_mode(0o600)).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg(unix)]
|
#[cfg(unix)]
|
||||||
fn cli_config_no_changes() {
|
fn cli_config_no_changes() {
|
||||||
|
if !can_execute_binary() {
|
||||||
|
eprintln!("Skipping test: cannot execute cross-compiled binary");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
let (td, xdg_cfg, xdg_cache) = setup_env();
|
let (td, xdg_cfg, xdg_cache) = setup_env();
|
||||||
let pw_file = td.path().join("pw.txt");
|
let pw_file = td.path().join("pw.txt");
|
||||||
fs::write(&pw_file, b"pw\n").unwrap();
|
create_password_file(&pw_file, b"pw\n");
|
||||||
write_yaml_config(&xdg_cfg, &pw_file, None);
|
write_yaml_config(&xdg_cfg, &pw_file, None);
|
||||||
|
|
||||||
// Create a no-op editor script that exits successfully without modifying the file
|
|
||||||
let editor = td.path().join("noop-editor.sh");
|
let editor = td.path().join("noop-editor.sh");
|
||||||
fs::write(&editor, b"#!/bin/sh\nexit 0\n").unwrap();
|
fs::write(&editor, b"#!/bin/sh\nexit 0\n").unwrap();
|
||||||
let mut perms = fs::metadata(&editor).unwrap().permissions();
|
let mut perms = fs::metadata(&editor).unwrap().permissions();
|
||||||
perms.set_mode(0o755);
|
perms.set_mode(0o755);
|
||||||
fs::set_permissions(&editor, perms).unwrap();
|
fs::set_permissions(&editor, perms).unwrap();
|
||||||
|
|
||||||
let mut cmd = Command::cargo_bin("gman").unwrap();
|
let mut cmd = Command::new(gman_bin());
|
||||||
cmd.env("XDG_CONFIG_HOME", &xdg_cfg)
|
cmd.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
.env("EDITOR", &editor)
|
.env("EDITOR", &editor)
|
||||||
@@ -80,15 +110,23 @@ fn cli_config_no_changes() {
|
|||||||
#[test]
|
#[test]
|
||||||
#[cfg(unix)]
|
#[cfg(unix)]
|
||||||
fn cli_config_updates_and_persists() {
|
fn cli_config_updates_and_persists() {
|
||||||
|
if !can_execute_binary() {
|
||||||
|
eprintln!("Skipping test: cannot execute cross-compiled binary");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
let (td, xdg_cfg, xdg_cache) = setup_env();
|
let (td, xdg_cfg, xdg_cache) = setup_env();
|
||||||
let pw_file = td.path().join("pw.txt");
|
let pw_file = td.path().join("pw.txt");
|
||||||
fs::write(&pw_file, b"pw\n").unwrap();
|
create_password_file(&pw_file, b"pw\n");
|
||||||
write_yaml_config(&xdg_cfg, &pw_file, None);
|
write_yaml_config(&xdg_cfg, &pw_file, None);
|
||||||
|
|
||||||
// Editor script appends a valid run_configs section to the YAML file
|
|
||||||
let editor = td.path().join("append-run-config.sh");
|
let editor = td.path().join("append-run-config.sh");
|
||||||
|
// Note: We need a small sleep to ensure the file modification timestamp changes.
|
||||||
|
// The dialoguer Editor uses file modification time to detect changes, and on fast
|
||||||
|
// systems the edit can complete within the same timestamp granularity.
|
||||||
let script = r#"#!/bin/sh
|
let script = r#"#!/bin/sh
|
||||||
FILE="$1"
|
FILE="$1"
|
||||||
|
sleep 0.1
|
||||||
cat >> "$FILE" <<'EOF'
|
cat >> "$FILE" <<'EOF'
|
||||||
run_configs:
|
run_configs:
|
||||||
- name: echo
|
- name: echo
|
||||||
@@ -101,7 +139,7 @@ exit 0
|
|||||||
perms.set_mode(0o755);
|
perms.set_mode(0o755);
|
||||||
fs::set_permissions(&editor, perms).unwrap();
|
fs::set_permissions(&editor, perms).unwrap();
|
||||||
|
|
||||||
let mut cmd = Command::cargo_bin("gman").unwrap();
|
let mut cmd = Command::new(gman_bin());
|
||||||
cmd.env("XDG_CONFIG_HOME", &xdg_cfg)
|
cmd.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
.env("EDITOR", &editor)
|
.env("EDITOR", &editor)
|
||||||
@@ -111,7 +149,6 @@ exit 0
|
|||||||
"Configuration updated successfully",
|
"Configuration updated successfully",
|
||||||
));
|
));
|
||||||
|
|
||||||
// Verify that the config file now contains the run_configs key
|
|
||||||
let cfg_path = xdg_cfg.join("gman").join("config.yml");
|
let cfg_path = xdg_cfg.join("gman").join("config.yml");
|
||||||
let written = fs::read_to_string(&cfg_path).expect("config file readable");
|
let written = fs::read_to_string(&cfg_path).expect("config file readable");
|
||||||
assert!(written.contains("run_configs:"));
|
assert!(written.contains("run_configs:"));
|
||||||
@@ -120,8 +157,13 @@ exit 0
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn cli_shows_help() {
|
fn cli_shows_help() {
|
||||||
|
if !can_execute_binary() {
|
||||||
|
eprintln!("Skipping test: cannot execute cross-compiled binary");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
let (_td, cfg, cache) = setup_env();
|
let (_td, cfg, cache) = setup_env();
|
||||||
let mut cmd = Command::cargo_bin("gman").unwrap();
|
let mut cmd = Command::new(gman_bin());
|
||||||
cmd.env("XDG_CACHE_HOME", &cache)
|
cmd.env("XDG_CACHE_HOME", &cache)
|
||||||
.env("XDG_CONFIG_HOME", &cfg)
|
.env("XDG_CONFIG_HOME", &cfg)
|
||||||
.arg("--help");
|
.arg("--help");
|
||||||
@@ -130,27 +172,19 @@ 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() {
|
||||||
|
if !can_execute_binary() {
|
||||||
|
eprintln!("Skipping test: cannot execute cross-compiled binary");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
let (td, xdg_cfg, xdg_cache) = setup_env();
|
let (td, xdg_cfg, xdg_cache) = setup_env();
|
||||||
let pw_file = td.path().join("pw.txt");
|
let pw_file = td.path().join("pw.txt");
|
||||||
fs::write(&pw_file, b"testpw\n").unwrap();
|
create_password_file(&pw_file, b"testpw\n");
|
||||||
write_yaml_config(&xdg_cfg, &pw_file, None);
|
write_yaml_config(&xdg_cfg, &pw_file, None);
|
||||||
|
|
||||||
// add
|
let mut add = Command::new(gman_bin());
|
||||||
let mut add = Command::cargo_bin("gman").unwrap();
|
|
||||||
add.env("XDG_CONFIG_HOME", &xdg_cfg)
|
add.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
.stdin(Stdio::piped())
|
.stdin(Stdio::piped())
|
||||||
@@ -166,8 +200,7 @@ fn cli_add_get_list_update_delete_roundtrip() {
|
|||||||
let add_out = child.wait_with_output().unwrap();
|
let add_out = child.wait_with_output().unwrap();
|
||||||
assert!(add_out.status.success());
|
assert!(add_out.status.success());
|
||||||
|
|
||||||
// get (text)
|
let mut get = Command::new(gman_bin());
|
||||||
let mut get = Command::cargo_bin("gman").unwrap();
|
|
||||||
get.env("XDG_CONFIG_HOME", &xdg_cfg)
|
get.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
.args(["get", "my_api_key"]);
|
.args(["get", "my_api_key"]);
|
||||||
@@ -175,8 +208,7 @@ fn cli_add_get_list_update_delete_roundtrip() {
|
|||||||
.success()
|
.success()
|
||||||
.stdout(predicate::str::contains("super_secret"));
|
.stdout(predicate::str::contains("super_secret"));
|
||||||
|
|
||||||
// get as JSON
|
let mut get_json = Command::new(gman_bin());
|
||||||
let mut get_json = Command::cargo_bin("gman").unwrap();
|
|
||||||
get_json
|
get_json
|
||||||
.env("XDG_CONFIG_HOME", &xdg_cfg)
|
.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
@@ -185,8 +217,7 @@ fn cli_add_get_list_update_delete_roundtrip() {
|
|||||||
predicate::str::contains("my_api_key").and(predicate::str::contains("super_secret")),
|
predicate::str::contains("my_api_key").and(predicate::str::contains("super_secret")),
|
||||||
);
|
);
|
||||||
|
|
||||||
// list
|
let mut list = Command::new(gman_bin());
|
||||||
let mut list = Command::cargo_bin("gman").unwrap();
|
|
||||||
list.env("XDG_CONFIG_HOME", &xdg_cfg)
|
list.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
.arg("list");
|
.arg("list");
|
||||||
@@ -194,8 +225,7 @@ fn cli_add_get_list_update_delete_roundtrip() {
|
|||||||
.success()
|
.success()
|
||||||
.stdout(predicate::str::contains("my_api_key"));
|
.stdout(predicate::str::contains("my_api_key"));
|
||||||
|
|
||||||
// update
|
let mut update = Command::new(gman_bin());
|
||||||
let mut update = Command::cargo_bin("gman").unwrap();
|
|
||||||
update
|
update
|
||||||
.env("XDG_CONFIG_HOME", &xdg_cfg)
|
.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
@@ -211,8 +241,7 @@ fn cli_add_get_list_update_delete_roundtrip() {
|
|||||||
let upd_out = child.wait_with_output().unwrap();
|
let upd_out = child.wait_with_output().unwrap();
|
||||||
assert!(upd_out.status.success());
|
assert!(upd_out.status.success());
|
||||||
|
|
||||||
// get again
|
let mut get2 = Command::new(gman_bin());
|
||||||
let mut get2 = Command::cargo_bin("gman").unwrap();
|
|
||||||
get2.env("XDG_CONFIG_HOME", &xdg_cfg)
|
get2.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
.args(["get", "my_api_key"]);
|
.args(["get", "my_api_key"]);
|
||||||
@@ -220,15 +249,13 @@ fn cli_add_get_list_update_delete_roundtrip() {
|
|||||||
.success()
|
.success()
|
||||||
.stdout(predicate::str::contains("new_val"));
|
.stdout(predicate::str::contains("new_val"));
|
||||||
|
|
||||||
// delete
|
let mut del = Command::new(gman_bin());
|
||||||
let mut del = Command::cargo_bin("gman").unwrap();
|
|
||||||
del.env("XDG_CONFIG_HOME", &xdg_cfg)
|
del.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
.args(["delete", "my_api_key"]);
|
.args(["delete", "my_api_key"]);
|
||||||
del.assert().success();
|
del.assert().success();
|
||||||
|
|
||||||
// get should now fail
|
let mut get_missing = Command::new(gman_bin());
|
||||||
let mut get_missing = Command::cargo_bin("gman").unwrap();
|
|
||||||
get_missing
|
get_missing
|
||||||
.env("XDG_CONFIG_HOME", &xdg_cfg)
|
.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
@@ -238,13 +265,17 @@ fn cli_add_get_list_update_delete_roundtrip() {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn cli_wrap_dry_run_env_injection() {
|
fn cli_wrap_dry_run_env_injection() {
|
||||||
|
if !can_execute_binary() {
|
||||||
|
eprintln!("Skipping test: cannot execute cross-compiled binary");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
let (td, xdg_cfg, xdg_cache) = setup_env();
|
let (td, xdg_cfg, xdg_cache) = setup_env();
|
||||||
let pw_file = td.path().join("pw.txt");
|
let pw_file = td.path().join("pw.txt");
|
||||||
fs::write(&pw_file, b"pw\n").unwrap();
|
create_password_file(&pw_file, b"pw\n");
|
||||||
write_yaml_config(&xdg_cfg, &pw_file, Some("echo"));
|
write_yaml_config(&xdg_cfg, &pw_file, Some("echo"));
|
||||||
|
|
||||||
// Add the secret so the profile can read it
|
let mut add = Command::new(gman_bin());
|
||||||
let mut add = Command::cargo_bin("gman").unwrap();
|
|
||||||
add.env("XDG_CONFIG_HOME", &xdg_cfg)
|
add.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
.stdin(Stdio::piped())
|
.stdin(Stdio::piped())
|
||||||
@@ -255,8 +286,7 @@ fn cli_wrap_dry_run_env_injection() {
|
|||||||
let add_out = child.wait_with_output().unwrap();
|
let add_out = child.wait_with_output().unwrap();
|
||||||
assert!(add_out.status.success());
|
assert!(add_out.status.success());
|
||||||
|
|
||||||
// Dry-run wrapping: prints preview command
|
let mut wrap = Command::new(gman_bin());
|
||||||
let mut wrap = Command::cargo_bin("gman").unwrap();
|
|
||||||
wrap.env("XDG_CONFIG_HOME", &xdg_cfg)
|
wrap.env("XDG_CONFIG_HOME", &xdg_cfg)
|
||||||
.env("XDG_CACHE_HOME", &xdg_cache)
|
.env("XDG_CACHE_HOME", &xdg_cache)
|
||||||
.arg("--dry-run")
|
.arg("--dry-run")
|
||||||
|
|||||||
+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,8 @@
|
|||||||
|
# Seeds for failure cases proptest has generated in the past. It is
|
||||||
|
# automatically read and these particular cases re-run before any
|
||||||
|
# novel cases are generated.
|
||||||
|
#
|
||||||
|
# It is recommended to check this file in to source control so that
|
||||||
|
# everyone who runs the test benefits from these saved cases.
|
||||||
|
cc 155469a45d7311cd4003e23a3bcdaa8e55879e6222c1b6313a2b1f0b563bb195 # shrinks to password = "", msg = " "
|
||||||
|
cc 0bc9f608677234c082d10ff51b15dc39b4c194cdf920b4d87e553467c93824ed # shrinks to password = "", msg = ""
|
||||||
@@ -1,15 +1,15 @@
|
|||||||
use base64::Engine;
|
use base64::Engine;
|
||||||
use gman::{decrypt_string, encrypt_string};
|
use gman::{decrypt_string, encrypt_string};
|
||||||
use proptest::prelude::*;
|
use proptest::prelude::*;
|
||||||
|
|
||||||
proptest! {
|
|
||||||
#![proptest_config(ProptestConfig::with_cases(64))]
|
|
||||||
}
|
|
||||||
use secrecy::SecretString;
|
use secrecy::SecretString;
|
||||||
|
|
||||||
proptest! {
|
proptest! {
|
||||||
|
// Reduced case count because Argon2 key derivation is intentionally slow
|
||||||
|
// (65 MiB memory, 3 iterations per encryption/decryption)
|
||||||
|
#![proptest_config(ProptestConfig::with_cases(4))]
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn prop_encrypt_decrypt_roundtrip(password in ".{0,64}", msg in ".{0,512}") {
|
fn prop_encrypt_decrypt_roundtrip(password in ".{1,64}", msg in ".{0,512}") {
|
||||||
let pw = SecretString::new(password.into());
|
let pw = SecretString::new(password.into());
|
||||||
let env = encrypt_string(pw.clone(), &msg).unwrap();
|
let env = encrypt_string(pw.clone(), &msg).unwrap();
|
||||||
let out = decrypt_string(pw, &env).unwrap();
|
let out = decrypt_string(pw, &env).unwrap();
|
||||||
@@ -18,10 +18,9 @@ proptest! {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn prop_tamper_ciphertext_detected(password in ".{0,32}", msg in ".{1,128}") {
|
fn prop_tamper_ciphertext_detected(password in ".{1,32}", msg in ".{1,128}") {
|
||||||
let pw = SecretString::new(password.into());
|
let pw = SecretString::new(password.into());
|
||||||
let env = encrypt_string(pw.clone(), &msg).unwrap();
|
let env = encrypt_string(pw.clone(), &msg).unwrap();
|
||||||
// Flip a bit in the ct payload segment
|
|
||||||
let mut parts: Vec<&str> = env.split(';').collect();
|
let mut parts: Vec<&str> = env.split(';').collect();
|
||||||
let ct_b64 = parts[6].strip_prefix("ct=").unwrap();
|
let ct_b64 = parts[6].strip_prefix("ct=").unwrap();
|
||||||
let mut ct = base64::engine::general_purpose::STANDARD.decode(ct_b64).unwrap();
|
let mut ct = base64::engine::general_purpose::STANDARD.decode(ct_b64).unwrap();
|
||||||
|
|||||||
@@ -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,7 @@
|
|||||||
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 one_password_tests;
|
||||||
mod provider_tests;
|
mod provider_tests;
|
||||||
|
|||||||
@@ -0,0 +1,113 @@
|
|||||||
|
use gman::config::{Config, ProviderConfig};
|
||||||
|
use gman::providers::{SecretProvider, SupportedProvider};
|
||||||
|
use pretty_assertions::{assert_eq, assert_str_eq};
|
||||||
|
use validator::Validate;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_one_password_supported_provider_display_and_validate_from_yaml() {
|
||||||
|
let yaml = r#"---
|
||||||
|
type: one_password
|
||||||
|
vault: Production
|
||||||
|
account: my.1password.com
|
||||||
|
"#;
|
||||||
|
|
||||||
|
let sp: SupportedProvider = serde_yaml::from_str(yaml).expect("valid supported provider yaml");
|
||||||
|
assert!(sp.validate().is_ok());
|
||||||
|
assert_eq!(sp.to_string(), "one_password");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_one_password_supported_provider_minimal_yaml() {
|
||||||
|
let yaml = r#"---
|
||||||
|
type: one_password
|
||||||
|
"#;
|
||||||
|
|
||||||
|
let sp: SupportedProvider = serde_yaml::from_str(yaml).expect("valid supported provider yaml");
|
||||||
|
assert!(sp.validate().is_ok());
|
||||||
|
assert_eq!(sp.to_string(), "one_password");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_one_password_supported_provider_vault_only() {
|
||||||
|
let yaml = r#"---
|
||||||
|
type: one_password
|
||||||
|
vault: Personal
|
||||||
|
"#;
|
||||||
|
|
||||||
|
let sp: SupportedProvider = serde_yaml::from_str(yaml).expect("valid supported provider yaml");
|
||||||
|
assert!(sp.validate().is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_one_password_supported_provider_account_only() {
|
||||||
|
let yaml = r#"---
|
||||||
|
type: one_password
|
||||||
|
account: team.1password.com
|
||||||
|
"#;
|
||||||
|
|
||||||
|
let sp: SupportedProvider = serde_yaml::from_str(yaml).expect("valid supported provider yaml");
|
||||||
|
assert!(sp.validate().is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_one_password_supported_provider_rejects_unknown_fields() {
|
||||||
|
let yaml = r#"---
|
||||||
|
type: one_password
|
||||||
|
vault: Production
|
||||||
|
unknown_field: bad
|
||||||
|
"#;
|
||||||
|
|
||||||
|
let result: Result<SupportedProvider, _> = serde_yaml::from_str(yaml);
|
||||||
|
assert!(result.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_provider_config_with_one_password_deserialize_and_extract() {
|
||||||
|
let yaml = r#"---
|
||||||
|
name: op
|
||||||
|
type: one_password
|
||||||
|
"#;
|
||||||
|
|
||||||
|
let pc: ProviderConfig = serde_yaml::from_str(yaml).expect("valid provider config yaml");
|
||||||
|
assert!(pc.validate().is_ok());
|
||||||
|
|
||||||
|
let mut pc_owned = pc.clone();
|
||||||
|
let provider: &mut dyn SecretProvider = pc_owned.extract_provider();
|
||||||
|
assert_str_eq!(provider.name(), "OnePasswordProvider");
|
||||||
|
|
||||||
|
let cfg_yaml = r#"---
|
||||||
|
default_provider: op
|
||||||
|
providers:
|
||||||
|
- name: op
|
||||||
|
type: one_password
|
||||||
|
vault: Production
|
||||||
|
account: my.1password.com
|
||||||
|
"#;
|
||||||
|
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("op"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_one_password_config_with_multiple_providers() {
|
||||||
|
let cfg_yaml = r#"---
|
||||||
|
default_provider: local
|
||||||
|
providers:
|
||||||
|
- name: local
|
||||||
|
type: local
|
||||||
|
- name: op
|
||||||
|
type: one_password
|
||||||
|
vault: Production
|
||||||
|
"#;
|
||||||
|
let cfg: Config = serde_yaml::from_str(cfg_yaml).expect("valid config yaml");
|
||||||
|
assert!(cfg.validate().is_ok());
|
||||||
|
|
||||||
|
let extracted = cfg
|
||||||
|
.extract_provider_config(Some("op".into()))
|
||||||
|
.expect("should find op provider");
|
||||||
|
assert_eq!(extracted.name.as_deref(), Some("op"));
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user