Service updates: Default the windows service to a dedicated config file for compatibility with the GUI. Have the service change it's start up type on run so it will automatically start on system reboot, go back to manual when stopped. Documentation updates.

Author: saradickinson

ChangeLog

@@ -1,6 +1,8 @@
-* 2020-04-  : Version 0.3.1
-  * Remove the secure.eu entries in the stubby config file as the service is shutting down
-    as of 30th April
+*2020- : Version 0.4.0
+  * Add ability to run Stubby as a full Windows service
+  * Update IPs for dot1.applied-privacy.net
+  * Remove the secure.eu entries in the stubby config file
+  * Bugfix: Make `run_in_foreground = 1` the default again
 
 * 2020-02-28: Version 0.3.0
   * Correct the applied-privacy.net details and remove ibksturm server in stubby.yml.example.

README.md

@@ -191,6 +191,8 @@ Or via the GUI:
 
 ## Windows 8 and later
 
+See the file windows/README.txt for a detailed description of building and using Stubby on windows.
+
 Powershell scripts are provided in the the windows directory of the source code that can be used to update the system resolvers. 
 Instructions for how to update the resolvers manually are provided are also provided - see https://dnsprivacy.org/wiki/display/DP/Windows+installer+for+Stubby 
 Stubby has been reported to work on Windows 7, but we don't officially support it. 

src/configfile.c

@@ -105,6 +105,18 @@ char *system_config_file(void)
         return folder_config_file(CSIDL_PROGRAM_FILES);
 }
 
+char *system_service_config_file(void)
+{
+        int csidl = CSIDL_PROGRAM_FILES;
+        TCHAR szPath[MAX_PATH];
+
+        if (!SUCCEEDED(SHGetFolderPath(NULL,
+            csidl | CSIDL_FLAG_CREATE, NULL, 0, szPath)))
+                return NULL;
+
+        return make_config_file_path(szPath, "\\Stubby\\stubbyservice.yml");        
+}
+
 #else
 
 char *home_config_file(void)

src/configfile.h

@@ -32,6 +32,9 @@
 
 char *home_config_file(void);
 char *system_config_file(void);
+#if defined(STUBBY_ON_WINDOWS)
+char *system_service_config_file(void);
+#endif
 
 void init_config(getdns_context *context);
 void delete_config(void);

src/windows/service.c

@@ -382,7 +382,7 @@ VOID SvcInstall(void)
         schService = CreateService(
                 schSCManager,              // SCM database
                 SVCNAME,                   // name of service
-                "Stubby DNS Privacy Proxy", // service name to display
+                "Stubby DNS Privacy stub resolver", // service name to display
                 SERVICE_ALL_ACCESS,        // desired access
                 SERVICE_WIN32_OWN_PROCESS, // service type
                 SERVICE_DEMAND_START,      // start type
@@ -401,7 +401,7 @@ VOID SvcInstall(void)
                 winlasterr("Create service");
         }
 
-        description.lpDescription = TEXT("Enable performing DNS name lookups over secure channels.");
+        description.lpDescription = TEXT("Enable performing DNS name lookups over encrypted channels.");
         ChangeServiceConfig2(schService, SERVICE_CONFIG_DESCRIPTION,
                              (LPVOID) &description);
 
@@ -602,6 +602,50 @@ int SvcStatus(void)
         }
 }
 
+static void set_startup(DWORD start_type) {
+
+        SC_HANDLE schSCManager;
+        SC_HANDLE schService;
+        stubby_debug("set_startup");  
+
+        schSCManager = OpenSCManager(
+                NULL,                    // local computer
+                NULL,                    // ServicesActive database
+                GENERIC_WRITE);           // modify service
+
+        if (NULL == schSCManager)
+                winlasterr("Open service manager");
+
+        schService = OpenService(
+                schSCManager,              // SCM database
+                SVCNAME,                   // name of service
+                SERVICE_CHANGE_CONFIG);     // intention
+
+        if (schService == NULL)
+        {
+                CloseServiceHandle(schSCManager);
+                winlasterr("Open service");
+        }
+
+
+         if (! ChangeServiceConfig( 
+                schService,                // service handle
+                SERVICE_NO_CHANGE,         // service type
+                start_type,                // start type
+                SERVICE_NO_CHANGE,         // error control type
+                NULL,                      // path to service's binary
+                NULL,                      // no load ordering group
+                NULL,                      // no tag identifier
+                NULL,                      // no dependencies
+                NULL,                      // account name: no change 
+                NULL,                      // password: no change 
+                NULL) )                    // display name: no change
+        {
+                stubby_debug("ChangeServiceConfig failed (%d)\n", GetLastError()); 
+        }
+        else stubby_debug("Service start type changed successfully.\n");               
+}
+
 VOID WINAPI SvcMain(DWORD dwArgc, LPTSTR *lpszArgv)
 {
         stubby_set_log_funcs(report_verror, report_vlog);
@@ -620,6 +664,7 @@ VOID WINAPI SvcMain(DWORD dwArgc, LPTSTR *lpszArgv)
         gSvcStatus.dwServiceSpecificExitCode = 0;
         ReportSvcStatus(SERVICE_START_PENDING, 0, 3000);
 
+        set_startup(SERVICE_AUTO_START);
         SvcInit(dwArgc, lpszArgv);
 }
 
