server.go 76 KB

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