SftpFileSystem.cpp 184 KB

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