server.go 82 KB

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