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

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
  • --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.
  • 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.2.tar.gz (11.2 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.2-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: py_simple_sshd-0.1.2.tar.gz
  • Upload date:
  • Size: 11.2 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.2.tar.gz
Algorithm Hash digest
SHA256 e056f5001be34305d5fa6a13fc6e6cc98cb0b854ba59f5c2f22aa5364bd73ad9
MD5 1b3889824a3b519f26bb0582eeb5b608
BLAKE2b-256 19426d7dcc5d685d75a32fb581be88bf3542c34162b02e422a6f36d1cc889920

See more details on using hashes here.

File details

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

File metadata

  • Download URL: py_simple_sshd-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 13.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f1f2d7ee847f77c79e309fba59d0086f4ef366889cc5ab689d976886b30fe367
MD5 efc961ca3f2400a6b23bc5abdada7823
BLAKE2b-256 e8b3d211bbdf284cdb8941225b99c4851e23c46919bb54bb5c7880f917cb43c3

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