engineering/sshpiper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc updates (#387)

Browse source 
* chore: Update sshpiperd command with additional options for key generation and log level

* chore: Update README.md with ports to other platforms

* chore: Update CONTRIBUTING.md with note about starting develop environment in vscode
This commit is contained in:
Boshi Lian 2024-05-18 02:51:39 -07:00 • committed by GitHub
parent 7ae7eb68c6
commit 38be0fdd81
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -23,6 +23,8 @@ git submodule update --init --recursive
### Start Develop Environment
_Note_: in vscode, you can use Reopen in dev container to start the develop environment.
```
# in e2e folder, run:
SSHPIPERD_DEBUG=1 docker-compose up --force-recreate --build -d

10
README.md
View file

@ -58,7 +58,7 @@ docker run -d -e USER_NAME=user -e USER_PASSWORD=pass -e PASSWORD_ACCESS=true -p
### start `sshpiperd` with `fixed` plugin targeting the dummy sshd server
```
sudo ./out/sshpiperd ./out/fixed --target 127.0.0.1:5522
./out/sshpiperd -i /tmp/sshpiperkey --server-key-generate-mode notexist --log-level=trace ./out/fixed --target 127.0.0.1:5522
```
### test ssh connection (password: `pass`)
@ -72,7 +72,7 @@ ssh 127.0.0.1 -l user -p 2222
Here illustrates the example of `addional challenge` before the `fixed` plugin.
```
sudo ./out/sshpiperd --log-level=trace ./out/simplemath -- ./out/fixed --target 127.0.0.1:5522
./out/sshpiperd -i /tmp/sshpiperkey --server-key-generate-mode notexist --log-level=trace ./out/simplemath -- ./out/fixed --target 127.0.0.1:5522
```
## Plugins
@ -150,7 +150,11 @@ How this work
| | | |
| | | |
+------------------------+ +----------------+
```
```
## Ports to other platforms
* [sshpiper on OpenWrt](https://github.com/ihidchaos/sshpiper-openwrt) by [@ihidchaos](https://github.com/ihidchaos)
## Migrating from `v0`