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

Update README.md

Browse source
This commit is contained in:
Boshi Lian 2018-02-20 04:58:11 +08:00
parent 49170a50f8
commit e1a1fcfde4
1 changed files with 5 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -54,7 +54,6 @@ docker run -d -p 2222:2222 \
-v /YOUR_WORKING_DIR:/var/sshpiper \ -v /YOUR_WORKING_DIR:/var/sshpiper \
farmer1992/sshpiperd farmer1992/sshpiperd
``` ```
Run with [Additional Challenge](#additional-challenge) Run with [Additional Challenge](#additional-challenge)
use env `SSHPIPERD_CHALLENGER` to specify which challenger to use use env `SSHPIPERD_CHALLENGER` to specify which challenger to use
@ -253,7 +252,7 @@ ssh-copy-id -i workingdir/test/id_rsa test@server
now `ssh test@sshpiper -i -i PK_X`, sshpiper will send `PK_Y` to server instead of `PK_X`. now `ssh test@sshpiper -i -i PK_X`, sshpiper will send `PK_Y` to server instead of `PK_X`.
### Additional Challenge ### Additional Challenge (`--challenger-driver=`)
ssh piper allows you run your own challenge before dialing to the upstream. ssh piper allows you run your own challenge before dialing to the upstream.
if a client failed in this challenge, connection will be closed. if a client failed in this challenge, connection will be closed.
@ -274,8 +273,11 @@ This is useful when you want use publickey and something like [google-authentica
you can configure the rule at `/etc/pam.d/sshpiperd` you can configure the rule at `/etc/pam.d/sshpiperd`
* welcometext
### SSH Session logging (`--record_typescript`) Do nothing, but print a welcome text
### SSH Session logging (`--auditor-driver=typescript-logger`)
When `record_typescript` is allowed, each piped connection would be recorded into [typescript](https://en.wikipedia.org/wiki/Script_(Unix)) in working_dir. When `record_typescript` is allowed, each piped connection would be recorded into [typescript](https://en.wikipedia.org/wiki/Script_(Unix)) in working_dir.
@ -298,22 +300,9 @@ This is useful when you want use publickey and something like [google-authentica
$ scriptreplay -t 1472847798.timing 1472847798.typescript # will replay the ssh session $ scriptreplay -t 1472847798.timing 1472847798.typescript # will replay the ssh session
``` ```
## API @ [![GoDoc](https://godoc.org/github.com/tg123/sshpiper?status.svg)](https://godoc.org/github.com/tg123/sshpiper/ssh#SSHPiperConfig)
Package ssh in sshpiper is compatible with [golang.org/x/crypto/ssh](http://golang.org/x/crypto/ssh).
All func and datatype left unchanged. You can use it like [golang.org/x/crypto/ssh](http://golang.org/x/crypto/ssh).
SSHPiper additional API
* [NewSSHPiperConn](https://godoc.org/github.com/tg123/sshpiper/ssh#NewSSHPiperConn)
* [SSHPiperConfig](https://godoc.org/github.com/tg123/sshpiper/ssh#SSHPiperConfig)
## TODO List ## TODO List
* live upgrade * live upgrade
* man page
* hostbased auth support * hostbased auth support
* ssh-copy-id support or tools * ssh-copy-id support or tools
* challenger: menu challenger * challenger: menu challenger