api_user.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  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/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. if !user.Filters.TOTPConfig.Enabled {
  127. sendAPIResponse(w, r, nil, "two-factor authentication is not enabled", http.StatusBadRequest)
  128. return
  129. }
  130. user.Filters.RecoveryCodes = nil
  131. user.Filters.TOTPConfig = dataprovider.UserTOTPConfig{
  132. Enabled: false,
  133. }
  134. if err := dataprovider.UpdateUser(&user, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role); err != nil {
  135. sendAPIResponse(w, r, err, "", getRespStatus(err))
  136. return
  137. }
  138. sendAPIResponse(w, r, nil, "2FA disabled", http.StatusOK)
  139. }
  140. func updateUser(w http.ResponseWriter, r *http.Request) {
  141. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  142. claims, err := getTokenClaims(r)
  143. if err != nil || claims.Username == "" {
  144. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  145. return
  146. }
  147. username := getURLParam(r, "username")
  148. disconnect := 0
  149. if _, ok := r.URL.Query()["disconnect"]; ok {
  150. disconnect, err = strconv.Atoi(r.URL.Query().Get("disconnect"))
  151. if err != nil {
  152. err = fmt.Errorf("invalid disconnect parameter: %v", err)
  153. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  154. return
  155. }
  156. }
  157. user, err := dataprovider.UserExists(username, claims.Role)
  158. if err != nil {
  159. sendAPIResponse(w, r, err, "", getRespStatus(err))
  160. return
  161. }
  162. var updatedUser dataprovider.User
  163. updatedUser.Password = user.Password
  164. err = render.DecodeJSON(r.Body, &updatedUser)
  165. if err != nil {
  166. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  167. return
  168. }
  169. updatedUser.ID = user.ID
  170. updatedUser.Username = user.Username
  171. updatedUser.Filters.RecoveryCodes = user.Filters.RecoveryCodes
  172. updatedUser.Filters.TOTPConfig = user.Filters.TOTPConfig
  173. updatedUser.LastPasswordChange = user.LastPasswordChange
  174. updatedUser.SetEmptySecretsIfNil()
  175. updateEncryptedSecrets(&updatedUser.FsConfig, user.FsConfig.S3Config.AccessSecret, user.FsConfig.AzBlobConfig.AccountKey,
  176. user.FsConfig.AzBlobConfig.SASURL, user.FsConfig.GCSConfig.Credentials, user.FsConfig.CryptConfig.Passphrase,
  177. user.FsConfig.SFTPConfig.Password, user.FsConfig.SFTPConfig.PrivateKey, user.FsConfig.SFTPConfig.KeyPassphrase,
  178. user.FsConfig.HTTPConfig.Password, user.FsConfig.HTTPConfig.APIKey)
  179. if claims.Role != "" {
  180. updatedUser.Role = claims.Role
  181. }
  182. err = dataprovider.UpdateUser(&updatedUser, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  183. if err != nil {
  184. sendAPIResponse(w, r, err, "", getRespStatus(err))
  185. return
  186. }
  187. sendAPIResponse(w, r, err, "User updated", http.StatusOK)
  188. if disconnect == 1 {
  189. disconnectUser(user.Username, claims.Username, claims.Role)
  190. }
  191. }
  192. func deleteUser(w http.ResponseWriter, r *http.Request) {
  193. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  194. claims, err := getTokenClaims(r)
  195. if err != nil || claims.Username == "" {
  196. sendAPIResponse(w, r, err, "Invalid token claims", http.StatusBadRequest)
  197. return
  198. }
  199. username := getURLParam(r, "username")
  200. err = dataprovider.DeleteUser(username, claims.Username, util.GetIPFromRemoteAddress(r.RemoteAddr), claims.Role)
  201. if err != nil {
  202. sendAPIResponse(w, r, err, "", getRespStatus(err))
  203. return
  204. }
  205. sendAPIResponse(w, r, err, "User deleted", http.StatusOK)
  206. disconnectUser(dataprovider.ConvertName(username), claims.Username, claims.Role)
  207. }
  208. func forgotUserPassword(w http.ResponseWriter, r *http.Request) {
  209. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  210. if !smtp.IsEnabled() {
  211. sendAPIResponse(w, r, nil, "No SMTP configuration", http.StatusBadRequest)
  212. return
  213. }
  214. err := handleForgotPassword(r, getURLParam(r, "username"), false)
  215. if err != nil {
  216. sendAPIResponse(w, r, err, "", getRespStatus(err))
  217. return
  218. }
  219. sendAPIResponse(w, r, err, "Check your email for the confirmation code", http.StatusOK)
  220. }
  221. func resetUserPassword(w http.ResponseWriter, r *http.Request) {
  222. r.Body = http.MaxBytesReader(w, r.Body, maxRequestSize)
  223. var req pwdReset
  224. err := render.DecodeJSON(r.Body, &req)
  225. if err != nil {
  226. sendAPIResponse(w, r, err, "", http.StatusBadRequest)
  227. return
  228. }
  229. _, _, err = handleResetPassword(r, req.Code, req.Password, req.Password, false)
  230. if err != nil {
  231. sendAPIResponse(w, r, err, "", getRespStatus(err))
  232. return
  233. }
  234. sendAPIResponse(w, r, err, "Password reset successful", http.StatusOK)
  235. }
  236. func disconnectUser(username, admin, role string) {
  237. for _, stat := range common.Connections.GetStats("") {
  238. if stat.Username == username {
  239. common.Connections.Close(stat.ConnectionID, "")
  240. }
  241. }
  242. for _, stat := range getNodesConnections(admin, role) {
  243. if stat.Username == username {
  244. n, err := dataprovider.GetNodeByName(stat.Node)
  245. if err != nil {
  246. logger.Warn(logSender, "", "unable to disconnect user %q, error getting node %q: %v", username, stat.Node, err)
  247. continue
  248. }
  249. if err := n.SendDeleteRequest(admin, role, fmt.Sprintf("%s/%s", activeConnectionsPath, stat.ConnectionID)); err != nil {
  250. logger.Warn(logSender, "", "unable to disconnect user %q from node %q, error: %v", username, n.Name, err)
  251. }
  252. }
  253. }
  254. }
  255. func updateEncryptedSecrets(fsConfig *vfs.Filesystem, currentS3AccessSecret, currentAzAccountKey, currentAzSASUrl,
  256. currentGCSCredentials, currentCryptoPassphrase, currentSFTPPassword, currentSFTPKey, currentSFTPKeyPassphrase,
  257. currentHTTPPassword, currentHTTPAPIKey *kms.Secret) {
  258. // we use the new access secret if plain or empty, otherwise the old value
  259. switch fsConfig.Provider {
  260. case sdk.S3FilesystemProvider:
  261. if fsConfig.S3Config.AccessSecret.IsNotPlainAndNotEmpty() {
  262. fsConfig.S3Config.AccessSecret = currentS3AccessSecret
  263. }
  264. case sdk.AzureBlobFilesystemProvider:
  265. if fsConfig.AzBlobConfig.AccountKey.IsNotPlainAndNotEmpty() {
  266. fsConfig.AzBlobConfig.AccountKey = currentAzAccountKey
  267. }
  268. if fsConfig.AzBlobConfig.SASURL.IsNotPlainAndNotEmpty() {
  269. fsConfig.AzBlobConfig.SASURL = currentAzSASUrl
  270. }
  271. case sdk.GCSFilesystemProvider:
  272. // for GCS credentials will be cleared if we enable automatic credentials
  273. // so keep the old credentials here if no new credentials are provided
  274. if !fsConfig.GCSConfig.Credentials.IsPlain() {
  275. fsConfig.GCSConfig.Credentials = currentGCSCredentials
  276. }
  277. case sdk.CryptedFilesystemProvider:
  278. if fsConfig.CryptConfig.Passphrase.IsNotPlainAndNotEmpty() {
  279. fsConfig.CryptConfig.Passphrase = currentCryptoPassphrase
  280. }
  281. case sdk.SFTPFilesystemProvider:
  282. updateSFTPFsEncryptedSecrets(fsConfig, currentSFTPPassword, currentSFTPKey, currentSFTPKeyPassphrase)
  283. case sdk.HTTPFilesystemProvider:
  284. updateHTTPFsEncryptedSecrets(fsConfig, currentHTTPPassword, currentHTTPAPIKey)
  285. }
  286. }
  287. func updateSFTPFsEncryptedSecrets(fsConfig *vfs.Filesystem, currentSFTPPassword, currentSFTPKey,
  288. currentSFTPKeyPassphrase *kms.Secret,
  289. ) {
  290. if fsConfig.SFTPConfig.Password.IsNotPlainAndNotEmpty() {
  291. fsConfig.SFTPConfig.Password = currentSFTPPassword
  292. }
  293. if fsConfig.SFTPConfig.PrivateKey.IsNotPlainAndNotEmpty() {
  294. fsConfig.SFTPConfig.PrivateKey = currentSFTPKey
  295. }
  296. if fsConfig.SFTPConfig.KeyPassphrase.IsNotPlainAndNotEmpty() {
  297. fsConfig.SFTPConfig.KeyPassphrase = currentSFTPKeyPassphrase
  298. }
  299. }
  300. func updateHTTPFsEncryptedSecrets(fsConfig *vfs.Filesystem, currentHTTPPassword, currentHTTPAPIKey *kms.Secret) {
  301. if fsConfig.HTTPConfig.Password.IsNotPlainAndNotEmpty() {
  302. fsConfig.HTTPConfig.Password = currentHTTPPassword
  303. }
  304. if fsConfig.HTTPConfig.APIKey.IsNotPlainAndNotEmpty() {
  305. fsConfig.HTTPConfig.APIKey = currentHTTPAPIKey
  306. }
  307. }