@@ -665,6 +710,9 @@ VOID SvcInit(DWORD dwArgc, LPTSTR* lpszArgv)
                 stubby_set_getdns_logging(context, lpszArgv[1][0] - '0');
         if ( dwArgc > 2 )
                 config_file = lpszArgv[2];
+        else
+                // have the service default to a dedicated file in its own directory
+                config_file = system_service_config_file();
 
         init_config(context);
         ReportSvcStatus(SERVICE_START_PENDING, 0, 1010);
@@ -709,6 +757,7 @@ VOID SvcInit(DWORD dwArgc, LPTSTR* lpszArgv)
                 default:
                         more = 0;
                         stubby_debug("Stop object signalled");
+                        set_startup(SERVICE_DEMAND_START);
                         break;
                 }
 

windows/README.txt

@@ -6,6 +6,9 @@ tested on Windows 10 and Windows 8. There is limited support for Windows 7
 welcomed via github!
 https://github.com/getdnsapi/stubby
 
+A development version of a Windows GUI for Stubby is also available, see
+https://dnsprivacy.org/wiki/display/DP/DNS+Privacy+Daemon+-+Stubby
+
 Installation
 --------------------
 Download and run the installer.
@@ -61,7 +64,7 @@ for details of available levels).
 A different location for the configuration file can be specified by adding:
 -C "<full path to stubby.yml>"
 
-We are working on support for running stubby as a service on Windows 10
+See below for details of running stubby as a service on Windows 10
 
 Test Stubby
 --------------------
@@ -122,6 +125,19 @@ task just run
 
 schtasks /create /tn Stubby /XML "C:\Program Files\Stubby\stubby.xml" /RU <you_user_name>
 
+Running as a Windows service
+----------------------------
+Stubby can now also be installed as a windows service by using the command
+
+stubby -w install
+
+It can then be controlled via the Windows Service Manager or directly on the command
+line by replacing 'install' with 'start', 'stop' or 'remove' in the above command. 
+The start command can take 2 parameters, the logging level and a custom configuration file.
+
+NOTE: When running as a service, stubby will read its default configuration from 
+
+C:\Program Files\Stubby\stubbyservice.yml
 
 Known Issues
 --------------------

windows/stubby-feature.wxs

@@ -18,8 +18,8 @@
       <Component Id="stubby.exe">
         <File Id="stubby.exe" Source="Stubby/stubby.exe"  KeyPath="yes" Checksum="yes"/>
         <ServiceInstall Id="ServiceInstaller" Type="ownProcess"
-                        Name="Stubby" DisplayName="Stubby DNS Privacy Proxy"
-                        Description="Enable performing DNS name lookups over secure channels."
+                        Name="Stubby" DisplayName="Stubby DNS Privacy stub resolver"
+                        Description="Enable performing DNS name lookups over encrypted channels."
                         Start="demand"
                         ErrorControl="normal"
                         Arguments="-w service">
@@ -53,6 +53,9 @@
       <Component Id="stubby.yml">
         <File Id="stubby.yml" Source="Stubby/stubby.yml"  KeyPath="yes" Checksum="yes" />
       </Component>
+      <Component Id="stubbyservice.yml">
+        <File Id="stubbyservice.yml" Name="stubbyservice.yml" Source="Stubby/stubby.yml"  KeyPath="yes" Checksum="yes" />
+      </Component>
       <Component Id="README.txt">
         <File Id="README.txt" Source="Stubby/README.txt"  KeyPath="yes" Checksum="yes"/>
       </Component>