From 674bfd1bc95643a016aa77f16add5ad93b2ab9bb Mon Sep 17 00:00:00 2001 From: David Cowden <dcow@smallstep.com> Date: Wed, 17 Jun 2020 02:09:29 -0700 Subject: [PATCH] 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. --- README.md | 7 ++++--- doc.go | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a8c07f7..c8cbda9 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/doc.go b/doc.go index 31258f5..c3e4e17 100644 --- a/doc.go +++ b/doc.go @@ -1,6 +1,6 @@ /* 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 -- GitLab