server_account.go 16 KB

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