Add vault client for cbi

[heurtematte]

This PR override: #43

This specific vault client help to deal with the secretsmanager, from script to shell.

• Easy login process
• Interact with specific mount secret
• Interact with user specific mount

Usage

vaultctl <command> [options]

Commands

login: Authenticate to Vault using LDAP

logout: Revoke token and remove credentials

status: Show current authentication status

export-vault: Export vault environment variables for current shell

• Usage: vaultctl export-vault

read : Read a secret field from Vault

• Usage: vaultctl read
• Note: path is the full path to the secret, including the field name

write = [...]: Write secrets to Vault

• Usage: vaultctl write [= | =@<secret_file> | @<secret_file>]
• Note: path is the full path to the secret without the field name

export-env <ENV_VAR:key> [<ENV_VAR2:key2> ...]: Export secrets from Vault as environment variables

• Usage: vaultctl export-env <ENV_VAR:key> [<ENV_VAR2:key2> ...]

export-env-all : Export ALL secrets from specified mount and path

• Usage: vaultctl export-env-all

export-users <ENV_VAR[:key]> [<ENV_VAR2[:key2]> ...]: Export specific secrets from users/

• Usage: vaultctl export-users <ENV_VAR[:key]> [<ENV_VAR2[:key2]> ...]

export-users-all: Export ALL secrets from users/

• Usage: vaultctl export-users-all

export-users-path <ENV_VAR[:key]> [<ENV_VAR2[:key2]> ...]: Export specific secrets from users//

• Usage: vaultctl export-users-path <ENV_VAR[:key]> [<ENV_VAR2[:key2]> ...]

export-users-path-all : Export ALL secrets from users//

• Usage: vaultctl export-users-path-all

export-users-cbi <ENV_VAR[:key]> [<ENV_VAR2[:key2]> ...]: Export specific secrets from users//cbi

• Usage: vaultctl export-users-cbi <ENV_VAR[:key]> [<ENV_VAR2[:key2]> ...]

export-users-cbi-all: Export ALL secrets from users//cbi

• Usage: vaultctl export-users-cbi-all

help: Show message cmd

Environment Variables:

VAULT_ADDR: Vault server address (default: https://secretsmanager.eclipse.org)
VAULT_TOKEN: Authentication token (set after login)
VAULT_USERNAME: LDAP username (optional)

Examples:

  vaultctl login                                        # Authenticate to Vault
  vaultctl status                                       # Check authentication status
  eval $(vaultctl export-vault)                         # Export auth variables to current shell

Read secrets (output to stdout)

 vaultctl read users <username>/JENKINS_USERNAME
 vaultctl read cbi technology.cbi/github.com/api-token

Write secrets

vaultctl write users myuser/cbi username=john password=******
vaultctl write cbi technology.cbi/github.com api-token=***** password=******

Export secrets as environment variables

  eval $(vaultctl export-users JENKINS_USERNAME JENKINS_PASSWORD) # Export specific user secrets
  eval $(vaultctl export-users jenkins_username --prefix CI_ --uppercase) # With prefix and uppercase
  eval $(vaultctl export-users-all)                     # Export ALL secrets from user path
  eval $(vaultctl export-users-all --prefix PREFIX_ --uppercase) # ALL with prefix and uppercase
  eval $(vaultctl export-users-path cbi JENKINS_USERNAME) # Export specific from users/<username>/cbi
  eval $(vaultctl export-users-path cbi JENKINS_USERNAME --prefix CBI_) # With prefix
  eval $(vaultctl export-users-cbi-all)                 # Export ALL secrets from cbi subpath
  eval $(vaultctl export-env users myuser USER:username PASS:password) # Export secrets as env vars
  eval $(vaultctl export-env users myuser user:username --prefix MY_ --uppercase) # With prefix and uppercase
  eval $(vaultctl export-env-all users <username>) # Export ALL from specified mount/path
  eval $(vaultctl export-env-all cbi technology.cbi/github.com --prefix GH_ --uppercase) # With options
  vaultctl logout                                       # Log out and revoke token

Move

  vaultctl mv cbi technology.cbi/repo3.eclipse.org technology.cbi/repo.eclipse.org
  vaultctl mv users myuser/old-path myuser/new-path

Delete

  vaultctl rm cbi technology.cbi/old-repo.eclipse.org
  vaultctl rm -f users myuser/deprecated-key              # skip confirmation

Find

  vaultctl find users                                   # List all paths in users mount (cached)
  vaultctl find users '*/cbi/*'                         # Find paths under any user's cbi dir
  vaultctl find cbi 'technology.cbi/*'                  # Find paths under technology.cbi
  vaultctl find users 'myuser/*' --no-cache             # Force live scan, update cache
  vaultctl find users --clear-cache                     # Invalidate cached index for users
  vaultctl find --clear-all-cache                       # Invalidate all cached indexes
  vaultctl find users --cache-info                      # Show cache status for users mount

Bulk rename

vaultctl find cbi "*repo3.*" -b | while read p; do vaultctl mv cbi "$p" "$(echo "$p" | sed 's/repo3\.eclipse\.org/repo.eclipse.offering/')"; done

Configuration

• Username saved in: /home//.vaultctl
• Token stored in: /home//.vault-token

[gitguardian]

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
27434270	Triggered	Username Password	fab55b5	secretsmanager/vaultctl.sh	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secret safely. Learn here the best practices.
3. Revoke and rotate this secret.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

[sonarqubecloud]

Quality Gate passed

Issues
19 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud