api_user.go 11 KB

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