server.go 80 KB

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