server.go 53 KB

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