server.go 79 KB

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