upstream: Call comma-separated lists as such to clarify semantics

Options such as Ciphers take values that may be a list of ciphers;  the
complete list, not indiviual elements, may be prefixed with a dash or plus
character to remove from or append to the default list respectively.

Users might read the current text as if each elment took an optional prefix,
so tweak the wording from "values" to "list" to prevent such ambiguity for
all options supporting this semantics (those that provide a list of
available elements via "ssh -Q ...").

Input and OK jmc

OpenBSD-Commit-ID: 4fdd175b0e5f5cb10ab3f26ccc38a93bb6515d57
1 file changed
tree: dc80779ae1927630fca5d540fbe7d0e5d1c6c53a
  1. contrib/
  2. openbsd-compat/
  3. regress/
  4. .depend
  5. .gitignore
  6. .skipped-commit-ids
  7. aclocal.m4
  8. addrmatch.c
  9. atomicio.c
  10. atomicio.h
  11. audit-bsm.c
  12. audit-linux.c
  13. audit.c
  14. audit.h
  15. auth-bsdauth.c
  16. auth-krb5.c
  17. auth-options.c
  18. auth-options.h
  19. auth-pam.c
  20. auth-pam.h
  21. auth-passwd.c
  22. auth-rhosts.c
  23. auth-shadow.c
  24. auth-sia.c
  25. auth-sia.h
  26. auth-skey.c
  27. auth.c
  28. auth.h
  29. auth2-chall.c
  30. auth2-gss.c
  31. auth2-hostbased.c
  32. auth2-kbdint.c
  33. auth2-none.c
  34. auth2-passwd.c
  35. auth2-pubkey.c
  36. auth2.c
  37. authfd.c
  38. authfd.h
  39. authfile.c
  40. authfile.h
  41. bitmap.c
  42. bitmap.h
  43. buildpkg.sh.in
  44. canohost.c
  45. canohost.h
  46. chacha.c
  47. chacha.h
  48. channels.c
  49. channels.h
  50. cipher-aes.c
  51. cipher-aesctr.c
  52. cipher-aesctr.h
  53. cipher-chachapoly.c
  54. cipher-chachapoly.h
  55. cipher-ctr.c
  56. cipher.c
  57. cipher.h
  58. cleanup.c
  59. clientloop.c
  60. clientloop.h
  61. compat.c
  62. compat.h
  63. config.guess
  64. config.sub
  65. configure.ac
  66. CREDITS
  67. crypto_api.h
  68. defines.h
  69. dh.c
  70. dh.h
  71. digest-libc.c
  72. digest-openssl.c
  73. digest.h
  74. dispatch.c
  75. dispatch.h
  76. dns.c
  77. dns.h
  78. ed25519.c
  79. entropy.c
  80. entropy.h
  81. fatal.c
  82. fe25519.c
  83. fe25519.h
  84. fixalgorithms
  85. fixpaths
  86. ge25519.c
  87. ge25519.h
  88. ge25519_base.data
  89. groupaccess.c
  90. groupaccess.h
  91. gss-genr.c
  92. gss-serv-krb5.c
  93. gss-serv.c
  94. hash.c
  95. hmac.c
  96. hmac.h
  97. hostfile.c
  98. hostfile.h
  99. includes.h
  100. INSTALL
  101. install-sh
  102. kex.c
  103. kex.h
  104. kexc25519.c
  105. kexdh.c
  106. kexecdh.c
  107. kexgen.c
  108. kexgex.c
  109. kexgexc.c
  110. kexgexs.c
  111. kexsntrup4591761x25519.c
  112. krl.c
  113. krl.h
  114. LICENCE
  115. log.c
  116. log.h
  117. loginrec.c
  118. loginrec.h
  119. logintest.c
  120. mac.c
  121. mac.h
  122. Makefile.in
  123. match.c
  124. match.h
  125. md5crypt.c
  126. md5crypt.h
  127. mdoc2man.awk
  128. misc.c
  129. misc.h
  130. mkinstalldirs
  131. moduli
  132. moduli.5
  133. moduli.c
  134. monitor.c
  135. monitor.h
  136. monitor_fdpass.c
  137. monitor_fdpass.h
  138. monitor_wrap.c
  139. monitor_wrap.h
  140. msg.c
  141. msg.h
  142. mux.c
  143. myproposal.h
  144. nchan.c
  145. nchan.ms
  146. nchan2.ms
  147. openssh.xml.in
  148. opensshd.init.in
  149. OVERVIEW
  150. packet.c
  151. packet.h
  152. pathnames.h
  153. pkcs11.h
  154. platform-misc.c
  155. platform-pledge.c
  156. platform-tracing.c
  157. platform.c
  158. platform.h
  159. poly1305.c
  160. poly1305.h
  161. progressmeter.c
  162. progressmeter.h
  163. PROTOCOL
  164. PROTOCOL.agent
  165. PROTOCOL.certkeys
  166. PROTOCOL.chacha20poly1305
  167. PROTOCOL.key
  168. PROTOCOL.krl
  169. PROTOCOL.mux
  170. readconf.c
  171. readconf.h
  172. README
  173. README.dns
  174. README.md
  175. README.platform
  176. README.privsep
  177. README.tun
  178. readpass.c
  179. rijndael.c
  180. rijndael.h
  181. sandbox-capsicum.c
  182. sandbox-darwin.c
  183. sandbox-null.c
  184. sandbox-pledge.c
  185. sandbox-rlimit.c
  186. sandbox-seccomp-filter.c
  187. sandbox-solaris.c
  188. sandbox-systrace.c
  189. sc25519.c
  190. sc25519.h
  191. scp.1
  192. scp.c
  193. servconf.c
  194. servconf.h
  195. serverloop.c
  196. serverloop.h
  197. session.c
  198. session.h
  199. sftp-client.c
  200. sftp-client.h
  201. sftp-common.c
  202. sftp-common.h
  203. sftp-glob.c
  204. sftp-realpath.c
  205. sftp-server-main.c
  206. sftp-server.8
  207. sftp-server.c
  208. sftp.1
  209. sftp.c
  210. sftp.h
  211. smult_curve25519_ref.c
  212. sntrup4591761.c
  213. sntrup4591761.sh
  214. ssh-add.1
  215. ssh-add.c
  216. ssh-agent.1
  217. ssh-agent.c
  218. ssh-dss.c
  219. ssh-ecdsa.c
  220. ssh-ed25519.c
  221. ssh-gss.h
  222. ssh-keygen.1
  223. ssh-keygen.c
  224. ssh-keyscan.1
  225. ssh-keyscan.c
  226. ssh-keysign.8
  227. ssh-keysign.c
  228. ssh-pkcs11-client.c
  229. ssh-pkcs11-helper.8
  230. ssh-pkcs11-helper.c
  231. ssh-pkcs11.c
  232. ssh-pkcs11.h
  233. ssh-rsa.c
  234. ssh-sandbox.h
  235. ssh-xmss.c
  236. ssh.1
  237. ssh.c
  238. ssh.h
  239. ssh2.h
  240. ssh_api.c
  241. ssh_api.h
  242. ssh_config
  243. ssh_config.5
  244. sshbuf-getput-basic.c
  245. sshbuf-getput-crypto.c
  246. sshbuf-misc.c
  247. sshbuf.c
  248. sshbuf.h
  249. sshconnect.c
  250. sshconnect.h
  251. sshconnect2.c
  252. sshd.8
  253. sshd.c
  254. sshd_config
  255. sshd_config.5
  256. ssherr.c
  257. ssherr.h
  258. sshkey-xmss.c
  259. sshkey-xmss.h
  260. sshkey.c
  261. sshkey.h
  262. sshlogin.c
  263. sshlogin.h
  264. sshpty.c
  265. sshpty.h
  266. sshtty.c
  267. survey.sh.in
  268. TODO
  269. ttymodes.c
  270. ttymodes.h
  271. uidswap.c
  272. uidswap.h
  273. umac.c
  274. umac.h
  275. umac128.c
  276. utf8.c
  277. utf8.h
  278. verify.c
  279. version.h
  280. xmalloc.c
  281. xmalloc.h
  282. xmss_commons.c
  283. xmss_commons.h
  284. xmss_fast.c
  285. xmss_fast.h
  286. xmss_hash.c
  287. xmss_hash.h
  288. xmss_hash_address.c
  289. xmss_hash_address.h
  290. xmss_wots.c
  291. xmss_wots.h
