registry.cpp 13 KB

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