server.go 82 KB

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