git.r.bdr.sh - rbdr/mobius/blob - hotline/server.go

   1 package hotline
   2
   3 import (
   4         "bufio"
   5         "bytes"
   6         "context"
   7         "encoding/binary"
   8         "errors"
   9         "fmt"
  10         "github.com/go-playground/validator/v10"
  11         "go.uber.org/zap"
  12         "gopkg.in/yaml.v3"
  13         "io"
  14         "io/fs"
  15         "io/ioutil"
  16         "math/big"
  17         "math/rand"
  18         "net"
  19         "os"
  20         "path/filepath"
  21         "strings"
  22         "sync"
  23         "time"
  24 )
  25
  26 type contextKey string
  27
  28 var contextKeyReq = contextKey("req")
  29
  30 type requestCtx struct {
  31         remoteAddr string
  32         login      string
  33         name       string
  34 }
  35
  36 const (
  37         userIdleSeconds        = 300 // time in seconds before an inactive user is marked idle
  38         idleCheckInterval      = 10  // time in seconds to check for idle users
  39         trackerUpdateFrequency = 300 // time in seconds between tracker re-registration
  40 )
  41
  42 var nostalgiaVersion = []byte{0, 0, 2, 0x2c} // version ID used by the Nostalgia client
  43
  44 type Server struct {
  45         Port          int
  46         Accounts      map[string]*Account
  47         Agreement     []byte
  48         Clients       map[uint16]*ClientConn
  49         fileTransfers map[[4]byte]*FileTransfer
  50
  51         Config        *Config
  52         ConfigDir     string
  53         Logger        *zap.SugaredLogger
  54         PrivateChats  map[uint32]*PrivateChat
  55         NextGuestID   *uint16
  56         TrackerPassID [4]byte
  57         Stats         *Stats
  58
  59         FS FileStore // Storage backend to use for File storage
  60
  61         outbox chan Transaction
  62         mux    sync.Mutex
  63
  64         threadedNewsMux sync.Mutex
  65         ThreadedNews    *ThreadedNews
  66
  67         flatNewsMux sync.Mutex
  68         FlatNews    []byte
  69
  70         banListMU sync.Mutex
  71         banList   map[string]*time.Time
  72 }
  73
  74 type PrivateChat struct {
  75         Subject    string
  76         ClientConn map[uint16]*ClientConn
  77 }
  78
  79 func (s *Server) ListenAndServe(ctx context.Context, cancelRoot context.CancelFunc) error {
  80         s.Logger.Infow("Hotline server started",
  81                 "version", VERSION,
  82                 "API port", fmt.Sprintf(":%v", s.Port),
  83                 "Transfer port", fmt.Sprintf(":%v", s.Port+1),
  84         )
  85
  86         var wg sync.WaitGroup
  87
  88         wg.Add(1)
  89         go func() {
  90                 ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", "", s.Port))
  91                 if err != nil {
  92                         s.Logger.Fatal(err)
  93                 }
  94
  95                 s.Logger.Fatal(s.Serve(ctx, ln))
  96         }()
  97
  98         wg.Add(1)
  99         go func() {
 100                 ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", "", s.Port+1))
 101                 if err != nil {
 102                         s.Logger.Fatal(err)
 103
 104                 }
 105
 106                 s.Logger.Fatal(s.ServeFileTransfers(ctx, ln))
 107         }()
 108
 109         wg.Wait()
 110
 111         return nil
 112 }
 113
 114 func (s *Server) ServeFileTransfers(ctx context.Context, ln net.Listener) error {
 115         for {
 116                 conn, err := ln.Accept()
 117                 if err != nil {
 118                         return err
 119                 }
 120
 121                 go func() {
 122                         defer func() { _ = conn.Close() }()
 123
 124                         err = s.handleFileTransfer(
 125                                 context.WithValue(ctx, contextKeyReq, requestCtx{
 126                                         remoteAddr: conn.RemoteAddr().String(),
 127                                 }),
 128                                 conn,
 129                         )
 130
 131                         if err != nil {
 132                                 s.Logger.Errorw("file transfer error", "reason", err)
 133                         }
 134                 }()
 135         }
 136 }
 137
 138 func (s *Server) sendTransaction(t Transaction) error {
 139         clientID, err := byteToInt(*t.clientID)
 140         if err != nil {
 141                 return err
 142         }
 143
 144         s.mux.Lock()
 145         client := s.Clients[uint16(clientID)]
 146         if client == nil {
 147                 return fmt.Errorf("invalid client id %v", *t.clientID)
 148         }
 149
 150         s.mux.Unlock()
 151
 152         b, err := t.MarshalBinary()
 153         if err != nil {
 154                 return err
 155         }
 156
 157         if _, err := client.Connection.Write(b); err != nil {
 158                 return err
 159         }
 160
 161         return nil
 162 }
 163
 164 func (s *Server) processOutbox() {
 165         for {
 166                 t := <-s.outbox
 167                 go func() {
 168                         if err := s.sendTransaction(t); err != nil {
 169                                 s.Logger.Errorw("error sending transaction", "err", err)
 170                         }
 171                 }()
 172         }
 173 }
 174
 175 func (s *Server) Serve(ctx context.Context, ln net.Listener) error {
 176         go s.processOutbox()
 177
 178         for {
 179                 conn, err := ln.Accept()
 180                 if err != nil {
 181                         s.Logger.Errorw("error accepting connection", "err", err)
 182                 }
 183                 connCtx := context.WithValue(ctx, contextKeyReq, requestCtx{
 184                         remoteAddr: conn.RemoteAddr().String(),
 185                 })
 186
 187                 go func() {
 188                         s.Logger.Infow("Connection established", "RemoteAddr", conn.RemoteAddr())
 189
 190                         defer conn.Close()
 191                         if err := s.handleNewConnection(connCtx, conn, conn.RemoteAddr().String()); err != nil {
 192                                 if err == io.EOF {
 193                                         s.Logger.Infow("Client disconnected", "RemoteAddr", conn.RemoteAddr())
 194                                 } else {
 195                                         s.Logger.Errorw("error serving request", "RemoteAddr", conn.RemoteAddr(), "err", err)
 196                                 }
 197                         }
 198                 }()
 199         }
 200 }
 201
 202 const (
 203         agreementFile = "Agreement.txt"
 204 )
 205
 206 // NewServer constructs a new Server from a config dir
 207 func NewServer(configDir string, netPort int, logger *zap.SugaredLogger, FS FileStore) (*Server, error) {
 208         server := Server{
 209                 Port:          netPort,
 210                 Accounts:      make(map[string]*Account),
 211                 Config:        new(Config),
 212                 Clients:       make(map[uint16]*ClientConn),
 213                 fileTransfers: make(map[[4]byte]*FileTransfer),
 214                 PrivateChats:  make(map[uint32]*PrivateChat),
 215                 ConfigDir:     configDir,
 216                 Logger:        logger,
 217                 NextGuestID:   new(uint16),
 218                 outbox:        make(chan Transaction),
 219                 Stats:         &Stats{StartTime: time.Now()},
 220                 ThreadedNews:  &ThreadedNews{},
 221                 FS:            FS,
 222                 banList:       make(map[string]*time.Time),
 223         }
 224
 225         var err error
 226
 227         // generate a new random passID for tracker registration
 228         if _, err := rand.Read(server.TrackerPassID[:]); err != nil {
 229                 return nil, err
 230         }
 231
 232         server.Agreement, err = os.ReadFile(filepath.Join(configDir, agreementFile))
 233         if err != nil {
 234                 return nil, err
 235         }
 236
 237         if server.FlatNews, err = os.ReadFile(filepath.Join(configDir, "MessageBoard.txt")); err != nil {
 238                 return nil, err
 239         }
 240
 241         // try to load the ban list, but ignore errors as this file may not be present or may be empty
 242         _ = server.loadBanList(filepath.Join(configDir, "Banlist.yaml"))
 243
 244         if err := server.loadThreadedNews(filepath.Join(configDir, "ThreadedNews.yaml")); err != nil {
 245                 return nil, err
 246         }
 247
 248         if err := server.loadConfig(filepath.Join(configDir, "config.yaml")); err != nil {
 249                 return nil, err
 250         }
 251
 252         if err := server.loadAccounts(filepath.Join(configDir, "Users/")); err != nil {
 253                 return nil, err
 254         }
 255
 256         server.Config.FileRoot = filepath.Join(configDir, "Files")
 257
 258         *server.NextGuestID = 1
 259
 260         if server.Config.EnableTrackerRegistration {
 261                 server.Logger.Infow(
 262                         "Tracker registration enabled",
 263                         "frequency", fmt.Sprintf("%vs", trackerUpdateFrequency),
 264                         "trackers", server.Config.Trackers,
 265                 )
 266
 267                 go func() {
 268                         for {
 269                                 tr := &TrackerRegistration{
 270                                         UserCount:   server.userCount(),
 271                                         PassID:      server.TrackerPassID[:],
 272                                         Name:        server.Config.Name,
 273                                         Description: server.Config.Description,
 274                                 }
 275                                 binary.BigEndian.PutUint16(tr.Port[:], uint16(server.Port))
 276                                 for _, t := range server.Config.Trackers {
 277                                         if err := register(t, tr); err != nil {
 278                                                 server.Logger.Errorw("unable to register with tracker %v", "error", err)
 279                                         }
 280                                         server.Logger.Debugw("Sent Tracker registration", "addr", t)
 281                                 }
 282
 283                                 time.Sleep(trackerUpdateFrequency * time.Second)
 284                         }
 285                 }()
 286         }
 287
 288         // Start Client Keepalive go routine
 289         go server.keepaliveHandler()
 290
 291         return &server, nil
 292 }
 293
 294 func (s *Server) userCount() int {
 295         s.mux.Lock()
 296         defer s.mux.Unlock()
 297
 298         return len(s.Clients)
 299 }
 300
 301 func (s *Server) keepaliveHandler() {
 302         for {
 303                 time.Sleep(idleCheckInterval * time.Second)
 304                 s.mux.Lock()
 305
 306                 for _, c := range s.Clients {
 307                         c.IdleTime += idleCheckInterval
 308                         if c.IdleTime > userIdleSeconds && !c.Idle {
 309                                 c.Idle = true
 310
 311                                 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(c.Flags)))
 312                                 flagBitmap.SetBit(flagBitmap, userFlagAway, 1)
 313                                 binary.BigEndian.PutUint16(c.Flags, uint16(flagBitmap.Int64()))
 314
 315                                 c.sendAll(
 316                                         tranNotifyChangeUser,
 317                                         NewField(fieldUserID, *c.ID),
 318                                         NewField(fieldUserFlags, c.Flags),
 319                                         NewField(fieldUserName, c.UserName),
 320                                         NewField(fieldUserIconID, c.Icon),
 321                                 )
 322                         }
 323                 }
 324                 s.mux.Unlock()
 325         }
 326 }
 327
 328 func (s *Server) writeBanList() error {
 329         s.banListMU.Lock()
 330         defer s.banListMU.Unlock()
 331
 332         out, err := yaml.Marshal(s.banList)
 333         if err != nil {
 334                 return err
 335         }
 336         err = ioutil.WriteFile(
 337                 filepath.Join(s.ConfigDir, "Banlist.yaml"),
 338                 out,
 339                 0666,
 340         )
 341         return err
 342 }
 343
 344 func (s *Server) writeThreadedNews() error {
 345         s.threadedNewsMux.Lock()
 346         defer s.threadedNewsMux.Unlock()
 347
 348         out, err := yaml.Marshal(s.ThreadedNews)
 349         if err != nil {
 350                 return err
 351         }
 352         err = s.FS.WriteFile(
 353                 filepath.Join(s.ConfigDir, "ThreadedNews.yaml"),
 354                 out,
 355                 0666,
 356         )
 357         return err
 358 }
 359
 360 func (s *Server) NewClientConn(conn io.ReadWriteCloser, remoteAddr string) *ClientConn {
 361         s.mux.Lock()
 362         defer s.mux.Unlock()
 363
 364         clientConn := &ClientConn{
 365                 ID:         &[]byte{0, 0},
 366                 Icon:       []byte{0, 0},
 367                 Flags:      []byte{0, 0},
 368                 UserName:   []byte{},
 369                 Connection: conn,
 370                 Server:     s,
 371                 Version:    []byte{},
 372                 AutoReply:  []byte{},
 373                 transfers:  map[int]map[[4]byte]*FileTransfer{},
 374                 Agreed:     false,
 375                 RemoteAddr: remoteAddr,
 376         }
 377         clientConn.transfers = map[int]map[[4]byte]*FileTransfer{
 378                 FileDownload:   {},
 379                 FileUpload:     {},
 380                 FolderDownload: {},
 381                 FolderUpload:   {},
 382                 bannerDownload: {},
 383         }
 384
 385         *s.NextGuestID++
 386         ID := *s.NextGuestID
 387
 388         binary.BigEndian.PutUint16(*clientConn.ID, ID)
 389         s.Clients[ID] = clientConn
 390
 391         return clientConn
 392 }
 393
 394 // NewUser creates a new user account entry in the server map and config file
 395 func (s *Server) NewUser(login, name, password string, access accessBitmap) error {
 396         s.mux.Lock()
 397         defer s.mux.Unlock()
 398
 399         account := Account{
 400                 Login:    login,
 401                 Name:     name,
 402                 Password: hashAndSalt([]byte(password)),
 403                 Access:   access,
 404         }
 405         out, err := yaml.Marshal(&account)
 406         if err != nil {
 407                 return err
 408         }
 409         s.Accounts[login] = &account
 410
 411         return s.FS.WriteFile(filepath.Join(s.ConfigDir, "Users", login+".yaml"), out, 0666)
 412 }
 413
 414 func (s *Server) UpdateUser(login, newLogin, name, password string, access accessBitmap) error {
 415         s.mux.Lock()
 416         defer s.mux.Unlock()
 417
 418         // update renames the user login
 419         if login != newLogin {
 420                 err := os.Rename(filepath.Join(s.ConfigDir, "Users", login+".yaml"), filepath.Join(s.ConfigDir, "Users", newLogin+".yaml"))
 421                 if err != nil {
 422                         return err
 423                 }
 424                 s.Accounts[newLogin] = s.Accounts[login]
 425                 delete(s.Accounts, login)
 426         }
 427
 428         account := s.Accounts[newLogin]
 429         account.Access = access
 430         account.Name = name
 431         account.Password = password
 432
 433         out, err := yaml.Marshal(&account)
 434         if err != nil {
 435                 return err
 436         }
 437
 438         if err := os.WriteFile(filepath.Join(s.ConfigDir, "Users", newLogin+".yaml"), out, 0666); err != nil {
 439                 return err
 440         }
 441
 442         return nil
 443 }
 444
 445 // DeleteUser deletes the user account
 446 func (s *Server) DeleteUser(login string) error {
 447         s.mux.Lock()
 448         defer s.mux.Unlock()
 449
 450         delete(s.Accounts, login)
 451
 452         return s.FS.Remove(filepath.Join(s.ConfigDir, "Users", login+".yaml"))
 453 }
 454
 455 func (s *Server) connectedUsers() []Field {
 456         s.mux.Lock()
 457         defer s.mux.Unlock()
 458
 459         var connectedUsers []Field
 460         for _, c := range sortedClients(s.Clients) {
 461                 if !c.Agreed {
 462                         continue
 463                 }
 464                 user := User{
 465                         ID:    *c.ID,
 466                         Icon:  c.Icon,
 467                         Flags: c.Flags,
 468                         Name:  string(c.UserName),
 469                 }
 470                 connectedUsers = append(connectedUsers, NewField(fieldUsernameWithInfo, user.Payload()))
 471         }
 472         return connectedUsers
 473 }
 474
 475 func (s *Server) loadBanList(path string) error {
 476         fh, err := os.Open(path)
 477         if err != nil {
 478                 return err
 479         }
 480         decoder := yaml.NewDecoder(fh)
 481
 482         return decoder.Decode(s.banList)
 483 }
 484
 485 // loadThreadedNews loads the threaded news data from disk
 486 func (s *Server) loadThreadedNews(threadedNewsPath string) error {
 487         fh, err := os.Open(threadedNewsPath)
 488         if err != nil {
 489                 return err
 490         }
 491         decoder := yaml.NewDecoder(fh)
 492
 493         return decoder.Decode(s.ThreadedNews)
 494 }
 495
 496 // loadAccounts loads account data from disk
 497 func (s *Server) loadAccounts(userDir string) error {
 498         matches, err := filepath.Glob(filepath.Join(userDir, "*.yaml"))
 499         if err != nil {
 500                 return err
 501         }
 502
 503         if len(matches) == 0 {
 504                 return errors.New("no user accounts found in " + userDir)
 505         }
 506
 507         for _, file := range matches {
 508                 fh, err := s.FS.Open(file)
 509                 if err != nil {
 510                         return err
 511                 }
 512
 513                 account := Account{}
 514                 decoder := yaml.NewDecoder(fh)
 515                 if err := decoder.Decode(&account); err != nil {
 516                         return err
 517                 }
 518
 519                 s.Accounts[account.Login] = &account
 520         }
 521         return nil
 522 }
 523
 524 func (s *Server) loadConfig(path string) error {
 525         fh, err := s.FS.Open(path)
 526         if err != nil {
 527                 return err
 528         }
 529
 530         decoder := yaml.NewDecoder(fh)
 531         err = decoder.Decode(s.Config)
 532         if err != nil {
 533                 return err
 534         }
 535
 536         validate := validator.New()
 537         err = validate.Struct(s.Config)
 538         if err != nil {
 539                 return err
 540         }
 541         return nil
 542 }
 543
 544 // handleNewConnection takes a new net.Conn and performs the initial login sequence
 545 func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser, remoteAddr string) error {
 546         defer dontPanic(s.Logger)
 547
 548         if err := Handshake(rwc); err != nil {
 549                 return err
 550         }
 551
 552         // Create a new scanner for parsing incoming bytes into transaction tokens
 553         scanner := bufio.NewScanner(rwc)
 554         scanner.Split(transactionScanner)
 555
 556         scanner.Scan()
 557
 558         var clientLogin Transaction
 559         if _, err := clientLogin.Write(scanner.Bytes()); err != nil {
 560                 return err
 561         }
 562
 563         c := s.NewClientConn(rwc, remoteAddr)
 564
 565         // check if remoteAddr is present in the ban list
 566         if banUntil, ok := s.banList[strings.Split(remoteAddr, ":")[0]]; ok {
 567                 // permaban
 568                 if banUntil == nil {
 569                         s.outbox <- *NewTransaction(
 570                                 tranServerMsg,
 571                                 c.ID,
 572                                 NewField(fieldData, []byte("You are permanently banned on this server")),
 573                                 NewField(fieldChatOptions, []byte{0, 0}),
 574                         )
 575                         time.Sleep(1 * time.Second)
 576                         return nil
 577                 } else if time.Now().Before(*banUntil) {
 578                         s.outbox <- *NewTransaction(
 579                                 tranServerMsg,
 580                                 c.ID,
 581                                 NewField(fieldData, []byte("You are temporarily banned on this server")),
 582                                 NewField(fieldChatOptions, []byte{0, 0}),
 583                         )
 584                         time.Sleep(1 * time.Second)
 585                         return nil
 586                 }
 587
 588         }
 589         defer c.Disconnect()
 590
 591         encodedLogin := clientLogin.GetField(fieldUserLogin).Data
 592         encodedPassword := clientLogin.GetField(fieldUserPassword).Data
 593         c.Version = clientLogin.GetField(fieldVersion).Data
 594
 595         var login string
 596         for _, char := range encodedLogin {
 597                 login += string(rune(255 - uint(char)))
 598         }
 599         if login == "" {
 600                 login = GuestAccount
 601         }
 602
 603         c.logger = s.Logger.With("remoteAddr", remoteAddr, "login", login)
 604
 605         // If authentication fails, send error reply and close connection
 606         if !c.Authenticate(login, encodedPassword) {
 607                 t := c.NewErrReply(&clientLogin, "Incorrect login.")
 608                 b, err := t.MarshalBinary()
 609                 if err != nil {
 610                         return err
 611                 }
 612                 if _, err := rwc.Write(b); err != nil {
 613                         return err
 614                 }
 615
 616                 c.logger.Infow("Login failed", "clientVersion", fmt.Sprintf("%x", c.Version))
 617
 618                 return nil
 619         }
 620
 621         if clientLogin.GetField(fieldUserIconID).Data != nil {
 622                 c.Icon = clientLogin.GetField(fieldUserIconID).Data
 623         }
 624
 625         c.Account = c.Server.Accounts[login]
 626
 627         if clientLogin.GetField(fieldUserName).Data != nil {
 628                 if c.Authorize(accessAnyName) {
 629                         c.UserName = clientLogin.GetField(fieldUserName).Data
 630                 } else {
 631                         c.UserName = []byte(c.Account.Name)
 632                 }
 633         }
 634
 635         if c.Authorize(accessDisconUser) {
 636                 c.Flags = []byte{0, 2}
 637         }
 638
 639         s.outbox <- c.NewReply(&clientLogin,
 640                 NewField(fieldVersion, []byte{0x00, 0xbe}),
 641                 NewField(fieldCommunityBannerID, []byte{0, 0}),
 642                 NewField(fieldServerName, []byte(s.Config.Name)),
 643         )
 644
 645         // Send user access privs so client UI knows how to behave
 646         c.Server.outbox <- *NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, c.Account.Access[:]))
 647
 648         // Accounts with accessNoAgreement do not receive the server agreement on login.  The behavior is different between
 649         // client versions.  For 1.2.3 client, we do not send tranShowAgreement.  For other client versions, we send
 650         // tranShowAgreement but with the NoServerAgreement field set to 1.
 651         if c.Authorize(accessNoAgreement) {
 652                 // If client version is nil, then the client uses the 1.2.3 login behavior
 653                 if c.Version != nil {
 654                         c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldNoServerAgreement, []byte{1}))
 655                 }
 656         } else {
 657                 c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldData, s.Agreement))
 658         }
 659
 660         // Used simplified hotline v1.2.3 login flow for clients that do not send login info in tranAgreed
 661         if c.Version == nil || bytes.Equal(c.Version, nostalgiaVersion) {
 662                 c.Agreed = true
 663                 c.logger = c.logger.With("name", string(c.UserName))
 664                 c.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%v", func() int { i, _ := byteToInt(c.Version); return i }()))
 665
 666                 for _, t := range c.notifyOthers(
 667                         *NewTransaction(
 668                                 tranNotifyChangeUser, nil,
 669                                 NewField(fieldUserName, c.UserName),
 670                                 NewField(fieldUserID, *c.ID),
 671                                 NewField(fieldUserIconID, c.Icon),
 672                                 NewField(fieldUserFlags, c.Flags),
 673                         ),
 674                 ) {
 675                         c.Server.outbox <- t
 676                 }
 677         }
 678
 679         c.Server.Stats.LoginCount += 1
 680
 681         // Scan for new transactions and handle them as they come in.
 682         for scanner.Scan() {
 683                 // Make a new []byte slice and copy the scanner bytes to it.  This is critical to avoid a data race as the
 684                 // scanner re-uses the buffer for subsequent scans.
 685                 buf := make([]byte, len(scanner.Bytes()))
 686                 copy(buf, scanner.Bytes())
 687
 688                 var t Transaction
 689                 if _, err := t.Write(buf); err != nil {
 690                         return err
 691                 }
 692
 693                 if err := c.handleTransaction(t); err != nil {
 694                         c.logger.Errorw("Error handling transaction", "err", err)
 695                 }
 696         }
 697         return nil
 698 }
 699
 700 func (s *Server) NewPrivateChat(cc *ClientConn) []byte {
 701         s.mux.Lock()
 702         defer s.mux.Unlock()
 703
 704         randID := make([]byte, 4)
 705         rand.Read(randID)
 706         data := binary.BigEndian.Uint32(randID[:])
 707
 708         s.PrivateChats[data] = &PrivateChat{
 709                 Subject:    "",
 710                 ClientConn: make(map[uint16]*ClientConn),
 711         }
 712         s.PrivateChats[data].ClientConn[cc.uint16ID()] = cc
 713
 714         return randID
 715 }
 716
 717 const dlFldrActionSendFile = 1
 718 const dlFldrActionResumeFile = 2
 719 const dlFldrActionNextFile = 3
 720
 721 // handleFileTransfer receives a client net.Conn from the file transfer server, performs the requested transfer type, then closes the connection
 722 func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) error {
 723         defer dontPanic(s.Logger)
 724
 725         txBuf := make([]byte, 16)
 726         if _, err := io.ReadFull(rwc, txBuf); err != nil {
 727                 return err
 728         }
 729
 730         var t transfer
 731         if _, err := t.Write(txBuf); err != nil {
 732                 return err
 733         }
 734
 735         defer func() {
 736                 s.mux.Lock()
 737                 delete(s.fileTransfers, t.ReferenceNumber)
 738                 s.mux.Unlock()
 739
 740         }()
 741
 742         s.mux.Lock()
 743         fileTransfer, ok := s.fileTransfers[t.ReferenceNumber]
 744         s.mux.Unlock()
 745         if !ok {
 746                 return errors.New("invalid transaction ID")
 747         }
 748
 749         defer func() {
 750                 fileTransfer.ClientConn.transfersMU.Lock()
 751                 delete(fileTransfer.ClientConn.transfers[fileTransfer.Type], t.ReferenceNumber)
 752                 fileTransfer.ClientConn.transfersMU.Unlock()
 753         }()
 754
 755         rLogger := s.Logger.With(
 756                 "remoteAddr", ctx.Value(contextKeyReq).(requestCtx).remoteAddr,
 757                 "login", fileTransfer.ClientConn.Account.Login,
 758                 "name", string(fileTransfer.ClientConn.UserName),
 759         )
 760
 761         fullPath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName)
 762         if err != nil {
 763                 return err
 764         }
 765
 766         switch fileTransfer.Type {
 767         case bannerDownload:
 768                 if err := s.bannerDownload(rwc); err != nil {
 769                         return err
 770                 }
 771         case FileDownload:
 772                 s.Stats.DownloadCounter += 1
 773
 774                 var dataOffset int64
 775                 if fileTransfer.fileResumeData != nil {
 776                         dataOffset = int64(binary.BigEndian.Uint32(fileTransfer.fileResumeData.ForkInfoList[0].DataSize[:]))
 777                 }
 778
 779                 fw, err := newFileWrapper(s.FS, fullPath, 0)
 780                 if err != nil {
 781                         return err
 782                 }
 783
 784                 rLogger.Infow("File download started", "filePath", fullPath)
 785
 786                 // if file transfer options are included, that means this is a "quick preview" request from a 1.5+ client
 787                 if fileTransfer.options == nil {
 788                         // Start by sending flat file object to client
 789                         if _, err := rwc.Write(fw.ffo.BinaryMarshal()); err != nil {
 790                                 return err
 791                         }
 792                 }
 793
 794                 file, err := fw.dataForkReader()
 795                 if err != nil {
 796                         return err
 797                 }
 798
 799                 br := bufio.NewReader(file)
 800                 if _, err := br.Discard(int(dataOffset)); err != nil {
 801                         return err
 802                 }
 803
 804                 if _, err = io.Copy(rwc, io.TeeReader(br, fileTransfer.bytesSentCounter)); err != nil {
 805                         return err
 806                 }
 807
 808                 // if the client requested to resume transfer, do not send the resource fork header, or it will be appended into the fileWrapper data
 809                 if fileTransfer.fileResumeData == nil {
 810                         err = binary.Write(rwc, binary.BigEndian, fw.rsrcForkHeader())
 811                         if err != nil {
 812                                 return err
 813                         }
 814                 }
 815
 816                 rFile, err := fw.rsrcForkFile()
 817                 if err != nil {
 818                         return nil
 819                 }
 820
 821                 if _, err = io.Copy(rwc, io.TeeReader(rFile, fileTransfer.bytesSentCounter)); err != nil {
 822                         return err
 823                 }
 824
 825         case FileUpload:
 826                 s.Stats.UploadCounter += 1
 827
 828                 var file *os.File
 829
 830                 // A file upload has three possible cases:
 831                 // 1) Upload a new file
 832                 // 2) Resume a partially transferred file
 833                 // 3) Replace a fully uploaded file
 834                 //  We have to infer which case applies by inspecting what is already on the filesystem
 835
 836                 // 1) Check for existing file:
 837                 _, err = os.Stat(fullPath)
 838                 if err == nil {
 839                         return errors.New("existing file found at " + fullPath)
 840                 }
 841                 if errors.Is(err, fs.ErrNotExist) {
 842                         // If not found, open or create a new .incomplete file
 843                         file, err = os.OpenFile(fullPath+incompleteFileSuffix, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
 844                         if err != nil {
 845                                 return err
 846                         }
 847                 }
 848
 849                 f, err := newFileWrapper(s.FS, fullPath, 0)
 850                 if err != nil {
 851                         return err
 852                 }
 853
 854                 rLogger.Infow("File upload started", "dstFile", fullPath)
 855
 856                 rForkWriter := io.Discard
 857                 iForkWriter := io.Discard
 858                 if s.Config.PreserveResourceForks {
 859                         rForkWriter, err = f.rsrcForkWriter()
 860                         if err != nil {
 861                                 return err
 862                         }
 863
 864                         iForkWriter, err = f.infoForkWriter()
 865                         if err != nil {
 866                                 return err
 867                         }
 868                 }
 869
 870                 if err := receiveFile(rwc, file, rForkWriter, iForkWriter, fileTransfer.bytesSentCounter); err != nil {
 871                         s.Logger.Error(err)
 872                 }
 873
 874                 if err := file.Close(); err != nil {
 875                         return err
 876                 }
 877
 878                 if err := s.FS.Rename(fullPath+".incomplete", fullPath); err != nil {
 879                         return err
 880                 }
 881
 882                 rLogger.Infow("File upload complete", "dstFile", fullPath)
 883         case FolderDownload:
 884                 // Folder Download flow:
 885                 // 1. Get filePath from the transfer
 886                 // 2. Iterate over files
 887                 // 3. For each fileWrapper:
 888                 //       Send fileWrapper header to client
 889                 // The client can reply in 3 ways:
 890                 //
 891                 // 1. If type is an odd number (unknown type?), or fileWrapper download for the current fileWrapper is completed:
 892                 //              client sends []byte{0x00, 0x03} to tell the server to continue to the next fileWrapper
 893                 //
 894                 // 2. If download of a fileWrapper is to be resumed:
 895                 //              client sends:
 896                 //                      []byte{0x00, 0x02} // download folder action
 897                 //                      [2]byte // Resume data size
 898                 //                      []byte fileWrapper resume data (see myField_FileResumeData)
 899                 //
 900                 // 3. Otherwise, download of the fileWrapper is requested and client sends []byte{0x00, 0x01}
 901                 //
 902                 // When download is requested (case 2 or 3), server replies with:
 903                 //                      [4]byte - fileWrapper size
 904                 //                      []byte  - Flattened File Object
 905                 //
 906                 // After every fileWrapper download, client could request next fileWrapper with:
 907                 //                      []byte{0x00, 0x03}
 908                 //
 909                 // This notifies the server to send the next item header
 910
 911                 basePathLen := len(fullPath)
 912
 913                 rLogger.Infow("Start folder download", "path", fullPath)
 914
 915                 nextAction := make([]byte, 2)
 916                 if _, err := io.ReadFull(rwc, nextAction); err != nil {
 917                         return err
 918                 }
 919
 920                 i := 0
 921                 err = filepath.Walk(fullPath+"/", func(path string, info os.FileInfo, err error) error {
 922                         s.Stats.DownloadCounter += 1
 923                         i += 1
 924
 925                         if err != nil {
 926                                 return err
 927                         }
 928
 929                         // skip dot files
 930                         if strings.HasPrefix(info.Name(), ".") {
 931                                 return nil
 932                         }
 933
 934                         hlFile, err := newFileWrapper(s.FS, path, 0)
 935                         if err != nil {
 936                                 return err
 937                         }
 938
 939                         subPath := path[basePathLen+1:]
 940                         rLogger.Debugw("Sending fileheader", "i", i, "path", path, "fullFilePath", fullPath, "subPath", subPath, "IsDir", info.IsDir())
 941
 942                         if i == 1 {
 943                                 return nil
 944                         }
 945
 946                         fileHeader := NewFileHeader(subPath, info.IsDir())
 947
 948                         // Send the fileWrapper header to client
 949                         if _, err := rwc.Write(fileHeader.Payload()); err != nil {
 950                                 s.Logger.Errorf("error sending file header: %v", err)
 951                                 return err
 952                         }
 953
 954                         // Read the client's Next Action request
 955                         if _, err := io.ReadFull(rwc, nextAction); err != nil {
 956                                 return err
 957                         }
 958
 959                         rLogger.Debugw("Client folder download action", "action", fmt.Sprintf("%X", nextAction[0:2]))
 960
 961                         var dataOffset int64
 962
 963                         switch nextAction[1] {
 964                         case dlFldrActionResumeFile:
 965                                 // get size of resumeData
 966                                 resumeDataByteLen := make([]byte, 2)
 967                                 if _, err := io.ReadFull(rwc, resumeDataByteLen); err != nil {
 968                                         return err
 969                                 }
 970
 971                                 resumeDataLen := binary.BigEndian.Uint16(resumeDataByteLen)
 972                                 resumeDataBytes := make([]byte, resumeDataLen)
 973                                 if _, err := io.ReadFull(rwc, resumeDataBytes); err != nil {
 974                                         return err
 975                                 }
 976
 977                                 var frd FileResumeData
 978                                 if err := frd.UnmarshalBinary(resumeDataBytes); err != nil {
 979                                         return err
 980                                 }
 981                                 dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:]))
 982                         case dlFldrActionNextFile:
 983                                 // client asked to skip this file
 984                                 return nil
 985                         }
 986
 987                         if info.IsDir() {
 988                                 return nil
 989                         }
 990
 991                         rLogger.Infow("File download started",
 992                                 "fileName", info.Name(),
 993                                 "TransferSize", fmt.Sprintf("%x", hlFile.ffo.TransferSize(dataOffset)),
 994                         )
 995
 996                         // Send file size to client
 997                         if _, err := rwc.Write(hlFile.ffo.TransferSize(dataOffset)); err != nil {
 998                                 s.Logger.Error(err)
 999                                 return err
1000                         }
1001
1002                         // Send ffo bytes to client
1003                         if _, err := rwc.Write(hlFile.ffo.BinaryMarshal()); err != nil {
1004                                 s.Logger.Error(err)
1005                                 return err
1006                         }
1007
1008                         file, err := s.FS.Open(path)
1009                         if err != nil {
1010                                 return err
1011                         }
1012
1013                         // wr := bufio.NewWriterSize(rwc, 1460)
1014                         if _, err = io.Copy(rwc, io.TeeReader(file, fileTransfer.bytesSentCounter)); err != nil {
1015                                 return err
1016                         }
1017
1018                         if nextAction[1] != 2 && hlFile.ffo.FlatFileHeader.ForkCount[1] == 3 {
1019                                 err = binary.Write(rwc, binary.BigEndian, hlFile.rsrcForkHeader())
1020                                 if err != nil {
1021                                         return err
1022                                 }
1023
1024                                 rFile, err := hlFile.rsrcForkFile()
1025                                 if err != nil {
1026                                         return err
1027                                 }
1028
1029                                 if _, err = io.Copy(rwc, io.TeeReader(rFile, fileTransfer.bytesSentCounter)); err != nil {
1030                                         return err
1031                                 }
1032                         }
1033
1034                         // Read the client's Next Action request.  This is always 3, I think?
1035                         if _, err := io.ReadFull(rwc, nextAction); err != nil {
1036                                 return err
1037                         }
1038
1039                         return nil
1040                 })
1041
1042                 if err != nil {
1043                         return err
1044                 }
1045
1046         case FolderUpload:
1047                 rLogger.Infow(
1048                         "Folder upload started",
1049                         "dstPath", fullPath,
1050                         "TransferSize", binary.BigEndian.Uint32(fileTransfer.TransferSize),
1051                         "FolderItemCount", fileTransfer.FolderItemCount,
1052                 )
1053
1054                 // Check if the target folder exists.  If not, create it.
1055                 if _, err := s.FS.Stat(fullPath); os.IsNotExist(err) {
1056                         if err := s.FS.Mkdir(fullPath, 0777); err != nil {
1057                                 return err
1058                         }
1059                 }
1060
1061                 // Begin the folder upload flow by sending the "next file action" to client
1062                 if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
1063                         return err
1064                 }
1065
1066                 fileSize := make([]byte, 4)
1067
1068                 for i := 0; i < fileTransfer.ItemCount(); i++ {
1069                         s.Stats.UploadCounter += 1
1070
1071                         var fu folderUpload
1072                         if _, err := io.ReadFull(rwc, fu.DataSize[:]); err != nil {
1073                                 return err
1074                         }
1075                         if _, err := io.ReadFull(rwc, fu.IsFolder[:]); err != nil {
1076                                 return err
1077                         }
1078                         if _, err := io.ReadFull(rwc, fu.PathItemCount[:]); err != nil {
1079                                 return err
1080                         }
1081
1082                         fu.FileNamePath = make([]byte, binary.BigEndian.Uint16(fu.DataSize[:])-4) // -4 to subtract the path separator bytes
1083
1084                         if _, err := io.ReadFull(rwc, fu.FileNamePath); err != nil {
1085                                 return err
1086                         }
1087
1088                         rLogger.Infow(
1089                                 "Folder upload continued",
1090                                 "FormattedPath", fu.FormattedPath(),
1091                                 "IsFolder", fmt.Sprintf("%x", fu.IsFolder),
1092                                 "PathItemCount", binary.BigEndian.Uint16(fu.PathItemCount[:]),
1093                         )
1094
1095                         if fu.IsFolder == [2]byte{0, 1} {
1096                                 if _, err := os.Stat(filepath.Join(fullPath, fu.FormattedPath())); os.IsNotExist(err) {
1097                                         if err := os.Mkdir(filepath.Join(fullPath, fu.FormattedPath()), 0777); err != nil {
1098                                                 return err
1099                                         }
1100                                 }
1101
1102                                 // Tell client to send next file
1103                                 if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
1104                                         return err
1105                                 }
1106                         } else {
1107                                 nextAction := dlFldrActionSendFile
1108
1109                                 // Check if we have the full file already.  If so, send dlFldrAction_NextFile to client to skip.
1110                                 _, err = os.Stat(filepath.Join(fullPath, fu.FormattedPath()))
1111                                 if err != nil && !errors.Is(err, fs.ErrNotExist) {
1112                                         return err
1113                                 }
1114                                 if err == nil {
1115                                         nextAction = dlFldrActionNextFile
1116                                 }
1117
1118                                 //  Check if we have a partial file already.  If so, send dlFldrAction_ResumeFile to client to resume upload.
1119                                 incompleteFile, err := os.Stat(filepath.Join(fullPath, fu.FormattedPath()+incompleteFileSuffix))
1120                                 if err != nil && !errors.Is(err, fs.ErrNotExist) {
1121                                         return err
1122                                 }
1123                                 if err == nil {
1124                                         nextAction = dlFldrActionResumeFile
1125                                 }
1126
1127                                 if _, err := rwc.Write([]byte{0, uint8(nextAction)}); err != nil {
1128                                         return err
1129                                 }
1130
1131                                 switch nextAction {
1132                                 case dlFldrActionNextFile:
1133                                         continue
1134                                 case dlFldrActionResumeFile:
1135                                         offset := make([]byte, 4)
1136                                         binary.BigEndian.PutUint32(offset, uint32(incompleteFile.Size()))
1137
1138                                         file, err := os.OpenFile(fullPath+"/"+fu.FormattedPath()+incompleteFileSuffix, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
1139                                         if err != nil {
1140                                                 return err
1141                                         }
1142
1143                                         fileResumeData := NewFileResumeData([]ForkInfoList{*NewForkInfoList(offset)})
1144
1145                                         b, _ := fileResumeData.BinaryMarshal()
1146
1147                                         bs := make([]byte, 2)
1148                                         binary.BigEndian.PutUint16(bs, uint16(len(b)))
1149
1150                                         if _, err := rwc.Write(append(bs, b...)); err != nil {
1151                                                 return err
1152                                         }
1153
1154                                         if _, err := io.ReadFull(rwc, fileSize); err != nil {
1155                                                 return err
1156                                         }
1157
1158                                         if err := receiveFile(rwc, file, ioutil.Discard, ioutil.Discard, fileTransfer.bytesSentCounter); err != nil {
1159                                                 s.Logger.Error(err)
1160                                         }
1161
1162                                         err = os.Rename(fullPath+"/"+fu.FormattedPath()+".incomplete", fullPath+"/"+fu.FormattedPath())
1163                                         if err != nil {
1164                                                 return err
1165                                         }
1166
1167                                 case dlFldrActionSendFile:
1168                                         if _, err := io.ReadFull(rwc, fileSize); err != nil {
1169                                                 return err
1170                                         }
1171
1172                                         filePath := filepath.Join(fullPath, fu.FormattedPath())
1173
1174                                         hlFile, err := newFileWrapper(s.FS, filePath, 0)
1175                                         if err != nil {
1176                                                 return err
1177                                         }
1178
1179                                         rLogger.Infow("Starting file transfer", "path", filePath, "fileNum", i+1, "fileSize", binary.BigEndian.Uint32(fileSize))
1180
1181                                         incWriter, err := hlFile.incFileWriter()
1182                                         if err != nil {
1183                                                 return err
1184                                         }
1185
1186                                         rForkWriter := io.Discard
1187                                         iForkWriter := io.Discard
1188                                         if s.Config.PreserveResourceForks {
1189                                                 iForkWriter, err = hlFile.infoForkWriter()
1190                                                 if err != nil {
1191                                                         return err
1192                                                 }
1193
1194                                                 rForkWriter, err = hlFile.rsrcForkWriter()
1195                                                 if err != nil {
1196                                                         return err
1197                                                 }
1198                                         }
1199                                         if err := receiveFile(rwc, incWriter, rForkWriter, iForkWriter, fileTransfer.bytesSentCounter); err != nil {
1200                                                 return err
1201                                         }
1202
1203                                         if err := os.Rename(filePath+".incomplete", filePath); err != nil {
1204                                                 return err
1205                                         }
1206                                 }
1207
1208                                 // Tell client to send next fileWrapper
1209                                 if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
1210                                         return err
1211                                 }
1212                         }
1213                 }
1214                 rLogger.Infof("Folder upload complete")
1215         }
1216
1217         return nil
1218 }