X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=registry.cpp;h=59d17d45fd66541097c161aef31e3aa30e7a8424;hb=fce252d07bdf443e3b283c26a940d3b0f26fd440;hp=ed013035c155f7ab2fd4c7c50717bb7b6617b1f0;hpb=b465216f3ec97443952f64ba5d068354c1296d3c;p=nssm.git diff --git a/registry.cpp b/registry.cpp index ed01303..59d17d4 100644 --- a/registry.cpp +++ b/registry.cpp @@ -4,13 +4,13 @@ int create_messages() { HKEY key; char registry[KEY_LENGTH]; - if (_snprintf(registry, sizeof(registry), "SYSTEM\\CurrentControlSet\\Services\\EventLog\\Application\\%s", NSSM) < 0) { + if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, "SYSTEM\\CurrentControlSet\\Services\\EventLog\\Application\\%s", NSSM) < 0) { log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "eventlog registry", "create_messages()", 0); return 1; } if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, 0) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, GetLastError(), 0); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0); return 2; } @@ -19,17 +19,17 @@ int create_messages() { GetModuleFileName(0, path, MAX_PATH); /* Try to register the module but don't worry so much on failure */ - RegSetValueEx(key, "EventMessageFile", 0, REG_SZ, (const unsigned char *) path, strlen(path) + 1); + RegSetValueEx(key, "EventMessageFile", 0, REG_SZ, (const unsigned char *) path, (unsigned long) strlen(path) + 1); unsigned long types = EVENTLOG_INFORMATION_TYPE | EVENTLOG_WARNING_TYPE | EVENTLOG_ERROR_TYPE; RegSetValueEx(key, "TypesSupported", 0, REG_DWORD, /*XXX*/(PBYTE) &types, sizeof(types)); return 0; } -int create_parameters(char *service_name, char *exe, char *flags, char *dir) { +int create_parameters(nssm_service_t *service) { /* Get registry */ char registry[KEY_LENGTH]; - if (_snprintf(registry, sizeof(registry), NSSM_REGISTRY, service_name) < 0) { + if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY, service->name) < 0) { log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REGISTRY", "create_parameters()", 0); return 1; } @@ -37,25 +37,25 @@ int create_parameters(char *service_name, char *exe, char *flags, char *dir) { /* Try to open the registry */ HKEY key; if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, 0) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, GetLastError(), 0); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0); return 2; } /* Try to create the parameters */ - if (RegSetValueEx(key, NSSM_REG_EXE, 0, REG_SZ, (const unsigned char *) exe, strlen(exe) + 1) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_EXE, GetLastError(), 0); + if (RegSetValueEx(key, NSSM_REG_EXE, 0, REG_EXPAND_SZ, (const unsigned char *) service->exe, (unsigned long) strlen(service->exe) + 1) != ERROR_SUCCESS) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_EXE, error_string(GetLastError()), 0); RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY); RegCloseKey(key); return 3; } - if (RegSetValueEx(key, NSSM_REG_FLAGS, 0, REG_SZ, (const unsigned char *) flags, strlen(flags) + 1) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_FLAGS, GetLastError(), 0); + if (RegSetValueEx(key, NSSM_REG_FLAGS, 0, REG_EXPAND_SZ, (const unsigned char *) service->flags, (unsigned long) strlen(service->flags) + 1) != ERROR_SUCCESS) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_FLAGS, error_string(GetLastError()), 0); RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY); RegCloseKey(key); return 4; } - if (RegSetValueEx(key, NSSM_REG_DIR, 0, REG_SZ, (const unsigned char *) dir, strlen(dir) + 1) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_DIR, GetLastError(), 0); + if (RegSetValueEx(key, NSSM_REG_DIR, 0, REG_EXPAND_SZ, (const unsigned char *) service->dir, (unsigned long) strlen(service->dir) + 1) != ERROR_SUCCESS) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_DIR, error_string(GetLastError()), 0); RegDeleteKey(HKEY_LOCAL_MACHINE, NSSM_REGISTRY); RegCloseKey(key); return 5; @@ -70,7 +70,7 @@ int create_parameters(char *service_name, char *exe, char *flags, char *dir) { int create_exit_action(char *service_name, const char *action_string) { /* Get registry */ char registry[KEY_LENGTH]; - if (_snprintf(registry, sizeof(registry), NSSM_REGISTRY "\\%s", service_name, NSSM_REG_EXIT) < 0) { + if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY "\\%s", service_name, NSSM_REG_EXIT) < 0) { log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REG_EXIT", "create_exit_action()", 0); return 1; } @@ -79,7 +79,7 @@ int create_exit_action(char *service_name, const char *action_string) { HKEY key; unsigned long disposition; if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, &disposition) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, GetLastError(), 0); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0); return 2; } @@ -90,8 +90,8 @@ int create_exit_action(char *service_name, const char *action_string) { } /* Create the default value */ - if (RegSetValueEx(key, 0, 0, REG_SZ, (const unsigned char *) action_string, strlen(action_string) + 1) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_EXIT, GetLastError(), 0); + if (RegSetValueEx(key, 0, 0, REG_SZ, (const unsigned char *) action_string, (unsigned long) strlen(action_string) + 1) != ERROR_SUCCESS) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_EXIT, error_string(GetLastError()), 0); RegCloseKey(key); return 3; } @@ -102,10 +102,174 @@ int create_exit_action(char *service_name, const char *action_string) { return 0; } -int get_parameters(char *service_name, char *exe, int exelen, char *flags, int flagslen, char *dir, int dirlen) { +int set_environment(char *service_name, HKEY key, char **env) { + unsigned long type = REG_MULTI_SZ; + unsigned long envlen = 0; + + /* Dummy test to find buffer size */ + unsigned long ret = RegQueryValueEx(key, NSSM_REG_ENV, 0, &type, NULL, &envlen); + if (ret != ERROR_SUCCESS) { + /* The service probably doesn't have any environment configured */ + if (ret == ERROR_FILE_NOT_FOUND) return 0; + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_ENV, error_string(GetLastError()), 0); + return 1; + } + + if (type != REG_MULTI_SZ) { + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_INVALID_ENVIRONMENT_STRING_TYPE, NSSM_REG_ENV, service_name, 0); + return 2; + } + + /* Probably not possible */ + if (! envlen) return 0; + + /* Previously initialised? */ + if (*env) HeapFree(GetProcessHeap(), 0, *env); + + *env = (char *) HeapAlloc(GetProcessHeap(), 0, envlen); + if (! *env) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "environment registry", "set_environment()", 0); + return 3; + } + + /* Actually get the strings */ + ret = RegQueryValueEx(key, NSSM_REG_ENV, 0, &type, (unsigned char *) *env, &envlen); + if (ret != ERROR_SUCCESS) { + HeapFree(GetProcessHeap(), 0, *env); + *env = 0; + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_ENV, error_string(GetLastError()), 0); + return 4; + } + + return 0; +} + +int expand_parameter(HKEY key, char *value, char *data, unsigned long datalen, bool sanitise, bool must_exist) { + unsigned char *buffer = (unsigned char *) HeapAlloc(GetProcessHeap(), 0, datalen); + if (! buffer) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, value, "expand_parameter()", 0); + return 1; + } + + ZeroMemory(data, datalen); + + unsigned long type = REG_EXPAND_SZ; + unsigned long buflen = datalen; + + unsigned long ret = RegQueryValueEx(key, value, 0, &type, buffer, &buflen); + if (ret != ERROR_SUCCESS) { + unsigned long error = GetLastError(); + HeapFree(GetProcessHeap(), 0, buffer); + + if (ret == ERROR_FILE_NOT_FOUND) { + if (! must_exist) return 0; + } + + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(error), 0); + return 2; + } + + /* Paths aren't allowed to contain quotes. */ + if (sanitise) PathUnquoteSpaces((LPSTR) buffer); + + /* Technically we shouldn't expand environment strings from REG_SZ values */ + if (type != REG_EXPAND_SZ) { + memmove(data, buffer, buflen); + HeapFree(GetProcessHeap(), 0, buffer); + return 0; + } + + ret = ExpandEnvironmentStrings((char *) buffer, data, datalen); + if (! ret || ret > datalen) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_EXPANDENVIRONMENTSTRINGS_FAILED, buffer, error_string(GetLastError()), 0); + HeapFree(GetProcessHeap(), 0, buffer); + return 3; + } + + HeapFree(GetProcessHeap(), 0, buffer); + return 0; +} + +int expand_parameter(HKEY key, char *value, char *data, unsigned long datalen, bool sanitise) { + return expand_parameter(key, value, data, datalen, sanitise, true); +} + +/* + Sets a string in the registry. + Returns: 0 if it was set. + 1 on error. +*/ +int set_expand_string(HKEY key, char *value, char *string) { + if (RegSetValueEx(key, value, 0, REG_EXPAND_SZ, (const unsigned char *) string, (unsigned long) strlen(string) + 1) == ERROR_SUCCESS) return 0; + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0); + return 1; +} + +/* + Set an unsigned long in the registry. + Returns: 0 if it was set. + 1 on error. +*/ +int set_number(HKEY key, char *value, unsigned long number) { + if (RegSetValueEx(key, value, 0, REG_DWORD, (const unsigned char *) &number, sizeof(number)) == ERROR_SUCCESS) return 0; + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0); + return 1; +} + +/* + Query an unsigned long from the registry. + Returns: 1 if a number was retrieved. + 0 if none was found and must_exist is false. + -1 if none was found and must_exist is true. + -2 otherwise. +*/ +int get_number(HKEY key, char *value, unsigned long *number, bool must_exist) { + unsigned long type = REG_DWORD; + unsigned long number_len = sizeof(unsigned long); + + int ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) number, &number_len); + if (ret == ERROR_SUCCESS) return 1; + + if (ret == ERROR_FILE_NOT_FOUND) { + if (! must_exist) return 0; + } + + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0); + if (ret == ERROR_FILE_NOT_FOUND) return -1; + + return -2; +} + +int get_number(HKEY key, char *value, unsigned long *number) { + return get_number(key, value, number, true); +} + +void override_milliseconds(char *service_name, HKEY key, char *value, unsigned long *buffer, unsigned long default_value, unsigned long event) { + unsigned long type = REG_DWORD; + unsigned long buflen = sizeof(unsigned long); + bool ok = false; + unsigned long ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) buffer, &buflen); + if (ret != ERROR_SUCCESS) { + if (ret != ERROR_FILE_NOT_FOUND) { + if (type != REG_DWORD) { + char milliseconds[16]; + _snprintf_s(milliseconds, sizeof(milliseconds), _TRUNCATE, "%lu", default_value); + log_event(EVENTLOG_WARNING_TYPE, event, service_name, value, milliseconds, 0); + } + else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0); + } + } + else ok = true; + + if (! ok) *buffer = default_value; +} + +int get_parameters(nssm_service_t *service, STARTUPINFO *si) { + unsigned long ret; + /* Get registry */ char registry[KEY_LENGTH]; - if (_snprintf(registry, sizeof(registry), NSSM_REGISTRY, service_name) < 0) { + if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY, service->name) < 0) { log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REGISTRY", "get_parameters()", 0); return 1; } @@ -113,33 +277,81 @@ int get_parameters(char *service_name, char *exe, int exelen, char *flags, int f /* Try to open the registry */ HKEY key; if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, GetLastError(), 0); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0); return 2; } - unsigned long type = REG_SZ; - /* Try to get executable file - MUST succeed */ - if (RegQueryValueEx(key, NSSM_REG_EXE, 0, &type, (unsigned char *) exe, (unsigned long *) &exelen) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_EXE, GetLastError(), 0); + if (expand_parameter(key, NSSM_REG_EXE, service->exe, sizeof(service->exe), false)) { RegCloseKey(key); return 3; } - /* Try to get flags - may fail */ - if (RegQueryValueEx(key, NSSM_REG_FLAGS, 0, &type, (unsigned char *) flags, (unsigned long *) &flagslen) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_FLAGS, GetLastError(), 0); - RegCloseKey(key); - return 4; + /* Try to get flags - may fail and we don't care */ + if (expand_parameter(key, NSSM_REG_FLAGS, service->flags, sizeof(service->flags), false)) { + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_FLAGS, NSSM_REG_FLAGS, service->name, service->exe, 0); + ZeroMemory(service->flags, sizeof(service->flags)); + } + + /* Try to get startup directory - may fail and we fall back to a default */ + if (expand_parameter(key, NSSM_REG_DIR, service->dir, sizeof(service->dir), true) || ! service->dir[0]) { + /* Our buffers are defined to be long enough for this to be safe */ + size_t i; + for (i = strlen(service->exe); i && service->exe[i] != '\\' && service->exe[i] != '/'; i--); + if (i) { + memmove(service->dir, service->exe, i); + service->dir[i] = '\0'; + } + else { + /* Help! */ + ret = GetWindowsDirectory(service->dir, sizeof(service->dir)); + if (! ret || ret > sizeof(service->dir)) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_NO_DIR_AND_NO_FALLBACK, NSSM_REG_DIR, service->name, 0); + RegCloseKey(key); + return 4; + } + } + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_DIR, NSSM_REG_DIR, service->name, service->dir, 0); } - /* Try to get startup directory - may fail */ - if (RegQueryValueEx(key, NSSM_REG_DIR, 0, &type, (unsigned char *) dir, (unsigned long *) &dirlen) != ERROR_SUCCESS) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_DIR, GetLastError(), 0); + /* Try to get environment variables - may fail */ + set_environment(service->name, key, &service->env); + + /* Try to get stdout and stderr */ + if (get_output_handles(key, si)) { + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_OUTPUT_HANDLES_FAILED, service->name, 0); RegCloseKey(key); return 5; } + /* Try to get throttle restart delay */ + override_milliseconds(service->name, key, NSSM_REG_THROTTLE, &service->throttle_delay, NSSM_RESET_THROTTLE_RESTART, NSSM_EVENT_BOGUS_THROTTLE); + + /* Try to get service stop flags. */ + unsigned long type = REG_DWORD; + unsigned long stop_method_skip; + unsigned long buflen = sizeof(stop_method_skip); + bool stop_ok = false; + ret = RegQueryValueEx(key, NSSM_REG_STOP_METHOD_SKIP, 0, &type, (unsigned char *) &stop_method_skip, &buflen); + if (ret != ERROR_SUCCESS) { + if (ret != ERROR_FILE_NOT_FOUND) { + if (type != REG_DWORD) { + log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_STOP_METHOD_SKIP, service->name, NSSM_REG_STOP_METHOD_SKIP, NSSM, 0); + } + else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_STOP_METHOD_SKIP, error_string(GetLastError()), 0); + } + } + else stop_ok = true; + + /* Try all methods except those requested to be skipped. */ + service->stop_method = ~0; + if (stop_ok) service->stop_method &= ~stop_method_skip; + + /* Try to get kill delays - may fail. */ + 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); + 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); + 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); + /* Close registry */ RegCloseKey(key); @@ -152,7 +364,7 @@ int get_exit_action(char *service_name, unsigned long *ret, unsigned char *actio /* Get registry */ char registry[KEY_LENGTH]; - if (_snprintf(registry, sizeof(registry), NSSM_REGISTRY "\\%s", service_name, NSSM_REG_EXIT) < 0) { + if (_snprintf_s(registry, sizeof(registry), _TRUNCATE, NSSM_REGISTRY "\\%s", service_name, NSSM_REG_EXIT) < 0) { log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, "NSSM_REG_EXIT", "get_exit_action()", 0); return 1; } @@ -161,7 +373,7 @@ int get_exit_action(char *service_name, unsigned long *ret, unsigned char *actio HKEY key; long error = RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, KEY_READ, &key); if (error != ERROR_SUCCESS && error != ERROR_FILE_NOT_FOUND) { - log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, GetLastError(), 0); + log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0); return 2; } @@ -170,7 +382,7 @@ int get_exit_action(char *service_name, unsigned long *ret, unsigned char *actio char code[64]; if (! ret) code[0] = '\0'; - else if (_snprintf(code, sizeof(code), "%lu", *ret) < 0) { + else if (_snprintf_s(code, sizeof(code), _TRUNCATE, "%lu", *ret) < 0) { RegCloseKey(key); return get_exit_action(service_name, 0, action, default_action); }