httpdtest.go 84 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553
  1. // Copyright (C) 2019-2022 Nicola Murino
  2. //
  3. // This program is free software: you can redistribute it and/or modify
  4. // it under the terms of the GNU Affero General Public License as published
  5. // by the Free Software Foundation, version 3.
  6. //
  7. // This program is distributed in the hope that it will be useful,
  8. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. // GNU Affero General Public License for more details.
  11. //
  12. // You should have received a copy of the GNU Affero General Public License
  13. // along with this program. If not, see <https://www.gnu.org/licenses/>.
  14. // Package httpdtest provides utilities for testing the exposed REST API.
  15. package httpdtest
  16. import (
  17. "bytes"
  18. "encoding/hex"
  19. "encoding/json"
  20. "errors"
  21. "fmt"
  22. "io"
  23. "net/http"
  24. "net/url"
  25. "path"
  26. "strconv"
  27. "strings"
  28. "github.com/go-chi/render"
  29. "github.com/sftpgo/sdk"
  30. "github.com/drakkan/sftpgo/v2/internal/common"
  31. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  32. "github.com/drakkan/sftpgo/v2/internal/httpclient"
  33. "github.com/drakkan/sftpgo/v2/internal/httpd"
  34. "github.com/drakkan/sftpgo/v2/internal/kms"
  35. "github.com/drakkan/sftpgo/v2/internal/util"
  36. "github.com/drakkan/sftpgo/v2/internal/version"
  37. "github.com/drakkan/sftpgo/v2/internal/vfs"
  38. )
  39. const (
  40. tokenPath = "/api/v2/token"
  41. activeConnectionsPath = "/api/v2/connections"
  42. quotasBasePath = "/api/v2/quotas"
  43. quotaScanPath = "/api/v2/quotas/users/scans"
  44. quotaScanVFolderPath = "/api/v2/quotas/folders/scans"
  45. userPath = "/api/v2/users"
  46. groupPath = "/api/v2/groups"
  47. versionPath = "/api/v2/version"
  48. folderPath = "/api/v2/folders"
  49. serverStatusPath = "/api/v2/status"
  50. dumpDataPath = "/api/v2/dumpdata"
  51. loadDataPath = "/api/v2/loaddata"
  52. defenderHosts = "/api/v2/defender/hosts"
  53. adminPath = "/api/v2/admins"
  54. adminPwdPath = "/api/v2/admin/changepwd"
  55. apiKeysPath = "/api/v2/apikeys"
  56. retentionBasePath = "/api/v2/retention/users"
  57. retentionChecksPath = "/api/v2/retention/users/checks"
  58. eventActionsPath = "/api/v2/eventactions"
  59. eventRulesPath = "/api/v2/eventrules"
  60. )
  61. const (
  62. defaultTokenAuthUser = "admin"
  63. defaultTokenAuthPass = "password"
  64. )
  65. var (
  66. httpBaseURL = "http://127.0.0.1:8080"
  67. jwtToken = ""
  68. )
  69. // SetBaseURL sets the base url to use for HTTP requests.
  70. // Default URL is "http://127.0.0.1:8080"
  71. func SetBaseURL(url string) {
  72. httpBaseURL = url
  73. }
  74. // SetJWTToken sets the JWT token to use
  75. func SetJWTToken(token string) {
  76. jwtToken = token
  77. }
  78. func sendHTTPRequest(method, url string, body io.Reader, contentType, token string) (*http.Response, error) {
  79. req, err := http.NewRequest(method, url, body)
  80. if err != nil {
  81. return nil, err
  82. }
  83. if contentType != "" {
  84. req.Header.Set("Content-Type", "application/json")
  85. }
  86. if token != "" {
  87. req.Header.Set("Authorization", fmt.Sprintf("Bearer %v", token))
  88. }
  89. return httpclient.GetHTTPClient().Do(req)
  90. }
  91. func buildURLRelativeToBase(paths ...string) string {
  92. // we need to use path.Join and not filepath.Join
  93. // since filepath.Join will use backslash separator on Windows
  94. p := path.Join(paths...)
  95. return fmt.Sprintf("%s/%s", strings.TrimRight(httpBaseURL, "/"), strings.TrimLeft(p, "/"))
  96. }
  97. // GetToken tries to return a JWT token
  98. func GetToken(username, password string) (string, map[string]any, error) {
  99. req, err := http.NewRequest(http.MethodGet, buildURLRelativeToBase(tokenPath), nil)
  100. if err != nil {
  101. return "", nil, err
  102. }
  103. req.SetBasicAuth(username, password)
  104. resp, err := httpclient.GetHTTPClient().Do(req)
  105. if err != nil {
  106. return "", nil, err
  107. }
  108. defer resp.Body.Close()
  109. err = checkResponse(resp.StatusCode, http.StatusOK)
  110. if err != nil {
  111. return "", nil, err
  112. }
  113. responseHolder := make(map[string]any)
  114. err = render.DecodeJSON(resp.Body, &responseHolder)
  115. if err != nil {
  116. return "", nil, err
  117. }
  118. return responseHolder["access_token"].(string), responseHolder, nil
  119. }
  120. func getDefaultToken() string {
  121. if jwtToken != "" {
  122. return jwtToken
  123. }
  124. token, _, err := GetToken(defaultTokenAuthUser, defaultTokenAuthPass)
  125. if err != nil {
  126. return ""
  127. }
  128. return token
  129. }
  130. // AddUser adds a new user and checks the received HTTP Status code against expectedStatusCode.
  131. func AddUser(user dataprovider.User, expectedStatusCode int) (dataprovider.User, []byte, error) {
  132. var newUser dataprovider.User
  133. var body []byte
  134. userAsJSON, _ := json.Marshal(user)
  135. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(userPath), bytes.NewBuffer(userAsJSON),
  136. "application/json", getDefaultToken())
  137. if err != nil {
  138. return newUser, body, err
  139. }
  140. defer resp.Body.Close()
  141. err = checkResponse(resp.StatusCode, expectedStatusCode)
  142. if expectedStatusCode != http.StatusCreated {
  143. body, _ = getResponseBody(resp)
  144. return newUser, body, err
  145. }
  146. if err == nil {
  147. err = render.DecodeJSON(resp.Body, &newUser)
  148. } else {
  149. body, _ = getResponseBody(resp)
  150. }
  151. if err == nil {
  152. err = checkUser(&user, &newUser)
  153. }
  154. return newUser, body, err
  155. }
  156. // UpdateUserWithJSON update a user using the provided JSON as POST body
  157. func UpdateUserWithJSON(user dataprovider.User, expectedStatusCode int, disconnect string, userAsJSON []byte) (dataprovider.User, []byte, error) {
  158. var newUser dataprovider.User
  159. var body []byte
  160. url, err := addDisconnectQueryParam(buildURLRelativeToBase(userPath, url.PathEscape(user.Username)), disconnect)
  161. if err != nil {
  162. return user, body, err
  163. }
  164. resp, err := sendHTTPRequest(http.MethodPut, url.String(), bytes.NewBuffer(userAsJSON), "application/json",
  165. getDefaultToken())
  166. if err != nil {
  167. return user, body, err
  168. }
  169. defer resp.Body.Close()
  170. body, _ = getResponseBody(resp)
  171. err = checkResponse(resp.StatusCode, expectedStatusCode)
  172. if expectedStatusCode != http.StatusOK {
  173. return newUser, body, err
  174. }
  175. if err == nil {
  176. newUser, body, err = GetUserByUsername(user.Username, expectedStatusCode)
  177. }
  178. if err == nil {
  179. err = checkUser(&user, &newUser)
  180. }
  181. return newUser, body, err
  182. }
  183. // UpdateUser updates an existing user and checks the received HTTP Status code against expectedStatusCode.
  184. func UpdateUser(user dataprovider.User, expectedStatusCode int, disconnect string) (dataprovider.User, []byte, error) {
  185. userAsJSON, _ := json.Marshal(user)
  186. return UpdateUserWithJSON(user, expectedStatusCode, disconnect, userAsJSON)
  187. }
  188. // RemoveUser removes an existing user and checks the received HTTP Status code against expectedStatusCode.
  189. func RemoveUser(user dataprovider.User, expectedStatusCode int) ([]byte, error) {
  190. var body []byte
  191. resp, err := sendHTTPRequest(http.MethodDelete, buildURLRelativeToBase(userPath, url.PathEscape(user.Username)),
  192. nil, "", getDefaultToken())
  193. if err != nil {
  194. return body, err
  195. }
  196. defer resp.Body.Close()
  197. body, _ = getResponseBody(resp)
  198. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  199. }
  200. // GetUserByUsername gets a user by username and checks the received HTTP Status code against expectedStatusCode.
  201. func GetUserByUsername(username string, expectedStatusCode int) (dataprovider.User, []byte, error) {
  202. var user dataprovider.User
  203. var body []byte
  204. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(userPath, url.PathEscape(username)),
  205. nil, "", getDefaultToken())
  206. if err != nil {
  207. return user, body, err
  208. }
  209. defer resp.Body.Close()
  210. err = checkResponse(resp.StatusCode, expectedStatusCode)
  211. if err == nil && expectedStatusCode == http.StatusOK {
  212. err = render.DecodeJSON(resp.Body, &user)
  213. } else {
  214. body, _ = getResponseBody(resp)
  215. }
  216. return user, body, err
  217. }
  218. // GetUsers returns a list of users and checks the received HTTP Status code against expectedStatusCode.
  219. // The number of results can be limited specifying a limit.
  220. // Some results can be skipped specifying an offset.
  221. func GetUsers(limit, offset int64, expectedStatusCode int) ([]dataprovider.User, []byte, error) {
  222. var users []dataprovider.User
  223. var body []byte
  224. url, err := addLimitAndOffsetQueryParams(buildURLRelativeToBase(userPath), limit, offset)
  225. if err != nil {
  226. return users, body, err
  227. }
  228. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  229. if err != nil {
  230. return users, body, err
  231. }
  232. defer resp.Body.Close()
  233. err = checkResponse(resp.StatusCode, expectedStatusCode)
  234. if err == nil && expectedStatusCode == http.StatusOK {
  235. err = render.DecodeJSON(resp.Body, &users)
  236. } else {
  237. body, _ = getResponseBody(resp)
  238. }
  239. return users, body, err
  240. }
  241. // AddGroup adds a new group and checks the received HTTP Status code against expectedStatusCode.
  242. func AddGroup(group dataprovider.Group, expectedStatusCode int) (dataprovider.Group, []byte, error) {
  243. var newGroup dataprovider.Group
  244. var body []byte
  245. asJSON, _ := json.Marshal(group)
  246. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(groupPath), bytes.NewBuffer(asJSON),
  247. "application/json", getDefaultToken())
  248. if err != nil {
  249. return newGroup, body, err
  250. }
  251. defer resp.Body.Close()
  252. err = checkResponse(resp.StatusCode, expectedStatusCode)
  253. if expectedStatusCode != http.StatusCreated {
  254. body, _ = getResponseBody(resp)
  255. return newGroup, body, err
  256. }
  257. if err == nil {
  258. err = render.DecodeJSON(resp.Body, &newGroup)
  259. } else {
  260. body, _ = getResponseBody(resp)
  261. }
  262. if err == nil {
  263. err = checkGroup(group, newGroup)
  264. }
  265. return newGroup, body, err
  266. }
  267. // UpdateGroup updates an existing group and checks the received HTTP Status code against expectedStatusCode
  268. func UpdateGroup(group dataprovider.Group, expectedStatusCode int) (dataprovider.Group, []byte, error) {
  269. var newGroup dataprovider.Group
  270. var body []byte
  271. asJSON, _ := json.Marshal(group)
  272. resp, err := sendHTTPRequest(http.MethodPut, buildURLRelativeToBase(groupPath, url.PathEscape(group.Name)),
  273. bytes.NewBuffer(asJSON), "application/json", getDefaultToken())
  274. if err != nil {
  275. return newGroup, body, err
  276. }
  277. defer resp.Body.Close()
  278. body, _ = getResponseBody(resp)
  279. err = checkResponse(resp.StatusCode, expectedStatusCode)
  280. if expectedStatusCode != http.StatusOK {
  281. return newGroup, body, err
  282. }
  283. if err == nil {
  284. newGroup, body, err = GetGroupByName(group.Name, expectedStatusCode)
  285. }
  286. if err == nil {
  287. err = checkGroup(group, newGroup)
  288. }
  289. return newGroup, body, err
  290. }
  291. // RemoveGroup removes an existing group and checks the received HTTP Status code against expectedStatusCode.
  292. func RemoveGroup(group dataprovider.Group, expectedStatusCode int) ([]byte, error) {
  293. var body []byte
  294. resp, err := sendHTTPRequest(http.MethodDelete, buildURLRelativeToBase(groupPath, url.PathEscape(group.Name)),
  295. nil, "", getDefaultToken())
  296. if err != nil {
  297. return body, err
  298. }
  299. defer resp.Body.Close()
  300. body, _ = getResponseBody(resp)
  301. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  302. }
  303. // GetGroupByName gets a group by name and checks the received HTTP Status code against expectedStatusCode.
  304. func GetGroupByName(name string, expectedStatusCode int) (dataprovider.Group, []byte, error) {
  305. var group dataprovider.Group
  306. var body []byte
  307. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(groupPath, url.PathEscape(name)),
  308. nil, "", getDefaultToken())
  309. if err != nil {
  310. return group, body, err
  311. }
  312. defer resp.Body.Close()
  313. err = checkResponse(resp.StatusCode, expectedStatusCode)
  314. if err == nil && expectedStatusCode == http.StatusOK {
  315. err = render.DecodeJSON(resp.Body, &group)
  316. } else {
  317. body, _ = getResponseBody(resp)
  318. }
  319. return group, body, err
  320. }
  321. // GetGroups returns a list of groups and checks the received HTTP Status code against expectedStatusCode.
  322. // The number of results can be limited specifying a limit.
  323. // Some results can be skipped specifying an offset.
  324. func GetGroups(limit, offset int64, expectedStatusCode int) ([]dataprovider.Group, []byte, error) {
  325. var groups []dataprovider.Group
  326. var body []byte
  327. url, err := addLimitAndOffsetQueryParams(buildURLRelativeToBase(groupPath), limit, offset)
  328. if err != nil {
  329. return groups, body, err
  330. }
  331. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  332. if err != nil {
  333. return groups, body, err
  334. }
  335. defer resp.Body.Close()
  336. err = checkResponse(resp.StatusCode, expectedStatusCode)
  337. if err == nil && expectedStatusCode == http.StatusOK {
  338. err = render.DecodeJSON(resp.Body, &groups)
  339. } else {
  340. body, _ = getResponseBody(resp)
  341. }
  342. return groups, body, err
  343. }
  344. // AddAdmin adds a new admin and checks the received HTTP Status code against expectedStatusCode.
  345. func AddAdmin(admin dataprovider.Admin, expectedStatusCode int) (dataprovider.Admin, []byte, error) {
  346. var newAdmin dataprovider.Admin
  347. var body []byte
  348. asJSON, _ := json.Marshal(admin)
  349. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(adminPath), bytes.NewBuffer(asJSON),
  350. "application/json", getDefaultToken())
  351. if err != nil {
  352. return newAdmin, body, err
  353. }
  354. defer resp.Body.Close()
  355. err = checkResponse(resp.StatusCode, expectedStatusCode)
  356. if expectedStatusCode != http.StatusCreated {
  357. body, _ = getResponseBody(resp)
  358. return newAdmin, body, err
  359. }
  360. if err == nil {
  361. err = render.DecodeJSON(resp.Body, &newAdmin)
  362. } else {
  363. body, _ = getResponseBody(resp)
  364. }
  365. if err == nil {
  366. err = checkAdmin(&admin, &newAdmin)
  367. }
  368. return newAdmin, body, err
  369. }
  370. // UpdateAdmin updates an existing admin and checks the received HTTP Status code against expectedStatusCode
  371. func UpdateAdmin(admin dataprovider.Admin, expectedStatusCode int) (dataprovider.Admin, []byte, error) {
  372. var newAdmin dataprovider.Admin
  373. var body []byte
  374. asJSON, _ := json.Marshal(admin)
  375. resp, err := sendHTTPRequest(http.MethodPut, buildURLRelativeToBase(adminPath, url.PathEscape(admin.Username)),
  376. bytes.NewBuffer(asJSON), "application/json", getDefaultToken())
  377. if err != nil {
  378. return newAdmin, body, err
  379. }
  380. defer resp.Body.Close()
  381. body, _ = getResponseBody(resp)
  382. err = checkResponse(resp.StatusCode, expectedStatusCode)
  383. if expectedStatusCode != http.StatusOK {
  384. return newAdmin, body, err
  385. }
  386. if err == nil {
  387. newAdmin, body, err = GetAdminByUsername(admin.Username, expectedStatusCode)
  388. }
  389. if err == nil {
  390. err = checkAdmin(&admin, &newAdmin)
  391. }
  392. return newAdmin, body, err
  393. }
  394. // RemoveAdmin removes an existing admin and checks the received HTTP Status code against expectedStatusCode.
  395. func RemoveAdmin(admin dataprovider.Admin, expectedStatusCode int) ([]byte, error) {
  396. var body []byte
  397. resp, err := sendHTTPRequest(http.MethodDelete, buildURLRelativeToBase(adminPath, url.PathEscape(admin.Username)),
  398. nil, "", getDefaultToken())
  399. if err != nil {
  400. return body, err
  401. }
  402. defer resp.Body.Close()
  403. body, _ = getResponseBody(resp)
  404. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  405. }
  406. // GetAdminByUsername gets an admin by username and checks the received HTTP Status code against expectedStatusCode.
  407. func GetAdminByUsername(username string, expectedStatusCode int) (dataprovider.Admin, []byte, error) {
  408. var admin dataprovider.Admin
  409. var body []byte
  410. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(adminPath, url.PathEscape(username)),
  411. nil, "", getDefaultToken())
  412. if err != nil {
  413. return admin, body, err
  414. }
  415. defer resp.Body.Close()
  416. err = checkResponse(resp.StatusCode, expectedStatusCode)
  417. if err == nil && expectedStatusCode == http.StatusOK {
  418. err = render.DecodeJSON(resp.Body, &admin)
  419. } else {
  420. body, _ = getResponseBody(resp)
  421. }
  422. return admin, body, err
  423. }
  424. // GetAdmins returns a list of admins and checks the received HTTP Status code against expectedStatusCode.
  425. // The number of results can be limited specifying a limit.
  426. // Some results can be skipped specifying an offset.
  427. func GetAdmins(limit, offset int64, expectedStatusCode int) ([]dataprovider.Admin, []byte, error) {
  428. var admins []dataprovider.Admin
  429. var body []byte
  430. url, err := addLimitAndOffsetQueryParams(buildURLRelativeToBase(adminPath), limit, offset)
  431. if err != nil {
  432. return admins, body, err
  433. }
  434. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  435. if err != nil {
  436. return admins, body, err
  437. }
  438. defer resp.Body.Close()
  439. err = checkResponse(resp.StatusCode, expectedStatusCode)
  440. if err == nil && expectedStatusCode == http.StatusOK {
  441. err = render.DecodeJSON(resp.Body, &admins)
  442. } else {
  443. body, _ = getResponseBody(resp)
  444. }
  445. return admins, body, err
  446. }
  447. // ChangeAdminPassword changes the password for an existing admin
  448. func ChangeAdminPassword(currentPassword, newPassword string, expectedStatusCode int) ([]byte, error) {
  449. var body []byte
  450. pwdChange := make(map[string]string)
  451. pwdChange["current_password"] = currentPassword
  452. pwdChange["new_password"] = newPassword
  453. asJSON, _ := json.Marshal(&pwdChange)
  454. resp, err := sendHTTPRequest(http.MethodPut, buildURLRelativeToBase(adminPwdPath),
  455. bytes.NewBuffer(asJSON), "application/json", getDefaultToken())
  456. if err != nil {
  457. return body, err
  458. }
  459. defer resp.Body.Close()
  460. err = checkResponse(resp.StatusCode, expectedStatusCode)
  461. body, _ = getResponseBody(resp)
  462. return body, err
  463. }
  464. // GetAPIKeys returns a list of API keys and checks the received HTTP Status code against expectedStatusCode.
  465. // The number of results can be limited specifying a limit.
  466. // Some results can be skipped specifying an offset.
  467. func GetAPIKeys(limit, offset int64, expectedStatusCode int) ([]dataprovider.APIKey, []byte, error) {
  468. var apiKeys []dataprovider.APIKey
  469. var body []byte
  470. url, err := addLimitAndOffsetQueryParams(buildURLRelativeToBase(apiKeysPath), limit, offset)
  471. if err != nil {
  472. return apiKeys, body, err
  473. }
  474. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  475. if err != nil {
  476. return apiKeys, body, err
  477. }
  478. defer resp.Body.Close()
  479. err = checkResponse(resp.StatusCode, expectedStatusCode)
  480. if err == nil && expectedStatusCode == http.StatusOK {
  481. err = render.DecodeJSON(resp.Body, &apiKeys)
  482. } else {
  483. body, _ = getResponseBody(resp)
  484. }
  485. return apiKeys, body, err
  486. }
  487. // AddAPIKey adds a new API key and checks the received HTTP Status code against expectedStatusCode.
  488. func AddAPIKey(apiKey dataprovider.APIKey, expectedStatusCode int) (dataprovider.APIKey, []byte, error) {
  489. var newAPIKey dataprovider.APIKey
  490. var body []byte
  491. asJSON, _ := json.Marshal(apiKey)
  492. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(apiKeysPath), bytes.NewBuffer(asJSON),
  493. "application/json", getDefaultToken())
  494. if err != nil {
  495. return newAPIKey, body, err
  496. }
  497. defer resp.Body.Close()
  498. err = checkResponse(resp.StatusCode, expectedStatusCode)
  499. if expectedStatusCode != http.StatusCreated {
  500. body, _ = getResponseBody(resp)
  501. return newAPIKey, body, err
  502. }
  503. if err != nil {
  504. body, _ = getResponseBody(resp)
  505. return newAPIKey, body, err
  506. }
  507. response := make(map[string]string)
  508. err = render.DecodeJSON(resp.Body, &response)
  509. if err == nil {
  510. newAPIKey, body, err = GetAPIKeyByID(resp.Header.Get("X-Object-ID"), http.StatusOK)
  511. }
  512. if err == nil {
  513. err = checkAPIKey(&apiKey, &newAPIKey)
  514. }
  515. newAPIKey.Key = response["key"]
  516. return newAPIKey, body, err
  517. }
  518. // UpdateAPIKey updates an existing API key and checks the received HTTP Status code against expectedStatusCode
  519. func UpdateAPIKey(apiKey dataprovider.APIKey, expectedStatusCode int) (dataprovider.APIKey, []byte, error) {
  520. var newAPIKey dataprovider.APIKey
  521. var body []byte
  522. asJSON, _ := json.Marshal(apiKey)
  523. resp, err := sendHTTPRequest(http.MethodPut, buildURLRelativeToBase(apiKeysPath, url.PathEscape(apiKey.KeyID)),
  524. bytes.NewBuffer(asJSON), "application/json", getDefaultToken())
  525. if err != nil {
  526. return newAPIKey, body, err
  527. }
  528. defer resp.Body.Close()
  529. body, _ = getResponseBody(resp)
  530. err = checkResponse(resp.StatusCode, expectedStatusCode)
  531. if expectedStatusCode != http.StatusOK {
  532. return newAPIKey, body, err
  533. }
  534. if err == nil {
  535. newAPIKey, body, err = GetAPIKeyByID(apiKey.KeyID, expectedStatusCode)
  536. }
  537. if err == nil {
  538. err = checkAPIKey(&apiKey, &newAPIKey)
  539. }
  540. return newAPIKey, body, err
  541. }
  542. // RemoveAPIKey removes an existing API key and checks the received HTTP Status code against expectedStatusCode.
  543. func RemoveAPIKey(apiKey dataprovider.APIKey, expectedStatusCode int) ([]byte, error) {
  544. var body []byte
  545. resp, err := sendHTTPRequest(http.MethodDelete, buildURLRelativeToBase(apiKeysPath, url.PathEscape(apiKey.KeyID)),
  546. nil, "", getDefaultToken())
  547. if err != nil {
  548. return body, err
  549. }
  550. defer resp.Body.Close()
  551. body, _ = getResponseBody(resp)
  552. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  553. }
  554. // GetAPIKeyByID gets a API key by ID and checks the received HTTP Status code against expectedStatusCode.
  555. func GetAPIKeyByID(keyID string, expectedStatusCode int) (dataprovider.APIKey, []byte, error) {
  556. var apiKey dataprovider.APIKey
  557. var body []byte
  558. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(apiKeysPath, url.PathEscape(keyID)),
  559. nil, "", getDefaultToken())
  560. if err != nil {
  561. return apiKey, body, err
  562. }
  563. defer resp.Body.Close()
  564. err = checkResponse(resp.StatusCode, expectedStatusCode)
  565. if err == nil && expectedStatusCode == http.StatusOK {
  566. err = render.DecodeJSON(resp.Body, &apiKey)
  567. } else {
  568. body, _ = getResponseBody(resp)
  569. }
  570. return apiKey, body, err
  571. }
  572. // AddEventAction adds a new event action
  573. func AddEventAction(action dataprovider.BaseEventAction, expectedStatusCode int) (dataprovider.BaseEventAction, []byte, error) {
  574. var newAction dataprovider.BaseEventAction
  575. var body []byte
  576. asJSON, _ := json.Marshal(action)
  577. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(eventActionsPath), bytes.NewBuffer(asJSON),
  578. "application/json", getDefaultToken())
  579. if err != nil {
  580. return newAction, body, err
  581. }
  582. defer resp.Body.Close()
  583. err = checkResponse(resp.StatusCode, expectedStatusCode)
  584. if expectedStatusCode != http.StatusCreated {
  585. body, _ = getResponseBody(resp)
  586. return newAction, body, err
  587. }
  588. if err == nil {
  589. err = render.DecodeJSON(resp.Body, &newAction)
  590. } else {
  591. body, _ = getResponseBody(resp)
  592. }
  593. if err == nil {
  594. err = checkEventAction(action, newAction)
  595. }
  596. return newAction, body, err
  597. }
  598. // UpdateEventAction updates an existing event action
  599. func UpdateEventAction(action dataprovider.BaseEventAction, expectedStatusCode int) (dataprovider.BaseEventAction, []byte, error) {
  600. var newAction dataprovider.BaseEventAction
  601. var body []byte
  602. asJSON, _ := json.Marshal(action)
  603. resp, err := sendHTTPRequest(http.MethodPut, buildURLRelativeToBase(eventActionsPath, url.PathEscape(action.Name)),
  604. bytes.NewBuffer(asJSON), "application/json", getDefaultToken())
  605. if err != nil {
  606. return newAction, body, err
  607. }
  608. defer resp.Body.Close()
  609. body, _ = getResponseBody(resp)
  610. err = checkResponse(resp.StatusCode, expectedStatusCode)
  611. if expectedStatusCode != http.StatusOK {
  612. return newAction, body, err
  613. }
  614. if err == nil {
  615. newAction, body, err = GetEventActionByName(action.Name, expectedStatusCode)
  616. }
  617. if err == nil {
  618. err = checkEventAction(action, newAction)
  619. }
  620. return newAction, body, err
  621. }
  622. // RemoveEventAction removes an existing action and checks the received HTTP Status code against expectedStatusCode.
  623. func RemoveEventAction(action dataprovider.BaseEventAction, expectedStatusCode int) ([]byte, error) {
  624. var body []byte
  625. resp, err := sendHTTPRequest(http.MethodDelete, buildURLRelativeToBase(eventActionsPath, url.PathEscape(action.Name)),
  626. nil, "", getDefaultToken())
  627. if err != nil {
  628. return body, err
  629. }
  630. defer resp.Body.Close()
  631. body, _ = getResponseBody(resp)
  632. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  633. }
  634. // GetEventActionByName gets an event action by name and checks the received HTTP Status code against expectedStatusCode.
  635. func GetEventActionByName(name string, expectedStatusCode int) (dataprovider.BaseEventAction, []byte, error) {
  636. var action dataprovider.BaseEventAction
  637. var body []byte
  638. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(eventActionsPath, url.PathEscape(name)),
  639. nil, "", getDefaultToken())
  640. if err != nil {
  641. return action, body, err
  642. }
  643. defer resp.Body.Close()
  644. err = checkResponse(resp.StatusCode, expectedStatusCode)
  645. if err == nil && expectedStatusCode == http.StatusOK {
  646. err = render.DecodeJSON(resp.Body, &action)
  647. } else {
  648. body, _ = getResponseBody(resp)
  649. }
  650. return action, body, err
  651. }
  652. // GetEventActions returns a list of event actions and checks the received HTTP Status code against expectedStatusCode.
  653. // The number of results can be limited specifying a limit.
  654. // Some results can be skipped specifying an offset.
  655. func GetEventActions(limit, offset int64, expectedStatusCode int) ([]dataprovider.BaseEventAction, []byte, error) {
  656. var actions []dataprovider.BaseEventAction
  657. var body []byte
  658. url, err := addLimitAndOffsetQueryParams(buildURLRelativeToBase(eventActionsPath), limit, offset)
  659. if err != nil {
  660. return actions, body, err
  661. }
  662. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  663. if err != nil {
  664. return actions, body, err
  665. }
  666. defer resp.Body.Close()
  667. err = checkResponse(resp.StatusCode, expectedStatusCode)
  668. if err == nil && expectedStatusCode == http.StatusOK {
  669. err = render.DecodeJSON(resp.Body, &actions)
  670. } else {
  671. body, _ = getResponseBody(resp)
  672. }
  673. return actions, body, err
  674. }
  675. // AddEventRule adds a new event rule
  676. func AddEventRule(rule dataprovider.EventRule, expectedStatusCode int) (dataprovider.EventRule, []byte, error) {
  677. var newRule dataprovider.EventRule
  678. var body []byte
  679. asJSON, _ := json.Marshal(rule)
  680. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(eventRulesPath), bytes.NewBuffer(asJSON),
  681. "application/json", getDefaultToken())
  682. if err != nil {
  683. return newRule, body, err
  684. }
  685. defer resp.Body.Close()
  686. err = checkResponse(resp.StatusCode, expectedStatusCode)
  687. if expectedStatusCode != http.StatusCreated {
  688. body, _ = getResponseBody(resp)
  689. return newRule, body, err
  690. }
  691. if err == nil {
  692. err = render.DecodeJSON(resp.Body, &newRule)
  693. } else {
  694. body, _ = getResponseBody(resp)
  695. }
  696. if err == nil {
  697. err = checkEventRule(rule, newRule)
  698. }
  699. return newRule, body, err
  700. }
  701. // UpdateEventRule updates an existing event rule
  702. func UpdateEventRule(rule dataprovider.EventRule, expectedStatusCode int) (dataprovider.EventRule, []byte, error) {
  703. var newRule dataprovider.EventRule
  704. var body []byte
  705. asJSON, _ := json.Marshal(rule)
  706. resp, err := sendHTTPRequest(http.MethodPut, buildURLRelativeToBase(eventRulesPath, url.PathEscape(rule.Name)),
  707. bytes.NewBuffer(asJSON), "application/json", getDefaultToken())
  708. if err != nil {
  709. return newRule, body, err
  710. }
  711. defer resp.Body.Close()
  712. body, _ = getResponseBody(resp)
  713. err = checkResponse(resp.StatusCode, expectedStatusCode)
  714. if expectedStatusCode != http.StatusOK {
  715. return newRule, body, err
  716. }
  717. if err == nil {
  718. newRule, body, err = GetEventRuleByName(rule.Name, expectedStatusCode)
  719. }
  720. if err == nil {
  721. err = checkEventRule(rule, newRule)
  722. }
  723. return newRule, body, err
  724. }
  725. // RemoveEventRule removes an existing rule and checks the received HTTP Status code against expectedStatusCode.
  726. func RemoveEventRule(rule dataprovider.EventRule, expectedStatusCode int) ([]byte, error) {
  727. var body []byte
  728. resp, err := sendHTTPRequest(http.MethodDelete, buildURLRelativeToBase(eventRulesPath, url.PathEscape(rule.Name)),
  729. nil, "", getDefaultToken())
  730. if err != nil {
  731. return body, err
  732. }
  733. defer resp.Body.Close()
  734. body, _ = getResponseBody(resp)
  735. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  736. }
  737. // GetEventRuleByName gets an event rule by name and checks the received HTTP Status code against expectedStatusCode.
  738. func GetEventRuleByName(name string, expectedStatusCode int) (dataprovider.EventRule, []byte, error) {
  739. var rule dataprovider.EventRule
  740. var body []byte
  741. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(eventRulesPath, url.PathEscape(name)),
  742. nil, "", getDefaultToken())
  743. if err != nil {
  744. return rule, body, err
  745. }
  746. defer resp.Body.Close()
  747. err = checkResponse(resp.StatusCode, expectedStatusCode)
  748. if err == nil && expectedStatusCode == http.StatusOK {
  749. err = render.DecodeJSON(resp.Body, &rule)
  750. } else {
  751. body, _ = getResponseBody(resp)
  752. }
  753. return rule, body, err
  754. }
  755. // GetEventRules returns a list of event rules and checks the received HTTP Status code against expectedStatusCode.
  756. // The number of results can be limited specifying a limit.
  757. // Some results can be skipped specifying an offset.
  758. func GetEventRules(limit, offset int64, expectedStatusCode int) ([]dataprovider.EventRule, []byte, error) {
  759. var rules []dataprovider.EventRule
  760. var body []byte
  761. url, err := addLimitAndOffsetQueryParams(buildURLRelativeToBase(eventRulesPath), limit, offset)
  762. if err != nil {
  763. return rules, body, err
  764. }
  765. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  766. if err != nil {
  767. return rules, body, err
  768. }
  769. defer resp.Body.Close()
  770. err = checkResponse(resp.StatusCode, expectedStatusCode)
  771. if err == nil && expectedStatusCode == http.StatusOK {
  772. err = render.DecodeJSON(resp.Body, &rules)
  773. } else {
  774. body, _ = getResponseBody(resp)
  775. }
  776. return rules, body, err
  777. }
  778. // GetQuotaScans gets active quota scans for users and checks the received HTTP Status code against expectedStatusCode.
  779. func GetQuotaScans(expectedStatusCode int) ([]common.ActiveQuotaScan, []byte, error) {
  780. var quotaScans []common.ActiveQuotaScan
  781. var body []byte
  782. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(quotaScanPath), nil, "", getDefaultToken())
  783. if err != nil {
  784. return quotaScans, body, err
  785. }
  786. defer resp.Body.Close()
  787. err = checkResponse(resp.StatusCode, expectedStatusCode)
  788. if err == nil && expectedStatusCode == http.StatusOK {
  789. err = render.DecodeJSON(resp.Body, &quotaScans)
  790. } else {
  791. body, _ = getResponseBody(resp)
  792. }
  793. return quotaScans, body, err
  794. }
  795. // StartQuotaScan starts a new quota scan for the given user and checks the received HTTP Status code against expectedStatusCode.
  796. func StartQuotaScan(user dataprovider.User, expectedStatusCode int) ([]byte, error) {
  797. var body []byte
  798. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(quotasBasePath, "users", user.Username, "scan"),
  799. nil, "", getDefaultToken())
  800. if err != nil {
  801. return body, err
  802. }
  803. defer resp.Body.Close()
  804. body, _ = getResponseBody(resp)
  805. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  806. }
  807. // UpdateQuotaUsage updates the user used quota limits and checks the received
  808. // HTTP Status code against expectedStatusCode.
  809. func UpdateQuotaUsage(user dataprovider.User, mode string, expectedStatusCode int) ([]byte, error) {
  810. var body []byte
  811. userAsJSON, _ := json.Marshal(user)
  812. url, err := addModeQueryParam(buildURLRelativeToBase(quotasBasePath, "users", user.Username, "usage"), mode)
  813. if err != nil {
  814. return body, err
  815. }
  816. resp, err := sendHTTPRequest(http.MethodPut, url.String(), bytes.NewBuffer(userAsJSON), "application/json",
  817. getDefaultToken())
  818. if err != nil {
  819. return body, err
  820. }
  821. defer resp.Body.Close()
  822. body, _ = getResponseBody(resp)
  823. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  824. }
  825. // UpdateTransferQuotaUsage updates the user used transfer quota limits and checks the received
  826. // HTTP Status code against expectedStatusCode.
  827. func UpdateTransferQuotaUsage(user dataprovider.User, mode string, expectedStatusCode int) ([]byte, error) {
  828. var body []byte
  829. userAsJSON, _ := json.Marshal(user)
  830. url, err := addModeQueryParam(buildURLRelativeToBase(quotasBasePath, "users", user.Username, "transfer-usage"), mode)
  831. if err != nil {
  832. return body, err
  833. }
  834. resp, err := sendHTTPRequest(http.MethodPut, url.String(), bytes.NewBuffer(userAsJSON), "application/json",
  835. getDefaultToken())
  836. if err != nil {
  837. return body, err
  838. }
  839. defer resp.Body.Close()
  840. body, _ = getResponseBody(resp)
  841. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  842. }
  843. // GetRetentionChecks returns the active retention checks
  844. func GetRetentionChecks(expectedStatusCode int) ([]common.ActiveRetentionChecks, []byte, error) {
  845. var checks []common.ActiveRetentionChecks
  846. var body []byte
  847. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(retentionChecksPath), nil, "", getDefaultToken())
  848. if err != nil {
  849. return checks, body, err
  850. }
  851. defer resp.Body.Close()
  852. err = checkResponse(resp.StatusCode, expectedStatusCode)
  853. if err == nil && expectedStatusCode == http.StatusOK {
  854. err = render.DecodeJSON(resp.Body, &checks)
  855. } else {
  856. body, _ = getResponseBody(resp)
  857. }
  858. return checks, body, err
  859. }
  860. // StartRetentionCheck starts a new retention check
  861. func StartRetentionCheck(username string, retention []dataprovider.FolderRetention, expectedStatusCode int) ([]byte, error) {
  862. var body []byte
  863. asJSON, _ := json.Marshal(retention)
  864. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(retentionBasePath, username, "check"),
  865. bytes.NewBuffer(asJSON), "application/json", getDefaultToken())
  866. if err != nil {
  867. return body, err
  868. }
  869. defer resp.Body.Close()
  870. body, _ = getResponseBody(resp)
  871. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  872. }
  873. // GetConnections returns status and stats for active SFTP/SCP connections
  874. func GetConnections(expectedStatusCode int) ([]common.ConnectionStatus, []byte, error) {
  875. var connections []common.ConnectionStatus
  876. var body []byte
  877. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(activeConnectionsPath), nil, "", getDefaultToken())
  878. if err != nil {
  879. return connections, body, err
  880. }
  881. defer resp.Body.Close()
  882. err = checkResponse(resp.StatusCode, expectedStatusCode)
  883. if err == nil && expectedStatusCode == http.StatusOK {
  884. err = render.DecodeJSON(resp.Body, &connections)
  885. } else {
  886. body, _ = getResponseBody(resp)
  887. }
  888. return connections, body, err
  889. }
  890. // CloseConnection closes an active connection identified by connectionID
  891. func CloseConnection(connectionID string, expectedStatusCode int) ([]byte, error) {
  892. var body []byte
  893. resp, err := sendHTTPRequest(http.MethodDelete, buildURLRelativeToBase(activeConnectionsPath, connectionID),
  894. nil, "", getDefaultToken())
  895. if err != nil {
  896. return body, err
  897. }
  898. defer resp.Body.Close()
  899. err = checkResponse(resp.StatusCode, expectedStatusCode)
  900. body, _ = getResponseBody(resp)
  901. return body, err
  902. }
  903. // AddFolder adds a new folder and checks the received HTTP Status code against expectedStatusCode
  904. func AddFolder(folder vfs.BaseVirtualFolder, expectedStatusCode int) (vfs.BaseVirtualFolder, []byte, error) {
  905. var newFolder vfs.BaseVirtualFolder
  906. var body []byte
  907. folderAsJSON, _ := json.Marshal(folder)
  908. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(folderPath), bytes.NewBuffer(folderAsJSON),
  909. "application/json", getDefaultToken())
  910. if err != nil {
  911. return newFolder, body, err
  912. }
  913. defer resp.Body.Close()
  914. err = checkResponse(resp.StatusCode, expectedStatusCode)
  915. if expectedStatusCode != http.StatusCreated {
  916. body, _ = getResponseBody(resp)
  917. return newFolder, body, err
  918. }
  919. if err == nil {
  920. err = render.DecodeJSON(resp.Body, &newFolder)
  921. } else {
  922. body, _ = getResponseBody(resp)
  923. }
  924. if err == nil {
  925. err = checkFolder(&folder, &newFolder)
  926. }
  927. return newFolder, body, err
  928. }
  929. // UpdateFolder updates an existing folder and checks the received HTTP Status code against expectedStatusCode.
  930. func UpdateFolder(folder vfs.BaseVirtualFolder, expectedStatusCode int) (vfs.BaseVirtualFolder, []byte, error) {
  931. var updatedFolder vfs.BaseVirtualFolder
  932. var body []byte
  933. folderAsJSON, _ := json.Marshal(folder)
  934. resp, err := sendHTTPRequest(http.MethodPut, buildURLRelativeToBase(folderPath, url.PathEscape(folder.Name)),
  935. bytes.NewBuffer(folderAsJSON), "application/json", getDefaultToken())
  936. if err != nil {
  937. return updatedFolder, body, err
  938. }
  939. defer resp.Body.Close()
  940. body, _ = getResponseBody(resp)
  941. err = checkResponse(resp.StatusCode, expectedStatusCode)
  942. if expectedStatusCode != http.StatusOK {
  943. return updatedFolder, body, err
  944. }
  945. if err == nil {
  946. updatedFolder, body, err = GetFolderByName(folder.Name, expectedStatusCode)
  947. }
  948. if err == nil {
  949. err = checkFolder(&folder, &updatedFolder)
  950. }
  951. return updatedFolder, body, err
  952. }
  953. // RemoveFolder removes an existing user and checks the received HTTP Status code against expectedStatusCode.
  954. func RemoveFolder(folder vfs.BaseVirtualFolder, expectedStatusCode int) ([]byte, error) {
  955. var body []byte
  956. resp, err := sendHTTPRequest(http.MethodDelete, buildURLRelativeToBase(folderPath, url.PathEscape(folder.Name)),
  957. nil, "", getDefaultToken())
  958. if err != nil {
  959. return body, err
  960. }
  961. defer resp.Body.Close()
  962. body, _ = getResponseBody(resp)
  963. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  964. }
  965. // GetFolderByName gets a folder by name and checks the received HTTP Status code against expectedStatusCode.
  966. func GetFolderByName(name string, expectedStatusCode int) (vfs.BaseVirtualFolder, []byte, error) {
  967. var folder vfs.BaseVirtualFolder
  968. var body []byte
  969. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(folderPath, url.PathEscape(name)),
  970. nil, "", getDefaultToken())
  971. if err != nil {
  972. return folder, body, err
  973. }
  974. defer resp.Body.Close()
  975. err = checkResponse(resp.StatusCode, expectedStatusCode)
  976. if err == nil && expectedStatusCode == http.StatusOK {
  977. err = render.DecodeJSON(resp.Body, &folder)
  978. } else {
  979. body, _ = getResponseBody(resp)
  980. }
  981. return folder, body, err
  982. }
  983. // GetFolders returns a list of folders and checks the received HTTP Status code against expectedStatusCode.
  984. // The number of results can be limited specifying a limit.
  985. // Some results can be skipped specifying an offset.
  986. // The results can be filtered specifying a folder path, the folder path filter is an exact match
  987. func GetFolders(limit int64, offset int64, expectedStatusCode int) ([]vfs.BaseVirtualFolder, []byte, error) {
  988. var folders []vfs.BaseVirtualFolder
  989. var body []byte
  990. url, err := addLimitAndOffsetQueryParams(buildURLRelativeToBase(folderPath), limit, offset)
  991. if err != nil {
  992. return folders, body, err
  993. }
  994. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  995. if err != nil {
  996. return folders, body, err
  997. }
  998. defer resp.Body.Close()
  999. err = checkResponse(resp.StatusCode, expectedStatusCode)
  1000. if err == nil && expectedStatusCode == http.StatusOK {
  1001. err = render.DecodeJSON(resp.Body, &folders)
  1002. } else {
  1003. body, _ = getResponseBody(resp)
  1004. }
  1005. return folders, body, err
  1006. }
  1007. // GetFoldersQuotaScans gets active quota scans for folders and checks the received HTTP Status code against expectedStatusCode.
  1008. func GetFoldersQuotaScans(expectedStatusCode int) ([]common.ActiveVirtualFolderQuotaScan, []byte, error) {
  1009. var quotaScans []common.ActiveVirtualFolderQuotaScan
  1010. var body []byte
  1011. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(quotaScanVFolderPath), nil, "", getDefaultToken())
  1012. if err != nil {
  1013. return quotaScans, body, err
  1014. }
  1015. defer resp.Body.Close()
  1016. err = checkResponse(resp.StatusCode, expectedStatusCode)
  1017. if err == nil && expectedStatusCode == http.StatusOK {
  1018. err = render.DecodeJSON(resp.Body, &quotaScans)
  1019. } else {
  1020. body, _ = getResponseBody(resp)
  1021. }
  1022. return quotaScans, body, err
  1023. }
  1024. // StartFolderQuotaScan start a new quota scan for the given folder and checks the received HTTP Status code against expectedStatusCode.
  1025. func StartFolderQuotaScan(folder vfs.BaseVirtualFolder, expectedStatusCode int) ([]byte, error) {
  1026. var body []byte
  1027. resp, err := sendHTTPRequest(http.MethodPost, buildURLRelativeToBase(quotasBasePath, "folders", folder.Name, "scan"),
  1028. nil, "", getDefaultToken())
  1029. if err != nil {
  1030. return body, err
  1031. }
  1032. defer resp.Body.Close()
  1033. body, _ = getResponseBody(resp)
  1034. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  1035. }
  1036. // UpdateFolderQuotaUsage updates the folder used quota limits and checks the received HTTP Status code against expectedStatusCode.
  1037. func UpdateFolderQuotaUsage(folder vfs.BaseVirtualFolder, mode string, expectedStatusCode int) ([]byte, error) {
  1038. var body []byte
  1039. folderAsJSON, _ := json.Marshal(folder)
  1040. url, err := addModeQueryParam(buildURLRelativeToBase(quotasBasePath, "folders", folder.Name, "usage"), mode)
  1041. if err != nil {
  1042. return body, err
  1043. }
  1044. resp, err := sendHTTPRequest(http.MethodPut, url.String(), bytes.NewBuffer(folderAsJSON), "", getDefaultToken())
  1045. if err != nil {
  1046. return body, err
  1047. }
  1048. defer resp.Body.Close()
  1049. body, _ = getResponseBody(resp)
  1050. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  1051. }
  1052. // GetVersion returns version details
  1053. func GetVersion(expectedStatusCode int) (version.Info, []byte, error) {
  1054. var appVersion version.Info
  1055. var body []byte
  1056. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(versionPath), nil, "", getDefaultToken())
  1057. if err != nil {
  1058. return appVersion, body, err
  1059. }
  1060. defer resp.Body.Close()
  1061. err = checkResponse(resp.StatusCode, expectedStatusCode)
  1062. if err == nil && expectedStatusCode == http.StatusOK {
  1063. err = render.DecodeJSON(resp.Body, &appVersion)
  1064. } else {
  1065. body, _ = getResponseBody(resp)
  1066. }
  1067. return appVersion, body, err
  1068. }
  1069. // GetStatus returns the server status
  1070. func GetStatus(expectedStatusCode int) (httpd.ServicesStatus, []byte, error) {
  1071. var response httpd.ServicesStatus
  1072. var body []byte
  1073. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(serverStatusPath), nil, "", getDefaultToken())
  1074. if err != nil {
  1075. return response, body, err
  1076. }
  1077. defer resp.Body.Close()
  1078. err = checkResponse(resp.StatusCode, expectedStatusCode)
  1079. if err == nil && (expectedStatusCode == http.StatusOK) {
  1080. err = render.DecodeJSON(resp.Body, &response)
  1081. } else {
  1082. body, _ = getResponseBody(resp)
  1083. }
  1084. return response, body, err
  1085. }
  1086. // GetDefenderHosts returns hosts that are banned or for which some violations have been detected
  1087. func GetDefenderHosts(expectedStatusCode int) ([]dataprovider.DefenderEntry, []byte, error) {
  1088. var response []dataprovider.DefenderEntry
  1089. var body []byte
  1090. url, err := url.Parse(buildURLRelativeToBase(defenderHosts))
  1091. if err != nil {
  1092. return response, body, err
  1093. }
  1094. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  1095. if err != nil {
  1096. return response, body, err
  1097. }
  1098. defer resp.Body.Close()
  1099. err = checkResponse(resp.StatusCode, expectedStatusCode)
  1100. if err == nil && expectedStatusCode == http.StatusOK {
  1101. err = render.DecodeJSON(resp.Body, &response)
  1102. } else {
  1103. body, _ = getResponseBody(resp)
  1104. }
  1105. return response, body, err
  1106. }
  1107. // GetDefenderHostByIP returns the host with the given IP, if it exists
  1108. func GetDefenderHostByIP(ip string, expectedStatusCode int) (dataprovider.DefenderEntry, []byte, error) {
  1109. var host dataprovider.DefenderEntry
  1110. var body []byte
  1111. id := hex.EncodeToString([]byte(ip))
  1112. resp, err := sendHTTPRequest(http.MethodGet, buildURLRelativeToBase(defenderHosts, id),
  1113. nil, "", getDefaultToken())
  1114. if err != nil {
  1115. return host, body, err
  1116. }
  1117. defer resp.Body.Close()
  1118. err = checkResponse(resp.StatusCode, expectedStatusCode)
  1119. if err == nil && expectedStatusCode == http.StatusOK {
  1120. err = render.DecodeJSON(resp.Body, &host)
  1121. } else {
  1122. body, _ = getResponseBody(resp)
  1123. }
  1124. return host, body, err
  1125. }
  1126. // RemoveDefenderHostByIP removes the host with the given IP from the defender list
  1127. func RemoveDefenderHostByIP(ip string, expectedStatusCode int) ([]byte, error) {
  1128. var body []byte
  1129. id := hex.EncodeToString([]byte(ip))
  1130. resp, err := sendHTTPRequest(http.MethodDelete, buildURLRelativeToBase(defenderHosts, id), nil, "", getDefaultToken())
  1131. if err != nil {
  1132. return body, err
  1133. }
  1134. defer resp.Body.Close()
  1135. body, _ = getResponseBody(resp)
  1136. return body, checkResponse(resp.StatusCode, expectedStatusCode)
  1137. }
  1138. // Dumpdata requests a backup to outputFile.
  1139. // outputFile is relative to the configured backups_path
  1140. func Dumpdata(outputFile, outputData, indent string, expectedStatusCode int) (map[string]any, []byte, error) {
  1141. var response map[string]any
  1142. var body []byte
  1143. url, err := url.Parse(buildURLRelativeToBase(dumpDataPath))
  1144. if err != nil {
  1145. return response, body, err
  1146. }
  1147. q := url.Query()
  1148. if outputData != "" {
  1149. q.Add("output-data", outputData)
  1150. }
  1151. if outputFile != "" {
  1152. q.Add("output-file", outputFile)
  1153. }
  1154. if indent != "" {
  1155. q.Add("indent", indent)
  1156. }
  1157. url.RawQuery = q.Encode()
  1158. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  1159. if err != nil {
  1160. return response, body, err
  1161. }
  1162. defer resp.Body.Close()
  1163. err = checkResponse(resp.StatusCode, expectedStatusCode)
  1164. if err == nil && expectedStatusCode == http.StatusOK {
  1165. err = render.DecodeJSON(resp.Body, &response)
  1166. } else {
  1167. body, _ = getResponseBody(resp)
  1168. }
  1169. return response, body, err
  1170. }
  1171. // Loaddata restores a backup.
  1172. func Loaddata(inputFile, scanQuota, mode string, expectedStatusCode int) (map[string]any, []byte, error) {
  1173. var response map[string]any
  1174. var body []byte
  1175. url, err := url.Parse(buildURLRelativeToBase(loadDataPath))
  1176. if err != nil {
  1177. return response, body, err
  1178. }
  1179. q := url.Query()
  1180. q.Add("input-file", inputFile)
  1181. if scanQuota != "" {
  1182. q.Add("scan-quota", scanQuota)
  1183. }
  1184. if mode != "" {
  1185. q.Add("mode", mode)
  1186. }
  1187. url.RawQuery = q.Encode()
  1188. resp, err := sendHTTPRequest(http.MethodGet, url.String(), nil, "", getDefaultToken())
  1189. if err != nil {
  1190. return response, body, err
  1191. }
  1192. defer resp.Body.Close()
  1193. err = checkResponse(resp.StatusCode, expectedStatusCode)
  1194. if err == nil && expectedStatusCode == http.StatusOK {
  1195. err = render.DecodeJSON(resp.Body, &response)
  1196. } else {
  1197. body, _ = getResponseBody(resp)
  1198. }
  1199. return response, body, err
  1200. }
  1201. // LoaddataFromPostBody restores a backup
  1202. func LoaddataFromPostBody(data []byte, scanQuota, mode string, expectedStatusCode int) (map[string]any, []byte, error) {
  1203. var response map[string]any
  1204. var body []byte
  1205. url, err := url.Parse(buildURLRelativeToBase(loadDataPath))
  1206. if err != nil {
  1207. return response, body, err
  1208. }
  1209. q := url.Query()
  1210. if scanQuota != "" {
  1211. q.Add("scan-quota", scanQuota)
  1212. }
  1213. if mode != "" {
  1214. q.Add("mode", mode)
  1215. }
  1216. url.RawQuery = q.Encode()
  1217. resp, err := sendHTTPRequest(http.MethodPost, url.String(), bytes.NewReader(data), "", getDefaultToken())
  1218. if err != nil {
  1219. return response, body, err
  1220. }
  1221. defer resp.Body.Close()
  1222. err = checkResponse(resp.StatusCode, expectedStatusCode)
  1223. if err == nil && expectedStatusCode == http.StatusOK {
  1224. err = render.DecodeJSON(resp.Body, &response)
  1225. } else {
  1226. body, _ = getResponseBody(resp)
  1227. }
  1228. return response, body, err
  1229. }
  1230. func checkResponse(actual int, expected int) error {
  1231. if expected != actual {
  1232. return fmt.Errorf("wrong status code: got %v want %v", actual, expected)
  1233. }
  1234. return nil
  1235. }
  1236. func getResponseBody(resp *http.Response) ([]byte, error) {
  1237. return io.ReadAll(resp.Body)
  1238. }
  1239. func checkEventAction(expected, actual dataprovider.BaseEventAction) error {
  1240. if expected.ID <= 0 {
  1241. if actual.ID <= 0 {
  1242. return errors.New("actual action ID must be > 0")
  1243. }
  1244. } else {
  1245. if actual.ID != expected.ID {
  1246. return errors.New("action ID mismatch")
  1247. }
  1248. }
  1249. if dataprovider.ConvertName(expected.Name) != actual.Name {
  1250. return errors.New("name mismatch")
  1251. }
  1252. if expected.Description != actual.Description {
  1253. return errors.New("description mismatch")
  1254. }
  1255. if expected.Type != actual.Type {
  1256. return errors.New("type mismatch")
  1257. }
  1258. if err := compareEventActionCmdConfigFields(expected.Options.CmdConfig, actual.Options.CmdConfig); err != nil {
  1259. return err
  1260. }
  1261. if err := compareEventActionEmailConfigFields(expected.Options.EmailConfig, actual.Options.EmailConfig); err != nil {
  1262. return err
  1263. }
  1264. if err := compareEventActionDataRetentionFields(expected.Options.RetentionConfig, actual.Options.RetentionConfig); err != nil {
  1265. return err
  1266. }
  1267. if err := compareEventActionFsConfigFields(expected.Options.FsConfig, actual.Options.FsConfig); err != nil {
  1268. return err
  1269. }
  1270. return compareEventActionHTTPConfigFields(expected.Options.HTTPConfig, actual.Options.HTTPConfig)
  1271. }
  1272. func checkEventSchedules(expected, actual []dataprovider.Schedule) error {
  1273. if len(expected) != len(actual) {
  1274. return errors.New("schedules mismatch")
  1275. }
  1276. for _, ex := range expected {
  1277. found := false
  1278. for _, ac := range actual {
  1279. if ac.DayOfMonth == ex.DayOfMonth && ac.DayOfWeek == ex.DayOfWeek && ac.Hours == ex.Hours && ac.Month == ex.Month {
  1280. found = true
  1281. break
  1282. }
  1283. }
  1284. if !found {
  1285. return errors.New("schedules content mismatch")
  1286. }
  1287. }
  1288. return nil
  1289. }
  1290. func compareConditionPatternOptions(expected, actual []dataprovider.ConditionPattern) error {
  1291. if len(expected) != len(actual) {
  1292. return errors.New("condition pattern mismatch")
  1293. }
  1294. for _, ex := range expected {
  1295. found := false
  1296. for _, ac := range actual {
  1297. if ac.Pattern == ex.Pattern && ac.InverseMatch == ex.InverseMatch {
  1298. found = true
  1299. break
  1300. }
  1301. }
  1302. if !found {
  1303. return errors.New("condition pattern content mismatch")
  1304. }
  1305. }
  1306. return nil
  1307. }
  1308. func checkEventConditionOptions(expected, actual dataprovider.ConditionOptions) error {
  1309. if err := compareConditionPatternOptions(expected.Names, actual.Names); err != nil {
  1310. return errors.New("condition names mismatch")
  1311. }
  1312. if err := compareConditionPatternOptions(expected.GroupNames, actual.GroupNames); err != nil {
  1313. return errors.New("condition group names mismatch")
  1314. }
  1315. if err := compareConditionPatternOptions(expected.FsPaths, actual.FsPaths); err != nil {
  1316. return errors.New("condition fs_paths mismatch")
  1317. }
  1318. if len(expected.Protocols) != len(actual.Protocols) {
  1319. return errors.New("condition protocols mismatch")
  1320. }
  1321. for _, v := range expected.Protocols {
  1322. if !util.Contains(actual.Protocols, v) {
  1323. return errors.New("condition protocols content mismatch")
  1324. }
  1325. }
  1326. if len(expected.ProviderObjects) != len(actual.ProviderObjects) {
  1327. return errors.New("condition provider objects mismatch")
  1328. }
  1329. for _, v := range expected.ProviderObjects {
  1330. if !util.Contains(actual.ProviderObjects, v) {
  1331. return errors.New("condition provider objects content mismatch")
  1332. }
  1333. }
  1334. if expected.MinFileSize != actual.MinFileSize {
  1335. return errors.New("condition min file size mismatch")
  1336. }
  1337. if expected.MaxFileSize != actual.MaxFileSize {
  1338. return errors.New("condition max file size mismatch")
  1339. }
  1340. return nil
  1341. }
  1342. func checkEventConditions(expected, actual dataprovider.EventConditions) error {
  1343. if len(expected.FsEvents) != len(actual.FsEvents) {
  1344. return errors.New("fs events mismatch")
  1345. }
  1346. for _, v := range expected.FsEvents {
  1347. if !util.Contains(actual.FsEvents, v) {
  1348. return errors.New("fs events content mismatch")
  1349. }
  1350. }
  1351. if len(expected.ProviderEvents) != len(actual.ProviderEvents) {
  1352. return errors.New("provider events mismatch")
  1353. }
  1354. for _, v := range expected.ProviderEvents {
  1355. if !util.Contains(actual.ProviderEvents, v) {
  1356. return errors.New("provider events content mismatch")
  1357. }
  1358. }
  1359. if err := checkEventConditionOptions(expected.Options, actual.Options); err != nil {
  1360. return err
  1361. }
  1362. return checkEventSchedules(expected.Schedules, actual.Schedules)
  1363. }
  1364. func checkEventRuleActions(expected, actual []dataprovider.EventAction) error {
  1365. if len(expected) != len(actual) {
  1366. return errors.New("actions mismatch")
  1367. }
  1368. for _, ex := range expected {
  1369. found := false
  1370. for _, ac := range actual {
  1371. if ex.Name == ac.Name && ex.Order == ac.Order && ex.Options.ExecuteSync == ac.Options.ExecuteSync &&
  1372. ex.Options.IsFailureAction == ac.Options.IsFailureAction && ex.Options.StopOnFailure == ac.Options.StopOnFailure {
  1373. found = true
  1374. break
  1375. }
  1376. }
  1377. if !found {
  1378. return errors.New("actions contents mismatch")
  1379. }
  1380. }
  1381. return nil
  1382. }
  1383. func checkEventRule(expected, actual dataprovider.EventRule) error {
  1384. if expected.ID <= 0 {
  1385. if actual.ID <= 0 {
  1386. return errors.New("actual group ID must be > 0")
  1387. }
  1388. } else {
  1389. if actual.ID != expected.ID {
  1390. return errors.New("group ID mismatch")
  1391. }
  1392. }
  1393. if dataprovider.ConvertName(expected.Name) != actual.Name {
  1394. return errors.New("name mismatch")
  1395. }
  1396. if expected.Description != actual.Description {
  1397. return errors.New("description mismatch")
  1398. }
  1399. if actual.CreatedAt == 0 {
  1400. return errors.New("created_at unset")
  1401. }
  1402. if actual.UpdatedAt == 0 {
  1403. return errors.New("updated_at unset")
  1404. }
  1405. if expected.Trigger != actual.Trigger {
  1406. return errors.New("trigger mismatch")
  1407. }
  1408. if err := checkEventConditions(expected.Conditions, actual.Conditions); err != nil {
  1409. return err
  1410. }
  1411. return checkEventRuleActions(expected.Actions, actual.Actions)
  1412. }
  1413. func checkGroup(expected, actual dataprovider.Group) error {
  1414. if expected.ID <= 0 {
  1415. if actual.ID <= 0 {
  1416. return errors.New("actual group ID must be > 0")
  1417. }
  1418. } else {
  1419. if actual.ID != expected.ID {
  1420. return errors.New("group ID mismatch")
  1421. }
  1422. }
  1423. if dataprovider.ConvertName(expected.Name) != actual.Name {
  1424. return errors.New("name mismatch")
  1425. }
  1426. if expected.Description != actual.Description {
  1427. return errors.New("description mismatch")
  1428. }
  1429. if actual.CreatedAt == 0 {
  1430. return errors.New("created_at unset")
  1431. }
  1432. if actual.UpdatedAt == 0 {
  1433. return errors.New("updated_at unset")
  1434. }
  1435. if err := compareEqualGroupSettingsFields(expected.UserSettings.BaseGroupUserSettings,
  1436. actual.UserSettings.BaseGroupUserSettings); err != nil {
  1437. return err
  1438. }
  1439. if err := compareVirtualFolders(expected.VirtualFolders, actual.VirtualFolders); err != nil {
  1440. return err
  1441. }
  1442. if err := compareUserFilters(expected.UserSettings.Filters, actual.UserSettings.Filters); err != nil {
  1443. return err
  1444. }
  1445. return compareFsConfig(&expected.UserSettings.FsConfig, &actual.UserSettings.FsConfig)
  1446. }
  1447. func checkFolder(expected *vfs.BaseVirtualFolder, actual *vfs.BaseVirtualFolder) error {
  1448. if expected.ID <= 0 {
  1449. if actual.ID <= 0 {
  1450. return errors.New("actual folder ID must be > 0")
  1451. }
  1452. } else {
  1453. if actual.ID != expected.ID {
  1454. return errors.New("folder ID mismatch")
  1455. }
  1456. }
  1457. if dataprovider.ConvertName(expected.Name) != actual.Name {
  1458. return errors.New("name mismatch")
  1459. }
  1460. if expected.MappedPath != actual.MappedPath {
  1461. return errors.New("mapped path mismatch")
  1462. }
  1463. if expected.Description != actual.Description {
  1464. return errors.New("description mismatch")
  1465. }
  1466. return compareFsConfig(&expected.FsConfig, &actual.FsConfig)
  1467. }
  1468. func checkAPIKey(expected, actual *dataprovider.APIKey) error {
  1469. if actual.Key != "" {
  1470. return errors.New("key must not be visible")
  1471. }
  1472. if actual.KeyID == "" {
  1473. return errors.New("actual key_id cannot be empty")
  1474. }
  1475. if expected.Name != actual.Name {
  1476. return errors.New("name mismatch")
  1477. }
  1478. if expected.Scope != actual.Scope {
  1479. return errors.New("scope mismatch")
  1480. }
  1481. if actual.CreatedAt == 0 {
  1482. return errors.New("created_at cannot be 0")
  1483. }
  1484. if actual.UpdatedAt == 0 {
  1485. return errors.New("updated_at cannot be 0")
  1486. }
  1487. if expected.ExpiresAt != actual.ExpiresAt {
  1488. return errors.New("expires_at mismatch")
  1489. }
  1490. if expected.Description != actual.Description {
  1491. return errors.New("description mismatch")
  1492. }
  1493. if expected.User != actual.User {
  1494. return errors.New("user mismatch")
  1495. }
  1496. if expected.Admin != actual.Admin {
  1497. return errors.New("admin mismatch")
  1498. }
  1499. return nil
  1500. }
  1501. func checkAdmin(expected, actual *dataprovider.Admin) error {
  1502. if actual.Password != "" {
  1503. return errors.New("admin password must not be visible")
  1504. }
  1505. if expected.ID <= 0 {
  1506. if actual.ID <= 0 {
  1507. return errors.New("actual admin ID must be > 0")
  1508. }
  1509. } else {
  1510. if actual.ID != expected.ID {
  1511. return errors.New("admin ID mismatch")
  1512. }
  1513. }
  1514. if expected.CreatedAt > 0 {
  1515. if expected.CreatedAt != actual.CreatedAt {
  1516. return fmt.Errorf("created_at mismatch %v != %v", expected.CreatedAt, actual.CreatedAt)
  1517. }
  1518. }
  1519. if err := compareAdminEqualFields(expected, actual); err != nil {
  1520. return err
  1521. }
  1522. if len(expected.Permissions) != len(actual.Permissions) {
  1523. return errors.New("permissions mismatch")
  1524. }
  1525. for _, p := range expected.Permissions {
  1526. if !util.Contains(actual.Permissions, p) {
  1527. return errors.New("permissions content mismatch")
  1528. }
  1529. }
  1530. if err := compareAdminFilters(expected.Filters, actual.Filters); err != nil {
  1531. return err
  1532. }
  1533. return compareAdminGroups(expected, actual)
  1534. }
  1535. func compareAdminFilters(expected, actual dataprovider.AdminFilters) error {
  1536. if expected.AllowAPIKeyAuth != actual.AllowAPIKeyAuth {
  1537. return errors.New("allow_api_key_auth mismatch")
  1538. }
  1539. if len(expected.AllowList) != len(actual.AllowList) {
  1540. return errors.New("allow list mismatch")
  1541. }
  1542. for _, v := range expected.AllowList {
  1543. if !util.Contains(actual.AllowList, v) {
  1544. return errors.New("allow list content mismatch")
  1545. }
  1546. }
  1547. if expected.Preferences.HideUserPageSections != actual.Preferences.HideUserPageSections {
  1548. return errors.New("hide user page sections mismatch")
  1549. }
  1550. return nil
  1551. }
  1552. func compareAdminEqualFields(expected *dataprovider.Admin, actual *dataprovider.Admin) error {
  1553. if dataprovider.ConvertName(expected.Username) != actual.Username {
  1554. return errors.New("sername mismatch")
  1555. }
  1556. if expected.Email != actual.Email {
  1557. return errors.New("email mismatch")
  1558. }
  1559. if expected.Status != actual.Status {
  1560. return errors.New("status mismatch")
  1561. }
  1562. if expected.Description != actual.Description {
  1563. return errors.New("description mismatch")
  1564. }
  1565. if expected.AdditionalInfo != actual.AdditionalInfo {
  1566. return errors.New("additional info mismatch")
  1567. }
  1568. return nil
  1569. }
  1570. func checkUser(expected *dataprovider.User, actual *dataprovider.User) error {
  1571. if actual.Password != "" {
  1572. return errors.New("user password must not be visible")
  1573. }
  1574. if expected.ID <= 0 {
  1575. if actual.ID <= 0 {
  1576. return errors.New("actual user ID must be > 0")
  1577. }
  1578. } else {
  1579. if actual.ID != expected.ID {
  1580. return errors.New("user ID mismatch")
  1581. }
  1582. }
  1583. if expected.CreatedAt > 0 {
  1584. if expected.CreatedAt != actual.CreatedAt {
  1585. return fmt.Errorf("created_at mismatch %v != %v", expected.CreatedAt, actual.CreatedAt)
  1586. }
  1587. }
  1588. if expected.Email != actual.Email {
  1589. return errors.New("email mismatch")
  1590. }
  1591. if err := compareUserPermissions(expected.Permissions, actual.Permissions); err != nil {
  1592. return err
  1593. }
  1594. if err := compareUserFilters(expected.Filters.BaseUserFilters, actual.Filters.BaseUserFilters); err != nil {
  1595. return err
  1596. }
  1597. if err := compareFsConfig(&expected.FsConfig, &actual.FsConfig); err != nil {
  1598. return err
  1599. }
  1600. if err := compareUserGroups(expected, actual); err != nil {
  1601. return err
  1602. }
  1603. if err := compareVirtualFolders(expected.VirtualFolders, actual.VirtualFolders); err != nil {
  1604. return err
  1605. }
  1606. return compareEqualsUserFields(expected, actual)
  1607. }
  1608. func compareUserPermissions(expected map[string][]string, actual map[string][]string) error {
  1609. if len(expected) != len(actual) {
  1610. return errors.New("permissions mismatch")
  1611. }
  1612. for dir, perms := range expected {
  1613. if actualPerms, ok := actual[dir]; ok {
  1614. for _, v := range actualPerms {
  1615. if !util.Contains(perms, v) {
  1616. return errors.New("permissions contents mismatch")
  1617. }
  1618. }
  1619. } else {
  1620. return errors.New("permissions directories mismatch")
  1621. }
  1622. }
  1623. return nil
  1624. }
  1625. func compareAdminGroups(expected *dataprovider.Admin, actual *dataprovider.Admin) error {
  1626. if len(actual.Groups) != len(expected.Groups) {
  1627. return errors.New("groups len mismatch")
  1628. }
  1629. for _, g := range actual.Groups {
  1630. found := false
  1631. for _, g1 := range expected.Groups {
  1632. if g1.Name == g.Name {
  1633. found = true
  1634. if g1.Options.AddToUsersAs != g.Options.AddToUsersAs {
  1635. return fmt.Errorf("add to users as field mismatch for group %s", g.Name)
  1636. }
  1637. }
  1638. }
  1639. if !found {
  1640. return errors.New("groups mismatch")
  1641. }
  1642. }
  1643. return nil
  1644. }
  1645. func compareUserGroups(expected *dataprovider.User, actual *dataprovider.User) error {
  1646. if len(actual.Groups) != len(expected.Groups) {
  1647. return errors.New("groups len mismatch")
  1648. }
  1649. for _, g := range actual.Groups {
  1650. found := false
  1651. for _, g1 := range expected.Groups {
  1652. if g1.Name == g.Name {
  1653. found = true
  1654. if g1.Type != g.Type {
  1655. return fmt.Errorf("type mismatch for group %s", g.Name)
  1656. }
  1657. }
  1658. }
  1659. if !found {
  1660. return errors.New("groups mismatch")
  1661. }
  1662. }
  1663. return nil
  1664. }
  1665. func compareVirtualFolders(expected []vfs.VirtualFolder, actual []vfs.VirtualFolder) error {
  1666. if len(actual) != len(expected) {
  1667. return errors.New("virtual folders len mismatch")
  1668. }
  1669. for _, v := range actual {
  1670. found := false
  1671. for _, v1 := range expected {
  1672. if path.Clean(v.VirtualPath) == path.Clean(v1.VirtualPath) {
  1673. if err := checkFolder(&v1.BaseVirtualFolder, &v.BaseVirtualFolder); err != nil {
  1674. return err
  1675. }
  1676. if v.QuotaSize != v1.QuotaSize {
  1677. return errors.New("vfolder quota size mismatch")
  1678. }
  1679. if (v.QuotaFiles) != (v1.QuotaFiles) {
  1680. return errors.New("vfolder quota files mismatch")
  1681. }
  1682. found = true
  1683. break
  1684. }
  1685. }
  1686. if !found {
  1687. return errors.New("virtual folders mismatch")
  1688. }
  1689. }
  1690. return nil
  1691. }
  1692. func compareFsConfig(expected *vfs.Filesystem, actual *vfs.Filesystem) error {
  1693. if expected.Provider != actual.Provider {
  1694. return errors.New("fs provider mismatch")
  1695. }
  1696. if err := compareS3Config(expected, actual); err != nil {
  1697. return err
  1698. }
  1699. if err := compareGCSConfig(expected, actual); err != nil {
  1700. return err
  1701. }
  1702. if err := compareAzBlobConfig(expected, actual); err != nil {
  1703. return err
  1704. }
  1705. if err := checkEncryptedSecret(expected.CryptConfig.Passphrase, actual.CryptConfig.Passphrase); err != nil {
  1706. return err
  1707. }
  1708. if err := compareSFTPFsConfig(expected, actual); err != nil {
  1709. return err
  1710. }
  1711. return compareHTTPFsConfig(expected, actual)
  1712. }
  1713. func compareS3Config(expected *vfs.Filesystem, actual *vfs.Filesystem) error { //nolint:gocyclo
  1714. if expected.S3Config.Bucket != actual.S3Config.Bucket {
  1715. return errors.New("fs S3 bucket mismatch")
  1716. }
  1717. if expected.S3Config.Region != actual.S3Config.Region {
  1718. return errors.New("fs S3 region mismatch")
  1719. }
  1720. if expected.S3Config.AccessKey != actual.S3Config.AccessKey {
  1721. return errors.New("fs S3 access key mismatch")
  1722. }
  1723. if expected.S3Config.RoleARN != actual.S3Config.RoleARN {
  1724. return errors.New("fs S3 role ARN mismatch")
  1725. }
  1726. if err := checkEncryptedSecret(expected.S3Config.AccessSecret, actual.S3Config.AccessSecret); err != nil {
  1727. return fmt.Errorf("fs S3 access secret mismatch: %v", err)
  1728. }
  1729. if expected.S3Config.Endpoint != actual.S3Config.Endpoint {
  1730. return errors.New("fs S3 endpoint mismatch")
  1731. }
  1732. if expected.S3Config.StorageClass != actual.S3Config.StorageClass {
  1733. return errors.New("fs S3 storage class mismatch")
  1734. }
  1735. if expected.S3Config.ACL != actual.S3Config.ACL {
  1736. return errors.New("fs S3 ACL mismatch")
  1737. }
  1738. if expected.S3Config.UploadPartSize != actual.S3Config.UploadPartSize {
  1739. return errors.New("fs S3 upload part size mismatch")
  1740. }
  1741. if expected.S3Config.UploadConcurrency != actual.S3Config.UploadConcurrency {
  1742. return errors.New("fs S3 upload concurrency mismatch")
  1743. }
  1744. if expected.S3Config.DownloadPartSize != actual.S3Config.DownloadPartSize {
  1745. return errors.New("fs S3 download part size mismatch")
  1746. }
  1747. if expected.S3Config.DownloadConcurrency != actual.S3Config.DownloadConcurrency {
  1748. return errors.New("fs S3 download concurrency mismatch")
  1749. }
  1750. if expected.S3Config.ForcePathStyle != actual.S3Config.ForcePathStyle {
  1751. return errors.New("fs S3 force path style mismatch")
  1752. }
  1753. if expected.S3Config.DownloadPartMaxTime != actual.S3Config.DownloadPartMaxTime {
  1754. return errors.New("fs S3 download part max time mismatch")
  1755. }
  1756. if expected.S3Config.UploadPartMaxTime != actual.S3Config.UploadPartMaxTime {
  1757. return errors.New("fs S3 upload part max time mismatch")
  1758. }
  1759. if expected.S3Config.KeyPrefix != actual.S3Config.KeyPrefix &&
  1760. expected.S3Config.KeyPrefix+"/" != actual.S3Config.KeyPrefix {
  1761. return errors.New("fs S3 key prefix mismatch")
  1762. }
  1763. return nil
  1764. }
  1765. func compareGCSConfig(expected *vfs.Filesystem, actual *vfs.Filesystem) error {
  1766. if expected.GCSConfig.Bucket != actual.GCSConfig.Bucket {
  1767. return errors.New("GCS bucket mismatch")
  1768. }
  1769. if expected.GCSConfig.StorageClass != actual.GCSConfig.StorageClass {
  1770. return errors.New("GCS storage class mismatch")
  1771. }
  1772. if expected.GCSConfig.ACL != actual.GCSConfig.ACL {
  1773. return errors.New("GCS ACL mismatch")
  1774. }
  1775. if expected.GCSConfig.KeyPrefix != actual.GCSConfig.KeyPrefix &&
  1776. expected.GCSConfig.KeyPrefix+"/" != actual.GCSConfig.KeyPrefix {
  1777. return errors.New("GCS key prefix mismatch")
  1778. }
  1779. if expected.GCSConfig.AutomaticCredentials != actual.GCSConfig.AutomaticCredentials {
  1780. return errors.New("GCS automatic credentials mismatch")
  1781. }
  1782. return nil
  1783. }
  1784. func compareHTTPFsConfig(expected *vfs.Filesystem, actual *vfs.Filesystem) error {
  1785. if expected.HTTPConfig.Endpoint != actual.HTTPConfig.Endpoint {
  1786. return errors.New("HTTPFs endpoint mismatch")
  1787. }
  1788. if expected.HTTPConfig.Username != actual.HTTPConfig.Username {
  1789. return errors.New("HTTPFs username mismatch")
  1790. }
  1791. if expected.HTTPConfig.SkipTLSVerify != actual.HTTPConfig.SkipTLSVerify {
  1792. return errors.New("HTTPFs skip_tls_verify mismatch")
  1793. }
  1794. if expected.SFTPConfig.EqualityCheckMode != actual.SFTPConfig.EqualityCheckMode {
  1795. return errors.New("HTTPFs equality_check_mode mismatch")
  1796. }
  1797. if err := checkEncryptedSecret(expected.HTTPConfig.Password, actual.HTTPConfig.Password); err != nil {
  1798. return fmt.Errorf("HTTPFs password mismatch: %v", err)
  1799. }
  1800. if err := checkEncryptedSecret(expected.HTTPConfig.APIKey, actual.HTTPConfig.APIKey); err != nil {
  1801. return fmt.Errorf("HTTPFs API key mismatch: %v", err)
  1802. }
  1803. return nil
  1804. }
  1805. func compareSFTPFsConfig(expected *vfs.Filesystem, actual *vfs.Filesystem) error {
  1806. if expected.SFTPConfig.Endpoint != actual.SFTPConfig.Endpoint {
  1807. return errors.New("SFTPFs endpoint mismatch")
  1808. }
  1809. if expected.SFTPConfig.Username != actual.SFTPConfig.Username {
  1810. return errors.New("SFTPFs username mismatch")
  1811. }
  1812. if expected.SFTPConfig.DisableCouncurrentReads != actual.SFTPConfig.DisableCouncurrentReads {
  1813. return errors.New("SFTPFs disable_concurrent_reads mismatch")
  1814. }
  1815. if expected.SFTPConfig.BufferSize != actual.SFTPConfig.BufferSize {
  1816. return errors.New("SFTPFs buffer_size mismatch")
  1817. }
  1818. if expected.SFTPConfig.EqualityCheckMode != actual.SFTPConfig.EqualityCheckMode {
  1819. return errors.New("SFTPFs equality_check_mode mismatch")
  1820. }
  1821. if err := checkEncryptedSecret(expected.SFTPConfig.Password, actual.SFTPConfig.Password); err != nil {
  1822. return fmt.Errorf("SFTPFs password mismatch: %v", err)
  1823. }
  1824. if err := checkEncryptedSecret(expected.SFTPConfig.PrivateKey, actual.SFTPConfig.PrivateKey); err != nil {
  1825. return fmt.Errorf("SFTPFs private key mismatch: %v", err)
  1826. }
  1827. if err := checkEncryptedSecret(expected.SFTPConfig.KeyPassphrase, actual.SFTPConfig.KeyPassphrase); err != nil {
  1828. return fmt.Errorf("SFTPFs private key passphrase mismatch: %v", err)
  1829. }
  1830. if expected.SFTPConfig.Prefix != actual.SFTPConfig.Prefix {
  1831. if expected.SFTPConfig.Prefix != "" && actual.SFTPConfig.Prefix != "/" {
  1832. return errors.New("SFTPFs prefix mismatch")
  1833. }
  1834. }
  1835. if len(expected.SFTPConfig.Fingerprints) != len(actual.SFTPConfig.Fingerprints) {
  1836. return errors.New("SFTPFs fingerprints mismatch")
  1837. }
  1838. for _, value := range actual.SFTPConfig.Fingerprints {
  1839. if !util.Contains(expected.SFTPConfig.Fingerprints, value) {
  1840. return errors.New("SFTPFs fingerprints mismatch")
  1841. }
  1842. }
  1843. return nil
  1844. }
  1845. func compareAzBlobConfig(expected *vfs.Filesystem, actual *vfs.Filesystem) error {
  1846. if expected.AzBlobConfig.Container != actual.AzBlobConfig.Container {
  1847. return errors.New("azure Blob container mismatch")
  1848. }
  1849. if expected.AzBlobConfig.AccountName != actual.AzBlobConfig.AccountName {
  1850. return errors.New("azure Blob account name mismatch")
  1851. }
  1852. if err := checkEncryptedSecret(expected.AzBlobConfig.AccountKey, actual.AzBlobConfig.AccountKey); err != nil {
  1853. return fmt.Errorf("azure Blob account key mismatch: %v", err)
  1854. }
  1855. if expected.AzBlobConfig.Endpoint != actual.AzBlobConfig.Endpoint {
  1856. return errors.New("azure Blob endpoint mismatch")
  1857. }
  1858. if err := checkEncryptedSecret(expected.AzBlobConfig.SASURL, actual.AzBlobConfig.SASURL); err != nil {
  1859. return fmt.Errorf("azure Blob SAS URL mismatch: %v", err)
  1860. }
  1861. if expected.AzBlobConfig.UploadPartSize != actual.AzBlobConfig.UploadPartSize {
  1862. return errors.New("azure Blob upload part size mismatch")
  1863. }
  1864. if expected.AzBlobConfig.UploadConcurrency != actual.AzBlobConfig.UploadConcurrency {
  1865. return errors.New("azure Blob upload concurrency mismatch")
  1866. }
  1867. if expected.AzBlobConfig.DownloadPartSize != actual.AzBlobConfig.DownloadPartSize {
  1868. return errors.New("azure Blob download part size mismatch")
  1869. }
  1870. if expected.AzBlobConfig.DownloadConcurrency != actual.AzBlobConfig.DownloadConcurrency {
  1871. return errors.New("azure Blob download concurrency mismatch")
  1872. }
  1873. if expected.AzBlobConfig.KeyPrefix != actual.AzBlobConfig.KeyPrefix &&
  1874. expected.AzBlobConfig.KeyPrefix+"/" != actual.AzBlobConfig.KeyPrefix {
  1875. return errors.New("azure Blob key prefix mismatch")
  1876. }
  1877. if expected.AzBlobConfig.UseEmulator != actual.AzBlobConfig.UseEmulator {
  1878. return errors.New("azure Blob use emulator mismatch")
  1879. }
  1880. if expected.AzBlobConfig.AccessTier != actual.AzBlobConfig.AccessTier {
  1881. return errors.New("azure Blob access tier mismatch")
  1882. }
  1883. return nil
  1884. }
  1885. func areSecretEquals(expected, actual *kms.Secret) bool {
  1886. if expected == nil && actual == nil {
  1887. return true
  1888. }
  1889. if expected != nil && expected.IsEmpty() && actual == nil {
  1890. return true
  1891. }
  1892. if actual != nil && actual.IsEmpty() && expected == nil {
  1893. return true
  1894. }
  1895. return false
  1896. }
  1897. func checkEncryptedSecret(expected, actual *kms.Secret) error {
  1898. if areSecretEquals(expected, actual) {
  1899. return nil
  1900. }
  1901. if expected == nil && actual != nil && !actual.IsEmpty() {
  1902. return errors.New("secret mismatch")
  1903. }
  1904. if actual == nil && expected != nil && !expected.IsEmpty() {
  1905. return errors.New("secret mismatch")
  1906. }
  1907. if expected.IsPlain() && actual.IsEncrypted() {
  1908. if actual.GetPayload() == "" {
  1909. return errors.New("invalid secret payload")
  1910. }
  1911. if actual.GetAdditionalData() != "" {
  1912. return errors.New("invalid secret additional data")
  1913. }
  1914. if actual.GetKey() != "" {
  1915. return errors.New("invalid secret key")
  1916. }
  1917. } else {
  1918. if expected.GetStatus() != actual.GetStatus() || expected.GetPayload() != actual.GetPayload() {
  1919. return errors.New("secret mismatch")
  1920. }
  1921. }
  1922. return nil
  1923. }
  1924. func compareUserFilterSubStructs(expected sdk.BaseUserFilters, actual sdk.BaseUserFilters) error {
  1925. for _, IPMask := range expected.AllowedIP {
  1926. if !util.Contains(actual.AllowedIP, IPMask) {
  1927. return errors.New("allowed IP contents mismatch")
  1928. }
  1929. }
  1930. for _, IPMask := range expected.DeniedIP {
  1931. if !util.Contains(actual.DeniedIP, IPMask) {
  1932. return errors.New("denied IP contents mismatch")
  1933. }
  1934. }
  1935. for _, method := range expected.DeniedLoginMethods {
  1936. if !util.Contains(actual.DeniedLoginMethods, method) {
  1937. return errors.New("denied login methods contents mismatch")
  1938. }
  1939. }
  1940. for _, protocol := range expected.DeniedProtocols {
  1941. if !util.Contains(actual.DeniedProtocols, protocol) {
  1942. return errors.New("denied protocols contents mismatch")
  1943. }
  1944. }
  1945. for _, options := range expected.WebClient {
  1946. if !util.Contains(actual.WebClient, options) {
  1947. return errors.New("web client options contents mismatch")
  1948. }
  1949. }
  1950. return compareUserFiltersEqualFields(expected, actual)
  1951. }
  1952. func compareUserFiltersEqualFields(expected sdk.BaseUserFilters, actual sdk.BaseUserFilters) error {
  1953. if expected.Hooks.ExternalAuthDisabled != actual.Hooks.ExternalAuthDisabled {
  1954. return errors.New("external_auth_disabled hook mismatch")
  1955. }
  1956. if expected.Hooks.PreLoginDisabled != actual.Hooks.PreLoginDisabled {
  1957. return errors.New("pre_login_disabled hook mismatch")
  1958. }
  1959. if expected.Hooks.CheckPasswordDisabled != actual.Hooks.CheckPasswordDisabled {
  1960. return errors.New("check_password_disabled hook mismatch")
  1961. }
  1962. if expected.DisableFsChecks != actual.DisableFsChecks {
  1963. return errors.New("disable_fs_checks mismatch")
  1964. }
  1965. if expected.StartDirectory != actual.StartDirectory {
  1966. return errors.New("start_directory mismatch")
  1967. }
  1968. return nil
  1969. }
  1970. func compareBaseUserFilters(expected sdk.BaseUserFilters, actual sdk.BaseUserFilters) error {
  1971. if len(expected.AllowedIP) != len(actual.AllowedIP) {
  1972. return errors.New("allowed IP mismatch")
  1973. }
  1974. if len(expected.DeniedIP) != len(actual.DeniedIP) {
  1975. return errors.New("denied IP mismatch")
  1976. }
  1977. if len(expected.DeniedLoginMethods) != len(actual.DeniedLoginMethods) {
  1978. return errors.New("denied login methods mismatch")
  1979. }
  1980. if len(expected.DeniedProtocols) != len(actual.DeniedProtocols) {
  1981. return errors.New("denied protocols mismatch")
  1982. }
  1983. if expected.MaxUploadFileSize != actual.MaxUploadFileSize {
  1984. return errors.New("max upload file size mismatch")
  1985. }
  1986. if expected.TLSUsername != actual.TLSUsername {
  1987. return errors.New("TLSUsername mismatch")
  1988. }
  1989. if len(expected.WebClient) != len(actual.WebClient) {
  1990. return errors.New("WebClient filter mismatch")
  1991. }
  1992. if expected.AllowAPIKeyAuth != actual.AllowAPIKeyAuth {
  1993. return errors.New("allow_api_key_auth mismatch")
  1994. }
  1995. if expected.ExternalAuthCacheTime != actual.ExternalAuthCacheTime {
  1996. return errors.New("external_auth_cache_time mismatch")
  1997. }
  1998. if expected.FTPSecurity != actual.FTPSecurity {
  1999. return errors.New("ftp_security mismatch")
  2000. }
  2001. if expected.IsAnonymous != actual.IsAnonymous {
  2002. return errors.New("is_anonymous mismatch")
  2003. }
  2004. if expected.DefaultSharesExpiration != actual.DefaultSharesExpiration {
  2005. return errors.New("default_shares_expiration mismatch")
  2006. }
  2007. return nil
  2008. }
  2009. func compareUserFilters(expected sdk.BaseUserFilters, actual sdk.BaseUserFilters) error {
  2010. if err := compareBaseUserFilters(expected, actual); err != nil {
  2011. return err
  2012. }
  2013. if err := compareUserFilterSubStructs(expected, actual); err != nil {
  2014. return err
  2015. }
  2016. if err := compareUserBandwidthLimitFilters(expected, actual); err != nil {
  2017. return err
  2018. }
  2019. if err := compareUserDataTransferLimitFilters(expected, actual); err != nil {
  2020. return err
  2021. }
  2022. return compareUserFilePatternsFilters(expected, actual)
  2023. }
  2024. func checkFilterMatch(expected []string, actual []string) bool {
  2025. if len(expected) != len(actual) {
  2026. return false
  2027. }
  2028. for _, e := range expected {
  2029. if !util.Contains(actual, strings.ToLower(e)) {
  2030. return false
  2031. }
  2032. }
  2033. return true
  2034. }
  2035. func compareUserDataTransferLimitFilters(expected sdk.BaseUserFilters, actual sdk.BaseUserFilters) error {
  2036. if len(expected.DataTransferLimits) != len(actual.DataTransferLimits) {
  2037. return errors.New("data transfer limits filters mismatch")
  2038. }
  2039. for idx, l := range expected.DataTransferLimits {
  2040. if actual.DataTransferLimits[idx].UploadDataTransfer != l.UploadDataTransfer {
  2041. return errors.New("data transfer limit upload_data_transfer mismatch")
  2042. }
  2043. if actual.DataTransferLimits[idx].DownloadDataTransfer != l.DownloadDataTransfer {
  2044. return errors.New("data transfer limit download_data_transfer mismatch")
  2045. }
  2046. if actual.DataTransferLimits[idx].TotalDataTransfer != l.TotalDataTransfer {
  2047. return errors.New("data transfer limit total_data_transfer mismatch")
  2048. }
  2049. for _, source := range actual.DataTransferLimits[idx].Sources {
  2050. if !util.Contains(l.Sources, source) {
  2051. return errors.New("data transfer limit source mismatch")
  2052. }
  2053. }
  2054. }
  2055. return nil
  2056. }
  2057. func compareUserBandwidthLimitFilters(expected sdk.BaseUserFilters, actual sdk.BaseUserFilters) error {
  2058. if len(expected.BandwidthLimits) != len(actual.BandwidthLimits) {
  2059. return errors.New("bandwidth limits filters mismatch")
  2060. }
  2061. for idx, l := range expected.BandwidthLimits {
  2062. if actual.BandwidthLimits[idx].UploadBandwidth != l.UploadBandwidth {
  2063. return errors.New("bandwidth filters upload_bandwidth mismatch")
  2064. }
  2065. if actual.BandwidthLimits[idx].DownloadBandwidth != l.DownloadBandwidth {
  2066. return errors.New("bandwidth filters download_bandwidth mismatch")
  2067. }
  2068. if len(actual.BandwidthLimits[idx].Sources) != len(l.Sources) {
  2069. return errors.New("bandwidth filters sources mismatch")
  2070. }
  2071. for _, source := range actual.BandwidthLimits[idx].Sources {
  2072. if !util.Contains(l.Sources, source) {
  2073. return errors.New("bandwidth filters source mismatch")
  2074. }
  2075. }
  2076. }
  2077. return nil
  2078. }
  2079. func compareUserFilePatternsFilters(expected sdk.BaseUserFilters, actual sdk.BaseUserFilters) error {
  2080. if len(expected.FilePatterns) != len(actual.FilePatterns) {
  2081. return errors.New("file patterns mismatch")
  2082. }
  2083. for _, f := range expected.FilePatterns {
  2084. found := false
  2085. for _, f1 := range actual.FilePatterns {
  2086. if path.Clean(f.Path) == path.Clean(f1.Path) && f.DenyPolicy == f1.DenyPolicy {
  2087. if !checkFilterMatch(f.AllowedPatterns, f1.AllowedPatterns) ||
  2088. !checkFilterMatch(f.DeniedPatterns, f1.DeniedPatterns) {
  2089. return errors.New("file patterns contents mismatch")
  2090. }
  2091. found = true
  2092. }
  2093. }
  2094. if !found {
  2095. return errors.New("file patterns contents mismatch")
  2096. }
  2097. }
  2098. return nil
  2099. }
  2100. func compareKeyValues(expected, actual []dataprovider.KeyValue) error {
  2101. if len(expected) != len(actual) {
  2102. return errors.New("kay values mismatch")
  2103. }
  2104. for _, ex := range expected {
  2105. found := false
  2106. for _, ac := range actual {
  2107. if ac.Key == ex.Key && ac.Value == ex.Value {
  2108. found = true
  2109. break
  2110. }
  2111. }
  2112. if !found {
  2113. return errors.New("kay values mismatch")
  2114. }
  2115. }
  2116. return nil
  2117. }
  2118. func compareHTTPparts(expected, actual []dataprovider.HTTPPart) error {
  2119. for _, p1 := range expected {
  2120. found := false
  2121. for _, p2 := range actual {
  2122. if p1.Name == p2.Name {
  2123. found = true
  2124. if err := compareKeyValues(p1.Headers, p2.Headers); err != nil {
  2125. return fmt.Errorf("http headers mismatch for part %q", p1.Name)
  2126. }
  2127. if p1.Body != p2.Body || p1.Filepath != p2.Filepath {
  2128. return fmt.Errorf("http part %q mismatch", p1.Name)
  2129. }
  2130. }
  2131. }
  2132. if !found {
  2133. return fmt.Errorf("expected http part %q not found", p1.Name)
  2134. }
  2135. }
  2136. return nil
  2137. }
  2138. func compareEventActionHTTPConfigFields(expected, actual dataprovider.EventActionHTTPConfig) error {
  2139. if expected.Endpoint != actual.Endpoint {
  2140. return errors.New("http endpoint mismatch")
  2141. }
  2142. if expected.Username != actual.Username {
  2143. return errors.New("http username mismatch")
  2144. }
  2145. if err := checkEncryptedSecret(expected.Password, actual.Password); err != nil {
  2146. return err
  2147. }
  2148. if err := compareKeyValues(expected.Headers, actual.Headers); err != nil {
  2149. return errors.New("http headers mismatch")
  2150. }
  2151. if expected.Timeout != actual.Timeout {
  2152. return errors.New("http timeout mismatch")
  2153. }
  2154. if expected.SkipTLSVerify != actual.SkipTLSVerify {
  2155. return errors.New("http skip TLS verify mismatch")
  2156. }
  2157. if expected.Method != actual.Method {
  2158. return errors.New("http method mismatch")
  2159. }
  2160. if err := compareKeyValues(expected.QueryParameters, actual.QueryParameters); err != nil {
  2161. return errors.New("http query parameters mismatch")
  2162. }
  2163. if expected.Body != actual.Body {
  2164. return errors.New("http body mismatch")
  2165. }
  2166. if len(expected.Parts) != len(actual.Parts) {
  2167. return errors.New("http parts mismatch")
  2168. }
  2169. return compareHTTPparts(expected.Parts, actual.Parts)
  2170. }
  2171. func compareEventActionEmailConfigFields(expected, actual dataprovider.EventActionEmailConfig) error {
  2172. if len(expected.Recipients) != len(actual.Recipients) {
  2173. return errors.New("email recipients mismatch")
  2174. }
  2175. for _, v := range expected.Recipients {
  2176. if !util.Contains(actual.Recipients, v) {
  2177. return errors.New("email recipients content mismatch")
  2178. }
  2179. }
  2180. if expected.Subject != actual.Subject {
  2181. return errors.New("email subject mismatch")
  2182. }
  2183. if expected.Body != actual.Body {
  2184. return errors.New("email body mismatch")
  2185. }
  2186. if len(expected.Attachments) != len(actual.Attachments) {
  2187. return errors.New("email attachments mismatch")
  2188. }
  2189. for _, v := range expected.Attachments {
  2190. if !util.Contains(actual.Attachments, v) {
  2191. return errors.New("email attachments content mismatch")
  2192. }
  2193. }
  2194. return nil
  2195. }
  2196. func compareEventActionFsCompressFields(expected, actual dataprovider.EventActionFsCompress) error {
  2197. if expected.Name != actual.Name {
  2198. return errors.New("fs compress name mismatch")
  2199. }
  2200. if len(expected.Paths) != len(actual.Paths) {
  2201. return errors.New("fs compress paths mismatch")
  2202. }
  2203. for _, v := range expected.Paths {
  2204. if !util.Contains(actual.Paths, v) {
  2205. return errors.New("fs compress paths content mismatch")
  2206. }
  2207. }
  2208. return nil
  2209. }
  2210. func compareEventActionFsConfigFields(expected, actual dataprovider.EventActionFilesystemConfig) error {
  2211. if expected.Type != actual.Type {
  2212. return errors.New("fs type mismatch")
  2213. }
  2214. if err := compareKeyValues(expected.Renames, actual.Renames); err != nil {
  2215. return errors.New("fs renames mismatch")
  2216. }
  2217. if len(expected.Deletes) != len(actual.Deletes) {
  2218. return errors.New("fs deletes mismatch")
  2219. }
  2220. for _, v := range expected.Deletes {
  2221. if !util.Contains(actual.Deletes, v) {
  2222. return errors.New("fs deletes content mismatch")
  2223. }
  2224. }
  2225. if len(expected.MkDirs) != len(actual.MkDirs) {
  2226. return errors.New("fs mkdirs mismatch")
  2227. }
  2228. for _, v := range expected.MkDirs {
  2229. if !util.Contains(actual.MkDirs, v) {
  2230. return errors.New("fs mkdir content mismatch")
  2231. }
  2232. }
  2233. if len(expected.Exist) != len(actual.Exist) {
  2234. return errors.New("fs exist mismatch")
  2235. }
  2236. for _, v := range expected.Exist {
  2237. if !util.Contains(actual.Exist, v) {
  2238. return errors.New("fs exist content mismatch")
  2239. }
  2240. }
  2241. return compareEventActionFsCompressFields(expected.Compress, actual.Compress)
  2242. }
  2243. func compareEventActionCmdConfigFields(expected, actual dataprovider.EventActionCommandConfig) error {
  2244. if expected.Cmd != actual.Cmd {
  2245. return errors.New("command mismatch")
  2246. }
  2247. if expected.Timeout != actual.Timeout {
  2248. return errors.New("cmd timeout mismatch")
  2249. }
  2250. if len(expected.Args) != len(actual.Args) {
  2251. return errors.New("cmd args mismatch")
  2252. }
  2253. for _, v := range expected.Args {
  2254. if !util.Contains(actual.Args, v) {
  2255. return errors.New("cmd args content mismatch")
  2256. }
  2257. }
  2258. if err := compareKeyValues(expected.EnvVars, actual.EnvVars); err != nil {
  2259. return errors.New("cmd env vars mismatch")
  2260. }
  2261. return nil
  2262. }
  2263. func compareEventActionDataRetentionFields(expected, actual dataprovider.EventActionDataRetentionConfig) error {
  2264. if len(expected.Folders) != len(actual.Folders) {
  2265. return errors.New("retention folders mismatch")
  2266. }
  2267. for _, f1 := range expected.Folders {
  2268. found := false
  2269. for _, f2 := range actual.Folders {
  2270. if f1.Path == f2.Path {
  2271. found = true
  2272. if f1.Retention != f2.Retention {
  2273. return fmt.Errorf("retention mismatch for folder %s", f1.Path)
  2274. }
  2275. if f1.DeleteEmptyDirs != f2.DeleteEmptyDirs {
  2276. return fmt.Errorf("delete_empty_dirs mismatch for folder %s", f1.Path)
  2277. }
  2278. if f1.IgnoreUserPermissions != f2.IgnoreUserPermissions {
  2279. return fmt.Errorf("ignore_user_permissions mismatch for folder %s", f1.Path)
  2280. }
  2281. break
  2282. }
  2283. }
  2284. if !found {
  2285. return errors.New("retention folders mismatch")
  2286. }
  2287. }
  2288. return nil
  2289. }
  2290. func compareEqualGroupSettingsFields(expected sdk.BaseGroupUserSettings, actual sdk.BaseGroupUserSettings) error {
  2291. if expected.HomeDir != actual.HomeDir {
  2292. return errors.New("home dir mismatch")
  2293. }
  2294. if expected.MaxSessions != actual.MaxSessions {
  2295. return errors.New("MaxSessions mismatch")
  2296. }
  2297. if expected.QuotaSize != actual.QuotaSize {
  2298. return errors.New("QuotaSize mismatch")
  2299. }
  2300. if expected.QuotaFiles != actual.QuotaFiles {
  2301. return errors.New("QuotaFiles mismatch")
  2302. }
  2303. if expected.UploadBandwidth != actual.UploadBandwidth {
  2304. return errors.New("UploadBandwidth mismatch")
  2305. }
  2306. if expected.DownloadBandwidth != actual.DownloadBandwidth {
  2307. return errors.New("DownloadBandwidth mismatch")
  2308. }
  2309. if expected.UploadDataTransfer != actual.UploadDataTransfer {
  2310. return errors.New("upload_data_transfer mismatch")
  2311. }
  2312. if expected.DownloadDataTransfer != actual.DownloadDataTransfer {
  2313. return errors.New("download_data_transfer mismatch")
  2314. }
  2315. if expected.TotalDataTransfer != actual.TotalDataTransfer {
  2316. return errors.New("total_data_transfer mismatch")
  2317. }
  2318. return compareUserPermissions(expected.Permissions, actual.Permissions)
  2319. }
  2320. func compareEqualsUserFields(expected *dataprovider.User, actual *dataprovider.User) error {
  2321. if dataprovider.ConvertName(expected.Username) != actual.Username {
  2322. return errors.New("username mismatch")
  2323. }
  2324. if expected.HomeDir != actual.HomeDir {
  2325. return errors.New("home dir mismatch")
  2326. }
  2327. if expected.UID != actual.UID {
  2328. return errors.New("UID mismatch")
  2329. }
  2330. if expected.GID != actual.GID {
  2331. return errors.New("GID mismatch")
  2332. }
  2333. if expected.MaxSessions != actual.MaxSessions {
  2334. return errors.New("MaxSessions mismatch")
  2335. }
  2336. if len(expected.Permissions) != len(actual.Permissions) {
  2337. return errors.New("permissions mismatch")
  2338. }
  2339. if expected.UploadBandwidth != actual.UploadBandwidth {
  2340. return errors.New("UploadBandwidth mismatch")
  2341. }
  2342. if expected.DownloadBandwidth != actual.DownloadBandwidth {
  2343. return errors.New("DownloadBandwidth mismatch")
  2344. }
  2345. if expected.Status != actual.Status {
  2346. return errors.New("status mismatch")
  2347. }
  2348. if expected.ExpirationDate != actual.ExpirationDate {
  2349. return errors.New("ExpirationDate mismatch")
  2350. }
  2351. if expected.AdditionalInfo != actual.AdditionalInfo {
  2352. return errors.New("AdditionalInfo mismatch")
  2353. }
  2354. if expected.Description != actual.Description {
  2355. return errors.New("description mismatch")
  2356. }
  2357. return compareQuotaUserFields(expected, actual)
  2358. }
  2359. func compareQuotaUserFields(expected *dataprovider.User, actual *dataprovider.User) error {
  2360. if expected.QuotaSize != actual.QuotaSize {
  2361. return errors.New("QuotaSize mismatch")
  2362. }
  2363. if expected.QuotaFiles != actual.QuotaFiles {
  2364. return errors.New("QuotaFiles mismatch")
  2365. }
  2366. if expected.UploadDataTransfer != actual.UploadDataTransfer {
  2367. return errors.New("upload_data_transfer mismatch")
  2368. }
  2369. if expected.DownloadDataTransfer != actual.DownloadDataTransfer {
  2370. return errors.New("download_data_transfer mismatch")
  2371. }
  2372. if expected.TotalDataTransfer != actual.TotalDataTransfer {
  2373. return errors.New("total_data_transfer mismatch")
  2374. }
  2375. return nil
  2376. }
  2377. func addLimitAndOffsetQueryParams(rawurl string, limit, offset int64) (*url.URL, error) {
  2378. url, err := url.Parse(rawurl)
  2379. if err != nil {
  2380. return nil, err
  2381. }
  2382. q := url.Query()
  2383. if limit > 0 {
  2384. q.Add("limit", strconv.FormatInt(limit, 10))
  2385. }
  2386. if offset > 0 {
  2387. q.Add("offset", strconv.FormatInt(offset, 10))
  2388. }
  2389. url.RawQuery = q.Encode()
  2390. return url, err
  2391. }
  2392. func addModeQueryParam(rawurl, mode string) (*url.URL, error) {
  2393. url, err := url.Parse(rawurl)
  2394. if err != nil {
  2395. return nil, err
  2396. }
  2397. q := url.Query()
  2398. if len(mode) > 0 {
  2399. q.Add("mode", mode)
  2400. }
  2401. url.RawQuery = q.Encode()
  2402. return url, err
  2403. }
  2404. func addDisconnectQueryParam(rawurl, disconnect string) (*url.URL, error) {
  2405. url, err := url.Parse(rawurl)
  2406. if err != nil {
  2407. return nil, err
  2408. }
  2409. q := url.Query()
  2410. if len(disconnect) > 0 {
  2411. q.Add("disconnect", disconnect)
  2412. }
  2413. url.RawQuery = q.Encode()
  2414. return url, err
  2415. }