api_admin.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  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. var updatedAdmin dataprovider.Admin
  108. err = render.DecodeJSON(r.Body, &updatedAdmin)
  109. if err != nil {
  110. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  111. return
  112. }
  113. claims, err := getTokenClaims(r)
  114. if err != nil || claims.Username == "" {
  115. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  116. return
  117. }
  118. if username == claims.Username {
  119. if claims.APIKeyID != "" {
  120. sendAPIResponse(w, r, errors.New("updating the admin impersonated with an API key is not allowed"), "",
  121. http.StatusBadRequest)
  122. return
  123. }
  124. if claims.isCriticalPermRemoved(updatedAdmin.Permissions) {
  125. sendAPIResponse(w, r, errors.New("you cannot remove these permissions to yourself"), "", http.StatusBadRequest)
  126. return
  127. }
  128. if updatedAdmin.Status == 0 {
  129. sendAPIResponse(w, r, errors.New("you cannot disable yourself"), "", http.StatusBadRequest)
  130. return
  131. }
  132. if updatedAdmin.Role != claims.Role {
  133. sendAPIResponse(w, r, errors.New("you cannot add/change your role"), "", http.StatusBadRequest)
  134. return
  135. }
  136. }
  137. updatedAdmin.ID = admin.ID
  138. updatedAdmin.Username = admin.Username
  139. if updatedAdmin.Password == "" {
  140. updatedAdmin.Password = admin.Password
  141. }
  142. updatedAdmin.Filters.TOTPConfig = admin.Filters.TOTPConfig
  143. updatedAdmin.Filters.RecoveryCodes = admin.Filters.RecoveryCodes
  144. err = dataprovider.UpdateAdmin(&updatedAdmin, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  145. if err != nil {
  146. sendAPIResponse(w, r, err, "", getRespStatus(err))
  147. return
  148. }
  149. sendAPIResponse(w, r, nil, "Admin updated", http.StatusOK)
  150. }
  151. func deleteAdmin(w http.ResponseWriter, r *http.Request) {
  152. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  153. username := getURLParam(r, "username")
  154. claims, err := getTokenClaims(r)
  155. if err != nil || claims.Username == "" {
  156. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  157. return
  158. }
  159. if username == claims.Username {
  160. sendAPIResponse(w, r, errors.New("you cannot delete yourself"), "", http.StatusBadRequest)
  161. return
  162. }
  163. err = dataprovider.DeleteAdmin(username, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  164. if err != nil {
  165. sendAPIResponse(w, r, err, "", getRespStatus(err))
  166. return
  167. }
  168. sendAPIResponse(w, r, err, "Admin deleted", http.StatusOK)
  169. }
  170. func getAdminProfile(w http.ResponseWriter, r *http.Request) {
  171. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  172. claims, err := getTokenClaims(r)
  173. if err != nil || claims.Username == "" {
  174. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  175. return
  176. }
  177. admin, err := dataprovider.AdminExists(claims.Username)
  178. if err != nil {
  179. sendAPIResponse(w, r, err, "", getRespStatus(err))
  180. return
  181. }
  182. resp := adminProfile{
  183. baseProfile: baseProfile{
  184. Email: admin.Email,
  185. Description: admin.Description,
  186. AllowAPIKeyAuth: admin.Filters.AllowAPIKeyAuth,
  187. },
  188. }
  189. render.JSON(w, r, resp)
  190. }
  191. func updateAdminProfile(w http.ResponseWriter, r *http.Request) {
  192. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  193. claims, err := getTokenClaims(r)
  194. if err != nil || claims.Username == "" {
  195. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  196. return
  197. }
  198. admin, err := dataprovider.AdminExists(claims.Username)
  199. if err != nil {
  200. sendAPIResponse(w, r, err, "", getRespStatus(err))
  201. return
  202. }
  203. var req adminProfile
  204. err = render.DecodeJSON(r.Body, &req)
  205. if err != nil {
  206. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  207. return
  208. }
  209. admin.Email = req.Email
  210. admin.Description = req.Description
  211. admin.Filters.AllowAPIKeyAuth = req.AllowAPIKeyAuth
  212. if err := dataprovider.UpdateAdmin(&admin, dataprovider.ActionExecutorSelf, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role); err != nil {
  213. sendAPIResponse(w, r, err, "", getRespStatus(err))
  214. return
  215. }
  216. sendAPIResponse(w, r, err, "Profile updated", http.StatusOK)
  217. }
  218. func forgotAdminPassword(w http.ResponseWriter, r *http.Request) {
  219. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  220. if !smtp.IsEnabled() {
  221. sendAPIResponse(w, r, nil, "No SMTP configuration", http.StatusBadRequest)
  222. return
  223. }
  224. err := handleForgotPassword(r, getURLParam(r, "username"), true)
  225. if err != nil {
  226. sendAPIResponse(w, r, err, "", getRespStatus(err))
  227. return
  228. }
  229. sendAPIResponse(w, r, err, "Check your email for the confirmation code", http.StatusOK)
  230. }
  231. func resetAdminPassword(w http.ResponseWriter, r *http.Request) {
  232. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  233. var req pwdReset
  234. err := render.DecodeJSON(r.Body, &req)
  235. if err != nil {
  236. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  237. return
  238. }
  239. _, _, err = handleResetPassword(r, req.Code, req.Password, true)
  240. if err != nil {
  241. sendAPIResponse(w, r, err, "", getRespStatus(err))
  242. return
  243. }
  244. sendAPIResponse(w, r, err, "Password reset successful", http.StatusOK)
  245. }
  246. func changeAdminPassword(w http.ResponseWriter, r *http.Request) {
  247. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  248. var pwd pwdChange
  249. err := render.DecodeJSON(r.Body, &pwd)
  250. if err != nil {
  251. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  252. return
  253. }
  254. err = doChangeAdminPassword(r, pwd.CurrentPassword, pwd.NewPassword, pwd.NewPassword)
  255. if err != nil {
  256. sendAPIResponse(w, r, err, "", getRespStatus(err))
  257. return
  258. }
  259. sendAPIResponse(w, r, err, "Password updated", http.StatusOK)
  260. }
  261. func doChangeAdminPassword(r *http.Request, currentPassword, newPassword, confirmNewPassword string) error {
  262. if currentPassword == "" || newPassword == "" || confirmNewPassword == "" {
  263. return util.NewValidationError("please provide the current password and the new one two times")
  264. }
  265. if newPassword != confirmNewPassword {
  266. return util.NewValidationError("the two password fields do not match")
  267. }
  268. if currentPassword == newPassword {
  269. return util.NewValidationError("the new password must be different from the current one")
  270. }
  271. claims, err := getTokenClaims(r)
  272. if err != nil {
  273. return err
  274. }
  275. admin, err := dataprovider.AdminExists(claims.Username)
  276. if err != nil {
  277. return err
  278. }
  279. match, err := admin.CheckPassword(currentPassword)
  280. if !match || err != nil {
  281. return util.NewValidationError("current password does not match")
  282. }
  283. admin.Password = newPassword
  284. return dataprovider.UpdateAdmin(&admin, dataprovider.ActionExecutorSelf, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  285. }
  286. func getTokenClaims(r *http.Request) (jwtTokenClaims, error) {
  287. tokenClaims := jwtTokenClaims{}
  288. _, claims, err := jwtauth.FromContext(r.Context())
  289. if err != nil {
  290. return tokenClaims, err
  291. }
  292. tokenClaims.Decode(claims)
  293. return tokenClaims, nil
  294. }