server_test.go 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995
  1. package oscar
  2. import (
  3. "bufio"
  4. "bytes"
  5. "context"
  6. "io"
  7. "log/slog"
  8. "net"
  9. "strings"
  10. "sync"
  11. "testing"
  12. "time"
  13. "github.com/stretchr/testify/assert"
  14. "github.com/stretchr/testify/mock"
  15. "golang.org/x/time/rate"
  16. "github.com/mk6i/retro-aim-server/config"
  17. "github.com/mk6i/retro-aim-server/state"
  18. "github.com/mk6i/retro-aim-server/wire"
  19. )
  20. func TestServer_ListenAndServeAndShutdown(t *testing.T) {
  21. var mu sync.Mutex
  22. var received []string
  23. var msgWg sync.WaitGroup
  24. cfg := []config.Listener{
  25. {
  26. BOSListenAddress: ":15000",
  27. BOSAdvertisedHostPlain: "localhost",
  28. },
  29. {
  30. BOSListenAddress: ":15001",
  31. BOSAdvertisedHostPlain: "localhost",
  32. },
  33. {
  34. BOSListenAddress: ":15002",
  35. BOSAdvertisedHostPlain: "localhost",
  36. },
  37. }
  38. responses := []string{"hello1", "hello2", "hello2"}
  39. server := NewServer(
  40. nil,
  41. nil,
  42. nil,
  43. nil,
  44. slog.Default(),
  45. nil,
  46. nil,
  47. nil,
  48. wire.DefaultSNACRateLimits(),
  49. nil,
  50. cfg,
  51. func(ctx context.Context, sess *state.Session) error { return nil },
  52. func(ctx context.Context, sess *state.Session) {},
  53. )
  54. server.handler = func(ctx context.Context, conn net.Conn, listener config.Listener) error {
  55. go func() {
  56. <-ctx.Done()
  57. _ = conn.Close()
  58. }()
  59. for {
  60. r := bufio.NewReader(conn)
  61. line, err := r.ReadString('\n')
  62. if err != nil {
  63. break
  64. }
  65. mu.Lock()
  66. received = append(received, strings.TrimSpace(line))
  67. mu.Unlock()
  68. msgWg.Done()
  69. }
  70. return nil
  71. }
  72. server.shutdownCtx, server.shutdownCancel = context.WithCancel(context.Background())
  73. shutdownCh := make(chan struct{})
  74. go func() {
  75. defer close(shutdownCh)
  76. assert.NoError(t, server.ListenAndServe())
  77. }()
  78. // Wait for server to be ready by checking if ports are listening
  79. for i := 0; i < len(cfg); i++ {
  80. maxRetries := 10
  81. backoff := 5 * time.Millisecond
  82. for attempt := 0; attempt < maxRetries; attempt++ {
  83. conn, err := net.Dial("tcp", "localhost"+cfg[i].BOSListenAddress)
  84. if err == nil {
  85. conn.Close()
  86. break
  87. }
  88. if attempt == maxRetries-1 {
  89. t.Fatalf("Server not ready after %d attempts: %v", maxRetries, err)
  90. }
  91. time.Sleep(backoff)
  92. backoff *= 2
  93. }
  94. }
  95. for i := 0; i < len(cfg); i++ {
  96. msgWg.Add(1)
  97. // Connect and send message
  98. conn, err := net.Dial("tcp", "localhost"+cfg[i].BOSListenAddress)
  99. assert.NoError(t, err)
  100. _, err = conn.Write([]byte(responses[i] + "\n"))
  101. assert.NoError(t, err)
  102. }
  103. msgWg.Wait()
  104. // Shutdown
  105. ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
  106. defer cancel()
  107. err := server.Shutdown(ctx)
  108. assert.NoError(t, err)
  109. <-shutdownCh
  110. // Check what was received
  111. mu.Lock()
  112. defer mu.Unlock()
  113. assert.ElementsMatch(t, received, responses)
  114. }
  115. type fakeConn struct {
  116. net.Conn // embed the real connection
  117. local net.Addr
  118. remote net.Addr
  119. }
  120. func (f fakeConn) RemoteAddr() net.Addr { return f.remote }
  121. func TestOscarServer_RouteConnection_Auth_BUCP(t *testing.T) {
  122. serverConn, clientConn := net.Pipe()
  123. addr, err := net.ResolveTCPAddr("tcp", "127.0.0.1:8080")
  124. assert.NoError(t, err)
  125. clientFake := fakeConn{
  126. Conn: serverConn,
  127. local: addr,
  128. remote: addr,
  129. }
  130. go func() {
  131. defer func() {
  132. _ = clientConn.Close()
  133. }()
  134. // < receive FLAPSignonFrame
  135. flap := wire.FLAPFrame{}
  136. assert.NoError(t, wire.UnmarshalBE(&flap, clientConn))
  137. flapSignonFrame := wire.FLAPSignonFrame{}
  138. assert.NoError(t, wire.UnmarshalBE(&flapSignonFrame, bytes.NewBuffer(flap.Payload)))
  139. // > send FLAPSignonFrame
  140. flapSignonFrame = wire.FLAPSignonFrame{
  141. FLAPVersion: 1,
  142. }
  143. buf := &bytes.Buffer{}
  144. assert.NoError(t, wire.MarshalBE(flapSignonFrame, buf))
  145. flap = wire.FLAPFrame{
  146. StartMarker: 42,
  147. FrameType: wire.FLAPFrameSignon,
  148. Payload: buf.Bytes(),
  149. }
  150. assert.NoError(t, wire.MarshalBE(flap, clientConn))
  151. // > send SNAC_0x17_0x06_BUCPChallengeRequest
  152. flapc := wire.NewFlapClient(0, clientConn, clientConn)
  153. frame := wire.SNACFrame{
  154. FoodGroup: wire.BUCP,
  155. SubGroup: wire.BUCPChallengeRequest,
  156. }
  157. bodyIn := wire.SNAC_0x17_0x06_BUCPChallengeRequest{}
  158. assert.NoError(t, flapc.SendSNAC(frame, bodyIn))
  159. // < receive SNAC_0x17_0x07_BUCPChallengeResponse
  160. frame = wire.SNACFrame{}
  161. assert.NoError(t, flapc.ReceiveSNAC(&frame, &wire.SNAC_0x17_0x07_BUCPChallengeResponse{}))
  162. assert.Equal(t, wire.SNACFrame{FoodGroup: wire.BUCP, SubGroup: wire.BUCPChallengeResponse}, frame)
  163. // > send keep alive frame (like BSFlite does mid-login)
  164. assert.NoError(t, flapc.SendKeepAliveFrame())
  165. // > send SNAC_0x17_0x02_BUCPLoginRequest
  166. frame = wire.SNACFrame{
  167. FoodGroup: wire.BUCP,
  168. SubGroup: wire.BUCPLoginRequest,
  169. }
  170. assert.NoError(t, flapc.SendSNAC(frame, wire.SNAC_0x17_0x02_BUCPLoginRequest{}))
  171. // < receive SNAC_0x17_0x03_BUCPLoginResponse
  172. frame = wire.SNACFrame{}
  173. assert.NoError(t, flapc.ReceiveSNAC(&frame, &wire.SNAC_0x17_0x03_BUCPLoginResponse{}))
  174. assert.Equal(t, wire.SNACFrame{FoodGroup: wire.BUCP, SubGroup: wire.BUCPLoginResponse}, frame)
  175. }()
  176. wg := &sync.WaitGroup{}
  177. authService := newMockAuthService(t)
  178. authService.EXPECT().
  179. BUCPChallenge(matchContext(), mock.Anything, mock.Anything).
  180. Return(wire.SNACMessage{
  181. Frame: wire.SNACFrame{
  182. FoodGroup: wire.BUCP,
  183. SubGroup: wire.BUCPChallengeResponse,
  184. },
  185. Body: wire.SNAC_0x17_0x07_BUCPChallengeResponse{},
  186. }, nil)
  187. authService.EXPECT().
  188. BUCPLogin(matchContext(), mock.Anything, mock.Anything, "localhost:5190").
  189. Return(wire.SNACMessage{
  190. Frame: wire.SNACFrame{
  191. FoodGroup: wire.BUCP,
  192. SubGroup: wire.BUCPLoginResponse,
  193. },
  194. Body: wire.SNAC_0x17_0x03_BUCPLoginResponse{},
  195. }, nil)
  196. rt := oscarServer{
  197. AuthService: authService,
  198. Logger: slog.Default(),
  199. IPRateLimiter: NewIPRateLimiter(rate.Every(1*time.Minute), 10, 1*time.Minute),
  200. }
  201. assert.NoError(t, rt.routeConnection(context.Background(), clientFake, config.Listener{BOSAdvertisedHostPlain: "localhost:5190"}))
  202. wg.Wait()
  203. }
  204. func TestOscarServer_RouteConnection_Auth_FLAP(t *testing.T) {
  205. serverConn, clientConn := net.Pipe()
  206. addr, err := net.ResolveTCPAddr("tcp", "127.0.0.1:8080")
  207. assert.NoError(t, err)
  208. clientFake := fakeConn{
  209. Conn: serverConn,
  210. local: addr,
  211. remote: addr,
  212. }
  213. go func() {
  214. defer func() {
  215. _ = clientConn.Close()
  216. }()
  217. // < receive FLAPSignonFrame
  218. flap := wire.FLAPFrame{}
  219. assert.NoError(t, wire.UnmarshalBE(&flap, clientConn))
  220. flapSignonFrame := wire.FLAPSignonFrame{}
  221. assert.NoError(t, wire.UnmarshalBE(&flapSignonFrame, bytes.NewBuffer(flap.Payload)))
  222. // > send FLAPSignonFrame with screen name TLV (indicates FLAP auth)
  223. flapSignonFrame = wire.FLAPSignonFrame{
  224. FLAPVersion: 1,
  225. }
  226. // Add screen name TLV to indicate FLAP authentication
  227. flapSignonFrame.Append(wire.NewTLVBE(wire.LoginTLVTagsScreenName, "testuser"))
  228. // Add password hash TLV for authentication
  229. flapSignonFrame.Append(wire.NewTLVBE(wire.LoginTLVTagsPasswordHash, []byte("password_hash")))
  230. // Add client identity TLV
  231. flapSignonFrame.Append(wire.NewTLVBE(wire.LoginTLVTagsClientIdentity, "ICQ 2000b"))
  232. buf := &bytes.Buffer{}
  233. assert.NoError(t, wire.MarshalBE(flapSignonFrame, buf))
  234. flap = wire.FLAPFrame{
  235. StartMarker: 42,
  236. FrameType: wire.FLAPFrameSignon,
  237. Payload: buf.Bytes(),
  238. }
  239. assert.NoError(t, wire.MarshalBE(flap, clientConn))
  240. // < receive FLAPSignoffFrame with authentication result
  241. flap = wire.FLAPFrame{}
  242. assert.NoError(t, wire.UnmarshalBE(&flap, clientConn))
  243. assert.Equal(t, wire.FLAPFrameSignoff, flap.FrameType)
  244. // Parse the signoff frame payload to verify authentication response
  245. signoffTLVs := wire.TLVRestBlock{}
  246. assert.NoError(t, wire.UnmarshalBE(&signoffTLVs, bytes.NewBuffer(flap.Payload)))
  247. }()
  248. wg := &sync.WaitGroup{}
  249. authService := newMockAuthService(t)
  250. authService.EXPECT().
  251. FLAPLogin(matchContext(), mock.Anything, mock.Anything, "localhost:5190").
  252. Return(wire.TLVRestBlock{
  253. TLVList: []wire.TLV{
  254. wire.NewTLVBE(wire.LoginTLVTagsScreenName, "testuser"),
  255. wire.NewTLVBE(wire.LoginTLVTagsReconnectHere, "localhost:5190"),
  256. wire.NewTLVBE(wire.LoginTLVTagsAuthorizationCookie, []byte("auth-cookie")),
  257. },
  258. }, nil)
  259. rt := oscarServer{
  260. AuthService: authService,
  261. Logger: slog.Default(),
  262. IPRateLimiter: NewIPRateLimiter(rate.Every(1*time.Minute), 10, 1*time.Minute),
  263. }
  264. assert.NoError(t, rt.routeConnection(context.Background(), clientFake, config.Listener{BOSAdvertisedHostPlain: "localhost:5190"}))
  265. wg.Wait()
  266. }
  267. func TestOscarServer_RouteConnection_BOS(t *testing.T) {
  268. sess := state.NewSession()
  269. clientConn, serverConn := net.Pipe()
  270. addr, err := net.ResolveTCPAddr("tcp", "127.0.0.1:8080")
  271. assert.NoError(t, err)
  272. clientFake := fakeConn{
  273. Conn: serverConn,
  274. local: addr,
  275. remote: addr,
  276. }
  277. go func() {
  278. // < receive FLAPSignonFrame
  279. flap := wire.FLAPFrame{}
  280. assert.NoError(t, wire.UnmarshalBE(&flap, clientConn))
  281. flapSignonFrame := wire.FLAPSignonFrame{}
  282. assert.NoError(t, wire.UnmarshalBE(&flapSignonFrame, bytes.NewBuffer(flap.Payload)))
  283. // > send FLAPSignonFrame
  284. flapSignonFrame = wire.FLAPSignonFrame{
  285. FLAPVersion: 1,
  286. }
  287. flapSignonFrame.Append(wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("the-cookie")))
  288. buf := &bytes.Buffer{}
  289. assert.NoError(t, wire.MarshalBE(flapSignonFrame, buf))
  290. flap = wire.FLAPFrame{
  291. StartMarker: 42,
  292. FrameType: wire.FLAPFrameSignon,
  293. Payload: buf.Bytes(),
  294. }
  295. assert.NoError(t, wire.MarshalBE(flap, clientConn))
  296. flapc := wire.NewFlapClient(0, clientConn, clientConn)
  297. // < receive SNAC_0x01_0x03_OServiceHostOnline
  298. frame := wire.SNACFrame{}
  299. body := wire.SNAC_0x01_0x03_OServiceHostOnline{}
  300. assert.NoError(t, flapc.ReceiveSNAC(&frame, &body))
  301. // send the first request that should get relayed to BOSRouter.Handle
  302. frame = wire.SNACFrame{
  303. FoodGroup: wire.OService,
  304. SubGroup: wire.OServiceClientOnline,
  305. }
  306. assert.NoError(t, flapc.SendSNAC(frame, struct{}{}))
  307. assert.NoError(t, clientConn.Close())
  308. }()
  309. wg := &sync.WaitGroup{}
  310. authService := newMockAuthService(t)
  311. authService.EXPECT().
  312. RegisterBOSSession(mock.Anything, state.ServerCookie{Service: wire.BOS}).
  313. Return(sess, nil)
  314. wg.Add(1)
  315. authService.EXPECT().
  316. Signout(mock.Anything, sess).
  317. Run(func(ctx context.Context, s *state.Session) {
  318. defer wg.Done()
  319. })
  320. authService.EXPECT().
  321. CrackCookie(mock.Anything).
  322. Return(state.ServerCookie{Service: wire.BOS}, nil)
  323. onlineNotifier := newMockOnlineNotifier(t)
  324. onlineNotifier.EXPECT().
  325. HostOnline(mock.Anything).
  326. Return(wire.SNACMessage{
  327. Frame: wire.SNACFrame{
  328. FoodGroup: wire.OService,
  329. SubGroup: wire.OServiceHostOnline,
  330. },
  331. Body: wire.SNAC_0x01_0x03_OServiceHostOnline{},
  332. })
  333. buddyListRegistry := newMockBuddyListRegistry(t)
  334. buddyListRegistry.EXPECT().
  335. RegisterBuddyList(mock.Anything, mock.Anything).
  336. Return(nil)
  337. buddyListRegistry.EXPECT().
  338. UnregisterBuddyList(mock.Anything, mock.Anything).
  339. Return(nil)
  340. departureNotifier := newMockDepartureNotifier(t)
  341. departureNotifier.EXPECT().
  342. BroadcastBuddyDeparted(mock.Anything, mock.Anything).
  343. Return(nil)
  344. chatSessionManager := newMockChatSessionManager(t)
  345. chatSessionManager.EXPECT().
  346. RemoveUserFromAllChats(mock.Anything)
  347. wg.Add(2)
  348. handler := func(ctx context.Context, serverType uint16, sess *state.Session, inFrame wire.SNACFrame, r io.Reader, rw ResponseWriter, listener config.Listener) error {
  349. defer wg.Done()
  350. return nil
  351. }
  352. rt := oscarServer{
  353. AuthService: authService,
  354. SNACHandler: handler,
  355. Logger: slog.Default(),
  356. OnlineNotifier: onlineNotifier,
  357. BuddyListRegistry: buddyListRegistry,
  358. ChatSessionManager: chatSessionManager,
  359. DepartureNotifier: departureNotifier,
  360. recalcWarning: func(ctx context.Context, sess *state.Session) error {
  361. return nil
  362. },
  363. lowerWarnLevel: func(ctx context.Context, sess *state.Session) {
  364. defer wg.Done()
  365. },
  366. }
  367. assert.NoError(t, rt.routeConnection(context.Background(), clientFake, config.Listener{}))
  368. wg.Wait()
  369. }
  370. func TestOscarServer_RouteConnection_Chat(t *testing.T) {
  371. sess := state.NewSession()
  372. clientConn, serverConn := net.Pipe()
  373. addr, err := net.ResolveTCPAddr("tcp", "127.0.0.1:8080")
  374. assert.NoError(t, err)
  375. clientFake := fakeConn{
  376. Conn: serverConn,
  377. local: addr,
  378. remote: addr,
  379. }
  380. go func() {
  381. // < receive FLAPSignonFrame
  382. flap := wire.FLAPFrame{}
  383. assert.NoError(t, wire.UnmarshalBE(&flap, clientConn))
  384. flapSignonFrame := wire.FLAPSignonFrame{}
  385. assert.NoError(t, wire.UnmarshalBE(&flapSignonFrame, bytes.NewBuffer(flap.Payload)))
  386. // > send FLAPSignonFrame
  387. flapSignonFrame = wire.FLAPSignonFrame{
  388. FLAPVersion: 1,
  389. }
  390. flapSignonFrame.Append(wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("the-cookie")))
  391. buf := &bytes.Buffer{}
  392. assert.NoError(t, wire.MarshalBE(flapSignonFrame, buf))
  393. flap = wire.FLAPFrame{
  394. StartMarker: 42,
  395. FrameType: wire.FLAPFrameSignon,
  396. Payload: buf.Bytes(),
  397. }
  398. assert.NoError(t, wire.MarshalBE(flap, clientConn))
  399. flapc := wire.NewFlapClient(0, clientConn, clientConn)
  400. // < receive SNAC_0x01_0x03_OServiceHostOnline
  401. frame := wire.SNACFrame{}
  402. body := wire.SNAC_0x01_0x03_OServiceHostOnline{}
  403. assert.NoError(t, flapc.ReceiveSNAC(&frame, &body))
  404. // send the first request that should get relayed to BOSRouter.Handle
  405. frame = wire.SNACFrame{
  406. FoodGroup: wire.OService,
  407. SubGroup: wire.OServiceClientOnline,
  408. }
  409. assert.NoError(t, flapc.SendSNAC(frame, struct{}{}))
  410. assert.NoError(t, clientConn.Close())
  411. }()
  412. wg := &sync.WaitGroup{}
  413. authService := newMockAuthService(t)
  414. authService.EXPECT().
  415. RegisterChatSession(mock.Anything, state.ServerCookie{Service: wire.Chat}).
  416. Return(sess, nil)
  417. wg.Add(1)
  418. authService.EXPECT().
  419. SignoutChat(mock.Anything, sess).
  420. Run(func(ctx context.Context, s *state.Session) {
  421. defer wg.Done()
  422. })
  423. authService.EXPECT().
  424. CrackCookie(mock.Anything).
  425. Return(state.ServerCookie{Service: wire.Chat}, nil)
  426. onlineNotifier := newMockOnlineNotifier(t)
  427. onlineNotifier.EXPECT().
  428. HostOnline(mock.Anything).
  429. Return(wire.SNACMessage{
  430. Frame: wire.SNACFrame{
  431. FoodGroup: wire.OService,
  432. SubGroup: wire.OServiceHostOnline,
  433. },
  434. Body: wire.SNAC_0x01_0x03_OServiceHostOnline{},
  435. })
  436. buddyListRegistry := newMockBuddyListRegistry(t)
  437. departureNotifier := newMockDepartureNotifier(t)
  438. chatSessionManager := newMockChatSessionManager(t)
  439. wg.Add(1)
  440. handler := func(ctx context.Context, serverType uint16, sess *state.Session, inFrame wire.SNACFrame, r io.Reader, rw ResponseWriter, listener config.Listener) error {
  441. defer wg.Done()
  442. return nil
  443. }
  444. rt := oscarServer{
  445. AuthService: authService,
  446. SNACHandler: handler,
  447. Logger: slog.Default(),
  448. OnlineNotifier: onlineNotifier,
  449. BuddyListRegistry: buddyListRegistry,
  450. ChatSessionManager: chatSessionManager,
  451. DepartureNotifier: departureNotifier,
  452. }
  453. assert.NoError(t, rt.routeConnection(context.Background(), clientFake, config.Listener{}))
  454. wg.Wait()
  455. }
  456. func TestOscarServer_RouteConnection_Admin(t *testing.T) {
  457. sess := state.NewSession()
  458. clientConn, serverConn := net.Pipe()
  459. addr, err := net.ResolveTCPAddr("tcp", "127.0.0.1:8080")
  460. assert.NoError(t, err)
  461. clientFake := fakeConn{
  462. Conn: serverConn,
  463. local: addr,
  464. remote: addr,
  465. }
  466. go func() {
  467. // < receive FLAPSignonFrame
  468. flap := wire.FLAPFrame{}
  469. assert.NoError(t, wire.UnmarshalBE(&flap, clientConn))
  470. flapSignonFrame := wire.FLAPSignonFrame{}
  471. assert.NoError(t, wire.UnmarshalBE(&flapSignonFrame, bytes.NewBuffer(flap.Payload)))
  472. // > send FLAPSignonFrame
  473. flapSignonFrame = wire.FLAPSignonFrame{
  474. FLAPVersion: 1,
  475. }
  476. flapSignonFrame.Append(wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("the-cookie")))
  477. buf := &bytes.Buffer{}
  478. assert.NoError(t, wire.MarshalBE(flapSignonFrame, buf))
  479. flap = wire.FLAPFrame{
  480. StartMarker: 42,
  481. FrameType: wire.FLAPFrameSignon,
  482. Payload: buf.Bytes(),
  483. }
  484. assert.NoError(t, wire.MarshalBE(flap, clientConn))
  485. flapc := wire.NewFlapClient(0, clientConn, clientConn)
  486. // < receive SNAC_0x01_0x03_OServiceHostOnline
  487. frame := wire.SNACFrame{}
  488. body := wire.SNAC_0x01_0x03_OServiceHostOnline{}
  489. assert.NoError(t, flapc.ReceiveSNAC(&frame, &body))
  490. // send the first request that should get relayed to BOSRouter.Handle
  491. frame = wire.SNACFrame{
  492. FoodGroup: wire.OService,
  493. SubGroup: wire.OServiceClientOnline,
  494. }
  495. assert.NoError(t, flapc.SendSNAC(frame, struct{}{}))
  496. assert.NoError(t, clientConn.Close())
  497. }()
  498. wg := &sync.WaitGroup{}
  499. authService := newMockAuthService(t)
  500. authService.EXPECT().
  501. CrackCookie(mock.Anything).
  502. Return(state.ServerCookie{Service: wire.Admin}, nil)
  503. authService.EXPECT().
  504. RetrieveBOSSession(mock.Anything, state.ServerCookie{Service: wire.Admin}).
  505. Return(sess, nil)
  506. onlineNotifier := newMockOnlineNotifier(t)
  507. onlineNotifier.EXPECT().
  508. HostOnline(mock.Anything).
  509. Return(wire.SNACMessage{
  510. Frame: wire.SNACFrame{
  511. FoodGroup: wire.OService,
  512. SubGroup: wire.OServiceHostOnline,
  513. },
  514. Body: wire.SNAC_0x01_0x03_OServiceHostOnline{},
  515. })
  516. buddyListRegistry := newMockBuddyListRegistry(t)
  517. departureNotifier := newMockDepartureNotifier(t)
  518. chatSessionManager := newMockChatSessionManager(t)
  519. wg.Add(1)
  520. handler := func(ctx context.Context, serverType uint16, sess *state.Session, inFrame wire.SNACFrame, r io.Reader, rw ResponseWriter, listener config.Listener) error {
  521. defer wg.Done()
  522. return nil
  523. }
  524. rt := oscarServer{
  525. AuthService: authService,
  526. SNACHandler: handler,
  527. Logger: slog.Default(),
  528. OnlineNotifier: onlineNotifier,
  529. BuddyListRegistry: buddyListRegistry,
  530. ChatSessionManager: chatSessionManager,
  531. DepartureNotifier: departureNotifier,
  532. }
  533. assert.NoError(t, rt.routeConnection(context.Background(), clientFake, config.Listener{}))
  534. wg.Wait()
  535. }
  536. // Make sure the client receives signoff FLAP when the server shuts down via
  537. // context cancellation.
  538. func Test_oscarServer_dispatchIncomingMessages_shutdownSignoff(t *testing.T) {
  539. clientConn, serverConn := net.Pipe()
  540. ctx, cancel := context.WithCancel(context.Background())
  541. var wg sync.WaitGroup
  542. wg.Add(1)
  543. go func() {
  544. defer wg.Done()
  545. srv := oscarServer{
  546. Logger: slog.Default(),
  547. }
  548. sess := state.NewSession()
  549. sess.SetMultiConnFlag(wire.MultiConnFlagsRecentClient)
  550. flapc := wire.NewFlapClient(0, serverConn, serverConn)
  551. err := srv.dispatchIncomingMessages(ctx, wire.BOS, sess, flapc, serverConn, config.Listener{})
  552. assert.NoError(t, err)
  553. }()
  554. cancel()
  555. flapc := wire.NewFlapClient(0, clientConn, clientConn)
  556. frame, err := flapc.ReceiveFLAP()
  557. assert.NoError(t, err)
  558. assert.Equal(t, wire.FLAPFrameSignoff, frame.FrameType)
  559. wg.Wait()
  560. }
  561. // Make sure the client (which doesn't support multi-conn) receives
  562. // disconnection signoff FLAP when the session gets logged off by a new session.
  563. func Test_oscarServer_dispatchIncomingMessages_disconnect_old_client(t *testing.T) {
  564. clientConn, serverConn := net.Pipe()
  565. ctx := context.Background()
  566. sess := state.NewSession()
  567. sess.SetMultiConnFlag(wire.MultiConnFlagsOldClient)
  568. var wg sync.WaitGroup
  569. wg.Add(1)
  570. go func() {
  571. defer wg.Done()
  572. srv := oscarServer{
  573. Logger: slog.Default(),
  574. }
  575. flapc := wire.NewFlapClient(0, serverConn, serverConn)
  576. err := srv.dispatchIncomingMessages(ctx, wire.BOS, sess, flapc, serverConn, config.Listener{})
  577. assert.NoError(t, err)
  578. }()
  579. sess.Close()
  580. frame := wire.FLAPFrameDisconnect{}
  581. assert.NoError(t, wire.UnmarshalBE(&frame, clientConn))
  582. assert.Equal(t, wire.FLAPFrameSignoff, frame.FrameType)
  583. wg.Wait()
  584. }
  585. // Make sure the client (which supports multi-conn) receives disconnection
  586. // signoff FLAP when the session gets logged off by a new session.
  587. func Test_oscarServer_dispatchIncomingMessages_disconnect_new_client(t *testing.T) {
  588. clientConn, serverConn := net.Pipe()
  589. ctx := context.Background()
  590. sess := state.NewSession()
  591. sess.SetMultiConnFlag(wire.MultiConnFlagsRecentClient)
  592. var wg sync.WaitGroup
  593. wg.Add(1)
  594. go func() {
  595. defer wg.Done()
  596. srv := oscarServer{
  597. Logger: slog.Default(),
  598. }
  599. flapc := wire.NewFlapClient(0, serverConn, serverConn)
  600. err := srv.dispatchIncomingMessages(ctx, wire.BOS, sess, flapc, serverConn, config.Listener{})
  601. assert.NoError(t, err)
  602. }()
  603. sess.Close()
  604. flapc := wire.NewFlapClient(0, clientConn, clientConn)
  605. frame, err := flapc.ReceiveFLAP()
  606. assert.NoError(t, err)
  607. assert.Equal(t, wire.FLAPFrameSignoff, frame.FrameType)
  608. wg.Wait()
  609. }
  610. func Test_oscarServer_receiveSessMessages_BOS_integration(t *testing.T) {
  611. serverConn, clientConn := net.Pipe()
  612. defer serverConn.Close()
  613. defer clientConn.Close()
  614. // Prepare session and mocks so we can exercise through routeConnection
  615. sess := state.NewSession()
  616. authService := newMockAuthService(t)
  617. authService.EXPECT().
  618. CrackCookie(mock.Anything).
  619. Return(state.ServerCookie{Service: wire.BOS}, nil)
  620. authService.EXPECT().
  621. RegisterBOSSession(mock.Anything, state.ServerCookie{Service: wire.BOS}).
  622. Return(sess, nil)
  623. var signoutWG sync.WaitGroup
  624. signoutWG.Add(1)
  625. authService.EXPECT().
  626. Signout(mock.Anything, sess).
  627. Run(func(ctx context.Context, s *state.Session) { signoutWG.Done() })
  628. onlineNotifier := newMockOnlineNotifier(t)
  629. onlineNotifier.EXPECT().
  630. HostOnline(mock.Anything).
  631. Return(wire.SNACMessage{
  632. Frame: wire.SNACFrame{FoodGroup: wire.OService, SubGroup: wire.OServiceHostOnline},
  633. Body: wire.SNAC_0x01_0x03_OServiceHostOnline{},
  634. })
  635. buddyListRegistry := newMockBuddyListRegistry(t)
  636. buddyListRegistry.EXPECT().RegisterBuddyList(mock.Anything, mock.Anything).Return(nil)
  637. buddyListRegistry.EXPECT().UnregisterBuddyList(mock.Anything, mock.Anything).Return(nil)
  638. departureNotifier := newMockDepartureNotifier(t)
  639. departureNotifier.EXPECT().BroadcastBuddyDeparted(mock.Anything, mock.Anything).Return(nil)
  640. chatSessionManager := newMockChatSessionManager(t)
  641. chatSessionManager.EXPECT().RemoveUserFromAllChats(mock.Anything)
  642. server := oscarServer{
  643. AuthService: authService,
  644. BuddyListRegistry: buddyListRegistry,
  645. ChatSessionManager: chatSessionManager,
  646. DepartureNotifier: departureNotifier,
  647. OnlineNotifier: onlineNotifier,
  648. Logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  649. recalcWarning: func(ctx context.Context, sess *state.Session) error { return nil },
  650. lowerWarnLevel: func(ctx context.Context, sess *state.Session) {},
  651. }
  652. // Fake client connection with address
  653. addr, err := net.ResolveTCPAddr("tcp", "127.0.0.1:8080")
  654. assert.NoError(t, err)
  655. clientFake := fakeConn{Conn: serverConn, local: addr, remote: addr}
  656. // Coordinate when the server has finished login and sent HostOnline
  657. ready := make(chan struct{})
  658. // Client goroutine: perform handshake and then read forwarded messages
  659. go func() {
  660. // < receive FLAPSignonFrame
  661. flap := wire.FLAPFrame{}
  662. _ = wire.UnmarshalBE(&flap, clientConn)
  663. flapSignon := wire.FLAPSignonFrame{}
  664. _ = wire.UnmarshalBE(&flapSignon, bytes.NewBuffer(flap.Payload))
  665. // > send FLAPSignonFrame with login cookie
  666. flapSignon = wire.FLAPSignonFrame{FLAPVersion: 1}
  667. flapSignon.Append(wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("the-cookie")))
  668. buf := &bytes.Buffer{}
  669. _ = wire.MarshalBE(flapSignon, buf)
  670. _ = wire.MarshalBE(wire.FLAPFrame{StartMarker: 42, FrameType: wire.FLAPFrameSignon, Payload: buf.Bytes()}, clientConn)
  671. // Expect HostOnline
  672. flapcClient := wire.NewFlapClient(0, clientConn, clientConn)
  673. fr := wire.SNACFrame{}
  674. body := wire.SNAC_0x01_0x03_OServiceHostOnline{}
  675. _ = flapcClient.ReceiveSNAC(&fr, &body)
  676. close(ready)
  677. }()
  678. // Run the server handler in background so we can drive the session
  679. doneServer := make(chan error, 1)
  680. go func() { doneServer <- server.routeConnection(context.Background(), clientFake, config.Listener{}) }()
  681. // Wait for HostOnline to be received so session is ready
  682. select {
  683. case <-ready:
  684. case <-time.After(5 * time.Second):
  685. t.Fatal("server did not complete login in time")
  686. }
  687. // Now send messages via the session and verify client receives them
  688. messages := []wire.SNACMessage{
  689. {
  690. Frame: wire.SNACFrame{FoodGroup: wire.Buddy, SubGroup: wire.BuddyArrived},
  691. Body: wire.SNAC_0x03_0x0B_BuddyArrived{TLVUserInfo: wire.TLVUserInfo{ScreenName: "user1"}},
  692. },
  693. {
  694. Frame: wire.SNACFrame{FoodGroup: wire.Buddy, SubGroup: wire.BuddyDeparted},
  695. Body: wire.SNAC_0x03_0x0C_BuddyDeparted{TLVUserInfo: wire.TLVUserInfo{ScreenName: "user2"}},
  696. },
  697. {
  698. Frame: wire.SNACFrame{FoodGroup: wire.ICBM, SubGroup: 0x07},
  699. Body: wire.SNAC_0x04_0x07_ICBMChannelMsgToClient{Cookie: 12345, ChannelID: 1, TLVUserInfo: wire.TLVUserInfo{ScreenName: "sender"}},
  700. },
  701. }
  702. for i, msg := range messages {
  703. status := sess.RelayMessage(msg)
  704. assert.Equal(t, state.SessSendOK, status, "Message %d should be sent successfully", i)
  705. }
  706. // Read and verify all messages from client side
  707. for i, expected := range messages {
  708. flapFrame := wire.FLAPFrame{}
  709. err := wire.UnmarshalBE(&flapFrame, clientConn)
  710. assert.NoError(t, err, "read FLAP frame %d", i)
  711. assert.Equal(t, uint8(42), flapFrame.StartMarker)
  712. assert.Equal(t, wire.FLAPFrameData, flapFrame.FrameType)
  713. snac := wire.SNACFrame{}
  714. buf := bytes.NewBuffer(flapFrame.Payload)
  715. err = wire.UnmarshalBE(&snac, buf)
  716. assert.NoError(t, err, "unmarshal SNAC %d", i)
  717. assert.Equal(t, expected.Frame.FoodGroup, snac.FoodGroup)
  718. assert.Equal(t, expected.Frame.SubGroup, snac.SubGroup)
  719. }
  720. // Close client to let server exit cleanly
  721. _ = clientConn.Close()
  722. // Wait for server handler to return
  723. select {
  724. case err := <-doneServer:
  725. assert.NoError(t, err)
  726. case <-time.After(5 * time.Second):
  727. t.Fatal("routeConnection did not exit in time")
  728. }
  729. // Ensure signout ran
  730. signoutWG.Wait()
  731. }
  732. func Test_oscarServer_receiveSessMessages_Chat_integration(t *testing.T) {
  733. serverConn, clientConn := net.Pipe()
  734. defer serverConn.Close()
  735. defer clientConn.Close()
  736. // Prepare session and mocks so we can exercise through routeConnection
  737. sess := state.NewSession()
  738. authService := newMockAuthService(t)
  739. authService.EXPECT().
  740. CrackCookie(mock.Anything).
  741. Return(state.ServerCookie{Service: wire.Chat}, nil)
  742. authService.EXPECT().
  743. RegisterChatSession(mock.Anything, state.ServerCookie{Service: wire.Chat}).
  744. Return(sess, nil)
  745. var signoutWG sync.WaitGroup
  746. signoutWG.Add(1)
  747. authService.EXPECT().
  748. SignoutChat(mock.Anything, sess).
  749. Run(func(ctx context.Context, s *state.Session) { signoutWG.Done() })
  750. onlineNotifier := newMockOnlineNotifier(t)
  751. onlineNotifier.EXPECT().
  752. HostOnline(mock.Anything).
  753. Return(wire.SNACMessage{
  754. Frame: wire.SNACFrame{FoodGroup: wire.OService, SubGroup: wire.OServiceHostOnline},
  755. Body: wire.SNAC_0x01_0x03_OServiceHostOnline{},
  756. })
  757. server := oscarServer{
  758. AuthService: authService,
  759. OnlineNotifier: onlineNotifier,
  760. Logger: slog.New(slog.NewTextHandler(io.Discard, nil)),
  761. }
  762. // Fake client connection with address
  763. addr, err := net.ResolveTCPAddr("tcp", "127.0.0.1:8080")
  764. assert.NoError(t, err)
  765. clientFake := fakeConn{Conn: serverConn, local: addr, remote: addr}
  766. ready := make(chan struct{})
  767. // Client goroutine: perform handshake and then read forwarded messages
  768. go func() {
  769. // < receive FLAPSignonFrame
  770. flap := wire.FLAPFrame{}
  771. _ = wire.UnmarshalBE(&flap, clientConn)
  772. flapSignon := wire.FLAPSignonFrame{}
  773. _ = wire.UnmarshalBE(&flapSignon, bytes.NewBuffer(flap.Payload))
  774. // > send FLAPSignonFrame with login cookie
  775. flapSignon = wire.FLAPSignonFrame{FLAPVersion: 1}
  776. flapSignon.Append(wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("the-cookie")))
  777. buf := &bytes.Buffer{}
  778. _ = wire.MarshalBE(flapSignon, buf)
  779. _ = wire.MarshalBE(wire.FLAPFrame{StartMarker: 42, FrameType: wire.FLAPFrameSignon, Payload: buf.Bytes()}, clientConn)
  780. // Expect HostOnline
  781. flapcClient := wire.NewFlapClient(0, clientConn, clientConn)
  782. fr := wire.SNACFrame{}
  783. body := wire.SNAC_0x01_0x03_OServiceHostOnline{}
  784. _ = flapcClient.ReceiveSNAC(&fr, &body)
  785. close(ready)
  786. }()
  787. // Run the server handler in background so we can drive the session
  788. doneServer := make(chan error, 1)
  789. go func() { doneServer <- server.routeConnection(context.Background(), clientFake, config.Listener{}) }()
  790. // Wait for HostOnline to be received so session is ready
  791. select {
  792. case <-ready:
  793. case <-time.After(5 * time.Second):
  794. t.Fatal("server did not complete login in time")
  795. }
  796. messages := []wire.SNACMessage{
  797. {
  798. Frame: wire.SNACFrame{FoodGroup: wire.Chat, SubGroup: wire.ChatUsersJoined},
  799. Body: wire.SNAC_0x0E_0x03_ChatUsersJoined{Users: []wire.TLVUserInfo{{ScreenName: "user1"}}},
  800. },
  801. {
  802. Frame: wire.SNACFrame{FoodGroup: wire.Chat, SubGroup: wire.ChatUsersLeft},
  803. Body: wire.SNAC_0x0E_0x04_ChatUsersLeft{Users: []wire.TLVUserInfo{{ScreenName: "user2"}}},
  804. },
  805. {
  806. Frame: wire.SNACFrame{FoodGroup: wire.Chat, SubGroup: wire.ChatChannelMsgToClient},
  807. Body: wire.SNAC_0x0E_0x06_ChatChannelMsgToClient{
  808. Cookie: 12345, Channel: 1,
  809. TLVRestBlock: wire.TLVRestBlock{TLVList: wire.TLVList{
  810. wire.NewTLVBE(wire.ChatTLVSenderInformation, wire.TLVUserInfo{ScreenName: "sender"}),
  811. wire.NewTLVBE(wire.ChatTLVMessageInfo, wire.TLVRestBlock{TLVList: wire.TLVList{
  812. wire.NewTLVBE(wire.ChatTLVMessageInfoText, "Hello chat!"),
  813. }}),
  814. }},
  815. },
  816. },
  817. }
  818. for i, msg := range messages {
  819. status := sess.RelayMessage(msg)
  820. assert.Equal(t, state.SessSendOK, status, "Message %d should be sent successfully", i)
  821. }
  822. for i, expected := range messages {
  823. flapFrame := wire.FLAPFrame{}
  824. err := wire.UnmarshalBE(&flapFrame, clientConn)
  825. assert.NoError(t, err, "read FLAP frame %d", i)
  826. assert.Equal(t, uint8(42), flapFrame.StartMarker)
  827. assert.Equal(t, wire.FLAPFrameData, flapFrame.FrameType)
  828. snac := wire.SNACFrame{}
  829. buf := bytes.NewBuffer(flapFrame.Payload)
  830. err = wire.UnmarshalBE(&snac, buf)
  831. assert.NoError(t, err, "unmarshal SNAC %d", i)
  832. assert.Equal(t, expected.Frame.FoodGroup, snac.FoodGroup)
  833. assert.Equal(t, expected.Frame.SubGroup, snac.SubGroup)
  834. }
  835. _ = clientConn.Close()
  836. select {
  837. case err := <-doneServer:
  838. assert.NoError(t, err)
  839. case <-time.After(5 * time.Second):
  840. t.Fatal("routeConnection did not exit in time")
  841. }
  842. signoutWG.Wait()
  843. }