server.go 55 KB

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