Skip to content
Snippets Groups Projects
Commit 674bfd1b authored by David Cowden's avatar David Cowden
Browse files

docs: Groom wording and add a few details

Namely, clarify the different parts of the ssh protocol architecture and
more specifically reference them in wording.
parent dfbd7054
Branches
Tags
No related merge requests found
......@@ -13,15 +13,16 @@ A [single-dependency][gomod] utility package that provides a [`net/http`][net-ht
## Why sshutil?
The `sshutil` package depends solely on the Go [`x/crypto`][crypto] module.
The [`x/crypto/ssh`][crypto-ssh] package provides convenient support for both the [ssh wire protocol][rfc4253] and the [ssh authentication protocol][rfc4252].
The authentication protocol API is, however, scoped to single connections—whereas servers generally accept many connections.
A small, but tedious, amount of work is required to implement a full connection-tracking server for production-like settings.
The [`x/crypto/ssh`][crypto-ssh] package provides convenient support for the [ssh wire protocol][rfc4253], the [ssh authentication protocol][rfc4252], and the [ssh connection protocol][rfc4254].
SSH, and thus the `x/crypto` implementation, is natually scoped to a single connection—whereas servers generally need to accept many connections.
A small, but tedious, amount of work is required to implement a full connection-tracking server for use in applications.
`sshutil` fills in the gap.
[crypto]: https://pkg.go.dev/golang.org/x/crypto
[crypto-ssh]: https://pkg.go.dev/golang.org/x/crypto/ssh
[rfc4252]: https://tools.ietf.org/html/rfc4252
[rfc4253]: https://tools.ietf.org/html/rfc4253
[rfc4254]: https://tools.ietf.org/html/rfc4254
## Get
......
/*
Package sshutil provides utilities for working with the ssh protocol at the
application layer. SSH is specified by: https://tools.ietf.org/html/rfc4252.
application layer. SSH is specified by: https://tools.ietf.org/html/rfc4251.
The ssh server API functions similar to 'net/http'. Register handlers for
various parts of the protocol and process each session as new client
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment