server.go 80 KB

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