Skip to main content

A small, production-oriented SSH daemon implemented with Paramiko.

Project description

py-simple-sshd

py-simple-sshd is a compact SSH daemon implemented with Paramiko. It is meant for cases where you need an embeddable, cross-platform SSH entry point that can launch a configured local shell after public-key or password-file authentication.

Installation

pip install py-simple-sshd

Usage

simple-sshd \
  --host 0.0.0.0 \
  --port 2222 \
  --shell /bin/bash \
  --authorized-keys /etc/simple-sshd/authorized_keys

Use --root when the daemon and the shells it starts should run with administrator/root privileges:

simple-sshd --root --host 0.0.0.0 --port 22 --shell /bin/bash --authorized-keys /etc/simple-sshd/authorized_keys

On Windows, errors printed in the elevated --root console pause briefly before exit so the message remains visible.

Password authentication is disabled unless --password-file is provided:

simple-sshd \
  --host 127.0.0.1 \
  --port 2222 \
  --shell /bin/bash \
  --authorized-keys ~/.ssh/authorized_keys \
  --password-file /etc/simple-sshd/password.txt

When both --authorized-keys and --password-file are configured, clients can authenticate with either a listed public key or the password read from the file. If --password-file is omitted, only public-key authentication is available.

On Windows, use a Windows shell path such as:

simple-sshd --host 127.0.0.1 --port 2222 --shell C:\Windows\System32\cmd.exe --password-file .\password.txt

Options

  • --host: address to bind, default 127.0.0.1
  • --port: TCP port to bind, default 2222
  • --shell: shell executable launched for authenticated sessions
  • --authorized-keys: OpenSSH authorized_keys file for public-key auth
  • --password-file: text file whose content is accepted as the SSH password
  • --host-key: private SSH host key; generated under ~/.simple-sshd if omitted
  • --root: relaunch the daemon with administrator/root privileges before serving
  • --log-level: DEBUG, INFO, WARNING, ERROR, or CRITICAL

Notes

  • Password files are read as UTF-8 text. Trailing line endings are removed, while other whitespace is preserved.
  • Host keys are persistent by default so clients can verify the server identity.
  • ANSI/VT escape sequences, including color, bold, cursor movement, clear-screen commands, and raw ESC input, are forwarded through the SSH channel. PTY sessions set TERM from the client's pty request so terminal-aware programs can enable their normal ANSI behavior.
  • POSIX systems use a real pty for terminal sessions. Windows terminal sessions use pywinpty; non-pty sessions use standard process pipes.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_simple_sshd-0.1.7.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_simple_sshd-0.1.7-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file py_simple_sshd-0.1.7.tar.gz.

File metadata

  • Download URL: py_simple_sshd-0.1.7.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Windows/10

File hashes

Hashes for py_simple_sshd-0.1.7.tar.gz
Algorithm Hash digest
SHA256 1ddf264703d89d31c189ffafc0ea64b32e8b530a403236c31ba9f4e800708e8f
MD5 b65131efcc2734f6c7c53f22b6b50390
BLAKE2b-256 1ed38e4d176975c065c911bfc754a56d1dcd384219163261e3afdffc9b90e1b0

See more details on using hashes here.

File details

Details for the file py_simple_sshd-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: py_simple_sshd-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Windows/10

File hashes

Hashes for py_simple_sshd-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 b844cd089c5a8b737b26171bb46150057ed2488bbd00c873c8a911334a92952f
MD5 38444bca887515f6d575f4c67f337eaf
BLAKE2b-256 f00fd233f23f979754653c7c8a91b94c7820f93c215304944de7c9be8da97781

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page