api_admin.go 11 KB

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