api_admin.go 10 KB

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