ExeSessionProcess.cs 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Diagnostics;
  4. using System.Globalization;
  5. using System.IO;
  6. using System.Threading;
  7. using Microsoft.Win32;
  8. using Microsoft.Win32.SafeHandles;
  9. using System.Runtime.InteropServices;
  10. using System.Reflection;
  11. using System.Security.Principal;
  12. using System.Security.AccessControl;
  13. namespace WinSCP
  14. {
  15. internal class ExeSessionProcess : IDisposable
  16. {
  17. public event OutputDataReceivedEventHandler OutputDataReceived;
  18. public bool HasExited { get { return _process.HasExited; } }
  19. public int ExitCode { get { return _process.ExitCode; } }
  20. public static ExeSessionProcess CreateForSession(Session session)
  21. {
  22. return new ExeSessionProcess(session, true, null);
  23. }
  24. public static ExeSessionProcess CreateForConsole(Session session, string additionalArguments)
  25. {
  26. return new ExeSessionProcess(session, false, additionalArguments);
  27. }
  28. private ExeSessionProcess(Session session, bool useXmlLog, string additionalArguments)
  29. {
  30. _session = session;
  31. _logger = session.Logger;
  32. _incompleteLine = string.Empty;
  33. using (_logger.CreateCallstack())
  34. {
  35. string executablePath = GetExecutablePath();
  36. _logger.WriteLine("EXE executable path resolved to {0}", executablePath);
  37. string assemblyFilePath = _logger.GetAssemblyFilePath();
  38. FileVersionInfo assemblyVersion = null;
  39. if (assemblyFilePath != null)
  40. {
  41. assemblyVersion = FileVersionInfo.GetVersionInfo(assemblyFilePath);
  42. }
  43. CheckVersion(executablePath, assemblyVersion);
  44. string configSwitch;
  45. if (_session.DefaultConfigurationInternal)
  46. {
  47. configSwitch = "/ini=nul ";
  48. }
  49. else
  50. {
  51. if (!string.IsNullOrEmpty(_session.IniFilePathInternal))
  52. {
  53. configSwitch = string.Format(CultureInfo.InvariantCulture, "/ini=\"{0}\" ", _session.IniFilePathInternal);
  54. }
  55. else
  56. {
  57. configSwitch = "";
  58. }
  59. }
  60. string logSwitch = null;
  61. if (!string.IsNullOrEmpty(_session.SessionLogPath))
  62. {
  63. logSwitch = string.Format(CultureInfo.InvariantCulture, "/log=\"{0}\" ", LogPathEscape(_session.SessionLogPath));
  64. }
  65. string xmlLogSwitch;
  66. if (useXmlLog)
  67. {
  68. xmlLogSwitch = string.Format(CultureInfo.InvariantCulture, "/xmllog=\"{0}\" /xmlgroups /xmllogrequired ", LogPathEscape(_session.XmlLogPath));
  69. }
  70. else
  71. {
  72. xmlLogSwitch = "";
  73. }
  74. string logLevelSwitch = null;
  75. if (_session.DebugLogLevel > 0)
  76. {
  77. logLevelSwitch = string.Format(CultureInfo.InvariantCulture, "/loglevel={0} ", _session.DebugLogLevel);
  78. }
  79. string assemblyVersionStr =
  80. (assemblyVersion == null) ? "unk" :
  81. string.Format(CultureInfo.InvariantCulture, "{0}.{1}.{2} ", assemblyVersion.ProductMajorPart, assemblyVersion.ProductMinorPart, assemblyVersion.ProductBuildPart);
  82. string assemblyVersionSwitch =
  83. string.Format(CultureInfo.InvariantCulture, "/dotnet={0} ", assemblyVersionStr);
  84. string arguments =
  85. xmlLogSwitch + "/nointeractiveinput " + assemblyVersionSwitch +
  86. configSwitch + logSwitch + logLevelSwitch + _session.AdditionalExecutableArguments;
  87. Tools.AddRawParameters(ref arguments, _session.RawConfiguration, "/rawconfig", false);
  88. if (!string.IsNullOrEmpty(additionalArguments))
  89. {
  90. arguments += " " + additionalArguments;
  91. }
  92. _process = new Process();
  93. _process.StartInfo.FileName = executablePath;
  94. _process.StartInfo.WorkingDirectory = Path.GetDirectoryName(executablePath);
  95. _process.StartInfo.Arguments = arguments;
  96. _process.StartInfo.UseShellExecute = false;
  97. _process.Exited += ProcessExited;
  98. }
  99. }
  100. private static string LogPathEscape(string path)
  101. {
  102. return Tools.ArgumentEscape(path).Replace("!", "!!");
  103. }
  104. public void Abort()
  105. {
  106. using (_logger.CreateCallstack())
  107. {
  108. lock (_lock)
  109. {
  110. if ((_process != null) && !_process.HasExited)
  111. {
  112. _process.Kill();
  113. }
  114. }
  115. }
  116. }
  117. public void Start()
  118. {
  119. using (_logger.CreateCallstack())
  120. {
  121. InitializeConsole();
  122. InitializeChild();
  123. }
  124. }
  125. private void InitializeChild()
  126. {
  127. using (_logger.CreateCallstack())
  128. {
  129. // The /console is redundant for CreateForConsole
  130. _process.StartInfo.Arguments += string.Format(CultureInfo.InvariantCulture, " /console /consoleinstance={0}", _instanceName);
  131. #if !NETSTANDARD
  132. // When running under IIS in "impersonated" mode, the process starts, but does not do anything.
  133. // Supposedly it "displayes" some invisible error message when starting and hangs.
  134. // Running it "as the user" helps, eventhough it already runs as the user.
  135. // These's probably some difference between "run as" and impersonations
  136. if (!string.IsNullOrEmpty(_session.ExecutableProcessUserName))
  137. {
  138. _logger.WriteLine("Will run process as {0}", _session.ExecutableProcessUserName);
  139. _process.StartInfo.UserName = _session.ExecutableProcessUserName;
  140. _process.StartInfo.Password = _session.ExecutableProcessPassword;
  141. // One of the hints for resolving C0000142 error (see below)
  142. // was setting this property, so that an environment is correctly loaded,
  143. // so DLLs can be found and loaded.
  144. _process.StartInfo.LoadUserProfile = true;
  145. // Without granting both window station and desktop access permissions,
  146. // WinSCP process aborts with C0000142 (DLL Initialization Failed) error,
  147. // when "running as user"
  148. _logger.WriteLine("Granting access to window station");
  149. try
  150. {
  151. IntPtr windowStation = UnsafeNativeMethods.GetProcessWindowStation();
  152. GrantAccess(windowStation, (int)WindowStationRights.AllAccess);
  153. }
  154. catch (Exception e)
  155. {
  156. throw _logger.WriteException(new SessionLocalException(_session, "Error granting access to window station", e));
  157. }
  158. _logger.WriteLine("Granting access to desktop");
  159. try
  160. {
  161. IntPtr desktop = UnsafeNativeMethods.GetThreadDesktop(UnsafeNativeMethods.GetCurrentThreadId());
  162. GrantAccess(desktop, (int)DesktopRights.AllAccess);
  163. }
  164. catch (Exception e)
  165. {
  166. throw _logger.WriteException(new SessionLocalException(_session, "Error granting access to desktop", e));
  167. }
  168. }
  169. #endif
  170. _logger.WriteLine("Starting \"{0}\" {1}", _process.StartInfo.FileName, _process.StartInfo.Arguments);
  171. _process.Start();
  172. _logger.WriteLine("Started process {0}", _process.Id);
  173. _thread = new Thread(ProcessEvents)
  174. {
  175. IsBackground = true
  176. };
  177. _thread.Start();
  178. }
  179. }
  180. // Handles returned by GetProcessWindowStation and GetThreadDesktop should not be closed
  181. internal class NoopSafeHandle : SafeHandle
  182. {
  183. public NoopSafeHandle(IntPtr handle) :
  184. base(handle, false)
  185. {
  186. }
  187. public override bool IsInvalid
  188. {
  189. get { return false; }
  190. }
  191. protected override bool ReleaseHandle()
  192. {
  193. return true;
  194. }
  195. }
  196. #if !NETSTANDARD
  197. private void GrantAccess(IntPtr handle, int accessMask)
  198. {
  199. using (SafeHandle safeHandle = new NoopSafeHandle(handle))
  200. {
  201. GenericSecurity security =
  202. new GenericSecurity(false, ResourceType.WindowObject, safeHandle, AccessControlSections.Access);
  203. security.AddAccessRule(
  204. new GenericAccessRule(new NTAccount(_session.ExecutableProcessUserName), accessMask, AccessControlType.Allow));
  205. security.Persist(safeHandle, AccessControlSections.Access);
  206. }
  207. }
  208. #endif
  209. private void ProcessExited(object sender, EventArgs e)
  210. {
  211. _logger.WriteLine("Process {0} exited with exit code {1}", _process.Id, _process.ExitCode);
  212. }
  213. private bool AbortedOrExited()
  214. {
  215. if (_abort)
  216. {
  217. _logger.WriteLine("Aborted");
  218. return true;
  219. }
  220. else if (_process.HasExited)
  221. {
  222. _logger.WriteLine("Exited");
  223. return true;
  224. }
  225. else
  226. {
  227. return false;
  228. }
  229. }
  230. private void ProcessEvents()
  231. {
  232. using (_logger.CreateCallstack())
  233. {
  234. while (!AbortedOrExited())
  235. {
  236. _logger.WriteLineLevel(1, "Waiting for request event");
  237. // Keep in sync with a delay in SessionLogReader.DoRead
  238. if (_requestEvent.WaitOne(100, false))
  239. {
  240. _logger.WriteLineLevel(1, "Got request event");
  241. ProcessEvent();
  242. }
  243. if (_logger.LogLevel >= 1)
  244. {
  245. _logger.WriteLine(string.Format(CultureInfo.InvariantCulture, "2nd generation collection count: {0}", GC.CollectionCount(2)));
  246. _logger.WriteLine(string.Format(CultureInfo.InvariantCulture, "Total memory allocated: {0}", GC.GetTotalMemory(false)));
  247. }
  248. }
  249. }
  250. }
  251. private void ProcessEvent()
  252. {
  253. using (_logger.CreateCallstack())
  254. {
  255. using (ConsoleCommStruct commStruct = AcquireCommStruct())
  256. {
  257. switch (commStruct.Event)
  258. {
  259. case ConsoleEvent.Print:
  260. ProcessPrintEvent(commStruct.PrintEvent);
  261. break;
  262. case ConsoleEvent.Input:
  263. ProcessInputEvent(commStruct.InputEvent);
  264. break;
  265. case ConsoleEvent.Choice:
  266. ProcessChoiceEvent(commStruct.ChoiceEvent);
  267. break;
  268. case ConsoleEvent.Title:
  269. ProcessTitleEvent(commStruct.TitleEvent);
  270. break;
  271. case ConsoleEvent.Init:
  272. ProcessInitEvent(commStruct.InitEvent);
  273. break;
  274. case ConsoleEvent.Progress:
  275. ProcessProgressEvent(commStruct.ProgressEvent);
  276. break;
  277. default:
  278. throw _logger.WriteException(new NotImplementedException());
  279. }
  280. }
  281. _responseEvent.Set();
  282. }
  283. }
  284. private void ProcessChoiceEvent(ConsoleChoiceEventStruct e)
  285. {
  286. using (_logger.CreateCallstack())
  287. {
  288. _logger.WriteLine(
  289. "Options: [{0}], Timer: [{1}], Timeouting: [{2}], Timeouted: [{3}], Break: [{4}]",
  290. e.Options, e.Timer, e.Timeouting, e.Timeouted, e.Break);
  291. QueryReceivedEventArgs args = new QueryReceivedEventArgs
  292. {
  293. Message = e.Message
  294. };
  295. _session.ProcessChoice(args);
  296. if (args.SelectedAction == QueryReceivedEventArgs.Action.None)
  297. {
  298. if (e.Timeouting)
  299. {
  300. Thread.Sleep((int)e.Timer);
  301. e.Result = e.Timeouted;
  302. }
  303. else
  304. {
  305. e.Result = e.Break;
  306. }
  307. }
  308. else if (args.SelectedAction == QueryReceivedEventArgs.Action.Continue)
  309. {
  310. if (e.Timeouting)
  311. {
  312. Thread.Sleep((int)e.Timer);
  313. e.Result = e.Timeouted;
  314. }
  315. else
  316. {
  317. e.Result = e.Continue;
  318. }
  319. }
  320. else if (args.SelectedAction == QueryReceivedEventArgs.Action.Abort)
  321. {
  322. e.Result = e.Break;
  323. }
  324. _logger.WriteLine("Options Result: [{0}]", e.Result);
  325. }
  326. }
  327. private void ProcessTitleEvent(ConsoleTitleEventStruct e)
  328. {
  329. using (_logger.CreateCallstack())
  330. {
  331. _logger.WriteLine("Not-supported title event [{0}]", e.Title);
  332. }
  333. }
  334. private void ProcessInputEvent(ConsoleInputEventStruct e)
  335. {
  336. using (_logger.CreateCallstack())
  337. {
  338. while (!AbortedOrExited())
  339. {
  340. lock (_input)
  341. {
  342. if (_input.Count > 0)
  343. {
  344. e.Str = _input[0];
  345. e.Result = true;
  346. _input.RemoveAt(0);
  347. Print(false, false, _log[0] + "\n");
  348. _log.RemoveAt(0);
  349. return;
  350. }
  351. }
  352. _inputEvent.WaitOne(100, false);
  353. }
  354. }
  355. }
  356. private void Print(bool fromBeginning, bool error, string message)
  357. {
  358. if (fromBeginning && ((message.Length == 0) || (message[0] != '\n')))
  359. {
  360. _lastFromBeginning = message;
  361. _logger.WriteLine("Buffered from-beginning message [{0}]", _lastFromBeginning);
  362. OutputDataReceived?.Invoke(this, null);
  363. }
  364. else
  365. {
  366. if (!string.IsNullOrEmpty(_lastFromBeginning))
  367. {
  368. AddToOutput(_lastFromBeginning, false);
  369. _lastFromBeginning = null;
  370. }
  371. if (fromBeginning && (message.Length > 0) && (message[0] == '\n'))
  372. {
  373. AddToOutput("\n", false);
  374. _lastFromBeginning = message.Substring(1);
  375. _logger.WriteLine("Buffered from-beginning message [{0}]", _lastFromBeginning);
  376. }
  377. else
  378. {
  379. AddToOutput(message, error);
  380. }
  381. }
  382. }
  383. private void AddToOutput(string message, bool error)
  384. {
  385. string[] lines = (_incompleteLine + message).Split(new[] { '\n' });
  386. _incompleteLine = lines[lines.Length - 1];
  387. for (int i = 0; i < lines.Length - 1; ++i)
  388. {
  389. OutputDataReceived?.Invoke(this, new OutputDataReceivedEventArgs(lines[i], error));
  390. }
  391. }
  392. private void ProcessPrintEvent(ConsolePrintEventStruct e)
  393. {
  394. _logger.WriteLineLevel(1, string.Format(CultureInfo.CurrentCulture, "Print: {0}", e.Message));
  395. Print(e.FromBeginning, e.Error, e.Message);
  396. }
  397. private void ProcessInitEvent(ConsoleInitEventStruct e)
  398. {
  399. using (_logger.CreateCallstack())
  400. {
  401. e.InputType = 3; // pipe
  402. e.OutputType = 3; // pipe
  403. e.WantsProgress = _session.WantsProgress;
  404. }
  405. }
  406. private void ProcessProgressEvent(ConsoleProgressEventStruct e)
  407. {
  408. using (_logger.CreateCallstack())
  409. {
  410. _logger.WriteLine(
  411. "File Name [{0}] - Directory [{1}] - Overall Progress [{2}] - File Progress [{3}] - CPS [{4}]",
  412. e.FileName, e.Directory, e.OverallProgress, e.FileProgress, e.CPS);
  413. if (!_cancel)
  414. {
  415. FileTransferProgressEventArgs args = new FileTransferProgressEventArgs();
  416. switch (e.Operation)
  417. {
  418. case ConsoleProgressEventStruct.ProgressOperation.Copy:
  419. args.Operation = ProgressOperation.Transfer;
  420. break;
  421. default:
  422. throw _logger.WriteException(new ArgumentOutOfRangeException("Unknown progress operation", (Exception)null));
  423. }
  424. switch (e.Side)
  425. {
  426. case ConsoleProgressEventStruct.ProgressSide.Local:
  427. args.Side = ProgressSide.Local;
  428. break;
  429. case ConsoleProgressEventStruct.ProgressSide.Remote:
  430. args.Side = ProgressSide.Remote;
  431. break;
  432. default:
  433. throw _logger.WriteException(new ArgumentOutOfRangeException("Unknown progress side", (Exception)null));
  434. }
  435. args.FileName = e.FileName;
  436. args.Directory = e.Directory;
  437. args.OverallProgress = ((double)e.OverallProgress) / 100;
  438. args.FileProgress = ((double)e.FileProgress) / 100;
  439. args.CPS = (int)e.CPS;
  440. args.Cancel = false;
  441. _session.ProcessProgress(args);
  442. }
  443. if (_cancel)
  444. {
  445. e.Cancel = true;
  446. }
  447. }
  448. }
  449. private void InitializeConsole()
  450. {
  451. using (_logger.CreateCallstack())
  452. {
  453. int attempts = 0;
  454. Random random = new Random();
  455. int process = Process.GetCurrentProcess().Id;
  456. do
  457. {
  458. if (attempts > MaxAttempts)
  459. {
  460. throw _logger.WriteException(new SessionLocalException(_session, "Cannot find unique name for event object."));
  461. }
  462. int instanceNumber = random.Next(1000);
  463. _instanceName = string.Format(CultureInfo.InvariantCulture, "_{0}_{1}_{2}", process, GetHashCode(), instanceNumber);
  464. _logger.WriteLine("Trying event {0}", _instanceName);
  465. if (!TryCreateEvent(ConsoleEventRequest + _instanceName, out _requestEvent))
  466. {
  467. _logger.WriteLine("Event {0} is not unique", _instanceName);
  468. _requestEvent.Close();
  469. _requestEvent = null;
  470. }
  471. else
  472. {
  473. _logger.WriteLine("Event {0} is unique", _instanceName);
  474. _responseEvent = CreateEvent(ConsoleEventResponse + _instanceName);
  475. _cancelEvent = CreateEvent(ConsoleEventCancel + _instanceName);
  476. string fileMappingName = ConsoleMapping + _instanceName;
  477. _fileMapping = CreateFileMapping(fileMappingName);
  478. if (Marshal.GetLastWin32Error() == UnsafeNativeMethods.ERROR_ALREADY_EXISTS)
  479. {
  480. throw _logger.WriteException(new SessionLocalException(_session, string.Format(CultureInfo.InvariantCulture, "File mapping {0} already exists", fileMappingName)));
  481. }
  482. if (_fileMapping.IsInvalid)
  483. {
  484. throw _logger.WriteException(new SessionLocalException(_session, string.Format(CultureInfo.InvariantCulture, "Cannot create file mapping {0}", fileMappingName)));
  485. }
  486. }
  487. ++attempts;
  488. }
  489. while (_requestEvent == null);
  490. using (ConsoleCommStruct commStruct = AcquireCommStruct())
  491. {
  492. commStruct.InitHeader();
  493. }
  494. if (_session.GuardProcessWithJobInternal)
  495. {
  496. string jobName = ConsoleJob + _instanceName;
  497. _job = new Job(_logger, jobName);
  498. }
  499. }
  500. }
  501. private SafeFileHandle CreateFileMapping(string fileMappingName)
  502. {
  503. unsafe
  504. {
  505. IntPtr securityAttributesPtr = IntPtr.Zero;
  506. #if !NETSTANDARD
  507. // We use the EventWaitHandleSecurity only to generate the descriptor binary form
  508. // that does not differ for object types, so we abuse the existing "event handle" implementation,
  509. // not to have to create the file mapping SecurityAttributes via P/Invoke.
  510. // .NET 4 supports MemoryMappedFile and MemoryMappedFileSecurity natively already
  511. EventWaitHandleSecurity security = CreateSecurity((EventWaitHandleRights)FileMappingRights.AllAccess);
  512. if (security != null)
  513. {
  514. SecurityAttributes securityAttributes = new SecurityAttributes();
  515. securityAttributes.nLength = (uint)Marshal.SizeOf(securityAttributes);
  516. byte[] descriptorBinaryForm = security.GetSecurityDescriptorBinaryForm();
  517. byte * buffer = stackalloc byte[descriptorBinaryForm.Length];
  518. for (int i = 0; i < descriptorBinaryForm.Length; i++)
  519. {
  520. buffer[i] = descriptorBinaryForm[i];
  521. }
  522. securityAttributes.lpSecurityDescriptor = (IntPtr)buffer;
  523. int length = Marshal.SizeOf(typeof(SecurityAttributes));
  524. securityAttributesPtr = Marshal.AllocHGlobal(length);
  525. Marshal.StructureToPtr(securityAttributes, securityAttributesPtr, false);
  526. }
  527. #endif
  528. return
  529. UnsafeNativeMethods.CreateFileMapping(
  530. new SafeFileHandle(new IntPtr(-1), true), securityAttributesPtr, FileMapProtection.PageReadWrite, 0,
  531. ConsoleCommStruct.Size, fileMappingName);
  532. }
  533. }
  534. private ConsoleCommStruct AcquireCommStruct()
  535. {
  536. return new ConsoleCommStruct(_session, _fileMapping);
  537. }
  538. private bool TryCreateEvent(string name, out EventWaitHandle ev)
  539. {
  540. _logger.WriteLine("Creating event {0}", name);
  541. string securityDesc;
  542. #if !NETSTANDARD
  543. EventWaitHandleSecurity security = CreateSecurity(EventWaitHandleRights.FullControl);
  544. ev = new EventWaitHandle(false, EventResetMode.AutoReset, name, out bool createdNew, security);
  545. securityDesc = (security != null ? security.GetSecurityDescriptorSddlForm(AccessControlSections.All) : "none");
  546. #else
  547. ev = new EventWaitHandle(false, EventResetMode.AutoReset, name, out bool createdNew);
  548. securityDesc = "not impl";
  549. #endif
  550. _logger.WriteLine(
  551. "Created event {0} with handle {1} with security {2}, new {3}",
  552. name, ev.SafeWaitHandle.DangerousGetHandle(), securityDesc, createdNew);
  553. return createdNew;
  554. }
  555. #if !NETSTANDARD
  556. private EventWaitHandleSecurity CreateSecurity(EventWaitHandleRights eventRights)
  557. {
  558. EventWaitHandleSecurity security = null;
  559. // When "running as user", we have to grant the target user permissions to the objects (events and file mapping) explicitly
  560. if (!string.IsNullOrEmpty(_session.ExecutableProcessUserName))
  561. {
  562. security = new EventWaitHandleSecurity();
  563. IdentityReference si;
  564. try
  565. {
  566. si = new NTAccount(_session.ExecutableProcessUserName);
  567. }
  568. catch (Exception e)
  569. {
  570. throw _logger.WriteException(new SessionLocalException(_session, string.Format(CultureInfo.CurrentCulture, "Error resolving account {0}", _session.ExecutableProcessUserName), e));
  571. }
  572. EventWaitHandleAccessRule rule =
  573. new EventWaitHandleAccessRule(
  574. si, eventRights, AccessControlType.Allow);
  575. security.AddAccessRule(rule);
  576. }
  577. return security;
  578. }
  579. #endif
  580. private EventWaitHandle CreateEvent(string name)
  581. {
  582. if (!TryCreateEvent(name, out EventWaitHandle ev))
  583. {
  584. throw _logger.WriteException(new SessionLocalException(_session, string.Format(CultureInfo.InvariantCulture, "Event {0} already exists", name)));
  585. }
  586. return ev;
  587. }
  588. private void TestEventClosed(string name)
  589. {
  590. if (_session.TestHandlesClosedInternal)
  591. {
  592. _logger.WriteLine("Testing that event {0} is closed", name);
  593. if (TryCreateEvent(name, out EventWaitHandle ev))
  594. {
  595. ev.Close();
  596. }
  597. else
  598. {
  599. _logger.WriteLine("Exception: Event {0} was not closed yet", name);
  600. }
  601. }
  602. }
  603. private void AddInput(string str, string log)
  604. {
  605. Type structType = typeof(ConsoleInputEventStruct);
  606. FieldInfo strField = structType.GetField("Str");
  607. object[] attributes = strField.GetCustomAttributes(typeof(MarshalAsAttribute), false);
  608. if (attributes.Length != 1)
  609. {
  610. throw _logger.WriteException(new InvalidOperationException("MarshalAs attribute not found for ConsoleInputEventStruct.Str"));
  611. }
  612. MarshalAsAttribute marshalAsAttribute = (MarshalAsAttribute)attributes[0];
  613. if (marshalAsAttribute.SizeConst <= str.Length)
  614. {
  615. throw _logger.WriteException(
  616. new SessionLocalException(
  617. _session,
  618. string.Format(CultureInfo.CurrentCulture, "Input [{0}] is too long ({1} limit)", str, marshalAsAttribute.SizeConst)));
  619. }
  620. lock (_input)
  621. {
  622. _input.Add(str);
  623. _log.Add(log);
  624. _inputEvent.Set();
  625. }
  626. }
  627. public void ExecuteCommand(string command, string log)
  628. {
  629. using (_logger.CreateCallstack())
  630. {
  631. _cancel = false;
  632. AddInput(command, log);
  633. }
  634. }
  635. public void Close()
  636. {
  637. using (_logger.CreateCallstack())
  638. {
  639. int timeout;
  640. #if DEBUG
  641. // in debug build, we expect the winscp.exe to run in tracing mode, being very slow
  642. timeout = 10000;
  643. #else
  644. timeout = 2000;
  645. #endif
  646. _logger.WriteLine("Waiting for process to exit ({0} ms)", timeout);
  647. if (!_process.WaitForExit(timeout))
  648. {
  649. _logger.WriteLine("Killing process");
  650. _process.Kill();
  651. }
  652. }
  653. }
  654. public void Dispose()
  655. {
  656. using (_logger.CreateCallstack())
  657. {
  658. lock (_lock)
  659. {
  660. if (_session.TestHandlesClosedInternal)
  661. {
  662. _logger.WriteLine("Will test that handles are closed");
  663. }
  664. _abort = true;
  665. if (_thread != null)
  666. {
  667. _thread.Join();
  668. _thread = null;
  669. }
  670. if (_process != null)
  671. {
  672. _process.Dispose();
  673. _process = null;
  674. }
  675. if (_requestEvent != null)
  676. {
  677. _requestEvent.Close();
  678. TestEventClosed(ConsoleEventRequest + _instanceName);
  679. }
  680. if (_responseEvent != null)
  681. {
  682. _responseEvent.Close();
  683. TestEventClosed(ConsoleEventResponse + _instanceName);
  684. }
  685. if (_cancelEvent != null)
  686. {
  687. _cancelEvent.Close();
  688. TestEventClosed(ConsoleEventCancel + _instanceName);
  689. }
  690. if (_fileMapping != null)
  691. {
  692. _fileMapping.Dispose();
  693. _fileMapping = null;
  694. if (_session.TestHandlesClosedInternal)
  695. {
  696. _logger.WriteLine("Testing that file mapping is closed");
  697. string fileMappingName = ConsoleMapping + _instanceName;
  698. SafeFileHandle fileMapping = CreateFileMapping(fileMappingName);
  699. if (Marshal.GetLastWin32Error() == UnsafeNativeMethods.ERROR_ALREADY_EXISTS)
  700. {
  701. _logger.WriteLine("Exception: File mapping {0} was not closed yet", fileMappingName);
  702. }
  703. if (!fileMapping.IsInvalid)
  704. {
  705. fileMapping.Dispose();
  706. }
  707. }
  708. }
  709. if (_inputEvent != null)
  710. {
  711. _inputEvent.Close();
  712. _inputEvent = null;
  713. }
  714. if (_job != null)
  715. {
  716. _job.Dispose();
  717. _job = null;
  718. }
  719. }
  720. }
  721. }
  722. private string GetExecutablePath()
  723. {
  724. using (_logger.CreateCallstack())
  725. {
  726. string executablePath;
  727. if (!string.IsNullOrEmpty(_session.ExecutablePath))
  728. {
  729. executablePath = _session.ExecutablePath;
  730. if (!File.Exists(executablePath))
  731. {
  732. throw _logger.WriteException(new SessionLocalException(_session, string.Format(CultureInfo.CurrentCulture, "{0} does not exists.", executablePath)));
  733. }
  734. }
  735. else
  736. {
  737. if (!TryFindExecutableInPath(GetAssemblyPath(), out executablePath) &&
  738. #if !NETSTANDARD
  739. !TryFindExecutableInPath(GetInstallationPath(RegistryHive.CurrentUser), out executablePath) &&
  740. !TryFindExecutableInPath(GetInstallationPath(RegistryHive.LocalMachine), out executablePath) &&
  741. #endif
  742. !TryFindExecutableInPath(GetDefaultInstallationPath(), out executablePath))
  743. {
  744. throw _logger.WriteException(
  745. new SessionLocalException(_session,
  746. string.Format(CultureInfo.CurrentCulture,
  747. "The {0} executable was not found at location of the assembly ({1}), nor in an installation path. You may use Session.ExecutablePath property to explicitly set path to {0}.",
  748. ExeExecutableFileName, GetAssemblyPath())));
  749. }
  750. }
  751. return executablePath;
  752. }
  753. }
  754. private static string GetDefaultInstallationPath()
  755. {
  756. string programFiles;
  757. if (IntPtr.Size == 8)
  758. {
  759. // In .NET 4 we can use Environment.SpecialFolder.ProgramFilesX86
  760. programFiles = Environment.GetEnvironmentVariable("ProgramFiles(x86)");
  761. }
  762. else
  763. {
  764. programFiles = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
  765. }
  766. return Path.Combine(programFiles, "WinSCP");
  767. }
  768. #if !NETSTANDARD
  769. private static string GetInstallationPath(RegistryHive hive)
  770. {
  771. RegistryKey baseKey = RegistryKey.OpenBaseKey(hive, RegistryView.Registry32);
  772. RegistryKey key = baseKey.OpenSubKey(@"Software\Microsoft\Windows\CurrentVersion\Uninstall\winscp3_is1");
  773. string result = (key != null) ? (string)key.GetValue("Inno Setup: App Path") : null;
  774. return result;
  775. }
  776. #endif
  777. private bool TryFindExecutableInPath(string path, out string result)
  778. {
  779. if (string.IsNullOrEmpty(path))
  780. {
  781. result = null;
  782. }
  783. else
  784. {
  785. string executablePath = Path.Combine(path, ExeExecutableFileName);
  786. if (File.Exists(executablePath))
  787. {
  788. result = executablePath;
  789. _logger.WriteLine("Executable found in {0}", executablePath);
  790. }
  791. else
  792. {
  793. result = null;
  794. _logger.WriteLine("Executable not found in {0}", executablePath);
  795. }
  796. }
  797. return (result != null);
  798. }
  799. private string GetAssemblyPath()
  800. {
  801. string codeBasePath = _logger.GetAssemblyFilePath();
  802. string path = null;
  803. if (!string.IsNullOrEmpty(codeBasePath))
  804. {
  805. path = Path.GetDirectoryName(codeBasePath);
  806. Debug.Assert(path != null);
  807. }
  808. return path;
  809. }
  810. private void CheckVersion(string exePath, FileVersionInfo assemblyVersion)
  811. {
  812. using (_logger.CreateCallstack())
  813. {
  814. if (assemblyVersion == null)
  815. {
  816. _logger.WriteLine("Assembly version not known, cannot check version");
  817. }
  818. else if (assemblyVersion.ProductVersion == AssemblyConstants.UndefinedProductVersion)
  819. {
  820. _logger.WriteLine("Undefined assembly version, cannot check version");
  821. }
  822. else
  823. {
  824. FileVersionInfo version = FileVersionInfo.GetVersionInfo(exePath);
  825. _logger.WriteLine("Version of {0} is {1}, product {2} version is {3}", exePath, version.FileVersion, version.ProductName, version.ProductVersion);
  826. if (_session.DisableVersionCheckInternal)
  827. {
  828. _logger.WriteLine("Version check disabled (not recommended)");
  829. }
  830. else if (assemblyVersion.ProductVersion != version.ProductVersion)
  831. {
  832. throw _logger.WriteException(
  833. new SessionLocalException(
  834. _session, string.Format(CultureInfo.CurrentCulture,
  835. "The version of {0} ({1}) does not match version of this assembly {2} ({3}).",
  836. exePath, version.ProductVersion, _logger.GetAssemblyFilePath(), assemblyVersion.ProductVersion)));
  837. }
  838. }
  839. }
  840. }
  841. public void WriteStatus()
  842. {
  843. string executablePath = GetExecutablePath();
  844. _logger.WriteLine("{0} - exists [{1}]", executablePath, File.Exists(executablePath));
  845. }
  846. public void RequestCallstack()
  847. {
  848. using (_logger.CreateCallstack())
  849. {
  850. lock (_lock)
  851. {
  852. if (_process == null)
  853. {
  854. _logger.WriteLine("Process is closed already");
  855. }
  856. else
  857. {
  858. try
  859. {
  860. string eventName = string.Format(CultureInfo.InvariantCulture, "WinSCPCallstack{0}", _process.Id);
  861. using (EventWaitHandle ev = EventWaitHandle.OpenExisting(eventName))
  862. {
  863. _logger.WriteLine("Setting event {0}", eventName);
  864. ev.Set();
  865. string callstackFileName = string.Format(CultureInfo.InvariantCulture, "{0}.txt", eventName);
  866. string callstackPath = Path.Combine(Path.GetTempPath(), callstackFileName);
  867. int timeout = 2000;
  868. while (!File.Exists(callstackPath))
  869. {
  870. if (timeout < 0)
  871. {
  872. string message = string.Format(CultureInfo.CurrentCulture, "Timeout waiting for callstack file {0} to be created ", callstackPath);
  873. throw new TimeoutException(message);
  874. }
  875. int step = 50;
  876. timeout -= 50;
  877. Thread.Sleep(step);
  878. }
  879. _logger.WriteLine("Callstack file {0} has been created", callstackPath);
  880. // allow writting to be finished
  881. Thread.Sleep(100);
  882. _logger.WriteLine(File.ReadAllText(callstackPath));
  883. File.Delete(callstackPath);
  884. }
  885. }
  886. catch (Exception e)
  887. {
  888. _logger.WriteException(e);
  889. }
  890. }
  891. }
  892. }
  893. }
  894. public void Cancel()
  895. {
  896. _cancel = true;
  897. }
  898. private const int MaxAttempts = 10;
  899. private const string ConsoleMapping = "WinSCPConsoleMapping";
  900. private const string ConsoleEventRequest = "WinSCPConsoleEventRequest";
  901. private const string ConsoleEventResponse = "WinSCPConsoleEventResponse";
  902. private const string ConsoleEventCancel = "WinSCPConsoleEventCancel";
  903. private const string ConsoleJob = "WinSCPConsoleJob";
  904. private const string ExeExecutableFileName = "winscp.exe";
  905. private Process _process;
  906. private readonly object _lock = new object();
  907. private readonly Logger _logger;
  908. private readonly Session _session;
  909. private EventWaitHandle _requestEvent;
  910. private EventWaitHandle _responseEvent;
  911. private EventWaitHandle _cancelEvent;
  912. private SafeFileHandle _fileMapping;
  913. private string _instanceName;
  914. private Thread _thread;
  915. private bool _abort;
  916. private string _lastFromBeginning;
  917. private string _incompleteLine;
  918. private readonly List<string> _input = new List<string>();
  919. private readonly List<string> _log = new List<string>();
  920. private AutoResetEvent _inputEvent = new AutoResetEvent(false);
  921. private Job _job;
  922. private bool _cancel;
  923. }
  924. }