2010-02-26 20:55:05 +00:00
|
|
|
This document describes a simple public-key certificate authentication
|
|
|
|
system for use by SSH.
|
|
|
|
|
|
|
|
Background
|
|
|
|
----------
|
|
|
|
|
|
|
|
The SSH protocol currently supports a simple public key authentication
|
|
|
|
mechanism. Unlike other public key implementations, SSH eschews the
|
|
|
|
use of X.509 certificates and uses raw keys. This approach has some
|
|
|
|
benefits relating to simplicity of configuration and minimisation
|
|
|
|
of attack surface, but it does not support the important use-cases
|
|
|
|
of centrally managed, passwordless authentication and centrally
|
|
|
|
certified host keys.
|
|
|
|
|
|
|
|
These protocol extensions build on the simple public key authentication
|
|
|
|
system already in SSH to allow certificate-based authentication.
|
|
|
|
The certificates used are not traditional X.509 certificates, with
|
|
|
|
numerous options and complex encoding rules, but something rather
|
2010-04-16 05:56:21 +00:00
|
|
|
more minimal: a key, some identity information and usage options
|
2010-02-26 20:55:05 +00:00
|
|
|
that have been signed with some other trusted key.
|
|
|
|
|
|
|
|
A sshd server may be configured to allow authentication via certified
|
|
|
|
keys, by extending the existing ~/.ssh/authorized_keys mechanism
|
|
|
|
to allow specification of certification authority keys in addition
|
|
|
|
to raw user keys. The ssh client will support automatic verification
|
|
|
|
of acceptance of certified host keys, by adding a similar ability
|
|
|
|
to specify CA keys in ~/.ssh/known_hosts.
|
|
|
|
|
|
|
|
Certified keys are represented using two new key types:
|
2010-04-16 05:56:21 +00:00
|
|
|
ssh-rsa-cert-v01@openssh.com and ssh-dss-cert-v01@openssh.com that
|
2010-02-26 20:55:05 +00:00
|
|
|
include certification information along with the public key that is used
|
|
|
|
to sign challenges. ssh-keygen performs the CA signing operation.
|
|
|
|
|
|
|
|
Protocol extensions
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
The SSH wire protocol includes several extensibility mechanisms.
|
|
|
|
These modifications shall take advantage of namespaced public key
|
|
|
|
algorithm names to add support for certificate authentication without
|
|
|
|
breaking the protocol - implementations that do not support the
|
|
|
|
extensions will simply ignore them.
|
|
|
|
|
|
|
|
Authentication using the new key formats described below proceeds
|
|
|
|
using the existing SSH "publickey" authentication method described
|
|
|
|
in RFC4252 section 7.
|
|
|
|
|
|
|
|
New public key formats
|
|
|
|
----------------------
|
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
The ssh-rsa-cert-v01@openssh.com and ssh-dss-cert-v01@openssh.com key
|
2010-03-04 10:52:00 +00:00
|
|
|
types take a similar high-level format (note: data types and
|
2010-02-26 20:55:05 +00:00
|
|
|
encoding are as per RFC4251 section 5). The serialised wire encoding of
|
|
|
|
these certificates is also used for storing them on disk.
|
|
|
|
|
|
|
|
#define SSH_CERT_TYPE_USER 1
|
|
|
|
#define SSH_CERT_TYPE_HOST 2
|
|
|
|
|
|
|
|
RSA certificate
|
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
string "ssh-rsa-cert-v01@openssh.com"
|
|
|
|
string nonce
|
2010-02-26 20:55:05 +00:00
|
|
|
mpint e
|
|
|
|
mpint n
|
2010-04-16 05:56:21 +00:00
|
|
|
uint64 serial
|
2010-02-26 20:55:05 +00:00
|
|
|
uint32 type
|
|
|
|
string key id
|
|
|
|
string valid principals
|
|
|
|
uint64 valid after
|
|
|
|
uint64 valid before
|
2010-04-16 05:56:21 +00:00
|
|
|
string critical options
|
|
|
|
string extensions
|
2010-02-26 20:55:05 +00:00
|
|
|
string reserved
|
|
|
|
string signature key
|
|
|
|
string signature
|
|
|
|
|
|
|
|
DSA certificate
|
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
string "ssh-dss-cert-v01@openssh.com"
|
|
|
|
string nonce
|
2010-02-26 20:55:05 +00:00
|
|
|
mpint p
|
|
|
|
mpint q
|
|
|
|
mpint g
|
|
|
|
mpint y
|
2010-04-16 05:56:21 +00:00
|
|
|
uint64 serial
|
2010-02-26 20:55:05 +00:00
|
|
|
uint32 type
|
|
|
|
string key id
|
|
|
|
string valid principals
|
|
|
|
uint64 valid after
|
|
|
|
uint64 valid before
|
2010-04-16 05:56:21 +00:00
|
|
|
string critical options
|
|
|
|
string extensions
|
2010-02-26 20:55:05 +00:00
|
|
|
string reserved
|
|
|
|
string signature key
|
|
|
|
string signature
|
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
The nonce field is a CA-provided random bitstring of arbitrary length
|
|
|
|
(but typically 16 or 32 bytes) included to make attacks that depend on
|
|
|
|
inducing collisions in the signature hash infeasible.
|
|
|
|
|
2010-02-26 20:55:05 +00:00
|
|
|
e and n are the RSA exponent and public modulus respectively.
|
|
|
|
|
|
|
|
p, q, g, y are the DSA parameters as described in FIPS-186-2.
|
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
serial is an optional certificate serial number set by the CA to
|
|
|
|
provide an abbreviated way to refer to certificates from that CA.
|
|
|
|
If a CA does not with to number its certificates it must set this
|
|
|
|
field to zero.
|
|
|
|
|
2010-02-26 20:55:05 +00:00
|
|
|
type specifies whether this certificate is for identification of a user
|
|
|
|
or a host using a SSH_CERT_TYPE_... value.
|
|
|
|
|
|
|
|
key id is a free-form text field that is filled in by the CA at the time
|
|
|
|
of signing; the intention is that the contents of this field are used to
|
|
|
|
identify the identity principal in log messages.
|
|
|
|
|
|
|
|
"valid principals" is a string containing zero or more principals as
|
|
|
|
strings packed inside it. These principals list the names for which this
|
|
|
|
certificate is valid; hostnames for SSH_CERT_TYPE_HOST certificates and
|
|
|
|
usernames for SSH_CERT_TYPE_USER certificates. As a special case, a
|
|
|
|
zero-length "valid principals" field means the certificate is valid for
|
|
|
|
any principal of the specified type. XXX DNS wildcards?
|
|
|
|
|
|
|
|
"valid after" and "valid before" specify a validity period for the
|
|
|
|
certificate. Each represents a time in seconds since 1970-01-01
|
|
|
|
00:00:00. A certificate is considered valid if:
|
|
|
|
valid after <= current time < valid before
|
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
criticial options is a set of zero or more key options encoded as
|
|
|
|
below. All such options are "critical" in the sense that an implementation
|
|
|
|
must refuse to authorise a key that has an unrecognised option.
|
2010-02-26 20:55:05 +00:00
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
extensions is a set of zero or more optional extensions. These extensions
|
|
|
|
are not critical, and an implementation that encounters one that it does
|
|
|
|
not recognise may safely ignore it. No extensions are defined at present.
|
2010-02-26 20:55:05 +00:00
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
The reserved field is currently unused and is ignored in this version of
|
2010-02-26 20:55:05 +00:00
|
|
|
the protocol.
|
|
|
|
|
|
|
|
signature key contains the CA key used to sign the certificate.
|
|
|
|
The valid key types for CA keys are ssh-rsa and ssh-dss. "Chained"
|
|
|
|
certificates, where the signature key type is a certificate type itself
|
|
|
|
are NOT supported. Note that it is possible for a RSA certificate key to
|
|
|
|
be signed by a DSS CA key and vice-versa.
|
|
|
|
|
|
|
|
signature is computed over all preceding fields from the initial string
|
|
|
|
up to, and including the signature key. Signatures are computed and
|
|
|
|
encoded according to the rules defined for the CA's public key algorithm
|
|
|
|
(RFC4253 section 6.6 for ssh-rsa and ssh-dss).
|
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
Critical options
|
|
|
|
----------------
|
2010-02-26 20:55:05 +00:00
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
The critical options section of the certificate specifies zero or more
|
|
|
|
options on the certificates validity. The format of this field
|
2010-02-26 20:55:05 +00:00
|
|
|
is a sequence of zero or more tuples:
|
|
|
|
|
|
|
|
string name
|
|
|
|
string data
|
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
The name field identifies the option and the data field encodes
|
|
|
|
option-specific information (see below). All options are
|
|
|
|
"critical", if an implementation does not recognise a option
|
2010-02-26 20:55:05 +00:00
|
|
|
then the validating party should refuse to accept the certificate.
|
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
The supported options and the contents and structure of their
|
2010-02-26 20:55:05 +00:00
|
|
|
data fields are:
|
|
|
|
|
|
|
|
Name Format Description
|
|
|
|
-----------------------------------------------------------------------------
|
|
|
|
force-command string Specifies a command that is executed
|
|
|
|
(replacing any the user specified on the
|
|
|
|
ssh command-line) whenever this key is
|
|
|
|
used for authentication.
|
|
|
|
|
|
|
|
permit-X11-forwarding empty Flag indicating that X11 forwarding
|
|
|
|
should be permitted. X11 forwarding will
|
2010-04-16 05:56:21 +00:00
|
|
|
be refused if this option is absent.
|
2010-02-26 20:55:05 +00:00
|
|
|
|
|
|
|
permit-agent-forwarding empty Flag indicating that agent forwarding
|
|
|
|
should be allowed. Agent forwarding
|
|
|
|
must not be permitted unless this
|
2010-04-16 05:56:21 +00:00
|
|
|
option is present.
|
2010-02-26 20:55:05 +00:00
|
|
|
|
|
|
|
permit-port-forwarding empty Flag indicating that port-forwarding
|
2010-04-16 05:56:21 +00:00
|
|
|
should be allowed. If this option is
|
2010-02-26 20:55:05 +00:00
|
|
|
not present then no port forwarding will
|
|
|
|
be allowed.
|
|
|
|
|
|
|
|
permit-pty empty Flag indicating that PTY allocation
|
|
|
|
should be permitted. In the absence of
|
2010-04-16 05:56:21 +00:00
|
|
|
this option PTY allocation will be
|
2010-02-26 20:55:05 +00:00
|
|
|
disabled.
|
|
|
|
|
|
|
|
permit-user-rc empty Flag indicating that execution of
|
|
|
|
~/.ssh/rc should be permitted. Execution
|
|
|
|
of this script will not be permitted if
|
2010-04-16 05:56:21 +00:00
|
|
|
this option is not present.
|
2010-02-26 20:55:05 +00:00
|
|
|
|
|
|
|
source-address string Comma-separated list of source addresses
|
|
|
|
from which this certificate is accepted
|
|
|
|
for authentication. Addresses are
|
|
|
|
specified in CIDR format (nn.nn.nn.nn/nn
|
|
|
|
or hhhh::hhhh/nn).
|
2010-04-16 05:56:21 +00:00
|
|
|
If this option is not present then
|
2010-02-26 20:55:05 +00:00
|
|
|
certificates may be presented from any
|
|
|
|
source address.
|
2010-03-02 23:24:00 +00:00
|
|
|
|
2010-04-16 05:56:21 +00:00
|
|
|
$OpenBSD: PROTOCOL.certkeys,v 1.4 2010/04/16 01:47:25 djm Exp $
|