source: code/trunk/downstream.go@ 756

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

Use dc.nick instead of "*" for RPL_* messages

Makes it clearer what these fields are used for. The default value
for dc.nick is "*".
File size: 73.9 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, ',' breaks lists
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{dc.nick, "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{dc.nick, "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{dc.nick, "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{dc.nick, 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{dc.nick, "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{dc.nick, "SASL authentication aborted"},
1233 })
1234 }
1235
1236 password := dc.password
1237 dc.password = ""
1238 if dc.user == nil {
1239 if password == "" {
1240 if dc.caps["sasl"] {
1241 return ircError{&irc.Message{
1242 Command: "FAIL",
1243 Params: []string{"*", "ACCOUNT_REQUIRED", "Authentication required"},
1244 }}
1245 } else {
1246 return ircError{&irc.Message{
1247 Command: irc.ERR_PASSWDMISMATCH,
1248 Params: []string{dc.nick, "Authentication required"},
1249 }}
1250 }
1251 }
1252
1253 if err := dc.authenticate(ctx, dc.rawUsername, password); err != nil {
1254 dc.logger.Printf("PASS authentication error for user %q: %v", dc.rawUsername, err)
1255 return ircError{&irc.Message{
1256 Command: irc.ERR_PASSWDMISMATCH,
1257 Params: []string{dc.nick, authErrorReason(err)},
1258 }}
1259 }
1260 }
1261
1262 if dc.clientName == "" && dc.networkName == "" {
1263 _, dc.clientName, dc.networkName = unmarshalUsername(dc.rawUsername)
1264 }
1265
1266 dc.registered = true
1267 dc.logger.Printf("registration complete for user %q", dc.user.Username)
1268 return nil
1269}
1270
1271func (dc *downstreamConn) loadNetwork(ctx context.Context) error {
1272 if dc.networkName == "" {
1273 return nil
1274 }
1275
1276 network := dc.user.getNetwork(dc.networkName)
1277 if network == nil {
1278 addr := dc.networkName
1279 if !strings.ContainsRune(addr, ':') {
1280 addr = addr + ":6697"
1281 }
1282
1283 dc.logger.Printf("trying to connect to new network %q", addr)
1284 if err := sanityCheckServer(ctx, addr); err != nil {
1285 dc.logger.Printf("failed to connect to %q: %v", addr, err)
1286 return ircError{&irc.Message{
1287 Command: irc.ERR_PASSWDMISMATCH,
1288 Params: []string{dc.nick, fmt.Sprintf("Failed to connect to %q", dc.networkName)},
1289 }}
1290 }
1291
1292 // Some clients only allow specifying the nickname (and use the
1293 // nickname as a username too). Strip the network name from the
1294 // nickname when auto-saving networks.
1295 nick, _, _ := unmarshalUsername(dc.nick)
1296
1297 dc.logger.Printf("auto-saving network %q", dc.networkName)
1298 var err error
1299 network, err = dc.user.createNetwork(ctx, &Network{
1300 Addr: dc.networkName,
1301 Nick: nick,
1302 Enabled: true,
1303 })
1304 if err != nil {
1305 return err
1306 }
1307 }
1308
1309 dc.network = network
1310 return nil
1311}
1312
1313func (dc *downstreamConn) welcome(ctx context.Context) error {
1314 if dc.user == nil || !dc.registered {
1315 panic("tried to welcome an unregistered connection")
1316 }
1317
1318 remoteAddr := dc.conn.RemoteAddr().String()
1319 dc.logger = &prefixLogger{dc.srv.Logger, fmt.Sprintf("user %q: downstream %q: ", dc.user.Username, remoteAddr)}
1320
1321 // TODO: doing this might take some time. We should do it in dc.register
1322 // instead, but we'll potentially be adding a new network and this must be
1323 // done in the user goroutine.
1324 if err := dc.loadNetwork(ctx); err != nil {
1325 return err
1326 }
1327
1328 if dc.network == nil && !dc.caps["soju.im/bouncer-networks"] && dc.srv.Config().MultiUpstream {
1329 dc.isMultiUpstream = true
1330 }
1331
1332 dc.updateSupportedCaps()
1333
1334 isupport := []string{
1335 fmt.Sprintf("CHATHISTORY=%v", chatHistoryLimit),
1336 "CASEMAPPING=ascii",
1337 }
1338
1339 if dc.network != nil {
1340 isupport = append(isupport, fmt.Sprintf("BOUNCER_NETID=%v", dc.network.ID))
1341 }
1342 if title := dc.srv.Config().Title; dc.network == nil && title != "" {
1343 isupport = append(isupport, "NETWORK="+encodeISUPPORT(title))
1344 }
1345 if dc.network == nil && !dc.isMultiUpstream {
1346 isupport = append(isupport, "WHOX")
1347 }
1348
1349 if uc := dc.upstream(); uc != nil {
1350 for k := range passthroughIsupport {
1351 v, ok := uc.isupport[k]
1352 if !ok {
1353 continue
1354 }
1355 if v != nil {
1356 isupport = append(isupport, fmt.Sprintf("%v=%v", k, *v))
1357 } else {
1358 isupport = append(isupport, k)
1359 }
1360 }
1361 }
1362
1363 dc.SendMessage(&irc.Message{
1364 Prefix: dc.srv.prefix(),
1365 Command: irc.RPL_WELCOME,
1366 Params: []string{dc.nick, "Welcome to soju, " + dc.nick},
1367 })
1368 dc.SendMessage(&irc.Message{
1369 Prefix: dc.srv.prefix(),
1370 Command: irc.RPL_YOURHOST,
1371 Params: []string{dc.nick, "Your host is " + dc.srv.Config().Hostname},
1372 })
1373 dc.SendMessage(&irc.Message{
1374 Prefix: dc.srv.prefix(),
1375 Command: irc.RPL_MYINFO,
1376 Params: []string{dc.nick, dc.srv.Config().Hostname, "soju", "aiwroO", "OovaimnqpsrtklbeI"},
1377 })
1378 for _, msg := range generateIsupport(dc.srv.prefix(), dc.nick, isupport) {
1379 dc.SendMessage(msg)
1380 }
1381 if uc := dc.upstream(); uc != nil {
1382 dc.SendMessage(&irc.Message{
1383 Prefix: dc.srv.prefix(),
1384 Command: irc.RPL_UMODEIS,
1385 Params: []string{dc.nick, "+" + string(uc.modes)},
1386 })
1387 }
1388 if dc.network == nil && !dc.isMultiUpstream && dc.user.Admin {
1389 dc.SendMessage(&irc.Message{
1390 Prefix: dc.srv.prefix(),
1391 Command: irc.RPL_UMODEIS,
1392 Params: []string{dc.nick, "+o"},
1393 })
1394 }
1395
1396 dc.updateNick()
1397 dc.updateRealname()
1398 dc.updateAccount()
1399
1400 if motd := dc.user.srv.Config().MOTD; motd != "" && dc.network == nil {
1401 for _, msg := range generateMOTD(dc.srv.prefix(), dc.nick, motd) {
1402 dc.SendMessage(msg)
1403 }
1404 } else {
1405 motdHint := "No MOTD"
1406 if dc.network != nil {
1407 motdHint = "Use /motd to read the message of the day"
1408 }
1409 dc.SendMessage(&irc.Message{
1410 Prefix: dc.srv.prefix(),
1411 Command: irc.ERR_NOMOTD,
1412 Params: []string{dc.nick, motdHint},
1413 })
1414 }
1415
1416 if dc.caps["soju.im/bouncer-networks-notify"] {
1417 dc.SendBatch("soju.im/bouncer-networks", nil, nil, func(batchRef irc.TagValue) {
1418 dc.user.forEachNetwork(func(network *network) {
1419 idStr := fmt.Sprintf("%v", network.ID)
1420 attrs := getNetworkAttrs(network)
1421 dc.SendMessage(&irc.Message{
1422 Tags: irc.Tags{"batch": batchRef},
1423 Prefix: dc.srv.prefix(),
1424 Command: "BOUNCER",
1425 Params: []string{"NETWORK", idStr, attrs.String()},
1426 })
1427 })
1428 })
1429 }
1430
1431 dc.forEachUpstream(func(uc *upstreamConn) {
1432 for _, entry := range uc.channels.innerMap {
1433 ch := entry.value.(*upstreamChannel)
1434 if !ch.complete {
1435 continue
1436 }
1437 record := uc.network.channels.Value(ch.Name)
1438 if record != nil && record.Detached {
1439 continue
1440 }
1441
1442 dc.SendMessage(&irc.Message{
1443 Prefix: dc.prefix(),
1444 Command: "JOIN",
1445 Params: []string{dc.marshalEntity(ch.conn.network, ch.Name)},
1446 })
1447
1448 forwardChannel(dc, ch)
1449 }
1450 })
1451
1452 dc.forEachNetwork(func(net *network) {
1453 if dc.caps["draft/chathistory"] || dc.user.msgStore == nil {
1454 return
1455 }
1456
1457 // Only send history if we're the first connected client with that name
1458 // for the network
1459 firstClient := true
1460 dc.user.forEachDownstream(func(c *downstreamConn) {
1461 if c != dc && c.clientName == dc.clientName && c.network == dc.network {
1462 firstClient = false
1463 }
1464 })
1465 if firstClient {
1466 net.delivered.ForEachTarget(func(target string) {
1467 lastDelivered := net.delivered.LoadID(target, dc.clientName)
1468 if lastDelivered == "" {
1469 return
1470 }
1471
1472 dc.sendTargetBacklog(ctx, net, target, lastDelivered)
1473
1474 // Fast-forward history to last message
1475 targetCM := net.casemap(target)
1476 lastID, err := dc.user.msgStore.LastMsgID(&net.Network, targetCM, time.Now())
1477 if err != nil {
1478 dc.logger.Printf("failed to get last message ID: %v", err)
1479 return
1480 }
1481 net.delivered.StoreID(target, dc.clientName, lastID)
1482 })
1483 }
1484 })
1485
1486 return nil
1487}
1488
1489// messageSupportsBacklog checks whether the provided message can be sent as
1490// part of an history batch.
1491func (dc *downstreamConn) messageSupportsBacklog(msg *irc.Message) bool {
1492 // Don't replay all messages, because that would mess up client
1493 // state. For instance we just sent the list of users, sending
1494 // PART messages for one of these users would be incorrect.
1495 switch msg.Command {
1496 case "PRIVMSG", "NOTICE":
1497 return true
1498 }
1499 return false
1500}
1501
1502func (dc *downstreamConn) sendTargetBacklog(ctx context.Context, net *network, target, msgID string) {
1503 if dc.caps["draft/chathistory"] || dc.user.msgStore == nil {
1504 return
1505 }
1506
1507 ch := net.channels.Value(target)
1508
1509 ctx, cancel := context.WithTimeout(ctx, backlogTimeout)
1510 defer cancel()
1511
1512 targetCM := net.casemap(target)
1513 history, err := dc.user.msgStore.LoadLatestID(ctx, &net.Network, targetCM, msgID, backlogLimit)
1514 if err != nil {
1515 dc.logger.Printf("failed to send backlog for %q: %v", target, err)
1516 return
1517 }
1518
1519 dc.SendBatch("chathistory", []string{dc.marshalEntity(net, target)}, nil, func(batchRef irc.TagValue) {
1520 for _, msg := range history {
1521 if ch != nil && ch.Detached {
1522 if net.detachedMessageNeedsRelay(ch, msg) {
1523 dc.relayDetachedMessage(net, msg)
1524 }
1525 } else {
1526 msg.Tags["batch"] = batchRef
1527 dc.SendMessage(dc.marshalMessage(msg, net))
1528 }
1529 }
1530 })
1531}
1532
1533func (dc *downstreamConn) relayDetachedMessage(net *network, msg *irc.Message) {
1534 if msg.Command != "PRIVMSG" && msg.Command != "NOTICE" {
1535 return
1536 }
1537
1538 sender := msg.Prefix.Name
1539 target, text := msg.Params[0], msg.Params[1]
1540 if net.isHighlight(msg) {
1541 sendServiceNOTICE(dc, fmt.Sprintf("highlight in %v: <%v> %v", dc.marshalEntity(net, target), sender, text))
1542 } else {
1543 sendServiceNOTICE(dc, fmt.Sprintf("message in %v: <%v> %v", dc.marshalEntity(net, target), sender, text))
1544 }
1545}
1546
1547func (dc *downstreamConn) runUntilRegistered() error {
1548 ctx, cancel := context.WithTimeout(context.TODO(), downstreamRegisterTimeout)
1549 defer cancel()
1550
1551 // Close the connection with an error if the deadline is exceeded
1552 go func() {
1553 <-ctx.Done()
1554 if err := ctx.Err(); err == context.DeadlineExceeded {
1555 dc.SendMessage(&irc.Message{
1556 Prefix: dc.srv.prefix(),
1557 Command: "ERROR",
1558 Params: []string{"Connection registration timed out"},
1559 })
1560 dc.Close()
1561 }
1562 }()
1563
1564 for !dc.registered {
1565 msg, err := dc.ReadMessage()
1566 if err != nil {
1567 return fmt.Errorf("failed to read IRC command: %w", err)
1568 }
1569
1570 err = dc.handleMessage(ctx, msg)
1571 if ircErr, ok := err.(ircError); ok {
1572 ircErr.Message.Prefix = dc.srv.prefix()
1573 dc.SendMessage(ircErr.Message)
1574 } else if err != nil {
1575 return fmt.Errorf("failed to handle IRC command %q: %v", msg, err)
1576 }
1577 }
1578
1579 return nil
1580}
1581
1582func (dc *downstreamConn) handleMessageRegistered(ctx context.Context, msg *irc.Message) error {
1583 switch msg.Command {
1584 case "CAP":
1585 var subCmd string
1586 if err := parseMessageParams(msg, &subCmd); err != nil {
1587 return err
1588 }
1589 if err := dc.handleCapCommand(subCmd, msg.Params[1:]); err != nil {
1590 return err
1591 }
1592 case "PING":
1593 var source, destination string
1594 if err := parseMessageParams(msg, &source); err != nil {
1595 return err
1596 }
1597 if len(msg.Params) > 1 {
1598 destination = msg.Params[1]
1599 }
1600 hostname := dc.srv.Config().Hostname
1601 if destination != "" && destination != hostname {
1602 return ircError{&irc.Message{
1603 Command: irc.ERR_NOSUCHSERVER,
1604 Params: []string{dc.nick, destination, "No such server"},
1605 }}
1606 }
1607 dc.SendMessage(&irc.Message{
1608 Prefix: dc.srv.prefix(),
1609 Command: "PONG",
1610 Params: []string{hostname, source},
1611 })
1612 return nil
1613 case "PONG":
1614 if len(msg.Params) == 0 {
1615 return newNeedMoreParamsError(msg.Command)
1616 }
1617 token := msg.Params[len(msg.Params)-1]
1618 dc.handlePong(token)
1619 case "USER":
1620 return ircError{&irc.Message{
1621 Command: irc.ERR_ALREADYREGISTERED,
1622 Params: []string{dc.nick, "You may not reregister"},
1623 }}
1624 case "NICK":
1625 var rawNick string
1626 if err := parseMessageParams(msg, &rawNick); err != nil {
1627 return err
1628 }
1629
1630 nick := rawNick
1631 var upstream *upstreamConn
1632 if dc.upstream() == nil {
1633 uc, unmarshaledNick, err := dc.unmarshalEntity(nick)
1634 if err == nil { // NICK nick/network: NICK only on a specific upstream
1635 upstream = uc
1636 nick = unmarshaledNick
1637 }
1638 }
1639
1640 if nick == "" || strings.ContainsAny(nick, illegalNickChars) {
1641 return ircError{&irc.Message{
1642 Command: irc.ERR_ERRONEUSNICKNAME,
1643 Params: []string{dc.nick, rawNick, "contains illegal characters"},
1644 }}
1645 }
1646 if casemapASCII(nick) == serviceNickCM {
1647 return ircError{&irc.Message{
1648 Command: irc.ERR_NICKNAMEINUSE,
1649 Params: []string{dc.nick, rawNick, "Nickname reserved for bouncer service"},
1650 }}
1651 }
1652
1653 var err error
1654 dc.forEachNetwork(func(n *network) {
1655 if err != nil || (upstream != nil && upstream.network != n) {
1656 return
1657 }
1658 n.Nick = nick
1659 err = dc.srv.db.StoreNetwork(ctx, dc.user.ID, &n.Network)
1660 })
1661 if err != nil {
1662 return err
1663 }
1664
1665 dc.forEachUpstream(func(uc *upstreamConn) {
1666 if upstream != nil && upstream != uc {
1667 return
1668 }
1669 uc.SendMessageLabeled(dc.id, &irc.Message{
1670 Command: "NICK",
1671 Params: []string{nick},
1672 })
1673 })
1674
1675 if dc.upstream() == nil && upstream == nil && dc.nick != nick {
1676 dc.SendMessage(&irc.Message{
1677 Prefix: dc.prefix(),
1678 Command: "NICK",
1679 Params: []string{nick},
1680 })
1681 dc.nick = nick
1682 dc.nickCM = casemapASCII(dc.nick)
1683 }
1684 case "SETNAME":
1685 var realname string
1686 if err := parseMessageParams(msg, &realname); err != nil {
1687 return err
1688 }
1689
1690 // If the client just resets to the default, just wipe the per-network
1691 // preference
1692 storeRealname := realname
1693 if realname == dc.user.Realname {
1694 storeRealname = ""
1695 }
1696
1697 var storeErr error
1698 var needUpdate []Network
1699 dc.forEachNetwork(func(n *network) {
1700 // We only need to call updateNetwork for upstreams that don't
1701 // support setname
1702 if uc := n.conn; uc != nil && uc.caps["setname"] {
1703 uc.SendMessageLabeled(dc.id, &irc.Message{
1704 Command: "SETNAME",
1705 Params: []string{realname},
1706 })
1707
1708 n.Realname = storeRealname
1709 if err := dc.srv.db.StoreNetwork(ctx, dc.user.ID, &n.Network); err != nil {
1710 dc.logger.Printf("failed to store network realname: %v", err)
1711 storeErr = err
1712 }
1713 return
1714 }
1715
1716 record := n.Network // copy network record because we'll mutate it
1717 record.Realname = storeRealname
1718 needUpdate = append(needUpdate, record)
1719 })
1720
1721 // Walk the network list as a second step, because updateNetwork
1722 // mutates the original list
1723 for _, record := range needUpdate {
1724 if _, err := dc.user.updateNetwork(ctx, &record); err != nil {
1725 dc.logger.Printf("failed to update network realname: %v", err)
1726 storeErr = err
1727 }
1728 }
1729 if storeErr != nil {
1730 return ircError{&irc.Message{
1731 Command: "FAIL",
1732 Params: []string{"SETNAME", "CANNOT_CHANGE_REALNAME", "Failed to update realname"},
1733 }}
1734 }
1735
1736 if dc.upstream() == nil {
1737 dc.SendMessage(&irc.Message{
1738 Prefix: dc.prefix(),
1739 Command: "SETNAME",
1740 Params: []string{realname},
1741 })
1742 }
1743 case "JOIN":
1744 var namesStr string
1745 if err := parseMessageParams(msg, &namesStr); err != nil {
1746 return err
1747 }
1748
1749 var keys []string
1750 if len(msg.Params) > 1 {
1751 keys = strings.Split(msg.Params[1], ",")
1752 }
1753
1754 for i, name := range strings.Split(namesStr, ",") {
1755 uc, upstreamName, err := dc.unmarshalEntity(name)
1756 if err != nil {
1757 return err
1758 }
1759
1760 var key string
1761 if len(keys) > i {
1762 key = keys[i]
1763 }
1764
1765 if !uc.isChannel(upstreamName) {
1766 dc.SendMessage(&irc.Message{
1767 Prefix: dc.srv.prefix(),
1768 Command: irc.ERR_NOSUCHCHANNEL,
1769 Params: []string{name, "Not a channel name"},
1770 })
1771 continue
1772 }
1773
1774 params := []string{upstreamName}
1775 if key != "" {
1776 params = append(params, key)
1777 }
1778 uc.SendMessageLabeled(dc.id, &irc.Message{
1779 Command: "JOIN",
1780 Params: params,
1781 })
1782
1783 ch := uc.network.channels.Value(upstreamName)
1784 if ch != nil {
1785 // Don't clear the channel key if there's one set
1786 // TODO: add a way to unset the channel key
1787 if key != "" {
1788 ch.Key = key
1789 }
1790 uc.network.attach(ch)
1791 } else {
1792 ch = &Channel{
1793 Name: upstreamName,
1794 Key: key,
1795 }
1796 uc.network.channels.SetValue(upstreamName, ch)
1797 }
1798 if err := dc.srv.db.StoreChannel(ctx, uc.network.ID, ch); err != nil {
1799 dc.logger.Printf("failed to create or update channel %q: %v", upstreamName, err)
1800 }
1801 }
1802 case "PART":
1803 var namesStr string
1804 if err := parseMessageParams(msg, &namesStr); err != nil {
1805 return err
1806 }
1807
1808 var reason string
1809 if len(msg.Params) > 1 {
1810 reason = msg.Params[1]
1811 }
1812
1813 for _, name := range strings.Split(namesStr, ",") {
1814 uc, upstreamName, err := dc.unmarshalEntity(name)
1815 if err != nil {
1816 return err
1817 }
1818
1819 if strings.EqualFold(reason, "detach") {
1820 ch := uc.network.channels.Value(upstreamName)
1821 if ch != nil {
1822 uc.network.detach(ch)
1823 } else {
1824 ch = &Channel{
1825 Name: name,
1826 Detached: true,
1827 }
1828 uc.network.channels.SetValue(upstreamName, ch)
1829 }
1830 if err := dc.srv.db.StoreChannel(ctx, uc.network.ID, ch); err != nil {
1831 dc.logger.Printf("failed to create or update channel %q: %v", upstreamName, err)
1832 }
1833 } else {
1834 params := []string{upstreamName}
1835 if reason != "" {
1836 params = append(params, reason)
1837 }
1838 uc.SendMessageLabeled(dc.id, &irc.Message{
1839 Command: "PART",
1840 Params: params,
1841 })
1842
1843 if err := uc.network.deleteChannel(ctx, upstreamName); err != nil {
1844 dc.logger.Printf("failed to delete channel %q: %v", upstreamName, err)
1845 }
1846 }
1847 }
1848 case "KICK":
1849 var channelStr, userStr string
1850 if err := parseMessageParams(msg, &channelStr, &userStr); err != nil {
1851 return err
1852 }
1853
1854 channels := strings.Split(channelStr, ",")
1855 users := strings.Split(userStr, ",")
1856
1857 var reason string
1858 if len(msg.Params) > 2 {
1859 reason = msg.Params[2]
1860 }
1861
1862 if len(channels) != 1 && len(channels) != len(users) {
1863 return ircError{&irc.Message{
1864 Command: irc.ERR_BADCHANMASK,
1865 Params: []string{dc.nick, channelStr, "Bad channel mask"},
1866 }}
1867 }
1868
1869 for i, user := range users {
1870 var channel string
1871 if len(channels) == 1 {
1872 channel = channels[0]
1873 } else {
1874 channel = channels[i]
1875 }
1876
1877 ucChannel, upstreamChannel, err := dc.unmarshalEntity(channel)
1878 if err != nil {
1879 return err
1880 }
1881
1882 ucUser, upstreamUser, err := dc.unmarshalEntity(user)
1883 if err != nil {
1884 return err
1885 }
1886
1887 if ucChannel != ucUser {
1888 return ircError{&irc.Message{
1889 Command: irc.ERR_USERNOTINCHANNEL,
1890 Params: []string{dc.nick, user, channel, "They are on another network"},
1891 }}
1892 }
1893 uc := ucChannel
1894
1895 params := []string{upstreamChannel, upstreamUser}
1896 if reason != "" {
1897 params = append(params, reason)
1898 }
1899 uc.SendMessageLabeled(dc.id, &irc.Message{
1900 Command: "KICK",
1901 Params: params,
1902 })
1903 }
1904 case "MODE":
1905 var name string
1906 if err := parseMessageParams(msg, &name); err != nil {
1907 return err
1908 }
1909
1910 var modeStr string
1911 if len(msg.Params) > 1 {
1912 modeStr = msg.Params[1]
1913 }
1914
1915 if casemapASCII(name) == dc.nickCM {
1916 if modeStr != "" {
1917 if uc := dc.upstream(); uc != nil {
1918 uc.SendMessageLabeled(dc.id, &irc.Message{
1919 Command: "MODE",
1920 Params: []string{uc.nick, modeStr},
1921 })
1922 } else {
1923 dc.SendMessage(&irc.Message{
1924 Prefix: dc.srv.prefix(),
1925 Command: irc.ERR_UMODEUNKNOWNFLAG,
1926 Params: []string{dc.nick, "Cannot change user mode in multi-upstream mode"},
1927 })
1928 }
1929 } else {
1930 var userMode string
1931 if uc := dc.upstream(); uc != nil {
1932 userMode = string(uc.modes)
1933 }
1934
1935 dc.SendMessage(&irc.Message{
1936 Prefix: dc.srv.prefix(),
1937 Command: irc.RPL_UMODEIS,
1938 Params: []string{dc.nick, "+" + userMode},
1939 })
1940 }
1941 return nil
1942 }
1943
1944 uc, upstreamName, err := dc.unmarshalEntity(name)
1945 if err != nil {
1946 return err
1947 }
1948
1949 if !uc.isChannel(upstreamName) {
1950 return ircError{&irc.Message{
1951 Command: irc.ERR_USERSDONTMATCH,
1952 Params: []string{dc.nick, "Cannot change mode for other users"},
1953 }}
1954 }
1955
1956 if modeStr != "" {
1957 params := []string{upstreamName, modeStr}
1958 params = append(params, msg.Params[2:]...)
1959 uc.SendMessageLabeled(dc.id, &irc.Message{
1960 Command: "MODE",
1961 Params: params,
1962 })
1963 } else {
1964 ch := uc.channels.Value(upstreamName)
1965 if ch == nil {
1966 return ircError{&irc.Message{
1967 Command: irc.ERR_NOSUCHCHANNEL,
1968 Params: []string{dc.nick, name, "No such channel"},
1969 }}
1970 }
1971
1972 if ch.modes == nil {
1973 // we haven't received the initial RPL_CHANNELMODEIS yet
1974 // ignore the request, we will broadcast the modes later when we receive RPL_CHANNELMODEIS
1975 return nil
1976 }
1977
1978 modeStr, modeParams := ch.modes.Format()
1979 params := []string{dc.nick, name, modeStr}
1980 params = append(params, modeParams...)
1981
1982 dc.SendMessage(&irc.Message{
1983 Prefix: dc.srv.prefix(),
1984 Command: irc.RPL_CHANNELMODEIS,
1985 Params: params,
1986 })
1987 if ch.creationTime != "" {
1988 dc.SendMessage(&irc.Message{
1989 Prefix: dc.srv.prefix(),
1990 Command: rpl_creationtime,
1991 Params: []string{dc.nick, name, ch.creationTime},
1992 })
1993 }
1994 }
1995 case "TOPIC":
1996 var channel string
1997 if err := parseMessageParams(msg, &channel); err != nil {
1998 return err
1999 }
2000
2001 uc, upstreamName, err := dc.unmarshalEntity(channel)
2002 if err != nil {
2003 return err
2004 }
2005
2006 if len(msg.Params) > 1 { // setting topic
2007 topic := msg.Params[1]
2008 uc.SendMessageLabeled(dc.id, &irc.Message{
2009 Command: "TOPIC",
2010 Params: []string{upstreamName, topic},
2011 })
2012 } else { // getting topic
2013 ch := uc.channels.Value(upstreamName)
2014 if ch == nil {
2015 return ircError{&irc.Message{
2016 Command: irc.ERR_NOSUCHCHANNEL,
2017 Params: []string{dc.nick, upstreamName, "No such channel"},
2018 }}
2019 }
2020 sendTopic(dc, ch)
2021 }
2022 case "LIST":
2023 network := dc.network
2024 if network == nil && len(msg.Params) > 0 {
2025 var err error
2026 network, msg.Params[0], err = dc.unmarshalEntityNetwork(msg.Params[0])
2027 if err != nil {
2028 return err
2029 }
2030 }
2031 if network == nil {
2032 dc.SendMessage(&irc.Message{
2033 Prefix: dc.srv.prefix(),
2034 Command: irc.RPL_LISTEND,
2035 Params: []string{dc.nick, "LIST without a network suffix is not supported in multi-upstream mode"},
2036 })
2037 return nil
2038 }
2039
2040 uc := network.conn
2041 if uc == nil {
2042 dc.SendMessage(&irc.Message{
2043 Prefix: dc.srv.prefix(),
2044 Command: irc.RPL_LISTEND,
2045 Params: []string{dc.nick, "Disconnected from upstream server"},
2046 })
2047 return nil
2048 }
2049
2050 uc.enqueueCommand(dc, msg)
2051 case "NAMES":
2052 if len(msg.Params) == 0 {
2053 dc.SendMessage(&irc.Message{
2054 Prefix: dc.srv.prefix(),
2055 Command: irc.RPL_ENDOFNAMES,
2056 Params: []string{dc.nick, "*", "End of /NAMES list"},
2057 })
2058 return nil
2059 }
2060
2061 channels := strings.Split(msg.Params[0], ",")
2062 for _, channel := range channels {
2063 uc, upstreamName, err := dc.unmarshalEntity(channel)
2064 if err != nil {
2065 return err
2066 }
2067
2068 ch := uc.channels.Value(upstreamName)
2069 if ch != nil {
2070 sendNames(dc, ch)
2071 } else {
2072 // NAMES on a channel we have not joined, ask upstream
2073 uc.SendMessageLabeled(dc.id, &irc.Message{
2074 Command: "NAMES",
2075 Params: []string{upstreamName},
2076 })
2077 }
2078 }
2079 // For WHOX docs, see:
2080 // - http://faerion.sourceforge.net/doc/irc/whox.var
2081 // - https://github.com/quakenet/snircd/blob/master/doc/readme.who
2082 // Note, many features aren't widely implemented, such as flags and mask2
2083 case "WHO":
2084 if len(msg.Params) == 0 {
2085 // TODO: support WHO without parameters
2086 dc.SendMessage(&irc.Message{
2087 Prefix: dc.srv.prefix(),
2088 Command: irc.RPL_ENDOFWHO,
2089 Params: []string{dc.nick, "*", "End of /WHO list"},
2090 })
2091 return nil
2092 }
2093
2094 // Clients will use the first mask to match RPL_ENDOFWHO
2095 endOfWhoToken := msg.Params[0]
2096
2097 // TODO: add support for WHOX mask2
2098 mask := msg.Params[0]
2099 var options string
2100 if len(msg.Params) > 1 {
2101 options = msg.Params[1]
2102 }
2103
2104 optionsParts := strings.SplitN(options, "%", 2)
2105 // TODO: add support for WHOX flags in optionsParts[0]
2106 var fields, whoxToken string
2107 if len(optionsParts) == 2 {
2108 optionsParts := strings.SplitN(optionsParts[1], ",", 2)
2109 fields = strings.ToLower(optionsParts[0])
2110 if len(optionsParts) == 2 && strings.Contains(fields, "t") {
2111 whoxToken = optionsParts[1]
2112 }
2113 }
2114
2115 // TODO: support mixed bouncer/upstream WHO queries
2116 maskCM := casemapASCII(mask)
2117 if dc.network == nil && maskCM == dc.nickCM {
2118 // TODO: support AWAY (H/G) in self WHO reply
2119 flags := "H"
2120 if dc.user.Admin {
2121 flags += "*"
2122 }
2123 info := whoxInfo{
2124 Token: whoxToken,
2125 Username: dc.user.Username,
2126 Hostname: dc.hostname,
2127 Server: dc.srv.Config().Hostname,
2128 Nickname: dc.nick,
2129 Flags: flags,
2130 Account: dc.user.Username,
2131 Realname: dc.realname,
2132 }
2133 dc.SendMessage(generateWHOXReply(dc.srv.prefix(), dc.nick, fields, &info))
2134 dc.SendMessage(&irc.Message{
2135 Prefix: dc.srv.prefix(),
2136 Command: irc.RPL_ENDOFWHO,
2137 Params: []string{dc.nick, endOfWhoToken, "End of /WHO list"},
2138 })
2139 return nil
2140 }
2141 if maskCM == serviceNickCM {
2142 info := whoxInfo{
2143 Token: whoxToken,
2144 Username: servicePrefix.User,
2145 Hostname: servicePrefix.Host,
2146 Server: dc.srv.Config().Hostname,
2147 Nickname: serviceNick,
2148 Flags: "H*",
2149 Account: serviceNick,
2150 Realname: serviceRealname,
2151 }
2152 dc.SendMessage(generateWHOXReply(dc.srv.prefix(), dc.nick, fields, &info))
2153 dc.SendMessage(&irc.Message{
2154 Prefix: dc.srv.prefix(),
2155 Command: irc.RPL_ENDOFWHO,
2156 Params: []string{dc.nick, endOfWhoToken, "End of /WHO list"},
2157 })
2158 return nil
2159 }
2160
2161 // TODO: properly support WHO masks
2162 uc, upstreamMask, err := dc.unmarshalEntity(mask)
2163 if err != nil {
2164 return err
2165 }
2166
2167 params := []string{upstreamMask}
2168 if options != "" {
2169 params = append(params, options)
2170 }
2171
2172 uc.enqueueCommand(dc, &irc.Message{
2173 Command: "WHO",
2174 Params: params,
2175 })
2176 case "WHOIS":
2177 if len(msg.Params) == 0 {
2178 return ircError{&irc.Message{
2179 Command: irc.ERR_NONICKNAMEGIVEN,
2180 Params: []string{dc.nick, "No nickname given"},
2181 }}
2182 }
2183
2184 var target, mask string
2185 if len(msg.Params) == 1 {
2186 target = ""
2187 mask = msg.Params[0]
2188 } else {
2189 target = msg.Params[0]
2190 mask = msg.Params[1]
2191 }
2192 // TODO: support multiple WHOIS users
2193 if i := strings.IndexByte(mask, ','); i >= 0 {
2194 mask = mask[:i]
2195 }
2196
2197 if dc.network == nil && casemapASCII(mask) == dc.nickCM {
2198 dc.SendMessage(&irc.Message{
2199 Prefix: dc.srv.prefix(),
2200 Command: irc.RPL_WHOISUSER,
2201 Params: []string{dc.nick, dc.nick, dc.user.Username, dc.hostname, "*", dc.realname},
2202 })
2203 dc.SendMessage(&irc.Message{
2204 Prefix: dc.srv.prefix(),
2205 Command: irc.RPL_WHOISSERVER,
2206 Params: []string{dc.nick, dc.nick, dc.srv.Config().Hostname, "soju"},
2207 })
2208 if dc.user.Admin {
2209 dc.SendMessage(&irc.Message{
2210 Prefix: dc.srv.prefix(),
2211 Command: irc.RPL_WHOISOPERATOR,
2212 Params: []string{dc.nick, dc.nick, "is a bouncer administrator"},
2213 })
2214 }
2215 dc.SendMessage(&irc.Message{
2216 Prefix: dc.srv.prefix(),
2217 Command: rpl_whoisaccount,
2218 Params: []string{dc.nick, dc.nick, dc.user.Username, "is logged in as"},
2219 })
2220 dc.SendMessage(&irc.Message{
2221 Prefix: dc.srv.prefix(),
2222 Command: irc.RPL_ENDOFWHOIS,
2223 Params: []string{dc.nick, dc.nick, "End of /WHOIS list"},
2224 })
2225 return nil
2226 }
2227 if casemapASCII(mask) == serviceNickCM {
2228 dc.SendMessage(&irc.Message{
2229 Prefix: dc.srv.prefix(),
2230 Command: irc.RPL_WHOISUSER,
2231 Params: []string{dc.nick, serviceNick, servicePrefix.User, servicePrefix.Host, "*", serviceRealname},
2232 })
2233 dc.SendMessage(&irc.Message{
2234 Prefix: dc.srv.prefix(),
2235 Command: irc.RPL_WHOISSERVER,
2236 Params: []string{dc.nick, serviceNick, dc.srv.Config().Hostname, "soju"},
2237 })
2238 dc.SendMessage(&irc.Message{
2239 Prefix: dc.srv.prefix(),
2240 Command: irc.RPL_WHOISOPERATOR,
2241 Params: []string{dc.nick, serviceNick, "is the bouncer service"},
2242 })
2243 dc.SendMessage(&irc.Message{
2244 Prefix: dc.srv.prefix(),
2245 Command: rpl_whoisaccount,
2246 Params: []string{dc.nick, serviceNick, serviceNick, "is logged in as"},
2247 })
2248 dc.SendMessage(&irc.Message{
2249 Prefix: dc.srv.prefix(),
2250 Command: irc.RPL_ENDOFWHOIS,
2251 Params: []string{dc.nick, serviceNick, "End of /WHOIS list"},
2252 })
2253 return nil
2254 }
2255
2256 // TODO: support WHOIS masks
2257 uc, upstreamNick, err := dc.unmarshalEntity(mask)
2258 if err != nil {
2259 return err
2260 }
2261
2262 var params []string
2263 if target != "" {
2264 if target == mask { // WHOIS nick nick
2265 params = []string{upstreamNick, upstreamNick}
2266 } else {
2267 params = []string{target, upstreamNick}
2268 }
2269 } else {
2270 params = []string{upstreamNick}
2271 }
2272
2273 uc.SendMessageLabeled(dc.id, &irc.Message{
2274 Command: "WHOIS",
2275 Params: params,
2276 })
2277 case "PRIVMSG", "NOTICE":
2278 var targetsStr, text string
2279 if err := parseMessageParams(msg, &targetsStr, &text); err != nil {
2280 return err
2281 }
2282 tags := copyClientTags(msg.Tags)
2283
2284 for _, name := range strings.Split(targetsStr, ",") {
2285 if name == "$"+dc.srv.Config().Hostname || (name == "$*" && dc.network == nil) {
2286 // "$" means a server mask follows. If it's the bouncer's
2287 // hostname, broadcast the message to all bouncer users.
2288 if !dc.user.Admin {
2289 return ircError{&irc.Message{
2290 Prefix: dc.srv.prefix(),
2291 Command: irc.ERR_BADMASK,
2292 Params: []string{dc.nick, name, "Permission denied to broadcast message to all bouncer users"},
2293 }}
2294 }
2295
2296 dc.logger.Printf("broadcasting bouncer-wide %v: %v", msg.Command, text)
2297
2298 broadcastTags := tags.Copy()
2299 broadcastTags["time"] = irc.TagValue(time.Now().UTC().Format(serverTimeLayout))
2300 broadcastMsg := &irc.Message{
2301 Tags: broadcastTags,
2302 Prefix: servicePrefix,
2303 Command: msg.Command,
2304 Params: []string{name, text},
2305 }
2306 dc.srv.forEachUser(func(u *user) {
2307 u.events <- eventBroadcast{broadcastMsg}
2308 })
2309 continue
2310 }
2311
2312 if dc.network == nil && casemapASCII(name) == dc.nickCM {
2313 dc.SendMessage(&irc.Message{
2314 Tags: msg.Tags.Copy(),
2315 Prefix: dc.prefix(),
2316 Command: msg.Command,
2317 Params: []string{name, text},
2318 })
2319 continue
2320 }
2321
2322 if msg.Command == "PRIVMSG" && casemapASCII(name) == serviceNickCM {
2323 if dc.caps["echo-message"] {
2324 echoTags := tags.Copy()
2325 echoTags["time"] = irc.TagValue(time.Now().UTC().Format(serverTimeLayout))
2326 dc.SendMessage(&irc.Message{
2327 Tags: echoTags,
2328 Prefix: dc.prefix(),
2329 Command: msg.Command,
2330 Params: []string{name, text},
2331 })
2332 }
2333 handleServicePRIVMSG(ctx, dc, text)
2334 continue
2335 }
2336
2337 uc, upstreamName, err := dc.unmarshalEntity(name)
2338 if err != nil {
2339 return err
2340 }
2341
2342 if msg.Command == "PRIVMSG" && uc.network.casemap(upstreamName) == "nickserv" {
2343 dc.handleNickServPRIVMSG(ctx, uc, text)
2344 }
2345
2346 unmarshaledText := text
2347 if uc.isChannel(upstreamName) {
2348 unmarshaledText = dc.unmarshalText(uc, text)
2349 }
2350 uc.SendMessageLabeled(dc.id, &irc.Message{
2351 Tags: tags,
2352 Command: msg.Command,
2353 Params: []string{upstreamName, unmarshaledText},
2354 })
2355
2356 echoTags := tags.Copy()
2357 echoTags["time"] = irc.TagValue(time.Now().UTC().Format(serverTimeLayout))
2358 if uc.account != "" {
2359 echoTags["account"] = irc.TagValue(uc.account)
2360 }
2361 echoMsg := &irc.Message{
2362 Tags: echoTags,
2363 Prefix: &irc.Prefix{Name: uc.nick},
2364 Command: msg.Command,
2365 Params: []string{upstreamName, text},
2366 }
2367 uc.produce(upstreamName, echoMsg, dc)
2368
2369 uc.updateChannelAutoDetach(upstreamName)
2370 }
2371 case "TAGMSG":
2372 var targetsStr string
2373 if err := parseMessageParams(msg, &targetsStr); err != nil {
2374 return err
2375 }
2376 tags := copyClientTags(msg.Tags)
2377
2378 for _, name := range strings.Split(targetsStr, ",") {
2379 if dc.network == nil && casemapASCII(name) == dc.nickCM {
2380 dc.SendMessage(&irc.Message{
2381 Tags: msg.Tags.Copy(),
2382 Prefix: dc.prefix(),
2383 Command: "TAGMSG",
2384 Params: []string{name},
2385 })
2386 continue
2387 }
2388
2389 if casemapASCII(name) == serviceNickCM {
2390 continue
2391 }
2392
2393 uc, upstreamName, err := dc.unmarshalEntity(name)
2394 if err != nil {
2395 return err
2396 }
2397 if _, ok := uc.caps["message-tags"]; !ok {
2398 continue
2399 }
2400
2401 uc.SendMessageLabeled(dc.id, &irc.Message{
2402 Tags: tags,
2403 Command: "TAGMSG",
2404 Params: []string{upstreamName},
2405 })
2406
2407 uc.updateChannelAutoDetach(upstreamName)
2408 }
2409 case "INVITE":
2410 var user, channel string
2411 if err := parseMessageParams(msg, &user, &channel); err != nil {
2412 return err
2413 }
2414
2415 ucChannel, upstreamChannel, err := dc.unmarshalEntity(channel)
2416 if err != nil {
2417 return err
2418 }
2419
2420 ucUser, upstreamUser, err := dc.unmarshalEntity(user)
2421 if err != nil {
2422 return err
2423 }
2424
2425 if ucChannel != ucUser {
2426 return ircError{&irc.Message{
2427 Command: irc.ERR_USERNOTINCHANNEL,
2428 Params: []string{dc.nick, user, channel, "They are on another network"},
2429 }}
2430 }
2431 uc := ucChannel
2432
2433 uc.SendMessageLabeled(dc.id, &irc.Message{
2434 Command: "INVITE",
2435 Params: []string{upstreamUser, upstreamChannel},
2436 })
2437 case "AUTHENTICATE":
2438 // Post-connection-registration AUTHENTICATE is unsupported in
2439 // multi-upstream mode, or if the upstream doesn't support SASL
2440 uc := dc.upstream()
2441 if uc == nil || !uc.caps["sasl"] {
2442 return ircError{&irc.Message{
2443 Command: irc.ERR_SASLFAIL,
2444 Params: []string{dc.nick, "Upstream network authentication not supported"},
2445 }}
2446 }
2447
2448 credentials, err := dc.handleAuthenticateCommand(msg)
2449 if err != nil {
2450 return err
2451 }
2452
2453 if credentials != nil {
2454 if uc.saslClient != nil {
2455 dc.endSASL(&irc.Message{
2456 Prefix: dc.srv.prefix(),
2457 Command: irc.ERR_SASLFAIL,
2458 Params: []string{dc.nick, "Another authentication attempt is already in progress"},
2459 })
2460 return nil
2461 }
2462
2463 uc.logger.Printf("starting post-registration SASL PLAIN authentication with username %q", credentials.plainUsername)
2464 uc.saslClient = sasl.NewPlainClient("", credentials.plainUsername, credentials.plainPassword)
2465 uc.enqueueCommand(dc, &irc.Message{
2466 Command: "AUTHENTICATE",
2467 Params: []string{"PLAIN"},
2468 })
2469 }
2470 case "REGISTER", "VERIFY":
2471 // Check number of params here, since we'll use that to save the
2472 // credentials on command success
2473 if (msg.Command == "REGISTER" && len(msg.Params) < 3) || (msg.Command == "VERIFY" && len(msg.Params) < 2) {
2474 return newNeedMoreParamsError(msg.Command)
2475 }
2476
2477 uc := dc.upstream()
2478 if uc == nil || !uc.caps["draft/account-registration"] {
2479 return ircError{&irc.Message{
2480 Command: "FAIL",
2481 Params: []string{msg.Command, "TEMPORARILY_UNAVAILABLE", "*", "Upstream network account registration not supported"},
2482 }}
2483 }
2484
2485 uc.logger.Printf("starting %v with account name %v", msg.Command, msg.Params[0])
2486 uc.enqueueCommand(dc, msg)
2487 case "MONITOR":
2488 // MONITOR is unsupported in multi-upstream mode
2489 uc := dc.upstream()
2490 if uc == nil {
2491 return newUnknownCommandError(msg.Command)
2492 }
2493 if _, ok := uc.isupport["MONITOR"]; !ok {
2494 return newUnknownCommandError(msg.Command)
2495 }
2496
2497 var subcommand string
2498 if err := parseMessageParams(msg, &subcommand); err != nil {
2499 return err
2500 }
2501
2502 switch strings.ToUpper(subcommand) {
2503 case "+", "-":
2504 var targets string
2505 if err := parseMessageParams(msg, nil, &targets); err != nil {
2506 return err
2507 }
2508 for _, target := range strings.Split(targets, ",") {
2509 if subcommand == "+" {
2510 // Hard limit, just to avoid having downstreams fill our map
2511 if len(dc.monitored.innerMap) >= 1000 {
2512 dc.SendMessage(&irc.Message{
2513 Prefix: dc.srv.prefix(),
2514 Command: irc.ERR_MONLISTFULL,
2515 Params: []string{dc.nick, "1000", target, "Bouncer monitor list is full"},
2516 })
2517 continue
2518 }
2519
2520 dc.monitored.SetValue(target, nil)
2521
2522 if uc.monitored.Has(target) {
2523 cmd := irc.RPL_MONOFFLINE
2524 if online := uc.monitored.Value(target); online {
2525 cmd = irc.RPL_MONONLINE
2526 }
2527
2528 dc.SendMessage(&irc.Message{
2529 Prefix: dc.srv.prefix(),
2530 Command: cmd,
2531 Params: []string{dc.nick, target},
2532 })
2533 }
2534 } else {
2535 dc.monitored.Delete(target)
2536 }
2537 }
2538 uc.updateMonitor()
2539 case "C": // clear
2540 dc.monitored = newCasemapMap(0)
2541 uc.updateMonitor()
2542 case "L": // list
2543 // TODO: be less lazy and pack the list
2544 for _, entry := range dc.monitored.innerMap {
2545 dc.SendMessage(&irc.Message{
2546 Prefix: dc.srv.prefix(),
2547 Command: irc.RPL_MONLIST,
2548 Params: []string{dc.nick, entry.originalKey},
2549 })
2550 }
2551 dc.SendMessage(&irc.Message{
2552 Prefix: dc.srv.prefix(),
2553 Command: irc.RPL_ENDOFMONLIST,
2554 Params: []string{dc.nick, "End of MONITOR list"},
2555 })
2556 case "S": // status
2557 // TODO: be less lazy and pack the lists
2558 for _, entry := range dc.monitored.innerMap {
2559 target := entry.originalKey
2560
2561 cmd := irc.RPL_MONOFFLINE
2562 if online := uc.monitored.Value(target); online {
2563 cmd = irc.RPL_MONONLINE
2564 }
2565
2566 dc.SendMessage(&irc.Message{
2567 Prefix: dc.srv.prefix(),
2568 Command: cmd,
2569 Params: []string{dc.nick, target},
2570 })
2571 }
2572 }
2573 case "CHATHISTORY":
2574 var subcommand string
2575 if err := parseMessageParams(msg, &subcommand); err != nil {
2576 return err
2577 }
2578 var target, limitStr string
2579 var boundsStr [2]string
2580 switch subcommand {
2581 case "AFTER", "BEFORE", "LATEST":
2582 if err := parseMessageParams(msg, nil, &target, &boundsStr[0], &limitStr); err != nil {
2583 return err
2584 }
2585 case "BETWEEN":
2586 if err := parseMessageParams(msg, nil, &target, &boundsStr[0], &boundsStr[1], &limitStr); err != nil {
2587 return err
2588 }
2589 case "TARGETS":
2590 if dc.network == nil {
2591 // Either an unbound bouncer network, in which case we should return no targets,
2592 // or a multi-upstream downstream, but we don't support CHATHISTORY TARGETS for those yet.
2593 dc.SendBatch("draft/chathistory-targets", nil, nil, func(batchRef irc.TagValue) {})
2594 return nil
2595 }
2596 if err := parseMessageParams(msg, nil, &boundsStr[0], &boundsStr[1], &limitStr); err != nil {
2597 return err
2598 }
2599 default:
2600 // TODO: support AROUND
2601 return ircError{&irc.Message{
2602 Command: "FAIL",
2603 Params: []string{"CHATHISTORY", "INVALID_PARAMS", subcommand, "Unknown command"},
2604 }}
2605 }
2606
2607 // We don't save history for our service
2608 if casemapASCII(target) == serviceNickCM {
2609 dc.SendBatch("chathistory", []string{target}, nil, func(batchRef irc.TagValue) {})
2610 return nil
2611 }
2612
2613 store, ok := dc.user.msgStore.(chatHistoryMessageStore)
2614 if !ok {
2615 return ircError{&irc.Message{
2616 Command: irc.ERR_UNKNOWNCOMMAND,
2617 Params: []string{dc.nick, "CHATHISTORY", "Unknown command"},
2618 }}
2619 }
2620
2621 network, entity, err := dc.unmarshalEntityNetwork(target)
2622 if err != nil {
2623 return err
2624 }
2625 entity = network.casemap(entity)
2626
2627 // TODO: support msgid criteria
2628 var bounds [2]time.Time
2629 bounds[0] = parseChatHistoryBound(boundsStr[0])
2630 if subcommand == "LATEST" && boundsStr[0] == "*" {
2631 bounds[0] = time.Now()
2632 } else if bounds[0].IsZero() {
2633 return ircError{&irc.Message{
2634 Command: "FAIL",
2635 Params: []string{"CHATHISTORY", "INVALID_PARAMS", subcommand, boundsStr[0], "Invalid first bound"},
2636 }}
2637 }
2638
2639 if boundsStr[1] != "" {
2640 bounds[1] = parseChatHistoryBound(boundsStr[1])
2641 if bounds[1].IsZero() {
2642 return ircError{&irc.Message{
2643 Command: "FAIL",
2644 Params: []string{"CHATHISTORY", "INVALID_PARAMS", subcommand, boundsStr[1], "Invalid second bound"},
2645 }}
2646 }
2647 }
2648
2649 limit, err := strconv.Atoi(limitStr)
2650 if err != nil || limit < 0 || limit > chatHistoryLimit {
2651 return ircError{&irc.Message{
2652 Command: "FAIL",
2653 Params: []string{"CHATHISTORY", "INVALID_PARAMS", subcommand, limitStr, "Invalid limit"},
2654 }}
2655 }
2656
2657 eventPlayback := dc.caps["draft/event-playback"]
2658
2659 var history []*irc.Message
2660 switch subcommand {
2661 case "BEFORE", "LATEST":
2662 history, err = store.LoadBeforeTime(ctx, &network.Network, entity, bounds[0], time.Time{}, limit, eventPlayback)
2663 case "AFTER":
2664 history, err = store.LoadAfterTime(ctx, &network.Network, entity, bounds[0], time.Now(), limit, eventPlayback)
2665 case "BETWEEN":
2666 if bounds[0].Before(bounds[1]) {
2667 history, err = store.LoadAfterTime(ctx, &network.Network, entity, bounds[0], bounds[1], limit, eventPlayback)
2668 } else {
2669 history, err = store.LoadBeforeTime(ctx, &network.Network, entity, bounds[0], bounds[1], limit, eventPlayback)
2670 }
2671 case "TARGETS":
2672 // TODO: support TARGETS in multi-upstream mode
2673 targets, err := store.ListTargets(ctx, &network.Network, bounds[0], bounds[1], limit, eventPlayback)
2674 if err != nil {
2675 dc.logger.Printf("failed fetching targets for chathistory: %v", err)
2676 return ircError{&irc.Message{
2677 Command: "FAIL",
2678 Params: []string{"CHATHISTORY", "MESSAGE_ERROR", subcommand, "Failed to retrieve targets"},
2679 }}
2680 }
2681
2682 dc.SendBatch("draft/chathistory-targets", nil, nil, func(batchRef irc.TagValue) {
2683 for _, target := range targets {
2684 if ch := network.channels.Value(target.Name); ch != nil && ch.Detached {
2685 continue
2686 }
2687
2688 dc.SendMessage(&irc.Message{
2689 Tags: irc.Tags{"batch": batchRef},
2690 Prefix: dc.srv.prefix(),
2691 Command: "CHATHISTORY",
2692 Params: []string{"TARGETS", target.Name, target.LatestMessage.UTC().Format(serverTimeLayout)},
2693 })
2694 }
2695 })
2696
2697 return nil
2698 }
2699 if err != nil {
2700 dc.logger.Printf("failed fetching %q messages for chathistory: %v", target, err)
2701 return newChatHistoryError(subcommand, target)
2702 }
2703
2704 dc.SendBatch("chathistory", []string{target}, nil, func(batchRef irc.TagValue) {
2705 for _, msg := range history {
2706 msg.Tags["batch"] = batchRef
2707 dc.SendMessage(dc.marshalMessage(msg, network))
2708 }
2709 })
2710 case "BOUNCER":
2711 var subcommand string
2712 if err := parseMessageParams(msg, &subcommand); err != nil {
2713 return err
2714 }
2715
2716 switch strings.ToUpper(subcommand) {
2717 case "BIND":
2718 return ircError{&irc.Message{
2719 Command: "FAIL",
2720 Params: []string{"BOUNCER", "REGISTRATION_IS_COMPLETED", "BIND", "Cannot bind to a network after registration"},
2721 }}
2722 case "LISTNETWORKS":
2723 dc.SendBatch("soju.im/bouncer-networks", nil, nil, func(batchRef irc.TagValue) {
2724 dc.user.forEachNetwork(func(network *network) {
2725 idStr := fmt.Sprintf("%v", network.ID)
2726 attrs := getNetworkAttrs(network)
2727 dc.SendMessage(&irc.Message{
2728 Tags: irc.Tags{"batch": batchRef},
2729 Prefix: dc.srv.prefix(),
2730 Command: "BOUNCER",
2731 Params: []string{"NETWORK", idStr, attrs.String()},
2732 })
2733 })
2734 })
2735 case "ADDNETWORK":
2736 var attrsStr string
2737 if err := parseMessageParams(msg, nil, &attrsStr); err != nil {
2738 return err
2739 }
2740 attrs := irc.ParseTags(attrsStr)
2741
2742 record := &Network{Nick: dc.nick, Enabled: true}
2743 if err := updateNetworkAttrs(record, attrs, subcommand); err != nil {
2744 return err
2745 }
2746
2747 if record.Nick == dc.user.Username {
2748 record.Nick = ""
2749 }
2750 if record.Realname == dc.user.Realname {
2751 record.Realname = ""
2752 }
2753
2754 network, err := dc.user.createNetwork(ctx, record)
2755 if err != nil {
2756 return ircError{&irc.Message{
2757 Command: "FAIL",
2758 Params: []string{"BOUNCER", "UNKNOWN_ERROR", subcommand, fmt.Sprintf("Failed to create network: %v", err)},
2759 }}
2760 }
2761
2762 dc.SendMessage(&irc.Message{
2763 Prefix: dc.srv.prefix(),
2764 Command: "BOUNCER",
2765 Params: []string{"ADDNETWORK", fmt.Sprintf("%v", network.ID)},
2766 })
2767 case "CHANGENETWORK":
2768 var idStr, attrsStr string
2769 if err := parseMessageParams(msg, nil, &idStr, &attrsStr); err != nil {
2770 return err
2771 }
2772 id, err := parseBouncerNetID(subcommand, idStr)
2773 if err != nil {
2774 return err
2775 }
2776 attrs := irc.ParseTags(attrsStr)
2777
2778 net := dc.user.getNetworkByID(id)
2779 if net == nil {
2780 return ircError{&irc.Message{
2781 Command: "FAIL",
2782 Params: []string{"BOUNCER", "INVALID_NETID", subcommand, idStr, "Invalid network ID"},
2783 }}
2784 }
2785
2786 record := net.Network // copy network record because we'll mutate it
2787 if err := updateNetworkAttrs(&record, attrs, subcommand); err != nil {
2788 return err
2789 }
2790
2791 if record.Nick == dc.user.Username {
2792 record.Nick = ""
2793 }
2794 if record.Realname == dc.user.Realname {
2795 record.Realname = ""
2796 }
2797
2798 _, err = dc.user.updateNetwork(ctx, &record)
2799 if err != nil {
2800 return ircError{&irc.Message{
2801 Command: "FAIL",
2802 Params: []string{"BOUNCER", "UNKNOWN_ERROR", subcommand, fmt.Sprintf("Failed to update network: %v", err)},
2803 }}
2804 }
2805
2806 dc.SendMessage(&irc.Message{
2807 Prefix: dc.srv.prefix(),
2808 Command: "BOUNCER",
2809 Params: []string{"CHANGENETWORK", idStr},
2810 })
2811 case "DELNETWORK":
2812 var idStr string
2813 if err := parseMessageParams(msg, nil, &idStr); err != nil {
2814 return err
2815 }
2816 id, err := parseBouncerNetID(subcommand, idStr)
2817 if err != nil {
2818 return err
2819 }
2820
2821 net := dc.user.getNetworkByID(id)
2822 if net == nil {
2823 return ircError{&irc.Message{
2824 Command: "FAIL",
2825 Params: []string{"BOUNCER", "INVALID_NETID", subcommand, idStr, "Invalid network ID"},
2826 }}
2827 }
2828
2829 if err := dc.user.deleteNetwork(ctx, net.ID); err != nil {
2830 return err
2831 }
2832
2833 dc.SendMessage(&irc.Message{
2834 Prefix: dc.srv.prefix(),
2835 Command: "BOUNCER",
2836 Params: []string{"DELNETWORK", idStr},
2837 })
2838 default:
2839 return ircError{&irc.Message{
2840 Command: "FAIL",
2841 Params: []string{"BOUNCER", "UNKNOWN_COMMAND", subcommand, "Unknown subcommand"},
2842 }}
2843 }
2844 default:
2845 dc.logger.Printf("unhandled message: %v", msg)
2846
2847 // Only forward unknown commands in single-upstream mode
2848 uc := dc.upstream()
2849 if uc == nil {
2850 return newUnknownCommandError(msg.Command)
2851 }
2852
2853 uc.SendMessageLabeled(dc.id, msg)
2854 }
2855 return nil
2856}
2857
2858func (dc *downstreamConn) handleNickServPRIVMSG(ctx context.Context, uc *upstreamConn, text string) {
2859 username, password, ok := parseNickServCredentials(text, uc.nick)
2860 if ok {
2861 uc.network.autoSaveSASLPlain(ctx, username, password)
2862 }
2863}
2864
2865func parseNickServCredentials(text, nick string) (username, password string, ok bool) {
2866 fields := strings.Fields(text)
2867 if len(fields) < 2 {
2868 return "", "", false
2869 }
2870 cmd := strings.ToUpper(fields[0])
2871 params := fields[1:]
2872 switch cmd {
2873 case "REGISTER":
2874 username = nick
2875 password = params[0]
2876 case "IDENTIFY":
2877 if len(params) == 1 {
2878 username = nick
2879 password = params[0]
2880 } else {
2881 username = params[0]
2882 password = params[1]
2883 }
2884 case "SET":
2885 if len(params) == 2 && strings.EqualFold(params[0], "PASSWORD") {
2886 username = nick
2887 password = params[1]
2888 }
2889 default:
2890 return "", "", false
2891 }
2892 return username, password, true
2893}
Note: See TracBrowser for help on using the repository browser.