1
0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00

General docs improvements (#481)

* docs improvements

* Updated matrix as part of "go generate" (e.g. adds SSHFP row)

* Commiting full matrix file

* Added docs for SSHFP record

* Matrix: Mark OVH as SSHFP-capable in docs (see PR #482)
This commit is contained in:
Patrik Kernstock
2019-05-21 04:33:50 +02:00
committed by Tom Limoncelli
parent d84a91c848
commit c65ba1c84c
10 changed files with 180 additions and 29 deletions

View File

@ -13,11 +13,11 @@ Tag can be one of "issue", "issuewild" or "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.:
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.
CAA record is supported only by BIND, Google Cloud DNS, and Amazon Route 53. Some certificate authorities may not support this record until the mandatory date of September 2017.
CAA record is supported only by BIND, Google Cloud DNS, Amazon Route 53 and OVH. Some certificate authorities may not support this record until the mandatory date of September 2017.
{% include startExample.html %}
{% highlight js %}

View File

@ -15,8 +15,8 @@ Target should be a string representing the NS target. If it is a single label we
{% highlight js %}
D("example.com", REGISTRAR, DnsProvider("R53"),
NS("foo", "ns1.example2.com"), // Delegate ".foo.example.com" zone to another server.
NS("foo", "ns2.example2.com"), // Delegate ".foo.example.com" zone to another server.
NS("foo", "ns1.example2.com."), // Delegate ".foo.example.com" zone to another server.
NS("foo", "ns2.example2.com."), // Delegate ".foo.example.com" zone to another server.
A("ns1.example2.com", "10.10.10.10"), // Glue records
A("ns2.example2.com", "10.10.10.20"), // Glue records
);

View File

@ -0,0 +1,37 @@
---
name: SSHFP
parameters:
- name
- algorithm
- type
- value
- modifiers...
---
SSHFP contains a fingerprint of a SSH server which can be validated before SSH clients are establishing the connection.
**Algorithm** (type of the key)
| ID | Algorithm |
|----|-----------|
| 0 | reserved |
| 1 | RSA |
| 2 | DSA |
| 3 | ECDSA |
| 4 | ED25519 |
**Type** (fingerprint format)
| ID | Algorithm |
|----|-----------|
| 0 | reserved |
| 1 | SHA-1 |
| 2 | SHA-256 |
`value` is the fingerprint as a string.
{% include startExample.html %}
{% highlight js %}
SSHFP('@', 1, 1, '00yourAmazingFingerprint00'),
{%endhighlight%}
{% include endExample.html %}

View File

@ -0,0 +1,17 @@
---
name: IP
parameters:
- ip
---
Converts the IP address from string to an integer. This allows performing mathematical operations with the IP address.
{% include startExample.html %}
{% highlight js %}
var addrA = IP('1.2.3.4')
var addrB = addrA + 1
// addrB = 1.2.3.5
{%endhighlight%}
{% include endExample.html %}