server.go 79 KB

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