registry.cpp 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821
  1. #include "nssm.h"
  2. extern const TCHAR *exit_action_strings[];
  3. static int service_registry_path(const TCHAR *service_name, bool parameters, const TCHAR *sub, TCHAR *buffer, unsigned long buflen) {
  4. int ret;
  5. if (parameters) {
  6. if (sub) ret = _sntprintf_s(buffer, buflen, _TRUNCATE, NSSM_REGISTRY _T("\\") NSSM_REG_PARAMETERS _T("\\%s"), service_name, sub);
  7. else ret = _sntprintf_s(buffer, buflen, _TRUNCATE, NSSM_REGISTRY _T("\\") NSSM_REG_PARAMETERS, service_name);
  8. }
  9. else ret = _sntprintf_s(buffer, buflen, _TRUNCATE, NSSM_REGISTRY, service_name);
  10. return ret;
  11. }
  12. static HKEY open_registry_key(const TCHAR *registry, REGSAM sam, bool must_exist) {
  13. HKEY key;
  14. if (sam & KEY_SET_VALUE) {
  15. if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, sam, 0, &key, 0) != ERROR_SUCCESS) {
  16. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);
  17. return 0;
  18. }
  19. }
  20. else {
  21. long error = RegOpenKeyEx(HKEY_LOCAL_MACHINE, registry, 0, sam, &key);
  22. if (error != ERROR_SUCCESS) {
  23. if (error == ERROR_FILE_NOT_FOUND && ! must_exist) return 0;
  24. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);
  25. return 0;
  26. }
  27. }
  28. return key;
  29. }
  30. int create_messages() {
  31. HKEY key;
  32. TCHAR registry[KEY_LENGTH];
  33. if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, _T("SYSTEM\\CurrentControlSet\\Services\\EventLog\\Application\\%s"), NSSM) < 0) {
  34. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("eventlog registry"), _T("create_messages()"), 0);
  35. return 1;
  36. }
  37. if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, 0) != ERROR_SUCCESS) {
  38. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);
  39. return 2;
  40. }
  41. /* Get path of this program */
  42. const TCHAR *path = nssm_unquoted_imagepath();
  43. /* Try to register the module but don't worry so much on failure */
  44. RegSetValueEx(key, _T("EventMessageFile"), 0, REG_SZ, (const unsigned char *) path, (unsigned long) (_tcslen(path) + 1) * sizeof(TCHAR));
  45. unsigned long types = EVENTLOG_INFORMATION_TYPE | EVENTLOG_WARNING_TYPE | EVENTLOG_ERROR_TYPE;
  46. RegSetValueEx(key, _T("TypesSupported"), 0, REG_DWORD, (const unsigned char *) &types, sizeof(types));
  47. return 0;
  48. }
  49. int create_parameters(nssm_service_t *service, bool editing) {
  50. /* Try to open the registry */
  51. HKEY key = open_registry(service->name, KEY_WRITE);
  52. if (! key) return 1;
  53. /* Remember parameters in case we need to delete them. */
  54. TCHAR registry[KEY_LENGTH];
  55. int ret = service_registry_path(service->name, true, 0, registry, _countof(registry));
  56. /* Try to create the parameters */
  57. if (set_expand_string(key, NSSM_REG_EXE, service->exe)) {
  58. if (ret > 0) RegDeleteKey(HKEY_LOCAL_MACHINE, registry);
  59. RegCloseKey(key);
  60. return 2;
  61. }
  62. if (set_expand_string(key, NSSM_REG_FLAGS, service->flags)) {
  63. if (ret > 0) RegDeleteKey(HKEY_LOCAL_MACHINE, registry);
  64. RegCloseKey(key);
  65. return 3;
  66. }
  67. if (set_expand_string(key, NSSM_REG_DIR, service->dir)) {
  68. if (ret > 0) RegDeleteKey(HKEY_LOCAL_MACHINE, registry);
  69. RegCloseKey(key);
  70. return 4;
  71. }
  72. /* Other non-default parameters. May fail. */
  73. if (service->priority != NORMAL_PRIORITY_CLASS) set_number(key, NSSM_REG_PRIORITY, service->priority);
  74. else if (editing) RegDeleteValue(key, NSSM_REG_PRIORITY);
  75. if (service->affinity) {
  76. TCHAR *string;
  77. if (! affinity_mask_to_string(service->affinity, &string)) {
  78. if (RegSetValueEx(key, NSSM_REG_AFFINITY, 0, REG_SZ, (const unsigned char *) string, (unsigned long) (_tcslen(string) + 1) * sizeof(TCHAR)) != ERROR_SUCCESS) {
  79. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_AFFINITY, error_string(GetLastError()), 0);
  80. HeapFree(GetProcessHeap(), 0, string);
  81. return 5;
  82. }
  83. }
  84. if (string) HeapFree(GetProcessHeap(), 0, string);
  85. }
  86. else if (editing) RegDeleteValue(key, NSSM_REG_AFFINITY);
  87. unsigned long stop_method_skip = ~service->stop_method;
  88. if (stop_method_skip) set_number(key, NSSM_REG_STOP_METHOD_SKIP, stop_method_skip);
  89. else if (editing) RegDeleteValue(key, NSSM_REG_STOP_METHOD_SKIP);
  90. if (service->default_exit_action < NSSM_NUM_EXIT_ACTIONS) create_exit_action(service->name, exit_action_strings[service->default_exit_action], editing);
  91. if (service->restart_delay) set_number(key, NSSM_REG_RESTART_DELAY, service->restart_delay);
  92. else if (editing) RegDeleteValue(key, NSSM_REG_RESTART_DELAY);
  93. if (service->throttle_delay != NSSM_RESET_THROTTLE_RESTART) set_number(key, NSSM_REG_THROTTLE, service->throttle_delay);
  94. else if (editing) RegDeleteValue(key, NSSM_REG_THROTTLE);
  95. if (service->kill_console_delay != NSSM_KILL_CONSOLE_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_CONSOLE_GRACE_PERIOD, service->kill_console_delay);
  96. else if (editing) RegDeleteValue(key, NSSM_REG_KILL_CONSOLE_GRACE_PERIOD);
  97. if (service->kill_window_delay != NSSM_KILL_WINDOW_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_WINDOW_GRACE_PERIOD, service->kill_window_delay);
  98. else if (editing) RegDeleteValue(key, NSSM_REG_KILL_WINDOW_GRACE_PERIOD);
  99. if (service->kill_threads_delay != NSSM_KILL_THREADS_GRACE_PERIOD) set_number(key, NSSM_REG_KILL_THREADS_GRACE_PERIOD, service->kill_threads_delay);
  100. else if (editing) RegDeleteValue(key, NSSM_REG_KILL_THREADS_GRACE_PERIOD);
  101. if (! service->kill_process_tree) set_number(key, NSSM_REG_KILL_PROCESS_TREE, 0);
  102. else if (editing) RegDeleteValue(key, NSSM_REG_KILL_PROCESS_TREE);
  103. if (service->stdin_path[0] || editing) {
  104. if (service->stdin_path[0]) set_expand_string(key, NSSM_REG_STDIN, service->stdin_path);
  105. else if (editing) RegDeleteValue(key, NSSM_REG_STDIN);
  106. if (service->stdin_sharing != NSSM_STDIN_SHARING) set_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_SHARING, service->stdin_sharing);
  107. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_SHARING);
  108. if (service->stdin_disposition != NSSM_STDIN_DISPOSITION) set_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_DISPOSITION, service->stdin_disposition);
  109. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_DISPOSITION);
  110. if (service->stdin_flags != NSSM_STDIN_FLAGS) set_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_FLAGS, service->stdin_flags);
  111. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDIN, NSSM_REG_STDIO_FLAGS);
  112. }
  113. if (service->stdout_path[0] || editing) {
  114. if (service->stdout_path[0]) set_expand_string(key, NSSM_REG_STDOUT, service->stdout_path);
  115. else if (editing) RegDeleteValue(key, NSSM_REG_STDOUT);
  116. if (service->stdout_sharing != NSSM_STDOUT_SHARING) set_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_SHARING, service->stdout_sharing);
  117. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_SHARING);
  118. if (service->stdout_disposition != NSSM_STDOUT_DISPOSITION) set_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_DISPOSITION, service->stdout_disposition);
  119. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_DISPOSITION);
  120. if (service->stdout_flags != NSSM_STDOUT_FLAGS) set_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_FLAGS, service->stdout_flags);
  121. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_FLAGS);
  122. if (service->stdout_copy_and_truncate) set_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_COPY_AND_TRUNCATE, 1);
  123. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDOUT, NSSM_REG_STDIO_COPY_AND_TRUNCATE);
  124. }
  125. if (service->stderr_path[0] || editing) {
  126. if (service->stderr_path[0]) set_expand_string(key, NSSM_REG_STDERR, service->stderr_path);
  127. else if (editing) RegDeleteValue(key, NSSM_REG_STDERR);
  128. if (service->stderr_sharing != NSSM_STDERR_SHARING) set_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_SHARING, service->stderr_sharing);
  129. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_SHARING);
  130. if (service->stderr_disposition != NSSM_STDERR_DISPOSITION) set_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_DISPOSITION, service->stderr_disposition);
  131. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_DISPOSITION);
  132. if (service->stderr_flags != NSSM_STDERR_FLAGS) set_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_FLAGS, service->stderr_flags);
  133. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_FLAGS);
  134. if (service->stderr_copy_and_truncate) set_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_COPY_AND_TRUNCATE, 1);
  135. else if (editing) delete_createfile_parameter(key, NSSM_REG_STDERR, NSSM_REG_STDIO_COPY_AND_TRUNCATE);
  136. }
  137. if (service->rotate_files) set_number(key, NSSM_REG_ROTATE, 1);
  138. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE);
  139. if (service->rotate_stdout_online) set_number(key, NSSM_REG_ROTATE_ONLINE, 1);
  140. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_ONLINE);
  141. if (service->rotate_seconds) set_number(key, NSSM_REG_ROTATE_SECONDS, service->rotate_seconds);
  142. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_SECONDS);
  143. if (service->rotate_bytes_low) set_number(key, NSSM_REG_ROTATE_BYTES_LOW, service->rotate_bytes_low);
  144. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_BYTES_LOW);
  145. if (service->rotate_bytes_high) set_number(key, NSSM_REG_ROTATE_BYTES_HIGH, service->rotate_bytes_high);
  146. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_BYTES_HIGH);
  147. if (service->rotate_delay != NSSM_ROTATE_DELAY) set_number(key, NSSM_REG_ROTATE_DELAY, service->rotate_delay);
  148. else if (editing) RegDeleteValue(key, NSSM_REG_ROTATE_DELAY);
  149. if (service->no_console) set_number(key, NSSM_REG_NO_CONSOLE, 1);
  150. else if (editing) RegDeleteValue(key, NSSM_REG_NO_CONSOLE);
  151. /* Environment */
  152. if (service->env) {
  153. if (RegSetValueEx(key, NSSM_REG_ENV, 0, REG_MULTI_SZ, (const unsigned char *) service->env, (unsigned long) service->envlen * sizeof(TCHAR)) != ERROR_SUCCESS) {
  154. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_ENV, error_string(GetLastError()), 0);
  155. }
  156. }
  157. else if (editing) RegDeleteValue(key, NSSM_REG_ENV);
  158. if (service->env_extra) {
  159. if (RegSetValueEx(key, NSSM_REG_ENV_EXTRA, 0, REG_MULTI_SZ, (const unsigned char *) service->env_extra, (unsigned long) service->env_extralen * sizeof(TCHAR)) != ERROR_SUCCESS) {
  160. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_ENV_EXTRA, error_string(GetLastError()), 0);
  161. }
  162. }
  163. else if (editing) RegDeleteValue(key, NSSM_REG_ENV_EXTRA);
  164. /* Close registry. */
  165. RegCloseKey(key);
  166. return 0;
  167. }
  168. int create_exit_action(TCHAR *service_name, const TCHAR *action_string, bool editing) {
  169. /* Get registry */
  170. TCHAR registry[KEY_LENGTH];
  171. if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, NSSM_REGISTRY _T("\\%s"), service_name, NSSM_REG_EXIT) < 0) {
  172. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("NSSM_REG_EXIT"), _T("create_exit_action()"), 0);
  173. return 1;
  174. }
  175. /* Try to open the registry */
  176. HKEY key;
  177. unsigned long disposition;
  178. if (RegCreateKeyEx(HKEY_LOCAL_MACHINE, registry, 0, 0, REG_OPTION_NON_VOLATILE, KEY_WRITE, 0, &key, &disposition) != ERROR_SUCCESS) {
  179. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OPENKEY_FAILED, registry, error_string(GetLastError()), 0);
  180. return 2;
  181. }
  182. /* Do nothing if the key already existed */
  183. if (disposition == REG_OPENED_EXISTING_KEY && ! editing) {
  184. RegCloseKey(key);
  185. return 0;
  186. }
  187. /* Create the default value */
  188. if (RegSetValueEx(key, 0, 0, REG_SZ, (const unsigned char *) action_string, (unsigned long) (_tcslen(action_string) + 1) * sizeof(TCHAR)) != ERROR_SUCCESS) {
  189. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, NSSM_REG_EXIT, error_string(GetLastError()), 0);
  190. RegCloseKey(key);
  191. return 3;
  192. }
  193. /* Close registry */
  194. RegCloseKey(key);
  195. return 0;
  196. }
  197. int get_environment(TCHAR *service_name, HKEY key, TCHAR *value, TCHAR **env, unsigned long *envlen) {
  198. unsigned long type = REG_MULTI_SZ;
  199. /* Dummy test to find buffer size */
  200. unsigned long ret = RegQueryValueEx(key, value, 0, &type, NULL, envlen);
  201. if (ret != ERROR_SUCCESS) {
  202. *env = 0;
  203. *envlen = 0;
  204. /* The service probably doesn't have any environment configured */
  205. if (ret == ERROR_FILE_NOT_FOUND) return 0;
  206. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);
  207. return 1;
  208. }
  209. if (type != REG_MULTI_SZ) {
  210. *env = 0;
  211. *envlen = 0;
  212. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_INVALID_ENVIRONMENT_STRING_TYPE, value, service_name, 0);
  213. return 2;
  214. }
  215. /* Probably not possible */
  216. if (! *envlen) return 0;
  217. /* Previously initialised? */
  218. if (*env) HeapFree(GetProcessHeap(), 0, *env);
  219. *env = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, *envlen);
  220. if (! *env) {
  221. *envlen = 0;
  222. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, value, _T("get_environment()"), 0);
  223. return 3;
  224. }
  225. /* Actually get the strings */
  226. ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) *env, envlen);
  227. if (ret != ERROR_SUCCESS) {
  228. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);
  229. HeapFree(GetProcessHeap(), 0, *env);
  230. *env = 0;
  231. *envlen = 0;
  232. return 4;
  233. }
  234. return 0;
  235. }
  236. int get_string(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool expand, bool sanitise, bool must_exist) {
  237. TCHAR *buffer = (TCHAR *) HeapAlloc(GetProcessHeap(), 0, datalen);
  238. if (! buffer) {
  239. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, value, _T("get_string()"), 0);
  240. return 1;
  241. }
  242. ZeroMemory(data, datalen);
  243. unsigned long type = REG_EXPAND_SZ;
  244. unsigned long buflen = datalen;
  245. unsigned long ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) buffer, &buflen);
  246. if (ret != ERROR_SUCCESS) {
  247. unsigned long error = GetLastError();
  248. HeapFree(GetProcessHeap(), 0, buffer);
  249. if (ret == ERROR_FILE_NOT_FOUND) {
  250. if (! must_exist) return 0;
  251. }
  252. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(error), 0);
  253. return 2;
  254. }
  255. /* Paths aren't allowed to contain quotes. */
  256. if (sanitise) PathUnquoteSpaces(buffer);
  257. /* Do we want to expand the string? */
  258. if (! expand) {
  259. if (type == REG_EXPAND_SZ) type = REG_SZ;
  260. }
  261. /* Technically we shouldn't expand environment strings from REG_SZ values */
  262. if (type != REG_EXPAND_SZ) {
  263. memmove(data, buffer, buflen);
  264. HeapFree(GetProcessHeap(), 0, buffer);
  265. return 0;
  266. }
  267. ret = ExpandEnvironmentStrings((TCHAR *) buffer, data, datalen);
  268. if (! ret || ret > datalen) {
  269. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_EXPANDENVIRONMENTSTRINGS_FAILED, buffer, error_string(GetLastError()), 0);
  270. HeapFree(GetProcessHeap(), 0, buffer);
  271. return 3;
  272. }
  273. HeapFree(GetProcessHeap(), 0, buffer);
  274. return 0;
  275. }
  276. int get_string(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool sanitise) {
  277. return get_string(key, value, data, datalen, false, sanitise, true);
  278. }
  279. int expand_parameter(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool sanitise, bool must_exist) {
  280. return get_string(key, value, data, datalen, true, sanitise, must_exist);
  281. }
  282. int expand_parameter(HKEY key, TCHAR *value, TCHAR *data, unsigned long datalen, bool sanitise) {
  283. return expand_parameter(key, value, data, datalen, sanitise, true);
  284. }
  285. /*
  286. Sets a string in the registry.
  287. Returns: 0 if it was set.
  288. 1 on error.
  289. */
  290. int set_string(HKEY key, TCHAR *value, TCHAR *string, bool expand) {
  291. unsigned long type = expand ? REG_EXPAND_SZ : REG_SZ;
  292. if (RegSetValueEx(key, value, 0, type, (const unsigned char *) string, (unsigned long) (_tcslen(string) + 1) * sizeof(TCHAR)) == ERROR_SUCCESS) return 0;
  293. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0);
  294. return 1;
  295. }
  296. int set_string(HKEY key, TCHAR *value, TCHAR *string) {
  297. return set_string(key, value, string, false);
  298. return 1;
  299. }
  300. int set_expand_string(HKEY key, TCHAR *value, TCHAR *string) {
  301. return set_string(key, value, string, true);
  302. return 1;
  303. }
  304. /*
  305. Set an unsigned long in the registry.
  306. Returns: 0 if it was set.
  307. 1 on error.
  308. */
  309. int set_number(HKEY key, TCHAR *value, unsigned long number) {
  310. if (RegSetValueEx(key, value, 0, REG_DWORD, (const unsigned char *) &number, sizeof(number)) == ERROR_SUCCESS) return 0;
  311. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_SETVALUE_FAILED, value, error_string(GetLastError()), 0);
  312. return 1;
  313. }
  314. /*
  315. Query an unsigned long from the registry.
  316. Returns: 1 if a number was retrieved.
  317. 0 if none was found and must_exist is false.
  318. -1 if none was found and must_exist is true.
  319. -2 otherwise.
  320. */
  321. int get_number(HKEY key, TCHAR *value, unsigned long *number, bool must_exist) {
  322. unsigned long type = REG_DWORD;
  323. unsigned long number_len = sizeof(unsigned long);
  324. int ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) number, &number_len);
  325. if (ret == ERROR_SUCCESS) return 1;
  326. if (ret == ERROR_FILE_NOT_FOUND) {
  327. if (! must_exist) return 0;
  328. }
  329. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);
  330. if (ret == ERROR_FILE_NOT_FOUND) return -1;
  331. return -2;
  332. }
  333. int get_number(HKEY key, TCHAR *value, unsigned long *number) {
  334. return get_number(key, value, number, true);
  335. }
  336. /* Replace NULL with CRLF. Leave NULL NULL as the end marker. */
  337. int format_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **formatted, unsigned long *newlen) {
  338. unsigned long i, j;
  339. *newlen = dnlen;
  340. if (! *newlen) {
  341. *formatted = 0;
  342. return 0;
  343. }
  344. for (i = 0; i < dnlen; i++) if (! dn[i] && dn[i + 1]) ++*newlen;
  345. *formatted = (TCHAR *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, *newlen * sizeof(TCHAR));
  346. if (! *formatted) {
  347. *newlen = 0;
  348. return 1;
  349. }
  350. for (i = 0, j = 0; i < dnlen; i++) {
  351. (*formatted)[j] = dn[i];
  352. if (! dn[i]) {
  353. if (dn[i + 1]) {
  354. (*formatted)[j] = _T('\r');
  355. (*formatted)[++j] = _T('\n');
  356. }
  357. }
  358. j++;
  359. }
  360. return 0;
  361. }
  362. /* Strip CR and replace LF with NULL. */
  363. int unformat_double_null(TCHAR *dn, unsigned long dnlen, TCHAR **unformatted, unsigned long *newlen) {
  364. unsigned long i, j;
  365. *newlen = 0;
  366. if (! dnlen) {
  367. *unformatted = 0;
  368. return 0;
  369. }
  370. for (i = 0; i < dnlen; i++) if (dn[i] != _T('\r')) ++*newlen;
  371. /* Skip blank lines. */
  372. for (i = 0; i < dnlen; i++) {
  373. if (dn[i] == _T('\r') && dn[i + 1] == _T('\n')) {
  374. /* This is the last CRLF. */
  375. if (i >= dnlen - 2) break;
  376. /*
  377. Strip at the start of the block or if the next characters are
  378. CRLF too.
  379. */
  380. if (! i || (dn[i + 2] == _T('\r') && dn[i + 3] == _T('\n'))) {
  381. for (j = i + 2; j < dnlen; j++) dn[j - 2] = dn[j];
  382. dn[dnlen--] = _T('\0');
  383. dn[dnlen--] = _T('\0');
  384. i--;
  385. --*newlen;
  386. }
  387. }
  388. }
  389. /* Must end with two NULLs. */
  390. *newlen += 2;
  391. *unformatted = (TCHAR *) HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, *newlen * sizeof(TCHAR));
  392. if (! *unformatted) return 1;
  393. for (i = 0, j = 0; i < dnlen; i++) {
  394. if (dn[i] == _T('\r')) continue;
  395. if (dn[i] == _T('\n')) (*unformatted)[j] = _T('\0');
  396. else (*unformatted)[j] = dn[i];
  397. j++;
  398. }
  399. return 0;
  400. }
  401. void override_milliseconds(TCHAR *service_name, HKEY key, TCHAR *value, unsigned long *buffer, unsigned long default_value, unsigned long event) {
  402. unsigned long type = REG_DWORD;
  403. unsigned long buflen = sizeof(unsigned long);
  404. bool ok = false;
  405. unsigned long ret = RegQueryValueEx(key, value, 0, &type, (unsigned char *) buffer, &buflen);
  406. if (ret != ERROR_SUCCESS) {
  407. if (ret != ERROR_FILE_NOT_FOUND) {
  408. if (type != REG_DWORD) {
  409. TCHAR milliseconds[16];
  410. _sntprintf_s(milliseconds, _countof(milliseconds), _TRUNCATE, _T("%lu"), default_value);
  411. log_event(EVENTLOG_WARNING_TYPE, event, service_name, value, milliseconds, 0);
  412. }
  413. else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, value, error_string(GetLastError()), 0);
  414. }
  415. }
  416. else ok = true;
  417. if (! ok) *buffer = default_value;
  418. }
  419. HKEY open_service_registry(const TCHAR *service_name, REGSAM sam, bool must_exist) {
  420. /* Get registry */
  421. TCHAR registry[KEY_LENGTH];
  422. if (service_registry_path(service_name, false, 0, registry, _countof(registry)) < 0) {
  423. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, NSSM_REGISTRY, _T("open_service_registry()"), 0);
  424. return 0;
  425. }
  426. return open_registry_key(registry, sam, must_exist);
  427. }
  428. HKEY open_registry(const TCHAR *service_name, const TCHAR *sub, REGSAM sam, bool must_exist) {
  429. /* Get registry */
  430. TCHAR registry[KEY_LENGTH];
  431. if (service_registry_path(service_name, true, sub, registry, _countof(registry)) < 0) {
  432. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, NSSM_REGISTRY, _T("open_registry()"), 0);
  433. return 0;
  434. }
  435. return open_registry_key(registry, sam, must_exist);
  436. }
  437. HKEY open_registry(const TCHAR *service_name, const TCHAR *sub, REGSAM sam) {
  438. return open_registry(service_name, sub, sam, true);
  439. }
  440. HKEY open_registry(const TCHAR *service_name, REGSAM sam) {
  441. return open_registry(service_name, 0, sam, true);
  442. }
  443. int get_io_parameters(nssm_service_t *service, HKEY key) {
  444. /* stdin */
  445. if (get_createfile_parameters(key, NSSM_REG_STDIN, service->stdin_path, &service->stdin_sharing, NSSM_STDIN_SHARING, &service->stdin_disposition, NSSM_STDIN_DISPOSITION, &service->stdin_flags, NSSM_STDIN_FLAGS, 0)) {
  446. service->stdin_sharing = service->stdin_disposition = service->stdin_flags = 0;
  447. ZeroMemory(service->stdin_path, _countof(service->stdin_path) * sizeof(TCHAR));
  448. return 1;
  449. }
  450. /* stdout */
  451. if (get_createfile_parameters(key, NSSM_REG_STDOUT, service->stdout_path, &service->stdout_sharing, NSSM_STDOUT_SHARING, &service->stdout_disposition, NSSM_STDOUT_DISPOSITION, &service->stdout_flags, NSSM_STDOUT_FLAGS, &service->stdout_copy_and_truncate)) {
  452. service->stdout_sharing = service->stdout_disposition = service->stdout_flags = 0;
  453. ZeroMemory(service->stdout_path, _countof(service->stdout_path) * sizeof(TCHAR));
  454. return 2;
  455. }
  456. /* stderr */
  457. if (get_createfile_parameters(key, NSSM_REG_STDERR, service->stderr_path, &service->stderr_sharing, NSSM_STDERR_SHARING, &service->stderr_disposition, NSSM_STDERR_DISPOSITION, &service->stderr_flags, NSSM_STDERR_FLAGS, &service->stderr_copy_and_truncate)) {
  458. service->stderr_sharing = service->stderr_disposition = service->stderr_flags = 0;
  459. ZeroMemory(service->stderr_path, _countof(service->stderr_path) * sizeof(TCHAR));
  460. return 3;
  461. }
  462. return 0;
  463. }
  464. int get_parameters(nssm_service_t *service, STARTUPINFO *si) {
  465. unsigned long ret;
  466. /* Try to open the registry */
  467. HKEY key = open_registry(service->name, KEY_READ);
  468. if (! key) return 1;
  469. /* Don't expand parameters when retrieving for the GUI. */
  470. bool expand = si ? true : false;
  471. /* Try to get environment variables - may fail */
  472. get_environment(service->name, key, NSSM_REG_ENV, &service->env, &service->envlen);
  473. /* Environment variables to add to existing rather than replace - may fail. */
  474. get_environment(service->name, key, NSSM_REG_ENV_EXTRA, &service->env_extra, &service->env_extralen);
  475. /* Set environment if we are starting the service. */
  476. if (si) set_service_environment(service);
  477. /* Try to get executable file - MUST succeed */
  478. if (get_string(key, NSSM_REG_EXE, service->exe, sizeof(service->exe), expand, false, true)) {
  479. RegCloseKey(key);
  480. return 3;
  481. }
  482. /* Try to get flags - may fail and we don't care */
  483. if (get_string(key, NSSM_REG_FLAGS, service->flags, sizeof(service->flags), expand, false, true)) {
  484. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_FLAGS, NSSM_REG_FLAGS, service->name, service->exe, 0);
  485. ZeroMemory(service->flags, sizeof(service->flags));
  486. }
  487. /* Try to get startup directory - may fail and we fall back to a default */
  488. if (get_string(key, NSSM_REG_DIR, service->dir, sizeof(service->dir), expand, true, true) || ! service->dir[0]) {
  489. _sntprintf_s(service->dir, _countof(service->dir), _TRUNCATE, _T("%s"), service->exe);
  490. strip_basename(service->dir);
  491. if (service->dir[0] == _T('\0')) {
  492. /* Help! */
  493. ret = GetWindowsDirectory(service->dir, sizeof(service->dir));
  494. if (! ret || ret > sizeof(service->dir)) {
  495. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_NO_DIR_AND_NO_FALLBACK, NSSM_REG_DIR, service->name, 0);
  496. RegCloseKey(key);
  497. return 4;
  498. }
  499. }
  500. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_NO_DIR, NSSM_REG_DIR, service->name, service->dir, 0);
  501. }
  502. /* Try to get processor affinity - may fail. */
  503. TCHAR buffer[512];
  504. if (get_string(key, NSSM_REG_AFFINITY, buffer, sizeof(buffer), false, false, false) || ! buffer[0]) service->affinity = 0LL;
  505. else if (affinity_string_to_mask(buffer, &service->affinity)) {
  506. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_AFFINITY_MASK, service->name, buffer);
  507. service->affinity = 0LL;
  508. }
  509. else {
  510. DWORD_PTR affinity, system_affinity;
  511. if (GetProcessAffinityMask(GetCurrentProcess(), &affinity, &system_affinity)) {
  512. _int64 effective_affinity = service->affinity & system_affinity;
  513. if (effective_affinity != service->affinity) {
  514. TCHAR *system = 0;
  515. if (! affinity_mask_to_string(system_affinity, &system)) {
  516. TCHAR *effective = 0;
  517. if (! affinity_mask_to_string(effective_affinity, &effective)) {
  518. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_EFFECTIVE_AFFINITY_MASK, service->name, buffer, system, effective, 0);
  519. }
  520. HeapFree(GetProcessHeap(), 0, effective);
  521. }
  522. HeapFree(GetProcessHeap(), 0, system);
  523. }
  524. }
  525. }
  526. /* Try to get priority - may fail. */
  527. unsigned long priority;
  528. if (get_number(key, NSSM_REG_PRIORITY, &priority, false) == 1) {
  529. if (priority == (priority & priority_mask())) service->priority = priority;
  530. else log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_PRIORITY, service->name, NSSM_REG_PRIORITY, 0);
  531. }
  532. /* Try to get file rotation settings - may fail. */
  533. unsigned long rotate_files;
  534. if (get_number(key, NSSM_REG_ROTATE, &rotate_files, false) == 1) {
  535. if (rotate_files) service->rotate_files = true;
  536. else service->rotate_files = false;
  537. }
  538. else service->rotate_files = false;
  539. if (get_number(key, NSSM_REG_ROTATE_ONLINE, &rotate_files, false) == 1) {
  540. if (rotate_files) service->rotate_stdout_online = service->rotate_stderr_online = true;
  541. else service->rotate_stdout_online = service->rotate_stderr_online = false;
  542. }
  543. else service->rotate_stdout_online = service->rotate_stderr_online = false;
  544. if (get_number(key, NSSM_REG_ROTATE_SECONDS, &service->rotate_seconds, false) != 1) service->rotate_seconds = 0;
  545. if (get_number(key, NSSM_REG_ROTATE_BYTES_LOW, &service->rotate_bytes_low, false) != 1) service->rotate_bytes_low = 0;
  546. if (get_number(key, NSSM_REG_ROTATE_BYTES_HIGH, &service->rotate_bytes_high, false) != 1) service->rotate_bytes_high = 0;
  547. override_milliseconds(service->name, key, NSSM_REG_ROTATE_DELAY, &service->rotate_delay, NSSM_ROTATE_DELAY, NSSM_EVENT_BOGUS_THROTTLE);
  548. /* Try to get force new console setting - may fail. */
  549. if (get_number(key, NSSM_REG_NO_CONSOLE, &service->no_console, false) != 1) service->no_console = 0;
  550. /* Change to startup directory in case stdout/stderr are relative paths. */
  551. TCHAR cwd[PATH_LENGTH];
  552. GetCurrentDirectory(_countof(cwd), cwd);
  553. SetCurrentDirectory(service->dir);
  554. /* Try to get stdout and stderr */
  555. if (get_io_parameters(service, key)) {
  556. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_GET_OUTPUT_HANDLES_FAILED, service->name, 0);
  557. RegCloseKey(key);
  558. SetCurrentDirectory(cwd);
  559. return 5;
  560. }
  561. /* Change back in case the startup directory needs to be deleted. */
  562. SetCurrentDirectory(cwd);
  563. /* Try to get mandatory restart delay */
  564. override_milliseconds(service->name, key, NSSM_REG_RESTART_DELAY, &service->restart_delay, 0, NSSM_EVENT_BOGUS_RESTART_DELAY);
  565. /* Try to get throttle restart delay */
  566. override_milliseconds(service->name, key, NSSM_REG_THROTTLE, &service->throttle_delay, NSSM_RESET_THROTTLE_RESTART, NSSM_EVENT_BOGUS_THROTTLE);
  567. /* Try to get service stop flags. */
  568. unsigned long type = REG_DWORD;
  569. unsigned long stop_method_skip;
  570. unsigned long buflen = sizeof(stop_method_skip);
  571. bool stop_ok = false;
  572. ret = RegQueryValueEx(key, NSSM_REG_STOP_METHOD_SKIP, 0, &type, (unsigned char *) &stop_method_skip, &buflen);
  573. if (ret != ERROR_SUCCESS) {
  574. if (ret != ERROR_FILE_NOT_FOUND) {
  575. if (type != REG_DWORD) {
  576. log_event(EVENTLOG_WARNING_TYPE, NSSM_EVENT_BOGUS_STOP_METHOD_SKIP, service->name, NSSM_REG_STOP_METHOD_SKIP, NSSM, 0);
  577. }
  578. else log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_QUERYVALUE_FAILED, NSSM_REG_STOP_METHOD_SKIP, error_string(GetLastError()), 0);
  579. }
  580. }
  581. else stop_ok = true;
  582. /* Try all methods except those requested to be skipped. */
  583. service->stop_method = ~0;
  584. if (stop_ok) service->stop_method &= ~stop_method_skip;
  585. /* Try to get kill delays - may fail. */
  586. 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);
  587. 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);
  588. 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);
  589. /* Try to get process tree settings - may fail. */
  590. unsigned long kill_process_tree;
  591. if (get_number(key, NSSM_REG_KILL_PROCESS_TREE, &kill_process_tree, false) == 1) {
  592. if (kill_process_tree) service->kill_process_tree = true;
  593. else service->kill_process_tree = false;
  594. }
  595. else service->kill_process_tree = true;
  596. /* Try to get default exit action. */
  597. bool default_action;
  598. service->default_exit_action = NSSM_EXIT_RESTART;
  599. TCHAR action_string[ACTION_LEN];
  600. if (! get_exit_action(service->name, 0, action_string, &default_action)) {
  601. for (int i = 0; exit_action_strings[i]; i++) {
  602. if (! _tcsnicmp((const TCHAR *) action_string, exit_action_strings[i], ACTION_LEN)) {
  603. service->default_exit_action = i;
  604. break;
  605. }
  606. }
  607. }
  608. /* Close registry */
  609. RegCloseKey(key);
  610. return 0;
  611. }
  612. /*
  613. Sets the string for the exit action corresponding to the exit code.
  614. ret is a pointer to an unsigned long containing the exit code.
  615. If ret is NULL, we retrieve the default exit action unconditionally.
  616. action is a buffer which receives the string.
  617. default_action is a pointer to a bool which is set to false if there
  618. was an explicit string for the given exit code, or true if we are
  619. returning the default action.
  620. Returns: 0 on success.
  621. 1 on error.
  622. */
  623. int get_exit_action(const TCHAR *service_name, unsigned long *ret, TCHAR *action, bool *default_action) {
  624. /* Are we returning the default action or a status-specific one? */
  625. *default_action = ! ret;
  626. /* Try to open the registry */
  627. HKEY key = open_registry(service_name, NSSM_REG_EXIT, KEY_READ);
  628. if (! key) return 1;
  629. unsigned long type = REG_SZ;
  630. unsigned long action_len = ACTION_LEN;
  631. TCHAR code[16];
  632. if (! ret) code[0] = _T('\0');
  633. else if (_sntprintf_s(code, _countof(code), _TRUNCATE, _T("%lu"), *ret) < 0) {
  634. RegCloseKey(key);
  635. return get_exit_action(service_name, 0, action, default_action);
  636. }
  637. if (RegQueryValueEx(key, code, 0, &type, (unsigned char *) action, &action_len) != ERROR_SUCCESS) {
  638. RegCloseKey(key);
  639. /* Try again with * as the key if an exit code was defined */
  640. if (ret) return get_exit_action(service_name, 0, action, default_action);
  641. return 0;
  642. }
  643. /* Close registry */
  644. RegCloseKey(key);
  645. return 0;
  646. }
  647. int set_hook(const TCHAR *service_name, const TCHAR *hook_event, const TCHAR *hook_action, TCHAR *cmd) {
  648. /* Try to open the registry */
  649. TCHAR registry[KEY_LENGTH];
  650. if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, _T("%s\\%s"), NSSM_REG_HOOK, hook_event) < 0) {
  651. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("hook registry"), _T("set_hook()"), 0);
  652. return 1;
  653. }
  654. HKEY key;
  655. long error;
  656. /* Don't create keys needlessly. */
  657. if (! _tcslen(cmd)) {
  658. key = open_registry(service_name, registry, KEY_READ, false);
  659. if (! key) return 0;
  660. error = RegQueryValueEx(key, hook_action, 0, 0, 0, 0);
  661. RegCloseKey(key);
  662. if (error == ERROR_FILE_NOT_FOUND) return 0;
  663. }
  664. key = open_registry(service_name, registry, KEY_WRITE);
  665. if (! key) return 1;
  666. int ret = 1;
  667. if (_tcslen(cmd)) ret = set_string(key, (TCHAR *) hook_action, cmd, true);
  668. else {
  669. error = RegDeleteValue(key, hook_action);
  670. if (error == ERROR_SUCCESS || error == ERROR_FILE_NOT_FOUND) ret = 0;
  671. }
  672. /* Close registry */
  673. RegCloseKey(key);
  674. return ret;
  675. }
  676. int get_hook(const TCHAR *service_name, const TCHAR *hook_event, const TCHAR *hook_action, TCHAR *buffer, unsigned long buflen) {
  677. /* Try to open the registry */
  678. TCHAR registry[KEY_LENGTH];
  679. if (_sntprintf_s(registry, _countof(registry), _TRUNCATE, _T("%s\\%s"), NSSM_REG_HOOK, hook_event) < 0) {
  680. log_event(EVENTLOG_ERROR_TYPE, NSSM_EVENT_OUT_OF_MEMORY, _T("hook registry"), _T("get_hook()"), 0);
  681. return 1;
  682. }
  683. HKEY key = open_registry(service_name, registry, KEY_READ, false);
  684. if (! key) return 1;
  685. int ret = expand_parameter(key, (TCHAR *) hook_action, buffer, buflen, true, false);
  686. /* Close registry */
  687. RegCloseKey(key);
  688. return ret;
  689. }