Skip to content

Commit 9f5d33e

Browse files
authored
Merge pull request #471 from smallstep/carl/con-302
Enterprise relay setup doc
2 parents 7691d73 + 00c6a53 commit 9f5d33e

File tree

2 files changed

+87
-0
lines changed

2 files changed

+87
-0
lines changed

manifest.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@
7676
{
7777
"title": "Configure Browser Certificates",
7878
"path": "/tutorials/browser-certificate-setup-guide.mdx"
79+
},
80+
{
81+
"title": "Configure Enterprise Relay",
82+
"path": "/tutorials/configure-enterprise-relay.mdx"
7983
}
8084
]
8185
},
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: Configure your endpoints for Smallstep Enterprise Relay
3+
updated_at: December 16, 2025
4+
html_title: Configure your Apple endponts to use Smallstep's Enterprise MASQUE Relay
5+
description: This tutorial describes how to deploy Smallstep's enterprise MASQUE relay service
6+
---
7+
8+
## Before you begin
9+
10+
To create your Relay server, you will need to give Smallstep the following information:
11+
12+
- **Relay Region**. The GCP region for the relay, eg. `US_CENTRAL1`
13+
- **Relay Trust Bundle** (optional). This will be used by the Relay to verify client certificates.
14+
This bundle needs to include both Root and Intermediate CA certificates for any CAs you want your Relay to trust.
15+
By default, your team's Smallstep Accounts Root and Intermediate CAs are trusted.
16+
- **Relay Issuing Authority** (optional). The CA that will issue the Relay's server TLS certificate.
17+
This must be a Smallstep CA in your team.
18+
By default, your team's Smallstep Workloads CA is used.
19+
20+
Once we have your details,
21+
Smallstep will create your relay server and respond with a **Relay URL**,
22+
which you’ll need for configuring clients.
23+
24+
## Typical Client Configuration
25+
26+
On Apple platforms, a typical client could be configured as follows:
27+
28+
- **Workloads CA Trust**: The Relay’s server certificate is issued by your team’s Workloads CA.
29+
Therefore, the client must trust your team's Workloads Root CA to connect to the relay.
30+
You can download the Workloads Root CA certificate from your [Authorities](https://smallstep.com/app/?next=/cm/authorities) page.
31+
- **Accounts CA Trust**: To obtain its client certificate, the client must trust your team's Smallstep Accounts Root CA
32+
You can download the Accounts Root CA certificate from your [Authorities](https://smallstep.com/app/?next=/cm/authorities) page.
33+
- **Client Certificate**: An [ACMECertificate MDM payload](https://support.apple.com/guide/deployment/automated-certificate-management-environment-depb95c66a07/web) is used to obtain a client certificate for accessing the Relay.
34+
- **Relay Configuration**: The Relay is configured using a [Relay MDM payload](https://developer.apple.com/documentation/devicemanagement/relay)
35+
36+
## Example: Jamf Pro Configuration Profile
37+
38+
In this example, we’ll use Jamf Pro to configure endpoints connecting to a Smallstep Relay.
39+
40+
**In the Smallstep console:**
41+
42+
1. Visit [Authorities](https://smallstep.com/app/?next=/cm/authorities)
43+
1. Select the **Smallstep Accounts** authority
44+
2. Download the Root Certificate
45+
3. Under the Provisioners section of the page, choose the provisioner named `acme-da`
46+
4. Temporarily save the **URL shown on the page**, eg. `https://accounts.example.ca.smallstep.com/acme/acme-da/directory`
47+
2. Return to [Authorities](https://smallstep.com/app/?next=/cm/authorities)
48+
1. Select the **Smallstep Workloads** authority
49+
2. Download the Root Certificate
50+
51+
**In Jamf Pro:**
52+
53+
1. Choose 🖥️ **Computers**
54+
2. Under the **Content Management** tab, choose **Configuration Profiles**
55+
3. Add a new Configuration Profile
56+
1. Choose **Options → General**
57+
- Name: Smallstep
58+
2. For ACME CA trust, add a **[Certificate payload](https://support.apple.com/guide/deployment/certificates-payload-settings-dep91d2eb26/web)**
59+
- Certificate Name: **Smallstep Accounts Authority**
60+
- Certificate Option: **Upload**
61+
- Certificate Upload: (upload the Accounts Root CA certificate)
62+
- Allow all apps access: ☑️
63+
3. For Relay server trust, add a **[Certificate payload](https://support.apple.com/guide/deployment/certificates-payload-settings-dep91d2eb26/web)**
64+
- Certificate Name: **Smallstep Workloads Authority**
65+
- Certificate Option: **Upload**
66+
- Certificate Upload: (upload the Workloads Root CA certificate)
67+
- Allow all apps access: ☑️
68+
4. Add a [ACMECertificate Payload](https://support.apple.com/guide/deployment/automated-certificate-management-environment-depb95c66a07/web)
69+
- URL: (paste the ACME provisioner URL you saved earlier)
70+
- Name: Smallstep
71+
- Redistribute Profile: 7 days
72+
- Key Size: `384`
73+
- Key Type: `ECSECPrimeRandom`
74+
- Client Identifier: `$SERIALNUMBER`
75+
- Subject: `/CN=$SERIALNUMBER/L=$PROFILEIDENTIFIER`
76+
- Hardware Bound: ✅
77+
- Attest: ✅
78+
- Key Usage: `0xB`
79+
- Extended Key Usage: `1.3.6.1.5.5.7.3.2`
80+
5. Add a [Relay payload](https://developer.apple.com/documentation/devicemanagement/relay)
81+
1. Relays: Add the URL for your Smallstep Enterprise Relay
82+
2. Match domains: Up to you
83+
3. Exclude domains: Up to you

0 commit comments

Comments
 (0)