registry.cpp

   1 #include "nssm.h"\r
   2 \r
   3 extern const char *exit_action_strings[];\r
   4 \r
   5 int create_messages() {\r
   6   HKEY key;\r
   7 \r
   8   char registry[KEY_LENGTH];\r
   9   if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, "SYSTEM\\CurrentControlSet\\Services\\EventLog\\Application\\%s", NSSM) < 0) {\r
  10     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "eventlog registry", "create_messages()", 0);\r
  11     return 1;\r
  12   }\r
  13 \r
  14   if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, 0) != ERROR_SUCCESS) {\r
  15     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
  16     return 2;\r
  17   }\r
  18 \r
  19   /* Get path of this program */\r
  20   char path[MAX_PATH];\r
  21   GetModuleFileName(0, path, MAX_PATH);\r
  22 \r
  23   /* Try to register the module but don't worry so much on failure */\r
  24   RegSetValueEx(key, "EventMessageFile", 0, REG_SZ, (const unsigned char *) path, (unsigned long) strlen(path) + 1);\r
  25   unsigned long types = EVENTLOG_INFORMATION_TYPE | EVENTLOG_WARNING_TYPE | EVENTLOG_ERROR_TYPE;\r
  26   RegSetValueEx(key, "TypesSupported", 0, REG_DWORD, (const unsigned char *) &types, sizeof(types));\r
  27 \r
  28   return 0;\r
  29 }\r
  30 \r
  31 int create_parameters(nssm_service_t *service) {\r
  32   /* Get registry */\r
  33   char registry[KEY_LENGTH];\r
  34   if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY, service->name) < 0) {\r
  35     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REGISTRY", "create_parameters()", 0);\r
  36     return 1;\r
  37   }\r
  38 \r
  39   /* Try to open the registry */\r
  40   HKEY key;\r
  41   if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, 0) != ERROR_SUCCESS) {\r
  42     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
  43     return 2;\r
  44   }\r
  45 \r
  46   /* Try to create the parameters */\r
  47   if (set_expand_string(key, NSSM_REG_EXE, service->exe)) {\r
  48     RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY);\r
  49     RegCloseKey(key);\r
  50     return 3;\r
  51   }\r
  52   if (set_expand_string(key, NSSM_REG_FLAGS, service->flags)) {\r
  53     RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY);\r
  54     RegCloseKey(key);\r
  55     return 4;\r
  56   }\r
  57   if (set_expand_string(key, NSSM_REG_DIR, service->dir)) {\r
  58     RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY);\r
  59     RegCloseKey(key);\r
  60     return 5;\r
  61   }\r
  62 \r
  63   /* Other non-default parameters. May fail. */\r
  64   unsigned long stop_method_skip = ~service->stop_method;\r
  65   if (stop_method_skip) set_number(key, NSSM_REG_STOP_METHOD_SKIP, stop_method_skip);\r
  66   if (service->default_exit_action < NSSM_NUM_EXIT_ACTIONS) create_exit_action(service->name, exit_action_strings[service->default_exit_action]);\r
  67   if (service->throttle_delay != NSSM_RESET_THROTTLE_RESTART) set_number(key, NSSM_REG_THROTTLE, service->throttle_delay);\r
  68   if (service->kill_console_delay != NSSM_KILL_CONSOLE_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_CONSOLE_GRACE_PERIOD, service->kill_console_delay);\r
  69   if (service->kill_window_delay != NSSM_KILL_WINDOW_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_WINDOW_GRACE_PERIOD, service->kill_window_delay);\r
  70   if (service->kill_threads_delay != NSSM_KILL_THREADS_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_THREADS_GRACE_PERIOD, service->kill_threads_delay);\r
  71   if (service->stdin_path[0]) set_expand_string(key, NSSM_REG_STDIN, service->stdin_path);\r
  72   if (service->stdout_path[0]) set_expand_string(key, NSSM_REG_STDOUT, service->stdout_path);\r
  73   if (service->stderr_path[0]) set_expand_string(key, NSSM_REG_STDERR, service->stderr_path);\r
  74 \r
  75   /* Close registry. */\r
  76   RegCloseKey(key);\r
  77 \r
  78   return 0;\r
  79 }\r
  80 \r
  81 int create_exit_action(char *service_name, const char *action_string) {\r
  82   /* Get registry */\r
  83   char registry[KEY_LENGTH];\r
  84   if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY "\\%s", service_name, NSSM_REG_EXIT) < 0) {\r
  85     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REG_EXIT", "create_exit_action()", 0);\r
  86     return 1;\r
  87   }\r
  88 \r
  89   /* Try to open the registry */\r
  90   HKEY key;\r
  91   unsigned long disposition;\r
  92   if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, &disposition) != ERROR_SUCCESS) {\r
  93     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
  94     return 2;\r
  95   }\r
  96 \r
  97   /* Do nothing if the key already existed */\r
  98   if (disposition == REG_OPENED_EXISTING_KEY) {\r
  99     RegCloseKey(key);\r
 100     return 0;\r
 101   }\r
 102 \r
 103   /* Create the default value */\r
 104   if (RegSetValueEx(key, 0, 0, REG_SZ, (const unsigned char *) action_string, (unsigned long) strlen(action_string) + 1) != ERROR_SUCCESS) {\r
 105     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_EXIT, error_string(GetLastError()), 0);\r
 106     RegCloseKey(key);\r
 107     return 3;\r
 108   }\r
 109 \r
 110   /* Close registry */\r
 111   RegCloseKey(key);\r
 112 \r
 113   return 0;\r
 114 }\r
 115 \r
 116 int set_environment(char *service_name, HKEY key, char **env) {\r
 117   unsigned long type = REG_MULTI_SZ;\r
 118   unsigned long envlen = 0;\r
 119 \r
 120   /* Dummy test to find buffer size */\r
 121   unsigned long ret = RegQueryValueEx(key, NSSM_REG_ENV, 0, &type, NULL, &envlen);\r
 122   if (ret != ERROR_SUCCESS) {\r
 123     /* The service probably doesn't have any environment configured */\r
 124     if (ret == ERROR_FILE_NOT_FOUND) return 0;\r
 125     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_ENV, error_string(GetLastError()), 0);\r
 126     return 1;\r
 127   }\r
 128 \r
 129   if (type != REG_MULTI_SZ) {\r
 130     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_INVALID_ENVIRONMENT_STRING_TYPE, NSSM_REG_ENV, service_name, 0);\r
 131     return 2;\r
 132   }\r
 133 \r
 134   /* Probably not possible */\r
 135   if (! envlen) return 0;\r
 136 \r
 137   /* Previously initialised? */\r
 138   if (*env) HeapFree(GetProcessHeap(), 0, *env);\r
 139 \r
 140   *env = (char *) HeapAlloc(GetProcessHeap(), 0, envlen);\r
 141   if (! *env) {\r
 142     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "environment registry", "set_environment()", 0);\r
 143     return 3;\r
 144   }\r
 145 \r
 146   /* Actually get the strings */\r
 147   ret = RegQueryValueEx(key, NSSM_REG_ENV, 0, &type, (unsigned char *) *env, &envlen);\r
 148   if (ret != ERROR_SUCCESS) {\r
 149     HeapFree(GetProcessHeap(), 0, *env);\r
 150     *env = 0;\r
 151     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_ENV, error_string(GetLastError()), 0);\r
 152     return 4;\r
 153   }\r
 154 \r
 155   return 0;\r
 156 }\r
 157 \r
 158 int expand_parameter(HKEY key, char *value, char *data, unsigned long datalen, bool sanitise, bool must_exist) {\r
 159   unsigned char *buffer = (unsigned char *) HeapAlloc(GetProcessHeap(), 0, datalen);\r
 160   if (! buffer) {\r
 161     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, value, "expand_parameter()", 0);\r
 162     return 1;\r
 163   }\r
 164 \r
 165   ZeroMemory(data, datalen);\r
 166 \r
 167   unsigned long type = REG_EXPAND_SZ;\r
 168   unsigned long buflen = datalen;\r
 169 \r
 170   unsigned long ret = RegQueryValueEx(key, value, 0, &type, buffer, &buflen);\r
 171   if (ret != ERROR_SUCCESS) {\r
 172     unsigned long error = GetLastError();\r
 173     HeapFree(GetProcessHeap(), 0, buffer);\r
 174 \r
 175     if (ret == ERROR_FILE_NOT_FOUND) {\r
 176       if (! must_exist) return 0;\r
 177     }\r
 178 \r
 179     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(error), 0);\r
 180     return 2;\r
 181   }\r
 182 \r
 183   /* Paths aren't allowed to contain quotes. */\r
 184   if (sanitise) PathUnquoteSpaces((LPSTR) buffer);\r
 185 \r
 186   /* Technically we shouldn't expand environment strings from REG_SZ values */\r
 187   if (type != REG_EXPAND_SZ) {\r
 188     memmove(data, buffer, buflen);\r
 189     HeapFree(GetProcessHeap(), 0, buffer);\r
 190     return 0;\r
 191   }\r
 192 \r
 193   ret = ExpandEnvironmentStrings((char *) buffer, data, datalen);\r
 194   if (! ret || ret > datalen) {\r
 195     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_EXPANDENVIRONMENTSTRINGS_FAILED, buffer, error_string(GetLastError()), 0);\r
 196     HeapFree(GetProcessHeap(), 0, buffer);\r
 197     return 3;\r
 198   }\r
 199 \r
 200   HeapFree(GetProcessHeap(), 0, buffer);\r
 201   return 0;\r
 202 }\r
 203 \r
 204 int expand_parameter(HKEY key, char *value, char *data, unsigned long datalen, bool sanitise) {\r
 205   return expand_parameter(key, value, data, datalen, sanitise, true);\r
 206 }\r
 207 \r
 208 /*\r
 209   Sets a string in the registry.\r
 210   Returns: 0 if it was set.\r
 211            1 on error.\r
 212 */\r
 213 int set_expand_string(HKEY key, char *value, char *string) {\r
 214   if (RegSetValueEx(key, value, 0, REG_EXPAND_SZ, (const unsigned char *) string, (unsigned long) strlen(string) + 1) == ERROR_SUCCESS) return 0;\r
 215   log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 216   return 1;\r
 217 }\r
 218 \r
 219 /*\r
 220   Set an unsigned long in the registry.\r
 221   Returns: 0 if it was set.\r
 222            1 on error.\r
 223 */\r
 224 int set_number(HKEY key, char *value, unsigned long number) {\r
 225   if (RegSetValueEx(key, value, 0, REG_DWORD, (const unsigned char *) &number, sizeof(number)) == ERROR_SUCCESS) return 0;\r
 226   log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 227   return 1;\r
 228 }\r
 229 \r
 230 /*\r
 231   Query an unsigned long from the registry.\r
 232   Returns:  1 if a number was retrieved.\r
 233             0 if none was found and must_exist is false.\r
 234            -1 if none was found and must_exist is true.\r
 235            -2 otherwise.\r
 236 */\r
 237 int get_number(HKEY key, char *value, unsigned long *number, bool must_exist) {\r
 238   unsigned long type = REG_DWORD;\r
 239   unsigned long number_len = sizeof(unsigned long);\r
 240 \r
 241   int ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) number, &number_len);\r
 242   if (ret == ERROR_SUCCESS) return 1;\r
 243 \r
 244   if (ret == ERROR_FILE_NOT_FOUND) {\r
 245     if (! must_exist) return 0;\r
 246   }\r
 247 \r
 248   log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 249   if (ret == ERROR_FILE_NOT_FOUND) return -1;\r
 250 \r
 251   return -2;\r
 252 }\r
 253 \r
 254 int get_number(HKEY key, char *value, unsigned long *number) {\r
 255   return get_number(key, value, number, true);\r
 256 }\r
 257 \r
 258 void override_milliseconds(char *service_name, HKEY key, char *value, unsigned long *buffer, unsigned long default_value, unsigned long event) {\r
 259   unsigned long type = REG_DWORD;\r
 260   unsigned long buflen = sizeof(unsigned long);\r
 261   bool ok = false;\r
 262   unsigned long ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) buffer, &buflen);\r
 263   if (ret != ERROR_SUCCESS) {\r
 264     if (ret != ERROR_FILE_NOT_FOUND) {\r
 265       if (type != REG_DWORD) {\r
 266         char milliseconds[16];\r
 267         _snprintf_s(milliseconds, sizeof(milliseconds), _TRUNCATE, "%lu", default_value);\r
 268         log_event(EVENTLOG_WARNING_TYPE, event, service_name, value, milliseconds, 0);\r
 269       }\r
 270       else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 271     }\r
 272   }\r
 273   else ok = true;\r
 274 \r
 275   if (! ok) *buffer = default_value;\r
 276 }\r
 277 \r
 278 int get_parameters(nssm_service_t *service, STARTUPINFO *si) {\r
 279   unsigned long ret;\r
 280 \r
 281   /* Get registry */\r
 282   char registry[KEY_LENGTH];\r
 283   if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY, service->name) < 0) {\r
 284     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REGISTRY", "get_parameters()", 0);\r
 285     return 1;\r
 286   }\r
 287 \r
 288   /* Try to open the registry */\r
 289   HKEY key;\r
 290   if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key) != ERROR_SUCCESS) {\r
 291     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
 292     return 2;\r
 293   }\r
 294 \r
 295   /* Try to get executable file - MUST succeed */\r
 296   if (expand_parameter(key, NSSM_REG_EXE, service->exe, sizeof(service->exe), false)) {\r
 297     RegCloseKey(key);\r
 298     return 3;\r
 299   }\r
 300 \r
 301   /* Try to get flags - may fail and we don't care */\r
 302   if (expand_parameter(key, NSSM_REG_FLAGS, service->flags, sizeof(service->flags), false)) {\r
 303     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_FLAGS, NSSM_REG_FLAGS, service->name, service->exe, 0);\r
 304     ZeroMemory(service->flags, sizeof(service->flags));\r
 305   }\r
 306 \r
 307   /* Try to get startup directory - may fail and we fall back to a default */\r
 308   if (expand_parameter(key, NSSM_REG_DIR, service->dir, sizeof(service->dir), true) || ! service->dir[0]) {\r
 309     /* Our buffers are defined to be long enough for this to be safe */\r
 310     size_t i;\r
 311     for (i = strlen(service->exe); i && service->exe[i] != '\\' && service->exe[i] != '/'; i--);\r
 312     if (i) {\r
 313       memmove(service->dir, service->exe, i);\r
 314       service->dir[i] = '\0';\r
 315     }\r
 316     else {\r
 317       /* Help! */\r
 318       ret = GetWindowsDirectory(service->dir, sizeof(service->dir));\r
 319       if (! ret || ret > sizeof(service->dir)) {\r
 320         log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_NO_DIR_AND_NO_FALLBACK, NSSM_REG_DIR, service->name, 0);\r
 321         RegCloseKey(key);\r
 322         return 4;\r
 323       }\r
 324     }\r
 325     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_DIR, NSSM_REG_DIR, service->name, service->dir, 0);\r
 326   }\r
 327 \r
 328   /* Try to get environment variables - may fail */\r
 329   set_environment(service->name, key, &service->env);\r
 330 \r
 331   /* Try to get stdout and stderr */\r
 332   if (get_output_handles(key, si)) {\r
 333     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_OUTPUT_HANDLES_FAILED, service->name, 0);\r
 334     RegCloseKey(key);\r
 335     return 5;\r
 336   }\r
 337 \r
 338   /* Try to get throttle restart delay */\r
 339   override_milliseconds(service->name, key, NSSM_REG_THROTTLE, &service->throttle_delay, NSSM_RESET_THROTTLE_RESTART, NSSM_EVENT_BOGUS_THROTTLE);\r
 340 \r
 341   /* Try to get service stop flags. */\r
 342   unsigned long type = REG_DWORD;\r
 343   unsigned long stop_method_skip;\r
 344   unsigned long buflen = sizeof(stop_method_skip);\r
 345   bool stop_ok = false;\r
 346   ret = RegQueryValueEx(key, NSSM_REG_STOP_METHOD_SKIP, 0, &type, (unsigned char *) &stop_method_skip, &buflen);\r
 347   if (ret != ERROR_SUCCESS) {\r
 348     if (ret != ERROR_FILE_NOT_FOUND) {\r
 349       if (type != REG_DWORD) {\r
 350         log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_STOP_METHOD_SKIP, service->name, NSSM_REG_STOP_METHOD_SKIP, NSSM, 0);\r
 351       }\r
 352       else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_STOP_METHOD_SKIP, error_string(GetLastError()), 0);\r
 353     }\r
 354   }\r
 355   else stop_ok = true;\r
 356 \r
 357   /* Try all methods except those requested to be skipped. */\r
 358   service->stop_method = ~0;\r
 359   if (stop_ok) service->stop_method &= ~stop_method_skip;\r
 360 \r
 361   /* Try to get kill delays - may fail. */\r
 362   override_milliseconds(service->name, key, NSSM_REG_KILL_CONSOLE_GRACE_PERIOD, &service->kill_console_delay, NSSM_KILL_CONSOLE_GRACE_PERIOD, NSSM_EVENT_BOGUS_KILL_CONSOLE_GRACE_PERIOD);\r
 363   override_milliseconds(service->name, key, NSSM_REG_KILL_WINDOW_GRACE_PERIOD, &service->kill_window_delay, NSSM_KILL_WINDOW_GRACE_PERIOD, NSSM_EVENT_BOGUS_KILL_WINDOW_GRACE_PERIOD);\r
 364   override_milliseconds(service->name, key, NSSM_REG_KILL_THREADS_GRACE_PERIOD, &service->kill_threads_delay, NSSM_KILL_THREADS_GRACE_PERIOD, NSSM_EVENT_BOGUS_KILL_THREADS_GRACE_PERIOD);\r
 365 \r
 366   /* Close registry */\r
 367   RegCloseKey(key);\r
 368 \r
 369   return 0;\r
 370 }\r
 371 \r
 372 int get_exit_action(char *service_name, unsigned long *ret, unsigned char *action, bool *default_action) {\r
 373   /* Are we returning the default action or a status-specific one? */\r
 374   *default_action = ! ret;\r
 375 \r
 376   /* Get registry */\r
 377   char registry[KEY_LENGTH];\r
 378   if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY "\\%s", service_name, NSSM_REG_EXIT) < 0) {\r
 379     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REG_EXIT", "get_exit_action()", 0);\r
 380     return 1;\r
 381   }\r
 382 \r
 383   /* Try to open the registry */\r
 384   HKEY key;\r
 385   long error = RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key);\r
 386   if (error != ERROR_SUCCESS && error != ERROR_FILE_NOT_FOUND) {\r
 387     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
 388     return 2;\r
 389   }\r
 390 \r
 391   unsigned long type = REG_SZ;\r
 392   unsigned long action_len = ACTION_LEN;\r
 393 \r
 394   char code[64];\r
 395   if (! ret) code[0] = '\0';\r
 396   else if (_snprintf_s(code, sizeof(code), _TRUNCATE, "%lu", *ret) < 0) {\r
 397     RegCloseKey(key);\r
 398     return get_exit_action(service_name, 0, action, default_action);\r
 399   }\r
 400   if (RegQueryValueEx(key, code, 0, &type, action, &action_len) != ERROR_SUCCESS) {\r
 401     RegCloseKey(key);\r
 402     /* Try again with * as the key if an exit code was defined */\r
 403     if (ret) return get_exit_action(service_name, 0, action, default_action);\r
 404     return 0;\r
 405   }\r
 406 \r
 407   /* Close registry */\r
 408   RegCloseKey(key);\r
 409 \r
 410   return 0;\r
 411 }\r