server.go 85 KB

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