SftpFileSystem.cpp 179 KB

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