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(registry, sizeof(registry), "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, 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(registry, sizeof(registry), 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, 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, 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, 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(registry, sizeof(registry), 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, 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) {\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   unsigned long type = REG_EXPAND_SZ;\r
 152   unsigned long buflen = datalen;\r
 153 \r
 154   unsigned long ret = RegQueryValueEx(key, value, 0, &type, buffer, &buflen);\r
 155   if (ret != ERROR_SUCCESS) {\r
 156     if (ret != ERROR_FILE_NOT_FOUND) log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 157     HeapFree(GetProcessHeap(), 0, buffer);\r
 158     return 2;\r
 159   }\r
 160 \r
 161   /* Paths aren't allowed to contain quotes. */\r
 162   if (sanitise) PathUnquoteSpaces((LPSTR) buffer);\r
 163 \r
 164   ZeroMemory(data, datalen);\r
 165 \r
 166   /* Technically we shouldn't expand environment strings from REG_SZ values */\r
 167   if (type != REG_EXPAND_SZ) {\r
 168     memmove(data, buffer, buflen);\r
 169     HeapFree(GetProcessHeap(), 0, buffer);\r
 170     return 0;\r
 171   }\r
 172 \r
 173   ret = ExpandEnvironmentStrings((char *) buffer, data, datalen);\r
 174   if (! ret || ret > datalen) {\r
 175     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_EXPANDENVIRONMENTSTRINGS_FAILED, buffer, error_string(GetLastError()), 0);\r
 176     HeapFree(GetProcessHeap(), 0, buffer);\r
 177     return 3;\r
 178   }\r
 179 \r
 180   HeapFree(GetProcessHeap(), 0, buffer);\r
 181   return 0;\r
 182 }\r
 183 \r
 184 /*\r
 185   Query an unsigned long from the registry.\r
 186   Returns:  1 if a number was retrieved.\r
 187             0 if none was found and must_exist is false.\r
 188            -1 if none was found and must_exist is true.\r
 189            -2 otherwise.\r
 190 */\r
 191 int get_number(HKEY key, char *value, unsigned long *number, bool must_exist) {\r
 192   unsigned long type = REG_DWORD;\r
 193   unsigned long number_len = sizeof(unsigned long);\r
 194 \r
 195   int ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) number, &number_len);\r
 196   if (ret == ERROR_SUCCESS) return 1;\r
 197 \r
 198   if (ret == ERROR_FILE_NOT_FOUND) {\r
 199     if (! must_exist) return 0;\r
 200   }\r
 201 \r
 202   log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);\r
 203   if (ret == ERROR_FILE_NOT_FOUND) return -1;\r
 204 \r
 205   return -2;\r
 206 }\r
 207 \r
 208 int get_number(HKEY key, char *value, unsigned long *number) {\r
 209   return get_number(key, value, number, true);\r
 210 }\r
 211 \r
 212 int get_parameters(char *service_name, char *exe, int exelen, char *flags, int flagslen, char *dir, int dirlen, char **env, unsigned long *throttle_delay) {\r
 213   unsigned long ret;\r
 214 \r
 215   /* Get registry */\r
 216   char registry[KEY_LENGTH];\r
 217   if (_snprintf(registry, sizeof(registry), NSSM_REGISTRY, service_name) < 0) {\r
 218     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REGISTRY", "get_parameters()", 0);\r
 219     return 1;\r
 220   }\r
 221 \r
 222   /* Try to open the registry */\r
 223   HKEY key;\r
 224   if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key) != ERROR_SUCCESS) {\r
 225     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
 226     return 2;\r
 227   }\r
 228 \r
 229   /* Try to get executable file - MUST succeed */\r
 230   if (expand_parameter(key, NSSM_REG_EXE, exe, exelen, false)) {\r
 231     RegCloseKey(key);\r
 232     return 3;\r
 233   }\r
 234 \r
 235   /* Try to get flags - may fail and we don't care */\r
 236   if (expand_parameter(key, NSSM_REG_FLAGS, flags, flagslen, false)) {\r
 237     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_FLAGS, NSSM_REG_FLAGS, service_name, exe, 0);\r
 238     ZeroMemory(flags, flagslen);\r
 239   }\r
 240 \r
 241   /* Try to get startup directory - may fail and we fall back to a default */\r
 242   if (expand_parameter(key, NSSM_REG_DIR, dir, dirlen, true) || ! dir[0]) {\r
 243     /* Our buffers are defined to be long enough for this to be safe */\r
 244     size_t i;\r
 245     for (i = strlen(exe); i && exe[i] != '\\' && exe[i] != '/'; i--);\r
 246     if (i) {\r
 247       memmove(dir, exe, i);\r
 248       dir[i] = '\0';\r
 249     }\r
 250     else {\r
 251       /* Help! */\r
 252       ret = GetWindowsDirectory(dir, dirlen);\r
 253       if (! ret || ret > dirlen) {\r
 254         log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_NO_DIR_AND_NO_FALLBACK, NSSM_REG_DIR, service_name, 0);\r
 255         RegCloseKey(key);\r
 256         return 4;\r
 257       }\r
 258     }\r
 259     log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_DIR, NSSM_REG_DIR, service_name, dir, 0);\r
 260   }\r
 261 \r
 262   /* Try to get environment variables - may fail */\r
 263   set_environment(service_name, key, env);\r
 264 \r
 265   /* Try to get throttle restart delay */\r
 266   unsigned long type = REG_DWORD;\r
 267   unsigned long buflen = sizeof(*throttle_delay);\r
 268   bool throttle_ok = false;\r
 269   ret = RegQueryValueEx(key, NSSM_REG_THROTTLE, 0, &type, (unsigned char *) throttle_delay, &buflen);\r
 270   if (ret != ERROR_SUCCESS) {\r
 271     if (ret != ERROR_FILE_NOT_FOUND) {\r
 272       if (type != REG_DWORD) {\r
 273         char milliseconds[16];\r
 274         _snprintf(milliseconds, sizeof(milliseconds), "%lu", NSSM_RESET_THROTTLE_RESTART);\r
 275         log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_THROTTLE, service_name, NSSM_REG_THROTTLE, milliseconds, 0);\r
 276       }\r
 277       else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_THROTTLE, error_string(GetLastError()), 0);\r
 278     }\r
 279   }\r
 280   else throttle_ok = true;\r
 281 \r
 282   if (! throttle_ok) *throttle_delay = NSSM_RESET_THROTTLE_RESTART;\r
 283 \r
 284   /* Close registry */\r
 285   RegCloseKey(key);\r
 286 \r
 287   return 0;\r
 288 }\r
 289 \r
 290 int get_exit_action(char *service_name, unsigned long *ret, unsigned char *action, bool *default_action) {\r
 291   /* Are we returning the default action or a status-specific one? */\r
 292   *default_action = ! ret;\r
 293 \r
 294   /* Get registry */\r
 295   char registry[KEY_LENGTH];\r
 296   if (_snprintf(registry, sizeof(registry), NSSM_REGISTRY "\\%s", service_name, NSSM_REG_EXIT) < 0) {\r
 297     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REG_EXIT", "get_exit_action()", 0);\r
 298     return 1;\r
 299   }\r
 300 \r
 301   /* Try to open the registry */\r
 302   HKEY key;\r
 303   long error = RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key);\r
 304   if (error != ERROR_SUCCESS && error != ERROR_FILE_NOT_FOUND) {\r
 305     log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);\r
 306     return 2;\r
 307   }\r
 308 \r
 309   unsigned long type = REG_SZ;\r
 310   unsigned long action_len = ACTION_LEN;\r
 311 \r
 312   char code[64];\r
 313   if (! ret) code[0] = '\0';\r
 314   else if (_snprintf(code, sizeof(code), "%lu", *ret) < 0) {\r
 315     RegCloseKey(key);\r
 316     return get_exit_action(service_name, 0, action, default_action);\r
 317   }\r
 318   if (RegQueryValueEx(key, code, 0, &type, action, &action_len) != ERROR_SUCCESS) {\r
 319     RegCloseKey(key);\r
 320     /* Try again with * as the key if an exit code was defined */\r
 321     if (ret) return get_exit_action(service_name, 0, action, default_action);\r
 322     return 0;\r
 323   }\r
 324 \r
 325   /* Close registry */\r
 326   RegCloseKey(key);\r
 327 \r
 328   return 0;\r
 329 }\r