Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add X.509 and SSH certificate field reference sections #254

Merged
merged 1 commit into from
Jul 25, 2023
Merged

Add X.509 and SSH certificate field reference sections #254

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions step-ca/templates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ Here's what the default X.509 [leaf certificate template](https://github.com/sma
}
```

### X.509 Template Fields

The fields in an X.509 template map to [X.509 v3 certificate fields](https://datatracker.ietf.org/doc/html/rfc5280). See [the complete list of fields supported in `step-ca` templates](https://github.com/smallstep/crypto/blob/master/x509util/certificate.go#L16).

### X.509 Template Variables

<Alert severity="info" id="star11">
Expand All @@ -81,7 +85,8 @@ Here's what the default X.509 [leaf certificate template](https://github.com/sma
</div>
</Alert>

Here are some common variables available in X.509 certificate template:
Here are some common variables available in X.509 certificate templates:

- **.Subject**:
This is the subject that was passed in to `step certificate` or `step ca certificate`. Specifically,
`.Subject.CommonName` contains the Common Name for the certificate.
Expand Down Expand Up @@ -270,8 +275,11 @@ Here is `step-ca`'s default [SSH certificate template](https://github.com/smalls
}
```

The [OpenSSH certificate protocol spec](https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys) defines the available Critical Options and Extensions.
### SSH Template Fields

The [OpenSSH certificate protocol spec](https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys) defines SSH certificate fields and the available Critical Options and Extensions.
Third parties can also add custom extensions.
See [the complete list of fields supported by `step-ca` SSH template](https://github.com/smallstep/crypto/blob/master/sshutil/certificate.go#L16).

### SSH Template Variables

Expand Down