api_admin.go 10 KB

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