server.go 51 KB

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