server.go 51 KB

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