Added DNS firewall Reverse DNS

This commit is contained in:
2025-11-06 20:51:51 +01:00
parent df0f60ef29
commit dbcda1685a
7 changed files with 303 additions and 0 deletions

View File

@@ -9,6 +9,8 @@ namespace AMWD.Net.Api.Cloudflare.Dns
/// </summary>
public static class DnsFirewallExtensions
{
#region DNS Firewall
/// <summary>
/// List DNS Firewall clusters for an account.
/// </summary>
@@ -150,5 +152,45 @@ namespace AMWD.Net.Api.Cloudflare.Dns
return client.DeleteAsync<Identifier>($"/accounts/{accountId}/dns_firewall/{dnsFirewallId}", null, cancellationToken);
}
#endregion DNS Firewall
#region Reverse DNS
/// <summary>
/// Show reverse DNS configuration (PTR records) for a DNS Firewall cluster
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="accountId">The account identifier.</param>
/// <param name="dnsFirewallId">The DNS firewall identifier.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<ReverseDnsResponse>> ShowDNSFirewallClusterReverseDNS(this ICloudflareClient client, string accountId, string dnsFirewallId, CancellationToken cancellationToken = default)
{
accountId.ValidateCloudflareId();
dnsFirewallId.ValidateCloudflareId();
return client.GetAsync<ReverseDnsResponse>($"/accounts/{accountId}/dns_firewall/{dnsFirewallId}/reverse_dns", null, cancellationToken);
}
/// <summary>
/// Update reverse DNS configuration (PTR records) for a DNS Firewall cluster.
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<ReverseDnsResponse>> UpdateDNSFirewallClusterReverseDNS(this ICloudflareClient client, UpdateDNSFirewallClusterReverseDNSRequest request, CancellationToken cancellationToken = default)
{
request.AccountId.ValidateCloudflareId();
request.DnsFirewallId.ValidateCloudflareId();
var req = new InternalUpdateDNSFirewallClusterReverseDNSRequest
{
Ptr = request.ReverseDNS
};
return client.PatchAsync<ReverseDnsResponse, InternalUpdateDNSFirewallClusterReverseDNSRequest>($"/accounts/{request.AccountId}/dns_firewall/{request.DnsFirewallId}/reverse_dns", req, cancellationToken);
}
#endregion Reverse DNS
}
}

View File

@@ -0,0 +1,8 @@
namespace AMWD.Net.Api.Cloudflare.Dns.Internals
{
internal class InternalUpdateDNSFirewallClusterReverseDNSRequest
{
[JsonProperty("ptr")]
public IReadOnlyDictionary<string, string>? Ptr { get; set; }
}
}

View File

