api_admin.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
  1. // Copyright (C) 2019-2023 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 httpd
  15. import (
  16. "context"
  17. "errors"
  18. "fmt"
  19. "net/http"
  20. "net/url"
  21. "github.com/go-chi/jwtauth/v5"
  22. "github.com/go-chi/render"
  23. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  24. "github.com/drakkan/sftpgo/v2/internal/smtp"
  25. "github.com/drakkan/sftpgo/v2/internal/util"
  26. )
  27. func getAdmins(w http.ResponseWriter, r *http.Request) {
  28. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  29. limit, offset, order, err := getSearchFilters(w, r)
  30. if err != nil {
  31. return
  32. }
  33. admins, err := dataprovider.GetAdmins(limit, offset, order)
  34. if err != nil {
  35. sendAPIResponse(w, r, err, "", getRespStatus(err))
  36. return
  37. }
  38. render.JSON(w, r, admins)
  39. }
  40. func getAdminByUsername(w http.ResponseWriter, r *http.Request) {
  41. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  42. username := getURLParam(r, "username")
  43. renderAdmin(w, r, username, http.StatusOK)
  44. }
  45. func renderAdmin(w http.ResponseWriter, r *http.Request, username string, status int) {
  46. admin, err := dataprovider.AdminExists(username)
  47. if err != nil {
  48. sendAPIResponse(w, r, err, "", getRespStatus(err))
  49. return
  50. }
  51. admin.HideConfidentialData()
  52. if status != http.StatusOK {
  53. ctx := context.WithValue(r.Context(), render.StatusCtxKey, http.StatusCreated)
  54. render.JSON(w, r.WithContext(ctx), admin)
  55. } else {
  56. render.JSON(w, r, admin)
  57. }
  58. }
  59. func addAdmin(w http.ResponseWriter, r *http.Request) {
  60. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  61. claims, err := getTokenClaims(r)
  62. if err != nil || claims.Username == "" {
  63. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  64. return
  65. }
  66. admin := dataprovider.Admin{}
  67. err = render.DecodeJSON(r.Body, &admin)
  68. if err != nil {
  69. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  70. return
  71. }
  72. err = dataprovider.AddAdmin(&admin, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  73. if err != nil {
  74. sendAPIResponse(w, r, err, "", getRespStatus(err))
  75. return
  76. }
  77. w.Header().Add("Location", fmt.Sprintf("%s/%s", adminPath, url.PathEscape(admin.Username)))
  78. renderAdmin(w, r, admin.Username, http.StatusCreated)
  79. }
  80. func disableAdmin2FA(w http.ResponseWriter, r *http.Request) {
  81. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  82. claims, err := getTokenClaims(r)
  83. if err != nil || claims.Username == "" {
  84. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  85. return
  86. }
  87. admin, err := dataprovider.AdminExists(getURLParam(r, "username"))
  88. if err != nil {
  89. sendAPIResponse(w, r, err, "", getRespStatus(err))
  90. return
  91. }
  92. admin.Filters.RecoveryCodes = nil
  93. admin.Filters.TOTPConfig = dataprovider.AdminTOTPConfig{
  94. Enabled: false,
  95. }
  96. if err := dataprovider.UpdateAdmin(&admin, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role); err != nil {
  97. sendAPIResponse(w, r, err, "", getRespStatus(err))
  98. return
  99. }
  100. sendAPIResponse(w, r, nil, "2FA disabled", http.StatusOK)
  101. }
  102. func updateAdmin(w http.ResponseWriter, r *http.Request) {
  103. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  104. username := getURLParam(r, "username")
  105. admin, err := dataprovider.AdminExists(username)
  106. if err != nil {
  107. sendAPIResponse(w, r, err, "", getRespStatus(err))
  108. return
  109. }
  110. var updatedAdmin dataprovider.Admin
  111. err = render.DecodeJSON(r.Body, &updatedAdmin)
  112. if err != nil {
  113. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  114. return
  115. }
  116. claims, err := getTokenClaims(r)
  117. if err != nil || claims.Username == "" {
  118. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  119. return
  120. }
  121. if username == claims.Username {
  122. if claims.APIKeyID != "" {
  123. sendAPIResponse(w, r, errors.New("updating the admin impersonated with an API key is not allowed"), "",
  124. http.StatusBadRequest)
  125. return
  126. }
  127. if claims.isCriticalPermRemoved(updatedAdmin.Permissions) {
  128. sendAPIResponse(w, r, errors.New("you cannot remove these permissions to yourself"), "", http.StatusBadRequest)
  129. return
  130. }
  131. if updatedAdmin.Status == 0 {
  132. sendAPIResponse(w, r, errors.New("you cannot disable yourself"), "", http.StatusBadRequest)
  133. return
  134. }
  135. if updatedAdmin.Role != claims.Role {
  136. sendAPIResponse(w, r, errors.New("you cannot add/change your role"), "", http.StatusBadRequest)
  137. return
  138. }
  139. }
  140. updatedAdmin.ID = admin.ID
  141. updatedAdmin.Username = admin.Username
  142. if updatedAdmin.Password == "" {
  143. updatedAdmin.Password = admin.Password
  144. }
  145. updatedAdmin.Filters.TOTPConfig = admin.Filters.TOTPConfig
  146. updatedAdmin.Filters.RecoveryCodes = admin.Filters.RecoveryCodes
  147. err = dataprovider.UpdateAdmin(&updatedAdmin, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  148. if err != nil {
  149. sendAPIResponse(w, r, err, "", getRespStatus(err))
  150. return
  151. }
  152. sendAPIResponse(w, r, nil, "Admin updated", http.StatusOK)
  153. }
  154. func deleteAdmin(w http.ResponseWriter, r *http.Request) {
  155. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  156. username := getURLParam(r, "username")
  157. claims, err := getTokenClaims(r)
  158. if err != nil || claims.Username == "" {
  159. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  160. return
  161. }
  162. if username == claims.Username {
  163. sendAPIResponse(w, r, errors.New("you cannot delete yourself"), "", http.StatusBadRequest)
  164. return
  165. }
  166. err = dataprovider.DeleteAdmin(username, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  167. if err != nil {
  168. sendAPIResponse(w, r, err, "", getRespStatus(err))
  169. return
  170. }
  171. sendAPIResponse(w, r, err, "Admin deleted", http.StatusOK)
  172. }
  173. func getAdminProfile(w http.ResponseWriter, r *http.Request) {
  174. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  175. claims, err := getTokenClaims(r)
  176. if err != nil || claims.Username == "" {
  177. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  178. return
  179. }
  180. admin, err := dataprovider.AdminExists(claims.Username)
  181. if err != nil {
  182. sendAPIResponse(w, r, err, "", getRespStatus(err))
  183. return
  184. }
  185. resp := adminProfile{
  186. baseProfile: baseProfile{
  187. Email: admin.Email,
  188. Description: admin.Description,
  189. AllowAPIKeyAuth: admin.Filters.AllowAPIKeyAuth,
  190. },
  191. }
  192. render.JSON(w, r, resp)
  193. }
  194. func updateAdminProfile(w http.ResponseWriter, r *http.Request) {
  195. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  196. claims, err := getTokenClaims(r)
  197. if err != nil || claims.Username == "" {
  198. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  199. return
  200. }
  201. admin, err := dataprovider.AdminExists(claims.Username)
  202. if err != nil {
  203. sendAPIResponse(w, r, err, "", getRespStatus(err))
  204. return
  205. }
  206. var req adminProfile
  207. err = render.DecodeJSON(r.Body, &req)
  208. if err != nil {
  209. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  210. return
  211. }
  212. admin.Email = req.Email
  213. admin.Description = req.Description
  214. admin.Filters.AllowAPIKeyAuth = req.AllowAPIKeyAuth
  215. if err := dataprovider.UpdateAdmin(&admin, dataprovider.ActionExecutorSelf, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role); err != nil {
  216. sendAPIResponse(w, r, err, "", getRespStatus(err))
  217. return
  218. }
  219. sendAPIResponse(w, r, err, "Profile updated", http.StatusOK)
  220. }
  221. func forgotAdminPassword(w http.ResponseWriter, r *http.Request) {
  222. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  223. if !smtp.IsEnabled() {
  224. sendAPIResponse(w, r, nil, "No SMTP configuration", http.StatusBadRequest)
  225. return
  226. }
  227. err := handleForgotPassword(r, getURLParam(r, "username"), true)
  228. if err != nil {
  229. sendAPIResponse(w, r, err, "", getRespStatus(err))
  230. return
  231. }
  232. sendAPIResponse(w, r, err, "Check your email for the confirmation code", http.StatusOK)
  233. }
  234. func resetAdminPassword(w http.ResponseWriter, r *http.Request) {
  235. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  236. var req pwdReset
  237. err := render.DecodeJSON(r.Body, &req)
  238. if err != nil {
  239. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  240. return
  241. }
  242. _, _, err = handleResetPassword(r, req.Code, req.Password, true)
  243. if err != nil {
  244. sendAPIResponse(w, r, err, "", getRespStatus(err))
  245. return
  246. }
  247. sendAPIResponse(w, r, err, "Password reset successful", http.StatusOK)
  248. }
  249. func changeAdminPassword(w http.ResponseWriter, r *http.Request) {
  250. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  251. var pwd pwdChange
  252. err := render.DecodeJSON(r.Body, &pwd)
  253. if err != nil {
  254. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  255. return
  256. }
  257. err = doChangeAdminPassword(r, pwd.CurrentPassword, pwd.NewPassword, pwd.NewPassword)
  258. if err != nil {
  259. sendAPIResponse(w, r, err, "", getRespStatus(err))
  260. return
  261. }
  262. sendAPIResponse(w, r, err, "Password updated", http.StatusOK)
  263. }
  264. func doChangeAdminPassword(r *http.Request, currentPassword, newPassword, confirmNewPassword string) error {
  265. if currentPassword == "" || newPassword == "" || confirmNewPassword == "" {
  266. return util.NewValidationError("please provide the current password and the new one two times")
  267. }
  268. if newPassword != confirmNewPassword {
  269. return util.NewValidationError("the two password fields do not match")
  270. }
  271. if currentPassword == newPassword {
  272. return util.NewValidationError("the new password must be different from the current one")
  273. }
  274. claims, err := getTokenClaims(r)
  275. if err != nil {
  276. return err
  277. }
  278. admin, err := dataprovider.AdminExists(claims.Username)
  279. if err != nil {
  280. return err
  281. }
  282. match, err := admin.CheckPassword(currentPassword)
  283. if !match || err != nil {
  284. return util.NewValidationError("current password does not match")
  285. }
  286. admin.Password = newPassword
  287. return dataprovider.UpdateAdmin(&admin, dataprovider.ActionExecutorSelf, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  288. }
  289. func getTokenClaims(r *http.Request) (jwtTokenClaims, error) {
  290. tokenClaims := jwtTokenClaims{}
  291. _, claims, err := jwtauth.FromContext(r.Context())
  292. if err != nil {
  293. return tokenClaims, err
  294. }
  295. tokenClaims.Decode(claims)
  296. return tokenClaims, nil
  297. }