server.go 61 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734
  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. "github.com/emersion/go-smtp"
  12. "github.com/gorilla/websocket"
  13. "golang.org/x/sync/errgroup"
  14. "heckel.io/ntfy/log"
  15. "heckel.io/ntfy/user"
  16. "heckel.io/ntfy/util"
  17. "io"
  18. "net"
  19. "net/http"
  20. "net/netip"
  21. "net/url"
  22. "os"
  23. "path"
  24. "path/filepath"
  25. "regexp"
  26. "sort"
  27. "strconv"
  28. "strings"
  29. "sync"
  30. "time"
  31. "unicode/utf8"
  32. )
  33. /*
  34. - HIGH Rate limiting: Sensitive endpoints (account/login/change-password/...)
  35. - HIGH Account limit creation triggers when account is taken!
  36. - HIGH Docs
  37. - HIGH Self-review
  38. - MEDIUM: Test for expiring messages after reservation removal
  39. - MEDIUM: Test new token endpoints & never-expiring token
  40. - LOW: UI: Flickering upgrade banner when logging in
  41. */
  42. // Server is the main server, providing the UI and API for ntfy
  43. type Server struct {
  44. config *Config
  45. httpServer *http.Server
  46. httpsServer *http.Server
  47. unixListener net.Listener
  48. smtpServer *smtp.Server
  49. smtpServerBackend *smtpBackend
  50. smtpSender mailer
  51. topics map[string]*topic
  52. visitors map[string]*visitor // ip:<ip> or user:<user>
  53. firebaseClient *firebaseClient
  54. messages int64
  55. userManager *user.Manager // Might be nil!
  56. messageCache *messageCache // Database that stores the messages
  57. fileCache *fileCache // File system based cache that stores attachments
  58. stripe stripeAPI // Stripe API, can be replaced with a mock
  59. priceCache *util.LookupCache[map[string]string] // Stripe price ID -> formatted price
  60. closeChan chan bool
  61. mu sync.Mutex
  62. }
  63. // handleFunc extends the normal http.HandlerFunc to be able to easily return errors
  64. type handleFunc func(http.ResponseWriter, *http.Request, *visitor) error
  65. var (
  66. // If changed, don't forget to update Android App and auth_sqlite.go
  67. topicRegex = regexp.MustCompile(`^[-_A-Za-z0-9]{1,64}$`) // No /!
  68. topicPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}$`) // Regex must match JS & Android app!
  69. externalTopicPathRegex = regexp.MustCompile(`^/[^/]+\.[^/]+/[-_A-Za-z0-9]{1,64}$`) // Extended topic path, for web-app, e.g. /example.com/mytopic
  70. jsonPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/json$`)
  71. ssePathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/sse$`)
  72. rawPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/raw$`)
  73. wsPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/ws$`)
  74. authPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/auth$`)
  75. publishPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}/(publish|send|trigger)$`)
  76. webConfigPath = "/config.js"
  77. accountPath = "/account"
  78. matrixPushPath = "/_matrix/push/v1/notify"
  79. apiHealthPath = "/v1/health"
  80. apiTiers = "/v1/tiers"
  81. apiAccountPath = "/v1/account"
  82. apiAccountTokenPath = "/v1/account/token"
  83. apiAccountPasswordPath = "/v1/account/password"
  84. apiAccountSettingsPath = "/v1/account/settings"
  85. apiAccountSubscriptionPath = "/v1/account/subscription"
  86. apiAccountReservationPath = "/v1/account/reservation"
  87. apiAccountBillingPortalPath = "/v1/account/billing/portal"
  88. apiAccountBillingWebhookPath = "/v1/account/billing/webhook"
  89. apiAccountBillingSubscriptionPath = "/v1/account/billing/subscription"
  90. apiAccountBillingSubscriptionCheckoutSuccessTemplate = "/v1/account/billing/subscription/success/{CHECKOUT_SESSION_ID}"
  91. apiAccountBillingSubscriptionCheckoutSuccessRegex = regexp.MustCompile(`/v1/account/billing/subscription/success/(.+)$`)
  92. apiAccountReservationSingleRegex = regexp.MustCompile(`/v1/account/reservation/([-_A-Za-z0-9]{1,64})$`)
  93. apiAccountSubscriptionSingleRegex = regexp.MustCompile(`^/v1/account/subscription/([-_A-Za-z0-9]{16})$`)
  94. staticRegex = regexp.MustCompile(`^/static/.+`)
  95. docsRegex = regexp.MustCompile(`^/docs(|/.*)$`)
  96. fileRegex = regexp.MustCompile(`^/file/([-_A-Za-z0-9]{1,64})(?:\.[A-Za-z0-9]{1,16})?$`)
  97. disallowedTopics = []string{"docs", "static", "file", "app", "account", "settings", "pricing", "signup", "login", "reset-password"} // If updated, also update in Android and web app
  98. urlRegex = regexp.MustCompile(`^https?://`)
  99. //go:embed site
  100. webFs embed.FS
  101. webFsCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: webFs}
  102. webSiteDir = "/site"
  103. webHomeIndex = "/home.html" // Landing page, only if "web-root: home"
  104. webAppIndex = "/app.html" // React app
  105. //go:embed docs
  106. docsStaticFs embed.FS
  107. docsStaticCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: docsStaticFs}
  108. )
  109. const (
  110. firebaseControlTopic = "~control" // See Android if changed
  111. firebasePollTopic = "~poll" // See iOS if changed
  112. emptyMessageBody = "triggered" // Used if message body is empty
  113. newMessageBody = "New message" // Used in poll requests as generic message
  114. defaultAttachmentMessage = "You received a file: %s" // Used if message body is empty, and there is an attachment
  115. encodingBase64 = "base64" // Used mainly for binary UnifiedPush messages
  116. jsonBodyBytesLimit = 16384
  117. )
  118. // WebSocket constants
  119. const (
  120. wsWriteWait = 2 * time.Second
  121. wsBufferSize = 1024
  122. wsReadLimit = 64 // We only ever receive PINGs
  123. wsPongWait = 15 * time.Second
  124. )
  125. // Log tags
  126. const (
  127. tagStartup = "startup"
  128. tagPublish = "publish"
  129. tagFirebase = "firebase"
  130. tagEmail = "email" // Send email
  131. tagSMTP = "smtp" // Receive email
  132. tagFileCache = "file_cache"
  133. tagMessageCache = "message_cache"
  134. tagStripe = "stripe"
  135. tagAccount = "account"
  136. tagManager = "manager"
  137. tagResetter = "resetter"
  138. tagWebsocket = "websocket"
  139. tagMatrix = "matrix"
  140. )
  141. // New instantiates a new Server. It creates the cache and adds a Firebase
  142. // subscriber (if configured).
  143. func New(conf *Config) (*Server, error) {
  144. var mailer mailer
  145. if conf.SMTPSenderAddr != "" {
  146. mailer = &smtpSender{config: conf}
  147. }
  148. var stripe stripeAPI
  149. if conf.StripeSecretKey != "" {
  150. stripe = newStripeAPI()
  151. }
  152. messageCache, err := createMessageCache(conf)
  153. if err != nil {
  154. return nil, err
  155. }
  156. topics, err := messageCache.Topics()
  157. if err != nil {
  158. return nil, err
  159. }
  160. var fileCache *fileCache
  161. if conf.AttachmentCacheDir != "" {
  162. fileCache, err = newFileCache(conf.AttachmentCacheDir, conf.AttachmentTotalSizeLimit)
  163. if err != nil {
  164. return nil, err
  165. }
  166. }
  167. var userManager *user.Manager
  168. if conf.AuthFile != "" {
  169. userManager, err = user.NewManager(conf.AuthFile, conf.AuthStartupQueries, conf.AuthDefault, conf.AuthBcryptCost, conf.AuthStatsQueueWriterInterval)
  170. if err != nil {
  171. return nil, err
  172. }
  173. }
  174. var firebaseClient *firebaseClient
  175. if conf.FirebaseKeyFile != "" {
  176. sender, err := newFirebaseSender(conf.FirebaseKeyFile)
  177. if err != nil {
  178. return nil, err
  179. }
  180. firebaseClient = newFirebaseClient(sender, userManager)
  181. }
  182. s := &Server{
  183. config: conf,
  184. messageCache: messageCache,
  185. fileCache: fileCache,
  186. firebaseClient: firebaseClient,
  187. smtpSender: mailer,
  188. topics: topics,
  189. userManager: userManager,
  190. visitors: make(map[string]*visitor),
  191. stripe: stripe,
  192. }
  193. s.priceCache = util.NewLookupCache(s.fetchStripePrices, conf.StripePriceCacheDuration)
  194. return s, nil
  195. }
  196. func createMessageCache(conf *Config) (*messageCache, error) {
  197. if conf.CacheDuration == 0 {
  198. return newNopCache()
  199. } else if conf.CacheFile != "" {
  200. return newSqliteCache(conf.CacheFile, conf.CacheStartupQueries, conf.CacheDuration, conf.CacheBatchSize, conf.CacheBatchTimeout, false)
  201. }
  202. return newMemCache()
  203. }
  204. // Run executes the main server. It listens on HTTP (+ HTTPS, if configured), and starts
  205. // a manager go routine to print stats and prune messages.
  206. func (s *Server) Run() error {
  207. var listenStr string
  208. if s.config.ListenHTTP != "" {
  209. listenStr += fmt.Sprintf(" %s[http]", s.config.ListenHTTP)
  210. }
  211. if s.config.ListenHTTPS != "" {
  212. listenStr += fmt.Sprintf(" %s[https]", s.config.ListenHTTPS)
  213. }
  214. if s.config.ListenUnix != "" {
  215. listenStr += fmt.Sprintf(" %s[unix]", s.config.ListenUnix)
  216. }
  217. if s.config.SMTPServerListen != "" {
  218. listenStr += fmt.Sprintf(" %s[smtp]", s.config.SMTPServerListen)
  219. }
  220. log.Tag(tagStartup).Info("Listening on%s, ntfy %s, log level is %s", listenStr, s.config.Version, log.CurrentLevel().String())
  221. if log.IsFile() {
  222. fmt.Fprintf(os.Stderr, "Listening on%s, ntfy %s\n", listenStr, s.config.Version)
  223. fmt.Fprintf(os.Stderr, "Logs are written to %s\n", log.File())
  224. }
  225. mux := http.NewServeMux()
  226. mux.HandleFunc("/", s.handle)
  227. errChan := make(chan error)
  228. s.mu.Lock()
  229. s.closeChan = make(chan bool)
  230. if s.config.ListenHTTP != "" {
  231. s.httpServer = &http.Server{Addr: s.config.ListenHTTP, Handler: mux}
  232. go func() {
  233. errChan <- s.httpServer.ListenAndServe()
  234. }()
  235. }
  236. if s.config.ListenHTTPS != "" {
  237. s.httpsServer = &http.Server{Addr: s.config.ListenHTTPS, Handler: mux}
  238. go func() {
  239. errChan <- s.httpsServer.ListenAndServeTLS(s.config.CertFile, s.config.KeyFile)
  240. }()
  241. }
  242. if s.config.ListenUnix != "" {
  243. go func() {
  244. var err error
  245. s.mu.Lock()
  246. os.Remove(s.config.ListenUnix)
  247. s.unixListener, err = net.Listen("unix", s.config.ListenUnix)
  248. if err != nil {
  249. s.mu.Unlock()
  250. errChan <- err
  251. return
  252. }
  253. defer s.unixListener.Close()
  254. if s.config.ListenUnixMode > 0 {
  255. if err := os.Chmod(s.config.ListenUnix, s.config.ListenUnixMode); err != nil {
  256. s.mu.Unlock()
  257. errChan <- err
  258. return
  259. }
  260. }
  261. s.mu.Unlock()
  262. httpServer := &http.Server{Handler: mux}
  263. errChan <- httpServer.Serve(s.unixListener)
  264. }()
  265. }
  266. if s.config.SMTPServerListen != "" {
  267. go func() {
  268. errChan <- s.runSMTPServer()
  269. }()
  270. }
  271. s.mu.Unlock()
  272. go s.runManager()
  273. go s.runStatsResetter()
  274. go s.runDelayedSender()
  275. go s.runFirebaseKeepaliver()
  276. return <-errChan
  277. }
  278. // Stop stops HTTP (+HTTPS) server and all managers
  279. func (s *Server) Stop() {
  280. s.mu.Lock()
  281. defer s.mu.Unlock()
  282. if s.httpServer != nil {
  283. s.httpServer.Close()
  284. }
  285. if s.httpsServer != nil {
  286. s.httpsServer.Close()
  287. }
  288. if s.unixListener != nil {
  289. s.unixListener.Close()
  290. }
  291. if s.smtpServer != nil {
  292. s.smtpServer.Close()
  293. }
  294. s.closeDatabases()
  295. close(s.closeChan)
  296. }
  297. func (s *Server) closeDatabases() {
  298. if s.userManager != nil {
  299. s.userManager.Close()
  300. }
  301. s.messageCache.Close()
  302. }
  303. func (s *Server) handle(w http.ResponseWriter, r *http.Request) {
  304. v, err := s.maybeAuthenticate(r) // Note: Always returns v, even when error is returned
  305. if err == nil {
  306. logvr(v, r).Debug("Dispatching request")
  307. if log.IsTrace() {
  308. logvr(v, r).Trace("Entire request (headers and body):\n%s", renderHTTPRequest(r))
  309. }
  310. err = s.handleInternal(w, r, v)
  311. }
  312. if err != nil {
  313. if websocket.IsWebSocketUpgrade(r) {
  314. isNormalError := strings.Contains(err.Error(), "i/o timeout")
  315. if isNormalError {
  316. logvr(v, r).Tag(tagWebsocket).Err(err).Fields(websocketErrorContext(err)).Debug("WebSocket error (this error is okay, it happens a lot): %s", err.Error())
  317. } else {
  318. logvr(v, r).Tag(tagWebsocket).Err(err).Fields(websocketErrorContext(err)).Info("WebSocket error: %s", err.Error())
  319. }
  320. return // Do not attempt to write to upgraded connection
  321. }
  322. if matrixErr, ok := err.(*errMatrix); ok {
  323. writeMatrixError(w, r, v, matrixErr)
  324. return
  325. }
  326. httpErr, ok := err.(*errHTTP)
  327. if !ok {
  328. httpErr = errHTTPInternalError
  329. }
  330. isNormalError := httpErr.HTTPCode == http.StatusNotFound || httpErr.HTTPCode == http.StatusBadRequest || httpErr.HTTPCode == http.StatusTooManyRequests
  331. if isNormalError {
  332. logvr(v, r).
  333. Err(httpErr).
  334. Debug("Connection closed with HTTP %d (ntfy error %d)", httpErr.HTTPCode, httpErr.Code)
  335. } else {
  336. logvr(v, r).
  337. Err(httpErr).
  338. Info("Connection closed with HTTP %d (ntfy error %d)", httpErr.HTTPCode, httpErr.Code)
  339. }
  340. w.Header().Set("Content-Type", "application/json")
  341. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  342. w.WriteHeader(httpErr.HTTPCode)
  343. io.WriteString(w, httpErr.JSON()+"\n")
  344. }
  345. }
  346. func (s *Server) handleInternal(w http.ResponseWriter, r *http.Request, v *visitor) error {
  347. if r.Method == http.MethodGet && r.URL.Path == "/" {
  348. return s.ensureWebEnabled(s.handleHome)(w, r, v)
  349. } else if r.Method == http.MethodHead && r.URL.Path == "/" {
  350. return s.ensureWebEnabled(s.handleEmpty)(w, r, v)
  351. } else if r.Method == http.MethodGet && r.URL.Path == apiHealthPath {
  352. return s.handleHealth(w, r, v)
  353. } else if r.Method == http.MethodGet && r.URL.Path == webConfigPath {
  354. return s.ensureWebEnabled(s.handleWebConfig)(w, r, v)
  355. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountPath {
  356. return s.ensureUserManager(s.handleAccountCreate)(w, r, v)
  357. } else if r.Method == http.MethodGet && r.URL.Path == apiAccountPath {
  358. return s.handleAccountGet(w, r, v) // Allowed by anonymous
  359. } else if r.Method == http.MethodDelete && r.URL.Path == apiAccountPath {
  360. return s.ensureUser(s.withAccountSync(s.handleAccountDelete))(w, r, v)
  361. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountPasswordPath {
  362. return s.ensureUser(s.handleAccountPasswordChange)(w, r, v)
  363. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountTokenPath {
  364. return s.ensureUser(s.withAccountSync(s.handleAccountTokenCreate))(w, r, v)
  365. } else if r.Method == http.MethodPatch && r.URL.Path == apiAccountTokenPath {
  366. return s.ensureUser(s.withAccountSync(s.handleAccountTokenUpdate))(w, r, v)
  367. } else if r.Method == http.MethodDelete && r.URL.Path == apiAccountTokenPath {
  368. return s.ensureUser(s.withAccountSync(s.handleAccountTokenDelete))(w, r, v)
  369. } else if r.Method == http.MethodPatch && r.URL.Path == apiAccountSettingsPath {
  370. return s.ensureUser(s.withAccountSync(s.handleAccountSettingsChange))(w, r, v)
  371. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountSubscriptionPath {
  372. return s.ensureUser(s.withAccountSync(s.handleAccountSubscriptionAdd))(w, r, v)
  373. } else if r.Method == http.MethodPatch && apiAccountSubscriptionSingleRegex.MatchString(r.URL.Path) {
  374. return s.ensureUser(s.withAccountSync(s.handleAccountSubscriptionChange))(w, r, v)
  375. } else if r.Method == http.MethodDelete && apiAccountSubscriptionSingleRegex.MatchString(r.URL.Path) {
  376. return s.ensureUser(s.withAccountSync(s.handleAccountSubscriptionDelete))(w, r, v)
  377. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountReservationPath {
  378. return s.ensureUser(s.withAccountSync(s.handleAccountReservationAdd))(w, r, v)
  379. } else if r.Method == http.MethodDelete && apiAccountReservationSingleRegex.MatchString(r.URL.Path) {
  380. return s.ensureUser(s.withAccountSync(s.handleAccountReservationDelete))(w, r, v)
  381. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountBillingSubscriptionPath {
  382. return s.ensurePaymentsEnabled(s.ensureUser(s.handleAccountBillingSubscriptionCreate))(w, r, v) // Account sync via incoming Stripe webhook
  383. } else if r.Method == http.MethodGet && apiAccountBillingSubscriptionCheckoutSuccessRegex.MatchString(r.URL.Path) {
  384. return s.ensurePaymentsEnabled(s.ensureUserManager(s.handleAccountBillingSubscriptionCreateSuccess))(w, r, v) // No user context!
  385. } else if r.Method == http.MethodPut && r.URL.Path == apiAccountBillingSubscriptionPath {
  386. return s.ensurePaymentsEnabled(s.ensureStripeCustomer(s.handleAccountBillingSubscriptionUpdate))(w, r, v) // Account sync via incoming Stripe webhook
  387. } else if r.Method == http.MethodDelete && r.URL.Path == apiAccountBillingSubscriptionPath {
  388. return s.ensurePaymentsEnabled(s.ensureStripeCustomer(s.handleAccountBillingSubscriptionDelete))(w, r, v) // Account sync via incoming Stripe webhook
  389. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountBillingPortalPath {
  390. return s.ensurePaymentsEnabled(s.ensureStripeCustomer(s.handleAccountBillingPortalSessionCreate))(w, r, v)
  391. } else if r.Method == http.MethodPost && r.URL.Path == apiAccountBillingWebhookPath {
  392. return s.ensurePaymentsEnabled(s.ensureUserManager(s.handleAccountBillingWebhook))(w, r, v) // This request comes from Stripe!
  393. } else if r.Method == http.MethodGet && r.URL.Path == apiTiers {
  394. return s.ensurePaymentsEnabled(s.handleBillingTiersGet)(w, r, v)
  395. } else if r.Method == http.MethodGet && r.URL.Path == matrixPushPath {
  396. return s.handleMatrixDiscovery(w)
  397. } else if r.Method == http.MethodGet && staticRegex.MatchString(r.URL.Path) {
  398. return s.ensureWebEnabled(s.handleStatic)(w, r, v)
  399. } else if r.Method == http.MethodGet && docsRegex.MatchString(r.URL.Path) {
  400. return s.ensureWebEnabled(s.handleDocs)(w, r, v)
  401. } else if (r.Method == http.MethodGet || r.Method == http.MethodHead) && fileRegex.MatchString(r.URL.Path) && s.config.AttachmentCacheDir != "" {
  402. return s.limitRequests(s.handleFile)(w, r, v)
  403. } else if r.Method == http.MethodOptions {
  404. return s.limitRequests(s.handleOptions)(w, r, v) // Should work even if the web app is not enabled, see #598
  405. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && r.URL.Path == "/" {
  406. return s.limitRequests(s.transformBodyJSON(s.authorizeTopicWrite(s.handlePublish)))(w, r, v)
  407. } else if r.Method == http.MethodPost && r.URL.Path == matrixPushPath {
  408. return s.limitRequests(s.transformMatrixJSON(s.authorizeTopicWrite(s.handlePublishMatrix)))(w, r, v)
  409. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && topicPathRegex.MatchString(r.URL.Path) {
  410. return s.limitRequests(s.authorizeTopicWrite(s.handlePublish))(w, r, v)
  411. } else if r.Method == http.MethodGet && publishPathRegex.MatchString(r.URL.Path) {
  412. return s.limitRequests(s.authorizeTopicWrite(s.handlePublish))(w, r, v)
  413. } else if r.Method == http.MethodGet && jsonPathRegex.MatchString(r.URL.Path) {
  414. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeJSON))(w, r, v)
  415. } else if r.Method == http.MethodGet && ssePathRegex.MatchString(r.URL.Path) {
  416. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeSSE))(w, r, v)
  417. } else if r.Method == http.MethodGet && rawPathRegex.MatchString(r.URL.Path) {
  418. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeRaw))(w, r, v)
  419. } else if r.Method == http.MethodGet && wsPathRegex.MatchString(r.URL.Path) {
  420. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeWS))(w, r, v)
  421. } else if r.Method == http.MethodGet && authPathRegex.MatchString(r.URL.Path) {
  422. return s.limitRequests(s.authorizeTopicRead(s.handleTopicAuth))(w, r, v)
  423. } else if r.Method == http.MethodGet && (topicPathRegex.MatchString(r.URL.Path) || externalTopicPathRegex.MatchString(r.URL.Path)) {
  424. return s.ensureWebEnabled(s.handleTopic)(w, r, v)
  425. }
  426. return errHTTPNotFound
  427. }
  428. func (s *Server) handleHome(w http.ResponseWriter, r *http.Request, v *visitor) error {
  429. if s.config.WebRootIsApp {
  430. r.URL.Path = webAppIndex
  431. } else {
  432. r.URL.Path = webHomeIndex
  433. }
  434. return s.handleStatic(w, r, v)
  435. }
  436. func (s *Server) handleTopic(w http.ResponseWriter, r *http.Request, v *visitor) error {
  437. unifiedpush := readBoolParam(r, false, "x-unifiedpush", "unifiedpush", "up") // see PUT/POST too!
  438. if unifiedpush {
  439. w.Header().Set("Content-Type", "application/json")
  440. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  441. _, err := io.WriteString(w, `{"unifiedpush":{"version":1}}`+"\n")
  442. return err
  443. }
  444. r.URL.Path = webAppIndex
  445. return s.handleStatic(w, r, v)
  446. }
  447. func (s *Server) handleEmpty(_ http.ResponseWriter, _ *http.Request, _ *visitor) error {
  448. return nil
  449. }
  450. func (s *Server) handleTopicAuth(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  451. return s.writeJSON(w, newSuccessResponse())
  452. }
  453. func (s *Server) handleHealth(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  454. response := &apiHealthResponse{
  455. Healthy: true,
  456. }
  457. return s.writeJSON(w, response)
  458. }
  459. func (s *Server) handleWebConfig(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  460. appRoot := "/"
  461. if !s.config.WebRootIsApp {
  462. appRoot = "/app"
  463. }
  464. response := &apiConfigResponse{
  465. BaseURL: "", // Will translate to window.location.origin
  466. AppRoot: appRoot,
  467. EnableLogin: s.config.EnableLogin,
  468. EnableSignup: s.config.EnableSignup,
  469. EnablePayments: s.config.StripeSecretKey != "",
  470. EnableReservations: s.config.EnableReservations,
  471. DisallowedTopics: disallowedTopics,
  472. }
  473. b, err := json.MarshalIndent(response, "", " ")
  474. if err != nil {
  475. return err
  476. }
  477. w.Header().Set("Content-Type", "text/javascript")
  478. _, err = io.WriteString(w, fmt.Sprintf("// Generated server configuration\nvar config = %s;\n", string(b)))
  479. return err
  480. }
  481. func (s *Server) handleStatic(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  482. r.URL.Path = webSiteDir + r.URL.Path
  483. util.Gzip(http.FileServer(http.FS(webFsCached))).ServeHTTP(w, r)
  484. return nil
  485. }
  486. func (s *Server) handleDocs(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  487. util.Gzip(http.FileServer(http.FS(docsStaticCached))).ServeHTTP(w, r)
  488. return nil
  489. }
  490. // handleFile processes the download of attachment files. The method handles GET and HEAD requests against a file.
  491. // Before streaming the file to a client, it locates uploader (m.Sender or m.User) in the message cache, so it
  492. // can associate the download bandwidth with the uploader.
  493. func (s *Server) handleFile(w http.ResponseWriter, r *http.Request, v *visitor) error {
  494. if s.config.AttachmentCacheDir == "" {
  495. return errHTTPInternalError
  496. }
  497. matches := fileRegex.FindStringSubmatch(r.URL.Path)
  498. if len(matches) != 2 {
  499. return errHTTPInternalErrorInvalidPath
  500. }
  501. messageID := matches[1]
  502. file := filepath.Join(s.config.AttachmentCacheDir, messageID)
  503. stat, err := os.Stat(file)
  504. if err != nil {
  505. return errHTTPNotFound
  506. }
  507. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  508. w.Header().Set("Content-Length", fmt.Sprintf("%d", stat.Size()))
  509. if r.Method == http.MethodHead {
  510. return nil
  511. }
  512. // Find message in database, and associate bandwidth to the uploader user
  513. // This is an easy way to
  514. // - avoid abuse (e.g. 1 uploader, 1k downloaders)
  515. // - and also uses the higher bandwidth limits of a paying user
  516. m, err := s.messageCache.Message(messageID)
  517. if err == errMessageNotFound {
  518. return errHTTPNotFound
  519. } else if err != nil {
  520. return err
  521. }
  522. bandwidthVisitor := v
  523. if s.userManager != nil && m.User != "" {
  524. u, err := s.userManager.UserByID(m.User)
  525. if err != nil {
  526. return err
  527. }
  528. bandwidthVisitor = s.visitor(v.IP(), u)
  529. } else if m.Sender.IsValid() {
  530. bandwidthVisitor = s.visitor(m.Sender, nil)
  531. }
  532. if !bandwidthVisitor.BandwidthAllowed(stat.Size()) {
  533. return errHTTPTooManyRequestsLimitAttachmentBandwidth
  534. }
  535. // Actually send file
  536. f, err := os.Open(file)
  537. if err != nil {
  538. return err
  539. }
  540. defer f.Close()
  541. _, err = io.Copy(util.NewContentTypeWriter(w, r.URL.Path), f)
  542. return err
  543. }
  544. func (s *Server) handleMatrixDiscovery(w http.ResponseWriter) error {
  545. if s.config.BaseURL == "" {
  546. return errHTTPInternalErrorMissingBaseURL
  547. }
  548. return writeMatrixDiscoveryResponse(w)
  549. }
  550. func (s *Server) handlePublishWithoutResponse(r *http.Request, v *visitor) (*message, error) {
  551. t, err := s.topicFromPath(r.URL.Path)
  552. if err != nil {
  553. return nil, err
  554. }
  555. if !v.MessageAllowed() {
  556. return nil, errHTTPTooManyRequestsLimitMessages
  557. }
  558. body, err := util.Peek(r.Body, s.config.MessageLimit)
  559. if err != nil {
  560. return nil, err
  561. }
  562. m := newDefaultMessage(t.ID, "")
  563. cache, firebase, email, unifiedpush, err := s.parsePublishParams(r, v, m)
  564. if err != nil {
  565. return nil, err
  566. }
  567. if m.PollID != "" {
  568. m = newPollRequestMessage(t.ID, m.PollID)
  569. }
  570. m.Sender = v.IP()
  571. m.User = v.MaybeUserID()
  572. m.Expires = time.Now().Add(v.Limits().MessageExpiryDuration).Unix()
  573. if err := s.handlePublishBody(r, v, m, body, unifiedpush); err != nil {
  574. return nil, err
  575. }
  576. if m.Message == "" {
  577. m.Message = emptyMessageBody
  578. }
  579. delayed := m.Time > time.Now().Unix()
  580. logvrm(v, r, m).
  581. Tag(tagPublish).
  582. Fields(log.Context{
  583. "message_delayed": delayed,
  584. "message_firebase": firebase,
  585. "message_unifiedpush": unifiedpush,
  586. "message_email": email,
  587. }).
  588. Debug("Received message")
  589. if log.IsTrace() {
  590. logvrm(v, r, m).
  591. Tag(tagPublish).
  592. Field("message_body", util.MaybeMarshalJSON(m)).
  593. Trace("Message body")
  594. }
  595. if !delayed {
  596. if err := t.Publish(v, m); err != nil {
  597. return nil, err
  598. }
  599. if s.firebaseClient != nil && firebase {
  600. go s.sendToFirebase(v, m)
  601. }
  602. if s.smtpSender != nil && email != "" {
  603. go s.sendEmail(v, m, email)
  604. }
  605. if s.config.UpstreamBaseURL != "" {
  606. go s.forwardPollRequest(v, m)
  607. }
  608. } else {
  609. logvrm(v, r, m).Tag(tagPublish).Debug("Message delayed, will process later")
  610. }
  611. if cache {
  612. logvrm(v, r, m).Tag(tagPublish).Debug("Adding message to cache")
  613. if err := s.messageCache.AddMessage(m); err != nil {
  614. return nil, err
  615. }
  616. }
  617. u := v.User()
  618. if s.userManager != nil && u != nil && u.Tier != nil {
  619. go s.userManager.EnqueueStats(u.ID, v.Stats())
  620. }
  621. s.mu.Lock()
  622. s.messages++
  623. s.mu.Unlock()
  624. return m, nil
  625. }
  626. func (s *Server) handlePublish(w http.ResponseWriter, r *http.Request, v *visitor) error {
  627. m, err := s.handlePublishWithoutResponse(r, v)
  628. if err != nil {
  629. return err
  630. }
  631. return s.writeJSON(w, m)
  632. }
  633. func (s *Server) handlePublishMatrix(w http.ResponseWriter, r *http.Request, v *visitor) error {
  634. _, err := s.handlePublishWithoutResponse(r, v)
  635. if err != nil {
  636. return &errMatrix{pushKey: r.Header.Get(matrixPushKeyHeader), err: err}
  637. }
  638. return writeMatrixSuccess(w)
  639. }
  640. func (s *Server) sendToFirebase(v *visitor, m *message) {
  641. logvm(v, m).Tag(tagFirebase).Debug("Publishing to Firebase")
  642. if err := s.firebaseClient.Send(v, m); err != nil {
  643. if err == errFirebaseTemporarilyBanned {
  644. logvm(v, m).Tag(tagFirebase).Err(err).Debug("Unable to publish to Firebase: %v", err.Error())
  645. } else {
  646. logvm(v, m).Tag(tagFirebase).Err(err).Warn("Unable to publish to Firebase: %v", err.Error())
  647. }
  648. }
  649. }
  650. func (s *Server) sendEmail(v *visitor, m *message, email string) {
  651. logvm(v, m).Tag(tagEmail).Field("email", email).Debug("Sending email to %s", email)
  652. if err := s.smtpSender.Send(v, m, email); err != nil {
  653. logvm(v, m).Tag(tagEmail).Field("email", email).Err(err).Warn("Unable to send email to %s: %v", email, err.Error())
  654. }
  655. }
  656. func (s *Server) forwardPollRequest(v *visitor, m *message) {
  657. topicURL := fmt.Sprintf("%s/%s", s.config.BaseURL, m.Topic)
  658. topicHash := fmt.Sprintf("%x", sha256.Sum256([]byte(topicURL)))
  659. forwardURL := fmt.Sprintf("%s/%s", s.config.UpstreamBaseURL, topicHash)
  660. logvm(v, m).Debug("Publishing poll request to %s", forwardURL)
  661. req, err := http.NewRequest("POST", forwardURL, strings.NewReader(""))
  662. if err != nil {
  663. logvm(v, m).Err(err).Warn("Unable to publish poll request")
  664. return
  665. }
  666. req.Header.Set("X-Poll-ID", m.ID)
  667. var httpClient = &http.Client{
  668. Timeout: time.Second * 10,
  669. }
  670. response, err := httpClient.Do(req)
  671. if err != nil {
  672. logvm(v, m).Err(err).Warn("Unable to publish poll request")
  673. return
  674. } else if response.StatusCode != http.StatusOK {
  675. logvm(v, m).Err(err).Warn("Unable to publish poll request, unexpected HTTP status: %d", response.StatusCode)
  676. return
  677. }
  678. }
  679. func (s *Server) parsePublishParams(r *http.Request, v *visitor, m *message) (cache bool, firebase bool, email string, unifiedpush bool, err error) {
  680. cache = readBoolParam(r, true, "x-cache", "cache")
  681. firebase = readBoolParam(r, true, "x-firebase", "firebase")
  682. m.Title = readParam(r, "x-title", "title", "t")
  683. m.Click = readParam(r, "x-click", "click")
  684. icon := readParam(r, "x-icon", "icon")
  685. filename := readParam(r, "x-filename", "filename", "file", "f")
  686. attach := readParam(r, "x-attach", "attach", "a")
  687. if attach != "" || filename != "" {
  688. m.Attachment = &attachment{}
  689. }
  690. if filename != "" {
  691. m.Attachment.Name = filename
  692. }
  693. if attach != "" {
  694. if !urlRegex.MatchString(attach) {
  695. return false, false, "", false, errHTTPBadRequestAttachmentURLInvalid
  696. }
  697. m.Attachment.URL = attach
  698. if m.Attachment.Name == "" {
  699. u, err := url.Parse(m.Attachment.URL)
  700. if err == nil {
  701. m.Attachment.Name = path.Base(u.Path)
  702. if m.Attachment.Name == "." || m.Attachment.Name == "/" {
  703. m.Attachment.Name = ""
  704. }
  705. }
  706. }
  707. if m.Attachment.Name == "" {
  708. m.Attachment.Name = "attachment"
  709. }
  710. }
  711. if icon != "" {
  712. if !urlRegex.MatchString(icon) {
  713. return false, false, "", false, errHTTPBadRequestIconURLInvalid
  714. }
  715. m.Icon = icon
  716. }
  717. email = readParam(r, "x-email", "x-e-mail", "email", "e-mail", "mail", "e")
  718. if email != "" {
  719. if !v.EmailAllowed() {
  720. return false, false, "", false, errHTTPTooManyRequestsLimitEmails
  721. }
  722. }
  723. if s.smtpSender == nil && email != "" {
  724. return false, false, "", false, errHTTPBadRequestEmailDisabled
  725. }
  726. messageStr := strings.ReplaceAll(readParam(r, "x-message", "message", "m"), "\\n", "\n")
  727. if messageStr != "" {
  728. m.Message = messageStr
  729. }
  730. m.Priority, err = util.ParsePriority(readParam(r, "x-priority", "priority", "prio", "p"))
  731. if err != nil {
  732. return false, false, "", false, errHTTPBadRequestPriorityInvalid
  733. }
  734. tagsStr := readParam(r, "x-tags", "tags", "tag", "ta")
  735. if tagsStr != "" {
  736. m.Tags = make([]string, 0)
  737. for _, s := range util.SplitNoEmpty(tagsStr, ",") {
  738. m.Tags = append(m.Tags, strings.TrimSpace(s))
  739. }
  740. }
  741. delayStr := readParam(r, "x-delay", "delay", "x-at", "at", "x-in", "in")
  742. if delayStr != "" {
  743. if !cache {
  744. return false, false, "", false, errHTTPBadRequestDelayNoCache
  745. }
  746. if email != "" {
  747. return false, false, "", false, errHTTPBadRequestDelayNoEmail // we cannot store the email address (yet)
  748. }
  749. delay, err := util.ParseFutureTime(delayStr, time.Now())
  750. if err != nil {
  751. return false, false, "", false, errHTTPBadRequestDelayCannotParse
  752. } else if delay.Unix() < time.Now().Add(s.config.MinDelay).Unix() {
  753. return false, false, "", false, errHTTPBadRequestDelayTooSmall
  754. } else if delay.Unix() > time.Now().Add(s.config.MaxDelay).Unix() {
  755. return false, false, "", false, errHTTPBadRequestDelayTooLarge
  756. }
  757. m.Time = delay.Unix()
  758. }
  759. actionsStr := readParam(r, "x-actions", "actions", "action")
  760. if actionsStr != "" {
  761. m.Actions, err = parseActions(actionsStr)
  762. if err != nil {
  763. return false, false, "", false, wrapErrHTTP(errHTTPBadRequestActionsInvalid, err.Error())
  764. }
  765. }
  766. unifiedpush = readBoolParam(r, false, "x-unifiedpush", "unifiedpush", "up") // see GET too!
  767. if unifiedpush {
  768. firebase = false
  769. unifiedpush = true
  770. }
  771. m.PollID = readParam(r, "x-poll-id", "poll-id")
  772. if m.PollID != "" {
  773. unifiedpush = false
  774. cache = false
  775. email = ""
  776. }
  777. return cache, firebase, email, unifiedpush, nil
  778. }
  779. // handlePublishBody consumes the PUT/POST body and decides whether the body is an attachment or the message.
  780. //
  781. // 1. curl -X POST -H "Poll: 1234" ntfy.sh/...
  782. // If a message is flagged as poll request, the body does not matter and is discarded
  783. // 2. curl -T somebinarydata.bin "ntfy.sh/mytopic?up=1"
  784. // If body is binary, encode as base64, if not do not encode
  785. // 3. curl -H "Attach: http://example.com/file.jpg" ntfy.sh/mytopic
  786. // Body must be a message, because we attached an external URL
  787. // 4. curl -T short.txt -H "Filename: short.txt" ntfy.sh/mytopic
  788. // Body must be attachment, because we passed a filename
  789. // 5. curl -T file.txt ntfy.sh/mytopic
  790. // If file.txt is <= 4096 (message limit) and valid UTF-8, treat it as a message
  791. // 6. curl -T file.txt ntfy.sh/mytopic
  792. // If file.txt is > message limit, treat it as an attachment
  793. func (s *Server) handlePublishBody(r *http.Request, v *visitor, m *message, body *util.PeekedReadCloser, unifiedpush bool) error {
  794. if m.Event == pollRequestEvent { // Case 1
  795. return s.handleBodyDiscard(body)
  796. } else if unifiedpush {
  797. return s.handleBodyAsMessageAutoDetect(m, body) // Case 2
  798. } else if m.Attachment != nil && m.Attachment.URL != "" {
  799. return s.handleBodyAsTextMessage(m, body) // Case 3
  800. } else if m.Attachment != nil && m.Attachment.Name != "" {
  801. return s.handleBodyAsAttachment(r, v, m, body) // Case 4
  802. } else if !body.LimitReached && utf8.Valid(body.PeekedBytes) {
  803. return s.handleBodyAsTextMessage(m, body) // Case 5
  804. }
  805. return s.handleBodyAsAttachment(r, v, m, body) // Case 6
  806. }
  807. func (s *Server) handleBodyDiscard(body *util.PeekedReadCloser) error {
  808. _, err := io.Copy(io.Discard, body)
  809. _ = body.Close()
  810. return err
  811. }
  812. func (s *Server) handleBodyAsMessageAutoDetect(m *message, body *util.PeekedReadCloser) error {
  813. if utf8.Valid(body.PeekedBytes) {
  814. m.Message = string(body.PeekedBytes) // Do not trim
  815. } else {
  816. m.Message = base64.StdEncoding.EncodeToString(body.PeekedBytes)
  817. m.Encoding = encodingBase64
  818. }
  819. return nil
  820. }
  821. func (s *Server) handleBodyAsTextMessage(m *message, body *util.PeekedReadCloser) error {
  822. if !utf8.Valid(body.PeekedBytes) {
  823. return errHTTPBadRequestMessageNotUTF8
  824. }
  825. if len(body.PeekedBytes) > 0 { // Empty body should not override message (publish via GET!)
  826. m.Message = strings.TrimSpace(string(body.PeekedBytes)) // Truncates the message to the peek limit if required
  827. }
  828. if m.Attachment != nil && m.Attachment.Name != "" && m.Message == "" {
  829. m.Message = fmt.Sprintf(defaultAttachmentMessage, m.Attachment.Name)
  830. }
  831. return nil
  832. }
  833. func (s *Server) handleBodyAsAttachment(r *http.Request, v *visitor, m *message, body *util.PeekedReadCloser) error {
  834. if s.fileCache == nil || s.config.BaseURL == "" || s.config.AttachmentCacheDir == "" {
  835. return errHTTPBadRequestAttachmentsDisallowed
  836. }
  837. vinfo, err := v.Info()
  838. if err != nil {
  839. return err
  840. }
  841. attachmentExpiry := time.Now().Add(vinfo.Limits.AttachmentExpiryDuration).Unix()
  842. if m.Time > attachmentExpiry {
  843. return errHTTPBadRequestAttachmentsExpiryBeforeDelivery
  844. }
  845. contentLengthStr := r.Header.Get("Content-Length")
  846. if contentLengthStr != "" { // Early "do-not-trust" check, hard limit see below
  847. contentLength, err := strconv.ParseInt(contentLengthStr, 10, 64)
  848. if err == nil && (contentLength > vinfo.Stats.AttachmentTotalSizeRemaining || contentLength > vinfo.Limits.AttachmentFileSizeLimit) {
  849. return errHTTPEntityTooLargeAttachment
  850. }
  851. }
  852. if m.Attachment == nil {
  853. m.Attachment = &attachment{}
  854. }
  855. var ext string
  856. m.Attachment.Expires = attachmentExpiry
  857. m.Attachment.Type, ext = util.DetectContentType(body.PeekedBytes, m.Attachment.Name)
  858. m.Attachment.URL = fmt.Sprintf("%s/file/%s%s", s.config.BaseURL, m.ID, ext)
  859. if m.Attachment.Name == "" {
  860. m.Attachment.Name = fmt.Sprintf("attachment%s", ext)
  861. }
  862. if m.Message == "" {
  863. m.Message = fmt.Sprintf(defaultAttachmentMessage, m.Attachment.Name)
  864. }
  865. limiters := []util.Limiter{
  866. v.BandwidthLimiter(),
  867. util.NewFixedLimiter(vinfo.Limits.AttachmentFileSizeLimit),
  868. util.NewFixedLimiter(vinfo.Stats.AttachmentTotalSizeRemaining),
  869. }
  870. m.Attachment.Size, err = s.fileCache.Write(m.ID, body, limiters...)
  871. if err == util.ErrLimitReached {
  872. return errHTTPEntityTooLargeAttachment
  873. } else if err != nil {
  874. return err
  875. }
  876. return nil
  877. }
  878. func (s *Server) handleSubscribeJSON(w http.ResponseWriter, r *http.Request, v *visitor) error {
  879. encoder := func(msg *message) (string, error) {
  880. var buf bytes.Buffer
  881. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  882. return "", err
  883. }
  884. return buf.String(), nil
  885. }
  886. return s.handleSubscribeHTTP(w, r, v, "application/x-ndjson", encoder)
  887. }
  888. func (s *Server) handleSubscribeSSE(w http.ResponseWriter, r *http.Request, v *visitor) error {
  889. encoder := func(msg *message) (string, error) {
  890. var buf bytes.Buffer
  891. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  892. return "", err
  893. }
  894. if msg.Event != messageEvent {
  895. return fmt.Sprintf("event: %s\ndata: %s\n", msg.Event, buf.String()), nil // Browser's .onmessage() does not fire on this!
  896. }
  897. return fmt.Sprintf("data: %s\n", buf.String()), nil
  898. }
  899. return s.handleSubscribeHTTP(w, r, v, "text/event-stream", encoder)
  900. }
  901. func (s *Server) handleSubscribeRaw(w http.ResponseWriter, r *http.Request, v *visitor) error {
  902. encoder := func(msg *message) (string, error) {
  903. if msg.Event == messageEvent { // only handle default events
  904. return strings.ReplaceAll(msg.Message, "\n", " ") + "\n", nil
  905. }
  906. return "\n", nil // "keepalive" and "open" events just send an empty line
  907. }
  908. return s.handleSubscribeHTTP(w, r, v, "text/plain", encoder)
  909. }
  910. func (s *Server) handleSubscribeHTTP(w http.ResponseWriter, r *http.Request, v *visitor, contentType string, encoder messageEncoder) error {
  911. logvr(v, r).Debug("HTTP stream connection opened")
  912. defer logvr(v, r).Debug("HTTP stream connection closed")
  913. if !v.SubscriptionAllowed() {
  914. return errHTTPTooManyRequestsLimitSubscriptions
  915. }
  916. defer v.RemoveSubscription()
  917. topics, topicsStr, err := s.topicsFromPath(r.URL.Path)
  918. if err != nil {
  919. return err
  920. }
  921. poll, since, scheduled, filters, err := parseSubscribeParams(r)
  922. if err != nil {
  923. return err
  924. }
  925. var wlock sync.Mutex
  926. defer func() {
  927. // Hack: This is the fix for a horrible data race that I have not been able to figure out in quite some time.
  928. // It appears to be happening when the Go HTTP code reads from the socket when closing the request (i.e. AFTER
  929. // this function returns), and causes a data race with the ResponseWriter. Locking wlock here silences the
  930. // data race detector. See https://github.com/binwiederhier/ntfy/issues/338#issuecomment-1163425889.
  931. wlock.TryLock()
  932. }()
  933. sub := func(v *visitor, msg *message) error {
  934. if !filters.Pass(msg) {
  935. return nil
  936. }
  937. m, err := encoder(msg)
  938. if err != nil {
  939. return err
  940. }
  941. wlock.Lock()
  942. defer wlock.Unlock()
  943. if _, err := w.Write([]byte(m)); err != nil {
  944. return err
  945. }
  946. if fl, ok := w.(http.Flusher); ok {
  947. fl.Flush()
  948. }
  949. return nil
  950. }
  951. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  952. w.Header().Set("Content-Type", contentType+"; charset=utf-8") // Android/Volley client needs charset!
  953. if poll {
  954. return s.sendOldMessages(topics, since, scheduled, v, sub)
  955. }
  956. ctx, cancel := context.WithCancel(context.Background())
  957. defer cancel()
  958. subscriberIDs := make([]int, 0)
  959. for _, t := range topics {
  960. subscriberIDs = append(subscriberIDs, t.Subscribe(sub, v.MaybeUserID(), cancel))
  961. }
  962. defer func() {
  963. for i, subscriberID := range subscriberIDs {
  964. topics[i].Unsubscribe(subscriberID) // Order!
  965. }
  966. }()
  967. if err := sub(v, newOpenMessage(topicsStr)); err != nil { // Send out open message
  968. return err
  969. }
  970. if err := s.sendOldMessages(topics, since, scheduled, v, sub); err != nil {
  971. return err
  972. }
  973. for {
  974. select {
  975. case <-ctx.Done():
  976. return nil
  977. case <-r.Context().Done():
  978. return nil
  979. case <-time.After(s.config.KeepaliveInterval):
  980. logvr(v, r).Trace("Sending keepalive message")
  981. v.Keepalive()
  982. if err := sub(v, newKeepaliveMessage(topicsStr)); err != nil { // Send keepalive message
  983. return err
  984. }
  985. }
  986. }
  987. }
  988. func (s *Server) handleSubscribeWS(w http.ResponseWriter, r *http.Request, v *visitor) error {
  989. if strings.ToLower(r.Header.Get("Upgrade")) != "websocket" {
  990. return errHTTPBadRequestWebSocketsUpgradeHeaderMissing
  991. }
  992. if !v.SubscriptionAllowed() {
  993. return errHTTPTooManyRequestsLimitSubscriptions
  994. }
  995. defer v.RemoveSubscription()
  996. logvr(v, r).Tag(tagWebsocket).Debug("WebSocket connection opened")
  997. defer logvr(v, r).Tag(tagWebsocket).Debug("WebSocket connection closed")
  998. topics, topicsStr, err := s.topicsFromPath(r.URL.Path)
  999. if err != nil {
  1000. return err
  1001. }
  1002. poll, since, scheduled, filters, err := parseSubscribeParams(r)
  1003. if err != nil {
  1004. return err
  1005. }
  1006. upgrader := &websocket.Upgrader{
  1007. ReadBufferSize: wsBufferSize,
  1008. WriteBufferSize: wsBufferSize,
  1009. CheckOrigin: func(r *http.Request) bool {
  1010. return true // We're open for business!
  1011. },
  1012. }
  1013. conn, err := upgrader.Upgrade(w, r, nil)
  1014. if err != nil {
  1015. return err
  1016. }
  1017. defer conn.Close()
  1018. // Subscription connections can be canceled externally, see topic.CancelSubscribers
  1019. cancelCtx, cancel := context.WithCancel(context.Background())
  1020. defer cancel()
  1021. // Use errgroup to run WebSocket reader and writer in Go routines
  1022. var wlock sync.Mutex
  1023. g, gctx := errgroup.WithContext(cancelCtx)
  1024. g.Go(func() error {
  1025. pongWait := s.config.KeepaliveInterval + wsPongWait
  1026. conn.SetReadLimit(wsReadLimit)
  1027. if err := conn.SetReadDeadline(time.Now().Add(pongWait)); err != nil {
  1028. return err
  1029. }
  1030. conn.SetPongHandler(func(appData string) error {
  1031. logvr(v, r).Tag(tagWebsocket).Trace("Received WebSocket pong")
  1032. return conn.SetReadDeadline(time.Now().Add(pongWait))
  1033. })
  1034. for {
  1035. _, _, err := conn.NextReader()
  1036. if err != nil {
  1037. return err
  1038. }
  1039. select {
  1040. case <-gctx.Done():
  1041. return nil
  1042. default:
  1043. }
  1044. }
  1045. })
  1046. g.Go(func() error {
  1047. ping := func() error {
  1048. wlock.Lock()
  1049. defer wlock.Unlock()
  1050. if err := conn.SetWriteDeadline(time.Now().Add(wsWriteWait)); err != nil {
  1051. return err
  1052. }
  1053. logvr(v, r).Tag(tagWebsocket).Trace("Sending WebSocket ping")
  1054. return conn.WriteMessage(websocket.PingMessage, nil)
  1055. }
  1056. for {
  1057. select {
  1058. case <-gctx.Done():
  1059. return nil
  1060. case <-cancelCtx.Done():
  1061. logvr(v, r).Tag(tagWebsocket).Trace("Cancel received, closing subscriber connection")
  1062. conn.Close()
  1063. return &websocket.CloseError{Code: websocket.CloseNormalClosure, Text: "subscription was canceled"}
  1064. case <-time.After(s.config.KeepaliveInterval):
  1065. v.Keepalive()
  1066. if err := ping(); err != nil {
  1067. return err
  1068. }
  1069. }
  1070. }
  1071. })
  1072. sub := func(v *visitor, msg *message) error {
  1073. if !filters.Pass(msg) {
  1074. return nil
  1075. }
  1076. wlock.Lock()
  1077. defer wlock.Unlock()
  1078. if err := conn.SetWriteDeadline(time.Now().Add(wsWriteWait)); err != nil {
  1079. return err
  1080. }
  1081. return conn.WriteJSON(msg)
  1082. }
  1083. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  1084. if poll {
  1085. return s.sendOldMessages(topics, since, scheduled, v, sub)
  1086. }
  1087. subscriberIDs := make([]int, 0)
  1088. for _, t := range topics {
  1089. subscriberIDs = append(subscriberIDs, t.Subscribe(sub, v.MaybeUserID(), cancel))
  1090. }
  1091. defer func() {
  1092. for i, subscriberID := range subscriberIDs {
  1093. topics[i].Unsubscribe(subscriberID) // Order!
  1094. }
  1095. }()
  1096. if err := sub(v, newOpenMessage(topicsStr)); err != nil { // Send out open message
  1097. return err
  1098. }
  1099. if err := s.sendOldMessages(topics, since, scheduled, v, sub); err != nil {
  1100. return err
  1101. }
  1102. err = g.Wait()
  1103. if err != nil && websocket.IsCloseError(err, websocket.CloseNormalClosure, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
  1104. logvr(v, r).Tag(tagWebsocket).Err(err).Fields(websocketErrorContext(err)).Trace("WebSocket connection closed")
  1105. return nil // Normal closures are not errors; note: "1006 (abnormal closure)" is treated as normal, because people disconnect a lot
  1106. }
  1107. return err
  1108. }
  1109. func parseSubscribeParams(r *http.Request) (poll bool, since sinceMarker, scheduled bool, filters *queryFilter, err error) {
  1110. poll = readBoolParam(r, false, "x-poll", "poll", "po")
  1111. scheduled = readBoolParam(r, false, "x-scheduled", "scheduled", "sched")
  1112. since, err = parseSince(r, poll)
  1113. if err != nil {
  1114. return
  1115. }
  1116. filters, err = parseQueryFilters(r)
  1117. if err != nil {
  1118. return
  1119. }
  1120. return
  1121. }
  1122. // sendOldMessages selects old messages from the messageCache and calls sub for each of them. It uses since as the
  1123. // marker, returning only messages that are newer than the marker.
  1124. func (s *Server) sendOldMessages(topics []*topic, since sinceMarker, scheduled bool, v *visitor, sub subscriber) error {
  1125. if since.IsNone() {
  1126. return nil
  1127. }
  1128. messages := make([]*message, 0)
  1129. for _, t := range topics {
  1130. topicMessages, err := s.messageCache.Messages(t.ID, since, scheduled)
  1131. if err != nil {
  1132. return err
  1133. }
  1134. messages = append(messages, topicMessages...)
  1135. }
  1136. sort.Slice(messages, func(i, j int) bool {
  1137. return messages[i].Time < messages[j].Time
  1138. })
  1139. for _, m := range messages {
  1140. if err := sub(v, m); err != nil {
  1141. return err
  1142. }
  1143. }
  1144. return nil
  1145. }
  1146. // parseSince returns a timestamp identifying the time span from which cached messages should be received.
  1147. //
  1148. // Values in the "since=..." parameter can be either a unix timestamp or a duration (e.g. 12h), or
  1149. // "all" for all messages.
  1150. func parseSince(r *http.Request, poll bool) (sinceMarker, error) {
  1151. since := readParam(r, "x-since", "since", "si")
  1152. // Easy cases (empty, all, none)
  1153. if since == "" {
  1154. if poll {
  1155. return sinceAllMessages, nil
  1156. }
  1157. return sinceNoMessages, nil
  1158. } else if since == "all" {
  1159. return sinceAllMessages, nil
  1160. } else if since == "none" {
  1161. return sinceNoMessages, nil
  1162. }
  1163. // ID, timestamp, duration
  1164. if validMessageID(since) {
  1165. return newSinceID(since), nil
  1166. } else if s, err := strconv.ParseInt(since, 10, 64); err == nil {
  1167. return newSinceTime(s), nil
  1168. } else if d, err := time.ParseDuration(since); err == nil {
  1169. return newSinceTime(time.Now().Add(-1 * d).Unix()), nil
  1170. }
  1171. return sinceNoMessages, errHTTPBadRequestSinceInvalid
  1172. }
  1173. func (s *Server) handleOptions(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  1174. w.Header().Set("Access-Control-Allow-Methods", "GET, PUT, POST, PATCH, DELETE")
  1175. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  1176. w.Header().Set("Access-Control-Allow-Headers", "*") // CORS, allow auth via JS // FIXME is this terrible?
  1177. return nil
  1178. }
  1179. func (s *Server) topicFromPath(path string) (*topic, error) {
  1180. parts := strings.Split(path, "/")
  1181. if len(parts) < 2 {
  1182. return nil, errHTTPBadRequestTopicInvalid
  1183. }
  1184. return s.topicFromID(parts[1])
  1185. }
  1186. func (s *Server) topicsFromPath(path string) ([]*topic, string, error) {
  1187. parts := strings.Split(path, "/")
  1188. if len(parts) < 2 {
  1189. return nil, "", errHTTPBadRequestTopicInvalid
  1190. }
  1191. topicIDs := util.SplitNoEmpty(parts[1], ",")
  1192. topics, err := s.topicsFromIDs(topicIDs...)
  1193. if err != nil {
  1194. return nil, "", errHTTPBadRequestTopicInvalid
  1195. }
  1196. return topics, parts[1], nil
  1197. }
  1198. func (s *Server) topicsFromIDs(ids ...string) ([]*topic, error) {
  1199. s.mu.Lock()
  1200. defer s.mu.Unlock()
  1201. topics := make([]*topic, 0)
  1202. for _, id := range ids {
  1203. if util.Contains(disallowedTopics, id) {
  1204. return nil, errHTTPBadRequestTopicDisallowed
  1205. }
  1206. if _, ok := s.topics[id]; !ok {
  1207. if len(s.topics) >= s.config.TotalTopicLimit {
  1208. return nil, errHTTPTooManyRequestsLimitTotalTopics
  1209. }
  1210. s.topics[id] = newTopic(id)
  1211. }
  1212. topics = append(topics, s.topics[id])
  1213. }
  1214. return topics, nil
  1215. }
  1216. func (s *Server) topicFromID(id string) (*topic, error) {
  1217. topics, err := s.topicsFromIDs(id)
  1218. if err != nil {
  1219. return nil, err
  1220. }
  1221. return topics[0], nil
  1222. }
  1223. func (s *Server) execManager() {
  1224. log.Tag(tagManager).Debug("Starting manager")
  1225. defer log.Tag(tagManager).Debug("Finished manager")
  1226. // WARNING: Make sure to only selectively lock with the mutex, and be aware that this
  1227. // there is no mutex for the entire function.
  1228. // Expire visitors from rate visitors map
  1229. s.mu.Lock()
  1230. staleVisitors := 0
  1231. for ip, v := range s.visitors {
  1232. if v.Stale() {
  1233. log.Tag(tagManager).With(v).Trace("Deleting stale visitor")
  1234. delete(s.visitors, ip)
  1235. staleVisitors++
  1236. }
  1237. }
  1238. s.mu.Unlock()
  1239. log.Tag(tagManager).Field("stale_visitors", staleVisitors).Debug("Deleted %d stale visitor(s)", staleVisitors)
  1240. // Delete expired user tokens and users
  1241. if s.userManager != nil {
  1242. if err := s.userManager.RemoveExpiredTokens(); err != nil {
  1243. log.Tag(tagManager).Err(err).Warn("Error expiring user tokens")
  1244. }
  1245. if err := s.userManager.RemoveDeletedUsers(); err != nil {
  1246. log.Tag(tagManager).Err(err).Warn("Error deleting soft-deleted users")
  1247. }
  1248. }
  1249. // Delete expired attachments
  1250. if s.fileCache != nil {
  1251. ids, err := s.messageCache.AttachmentsExpired()
  1252. if err != nil {
  1253. log.Tag(tagManager).Err(err).Warn("Error retrieving expired attachments")
  1254. } else if len(ids) > 0 {
  1255. if log.Tag(tagManager).IsDebug() {
  1256. log.Tag(tagManager).Debug("Deleting attachments %s", strings.Join(ids, ", "))
  1257. }
  1258. if err := s.fileCache.Remove(ids...); err != nil {
  1259. log.Tag(tagManager).Err(err).Warn("Error deleting attachments")
  1260. }
  1261. if err := s.messageCache.MarkAttachmentsDeleted(ids...); err != nil {
  1262. log.Tag(tagManager).Err(err).Warn("Error marking attachments deleted")
  1263. }
  1264. } else {
  1265. log.Tag(tagManager).Debug("No expired attachments to delete")
  1266. }
  1267. }
  1268. // Prune messages
  1269. log.Tag(tagManager).Debug("Manager: Pruning messages")
  1270. expiredMessageIDs, err := s.messageCache.MessagesExpired()
  1271. if err != nil {
  1272. log.Tag(tagManager).Err(err).Warn("Error retrieving expired messages")
  1273. } else if len(expiredMessageIDs) > 0 {
  1274. if err := s.fileCache.Remove(expiredMessageIDs...); err != nil {
  1275. log.Tag(tagManager).Err(err).Warn("Error deleting attachments for expired messages")
  1276. }
  1277. if err := s.messageCache.DeleteMessages(expiredMessageIDs...); err != nil {
  1278. log.Tag(tagManager).Err(err).Warn("Error marking attachments deleted")
  1279. }
  1280. } else {
  1281. log.Tag(tagManager).Debug("No expired messages to delete")
  1282. }
  1283. // Message count per topic
  1284. var messagesCached int
  1285. messageCounts, err := s.messageCache.MessageCounts()
  1286. if err != nil {
  1287. log.Tag(tagManager).Err(err).Warn("Cannot get message counts")
  1288. messageCounts = make(map[string]int) // Empty, so we can continue
  1289. }
  1290. for _, count := range messageCounts {
  1291. messagesCached += count
  1292. }
  1293. // Remove subscriptions without subscribers
  1294. s.mu.Lock()
  1295. var subscribers int
  1296. for _, t := range s.topics {
  1297. subs := t.SubscribersCount()
  1298. log.Tag(tagManager).Trace("- topic %s: %d subscribers", t.ID, subs)
  1299. msgs, exists := messageCounts[t.ID]
  1300. if subs == 0 && (!exists || msgs == 0) {
  1301. log.Tag(tagManager).Trace("Deleting empty topic %s", t.ID)
  1302. delete(s.topics, t.ID)
  1303. continue
  1304. }
  1305. subscribers += subs
  1306. }
  1307. s.mu.Unlock()
  1308. // Mail stats
  1309. var receivedMailTotal, receivedMailSuccess, receivedMailFailure int64
  1310. if s.smtpServerBackend != nil {
  1311. receivedMailTotal, receivedMailSuccess, receivedMailFailure = s.smtpServerBackend.Counts()
  1312. }
  1313. var sentMailTotal, sentMailSuccess, sentMailFailure int64
  1314. if s.smtpSender != nil {
  1315. sentMailTotal, sentMailSuccess, sentMailFailure = s.smtpSender.Counts()
  1316. }
  1317. // Print stats
  1318. s.mu.Lock()
  1319. messagesCount, topicsCount, visitorsCount := s.messages, len(s.topics), len(s.visitors)
  1320. s.mu.Unlock()
  1321. log.
  1322. Tag(tagManager).
  1323. Fields(log.Context{
  1324. "messages_published": messagesCount,
  1325. "messages_cached": messagesCached,
  1326. "topics_active": topicsCount,
  1327. "subscribers": subscribers,
  1328. "visitors": visitorsCount,
  1329. "emails_received": receivedMailTotal,
  1330. "emails_received_success": receivedMailSuccess,
  1331. "emails_received_failure": receivedMailFailure,
  1332. "emails_sent": sentMailTotal,
  1333. "emails_sent_success": sentMailSuccess,
  1334. "emails_sent_failure": sentMailFailure,
  1335. }).
  1336. Info("Server stats")
  1337. }
  1338. func (s *Server) runSMTPServer() error {
  1339. s.smtpServerBackend = newMailBackend(s.config, s.handle)
  1340. s.smtpServer = smtp.NewServer(s.smtpServerBackend)
  1341. s.smtpServer.Addr = s.config.SMTPServerListen
  1342. s.smtpServer.Domain = s.config.SMTPServerDomain
  1343. s.smtpServer.ReadTimeout = 10 * time.Second
  1344. s.smtpServer.WriteTimeout = 10 * time.Second
  1345. s.smtpServer.MaxMessageBytes = 1024 * 1024 // Must be much larger than message size (headers, multipart, etc.)
  1346. s.smtpServer.MaxRecipients = 1
  1347. s.smtpServer.AllowInsecureAuth = true
  1348. return s.smtpServer.ListenAndServe()
  1349. }
  1350. func (s *Server) runManager() {
  1351. for {
  1352. select {
  1353. case <-time.After(s.config.ManagerInterval):
  1354. s.execManager()
  1355. case <-s.closeChan:
  1356. return
  1357. }
  1358. }
  1359. }
  1360. // runStatsResetter runs once a day (usually midnight UTC) to reset all the visitor's message and
  1361. // email counters. The stats are used to display the counters in the web app, as well as for rate limiting.
  1362. func (s *Server) runStatsResetter() {
  1363. for {
  1364. runAt := util.NextOccurrenceUTC(s.config.VisitorStatsResetTime, time.Now())
  1365. timer := time.NewTimer(time.Until(runAt))
  1366. log.Tag(tagResetter).Debug("Waiting until %v to reset visitor stats", runAt)
  1367. select {
  1368. case <-timer.C:
  1369. log.Tag(tagResetter).Debug("Running stats resetter")
  1370. s.resetStats()
  1371. case <-s.closeChan:
  1372. log.Tag(tagResetter).Debug("Stopping stats resetter")
  1373. timer.Stop()
  1374. return
  1375. }
  1376. }
  1377. }
  1378. func (s *Server) resetStats() {
  1379. log.Info("Resetting all visitor stats (daily task)")
  1380. s.mu.Lock()
  1381. defer s.mu.Unlock() // Includes the database query to avoid races with other processes
  1382. for _, v := range s.visitors {
  1383. v.ResetStats()
  1384. }
  1385. if s.userManager != nil {
  1386. if err := s.userManager.ResetStats(); err != nil {
  1387. log.Tag(tagResetter).Warn("Failed to write to database: %s", err.Error())
  1388. }
  1389. }
  1390. }
  1391. func (s *Server) runFirebaseKeepaliver() {
  1392. if s.firebaseClient == nil {
  1393. return
  1394. }
  1395. v := newVisitor(s.config, s.messageCache, s.userManager, netip.IPv4Unspecified(), nil) // Background process, not a real visitor, uses IP 0.0.0.0
  1396. for {
  1397. select {
  1398. case <-time.After(s.config.FirebaseKeepaliveInterval):
  1399. s.sendToFirebase(v, newKeepaliveMessage(firebaseControlTopic))
  1400. case <-time.After(s.config.FirebasePollInterval):
  1401. s.sendToFirebase(v, newKeepaliveMessage(firebasePollTopic))
  1402. case <-s.closeChan:
  1403. return
  1404. }
  1405. }
  1406. }
  1407. func (s *Server) runDelayedSender() {
  1408. for {
  1409. select {
  1410. case <-time.After(s.config.DelayedSenderInterval):
  1411. if err := s.sendDelayedMessages(); err != nil {
  1412. log.Tag(tagPublish).Err(err).Warn("Error sending delayed messages")
  1413. }
  1414. case <-s.closeChan:
  1415. return
  1416. }
  1417. }
  1418. }
  1419. func (s *Server) sendDelayedMessages() error {
  1420. messages, err := s.messageCache.MessagesDue()
  1421. if err != nil {
  1422. return err
  1423. }
  1424. for _, m := range messages {
  1425. var u *user.User
  1426. if s.userManager != nil && m.User != "" {
  1427. u, err = s.userManager.User(m.User)
  1428. if err != nil {
  1429. log.With(m).Err(err).Warn("Error sending delayed message")
  1430. continue
  1431. }
  1432. }
  1433. v := s.visitor(m.Sender, u)
  1434. if err := s.sendDelayedMessage(v, m); err != nil {
  1435. logvm(v, m).Err(err).Warn("Error sending delayed message")
  1436. }
  1437. }
  1438. return nil
  1439. }
  1440. func (s *Server) sendDelayedMessage(v *visitor, m *message) error {
  1441. logvm(v, m).Debug("Sending delayed message")
  1442. s.mu.Lock()
  1443. t, ok := s.topics[m.Topic] // If no subscribers, just mark message as published
  1444. s.mu.Unlock()
  1445. if ok {
  1446. go func() {
  1447. // We do not rate-limit messages here, since we've rate limited them in the PUT/POST handler
  1448. if err := t.Publish(v, m); err != nil {
  1449. logvm(v, m).Err(err).Warn("Unable to publish message")
  1450. }
  1451. }()
  1452. }
  1453. if s.firebaseClient != nil { // Firebase subscribers may not show up in topics map
  1454. go s.sendToFirebase(v, m)
  1455. }
  1456. if s.config.UpstreamBaseURL != "" {
  1457. go s.forwardPollRequest(v, m)
  1458. }
  1459. if err := s.messageCache.MarkPublished(m); err != nil {
  1460. return err
  1461. }
  1462. return nil
  1463. }
  1464. func (s *Server) limitRequests(next handleFunc) handleFunc {
  1465. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1466. if util.ContainsIP(s.config.VisitorRequestExemptIPAddrs, v.ip) {
  1467. return next(w, r, v)
  1468. } else if err := v.RequestAllowed(); err != nil {
  1469. logvr(v, r).Err(err).Trace("Request not allowed by rate limiter")
  1470. return errHTTPTooManyRequestsLimitRequests
  1471. }
  1472. return next(w, r, v)
  1473. }
  1474. }
  1475. // transformBodyJSON peeks the request body, reads the JSON, and converts it to headers
  1476. // before passing it on to the next handler. This is meant to be used in combination with handlePublish.
  1477. func (s *Server) transformBodyJSON(next handleFunc) handleFunc {
  1478. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1479. m, err := readJSONWithLimit[publishMessage](r.Body, s.config.MessageLimit*2, false) // 2x to account for JSON format overhead
  1480. if err != nil {
  1481. return err
  1482. }
  1483. if !topicRegex.MatchString(m.Topic) {
  1484. return errHTTPBadRequestTopicInvalid
  1485. }
  1486. if m.Message == "" {
  1487. m.Message = emptyMessageBody
  1488. }
  1489. r.URL.Path = "/" + m.Topic
  1490. r.Body = io.NopCloser(strings.NewReader(m.Message))
  1491. if m.Title != "" {
  1492. r.Header.Set("X-Title", m.Title)
  1493. }
  1494. if m.Priority != 0 {
  1495. r.Header.Set("X-Priority", fmt.Sprintf("%d", m.Priority))
  1496. }
  1497. if m.Tags != nil && len(m.Tags) > 0 {
  1498. r.Header.Set("X-Tags", strings.Join(m.Tags, ","))
  1499. }
  1500. if m.Attach != "" {
  1501. r.Header.Set("X-Attach", m.Attach)
  1502. }
  1503. if m.Filename != "" {
  1504. r.Header.Set("X-Filename", m.Filename)
  1505. }
  1506. if m.Click != "" {
  1507. r.Header.Set("X-Click", m.Click)
  1508. }
  1509. if m.Icon != "" {
  1510. r.Header.Set("X-Icon", m.Icon)
  1511. }
  1512. if len(m.Actions) > 0 {
  1513. actionsStr, err := json.Marshal(m.Actions)
  1514. if err != nil {
  1515. return errHTTPBadRequestMessageJSONInvalid
  1516. }
  1517. r.Header.Set("X-Actions", string(actionsStr))
  1518. }
  1519. if m.Email != "" {
  1520. r.Header.Set("X-Email", m.Email)
  1521. }
  1522. if m.Delay != "" {
  1523. r.Header.Set("X-Delay", m.Delay)
  1524. }
  1525. return next(w, r, v)
  1526. }
  1527. }
  1528. func (s *Server) transformMatrixJSON(next handleFunc) handleFunc {
  1529. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1530. newRequest, err := newRequestFromMatrixJSON(r, s.config.BaseURL, s.config.MessageLimit)
  1531. if err != nil {
  1532. logvr(v, r).Tag(tagMatrix).Err(err).Trace("Invalid Matrix request")
  1533. return err
  1534. }
  1535. if err := next(w, newRequest, v); err != nil {
  1536. return &errMatrix{pushKey: newRequest.Header.Get(matrixPushKeyHeader), err: err}
  1537. }
  1538. return nil
  1539. }
  1540. }
  1541. func (s *Server) authorizeTopicWrite(next handleFunc) handleFunc {
  1542. return s.autorizeTopic(next, user.PermissionWrite)
  1543. }
  1544. func (s *Server) authorizeTopicRead(next handleFunc) handleFunc {
  1545. return s.autorizeTopic(next, user.PermissionRead)
  1546. }
  1547. func (s *Server) autorizeTopic(next handleFunc, perm user.Permission) handleFunc {
  1548. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1549. if s.userManager == nil {
  1550. return next(w, r, v)
  1551. }
  1552. topics, _, err := s.topicsFromPath(r.URL.Path)
  1553. if err != nil {
  1554. return err
  1555. }
  1556. u := v.User()
  1557. for _, t := range topics {
  1558. if err := s.userManager.Authorize(u, t.ID, perm); err != nil {
  1559. logvr(v, r).Err(err).Field("message_topic", t.ID).Debug("Access to topic %s not authorized", t.ID)
  1560. return errHTTPForbidden
  1561. }
  1562. }
  1563. return next(w, r, v)
  1564. }
  1565. }
  1566. // maybeAuthenticate creates or retrieves a rate.Limiter for the given visitor.
  1567. // Note that this function will always return a visitor, even if an error occurs.
  1568. func (s *Server) maybeAuthenticate(r *http.Request) (v *visitor, err error) {
  1569. ip := extractIPAddress(r, s.config.BehindProxy)
  1570. var u *user.User // may stay nil if no auth header!
  1571. if u, err = s.authenticate(r); err != nil {
  1572. logr(r).Err(err).Debug("Authentication failed: %s", err.Error())
  1573. err = errHTTPUnauthorized // Always return visitor, even when error occurs!
  1574. }
  1575. v = s.visitor(ip, u)
  1576. v.SetUser(u) // Update visitor user with latest from database!
  1577. return v, err // Always return visitor, even when error occurs!
  1578. }
  1579. // authenticate a user based on basic auth username/password (Authorization: Basic ...), or token auth (Authorization: Bearer ...).
  1580. // The Authorization header can be passed as a header or the ?auth=... query param. The latter is required only to
  1581. // support the WebSocket JavaScript class, which does not support passing headers during the initial request. The auth
  1582. // query param is effectively double base64 encoded. Its format is base64(Basic base64(user:pass)).
  1583. func (s *Server) authenticate(r *http.Request) (user *user.User, err error) {
  1584. value := strings.TrimSpace(r.Header.Get("Authorization"))
  1585. queryParam := readQueryParam(r, "authorization", "auth")
  1586. if queryParam != "" {
  1587. a, err := base64.RawURLEncoding.DecodeString(queryParam)
  1588. if err != nil {
  1589. return nil, err
  1590. }
  1591. value = strings.TrimSpace(string(a))
  1592. }
  1593. if value == "" {
  1594. return nil, nil
  1595. } else if s.userManager == nil {
  1596. return nil, errHTTPUnauthorized
  1597. }
  1598. if strings.HasPrefix(value, "Bearer") {
  1599. return s.authenticateBearerAuth(r, strings.TrimSpace(strings.TrimPrefix(value, "Bearer")))
  1600. }
  1601. return s.authenticateBasicAuth(r, value)
  1602. }
  1603. func (s *Server) authenticateBasicAuth(r *http.Request, value string) (user *user.User, err error) {
  1604. r.Header.Set("Authorization", value)
  1605. username, password, ok := r.BasicAuth()
  1606. if !ok {
  1607. return nil, errors.New("invalid basic auth")
  1608. } else if username == "" {
  1609. return s.authenticateBearerAuth(r, password) // Treat password as token
  1610. }
  1611. return s.userManager.Authenticate(username, password)
  1612. }
  1613. func (s *Server) authenticateBearerAuth(r *http.Request, token string) (*user.User, error) {
  1614. u, err := s.userManager.AuthenticateToken(token)
  1615. if err != nil {
  1616. return nil, err
  1617. }
  1618. ip := extractIPAddress(r, s.config.BehindProxy)
  1619. go s.userManager.EnqueueTokenUpdate(token, &user.TokenUpdate{
  1620. LastAccess: time.Now(),
  1621. LastOrigin: ip,
  1622. })
  1623. return u, nil
  1624. }
  1625. func (s *Server) visitor(ip netip.Addr, user *user.User) *visitor {
  1626. s.mu.Lock()
  1627. defer s.mu.Unlock()
  1628. id := visitorID(ip, user)
  1629. v, exists := s.visitors[id]
  1630. if !exists {
  1631. s.visitors[id] = newVisitor(s.config, s.messageCache, s.userManager, ip, user)
  1632. return s.visitors[id]
  1633. }
  1634. v.Keepalive()
  1635. return v
  1636. }
  1637. func (s *Server) writeJSON(w http.ResponseWriter, v any) error {
  1638. w.Header().Set("Content-Type", "application/json")
  1639. w.Header().Set("Access-Control-Allow-Origin", s.config.AccessControlAllowOrigin) // CORS, allow cross-origin requests
  1640. if err := json.NewEncoder(w).Encode(v); err != nil {
  1641. return err
  1642. }
  1643. return nil
  1644. }