summaryrefslogtreecommitdiff
path: root/ssh-keygen.1
diff options
context:
space:
mode:
authordjm@openbsd.org <djm@openbsd.org>2019-12-30 03:28:41 +0000
committerDamien Miller <djm@mindrot.org>2019-12-30 14:32:20 +1100
commit1e645fe767f27725dc7fd7864526de34683f7daf (patch)
tree61d4230dba514a5a560522c97e424cee60b33156 /ssh-keygen.1
parent20ccd854245c598e2b47cc9f8d4955d645195055 (diff)
upstream: prepare for use of ssh-keygen -O flag beyond certs
Move list of available certificate options in ssh-keygen.1 to the CERTIFICATES section. Collect options specified by -O but delay parsing/validation of certificate options until we're sure that we're acting as a CA. ok markus@ OpenBSD-Commit-ID: 33e6bcc29cfca43606f6fa09bd84b955ee3a4106
Diffstat (limited to 'ssh-keygen.1')
-rw-r--r--ssh-keygen.1188
1 files changed, 93 insertions, 95 deletions
diff --git a/ssh-keygen.1 b/ssh-keygen.1
index 038e2c578..67a57b9f7 100644
--- a/ssh-keygen.1
+++ b/ssh-keygen.1
@@ -1,4 +1,4 @@
1.\" $OpenBSD: ssh-keygen.1,v 1.182 2019/12/27 08:28:44 jmc Exp $ 1.\" $OpenBSD: ssh-keygen.1,v 1.183 2019/12/30 03:28:41 djm Exp $
2.\" 2.\"
3.\" Author: Tatu Ylonen <ylo@cs.hut.fi> 3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
@@ -35,7 +35,7 @@
35.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 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. 36.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37.\" 37.\"
38.Dd $Mdocdate: December 27 2019 $ 38.Dd $Mdocdate: December 30 2019 $
39.Dt SSH-KEYGEN 1 39.Dt SSH-KEYGEN 1
40.Os 40.Os
41.Sh NAME 41.Sh NAME
@@ -458,97 +458,10 @@ Please see the
458section for details. 458section for details.
459.It Fl O Ar option 459.It Fl O Ar option
460Specify a certificate option when signing a key. 460Specify a certificate option when signing a key.
461This option may be specified multiple times. 461See the
462See also the
463.Sx CERTIFICATES 462.Sx CERTIFICATES
464section for further details. 463section for a list of available certificate options.
465.Pp 464This option may be specified multiple times.
466At present, no standard options are valid for host keys.
467The options that are valid for user certificates are:
468.Pp
469.Bl -tag -width Ds -compact
470.It Ic clear
471Clear all enabled permissions.
472This is useful for clearing the default set of permissions so permissions may
473be added individually.
474.Pp
475.It Ic critical : Ns Ar name Ns Op Ns = Ns Ar contents
476.It Ic extension : Ns Ar name Ns Op Ns = Ns Ar contents
477Includes an arbitrary certificate critical option or extension.
478The specified
479.Ar name
480should include a domain suffix, e.g.\&
481.Dq name@example.com .
482If
483.Ar contents
484is specified then it is included as the contents of the extension/option
485encoded as a string, otherwise the extension/option is created with no
486contents (usually indicating a flag).
487Extensions may be ignored by a client or server that does not recognise them,
488whereas unknown critical options will cause the certificate to be refused.
489.Pp
490.It Ic force-command Ns = Ns Ar command
491Forces the execution of
492.Ar command
493instead of any shell or command specified by the user when
494the certificate is used for authentication.
495.Pp
496.It Ic no-agent-forwarding
497Disable
498.Xr ssh-agent 1
499forwarding (permitted by default).
500.Pp
501.It Ic no-port-forwarding
502Disable port forwarding (permitted by default).
503.Pp
504.It Ic no-pty
505Disable PTY allocation (permitted by default).
506.Pp
507.It Ic no-user-rc
508Disable execution of
509.Pa ~/.ssh/rc
510by
511.Xr sshd 8
512(permitted by default).
513.Pp
514.It Ic no-x11-forwarding
515Disable X11 forwarding (permitted by default).
516.Pp
517.It Ic permit-agent-forwarding
518Allows
519.Xr ssh-agent 1
520forwarding.
521.Pp
522.It Ic permit-port-forwarding
523Allows port forwarding.
524.Pp
525.It Ic permit-pty
526Allows PTY allocation.
527.Pp
528.It Ic permit-user-rc
529Allows execution of
530.Pa ~/.ssh/rc
531by
532.Xr sshd 8 .
533.Pp
534.It Ic permit-X11-forwarding
535Allows X11 forwarding.
536.Pp
537.It Ic no-touch-required
538Do not require signatures made using this key require demonstration
539of user presence (e.g. by having the user touch the key).
540This option only makes sense for the FIDO authenticator algorithms
541.Cm ecdsa-sk
542and
543.Cm ed25519-sk .
544.Pp
545.It Ic source-address Ns = Ns Ar address_list
546Restrict the source addresses from which the certificate is considered valid.
547The
548.Ar address_list
549is a comma-separated list of one or more address/netmask pairs in CIDR
550format.
551.El
552.It Fl P Ar passphrase 465.It Fl P Ar passphrase
553Provides the (old) passphrase. 466Provides the (old) passphrase.
554.It Fl p 467.It Fl p
@@ -899,9 +812,94 @@ be specified through certificate options.
899A certificate option may disable features of the SSH session, may be 812A certificate option may disable features of the SSH session, may be
900valid only when presented from particular source addresses or may 813valid only when presented from particular source addresses or may
901force the use of a specific command. 814force the use of a specific command.
902For a list of valid certificate options, see the documentation for the 815.Pp
903.Fl O 816The options that are valid for user certificates are:
904option above. 817.Pp
818.Bl -tag -width Ds -compact
819.It Ic clear
820Clear all enabled permissions.
821This is useful for clearing the default set of permissions so permissions may
822be added individually.
823.Pp
824.It Ic critical : Ns Ar name Ns Op Ns = Ns Ar contents
825.It Ic extension : Ns Ar name Ns Op Ns = Ns Ar contents
826Includes an arbitrary certificate critical option or extension.
827The specified
828.Ar name
829should include a domain suffix, e.g.\&
830.Dq name@example.com .
831If
832.Ar contents
833is specified then it is included as the contents of the extension/option
834encoded as a string, otherwise the extension/option is created with no
835contents (usually indicating a flag).
836Extensions may be ignored by a client or server that does not recognise them,
837whereas unknown critical options will cause the certificate to be refused.
838.Pp
839.It Ic force-command Ns = Ns Ar command
840Forces the execution of
841.Ar command
842instead of any shell or command specified by the user when
843the certificate is used for authentication.
844.Pp
845.It Ic no-agent-forwarding
846Disable
847.Xr ssh-agent 1
848forwarding (permitted by default).
849.Pp
850.It Ic no-port-forwarding
851Disable port forwarding (permitted by default).
852.Pp
853.It Ic no-pty
854Disable PTY allocation (permitted by default).
855.Pp
856.It Ic no-user-rc
857Disable execution of
858.Pa ~/.ssh/rc
859by
860.Xr sshd 8
861(permitted by default).
862.Pp
863.It Ic no-x11-forwarding
864Disable X11 forwarding (permitted by default).
865.Pp
866.It Ic permit-agent-forwarding
867Allows
868.Xr ssh-agent 1
869forwarding.
870.Pp
871.It Ic permit-port-forwarding
872Allows port forwarding.
873.Pp
874.It Ic permit-pty
875Allows PTY allocation.
876.Pp
877.It Ic permit-user-rc
878Allows execution of
879.Pa ~/.ssh/rc
880by
881.Xr sshd 8 .
882.Pp
883.It Ic permit-X11-forwarding
884Allows X11 forwarding.
885.Pp
886.It Ic no-touch-required
887Do not require signatures made using this key require demonstration
888of user presence (e.g. by having the user touch the key).
889This option only makes sense for the Security Key algorithms
890.Cm ecdsa-sk
891and
892.Cm ed25519-sk .
893.Pp
894.It Ic source-address Ns = Ns Ar address_list
895Restrict the source addresses from which the certificate is considered valid.
896The
897.Ar address_list
898is a comma-separated list of one or more address/netmask pairs in CIDR
899format.
900.El
901.Pp
902At present, no standard options are valid for host keys.
905.Pp 903.Pp
906Finally, certificates may be defined with a validity lifetime. 904Finally, certificates may be defined with a validity lifetime.
907The 905The