README.md

Portable OpenSSH

OpenSSH is a complete implementation of the SSH protocol (version 2) for secure remote login, command execution and file transfer. It includes a client ssh and server sshd, file transfer utilities scp and sftp as well as tools for key generation (ssh-keygen), run-time key storage (ssh-agent) and a number of supporting programs.

This is a port of OpenBSD's OpenSSH to most Unix-like operating systems, including Linux, OS X and Cygwin. Portable OpenSSH polyfills OpenBSD APIs that are not available elsewhere, adds sshd sandboxing for more operating systems and includes support for OS-native authentication and auditing (e.g. using PAM).

Documentation

The official documentation for OpenSSH are the man pages for each tool:

Stable Releases

Stable release tarballs are available from a number of download mirrors. We recommend the use of a stable release for most users. Please read the release notes for details of recent changes and potential incompatibilities.

Building Portable OpenSSH

Dependencies

Portable OpenSSH is built using autoconf and make. It requires a working C compiler, standard library and headers, as well as zlib and libcrypto from either LibreSSL or OpenSSL to build. Certain platforms and build-time options may require additional dependencies.

Building a release

Releases include a pre-built copy of the configure script and may be built using:

tar zxvf openssh-X.Y.tar.gz
cd openssh
./configure # [options]
make && make tests

See the Build-time Customisation section below for configure options. If you plan on installing OpenSSH to your system, then you will usually want to specify destination paths.

Building from git

If building from git, you'll need autoconf installed to build the configure script. The following commands will check out and build portable OpenSSH from git:

git clone https://github.com/openssh/openssh-portable # or https://anongit.mindrot.org/openssh.git
cd openssh-portable
autoreconf
./configure
make && make tests

Build-time Customisation

There are many build-time customisation options available. All Autoconf destination path flags (e.g. --prefix) are supported (and are usually required if you want to install OpenSSH).

For a full list of available flags, run configure --help but a few of the more frequently-used ones are described below. Some of these flags will require additional libraries and/or headers be installed.

FlagMeaning
--with-pamEnable PAM support. OpenPAM, Linux PAM and Solaris PAM are supported.
--with-libeditEnable libedit support for sftp.
--with-kerberos5Enable Kerberos/GSSAPI support. Both Heimdal and MIT Kerberos implementations are supported.
--with-selinuxEnable SELinux support.

Development

Portable OpenSSH development is discussed on the openssh-unix-dev mailing list (archive mirror). Bugs and feature requests are tracked on our Bugzilla.

Reporting bugs

Non-security bugs may be reported to the developers via Bugzilla or via the mailing list above. Security bugs should be reported to openssh@openssh.com.