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(char *service_name, char *exe, char *flags, char *dir) {\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 *) exe, (unsigned long) strlen(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 *) flags, (unsigned long) strlen(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 *) dir, (unsigned long) strlen(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   *env = (char *) HeapAlloc(GetProcessHeap(), 0, envlen);\r
 127   if (! *env) {\r
 128     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "environment registry", "set_environment()", 0);\r
 129     return 3;\r
 130   }\r
 131 \r
 132   /* Actually get the strings */\r
 133   ret = RegQueryValueEx(key, NSSM_REG_ENV, 0, &type, (unsigned char *) *env, &envlen);\r
 134   if (ret != ERROR_SUCCESS) {\r
 135     HeapFree(GetProcessHeap(), 0, *env);\r
 136     *env = 0;\r
 137     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_ENV, error_string(GetLastError()), 0);\r
 138     return 4;\r
 139   }\r
 140 \r
 141   return 0;\r
 142 }\r
 143 \r
 144 int expand_parameter(HKEY key, char *value, char *data, unsigned long datalen, bool sanitise, bool must_exist) {\r
 145   unsigned char *buffer = (unsigned char *) HeapAlloc(GetProcessHeap(), 0, datalen);\r
 146   if (! buffer) {\r
 147     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, value, "expand_parameter()", 0);\r
 148     return 1;\r
 149   }\r
 150 \r
 151   ZeroMemory(data, datalen);\r
 152 \r
 153   unsigned long type = REG_EXPAND_SZ;\r
 154   unsigned long buflen = datalen;\r
 155 \r
 156   unsigned long ret = RegQueryValueEx(key, value, 0, &type, buffer, &buflen);\r
 157   if (ret != ERROR_SUCCESS) {\r
 158     unsigned long error = GetLastError();\r
 159     HeapFree(GetProcessHeap(), 0, buffer);\r
 160 \r
 161     if (ret == ERROR_FILE_NOT_FOUND) {\r
 162       if (! must_exist) return 0;\r
 163     }\r
 164 \r
 165     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(error), 0);\r
 166     return 2;\r
 167   }\r
 168 \r
 169   /* Paths aren't allowed to contain quotes. */\r
 170   if (sanitise) PathUnquoteSpaces((LPSTR) buffer);\r
 171 \r
 172   /* Technically we shouldn't expand environment strings from REG_SZ values */\r
 173   if (type != REG_EXPAND_SZ) {\r
 174     memmove(data, buffer, buflen);\r
 175     HeapFree(GetProcessHeap(), 0, buffer);\r
 176     return 0;\r
 177   }\r
 178 \r
 179   ret = ExpandEnvironmentStrings((char *) buffer, data, datalen);\r
 180   if (! ret || ret > datalen) {\r
 181     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_EXPANDENVIRONMENTSTRINGS_FAILED, buffer, error_string(GetLastError()), 0);\r
 182     HeapFree(GetProcessHeap(), 0, buffer);\r
 183     return 3;\r
 184   }\r
 185 \r
 186   HeapFree(GetProcessHeap(), 0, buffer);\r
 187   return 0;\r
 188 }\r
 189 \r
 190 int expand_parameter(HKEY key, char *value, char *data, unsigned long datalen, bool sanitise) {\r
 191   return expand_parameter(key, value, data, datalen, sanitise, true);\r
 192 }\r
 193 \r
 194 /*\r
 195   Sets a string in the registry.\r
 196   Returns: 0 if it was set.\r
 197            1 on error.\r
 198 */\r
 199 int set_expand_string(HKEY key, char *value, char *string) {\r
 200   if (RegSetValueEx(key, value, 0, REG_EXPAND_SZ, (const unsigned char *) string, (unsigned long) strlen(string) + 1) == ERROR_SUCCESS) return 0;\r
 201   log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 202   return 1;\r
 203 }\r
 204 \r
 205 /*\r
 206   Set an unsigned long in the registry.\r
 207   Returns: 0 if it was set.\r
 208            1 on error.\r
 209 */\r
 210 int set_number(HKEY key, char *value, unsigned long number) {\r
 211   if (RegSetValueEx(key, value, 0, REG_DWORD, (const unsigned char *) &number, sizeof(number)) == ERROR_SUCCESS) return 0;\r
 212   log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 213   return 1;\r
 214 }\r
 215 \r
 216 /*\r
 217   Query an unsigned long from the registry.\r
 218   Returns:  1 if a number was retrieved.\r
 219             0 if none was found and must_exist is false.\r
 220            -1 if none was found and must_exist is true.\r
 221            -2 otherwise.\r
 222 */\r
 223 int get_number(HKEY key, char *value, unsigned long *number, bool must_exist) {\r
 224   unsigned long type = REG_DWORD;\r
 225   unsigned long number_len = sizeof(unsigned long);\r
 226 \r
 227   int ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) number, &number_len);\r
 228   if (ret == ERROR_SUCCESS) return 1;\r
 229 \r
 230   if (ret == ERROR_FILE_NOT_FOUND) {\r
 231     if (! must_exist) return 0;\r
 232   }\r
 233 \r
 234   log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 235   if (ret == ERROR_FILE_NOT_FOUND) return -1;\r
 236 \r
 237   return -2;\r
 238 }\r
 239 \r
 240 int get_number(HKEY key, char *value, unsigned long *number) {\r
 241   return get_number(key, value, number, true);\r
 242 }\r
 243 \r
 244 void override_milliseconds(char *service_name, HKEY key, char *value, unsigned long *buffer, unsigned long default_value, unsigned long event) {\r
 245   unsigned long type = REG_DWORD;\r
 246   unsigned long buflen = sizeof(unsigned long);\r
 247   bool ok = false;\r
 248   unsigned long ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) buffer, &buflen);\r
 249   if (ret != ERROR_SUCCESS) {\r
 250     if (ret != ERROR_FILE_NOT_FOUND) {\r
 251       if (type != REG_DWORD) {\r
 252         char milliseconds[16];\r
 253         _snprintf_s(milliseconds, sizeof(milliseconds), _TRUNCATE, "%lu", default_value);\r
 254         log_event(EVENTLOG_WARNING_TYPE, event, service_name, value, milliseconds, 0);\r
 255       }\r
 256       else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 257     }\r
 258   }\r
 259   else ok = true;\r
 260 \r
 261   if (! ok) *buffer = default_value;\r
 262 }\r
 263 \r
 264 int get_parameters(char *service_name, char *exe, unsigned long exelen, char *flags, unsigned long flagslen, char *dir, unsigned long dirlen, char **env, unsigned long *throttle_delay, unsigned long *stop_method, unsigned long *kill_console_delay, unsigned long *kill_window_delay, unsigned long *kill_threads_delay, STARTUPINFO *si) {\r
 265   unsigned long ret;\r
 266 \r
 267   /* Get registry */\r
 268   char registry[KEY_LENGTH];\r
 269   if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY, service_name) < 0) {\r
 270     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REGISTRY", "get_parameters()", 0);\r
 271     return 1;\r
 272   }\r
 273 \r
 274   /* Try to open the registry */\r
 275   HKEY key;\r
 276   if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key) != ERROR_SUCCESS) {\r
 277     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
 278     return 2;\r
 279   }\r
 280 \r
 281   /* Try to get executable file - MUST succeed */\r
 282   if (expand_parameter(key, NSSM_REG_EXE, exe, exelen, false)) {\r
 283     RegCloseKey(key);\r
 284     return 3;\r
 285   }\r
 286 \r
 287   /* Try to get flags - may fail and we don't care */\r
 288   if (expand_parameter(key, NSSM_REG_FLAGS, flags, flagslen, false)) {\r
 289     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_FLAGS, NSSM_REG_FLAGS, service_name, exe, 0);\r
 290     ZeroMemory(flags, flagslen);\r
 291   }\r
 292 \r
 293   /* Try to get startup directory - may fail and we fall back to a default */\r
 294   if (expand_parameter(key, NSSM_REG_DIR, dir, dirlen, true) || ! dir[0]) {\r
 295     /* Our buffers are defined to be long enough for this to be safe */\r
 296     size_t i;\r
 297     for (i = strlen(exe); i && exe[i] != '\\' && exe[i] != '/'; i--);\r
 298     if (i) {\r
 299       memmove(dir, exe, i);\r
 300       dir[i] = '\0';\r
 301     }\r
 302     else {\r
 303       /* Help! */\r
 304       ret = GetWindowsDirectory(dir, dirlen);\r
 305       if (! ret || ret > dirlen) {\r
 306         log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_NO_DIR_AND_NO_FALLBACK, NSSM_REG_DIR, service_name, 0);\r
 307         RegCloseKey(key);\r
 308         return 4;\r
 309       }\r
 310     }\r
 311     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_DIR, NSSM_REG_DIR, service_name, dir, 0);\r
 312   }\r
 313 \r
 314   /* Try to get environment variables - may fail */\r
 315   set_environment(service_name, key, env);\r
 316 \r
 317   /* Try to get stdout and stderr */\r
 318   if (get_output_handles(key, si)) {\r
 319     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_OUTPUT_HANDLES_FAILED, service_name, 0);\r
 320     RegCloseKey(key);\r
 321     return 5;\r
 322   }\r
 323 \r
 324   /* Try to get throttle restart delay */\r
 325   override_milliseconds(service_name, key, NSSM_REG_THROTTLE, throttle_delay, NSSM_RESET_THROTTLE_RESTART, NSSM_EVENT_BOGUS_THROTTLE);\r
 326 \r
 327   /* Try to get service stop flags. */\r
 328   unsigned long type = REG_DWORD;\r
 329   unsigned long stop_method_skip;\r
 330   unsigned long buflen = sizeof(stop_method_skip);\r
 331   bool stop_ok = false;\r
 332   ret = RegQueryValueEx(key, NSSM_REG_STOP_METHOD_SKIP, 0, &type, (unsigned char *) &stop_method_skip, &buflen);\r
 333   if (ret != ERROR_SUCCESS) {\r
 334     if (ret != ERROR_FILE_NOT_FOUND) {\r
 335       if (type != REG_DWORD) {\r
 336         log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_STOP_METHOD_SKIP, service_name, NSSM_REG_STOP_METHOD_SKIP, NSSM, 0);\r
 337       }\r
 338       else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_STOP_METHOD_SKIP, error_string(GetLastError()), 0);\r
 339     }\r
 340   }\r
 341   else stop_ok = true;\r
 342 \r
 343   /* Try all methods except those requested to be skipped. */\r
 344   *stop_method = ~0;\r
 345   if (stop_ok) *stop_method &= ~stop_method_skip;\r
 346 \r
 347   /* Try to get kill delays - may fail. */\r
 348   override_milliseconds(service_name, key, NSSM_REG_KILL_CONSOLE_GRACE_PERIOD, kill_console_delay, NSSM_KILL_CONSOLE_GRACE_PERIOD, NSSM_EVENT_BOGUS_KILL_CONSOLE_GRACE_PERIOD);\r
 349   override_milliseconds(service_name, key, NSSM_REG_KILL_WINDOW_GRACE_PERIOD, kill_window_delay, NSSM_KILL_WINDOW_GRACE_PERIOD, NSSM_EVENT_BOGUS_KILL_WINDOW_GRACE_PERIOD);\r
 350   override_milliseconds(service_name, key, NSSM_REG_KILL_THREADS_GRACE_PERIOD, kill_threads_delay, NSSM_KILL_THREADS_GRACE_PERIOD, NSSM_EVENT_BOGUS_KILL_THREADS_GRACE_PERIOD);\r
 351 \r
 352   /* Close registry */\r
 353   RegCloseKey(key);\r
 354 \r
 355   return 0;\r
 356 }\r
 357 \r
 358 int get_exit_action(char *service_name, unsigned long *ret, unsigned char *action, bool *default_action) {\r
 359   /* Are we returning the default action or a status-specific one? */\r
 360   *default_action = ! ret;\r
 361 \r
 362   /* Get registry */\r
 363   char registry[KEY_LENGTH];\r
 364   if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY "\\%s", service_name, NSSM_REG_EXIT) < 0) {\r
 365     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REG_EXIT", "get_exit_action()", 0);\r
 366     return 1;\r
 367   }\r
 368 \r
 369   /* Try to open the registry */\r
 370   HKEY key;\r
 371   long error = RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key);\r
 372   if (error != ERROR_SUCCESS && error != ERROR_FILE_NOT_FOUND) {\r
 373     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
 374     return 2;\r
 375   }\r
 376 \r
 377   unsigned long type = REG_SZ;\r
 378   unsigned long action_len = ACTION_LEN;\r
 379 \r
 380   char code[64];\r
 381   if (! ret) code[0] = '\0';\r
 382   else if (_snprintf_s(code, sizeof(code), _TRUNCATE, "%lu", *ret) < 0) {\r
 383     RegCloseKey(key);\r
 384     return get_exit_action(service_name, 0, action, default_action);\r
 385   }\r
 386   if (RegQueryValueEx(key, code, 0, &type, action, &action_len) != ERROR_SUCCESS) {\r
 387     RegCloseKey(key);\r
 388     /* Try again with * as the key if an exit code was defined */\r
 389     if (ret) return get_exit_action(service_name, 0, action, default_action);\r
 390     return 0;\r
 391   }\r
 392 \r
 393   /* Close registry */\r
 394   RegCloseKey(key);\r
 395 \r
 396   return 0;\r
 397 }\r