X-Git-Url: https://git.r.bdr.sh/rbdr/mobius/blobdiff_plain/40414f9295dd301f1c714bc3067392b7cc8f8427..b6e3be945680d017874967ae72ef86ee4235dcc2:/hotline/server.go diff --git a/hotline/server.go b/hotline/server.go index d5da458..cfdb6b3 100644 --- a/hotline/server.go +++ b/hotline/server.go @@ -1,91 +1,160 @@ package hotline import ( + "bufio" + "bytes" "context" + "crypto/rand" "encoding/binary" "errors" "fmt" - "github.com/go-playground/validator/v10" - "go.uber.org/zap" + "golang.org/x/text/encoding/charmap" "io" - "io/fs" - "io/ioutil" - "math/big" - "math/rand" + "log" + "log/slog" "net" "os" - "path" - "path/filepath" - "runtime/debug" - "sort" "strings" "sync" "time" - - "gopkg.in/yaml.v3" ) -const ( - userIdleSeconds = 300 // time in seconds before an inactive user is marked idle - idleCheckInterval = 10 // time in seconds to check for idle users - trackerUpdateFrequency = 300 // time in seconds between tracker re-registration -) +type contextKey string + +var contextKeyReq = contextKey("req") + +type requestCtx struct { + remoteAddr string +} + +// Converts bytes from Mac Roman encoding to UTF-8 +var txtDecoder = charmap.Macintosh.NewDecoder() + +// Converts bytes from UTF-8 to Mac Roman encoding +var txtEncoder = charmap.Macintosh.NewEncoder() type Server struct { - Port int - Accounts map[string]*Account - Agreement []byte - Clients map[uint16]*ClientConn - FlatNews []byte - ThreadedNews *ThreadedNews - FileTransfers map[uint32]*FileTransfer - Config *Config - ConfigDir string - Logger *zap.SugaredLogger - PrivateChats map[uint32]*PrivateChat - NextGuestID *uint16 + NetInterface string + Port int + + handlers map[TranType]HandlerFunc + + Config Config + Logger *slog.Logger + TrackerPassID [4]byte - Stats *Stats - APIListener net.Listener - FileListener net.Listener + Stats Counter - // newsReader io.Reader - // newsWriter io.WriteCloser + FS FileStore // Storage backend to use for File storage outbox chan Transaction - mux sync.Mutex - flatNewsMux sync.Mutex + Agreement io.ReadSeeker + Banner []byte + + FileTransferMgr FileTransferMgr + ChatMgr ChatManager + ClientMgr ClientManager + AccountManager AccountManager + ThreadedNewsMgr ThreadedNewsMgr + BanList BanMgr + + MessageBoard io.ReadWriteSeeker } -type PrivateChat struct { - Subject string - ClientConn map[uint16]*ClientConn +type Option = func(s *Server) + +func WithConfig(config Config) func(s *Server) { + return func(s *Server) { + s.Config = config + } +} + +func WithLogger(logger *slog.Logger) func(s *Server) { + return func(s *Server) { + s.Logger = logger + } +} + +// WithPort optionally overrides the default TCP port. +func WithPort(port int) func(s *Server) { + return func(s *Server) { + s.Port = port + } } -func (s *Server) ListenAndServe(ctx context.Context, cancelRoot context.CancelFunc) error { - s.Logger.Infow("Hotline server started", "version", VERSION) +// WithInterface optionally sets a specific interface to listen on. +func WithInterface(netInterface string) func(s *Server) { + return func(s *Server) { + s.NetInterface = netInterface + } +} + +type ServerConfig struct { +} + +func NewServer(options ...Option) (*Server, error) { + server := Server{ + handlers: make(map[TranType]HandlerFunc), + outbox: make(chan Transaction), + FS: &OSFileStore{}, + ChatMgr: NewMemChatManager(), + ClientMgr: NewMemClientMgr(), + FileTransferMgr: NewMemFileTransferMgr(), + Stats: NewStats(), + } + + for _, opt := range options { + opt(&server) + } + + // generate a new random passID for tracker registration + _, err := rand.Read(server.TrackerPassID[:]) + if err != nil { + return nil, err + } + + return &server, nil +} + +func (s *Server) CurrentStats() map[string]interface{} { + return s.Stats.Values() +} + +func (s *Server) ListenAndServe(ctx context.Context) error { + go s.registerWithTrackers(ctx) + go s.keepaliveHandler(ctx) + go s.processOutbox() + var wg sync.WaitGroup wg.Add(1) - go func() { s.Logger.Fatal(s.Serve(ctx, cancelRoot, s.APIListener)) }() + go func() { + ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", s.NetInterface, s.Port)) + if err != nil { + log.Fatal(err) + } + + log.Fatal(s.Serve(ctx, ln)) + }() wg.Add(1) - go func() { s.Logger.Fatal(s.ServeFileTransfers(s.FileListener)) }() + go func() { + ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", s.NetInterface, s.Port+1)) + if err != nil { + log.Fatal(err) + } + + log.Fatal(s.ServeFileTransfers(ctx, ln)) + }() wg.Wait() return nil } -func (s *Server) APIPort() int { - return s.APIListener.Addr().(*net.TCPAddr).Port -} - -func (s *Server) ServeFileTransfers(ln net.Listener) error { - s.Logger.Infow("Hotline file transfer server started", "Addr", fmt.Sprintf(":%v", s.Port+1)) - +func (s *Server) ServeFileTransfers(ctx context.Context, ln net.Listener) error { for { conn, err := ln.Accept() if err != nil { @@ -93,1025 +162,443 @@ func (s *Server) ServeFileTransfers(ln net.Listener) error { } go func() { - if err := s.handleFileTransfer(conn); err != nil { - s.Logger.Errorw("file transfer error", "reason", err) + defer func() { _ = conn.Close() }() + + err = s.handleFileTransfer( + context.WithValue(ctx, contextKeyReq, requestCtx{remoteAddr: conn.RemoteAddr().String()}), + conn, + ) + + if err != nil { + s.Logger.Error("file transfer error", "reason", err) } }() } } func (s *Server) sendTransaction(t Transaction) error { - requestNum := binary.BigEndian.Uint16(t.Type) - clientID, err := byteToInt(*t.clientID) - if err != nil { - return err - } + client := s.ClientMgr.Get(t.ClientID) - s.mux.Lock() - client := s.Clients[uint16(clientID)] - s.mux.Unlock() if client == nil { - return fmt.Errorf("invalid client id %v", *t.clientID) + return nil } - userName := string(client.UserName) - login := client.Account.Login - handler := TransactionHandlers[requestNum] - - b, err := t.MarshalBinary() + _, err := io.Copy(client.Connection, &t) if err != nil { - return err - } - var n int - if n, err = client.Connection.Write(b); err != nil { - return err + return fmt.Errorf("failed to send transaction to client %v: %v", t.ClientID, err) } - s.Logger.Debugw("Sent Transaction", - "name", userName, - "login", login, - "IsReply", t.IsReply, - "type", handler.Name, - "sentBytes", n, - "remoteAddr", client.RemoteAddr, - ) + return nil } -func (s *Server) Serve(ctx context.Context, cancelRoot context.CancelFunc, ln net.Listener) error { - s.Logger.Infow("Hotline server started", "Addr", fmt.Sprintf(":%v", s.Port)) - +func (s *Server) processOutbox() { for { - conn, err := ln.Accept() - if err != nil { - s.Logger.Errorw("error accepting connection", "err", err) - } - + t := <-s.outbox go func() { - for { - t := <-s.outbox - go func() { - if err := s.sendTransaction(t); err != nil { - s.Logger.Errorw("error sending transaction", "err", err) - } - }() - } - }() - go func() { - if err := s.handleNewConnection(conn, conn.RemoteAddr().String()); err != nil { - if err == io.EOF { - s.Logger.Infow("Client disconnected", "RemoteAddr", conn.RemoteAddr()) - } else { - s.Logger.Errorw("error serving request", "RemoteAddr", conn.RemoteAddr(), "err", err) - } + if err := s.sendTransaction(t); err != nil { + s.Logger.Error("error sending transaction", "err", err) } }() } } -const ( - agreementFile = "Agreement.txt" -) - -// NewServer constructs a new Server from a config dir -func NewServer(configDir, netInterface string, netPort int, logger *zap.SugaredLogger) (*Server, error) { - server := Server{ - Port: netPort, - Accounts: make(map[string]*Account), - Config: new(Config), - Clients: make(map[uint16]*ClientConn), - FileTransfers: make(map[uint32]*FileTransfer), - PrivateChats: make(map[uint32]*PrivateChat), - ConfigDir: configDir, - Logger: logger, - NextGuestID: new(uint16), - outbox: make(chan Transaction), - Stats: &Stats{StartTime: time.Now()}, - ThreadedNews: &ThreadedNews{}, - } - - ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", netInterface, netPort)) - if err != nil { - return nil, err - } - server.APIListener = ln - - if netPort != 0 { - netPort += 1 - } - - ln2, err := net.Listen("tcp", fmt.Sprintf("%s:%v", netInterface, netPort)) - server.FileListener = ln2 - if err != nil { - return nil, err - } - - // generate a new random passID for tracker registration - if _, err := rand.Read(server.TrackerPassID[:]); err != nil { - return nil, err - } - - server.Logger.Debugw("Loading Agreement", "path", configDir+agreementFile) - if server.Agreement, err = os.ReadFile(configDir + agreementFile); err != nil { - return nil, err - } - - if server.FlatNews, err = os.ReadFile(configDir + "MessageBoard.txt"); err != nil { - return nil, err - } +func (s *Server) Serve(ctx context.Context, ln net.Listener) error { + for { + select { + case <-ctx.Done(): + s.Logger.Info("Server shutting down") + return ctx.Err() + default: + conn, err := ln.Accept() + if err != nil { + s.Logger.Error("Error accepting connection", "err", err) + continue + } - if err := server.loadThreadedNews(configDir + "ThreadedNews.yaml"); err != nil { - return nil, err - } + go func() { + connCtx := context.WithValue(ctx, contextKeyReq, requestCtx{ + remoteAddr: conn.RemoteAddr().String(), + }) - if err := server.loadConfig(configDir + "config.yaml"); err != nil { - return nil, err - } + s.Logger.Info("Connection established", "addr", conn.RemoteAddr()) + defer conn.Close() - if err := server.loadAccounts(configDir + "Users/"); err != nil { - return nil, err + if err := s.handleNewConnection(connCtx, conn, conn.RemoteAddr().String()); err != nil { + if err == io.EOF { + s.Logger.Info("Client disconnected", "RemoteAddr", conn.RemoteAddr()) + } else { + s.Logger.Error("Error serving request", "RemoteAddr", conn.RemoteAddr(), "err", err) + } + } + }() + } } +} - server.Config.FileRoot = configDir + "Files/" - - *server.NextGuestID = 1 +// time in seconds between tracker re-registration +const trackerUpdateFrequency = 300 - if server.Config.EnableTrackerRegistration { - server.Logger.Infow( - "Tracker registration enabled", - "frequency", fmt.Sprintf("%vs", trackerUpdateFrequency), - "trackers", server.Config.Trackers, - ) +// registerWithTrackers runs every trackerUpdateFrequency seconds to update the server's tracker entry on all configured +// trackers. +func (s *Server) registerWithTrackers(ctx context.Context) { + ticker := time.NewTicker(trackerUpdateFrequency * time.Second) + defer ticker.Stop() - go func() { - for { + for { + select { + case <-ctx.Done(): + return + case <-ticker.C: + if s.Config.EnableTrackerRegistration { tr := &TrackerRegistration{ - UserCount: server.userCount(), - PassID: server.TrackerPassID[:], - Name: server.Config.Name, - Description: server.Config.Description, + UserCount: len(s.ClientMgr.List()), + PassID: s.TrackerPassID, + Name: s.Config.Name, + Description: s.Config.Description, } - binary.BigEndian.PutUint16(tr.Port[:], uint16(server.Port)) - for _, t := range server.Config.Trackers { - if err := register(t, tr); err != nil { - server.Logger.Errorw("unable to register with tracker %v", "error", err) + binary.BigEndian.PutUint16(tr.Port[:], uint16(s.Port)) + + for _, t := range s.Config.Trackers { + if err := register(&RealDialer{}, t, tr); err != nil { + s.Logger.Error(fmt.Sprintf("Unable to register with tracker %v", t), "error", err) } - server.Logger.Infow("Sent Tracker registration", "data", tr) } - - time.Sleep(trackerUpdateFrequency * time.Second) } - }() + } } - // Start Client Keepalive go routine - go server.keepaliveHandler() - - return &server, nil } -func (s *Server) userCount() int { - s.mux.Lock() - defer s.mux.Unlock() +const ( + userIdleSeconds = 300 // time in seconds before an inactive user is marked idle + idleCheckInterval = 10 // time in seconds to check for idle users +) - return len(s.Clients) -} +// keepaliveHandler runs every idleCheckInterval seconds and increments a user's idle time by idleCheckInterval seconds. +// If the updated idle time exceeds userIdleSeconds and the user was not previously idle, we notify all connected clients +// that the user has gone idle. For most clients, this turns the user grey in the user list. +func (s *Server) keepaliveHandler(ctx context.Context) { + ticker := time.NewTicker(idleCheckInterval * time.Second) + defer ticker.Stop() -func (s *Server) keepaliveHandler() { for { - time.Sleep(idleCheckInterval * time.Second) - s.mux.Lock() - - for _, c := range s.Clients { - c.IdleTime += idleCheckInterval - if c.IdleTime > userIdleSeconds && !c.Idle { - c.Idle = true - - flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(*c.Flags))) - flagBitmap.SetBit(flagBitmap, userFlagAway, 1) - binary.BigEndian.PutUint16(*c.Flags, uint16(flagBitmap.Int64())) - - c.sendAll( - tranNotifyChangeUser, - NewField(fieldUserID, *c.ID), - NewField(fieldUserFlags, *c.Flags), - NewField(fieldUserName, c.UserName), - NewField(fieldUserIconID, *c.Icon), - ) + select { + case <-ctx.Done(): + return + case <-ticker.C: + for _, c := range s.ClientMgr.List() { + c.mu.Lock() + c.IdleTime += idleCheckInterval + + // Check if the user + if c.IdleTime > userIdleSeconds && !c.Flags.IsSet(UserFlagAway) { + c.Flags.Set(UserFlagAway, 1) + + c.SendAll( + TranNotifyChangeUser, + NewField(FieldUserID, c.ID[:]), + NewField(FieldUserFlags, c.Flags[:]), + NewField(FieldUserName, c.UserName), + NewField(FieldUserIconID, c.Icon), + ) + } + c.mu.Unlock() } } - s.mux.Unlock() } } -func (s *Server) writeThreadedNews() error { - s.mux.Lock() - defer s.mux.Unlock() - - out, err := yaml.Marshal(s.ThreadedNews) - if err != nil { - return err - } - err = ioutil.WriteFile( - s.ConfigDir+"ThreadedNews.yaml", - out, - 0666, - ) - return err -} - -func (s *Server) NewClientConn(conn net.Conn, remoteAddr string) *ClientConn { - s.mux.Lock() - defer s.mux.Unlock() - +func (s *Server) NewClientConn(conn io.ReadWriteCloser, remoteAddr string) *ClientConn { clientConn := &ClientConn{ - ID: &[]byte{0, 0}, - Icon: &[]byte{0, 0}, - Flags: &[]byte{0, 0}, - UserName: []byte{}, + Icon: []byte{0, 0}, // TODO: make array type Connection: conn, Server: s, - Version: &[]byte{}, - AutoReply: []byte{}, - Transfers: make(map[int][]*FileTransfer), - Agreed: false, RemoteAddr: remoteAddr, - } - *s.NextGuestID++ - ID := *s.NextGuestID - - binary.BigEndian.PutUint16(*clientConn.ID, ID) - s.Clients[ID] = clientConn - - return clientConn -} - -// NewUser creates a new user account entry in the server map and config file -func (s *Server) NewUser(login, name, password string, access []byte) error { - s.mux.Lock() - defer s.mux.Unlock() - - account := Account{ - Login: login, - Name: name, - Password: hashAndSalt([]byte(password)), - Access: &access, - } - out, err := yaml.Marshal(&account) - if err != nil { - return err - } - s.Accounts[login] = &account - - return FS.WriteFile(s.ConfigDir+"Users/"+login+".yaml", out, 0666) -} - -func (s *Server) UpdateUser(login, newLogin, name, password string, access []byte) error { - s.mux.Lock() - defer s.mux.Unlock() - fmt.Printf("login: %v, newLogin: %v: ", login, newLogin) - - // update renames the user login - if login != newLogin { - err := os.Rename(s.ConfigDir+"Users/"+login+".yaml", s.ConfigDir+"Users/"+newLogin+".yaml") - if err != nil { - return err - } - s.Accounts[newLogin] = s.Accounts[login] - delete(s.Accounts, login) + ClientFileTransferMgr: NewClientFileTransferMgr(), } - account := s.Accounts[newLogin] - account.Access = &access - account.Name = name - account.Password = password + s.ClientMgr.Add(clientConn) - out, err := yaml.Marshal(&account) - if err != nil { - return err - } - if err := os.WriteFile(s.ConfigDir+"Users/"+newLogin+".yaml", out, 0666); err != nil { - return err - } - - return nil -} - -// DeleteUser deletes the user account -func (s *Server) DeleteUser(login string) error { - s.mux.Lock() - defer s.mux.Unlock() - - delete(s.Accounts, login) - - return FS.Remove(s.ConfigDir + "Users/" + login + ".yaml") -} - -func (s *Server) connectedUsers() []Field { - s.mux.Lock() - defer s.mux.Unlock() - - var connectedUsers []Field - for _, c := range sortedClients(s.Clients) { - if !c.Agreed { - continue - } - user := User{ - ID: *c.ID, - Icon: *c.Icon, - Flags: *c.Flags, - Name: string(c.UserName), - } - connectedUsers = append(connectedUsers, NewField(fieldUsernameWithInfo, user.Payload())) - } - return connectedUsers + return clientConn } -// loadThreadedNews loads the threaded news data from disk -func (s *Server) loadThreadedNews(threadedNewsPath string) error { - fh, err := os.Open(threadedNewsPath) - if err != nil { - return err - } - decoder := yaml.NewDecoder(fh) - - return decoder.Decode(s.ThreadedNews) +func sendBanMessage(rwc io.Writer, message string) { + t := NewTransaction( + TranServerMsg, + [2]byte{0, 0}, + NewField(FieldData, []byte(message)), + NewField(FieldChatOptions, []byte{0, 0}), + ) + _, _ = io.Copy(rwc, &t) + time.Sleep(1 * time.Second) } -// loadAccounts loads account data from disk -func (s *Server) loadAccounts(userDir string) error { - matches, err := filepath.Glob(path.Join(userDir, "*.yaml")) - if err != nil { - return err - } +// handleNewConnection takes a new net.Conn and performs the initial login sequence +func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser, remoteAddr string) error { + defer dontPanic(s.Logger) - if len(matches) == 0 { - return errors.New("no user accounts found in " + userDir) + if err := performHandshake(rwc); err != nil { + return fmt.Errorf("perform handshake: %w", err) } - for _, file := range matches { - fh, err := FS.Open(file) - if err != nil { - return err + // Check if remoteAddr is present in the ban list + ipAddr := strings.Split(remoteAddr, ":")[0] + if isBanned, banUntil := s.BanList.IsBanned(ipAddr); isBanned { + // permaban + if banUntil == nil { + sendBanMessage(rwc, "You are permanently banned on this server") + s.Logger.Debug("Disconnecting permanently banned IP", "remoteAddr", ipAddr) + return nil } - account := Account{} - decoder := yaml.NewDecoder(fh) - if err := decoder.Decode(&account); err != nil { - return err + // temporary ban + if time.Now().Before(*banUntil) { + sendBanMessage(rwc, "You are temporarily banned on this server") + s.Logger.Debug("Disconnecting temporarily banned IP", "remoteAddr", ipAddr) + return nil } - - s.Accounts[account.Login] = &account - } - return nil -} - -func (s *Server) loadConfig(path string) error { - fh, err := FS.Open(path) - if err != nil { - return err - } - - decoder := yaml.NewDecoder(fh) - err = decoder.Decode(s.Config) - if err != nil { - return err } - validate := validator.New() - err = validate.Struct(s.Config) - if err != nil { - return err - } - return nil -} - -const ( - minTransactionLen = 22 // minimum length of any transaction -) - -// dontPanic recovers and logs panics instead of crashing -// TODO: remove this after known issues are fixed -func dontPanic(logger *zap.SugaredLogger) { - if r := recover(); r != nil { - fmt.Println("stacktrace from panic: \n" + string(debug.Stack())) - logger.Errorw("PANIC", "err", r, "trace", string(debug.Stack())) - } -} - -// handleNewConnection takes a new net.Conn and performs the initial login sequence -func (s *Server) handleNewConnection(conn net.Conn, remoteAddr string) error { - defer dontPanic(s.Logger) + // Create a new scanner for parsing incoming bytes into transaction tokens + scanner := bufio.NewScanner(rwc) + scanner.Split(transactionScanner) - if err := Handshake(conn); err != nil { - return err - } + scanner.Scan() - buf := make([]byte, 1024) - // TODO: fix potential short read with io.ReadFull - readLen, err := conn.Read(buf) - if readLen < minTransactionLen { - return err - } - if err != nil { - return err - } + // Make a new []byte slice and copy the scanner bytes to it. This is critical to avoid a data race as the + // scanner re-uses the buffer for subsequent scans. + buf := make([]byte, len(scanner.Bytes())) + copy(buf, scanner.Bytes()) - clientLogin, _, err := ReadTransaction(buf[:readLen]) - if err != nil { - return err + var clientLogin Transaction + if _, err := clientLogin.Write(buf); err != nil { + return fmt.Errorf("error writing login transaction: %w", err) } - c := s.NewClientConn(conn, remoteAddr) + c := s.NewClientConn(rwc, remoteAddr) defer c.Disconnect() - encodedLogin := clientLogin.GetField(fieldUserLogin).Data - encodedPassword := clientLogin.GetField(fieldUserPassword).Data - *c.Version = clientLogin.GetField(fieldVersion).Data + encodedPassword := clientLogin.GetField(FieldUserPassword).Data + c.Version = clientLogin.GetField(FieldVersion).Data - var login string - for _, char := range encodedLogin { - login += string(rune(255 - uint(char))) - } + login := clientLogin.GetField(FieldUserLogin).DecodeObfuscatedString() if login == "" { login = GuestAccount } + c.Logger = s.Logger.With("ip", ipAddr, "login", login) + // If authentication fails, send error reply and close connection if !c.Authenticate(login, encodedPassword) { - t := c.NewErrReply(clientLogin, "Incorrect login.") - b, err := t.MarshalBinary() + t := c.NewErrReply(&clientLogin, "Incorrect login.")[0] + + _, err := io.Copy(rwc, &t) if err != nil { return err } - if _, err := conn.Write(b); err != nil { - return err - } - return fmt.Errorf("incorrect login") - } - if clientLogin.GetField(fieldUserName).Data != nil { - c.UserName = clientLogin.GetField(fieldUserName).Data + c.Logger.Info("Login failed", "clientVersion", fmt.Sprintf("%x", c.Version)) + + return nil } - if clientLogin.GetField(fieldUserIconID).Data != nil { - *c.Icon = clientLogin.GetField(fieldUserIconID).Data + if clientLogin.GetField(FieldUserIconID).Data != nil { + c.Icon = clientLogin.GetField(FieldUserIconID).Data } - c.Account = c.Server.Accounts[login] + c.Account = c.Server.AccountManager.Get(login) + if c.Account == nil { + return nil + } - if c.Authorize(accessDisconUser) { - *c.Flags = []byte{0, 2} + if clientLogin.GetField(FieldUserName).Data != nil { + if c.Authorize(AccessAnyName) { + c.UserName = clientLogin.GetField(FieldUserName).Data + } else { + c.UserName = []byte(c.Account.Name) + } } - s.Logger.Infow("Client connection received", "login", login, "version", *c.Version, "RemoteAddr", remoteAddr) + if c.Authorize(AccessDisconUser) { + c.Flags.Set(UserFlagAdmin, 1) + } - s.outbox <- c.NewReply(clientLogin, - NewField(fieldVersion, []byte{0x00, 0xbe}), - NewField(fieldCommunityBannerID, []byte{0x00, 0x01}), - NewField(fieldServerName, []byte(s.Config.Name)), + s.outbox <- c.NewReply(&clientLogin, + NewField(FieldVersion, []byte{0x00, 0xbe}), + NewField(FieldCommunityBannerID, []byte{0, 0}), + NewField(FieldServerName, []byte(s.Config.Name)), ) // Send user access privs so client UI knows how to behave - c.Server.outbox <- *NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, *c.Account.Access)) - - // Show agreement to client - c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldData, s.Agreement)) - - // assume simplified hotline v1.2.3 login flow that does not require agreement - if *c.Version == nil { - c.Agreed = true - - c.notifyOthers( - *NewTransaction( - tranNotifyChangeUser, nil, - NewField(fieldUserName, c.UserName), - NewField(fieldUserID, *c.ID), - NewField(fieldUserIconID, *c.Icon), - NewField(fieldUserFlags, *c.Flags), - ), - ) - } - - c.Server.Stats.LoginCount += 1 - - const readBuffSize = 1024000 // 1KB - TODO: what should this be? - tranBuff := make([]byte, 0) - tReadlen := 0 - // Infinite loop where take action on incoming client requests until the connection is closed - for { - buf = make([]byte, readBuffSize) - tranBuff = tranBuff[tReadlen:] - - readLen, err := c.Connection.Read(buf) - if err != nil { - return err - } - tranBuff = append(tranBuff, buf[:readLen]...) - - // We may have read multiple requests worth of bytes from Connection.Read. readTransactions splits them - // into a slice of transactions - var transactions []Transaction - if transactions, tReadlen, err = readTransactions(tranBuff); err != nil { - c.Server.Logger.Errorw("Error handling transaction", "err", err) + c.Server.outbox <- NewTransaction(TranUserAccess, c.ID, NewField(FieldUserAccess, c.Account.Access[:])) + + // Accounts with AccessNoAgreement do not receive the server agreement on login. The behavior is different between + // client versions. For 1.2.3 client, we do not send TranShowAgreement. For other client versions, we send + // TranShowAgreement but with the NoServerAgreement field set to 1. + if c.Authorize(AccessNoAgreement) { + // If client version is nil, then the client uses the 1.2.3 login behavior + if c.Version != nil { + c.Server.outbox <- NewTransaction(TranShowAgreement, c.ID, NewField(FieldNoServerAgreement, []byte{1})) } - - // iterate over all of the transactions that were parsed from the byte slice and handle them - for _, t := range transactions { - if err := c.handleTransaction(&t); err != nil { - c.Server.Logger.Errorw("Error handling transaction", "err", err) - } + } else { + _, _ = c.Server.Agreement.Seek(0, 0) + data, _ := io.ReadAll(c.Server.Agreement) + + c.Server.outbox <- NewTransaction(TranShowAgreement, c.ID, NewField(FieldData, data)) + } + + // If the client has provided a username as part of the login, we can infer that it is using the 1.2.3 login + // flow and not the 1.5+ flow. + if len(c.UserName) != 0 { + // Add the client username to the logger. For 1.5+ clients, we don't have this information yet as it comes as + // part of TranAgreed + c.Logger = c.Logger.With("name", string(c.UserName)) + c.Logger.Info("Login successful") + + // Notify other clients on the server that the new user has logged in. For 1.5+ clients we don't have this + // information yet, so we do it in TranAgreed instead + for _, t := range c.NotifyOthers( + NewTransaction( + TranNotifyChangeUser, [2]byte{0, 0}, + NewField(FieldUserName, c.UserName), + NewField(FieldUserID, c.ID[:]), + NewField(FieldUserIconID, c.Icon), + NewField(FieldUserFlags, c.Flags[:]), + ), + ) { + c.Server.outbox <- t } } -} -// NewTransactionRef generates a random ID for the file transfer. The Hotline client includes this ID -// in the file transfer request payload, and the file transfer server will use it to map the request -// to a transfer -func (s *Server) NewTransactionRef() []byte { - transactionRef := make([]byte, 4) - rand.Read(transactionRef) + c.Server.Stats.Increment(StatConnectionCounter, StatCurrentlyConnected) + defer c.Server.Stats.Decrement(StatCurrentlyConnected) - return transactionRef -} + if len(s.ClientMgr.List()) > c.Server.Stats.Get(StatConnectionPeak) { + c.Server.Stats.Set(StatConnectionPeak, len(s.ClientMgr.List())) + } -func (s *Server) NewPrivateChat(cc *ClientConn) []byte { - s.mux.Lock() - defer s.mux.Unlock() + // Scan for new transactions and handle them as they come in. + for scanner.Scan() { + // Copy the scanner bytes to a new slice to it to avoid a data race when the scanner re-uses the buffer. + tmpBuf := make([]byte, len(scanner.Bytes())) + copy(tmpBuf, scanner.Bytes()) - randID := make([]byte, 4) - rand.Read(randID) - data := binary.BigEndian.Uint32(randID[:]) + var t Transaction + if _, err := t.Write(tmpBuf); err != nil { + return err + } - s.PrivateChats[data] = &PrivateChat{ - Subject: "", - ClientConn: make(map[uint16]*ClientConn), + c.handleTransaction(t) } - s.PrivateChats[data].ClientConn[cc.uint16ID()] = cc - - return randID + return nil } -const dlFldrActionSendFile = 1 -const dlFldrActionResumeFile = 2 -const dlFldrActionNextFile = 3 - // handleFileTransfer receives a client net.Conn from the file transfer server, performs the requested transfer type, then closes the connection -func (s *Server) handleFileTransfer(conn io.ReadWriteCloser) error { - defer func() { - - if err := conn.Close(); err != nil { - s.Logger.Errorw("error closing connection", "error", err) - } - }() - +func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) error { defer dontPanic(s.Logger) - txBuf := make([]byte, 16) - if _, err := io.ReadFull(conn, txBuf); err != nil { - return err - } - + // The first 16 bytes contain the file transfer. var t transfer - if _, err := t.Write(txBuf); err != nil { - return err + if _, err := io.CopyN(&t, rwc, 16); err != nil { + return fmt.Errorf("error reading file transfer: %w", err) } - transferRefNum := binary.BigEndian.Uint32(t.ReferenceNumber[:]) - defer func() { - s.mux.Lock() - delete(s.FileTransfers, transferRefNum) - s.mux.Unlock() - }() - - s.mux.Lock() - fileTransfer, ok := s.FileTransfers[transferRefNum] - s.mux.Unlock() - if !ok { + fileTransfer := s.FileTransferMgr.Get(t.ReferenceNumber) + if fileTransfer == nil { return errors.New("invalid transaction ID") } - switch fileTransfer.Type { - case FileDownload: - fullFilePath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName) - if err != nil { - return err - } + defer func() { + s.FileTransferMgr.Delete(t.ReferenceNumber) - var dataOffset int64 - if fileTransfer.fileResumeData != nil { - dataOffset = int64(binary.BigEndian.Uint32(fileTransfer.fileResumeData.ForkInfoList[0].DataSize[:])) - } + // Wait a few seconds before closing the connection: this is a workaround for problems + // observed with Windows clients where the client must initiate close of the TCP connection before + // the server does. This is gross and seems unnecessary. TODO: Revisit? + time.Sleep(3 * time.Second) + }() - ffo, err := NewFlattenedFileObject(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName, dataOffset) - if err != nil { - return err - } + rLogger := s.Logger.With( + "remoteAddr", ctx.Value(contextKeyReq).(requestCtx).remoteAddr, + "login", fileTransfer.ClientConn.Account.Login, + "Name", string(fileTransfer.ClientConn.UserName), + ) - s.Logger.Infow("File download started", "filePath", fullFilePath, "transactionRef", fileTransfer.ReferenceNumber) + fullPath, err := ReadPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName) + if err != nil { + return err + } - if fileTransfer.options == nil { - // Start by sending flat file object to client - if _, err := conn.Write(ffo.BinaryMarshal()); err != nil { - return err - } + switch fileTransfer.Type { + case BannerDownload: + if _, err := io.Copy(rwc, bytes.NewBuffer(s.Banner)); err != nil { + return fmt.Errorf("error sending Banner: %w", err) } + case FileDownload: + s.Stats.Increment(StatDownloadCounter, StatDownloadsInProgress) + defer func() { + s.Stats.Decrement(StatDownloadsInProgress) + }() - file, err := FS.Open(fullFilePath) + err = DownloadHandler(rwc, fullPath, fileTransfer, s.FS, rLogger, true) if err != nil { - return err + return fmt.Errorf("file download: %w", err) } - sendBuffer := make([]byte, 1048576) - var totalSent int64 - for { - var bytesRead int - if bytesRead, err = file.ReadAt(sendBuffer, dataOffset+totalSent); err == io.EOF { - if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil { - return err - } - break - } - if err != nil { - return err - } - totalSent += int64(bytesRead) - - fileTransfer.BytesSent += bytesRead - - if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil { - return err - } - } case FileUpload: - destinationFile := s.Config.FileRoot + ReadFilePath(fileTransfer.FilePath) + "/" + string(fileTransfer.FileName) - - var file *os.File - - // A file upload has three possible cases: - // 1) Upload a new file - // 2) Resume a partially transferred file - // 3) Replace a fully uploaded file - // Unfortunately we have to infer which case applies by inspecting what is already on the file system - - // 1) Check for existing file: - _, err := os.Stat(destinationFile) - if err == nil { - // If found, that means this upload is intended to replace the file - if err = os.Remove(destinationFile); err != nil { - return err - } - file, err = os.Create(destinationFile + incompleteFileSuffix) - } - if errors.Is(err, fs.ErrNotExist) { - // If not found, open or create a new incomplete file - file, err = os.OpenFile(destinationFile+incompleteFileSuffix, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644) - if err != nil { - return err - } - } - - defer func() { _ = file.Close() }() - - s.Logger.Infow("File upload started", "transactionRef", fileTransfer.ReferenceNumber, "dstFile", destinationFile) - - // TODO: replace io.Discard with a real file when ready to implement storing of resource fork data - if err := receiveFile(conn, file, io.Discard); err != nil { - return err - } - - if err := os.Rename(destinationFile+".incomplete", destinationFile); err != nil { - return err - } + s.Stats.Increment(StatUploadCounter, StatUploadsInProgress) + defer func() { + s.Stats.Decrement(StatUploadsInProgress) + }() - s.Logger.Infow("File upload complete", "transactionRef", fileTransfer.ReferenceNumber, "dstFile", destinationFile) - case FolderDownload: - // Folder Download flow: - // 1. Get filePath from the transfer - // 2. Iterate over files - // 3. For each file: - // Send file header to client - // The client can reply in 3 ways: - // - // 1. If type is an odd number (unknown type?), or file download for the current file is completed: - // client sends []byte{0x00, 0x03} to tell the server to continue to the next file - // - // 2. If download of a file is to be resumed: - // client sends: - // []byte{0x00, 0x02} // download folder action - // [2]byte // Resume data size - // []byte file resume data (see myField_FileResumeData) - // - // 3. Otherwise, download of the file is requested and client sends []byte{0x00, 0x01} - // - // When download is requested (case 2 or 3), server replies with: - // [4]byte - file size - // []byte - Flattened File Object - // - // After every file download, client could request next file with: - // []byte{0x00, 0x03} - // - // This notifies the server to send the next item header - - fullFilePath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName) + err = UploadHandler(rwc, fullPath, fileTransfer, s.FS, rLogger, s.Config.PreserveResourceForks) if err != nil { - return err + return fmt.Errorf("file upload error: %w", err) } - basePathLen := len(fullFilePath) - - s.Logger.Infow("Start folder download", "path", fullFilePath, "ReferenceNumber", fileTransfer.ReferenceNumber) + case FolderDownload: + s.Stats.Increment(StatDownloadCounter, StatDownloadsInProgress) + defer func() { + s.Stats.Decrement(StatDownloadsInProgress) + }() - nextAction := make([]byte, 2) - if _, err := io.ReadFull(conn, nextAction); err != nil { - return err + err = DownloadFolderHandler(rwc, fullPath, fileTransfer, s.FS, rLogger, s.Config.PreserveResourceForks) + if err != nil { + return fmt.Errorf("file upload error: %w", err) } - i := 0 - err = filepath.Walk(fullFilePath+"/", func(path string, info os.FileInfo, err error) error { - if err != nil { - return err - } - i += 1 - subPath := path[basePathLen+1:] - s.Logger.Infow("Sending fileheader", "i", i, "path", path, "fullFilePath", fullFilePath, "subPath", subPath, "IsDir", info.IsDir()) - - if i == 1 { - return nil - } - - fileHeader := NewFileHeader(subPath, info.IsDir()) - - // Send the file header to client - if _, err := conn.Write(fileHeader.Payload()); err != nil { - s.Logger.Errorf("error sending file header: %v", err) - return err - } - - // Read the client's Next Action request - if _, err := io.ReadFull(conn, nextAction); err != nil { - return err - } - - s.Logger.Infow("Client folder download action", "action", fmt.Sprintf("%X", nextAction[0:2])) - - var dataOffset int64 - - switch nextAction[1] { - case dlFldrActionResumeFile: - // client asked to resume this file - var frd FileResumeData - // get size of resumeData - if _, err := io.ReadFull(conn, nextAction); err != nil { - return err - } - - resumeDataLen := binary.BigEndian.Uint16(nextAction) - resumeDataBytes := make([]byte, resumeDataLen) - if _, err := io.ReadFull(conn, resumeDataBytes); err != nil { - return err - } - - if err := frd.UnmarshalBinary(resumeDataBytes); err != nil { - return err - } - dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:])) - case dlFldrActionNextFile: - // client asked to skip this file - return nil - } - - if info.IsDir() { - return nil - } - - splitPath := strings.Split(path, "/") - - ffo, err := NewFlattenedFileObject(strings.Join(splitPath[:len(splitPath)-1], "/"), nil, []byte(info.Name()), dataOffset) - if err != nil { - return err - } - s.Logger.Infow("File download started", - "fileName", info.Name(), - "transactionRef", fileTransfer.ReferenceNumber, - "TransferSize", fmt.Sprintf("%x", ffo.TransferSize()), - ) - - // Send file size to client - if _, err := conn.Write(ffo.TransferSize()); err != nil { - s.Logger.Error(err) - return err - } - - // Send ffo bytes to client - if _, err := conn.Write(ffo.BinaryMarshal()); err != nil { - s.Logger.Error(err) - return err - } - - file, err := FS.Open(path) - if err != nil { - return err - } - - // // Copy N bytes from file to connection - // _, err = io.CopyN(conn, file, int64(binary.BigEndian.Uint32(ffo.FlatFileDataForkHeader.DataSize[:]))) - // if err != nil { - // return err - // } - // file.Close() - sendBuffer := make([]byte, 1048576) - var totalSent int64 - for { - var bytesRead int - if bytesRead, err = file.ReadAt(sendBuffer, dataOffset+totalSent); err == io.EOF { - if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil { - return err - } - break - } - if err != nil { - panic(err) - } - totalSent += int64(bytesRead) - - fileTransfer.BytesSent += bytesRead - - if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil { - return err - } - } - - // TODO: optionally send resource fork header and resource fork data - - // Read the client's Next Action request. This is always 3, I think? - if _, err := io.ReadFull(conn, nextAction); err != nil { - return err - } - - return nil - }) - case FolderUpload: - dstPath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName) - if err != nil { - return err - } - s.Logger.Infow( + s.Stats.Increment(StatUploadCounter, StatUploadsInProgress) + defer func() { + s.Stats.Decrement(StatUploadsInProgress) + }() + + rLogger.Info( "Folder upload started", - "transactionRef", fileTransfer.ReferenceNumber, - "dstPath", dstPath, - "TransferSize", fmt.Sprintf("%x", fileTransfer.TransferSize), + "dstPath", fullPath, + "TransferSize", binary.BigEndian.Uint32(fileTransfer.TransferSize), "FolderItemCount", fileTransfer.FolderItemCount, ) - // Check if the target folder exists. If not, create it. - if _, err := FS.Stat(dstPath); os.IsNotExist(err) { - if err := FS.Mkdir(dstPath, 0777); err != nil { - return err - } - } - - // Begin the folder upload flow by sending the "next file action" to client - if _, err := conn.Write([]byte{0, dlFldrActionNextFile}); err != nil { - return err - } - - fileSize := make([]byte, 4) - readBuffer := make([]byte, 1024) - - for i := 0; i < fileTransfer.ItemCount(); i++ { - // TODO: fix potential short read with io.ReadFull - _, err := conn.Read(readBuffer) - if err != nil { - return err - } - fu := readFolderUpload(readBuffer) - - s.Logger.Infow( - "Folder upload continued", - "transactionRef", fmt.Sprintf("%x", fileTransfer.ReferenceNumber), - "FormattedPath", fu.FormattedPath(), - "IsFolder", fmt.Sprintf("%x", fu.IsFolder), - "PathItemCount", binary.BigEndian.Uint16(fu.PathItemCount[:]), - ) - - if fu.IsFolder == [2]byte{0, 1} { - if _, err := os.Stat(dstPath + "/" + fu.FormattedPath()); os.IsNotExist(err) { - if err := os.Mkdir(dstPath+"/"+fu.FormattedPath(), 0777); err != nil { - return err - } - } - - // Tell client to send next file - if _, err := conn.Write([]byte{0, dlFldrActionNextFile}); err != nil { - return err - } - } else { - nextAction := dlFldrActionSendFile - - // Check if we have the full file already. If so, send dlFldrAction_NextFile to client to skip. - _, err := os.Stat(dstPath + "/" + fu.FormattedPath()) - if err != nil && !errors.Is(err, fs.ErrNotExist) { - return err - } - if err == nil { - nextAction = dlFldrActionNextFile - } - - // Check if we have a partial file already. If so, send dlFldrAction_ResumeFile to client to resume upload. - inccompleteFile, err := os.Stat(dstPath + "/" + fu.FormattedPath() + incompleteFileSuffix) - if err != nil && !errors.Is(err, fs.ErrNotExist) { - return err - } - if err == nil { - nextAction = dlFldrActionResumeFile - } - - fmt.Printf("Next Action: %v\n", nextAction) - - if _, err := conn.Write([]byte{0, uint8(nextAction)}); err != nil { - return err - } - - switch nextAction { - case dlFldrActionNextFile: - continue - case dlFldrActionResumeFile: - offset := make([]byte, 4) - binary.BigEndian.PutUint32(offset, uint32(inccompleteFile.Size())) - - file, err := os.OpenFile(dstPath+"/"+fu.FormattedPath()+incompleteFileSuffix, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) - if err != nil { - return err - } - - fileResumeData := NewFileResumeData([]ForkInfoList{ - *NewForkInfoList(offset), - }) - - b, _ := fileResumeData.BinaryMarshal() - - bs := make([]byte, 2) - binary.BigEndian.PutUint16(bs, uint16(len(b))) - - if _, err := conn.Write(append(bs, b...)); err != nil { - return err - } - - if _, err := io.ReadFull(conn, fileSize); err != nil { - return err - } - - if err := receiveFile(conn, file, ioutil.Discard); err != nil { - s.Logger.Error(err) - } - - err = os.Rename(dstPath+"/"+fu.FormattedPath()+".incomplete", dstPath+"/"+fu.FormattedPath()) - if err != nil { - return err - } - - case dlFldrActionSendFile: - if _, err := conn.Read(fileSize); err != nil { - return err - } - - filePath := dstPath + "/" + fu.FormattedPath() - s.Logger.Infow("Starting file transfer", "path", filePath, "fileNum", i+1, "totalFiles", "zz", "fileSize", binary.BigEndian.Uint32(fileSize)) - - newFile, err := FS.Create(filePath + ".incomplete") - if err != nil { - return err - } - - if err := receiveFile(conn, newFile, ioutil.Discard); err != nil { - s.Logger.Error(err) - } - _ = newFile.Close() - if err := os.Rename(filePath+".incomplete", filePath); err != nil { - return err - } - } - - // Tell client to send next file - if _, err := conn.Write([]byte{0, dlFldrActionNextFile}); err != nil { - return err - } - } + err = UploadFolderHandler(rwc, fullPath, fileTransfer, s.FS, rLogger, s.Config.PreserveResourceForks) + if err != nil { + return fmt.Errorf("file upload error: %w", err) } - s.Logger.Infof("Folder upload complete") } - return nil } -// sortedClients is a utility function that takes a map of *ClientConn and returns a sorted slice of the values. -// The purpose of this is to ensure that the ordering of client connections is deterministic so that test assertions work. -func sortedClients(unsortedClients map[uint16]*ClientConn) (clients []*ClientConn) { - for _, c := range unsortedClients { - clients = append(clients, c) +func (s *Server) SendAll(t TranType, fields ...Field) { + for _, c := range s.ClientMgr.List() { + s.outbox <- NewTransaction(t, c.ID, fields...) } - sort.Sort(byClientID(clients)) - return clients +} + +func (s *Server) Shutdown(msg []byte) { + s.Logger.Info("Shutdown signal received") + s.SendAll(TranDisconnectMsg, NewField(FieldData, msg)) + + time.Sleep(3 * time.Second) + + os.Exit(0) }