SecureShell.cpp 90 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867
  1. //---------------------------------------------------------------------------
  2. #include <vcl.h>
  3. #pragma hdrstop
  4. #include "Common.h"
  5. #include "PuttyIntf.h"
  6. #include "Exceptions.h"
  7. #include "Interface.h"
  8. #include "SecureShell.h"
  9. #include "TextsCore.h"
  10. #include "HelpCore.h"
  11. #include "CoreMain.h"
  12. #include <StrUtils.hpp>
  13. #ifndef AUTO_WINSOCK
  14. #include <winsock2.h>
  15. #endif
  16. #include <ws2ipdef.h>
  17. //---------------------------------------------------------------------------
  18. #pragma package(smart_init)
  19. //---------------------------------------------------------------------------
  20. #define MAX_BUFSIZE 32768
  21. //---------------------------------------------------------------------------
  22. const wchar_t HostKeyDelimiter = L';';
  23. static std::unique_ptr<TCriticalSection> PuttyStorageSection(TraceInitPtr(new TCriticalSection()));
  24. //---------------------------------------------------------------------------
  25. struct TPuttyTranslation
  26. {
  27. const wchar_t * Original;
  28. int Translation;
  29. UnicodeString HelpKeyword;
  30. };
  31. //---------------------------------------------------------------------------
  32. struct ScpLogPolicy : public LogPolicy
  33. {
  34. TSecureShell * SecureShell;
  35. struct Seat * Seat;
  36. };
  37. //---------------------------------------------------------------------------
  38. Seat * get_log_seat(LogContext * logctx)
  39. {
  40. ScpLogPolicy * ALogPolicy = static_cast<ScpLogPolicy *>(log_get_logpolicy(logctx));
  41. return ALogPolicy->Seat;
  42. }
  43. //---------------------------------------------------------------------------
  44. struct callback_set * get_log_callback_set(LogContext * logctx)
  45. {
  46. ScpLogPolicy * ALogPolicy = static_cast<ScpLogPolicy *>(log_get_logpolicy(logctx));
  47. return ALogPolicy->SecureShell->GetCallbackSet();
  48. }
  49. //---------------------------------------------------------------------------
  50. __fastcall TSecureShell::TSecureShell(TSessionUI* UI,
  51. TSessionData * SessionData, TSessionLog * Log, TConfiguration * Configuration)
  52. {
  53. FUI = UI;
  54. FSessionData = SessionData;
  55. FLog = Log;
  56. FConfiguration = Configuration;
  57. FActive = false;
  58. FWaiting = 0;
  59. FOpened = false;
  60. FSshImplementation = sshiUnknown;
  61. OutPtr = NULL;
  62. Pending = NULL;
  63. FBackendHandle = NULL;
  64. FLogPolicy = NULL;
  65. FSeat = NULL;
  66. FLogCtx = NULL;
  67. ResetConnection();
  68. FOnCaptureOutput = NULL;
  69. FOnReceive = NULL;
  70. FSocket = INVALID_SOCKET;
  71. FSocketEvent = CreateEvent(NULL, false, false, NULL);
  72. FFrozen = false;
  73. FSimple = false;
  74. FCollectPrivateKeyUsage = false;
  75. FWaitingForData = 0;
  76. FCallbackSet = new callback_set();
  77. memset(FCallbackSet, 0, sizeof(*FCallbackSet));
  78. FCallbackSet->ready_event = INVALID_HANDLE_VALUE;
  79. }
  80. //---------------------------------------------------------------------------
  81. __fastcall TSecureShell::~TSecureShell()
  82. {
  83. DebugAssert(FWaiting == 0);
  84. if (Active)
  85. {
  86. Close();
  87. }
  88. ResetConnection();
  89. CloseHandle(FSocketEvent);
  90. delete FCallbackSet;
  91. }
  92. //---------------------------------------------------------------------------
  93. void __fastcall TSecureShell::ResetConnection()
  94. {
  95. FreeBackend();
  96. ClearStdError();
  97. PendLen = 0;
  98. PendSize = 0;
  99. sfree(Pending);
  100. Pending = NULL;
  101. FCWriteTemp = L"";
  102. ResetSessionInfo();
  103. FAuthenticating = false;
  104. FAuthenticated = false;
  105. FStoredPasswordTried = false;
  106. FStoredPasswordTriedForKI = false;
  107. FStoredPassphraseTried = false;
  108. delete FLogPolicy;
  109. FLogPolicy = NULL;
  110. delete FSeat;
  111. FSeat = NULL;
  112. if (FLogCtx != NULL)
  113. {
  114. log_free(FLogCtx);
  115. }
  116. FLogCtx = NULL;
  117. FClosed = false;
  118. FLoggedKnownHostKeys.clear();
  119. }
  120. //---------------------------------------------------------------------------
  121. void __fastcall TSecureShell::ResetSessionInfo()
  122. {
  123. FSessionInfoValid = false;
  124. }
  125. //---------------------------------------------------------------------------
  126. inline void __fastcall TSecureShell::UpdateSessionInfo()
  127. {
  128. if (!FSessionInfoValid)
  129. {
  130. DebugAssert(get_ssh_version(FBackendHandle) == 2);
  131. FSessionInfo.ProtocolBaseName = L"SSH";
  132. FSessionInfo.ProtocolName =
  133. FORMAT(L"%s-%d", (FSessionInfo.ProtocolBaseName, get_ssh_version(FBackendHandle)));
  134. FSessionInfo.SecurityProtocolName = FSessionInfo.ProtocolName;
  135. FSessionInfo.CSCipher = GetCipherName(get_cscipher(FBackendHandle));
  136. FSessionInfo.SCCipher = GetCipherName(get_sccipher(FBackendHandle));
  137. FSessionInfo.CSCompression = GetCompressorName(get_cscomp(FBackendHandle));
  138. FSessionInfo.SCCompression = GetDecompressorName(get_sccomp(FBackendHandle));
  139. FSessionInfoValid = true;
  140. }
  141. }
  142. //---------------------------------------------------------------------------
  143. const TSessionInfo & __fastcall TSecureShell::GetSessionInfo()
  144. {
  145. if (!FSessionInfoValid)
  146. {
  147. UpdateSessionInfo();
  148. }
  149. return FSessionInfo;
  150. }
  151. //---------------------------------------------------------------------
  152. void __fastcall TSecureShell::GetHostKeyFingerprint(UnicodeString & SHA256, UnicodeString & MD5)
  153. {
  154. SHA256 = FSessionInfo.HostKeyFingerprintSHA256;
  155. MD5 = FSessionInfo.HostKeyFingerprintMD5;
  156. }
  157. //---------------------------------------------------------------------
  158. Conf * __fastcall TSecureShell::StoreToConfig(TSessionData * Data, bool Simple)
  159. {
  160. Conf * conf = conf_new();
  161. PuttyDefaults(conf);
  162. // user-configurable settings
  163. conf_set_str(conf, CONF_host, AnsiString(Data->HostNameExpanded).c_str());
  164. conf_set_str(conf, CONF_username, UTF8String(Data->UserNameExpanded).c_str());
  165. conf_set_int(conf, CONF_port, Data->PortNumber);
  166. conf_set_int(conf, CONF_protocol, PROT_SSH);
  167. conf_set_bool(conf, CONF_change_password, Data->ChangePassword);
  168. // always set 0, as we will handle keepalives ourselves to avoid
  169. // multi-threaded issues in putty timer list
  170. conf_set_int(conf, CONF_ping_interval, 0);
  171. conf_set_bool(conf, CONF_compression, Data->Compression);
  172. conf_set_bool(conf, CONF_tryagent, Data->TryAgent);
  173. conf_set_bool(conf, CONF_agentfwd, Data->AgentFwd);
  174. conf_set_int(conf, CONF_addressfamily, Data->AddressFamily);
  175. conf_set_str(conf, CONF_ssh_rekey_data, AnsiString(Data->RekeyData).c_str());
  176. conf_set_int(conf, CONF_ssh_rekey_time, Data->RekeyTime);
  177. DebugAssert(CIPHER_MAX == CIPHER_COUNT);
  178. for (int c = 0; c < CIPHER_COUNT; c++)
  179. {
  180. int pcipher;
  181. // Update also CollectUsage
  182. switch (Data->Cipher[c]) {
  183. case cipWarn: pcipher = CIPHER_WARN; break;
  184. case cip3DES: pcipher = CIPHER_3DES; break;
  185. case cipBlowfish: pcipher = CIPHER_BLOWFISH; break;
  186. case cipAES: pcipher = CIPHER_AES; break;
  187. case cipDES: pcipher = CIPHER_DES; break;
  188. case cipArcfour: pcipher = CIPHER_ARCFOUR; break;
  189. case cipChaCha20: pcipher = CIPHER_CHACHA20; break;
  190. case cipAESGCM: pcipher = CIPHER_AESGCM; break;
  191. default: DebugFail();
  192. }
  193. conf_set_int_int(conf, CONF_ssh_cipherlist, c, pcipher);
  194. }
  195. DebugAssert(KEX_MAX == KEX_COUNT);
  196. for (int k = 0; k < KEX_COUNT; k++)
  197. {
  198. int pkex;
  199. switch (Data->Kex[k]) {
  200. case kexWarn: pkex = KEX_WARN; break;
  201. case kexDHGroup1: pkex = KEX_DHGROUP1; break;
  202. case kexDHGroup14: pkex = KEX_DHGROUP14; break;
  203. case kexDHGroup15: pkex = KEX_DHGROUP15; break;
  204. case kexDHGroup16: pkex = KEX_DHGROUP16; break;
  205. case kexDHGroup17: pkex = KEX_DHGROUP17; break;
  206. case kexDHGroup18: pkex = KEX_DHGROUP18; break;
  207. case kexDHGEx: pkex = KEX_DHGEX; break;
  208. case kexRSA: pkex = KEX_RSA; break;
  209. case kexECDH: pkex = KEX_ECDH; break;
  210. case kexNTRUHybrid: pkex = KEX_NTRU_HYBRID; break;
  211. default: DebugFail();
  212. }
  213. conf_set_int_int(conf, CONF_ssh_kexlist, k, pkex);
  214. }
  215. DebugAssert(HK_MAX == HOSTKEY_COUNT);
  216. for (int h = 0; h < HOSTKEY_COUNT; h++)
  217. {
  218. int phk = HostKeyToPutty(Data->HostKeys[h]);
  219. conf_set_int_int(conf, CONF_ssh_hklist, h, phk);
  220. }
  221. DebugAssert(ngsslibs == GSSLIB_COUNT);
  222. for (int g = 0; g < GSSLIB_COUNT; g++)
  223. {
  224. int pgsslib;
  225. switch (Data->GssLib[g]) {
  226. case gssGssApi32: pgsslib = 0; break;
  227. case gssSspi: pgsslib = 1; break;
  228. case gssCustom: pgsslib = 2; break;
  229. default: DebugFail();
  230. }
  231. conf_set_int_int(conf, CONF_ssh_gsslist, g, pgsslib);
  232. }
  233. Filename * GssLibCustomFileName = filename_from_str(UTF8String(Data->GssLibCustom).c_str());
  234. conf_set_filename(conf, CONF_ssh_gss_custom, GssLibCustomFileName);
  235. filename_free(GssLibCustomFileName);
  236. Filename * AFileName = filename_from_str(UTF8String(Data->ResolvePublicKeyFile()).c_str());
  237. conf_set_filename(conf, CONF_keyfile, AFileName);
  238. filename_free(AFileName);
  239. AFileName = filename_from_str(UTF8String(ExpandEnvironmentVariables(Data->DetachedCertificate)).c_str());
  240. conf_set_filename(conf, CONF_detached_cert, AFileName);
  241. filename_free(AFileName);
  242. conf_set_bool(conf, CONF_ssh2_des_cbc, Data->Ssh2DES);
  243. conf_set_bool(conf, CONF_ssh_no_userauth, Data->SshNoUserAuth);
  244. conf_set_bool(conf, CONF_try_ki_auth, Data->AuthKI);
  245. conf_set_bool(conf, CONF_try_gssapi_auth, Data->AuthGSSAPI);
  246. conf_set_bool(conf, CONF_try_gssapi_kex, Data->AuthGSSAPIKEX);
  247. conf_set_bool(conf, CONF_gssapifwd, Data->GSSAPIFwdTGT);
  248. conf_set_bool(conf, CONF_change_username, Data->ChangeUsername);
  249. conf_set_int(conf, CONF_proxy_type, Data->ProxyMethod);
  250. conf_set_str(conf, CONF_proxy_host, AnsiString(Data->ProxyHost).c_str());
  251. conf_set_int(conf, CONF_proxy_port, Data->ProxyPort);
  252. conf_set_str(conf, CONF_proxy_username, UTF8String(Data->ProxyUsername).c_str());
  253. conf_set_str(conf, CONF_proxy_password, UTF8String(Data->ProxyPassword).c_str());
  254. if (Data->ProxyMethod == pmCmd)
  255. {
  256. conf_set_str(conf, CONF_proxy_telnet_command, AnsiString(Data->ProxyLocalCommand).c_str());
  257. }
  258. else
  259. {
  260. conf_set_str(conf, CONF_proxy_telnet_command, AnsiString(Data->ProxyTelnetCommand).c_str());
  261. }
  262. conf_set_int(conf, CONF_proxy_dns, Data->ProxyDNS);
  263. conf_set_bool(conf, CONF_even_proxy_localhost, Data->ProxyLocalhost);
  264. conf_set_int(conf, CONF_sshbug_hmac2, Data->Bug[sbHMAC2]);
  265. conf_set_int(conf, CONF_sshbug_derivekey2, Data->Bug[sbDeriveKey2]);
  266. conf_set_int(conf, CONF_sshbug_rsapad2, Data->Bug[sbRSAPad2]);
  267. conf_set_int(conf, CONF_sshbug_rekey2, Data->Bug[sbRekey2]);
  268. conf_set_int(conf, CONF_sshbug_pksessid2, Data->Bug[sbPKSessID2]);
  269. conf_set_int(conf, CONF_sshbug_maxpkt2, Data->Bug[sbMaxPkt2]);
  270. conf_set_int(conf, CONF_sshbug_ignore2, Data->Bug[sbIgnore2]);
  271. conf_set_int(conf, CONF_sshbug_winadj, Data->Bug[sbWinAdj]);
  272. conf_set_int(conf, CONF_sshbug_oldgex2, Data->Bug[sbOldGex2]);
  273. conf_set_int(conf, CONF_sshbug_chanreq, Data->Bug[sbChanReq]);
  274. if (!Data->TunnelPortFwd.IsEmpty())
  275. {
  276. DebugAssert(!Simple);
  277. UnicodeString TunnelPortFwd = Data->TunnelPortFwd;
  278. while (!TunnelPortFwd.IsEmpty())
  279. {
  280. UnicodeString Buf = CutToChar(TunnelPortFwd, L',', true);
  281. AnsiString Key = AnsiString(CutToChar(Buf, L'\t', true));
  282. AnsiString Value = AnsiString(Buf);
  283. conf_set_str_str(conf, CONF_portfwd, Key.c_str(), Value.c_str());
  284. }
  285. // when setting up a tunnel, do not open shell/sftp
  286. conf_set_bool(conf, CONF_ssh_no_shell, TRUE);
  287. }
  288. else
  289. {
  290. DebugAssert(Simple);
  291. conf_set_bool(conf, CONF_ssh_simple, Data->SshSimple && Simple);
  292. if (Data->FSProtocol == fsSCPonly)
  293. {
  294. conf_set_bool(conf, CONF_ssh_subsys, FALSE);
  295. if (Data->Shell.IsEmpty())
  296. {
  297. // Following forces Putty to open default shell
  298. // see ssh.c: do_ssh2_authconn() and ssh1_protocol()
  299. conf_set_str(conf, CONF_remote_cmd, "");
  300. }
  301. else
  302. {
  303. conf_set_str(conf, CONF_remote_cmd, AnsiString(Data->Shell).c_str());
  304. }
  305. conf_set_bool(conf, CONF_force_remote_cmd2, 0);
  306. }
  307. else
  308. {
  309. if (Data->SftpServer.IsEmpty())
  310. {
  311. conf_set_bool(conf, CONF_ssh_subsys, TRUE);
  312. conf_set_str(conf, CONF_remote_cmd, "sftp");
  313. }
  314. else
  315. {
  316. conf_set_bool(conf, CONF_ssh_subsys, FALSE);
  317. conf_set_str(conf, CONF_remote_cmd, AnsiString(Data->SftpServer).c_str());
  318. }
  319. if (Data->FSProtocol != fsSFTPonly)
  320. {
  321. conf_set_bool(conf, CONF_ssh_subsys2, FALSE);
  322. if (Data->Shell.IsEmpty())
  323. {
  324. // Following forces Putty to open default shell
  325. // see ssh.c: do_ssh2_authconn() and ssh1_protocol()
  326. conf_set_str(conf, CONF_remote_cmd2, "");
  327. // PuTTY ignores CONF_remote_cmd2 set to "",
  328. // so we have to enforce it
  329. // (CONF_force_remote_cmd2 is our config option)
  330. conf_set_bool(conf, CONF_force_remote_cmd2, 1);
  331. }
  332. else
  333. {
  334. conf_set_str(conf, CONF_remote_cmd2, AnsiString(Data->Shell).c_str());
  335. }
  336. }
  337. else
  338. {
  339. if (Data->SftpServer.IsEmpty())
  340. {
  341. // see psftp_connect() from psftp.c
  342. conf_set_bool(conf, CONF_ssh_subsys2, FALSE);
  343. conf_set_str(conf, CONF_remote_cmd2,
  344. "test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\n"
  345. "test -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\n"
  346. "exec sftp-server");
  347. }
  348. else
  349. {
  350. conf_set_bool(conf, CONF_force_remote_cmd2, 0);
  351. }
  352. }
  353. }
  354. }
  355. conf_set_int(conf, CONF_connect_timeout, Data->Timeout * MSecsPerSec);
  356. conf_set_int(conf, CONF_sndbuf, Data->SendBuf);
  357. conf_set_str(conf, CONF_srcaddr, AnsiString(Data->SourceAddress).c_str());
  358. // permanent settings
  359. conf_set_bool(conf, CONF_nopty, TRUE);
  360. conf_set_bool(conf, CONF_tcp_keepalives, 0);
  361. conf_set_bool(conf, CONF_ssh_show_banner, TRUE);
  362. conf_set_int(conf, CONF_proxy_log_to_term, FORCE_OFF);
  363. conf_set_str(conf, CONF_loghost, AnsiString(Data->LogicalHostName).c_str());
  364. return conf;
  365. }
  366. //---------------------------------------------------------------------------
  367. static void eventlog(LogPolicy * ALogPolicy, const char * string)
  368. {
  369. static_cast<ScpLogPolicy *>(ALogPolicy)->SecureShell->PuttyLogEvent(string);
  370. }
  371. //---------------------------------------------------------------------------
  372. static const LogPolicyVtable ScpLogPolicyVTable =
  373. {
  374. eventlog,
  375. NULL, // Should never be called
  376. NULL, // Should never be called
  377. null_lp_verbose_no, // Should never be called
  378. };
  379. //---------------------------------------------------------------------------
  380. void __fastcall TSecureShell::Open()
  381. {
  382. ResetConnection();
  383. FAuthenticating = false;
  384. FAuthenticated = false;
  385. FLastSendBufferUpdate = 0;
  386. // do not use UTF-8 until decided otherwise (see TSCPFileSystem::DetectUtf())
  387. FUtfStrings = false;
  388. FActive = false;
  389. FAuthenticationLog = L"";
  390. FNoConnectionResponse = false;
  391. FUI->Information(LoadStr(STATUS_LOOKUPHOST), true);
  392. try
  393. {
  394. char * RealHost;
  395. FreeBackend(); // in case we are reconnecting
  396. const char * InitError;
  397. Conf * conf = StoreToConfig(FSessionData, Simple);
  398. FSendBuf = FSessionData->SendBuf;
  399. FSeat = new ScpSeat(this);
  400. FLogPolicy = new ScpLogPolicy();
  401. FLogPolicy->vt = &ScpLogPolicyVTable;
  402. FLogPolicy->SecureShell = this;
  403. FLogPolicy->Seat = FSeat;
  404. try
  405. {
  406. FLogCtx = log_init(FLogPolicy, conf);
  407. InitError = backend_init(&ssh_backend, FSeat, &FBackendHandle, FLogCtx, conf,
  408. AnsiString(FSessionData->HostNameExpanded).c_str(), FSessionData->PortNumber, &RealHost,
  409. (FSessionData->TcpNoDelay ? 1 : 0),
  410. conf_get_bool(conf, CONF_tcp_keepalives));
  411. }
  412. __finally
  413. {
  414. conf_free(conf);
  415. }
  416. sfree(RealHost);
  417. if (InitError)
  418. {
  419. PuttyFatalError(InitError);
  420. }
  421. FUI->Information(LoadStr(STATUS_CONNECT), true);
  422. if (!Active && DebugAlwaysTrue(HasLocalProxy()))
  423. {
  424. FActive = true;
  425. }
  426. Init();
  427. CheckConnection(CONNECTION_FAILED);
  428. }
  429. catch (Exception & E)
  430. {
  431. if (FNoConnectionResponse && TryFtp())
  432. {
  433. Configuration->Usage->Inc(L"ProtocolSuggestions");
  434. // HELP_FTP_SUGGESTION won't be used as all errors that set
  435. // FNoConnectionResponse have already their own help keyword
  436. FUI->FatalError(&E, LoadStr(FTP_SUGGESTION), HELP_FTP_SUGGESTION);
  437. }
  438. else
  439. {
  440. throw;
  441. }
  442. }
  443. FLastDataSent = Now();
  444. FSessionInfo.LoginTime = Now();
  445. FAuthenticating = false;
  446. FAuthenticated = true;
  447. FUI->Information(LoadStr(STATUS_AUTHENTICATED), true);
  448. ResetSessionInfo();
  449. DebugAssert(!FSessionInfo.SshImplementation.IsEmpty());
  450. FOpened = true;
  451. UnicodeString SshImplementation = GetSessionInfo().SshImplementation;
  452. if (IsOpenSSH(SshImplementation))
  453. {
  454. FSshImplementation = sshiOpenSSH;
  455. }
  456. // e.g. "mod_sftp/0.9.8"
  457. else if (SshImplementation.Pos(L"mod_sftp") == 1)
  458. {
  459. FSshImplementation = sshiProFTPD;
  460. }
  461. // e.g. "5.25 FlowSsh: Bitvise SSH Server (WinSSHD) 6.07: free only for personal non-commercial use"
  462. else if (SshImplementation.Pos(L"FlowSsh") > 0)
  463. {
  464. FSshImplementation = sshiBitvise;
  465. }
  466. // e.g. "srtSSHServer_10.00"
  467. else if (ContainsText(SshImplementation, L"srtSSHServer"))
  468. {
  469. FSshImplementation = sshiTitan;
  470. }
  471. else if (ContainsText(FSessionInfo.SshImplementation, L"OpenVMS"))
  472. {
  473. FSshImplementation = sshiOpenVMS;
  474. }
  475. else if (ContainsText(FSessionInfo.SshImplementation, L"CerberusFTPServer"))
  476. {
  477. FSshImplementation = sshiCerberus;
  478. }
  479. else
  480. {
  481. FSshImplementation = sshiUnknown;
  482. }
  483. }
  484. //---------------------------------------------------------------------------
  485. bool __fastcall TSecureShell::TryFtp()
  486. {
  487. bool Result;
  488. if (!FConfiguration->TryFtpWhenSshFails)
  489. {
  490. Result = false;
  491. }
  492. else
  493. {
  494. if (((FSessionData->FSProtocol != fsSFTP) && (FSessionData->FSProtocol != fsSFTPonly)) ||
  495. (FSessionData->PortNumber != SshPortNumber) ||
  496. FSessionData->Tunnel || (FSessionData->ProxyMethod != ::pmNone))
  497. {
  498. LogEvent(L"Using non-standard protocol or port, tunnel or proxy, will not knock FTP port.");
  499. Result = false;
  500. }
  501. else
  502. {
  503. LogEvent(L"Knocking FTP port.");
  504. SOCKET Socket = socket(AF_INET, SOCK_STREAM, 0);
  505. Result = (Socket != INVALID_SOCKET);
  506. if (Result)
  507. {
  508. LPHOSTENT HostEntry = gethostbyname(AnsiString(FSessionData->HostNameExpanded).c_str());
  509. Result = (HostEntry != NULL);
  510. if (Result)
  511. {
  512. SOCKADDR_IN Address;
  513. memset(&Address, 0, sizeof(Address));
  514. Address.sin_family = AF_INET;
  515. int Port = FtpPortNumber;
  516. Address.sin_port = htons(static_cast<short>(Port));
  517. Address.sin_addr.s_addr = *((unsigned long *)*HostEntry->h_addr_list);
  518. HANDLE Event = CreateEvent(NULL, false, false, NULL);
  519. Result = (WSAEventSelect(Socket, (WSAEVENT)Event, FD_CONNECT | FD_CLOSE) != SOCKET_ERROR);
  520. if (Result)
  521. {
  522. Result =
  523. (connect(Socket, reinterpret_cast<sockaddr *>(&Address), sizeof(Address)) != SOCKET_ERROR) ||
  524. (WSAGetLastError() == WSAEWOULDBLOCK);
  525. if (Result)
  526. {
  527. Result = (WaitForSingleObject(Event, 2000) == WAIT_OBJECT_0);
  528. }
  529. }
  530. CloseHandle(Event);
  531. }
  532. closesocket(Socket);
  533. }
  534. if (Result)
  535. {
  536. LogEvent(L"FTP port opened, will suggest using FTP protocol.");
  537. }
  538. else
  539. {
  540. LogEvent(L"FTP port did not open.");
  541. }
  542. }
  543. }
  544. return Result;
  545. }
  546. //---------------------------------------------------------------------------
  547. void __fastcall TSecureShell::Init()
  548. {
  549. try
  550. {
  551. try
  552. {
  553. // Recent pscp checks backend_exitcode(FBackendHandle) in the loop
  554. // (see comment in putty revision 8110)
  555. // It seems that we do not need to do it.
  556. while (!winscp_query(FBackendHandle, WINSCP_QUERY_MAIN_CHANNEL))
  557. {
  558. if (Configuration->ActualLogProtocol >= 1)
  559. {
  560. LogEvent(L"Waiting for the server to continue with the initialization");
  561. }
  562. WaitForData();
  563. }
  564. }
  565. catch(Exception & E)
  566. {
  567. if (FAuthenticating && !FAuthenticationLog.IsEmpty())
  568. {
  569. FUI->FatalError(&E, FMTLOAD(AUTHENTICATION_LOG, (FAuthenticationLog)));
  570. }
  571. else
  572. {
  573. throw;
  574. }
  575. }
  576. }
  577. catch(Exception & E)
  578. {
  579. if (FAuthenticating)
  580. {
  581. FUI->FatalError(&E, LoadStr(AUTHENTICATION_FAILED));
  582. }
  583. else
  584. {
  585. throw;
  586. }
  587. }
  588. }
  589. //---------------------------------------------------------------------------
  590. struct callback_set * TSecureShell::GetCallbackSet()
  591. {
  592. return FCallbackSet;
  593. }
  594. //---------------------------------------------------------------------------
  595. UnicodeString __fastcall TSecureShell::ConvertFromPutty(const char * Str, int Length)
  596. {
  597. int BomLength = strlen(WINSCP_BOM);
  598. if ((Length >= BomLength) &&
  599. (strncmp(Str, WINSCP_BOM, BomLength) == 0))
  600. {
  601. return UTF8ToString(Str + BomLength, Length - BomLength);
  602. }
  603. else
  604. {
  605. return AnsiToString(Str, Length);
  606. }
  607. }
  608. //---------------------------------------------------------------------------
  609. const UnicodeString ServerVersionMsg(L"Remote version: ");
  610. const UnicodeString ForwardingFailureMsg(L"Forwarded connection refused by remote");
  611. const UnicodeString LocalPortMsg(L"Local port ");
  612. const UnicodeString ForwadingToMsg(L" forwarding to ");
  613. const UnicodeString FailedMsg(L" failed:");
  614. //---------------------------------------------------------------------------
  615. void __fastcall TSecureShell::PuttyLogEvent(const char * AStr)
  616. {
  617. UnicodeString Str = ConvertFromPutty(AStr, strlen(AStr));
  618. // Gross hack
  619. if (StartsStr(ServerVersionMsg, Str))
  620. {
  621. FSessionInfo.SshVersionString = RightStr(Str, Str.Length() - ServerVersionMsg.Length());
  622. const wchar_t * Ptr = wcschr(FSessionInfo.SshVersionString.c_str(), L'-');
  623. if (Ptr != NULL)
  624. {
  625. Ptr = wcschr(Ptr + 1, L'-');
  626. }
  627. FSessionInfo.SshImplementation = (Ptr != NULL) ? Ptr + 1 : L"";
  628. }
  629. else if (StartsStr(ForwardingFailureMsg, Str))
  630. {
  631. if (ForwardingFailureMsg == Str)
  632. {
  633. FLastTunnelError = Str;
  634. }
  635. else
  636. {
  637. FLastTunnelError = RightStr(Str, Str.Length() - ForwardingFailureMsg.Length());
  638. UnicodeString Prefix(L": ");
  639. if (StartsStr(Prefix, FLastTunnelError))
  640. {
  641. FLastTunnelError.Delete(1, Prefix.Length());
  642. }
  643. static const TPuttyTranslation Translation[] = {
  644. { L"Administratively prohibited [%]", PFWD_TRANSL_ADMIN },
  645. { L"Connect failed [%]", PFWD_TRANSL_CONNECT },
  646. };
  647. TranslatePuttyMessage(Translation, LENOF(Translation), FLastTunnelError);
  648. }
  649. }
  650. else if (StartsStr(LocalPortMsg, Str) && ContainsStr(Str, ForwadingToMsg) && ContainsStr(Str, FailedMsg))
  651. {
  652. FLastTunnelError = Str;
  653. }
  654. LogEvent(Str);
  655. }
  656. //---------------------------------------------------------------------------
  657. TPromptKind __fastcall TSecureShell::IdentifyPromptKind(UnicodeString & Name)
  658. {
  659. // beware of changing order
  660. static const TPuttyTranslation NameTranslation[] = {
  661. { L"SSH login name", USERNAME_TITLE },
  662. { L"SSH key passphrase", PASSPHRASE_TITLE },
  663. { L"SSH TIS authentication", SERVER_PROMPT_TITLE },
  664. { L"SSH CryptoCard authentication", SERVER_PROMPT_TITLE },
  665. { L"SSH server: %", SERVER_PROMPT_TITLE2 },
  666. { L"SSH server authentication", SERVER_PROMPT_TITLE },
  667. { L"SSH password", PASSWORD_TITLE },
  668. { L"New SSH password", NEW_PASSWORD_TITLE },
  669. { L"SOCKS proxy authentication", PROXY_AUTH_TITLE },
  670. { L"HTTP proxy authentication", PROXY_AUTH_TITLE },
  671. };
  672. int Index = TranslatePuttyMessage(NameTranslation, LENOF(NameTranslation), Name);
  673. TPromptKind PromptKind;
  674. if (Index == 0) // username
  675. {
  676. PromptKind = pkUserName;
  677. }
  678. else if (Index == 1) // passphrase
  679. {
  680. PromptKind = pkPassphrase;
  681. }
  682. else if (Index == 2) // TIS
  683. {
  684. PromptKind = pkTIS;
  685. }
  686. else if (Index == 3) // CryptoCard
  687. {
  688. PromptKind = pkCryptoCard;
  689. }
  690. else if ((Index == 4) || (Index == 5))
  691. {
  692. PromptKind = pkKeybInteractive;
  693. }
  694. else if (Index == 6)
  695. {
  696. PromptKind = pkPassword;
  697. }
  698. else if (Index == 7)
  699. {
  700. PromptKind = pkNewPassword;
  701. }
  702. else if ((Index == 8) || (Index == 9))
  703. {
  704. PromptKind = pkProxyAuth;
  705. }
  706. else
  707. {
  708. PromptKind = pkPrompt;
  709. DebugFail();
  710. }
  711. return PromptKind;
  712. }
  713. //---------------------------------------------------------------------------
  714. bool __fastcall TSecureShell::PromptUser(bool /*ToServer*/,
  715. UnicodeString AName, bool /*NameRequired*/,
  716. UnicodeString Instructions, bool InstructionsRequired,
  717. TStrings * Prompts, TStrings * Results)
  718. {
  719. // there can be zero prompts!
  720. DebugAssert(Results->Count == Prompts->Count);
  721. UnicodeString Name = AName;
  722. TPromptKind PromptKind = IdentifyPromptKind(Name);
  723. const TPuttyTranslation * InstructionTranslation = NULL;
  724. const TPuttyTranslation * PromptTranslation = NULL;
  725. size_t PromptTranslationCount = 1;
  726. UnicodeString PromptDesc;
  727. if (PromptKind == pkUserName)
  728. {
  729. static const TPuttyTranslation UsernamePromptTranslation[] = {
  730. { L"login as: ", USERNAME_PROMPT2 },
  731. };
  732. PromptTranslation = UsernamePromptTranslation;
  733. PromptDesc = L"username";
  734. }
  735. else if (PromptKind == pkPassphrase)
  736. {
  737. static const TPuttyTranslation PassphrasePromptTranslation[] = {
  738. { L"Passphrase for key \"%\": ", PROMPT_KEY_PASSPHRASE },
  739. };
  740. PromptTranslation = PassphrasePromptTranslation;
  741. PromptDesc = L"passphrase";
  742. }
  743. else if (PromptKind == pkTIS)
  744. {
  745. static const TPuttyTranslation TISInstructionTranslation[] = {
  746. { L"Using TIS authentication.%", TIS_INSTRUCTION },
  747. };
  748. static const TPuttyTranslation TISPromptTranslation[] = {
  749. { L"Response: ", PROMPT_PROMPT },
  750. };
  751. InstructionTranslation = TISInstructionTranslation;
  752. PromptTranslation = TISPromptTranslation;
  753. PromptDesc = L"tis";
  754. }
  755. else if (PromptKind == pkCryptoCard)
  756. {
  757. static const TPuttyTranslation CryptoCardInstructionTranslation[] = {
  758. { L"Using CryptoCard authentication.%", CRYPTOCARD_INSTRUCTION },
  759. };
  760. static const TPuttyTranslation CryptoCardPromptTranslation[] = {
  761. { L"Response: ", PROMPT_PROMPT },
  762. };
  763. InstructionTranslation = CryptoCardInstructionTranslation;
  764. PromptTranslation = CryptoCardPromptTranslation;
  765. PromptDesc = L"cryptocard";
  766. }
  767. else if (PromptKind == pkKeybInteractive)
  768. {
  769. static const TPuttyTranslation KeybInteractiveInstructionTranslation[] = {
  770. { L"Using keyboard-interactive authentication.%", KEYBINTER_INSTRUCTION },
  771. };
  772. static const TPuttyTranslation KeybInteractivePromptTranslation[] = {
  773. // as used by Linux-PAM (pam_exec/pam_exec.c, libpam/pam_get_authtok.c,
  774. // pam_unix/pam_unix_auth.c, pam_userdb/pam_userdb.c)
  775. { L"Password: ", PASSWORD_PROMPT },
  776. };
  777. InstructionTranslation = KeybInteractiveInstructionTranslation;
  778. PromptTranslation = KeybInteractivePromptTranslation;
  779. PromptDesc = L"keyboard interactive";
  780. }
  781. else if (PromptKind == pkPassword)
  782. {
  783. DebugAssert(Prompts->Count == 1);
  784. Prompts->Strings[0] = LoadStr(PASSWORD_PROMPT);
  785. PromptDesc = L"password";
  786. }
  787. else if (PromptKind == pkNewPassword)
  788. {
  789. // Can be tested with WS_FTP server
  790. static const TPuttyTranslation NewPasswordPromptTranslation[] = {
  791. { L"Current password (blank for previously entered password): ", NEW_PASSWORD_CURRENT_PROMPT },
  792. { L"Enter new password: ", NEW_PASSWORD_NEW_PROMPT },
  793. { L"Confirm new password: ", NEW_PASSWORD_CONFIRM_PROMPT },
  794. };
  795. PromptTranslation = NewPasswordPromptTranslation;
  796. PromptTranslationCount = LENOF(NewPasswordPromptTranslation);
  797. PromptDesc = L"new password";
  798. }
  799. else if (PromptKind == pkProxyAuth)
  800. {
  801. static const TPuttyTranslation ProxyAuthPromptTranslation[] = {
  802. { L"Proxy username: ", PROXY_AUTH_USERNAME_PROMPT },
  803. { L"Proxy password: ", PROXY_AUTH_PASSWORD_PROMPT },
  804. };
  805. PromptTranslation = ProxyAuthPromptTranslation;
  806. PromptTranslationCount = LENOF(ProxyAuthPromptTranslation);
  807. PromptDesc = L"proxy authentication";
  808. }
  809. else
  810. {
  811. PromptDesc = L"unknown";
  812. DebugFail();
  813. }
  814. UnicodeString InstructionsLog =
  815. (Instructions.IsEmpty() ? UnicodeString(L"<no instructions>") : FORMAT(L"\"%s\"", (Instructions)));
  816. UnicodeString PromptsLog =
  817. (Prompts->Count > 0 ? FORMAT(L"\"%s\"", (Prompts->Strings[0])) : UnicodeString(L"<no prompt>")) +
  818. (Prompts->Count > 1 ? FORMAT(L" + %d more", (Prompts->Count - 1)) : UnicodeString());
  819. LogEvent(FORMAT(L"Prompt (%s, \"%s\", %s, %s)", (PromptDesc, AName, InstructionsLog, PromptsLog)));
  820. Name = Name.Trim();
  821. if (InstructionTranslation != NULL)
  822. {
  823. TranslatePuttyMessage(InstructionTranslation, 1, Instructions);
  824. }
  825. // some servers add leading or trailing blank line to make the prompt look prettier
  826. // on terminal console
  827. Instructions = Instructions.Trim();
  828. for (int Index = 0; Index < Prompts->Count; Index++)
  829. {
  830. UnicodeString Prompt = Prompts->Strings[Index];
  831. if (PromptTranslation != NULL)
  832. {
  833. TranslatePuttyMessage(PromptTranslation, PromptTranslationCount, Prompt);
  834. }
  835. // some servers add leading blank line to make the prompt look prettier
  836. // on terminal console
  837. Prompts->Strings[Index] = Prompt.Trim();
  838. }
  839. bool Result = false;
  840. if ((PromptKind == pkTIS) || (PromptKind == pkCryptoCard) ||
  841. (PromptKind == pkKeybInteractive))
  842. {
  843. if (FSessionData->AuthKIPassword && !FSessionData->Password.IsEmpty() &&
  844. !FStoredPasswordTriedForKI && (Prompts->Count == 1) &&
  845. FLAGCLEAR(int(Prompts->Objects[0]), pupEcho))
  846. {
  847. LogEvent(L"Using stored password.");
  848. FUI->Information(LoadStr(AUTH_PASSWORD), false);
  849. Result = true;
  850. Results->Strings[0] = NormalizeString(FSessionData->Password);
  851. FStoredPasswordTriedForKI = true;
  852. }
  853. else if (Instructions.IsEmpty() && !InstructionsRequired && (Prompts->Count == 0))
  854. {
  855. LogEvent(L"Ignoring empty SSH server authentication request");
  856. Result = true;
  857. }
  858. }
  859. else if (PromptKind == pkPassword)
  860. {
  861. if (!FSessionData->Password.IsEmpty() && !FStoredPasswordTried)
  862. {
  863. LogEvent(L"Using stored password.");
  864. FUI->Information(LoadStr(AUTH_PASSWORD), false);
  865. Result = true;
  866. Results->Strings[0] = NormalizeString(FSessionData->Password);
  867. FStoredPasswordTried = true;
  868. }
  869. }
  870. else if (PromptKind == pkPassphrase)
  871. {
  872. if (!FSessionData->Passphrase.IsEmpty() && !FStoredPassphraseTried)
  873. {
  874. LogEvent(L"Using configured passphrase.");
  875. Result = true;
  876. Results->Strings[0] = FSessionData->Passphrase;
  877. FStoredPassphraseTried = true;
  878. }
  879. }
  880. else if (PromptKind == pkNewPassword)
  881. {
  882. if (FSessionData->ChangePassword)
  883. {
  884. FUI->Information(LoadStr(AUTH_CHANGING_PASSWORD), false);
  885. if (!FSessionData->Password.IsEmpty() && !FSessionData->NewPassword.IsEmpty() && !FStoredPasswordTried)
  886. {
  887. LogEvent(L"Using stored password and new password.");
  888. Result = true;
  889. DebugAssert(Results->Count == 3);
  890. Results->Strings[0] = NormalizeString(FSessionData->Password);
  891. Results->Strings[1] = NormalizeString(FSessionData->NewPassword);
  892. Results->Strings[2] = NormalizeString(FSessionData->NewPassword);
  893. FStoredPasswordTried = true;
  894. }
  895. }
  896. }
  897. if (!Result)
  898. {
  899. LogEvent(L"Prompting user for the credentials.");
  900. Result = FUI->PromptUser(FSessionData,
  901. PromptKind, Name, Instructions, Prompts, Results);
  902. if (!Result)
  903. {
  904. LogEvent(L"Prompt cancelled.");
  905. }
  906. else
  907. {
  908. if ((Prompts->Count >= 1) &&
  909. (FLAGSET(int(Prompts->Objects[0]), pupEcho) || Configuration->LogSensitive))
  910. {
  911. LogEvent(FORMAT(L"Response: \"%s\"", (Results->Strings[0])));
  912. }
  913. else
  914. {
  915. LogEvent("Prompt responded.");
  916. }
  917. if ((PromptKind == pkUserName) && (Prompts->Count == 1))
  918. {
  919. FUserName = Results->Strings[0];
  920. }
  921. }
  922. }
  923. return Result;
  924. }
  925. //---------------------------------------------------------------------------
  926. void __fastcall TSecureShell::GotHostKey()
  927. {
  928. // due to re-key GotHostKey() may be called again later during session
  929. if (!FAuthenticating && !FAuthenticated)
  930. {
  931. FAuthenticating = true;
  932. if (!FSessionData->ChangePassword)
  933. {
  934. FUI->Information(LoadStr(STATUS_AUTHENTICATE), true);
  935. }
  936. }
  937. }
  938. //---------------------------------------------------------------------------
  939. void __fastcall TSecureShell::CWrite(const char * Data, size_t Length)
  940. {
  941. // some messages to stderr may indicate that something has changed with the
  942. // session, so reset the session info
  943. ResetSessionInfo();
  944. // We send only whole line at once, so we have to cache incoming data
  945. FCWriteTemp += DeleteChar(ConvertFromPutty(Data, Length), L'\r');
  946. UnicodeString Line;
  947. // Do we have at least one complete line in std error cache?
  948. while (FCWriteTemp.Pos(L"\n") > 0)
  949. {
  950. UnicodeString Line = CutToChar(FCWriteTemp, L'\n', false);
  951. FLog->Add(llStdError, Line);
  952. if (FAuthenticating)
  953. {
  954. TranslateAuthenticationMessage(Line);
  955. FAuthenticationLog += (FAuthenticationLog.IsEmpty() ? L"" : L"\n") + Line;
  956. }
  957. FUI->Information(Line, false);
  958. }
  959. }
  960. //---------------------------------------------------------------------------
  961. void __fastcall TSecureShell::RegisterReceiveHandler(TNotifyEvent Handler)
  962. {
  963. DebugAssert(FOnReceive == NULL);
  964. FOnReceive = Handler;
  965. }
  966. //---------------------------------------------------------------------------
  967. void __fastcall TSecureShell::UnregisterReceiveHandler(TNotifyEvent Handler)
  968. {
  969. DebugAssert(FOnReceive == Handler);
  970. DebugUsedParam(Handler);
  971. FOnReceive = NULL;
  972. }
  973. //---------------------------------------------------------------------------
  974. void __fastcall TSecureShell::FromBackend(const unsigned char * Data, size_t Length)
  975. {
  976. // Note that we do not apply ConvertFromPutty to Data yet (as opposite to CWrite).
  977. // as there's no use for this atm.
  978. CheckConnection();
  979. if (Configuration->ActualLogProtocol >= 1)
  980. {
  981. LogEvent(FORMAT(L"Received %u bytes", (static_cast<int>(Length))));
  982. }
  983. // Following is taken from scp.c from_backend() and modified
  984. const unsigned char *p = Data;
  985. unsigned Len = Length;
  986. // with event-select mechanism we can now receive data even before we
  987. // actually expect them (OutPtr can be NULL)
  988. if ((OutPtr != NULL) && (OutLen > 0) && (Len > 0))
  989. {
  990. unsigned Used = OutLen;
  991. if (Used > Len) Used = Len;
  992. memmove(OutPtr, p, Used);
  993. OutPtr += Used; OutLen -= Used;
  994. p += Used; Len -= Used;
  995. }
  996. if (Len > 0)
  997. {
  998. if (PendSize < PendLen + Len)
  999. {
  1000. PendSize = PendLen + Len + 4096;
  1001. Pending = (unsigned char *)
  1002. (Pending ? srealloc(Pending, PendSize) : smalloc(PendSize));
  1003. if (!Pending) FatalError(L"Out of memory");
  1004. }
  1005. memmove(Pending + PendLen, p, Len);
  1006. PendLen += Len;
  1007. }
  1008. if (FOnReceive != NULL)
  1009. {
  1010. if (!FFrozen)
  1011. {
  1012. FFrozen = true;
  1013. try
  1014. {
  1015. do
  1016. {
  1017. FDataWhileFrozen = false;
  1018. FOnReceive(NULL);
  1019. }
  1020. while (FDataWhileFrozen);
  1021. }
  1022. __finally
  1023. {
  1024. FFrozen = false;
  1025. }
  1026. }
  1027. else
  1028. {
  1029. FDataWhileFrozen = true;
  1030. }
  1031. }
  1032. }
  1033. //---------------------------------------------------------------------------
  1034. bool __fastcall TSecureShell::Peek(unsigned char *& Buf, int Len)
  1035. {
  1036. bool Result = (int(PendLen) >= Len);
  1037. if (Result)
  1038. {
  1039. Buf = Pending;
  1040. }
  1041. return Result;
  1042. }
  1043. //---------------------------------------------------------------------------
  1044. Integer __fastcall TSecureShell::Receive(unsigned char * Buf, Integer Len)
  1045. {
  1046. CheckConnection();
  1047. if (Len > 0)
  1048. {
  1049. // Following is taken from scp.c ssh_scp_recv() and modified
  1050. OutPtr = Buf;
  1051. OutLen = Len;
  1052. try
  1053. {
  1054. /*
  1055. * See if the pending-input block contains some of what we
  1056. * need.
  1057. */
  1058. if (PendLen > 0)
  1059. {
  1060. unsigned PendUsed = PendLen;
  1061. if (PendUsed > OutLen)
  1062. {
  1063. PendUsed = OutLen;
  1064. }
  1065. memmove(OutPtr, Pending, PendUsed);
  1066. memmove(Pending, Pending + PendUsed, PendLen - PendUsed);
  1067. OutPtr += PendUsed;
  1068. OutLen -= PendUsed;
  1069. PendLen -= PendUsed;
  1070. if (PendLen == 0)
  1071. {
  1072. PendSize = 0;
  1073. sfree(Pending);
  1074. Pending = NULL;
  1075. }
  1076. }
  1077. while (OutLen > 0)
  1078. {
  1079. if (Configuration->ActualLogProtocol >= 1)
  1080. {
  1081. LogEvent(FORMAT(L"Waiting for another %u bytes", (static_cast<int>(OutLen))));
  1082. }
  1083. WaitForData();
  1084. }
  1085. // This seems ambiguous
  1086. if (Len <= 0) FatalError(LoadStr(LOST_CONNECTION));
  1087. }
  1088. __finally
  1089. {
  1090. OutPtr = NULL;
  1091. }
  1092. }
  1093. if (Configuration->ActualLogProtocol >= 1)
  1094. {
  1095. LogEvent(FORMAT(L"Read %u bytes (%d pending)",
  1096. (static_cast<int>(Len), static_cast<int>(PendLen))));
  1097. }
  1098. return Len;
  1099. }
  1100. //---------------------------------------------------------------------------
  1101. UnicodeString __fastcall TSecureShell::ReceiveLine()
  1102. {
  1103. unsigned Index;
  1104. RawByteString Line;
  1105. Boolean EOL = False;
  1106. do
  1107. {
  1108. // If there is any buffer of received chars
  1109. if (PendLen > 0)
  1110. {
  1111. Index = 0;
  1112. // Repeat until we walk thru whole buffer or reach end-of-line
  1113. while ((Index < PendLen) && (!Index || (Pending[Index-1] != '\n')))
  1114. {
  1115. Index++;
  1116. }
  1117. EOL = (Boolean)(Index && (Pending[Index-1] == '\n'));
  1118. Integer PrevLen = Line.Length();
  1119. Line.SetLength(PrevLen + Index);
  1120. Receive(reinterpret_cast<unsigned char *>(Line.c_str()) + PrevLen, Index);
  1121. }
  1122. // If buffer don't contain end-of-line character
  1123. // we read one more which causes receiving new buffer of chars
  1124. if (!EOL)
  1125. {
  1126. unsigned char Ch;
  1127. Receive(&Ch, 1);
  1128. Line += static_cast<char>(Ch);
  1129. EOL = (static_cast<char>(Ch) == '\n');
  1130. }
  1131. }
  1132. while (!EOL);
  1133. // We don't want end-of-line character
  1134. Line.SetLength(Line.Length()-1);
  1135. UnicodeString Result = ConvertInput(Line);
  1136. CaptureOutput(llOutput, Result);
  1137. return Result;
  1138. }
  1139. //---------------------------------------------------------------------------
  1140. UnicodeString __fastcall TSecureShell::ConvertInput(const RawByteString & Input)
  1141. {
  1142. UnicodeString Result;
  1143. if (UtfStrings)
  1144. {
  1145. Result = UTF8ToString(Input);
  1146. }
  1147. else
  1148. {
  1149. Result = AnsiToString(Input);
  1150. }
  1151. return Result;
  1152. }
  1153. //---------------------------------------------------------------------------
  1154. void __fastcall TSecureShell::SendSpecial(int Code)
  1155. {
  1156. if (Configuration->ActualLogProtocol >= 0)
  1157. {
  1158. LogEvent(FORMAT(L"Sending special code: %d", (Code)));
  1159. }
  1160. CheckConnection();
  1161. backend_special(FBackendHandle, (SessionSpecialCode)Code, 0);
  1162. CheckConnection();
  1163. FLastDataSent = Now();
  1164. }
  1165. //---------------------------------------------------------------------------
  1166. unsigned int __fastcall TSecureShell::TimeoutPrompt(TQueryParamsTimerEvent PoolEvent)
  1167. {
  1168. FWaiting++;
  1169. unsigned int Answer;
  1170. try
  1171. {
  1172. TQueryParams Params(qpFatalAbort | qpAllowContinueOnError | qpIgnoreAbort);
  1173. Params.HelpKeyword = HELP_MESSAGE_HOST_IS_NOT_COMMUNICATING;
  1174. Params.Timer = 500;
  1175. Params.TimerEvent = PoolEvent;
  1176. Params.TimerMessage = MainInstructionsFirstParagraph(FMTLOAD(TIMEOUT_STILL_WAITING3, (FSessionData->Timeout)));
  1177. Params.TimerAnswers = qaAbort;
  1178. Params.TimerQueryType = qtInformation;
  1179. if (FConfiguration->SessionReopenAutoStall > 0)
  1180. {
  1181. Params.Timeout = FConfiguration->SessionReopenAutoStall;
  1182. Params.TimeoutAnswer = qaAbort;
  1183. Params.TimeoutResponse = qaNo;
  1184. }
  1185. Answer = FUI->QueryUser(MainInstructions(FMTLOAD(CONFIRM_PROLONG_TIMEOUT3, (FSessionData->Timeout))),
  1186. NULL, qaRetry | qaAbort, &Params);
  1187. }
  1188. __finally
  1189. {
  1190. FWaiting--;
  1191. }
  1192. return Answer;
  1193. }
  1194. //---------------------------------------------------------------------------
  1195. void __fastcall TSecureShell::SendBuffer(unsigned int & Result)
  1196. {
  1197. // for comments see PoolForData
  1198. if (!Active)
  1199. {
  1200. Result = qaRetry;
  1201. }
  1202. else
  1203. {
  1204. try
  1205. {
  1206. if (backend_sendbuffer(FBackendHandle) <= MAX_BUFSIZE)
  1207. {
  1208. Result = qaOK;
  1209. }
  1210. }
  1211. catch(...)
  1212. {
  1213. Result = qaRetry;
  1214. }
  1215. }
  1216. }
  1217. //---------------------------------------------------------------------------
  1218. void TSecureShell::TimeoutAbort(unsigned int Answer)
  1219. {
  1220. FatalError(MainInstructions(LoadStr(Answer == qaAbort ? USER_TERMINATED : TIMEOUT_ERROR)));
  1221. }
  1222. //---------------------------------------------------------------------------
  1223. void __fastcall TSecureShell::DispatchSendBuffer(int BufSize)
  1224. {
  1225. TDateTime Start = Now();
  1226. do
  1227. {
  1228. CheckConnection();
  1229. if (Configuration->ActualLogProtocol >= 1)
  1230. {
  1231. LogEvent(FORMAT(L"There are %u bytes remaining in the send buffer, "
  1232. "need to send at least another %u bytes",
  1233. (BufSize, BufSize - MAX_BUFSIZE)));
  1234. }
  1235. EventSelectLoop(100, false, NULL);
  1236. BufSize = backend_sendbuffer(FBackendHandle);
  1237. if (Configuration->ActualLogProtocol >= 1)
  1238. {
  1239. LogEvent(FORMAT(L"There are %u bytes remaining in the send buffer", (BufSize)));
  1240. }
  1241. if (Now() - Start > FSessionData->TimeoutDT)
  1242. {
  1243. LogEvent(L"Waiting for dispatching send buffer timed out, asking user what to do.");
  1244. unsigned int Answer = TimeoutPrompt(SendBuffer);
  1245. switch (Answer)
  1246. {
  1247. case qaRetry:
  1248. Start = Now();
  1249. break;
  1250. case qaOK:
  1251. BufSize = 0;
  1252. break;
  1253. default:
  1254. DebugFail();
  1255. // fallthru
  1256. case qaAbort:
  1257. case qaNo:
  1258. TimeoutAbort(Answer);
  1259. break;
  1260. }
  1261. }
  1262. }
  1263. while (BufSize > MAX_BUFSIZE);
  1264. }
  1265. //---------------------------------------------------------------------------
  1266. void __fastcall TSecureShell::Send(const unsigned char * Buf, Integer Len)
  1267. {
  1268. CheckConnection();
  1269. backend_send(FBackendHandle, const_cast<char *>(reinterpret_cast<const char *>(Buf)), Len);
  1270. int BufSize = backend_sendbuffer(FBackendHandle);
  1271. if (Configuration->ActualLogProtocol >= 1)
  1272. {
  1273. LogEvent(FORMAT(L"Sent %u bytes", (static_cast<int>(Len))));
  1274. LogEvent(FORMAT(L"There are %u bytes remaining in the send buffer", (BufSize)));
  1275. }
  1276. FLastDataSent = Now();
  1277. // among other forces receive of pending data to free the servers's send buffer
  1278. EventSelectLoop(0, false, NULL);
  1279. if (BufSize > MAX_BUFSIZE)
  1280. {
  1281. DispatchSendBuffer(BufSize);
  1282. }
  1283. CheckConnection();
  1284. }
  1285. //---------------------------------------------------------------------------
  1286. void __fastcall TSecureShell::SendNull()
  1287. {
  1288. LogEvent(L"Sending NULL.");
  1289. unsigned char Null = 0;
  1290. Send(&Null, 1);
  1291. }
  1292. //---------------------------------------------------------------------------
  1293. void __fastcall TSecureShell::SendLine(const UnicodeString & Line)
  1294. {
  1295. CheckConnection();
  1296. RawByteString Buf;
  1297. if (UtfStrings)
  1298. {
  1299. Buf = RawByteString(UTF8String(Line));
  1300. }
  1301. else
  1302. {
  1303. Buf = RawByteString(AnsiString(Line));
  1304. }
  1305. Buf += "\n";
  1306. FLog->Add(llInput, Line);
  1307. Send(reinterpret_cast<const unsigned char *>(Buf.c_str()), Buf.Length());
  1308. }
  1309. //---------------------------------------------------------------------------
  1310. int __fastcall TSecureShell::TranslatePuttyMessage(
  1311. const TPuttyTranslation * Translation, size_t Count, UnicodeString & Message,
  1312. UnicodeString * HelpKeyword)
  1313. {
  1314. int Result = -1;
  1315. for (unsigned int Index = 0; Index < Count; Index++)
  1316. {
  1317. const wchar_t * Original = Translation[Index].Original;
  1318. const wchar_t * Div = wcschr(Original, L'%');
  1319. if (Div == NULL)
  1320. {
  1321. if (wcscmp(Message.c_str(), Original) == 0)
  1322. {
  1323. Message = LoadStr(Translation[Index].Translation);
  1324. Result = int(Index);
  1325. break;
  1326. }
  1327. }
  1328. else
  1329. {
  1330. size_t OriginalLen = wcslen(Original);
  1331. size_t PrefixLen = Div - Original;
  1332. size_t SuffixLen = OriginalLen - PrefixLen - 1;
  1333. if (((size_t)Message.Length() >= OriginalLen - 1) &&
  1334. (wcsncmp(Message.c_str(), Original, PrefixLen) == 0) &&
  1335. (wcsncmp(Message.c_str() + Message.Length() - SuffixLen, Div + 1, SuffixLen) == 0))
  1336. {
  1337. Message = FMTLOAD(Translation[Index].Translation,
  1338. (Message.SubString(PrefixLen + 1, Message.Length() - PrefixLen - SuffixLen).TrimRight()));
  1339. Result = int(Index);
  1340. break;
  1341. }
  1342. }
  1343. }
  1344. if ((HelpKeyword != NULL) && (Result >= 0))
  1345. {
  1346. *HelpKeyword = Translation[Result].HelpKeyword;
  1347. }
  1348. return Result;
  1349. }
  1350. //---------------------------------------------------------------------------
  1351. int __fastcall TSecureShell::TranslateAuthenticationMessage(
  1352. UnicodeString & Message, UnicodeString * HelpKeyword)
  1353. {
  1354. static const TPuttyTranslation Translation[] = {
  1355. { L"Using username \"%\".", AUTH_TRANSL_USERNAME },
  1356. { L"Using keyboard-interactive authentication.", AUTH_TRANSL_KEYB_INTER }, // not used anymore
  1357. { L"Authenticating with public key \"%\" from agent", AUTH_TRANSL_PUBLIC_KEY_AGENT },
  1358. { L"Authenticating with public key \"%\"", AUTH_TRANSL_PUBLIC_KEY },
  1359. { L"Authenticated using RSA key \"%\" from agent", AUTH_TRANSL_PUBLIC_KEY_AGENT },
  1360. { L"Wrong passphrase", AUTH_TRANSL_WRONG_PASSPHRASE },
  1361. { L"Wrong passphrase.", AUTH_TRANSL_WRONG_PASSPHRASE },
  1362. { L"Access denied", AUTH_TRANSL_ACCESS_DENIED },
  1363. { L"Trying public key authentication.", AUTH_TRANSL_TRY_PUBLIC_KEY },
  1364. { L"Server refused our public key.", AUTH_TRANSL_KEY_REFUSED, HELP_AUTH_TRANSL_KEY_REFUSED }, // help mapping probably never used
  1365. { L"Server refused our key", AUTH_TRANSL_KEY_REFUSED, HELP_AUTH_TRANSL_KEY_REFUSED }
  1366. };
  1367. int Result = TranslatePuttyMessage(Translation, LENOF(Translation), Message, HelpKeyword);
  1368. if ((Result == 2) || (Result == 3) || (Result == 4))
  1369. {
  1370. FCollectPrivateKeyUsage = true;
  1371. }
  1372. return Result;
  1373. }
  1374. //---------------------------------------------------------------------------
  1375. void __fastcall TSecureShell::AddStdError(const char * Data, size_t Length)
  1376. {
  1377. UnicodeString Str = ConvertInput(RawByteString(Data, Length));
  1378. FStdError += Str;
  1379. Integer P;
  1380. Str = DeleteChar(Str, L'\r');
  1381. // We send only whole line at once to log, so we have to cache
  1382. // incoming std error data
  1383. FStdErrorTemp += Str;
  1384. UnicodeString Line;
  1385. // Do we have at least one complete line in std error cache?
  1386. while ((P = FStdErrorTemp.Pos(L"\n")) > 0)
  1387. {
  1388. Line = FStdErrorTemp.SubString(1, P-1);
  1389. FStdErrorTemp.Delete(1, P);
  1390. AddStdErrorLine(Line);
  1391. }
  1392. }
  1393. //---------------------------------------------------------------------------
  1394. void __fastcall TSecureShell::AddStdErrorLine(const UnicodeString & Str)
  1395. {
  1396. if (FAuthenticating)
  1397. {
  1398. FAuthenticationLog += (FAuthenticationLog.IsEmpty() ? L"" : L"\n") + Str;
  1399. }
  1400. CaptureOutput(llStdError, Str);
  1401. }
  1402. //---------------------------------------------------------------------------
  1403. const UnicodeString & __fastcall TSecureShell::GetStdError()
  1404. {
  1405. return FStdError;
  1406. }
  1407. //---------------------------------------------------------------------------
  1408. void __fastcall TSecureShell::ClearStdError()
  1409. {
  1410. // Flush std error cache
  1411. if (!FStdErrorTemp.IsEmpty())
  1412. {
  1413. if (FAuthenticating)
  1414. {
  1415. FAuthenticationLog +=
  1416. (FAuthenticationLog.IsEmpty() ? L"" : L"\n") + FStdErrorTemp;
  1417. }
  1418. CaptureOutput(llStdError, FStdErrorTemp);
  1419. FStdErrorTemp = L"";
  1420. }
  1421. FStdError = L"";
  1422. }
  1423. //---------------------------------------------------------------------------
  1424. void __fastcall TSecureShell::CaptureOutput(TLogLineType Type,
  1425. const UnicodeString & Line)
  1426. {
  1427. if (FOnCaptureOutput != NULL)
  1428. {
  1429. FOnCaptureOutput(Line, (Type == llStdError) ? cotError : cotOutput);
  1430. }
  1431. FLog->Add(Type, Line);
  1432. }
  1433. //---------------------------------------------------------------------------
  1434. int __fastcall TSecureShell::TranslateErrorMessage(
  1435. UnicodeString & Message, UnicodeString * HelpKeyword)
  1436. {
  1437. static const TPuttyTranslation Translation[] = {
  1438. { L"Remote side unexpectedly closed network connection", UNEXPECTED_CLOSE_ERROR, HELP_UNEXPECTED_CLOSE_ERROR },
  1439. { L"Network error: Connection refused", NET_TRANSL_REFUSED2, HELP_NET_TRANSL_REFUSED },
  1440. { L"Network error: Connection reset by peer", NET_TRANSL_RESET, HELP_NET_TRANSL_RESET },
  1441. { L"Network error: Connection timed out", NET_TRANSL_TIMEOUT2, HELP_NET_TRANSL_TIMEOUT },
  1442. { L"Network error: No route to host", NET_TRANSL_NO_ROUTE2, HELP_NET_TRANSL_NO_ROUTE },
  1443. { L"Network error: Software caused connection abort", NET_TRANSL_CONN_ABORTED, HELP_NET_TRANSL_CONN_ABORTED },
  1444. { L"Host does not exist", NET_TRANSL_HOST_NOT_EXIST2, HELP_NET_TRANSL_HOST_NOT_EXIST },
  1445. { L"Incoming packet was garbled on decryption", NET_TRANSL_PACKET_GARBLED, HELP_NET_TRANSL_PACKET_GARBLED },
  1446. };
  1447. int Index = TranslatePuttyMessage(Translation, LENOF(Translation), Message, HelpKeyword);
  1448. if ((Index == 0) || (Index == 1) || (Index == 2) || (Index == 3))
  1449. {
  1450. FNoConnectionResponse = true;
  1451. }
  1452. Message = ReplaceStr(Message, L"%HOST%", FSessionData->HostNameExpanded);
  1453. return Index;
  1454. }
  1455. //---------------------------------------------------------------------------
  1456. void __fastcall TSecureShell::PuttyFatalError(UnicodeString Error)
  1457. {
  1458. UnicodeString HelpKeyword;
  1459. TranslateErrorMessage(Error, &HelpKeyword);
  1460. if (!FClosed)
  1461. {
  1462. FatalError(Error, HelpKeyword);
  1463. }
  1464. else
  1465. {
  1466. LogEvent(FORMAT(L"Ignoring an error from the server while closing: %s", (Error)));
  1467. }
  1468. }
  1469. //---------------------------------------------------------------------------
  1470. void __fastcall TSecureShell::FatalError(UnicodeString Error, UnicodeString HelpKeyword)
  1471. {
  1472. FUI->FatalError(NULL, Error, HelpKeyword);
  1473. }
  1474. //---------------------------------------------------------------------------
  1475. void __fastcall inline TSecureShell::LogEvent(const UnicodeString & Str)
  1476. {
  1477. if (FLog->Logging)
  1478. {
  1479. FLog->Add(llMessage, Str);
  1480. }
  1481. }
  1482. //---------------------------------------------------------------------------
  1483. void __fastcall TSecureShell::SocketEventSelect(SOCKET Socket, HANDLE Event, bool Enable)
  1484. {
  1485. int Events;
  1486. if (Enable)
  1487. {
  1488. Events = (FD_CONNECT | FD_READ | FD_WRITE | FD_OOB | FD_CLOSE | FD_ACCEPT);
  1489. }
  1490. else
  1491. {
  1492. Events = 0;
  1493. }
  1494. if (Configuration->ActualLogProtocol >= 2)
  1495. {
  1496. LogEvent(FORMAT(L"Selecting events %d for socket %d", (int(Events), int(Socket))));
  1497. }
  1498. if (WSAEventSelect(Socket, (WSAEVENT)Event, Events) == SOCKET_ERROR)
  1499. {
  1500. if (Configuration->ActualLogProtocol >= 2)
  1501. {
  1502. LogEvent(FORMAT(L"Error selecting events %d for socket %d", (int(Events), int(Socket))));
  1503. }
  1504. if (Enable)
  1505. {
  1506. FatalError(FMTLOAD(EVENT_SELECT_ERROR, (WSAGetLastError())));
  1507. }
  1508. }
  1509. }
  1510. //---------------------------------------------------------------------------
  1511. bool TSecureShell::HasLocalProxy()
  1512. {
  1513. return (FSessionData->ProxyMethod == pmCmd);
  1514. }
  1515. //---------------------------------------------------------------------------
  1516. void __fastcall TSecureShell::UpdateSocket(SOCKET value, bool Enable)
  1517. {
  1518. if (!FActive && !Enable)
  1519. {
  1520. // no-op
  1521. // Remove the branch eventually:
  1522. // When TCP connection fails, PuTTY does not release the memory allocated for
  1523. // socket. As a simple hack we call sk_tcp_close() in ssh.c to release the memory,
  1524. // until they fix it better. Unfortunately sk_tcp_close calls do_select,
  1525. // so we must filter that out.
  1526. }
  1527. else
  1528. {
  1529. DebugAssert(value);
  1530. DebugAssert((FActive && (FSocket == value)) || (!FActive && Enable));
  1531. // filter our "local proxy" connection, which have no socket
  1532. if (value != INVALID_SOCKET)
  1533. {
  1534. SocketEventSelect(value, FSocketEvent, Enable);
  1535. }
  1536. else
  1537. {
  1538. DebugAssert(HasLocalProxy());
  1539. }
  1540. if (Enable)
  1541. {
  1542. FSocket = value;
  1543. FActive = true;
  1544. }
  1545. else
  1546. {
  1547. FSocket = INVALID_SOCKET;
  1548. Discard();
  1549. }
  1550. }
  1551. }
  1552. //---------------------------------------------------------------------------
  1553. void __fastcall TSecureShell::UpdatePortFwdSocket(SOCKET value, bool Enable)
  1554. {
  1555. if (value != INVALID_SOCKET)
  1556. {
  1557. if (Configuration->ActualLogProtocol >= 2)
  1558. {
  1559. LogEvent(FORMAT(L"Updating forwarding socket %d (%d)", (int(value), int(Enable))));
  1560. }
  1561. SocketEventSelect(value, FSocketEvent, Enable);
  1562. if (Enable)
  1563. {
  1564. FPortFwdSockets.insert(value);
  1565. }
  1566. else
  1567. {
  1568. FPortFwdSockets.erase(value);
  1569. }
  1570. }
  1571. else
  1572. {
  1573. DebugAssert(FSessionData->AgentFwd);
  1574. }
  1575. }
  1576. //---------------------------------------------------------------------------
  1577. void __fastcall TSecureShell::FreeBackend()
  1578. {
  1579. if (FBackendHandle != NULL)
  1580. {
  1581. backend_free(FBackendHandle);
  1582. FBackendHandle = NULL;
  1583. // After destroying backend, ic_pktin_free should be the only remaining callback.
  1584. if (is_idempotent_callback_pending(FCallbackSet, FCallbackSet->ic_pktin_free))
  1585. {
  1586. // This releases the callback and should be noop otherwise.
  1587. run_toplevel_callbacks(FCallbackSet);
  1588. }
  1589. sfree(FCallbackSet->ic_pktin_free);
  1590. FCallbackSet->ic_pktin_free = NULL;
  1591. // Not checking that cbcurr is NULL. It may be non-null, when (fatal?) exception occurs, while the callback is called.
  1592. FCallbackSet->cbcurr = NULL;
  1593. DebugAssert(FCallbackSet->cbhead == NULL);
  1594. DebugAssert(FCallbackSet->cbtail == NULL);
  1595. if (FCallbackSet->pktin_freeq_head != NULL)
  1596. {
  1597. DebugAssert(FCallbackSet->pktin_freeq_head->next == FCallbackSet->pktin_freeq_head);
  1598. sfree(FCallbackSet->pktin_freeq_head);
  1599. FCallbackSet->pktin_freeq_head = NULL;
  1600. }
  1601. if (FCallbackSet->handlewaits_tree_real != NULL)
  1602. {
  1603. DebugAssert(count234(FCallbackSet->handlewaits_tree_real) <= 1);
  1604. while (count234(FCallbackSet->handlewaits_tree_real) > 0)
  1605. {
  1606. HandleWait * AHandleWait = static_cast<HandleWait *>(index234(FCallbackSet->handlewaits_tree_real, 0));
  1607. delete_handle_wait(FCallbackSet, AHandleWait);
  1608. }
  1609. freetree234(FCallbackSet->handlewaits_tree_real);
  1610. FCallbackSet->handlewaits_tree_real = NULL;
  1611. }
  1612. if (FCallbackSet->ready_event != INVALID_HANDLE_VALUE)
  1613. {
  1614. CloseHandle(FCallbackSet->ready_event);
  1615. FCallbackSet->ready_event = INVALID_HANDLE_VALUE;
  1616. }
  1617. }
  1618. }
  1619. //---------------------------------------------------------------------------
  1620. void __fastcall TSecureShell::Discard()
  1621. {
  1622. bool WasActive = FActive;
  1623. FActive = false;
  1624. FOpened = false;
  1625. if (WasActive)
  1626. {
  1627. FUI->Closed();
  1628. }
  1629. }
  1630. //---------------------------------------------------------------------------
  1631. void __fastcall TSecureShell::Close()
  1632. {
  1633. LogEvent(L"Closing connection.");
  1634. DebugAssert(FActive);
  1635. FClosed = true;
  1636. // Without main channel SS_EOF is ignored and would get stuck waiting for exit code.
  1637. if ((backend_exitcode(FBackendHandle) < 0) && winscp_query(FBackendHandle, WINSCP_QUERY_MAIN_CHANNEL))
  1638. {
  1639. // this is particularly necessary when using local proxy command
  1640. // (e.g. plink), otherwise it hangs in sk_localproxy_close
  1641. SendSpecial(SS_EOF);
  1642. // Try waiting for the EOF exchange to complete (among other to avoid packet queue memory leaks)
  1643. int Timeout = 500;
  1644. while ((backend_exitcode(FBackendHandle) < 0) && (Timeout > 0))
  1645. {
  1646. const int Step = 100;
  1647. if (!EventSelectLoop(Step, false, NULL))
  1648. {
  1649. Timeout -= Step;
  1650. }
  1651. }
  1652. }
  1653. FreeBackend();
  1654. Discard();
  1655. }
  1656. //---------------------------------------------------------------------------
  1657. void inline __fastcall TSecureShell::CheckConnection(int Message)
  1658. {
  1659. if (!FActive || (backend_exitcode(FBackendHandle) >= 0))
  1660. {
  1661. UnicodeString Str;
  1662. UnicodeString HelpKeyword;
  1663. if (Message >= 0)
  1664. {
  1665. Str = LoadStr(Message);
  1666. }
  1667. else
  1668. {
  1669. Str = LoadStr(NOT_CONNECTED);
  1670. HelpKeyword = HELP_NOT_CONNECTED;
  1671. }
  1672. Str = MainInstructions(Str);
  1673. int ExitCode = backend_exitcode(FBackendHandle);
  1674. if (ExitCode >= 0)
  1675. {
  1676. Str += L" " + FMTLOAD(SSH_EXITCODE, (ExitCode));
  1677. }
  1678. if (!FClosed)
  1679. {
  1680. FatalError(Str, HelpKeyword);
  1681. }
  1682. else
  1683. {
  1684. LogEvent(FORMAT(L"Ignoring closed connection: %s", (Str)));
  1685. }
  1686. }
  1687. }
  1688. //---------------------------------------------------------------------------
  1689. void __fastcall TSecureShell::PoolForData(WSANETWORKEVENTS & Events, unsigned int & Result)
  1690. {
  1691. if (!Active)
  1692. {
  1693. // see comment below
  1694. Result = qaRetry;
  1695. }
  1696. else
  1697. {
  1698. try
  1699. {
  1700. if (Configuration->ActualLogProtocol >= 2)
  1701. {
  1702. LogEvent(L"Pooling for data in case they finally arrives");
  1703. }
  1704. // in extreme condition it may happen that send buffer is full, but there
  1705. // will be no data coming and we may not empty the send buffer because we
  1706. // do not process FD_WRITE until we receive any FD_READ
  1707. if (EventSelectLoop(0, false, &Events))
  1708. {
  1709. LogEvent(L"Data has arrived, closing query to user.");
  1710. Result = qaOK;
  1711. }
  1712. }
  1713. catch(...)
  1714. {
  1715. // if we let the exception out, it may popup another message dialog
  1716. // in whole event loop, another call to PoolForData from original dialog
  1717. // would be invoked, leading to an infinite loop.
  1718. // by retrying we hope (that probably fatal) error would repeat in WaitForData.
  1719. // anyway now once no actual work is done in EventSelectLoop,
  1720. // hardly any exception can occur actually
  1721. Result = qaRetry;
  1722. }
  1723. }
  1724. }
  1725. //---------------------------------------------------------------------------
  1726. class TPoolForDataEvent
  1727. {
  1728. public:
  1729. __fastcall TPoolForDataEvent(TSecureShell * SecureShell, WSANETWORKEVENTS & Events) :
  1730. FSecureShell(SecureShell),
  1731. FEvents(Events)
  1732. {
  1733. }
  1734. void __fastcall PoolForData(unsigned int & Result)
  1735. {
  1736. FSecureShell->PoolForData(FEvents, Result);
  1737. }
  1738. private:
  1739. TSecureShell * FSecureShell;
  1740. WSANETWORKEVENTS & FEvents;
  1741. };
  1742. //---------------------------------------------------------------------------
  1743. void __fastcall TSecureShell::WaitForData()
  1744. {
  1745. // see winsftp.c
  1746. bool IncomingData;
  1747. do
  1748. {
  1749. if (Configuration->ActualLogProtocol >= 2)
  1750. {
  1751. LogEvent(L"Looking for incoming data");
  1752. }
  1753. IncomingData = EventSelectLoop(FSessionData->Timeout * MSecsPerSec, true, NULL);
  1754. if (!IncomingData)
  1755. {
  1756. DebugAssert(FWaitingForData == 0);
  1757. TAutoNestingCounter NestingCounter(FWaitingForData);
  1758. WSANETWORKEVENTS Events;
  1759. memset(&Events, 0, sizeof(Events));
  1760. TPoolForDataEvent Event(this, Events);
  1761. LogEvent(L"Waiting for data timed out, asking user what to do.");
  1762. unsigned int Answer = TimeoutPrompt(Event.PoolForData);
  1763. switch (Answer)
  1764. {
  1765. case qaRetry:
  1766. // noop
  1767. break;
  1768. case qaOK:
  1769. // read event was already captured in PoolForData(),
  1770. // make sure we do not try to select it again as it would timeout
  1771. // unless another read event occurs
  1772. IncomingData = true;
  1773. HandleNetworkEvents(FSocket, Events);
  1774. break;
  1775. default:
  1776. DebugFail();
  1777. // fallthru
  1778. case qaAbort:
  1779. case qaNo:
  1780. TimeoutAbort(Answer);
  1781. break;
  1782. }
  1783. }
  1784. }
  1785. while (!IncomingData);
  1786. }
  1787. //---------------------------------------------------------------------------
  1788. bool __fastcall TSecureShell::SshFallbackCmd() const
  1789. {
  1790. return ssh_fallback_cmd(FBackendHandle);
  1791. }
  1792. //---------------------------------------------------------------------------
  1793. bool __fastcall TSecureShell::EnumNetworkEvents(SOCKET Socket, WSANETWORKEVENTS & Events)
  1794. {
  1795. if (Configuration->ActualLogProtocol >= 2)
  1796. {
  1797. LogEvent(FORMAT(L"Enumerating network events for socket %d", (int(Socket))));
  1798. }
  1799. // see winplink.c
  1800. WSANETWORKEVENTS AEvents;
  1801. if (WSAEnumNetworkEvents(Socket, NULL, &AEvents) == 0)
  1802. {
  1803. noise_ultralight(NOISE_SOURCE_IOID, Socket);
  1804. noise_ultralight(NOISE_SOURCE_IOID, AEvents.lNetworkEvents);
  1805. Events.lNetworkEvents |= AEvents.lNetworkEvents;
  1806. for (int Index = 0; Index < FD_MAX_EVENTS; Index++)
  1807. {
  1808. if (AEvents.iErrorCode[Index] != 0)
  1809. {
  1810. Events.iErrorCode[Index] = AEvents.iErrorCode[Index];
  1811. }
  1812. }
  1813. if (Configuration->ActualLogProtocol >= 2)
  1814. {
  1815. LogEvent(FORMAT(L"Enumerated %d network events making %d cumulative events for socket %d",
  1816. (int(AEvents.lNetworkEvents), int(Events.lNetworkEvents), int(Socket))));
  1817. }
  1818. }
  1819. else
  1820. {
  1821. if (Configuration->ActualLogProtocol >= 2)
  1822. {
  1823. LogEvent(FORMAT(L"Error enumerating network events for socket %d", (int(Socket))));
  1824. }
  1825. }
  1826. bool Result =
  1827. FLAGSET(Events.lNetworkEvents, FD_READ) ||
  1828. FLAGSET(Events.lNetworkEvents, FD_CLOSE);
  1829. return Result;
  1830. }
  1831. //---------------------------------------------------------------------------
  1832. void __fastcall TSecureShell::HandleNetworkEvents(SOCKET Socket, WSANETWORKEVENTS & Events)
  1833. {
  1834. static const struct { int Bit, Mask; const wchar_t * Desc; } EventTypes[] =
  1835. {
  1836. { FD_WRITE_BIT, FD_WRITE, L"write" },
  1837. { FD_OOB_BIT, FD_OOB, L"oob" },
  1838. { FD_ACCEPT_BIT, FD_ACCEPT, L"accept" },
  1839. { FD_CONNECT_BIT, FD_CONNECT, L"connect" },
  1840. { FD_CLOSE_BIT, FD_CLOSE, L"close" },
  1841. // Read goes last, as it can cause an exception.
  1842. // Though a correct solution would be to process all events, even if one causes exception
  1843. { FD_READ_BIT, FD_READ, L"read" },
  1844. };
  1845. for (unsigned int Event = 0; Event < LENOF(EventTypes); Event++)
  1846. {
  1847. if (FLAGSET(Events.lNetworkEvents, EventTypes[Event].Mask))
  1848. {
  1849. int Err = Events.iErrorCode[EventTypes[Event].Bit];
  1850. if (Configuration->ActualLogProtocol >= 2)
  1851. {
  1852. LogEvent(FORMAT(L"Handling network %s event on socket %d with error %d",
  1853. (EventTypes[Event].Desc, int(Socket), Err)));
  1854. }
  1855. #pragma option push -w-prc
  1856. LPARAM SelectEvent = WSAMAKESELECTREPLY(EventTypes[Event].Mask, Err);
  1857. #pragma option pop
  1858. select_result((WPARAM)Socket, SelectEvent);
  1859. CheckConnection();
  1860. }
  1861. }
  1862. }
  1863. //---------------------------------------------------------------------------
  1864. bool __fastcall TSecureShell::ProcessNetworkEvents(SOCKET Socket)
  1865. {
  1866. WSANETWORKEVENTS Events;
  1867. memset(&Events, 0, sizeof(Events));
  1868. bool Result = EnumNetworkEvents(Socket, Events);
  1869. HandleNetworkEvents(Socket, Events);
  1870. return Result;
  1871. }
  1872. //---------------------------------------------------------------------------
  1873. bool __fastcall TSecureShell::EventSelectLoop(unsigned int MSec, bool ReadEventRequired,
  1874. WSANETWORKEVENTS * Events)
  1875. {
  1876. bool Result = false;
  1877. do
  1878. {
  1879. if (Configuration->ActualLogProtocol >= 2)
  1880. {
  1881. LogEvent(L"Looking for network events");
  1882. }
  1883. unsigned int TicksBefore = GetTickCount();
  1884. HandleWaitList * WaitList = NULL;
  1885. try
  1886. {
  1887. unsigned int Timeout = MSec;
  1888. unsigned int WaitResult;
  1889. do
  1890. {
  1891. CheckConnection();
  1892. unsigned int TimeoutStep = std::min(GUIUpdateInterval, Timeout);
  1893. if (toplevel_callback_pending(GetCallbackSet()))
  1894. {
  1895. TimeoutStep = 0;
  1896. }
  1897. Timeout -= TimeoutStep;
  1898. if (WaitList != NULL)
  1899. {
  1900. handle_wait_list_free(WaitList);
  1901. }
  1902. // It returns only busy handles, so the set can change with every call to run_toplevel_callbacks.
  1903. WaitList = get_handle_wait_list(FCallbackSet);
  1904. DebugAssert(WaitList->nhandles < MAXIMUM_WAIT_OBJECTS);
  1905. WaitList->handles[WaitList->nhandles] = FSocketEvent;
  1906. WaitResult = WaitForMultipleObjects(WaitList->nhandles + 1, WaitList->handles, FALSE, TimeoutStep);
  1907. FUI->ProcessGUI();
  1908. // run_toplevel_callbacks can cause processing of pending raw data, so:
  1909. // 1) Check for changes in our pending buffer - wait criteria in Receive()
  1910. int PrevDataLen = (-static_cast<int>(OutLen) + static_cast<int>(PendLen));
  1911. // 2) Changes in session state - wait criteria in Init()
  1912. unsigned int HadMainChannel = winscp_query(FBackendHandle, WINSCP_QUERY_MAIN_CHANNEL);
  1913. if (run_toplevel_callbacks(GetCallbackSet()) &&
  1914. (((-static_cast<int>(OutLen) + static_cast<int>(PendLen)) > PrevDataLen) ||
  1915. (HadMainChannel != winscp_query(FBackendHandle, WINSCP_QUERY_MAIN_CHANNEL))))
  1916. {
  1917. // Note that we still may process new network event now
  1918. Result = true;
  1919. }
  1920. } while ((WaitResult == WAIT_TIMEOUT) && (Timeout > 0) && !Result);
  1921. if (WaitResult < WAIT_OBJECT_0 + WaitList->nhandles)
  1922. {
  1923. if (handle_wait_activate(FCallbackSet, WaitList, WaitResult - WAIT_OBJECT_0))
  1924. {
  1925. Result = true;
  1926. }
  1927. }
  1928. else if (WaitResult == WAIT_OBJECT_0 + WaitList->nhandles)
  1929. {
  1930. if (Configuration->ActualLogProtocol >= 1)
  1931. {
  1932. LogEvent(L"Detected network event");
  1933. }
  1934. DebugAssert(FSocket != INVALID_SOCKET);
  1935. if (Events == NULL)
  1936. {
  1937. if (ProcessNetworkEvents(FSocket))
  1938. {
  1939. Result = true;
  1940. }
  1941. }
  1942. else
  1943. {
  1944. if (EnumNetworkEvents(FSocket, *Events))
  1945. {
  1946. Result = true;
  1947. }
  1948. }
  1949. {
  1950. TSockets::iterator i = FPortFwdSockets.begin();
  1951. while (i != FPortFwdSockets.end())
  1952. {
  1953. ProcessNetworkEvents(*i);
  1954. i++;
  1955. }
  1956. }
  1957. }
  1958. else if (WaitResult == WAIT_TIMEOUT)
  1959. {
  1960. if (Configuration->ActualLogProtocol >= 2)
  1961. {
  1962. LogEvent(L"Timeout waiting for network events");
  1963. }
  1964. MSec = 0;
  1965. }
  1966. else
  1967. {
  1968. if (Configuration->ActualLogProtocol >= 2)
  1969. {
  1970. LogEvent(FORMAT(L"Unknown waiting result %d", (int(WaitResult))));
  1971. }
  1972. MSec = 0;
  1973. }
  1974. }
  1975. __finally
  1976. {
  1977. if (WaitList != NULL)
  1978. {
  1979. handle_wait_list_free(WaitList);
  1980. }
  1981. }
  1982. unsigned int TicksAfter = GetTickCount();
  1983. // ticks wraps once in 49.7 days
  1984. if (TicksBefore < TicksAfter)
  1985. {
  1986. unsigned int Ticks = TicksAfter - TicksBefore;
  1987. if (Ticks > MSec)
  1988. {
  1989. MSec = 0;
  1990. }
  1991. else
  1992. {
  1993. MSec -= Ticks;
  1994. }
  1995. }
  1996. if ((FSocket != INVALID_SOCKET) &&
  1997. (FSendBuf > 0) && (TicksAfter - FLastSendBufferUpdate >= 1000))
  1998. {
  1999. DWORD BufferLen = 0;
  2000. DWORD OutLen = 0;
  2001. if (WSAIoctl(FSocket, SIO_IDEAL_SEND_BACKLOG_QUERY, NULL, 0, &BufferLen, sizeof(BufferLen), &OutLen, 0, 0) == 0)
  2002. {
  2003. DebugAssert(OutLen == sizeof(BufferLen));
  2004. if (FSendBuf < static_cast<int>(BufferLen))
  2005. {
  2006. LogEvent(FORMAT(L"Increasing send buffer from %d to %d", (FSendBuf, static_cast<int>(BufferLen))));
  2007. FSendBuf = BufferLen;
  2008. setsockopt(FSocket, SOL_SOCKET, SO_SNDBUF, reinterpret_cast<const char *>(&BufferLen), sizeof(BufferLen));
  2009. }
  2010. }
  2011. FLastSendBufferUpdate = TicksAfter;
  2012. }
  2013. }
  2014. while (ReadEventRequired && (MSec > 0) && !Result);
  2015. return Result;
  2016. }
  2017. //---------------------------------------------------------------------------
  2018. void __fastcall TSecureShell::Idle(unsigned int MSec)
  2019. {
  2020. noise_regular();
  2021. winscp_query(FBackendHandle, WINSCP_QUERY_TIMER);
  2022. // if we are actively waiting for data in WaitForData,
  2023. // do not read here, otherwise we swallow read event and never wake
  2024. if (FWaitingForData <= 0)
  2025. {
  2026. EventSelectLoop(MSec, false, NULL);
  2027. }
  2028. }
  2029. //---------------------------------------------------------------------------
  2030. void __fastcall TSecureShell::KeepAlive()
  2031. {
  2032. if (FActive && (FWaiting == 0))
  2033. {
  2034. LogEvent(L"Sending null packet to keep session alive.");
  2035. SendSpecial(SS_PING);
  2036. }
  2037. else
  2038. {
  2039. // defer next keepalive attempt
  2040. FLastDataSent = Now();
  2041. }
  2042. }
  2043. //---------------------------------------------------------------------------
  2044. unsigned long __fastcall TSecureShell::MaxPacketSize()
  2045. {
  2046. if (!FSessionInfoValid)
  2047. {
  2048. UpdateSessionInfo();
  2049. }
  2050. return winscp_query(FBackendHandle, WINSCP_QUERY_REMMAXPKT);
  2051. }
  2052. //---------------------------------------------------------------------------
  2053. UnicodeString __fastcall TSecureShell::FormatKeyStr(UnicodeString KeyStr)
  2054. {
  2055. int Index = 1;
  2056. int Digits = 0;
  2057. while (Index <= KeyStr.Length())
  2058. {
  2059. if (IsHex(KeyStr[Index]))
  2060. {
  2061. Digits++;
  2062. if (Digits >= 16)
  2063. {
  2064. KeyStr.Insert(L" ", Index + 1);
  2065. Index++;
  2066. Digits = 0;
  2067. }
  2068. }
  2069. else
  2070. {
  2071. Digits = 0;
  2072. }
  2073. Index++;
  2074. }
  2075. return KeyStr;
  2076. }
  2077. //---------------------------------------------------------------------------
  2078. void __fastcall TSecureShell::GetRealHost(UnicodeString & Host, int & Port)
  2079. {
  2080. if (FSessionData->Tunnel)
  2081. {
  2082. // Now that we set the CONF_loghost, the hostname is correct already
  2083. Host = FSessionData->OrigHostName;
  2084. Port = FSessionData->OrigPortNumber;
  2085. }
  2086. }
  2087. //---------------------------------------------------------------------------
  2088. bool TSecureShell::HaveAcceptNewHostKeyPolicy()
  2089. {
  2090. return SameText(FSessionData->HostKey.Trim(), L"acceptnew");
  2091. }
  2092. //---------------------------------------------------------------------------
  2093. THierarchicalStorage * TSecureShell::GetHostKeyStorage()
  2094. {
  2095. if (!Configuration->Persistent && HaveAcceptNewHostKeyPolicy())
  2096. {
  2097. return Configuration->CreateConfigRegistryStorage();
  2098. }
  2099. else
  2100. {
  2101. return Configuration->CreateConfigStorage();
  2102. }
  2103. }
  2104. //---------------------------------------------------------------------------
  2105. UnicodeString __fastcall TSecureShell::RetrieveHostKey(const UnicodeString & Host, int Port, const UnicodeString & KeyType)
  2106. {
  2107. std::unique_ptr<THierarchicalStorage> Storage(GetHostKeyStorage());
  2108. Storage->AccessMode = smRead;
  2109. TGuard Guard(PuttyStorageSection.get());
  2110. DebugAssert(PuttyStorage == NULL);
  2111. TValueRestorer<THierarchicalStorage *> StorageRestorer(PuttyStorage);
  2112. PuttyStorage = Storage.get();
  2113. AnsiString AnsiStoredKeys;
  2114. AnsiStoredKeys.SetLength(10240);
  2115. UnicodeString Result;
  2116. if (retrieve_host_key(AnsiString(Host).c_str(), Port, AnsiString(KeyType).c_str(),
  2117. AnsiStoredKeys.c_str(), AnsiStoredKeys.Length()) == 0)
  2118. {
  2119. PackStr(AnsiStoredKeys);
  2120. Result = UnicodeString(AnsiStoredKeys);
  2121. }
  2122. return Result;
  2123. }
  2124. //---------------------------------------------------------------------------
  2125. static bool DoVerifyFingerprint(const UnicodeString & AFingerprintFromUser, const UnicodeString & AFingerprintFromHost, bool Base64)
  2126. {
  2127. UnicodeString FingerprintFromUser = AFingerprintFromUser;
  2128. UnicodeString FingerprintFromHost = AFingerprintFromHost;
  2129. UnicodeString FingerprintFromUserName, FingerprintFromHostName;
  2130. NormalizeFingerprint(FingerprintFromUser, FingerprintFromUserName);
  2131. NormalizeFingerprint(FingerprintFromHost, FingerprintFromHostName);
  2132. bool Result;
  2133. if (DebugAlwaysFalse(FingerprintFromHostName.IsEmpty()))
  2134. {
  2135. Result = false;
  2136. }
  2137. else
  2138. {
  2139. // In all below three formats, the checksum can be any of these formats:
  2140. // MD5 (case insensitive):
  2141. // xx:xx:xx
  2142. // xx-xx-xx
  2143. // SHA-256 (case sensitive):
  2144. // xxxx+xx/xxx=
  2145. // xxxx+xx/xxx
  2146. // xxxx-xx_xxx=
  2147. // xxxx-xx_xxx
  2148. // Full fingerprint format "type bits checksum"
  2149. if (!FingerprintFromUserName.IsEmpty())
  2150. {
  2151. Result =
  2152. SameText(FingerprintFromUserName, FingerprintFromHostName) &&
  2153. SameChecksum(FingerprintFromUser, FingerprintFromHost, Base64);
  2154. }
  2155. else
  2156. {
  2157. // normalized format "type-checksum"
  2158. UnicodeString NormalizedPrefix = FingerprintFromHost + NormalizedFingerprintSeparator;
  2159. if (StartsText(NormalizedPrefix, FingerprintFromUser))
  2160. {
  2161. FingerprintFromUser.Delete(1, NormalizedPrefix.Length());
  2162. Result = SameChecksum(FingerprintFromUser, FingerprintFromHost, Base64);
  2163. }
  2164. else
  2165. {
  2166. // last resort: "checksum" only
  2167. Result = SameChecksum(FingerprintFromUser, FingerprintFromHost, Base64);
  2168. }
  2169. }
  2170. }
  2171. return Result;
  2172. }
  2173. //---------------------------------------------------------------------------
  2174. static bool VerifyFingerprint(
  2175. const UnicodeString & FingerprintFromUser, const UnicodeString & FingerprintFromHostMD5, const UnicodeString & FingerprintFromHostSHA256)
  2176. {
  2177. return
  2178. DoVerifyFingerprint(FingerprintFromUser, FingerprintFromHostMD5, false) ||
  2179. DoVerifyFingerprint(FingerprintFromUser, FingerprintFromHostSHA256, true);
  2180. }
  2181. //---------------------------------------------------------------------------
  2182. struct TPasteKeyHandler
  2183. {
  2184. UnicodeString KeyStr;
  2185. UnicodeString FingerprintMD5;
  2186. UnicodeString FingerprintSHA256;
  2187. TSessionUI * UI;
  2188. void __fastcall Paste(TObject * Sender, unsigned int & Answer);
  2189. };
  2190. //---------------------------------------------------------------------------
  2191. void __fastcall TPasteKeyHandler::Paste(TObject * /*Sender*/, unsigned int & Answer)
  2192. {
  2193. UnicodeString ClipboardText;
  2194. if (TextFromClipboard(ClipboardText, true))
  2195. {
  2196. if (VerifyFingerprint(ClipboardText, FingerprintMD5, FingerprintSHA256) ||
  2197. SameText(ClipboardText, KeyStr))
  2198. {
  2199. Answer = qaYes;
  2200. }
  2201. else
  2202. {
  2203. const struct ssh_keyalg * Algorithm;
  2204. try
  2205. {
  2206. UnicodeString Key = ParseOpenSshPubLine(ClipboardText, Algorithm);
  2207. if (Key == KeyStr)
  2208. {
  2209. Answer = qaYes;
  2210. }
  2211. }
  2212. catch (...)
  2213. {
  2214. // swallow
  2215. }
  2216. }
  2217. }
  2218. if (Answer == 0)
  2219. {
  2220. UI->QueryUser(LoadStr(HOSTKEY_NOT_MATCH_CLIPBOARD), NULL, qaOK, NULL, qtError);
  2221. }
  2222. }
  2223. //---------------------------------------------------------------------------
  2224. bool TSecureShell::VerifyCachedHostKey(
  2225. const UnicodeString & StoredKeys, const UnicodeString & KeyStr, const UnicodeString & FingerprintMD5, const UnicodeString & FingerprintSHA256)
  2226. {
  2227. bool Result = false;
  2228. UnicodeString Buf = StoredKeys;
  2229. while (!Result && !Buf.IsEmpty())
  2230. {
  2231. UnicodeString StoredKey = CutToChar(Buf, HostKeyDelimiter, false);
  2232. // skip leading ECDH subtype identification
  2233. int P = StoredKey.Pos(L",");
  2234. // Start from beginning or after the comma, if there's any.
  2235. // If it does not start with 0x, it's probably a fingerprint (stored by TSessionData::CacheHostKey).
  2236. bool Fingerprint = (StoredKey.SubString(P + 1, 2) != L"0x");
  2237. if (!Fingerprint && (StoredKey == KeyStr))
  2238. {
  2239. LogEvent(L"Host key matches cached key");
  2240. Result = true;
  2241. }
  2242. else if (Fingerprint && VerifyFingerprint(StoredKey, FingerprintMD5, FingerprintSHA256))
  2243. {
  2244. LogEvent(L"Host key matches cached key fingerprint");
  2245. Result = true;
  2246. }
  2247. else
  2248. {
  2249. if (Configuration->ActualLogProtocol >= 1)
  2250. {
  2251. UnicodeString FormattedKey = Fingerprint ? StoredKey : FormatKeyStr(StoredKey);
  2252. LogEvent(FORMAT(L"Host key does not match cached key %s", (FormattedKey)));
  2253. }
  2254. else
  2255. {
  2256. LogEvent(L"Host key does not match cached key");
  2257. }
  2258. }
  2259. }
  2260. return Result;
  2261. }
  2262. //---------------------------------------------------------------------------
  2263. UnicodeString TSecureShell::StoreHostKey(
  2264. const UnicodeString & Host, int Port, const UnicodeString & KeyType, const UnicodeString & KeyStr)
  2265. {
  2266. TGuard Guard(PuttyStorageSection.get());
  2267. DebugAssert(PuttyStorage == NULL);
  2268. TValueRestorer<THierarchicalStorage *> StorageRestorer(PuttyStorage);
  2269. std::unique_ptr<THierarchicalStorage> Storage(GetHostKeyStorage());
  2270. Storage->AccessMode = smReadWrite;
  2271. PuttyStorage = Storage.get();
  2272. store_host_key(AnsiString(Host).c_str(), Port, AnsiString(KeyType).c_str(), AnsiString(KeyStr).c_str());
  2273. return Storage->Source;
  2274. }
  2275. //---------------------------------------------------------------------------
  2276. void TSecureShell::ParseFingerprint(const UnicodeString & Fingerprint, UnicodeString & SignKeyType, UnicodeString & Hash)
  2277. {
  2278. UnicodeString Buf = Fingerprint;
  2279. UnicodeString SignKeyAlg = CutToChar(Buf, L' ', false);
  2280. UnicodeString SignKeySize = CutToChar(Buf, L' ', false);
  2281. SignKeyType = SignKeyAlg + L' ' + SignKeySize;
  2282. Hash = Buf;
  2283. }
  2284. //---------------------------------------------------------------------------
  2285. void __fastcall TSecureShell::VerifyHostKey(
  2286. const UnicodeString & AHost, int Port, const UnicodeString & KeyType, const UnicodeString & KeyStr,
  2287. const UnicodeString & AFingerprintSHA256, const UnicodeString & AFingerprintMD5)
  2288. {
  2289. if (Configuration->ActualLogProtocol >= 1)
  2290. {
  2291. LogEvent(FORMAT(L"Verifying host key %s %s with fingerprints %s, %s", (KeyType, FormatKeyStr(KeyStr), AFingerprintSHA256, AFingerprintMD5)));
  2292. }
  2293. GotHostKey();
  2294. DebugAssert(KeyStr.Pos(HostKeyDelimiter) == 0);
  2295. UnicodeString Host = AHost;
  2296. GetRealHost(Host, Port);
  2297. UnicodeString SignKeyType, MD5, SHA256;
  2298. ParseFingerprint(AFingerprintMD5, SignKeyType, MD5);
  2299. DebugAssert(get_ssh_version(FBackendHandle) == 2);
  2300. UnicodeString SignKeyTypeSHA256;
  2301. ParseFingerprint(AFingerprintSHA256, SignKeyTypeSHA256, SHA256);
  2302. DebugAssert(SignKeyTypeSHA256 == SignKeyType);
  2303. if (DebugAlwaysTrue(StartsText(L"SHA256:", SHA256)))
  2304. {
  2305. CutToChar(SHA256, L':', false);
  2306. }
  2307. UnicodeString FingerprintMD5 = SignKeyType + L' ' + MD5;
  2308. DebugAssert(AFingerprintMD5 == FingerprintMD5);
  2309. UnicodeString FingerprintSHA256 = SignKeyType + L' ' + SHA256;
  2310. DebugAssert(ReplaceStr(AFingerprintSHA256, L"SHA256:", EmptyStr) == FingerprintSHA256);
  2311. FSessionInfo.HostKeyFingerprintSHA256 = FingerprintSHA256;
  2312. FSessionInfo.HostKeyFingerprintMD5 = FingerprintMD5;
  2313. if (FSessionData->FingerprintScan)
  2314. {
  2315. Abort();
  2316. }
  2317. bool AcceptNew = HaveAcceptNewHostKeyPolicy();
  2318. UnicodeString ConfigHostKey;
  2319. if (!AcceptNew)
  2320. {
  2321. ConfigHostKey = FSessionData->HostKey;
  2322. }
  2323. UnicodeString StoredKeys = RetrieveHostKey(Host, Port, KeyType);
  2324. bool Result = VerifyCachedHostKey(StoredKeys, KeyStr, FingerprintMD5, FingerprintSHA256);
  2325. if (!Result && AcceptNew)
  2326. {
  2327. if (!StoredKeys.IsEmpty()) // optimization + avoiding the log message
  2328. {
  2329. AcceptNew = false;
  2330. }
  2331. else if (have_any_ssh2_hostkey(FSeat, AnsiString(Host).c_str(), Port))
  2332. {
  2333. LogEvent(L"Host key not found in the cache, but other key types found, cannot accept new key");
  2334. AcceptNew = false;
  2335. }
  2336. }
  2337. bool ConfiguredKeyNotMatch = false;
  2338. if (!Result && !ConfigHostKey.IsEmpty() &&
  2339. // Should test have_any_ssh2_hostkey + No need to bother with AcceptNew, as we never get here
  2340. (StoredKeys.IsEmpty() || FSessionData->OverrideCachedHostKey))
  2341. {
  2342. UnicodeString Buf = ConfigHostKey;
  2343. while (!Result && !Buf.IsEmpty())
  2344. {
  2345. UnicodeString ExpectedKey = CutToChar(Buf, HostKeyDelimiter, false);
  2346. if (ExpectedKey == L"*")
  2347. {
  2348. UnicodeString Message = LoadStr(ANY_HOSTKEY);
  2349. FUI->Information(Message, true);
  2350. FLog->Add(llException, Message);
  2351. Result = true;
  2352. }
  2353. else if (VerifyFingerprint(ExpectedKey, FingerprintMD5, FingerprintSHA256))
  2354. {
  2355. LogEvent(L"Host key matches configured key fingerprint");
  2356. Result = true;
  2357. }
  2358. else
  2359. {
  2360. LogEvent(FORMAT(L"Host key does not match configured key fingerprint %s", (ExpectedKey)));
  2361. }
  2362. }
  2363. if (!Result)
  2364. {
  2365. ConfiguredKeyNotMatch = true;
  2366. }
  2367. }
  2368. if (!Result && AcceptNew && DebugAlwaysTrue(ConfigHostKey.IsEmpty()))
  2369. {
  2370. try
  2371. {
  2372. UnicodeString StorageSource = StoreHostKey(Host, Port, KeyType, KeyStr);
  2373. UnicodeString StoredKeys = RetrieveHostKey(Host, Port, KeyType);
  2374. if (StoredKeys != KeyStr)
  2375. {
  2376. throw Exception(UnicodeString());
  2377. }
  2378. Configuration->Usage->Inc(L"HostKeyNewAccepted");
  2379. LogEvent(FORMAT(L"Warning: Stored new host key to %s - This should occur only on the first connection", (StorageSource)));
  2380. Result = true;
  2381. }
  2382. catch (Exception & E)
  2383. {
  2384. FUI->FatalError(&E, LoadStr(STORE_NEW_HOSTKEY_ERROR));
  2385. }
  2386. }
  2387. if (!Result)
  2388. {
  2389. bool Verified;
  2390. if (ConfiguredKeyNotMatch || Configuration->DisableAcceptingHostKeys)
  2391. {
  2392. Verified = false;
  2393. }
  2394. // no point offering manual verification, if we cannot persist the verified key
  2395. else if (!Configuration->Persistent && Configuration->Scripting)
  2396. {
  2397. Verified = false;
  2398. }
  2399. else
  2400. {
  2401. // We should not offer caching if !Configuration->Persistent,
  2402. // but as scripting mode is handled earlier and in GUI it hardly happens,
  2403. // it's a small issue.
  2404. TClipboardHandler ClipboardHandler;
  2405. ClipboardHandler.Text = FingerprintSHA256 + L"\n" + FingerprintMD5;
  2406. TPasteKeyHandler PasteKeyHandler;
  2407. PasteKeyHandler.KeyStr = KeyStr;
  2408. PasteKeyHandler.FingerprintMD5 = FingerprintMD5;
  2409. PasteKeyHandler.FingerprintSHA256 = FingerprintSHA256;
  2410. PasteKeyHandler.UI = FUI;
  2411. bool Unknown = StoredKeys.IsEmpty();
  2412. int Answers;
  2413. int AliasesCount;
  2414. TQueryButtonAlias Aliases[4];
  2415. Aliases[0].Button = qaRetry;
  2416. Aliases[0].Alias = LoadStr(COPY_KEY_BUTTON);
  2417. Aliases[0].ActionAlias = LoadStr(COPY_KEY_ACTION);
  2418. Aliases[0].OnSubmit = &ClipboardHandler.Copy;
  2419. Aliases[1].Button = qaIgnore;
  2420. Aliases[1].Alias = LoadStr(PASTE_KEY_BUTTON);
  2421. Aliases[1].OnSubmit = &PasteKeyHandler.Paste;
  2422. Aliases[1].GroupWith = qaYes;
  2423. Answers = qaYes | qaCancel | qaRetry | qaIgnore;
  2424. AliasesCount = 2;
  2425. if (!Unknown)
  2426. {
  2427. Aliases[2].Button = qaYes;
  2428. Aliases[2].Alias = LoadStr(UPDATE_KEY_BUTTON);
  2429. Aliases[3].Button = qaOK;
  2430. Aliases[3].Alias = LoadStr(ADD_KEY_BUTTON);
  2431. AliasesCount += 2;
  2432. Answers |= qaSkip | qaOK;
  2433. }
  2434. else
  2435. {
  2436. Answers |= qaNo;
  2437. }
  2438. TQueryParams Params(qpWaitInBatch);
  2439. Params.NoBatchAnswers = qaYes | qaRetry | qaSkip | qaOK;
  2440. Params.HelpKeyword = (Unknown ? HELP_UNKNOWN_KEY : HELP_DIFFERENT_KEY);
  2441. Params.Aliases = Aliases;
  2442. Params.AliasesCount = AliasesCount;
  2443. UnicodeString KeyTypeHuman = GetKeyTypeHuman(KeyType);
  2444. UnicodeString KeyDetails = FMTLOAD(KEY_DETAILS, (SignKeyType, SHA256, MD5));
  2445. UnicodeString Message = FMTLOAD((Unknown ? UNKNOWN_KEY4 : DIFFERENT_KEY5), (KeyTypeHuman, KeyDetails));
  2446. if (Configuration->Scripting)
  2447. {
  2448. AddToList(Message, LoadStr(SCRIPTING_USE_HOSTKEY), L"\n");
  2449. }
  2450. unsigned int R =
  2451. FUI->QueryUser(Message, NULL, Answers, &Params, qtWarning);
  2452. UnicodeString StoreKeyStr = KeyStr;
  2453. switch (R) {
  2454. case qaOK:
  2455. DebugAssert(!Unknown);
  2456. StoreKeyStr = (StoredKeys + HostKeyDelimiter + StoreKeyStr);
  2457. // fall thru
  2458. case qaYes:
  2459. StoreHostKey(Host, Port, KeyType, StoreKeyStr);
  2460. Verified = true;
  2461. break;
  2462. case qaCancel:
  2463. Verified = false;
  2464. break;
  2465. default:
  2466. Verified = true;
  2467. break;
  2468. }
  2469. }
  2470. if (!Verified)
  2471. {
  2472. Configuration->Usage->Inc(L"HostNotVerified");
  2473. UnicodeString Message;
  2474. if (ConfiguredKeyNotMatch)
  2475. {
  2476. Message = FMTLOAD(CONFIGURED_KEY_NOT_MATCH, (ConfigHostKey));
  2477. }
  2478. else if (!Configuration->Persistent && Configuration->Scripting)
  2479. {
  2480. Message = LoadStr(HOSTKEY_NOT_CONFIGURED);
  2481. }
  2482. else
  2483. {
  2484. Message = LoadStr(KEY_NOT_VERIFIED);
  2485. }
  2486. Exception * E = new Exception(MainInstructions(Message));
  2487. try
  2488. {
  2489. FUI->FatalError(E, FMTLOAD(HOSTKEY, (FingerprintSHA256)));
  2490. }
  2491. __finally
  2492. {
  2493. delete E;
  2494. }
  2495. }
  2496. }
  2497. Configuration->RememberLastFingerprint(FSessionData->SiteKey, SshFingerprintType, FingerprintSHA256);
  2498. }
  2499. //---------------------------------------------------------------------------
  2500. bool __fastcall TSecureShell::HaveHostKey(UnicodeString Host, int Port, const UnicodeString KeyType)
  2501. {
  2502. // Return true, if we have any host key fingerprint of a particular type
  2503. GetRealHost(Host, Port);
  2504. UnicodeString StoredKeys = RetrieveHostKey(Host, Port, KeyType);
  2505. bool Result = !StoredKeys.IsEmpty();
  2506. if (!FSessionData->HostKey.IsEmpty())
  2507. {
  2508. UnicodeString Buf = FSessionData->HostKey;
  2509. while (!Result && !Buf.IsEmpty())
  2510. {
  2511. UnicodeString ExpectedKey = CutToChar(Buf, HostKeyDelimiter, false);
  2512. UnicodeString ExpectedKeyType = KeyTypeFromFingerprint(ExpectedKey);
  2513. Result = SameText(ExpectedKeyType, KeyType);
  2514. }
  2515. }
  2516. if (Result &&
  2517. (FLoggedKnownHostKeys.find(KeyType) == FLoggedKnownHostKeys.end()))
  2518. {
  2519. LogEvent(FORMAT(L"Have a known host key of type %s", (KeyType)));
  2520. // This is called multiple times for the same cached key since PuTTY 0.76 (support for rsa-sha2*?).
  2521. // Avoid repeated log entries.
  2522. FLoggedKnownHostKeys.insert(KeyType);
  2523. }
  2524. return Result;
  2525. }
  2526. //---------------------------------------------------------------------------
  2527. void __fastcall TSecureShell::AskAlg(UnicodeString AlgType, UnicodeString AlgName)
  2528. {
  2529. // beware of changing order
  2530. static const TPuttyTranslation AlgTranslation[] = {
  2531. { L"cipher", CIPHER_TYPE_BOTH2 },
  2532. { L"client-to-server cipher", CIPHER_TYPE_CS2 },
  2533. { L"server-to-client cipher", CIPHER_TYPE_SC2 },
  2534. { L"key-exchange algorithm", KEY_EXCHANGE_ALG },
  2535. { L"hostkey type", KEYKEY_TYPE },
  2536. };
  2537. TranslatePuttyMessage(AlgTranslation, LENOF(AlgTranslation), AlgType);
  2538. UnicodeString Msg = FMTLOAD(ALG_BELOW_TRESHOLD, (AlgType, AlgName));
  2539. if (FUI->QueryUser(Msg, NULL, qaYes | qaNo, NULL, qtWarning) == qaNo)
  2540. {
  2541. UnicodeString Error = FMTLOAD(ALG_NOT_VERIFIED, (AlgType, AlgName));
  2542. FUI->FatalError(NULL, Error);
  2543. }
  2544. }
  2545. //---------------------------------------------------------------------------
  2546. void __fastcall TSecureShell::DisplayBanner(const UnicodeString & Banner)
  2547. {
  2548. // Since 0.77 PuTTY calls this again with CRLF if the actual banner does not end with one.
  2549. if (!Banner.Trim().IsEmpty())
  2550. {
  2551. FUI->DisplayBanner(Banner);
  2552. }
  2553. }
  2554. //---------------------------------------------------------------------------
  2555. void __fastcall TSecureShell::OldKeyfileWarning()
  2556. {
  2557. // actually never called, see Net.cpp
  2558. FUI->QueryUser(LoadStr(OLD_KEY), NULL, qaOK, NULL, qtWarning);
  2559. }
  2560. //---------------------------------------------------------------------------
  2561. bool __fastcall TSecureShell::GetStoredCredentialsTried()
  2562. {
  2563. return FStoredPasswordTried || FStoredPasswordTriedForKI || FStoredPassphraseTried;
  2564. }
  2565. //---------------------------------------------------------------------------
  2566. bool __fastcall TSecureShell::GetReady()
  2567. {
  2568. return FOpened && (FWaiting == 0);
  2569. }
  2570. //---------------------------------------------------------------------------
  2571. void __fastcall TSecureShell::CollectUsage()
  2572. {
  2573. if (FCollectPrivateKeyUsage)
  2574. {
  2575. Configuration->Usage->Inc(L"OpenedSessionsPrivateKey2");
  2576. }
  2577. Configuration->Usage->Inc(L"OpenedSessionsSSH2");
  2578. if (SshImplementation == sshiOpenSSH)
  2579. {
  2580. Configuration->Usage->Inc(L"OpenedSessionsSSHOpenSSH");
  2581. }
  2582. else if (SshImplementation == sshiProFTPD)
  2583. {
  2584. Configuration->Usage->Inc(L"OpenedSessionsSSHProFTPD");
  2585. }
  2586. else if (SshImplementation == sshiBitvise)
  2587. {
  2588. Configuration->Usage->Inc(L"OpenedSessionsSSHBitvise");
  2589. }
  2590. else if (SshImplementation == sshiTitan)
  2591. {
  2592. Configuration->Usage->Inc(L"OpenedSessionsSSHTitan");
  2593. }
  2594. else if (SshImplementation == sshiOpenVMS)
  2595. {
  2596. Configuration->Usage->Inc(L"OpenedSessionsSSHOpenVMS");
  2597. }
  2598. else if (ContainsText(FSessionInfo.SshImplementation, L"Serv-U"))
  2599. {
  2600. Configuration->Usage->Inc(L"OpenedSessionsSSHServU");
  2601. }
  2602. else if (SshImplementation == sshiCerberus)
  2603. {
  2604. // Ntb, Cerberus can also be detected using vendor-id extension
  2605. // Cerberus FTP Server 7.0.5.3 (70005003) by Cerberus, LLC
  2606. Configuration->Usage->Inc(L"OpenedSessionsSSHCerberus");
  2607. }
  2608. else if (ContainsText(FSessionInfo.SshImplementation, L"WS_FTP"))
  2609. {
  2610. Configuration->Usage->Inc(L"OpenedSessionsSSHWSFTP");
  2611. }
  2612. // SSH-2.0-1.36_sshlib GlobalSCAPE
  2613. else if (ContainsText(FSessionInfo.SshImplementation, L"GlobalSCAPE"))
  2614. {
  2615. Configuration->Usage->Inc(L"OpenedSessionsSSHGlobalScape");
  2616. }
  2617. // SSH-2.0-CompleteFTP-8.1.3
  2618. else if (ContainsText(FSessionInfo.SshImplementation, L"CompleteFTP"))
  2619. {
  2620. Configuration->Usage->Inc(L"OpenedSessionsSSHComplete");
  2621. }
  2622. // SSH-2.0-CoreFTP-0.3.3
  2623. else if (ContainsText(FSessionInfo.SshImplementation, L"CoreFTP"))
  2624. {
  2625. Configuration->Usage->Inc(L"OpenedSessionsSSHCore");
  2626. }
  2627. // SSH-2.0-SSHD-CORE-0.11.0 (value is configurable, this is a default)
  2628. // (Apache Mina SSHD, e.g. on brickftp.com)
  2629. else if (ContainsText(FSessionInfo.SshImplementation, L"SSHD-CORE"))
  2630. {
  2631. Configuration->Usage->Inc(L"OpenedSessionsSSHApache");
  2632. }
  2633. // SSH-2.0-Syncplify_Me_Server
  2634. else if (ContainsText(FSessionInfo.SshImplementation, L"Syncplify"))
  2635. {
  2636. Configuration->Usage->Inc(L"OpenedSessionsSSHSyncplify");
  2637. }
  2638. else if (ContainsText(FSessionInfo.SshImplementation, L"zFTPServer"))
  2639. {
  2640. Configuration->Usage->Inc(L"OpenedSessionsSSHzFTP");
  2641. }
  2642. else
  2643. {
  2644. Configuration->Usage->Inc(L"OpenedSessionsSSHOther");
  2645. }
  2646. int CipherGroup = GetCipherGroup(get_cscipher(FBackendHandle));
  2647. switch (CipherGroup)
  2648. {
  2649. case CIPHER_3DES: Configuration->Usage->Inc(L"OpenedSessionsSSHCipher3DES"); break;
  2650. case CIPHER_BLOWFISH: Configuration->Usage->Inc(L"OpenedSessionsSSHCipherBlowfish"); break;
  2651. case CIPHER_AES: Configuration->Usage->Inc(L"OpenedSessionsSSHCipherAES"); break;
  2652. // All following miss "Cipher"
  2653. case CIPHER_DES: Configuration->Usage->Inc(L"OpenedSessionsSSHDES"); break;
  2654. case CIPHER_ARCFOUR: Configuration->Usage->Inc(L"OpenedSessionsSSHArcfour"); break;
  2655. case CIPHER_CHACHA20: Configuration->Usage->Inc(L"OpenedSessionsSSHChaCha20"); break;
  2656. case CIPHER_AESGCM: Configuration->Usage->Inc(L"OpenedSessionsSSHAESGCM"); break;
  2657. default: DebugFail(); break;
  2658. }
  2659. }
  2660. //---------------------------------------------------------------------------
  2661. bool __fastcall TSecureShell::CanChangePassword()
  2662. {
  2663. return
  2664. // These major SSH servers explicitly do not support password change.
  2665. (SshImplementation != sshiOpenSSH) && // See userauth_passwd
  2666. (SshImplementation != sshiProFTPD); // See sftp_auth_password
  2667. }