pierdet/rwsdns

RWSDNS aims to provide a RESTful API for interacting with Windows Server DNS.

RWSDNS - RESTful Windows Server DNS

RWSDNS aims to provide a RESTful API for interacting with Windows Server DNS.

Installation on IIS

Installation has to be done on a DNS Server, you need the .NET Core SDK in order to publish the application.

(Thanks https://github.com/unosquare/passcore for the template!)

1. Install IIS
2. Download the source code and run the following command via an Command Prompt. Make sure you start the Command Prompt with the Administrator option and change directory to where the project files is saved.
   • dotnet publish --configuration Release --runtime win-x64 --output "<path>"
   • The <path> is the directory where you will be serving the website from.
3. Install the .NET Core 3.0.0 Windows Server Hosting bundle.
4. Go to your IIS Manager, Right-click on Application Pools and select Add Application Pool.
5. A dialog appears. Under Name enter RWSDNS Application Pool, leave .NET CLR version and Managed Code as the default. Click OK.
6. Now, right-click on the application pool you just created in the previous step and select Advanced Settings .... Change the Start Mode to AlwaysRunning, and the Idle Time-out (minutes) to 0. Click on OK. This will ensure the application stays responsive even after long periods of inactivity. Identity also has to be changed to an account with permissions to manage DNS.
7. Back on your IIS Manager, right-click on Sites and select Add Website
8. A dialog appears. Under Site name, enter RWSDNS. Under Application pool click on Select and ensure you select RWSDNS Application Pool. Under Physical path, click on the ellipsis (...), navigate to the folder where you extracted RWSDNS.
   • Important: Make sure the Physical path points to the parent folder which is the one containing the files, logs and wwwroot folders.
9. Under the Binding section of the same dialog, configure the Type to be https, set IP Address to All Unassigned, the Port to 443 and the Hostname to something like dnsapi.yourdomain.com. Under SSL Certificate select a certificate that matches the Hostname you provided above. If you don't know how to install a certificate, please refer to SSL Certificate Install on IIS 8 or SSL Certificate Install on IIS 10 , in order to install a proper certificate.
   • Important: Do not serve this website without an SSL certificate because requests and responses will be transmitted in cleartext and an attacker could easily retrieve these messages and collect the API Key.
10. Click OK and you should be set. You should change the default API Key which is 'Password' via the /api/v1.0/auth/ApiKey endpoint right away.

Example use - A Record for the DNS zone 'test.se'

http post for adding/updating, http delete for deleting all

note - Check the /tests/ folder for up-to-date URL:s in the powershell scripts

Example use - CNAME Record for the DNS zone 'test.se'

(http post for adding/updating, http delete for deleting all)

rwsdns's Issues

Fix so restart isn't needed to reload the appsettings.json file

RWSDNS/RWSDNS/Controllers/ApiKeyController.cs

Lines 15 to 18 in 1fc0f78

	// @Todo Fix so restart isn't needed to reload the appsettings.json file
	[ApiVersion("1.0")]
	[Route("api/v{version:apiVersion}/auth/[controller]")]
	[ApiController]

---

This issue was generated by todo based on a Todo comment in 1fc0f78. It's been assigned to @pierdet because they committed the code.

Implement delete functionality

https://stackoverflow.com/questions/3827126/how-to-delete-a-dns-zone-with-wmi

- Implement Delete functionality

RWSDNS/RWSDNS/Common/DNSProvider.cs

Lines 32 to 35 in ff059b6

	// @Todo - Implement Delete functionality
	return new ApiResult { Success = false };
	}
	// Existing A record found, update record.

---

This issue was generated by todo based on a Todo comment in ff059b6. It's been assigned to @pierdet because they committed the code.

- Fix, doesn't work now.

RWSDNS/RWSDNS/Common/DNSProvider.cs

Lines 249 to 254 in 6c86512

	// @Todo - Fix, doesn't work now.
	var mgmtClass = new ManagementClass(mgmtScope, new ManagementPath("MicrosoftDNS_Zone"), null);
	mgmtParams = mgmtClass.GetMethodParameters("CreateZone");
	mgmtParams["DnsServerName"] = Environment.MachineName;
	mgmtParams["ZoneName"] = zone;

---

This issue was generated by todo based on a Todo comment in 6c86512. It's been assigned to @pierdet because they committed the code.

dispose of ManagementObjectSearcher in methods

RWSDNS/RWSDNS/Common/DNSProvider.cs

Lines 13 to 16 in faa8a59

	// @Todo dispose of ManagementObjectSearcher in methods
	public ApiResult DeleteARecord(string zone, string hostname, string ipAddress)
	{
	var mgmtScope = new ManagementScope(@"\\.\Root\MicrosoftDNS");

---

This issue was generated by todo based on a Todo comment in faa8a59. It's been assigned to @pierdet because they committed the code.

Rewrite to support new API Endpoints and the new URL:s

RWSDNS/tests/test1.ps1

Lines 4 to 8 in ae0eca9

	# @Todo Rewrite to support new API Endpoints and the new URL:s
	#skip SSL
	add-type @"
	using System.Net;

---

This issue was generated by todo based on a Todo comment in ae0eca9. It's been assigned to @pierdet because they committed the code.

Update readme with new API urls, authentication etc

Implement methods for CNAME and TXT records in DNSProvider

Implement API Key auth

rename to ARecordController

RWSDNS/RWSDNS/Controllers/DnsController.cs

Lines 12 to 15 in ff059b6

	// @Todo rename to ARecordController
	[Route("v1/[controller]")]
	[ApiController]
	public class DnsController : ControllerBase

---

This issue was generated by todo based on a Todo comment in ff059b6. It's been assigned to @pierdet because they committed the code.

Create tests

https://stackoverflow.com/questions/22105838/how-would-i-write-unit-tests-for-something-like-this ?

implement tests for the other methods

RWSDNS/tests/test1.ps1

Lines 19 to 20 in faa8a59

	# @Todo implement tests for the other methods
	}

---

This issue was generated by todo based on a Todo comment in faa8a59. It's been assigned to @pierdet because they committed the code.