Files
khm/README.MD
Alexandr Bogomyakov 2f1fcd681e Update README.MD
2025-05-12 02:46:25 +03:00

2.5 KiB

KHM - Known Hosts Manager

KHM allows you to synchronize the known_hosts file across multiple hosts. This application manages SSH keys and flows, either as a server or client. In server mode, it stores keys and flows in a PostgreSQL database. In client mode, it sends keys to the server and can update the known_hosts file with keys from the server.

Features

  • Synchronize known_hosts file across multiple hosts.
  • Manage SSH keys and flows in a PostgreSQL database.
  • Operate in both server and client modes.
  • Automatically update known_hosts file with keys from the server.

Usage

Server Mode

To run the application in server mode, use the following command:

khm --server --ip 127.0.0.1 --port 8080 --db-host 127.0.0.1 --db-name khm --db-user admin --db-password <SECRET> --flows work,home

Client Mode

To run the application in client mode, use the following command:

khm --host http://khm.example.com:8080/<FLOW_NAME>/ --known-hosts ~/.ssh/known_hosts --in-place

Arguments

Options:

  • --server Run in server mode
  • --in-place Server mode: Sync the known_hosts file with keys from the server
  • --flows <FLOWS>... Server mode: Comma-separated list of flows to manage [default: default]
  • -i, --ip <IP> Server mode: IP address to bind the server to [default: 127.0.0.1]
  • -p, --port <PORT> Server mode: Port to bind the server to [default: 8080]
  • --db-host <DB_HOST> Server mode: Hostname or IP address of the PostgreSQL database [default: 127.0.0.1]
  • --db-name <DB_NAME> Server mode: Name of the PostgreSQL database [default: khm]
  • --db-user <DB_USER> Server mode: Username for the PostgreSQL database
  • --db-password <DB_PASSWORD> Server mode: Password for the PostgreSQL database
  • --basic-auth <BASIC_AUTH> Client mode: Basic Auth credentials [default: ""]
  • --host <HOST> Client mode: Full host address of the server to connect to. Like https://khm.example.com/<FLOW_NAME>
  • --known-hosts <KNOWN_HOSTS> Client mode: Path to the known_hosts file [default: ~/.ssh/known_hosts]

Installation

  1. Ensure you have Rust installed. If not, you can install it from rustup.rs.
  2. Clone the repository:
    git clone https://github.com/house-of-vanity/khm.git
    cd khm
    
  3. Run the project:
    cargo run --release -- --help
    

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

This project is licensed under the WTFPL License.