M2m MCP Server Ssh Server

🚀 MCP Server SSH

MCP Server SSH is a tool that provides secure SSH access and supports key management. It allows clients to connect to the server via the SSH protocol and simplifies the client public key registration process through a配套的 HTTP key management server.

🚀 Quick Start

📦 Installation

You can run the MCP Server SSH using the following command:

uv run m2m-mcp-server-ssh-server --help

⚙️ Parameter Options

⚠️ Important Note

When binding to all interfaces (0.0.0.0), your server will be accessible from any machine that can access your system. Ensure strong authentication is used and consider additional security measures such as firewalls.

✨ Features - Key Management Server

You can optionally run an HTTP key management server to simplify client key registration:

uv run m2m-mcp-server-ssh-server --run-key-server

This will start:

• The SSH server listening on port 8022.
• The key management HTTP server listening on port 8000 (default is restricted to localhost).

🔌 Key Management API

The key management server provides the following interfaces:

1. POST /register - Register a client public key.
   • Request body: {"client_pub_key": "ssh-rsa AAAA..."}
   • Response: {"status": "success"} or an error message.
2. GET /server_pub_key - Get the server's public key.
   • Response: {"server_pub_key": "ssh-ed25519 AAAA..."}
3. GET /health - Check the server's health status.
   • Response: {"status": "healthy"}

💻 Usage Examples - Example Client Key Registration

curl -X POST -H "Content-Type: application/json" \
  -d '{"client_pub_key": "ssh-rsa AAAA..."}' \
  http://localhost:8000/register

🔒 Security Precautions

• By default, it binds to localhost (127.0.0.1) for enhanced security.
• Automatically generates keys with secure permissions if not provided.
• The default key location is ~/.ssh/m2m_mcp_server_ssh_server.
• The private key is protected with 0644 permissions.
• Supports client IP address whitelist restrictions.

📚 Dependencies

• Python 3.8+
• pip package manager
• cryptography library (for encryption operations)

🛠️ Development Environment Setup

git clone https://github.com/yourusername/mcp-server-ssh.git
cd mcp-server-ssh
pip install -r requirements.txt
python main.py --help

🤝 Contribution Guidelines

📝 Submitting Code

1. Fork the project repository.
2. Create a feature branch: git checkout -b feature/new-feature.
3. Commit your changes: git commit -m "Add new feature".
4. Push to the branch: git push origin feature/new-feature.
5. Create a Pull Request.

📋 Development Specifications

1. Follow the PEP8 code style guide.
2. Add unit test cases.
3. Ensure documentation is updated.
4. Run the format check before submission: black ..

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.