Skip to content

[mTLS] Update byo-ca.mdx #18592

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

Merged
merged 2 commits into from
Dec 6, 2024
Merged

[mTLS] Update byo-ca.mdx #18592

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f13dbb
[mTLS] Update byo-ca.mdx
ngayerie Dec 5, 2024
c4d70eb
Move code block example to new section and link step to it
RebeccaTamachiro Dec 6, 2024
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
22 changes: 13 additions & 9 deletions src/content/docs/ssl/client-certificates/byo-ca.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,7 @@ This is especially useful if you already have mTLS implemented and client certif
If no `mtls_certificate_id` is provided, the action will be performed against a Cloudflare Managed CA.
:::



4. (Optional) Since this process is API-only, and hostnames that use your uploaded CA certificate **are not** listed on the dashboard, you can make a [GET request](/api/operations/client-certificate-for-a-zone-list-hostname-associations) with the `mtls_certificate_id` as a query parameter to confirm the hostname association.

```bash
curl "https://api.cloudflare.com/client/v4/zones/zone_id/certificate_authorities/hostname_associations?mtls_certificate_id={id_from_step_2}" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>"
```
4. (Optional) Since this process is API-only, and hostnames that use your uploaded CA certificate **are not** listed on the dashboard, you can make a [GET request](#list-ca-hostname-associations) to confirm the CA hostname associations.

5. Create a custom rule to enforce client certificate validation.
You can do this [via the dashboard](/api-shield/security/mtls/configure/) or [via API](/waf/custom-rules/create-api/).
Expand All @@ -98,3 +90,15 @@ If you want to remove a CA that you have previously uploaded, you must first rem
```

2. Use the [Delete mTLS certificate endpoint](/api/operations/m-tls-certificate-management-delete-m-tls-certificate) to delete the certificate.

## List CA hostname associations

You can also use the [API](/api/operations/client-certificate-for-a-zone-list-hostname-associations) to list the hostname associations. Make sure you include the query parameter `mtls_certificate_id`, where `mtls_certificate_id` is the certificate ID of the uploaded CA (step 2 above).

```bash
curl "https://api.cloudflare.com/client/v4/zones/zone_id/certificate_authorities/hostname_associations?mtls_certificate_id={id_from_step_2}" \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>"
```


Loading