server_account.go 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515
  1. package server
  2. import (
  3. "encoding/json"
  4. "heckel.io/ntfy/log"
  5. "heckel.io/ntfy/user"
  6. "heckel.io/ntfy/util"
  7. "net/http"
  8. "net/netip"
  9. "strings"
  10. "time"
  11. )
  12. const (
  13. subscriptionIDLength = 16
  14. subscriptionIDPrefix = "su_"
  15. syncTopicAccountSyncEvent = "sync"
  16. tokenExpiryDuration = 72 * time.Hour // Extend tokens by this much
  17. )
  18. func (s *Server) handleAccountCreate(w http.ResponseWriter, r *http.Request, v *visitor) error {
  19. u := v.User()
  20. if !u.Admin() { // u may be nil, but that's fine
  21. if !s.config.EnableSignup {
  22. return errHTTPBadRequestSignupNotEnabled
  23. } else if u != nil {
  24. return errHTTPUnauthorized // Cannot create account from user context
  25. }
  26. if !v.AccountCreationAllowed() {
  27. return errHTTPTooManyRequestsLimitAccountCreation
  28. }
  29. }
  30. newAccount, err := readJSONWithLimit[apiAccountCreateRequest](r.Body, jsonBodyBytesLimit, false)
  31. if err != nil {
  32. return err
  33. }
  34. if existingUser, _ := s.userManager.User(newAccount.Username); existingUser != nil {
  35. return errHTTPConflictUserExists
  36. }
  37. if err := s.userManager.AddUser(newAccount.Username, newAccount.Password, user.RoleUser); err != nil { // TODO this should return a User
  38. return err
  39. }
  40. return s.writeJSON(w, newSuccessResponse())
  41. }
  42. func (s *Server) handleAccountGet(w http.ResponseWriter, _ *http.Request, v *visitor) error {
  43. info, err := v.Info()
  44. if err != nil {
  45. return err
  46. }
  47. limits, stats := info.Limits, info.Stats
  48. response := &apiAccountResponse{
  49. Limits: &apiAccountLimits{
  50. Basis: string(limits.Basis),
  51. Messages: limits.MessageLimit,
  52. MessagesExpiryDuration: int64(limits.MessageExpiryDuration.Seconds()),
  53. Emails: limits.EmailLimit,
  54. Reservations: limits.ReservationsLimit,
  55. AttachmentTotalSize: limits.AttachmentTotalSizeLimit,
  56. AttachmentFileSize: limits.AttachmentFileSizeLimit,
  57. AttachmentExpiryDuration: int64(limits.AttachmentExpiryDuration.Seconds()),
  58. AttachmentBandwidth: limits.AttachmentBandwidthLimit,
  59. },
  60. Stats: &apiAccountStats{
  61. Messages: stats.Messages,
  62. MessagesRemaining: stats.MessagesRemaining,
  63. Emails: stats.Emails,
  64. EmailsRemaining: stats.EmailsRemaining,
  65. Reservations: stats.Reservations,
  66. ReservationsRemaining: stats.ReservationsRemaining,
  67. AttachmentTotalSize: stats.AttachmentTotalSize,
  68. AttachmentTotalSizeRemaining: stats.AttachmentTotalSizeRemaining,
  69. },
  70. }
  71. u := v.User()
  72. if u != nil {
  73. response.Username = u.Name
  74. response.Role = string(u.Role)
  75. response.SyncTopic = u.SyncTopic
  76. if u.Prefs != nil {
  77. if u.Prefs.Language != nil {
  78. response.Language = *u.Prefs.Language
  79. }
  80. if u.Prefs.Notification != nil {
  81. response.Notification = u.Prefs.Notification
  82. }
  83. if u.Prefs.Subscriptions != nil {
  84. response.Subscriptions = u.Prefs.Subscriptions
  85. }
  86. }
  87. if u.Tier != nil {
  88. response.Tier = &apiAccountTier{
  89. Code: u.Tier.Code,
  90. Name: u.Tier.Name,
  91. }
  92. }
  93. if u.Billing.StripeCustomerID != "" {
  94. response.Billing = &apiAccountBilling{
  95. Customer: true,
  96. Subscription: u.Billing.StripeSubscriptionID != "",
  97. Status: string(u.Billing.StripeSubscriptionStatus),
  98. PaidUntil: u.Billing.StripeSubscriptionPaidUntil.Unix(),
  99. CancelAt: u.Billing.StripeSubscriptionCancelAt.Unix(),
  100. }
  101. }
  102. reservations, err := s.userManager.Reservations(u.Name)
  103. if err != nil {
  104. return err
  105. }
  106. if len(reservations) > 0 {
  107. response.Reservations = make([]*apiAccountReservation, 0)
  108. for _, r := range reservations {
  109. response.Reservations = append(response.Reservations, &apiAccountReservation{
  110. Topic: r.Topic,
  111. Everyone: r.Everyone.String(),
  112. })
  113. }
  114. }
  115. tokens, err := s.userManager.Tokens(u.ID)
  116. if err != nil {
  117. return err
  118. }
  119. if len(tokens) > 0 {
  120. response.Tokens = make([]*apiAccountTokenResponse, 0)
  121. for _, t := range tokens {
  122. var lastOrigin string
  123. if t.LastOrigin != netip.IPv4Unspecified() {
  124. lastOrigin = t.LastOrigin.String()
  125. }
  126. response.Tokens = append(response.Tokens, &apiAccountTokenResponse{
  127. Token: t.Value,
  128. Label: t.Label,
  129. LastAccess: t.LastAccess.Unix(),
  130. LastOrigin: lastOrigin,
  131. Expires: t.Expires.Unix(),
  132. })
  133. }
  134. }
  135. } else {
  136. response.Username = user.Everyone
  137. response.Role = string(user.RoleAnonymous)
  138. }
  139. return s.writeJSON(w, response)
  140. }
  141. func (s *Server) handleAccountDelete(w http.ResponseWriter, r *http.Request, v *visitor) error {
  142. req, err := readJSONWithLimit[apiAccountDeleteRequest](r.Body, jsonBodyBytesLimit, false)
  143. if err != nil {
  144. return err
  145. } else if req.Password == "" {
  146. return errHTTPBadRequest
  147. }
  148. u := v.User()
  149. if _, err := s.userManager.Authenticate(u.Name, req.Password); err != nil {
  150. return errHTTPBadRequestIncorrectPasswordConfirmation
  151. }
  152. if u.Billing.StripeSubscriptionID != "" {
  153. logvr(v, r).Tag(tagPay).Info("Canceling billing subscription for user %s", u.Name)
  154. if _, err := s.stripe.CancelSubscription(u.Billing.StripeSubscriptionID); err != nil {
  155. return err
  156. }
  157. }
  158. if err := s.maybeRemoveMessagesAndExcessReservations(logHTTPPrefix(v, r), u, 0); err != nil {
  159. return err
  160. }
  161. logvr(v, r).Tag(tagAccount).Info("Marking user %s as deleted", u.Name)
  162. if err := s.userManager.MarkUserRemoved(u); err != nil {
  163. return err
  164. }
  165. return s.writeJSON(w, newSuccessResponse())
  166. }
  167. func (s *Server) handleAccountPasswordChange(w http.ResponseWriter, r *http.Request, v *visitor) error {
  168. req, err := readJSONWithLimit[apiAccountPasswordChangeRequest](r.Body, jsonBodyBytesLimit, false)
  169. if err != nil {
  170. return err
  171. } else if req.Password == "" || req.NewPassword == "" {
  172. return errHTTPBadRequest
  173. }
  174. u := v.User()
  175. if _, err := s.userManager.Authenticate(u.Name, req.Password); err != nil {
  176. return errHTTPBadRequestIncorrectPasswordConfirmation
  177. }
  178. if err := s.userManager.ChangePassword(u.Name, req.NewPassword); err != nil {
  179. return err
  180. }
  181. logvr(v, r).Tag(tagAccount).Debug("Changed password for user %s", u.Name)
  182. return s.writeJSON(w, newSuccessResponse())
  183. }
  184. func (s *Server) handleAccountTokenCreate(w http.ResponseWriter, r *http.Request, v *visitor) error {
  185. // TODO rate limit
  186. req, err := readJSONWithLimit[apiAccountTokenIssueRequest](r.Body, jsonBodyBytesLimit, true) // Allow empty body!
  187. if err != nil {
  188. return err
  189. }
  190. var label string
  191. if req.Label != nil {
  192. label = *req.Label
  193. }
  194. expires := time.Now().Add(tokenExpiryDuration)
  195. if req.Expires != nil {
  196. expires = time.Unix(*req.Expires, 0)
  197. }
  198. u := v.User()
  199. token, err := s.userManager.CreateToken(u.ID, label, expires, v.IP())
  200. if err != nil {
  201. return err
  202. }
  203. logvr(v, r).Tag(tagAccount).Debug("Created token for user %s", u.Name)
  204. response := &apiAccountTokenResponse{
  205. Token: token.Value,
  206. Label: token.Label,
  207. LastAccess: token.LastAccess.Unix(),
  208. LastOrigin: token.LastOrigin.String(),
  209. Expires: token.Expires.Unix(),
  210. }
  211. return s.writeJSON(w, response)
  212. }
  213. func (s *Server) handleAccountTokenUpdate(w http.ResponseWriter, r *http.Request, v *visitor) error {
  214. // TODO rate limit
  215. u := v.User()
  216. req, err := readJSONWithLimit[apiAccountTokenUpdateRequest](r.Body, jsonBodyBytesLimit, true) // Allow empty body!
  217. if err != nil {
  218. return err
  219. } else if req.Token == "" {
  220. req.Token = u.Token
  221. if req.Token == "" {
  222. return errHTTPBadRequestNoTokenProvided
  223. }
  224. }
  225. var expires *time.Time
  226. if req.Expires != nil {
  227. expires = util.Time(time.Unix(*req.Expires, 0))
  228. } else if req.Label == nil {
  229. // If label and expires are not set, simply extend the token by 72 hours
  230. expires = util.Time(time.Now().Add(tokenExpiryDuration))
  231. }
  232. token, err := s.userManager.ChangeToken(u.ID, req.Token, req.Label, expires)
  233. if err != nil {
  234. return err
  235. }
  236. response := &apiAccountTokenResponse{
  237. Token: token.Value,
  238. Label: token.Label,
  239. LastAccess: token.LastAccess.Unix(),
  240. LastOrigin: token.LastOrigin.String(),
  241. Expires: token.Expires.Unix(),
  242. }
  243. return s.writeJSON(w, response)
  244. }
  245. func (s *Server) handleAccountTokenDelete(w http.ResponseWriter, r *http.Request, v *visitor) error {
  246. // TODO rate limit
  247. u := v.User()
  248. token := readParam(r, "X-Token", "Token") // DELETEs cannot have a body, and we don't want it in the path
  249. if token == "" {
  250. token = u.Token
  251. if token == "" {
  252. return errHTTPBadRequestNoTokenProvided
  253. }
  254. }
  255. if err := s.userManager.RemoveToken(u.ID, token); err != nil {
  256. return err
  257. }
  258. return s.writeJSON(w, newSuccessResponse())
  259. }
  260. func (s *Server) handleAccountSettingsChange(w http.ResponseWriter, r *http.Request, v *visitor) error {
  261. newPrefs, err := readJSONWithLimit[user.Prefs](r.Body, jsonBodyBytesLimit, false)
  262. if err != nil {
  263. return err
  264. }
  265. u := v.User()
  266. if u.Prefs == nil {
  267. u.Prefs = &user.Prefs{}
  268. }
  269. prefs := u.Prefs
  270. if newPrefs.Language != nil {
  271. prefs.Language = newPrefs.Language
  272. }
  273. if newPrefs.Notification != nil {
  274. if prefs.Notification == nil {
  275. prefs.Notification = &user.NotificationPrefs{}
  276. }
  277. if newPrefs.Notification.DeleteAfter != nil {
  278. prefs.Notification.DeleteAfter = newPrefs.Notification.DeleteAfter
  279. }
  280. if newPrefs.Notification.Sound != nil {
  281. prefs.Notification.Sound = newPrefs.Notification.Sound
  282. }
  283. if newPrefs.Notification.MinPriority != nil {
  284. prefs.Notification.MinPriority = newPrefs.Notification.MinPriority
  285. }
  286. }
  287. if err := s.userManager.ChangeSettings(u); err != nil {
  288. return err
  289. }
  290. return s.writeJSON(w, newSuccessResponse())
  291. }
  292. func (s *Server) handleAccountSubscriptionAdd(w http.ResponseWriter, r *http.Request, v *visitor) error {
  293. newSubscription, err := readJSONWithLimit[user.Subscription](r.Body, jsonBodyBytesLimit, false)
  294. if err != nil {
  295. return err
  296. }
  297. u := v.User()
  298. if u.Prefs == nil {
  299. u.Prefs = &user.Prefs{}
  300. }
  301. newSubscription.ID = "" // Client cannot set ID
  302. for _, subscription := range u.Prefs.Subscriptions {
  303. if newSubscription.BaseURL == subscription.BaseURL && newSubscription.Topic == subscription.Topic {
  304. newSubscription = subscription
  305. break
  306. }
  307. }
  308. if newSubscription.ID == "" {
  309. newSubscription.ID = util.RandomStringPrefix(subscriptionIDPrefix, subscriptionIDLength)
  310. u.Prefs.Subscriptions = append(u.Prefs.Subscriptions, newSubscription)
  311. if err := s.userManager.ChangeSettings(u); err != nil {
  312. return err
  313. }
  314. }
  315. return s.writeJSON(w, newSubscription)
  316. }
  317. func (s *Server) handleAccountSubscriptionChange(w http.ResponseWriter, r *http.Request, v *visitor) error {
  318. matches := apiAccountSubscriptionSingleRegex.FindStringSubmatch(r.URL.Path)
  319. if len(matches) != 2 {
  320. return errHTTPInternalErrorInvalidPath
  321. }
  322. subscriptionID := matches[1]
  323. updatedSubscription, err := readJSONWithLimit[user.Subscription](r.Body, jsonBodyBytesLimit, false)
  324. if err != nil {
  325. return err
  326. }
  327. u := v.User()
  328. if u.Prefs == nil || u.Prefs.Subscriptions == nil {
  329. return errHTTPNotFound
  330. }
  331. var subscription *user.Subscription
  332. for _, sub := range u.Prefs.Subscriptions {
  333. if sub.ID == subscriptionID {
  334. sub.DisplayName = updatedSubscription.DisplayName
  335. subscription = sub
  336. break
  337. }
  338. }
  339. if subscription == nil {
  340. return errHTTPNotFound
  341. }
  342. if err := s.userManager.ChangeSettings(u); err != nil {
  343. return err
  344. }
  345. return s.writeJSON(w, subscription)
  346. }
  347. func (s *Server) handleAccountSubscriptionDelete(w http.ResponseWriter, r *http.Request, v *visitor) error {
  348. matches := apiAccountSubscriptionSingleRegex.FindStringSubmatch(r.URL.Path)
  349. if len(matches) != 2 {
  350. return errHTTPInternalErrorInvalidPath
  351. }
  352. subscriptionID := matches[1]
  353. u := v.User()
  354. if u.Prefs == nil || u.Prefs.Subscriptions == nil {
  355. return nil
  356. }
  357. newSubscriptions := make([]*user.Subscription, 0)
  358. for _, subscription := range u.Prefs.Subscriptions {
  359. if subscription.ID != subscriptionID {
  360. newSubscriptions = append(newSubscriptions, subscription)
  361. }
  362. }
  363. if len(newSubscriptions) < len(u.Prefs.Subscriptions) {
  364. u.Prefs.Subscriptions = newSubscriptions
  365. if err := s.userManager.ChangeSettings(u); err != nil {
  366. return err
  367. }
  368. }
  369. return s.writeJSON(w, newSuccessResponse())
  370. }
  371. // handleAccountReservationAdd adds a topic reservation for the logged-in user, but only if the user has a tier
  372. // with enough remaining reservations left, or if the user is an admin. Admins can always reserve a topic, unless
  373. // it is already reserved by someone else.
  374. func (s *Server) handleAccountReservationAdd(w http.ResponseWriter, r *http.Request, v *visitor) error {
  375. u := v.User()
  376. req, err := readJSONWithLimit[apiAccountReservationRequest](r.Body, jsonBodyBytesLimit, false)
  377. if err != nil {
  378. return err
  379. }
  380. if !topicRegex.MatchString(req.Topic) {
  381. return errHTTPBadRequestTopicInvalid
  382. }
  383. everyone, err := user.ParsePermission(req.Everyone)
  384. if err != nil {
  385. return errHTTPBadRequestPermissionInvalid
  386. }
  387. // Check if we are allowed to reserve this topic
  388. if u.User() && u.Tier == nil {
  389. return errHTTPUnauthorized
  390. } else if err := s.userManager.CheckAllowAccess(u.Name, req.Topic); err != nil {
  391. return errHTTPConflictTopicReserved
  392. } else if u.User() {
  393. hasReservation, err := s.userManager.HasReservation(u.Name, req.Topic)
  394. if err != nil {
  395. return err
  396. }
  397. if !hasReservation {
  398. reservations, err := s.userManager.ReservationsCount(u.Name)
  399. if err != nil {
  400. return err
  401. } else if reservations >= u.Tier.ReservationLimit {
  402. return errHTTPTooManyRequestsLimitReservations
  403. }
  404. }
  405. }
  406. // Actually add the reservation
  407. if err := s.userManager.AddReservation(u.Name, req.Topic, everyone); err != nil {
  408. return err
  409. }
  410. // Kill existing subscribers
  411. t, err := s.topicFromID(req.Topic)
  412. if err != nil {
  413. return err
  414. }
  415. t.CancelSubscribers(u.ID)
  416. return s.writeJSON(w, newSuccessResponse())
  417. }
  418. // handleAccountReservationDelete deletes a topic reservation if it is owned by the current user
  419. func (s *Server) handleAccountReservationDelete(w http.ResponseWriter, r *http.Request, v *visitor) error {
  420. matches := apiAccountReservationSingleRegex.FindStringSubmatch(r.URL.Path)
  421. if len(matches) != 2 {
  422. return errHTTPInternalErrorInvalidPath
  423. }
  424. topic := matches[1]
  425. if !topicRegex.MatchString(topic) {
  426. return errHTTPBadRequestTopicInvalid
  427. }
  428. u := v.User()
  429. authorized, err := s.userManager.HasReservation(u.Name, topic)
  430. if err != nil {
  431. return err
  432. } else if !authorized {
  433. return errHTTPUnauthorized
  434. }
  435. if err := s.userManager.RemoveReservations(u.Name, topic); err != nil {
  436. return err
  437. }
  438. deleteMessages := readBoolParam(r, false, "X-Delete-Messages", "Delete-Messages")
  439. if deleteMessages {
  440. if err := s.messageCache.ExpireMessages(topic); err != nil {
  441. return err
  442. }
  443. }
  444. return s.writeJSON(w, newSuccessResponse())
  445. }
  446. // maybeRemoveMessagesAndExcessReservations deletes topic reservations for the given user (if too many for tier),
  447. // and marks associated messages for the topics as deleted. This also eventually deletes attachments.
  448. // The process relies on the manager to perform the actual deletions (see runManager).
  449. func (s *Server) maybeRemoveMessagesAndExcessReservations(logPrefix string, u *user.User, reservationsLimit int64) error {
  450. reservations, err := s.userManager.Reservations(u.Name)
  451. if err != nil {
  452. return err
  453. } else if int64(len(reservations)) <= reservationsLimit {
  454. return nil
  455. }
  456. topics := make([]string, 0)
  457. for i := int64(len(reservations)) - 1; i >= reservationsLimit; i-- {
  458. topics = append(topics, reservations[i].Topic)
  459. }
  460. log.Info("%s Removing excess reservations for topics %s", logPrefix, strings.Join(topics, ", "))
  461. if err := s.userManager.RemoveReservations(u.Name, topics...); err != nil {
  462. return err
  463. }
  464. if err := s.messageCache.ExpireMessages(topics...); err != nil {
  465. return err
  466. }
  467. return nil
  468. }
  469. // publishSyncEventAsync kicks of a Go routine to publish a sync message to the user's sync topic
  470. func (s *Server) publishSyncEventAsync(v *visitor) {
  471. go func() {
  472. if err := s.publishSyncEvent(v); err != nil {
  473. log.Trace("%s Error publishing to user's sync topic: %s", v.String(), err.Error())
  474. }
  475. }()
  476. }
  477. // publishSyncEvent publishes a sync message to the user's sync topic
  478. func (s *Server) publishSyncEvent(v *visitor) error {
  479. u := v.User()
  480. if u == nil || u.SyncTopic == "" {
  481. return nil
  482. }
  483. log.Trace("Publishing sync event to user %s's sync topic %s", u.Name, u.SyncTopic)
  484. syncTopic, err := s.topicFromID(u.SyncTopic)
  485. if err != nil {
  486. return err
  487. }
  488. messageBytes, err := json.Marshal(&apiAccountSyncTopicResponse{Event: syncTopicAccountSyncEvent})
  489. if err != nil {
  490. return err
  491. }
  492. m := newDefaultMessage(syncTopic.ID, string(messageBytes))
  493. if err := syncTopic.Publish(v, m); err != nil {
  494. return err
  495. }
  496. return nil
  497. }