server.go 47 KB

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