api_http_user.go 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465
  1. package httpd
  2. import (
  3. "context"
  4. "errors"
  5. "fmt"
  6. "io"
  7. "mime/multipart"
  8. "net/http"
  9. "os"
  10. "path"
  11. "time"
  12. "github.com/go-chi/render"
  13. "github.com/rs/xid"
  14. "github.com/drakkan/sftpgo/v2/common"
  15. "github.com/drakkan/sftpgo/v2/dataprovider"
  16. "github.com/drakkan/sftpgo/v2/logger"
  17. "github.com/drakkan/sftpgo/v2/util"
  18. )
  19. func getUserConnection(w http.ResponseWriter, r *http.Request) (*Connection, error) {
  20. claims, err := getTokenClaims(r)
  21. if err != nil || claims.Username == "" {
  22. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  23. return nil, fmt.Errorf("invalid token claims %w", err)
  24. }
  25. user, err := dataprovider.UserExists(claims.Username)
  26. if err != nil {
  27. sendAPIResponse(w, r, nil, "Unable to retrieve your user", getRespStatus(err))
  28. return nil, err
  29. }
  30. connID := xid.New().String()
  31. connectionID := fmt.Sprintf("%v_%v", common.ProtocolHTTP, connID)
  32. if err := checkHTTPClientUser(&user, r, connectionID); err != nil {
  33. sendAPIResponse(w, r, err, http.StatusText(http.StatusForbidden), http.StatusForbidden)
  34. return nil, err
  35. }
  36. connection := &Connection{
  37. BaseConnection: common.NewBaseConnection(connID, common.ProtocolHTTP, util.GetHTTPLocalAddress(r),
  38. r.RemoteAddr, user),
  39. request: r,
  40. }
  41. return connection, nil
  42. }
  43. func readUserFolder(w http.ResponseWriter, r *http.Request) {
  44. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  45. connection, err := getUserConnection(w, r)
  46. if err != nil {
  47. return
  48. }
  49. common.Connections.Add(connection)
  50. defer common.Connections.Remove(connection.GetID())
  51. name := util.CleanPath(r.URL.Query().Get("path"))
  52. contents, err := connection.ReadDir(name)
  53. if err != nil {
  54. sendAPIResponse(w, r, err, "Unable to get directory contents", getMappedStatusCode(err))
  55. return
  56. }
  57. results := make([]map[string]interface{}, 0, len(contents))
  58. for _, info := range contents {
  59. res := make(map[string]interface{})
  60. res["name"] = info.Name()
  61. if info.Mode().IsRegular() {
  62. res["size"] = info.Size()
  63. }
  64. res["mode"] = info.Mode()
  65. res["last_modified"] = info.ModTime().UTC().Format(time.RFC3339)
  66. results = append(results, res)
  67. }
  68. render.JSON(w, r, results)
  69. }
  70. func createUserDir(w http.ResponseWriter, r *http.Request) {
  71. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  72. connection, err := getUserConnection(w, r)
  73. if err != nil {
  74. return
  75. }
  76. common.Connections.Add(connection)
  77. defer common.Connections.Remove(connection.GetID())
  78. name := util.CleanPath(r.URL.Query().Get("path"))
  79. err = connection.CreateDir(name)
  80. if err != nil {
  81. sendAPIResponse(w, r, err, fmt.Sprintf("Unable to create directory %#v", name), getMappedStatusCode(err))
  82. return
  83. }
  84. sendAPIResponse(w, r, nil, fmt.Sprintf("Directory %#v created", name), http.StatusCreated)
  85. }
  86. func renameUserDir(w http.ResponseWriter, r *http.Request) {
  87. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  88. connection, err := getUserConnection(w, r)
  89. if err != nil {
  90. return
  91. }
  92. common.Connections.Add(connection)
  93. defer common.Connections.Remove(connection.GetID())
  94. oldName := util.CleanPath(r.URL.Query().Get("path"))
  95. newName := util.CleanPath(r.URL.Query().Get("target"))
  96. err = connection.Rename(oldName, newName)
  97. if err != nil {
  98. sendAPIResponse(w, r, err, fmt.Sprintf("Unable to rename directory %#v to %#v", oldName, newName),
  99. getMappedStatusCode(err))
  100. return
  101. }
  102. sendAPIResponse(w, r, nil, fmt.Sprintf("Directory %#v renamed to %#v", oldName, newName), http.StatusOK)
  103. }
  104. func deleteUserDir(w http.ResponseWriter, r *http.Request) {
  105. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  106. connection, err := getUserConnection(w, r)
  107. if err != nil {
  108. return
  109. }
  110. common.Connections.Add(connection)
  111. defer common.Connections.Remove(connection.GetID())
  112. name := util.CleanPath(r.URL.Query().Get("path"))
  113. err = connection.RemoveDir(name)
  114. if err != nil {
  115. sendAPIResponse(w, r, err, fmt.Sprintf("Unable to delete directory %#v", name), getMappedStatusCode(err))
  116. return
  117. }
  118. sendAPIResponse(w, r, nil, fmt.Sprintf("Directory %#v deleted", name), http.StatusOK)
  119. }
  120. func getUserFile(w http.ResponseWriter, r *http.Request) {
  121. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  122. connection, err := getUserConnection(w, r)
  123. if err != nil {
  124. return
  125. }
  126. common.Connections.Add(connection)
  127. defer common.Connections.Remove(connection.GetID())
  128. name := util.CleanPath(r.URL.Query().Get("path"))
  129. if name == "/" {
  130. sendAPIResponse(w, r, nil, "Please set the path to a valid file", http.StatusBadRequest)
  131. return
  132. }
  133. info, err := connection.Stat(name, 0)
  134. if err != nil {
  135. sendAPIResponse(w, r, err, "Unable to stat the requested file", getMappedStatusCode(err))
  136. return
  137. }
  138. if info.IsDir() {
  139. sendAPIResponse(w, r, nil, fmt.Sprintf("Please set the path to a valid file, %#v is a directory", name), http.StatusBadRequest)
  140. return
  141. }
  142. inline := r.URL.Query().Get("inline") != ""
  143. if status, err := downloadFile(w, r, connection, name, info, inline); err != nil {
  144. resp := apiResponse{
  145. Error: err.Error(),
  146. Message: http.StatusText(status),
  147. }
  148. ctx := r.Context()
  149. if status != 0 {
  150. ctx = context.WithValue(ctx, render.StatusCtxKey, status)
  151. }
  152. render.JSON(w, r.WithContext(ctx), resp)
  153. }
  154. }
  155. func uploadUserFiles(w http.ResponseWriter, r *http.Request) {
  156. if maxUploadFileSize > 0 {
  157. r.Body = http.MaxBytesReader(w, r.Body, maxUploadFileSize)
  158. }
  159. connection, err := getUserConnection(w, r)
  160. if err != nil {
  161. return
  162. }
  163. common.Connections.Add(connection)
  164. defer common.Connections.Remove(connection.GetID())
  165. err = r.ParseMultipartForm(maxMultipartMem)
  166. if err != nil {
  167. sendAPIResponse(w, r, err, "Unable to parse multipart form", http.StatusBadRequest)
  168. return
  169. }
  170. defer r.MultipartForm.RemoveAll() //nolint:errcheck
  171. parentDir := util.CleanPath(r.URL.Query().Get("path"))
  172. files := r.MultipartForm.File["filenames"]
  173. if len(files) == 0 {
  174. sendAPIResponse(w, r, nil, "No files uploaded!", http.StatusBadRequest)
  175. return
  176. }
  177. doUploadFiles(w, r, connection, parentDir, files)
  178. }
  179. func doUploadFiles(w http.ResponseWriter, r *http.Request, connection *Connection, parentDir string,
  180. files []*multipart.FileHeader,
  181. ) int {
  182. uploaded := 0
  183. for _, f := range files {
  184. file, err := f.Open()
  185. if err != nil {
  186. sendAPIResponse(w, r, err, fmt.Sprintf("Unable to read uploaded file %#v", f.Filename), getMappedStatusCode(err))
  187. return uploaded
  188. }
  189. defer file.Close()
  190. filePath := path.Join(parentDir, f.Filename)
  191. writer, err := connection.getFileWriter(filePath)
  192. if err != nil {
  193. sendAPIResponse(w, r, err, fmt.Sprintf("Unable to write file %#v", f.Filename), getMappedStatusCode(err))
  194. return uploaded
  195. }
  196. _, err = io.Copy(writer, file)
  197. if err != nil {
  198. writer.Close() //nolint:errcheck
  199. sendAPIResponse(w, r, err, fmt.Sprintf("Error saving file %#v", f.Filename), getMappedStatusCode(err))
  200. return uploaded
  201. }
  202. err = writer.Close()
  203. if err != nil {
  204. sendAPIResponse(w, r, err, fmt.Sprintf("Error closing file %#v", f.Filename), getMappedStatusCode(err))
  205. return uploaded
  206. }
  207. uploaded++
  208. }
  209. sendAPIResponse(w, r, nil, "Upload completed", http.StatusCreated)
  210. return uploaded
  211. }
  212. func renameUserFile(w http.ResponseWriter, r *http.Request) {
  213. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  214. connection, err := getUserConnection(w, r)
  215. if err != nil {
  216. return
  217. }
  218. common.Connections.Add(connection)
  219. defer common.Connections.Remove(connection.GetID())
  220. oldName := util.CleanPath(r.URL.Query().Get("path"))
  221. newName := util.CleanPath(r.URL.Query().Get("target"))
  222. err = connection.Rename(oldName, newName)
  223. if err != nil {
  224. sendAPIResponse(w, r, err, fmt.Sprintf("Unable to rename file %#v to %#v", oldName, newName),
  225. getMappedStatusCode(err))
  226. return
  227. }
  228. sendAPIResponse(w, r, nil, fmt.Sprintf("File %#v renamed to %#v", oldName, newName), http.StatusOK)
  229. }
  230. func deleteUserFile(w http.ResponseWriter, r *http.Request) {
  231. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  232. connection, err := getUserConnection(w, r)
  233. if err != nil {
  234. return
  235. }
  236. common.Connections.Add(connection)
  237. defer common.Connections.Remove(connection.GetID())
  238. name := util.CleanPath(r.URL.Query().Get("path"))
  239. fs, p, err := connection.GetFsAndResolvedPath(name)
  240. if err != nil {
  241. sendAPIResponse(w, r, err, fmt.Sprintf("Unable to delete file %#v", name), getMappedStatusCode(err))
  242. return
  243. }
  244. var fi os.FileInfo
  245. if fi, err = fs.Lstat(p); err != nil {
  246. connection.Log(logger.LevelWarn, "failed to remove a file %#v: stat error: %+v", p, err)
  247. err = connection.GetFsError(fs, err)
  248. sendAPIResponse(w, r, err, fmt.Sprintf("Unable to delete file %#v", name), getMappedStatusCode(err))
  249. return
  250. }
  251. if fi.IsDir() && fi.Mode()&os.ModeSymlink == 0 {
  252. connection.Log(logger.LevelDebug, "cannot remove %#v is not a file/symlink", p)
  253. sendAPIResponse(w, r, err, fmt.Sprintf("Unable delete %#v, it is not a file/symlink", name), http.StatusBadRequest)
  254. return
  255. }
  256. err = connection.RemoveFile(fs, p, name, fi)
  257. if err != nil {
  258. sendAPIResponse(w, r, err, fmt.Sprintf("Unable to delete file %#v", name), getMappedStatusCode(err))
  259. return
  260. }
  261. sendAPIResponse(w, r, nil, fmt.Sprintf("File %#v deleted", name), http.StatusOK)
  262. }
  263. func getUserFilesAsZipStream(w http.ResponseWriter, r *http.Request) {
  264. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  265. connection, err := getUserConnection(w, r)
  266. if err != nil {
  267. return
  268. }
  269. common.Connections.Add(connection)
  270. defer common.Connections.Remove(connection.GetID())
  271. var filesList []string
  272. err = render.DecodeJSON(r.Body, &filesList)
  273. if err != nil {
  274. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  275. return
  276. }
  277. baseDir := "/"
  278. for idx := range filesList {
  279. filesList[idx] = util.CleanPath(filesList[idx])
  280. }
  281. filesList = util.RemoveDuplicates(filesList)
  282. w.Header().Set("Content-Disposition", "attachment; filename=\"sftpgo-download.zip\"")
  283. renderCompressedFiles(w, connection, baseDir, filesList, nil)
  284. }
  285. func getUserPublicKeys(w http.ResponseWriter, r *http.Request) {
  286. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  287. claims, err := getTokenClaims(r)
  288. if err != nil || claims.Username == "" {
  289. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  290. return
  291. }
  292. user, err := dataprovider.UserExists(claims.Username)
  293. if err != nil {
  294. sendAPIResponse(w, r, nil, "Unable to retrieve your user", getRespStatus(err))
  295. return
  296. }
  297. render.JSON(w, r, user.PublicKeys)
  298. }
  299. func setUserPublicKeys(w http.ResponseWriter, r *http.Request) {
  300. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  301. claims, err := getTokenClaims(r)
  302. if err != nil || claims.Username == "" {
  303. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  304. return
  305. }
  306. user, err := dataprovider.UserExists(claims.Username)
  307. if err != nil {
  308. sendAPIResponse(w, r, nil, "Unable to retrieve your user", getRespStatus(err))
  309. return
  310. }
  311. var publicKeys []string
  312. err = render.DecodeJSON(r.Body, &publicKeys)
  313. if err != nil {
  314. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  315. return
  316. }
  317. user.PublicKeys = publicKeys
  318. err = dataprovider.UpdateUser(&user, dataprovider.ActionExecutorSelf, util.GetIPFromRemoteAddress(r.RemoteAddr))
  319. if err != nil {
  320. sendAPIResponse(w, r, err, "", getRespStatus(err))
  321. return
  322. }
  323. sendAPIResponse(w, r, err, "Public keys updated", http.StatusOK)
  324. }
  325. func getUserProfile(w http.ResponseWriter, r *http.Request) {
  326. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  327. claims, err := getTokenClaims(r)
  328. if err != nil || claims.Username == "" {
  329. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  330. return
  331. }
  332. user, err := dataprovider.UserExists(claims.Username)
  333. if err != nil {
  334. sendAPIResponse(w, r, err, "", getRespStatus(err))
  335. return
  336. }
  337. resp := userProfile{
  338. baseProfile: baseProfile{
  339. Email: user.Email,
  340. Description: user.Description,
  341. AllowAPIKeyAuth: user.Filters.AllowAPIKeyAuth,
  342. },
  343. PublicKeys: user.PublicKeys,
  344. }
  345. render.JSON(w, r, resp)
  346. }
  347. func updateUserProfile(w http.ResponseWriter, r *http.Request) {
  348. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  349. claims, err := getTokenClaims(r)
  350. if err != nil || claims.Username == "" {
  351. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  352. return
  353. }
  354. var req userProfile
  355. err = render.DecodeJSON(r.Body, &req)
  356. if err != nil {
  357. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  358. return
  359. }
  360. user, err := dataprovider.UserExists(claims.Username)
  361. if err != nil {
  362. sendAPIResponse(w, r, err, "", getRespStatus(err))
  363. return
  364. }
  365. if !user.CanManagePublicKeys() && !user.CanChangeAPIKeyAuth() && !user.CanChangeInfo() {
  366. sendAPIResponse(w, r, nil, "You are not allowed to change anything", http.StatusForbidden)
  367. return
  368. }
  369. if user.CanManagePublicKeys() {
  370. user.PublicKeys = req.PublicKeys
  371. }
  372. if user.CanChangeAPIKeyAuth() {
  373. user.Filters.AllowAPIKeyAuth = req.AllowAPIKeyAuth
  374. }
  375. if user.CanChangeInfo() {
  376. user.Email = req.Email
  377. user.Description = req.Description
  378. }
  379. if err := dataprovider.UpdateUser(&user, dataprovider.ActionExecutorSelf, util.GetIPFromRemoteAddress(r.RemoteAddr)); err != nil {
  380. sendAPIResponse(w, r, err, "", getRespStatus(err))
  381. return
  382. }
  383. sendAPIResponse(w, r, err, "Profile updated", http.StatusOK)
  384. }
  385. func changeUserPassword(w http.ResponseWriter, r *http.Request) {
  386. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  387. var pwd pwdChange
  388. err := render.DecodeJSON(r.Body, &pwd)
  389. if err != nil {
  390. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  391. return
  392. }
  393. err = doChangeUserPassword(r, pwd.CurrentPassword, pwd.NewPassword, pwd.NewPassword)
  394. if err != nil {
  395. sendAPIResponse(w, r, err, "", getRespStatus(err))
  396. return
  397. }
  398. sendAPIResponse(w, r, err, "Password updated", http.StatusOK)
  399. }
  400. func doChangeUserPassword(r *http.Request, currentPassword, newPassword, confirmNewPassword string) error {
  401. if currentPassword == "" || newPassword == "" || confirmNewPassword == "" {
  402. return util.NewValidationError("please provide the current password and the new one two times")
  403. }
  404. if newPassword != confirmNewPassword {
  405. return util.NewValidationError("the two password fields do not match")
  406. }
  407. if currentPassword == newPassword {
  408. return util.NewValidationError("the new password must be different from the current one")
  409. }
  410. claims, err := getTokenClaims(r)
  411. if err != nil || claims.Username == "" {
  412. return errors.New("invalid token claims")
  413. }
  414. user, err := dataprovider.CheckUserAndPass(claims.Username, currentPassword, util.GetIPFromRemoteAddress(r.RemoteAddr),
  415. common.ProtocolHTTP)
  416. if err != nil {
  417. return util.NewValidationError("current password does not match")
  418. }
  419. user.Password = newPassword
  420. return dataprovider.UpdateUser(&user, dataprovider.ActionExecutorSelf, util.GetIPFromRemoteAddress(r.RemoteAddr))
  421. }