2016-11-30 22:06:57 +00:00
# gliderlabs/ssh
2017-03-06 20:25:59 +00:00
[](http://slack.gliderlabs.com) [](https://godoc.org/github.com/gliderlabs/ssh) [](https://goreportcard.com/report/github.com/gliderlabs/ssh) [](#backers) [](#sponsors)
2016-11-30 22:06:57 +00:00
This Go package wraps the [crypto/ssh
package](https://godoc.org/golang.org/x/crypto/ssh) with a higher-level API for
building SSH servers. The goal of the API was to make it as simple as using
[net/http ](https://golang.org/pkg/net/http/ ), so the API is very similar:
```
2016-12-03 15:08:19 +00:00
package main
2017-04-14 19:47:40 +00:00
2016-12-03 15:08:19 +00:00
import (
"github.com/gliderlabs/ssh"
"io"
"log"
)
2017-04-14 19:47:40 +00:00
2016-12-03 15:08:19 +00:00
func main() {
ssh.Handle(func(s ssh.Session) {
io.WriteString(s, "Hello world\n")
})
2017-04-14 19:47:40 +00:00
2016-12-03 15:08:19 +00:00
log.Fatal(ssh.ListenAndServe(":2222", nil))
}
2016-11-30 22:06:57 +00:00
```
2017-04-14 19:47:40 +00:00
This package was built after working on nearly a dozen projects at Glider Labs using SSH and collaborating with [@shazow ](https://twitter.com/shazow ) (known for [ssh-chat ](https://github.com/shazow/ssh-chat )).
## Examples
2017-07-12 17:27:56 +00:00
A bunch of great examples are in the `_examples` directory.
2016-11-30 22:06:57 +00:00
## Usage
[See GoDoc reference. ](https://godoc.org/github.com/gliderlabs/ssh )
## Testing
We could use some help figuring out the best way to test this library. Since
there is very little functionality it's adding, it doesn't seem appropriate to
duplicate the crypto/ssh tests, however, maybe that's actually the best idea. Perform
the same tests using this API.
## Contributing
Pull requests are welcome! However, since this project is very much about API
design, please submit API changes as issues to discuss before submitting PRs.
Also, you can [join our Slack ](http://slack.gliderlabs.com ) to discuss as well.
2017-03-06 20:25:59 +00:00
## Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer ](https://opencollective.com/ssh#backer )]
< a href = "https://opencollective.com/ssh/backer/0/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/1/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/2/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/3/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/4/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/5/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/6/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/7/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/8/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/9/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/10/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/11/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/12/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/13/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/14/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/15/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/16/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/17/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/18/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/19/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/20/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/21/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/22/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/23/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/24/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/25/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/26/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/27/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/28/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/backer/29/website" target = "_blank" > < img src = "https://opencollective.com/ssh/backer/29/avatar.svg" > < / a >
## Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor ](https://opencollective.com/ssh#sponsor )]
< a href = "https://opencollective.com/ssh/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/10/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/11/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/12/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/13/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/14/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/15/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/16/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/17/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/18/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/19/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/20/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/21/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/22/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/23/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/24/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/25/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/26/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/27/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/28/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/ssh/sponsor/29/website" target = "_blank" > < img src = "https://opencollective.com/ssh/sponsor/29/avatar.svg" > < / a >
2016-11-30 22:06:57 +00:00
## License
BSD
