server.go 70 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927
  1. package server
  2. import (
  3. "bytes"
  4. "context"
  5. "crypto/sha256"
  6. "embed"
  7. "encoding/base64"
  8. "encoding/json"
  9. "errors"
  10. "fmt"
  11. "github.com/emersion/go-smtp"
  12. "github.com/gorilla/websocket"
  13. "github.com/prometheus/client_golang/prometheus/promhttp"
  14. "golang.org/x/sync/errgroup"
  15. "heckel.io/ntfy/log"
  16. "heckel.io/ntfy/user"
  17. "heckel.io/ntfy/util"
  18. "io"
  19. "net"
  20. "net/http"
  21. "net/http/pprof"
  22. "net/netip"
  23. "net/url"
  24. "os"
  25. "path"
  26. "path/filepath"
  27. "regexp"
  28. "sort"
  29. "strconv"
  30. "strings"
  31. "sync"
  32. "time"
  33. "unicode/utf8"
  34. )
  35. // Server is the main server, providing the UI and API for ntfy
  36. type Server struct {
  37. config *Config
  38. httpServer *http.Server
  39. httpsServer *http.Server
  40. httpMetricsServer *http.Server
  41. httpProfileServer *http.Server
  42. unixListener net.Listener
  43. smtpServer *smtp.Server
  44. smtpServerBackend *smtpBackend
  45. smtpSender mailer
  46. topics map[string]*topic
  47. visitors map[string]*visitor // ip:<ip> or user:<user>
  48. firebaseClient *firebaseClient
  49. messages int64 // Total number of messages (persisted if messageCache enabled)
  50. messagesHistory []int64 // Last n values of the messages counter, used to determine rate
  51. userManager *user.Manager // Might be nil!
  52. messageCache *messageCache // Database that stores the messages
  53. fileCache *fileCache // File system based cache that stores attachments
  54. stripe stripeAPI // Stripe API, can be replaced with a mock
  55. priceCache *util.LookupCache[map[string]int64] // Stripe price ID -> price as cents (USD implied!)
  56. metricsHandler http.Handler // Handles /metrics if enable-metrics set, and listen-metrics-http not set
  57. closeChan chan bool
  58. mu sync.RWMutex
  59. }
  60. // handleFunc extends the normal http.HandlerFunc to be able to easily return errors
  61. type handleFunc func(http.ResponseWriter, *http.Request, *visitor) error
  62. var (
  63. // If changed, don't forget to update Android App and auth_sqlite.go
  64. topicRegex = regexp.MustCompile(`^[-_A-Za-z0-9]{1,64}$`) // No /!
  65. topicPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}$`) // Regex must match JS & Android app!
  66. externalTopicPathRegex = regexp.MustCompile(`^/[^/]+\.[^/]+/[-_A-Za-z0-9]{1,64}$`) // Extended topic path, for web-app, e.g. /example.com/mytopic
  67. jsonPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/json$`)
  68. ssePathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/sse$`)
  69. rawPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/raw$`)
  70. wsPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/ws$`)
  71. authPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/auth$`)
  72. publishPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}/(publish|send|trigger)$`)
  73. webConfigPath = "/config.js"
  74. accountPath = "/account"
  75. matrixPushPath = "/_matrix/push/v1/notify"
  76. metricsPath = "/metrics"
  77. apiHealthPath = "/v1/health"
  78. apiStatsPath = "/v1/stats"
  79. apiTiersPath = "/v1/tiers"
  80. apiUsersPath = "/v1/users"
  81. apiUsersAccessPath = "/v1/users/access"
  82. apiAccountPath = "/v1/account"
  83. apiAccountTokenPath = "/v1/account/token"
  84. apiAccountPasswordPath = "/v1/account/password"
  85. apiAccountSettingsPath = "/v1/account/settings"
  86. apiAccountSubscriptionPath = "/v1/account/subscription"
  87. apiAccountReservationPath = "/v1/account/reservation"
  88. apiAccountPhonePath = "/v1/account/phone"
  89. apiAccountPhoneVerifyPath = "/v1/account/phone/verify"
  90. apiAccountBillingPortalPath = "/v1/account/billing/portal"
  91. apiAccountBillingWebhookPath = "/v1/account/billing/webhook"
  92. apiAccountBillingSubscriptionPath = "/v1/account/billing/subscription"
  93. apiAccountBillingSubscriptionCheckoutSuccessTemplate = "/v1/account/billing/subscription/success/{CHECKOUT_SESSION_ID}"
  94. apiAccountBillingSubscriptionCheckoutSuccessRegex = regexp.MustCompile(`/v1/account/billing/subscription/success/(.+)$`)
  95. apiAccountReservationSingleRegex = regexp.MustCompile(`/v1/account/reservation/([-_A-Za-z0-9]{1,64})$`)
  96. staticRegex = regexp.MustCompile(`^/static/.+`)
  97. docsRegex = regexp.MustCompile(`^/docs(|/.*)$`)
  98. fileRegex = regexp.MustCompile(`^/file/([-_A-Za-z0-9]{1,64})(?:\.[A-Za-z0-9]{1,16})?$`)
  99. urlRegex = regexp.MustCompile(`^https?://`)
  100. phoneNumberRegex = regexp.MustCompile(`^\+\d{1,100}$`)
  101. //go:embed site
  102. webFs embed.FS
  103. webFsCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: webFs}
  104. webSiteDir = "/site"
  105. webAppIndex = "/app.html" // React app
  106. //go:embed docs
  107. docsStaticFs embed.FS
  108. docsStaticCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: docsStaticFs}
  109. )
  110. const (
  111. firebaseControlTopic = "~control" // See Android if changed
  112. firebasePollTopic = "~poll" // See iOS if changed
  113. emptyMessageBody = "triggered" // Used if message body is empty
  114. newMessageBody = "New message" // Used in poll requests as generic message
  115. defaultAttachmentMessage = "You received a file: %s" // Used if message body is empty, and there is an attachment
  116. encodingBase64 = "base64" // Used mainly for binary UnifiedPush messages
  117. jsonBodyBytesLimit = 16384 // Max number of bytes for a JSON request body
  118. unifiedPushTopicPrefix = "up" // Temporarily, we rate limit all "up*" topics based on the subscriber
  119. unifiedPushTopicLength = 14 // Length of UnifiedPush topics, including the "up" part
  120. messagesHistoryMax = 10 // Number of message count values to keep in memory
  121. )
  122. // WebSocket constants
  123. const (
  124. wsWriteWait = 2 * time.Second
  125. wsBufferSize = 1024
  126. wsReadLimit = 64 // We only ever receive PINGs
  127. wsPongWait = 15 * time.Second
  128. )
  129. // New instantiates a new Server. It creates the cache and adds a Firebase
  130. // subscriber (if configured).
  131. func New(conf *Config) (*Server, error) {
  132. var mailer mailer
  133. if conf.SMTPSenderAddr != "" {
  134. mailer = &smtpSender{config: conf}
  135. }
  136. var stripe stripeAPI
  137. if conf.StripeSecretKey != "" {
  138. stripe = newStripeAPI()
  139. }
  140. messageCache, err := createMessageCache(conf)
  141. if err != nil {
  142. return nil, err
  143. }
  144. topics, err := messageCache.Topics()
  145. if err != nil {
  146. return nil, err
  147. }
  148. messages, err := messageCache.Stats()
  149. if err != nil {
  150. return nil, err
  151. }
  152. var fileCache *fileCache
  153. if conf.AttachmentCacheDir != "" {
  154. fileCache, err = newFileCache(conf.AttachmentCacheDir, conf.AttachmentTotalSizeLimit)
  155. if err != nil {
  156. return nil, err
  157. }
  158. }
  159. var userManager *user.Manager
  160. if conf.AuthFile != "" {
  161. userManager, err = user.NewManager(conf.AuthFile, conf.AuthStartupQueries, conf.AuthDefault, conf.AuthBcryptCost, conf.AuthStatsQueueWriterInterval)
  162. if err != nil {
  163. return nil, err
  164. }
  165. }
  166. var firebaseClient *firebaseClient
  167. if conf.FirebaseKeyFile != "" {
  168. sender, err := newFirebaseSender(conf.FirebaseKeyFile)
  169. if err != nil {
  170. return nil, err
  171. }
  172. // This awkward logic is required because Go is weird about nil types and interfaces.
  173. // See issue #641, and https://go.dev/play/p/uur1flrv1t3 for an example
  174. var auther user.Auther
  175. if userManager != nil {
  176. auther = userManager
  177. }
  178. firebaseClient = newFirebaseClient(sender, auther)
  179. }
  180. s := &Server{
  181. config: conf,
  182. messageCache: messageCache,
  183. fileCache: fileCache,
  184. firebaseClient: firebaseClient,
  185. smtpSender: mailer,
  186. topics: topics,
  187. userManager: userManager,
  188. messages: messages,
  189. messagesHistory: []int64{messages},
  190. visitors: make(map[string]*visitor),
  191. stripe: stripe,
  192. }
  193. s.priceCache = util.NewLookupCache(s.fetchStripePrices, conf.StripePriceCacheDuration)
  194. return s, nil
  195. }
  196. func createMessageCache(conf *Config) (*messageCache, error) {
  197. if conf.CacheDuration == 0 {
  198. return newNopCache()
  199. } else if conf.CacheFile != "" {
  200. return newSqliteCache(conf.CacheFile, conf.CacheStartupQueries, conf.CacheDuration, conf.CacheBatchSize, conf.CacheBatchTimeout, false)
  201. }
  202. return newMemCache()
  203. }
  204. // Run executes the main server. It listens on HTTP (+ HTTPS, if configured), and starts
  205. // a manager go routine to print stats and prune messages.
  206. func (s *Server) Run() error {
  207. var listenStr string
  208. if s.config.ListenHTTP != "" {
  209. listenStr += fmt.Sprintf(" %s[http]", s.config.ListenHTTP)
  210. }
  211. if s.config.ListenHTTPS != "" {
  212. listenStr += fmt.Sprintf(" %s[https]", s.config.ListenHTTPS)
  213. }
  214. if s.config.ListenUnix != "" {
  215. listenStr += fmt.Sprintf(" %s[unix]", s.config.ListenUnix)
  216. }
  217. if s.config.SMTPServerListen != "" {
  218. listenStr += fmt.Sprintf(" %s[smtp]", s.config.SMTPServerListen)
  219. }
  220. if s.config.MetricsListenHTTP != "" {
  221. listenStr += fmt.Sprintf(" %s[http/metrics]", s.config.MetricsListenHTTP)
  222. }
  223. if s.config.ProfileListenHTTP != "" {
  224. listenStr += fmt.Sprintf(" %s[http/profile]", s.config.ProfileListenHTTP)
  225. }
  226. log.Tag(tagStartup).Info("Listening on%s, ntfy %s, log level is %s", listenStr, s.config.Version, log.CurrentLevel().String())
  227. if log.IsFile() {
  228. fmt.Fprintf(os.Stderr, "Listening on%s, ntfy %s\n", listenStr, s.config.Version)
  229. fmt.Fprintf(os.Stderr, "Logs are written to %s\n", log.File())
  230. }
  231. mux := http.NewServeMux()
  232. mux.HandleFunc("/", s.handle)
  233. errChan := make(chan error)
  234. s.mu.Lock()
  235. s.closeChan = make(chan bool)
  236. if s.config.ListenHTTP != "" {
  237. s.httpServer = &http.Server{Addr: s.config.ListenHTTP, Handler: mux}
  238. go func() {
  239. errChan <- s.httpServer.ListenAndServe()
  240. }()
  241. }
  242. if s.config.ListenHTTPS != "" {
  243. s.httpsServer = &http.Server{Addr: s.config.ListenHTTPS, Handler: mux}
  244. go func() {
  245. errChan <- s.httpsServer.ListenAndServeTLS(s.config.CertFile, s.config.KeyFile)
  246. }()
  247. }
  248. if s.config.ListenUnix != "" {
  249. go func() {
  250. var err error
  251. s.mu.Lock()
  252. os.Remove(s.config.ListenUnix)
  253. s.unixListener, err = net.Listen("unix", s.config.ListenUnix)
  254. if err != nil {
  255. s.mu.Unlock()
  256. errChan <- err
  257. return
  258. }
  259. defer s.unixListener.Close()
  260. if s.config.ListenUnixMode > 0 {
  261. if err := os.Chmod(s.config.ListenUnix, s.config.ListenUnixMode); err != nil {
  262. s.mu.Unlock()
  263. errChan <- err
  264. return
  265. }
  266. }
  267. s.mu.Unlock()
  268. httpServer := &http.Server{Handler: mux}
  269. errChan <- httpServer.Serve(s.unixListener)
  270. }()
  271. }
  272. if s.config.MetricsListenHTTP != "" {
  273. initMetrics()
  274. s.httpMetricsServer = &http.Server{Addr: s.config.MetricsListenHTTP, Handler: promhttp.Handler()}
  275. go func() {
  276. errChan <- s.httpMetricsServer.ListenAndServe()
  277. }()
  278. } else if s.config.EnableMetrics {
  279. initMetrics()
  280. s.metricsHandler = promhttp.Handler()
  281. }
  282. if s.config.ProfileListenHTTP != "" {
  283. profileMux := http.NewServeMux()
  284. profileMux.HandleFunc("/debug/pprof/", pprof.Index)
  285. profileMux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
  286. profileMux.HandleFunc("/debug/pprof/profile", pprof.Profile)
  287. profileMux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
  288. profileMux.HandleFunc("/debug/pprof/trace", pprof.Trace)
  289. s.httpProfileServer = &http.Server{Addr: s.config.ProfileListenHTTP, Handler: profileMux}
  290. go func() {
  291. errChan <- s.httpProfileServer.ListenAndServe()
  292. }()
  293. }
  294. if s.config.SMTPServerListen != "" {
  295. go func() {
  296. errChan <- s.runSMTPServer()
  297. }()
  298. }
  299. s.mu.Unlock()
  300. go s.runManager()
  301. go s.runStatsResetter()
  302. go s.runDelayedSender()
  303. go s.runFirebaseKeepaliver()
  304. return <-errChan
  305. }
  306. // Stop stops HTTP (+HTTPS) server and all managers
  307. func (s *Server) Stop() {
  308. s.mu.Lock()
  309. defer s.mu.Unlock()
  310. if s.httpServer != nil {
  311. s.httpServer.Close()
  312. }
  313. if s.httpsServer != nil {
  314. s.httpsServer.Close()
  315. }
  316. if s.unixListener != nil {
  317. s.unixListener.Close()
  318. }
  319. if s.smtpServer != nil {
  320. s.smtpServer.Close()
  321. }
  322. s.closeDatabases()
  323. close(s.closeChan)
  324. }
  325. func (s *Server) closeDatabases() {
  326. if s.userManager != nil {
  327. s.userManager.Close()
  328. }
  329. s.messageCache.Close()
  330. }
  331. // handle is the main entry point for all HTTP requests
  332. func (s *Server) handle(w http.ResponseWriter, r *http.Request) {
  333. v, err := s.maybeAuthenticate(r) // Note: Always returns v, even when error is returned
  334. if err != nil {
  335. s.handleError(w, r, v, err)
  336. return
  337. }
  338. ev := logvr(v, r)
  339. if ev.IsTrace() {
  340. ev.Field("http_request", renderHTTPRequest(r)).Trace("HTTP request started")
  341. } else if logvr(v, r).IsDebug() {
  342. ev.Debug("HTTP request started")
  343. }
  344. logvr(v, r).
  345. Timing(func() {
  346. if err := s.handleInternal(w, r, v); err != nil {
  347. s.handleError(w, r, v, err)
  348. return
  349. }
  350. if metricHTTPRequests != nil {
  351. metricHTTPRequests.WithLabelValues("200", "20000", r.Method).Inc()
  352. }
  353. }).
  354. Debug("HTTP request finished")
  355. }
  356. func (s *Server) handleError(w http.ResponseWriter, r *http.Request, v *visitor, err error) {
  357. httpErr, ok := err.(*errHTTP)
  358. if !ok {
  359. httpErr = errHTTPInternalError
  360. }
  361. if metricHTTPRequests != nil {
  362. metricHTTPRequests.WithLabelValues(fmt.Sprintf("%d", httpErr.HTTPCode), fmt.Sprintf("%d", httpErr.Code), r.Method).Inc()
  363. }
  364. isRateLimiting := util.Contains(rateLimitingErrorCodes, httpErr.HTTPCode)
  365. isNormalError := strings.Contains(err.Error(), "i/o timeout") || util.Contains(normalErrorCodes, httpErr.HTTPCode)
  366. ev := logvr(v, r).Err(err)
  367. if websocket.IsWebSocketUpgrade(r) {
  368. ev.Tag(tagWebsocket).Fields(websocketErrorContext(err))
  369. if isNormalError {
  370. ev.Debug("WebSocket error (this error is okay, it happens a lot): %s", err.Error())
  371. } else {
  372. ev.Info("WebSocket error: %s", err.Error())
  373. }
  374. return // Do not attempt to write to upgraded connection
  375. }
  376. if isNormalError {
  377. ev.Debug("Connection closed with HTTP %d (ntfy error %d)", httpErr.HTTPCode, httpErr.Code)
  378. } else {
  379. ev.Info("Connection closed with HTTP %d (ntfy error %d)", httpErr.HTTPCode, httpErr.Code)
  380. }
  381. if isRateLimiting && s.config.StripeSecretKey != "" {
  382. u := v.User()
  383. if u == nil || u.Tier == nil {
  384. httpErr = httpErr.Wrap("increase your limits with a paid plan, see %s", s.config.BaseURL)
  385. }
  386. }
  387. w.Header().Set("Content-Type", "application/json")
  388. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  389. w.WriteHeader(httpErr.HTTPCode)
  390. io.WriteString(w, httpErr.JSON()+"\n")
  391. }
  392. func (s *Server) handleInternal(w http.ResponseWriter, r *http.Request, v *visitor) error {
  393. if r.Method == http.MethodGet && r.URL.Path == "/" && s.config.WebRoot == "/" {
  394. return s.ensureWebEnabled(s.handleRoot)(w, r, v)
  395. } else if r.Method == http.MethodHead && r.URL.Path == "/" {
  396. return s.ensureWebEnabled(s.handleEmpty)(w, r, v)
  397. } else if r.Method == http.MethodGet && r.URL.Path == apiHealthPath {
  398. return s.handleHealth(w, r, v)
  399. } else if r.Method == http.MethodGet && r.URL.Path == webConfigPath {
  400. return s.ensureWebEnabled(s.handleWebConfig)(w, r, v)
  401. } else if r.Method == http.MethodGet && r.URL.Path == apiUsersPath {
  402. return s.ensureAdmin(s.handleUsersGet)(w, r, v)
  403. } else if r.Method == http.MethodPut && r.URL.Path == apiUsersPath {
  404. return s.ensureAdmin(s.handleUsersAdd)(w, r, v)
  405. } else if r.Method == http.MethodDelete && r.URL.Path == apiUsersPath {
  406. return s.ensureAdmin(s.handleUsersDelete)(w, r, v)
  407. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && r.URL.Path == apiUsersAccessPath {
  408. return s.ensureAdmin(s.handleAccessAllow)(w, r, v)
  409. } else if r.Method == http.MethodDelete && r.URL.Path == apiUsersAccessPath {
  410. return s.ensureAdmin(s.handleAccessReset)(w, r, v)
  411. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountPath {
  412. return s.ensureUserManager(s.handleAccountCreate)(w, r, v)
  413. } else if r.Method == http.MethodGet && r.URL.Path == apiAccountPath {
  414. return s.handleAccountGet(w, r, v) // Allowed by anonymous
  415. } else if r.Method == http.MethodDelete && r.URL.Path == apiAccountPath {
  416. return s.ensureUser(s.withAccountSync(s.handleAccountDelete))(w, r, v)
  417. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountPasswordPath {
  418. return s.ensureUser(s.handleAccountPasswordChange)(w, r, v)
  419. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountTokenPath {
  420. return s.ensureUser(s.withAccountSync(s.handleAccountTokenCreate))(w, r, v)
  421. } else if r.Method == http.MethodPatch && r.URL.Path == apiAccountTokenPath {
  422. return s.ensureUser(s.withAccountSync(s.handleAccountTokenUpdate))(w, r, v)
  423. } else if r.Method == http.MethodDelete && r.URL.Path == apiAccountTokenPath {
  424. return s.ensureUser(s.withAccountSync(s.handleAccountTokenDelete))(w, r, v)
  425. } else if r.Method == http.MethodPatch && r.URL.Path == apiAccountSettingsPath {
  426. return s.ensureUser(s.withAccountSync(s.handleAccountSettingsChange))(w, r, v)
  427. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountSubscriptionPath {
  428. return s.ensureUser(s.withAccountSync(s.handleAccountSubscriptionAdd))(w, r, v)
  429. } else if r.Method == http.MethodPatch && r.URL.Path == apiAccountSubscriptionPath {
  430. return s.ensureUser(s.withAccountSync(s.handleAccountSubscriptionChange))(w, r, v)
  431. } else if r.Method == http.MethodDelete && r.URL.Path == apiAccountSubscriptionPath {
  432. return s.ensureUser(s.withAccountSync(s.handleAccountSubscriptionDelete))(w, r, v)
  433. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountReservationPath {
  434. return s.ensureUser(s.withAccountSync(s.handleAccountReservationAdd))(w, r, v)
  435. } else if r.Method == http.MethodDelete && apiAccountReservationSingleRegex.MatchString(r.URL.Path) {
  436. return s.ensureUser(s.withAccountSync(s.handleAccountReservationDelete))(w, r, v)
  437. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountBillingSubscriptionPath {
  438. return s.ensurePaymentsEnabled(s.ensureUser(s.handleAccountBillingSubscriptionCreate))(w, r, v) // Account sync via incoming Stripe webhook
  439. } else if r.Method == http.MethodGet && apiAccountBillingSubscriptionCheckoutSuccessRegex.MatchString(r.URL.Path) {
  440. return s.ensurePaymentsEnabled(s.ensureUserManager(s.handleAccountBillingSubscriptionCreateSuccess))(w, r, v) // No user context!
  441. } else if r.Method == http.MethodPut && r.URL.Path == apiAccountBillingSubscriptionPath {
  442. return s.ensurePaymentsEnabled(s.ensureStripeCustomer(s.handleAccountBillingSubscriptionUpdate))(w, r, v) // Account sync via incoming Stripe webhook
  443. } else if r.Method == http.MethodDelete && r.URL.Path == apiAccountBillingSubscriptionPath {
  444. return s.ensurePaymentsEnabled(s.ensureStripeCustomer(s.handleAccountBillingSubscriptionDelete))(w, r, v) // Account sync via incoming Stripe webhook
  445. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountBillingPortalPath {
  446. return s.ensurePaymentsEnabled(s.ensureStripeCustomer(s.handleAccountBillingPortalSessionCreate))(w, r, v)
  447. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountBillingWebhookPath {
  448. return s.ensurePaymentsEnabled(s.ensureUserManager(s.handleAccountBillingWebhook))(w, r, v) // This request comes from Stripe!
  449. } else if r.Method == http.MethodPut && r.URL.Path == apiAccountPhoneVerifyPath {
  450. return s.ensureUser(s.ensureCallsEnabled(s.withAccountSync(s.handleAccountPhoneNumberVerify)))(w, r, v)
  451. } else if r.Method == http.MethodPut && r.URL.Path == apiAccountPhonePath {
  452. return s.ensureUser(s.ensureCallsEnabled(s.withAccountSync(s.handleAccountPhoneNumberAdd)))(w, r, v)
  453. } else if r.Method == http.MethodDelete && r.URL.Path == apiAccountPhonePath {
  454. return s.ensureUser(s.ensureCallsEnabled(s.withAccountSync(s.handleAccountPhoneNumberDelete)))(w, r, v)
  455. } else if r.Method == http.MethodGet && r.URL.Path == apiStatsPath {
  456. return s.handleStats(w, r, v)
  457. } else if r.Method == http.MethodGet && r.URL.Path == apiTiersPath {
  458. return s.ensurePaymentsEnabled(s.handleBillingTiersGet)(w, r, v)
  459. } else if r.Method == http.MethodGet && r.URL.Path == matrixPushPath {
  460. return s.handleMatrixDiscovery(w)
  461. } else if r.Method == http.MethodGet && r.URL.Path == metricsPath && s.metricsHandler != nil {
  462. return s.handleMetrics(w, r, v)
  463. } else if r.Method == http.MethodGet && staticRegex.MatchString(r.URL.Path) {
  464. return s.ensureWebEnabled(s.handleStatic)(w, r, v)
  465. } else if r.Method == http.MethodGet && docsRegex.MatchString(r.URL.Path) {
  466. return s.ensureWebEnabled(s.handleDocs)(w, r, v)
  467. } else if (r.Method == http.MethodGet || r.Method == http.MethodHead) && fileRegex.MatchString(r.URL.Path) && s.config.AttachmentCacheDir != "" {
  468. return s.limitRequests(s.handleFile)(w, r, v)
  469. } else if r.Method == http.MethodOptions {
  470. return s.limitRequests(s.handleOptions)(w, r, v) // Should work even if the web app is not enabled, see #598
  471. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && r.URL.Path == "/" {
  472. return s.transformBodyJSON(s.limitRequestsWithTopic(s.authorizeTopicWrite(s.handlePublish)))(w, r, v)
  473. } else if r.Method == http.MethodPost && r.URL.Path == matrixPushPath {
  474. return s.transformMatrixJSON(s.limitRequestsWithTopic(s.authorizeTopicWrite(s.handlePublishMatrix)))(w, r, v)
  475. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && topicPathRegex.MatchString(r.URL.Path) {
  476. return s.limitRequestsWithTopic(s.authorizeTopicWrite(s.handlePublish))(w, r, v)
  477. } else if r.Method == http.MethodGet && publishPathRegex.MatchString(r.URL.Path) {
  478. return s.limitRequestsWithTopic(s.authorizeTopicWrite(s.handlePublish))(w, r, v)
  479. } else if r.Method == http.MethodGet && jsonPathRegex.MatchString(r.URL.Path) {
  480. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeJSON))(w, r, v)
  481. } else if r.Method == http.MethodGet && ssePathRegex.MatchString(r.URL.Path) {
  482. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeSSE))(w, r, v)
  483. } else if r.Method == http.MethodGet && rawPathRegex.MatchString(r.URL.Path) {
  484. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeRaw))(w, r, v)
  485. } else if r.Method == http.MethodGet && wsPathRegex.MatchString(r.URL.Path) {
  486. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeWS))(w, r, v)
  487. } else if r.Method == http.MethodGet && authPathRegex.MatchString(r.URL.Path) {
  488. return s.limitRequests(s.authorizeTopicRead(s.handleTopicAuth))(w, r, v)
  489. } else if r.Method == http.MethodGet && (topicPathRegex.MatchString(r.URL.Path) || externalTopicPathRegex.MatchString(r.URL.Path)) {
  490. return s.ensureWebEnabled(s.handleTopic)(w, r, v)
  491. }
  492. return errHTTPNotFound
  493. }
  494. func (s *Server) handleRoot(w http.ResponseWriter, r *http.Request, v *visitor) error {
  495. r.URL.Path = webAppIndex
  496. return s.handleStatic(w, r, v)
  497. }
  498. func (s *Server) handleTopic(w http.ResponseWriter, r *http.Request, v *visitor) error {
  499. unifiedpush := readBoolParam(r, false, "x-unifiedpush", "unifiedpush", "up") // see PUT/POST too!
  500. if unifiedpush {
  501. w.Header().Set("Content-Type", "application/json")
  502. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  503. _, err := io.WriteString(w, `{"unifiedpush":{"version":1}}`+"\n")
  504. return err
  505. }
  506. r.URL.Path = webAppIndex
  507. return s.handleStatic(w, r, v)
  508. }
  509. func (s *Server) handleEmpty(_ http.ResponseWriter, _ *http.Request, _ *visitor) error {
  510. return nil
  511. }
  512. func (s *Server) handleTopicAuth(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  513. return s.writeJSON(w, newSuccessResponse())
  514. }
  515. func (s *Server) handleHealth(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  516. response := &apiHealthResponse{
  517. Healthy: true,
  518. }
  519. return s.writeJSON(w, response)
  520. }
  521. func (s *Server) handleWebConfig(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  522. response := &apiConfigResponse{
  523. BaseURL: "", // Will translate to window.location.origin
  524. AppRoot: s.config.WebRoot,
  525. EnableLogin: s.config.EnableLogin,
  526. EnableSignup: s.config.EnableSignup,
  527. EnablePayments: s.config.StripeSecretKey != "",
  528. EnableCalls: s.config.TwilioAccount != "",
  529. EnableEmails: s.config.SMTPSenderFrom != "",
  530. EnableReservations: s.config.EnableReservations,
  531. BillingContact: s.config.BillingContact,
  532. DisallowedTopics: s.config.DisallowedTopics,
  533. }
  534. b, err := json.MarshalIndent(response, "", " ")
  535. if err != nil {
  536. return err
  537. }
  538. w.Header().Set("Content-Type", "text/javascript")
  539. _, err = io.WriteString(w, fmt.Sprintf("// Generated server configuration\nvar config = %s;\n", string(b)))
  540. return err
  541. }
  542. // handleMetrics returns Prometheus metrics. This endpoint is only called if enable-metrics is set,
  543. // and listen-metrics-http is not set.
  544. func (s *Server) handleMetrics(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  545. s.metricsHandler.ServeHTTP(w, r)
  546. return nil
  547. }
  548. // handleStatic returns all static resources (excluding the docs), including the web app
  549. func (s *Server) handleStatic(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  550. r.URL.Path = webSiteDir + r.URL.Path
  551. util.Gzip(http.FileServer(http.FS(webFsCached))).ServeHTTP(w, r)
  552. return nil
  553. }
  554. // handleDocs returns static resources related to the docs
  555. func (s *Server) handleDocs(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  556. util.Gzip(http.FileServer(http.FS(docsStaticCached))).ServeHTTP(w, r)
  557. return nil
  558. }
  559. // handleStats returns the publicly available server stats
  560. func (s *Server) handleStats(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  561. s.mu.RLock()
  562. messages, n, rate := s.messages, len(s.messagesHistory), float64(0)
  563. if n > 1 {
  564. rate = float64(s.messagesHistory[n-1]-s.messagesHistory[0]) / (float64(n-1) * s.config.ManagerInterval.Seconds())
  565. }
  566. s.mu.RUnlock()
  567. response := &apiStatsResponse{
  568. Messages: messages,
  569. MessagesRate: rate,
  570. }
  571. return s.writeJSON(w, response)
  572. }
  573. // handleFile processes the download of attachment files. The method handles GET and HEAD requests against a file.
  574. // Before streaming the file to a client, it locates uploader (m.Sender or m.User) in the message cache, so it
  575. // can associate the download bandwidth with the uploader.
  576. func (s *Server) handleFile(w http.ResponseWriter, r *http.Request, v *visitor) error {
  577. if s.config.AttachmentCacheDir == "" {
  578. return errHTTPInternalError
  579. }
  580. matches := fileRegex.FindStringSubmatch(r.URL.Path)
  581. if len(matches) != 2 {
  582. return errHTTPInternalErrorInvalidPath
  583. }
  584. messageID := matches[1]
  585. file := filepath.Join(s.config.AttachmentCacheDir, messageID)
  586. stat, err := os.Stat(file)
  587. if err != nil {
  588. return errHTTPNotFound.Fields(log.Context{
  589. "message_id": messageID,
  590. "error_context": "filesystem",
  591. })
  592. }
  593. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  594. w.Header().Set("Content-Length", fmt.Sprintf("%d", stat.Size()))
  595. if r.Method == http.MethodHead {
  596. return nil
  597. }
  598. // Find message in database, and associate bandwidth to the uploader user
  599. // This is an easy way to
  600. // - avoid abuse (e.g. 1 uploader, 1k downloaders)
  601. // - and also uses the higher bandwidth limits of a paying user
  602. m, err := s.messageCache.Message(messageID)
  603. if err == errMessageNotFound {
  604. if s.config.CacheBatchTimeout > 0 {
  605. // Strange edge case: If we immediately after upload request the file (the web app does this for images),
  606. // and messages are persisted asynchronously, retry fetching from the database
  607. m, err = util.Retry(func() (*message, error) {
  608. return s.messageCache.Message(messageID)
  609. }, s.config.CacheBatchTimeout, 100*time.Millisecond, 300*time.Millisecond, 600*time.Millisecond)
  610. }
  611. if err != nil {
  612. return errHTTPNotFound.Fields(log.Context{
  613. "message_id": messageID,
  614. "error_context": "message_cache",
  615. })
  616. }
  617. } else if err != nil {
  618. return err
  619. }
  620. bandwidthVisitor := v
  621. if s.userManager != nil && m.User != "" {
  622. u, err := s.userManager.UserByID(m.User)
  623. if err != nil {
  624. return err
  625. }
  626. bandwidthVisitor = s.visitor(v.IP(), u)
  627. } else if m.Sender.IsValid() {
  628. bandwidthVisitor = s.visitor(m.Sender, nil)
  629. }
  630. if !bandwidthVisitor.BandwidthAllowed(stat.Size()) {
  631. return errHTTPTooManyRequestsLimitAttachmentBandwidth.With(m)
  632. }
  633. // Actually send file
  634. f, err := os.Open(file)
  635. if err != nil {
  636. return err
  637. }
  638. defer f.Close()
  639. if m.Attachment.Name != "" {
  640. w.Header().Set("Content-Disposition", "attachment; filename="+strconv.Quote(m.Attachment.Name))
  641. }
  642. _, err = io.Copy(util.NewContentTypeWriter(w, r.URL.Path), f)
  643. return err
  644. }
  645. func (s *Server) handleMatrixDiscovery(w http.ResponseWriter) error {
  646. if s.config.BaseURL == "" {
  647. return errHTTPInternalErrorMissingBaseURL
  648. }
  649. return writeMatrixDiscoveryResponse(w)
  650. }
  651. func (s *Server) handlePublishInternal(r *http.Request, v *visitor) (*message, error) {
  652. start := time.Now()
  653. t, err := fromContext[*topic](r, contextTopic)
  654. if err != nil {
  655. return nil, err
  656. }
  657. vrate, err := fromContext[*visitor](r, contextRateVisitor)
  658. if err != nil {
  659. return nil, err
  660. }
  661. body, err := util.Peek(r.Body, s.config.MessageLimit)
  662. if err != nil {
  663. return nil, err
  664. }
  665. m := newDefaultMessage(t.ID, "")
  666. cache, firebase, email, call, unifiedpush, e := s.parsePublishParams(r, m)
  667. if e != nil {
  668. return nil, e.With(t)
  669. }
  670. if unifiedpush && s.config.VisitorSubscriberRateLimiting && t.RateVisitor() == nil {
  671. // UnifiedPush clients must subscribe before publishing to allow proper subscriber-based rate limiting (see
  672. // Rate-Topics header). The 5xx response is because some app servers (in particular Mastodon) will remove
  673. // the subscription as invalid if any 400-499 code (except 429/408) is returned.
  674. // See https://github.com/mastodon/mastodon/blob/730bb3e211a84a2f30e3e2bbeae3f77149824a68/app/workers/web/push_notification_worker.rb#L35-L46
  675. return nil, errHTTPInsufficientStorageUnifiedPush.With(t)
  676. } else if !util.ContainsIP(s.config.VisitorRequestExemptIPAddrs, v.ip) && !vrate.MessageAllowed() {
  677. return nil, errHTTPTooManyRequestsLimitMessages.With(t)
  678. } else if email != "" && !vrate.EmailAllowed() {
  679. return nil, errHTTPTooManyRequestsLimitEmails.With(t)
  680. } else if call != "" {
  681. var httpErr *errHTTP
  682. call, httpErr = s.convertPhoneNumber(v.User(), call)
  683. if httpErr != nil {
  684. return nil, httpErr.With(t)
  685. } else if !vrate.CallAllowed() {
  686. return nil, errHTTPTooManyRequestsLimitCalls.With(t)
  687. }
  688. }
  689. if m.PollID != "" {
  690. m = newPollRequestMessage(t.ID, m.PollID)
  691. }
  692. m.Sender = v.IP()
  693. m.User = v.MaybeUserID()
  694. if cache {
  695. m.Expires = time.Unix(m.Time, 0).Add(v.Limits().MessageExpiryDuration).Unix()
  696. }
  697. if err := s.handlePublishBody(r, v, m, body, unifiedpush); err != nil {
  698. return nil, err
  699. }
  700. if m.Message == "" {
  701. m.Message = emptyMessageBody
  702. }
  703. delayed := m.Time > time.Now().Unix()
  704. ev := logvrm(v, r, m).
  705. Tag(tagPublish).
  706. With(t).
  707. Fields(log.Context{
  708. "message_delayed": delayed,
  709. "message_firebase": firebase,
  710. "message_unifiedpush": unifiedpush,
  711. "message_email": email,
  712. "message_call": call,
  713. })
  714. if ev.IsTrace() {
  715. ev.Field("message_body", util.MaybeMarshalJSON(m)).Trace("Received message")
  716. } else if ev.IsDebug() {
  717. ev.Debug("Received message")
  718. }
  719. if !delayed {
  720. if err := t.Publish(v, m); err != nil {
  721. return nil, err
  722. }
  723. if s.firebaseClient != nil && firebase {
  724. go s.sendToFirebase(v, m)
  725. }
  726. if s.smtpSender != nil && email != "" {
  727. go s.sendEmail(v, m, email)
  728. }
  729. if s.config.TwilioAccount != "" && call != "" {
  730. go s.callPhone(v, r, m, call)
  731. }
  732. if s.config.UpstreamBaseURL != "" {
  733. go s.forwardPollRequest(v, m)
  734. }
  735. } else {
  736. logvrm(v, r, m).Tag(tagPublish).Debug("Message delayed, will process later")
  737. }
  738. if cache {
  739. logvrm(v, r, m).Tag(tagPublish).Debug("Adding message to cache")
  740. if err := s.messageCache.AddMessage(m); err != nil {
  741. return nil, err
  742. }
  743. }
  744. u := v.User()
  745. if s.userManager != nil && u != nil && u.Tier != nil {
  746. go s.userManager.EnqueueUserStats(u.ID, v.Stats())
  747. }
  748. s.mu.Lock()
  749. s.messages++
  750. s.mu.Unlock()
  751. if unifiedpush {
  752. minc(metricUnifiedPushPublishedSuccess)
  753. }
  754. mset(metricMessagePublishDurationMillis, time.Since(start).Milliseconds())
  755. return m, nil
  756. }
  757. func (s *Server) handlePublish(w http.ResponseWriter, r *http.Request, v *visitor) error {
  758. m, err := s.handlePublishInternal(r, v)
  759. if err != nil {
  760. minc(metricMessagesPublishedFailure)
  761. return err
  762. }
  763. minc(metricMessagesPublishedSuccess)
  764. return s.writeJSON(w, m)
  765. }
  766. func (s *Server) handlePublishMatrix(w http.ResponseWriter, r *http.Request, v *visitor) error {
  767. _, err := s.handlePublishInternal(r, v)
  768. if err != nil {
  769. minc(metricMessagesPublishedFailure)
  770. minc(metricMatrixPublishedFailure)
  771. if e, ok := err.(*errHTTP); ok && e.HTTPCode == errHTTPInsufficientStorageUnifiedPush.HTTPCode {
  772. topic, err := fromContext[*topic](r, contextTopic)
  773. if err != nil {
  774. return err
  775. }
  776. pushKey, err := fromContext[string](r, contextMatrixPushKey)
  777. if err != nil {
  778. return err
  779. }
  780. if time.Since(topic.LastAccess()) > matrixRejectPushKeyForUnifiedPushTopicWithoutRateVisitorAfter {
  781. return writeMatrixResponse(w, pushKey)
  782. }
  783. }
  784. return err
  785. }
  786. minc(metricMessagesPublishedSuccess)
  787. minc(metricMatrixPublishedSuccess)
  788. return writeMatrixSuccess(w)
  789. }
  790. func (s *Server) sendToFirebase(v *visitor, m *message) {
  791. logvm(v, m).Tag(tagFirebase).Debug("Publishing to Firebase")
  792. if err := s.firebaseClient.Send(v, m); err != nil {
  793. minc(metricFirebasePublishedFailure)
  794. if err == errFirebaseTemporarilyBanned {
  795. logvm(v, m).Tag(tagFirebase).Err(err).Debug("Unable to publish to Firebase: %v", err.Error())
  796. } else {
  797. logvm(v, m).Tag(tagFirebase).Err(err).Warn("Unable to publish to Firebase: %v", err.Error())
  798. }
  799. return
  800. }
  801. minc(metricFirebasePublishedSuccess)
  802. }
  803. func (s *Server) sendEmail(v *visitor, m *message, email string) {
  804. logvm(v, m).Tag(tagEmail).Field("email", email).Debug("Sending email to %s", email)
  805. if err := s.smtpSender.Send(v, m, email); err != nil {
  806. logvm(v, m).Tag(tagEmail).Field("email", email).Err(err).Warn("Unable to send email to %s: %v", email, err.Error())
  807. minc(metricEmailsPublishedFailure)
  808. return
  809. }
  810. minc(metricEmailsPublishedSuccess)
  811. }
  812. func (s *Server) forwardPollRequest(v *visitor, m *message) {
  813. topicURL := fmt.Sprintf("%s/%s", s.config.BaseURL, m.Topic)
  814. topicHash := fmt.Sprintf("%x", sha256.Sum256([]byte(topicURL)))
  815. forwardURL := fmt.Sprintf("%s/%s", s.config.UpstreamBaseURL, topicHash)
  816. logvm(v, m).Debug("Publishing poll request to %s", forwardURL)
  817. req, err := http.NewRequest("POST", forwardURL, strings.NewReader(""))
  818. if err != nil {
  819. logvm(v, m).Err(err).Warn("Unable to publish poll request")
  820. return
  821. }
  822. req.Header.Set("X-Poll-ID", m.ID)
  823. var httpClient = &http.Client{
  824. Timeout: time.Second * 10,
  825. }
  826. response, err := httpClient.Do(req)
  827. if err != nil {
  828. logvm(v, m).Err(err).Warn("Unable to publish poll request")
  829. return
  830. } else if response.StatusCode != http.StatusOK {
  831. logvm(v, m).Err(err).Warn("Unable to publish poll request, unexpected HTTP status: %d", response.StatusCode)
  832. return
  833. }
  834. }
  835. func (s *Server) parsePublishParams(r *http.Request, m *message) (cache bool, firebase bool, email, call string, unifiedpush bool, err *errHTTP) {
  836. cache = readBoolParam(r, true, "x-cache", "cache")
  837. firebase = readBoolParam(r, true, "x-firebase", "firebase")
  838. m.Title = maybeDecodeHeader(readParam(r, "x-title", "title", "t"))
  839. m.Click = readParam(r, "x-click", "click")
  840. icon := readParam(r, "x-icon", "icon")
  841. filename := readParam(r, "x-filename", "filename", "file", "f")
  842. attach := readParam(r, "x-attach", "attach", "a")
  843. if attach != "" || filename != "" {
  844. m.Attachment = &attachment{}
  845. }
  846. if filename != "" {
  847. m.Attachment.Name = filename
  848. }
  849. if attach != "" {
  850. if !urlRegex.MatchString(attach) {
  851. return false, false, "", "", false, errHTTPBadRequestAttachmentURLInvalid
  852. }
  853. m.Attachment.URL = attach
  854. if m.Attachment.Name == "" {
  855. u, err := url.Parse(m.Attachment.URL)
  856. if err == nil {
  857. m.Attachment.Name = path.Base(u.Path)
  858. if m.Attachment.Name == "." || m.Attachment.Name == "/" {
  859. m.Attachment.Name = ""
  860. }
  861. }
  862. }
  863. if m.Attachment.Name == "" {
  864. m.Attachment.Name = "attachment"
  865. }
  866. }
  867. if icon != "" {
  868. if !urlRegex.MatchString(icon) {
  869. return false, false, "", "", false, errHTTPBadRequestIconURLInvalid
  870. }
  871. m.Icon = icon
  872. }
  873. email = readParam(r, "x-email", "x-e-mail", "email", "e-mail", "mail", "e")
  874. if s.smtpSender == nil && email != "" {
  875. return false, false, "", "", false, errHTTPBadRequestEmailDisabled
  876. }
  877. call = readParam(r, "x-call", "call")
  878. if call != "" && (s.config.TwilioAccount == "" || s.userManager == nil) {
  879. return false, false, "", "", false, errHTTPBadRequestPhoneCallsDisabled
  880. } else if call != "" && !isBoolValue(call) && !phoneNumberRegex.MatchString(call) {
  881. return false, false, "", "", false, errHTTPBadRequestPhoneNumberInvalid
  882. }
  883. messageStr := strings.ReplaceAll(readParam(r, "x-message", "message", "m"), "\\n", "\n")
  884. if messageStr != "" {
  885. m.Message = maybeDecodeHeader(messageStr)
  886. }
  887. var e error
  888. m.Priority, e = util.ParsePriority(readParam(r, "x-priority", "priority", "prio", "p"))
  889. if e != nil {
  890. return false, false, "", "", false, errHTTPBadRequestPriorityInvalid
  891. }
  892. m.Tags = readCommaSeparatedParam(r, "x-tags", "tags", "tag", "ta")
  893. for i, t := range m.Tags {
  894. m.Tags[i] = maybeDecodeHeader(t)
  895. }
  896. delayStr := readParam(r, "x-delay", "delay", "x-at", "at", "x-in", "in")
  897. if delayStr != "" {
  898. if !cache {
  899. return false, false, "", "", false, errHTTPBadRequestDelayNoCache
  900. }
  901. if email != "" {
  902. return false, false, "", "", false, errHTTPBadRequestDelayNoEmail // we cannot store the email address (yet)
  903. }
  904. if call != "" {
  905. return false, false, "", "", false, errHTTPBadRequestDelayNoCall // we cannot store the phone number (yet)
  906. }
  907. delay, err := util.ParseFutureTime(delayStr, time.Now())
  908. if err != nil {
  909. return false, false, "", "", false, errHTTPBadRequestDelayCannotParse
  910. } else if delay.Unix() < time.Now().Add(s.config.MinDelay).Unix() {
  911. return false, false, "", "", false, errHTTPBadRequestDelayTooSmall
  912. } else if delay.Unix() > time.Now().Add(s.config.MaxDelay).Unix() {
  913. return false, false, "", "", false, errHTTPBadRequestDelayTooLarge
  914. }
  915. m.Time = delay.Unix()
  916. }
  917. actionsStr := readParam(r, "x-actions", "actions", "action")
  918. if actionsStr != "" {
  919. m.Actions, e = parseActions(actionsStr)
  920. if e != nil {
  921. return false, false, "", "", false, errHTTPBadRequestActionsInvalid.Wrap(e.Error())
  922. }
  923. }
  924. unifiedpush = readBoolParam(r, false, "x-unifiedpush", "unifiedpush", "up") // see GET too!
  925. if unifiedpush {
  926. firebase = false
  927. unifiedpush = true
  928. }
  929. m.PollID = readParam(r, "x-poll-id", "poll-id")
  930. if m.PollID != "" {
  931. unifiedpush = false
  932. cache = false
  933. email = ""
  934. }
  935. return cache, firebase, email, call, unifiedpush, nil
  936. }
  937. // handlePublishBody consumes the PUT/POST body and decides whether the body is an attachment or the message.
  938. //
  939. // 1. curl -X POST -H "Poll: 1234" ntfy.sh/...
  940. // If a message is flagged as poll request, the body does not matter and is discarded
  941. // 2. curl -T somebinarydata.bin "ntfy.sh/mytopic?up=1"
  942. // If body is binary, encode as base64, if not do not encode
  943. // 3. curl -H "Attach: http://example.com/file.jpg" ntfy.sh/mytopic
  944. // Body must be a message, because we attached an external URL
  945. // 4. curl -T short.txt -H "Filename: short.txt" ntfy.sh/mytopic
  946. // Body must be attachment, because we passed a filename
  947. // 5. curl -T file.txt ntfy.sh/mytopic
  948. // If file.txt is <= 4096 (message limit) and valid UTF-8, treat it as a message
  949. // 6. curl -T file.txt ntfy.sh/mytopic
  950. // If file.txt is > message limit, treat it as an attachment
  951. func (s *Server) handlePublishBody(r *http.Request, v *visitor, m *message, body *util.PeekedReadCloser, unifiedpush bool) error {
  952. if m.Event == pollRequestEvent { // Case 1
  953. return s.handleBodyDiscard(body)
  954. } else if unifiedpush {
  955. return s.handleBodyAsMessageAutoDetect(m, body) // Case 2
  956. } else if m.Attachment != nil && m.Attachment.URL != "" {
  957. return s.handleBodyAsTextMessage(m, body) // Case 3
  958. } else if m.Attachment != nil && m.Attachment.Name != "" {
  959. return s.handleBodyAsAttachment(r, v, m, body) // Case 4
  960. } else if !body.LimitReached && utf8.Valid(body.PeekedBytes) {
  961. return s.handleBodyAsTextMessage(m, body) // Case 5
  962. }
  963. return s.handleBodyAsAttachment(r, v, m, body) // Case 6
  964. }
  965. func (s *Server) handleBodyDiscard(body *util.PeekedReadCloser) error {
  966. _, err := io.Copy(io.Discard, body)
  967. _ = body.Close()
  968. return err
  969. }
  970. func (s *Server) handleBodyAsMessageAutoDetect(m *message, body *util.PeekedReadCloser) error {
  971. if utf8.Valid(body.PeekedBytes) {
  972. m.Message = string(body.PeekedBytes) // Do not trim
  973. } else {
  974. m.Message = base64.StdEncoding.EncodeToString(body.PeekedBytes)
  975. m.Encoding = encodingBase64
  976. }
  977. return nil
  978. }
  979. func (s *Server) handleBodyAsTextMessage(m *message, body *util.PeekedReadCloser) error {
  980. if !utf8.Valid(body.PeekedBytes) {
  981. return errHTTPBadRequestMessageNotUTF8.With(m)
  982. }
  983. if len(body.PeekedBytes) > 0 { // Empty body should not override message (publish via GET!)
  984. m.Message = strings.TrimSpace(string(body.PeekedBytes)) // Truncates the message to the peek limit if required
  985. }
  986. if m.Attachment != nil && m.Attachment.Name != "" && m.Message == "" {
  987. m.Message = fmt.Sprintf(defaultAttachmentMessage, m.Attachment.Name)
  988. }
  989. return nil
  990. }
  991. func (s *Server) handleBodyAsAttachment(r *http.Request, v *visitor, m *message, body *util.PeekedReadCloser) error {
  992. if s.fileCache == nil || s.config.BaseURL == "" || s.config.AttachmentCacheDir == "" {
  993. return errHTTPBadRequestAttachmentsDisallowed.With(m)
  994. }
  995. vinfo, err := v.Info()
  996. if err != nil {
  997. return err
  998. }
  999. attachmentExpiry := time.Now().Add(vinfo.Limits.AttachmentExpiryDuration).Unix()
  1000. if m.Time > attachmentExpiry {
  1001. return errHTTPBadRequestAttachmentsExpiryBeforeDelivery.With(m)
  1002. }
  1003. contentLengthStr := r.Header.Get("Content-Length")
  1004. if contentLengthStr != "" { // Early "do-not-trust" check, hard limit see below
  1005. contentLength, err := strconv.ParseInt(contentLengthStr, 10, 64)
  1006. if err == nil && (contentLength > vinfo.Stats.AttachmentTotalSizeRemaining || contentLength > vinfo.Limits.AttachmentFileSizeLimit) {
  1007. return errHTTPEntityTooLargeAttachment.With(m).Fields(log.Context{
  1008. "message_content_length": contentLength,
  1009. "attachment_total_size_remaining": vinfo.Stats.AttachmentTotalSizeRemaining,
  1010. "attachment_file_size_limit": vinfo.Limits.AttachmentFileSizeLimit,
  1011. })
  1012. }
  1013. }
  1014. if m.Attachment == nil {
  1015. m.Attachment = &attachment{}
  1016. }
  1017. var ext string
  1018. m.Attachment.Expires = attachmentExpiry
  1019. m.Attachment.Type, ext = util.DetectContentType(body.PeekedBytes, m.Attachment.Name)
  1020. m.Attachment.URL = fmt.Sprintf("%s/file/%s%s", s.config.BaseURL, m.ID, ext)
  1021. if m.Attachment.Name == "" {
  1022. m.Attachment.Name = fmt.Sprintf("attachment%s", ext)
  1023. }
  1024. if m.Message == "" {
  1025. m.Message = fmt.Sprintf(defaultAttachmentMessage, m.Attachment.Name)
  1026. }
  1027. limiters := []util.Limiter{
  1028. v.BandwidthLimiter(),
  1029. util.NewFixedLimiter(vinfo.Limits.AttachmentFileSizeLimit),
  1030. util.NewFixedLimiter(vinfo.Stats.AttachmentTotalSizeRemaining),
  1031. }
  1032. m.Attachment.Size, err = s.fileCache.Write(m.ID, body, limiters...)
  1033. if err == util.ErrLimitReached {
  1034. return errHTTPEntityTooLargeAttachment.With(m)
  1035. } else if err != nil {
  1036. return err
  1037. }
  1038. return nil
  1039. }
  1040. func (s *Server) handleSubscribeJSON(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1041. encoder := func(msg *message) (string, error) {
  1042. var buf bytes.Buffer
  1043. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  1044. return "", err
  1045. }
  1046. return buf.String(), nil
  1047. }
  1048. return s.handleSubscribeHTTP(w, r, v, "application/x-ndjson", encoder)
  1049. }
  1050. func (s *Server) handleSubscribeSSE(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1051. encoder := func(msg *message) (string, error) {
  1052. var buf bytes.Buffer
  1053. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  1054. return "", err
  1055. }
  1056. if msg.Event != messageEvent {
  1057. return fmt.Sprintf("event: %s\ndata: %s\n", msg.Event, buf.String()), nil // Browser's .onmessage() does not fire on this!
  1058. }
  1059. return fmt.Sprintf("data: %s\n", buf.String()), nil
  1060. }
  1061. return s.handleSubscribeHTTP(w, r, v, "text/event-stream", encoder)
  1062. }
  1063. func (s *Server) handleSubscribeRaw(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1064. encoder := func(msg *message) (string, error) {
  1065. if msg.Event == messageEvent { // only handle default events
  1066. return strings.ReplaceAll(msg.Message, "\n", " ") + "\n", nil
  1067. }
  1068. return "\n", nil // "keepalive" and "open" events just send an empty line
  1069. }
  1070. return s.handleSubscribeHTTP(w, r, v, "text/plain", encoder)
  1071. }
  1072. func (s *Server) handleSubscribeHTTP(w http.ResponseWriter, r *http.Request, v *visitor, contentType string, encoder messageEncoder) error {
  1073. logvr(v, r).Tag(tagSubscribe).Debug("HTTP stream connection opened")
  1074. defer logvr(v, r).Tag(tagSubscribe).Debug("HTTP stream connection closed")
  1075. if !v.SubscriptionAllowed() {
  1076. return errHTTPTooManyRequestsLimitSubscriptions
  1077. }
  1078. defer v.RemoveSubscription()
  1079. topics, topicsStr, err := s.topicsFromPath(r.URL.Path)
  1080. if err != nil {
  1081. return err
  1082. }
  1083. poll, since, scheduled, filters, rateTopics, err := parseSubscribeParams(r)
  1084. if err != nil {
  1085. return err
  1086. }
  1087. var wlock sync.Mutex
  1088. defer func() {
  1089. // Hack: This is the fix for a horrible data race that I have not been able to figure out in quite some time.
  1090. // It appears to be happening when the Go HTTP code reads from the socket when closing the request (i.e. AFTER
  1091. // this function returns), and causes a data race with the ResponseWriter. Locking wlock here silences the
  1092. // data race detector. See https://github.com/binwiederhier/ntfy/issues/338#issuecomment-1163425889.
  1093. wlock.TryLock()
  1094. }()
  1095. sub := func(v *visitor, msg *message) error {
  1096. if !filters.Pass(msg) {
  1097. return nil
  1098. }
  1099. m, err := encoder(msg)
  1100. if err != nil {
  1101. return err
  1102. }
  1103. wlock.Lock()
  1104. defer wlock.Unlock()
  1105. if _, err := w.Write([]byte(m)); err != nil {
  1106. return err
  1107. }
  1108. if fl, ok := w.(http.Flusher); ok {
  1109. fl.Flush()
  1110. }
  1111. return nil
  1112. }
  1113. if err := s.maybeSetRateVisitors(r, v, topics, rateTopics); err != nil {
  1114. return err
  1115. }
  1116. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  1117. w.Header().Set("Content-Type", contentType+"; charset=utf-8") // Android/Volley client needs charset!
  1118. if poll {
  1119. for _, t := range topics {
  1120. t.Keepalive()
  1121. }
  1122. return s.sendOldMessages(topics, since, scheduled, v, sub)
  1123. }
  1124. ctx, cancel := context.WithCancel(context.Background())
  1125. defer cancel()
  1126. subscriberIDs := make([]int, 0)
  1127. for _, t := range topics {
  1128. subscriberIDs = append(subscriberIDs, t.Subscribe(sub, v.MaybeUserID(), cancel))
  1129. }
  1130. defer func() {
  1131. for i, subscriberID := range subscriberIDs {
  1132. topics[i].Unsubscribe(subscriberID) // Order!
  1133. }
  1134. }()
  1135. if err := sub(v, newOpenMessage(topicsStr)); err != nil { // Send out open message
  1136. return err
  1137. }
  1138. if err := s.sendOldMessages(topics, since, scheduled, v, sub); err != nil {
  1139. return err
  1140. }
  1141. for {
  1142. select {
  1143. case <-ctx.Done():
  1144. return nil
  1145. case <-r.Context().Done():
  1146. return nil
  1147. case <-time.After(s.config.KeepaliveInterval):
  1148. ev := logvr(v, r).Tag(tagSubscribe)
  1149. if len(topics) == 1 {
  1150. ev.With(topics[0]).Trace("Sending keepalive message to %s", topics[0].ID)
  1151. } else {
  1152. ev.Trace("Sending keepalive message to %d topics", len(topics))
  1153. }
  1154. v.Keepalive()
  1155. for _, t := range topics {
  1156. t.Keepalive()
  1157. }
  1158. if err := sub(v, newKeepaliveMessage(topicsStr)); err != nil { // Send keepalive message
  1159. return err
  1160. }
  1161. }
  1162. }
  1163. }
  1164. func (s *Server) handleSubscribeWS(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1165. if strings.ToLower(r.Header.Get("Upgrade")) != "websocket" {
  1166. return errHTTPBadRequestWebSocketsUpgradeHeaderMissing
  1167. }
  1168. if !v.SubscriptionAllowed() {
  1169. return errHTTPTooManyRequestsLimitSubscriptions
  1170. }
  1171. defer v.RemoveSubscription()
  1172. logvr(v, r).Tag(tagWebsocket).Debug("WebSocket connection opened")
  1173. defer logvr(v, r).Tag(tagWebsocket).Debug("WebSocket connection closed")
  1174. topics, topicsStr, err := s.topicsFromPath(r.URL.Path)
  1175. if err != nil {
  1176. return err
  1177. }
  1178. poll, since, scheduled, filters, rateTopics, err := parseSubscribeParams(r)
  1179. if err != nil {
  1180. return err
  1181. }
  1182. upgrader := &websocket.Upgrader{
  1183. ReadBufferSize: wsBufferSize,
  1184. WriteBufferSize: wsBufferSize,
  1185. CheckOrigin: func(r *http.Request) bool {
  1186. return true // We're open for business!
  1187. },
  1188. }
  1189. conn, err := upgrader.Upgrade(w, r, nil)
  1190. if err != nil {
  1191. return err
  1192. }
  1193. defer conn.Close()
  1194. // Subscription connections can be canceled externally, see topic.CancelSubscribersExceptUser
  1195. cancelCtx, cancel := context.WithCancel(context.Background())
  1196. defer cancel()
  1197. // Use errgroup to run WebSocket reader and writer in Go routines
  1198. var wlock sync.Mutex
  1199. g, gctx := errgroup.WithContext(cancelCtx)
  1200. g.Go(func() error {
  1201. pongWait := s.config.KeepaliveInterval + wsPongWait
  1202. conn.SetReadLimit(wsReadLimit)
  1203. if err := conn.SetReadDeadline(time.Now().Add(pongWait)); err != nil {
  1204. return err
  1205. }
  1206. conn.SetPongHandler(func(appData string) error {
  1207. logvr(v, r).Tag(tagWebsocket).Trace("Received WebSocket pong")
  1208. return conn.SetReadDeadline(time.Now().Add(pongWait))
  1209. })
  1210. for {
  1211. _, _, err := conn.NextReader()
  1212. if err != nil {
  1213. return err
  1214. }
  1215. select {
  1216. case <-gctx.Done():
  1217. return nil
  1218. default:
  1219. }
  1220. }
  1221. })
  1222. g.Go(func() error {
  1223. ping := func() error {
  1224. wlock.Lock()
  1225. defer wlock.Unlock()
  1226. if err := conn.SetWriteDeadline(time.Now().Add(wsWriteWait)); err != nil {
  1227. return err
  1228. }
  1229. logvr(v, r).Tag(tagWebsocket).Trace("Sending WebSocket ping")
  1230. return conn.WriteMessage(websocket.PingMessage, nil)
  1231. }
  1232. for {
  1233. select {
  1234. case <-gctx.Done():
  1235. return nil
  1236. case <-cancelCtx.Done():
  1237. logvr(v, r).Tag(tagWebsocket).Trace("Cancel received, closing subscriber connection")
  1238. conn.Close()
  1239. return &websocket.CloseError{Code: websocket.CloseNormalClosure, Text: "subscription was canceled"}
  1240. case <-time.After(s.config.KeepaliveInterval):
  1241. v.Keepalive()
  1242. for _, t := range topics {
  1243. t.Keepalive()
  1244. }
  1245. if err := ping(); err != nil {
  1246. return err
  1247. }
  1248. }
  1249. }
  1250. })
  1251. sub := func(v *visitor, msg *message) error {
  1252. if !filters.Pass(msg) {
  1253. return nil
  1254. }
  1255. wlock.Lock()
  1256. defer wlock.Unlock()
  1257. if err := conn.SetWriteDeadline(time.Now().Add(wsWriteWait)); err != nil {
  1258. return err
  1259. }
  1260. return conn.WriteJSON(msg)
  1261. }
  1262. if err := s.maybeSetRateVisitors(r, v, topics, rateTopics); err != nil {
  1263. return err
  1264. }
  1265. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  1266. if poll {
  1267. for _, t := range topics {
  1268. t.Keepalive()
  1269. }
  1270. return s.sendOldMessages(topics, since, scheduled, v, sub)
  1271. }
  1272. subscriberIDs := make([]int, 0)
  1273. for _, t := range topics {
  1274. subscriberIDs = append(subscriberIDs, t.Subscribe(sub, v.MaybeUserID(), cancel))
  1275. }
  1276. defer func() {
  1277. for i, subscriberID := range subscriberIDs {
  1278. topics[i].Unsubscribe(subscriberID) // Order!
  1279. }
  1280. }()
  1281. if err := sub(v, newOpenMessage(topicsStr)); err != nil { // Send out open message
  1282. return err
  1283. }
  1284. if err := s.sendOldMessages(topics, since, scheduled, v, sub); err != nil {
  1285. return err
  1286. }
  1287. err = g.Wait()
  1288. if err != nil && websocket.IsCloseError(err, websocket.CloseNormalClosure, websocket.CloseGoingAway, websocket.CloseAbnormalClosure, websocket.CloseNoStatusReceived) {
  1289. logvr(v, r).Tag(tagWebsocket).Err(err).Fields(websocketErrorContext(err)).Trace("WebSocket connection closed")
  1290. return nil // Normal closures are not errors; note: "1006 (abnormal closure)" is treated as normal, because people disconnect a lot
  1291. }
  1292. return err
  1293. }
  1294. func parseSubscribeParams(r *http.Request) (poll bool, since sinceMarker, scheduled bool, filters *queryFilter, rateTopics []string, err error) {
  1295. poll = readBoolParam(r, false, "x-poll", "poll", "po")
  1296. scheduled = readBoolParam(r, false, "x-scheduled", "scheduled", "sched")
  1297. since, err = parseSince(r, poll)
  1298. if err != nil {
  1299. return
  1300. }
  1301. filters, err = parseQueryFilters(r)
  1302. if err != nil {
  1303. return
  1304. }
  1305. rateTopics = readCommaSeparatedParam(r, "x-rate-topics", "rate-topics")
  1306. return
  1307. }
  1308. // maybeSetRateVisitors sets the rate visitor on a topic (v.SetRateVisitor), indicating that all messages published
  1309. // to that topic will be rate limited against the rate visitor instead of the publishing visitor.
  1310. //
  1311. // Setting the rate visitor is ony allowed if the `visitor-subscriber-rate-limiting` setting is enabled, AND
  1312. // - auth-file is not set (everything is open by default)
  1313. // - or the topic is reserved, and v.user is the owner
  1314. // - or the topic is not reserved, and v.user has write access
  1315. //
  1316. // Note: This TEMPORARILY also registers all topics starting with "up" (= UnifiedPush). This is to ease the transition
  1317. // until the Android app will send the "Rate-Topics" header.
  1318. func (s *Server) maybeSetRateVisitors(r *http.Request, v *visitor, topics []*topic, rateTopics []string) error {
  1319. // Bail out if not enabled
  1320. if !s.config.VisitorSubscriberRateLimiting {
  1321. return nil
  1322. }
  1323. // Make a list of topics that we'll actually set the RateVisitor on
  1324. eligibleRateTopics := make([]*topic, 0)
  1325. for _, t := range topics {
  1326. if (strings.HasPrefix(t.ID, unifiedPushTopicPrefix) && len(t.ID) == unifiedPushTopicLength) || util.Contains(rateTopics, t.ID) {
  1327. eligibleRateTopics = append(eligibleRateTopics, t)
  1328. }
  1329. }
  1330. if len(eligibleRateTopics) == 0 {
  1331. return nil
  1332. }
  1333. // If access controls are turned off, v has access to everything, and we can set the rate visitor
  1334. if s.userManager == nil {
  1335. return s.setRateVisitors(r, v, eligibleRateTopics)
  1336. }
  1337. // If access controls are enabled, only set rate visitor if
  1338. // - topic is reserved, and v.user is the owner
  1339. // - topic is not reserved, and v.user has write access
  1340. writableRateTopics := make([]*topic, 0)
  1341. for _, t := range topics {
  1342. ownerUserID, err := s.userManager.ReservationOwner(t.ID)
  1343. if err != nil {
  1344. return err
  1345. }
  1346. if ownerUserID == "" {
  1347. if err := s.userManager.Authorize(v.User(), t.ID, user.PermissionWrite); err == nil {
  1348. writableRateTopics = append(writableRateTopics, t)
  1349. }
  1350. } else if ownerUserID == v.MaybeUserID() {
  1351. writableRateTopics = append(writableRateTopics, t)
  1352. }
  1353. }
  1354. return s.setRateVisitors(r, v, writableRateTopics)
  1355. }
  1356. func (s *Server) setRateVisitors(r *http.Request, v *visitor, rateTopics []*topic) error {
  1357. for _, t := range rateTopics {
  1358. logvr(v, r).
  1359. Tag(tagSubscribe).
  1360. With(t).
  1361. Debug("Setting visitor as rate visitor for topic %s", t.ID)
  1362. t.SetRateVisitor(v)
  1363. }
  1364. return nil
  1365. }
  1366. // sendOldMessages selects old messages from the messageCache and calls sub for each of them. It uses since as the
  1367. // marker, returning only messages that are newer than the marker.
  1368. func (s *Server) sendOldMessages(topics []*topic, since sinceMarker, scheduled bool, v *visitor, sub subscriber) error {
  1369. if since.IsNone() {
  1370. return nil
  1371. }
  1372. messages := make([]*message, 0)
  1373. for _, t := range topics {
  1374. topicMessages, err := s.messageCache.Messages(t.ID, since, scheduled)
  1375. if err != nil {
  1376. return err
  1377. }
  1378. messages = append(messages, topicMessages...)
  1379. }
  1380. sort.Slice(messages, func(i, j int) bool {
  1381. return messages[i].Time < messages[j].Time
  1382. })
  1383. for _, m := range messages {
  1384. if err := sub(v, m); err != nil {
  1385. return err
  1386. }
  1387. }
  1388. return nil
  1389. }
  1390. // parseSince returns a timestamp identifying the time span from which cached messages should be received.
  1391. //
  1392. // Values in the "since=..." parameter can be either a unix timestamp or a duration (e.g. 12h), or
  1393. // "all" for all messages.
  1394. func parseSince(r *http.Request, poll bool) (sinceMarker, error) {
  1395. since := readParam(r, "x-since", "since", "si")
  1396. // Easy cases (empty, all, none)
  1397. if since == "" {
  1398. if poll {
  1399. return sinceAllMessages, nil
  1400. }
  1401. return sinceNoMessages, nil
  1402. } else if since == "all" {
  1403. return sinceAllMessages, nil
  1404. } else if since == "none" {
  1405. return sinceNoMessages, nil
  1406. }
  1407. // ID, timestamp, duration
  1408. if validMessageID(since) {
  1409. return newSinceID(since), nil
  1410. } else if s, err := strconv.ParseInt(since, 10, 64); err == nil {
  1411. return newSinceTime(s), nil
  1412. } else if d, err := time.ParseDuration(since); err == nil {
  1413. return newSinceTime(time.Now().Add(-1 * d).Unix()), nil
  1414. }
  1415. return sinceNoMessages, errHTTPBadRequestSinceInvalid
  1416. }
  1417. func (s *Server) handleOptions(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  1418. w.Header().Set("Access-Control-Allow-Methods", "GET, PUT, POST, PATCH, DELETE")
  1419. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  1420. w.Header().Set("Access-Control-Allow-Headers", "*") // CORS, allow auth via JS // FIXME is this terrible?
  1421. return nil
  1422. }
  1423. // topicFromPath returns the topic from a root path (e.g. /mytopic), creating it if it doesn't exist.
  1424. func (s *Server) topicFromPath(path string) (*topic, error) {
  1425. parts := strings.Split(path, "/")
  1426. if len(parts) < 2 {
  1427. return nil, errHTTPBadRequestTopicInvalid
  1428. }
  1429. return s.topicFromID(parts[1])
  1430. }
  1431. // topicsFromPath returns the topic from a root path (e.g. /mytopic,mytopic2), creating it if it doesn't exist.
  1432. func (s *Server) topicsFromPath(path string) ([]*topic, string, error) {
  1433. parts := strings.Split(path, "/")
  1434. if len(parts) < 2 {
  1435. return nil, "", errHTTPBadRequestTopicInvalid
  1436. }
  1437. topicIDs := util.SplitNoEmpty(parts[1], ",")
  1438. topics, err := s.topicsFromIDs(topicIDs...)
  1439. if err != nil {
  1440. return nil, "", errHTTPBadRequestTopicInvalid
  1441. }
  1442. return topics, parts[1], nil
  1443. }
  1444. // topicsFromIDs returns the topics with the given IDs, creating them if they don't exist.
  1445. func (s *Server) topicsFromIDs(ids ...string) ([]*topic, error) {
  1446. s.mu.Lock()
  1447. defer s.mu.Unlock()
  1448. topics := make([]*topic, 0)
  1449. for _, id := range ids {
  1450. if util.Contains(s.config.DisallowedTopics, id) {
  1451. return nil, errHTTPBadRequestTopicDisallowed
  1452. }
  1453. if _, ok := s.topics[id]; !ok {
  1454. if len(s.topics) >= s.config.TotalTopicLimit {
  1455. return nil, errHTTPTooManyRequestsLimitTotalTopics
  1456. }
  1457. s.topics[id] = newTopic(id)
  1458. }
  1459. topics = append(topics, s.topics[id])
  1460. }
  1461. return topics, nil
  1462. }
  1463. // topicFromID returns the topic with the given ID, creating it if it doesn't exist.
  1464. func (s *Server) topicFromID(id string) (*topic, error) {
  1465. topics, err := s.topicsFromIDs(id)
  1466. if err != nil {
  1467. return nil, err
  1468. }
  1469. return topics[0], nil
  1470. }
  1471. // topicsFromPattern returns a list of topics matching the given pattern, but it does not create them.
  1472. func (s *Server) topicsFromPattern(pattern string) ([]*topic, error) {
  1473. s.mu.RLock()
  1474. defer s.mu.RUnlock()
  1475. patternRegexp, err := regexp.Compile("^" + strings.ReplaceAll(pattern, "*", ".*") + "$")
  1476. if err != nil {
  1477. return nil, err
  1478. }
  1479. topics := make([]*topic, 0)
  1480. for _, t := range s.topics {
  1481. if patternRegexp.MatchString(t.ID) {
  1482. topics = append(topics, t)
  1483. }
  1484. }
  1485. return topics, nil
  1486. }
  1487. func (s *Server) runSMTPServer() error {
  1488. s.smtpServerBackend = newMailBackend(s.config, s.handle)
  1489. s.smtpServer = smtp.NewServer(s.smtpServerBackend)
  1490. s.smtpServer.Addr = s.config.SMTPServerListen
  1491. s.smtpServer.Domain = s.config.SMTPServerDomain
  1492. s.smtpServer.ReadTimeout = 10 * time.Second
  1493. s.smtpServer.WriteTimeout = 10 * time.Second
  1494. s.smtpServer.MaxMessageBytes = 1024 * 1024 // Must be much larger than message size (headers, multipart, etc.)
  1495. s.smtpServer.MaxRecipients = 1
  1496. s.smtpServer.AllowInsecureAuth = true
  1497. return s.smtpServer.ListenAndServe()
  1498. }
  1499. func (s *Server) runManager() {
  1500. for {
  1501. select {
  1502. case <-time.After(s.config.ManagerInterval):
  1503. log.
  1504. Tag(tagManager).
  1505. Timing(s.execManager).
  1506. Debug("Manager finished")
  1507. case <-s.closeChan:
  1508. return
  1509. }
  1510. }
  1511. }
  1512. // runStatsResetter runs once a day (usually midnight UTC) to reset all the visitor's message and
  1513. // email counters. The stats are used to display the counters in the web app, as well as for rate limiting.
  1514. func (s *Server) runStatsResetter() {
  1515. for {
  1516. runAt := util.NextOccurrenceUTC(s.config.VisitorStatsResetTime, time.Now())
  1517. timer := time.NewTimer(time.Until(runAt))
  1518. log.Tag(tagResetter).Debug("Waiting until %v to reset visitor stats", runAt)
  1519. select {
  1520. case <-timer.C:
  1521. log.Tag(tagResetter).Debug("Running stats resetter")
  1522. s.resetStats()
  1523. case <-s.closeChan:
  1524. log.Tag(tagResetter).Debug("Stopping stats resetter")
  1525. timer.Stop()
  1526. return
  1527. }
  1528. }
  1529. }
  1530. func (s *Server) resetStats() {
  1531. log.Info("Resetting all visitor stats (daily task)")
  1532. s.mu.Lock()
  1533. defer s.mu.Unlock() // Includes the database query to avoid races with other processes
  1534. for _, v := range s.visitors {
  1535. v.ResetStats()
  1536. }
  1537. if s.userManager != nil {
  1538. if err := s.userManager.ResetStats(); err != nil {
  1539. log.Tag(tagResetter).Warn("Failed to write to database: %s", err.Error())
  1540. }
  1541. }
  1542. }
  1543. func (s *Server) runFirebaseKeepaliver() {
  1544. if s.firebaseClient == nil {
  1545. return
  1546. }
  1547. v := newVisitor(s.config, s.messageCache, s.userManager, netip.IPv4Unspecified(), nil) // Background process, not a real visitor, uses IP 0.0.0.0
  1548. for {
  1549. select {
  1550. case <-time.After(s.config.FirebaseKeepaliveInterval):
  1551. s.sendToFirebase(v, newKeepaliveMessage(firebaseControlTopic))
  1552. /*
  1553. FIXME: Disable iOS polling entirely for now due to thundering herd problem (see #677)
  1554. To solve this, we'd have to shard the iOS poll topics to spread out the polling evenly.
  1555. Given that it's not really necessary to poll, turning it off for now should not have any impact.
  1556. case <-time.After(s.config.FirebasePollInterval):
  1557. s.sendToFirebase(v, newKeepaliveMessage(firebasePollTopic))
  1558. */
  1559. case <-s.closeChan:
  1560. return
  1561. }
  1562. }
  1563. }
  1564. func (s *Server) runDelayedSender() {
  1565. for {
  1566. select {
  1567. case <-time.After(s.config.DelayedSenderInterval):
  1568. if err := s.sendDelayedMessages(); err != nil {
  1569. log.Tag(tagPublish).Err(err).Warn("Error sending delayed messages")
  1570. }
  1571. case <-s.closeChan:
  1572. return
  1573. }
  1574. }
  1575. }
  1576. func (s *Server) sendDelayedMessages() error {
  1577. messages, err := s.messageCache.MessagesDue()
  1578. if err != nil {
  1579. return err
  1580. }
  1581. for _, m := range messages {
  1582. var u *user.User
  1583. if s.userManager != nil && m.User != "" {
  1584. u, err = s.userManager.UserByID(m.User)
  1585. if err != nil {
  1586. log.With(m).Err(err).Warn("Error sending delayed message")
  1587. continue
  1588. }
  1589. }
  1590. v := s.visitor(m.Sender, u)
  1591. if err := s.sendDelayedMessage(v, m); err != nil {
  1592. logvm(v, m).Err(err).Warn("Error sending delayed message")
  1593. }
  1594. }
  1595. return nil
  1596. }
  1597. func (s *Server) sendDelayedMessage(v *visitor, m *message) error {
  1598. logvm(v, m).Debug("Sending delayed message")
  1599. s.mu.RLock()
  1600. t, ok := s.topics[m.Topic] // If no subscribers, just mark message as published
  1601. s.mu.RUnlock()
  1602. if ok {
  1603. go func() {
  1604. // We do not rate-limit messages here, since we've rate limited them in the PUT/POST handler
  1605. if err := t.Publish(v, m); err != nil {
  1606. logvm(v, m).Err(err).Warn("Unable to publish message")
  1607. }
  1608. }()
  1609. }
  1610. if s.firebaseClient != nil { // Firebase subscribers may not show up in topics map
  1611. go s.sendToFirebase(v, m)
  1612. }
  1613. if s.config.UpstreamBaseURL != "" {
  1614. go s.forwardPollRequest(v, m)
  1615. }
  1616. if err := s.messageCache.MarkPublished(m); err != nil {
  1617. return err
  1618. }
  1619. return nil
  1620. }
  1621. // transformBodyJSON peeks the request body, reads the JSON, and converts it to headers
  1622. // before passing it on to the next handler. This is meant to be used in combination with handlePublish.
  1623. func (s *Server) transformBodyJSON(next handleFunc) handleFunc {
  1624. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1625. m, err := readJSONWithLimit[publishMessage](r.Body, s.config.MessageLimit*2, false) // 2x to account for JSON format overhead
  1626. if err != nil {
  1627. return err
  1628. }
  1629. if !topicRegex.MatchString(m.Topic) {
  1630. return errHTTPBadRequestTopicInvalid
  1631. }
  1632. if m.Message == "" {
  1633. m.Message = emptyMessageBody
  1634. }
  1635. r.URL.Path = "/" + m.Topic
  1636. r.Body = io.NopCloser(strings.NewReader(m.Message))
  1637. if m.Title != "" {
  1638. r.Header.Set("X-Title", m.Title)
  1639. }
  1640. if m.Priority != 0 {
  1641. r.Header.Set("X-Priority", fmt.Sprintf("%d", m.Priority))
  1642. }
  1643. if m.Tags != nil && len(m.Tags) > 0 {
  1644. r.Header.Set("X-Tags", strings.Join(m.Tags, ","))
  1645. }
  1646. if m.Attach != "" {
  1647. r.Header.Set("X-Attach", m.Attach)
  1648. }
  1649. if m.Filename != "" {
  1650. r.Header.Set("X-Filename", m.Filename)
  1651. }
  1652. if m.Click != "" {
  1653. r.Header.Set("X-Click", m.Click)
  1654. }
  1655. if m.Icon != "" {
  1656. r.Header.Set("X-Icon", m.Icon)
  1657. }
  1658. if len(m.Actions) > 0 {
  1659. actionsStr, err := json.Marshal(m.Actions)
  1660. if err != nil {
  1661. return errHTTPBadRequestMessageJSONInvalid
  1662. }
  1663. r.Header.Set("X-Actions", string(actionsStr))
  1664. }
  1665. if m.Email != "" {
  1666. r.Header.Set("X-Email", m.Email)
  1667. }
  1668. if m.Delay != "" {
  1669. r.Header.Set("X-Delay", m.Delay)
  1670. }
  1671. return next(w, r, v)
  1672. }
  1673. }
  1674. func (s *Server) transformMatrixJSON(next handleFunc) handleFunc {
  1675. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1676. newRequest, err := newRequestFromMatrixJSON(r, s.config.BaseURL, s.config.MessageLimit)
  1677. if err != nil {
  1678. logvr(v, r).Tag(tagMatrix).Err(err).Debug("Invalid Matrix request")
  1679. if e, ok := err.(*errMatrixPushkeyRejected); ok {
  1680. return writeMatrixResponse(w, e.rejectedPushKey)
  1681. }
  1682. return err
  1683. }
  1684. if err := next(w, newRequest, v); err != nil {
  1685. logvr(v, r).Tag(tagMatrix).Err(err).Debug("Error handling Matrix request")
  1686. return err
  1687. }
  1688. return nil
  1689. }
  1690. }
  1691. func (s *Server) authorizeTopicWrite(next handleFunc) handleFunc {
  1692. return s.autorizeTopic(next, user.PermissionWrite)
  1693. }
  1694. func (s *Server) authorizeTopicRead(next handleFunc) handleFunc {
  1695. return s.autorizeTopic(next, user.PermissionRead)
  1696. }
  1697. func (s *Server) autorizeTopic(next handleFunc, perm user.Permission) handleFunc {
  1698. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1699. if s.userManager == nil {
  1700. return next(w, r, v)
  1701. }
  1702. topics, _, err := s.topicsFromPath(r.URL.Path)
  1703. if err != nil {
  1704. return err
  1705. }
  1706. u := v.User()
  1707. for _, t := range topics {
  1708. if err := s.userManager.Authorize(u, t.ID, perm); err != nil {
  1709. logvr(v, r).With(t).Err(err).Debug("Access to topic %s not authorized", t.ID)
  1710. return errHTTPForbidden.With(t)
  1711. }
  1712. }
  1713. return next(w, r, v)
  1714. }
  1715. }
  1716. // maybeAuthenticate reads the "Authorization" header and will try to authenticate the user
  1717. // if it is set.
  1718. //
  1719. // - If auth-file is not configured, immediately return an IP-based visitor
  1720. // - If the header is not set or not supported (anything non-Basic and non-Bearer),
  1721. // an IP-based visitor is returned
  1722. // - If the header is set, authenticate will be called to check the username/password (Basic auth),
  1723. // or the token (Bearer auth), and read the user from the database
  1724. //
  1725. // This function will ALWAYS return a visitor, even if an error occurs (e.g. unauthorized), so
  1726. // that subsequent logging calls still have a visitor context.
  1727. func (s *Server) maybeAuthenticate(r *http.Request) (*visitor, error) {
  1728. // Read "Authorization" header value, and exit out early if it's not set
  1729. ip := extractIPAddress(r, s.config.BehindProxy)
  1730. vip := s.visitor(ip, nil)
  1731. if s.userManager == nil {
  1732. return vip, nil
  1733. }
  1734. header, err := readAuthHeader(r)
  1735. if err != nil {
  1736. return vip, err
  1737. } else if !supportedAuthHeader(header) {
  1738. return vip, nil
  1739. }
  1740. // If we're trying to auth, check the rate limiter first
  1741. if !vip.AuthAllowed() {
  1742. return vip, errHTTPTooManyRequestsLimitAuthFailure // Always return visitor, even when error occurs!
  1743. }
  1744. u, err := s.authenticate(r, header)
  1745. if err != nil {
  1746. vip.AuthFailed()
  1747. logr(r).Err(err).Debug("Authentication failed")
  1748. return vip, errHTTPUnauthorized // Always return visitor, even when error occurs!
  1749. }
  1750. // Authentication with user was successful
  1751. return s.visitor(ip, u), nil
  1752. }
  1753. // authenticate a user based on basic auth username/password (Authorization: Basic ...), or token auth (Authorization: Bearer ...).
  1754. // The Authorization header can be passed as a header or the ?auth=... query param. The latter is required only to
  1755. // support the WebSocket JavaScript class, which does not support passing headers during the initial request. The auth
  1756. // query param is effectively doubly base64 encoded. Its format is base64(Basic base64(user:pass)).
  1757. func (s *Server) authenticate(r *http.Request, header string) (user *user.User, err error) {
  1758. if strings.HasPrefix(header, "Bearer") {
  1759. return s.authenticateBearerAuth(r, strings.TrimSpace(strings.TrimPrefix(header, "Bearer")))
  1760. }
  1761. return s.authenticateBasicAuth(r, header)
  1762. }
  1763. // readAuthHeader reads the raw value of the Authorization header, either from the actual HTTP header,
  1764. // or from the ?auth... query parameter
  1765. func readAuthHeader(r *http.Request) (string, error) {
  1766. value := strings.TrimSpace(r.Header.Get("Authorization"))
  1767. queryParam := readQueryParam(r, "authorization", "auth")
  1768. if queryParam != "" {
  1769. a, err := base64.RawURLEncoding.DecodeString(queryParam)
  1770. if err != nil {
  1771. return "", err
  1772. }
  1773. value = strings.TrimSpace(string(a))
  1774. }
  1775. return value, nil
  1776. }
  1777. // supportedAuthHeader returns true only if the Authorization header value starts
  1778. // with "Basic" or "Bearer". In particular, an empty value is not supported, and neither
  1779. // are things like "WebPush", or "vapid" (see #629).
  1780. func supportedAuthHeader(value string) bool {
  1781. value = strings.ToLower(value)
  1782. return strings.HasPrefix(value, "basic ") || strings.HasPrefix(value, "bearer ")
  1783. }
  1784. func (s *Server) authenticateBasicAuth(r *http.Request, value string) (user *user.User, err error) {
  1785. r.Header.Set("Authorization", value)
  1786. username, password, ok := r.BasicAuth()
  1787. if !ok {
  1788. return nil, errors.New("invalid basic auth")
  1789. } else if username == "" {
  1790. return s.authenticateBearerAuth(r, password) // Treat password as token
  1791. }
  1792. return s.userManager.Authenticate(username, password)
  1793. }
  1794. func (s *Server) authenticateBearerAuth(r *http.Request, token string) (*user.User, error) {
  1795. u, err := s.userManager.AuthenticateToken(token)
  1796. if err != nil {
  1797. return nil, err
  1798. }
  1799. ip := extractIPAddress(r, s.config.BehindProxy)
  1800. go s.userManager.EnqueueTokenUpdate(token, &user.TokenUpdate{
  1801. LastAccess: time.Now(),
  1802. LastOrigin: ip,
  1803. })
  1804. return u, nil
  1805. }
  1806. func (s *Server) visitor(ip netip.Addr, user *user.User) *visitor {
  1807. s.mu.Lock()
  1808. defer s.mu.Unlock()
  1809. id := visitorID(ip, user)
  1810. v, exists := s.visitors[id]
  1811. if !exists {
  1812. s.visitors[id] = newVisitor(s.config, s.messageCache, s.userManager, ip, user)
  1813. return s.visitors[id]
  1814. }
  1815. v.Keepalive()
  1816. v.SetUser(user) // Always update with the latest user, may be nil!
  1817. return v
  1818. }
  1819. func (s *Server) writeJSON(w http.ResponseWriter, v any) error {
  1820. w.Header().Set("Content-Type", "application/json")
  1821. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  1822. if err := json.NewEncoder(w).Encode(v); err != nil {
  1823. return err
  1824. }
  1825. return nil
  1826. }
  1827. func (s *Server) updateAndWriteStats(messagesCount int64) {
  1828. s.mu.Lock()
  1829. s.messagesHistory = append(s.messagesHistory, messagesCount)
  1830. if len(s.messagesHistory) > messagesHistoryMax {
  1831. s.messagesHistory = s.messagesHistory[1:]
  1832. }
  1833. s.mu.Unlock()
  1834. go func() {
  1835. if err := s.messageCache.UpdateStats(messagesCount); err != nil {
  1836. log.Tag(tagManager).Err(err).Warn("Cannot write messages stats")
  1837. }
  1838. }()
  1839. }