1// Copyright 2011 The Go Authors. All rights reserved.
 2// Use of this source code is governed by a BSD-style
 3// license that can be found in the LICENSE file.
 4
 5/*
 6Package ssh implements an SSH client and server.
 7
 8SSH is a transport security protocol, an authentication protocol and a
 9family of application protocols. The most typical application level
10protocol is a remote shell and this is specifically implemented.  However,
11the multiplexed nature of SSH is exposed to users that wish to support
12others.
13
14References:
15
16	[PROTOCOL]: https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL?rev=HEAD
17	[PROTOCOL.certkeys]: http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.certkeys?rev=HEAD
18	[SSH-PARAMETERS]:    http://www.iana.org/assignments/ssh-parameters/ssh-parameters.xml#ssh-parameters-1
19	[SSH-CERTS]:	https://datatracker.ietf.org/doc/html/draft-miller-ssh-cert-01
20	[FIPS 140-3 mode]: https://go.dev/doc/security/fips140
21
22This package does not fall under the stability promise of the Go language itself,
23so its API may be changed when pressing needs arise.
24
25# FIPS 140-3 mode
26
27When the program is in [FIPS 140-3 mode], this package behaves as if only SP
28800-140C and SP 800-140D approved cipher suites, signature algorithms,
29certificate public key types and sizes, and key exchange and derivation
30algorithms were implemented. Others are silently ignored and not negotiated, or
31rejected. This set may depend on the algorithms supported by the FIPS 140-3 Go
32Cryptographic Module selected with GOFIPS140, and may change across Go versions.
33*/
34package ssh