server.go 79 KB

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