server.go 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435
  1. package webapi
  2. import (
  3. "context"
  4. "errors"
  5. "fmt"
  6. "log/slog"
  7. "net/http"
  8. "time"
  9. "golang.org/x/sync/errgroup"
  10. "github.com/mk6i/open-oscar-server/server/webapi/handlers"
  11. "github.com/mk6i/open-oscar-server/server/webapi/middleware"
  12. "github.com/mk6i/open-oscar-server/state"
  13. )
  14. func NewServer(listeners []string, logger *slog.Logger, handler Handler, apiKeyValidator middleware.APIKeyValidator, sessionManager *state.WebAPISessionManager) *Server {
  15. servers := make([]*http.Server, 0, len(listeners))
  16. authMiddleware := middleware.NewAuthMiddleware(apiKeyValidator, logger)
  17. authHandler := &handlers.AuthHandler{
  18. AuthService: handler.AuthService,
  19. CookieBaker: handler.CookieBaker,
  20. Logger: logger,
  21. }
  22. sessionHandler := &handlers.SessionHandler{
  23. SessionManager: sessionManager,
  24. OSCARAuthService: handler.AuthService,
  25. FeedbagService: handler.FeedbagService,
  26. BuddyListManager: handler.BuddyListManager.(*handlers.BuddyListManager),
  27. IconSource: handler.IconSource,
  28. Logger: logger,
  29. OServiceService: handler.OServiceService,
  30. }
  31. eventsHandler := &handlers.EventsHandler{
  32. SessionManager: sessionManager,
  33. Logger: logger,
  34. }
  35. presenceHandler := &handlers.PresenceHandler{
  36. SessionManager: sessionManager,
  37. FeedbagService: handler.FeedbagService,
  38. BuddyBroadcaster: handler.BuddyBroadcaster,
  39. LocateService: handler.LocateService,
  40. IconSource: handler.IconSource,
  41. Logger: logger,
  42. }
  43. buddyListHandler := &handlers.BuddyListHandler{
  44. BuddyListManager: handler.BuddyListManager.(*handlers.BuddyListManager),
  45. Logger: logger,
  46. FeedbagService: handler.FeedbagService,
  47. }
  48. messagingHandler := &handlers.MessagingHandler{
  49. SessionManager: sessionManager,
  50. ICBMService: handler.ICBMService,
  51. LocateService: handler.LocateService,
  52. FeedbagService: handler.FeedbagService,
  53. Logger: logger,
  54. }
  55. preferenceHandler := &handlers.PreferenceHandler{
  56. SessionManager: sessionManager,
  57. FeedbagService: handler.FeedbagService,
  58. Logger: logger,
  59. }
  60. memberDirHandler := &handlers.MemberDirHandler{
  61. DirSearchService: handler.DirSearchService,
  62. LocateService: handler.LocateService,
  63. Logger: logger,
  64. }
  65. oscarBridgeHandler := &handlers.OSCARBridgeHandler{
  66. SessionManager: sessionManager,
  67. OSCARAuthService: handler.AuthService,
  68. CookieBaker: handler.CookieBaker,
  69. Config: handler.OSCARConfig,
  70. Logger: logger,
  71. }
  72. shutdownCtx, shutdownCancel := context.WithCancel(context.Background())
  73. for _, l := range listeners {
  74. mux := http.NewServeMux()
  75. // Exact root only. Pattern "GET /" matches every GET path in Go 1.22+ (prefix /), which
  76. // would steal /getAggregated and other lifestream URLs before stubs/404.
  77. mux.HandleFunc("GET /{$}", handler.GetHelloWorldHandler)
  78. // Authentication endpoint (public - no API key required for user login)
  79. // Using pattern with explicit method for Go 1.22+ routing
  80. mux.HandleFunc("POST /auth/clientLogin", func(w http.ResponseWriter, r *http.Request) {
  81. // Set CORS headers for public endpoint
  82. w.Header().Set("Access-Control-Allow-Origin", "*")
  83. w.Header().Set("Access-Control-Allow-Methods", "POST, OPTIONS")
  84. w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
  85. authHandler.ClientLogin(w, r)
  86. })
  87. // Handle OPTIONS for CORS preflight
  88. mux.HandleFunc("OPTIONS /auth/clientLogin", func(w http.ResponseWriter, r *http.Request) {
  89. w.Header().Set("Access-Control-Allow-Origin", "*")
  90. w.Header().Set("Access-Control-Allow-Methods", "POST, OPTIONS")
  91. w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
  92. w.WriteHeader(http.StatusNoContent)
  93. })
  94. mux.HandleFunc("GET /auth/getToken", func(w http.ResponseWriter, r *http.Request) {
  95. w.Header().Set("Access-Control-Allow-Origin", "*")
  96. w.Header().Set("Access-Control-Allow-Methods", "GET, OPTIONS")
  97. w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
  98. authHandler.GetToken(w, r)
  99. })
  100. mux.HandleFunc("OPTIONS /auth/getToken", func(w http.ResponseWriter, r *http.Request) {
  101. w.Header().Set("Access-Control-Allow-Origin", "*")
  102. w.Header().Set("Access-Control-Allow-Methods", "GET, OPTIONS")
  103. w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
  104. w.WriteHeader(http.StatusNoContent)
  105. })
  106. // Web AIM navigates the browser here on File > Logout; clear SSO state
  107. // and redirect to the login screen.
  108. mux.HandleFunc("GET /auth/logout", authHandler.Logout)
  109. mux.HandleFunc("GET /_cqr/login/login.psp", authHandler.LoginPSP)
  110. mux.HandleFunc("POST /_cqr/login/login.psp", authHandler.LoginPSP)
  111. // Authenticated Web AIM API endpoints
  112. // SessionInstance management - supports multiple auth methods (k, a, ts+sig_sha256)
  113. mux.Handle("GET /aim/startSession", authMiddleware.AuthenticateFlexible(
  114. authMiddleware.CORSMiddleware(
  115. http.HandlerFunc(sessionHandler.StartSession))))
  116. // End session - uses aimsid for auth, no k required
  117. mux.Handle("GET /aim/endSession", authMiddleware.AuthenticateFlexible(
  118. authMiddleware.CORSMiddleware(
  119. authMiddleware.RequireSession(sessionManager, sessionHandler.EndSession))))
  120. // Event fetching - uses aimsid for auth, no k required
  121. mux.Handle("GET /aim/fetchEvents", authMiddleware.AuthenticateFlexible(
  122. authMiddleware.CORSMiddleware(
  123. authMiddleware.RequireSession(sessionManager, eventsHandler.FetchEvents))))
  124. // Add temp buddy - uses aimsid for auth
  125. mux.Handle("GET /aim/addTempBuddy", authMiddleware.AuthenticateFlexible(
  126. authMiddleware.CORSMiddleware(
  127. authMiddleware.RequireSession(sessionManager, buddyListHandler.AddTempBuddy))))
  128. mux.Handle("GET /aim/removeTempBuddy", authMiddleware.AuthenticateFlexible(
  129. authMiddleware.CORSMiddleware(
  130. authMiddleware.RequireSession(sessionManager, buddyListHandler.RemoveTempBuddy))))
  131. aimStub := &handlers.AimStubHandler{Logger: logger}
  132. aimRoute := func(h http.HandlerFunc) http.Handler {
  133. return authMiddleware.AuthenticateFlexible(
  134. authMiddleware.CORSMiddleware(http.HandlerFunc(h)))
  135. }
  136. mux.Handle("GET /aim/setForwardDomain", aimRoute(aimStub.SetForwardDomain))
  137. mux.Handle("GET /aim/getData", aimRoute(aimStub.GetData))
  138. conversationStub := &handlers.ConversationStubHandler{
  139. SessionManager: sessionManager,
  140. Logger: logger,
  141. }
  142. mux.Handle("GET /conversation/update", aimRoute(conversationStub.Update))
  143. mux.Handle("GET /conversation/close", aimRoute(conversationStub.Close))
  144. mux.Handle("GET /imlog/markRead", aimRoute(conversationStub.MarkRead))
  145. mux.Handle("GET /imlog/fetchStoredIMs", authMiddleware.AuthenticateFlexible(
  146. authMiddleware.CORSMiddleware(
  147. authMiddleware.RequireSession(sessionManager, conversationStub.FetchStoredIMs))))
  148. // Presence and buddy list
  149. // GetPresence supports aimsid-based auth, so we use flexible auth
  150. mux.Handle("GET /presence/get", authMiddleware.AuthenticateFlexible(
  151. authMiddleware.CORSMiddleware(
  152. authMiddleware.RequireSession(sessionManager, presenceHandler.GetPresence))))
  153. buddyListRoute := func(h func(http.ResponseWriter, *http.Request, *state.WebAPISession)) http.Handler {
  154. return authMiddleware.AuthenticateFlexible(
  155. authMiddleware.CORSMiddleware(
  156. authMiddleware.RequireSession(sessionManager, h)))
  157. }
  158. mux.Handle("GET /buddylist/addBuddy", buddyListRoute(buddyListHandler.AddBuddy))
  159. mux.Handle("GET /buddylist/addGroup", buddyListRoute(buddyListHandler.AddGroup))
  160. mux.Handle("GET /buddylist/removeBuddy", buddyListRoute(buddyListHandler.RemoveBuddy))
  161. mux.Handle("GET /buddylist/removeGroup", buddyListRoute(buddyListHandler.RemoveGroup))
  162. mux.Handle("GET /buddylist/renameGroup", buddyListRoute(buddyListHandler.RenameGroup))
  163. mux.Handle("GET /buddylist/moveBuddy", buddyListRoute(buddyListHandler.MoveBuddy))
  164. mux.Handle("GET /buddylist/setBuddyAttribute", buddyListRoute(buddyListHandler.SetBuddyAttribute))
  165. mux.Handle("GET /buddylist/setGroupAttribute", buddyListRoute(buddyListHandler.SetGroupAttribute))
  166. // sendIM supports aimsid-based auth, so we use flexible auth.
  167. // The Web AIM client POSTs the message body (non-IE browsers); IE uses GET.
  168. sendIMHandler := authMiddleware.AuthenticateFlexible(
  169. authMiddleware.CORSMiddleware(
  170. authMiddleware.RequireSession(sessionManager, messagingHandler.SendIM)))
  171. mux.Handle("GET /im/sendIM", sendIMHandler)
  172. mux.Handle("POST /im/sendIM", sendIMHandler)
  173. mux.Handle("GET /im/setTyping", authMiddleware.AuthenticateFlexible(
  174. authMiddleware.CORSMiddleware(
  175. authMiddleware.RequireSession(sessionManager, messagingHandler.SetTyping))))
  176. // SetState only requires aimsid, no k parameter needed
  177. mux.Handle("GET /presence/setState", authMiddleware.AuthenticateFlexible(
  178. authMiddleware.CORSMiddleware(
  179. authMiddleware.RequireSession(sessionManager, presenceHandler.SetState))))
  180. // These presence endpoints support aimsid-based auth where k is not required
  181. mux.Handle("GET /presence/setStatus", authMiddleware.AuthenticateFlexible(
  182. authMiddleware.CORSMiddleware(
  183. authMiddleware.RequireSession(sessionManager, presenceHandler.SetStatus))))
  184. mux.Handle("GET /presence/setProfile", authMiddleware.AuthenticateFlexible(
  185. authMiddleware.CORSMiddleware(
  186. authMiddleware.RequireSession(sessionManager, presenceHandler.SetProfile))))
  187. mux.Handle("GET /presence/getProfile", authMiddleware.AuthenticateFlexible(
  188. authMiddleware.CORSMiddleware(
  189. authMiddleware.RequireSession(sessionManager, presenceHandler.GetProfile))))
  190. mux.HandleFunc("GET /presence/icon", presenceHandler.Icon)
  191. // Member directory search and self directory-info retrieval. Both use
  192. // aimsid-based auth, so we use flexible auth.
  193. mux.Handle("GET /memberDir/search", authMiddleware.AuthenticateFlexible(
  194. authMiddleware.CORSMiddleware(
  195. authMiddleware.RequireSession(sessionManager, memberDirHandler.Search))))
  196. mux.Handle("GET /memberDir/get", authMiddleware.AuthenticateFlexible(
  197. authMiddleware.CORSMiddleware(
  198. authMiddleware.RequireSession(sessionManager, memberDirHandler.Get))))
  199. mux.Handle("GET /memberDir/update", authMiddleware.AuthenticateFlexible(
  200. authMiddleware.CORSMiddleware(
  201. authMiddleware.RequireSession(sessionManager, memberDirHandler.Update))))
  202. // These endpoints support aimsid-based auth, so we use a flexible auth approach
  203. mux.Handle("GET /preference/set", authMiddleware.AuthenticateFlexible(
  204. authMiddleware.CORSMiddleware(
  205. authMiddleware.RequireSession(sessionManager, preferenceHandler.SetPreferences))))
  206. mux.Handle("GET /preference/get", authMiddleware.AuthenticateFlexible(
  207. authMiddleware.CORSMiddleware(
  208. authMiddleware.RequireSession(sessionManager, preferenceHandler.GetPreferences))))
  209. mux.Handle("GET /preference/setPermitDeny", authMiddleware.AuthenticateFlexible(
  210. authMiddleware.CORSMiddleware(
  211. authMiddleware.RequireSession(sessionManager, preferenceHandler.SetPermitDeny))))
  212. mux.Handle("GET /preference/getPermitDeny", authMiddleware.AuthenticateFlexible(
  213. authMiddleware.CORSMiddleware(
  214. authMiddleware.RequireSession(sessionManager, preferenceHandler.GetPermitDeny))))
  215. // OSCAR Bridge endpoint
  216. mux.Handle("GET /aim/startOSCARSession", authMiddleware.Authenticate(
  217. authMiddleware.CORSMiddleware(
  218. http.HandlerFunc(oscarBridgeHandler.StartOSCARSession))))
  219. // Expressions endpoint (for buddy icons, etc.).
  220. //
  221. // Unauthenticated, like /presence/icon: the buddyIcon URLs this serves are
  222. // published to the client and loaded as plain <img> sources, which carry
  223. // neither an aimsid nor an API key. Threading a session token through them
  224. // instead would leak it into the DOM and defeat caching, since these URLs
  225. // outlive the session that produced them. Buddy icons are public assets.
  226. expressionsHandler := handlers.NewExpressionsHandler(handler.IconSource, logger)
  227. mux.Handle("GET /expressions/get", authMiddleware.CORSMiddleware(
  228. http.HandlerFunc(expressionsHandler.Get)))
  229. // Web AIM calls lifestream/* on the API host (e.g. /lifestream/getUserDetails).
  230. lifestreamStub := &handlers.UserInfoStubHandler{Logger: logger}
  231. lifestreamRoute := func(h http.HandlerFunc) http.Handler {
  232. return authMiddleware.AuthenticateFlexible(
  233. authMiddleware.CORSMiddleware(http.HandlerFunc(h)))
  234. }
  235. // getUserDetails returns a minimal AIM identity. Every other lifestream/*
  236. // method is an unimplemented social-feed feature; the subtree catch-all
  237. // acknowledges them with an empty 200 so the client doesn't error.
  238. mux.Handle("GET /lifestream/getUserDetails", lifestreamRoute(lifestreamStub.GetUserDetails))
  239. mux.Handle("GET /lifestream/", lifestreamRoute(lifestreamStub.EmptyOK))
  240. // Unmatched paths (pattern "/" matches anything not covered by routes above).
  241. mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
  242. logger.Debug("webapi 404", "method", r.Method, "path", r.URL.Path)
  243. handlers.SendError(w, http.StatusNotFound, "not found")
  244. })
  245. servers = append(servers, &http.Server{
  246. Addr: l,
  247. Handler: middleware.RequestLogger(logger, mux),
  248. })
  249. }
  250. sessionHandler.FnSessCfg = func(sess *state.Session) {
  251. sess.OnSessionClose(func() {
  252. ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
  253. defer cancel()
  254. if !shuttingDown(shutdownCtx) {
  255. if err := handler.BuddyBroadcaster.BroadcastBuddyDeparted(ctx, sess.IdentScreenName()); err != nil {
  256. logger.ErrorContext(ctx, "error sending buddy departure notifications", "err", err.Error())
  257. }
  258. }
  259. // buddy list must be cleared before session is closed, otherwise
  260. // there will be a race condition that could cause the buddy list
  261. // be prematurely deleted.
  262. if err := handler.BuddyListRegistry.UnregisterBuddyList(ctx, sess.IdentScreenName()); err != nil {
  263. logger.ErrorContext(ctx, "error removing buddy list entry", "err", err.Error())
  264. }
  265. handler.ChatSessionManager.RemoveUserFromAllChats(sess.IdentScreenName())
  266. handler.AuthService.Signout(ctx, sess)
  267. })
  268. }
  269. sessionHandler.FnSessInit = func(instance *state.SessionInstance) func() error {
  270. return func() error {
  271. // make buddy list visible to other users
  272. if err := handler.BuddyListRegistry.RegisterBuddyList(shutdownCtx, instance.IdentScreenName()); err != nil {
  273. return fmt.Errorf("unable to init buddy list: %w", err)
  274. }
  275. // restore warning level from last session
  276. if err := handler.RecalcWarning(shutdownCtx, instance); err != nil {
  277. return fmt.Errorf("failed to recalculate warning level: %w", err)
  278. }
  279. // periodically decay warning level
  280. go handler.LowerWarnLevel(shutdownCtx, instance)
  281. return nil
  282. }
  283. }
  284. sessionHandler.FnInstanceClose = func(instance *state.SessionInstance) func() {
  285. return func() {
  286. if shuttingDown(shutdownCtx) {
  287. return
  288. }
  289. if instance.Session().Invisible() {
  290. if err := handler.BuddyBroadcaster.BroadcastBuddyDeparted(shutdownCtx, instance.IdentScreenName()); err != nil {
  291. logger.ErrorContext(shutdownCtx, "error sending buddy departure notifications", "err", err.Error())
  292. }
  293. } else {
  294. if err := handler.BuddyBroadcaster.BroadcastBuddyArrived(shutdownCtx, instance.IdentScreenName(), instance.Session().TLVUserInfo()); err != nil {
  295. logger.ErrorContext(shutdownCtx, "error sending buddy arrival notifications", "err", err.Error())
  296. }
  297. }
  298. }
  299. }
  300. return &Server{
  301. servers: servers,
  302. logger: logger,
  303. sessionManager: sessionManager,
  304. shutdownCtx: shutdownCtx,
  305. shutdownCancel: shutdownCancel,
  306. }
  307. }
  308. // Server hosts an HTTP endpoint capable of handling AIM-style Kerberos
  309. // authentication. The messages are structured as SNACs transmitted over HTTP.
  310. //
  311. // shutdownCtx bounds the lifetime of the background session reaper: ListenAndServe
  312. // drives it, and Shutdown (or a failed listener) calls shutdownCancel to unwind.
  313. type Server struct {
  314. servers []*http.Server
  315. logger *slog.Logger
  316. sessionManager *state.WebAPISessionManager
  317. shutdownCtx context.Context
  318. shutdownCancel context.CancelFunc
  319. }
  320. func (s *Server) ListenAndServe() error {
  321. if len(s.servers) == 0 {
  322. s.logger.Debug("no webapi listeners defined")
  323. return nil
  324. }
  325. g, ctx := errgroup.WithContext(s.shutdownCtx)
  326. g.Go(func() error {
  327. s.sessionManager.Run(ctx)
  328. return nil
  329. })
  330. for _, server := range s.servers {
  331. g.Go(func() error {
  332. s.logger.Info("starting server", "addr", server.Addr)
  333. if err := server.ListenAndServe(); !errors.Is(err, http.ErrServerClosed) {
  334. s.shutdownCancel()
  335. return fmt.Errorf("unable to start webapi server: %w", err)
  336. }
  337. return nil
  338. })
  339. }
  340. return g.Wait()
  341. }
  342. func (s *Server) Shutdown(ctx context.Context) error {
  343. s.logger.Debug("Initiating graceful shutdown...")
  344. s.shutdownCancel() // stop the session reaper so ListenAndServe's errgroup can drain
  345. var errs []error
  346. if err := s.sessionManager.Shutdown(ctx); err != nil {
  347. errs = append(errs, fmt.Errorf("draining webapi sessions: %w", err))
  348. }
  349. for _, srv := range s.servers {
  350. if err := srv.Shutdown(ctx); err != nil {
  351. errs = append(errs, fmt.Errorf("stopping webapi listener %s: %w", srv.Addr, err))
  352. }
  353. }
  354. if err := errors.Join(errs...); err != nil {
  355. s.logger.Error("shutdown incomplete", "err", err.Error())
  356. return err
  357. }
  358. s.logger.Info("shutdown complete")
  359. return nil
  360. }
  361. func shuttingDown(ctx context.Context) bool {
  362. select {
  363. case <-ctx.Done():
  364. // server is shutting down, don't send buddy notifications
  365. return true
  366. default:
  367. }
  368. return false
  369. }