Skip to content

Commit 265db35

Browse files
authored
Merge pull request #380 from smallstep/carl/config-fix
Add policy description to Configuration Guide
2 parents e50fa41 + e663e8f commit 265db35

File tree

4 files changed

+39
-4
lines changed

4 files changed

+39
-4
lines changed

step-ca/configuration.mdx

+4-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,8 @@ the `--password-file` flag accepts
102102
"x509": {
103103
"allow": {
104104
"dns": ["*.local"]
105-
}
105+
},
106+
"allowWildcardNames": false
106107
},
107108
"ssh": {
108109
"user": {
@@ -252,6 +253,8 @@ the `--password-file` flag accepts
252253

253254
- **template**: default ASN1DN values for new certificates. See [Templates](./templates.mdx).
254255

256+
- **policy**: authority-wide policy for certificate identifiers. See [Policies](./policies.mdx).
257+
255258
- **disableIssuedAtCheck**: ☠️ disable a check verifying that provisioning tokens must be issued after the CA has booted. This claim is one prevention against token reuse. The default value is false. Do not change this unless you know what you are doing.
256259

257260
- **claims**: default validation for requested attributes in the certificate request. Can be overridden by similar claims objects defined by individual provisioners.

step-ca/policies.mdx

+14-2
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,20 @@ A rule for `*.éxàmplê.com` will internally be represented using its internati
8383
This rule will match `www.éxàmplê.com` as well as its internationalized representation `www.xn–xmpl-0na6cm.com` (and other subdomains).
8484

8585
By default it is not possible to request a certificate with a literal wildcard character in the domain, like `*.example.com`.
86-
It is possible to configure the policy to allow this.
86+
It is possible to configure the policy to allow this:
87+
88+
```
89+
"policy": {
90+
"x509": {
91+
"allow": {
92+
"dns": ["*.example.com"]
93+
}
94+
"allowWildcardNames": true
95+
}
96+
}
97+
98+
```
99+
87100

88101
#### Examples
89102

@@ -287,7 +300,6 @@ An example is shown below:
287300
"dns": ["forbidden.local"],
288301
"ip": ["192.168.0.1"]
289302
},
290-
"allowWildcardNames": false,
291303
},
292304
"ssh": {
293305
"user": {

tutorials/connect-jamf-pro-to-smallstep.mdx

+19-1
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,32 @@ Smallstep can integrate with Jamf Pro to synchronize your device inventory, and
88

99
This document also contains [uninstall instructions](#uninstall-smallstep-agent-with-jamf-pro).
1010

11-
# Prerequisites
11+
# Requirements & Limitations
1212

1313
You will need:
1414

1515
- A [Smallstep team](https://smallstep.com/#) with Pro features enabled
1616
- A [Jamf Pro](https://www.jamf.com/products/jamf-pro/) tenant
1717
- A [package distribution point](https://learn.jamf.com/en-US/bundle/jamf-pro-install-guide-linux-current/page/About_Distribution_Points.html) configured in Jamf Pro
1818

19+
Client requirements:
20+
21+
- The agent will need to reach the following domains:
22+
```
23+
smallstep.com
24+
api.smallstep.com
25+
gateway.smallstep.com
26+
control.infra.smallstep.com
27+
*.[team-name].ca.smallstep.com
28+
auth.smallstep.com
29+
att.smallstep.com
30+
```
31+
32+
Limitations:
33+
34+
- For VPN configurations, only IPSec VPNs are currently supported.
35+
- “Always-on VPN” or device-wide VPNs are not yet supported in Smallstep-managed configurations.
36+
1937
# Step-by-step instructions
2038

2139
### Create an API Client in Jamf Pro

tutorials/vpn-setup-guide.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description: This tutorial describes how to configure Smallstep with VPN servers
88
This tutorial describes how to configure your VPN server for certificate-based authentication with Smallstep.
99
The Smallstep app can then configure and issue certificates to your clients.
1010

11+
Smallstep's agent software is currently only able to manage IPSec VPN connections.
12+
1113
# Overview of Setup Steps
1214

1315
While the details will differ between VPNs, the process of configuring a VPN server

0 commit comments

Comments
 (0)