source: code/trunk/downstream.go@ 275

Last change on this file since 275 was 275, checked in by contact, 5 years ago

Add downstream support for cap-notify
File size: 33.5 KB
Line 
1package soju
2
3import (
4 "crypto/tls"
5 "encoding/base64"
6 "fmt"
7 "io"
8 "net"
9 "strconv"
10 "strings"
11 "time"
12
13 "github.com/emersion/go-sasl"
14 "golang.org/x/crypto/bcrypt"
15 "gopkg.in/irc.v3"
16)
17
18type ircError struct {
19 Message *irc.Message
20}
21
22func (err ircError) Error() string {
23 return err.Message.String()
24}
25
26func newUnknownCommandError(cmd string) ircError {
27 return ircError{&irc.Message{
28 Command: irc.ERR_UNKNOWNCOMMAND,
29 Params: []string{
30 "*",
31 cmd,
32 "Unknown command",
33 },
34 }}
35}
36
37func newNeedMoreParamsError(cmd string) ircError {
38 return ircError{&irc.Message{
39 Command: irc.ERR_NEEDMOREPARAMS,
40 Params: []string{
41 "*",
42 cmd,
43 "Not enough parameters",
44 },
45 }}
46}
47
48var errAuthFailed = ircError{&irc.Message{
49 Command: irc.ERR_PASSWDMISMATCH,
50 Params: []string{"*", "Invalid username or password"},
51}}
52
53// permanentDownstreamCaps is the list of always-supported downstream
54// capabilities.
55var permanentDownstreamCaps = map[string]string{
56 "batch": "",
57 "cap-notify": "",
58 "echo-message": "",
59 "message-tags": "",
60 "sasl": "PLAIN",
61 "server-time": "",
62}
63
64type downstreamConn struct {
65 conn
66
67 id uint64
68
69 registered bool
70 user *user
71 nick string
72 rawUsername string
73 networkName string
74 clientName string
75 realname string
76 hostname string
77 password string // empty after authentication
78 network *network // can be nil
79
80 negociatingCaps bool
81 capVersion int
82 supportedCaps map[string]string
83 caps map[string]bool
84
85 saslServer sasl.Server
86}
87
88func newDownstreamConn(srv *Server, netConn net.Conn, id uint64) *downstreamConn {
89 logger := &prefixLogger{srv.Logger, fmt.Sprintf("downstream %q: ", netConn.RemoteAddr())}
90 dc := &downstreamConn{
91 conn: *newConn(srv, netConn, logger),
92 id: id,
93 supportedCaps: make(map[string]string),
94 caps: make(map[string]bool),
95 }
96 dc.hostname = netConn.RemoteAddr().String()
97 if host, _, err := net.SplitHostPort(dc.hostname); err == nil {
98 dc.hostname = host
99 }
100 for k, v := range permanentDownstreamCaps {
101 dc.supportedCaps[k] = v
102 }
103 return dc
104}
105
106func (dc *downstreamConn) prefix() *irc.Prefix {
107 return &irc.Prefix{
108 Name: dc.nick,
109 User: dc.user.Username,
110 Host: dc.hostname,
111 }
112}
113
114func (dc *downstreamConn) forEachNetwork(f func(*network)) {
115 if dc.network != nil {
116 f(dc.network)
117 } else {
118 dc.user.forEachNetwork(f)
119 }
120}
121
122func (dc *downstreamConn) forEachUpstream(f func(*upstreamConn)) {
123 dc.user.forEachUpstream(func(uc *upstreamConn) {
124 if dc.network != nil && uc.network != dc.network {
125 return
126 }
127 f(uc)
128 })
129}
130
131// upstream returns the upstream connection, if any. If there are zero or if
132// there are multiple upstream connections, it returns nil.
133func (dc *downstreamConn) upstream() *upstreamConn {
134 if dc.network == nil {
135 return nil
136 }
137 return dc.network.upstream()
138}
139
140func isOurNick(net *network, nick string) bool {
141 // TODO: this doesn't account for nick changes
142 if net.conn != nil {
143 return nick == net.conn.nick
144 }
145 // We're not currently connected to the upstream connection, so we don't
146 // know whether this name is our nickname. Best-effort: use the network's
147 // configured nickname and hope it was the one being used when we were
148 // connected.
149 return nick == net.Nick
150}
151
152// marshalEntity converts an upstream entity name (ie. channel or nick) into a
153// downstream entity name.
154//
155// This involves adding a "/<network>" suffix if the entity isn't the current
156// user.
157func (dc *downstreamConn) marshalEntity(net *network, name string) string {
158 if dc.network != nil {
159 if dc.network != net {
160 panic("soju: tried to marshal an entity for another network")
161 }
162 return name
163 }
164 if isOurNick(net, name) {
165 return dc.nick
166 }
167 return name + "/" + net.GetName()
168}
169
170func (dc *downstreamConn) marshalUserPrefix(net *network, prefix *irc.Prefix) *irc.Prefix {
171 if isOurNick(net, prefix.Name) {
172 return dc.prefix()
173 }
174 if dc.network != nil {
175 if dc.network != net {
176 panic("soju: tried to marshal a user prefix for another network")
177 }
178 return prefix
179 }
180 return &irc.Prefix{
181 Name: prefix.Name + "/" + net.GetName(),
182 User: prefix.User,
183 Host: prefix.Host,
184 }
185}
186
187// unmarshalEntity converts a downstream entity name (ie. channel or nick) into
188// an upstream entity name.
189//
190// This involves removing the "/<network>" suffix.
191func (dc *downstreamConn) unmarshalEntity(name string) (*upstreamConn, string, error) {
192 if uc := dc.upstream(); uc != nil {
193 return uc, name, nil
194 }
195
196 var conn *upstreamConn
197 if i := strings.LastIndexByte(name, '/'); i >= 0 {
198 network := name[i+1:]
199 name = name[:i]
200
201 dc.forEachUpstream(func(uc *upstreamConn) {
202 if network != uc.network.GetName() {
203 return
204 }
205 conn = uc
206 })
207 }
208
209 if conn == nil {
210 return nil, "", ircError{&irc.Message{
211 Command: irc.ERR_NOSUCHCHANNEL,
212 Params: []string{name, "No such channel"},
213 }}
214 }
215 return conn, name, nil
216}
217
218func (dc *downstreamConn) unmarshalText(uc *upstreamConn, text string) string {
219 if dc.upstream() != nil {
220 return text
221 }
222 // TODO: smarter parsing that ignores URLs
223 return strings.ReplaceAll(text, "/"+uc.network.GetName(), "")
224}
225
226func (dc *downstreamConn) readMessages(ch chan<- event) error {
227 for {
228 msg, err := dc.ReadMessage()
229 if err == io.EOF {
230 break
231 } else if err != nil {
232 return fmt.Errorf("failed to read IRC command: %v", err)
233 }
234
235 ch <- eventDownstreamMessage{msg, dc}
236 }
237
238 return nil
239}
240
241// SendMessage sends an outgoing message.
242//
243// This can only called from the user goroutine.
244func (dc *downstreamConn) SendMessage(msg *irc.Message) {
245 if !dc.caps["message-tags"] {
246 msg = msg.Copy()
247 for name := range msg.Tags {
248 supported := false
249 switch name {
250 case "time":
251 supported = dc.caps["server-time"]
252 }
253 if !supported {
254 delete(msg.Tags, name)
255 }
256 }
257 }
258
259 dc.conn.SendMessage(msg)
260}
261
262// marshalMessage re-formats a message coming from an upstream connection so
263// that it's suitable for being sent on this downstream connection. Only
264// messages that may appear in logs are supported.
265func (dc *downstreamConn) marshalMessage(msg *irc.Message, net *network) *irc.Message {
266 msg = msg.Copy()
267 msg.Prefix = dc.marshalUserPrefix(net, msg.Prefix)
268
269 switch msg.Command {
270 case "PRIVMSG", "NOTICE":
271 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
272 case "NICK":
273 // Nick change for another user
274 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
275 case "JOIN", "PART":
276 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
277 case "KICK":
278 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
279 msg.Params[1] = dc.marshalEntity(net, msg.Params[1])
280 case "TOPIC":
281 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
282 case "MODE":
283 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
284 case "QUIT":
285 // This space is intentionally left blank
286 default:
287 panic(fmt.Sprintf("unexpected %q message", msg.Command))
288 }
289
290 return msg
291}
292
293func (dc *downstreamConn) handleMessage(msg *irc.Message) error {
294 switch msg.Command {
295 case "QUIT":
296 return dc.Close()
297 default:
298 if dc.registered {
299 return dc.handleMessageRegistered(msg)
300 } else {
301 return dc.handleMessageUnregistered(msg)
302 }
303 }
304}
305
306func (dc *downstreamConn) handleMessageUnregistered(msg *irc.Message) error {
307 switch msg.Command {
308 case "NICK":
309 var nick string
310 if err := parseMessageParams(msg, &nick); err != nil {
311 return err
312 }
313 if nick == serviceNick {
314 return ircError{&irc.Message{
315 Command: irc.ERR_NICKNAMEINUSE,
316 Params: []string{dc.nick, nick, "Nickname reserved for bouncer service"},
317 }}
318 }
319 dc.nick = nick
320 case "USER":
321 if err := parseMessageParams(msg, &dc.rawUsername, nil, nil, &dc.realname); err != nil {
322 return err
323 }
324 case "PASS":
325 if err := parseMessageParams(msg, &dc.password); err != nil {
326 return err
327 }
328 case "CAP":
329 var subCmd string
330 if err := parseMessageParams(msg, &subCmd); err != nil {
331 return err
332 }
333 if err := dc.handleCapCommand(subCmd, msg.Params[1:]); err != nil {
334 return err
335 }
336 case "AUTHENTICATE":
337 if !dc.caps["sasl"] {
338 return ircError{&irc.Message{
339 Command: irc.ERR_SASLFAIL,
340 Params: []string{"*", "AUTHENTICATE requires the \"sasl\" capability to be enabled"},
341 }}
342 }
343 if len(msg.Params) == 0 {
344 return ircError{&irc.Message{
345 Command: irc.ERR_SASLFAIL,
346 Params: []string{"*", "Missing AUTHENTICATE argument"},
347 }}
348 }
349 if dc.nick == "" {
350 return ircError{&irc.Message{
351 Command: irc.ERR_SASLFAIL,
352 Params: []string{"*", "Expected NICK command before AUTHENTICATE"},
353 }}
354 }
355
356 var resp []byte
357 if dc.saslServer == nil {
358 mech := strings.ToUpper(msg.Params[0])
359 switch mech {
360 case "PLAIN":
361 dc.saslServer = sasl.NewPlainServer(sasl.PlainAuthenticator(func(identity, username, password string) error {
362 return dc.authenticate(username, password)
363 }))
364 default:
365 return ircError{&irc.Message{
366 Command: irc.ERR_SASLFAIL,
367 Params: []string{"*", fmt.Sprintf("Unsupported SASL mechanism %q", mech)},
368 }}
369 }
370 } else if msg.Params[0] == "*" {
371 dc.saslServer = nil
372 return ircError{&irc.Message{
373 Command: irc.ERR_SASLABORTED,
374 Params: []string{"*", "SASL authentication aborted"},
375 }}
376 } else if msg.Params[0] == "+" {
377 resp = nil
378 } else {
379 // TODO: multi-line messages
380 var err error
381 resp, err = base64.StdEncoding.DecodeString(msg.Params[0])
382 if err != nil {
383 dc.saslServer = nil
384 return ircError{&irc.Message{
385 Command: irc.ERR_SASLFAIL,
386 Params: []string{"*", "Invalid base64-encoded response"},
387 }}
388 }
389 }
390
391 challenge, done, err := dc.saslServer.Next(resp)
392 if err != nil {
393 dc.saslServer = nil
394 if ircErr, ok := err.(ircError); ok && ircErr.Message.Command == irc.ERR_PASSWDMISMATCH {
395 return ircError{&irc.Message{
396 Command: irc.ERR_SASLFAIL,
397 Params: []string{"*", ircErr.Message.Params[1]},
398 }}
399 }
400 dc.SendMessage(&irc.Message{
401 Prefix: dc.srv.prefix(),
402 Command: irc.ERR_SASLFAIL,
403 Params: []string{"*", "SASL error"},
404 })
405 return fmt.Errorf("SASL authentication failed: %v", err)
406 } else if done {
407 dc.saslServer = nil
408 dc.SendMessage(&irc.Message{
409 Prefix: dc.srv.prefix(),
410 Command: irc.RPL_LOGGEDIN,
411 Params: []string{dc.nick, dc.nick, dc.user.Username, "You are now logged in"},
412 })
413 dc.SendMessage(&irc.Message{
414 Prefix: dc.srv.prefix(),
415 Command: irc.RPL_SASLSUCCESS,
416 Params: []string{dc.nick, "SASL authentication successful"},
417 })
418 } else {
419 challengeStr := "+"
420 if len(challenge) > 0 {
421 challengeStr = base64.StdEncoding.EncodeToString(challenge)
422 }
423
424 // TODO: multi-line messages
425 dc.SendMessage(&irc.Message{
426 Prefix: dc.srv.prefix(),
427 Command: "AUTHENTICATE",
428 Params: []string{challengeStr},
429 })
430 }
431 default:
432 dc.logger.Printf("unhandled message: %v", msg)
433 return newUnknownCommandError(msg.Command)
434 }
435 if dc.rawUsername != "" && dc.nick != "" && !dc.negociatingCaps {
436 return dc.register()
437 }
438 return nil
439}
440
441func (dc *downstreamConn) handleCapCommand(cmd string, args []string) error {
442 cmd = strings.ToUpper(cmd)
443
444 replyTo := dc.nick
445 if !dc.registered {
446 replyTo = "*"
447 }
448
449 switch cmd {
450 case "LS":
451 if len(args) > 0 {
452 var err error
453 if dc.capVersion, err = strconv.Atoi(args[0]); err != nil {
454 return err
455 }
456 }
457
458 caps := make([]string, 0, len(dc.supportedCaps))
459 for k, v := range dc.supportedCaps {
460 if dc.capVersion >= 302 && v != "" {
461 caps = append(caps, k + "=" + v)
462 } else {
463 caps = append(caps, k)
464 }
465 }
466
467 // TODO: multi-line replies
468 dc.SendMessage(&irc.Message{
469 Prefix: dc.srv.prefix(),
470 Command: "CAP",
471 Params: []string{replyTo, "LS", strings.Join(caps, " ")},
472 })
473
474 if dc.capVersion >= 302 {
475 // CAP version 302 implicitly enables cap-notify
476 dc.caps["cap-notify"] = true
477 }
478
479 if !dc.registered {
480 dc.negociatingCaps = true
481 }
482 case "LIST":
483 var caps []string
484 for name := range dc.caps {
485 caps = append(caps, name)
486 }
487
488 // TODO: multi-line replies
489 dc.SendMessage(&irc.Message{
490 Prefix: dc.srv.prefix(),
491 Command: "CAP",
492 Params: []string{replyTo, "LIST", strings.Join(caps, " ")},
493 })
494 case "REQ":
495 if len(args) == 0 {
496 return ircError{&irc.Message{
497 Command: err_invalidcapcmd,
498 Params: []string{replyTo, cmd, "Missing argument in CAP REQ command"},
499 }}
500 }
501
502 // TODO: atomically ack/nak the whole capability set
503 caps := strings.Fields(args[0])
504 ack := true
505 for _, name := range caps {
506 name = strings.ToLower(name)
507 enable := !strings.HasPrefix(name, "-")
508 if !enable {
509 name = strings.TrimPrefix(name, "-")
510 }
511
512 if enable == dc.caps[name] {
513 continue
514 }
515
516 _, ok := dc.supportedCaps[name]
517 if !ok {
518 ack = false
519 break
520 }
521
522 if name == "cap-notify" && dc.capVersion >= 302 && !enable {
523 // cap-notify cannot be disabled with CAP version 302
524 ack = false
525 break
526 }
527
528 dc.caps[name] = enable
529 }
530
531 reply := "NAK"
532 if ack {
533 reply = "ACK"
534 }
535 dc.SendMessage(&irc.Message{
536 Prefix: dc.srv.prefix(),
537 Command: "CAP",
538 Params: []string{replyTo, reply, args[0]},
539 })
540 case "END":
541 dc.negociatingCaps = false
542 default:
543 return ircError{&irc.Message{
544 Command: err_invalidcapcmd,
545 Params: []string{replyTo, cmd, "Unknown CAP command"},
546 }}
547 }
548 return nil
549}
550
551func (dc *downstreamConn) setSupportedCap(name, value string) {
552 prevValue, hasPrev := dc.supportedCaps[name]
553 changed := !hasPrev || prevValue != value
554 dc.supportedCaps[name] = value
555
556 if !dc.caps["cap-notify"] || !changed {
557 return
558 }
559
560 replyTo := dc.nick
561 if !dc.registered {
562 replyTo = "*"
563 }
564
565 cap := name
566 if value != "" && dc.capVersion >= 302 {
567 cap = name + "=" + value
568 }
569
570 dc.SendMessage(&irc.Message{
571 Prefix: dc.srv.prefix(),
572 Command: "CAP",
573 Params: []string{replyTo, "NEW", cap},
574 })
575}
576
577func (dc *downstreamConn) unsetSupportedCap(name string) {
578 _, hasPrev := dc.supportedCaps[name]
579 delete(dc.supportedCaps, name)
580 delete(dc.caps, name)
581
582 if !dc.caps["cap-notify"] || !hasPrev {
583 return
584 }
585
586 replyTo := dc.nick
587 if !dc.registered {
588 replyTo = "*"
589 }
590
591 dc.SendMessage(&irc.Message{
592 Prefix: dc.srv.prefix(),
593 Command: "CAP",
594 Params: []string{replyTo, "DEL", name},
595 })
596}
597
598func sanityCheckServer(addr string) error {
599 dialer := net.Dialer{Timeout: 30 * time.Second}
600 conn, err := tls.DialWithDialer(&dialer, "tcp", addr, nil)
601 if err != nil {
602 return err
603 }
604 return conn.Close()
605}
606
607func unmarshalUsername(rawUsername string) (username, client, network string) {
608 username = rawUsername
609
610 i := strings.IndexAny(username, "/@")
611 j := strings.LastIndexAny(username, "/@")
612 if i >= 0 {
613 username = rawUsername[:i]
614 }
615 if j >= 0 {
616 if rawUsername[j] == '@' {
617 client = rawUsername[j+1:]
618 } else {
619 network = rawUsername[j+1:]
620 }
621 }
622 if i >= 0 && j >= 0 && i < j {
623 if rawUsername[i] == '@' {
624 client = rawUsername[i+1 : j]
625 } else {
626 network = rawUsername[i+1 : j]
627 }
628 }
629
630 return username, client, network
631}
632
633func (dc *downstreamConn) authenticate(username, password string) error {
634 username, clientName, networkName := unmarshalUsername(username)
635
636 u, err := dc.srv.db.GetUser(username)
637 if err != nil {
638 dc.logger.Printf("failed authentication for %q: %v", username, err)
639 return errAuthFailed
640 }
641
642 err = bcrypt.CompareHashAndPassword([]byte(u.Password), []byte(password))
643 if err != nil {
644 dc.logger.Printf("failed authentication for %q: %v", username, err)
645 return errAuthFailed
646 }
647
648 dc.user = dc.srv.getUser(username)
649 if dc.user == nil {
650 dc.logger.Printf("failed authentication for %q: user not active", username)
651 return errAuthFailed
652 }
653 dc.clientName = clientName
654 dc.networkName = networkName
655 return nil
656}
657
658func (dc *downstreamConn) register() error {
659 if dc.registered {
660 return fmt.Errorf("tried to register twice")
661 }
662
663 password := dc.password
664 dc.password = ""
665 if dc.user == nil {
666 if err := dc.authenticate(dc.rawUsername, password); err != nil {
667 return err
668 }
669 }
670
671 if dc.clientName == "" && dc.networkName == "" {
672 _, dc.clientName, dc.networkName = unmarshalUsername(dc.rawUsername)
673 }
674
675 dc.registered = true
676 dc.logger.Printf("registration complete for user %q", dc.user.Username)
677 return nil
678}
679
680func (dc *downstreamConn) loadNetwork() error {
681 if dc.networkName == "" {
682 return nil
683 }
684
685 network := dc.user.getNetwork(dc.networkName)
686 if network == nil {
687 addr := dc.networkName
688 if !strings.ContainsRune(addr, ':') {
689 addr = addr + ":6697"
690 }
691
692 dc.logger.Printf("trying to connect to new network %q", addr)
693 if err := sanityCheckServer(addr); err != nil {
694 dc.logger.Printf("failed to connect to %q: %v", addr, err)
695 return ircError{&irc.Message{
696 Command: irc.ERR_PASSWDMISMATCH,
697 Params: []string{"*", fmt.Sprintf("Failed to connect to %q", dc.networkName)},
698 }}
699 }
700
701 dc.logger.Printf("auto-saving network %q", dc.networkName)
702 var err error
703 network, err = dc.user.createNetwork(&Network{
704 Addr: dc.networkName,
705 Nick: dc.nick,
706 })
707 if err != nil {
708 return err
709 }
710 }
711
712 dc.network = network
713 return nil
714}
715
716func (dc *downstreamConn) welcome() error {
717 if dc.user == nil || !dc.registered {
718 panic("tried to welcome an unregistered connection")
719 }
720
721 // TODO: doing this might take some time. We should do it in dc.register
722 // instead, but we'll potentially be adding a new network and this must be
723 // done in the user goroutine.
724 if err := dc.loadNetwork(); err != nil {
725 return err
726 }
727
728 dc.SendMessage(&irc.Message{
729 Prefix: dc.srv.prefix(),
730 Command: irc.RPL_WELCOME,
731 Params: []string{dc.nick, "Welcome to soju, " + dc.nick},
732 })
733 dc.SendMessage(&irc.Message{
734 Prefix: dc.srv.prefix(),
735 Command: irc.RPL_YOURHOST,
736 Params: []string{dc.nick, "Your host is " + dc.srv.Hostname},
737 })
738 dc.SendMessage(&irc.Message{
739 Prefix: dc.srv.prefix(),
740 Command: irc.RPL_CREATED,
741 Params: []string{dc.nick, "Who cares when the server was created?"},
742 })
743 dc.SendMessage(&irc.Message{
744 Prefix: dc.srv.prefix(),
745 Command: irc.RPL_MYINFO,
746 Params: []string{dc.nick, dc.srv.Hostname, "soju", "aiwroO", "OovaimnqpsrtklbeI"},
747 })
748 // TODO: RPL_ISUPPORT
749 dc.SendMessage(&irc.Message{
750 Prefix: dc.srv.prefix(),
751 Command: irc.ERR_NOMOTD,
752 Params: []string{dc.nick, "No MOTD"},
753 })
754
755 dc.forEachUpstream(func(uc *upstreamConn) {
756 for _, ch := range uc.channels {
757 if ch.complete {
758 dc.SendMessage(&irc.Message{
759 Prefix: dc.prefix(),
760 Command: "JOIN",
761 Params: []string{dc.marshalEntity(ch.conn.network, ch.Name)},
762 })
763
764 forwardChannel(dc, ch)
765 }
766 }
767 })
768
769 dc.forEachNetwork(func(net *network) {
770 // Only send history if we're the first connected client with that name
771 // for the network
772 if _, ok := net.offlineClients[dc.clientName]; ok {
773 dc.sendNetworkHistory(net)
774 delete(net.offlineClients, dc.clientName)
775 }
776 })
777
778 return nil
779}
780
781func (dc *downstreamConn) sendNetworkHistory(net *network) {
782 for target, history := range net.history {
783 seq, ok := history.offlineClients[dc.clientName]
784 if !ok {
785 continue
786 }
787 delete(history.offlineClients, dc.clientName)
788
789 // If all clients have received history, no need to keep the
790 // ring buffer around
791 if len(history.offlineClients) == 0 {
792 delete(net.history, target)
793 }
794
795 consumer := history.ring.NewConsumer(seq)
796
797 batchRef := "history"
798 if dc.caps["batch"] {
799 dc.SendMessage(&irc.Message{
800 Prefix: dc.srv.prefix(),
801 Command: "BATCH",
802 Params: []string{"+" + batchRef, "chathistory", dc.marshalEntity(net, target)},
803 })
804 }
805
806 for {
807 msg := consumer.Consume()
808 if msg == nil {
809 break
810 }
811
812 // Don't replay all messages, because that would mess up client
813 // state. For instance we just sent the list of users, sending
814 // PART messages for one of these users would be incorrect.
815 ignore := true
816 switch msg.Command {
817 case "PRIVMSG", "NOTICE":
818 ignore = false
819 }
820 if ignore {
821 continue
822 }
823
824 if dc.caps["batch"] {
825 msg = msg.Copy()
826 msg.Tags["batch"] = irc.TagValue(batchRef)
827 }
828
829 dc.SendMessage(dc.marshalMessage(msg, net))
830 }
831
832 if dc.caps["batch"] {
833 dc.SendMessage(&irc.Message{
834 Prefix: dc.srv.prefix(),
835 Command: "BATCH",
836 Params: []string{"-" + batchRef},
837 })
838 }
839 }
840}
841
842func (dc *downstreamConn) runUntilRegistered() error {
843 for !dc.registered {
844 msg, err := dc.ReadMessage()
845 if err != nil {
846 return fmt.Errorf("failed to read IRC command: %v", err)
847 }
848
849 err = dc.handleMessage(msg)
850 if ircErr, ok := err.(ircError); ok {
851 ircErr.Message.Prefix = dc.srv.prefix()
852 dc.SendMessage(ircErr.Message)
853 } else if err != nil {
854 return fmt.Errorf("failed to handle IRC command %q: %v", msg, err)
855 }
856 }
857
858 return nil
859}
860
861func (dc *downstreamConn) handleMessageRegistered(msg *irc.Message) error {
862 switch msg.Command {
863 case "CAP":
864 var subCmd string
865 if err := parseMessageParams(msg, &subCmd); err != nil {
866 return err
867 }
868 if err := dc.handleCapCommand(subCmd, msg.Params[1:]); err != nil {
869 return err
870 }
871 case "PING":
872 dc.SendMessage(&irc.Message{
873 Prefix: dc.srv.prefix(),
874 Command: "PONG",
875 Params: msg.Params,
876 })
877 return nil
878 case "USER":
879 return ircError{&irc.Message{
880 Command: irc.ERR_ALREADYREGISTERED,
881 Params: []string{dc.nick, "You may not reregister"},
882 }}
883 case "NICK":
884 var nick string
885 if err := parseMessageParams(msg, &nick); err != nil {
886 return err
887 }
888
889 var err error
890 dc.forEachNetwork(func(n *network) {
891 if err != nil {
892 return
893 }
894 n.Nick = nick
895 err = dc.srv.db.StoreNetwork(dc.user.Username, &n.Network)
896 })
897 if err != nil {
898 return err
899 }
900
901 dc.forEachUpstream(func(uc *upstreamConn) {
902 uc.SendMessage(msg)
903 })
904 case "JOIN":
905 var namesStr string
906 if err := parseMessageParams(msg, &namesStr); err != nil {
907 return err
908 }
909
910 var keys []string
911 if len(msg.Params) > 1 {
912 keys = strings.Split(msg.Params[1], ",")
913 }
914
915 for i, name := range strings.Split(namesStr, ",") {
916 uc, upstreamName, err := dc.unmarshalEntity(name)
917 if err != nil {
918 return err
919 }
920
921 var key string
922 if len(keys) > i {
923 key = keys[i]
924 }
925
926 params := []string{upstreamName}
927 if key != "" {
928 params = append(params, key)
929 }
930 uc.SendMessage(&irc.Message{
931 Command: "JOIN",
932 Params: params,
933 })
934
935 ch := &Channel{Name: upstreamName, Key: key}
936 if err := uc.network.createUpdateChannel(ch); err != nil {
937 dc.logger.Printf("failed to create or update channel %q: %v", upstreamName, err)
938 }
939 }
940 case "PART":
941 var namesStr string
942 if err := parseMessageParams(msg, &namesStr); err != nil {
943 return err
944 }
945
946 var reason string
947 if len(msg.Params) > 1 {
948 reason = msg.Params[1]
949 }
950
951 for _, name := range strings.Split(namesStr, ",") {
952 uc, upstreamName, err := dc.unmarshalEntity(name)
953 if err != nil {
954 return err
955 }
956
957 params := []string{upstreamName}
958 if reason != "" {
959 params = append(params, reason)
960 }
961 uc.SendMessage(&irc.Message{
962 Command: "PART",
963 Params: params,
964 })
965
966 if err := uc.network.deleteChannel(upstreamName); err != nil {
967 dc.logger.Printf("failed to delete channel %q: %v", upstreamName, err)
968 }
969 }
970 case "KICK":
971 var channelStr, userStr string
972 if err := parseMessageParams(msg, &channelStr, &userStr); err != nil {
973 return err
974 }
975
976 channels := strings.Split(channelStr, ",")
977 users := strings.Split(userStr, ",")
978
979 var reason string
980 if len(msg.Params) > 2 {
981 reason = msg.Params[2]
982 }
983
984 if len(channels) != 1 && len(channels) != len(users) {
985 return ircError{&irc.Message{
986 Command: irc.ERR_BADCHANMASK,
987 Params: []string{dc.nick, channelStr, "Bad channel mask"},
988 }}
989 }
990
991 for i, user := range users {
992 var channel string
993 if len(channels) == 1 {
994 channel = channels[0]
995 } else {
996 channel = channels[i]
997 }
998
999 ucChannel, upstreamChannel, err := dc.unmarshalEntity(channel)
1000 if err != nil {
1001 return err
1002 }
1003
1004 ucUser, upstreamUser, err := dc.unmarshalEntity(user)
1005 if err != nil {
1006 return err
1007 }
1008
1009 if ucChannel != ucUser {
1010 return ircError{&irc.Message{
1011 Command: irc.ERR_USERNOTINCHANNEL,
1012 Params: []string{dc.nick, user, channel, "They aren't on that channel"},
1013 }}
1014 }
1015 uc := ucChannel
1016
1017 params := []string{upstreamChannel, upstreamUser}
1018 if reason != "" {
1019 params = append(params, reason)
1020 }
1021 uc.SendMessage(&irc.Message{
1022 Command: "KICK",
1023 Params: params,
1024 })
1025 }
1026 case "MODE":
1027 var name string
1028 if err := parseMessageParams(msg, &name); err != nil {
1029 return err
1030 }
1031
1032 var modeStr string
1033 if len(msg.Params) > 1 {
1034 modeStr = msg.Params[1]
1035 }
1036
1037 if name == dc.nick {
1038 if modeStr != "" {
1039 dc.forEachUpstream(func(uc *upstreamConn) {
1040 uc.SendMessage(&irc.Message{
1041 Command: "MODE",
1042 Params: []string{uc.nick, modeStr},
1043 })
1044 })
1045 } else {
1046 dc.SendMessage(&irc.Message{
1047 Prefix: dc.srv.prefix(),
1048 Command: irc.RPL_UMODEIS,
1049 Params: []string{dc.nick, ""}, // TODO
1050 })
1051 }
1052 return nil
1053 }
1054
1055 uc, upstreamName, err := dc.unmarshalEntity(name)
1056 if err != nil {
1057 return err
1058 }
1059
1060 if !uc.isChannel(upstreamName) {
1061 return ircError{&irc.Message{
1062 Command: irc.ERR_USERSDONTMATCH,
1063 Params: []string{dc.nick, "Cannot change mode for other users"},
1064 }}
1065 }
1066
1067 if modeStr != "" {
1068 params := []string{upstreamName, modeStr}
1069 params = append(params, msg.Params[2:]...)
1070 uc.SendMessage(&irc.Message{
1071 Command: "MODE",
1072 Params: params,
1073 })
1074 } else {
1075 ch, ok := uc.channels[upstreamName]
1076 if !ok {
1077 return ircError{&irc.Message{
1078 Command: irc.ERR_NOSUCHCHANNEL,
1079 Params: []string{dc.nick, name, "No such channel"},
1080 }}
1081 }
1082
1083 if ch.modes == nil {
1084 // we haven't received the initial RPL_CHANNELMODEIS yet
1085 // ignore the request, we will broadcast the modes later when we receive RPL_CHANNELMODEIS
1086 return nil
1087 }
1088
1089 modeStr, modeParams := ch.modes.Format()
1090 params := []string{dc.nick, name, modeStr}
1091 params = append(params, modeParams...)
1092
1093 dc.SendMessage(&irc.Message{
1094 Prefix: dc.srv.prefix(),
1095 Command: irc.RPL_CHANNELMODEIS,
1096 Params: params,
1097 })
1098 if ch.creationTime != "" {
1099 dc.SendMessage(&irc.Message{
1100 Prefix: dc.srv.prefix(),
1101 Command: rpl_creationtime,
1102 Params: []string{dc.nick, name, ch.creationTime},
1103 })
1104 }
1105 }
1106 case "TOPIC":
1107 var channel string
1108 if err := parseMessageParams(msg, &channel); err != nil {
1109 return err
1110 }
1111
1112 uc, upstreamChannel, err := dc.unmarshalEntity(channel)
1113 if err != nil {
1114 return err
1115 }
1116
1117 if len(msg.Params) > 1 { // setting topic
1118 topic := msg.Params[1]
1119 uc.SendMessage(&irc.Message{
1120 Command: "TOPIC",
1121 Params: []string{upstreamChannel, topic},
1122 })
1123 } else { // getting topic
1124 ch, ok := uc.channels[upstreamChannel]
1125 if !ok {
1126 return ircError{&irc.Message{
1127 Command: irc.ERR_NOSUCHCHANNEL,
1128 Params: []string{dc.nick, upstreamChannel, "No such channel"},
1129 }}
1130 }
1131 sendTopic(dc, ch)
1132 }
1133 case "LIST":
1134 // TODO: support ELIST when supported by all upstreams
1135
1136 pl := pendingLIST{
1137 downstreamID: dc.id,
1138 pendingCommands: make(map[int64]*irc.Message),
1139 }
1140 var upstreamChannels map[int64][]string
1141 if len(msg.Params) > 0 {
1142 upstreamChannels = make(map[int64][]string)
1143 channels := strings.Split(msg.Params[0], ",")
1144 for _, channel := range channels {
1145 uc, upstreamChannel, err := dc.unmarshalEntity(channel)
1146 if err != nil {
1147 return err
1148 }
1149 upstreamChannels[uc.network.ID] = append(upstreamChannels[uc.network.ID], upstreamChannel)
1150 }
1151 }
1152
1153 dc.user.pendingLISTs = append(dc.user.pendingLISTs, pl)
1154 dc.forEachUpstream(func(uc *upstreamConn) {
1155 var params []string
1156 if upstreamChannels != nil {
1157 if channels, ok := upstreamChannels[uc.network.ID]; ok {
1158 params = []string{strings.Join(channels, ",")}
1159 } else {
1160 return
1161 }
1162 }
1163 pl.pendingCommands[uc.network.ID] = &irc.Message{
1164 Command: "LIST",
1165 Params: params,
1166 }
1167 uc.trySendLIST(dc.id)
1168 })
1169 case "NAMES":
1170 if len(msg.Params) == 0 {
1171 dc.SendMessage(&irc.Message{
1172 Prefix: dc.srv.prefix(),
1173 Command: irc.RPL_ENDOFNAMES,
1174 Params: []string{dc.nick, "*", "End of /NAMES list"},
1175 })
1176 return nil
1177 }
1178
1179 channels := strings.Split(msg.Params[0], ",")
1180 for _, channel := range channels {
1181 uc, upstreamChannel, err := dc.unmarshalEntity(channel)
1182 if err != nil {
1183 return err
1184 }
1185
1186 ch, ok := uc.channels[upstreamChannel]
1187 if ok {
1188 sendNames(dc, ch)
1189 } else {
1190 // NAMES on a channel we have not joined, ask upstream
1191 uc.SendMessageLabeled(dc.id, &irc.Message{
1192 Command: "NAMES",
1193 Params: []string{upstreamChannel},
1194 })
1195 }
1196 }
1197 case "WHO":
1198 if len(msg.Params) == 0 {
1199 // TODO: support WHO without parameters
1200 dc.SendMessage(&irc.Message{
1201 Prefix: dc.srv.prefix(),
1202 Command: irc.RPL_ENDOFWHO,
1203 Params: []string{dc.nick, "*", "End of /WHO list"},
1204 })
1205 return nil
1206 }
1207
1208 // TODO: support WHO masks
1209 entity := msg.Params[0]
1210
1211 if entity == dc.nick {
1212 // TODO: support AWAY (H/G) in self WHO reply
1213 dc.SendMessage(&irc.Message{
1214 Prefix: dc.srv.prefix(),
1215 Command: irc.RPL_WHOREPLY,
1216 Params: []string{dc.nick, "*", dc.user.Username, dc.hostname, dc.srv.Hostname, dc.nick, "H", "0 " + dc.realname},
1217 })
1218 dc.SendMessage(&irc.Message{
1219 Prefix: dc.srv.prefix(),
1220 Command: irc.RPL_ENDOFWHO,
1221 Params: []string{dc.nick, dc.nick, "End of /WHO list"},
1222 })
1223 return nil
1224 }
1225
1226 uc, upstreamName, err := dc.unmarshalEntity(entity)
1227 if err != nil {
1228 return err
1229 }
1230
1231 var params []string
1232 if len(msg.Params) == 2 {
1233 params = []string{upstreamName, msg.Params[1]}
1234 } else {
1235 params = []string{upstreamName}
1236 }
1237
1238 uc.SendMessageLabeled(dc.id, &irc.Message{
1239 Command: "WHO",
1240 Params: params,
1241 })
1242 case "WHOIS":
1243 if len(msg.Params) == 0 {
1244 return ircError{&irc.Message{
1245 Command: irc.ERR_NONICKNAMEGIVEN,
1246 Params: []string{dc.nick, "No nickname given"},
1247 }}
1248 }
1249
1250 var target, mask string
1251 if len(msg.Params) == 1 {
1252 target = ""
1253 mask = msg.Params[0]
1254 } else {
1255 target = msg.Params[0]
1256 mask = msg.Params[1]
1257 }
1258 // TODO: support multiple WHOIS users
1259 if i := strings.IndexByte(mask, ','); i >= 0 {
1260 mask = mask[:i]
1261 }
1262
1263 if mask == dc.nick {
1264 dc.SendMessage(&irc.Message{
1265 Prefix: dc.srv.prefix(),
1266 Command: irc.RPL_WHOISUSER,
1267 Params: []string{dc.nick, dc.nick, dc.user.Username, dc.hostname, "*", dc.realname},
1268 })
1269 dc.SendMessage(&irc.Message{
1270 Prefix: dc.srv.prefix(),
1271 Command: irc.RPL_WHOISSERVER,
1272 Params: []string{dc.nick, dc.nick, dc.srv.Hostname, "soju"},
1273 })
1274 dc.SendMessage(&irc.Message{
1275 Prefix: dc.srv.prefix(),
1276 Command: irc.RPL_ENDOFWHOIS,
1277 Params: []string{dc.nick, dc.nick, "End of /WHOIS list"},
1278 })
1279 return nil
1280 }
1281
1282 // TODO: support WHOIS masks
1283 uc, upstreamNick, err := dc.unmarshalEntity(mask)
1284 if err != nil {
1285 return err
1286 }
1287
1288 var params []string
1289 if target != "" {
1290 params = []string{target, upstreamNick}
1291 } else {
1292 params = []string{upstreamNick}
1293 }
1294
1295 uc.SendMessageLabeled(dc.id, &irc.Message{
1296 Command: "WHOIS",
1297 Params: params,
1298 })
1299 case "PRIVMSG":
1300 var targetsStr, text string
1301 if err := parseMessageParams(msg, &targetsStr, &text); err != nil {
1302 return err
1303 }
1304
1305 for _, name := range strings.Split(targetsStr, ",") {
1306 if name == serviceNick {
1307 handleServicePRIVMSG(dc, text)
1308 continue
1309 }
1310
1311 uc, upstreamName, err := dc.unmarshalEntity(name)
1312 if err != nil {
1313 return err
1314 }
1315
1316 if upstreamName == "NickServ" {
1317 dc.handleNickServPRIVMSG(uc, text)
1318 }
1319
1320 unmarshaledText := text
1321 if uc.isChannel(upstreamName) {
1322 unmarshaledText = dc.unmarshalText(uc, text)
1323 }
1324 uc.SendMessage(&irc.Message{
1325 Command: "PRIVMSG",
1326 Params: []string{upstreamName, unmarshaledText},
1327 })
1328
1329 echoMsg := &irc.Message{
1330 Prefix: &irc.Prefix{
1331 Name: uc.nick,
1332 User: uc.username,
1333 },
1334 Command: "PRIVMSG",
1335 Params: []string{upstreamName, text},
1336 }
1337
1338 uc.produce(upstreamName, echoMsg, dc)
1339 }
1340 case "NOTICE":
1341 var targetsStr, text string
1342 if err := parseMessageParams(msg, &targetsStr, &text); err != nil {
1343 return err
1344 }
1345
1346 for _, name := range strings.Split(targetsStr, ",") {
1347 uc, upstreamName, err := dc.unmarshalEntity(name)
1348 if err != nil {
1349 return err
1350 }
1351
1352 unmarshaledText := text
1353 if uc.isChannel(upstreamName) {
1354 unmarshaledText = dc.unmarshalText(uc, text)
1355 }
1356 uc.SendMessage(&irc.Message{
1357 Command: "NOTICE",
1358 Params: []string{upstreamName, unmarshaledText},
1359 })
1360 }
1361 case "INVITE":
1362 var user, channel string
1363 if err := parseMessageParams(msg, &user, &channel); err != nil {
1364 return err
1365 }
1366
1367 ucChannel, upstreamChannel, err := dc.unmarshalEntity(channel)
1368 if err != nil {
1369 return err
1370 }
1371
1372 ucUser, upstreamUser, err := dc.unmarshalEntity(user)
1373 if err != nil {
1374 return err
1375 }
1376
1377 if ucChannel != ucUser {
1378 return ircError{&irc.Message{
1379 Command: irc.ERR_USERNOTINCHANNEL,
1380 Params: []string{dc.nick, user, channel, "They aren't on that channel"},
1381 }}
1382 }
1383 uc := ucChannel
1384
1385 uc.SendMessageLabeled(dc.id, &irc.Message{
1386 Command: "INVITE",
1387 Params: []string{upstreamUser, upstreamChannel},
1388 })
1389 default:
1390 dc.logger.Printf("unhandled message: %v", msg)
1391 return newUnknownCommandError(msg.Command)
1392 }
1393 return nil
1394}
1395
1396func (dc *downstreamConn) handleNickServPRIVMSG(uc *upstreamConn, text string) {
1397 username, password, ok := parseNickServCredentials(text, uc.nick)
1398 if !ok {
1399 return
1400 }
1401
1402 dc.logger.Printf("auto-saving NickServ credentials with username %q", username)
1403 n := uc.network
1404 n.SASL.Mechanism = "PLAIN"
1405 n.SASL.Plain.Username = username
1406 n.SASL.Plain.Password = password
1407 if err := dc.srv.db.StoreNetwork(dc.user.Username, &n.Network); err != nil {
1408 dc.logger.Printf("failed to save NickServ credentials: %v", err)
1409 }
1410}
1411
1412func parseNickServCredentials(text, nick string) (username, password string, ok bool) {
1413 fields := strings.Fields(text)
1414 if len(fields) < 2 {
1415 return "", "", false
1416 }
1417 cmd := strings.ToUpper(fields[0])
1418 params := fields[1:]
1419 switch cmd {
1420 case "REGISTER":
1421 username = nick
1422 password = params[0]
1423 case "IDENTIFY":
1424 if len(params) == 1 {
1425 username = nick
1426 password = params[0]
1427 } else {
1428 username = params[0]
1429 password = params[1]
1430 }
1431 case "SET":
1432 if len(params) == 2 && strings.EqualFold(params[0], "PASSWORD") {
1433 username = nick
1434 password = params[1]
1435 }
1436 }
1437 return username, password, true
1438}
Note: See TracBrowser for help on using the repository browser.