You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

server.go 35KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106
  1. // Copyright (c) 2012-2014 Jeremy Latt
  2. // Copyright (c) 2014-2015 Edmund Huber
  3. // Copyright (c) 2016-2017 Daniel Oaks <daniel@danieloaks.net>
  4. // released under the MIT license
  5. package irc
  6. import (
  7. "bufio"
  8. "crypto/tls"
  9. "fmt"
  10. "net"
  11. "net/http"
  12. _ "net/http/pprof"
  13. "os"
  14. "os/signal"
  15. "strconv"
  16. "strings"
  17. "sync"
  18. "syscall"
  19. "time"
  20. "unsafe"
  21. "github.com/goshuirc/irc-go/ircfmt"
  22. "github.com/oragono/oragono/irc/caps"
  23. "github.com/oragono/oragono/irc/connection_limits"
  24. "github.com/oragono/oragono/irc/history"
  25. "github.com/oragono/oragono/irc/logger"
  26. "github.com/oragono/oragono/irc/modes"
  27. "github.com/oragono/oragono/irc/mysql"
  28. "github.com/oragono/oragono/irc/sno"
  29. "github.com/oragono/oragono/irc/utils"
  30. "github.com/tidwall/buntdb"
  31. )
  32. var (
  33. // common error line to sub values into
  34. errorMsg = "ERROR :%s\r\n"
  35. // supportedUserModesString acts as a cache for when we introduce users
  36. supportedUserModesString = modes.SupportedUserModes.String()
  37. // supportedChannelModesString acts as a cache for when we introduce users
  38. supportedChannelModesString = modes.SupportedChannelModes.String()
  39. // whitelist of caps to serve on the STS-only listener. In particular,
  40. // never advertise SASL, to discourage people from sending their passwords:
  41. stsOnlyCaps = caps.NewSet(caps.STS, caps.MessageTags, caps.ServerTime, caps.LabeledResponse, caps.Nope)
  42. // we only have standard channels for now. TODO: any updates to this
  43. // will also need to be reflected in CasefoldChannel
  44. chanTypes = "#"
  45. throttleMessage = "You have attempted to connect too many times within a short duration. Wait a while, and you will be able to connect."
  46. )
  47. // ListenerWrapper wraps a listener so it can be safely reconfigured or stopped
  48. type ListenerWrapper struct {
  49. // protects atomic update of config and shouldStop:
  50. sync.Mutex // tier 1
  51. listener net.Listener
  52. // optional WebSocket endpoint
  53. httpServer *http.Server
  54. config listenerConfig
  55. shouldStop bool
  56. }
  57. // Server is the main Oragono server.
  58. type Server struct {
  59. accounts AccountManager
  60. channels ChannelManager
  61. channelRegistry ChannelRegistry
  62. clients ClientManager
  63. config unsafe.Pointer
  64. configFilename string
  65. connectionLimiter connection_limits.Limiter
  66. ctime time.Time
  67. dlines *DLineManager
  68. helpIndexManager HelpIndexManager
  69. klines *KLineManager
  70. listeners map[string]*ListenerWrapper
  71. logger *logger.Manager
  72. monitorManager MonitorManager
  73. name string
  74. nameCasefolded string
  75. rehashMutex sync.Mutex // tier 4
  76. rehashSignal chan os.Signal
  77. pprofServer *http.Server
  78. resumeManager ResumeManager
  79. signals chan os.Signal
  80. snomasks SnoManager
  81. store *buntdb.DB
  82. historyDB mysql.MySQL
  83. torLimiter connection_limits.TorLimiter
  84. whoWas WhoWasList
  85. stats Stats
  86. semaphores ServerSemaphores
  87. }
  88. var (
  89. // ServerExitSignals are the signals the server will exit on.
  90. ServerExitSignals = []os.Signal{
  91. syscall.SIGINT,
  92. syscall.SIGTERM,
  93. syscall.SIGQUIT,
  94. }
  95. )
  96. type clientConn struct {
  97. Conn net.Conn
  98. Config listenerConfig
  99. }
  100. // NewServer returns a new Oragono server.
  101. func NewServer(config *Config, logger *logger.Manager) (*Server, error) {
  102. // initialize data structures
  103. server := &Server{
  104. ctime: time.Now().UTC(),
  105. listeners: make(map[string]*ListenerWrapper),
  106. logger: logger,
  107. rehashSignal: make(chan os.Signal, 1),
  108. signals: make(chan os.Signal, len(ServerExitSignals)),
  109. }
  110. server.clients.Initialize()
  111. server.semaphores.Initialize()
  112. server.resumeManager.Initialize(server)
  113. server.whoWas.Initialize(config.Limits.WhowasEntries)
  114. server.monitorManager.Initialize()
  115. server.snomasks.Initialize()
  116. if err := server.applyConfig(config); err != nil {
  117. return nil, err
  118. }
  119. // Attempt to clean up when receiving these signals.
  120. signal.Notify(server.signals, ServerExitSignals...)
  121. signal.Notify(server.rehashSignal, syscall.SIGHUP)
  122. return server, nil
  123. }
  124. // Shutdown shuts down the server.
  125. func (server *Server) Shutdown() {
  126. //TODO(dan): Make sure we disallow new nicks
  127. for _, client := range server.clients.AllClients() {
  128. client.Notice("Server is shutting down")
  129. }
  130. if err := server.store.Close(); err != nil {
  131. server.logger.Error("shutdown", fmt.Sprintln("Could not close datastore:", err))
  132. }
  133. server.historyDB.Close()
  134. }
  135. // Run starts the server.
  136. func (server *Server) Run() {
  137. // defer closing db/store
  138. defer server.store.Close()
  139. for {
  140. select {
  141. case <-server.signals:
  142. server.Shutdown()
  143. return
  144. case <-server.rehashSignal:
  145. go func() {
  146. server.logger.Info("server", "Rehashing due to SIGHUP")
  147. err := server.rehash()
  148. if err != nil {
  149. server.logger.Error("server", fmt.Sprintln("Failed to rehash:", err.Error()))
  150. }
  151. }()
  152. }
  153. }
  154. }
  155. func (server *Server) checkBans(ipaddr net.IP) (banned bool, message string) {
  156. // check DLINEs
  157. isBanned, info := server.dlines.CheckIP(ipaddr)
  158. if isBanned {
  159. server.logger.Info("connect-ip", fmt.Sprintf("Client from %v rejected by d-line", ipaddr))
  160. return true, info.BanMessage("You are banned from this server (%s)")
  161. }
  162. // check connection limits
  163. err := server.connectionLimiter.AddClient(ipaddr)
  164. if err == connection_limits.ErrLimitExceeded {
  165. // too many connections from one client, tell the client and close the connection
  166. server.logger.Info("connect-ip", fmt.Sprintf("Client from %v rejected for connection limit", ipaddr))
  167. return true, "Too many clients from your network"
  168. } else if err == connection_limits.ErrThrottleExceeded {
  169. duration := server.Config().Server.IPLimits.BanDuration
  170. if duration == 0 {
  171. return false, ""
  172. }
  173. server.dlines.AddIP(ipaddr, duration, throttleMessage, "Exceeded automated connection throttle", "auto.connection.throttler")
  174. // they're DLINE'd for 15 minutes or whatever, so we can reset the connection throttle now,
  175. // and once their temporary DLINE is finished they can fill up the throttler again
  176. server.connectionLimiter.ResetThrottle(ipaddr)
  177. // this might not show up properly on some clients, but our objective here is just to close it out before it has a load impact on us
  178. server.logger.Info(
  179. "connect-ip",
  180. fmt.Sprintf("Client from %v exceeded connection throttle, d-lining for %v", ipaddr, duration))
  181. return true, throttleMessage
  182. } else if err != nil {
  183. server.logger.Warning("internal", "unexpected ban result", err.Error())
  184. }
  185. return false, ""
  186. }
  187. func (server *Server) checkTorLimits() (banned bool, message string) {
  188. switch server.torLimiter.AddClient() {
  189. case connection_limits.ErrLimitExceeded:
  190. return true, "Too many clients from the Tor network"
  191. case connection_limits.ErrThrottleExceeded:
  192. return true, "Exceeded connection throttle for the Tor network"
  193. default:
  194. return false, ""
  195. }
  196. }
  197. //
  198. // IRC protocol listeners
  199. //
  200. // createListener starts a given listener.
  201. func (server *Server) createListener(addr string, conf listenerConfig, bindMode os.FileMode) (*ListenerWrapper, error) {
  202. if conf.WebSocket {
  203. return server.createWSListener(addr, conf)
  204. }
  205. return server.createNetListener(addr, conf, bindMode)
  206. }
  207. func (server *Server) isTrusted(ip string) bool {
  208. netIP := net.ParseIP(ip)
  209. return utils.IPInNets(netIP, server.Config().Server.proxyAllowedFromNets)
  210. }
  211. func (server *Server) followHTTPForwards(addr string, forwards string) string {
  212. if !server.isTrusted(addr) {
  213. return addr
  214. }
  215. forwardIPs := strings.Split(forwards, ",")
  216. // Iterate backwards to have the inner-most proxy first.
  217. for i := len(forwardIPs) - 1; i >= 0; i-- {
  218. // Using i so that addr points to the last item after the end of the loop.
  219. addr = forwardIPs[i]
  220. if !server.isTrusted(addr) {
  221. return addr
  222. }
  223. }
  224. // All IPs are trusted? weird. Let's take the last one and call it a day.
  225. return addr
  226. }
  227. // createWSListener starts a given WebSocket listener.
  228. func (server *Server) createWSListener(addr string, conf listenerConfig) (*ListenerWrapper, error) {
  229. var listener net.Listener
  230. var err error
  231. handler := func(w http.ResponseWriter, r *http.Request) {
  232. remoteAddr := r.RemoteAddr
  233. if header, ok := r.Header["X-Forwarded-For"]; ok {
  234. remoteAddr = server.followHTTPForwards(remoteAddr, header[len(header)-1])
  235. }
  236. conn, err := wsUpgrader.Upgrade(w, r, nil)
  237. if err != nil {
  238. server.logger.Error("internal", "upgrade error", addr, err.Error())
  239. return
  240. }
  241. newConn := clientConn{
  242. Conn: WSContainer{conn},
  243. Config: conf,
  244. }
  245. server.RunClient(newConn, "")
  246. }
  247. endpoint := http.Server{
  248. Addr: addr,
  249. Handler: http.HandlerFunc(handler),
  250. ReadTimeout: 10 * time.Second,
  251. WriteTimeout: 10 * time.Second,
  252. MaxHeaderBytes: 1 << 20,
  253. }
  254. if conf.TLSConfig != nil {
  255. listener, err = tls.Listen("tcp", addr, conf.TLSConfig)
  256. } else {
  257. listener, err = net.Listen("tcp", addr)
  258. }
  259. if err != nil {
  260. return nil, err
  261. }
  262. // throw our details to the server so we can be modified/killed later
  263. wrapper := ListenerWrapper{
  264. listener: listener,
  265. httpServer: &endpoint,
  266. config: conf,
  267. shouldStop: false,
  268. }
  269. go func() {
  270. err := endpoint.Serve(listener)
  271. if err != nil {
  272. server.logger.Error("internal", "Failed to start WebSocket listener on", addr)
  273. }
  274. }()
  275. return &wrapper, nil
  276. }
  277. // createNetListener starts a given unix or TCP listener.
  278. func (server *Server) createNetListener(addr string, conf listenerConfig, bindMode os.FileMode) (*ListenerWrapper, error) {
  279. var listener net.Listener
  280. var err error
  281. addr = strings.TrimPrefix(addr, "unix:")
  282. if strings.HasPrefix(addr, "/") {
  283. // https://stackoverflow.com/a/34881585
  284. os.Remove(addr)
  285. listener, err = net.Listen("unix", addr)
  286. if err == nil && bindMode != 0 {
  287. os.Chmod(addr, bindMode)
  288. }
  289. } else {
  290. listener, err = net.Listen("tcp", addr)
  291. }
  292. if err != nil {
  293. return nil, err
  294. }
  295. // throw our details to the server so we can be modified/killed later
  296. wrapper := ListenerWrapper{
  297. listener: listener,
  298. config: conf,
  299. shouldStop: false,
  300. }
  301. var shouldStop bool
  302. // setup accept goroutine
  303. go func() {
  304. for {
  305. conn, err := listener.Accept()
  306. // synchronously access config data:
  307. wrapper.Lock()
  308. shouldStop = wrapper.shouldStop
  309. conf := wrapper.config
  310. wrapper.Unlock()
  311. if shouldStop {
  312. if conn != nil {
  313. conn.Close()
  314. }
  315. listener.Close()
  316. return
  317. } else if err == nil {
  318. var proxyLine string
  319. if conf.ProxyBeforeTLS {
  320. proxyLine = readRawProxyLine(conn)
  321. if proxyLine == "" {
  322. server.logger.Error("internal", "bad TLS-proxy line from", addr)
  323. conn.Close()
  324. continue
  325. }
  326. }
  327. if conf.TLSConfig != nil {
  328. conn = tls.Server(conn, conf.TLSConfig)
  329. }
  330. newConn := clientConn{
  331. Conn: conn,
  332. Config: conf,
  333. }
  334. // hand off the connection
  335. go server.RunClient(newConn, proxyLine)
  336. } else {
  337. server.logger.Error("internal", "accept error", addr, err.Error())
  338. }
  339. }
  340. }()
  341. return &wrapper, nil
  342. }
  343. //
  344. // server functionality
  345. //
  346. func (server *Server) tryRegister(c *Client, session *Session) (exiting bool) {
  347. // if the session just sent us a RESUME line, try to resume
  348. if session.resumeDetails != nil {
  349. session.tryResume()
  350. return // whether we succeeded or failed, either way `c` is not getting registered
  351. }
  352. // try to complete registration normally
  353. if c.preregNick == "" || !c.HasUsername() || session.capState == caps.NegotiatingState {
  354. return
  355. }
  356. if c.isSTSOnly {
  357. server.playRegistrationBurst(session)
  358. return true
  359. }
  360. // client MUST send PASS if necessary, or authenticate with SASL if necessary,
  361. // before completing the other registration commands
  362. authOutcome := c.isAuthorized(server.Config(), session)
  363. var quitMessage string
  364. switch authOutcome {
  365. case authFailPass:
  366. quitMessage = c.t("Password incorrect")
  367. c.Send(nil, server.name, ERR_PASSWDMISMATCH, "*", quitMessage)
  368. case authFailSaslRequired, authFailTorSaslRequired:
  369. quitMessage = c.t("You must log in with SASL to join this server")
  370. c.Send(nil, c.server.name, "FAIL", "*", "ACCOUNT_REQUIRED", quitMessage)
  371. }
  372. if authOutcome != authSuccess {
  373. c.Quit(quitMessage, nil)
  374. return true
  375. }
  376. // we have the final value of the IP address: do the hostname lookup
  377. // (nickmask will be set below once nickname assignment succeeds)
  378. if session.rawHostname == "" {
  379. session.client.lookupHostname(session, false)
  380. }
  381. rb := NewResponseBuffer(session)
  382. nickAssigned := performNickChange(server, c, c, session, c.preregNick, rb)
  383. rb.Send(true)
  384. if !nickAssigned {
  385. c.preregNick = ""
  386. return
  387. }
  388. if session.client != c {
  389. // reattached, bail out.
  390. // we'll play the reg burst later, on the new goroutine associated with
  391. // (thisSession, otherClient). This is to avoid having to transfer state
  392. // like nickname, hostname, etc. to show the correct values in the reg burst.
  393. return
  394. }
  395. // check KLINEs
  396. isBanned, info := server.klines.CheckMasks(c.AllNickmasks()...)
  397. if isBanned {
  398. c.Quit(info.BanMessage(c.t("You are banned from this server (%s)")), nil)
  399. return true
  400. }
  401. // registration has succeeded:
  402. c.SetRegistered()
  403. // count new user in statistics
  404. server.stats.Register()
  405. server.monitorManager.AlertAbout(c, true)
  406. server.playRegistrationBurst(session)
  407. return false
  408. }
  409. func (server *Server) playRegistrationBurst(session *Session) {
  410. c := session.client
  411. // continue registration
  412. d := c.Details()
  413. server.logger.Info("connect", fmt.Sprintf("Client connected [%s] [u:%s] [r:%s]", d.nick, d.username, d.realname))
  414. server.snomasks.Send(sno.LocalConnects, fmt.Sprintf("Client connected [%s] [u:%s] [h:%s] [ip:%s] [r:%s]", d.nick, d.username, session.rawHostname, session.IP().String(), d.realname))
  415. // send welcome text
  416. //NOTE(dan): we specifically use the NICK here instead of the nickmask
  417. // see http://modern.ircdocs.horse/#rplwelcome-001 for details on why we avoid using the nickmask
  418. session.Send(nil, server.name, RPL_WELCOME, d.nick, fmt.Sprintf(c.t("Welcome to the Internet Relay Network %s"), d.nick))
  419. session.Send(nil, server.name, RPL_YOURHOST, d.nick, fmt.Sprintf(c.t("Your host is %[1]s, running version %[2]s"), server.name, Ver))
  420. session.Send(nil, server.name, RPL_CREATED, d.nick, fmt.Sprintf(c.t("This server was created %s"), server.ctime.Format(time.RFC1123)))
  421. //TODO(dan): Look at adding last optional [<channel modes with a parameter>] parameter
  422. session.Send(nil, server.name, RPL_MYINFO, d.nick, server.name, Ver, supportedUserModesString, supportedChannelModesString)
  423. if c.isSTSOnly {
  424. for _, line := range server.Config().Server.STS.bannerLines {
  425. c.Notice(line)
  426. }
  427. return
  428. }
  429. rb := NewResponseBuffer(session)
  430. server.RplISupport(c, rb)
  431. server.Lusers(c, rb)
  432. server.MOTD(c, rb)
  433. rb.Send(true)
  434. modestring := c.ModeString()
  435. if modestring != "+" {
  436. session.Send(nil, server.name, RPL_UMODEIS, d.nick, modestring)
  437. }
  438. c.attemptAutoOper(session)
  439. if server.logger.IsLoggingRawIO() {
  440. session.Send(nil, c.server.name, "NOTICE", d.nick, c.t("This server is in debug mode and is logging all user I/O. If you do not wish for everything you send to be readable by the server owner(s), please disconnect."))
  441. }
  442. // #572: defer nick warnings to the end of the registration burst
  443. session.client.nickTimer.Touch(nil)
  444. }
  445. // RplISupport outputs our ISUPPORT lines to the client. This is used on connection and in VERSION responses.
  446. func (server *Server) RplISupport(client *Client, rb *ResponseBuffer) {
  447. translatedISupport := client.t("are supported by this server")
  448. nick := client.Nick()
  449. config := server.Config()
  450. for _, cachedTokenLine := range config.Server.isupport.CachedReply {
  451. length := len(cachedTokenLine) + 2
  452. tokenline := make([]string, length)
  453. tokenline[0] = nick
  454. copy(tokenline[1:], cachedTokenLine)
  455. tokenline[length-1] = translatedISupport
  456. rb.Add(nil, server.name, RPL_ISUPPORT, tokenline...)
  457. }
  458. }
  459. func (server *Server) Lusers(client *Client, rb *ResponseBuffer) {
  460. nick := client.Nick()
  461. stats := server.stats.GetValues()
  462. rb.Add(nil, server.name, RPL_LUSERCLIENT, nick, fmt.Sprintf(client.t("There are %[1]d users and %[2]d invisible on %[3]d server(s)"), stats.Total-stats.Invisible, stats.Invisible, 1))
  463. rb.Add(nil, server.name, RPL_LUSEROP, nick, strconv.Itoa(stats.Operators), client.t("IRC Operators online"))
  464. rb.Add(nil, server.name, RPL_LUSERUNKNOWN, nick, strconv.Itoa(stats.Unknown), client.t("unregistered connections"))
  465. rb.Add(nil, server.name, RPL_LUSERCHANNELS, nick, strconv.Itoa(server.channels.Len()), client.t("channels formed"))
  466. rb.Add(nil, server.name, RPL_LUSERME, nick, fmt.Sprintf(client.t("I have %[1]d clients and %[2]d servers"), stats.Total, 0))
  467. total := strconv.Itoa(stats.Total)
  468. max := strconv.Itoa(stats.Max)
  469. rb.Add(nil, server.name, RPL_LOCALUSERS, nick, total, max, fmt.Sprintf(client.t("Current local users %[1]s, max %[2]s"), total, max))
  470. rb.Add(nil, server.name, RPL_GLOBALUSERS, nick, total, max, fmt.Sprintf(client.t("Current global users %[1]s, max %[2]s"), total, max))
  471. }
  472. // MOTD serves the Message of the Day.
  473. func (server *Server) MOTD(client *Client, rb *ResponseBuffer) {
  474. motdLines := server.Config().Server.motdLines
  475. if len(motdLines) < 1 {
  476. rb.Add(nil, server.name, ERR_NOMOTD, client.nick, client.t("MOTD File is missing"))
  477. return
  478. }
  479. rb.Add(nil, server.name, RPL_MOTDSTART, client.nick, fmt.Sprintf(client.t("- %s Message of the day - "), server.name))
  480. for _, line := range motdLines {
  481. rb.Add(nil, server.name, RPL_MOTD, client.nick, line)
  482. }
  483. rb.Add(nil, server.name, RPL_ENDOFMOTD, client.nick, client.t("End of MOTD command"))
  484. }
  485. // WhoisChannelsNames returns the common channel names between two users.
  486. func (client *Client) WhoisChannelsNames(target *Client, multiPrefix bool) []string {
  487. var chstrs []string
  488. for _, channel := range target.Channels() {
  489. // channel is secret and the target can't see it
  490. if !client.HasMode(modes.Operator) {
  491. if (target.HasMode(modes.Invisible) || channel.flags.HasMode(modes.Secret)) && !channel.hasClient(client) {
  492. continue
  493. }
  494. }
  495. chstrs = append(chstrs, channel.ClientPrefixes(target, multiPrefix)+channel.name)
  496. }
  497. return chstrs
  498. }
  499. func (client *Client) getWhoisOf(target *Client, rb *ResponseBuffer) {
  500. cnick := client.Nick()
  501. targetInfo := target.Details()
  502. rb.Add(nil, client.server.name, RPL_WHOISUSER, cnick, targetInfo.nick, targetInfo.username, targetInfo.hostname, "*", targetInfo.realname)
  503. tnick := targetInfo.nick
  504. whoischannels := client.WhoisChannelsNames(target, rb.session.capabilities.Has(caps.MultiPrefix))
  505. if whoischannels != nil {
  506. rb.Add(nil, client.server.name, RPL_WHOISCHANNELS, cnick, tnick, strings.Join(whoischannels, " "))
  507. }
  508. tOper := target.Oper()
  509. if tOper != nil {
  510. rb.Add(nil, client.server.name, RPL_WHOISOPERATOR, cnick, tnick, tOper.WhoisLine)
  511. }
  512. if client.HasMode(modes.Operator) || client == target {
  513. rb.Add(nil, client.server.name, RPL_WHOISACTUALLY, cnick, tnick, fmt.Sprintf("%s@%s", targetInfo.username, target.RawHostname()), target.IPString(), client.t("Actual user@host, Actual IP"))
  514. }
  515. if target.HasMode(modes.TLS) {
  516. rb.Add(nil, client.server.name, RPL_WHOISSECURE, cnick, tnick, client.t("is using a secure connection"))
  517. }
  518. if targetInfo.accountName != "*" {
  519. rb.Add(nil, client.server.name, RPL_WHOISACCOUNT, cnick, tnick, targetInfo.accountName, client.t("is logged in as"))
  520. }
  521. if target.HasMode(modes.Bot) {
  522. rb.Add(nil, client.server.name, RPL_WHOISBOT, cnick, tnick, ircfmt.Unescape(fmt.Sprintf(client.t("is a $bBot$b on %s"), client.server.Config().Network.Name)))
  523. }
  524. if client == target || client.HasMode(modes.Operator) {
  525. for _, session := range target.Sessions() {
  526. if session.certfp != "" {
  527. rb.Add(nil, client.server.name, RPL_WHOISCERTFP, cnick, tnick, fmt.Sprintf(client.t("has client certificate fingerprint %s"), session.certfp))
  528. }
  529. }
  530. }
  531. rb.Add(nil, client.server.name, RPL_WHOISIDLE, cnick, tnick, strconv.FormatUint(target.IdleSeconds(), 10), strconv.FormatInt(target.SignonTime(), 10), client.t("seconds idle, signon time"))
  532. if target.Away() {
  533. rb.Add(nil, client.server.name, RPL_AWAY, cnick, tnick, target.AwayMessage())
  534. }
  535. }
  536. // rplWhoReply returns the WHO reply between one user and another channel/user.
  537. // <channel> <user> <host> <server> <nick> ( "H" / "G" ) ["*"] [ ( "@" / "+" ) ]
  538. // :<hopcount> <real name>
  539. func (client *Client) rplWhoReply(channel *Channel, target *Client, rb *ResponseBuffer) {
  540. channelName := "*"
  541. flags := ""
  542. if target.Away() {
  543. flags = "G"
  544. } else {
  545. flags = "H"
  546. }
  547. if target.HasMode(modes.Operator) {
  548. flags += "*"
  549. }
  550. if channel != nil {
  551. // TODO is this right?
  552. flags += channel.ClientPrefixes(target, rb.session.capabilities.Has(caps.MultiPrefix))
  553. channelName = channel.name
  554. }
  555. details := target.Details()
  556. // hardcode a hopcount of 0 for now
  557. rb.Add(nil, client.server.name, RPL_WHOREPLY, client.Nick(), channelName, details.username, details.hostname, client.server.name, details.nick, flags, "0 "+details.realname)
  558. }
  559. // rehash reloads the config and applies the changes from the config file.
  560. func (server *Server) rehash() error {
  561. server.logger.Debug("server", "Starting rehash")
  562. // only let one REHASH go on at a time
  563. server.rehashMutex.Lock()
  564. defer server.rehashMutex.Unlock()
  565. server.logger.Debug("server", "Got rehash lock")
  566. config, err := LoadConfig(server.configFilename)
  567. if err != nil {
  568. return fmt.Errorf("Error loading config file config: %s", err.Error())
  569. }
  570. err = server.applyConfig(config)
  571. if err != nil {
  572. return fmt.Errorf("Error applying config changes: %s", err.Error())
  573. }
  574. return nil
  575. }
  576. func (server *Server) applyConfig(config *Config) (err error) {
  577. oldConfig := server.Config()
  578. initial := oldConfig == nil
  579. if initial {
  580. server.configFilename = config.Filename
  581. server.name = config.Server.Name
  582. server.nameCasefolded = config.Server.nameCasefolded
  583. globalCasemappingSetting = config.Server.Casemapping
  584. } else {
  585. // enforce configs that can't be changed after launch:
  586. if server.name != config.Server.Name {
  587. return fmt.Errorf("Server name cannot be changed after launching the server, rehash aborted")
  588. } else if oldConfig.Datastore.Path != config.Datastore.Path {
  589. return fmt.Errorf("Datastore path cannot be changed after launching the server, rehash aborted")
  590. } else if globalCasemappingSetting != config.Server.Casemapping {
  591. return fmt.Errorf("Casemapping cannot be changed after launching the server, rehash aborted")
  592. } else if oldConfig.Accounts.Multiclient.AlwaysOn != config.Accounts.Multiclient.AlwaysOn {
  593. return fmt.Errorf("Default always-on setting cannot be changed after launching the server, rehash aborted")
  594. }
  595. }
  596. server.logger.Info("server", "Using config file", server.configFilename)
  597. // first, reload config sections for functionality implemented in subpackages:
  598. wasLoggingRawIO := !initial && server.logger.IsLoggingRawIO()
  599. err = server.logger.ApplyConfig(config.Logging)
  600. if err != nil {
  601. return err
  602. }
  603. nowLoggingRawIO := server.logger.IsLoggingRawIO()
  604. // notify existing clients if raw i/o logging was enabled by a rehash
  605. sendRawOutputNotice := !wasLoggingRawIO && nowLoggingRawIO
  606. server.connectionLimiter.ApplyConfig(&config.Server.IPLimits)
  607. tlConf := &config.Server.TorListeners
  608. server.torLimiter.Configure(tlConf.MaxConnections, tlConf.ThrottleDuration, tlConf.MaxConnectionsPerDuration)
  609. // Translations
  610. server.logger.Debug("server", "Regenerating HELP indexes for new languages")
  611. server.helpIndexManager.GenerateIndices(config.languageManager)
  612. if oldConfig != nil {
  613. // if certain features were enabled by rehash, we need to load the corresponding data
  614. // from the store
  615. if !oldConfig.Accounts.NickReservation.Enabled {
  616. server.accounts.buildNickToAccountIndex(config)
  617. }
  618. if !oldConfig.Accounts.VHosts.Enabled {
  619. server.accounts.initVHostRequestQueue(config)
  620. }
  621. if !oldConfig.Channels.Registration.Enabled {
  622. server.channels.loadRegisteredChannels(config)
  623. }
  624. // resize history buffers as needed
  625. if oldConfig.History != config.History {
  626. for _, channel := range server.channels.Channels() {
  627. channel.resizeHistory(config)
  628. }
  629. for _, client := range server.clients.AllClients() {
  630. client.resizeHistory(config)
  631. }
  632. }
  633. if oldConfig.Accounts.Registration.Throttling != config.Accounts.Registration.Throttling {
  634. server.accounts.resetRegisterThrottle(config)
  635. }
  636. }
  637. // activate the new config
  638. server.SetConfig(config)
  639. // burst new and removed caps
  640. addedCaps, removedCaps := config.Diff(oldConfig)
  641. var capBurstSessions []*Session
  642. added := make(map[caps.Version][]string)
  643. var removed []string
  644. if !addedCaps.Empty() || !removedCaps.Empty() {
  645. capBurstSessions = server.clients.AllWithCapsNotify()
  646. added[caps.Cap301] = addedCaps.Strings(caps.Cap301, config.Server.capValues, 0)
  647. added[caps.Cap302] = addedCaps.Strings(caps.Cap302, config.Server.capValues, 0)
  648. // removed never has values, so we leave it as Cap301
  649. removed = removedCaps.Strings(caps.Cap301, config.Server.capValues, 0)
  650. }
  651. for _, sSession := range capBurstSessions {
  652. // DEL caps and then send NEW ones so that updated caps get removed/added correctly
  653. if !removedCaps.Empty() {
  654. for _, capStr := range removed {
  655. sSession.Send(nil, server.name, "CAP", sSession.client.Nick(), "DEL", capStr)
  656. }
  657. }
  658. if !addedCaps.Empty() {
  659. for _, capStr := range added[sSession.capVersion] {
  660. sSession.Send(nil, server.name, "CAP", sSession.client.Nick(), "NEW", capStr)
  661. }
  662. }
  663. }
  664. server.logger.Info("server", "Using datastore", config.Datastore.Path)
  665. if initial {
  666. if err := server.loadDatastore(config); err != nil {
  667. return err
  668. }
  669. } else {
  670. if config.Datastore.MySQL.Enabled && config.Datastore.MySQL != oldConfig.Datastore.MySQL {
  671. server.historyDB.SetConfig(config.Datastore.MySQL)
  672. }
  673. }
  674. server.setupPprofListener(config)
  675. // set RPL_ISUPPORT
  676. var newISupportReplies [][]string
  677. if oldConfig != nil {
  678. newISupportReplies = oldConfig.Server.isupport.GetDifference(&config.Server.isupport)
  679. }
  680. // we are now open for business
  681. err = server.setupListeners(config)
  682. if !initial {
  683. // push new info to all of our clients
  684. for _, sClient := range server.clients.AllClients() {
  685. for _, tokenline := range newISupportReplies {
  686. sClient.Send(nil, server.name, RPL_ISUPPORT, append([]string{sClient.nick}, tokenline...)...)
  687. }
  688. if sendRawOutputNotice {
  689. sClient.Notice(sClient.t("This server is in debug mode and is logging all user I/O. If you do not wish for everything you send to be readable by the server owner(s), please disconnect."))
  690. }
  691. if !oldConfig.Accounts.NickReservation.Enabled && config.Accounts.NickReservation.Enabled {
  692. sClient.nickTimer.Initialize(sClient)
  693. sClient.nickTimer.Touch(nil)
  694. } else if oldConfig.Accounts.NickReservation.Enabled && !config.Accounts.NickReservation.Enabled {
  695. sClient.nickTimer.Stop()
  696. }
  697. }
  698. }
  699. return err
  700. }
  701. func (server *Server) setupPprofListener(config *Config) {
  702. pprofListener := ""
  703. if config.Debug.PprofListener != nil {
  704. pprofListener = *config.Debug.PprofListener
  705. }
  706. if server.pprofServer != nil {
  707. if pprofListener == "" || (pprofListener != server.pprofServer.Addr) {
  708. server.logger.Info("server", "Stopping pprof listener", server.pprofServer.Addr)
  709. server.pprofServer.Close()
  710. server.pprofServer = nil
  711. }
  712. }
  713. if pprofListener != "" && server.pprofServer == nil {
  714. ps := http.Server{
  715. Addr: pprofListener,
  716. }
  717. go func() {
  718. if err := ps.ListenAndServe(); err != nil {
  719. server.logger.Error("server", "pprof listener failed", err.Error())
  720. }
  721. }()
  722. server.pprofServer = &ps
  723. server.logger.Info("server", "Started pprof listener", server.pprofServer.Addr)
  724. }
  725. }
  726. func (config *Config) loadMOTD() (err error) {
  727. if config.Server.MOTD != "" {
  728. file, err := os.Open(config.Server.MOTD)
  729. if err == nil {
  730. defer file.Close()
  731. reader := bufio.NewReader(file)
  732. for {
  733. line, err := reader.ReadString('\n')
  734. if err != nil {
  735. break
  736. }
  737. line = strings.TrimRight(line, "\r\n")
  738. if config.Server.MOTDFormatting {
  739. line = ircfmt.Unescape(line)
  740. }
  741. // "- " is the required prefix for MOTD, we just add it here to make
  742. // bursting it out to clients easier
  743. line = fmt.Sprintf("- %s", line)
  744. config.Server.motdLines = append(config.Server.motdLines, line)
  745. }
  746. }
  747. }
  748. return
  749. }
  750. func (server *Server) loadDatastore(config *Config) error {
  751. // open the datastore and load server state for which it (rather than config)
  752. // is the source of truth
  753. _, err := os.Stat(config.Datastore.Path)
  754. if os.IsNotExist(err) {
  755. server.logger.Warning("server", "database does not exist, creating it", config.Datastore.Path)
  756. err = initializeDB(config.Datastore.Path)
  757. if err != nil {
  758. return err
  759. }
  760. }
  761. db, err := OpenDatabase(config)
  762. if err == nil {
  763. server.store = db
  764. } else {
  765. return fmt.Errorf("Failed to open datastore: %s", err.Error())
  766. }
  767. // load *lines (from the datastores)
  768. server.logger.Debug("server", "Loading D/Klines")
  769. server.loadDLines()
  770. server.loadKLines()
  771. server.channelRegistry.Initialize(server)
  772. server.channels.Initialize(server)
  773. server.accounts.Initialize(server)
  774. if config.Datastore.MySQL.Enabled {
  775. server.historyDB.Initialize(server.logger, config.Datastore.MySQL)
  776. err = server.historyDB.Open()
  777. if err != nil {
  778. server.logger.Error("internal", "could not connect to mysql", err.Error())
  779. return err
  780. }
  781. }
  782. return nil
  783. }
  784. func (server *Server) setupListeners(config *Config) (err error) {
  785. logListener := func(addr string, config listenerConfig) {
  786. server.logger.Info("listeners",
  787. fmt.Sprintf("now listening on %s, tls=%t, tlsproxy=%t, tor=%t, websocket=%t.", addr, (config.TLSConfig != nil), config.ProxyBeforeTLS, config.Tor, config.WebSocket),
  788. )
  789. }
  790. // update or destroy all existing listeners
  791. for addr := range server.listeners {
  792. currentListener := server.listeners[addr]
  793. newConfig, stillConfigured := config.Server.trueListeners[addr]
  794. currentListener.Lock()
  795. currentListener.shouldStop = !stillConfigured
  796. currentListener.config = newConfig
  797. currentListener.Unlock()
  798. if stillConfigured {
  799. logListener(addr, newConfig)
  800. } else {
  801. // tell the listener it should stop by interrupting its Accept() call:
  802. currentListener.listener.Close()
  803. delete(server.listeners, addr)
  804. server.logger.Info("listeners", fmt.Sprintf("stopped listening on %s.", addr))
  805. }
  806. }
  807. publicPlaintextListener := ""
  808. // create new listeners that were not previously configured
  809. for newAddr, newConfig := range config.Server.trueListeners {
  810. if strings.HasPrefix(newAddr, ":") && !newConfig.Tor && !newConfig.STSOnly && newConfig.TLSConfig == nil {
  811. publicPlaintextListener = newAddr
  812. }
  813. _, exists := server.listeners[newAddr]
  814. if !exists {
  815. // make new listener
  816. listener, listenerErr := server.createListener(newAddr, newConfig, config.Server.UnixBindMode)
  817. if listenerErr != nil {
  818. server.logger.Error("server", "couldn't listen on", newAddr, listenerErr.Error())
  819. err = listenerErr
  820. continue
  821. }
  822. server.listeners[newAddr] = listener
  823. logListener(newAddr, newConfig)
  824. }
  825. }
  826. if publicPlaintextListener != "" {
  827. server.logger.Warning("listeners", fmt.Sprintf("Your server is configured with public plaintext listener %s. Consider disabling it for improved security and privacy.", publicPlaintextListener))
  828. }
  829. return
  830. }
  831. // Gets the abstract sequence from which we're going to query history;
  832. // we may already know the channel we're querying, or we may have
  833. // to look it up via a string query. This function is responsible for
  834. // privilege checking.
  835. func (server *Server) GetHistorySequence(providedChannel *Channel, client *Client, query string) (channel *Channel, sequence history.Sequence, err error) {
  836. config := server.Config()
  837. // 4 cases: {persistent, ephemeral} x {normal, conversation}
  838. // with ephemeral history, target is implicit in the choice of `hist`,
  839. // and correspondent is "" if we're retrieving a channel or *, and the correspondent's name
  840. // if we're retrieving a DM conversation ("query buffer"). with persistent history,
  841. // target is always nonempty, and correspondent is either empty or nonempty as before.
  842. var status HistoryStatus
  843. var target, correspondent string
  844. var hist *history.Buffer
  845. channel = providedChannel
  846. if channel == nil {
  847. if strings.HasPrefix(query, "#") {
  848. channel = server.channels.Get(query)
  849. if channel == nil {
  850. return
  851. }
  852. }
  853. }
  854. if channel != nil {
  855. if !channel.hasClient(client) {
  856. err = errInsufficientPrivs
  857. return
  858. }
  859. status, target = channel.historyStatus(config)
  860. switch status {
  861. case HistoryEphemeral:
  862. hist = &channel.history
  863. case HistoryPersistent:
  864. // already set `target`
  865. default:
  866. return
  867. }
  868. } else {
  869. status, target = client.historyStatus(config)
  870. if query != "*" {
  871. correspondent, err = CasefoldName(query)
  872. if err != nil {
  873. return
  874. }
  875. }
  876. switch status {
  877. case HistoryEphemeral:
  878. hist = &client.history
  879. case HistoryPersistent:
  880. // already set `target`, and `correspondent` if necessary
  881. default:
  882. return
  883. }
  884. }
  885. var cutoff time.Time
  886. if config.History.Restrictions.ExpireTime != 0 {
  887. cutoff = time.Now().UTC().Add(-time.Duration(config.History.Restrictions.ExpireTime))
  888. }
  889. // #836: registration date cutoff is always enforced for DMs
  890. if config.History.Restrictions.EnforceRegistrationDate || channel == nil {
  891. regCutoff := client.historyCutoff()
  892. // take the later of the two cutoffs
  893. if regCutoff.After(cutoff) {
  894. cutoff = regCutoff
  895. }
  896. }
  897. // #836 again: grace period is never applied to DMs
  898. if !cutoff.IsZero() && channel != nil {
  899. cutoff = cutoff.Add(-time.Duration(config.History.Restrictions.GracePeriod))
  900. }
  901. if hist != nil {
  902. sequence = hist.MakeSequence(correspondent, cutoff)
  903. } else if target != "" {
  904. sequence = server.historyDB.MakeSequence(target, correspondent, cutoff)
  905. }
  906. return
  907. }
  908. // elistMatcher takes and matches ELIST conditions
  909. type elistMatcher struct {
  910. MinClientsActive bool
  911. MinClients int
  912. MaxClientsActive bool
  913. MaxClients int
  914. }
  915. // Matches checks whether the given channel matches our matches.
  916. func (matcher *elistMatcher) Matches(channel *Channel) bool {
  917. if matcher.MinClientsActive {
  918. if len(channel.Members()) < matcher.MinClients {
  919. return false
  920. }
  921. }
  922. if matcher.MaxClientsActive {
  923. if len(channel.Members()) < len(channel.members) {
  924. return false
  925. }
  926. }
  927. return true
  928. }
  929. // RplList returns the RPL_LIST numeric for the given channel.
  930. func (target *Client) RplList(channel *Channel, rb *ResponseBuffer) {
  931. // get the correct number of channel members
  932. var memberCount int
  933. if target.HasMode(modes.Operator) || channel.hasClient(target) {
  934. memberCount = len(channel.Members())
  935. } else {
  936. for _, member := range channel.Members() {
  937. if !member.HasMode(modes.Invisible) {
  938. memberCount++
  939. }
  940. }
  941. }
  942. // #704: some channels are kept around even with no members
  943. if memberCount != 0 {
  944. rb.Add(nil, target.server.name, RPL_LIST, target.nick, channel.name, strconv.Itoa(memberCount), channel.topic)
  945. }
  946. }
  947. var (
  948. infoString1 = strings.Split(` ▄▄▄ ▄▄▄· ▄▄ • ▐ ▄
  949. ▪ ▀▄ █·▐█ ▀█ ▐█ ▀ ▪▪ •█▌▐█▪
  950. ▄█▀▄ ▐▀▀▄ ▄█▀▀█ ▄█ ▀█▄ ▄█▀▄▪▐█▐▐▌ ▄█▀▄
  951. ▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
  952. ▀█▄▀▪.▀ ▀ ▀ ▀ ·▀▀▀▀ ▀█▄▀ ▀▀ █▪ ▀█▄▀▪
  953. https://oragono.io/
  954. https://github.com/oragono/oragono
  955. https://crowdin.com/project/oragono
  956. `, "\n")
  957. infoString2 = strings.Split(` Daniel Oakley, DanielOaks, <daniel@danieloaks.net>
  958. Shivaram Lingamneni, slingamn, <slingamn@cs.stanford.edu>
  959. `, "\n")
  960. infoString3 = strings.Split(` Jeremy Latt, jlatt
  961. Edmund Huber, edmund-huber
  962. `, "\n")
  963. )