api_user.go 11 KB

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