@@ -122,6 +122,13 @@ This package contains the feature set of the _DNS_ section of the Cloudflare API
- [Delete DNS Firewall Cluster](https://developers.cloudflare.com/api/resources/dns_firewall/methods/delete/)
#### [Reverse DNS]
- [Show DNS Firewall Cluster Reverse DNS](https://developers.cloudflare.com/api/resources/dns_firewall/subresources/reverse_dns/methods/get/)
- [Update DNS Firewall Cluster Reverse DNS](https://developers.cloudflare.com/api/resources/dns_firewall/subresources/reverse_dns/methods/edit/)
---
Published under MIT License (see [choose a license])
@@ -146,3 +153,4 @@ Published under MIT License (see [choose a license])
[Peers]: https://developers.cloudflare.com/api/resources/dns/subresources/zone_transfers/subresources/peers/
[TSIGs]: https://developers.cloudflare.com/api/resources/dns/subresources/zone_transfers/subresources/tsigs/
[DNS Firewall]: https://developers.cloudflare.com/api/resources/dns_firewall/
[Reverse DNS]: https://developers.cloudflare.com/api/resources/dns_firewall/subresources/reverse_dns/

View File

@@ -0,0 +1,34 @@
namespace AMWD.Net.Api.Cloudflare.Dns
{
/// <summary>
/// Represents a request to update the reverse DNS configuration for a DNS firewall cluster.
/// </summary>
public class UpdateDNSFirewallClusterReverseDNSRequest
{
/// <summary>
/// Initializes a new instance of the <see cref="UpdateDNSFirewallClusterReverseDNSRequest"/> class.
/// </summary>
/// <param name="accountId">The account identifier.</param>
/// <param name="dnsFirewallId">The DNS firewall cluster identifier.</param>
public UpdateDNSFirewallClusterReverseDNSRequest(string accountId, string dnsFirewallId)
{
AccountId = accountId;
DnsFirewallId = dnsFirewallId;
}
/// <summary>
/// The account identifier.
/// </summary>
public string AccountId { get; set; }
/// <summary>
/// The DNS firewall cluster identifier.
/// </summary>
public string DnsFirewallId { get; set; }
/// <summary>
/// Map of cluster IP addresses to PTR record contents.
/// </summary>
public IReadOnlyDictionary<string, string>? ReverseDNS { get; set; }
}
}

View File

@@ -0,0 +1,14 @@
namespace AMWD.Net.Api.Cloudflare.Dns
{
/// <summary>
/// Represents the response of reverse DNS records of a firewall cluster.
/// </summary>
public class ReverseDnsResponse
{
/// <summary>
/// Map of cluster IP addresses to PTR record contents.
/// </summary>
[JsonProperty("ptr")]
public IReadOnlyDictionary<string, string>? ReverseDNS { get; set; }
}
}

View File

@@ -0,0 +1,79 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Dns;
using Moq;
namespace Cloudflare.Dns.Tests.DnsFirewallExtensions.ReverseDns
{
[TestClass]
public class ShowDNSFirewallClusterReverseDNSTest
{
public TestContext TestContext { get; set; }
private const string AccountId = "023e105f4ecef8ad9ca31a8372d0c353";
private const string ClusterId = "023e105f4ecef8ad9ca31a8372d0c355";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<ReverseDnsResponse> _response;
private List<(string RequestPath, IQueryParameterFilter QueryFilter)> _callbacks;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<ReverseDnsResponse>
{
Success = true,
Messages = [new ResponseInfo(1000, "Message 1")],
Errors = [new ResponseInfo(1000, "Error 1")],
Result = new ReverseDnsResponse
{
ReverseDNS = new Dictionary<string, string>
{
["192.0.2.1"] = "ptr.example.com"
}
}
};
}
[TestMethod]
public async Task ShouldShowDnsFirewallClusterReverseDns()
{
// Arrange
var client = GetClient();
// Act
var response = await client.ShowDNSFirewallClusterReverseDNS(AccountId, ClusterId, TestContext.CancellationToken);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.IsNotNull(response.Result);
Assert.IsTrue(response.Result.ReverseDNS?.ContainsKey("192.0.2.1") ?? false);
Assert.AreEqual("ptr.example.com", response.Result.ReverseDNS!["192.0.2.1"]);
Assert.HasCount(1, _callbacks);
var (requestPath, queryFilter) = _callbacks.First();
Assert.AreEqual($"/accounts/{AccountId}/dns_firewall/{ClusterId}/reverse_dns", requestPath);
Assert.IsNull(queryFilter);
_clientMock.Verify(m => m.GetAsync<ReverseDnsResponse>($"/accounts/{AccountId}/dns_firewall/{ClusterId}/reverse_dns", null, TestContext.CancellationToken), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.GetAsync<ReverseDnsResponse>(It.IsAny<string>(), It.IsAny<IQueryParameterFilter>(), It.IsAny<CancellationToken>()))
.Callback<string, IQueryParameterFilter, CancellationToken>((requestPath, queryFilter, _) => _callbacks.Add((requestPath, queryFilter)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}

View File

@@ -0,0 +1,118 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Dns;
using AMWD.Net.Api.Cloudflare.Dns.Internals;
using Moq;
namespace Cloudflare.Dns.Tests.DnsFirewallExtensions.ReverseDns
{
[TestClass]
public class UpdateDNSFirewallClusterReverseDNSTest
{
public TestContext TestContext { get; set; }
private const string AccountId = "023e105f4ecef8ad9ca31a8372d0c353";
private const string ClusterId = "023e105f4ecef8ad9ca31a8372d0c355";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<ReverseDnsResponse> _response;
private List<(string RequestPath, InternalUpdateDNSFirewallClusterReverseDNSRequest Request)> _callbacks;
private UpdateDNSFirewallClusterReverseDNSRequest _request;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<ReverseDnsResponse>
{
Success = true,
Messages = [new ResponseInfo(1000, "Message 1")],
Errors = [new ResponseInfo(1000, "Error 1")],
Result = new ReverseDnsResponse
{
ReverseDNS = new Dictionary<string, string>
{
["10.0.0.1"] = "ptr1.example.com"
}
}
};
_request = new UpdateDNSFirewallClusterReverseDNSRequest(AccountId, ClusterId)
{
ReverseDNS = new Dictionary<string, string>
{
["10.0.0.1"] = "ptr1.example.com"
}
};
}
[TestMethod]
public async Task ShouldUpdateDnsFirewallClusterReverseDns()
{
// Arrange
var client = GetClient();
// Act
var response = await client.UpdateDNSFirewallClusterReverseDNS(_request, TestContext.CancellationToken);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.IsNotNull(response.Result);
Assert.IsTrue(response.Result.ReverseDNS?.ContainsKey("10.0.0.1") ?? false);
Assert.AreEqual("ptr1.example.com", response.Result.ReverseDNS!["10.0.0.1"]);
Assert.HasCount(1, _callbacks);
var (requestPath, request) = _callbacks.First();
Assert.AreEqual($"/accounts/{AccountId}/dns_firewall/{ClusterId}/reverse_dns", requestPath);
Assert.IsNotNull(request);
Assert.IsNotNull(request.Ptr);
Assert.IsTrue(request.Ptr.ContainsKey("10.0.0.1"));
Assert.AreEqual("ptr1.example.com", request.Ptr["10.0.0.1"]);
_clientMock.Verify(m => m.PatchAsync<ReverseDnsResponse, InternalUpdateDNSFirewallClusterReverseDNSRequest>($"/accounts/{AccountId}/dns_firewall/{ClusterId}/reverse_dns", It.IsAny<InternalUpdateDNSFirewallClusterReverseDNSRequest>(), TestContext.CancellationToken), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
[TestMethod]
public async Task ShouldUpdateDnsFirewallClusterReverseDnsMinimalSet()
{
// Arrange
_request = new UpdateDNSFirewallClusterReverseDNSRequest(AccountId, ClusterId);
var client = GetClient();
// Act
var response = await client.UpdateDNSFirewallClusterReverseDNS(_request, TestContext.CancellationToken);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.HasCount(1, _callbacks);
var (requestPath, request) = _callbacks.First();
Assert.AreEqual($"/accounts/{AccountId}/dns_firewall/{ClusterId}/reverse_dns", requestPath);
Assert.IsNull(request.Ptr);
_clientMock.Verify(m => m.PatchAsync<ReverseDnsResponse, InternalUpdateDNSFirewallClusterReverseDNSRequest>($"/accounts/{AccountId}/dns_firewall/{ClusterId}/reverse_dns", It.IsAny<InternalUpdateDNSFirewallClusterReverseDNSRequest>(), TestContext.CancellationToken), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.PatchAsync<ReverseDnsResponse, InternalUpdateDNSFirewallClusterReverseDNSRequest>(It.IsAny<string>(), It.IsAny<InternalUpdateDNSFirewallClusterReverseDNSRequest>(), It.IsAny<CancellationToken>()))
.Callback<string, InternalUpdateDNSFirewallClusterReverseDNSRequest, CancellationToken>((requestPath, request, _) => _callbacks.Add((requestPath, request)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}