server_test.go 98 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739
  1. package server
  2. import (
  3. "bufio"
  4. "context"
  5. "encoding/base64"
  6. "encoding/json"
  7. "fmt"
  8. "golang.org/x/crypto/bcrypt"
  9. "heckel.io/ntfy/user"
  10. "io"
  11. "math/rand"
  12. "net/http"
  13. "net/http/httptest"
  14. "net/netip"
  15. "os"
  16. "path/filepath"
  17. "runtime/debug"
  18. "strings"
  19. "sync"
  20. "sync/atomic"
  21. "testing"
  22. "time"
  23. "github.com/SherClockHolmes/webpush-go"
  24. "github.com/stretchr/testify/require"
  25. "heckel.io/ntfy/log"
  26. "heckel.io/ntfy/util"
  27. )
  28. func TestMain(m *testing.M) {
  29. log.SetLevel(log.ErrorLevel)
  30. os.Exit(m.Run())
  31. }
  32. func TestServer_PublishAndPoll(t *testing.T) {
  33. s := newTestServer(t, newTestConfig(t))
  34. response1 := request(t, s, "PUT", "/mytopic", "my first message", nil)
  35. msg1 := toMessage(t, response1.Body.String())
  36. require.NotEmpty(t, msg1.ID)
  37. require.Equal(t, "my first message", msg1.Message)
  38. response2 := request(t, s, "PUT", "/mytopic", "my second\n\nmessage", nil)
  39. msg2 := toMessage(t, response2.Body.String())
  40. require.NotEqual(t, msg1.ID, msg2.ID)
  41. require.NotEmpty(t, msg2.ID)
  42. require.Equal(t, "my second\n\nmessage", msg2.Message)
  43. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  44. messages := toMessages(t, response.Body.String())
  45. require.Equal(t, 2, len(messages))
  46. require.Equal(t, "my first message", messages[0].Message)
  47. require.Equal(t, "my second\n\nmessage", messages[1].Message)
  48. response = request(t, s, "GET", "/mytopic/sse?poll=1&since=all", "", nil)
  49. lines := strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  50. require.Equal(t, 3, len(lines))
  51. require.Equal(t, "my first message", toMessage(t, strings.TrimPrefix(lines[0], "data: ")).Message)
  52. require.Equal(t, "", lines[1])
  53. require.Equal(t, "my second\n\nmessage", toMessage(t, strings.TrimPrefix(lines[2], "data: ")).Message)
  54. response = request(t, s, "GET", "/mytopic/raw?poll=1", "", nil)
  55. lines = strings.Split(strings.TrimSpace(response.Body.String()), "\n")
  56. require.Equal(t, 2, len(lines))
  57. require.Equal(t, "my first message", lines[0])
  58. require.Equal(t, "my second message", lines[1]) // \n -> " "
  59. }
  60. func TestServer_PublishWithFirebase(t *testing.T) {
  61. sender := newTestFirebaseSender(10)
  62. s := newTestServer(t, newTestConfig(t))
  63. s.firebaseClient = newFirebaseClient(sender, &testAuther{Allow: true})
  64. response := request(t, s, "PUT", "/mytopic", "my first message", nil)
  65. msg1 := toMessage(t, response.Body.String())
  66. require.NotEmpty(t, msg1.ID)
  67. require.Equal(t, "my first message", msg1.Message)
  68. time.Sleep(100 * time.Millisecond) // Firebase publishing happens
  69. require.Equal(t, 1, len(sender.Messages()))
  70. require.Equal(t, "my first message", sender.Messages()[0].Data["message"])
  71. require.Equal(t, "my first message", sender.Messages()[0].APNS.Payload.Aps.Alert.Body)
  72. require.Equal(t, "my first message", sender.Messages()[0].APNS.Payload.CustomData["message"])
  73. }
  74. func TestServer_PublishWithFirebase_WithoutUsers_AndWithoutPanic(t *testing.T) {
  75. // This tests issue #641, which used to panic before the fix
  76. firebaseKeyFile := filepath.Join(t.TempDir(), "firebase.json")
  77. contents := `{
  78. "type": "service_account",
  79. "project_id": "ntfy-test",
  80. "private_key_id": "fsfhskjdfhskdhfskdjfhsdf",
  81. "private_key": "lalala",
  82. "client_email": "firebase-adminsdk-muv04@ntfy-test.iam.gserviceaccount.com",
  83. "client_id": "123123213",
  84. "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  85. "token_uri": "https://oauth2.googleapis.com/token",
  86. "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  87. "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/firebase-adminsdk-muv04%40ntfy-test.iam.gserviceaccount.com"
  88. }
  89. `
  90. require.Nil(t, os.WriteFile(firebaseKeyFile, []byte(contents), 0600))
  91. c := newTestConfig(t)
  92. c.FirebaseKeyFile = firebaseKeyFile
  93. s := newTestServer(t, c)
  94. response := request(t, s, "PUT", "/mytopic", "my first message", nil)
  95. require.Equal(t, "my first message", toMessage(t, response.Body.String()).Message)
  96. }
  97. func TestServer_SubscribeOpenAndKeepalive(t *testing.T) {
  98. t.Parallel()
  99. c := newTestConfig(t)
  100. c.KeepaliveInterval = time.Second
  101. s := newTestServer(t, c)
  102. rr := httptest.NewRecorder()
  103. ctx, cancel := context.WithCancel(context.Background())
  104. req, err := http.NewRequestWithContext(ctx, "GET", "/mytopic/json", nil)
  105. if err != nil {
  106. t.Fatal(err)
  107. }
  108. doneChan := make(chan bool)
  109. go func() {
  110. s.handle(rr, req)
  111. doneChan <- true
  112. }()
  113. time.Sleep(1300 * time.Millisecond)
  114. cancel()
  115. <-doneChan
  116. messages := toMessages(t, rr.Body.String())
  117. require.Equal(t, 2, len(messages))
  118. require.Equal(t, openEvent, messages[0].Event)
  119. require.Equal(t, "mytopic", messages[0].Topic)
  120. require.Equal(t, "", messages[0].Message)
  121. require.Equal(t, "", messages[0].Title)
  122. require.Equal(t, 0, messages[0].Priority)
  123. require.Nil(t, messages[0].Tags)
  124. require.Equal(t, keepaliveEvent, messages[1].Event)
  125. require.Equal(t, "mytopic", messages[1].Topic)
  126. require.Equal(t, "", messages[1].Message)
  127. require.Equal(t, "", messages[1].Title)
  128. require.Equal(t, 0, messages[1].Priority)
  129. require.Nil(t, messages[1].Tags)
  130. }
  131. func TestServer_PublishAndSubscribe(t *testing.T) {
  132. t.Parallel()
  133. s := newTestServer(t, newTestConfig(t))
  134. subscribeRR := httptest.NewRecorder()
  135. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  136. publishFirstRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  137. require.Equal(t, 200, publishFirstRR.Code)
  138. time.Sleep(500 * time.Millisecond) // Publishing is done asynchronously, this avoids races
  139. publishSecondRR := request(t, s, "PUT", "/mytopic", "my other message", map[string]string{
  140. "Title": " This is a title ",
  141. "X-Tags": "tag1,tag 2, tag3",
  142. "p": "1",
  143. })
  144. require.Equal(t, 200, publishSecondRR.Code)
  145. subscribeCancel()
  146. messages := toMessages(t, subscribeRR.Body.String())
  147. require.Equal(t, 3, len(messages))
  148. require.Equal(t, openEvent, messages[0].Event)
  149. require.Equal(t, messageEvent, messages[1].Event)
  150. require.Equal(t, "mytopic", messages[1].Topic)
  151. require.Equal(t, "my first message", messages[1].Message)
  152. require.Equal(t, "", messages[1].Title)
  153. require.Equal(t, 0, messages[1].Priority)
  154. require.Nil(t, messages[1].Tags)
  155. require.True(t, time.Now().Add(12*time.Hour-5*time.Second).Unix() < messages[1].Expires)
  156. require.True(t, time.Now().Add(12*time.Hour+5*time.Second).Unix() > messages[1].Expires)
  157. require.Equal(t, messageEvent, messages[2].Event)
  158. require.Equal(t, "mytopic", messages[2].Topic)
  159. require.Equal(t, "my other message", messages[2].Message)
  160. require.Equal(t, "This is a title", messages[2].Title)
  161. require.Equal(t, 1, messages[2].Priority)
  162. require.Equal(t, []string{"tag1", "tag 2", "tag3"}, messages[2].Tags)
  163. }
  164. func TestServer_Publish_Disallowed_Topic(t *testing.T) {
  165. c := newTestConfig(t)
  166. c.DisallowedTopics = []string{"about", "time", "this", "got", "added"}
  167. s := newTestServer(t, c)
  168. rr := request(t, s, "PUT", "/mytopic", "my first message", nil)
  169. require.Equal(t, 200, rr.Code)
  170. rr = request(t, s, "PUT", "/about", "another message", nil)
  171. require.Equal(t, 400, rr.Code)
  172. require.Equal(t, 40010, toHTTPError(t, rr.Body.String()).Code)
  173. }
  174. func TestServer_StaticSites(t *testing.T) {
  175. s := newTestServer(t, newTestConfig(t))
  176. rr := request(t, s, "GET", "/", "", nil)
  177. require.Equal(t, 200, rr.Code)
  178. require.Contains(t, rr.Body.String(), "</html>")
  179. rr = request(t, s, "HEAD", "/", "", nil)
  180. require.Equal(t, 200, rr.Code)
  181. rr = request(t, s, "OPTIONS", "/", "", nil)
  182. require.Equal(t, 200, rr.Code)
  183. rr = request(t, s, "GET", "/does-not-exist.txt", "", nil)
  184. require.Equal(t, 404, rr.Code)
  185. rr = request(t, s, "GET", "/mytopic", "", nil)
  186. require.Equal(t, 200, rr.Code)
  187. require.Contains(t, rr.Body.String(), `<meta name="robots" content="noindex, nofollow" />`)
  188. rr = request(t, s, "GET", "/docs", "", nil)
  189. require.Equal(t, 301, rr.Code)
  190. // Docs test removed, it was failing annoyingly.
  191. }
  192. func TestServer_WebEnabled(t *testing.T) {
  193. conf := newTestConfig(t)
  194. conf.WebRoot = "" // Disable web app
  195. s := newTestServer(t, conf)
  196. rr := request(t, s, "GET", "/", "", nil)
  197. require.Equal(t, 404, rr.Code)
  198. rr = request(t, s, "GET", "/config.js", "", nil)
  199. require.Equal(t, 404, rr.Code)
  200. rr = request(t, s, "GET", "/sw.js", "", nil)
  201. require.Equal(t, 404, rr.Code)
  202. rr = request(t, s, "GET", "/app.html", "", nil)
  203. require.Equal(t, 404, rr.Code)
  204. rr = request(t, s, "GET", "/static/css/home.css", "", nil)
  205. require.Equal(t, 404, rr.Code)
  206. conf2 := newTestConfig(t)
  207. conf2.WebRoot = "/"
  208. s2 := newTestServer(t, conf2)
  209. rr = request(t, s2, "GET", "/", "", nil)
  210. require.Equal(t, 200, rr.Code)
  211. rr = request(t, s2, "GET", "/config.js", "", nil)
  212. require.Equal(t, 200, rr.Code)
  213. rr = request(t, s2, "GET", "/sw.js", "", nil)
  214. require.Equal(t, 200, rr.Code)
  215. rr = request(t, s2, "GET", "/app.html", "", nil)
  216. require.Equal(t, 200, rr.Code)
  217. }
  218. func TestServer_WebPushEnabled(t *testing.T) {
  219. conf := newTestConfig(t)
  220. conf.WebRoot = "" // Disable web app
  221. s := newTestServer(t, conf)
  222. rr := request(t, s, "GET", "/manifest.webmanifest", "", nil)
  223. require.Equal(t, 404, rr.Code)
  224. conf2 := newTestConfig(t)
  225. s2 := newTestServer(t, conf2)
  226. rr = request(t, s2, "GET", "/manifest.webmanifest", "", nil)
  227. require.Equal(t, 404, rr.Code)
  228. conf3 := newTestConfigWithWebPush(t)
  229. s3 := newTestServer(t, conf3)
  230. rr = request(t, s3, "GET", "/manifest.webmanifest", "", nil)
  231. require.Equal(t, 200, rr.Code)
  232. require.Equal(t, "application/manifest+json", rr.Header().Get("Content-Type"))
  233. }
  234. func TestServer_PublishLargeMessage(t *testing.T) {
  235. c := newTestConfig(t)
  236. c.AttachmentCacheDir = "" // Disable attachments
  237. s := newTestServer(t, c)
  238. body := strings.Repeat("this is a large message", 5000)
  239. response := request(t, s, "PUT", "/mytopic", body, nil)
  240. require.Equal(t, 400, response.Code)
  241. }
  242. func TestServer_PublishPriority(t *testing.T) {
  243. s := newTestServer(t, newTestConfig(t))
  244. for prio := 1; prio <= 5; prio++ {
  245. response := request(t, s, "GET", fmt.Sprintf("/mytopic/publish?priority=%d", prio), fmt.Sprintf("priority %d", prio), nil)
  246. msg := toMessage(t, response.Body.String())
  247. require.Equal(t, prio, msg.Priority)
  248. }
  249. response := request(t, s, "GET", "/mytopic/publish?priority=min", "test", nil)
  250. require.Equal(t, 1, toMessage(t, response.Body.String()).Priority)
  251. response = request(t, s, "GET", "/mytopic/send?priority=low", "test", nil)
  252. require.Equal(t, 2, toMessage(t, response.Body.String()).Priority)
  253. response = request(t, s, "GET", "/mytopic/send?priority=default", "test", nil)
  254. require.Equal(t, 3, toMessage(t, response.Body.String()).Priority)
  255. response = request(t, s, "GET", "/mytopic/send?priority=high", "test", nil)
  256. require.Equal(t, 4, toMessage(t, response.Body.String()).Priority)
  257. response = request(t, s, "GET", "/mytopic/send?priority=max", "test", nil)
  258. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  259. response = request(t, s, "GET", "/mytopic/trigger?priority=urgent", "test", nil)
  260. require.Equal(t, 5, toMessage(t, response.Body.String()).Priority)
  261. response = request(t, s, "GET", "/mytopic/trigger?priority=INVALID", "test", nil)
  262. require.Equal(t, 40007, toHTTPError(t, response.Body.String()).Code)
  263. }
  264. func TestServer_PublishGETOnlyOneTopic(t *testing.T) {
  265. // This tests a bug that allowed publishing topics with a comma in the name (no ticket)
  266. s := newTestServer(t, newTestConfig(t))
  267. response := request(t, s, "GET", "/mytopic,mytopic2/publish?m=hi", "", nil)
  268. require.Equal(t, 404, response.Code)
  269. }
  270. func TestServer_PublishNoCache(t *testing.T) {
  271. s := newTestServer(t, newTestConfig(t))
  272. response := request(t, s, "PUT", "/mytopic", "this message is not cached", map[string]string{
  273. "Cache": "no",
  274. })
  275. msg := toMessage(t, response.Body.String())
  276. require.NotEmpty(t, msg.ID)
  277. require.Equal(t, "this message is not cached", msg.Message)
  278. require.Equal(t, int64(0), msg.Expires)
  279. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  280. messages := toMessages(t, response.Body.String())
  281. require.Empty(t, messages)
  282. }
  283. func TestServer_PublishAt(t *testing.T) {
  284. t.Parallel()
  285. s := newTestServer(t, newTestConfig(t))
  286. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  287. "In": "1h",
  288. })
  289. require.Equal(t, 200, response.Code)
  290. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  291. messages := toMessages(t, response.Body.String())
  292. require.Equal(t, 0, len(messages))
  293. // Update message time to the past
  294. fakeTime := time.Now().Add(-10 * time.Second).Unix()
  295. _, err := s.messageCache.db.Exec(`UPDATE messages SET time=?`, fakeTime)
  296. require.Nil(t, err)
  297. // Trigger delayed message sending
  298. require.Nil(t, s.sendDelayedMessages())
  299. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  300. messages = toMessages(t, response.Body.String())
  301. require.Equal(t, 1, len(messages))
  302. require.Equal(t, "a message", messages[0].Message)
  303. require.Equal(t, netip.Addr{}, messages[0].Sender) // Never return the sender!
  304. messages, err = s.messageCache.Messages("mytopic", sinceAllMessages, true)
  305. require.Nil(t, err)
  306. require.Equal(t, 1, len(messages))
  307. require.Equal(t, "a message", messages[0].Message)
  308. require.Equal(t, "9.9.9.9", messages[0].Sender.String()) // It's stored in the DB though!
  309. }
  310. func TestServer_PublishAt_FromUser(t *testing.T) {
  311. t.Parallel()
  312. s := newTestServer(t, newTestConfigWithAuthFile(t))
  313. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleAdmin))
  314. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  315. "Authorization": util.BasicAuth("phil", "phil"),
  316. "In": "1h",
  317. })
  318. require.Equal(t, 200, response.Code)
  319. // Message doesn't show up immediately
  320. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  321. messages := toMessages(t, response.Body.String())
  322. require.Equal(t, 0, len(messages))
  323. // Update message time to the past
  324. fakeTime := time.Now().Add(-10 * time.Second).Unix()
  325. _, err := s.messageCache.db.Exec(`UPDATE messages SET time=?`, fakeTime)
  326. require.Nil(t, err)
  327. // Trigger delayed message sending
  328. require.Nil(t, s.sendDelayedMessages())
  329. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  330. messages = toMessages(t, response.Body.String())
  331. require.Equal(t, 1, len(messages))
  332. require.Equal(t, fakeTime, messages[0].Time)
  333. require.Equal(t, "a message", messages[0].Message)
  334. messages, err = s.messageCache.Messages("mytopic", sinceAllMessages, true)
  335. require.Nil(t, err)
  336. require.Equal(t, 1, len(messages))
  337. require.Equal(t, "a message", messages[0].Message)
  338. require.True(t, strings.HasPrefix(messages[0].User, "u_"))
  339. }
  340. func TestServer_PublishAt_Expires(t *testing.T) {
  341. s := newTestServer(t, newTestConfig(t))
  342. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  343. "In": "2 days",
  344. })
  345. require.Equal(t, 200, response.Code)
  346. m := toMessage(t, response.Body.String())
  347. require.True(t, m.Expires > time.Now().Add(12*time.Hour+48*time.Hour-time.Minute).Unix())
  348. require.True(t, m.Expires < time.Now().Add(12*time.Hour+48*time.Hour+time.Minute).Unix())
  349. }
  350. func TestServer_PublishAtWithCacheError(t *testing.T) {
  351. s := newTestServer(t, newTestConfig(t))
  352. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  353. "Cache": "no",
  354. "In": "30 min",
  355. })
  356. require.Equal(t, 400, response.Code)
  357. require.Equal(t, errHTTPBadRequestDelayNoCache, toHTTPError(t, response.Body.String()))
  358. }
  359. func TestServer_PublishAtTooShortDelay(t *testing.T) {
  360. s := newTestServer(t, newTestConfig(t))
  361. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  362. "In": "1s",
  363. })
  364. require.Equal(t, 400, response.Code)
  365. }
  366. func TestServer_PublishAtTooLongDelay(t *testing.T) {
  367. s := newTestServer(t, newTestConfig(t))
  368. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  369. "In": "99999999h",
  370. })
  371. require.Equal(t, 400, response.Code)
  372. }
  373. func TestServer_PublishAtInvalidDelay(t *testing.T) {
  374. s := newTestServer(t, newTestConfig(t))
  375. response := request(t, s, "PUT", "/mytopic?delay=INVALID", "a message", nil)
  376. err := toHTTPError(t, response.Body.String())
  377. require.Equal(t, 400, response.Code)
  378. require.Equal(t, 40004, err.Code)
  379. }
  380. func TestServer_PublishAtTooLarge(t *testing.T) {
  381. s := newTestServer(t, newTestConfig(t))
  382. response := request(t, s, "PUT", "/mytopic?x-in=99999h", "a message", nil)
  383. err := toHTTPError(t, response.Body.String())
  384. require.Equal(t, 400, response.Code)
  385. require.Equal(t, 40006, err.Code)
  386. }
  387. func TestServer_PublishAtAndPrune(t *testing.T) {
  388. s := newTestServer(t, newTestConfig(t))
  389. response := request(t, s, "PUT", "/mytopic", "a message", map[string]string{
  390. "In": "1h",
  391. })
  392. require.Equal(t, 200, response.Code)
  393. s.execManager() // Fire pruning
  394. response = request(t, s, "GET", "/mytopic/json?poll=1&scheduled=1", "", nil)
  395. messages := toMessages(t, response.Body.String())
  396. require.Equal(t, 1, len(messages)) // Not affected by pruning
  397. require.Equal(t, "a message", messages[0].Message)
  398. }
  399. func TestServer_PublishAndMultiPoll(t *testing.T) {
  400. s := newTestServer(t, newTestConfig(t))
  401. response := request(t, s, "PUT", "/mytopic1", "message 1", nil)
  402. msg := toMessage(t, response.Body.String())
  403. require.NotEmpty(t, msg.ID)
  404. require.Equal(t, "mytopic1", msg.Topic)
  405. require.Equal(t, "message 1", msg.Message)
  406. response = request(t, s, "PUT", "/mytopic2", "message 2", nil)
  407. msg = toMessage(t, response.Body.String())
  408. require.NotEmpty(t, msg.ID)
  409. require.Equal(t, "mytopic2", msg.Topic)
  410. require.Equal(t, "message 2", msg.Message)
  411. response = request(t, s, "GET", "/mytopic1/json?poll=1", "", nil)
  412. messages := toMessages(t, response.Body.String())
  413. require.Equal(t, 1, len(messages))
  414. require.Equal(t, "mytopic1", messages[0].Topic)
  415. require.Equal(t, "message 1", messages[0].Message)
  416. response = request(t, s, "GET", "/mytopic1,mytopic2/json?poll=1", "", nil)
  417. messages = toMessages(t, response.Body.String())
  418. require.Equal(t, 2, len(messages))
  419. require.Equal(t, "mytopic1", messages[0].Topic)
  420. require.Equal(t, "message 1", messages[0].Message)
  421. require.Equal(t, "mytopic2", messages[1].Topic)
  422. require.Equal(t, "message 2", messages[1].Message)
  423. }
  424. func TestServer_PublishWithNopCache(t *testing.T) {
  425. c := newTestConfig(t)
  426. c.CacheDuration = 0
  427. s := newTestServer(t, c)
  428. subscribeRR := httptest.NewRecorder()
  429. subscribeCancel := subscribe(t, s, "/mytopic/json", subscribeRR)
  430. publishRR := request(t, s, "PUT", "/mytopic", "my first message", nil)
  431. require.Equal(t, 200, publishRR.Code)
  432. subscribeCancel()
  433. messages := toMessages(t, subscribeRR.Body.String())
  434. require.Equal(t, 2, len(messages))
  435. require.Equal(t, openEvent, messages[0].Event)
  436. require.Equal(t, messageEvent, messages[1].Event)
  437. require.Equal(t, "my first message", messages[1].Message)
  438. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  439. messages = toMessages(t, response.Body.String())
  440. require.Empty(t, messages)
  441. }
  442. func TestServer_PublishAndPollSince(t *testing.T) {
  443. t.Parallel()
  444. s := newTestServer(t, newTestConfig(t))
  445. request(t, s, "PUT", "/mytopic", "test 1", nil)
  446. time.Sleep(1100 * time.Millisecond)
  447. since := time.Now().Unix()
  448. request(t, s, "PUT", "/mytopic", "test 2", nil)
  449. response := request(t, s, "GET", fmt.Sprintf("/mytopic/json?poll=1&since=%d", since), "", nil)
  450. messages := toMessages(t, response.Body.String())
  451. require.Equal(t, 1, len(messages))
  452. require.Equal(t, "test 2", messages[0].Message)
  453. response = request(t, s, "GET", "/mytopic/json?poll=1&since=10s", "", nil)
  454. messages = toMessages(t, response.Body.String())
  455. require.Equal(t, 2, len(messages))
  456. require.Equal(t, "test 1", messages[0].Message)
  457. response = request(t, s, "GET", "/mytopic/json?poll=1&since=100ms", "", nil)
  458. messages = toMessages(t, response.Body.String())
  459. require.Equal(t, 1, len(messages))
  460. require.Equal(t, "test 2", messages[0].Message)
  461. response = request(t, s, "GET", "/mytopic/json?poll=1&since=INVALID", "", nil)
  462. require.Equal(t, 40008, toHTTPError(t, response.Body.String()).Code)
  463. }
  464. func newMessageWithTimestamp(topic, message string, timestamp int64) *message {
  465. m := newDefaultMessage(topic, message)
  466. m.Time = timestamp
  467. return m
  468. }
  469. func TestServer_PollSinceID_MultipleTopics(t *testing.T) {
  470. s := newTestServer(t, newTestConfig(t))
  471. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 1", 1655740277)))
  472. markerMessage := newMessageWithTimestamp("mytopic2", "test 2", 1655740283)
  473. require.Nil(t, s.messageCache.AddMessage(markerMessage))
  474. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 3", 1655740289)))
  475. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic2", "test 4", 1655740293)))
  476. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 5", 1655740297)))
  477. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic2", "test 6", 1655740303)))
  478. response := request(t, s, "GET", fmt.Sprintf("/mytopic1,mytopic2/json?poll=1&since=%s", markerMessage.ID), "", nil)
  479. messages := toMessages(t, response.Body.String())
  480. require.Equal(t, 4, len(messages))
  481. require.Equal(t, "test 3", messages[0].Message)
  482. require.Equal(t, "mytopic1", messages[0].Topic)
  483. require.Equal(t, "test 4", messages[1].Message)
  484. require.Equal(t, "mytopic2", messages[1].Topic)
  485. require.Equal(t, "test 5", messages[2].Message)
  486. require.Equal(t, "mytopic1", messages[2].Topic)
  487. require.Equal(t, "test 6", messages[3].Message)
  488. require.Equal(t, "mytopic2", messages[3].Topic)
  489. }
  490. func TestServer_PollSinceID_MultipleTopics_IDDoesNotMatch(t *testing.T) {
  491. s := newTestServer(t, newTestConfig(t))
  492. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 3", 1655740289)))
  493. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic2", "test 4", 1655740293)))
  494. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic1", "test 5", 1655740297)))
  495. require.Nil(t, s.messageCache.AddMessage(newMessageWithTimestamp("mytopic2", "test 6", 1655740303)))
  496. response := request(t, s, "GET", "/mytopic1,mytopic2/json?poll=1&since=NoMatchForID", "", nil)
  497. messages := toMessages(t, response.Body.String())
  498. require.Equal(t, 4, len(messages))
  499. require.Equal(t, "test 3", messages[0].Message)
  500. require.Equal(t, "test 4", messages[1].Message)
  501. require.Equal(t, "test 5", messages[2].Message)
  502. require.Equal(t, "test 6", messages[3].Message)
  503. }
  504. func TestServer_PublishViaGET(t *testing.T) {
  505. s := newTestServer(t, newTestConfig(t))
  506. response := request(t, s, "GET", "/mytopic/trigger", "", nil)
  507. msg := toMessage(t, response.Body.String())
  508. require.NotEmpty(t, msg.ID)
  509. require.Equal(t, "triggered", msg.Message)
  510. response = request(t, s, "GET", "/mytopic/send?message=This+is+a+test&t=This+is+a+title&tags=skull&x-priority=5&delay=24h", "", nil)
  511. msg = toMessage(t, response.Body.String())
  512. require.NotEmpty(t, msg.ID)
  513. require.Equal(t, "This is a test", msg.Message)
  514. require.Equal(t, "This is a title", msg.Title)
  515. require.Equal(t, []string{"skull"}, msg.Tags)
  516. require.Equal(t, 5, msg.Priority)
  517. require.Greater(t, msg.Time, time.Now().Add(23*time.Hour).Unix())
  518. }
  519. func TestServer_PublishMessageInHeaderWithNewlines(t *testing.T) {
  520. s := newTestServer(t, newTestConfig(t))
  521. response := request(t, s, "PUT", "/mytopic", "", map[string]string{
  522. "Message": "Line 1\\nLine 2",
  523. })
  524. msg := toMessage(t, response.Body.String())
  525. require.NotEmpty(t, msg.ID)
  526. require.Equal(t, "Line 1\nLine 2", msg.Message) // \\n -> \n !
  527. }
  528. func TestServer_PublishInvalidTopic(t *testing.T) {
  529. s := newTestServer(t, newTestConfig(t))
  530. s.smtpSender = &testMailer{}
  531. response := request(t, s, "PUT", "/docs", "fail", nil)
  532. require.Equal(t, 40010, toHTTPError(t, response.Body.String()).Code)
  533. }
  534. func TestServer_PollWithQueryFilters(t *testing.T) {
  535. s := newTestServer(t, newTestConfig(t))
  536. response := request(t, s, "PUT", "/mytopic?priority=1&tags=tag1,tag2", "my first message", nil)
  537. msg := toMessage(t, response.Body.String())
  538. require.NotEmpty(t, msg.ID)
  539. response = request(t, s, "PUT", "/mytopic?title=a+title", "my second message", map[string]string{
  540. "Tags": "tag2,tag3",
  541. })
  542. msg = toMessage(t, response.Body.String())
  543. require.NotEmpty(t, msg.ID)
  544. queriesThatShouldReturnMessageOne := []string{
  545. "/mytopic/json?poll=1&priority=1",
  546. "/mytopic/json?poll=1&priority=min",
  547. "/mytopic/json?poll=1&priority=min,low",
  548. "/mytopic/json?poll=1&priority=1,2",
  549. "/mytopic/json?poll=1&p=2,min",
  550. "/mytopic/json?poll=1&tags=tag1",
  551. "/mytopic/json?poll=1&tags=tag1,tag2",
  552. "/mytopic/json?poll=1&message=my+first+message",
  553. }
  554. for _, query := range queriesThatShouldReturnMessageOne {
  555. response = request(t, s, "GET", query, "", nil)
  556. messages := toMessages(t, response.Body.String())
  557. require.Equal(t, 1, len(messages), "Query failed: "+query)
  558. require.Equal(t, "my first message", messages[0].Message, "Query failed: "+query)
  559. }
  560. queriesThatShouldReturnMessageTwo := []string{
  561. "/mytopic/json?poll=1&x-priority=3", // !
  562. "/mytopic/json?poll=1&priority=3",
  563. "/mytopic/json?poll=1&priority=default",
  564. "/mytopic/json?poll=1&p=3",
  565. "/mytopic/json?poll=1&x-tags=tag2,tag3",
  566. "/mytopic/json?poll=1&tags=tag2,tag3",
  567. "/mytopic/json?poll=1&tag=tag2,tag3",
  568. "/mytopic/json?poll=1&ta=tag2,tag3",
  569. "/mytopic/json?poll=1&x-title=a+title",
  570. "/mytopic/json?poll=1&title=a+title",
  571. "/mytopic/json?poll=1&t=a+title",
  572. "/mytopic/json?poll=1&x-message=my+second+message",
  573. "/mytopic/json?poll=1&message=my+second+message",
  574. "/mytopic/json?poll=1&m=my+second+message",
  575. "/mytopic/json?x-poll=1&m=my+second+message",
  576. "/mytopic/json?po=1&m=my+second+message",
  577. }
  578. for _, query := range queriesThatShouldReturnMessageTwo {
  579. response = request(t, s, "GET", query, "", nil)
  580. messages := toMessages(t, response.Body.String())
  581. require.Equal(t, 1, len(messages), "Query failed: "+query)
  582. require.Equal(t, "my second message", messages[0].Message, "Query failed: "+query)
  583. }
  584. queriesThatShouldReturnNoMessages := []string{
  585. "/mytopic/json?poll=1&priority=4",
  586. "/mytopic/json?poll=1&tags=tag1,tag2,tag3",
  587. "/mytopic/json?poll=1&title=another+title",
  588. "/mytopic/json?poll=1&message=my+third+message",
  589. "/mytopic/json?poll=1&message=my+third+message",
  590. }
  591. for _, query := range queriesThatShouldReturnNoMessages {
  592. response = request(t, s, "GET", query, "", nil)
  593. messages := toMessages(t, response.Body.String())
  594. require.Equal(t, 0, len(messages), "Query failed: "+query)
  595. }
  596. }
  597. func TestServer_SubscribeWithQueryFilters(t *testing.T) {
  598. t.Parallel()
  599. c := newTestConfig(t)
  600. c.KeepaliveInterval = 800 * time.Millisecond
  601. s := newTestServer(t, c)
  602. subscribeResponse := httptest.NewRecorder()
  603. subscribeCancel := subscribe(t, s, "/mytopic/json?tags=zfs-issue", subscribeResponse)
  604. response := request(t, s, "PUT", "/mytopic", "my first message", nil)
  605. require.Equal(t, 200, response.Code)
  606. response = request(t, s, "PUT", "/mytopic", "ZFS scrub failed", map[string]string{
  607. "Tags": "zfs-issue,zfs-scrub",
  608. })
  609. require.Equal(t, 200, response.Code)
  610. time.Sleep(850 * time.Millisecond)
  611. subscribeCancel()
  612. messages := toMessages(t, subscribeResponse.Body.String())
  613. require.Equal(t, 3, len(messages))
  614. require.Equal(t, openEvent, messages[0].Event)
  615. require.Equal(t, messageEvent, messages[1].Event)
  616. require.Equal(t, "ZFS scrub failed", messages[1].Message)
  617. require.Equal(t, keepaliveEvent, messages[2].Event)
  618. }
  619. func TestServer_Auth_Success_Admin(t *testing.T) {
  620. c := newTestConfigWithAuthFile(t)
  621. s := newTestServer(t, c)
  622. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleAdmin))
  623. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  624. "Authorization": util.BasicAuth("phil", "phil"),
  625. })
  626. require.Equal(t, 200, response.Code)
  627. require.Equal(t, `{"success":true}`+"\n", response.Body.String())
  628. }
  629. func TestServer_Auth_Success_User(t *testing.T) {
  630. c := newTestConfigWithAuthFile(t)
  631. c.AuthDefault = user.PermissionDenyAll
  632. s := newTestServer(t, c)
  633. require.Nil(t, s.userManager.AddUser("ben", "ben", user.RoleUser))
  634. require.Nil(t, s.userManager.AllowAccess("ben", "mytopic", user.PermissionReadWrite))
  635. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  636. "Authorization": util.BasicAuth("ben", "ben"),
  637. })
  638. require.Equal(t, 200, response.Code)
  639. }
  640. func TestServer_Auth_Success_User_MultipleTopics(t *testing.T) {
  641. c := newTestConfigWithAuthFile(t)
  642. c.AuthDefault = user.PermissionDenyAll
  643. s := newTestServer(t, c)
  644. require.Nil(t, s.userManager.AddUser("ben", "ben", user.RoleUser))
  645. require.Nil(t, s.userManager.AllowAccess("ben", "mytopic", user.PermissionReadWrite))
  646. require.Nil(t, s.userManager.AllowAccess("ben", "anothertopic", user.PermissionReadWrite))
  647. response := request(t, s, "GET", "/mytopic,anothertopic/auth", "", map[string]string{
  648. "Authorization": util.BasicAuth("ben", "ben"),
  649. })
  650. require.Equal(t, 200, response.Code)
  651. response = request(t, s, "GET", "/mytopic,anothertopic,NOT-THIS-ONE/auth", "", map[string]string{
  652. "Authorization": util.BasicAuth("ben", "ben"),
  653. })
  654. require.Equal(t, 403, response.Code)
  655. }
  656. func TestServer_Auth_Fail_InvalidPass(t *testing.T) {
  657. c := newTestConfig(t)
  658. c.AuthFile = filepath.Join(t.TempDir(), "user.db")
  659. c.AuthDefault = user.PermissionDenyAll
  660. s := newTestServer(t, c)
  661. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleAdmin))
  662. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  663. "Authorization": util.BasicAuth("phil", "INVALID"),
  664. })
  665. require.Equal(t, 401, response.Code)
  666. }
  667. func TestServer_Auth_Fail_Unauthorized(t *testing.T) {
  668. c := newTestConfigWithAuthFile(t)
  669. c.AuthDefault = user.PermissionDenyAll
  670. s := newTestServer(t, c)
  671. require.Nil(t, s.userManager.AddUser("ben", "ben", user.RoleUser))
  672. require.Nil(t, s.userManager.AllowAccess("ben", "sometopic", user.PermissionReadWrite)) // Not mytopic!
  673. response := request(t, s, "GET", "/mytopic/auth", "", map[string]string{
  674. "Authorization": util.BasicAuth("ben", "ben"),
  675. })
  676. require.Equal(t, 403, response.Code)
  677. }
  678. func TestServer_Auth_Fail_CannotPublish(t *testing.T) {
  679. c := newTestConfigWithAuthFile(t)
  680. c.AuthDefault = user.PermissionReadWrite // Open by default
  681. s := newTestServer(t, c)
  682. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleAdmin))
  683. require.Nil(t, s.userManager.AllowAccess(user.Everyone, "private", user.PermissionDenyAll))
  684. require.Nil(t, s.userManager.AllowAccess(user.Everyone, "announcements", user.PermissionRead))
  685. response := request(t, s, "PUT", "/mytopic", "test", nil)
  686. require.Equal(t, 200, response.Code)
  687. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  688. require.Equal(t, 200, response.Code)
  689. response = request(t, s, "PUT", "/announcements", "test", nil)
  690. require.Equal(t, 403, response.Code) // Cannot write as anonymous
  691. response = request(t, s, "PUT", "/announcements", "test", map[string]string{
  692. "Authorization": util.BasicAuth("phil", "phil"),
  693. })
  694. require.Equal(t, 200, response.Code)
  695. response = request(t, s, "GET", "/announcements/json?poll=1", "", nil)
  696. require.Equal(t, 200, response.Code) // Anonymous read allowed
  697. response = request(t, s, "GET", "/private/json?poll=1", "", nil)
  698. require.Equal(t, 403, response.Code) // Anonymous read not allowed
  699. }
  700. func TestServer_Auth_Fail_Rate_Limiting(t *testing.T) {
  701. c := newTestConfigWithAuthFile(t)
  702. c.VisitorAuthFailureLimitBurst = 10
  703. s := newTestServer(t, c)
  704. for i := 0; i < 10; i++ {
  705. response := request(t, s, "PUT", "/announcements", "test", map[string]string{
  706. "Authorization": util.BasicAuth("phil", "phil"),
  707. })
  708. require.Equal(t, 401, response.Code)
  709. }
  710. response := request(t, s, "PUT", "/announcements", "test", map[string]string{
  711. "Authorization": util.BasicAuth("phil", "phil"),
  712. })
  713. require.Equal(t, 429, response.Code)
  714. require.Equal(t, 42909, toHTTPError(t, response.Body.String()).Code)
  715. }
  716. func TestServer_Auth_ViaQuery(t *testing.T) {
  717. c := newTestConfigWithAuthFile(t)
  718. c.AuthDefault = user.PermissionDenyAll
  719. s := newTestServer(t, c)
  720. require.Nil(t, s.userManager.AddUser("ben", "some pass", user.RoleAdmin))
  721. u := fmt.Sprintf("/mytopic/json?poll=1&auth=%s", base64.RawURLEncoding.EncodeToString([]byte(util.BasicAuth("ben", "some pass"))))
  722. response := request(t, s, "GET", u, "", nil)
  723. require.Equal(t, 200, response.Code)
  724. u = fmt.Sprintf("/mytopic/json?poll=1&auth=%s", base64.RawURLEncoding.EncodeToString([]byte(util.BasicAuth("ben", "WRONNNGGGG"))))
  725. response = request(t, s, "GET", u, "", nil)
  726. require.Equal(t, 401, response.Code)
  727. }
  728. func TestServer_Auth_NonBasicHeader(t *testing.T) {
  729. s := newTestServer(t, newTestConfigWithAuthFile(t))
  730. response := request(t, s, "PUT", "/mytopic", "test", map[string]string{
  731. "Authorization": "WebPush not-supported",
  732. })
  733. require.Equal(t, 200, response.Code)
  734. response = request(t, s, "PUT", "/mytopic", "test", map[string]string{
  735. "Authorization": "Bearer supported",
  736. })
  737. require.Equal(t, 401, response.Code)
  738. response = request(t, s, "PUT", "/mytopic", "test", map[string]string{
  739. "Authorization": "basic supported",
  740. })
  741. require.Equal(t, 401, response.Code)
  742. }
  743. func TestServer_StatsResetter(t *testing.T) {
  744. t.Parallel()
  745. // This tests the stats resetter for
  746. // - an anonymous user
  747. // - a user without a tier (treated like the same as the anonymous user)
  748. // - a user with a tier
  749. c := newTestConfigWithAuthFile(t)
  750. c.VisitorStatsResetTime = time.Now().Add(2 * time.Second)
  751. s := newTestServer(t, c)
  752. go s.runStatsResetter()
  753. // Create user with tier (tieruser) and user without tier (phil)
  754. require.Nil(t, s.userManager.AddTier(&user.Tier{
  755. Code: "test",
  756. MessageLimit: 5,
  757. MessageExpiryDuration: -5 * time.Second, // Second, what a hack!
  758. }))
  759. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  760. require.Nil(t, s.userManager.AddUser("tieruser", "tieruser", user.RoleUser))
  761. require.Nil(t, s.userManager.ChangeTier("tieruser", "test"))
  762. // Send an anonymous message
  763. response := request(t, s, "PUT", "/mytopic", "test", nil)
  764. require.Equal(t, 200, response.Code)
  765. // Send messages from user without tier (phil)
  766. for i := 0; i < 5; i++ {
  767. response := request(t, s, "PUT", "/mytopic", "test", map[string]string{
  768. "Authorization": util.BasicAuth("phil", "phil"),
  769. })
  770. require.Equal(t, 200, response.Code)
  771. }
  772. // Send messages from user with tier
  773. for i := 0; i < 2; i++ {
  774. response := request(t, s, "PUT", "/mytopic", "test", map[string]string{
  775. "Authorization": util.BasicAuth("tieruser", "tieruser"),
  776. })
  777. require.Equal(t, 200, response.Code)
  778. }
  779. // User stats show 6 messages (for user without tier)
  780. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  781. "Authorization": util.BasicAuth("phil", "phil"),
  782. })
  783. require.Equal(t, 200, response.Code)
  784. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  785. require.Nil(t, err)
  786. require.Equal(t, int64(6), account.Stats.Messages)
  787. // User stats show 6 messages (for anonymous visitor)
  788. response = request(t, s, "GET", "/v1/account", "", nil)
  789. require.Equal(t, 200, response.Code)
  790. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  791. require.Nil(t, err)
  792. require.Equal(t, int64(6), account.Stats.Messages)
  793. // User stats show 2 messages (for user with tier)
  794. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  795. "Authorization": util.BasicAuth("tieruser", "tieruser"),
  796. })
  797. require.Equal(t, 200, response.Code)
  798. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  799. require.Nil(t, err)
  800. require.Equal(t, int64(2), account.Stats.Messages)
  801. // Wait for stats resetter to run
  802. waitFor(t, func() bool {
  803. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  804. "Authorization": util.BasicAuth("phil", "phil"),
  805. })
  806. require.Equal(t, 200, response.Code)
  807. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  808. require.Nil(t, err)
  809. return account.Stats.Messages == 0
  810. })
  811. // User stats show 0 messages now!
  812. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  813. "Authorization": util.BasicAuth("phil", "phil"),
  814. })
  815. require.Equal(t, 200, response.Code)
  816. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  817. require.Nil(t, err)
  818. require.Equal(t, int64(0), account.Stats.Messages)
  819. // Since this is a user without a tier, the anonymous user should have the same stats
  820. response = request(t, s, "GET", "/v1/account", "", nil)
  821. require.Equal(t, 200, response.Code)
  822. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  823. require.Nil(t, err)
  824. require.Equal(t, int64(0), account.Stats.Messages)
  825. // User stats show 0 messages (for user with tier)
  826. response = request(t, s, "GET", "/v1/account", "", map[string]string{
  827. "Authorization": util.BasicAuth("tieruser", "tieruser"),
  828. })
  829. require.Equal(t, 200, response.Code)
  830. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  831. require.Nil(t, err)
  832. require.Equal(t, int64(0), account.Stats.Messages)
  833. }
  834. func TestServer_StatsResetter_MessageLimiter_EmailsLimiter(t *testing.T) {
  835. // This tests that the messageLimiter (the only fixed limiter) and the emailsLimiter (token bucket)
  836. // is reset by the stats resetter
  837. c := newTestConfigWithAuthFile(t)
  838. s := newTestServer(t, c)
  839. s.smtpSender = &testMailer{}
  840. // Publish some messages, and check stats
  841. for i := 0; i < 3; i++ {
  842. response := request(t, s, "PUT", "/mytopic", "test", nil)
  843. require.Equal(t, 200, response.Code)
  844. }
  845. response := request(t, s, "PUT", "/mytopic", "test", map[string]string{
  846. "Email": "test@email.com",
  847. })
  848. require.Equal(t, 200, response.Code)
  849. rr := request(t, s, "GET", "/v1/account", "", nil)
  850. require.Equal(t, 200, rr.Code)
  851. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(rr.Body))
  852. require.Nil(t, err)
  853. require.Equal(t, int64(4), account.Stats.Messages)
  854. require.Equal(t, int64(1), account.Stats.Emails)
  855. v := s.visitor(netip.MustParseAddr("9.9.9.9"), nil)
  856. require.Equal(t, int64(4), v.Stats().Messages)
  857. require.Equal(t, int64(4), v.messagesLimiter.Value())
  858. require.Equal(t, int64(1), v.Stats().Emails)
  859. require.Equal(t, int64(1), v.emailsLimiter.Value())
  860. // Reset stats and check again
  861. s.resetStats()
  862. rr = request(t, s, "GET", "/v1/account", "", nil)
  863. require.Equal(t, 200, rr.Code)
  864. account, err = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(rr.Body))
  865. require.Nil(t, err)
  866. require.Equal(t, int64(0), account.Stats.Messages)
  867. require.Equal(t, int64(0), account.Stats.Emails)
  868. v = s.visitor(netip.MustParseAddr("9.9.9.9"), nil)
  869. require.Equal(t, int64(0), v.Stats().Messages)
  870. require.Equal(t, int64(0), v.messagesLimiter.Value())
  871. require.Equal(t, int64(0), v.Stats().Emails)
  872. require.Equal(t, int64(0), v.emailsLimiter.Value())
  873. }
  874. func TestServer_DailyMessageQuotaFromDatabase(t *testing.T) {
  875. t.Parallel()
  876. // This tests that the daily message quota is prefilled originally from the database,
  877. // if the visitor is unknown
  878. c := newTestConfigWithAuthFile(t)
  879. c.AuthStatsQueueWriterInterval = 100 * time.Millisecond
  880. s := newTestServer(t, c)
  881. // Create user, and update it with some message and email stats
  882. require.Nil(t, s.userManager.AddTier(&user.Tier{
  883. Code: "test",
  884. }))
  885. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  886. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  887. u, err := s.userManager.User("phil")
  888. require.Nil(t, err)
  889. s.userManager.EnqueueUserStats(u.ID, &user.Stats{
  890. Messages: 123456,
  891. Emails: 999,
  892. })
  893. time.Sleep(400 * time.Millisecond)
  894. // Get account and verify stats are read from the DB, and that the visitor also has these stats
  895. rr := request(t, s, "GET", "/v1/account", "", map[string]string{
  896. "Authorization": util.BasicAuth("phil", "phil"),
  897. })
  898. require.Equal(t, 200, rr.Code)
  899. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(rr.Body))
  900. require.Nil(t, err)
  901. require.Equal(t, int64(123456), account.Stats.Messages)
  902. require.Equal(t, int64(999), account.Stats.Emails)
  903. v := s.visitor(netip.MustParseAddr("9.9.9.9"), u)
  904. require.Equal(t, int64(123456), v.Stats().Messages)
  905. require.Equal(t, int64(123456), v.messagesLimiter.Value())
  906. require.Equal(t, int64(999), v.Stats().Emails)
  907. require.Equal(t, int64(999), v.emailsLimiter.Value())
  908. }
  909. type testMailer struct {
  910. count int
  911. mu sync.Mutex
  912. }
  913. func (t *testMailer) Send(v *visitor, m *message, to string) error {
  914. t.mu.Lock()
  915. defer t.mu.Unlock()
  916. t.count++
  917. return nil
  918. }
  919. func (t *testMailer) Counts() (total int64, success int64, failure int64) {
  920. return 0, 0, 0
  921. }
  922. func (t *testMailer) Count() int {
  923. t.mu.Lock()
  924. defer t.mu.Unlock()
  925. return t.count
  926. }
  927. func TestServer_PublishTooRequests_Defaults(t *testing.T) {
  928. s := newTestServer(t, newTestConfig(t))
  929. for i := 0; i < 60; i++ {
  930. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  931. require.Equal(t, 200, response.Code)
  932. }
  933. response := request(t, s, "PUT", "/mytopic", "message", nil)
  934. require.Equal(t, 429, response.Code)
  935. }
  936. func TestServer_PublishTooRequests_Defaults_ExemptHosts(t *testing.T) {
  937. c := newTestConfig(t)
  938. c.VisitorRequestLimitBurst = 3
  939. c.VisitorRequestExemptIPAddrs = []netip.Prefix{netip.MustParsePrefix("9.9.9.9/32")} // see request()
  940. s := newTestServer(t, c)
  941. for i := 0; i < 5; i++ { // > 3
  942. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  943. require.Equal(t, 200, response.Code)
  944. }
  945. }
  946. func TestServer_PublishTooRequests_Defaults_ExemptHosts_MessageDailyLimit(t *testing.T) {
  947. c := newTestConfig(t)
  948. c.VisitorRequestLimitBurst = 10
  949. c.VisitorMessageDailyLimit = 4
  950. c.VisitorRequestExemptIPAddrs = []netip.Prefix{netip.MustParsePrefix("9.9.9.9/32")} // see request()
  951. s := newTestServer(t, c)
  952. for i := 0; i < 8; i++ { // 4
  953. response := request(t, s, "PUT", "/mytopic", "message", nil)
  954. require.Equal(t, 200, response.Code)
  955. }
  956. }
  957. func TestServer_PublishTooRequests_ShortReplenish(t *testing.T) {
  958. t.Parallel()
  959. c := newTestConfig(t)
  960. c.VisitorRequestLimitBurst = 60
  961. c.VisitorRequestLimitReplenish = time.Second
  962. s := newTestServer(t, c)
  963. for i := 0; i < 60; i++ {
  964. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), nil)
  965. require.Equal(t, 200, response.Code)
  966. }
  967. response := request(t, s, "PUT", "/mytopic", "message", nil)
  968. require.Equal(t, 429, response.Code)
  969. time.Sleep(1020 * time.Millisecond)
  970. response = request(t, s, "PUT", "/mytopic", "message", nil)
  971. require.Equal(t, 200, response.Code)
  972. }
  973. func TestServer_PublishTooManyEmails_Defaults(t *testing.T) {
  974. s := newTestServer(t, newTestConfig(t))
  975. s.smtpSender = &testMailer{}
  976. for i := 0; i < 16; i++ {
  977. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  978. "E-Mail": "test@example.com",
  979. })
  980. require.Equal(t, 200, response.Code)
  981. }
  982. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  983. "E-Mail": "test@example.com",
  984. })
  985. require.Equal(t, 429, response.Code)
  986. }
  987. func TestServer_PublishTooManyEmails_Replenish(t *testing.T) {
  988. t.Parallel()
  989. c := newTestConfig(t)
  990. c.VisitorEmailLimitReplenish = 500 * time.Millisecond
  991. s := newTestServer(t, c)
  992. s.smtpSender = &testMailer{}
  993. for i := 0; i < 16; i++ {
  994. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("message %d", i), map[string]string{
  995. "E-Mail": "test@example.com",
  996. })
  997. require.Equal(t, 200, response.Code)
  998. }
  999. response := request(t, s, "PUT", "/mytopic", "one too many", map[string]string{
  1000. "E-Mail": "test@example.com",
  1001. })
  1002. require.Equal(t, 429, response.Code)
  1003. time.Sleep(510 * time.Millisecond)
  1004. response = request(t, s, "PUT", "/mytopic", "this should be okay again too many", map[string]string{
  1005. "E-Mail": "test@example.com",
  1006. })
  1007. require.Equal(t, 200, response.Code)
  1008. response = request(t, s, "PUT", "/mytopic", "and bad again", map[string]string{
  1009. "E-Mail": "test@example.com",
  1010. })
  1011. require.Equal(t, 429, response.Code)
  1012. }
  1013. func TestServer_PublishDelayedEmail_Fail(t *testing.T) {
  1014. s := newTestServer(t, newTestConfig(t))
  1015. s.smtpSender = &testMailer{}
  1016. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  1017. "E-Mail": "test@example.com",
  1018. "Delay": "20 min",
  1019. })
  1020. require.Equal(t, 40003, toHTTPError(t, response.Body.String()).Code)
  1021. }
  1022. func TestServer_PublishDelayedCall_Fail(t *testing.T) {
  1023. c := newTestConfigWithAuthFile(t)
  1024. c.TwilioAccount = "AC1234567890"
  1025. c.TwilioAuthToken = "AAEAA1234567890"
  1026. c.TwilioPhoneNumber = "+1234567890"
  1027. s := newTestServer(t, c)
  1028. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  1029. "Call": "yes",
  1030. "Delay": "20 min",
  1031. })
  1032. require.Equal(t, 40037, toHTTPError(t, response.Body.String()).Code)
  1033. }
  1034. func TestServer_PublishEmailNoMailer_Fail(t *testing.T) {
  1035. s := newTestServer(t, newTestConfig(t))
  1036. response := request(t, s, "PUT", "/mytopic", "fail", map[string]string{
  1037. "E-Mail": "test@example.com",
  1038. })
  1039. require.Equal(t, 400, response.Code)
  1040. }
  1041. func TestServer_PublishAndExpungeTopicAfter16Hours(t *testing.T) {
  1042. t.Parallel()
  1043. s := newTestServer(t, newTestConfig(t))
  1044. subFn := func(v *visitor, msg *message) error {
  1045. return nil
  1046. }
  1047. // Publish and check last access
  1048. response := request(t, s, "POST", "/mytopic", "test", map[string]string{
  1049. "Cache": "no",
  1050. })
  1051. require.Equal(t, 200, response.Code)
  1052. waitFor(t, func() bool {
  1053. // .lastAccess set in t.Publish() -> t.Keepalive() in Goroutine
  1054. s.topics["mytopic"].mu.RLock()
  1055. defer s.topics["mytopic"].mu.RUnlock()
  1056. return s.topics["mytopic"].lastAccess.Unix() >= time.Now().Unix()-2 &&
  1057. s.topics["mytopic"].lastAccess.Unix() <= time.Now().Unix()+2
  1058. })
  1059. // Topic won't get pruned
  1060. s.execManager()
  1061. require.NotNil(t, s.topics["mytopic"])
  1062. // Fudge with last access, but subscribe, and see that it won't get pruned (because of subscriber)
  1063. subID := s.topics["mytopic"].Subscribe(subFn, "", func() {})
  1064. s.topics["mytopic"].mu.Lock()
  1065. s.topics["mytopic"].lastAccess = time.Now().Add(-17 * time.Hour)
  1066. s.topics["mytopic"].mu.Unlock()
  1067. s.execManager()
  1068. require.NotNil(t, s.topics["mytopic"])
  1069. // It'll finally get pruned now that there are no subscribers and last access is 17 hours ago
  1070. s.topics["mytopic"].Unsubscribe(subID)
  1071. s.execManager()
  1072. require.Nil(t, s.topics["mytopic"])
  1073. }
  1074. func TestServer_TopicKeepaliveOnPoll(t *testing.T) {
  1075. t.Parallel()
  1076. s := newTestServer(t, newTestConfig(t))
  1077. // Create topic by polling once
  1078. response := request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  1079. require.Equal(t, 200, response.Code)
  1080. // Mess with last access time
  1081. s.topics["mytopic"].lastAccess = time.Now().Add(-17 * time.Hour)
  1082. // Poll again and check keepalive time
  1083. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  1084. require.Equal(t, 200, response.Code)
  1085. require.True(t, s.topics["mytopic"].lastAccess.Unix() >= time.Now().Unix()-2)
  1086. require.True(t, s.topics["mytopic"].lastAccess.Unix() <= time.Now().Unix()+2)
  1087. }
  1088. func TestServer_UnifiedPushDiscovery(t *testing.T) {
  1089. s := newTestServer(t, newTestConfig(t))
  1090. response := request(t, s, "GET", "/mytopic?up=1", "", nil)
  1091. require.Equal(t, 200, response.Code)
  1092. require.Equal(t, `{"unifiedpush":{"version":1}}`+"\n", response.Body.String())
  1093. }
  1094. func TestServer_PublishUnifiedPushBinary_AndPoll(t *testing.T) {
  1095. b := make([]byte, 12) // Max length
  1096. _, err := rand.Read(b)
  1097. require.Nil(t, err)
  1098. s := newTestServer(t, newTestConfig(t))
  1099. // Register a UnifiedPush subscriber
  1100. response := request(t, s, "GET", "/up123456789012/json?poll=1", "", map[string]string{
  1101. "Rate-Topics": "up123456789012",
  1102. })
  1103. require.Equal(t, 200, response.Code)
  1104. // Publish message to topic
  1105. response = request(t, s, "PUT", "/up123456789012?up=1", string(b), nil)
  1106. require.Equal(t, 200, response.Code)
  1107. m := toMessage(t, response.Body.String())
  1108. require.Equal(t, "base64", m.Encoding)
  1109. b2, err := base64.StdEncoding.DecodeString(m.Message)
  1110. require.Nil(t, err)
  1111. require.Equal(t, b, b2)
  1112. // Retrieve and check published message
  1113. response = request(t, s, "GET", "/up123456789012/json?poll=1", string(b), nil)
  1114. require.Equal(t, 200, response.Code)
  1115. m = toMessage(t, response.Body.String())
  1116. require.Equal(t, "base64", m.Encoding)
  1117. b2, err = base64.StdEncoding.DecodeString(m.Message)
  1118. require.Nil(t, err)
  1119. require.Equal(t, b, b2)
  1120. }
  1121. func TestServer_PublishUnifiedPushBinary_Truncated(t *testing.T) {
  1122. b := make([]byte, 5000) // Longer than max length
  1123. _, err := rand.Read(b)
  1124. require.Nil(t, err)
  1125. s := newTestServer(t, newTestConfig(t))
  1126. // Register a UnifiedPush subscriber
  1127. response := request(t, s, "GET", "/mytopic/json?poll=1", "", map[string]string{
  1128. "Rate-Topics": "mytopic",
  1129. })
  1130. require.Equal(t, 200, response.Code)
  1131. // Publish message to topic
  1132. response = request(t, s, "PUT", "/mytopic?up=1", string(b), nil)
  1133. require.Equal(t, 200, response.Code)
  1134. m := toMessage(t, response.Body.String())
  1135. require.Equal(t, "base64", m.Encoding)
  1136. b2, err := base64.StdEncoding.DecodeString(m.Message)
  1137. require.Nil(t, err)
  1138. require.Equal(t, 4096, len(b2))
  1139. require.Equal(t, b[:4096], b2)
  1140. }
  1141. func TestServer_PublishUnifiedPushText(t *testing.T) {
  1142. s := newTestServer(t, newTestConfig(t))
  1143. // Register a UnifiedPush subscriber
  1144. response := request(t, s, "GET", "/mytopic/json?poll=1", "", map[string]string{
  1145. "Rate-Topics": "mytopic",
  1146. })
  1147. require.Equal(t, 200, response.Code)
  1148. // Publish UnifiedPush text message
  1149. response = request(t, s, "PUT", "/mytopic?up=1", "this is a unifiedpush text message", nil)
  1150. require.Equal(t, 200, response.Code)
  1151. m := toMessage(t, response.Body.String())
  1152. require.Equal(t, "", m.Encoding)
  1153. require.Equal(t, "this is a unifiedpush text message", m.Message)
  1154. }
  1155. func TestServer_MatrixGateway_Discovery_Success(t *testing.T) {
  1156. s := newTestServer(t, newTestConfig(t))
  1157. response := request(t, s, "GET", "/_matrix/push/v1/notify", "", nil)
  1158. require.Equal(t, 200, response.Code)
  1159. require.Equal(t, `{"unifiedpush":{"gateway":"matrix"}}`+"\n", response.Body.String())
  1160. }
  1161. func TestServer_MatrixGateway_Discovery_Failure_Unconfigured(t *testing.T) {
  1162. c := newTestConfig(t)
  1163. c.BaseURL = ""
  1164. s := newTestServer(t, c)
  1165. response := request(t, s, "GET", "/_matrix/push/v1/notify", "", nil)
  1166. require.Equal(t, 500, response.Code)
  1167. err := toHTTPError(t, response.Body.String())
  1168. require.Equal(t, 50003, err.Code)
  1169. }
  1170. func TestServer_MatrixGateway_Push_Success(t *testing.T) {
  1171. s := newTestServer(t, newTestConfig(t))
  1172. response := request(t, s, "GET", "/mytopic/json?poll=1", "", map[string]string{
  1173. "Rate-Topics": "mytopic", // Register first!
  1174. })
  1175. require.Equal(t, 200, response.Code)
  1176. notification := `{"notification":{"devices":[{"pushkey":"http://127.0.0.1:12345/mytopic?up=1"}]}}`
  1177. response = request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1178. require.Equal(t, 200, response.Code)
  1179. require.Equal(t, `{"rejected":[]}`+"\n", response.Body.String())
  1180. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  1181. require.Equal(t, 200, response.Code)
  1182. m := toMessage(t, response.Body.String())
  1183. require.Equal(t, notification, m.Message)
  1184. }
  1185. func TestServer_MatrixGateway_Push_Failure_NoSubscriber(t *testing.T) {
  1186. c := newTestConfig(t)
  1187. c.VisitorSubscriberRateLimiting = true
  1188. s := newTestServer(t, c)
  1189. notification := `{"notification":{"devices":[{"pushkey":"http://127.0.0.1:12345/mytopic?up=1"}]}}`
  1190. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1191. require.Equal(t, 507, response.Code)
  1192. require.Equal(t, 50701, toHTTPError(t, response.Body.String()).Code)
  1193. }
  1194. func TestServer_MatrixGateway_Push_Failure_NoSubscriber_After13Hours(t *testing.T) {
  1195. c := newTestConfig(t)
  1196. c.VisitorSubscriberRateLimiting = true
  1197. s := newTestServer(t, c)
  1198. notification := `{"notification":{"devices":[{"pushkey":"http://127.0.0.1:12345/mytopic?up=1"}]}}`
  1199. // No success if no rate visitor set (this also creates the topic in memory)
  1200. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1201. require.Equal(t, 507, response.Code)
  1202. require.Equal(t, 50701, toHTTPError(t, response.Body.String()).Code)
  1203. require.Nil(t, s.topics["mytopic"].rateVisitor)
  1204. // Fake: This topic has been around for 13 hours without a rate visitor
  1205. s.topics["mytopic"].lastAccess = time.Now().Add(-13 * time.Hour)
  1206. // Same request should now return HTTP 200 with a rejected pushkey
  1207. response = request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1208. require.Equal(t, 200, response.Code)
  1209. require.Equal(t, `{"rejected":["http://127.0.0.1:12345/mytopic?up=1"]}`, strings.TrimSpace(response.Body.String()))
  1210. // Slightly unrelated: Test that topic is pruned after 16 hours
  1211. s.topics["mytopic"].lastAccess = time.Now().Add(-17 * time.Hour)
  1212. s.execManager()
  1213. require.Nil(t, s.topics["mytopic"])
  1214. }
  1215. func TestServer_MatrixGateway_Push_Failure_InvalidPushkey(t *testing.T) {
  1216. s := newTestServer(t, newTestConfig(t))
  1217. notification := `{"notification":{"devices":[{"pushkey":"http://wrong-base-url.com/mytopic?up=1"}]}}`
  1218. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1219. require.Equal(t, 200, response.Code)
  1220. require.Equal(t, `{"rejected":["http://wrong-base-url.com/mytopic?up=1"]}`+"\n", response.Body.String())
  1221. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  1222. require.Equal(t, 200, response.Code)
  1223. require.Equal(t, "", response.Body.String()) // Empty!
  1224. }
  1225. func TestServer_MatrixGateway_Push_Failure_EverythingIsWrong(t *testing.T) {
  1226. s := newTestServer(t, newTestConfig(t))
  1227. notification := `{"message":"this is not really a Matrix message"}`
  1228. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1229. require.Equal(t, 400, response.Code)
  1230. require.Equal(t, 40019, toHTTPError(t, response.Body.String()).Code)
  1231. notification = `this isn't even JSON'`
  1232. response = request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1233. require.Equal(t, 400, response.Code)
  1234. require.Equal(t, 40019, toHTTPError(t, response.Body.String()).Code)
  1235. }
  1236. func TestServer_MatrixGateway_Push_Failure_Unconfigured(t *testing.T) {
  1237. c := newTestConfig(t)
  1238. c.BaseURL = ""
  1239. s := newTestServer(t, c)
  1240. notification := `{"notification":{"devices":[{"pushkey":"http://127.0.0.1:12345/mytopic?up=1"}]}}`
  1241. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1242. require.Equal(t, 500, response.Code)
  1243. require.Equal(t, 50003, toHTTPError(t, response.Body.String()).Code)
  1244. }
  1245. func TestServer_PublishActions_AndPoll(t *testing.T) {
  1246. s := newTestServer(t, newTestConfig(t))
  1247. response := request(t, s, "PUT", "/mytopic", "my message", map[string]string{
  1248. "Actions": "view, Open portal, https://home.nest.com/; http, Turn down, https://api.nest.com/device/XZ1D2, body=target_temp_f=65",
  1249. })
  1250. require.Equal(t, 200, response.Code)
  1251. response = request(t, s, "GET", "/mytopic/json?poll=1", "", nil)
  1252. require.Equal(t, 200, response.Code)
  1253. m := toMessage(t, response.Body.String())
  1254. require.Equal(t, 2, len(m.Actions))
  1255. require.Equal(t, "view", m.Actions[0].Action)
  1256. require.Equal(t, "Open portal", m.Actions[0].Label)
  1257. require.Equal(t, "https://home.nest.com/", m.Actions[0].URL)
  1258. require.Equal(t, "http", m.Actions[1].Action)
  1259. require.Equal(t, "Turn down", m.Actions[1].Label)
  1260. require.Equal(t, "https://api.nest.com/device/XZ1D2", m.Actions[1].URL)
  1261. require.Equal(t, "target_temp_f=65", m.Actions[1].Body)
  1262. }
  1263. func TestServer_PublishAsJSON(t *testing.T) {
  1264. s := newTestServer(t, newTestConfig(t))
  1265. body := `{"topic":"mytopic","message":"A message","title":"a title\nwith lines","tags":["tag1","tag 2"],` +
  1266. `"not-a-thing":"ok", "attach":"http://google.com","filename":"google.pdf", "click":"http://ntfy.sh","priority":4,` +
  1267. `"icon":"https://ntfy.sh/static/img/ntfy.png", "delay":"30min"}`
  1268. response := request(t, s, "PUT", "/", body, nil)
  1269. require.Equal(t, 200, response.Code)
  1270. m := toMessage(t, response.Body.String())
  1271. require.Equal(t, "mytopic", m.Topic)
  1272. require.Equal(t, "A message", m.Message)
  1273. require.Equal(t, "a title\nwith lines", m.Title)
  1274. require.Equal(t, []string{"tag1", "tag 2"}, m.Tags)
  1275. require.Equal(t, "http://google.com", m.Attachment.URL)
  1276. require.Equal(t, "google.pdf", m.Attachment.Name)
  1277. require.Equal(t, "http://ntfy.sh", m.Click)
  1278. require.Equal(t, "https://ntfy.sh/static/img/ntfy.png", m.Icon)
  1279. require.Equal(t, 4, m.Priority)
  1280. require.True(t, m.Time > time.Now().Unix()+29*60)
  1281. require.True(t, m.Time < time.Now().Unix()+31*60)
  1282. }
  1283. func TestServer_PublishAsJSON_RateLimit_MessageDailyLimit(t *testing.T) {
  1284. // Publishing as JSON follows a different path. This ensures that rate
  1285. // limiting works for this endpoint as well
  1286. c := newTestConfig(t)
  1287. c.VisitorMessageDailyLimit = 3
  1288. s := newTestServer(t, c)
  1289. for i := 0; i < 3; i++ {
  1290. response := request(t, s, "PUT", "/", `{"topic":"mytopic","message":"A message"}`, nil)
  1291. require.Equal(t, 200, response.Code)
  1292. }
  1293. response := request(t, s, "PUT", "/", `{"topic":"mytopic","message":"A message"}`, nil)
  1294. require.Equal(t, 429, response.Code)
  1295. require.Equal(t, 42908, toHTTPError(t, response.Body.String()).Code)
  1296. }
  1297. func TestServer_PublishAsJSON_WithEmail(t *testing.T) {
  1298. t.Parallel()
  1299. mailer := &testMailer{}
  1300. s := newTestServer(t, newTestConfig(t))
  1301. s.smtpSender = mailer
  1302. body := `{"topic":"mytopic","message":"A message","email":"phil@example.com"}`
  1303. response := request(t, s, "PUT", "/", body, nil)
  1304. require.Equal(t, 200, response.Code)
  1305. time.Sleep(100 * time.Millisecond) // E-Mail publishing happens in a Go routine
  1306. m := toMessage(t, response.Body.String())
  1307. require.Equal(t, "mytopic", m.Topic)
  1308. require.Equal(t, "A message", m.Message)
  1309. require.Equal(t, 1, mailer.Count())
  1310. }
  1311. func TestServer_PublishAsJSON_WithActions(t *testing.T) {
  1312. s := newTestServer(t, newTestConfig(t))
  1313. body := `{
  1314. "topic":"mytopic",
  1315. "message":"A message",
  1316. "actions": [
  1317. {
  1318. "action": "view",
  1319. "label": "Open portal",
  1320. "url": "https://home.nest.com/"
  1321. },
  1322. {
  1323. "action": "http",
  1324. "label": "Turn down",
  1325. "url": "https://api.nest.com/device/XZ1D2",
  1326. "body": "target_temp_f=65"
  1327. }
  1328. ]
  1329. }`
  1330. response := request(t, s, "POST", "/", body, nil)
  1331. require.Equal(t, 200, response.Code)
  1332. m := toMessage(t, response.Body.String())
  1333. require.Equal(t, "mytopic", m.Topic)
  1334. require.Equal(t, "A message", m.Message)
  1335. require.Equal(t, 2, len(m.Actions))
  1336. require.Equal(t, "view", m.Actions[0].Action)
  1337. require.Equal(t, "Open portal", m.Actions[0].Label)
  1338. require.Equal(t, "https://home.nest.com/", m.Actions[0].URL)
  1339. require.Equal(t, "http", m.Actions[1].Action)
  1340. require.Equal(t, "Turn down", m.Actions[1].Label)
  1341. require.Equal(t, "https://api.nest.com/device/XZ1D2", m.Actions[1].URL)
  1342. require.Equal(t, "target_temp_f=65", m.Actions[1].Body)
  1343. }
  1344. func TestServer_PublishAsJSON_Invalid(t *testing.T) {
  1345. s := newTestServer(t, newTestConfig(t))
  1346. body := `{"topic":"mytopic",INVALID`
  1347. response := request(t, s, "PUT", "/", body, nil)
  1348. require.Equal(t, 400, response.Code)
  1349. }
  1350. func TestServer_PublishWithTierBasedMessageLimitAndExpiry(t *testing.T) {
  1351. c := newTestConfigWithAuthFile(t)
  1352. s := newTestServer(t, c)
  1353. // Create tier with certain limits
  1354. require.Nil(t, s.userManager.AddTier(&user.Tier{
  1355. Code: "test",
  1356. MessageLimit: 5,
  1357. MessageExpiryDuration: -5 * time.Second, // Second, what a hack!
  1358. }))
  1359. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1360. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1361. // Publish to reach message limit
  1362. for i := 0; i < 5; i++ {
  1363. response := request(t, s, "PUT", "/mytopic", fmt.Sprintf("this is message %d", i+1), map[string]string{
  1364. "Authorization": util.BasicAuth("phil", "phil"),
  1365. })
  1366. require.Equal(t, 200, response.Code)
  1367. msg := toMessage(t, response.Body.String())
  1368. require.True(t, msg.Expires < time.Now().Unix()+5)
  1369. }
  1370. response := request(t, s, "PUT", "/mytopic", "this is too much", map[string]string{
  1371. "Authorization": util.BasicAuth("phil", "phil"),
  1372. })
  1373. require.Equal(t, 429, response.Code)
  1374. // Run pruning and see if they are gone
  1375. s.execManager()
  1376. response = request(t, s, "GET", "/mytopic/json?poll=1", "", map[string]string{
  1377. "Authorization": util.BasicAuth("phil", "phil"),
  1378. })
  1379. require.Equal(t, 200, response.Code)
  1380. require.Empty(t, response.Body)
  1381. }
  1382. func TestServer_PublishAttachment(t *testing.T) {
  1383. content := "text file!" + util.RandomString(4990) // > 4096
  1384. s := newTestServer(t, newTestConfig(t))
  1385. response := request(t, s, "PUT", "/mytopic", content, nil)
  1386. msg := toMessage(t, response.Body.String())
  1387. require.Equal(t, "attachment.txt", msg.Attachment.Name)
  1388. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  1389. require.Equal(t, int64(5000), msg.Attachment.Size)
  1390. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(179*time.Minute).Unix()) // Almost 3 hours
  1391. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1392. require.Equal(t, netip.Addr{}, msg.Sender) // Should never be returned
  1393. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1394. // GET
  1395. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1396. response = request(t, s, "GET", path, "", nil)
  1397. require.Equal(t, 200, response.Code)
  1398. require.Equal(t, "5000", response.Header().Get("Content-Length"))
  1399. require.Equal(t, content, response.Body.String())
  1400. // HEAD
  1401. response = request(t, s, "HEAD", path, "", nil)
  1402. require.Equal(t, 200, response.Code)
  1403. require.Equal(t, "5000", response.Header().Get("Content-Length"))
  1404. require.Equal(t, "", response.Body.String())
  1405. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  1406. size, err := s.messageCache.AttachmentBytesUsedBySender("9.9.9.9") // See request()
  1407. require.Nil(t, err)
  1408. require.Equal(t, int64(5000), size)
  1409. }
  1410. func TestServer_PublishAttachmentShortWithFilename(t *testing.T) {
  1411. c := newTestConfig(t)
  1412. c.BehindProxy = true
  1413. s := newTestServer(t, c)
  1414. content := "this is an ATTACHMENT"
  1415. response := request(t, s, "PUT", "/mytopic?f=myfile.txt", content, map[string]string{
  1416. "X-Forwarded-For": "1.2.3.4",
  1417. })
  1418. msg := toMessage(t, response.Body.String())
  1419. require.Equal(t, "myfile.txt", msg.Attachment.Name)
  1420. require.Equal(t, "text/plain; charset=utf-8", msg.Attachment.Type)
  1421. require.Equal(t, int64(21), msg.Attachment.Size)
  1422. require.GreaterOrEqual(t, msg.Attachment.Expires, time.Now().Add(3*time.Hour).Unix())
  1423. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1424. require.Equal(t, netip.Addr{}, msg.Sender) // Should never be returned
  1425. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1426. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1427. response = request(t, s, "GET", path, "", nil)
  1428. require.Equal(t, 200, response.Code)
  1429. require.Equal(t, "21", response.Header().Get("Content-Length"))
  1430. require.Equal(t, content, response.Body.String())
  1431. // Slightly unrelated cross-test: make sure we add an owner for internal attachments
  1432. size, err := s.messageCache.AttachmentBytesUsedBySender("1.2.3.4")
  1433. require.Nil(t, err)
  1434. require.Equal(t, int64(21), size)
  1435. }
  1436. func TestServer_PublishAttachmentExternalWithoutFilename(t *testing.T) {
  1437. s := newTestServer(t, newTestConfig(t))
  1438. response := request(t, s, "PUT", "/mytopic", "", map[string]string{
  1439. "Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  1440. })
  1441. msg := toMessage(t, response.Body.String())
  1442. require.Equal(t, "You received a file: Pink_flower.jpg", msg.Message)
  1443. require.Equal(t, "Pink_flower.jpg", msg.Attachment.Name)
  1444. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  1445. require.Equal(t, "", msg.Attachment.Type)
  1446. require.Equal(t, int64(0), msg.Attachment.Size)
  1447. require.Equal(t, int64(0), msg.Attachment.Expires)
  1448. require.Equal(t, netip.Addr{}, msg.Sender)
  1449. // Slightly unrelated cross-test: make sure we don't add an owner for external attachments
  1450. size, err := s.messageCache.AttachmentBytesUsedBySender("127.0.0.1")
  1451. require.Nil(t, err)
  1452. require.Equal(t, int64(0), size)
  1453. }
  1454. func TestServer_PublishAttachmentExternalWithFilename(t *testing.T) {
  1455. s := newTestServer(t, newTestConfig(t))
  1456. response := request(t, s, "PUT", "/mytopic", "This is a custom message", map[string]string{
  1457. "X-Attach": "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg",
  1458. "File": "some file.jpg",
  1459. })
  1460. msg := toMessage(t, response.Body.String())
  1461. require.Equal(t, "This is a custom message", msg.Message)
  1462. require.Equal(t, "some file.jpg", msg.Attachment.Name)
  1463. require.Equal(t, "https://upload.wikimedia.org/wikipedia/commons/f/fd/Pink_flower.jpg", msg.Attachment.URL)
  1464. require.Equal(t, "", msg.Attachment.Type)
  1465. require.Equal(t, int64(0), msg.Attachment.Size)
  1466. require.Equal(t, int64(0), msg.Attachment.Expires)
  1467. require.Equal(t, netip.Addr{}, msg.Sender)
  1468. }
  1469. func TestServer_PublishAttachmentBadURL(t *testing.T) {
  1470. s := newTestServer(t, newTestConfig(t))
  1471. response := request(t, s, "PUT", "/mytopic?a=not+a+URL", "", nil)
  1472. err := toHTTPError(t, response.Body.String())
  1473. require.Equal(t, 400, response.Code)
  1474. require.Equal(t, 400, err.HTTPCode)
  1475. require.Equal(t, 40013, err.Code)
  1476. }
  1477. func TestServer_PublishAttachmentTooLargeContentLength(t *testing.T) {
  1478. content := util.RandomString(5000) // > 4096
  1479. s := newTestServer(t, newTestConfig(t))
  1480. response := request(t, s, "PUT", "/mytopic", content, map[string]string{
  1481. "Content-Length": "20000000",
  1482. })
  1483. err := toHTTPError(t, response.Body.String())
  1484. require.Equal(t, 413, response.Code)
  1485. require.Equal(t, 413, err.HTTPCode)
  1486. require.Equal(t, 41301, err.Code)
  1487. }
  1488. func TestServer_PublishAttachmentTooLargeBodyAttachmentFileSizeLimit(t *testing.T) {
  1489. content := util.RandomString(5001) // > 5000, see below
  1490. c := newTestConfig(t)
  1491. c.AttachmentFileSizeLimit = 5000
  1492. s := newTestServer(t, c)
  1493. response := request(t, s, "PUT", "/mytopic", content, nil)
  1494. err := toHTTPError(t, response.Body.String())
  1495. require.Equal(t, 413, response.Code)
  1496. require.Equal(t, 413, err.HTTPCode)
  1497. require.Equal(t, 41301, err.Code)
  1498. }
  1499. func TestServer_PublishAttachmentExpiryBeforeDelivery(t *testing.T) {
  1500. c := newTestConfig(t)
  1501. c.AttachmentExpiryDuration = 10 * time.Minute
  1502. s := newTestServer(t, c)
  1503. response := request(t, s, "PUT", "/mytopic", util.RandomString(5000), map[string]string{
  1504. "Delay": "11 min", // > AttachmentExpiryDuration
  1505. })
  1506. err := toHTTPError(t, response.Body.String())
  1507. require.Equal(t, 400, response.Code)
  1508. require.Equal(t, 400, err.HTTPCode)
  1509. require.Equal(t, 40015, err.Code)
  1510. }
  1511. func TestServer_PublishAttachmentTooLargeBodyVisitorAttachmentTotalSizeLimit(t *testing.T) {
  1512. c := newTestConfig(t)
  1513. c.VisitorAttachmentTotalSizeLimit = 10000
  1514. s := newTestServer(t, c)
  1515. response := request(t, s, "PUT", "/mytopic", "text file!"+util.RandomString(4990), nil)
  1516. msg := toMessage(t, response.Body.String())
  1517. require.Equal(t, 200, response.Code)
  1518. require.Equal(t, "You received a file: attachment.txt", msg.Message)
  1519. require.Equal(t, int64(5000), msg.Attachment.Size)
  1520. content := util.RandomString(5001) // 5000+5001 > , see below
  1521. response = request(t, s, "PUT", "/mytopic", content, nil)
  1522. err := toHTTPError(t, response.Body.String())
  1523. require.Equal(t, 413, response.Code)
  1524. require.Equal(t, 413, err.HTTPCode)
  1525. require.Equal(t, 41301, err.Code)
  1526. }
  1527. func TestServer_PublishAttachmentAndExpire(t *testing.T) {
  1528. t.Parallel()
  1529. content := util.RandomString(5000) // > 4096
  1530. c := newTestConfig(t)
  1531. c.AttachmentExpiryDuration = time.Millisecond // Hack
  1532. s := newTestServer(t, c)
  1533. // Publish and make sure we can retrieve it
  1534. response := request(t, s, "PUT", "/mytopic", content, nil)
  1535. msg := toMessage(t, response.Body.String())
  1536. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1537. file := filepath.Join(s.config.AttachmentCacheDir, msg.ID)
  1538. require.FileExists(t, file)
  1539. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1540. response = request(t, s, "GET", path, "", nil)
  1541. require.Equal(t, 200, response.Code)
  1542. require.Equal(t, content, response.Body.String())
  1543. // Prune and makes sure it's gone
  1544. waitFor(t, func() bool {
  1545. s.execManager() // May run many times
  1546. return !util.FileExists(file)
  1547. })
  1548. response = request(t, s, "GET", path, "", nil)
  1549. require.Equal(t, 404, response.Code)
  1550. }
  1551. func TestServer_PublishAttachmentWithTierBasedExpiry(t *testing.T) {
  1552. t.Parallel()
  1553. content := util.RandomString(5000) // > 4096
  1554. c := newTestConfigWithAuthFile(t)
  1555. c.AttachmentExpiryDuration = time.Millisecond // Hack
  1556. s := newTestServer(t, c)
  1557. // Create tier with certain limits
  1558. sevenDays := time.Duration(604800) * time.Second
  1559. require.Nil(t, s.userManager.AddTier(&user.Tier{
  1560. Code: "test",
  1561. MessageLimit: 10,
  1562. MessageExpiryDuration: sevenDays,
  1563. AttachmentFileSizeLimit: 50_000,
  1564. AttachmentTotalSizeLimit: 200_000,
  1565. AttachmentExpiryDuration: sevenDays, // 7 days
  1566. AttachmentBandwidthLimit: 100000,
  1567. }))
  1568. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1569. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1570. // Publish and make sure we can retrieve it
  1571. response := request(t, s, "PUT", "/mytopic", content, map[string]string{
  1572. "Authorization": util.BasicAuth("phil", "phil"),
  1573. })
  1574. require.Equal(t, 200, response.Code)
  1575. msg := toMessage(t, response.Body.String())
  1576. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1577. require.True(t, msg.Attachment.Expires > time.Now().Add(sevenDays-30*time.Second).Unix())
  1578. require.True(t, msg.Expires > time.Now().Add(sevenDays-30*time.Second).Unix())
  1579. file := filepath.Join(s.config.AttachmentCacheDir, msg.ID)
  1580. require.FileExists(t, file)
  1581. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1582. response = request(t, s, "GET", path, "", nil)
  1583. require.Equal(t, 200, response.Code)
  1584. require.Equal(t, content, response.Body.String())
  1585. // Prune and makes sure it's still there
  1586. time.Sleep(time.Second) // Sigh ...
  1587. s.execManager()
  1588. require.FileExists(t, file)
  1589. response = request(t, s, "GET", path, "", nil)
  1590. require.Equal(t, 200, response.Code)
  1591. }
  1592. func TestServer_PublishAttachmentWithTierBasedBandwidthLimit(t *testing.T) {
  1593. content := util.RandomString(5000) // > 4096
  1594. c := newTestConfigWithAuthFile(t)
  1595. c.VisitorAttachmentDailyBandwidthLimit = 1000 // Much lower than tier bandwidth!
  1596. s := newTestServer(t, c)
  1597. // Create tier with certain limits
  1598. require.Nil(t, s.userManager.AddTier(&user.Tier{
  1599. Code: "test",
  1600. MessageLimit: 10,
  1601. MessageExpiryDuration: time.Hour,
  1602. AttachmentFileSizeLimit: 50_000,
  1603. AttachmentTotalSizeLimit: 200_000,
  1604. AttachmentExpiryDuration: time.Hour,
  1605. AttachmentBandwidthLimit: 14000, // < 3x5000 bytes -> enough for one upload, one download
  1606. }))
  1607. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1608. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1609. // Publish and make sure we can retrieve it
  1610. rr := request(t, s, "PUT", "/mytopic", content, map[string]string{
  1611. "Authorization": util.BasicAuth("phil", "phil"),
  1612. })
  1613. require.Equal(t, 200, rr.Code)
  1614. msg := toMessage(t, rr.Body.String())
  1615. // Retrieve it (first time succeeds)
  1616. rr = request(t, s, "GET", "/file/"+msg.ID, content, nil) // File downloads do not send auth headers!!
  1617. require.Equal(t, 200, rr.Code)
  1618. require.Equal(t, content, rr.Body.String())
  1619. // Retrieve it AGAIN (fails, due to bandwidth limit)
  1620. rr = request(t, s, "GET", "/file/"+msg.ID, content, nil)
  1621. require.Equal(t, 429, rr.Code)
  1622. }
  1623. func TestServer_PublishAttachmentWithTierBasedLimits(t *testing.T) {
  1624. smallFile := util.RandomString(20_000)
  1625. largeFile := util.RandomString(50_000)
  1626. c := newTestConfigWithAuthFile(t)
  1627. c.AttachmentFileSizeLimit = 20_000
  1628. c.VisitorAttachmentTotalSizeLimit = 40_000
  1629. s := newTestServer(t, c)
  1630. // Create tier with certain limits
  1631. require.Nil(t, s.userManager.AddTier(&user.Tier{
  1632. Code: "test",
  1633. MessageLimit: 100,
  1634. AttachmentFileSizeLimit: 50_000,
  1635. AttachmentTotalSizeLimit: 200_000,
  1636. AttachmentExpiryDuration: 30 * time.Second,
  1637. AttachmentBandwidthLimit: 1000000,
  1638. }))
  1639. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1640. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  1641. // Publish small file as anonymous
  1642. response := request(t, s, "PUT", "/mytopic", smallFile, nil)
  1643. msg := toMessage(t, response.Body.String())
  1644. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1645. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1646. // Publish large file as anonymous
  1647. response = request(t, s, "PUT", "/mytopic", largeFile, nil)
  1648. require.Equal(t, 413, response.Code)
  1649. require.Equal(t, 41301, toHTTPError(t, response.Body.String()).Code)
  1650. // Publish too large file as phil
  1651. response = request(t, s, "PUT", "/mytopic", largeFile+" a few more bytes", map[string]string{
  1652. "Authorization": util.BasicAuth("phil", "phil"),
  1653. })
  1654. require.Equal(t, 413, response.Code)
  1655. require.Equal(t, 41301, toHTTPError(t, response.Body.String()).Code)
  1656. // Publish large file as phil (4x)
  1657. for i := 0; i < 4; i++ {
  1658. response = request(t, s, "PUT", "/mytopic", largeFile, map[string]string{
  1659. "Authorization": util.BasicAuth("phil", "phil"),
  1660. })
  1661. require.Equal(t, 200, response.Code)
  1662. msg = toMessage(t, response.Body.String())
  1663. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1664. require.FileExists(t, filepath.Join(s.config.AttachmentCacheDir, msg.ID))
  1665. }
  1666. response = request(t, s, "PUT", "/mytopic", largeFile, map[string]string{
  1667. "Authorization": util.BasicAuth("phil", "phil"),
  1668. })
  1669. require.Equal(t, 413, response.Code)
  1670. require.Equal(t, 41301, toHTTPError(t, response.Body.String()).Code)
  1671. }
  1672. func TestServer_PublishAttachmentBandwidthLimit(t *testing.T) {
  1673. content := util.RandomString(5000) // > 4096
  1674. c := newTestConfig(t)
  1675. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 123 // A little more than 1 upload and 3 downloads
  1676. s := newTestServer(t, c)
  1677. // Publish attachment
  1678. response := request(t, s, "PUT", "/mytopic", content, nil)
  1679. msg := toMessage(t, response.Body.String())
  1680. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1681. // Value it 4 times successfully
  1682. path := strings.TrimPrefix(msg.Attachment.URL, "http://127.0.0.1:12345")
  1683. for i := 1; i <= 4; i++ { // 4 successful downloads
  1684. response = request(t, s, "GET", path, "", nil)
  1685. require.Equal(t, 200, response.Code)
  1686. require.Equal(t, content, response.Body.String())
  1687. }
  1688. // And then fail with a 429
  1689. response = request(t, s, "GET", path, "", nil)
  1690. err := toHTTPError(t, response.Body.String())
  1691. require.Equal(t, 429, response.Code)
  1692. require.Equal(t, 42905, err.Code)
  1693. }
  1694. func TestServer_PublishAttachmentBandwidthLimitUploadOnly(t *testing.T) {
  1695. content := util.RandomString(5000) // > 4096
  1696. c := newTestConfig(t)
  1697. c.VisitorAttachmentDailyBandwidthLimit = 5*5000 + 500 // 5 successful uploads
  1698. s := newTestServer(t, c)
  1699. // 5 successful uploads
  1700. for i := 1; i <= 5; i++ {
  1701. response := request(t, s, "PUT", "/mytopic", content, nil)
  1702. msg := toMessage(t, response.Body.String())
  1703. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1704. }
  1705. // And a failed one
  1706. response := request(t, s, "PUT", "/mytopic", content, nil)
  1707. err := toHTTPError(t, response.Body.String())
  1708. require.Equal(t, 413, response.Code)
  1709. require.Equal(t, 41301, err.Code)
  1710. }
  1711. func TestServer_PublishAttachmentAndImmediatelyGetItWithCacheTimeout(t *testing.T) {
  1712. // This tests the awkward util.Retry in handleFile: Due to the async persisting of messages,
  1713. // the message is not immediately available when attempting to download it.
  1714. c := newTestConfig(t)
  1715. c.CacheBatchTimeout = 500 * time.Millisecond
  1716. c.CacheBatchSize = 10
  1717. s := newTestServer(t, c)
  1718. content := "this is an ATTACHMENT"
  1719. rr := request(t, s, "PUT", "/mytopic?f=myfile.txt", content, nil)
  1720. m := toMessage(t, rr.Body.String())
  1721. require.Equal(t, "myfile.txt", m.Attachment.Name)
  1722. path := strings.TrimPrefix(m.Attachment.URL, "http://127.0.0.1:12345")
  1723. rr = request(t, s, "GET", path, "", nil)
  1724. require.Equal(t, 200, rr.Code) // Not 404!
  1725. require.Equal(t, content, rr.Body.String())
  1726. }
  1727. func TestServer_PublishAttachmentAccountStats(t *testing.T) {
  1728. content := util.RandomString(4999) // > 4096
  1729. c := newTestConfig(t)
  1730. c.AttachmentFileSizeLimit = 5000
  1731. c.VisitorAttachmentTotalSizeLimit = 6000
  1732. s := newTestServer(t, c)
  1733. // Upload one attachment
  1734. response := request(t, s, "PUT", "/mytopic", content, nil)
  1735. msg := toMessage(t, response.Body.String())
  1736. require.Contains(t, msg.Attachment.URL, "http://127.0.0.1:12345/file/")
  1737. // User stats
  1738. response = request(t, s, "GET", "/v1/account", "", nil)
  1739. require.Equal(t, 200, response.Code)
  1740. account, err := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(response.Body))
  1741. require.Nil(t, err)
  1742. require.Equal(t, int64(5000), account.Limits.AttachmentFileSize)
  1743. require.Equal(t, int64(6000), account.Limits.AttachmentTotalSize)
  1744. require.Equal(t, int64(4999), account.Stats.AttachmentTotalSize)
  1745. require.Equal(t, int64(1001), account.Stats.AttachmentTotalSizeRemaining)
  1746. require.Equal(t, int64(1), account.Stats.Messages)
  1747. }
  1748. func TestServer_Visitor_XForwardedFor_None(t *testing.T) {
  1749. c := newTestConfig(t)
  1750. c.BehindProxy = true
  1751. s := newTestServer(t, c)
  1752. r, _ := http.NewRequest("GET", "/bla", nil)
  1753. r.RemoteAddr = "8.9.10.11"
  1754. r.Header.Set("X-Forwarded-For", " ") // Spaces, not empty!
  1755. v, err := s.maybeAuthenticate(r)
  1756. require.Nil(t, err)
  1757. require.Equal(t, "8.9.10.11", v.ip.String())
  1758. }
  1759. func TestServer_Visitor_XForwardedFor_Single(t *testing.T) {
  1760. c := newTestConfig(t)
  1761. c.BehindProxy = true
  1762. s := newTestServer(t, c)
  1763. r, _ := http.NewRequest("GET", "/bla", nil)
  1764. r.RemoteAddr = "8.9.10.11"
  1765. r.Header.Set("X-Forwarded-For", "1.1.1.1")
  1766. v, err := s.maybeAuthenticate(r)
  1767. require.Nil(t, err)
  1768. require.Equal(t, "1.1.1.1", v.ip.String())
  1769. }
  1770. func TestServer_Visitor_XForwardedFor_Multiple(t *testing.T) {
  1771. c := newTestConfig(t)
  1772. c.BehindProxy = true
  1773. s := newTestServer(t, c)
  1774. r, _ := http.NewRequest("GET", "/bla", nil)
  1775. r.RemoteAddr = "8.9.10.11"
  1776. r.Header.Set("X-Forwarded-For", "1.2.3.4 , 2.4.4.2,234.5.2.1 ")
  1777. v, err := s.maybeAuthenticate(r)
  1778. require.Nil(t, err)
  1779. require.Equal(t, "234.5.2.1", v.ip.String())
  1780. }
  1781. func TestServer_PublishWhileUpdatingStatsWithLotsOfMessages(t *testing.T) {
  1782. t.Parallel()
  1783. count := 50000
  1784. c := newTestConfig(t)
  1785. c.TotalTopicLimit = 50001
  1786. c.CacheStartupQueries = "pragma journal_mode = WAL; pragma synchronous = normal; pragma temp_store = memory;"
  1787. s := newTestServer(t, c)
  1788. // Add lots of messages
  1789. log.Info("Adding %d messages", count)
  1790. start := time.Now()
  1791. messages := make([]*message, 0)
  1792. for i := 0; i < count; i++ {
  1793. topicID := fmt.Sprintf("topic%d", i)
  1794. _, err := s.topicsFromIDs(topicID) // Add topic to internal s.topics array
  1795. require.Nil(t, err)
  1796. messages = append(messages, newDefaultMessage(topicID, "some message"))
  1797. }
  1798. require.Nil(t, s.messageCache.addMessages(messages))
  1799. log.Info("Done: Adding %d messages; took %s", count, time.Since(start).Round(time.Millisecond))
  1800. // Update stats
  1801. statsChan := make(chan bool)
  1802. go func() {
  1803. log.Info("Updating stats")
  1804. start := time.Now()
  1805. s.execManager()
  1806. log.Info("Done: Updating stats; took %s", time.Since(start).Round(time.Millisecond))
  1807. statsChan <- true
  1808. }()
  1809. time.Sleep(50 * time.Millisecond) // Make sure it starts first
  1810. // Publish message (during stats update)
  1811. log.Info("Publishing message")
  1812. start = time.Now()
  1813. response := request(t, s, "PUT", "/mytopic", "some body", nil)
  1814. m := toMessage(t, response.Body.String())
  1815. require.Equal(t, "some body", m.Message)
  1816. require.True(t, time.Since(start) < 100*time.Millisecond)
  1817. log.Info("Done: Publishing message; took %s", time.Since(start).Round(time.Millisecond))
  1818. // Wait for all goroutines
  1819. select {
  1820. case <-statsChan:
  1821. case <-time.After(10 * time.Second):
  1822. t.Fatal("Timed out waiting for Go routines")
  1823. }
  1824. log.Info("Done: Waiting for all locks")
  1825. }
  1826. func TestServer_AnonymousUser_And_NonTierUser_Are_Same_Visitor(t *testing.T) {
  1827. conf := newTestConfigWithAuthFile(t)
  1828. s := newTestServer(t, conf)
  1829. defer s.closeDatabases()
  1830. // Create user without tier
  1831. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  1832. // Publish a message (anonymous user)
  1833. rr := request(t, s, "POST", "/mytopic", "hi", nil)
  1834. require.Equal(t, 200, rr.Code)
  1835. // Publish a message (non-tier user)
  1836. rr = request(t, s, "POST", "/mytopic", "hi", map[string]string{
  1837. "Authorization": util.BasicAuth("phil", "phil"),
  1838. })
  1839. require.Equal(t, 200, rr.Code)
  1840. // User stats (anonymous user)
  1841. rr = request(t, s, "GET", "/v1/account", "", nil)
  1842. account, _ := util.UnmarshalJSON[apiAccountResponse](io.NopCloser(rr.Body))
  1843. require.Equal(t, int64(2), account.Stats.Messages)
  1844. // User stats (non-tier user)
  1845. rr = request(t, s, "GET", "/v1/account", "", map[string]string{
  1846. "Authorization": util.BasicAuth("phil", "phil"),
  1847. })
  1848. account, _ = util.UnmarshalJSON[apiAccountResponse](io.NopCloser(rr.Body))
  1849. require.Equal(t, int64(2), account.Stats.Messages)
  1850. }
  1851. func TestServer_SubscriberRateLimiting_Success(t *testing.T) {
  1852. c := newTestConfigWithAuthFile(t)
  1853. c.VisitorRequestLimitBurst = 3
  1854. c.VisitorSubscriberRateLimiting = true
  1855. s := newTestServer(t, c)
  1856. // "Register" visitor 1.2.3.4 to topic "subscriber1topic" as a rate limit visitor
  1857. subscriber1Fn := func(r *http.Request) {
  1858. r.RemoteAddr = "1.2.3.4"
  1859. }
  1860. rr := request(t, s, "GET", "/subscriber1topic/json?poll=1", "", map[string]string{
  1861. "Rate-Topics": "subscriber1topic",
  1862. }, subscriber1Fn)
  1863. require.Equal(t, 200, rr.Code)
  1864. require.Equal(t, "", rr.Body.String())
  1865. require.Equal(t, "1.2.3.4", s.topics["subscriber1topic"].rateVisitor.ip.String())
  1866. // "Register" visitor 8.7.7.1 to topic "up012345678912" as a rate limit visitor (implicitly via topic name)
  1867. subscriber2Fn := func(r *http.Request) {
  1868. r.RemoteAddr = "8.7.7.1"
  1869. }
  1870. rr = request(t, s, "GET", "/up012345678912/json?poll=1", "", nil, subscriber2Fn)
  1871. require.Equal(t, 200, rr.Code)
  1872. require.Equal(t, "", rr.Body.String())
  1873. require.Equal(t, "8.7.7.1", s.topics["up012345678912"].rateVisitor.ip.String())
  1874. // Publish 2 messages to "subscriber1topic" as visitor 9.9.9.9. It'd be 3 normally, but the
  1875. // GET request before is also counted towards the request limiter.
  1876. for i := 0; i < 2; i++ {
  1877. rr := request(t, s, "PUT", "/subscriber1topic", "some message", nil)
  1878. require.Equal(t, 200, rr.Code)
  1879. }
  1880. rr = request(t, s, "PUT", "/subscriber1topic", "some message", nil)
  1881. require.Equal(t, 429, rr.Code)
  1882. // Publish another 2 messages to "up012345678912" as visitor 9.9.9.9
  1883. for i := 0; i < 2; i++ {
  1884. rr := request(t, s, "PUT", "/up012345678912", "some message", nil)
  1885. require.Equal(t, 200, rr.Code) // If we fail here, handlePublish is using the wrong visitor!
  1886. }
  1887. rr = request(t, s, "PUT", "/up012345678912", "some message", nil)
  1888. require.Equal(t, 429, rr.Code)
  1889. // Hurray! At this point, visitor 9.9.9.9 has published 4 messages, even though
  1890. // VisitorRequestLimitBurst is 3. That means it's working.
  1891. // Now let's confirm that so far we haven't used up any of visitor 9.9.9.9's request limiter
  1892. // by publishing another 3 requests from it.
  1893. for i := 0; i < 3; i++ {
  1894. rr := request(t, s, "PUT", "/some-other-topic", "some message", nil)
  1895. require.Equal(t, 200, rr.Code)
  1896. }
  1897. rr = request(t, s, "PUT", "/some-other-topic", "some message", nil)
  1898. require.Equal(t, 429, rr.Code)
  1899. }
  1900. func TestServer_SubscriberRateLimiting_NotEnabled_Failed(t *testing.T) {
  1901. c := newTestConfigWithAuthFile(t)
  1902. c.VisitorRequestLimitBurst = 3
  1903. c.VisitorSubscriberRateLimiting = false
  1904. s := newTestServer(t, c)
  1905. // Subscriber rate limiting is disabled!
  1906. // Registering visitor 1.2.3.4 to topic has no effect
  1907. rr := request(t, s, "GET", "/subscriber1topic/json?poll=1", "", map[string]string{
  1908. "Rate-Topics": "subscriber1topic",
  1909. }, func(r *http.Request) {
  1910. r.RemoteAddr = "1.2.3.4"
  1911. })
  1912. require.Equal(t, 200, rr.Code)
  1913. require.Equal(t, "", rr.Body.String())
  1914. require.Nil(t, s.topics["subscriber1topic"].rateVisitor)
  1915. // Registering visitor 8.7.7.1 to topic has no effect
  1916. rr = request(t, s, "GET", "/up012345678912/json?poll=1", "", nil, func(r *http.Request) {
  1917. r.RemoteAddr = "8.7.7.1"
  1918. })
  1919. require.Equal(t, 200, rr.Code)
  1920. require.Equal(t, "", rr.Body.String())
  1921. require.Nil(t, s.topics["up012345678912"].rateVisitor)
  1922. // Publish 3 messages to "subscriber1topic" as visitor 9.9.9.9
  1923. for i := 0; i < 3; i++ {
  1924. rr := request(t, s, "PUT", "/subscriber1topic", "some message", nil)
  1925. require.Equal(t, 200, rr.Code)
  1926. }
  1927. rr = request(t, s, "PUT", "/subscriber1topic", "some message", nil)
  1928. require.Equal(t, 429, rr.Code)
  1929. rr = request(t, s, "PUT", "/up012345678912", "some message", nil)
  1930. require.Equal(t, 429, rr.Code)
  1931. }
  1932. func TestServer_SubscriberRateLimiting_UP_Only(t *testing.T) {
  1933. c := newTestConfigWithAuthFile(t)
  1934. c.VisitorRequestLimitBurst = 3
  1935. c.VisitorSubscriberRateLimiting = true
  1936. s := newTestServer(t, c)
  1937. // "Register" 5 different UnifiedPush visitors
  1938. for i := 0; i < 5; i++ {
  1939. subscriberFn := func(r *http.Request) {
  1940. r.RemoteAddr = fmt.Sprintf("1.2.3.%d", i+1)
  1941. }
  1942. rr := request(t, s, "GET", fmt.Sprintf("/up12345678901%d/json?poll=1", i), "", nil, subscriberFn)
  1943. require.Equal(t, 200, rr.Code)
  1944. }
  1945. // Publish 2 messages per topic
  1946. for i := 0; i < 5; i++ {
  1947. for j := 0; j < 2; j++ {
  1948. rr := request(t, s, "PUT", fmt.Sprintf("/up12345678901%d?up=1", i), "some message", nil)
  1949. require.Equal(t, 200, rr.Code)
  1950. }
  1951. }
  1952. }
  1953. func TestServer_Matrix_SubscriberRateLimiting_UP_Only(t *testing.T) {
  1954. c := newTestConfig(t)
  1955. c.VisitorRequestLimitBurst = 3
  1956. c.VisitorSubscriberRateLimiting = true
  1957. s := newTestServer(t, c)
  1958. // "Register" 5 different UnifiedPush visitors
  1959. for i := 0; i < 5; i++ {
  1960. rr := request(t, s, "GET", fmt.Sprintf("/up12345678901%d/json?poll=1", i), "", nil, func(r *http.Request) {
  1961. r.RemoteAddr = fmt.Sprintf("1.2.3.%d", i+1)
  1962. })
  1963. require.Equal(t, 200, rr.Code)
  1964. }
  1965. // Publish 2 messages per topic
  1966. for i := 0; i < 5; i++ {
  1967. notification := fmt.Sprintf(`{"notification":{"devices":[{"pushkey":"http://127.0.0.1:12345/up12345678901%d?up=1"}]}}`, i)
  1968. for j := 0; j < 2; j++ {
  1969. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1970. require.Equal(t, 200, response.Code)
  1971. require.Equal(t, `{"rejected":[]}`+"\n", response.Body.String())
  1972. }
  1973. response := request(t, s, "POST", "/_matrix/push/v1/notify", notification, nil)
  1974. require.Equal(t, 429, response.Code, notification)
  1975. require.Equal(t, 42901, toHTTPError(t, response.Body.String()).Code)
  1976. }
  1977. }
  1978. func TestServer_SubscriberRateLimiting_VisitorExpiration(t *testing.T) {
  1979. c := newTestConfig(t)
  1980. c.VisitorRequestLimitBurst = 3
  1981. c.VisitorSubscriberRateLimiting = true
  1982. s := newTestServer(t, c)
  1983. // "Register" rate visitor
  1984. subscriberFn := func(r *http.Request) {
  1985. r.RemoteAddr = "1.2.3.4"
  1986. }
  1987. rr := request(t, s, "GET", "/mytopic/json?poll=1", "", map[string]string{
  1988. "rate-topics": "mytopic",
  1989. }, subscriberFn)
  1990. require.Equal(t, 200, rr.Code)
  1991. require.Equal(t, "1.2.3.4", s.topics["mytopic"].rateVisitor.ip.String())
  1992. require.Equal(t, s.visitors["ip:1.2.3.4"], s.topics["mytopic"].rateVisitor)
  1993. // Publish message, observe rate visitor tokens being decreased
  1994. response := request(t, s, "POST", "/mytopic", "some message", nil)
  1995. require.Equal(t, 200, response.Code)
  1996. require.Equal(t, int64(0), s.visitors["ip:9.9.9.9"].messagesLimiter.Value())
  1997. require.Equal(t, int64(1), s.topics["mytopic"].rateVisitor.messagesLimiter.Value())
  1998. require.Equal(t, s.visitors["ip:1.2.3.4"], s.topics["mytopic"].rateVisitor)
  1999. // Expire visitor
  2000. s.visitors["ip:1.2.3.4"].seen = time.Now().Add(-1 * 25 * time.Hour)
  2001. s.pruneVisitors()
  2002. // Publish message again, observe that rateVisitor is not used anymore and is reset
  2003. response = request(t, s, "POST", "/mytopic", "some message", nil)
  2004. require.Equal(t, 200, response.Code)
  2005. require.Equal(t, int64(1), s.visitors["ip:9.9.9.9"].messagesLimiter.Value())
  2006. require.Nil(t, s.topics["mytopic"].rateVisitor)
  2007. require.Nil(t, s.visitors["ip:1.2.3.4"])
  2008. }
  2009. func TestServer_SubscriberRateLimiting_ProtectedTopics(t *testing.T) {
  2010. c := newTestConfigWithAuthFile(t)
  2011. c.AuthDefault = user.PermissionDenyAll
  2012. c.VisitorSubscriberRateLimiting = true
  2013. s := newTestServer(t, c)
  2014. // Create some ACLs
  2015. require.Nil(t, s.userManager.AddTier(&user.Tier{
  2016. Code: "test",
  2017. MessageLimit: 5,
  2018. }))
  2019. require.Nil(t, s.userManager.AddUser("ben", "ben", user.RoleUser))
  2020. require.Nil(t, s.userManager.ChangeTier("ben", "test"))
  2021. require.Nil(t, s.userManager.AllowAccess("ben", "announcements", user.PermissionReadWrite))
  2022. require.Nil(t, s.userManager.AllowAccess(user.Everyone, "announcements", user.PermissionRead))
  2023. require.Nil(t, s.userManager.AllowAccess(user.Everyone, "public_topic", user.PermissionReadWrite))
  2024. require.Nil(t, s.userManager.AddUser("phil", "phil", user.RoleUser))
  2025. require.Nil(t, s.userManager.ChangeTier("phil", "test"))
  2026. require.Nil(t, s.userManager.AddReservation("phil", "reserved-for-phil", user.PermissionReadWrite))
  2027. // Set rate visitor as user "phil" on topic
  2028. // - "reserved-for-phil": Allowed, because I am the owner
  2029. // - "public_topic": Allowed, because it has read-write permissions for everyone
  2030. // - "announcements": NOT allowed, because it has read-only permissions for everyone
  2031. rr := request(t, s, "GET", "/reserved-for-phil,public_topic,announcements/json?poll=1", "", map[string]string{
  2032. "Authorization": util.BasicAuth("phil", "phil"),
  2033. "Rate-Topics": "reserved-for-phil,public_topic,announcements",
  2034. })
  2035. require.Equal(t, 200, rr.Code)
  2036. require.Equal(t, "phil", s.topics["reserved-for-phil"].rateVisitor.user.Name)
  2037. require.Equal(t, "phil", s.topics["public_topic"].rateVisitor.user.Name)
  2038. require.Nil(t, s.topics["announcements"].rateVisitor)
  2039. // Set rate visitor as user "ben" on topic
  2040. // - "reserved-for-phil": NOT allowed, because I am not the owner
  2041. // - "public_topic": Allowed, because it has read-write permissions for everyone
  2042. // - "announcements": Allowed, because I have read-write permissions
  2043. rr = request(t, s, "GET", "/reserved-for-phil,public_topic,announcements/json?poll=1", "", map[string]string{
  2044. "Authorization": util.BasicAuth("ben", "ben"),
  2045. "Rate-Topics": "reserved-for-phil,public_topic,announcements",
  2046. })
  2047. require.Equal(t, 200, rr.Code)
  2048. require.Equal(t, "phil", s.topics["reserved-for-phil"].rateVisitor.user.Name)
  2049. require.Equal(t, "ben", s.topics["public_topic"].rateVisitor.user.Name)
  2050. require.Equal(t, "ben", s.topics["announcements"].rateVisitor.user.Name)
  2051. }
  2052. func TestServer_SubscriberRateLimiting_ProtectedTopics_WithDefaultReadWrite(t *testing.T) {
  2053. c := newTestConfigWithAuthFile(t)
  2054. c.AuthDefault = user.PermissionReadWrite
  2055. c.VisitorSubscriberRateLimiting = true
  2056. s := newTestServer(t, c)
  2057. // Create some ACLs
  2058. require.Nil(t, s.userManager.AllowAccess(user.Everyone, "announcements", user.PermissionRead))
  2059. // Set rate visitor as ip:1.2.3.4 on topic
  2060. // - "up123456789012": Allowed, because no ACLs and nobody owns the topic
  2061. // - "announcements": NOT allowed, because it has read-only permissions for everyone
  2062. rr := request(t, s, "GET", "/up123456789012,announcements/json?poll=1", "", nil, func(r *http.Request) {
  2063. r.RemoteAddr = "1.2.3.4"
  2064. })
  2065. require.Equal(t, 200, rr.Code)
  2066. require.Equal(t, "1.2.3.4", s.topics["up123456789012"].rateVisitor.ip.String())
  2067. require.Nil(t, s.topics["announcements"].rateVisitor)
  2068. }
  2069. func TestServer_MessageHistoryAndStatsEndpoint(t *testing.T) {
  2070. c := newTestConfig(t)
  2071. c.ManagerInterval = 2 * time.Second
  2072. s := newTestServer(t, c)
  2073. // Publish some messages, and get stats
  2074. for i := 0; i < 5; i++ {
  2075. response := request(t, s, "POST", "/mytopic", "some message", nil)
  2076. require.Equal(t, 200, response.Code)
  2077. }
  2078. require.Equal(t, int64(5), s.messages)
  2079. require.Equal(t, []int64{0}, s.messagesHistory)
  2080. response := request(t, s, "GET", "/v1/stats", "", nil)
  2081. require.Equal(t, 200, response.Code)
  2082. require.Equal(t, `{"messages":5,"messages_rate":0}`+"\n", response.Body.String())
  2083. // Run manager and see message history update
  2084. s.execManager()
  2085. require.Equal(t, []int64{0, 5}, s.messagesHistory)
  2086. response = request(t, s, "GET", "/v1/stats", "", nil)
  2087. require.Equal(t, 200, response.Code)
  2088. require.Equal(t, `{"messages":5,"messages_rate":2.5}`+"\n", response.Body.String()) // 5 messages in 2 seconds = 2.5 messages per second
  2089. // Publish some more messages
  2090. for i := 0; i < 10; i++ {
  2091. response := request(t, s, "POST", "/mytopic", "some message", nil)
  2092. require.Equal(t, 200, response.Code)
  2093. }
  2094. require.Equal(t, int64(15), s.messages)
  2095. require.Equal(t, []int64{0, 5}, s.messagesHistory)
  2096. response = request(t, s, "GET", "/v1/stats", "", nil)
  2097. require.Equal(t, 200, response.Code)
  2098. require.Equal(t, `{"messages":15,"messages_rate":2.5}`+"\n", response.Body.String()) // Rate did not update yet
  2099. // Run manager and see message history update
  2100. s.execManager()
  2101. require.Equal(t, []int64{0, 5, 15}, s.messagesHistory)
  2102. response = request(t, s, "GET", "/v1/stats", "", nil)
  2103. require.Equal(t, 200, response.Code)
  2104. require.Equal(t, `{"messages":15,"messages_rate":3.75}`+"\n", response.Body.String()) // 15 messages in 4 seconds = 3.75 messages per second
  2105. }
  2106. func TestServer_MessageHistoryMaxSize(t *testing.T) {
  2107. s := newTestServer(t, newTestConfig(t))
  2108. for i := 0; i < 20; i++ {
  2109. s.messages = int64(i)
  2110. s.execManager()
  2111. }
  2112. require.Equal(t, []int64{10, 11, 12, 13, 14, 15, 16, 17, 18, 19}, s.messagesHistory)
  2113. }
  2114. func TestServer_MessageCountPersistence(t *testing.T) {
  2115. c := newTestConfig(t)
  2116. s := newTestServer(t, c)
  2117. s.messages = 1234
  2118. s.execManager()
  2119. waitFor(t, func() bool {
  2120. messages, err := s.messageCache.Stats()
  2121. require.Nil(t, err)
  2122. return messages == 1234
  2123. })
  2124. s = newTestServer(t, c)
  2125. require.Equal(t, int64(1234), s.messages)
  2126. }
  2127. func TestServer_PublishWithUTF8MimeHeader(t *testing.T) {
  2128. s := newTestServer(t, newTestConfig(t))
  2129. response := request(t, s, "POST", "/mytopic", "some attachment", map[string]string{
  2130. "X-Filename": "some =?UTF-8?q?=C3=A4?=ttachment.txt",
  2131. "X-Message": "=?UTF-8?B?8J+HqfCfh6o=?=",
  2132. "X-Title": "=?UTF-8?B?bnRmeSDlvojmo5I=?=, no really I mean it! =?UTF-8?Q?This is q=C3=BC=C3=B6ted-print=C3=A4ble.?=",
  2133. "X-Tags": "=?UTF-8?B?8J+HqfCfh6o=?=, =?UTF-8?B?bnRmeSDlvojmo5I=?=",
  2134. "X-Click": "=?uTf-8?b?aHR0cHM6Ly/wn5KpLmxh?=",
  2135. "X-Actions": "http, \"=?utf-8?q?Mettre =C3=A0 jour?=\", \"https://my.tld/webhook/netbird-update\"; =?utf-8?b?aHR0cCwg6L+Z5piv5LiA5Liq5qCH562+LCBodHRwczovL/CfkqkubGE=?=",
  2136. })
  2137. require.Equal(t, 200, response.Code)
  2138. m := toMessage(t, response.Body.String())
  2139. require.Equal(t, "🇩🇪", m.Message)
  2140. require.Equal(t, "ntfy 很棒, no really I mean it! This is qüöted-printäble.", m.Title)
  2141. require.Equal(t, "some ättachment.txt", m.Attachment.Name)
  2142. require.Equal(t, "🇩🇪", m.Tags[0])
  2143. require.Equal(t, "ntfy 很棒", m.Tags[1])
  2144. require.Equal(t, "https://💩.la", m.Click)
  2145. require.Equal(t, "Mettre à jour", m.Actions[0].Label)
  2146. require.Equal(t, "http", m.Actions[1].Action)
  2147. require.Equal(t, "这是一个标签", m.Actions[1].Label)
  2148. require.Equal(t, "https://💩.la", m.Actions[1].URL)
  2149. }
  2150. func TestServer_UpstreamBaseURL_Success(t *testing.T) {
  2151. var pollID atomic.Pointer[string]
  2152. upstreamServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  2153. body, err := io.ReadAll(r.Body)
  2154. require.Nil(t, err)
  2155. require.Equal(t, "/87c9cddf7b0105f5fe849bf084c6e600be0fde99be3223335199b4965bd7b735", r.URL.Path)
  2156. require.Equal(t, "", string(body))
  2157. require.NotEmpty(t, r.Header.Get("X-Poll-ID"))
  2158. pollID.Store(util.String(r.Header.Get("X-Poll-ID")))
  2159. }))
  2160. defer upstreamServer.Close()
  2161. c := newTestConfigWithAuthFile(t)
  2162. c.BaseURL = "http://myserver.internal"
  2163. c.UpstreamBaseURL = upstreamServer.URL
  2164. s := newTestServer(t, c)
  2165. // Send message, and wait for upstream server to receive it
  2166. response := request(t, s, "PUT", "/mytopic", `hi there`, nil)
  2167. require.Equal(t, 200, response.Code)
  2168. m := toMessage(t, response.Body.String())
  2169. require.NotEmpty(t, m.ID)
  2170. require.Equal(t, "hi there", m.Message)
  2171. waitFor(t, func() bool {
  2172. pID := pollID.Load()
  2173. return pID != nil && *pID == m.ID
  2174. })
  2175. }
  2176. func TestServer_UpstreamBaseURL_With_Access_Token_Success(t *testing.T) {
  2177. var pollID atomic.Pointer[string]
  2178. upstreamServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  2179. body, err := io.ReadAll(r.Body)
  2180. require.Nil(t, err)
  2181. require.Equal(t, "/a1c72bcb4daf5af54d13ef86aea8f76c11e8b88320d55f1811d5d7b173bcc1df", r.URL.Path)
  2182. require.Equal(t, "Bearer tk_1234567890", r.Header.Get("Authorization"))
  2183. require.Equal(t, "", string(body))
  2184. require.NotEmpty(t, r.Header.Get("X-Poll-ID"))
  2185. pollID.Store(util.String(r.Header.Get("X-Poll-ID")))
  2186. }))
  2187. defer upstreamServer.Close()
  2188. c := newTestConfigWithAuthFile(t)
  2189. c.BaseURL = "http://myserver.internal"
  2190. c.UpstreamBaseURL = upstreamServer.URL
  2191. c.UpstreamAccessToken = "tk_1234567890"
  2192. s := newTestServer(t, c)
  2193. // Send message, and wait for upstream server to receive it
  2194. response := request(t, s, "PUT", "/mytopic1", `hi there`, nil)
  2195. require.Equal(t, 200, response.Code)
  2196. m := toMessage(t, response.Body.String())
  2197. require.NotEmpty(t, m.ID)
  2198. require.Equal(t, "hi there", m.Message)
  2199. waitFor(t, func() bool {
  2200. pID := pollID.Load()
  2201. return pID != nil && *pID == m.ID
  2202. })
  2203. }
  2204. func TestServer_UpstreamBaseURL_DoNotForwardUnifiedPush(t *testing.T) {
  2205. upstreamServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  2206. t.Fatal("UnifiedPush messages should not be forwarded")
  2207. }))
  2208. defer upstreamServer.Close()
  2209. c := newTestConfigWithAuthFile(t)
  2210. c.BaseURL = "http://myserver.internal"
  2211. c.UpstreamBaseURL = upstreamServer.URL
  2212. s := newTestServer(t, c)
  2213. // Send UP message, this should not forward to upstream server
  2214. response := request(t, s, "PUT", "/mytopic?up=1", `hi there`, nil)
  2215. require.Equal(t, 200, response.Code)
  2216. m := toMessage(t, response.Body.String())
  2217. require.NotEmpty(t, m.ID)
  2218. require.Equal(t, "hi there", m.Message)
  2219. // Forwarding is done asynchronously, so wait a bit.
  2220. // This ensures that the t.Fatal above is actually not triggered.
  2221. time.Sleep(500 * time.Millisecond)
  2222. }
  2223. func newTestConfig(t *testing.T) *Config {
  2224. conf := NewConfig()
  2225. conf.BaseURL = "http://127.0.0.1:12345"
  2226. conf.CacheFile = filepath.Join(t.TempDir(), "cache.db")
  2227. conf.CacheStartupQueries = "pragma journal_mode = WAL; pragma synchronous = normal; pragma temp_store = memory;"
  2228. conf.AttachmentCacheDir = t.TempDir()
  2229. return conf
  2230. }
  2231. func configureAuth(t *testing.T, conf *Config) *Config {
  2232. conf.AuthFile = filepath.Join(t.TempDir(), "user.db")
  2233. conf.AuthStartupQueries = "pragma journal_mode = WAL; pragma synchronous = normal; pragma temp_store = memory;"
  2234. conf.AuthBcryptCost = bcrypt.MinCost // This speeds up tests a lot
  2235. return conf
  2236. }
  2237. func newTestConfigWithAuthFile(t *testing.T) *Config {
  2238. conf := newTestConfig(t)
  2239. conf = configureAuth(t, conf)
  2240. return conf
  2241. }
  2242. func newTestConfigWithWebPush(t *testing.T) *Config {
  2243. conf := newTestConfig(t)
  2244. privateKey, publicKey, err := webpush.GenerateVAPIDKeys()
  2245. require.Nil(t, err)
  2246. conf.WebPushFile = filepath.Join(t.TempDir(), "webpush.db")
  2247. conf.WebPushEmailAddress = "testing@example.com"
  2248. conf.WebPushPrivateKey = privateKey
  2249. conf.WebPushPublicKey = publicKey
  2250. return conf
  2251. }
  2252. func newTestServer(t *testing.T, config *Config) *Server {
  2253. server, err := New(config)
  2254. require.Nil(t, err)
  2255. return server
  2256. }
  2257. func request(t *testing.T, s *Server, method, url, body string, headers map[string]string, fn ...func(r *http.Request)) *httptest.ResponseRecorder {
  2258. rr := httptest.NewRecorder()
  2259. r, err := http.NewRequest(method, url, strings.NewReader(body))
  2260. if err != nil {
  2261. t.Fatal(err)
  2262. }
  2263. r.RemoteAddr = "9.9.9.9" // Used for tests
  2264. for k, v := range headers {
  2265. r.Header.Set(k, v)
  2266. }
  2267. for _, f := range fn {
  2268. f(r)
  2269. }
  2270. s.handle(rr, r)
  2271. return rr
  2272. }
  2273. func subscribe(t *testing.T, s *Server, url string, rr *httptest.ResponseRecorder) context.CancelFunc {
  2274. ctx, cancel := context.WithCancel(context.Background())
  2275. req, err := http.NewRequestWithContext(ctx, "GET", url, nil)
  2276. if err != nil {
  2277. t.Fatal(err)
  2278. }
  2279. done := make(chan bool)
  2280. go func() {
  2281. s.handle(rr, req)
  2282. done <- true
  2283. }()
  2284. cancelAndWaitForDone := func() {
  2285. time.Sleep(200 * time.Millisecond)
  2286. cancel()
  2287. <-done
  2288. }
  2289. time.Sleep(200 * time.Millisecond)
  2290. return cancelAndWaitForDone
  2291. }
  2292. func toMessages(t *testing.T, s string) []*message {
  2293. messages := make([]*message, 0)
  2294. scanner := bufio.NewScanner(strings.NewReader(s))
  2295. for scanner.Scan() {
  2296. messages = append(messages, toMessage(t, scanner.Text()))
  2297. }
  2298. return messages
  2299. }
  2300. func toMessage(t *testing.T, s string) *message {
  2301. var m message
  2302. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&m))
  2303. return &m
  2304. }
  2305. func toHTTPError(t *testing.T, s string) *errHTTP {
  2306. var e errHTTP
  2307. require.Nil(t, json.NewDecoder(strings.NewReader(s)).Decode(&e))
  2308. return &e
  2309. }
  2310. func readAll(t *testing.T, rc io.ReadCloser) string {
  2311. b, err := io.ReadAll(rc)
  2312. if err != nil {
  2313. t.Fatal(err)
  2314. }
  2315. return string(b)
  2316. }
  2317. func waitFor(t *testing.T, f func() bool) {
  2318. waitForWithMaxWait(t, 5*time.Second, f)
  2319. }
  2320. func waitForWithMaxWait(t *testing.T, maxWait time.Duration, f func() bool) {
  2321. start := time.Now()
  2322. for time.Since(start) < maxWait {
  2323. if f() {
  2324. return
  2325. }
  2326. time.Sleep(50 * time.Millisecond)
  2327. }
  2328. t.Fatalf("Function f did not succeed after %v: %v", maxWait, string(debug.Stack()))
  2329. }