SftpFileSystem.cpp 185 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883
  1. //---------------------------------------------------------------------------
  2. #include <vcl.h>
  3. #pragma hdrstop
  4. #include "SftpFileSystem.h"
  5. #include "PuttyTools.h"
  6. #include "Common.h"
  7. #include "Exceptions.h"
  8. #include "Interface.h"
  9. #include "Terminal.h"
  10. #include "TextsCore.h"
  11. #include "HelpCore.h"
  12. #include "SecureShell.h"
  13. #include "Cryptography.h"
  14. #include <WideStrUtils.hpp>
  15. #include <limits>
  16. #include <memory>
  17. //---------------------------------------------------------------------------
  18. #pragma package(smart_init)
  19. //---------------------------------------------------------------------------
  20. #define FILE_OPERATION_LOOP_TERMINAL FTerminal
  21. //---------------------------------------------------------------------------
  22. #define SSH_FX_OK 0
  23. #define SSH_FX_EOF 1
  24. #define SSH_FX_NO_SUCH_FILE 2
  25. #define SSH_FX_PERMISSION_DENIED 3
  26. #define SSH_FX_FAILURE 4
  27. #define SSH_FX_OP_UNSUPPORTED 8
  28. #define SSH_FXP_INIT 1
  29. #define SSH_FXP_VERSION 2
  30. #define SSH_FXP_OPEN 3
  31. #define SSH_FXP_CLOSE 4
  32. #define SSH_FXP_READ 5
  33. #define SSH_FXP_WRITE 6
  34. #define SSH_FXP_LSTAT 7
  35. #define SSH_FXP_FSTAT 8
  36. #define SSH_FXP_SETSTAT 9
  37. #define SSH_FXP_FSETSTAT 10
  38. #define SSH_FXP_OPENDIR 11
  39. #define SSH_FXP_READDIR 12
  40. #define SSH_FXP_REMOVE 13
  41. #define SSH_FXP_MKDIR 14
  42. #define SSH_FXP_RMDIR 15
  43. #define SSH_FXP_REALPATH 16
  44. #define SSH_FXP_STAT 17
  45. #define SSH_FXP_RENAME 18
  46. #define SSH_FXP_READLINK 19
  47. #define SSH_FXP_SYMLINK 20
  48. #define SSH_FXP_LINK 21
  49. #define SSH_FXP_STATUS 101
  50. #define SSH_FXP_HANDLE 102
  51. #define SSH_FXP_DATA 103
  52. #define SSH_FXP_NAME 104
  53. #define SSH_FXP_ATTRS 105
  54. #define SSH_FXP_EXTENDED 200
  55. #define SSH_FXP_EXTENDED_REPLY 201
  56. #define SSH_FXP_ATTRS 105
  57. #define SSH_FILEXFER_ATTR_SIZE 0x00000001
  58. #define SSH_FILEXFER_ATTR_UIDGID 0x00000002
  59. #define SSH_FILEXFER_ATTR_PERMISSIONS 0x00000004
  60. #define SSH_FILEXFER_ATTR_ACMODTIME 0x00000008
  61. #define SSH_FILEXFER_ATTR_EXTENDED 0x80000000
  62. #define SSH_FILEXFER_ATTR_ACCESSTIME 0x00000008
  63. #define SSH_FILEXFER_ATTR_CREATETIME 0x00000010
  64. #define SSH_FILEXFER_ATTR_MODIFYTIME 0x00000020
  65. #define SSH_FILEXFER_ATTR_ACL 0x00000040
  66. #define SSH_FILEXFER_ATTR_OWNERGROUP 0x00000080
  67. #define SSH_FILEXFER_ATTR_SUBSECOND_TIMES 0x00000100
  68. #define SSH_FILEXFER_ATTR_BITS 0x00000200
  69. #define SSH_FILEXFER_ATTR_ALLOCATION_SIZE 0x00000400
  70. #define SSH_FILEXFER_ATTR_TEXT_HINT 0x00000800
  71. #define SSH_FILEXFER_ATTR_MIME_TYPE 0x00001000
  72. #define SSH_FILEXFER_ATTR_LINK_COUNT 0x00002000
  73. #define SSH_FILEXFER_ATTR_UNTRANSLATED_NAME 0x00004000
  74. #define SSH_FILEXFER_ATTR_CTIME 0x00008000
  75. #define SSH_FILEXFER_ATTR_EXTENDED 0x80000000
  76. #define SSH_FILEXFER_ATTR_COMMON \
  77. (SSH_FILEXFER_ATTR_SIZE | SSH_FILEXFER_ATTR_OWNERGROUP | \
  78. SSH_FILEXFER_ATTR_PERMISSIONS | SSH_FILEXFER_ATTR_ACCESSTIME | \
  79. SSH_FILEXFER_ATTR_MODIFYTIME)
  80. #define SSH_FILEXFER_TYPE_REGULAR 1
  81. #define SSH_FILEXFER_TYPE_DIRECTORY 2
  82. #define SSH_FILEXFER_TYPE_SYMLINK 3
  83. #define SSH_FILEXFER_TYPE_SPECIAL 4
  84. #define SSH_FILEXFER_TYPE_UNKNOWN 5
  85. #define SSH_FXF_READ 0x00000001
  86. #define SSH_FXF_WRITE 0x00000002
  87. #define SSH_FXF_APPEND 0x00000004
  88. #define SSH_FXF_CREAT 0x00000008
  89. #define SSH_FXF_TRUNC 0x00000010
  90. #define SSH_FXF_EXCL 0x00000020
  91. #define SSH_FXF_TEXT 0x00000040
  92. #define SSH_FXF_ACCESS_DISPOSITION 0x00000007
  93. #define SSH_FXF_CREATE_NEW 0x00000000
  94. #define SSH_FXF_CREATE_TRUNCATE 0x00000001
  95. #define SSH_FXF_OPEN_EXISTING 0x00000002
  96. #define SSH_FXF_OPEN_OR_CREATE 0x00000003
  97. #define SSH_FXF_TRUNCATE_EXISTING 0x00000004
  98. #define SSH_FXF_ACCESS_APPEND_DATA 0x00000008
  99. #define SSH_FXF_ACCESS_APPEND_DATA_ATOMIC 0x00000010
  100. #define SSH_FXF_ACCESS_TEXT_MODE 0x00000020
  101. #define ACE4_READ_DATA 0x00000001
  102. #define ACE4_LIST_DIRECTORY 0x00000001
  103. #define ACE4_WRITE_DATA 0x00000002
  104. #define ACE4_ADD_FILE 0x00000002
  105. #define ACE4_APPEND_DATA 0x00000004
  106. #define ACE4_ADD_SUBDIRECTORY 0x00000004
  107. #define ACE4_READ_NAMED_ATTRS 0x00000008
  108. #define ACE4_WRITE_NAMED_ATTRS 0x00000010
  109. #define ACE4_EXECUTE 0x00000020
  110. #define ACE4_DELETE_CHILD 0x00000040
  111. #define ACE4_READ_ATTRIBUTES 0x00000080
  112. #define ACE4_WRITE_ATTRIBUTES 0x00000100
  113. #define ACE4_DELETE 0x00010000
  114. #define ACE4_READ_ACL 0x00020000
  115. #define ACE4_WRITE_ACL 0x00040000
  116. #define ACE4_WRITE_OWNER 0x00080000
  117. #define ACE4_SYNCHRONIZE 0x00100000
  118. #define SSH_FILEXFER_ATTR_FLAGS_HIDDEN 0x00000004
  119. #define SSH_FXP_REALPATH_NO_CHECK 0x00000001
  120. #define SSH_FXP_REALPATH_STAT_IF 0x00000002
  121. #define SSH_FXP_REALPATH_STAT_ALWAYS 0x00000003
  122. #define SFTP_MAX_PACKET_LEN 1024000
  123. //---------------------------------------------------------------------------
  124. #define SFTP_EXT_OWNER_GROUP L"owner-group-query@generic-extensions"
  125. #define SFTP_EXT_OWNER_GROUP_REPLY L"owner-group-query-reply@generic-extensions"
  126. #define SFTP_EXT_NEWLINE L"newline"
  127. #define SFTP_EXT_SUPPORTED L"supported"
  128. #define SFTP_EXT_SUPPORTED2 L"supported2"
  129. #define SFTP_EXT_FSROOTS L"[email protected]"
  130. #define SFTP_EXT_VENDOR_ID L"vendor-id"
  131. #define SFTP_EXT_VERSIONS L"versions"
  132. #define SFTP_EXT_SPACE_AVAILABLE L"space-available"
  133. #define SFTP_EXT_CHECK_FILE L"check-file"
  134. #define SFTP_EXT_CHECK_FILE_NAME L"check-file-name"
  135. #define SFTP_EXT_STATVFS L"[email protected]"
  136. #define SFTP_EXT_STATVFS_VALUE_V2 L"2"
  137. #define SFTP_EXT_STATVFS_ST_RDONLY 0x1
  138. #define SFTP_EXT_STATVFS_ST_NOSUID 0x2
  139. #define SFTP_EXT_HARDLINK L"[email protected]"
  140. #define SFTP_EXT_HARDLINK_VALUE_V1 L"1"
  141. #define SFTP_EXT_COPY_FILE L"copy-file"
  142. #define SFTP_EXT_COPY_DATA L"copy-data"
  143. #define SFTP_EXT_LIMITS L"[email protected]"
  144. #define SFTP_EXT_LIMITS_VALUE_V1 L"1"
  145. #define SFTP_EXT_POSIX_RENAME L"[email protected]"
  146. //---------------------------------------------------------------------------
  147. #define OGQ_LIST_OWNERS 0x01
  148. #define OGQ_LIST_GROUPS 0x02
  149. //---------------------------------------------------------------------------
  150. const int SFTPMinVersion = 0;
  151. const int SFTPStandardVersion = 3;
  152. const int SFTPMaxVersion = 6;
  153. const unsigned int SFTPNoMessageNumber = static_cast<unsigned int>(-1);
  154. const int asNo = 0;
  155. const int asOK = 1 << SSH_FX_OK;
  156. const int asEOF = 1 << SSH_FX_EOF;
  157. const int asPermDenied = 1 << SSH_FX_PERMISSION_DENIED;
  158. const int asOpUnsupported = 1 << SSH_FX_OP_UNSUPPORTED;
  159. const int asNoSuchFile = 1 << SSH_FX_NO_SUCH_FILE;
  160. const int asAll = 0xFFFF;
  161. //---------------------------------------------------------------------------
  162. #define GET_32BIT(cp) \
  163. (((unsigned long)(unsigned char)(cp)[0] << 24) | \
  164. ((unsigned long)(unsigned char)(cp)[1] << 16) | \
  165. ((unsigned long)(unsigned char)(cp)[2] << 8) | \
  166. ((unsigned long)(unsigned char)(cp)[3]))
  167. #define PUT_32BIT(cp, value) { \
  168. (cp)[0] = (unsigned char)((value) >> 24); \
  169. (cp)[1] = (unsigned char)((value) >> 16); \
  170. (cp)[2] = (unsigned char)((value) >> 8); \
  171. (cp)[3] = (unsigned char)(value); }
  172. //---------------------------------------------------------------------------
  173. #define SFTP_PACKET_ALLOC_DELTA 256
  174. //---------------------------------------------------------------------------
  175. #pragma warn -inl
  176. //---------------------------------------------------------------------------
  177. struct TSFTPSupport
  178. {
  179. TSFTPSupport() :
  180. AttribExtensions(new TStringList())
  181. {
  182. Reset();
  183. }
  184. ~TSFTPSupport()
  185. {
  186. delete AttribExtensions;
  187. }
  188. void Reset()
  189. {
  190. AttributeMask = 0;
  191. AttributeBits = 0;
  192. OpenFlags = 0;
  193. AccessMask = 0;
  194. MaxReadSize = 0;
  195. OpenBlockVector = 0;
  196. BlockVector = 0;
  197. AttribExtensions->Clear();
  198. Loaded = false;
  199. }
  200. unsigned int AttributeMask;
  201. unsigned int AttributeBits;
  202. unsigned int OpenFlags;
  203. unsigned int AccessMask;
  204. unsigned int MaxReadSize;
  205. unsigned int OpenBlockVector;
  206. unsigned int BlockVector;
  207. TStrings * AttribExtensions;
  208. bool Loaded;
  209. };
  210. //---------------------------------------------------------------------------
  211. class TSFTPPacket
  212. {
  213. public:
  214. TSFTPPacket()
  215. {
  216. Init();
  217. }
  218. TSFTPPacket(const TSFTPPacket & Source)
  219. {
  220. Init();
  221. *this = Source;
  222. }
  223. TSFTPPacket(unsigned char AType)
  224. {
  225. Init();
  226. ChangeType(AType);
  227. }
  228. TSFTPPacket(const unsigned char * Source, unsigned int Len)
  229. {
  230. Init();
  231. FLength = Len;
  232. Capacity = FLength;
  233. memcpy(Data, Source, Len);
  234. }
  235. TSFTPPacket(const RawByteString & Source)
  236. {
  237. Init();
  238. FLength = Source.Length();
  239. Capacity = FLength;
  240. memcpy(Data, Source.c_str(), Source.Length());
  241. }
  242. ~TSFTPPacket()
  243. {
  244. if (FData != NULL)
  245. {
  246. delete[] (FData - FSendPrefixLen);
  247. }
  248. if (FReservedBy) FReservedBy->UnreserveResponse(this);
  249. }
  250. void ChangeType(unsigned char AType)
  251. {
  252. FPosition = 0;
  253. FLength = 0;
  254. Capacity = 0;
  255. FType = AType;
  256. AddByte(FType);
  257. if ((FType != 1) && (FType != SSH_FXP_INIT))
  258. {
  259. AssignNumber();
  260. AddCardinal(FMessageNumber);
  261. }
  262. }
  263. void Reuse()
  264. {
  265. AssignNumber();
  266. DebugAssert(Length >= 5);
  267. // duplicated in AddCardinal()
  268. unsigned char Buf[4];
  269. PUT_32BIT(Buf, FMessageNumber);
  270. memcpy(FData + 1, Buf, sizeof(Buf));
  271. }
  272. void AddByte(unsigned char Value)
  273. {
  274. Add(&Value, sizeof(Value));
  275. }
  276. void AddBool(bool Value)
  277. {
  278. AddByte(Value ? 1 : 0);
  279. }
  280. void AddCardinal(unsigned long Value)
  281. {
  282. // duplicated in Reuse()
  283. unsigned char Buf[4];
  284. PUT_32BIT(Buf, Value);
  285. Add(&Buf, sizeof(Buf));
  286. }
  287. void AddInt64(__int64 Value)
  288. {
  289. AddCardinal((unsigned long)(Value >> 32));
  290. AddCardinal((unsigned long)(Value & 0xFFFFFFFF));
  291. }
  292. void AddData(const void * Data, int ALength)
  293. {
  294. AddCardinal(ALength);
  295. Add(Data, ALength);
  296. }
  297. void AddString(const RawByteString & Value)
  298. {
  299. AddCardinal(Value.Length());
  300. Add(Value.c_str(), Value.Length());
  301. }
  302. inline void AddUtfString(const UTF8String & Value)
  303. {
  304. AddString(Value);
  305. }
  306. inline void AddUtfString(const UnicodeString & Value)
  307. {
  308. AddUtfString(UTF8String(Value));
  309. }
  310. inline void AddString(const UnicodeString Value, TAutoSwitch Utf)
  311. {
  312. // asAuto: Using UTF until we receive non-UTF string from the server
  313. if ((Utf == asOn) || (Utf == asAuto))
  314. {
  315. AddUtfString(Value);
  316. }
  317. else
  318. {
  319. AddString(RawByteString(AnsiString(Value)));
  320. }
  321. }
  322. // now purposeless alias to AddString
  323. inline void AddPathString(const UnicodeString & Value, TAutoSwitch Utf)
  324. {
  325. AddString(Value, Utf);
  326. }
  327. unsigned int AllocationSizeAttribute(int Version)
  328. {
  329. return (Version >= 6) ? SSH_FILEXFER_ATTR_ALLOCATION_SIZE : SSH_FILEXFER_ATTR_SIZE;
  330. }
  331. void AddProperties(unsigned short * Rights, TRemoteToken * Owner,
  332. TRemoteToken * Group, __int64 * MTime, __int64 * ATime,
  333. __int64 * Size, bool IsDirectory, int Version, TAutoSwitch Utf)
  334. {
  335. int Flags = 0;
  336. if (Size != NULL)
  337. {
  338. Flags |= AllocationSizeAttribute(Version);
  339. }
  340. // both or neither
  341. DebugAssert((Owner != NULL) == (Group != NULL));
  342. if ((Owner != NULL) && (Group != NULL))
  343. {
  344. if (Version < 4)
  345. {
  346. DebugAssert(Owner->IDValid && Group->IDValid);
  347. Flags |= SSH_FILEXFER_ATTR_UIDGID;
  348. }
  349. else
  350. {
  351. DebugAssert(Owner->NameValid && Group->NameValid);
  352. Flags |= SSH_FILEXFER_ATTR_OWNERGROUP;
  353. }
  354. }
  355. if (Rights != NULL)
  356. {
  357. Flags |= SSH_FILEXFER_ATTR_PERMISSIONS;
  358. }
  359. if ((Version < 4) && ((MTime != NULL) || (ATime != NULL)))
  360. {
  361. Flags |= SSH_FILEXFER_ATTR_ACMODTIME;
  362. }
  363. if ((Version >= 4) && (ATime != NULL))
  364. {
  365. Flags |= SSH_FILEXFER_ATTR_ACCESSTIME;
  366. }
  367. if ((Version >= 4) && (MTime != NULL))
  368. {
  369. Flags |= SSH_FILEXFER_ATTR_MODIFYTIME;
  370. }
  371. AddCardinal(Flags);
  372. if (Version >= 4)
  373. {
  374. AddByte(static_cast<unsigned char>(IsDirectory ?
  375. SSH_FILEXFER_TYPE_DIRECTORY : SSH_FILEXFER_TYPE_REGULAR));
  376. }
  377. if (Size != NULL)
  378. {
  379. // this is SSH_FILEXFER_ATTR_SIZE for version <= 5, but
  380. // SSH_FILEXFER_ATTR_ALLOCATION_SIZE for version >= 6
  381. AddInt64(*Size);
  382. }
  383. if ((Owner != NULL) && (Group != NULL))
  384. {
  385. if (Version < 4)
  386. {
  387. DebugAssert(Owner->IDValid && Group->IDValid);
  388. AddCardinal(Owner->ID);
  389. AddCardinal(Group->ID);
  390. }
  391. else
  392. {
  393. DebugAssert(Owner->NameValid && Group->NameValid);
  394. AddString(Owner->Name, Utf);
  395. AddString(Group->Name, Utf);
  396. }
  397. }
  398. if (Rights != NULL)
  399. {
  400. AddCardinal(*Rights);
  401. }
  402. if ((Version < 4) && ((MTime != NULL) || (ATime != NULL)))
  403. {
  404. // any way to reflect sbSignedTS here?
  405. // (note that casting __int64 > 2^31 < 2^32 to unsigned long is wrapped,
  406. // thus we never can set time after 2038, even if the server supports it)
  407. AddCardinal(static_cast<unsigned long>(ATime != NULL ? *ATime : *MTime));
  408. AddCardinal(static_cast<unsigned long>(MTime != NULL ? *MTime : *ATime));
  409. }
  410. if ((Version >= 4) && (ATime != NULL))
  411. {
  412. AddInt64(*ATime);
  413. }
  414. if ((Version >= 4) && (MTime != NULL))
  415. {
  416. AddInt64(*MTime);
  417. }
  418. }
  419. void AddProperties(const TRemoteProperties * Properties,
  420. unsigned short BaseRights, bool IsDirectory, int Version, TAutoSwitch Utf,
  421. TChmodSessionAction * Action)
  422. {
  423. enum TValid { valNone = 0, valRights = 0x01, valOwner = 0x02, valGroup = 0x04,
  424. valMTime = 0x08, valATime = 0x10 } Valid = valNone;
  425. unsigned short RightsNum = 0;
  426. TRemoteToken Owner;
  427. TRemoteToken Group;
  428. __int64 MTime;
  429. __int64 ATime;
  430. if (Properties != NULL)
  431. {
  432. if (Properties->Valid.Contains(vpGroup))
  433. {
  434. Valid = (TValid)(Valid | valGroup);
  435. Group = Properties->Group;
  436. }
  437. if (Properties->Valid.Contains(vpOwner))
  438. {
  439. Valid = (TValid)(Valid | valOwner);
  440. Owner = Properties->Owner;
  441. }
  442. if (Properties->Valid.Contains(vpRights))
  443. {
  444. Valid = (TValid)(Valid | valRights);
  445. TRights Rights = TRights(BaseRights).Combine(Properties->Rights);
  446. if (IsDirectory && Properties->AddXToDirectories)
  447. {
  448. Rights.AddExecute();
  449. }
  450. RightsNum = Rights;
  451. if (Action != NULL)
  452. {
  453. Action->Rights(Rights);
  454. }
  455. }
  456. if (Properties->Valid.Contains(vpLastAccess))
  457. {
  458. Valid = (TValid)(Valid | valATime);
  459. ATime = Properties->LastAccess;
  460. }
  461. if (Properties->Valid.Contains(vpModification))
  462. {
  463. Valid = (TValid)(Valid | valMTime);
  464. MTime = Properties->Modification;
  465. }
  466. }
  467. AddProperties(
  468. Valid & valRights ? &RightsNum : NULL,
  469. Valid & valOwner ? &Owner : NULL,
  470. Valid & valGroup ? &Group : NULL,
  471. Valid & valMTime ? &MTime : NULL,
  472. Valid & valATime ? &ATime : NULL,
  473. NULL, IsDirectory, Version, Utf);
  474. }
  475. unsigned char GetByte()
  476. {
  477. Need(sizeof(unsigned char));
  478. unsigned char Result = FData[FPosition];
  479. DataConsumed(sizeof(unsigned char));
  480. return Result;
  481. }
  482. bool GetBool()
  483. {
  484. return (GetByte() != 0);
  485. }
  486. bool CanGetBool()
  487. {
  488. return (RemainingLength >= sizeof(unsigned char));
  489. }
  490. unsigned long GetCardinal()
  491. {
  492. unsigned long Result = PeekCardinal();
  493. DataConsumed(sizeof(Result));
  494. return Result;
  495. }
  496. bool CanGetCardinal()
  497. {
  498. return (RemainingLength >= sizeof(unsigned long));
  499. }
  500. unsigned long GetSmallCardinal()
  501. {
  502. unsigned long Result;
  503. Need(2);
  504. Result = (FData[FPosition] << 8) + FData[FPosition + 1];
  505. DataConsumed(2);
  506. return Result;
  507. }
  508. bool CanGetSmallCardinal()
  509. {
  510. return (RemainingLength >= 2);
  511. }
  512. __int64 GetInt64()
  513. {
  514. __int64 Hi = GetCardinal();
  515. __int64 Lo = GetCardinal();
  516. return (Hi << 32) + Lo;
  517. }
  518. RawByteString GetRawByteString()
  519. {
  520. RawByteString Result;
  521. unsigned long Len = GetCardinal();
  522. Need(Len);
  523. // cannot happen anyway as Need() would raise exception
  524. DebugAssert(Len < SFTP_MAX_PACKET_LEN);
  525. Result.SetLength(Len);
  526. memcpy(Result.c_str(), FData + FPosition, Len);
  527. DataConsumed(Len);
  528. return Result;
  529. }
  530. bool CanGetString(unsigned int & Size)
  531. {
  532. bool Result = CanGetCardinal();
  533. if (Result)
  534. {
  535. unsigned long Len = PeekCardinal();
  536. Size = (sizeof(Len) + Len);
  537. Result = (Size <= RemainingLength);
  538. }
  539. return Result;
  540. }
  541. // For reading strings that are character strings (not byte strings as
  542. // as file handles), and SFTP spec does not say explicitly that they
  543. // are in UTF. For most of them it actually does not matter as
  544. // the content should be pure ASCII (e.g. extension names, etc.)
  545. inline UnicodeString GetAnsiString()
  546. {
  547. return AnsiToString(GetRawByteString());
  548. }
  549. inline RawByteString GetFileHandle()
  550. {
  551. return GetRawByteString();
  552. }
  553. inline UnicodeString GetString(TAutoSwitch & Utf)
  554. {
  555. if (Utf != asOff)
  556. {
  557. return GetUtfString(Utf);
  558. }
  559. else
  560. {
  561. return GetAnsiString();
  562. }
  563. }
  564. // now purposeless alias to GetString(bool)
  565. inline UnicodeString GetPathString(TAutoSwitch & Utf)
  566. {
  567. return GetString(Utf);
  568. }
  569. void GetFile(TRemoteFile * File, int Version, TDSTMode DSTMode, TAutoSwitch & Utf, bool SignedTS, bool Complete)
  570. {
  571. DebugAssert(File);
  572. unsigned int Flags;
  573. UnicodeString ListingStr;
  574. unsigned long Permissions = 0;
  575. bool ParsingFailed = false;
  576. if (Type != SSH_FXP_ATTRS)
  577. {
  578. File->FileName = GetPathString(Utf);
  579. if (Version < 4)
  580. {
  581. ListingStr = GetString(Utf);
  582. }
  583. }
  584. Flags = GetCardinal();
  585. if (Version >= 4)
  586. {
  587. unsigned char FXType = GetByte();
  588. // -:regular, D:directory, L:symlink, S:special, U:unknown
  589. // O:socket, C:char device, B:block device, F:fifo
  590. // SSH-2.0-cryptlib returns file type 0 in response to SSH_FXP_LSTAT,
  591. // handle this undefined value as "unknown"
  592. static wchar_t * Types = L"U-DLSUOCBF";
  593. if (FXType > (unsigned char)wcslen(Types))
  594. {
  595. throw Exception(FMTLOAD(SFTP_UNKNOWN_FILE_TYPE, (int(FXType))));
  596. }
  597. File->Type = Types[FXType];
  598. }
  599. if (Flags & SSH_FILEXFER_ATTR_SIZE)
  600. {
  601. File->Size = GetInt64();
  602. }
  603. // SFTP-6 only
  604. if (Flags & SSH_FILEXFER_ATTR_ALLOCATION_SIZE)
  605. {
  606. GetInt64(); // skip
  607. }
  608. // SSH-2.0-3.2.0 F-SECURE SSH - Process Software MultiNet
  609. // sets SSH_FILEXFER_ATTR_UIDGID for v4, but does not include the UID/GUID
  610. if ((Flags & SSH_FILEXFER_ATTR_UIDGID) && (Version < 4))
  611. {
  612. File->Owner.ID = GetCardinal();
  613. File->Group.ID = GetCardinal();
  614. }
  615. if (Flags & SSH_FILEXFER_ATTR_OWNERGROUP)
  616. {
  617. DebugAssert(Version >= 4);
  618. File->Owner.Name = GetString(Utf);
  619. File->Group.Name = GetString(Utf);
  620. }
  621. if (Flags & SSH_FILEXFER_ATTR_PERMISSIONS)
  622. {
  623. Permissions = GetCardinal();
  624. }
  625. if (Version < 4)
  626. {
  627. if (Flags & SSH_FILEXFER_ATTR_ACMODTIME)
  628. {
  629. File->LastAccess = UnixToDateTime(
  630. SignedTS ?
  631. static_cast<__int64>(static_cast<signed long>(GetCardinal())) :
  632. static_cast<__int64>(GetCardinal()),
  633. DSTMode);
  634. File->Modification = UnixToDateTime(
  635. SignedTS ?
  636. static_cast<__int64>(static_cast<signed long>(GetCardinal())) :
  637. static_cast<__int64>(GetCardinal()),
  638. DSTMode);
  639. }
  640. }
  641. else
  642. {
  643. if (Flags & SSH_FILEXFER_ATTR_ACCESSTIME)
  644. {
  645. File->LastAccess = UnixToDateTime(GetInt64(), DSTMode);
  646. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  647. {
  648. GetCardinal(); // skip access time subseconds
  649. }
  650. }
  651. if (Flags & SSH_FILEXFER_ATTR_CREATETIME)
  652. {
  653. GetInt64(); // skip create time
  654. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  655. {
  656. GetCardinal(); // skip create time subseconds
  657. }
  658. }
  659. if (Flags & SSH_FILEXFER_ATTR_MODIFYTIME)
  660. {
  661. File->Modification = UnixToDateTime(GetInt64(), DSTMode);
  662. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  663. {
  664. GetCardinal(); // skip modification time subseconds
  665. }
  666. }
  667. // SFTP-6
  668. if (Flags & SSH_FILEXFER_ATTR_CTIME)
  669. {
  670. GetInt64(); // skip attribute modification time
  671. if (Flags & SSH_FILEXFER_ATTR_SUBSECOND_TIMES)
  672. {
  673. GetCardinal(); // skip attribute modification time subseconds
  674. }
  675. }
  676. }
  677. if (Flags & SSH_FILEXFER_ATTR_ACL)
  678. {
  679. GetRawByteString();
  680. }
  681. if (Flags & SSH_FILEXFER_ATTR_BITS)
  682. {
  683. // while SSH_FILEXFER_ATTR_BITS is defined for SFTP5 only, vandyke 2.3.3 sets it
  684. // for SFTP4 as well
  685. unsigned long Bits = GetCardinal();
  686. if (Version >= 6)
  687. {
  688. unsigned long BitsValid = GetCardinal();
  689. Bits = Bits & BitsValid;
  690. }
  691. if (FLAGSET(Bits, SSH_FILEXFER_ATTR_FLAGS_HIDDEN))
  692. {
  693. File->IsHidden = true;
  694. }
  695. }
  696. // skip some SFTP-6 only fields
  697. if (Flags & SSH_FILEXFER_ATTR_TEXT_HINT)
  698. {
  699. GetByte();
  700. }
  701. if (Flags & SSH_FILEXFER_ATTR_MIME_TYPE)
  702. {
  703. GetAnsiString();
  704. }
  705. if (Flags & SSH_FILEXFER_ATTR_LINK_COUNT)
  706. {
  707. GetCardinal();
  708. }
  709. if (Flags & SSH_FILEXFER_ATTR_UNTRANSLATED_NAME)
  710. {
  711. GetPathString(Utf);
  712. }
  713. if ((Version < 4) && (Type != SSH_FXP_ATTRS))
  714. {
  715. try
  716. {
  717. // update permissions and user/group name
  718. // modification time and filename is ignored
  719. File->ListingStr = ListingStr;
  720. }
  721. catch(...)
  722. {
  723. // ignore any error while parsing listing line,
  724. // SFTP specification do not recommend to parse it
  725. ParsingFailed = true;
  726. }
  727. }
  728. if (Type == SSH_FXP_ATTRS || Version >= 4 || ParsingFailed)
  729. {
  730. wchar_t Type = FILETYPE_DEFAULT;
  731. if (FLAGSET(Flags, SSH_FILEXFER_ATTR_PERMISSIONS))
  732. {
  733. File->Rights->Number = (unsigned short)(Permissions & TRights::rfAllSpecials);
  734. if (FLAGSET(Permissions, TRights::rfDirectory))
  735. {
  736. Type = FILETYPE_DIRECTORY;
  737. }
  738. }
  739. if (Version < 4)
  740. {
  741. File->Type = Type;
  742. }
  743. }
  744. if (Flags & SSH_FILEXFER_ATTR_EXTENDED)
  745. {
  746. unsigned int ExtendedCount = GetCardinal();
  747. for (unsigned int Index = 0; Index < ExtendedCount; Index++)
  748. {
  749. GetRawByteString(); // skip extended_type
  750. GetRawByteString(); // skip extended_data
  751. }
  752. }
  753. if (Complete)
  754. {
  755. File->Complete();
  756. }
  757. }
  758. unsigned char * GetNextData(unsigned int Size = 0)
  759. {
  760. if (Size > 0)
  761. {
  762. Need(Size);
  763. }
  764. return FPosition < FLength ? FData + FPosition : NULL;
  765. }
  766. void DataConsumed(unsigned int Size)
  767. {
  768. FPosition += Size;
  769. }
  770. void DataUpdated(int ALength)
  771. {
  772. FPosition = 0;
  773. FLength = ALength;
  774. FType = GetByte();
  775. if (FType != SSH_FXP_VERSION)
  776. {
  777. FMessageNumber = GetCardinal();
  778. }
  779. else
  780. {
  781. FMessageNumber = SFTPNoMessageNumber;
  782. }
  783. }
  784. void LoadFromFile(const UnicodeString FileName)
  785. {
  786. TStringList * DumpLines = new TStringList();
  787. RawByteString Dump;
  788. try
  789. {
  790. DumpLines->LoadFromFile(FileName);
  791. Dump = RawByteString(AnsiString(DumpLines->Text));
  792. }
  793. __finally
  794. {
  795. delete DumpLines;
  796. }
  797. Capacity = 20480;
  798. unsigned char Byte[3];
  799. memset(Byte, '\0', sizeof(Byte));
  800. int Index = 1;
  801. unsigned int Length = 0;
  802. while (Index < Dump.Length())
  803. {
  804. char C = Dump[Index];
  805. if (IsHex(C))
  806. {
  807. if (Byte[0] == '\0')
  808. {
  809. Byte[0] = C;
  810. }
  811. else
  812. {
  813. Byte[1] = C;
  814. DebugAssert(Length < Capacity);
  815. Data[Length] = HexToByte(UnicodeString(reinterpret_cast<char *>(Byte)));
  816. Length++;
  817. memset(Byte, '\0', sizeof(Byte));
  818. }
  819. }
  820. Index++;
  821. }
  822. DataUpdated(Length);
  823. }
  824. UnicodeString __fastcall Dump() const
  825. {
  826. UnicodeString Result;
  827. for (unsigned int Index = 0; Index < Length; Index++)
  828. {
  829. Result += ByteToHex(Data[Index]) + L",";
  830. if (((Index + 1) % 25) == 0)
  831. {
  832. Result += L"\n";
  833. }
  834. }
  835. return Result;
  836. }
  837. TSFTPPacket & operator = (const TSFTPPacket & Source)
  838. {
  839. Capacity = 0;
  840. Add(Source.Data, Source.Length);
  841. DataUpdated(Source.Length);
  842. FPosition = Source.FPosition;
  843. return *this;
  844. }
  845. __property unsigned int Length = { read = FLength };
  846. __property unsigned int RemainingLength = { read = GetRemainingLength };
  847. __property unsigned char * Data = { read = FData };
  848. __property unsigned char * SendData = { read = GetSendData };
  849. __property unsigned int SendLength = { read = GetSendLength };
  850. __property unsigned int Capacity = { read = FCapacity, write = SetCapacity };
  851. __property unsigned char Type = { read = FType };
  852. __property unsigned char RequestType = { read = GetRequestType };
  853. __property unsigned int MessageNumber = { read = FMessageNumber, write = FMessageNumber };
  854. __property TSFTPFileSystem * ReservedBy = { read = FReservedBy, write = FReservedBy };
  855. __property UnicodeString TypeName = { read = GetTypeName };
  856. private:
  857. unsigned char * FData;
  858. unsigned int FLength;
  859. unsigned int FCapacity;
  860. unsigned int FPosition;
  861. unsigned char FType;
  862. unsigned int FMessageNumber;
  863. TSFTPFileSystem * FReservedBy;
  864. static int FMessageCounter;
  865. static const FSendPrefixLen = 4;
  866. void Init()
  867. {
  868. FData = NULL;
  869. FCapacity = 0;
  870. FLength = 0;
  871. FPosition = 0;
  872. FMessageNumber = SFTPNoMessageNumber;
  873. FType = -1;
  874. FReservedBy = NULL;
  875. }
  876. void AssignNumber()
  877. {
  878. // this is not strictly thread-safe, but as it is accessed from multiple
  879. // threads only for multiple connection, it is not problem if two threads get
  880. // the same number
  881. FMessageNumber = (FMessageCounter << 8) + FType;
  882. FMessageCounter++;
  883. }
  884. unsigned char GetRequestType()
  885. {
  886. if (FMessageNumber != SFTPNoMessageNumber)
  887. {
  888. return (unsigned char)(FMessageNumber & 0xFF);
  889. }
  890. else
  891. {
  892. DebugAssert(Type == SSH_FXP_VERSION);
  893. return SSH_FXP_INIT;
  894. }
  895. }
  896. inline void Add(const void * AData, int ALength)
  897. {
  898. if (Length + ALength > Capacity)
  899. {
  900. Capacity = Length + ALength + SFTP_PACKET_ALLOC_DELTA;
  901. }
  902. memcpy(FData + Length, AData, ALength);
  903. FLength += ALength;
  904. }
  905. void SetCapacity(unsigned int ACapacity)
  906. {
  907. if (ACapacity != Capacity)
  908. {
  909. FCapacity = ACapacity;
  910. if (FCapacity > 0)
  911. {
  912. unsigned char * NData = (new unsigned char[FCapacity + FSendPrefixLen]) + FSendPrefixLen;
  913. if (FData)
  914. {
  915. memcpy(NData - FSendPrefixLen, FData - FSendPrefixLen,
  916. (FLength < FCapacity ? FLength : FCapacity) + FSendPrefixLen);
  917. delete[] (FData - FSendPrefixLen);
  918. }
  919. FData = NData;
  920. }
  921. else
  922. {
  923. if (FData) delete[] (FData - FSendPrefixLen);
  924. FData = NULL;
  925. }
  926. if (FLength > FCapacity) FLength = FCapacity;
  927. }
  928. }
  929. UnicodeString GetTypeName() const
  930. {
  931. #define TYPE_CASE(TYPE) case TYPE: return TEXT(#TYPE)
  932. switch (Type) {
  933. TYPE_CASE(SSH_FXP_INIT);
  934. TYPE_CASE(SSH_FXP_VERSION);
  935. TYPE_CASE(SSH_FXP_OPEN);
  936. TYPE_CASE(SSH_FXP_CLOSE);
  937. TYPE_CASE(SSH_FXP_READ);
  938. TYPE_CASE(SSH_FXP_WRITE);
  939. TYPE_CASE(SSH_FXP_LSTAT);
  940. TYPE_CASE(SSH_FXP_FSTAT);
  941. TYPE_CASE(SSH_FXP_SETSTAT);
  942. TYPE_CASE(SSH_FXP_FSETSTAT);
  943. TYPE_CASE(SSH_FXP_OPENDIR);
  944. TYPE_CASE(SSH_FXP_READDIR);
  945. TYPE_CASE(SSH_FXP_REMOVE);
  946. TYPE_CASE(SSH_FXP_MKDIR);
  947. TYPE_CASE(SSH_FXP_RMDIR);
  948. TYPE_CASE(SSH_FXP_REALPATH);
  949. TYPE_CASE(SSH_FXP_STAT);
  950. TYPE_CASE(SSH_FXP_RENAME);
  951. TYPE_CASE(SSH_FXP_READLINK);
  952. TYPE_CASE(SSH_FXP_SYMLINK);
  953. TYPE_CASE(SSH_FXP_LINK);
  954. TYPE_CASE(SSH_FXP_STATUS);
  955. TYPE_CASE(SSH_FXP_HANDLE);
  956. TYPE_CASE(SSH_FXP_DATA);
  957. TYPE_CASE(SSH_FXP_NAME);
  958. TYPE_CASE(SSH_FXP_ATTRS);
  959. TYPE_CASE(SSH_FXP_EXTENDED);
  960. TYPE_CASE(SSH_FXP_EXTENDED_REPLY);
  961. default:
  962. return FORMAT(L"Unknown message (%d)", (int(Type)));
  963. }
  964. }
  965. unsigned char * GetSendData() const
  966. {
  967. unsigned char * Result = FData - FSendPrefixLen;
  968. // this is not strictly const-object operation
  969. PUT_32BIT(Result, Length);
  970. return Result;
  971. }
  972. unsigned int GetSendLength() const
  973. {
  974. return FSendPrefixLen + Length;
  975. }
  976. unsigned int GetRemainingLength() const
  977. {
  978. return Length - FPosition;
  979. }
  980. inline void Need(unsigned int Size)
  981. {
  982. if (Size > RemainingLength)
  983. {
  984. throw Exception(FMTLOAD(SFTP_PACKET_ERROR, (int(FPosition), int(Size), int(FLength))));
  985. }
  986. }
  987. unsigned long PeekCardinal()
  988. {
  989. unsigned long Result;
  990. Need(sizeof(Result));
  991. Result = GET_32BIT(FData + FPosition);
  992. return Result;
  993. }
  994. inline UnicodeString GetUtfString(TAutoSwitch & Utf)
  995. {
  996. DebugAssert(Utf != asOff);
  997. UnicodeString Result;
  998. RawByteString S = GetRawByteString();
  999. if (Utf == asAuto)
  1000. {
  1001. TEncodeType EncodeType = DetectUTF8Encoding(S);
  1002. if (EncodeType == etANSI)
  1003. {
  1004. Utf = asOff;
  1005. Result = AnsiToString(S);
  1006. }
  1007. }
  1008. if (Utf != asOff)
  1009. {
  1010. Result = UTF8ToString(S);
  1011. }
  1012. return Result;
  1013. }
  1014. };
  1015. //---------------------------------------------------------------------------
  1016. int TSFTPPacket::FMessageCounter = 0;
  1017. //---------------------------------------------------------------------------
  1018. class TSFTPQueue
  1019. {
  1020. public:
  1021. __fastcall TSFTPQueue(TSFTPFileSystem * AFileSystem)
  1022. {
  1023. FFileSystem = AFileSystem;
  1024. DebugAssert(FFileSystem);
  1025. FRequests = new TList();
  1026. FResponses = new TList();
  1027. }
  1028. virtual __fastcall ~TSFTPQueue()
  1029. {
  1030. TSFTPQueuePacket * Request;
  1031. TSFTPPacket * Response;
  1032. DebugAssert(FResponses->Count == FRequests->Count);
  1033. for (int Index = 0; Index < FRequests->Count; Index++)
  1034. {
  1035. Request = static_cast<TSFTPQueuePacket*>(FRequests->Items[Index]);
  1036. DebugAssert(Request);
  1037. delete Request;
  1038. Response = static_cast<TSFTPPacket*>(FResponses->Items[Index]);
  1039. DebugAssert(Response);
  1040. delete Response;
  1041. }
  1042. delete FRequests;
  1043. delete FResponses;
  1044. }
  1045. bool __fastcall Init()
  1046. {
  1047. return SendRequests();
  1048. }
  1049. void DisposeUntil(int Count, int ExpectedType)
  1050. {
  1051. DebugAssert(FFileSystem->FTerminal->Active);
  1052. while (FRequests->Count > Count)
  1053. {
  1054. DebugAssert(FResponses->Count);
  1055. std::unique_ptr<TSFTPQueuePacket> Request(DebugNotNull(static_cast<TSFTPQueuePacket*>(FRequests->Items[0])));
  1056. std::unique_ptr<TSFTPPacket> Response(DebugNotNull(static_cast<TSFTPPacket*>(FResponses->Items[0])));
  1057. // Particularly when ExpectedType >= 0, the ReceiveResponse may throw, and we have to remove the packets from queue
  1058. FRequests->Delete(0);
  1059. FResponses->Delete(0);
  1060. try
  1061. {
  1062. ReceiveResponse(Request.get(), Response.get(), ExpectedType, -1);
  1063. }
  1064. catch(Exception & E)
  1065. {
  1066. if ((ExpectedType < 0) && (Count == 0))
  1067. {
  1068. if (FFileSystem->FTerminal->Active)
  1069. {
  1070. FFileSystem->FTerminal->LogEvent(L"Error while disposing the SFTP queue.");
  1071. FFileSystem->FTerminal->Log->AddException(&E);
  1072. }
  1073. else
  1074. {
  1075. FFileSystem->FTerminal->LogEvent(L"Fatal error while disposing the SFTP queue.");
  1076. throw;
  1077. }
  1078. }
  1079. else
  1080. {
  1081. throw;
  1082. }
  1083. }
  1084. }
  1085. }
  1086. virtual void __fastcall Dispose(int ExpectedType)
  1087. {
  1088. DisposeUntil(0, ExpectedType);
  1089. }
  1090. void __fastcall DisposeSafe(int ExpectedType = -1)
  1091. {
  1092. if (FFileSystem->FTerminal->Active)
  1093. {
  1094. Dispose(ExpectedType);
  1095. }
  1096. }
  1097. bool __fastcall ReceivePacket(TSFTPPacket * Packet,
  1098. int ExpectedType = -1, int AllowStatus = -1, void ** Token = NULL, bool TryOnly = false)
  1099. {
  1100. DebugAssert(FRequests->Count);
  1101. bool Result;
  1102. TSFTPQueuePacket * Request = NULL;
  1103. TSFTPPacket * Response = NULL;
  1104. try
  1105. {
  1106. Request = static_cast<TSFTPQueuePacket*>(FRequests->Items[0]);
  1107. FRequests->Delete(0);
  1108. DebugAssert(Request);
  1109. if (Token != NULL)
  1110. {
  1111. *Token = Request->Token;
  1112. }
  1113. Response = static_cast<TSFTPPacket*>(FResponses->Items[0]);
  1114. FResponses->Delete(0);
  1115. DebugAssert(Response);
  1116. ReceiveResponse(Request, Response, ExpectedType, AllowStatus, TryOnly);
  1117. if ((Response->Capacity == 0) && DebugAlwaysTrue(TryOnly))
  1118. {
  1119. FRequests->Insert(0, Request);
  1120. Request = NULL;
  1121. FResponses->Insert(0, Response);
  1122. Response = NULL;
  1123. Result = true;
  1124. }
  1125. else
  1126. {
  1127. if (Packet)
  1128. {
  1129. *Packet = *Response;
  1130. }
  1131. Result = !End(Response);
  1132. if (Result)
  1133. {
  1134. SendRequests();
  1135. }
  1136. }
  1137. }
  1138. __finally
  1139. {
  1140. delete Request;
  1141. delete Response;
  1142. }
  1143. return Result;
  1144. }
  1145. bool __fastcall Next(int ExpectedType = -1, int AllowStatus = -1)
  1146. {
  1147. return ReceivePacket(NULL, ExpectedType, AllowStatus);
  1148. }
  1149. protected:
  1150. TList * FRequests;
  1151. TList * FResponses;
  1152. TSFTPFileSystem * FFileSystem;
  1153. class TSFTPQueuePacket : public TSFTPPacket
  1154. {
  1155. public:
  1156. TSFTPQueuePacket() :
  1157. TSFTPPacket()
  1158. {
  1159. Token = NULL;
  1160. }
  1161. void * Token;
  1162. };
  1163. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request) = 0;
  1164. virtual bool __fastcall End(TSFTPPacket * Response) = 0;
  1165. virtual void __fastcall SendPacket(TSFTPQueuePacket * Packet)
  1166. {
  1167. FFileSystem->SendPacket(Packet);
  1168. }
  1169. virtual void __fastcall ReceiveResponse(
  1170. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
  1171. int AllowStatus, bool TryOnly = false)
  1172. {
  1173. FFileSystem->ReceiveResponse(Packet, Response, ExpectedType, AllowStatus, TryOnly);
  1174. }
  1175. // sends as many requests as allowed by implementation
  1176. virtual bool SendRequests() = 0;
  1177. virtual bool __fastcall SendRequest()
  1178. {
  1179. TSFTPQueuePacket * Request = NULL;
  1180. try
  1181. {
  1182. Request = new TSFTPQueuePacket();
  1183. if (!InitRequest(Request))
  1184. {
  1185. delete Request;
  1186. Request = NULL;
  1187. }
  1188. }
  1189. catch(...)
  1190. {
  1191. delete Request;
  1192. throw;
  1193. }
  1194. if (Request != NULL)
  1195. {
  1196. TSFTPPacket * Response = new TSFTPPacket();
  1197. FRequests->Add(Request);
  1198. FResponses->Add(Response);
  1199. if (FFileSystem->FTerminal->Configuration->ActualLogProtocol >= 1)
  1200. {
  1201. FFileSystem->FTerminal->LogEvent(FORMAT(L"Queue len: %d", (FRequests->Count)));
  1202. }
  1203. // make sure the response is reserved before actually sending the message
  1204. // as we may receive response asynchronously before SendPacket finishes
  1205. FFileSystem->ReserveResponse(Request, Response);
  1206. SendPacket(Request);
  1207. }
  1208. return (Request != NULL);
  1209. }
  1210. };
  1211. //---------------------------------------------------------------------------
  1212. class TSFTPFixedLenQueue : public TSFTPQueue
  1213. {
  1214. public:
  1215. __fastcall TSFTPFixedLenQueue(TSFTPFileSystem * AFileSystem) : TSFTPQueue(AFileSystem)
  1216. {
  1217. FMissedRequests = 0;
  1218. }
  1219. virtual __fastcall ~TSFTPFixedLenQueue(){}
  1220. bool Init(int QueueLen)
  1221. {
  1222. FMissedRequests = QueueLen - 1;
  1223. return TSFTPQueue::Init();
  1224. }
  1225. protected:
  1226. int FMissedRequests;
  1227. // sends as many requests as allowed by implementation
  1228. virtual bool SendRequests()
  1229. {
  1230. bool Result = false;
  1231. FMissedRequests++;
  1232. while ((FMissedRequests > 0) && SendRequest())
  1233. {
  1234. Result = true;
  1235. FMissedRequests--;
  1236. }
  1237. return Result;
  1238. }
  1239. };
  1240. //---------------------------------------------------------------------------
  1241. class TSFTPAsynchronousQueue : public TSFTPQueue
  1242. {
  1243. public:
  1244. __fastcall TSFTPAsynchronousQueue(TSFTPFileSystem * AFileSystem) : TSFTPQueue(AFileSystem)
  1245. {
  1246. RegisterReceiveHandler();
  1247. }
  1248. virtual __fastcall ~TSFTPAsynchronousQueue()
  1249. {
  1250. UnregisterReceiveHandler();
  1251. }
  1252. virtual void __fastcall Dispose(int ExpectedType)
  1253. {
  1254. // we do not want to receive asynchronous notifications anymore,
  1255. // while waiting synchronously for pending responses
  1256. UnregisterReceiveHandler();
  1257. TSFTPQueue::Dispose(ExpectedType);
  1258. }
  1259. bool __fastcall Continue()
  1260. {
  1261. return SendRequest();
  1262. }
  1263. protected:
  1264. // event handler for incoming data
  1265. void __fastcall ReceiveHandler(TObject * /*Sender*/)
  1266. {
  1267. while (// optimization only as we call ReceivePacket with TryOnly anyway
  1268. FFileSystem->PeekPacket() &&
  1269. ReceivePacketAsynchronously())
  1270. {
  1271. // loop
  1272. }
  1273. }
  1274. virtual bool __fastcall ReceivePacketAsynchronously() = 0;
  1275. // sends as many requests as allowed by implementation
  1276. virtual bool SendRequests()
  1277. {
  1278. // noop
  1279. return true;
  1280. }
  1281. bool __fastcall UnregisterReceiveHandler()
  1282. {
  1283. bool Result = FReceiveHandlerRegistered;
  1284. if (Result)
  1285. {
  1286. FReceiveHandlerRegistered = false;
  1287. FFileSystem->FSecureShell->UnregisterReceiveHandler(ReceiveHandler);
  1288. }
  1289. return Result;
  1290. }
  1291. void __fastcall RegisterReceiveHandler()
  1292. {
  1293. FFileSystem->FSecureShell->RegisterReceiveHandler(ReceiveHandler);
  1294. FReceiveHandlerRegistered = true;
  1295. }
  1296. private:
  1297. bool FReceiveHandlerRegistered;
  1298. };
  1299. //---------------------------------------------------------------------------
  1300. class TSFTPDownloadQueue : public TSFTPFixedLenQueue
  1301. {
  1302. public:
  1303. TSFTPDownloadQueue(TSFTPFileSystem * AFileSystem) :
  1304. TSFTPFixedLenQueue(AFileSystem)
  1305. {
  1306. }
  1307. virtual __fastcall ~TSFTPDownloadQueue(){}
  1308. bool __fastcall Init(
  1309. int QueueLen, const RawByteString & AHandle, __int64 Offset, __int64 PartSize, TFileOperationProgressType * AOperationProgress)
  1310. {
  1311. FHandle = AHandle;
  1312. FOffset = Offset;
  1313. FTransferred = Offset;
  1314. FPartSize = PartSize;
  1315. OperationProgress = AOperationProgress;
  1316. return TSFTPFixedLenQueue::Init(QueueLen);
  1317. }
  1318. void __fastcall InitFillGapRequest(__int64 Offset, unsigned long Missing,
  1319. TSFTPPacket * Packet)
  1320. {
  1321. InitRequest(Packet, Offset, Missing);
  1322. }
  1323. bool __fastcall ReceivePacket(TSFTPPacket * Packet, unsigned long & BlockSize)
  1324. {
  1325. void * Token;
  1326. bool Result = TSFTPFixedLenQueue::ReceivePacket(Packet, SSH_FXP_DATA, asEOF, &Token);
  1327. BlockSize = reinterpret_cast<unsigned long>(Token);
  1328. return Result;
  1329. }
  1330. protected:
  1331. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request)
  1332. {
  1333. unsigned int BlockSize = FFileSystem->DownloadBlockSize(OperationProgress);
  1334. if (FPartSize >= 0)
  1335. {
  1336. __int64 Remaining = (FOffset + FPartSize) - FTransferred;
  1337. if (Remaining < BlockSize)
  1338. {
  1339. // It's lower, so the cast is safe
  1340. BlockSize = static_cast<unsigned int>(Remaining);
  1341. }
  1342. }
  1343. bool Result = (BlockSize > 0);
  1344. if (Result)
  1345. {
  1346. InitRequest(Request, FTransferred, BlockSize);
  1347. Request->Token = reinterpret_cast<void*>(BlockSize);
  1348. FTransferred += BlockSize;
  1349. }
  1350. return Result;
  1351. }
  1352. void __fastcall InitRequest(TSFTPPacket * Request, __int64 Offset,
  1353. unsigned long Size)
  1354. {
  1355. Request->ChangeType(SSH_FXP_READ);
  1356. Request->AddString(FHandle);
  1357. Request->AddInt64(Offset);
  1358. Request->AddCardinal(Size);
  1359. }
  1360. virtual bool __fastcall End(TSFTPPacket * Response)
  1361. {
  1362. return (Response->Type != SSH_FXP_DATA);
  1363. }
  1364. private:
  1365. TFileOperationProgressType * OperationProgress;
  1366. __int64 FOffset;
  1367. __int64 FTransferred;
  1368. __int64 FPartSize;
  1369. RawByteString FHandle;
  1370. };
  1371. //---------------------------------------------------------------------------
  1372. class TSFTPUploadQueue : public TSFTPAsynchronousQueue
  1373. {
  1374. public:
  1375. TSFTPUploadQueue(TSFTPFileSystem * AFileSystem, TEncryption * Encryption, int QueueMaxLen) :
  1376. TSFTPAsynchronousQueue(AFileSystem),
  1377. FEncryption(Encryption)
  1378. {
  1379. FStream = NULL;
  1380. FOnTransferIn = NULL;
  1381. OperationProgress = NULL;
  1382. FLastBlockSize = 0;
  1383. FEnd = false;
  1384. FConvertToken = false;
  1385. FQueueMaxLen = QueueMaxLen;
  1386. }
  1387. virtual __fastcall ~TSFTPUploadQueue()
  1388. {
  1389. delete FStream;
  1390. }
  1391. bool __fastcall Init(const UnicodeString & AFileName,
  1392. HANDLE AFile, TTransferInEvent OnTransferIn, TFileOperationProgressType * AOperationProgress,
  1393. const RawByteString AHandle, __int64 ATransferred,
  1394. int ConvertParams)
  1395. {
  1396. FFileName = AFileName;
  1397. if (OnTransferIn == NULL)
  1398. {
  1399. FStream = new TSafeHandleStream((THandle)AFile);
  1400. }
  1401. OperationProgress = AOperationProgress;
  1402. FHandle = AHandle;
  1403. FOnTransferIn = OnTransferIn;
  1404. FTransferred = ATransferred;
  1405. FConvertParams = ConvertParams;
  1406. return TSFTPAsynchronousQueue::Init();
  1407. }
  1408. void __fastcall DisposeSafeWithErrorHandling()
  1409. {
  1410. DisposeSafe(SSH_FXP_STATUS);
  1411. }
  1412. protected:
  1413. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request)
  1414. {
  1415. TTerminal * FTerminal = FFileSystem->FTerminal;
  1416. // Buffer for one block of data
  1417. TFileBuffer BlockBuf;
  1418. unsigned long BlockSize = FFileSystem->UploadBlockSize(FHandle, OperationProgress);
  1419. bool Result = (BlockSize > 0);
  1420. if (Result)
  1421. {
  1422. bool Last;
  1423. if (FOnTransferIn != NULL)
  1424. {
  1425. size_t Read = BlockBuf.LoadFromIn(FOnTransferIn, FTerminal, BlockSize);
  1426. Last = (Read < BlockSize);
  1427. }
  1428. else
  1429. {
  1430. FILE_OPERATION_LOOP_BEGIN
  1431. {
  1432. BlockBuf.LoadStream(FStream, BlockSize, false);
  1433. }
  1434. FILE_OPERATION_LOOP_END(FMTLOAD(READ_ERROR, (FFileName)));
  1435. Last = (FStream->Position >= FStream->Size);
  1436. }
  1437. FEnd = (BlockBuf.Size == 0);
  1438. Result = !FEnd;
  1439. if (Result)
  1440. {
  1441. OperationProgress->AddLocallyUsed(BlockBuf.Size);
  1442. // We do ASCII transfer: convert EOL of current block
  1443. if (OperationProgress->AsciiTransfer)
  1444. {
  1445. __int64 PrevBufSize = BlockBuf.Size;
  1446. BlockBuf.Convert(FTerminal->Configuration->LocalEOLType,
  1447. FFileSystem->GetEOL(), FConvertParams, FConvertToken);
  1448. // update transfer size with difference arised from EOL conversion
  1449. OperationProgress->ChangeTransferSize(OperationProgress->TransferSize -
  1450. PrevBufSize + BlockBuf.Size);
  1451. }
  1452. if (FFileSystem->FTerminal->Configuration->ActualLogProtocol >= 1)
  1453. {
  1454. FFileSystem->FTerminal->LogEvent(FORMAT(L"Write request offset: %d, len: %d",
  1455. (int(FTransferred), int(BlockBuf.Size))));
  1456. }
  1457. if (FEncryption != NULL)
  1458. {
  1459. FEncryption->Encrypt(BlockBuf, Last);
  1460. }
  1461. Request->ChangeType(SSH_FXP_WRITE);
  1462. Request->AddString(FHandle);
  1463. Request->AddInt64(FTransferred);
  1464. Request->AddData(BlockBuf.Data, BlockBuf.Size);
  1465. FLastBlockSize = BlockBuf.Size;
  1466. FTransferred += BlockBuf.Size;
  1467. }
  1468. }
  1469. return Result;
  1470. }
  1471. virtual void __fastcall SendPacket(TSFTPQueuePacket * Packet)
  1472. {
  1473. TSFTPAsynchronousQueue::SendPacket(Packet);
  1474. OperationProgress->AddTransferred(FLastBlockSize);
  1475. }
  1476. virtual void __fastcall ReceiveResponse(
  1477. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
  1478. int AllowStatus, bool TryOnly)
  1479. {
  1480. TSFTPAsynchronousQueue::ReceiveResponse(Packet, Response, ExpectedType, AllowStatus, TryOnly);
  1481. if (Response->Capacity > 0)
  1482. {
  1483. // particularly when uploading a file that completely fits into send buffer
  1484. // over slow line, we may end up seemingly completing the transfer immediately
  1485. // but hanging the application for a long time waiting for responses
  1486. // (common is that the progress window would not even manage to draw itself,
  1487. // showing that upload finished, before the application "hangs")
  1488. FFileSystem->Progress(OperationProgress);
  1489. }
  1490. else
  1491. {
  1492. DebugAssert(TryOnly);
  1493. }
  1494. }
  1495. virtual bool __fastcall ReceivePacketAsynchronously()
  1496. {
  1497. // do not read response to close request
  1498. bool Result = (FRequests->Count > 0);
  1499. if (Result)
  1500. {
  1501. // Try only: We cannot read from the socket here as we are already called
  1502. // from TSecureShell::HandleNetworkEvents as it would cause a recursion
  1503. // that would potentially make PuTTY code process the SSH packets in wrong order.
  1504. ReceivePacket(NULL, SSH_FXP_STATUS, -1, NULL, true);
  1505. }
  1506. return Result;
  1507. }
  1508. virtual bool __fastcall End(TSFTPPacket * /*Response*/)
  1509. {
  1510. return FEnd;
  1511. }
  1512. virtual bool __fastcall SendRequest()
  1513. {
  1514. bool Result = TSFTPAsynchronousQueue::SendRequest();
  1515. if (FRequests->Count >= FQueueMaxLen)
  1516. {
  1517. FFileSystem->FTerminal->LogEvent(1, L"Too many outstanding requests, waiting for responses...");
  1518. DebugCheck(UnregisterReceiveHandler());
  1519. try
  1520. {
  1521. DisposeUntil(FQueueMaxLen - 1, SSH_FXP_STATUS);
  1522. }
  1523. __finally
  1524. {
  1525. RegisterReceiveHandler();
  1526. }
  1527. }
  1528. return Result;
  1529. }
  1530. private:
  1531. TStream * FStream;
  1532. TTransferInEvent FOnTransferIn;
  1533. TFileOperationProgressType * OperationProgress;
  1534. UnicodeString FFileName;
  1535. unsigned long FLastBlockSize;
  1536. bool FEnd;
  1537. __int64 FTransferred;
  1538. RawByteString FHandle;
  1539. bool FConvertToken;
  1540. int FConvertParams;
  1541. TEncryption * FEncryption;
  1542. int FQueueMaxLen;
  1543. };
  1544. //---------------------------------------------------------------------------
  1545. class TSFTPLoadFilesPropertiesQueue : public TSFTPFixedLenQueue
  1546. {
  1547. public:
  1548. TSFTPLoadFilesPropertiesQueue(TSFTPFileSystem * AFileSystem) :
  1549. TSFTPFixedLenQueue(AFileSystem)
  1550. {
  1551. FIndex = 0;
  1552. }
  1553. virtual __fastcall ~TSFTPLoadFilesPropertiesQueue(){}
  1554. bool __fastcall Init(int QueueLen, TStrings * FileList)
  1555. {
  1556. FFileList = FileList;
  1557. return TSFTPFixedLenQueue::Init(QueueLen);
  1558. }
  1559. bool __fastcall ReceivePacket(TSFTPPacket * Packet, TRemoteFile *& File)
  1560. {
  1561. void * Token;
  1562. bool Result = TSFTPFixedLenQueue::ReceivePacket(Packet, SSH_FXP_ATTRS, asAll, &Token);
  1563. File = static_cast<TRemoteFile *>(Token);
  1564. return Result;
  1565. }
  1566. protected:
  1567. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request)
  1568. {
  1569. bool Result = false;
  1570. while (!Result && (FIndex < FFileList->Count))
  1571. {
  1572. TRemoteFile * File = static_cast<TRemoteFile *>(FFileList->Objects[FIndex]);
  1573. FIndex++;
  1574. bool MissingRights =
  1575. (FFileSystem->FSupport->Loaded &&
  1576. FLAGSET(FFileSystem->FSupport->AttributeMask, SSH_FILEXFER_ATTR_PERMISSIONS) &&
  1577. File->Rights->Unknown);
  1578. bool MissingOwnerGroup =
  1579. (FFileSystem->FSecureShell->SshImplementation == sshiBitvise) ||
  1580. (FFileSystem->FSupport->Loaded &&
  1581. FLAGSET(FFileSystem->FSupport->AttributeMask, SSH_FILEXFER_ATTR_OWNERGROUP) &&
  1582. !File->Owner.IsSet || !File->Group.IsSet);
  1583. Result = (MissingRights || MissingOwnerGroup);
  1584. if (Result)
  1585. {
  1586. Request->ChangeType(SSH_FXP_LSTAT);
  1587. FFileSystem->AddPathString(*Request, FFileSystem->LocalCanonify(File->FileName));
  1588. if (FFileSystem->FVersion >= 4)
  1589. {
  1590. Request->AddCardinal(
  1591. FLAGMASK(MissingRights, SSH_FILEXFER_ATTR_PERMISSIONS) |
  1592. FLAGMASK(MissingOwnerGroup, SSH_FILEXFER_ATTR_OWNERGROUP));
  1593. }
  1594. Request->Token = File;
  1595. }
  1596. }
  1597. return Result;
  1598. }
  1599. virtual bool __fastcall SendRequest()
  1600. {
  1601. bool Result =
  1602. (FIndex < FFileList->Count) &&
  1603. TSFTPFixedLenQueue::SendRequest();
  1604. return Result;
  1605. }
  1606. virtual bool __fastcall End(TSFTPPacket * /*Response*/)
  1607. {
  1608. return (FRequests->Count == 0);
  1609. }
  1610. private:
  1611. TStrings * FFileList;
  1612. int FIndex;
  1613. };
  1614. //---------------------------------------------------------------------------
  1615. class TSFTPCalculateFilesChecksumQueue : public TSFTPFixedLenQueue
  1616. {
  1617. public:
  1618. TSFTPCalculateFilesChecksumQueue(TSFTPFileSystem * AFileSystem) :
  1619. TSFTPFixedLenQueue(AFileSystem)
  1620. {
  1621. FIndex = 0;
  1622. }
  1623. virtual __fastcall ~TSFTPCalculateFilesChecksumQueue(){}
  1624. bool __fastcall Init(int QueueLen, const UnicodeString & Alg, TStrings * FileList)
  1625. {
  1626. FAlg = Alg;
  1627. FFileList = FileList;
  1628. return TSFTPFixedLenQueue::Init(QueueLen);
  1629. }
  1630. bool __fastcall ReceivePacket(TSFTPPacket * Packet, TRemoteFile *& File)
  1631. {
  1632. void * Token;
  1633. bool Result;
  1634. try
  1635. {
  1636. Result = TSFTPFixedLenQueue::ReceivePacket(Packet, SSH_FXP_EXTENDED_REPLY, asNo, &Token);
  1637. }
  1638. __finally
  1639. {
  1640. File = static_cast<TRemoteFile *>(Token);
  1641. }
  1642. return Result;
  1643. }
  1644. protected:
  1645. virtual bool __fastcall InitRequest(TSFTPQueuePacket * Request)
  1646. {
  1647. bool Result = false;
  1648. while (!Result && (FIndex < FFileList->Count))
  1649. {
  1650. TRemoteFile * File = static_cast<TRemoteFile *>(FFileList->Objects[FIndex]);
  1651. DebugAssert(File != NULL);
  1652. FIndex++;
  1653. Result = !File->IsDirectory;
  1654. if (Result)
  1655. {
  1656. DebugAssert(IsRealFile(File->FileName));
  1657. Request->ChangeType(SSH_FXP_EXTENDED);
  1658. Request->AddString(SFTP_EXT_CHECK_FILE_NAME);
  1659. FFileSystem->AddPathString(*Request, FFileSystem->LocalCanonify(File->FullFileName));
  1660. Request->AddString(FAlg);
  1661. Request->AddInt64(0); // offset
  1662. Request->AddInt64(0); // length (0 = till end)
  1663. Request->AddCardinal(0); // block size (0 = no blocks or "one block")
  1664. Request->Token = File;
  1665. }
  1666. }
  1667. return Result;
  1668. }
  1669. virtual bool __fastcall SendRequest()
  1670. {
  1671. bool Result =
  1672. (FIndex < FFileList->Count) &&
  1673. TSFTPFixedLenQueue::SendRequest();
  1674. return Result;
  1675. }
  1676. virtual bool __fastcall End(TSFTPPacket * /*Response*/)
  1677. {
  1678. return (FRequests->Count == 0);
  1679. }
  1680. private:
  1681. UnicodeString FAlg;
  1682. TStrings * FFileList;
  1683. int FIndex;
  1684. };
  1685. //---------------------------------------------------------------------------
  1686. #pragma warn .inl
  1687. //---------------------------------------------------------------------------
  1688. class TSFTPBusy
  1689. {
  1690. public:
  1691. __fastcall TSFTPBusy(TSFTPFileSystem * FileSystem)
  1692. {
  1693. FFileSystem = FileSystem;
  1694. DebugAssert(FFileSystem != NULL);
  1695. FFileSystem->BusyStart();
  1696. }
  1697. __fastcall ~TSFTPBusy()
  1698. {
  1699. FFileSystem->BusyEnd();
  1700. }
  1701. private:
  1702. TSFTPFileSystem * FFileSystem;
  1703. };
  1704. //===========================================================================
  1705. struct TOpenRemoteFileParams
  1706. {
  1707. UnicodeString FileName;
  1708. UnicodeString RemoteFileName;
  1709. UnicodeString RemoteFullFileName;
  1710. TFileOperationProgressType * OperationProgress;
  1711. const TCopyParamType * CopyParam;
  1712. int Params;
  1713. bool Resume;
  1714. bool Resuming;
  1715. TSFTPOverwriteMode OverwriteMode;
  1716. __int64 DestFileSize; // output
  1717. RawByteString RemoteFileHandle; // output
  1718. TOverwriteFileParams * FileParams;
  1719. bool Confirmed;
  1720. bool DontRecycle;
  1721. bool Recycled;
  1722. TRights RecycledRights;
  1723. };
  1724. //===========================================================================
  1725. __fastcall TSFTPFileSystem::TSFTPFileSystem(TTerminal * ATerminal,
  1726. TSecureShell * SecureShell):
  1727. TCustomFileSystem(ATerminal)
  1728. {
  1729. FSecureShell = SecureShell;
  1730. FPacketReservations = new TList();
  1731. ResetConnection();
  1732. FBusy = 0;
  1733. FAvoidBusy = false;
  1734. FUtfStrings = asOff;
  1735. FUtfDisablingAnnounced = true;
  1736. FSignedTS = false;
  1737. FSupport = new TSFTPSupport();
  1738. FFixedPaths = NULL;
  1739. FFileSystemInfoValid = false;
  1740. FChecksumAlgs.reset(new TStringList());
  1741. FChecksumSftpAlgs.reset(new TStringList());
  1742. // List as defined by draft-ietf-secsh-filexfer-extensions-00
  1743. // MD5 moved to the back
  1744. RegisterChecksumAlg(Sha1ChecksumAlg, L"sha1");
  1745. RegisterChecksumAlg(Sha224ChecksumAlg, L"sha224");
  1746. RegisterChecksumAlg(Sha256ChecksumAlg, L"sha256");
  1747. RegisterChecksumAlg(Sha384ChecksumAlg, L"sha384");
  1748. RegisterChecksumAlg(Sha512ChecksumAlg, L"sha512");
  1749. RegisterChecksumAlg(Md5ChecksumAlg, L"md5");
  1750. RegisterChecksumAlg(Crc32ChecksumAlg, L"crc32");
  1751. }
  1752. //---------------------------------------------------------------------------
  1753. __fastcall TSFTPFileSystem::~TSFTPFileSystem()
  1754. {
  1755. delete FSupport;
  1756. // After closing, we can only possibly have "discard" reservations of the not-read responses to the last requests
  1757. // (typically to SSH_FXP_CLOSE)
  1758. for (int i = 0; i < FPacketReservations->Count; i++)
  1759. {
  1760. DebugAssert(FPacketReservations->Items[i] == NULL);
  1761. }
  1762. delete FPacketReservations;
  1763. delete FFixedPaths;
  1764. delete FSecureShell;
  1765. }
  1766. //---------------------------------------------------------------------------
  1767. void __fastcall TSFTPFileSystem::Open()
  1768. {
  1769. // this is used for reconnects only
  1770. ResetConnection();
  1771. FSecureShell->Open();
  1772. }
  1773. //---------------------------------------------------------------------------
  1774. void __fastcall TSFTPFileSystem::Close()
  1775. {
  1776. FSecureShell->Close();
  1777. }
  1778. //---------------------------------------------------------------------------
  1779. bool __fastcall TSFTPFileSystem::GetActive()
  1780. {
  1781. return FSecureShell->Active;
  1782. }
  1783. //---------------------------------------------------------------------------
  1784. void __fastcall TSFTPFileSystem::CollectUsage()
  1785. {
  1786. FSecureShell->CollectUsage();
  1787. UnicodeString VersionCounter;
  1788. switch (FVersion)
  1789. {
  1790. case 0:
  1791. VersionCounter = L"OpenedSessionsSFTP0";
  1792. break;
  1793. case 1:
  1794. VersionCounter = L"OpenedSessionsSFTP1";
  1795. break;
  1796. case 2:
  1797. VersionCounter = L"OpenedSessionsSFTP2";
  1798. break;
  1799. case 3:
  1800. VersionCounter = L"OpenedSessionsSFTP3";
  1801. break;
  1802. case 4:
  1803. VersionCounter = L"OpenedSessionsSFTP4";
  1804. break;
  1805. case 5:
  1806. VersionCounter = L"OpenedSessionsSFTP5";
  1807. break;
  1808. case 6:
  1809. VersionCounter = L"OpenedSessionsSFTP6";
  1810. break;
  1811. default:
  1812. DebugFail();
  1813. }
  1814. FTerminal->Configuration->Usage->Inc(VersionCounter);
  1815. }
  1816. //---------------------------------------------------------------------------
  1817. const TSessionInfo & __fastcall TSFTPFileSystem::GetSessionInfo()
  1818. {
  1819. return FSecureShell->GetSessionInfo();
  1820. }
  1821. //---------------------------------------------------------------------------
  1822. const TFileSystemInfo & __fastcall TSFTPFileSystem::GetFileSystemInfo(bool /*Retrieve*/)
  1823. {
  1824. if (!FFileSystemInfoValid)
  1825. {
  1826. FFileSystemInfo.AdditionalInfo = L"";
  1827. if (!IsCapable(fcRename))
  1828. {
  1829. FFileSystemInfo.AdditionalInfo += LoadStr(FS_RENAME_NOT_SUPPORTED) + L"\r\n\r\n";
  1830. }
  1831. if (!FExtensions.IsEmpty())
  1832. {
  1833. FFileSystemInfo.AdditionalInfo +=
  1834. LoadStr(SFTP_EXTENSION_INFO) + L"\r\n" +
  1835. FExtensions;
  1836. }
  1837. else
  1838. {
  1839. FFileSystemInfo.AdditionalInfo += LoadStr(SFTP_NO_EXTENSION_INFO) + L"\r\n";
  1840. }
  1841. FFileSystemInfo.ProtocolBaseName = L"SFTP";
  1842. FFileSystemInfo.ProtocolName = FMTLOAD(SFTP_PROTOCOL_NAME2, (FVersion));
  1843. FTerminal->SaveCapabilities(FFileSystemInfo);
  1844. FFileSystemInfoValid = true;
  1845. }
  1846. return FFileSystemInfo;
  1847. }
  1848. //---------------------------------------------------------------------------
  1849. bool __fastcall TSFTPFileSystem::TemporaryTransferFile(const UnicodeString & FileName)
  1850. {
  1851. return (GetPartialFileExtLen(FileName) > 0);
  1852. }
  1853. //---------------------------------------------------------------------------
  1854. bool __fastcall TSFTPFileSystem::GetStoredCredentialsTried()
  1855. {
  1856. return FSecureShell->GetStoredCredentialsTried();
  1857. }
  1858. //---------------------------------------------------------------------------
  1859. UnicodeString __fastcall TSFTPFileSystem::GetUserName()
  1860. {
  1861. return FSecureShell->UserName;
  1862. }
  1863. //---------------------------------------------------------------------------
  1864. void __fastcall TSFTPFileSystem::Idle()
  1865. {
  1866. // Keep session alive
  1867. if ((FTerminal->SessionData->PingType != ptOff) &&
  1868. (Now() - FSecureShell->LastDataSent > FTerminal->SessionData->PingIntervalDT))
  1869. {
  1870. if ((FTerminal->SessionData->PingType == ptDummyCommand) &&
  1871. FSecureShell->Ready)
  1872. {
  1873. FTerminal->LogEvent(L"Sending dummy command to keep session alive.");
  1874. TSFTPPacket Packet(SSH_FXP_REALPATH);
  1875. AddPathString(Packet, L"/");
  1876. SendPacketAndReceiveResponse(&Packet, &Packet);
  1877. }
  1878. else
  1879. {
  1880. FSecureShell->KeepAlive();
  1881. }
  1882. }
  1883. FSecureShell->Idle();
  1884. }
  1885. //---------------------------------------------------------------------------
  1886. void __fastcall TSFTPFileSystem::ResetConnection()
  1887. {
  1888. FPacketReservations->Clear();
  1889. FPacketNumbers = VarArrayCreate(OPENARRAY(int, (0, 1)), varLongWord);
  1890. FNotLoggedRequests.clear();
  1891. FPreviousLoggedPacket = 0;
  1892. FNotLoggedWritePackets = FNotLoggedReadPackets = FNotLoggedStatusPackets = FNotLoggedDataPackets = 0;
  1893. }
  1894. //---------------------------------------------------------------------------
  1895. bool __fastcall TSFTPFileSystem::IsCapable(int Capability) const
  1896. {
  1897. DebugAssert(FTerminal);
  1898. switch (Capability) {
  1899. case fcAnyCommand:
  1900. case fcShellAnyCommand:
  1901. case fcLocking:
  1902. case fcAclChangingFiles: // pending implementation
  1903. case fcMoveOverExistingFile:
  1904. return false;
  1905. case fcNewerOnlyUpload:
  1906. case fcTimestampChanging:
  1907. case fcIgnorePermErrors:
  1908. case fcPreservingTimestampUpload:
  1909. case fcSecondaryShell:
  1910. case fcRemoveCtrlZUpload:
  1911. case fcRemoveBOMUpload:
  1912. case fcPreservingTimestampDirs:
  1913. case fcTransferOut:
  1914. case fcTransferIn:
  1915. return true;
  1916. case fcMoveToQueue:
  1917. case fcResumeSupport:
  1918. case fcSkipTransfer:
  1919. case fcParallelTransfers:
  1920. case fcParallelFileTransfers:
  1921. return !FTerminal->IsEncryptingFiles();
  1922. case fcRename:
  1923. case fcRemoteMove:
  1924. return (FVersion >= 2);
  1925. case fcSymbolicLink:
  1926. case fcResolveSymlink:
  1927. return (FVersion >= 3) && !FTerminal->IsEncryptingFiles();
  1928. case fcModeChanging:
  1929. case fcModeChangingUpload:
  1930. return !FSupport->Loaded ||
  1931. FLAGSET(FSupport->AttributeMask, SSH_FILEXFER_ATTR_PERMISSIONS);
  1932. case fcGroupOwnerChangingByID:
  1933. return (FVersion <= 3);
  1934. case fcOwnerChanging:
  1935. case fcGroupChanging:
  1936. return
  1937. (FVersion <= 3) ||
  1938. ((FVersion >= 4) &&
  1939. (!FSupport->Loaded ||
  1940. FLAGSET(FSupport->AttributeMask, SSH_FILEXFER_ATTR_OWNERGROUP)));
  1941. case fcNativeTextMode:
  1942. return !FTerminal->IsEncryptingFiles() && (FVersion >= 4);
  1943. case fcTextMode:
  1944. return
  1945. !FTerminal->IsEncryptingFiles() &&
  1946. ((FVersion >= 4) ||
  1947. (strcmp(GetEOL(), EOLToStr(FTerminal->Configuration->LocalEOLType)) != 0));
  1948. case fcUserGroupListing:
  1949. return SupportsExtension(SFTP_EXT_OWNER_GROUP);
  1950. case fcLoadingAdditionalProperties:
  1951. // We allow loading properties only, if "supported" extension is supported and
  1952. // the server supports "permissions" and/or "owner/group" attributes
  1953. // (no other attributes are loaded).
  1954. // This is here only because of VShell
  1955. // (it supports owner/group, but does not include them into response to
  1956. // SSH_FXP_READDIR)
  1957. // and Bitvise (the same as VShell, but it does not even bother to provide "supported" extension until 6.21)
  1958. // No other use is known.
  1959. return
  1960. (FSupport->Loaded &&
  1961. ((FSupport->AttributeMask &
  1962. (SSH_FILEXFER_ATTR_PERMISSIONS | SSH_FILEXFER_ATTR_OWNERGROUP)) != 0)) ||
  1963. (FSecureShell->SshImplementation == sshiBitvise);
  1964. case fcCheckingSpaceAvailable:
  1965. return
  1966. // extension announced in extension list of by
  1967. // SFTP_EXT_SUPPORTED/SFTP_EXT_SUPPORTED2 extension
  1968. // (SFTP version 5 and newer only)
  1969. SupportsExtension(SFTP_EXT_SPACE_AVAILABLE) ||
  1970. // extension announced by proprietary SFTP_EXT_STATVFS extension
  1971. FSupportsStatVfsV2 ||
  1972. // Bitvise (until 6.21) fails to report it's supported extensions.
  1973. (FSecureShell->SshImplementation == sshiBitvise);
  1974. case fcCalculatingChecksum:
  1975. return
  1976. !FTerminal->IsEncryptingFiles() &&
  1977. (// Specification says that "check-file" should be announced,
  1978. // yet Vandyke VShell (as of 4.0.3) announce "check-file-name"
  1979. SupportsExtension(SFTP_EXT_CHECK_FILE) ||
  1980. SupportsExtension(SFTP_EXT_CHECK_FILE_NAME) ||
  1981. // see above
  1982. (FSecureShell->SshImplementation == sshiBitvise));
  1983. case fcRemoteCopy:
  1984. return
  1985. // Implemented by ProFTPD/mod_sftp, OpenSSH (since 9.0) and Bitvise WinSSHD (without announcing it)
  1986. SupportsExtension(SFTP_EXT_COPY_FILE) ||
  1987. SupportsExtension(SFTP_EXT_COPY_DATA) ||
  1988. // see above
  1989. (FSecureShell->SshImplementation == sshiBitvise);
  1990. case fcHardLink:
  1991. return
  1992. (FVersion >= 6) ||
  1993. FSupportsHardlink;
  1994. case fcChangePassword:
  1995. return FSecureShell->CanChangePassword();
  1996. default:
  1997. DebugFail();
  1998. return false;
  1999. }
  2000. }
  2001. //---------------------------------------------------------------------------
  2002. bool __fastcall TSFTPFileSystem::SupportsExtension(const UnicodeString & Extension) const
  2003. {
  2004. return (FSupportedExtensions->IndexOf(Extension) >= 0);
  2005. }
  2006. //---------------------------------------------------------------------------
  2007. inline void __fastcall TSFTPFileSystem::BusyStart()
  2008. {
  2009. if (FBusy == 0 && FTerminal->UseBusyCursor && !FAvoidBusy)
  2010. {
  2011. FBusyToken = ::BusyStart();
  2012. }
  2013. FBusy++;
  2014. DebugAssert(FBusy < 10);
  2015. }
  2016. //---------------------------------------------------------------------------
  2017. inline void __fastcall TSFTPFileSystem::BusyEnd()
  2018. {
  2019. DebugAssert(FBusy > 0);
  2020. FBusy--;
  2021. if (FBusy == 0 && FTerminal->UseBusyCursor && !FAvoidBusy)
  2022. {
  2023. ::BusyEnd(FBusyToken);
  2024. FBusyToken = NULL;
  2025. }
  2026. }
  2027. //---------------------------------------------------------------------------
  2028. // size + message number + type
  2029. const unsigned long SFTPPacketOverhead = 4 + 4 + 1;
  2030. //---------------------------------------------------------------------------
  2031. unsigned long __fastcall TSFTPFileSystem::TransferBlockSize(
  2032. unsigned long Overhead, TFileOperationProgressType * OperationProgress)
  2033. {
  2034. const unsigned long MinPacketSize = 32768;
  2035. unsigned long AMaxPacketSize = FSecureShell->MaxPacketSize();
  2036. bool MaxPacketSizeValid = (AMaxPacketSize > 0);
  2037. unsigned long CPSRounded = TEncryption::RoundToBlock(OperationProgress->CPS());
  2038. unsigned long Result = CPSRounded;
  2039. if ((FMaxPacketSize > 0) &&
  2040. ((FMaxPacketSize < AMaxPacketSize) || !MaxPacketSizeValid))
  2041. {
  2042. AMaxPacketSize = FMaxPacketSize;
  2043. MaxPacketSizeValid = true;
  2044. }
  2045. if (Result == 0)
  2046. {
  2047. Result = OperationProgress->StaticBlockSize();
  2048. }
  2049. if (Result < MinPacketSize)
  2050. {
  2051. Result = MinPacketSize;
  2052. }
  2053. if (MaxPacketSizeValid)
  2054. {
  2055. Overhead += SFTPPacketOverhead;
  2056. if (AMaxPacketSize < Overhead)
  2057. {
  2058. // do not send another request
  2059. // (generally should happen only if upload buffer is full)
  2060. Result = 0;
  2061. }
  2062. else
  2063. {
  2064. AMaxPacketSize -= Overhead;
  2065. if (Result > AMaxPacketSize)
  2066. {
  2067. unsigned int MaxPacketSizeRounded = TEncryption::RoundToBlockDown(AMaxPacketSize);
  2068. if (MaxPacketSizeRounded > 0)
  2069. {
  2070. AMaxPacketSize = MaxPacketSizeRounded;
  2071. }
  2072. Result = AMaxPacketSize;
  2073. }
  2074. }
  2075. }
  2076. Result = OperationProgress->AdjustToCPSLimit(Result);
  2077. return Result;
  2078. }
  2079. //---------------------------------------------------------------------------
  2080. unsigned long __fastcall TSFTPFileSystem::UploadBlockSize(const RawByteString & Handle,
  2081. TFileOperationProgressType * OperationProgress)
  2082. {
  2083. // handle length + offset + data size
  2084. const unsigned long UploadPacketOverhead =
  2085. sizeof(unsigned long) + sizeof(__int64) + sizeof(unsigned long);
  2086. return TransferBlockSize(UploadPacketOverhead + Handle.Length(), OperationProgress);
  2087. }
  2088. //---------------------------------------------------------------------------
  2089. unsigned long __fastcall TSFTPFileSystem::DownloadBlockSize(
  2090. TFileOperationProgressType * OperationProgress)
  2091. {
  2092. unsigned long Result = TransferBlockSize(sizeof(unsigned long), OperationProgress);
  2093. if (FSupport->Loaded && (FSupport->MaxReadSize > 0) &&
  2094. (Result > FSupport->MaxReadSize))
  2095. {
  2096. Result = FSupport->MaxReadSize;
  2097. }
  2098. // Never ask for more than we can accept (overhead here should correctly not include the "size" field)
  2099. if (Result + SFTPPacketOverhead > SFTP_MAX_PACKET_LEN)
  2100. {
  2101. Result = SFTP_MAX_PACKET_LEN - SFTPPacketOverhead;
  2102. }
  2103. return Result;
  2104. }
  2105. //---------------------------------------------------------------------------
  2106. void __fastcall TSFTPFileSystem::Progress(TFileOperationProgressType * OperationProgress)
  2107. {
  2108. FTerminal->Progress(OperationProgress);
  2109. }
  2110. //---------------------------------------------------------------------------
  2111. void TSFTPFileSystem::LogPacket(const TSFTPPacket * Packet, TLogLineType Type)
  2112. {
  2113. std::vector<UnicodeString> NotLogged;
  2114. #define ADD_NOT_LOGGED(V, N) \
  2115. if (FNotLogged##V##Packets > 0) \
  2116. { \
  2117. NotLogged.push_back(FORMAT(L"%d SSH_FXP_"#N, (FNotLogged##V##Packets))); \
  2118. FNotLogged##V##Packets = 0; \
  2119. }
  2120. ADD_NOT_LOGGED(Write, WRITE);
  2121. ADD_NOT_LOGGED(Read, READ);
  2122. ADD_NOT_LOGGED(Data, DATA);
  2123. ADD_NOT_LOGGED(Status, STATUS);
  2124. if (!NotLogged.empty())
  2125. {
  2126. UnicodeString S;
  2127. for (size_t Index = 0; Index < NotLogged.size(); Index++)
  2128. {
  2129. AddToList(S, NotLogged[Index], (Index < NotLogged.size() - 1 ? L", " : L" and "));
  2130. }
  2131. FTerminal->LogEvent(FORMAT(L"Skipped %s packets", (S)));
  2132. }
  2133. FTerminal->Log->Add(
  2134. Type, FORMAT(L"Type: %s, Size: %d, Number: %d", (Packet->TypeName, (int)Packet->Length, (int)Packet->MessageNumber)));
  2135. if (FTerminal->Configuration->ActualLogProtocol >= 2)
  2136. {
  2137. FTerminal->Log->Add(Type, Packet->Dump());
  2138. }
  2139. }
  2140. //---------------------------------------------------------------------------
  2141. void __fastcall TSFTPFileSystem::SendPacket(const TSFTPPacket * Packet)
  2142. {
  2143. // putting here for a lack of better place
  2144. if (!FUtfDisablingAnnounced && (FUtfStrings == asOff))
  2145. {
  2146. FTerminal->LogEvent(L"Strings received in non-UTF-8 encoding in a previous packet, will not use UTF-8 anymore");
  2147. FUtfDisablingAnnounced = true;
  2148. }
  2149. BusyStart();
  2150. try
  2151. {
  2152. if (FTerminal->Log->Logging && (FTerminal->Configuration->ActualLogProtocol >= 0))
  2153. {
  2154. if ((FPreviousLoggedPacket != SSH_FXP_READ &&
  2155. FPreviousLoggedPacket != SSH_FXP_WRITE) ||
  2156. (Packet->Type != FPreviousLoggedPacket) ||
  2157. (FTerminal->Configuration->ActualLogProtocol >= 1))
  2158. {
  2159. LogPacket(Packet, llInput);
  2160. FPreviousLoggedPacket = Packet->Type;
  2161. }
  2162. else
  2163. {
  2164. if (Packet->Type == SSH_FXP_WRITE)
  2165. {
  2166. FNotLoggedWritePackets++;
  2167. }
  2168. else if (DebugAlwaysTrue(Packet->Type == SSH_FXP_READ))
  2169. {
  2170. FNotLoggedReadPackets++;
  2171. }
  2172. FNotLoggedRequests.insert(Packet->MessageNumber);
  2173. }
  2174. }
  2175. FSecureShell->Send(Packet->SendData, Packet->SendLength);
  2176. }
  2177. __finally
  2178. {
  2179. BusyEnd();
  2180. }
  2181. }
  2182. //---------------------------------------------------------------------------
  2183. unsigned long __fastcall TSFTPFileSystem::GotStatusPacket(
  2184. TSFTPPacket * Packet, int AllowStatus, bool DoNotForceLog)
  2185. {
  2186. unsigned long Code = Packet->GetCardinal();
  2187. static int Messages[] = {
  2188. SFTP_STATUS_OK,
  2189. SFTP_STATUS_EOF,
  2190. SFTP_STATUS_NO_SUCH_FILE,
  2191. SFTP_STATUS_PERMISSION_DENIED,
  2192. SFTP_STATUS_FAILURE,
  2193. SFTP_STATUS_BAD_MESSAGE,
  2194. SFTP_STATUS_NO_CONNECTION,
  2195. SFTP_STATUS_CONNECTION_LOST,
  2196. SFTP_STATUS_OP_UNSUPPORTED,
  2197. SFTP_STATUS_INVALID_HANDLE,
  2198. SFTP_STATUS_NO_SUCH_PATH,
  2199. SFTP_STATUS_FILE_ALREADY_EXISTS,
  2200. SFTP_STATUS_WRITE_PROTECT,
  2201. SFTP_STATUS_NO_MEDIA,
  2202. SFTP_STATUS_NO_SPACE_ON_FILESYSTEM,
  2203. SFTP_STATUS_QUOTA_EXCEEDED,
  2204. SFTP_STATUS_UNKNOWN_PRINCIPAL,
  2205. SFTP_STATUS_LOCK_CONFLICT,
  2206. SFTP_STATUS_DIR_NOT_EMPTY,
  2207. SFTP_STATUS_NOT_A_DIRECTORY,
  2208. SFTP_STATUS_INVALID_FILENAME,
  2209. SFTP_STATUS_LINK_LOOP,
  2210. SFTP_STATUS_CANNOT_DELETE,
  2211. SFTP_STATUS_INVALID_PARAMETER,
  2212. SFTP_STATUS_FILE_IS_A_DIRECTORY,
  2213. SFTP_STATUS_BYTE_RANGE_LOCK_CONFLICT,
  2214. SFTP_STATUS_BYTE_RANGE_LOCK_REFUSED,
  2215. SFTP_STATUS_DELETE_PENDING,
  2216. SFTP_STATUS_FILE_CORRUPT,
  2217. SFTP_STATUS_OWNER_INVALID,
  2218. SFTP_STATUS_GROUP_INVALID,
  2219. SFTP_STATUS_NO_MATCHING_BYTE_RANGE_LOCK
  2220. };
  2221. int Message;
  2222. if ((AllowStatus & (0x01 << Code)) == 0)
  2223. {
  2224. if (Code >= LENOF(Messages))
  2225. {
  2226. Message = SFTP_STATUS_UNKNOWN;
  2227. }
  2228. else
  2229. {
  2230. Message = Messages[Code];
  2231. }
  2232. UnicodeString MessageStr = LoadStr(Message);
  2233. UnicodeString ServerMessage;
  2234. UnicodeString LanguageTag;
  2235. // Message field is defined since version 3 only.
  2236. // We also might get the packet even before the version is established.
  2237. // And Cisco servers respond without message field even in version 3.
  2238. if (Packet->RemainingLength > 0)
  2239. {
  2240. // message is in UTF only since SFTP specification 01 (specification 00
  2241. // is also version 3)
  2242. // (in other words, always use UTF unless server is known to be buggy)
  2243. ServerMessage = Packet->GetString(FUtfStrings);
  2244. // SSH-2.0-Maverick_SSHD and SSH-2.0-CIGNA SFTP Server Ready! omit the language tag
  2245. // and I believe I've seen one more server doing the same.
  2246. if (Packet->RemainingLength > 0)
  2247. {
  2248. LanguageTag = Packet->GetAnsiString();
  2249. if ((FVersion >= 5) && (Message == SFTP_STATUS_UNKNOWN_PRINCIPAL))
  2250. {
  2251. UnicodeString Principals;
  2252. while (Packet->GetNextData() != NULL)
  2253. {
  2254. if (!Principals.IsEmpty())
  2255. {
  2256. Principals += L", ";
  2257. }
  2258. Principals += Packet->GetAnsiString();
  2259. }
  2260. MessageStr = FORMAT(MessageStr, (Principals));
  2261. }
  2262. }
  2263. }
  2264. else
  2265. {
  2266. ServerMessage = LoadStr(SFTP_SERVER_MESSAGE_UNSUPPORTED);
  2267. }
  2268. if (FTerminal->Log->Logging &&
  2269. (FTerminal->Configuration->ActualLogProtocol >= 0))
  2270. {
  2271. FTerminal->Log->Add(llOutput, FORMAT(L"Status code: %d, Message: %d, Server: %s, Language: %s ",
  2272. (int(Code), (int)Packet->MessageNumber, ServerMessage, LanguageTag)));
  2273. }
  2274. if (!LanguageTag.IsEmpty())
  2275. {
  2276. LanguageTag = FORMAT(L" (%s)", (LanguageTag));
  2277. }
  2278. UnicodeString HelpKeyword;
  2279. switch (Code)
  2280. {
  2281. case SSH_FX_FAILURE:
  2282. HelpKeyword = HELP_SFTP_STATUS_FAILURE;
  2283. break;
  2284. case SSH_FX_PERMISSION_DENIED:
  2285. HelpKeyword = HELP_SFTP_STATUS_PERMISSION_DENIED;
  2286. break;
  2287. }
  2288. UnicodeString Error = FMTLOAD(SFTP_ERROR_FORMAT3, (MessageStr,
  2289. int(Code), LanguageTag, ServerMessage));
  2290. if (Code == SSH_FX_FAILURE)
  2291. {
  2292. FTerminal->Configuration->Usage->Inc(L"SftpFailureErrors");
  2293. Error += L"\n\n" + LoadStr(SFTP_STATUS_4);
  2294. }
  2295. FTerminal->TerminalError(NULL, Error, HelpKeyword);
  2296. return 0;
  2297. }
  2298. else
  2299. {
  2300. if (!DoNotForceLog || (Code != 0))
  2301. {
  2302. if (FTerminal->Configuration->ActualLogProtocol >= 0)
  2303. {
  2304. FTerminal->Log->Add(llOutput, FORMAT(L"Status code: %d", ((int)Code)));
  2305. }
  2306. }
  2307. return Code;
  2308. }
  2309. }
  2310. //---------------------------------------------------------------------------
  2311. void __fastcall TSFTPFileSystem::RemoveReservation(int Reservation)
  2312. {
  2313. for (int Index = Reservation+1; Index < FPacketReservations->Count; Index++)
  2314. {
  2315. FPacketNumbers.PutElement(FPacketNumbers.GetElement(Index), Index-1);
  2316. }
  2317. TSFTPPacket * Packet = (TSFTPPacket *)FPacketReservations->Items[Reservation];
  2318. if (Packet)
  2319. {
  2320. DebugAssert(Packet->ReservedBy == this);
  2321. Packet->ReservedBy = NULL;
  2322. }
  2323. FPacketReservations->Delete(Reservation);
  2324. }
  2325. //---------------------------------------------------------------------------
  2326. inline int __fastcall TSFTPFileSystem::PacketLength(unsigned char * LenBuf, int ExpectedType)
  2327. {
  2328. int Length = GET_32BIT(LenBuf);
  2329. if (Length > SFTP_MAX_PACKET_LEN)
  2330. {
  2331. UnicodeString Message = FMTLOAD(SFTP_PACKET_TOO_BIG, (
  2332. int(Length), SFTP_MAX_PACKET_LEN));
  2333. if (ExpectedType == SSH_FXP_VERSION)
  2334. {
  2335. RawByteString LenString(reinterpret_cast<char *>(LenBuf), 4);
  2336. Message = FMTLOAD(SFTP_PACKET_TOO_BIG_INIT_EXPLAIN,
  2337. (Message, DisplayableStr(LenString)));
  2338. }
  2339. FTerminal->FatalError(NULL, Message, HELP_SFTP_PACKET_TOO_BIG);
  2340. }
  2341. return Length;
  2342. }
  2343. //---------------------------------------------------------------------------
  2344. bool __fastcall TSFTPFileSystem::PeekPacket()
  2345. {
  2346. bool Result;
  2347. unsigned char * Buf;
  2348. Result = FSecureShell->Peek(Buf, 4);
  2349. if (Result)
  2350. {
  2351. int Length = PacketLength(Buf, -1);
  2352. Result = FSecureShell->Peek(Buf, 4 + Length);
  2353. }
  2354. return Result;
  2355. }
  2356. //---------------------------------------------------------------------------
  2357. int __fastcall TSFTPFileSystem::ReceivePacket(TSFTPPacket * Packet,
  2358. int ExpectedType, int AllowStatus, bool TryOnly)
  2359. {
  2360. TSFTPBusy Busy(this);
  2361. int Result = SSH_FX_OK;
  2362. int Reservation = FPacketReservations->IndexOf(Packet);
  2363. bool NotLogged;
  2364. if (Reservation < 0 || Packet->Capacity == 0)
  2365. {
  2366. bool IsReserved;
  2367. do
  2368. {
  2369. IsReserved = false;
  2370. NotLogged = false;
  2371. DebugAssert(Packet);
  2372. if (TryOnly && !PeekPacket())
  2373. {
  2374. // Reset packet in case it was filled by previous out-of-order
  2375. // reserved packet
  2376. *Packet = TSFTPPacket();
  2377. }
  2378. else
  2379. {
  2380. unsigned char LenBuf[4];
  2381. FSecureShell->Receive(LenBuf, sizeof(LenBuf));
  2382. int Length = PacketLength(LenBuf, ExpectedType);
  2383. Packet->Capacity = Length;
  2384. FSecureShell->Receive(Packet->Data, Length);
  2385. Packet->DataUpdated(Length);
  2386. bool ResponseToNotLoggedRequest = (FNotLoggedRequests.erase(Packet->MessageNumber) != 0);
  2387. if (FTerminal->Log->Logging && (FTerminal->Configuration->ActualLogProtocol >= 0))
  2388. {
  2389. if (!ResponseToNotLoggedRequest ||
  2390. (Packet->Type != SSH_FXP_STATUS && Packet->Type != SSH_FXP_DATA) ||
  2391. (FTerminal->Configuration->ActualLogProtocol >= 1))
  2392. {
  2393. LogPacket(Packet, llOutput);
  2394. }
  2395. else
  2396. {
  2397. if (Packet->Type == SSH_FXP_STATUS)
  2398. {
  2399. FNotLoggedStatusPackets++;
  2400. }
  2401. else if (DebugAlwaysTrue(Packet->Type == SSH_FXP_DATA))
  2402. {
  2403. FNotLoggedDataPackets++;
  2404. }
  2405. NotLogged = true; // used only for the response we wait for
  2406. }
  2407. }
  2408. if (Reservation < 0 ||
  2409. Packet->MessageNumber != (unsigned int)FPacketNumbers.GetElement(Reservation))
  2410. {
  2411. TSFTPPacket * ReservedPacket;
  2412. unsigned int MessageNumber;
  2413. for (int Index = 0; Index < FPacketReservations->Count; Index++)
  2414. {
  2415. MessageNumber = (unsigned int)FPacketNumbers.GetElement(Index);
  2416. if (MessageNumber == Packet->MessageNumber)
  2417. {
  2418. ReservedPacket = (TSFTPPacket *)FPacketReservations->Items[Index];
  2419. IsReserved = true;
  2420. if (ReservedPacket)
  2421. {
  2422. FTerminal->LogEvent(0, L"Storing reserved response");
  2423. *ReservedPacket = *Packet;
  2424. }
  2425. else
  2426. {
  2427. FTerminal->LogEvent(0, L"Discarding reserved response");
  2428. RemoveReservation(Index);
  2429. if ((Reservation >= 0) && (Reservation > Index))
  2430. {
  2431. Reservation--;
  2432. DebugAssert(Reservation == FPacketReservations->IndexOf(Packet));
  2433. }
  2434. }
  2435. break;
  2436. }
  2437. }
  2438. }
  2439. }
  2440. }
  2441. while (IsReserved);
  2442. }
  2443. if ((Packet->Capacity == 0) && DebugAlwaysTrue(TryOnly))
  2444. {
  2445. // noop
  2446. }
  2447. else
  2448. {
  2449. // before we removed the reservation after check for packet type,
  2450. // but if it raises exception, removal is unnecessarily
  2451. // postponed until the packet is removed
  2452. // (and it have not worked anyway until recent fix to UnreserveResponse)
  2453. if (Reservation >= 0)
  2454. {
  2455. DebugAssert(Packet->MessageNumber == (unsigned int)FPacketNumbers.GetElement(Reservation));
  2456. RemoveReservation(Reservation);
  2457. }
  2458. if (ExpectedType >= 0)
  2459. {
  2460. if (Packet->Type == SSH_FXP_STATUS)
  2461. {
  2462. if (AllowStatus < 0)
  2463. {
  2464. AllowStatus = (ExpectedType == SSH_FXP_STATUS ? asOK : asNo);
  2465. }
  2466. Result = GotStatusPacket(Packet, AllowStatus, NotLogged);
  2467. }
  2468. else if (ExpectedType != Packet->Type)
  2469. {
  2470. FTerminal->FatalError(NULL, FMTLOAD(SFTP_INVALID_TYPE, ((int)Packet->Type)));
  2471. }
  2472. }
  2473. }
  2474. return Result;
  2475. }
  2476. //---------------------------------------------------------------------------
  2477. void __fastcall TSFTPFileSystem::ReserveResponse(const TSFTPPacket * Packet,
  2478. TSFTPPacket * Response)
  2479. {
  2480. if (Response != NULL)
  2481. {
  2482. DebugAssert(FPacketReservations->IndexOf(Response) < 0);
  2483. // mark response as not received yet
  2484. Response->Capacity = 0;
  2485. Response->ReservedBy = this;
  2486. }
  2487. FPacketReservations->Add(Response);
  2488. if (FPacketReservations->Count >= FPacketNumbers.ArrayHighBound())
  2489. {
  2490. FPacketNumbers.ArrayRedim(FPacketReservations->Count + 10);
  2491. }
  2492. FPacketNumbers.PutElement(Packet->MessageNumber, FPacketReservations->Count - 1);
  2493. }
  2494. //---------------------------------------------------------------------------
  2495. void __fastcall TSFTPFileSystem::UnreserveResponse(TSFTPPacket * Response)
  2496. {
  2497. int Reservation = FPacketReservations->IndexOf(Response);
  2498. if (Response->Capacity != 0)
  2499. {
  2500. // added check for already received packet
  2501. // (it happens when the reserved response is received out of order,
  2502. // unexpectedly soon, and then receivepacket() on the packet
  2503. // is not actually called, due to exception)
  2504. RemoveReservation(Reservation);
  2505. }
  2506. else
  2507. {
  2508. if (Reservation >= 0)
  2509. {
  2510. // we probably do not remove the item at all, because
  2511. // we must remember that the response was expected, so we skip it
  2512. // in receivepacket()
  2513. FPacketReservations->Items[Reservation] = NULL;
  2514. }
  2515. }
  2516. }
  2517. //---------------------------------------------------------------------------
  2518. int __fastcall TSFTPFileSystem::ReceiveResponse(
  2519. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
  2520. int AllowStatus, bool TryOnly)
  2521. {
  2522. int Result;
  2523. unsigned int MessageNumber = Packet->MessageNumber;
  2524. TSFTPPacket * AResponse = (Response ? Response : new TSFTPPacket());
  2525. try
  2526. {
  2527. Result = ReceivePacket(AResponse, ExpectedType, AllowStatus, TryOnly);
  2528. if (MessageNumber != AResponse->MessageNumber)
  2529. {
  2530. FTerminal->FatalError(NULL, FMTLOAD(SFTP_MESSAGE_NUMBER,
  2531. ((int)AResponse->MessageNumber, (int)MessageNumber)));
  2532. }
  2533. }
  2534. __finally
  2535. {
  2536. if (!Response)
  2537. {
  2538. delete AResponse;
  2539. }
  2540. }
  2541. return Result;
  2542. }
  2543. //---------------------------------------------------------------------------
  2544. int __fastcall TSFTPFileSystem::SendPacketAndReceiveResponse(
  2545. const TSFTPPacket * Packet, TSFTPPacket * Response, int ExpectedType,
  2546. int AllowStatus)
  2547. {
  2548. int Result;
  2549. TSFTPBusy Busy(this);
  2550. SendPacket(Packet);
  2551. Result = ReceiveResponse(Packet, Response, ExpectedType, AllowStatus);
  2552. return Result;
  2553. }
  2554. //---------------------------------------------------------------------------
  2555. UnicodeString __fastcall TSFTPFileSystem::RealPath(const UnicodeString & Path)
  2556. {
  2557. if (FTerminal->SessionData->SFTPRealPath == asOff)
  2558. {
  2559. return LocalCanonify(Path);
  2560. }
  2561. else
  2562. {
  2563. try
  2564. {
  2565. FTerminal->LogEvent(0, FORMAT(L"Getting real path for '%s'", (Path)));
  2566. TSFTPPacket Packet(SSH_FXP_REALPATH);
  2567. AddPathString(Packet, Path);
  2568. // In SFTP-6 new optional field control-byte is added that defaults to
  2569. // SSH_FXP_REALPATH_NO_CHECK=0x01, meaning it won't fail, if the path does not exist.
  2570. // That differs from SFTP-5 recommendation that
  2571. // "The server SHOULD fail the request if the path is not present on the server."
  2572. // Earlier versions had no recommendation, though canonical SFTP-3 implementation
  2573. // in OpenSSH fails.
  2574. // While we really do not care much, we anyway set the flag to ~ & 0x01 to make the request fail.
  2575. // First for consistency.
  2576. // Second to workaround a bug in ProFTPD/mod_sftp version 1.3.5rc1 through 1.3.5-stable
  2577. // that sends a completely malformed response for non-existing paths,
  2578. // when SSH_FXP_REALPATH_NO_CHECK (even implicitly) is used.
  2579. // See http://bugs.proftpd.org/show_bug.cgi?id=4160
  2580. // Note that earlier drafts of SFTP-6 (filexfer-07 and -08) had optional compose-path field
  2581. // before control-byte field. If we ever use this against a server conforming to those drafts,
  2582. // it may cause trouble.
  2583. if (FVersion >= 6)
  2584. {
  2585. if (FSecureShell->SshImplementation != sshiProFTPD)
  2586. {
  2587. Packet.AddByte(SSH_FXP_REALPATH_STAT_ALWAYS);
  2588. }
  2589. else
  2590. {
  2591. // Cannot use SSH_FXP_REALPATH_STAT_ALWAYS as ProFTPD does wrong bitwise test
  2592. // so it incorrectly evaluates SSH_FXP_REALPATH_STAT_ALWAYS (0x03) as
  2593. // SSH_FXP_REALPATH_NO_CHECK (0x01). The only value conforming to the
  2594. // specification, yet working with ProFTPD is SSH_FXP_REALPATH_STAT_IF (0x02).
  2595. Packet.AddByte(SSH_FXP_REALPATH_STAT_IF);
  2596. }
  2597. }
  2598. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_NAME);
  2599. if (Packet.GetCardinal() != 1)
  2600. {
  2601. FTerminal->FatalError(NULL, LoadStr(SFTP_NON_ONE_FXP_NAME_PACKET));
  2602. }
  2603. UnicodeString RealDir = UnixExcludeTrailingBackslash(Packet.GetPathString(FUtfStrings));
  2604. // do not cache, as particularly when called from CreateDirectory > Canonify,
  2605. // we would cache an unencrypted path to a directory we want to create encrypted,
  2606. // what would prevent the encryption later.
  2607. RealDir = FTerminal->DecryptFileName(RealDir, true, true);
  2608. // ignore rest of SSH_FXP_NAME packet
  2609. FTerminal->LogEvent(0, FORMAT(L"Real path is '%s'", (RealDir)));
  2610. return RealDir;
  2611. }
  2612. catch(Exception & E)
  2613. {
  2614. if (FTerminal->Active)
  2615. {
  2616. throw ExtException(&E, FMTLOAD(SFTP_REALPATH_ERROR, (Path)));
  2617. }
  2618. else
  2619. {
  2620. throw;
  2621. }
  2622. }
  2623. }
  2624. }
  2625. //---------------------------------------------------------------------------
  2626. UnicodeString __fastcall TSFTPFileSystem::RealPath(const UnicodeString & Path, const UnicodeString & BaseDir)
  2627. {
  2628. UnicodeString APath;
  2629. if (UnixIsAbsolutePath(Path))
  2630. {
  2631. APath = Path;
  2632. }
  2633. else
  2634. {
  2635. if (!Path.IsEmpty())
  2636. {
  2637. // this condition/block was outside (before) current block
  2638. // but it did not work when Path was empty
  2639. if (!BaseDir.IsEmpty())
  2640. {
  2641. APath = UnixIncludeTrailingBackslash(BaseDir);
  2642. }
  2643. APath = APath + Path;
  2644. }
  2645. if (APath.IsEmpty()) APath = UnixIncludeTrailingBackslash(L".");
  2646. }
  2647. return RealPath(APath);
  2648. }
  2649. //---------------------------------------------------------------------------
  2650. UnicodeString __fastcall TSFTPFileSystem::LocalCanonify(const UnicodeString & Path)
  2651. {
  2652. // TODO: improve (handle .. etc.)
  2653. if (UnixIsAbsolutePath(Path) ||
  2654. (!FCurrentDirectory.IsEmpty() && UnixSamePath(FCurrentDirectory, Path)))
  2655. {
  2656. return Path;
  2657. }
  2658. else
  2659. {
  2660. return ::AbsolutePath(FCurrentDirectory, Path);
  2661. }
  2662. }
  2663. //---------------------------------------------------------------------------
  2664. UnicodeString __fastcall TSFTPFileSystem::Canonify(const UnicodeString & AAPath)
  2665. {
  2666. // inspired by canonify() from PSFTP.C
  2667. UnicodeString Result;
  2668. FTerminal->LogEvent(FORMAT(L"Canonifying: \"%s\"", (AAPath)));
  2669. UnicodeString Path = LocalCanonify(AAPath);
  2670. bool TryParent = false;
  2671. try
  2672. {
  2673. Result = RealPath(Path);
  2674. }
  2675. catch(...)
  2676. {
  2677. if (FTerminal->Active)
  2678. {
  2679. TryParent = true;
  2680. }
  2681. else
  2682. {
  2683. throw;
  2684. }
  2685. }
  2686. if (TryParent)
  2687. {
  2688. UnicodeString APath = UnixExcludeTrailingBackslash(Path);
  2689. UnicodeString Name = UnixExtractFileName(APath);
  2690. if (!IsRealFile(Name))
  2691. {
  2692. Result = Path;
  2693. }
  2694. else
  2695. {
  2696. UnicodeString FPath = UnixExtractFilePath(APath);
  2697. try
  2698. {
  2699. Result = RealPath(FPath);
  2700. Result = UnixIncludeTrailingBackslash(Result) + Name;
  2701. }
  2702. catch(...)
  2703. {
  2704. if (FTerminal->Active)
  2705. {
  2706. Result = Path;
  2707. }
  2708. else
  2709. {
  2710. throw;
  2711. }
  2712. }
  2713. }
  2714. }
  2715. FTerminal->LogEvent(FORMAT(L"Canonified: \"%s\"", (Result)));
  2716. return Result;
  2717. }
  2718. //---------------------------------------------------------------------------
  2719. UnicodeString __fastcall TSFTPFileSystem::AbsolutePath(UnicodeString Path, bool Local)
  2720. {
  2721. if (Local)
  2722. {
  2723. return LocalCanonify(Path);
  2724. }
  2725. else
  2726. {
  2727. return RealPath(Path, CurrentDirectory);
  2728. }
  2729. }
  2730. //---------------------------------------------------------------------------
  2731. UnicodeString __fastcall TSFTPFileSystem::GetHomeDirectory()
  2732. {
  2733. if (FHomeDirectory.IsEmpty())
  2734. {
  2735. FHomeDirectory = RealPath(L".");
  2736. // Prevent infinite recursion when the server is broken
  2737. if (FHomeDirectory.IsEmpty())
  2738. {
  2739. FHomeDirectory = ROOTDIRECTORY;
  2740. }
  2741. }
  2742. return FHomeDirectory;
  2743. }
  2744. //---------------------------------------------------------------------------
  2745. void __fastcall TSFTPFileSystem::LoadFile(TRemoteFile * File, TSFTPPacket * Packet,
  2746. bool Complete)
  2747. {
  2748. Packet->GetFile(File, FVersion, FTerminal->SessionData->DSTMode, FUtfStrings, FSignedTS, Complete);
  2749. }
  2750. //---------------------------------------------------------------------------
  2751. TRemoteFile * __fastcall TSFTPFileSystem::LoadFile(TSFTPPacket * Packet,
  2752. TRemoteFile * ALinkedByFile, const UnicodeString FileName,
  2753. TRemoteFileList * TempFileList, bool Complete)
  2754. {
  2755. TRemoteFile * File = new TRemoteFile(ALinkedByFile);
  2756. try
  2757. {
  2758. File->Terminal = FTerminal;
  2759. if (!FileName.IsEmpty())
  2760. {
  2761. File->FileName = FileName;
  2762. }
  2763. // to get full path for symlink completion
  2764. File->Directory = TempFileList;
  2765. LoadFile(File, Packet, Complete);
  2766. File->Directory = NULL;
  2767. }
  2768. catch(...)
  2769. {
  2770. delete File;
  2771. throw;
  2772. }
  2773. return File;
  2774. }
  2775. //---------------------------------------------------------------------------
  2776. UnicodeString __fastcall TSFTPFileSystem::GetCurrentDirectory()
  2777. {
  2778. return FCurrentDirectory;
  2779. }
  2780. //---------------------------------------------------------------------------
  2781. void __fastcall TSFTPFileSystem::DoStartup()
  2782. {
  2783. // do not know yet
  2784. FVersion = -1;
  2785. FFileSystemInfoValid = false;
  2786. TSFTPPacket Packet(SSH_FXP_INIT);
  2787. int MaxVersion = FTerminal->SessionData->SFTPMaxVersion;
  2788. if (MaxVersion == SFTPMaxVersionAuto)
  2789. {
  2790. TSshImplementation SshImplementation = FSecureShell->SshImplementation;
  2791. if ((SshImplementation == sshiOpenSSH) || (SshImplementation == sshiProFTPD) || (SshImplementation == sshiBitvise))
  2792. {
  2793. MaxVersion = SFTPMaxVersion;
  2794. FTerminal->LogEvent(FORMAT(L"Well known server, allowing SFTP version %d.", (MaxVersion)));
  2795. }
  2796. else
  2797. {
  2798. MaxVersion = SFTPStandardVersion;
  2799. FTerminal->LogEvent(FORMAT(L"Not well known server, limiting to safe SFTP version %d.", (MaxVersion)));
  2800. }
  2801. }
  2802. if (MaxVersion > SFTPMaxVersion)
  2803. {
  2804. MaxVersion = SFTPMaxVersion;
  2805. }
  2806. Packet.AddCardinal(MaxVersion);
  2807. try
  2808. {
  2809. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_VERSION);
  2810. }
  2811. catch(Exception &E)
  2812. {
  2813. FTerminal->FatalError(&E, LoadStr(SFTP_INITIALIZE_ERROR), HELP_SFTP_INITIALIZE_ERROR);
  2814. }
  2815. FVersion = Packet.GetCardinal();
  2816. FTerminal->LogEvent(FORMAT(L"SFTP version %d negotiated.", (FVersion)));
  2817. if (FVersion > MaxVersion)
  2818. {
  2819. // This happens with ProFTPD:
  2820. // https://github.com/proftpd/proftpd/issues/1200
  2821. FTerminal->LogEvent(L"Got higher version than asked for.");
  2822. }
  2823. if (FVersion < SFTPMinVersion || FVersion > SFTPMaxVersion)
  2824. {
  2825. FTerminal->FatalError(NULL, FMTLOAD(SFTP_VERSION_NOT_SUPPORTED,
  2826. (FVersion, SFTPMinVersion, SFTPMaxVersion)));
  2827. }
  2828. FExtensions = EmptyStr;
  2829. FEOL = "\r\n";
  2830. FSupport->Loaded = false;
  2831. FSupportsStatVfsV2 = false;
  2832. FSupportsHardlink = false;
  2833. bool SupportsLimits = false;
  2834. SAFE_DESTROY(FFixedPaths);
  2835. // OpenSSH announce extensions directly in the SSH_FXP_VERSION packet only.
  2836. // Bitvise uses "supported2" extension for some (mostly the standard ones) and SSH_FXP_VERSION for other.
  2837. // ProFTPD uses "supported2" extension for the standard extensions. And repeats them along with non-standard in the SSH_FXP_VERSION.
  2838. std::unique_ptr<TStrings> SupportedExtensions(new TStringList());
  2839. if (FVersion >= 3)
  2840. {
  2841. while (Packet.GetNextData() != NULL)
  2842. {
  2843. UnicodeString ExtensionName = Packet.GetAnsiString();
  2844. RawByteString ExtensionData = Packet.GetRawByteString();
  2845. UnicodeString ExtensionDisplayData = DisplayableStr(ExtensionData);
  2846. if (ExtensionName == SFTP_EXT_NEWLINE)
  2847. {
  2848. FEOL = AnsiString(ExtensionData);
  2849. FTerminal->LogEvent(FORMAT(L"Server requests EOL sequence %s.",
  2850. (ExtensionDisplayData)));
  2851. if (FEOL.Length() < 1 || FEOL.Length() > 2)
  2852. {
  2853. FTerminal->FatalError(NULL, FMTLOAD(SFTP_INVALID_EOL, (ExtensionDisplayData)));
  2854. }
  2855. }
  2856. // do not allow "supported" to override "supported2" if both are received
  2857. else if (((ExtensionName == SFTP_EXT_SUPPORTED) && !FSupport->Loaded) ||
  2858. (ExtensionName == SFTP_EXT_SUPPORTED2))
  2859. {
  2860. FSupport->Reset();
  2861. TSFTPPacket SupportedStruct(ExtensionData);
  2862. FSupport->Loaded = true;
  2863. FSupport->AttributeMask = SupportedStruct.GetCardinal();
  2864. FSupport->AttributeBits = SupportedStruct.GetCardinal();
  2865. FSupport->OpenFlags = SupportedStruct.GetCardinal();
  2866. FSupport->AccessMask = SupportedStruct.GetCardinal();
  2867. FSupport->MaxReadSize = SupportedStruct.GetCardinal();
  2868. std::unique_ptr<TStrings> ExtensionsLog(new TStringList());
  2869. if (ExtensionName == SFTP_EXT_SUPPORTED)
  2870. {
  2871. while (SupportedStruct.GetNextData() != NULL)
  2872. {
  2873. UnicodeString Extension = SupportedStruct.GetAnsiString();
  2874. ExtensionsLog->Add(Extension);
  2875. SupportedExtensions->Add(Extension);
  2876. }
  2877. }
  2878. else
  2879. {
  2880. // note that supported-open-block-vector, supported-block-vector,
  2881. // attrib-extension-count and attrib-extension-names fields
  2882. // were added only in rev 08, while "supported2" was defined in rev 07
  2883. FSupport->OpenBlockVector = SupportedStruct.GetSmallCardinal();
  2884. FSupport->BlockVector = SupportedStruct.GetSmallCardinal();
  2885. unsigned int ExtensionCount;
  2886. ExtensionCount = SupportedStruct.GetCardinal();
  2887. for (unsigned int i = 0; i < ExtensionCount; i++)
  2888. {
  2889. FSupport->AttribExtensions->Add(SupportedStruct.GetAnsiString());
  2890. }
  2891. ExtensionCount = SupportedStruct.GetCardinal();
  2892. for (unsigned int i = 0; i < ExtensionCount; i++)
  2893. {
  2894. UnicodeString Extension = SupportedStruct.GetAnsiString();
  2895. SupportedExtensions->Add(Extension);
  2896. ExtensionsLog->Add(Extension);
  2897. }
  2898. }
  2899. if (FTerminal->Log->Logging)
  2900. {
  2901. FTerminal->LogEvent(FORMAT(
  2902. L"Server support information (%s):\n"
  2903. " Attribute mask: %x, Attribute bits: %x, Open flags: %x\n"
  2904. " Access mask: %x, Open block vector: %x, Block vector: %x, Max read size: %d\n",
  2905. (ExtensionName,
  2906. int(FSupport->AttributeMask),
  2907. int(FSupport->AttributeBits),
  2908. int(FSupport->OpenFlags),
  2909. int(FSupport->AccessMask),
  2910. int(FSupport->OpenBlockVector),
  2911. int(FSupport->BlockVector),
  2912. int(FSupport->MaxReadSize))));
  2913. FTerminal->LogEvent(FORMAT(L" Attribute extensions (%d)\n", (FSupport->AttribExtensions->Count)));
  2914. for (int Index = 0; Index < FSupport->AttribExtensions->Count; Index++)
  2915. {
  2916. FTerminal->LogEvent(
  2917. FORMAT(L" %s", (FSupport->AttribExtensions->Strings[Index])));
  2918. }
  2919. FTerminal->LogEvent(FORMAT(L" Extensions (%d)\n", (ExtensionsLog->Count)));
  2920. for (int Index = 0; Index < ExtensionsLog->Count; Index++)
  2921. {
  2922. FTerminal->LogEvent(
  2923. FORMAT(L" %s", (ExtensionsLog->Strings[Index])));
  2924. }
  2925. }
  2926. }
  2927. else if (ExtensionName == SFTP_EXT_VENDOR_ID)
  2928. {
  2929. TSFTPPacket VendorIdStruct(ExtensionData);
  2930. UnicodeString VendorName(VendorIdStruct.GetAnsiString());
  2931. UnicodeString ProductName(VendorIdStruct.GetAnsiString());
  2932. UnicodeString ProductVersion(VendorIdStruct.GetAnsiString());
  2933. __int64 ProductBuildNumber = VendorIdStruct.GetInt64();
  2934. FTerminal->LogEvent(FORMAT(L"Server software: %s %s (%d) by %s",
  2935. (ProductName, ProductVersion, int(ProductBuildNumber), VendorName)));
  2936. }
  2937. else if (ExtensionName == SFTP_EXT_FSROOTS)
  2938. {
  2939. FTerminal->LogEvent(L"File system roots:\n");
  2940. DebugAssert(FFixedPaths == NULL);
  2941. FFixedPaths = new TStringList();
  2942. try
  2943. {
  2944. TSFTPPacket RootsPacket(ExtensionData);
  2945. while (RootsPacket.GetNextData() != NULL)
  2946. {
  2947. unsigned long Dummy = RootsPacket.GetCardinal();
  2948. if (Dummy != 1)
  2949. {
  2950. break;
  2951. }
  2952. else
  2953. {
  2954. unsigned char Drive = RootsPacket.GetByte();
  2955. unsigned char MaybeType = RootsPacket.GetByte();
  2956. FTerminal->LogEvent(FORMAT(L" %s: (type %d)", (static_cast<char>(Drive), (int)MaybeType)));
  2957. FFixedPaths->Add(FORMAT(L"%s:", (static_cast<char>(Drive))));
  2958. }
  2959. }
  2960. }
  2961. catch(Exception & E)
  2962. {
  2963. FFixedPaths->Clear();
  2964. FTerminal->LogEvent(FORMAT(L"Failed to decode %s extension",
  2965. (ExtensionName)));
  2966. FTerminal->HandleException(&E);
  2967. }
  2968. }
  2969. else if (ExtensionName == SFTP_EXT_VERSIONS)
  2970. {
  2971. // first try legacy decoding according to incorrect encoding
  2972. // (structure-like) as of VShell (bug no longer present as of 4.0.3).
  2973. TSFTPPacket VersionsPacket(ExtensionData);
  2974. unsigned int StringSize;
  2975. if (VersionsPacket.CanGetString(StringSize) &&
  2976. (StringSize == VersionsPacket.RemainingLength))
  2977. {
  2978. UnicodeString Versions = VersionsPacket.GetAnsiString();
  2979. FTerminal->LogEvent(FORMAT(L"SFTP versions supported by the server (VShell format): %s",
  2980. (Versions)));
  2981. }
  2982. else
  2983. {
  2984. // if that fails, fallback to proper decoding
  2985. FTerminal->LogEvent(FORMAT(L"SFTP versions supported by the server: %s",
  2986. (AnsiToString(ExtensionData))));
  2987. }
  2988. }
  2989. else if (ExtensionName == SFTP_EXT_STATVFS)
  2990. {
  2991. UnicodeString StatVfsVersion = AnsiToString(ExtensionData);
  2992. if (StatVfsVersion == SFTP_EXT_STATVFS_VALUE_V2)
  2993. {
  2994. FSupportsStatVfsV2 = true;
  2995. FTerminal->LogEvent(FORMAT(L"Supports %s extension version %s", (ExtensionName, StatVfsVersion)));
  2996. }
  2997. else
  2998. {
  2999. FTerminal->LogEvent(FORMAT(L"Unsupported %s extension version %s", (ExtensionName, StatVfsVersion)));
  3000. }
  3001. }
  3002. else if (ExtensionName == SFTP_EXT_HARDLINK)
  3003. {
  3004. UnicodeString HardlinkVersion = AnsiToString(ExtensionData);
  3005. if (HardlinkVersion == SFTP_EXT_HARDLINK_VALUE_V1)
  3006. {
  3007. FSupportsHardlink = true;
  3008. FTerminal->LogEvent(FORMAT(L"Supports %s extension version %s", (ExtensionName, HardlinkVersion)));
  3009. }
  3010. else
  3011. {
  3012. FTerminal->LogEvent(FORMAT(L"Unsupported %s extension version %s", (ExtensionName, HardlinkVersion)));
  3013. }
  3014. }
  3015. else if (ExtensionName == SFTP_EXT_LIMITS)
  3016. {
  3017. UnicodeString LimitsVersion = AnsiToString(ExtensionData);
  3018. if (LimitsVersion == SFTP_EXT_LIMITS_VALUE_V1)
  3019. {
  3020. SupportsLimits = true;
  3021. FTerminal->LogEvent(FORMAT(L"Supports %s extension version %s", (ExtensionName, LimitsVersion)));
  3022. }
  3023. else
  3024. {
  3025. FTerminal->LogEvent(FORMAT(L"Unsupported %s extension version %s", (ExtensionName, LimitsVersion)));
  3026. }
  3027. }
  3028. else if ((ExtensionName == SFTP_EXT_COPY_FILE) ||
  3029. (ExtensionName == SFTP_EXT_COPY_DATA) ||
  3030. (ExtensionName == SFTP_EXT_SPACE_AVAILABLE) ||
  3031. (ExtensionName == SFTP_EXT_CHECK_FILE) ||
  3032. (ExtensionName == SFTP_EXT_POSIX_RENAME))
  3033. {
  3034. FTerminal->LogEvent(FORMAT(L"Supports extension %s=%s", (ExtensionName, ExtensionDisplayData)));
  3035. }
  3036. else
  3037. {
  3038. FTerminal->LogEvent(0, FORMAT(L"Unknown server extension %s=%s", (ExtensionName, ExtensionDisplayData)));
  3039. }
  3040. UnicodeString Line = ExtensionName;
  3041. if (!ExtensionDisplayData.IsEmpty())
  3042. {
  3043. Line += FORMAT(L"=%s", (ExtensionDisplayData));
  3044. }
  3045. FExtensions += FORMAT(L" %s\r\n", (Line));
  3046. SupportedExtensions->Add(ExtensionName);
  3047. }
  3048. }
  3049. if (FVersion < 4)
  3050. {
  3051. // currently enable the bug for all servers (really known on OpenSSH)
  3052. FSignedTS = (FTerminal->SessionData->SFTPBug[sbSignedTS] == asOn) ||
  3053. (FTerminal->SessionData->SFTPBug[sbSignedTS] == asAuto);
  3054. if (FSignedTS)
  3055. {
  3056. FTerminal->LogEvent(L"We believe the server has signed timestamps bug");
  3057. }
  3058. }
  3059. else
  3060. {
  3061. FSignedTS = false;
  3062. }
  3063. switch (FTerminal->SessionData->NotUtf)
  3064. {
  3065. case asOff:
  3066. FUtfStrings = asOn;
  3067. FTerminal->LogEvent(L"We will use UTF-8 strings as configured");
  3068. break;
  3069. default:
  3070. DebugFail();
  3071. case asAuto:
  3072. // Nb, Foxit server does not exist anymore
  3073. if (GetSessionInfo().SshImplementation.Pos(L"Foxit-WAC-Server") == 1)
  3074. {
  3075. FUtfStrings = asOff;
  3076. FTerminal->LogEvent(L"We will not use UTF-8 strings as the server is known not to use them");
  3077. }
  3078. else
  3079. {
  3080. if (FVersion >= 4)
  3081. {
  3082. FTerminal->LogEvent(L"We will use UTF-8 strings as it is mandatory with SFTP version 4 and newer");
  3083. FUtfStrings = asOn;
  3084. }
  3085. else
  3086. {
  3087. FTerminal->LogEvent(L"We will use UTF-8 strings until server sends an invalid UTF-8 string as with SFTP version 3 and older UTF-8 strings are not mandatory");
  3088. FUtfStrings = asAuto;
  3089. FUtfDisablingAnnounced = false;
  3090. }
  3091. }
  3092. break;
  3093. case asOn:
  3094. FTerminal->LogEvent(L"We will not use UTF-8 strings as configured");
  3095. FUtfStrings = asOff;
  3096. break;
  3097. }
  3098. FMaxPacketSize = FTerminal->SessionData->SFTPMaxPacketSize;
  3099. if (FMaxPacketSize == 0)
  3100. {
  3101. unsigned int PacketPayload = 4;
  3102. if (SupportsLimits)
  3103. {
  3104. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  3105. Packet.AddString(SFTP_EXT_LIMITS);
  3106. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_EXTENDED_REPLY);
  3107. unsigned int MaxPacketSize = std::min(static_cast<__int64>(std::numeric_limits<unsigned long>::max()), Packet.GetInt64());
  3108. FTerminal->LogEvent(FORMAT(L"Limiting packet size to server's limit of %d + %d bytes",
  3109. (static_cast<int>(MaxPacketSize), static_cast<int>(PacketPayload))));
  3110. FMaxPacketSize = MaxPacketSize + PacketPayload;
  3111. }
  3112. else if ((FSecureShell->SshImplementation == sshiOpenSSH) && (FVersion == 3) && !FSupport->Loaded)
  3113. {
  3114. FMaxPacketSize = PacketPayload + (256 * 1024); // len + 256kB payload
  3115. FTerminal->LogEvent(FORMAT(L"Limiting packet size to OpenSSH sftp-server limit of %d bytes",
  3116. (int(FMaxPacketSize))));
  3117. }
  3118. // full string is "1.77 sshlib: Momentum SSH Server",
  3119. // possibly it is sshlib-related
  3120. else if (GetSessionInfo().SshImplementation.Pos(L"Momentum SSH Server") != 0)
  3121. {
  3122. FMaxPacketSize = PacketPayload + (32 * 1024);
  3123. FTerminal->LogEvent(FORMAT(L"Limiting packet size to Momentum sftp-server limit of %d bytes",
  3124. (int(FMaxPacketSize))));
  3125. }
  3126. }
  3127. FSupportedExtensions.reset(FTerminal->ProcessFeatures(SupportedExtensions.get()));
  3128. if (SupportsExtension(SFTP_EXT_VENDOR_ID))
  3129. {
  3130. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  3131. Packet.AddString(SFTP_EXT_VENDOR_ID);
  3132. Packet.AddString(FTerminal->Configuration->CompanyName);
  3133. Packet.AddString(FTerminal->Configuration->ProductName);
  3134. Packet.AddString(FTerminal->Configuration->ProductVersion);
  3135. Packet.AddInt64(LOWORD(FTerminal->Configuration->FixedApplicationInfo->dwFileVersionLS));
  3136. SendPacket(&Packet);
  3137. // we are not interested in the response, do not wait for it
  3138. ReserveResponse(&Packet, NULL);
  3139. }
  3140. }
  3141. //---------------------------------------------------------------------------
  3142. char * __fastcall TSFTPFileSystem::GetEOL() const
  3143. {
  3144. if (FVersion >= 4)
  3145. {
  3146. DebugAssert(!FEOL.IsEmpty());
  3147. return FEOL.c_str();
  3148. }
  3149. else
  3150. {
  3151. return EOLToStr(FTerminal->SessionData->EOLType);
  3152. }
  3153. }
  3154. //---------------------------------------------------------------------------
  3155. void __fastcall TSFTPFileSystem::LookupUsersGroups()
  3156. {
  3157. DebugAssert(SupportsExtension(SFTP_EXT_OWNER_GROUP));
  3158. TSFTPPacket PacketOwners(SSH_FXP_EXTENDED);
  3159. TSFTPPacket PacketGroups(SSH_FXP_EXTENDED);
  3160. TSFTPPacket * Packets[] = { &PacketOwners, &PacketGroups };
  3161. TRemoteTokenList * Lists[] = { &FTerminal->FUsers, &FTerminal->FGroups };
  3162. wchar_t ListTypes[] = { OGQ_LIST_OWNERS, OGQ_LIST_GROUPS };
  3163. for (size_t Index = 0; Index < LENOF(Packets); Index++)
  3164. {
  3165. TSFTPPacket * Packet = Packets[Index];
  3166. Packet->AddString(SFTP_EXT_OWNER_GROUP);
  3167. Packet->AddByte(ListTypes[Index]);
  3168. SendPacket(Packet);
  3169. ReserveResponse(Packet, Packet);
  3170. }
  3171. for (size_t Index = 0; Index < LENOF(Packets); Index++)
  3172. {
  3173. TSFTPPacket * Packet = Packets[Index];
  3174. ReceiveResponse(Packet, Packet, SSH_FXP_EXTENDED_REPLY, asOpUnsupported);
  3175. if ((Packet->Type != SSH_FXP_EXTENDED_REPLY) ||
  3176. (Packet->GetAnsiString() != SFTP_EXT_OWNER_GROUP_REPLY))
  3177. {
  3178. FTerminal->LogEvent(FORMAT(L"Invalid response to %s", (SFTP_EXT_OWNER_GROUP)));
  3179. }
  3180. else
  3181. {
  3182. TRemoteTokenList & List = *Lists[Index];
  3183. unsigned long Count = Packet->GetCardinal();
  3184. List.Clear();
  3185. for (unsigned long Item = 0; Item < Count; Item++)
  3186. {
  3187. TRemoteToken Token(Packet->GetString(FUtfStrings));
  3188. List.Add(Token);
  3189. if (&List == &FTerminal->FGroups)
  3190. {
  3191. FTerminal->FMembership.Add(Token);
  3192. }
  3193. }
  3194. }
  3195. }
  3196. }
  3197. //---------------------------------------------------------------------------
  3198. void __fastcall TSFTPFileSystem::ReadCurrentDirectory()
  3199. {
  3200. if (!FDirectoryToChangeTo.IsEmpty())
  3201. {
  3202. FCurrentDirectory = FDirectoryToChangeTo;
  3203. FDirectoryToChangeTo = L"";
  3204. }
  3205. else if (FCurrentDirectory.IsEmpty())
  3206. {
  3207. // this happens only after startup when default remote directory is not specified
  3208. FCurrentDirectory = GetHomeDirectory();
  3209. }
  3210. }
  3211. //---------------------------------------------------------------------------
  3212. void __fastcall TSFTPFileSystem::HomeDirectory()
  3213. {
  3214. ChangeDirectory(GetHomeDirectory());
  3215. }
  3216. //---------------------------------------------------------------------------
  3217. void __fastcall TSFTPFileSystem::TryOpenDirectory(const UnicodeString Directory)
  3218. {
  3219. FTerminal->LogEvent(FORMAT(L"Trying to open directory \"%s\".", (Directory)));
  3220. TRemoteFile * File;
  3221. CustomReadFile(Directory, File, SSH_FXP_LSTAT, NULL, asOpUnsupported);
  3222. if (File == NULL)
  3223. {
  3224. // File can be NULL only when server does not support SSH_FXP_LSTAT.
  3225. // Fallback to legacy solution, which in turn does not allow entering
  3226. // traverse-only (chmod 110) directories.
  3227. // This is workaround for https://www.ftpshell.com/
  3228. TSFTPPacket Packet(SSH_FXP_OPENDIR);
  3229. AddPathString(Packet, UnixExcludeTrailingBackslash(Directory));
  3230. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
  3231. RawByteString Handle = Packet.GetFileHandle();
  3232. Packet.ChangeType(SSH_FXP_CLOSE);
  3233. Packet.AddString(Handle);
  3234. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS, asAll);
  3235. }
  3236. else
  3237. {
  3238. delete File;
  3239. }
  3240. }
  3241. //---------------------------------------------------------------------------
  3242. void __fastcall TSFTPFileSystem::AnnounceFileListOperation()
  3243. {
  3244. }
  3245. //---------------------------------------------------------------------------
  3246. void __fastcall TSFTPFileSystem::ChangeDirectory(const UnicodeString Directory)
  3247. {
  3248. UnicodeString Path, Current;
  3249. Current = !FDirectoryToChangeTo.IsEmpty() ? FDirectoryToChangeTo : FCurrentDirectory;
  3250. Path = RealPath(Directory, Current);
  3251. // to verify existence of directory try to open it (SSH_FXP_REALPATH succeeds
  3252. // for invalid paths on some systems, like CygWin)
  3253. TryOpenDirectory(Path);
  3254. // if open dir did not fail, directory exists -> success.
  3255. FDirectoryToChangeTo = Path;
  3256. }
  3257. //---------------------------------------------------------------------------
  3258. void __fastcall TSFTPFileSystem::CachedChangeDirectory(const UnicodeString Directory)
  3259. {
  3260. FDirectoryToChangeTo = UnixExcludeTrailingBackslash(Directory);
  3261. }
  3262. //---------------------------------------------------------------------------
  3263. void __fastcall TSFTPFileSystem::ReadDirectory(TRemoteFileList * FileList)
  3264. {
  3265. DebugAssert(FileList && !FileList->Directory.IsEmpty());
  3266. UnicodeString Directory;
  3267. Directory = UnixExcludeTrailingBackslash(LocalCanonify(FileList->Directory));
  3268. FTerminal->LogEvent(FORMAT(L"Listing directory \"%s\".", (Directory)));
  3269. // moved before SSH_FXP_OPENDIR, so directory listing does not retain
  3270. // old data (e.g. parent directory) when reading fails
  3271. FileList->Reset();
  3272. TSFTPPacket Packet(SSH_FXP_OPENDIR);
  3273. RawByteString Handle;
  3274. try
  3275. {
  3276. AddPathString(Packet, Directory);
  3277. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
  3278. Handle = Packet.GetFileHandle();
  3279. }
  3280. catch(...)
  3281. {
  3282. if (FTerminal->Active)
  3283. {
  3284. FileList->AddFile(new TRemoteParentDirectory(FTerminal));
  3285. }
  3286. throw;
  3287. }
  3288. TSFTPPacket Response;
  3289. try
  3290. {
  3291. bool isEOF = false;
  3292. int Total = 0;
  3293. bool HasParentDirectory = false;
  3294. TRemoteFile * File;
  3295. Packet.ChangeType(SSH_FXP_READDIR);
  3296. Packet.AddString(Handle);
  3297. SendPacket(&Packet);
  3298. do
  3299. {
  3300. ReceiveResponse(&Packet, &Response);
  3301. if (Response.Type == SSH_FXP_NAME)
  3302. {
  3303. TSFTPPacket ListingPacket = Response;
  3304. Packet.ChangeType(SSH_FXP_READDIR);
  3305. Packet.AddString(Handle);
  3306. SendPacket(&Packet);
  3307. ReserveResponse(&Packet, &Response);
  3308. unsigned int Count = ListingPacket.GetCardinal();
  3309. int ResolvedLinks = 0;
  3310. for (unsigned long Index = 0; !isEOF && (Index < Count); Index++)
  3311. {
  3312. std::unique_ptr<TRemoteFile> AFile(LoadFile(&ListingPacket, NULL, L"", FileList));
  3313. TRemoteFile * File = AFile.get();
  3314. if (FTerminal->IsValidFile(File))
  3315. {
  3316. FileList->AddFile(AFile.release());
  3317. if (FTerminal->IsEncryptingFiles() && // optimization
  3318. IsRealFile(File->FileName))
  3319. {
  3320. UnicodeString FullFileName = UnixExcludeTrailingBackslash(File->FullFileName);
  3321. UnicodeString FileName = UnixExtractFileName(FTerminal->DecryptFileName(FullFileName, false, false));
  3322. if (File->FileName != FileName)
  3323. {
  3324. File->SetEncrypted();
  3325. }
  3326. File->FileName = FileName;
  3327. }
  3328. if (FTerminal->Configuration->ActualLogProtocol >= 1)
  3329. {
  3330. FTerminal->LogEvent(FORMAT(L"Read file '%s' from listing", (File->FileName)));
  3331. }
  3332. if (File->LinkedFile != NULL)
  3333. {
  3334. ResolvedLinks++;
  3335. }
  3336. if (File->IsParentDirectory)
  3337. {
  3338. HasParentDirectory = true;
  3339. }
  3340. Total++;
  3341. if (Total % 10 == 0)
  3342. {
  3343. FTerminal->DoReadDirectoryProgress(Total, ResolvedLinks, isEOF);
  3344. if (isEOF)
  3345. {
  3346. FTerminal->LogEvent(L"Listing directory cancelled.");
  3347. FTerminal->DoReadDirectoryProgress(-2, 0, isEOF);
  3348. }
  3349. }
  3350. }
  3351. }
  3352. if (!isEOF &&
  3353. (FVersion >= 6) &&
  3354. // As of 7.0.9 the Cerberus SFTP server always sets the end-of-list to true.
  3355. // Fixed in 7.0.10.
  3356. (FSecureShell->SshImplementation != sshiCerberus) &&
  3357. ListingPacket.CanGetBool())
  3358. {
  3359. isEOF = ListingPacket.GetBool();
  3360. }
  3361. if (Count == 0)
  3362. {
  3363. FTerminal->LogEvent(L"Empty directory listing packet. Aborting directory reading.");
  3364. isEOF = true;
  3365. }
  3366. }
  3367. else if (Response.Type == SSH_FXP_STATUS)
  3368. {
  3369. isEOF = (GotStatusPacket(&Response, asEOF, false) == SSH_FX_EOF);
  3370. }
  3371. else
  3372. {
  3373. FTerminal->FatalError(NULL, FMTLOAD(SFTP_INVALID_TYPE, ((int)Response.Type)));
  3374. }
  3375. }
  3376. while (!isEOF);
  3377. if (Total == 0)
  3378. {
  3379. bool Failure = false;
  3380. // no point reading parent of root directory,
  3381. // moreover CompleteFTP terminates session upon attempt to do so
  3382. if (IsUnixRootPath(FileList->Directory))
  3383. {
  3384. File = NULL;
  3385. }
  3386. else
  3387. {
  3388. // Empty file list -> probably "permission denied", we
  3389. // at least get link to parent directory ("..")
  3390. try
  3391. {
  3392. FTerminal->ExceptionOnFail = true;
  3393. try
  3394. {
  3395. File = FTerminal->ReadFile(UnixCombinePaths(FileList->Directory, PARENTDIRECTORY));
  3396. }
  3397. __finally
  3398. {
  3399. FTerminal->ExceptionOnFail = false;
  3400. }
  3401. }
  3402. catch(Exception &E)
  3403. {
  3404. if (E.InheritsFrom(__classid(EFatal)))
  3405. {
  3406. throw;
  3407. }
  3408. else
  3409. {
  3410. File = NULL;
  3411. Failure = true;
  3412. }
  3413. }
  3414. }
  3415. // on some systems even getting ".." fails, we create dummy ".." instead
  3416. if (File == NULL)
  3417. {
  3418. File = new TRemoteParentDirectory(FTerminal);
  3419. }
  3420. DebugAssert(File && File->IsParentDirectory);
  3421. FileList->AddFile(File);
  3422. if (Failure)
  3423. {
  3424. throw ExtException(
  3425. NULL, FMTLOAD(EMPTY_DIRECTORY, (FileList->Directory)),
  3426. HELP_EMPTY_DIRECTORY);
  3427. }
  3428. }
  3429. else
  3430. {
  3431. if (!HasParentDirectory)
  3432. {
  3433. FileList->AddFile(new TRemoteParentDirectory(FTerminal));
  3434. }
  3435. }
  3436. }
  3437. __finally
  3438. {
  3439. if (FTerminal->Active)
  3440. {
  3441. Packet.ChangeType(SSH_FXP_CLOSE);
  3442. Packet.AddString(Handle);
  3443. SendPacket(&Packet);
  3444. // we are not interested in the response, do not wait for it
  3445. ReserveResponse(&Packet, NULL);
  3446. }
  3447. }
  3448. }
  3449. //---------------------------------------------------------------------------
  3450. void __fastcall TSFTPFileSystem::ReadSymlink(TRemoteFile * SymlinkFile,
  3451. TRemoteFile *& File)
  3452. {
  3453. DebugAssert(SymlinkFile != NULL);
  3454. DebugAssert(FVersion >= 3); // symlinks are supported with SFTP version 3 and later
  3455. // need to use full filename when resolving links within subdirectory
  3456. // (i.e. for download)
  3457. UnicodeString FileName = LocalCanonify(
  3458. SymlinkFile->HaveFullFileName ? SymlinkFile->FullFileName : SymlinkFile->FileName);
  3459. TSFTPPacket ReadLinkPacket(SSH_FXP_READLINK);
  3460. AddPathString(ReadLinkPacket, FileName);
  3461. SendPacket(&ReadLinkPacket);
  3462. ReserveResponse(&ReadLinkPacket, &ReadLinkPacket);
  3463. // send second request before reading response to first one
  3464. // (performance benefit)
  3465. TSFTPPacket AttrsPacket(SSH_FXP_STAT);
  3466. AddPathString(AttrsPacket, FileName);
  3467. if (FVersion >= 4)
  3468. {
  3469. AttrsPacket.AddCardinal(SSH_FILEXFER_ATTR_COMMON);
  3470. }
  3471. SendPacket(&AttrsPacket);
  3472. ReserveResponse(&AttrsPacket, &AttrsPacket);
  3473. ReceiveResponse(&ReadLinkPacket, &ReadLinkPacket, SSH_FXP_NAME);
  3474. if (ReadLinkPacket.GetCardinal() != 1)
  3475. {
  3476. FTerminal->FatalError(NULL, LoadStr(SFTP_NON_ONE_FXP_NAME_PACKET));
  3477. }
  3478. // Not sure about the DontCache parameter here. Actually we should not get here for encrypted sessions.
  3479. DebugAssert(!FTerminal->IsEncryptingFiles());
  3480. SymlinkFile->LinkTo = FTerminal->DecryptFileName(ReadLinkPacket.GetPathString(FUtfStrings), true, true);
  3481. FTerminal->LogEvent(FORMAT(L"Link resolved to \"%s\".", (SymlinkFile->LinkTo)));
  3482. ReceiveResponse(&AttrsPacket, &AttrsPacket, SSH_FXP_ATTRS);
  3483. // SymlinkFile->FileName was used instead SymlinkFile->LinkTo before, why?
  3484. File = LoadFile(&AttrsPacket, SymlinkFile,
  3485. UnixExtractFileName(SymlinkFile->LinkTo));
  3486. }
  3487. //---------------------------------------------------------------------------
  3488. void __fastcall TSFTPFileSystem::ReadFile(const UnicodeString FileName,
  3489. TRemoteFile *& File)
  3490. {
  3491. CustomReadFile(FileName, File, SSH_FXP_LSTAT);
  3492. }
  3493. //---------------------------------------------------------------------------
  3494. bool __fastcall TSFTPFileSystem::RemoteFileExists(const UnicodeString FullPath,
  3495. TRemoteFile ** File)
  3496. {
  3497. bool Result;
  3498. try
  3499. {
  3500. TRemoteFile * AFile;
  3501. CustomReadFile(FullPath, AFile, SSH_FXP_LSTAT, NULL, asNoSuchFile);
  3502. Result = (AFile != NULL);
  3503. if (Result)
  3504. {
  3505. if (File)
  3506. {
  3507. *File = AFile;
  3508. }
  3509. else
  3510. {
  3511. delete AFile;
  3512. }
  3513. }
  3514. }
  3515. catch(...)
  3516. {
  3517. if (!FTerminal->Active)
  3518. {
  3519. throw;
  3520. }
  3521. Result = false;
  3522. }
  3523. return Result;
  3524. }
  3525. //---------------------------------------------------------------------------
  3526. void __fastcall TSFTPFileSystem::SendCustomReadFile(TSFTPPacket * Packet,
  3527. TSFTPPacket * Response, unsigned long Flags)
  3528. {
  3529. if (FVersion >= 4)
  3530. {
  3531. Packet->AddCardinal(Flags);
  3532. }
  3533. SendPacket(Packet);
  3534. ReserveResponse(Packet, Response);
  3535. }
  3536. //---------------------------------------------------------------------------
  3537. void __fastcall TSFTPFileSystem::CustomReadFile(const UnicodeString FileName,
  3538. TRemoteFile *& File, unsigned char Type, TRemoteFile * ALinkedByFile,
  3539. int AllowStatus)
  3540. {
  3541. unsigned long Flags = SSH_FILEXFER_ATTR_SIZE | SSH_FILEXFER_ATTR_PERMISSIONS |
  3542. SSH_FILEXFER_ATTR_ACCESSTIME | SSH_FILEXFER_ATTR_MODIFYTIME |
  3543. SSH_FILEXFER_ATTR_OWNERGROUP;
  3544. TSFTPPacket Packet(Type);
  3545. UnicodeString FullName = LocalCanonify(FileName);
  3546. AddPathString(Packet, FullName);
  3547. SendCustomReadFile(&Packet, &Packet, Flags);
  3548. ReceiveResponse(&Packet, &Packet, SSH_FXP_ATTRS, AllowStatus);
  3549. if (Packet.Type == SSH_FXP_ATTRS)
  3550. {
  3551. File = LoadFile(&Packet, ALinkedByFile, UnixExtractFileName(FileName));
  3552. if (FTerminal->IsFileEncrypted(FullName))
  3553. {
  3554. File->SetEncrypted();
  3555. }
  3556. }
  3557. else
  3558. {
  3559. DebugAssert(AllowStatus > 0);
  3560. File = NULL;
  3561. }
  3562. }
  3563. //---------------------------------------------------------------------------
  3564. void __fastcall TSFTPFileSystem::DoDeleteFile(const UnicodeString FileName, unsigned char Type)
  3565. {
  3566. TSFTPPacket Packet(Type);
  3567. UnicodeString RealFileName = LocalCanonify(FileName);
  3568. AddPathString(Packet, RealFileName);
  3569. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3570. }
  3571. //---------------------------------------------------------------------------
  3572. void __fastcall TSFTPFileSystem::DeleteFile(const UnicodeString FileName,
  3573. const TRemoteFile * File, int Params, TRmSessionAction & Action)
  3574. {
  3575. unsigned char Type;
  3576. if (FTerminal->DeleteContentsIfDirectory(FileName, File, Params, Action))
  3577. {
  3578. Type = SSH_FXP_RMDIR;
  3579. }
  3580. else
  3581. {
  3582. Type = SSH_FXP_REMOVE;
  3583. }
  3584. DoDeleteFile(FileName, Type);
  3585. }
  3586. //---------------------------------------------------------------------------
  3587. void __fastcall TSFTPFileSystem::RenameFile(
  3588. const UnicodeString & FileName, const TRemoteFile *, const UnicodeString & NewName, bool DebugUsedArg(Overwrite))
  3589. {
  3590. bool UsePosixRename = FTerminal->SessionData->UsePosixRename;
  3591. TSFTPPacket Packet(UsePosixRename ? SSH_FXP_EXTENDED : SSH_FXP_RENAME);
  3592. if (UsePosixRename)
  3593. {
  3594. Packet.AddString(SFTP_EXT_POSIX_RENAME);
  3595. }
  3596. UnicodeString RealName = LocalCanonify(FileName);
  3597. bool Encrypted = FTerminal->IsFileEncrypted(RealName);
  3598. AddPathString(Packet, RealName);
  3599. UnicodeString TargetName;
  3600. if (UnixExtractFilePath(NewName).IsEmpty())
  3601. {
  3602. // rename case (TTerminal::RenameFile)
  3603. TargetName = UnixExtractFilePath(RealName) + NewName;
  3604. }
  3605. else
  3606. {
  3607. TargetName = LocalCanonify(NewName);
  3608. }
  3609. AddPathString(Packet, TargetName, Encrypted);
  3610. if (!UsePosixRename && (FVersion >= 5))
  3611. {
  3612. // Use SSH_FXP_RENAME + SSH_FXF_RENAME_ATOMIC when UsePosixRename?
  3613. Packet.AddCardinal(0);
  3614. }
  3615. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3616. }
  3617. //---------------------------------------------------------------------------
  3618. void TSFTPFileSystem::DoCloseRemoteIfOpened(const RawByteString & Handle)
  3619. {
  3620. if (!Handle.IsEmpty())
  3621. {
  3622. TSFTPPacket Packet(SSH_FXP_CLOSE);
  3623. Packet.AddString(Handle);
  3624. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3625. }
  3626. }
  3627. //---------------------------------------------------------------------------
  3628. void __fastcall TSFTPFileSystem::CopyFile(
  3629. const UnicodeString & FileName, const TRemoteFile * File, const UnicodeString & NewName, bool DebugUsedArg(Overwrite))
  3630. {
  3631. UnicodeString FileNameCanonical = Canonify(FileName);
  3632. bool Encrypted = FTerminal->IsFileEncrypted(FileNameCanonical);
  3633. UnicodeString NewNameCanonical = Canonify(NewName);
  3634. if (SupportsExtension(SFTP_EXT_COPY_FILE) || (FSecureShell->SshImplementation == sshiBitvise))
  3635. {
  3636. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  3637. Packet.AddString(SFTP_EXT_COPY_FILE);
  3638. AddPathString(Packet, FileNameCanonical);
  3639. AddPathString(Packet, NewNameCanonical, Encrypted);
  3640. Packet.AddBool(false);
  3641. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3642. }
  3643. else
  3644. {
  3645. DebugAssert(SupportsExtension(SFTP_EXT_COPY_DATA));
  3646. __int64 Size = DebugAlwaysTrue(File != NULL) ? File->Size : -1;
  3647. RawByteString SourceRemoteHandle, DestRemoteHandle;
  3648. try
  3649. {
  3650. SourceRemoteHandle = SFTPOpenRemoteFile(FileNameCanonical, SSH_FXF_READ, Encrypted, Size);
  3651. // SFTP_EXT_COPY_FILE does not allow overwriting existing files
  3652. // (the specification does not mandate it, but it is implemented like that both in ProFTPD and Bitvise).
  3653. // So using SSH_FXF_EXCL for consistency.
  3654. DestRemoteHandle = SFTPOpenRemoteFile(NewNameCanonical, SSH_FXF_WRITE | SSH_FXF_CREAT | SSH_FXF_EXCL, Encrypted, Size);
  3655. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  3656. Packet.AddString(SFTP_EXT_COPY_DATA);
  3657. Packet.AddString(SourceRemoteHandle);
  3658. Packet.AddInt64(0);
  3659. Packet.AddInt64(0); // until EOF
  3660. Packet.AddString(DestRemoteHandle);
  3661. Packet.AddInt64(0);
  3662. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3663. if (DebugAlwaysTrue(File != NULL))
  3664. {
  3665. TSFTPPacket PropertiesRequest(SSH_FXP_SETSTAT);
  3666. AddPathString(PropertiesRequest, NewNameCanonical);
  3667. unsigned short Rights = File->Rights->NumberSet;
  3668. TDSTMode DSTMode = FTerminal->SessionData->DSTMode;
  3669. __int64 MTime = ConvertTimestampToUnix(DateTimeToFileTime(File->Modification, DSTMode), DSTMode);
  3670. PropertiesRequest.AddProperties(&Rights, NULL, NULL, &MTime, NULL, NULL, false, FVersion, FUtfStrings);
  3671. SendPacketAndReceiveResponse(&PropertiesRequest, &Packet, SSH_FXP_STATUS);
  3672. }
  3673. }
  3674. __finally
  3675. {
  3676. if (FTerminal->Active)
  3677. {
  3678. DoCloseRemoteIfOpened(SourceRemoteHandle);
  3679. DoCloseRemoteIfOpened(DestRemoteHandle);
  3680. }
  3681. }
  3682. }
  3683. }
  3684. //---------------------------------------------------------------------------
  3685. void __fastcall TSFTPFileSystem::CreateDirectory(const UnicodeString & DirName, bool Encrypt)
  3686. {
  3687. TSFTPPacket Packet(SSH_FXP_MKDIR);
  3688. UnicodeString CanonifiedName = Canonify(DirName);
  3689. AddPathString(Packet, CanonifiedName, Encrypt);
  3690. Packet.AddProperties(NULL, 0, true, FVersion, FUtfStrings, NULL);
  3691. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3692. }
  3693. //---------------------------------------------------------------------------
  3694. void __fastcall TSFTPFileSystem::CreateLink(const UnicodeString FileName,
  3695. const UnicodeString PointTo, bool Symbolic)
  3696. {
  3697. // Cerberus server does not even respond to LINK or SYMLINK,
  3698. // Although its log says:
  3699. // Unrecognized SFTP client command: (20)
  3700. // Unknown SFTP packet - Sending Unsupported OP response
  3701. DebugAssert(FVersion >= 3); // links are supported with SFTP version 3 and later
  3702. bool UseLink = (FVersion >= 6);
  3703. bool UseHardlink = !Symbolic && !UseLink && FSupportsHardlink;
  3704. TSFTPPacket Packet(UseHardlink ? SSH_FXP_EXTENDED : (UseLink ? SSH_FXP_LINK : SSH_FXP_SYMLINK));
  3705. if (UseHardlink)
  3706. {
  3707. Packet.AddString(SFTP_EXT_HARDLINK);
  3708. }
  3709. bool Buggy;
  3710. // OpenSSH hardlink extension always uses the "wrong" order
  3711. // as it's defined as such to mimic OpenSSH symlink bug
  3712. if (UseHardlink)
  3713. {
  3714. Buggy = true; //sic
  3715. }
  3716. else
  3717. {
  3718. if (FTerminal->SessionData->SFTPBug[sbSymlink] == asOn)
  3719. {
  3720. Buggy = true;
  3721. FTerminal->LogEvent(L"Forcing workaround for SFTP link bug");
  3722. }
  3723. else if (FTerminal->SessionData->SFTPBug[sbSymlink] == asOff)
  3724. {
  3725. Buggy = false;
  3726. }
  3727. else
  3728. {
  3729. if (UseLink)
  3730. {
  3731. if (FSecureShell->SshImplementation == sshiProFTPD)
  3732. {
  3733. // ProFTPD/mod_sftp followed OpenSSH symlink bug even for link implementation.
  3734. // This will be fixed with the next release with
  3735. // SSH version string bumped to "mod_sftp/1.0.0"
  3736. // http://bugs.proftpd.org/show_bug.cgi?id=4080
  3737. UnicodeString ProFTPDVerStr = GetSessionInfo().SshImplementation;
  3738. CutToChar(ProFTPDVerStr, L'/', false);
  3739. int ProFTPDMajorVer = StrToIntDef(CutToChar(ProFTPDVerStr, L'.', false), 0);
  3740. Buggy = (ProFTPDMajorVer == 0);
  3741. if (Buggy)
  3742. {
  3743. FTerminal->LogEvent(L"We believe the server has SFTP link bug");
  3744. }
  3745. }
  3746. else
  3747. {
  3748. Buggy = false;
  3749. }
  3750. }
  3751. else
  3752. {
  3753. // ProFTPD/mod_sftp deliberately follows OpenSSH bug.
  3754. // Though we should get here with ProFTPD only when user forced
  3755. // SFTP version < 6 or when connecting to an ancient version of ProFTPD.
  3756. Buggy =
  3757. (FSecureShell->SshImplementation == sshiOpenSSH) ||
  3758. (FSecureShell->SshImplementation == sshiProFTPD);
  3759. if (Buggy)
  3760. {
  3761. FTerminal->LogEvent(L"We believe the server has SFTP symlink bug");
  3762. }
  3763. }
  3764. }
  3765. }
  3766. UnicodeString FinalPointTo = PointTo;
  3767. UnicodeString FinalFileName = Canonify(FileName);
  3768. if (!Symbolic)
  3769. {
  3770. FinalPointTo = Canonify(PointTo);
  3771. }
  3772. // creating symlinks is not allowed when encryption is enabled, so we are not considering encryption here
  3773. if (!Buggy)
  3774. {
  3775. AddPathString(Packet, FinalFileName);
  3776. AddPathString(Packet, FinalPointTo);
  3777. }
  3778. else
  3779. {
  3780. AddPathString(Packet, FinalPointTo);
  3781. AddPathString(Packet, FinalFileName);
  3782. }
  3783. if (UseLink)
  3784. {
  3785. Packet.AddBool(Symbolic);
  3786. }
  3787. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3788. }
  3789. //---------------------------------------------------------------------------
  3790. void __fastcall TSFTPFileSystem::ChangeFileProperties(const UnicodeString FileName,
  3791. const TRemoteFile * /*File*/, const TRemoteProperties * AProperties,
  3792. TChmodSessionAction & Action)
  3793. {
  3794. DebugAssert(AProperties != NULL);
  3795. TRemoteFile * File;
  3796. UnicodeString RealFileName = LocalCanonify(FileName);
  3797. ReadFile(RealFileName, File);
  3798. try
  3799. {
  3800. DebugAssert(File);
  3801. if (File->IsDirectory && FTerminal->CanRecurseToDirectory(File) && AProperties->Recursive)
  3802. {
  3803. try
  3804. {
  3805. FTerminal->ProcessDirectory(FileName, FTerminal->ChangeFileProperties,
  3806. (void*)AProperties);
  3807. }
  3808. catch(...)
  3809. {
  3810. Action.Cancel();
  3811. throw;
  3812. }
  3813. }
  3814. // SFTP can change owner and group at the same time only, not individually.
  3815. // Fortunately we know current owner/group, so if only one is present,
  3816. // we can supplement the other.
  3817. TRemoteProperties Properties(*AProperties);
  3818. if (Properties.Valid.Contains(vpGroup) &&
  3819. !Properties.Valid.Contains(vpOwner))
  3820. {
  3821. Properties.Owner = File->Owner;
  3822. Properties.Valid << vpOwner;
  3823. }
  3824. else if (Properties.Valid.Contains(vpOwner) &&
  3825. !Properties.Valid.Contains(vpGroup))
  3826. {
  3827. Properties.Group = File->Group;
  3828. Properties.Valid << vpGroup;
  3829. }
  3830. TSFTPPacket Packet(SSH_FXP_SETSTAT);
  3831. AddPathString(Packet, RealFileName);
  3832. Packet.AddProperties(&Properties, *File->Rights, File->IsDirectory, FVersion, FUtfStrings, &Action);
  3833. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_STATUS);
  3834. }
  3835. __finally
  3836. {
  3837. delete File;
  3838. }
  3839. }
  3840. //---------------------------------------------------------------------------
  3841. bool __fastcall TSFTPFileSystem::LoadFilesProperties(TStrings * FileList)
  3842. {
  3843. bool Result = false;
  3844. // without knowledge of server's capabilities, this all make no sense
  3845. if (FSupport->Loaded || (FSecureShell->SshImplementation == sshiBitvise))
  3846. {
  3847. TFileOperationProgressType Progress(&FTerminal->DoProgress, &FTerminal->DoFinished);
  3848. FTerminal->OperationStart(Progress, foGetProperties, osRemote, FileList->Count);
  3849. static int LoadFilesPropertiesQueueLen = 5;
  3850. TSFTPLoadFilesPropertiesQueue Queue(this);
  3851. try
  3852. {
  3853. if (Queue.Init(LoadFilesPropertiesQueueLen, FileList))
  3854. {
  3855. TRemoteFile * File;
  3856. TSFTPPacket Packet;
  3857. bool Next;
  3858. do
  3859. {
  3860. Next = Queue.ReceivePacket(&Packet, File);
  3861. DebugAssert((Packet.Type == SSH_FXP_ATTRS) || (Packet.Type == SSH_FXP_STATUS));
  3862. if (Packet.Type == SSH_FXP_ATTRS)
  3863. {
  3864. DebugAssert(File != NULL);
  3865. Progress.SetFile(File->FileName);
  3866. LoadFile(File, &Packet);
  3867. Result = true;
  3868. TOnceDoneOperation OnceDoneOperation;
  3869. Progress.Finish(File->FileName, true, OnceDoneOperation);
  3870. }
  3871. if (Progress.Cancel != csContinue)
  3872. {
  3873. Next = false;
  3874. }
  3875. }
  3876. while (Next);
  3877. }
  3878. }
  3879. __finally
  3880. {
  3881. Queue.DisposeSafe();
  3882. FTerminal->OperationStop(Progress);
  3883. }
  3884. // queue is discarded here
  3885. }
  3886. return Result;
  3887. }
  3888. //---------------------------------------------------------------------------
  3889. void __fastcall TSFTPFileSystem::CalculateFilesChecksum(
  3890. const UnicodeString & Alg, TStrings * FileList, TCalculatedChecksumEvent OnCalculatedChecksum,
  3891. TFileOperationProgressType * OperationProgress, bool FirstLevel)
  3892. {
  3893. FTerminal->CalculateSubFoldersChecksum(Alg, FileList, OnCalculatedChecksum, OperationProgress, FirstLevel);
  3894. static int CalculateFilesChecksumQueueLen = 5;
  3895. TSFTPCalculateFilesChecksumQueue Queue(this);
  3896. TOnceDoneOperation OnceDoneOperation; // not used
  3897. try
  3898. {
  3899. UnicodeString SftpAlg;
  3900. int Index = FChecksumAlgs->IndexOf(Alg);
  3901. if (Index >= 0)
  3902. {
  3903. SftpAlg = FChecksumSftpAlgs->Strings[Index];
  3904. }
  3905. else
  3906. {
  3907. // try user-specified alg
  3908. SftpAlg = Alg;
  3909. }
  3910. if (Queue.Init(CalculateFilesChecksumQueueLen, SftpAlg, FileList))
  3911. {
  3912. TSFTPPacket Packet;
  3913. bool Next;
  3914. do
  3915. {
  3916. bool Success = false;
  3917. TRemoteFile * File = NULL;
  3918. try
  3919. {
  3920. TChecksumSessionAction Action(FTerminal->ActionLog);
  3921. try
  3922. {
  3923. Next = Queue.ReceivePacket(&Packet, File);
  3924. DebugAssert(Packet.Type == SSH_FXP_EXTENDED_REPLY);
  3925. OperationProgress->SetFile(File->FileName);
  3926. Action.FileName(File->FullFileName);
  3927. // skip alg
  3928. Packet.GetAnsiString();
  3929. UnicodeString Checksum = BytesToHex(reinterpret_cast<const unsigned char*>(Packet.GetNextData(Packet.RemainingLength)), Packet.RemainingLength, false);
  3930. if (OnCalculatedChecksum != NULL)
  3931. {
  3932. OnCalculatedChecksum(File->FileName, Alg, Checksum);
  3933. }
  3934. Action.Checksum(Alg, Checksum);
  3935. Success = true;
  3936. }
  3937. catch (Exception & E)
  3938. {
  3939. FTerminal->RollbackAction(Action, OperationProgress, &E);
  3940. // Error formatting expanded from inline to avoid strange exceptions
  3941. UnicodeString Error =
  3942. FMTLOAD(CHECKSUM_ERROR,
  3943. (File != NULL ? File->FullFileName : UnicodeString(L"")));
  3944. FTerminal->CommandError(&E, Error);
  3945. // TODO: retries? resume?
  3946. Next = false;
  3947. }
  3948. }
  3949. __finally
  3950. {
  3951. if (FirstLevel)
  3952. {
  3953. OperationProgress->Finish(File->FileName, Success, OnceDoneOperation);
  3954. }
  3955. }
  3956. if (OperationProgress->Cancel != csContinue)
  3957. {
  3958. Next = false;
  3959. }
  3960. }
  3961. while (Next);
  3962. }
  3963. }
  3964. __finally
  3965. {
  3966. Queue.DisposeSafe();
  3967. }
  3968. // queue is discarded here
  3969. }
  3970. //---------------------------------------------------------------------------
  3971. UnicodeString TSFTPFileSystem::CalculateFilesChecksumInitialize(const UnicodeString & Alg)
  3972. {
  3973. return FindIdent(Alg, FChecksumAlgs.get());
  3974. }
  3975. //---------------------------------------------------------------------------
  3976. void __fastcall TSFTPFileSystem::CustomCommandOnFile(const UnicodeString /*FileName*/,
  3977. const TRemoteFile * /*File*/, UnicodeString /*Command*/, int /*Params*/,
  3978. TCaptureOutputEvent /*OutputEvent*/)
  3979. {
  3980. DebugFail();
  3981. }
  3982. //---------------------------------------------------------------------------
  3983. void __fastcall TSFTPFileSystem::AnyCommand(const UnicodeString /*Command*/,
  3984. TCaptureOutputEvent /*OutputEvent*/)
  3985. {
  3986. DebugFail();
  3987. }
  3988. //---------------------------------------------------------------------------
  3989. TStrings * __fastcall TSFTPFileSystem::GetFixedPaths()
  3990. {
  3991. return FFixedPaths;
  3992. }
  3993. //---------------------------------------------------------------------------
  3994. void __fastcall TSFTPFileSystem::SpaceAvailable(const UnicodeString Path,
  3995. TSpaceAvailable & ASpaceAvailable)
  3996. {
  3997. if (SupportsExtension(SFTP_EXT_SPACE_AVAILABLE) ||
  3998. // See comment in IsCapable
  3999. (FSecureShell->SshImplementation == sshiBitvise))
  4000. {
  4001. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  4002. Packet.AddString(SFTP_EXT_SPACE_AVAILABLE);
  4003. AddPathString(Packet, LocalCanonify(Path));
  4004. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_EXTENDED_REPLY);
  4005. ASpaceAvailable.BytesOnDevice = Packet.GetInt64();
  4006. ASpaceAvailable.UnusedBytesOnDevice = Packet.GetInt64();
  4007. ASpaceAvailable.BytesAvailableToUser = Packet.GetInt64();
  4008. ASpaceAvailable.UnusedBytesAvailableToUser = Packet.GetInt64();
  4009. // bytes-per-allocation-unit was added later to the protocol
  4010. // (revision 07, while the extension was defined already in rev 06),
  4011. // be tolerant
  4012. if (Packet.CanGetCardinal())
  4013. {
  4014. ASpaceAvailable.BytesPerAllocationUnit = Packet.GetCardinal();
  4015. }
  4016. else if (Packet.CanGetSmallCardinal())
  4017. {
  4018. // See http://bugs.proftpd.org/show_bug.cgi?id=4079
  4019. FTerminal->LogEvent(L"Assuming ProFTPD/mod_sftp bug of 2-byte bytes-per-allocation-unit field");
  4020. ASpaceAvailable.BytesPerAllocationUnit = Packet.GetSmallCardinal();
  4021. }
  4022. else
  4023. {
  4024. FTerminal->LogEvent(L"Missing bytes-per-allocation-unit field");
  4025. }
  4026. }
  4027. else if (DebugAlwaysTrue(FSupportsStatVfsV2))
  4028. {
  4029. // https://github.com/openssh/openssh-portable/blob/master/PROTOCOL
  4030. TSFTPPacket Packet(SSH_FXP_EXTENDED);
  4031. Packet.AddString(SFTP_EXT_STATVFS);
  4032. AddPathString(Packet, LocalCanonify(Path));
  4033. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_EXTENDED_REPLY);
  4034. __int64 BlockSize = Packet.GetInt64(); // file system block size
  4035. __int64 FundamentalBlockSize = Packet.GetInt64(); // fundamental fs block size
  4036. __int64 Blocks = Packet.GetInt64(); // number of blocks (unit f_frsize)
  4037. __int64 FreeBlocks = Packet.GetInt64(); // free blocks in file system
  4038. __int64 AvailableBlocks = Packet.GetInt64(); // free blocks for non-root
  4039. __int64 FileINodes = Packet.GetInt64(); // total file inodes
  4040. __int64 FreeFileINodes = Packet.GetInt64(); // free file inodes
  4041. __int64 AvailableFileINodes = Packet.GetInt64(); // free file inodes for to non-root
  4042. __int64 SID = Packet.GetInt64(); // file system id
  4043. __int64 Flags = Packet.GetInt64(); // bit mask of f_flag values
  4044. __int64 NameMax = Packet.GetInt64(); // maximum filename length
  4045. FTerminal->LogEvent(FORMAT(L"Block size: %s", (IntToStr(BlockSize))));
  4046. FTerminal->LogEvent(FORMAT(L"Fundamental block size: %s", (IntToStr(FundamentalBlockSize))));
  4047. FTerminal->LogEvent(FORMAT(L"Total blocks: %s", (IntToStr(Blocks))));
  4048. FTerminal->LogEvent(FORMAT(L"Free blocks: %s", (IntToStr(FreeBlocks))));
  4049. FTerminal->LogEvent(FORMAT(L"Free blocks for non-root: %s", (IntToStr(AvailableBlocks))));
  4050. FTerminal->LogEvent(FORMAT(L"Total file inodes: %s", (IntToStr(FileINodes))));
  4051. FTerminal->LogEvent(FORMAT(L"Free file inodes: %s", (IntToStr(FreeFileINodes))));
  4052. FTerminal->LogEvent(FORMAT(L"Free file inodes for non-root: %s", (IntToStr(AvailableFileINodes))));
  4053. FTerminal->LogEvent(FORMAT(L"File system ID: %s", (BytesToHex(reinterpret_cast<const unsigned char *>(&SID), sizeof(SID)))));
  4054. UnicodeString FlagStr;
  4055. if (FLAGSET(Flags, SFTP_EXT_STATVFS_ST_RDONLY))
  4056. {
  4057. AddToList(FlagStr, L"read-only", L",");
  4058. Flags -= SFTP_EXT_STATVFS_ST_RDONLY;
  4059. }
  4060. if (FLAGSET(Flags, SFTP_EXT_STATVFS_ST_NOSUID))
  4061. {
  4062. AddToList(FlagStr, L"no-setuid", L",");
  4063. Flags -= SFTP_EXT_STATVFS_ST_NOSUID;
  4064. }
  4065. if (Flags != 0)
  4066. {
  4067. AddToList(FlagStr, UnicodeString(L"0x") + IntToHex(Flags, 2), L",");
  4068. }
  4069. if (FlagStr.IsEmpty())
  4070. {
  4071. FlagStr = L"none";
  4072. }
  4073. FTerminal->LogEvent(FORMAT(L"Flags: %s", (FlagStr)));
  4074. FTerminal->LogEvent(FORMAT(L"Max name length: %s", (IntToStr(NameMax))));
  4075. ASpaceAvailable.BytesOnDevice = BlockSize * Blocks;
  4076. ASpaceAvailable.UnusedBytesOnDevice = BlockSize * FreeBlocks;
  4077. ASpaceAvailable.BytesAvailableToUser = 0;
  4078. ASpaceAvailable.UnusedBytesAvailableToUser = BlockSize * AvailableBlocks;
  4079. ASpaceAvailable.BytesPerAllocationUnit =
  4080. (BlockSize > std::numeric_limits<unsigned long>::max()) ? 0 : static_cast<unsigned long>(BlockSize);
  4081. }
  4082. }
  4083. //---------------------------------------------------------------------------
  4084. // transfer protocol
  4085. //---------------------------------------------------------------------------
  4086. void __fastcall TSFTPFileSystem::CopyToRemote(TStrings * FilesToCopy,
  4087. const UnicodeString TargetDir, const TCopyParamType * CopyParam,
  4088. int Params, TFileOperationProgressType * OperationProgress,
  4089. TOnceDoneOperation & OnceDoneOperation)
  4090. {
  4091. TAutoFlag AvoidBusyFlag(FAvoidBusy);
  4092. FTerminal->DoCopyToRemote(FilesToCopy, TargetDir, CopyParam, Params, OperationProgress, tfPreCreateDir, OnceDoneOperation);
  4093. }
  4094. //---------------------------------------------------------------------------
  4095. void __fastcall TSFTPFileSystem::SFTPConfirmOverwrite(
  4096. const UnicodeString & SourceFullFileName, UnicodeString & TargetFileName,
  4097. const TCopyParamType * CopyParam, int Params, TFileOperationProgressType * OperationProgress,
  4098. TSFTPOverwriteMode & OverwriteMode, const TOverwriteFileParams * FileParams)
  4099. {
  4100. bool CanAppend = !FTerminal->IsEncryptingFiles() && ((FVersion < 4) || !OperationProgress->AsciiTransfer);
  4101. unsigned int Answer;
  4102. {
  4103. TSuspendFileOperationProgress Suspend(OperationProgress);
  4104. int Answers = qaYes | qaNo | qaCancel | qaYesToAll | qaNoToAll | qaAll | qaIgnore;
  4105. // possibly we can allow alternate resume at least in some cases
  4106. if (CanAppend)
  4107. {
  4108. Answers |= qaRetry;
  4109. }
  4110. TQueryButtonAlias Aliases[5];
  4111. Aliases[0].Button = qaRetry;
  4112. Aliases[0].Alias = LoadStr(APPEND_BUTTON);
  4113. Aliases[0].GroupWith = qaNo;
  4114. Aliases[0].GrouppedShiftState = TShiftState() << ssAlt;
  4115. Aliases[1] = TQueryButtonAlias::CreateAllAsYesToNewerGrouppedWithYes();
  4116. Aliases[2] = TQueryButtonAlias::CreateIgnoreAsRenameGrouppedWithNo();
  4117. Aliases[3] = TQueryButtonAlias::CreateYesToAllGrouppedWithYes();
  4118. Aliases[4] = TQueryButtonAlias::CreateNoToAllGrouppedWithNo();
  4119. TQueryParams QueryParams(qpNeverAskAgainCheck);
  4120. QueryParams.NoBatchAnswers = qaIgnore | qaRetry | qaAll;
  4121. QueryParams.Aliases = Aliases;
  4122. QueryParams.AliasesCount = LENOF(Aliases);
  4123. Answer = FTerminal->ConfirmFileOverwrite(
  4124. SourceFullFileName, TargetFileName, FileParams,
  4125. Answers, &QueryParams,
  4126. ReverseOperationSide(OperationProgress->Side),
  4127. CopyParam, Params, OperationProgress);
  4128. }
  4129. if (CanAppend &&
  4130. ((Answer == qaRetry) || (Answer == qaSkip)))
  4131. {
  4132. OperationProgress->LockUserSelections();
  4133. try
  4134. {
  4135. // duplicated in TTerminal::ConfirmFileOverwrite
  4136. bool CanAlternateResume =
  4137. (FileParams->DestSize < FileParams->SourceSize) && !OperationProgress->AsciiTransfer;
  4138. TBatchOverwrite BatchOverwrite =
  4139. FTerminal->EffectiveBatchOverwrite(SourceFullFileName, CopyParam, Params, OperationProgress, true);
  4140. // when mode is forced by batch, never query user
  4141. if (BatchOverwrite == boAppend)
  4142. {
  4143. OverwriteMode = omAppend;
  4144. }
  4145. else if (CanAlternateResume &&
  4146. ((BatchOverwrite == boResume) || (BatchOverwrite == boAlternateResume)))
  4147. {
  4148. OverwriteMode = omResume;
  4149. }
  4150. // no other option, but append
  4151. else if (!CanAlternateResume)
  4152. {
  4153. OverwriteMode = omAppend;
  4154. }
  4155. else
  4156. {
  4157. TQueryParams Params(0, HELP_APPEND_OR_RESUME);
  4158. {
  4159. TSuspendFileOperationProgress Suspend(OperationProgress);
  4160. Answer = FTerminal->QueryUser(FORMAT(LoadStr(APPEND_OR_RESUME2), (SourceFullFileName)),
  4161. NULL, qaYes | qaNo | qaNoToAll | qaCancel, &Params);
  4162. }
  4163. switch (Answer)
  4164. {
  4165. case qaYes:
  4166. OverwriteMode = omAppend;
  4167. break;
  4168. case qaNo:
  4169. OverwriteMode = omResume;
  4170. break;
  4171. case qaNoToAll:
  4172. OverwriteMode = omResume;
  4173. OperationProgress->SetBatchOverwrite(boAlternateResume);
  4174. break;
  4175. default: DebugFail(); //fallthru
  4176. case qaCancel:
  4177. OperationProgress->SetCancelAtLeast(csCancel);
  4178. Abort();
  4179. break;
  4180. }
  4181. }
  4182. }
  4183. __finally
  4184. {
  4185. OperationProgress->UnlockUserSelections();
  4186. }
  4187. }
  4188. else if (Answer == qaIgnore)
  4189. {
  4190. if (FTerminal->PromptUser(FTerminal->SessionData, pkFileName, LoadStr(RENAME_TITLE), L"",
  4191. LoadStr(RENAME_PROMPT2), true, 0, TargetFileName))
  4192. {
  4193. OverwriteMode = omOverwrite;
  4194. }
  4195. else
  4196. {
  4197. OperationProgress->SetCancelAtLeast(csCancel);
  4198. Abort();
  4199. }
  4200. }
  4201. else
  4202. {
  4203. OverwriteMode = omOverwrite;
  4204. switch (Answer)
  4205. {
  4206. case qaCancel:
  4207. OperationProgress->SetCancelAtLeast(csCancel);
  4208. Abort();
  4209. break;
  4210. case qaNo:
  4211. throw ESkipFile();
  4212. }
  4213. }
  4214. }
  4215. //---------------------------------------------------------------------------
  4216. bool TSFTPFileSystem::SFTPConfirmResume(const UnicodeString DestFileName,
  4217. bool PartialBiggerThanSource, TFileOperationProgressType * OperationProgress)
  4218. {
  4219. bool ResumeTransfer;
  4220. DebugAssert(OperationProgress);
  4221. if (PartialBiggerThanSource)
  4222. {
  4223. unsigned int Answer;
  4224. {
  4225. TSuspendFileOperationProgress Suspend(OperationProgress);
  4226. TQueryParams Params(qpAllowContinueOnError, HELP_PARTIAL_BIGGER_THAN_SOURCE);
  4227. Answer = FTerminal->QueryUser(
  4228. FMTLOAD(PARTIAL_BIGGER_THAN_SOURCE, (DestFileName)), NULL,
  4229. qaOK | qaAbort, &Params, qtWarning);
  4230. }
  4231. if (Answer == qaAbort)
  4232. {
  4233. OperationProgress->SetCancelAtLeast(csCancel);
  4234. Abort();
  4235. }
  4236. ResumeTransfer = false;
  4237. }
  4238. else if (FTerminal->Configuration->ConfirmResume)
  4239. {
  4240. unsigned int Answer;
  4241. {
  4242. TSuspendFileOperationProgress Suspend(OperationProgress);
  4243. TQueryParams Params(qpAllowContinueOnError | qpNeverAskAgainCheck,
  4244. HELP_RESUME_TRANSFER);
  4245. // "abort" replaced with "cancel" to unify with "append/resume" query
  4246. Answer = FTerminal->QueryUser(
  4247. FMTLOAD(RESUME_TRANSFER2, (DestFileName)), NULL, qaYes | qaNo | qaCancel,
  4248. &Params);
  4249. }
  4250. switch (Answer) {
  4251. case qaNeverAskAgain:
  4252. FTerminal->Configuration->ConfirmResume = false;
  4253. case qaYes:
  4254. ResumeTransfer = true;
  4255. break;
  4256. case qaNo:
  4257. ResumeTransfer = false;
  4258. break;
  4259. case qaCancel:
  4260. OperationProgress->SetCancelAtLeast(csCancel);
  4261. Abort();
  4262. break;
  4263. }
  4264. }
  4265. else
  4266. {
  4267. ResumeTransfer = true;
  4268. }
  4269. return ResumeTransfer;
  4270. }
  4271. //---------------------------------------------------------------------------
  4272. bool __fastcall TSFTPFileSystem::DoesFileLookLikeSymLink(TRemoteFile * File)
  4273. {
  4274. return
  4275. (FVersion < 4) &&
  4276. ((*File->Rights & TRights::rfAll) == TRights::rfAll) &&
  4277. (File->Size < 100);
  4278. }
  4279. //---------------------------------------------------------------------------
  4280. void __fastcall TSFTPFileSystem::Source(
  4281. TLocalFileHandle & Handle, const UnicodeString & TargetDir, UnicodeString & DestFileName,
  4282. const TCopyParamType * CopyParam, int Params,
  4283. TFileOperationProgressType * OperationProgress, unsigned int Flags,
  4284. TUploadSessionAction & Action, bool & ChildError)
  4285. {
  4286. UnicodeString DestFullName = LocalCanonify(TargetDir + DestFileName);
  4287. UnicodeString DestPartialFullName;
  4288. bool ResumeAllowed;
  4289. bool ResumeTransfer = false;
  4290. bool DestFileExists = false;
  4291. TRights DestRights;
  4292. __int64 ResumeOffset;
  4293. // should we check for interrupted transfer?
  4294. ResumeAllowed =
  4295. !OperationProgress->AsciiTransfer &&
  4296. CopyParam->AllowResume(OperationProgress->LocalSize, DestFileName) &&
  4297. IsCapable(fcRename) &&
  4298. !FTerminal->IsEncryptingFiles() &&
  4299. (CopyParam->OnTransferIn == NULL);
  4300. TOpenRemoteFileParams OpenParams;
  4301. OpenParams.OverwriteMode = omOverwrite;
  4302. TOverwriteFileParams FileParams;
  4303. FileParams.SourceSize = OperationProgress->LocalSize;
  4304. FileParams.SourceTimestamp = Handle.Modification;
  4305. if (ResumeAllowed)
  4306. {
  4307. DestPartialFullName = DestFullName + PartialExt;
  4308. if (FLAGCLEAR(Flags, tfNewDirectory))
  4309. {
  4310. FTerminal->LogEvent(L"Checking existence of file.");
  4311. TRemoteFile * File = NULL;
  4312. DestFileExists = RemoteFileExists(DestFullName, &File);
  4313. OperationProgress->Progress();
  4314. if (DestFileExists)
  4315. {
  4316. FTerminal->LogEvent(FORMAT(L"File exists: %s", (FTerminal->GetRemoteFileInfo(File))));
  4317. OpenParams.DestFileSize = File->Resolve()->Size;
  4318. FileParams.DestSize = OpenParams.DestFileSize;
  4319. FileParams.DestTimestamp = File->Modification;
  4320. DestRights = *File->Rights;
  4321. // If destination file is symlink, never do resumable transfer,
  4322. // as it would delete the symlink.
  4323. if (File->IsSymLink)
  4324. {
  4325. ResumeAllowed = false;
  4326. FTerminal->LogEvent(L"Existing file is symbolic link, not doing resumable transfer.");
  4327. }
  4328. // Also bit of heuristics to detect symlink on SFTP-3 and older
  4329. // (which does not indicate symlink in SSH_FXP_ATTRS).
  4330. // if file has all permissions and is small, then it is likely symlink.
  4331. // also it is not likely that such a small file (if it is not symlink)
  4332. // gets overwritten by large file (that would trigger resumable transfer).
  4333. else if (DoesFileLookLikeSymLink(File))
  4334. {
  4335. ResumeAllowed = false;
  4336. FTerminal->LogEvent(L"Existing file looks like a symbolic link, not doing resumable transfer.");
  4337. }
  4338. // Also never do resumable transfer for file owned by other user
  4339. // as deleting and recreating the file would change ownership.
  4340. // This won't for work for SFTP-3 (OpenSSH) as it does not provide
  4341. // owner name (only UID) and we know only logged in user name (not UID)
  4342. else if (!File->Owner.Name.IsEmpty() && !SameUserName(File->Owner.Name, FTerminal->UserName))
  4343. {
  4344. ResumeAllowed = false;
  4345. FTerminal->LogEvent(
  4346. FORMAT(L"Existing file is owned by another user [%s], not doing resumable transfer.", (File->Owner.Name)));
  4347. }
  4348. delete File;
  4349. File = NULL;
  4350. }
  4351. if (ResumeAllowed)
  4352. {
  4353. FTerminal->LogEvent(L"Checking existence of partially transferred file.");
  4354. if (RemoteFileExists(DestPartialFullName, &File))
  4355. {
  4356. ResumeOffset = File->Resolve()->Size; // Though partial file should not be symlink
  4357. delete File;
  4358. File = NULL;
  4359. bool PartialBiggerThanSource = (ResumeOffset > OperationProgress->LocalSize);
  4360. if (FLAGCLEAR(Params, cpNoConfirmation) &&
  4361. FLAGCLEAR(Params, cpResume) &&
  4362. !CopyParam->ResumeTransfer(Handle.FileName))
  4363. {
  4364. ResumeTransfer = SFTPConfirmResume(DestFileName,
  4365. PartialBiggerThanSource, OperationProgress);
  4366. }
  4367. else
  4368. {
  4369. ResumeTransfer = !PartialBiggerThanSource;
  4370. }
  4371. if (!ResumeTransfer)
  4372. {
  4373. DoDeleteFile(DestPartialFullName, SSH_FXP_REMOVE);
  4374. OperationProgress->Progress();
  4375. }
  4376. else
  4377. {
  4378. FTerminal->LogEvent(L"Resuming file transfer.");
  4379. }
  4380. }
  4381. else
  4382. {
  4383. // partial upload file does not exists, check for full file
  4384. if (DestFileExists)
  4385. {
  4386. UnicodeString PrevDestFileName = DestFileName;
  4387. SFTPConfirmOverwrite(Handle.FileName, DestFileName,
  4388. CopyParam, Params, OperationProgress, OpenParams.OverwriteMode, &FileParams);
  4389. if (PrevDestFileName != DestFileName)
  4390. {
  4391. // update paths in case user changes the file name
  4392. DestFullName = LocalCanonify(TargetDir + DestFileName);
  4393. DestPartialFullName = DestFullName + PartialExt;
  4394. FTerminal->LogEvent(L"Checking existence of new file.");
  4395. DestFileExists = RemoteFileExists(DestFullName, NULL);
  4396. }
  4397. }
  4398. }
  4399. }
  4400. }
  4401. }
  4402. // will the transfer be resumable?
  4403. bool IntendedResume = (ResumeAllowed && (OpenParams.OverwriteMode == omOverwrite));
  4404. bool DoResume = IntendedResume;
  4405. UnicodeString RemoteFileName = DoResume ? DestPartialFullName : DestFullName;
  4406. OpenParams.FileName = Handle.FileName;
  4407. OpenParams.RemoteFileName = RemoteFileName;
  4408. OpenParams.RemoteFullFileName = DestFullName;
  4409. OpenParams.Resume = DoResume;
  4410. OpenParams.Resuming = ResumeTransfer;
  4411. OpenParams.OperationProgress = OperationProgress;
  4412. OpenParams.CopyParam = CopyParam;
  4413. OpenParams.Params = Params;
  4414. OpenParams.FileParams = &FileParams;
  4415. OpenParams.Confirmed = (CopyParam->OnTransferIn != NULL) && FLAGCLEAR(Params, cpAppend);
  4416. OpenParams.DontRecycle = false;
  4417. OpenParams.Recycled = false;
  4418. FTerminal->LogEvent(0, L"Opening remote file.");
  4419. FTerminal->FileOperationLoop(SFTPOpenRemote, OperationProgress, folAllowSkip,
  4420. FMTLOAD(SFTP_CREATE_FILE_ERROR, (OpenParams.RemoteFileName)),
  4421. &OpenParams);
  4422. OperationProgress->Progress();
  4423. DoResume = OpenParams.Resume;
  4424. if (OpenParams.RemoteFileName != RemoteFileName)
  4425. {
  4426. DebugAssert(!DoResume);
  4427. DebugAssert(UnixExtractFilePath(OpenParams.RemoteFileName) == UnixExtractFilePath(RemoteFileName));
  4428. DestFullName = OpenParams.RemoteFileName;
  4429. UnicodeString NewFileName = UnixExtractFileName(DestFullName);
  4430. // We can get here either when user change target name or
  4431. // when we intended to transfer via temporary file but we fails to create it in the end
  4432. DebugAssert((DestFileName != NewFileName) || (IntendedResume && !DoResume));
  4433. DestFileName = NewFileName;
  4434. }
  4435. Action.Destination(DestFullName);
  4436. bool TransferFinished = false;
  4437. __int64 DestWriteOffset = 0;
  4438. TSFTPPacket CloseRequest;
  4439. bool PreserveRights = CopyParam->PreserveRights && (CopyParam->OnTransferIn == NULL);
  4440. bool PreserveExistingRights = (DoResume && DestFileExists) || OpenParams.Recycled;
  4441. bool SetRights = (PreserveExistingRights || PreserveRights);
  4442. bool PreserveTime = CopyParam->PreserveTime && (CopyParam->OnTransferIn == NULL);
  4443. bool SetProperties = (PreserveTime || SetRights);
  4444. TSFTPPacket PropertiesRequest(SSH_FXP_SETSTAT);
  4445. TSFTPPacket PropertiesResponse;
  4446. TRights Rights;
  4447. if (SetProperties)
  4448. {
  4449. AddPathString(PropertiesRequest, DestFullName);
  4450. if (PreserveRights)
  4451. {
  4452. Rights = CopyParam->RemoteFileRights(Handle.Attrs);
  4453. }
  4454. else if (PreserveExistingRights)
  4455. {
  4456. if (DestFileExists)
  4457. {
  4458. Rights = DestRights;
  4459. }
  4460. else
  4461. {
  4462. Rights = OpenParams.RecycledRights;
  4463. }
  4464. }
  4465. else
  4466. {
  4467. DebugAssert(!SetRights);
  4468. }
  4469. unsigned short RightsNumber = Rights.NumberSet;
  4470. PropertiesRequest.AddProperties(
  4471. SetRights ? &RightsNumber : NULL, NULL, NULL,
  4472. PreserveTime ? &Handle.MTime : NULL,
  4473. NULL, NULL, false, FVersion, FUtfStrings);
  4474. }
  4475. try
  4476. {
  4477. if (OpenParams.OverwriteMode == omAppend)
  4478. {
  4479. FTerminal->LogEvent(L"Appending file.");
  4480. DestWriteOffset = OpenParams.DestFileSize;
  4481. }
  4482. else if (ResumeTransfer || (OpenParams.OverwriteMode == omResume))
  4483. {
  4484. if (OpenParams.OverwriteMode == omResume)
  4485. {
  4486. FTerminal->LogEvent(L"Resuming file transfer (append style).");
  4487. ResumeOffset = OpenParams.DestFileSize;
  4488. }
  4489. FileSeek((THandle)Handle.Handle, ResumeOffset, soBeginning);
  4490. OperationProgress->AddResumed(ResumeOffset);
  4491. }
  4492. TEncryption Encryption(FTerminal->GetEncryptKey());
  4493. bool Encrypt = FTerminal->IsFileEncrypted(DestFullName, CopyParam->EncryptNewFiles);
  4494. TValueRestorer<TSecureShellMode> SecureShellModeRestorer(FSecureShell->Mode, ssmUploading);
  4495. TSFTPUploadQueue Queue(this, (Encrypt ? &Encryption : NULL), FTerminal->SessionData->SFTPUploadQueue);
  4496. try
  4497. {
  4498. int ConvertParams =
  4499. FLAGMASK(CopyParam->RemoveCtrlZ, cpRemoveCtrlZ) |
  4500. FLAGMASK(CopyParam->RemoveBOM, cpRemoveBOM);
  4501. Queue.Init(Handle.FileName, Handle.Handle, CopyParam->OnTransferIn, OperationProgress,
  4502. OpenParams.RemoteFileHandle,
  4503. DestWriteOffset + OperationProgress->TransferredSize,
  4504. ConvertParams);
  4505. while (Queue.Continue())
  4506. {
  4507. if (OperationProgress->Cancel)
  4508. {
  4509. if (OperationProgress->ClearCancelFile())
  4510. {
  4511. throw ESkipFile();
  4512. }
  4513. else
  4514. {
  4515. Abort();
  4516. }
  4517. }
  4518. }
  4519. // send close request before waiting for pending read responses
  4520. SFTPCloseRemote(OpenParams.RemoteFileHandle, DestFileName,
  4521. OperationProgress, false, true, &CloseRequest);
  4522. OpenParams.RemoteFileHandle = L"";
  4523. // when resuming is disabled, we can send "set properties"
  4524. // request before waiting for pending read/close responses
  4525. if (SetProperties && !DoResume)
  4526. {
  4527. SendPacket(&PropertiesRequest);
  4528. ReserveResponse(&PropertiesRequest, &PropertiesResponse);
  4529. }
  4530. // No error so far, processes pending responses and throw on first error
  4531. Queue.DisposeSafeWithErrorHandling();
  4532. }
  4533. __finally
  4534. {
  4535. // Either queue is empty now (noop call then),
  4536. // or some error occurred (in that case, process remaining responses, ignoring other errors)
  4537. Queue.DisposeSafe();
  4538. }
  4539. TransferFinished = true;
  4540. // queue is discarded here
  4541. }
  4542. __finally
  4543. {
  4544. if (FTerminal->Active)
  4545. {
  4546. // if file transfer was finished, the close request was already sent
  4547. if (!OpenParams.RemoteFileHandle.IsEmpty())
  4548. {
  4549. SFTPCloseRemote(OpenParams.RemoteFileHandle, DestFileName,
  4550. OperationProgress, TransferFinished, true, &CloseRequest);
  4551. }
  4552. // wait for the response
  4553. SFTPCloseRemote(OpenParams.RemoteFileHandle, DestFileName,
  4554. OperationProgress, TransferFinished, false, &CloseRequest);
  4555. // delete file if transfer was not completed, resuming was not allowed and
  4556. // we were not appending (incl. alternate resume),
  4557. // shortly after plain transfer completes (eq. !ResumeAllowed)
  4558. if (!TransferFinished && !DoResume && (OpenParams.OverwriteMode == omOverwrite))
  4559. {
  4560. DoDeleteFile(OpenParams.RemoteFileName, SSH_FXP_REMOVE);
  4561. }
  4562. }
  4563. }
  4564. OperationProgress->Progress();
  4565. if (DoResume)
  4566. {
  4567. if (DestFileExists)
  4568. {
  4569. FILE_OPERATION_LOOP_BEGIN
  4570. {
  4571. if (FTerminal->SessionData->OverwrittenToRecycleBin &&
  4572. !FTerminal->SessionData->RecycleBinPath.IsEmpty())
  4573. {
  4574. FTerminal->RecycleFile(DestFullName, NULL);
  4575. }
  4576. else
  4577. {
  4578. DoDeleteFile(DestFullName, SSH_FXP_REMOVE);
  4579. }
  4580. }
  4581. FILE_OPERATION_LOOP_END(
  4582. FMTLOAD(DELETE_ON_RESUME_ERROR,
  4583. (UnixExtractFileName(DestFullName), DestFullName)));
  4584. }
  4585. // originally this was before CLOSE (last __finally statement),
  4586. // on VShell it failed
  4587. FILE_OPERATION_LOOP_BEGIN
  4588. {
  4589. RenameFile(OpenParams.RemoteFileName, NULL, DestFileName, false);
  4590. }
  4591. FILE_OPERATION_LOOP_END_CUSTOM(
  4592. FMTLOAD(RENAME_AFTER_RESUME_ERROR,
  4593. (UnixExtractFileName(OpenParams.RemoteFileName), DestFileName)),
  4594. folAllowSkip, HELP_RENAME_AFTER_RESUME_ERROR);
  4595. }
  4596. if (SetProperties)
  4597. {
  4598. std::unique_ptr<TTouchSessionAction> TouchAction;
  4599. if (PreserveTime)
  4600. {
  4601. TDateTime MDateTime = UnixToDateTime(Handle.MTime, FTerminal->SessionData->DSTMode);
  4602. FTerminal->LogEvent(FORMAT(L"Preserving timestamp [%s]",
  4603. (StandardTimestamp(MDateTime))));
  4604. TouchAction.reset(new TTouchSessionAction(FTerminal->ActionLog, DestFullName,
  4605. MDateTime));
  4606. }
  4607. std::unique_ptr<TChmodSessionAction> ChmodAction;
  4608. // do record chmod only if it was explicitly requested,
  4609. // not when it was implicitly performed to apply timestamp
  4610. // of overwritten file to new file
  4611. if (PreserveRights)
  4612. {
  4613. ChmodAction.reset(new TChmodSessionAction(FTerminal->ActionLog, DestFullName, Rights));
  4614. }
  4615. try
  4616. {
  4617. // when resuming is enabled, the set properties request was not sent yet
  4618. if (DoResume)
  4619. {
  4620. SendPacket(&PropertiesRequest);
  4621. }
  4622. bool Resend = false;
  4623. FILE_OPERATION_LOOP_BEGIN
  4624. {
  4625. try
  4626. {
  4627. TSFTPPacket DummyResponse;
  4628. TSFTPPacket * Response = &PropertiesResponse;
  4629. if (Resend)
  4630. {
  4631. PropertiesRequest.Reuse();
  4632. SendPacket(&PropertiesRequest);
  4633. // ReceiveResponse currently cannot receive twice into same packet,
  4634. // so DummyResponse is temporary workaround
  4635. Response = &DummyResponse;
  4636. }
  4637. Resend = true;
  4638. ReceiveResponse(&PropertiesRequest, Response, SSH_FXP_STATUS,
  4639. asOK | FLAGMASK(CopyParam->IgnorePermErrors, asPermDenied));
  4640. }
  4641. catch (...)
  4642. {
  4643. if (FTerminal->Active &&
  4644. (!PreserveRights && !PreserveTime))
  4645. {
  4646. DebugAssert(DoResume);
  4647. FTerminal->LogEvent(L"Ignoring error preserving permissions of overwritten file");
  4648. }
  4649. else
  4650. {
  4651. throw;
  4652. }
  4653. }
  4654. }
  4655. FILE_OPERATION_LOOP_END_CUSTOM(
  4656. FMTLOAD(PRESERVE_TIME_PERM_ERROR3, (DestFileName)),
  4657. folAllowSkip, HELP_PRESERVE_TIME_PERM_ERROR);
  4658. }
  4659. catch(Exception & E)
  4660. {
  4661. if (TouchAction.get() != NULL)
  4662. {
  4663. TouchAction->Rollback(&E);
  4664. }
  4665. if (ChmodAction.get() != NULL)
  4666. {
  4667. ChmodAction->Rollback(&E);
  4668. }
  4669. ChildError = true;
  4670. throw;
  4671. }
  4672. }
  4673. }
  4674. //---------------------------------------------------------------------------
  4675. RawByteString __fastcall TSFTPFileSystem::SFTPOpenRemoteFile(
  4676. const UnicodeString & FileName, unsigned int OpenType, bool EncryptNewFiles, __int64 Size)
  4677. {
  4678. TSFTPPacket Packet(SSH_FXP_OPEN);
  4679. AddPathString(Packet, FileName, EncryptNewFiles);
  4680. if (FVersion < 5)
  4681. {
  4682. Packet.AddCardinal(OpenType);
  4683. }
  4684. else
  4685. {
  4686. unsigned long Access =
  4687. FLAGMASK(FLAGSET(OpenType, SSH_FXF_READ), ACE4_READ_DATA) |
  4688. FLAGMASK(FLAGSET(OpenType, SSH_FXF_WRITE), ACE4_WRITE_DATA | ACE4_APPEND_DATA);
  4689. unsigned long Flags;
  4690. if (FLAGSET(OpenType, SSH_FXF_CREAT | SSH_FXF_EXCL))
  4691. {
  4692. Flags = SSH_FXF_CREATE_NEW;
  4693. }
  4694. else if (FLAGSET(OpenType, SSH_FXF_CREAT | SSH_FXF_TRUNC))
  4695. {
  4696. Flags = SSH_FXF_CREATE_TRUNCATE;
  4697. }
  4698. else if (FLAGSET(OpenType, SSH_FXF_CREAT))
  4699. {
  4700. Flags = SSH_FXF_OPEN_OR_CREATE;
  4701. }
  4702. else
  4703. {
  4704. Flags = SSH_FXF_OPEN_EXISTING;
  4705. }
  4706. Flags |=
  4707. FLAGMASK(FLAGSET(OpenType, SSH_FXF_APPEND), SSH_FXF_ACCESS_APPEND_DATA) |
  4708. FLAGMASK(FLAGSET(OpenType, SSH_FXF_TEXT), SSH_FXF_ACCESS_TEXT_MODE);
  4709. Packet.AddCardinal(Access);
  4710. Packet.AddCardinal(Flags);
  4711. }
  4712. bool SendSize =
  4713. (Size >= 0) &&
  4714. FLAGSET(OpenType, SSH_FXF_CREAT | SSH_FXF_TRUNC) &&
  4715. // Particularly VanDyke VShell (4.0.3) does not support SSH_FILEXFER_ATTR_ALLOCATION_SIZE
  4716. // (it fails open request when the attribute is included).
  4717. // It's SFTP-6 attribute, so support structure should be available.
  4718. // It's actually not with VShell. But VShell supports the SSH_FILEXFER_ATTR_ALLOCATION_SIZE.
  4719. // All servers should support SSH_FILEXFER_ATTR_SIZE (SFTP < 6)
  4720. (!FSupport->Loaded || FLAGSET(FSupport->AttributeMask, Packet.AllocationSizeAttribute(FVersion)));
  4721. Packet.AddProperties(NULL, NULL, NULL, NULL, NULL,
  4722. SendSize ? &Size : NULL, false, FVersion, FUtfStrings);
  4723. SendPacketAndReceiveResponse(&Packet, &Packet, SSH_FXP_HANDLE);
  4724. return Packet.GetFileHandle();
  4725. }
  4726. //---------------------------------------------------------------------------
  4727. int __fastcall TSFTPFileSystem::SFTPOpenRemote(void * AOpenParams, void * /*Param2*/)
  4728. {
  4729. TOpenRemoteFileParams * OpenParams = (TOpenRemoteFileParams *)AOpenParams;
  4730. DebugAssert(OpenParams);
  4731. TFileOperationProgressType * OperationProgress = OpenParams->OperationProgress;
  4732. int OpenType;
  4733. bool Success = false;
  4734. bool ConfirmOverwriting;
  4735. do
  4736. {
  4737. try
  4738. {
  4739. ConfirmOverwriting =
  4740. !OpenParams->Confirmed && !OpenParams->Resume &&
  4741. FTerminal->CheckRemoteFile(OpenParams->FileName, OpenParams->CopyParam, OpenParams->Params, OperationProgress);
  4742. OpenType = SSH_FXF_WRITE | SSH_FXF_CREAT;
  4743. // when we want to preserve overwritten files, we need to find out that
  4744. // they exist first... even if overwrite confirmation is disabled.
  4745. // but not when we already know we are not going to overwrite (but e.g. to append)
  4746. if ((ConfirmOverwriting || (FTerminal->SessionData->OverwrittenToRecycleBin && !OpenParams->DontRecycle)) &&
  4747. (OpenParams->OverwriteMode == omOverwrite))
  4748. {
  4749. OpenType |= SSH_FXF_EXCL;
  4750. }
  4751. if (!OpenParams->Resuming && (OpenParams->OverwriteMode == omOverwrite))
  4752. {
  4753. OpenType |= SSH_FXF_TRUNC;
  4754. }
  4755. if ((FVersion >= 4) && OpenParams->OperationProgress->AsciiTransfer)
  4756. {
  4757. OpenType |= SSH_FXF_TEXT;
  4758. }
  4759. OpenParams->RemoteFileHandle =
  4760. SFTPOpenRemoteFile(OpenParams->RemoteFileName, OpenType, OpenParams->CopyParam->EncryptNewFiles, OperationProgress->LocalSize);
  4761. Success = true;
  4762. }
  4763. catch(Exception & E)
  4764. {
  4765. if (OpenParams->Resume && !OpenParams->Resuming &&
  4766. (OpenParams->RemoteFileName != OpenParams->RemoteFullFileName) &&
  4767. (OpenParams->CopyParam->ResumeSupport == rsSmart) && FTerminal->Active)
  4768. {
  4769. FTerminal->LogEvent(FORMAT(L"Cannot create new partial file \"%s\", trying to create target file \"%s\"", (OpenParams->RemoteFileName, OpenParams->RemoteFullFileName)));
  4770. OpenParams->RemoteFileName = OpenParams->RemoteFullFileName;
  4771. OpenParams->Resume = false;
  4772. }
  4773. else if (!OpenParams->Confirmed && (OpenType & SSH_FXF_EXCL) && FTerminal->Active)
  4774. {
  4775. FTerminal->LogEvent(FORMAT(L"Cannot create new file \"%s\", checking if it exists already", (OpenParams->RemoteFileName)));
  4776. bool ThrowOriginal = false;
  4777. std::unique_ptr<TRemoteFile> File;
  4778. // When exclusive opening of file fails, try to detect if file exists.
  4779. // When file does not exist, failure was probably caused by 'permission denied'
  4780. // or similar error. In this case throw original exception.
  4781. try
  4782. {
  4783. OperationProgress->Progress();
  4784. TRemoteFile * AFile;
  4785. UnicodeString RealFileName = LocalCanonify(OpenParams->RemoteFileName);
  4786. ReadFile(RealFileName, AFile);
  4787. File.reset(AFile);
  4788. File->FullFileName = RealFileName;
  4789. OpenParams->DestFileSize = File->Size; // Resolve symlinks?
  4790. if (OpenParams->FileParams != NULL)
  4791. {
  4792. OpenParams->FileParams->DestTimestamp = File->Modification;
  4793. OpenParams->FileParams->DestSize = OpenParams->DestFileSize;
  4794. }
  4795. }
  4796. catch(...)
  4797. {
  4798. if (!FTerminal->Active)
  4799. {
  4800. throw;
  4801. }
  4802. else
  4803. {
  4804. ThrowOriginal = true;
  4805. }
  4806. }
  4807. if (ThrowOriginal)
  4808. {
  4809. throw;
  4810. }
  4811. // we may get here even if confirmation is disabled,
  4812. // when we have preserving of overwritten files enabled
  4813. if (ConfirmOverwriting)
  4814. {
  4815. OperationProgress->Progress();
  4816. // confirmation duplicated in SFTPSource for resumable file transfers.
  4817. UnicodeString RemoteFileNameOnly = UnixExtractFileName(OpenParams->RemoteFileName);
  4818. SFTPConfirmOverwrite(OpenParams->FileName, RemoteFileNameOnly,
  4819. OpenParams->CopyParam, OpenParams->Params, OperationProgress, OpenParams->OverwriteMode, OpenParams->FileParams);
  4820. if (RemoteFileNameOnly != UnixExtractFileName(OpenParams->RemoteFileName))
  4821. {
  4822. OpenParams->RemoteFileName =
  4823. UnixExtractFilePath(OpenParams->RemoteFileName) + RemoteFileNameOnly;
  4824. // no longer points to a relevant file
  4825. File.reset(NULL);
  4826. }
  4827. OpenParams->Confirmed = true;
  4828. }
  4829. else
  4830. {
  4831. DebugAssert(FTerminal->SessionData->OverwrittenToRecycleBin);
  4832. }
  4833. if ((OpenParams->OverwriteMode == omOverwrite) &&
  4834. FTerminal->SessionData->OverwrittenToRecycleBin &&
  4835. !FTerminal->SessionData->RecycleBinPath.IsEmpty())
  4836. {
  4837. bool IsSymLink = (File.get() != NULL) && File->IsSymLink;
  4838. if (!IsSymLink && (File.get() != NULL) && DoesFileLookLikeSymLink(File.get()) && IsCapable(fcResolveSymlink))
  4839. {
  4840. FTerminal->LogEvent(L"Existing file looks like a symbolic link, checking if it really is.");
  4841. try
  4842. {
  4843. OperationProgress->Progress();
  4844. TRemoteFile * LinkedFile;
  4845. ReadSymlink(File.get(), LinkedFile);
  4846. delete LinkedFile;
  4847. IsSymLink = true;
  4848. }
  4849. catch (...)
  4850. {
  4851. if (!FTerminal->Active)
  4852. {
  4853. throw;
  4854. }
  4855. }
  4856. }
  4857. if (IsSymLink)
  4858. {
  4859. FTerminal->LogEvent(L"Existing file is a symbolic link, it will not be moved to a recycle bin.");
  4860. OpenParams->DontRecycle = true;
  4861. }
  4862. else
  4863. {
  4864. OperationProgress->Progress();
  4865. if (!FTerminal->RecycleFile(OpenParams->RemoteFileName, NULL))
  4866. {
  4867. // Allow normal overwrite
  4868. OpenParams->DontRecycle = true;
  4869. }
  4870. else
  4871. {
  4872. OpenParams->Recycled = true;
  4873. OpenParams->RecycledRights = *File->Rights;
  4874. }
  4875. }
  4876. }
  4877. }
  4878. else if (FTerminal->Active)
  4879. {
  4880. // if file overwriting was confirmed, it means that the file already exists,
  4881. // if not, check now
  4882. if (!OpenParams->Confirmed)
  4883. {
  4884. bool ThrowOriginal = false;
  4885. // When file does not exist, failure was probably caused by 'permission denied'
  4886. // or similar error. In this case throw original exception.
  4887. try
  4888. {
  4889. TRemoteFile * File;
  4890. UnicodeString RealFileName = LocalCanonify(OpenParams->RemoteFileName);
  4891. ReadFile(RealFileName, File);
  4892. SAFE_DESTROY(File);
  4893. }
  4894. catch(...)
  4895. {
  4896. if (!FTerminal->Active)
  4897. {
  4898. throw;
  4899. }
  4900. else
  4901. {
  4902. ThrowOriginal = true;
  4903. }
  4904. }
  4905. if (ThrowOriginal)
  4906. {
  4907. throw;
  4908. }
  4909. }
  4910. // now we know that the file exists
  4911. if (FTerminal->FileOperationLoopQuery(E, OperationProgress,
  4912. FMTLOAD(SFTP_OVERWRITE_FILE_ERROR2, (OpenParams->RemoteFileName)),
  4913. folAllowSkip, LoadStr(SFTP_OVERWRITE_DELETE_BUTTON)))
  4914. {
  4915. OperationProgress->Progress();
  4916. int Params = dfNoRecursive;
  4917. FTerminal->DeleteFile(OpenParams->RemoteFileName, NULL, &Params);
  4918. }
  4919. }
  4920. else
  4921. {
  4922. throw;
  4923. }
  4924. }
  4925. }
  4926. while (!Success);
  4927. return 0;
  4928. }
  4929. //---------------------------------------------------------------------------
  4930. void __fastcall TSFTPFileSystem::SFTPCloseRemote(const RawByteString Handle,
  4931. const UnicodeString FileName, TFileOperationProgressType * OperationProgress,
  4932. bool TransferFinished, bool Request, TSFTPPacket * Packet)
  4933. {
  4934. // Moving this out of SFTPSource() fixed external exception 0xC0000029 error
  4935. FILE_OPERATION_LOOP_BEGIN
  4936. {
  4937. try
  4938. {
  4939. TSFTPPacket CloseRequest;
  4940. TSFTPPacket * P = (Packet == NULL ? &CloseRequest : Packet);
  4941. if (Request)
  4942. {
  4943. P->ChangeType(SSH_FXP_CLOSE);
  4944. P->AddString(Handle);
  4945. SendPacket(P);
  4946. ReserveResponse(P, Packet);
  4947. }
  4948. else
  4949. {
  4950. DebugAssert(Packet != NULL);
  4951. ReceiveResponse(P, Packet, SSH_FXP_STATUS);
  4952. }
  4953. }
  4954. catch(...)
  4955. {
  4956. if (!FTerminal->Active || TransferFinished)
  4957. {
  4958. throw;
  4959. }
  4960. }
  4961. }
  4962. FILE_OPERATION_LOOP_END(FMTLOAD(SFTP_CLOSE_FILE_ERROR, (FileName)));
  4963. }
  4964. //---------------------------------------------------------------------------
  4965. void __fastcall TSFTPFileSystem::CopyToLocal(TStrings * FilesToCopy,
  4966. const UnicodeString TargetDir, const TCopyParamType * CopyParam,
  4967. int Params, TFileOperationProgressType * OperationProgress,
  4968. TOnceDoneOperation & OnceDoneOperation)
  4969. {
  4970. TAutoFlag AvoidBusyFlag(FAvoidBusy);
  4971. FTerminal->DoCopyToLocal(FilesToCopy, TargetDir, CopyParam, Params, OperationProgress, tfNone, OnceDoneOperation);
  4972. }
  4973. //---------------------------------------------------------------------------
  4974. void __fastcall TSFTPFileSystem::DirectorySunk(
  4975. const UnicodeString & DestFullName, const TRemoteFile * File, const TCopyParamType * CopyParam)
  4976. {
  4977. if (CopyParam->PreserveTime && CopyParam->PreserveTimeDirs)
  4978. {
  4979. // FILE_FLAG_BACKUP_SEMANTICS is needed to "open" directory
  4980. HANDLE LocalHandle =
  4981. CreateFile(
  4982. ApiPath(DestFullName).c_str(), GENERIC_WRITE, FILE_SHARE_WRITE, NULL, OPEN_EXISTING,
  4983. FILE_FLAG_BACKUP_SEMANTICS, 0);
  4984. if (LocalHandle == INVALID_HANDLE_VALUE)
  4985. {
  4986. int SetFileTimeError = GetLastError();
  4987. FTerminal->LogEvent(
  4988. FORMAT(L"Preserving directory timestamp failed, ignoring: %s", (SysErrorMessageForError(SetFileTimeError))));
  4989. }
  4990. else
  4991. {
  4992. FTerminal->UpdateTargetTime(
  4993. LocalHandle, File->Modification, File->ModificationFmt, FTerminal->SessionData->DSTMode);
  4994. CloseHandle(LocalHandle);
  4995. }
  4996. }
  4997. }
  4998. //---------------------------------------------------------------------------
  4999. void __fastcall TSFTPFileSystem::WriteLocalFile(
  5000. const TCopyParamType * CopyParam, TStream * FileStream, TFileBuffer & BlockBuf, const UnicodeString & LocalFileName,
  5001. TFileOperationProgressType * OperationProgress)
  5002. {
  5003. if (CopyParam->OnTransferOut != NULL)
  5004. {
  5005. BlockBuf.WriteToOut(CopyParam->OnTransferOut, FTerminal, BlockBuf.Size);
  5006. }
  5007. else
  5008. {
  5009. FILE_OPERATION_LOOP_BEGIN
  5010. {
  5011. BlockBuf.WriteToStream(FileStream, BlockBuf.Size);
  5012. }
  5013. FILE_OPERATION_LOOP_END(FMTLOAD(WRITE_ERROR, (LocalFileName)));
  5014. }
  5015. OperationProgress->AddLocallyUsed(BlockBuf.Size);
  5016. }
  5017. //---------------------------------------------------------------------------
  5018. void __fastcall TSFTPFileSystem::Sink(
  5019. const UnicodeString & FileName, const TRemoteFile * File,
  5020. const UnicodeString & TargetDir, UnicodeString & DestFileName, int Attrs,
  5021. const TCopyParamType * CopyParam, int Params, TFileOperationProgressType * OperationProgress,
  5022. unsigned int /*Flags*/, TDownloadSessionAction & Action)
  5023. {
  5024. // resume has no sense for temporary downloads
  5025. bool ResumeAllowed =
  5026. FLAGCLEAR(Params, cpTemporary) &&
  5027. !OperationProgress->AsciiTransfer &&
  5028. CopyParam->AllowResume(OperationProgress->TransferSize, DestFileName) &&
  5029. !FTerminal->IsEncryptingFiles() &&
  5030. (CopyParam->OnTransferOut == NULL) &&
  5031. (CopyParam->PartOffset < 0);
  5032. HANDLE LocalHandle = NULL;
  5033. TStream * FileStream = NULL;
  5034. bool DeleteLocalFile = false;
  5035. RawByteString RemoteHandle;
  5036. UnicodeString DestFullName = TargetDir + DestFileName;
  5037. UnicodeString LocalFileName = DestFullName;
  5038. TSFTPOverwriteMode OverwriteMode = omOverwrite;
  5039. try
  5040. {
  5041. bool ResumeTransfer = false;
  5042. UnicodeString DestPartialFullName;
  5043. if (ResumeAllowed)
  5044. {
  5045. DestPartialFullName = DestFullName + PartialExt;
  5046. LocalFileName = DestPartialFullName;
  5047. FTerminal->LogEvent(L"Checking existence of partially transferred file.");
  5048. if (FileExists(ApiPath(DestPartialFullName)))
  5049. {
  5050. FTerminal->LogEvent(L"Partially transferred file exists.");
  5051. __int64 ResumeOffset;
  5052. FTerminal->OpenLocalFile(DestPartialFullName, GENERIC_WRITE,
  5053. NULL, &LocalHandle, NULL, NULL, NULL, &ResumeOffset);
  5054. bool PartialBiggerThanSource = (ResumeOffset > OperationProgress->TransferSize);
  5055. if (FLAGCLEAR(Params, cpNoConfirmation))
  5056. {
  5057. ResumeTransfer = SFTPConfirmResume(DestFileName, PartialBiggerThanSource, OperationProgress);
  5058. }
  5059. else
  5060. {
  5061. ResumeTransfer = !PartialBiggerThanSource;
  5062. if (!ResumeTransfer)
  5063. {
  5064. FTerminal->LogEvent(L"Partially transferred file is bigger than original file.");
  5065. }
  5066. }
  5067. if (!ResumeTransfer)
  5068. {
  5069. CloseHandle(LocalHandle);
  5070. LocalHandle = NULL;
  5071. FTerminal->DoDeleteLocalFile(DestPartialFullName);
  5072. }
  5073. else
  5074. {
  5075. FTerminal->LogEvent(L"Resuming file transfer.");
  5076. FileSeek((THandle)LocalHandle, ResumeOffset, soBeginning);
  5077. OperationProgress->AddResumed(ResumeOffset);
  5078. }
  5079. }
  5080. OperationProgress->Progress();
  5081. }
  5082. // first open source file, not to loose the destination file,
  5083. // if we cannot open the source one in the first place
  5084. FTerminal->LogEvent(L"Opening remote file.");
  5085. FILE_OPERATION_LOOP_BEGIN
  5086. {
  5087. int OpenType = SSH_FXF_READ;
  5088. if ((FVersion >= 4) && OperationProgress->AsciiTransfer)
  5089. {
  5090. OpenType |= SSH_FXF_TEXT;
  5091. }
  5092. RemoteHandle = SFTPOpenRemoteFile(FileName, OpenType);
  5093. OperationProgress->Progress();
  5094. }
  5095. FILE_OPERATION_LOOP_END(FMTLOAD(SFTP_OPEN_FILE_ERROR, (FileName)));
  5096. TSFTPPacket RemoteFilePacket(SSH_FXP_FSTAT);
  5097. RemoteFilePacket.AddString(RemoteHandle);
  5098. SendCustomReadFile(&RemoteFilePacket, &RemoteFilePacket, SSH_FILEXFER_ATTR_MODIFYTIME);
  5099. ReceiveResponse(&RemoteFilePacket, &RemoteFilePacket);
  5100. OperationProgress->Progress();
  5101. TDateTime Modification = File->Modification; // fallback
  5102. TModificationFmt ModificationFmt = File->ModificationFmt;
  5103. // ignore errors
  5104. if (RemoteFilePacket.Type == SSH_FXP_ATTRS)
  5105. {
  5106. // load file, avoid completion (resolving symlinks) as we do not need that
  5107. std::unique_ptr<TRemoteFile> AFile(
  5108. LoadFile(&RemoteFilePacket, NULL, UnixExtractFileName(FileName), NULL, false));
  5109. if (AFile->Modification != TDateTime())
  5110. {
  5111. Modification = File->Modification;
  5112. ModificationFmt = File->ModificationFmt;
  5113. }
  5114. }
  5115. if ((Attrs >= 0) && !ResumeTransfer)
  5116. {
  5117. __int64 DestFileSize;
  5118. __int64 MTime;
  5119. FTerminal->OpenLocalFile(
  5120. DestFullName, GENERIC_WRITE, NULL, &LocalHandle, NULL, &MTime, NULL, &DestFileSize, false);
  5121. FTerminal->LogEvent(L"Confirming overwriting of file.");
  5122. TOverwriteFileParams FileParams;
  5123. FileParams.SourceSize = OperationProgress->TransferSize;
  5124. FileParams.SourceTimestamp = Modification;
  5125. FileParams.DestTimestamp = UnixToDateTime(MTime,
  5126. FTerminal->SessionData->DSTMode);
  5127. FileParams.DestSize = DestFileSize;
  5128. UnicodeString PrevDestFileName = DestFileName;
  5129. SFTPConfirmOverwrite(FileName, DestFileName, CopyParam, Params, OperationProgress, OverwriteMode, &FileParams);
  5130. if (PrevDestFileName != DestFileName)
  5131. {
  5132. DestFullName = TargetDir + DestFileName;
  5133. DestPartialFullName = DestFullName + PartialExt;
  5134. if (ResumeAllowed)
  5135. {
  5136. if (FileExists(ApiPath(DestPartialFullName)))
  5137. {
  5138. FTerminal->DoDeleteLocalFile(DestPartialFullName);
  5139. }
  5140. LocalFileName = DestPartialFullName;
  5141. }
  5142. else
  5143. {
  5144. LocalFileName = DestFullName;
  5145. }
  5146. }
  5147. if (OverwriteMode == omOverwrite)
  5148. {
  5149. // is NULL when overwriting read-only file
  5150. if (LocalHandle)
  5151. {
  5152. CloseHandle(LocalHandle);
  5153. LocalHandle = NULL;
  5154. }
  5155. }
  5156. else
  5157. {
  5158. // is NULL when overwriting read-only file, so following will
  5159. // probably fail anyway
  5160. if (LocalHandle == NULL)
  5161. {
  5162. FTerminal->OpenLocalFile(DestFullName, GENERIC_WRITE, NULL, &LocalHandle, NULL, NULL, NULL, NULL);
  5163. }
  5164. ResumeAllowed = false;
  5165. FileSeek((THandle)LocalHandle, DestFileSize, soBeginning);
  5166. if (OverwriteMode == omAppend)
  5167. {
  5168. FTerminal->LogEvent(L"Appending to file.");
  5169. }
  5170. else
  5171. {
  5172. FTerminal->LogEvent(L"Resuming file transfer (append style).");
  5173. DebugAssert(OverwriteMode == omResume);
  5174. OperationProgress->AddResumed(DestFileSize);
  5175. }
  5176. }
  5177. }
  5178. Action.Destination(ExpandUNCFileName(DestFullName));
  5179. if (CopyParam->OnTransferOut == NULL)
  5180. {
  5181. // if not already opened (resume, append...), create new empty file
  5182. if (!LocalHandle)
  5183. {
  5184. if (!FTerminal->CreateLocalFile(LocalFileName, OperationProgress,
  5185. &LocalHandle, FLAGSET(Params, cpNoConfirmation)))
  5186. {
  5187. throw ESkipFile();
  5188. }
  5189. }
  5190. DebugAssert(LocalHandle);
  5191. DeleteLocalFile = true;
  5192. FileStream = new TSafeHandleStream((THandle)LocalHandle);
  5193. }
  5194. // at end of this block queue is discarded
  5195. {
  5196. TValueRestorer<TSecureShellMode> SecureShellModeRestorer(FSecureShell->Mode, ssmDownloading);
  5197. TSFTPDownloadQueue Queue(this);
  5198. try
  5199. {
  5200. TSFTPPacket DataPacket;
  5201. int QueueLen = int(OperationProgress->TransferSize / DownloadBlockSize(OperationProgress)) + 1;
  5202. if ((QueueLen > FTerminal->SessionData->SFTPDownloadQueue) ||
  5203. (QueueLen < 0))
  5204. {
  5205. QueueLen = FTerminal->SessionData->SFTPDownloadQueue;
  5206. }
  5207. if (QueueLen < 1)
  5208. {
  5209. QueueLen = 1;
  5210. }
  5211. __int64 Offset = OperationProgress->TransferredSize + std::max(CopyParam->PartOffset, 0LL);
  5212. Queue.Init(QueueLen, RemoteHandle, Offset, CopyParam->PartSize, OperationProgress);
  5213. bool Eof = false;
  5214. bool PrevIncomplete = false;
  5215. int GapFillCount = 0;
  5216. int GapCount = 0;
  5217. unsigned long Missing = 0;
  5218. unsigned long DataLen = 0;
  5219. unsigned long BlockSize;
  5220. bool ConvertToken = false;
  5221. TEncryption Encryption(FTerminal->GetEncryptKey());
  5222. bool Decrypt = FTerminal->IsFileEncrypted(FileName);
  5223. while (!Eof)
  5224. {
  5225. if (Missing > 0)
  5226. {
  5227. Queue.InitFillGapRequest(Offset + OperationProgress->TransferredSize, Missing, &DataPacket);
  5228. GapFillCount++;
  5229. SendPacketAndReceiveResponse(&DataPacket, &DataPacket, SSH_FXP_DATA, asEOF);
  5230. }
  5231. else
  5232. {
  5233. Queue.ReceivePacket(&DataPacket, BlockSize);
  5234. }
  5235. if (DataPacket.Type == SSH_FXP_STATUS)
  5236. {
  5237. // must be SSH_FX_EOF, any other status packet would raise exception
  5238. Eof = true;
  5239. // close file right away, before waiting for pending responses
  5240. SFTPCloseRemote(RemoteHandle, DestFileName, OperationProgress, true, true, NULL);
  5241. RemoteHandle = L""; // do not close file again in __finally block
  5242. }
  5243. if (!Eof)
  5244. {
  5245. if ((Missing == 0) && PrevIncomplete)
  5246. {
  5247. // This can happen only if last request returned less bytes
  5248. // than expected, but exactly number of bytes missing to last
  5249. // known file size, but actually EOF was not reached.
  5250. // Can happen only when filesize has changed since directory
  5251. // listing and server returns less bytes than requested and
  5252. // file has some special file size.
  5253. FTerminal->LogEvent(FORMAT(
  5254. L"Received incomplete data packet before end of file, offset: %s, size: %d, requested: %d",
  5255. (IntToStr(OperationProgress->TransferredSize), int(DataLen), int(BlockSize))));
  5256. FTerminal->TerminalError(NULL, LoadStr(SFTP_INCOMPLETE_BEFORE_EOF));
  5257. }
  5258. // Buffer for one block of data
  5259. TFileBuffer BlockBuf;
  5260. DataLen = DataPacket.GetCardinal();
  5261. PrevIncomplete = false;
  5262. if (Missing > 0)
  5263. {
  5264. DebugAssert(DataLen <= Missing);
  5265. Missing -= DataLen;
  5266. }
  5267. else if (DataLen < BlockSize)
  5268. {
  5269. if (OperationProgress->TransferredSize + DataLen !=
  5270. OperationProgress->TransferSize)
  5271. {
  5272. // with native text transfer mode (SFTP>=4), do not bother about
  5273. // getting less than requested, read offset is ignored anyway
  5274. if ((FVersion < 4) || !OperationProgress->AsciiTransfer)
  5275. {
  5276. GapCount++;
  5277. Missing = BlockSize - DataLen;
  5278. }
  5279. }
  5280. else
  5281. {
  5282. PrevIncomplete = true;
  5283. }
  5284. }
  5285. DebugAssert(DataLen <= BlockSize);
  5286. BlockBuf.Insert(0, reinterpret_cast<const char *>(DataPacket.GetNextData(DataLen)), DataLen);
  5287. DataPacket.DataConsumed(DataLen);
  5288. OperationProgress->AddTransferred(DataLen);
  5289. if ((FVersion >= 6) && DataPacket.CanGetBool() && (Missing == 0))
  5290. {
  5291. Eof = DataPacket.GetBool();
  5292. }
  5293. if ((CopyParam->PartSize >= 0) &&
  5294. (OperationProgress->TransferredSize >= CopyParam->PartSize))
  5295. {
  5296. Eof = true;
  5297. }
  5298. if (OperationProgress->AsciiTransfer)
  5299. {
  5300. DebugAssert(!ResumeTransfer && !ResumeAllowed);
  5301. unsigned int PrevBlockSize = BlockBuf.Size;
  5302. BlockBuf.Convert(GetEOL(), FTerminal->Configuration->LocalEOLType, 0, ConvertToken);
  5303. OperationProgress->SetLocalSize(OperationProgress->LocalSize - PrevBlockSize + BlockBuf.Size);
  5304. }
  5305. if (Decrypt)
  5306. {
  5307. Encryption.Decrypt(BlockBuf);
  5308. }
  5309. WriteLocalFile(CopyParam, FileStream, BlockBuf, LocalFileName, OperationProgress);
  5310. }
  5311. if (OperationProgress->Cancel != csContinue)
  5312. {
  5313. if (OperationProgress->ClearCancelFile())
  5314. {
  5315. throw ESkipFile();
  5316. }
  5317. else
  5318. {
  5319. Abort();
  5320. }
  5321. }
  5322. };
  5323. if (GapCount > 0)
  5324. {
  5325. FTerminal->LogEvent(FORMAT(L"%d requests to fill %d data gaps were issued.", (GapFillCount, GapCount)));
  5326. }
  5327. if (Decrypt)
  5328. {
  5329. TFileBuffer BlockBuf;
  5330. if (Encryption.DecryptEnd(BlockBuf))
  5331. {
  5332. WriteLocalFile(CopyParam, FileStream, BlockBuf, LocalFileName, OperationProgress);
  5333. }
  5334. }
  5335. }
  5336. __finally
  5337. {
  5338. Queue.DisposeSafe();
  5339. }
  5340. // queue is discarded here
  5341. }
  5342. if (CopyParam->OnTransferOut == NULL)
  5343. {
  5344. DebugAssert(LocalHandle);
  5345. if (CopyParam->PreserveTime)
  5346. {
  5347. FTerminal->UpdateTargetTime(LocalHandle, Modification, ModificationFmt, FTerminal->SessionData->DSTMode);
  5348. }
  5349. CloseHandle(LocalHandle);
  5350. LocalHandle = NULL;
  5351. if (ResumeAllowed)
  5352. {
  5353. // See also DoRenameLocalFileForce
  5354. FILE_OPERATION_LOOP_BEGIN
  5355. {
  5356. if (FileExists(ApiPath(DestFullName)))
  5357. {
  5358. DeleteFileChecked(DestFullName);
  5359. }
  5360. THROWOSIFFALSE(Sysutils::RenameFile(ApiPath(DestPartialFullName), ApiPath(DestFullName)));
  5361. }
  5362. FILE_OPERATION_LOOP_END(FMTLOAD(RENAME_AFTER_RESUME_ERROR, (ExtractFileName(DestPartialFullName), DestFileName)));
  5363. }
  5364. DeleteLocalFile = false;
  5365. FTerminal->UpdateTargetAttrs(DestFullName, File, CopyParam, Attrs);
  5366. }
  5367. }
  5368. __finally
  5369. {
  5370. if (LocalHandle)
  5371. {
  5372. CloseHandle(LocalHandle);
  5373. }
  5374. if (FileStream != NULL)
  5375. {
  5376. delete FileStream;
  5377. }
  5378. if (DeleteLocalFile && (!ResumeAllowed || OperationProgress->LocallyUsed == 0) &&
  5379. (OverwriteMode == omOverwrite))
  5380. {
  5381. FTerminal->DoDeleteLocalFile(LocalFileName);
  5382. }
  5383. // if the transfer was finished, the file is usually closed already
  5384. // (except for special cases like SFTPv6 EOF indication or partial file download)
  5385. if (FTerminal->Active && !RemoteHandle.IsEmpty())
  5386. {
  5387. // do not wait for response
  5388. SFTPCloseRemote(RemoteHandle, DestFileName, OperationProgress, true, true, NULL);
  5389. }
  5390. }
  5391. }
  5392. //---------------------------------------------------------------------------
  5393. void __fastcall TSFTPFileSystem::RegisterChecksumAlg(const UnicodeString & Alg, const UnicodeString & SftpAlg)
  5394. {
  5395. FChecksumAlgs->Add(Alg);
  5396. FChecksumSftpAlgs->Add(SftpAlg);
  5397. }
  5398. //---------------------------------------------------------------------------
  5399. void __fastcall TSFTPFileSystem::GetSupportedChecksumAlgs(TStrings * Algs)
  5400. {
  5401. Algs->AddStrings(FChecksumAlgs.get());
  5402. }
  5403. //---------------------------------------------------------------------------
  5404. void __fastcall TSFTPFileSystem::LockFile(const UnicodeString & /*FileName*/, const TRemoteFile * /*File*/)
  5405. {
  5406. DebugFail();
  5407. }
  5408. //---------------------------------------------------------------------------
  5409. void __fastcall TSFTPFileSystem::UnlockFile(const UnicodeString & /*FileName*/, const TRemoteFile * /*File*/)
  5410. {
  5411. DebugFail();
  5412. }
  5413. //---------------------------------------------------------------------------
  5414. void __fastcall TSFTPFileSystem::UpdateFromMain(TCustomFileSystem * /*MainFileSystem*/)
  5415. {
  5416. // noop
  5417. }
  5418. //---------------------------------------------------------------------------
  5419. void __fastcall TSFTPFileSystem::ClearCaches()
  5420. {
  5421. // noop
  5422. }
  5423. //---------------------------------------------------------------------------
  5424. void TSFTPFileSystem::AddPathString(TSFTPPacket & Packet, const UnicodeString & Value, bool EncryptNewFiles)
  5425. {
  5426. UnicodeString EncryptedPath = FTerminal->EncryptFileName(Value, EncryptNewFiles);
  5427. Packet.AddPathString(EncryptedPath, FUtfStrings);
  5428. }