Annotation of src/usr.bin/ssh/ssh-keygen.1, Revision 1.197
1.197 ! djm 1: .\" $OpenBSD: ssh-keygen.1,v 1.196 2020/01/23 23:31:52 djm Exp $
1.1 deraadt 2: .\"
3: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5: .\" All rights reserved
6: .\"
1.22 deraadt 7: .\" As far as I am concerned, the code I have written for this software
8: .\" can be used freely for any purpose. Any derived versions of this
9: .\" software must be clearly marked as such, and if the derived work is
10: .\" incompatible with the protocol description in the RFC file, it must be
11: .\" called by a name other than "ssh" or "Secure Shell".
12: .\"
13: .\"
1.33 deraadt 14: .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
15: .\" Copyright (c) 1999 Aaron Campbell. All rights reserved.
16: .\" Copyright (c) 1999 Theo de Raadt. All rights reserved.
1.22 deraadt 17: .\"
18: .\" Redistribution and use in source and binary forms, with or without
19: .\" modification, are permitted provided that the following conditions
20: .\" are met:
21: .\" 1. Redistributions of source code must retain the above copyright
22: .\" notice, this list of conditions and the following disclaimer.
23: .\" 2. Redistributions in binary form must reproduce the above copyright
24: .\" notice, this list of conditions and the following disclaimer in the
25: .\" documentation and/or other materials provided with the distribution.
1.1 deraadt 26: .\"
1.22 deraadt 27: .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
28: .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
29: .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30: .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
31: .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32: .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33: .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34: .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35: .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
36: .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1.1 deraadt 37: .\"
1.195 jmc 38: .Dd $Mdocdate: January 23 2020 $
1.2 deraadt 39: .Dt SSH-KEYGEN 1
40: .Os
41: .Sh NAME
42: .Nm ssh-keygen
1.179 jmc 43: .Nd OpenSSH authentication key utility
1.2 deraadt 44: .Sh SYNOPSIS
45: .Nm ssh-keygen
1.25 markus 46: .Op Fl q
1.2 deraadt 47: .Op Fl b Ar bits
48: .Op Fl C Ar comment
1.20 markus 49: .Op Fl f Ar output_keyfile
1.155 djm 50: .Op Fl m Ar format
1.175 djm 51: .Op Fl t Cm dsa | ecdsa | ecdsa-sk | ed25519 | ed25519-sk | rsa
1.171 jmc 52: .Op Fl N Ar new_passphrase
1.191 naddy 53: .Op Fl O Ar option
1.173 naddy 54: .Op Fl w Ar provider
1.2 deraadt 55: .Nm ssh-keygen
56: .Fl p
1.9 markus 57: .Op Fl f Ar keyfile
1.155 djm 58: .Op Fl m Ar format
1.171 jmc 59: .Op Fl N Ar new_passphrase
60: .Op Fl P Ar old_passphrase
1.2 deraadt 61: .Nm ssh-keygen
1.37 markus 62: .Fl i
1.171 jmc 63: .Op Fl f Ar input_keyfile
1.95 djm 64: .Op Fl m Ar key_format
1.16 deraadt 65: .Nm ssh-keygen
1.37 markus 66: .Fl e
1.171 jmc 67: .Op Fl f Ar input_keyfile
1.95 djm 68: .Op Fl m Ar key_format
1.16 deraadt 69: .Nm ssh-keygen
1.17 markus 70: .Fl y
1.20 markus 71: .Op Fl f Ar input_keyfile
1.17 markus 72: .Nm ssh-keygen
1.2 deraadt 73: .Fl c
74: .Op Fl C Ar comment
1.9 markus 75: .Op Fl f Ar keyfile
1.171 jmc 76: .Op Fl P Ar passphrase
1.9 markus 77: .Nm ssh-keygen
78: .Fl l
1.125 naddy 79: .Op Fl v
1.124 djm 80: .Op Fl E Ar fingerprint_hash
1.35 markus 81: .Op Fl f Ar input_keyfile
82: .Nm ssh-keygen
83: .Fl B
1.20 markus 84: .Op Fl f Ar input_keyfile
1.48 jakob 85: .Nm ssh-keygen
1.82 jmc 86: .Fl D Ar pkcs11
1.48 jakob 87: .Nm ssh-keygen
1.64 djm 88: .Fl F Ar hostname
1.170 jmc 89: .Op Fl lv
1.64 djm 90: .Op Fl f Ar known_hosts_file
91: .Nm ssh-keygen
92: .Fl H
93: .Op Fl f Ar known_hosts_file
94: .Nm ssh-keygen
1.187 djm 95: .Fl K
96: .Op Fl w Ar provider
97: .Nm ssh-keygen
1.64 djm 98: .Fl R Ar hostname
99: .Op Fl f Ar known_hosts_file
1.57 jakob 100: .Nm ssh-keygen
101: .Fl r Ar hostname
1.170 jmc 102: .Op Fl g
1.57 jakob 103: .Op Fl f Ar input_keyfile
1.60 djm 104: .Nm ssh-keygen
1.184 djm 105: .Fl M Cm generate
106: .Op Fl O Ar option
1.191 naddy 107: .Ar output_file
1.60 djm 108: .Nm ssh-keygen
1.184 djm 109: .Fl M Cm screen
1.191 naddy 110: .Op Fl f Ar input_file
1.184 djm 111: .Op Fl O Ar option
1.191 naddy 112: .Ar output_file
1.84 djm 113: .Nm ssh-keygen
1.171 jmc 114: .Fl I Ar certificate_identity
1.84 djm 115: .Fl s Ar ca_key
1.170 jmc 116: .Op Fl hU
1.142 djm 117: .Op Fl D Ar pkcs11_provider
1.84 djm 118: .Op Fl n Ar principals
1.93 djm 119: .Op Fl O Ar option
1.84 djm 120: .Op Fl V Ar validity_interval
1.93 djm 121: .Op Fl z Ar serial_number
1.84 djm 122: .Ar
1.86 djm 123: .Nm ssh-keygen
124: .Fl L
125: .Op Fl f Ar input_keyfile
1.102 stevesk 126: .Nm ssh-keygen
127: .Fl A
1.143 djm 128: .Op Fl f Ar prefix_path
1.111 djm 129: .Nm ssh-keygen
130: .Fl k
131: .Fl f Ar krl_file
132: .Op Fl u
1.112 jmc 133: .Op Fl s Ar ca_public
134: .Op Fl z Ar version_number
1.111 djm 135: .Ar
136: .Nm ssh-keygen
137: .Fl Q
138: .Fl f Ar krl_file
139: .Ar
1.163 djm 140: .Nm ssh-keygen
1.196 djm 141: .Fl Y Cm find-principals
1.194 djm 142: .Fl s Ar signature_file
143: .Fl f Ar allowed_signers_file
144: .Nm ssh-keygen
1.171 jmc 145: .Fl Y Cm check-novalidate
146: .Fl n Ar namespace
147: .Fl s Ar signature_file
148: .Nm ssh-keygen
1.163 djm 149: .Fl Y Cm sign
150: .Fl f Ar key_file
151: .Fl n Ar namespace
152: .Ar
153: .Nm ssh-keygen
154: .Fl Y Cm verify
1.171 jmc 155: .Fl f Ar allowed_signers_file
1.163 djm 156: .Fl I Ar signer_identity
157: .Fl n Ar namespace
158: .Fl s Ar signature_file
159: .Op Fl r Ar revocation_file
1.13 aaron 160: .Sh DESCRIPTION
1.2 deraadt 161: .Nm
1.37 markus 162: generates, manages and converts authentication keys for
1.2 deraadt 163: .Xr ssh 1 .
1.15 deraadt 164: .Nm
1.140 jmc 165: can create keys for use by SSH protocol version 2.
1.130 jmc 166: .Pp
1.58 jmc 167: The type of key to be generated is specified with the
1.25 markus 168: .Fl t
1.52 djm 169: option.
1.70 djm 170: If invoked without any arguments,
171: .Nm
1.141 naddy 172: will generate an RSA key.
1.15 deraadt 173: .Pp
1.60 djm 174: .Nm
175: is also used to generate groups for use in Diffie-Hellman group
176: exchange (DH-GEX).
177: See the
178: .Sx MODULI GENERATION
179: section for details.
180: .Pp
1.111 djm 181: Finally,
182: .Nm
183: can be used to generate and update Key Revocation Lists, and to test whether
1.112 jmc 184: given keys have been revoked by one.
185: See the
1.111 djm 186: .Sx KEY REVOCATION LISTS
187: section for details.
188: .Pp
1.2 deraadt 189: Normally each user wishing to use SSH
1.99 djm 190: with public key authentication runs this once to create the authentication
1.1 deraadt 191: key in
1.118 naddy 192: .Pa ~/.ssh/id_dsa ,
1.99 djm 193: .Pa ~/.ssh/id_ecdsa ,
1.173 naddy 194: .Pa ~/.ssh/id_ecdsa_sk ,
1.176 naddy 195: .Pa ~/.ssh/id_ed25519 ,
196: .Pa ~/.ssh/id_ed25519_sk
1.15 deraadt 197: or
1.68 djm 198: .Pa ~/.ssh/id_rsa .
1.15 deraadt 199: Additionally, the system administrator may use this to generate host keys,
200: as seen in
201: .Pa /etc/rc .
1.2 deraadt 202: .Pp
1.1 deraadt 203: Normally this program generates the key and asks for a file in which
1.12 aaron 204: to store the private key.
205: The public key is stored in a file with the same name but
1.2 deraadt 206: .Dq .pub
1.12 aaron 207: appended.
208: The program also asks for a passphrase.
209: The passphrase may be empty to indicate no passphrase
1.26 markus 210: (host keys must have an empty passphrase), or it may be a string of
1.12 aaron 211: arbitrary length.
1.51 stevesk 212: A passphrase is similar to a password, except it can be a phrase with a
213: series of words, punctuation, numbers, whitespace, or any string of
214: characters you want.
215: Good passphrases are 10-30 characters long, are
1.1 deraadt 216: not simple sentences or otherwise easily guessable (English
1.42 markus 217: prose has only 1-2 bits of entropy per character, and provides very bad
1.51 stevesk 218: passphrases), and contain a mix of upper and lowercase letters,
219: numbers, and non-alphanumeric characters.
1.12 aaron 220: The passphrase can be changed later by using the
1.2 deraadt 221: .Fl p
1.1 deraadt 222: option.
1.2 deraadt 223: .Pp
1.12 aaron 224: There is no way to recover a lost passphrase.
1.105 djm 225: If the passphrase is lost or forgotten, a new key must be generated
226: and the corresponding public key copied to other machines.
1.2 deraadt 227: .Pp
1.153 djm 228: .Nm
229: will by default write keys in an OpenSSH-specific format.
230: This format is preferred as it offers better protection for
231: keys at rest as well as allowing storage of key comments within
232: the private key file itself.
233: The key comment may be useful to help identify the key.
1.12 aaron 234: The comment is initialized to
1.2 deraadt 235: .Dq user@host
236: when the key is created, but can be changed using the
237: .Fl c
1.1 deraadt 238: option.
1.153 djm 239: .Pp
240: It is still possible for
241: .Nm
242: to write the previously-used PEM format private keys using the
243: .Fl m
244: flag.
245: This may be used when generating new keys, and existing new-format
246: keys may be converted using this option in conjunction with the
247: .Fl p
248: (change passphrase) flag.
1.2 deraadt 249: .Pp
1.15 deraadt 250: After a key is generated, instructions below detail where the keys
251: should be placed to be activated.
252: .Pp
1.2 deraadt 253: The options are as follows:
254: .Bl -tag -width Ds
1.102 stevesk 255: .It Fl A
1.175 djm 256: For each of the key types (rsa, dsa, ecdsa and ed25519)
1.118 naddy 257: for which host keys
1.102 stevesk 258: do not exist, generate the host keys with the default key file path,
259: an empty passphrase, default bits for the key type, and default comment.
1.144 jmc 260: If
1.143 djm 261: .Fl f
1.144 jmc 262: has also been specified, its argument is used as a prefix to the
1.143 djm 263: default path for the resulting host key files.
1.104 jmc 264: This is used by
1.102 stevesk 265: .Pa /etc/rc
266: to generate new host keys.
1.117 djm 267: .It Fl a Ar rounds
1.169 jmc 268: When saving a private key, this option specifies the number of KDF
1.148 djm 269: (key derivation function) rounds used.
1.117 djm 270: Higher numbers result in slower passphrase verification and increased
271: resistance to brute-force password cracking (should the keys be stolen).
1.66 jmc 272: .It Fl B
273: Show the bubblebabble digest of specified private or public key file.
1.2 deraadt 274: .It Fl b Ar bits
1.12 aaron 275: Specifies the number of bits in the key to create.
1.158 dtucker 276: For RSA keys, the minimum size is 1024 bits and the default is 3072 bits.
277: Generally, 3072 bits is considered sufficient.
1.72 dtucker 278: DSA keys must be exactly 1024 bits as specified by FIPS 186-2.
1.106 djm 279: For ECDSA keys, the
280: .Fl b
1.107 deraadt 281: flag determines the key length by selecting from one of three elliptic
1.106 djm 282: curve sizes: 256, 384 or 521 bits.
283: Attempting to use bit lengths other than these three values for ECDSA keys
284: will fail.
1.176 naddy 285: ECDSA-SK, Ed25519 and Ed25519-SK keys have a fixed length and the
1.118 naddy 286: .Fl b
287: flag will be ignored.
1.66 jmc 288: .It Fl C Ar comment
289: Provides a new comment.
1.2 deraadt 290: .It Fl c
1.1 deraadt 291: Requests changing the comment in the private and public key files.
292: The program will prompt for the file containing the private keys, for
1.41 stevesk 293: the passphrase if the key has one, and for the new comment.
1.81 markus 294: .It Fl D Ar pkcs11
1.157 naddy 295: Download the public keys provided by the PKCS#11 shared library
1.83 markus 296: .Ar pkcs11 .
1.98 djm 297: When used in combination with
298: .Fl s ,
299: this option indicates that a CA key resides in a PKCS#11 token (see the
300: .Sx CERTIFICATES
301: section for details).
1.124 djm 302: .It Fl E Ar fingerprint_hash
303: Specifies the hash algorithm used when displaying key fingerprints.
304: Valid options are:
305: .Dq md5
306: and
307: .Dq sha256 .
308: The default is
309: .Dq sha256 .
1.37 markus 310: .It Fl e
1.40 markus 311: This option will read a private or public OpenSSH key file and
1.154 djm 312: print to stdout a public key in one of the formats specified by the
1.95 djm 313: .Fl m
314: option.
315: The default export format is
316: .Dq RFC4716 .
1.96 jmc 317: This option allows exporting OpenSSH keys for use by other programs, including
1.95 djm 318: several commercial SSH implementations.
1.151 djm 319: .It Fl F Ar hostname | [hostname]:port
1.66 jmc 320: Search for the specified
321: .Ar hostname
1.151 djm 322: (with optional port number)
1.66 jmc 323: in a
324: .Pa known_hosts
325: file, listing any occurrences found.
326: This option is useful to find hashed host names or addresses and may also be
327: used in conjunction with the
328: .Fl H
329: option to print found keys in a hashed format.
330: .It Fl f Ar filename
331: Specifies the filename of the key file.
1.57 jakob 332: .It Fl g
1.62 jakob 333: Use generic DNS format when printing fingerprint resource records using the
1.63 jmc 334: .Fl r
1.62 jakob 335: command.
1.66 jmc 336: .It Fl H
337: Hash a
338: .Pa known_hosts
1.67 dtucker 339: file.
340: This replaces all hostnames and addresses with hashed representations
341: within the specified file; the original content is moved to a file with
342: a .old suffix.
1.66 jmc 343: These hashes may be used normally by
344: .Nm ssh
345: and
346: .Nm sshd ,
347: but they do not reveal identifying information should the file's contents
348: be disclosed.
349: This option will not modify existing hashed hostnames and is therefore safe
350: to use on files that mix hashed and non-hashed names.
1.84 djm 351: .It Fl h
352: When signing a key, create a host certificate instead of a user
353: certificate.
354: Please see the
355: .Sx CERTIFICATES
356: section for details.
1.85 jmc 357: .It Fl I Ar certificate_identity
1.84 djm 358: Specify the key identity when signing a public key.
359: Please see the
360: .Sx CERTIFICATES
361: section for details.
1.37 markus 362: .It Fl i
363: This option will read an unencrypted private (or public) key file
1.95 djm 364: in the format specified by the
365: .Fl m
366: option and print an OpenSSH compatible private
1.37 markus 367: (or public) key to stdout.
1.122 jmc 368: This option allows importing keys from other software, including several
369: commercial SSH implementations.
370: The default import format is
371: .Dq RFC4716 .
1.188 jmc 372: .It Fl K
1.187 djm 373: Download resident keys from a FIDO authenticator.
374: Public and private key files will be written to the current directory for
375: each downloaded key.
1.111 djm 376: .It Fl k
377: Generate a KRL file.
378: In this mode,
379: .Nm
380: will generate a KRL file at the location specified via the
381: .Fl f
1.114 jmc 382: flag that revokes every key or certificate presented on the command line.
1.111 djm 383: Keys/certificates to be revoked may be specified by public key file or
384: using the format described in the
385: .Sx KEY REVOCATION LISTS
386: section.
1.86 djm 387: .It Fl L
1.129 djm 388: Prints the contents of one or more certificates.
1.9 markus 389: .It Fl l
1.77 grunk 390: Show fingerprint of specified public key file.
1.50 markus 391: For RSA and DSA keys
392: .Nm
1.78 jmc 393: tries to find the matching public key file and prints its fingerprint.
394: If combined with
395: .Fl v ,
1.132 jmc 396: a visual ASCII art representation of the key is supplied with the
1.131 djm 397: fingerprint.
1.184 djm 398: .It Fl M Cm generate
399: Generate candidate Diffie-Hellman Group Exchange (DH-GEX) parameters for
400: eventual use by the
401: .Sq diffie-hellman-group-exchange-*
402: key exchange methods.
403: The numbers generated by this operation must be further screened before
404: use.
405: See the
406: .Sx MODULI GENERATION
407: section for more information.
408: .It Fl M Cm screen
409: Screen candidate parameters for Diffie-Hellman Group Exchange.
410: This will accept a list of candidate numbers and test that they are
411: safe (Sophie Germain) primes with acceptable group generators.
412: The results of this operation may be added to the
413: .Pa /etc/moduli
414: file.
415: See the
416: .Sx MODULI GENERATION
417: section for more information.
1.95 djm 418: .It Fl m Ar key_format
1.155 djm 419: Specify a key format for key generation, the
1.95 djm 420: .Fl i
1.155 djm 421: (import),
1.95 djm 422: .Fl e
1.155 djm 423: (export) conversion options, and the
424: .Fl p
425: change passphrase operation.
426: The latter may be used to convert between OpenSSH private key and PEM
427: private key formats.
1.95 djm 428: The supported key formats are:
429: .Dq RFC4716
1.96 jmc 430: (RFC 4716/SSH2 public or private key),
1.95 djm 431: .Dq PKCS8
1.161 djm 432: (PKCS8 public or private key)
1.95 djm 433: or
434: .Dq PEM
435: (PEM public key).
1.161 djm 436: By default OpenSSH will write newly-generated private keys in its own
437: format, but when converting public keys for export the default format is
1.95 djm 438: .Dq RFC4716 .
1.148 djm 439: Setting a format of
440: .Dq PEM
441: when generating or updating a supported private key type will cause the
442: key to be stored in the legacy PEM private key format.
1.66 jmc 443: .It Fl N Ar new_passphrase
444: Provides the new passphrase.
1.84 djm 445: .It Fl n Ar principals
446: Specify one or more principals (user or host names) to be included in
447: a certificate when signing a key.
448: Multiple principals may be specified, separated by commas.
449: Please see the
450: .Sx CERTIFICATES
451: section for details.
1.93 djm 452: .It Fl O Ar option
1.184 djm 453: Specify a key/value option.
454: These are specific to the operation that
455: .Nm
456: has been requested to perform.
457: .Pp
458: When signing certificates, one of the options listed in the
1.183 djm 459: .Sx CERTIFICATES
1.184 djm 460: section may be specified here.
461: .Pp
462: When performing moduli generation or screening, one of the options
463: listed in the
464: .Sx MODULI GENERATION
465: section may be specified.
466: .Pp
1.190 jmc 467: When generating a key that will be hosted on a FIDO authenticator,
468: this flag may be used to specify key-specific options.
469: Those supported at present are:
470: .Bl -tag -width Ds
471: .It Cm application
472: Override the default FIDO application/origin string of
1.189 djm 473: .Dq ssh: .
1.190 jmc 474: This may be useful when generating host or domain-specific resident keys.
475: .It Cm device
476: Explicitly specify a
1.189 djm 477: .Xr fido 4
478: device to use, rather than letting the token middleware select one.
1.190 jmc 479: .It Cm no-touch-required
480: Indicate that the generated private key should not require touch
1.185 djm 481: events (user presence) when making signatures.
482: Note that
483: .Xr sshd 8
484: will refuse such signatures by default, unless overridden via
485: an authorized_keys option.
1.197 ! djm 486: .It Cm challenge=path
! 487: Specifies a path to a challenge string that will be passed to the
! 488: FIDO token during key generation.
! 489: The challenge string is optional, but may be used as part of an out-of-band
! 490: protocol for key enrollment.
! 491: If no
! 492: .Cm challenge
! 493: is specified, a random challenge is used.
1.190 jmc 494: .It Cm resident
495: Indicate that the key should be stored on the FIDO authenticator itself.
1.185 djm 496: Resident keys may be supported on FIDO2 tokens and typically require that
497: a PIN be set on the token prior to generation.
498: Resident keys may be loaded off the token using
499: .Xr ssh-add 1 .
1.190 jmc 500: .It Cm user
501: A username to be associated with a resident key,
1.189 djm 502: overriding the empty default username.
503: Specifying a username may be useful when generating multiple resident keys
504: for the same application name.
1.197 ! djm 505: .It Cm write-attestation=path
! 506: May be used at key generation time to record the attestation certificate
! 507: returned from FIDO tokens during key generation.
! 508: By default this information is discarded.
1.190 jmc 509: .El
1.185 djm 510: .Pp
511: The
512: .Fl O
513: option may be specified multiple times.
1.66 jmc 514: .It Fl P Ar passphrase
515: Provides the (old) passphrase.
1.2 deraadt 516: .It Fl p
1.1 deraadt 517: Requests changing the passphrase of a private key file instead of
1.12 aaron 518: creating a new private key.
519: The program will prompt for the file
1.1 deraadt 520: containing the private key, for the old passphrase, and twice for the
521: new passphrase.
1.113 jmc 522: .It Fl Q
523: Test whether keys have been revoked in a KRL.
1.5 aaron 524: .It Fl q
525: Silence
526: .Nm ssh-keygen .
1.152 djm 527: .It Fl R Ar hostname | [hostname]:port
1.151 djm 528: Removes all keys belonging to the specified
1.64 djm 529: .Ar hostname
1.151 djm 530: (with optional port number)
1.65 jmc 531: from a
1.64 djm 532: .Pa known_hosts
533: file.
1.65 jmc 534: This option is useful to delete hashed hosts (see the
1.64 djm 535: .Fl H
536: option above).
1.66 jmc 537: .It Fl r Ar hostname
538: Print the SSHFP fingerprint resource record named
539: .Ar hostname
540: for the specified public key file.
1.84 djm 541: .It Fl s Ar ca_key
542: Certify (sign) a public key using the specified CA key.
543: Please see the
544: .Sx CERTIFICATES
545: section for details.
1.111 djm 546: .Pp
547: When generating a KRL,
548: .Fl s
1.112 jmc 549: specifies a path to a CA public key file used to revoke certificates directly
1.111 djm 550: by key ID or serial number.
551: See the
552: .Sx KEY REVOCATION LISTS
553: section for details.
1.175 djm 554: .It Fl t Cm dsa | ecdsa | ecdsa-sk | ed25519 | ed25519-sk | rsa
1.66 jmc 555: Specifies the type of key to create.
556: The possible values are
1.100 naddy 557: .Dq dsa ,
1.118 naddy 558: .Dq ecdsa ,
1.173 naddy 559: .Dq ecdsa-sk ,
1.118 naddy 560: .Dq ed25519 ,
1.175 djm 561: .Dq ed25519-sk ,
1.100 naddy 562: or
1.139 jmc 563: .Dq rsa .
1.159 djm 564: .Pp
565: This flag may also be used to specify the desired signature type when
1.160 jmc 566: signing certificates using an RSA CA key.
1.159 djm 567: The available RSA signature variants are
568: .Dq ssh-rsa
569: (SHA1 signatures, not recommended),
1.160 jmc 570: .Dq rsa-sha2-256 ,
571: and
1.159 djm 572: .Dq rsa-sha2-512
573: (the default).
1.142 djm 574: .It Fl U
575: When used in combination with
576: .Fl s ,
577: this option indicates that a CA key resides in a
578: .Xr ssh-agent 1 .
579: See the
580: .Sx CERTIFICATES
581: section for more information.
1.112 jmc 582: .It Fl u
583: Update a KRL.
584: When specified with
585: .Fl k ,
1.114 jmc 586: keys listed via the command line are added to the existing KRL rather than
1.112 jmc 587: a new KRL being created.
1.84 djm 588: .It Fl V Ar validity_interval
589: Specify a validity interval when signing a certificate.
590: A validity interval may consist of a single time, indicating that the
591: certificate is valid beginning now and expiring at that time, or may consist
592: of two times separated by a colon to indicate an explicit time interval.
1.145 djm 593: .Pp
594: The start time may be specified as the string
595: .Dq always
596: to indicate the certificate has no specified start time,
1.147 djm 597: a date in YYYYMMDD format, a time in YYYYMMDDHHMM[SS] format,
1.145 djm 598: a relative time (to the current time) consisting of a minus sign followed by
599: an interval in the format described in the
1.116 jmc 600: TIME FORMATS section of
1.90 jmc 601: .Xr sshd_config 5 .
1.145 djm 602: .Pp
1.147 djm 603: The end time may be specified as a YYYYMMDD date, a YYYYMMDDHHMM[SS] time,
1.145 djm 604: a relative time starting with a plus character or the string
605: .Dq forever
606: to indicate that the certificate has no expirty date.
1.84 djm 607: .Pp
608: For example:
609: .Dq +52w1d
610: (valid from now to 52 weeks and one day from now),
611: .Dq -4w:+4w
612: (valid from four weeks ago to four weeks from now),
613: .Dq 20100101123000:20110101123000
614: (valid from 12:30 PM, January 1st, 2010 to 12:30 PM, January 1st, 2011),
615: .Dq -1d:20110101
616: (valid from yesterday to midnight, January 1st, 2011).
1.145 djm 617: .Dq -1m:forever
618: (valid from one minute ago and never expiring).
1.61 djm 619: .It Fl v
620: Verbose mode.
621: Causes
622: .Nm
623: to print debugging messages about its progress.
624: This is helpful for debugging moduli generation.
625: Multiple
626: .Fl v
627: options increase the verbosity.
628: The maximum is 3.
1.173 naddy 629: .It Fl w Ar provider
1.180 naddy 630: Specifies a path to a library that will be used when creating
631: FIDO authenticator-hosted keys, overriding the default of using
632: the internal USB HID support.
1.196 djm 633: .It Fl Y Cm find-principals
634: Find the principal(s) associated with the public key of a signature,
1.194 djm 635: provided using the
636: .Fl s
637: flag in an authorized signers file provided using the
638: .Fl f
639: flag.
640: The format of the allowed signers file is documented in the
641: .Sx ALLOWED SIGNERS
1.195 jmc 642: section below.
1.196 djm 643: If one or more matching principals are found, they are returned on
644: standard output.
1.182 jmc 645: .It Fl Y Cm check-novalidate
646: Checks that a signature generated using
647: .Nm
648: .Fl Y Cm sign
649: has a valid structure.
650: This does not validate if a signature comes from an authorized signer.
651: When testing a signature,
652: .Nm
653: accepts a message on standard input and a signature namespace using
654: .Fl n .
655: A file containing the corresponding signature must also be supplied using the
656: .Fl s
657: flag.
658: Successful testing of the signature is signalled by
659: .Nm
660: returning a zero exit status.
1.166 jmc 661: .It Fl Y Cm sign
1.163 djm 662: Cryptographically sign a file or some data using a SSH key.
663: When signing,
664: .Nm
665: accepts zero or more files to sign on the command-line - if no files
666: are specified then
667: .Nm
668: will sign data presented on standard input.
669: Signatures are written to the path of the input file with
670: .Dq .sig
671: appended, or to standard output if the message to be signed was read from
672: standard input.
673: .Pp
674: The key used for signing is specified using the
675: .Fl f
676: option and may refer to either a private key, or a public key with the private
677: half available via
678: .Xr ssh-agent 1 .
679: An additional signature namespace, used to prevent signature confusion across
680: different domains of use (e.g. file signing vs email signing) must be provided
681: via the
682: .Fl n
683: flag.
684: Namespaces are arbitrary strings, and may include:
685: .Dq file
686: for file signing,
687: .Dq email
688: for email signing.
689: For custom uses, it is recommended to use names following a
690: NAMESPACE@YOUR.DOMAIN pattern to generate unambiguous namespaces.
1.166 jmc 691: .It Fl Y Cm verify
1.163 djm 692: Request to verify a signature generated using
693: .Nm
1.166 jmc 694: .Fl Y Cm sign
1.163 djm 695: as described above.
696: When verifying a signature,
697: .Nm
698: accepts a message on standard input and a signature namespace using
699: .Fl n .
700: A file containing the corresponding signature must also be supplied using the
701: .Fl s
702: flag, along with the identity of the signer using
703: .Fl I
704: and a list of allowed signers via the
705: .Fl f
706: flag.
707: The format of the allowed signers file is documented in the
708: .Sx ALLOWED SIGNERS
709: section below.
710: A file containing revoked keys can be passed using the
711: .Fl r
1.165 jmc 712: flag.
713: The revocation file may be a KRL or a one-per-line list of public keys.
1.163 djm 714: Successful verification by an authorized signer is signalled by
715: .Nm
716: returning a zero exit status.
1.181 jmc 717: .It Fl y
718: This option will read a private
719: OpenSSH format file and print an OpenSSH public key to stdout.
1.93 djm 720: .It Fl z Ar serial_number
721: Specifies a serial number to be embedded in the certificate to distinguish
722: this certificate from others from the same CA.
1.156 djm 723: If the
724: .Ar serial_number
725: is prefixed with a
726: .Sq +
727: character, then the serial number will be incremented for each certificate
728: signed on a single command-line.
1.93 djm 729: The default serial number is zero.
1.111 djm 730: .Pp
731: When generating a KRL, the
732: .Fl z
733: flag is used to specify a KRL version number.
1.2 deraadt 734: .El
1.60 djm 735: .Sh MODULI GENERATION
736: .Nm
737: may be used to generate groups for the Diffie-Hellman Group Exchange
738: (DH-GEX) protocol.
739: Generating these groups is a two-step process: first, candidate
740: primes are generated using a fast, but memory intensive process.
741: These candidate primes are then tested for suitability (a CPU-intensive
742: process).
743: .Pp
744: Generation of primes is performed using the
1.184 djm 745: .Fl M Cm generate
1.60 djm 746: option.
747: The desired length of the primes may be specified by the
1.184 djm 748: .Fl O Cm bits
1.60 djm 749: option.
750: For example:
751: .Pp
1.184 djm 752: .Dl # ssh-keygen -M generate -O bits=2048 moduli-2048.candidates
1.60 djm 753: .Pp
754: By default, the search for primes begins at a random point in the
755: desired length range.
756: This may be overridden using the
1.184 djm 757: .Fl O Cm start
1.60 djm 758: option, which specifies a different start point (in hex).
759: .Pp
1.109 dtucker 760: Once a set of candidates have been generated, they must be screened for
1.60 djm 761: suitability.
762: This may be performed using the
1.184 djm 763: .Fl M Cm screen
1.60 djm 764: option.
765: In this mode
766: .Nm
767: will read candidates from standard input (or a file specified using the
768: .Fl f
769: option).
770: For example:
771: .Pp
1.184 djm 772: .Dl # ssh-keygen -M screen -f moduli-2048.candidates moduli-2048
1.60 djm 773: .Pp
774: By default, each candidate will be subjected to 100 primality tests.
775: This may be overridden using the
1.184 djm 776: .Fl O Cm prime-tests
1.60 djm 777: option.
778: The DH generator value will be chosen automatically for the
779: prime under consideration.
780: If a specific generator is desired, it may be requested using the
1.184 djm 781: .Fl O Cm generator
1.60 djm 782: option.
1.66 jmc 783: Valid generator values are 2, 3, and 5.
1.60 djm 784: .Pp
785: Screened DH groups may be installed in
786: .Pa /etc/moduli .
787: It is important that this file contains moduli of a range of bit lengths and
788: that both ends of a connection share common moduli.
1.184 djm 789: .Pp
790: A number of options are available for moduli generation and screening via the
791: .Fl O
792: flag:
1.186 jmc 793: .Bl -tag -width Ds
1.184 djm 794: .It Ic lines Ns = Ns Ar number
795: Exit after screening the specified number of lines while performing DH
796: candidate screening.
797: .It Ic start-line Ns = Ns Ar line-number
798: Start screening at the specified line number while performing DH candidate
799: screening.
800: .It Ic checkpoint Ns = Ns Ar filename
801: Write the last line processed to the specified file while performing DH
802: candidate screening.
803: This will be used to skip lines in the input file that have already been
804: processed if the job is restarted.
805: .It Ic memory Ns = Ns Ar mbytes
806: Specify the amount of memory to use (in megabytes) when generating
807: candidate moduli for DH-GEX.
808: .It Ic start Ns = Ns Ar hex-value
809: Specify start point (in hex) when generating candidate moduli for DH-GEX.
810: .It Ic generator Ns = Ns Ar value
811: Specify desired generator (in decimal) when testing candidate moduli for DH-GEX.
812: .El
1.84 djm 813: .Sh CERTIFICATES
814: .Nm
815: supports signing of keys to produce certificates that may be used for
816: user or host authentication.
817: Certificates consist of a public key, some identity information, zero or
1.94 jmc 818: more principal (user or host) names and a set of options that
1.84 djm 819: are signed by a Certification Authority (CA) key.
820: Clients or servers may then trust only the CA key and verify its signature
821: on a certificate rather than trusting many user/host keys.
822: Note that OpenSSH certificates are a different, and much simpler, format to
823: the X.509 certificates used in
824: .Xr ssl 8 .
825: .Pp
826: .Nm
827: supports two types of certificates: user and host.
828: User certificates authenticate users to servers, whereas host certificates
1.85 jmc 829: authenticate server hosts to users.
830: To generate a user certificate:
1.84 djm 831: .Pp
832: .Dl $ ssh-keygen -s /path/to/ca_key -I key_id /path/to/user_key.pub
833: .Pp
834: The resultant certificate will be placed in
1.91 djm 835: .Pa /path/to/user_key-cert.pub .
1.84 djm 836: A host certificate requires the
837: .Fl h
838: option:
839: .Pp
840: .Dl $ ssh-keygen -s /path/to/ca_key -I key_id -h /path/to/host_key.pub
841: .Pp
842: The host certificate will be output to
1.91 djm 843: .Pa /path/to/host_key-cert.pub .
1.98 djm 844: .Pp
845: It is possible to sign using a CA key stored in a PKCS#11 token by
846: providing the token library using
847: .Fl D
848: and identifying the CA key by providing its public half as an argument
849: to
850: .Fl s :
851: .Pp
1.127 naddy 852: .Dl $ ssh-keygen -s ca_key.pub -D libpkcs11.so -I key_id user_key.pub
1.142 djm 853: .Pp
854: Similarly, it is possible for the CA key to be hosted in a
855: .Xr ssh-agent 1 .
856: This is indicated by the
857: .Fl U
858: flag and, again, the CA key must be identified by its public half.
859: .Pp
860: .Dl $ ssh-keygen -Us ca_key.pub -I key_id user_key.pub
1.98 djm 861: .Pp
862: In all cases,
1.84 djm 863: .Ar key_id
864: is a "key identifier" that is logged by the server when the certificate
865: is used for authentication.
866: .Pp
867: Certificates may be limited to be valid for a set of principal (user/host)
868: names.
869: By default, generated certificates are valid for all users or hosts.
870: To generate a certificate for a specified set of principals:
871: .Pp
872: .Dl $ ssh-keygen -s ca_key -I key_id -n user1,user2 user_key.pub
1.127 naddy 873: .Dl "$ ssh-keygen -s ca_key -I key_id -h -n host.domain host_key.pub"
1.84 djm 874: .Pp
875: Additional limitations on the validity and use of user certificates may
1.94 jmc 876: be specified through certificate options.
1.93 djm 877: A certificate option may disable features of the SSH session, may be
1.84 djm 878: valid only when presented from particular source addresses or may
879: force the use of a specific command.
1.183 djm 880: .Pp
881: The options that are valid for user certificates are:
882: .Pp
883: .Bl -tag -width Ds -compact
884: .It Ic clear
885: Clear all enabled permissions.
886: This is useful for clearing the default set of permissions so permissions may
887: be added individually.
888: .Pp
889: .It Ic critical : Ns Ar name Ns Op Ns = Ns Ar contents
890: .It Ic extension : Ns Ar name Ns Op Ns = Ns Ar contents
891: Includes an arbitrary certificate critical option or extension.
892: The specified
893: .Ar name
894: should include a domain suffix, e.g.\&
895: .Dq name@example.com .
896: If
897: .Ar contents
898: is specified then it is included as the contents of the extension/option
899: encoded as a string, otherwise the extension/option is created with no
900: contents (usually indicating a flag).
901: Extensions may be ignored by a client or server that does not recognise them,
902: whereas unknown critical options will cause the certificate to be refused.
903: .Pp
904: .It Ic force-command Ns = Ns Ar command
905: Forces the execution of
906: .Ar command
907: instead of any shell or command specified by the user when
908: the certificate is used for authentication.
909: .Pp
910: .It Ic no-agent-forwarding
911: Disable
912: .Xr ssh-agent 1
913: forwarding (permitted by default).
914: .Pp
915: .It Ic no-port-forwarding
916: Disable port forwarding (permitted by default).
917: .Pp
918: .It Ic no-pty
919: Disable PTY allocation (permitted by default).
920: .Pp
921: .It Ic no-user-rc
922: Disable execution of
923: .Pa ~/.ssh/rc
924: by
925: .Xr sshd 8
926: (permitted by default).
927: .Pp
928: .It Ic no-x11-forwarding
929: Disable X11 forwarding (permitted by default).
930: .Pp
931: .It Ic permit-agent-forwarding
932: Allows
933: .Xr ssh-agent 1
934: forwarding.
935: .Pp
936: .It Ic permit-port-forwarding
937: Allows port forwarding.
938: .Pp
939: .It Ic permit-pty
940: Allows PTY allocation.
941: .Pp
942: .It Ic permit-user-rc
943: Allows execution of
944: .Pa ~/.ssh/rc
945: by
946: .Xr sshd 8 .
947: .Pp
948: .It Ic permit-X11-forwarding
949: Allows X11 forwarding.
950: .Pp
951: .It Ic no-touch-required
952: Do not require signatures made using this key require demonstration
1.193 naddy 953: of user presence (e.g. by having the user touch the authenticator).
1.192 naddy 954: This option only makes sense for the FIDO authenticator algorithms
1.183 djm 955: .Cm ecdsa-sk
956: and
957: .Cm ed25519-sk .
958: .Pp
959: .It Ic source-address Ns = Ns Ar address_list
960: Restrict the source addresses from which the certificate is considered valid.
961: The
962: .Ar address_list
963: is a comma-separated list of one or more address/netmask pairs in CIDR
964: format.
965: .El
966: .Pp
967: At present, no standard options are valid for host keys.
1.84 djm 968: .Pp
969: Finally, certificates may be defined with a validity lifetime.
970: The
971: .Fl V
972: option allows specification of certificate start and end times.
973: A certificate that is presented at a time outside this range will not be
974: considered valid.
1.110 jmc 975: By default, certificates are valid from
976: .Ux
977: Epoch to the distant future.
1.84 djm 978: .Pp
979: For certificates to be used for user or host authentication, the CA
980: public key must be trusted by
981: .Xr sshd 8
982: or
983: .Xr ssh 1 .
984: Please refer to those manual pages for details.
1.111 djm 985: .Sh KEY REVOCATION LISTS
986: .Nm
987: is able to manage OpenSSH format Key Revocation Lists (KRLs).
988: These binary files specify keys or certificates to be revoked using a
1.119 tedu 989: compact format, taking as little as one bit per certificate if they are being
1.111 djm 990: revoked by serial number.
991: .Pp
992: KRLs may be generated using the
993: .Fl k
994: flag.
1.114 jmc 995: This option reads one or more files from the command line and generates a new
1.111 djm 996: KRL.
997: The files may either contain a KRL specification (see below) or public keys,
998: listed one per line.
999: Plain public keys are revoked by listing their hash or contents in the KRL and
1000: certificates revoked by serial number or key ID (if the serial is zero or
1001: not available).
1002: .Pp
1003: Revoking keys using a KRL specification offers explicit control over the
1004: types of record used to revoke keys and may be used to directly revoke
1005: certificates by serial number or key ID without having the complete original
1006: certificate on hand.
1007: A KRL specification consists of lines containing one of the following directives
1008: followed by a colon and some directive-specific information.
1009: .Bl -tag -width Ds
1.115 jmc 1010: .It Cm serial : Ar serial_number Ns Op - Ns Ar serial_number
1.111 djm 1011: Revokes a certificate with the specified serial number.
1.112 jmc 1012: Serial numbers are 64-bit values, not including zero and may be expressed
1.111 djm 1013: in decimal, hex or octal.
1014: If two serial numbers are specified separated by a hyphen, then the range
1015: of serial numbers including and between each is revoked.
1016: The CA key must have been specified on the
1017: .Nm
1.114 jmc 1018: command line using the
1.111 djm 1019: .Fl s
1020: option.
1021: .It Cm id : Ar key_id
1022: Revokes a certificate with the specified key ID string.
1023: The CA key must have been specified on the
1024: .Nm
1.114 jmc 1025: command line using the
1.111 djm 1026: .Fl s
1027: option.
1028: .It Cm key : Ar public_key
1029: Revokes the specified key.
1.112 jmc 1030: If a certificate is listed, then it is revoked as a plain public key.
1.111 djm 1031: .It Cm sha1 : Ar public_key
1.149 djm 1032: Revokes the specified key by including its SHA1 hash in the KRL.
1033: .It Cm sha256 : Ar public_key
1034: Revokes the specified key by including its SHA256 hash in the KRL.
1035: KRLs that revoke keys by SHA256 hash are not supported by OpenSSH versions
1036: prior to 7.9.
1037: .It Cm hash : Ar fingerprint
1.150 djm 1038: Revokes a key using a fingerprint hash, as obtained from a
1.149 djm 1039: .Xr sshd 8
1040: authentication log message or the
1041: .Nm
1042: .Fl l
1043: flag.
1044: Only SHA256 fingerprints are supported here and resultant KRLs are
1045: not supported by OpenSSH versions prior to 7.9.
1.111 djm 1046: .El
1047: .Pp
1048: KRLs may be updated using the
1049: .Fl u
1050: flag in addition to
1051: .Fl k .
1.114 jmc 1052: When this option is specified, keys listed via the command line are merged into
1.111 djm 1053: the KRL, adding to those already there.
1054: .Pp
1055: It is also possible, given a KRL, to test whether it revokes a particular key
1056: (or keys).
1057: The
1058: .Fl Q
1.128 jmc 1059: flag will query an existing KRL, testing each key specified on the command line.
1.114 jmc 1060: If any key listed on the command line has been revoked (or an error encountered)
1.111 djm 1061: then
1062: .Nm
1063: will exit with a non-zero exit status.
1064: A zero exit status will only be returned if no key was revoked.
1.163 djm 1065: .Sh ALLOWED SIGNERS
1066: When verifying signatures,
1067: .Nm
1068: uses a simple list of identities and keys to determine whether a signature
1069: comes from an authorized source.
1070: This "allowed signers" file uses a format patterned after the
1071: AUTHORIZED_KEYS FILE FORMAT described in
1.165 jmc 1072: .Xr sshd 8 .
1.163 djm 1073: Each line of the file contains the following space-separated fields:
1074: principals, options, keytype, base64-encoded key.
1075: Empty lines and lines starting with a
1076: .Ql #
1077: are ignored as comments.
1078: .Pp
1079: The principals field is a pattern-list (See PATTERNS in
1080: .Xr ssh_config 5 )
1081: consisting of one or more comma-separated USER@DOMAIN identity patterns
1082: that are accepted for signing.
1083: When verifying, the identity presented via the
1.172 jmc 1084: .Fl I
1085: option must match a principals pattern in order for the corresponding key to be
1.163 djm 1086: considered acceptable for verification.
1087: .Pp
1088: The options (if present) consist of comma-separated option specifications.
1089: No spaces are permitted, except within double quotes.
1090: The following option specifications are supported (note that option keywords
1091: are case-insensitive):
1092: .Bl -tag -width Ds
1093: .It Cm cert-authority
1094: Indicates that this key is accepted as a certificate authority (CA) and
1095: that certificates signed by this CA may be accepted for verification.
1096: .It Cm namespaces="namespace-list"
1097: Specifies a pattern-list of namespaces that are accepted for this key.
1.164 djm 1098: If this option is present, the signature namespace embedded in the
1.163 djm 1099: signature object and presented on the verification command-line must
1100: match the specified list before the key will be considered acceptable.
1101: .El
1102: .Pp
1103: When verifying signatures made by certificates, the expected principal
1104: name must match both the principals pattern in the allowed signers file and
1105: the principals embedded in the certificate itself.
1106: .Pp
1107: An example allowed signers file:
1108: .Bd -literal -offset 3n
1109: # Comments allowed at start of line
1110: user1@example.com,user2@example.com ssh-rsa AAAAX1...
1111: # A certificate authority, trusted for all principals in a domain.
1112: *@example.com cert-authority ssh-ed25519 AAAB4...
1113: # A key that is accepted only for file signing.
1114: user2@example.com namespaces="file" ssh-ed25519 AAA41...
1115: .Ed
1.173 naddy 1116: .Sh ENVIRONMENT
1117: .Bl -tag -width Ds
1118: .It Ev SSH_SK_PROVIDER
1.180 naddy 1119: Specifies the path to a library used to interact with FIDO authenticators.
1.173 naddy 1120: .El
1.2 deraadt 1121: .Sh FILES
1.100 naddy 1122: .Bl -tag -width Ds -compact
1.68 djm 1123: .It Pa ~/.ssh/id_dsa
1.100 naddy 1124: .It Pa ~/.ssh/id_ecdsa
1.173 naddy 1125: .It Pa ~/.ssh/id_ecdsa_sk
1.118 naddy 1126: .It Pa ~/.ssh/id_ed25519
1.176 naddy 1127: .It Pa ~/.ssh/id_ed25519_sk
1.100 naddy 1128: .It Pa ~/.ssh/id_rsa
1.180 naddy 1129: Contains the DSA, ECDSA, authenticator-hosted ECDSA, Ed25519,
1130: authenticator-hosted Ed25519 or RSA authentication identity of the user.
1.15 deraadt 1131: This file should not be readable by anyone but the user.
1132: It is possible to
1133: specify a passphrase when generating the key; that passphrase will be
1.80 dtucker 1134: used to encrypt the private part of this file using 128-bit AES.
1.15 deraadt 1135: This file is not automatically accessed by
1136: .Nm
1137: but it is offered as the default file for the private key.
1.46 markus 1138: .Xr ssh 1
1.15 deraadt 1139: will read this file when a login attempt is made.
1.100 naddy 1140: .Pp
1.68 djm 1141: .It Pa ~/.ssh/id_dsa.pub
1.100 naddy 1142: .It Pa ~/.ssh/id_ecdsa.pub
1.173 naddy 1143: .It Pa ~/.ssh/id_ecdsa_sk.pub
1.118 naddy 1144: .It Pa ~/.ssh/id_ed25519.pub
1.176 naddy 1145: .It Pa ~/.ssh/id_ed25519_sk.pub
1.68 djm 1146: .It Pa ~/.ssh/id_rsa.pub
1.180 naddy 1147: Contains the DSA, ECDSA, authenticator-hosted ECDSA, Ed25519,
1148: authenticator-hosted Ed25519 or RSA public key for authentication.
1.15 deraadt 1149: The contents of this file should be added to
1.68 djm 1150: .Pa ~/.ssh/authorized_keys
1.15 deraadt 1151: on all machines
1.49 deraadt 1152: where the user wishes to log in using public key authentication.
1.12 aaron 1153: There is no need to keep the contents of this file secret.
1.100 naddy 1154: .Pp
1.60 djm 1155: .It Pa /etc/moduli
1156: Contains Diffie-Hellman groups used for DH-GEX.
1157: The file format is described in
1158: .Xr moduli 5 .
1.19 aaron 1159: .El
1.2 deraadt 1160: .Sh SEE ALSO
1161: .Xr ssh 1 ,
1162: .Xr ssh-add 1 ,
1.8 ericj 1163: .Xr ssh-agent 1 ,
1.60 djm 1164: .Xr moduli 5 ,
1.30 itojun 1165: .Xr sshd 8
1.37 markus 1166: .Rs
1.73 markus 1167: .%R RFC 4716
1168: .%T "The Secure Shell (SSH) Public Key File Format"
1169: .%D 2006
1.37 markus 1170: .Re
1.59 jmc 1171: .Sh AUTHORS
1172: OpenSSH is a derivative of the original and free
1173: ssh 1.2.12 release by Tatu Ylonen.
1174: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
1175: Theo de Raadt and Dug Song
1176: removed many bugs, re-added newer features and
1177: created OpenSSH.
1178: Markus Friedl contributed the support for SSH
1179: protocol versions 1.5 and 2.0.
![[BACK]](/icons/back.gif){kind=icon}
Return to ssh-keygen.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh