server.go 74 KB

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