mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-05-11 05:55:12 +00:00
DOCS: Migrated documentation website to Gitbook (#1809)
This commit is contained in:
committed by
GitHub
parent
f4388dd6ad
commit
f912b15adc
53
documentation/functions/record/CAA_BUILDER.md
Normal file
53
documentation/functions/record/CAA_BUILDER.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
name: CAA_BUILDER
|
||||
parameters:
|
||||
- label
|
||||
- iodef
|
||||
- iodef_critical
|
||||
- issue
|
||||
- issuewild
|
||||
parameters_object: true
|
||||
parameter_types:
|
||||
label: string?
|
||||
iodef: string
|
||||
iodef_critical: boolean?
|
||||
issue: string[]
|
||||
issuewild: string
|
||||
---
|
||||
|
||||
DNSControl contains a `CAA_BUILDER` 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.
|
||||
|
||||
## Example
|
||||
|
||||
For example you can use:
|
||||
|
||||
```javascript
|
||||
CAA_BUILDER({
|
||||
label: "@",
|
||||
iodef: "mailto:test@domain.tld",
|
||||
iodef_critical: true,
|
||||
issue: [
|
||||
"letsencrypt.org",
|
||||
"comodoca.com",
|
||||
],
|
||||
issuewild: "none",
|
||||
})
|
||||
```
|
||||
|
||||
The parameters are:
|
||||
|
||||
* `label:` The label of the CAA record. (Optional. Default: `"@"`)
|
||||
* `iodef:` Report all violation to configured mail address.
|
||||
* `iodef_critical:` This can be `true` or `false`. If enabled and CA does not support this record, then certificate issue will be refused. (Optional. Default: `false`)
|
||||
* `issue:` An array of CAs which are allowed to issue certificates. (Use `"none"` to refuse all CAs)
|
||||
* `issuewild:` An array of CAs which are allowed to issue wildcard certificates. (Can be simply `"none"` to refuse issuing wildcard certificates for all CAs)
|
||||
|
||||
`CAA_BUILDER()` returns multiple records (when configured as example above):
|
||||
|
||||
* `CAA("@", "iodef", "mailto:test@domain.tld", CAA_CRITICAL)`
|
||||
* `CAA("@", "issue", "letsencrypt.org")`
|
||||
* `CAA("@", "issue", "comodoca.com")`
|
||||
* `CAA("@", "issuewild", ";")`
|
Reference in New Issue
Block a user