1 | package soju
|
---|
2 |
|
---|
3 | import (
|
---|
4 | "context"
|
---|
5 | "errors"
|
---|
6 | "fmt"
|
---|
7 | "io"
|
---|
8 | "log"
|
---|
9 | "mime"
|
---|
10 | "net"
|
---|
11 | "net/http"
|
---|
12 | "runtime/debug"
|
---|
13 | "sync"
|
---|
14 | "sync/atomic"
|
---|
15 | "time"
|
---|
16 |
|
---|
17 | "github.com/prometheus/client_golang/prometheus"
|
---|
18 | "gopkg.in/irc.v3"
|
---|
19 | "nhooyr.io/websocket"
|
---|
20 |
|
---|
21 | "git.sr.ht/~emersion/soju/config"
|
---|
22 | )
|
---|
23 |
|
---|
24 | // TODO: make configurable
|
---|
25 | var retryConnectDelay = time.Minute
|
---|
26 | var connectTimeout = 15 * time.Second
|
---|
27 | var writeTimeout = 10 * time.Second
|
---|
28 | var upstreamMessageDelay = 2 * time.Second
|
---|
29 | var upstreamMessageBurst = 10
|
---|
30 | var backlogTimeout = 10 * time.Second
|
---|
31 | var handleDownstreamMessageTimeout = 10 * time.Second
|
---|
32 | var downstreamRegisterTimeout = 30 * time.Second
|
---|
33 | var chatHistoryLimit = 1000
|
---|
34 | var backlogLimit = 4000
|
---|
35 |
|
---|
36 | type Logger interface {
|
---|
37 | Print(v ...interface{})
|
---|
38 | Printf(format string, v ...interface{})
|
---|
39 | }
|
---|
40 |
|
---|
41 | type prefixLogger struct {
|
---|
42 | logger Logger
|
---|
43 | prefix string
|
---|
44 | }
|
---|
45 |
|
---|
46 | var _ Logger = (*prefixLogger)(nil)
|
---|
47 |
|
---|
48 | func (l *prefixLogger) Print(v ...interface{}) {
|
---|
49 | v = append([]interface{}{l.prefix}, v...)
|
---|
50 | l.logger.Print(v...)
|
---|
51 | }
|
---|
52 |
|
---|
53 | func (l *prefixLogger) Printf(format string, v ...interface{}) {
|
---|
54 | v = append([]interface{}{l.prefix}, v...)
|
---|
55 | l.logger.Printf("%v"+format, v...)
|
---|
56 | }
|
---|
57 |
|
---|
58 | type Config struct {
|
---|
59 | Hostname string
|
---|
60 | Title string
|
---|
61 | LogPath string
|
---|
62 | Debug bool
|
---|
63 | HTTPOrigins []string
|
---|
64 | AcceptProxyIPs config.IPSet
|
---|
65 | MaxUserNetworks int
|
---|
66 | MultiUpstream bool
|
---|
67 | MOTD string
|
---|
68 | UpstreamUserIPs []*net.IPNet
|
---|
69 | }
|
---|
70 |
|
---|
71 | type Server struct {
|
---|
72 | Logger Logger
|
---|
73 | Identd *Identd // can be nil
|
---|
74 | MetricsRegistry prometheus.Registerer // can be nil
|
---|
75 |
|
---|
76 | config atomic.Value // *Config
|
---|
77 | db Database
|
---|
78 | stopWG sync.WaitGroup
|
---|
79 | connCount int64 // atomic
|
---|
80 |
|
---|
81 | lock sync.Mutex
|
---|
82 | listeners map[net.Listener]struct{}
|
---|
83 | users map[string]*user
|
---|
84 | }
|
---|
85 |
|
---|
86 | func NewServer(db Database) *Server {
|
---|
87 | srv := &Server{
|
---|
88 | Logger: log.New(log.Writer(), "", log.LstdFlags),
|
---|
89 | db: db,
|
---|
90 | listeners: make(map[net.Listener]struct{}),
|
---|
91 | users: make(map[string]*user),
|
---|
92 | }
|
---|
93 | srv.config.Store(&Config{
|
---|
94 | Hostname: "localhost",
|
---|
95 | MaxUserNetworks: -1,
|
---|
96 | MultiUpstream: true,
|
---|
97 | })
|
---|
98 | return srv
|
---|
99 | }
|
---|
100 |
|
---|
101 | func (s *Server) prefix() *irc.Prefix {
|
---|
102 | return &irc.Prefix{Name: s.Config().Hostname}
|
---|
103 | }
|
---|
104 |
|
---|
105 | func (s *Server) Config() *Config {
|
---|
106 | return s.config.Load().(*Config)
|
---|
107 | }
|
---|
108 |
|
---|
109 | func (s *Server) SetConfig(cfg *Config) {
|
---|
110 | s.config.Store(cfg)
|
---|
111 | }
|
---|
112 |
|
---|
113 | func (s *Server) Start() error {
|
---|
114 | users, err := s.db.ListUsers(context.TODO())
|
---|
115 | if err != nil {
|
---|
116 | return err
|
---|
117 | }
|
---|
118 |
|
---|
119 | s.lock.Lock()
|
---|
120 | for i := range users {
|
---|
121 | s.addUserLocked(&users[i])
|
---|
122 | }
|
---|
123 | s.lock.Unlock()
|
---|
124 |
|
---|
125 | return nil
|
---|
126 | }
|
---|
127 |
|
---|
128 | func (s *Server) Shutdown() {
|
---|
129 | s.lock.Lock()
|
---|
130 | for ln := range s.listeners {
|
---|
131 | if err := ln.Close(); err != nil {
|
---|
132 | s.Logger.Printf("failed to stop listener: %v", err)
|
---|
133 | }
|
---|
134 | }
|
---|
135 | for _, u := range s.users {
|
---|
136 | u.events <- eventStop{}
|
---|
137 | }
|
---|
138 | s.lock.Unlock()
|
---|
139 |
|
---|
140 | s.stopWG.Wait()
|
---|
141 |
|
---|
142 | if err := s.db.Close(); err != nil {
|
---|
143 | s.Logger.Printf("failed to close DB: %v", err)
|
---|
144 | }
|
---|
145 | }
|
---|
146 |
|
---|
147 | func (s *Server) createUser(ctx context.Context, user *User) (*user, error) {
|
---|
148 | s.lock.Lock()
|
---|
149 | defer s.lock.Unlock()
|
---|
150 |
|
---|
151 | if _, ok := s.users[user.Username]; ok {
|
---|
152 | return nil, fmt.Errorf("user %q already exists", user.Username)
|
---|
153 | }
|
---|
154 |
|
---|
155 | err := s.db.StoreUser(ctx, user)
|
---|
156 | if err != nil {
|
---|
157 | return nil, fmt.Errorf("could not create user in db: %v", err)
|
---|
158 | }
|
---|
159 |
|
---|
160 | return s.addUserLocked(user), nil
|
---|
161 | }
|
---|
162 |
|
---|
163 | func (s *Server) forEachUser(f func(*user)) {
|
---|
164 | s.lock.Lock()
|
---|
165 | for _, u := range s.users {
|
---|
166 | f(u)
|
---|
167 | }
|
---|
168 | s.lock.Unlock()
|
---|
169 | }
|
---|
170 |
|
---|
171 | func (s *Server) getUser(name string) *user {
|
---|
172 | s.lock.Lock()
|
---|
173 | u := s.users[name]
|
---|
174 | s.lock.Unlock()
|
---|
175 | return u
|
---|
176 | }
|
---|
177 |
|
---|
178 | func (s *Server) addUserLocked(user *User) *user {
|
---|
179 | s.Logger.Printf("starting bouncer for user %q", user.Username)
|
---|
180 | u := newUser(s, user)
|
---|
181 | s.users[u.Username] = u
|
---|
182 |
|
---|
183 | s.stopWG.Add(1)
|
---|
184 |
|
---|
185 | go func() {
|
---|
186 | defer func() {
|
---|
187 | if err := recover(); err != nil {
|
---|
188 | s.Logger.Printf("panic serving user %q: %v\n%v", user.Username, err, debug.Stack())
|
---|
189 | }
|
---|
190 | }()
|
---|
191 |
|
---|
192 | u.run()
|
---|
193 |
|
---|
194 | s.lock.Lock()
|
---|
195 | delete(s.users, u.Username)
|
---|
196 | s.lock.Unlock()
|
---|
197 |
|
---|
198 | s.stopWG.Done()
|
---|
199 | }()
|
---|
200 |
|
---|
201 | return u
|
---|
202 | }
|
---|
203 |
|
---|
204 | var lastDownstreamID uint64 = 0
|
---|
205 |
|
---|
206 | func (s *Server) handle(ic ircConn) {
|
---|
207 | defer func() {
|
---|
208 | if err := recover(); err != nil {
|
---|
209 | s.Logger.Printf("panic serving downstream %q: %v\n%v", ic.RemoteAddr(), err, debug.Stack())
|
---|
210 | }
|
---|
211 | }()
|
---|
212 |
|
---|
213 | atomic.AddInt64(&s.connCount, 1)
|
---|
214 | id := atomic.AddUint64(&lastDownstreamID, 1)
|
---|
215 | dc := newDownstreamConn(s, ic, id)
|
---|
216 | if err := dc.runUntilRegistered(); err != nil {
|
---|
217 | if !errors.Is(err, io.EOF) {
|
---|
218 | dc.logger.Print(err)
|
---|
219 | }
|
---|
220 | } else {
|
---|
221 | dc.user.events <- eventDownstreamConnected{dc}
|
---|
222 | if err := dc.readMessages(dc.user.events); err != nil {
|
---|
223 | dc.logger.Print(err)
|
---|
224 | }
|
---|
225 | dc.user.events <- eventDownstreamDisconnected{dc}
|
---|
226 | }
|
---|
227 | dc.Close()
|
---|
228 | atomic.AddInt64(&s.connCount, -1)
|
---|
229 | }
|
---|
230 |
|
---|
231 | func (s *Server) Serve(ln net.Listener) error {
|
---|
232 | s.lock.Lock()
|
---|
233 | s.listeners[ln] = struct{}{}
|
---|
234 | s.lock.Unlock()
|
---|
235 |
|
---|
236 | s.stopWG.Add(1)
|
---|
237 |
|
---|
238 | defer func() {
|
---|
239 | s.lock.Lock()
|
---|
240 | delete(s.listeners, ln)
|
---|
241 | s.lock.Unlock()
|
---|
242 |
|
---|
243 | s.stopWG.Done()
|
---|
244 | }()
|
---|
245 |
|
---|
246 | for {
|
---|
247 | conn, err := ln.Accept()
|
---|
248 | if isErrClosed(err) {
|
---|
249 | return nil
|
---|
250 | } else if err != nil {
|
---|
251 | return fmt.Errorf("failed to accept connection: %v", err)
|
---|
252 | }
|
---|
253 |
|
---|
254 | go s.handle(newNetIRCConn(conn))
|
---|
255 | }
|
---|
256 | }
|
---|
257 |
|
---|
258 | func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request) {
|
---|
259 | conn, err := websocket.Accept(w, req, &websocket.AcceptOptions{
|
---|
260 | Subprotocols: []string{"text.ircv3.net"}, // non-compliant, fight me
|
---|
261 | OriginPatterns: s.Config().HTTPOrigins,
|
---|
262 | })
|
---|
263 | if err != nil {
|
---|
264 | s.Logger.Printf("failed to serve HTTP connection: %v", err)
|
---|
265 | return
|
---|
266 | }
|
---|
267 |
|
---|
268 | isProxy := false
|
---|
269 | if host, _, err := net.SplitHostPort(req.RemoteAddr); err == nil {
|
---|
270 | if ip := net.ParseIP(host); ip != nil {
|
---|
271 | isProxy = s.Config().AcceptProxyIPs.Contains(ip)
|
---|
272 | }
|
---|
273 | }
|
---|
274 |
|
---|
275 | // Only trust the Forwarded header field if this is a trusted proxy IP
|
---|
276 | // to prevent users from spoofing the remote address
|
---|
277 | remoteAddr := req.RemoteAddr
|
---|
278 | if isProxy {
|
---|
279 | forwarded := parseForwarded(req.Header)
|
---|
280 | if forwarded["for"] != "" {
|
---|
281 | remoteAddr = forwarded["for"]
|
---|
282 | }
|
---|
283 | }
|
---|
284 |
|
---|
285 | s.handle(newWebsocketIRCConn(conn, remoteAddr))
|
---|
286 | }
|
---|
287 |
|
---|
288 | func parseForwarded(h http.Header) map[string]string {
|
---|
289 | forwarded := h.Get("Forwarded")
|
---|
290 | if forwarded == "" {
|
---|
291 | return map[string]string{
|
---|
292 | "for": h.Get("X-Forwarded-For"),
|
---|
293 | "proto": h.Get("X-Forwarded-Proto"),
|
---|
294 | "host": h.Get("X-Forwarded-Host"),
|
---|
295 | }
|
---|
296 | }
|
---|
297 | // Hack to easily parse header parameters
|
---|
298 | _, params, _ := mime.ParseMediaType("hack; " + forwarded)
|
---|
299 | return params
|
---|
300 | }
|
---|
301 |
|
---|
302 | type ServerStats struct {
|
---|
303 | Users int
|
---|
304 | Downstreams int64
|
---|
305 | }
|
---|
306 |
|
---|
307 | func (s *Server) Stats() *ServerStats {
|
---|
308 | var stats ServerStats
|
---|
309 | s.lock.Lock()
|
---|
310 | stats.Users = len(s.users)
|
---|
311 | s.lock.Unlock()
|
---|
312 | stats.Downstreams = atomic.LoadInt64(&s.connCount)
|
---|
313 | return &stats
|
---|
314 | }
|
---|