api_user.go 11 KB

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