fergalmoran/DnsServer
1
0
Fork 0
mirror of https://github.com/fergalmoran/DnsServer.git synced 2025-12-22 09:29:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated apidocs.

Browse Source
This commit is contained in:
Shreyas Zare
2022-03-12 16:01:47 +05:30
parent 72ac65297d
commit 26244f0286
1 changed files with 33 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
APIDOCS.md
View File

@@ -1882,7 +1882,7 @@ WHERE:
Signs the primary zone (DNSSEC).
URL:
`http://localhost:5380/api/zone/dnssec/sign?token=x&zone=example.com&algorithm=ECDSA&dnsKeyTtl=86400&nxProof=NSEC3&iterations=0&saltLength=0&curve=P256`
`http://localhost:5380/api/zone/dnssec/sign?token=x&zone=example.com&algorithm=ECDSA&dnsKeyTtl=86400&zskRolloverDays=90&nxProof=NSEC3&iterations=0&saltLength=0&curve=P256`
WHERE:
- `token`: The session token generated by the `login` call.
@@ -1893,6 +1893,7 @@ WHERE:
- `zskKeySize` (optional): The size of the Zone Signing Key (ZSK) in bits to be used when using `RSA` algorithm. This optional parameter is required when using `RSA` algorithm.
- `curve` (optional): The name of the curve to be used when using `ECDSA` algorithm. Valid values are [`P256`, `P384`]. This optional parameter is required when using `ECDSA` algorithm.
- `dnsKeyTtl` (optional): The TTL value to be used for DNSKEY records. Default value is `86400` when not specified.
- `zskRolloverDays` (optional): The frequency in days that the DNS server must automatically rollover the Zone Signing Keys (ZSK) in the zone. Default value is `90` days.
- `nxProof` (optional): The type of proof of non-existence that must be used for signing the zone. Valid values are [`NSEC`, `NSEC3`]. Default value is `NSEC` when not specified.
- `iterations` (optional): The number of iterations to use for hashing in NSEC3. This optional parameter is only applicable when using `NSEC3` as the `nxProof`. Default value is `0` when not specified.
- `saltLength` (optional): The length of salt in bytes to use for hashing in NSEC3. This optional parameter is only applicable when using `NSEC3` as the `nxProof`. Default value is `0` when not specified.
@@ -1913,7 +1914,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone to unsign.
RESPONSE:
```
@@ -1931,7 +1932,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
RESPONSE:
```
@@ -1943,6 +1944,7 @@ RESPONSE:
"disabled": false,
"dnssecStatus": "SignedWithNSEC",
"dnsKeyTtl": 86400,
"zskRolloverDays": 90,
"dnssecPrivateKeys": [
{
"keyTag": 19198,
@@ -1975,7 +1977,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
RESPONSE:
```
@@ -1993,7 +1995,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
RESPONSE:
```
@@ -2011,7 +2013,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
- `iterations` (optional): The number of iterations to use for hashing. Default value is `0` when not specified.
- `saltLength` (optional): The length of salt in bytes to use for hashing. Default value is `0` when not specified.
@@ -2031,7 +2033,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
- `ttl`: The TTL value for the DNSKEY resource record set.
RESPONSE:
@@ -2041,6 +2043,25 @@ RESPONSE:
}
```
### Update DNSKEY Rollover
Updates the Zone Signing Key (ZSK) automatic rollover option.
URL:
`http://localhost:5380/api/zone/dnssec/updateDnsKeyRollover?token=x&zone=example.com&zskRolloverDays=90`
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone.
- `zskRolloverDays`: The frequency in days that the DNS server must automatically rollover the Zone Signing Keys (ZSK) in the zone.
RESPONSE:
```
{
"status": "ok"
}
```
### Generate Private Key
Generates a private key to be used for signing the zone with DNSSEC.
@@ -2050,7 +2071,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
- `keyType`: The type of key for which the private key is to be generated. Valid values are [`KeySigningKey`, `ZoneSigningKey`].
- `algorithm`: The algorithm to be used for signing. Valid values are [`RSA`, `ECDSA`].
- `hashAlgorithm` (optional): The hash algorithm to be used when using `RSA` algorithm. Valid values are [`MD5`, `SHA1, `SHA256`, `SHA512`]. This optional parameter is required when using `RSA` algorithm.
@@ -2073,7 +2094,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
- `keyTag`: The key tag of the private key to be deleted.
RESPONSE:
@@ -2092,7 +2113,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
RESPONSE:
```
@@ -2110,7 +2131,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
- `keyTag`: The key tag of the private key to rollover.
RESPONSE:
@@ -2129,7 +2150,7 @@ URL:
WHERE:
- `token`: The session token generated by the `login` call.
- `zone`: The name of the primary zone to sign.
- `zone`: The name of the primary zone.
- `keyTag`: The key tag of the private key to retire.
RESPONSE: