mirror of
https://github.com/damp11113/PyserSSH.git
synced 2025-04-28 06:58:12 +00:00
53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
# What is PyserSSH
|
|
|
|
PyserSSH is a library for remote control your code with ssh client. The aim is to provide a scriptable SSH server which can be made to behave like any SSH-enabled device.
|
|
|
|
This project is part from [damp11113-library](https://github.com/damp11113/damp11113-library)
|
|
|
|
This Server use port **2222** for default port
|
|
|
|
# Install
|
|
Install from pypi
|
|
```bash
|
|
pip install PyserSSH
|
|
```
|
|
Install from github
|
|
```bash
|
|
pip install git+https://github.com/damp11113/PyserSSH.git
|
|
```
|
|
## Optional Packages
|
|
- [damp11113-library](https://github.com/damp11113/damp11113-library)
|
|
|
|
# Quick Example
|
|
```py
|
|
import os
|
|
|
|
from PyserSSH import Server, Send, AccountManager
|
|
|
|
useraccount = AccountManager()
|
|
useraccount.add_account("admin", "") # create user without password
|
|
|
|
ssh = Server(useraccount)
|
|
|
|
@ssh.on_user("command")
|
|
def command(client, command: str):
|
|
if command == "hello":
|
|
Send(client, "world!")
|
|
|
|
ssh.run(os.path.join(os.path.dirname(os.path.realpath(__file__)), 'private_key.pem'))
|
|
```
|
|
This example you can connect with `ssh admin@localhost -p 2222` and press enter on login
|
|
If you input `hello` the response is `world`
|
|
|
|
# Demo
|
|
https://github.com/damp11113/PyserSSH/assets/64675096/49bef3e2-3b15-4b64-b88e-3ca84a955de7
|
|
|
|
See [server.py](https://github.com/damp11113/PyserSSH/blob/main/demo/server.py)
|
|
|
|
I intend to leaked private key because that key i generated new. I recommend to generate new key if you want to use on your host because that key is for demo only.
|
|
why i talk about this? because when i push private key into this repo in next 5 min++ i getting new email from GitGuardian. in that email say "
|
|
GitGuardian has detected the following RSA Private Key exposed within your GitHub account" i dont knows what is GitGuardian and i not install this app into my account.
|
|
|
|
|
|
|