server.go 67 KB

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