api_user.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  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. "fmt"
  18. "net/http"
  19. "net/url"
  20. "strconv"
  21. "time"
  22. "github.com/go-chi/render"
  23. "github.com/sftpgo/sdk"
  24. "github.com/drakkan/sftpgo/v2/internal/common"
  25. "github.com/drakkan/sftpgo/v2/internal/dataprovider"
  26. "github.com/drakkan/sftpgo/v2/internal/logger"
  27. "github.com/drakkan/sftpgo/v2/internal/smtp"
  28. "github.com/drakkan/sftpgo/v2/internal/util"
  29. "github.com/drakkan/sftpgo/v2/internal/vfs"
  30. )
  31. func getUsers(w http.ResponseWriter, r *http.Request) {
  32. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  33. limit, offset, order, err := getSearchFilters(w, r)
  34. if err != nil {
  35. return
  36. }
  37. claims, err := getTokenClaims(r)
  38. if err != nil || claims.Username == "" {
  39. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  40. return
  41. }
  42. users, err := dataprovider.GetUsers(limit, offset, order, claims.Role)
  43. if err == nil {
  44. render.JSON(w, r, users)
  45. } else {
  46. sendAPIResponse(w, r, err, "", http.StatusInternalServerError)
  47. }
  48. }
  49. func getUserByUsername(w http.ResponseWriter, r *http.Request) {
  50. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  51. claims, err := getTokenClaims(r)
  52. if err != nil || claims.Username == "" {
  53. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  54. return
  55. }
  56. username := getURLParam(r, "username")
  57. renderUser(w, r, username, &claims, http.StatusOK)
  58. }
  59. func renderUser(w http.ResponseWriter, r *http.Request, username string, claims *jwtTokenClaims, status int) {
  60. user, err := dataprovider.UserExists(username, claims.Role)
  61. if err != nil {
  62. sendAPIResponse(w, r, err, "", getRespStatus(err))
  63. return
  64. }
  65. if hideConfidentialData(claims, r) {
  66. user.PrepareForRendering()
  67. }
  68. if status != http.StatusOK {
  69. ctx := context.WithValue(r.Context(), render.StatusCtxKey, status)
  70. render.JSON(w, r.WithContext(ctx), user)
  71. } else {
  72. render.JSON(w, r, user)
  73. }
  74. }
  75. func addUser(w http.ResponseWriter, r *http.Request) {
  76. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  77. claims, err := getTokenClaims(r)
  78. if err != nil || claims.Username == "" {
  79. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  80. return
  81. }
  82. admin, err := dataprovider.AdminExists(claims.Username)
  83. if err != nil {
  84. sendAPIResponse(w, r, err, "", getRespStatus(err))
  85. return
  86. }
  87. var user dataprovider.User
  88. if admin.Filters.Preferences.DefaultUsersExpiration > 0 {
  89. user.ExpirationDate = util.GetTimeAsMsSinceEpoch(time.Now().Add(24 * time.Hour * time.Duration(admin.Filters.Preferences.DefaultUsersExpiration)))
  90. }
  91. err = render.DecodeJSON(r.Body, &user)
  92. if err != nil {
  93. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  94. return
  95. }
  96. if claims.Role != "" {
  97. user.Role = claims.Role
  98. }
  99. user.LastPasswordChange = 0
  100. user.Filters.RecoveryCodes = nil
  101. user.Filters.TOTPConfig = dataprovider.UserTOTPConfig{
  102. Enabled: false,
  103. }
  104. err = dataprovider.AddUser(&user, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  105. if err != nil {
  106. sendAPIResponse(w, r, err, "", getRespStatus(err))
  107. return
  108. }
  109. w.Header().Add("Location", fmt.Sprintf("%s/%s", userPath, url.PathEscape(user.Username)))
  110. renderUser(w, r, user.Username, &claims, http.StatusCreated)
  111. }
  112. func disableUser2FA(w http.ResponseWriter, r *http.Request) {
  113. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  114. claims, err := getTokenClaims(r)
  115. if err != nil || claims.Username == "" {
  116. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  117. return
  118. }
  119. username := getURLParam(r, "username")
  120. user, err := dataprovider.UserExists(username, claims.Role)
  121. if err != nil {
  122. sendAPIResponse(w, r, err, "", getRespStatus(err))
  123. return
  124. }
  125. if !user.Filters.TOTPConfig.Enabled {
  126. sendAPIResponse(w, r, nil, "two-factor authentication is not enabled", http.StatusBadRequest)
  127. return
  128. }
  129. user.Filters.RecoveryCodes = nil
  130. user.Filters.TOTPConfig = dataprovider.UserTOTPConfig{
  131. Enabled: false,
  132. }
  133. if err := dataprovider.UpdateUser(&user, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role); err != nil {
  134. sendAPIResponse(w, r, err, "", getRespStatus(err))
  135. return
  136. }
  137. sendAPIResponse(w, r, nil, "2FA disabled", http.StatusOK)
  138. }
  139. func updateUser(w http.ResponseWriter, r *http.Request) {
  140. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  141. claims, err := getTokenClaims(r)
  142. if err != nil || claims.Username == "" {
  143. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  144. return
  145. }
  146. username := getURLParam(r, "username")
  147. disconnect := 0
  148. if _, ok := r.URL.Query()["disconnect"]; ok {
  149. disconnect, err = strconv.Atoi(r.URL.Query().Get("disconnect"))
  150. if err != nil {
  151. err = fmt.Errorf("invalid disconnect parameter: %v", err)
  152. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  153. return
  154. }
  155. }
  156. user, err := dataprovider.UserExists(username, claims.Role)
  157. if err != nil {
  158. sendAPIResponse(w, r, err, "", getRespStatus(err))
  159. return
  160. }
  161. var updatedUser dataprovider.User
  162. updatedUser.Password = user.Password
  163. err = render.DecodeJSON(r.Body, &updatedUser)
  164. if err != nil {
  165. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  166. return
  167. }
  168. updatedUser.ID = user.ID
  169. updatedUser.Username = user.Username
  170. updatedUser.Filters.RecoveryCodes = user.Filters.RecoveryCodes
  171. updatedUser.Filters.TOTPConfig = user.Filters.TOTPConfig
  172. updatedUser.LastPasswordChange = user.LastPasswordChange
  173. updatedUser.SetEmptySecretsIfNil()
  174. updateEncryptedSecrets(&updatedUser.FsConfig, &user.FsConfig)
  175. if claims.Role != "" {
  176. updatedUser.Role = claims.Role
  177. }
  178. err = dataprovider.UpdateUser(&updatedUser, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  179. if err != nil {
  180. sendAPIResponse(w, r, err, "", getRespStatus(err))
  181. return
  182. }
  183. sendAPIResponse(w, r, err, "User updated", http.StatusOK)
  184. if disconnect == 1 {
  185. disconnectUser(user.Username, claims.Username, claims.Role)
  186. }
  187. }
  188. func deleteUser(w http.ResponseWriter, r *http.Request) {
  189. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  190. claims, err := getTokenClaims(r)
  191. if err != nil || claims.Username == "" {
  192. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  193. return
  194. }
  195. username := getURLParam(r, "username")
  196. err = dataprovider.DeleteUser(username, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  197. if err != nil {
  198. sendAPIResponse(w, r, err, "", getRespStatus(err))
  199. return
  200. }
  201. sendAPIResponse(w, r, err, "User deleted", http.StatusOK)
  202. disconnectUser(dataprovider.ConvertName(username), claims.Username, claims.Role)
  203. }
  204. func forgotUserPassword(w http.ResponseWriter, r *http.Request) {
  205. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  206. if !smtp.IsEnabled() {
  207. sendAPIResponse(w, r, nil, "No SMTP configuration", http.StatusBadRequest)
  208. return
  209. }
  210. err := handleForgotPassword(r, getURLParam(r, "username"), false)
  211. if err != nil {
  212. sendAPIResponse(w, r, err, "", getRespStatus(err))
  213. return
  214. }
  215. sendAPIResponse(w, r, err, "Check your email for the confirmation code", http.StatusOK)
  216. }
  217. func resetUserPassword(w http.ResponseWriter, r *http.Request) {
  218. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  219. var req pwdReset
  220. err := render.DecodeJSON(r.Body, &req)
  221. if err != nil {
  222. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  223. return
  224. }
  225. _, _, err = handleResetPassword(r, req.Code, req.Password, req.Password, false)
  226. if err != nil {
  227. sendAPIResponse(w, r, err, "", getRespStatus(err))
  228. return
  229. }
  230. sendAPIResponse(w, r, err, "Password reset successful", http.StatusOK)
  231. }
  232. func disconnectUser(username, admin, role string) {
  233. for _, stat := range common.Connections.GetStats("") {
  234. if stat.Username == username {
  235. common.Connections.Close(stat.ConnectionID, "")
  236. }
  237. }
  238. for _, stat := range getNodesConnections(admin, role) {
  239. if stat.Username == username {
  240. n, err := dataprovider.GetNodeByName(stat.Node)
  241. if err != nil {
  242. logger.Warn(logSender, "", "unable to disconnect user %q, error getting node %q: %v", username, stat.Node, err)
  243. continue
  244. }
  245. if err := n.SendDeleteRequest(admin, role, fmt.Sprintf("%s/%s", activeConnectionsPath, stat.ConnectionID)); err != nil {
  246. logger.Warn(logSender, "", "unable to disconnect user %q from node %q, error: %v", username, n.Name, err)
  247. }
  248. }
  249. }
  250. }
  251. func updateEncryptedSecrets(fsConfig *vfs.Filesystem, currentFsConfig *vfs.Filesystem) {
  252. // we use the new access secret if plain or empty, otherwise the old value
  253. switch fsConfig.Provider {
  254. case sdk.S3FilesystemProvider:
  255. if fsConfig.S3Config.AccessSecret.IsNotPlainAndNotEmpty() {
  256. fsConfig.S3Config.AccessSecret = currentFsConfig.S3Config.AccessSecret
  257. }
  258. case sdk.AzureBlobFilesystemProvider:
  259. if fsConfig.AzBlobConfig.AccountKey.IsNotPlainAndNotEmpty() {
  260. fsConfig.AzBlobConfig.AccountKey = currentFsConfig.AzBlobConfig.AccountKey
  261. }
  262. if fsConfig.AzBlobConfig.SASURL.IsNotPlainAndNotEmpty() {
  263. fsConfig.AzBlobConfig.SASURL = currentFsConfig.AzBlobConfig.SASURL
  264. }
  265. case sdk.GCSFilesystemProvider:
  266. // for GCS credentials will be cleared if we enable automatic credentials
  267. // so keep the old credentials here if no new credentials are provided
  268. if !fsConfig.GCSConfig.Credentials.IsPlain() {
  269. fsConfig.GCSConfig.Credentials = currentFsConfig.GCSConfig.Credentials
  270. }
  271. case sdk.CryptedFilesystemProvider:
  272. if fsConfig.CryptConfig.Passphrase.IsNotPlainAndNotEmpty() {
  273. fsConfig.CryptConfig.Passphrase = currentFsConfig.CryptConfig.Passphrase
  274. }
  275. case sdk.SFTPFilesystemProvider:
  276. updateSFTPFsEncryptedSecrets(fsConfig, currentFsConfig)
  277. case sdk.HTTPFilesystemProvider:
  278. updateHTTPFsEncryptedSecrets(fsConfig, currentFsConfig)
  279. }
  280. }
  281. func updateSFTPFsEncryptedSecrets(fsConfig *vfs.Filesystem, currentFsConfig *vfs.Filesystem) {
  282. if fsConfig.SFTPConfig.Password.IsNotPlainAndNotEmpty() {
  283. fsConfig.SFTPConfig.Password = currentFsConfig.SFTPConfig.Password
  284. }
  285. if fsConfig.SFTPConfig.PrivateKey.IsNotPlainAndNotEmpty() {
  286. fsConfig.SFTPConfig.PrivateKey = currentFsConfig.SFTPConfig.PrivateKey
  287. }
  288. if fsConfig.SFTPConfig.KeyPassphrase.IsNotPlainAndNotEmpty() {
  289. fsConfig.SFTPConfig.KeyPassphrase = currentFsConfig.SFTPConfig.KeyPassphrase
  290. }
  291. }
  292. func updateHTTPFsEncryptedSecrets(fsConfig *vfs.Filesystem, currentFsConfig *vfs.Filesystem) {
  293. if fsConfig.HTTPConfig.Password.IsNotPlainAndNotEmpty() {
  294. fsConfig.HTTPConfig.Password = currentFsConfig.HTTPConfig.Password
  295. }
  296. if fsConfig.HTTPConfig.APIKey.IsNotPlainAndNotEmpty() {
  297. fsConfig.HTTPConfig.APIKey = currentFsConfig.HTTPConfig.APIKey
  298. }
  299. }