source: code/trunk/downstream.go@ 750

Last change on this file since 750 was 750, checked in by contact, 4 years ago

Add username to downstreamConn log messages
File size: 73.5 KB
Line 
1package soju
2
3import (
4 "context"
5 "crypto/tls"
6 "encoding/base64"
7 "errors"
8 "fmt"
9 "io"
10 "net"
11 "strconv"
12 "strings"
13 "time"
14
15 "github.com/emersion/go-sasl"
16 "golang.org/x/crypto/bcrypt"
17 "gopkg.in/irc.v3"
18)
19
20type ircError struct {
21 Message *irc.Message
22}
23
24func (err ircError) Error() string {
25 return err.Message.String()
26}
27
28func newUnknownCommandError(cmd string) ircError {
29 return ircError{&irc.Message{
30 Command: irc.ERR_UNKNOWNCOMMAND,
31 Params: []string{
32 "*",
33 cmd,
34 "Unknown command",
35 },
36 }}
37}
38
39func newNeedMoreParamsError(cmd string) ircError {
40 return ircError{&irc.Message{
41 Command: irc.ERR_NEEDMOREPARAMS,
42 Params: []string{
43 "*",
44 cmd,
45 "Not enough parameters",
46 },
47 }}
48}
49
50func newChatHistoryError(subcommand string, target string) ircError {
51 return ircError{&irc.Message{
52 Command: "FAIL",
53 Params: []string{"CHATHISTORY", "MESSAGE_ERROR", subcommand, target, "Messages could not be retrieved"},
54 }}
55}
56
57// authError is an authentication error.
58type authError struct {
59 // Internal error cause. This will not be revealed to the user.
60 err error
61 // Error cause which can safely be sent to the user without compromising
62 // security.
63 reason string
64}
65
66func (err *authError) Error() string {
67 return err.err.Error()
68}
69
70func (err *authError) Unwrap() error {
71 return err.err
72}
73
74// authErrorReason returns the user-friendly reason of an authentication
75// failure.
76func authErrorReason(err error) string {
77 if authErr, ok := err.(*authError); ok {
78 return authErr.reason
79 } else {
80 return "Authentication failed"
81 }
82}
83
84func newInvalidUsernameOrPasswordError(err error) error {
85 return &authError{
86 err: err,
87 reason: "Invalid username or password",
88 }
89}
90
91func parseBouncerNetID(subcommand, s string) (int64, error) {
92 id, err := strconv.ParseInt(s, 10, 64)
93 if err != nil {
94 return 0, ircError{&irc.Message{
95 Command: "FAIL",
96 Params: []string{"BOUNCER", "INVALID_NETID", subcommand, s, "Invalid network ID"},
97 }}
98 }
99 return id, nil
100}
101
102func fillNetworkAddrAttrs(attrs irc.Tags, network *Network) {
103 u, err := network.URL()
104 if err != nil {
105 return
106 }
107
108 hasHostPort := true
109 switch u.Scheme {
110 case "ircs":
111 attrs["tls"] = irc.TagValue("1")
112 case "irc+insecure":
113 attrs["tls"] = irc.TagValue("0")
114 default: // e.g. unix://
115 hasHostPort = false
116 }
117 if host, port, err := net.SplitHostPort(u.Host); err == nil && hasHostPort {
118 attrs["host"] = irc.TagValue(host)
119 attrs["port"] = irc.TagValue(port)
120 } else if hasHostPort {
121 attrs["host"] = irc.TagValue(u.Host)
122 }
123}
124
125func getNetworkAttrs(network *network) irc.Tags {
126 state := "disconnected"
127 if uc := network.conn; uc != nil {
128 state = "connected"
129 }
130
131 attrs := irc.Tags{
132 "name": irc.TagValue(network.GetName()),
133 "state": irc.TagValue(state),
134 "nickname": irc.TagValue(GetNick(&network.user.User, &network.Network)),
135 }
136
137 if network.Username != "" {
138 attrs["username"] = irc.TagValue(network.Username)
139 }
140 if realname := GetRealname(&network.user.User, &network.Network); realname != "" {
141 attrs["realname"] = irc.TagValue(realname)
142 }
143
144 fillNetworkAddrAttrs(attrs, &network.Network)
145
146 return attrs
147}
148
149func networkAddrFromAttrs(attrs irc.Tags) string {
150 host, ok := attrs.GetTag("host")
151 if !ok {
152 return ""
153 }
154
155 addr := host
156 if port, ok := attrs.GetTag("port"); ok {
157 addr += ":" + port
158 }
159
160 if tlsStr, ok := attrs.GetTag("tls"); ok && tlsStr == "0" {
161 addr = "irc+insecure://" + tlsStr
162 }
163
164 return addr
165}
166
167func updateNetworkAttrs(record *Network, attrs irc.Tags, subcommand string) error {
168 addrAttrs := irc.Tags{}
169 fillNetworkAddrAttrs(addrAttrs, record)
170
171 updateAddr := false
172 for k, v := range attrs {
173 s := string(v)
174 switch k {
175 case "host", "port", "tls":
176 updateAddr = true
177 addrAttrs[k] = v
178 case "name":
179 record.Name = s
180 case "nickname":
181 record.Nick = s
182 case "username":
183 record.Username = s
184 case "realname":
185 record.Realname = s
186 case "pass":
187 record.Pass = s
188 default:
189 return ircError{&irc.Message{
190 Command: "FAIL",
191 Params: []string{"BOUNCER", "UNKNOWN_ATTRIBUTE", subcommand, k, "Unknown attribute"},
192 }}
193 }
194 }
195
196 if updateAddr {
197 record.Addr = networkAddrFromAttrs(addrAttrs)
198 if record.Addr == "" {
199 return ircError{&irc.Message{
200 Command: "FAIL",
201 Params: []string{"BOUNCER", "NEED_ATTRIBUTE", subcommand, "host", "Missing required host attribute"},
202 }}
203 }
204 }
205
206 return nil
207}
208
209// ' ' and ':' break the IRC message wire format, '@' and '!' break prefixes,
210// '*' and '?' break masks, '$' breaks server masks in PRIVMSG/NOTICE,
211// "*" is the reserved nickname for registration
212const illegalNickChars = " :@!*?$"
213
214// permanentDownstreamCaps is the list of always-supported downstream
215// capabilities.
216var permanentDownstreamCaps = map[string]string{
217 "batch": "",
218 "cap-notify": "",
219 "echo-message": "",
220 "invite-notify": "",
221 "message-tags": "",
222 "server-time": "",
223 "setname": "",
224
225 "soju.im/bouncer-networks": "",
226 "soju.im/bouncer-networks-notify": "",
227}
228
229// needAllDownstreamCaps is the list of downstream capabilities that
230// require support from all upstreams to be enabled
231var needAllDownstreamCaps = map[string]string{
232 "account-notify": "",
233 "account-tag": "",
234 "away-notify": "",
235 "extended-join": "",
236 "multi-prefix": "",
237
238 "draft/extended-monitor": "",
239}
240
241// passthroughIsupport is the set of ISUPPORT tokens that are directly passed
242// through from the upstream server to downstream clients.
243//
244// This is only effective in single-upstream mode.
245var passthroughIsupport = map[string]bool{
246 "AWAYLEN": true,
247 "BOT": true,
248 "CHANLIMIT": true,
249 "CHANMODES": true,
250 "CHANNELLEN": true,
251 "CHANTYPES": true,
252 "CLIENTTAGDENY": true,
253 "ELIST": true,
254 "EXCEPTS": true,
255 "EXTBAN": true,
256 "HOSTLEN": true,
257 "INVEX": true,
258 "KICKLEN": true,
259 "MAXLIST": true,
260 "MAXTARGETS": true,
261 "MODES": true,
262 "MONITOR": true,
263 "NAMELEN": true,
264 "NETWORK": true,
265 "NICKLEN": true,
266 "PREFIX": true,
267 "SAFELIST": true,
268 "TARGMAX": true,
269 "TOPICLEN": true,
270 "USERLEN": true,
271 "UTF8ONLY": true,
272 "WHOX": true,
273}
274
275type downstreamSASL struct {
276 server sasl.Server
277 plainUsername, plainPassword string
278}
279
280type downstreamConn struct {
281 conn
282
283 id uint64
284
285 registered bool
286 user *user
287 nick string
288 nickCM string
289 rawUsername string
290 networkName string
291 clientName string
292 realname string
293 hostname string
294 account string // RPL_LOGGEDIN/OUT state
295 password string // empty after authentication
296 network *network // can be nil
297 isMultiUpstream bool
298
299 negotiatingCaps bool
300 capVersion int
301 supportedCaps map[string]string
302 caps map[string]bool
303 sasl *downstreamSASL
304
305 lastBatchRef uint64
306
307 monitored casemapMap
308}
309
310func newDownstreamConn(srv *Server, ic ircConn, id uint64) *downstreamConn {
311 remoteAddr := ic.RemoteAddr().String()
312 logger := &prefixLogger{srv.Logger, fmt.Sprintf("downstream %q: ", remoteAddr)}
313 options := connOptions{Logger: logger}
314 dc := &downstreamConn{
315 conn: *newConn(srv, ic, &options),
316 id: id,
317 nick: "*",
318 nickCM: "*",
319 supportedCaps: make(map[string]string),
320 caps: make(map[string]bool),
321 monitored: newCasemapMap(0),
322 }
323 dc.hostname = remoteAddr
324 if host, _, err := net.SplitHostPort(dc.hostname); err == nil {
325 dc.hostname = host
326 }
327 for k, v := range permanentDownstreamCaps {
328 dc.supportedCaps[k] = v
329 }
330 dc.supportedCaps["sasl"] = "PLAIN"
331 // TODO: this is racy, we should only enable chathistory after
332 // authentication and then check that user.msgStore implements
333 // chatHistoryMessageStore
334 if srv.Config().LogPath != "" {
335 dc.supportedCaps["draft/chathistory"] = ""
336 }
337 return dc
338}
339
340func (dc *downstreamConn) prefix() *irc.Prefix {
341 return &irc.Prefix{
342 Name: dc.nick,
343 User: dc.user.Username,
344 Host: dc.hostname,
345 }
346}
347
348func (dc *downstreamConn) forEachNetwork(f func(*network)) {
349 if dc.network != nil {
350 f(dc.network)
351 } else if dc.isMultiUpstream {
352 dc.user.forEachNetwork(f)
353 }
354}
355
356func (dc *downstreamConn) forEachUpstream(f func(*upstreamConn)) {
357 if dc.network == nil && !dc.isMultiUpstream {
358 return
359 }
360 dc.user.forEachUpstream(func(uc *upstreamConn) {
361 if dc.network != nil && uc.network != dc.network {
362 return
363 }
364 f(uc)
365 })
366}
367
368// upstream returns the upstream connection, if any. If there are zero or if
369// there are multiple upstream connections, it returns nil.
370func (dc *downstreamConn) upstream() *upstreamConn {
371 if dc.network == nil {
372 return nil
373 }
374 return dc.network.conn
375}
376
377func isOurNick(net *network, nick string) bool {
378 // TODO: this doesn't account for nick changes
379 if net.conn != nil {
380 return net.casemap(nick) == net.conn.nickCM
381 }
382 // We're not currently connected to the upstream connection, so we don't
383 // know whether this name is our nickname. Best-effort: use the network's
384 // configured nickname and hope it was the one being used when we were
385 // connected.
386 return net.casemap(nick) == net.casemap(GetNick(&net.user.User, &net.Network))
387}
388
389// marshalEntity converts an upstream entity name (ie. channel or nick) into a
390// downstream entity name.
391//
392// This involves adding a "/<network>" suffix if the entity isn't the current
393// user.
394func (dc *downstreamConn) marshalEntity(net *network, name string) string {
395 if isOurNick(net, name) {
396 return dc.nick
397 }
398 name = partialCasemap(net.casemap, name)
399 if dc.network != nil {
400 if dc.network != net {
401 panic("soju: tried to marshal an entity for another network")
402 }
403 return name
404 }
405 return name + "/" + net.GetName()
406}
407
408func (dc *downstreamConn) marshalUserPrefix(net *network, prefix *irc.Prefix) *irc.Prefix {
409 if isOurNick(net, prefix.Name) {
410 return dc.prefix()
411 }
412 prefix.Name = partialCasemap(net.casemap, prefix.Name)
413 if dc.network != nil {
414 if dc.network != net {
415 panic("soju: tried to marshal a user prefix for another network")
416 }
417 return prefix
418 }
419 return &irc.Prefix{
420 Name: prefix.Name + "/" + net.GetName(),
421 User: prefix.User,
422 Host: prefix.Host,
423 }
424}
425
426// unmarshalEntityNetwork converts a downstream entity name (ie. channel or
427// nick) into an upstream entity name.
428//
429// This involves removing the "/<network>" suffix.
430func (dc *downstreamConn) unmarshalEntityNetwork(name string) (*network, string, error) {
431 if dc.network != nil {
432 return dc.network, name, nil
433 }
434 if !dc.isMultiUpstream {
435 return nil, "", ircError{&irc.Message{
436 Command: irc.ERR_NOSUCHCHANNEL,
437 Params: []string{dc.nick, name, "Cannot interact with channels and users on the bouncer connection. Did you mean to use a specific network?"},
438 }}
439 }
440
441 var net *network
442 if i := strings.LastIndexByte(name, '/'); i >= 0 {
443 network := name[i+1:]
444 name = name[:i]
445
446 for _, n := range dc.user.networks {
447 if network == n.GetName() {
448 net = n
449 break
450 }
451 }
452 }
453
454 if net == nil {
455 return nil, "", ircError{&irc.Message{
456 Command: irc.ERR_NOSUCHCHANNEL,
457 Params: []string{dc.nick, name, "Missing network suffix in name"},
458 }}
459 }
460
461 return net, name, nil
462}
463
464// unmarshalEntity is the same as unmarshalEntityNetwork, but returns the
465// upstream connection and fails if the upstream is disconnected.
466func (dc *downstreamConn) unmarshalEntity(name string) (*upstreamConn, string, error) {
467 net, name, err := dc.unmarshalEntityNetwork(name)
468 if err != nil {
469 return nil, "", err
470 }
471
472 if net.conn == nil {
473 return nil, "", ircError{&irc.Message{
474 Command: irc.ERR_NOSUCHCHANNEL,
475 Params: []string{dc.nick, name, "Disconnected from upstream network"},
476 }}
477 }
478
479 return net.conn, name, nil
480}
481
482func (dc *downstreamConn) unmarshalText(uc *upstreamConn, text string) string {
483 if dc.upstream() != nil {
484 return text
485 }
486 // TODO: smarter parsing that ignores URLs
487 return strings.ReplaceAll(text, "/"+uc.network.GetName(), "")
488}
489
490func (dc *downstreamConn) ReadMessage() (*irc.Message, error) {
491 msg, err := dc.conn.ReadMessage()
492 if err != nil {
493 return nil, err
494 }
495 dc.srv.metrics.downstreamInMessagesTotal.Inc()
496 return msg, nil
497}
498
499func (dc *downstreamConn) readMessages(ch chan<- event) error {
500 for {
501 msg, err := dc.ReadMessage()
502 if errors.Is(err, io.EOF) {
503 break
504 } else if err != nil {
505 return fmt.Errorf("failed to read IRC command: %v", err)
506 }
507
508 ch <- eventDownstreamMessage{msg, dc}
509 }
510
511 return nil
512}
513
514// SendMessage sends an outgoing message.
515//
516// This can only called from the user goroutine.
517func (dc *downstreamConn) SendMessage(msg *irc.Message) {
518 if !dc.caps["message-tags"] {
519 if msg.Command == "TAGMSG" {
520 return
521 }
522 msg = msg.Copy()
523 for name := range msg.Tags {
524 supported := false
525 switch name {
526 case "time":
527 supported = dc.caps["server-time"]
528 case "account":
529 supported = dc.caps["account"]
530 }
531 if !supported {
532 delete(msg.Tags, name)
533 }
534 }
535 }
536 if !dc.caps["batch"] && msg.Tags["batch"] != "" {
537 msg = msg.Copy()
538 delete(msg.Tags, "batch")
539 }
540 if msg.Command == "JOIN" && !dc.caps["extended-join"] {
541 msg.Params = msg.Params[:1]
542 }
543 if msg.Command == "SETNAME" && !dc.caps["setname"] {
544 return
545 }
546 if msg.Command == "AWAY" && !dc.caps["away-notify"] {
547 return
548 }
549 if msg.Command == "ACCOUNT" && !dc.caps["account-notify"] {
550 return
551 }
552
553 dc.srv.metrics.downstreamOutMessagesTotal.Inc()
554 dc.conn.SendMessage(msg)
555}
556
557func (dc *downstreamConn) SendBatch(typ string, params []string, tags irc.Tags, f func(batchRef irc.TagValue)) {
558 dc.lastBatchRef++
559 ref := fmt.Sprintf("%v", dc.lastBatchRef)
560
561 if dc.caps["batch"] {
562 dc.SendMessage(&irc.Message{
563 Tags: tags,
564 Prefix: dc.srv.prefix(),
565 Command: "BATCH",
566 Params: append([]string{"+" + ref, typ}, params...),
567 })
568 }
569
570 f(irc.TagValue(ref))
571
572 if dc.caps["batch"] {
573 dc.SendMessage(&irc.Message{
574 Prefix: dc.srv.prefix(),
575 Command: "BATCH",
576 Params: []string{"-" + ref},
577 })
578 }
579}
580
581// sendMessageWithID sends an outgoing message with the specified internal ID.
582func (dc *downstreamConn) sendMessageWithID(msg *irc.Message, id string) {
583 dc.SendMessage(msg)
584
585 if id == "" || !dc.messageSupportsBacklog(msg) {
586 return
587 }
588
589 dc.sendPing(id)
590}
591
592// advanceMessageWithID advances history to the specified message ID without
593// sending a message. This is useful e.g. for self-messages when echo-message
594// isn't enabled.
595func (dc *downstreamConn) advanceMessageWithID(msg *irc.Message, id string) {
596 if id == "" || !dc.messageSupportsBacklog(msg) {
597 return
598 }
599
600 dc.sendPing(id)
601}
602
603// ackMsgID acknowledges that a message has been received.
604func (dc *downstreamConn) ackMsgID(id string) {
605 netID, entity, err := parseMsgID(id, nil)
606 if err != nil {
607 dc.logger.Printf("failed to ACK message ID %q: %v", id, err)
608 return
609 }
610
611 network := dc.user.getNetworkByID(netID)
612 if network == nil {
613 return
614 }
615
616 network.delivered.StoreID(entity, dc.clientName, id)
617}
618
619func (dc *downstreamConn) sendPing(msgID string) {
620 token := "soju-msgid-" + msgID
621 dc.SendMessage(&irc.Message{
622 Command: "PING",
623 Params: []string{token},
624 })
625}
626
627func (dc *downstreamConn) handlePong(token string) {
628 if !strings.HasPrefix(token, "soju-msgid-") {
629 dc.logger.Printf("received unrecognized PONG token %q", token)
630 return
631 }
632 msgID := strings.TrimPrefix(token, "soju-msgid-")
633 dc.ackMsgID(msgID)
634}
635
636// marshalMessage re-formats a message coming from an upstream connection so
637// that it's suitable for being sent on this downstream connection. Only
638// messages that may appear in logs are supported, except MODE messages which
639// may only appear in single-upstream mode.
640func (dc *downstreamConn) marshalMessage(msg *irc.Message, net *network) *irc.Message {
641 msg = msg.Copy()
642 msg.Prefix = dc.marshalUserPrefix(net, msg.Prefix)
643
644 if dc.network != nil {
645 return msg
646 }
647
648 switch msg.Command {
649 case "PRIVMSG", "NOTICE", "TAGMSG":
650 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
651 case "NICK":
652 // Nick change for another user
653 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
654 case "JOIN", "PART":
655 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
656 case "KICK":
657 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
658 msg.Params[1] = dc.marshalEntity(net, msg.Params[1])
659 case "TOPIC":
660 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
661 case "QUIT", "SETNAME":
662 // This space is intentionally left blank
663 default:
664 panic(fmt.Sprintf("unexpected %q message", msg.Command))
665 }
666
667 return msg
668}
669
670func (dc *downstreamConn) handleMessage(ctx context.Context, msg *irc.Message) error {
671 ctx, cancel := dc.conn.NewContext(ctx)
672 defer cancel()
673
674 ctx, cancel = context.WithTimeout(ctx, handleDownstreamMessageTimeout)
675 defer cancel()
676
677 switch msg.Command {
678 case "QUIT":
679 return dc.Close()
680 default:
681 if dc.registered {
682 return dc.handleMessageRegistered(ctx, msg)
683 } else {
684 return dc.handleMessageUnregistered(ctx, msg)
685 }
686 }
687}
688
689func (dc *downstreamConn) handleMessageUnregistered(ctx context.Context, msg *irc.Message) error {
690 switch msg.Command {
691 case "NICK":
692 var nick string
693 if err := parseMessageParams(msg, &nick); err != nil {
694 return err
695 }
696 if nick == "" || strings.ContainsAny(nick, illegalNickChars) {
697 return ircError{&irc.Message{
698 Command: irc.ERR_ERRONEUSNICKNAME,
699 Params: []string{dc.nick, nick, "contains illegal characters"},
700 }}
701 }
702 nickCM := casemapASCII(nick)
703 if nickCM == serviceNickCM {
704 return ircError{&irc.Message{
705 Command: irc.ERR_NICKNAMEINUSE,
706 Params: []string{dc.nick, nick, "Nickname reserved for bouncer service"},
707 }}
708 }
709 dc.nick = nick
710 dc.nickCM = nickCM
711 case "USER":
712 if err := parseMessageParams(msg, &dc.rawUsername, nil, nil, &dc.realname); err != nil {
713 return err
714 }
715 case "PASS":
716 if err := parseMessageParams(msg, &dc.password); err != nil {
717 return err
718 }
719 case "CAP":
720 var subCmd string
721 if err := parseMessageParams(msg, &subCmd); err != nil {
722 return err
723 }
724 if err := dc.handleCapCommand(subCmd, msg.Params[1:]); err != nil {
725 return err
726 }
727 case "AUTHENTICATE":
728 credentials, err := dc.handleAuthenticateCommand(msg)
729 if err != nil {
730 return err
731 } else if credentials == nil {
732 break
733 }
734
735 if err := dc.authenticate(ctx, credentials.plainUsername, credentials.plainPassword); err != nil {
736 dc.logger.Printf("SASL authentication error for user %q: %v", credentials.plainUsername, err)
737 dc.endSASL(&irc.Message{
738 Prefix: dc.srv.prefix(),
739 Command: irc.ERR_SASLFAIL,
740 Params: []string{dc.nick, authErrorReason(err)},
741 })
742 break
743 }
744
745 // Technically we should send RPL_LOGGEDIN here. However we use
746 // RPL_LOGGEDIN to mirror the upstream connection status. Let's
747 // see how many clients that breaks. See:
748 // https://github.com/ircv3/ircv3-specifications/pull/476
749 dc.endSASL(nil)
750 case "BOUNCER":
751 var subcommand string
752 if err := parseMessageParams(msg, &subcommand); err != nil {
753 return err
754 }
755
756 switch strings.ToUpper(subcommand) {
757 case "BIND":
758 var idStr string
759 if err := parseMessageParams(msg, nil, &idStr); err != nil {
760 return err
761 }
762
763 if dc.user == nil {
764 return ircError{&irc.Message{
765 Command: "FAIL",
766 Params: []string{"BOUNCER", "ACCOUNT_REQUIRED", "BIND", "Authentication needed to bind to bouncer network"},
767 }}
768 }
769
770 id, err := parseBouncerNetID(subcommand, idStr)
771 if err != nil {
772 return err
773 }
774
775 var match *network
776 dc.user.forEachNetwork(func(net *network) {
777 if net.ID == id {
778 match = net
779 }
780 })
781 if match == nil {
782 return ircError{&irc.Message{
783 Command: "FAIL",
784 Params: []string{"BOUNCER", "INVALID_NETID", idStr, "Unknown network ID"},
785 }}
786 }
787
788 dc.networkName = match.GetName()
789 }
790 default:
791 dc.logger.Printf("unhandled message: %v", msg)
792 return newUnknownCommandError(msg.Command)
793 }
794 if dc.rawUsername != "" && dc.nick != "*" && !dc.negotiatingCaps {
795 return dc.register(ctx)
796 }
797 return nil
798}
799
800func (dc *downstreamConn) handleCapCommand(cmd string, args []string) error {
801 cmd = strings.ToUpper(cmd)
802
803 switch cmd {
804 case "LS":
805 if len(args) > 0 {
806 var err error
807 if dc.capVersion, err = strconv.Atoi(args[0]); err != nil {
808 return err
809 }
810 }
811 if !dc.registered && dc.capVersion >= 302 {
812 // Let downstream show everything it supports, and trim
813 // down the available capabilities when upstreams are
814 // known.
815 for k, v := range needAllDownstreamCaps {
816 dc.supportedCaps[k] = v
817 }
818 }
819
820 caps := make([]string, 0, len(dc.supportedCaps))
821 for k, v := range dc.supportedCaps {
822 if dc.capVersion >= 302 && v != "" {
823 caps = append(caps, k+"="+v)
824 } else {
825 caps = append(caps, k)
826 }
827 }
828
829 // TODO: multi-line replies
830 dc.SendMessage(&irc.Message{
831 Prefix: dc.srv.prefix(),
832 Command: "CAP",
833 Params: []string{dc.nick, "LS", strings.Join(caps, " ")},
834 })
835
836 if dc.capVersion >= 302 {
837 // CAP version 302 implicitly enables cap-notify
838 dc.caps["cap-notify"] = true
839 }
840
841 if !dc.registered {
842 dc.negotiatingCaps = true
843 }
844 case "LIST":
845 var caps []string
846 for name, enabled := range dc.caps {
847 if enabled {
848 caps = append(caps, name)
849 }
850 }
851
852 // TODO: multi-line replies
853 dc.SendMessage(&irc.Message{
854 Prefix: dc.srv.prefix(),
855 Command: "CAP",
856 Params: []string{dc.nick, "LIST", strings.Join(caps, " ")},
857 })
858 case "REQ":
859 if len(args) == 0 {
860 return ircError{&irc.Message{
861 Command: err_invalidcapcmd,
862 Params: []string{dc.nick, cmd, "Missing argument in CAP REQ command"},
863 }}
864 }
865
866 // TODO: atomically ack/nak the whole capability set
867 caps := strings.Fields(args[0])
868 ack := true
869 for _, name := range caps {
870 name = strings.ToLower(name)
871 enable := !strings.HasPrefix(name, "-")
872 if !enable {
873 name = strings.TrimPrefix(name, "-")
874 }
875
876 if enable == dc.caps[name] {
877 continue
878 }
879
880 _, ok := dc.supportedCaps[name]
881 if !ok {
882 ack = false
883 break
884 }
885
886 if name == "cap-notify" && dc.capVersion >= 302 && !enable {
887 // cap-notify cannot be disabled with CAP version 302
888 ack = false
889 break
890 }
891
892 dc.caps[name] = enable
893 }
894
895 reply := "NAK"
896 if ack {
897 reply = "ACK"
898 }
899 dc.SendMessage(&irc.Message{
900 Prefix: dc.srv.prefix(),
901 Command: "CAP",
902 Params: []string{dc.nick, reply, args[0]},
903 })
904
905 if !dc.registered {
906 dc.negotiatingCaps = true
907 }
908 case "END":
909 dc.negotiatingCaps = false
910 default:
911 return ircError{&irc.Message{
912 Command: err_invalidcapcmd,
913 Params: []string{dc.nick, cmd, "Unknown CAP command"},
914 }}
915 }
916 return nil
917}
918
919func (dc *downstreamConn) handleAuthenticateCommand(msg *irc.Message) (result *downstreamSASL, err error) {
920 defer func() {
921 if err != nil {
922 dc.sasl = nil
923 }
924 }()
925
926 if !dc.caps["sasl"] {
927 return nil, ircError{&irc.Message{
928 Prefix: dc.srv.prefix(),
929 Command: irc.ERR_SASLFAIL,
930 Params: []string{"*", "AUTHENTICATE requires the \"sasl\" capability to be enabled"},
931 }}
932 }
933 if len(msg.Params) == 0 {
934 return nil, ircError{&irc.Message{
935 Prefix: dc.srv.prefix(),
936 Command: irc.ERR_SASLFAIL,
937 Params: []string{"*", "Missing AUTHENTICATE argument"},
938 }}
939 }
940 if msg.Params[0] == "*" {
941 return nil, ircError{&irc.Message{
942 Prefix: dc.srv.prefix(),
943 Command: irc.ERR_SASLABORTED,
944 Params: []string{"*", "SASL authentication aborted"},
945 }}
946 }
947
948 var resp []byte
949 if dc.sasl == nil {
950 mech := strings.ToUpper(msg.Params[0])
951 var server sasl.Server
952 switch mech {
953 case "PLAIN":
954 server = sasl.NewPlainServer(sasl.PlainAuthenticator(func(identity, username, password string) error {
955 dc.sasl.plainUsername = username
956 dc.sasl.plainPassword = password
957 return nil
958 }))
959 default:
960 return nil, ircError{&irc.Message{
961 Prefix: dc.srv.prefix(),
962 Command: irc.ERR_SASLFAIL,
963 Params: []string{"*", fmt.Sprintf("Unsupported SASL mechanism %q", mech)},
964 }}
965 }
966
967 dc.sasl = &downstreamSASL{server: server}
968 } else {
969 // TODO: multi-line messages
970 if msg.Params[0] == "+" {
971 resp = nil
972 } else if resp, err = base64.StdEncoding.DecodeString(msg.Params[0]); err != nil {
973 return nil, ircError{&irc.Message{
974 Prefix: dc.srv.prefix(),
975 Command: irc.ERR_SASLFAIL,
976 Params: []string{"*", "Invalid base64-encoded response"},
977 }}
978 }
979 }
980
981 challenge, done, err := dc.sasl.server.Next(resp)
982 if err != nil {
983 return nil, err
984 } else if done {
985 return dc.sasl, nil
986 } else {
987 challengeStr := "+"
988 if len(challenge) > 0 {
989 challengeStr = base64.StdEncoding.EncodeToString(challenge)
990 }
991
992 // TODO: multi-line messages
993 dc.SendMessage(&irc.Message{
994 Prefix: dc.srv.prefix(),
995 Command: "AUTHENTICATE",
996 Params: []string{challengeStr},
997 })
998 return nil, nil
999 }
1000}
1001
1002func (dc *downstreamConn) endSASL(msg *irc.Message) {
1003 if dc.sasl == nil {
1004 return
1005 }
1006
1007 dc.sasl = nil
1008
1009 if msg != nil {
1010 dc.SendMessage(msg)
1011 } else {
1012 dc.SendMessage(&irc.Message{
1013 Prefix: dc.srv.prefix(),
1014 Command: irc.RPL_SASLSUCCESS,
1015 Params: []string{dc.nick, "SASL authentication successful"},
1016 })
1017 }
1018}
1019
1020func (dc *downstreamConn) setSupportedCap(name, value string) {
1021 prevValue, hasPrev := dc.supportedCaps[name]
1022 changed := !hasPrev || prevValue != value
1023 dc.supportedCaps[name] = value
1024
1025 if !dc.caps["cap-notify"] || !changed {
1026 return
1027 }
1028
1029 cap := name
1030 if value != "" && dc.capVersion >= 302 {
1031 cap = name + "=" + value
1032 }
1033
1034 dc.SendMessage(&irc.Message{
1035 Prefix: dc.srv.prefix(),
1036 Command: "CAP",
1037 Params: []string{dc.nick, "NEW", cap},
1038 })
1039}
1040
1041func (dc *downstreamConn) unsetSupportedCap(name string) {
1042 _, hasPrev := dc.supportedCaps[name]
1043 delete(dc.supportedCaps, name)
1044 delete(dc.caps, name)
1045
1046 if !dc.caps["cap-notify"] || !hasPrev {
1047 return
1048 }
1049
1050 dc.SendMessage(&irc.Message{
1051 Prefix: dc.srv.prefix(),
1052 Command: "CAP",
1053 Params: []string{dc.nick, "DEL", name},
1054 })
1055}
1056
1057func (dc *downstreamConn) updateSupportedCaps() {
1058 supportedCaps := make(map[string]bool)
1059 for cap := range needAllDownstreamCaps {
1060 supportedCaps[cap] = true
1061 }
1062 dc.forEachUpstream(func(uc *upstreamConn) {
1063 for cap, supported := range supportedCaps {
1064 supportedCaps[cap] = supported && uc.caps[cap]
1065 }
1066 })
1067
1068 for cap, supported := range supportedCaps {
1069 if supported {
1070 dc.setSupportedCap(cap, needAllDownstreamCaps[cap])
1071 } else {
1072 dc.unsetSupportedCap(cap)
1073 }
1074 }
1075
1076 if uc := dc.upstream(); uc != nil && uc.supportsSASL("PLAIN") {
1077 dc.setSupportedCap("sasl", "PLAIN")
1078 } else if dc.network != nil {
1079 dc.unsetSupportedCap("sasl")
1080 }
1081
1082 if uc := dc.upstream(); uc != nil && uc.caps["draft/account-registration"] {
1083 // Strip "before-connect", because we require downstreams to be fully
1084 // connected before attempting account registration.
1085 values := strings.Split(uc.supportedCaps["draft/account-registration"], ",")
1086 for i, v := range values {
1087 if v == "before-connect" {
1088 values = append(values[:i], values[i+1:]...)
1089 break
1090 }
1091 }
1092 dc.setSupportedCap("draft/account-registration", strings.Join(values, ","))
1093 } else {
1094 dc.unsetSupportedCap("draft/account-registration")
1095 }
1096
1097 if _, ok := dc.user.msgStore.(chatHistoryMessageStore); ok && dc.network != nil {
1098 dc.setSupportedCap("draft/event-playback", "")
1099 } else {
1100 dc.unsetSupportedCap("draft/event-playback")
1101 }
1102}
1103
1104func (dc *downstreamConn) updateNick() {
1105 if uc := dc.upstream(); uc != nil && uc.nick != dc.nick {
1106 dc.SendMessage(&irc.Message{
1107 Prefix: dc.prefix(),
1108 Command: "NICK",
1109 Params: []string{uc.nick},
1110 })
1111 dc.nick = uc.nick
1112 dc.nickCM = casemapASCII(dc.nick)
1113 }
1114}
1115
1116func (dc *downstreamConn) updateRealname() {
1117 if uc := dc.upstream(); uc != nil && uc.realname != dc.realname && dc.caps["setname"] {
1118 dc.SendMessage(&irc.Message{
1119 Prefix: dc.prefix(),
1120 Command: "SETNAME",
1121 Params: []string{uc.realname},
1122 })
1123 dc.realname = uc.realname
1124 }
1125}
1126
1127func (dc *downstreamConn) updateAccount() {
1128 var account string
1129 if dc.network == nil {
1130 account = dc.user.Username
1131 } else if uc := dc.upstream(); uc != nil {
1132 account = uc.account
1133 } else {
1134 return
1135 }
1136
1137 if dc.account == account || !dc.caps["sasl"] {
1138 return
1139 }
1140
1141 if account != "" {
1142 dc.SendMessage(&irc.Message{
1143 Prefix: dc.srv.prefix(),
1144 Command: irc.RPL_LOGGEDIN,
1145 Params: []string{dc.nick, dc.prefix().String(), account, "You are logged in as " + account},
1146 })
1147 } else {
1148 dc.SendMessage(&irc.Message{
1149 Prefix: dc.srv.prefix(),
1150 Command: irc.RPL_LOGGEDOUT,
1151 Params: []string{dc.nick, dc.prefix().String(), "You are logged out"},
1152 })
1153 }
1154
1155 dc.account = account
1156}
1157
1158func sanityCheckServer(ctx context.Context, addr string) error {
1159 ctx, cancel := context.WithTimeout(ctx, 15*time.Second)
1160 defer cancel()
1161
1162 conn, err := new(tls.Dialer).DialContext(ctx, "tcp", addr)
1163 if err != nil {
1164 return err
1165 }
1166
1167 return conn.Close()
1168}
1169
1170func unmarshalUsername(rawUsername string) (username, client, network string) {
1171 username = rawUsername
1172
1173 i := strings.IndexAny(username, "/@")
1174 j := strings.LastIndexAny(username, "/@")
1175 if i >= 0 {
1176 username = rawUsername[:i]
1177 }
1178 if j >= 0 {
1179 if rawUsername[j] == '@' {
1180 client = rawUsername[j+1:]
1181 } else {
1182 network = rawUsername[j+1:]
1183 }
1184 }
1185 if i >= 0 && j >= 0 && i < j {
1186 if rawUsername[i] == '@' {
1187 client = rawUsername[i+1 : j]
1188 } else {
1189 network = rawUsername[i+1 : j]
1190 }
1191 }
1192
1193 return username, client, network
1194}
1195
1196func (dc *downstreamConn) authenticate(ctx context.Context, username, password string) error {
1197 username, clientName, networkName := unmarshalUsername(username)
1198
1199 u, err := dc.srv.db.GetUser(ctx, username)
1200 if err != nil {
1201 return newInvalidUsernameOrPasswordError(fmt.Errorf("user not found: %w", err))
1202 }
1203
1204 // Password auth disabled
1205 if u.Password == "" {
1206 return newInvalidUsernameOrPasswordError(fmt.Errorf("password auth disabled"))
1207 }
1208
1209 err = bcrypt.CompareHashAndPassword([]byte(u.Password), []byte(password))
1210 if err != nil {
1211 return newInvalidUsernameOrPasswordError(fmt.Errorf("wrong password"))
1212 }
1213
1214 dc.user = dc.srv.getUser(username)
1215 if dc.user == nil {
1216 return fmt.Errorf("user not active")
1217 }
1218 dc.clientName = clientName
1219 dc.networkName = networkName
1220 return nil
1221}
1222
1223func (dc *downstreamConn) register(ctx context.Context) error {
1224 if dc.registered {
1225 return fmt.Errorf("tried to register twice")
1226 }
1227
1228 if dc.sasl != nil {
1229 dc.endSASL(&irc.Message{
1230 Prefix: dc.srv.prefix(),
1231 Command: irc.ERR_SASLABORTED,
1232 Params: []string{"*", "SASL authentication aborted"},
1233 })
1234 }
1235
1236 password := dc.password
1237 dc.password = ""
1238 if dc.user == nil {
1239 if err := dc.authenticate(ctx, dc.rawUsername, password); err != nil {
1240 dc.logger.Printf("PASS authentication error for user %q: %v", dc.rawUsername, err)
1241 return ircError{&irc.Message{
1242 Command: irc.ERR_PASSWDMISMATCH,
1243 Params: []string{"*", authErrorReason(err)},
1244 }}
1245 }
1246 }
1247
1248 if dc.clientName == "" && dc.networkName == "" {
1249 _, dc.clientName, dc.networkName = unmarshalUsername(dc.rawUsername)
1250 }
1251
1252 dc.registered = true
1253 dc.logger.Printf("registration complete for user %q", dc.user.Username)
1254 return nil
1255}
1256
1257func (dc *downstreamConn) loadNetwork(ctx context.Context) error {
1258 if dc.networkName == "" {
1259 return nil
1260 }
1261
1262 network := dc.user.getNetwork(dc.networkName)
1263 if network == nil {
1264 addr := dc.networkName
1265 if !strings.ContainsRune(addr, ':') {
1266 addr = addr + ":6697"
1267 }
1268
1269 dc.logger.Printf("trying to connect to new network %q", addr)
1270 if err := sanityCheckServer(ctx, addr); err != nil {
1271 dc.logger.Printf("failed to connect to %q: %v", addr, err)
1272 return ircError{&irc.Message{
1273 Command: irc.ERR_PASSWDMISMATCH,
1274 Params: []string{"*", fmt.Sprintf("Failed to connect to %q", dc.networkName)},
1275 }}
1276 }
1277
1278 // Some clients only allow specifying the nickname (and use the
1279 // nickname as a username too). Strip the network name from the
1280 // nickname when auto-saving networks.
1281 nick, _, _ := unmarshalUsername(dc.nick)
1282
1283 dc.logger.Printf("auto-saving network %q", dc.networkName)
1284 var err error
1285 network, err = dc.user.createNetwork(ctx, &Network{
1286 Addr: dc.networkName,
1287 Nick: nick,
1288 Enabled: true,
1289 })
1290 if err != nil {
1291 return err
1292 }
1293 }
1294
1295 dc.network = network
1296 return nil
1297}
1298
1299func (dc *downstreamConn) welcome(ctx context.Context) error {
1300 if dc.user == nil || !dc.registered {
1301 panic("tried to welcome an unregistered connection")
1302 }
1303
1304 remoteAddr := dc.conn.RemoteAddr().String()
1305 dc.logger = &prefixLogger{dc.srv.Logger, fmt.Sprintf("user %q: downstream %q: ", dc.user.Username, remoteAddr)}
1306
1307 // TODO: doing this might take some time. We should do it in dc.register
1308 // instead, but we'll potentially be adding a new network and this must be
1309 // done in the user goroutine.
1310 if err := dc.loadNetwork(ctx); err != nil {
1311 return err
1312 }
1313
1314 if dc.network == nil && !dc.caps["soju.im/bouncer-networks"] && dc.srv.Config().MultiUpstream {
1315 dc.isMultiUpstream = true
1316 }
1317
1318 dc.updateSupportedCaps()
1319
1320 isupport := []string{
1321 fmt.Sprintf("CHATHISTORY=%v", chatHistoryLimit),
1322 "CASEMAPPING=ascii",
1323 }
1324
1325 if dc.network != nil {
1326 isupport = append(isupport, fmt.Sprintf("BOUNCER_NETID=%v", dc.network.ID))
1327 }
1328 if title := dc.srv.Config().Title; dc.network == nil && title != "" {
1329 isupport = append(isupport, "NETWORK="+encodeISUPPORT(title))
1330 }
1331 if dc.network == nil && !dc.isMultiUpstream {
1332 isupport = append(isupport, "WHOX")
1333 }
1334
1335 if uc := dc.upstream(); uc != nil {
1336 for k := range passthroughIsupport {
1337 v, ok := uc.isupport[k]
1338 if !ok {
1339 continue
1340 }
1341 if v != nil {
1342 isupport = append(isupport, fmt.Sprintf("%v=%v", k, *v))
1343 } else {
1344 isupport = append(isupport, k)
1345 }
1346 }
1347 }
1348
1349 dc.SendMessage(&irc.Message{
1350 Prefix: dc.srv.prefix(),
1351 Command: irc.RPL_WELCOME,
1352 Params: []string{dc.nick, "Welcome to soju, " + dc.nick},
1353 })
1354 dc.SendMessage(&irc.Message{
1355 Prefix: dc.srv.prefix(),
1356 Command: irc.RPL_YOURHOST,
1357 Params: []string{dc.nick, "Your host is " + dc.srv.Config().Hostname},
1358 })
1359 dc.SendMessage(&irc.Message{
1360 Prefix: dc.srv.prefix(),
1361 Command: irc.RPL_MYINFO,
1362 Params: []string{dc.nick, dc.srv.Config().Hostname, "soju", "aiwroO", "OovaimnqpsrtklbeI"},
1363 })
1364 for _, msg := range generateIsupport(dc.srv.prefix(), dc.nick, isupport) {
1365 dc.SendMessage(msg)
1366 }
1367 if uc := dc.upstream(); uc != nil {
1368 dc.SendMessage(&irc.Message{
1369 Prefix: dc.srv.prefix(),
1370 Command: irc.RPL_UMODEIS,
1371 Params: []string{dc.nick, "+" + string(uc.modes)},
1372 })
1373 }
1374 if dc.network == nil && !dc.isMultiUpstream && dc.user.Admin {
1375 dc.SendMessage(&irc.Message{
1376 Prefix: dc.srv.prefix(),
1377 Command: irc.RPL_UMODEIS,
1378 Params: []string{dc.nick, "+o"},
1379 })
1380 }
1381
1382 dc.updateNick()
1383 dc.updateRealname()
1384 dc.updateAccount()
1385
1386 if motd := dc.user.srv.Config().MOTD; motd != "" && dc.network == nil {
1387 for _, msg := range generateMOTD(dc.srv.prefix(), dc.nick, motd) {
1388 dc.SendMessage(msg)
1389 }
1390 } else {
1391 motdHint := "No MOTD"
1392 if dc.network != nil {
1393 motdHint = "Use /motd to read the message of the day"
1394 }
1395 dc.SendMessage(&irc.Message{
1396 Prefix: dc.srv.prefix(),
1397 Command: irc.ERR_NOMOTD,
1398 Params: []string{dc.nick, motdHint},
1399 })
1400 }
1401
1402 if dc.caps["soju.im/bouncer-networks-notify"] {
1403 dc.SendBatch("soju.im/bouncer-networks", nil, nil, func(batchRef irc.TagValue) {
1404 dc.user.forEachNetwork(func(network *network) {
1405 idStr := fmt.Sprintf("%v", network.ID)
1406 attrs := getNetworkAttrs(network)
1407 dc.SendMessage(&irc.Message{
1408 Tags: irc.Tags{"batch": batchRef},
1409 Prefix: dc.srv.prefix(),
1410 Command: "BOUNCER",
1411 Params: []string{"NETWORK", idStr, attrs.String()},
1412 })
1413 })
1414 })
1415 }
1416
1417 dc.forEachUpstream(func(uc *upstreamConn) {
1418 for _, entry := range uc.channels.innerMap {
1419 ch := entry.value.(*upstreamChannel)
1420 if !ch.complete {
1421 continue
1422 }
1423 record := uc.network.channels.Value(ch.Name)
1424 if record != nil && record.Detached {
1425 continue
1426 }
1427
1428 dc.SendMessage(&irc.Message{
1429 Prefix: dc.prefix(),
1430 Command: "JOIN",
1431 Params: []string{dc.marshalEntity(ch.conn.network, ch.Name)},
1432 })
1433
1434 forwardChannel(dc, ch)
1435 }
1436 })
1437
1438 dc.forEachNetwork(func(net *network) {
1439 if dc.caps["draft/chathistory"] || dc.user.msgStore == nil {
1440 return
1441 }
1442
1443 // Only send history if we're the first connected client with that name
1444 // for the network
1445 firstClient := true
1446 dc.user.forEachDownstream(func(c *downstreamConn) {
1447 if c != dc && c.clientName == dc.clientName && c.network == dc.network {
1448 firstClient = false
1449 }
1450 })
1451 if firstClient {
1452 net.delivered.ForEachTarget(func(target string) {
1453 lastDelivered := net.delivered.LoadID(target, dc.clientName)
1454 if lastDelivered == "" {
1455 return
1456 }
1457
1458 dc.sendTargetBacklog(ctx, net, target, lastDelivered)
1459
1460 // Fast-forward history to last message
1461 targetCM := net.casemap(target)
1462 lastID, err := dc.user.msgStore.LastMsgID(&net.Network, targetCM, time.Now())
1463 if err != nil {
1464 dc.logger.Printf("failed to get last message ID: %v", err)
1465 return
1466 }
1467 net.delivered.StoreID(target, dc.clientName, lastID)
1468 })
1469 }
1470 })
1471
1472 return nil
1473}
1474
1475// messageSupportsBacklog checks whether the provided message can be sent as
1476// part of an history batch.
1477func (dc *downstreamConn) messageSupportsBacklog(msg *irc.Message) bool {
1478 // Don't replay all messages, because that would mess up client
1479 // state. For instance we just sent the list of users, sending
1480 // PART messages for one of these users would be incorrect.
1481 switch msg.Command {
1482 case "PRIVMSG", "NOTICE":
1483 return true
1484 }
1485 return false
1486}
1487
1488func (dc *downstreamConn) sendTargetBacklog(ctx context.Context, net *network, target, msgID string) {
1489 if dc.caps["draft/chathistory"] || dc.user.msgStore == nil {
1490 return
1491 }
1492
1493 ch := net.channels.Value(target)
1494
1495 ctx, cancel := context.WithTimeout(ctx, backlogTimeout)
1496 defer cancel()
1497
1498 targetCM := net.casemap(target)
1499 history, err := dc.user.msgStore.LoadLatestID(ctx, &net.Network, targetCM, msgID, backlogLimit)
1500 if err != nil {
1501 dc.logger.Printf("failed to send backlog for %q: %v", target, err)
1502 return
1503 }
1504
1505 dc.SendBatch("chathistory", []string{dc.marshalEntity(net, target)}, nil, func(batchRef irc.TagValue) {
1506 for _, msg := range history {
1507 if ch != nil && ch.Detached {
1508 if net.detachedMessageNeedsRelay(ch, msg) {
1509 dc.relayDetachedMessage(net, msg)
1510 }
1511 } else {
1512 msg.Tags["batch"] = batchRef
1513 dc.SendMessage(dc.marshalMessage(msg, net))
1514 }
1515 }
1516 })
1517}
1518
1519func (dc *downstreamConn) relayDetachedMessage(net *network, msg *irc.Message) {
1520 if msg.Command != "PRIVMSG" && msg.Command != "NOTICE" {
1521 return
1522 }
1523
1524 sender := msg.Prefix.Name
1525 target, text := msg.Params[0], msg.Params[1]
1526 if net.isHighlight(msg) {
1527 sendServiceNOTICE(dc, fmt.Sprintf("highlight in %v: <%v> %v", dc.marshalEntity(net, target), sender, text))
1528 } else {
1529 sendServiceNOTICE(dc, fmt.Sprintf("message in %v: <%v> %v", dc.marshalEntity(net, target), sender, text))
1530 }
1531}
1532
1533func (dc *downstreamConn) runUntilRegistered() error {
1534 ctx, cancel := context.WithTimeout(context.TODO(), downstreamRegisterTimeout)
1535 defer cancel()
1536
1537 // Close the connection with an error if the deadline is exceeded
1538 go func() {
1539 <-ctx.Done()
1540 if err := ctx.Err(); err == context.DeadlineExceeded {
1541 dc.SendMessage(&irc.Message{
1542 Prefix: dc.srv.prefix(),
1543 Command: "ERROR",
1544 Params: []string{"Connection registration timed out"},
1545 })
1546 dc.Close()
1547 }
1548 }()
1549
1550 for !dc.registered {
1551 msg, err := dc.ReadMessage()
1552 if err != nil {
1553 return fmt.Errorf("failed to read IRC command: %w", err)
1554 }
1555
1556 err = dc.handleMessage(ctx, msg)
1557 if ircErr, ok := err.(ircError); ok {
1558 ircErr.Message.Prefix = dc.srv.prefix()
1559 dc.SendMessage(ircErr.Message)
1560 } else if err != nil {
1561 return fmt.Errorf("failed to handle IRC command %q: %v", msg, err)
1562 }
1563 }
1564
1565 return nil
1566}
1567
1568func (dc *downstreamConn) handleMessageRegistered(ctx context.Context, msg *irc.Message) error {
1569 switch msg.Command {
1570 case "CAP":
1571 var subCmd string
1572 if err := parseMessageParams(msg, &subCmd); err != nil {
1573 return err
1574 }
1575 if err := dc.handleCapCommand(subCmd, msg.Params[1:]); err != nil {
1576 return err
1577 }
1578 case "PING":
1579 var source, destination string
1580 if err := parseMessageParams(msg, &source); err != nil {
1581 return err
1582 }
1583 if len(msg.Params) > 1 {
1584 destination = msg.Params[1]
1585 }
1586 hostname := dc.srv.Config().Hostname
1587 if destination != "" && destination != hostname {
1588 return ircError{&irc.Message{
1589 Command: irc.ERR_NOSUCHSERVER,
1590 Params: []string{dc.nick, destination, "No such server"},
1591 }}
1592 }
1593 dc.SendMessage(&irc.Message{
1594 Prefix: dc.srv.prefix(),
1595 Command: "PONG",
1596 Params: []string{hostname, source},
1597 })
1598 return nil
1599 case "PONG":
1600 if len(msg.Params) == 0 {
1601 return newNeedMoreParamsError(msg.Command)
1602 }
1603 token := msg.Params[len(msg.Params)-1]
1604 dc.handlePong(token)
1605 case "USER":
1606 return ircError{&irc.Message{
1607 Command: irc.ERR_ALREADYREGISTERED,
1608 Params: []string{dc.nick, "You may not reregister"},
1609 }}
1610 case "NICK":
1611 var rawNick string
1612 if err := parseMessageParams(msg, &rawNick); err != nil {
1613 return err
1614 }
1615
1616 nick := rawNick
1617 var upstream *upstreamConn
1618 if dc.upstream() == nil {
1619 uc, unmarshaledNick, err := dc.unmarshalEntity(nick)
1620 if err == nil { // NICK nick/network: NICK only on a specific upstream
1621 upstream = uc
1622 nick = unmarshaledNick
1623 }
1624 }
1625
1626 if nick == "" || strings.ContainsAny(nick, illegalNickChars) {
1627 return ircError{&irc.Message{
1628 Command: irc.ERR_ERRONEUSNICKNAME,
1629 Params: []string{dc.nick, rawNick, "contains illegal characters"},
1630 }}
1631 }
1632 if casemapASCII(nick) == serviceNickCM {
1633 return ircError{&irc.Message{
1634 Command: irc.ERR_NICKNAMEINUSE,
1635 Params: []string{dc.nick, rawNick, "Nickname reserved for bouncer service"},
1636 }}
1637 }
1638
1639 var err error
1640 dc.forEachNetwork(func(n *network) {
1641 if err != nil || (upstream != nil && upstream.network != n) {
1642 return
1643 }
1644 n.Nick = nick
1645 err = dc.srv.db.StoreNetwork(ctx, dc.user.ID, &n.Network)
1646 })
1647 if err != nil {
1648 return err
1649 }
1650
1651 dc.forEachUpstream(func(uc *upstreamConn) {
1652 if upstream != nil && upstream != uc {
1653 return
1654 }
1655 uc.SendMessageLabeled(dc.id, &irc.Message{
1656 Command: "NICK",
1657 Params: []string{nick},
1658 })
1659 })
1660
1661 if dc.upstream() == nil && upstream == nil && dc.nick != nick {
1662 dc.SendMessage(&irc.Message{
1663 Prefix: dc.prefix(),
1664 Command: "NICK",
1665 Params: []string{nick},
1666 })
1667 dc.nick = nick
1668 dc.nickCM = casemapASCII(dc.nick)
1669 }
1670 case "SETNAME":
1671 var realname string
1672 if err := parseMessageParams(msg, &realname); err != nil {
1673 return err
1674 }
1675
1676 // If the client just resets to the default, just wipe the per-network
1677 // preference
1678 storeRealname := realname
1679 if realname == dc.user.Realname {
1680 storeRealname = ""
1681 }
1682
1683 var storeErr error
1684 var needUpdate []Network
1685 dc.forEachNetwork(func(n *network) {
1686 // We only need to call updateNetwork for upstreams that don't
1687 // support setname
1688 if uc := n.conn; uc != nil && uc.caps["setname"] {
1689 uc.SendMessageLabeled(dc.id, &irc.Message{
1690 Command: "SETNAME",
1691 Params: []string{realname},
1692 })
1693
1694 n.Realname = storeRealname
1695 if err := dc.srv.db.StoreNetwork(ctx, dc.user.ID, &n.Network); err != nil {
1696 dc.logger.Printf("failed to store network realname: %v", err)
1697 storeErr = err
1698 }
1699 return
1700 }
1701
1702 record := n.Network // copy network record because we'll mutate it
1703 record.Realname = storeRealname
1704 needUpdate = append(needUpdate, record)
1705 })
1706
1707 // Walk the network list as a second step, because updateNetwork
1708 // mutates the original list
1709 for _, record := range needUpdate {
1710 if _, err := dc.user.updateNetwork(ctx, &record); err != nil {
1711 dc.logger.Printf("failed to update network realname: %v", err)
1712 storeErr = err
1713 }
1714 }
1715 if storeErr != nil {
1716 return ircError{&irc.Message{
1717 Command: "FAIL",
1718 Params: []string{"SETNAME", "CANNOT_CHANGE_REALNAME", "Failed to update realname"},
1719 }}
1720 }
1721
1722 if dc.upstream() == nil {
1723 dc.SendMessage(&irc.Message{
1724 Prefix: dc.prefix(),
1725 Command: "SETNAME",
1726 Params: []string{realname},
1727 })
1728 }
1729 case "JOIN":
1730 var namesStr string
1731 if err := parseMessageParams(msg, &namesStr); err != nil {
1732 return err
1733 }
1734
1735 var keys []string
1736 if len(msg.Params) > 1 {
1737 keys = strings.Split(msg.Params[1], ",")
1738 }
1739
1740 for i, name := range strings.Split(namesStr, ",") {
1741 uc, upstreamName, err := dc.unmarshalEntity(name)
1742 if err != nil {
1743 return err
1744 }
1745
1746 var key string
1747 if len(keys) > i {
1748 key = keys[i]
1749 }
1750
1751 if !uc.isChannel(upstreamName) {
1752 dc.SendMessage(&irc.Message{
1753 Prefix: dc.srv.prefix(),
1754 Command: irc.ERR_NOSUCHCHANNEL,
1755 Params: []string{name, "Not a channel name"},
1756 })
1757 continue
1758 }
1759
1760 params := []string{upstreamName}
1761 if key != "" {
1762 params = append(params, key)
1763 }
1764 uc.SendMessageLabeled(dc.id, &irc.Message{
1765 Command: "JOIN",
1766 Params: params,
1767 })
1768
1769 ch := uc.network.channels.Value(upstreamName)
1770 if ch != nil {
1771 // Don't clear the channel key if there's one set
1772 // TODO: add a way to unset the channel key
1773 if key != "" {
1774 ch.Key = key
1775 }
1776 uc.network.attach(ch)
1777 } else {
1778 ch = &Channel{
1779 Name: upstreamName,
1780 Key: key,
1781 }
1782 uc.network.channels.SetValue(upstreamName, ch)
1783 }
1784 if err := dc.srv.db.StoreChannel(ctx, uc.network.ID, ch); err != nil {
1785 dc.logger.Printf("failed to create or update channel %q: %v", upstreamName, err)
1786 }
1787 }
1788 case "PART":
1789 var namesStr string
1790 if err := parseMessageParams(msg, &namesStr); err != nil {
1791 return err
1792 }
1793
1794 var reason string
1795 if len(msg.Params) > 1 {
1796 reason = msg.Params[1]
1797 }
1798
1799 for _, name := range strings.Split(namesStr, ",") {
1800 uc, upstreamName, err := dc.unmarshalEntity(name)
1801 if err != nil {
1802 return err
1803 }
1804
1805 if strings.EqualFold(reason, "detach") {
1806 ch := uc.network.channels.Value(upstreamName)
1807 if ch != nil {
1808 uc.network.detach(ch)
1809 } else {
1810 ch = &Channel{
1811 Name: name,
1812 Detached: true,
1813 }
1814 uc.network.channels.SetValue(upstreamName, ch)
1815 }
1816 if err := dc.srv.db.StoreChannel(ctx, uc.network.ID, ch); err != nil {
1817 dc.logger.Printf("failed to create or update channel %q: %v", upstreamName, err)
1818 }
1819 } else {
1820 params := []string{upstreamName}
1821 if reason != "" {
1822 params = append(params, reason)
1823 }
1824 uc.SendMessageLabeled(dc.id, &irc.Message{
1825 Command: "PART",
1826 Params: params,
1827 })
1828
1829 if err := uc.network.deleteChannel(ctx, upstreamName); err != nil {
1830 dc.logger.Printf("failed to delete channel %q: %v", upstreamName, err)
1831 }
1832 }
1833 }
1834 case "KICK":
1835 var channelStr, userStr string
1836 if err := parseMessageParams(msg, &channelStr, &userStr); err != nil {
1837 return err
1838 }
1839
1840 channels := strings.Split(channelStr, ",")
1841 users := strings.Split(userStr, ",")
1842
1843 var reason string
1844 if len(msg.Params) > 2 {
1845 reason = msg.Params[2]
1846 }
1847
1848 if len(channels) != 1 && len(channels) != len(users) {
1849 return ircError{&irc.Message{
1850 Command: irc.ERR_BADCHANMASK,
1851 Params: []string{dc.nick, channelStr, "Bad channel mask"},
1852 }}
1853 }
1854
1855 for i, user := range users {
1856 var channel string
1857 if len(channels) == 1 {
1858 channel = channels[0]
1859 } else {
1860 channel = channels[i]
1861 }
1862
1863 ucChannel, upstreamChannel, err := dc.unmarshalEntity(channel)
1864 if err != nil {
1865 return err
1866 }
1867
1868 ucUser, upstreamUser, err := dc.unmarshalEntity(user)
1869 if err != nil {
1870 return err
1871 }
1872
1873 if ucChannel != ucUser {
1874 return ircError{&irc.Message{
1875 Command: irc.ERR_USERNOTINCHANNEL,
1876 Params: []string{dc.nick, user, channel, "They are on another network"},
1877 }}
1878 }
1879 uc := ucChannel
1880
1881 params := []string{upstreamChannel, upstreamUser}
1882 if reason != "" {
1883 params = append(params, reason)
1884 }
1885 uc.SendMessageLabeled(dc.id, &irc.Message{
1886 Command: "KICK",
1887 Params: params,
1888 })
1889 }
1890 case "MODE":
1891 var name string
1892 if err := parseMessageParams(msg, &name); err != nil {
1893 return err
1894 }
1895
1896 var modeStr string
1897 if len(msg.Params) > 1 {
1898 modeStr = msg.Params[1]
1899 }
1900
1901 if casemapASCII(name) == dc.nickCM {
1902 if modeStr != "" {
1903 if uc := dc.upstream(); uc != nil {
1904 uc.SendMessageLabeled(dc.id, &irc.Message{
1905 Command: "MODE",
1906 Params: []string{uc.nick, modeStr},
1907 })
1908 } else {
1909 dc.SendMessage(&irc.Message{
1910 Prefix: dc.srv.prefix(),
1911 Command: irc.ERR_UMODEUNKNOWNFLAG,
1912 Params: []string{dc.nick, "Cannot change user mode in multi-upstream mode"},
1913 })
1914 }
1915 } else {
1916 var userMode string
1917 if uc := dc.upstream(); uc != nil {
1918 userMode = string(uc.modes)
1919 }
1920
1921 dc.SendMessage(&irc.Message{
1922 Prefix: dc.srv.prefix(),
1923 Command: irc.RPL_UMODEIS,
1924 Params: []string{dc.nick, "+" + userMode},
1925 })
1926 }
1927 return nil
1928 }
1929
1930 uc, upstreamName, err := dc.unmarshalEntity(name)
1931 if err != nil {
1932 return err
1933 }
1934
1935 if !uc.isChannel(upstreamName) {
1936 return ircError{&irc.Message{
1937 Command: irc.ERR_USERSDONTMATCH,
1938 Params: []string{dc.nick, "Cannot change mode for other users"},
1939 }}
1940 }
1941
1942 if modeStr != "" {
1943 params := []string{upstreamName, modeStr}
1944 params = append(params, msg.Params[2:]...)
1945 uc.SendMessageLabeled(dc.id, &irc.Message{
1946 Command: "MODE",
1947 Params: params,
1948 })
1949 } else {
1950 ch := uc.channels.Value(upstreamName)
1951 if ch == nil {
1952 return ircError{&irc.Message{
1953 Command: irc.ERR_NOSUCHCHANNEL,
1954 Params: []string{dc.nick, name, "No such channel"},
1955 }}
1956 }
1957
1958 if ch.modes == nil {
1959 // we haven't received the initial RPL_CHANNELMODEIS yet
1960 // ignore the request, we will broadcast the modes later when we receive RPL_CHANNELMODEIS
1961 return nil
1962 }
1963
1964 modeStr, modeParams := ch.modes.Format()
1965 params := []string{dc.nick, name, modeStr}
1966 params = append(params, modeParams...)
1967
1968 dc.SendMessage(&irc.Message{
1969 Prefix: dc.srv.prefix(),
1970 Command: irc.RPL_CHANNELMODEIS,
1971 Params: params,
1972 })
1973 if ch.creationTime != "" {
1974 dc.SendMessage(&irc.Message{
1975 Prefix: dc.srv.prefix(),
1976 Command: rpl_creationtime,
1977 Params: []string{dc.nick, name, ch.creationTime},
1978 })
1979 }
1980 }
1981 case "TOPIC":
1982 var channel string
1983 if err := parseMessageParams(msg, &channel); err != nil {
1984 return err
1985 }
1986
1987 uc, upstreamName, err := dc.unmarshalEntity(channel)
1988 if err != nil {
1989 return err
1990 }
1991
1992 if len(msg.Params) > 1 { // setting topic
1993 topic := msg.Params[1]
1994 uc.SendMessageLabeled(dc.id, &irc.Message{
1995 Command: "TOPIC",
1996 Params: []string{upstreamName, topic},
1997 })
1998 } else { // getting topic
1999 ch := uc.channels.Value(upstreamName)
2000 if ch == nil {
2001 return ircError{&irc.Message{
2002 Command: irc.ERR_NOSUCHCHANNEL,
2003 Params: []string{dc.nick, upstreamName, "No such channel"},
2004 }}
2005 }
2006 sendTopic(dc, ch)
2007 }
2008 case "LIST":
2009 network := dc.network
2010 if network == nil && len(msg.Params) > 0 {
2011 var err error
2012 network, msg.Params[0], err = dc.unmarshalEntityNetwork(msg.Params[0])
2013 if err != nil {
2014 return err
2015 }
2016 }
2017 if network == nil {
2018 dc.SendMessage(&irc.Message{
2019 Prefix: dc.srv.prefix(),
2020 Command: irc.RPL_LISTEND,
2021 Params: []string{dc.nick, "LIST without a network suffix is not supported in multi-upstream mode"},
2022 })
2023 return nil
2024 }
2025
2026 uc := network.conn
2027 if uc == nil {
2028 dc.SendMessage(&irc.Message{
2029 Prefix: dc.srv.prefix(),
2030 Command: irc.RPL_LISTEND,
2031 Params: []string{dc.nick, "Disconnected from upstream server"},
2032 })
2033 return nil
2034 }
2035
2036 uc.enqueueCommand(dc, msg)
2037 case "NAMES":
2038 if len(msg.Params) == 0 {
2039 dc.SendMessage(&irc.Message{
2040 Prefix: dc.srv.prefix(),
2041 Command: irc.RPL_ENDOFNAMES,
2042 Params: []string{dc.nick, "*", "End of /NAMES list"},
2043 })
2044 return nil
2045 }
2046
2047 channels := strings.Split(msg.Params[0], ",")
2048 for _, channel := range channels {
2049 uc, upstreamName, err := dc.unmarshalEntity(channel)
2050 if err != nil {
2051 return err
2052 }
2053
2054 ch := uc.channels.Value(upstreamName)
2055 if ch != nil {
2056 sendNames(dc, ch)
2057 } else {
2058 // NAMES on a channel we have not joined, ask upstream
2059 uc.SendMessageLabeled(dc.id, &irc.Message{
2060 Command: "NAMES",
2061 Params: []string{upstreamName},
2062 })
2063 }
2064 }
2065 // For WHOX docs, see:
2066 // - http://faerion.sourceforge.net/doc/irc/whox.var
2067 // - https://github.com/quakenet/snircd/blob/master/doc/readme.who
2068 // Note, many features aren't widely implemented, such as flags and mask2
2069 case "WHO":
2070 if len(msg.Params) == 0 {
2071 // TODO: support WHO without parameters
2072 dc.SendMessage(&irc.Message{
2073 Prefix: dc.srv.prefix(),
2074 Command: irc.RPL_ENDOFWHO,
2075 Params: []string{dc.nick, "*", "End of /WHO list"},
2076 })
2077 return nil
2078 }
2079
2080 // Clients will use the first mask to match RPL_ENDOFWHO
2081 endOfWhoToken := msg.Params[0]
2082
2083 // TODO: add support for WHOX mask2
2084 mask := msg.Params[0]
2085 var options string
2086 if len(msg.Params) > 1 {
2087 options = msg.Params[1]
2088 }
2089
2090 optionsParts := strings.SplitN(options, "%", 2)
2091 // TODO: add support for WHOX flags in optionsParts[0]
2092 var fields, whoxToken string
2093 if len(optionsParts) == 2 {
2094 optionsParts := strings.SplitN(optionsParts[1], ",", 2)
2095 fields = strings.ToLower(optionsParts[0])
2096 if len(optionsParts) == 2 && strings.Contains(fields, "t") {
2097 whoxToken = optionsParts[1]
2098 }
2099 }
2100
2101 // TODO: support mixed bouncer/upstream WHO queries
2102 maskCM := casemapASCII(mask)
2103 if dc.network == nil && maskCM == dc.nickCM {
2104 // TODO: support AWAY (H/G) in self WHO reply
2105 flags := "H"
2106 if dc.user.Admin {
2107 flags += "*"
2108 }
2109 info := whoxInfo{
2110 Token: whoxToken,
2111 Username: dc.user.Username,
2112 Hostname: dc.hostname,
2113 Server: dc.srv.Config().Hostname,
2114 Nickname: dc.nick,
2115 Flags: flags,
2116 Account: dc.user.Username,
2117 Realname: dc.realname,
2118 }
2119 dc.SendMessage(generateWHOXReply(dc.srv.prefix(), dc.nick, fields, &info))
2120 dc.SendMessage(&irc.Message{
2121 Prefix: dc.srv.prefix(),
2122 Command: irc.RPL_ENDOFWHO,
2123 Params: []string{dc.nick, endOfWhoToken, "End of /WHO list"},
2124 })
2125 return nil
2126 }
2127 if maskCM == serviceNickCM {
2128 info := whoxInfo{
2129 Token: whoxToken,
2130 Username: servicePrefix.User,
2131 Hostname: servicePrefix.Host,
2132 Server: dc.srv.Config().Hostname,
2133 Nickname: serviceNick,
2134 Flags: "H*",
2135 Account: serviceNick,
2136 Realname: serviceRealname,
2137 }
2138 dc.SendMessage(generateWHOXReply(dc.srv.prefix(), dc.nick, fields, &info))
2139 dc.SendMessage(&irc.Message{
2140 Prefix: dc.srv.prefix(),
2141 Command: irc.RPL_ENDOFWHO,
2142 Params: []string{dc.nick, endOfWhoToken, "End of /WHO list"},
2143 })
2144 return nil
2145 }
2146
2147 // TODO: properly support WHO masks
2148 uc, upstreamMask, err := dc.unmarshalEntity(mask)
2149 if err != nil {
2150 return err
2151 }
2152
2153 params := []string{upstreamMask}
2154 if options != "" {
2155 params = append(params, options)
2156 }
2157
2158 uc.enqueueCommand(dc, &irc.Message{
2159 Command: "WHO",
2160 Params: params,
2161 })
2162 case "WHOIS":
2163 if len(msg.Params) == 0 {
2164 return ircError{&irc.Message{
2165 Command: irc.ERR_NONICKNAMEGIVEN,
2166 Params: []string{dc.nick, "No nickname given"},
2167 }}
2168 }
2169
2170 var target, mask string
2171 if len(msg.Params) == 1 {
2172 target = ""
2173 mask = msg.Params[0]
2174 } else {
2175 target = msg.Params[0]
2176 mask = msg.Params[1]
2177 }
2178 // TODO: support multiple WHOIS users
2179 if i := strings.IndexByte(mask, ','); i >= 0 {
2180 mask = mask[:i]
2181 }
2182
2183 if dc.network == nil && casemapASCII(mask) == dc.nickCM {
2184 dc.SendMessage(&irc.Message{
2185 Prefix: dc.srv.prefix(),
2186 Command: irc.RPL_WHOISUSER,
2187 Params: []string{dc.nick, dc.nick, dc.user.Username, dc.hostname, "*", dc.realname},
2188 })
2189 dc.SendMessage(&irc.Message{
2190 Prefix: dc.srv.prefix(),
2191 Command: irc.RPL_WHOISSERVER,
2192 Params: []string{dc.nick, dc.nick, dc.srv.Config().Hostname, "soju"},
2193 })
2194 if dc.user.Admin {
2195 dc.SendMessage(&irc.Message{
2196 Prefix: dc.srv.prefix(),
2197 Command: irc.RPL_WHOISOPERATOR,
2198 Params: []string{dc.nick, dc.nick, "is a bouncer administrator"},
2199 })
2200 }
2201 dc.SendMessage(&irc.Message{
2202 Prefix: dc.srv.prefix(),
2203 Command: rpl_whoisaccount,
2204 Params: []string{dc.nick, dc.nick, dc.user.Username, "is logged in as"},
2205 })
2206 dc.SendMessage(&irc.Message{
2207 Prefix: dc.srv.prefix(),
2208 Command: irc.RPL_ENDOFWHOIS,
2209 Params: []string{dc.nick, dc.nick, "End of /WHOIS list"},
2210 })
2211 return nil
2212 }
2213 if casemapASCII(mask) == serviceNickCM {
2214 dc.SendMessage(&irc.Message{
2215 Prefix: dc.srv.prefix(),
2216 Command: irc.RPL_WHOISUSER,
2217 Params: []string{dc.nick, serviceNick, servicePrefix.User, servicePrefix.Host, "*", serviceRealname},
2218 })
2219 dc.SendMessage(&irc.Message{
2220 Prefix: dc.srv.prefix(),
2221 Command: irc.RPL_WHOISSERVER,
2222 Params: []string{dc.nick, serviceNick, dc.srv.Config().Hostname, "soju"},
2223 })
2224 dc.SendMessage(&irc.Message{
2225 Prefix: dc.srv.prefix(),
2226 Command: irc.RPL_WHOISOPERATOR,
2227 Params: []string{dc.nick, serviceNick, "is the bouncer service"},
2228 })
2229 dc.SendMessage(&irc.Message{
2230 Prefix: dc.srv.prefix(),
2231 Command: rpl_whoisaccount,
2232 Params: []string{dc.nick, serviceNick, serviceNick, "is logged in as"},
2233 })
2234 dc.SendMessage(&irc.Message{
2235 Prefix: dc.srv.prefix(),
2236 Command: irc.RPL_ENDOFWHOIS,
2237 Params: []string{dc.nick, serviceNick, "End of /WHOIS list"},
2238 })
2239 return nil
2240 }
2241
2242 // TODO: support WHOIS masks
2243 uc, upstreamNick, err := dc.unmarshalEntity(mask)
2244 if err != nil {
2245 return err
2246 }
2247
2248 var params []string
2249 if target != "" {
2250 if target == mask { // WHOIS nick nick
2251 params = []string{upstreamNick, upstreamNick}
2252 } else {
2253 params = []string{target, upstreamNick}
2254 }
2255 } else {
2256 params = []string{upstreamNick}
2257 }
2258
2259 uc.SendMessageLabeled(dc.id, &irc.Message{
2260 Command: "WHOIS",
2261 Params: params,
2262 })
2263 case "PRIVMSG", "NOTICE":
2264 var targetsStr, text string
2265 if err := parseMessageParams(msg, &targetsStr, &text); err != nil {
2266 return err
2267 }
2268 tags := copyClientTags(msg.Tags)
2269
2270 for _, name := range strings.Split(targetsStr, ",") {
2271 if name == "$"+dc.srv.Config().Hostname || (name == "$*" && dc.network == nil) {
2272 // "$" means a server mask follows. If it's the bouncer's
2273 // hostname, broadcast the message to all bouncer users.
2274 if !dc.user.Admin {
2275 return ircError{&irc.Message{
2276 Prefix: dc.srv.prefix(),
2277 Command: irc.ERR_BADMASK,
2278 Params: []string{dc.nick, name, "Permission denied to broadcast message to all bouncer users"},
2279 }}
2280 }
2281
2282 dc.logger.Printf("broadcasting bouncer-wide %v: %v", msg.Command, text)
2283
2284 broadcastTags := tags.Copy()
2285 broadcastTags["time"] = irc.TagValue(time.Now().UTC().Format(serverTimeLayout))
2286 broadcastMsg := &irc.Message{
2287 Tags: broadcastTags,
2288 Prefix: servicePrefix,
2289 Command: msg.Command,
2290 Params: []string{name, text},
2291 }
2292 dc.srv.forEachUser(func(u *user) {
2293 u.events <- eventBroadcast{broadcastMsg}
2294 })
2295 continue
2296 }
2297
2298 if dc.network == nil && casemapASCII(name) == dc.nickCM {
2299 dc.SendMessage(&irc.Message{
2300 Tags: msg.Tags.Copy(),
2301 Prefix: dc.prefix(),
2302 Command: msg.Command,
2303 Params: []string{name, text},
2304 })
2305 continue
2306 }
2307
2308 if msg.Command == "PRIVMSG" && casemapASCII(name) == serviceNickCM {
2309 if dc.caps["echo-message"] {
2310 echoTags := tags.Copy()
2311 echoTags["time"] = irc.TagValue(time.Now().UTC().Format(serverTimeLayout))
2312 dc.SendMessage(&irc.Message{
2313 Tags: echoTags,
2314 Prefix: dc.prefix(),
2315 Command: msg.Command,
2316 Params: []string{name, text},
2317 })
2318 }
2319 handleServicePRIVMSG(ctx, dc, text)
2320 continue
2321 }
2322
2323 uc, upstreamName, err := dc.unmarshalEntity(name)
2324 if err != nil {
2325 return err
2326 }
2327
2328 if msg.Command == "PRIVMSG" && uc.network.casemap(upstreamName) == "nickserv" {
2329 dc.handleNickServPRIVMSG(ctx, uc, text)
2330 }
2331
2332 unmarshaledText := text
2333 if uc.isChannel(upstreamName) {
2334 unmarshaledText = dc.unmarshalText(uc, text)
2335 }
2336 uc.SendMessageLabeled(dc.id, &irc.Message{
2337 Tags: tags,
2338 Command: msg.Command,
2339 Params: []string{upstreamName, unmarshaledText},
2340 })
2341
2342 echoTags := tags.Copy()
2343 echoTags["time"] = irc.TagValue(time.Now().UTC().Format(serverTimeLayout))
2344 if uc.account != "" {
2345 echoTags["account"] = irc.TagValue(uc.account)
2346 }
2347 echoMsg := &irc.Message{
2348 Tags: echoTags,
2349 Prefix: &irc.Prefix{Name: uc.nick},
2350 Command: msg.Command,
2351 Params: []string{upstreamName, text},
2352 }
2353 uc.produce(upstreamName, echoMsg, dc)
2354
2355 uc.updateChannelAutoDetach(upstreamName)
2356 }
2357 case "TAGMSG":
2358 var targetsStr string
2359 if err := parseMessageParams(msg, &targetsStr); err != nil {
2360 return err
2361 }
2362 tags := copyClientTags(msg.Tags)
2363
2364 for _, name := range strings.Split(targetsStr, ",") {
2365 if dc.network == nil && casemapASCII(name) == dc.nickCM {
2366 dc.SendMessage(&irc.Message{
2367 Tags: msg.Tags.Copy(),
2368 Prefix: dc.prefix(),
2369 Command: "TAGMSG",
2370 Params: []string{name},
2371 })
2372 continue
2373 }
2374
2375 if casemapASCII(name) == serviceNickCM {
2376 continue
2377 }
2378
2379 uc, upstreamName, err := dc.unmarshalEntity(name)
2380 if err != nil {
2381 return err
2382 }
2383 if _, ok := uc.caps["message-tags"]; !ok {
2384 continue
2385 }
2386
2387 uc.SendMessageLabeled(dc.id, &irc.Message{
2388 Tags: tags,
2389 Command: "TAGMSG",
2390 Params: []string{upstreamName},
2391 })
2392
2393 uc.updateChannelAutoDetach(upstreamName)
2394 }
2395 case "INVITE":
2396 var user, channel string
2397 if err := parseMessageParams(msg, &user, &channel); err != nil {
2398 return err
2399 }
2400
2401 ucChannel, upstreamChannel, err := dc.unmarshalEntity(channel)
2402 if err != nil {
2403 return err
2404 }
2405
2406 ucUser, upstreamUser, err := dc.unmarshalEntity(user)
2407 if err != nil {
2408 return err
2409 }
2410
2411 if ucChannel != ucUser {
2412 return ircError{&irc.Message{
2413 Command: irc.ERR_USERNOTINCHANNEL,
2414 Params: []string{dc.nick, user, channel, "They are on another network"},
2415 }}
2416 }
2417 uc := ucChannel
2418
2419 uc.SendMessageLabeled(dc.id, &irc.Message{
2420 Command: "INVITE",
2421 Params: []string{upstreamUser, upstreamChannel},
2422 })
2423 case "AUTHENTICATE":
2424 // Post-connection-registration AUTHENTICATE is unsupported in
2425 // multi-upstream mode, or if the upstream doesn't support SASL
2426 uc := dc.upstream()
2427 if uc == nil || !uc.caps["sasl"] {
2428 return ircError{&irc.Message{
2429 Command: irc.ERR_SASLFAIL,
2430 Params: []string{dc.nick, "Upstream network authentication not supported"},
2431 }}
2432 }
2433
2434 credentials, err := dc.handleAuthenticateCommand(msg)
2435 if err != nil {
2436 return err
2437 }
2438
2439 if credentials != nil {
2440 if uc.saslClient != nil {
2441 dc.endSASL(&irc.Message{
2442 Prefix: dc.srv.prefix(),
2443 Command: irc.ERR_SASLFAIL,
2444 Params: []string{dc.nick, "Another authentication attempt is already in progress"},
2445 })
2446 return nil
2447 }
2448
2449 uc.logger.Printf("starting post-registration SASL PLAIN authentication with username %q", credentials.plainUsername)
2450 uc.saslClient = sasl.NewPlainClient("", credentials.plainUsername, credentials.plainPassword)
2451 uc.enqueueCommand(dc, &irc.Message{
2452 Command: "AUTHENTICATE",
2453 Params: []string{"PLAIN"},
2454 })
2455 }
2456 case "REGISTER", "VERIFY":
2457 // Check number of params here, since we'll use that to save the
2458 // credentials on command success
2459 if (msg.Command == "REGISTER" && len(msg.Params) < 3) || (msg.Command == "VERIFY" && len(msg.Params) < 2) {
2460 return newNeedMoreParamsError(msg.Command)
2461 }
2462
2463 uc := dc.upstream()
2464 if uc == nil || !uc.caps["draft/account-registration"] {
2465 return ircError{&irc.Message{
2466 Command: "FAIL",
2467 Params: []string{msg.Command, "TEMPORARILY_UNAVAILABLE", "*", "Upstream network account registration not supported"},
2468 }}
2469 }
2470
2471 uc.logger.Printf("starting %v with account name %v", msg.Command, msg.Params[0])
2472 uc.enqueueCommand(dc, msg)
2473 case "MONITOR":
2474 // MONITOR is unsupported in multi-upstream mode
2475 uc := dc.upstream()
2476 if uc == nil {
2477 return newUnknownCommandError(msg.Command)
2478 }
2479 if _, ok := uc.isupport["MONITOR"]; !ok {
2480 return newUnknownCommandError(msg.Command)
2481 }
2482
2483 var subcommand string
2484 if err := parseMessageParams(msg, &subcommand); err != nil {
2485 return err
2486 }
2487
2488 switch strings.ToUpper(subcommand) {
2489 case "+", "-":
2490 var targets string
2491 if err := parseMessageParams(msg, nil, &targets); err != nil {
2492 return err
2493 }
2494 for _, target := range strings.Split(targets, ",") {
2495 if subcommand == "+" {
2496 // Hard limit, just to avoid having downstreams fill our map
2497 if len(dc.monitored.innerMap) >= 1000 {
2498 dc.SendMessage(&irc.Message{
2499 Prefix: dc.srv.prefix(),
2500 Command: irc.ERR_MONLISTFULL,
2501 Params: []string{dc.nick, "1000", target, "Bouncer monitor list is full"},
2502 })
2503 continue
2504 }
2505
2506 dc.monitored.SetValue(target, nil)
2507
2508 if uc.monitored.Has(target) {
2509 cmd := irc.RPL_MONOFFLINE
2510 if online := uc.monitored.Value(target); online {
2511 cmd = irc.RPL_MONONLINE
2512 }
2513
2514 dc.SendMessage(&irc.Message{
2515 Prefix: dc.srv.prefix(),
2516 Command: cmd,
2517 Params: []string{dc.nick, target},
2518 })
2519 }
2520 } else {
2521 dc.monitored.Delete(target)
2522 }
2523 }
2524 uc.updateMonitor()
2525 case "C": // clear
2526 dc.monitored = newCasemapMap(0)
2527 uc.updateMonitor()
2528 case "L": // list
2529 // TODO: be less lazy and pack the list
2530 for _, entry := range dc.monitored.innerMap {
2531 dc.SendMessage(&irc.Message{
2532 Prefix: dc.srv.prefix(),
2533 Command: irc.RPL_MONLIST,
2534 Params: []string{dc.nick, entry.originalKey},
2535 })
2536 }
2537 dc.SendMessage(&irc.Message{
2538 Prefix: dc.srv.prefix(),
2539 Command: irc.RPL_ENDOFMONLIST,
2540 Params: []string{dc.nick, "End of MONITOR list"},
2541 })
2542 case "S": // status
2543 // TODO: be less lazy and pack the lists
2544 for _, entry := range dc.monitored.innerMap {
2545 target := entry.originalKey
2546
2547 cmd := irc.RPL_MONOFFLINE
2548 if online := uc.monitored.Value(target); online {
2549 cmd = irc.RPL_MONONLINE
2550 }
2551
2552 dc.SendMessage(&irc.Message{
2553 Prefix: dc.srv.prefix(),
2554 Command: cmd,
2555 Params: []string{dc.nick, target},
2556 })
2557 }
2558 }
2559 case "CHATHISTORY":
2560 var subcommand string
2561 if err := parseMessageParams(msg, &subcommand); err != nil {
2562 return err
2563 }
2564 var target, limitStr string
2565 var boundsStr [2]string
2566 switch subcommand {
2567 case "AFTER", "BEFORE", "LATEST":
2568 if err := parseMessageParams(msg, nil, &target, &boundsStr[0], &limitStr); err != nil {
2569 return err
2570 }
2571 case "BETWEEN":
2572 if err := parseMessageParams(msg, nil, &target, &boundsStr[0], &boundsStr[1], &limitStr); err != nil {
2573 return err
2574 }
2575 case "TARGETS":
2576 if dc.network == nil {
2577 // Either an unbound bouncer network, in which case we should return no targets,
2578 // or a multi-upstream downstream, but we don't support CHATHISTORY TARGETS for those yet.
2579 dc.SendBatch("draft/chathistory-targets", nil, nil, func(batchRef irc.TagValue) {})
2580 return nil
2581 }
2582 if err := parseMessageParams(msg, nil, &boundsStr[0], &boundsStr[1], &limitStr); err != nil {
2583 return err
2584 }
2585 default:
2586 // TODO: support AROUND
2587 return ircError{&irc.Message{
2588 Command: "FAIL",
2589 Params: []string{"CHATHISTORY", "INVALID_PARAMS", subcommand, "Unknown command"},
2590 }}
2591 }
2592
2593 // We don't save history for our service
2594 if casemapASCII(target) == serviceNickCM {
2595 dc.SendBatch("chathistory", []string{target}, nil, func(batchRef irc.TagValue) {})
2596 return nil
2597 }
2598
2599 store, ok := dc.user.msgStore.(chatHistoryMessageStore)
2600 if !ok {
2601 return ircError{&irc.Message{
2602 Command: irc.ERR_UNKNOWNCOMMAND,
2603 Params: []string{dc.nick, "CHATHISTORY", "Unknown command"},
2604 }}
2605 }
2606
2607 network, entity, err := dc.unmarshalEntityNetwork(target)
2608 if err != nil {
2609 return err
2610 }
2611 entity = network.casemap(entity)
2612
2613 // TODO: support msgid criteria
2614 var bounds [2]time.Time
2615 bounds[0] = parseChatHistoryBound(boundsStr[0])
2616 if subcommand == "LATEST" && boundsStr[0] == "*" {
2617 bounds[0] = time.Now()
2618 } else if bounds[0].IsZero() {
2619 return ircError{&irc.Message{
2620 Command: "FAIL",
2621 Params: []string{"CHATHISTORY", "INVALID_PARAMS", subcommand, boundsStr[0], "Invalid first bound"},
2622 }}
2623 }
2624
2625 if boundsStr[1] != "" {
2626 bounds[1] = parseChatHistoryBound(boundsStr[1])
2627 if bounds[1].IsZero() {
2628 return ircError{&irc.Message{
2629 Command: "FAIL",
2630 Params: []string{"CHATHISTORY", "INVALID_PARAMS", subcommand, boundsStr[1], "Invalid second bound"},
2631 }}
2632 }
2633 }
2634
2635 limit, err := strconv.Atoi(limitStr)
2636 if err != nil || limit < 0 || limit > chatHistoryLimit {
2637 return ircError{&irc.Message{
2638 Command: "FAIL",
2639 Params: []string{"CHATHISTORY", "INVALID_PARAMS", subcommand, limitStr, "Invalid limit"},
2640 }}
2641 }
2642
2643 eventPlayback := dc.caps["draft/event-playback"]
2644
2645 var history []*irc.Message
2646 switch subcommand {
2647 case "BEFORE", "LATEST":
2648 history, err = store.LoadBeforeTime(ctx, &network.Network, entity, bounds[0], time.Time{}, limit, eventPlayback)
2649 case "AFTER":
2650 history, err = store.LoadAfterTime(ctx, &network.Network, entity, bounds[0], time.Now(), limit, eventPlayback)
2651 case "BETWEEN":
2652 if bounds[0].Before(bounds[1]) {
2653 history, err = store.LoadAfterTime(ctx, &network.Network, entity, bounds[0], bounds[1], limit, eventPlayback)
2654 } else {
2655 history, err = store.LoadBeforeTime(ctx, &network.Network, entity, bounds[0], bounds[1], limit, eventPlayback)
2656 }
2657 case "TARGETS":
2658 // TODO: support TARGETS in multi-upstream mode
2659 targets, err := store.ListTargets(ctx, &network.Network, bounds[0], bounds[1], limit, eventPlayback)
2660 if err != nil {
2661 dc.logger.Printf("failed fetching targets for chathistory: %v", err)
2662 return ircError{&irc.Message{
2663 Command: "FAIL",
2664 Params: []string{"CHATHISTORY", "MESSAGE_ERROR", subcommand, "Failed to retrieve targets"},
2665 }}
2666 }
2667
2668 dc.SendBatch("draft/chathistory-targets", nil, nil, func(batchRef irc.TagValue) {
2669 for _, target := range targets {
2670 if ch := network.channels.Value(target.Name); ch != nil && ch.Detached {
2671 continue
2672 }
2673
2674 dc.SendMessage(&irc.Message{
2675 Tags: irc.Tags{"batch": batchRef},
2676 Prefix: dc.srv.prefix(),
2677 Command: "CHATHISTORY",
2678 Params: []string{"TARGETS", target.Name, target.LatestMessage.UTC().Format(serverTimeLayout)},
2679 })
2680 }
2681 })
2682
2683 return nil
2684 }
2685 if err != nil {
2686 dc.logger.Printf("failed fetching %q messages for chathistory: %v", target, err)
2687 return newChatHistoryError(subcommand, target)
2688 }
2689
2690 dc.SendBatch("chathistory", []string{target}, nil, func(batchRef irc.TagValue) {
2691 for _, msg := range history {
2692 msg.Tags["batch"] = batchRef
2693 dc.SendMessage(dc.marshalMessage(msg, network))
2694 }
2695 })
2696 case "BOUNCER":
2697 var subcommand string
2698 if err := parseMessageParams(msg, &subcommand); err != nil {
2699 return err
2700 }
2701
2702 switch strings.ToUpper(subcommand) {
2703 case "BIND":
2704 return ircError{&irc.Message{
2705 Command: "FAIL",
2706 Params: []string{"BOUNCER", "REGISTRATION_IS_COMPLETED", "BIND", "Cannot bind to a network after registration"},
2707 }}
2708 case "LISTNETWORKS":
2709 dc.SendBatch("soju.im/bouncer-networks", nil, nil, func(batchRef irc.TagValue) {
2710 dc.user.forEachNetwork(func(network *network) {
2711 idStr := fmt.Sprintf("%v", network.ID)
2712 attrs := getNetworkAttrs(network)
2713 dc.SendMessage(&irc.Message{
2714 Tags: irc.Tags{"batch": batchRef},
2715 Prefix: dc.srv.prefix(),
2716 Command: "BOUNCER",
2717 Params: []string{"NETWORK", idStr, attrs.String()},
2718 })
2719 })
2720 })
2721 case "ADDNETWORK":
2722 var attrsStr string
2723 if err := parseMessageParams(msg, nil, &attrsStr); err != nil {
2724 return err
2725 }
2726 attrs := irc.ParseTags(attrsStr)
2727
2728 record := &Network{Nick: dc.nick, Enabled: true}
2729 if err := updateNetworkAttrs(record, attrs, subcommand); err != nil {
2730 return err
2731 }
2732
2733 if record.Nick == dc.user.Username {
2734 record.Nick = ""
2735 }
2736 if record.Realname == dc.user.Realname {
2737 record.Realname = ""
2738 }
2739
2740 network, err := dc.user.createNetwork(ctx, record)
2741 if err != nil {
2742 return ircError{&irc.Message{
2743 Command: "FAIL",
2744 Params: []string{"BOUNCER", "UNKNOWN_ERROR", subcommand, fmt.Sprintf("Failed to create network: %v", err)},
2745 }}
2746 }
2747
2748 dc.SendMessage(&irc.Message{
2749 Prefix: dc.srv.prefix(),
2750 Command: "BOUNCER",
2751 Params: []string{"ADDNETWORK", fmt.Sprintf("%v", network.ID)},
2752 })
2753 case "CHANGENETWORK":
2754 var idStr, attrsStr string
2755 if err := parseMessageParams(msg, nil, &idStr, &attrsStr); err != nil {
2756 return err
2757 }
2758 id, err := parseBouncerNetID(subcommand, idStr)
2759 if err != nil {
2760 return err
2761 }
2762 attrs := irc.ParseTags(attrsStr)
2763
2764 net := dc.user.getNetworkByID(id)
2765 if net == nil {
2766 return ircError{&irc.Message{
2767 Command: "FAIL",
2768 Params: []string{"BOUNCER", "INVALID_NETID", subcommand, idStr, "Invalid network ID"},
2769 }}
2770 }
2771
2772 record := net.Network // copy network record because we'll mutate it
2773 if err := updateNetworkAttrs(&record, attrs, subcommand); err != nil {
2774 return err
2775 }
2776
2777 if record.Nick == dc.user.Username {
2778 record.Nick = ""
2779 }
2780 if record.Realname == dc.user.Realname {
2781 record.Realname = ""
2782 }
2783
2784 _, err = dc.user.updateNetwork(ctx, &record)
2785 if err != nil {
2786 return ircError{&irc.Message{
2787 Command: "FAIL",
2788 Params: []string{"BOUNCER", "UNKNOWN_ERROR", subcommand, fmt.Sprintf("Failed to update network: %v", err)},
2789 }}
2790 }
2791
2792 dc.SendMessage(&irc.Message{
2793 Prefix: dc.srv.prefix(),
2794 Command: "BOUNCER",
2795 Params: []string{"CHANGENETWORK", idStr},
2796 })
2797 case "DELNETWORK":
2798 var idStr string
2799 if err := parseMessageParams(msg, nil, &idStr); err != nil {
2800 return err
2801 }
2802 id, err := parseBouncerNetID(subcommand, idStr)
2803 if err != nil {
2804 return err
2805 }
2806
2807 net := dc.user.getNetworkByID(id)
2808 if net == nil {
2809 return ircError{&irc.Message{
2810 Command: "FAIL",
2811 Params: []string{"BOUNCER", "INVALID_NETID", subcommand, idStr, "Invalid network ID"},
2812 }}
2813 }
2814
2815 if err := dc.user.deleteNetwork(ctx, net.ID); err != nil {
2816 return err
2817 }
2818
2819 dc.SendMessage(&irc.Message{
2820 Prefix: dc.srv.prefix(),
2821 Command: "BOUNCER",
2822 Params: []string{"DELNETWORK", idStr},
2823 })
2824 default:
2825 return ircError{&irc.Message{
2826 Command: "FAIL",
2827 Params: []string{"BOUNCER", "UNKNOWN_COMMAND", subcommand, "Unknown subcommand"},
2828 }}
2829 }
2830 default:
2831 dc.logger.Printf("unhandled message: %v", msg)
2832
2833 // Only forward unknown commands in single-upstream mode
2834 uc := dc.upstream()
2835 if uc == nil {
2836 return newUnknownCommandError(msg.Command)
2837 }
2838
2839 uc.SendMessageLabeled(dc.id, msg)
2840 }
2841 return nil
2842}
2843
2844func (dc *downstreamConn) handleNickServPRIVMSG(ctx context.Context, uc *upstreamConn, text string) {
2845 username, password, ok := parseNickServCredentials(text, uc.nick)
2846 if ok {
2847 uc.network.autoSaveSASLPlain(ctx, username, password)
2848 }
2849}
2850
2851func parseNickServCredentials(text, nick string) (username, password string, ok bool) {
2852 fields := strings.Fields(text)
2853 if len(fields) < 2 {
2854 return "", "", false
2855 }
2856 cmd := strings.ToUpper(fields[0])
2857 params := fields[1:]
2858 switch cmd {
2859 case "REGISTER":
2860 username = nick
2861 password = params[0]
2862 case "IDENTIFY":
2863 if len(params) == 1 {
2864 username = nick
2865 password = params[0]
2866 } else {
2867 username = params[0]
2868 password = params[1]
2869 }
2870 case "SET":
2871 if len(params) == 2 && strings.EqualFold(params[0], "PASSWORD") {
2872 username = nick
2873 password = params[1]
2874 }
2875 default:
2876 return "", "", false
2877 }
2878 return username, password, true
2879}
Note: See TracBrowser for help on using the repository browser.