Files
mcp-ssh-orchestrator/examples/example-credentials.yml
T
Sammy Farida f874b13d34 Security/fix command chaining bypass (#68)
* fix: Remove unused variable in fix-markdownlint.py

* fix: Remove unused code_block_lang variable

* chore: Update documentation, workflows, and examples

- Updated all wiki documentation files (markdownlint fixes)
- Updated GitHub workflows and issue templates
- Updated example configuration files
- Updated metadata.json and pyproject.toml
- Updated Dockerfile and compose files
- Updated validation scripts

Note: yamllint warnings are style-only (missing ---, line length) and don't affect functionality
2025-11-18 07:00:42 -05:00

54 lines
2.2 KiB
YAML

# example-credentials.yml
#
# Example SSH credentials configuration for mcp-ssh-orchestrator.
# Copy this to config/credentials.yml and customize for your environment.
#
# SECURITY NOTES:
# - Never commit real secrets to Git.
# - Mount your private keys into /app/keys (read-only) with chmod 0400.
# - Store passwords/passphrases as Docker secrets or env vars (see below).
# - Secrets are resolved in the following order:
# 1. Environment variable: MCP_SSH_SECRET_<NAME_IN_UPPERCASE>
# 2. Docker secret file: /app/secrets/<name>
#
# Fields:
# name : unique identifier referenced by servers.yml (required)
# username : SSH username (required)
# key_path : private key path relative to /app/keys (or absolute path)
# password_secret : secret name containing SSH password (optional)
# key_passphrase_secret: secret name containing passphrase for encrypted key (optional)
#
# Example secret setup:
# echo "super-secret" > secrets/prod_admin_password.txt
# docker secret create prod_admin_password secrets/prod_admin_password.txt
# export MCP_SSH_SECRET_PROD_ADMIN_PASSWORD=super-secret # optional env alternative
entries:
# Production automation account using Ed25519 key (recommended)
- name: "prod-admin"
username: "ubuntu"
key_path: "prod/id_ed25519"
key_passphrase_secret: "prod_admin_passphrase" # leave blank if unencrypted
password_secret: "" # password auth disabled
# Staging deployment user with encrypted RSA key (passphrase pulled from secrets)
- name: "stg-deploy"
username: "deploy"
key_path: "staging/id_rsa_encrypted"
key_passphrase_secret: "stg_deploy_key_passphrase"
password_secret: ""
# Lab maintenance account authenticating with password stored in secret
- name: "lab-maint"
username: "maint"
key_path: ""
key_passphrase_secret: ""
password_secret: "lab_maint_password"
# Example mixed-mode user: password fallback plus passphrase-protected key
- name: "ops-fallback"
username: "ops"
key_path: "shared/id_rsa_encrypted"
key_passphrase_secret: "ops_key_passphrase"
password_secret: "ops_password"