source: code/trunk/downstream.go@ 682

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

Add a queue for WHO commands

This has the following upsides:

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