source: code/trunk/downstream.go@ 716

Last change on this file since 716 was 716, checked in by hubert, 4 years ago

Allow AUTHENTICATE before NICK

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