server.go 64 KB

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