registry.cpp

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