server.go 51 KB

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