server.go 83 KB

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