1
0

api_user.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  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, http.StatusOK)
  59. }
  60. func renderUser(w http.ResponseWriter, r *http.Request, username string, claims *jwtTokenClaims, status int) {
  61. user, err := dataprovider.UserExists(username, claims.Role)
  62. if err != nil {
  63. sendAPIResponse(w, r, err, "", getRespStatus(err))
  64. return
  65. }
  66. if hideConfidentialData(claims, r) {
  67. user.PrepareForRendering()
  68. }
  69. if status != http.StatusOK {
  70. ctx := context.WithValue(r.Context(), render.StatusCtxKey, status)
  71. render.JSON(w, r.WithContext(ctx), user)
  72. } else {
  73. render.JSON(w, r, user)
  74. }
  75. }
  76. func addUser(w http.ResponseWriter, r *http.Request) {
  77. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  78. claims, err := getTokenClaims(r)
  79. if err != nil || claims.Username == "" {
  80. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  81. return
  82. }
  83. admin, err := dataprovider.AdminExists(claims.Username)
  84. if err != nil {
  85. sendAPIResponse(w, r, err, "", getRespStatus(err))
  86. return
  87. }
  88. var user dataprovider.User
  89. if admin.Filters.Preferences.DefaultUsersExpiration > 0 {
  90. user.ExpirationDate = util.GetTimeAsMsSinceEpoch(time.Now().Add(24 * time.Hour * time.Duration(admin.Filters.Preferences.DefaultUsersExpiration)))
  91. }
  92. err = render.DecodeJSON(r.Body, &user)
  93. if err != nil {
  94. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  95. return
  96. }
  97. if claims.Role != "" {
  98. user.Role = claims.Role
  99. }
  100. user.LastPasswordChange = 0
  101. user.Filters.RecoveryCodes = nil
  102. user.Filters.TOTPConfig = dataprovider.UserTOTPConfig{
  103. Enabled: false,
  104. }
  105. err = dataprovider.AddUser(&user, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  106. if err != nil {
  107. sendAPIResponse(w, r, err, "", getRespStatus(err))
  108. return
  109. }
  110. w.Header().Add("Location", fmt.Sprintf("%s/%s", userPath, url.PathEscape(user.Username)))
  111. renderUser(w, r, user.Username, &claims, http.StatusCreated)
  112. }
  113. func disableUser2FA(w http.ResponseWriter, r *http.Request) {
  114. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  115. claims, err := getTokenClaims(r)
  116. if err != nil || claims.Username == "" {
  117. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  118. return
  119. }
  120. username := getURLParam(r, "username")
  121. user, err := dataprovider.UserExists(username, claims.Role)
  122. if err != nil {
  123. sendAPIResponse(w, r, err, "", getRespStatus(err))
  124. return
  125. }
  126. user.Filters.RecoveryCodes = nil
  127. user.Filters.TOTPConfig = dataprovider.UserTOTPConfig{
  128. Enabled: false,
  129. }
  130. if err := dataprovider.UpdateUser(&user, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role); err != nil {
  131. sendAPIResponse(w, r, err, "", getRespStatus(err))
  132. return
  133. }
  134. sendAPIResponse(w, r, nil, "2FA disabled", http.StatusOK)
  135. }
  136. func updateUser(w http.ResponseWriter, r *http.Request) {
  137. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  138. claims, err := getTokenClaims(r)
  139. if err != nil || claims.Username == "" {
  140. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  141. return
  142. }
  143. username := getURLParam(r, "username")
  144. disconnect := 0
  145. if _, ok := r.URL.Query()["disconnect"]; ok {
  146. disconnect, err = strconv.Atoi(r.URL.Query().Get("disconnect"))
  147. if err != nil {
  148. err = fmt.Errorf("invalid disconnect parameter: %v", err)
  149. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  150. return
  151. }
  152. }
  153. user, err := dataprovider.UserExists(username, claims.Role)
  154. if err != nil {
  155. sendAPIResponse(w, r, err, "", getRespStatus(err))
  156. return
  157. }
  158. var updatedUser dataprovider.User
  159. updatedUser.Password = user.Password
  160. err = render.DecodeJSON(r.Body, &updatedUser)
  161. if err != nil {
  162. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  163. return
  164. }
  165. updatedUser.ID = user.ID
  166. updatedUser.Username = user.Username
  167. updatedUser.Filters.RecoveryCodes = user.Filters.RecoveryCodes
  168. updatedUser.Filters.TOTPConfig = user.Filters.TOTPConfig
  169. updatedUser.LastPasswordChange = user.LastPasswordChange
  170. updatedUser.SetEmptySecretsIfNil()
  171. updateEncryptedSecrets(&updatedUser.FsConfig, user.FsConfig.S3Config.AccessSecret, user.FsConfig.AzBlobConfig.AccountKey,
  172. user.FsConfig.AzBlobConfig.SASURL, user.FsConfig.GCSConfig.Credentials, user.FsConfig.CryptConfig.Passphrase,
  173. user.FsConfig.SFTPConfig.Password, user.FsConfig.SFTPConfig.PrivateKey, user.FsConfig.SFTPConfig.KeyPassphrase,
  174. user.FsConfig.HTTPConfig.Password, user.FsConfig.HTTPConfig.APIKey)
  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, 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, currentS3AccessSecret, currentAzAccountKey, currentAzSASUrl,
  252. currentGCSCredentials, currentCryptoPassphrase, currentSFTPPassword, currentSFTPKey, currentSFTPKeyPassphrase,
  253. currentHTTPPassword, currentHTTPAPIKey *kms.Secret) {
  254. // we use the new access secret if plain or empty, otherwise the old value
  255. switch fsConfig.Provider {
  256. case sdk.S3FilesystemProvider:
  257. if fsConfig.S3Config.AccessSecret.IsNotPlainAndNotEmpty() {
  258. fsConfig.S3Config.AccessSecret = currentS3AccessSecret
  259. }
  260. case sdk.AzureBlobFilesystemProvider:
  261. if fsConfig.AzBlobConfig.AccountKey.IsNotPlainAndNotEmpty() {
  262. fsConfig.AzBlobConfig.AccountKey = currentAzAccountKey
  263. }
  264. if fsConfig.AzBlobConfig.SASURL.IsNotPlainAndNotEmpty() {
  265. fsConfig.AzBlobConfig.SASURL = currentAzSASUrl
  266. }
  267. case sdk.GCSFilesystemProvider:
  268. // for GCS credentials will be cleared if we enable automatic credentials
  269. // so keep the old credentials here if no new credentials are provided
  270. if !fsConfig.GCSConfig.Credentials.IsPlain() {
  271. fsConfig.GCSConfig.Credentials = currentGCSCredentials
  272. }
  273. case sdk.CryptedFilesystemProvider:
  274. if fsConfig.CryptConfig.Passphrase.IsNotPlainAndNotEmpty() {
  275. fsConfig.CryptConfig.Passphrase = currentCryptoPassphrase
  276. }
  277. case sdk.SFTPFilesystemProvider:
  278. updateSFTPFsEncryptedSecrets(fsConfig, currentSFTPPassword, currentSFTPKey, currentSFTPKeyPassphrase)
  279. case sdk.HTTPFilesystemProvider:
  280. updateHTTPFsEncryptedSecrets(fsConfig, currentHTTPPassword, currentHTTPAPIKey)
  281. }
  282. }
  283. func updateSFTPFsEncryptedSecrets(fsConfig *vfs.Filesystem, currentSFTPPassword, currentSFTPKey,
  284. currentSFTPKeyPassphrase *kms.Secret,
  285. ) {
  286. if fsConfig.SFTPConfig.Password.IsNotPlainAndNotEmpty() {
  287. fsConfig.SFTPConfig.Password = currentSFTPPassword
  288. }
  289. if fsConfig.SFTPConfig.PrivateKey.IsNotPlainAndNotEmpty() {
  290. fsConfig.SFTPConfig.PrivateKey = currentSFTPKey
  291. }
  292. if fsConfig.SFTPConfig.KeyPassphrase.IsNotPlainAndNotEmpty() {
  293. fsConfig.SFTPConfig.KeyPassphrase = currentSFTPKeyPassphrase
  294. }
  295. }
  296. func updateHTTPFsEncryptedSecrets(fsConfig *vfs.Filesystem, currentHTTPPassword, currentHTTPAPIKey *kms.Secret) {
  297. if fsConfig.HTTPConfig.Password.IsNotPlainAndNotEmpty() {
  298. fsConfig.HTTPConfig.Password = currentHTTPPassword
  299. }
  300. if fsConfig.HTTPConfig.APIKey.IsNotPlainAndNotEmpty() {
  301. fsConfig.HTTPConfig.APIKey = currentHTTPAPIKey
  302. }
  303. }