server.go 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453
  1. package server
  2. import (
  3. "bytes"
  4. "context"
  5. "crypto/sha256"
  6. "embed"
  7. "encoding/base64"
  8. "encoding/json"
  9. "fmt"
  10. "io"
  11. "net"
  12. "net/http"
  13. "net/url"
  14. "os"
  15. "path"
  16. "path/filepath"
  17. "regexp"
  18. "sort"
  19. "strconv"
  20. "strings"
  21. "sync"
  22. "time"
  23. "unicode/utf8"
  24. "heckel.io/ntfy/log"
  25. "github.com/emersion/go-smtp"
  26. "github.com/gorilla/websocket"
  27. "golang.org/x/sync/errgroup"
  28. "heckel.io/ntfy/auth"
  29. "heckel.io/ntfy/util"
  30. )
  31. // Server is the main server, providing the UI and API for ntfy
  32. type Server struct {
  33. config *Config
  34. httpServer *http.Server
  35. httpsServer *http.Server
  36. unixListener net.Listener
  37. smtpServer *smtp.Server
  38. smtpServerBackend *smtpBackend
  39. smtpSender mailer
  40. topics map[string]*topic
  41. visitors map[string]*visitor
  42. firebaseClient *firebaseClient
  43. messages int64
  44. auth auth.Auther
  45. messageCache *messageCache
  46. fileCache *fileCache
  47. closeChan chan bool
  48. mu sync.Mutex
  49. }
  50. // handleFunc extends the normal http.HandlerFunc to be able to easily return errors
  51. type handleFunc func(http.ResponseWriter, *http.Request, *visitor) error
  52. var (
  53. // If changed, don't forget to update Android App and auth_sqlite.go
  54. topicRegex = regexp.MustCompile(`^[-_A-Za-z0-9]{1,64}$`) // No /!
  55. topicPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}$`) // Regex must match JS & Android app!
  56. externalTopicPathRegex = regexp.MustCompile(`^/[^/]+\.[^/]+/[-_A-Za-z0-9]{1,64}$`) // Extended topic path, for web-app, e.g. /example.com/mytopic
  57. jsonPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/json$`)
  58. ssePathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/sse$`)
  59. rawPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/raw$`)
  60. wsPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/ws$`)
  61. authPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/auth$`)
  62. publishPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}/(publish|send|trigger)$`)
  63. webConfigPath = "/config.js"
  64. userStatsPath = "/user/stats"
  65. matrixPushPath = "/_matrix/push/v1/notify"
  66. staticRegex = regexp.MustCompile(`^/static/.+`)
  67. docsRegex = regexp.MustCompile(`^/docs(|/.*)$`)
  68. fileRegex = regexp.MustCompile(`^/file/([-_A-Za-z0-9]{1,64})(?:\.[A-Za-z0-9]{1,16})?$`)
  69. disallowedTopics = []string{"docs", "static", "file", "app", "settings"} // If updated, also update in Android app
  70. attachURLRegex = regexp.MustCompile(`^https?://`)
  71. //go:embed site
  72. webFs embed.FS
  73. webFsCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: webFs}
  74. webSiteDir = "/site"
  75. webHomeIndex = "/home.html" // Landing page, only if "web-root: home"
  76. webAppIndex = "/app.html" // React app
  77. //go:embed docs
  78. docsStaticFs embed.FS
  79. docsStaticCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: docsStaticFs}
  80. )
  81. const (
  82. firebaseControlTopic = "~control" // See Android if changed
  83. firebasePollTopic = "~poll" // See iOS if changed
  84. emptyMessageBody = "triggered" // Used if message body is empty
  85. newMessageBody = "New message" // Used in poll requests as generic message
  86. defaultAttachmentMessage = "You received a file: %s" // Used if message body is empty, and there is an attachment
  87. encodingBase64 = "base64"
  88. )
  89. // WebSocket constants
  90. const (
  91. wsWriteWait = 2 * time.Second
  92. wsBufferSize = 1024
  93. wsReadLimit = 64 // We only ever receive PINGs
  94. wsPongWait = 15 * time.Second
  95. )
  96. // New instantiates a new Server. It creates the cache and adds a Firebase
  97. // subscriber (if configured).
  98. func New(conf *Config) (*Server, error) {
  99. var mailer mailer
  100. if conf.SMTPSenderAddr != "" {
  101. mailer = &smtpSender{config: conf}
  102. }
  103. messageCache, err := createMessageCache(conf)
  104. if err != nil {
  105. return nil, err
  106. }
  107. topics, err := messageCache.Topics()
  108. if err != nil {
  109. return nil, err
  110. }
  111. var fileCache *fileCache
  112. if conf.AttachmentCacheDir != "" {
  113. fileCache, err = newFileCache(conf.AttachmentCacheDir, conf.AttachmentTotalSizeLimit, conf.AttachmentFileSizeLimit)
  114. if err != nil {
  115. return nil, err
  116. }
  117. }
  118. var auther auth.Auther
  119. if conf.AuthFile != "" {
  120. auther, err = auth.NewSQLiteAuth(conf.AuthFile, conf.AuthDefaultRead, conf.AuthDefaultWrite)
  121. if err != nil {
  122. return nil, err
  123. }
  124. }
  125. var firebaseClient *firebaseClient
  126. if conf.FirebaseKeyFile != "" {
  127. sender, err := newFirebaseSender(conf.FirebaseKeyFile)
  128. if err != nil {
  129. return nil, err
  130. }
  131. firebaseClient = newFirebaseClient(sender, auther)
  132. }
  133. return &Server{
  134. config: conf,
  135. messageCache: messageCache,
  136. fileCache: fileCache,
  137. firebaseClient: firebaseClient,
  138. smtpSender: mailer,
  139. topics: topics,
  140. auth: auther,
  141. visitors: make(map[string]*visitor),
  142. }, nil
  143. }
  144. func createMessageCache(conf *Config) (*messageCache, error) {
  145. if conf.CacheDuration == 0 {
  146. return newNopCache()
  147. } else if conf.CacheFile != "" {
  148. return newSqliteCache(conf.CacheFile, conf.CacheStartupQueries, false)
  149. }
  150. return newMemCache()
  151. }
  152. // Run executes the main server. It listens on HTTP (+ HTTPS, if configured), and starts
  153. // a manager go routine to print stats and prune messages.
  154. func (s *Server) Run() error {
  155. var listenStr string
  156. if s.config.ListenHTTP != "" {
  157. listenStr += fmt.Sprintf(" %s[http]", s.config.ListenHTTP)
  158. }
  159. if s.config.ListenHTTPS != "" {
  160. listenStr += fmt.Sprintf(" %s[https]", s.config.ListenHTTPS)
  161. }
  162. if s.config.ListenUnix != "" {
  163. listenStr += fmt.Sprintf(" %s[unix]", s.config.ListenUnix)
  164. }
  165. if s.config.SMTPServerListen != "" {
  166. listenStr += fmt.Sprintf(" %s[smtp]", s.config.SMTPServerListen)
  167. }
  168. log.Info("Listening on%s, ntfy %s, log level is %s", listenStr, s.config.Version, log.CurrentLevel().String())
  169. mux := http.NewServeMux()
  170. mux.HandleFunc("/", s.handle)
  171. errChan := make(chan error)
  172. s.mu.Lock()
  173. s.closeChan = make(chan bool)
  174. if s.config.ListenHTTP != "" {
  175. s.httpServer = &http.Server{Addr: s.config.ListenHTTP, Handler: mux}
  176. go func() {
  177. errChan <- s.httpServer.ListenAndServe()
  178. }()
  179. }
  180. if s.config.ListenHTTPS != "" {
  181. s.httpsServer = &http.Server{Addr: s.config.ListenHTTPS, Handler: mux}
  182. go func() {
  183. errChan <- s.httpsServer.ListenAndServeTLS(s.config.CertFile, s.config.KeyFile)
  184. }()
  185. }
  186. if s.config.ListenUnix != "" {
  187. go func() {
  188. var err error
  189. s.mu.Lock()
  190. os.Remove(s.config.ListenUnix)
  191. s.unixListener, err = net.Listen("unix", s.config.ListenUnix)
  192. if err != nil {
  193. s.mu.Unlock()
  194. errChan <- err
  195. return
  196. }
  197. defer s.unixListener.Close()
  198. if s.config.ListenUnixMode > 0 {
  199. if err := os.Chmod(s.config.ListenUnix, s.config.ListenUnixMode); err != nil {
  200. s.mu.Unlock()
  201. errChan <- err
  202. return
  203. }
  204. }
  205. s.mu.Unlock()
  206. httpServer := &http.Server{Handler: mux}
  207. errChan <- httpServer.Serve(s.unixListener)
  208. }()
  209. }
  210. if s.config.SMTPServerListen != "" {
  211. go func() {
  212. errChan <- s.runSMTPServer()
  213. }()
  214. }
  215. s.mu.Unlock()
  216. go s.runManager()
  217. go s.runDelayedSender()
  218. go s.runFirebaseKeepaliver()
  219. return <-errChan
  220. }
  221. // Stop stops HTTP (+HTTPS) server and all managers
  222. func (s *Server) Stop() {
  223. s.mu.Lock()
  224. defer s.mu.Unlock()
  225. if s.httpServer != nil {
  226. s.httpServer.Close()
  227. }
  228. if s.httpsServer != nil {
  229. s.httpsServer.Close()
  230. }
  231. if s.unixListener != nil {
  232. s.unixListener.Close()
  233. }
  234. if s.smtpServer != nil {
  235. s.smtpServer.Close()
  236. }
  237. close(s.closeChan)
  238. }
  239. func (s *Server) handle(w http.ResponseWriter, r *http.Request) {
  240. v := s.visitor(r)
  241. log.Debug("%s Dispatching request", logHTTPPrefix(v, r))
  242. if log.IsTrace() {
  243. log.Trace("%s Entire request (headers and body):\n%s", logHTTPPrefix(v, r), renderHTTPRequest(r))
  244. }
  245. if err := s.handleInternal(w, r, v); err != nil {
  246. if websocket.IsWebSocketUpgrade(r) {
  247. isNormalError := strings.Contains(err.Error(), "i/o timeout")
  248. if isNormalError {
  249. log.Debug("%s WebSocket error (this error is okay, it happens a lot): %s", logHTTPPrefix(v, r), err.Error())
  250. } else {
  251. log.Info("%s WebSocket error: %s", logHTTPPrefix(v, r), err.Error())
  252. }
  253. return // Do not attempt to write to upgraded connection
  254. }
  255. if matrixErr, ok := err.(*errMatrix); ok {
  256. writeMatrixError(w, r, v, matrixErr)
  257. return
  258. }
  259. httpErr, ok := err.(*errHTTP)
  260. if !ok {
  261. httpErr = errHTTPInternalError
  262. }
  263. isNormalError := httpErr.HTTPCode == http.StatusNotFound || httpErr.HTTPCode == http.StatusBadRequest
  264. if isNormalError {
  265. log.Debug("%s Connection closed with HTTP %d (ntfy error %d): %s", logHTTPPrefix(v, r), httpErr.HTTPCode, httpErr.Code, err.Error())
  266. } else {
  267. log.Info("%s Connection closed with HTTP %d (ntfy error %d): %s", logHTTPPrefix(v, r), httpErr.HTTPCode, httpErr.Code, err.Error())
  268. }
  269. w.Header().Set("Content-Type", "application/json")
  270. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  271. w.WriteHeader(httpErr.HTTPCode)
  272. io.WriteString(w, httpErr.JSON()+"\n")
  273. }
  274. }
  275. func (s *Server) handleInternal(w http.ResponseWriter, r *http.Request, v *visitor) error {
  276. if r.Method == http.MethodGet && r.URL.Path == "/" {
  277. return s.ensureWebEnabled(s.handleHome)(w, r, v)
  278. } else if r.Method == http.MethodHead && r.URL.Path == "/" {
  279. return s.ensureWebEnabled(s.handleEmpty)(w, r, v)
  280. } else if r.Method == http.MethodGet && r.URL.Path == webConfigPath {
  281. return s.ensureWebEnabled(s.handleWebConfig)(w, r, v)
  282. } else if r.Method == http.MethodGet && r.URL.Path == userStatsPath {
  283. return s.handleUserStats(w, r, v)
  284. } else if r.Method == http.MethodGet && r.URL.Path == matrixPushPath {
  285. return s.handleMatrixDiscovery(w)
  286. } else if r.Method == http.MethodGet && staticRegex.MatchString(r.URL.Path) {
  287. return s.ensureWebEnabled(s.handleStatic)(w, r, v)
  288. } else if r.Method == http.MethodGet && docsRegex.MatchString(r.URL.Path) {
  289. return s.ensureWebEnabled(s.handleDocs)(w, r, v)
  290. } else if (r.Method == http.MethodGet || r.Method == http.MethodHead) && fileRegex.MatchString(r.URL.Path) && s.config.AttachmentCacheDir != "" {
  291. return s.limitRequests(s.handleFile)(w, r, v)
  292. } else if r.Method == http.MethodOptions {
  293. return s.ensureWebEnabled(s.handleOptions)(w, r, v)
  294. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && r.URL.Path == "/" {
  295. return s.limitRequests(s.transformBodyJSON(s.authWrite(s.handlePublish)))(w, r, v)
  296. } else if r.Method == http.MethodPost && r.URL.Path == matrixPushPath {
  297. return s.limitRequests(s.transformMatrixJSON(s.authWrite(s.handlePublishMatrix)))(w, r, v)
  298. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && topicPathRegex.MatchString(r.URL.Path) {
  299. return s.limitRequests(s.authWrite(s.handlePublish))(w, r, v)
  300. } else if r.Method == http.MethodGet && publishPathRegex.MatchString(r.URL.Path) {
  301. return s.limitRequests(s.authWrite(s.handlePublish))(w, r, v)
  302. } else if r.Method == http.MethodGet && jsonPathRegex.MatchString(r.URL.Path) {
  303. return s.limitRequests(s.authRead(s.handleSubscribeJSON))(w, r, v)
  304. } else if r.Method == http.MethodGet && ssePathRegex.MatchString(r.URL.Path) {
  305. return s.limitRequests(s.authRead(s.handleSubscribeSSE))(w, r, v)
  306. } else if r.Method == http.MethodGet && rawPathRegex.MatchString(r.URL.Path) {
  307. return s.limitRequests(s.authRead(s.handleSubscribeRaw))(w, r, v)
  308. } else if r.Method == http.MethodGet && wsPathRegex.MatchString(r.URL.Path) {
  309. return s.limitRequests(s.authRead(s.handleSubscribeWS))(w, r, v)
  310. } else if r.Method == http.MethodGet && authPathRegex.MatchString(r.URL.Path) {
  311. return s.limitRequests(s.authRead(s.handleTopicAuth))(w, r, v)
  312. } else if r.Method == http.MethodGet && (topicPathRegex.MatchString(r.URL.Path) || externalTopicPathRegex.MatchString(r.URL.Path)) {
  313. return s.ensureWebEnabled(s.handleTopic)(w, r, v)
  314. }
  315. return errHTTPNotFound
  316. }
  317. func (s *Server) handleHome(w http.ResponseWriter, r *http.Request, v *visitor) error {
  318. if s.config.WebRootIsApp {
  319. r.URL.Path = webAppIndex
  320. } else {
  321. r.URL.Path = webHomeIndex
  322. }
  323. return s.handleStatic(w, r, v)
  324. }
  325. func (s *Server) handleTopic(w http.ResponseWriter, r *http.Request, v *visitor) error {
  326. unifiedpush := readBoolParam(r, false, "x-unifiedpush", "unifiedpush", "up") // see PUT/POST too!
  327. if unifiedpush {
  328. w.Header().Set("Content-Type", "application/json")
  329. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  330. _, err := io.WriteString(w, `{"unifiedpush":{"version":1}}`+"\n")
  331. return err
  332. }
  333. r.URL.Path = webAppIndex
  334. return s.handleStatic(w, r, v)
  335. }
  336. func (s *Server) handleEmpty(_ http.ResponseWriter, _ *http.Request, _ *visitor) error {
  337. return nil
  338. }
  339. func (s *Server) handleTopicAuth(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  340. w.Header().Set("Content-Type", "application/json")
  341. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  342. _, err := io.WriteString(w, `{"success":true}`+"\n")
  343. return err
  344. }
  345. func (s *Server) handleWebConfig(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  346. appRoot := "/"
  347. if !s.config.WebRootIsApp {
  348. appRoot = "/app"
  349. }
  350. disallowedTopicsStr := `"` + strings.Join(disallowedTopics, `", "`) + `"`
  351. w.Header().Set("Content-Type", "text/javascript")
  352. _, err := io.WriteString(w, fmt.Sprintf(`// Generated server configuration
  353. var config = {
  354. appRoot: "%s",
  355. disallowedTopics: [%s]
  356. };`, appRoot, disallowedTopicsStr))
  357. return err
  358. }
  359. func (s *Server) handleUserStats(w http.ResponseWriter, r *http.Request, v *visitor) error {
  360. stats, err := v.Stats()
  361. if err != nil {
  362. return err
  363. }
  364. w.Header().Set("Content-Type", "text/json")
  365. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  366. if err := json.NewEncoder(w).Encode(stats); err != nil {
  367. return err
  368. }
  369. return nil
  370. }
  371. func (s *Server) handleStatic(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  372. r.URL.Path = webSiteDir + r.URL.Path
  373. util.Gzip(http.FileServer(http.FS(webFsCached))).ServeHTTP(w, r)
  374. return nil
  375. }
  376. func (s *Server) handleDocs(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  377. util.Gzip(http.FileServer(http.FS(docsStaticCached))).ServeHTTP(w, r)
  378. return nil
  379. }
  380. func (s *Server) handleFile(w http.ResponseWriter, r *http.Request, v *visitor) error {
  381. if s.config.AttachmentCacheDir == "" {
  382. return errHTTPInternalError
  383. }
  384. matches := fileRegex.FindStringSubmatch(r.URL.Path)
  385. if len(matches) != 2 {
  386. return errHTTPInternalErrorInvalidFilePath
  387. }
  388. messageID := matches[1]
  389. file := filepath.Join(s.config.AttachmentCacheDir, messageID)
  390. stat, err := os.Stat(file)
  391. if err != nil {
  392. return errHTTPNotFound
  393. }
  394. if r.Method == http.MethodGet {
  395. if err := v.BandwidthLimiter().Allow(stat.Size()); err != nil {
  396. return errHTTPTooManyRequestsAttachmentBandwidthLimit
  397. }
  398. }
  399. w.Header().Set("Content-Length", fmt.Sprintf("%d", stat.Size()))
  400. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  401. if r.Method == http.MethodGet {
  402. f, err := os.Open(file)
  403. if err != nil {
  404. return err
  405. }
  406. defer f.Close()
  407. _, err = io.Copy(util.NewContentTypeWriter(w, r.URL.Path), f)
  408. return err
  409. }
  410. return nil
  411. }
  412. func (s *Server) handleMatrixDiscovery(w http.ResponseWriter) error {
  413. if s.config.BaseURL == "" {
  414. return errHTTPInternalErrorMissingBaseURL
  415. }
  416. return writeMatrixDiscoveryResponse(w)
  417. }
  418. func (s *Server) handlePublishWithoutResponse(r *http.Request, v *visitor) (*message, error) {
  419. t, err := s.topicFromPath(r.URL.Path)
  420. if err != nil {
  421. return nil, err
  422. }
  423. body, err := util.Peek(r.Body, s.config.MessageLimit)
  424. if err != nil {
  425. return nil, err
  426. }
  427. m := newDefaultMessage(t.ID, "")
  428. cache, firebase, email, unifiedpush, err := s.parsePublishParams(r, v, m)
  429. if err != nil {
  430. return nil, err
  431. }
  432. if m.PollID != "" {
  433. m = newPollRequestMessage(t.ID, m.PollID)
  434. }
  435. if err := s.handlePublishBody(r, v, m, body, unifiedpush); err != nil {
  436. return nil, err
  437. }
  438. if m.Message == "" {
  439. m.Message = emptyMessageBody
  440. }
  441. delayed := m.Time > time.Now().Unix()
  442. log.Debug("%s Received message: event=%s, body=%d byte(s), delayed=%t, firebase=%t, cache=%t, up=%t, email=%s",
  443. logMessagePrefix(v, m), m.Event, len(m.Message), delayed, firebase, cache, unifiedpush, email)
  444. if log.IsTrace() {
  445. log.Trace("%s Message body: %s", logMessagePrefix(v, m), util.MaybeMarshalJSON(m))
  446. }
  447. if !delayed {
  448. if err := t.Publish(v, m); err != nil {
  449. return nil, err
  450. }
  451. if s.firebaseClient != nil && firebase {
  452. go s.sendToFirebase(v, m)
  453. }
  454. if s.smtpSender != nil && email != "" {
  455. go s.sendEmail(v, m, email)
  456. }
  457. if s.config.UpstreamBaseURL != "" {
  458. go s.forwardPollRequest(v, m)
  459. }
  460. } else {
  461. log.Debug("%s Message delayed, will process later", logMessagePrefix(v, m))
  462. }
  463. if cache {
  464. if err := s.messageCache.AddMessage(m); err != nil {
  465. return nil, err
  466. }
  467. }
  468. s.mu.Lock()
  469. s.messages++
  470. s.mu.Unlock()
  471. return m, nil
  472. }
  473. func (s *Server) handlePublish(w http.ResponseWriter, r *http.Request, v *visitor) error {
  474. m, err := s.handlePublishWithoutResponse(r, v)
  475. if err != nil {
  476. return err
  477. }
  478. w.Header().Set("Content-Type", "application/json")
  479. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  480. if err := json.NewEncoder(w).Encode(m); err != nil {
  481. return err
  482. }
  483. return nil
  484. }
  485. func (s *Server) handlePublishMatrix(w http.ResponseWriter, r *http.Request, v *visitor) error {
  486. _, err := s.handlePublishWithoutResponse(r, v)
  487. if err != nil {
  488. return &errMatrix{pushKey: r.Header.Get(matrixPushKeyHeader), err: err}
  489. }
  490. return writeMatrixSuccess(w)
  491. }
  492. func (s *Server) sendToFirebase(v *visitor, m *message) {
  493. log.Debug("%s Publishing to Firebase", logMessagePrefix(v, m))
  494. if err := s.firebaseClient.Send(v, m); err != nil {
  495. if err == errFirebaseTemporarilyBanned {
  496. log.Debug("%s Unable to publish to Firebase: %v", logMessagePrefix(v, m), err.Error())
  497. } else {
  498. log.Warn("%s Unable to publish to Firebase: %v", logMessagePrefix(v, m), err.Error())
  499. }
  500. }
  501. }
  502. func (s *Server) sendEmail(v *visitor, m *message, email string) {
  503. log.Debug("%s Sending email to %s", logMessagePrefix(v, m), email)
  504. if err := s.smtpSender.Send(v, m, email); err != nil {
  505. log.Warn("%s Unable to send email to %s: %v", logMessagePrefix(v, m), email, err.Error())
  506. }
  507. }
  508. func (s *Server) forwardPollRequest(v *visitor, m *message) {
  509. topicURL := fmt.Sprintf("%s/%s", s.config.BaseURL, m.Topic)
  510. topicHash := fmt.Sprintf("%x", sha256.Sum256([]byte(topicURL)))
  511. forwardURL := fmt.Sprintf("%s/%s", s.config.UpstreamBaseURL, topicHash)
  512. log.Debug("%s Publishing poll request to %s", logMessagePrefix(v, m), forwardURL)
  513. req, err := http.NewRequest("POST", forwardURL, strings.NewReader(""))
  514. if err != nil {
  515. log.Warn("%s Unable to publish poll request: %v", logMessagePrefix(v, m), err.Error())
  516. return
  517. }
  518. req.Header.Set("X-Poll-ID", m.ID)
  519. var httpClient = &http.Client{
  520. Timeout: time.Second * 10,
  521. }
  522. response, err := httpClient.Do(req)
  523. if err != nil {
  524. log.Warn("%s Unable to publish poll request: %v", logMessagePrefix(v, m), err.Error())
  525. return
  526. } else if response.StatusCode != http.StatusOK {
  527. log.Warn("%s Unable to publish poll request, unexpected HTTP status: %d", logMessagePrefix(v, m), response.StatusCode)
  528. return
  529. }
  530. }
  531. func (s *Server) parsePublishParams(r *http.Request, v *visitor, m *message) (cache bool, firebase bool, email string, unifiedpush bool, err error) {
  532. cache = readBoolParam(r, true, "x-cache", "cache")
  533. firebase = readBoolParam(r, true, "x-firebase", "firebase")
  534. m.Title = readParam(r, "x-title", "title", "t")
  535. m.Click = readParam(r, "x-click", "click")
  536. filename := readParam(r, "x-filename", "filename", "file", "f")
  537. attach := readParam(r, "x-attach", "attach", "a")
  538. if attach != "" || filename != "" {
  539. m.Attachment = &attachment{}
  540. }
  541. if filename != "" {
  542. m.Attachment.Name = filename
  543. }
  544. if attach != "" {
  545. if !attachURLRegex.MatchString(attach) {
  546. return false, false, "", false, errHTTPBadRequestAttachmentURLInvalid
  547. }
  548. m.Attachment.URL = attach
  549. if m.Attachment.Name == "" {
  550. u, err := url.Parse(m.Attachment.URL)
  551. if err == nil {
  552. m.Attachment.Name = path.Base(u.Path)
  553. if m.Attachment.Name == "." || m.Attachment.Name == "/" {
  554. m.Attachment.Name = ""
  555. }
  556. }
  557. }
  558. if m.Attachment.Name == "" {
  559. m.Attachment.Name = "attachment"
  560. }
  561. }
  562. email = readParam(r, "x-email", "x-e-mail", "email", "e-mail", "mail", "e")
  563. if email != "" {
  564. if err := v.EmailAllowed(); err != nil {
  565. return false, false, "", false, errHTTPTooManyRequestsLimitEmails
  566. }
  567. }
  568. if s.smtpSender == nil && email != "" {
  569. return false, false, "", false, errHTTPBadRequestEmailDisabled
  570. }
  571. messageStr := strings.ReplaceAll(readParam(r, "x-message", "message", "m"), "\\n", "\n")
  572. if messageStr != "" {
  573. m.Message = messageStr
  574. }
  575. m.Priority, err = util.ParsePriority(readParam(r, "x-priority", "priority", "prio", "p"))
  576. if err != nil {
  577. return false, false, "", false, errHTTPBadRequestPriorityInvalid
  578. }
  579. tagsStr := readParam(r, "x-tags", "tags", "tag", "ta")
  580. if tagsStr != "" {
  581. m.Tags = make([]string, 0)
  582. for _, s := range util.SplitNoEmpty(tagsStr, ",") {
  583. m.Tags = append(m.Tags, strings.TrimSpace(s))
  584. }
  585. }
  586. delayStr := readParam(r, "x-delay", "delay", "x-at", "at", "x-in", "in")
  587. if delayStr != "" {
  588. if !cache {
  589. return false, false, "", false, errHTTPBadRequestDelayNoCache
  590. }
  591. if email != "" {
  592. return false, false, "", false, errHTTPBadRequestDelayNoEmail // we cannot store the email address (yet)
  593. }
  594. delay, err := util.ParseFutureTime(delayStr, time.Now())
  595. if err != nil {
  596. return false, false, "", false, errHTTPBadRequestDelayCannotParse
  597. } else if delay.Unix() < time.Now().Add(s.config.MinDelay).Unix() {
  598. return false, false, "", false, errHTTPBadRequestDelayTooSmall
  599. } else if delay.Unix() > time.Now().Add(s.config.MaxDelay).Unix() {
  600. return false, false, "", false, errHTTPBadRequestDelayTooLarge
  601. }
  602. m.Time = delay.Unix()
  603. m.Sender = v.ip // Important for rate limiting
  604. }
  605. actionsStr := readParam(r, "x-actions", "actions", "action")
  606. if actionsStr != "" {
  607. m.Actions, err = parseActions(actionsStr)
  608. if err != nil {
  609. return false, false, "", false, wrapErrHTTP(errHTTPBadRequestActionsInvalid, err.Error())
  610. }
  611. }
  612. unifiedpush = readBoolParam(r, false, "x-unifiedpush", "unifiedpush", "up") // see GET too!
  613. if unifiedpush {
  614. firebase = false
  615. unifiedpush = true
  616. }
  617. m.PollID = readParam(r, "x-poll-id", "poll-id")
  618. if m.PollID != "" {
  619. unifiedpush = false
  620. cache = false
  621. email = ""
  622. }
  623. return cache, firebase, email, unifiedpush, nil
  624. }
  625. // handlePublishBody consumes the PUT/POST body and decides whether the body is an attachment or the message.
  626. //
  627. // 1. curl -X POST -H "Poll: 1234" ntfy.sh/...
  628. // If a message is flagged as poll request, the body does not matter and is discarded
  629. // 2. curl -T somebinarydata.bin "ntfy.sh/mytopic?up=1"
  630. // If body is binary, encode as base64, if not do not encode
  631. // 3. curl -H "Attach: http://example.com/file.jpg" ntfy.sh/mytopic
  632. // Body must be a message, because we attached an external URL
  633. // 4. curl -T short.txt -H "Filename: short.txt" ntfy.sh/mytopic
  634. // Body must be attachment, because we passed a filename
  635. // 5. curl -T file.txt ntfy.sh/mytopic
  636. // If file.txt is <= 4096 (message limit) and valid UTF-8, treat it as a message
  637. // 6. curl -T file.txt ntfy.sh/mytopic
  638. // If file.txt is > message limit, treat it as an attachment
  639. func (s *Server) handlePublishBody(r *http.Request, v *visitor, m *message, body *util.PeekedReadCloser, unifiedpush bool) error {
  640. if m.Event == pollRequestEvent { // Case 1
  641. return s.handleBodyDiscard(body)
  642. } else if unifiedpush {
  643. return s.handleBodyAsMessageAutoDetect(m, body) // Case 2
  644. } else if m.Attachment != nil && m.Attachment.URL != "" {
  645. return s.handleBodyAsTextMessage(m, body) // Case 3
  646. } else if m.Attachment != nil && m.Attachment.Name != "" {
  647. return s.handleBodyAsAttachment(r, v, m, body) // Case 4
  648. } else if !body.LimitReached && utf8.Valid(body.PeekedBytes) {
  649. return s.handleBodyAsTextMessage(m, body) // Case 5
  650. }
  651. return s.handleBodyAsAttachment(r, v, m, body) // Case 6
  652. }
  653. func (s *Server) handleBodyDiscard(body *util.PeekedReadCloser) error {
  654. _, err := io.Copy(io.Discard, body)
  655. _ = body.Close()
  656. return err
  657. }
  658. func (s *Server) handleBodyAsMessageAutoDetect(m *message, body *util.PeekedReadCloser) error {
  659. if utf8.Valid(body.PeekedBytes) {
  660. m.Message = string(body.PeekedBytes) // Do not trim
  661. } else {
  662. m.Message = base64.StdEncoding.EncodeToString(body.PeekedBytes)
  663. m.Encoding = encodingBase64
  664. }
  665. return nil
  666. }
  667. func (s *Server) handleBodyAsTextMessage(m *message, body *util.PeekedReadCloser) error {
  668. if !utf8.Valid(body.PeekedBytes) {
  669. return errHTTPBadRequestMessageNotUTF8
  670. }
  671. if len(body.PeekedBytes) > 0 { // Empty body should not override message (publish via GET!)
  672. m.Message = strings.TrimSpace(string(body.PeekedBytes)) // Truncates the message to the peek limit if required
  673. }
  674. if m.Attachment != nil && m.Attachment.Name != "" && m.Message == "" {
  675. m.Message = fmt.Sprintf(defaultAttachmentMessage, m.Attachment.Name)
  676. }
  677. return nil
  678. }
  679. func (s *Server) handleBodyAsAttachment(r *http.Request, v *visitor, m *message, body *util.PeekedReadCloser) error {
  680. if s.fileCache == nil || s.config.BaseURL == "" || s.config.AttachmentCacheDir == "" {
  681. return errHTTPBadRequestAttachmentsDisallowed
  682. } else if m.Time > time.Now().Add(s.config.AttachmentExpiryDuration).Unix() {
  683. return errHTTPBadRequestAttachmentsExpiryBeforeDelivery
  684. }
  685. visitorStats, err := v.Stats()
  686. if err != nil {
  687. return err
  688. }
  689. contentLengthStr := r.Header.Get("Content-Length")
  690. if contentLengthStr != "" { // Early "do-not-trust" check, hard limit see below
  691. contentLength, err := strconv.ParseInt(contentLengthStr, 10, 64)
  692. if err == nil && (contentLength > visitorStats.VisitorAttachmentBytesRemaining || contentLength > s.config.AttachmentFileSizeLimit) {
  693. return errHTTPEntityTooLargeAttachmentTooLarge
  694. }
  695. }
  696. if m.Attachment == nil {
  697. m.Attachment = &attachment{}
  698. }
  699. var ext string
  700. m.Sender = v.ip // Important for attachment rate limiting
  701. m.Attachment.Expires = time.Now().Add(s.config.AttachmentExpiryDuration).Unix()
  702. m.Attachment.Type, ext = util.DetectContentType(body.PeekedBytes, m.Attachment.Name)
  703. m.Attachment.URL = fmt.Sprintf("%s/file/%s%s", s.config.BaseURL, m.ID, ext)
  704. if m.Attachment.Name == "" {
  705. m.Attachment.Name = fmt.Sprintf("attachment%s", ext)
  706. }
  707. if m.Message == "" {
  708. m.Message = fmt.Sprintf(defaultAttachmentMessage, m.Attachment.Name)
  709. }
  710. m.Attachment.Size, err = s.fileCache.Write(m.ID, body, v.BandwidthLimiter(), util.NewFixedLimiter(visitorStats.VisitorAttachmentBytesRemaining))
  711. if err == util.ErrLimitReached {
  712. return errHTTPEntityTooLargeAttachmentTooLarge
  713. } else if err != nil {
  714. return err
  715. }
  716. return nil
  717. }
  718. func (s *Server) handleSubscribeJSON(w http.ResponseWriter, r *http.Request, v *visitor) error {
  719. encoder := func(msg *message) (string, error) {
  720. var buf bytes.Buffer
  721. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  722. return "", err
  723. }
  724. return buf.String(), nil
  725. }
  726. return s.handleSubscribeHTTP(w, r, v, "application/x-ndjson", encoder)
  727. }
  728. func (s *Server) handleSubscribeSSE(w http.ResponseWriter, r *http.Request, v *visitor) error {
  729. encoder := func(msg *message) (string, error) {
  730. var buf bytes.Buffer
  731. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  732. return "", err
  733. }
  734. if msg.Event != messageEvent {
  735. return fmt.Sprintf("event: %s\ndata: %s\n", msg.Event, buf.String()), nil // Browser's .onmessage() does not fire on this!
  736. }
  737. return fmt.Sprintf("data: %s\n", buf.String()), nil
  738. }
  739. return s.handleSubscribeHTTP(w, r, v, "text/event-stream", encoder)
  740. }
  741. func (s *Server) handleSubscribeRaw(w http.ResponseWriter, r *http.Request, v *visitor) error {
  742. encoder := func(msg *message) (string, error) {
  743. if msg.Event == messageEvent { // only handle default events
  744. return strings.ReplaceAll(msg.Message, "\n", " ") + "\n", nil
  745. }
  746. return "\n", nil // "keepalive" and "open" events just send an empty line
  747. }
  748. return s.handleSubscribeHTTP(w, r, v, "text/plain", encoder)
  749. }
  750. func (s *Server) handleSubscribeHTTP(w http.ResponseWriter, r *http.Request, v *visitor, contentType string, encoder messageEncoder) error {
  751. log.Debug("%s HTTP stream connection opened", logHTTPPrefix(v, r))
  752. defer log.Debug("%s HTTP stream connection closed", logHTTPPrefix(v, r))
  753. if err := v.SubscriptionAllowed(); err != nil {
  754. return errHTTPTooManyRequestsLimitSubscriptions
  755. }
  756. defer v.RemoveSubscription()
  757. topics, topicsStr, err := s.topicsFromPath(r.URL.Path)
  758. if err != nil {
  759. return err
  760. }
  761. poll, since, scheduled, filters, err := parseSubscribeParams(r)
  762. if err != nil {
  763. return err
  764. }
  765. var wlock sync.Mutex
  766. defer func() {
  767. // Hack: This is the fix for a horrible data race that I have not been able to figure out in quite some time.
  768. // It appears to be happening when the Go HTTP code reads from the socket when closing the request (i.e. AFTER
  769. // this function returns), and causes a data race with the ResponseWriter. Locking wlock here silences the
  770. // data race detector. See https://github.com/binwiederhier/ntfy/issues/338#issuecomment-1163425889.
  771. wlock.TryLock()
  772. }()
  773. sub := func(v *visitor, msg *message) error {
  774. if !filters.Pass(msg) {
  775. return nil
  776. }
  777. m, err := encoder(msg)
  778. if err != nil {
  779. return err
  780. }
  781. wlock.Lock()
  782. defer wlock.Unlock()
  783. if _, err := w.Write([]byte(m)); err != nil {
  784. return err
  785. }
  786. if fl, ok := w.(http.Flusher); ok {
  787. fl.Flush()
  788. }
  789. return nil
  790. }
  791. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  792. w.Header().Set("Content-Type", contentType+"; charset=utf-8") // Android/Volley client needs charset!
  793. if poll {
  794. return s.sendOldMessages(topics, since, scheduled, v, sub)
  795. }
  796. subscriberIDs := make([]int, 0)
  797. for _, t := range topics {
  798. subscriberIDs = append(subscriberIDs, t.Subscribe(sub))
  799. }
  800. defer func() {
  801. for i, subscriberID := range subscriberIDs {
  802. topics[i].Unsubscribe(subscriberID) // Order!
  803. }
  804. }()
  805. if err := sub(v, newOpenMessage(topicsStr)); err != nil { // Send out open message
  806. return err
  807. }
  808. if err := s.sendOldMessages(topics, since, scheduled, v, sub); err != nil {
  809. return err
  810. }
  811. for {
  812. select {
  813. case <-r.Context().Done():
  814. return nil
  815. case <-time.After(s.config.KeepaliveInterval):
  816. log.Trace("%s Sending keepalive message", logHTTPPrefix(v, r))
  817. v.Keepalive()
  818. if err := sub(v, newKeepaliveMessage(topicsStr)); err != nil { // Send keepalive message
  819. return err
  820. }
  821. }
  822. }
  823. }
  824. func (s *Server) handleSubscribeWS(w http.ResponseWriter, r *http.Request, v *visitor) error {
  825. if strings.ToLower(r.Header.Get("Upgrade")) != "websocket" {
  826. return errHTTPBadRequestWebSocketsUpgradeHeaderMissing
  827. }
  828. if err := v.SubscriptionAllowed(); err != nil {
  829. return errHTTPTooManyRequestsLimitSubscriptions
  830. }
  831. defer v.RemoveSubscription()
  832. log.Debug("%s WebSocket connection opened", logHTTPPrefix(v, r))
  833. defer log.Debug("%s WebSocket connection closed", logHTTPPrefix(v, r))
  834. topics, topicsStr, err := s.topicsFromPath(r.URL.Path)
  835. if err != nil {
  836. return err
  837. }
  838. poll, since, scheduled, filters, err := parseSubscribeParams(r)
  839. if err != nil {
  840. return err
  841. }
  842. upgrader := &websocket.Upgrader{
  843. ReadBufferSize: wsBufferSize,
  844. WriteBufferSize: wsBufferSize,
  845. CheckOrigin: func(r *http.Request) bool {
  846. return true // We're open for business!
  847. },
  848. }
  849. conn, err := upgrader.Upgrade(w, r, nil)
  850. if err != nil {
  851. return err
  852. }
  853. defer conn.Close()
  854. var wlock sync.Mutex
  855. g, ctx := errgroup.WithContext(context.Background())
  856. g.Go(func() error {
  857. pongWait := s.config.KeepaliveInterval + wsPongWait
  858. conn.SetReadLimit(wsReadLimit)
  859. if err := conn.SetReadDeadline(time.Now().Add(pongWait)); err != nil {
  860. return err
  861. }
  862. conn.SetPongHandler(func(appData string) error {
  863. log.Trace("%s Received WebSocket pong", logHTTPPrefix(v, r))
  864. return conn.SetReadDeadline(time.Now().Add(pongWait))
  865. })
  866. for {
  867. _, _, err := conn.NextReader()
  868. if err != nil {
  869. return err
  870. }
  871. }
  872. })
  873. g.Go(func() error {
  874. ping := func() error {
  875. wlock.Lock()
  876. defer wlock.Unlock()
  877. if err := conn.SetWriteDeadline(time.Now().Add(wsWriteWait)); err != nil {
  878. return err
  879. }
  880. log.Trace("%s Sending WebSocket ping", logHTTPPrefix(v, r))
  881. return conn.WriteMessage(websocket.PingMessage, nil)
  882. }
  883. for {
  884. select {
  885. case <-ctx.Done():
  886. return nil
  887. case <-time.After(s.config.KeepaliveInterval):
  888. v.Keepalive()
  889. if err := ping(); err != nil {
  890. return err
  891. }
  892. }
  893. }
  894. })
  895. sub := func(v *visitor, msg *message) error {
  896. if !filters.Pass(msg) {
  897. return nil
  898. }
  899. wlock.Lock()
  900. defer wlock.Unlock()
  901. if err := conn.SetWriteDeadline(time.Now().Add(wsWriteWait)); err != nil {
  902. return err
  903. }
  904. return conn.WriteJSON(msg)
  905. }
  906. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  907. if poll {
  908. return s.sendOldMessages(topics, since, scheduled, v, sub)
  909. }
  910. subscriberIDs := make([]int, 0)
  911. for _, t := range topics {
  912. subscriberIDs = append(subscriberIDs, t.Subscribe(sub))
  913. }
  914. defer func() {
  915. for i, subscriberID := range subscriberIDs {
  916. topics[i].Unsubscribe(subscriberID) // Order!
  917. }
  918. }()
  919. if err := sub(v, newOpenMessage(topicsStr)); err != nil { // Send out open message
  920. return err
  921. }
  922. if err := s.sendOldMessages(topics, since, scheduled, v, sub); err != nil {
  923. return err
  924. }
  925. err = g.Wait()
  926. if err != nil && websocket.IsCloseError(err, websocket.CloseNormalClosure, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
  927. log.Trace("%s WebSocket connection closed: %s", logHTTPPrefix(v, r), err.Error())
  928. return nil // Normal closures are not errors; note: "1006 (abnormal closure)" is treated as normal, because people disconnect a lot
  929. }
  930. return err
  931. }
  932. func parseSubscribeParams(r *http.Request) (poll bool, since sinceMarker, scheduled bool, filters *queryFilter, err error) {
  933. poll = readBoolParam(r, false, "x-poll", "poll", "po")
  934. scheduled = readBoolParam(r, false, "x-scheduled", "scheduled", "sched")
  935. since, err = parseSince(r, poll)
  936. if err != nil {
  937. return
  938. }
  939. filters, err = parseQueryFilters(r)
  940. if err != nil {
  941. return
  942. }
  943. return
  944. }
  945. // sendOldMessages selects old messages from the messageCache and calls sub for each of them. It uses since as the
  946. // marker, returning only messages that are newer than the marker.
  947. func (s *Server) sendOldMessages(topics []*topic, since sinceMarker, scheduled bool, v *visitor, sub subscriber) error {
  948. if since.IsNone() {
  949. return nil
  950. }
  951. messages := make([]*message, 0)
  952. for _, t := range topics {
  953. topicMessages, err := s.messageCache.Messages(t.ID, since, scheduled)
  954. if err != nil {
  955. return err
  956. }
  957. messages = append(messages, topicMessages...)
  958. }
  959. sort.Slice(messages, func(i, j int) bool {
  960. return messages[i].Time < messages[j].Time
  961. })
  962. for _, m := range messages {
  963. if err := sub(v, m); err != nil {
  964. return err
  965. }
  966. }
  967. return nil
  968. }
  969. // parseSince returns a timestamp identifying the time span from which cached messages should be received.
  970. //
  971. // Values in the "since=..." parameter can be either a unix timestamp or a duration (e.g. 12h), or
  972. // "all" for all messages.
  973. func parseSince(r *http.Request, poll bool) (sinceMarker, error) {
  974. since := readParam(r, "x-since", "since", "si")
  975. // Easy cases (empty, all, none)
  976. if since == "" {
  977. if poll {
  978. return sinceAllMessages, nil
  979. }
  980. return sinceNoMessages, nil
  981. } else if since == "all" {
  982. return sinceAllMessages, nil
  983. } else if since == "none" {
  984. return sinceNoMessages, nil
  985. }
  986. // ID, timestamp, duration
  987. if validMessageID(since) {
  988. return newSinceID(since), nil
  989. } else if s, err := strconv.ParseInt(since, 10, 64); err == nil {
  990. return newSinceTime(s), nil
  991. } else if d, err := time.ParseDuration(since); err == nil {
  992. return newSinceTime(time.Now().Add(-1 * d).Unix()), nil
  993. }
  994. return sinceNoMessages, errHTTPBadRequestSinceInvalid
  995. }
  996. func (s *Server) handleOptions(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  997. w.Header().Set("Access-Control-Allow-Methods", "GET, PUT, POST")
  998. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  999. w.Header().Set("Access-Control-Allow-Headers", "*") // CORS, allow auth via JS // FIXME is this terrible?
  1000. return nil
  1001. }
  1002. func (s *Server) topicFromPath(path string) (*topic, error) {
  1003. parts := strings.Split(path, "/")
  1004. if len(parts) < 2 {
  1005. return nil, errHTTPBadRequestTopicInvalid
  1006. }
  1007. topics, err := s.topicsFromIDs(parts[1])
  1008. if err != nil {
  1009. return nil, err
  1010. }
  1011. return topics[0], nil
  1012. }
  1013. func (s *Server) topicsFromPath(path string) ([]*topic, string, error) {
  1014. parts := strings.Split(path, "/")
  1015. if len(parts) < 2 {
  1016. return nil, "", errHTTPBadRequestTopicInvalid
  1017. }
  1018. topicIDs := util.SplitNoEmpty(parts[1], ",")
  1019. topics, err := s.topicsFromIDs(topicIDs...)
  1020. if err != nil {
  1021. return nil, "", errHTTPBadRequestTopicInvalid
  1022. }
  1023. return topics, parts[1], nil
  1024. }
  1025. func (s *Server) topicsFromIDs(ids ...string) ([]*topic, error) {
  1026. s.mu.Lock()
  1027. defer s.mu.Unlock()
  1028. topics := make([]*topic, 0)
  1029. for _, id := range ids {
  1030. if util.InStringList(disallowedTopics, id) {
  1031. return nil, errHTTPBadRequestTopicDisallowed
  1032. }
  1033. if _, ok := s.topics[id]; !ok {
  1034. if len(s.topics) >= s.config.TotalTopicLimit {
  1035. return nil, errHTTPTooManyRequestsLimitTotalTopics
  1036. }
  1037. s.topics[id] = newTopic(id)
  1038. }
  1039. topics = append(topics, s.topics[id])
  1040. }
  1041. return topics, nil
  1042. }
  1043. func (s *Server) updateStatsAndPrune() {
  1044. log.Debug("Manager: Starting")
  1045. defer log.Debug("Manager: Finished")
  1046. // WARNING: Make sure to only selectively lock with the mutex, and be aware that this
  1047. // there is no mutex for the entire function.
  1048. // Expire visitors from rate visitors map
  1049. s.mu.Lock()
  1050. staleVisitors := 0
  1051. for ip, v := range s.visitors {
  1052. if v.Stale() {
  1053. log.Trace("Deleting stale visitor %s", v.ip)
  1054. delete(s.visitors, ip)
  1055. staleVisitors++
  1056. }
  1057. }
  1058. s.mu.Unlock()
  1059. log.Debug("Manager: Deleted %d stale visitor(s)", staleVisitors)
  1060. // Delete expired attachments
  1061. if s.fileCache != nil && s.config.AttachmentExpiryDuration > 0 {
  1062. olderThan := time.Now().Add(-1 * s.config.AttachmentExpiryDuration)
  1063. ids, err := s.fileCache.Expired(olderThan)
  1064. if err != nil {
  1065. log.Warn("Error retrieving expired attachments: %s", err.Error())
  1066. } else if len(ids) > 0 {
  1067. log.Debug("Manager: Deleting expired attachments: %v", ids)
  1068. if err := s.fileCache.Remove(ids...); err != nil {
  1069. log.Warn("Error deleting attachments: %s", err.Error())
  1070. }
  1071. } else {
  1072. log.Debug("Manager: No expired attachments to delete")
  1073. }
  1074. }
  1075. // Prune message cache
  1076. olderThan := time.Now().Add(-1 * s.config.CacheDuration)
  1077. log.Debug("Manager: Pruning messages older than %s", olderThan.Format("2006-01-02 15:04:05"))
  1078. if err := s.messageCache.Prune(olderThan); err != nil {
  1079. log.Warn("Manager: Error pruning cache: %s", err.Error())
  1080. }
  1081. // Message count per topic
  1082. var messages int
  1083. messageCounts, err := s.messageCache.MessageCounts()
  1084. if err != nil {
  1085. log.Warn("Manager: Cannot get message counts: %s", err.Error())
  1086. messageCounts = make(map[string]int) // Empty, so we can continue
  1087. }
  1088. for _, count := range messageCounts {
  1089. messages += count
  1090. }
  1091. // Remove subscriptions without subscribers
  1092. s.mu.Lock()
  1093. var subscribers int
  1094. for _, t := range s.topics {
  1095. subs := t.SubscribersCount()
  1096. msgs, exists := messageCounts[t.ID]
  1097. if subs == 0 && (!exists || msgs == 0) {
  1098. log.Trace("Deleting empty topic %s", t.ID)
  1099. delete(s.topics, t.ID)
  1100. continue
  1101. }
  1102. subscribers += subs
  1103. }
  1104. s.mu.Unlock()
  1105. // Mail stats
  1106. var receivedMailTotal, receivedMailSuccess, receivedMailFailure int64
  1107. if s.smtpServerBackend != nil {
  1108. receivedMailTotal, receivedMailSuccess, receivedMailFailure = s.smtpServerBackend.Counts()
  1109. }
  1110. var sentMailTotal, sentMailSuccess, sentMailFailure int64
  1111. if s.smtpSender != nil {
  1112. sentMailTotal, sentMailSuccess, sentMailFailure = s.smtpSender.Counts()
  1113. }
  1114. // Print stats
  1115. s.mu.Lock()
  1116. messagesCount, topicsCount, visitorsCount := s.messages, len(s.topics), len(s.visitors)
  1117. s.mu.Unlock()
  1118. log.Info("Stats: %d messages published, %d in cache, %d topic(s) active, %d subscriber(s), %d visitor(s), %d mails received (%d successful, %d failed), %d mails sent (%d successful, %d failed)",
  1119. messagesCount, messages, topicsCount, subscribers, visitorsCount,
  1120. receivedMailTotal, receivedMailSuccess, receivedMailFailure,
  1121. sentMailTotal, sentMailSuccess, sentMailFailure)
  1122. }
  1123. func (s *Server) runSMTPServer() error {
  1124. s.smtpServerBackend = newMailBackend(s.config, s.handle)
  1125. s.smtpServer = smtp.NewServer(s.smtpServerBackend)
  1126. s.smtpServer.Addr = s.config.SMTPServerListen
  1127. s.smtpServer.Domain = s.config.SMTPServerDomain
  1128. s.smtpServer.ReadTimeout = 10 * time.Second
  1129. s.smtpServer.WriteTimeout = 10 * time.Second
  1130. s.smtpServer.MaxMessageBytes = 1024 * 1024 // Must be much larger than message size (headers, multipart, etc.)
  1131. s.smtpServer.MaxRecipients = 1
  1132. s.smtpServer.AllowInsecureAuth = true
  1133. return s.smtpServer.ListenAndServe()
  1134. }
  1135. func (s *Server) runManager() {
  1136. for {
  1137. select {
  1138. case <-time.After(s.config.ManagerInterval):
  1139. s.updateStatsAndPrune()
  1140. case <-s.closeChan:
  1141. return
  1142. }
  1143. }
  1144. }
  1145. func (s *Server) runFirebaseKeepaliver() {
  1146. if s.firebaseClient == nil {
  1147. return
  1148. }
  1149. v := newVisitor(s.config, s.messageCache, "0.0.0.0") // Background process, not a real visitor
  1150. for {
  1151. select {
  1152. case <-time.After(s.config.FirebaseKeepaliveInterval):
  1153. s.sendToFirebase(v, newKeepaliveMessage(firebaseControlTopic))
  1154. case <-time.After(s.config.FirebasePollInterval):
  1155. s.sendToFirebase(v, newKeepaliveMessage(firebasePollTopic))
  1156. case <-s.closeChan:
  1157. return
  1158. }
  1159. }
  1160. }
  1161. func (s *Server) runDelayedSender() {
  1162. for {
  1163. select {
  1164. case <-time.After(s.config.DelayedSenderInterval):
  1165. if err := s.sendDelayedMessages(); err != nil {
  1166. log.Warn("Error sending delayed messages: %s", err.Error())
  1167. }
  1168. case <-s.closeChan:
  1169. return
  1170. }
  1171. }
  1172. }
  1173. func (s *Server) sendDelayedMessages() error {
  1174. messages, err := s.messageCache.MessagesDue()
  1175. if err != nil {
  1176. return err
  1177. }
  1178. for _, m := range messages {
  1179. v := s.visitorFromIP(m.Sender)
  1180. if err := s.sendDelayedMessage(v, m); err != nil {
  1181. log.Warn("%s Error sending delayed message: %s", logMessagePrefix(v, m), err.Error())
  1182. }
  1183. }
  1184. return nil
  1185. }
  1186. func (s *Server) sendDelayedMessage(v *visitor, m *message) error {
  1187. log.Debug("%s Sending delayed message", logMessagePrefix(v, m))
  1188. s.mu.Lock()
  1189. t, ok := s.topics[m.Topic] // If no subscribers, just mark message as published
  1190. s.mu.Unlock()
  1191. if ok {
  1192. go func() {
  1193. // We do not rate-limit messages here, since we've rate limited them in the PUT/POST handler
  1194. if err := t.Publish(v, m); err != nil {
  1195. log.Warn("%s Unable to publish message: %v", logMessagePrefix(v, m), err.Error())
  1196. }
  1197. }()
  1198. }
  1199. if s.firebaseClient != nil { // Firebase subscribers may not show up in topics map
  1200. go s.sendToFirebase(v, m)
  1201. }
  1202. if s.config.UpstreamBaseURL != "" {
  1203. go s.forwardPollRequest(v, m)
  1204. }
  1205. if err := s.messageCache.MarkPublished(m); err != nil {
  1206. return err
  1207. }
  1208. return nil
  1209. }
  1210. func (s *Server) limitRequests(next handleFunc) handleFunc {
  1211. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1212. if util.InStringList(s.config.VisitorRequestExemptIPAddrs, v.ip) {
  1213. return next(w, r, v)
  1214. } else if err := v.RequestAllowed(); err != nil {
  1215. return errHTTPTooManyRequestsLimitRequests
  1216. }
  1217. return next(w, r, v)
  1218. }
  1219. }
  1220. func (s *Server) ensureWebEnabled(next handleFunc) handleFunc {
  1221. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1222. if !s.config.EnableWeb {
  1223. return errHTTPNotFound
  1224. }
  1225. return next(w, r, v)
  1226. }
  1227. }
  1228. // transformBodyJSON peeks the request body, reads the JSON, and converts it to headers
  1229. // before passing it on to the next handler. This is meant to be used in combination with handlePublish.
  1230. func (s *Server) transformBodyJSON(next handleFunc) handleFunc {
  1231. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1232. body, err := util.Peek(r.Body, s.config.MessageLimit)
  1233. if err != nil {
  1234. return err
  1235. }
  1236. defer r.Body.Close()
  1237. var m publishMessage
  1238. if err := json.NewDecoder(body).Decode(&m); err != nil {
  1239. return errHTTPBadRequestJSONInvalid
  1240. }
  1241. if !topicRegex.MatchString(m.Topic) {
  1242. return errHTTPBadRequestTopicInvalid
  1243. }
  1244. if m.Message == "" {
  1245. m.Message = emptyMessageBody
  1246. }
  1247. r.URL.Path = "/" + m.Topic
  1248. r.Body = io.NopCloser(strings.NewReader(m.Message))
  1249. if m.Title != "" {
  1250. r.Header.Set("X-Title", m.Title)
  1251. }
  1252. if m.Priority != 0 {
  1253. r.Header.Set("X-Priority", fmt.Sprintf("%d", m.Priority))
  1254. }
  1255. if m.Tags != nil && len(m.Tags) > 0 {
  1256. r.Header.Set("X-Tags", strings.Join(m.Tags, ","))
  1257. }
  1258. if m.Attach != "" {
  1259. r.Header.Set("X-Attach", m.Attach)
  1260. }
  1261. if m.Filename != "" {
  1262. r.Header.Set("X-Filename", m.Filename)
  1263. }
  1264. if m.Click != "" {
  1265. r.Header.Set("X-Click", m.Click)
  1266. }
  1267. if len(m.Actions) > 0 {
  1268. actionsStr, err := json.Marshal(m.Actions)
  1269. if err != nil {
  1270. return errHTTPBadRequestJSONInvalid
  1271. }
  1272. r.Header.Set("X-Actions", string(actionsStr))
  1273. }
  1274. if m.Email != "" {
  1275. r.Header.Set("X-Email", m.Email)
  1276. }
  1277. if m.Delay != "" {
  1278. r.Header.Set("X-Delay", m.Delay)
  1279. }
  1280. return next(w, r, v)
  1281. }
  1282. }
  1283. func (s *Server) transformMatrixJSON(next handleFunc) handleFunc {
  1284. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1285. newRequest, err := newRequestFromMatrixJSON(r, s.config.BaseURL, s.config.MessageLimit)
  1286. if err != nil {
  1287. return err
  1288. }
  1289. if err := next(w, newRequest, v); err != nil {
  1290. return &errMatrix{pushKey: newRequest.Header.Get(matrixPushKeyHeader), err: err}
  1291. }
  1292. return nil
  1293. }
  1294. }
  1295. func (s *Server) authWrite(next handleFunc) handleFunc {
  1296. return s.withAuth(next, auth.PermissionWrite)
  1297. }
  1298. func (s *Server) authRead(next handleFunc) handleFunc {
  1299. return s.withAuth(next, auth.PermissionRead)
  1300. }
  1301. func (s *Server) withAuth(next handleFunc, perm auth.Permission) handleFunc {
  1302. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1303. if s.auth == nil {
  1304. return next(w, r, v)
  1305. }
  1306. topics, _, err := s.topicsFromPath(r.URL.Path)
  1307. if err != nil {
  1308. return err
  1309. }
  1310. var user *auth.User // may stay nil if no auth header!
  1311. username, password, ok := extractUserPass(r)
  1312. if ok {
  1313. if user, err = s.auth.Authenticate(username, password); err != nil {
  1314. log.Info("authentication failed: %s", err.Error())
  1315. return errHTTPUnauthorized
  1316. }
  1317. }
  1318. for _, t := range topics {
  1319. if err := s.auth.Authorize(user, t.ID, perm); err != nil {
  1320. log.Info("unauthorized: %s", err.Error())
  1321. return errHTTPForbidden
  1322. }
  1323. }
  1324. return next(w, r, v)
  1325. }
  1326. }
  1327. // extractUserPass reads the username/password from the basic auth header (Authorization: Basic ...),
  1328. // or from the ?auth=... query param. The latter is required only to support the WebSocket JavaScript
  1329. // class, which does not support passing headers during the initial request. The auth query param
  1330. // is effectively double base64 encoded. Its format is base64(Basic base64(user:pass)).
  1331. func extractUserPass(r *http.Request) (username string, password string, ok bool) {
  1332. username, password, ok = r.BasicAuth()
  1333. if ok {
  1334. return
  1335. }
  1336. authParam := readQueryParam(r, "authorization", "auth")
  1337. if authParam != "" {
  1338. a, err := base64.RawURLEncoding.DecodeString(authParam)
  1339. if err != nil {
  1340. return
  1341. }
  1342. r.Header.Set("Authorization", string(a))
  1343. return r.BasicAuth()
  1344. }
  1345. return
  1346. }
  1347. // visitor creates or retrieves a rate.Limiter for the given visitor.
  1348. // This function was taken from https://www.alexedwards.net/blog/how-to-rate-limit-http-requests (MIT).
  1349. func (s *Server) visitor(r *http.Request) *visitor {
  1350. remoteAddr := r.RemoteAddr
  1351. ip, _, err := net.SplitHostPort(remoteAddr)
  1352. if err != nil {
  1353. ip = remoteAddr // This should not happen in real life; only in tests.
  1354. }
  1355. if s.config.BehindProxy && strings.TrimSpace(r.Header.Get("X-Forwarded-For")) != "" {
  1356. // X-Forwarded-For can contain multiple addresses (see #328). If we are behind a proxy,
  1357. // only the right-most address can be trusted (as this is the one added by our proxy server).
  1358. // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For for details.
  1359. ips := util.SplitNoEmpty(r.Header.Get("X-Forwarded-For"), ",")
  1360. ip = strings.TrimSpace(util.LastString(ips, remoteAddr))
  1361. }
  1362. return s.visitorFromIP(ip)
  1363. }
  1364. func (s *Server) visitorFromIP(ip string) *visitor {
  1365. s.mu.Lock()
  1366. defer s.mu.Unlock()
  1367. v, exists := s.visitors[ip]
  1368. if !exists {
  1369. s.visitors[ip] = newVisitor(s.config, s.messageCache, ip)
  1370. return s.visitors[ip]
  1371. }
  1372. v.Keepalive()
  1373. return v
  1374. }