1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Jeffrey Cafferata c74a527bf9 DOCS: [CAA] General improvements (#1971)
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
2023-01-22 11:20:49 -05:00

40 lines
1.5 KiB
Markdown

---
name: CAA
parameters:
- name
- tag
- value
- modifiers...
parameter_types:
name: string
tag: '"issue" | "issuewild" | "iodef"'
value: string
"modifiers...": RecordModifier[]
---
`CAA()` adds a CAA record to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
Tag can be one of
1. `"issue"`
2. `"issuewild"`
3. `"iodef"`
Value is a string. The format of the contents is different depending on the tag. DNSControl will handle any escaping or quoting required, similar to TXT records. For example use `CAA("@", "issue", "letsencrypt.org")` rather than `CAA("@", "issue", "\"letsencrypt.org\"")`.
Flags are controlled by modifier:
- `CAA_CRITICAL`: Issuer critical flag. CA that does not understand this tag will refuse to issue certificate for this domain.
```javascript
D("example.com", REGISTRAR, DnsProvider("GCLOUD"),
// Allow letsencrypt to issue certificate for this domain
CAA("@", "issue", "letsencrypt.org"),
// Allow no CA to issue wildcard certificate for this domain
CAA("@", "issuewild", ";"),
// Report all violation to test@example.com. If CA does not support
// this record then refuse to issue any certificate
CAA("@", "iodef", "mailto:test@example.com", CAA_CRITICAL)
);
```
DNSControl contains a [`CAA_BUILDER`](../record/CAA_BUILDER.md) which can be used to simply create `CAA()` records for your domains. Instead of creating each CAA record individually, you can simply configure your report mail address, the authorized certificate authorities and the builder cares about the rest.