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 37KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054
  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. "fmt"
  8. "net"
  9. "net/http"
  10. _ "net/http/pprof"
  11. "os"
  12. "os/signal"
  13. "runtime/debug"
  14. "strconv"
  15. "strings"
  16. "sync"
  17. "syscall"
  18. "time"
  19. "unsafe"
  20. "github.com/goshuirc/irc-go/ircfmt"
  21. "github.com/oragono/oragono/irc/caps"
  22. "github.com/oragono/oragono/irc/connection_limits"
  23. "github.com/oragono/oragono/irc/flatip"
  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. const (
  33. alwaysOnExpirationPollPeriod = time.Hour
  34. )
  35. var (
  36. // common error line to sub values into
  37. errorMsg = "ERROR :%s\r\n"
  38. // three final parameters of 004 RPL_MYINFO, enumerating our supported modes
  39. rplMyInfo1, rplMyInfo2, rplMyInfo3 = modes.RplMyInfo()
  40. // CHANMODES isupport token
  41. chanmodesToken = modes.ChanmodesToken()
  42. // whitelist of caps to serve on the STS-only listener. In particular,
  43. // never advertise SASL, to discourage people from sending their passwords:
  44. stsOnlyCaps = caps.NewSet(caps.STS, caps.MessageTags, caps.ServerTime, caps.Batch, caps.LabeledResponse, caps.EchoMessage, caps.Nope)
  45. // we only have standard channels for now. TODO: any updates to this
  46. // will also need to be reflected in CasefoldChannel
  47. chanTypes = "#"
  48. throttleMessage = "You have attempted to connect too many times within a short duration. Wait a while, and you will be able to connect."
  49. )
  50. // Server is the main Oragono server.
  51. type Server struct {
  52. accounts AccountManager
  53. channels ChannelManager
  54. channelRegistry ChannelRegistry
  55. clients ClientManager
  56. config unsafe.Pointer
  57. configFilename string
  58. connectionLimiter connection_limits.Limiter
  59. ctime time.Time
  60. dlines *DLineManager
  61. helpIndexManager HelpIndexManager
  62. klines *KLineManager
  63. listeners map[string]IRCListener
  64. logger *logger.Manager
  65. monitorManager MonitorManager
  66. name string
  67. nameCasefolded string
  68. rehashMutex sync.Mutex // tier 4
  69. rehashSignal chan os.Signal
  70. pprofServer *http.Server
  71. resumeManager ResumeManager
  72. signals chan os.Signal
  73. snomasks SnoManager
  74. store *buntdb.DB
  75. historyDB mysql.MySQL
  76. torLimiter connection_limits.TorLimiter
  77. whoWas WhoWasList
  78. stats Stats
  79. semaphores ServerSemaphores
  80. defcon uint32
  81. }
  82. // NewServer returns a new Oragono server.
  83. func NewServer(config *Config, logger *logger.Manager) (*Server, error) {
  84. // initialize data structures
  85. server := &Server{
  86. ctime: time.Now().UTC(),
  87. listeners: make(map[string]IRCListener),
  88. logger: logger,
  89. rehashSignal: make(chan os.Signal, 1),
  90. signals: make(chan os.Signal, len(ServerExitSignals)),
  91. defcon: 5,
  92. }
  93. server.clients.Initialize()
  94. server.semaphores.Initialize()
  95. server.resumeManager.Initialize(server)
  96. server.whoWas.Initialize(config.Limits.WhowasEntries)
  97. server.monitorManager.Initialize()
  98. server.snomasks.Initialize()
  99. if err := server.applyConfig(config); err != nil {
  100. return nil, err
  101. }
  102. // Attempt to clean up when receiving these signals.
  103. signal.Notify(server.signals, ServerExitSignals...)
  104. signal.Notify(server.rehashSignal, syscall.SIGHUP)
  105. time.AfterFunc(alwaysOnExpirationPollPeriod, server.handleAlwaysOnExpirations)
  106. return server, nil
  107. }
  108. // Shutdown shuts down the server.
  109. func (server *Server) Shutdown() {
  110. //TODO(dan): Make sure we disallow new nicks
  111. for _, client := range server.clients.AllClients() {
  112. client.Notice("Server is shutting down")
  113. if client.AlwaysOn() {
  114. client.Store(IncludeLastSeen)
  115. }
  116. }
  117. if err := server.store.Close(); err != nil {
  118. server.logger.Error("shutdown", fmt.Sprintln("Could not close datastore:", err))
  119. }
  120. server.historyDB.Close()
  121. }
  122. // Run starts the server.
  123. func (server *Server) Run() {
  124. // defer closing db/store
  125. defer server.store.Close()
  126. for {
  127. select {
  128. case <-server.signals:
  129. server.Shutdown()
  130. return
  131. case <-server.rehashSignal:
  132. go func() {
  133. server.logger.Info("server", "Rehashing due to SIGHUP")
  134. server.rehash()
  135. }()
  136. }
  137. }
  138. }
  139. func (server *Server) checkBans(config *Config, ipaddr net.IP, checkScripts bool) (banned bool, requireSASL bool, message string) {
  140. // #671: do not enforce bans against loopback, as a failsafe
  141. // note that this function is not used for Tor connections (checkTorLimits is used instead)
  142. if ipaddr.IsLoopback() {
  143. return
  144. }
  145. if server.Defcon() == 1 {
  146. if !utils.IPInNets(ipaddr, server.Config().Server.secureNets) {
  147. return true, false, "New connections to this server are temporarily restricted"
  148. }
  149. }
  150. flat := flatip.FromNetIP(ipaddr)
  151. // check DLINEs
  152. isBanned, info := server.dlines.CheckIP(flat)
  153. if isBanned {
  154. if info.RequireSASL {
  155. server.logger.Info("connect-ip", "Requiring SASL from client due to d-line", ipaddr.String())
  156. return false, true, info.BanMessage("You must authenticate with SASL to connect from this IP (%s)")
  157. } else {
  158. server.logger.Info("connect-ip", "Client rejected by d-line", ipaddr.String())
  159. return true, false, info.BanMessage("You are banned from this server (%s)")
  160. }
  161. }
  162. // check connection limits
  163. err := server.connectionLimiter.AddClient(flat)
  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", "Client rejected for connection limit", ipaddr.String())
  167. return true, false, "Too many clients from your network"
  168. } else if err == connection_limits.ErrThrottleExceeded {
  169. server.logger.Info("connect-ip", "Client exceeded connection throttle", ipaddr.String())
  170. return true, false, throttleMessage
  171. } else if err != nil {
  172. server.logger.Warning("internal", "unexpected ban result", err.Error())
  173. }
  174. if checkScripts && config.Server.IPCheckScript.Enabled {
  175. output, err := CheckIPBan(server.semaphores.IPCheckScript, config.Server.IPCheckScript, ipaddr)
  176. if err != nil {
  177. server.logger.Error("internal", "couldn't check IP ban script", ipaddr.String(), err.Error())
  178. return false, false, ""
  179. }
  180. // TODO: currently no way to cache IPAccepted
  181. if (output.Result == IPBanned || output.Result == IPRequireSASL) && output.CacheSeconds != 0 {
  182. network, err := flatip.ParseToNormalizedNet(output.CacheNet)
  183. if err != nil {
  184. server.logger.Error("internal", "invalid dline net from IP ban script", ipaddr.String(), output.CacheNet)
  185. } else {
  186. dlineDuration := time.Duration(output.CacheSeconds) * time.Second
  187. err := server.dlines.AddNetwork(network, dlineDuration, output.Result == IPRequireSASL, output.BanMessage, "", "")
  188. if err != nil {
  189. server.logger.Error("internal", "couldn't set dline from IP ban script", ipaddr.String(), err.Error())
  190. }
  191. }
  192. }
  193. if output.Result == IPBanned {
  194. // XXX roll back IP connection/throttling addition for the IP
  195. server.connectionLimiter.RemoveClient(flat)
  196. server.logger.Info("connect-ip", "Rejected client due to ip-check-script", ipaddr.String())
  197. return true, false, output.BanMessage
  198. } else if output.Result == IPRequireSASL {
  199. server.logger.Info("connect-ip", "Requiring SASL from client due to ip-check-script", ipaddr.String())
  200. return false, true, output.BanMessage
  201. }
  202. }
  203. return false, false, ""
  204. }
  205. func (server *Server) checkTorLimits() (banned bool, message string) {
  206. switch server.torLimiter.AddClient() {
  207. case connection_limits.ErrLimitExceeded:
  208. return true, "Too many clients from the Tor network"
  209. case connection_limits.ErrThrottleExceeded:
  210. return true, "Exceeded connection throttle for the Tor network"
  211. default:
  212. return false, ""
  213. }
  214. }
  215. func (server *Server) handleAlwaysOnExpirations() {
  216. defer func() {
  217. if r := recover(); r != nil {
  218. server.logger.Error("internal",
  219. fmt.Sprintf("Panic in always-on cleanup: %v\n%s", r, debug.Stack()))
  220. }
  221. // either way, reschedule
  222. time.AfterFunc(alwaysOnExpirationPollPeriod, server.handleAlwaysOnExpirations)
  223. }()
  224. config := server.Config()
  225. deadline := time.Duration(config.Accounts.Multiclient.AlwaysOnExpiration)
  226. if deadline == 0 {
  227. return
  228. }
  229. server.logger.Info("accounts", "Checking always-on clients for expiration")
  230. for _, client := range server.clients.AllClients() {
  231. if client.IsExpiredAlwaysOn(config) {
  232. // TODO save the channels list, use it for autojoin if/when they return?
  233. server.logger.Info("accounts", "Expiring always-on client", client.AccountName())
  234. client.destroy(nil)
  235. }
  236. }
  237. }
  238. //
  239. // server functionality
  240. //
  241. func (server *Server) tryRegister(c *Client, session *Session) (exiting bool) {
  242. // if the session just sent us a RESUME line, try to resume
  243. if session.resumeDetails != nil {
  244. session.tryResume()
  245. return // whether we succeeded or failed, either way `c` is not getting registered
  246. }
  247. // XXX PROXY or WEBIRC MUST be sent as the first line of the session;
  248. // if we are here at all that means we have the final value of the IP
  249. if session.rawHostname == "" {
  250. session.client.lookupHostname(session, false)
  251. }
  252. // try to complete registration normally
  253. // XXX(#1057) username can be filled in by an ident query without the client
  254. // having sent USER: check for both username and realname to ensure they did
  255. if c.preregNick == "" || c.username == "" || c.realname == "" || session.capState == caps.NegotiatingState {
  256. return
  257. }
  258. if c.isSTSOnly {
  259. server.playSTSBurst(session)
  260. return true
  261. }
  262. // client MUST send PASS if necessary, or authenticate with SASL if necessary,
  263. // before completing the other registration commands
  264. config := server.Config()
  265. authOutcome := c.isAuthorized(server, config, session, c.requireSASL)
  266. var quitMessage string
  267. switch authOutcome {
  268. case authFailPass:
  269. quitMessage = c.t("Password incorrect")
  270. c.Send(nil, server.name, ERR_PASSWDMISMATCH, "*", quitMessage)
  271. case authFailSaslRequired, authFailTorSaslRequired:
  272. quitMessage = c.requireSASLMessage
  273. if quitMessage == "" {
  274. quitMessage = c.t("You must log in with SASL to join this server")
  275. }
  276. c.Send(nil, c.server.name, "FAIL", "*", "ACCOUNT_REQUIRED", quitMessage)
  277. }
  278. if authOutcome != authSuccess {
  279. c.Quit(quitMessage, nil)
  280. return true
  281. }
  282. c.requireSASLMessage = ""
  283. rb := NewResponseBuffer(session)
  284. nickError := performNickChange(server, c, c, session, c.preregNick, rb)
  285. rb.Send(true)
  286. if nickError == errInsecureReattach {
  287. c.Quit(c.t("You can't mix secure and insecure connections to this account"), nil)
  288. return true
  289. } else if nickError != nil {
  290. c.preregNick = ""
  291. return false
  292. }
  293. if session.client != c {
  294. // reattached, bail out.
  295. // we'll play the reg burst later, on the new goroutine associated with
  296. // (thisSession, otherClient). This is to avoid having to transfer state
  297. // like nickname, hostname, etc. to show the correct values in the reg burst.
  298. return false
  299. }
  300. // Apply default user modes (without updating the invisible counter)
  301. // The number of invisible users will be updated by server.stats.Register
  302. // if we're using default user mode +i.
  303. for _, defaultMode := range config.Accounts.defaultUserModes {
  304. c.SetMode(defaultMode, true)
  305. }
  306. // count new user in statistics (before checking KLINEs, see #1303)
  307. server.stats.Register(c.HasMode(modes.Invisible))
  308. // check KLINEs (#671: ignore KLINEs for loopback connections)
  309. if !session.IP().IsLoopback() || session.isTor {
  310. isBanned, info := server.klines.CheckMasks(c.AllNickmasks()...)
  311. if isBanned {
  312. c.Quit(info.BanMessage(c.t("You are banned from this server (%s)")), nil)
  313. return true
  314. }
  315. }
  316. server.playRegistrationBurst(session)
  317. return false
  318. }
  319. func (server *Server) playSTSBurst(session *Session) {
  320. nick := utils.SafeErrorParam(session.client.preregNick)
  321. session.Send(nil, server.name, RPL_WELCOME, nick, fmt.Sprintf("Welcome to the Internet Relay Network %s", nick))
  322. session.Send(nil, server.name, RPL_YOURHOST, nick, fmt.Sprintf("Your host is %[1]s, running version %[2]s", server.name, "oragono"))
  323. session.Send(nil, server.name, RPL_CREATED, nick, fmt.Sprintf("This server was created %s", time.Time{}.Format(time.RFC1123)))
  324. session.Send(nil, server.name, RPL_MYINFO, nick, server.name, "oragono", "o", "o", "o")
  325. session.Send(nil, server.name, RPL_ISUPPORT, nick, "CASEMAPPING=ascii", "are supported by this server")
  326. session.Send(nil, server.name, ERR_NOMOTD, nick, "MOTD is unavailable")
  327. for _, line := range server.Config().Server.STS.bannerLines {
  328. session.Send(nil, server.name, "NOTICE", nick, line)
  329. }
  330. }
  331. func (server *Server) playRegistrationBurst(session *Session) {
  332. c := session.client
  333. // continue registration
  334. d := c.Details()
  335. server.logger.Info("connect", fmt.Sprintf("Client connected [%s] [u:%s] [r:%s]", d.nick, d.username, d.realname))
  336. 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))
  337. if d.account != "" {
  338. server.sendLoginSnomask(d.nickMask, d.accountName)
  339. }
  340. // send welcome text
  341. //NOTE(dan): we specifically use the NICK here instead of the nickmask
  342. // see http://modern.ircdocs.horse/#rplwelcome-001 for details on why we avoid using the nickmask
  343. config := server.Config()
  344. session.Send(nil, server.name, RPL_WELCOME, d.nick, fmt.Sprintf(c.t("Welcome to the %s IRC Network %s"), config.Network.Name, d.nick))
  345. 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))
  346. session.Send(nil, server.name, RPL_CREATED, d.nick, fmt.Sprintf(c.t("This server was created %s"), server.ctime.Format(time.RFC1123)))
  347. session.Send(nil, server.name, RPL_MYINFO, d.nick, server.name, Ver, rplMyInfo1, rplMyInfo2, rplMyInfo3)
  348. rb := NewResponseBuffer(session)
  349. server.RplISupport(c, rb)
  350. server.Lusers(c, rb)
  351. server.MOTD(c, rb)
  352. rb.Send(true)
  353. modestring := c.ModeString()
  354. if modestring != "+" {
  355. session.Send(nil, server.name, RPL_UMODEIS, d.nick, modestring)
  356. }
  357. c.attemptAutoOper(session)
  358. if server.logger.IsLoggingRawIO() {
  359. 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."))
  360. }
  361. }
  362. // RplISupport outputs our ISUPPORT lines to the client. This is used on connection and in VERSION responses.
  363. func (server *Server) RplISupport(client *Client, rb *ResponseBuffer) {
  364. translatedISupport := client.t("are supported by this server")
  365. nick := client.Nick()
  366. config := server.Config()
  367. for _, cachedTokenLine := range config.Server.isupport.CachedReply {
  368. length := len(cachedTokenLine) + 2
  369. tokenline := make([]string, length)
  370. tokenline[0] = nick
  371. copy(tokenline[1:], cachedTokenLine)
  372. tokenline[length-1] = translatedISupport
  373. rb.Add(nil, server.name, RPL_ISUPPORT, tokenline...)
  374. }
  375. }
  376. func (server *Server) Lusers(client *Client, rb *ResponseBuffer) {
  377. nick := client.Nick()
  378. stats := server.stats.GetValues()
  379. 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))
  380. rb.Add(nil, server.name, RPL_LUSEROP, nick, strconv.Itoa(stats.Operators), client.t("IRC Operators online"))
  381. rb.Add(nil, server.name, RPL_LUSERUNKNOWN, nick, strconv.Itoa(stats.Unknown), client.t("unregistered connections"))
  382. rb.Add(nil, server.name, RPL_LUSERCHANNELS, nick, strconv.Itoa(server.channels.Len()), client.t("channels formed"))
  383. rb.Add(nil, server.name, RPL_LUSERME, nick, fmt.Sprintf(client.t("I have %[1]d clients and %[2]d servers"), stats.Total, 0))
  384. total := strconv.Itoa(stats.Total)
  385. max := strconv.Itoa(stats.Max)
  386. rb.Add(nil, server.name, RPL_LOCALUSERS, nick, total, max, fmt.Sprintf(client.t("Current local users %[1]s, max %[2]s"), total, max))
  387. rb.Add(nil, server.name, RPL_GLOBALUSERS, nick, total, max, fmt.Sprintf(client.t("Current global users %[1]s, max %[2]s"), total, max))
  388. }
  389. // MOTD serves the Message of the Day.
  390. func (server *Server) MOTD(client *Client, rb *ResponseBuffer) {
  391. motdLines := server.Config().Server.motdLines
  392. if len(motdLines) < 1 {
  393. rb.Add(nil, server.name, ERR_NOMOTD, client.nick, client.t("MOTD File is missing"))
  394. return
  395. }
  396. rb.Add(nil, server.name, RPL_MOTDSTART, client.nick, fmt.Sprintf(client.t("- %s Message of the day - "), server.name))
  397. for _, line := range motdLines {
  398. rb.Add(nil, server.name, RPL_MOTD, client.nick, line)
  399. }
  400. rb.Add(nil, server.name, RPL_ENDOFMOTD, client.nick, client.t("End of MOTD command"))
  401. }
  402. func (client *Client) whoisChannelsNames(target *Client, multiPrefix bool, hasPrivs bool) []string {
  403. var chstrs []string
  404. targetInvis := target.HasMode(modes.Invisible)
  405. for _, channel := range target.Channels() {
  406. if !hasPrivs && (targetInvis || channel.flags.HasMode(modes.Secret)) && !channel.hasClient(client) {
  407. // client can't see *this* channel membership
  408. continue
  409. }
  410. chstrs = append(chstrs, channel.ClientPrefixes(target, multiPrefix)+channel.name)
  411. }
  412. return chstrs
  413. }
  414. func (client *Client) getWhoisOf(target *Client, hasPrivs bool, rb *ResponseBuffer) {
  415. oper := client.Oper()
  416. cnick := client.Nick()
  417. targetInfo := target.Details()
  418. rb.Add(nil, client.server.name, RPL_WHOISUSER, cnick, targetInfo.nick, targetInfo.username, targetInfo.hostname, "*", targetInfo.realname)
  419. tnick := targetInfo.nick
  420. whoischannels := client.whoisChannelsNames(target, rb.session.capabilities.Has(caps.MultiPrefix), oper.HasRoleCapab("sajoin"))
  421. if whoischannels != nil {
  422. rb.Add(nil, client.server.name, RPL_WHOISCHANNELS, cnick, tnick, strings.Join(whoischannels, " "))
  423. }
  424. if target.HasMode(modes.Operator) && operStatusVisible(client, target, oper != nil) {
  425. tOper := target.Oper()
  426. if tOper != nil {
  427. rb.Add(nil, client.server.name, RPL_WHOISOPERATOR, cnick, tnick, tOper.WhoisLine)
  428. }
  429. }
  430. if client == target || oper.HasRoleCapab("ban") {
  431. 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"))
  432. }
  433. if client == target || oper.HasRoleCapab("samode") {
  434. rb.Add(nil, client.server.name, RPL_WHOISMODES, cnick, tnick, fmt.Sprintf(client.t("is using modes +%s"), target.modes.String()))
  435. }
  436. if target.HasMode(modes.TLS) {
  437. rb.Add(nil, client.server.name, RPL_WHOISSECURE, cnick, tnick, client.t("is using a secure connection"))
  438. }
  439. if targetInfo.accountName != "*" {
  440. rb.Add(nil, client.server.name, RPL_WHOISACCOUNT, cnick, tnick, targetInfo.accountName, client.t("is logged in as"))
  441. }
  442. if target.HasMode(modes.Bot) {
  443. rb.Add(nil, client.server.name, RPL_WHOISBOT, cnick, tnick, fmt.Sprintf(ircfmt.Unescape(client.t("is a $bBot$b on %s")), client.server.Config().Network.Name))
  444. }
  445. if client == target || oper.HasRoleCapab("ban") {
  446. for _, session := range target.Sessions() {
  447. if session.certfp != "" {
  448. rb.Add(nil, client.server.name, RPL_WHOISCERTFP, cnick, tnick, fmt.Sprintf(client.t("has client certificate fingerprint %s"), session.certfp))
  449. }
  450. }
  451. }
  452. 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"))
  453. if away, awayMessage := target.Away(); away {
  454. rb.Add(nil, client.server.name, RPL_AWAY, cnick, tnick, awayMessage)
  455. }
  456. }
  457. // rehash reloads the config and applies the changes from the config file.
  458. func (server *Server) rehash() error {
  459. server.logger.Info("server", "Attempting rehash")
  460. // only let one REHASH go on at a time
  461. server.rehashMutex.Lock()
  462. defer server.rehashMutex.Unlock()
  463. server.logger.Debug("server", "Got rehash lock")
  464. config, err := LoadConfig(server.configFilename)
  465. if err != nil {
  466. server.logger.Error("server", "failed to load config file", err.Error())
  467. return err
  468. }
  469. err = server.applyConfig(config)
  470. if err != nil {
  471. server.logger.Error("server", "Failed to rehash", err.Error())
  472. return err
  473. }
  474. server.logger.Info("server", "Rehash completed successfully")
  475. return nil
  476. }
  477. func (server *Server) applyConfig(config *Config) (err error) {
  478. oldConfig := server.Config()
  479. initial := oldConfig == nil
  480. if initial {
  481. server.configFilename = config.Filename
  482. server.name = config.Server.Name
  483. server.nameCasefolded = config.Server.nameCasefolded
  484. globalCasemappingSetting = config.Server.Casemapping
  485. globalUtf8EnforcementSetting = config.Server.EnforceUtf8
  486. } else {
  487. // enforce configs that can't be changed after launch:
  488. if server.name != config.Server.Name {
  489. return fmt.Errorf("Server name cannot be changed after launching the server, rehash aborted")
  490. } else if oldConfig.Datastore.Path != config.Datastore.Path {
  491. return fmt.Errorf("Datastore path cannot be changed after launching the server, rehash aborted")
  492. } else if globalCasemappingSetting != config.Server.Casemapping {
  493. return fmt.Errorf("Casemapping cannot be changed after launching the server, rehash aborted")
  494. } else if globalUtf8EnforcementSetting != config.Server.EnforceUtf8 {
  495. return fmt.Errorf("UTF-8 enforcement cannot be changed after launching the server, rehash aborted")
  496. } else if oldConfig.Accounts.Multiclient.AlwaysOn != config.Accounts.Multiclient.AlwaysOn {
  497. return fmt.Errorf("Default always-on setting cannot be changed after launching the server, rehash aborted")
  498. } else if oldConfig.Server.Relaymsg.Enabled != config.Server.Relaymsg.Enabled {
  499. return fmt.Errorf("Cannot enable or disable relaying after launching the server, rehash aborted")
  500. } else if oldConfig.Server.Relaymsg.Separators != config.Server.Relaymsg.Separators {
  501. return fmt.Errorf("Cannot change relaying separators after launching the server, rehash aborted")
  502. } else if oldConfig.Server.IPCheckScript.MaxConcurrency != config.Server.IPCheckScript.MaxConcurrency ||
  503. oldConfig.Accounts.AuthScript.MaxConcurrency != config.Accounts.AuthScript.MaxConcurrency {
  504. return fmt.Errorf("Cannot change max-concurrency for scripts after launching the server, rehash aborted")
  505. } else if oldConfig.Server.OverrideServicesHostname != config.Server.OverrideServicesHostname {
  506. return fmt.Errorf("Cannot change override-services-hostname after launching the server, rehash aborted")
  507. } else if !oldConfig.Datastore.MySQL.Enabled && config.Datastore.MySQL.Enabled {
  508. return fmt.Errorf("Cannot enable MySQL after launching the server, rehash aborted")
  509. }
  510. }
  511. server.logger.Info("server", "Using config file", server.configFilename)
  512. // first, reload config sections for functionality implemented in subpackages:
  513. wasLoggingRawIO := !initial && server.logger.IsLoggingRawIO()
  514. err = server.logger.ApplyConfig(config.Logging)
  515. if err != nil {
  516. return err
  517. }
  518. nowLoggingRawIO := server.logger.IsLoggingRawIO()
  519. // notify existing clients if raw i/o logging was enabled by a rehash
  520. sendRawOutputNotice := !wasLoggingRawIO && nowLoggingRawIO
  521. server.connectionLimiter.ApplyConfig(&config.Server.IPLimits)
  522. tlConf := &config.Server.TorListeners
  523. server.torLimiter.Configure(tlConf.MaxConnections, tlConf.ThrottleDuration, tlConf.MaxConnectionsPerDuration)
  524. // Translations
  525. server.logger.Debug("server", "Regenerating HELP indexes for new languages")
  526. server.helpIndexManager.GenerateIndices(config.languageManager)
  527. if initial {
  528. maxIPConc := int(config.Server.IPCheckScript.MaxConcurrency)
  529. if maxIPConc != 0 {
  530. server.semaphores.IPCheckScript.Initialize(maxIPConc)
  531. }
  532. maxAuthConc := int(config.Accounts.AuthScript.MaxConcurrency)
  533. if maxAuthConc != 0 {
  534. server.semaphores.AuthScript.Initialize(maxAuthConc)
  535. }
  536. if err := overrideServicePrefixes(config.Server.OverrideServicesHostname); err != nil {
  537. return err
  538. }
  539. }
  540. if oldConfig != nil {
  541. // if certain features were enabled by rehash, we need to load the corresponding data
  542. // from the store
  543. if !oldConfig.Accounts.NickReservation.Enabled {
  544. server.accounts.buildNickToAccountIndex(config)
  545. }
  546. if !oldConfig.Channels.Registration.Enabled {
  547. server.channels.loadRegisteredChannels(config)
  548. }
  549. // resize history buffers as needed
  550. if config.historyChangedFrom(oldConfig) {
  551. for _, channel := range server.channels.Channels() {
  552. channel.resizeHistory(config)
  553. }
  554. for _, client := range server.clients.AllClients() {
  555. client.resizeHistory(config)
  556. }
  557. }
  558. if oldConfig.Accounts.Registration.Throttling != config.Accounts.Registration.Throttling {
  559. server.accounts.resetRegisterThrottle(config)
  560. }
  561. }
  562. server.logger.Info("server", "Using datastore", config.Datastore.Path)
  563. if initial {
  564. if err := server.loadDatastore(config); err != nil {
  565. return err
  566. }
  567. } else {
  568. if config.Datastore.MySQL.Enabled && config.Datastore.MySQL != oldConfig.Datastore.MySQL {
  569. server.historyDB.SetConfig(config.Datastore.MySQL)
  570. }
  571. }
  572. // now that the datastore is initialized, we can load the cloak secret from it
  573. // XXX this modifies config after the initial load, which is naughty,
  574. // but there's no data race because we haven't done SetConfig yet
  575. config.Server.Cloaks.SetSecret(LoadCloakSecret(server.store))
  576. // activate the new config
  577. server.SetConfig(config)
  578. // load [dk]-lines, registered users and channels, etc.
  579. if initial {
  580. if err := server.loadFromDatastore(config); err != nil {
  581. return err
  582. }
  583. }
  584. // burst new and removed caps
  585. addedCaps, removedCaps := config.Diff(oldConfig)
  586. var capBurstSessions []*Session
  587. added := make(map[caps.Version][]string)
  588. var removed []string
  589. if !addedCaps.Empty() || !removedCaps.Empty() {
  590. capBurstSessions = server.clients.AllWithCapsNotify()
  591. added[caps.Cap301] = addedCaps.Strings(caps.Cap301, config.Server.capValues, 0)
  592. added[caps.Cap302] = addedCaps.Strings(caps.Cap302, config.Server.capValues, 0)
  593. // removed never has values, so we leave it as Cap301
  594. removed = removedCaps.Strings(caps.Cap301, config.Server.capValues, 0)
  595. }
  596. for _, sSession := range capBurstSessions {
  597. // DEL caps and then send NEW ones so that updated caps get removed/added correctly
  598. if !removedCaps.Empty() {
  599. for _, capStr := range removed {
  600. sSession.Send(nil, server.name, "CAP", sSession.client.Nick(), "DEL", capStr)
  601. }
  602. }
  603. if !addedCaps.Empty() {
  604. for _, capStr := range added[sSession.capVersion] {
  605. sSession.Send(nil, server.name, "CAP", sSession.client.Nick(), "NEW", capStr)
  606. }
  607. }
  608. }
  609. server.setupPprofListener(config)
  610. // set RPL_ISUPPORT
  611. var newISupportReplies [][]string
  612. if oldConfig != nil {
  613. newISupportReplies = oldConfig.Server.isupport.GetDifference(&config.Server.isupport)
  614. }
  615. if len(config.Server.ProxyAllowedFrom) != 0 {
  616. server.logger.Info("server", "Proxied IPs will be accepted from", strings.Join(config.Server.ProxyAllowedFrom, ", "))
  617. }
  618. // we are now open for business
  619. err = server.setupListeners(config)
  620. if !initial {
  621. // push new info to all of our clients
  622. for _, sClient := range server.clients.AllClients() {
  623. for _, tokenline := range newISupportReplies {
  624. sClient.Send(nil, server.name, RPL_ISUPPORT, append([]string{sClient.nick}, tokenline...)...)
  625. }
  626. if sendRawOutputNotice {
  627. 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."))
  628. }
  629. }
  630. }
  631. return err
  632. }
  633. func (server *Server) setupPprofListener(config *Config) {
  634. pprofListener := ""
  635. if config.Debug.PprofListener != nil {
  636. pprofListener = *config.Debug.PprofListener
  637. }
  638. if server.pprofServer != nil {
  639. if pprofListener == "" || (pprofListener != server.pprofServer.Addr) {
  640. server.logger.Info("server", "Stopping pprof listener", server.pprofServer.Addr)
  641. server.pprofServer.Close()
  642. server.pprofServer = nil
  643. }
  644. }
  645. if pprofListener != "" && server.pprofServer == nil {
  646. ps := http.Server{
  647. Addr: pprofListener,
  648. }
  649. go func() {
  650. if err := ps.ListenAndServe(); err != nil {
  651. server.logger.Error("server", "pprof listener failed", err.Error())
  652. }
  653. }()
  654. server.pprofServer = &ps
  655. server.logger.Info("server", "Started pprof listener", server.pprofServer.Addr)
  656. }
  657. }
  658. func (server *Server) loadDatastore(config *Config) error {
  659. // open the datastore and load server state for which it (rather than config)
  660. // is the source of truth
  661. _, err := os.Stat(config.Datastore.Path)
  662. if os.IsNotExist(err) {
  663. server.logger.Warning("server", "database does not exist, creating it", config.Datastore.Path)
  664. err = initializeDB(config.Datastore.Path)
  665. if err != nil {
  666. return err
  667. }
  668. }
  669. db, err := OpenDatabase(config)
  670. if err == nil {
  671. server.store = db
  672. return nil
  673. } else {
  674. return fmt.Errorf("Failed to open datastore: %s", err.Error())
  675. }
  676. }
  677. func (server *Server) loadFromDatastore(config *Config) (err error) {
  678. // load *lines (from the datastores)
  679. server.logger.Debug("server", "Loading D/Klines")
  680. server.loadDLines()
  681. server.loadKLines()
  682. server.channelRegistry.Initialize(server)
  683. server.channels.Initialize(server)
  684. server.accounts.Initialize(server)
  685. if config.Datastore.MySQL.Enabled {
  686. server.historyDB.Initialize(server.logger, config.Datastore.MySQL)
  687. err = server.historyDB.Open()
  688. if err != nil {
  689. server.logger.Error("internal", "could not connect to mysql", err.Error())
  690. return err
  691. }
  692. }
  693. return nil
  694. }
  695. func (server *Server) setupListeners(config *Config) (err error) {
  696. logListener := func(addr string, config utils.ListenerConfig) {
  697. server.logger.Info("listeners",
  698. fmt.Sprintf("now listening on %s, tls=%t, proxy=%t, tor=%t, websocket=%t.", addr, (config.TLSConfig != nil), config.RequireProxy, config.Tor, config.WebSocket),
  699. )
  700. }
  701. // update or destroy all existing listeners
  702. for addr := range server.listeners {
  703. currentListener := server.listeners[addr]
  704. newConfig, stillConfigured := config.Server.trueListeners[addr]
  705. if stillConfigured {
  706. if reloadErr := currentListener.Reload(newConfig); reloadErr == nil {
  707. logListener(addr, newConfig)
  708. } else {
  709. // stop the listener; we will attempt to replace it below
  710. currentListener.Stop()
  711. delete(server.listeners, addr)
  712. }
  713. } else {
  714. currentListener.Stop()
  715. delete(server.listeners, addr)
  716. server.logger.Info("listeners", fmt.Sprintf("stopped listening on %s.", addr))
  717. }
  718. }
  719. publicPlaintextListener := ""
  720. // create new listeners that were not previously configured,
  721. // or that couldn't be reloaded above:
  722. for newAddr, newConfig := range config.Server.trueListeners {
  723. if strings.HasPrefix(newAddr, ":") && !newConfig.Tor && !newConfig.STSOnly && newConfig.TLSConfig == nil {
  724. publicPlaintextListener = newAddr
  725. }
  726. _, exists := server.listeners[newAddr]
  727. if !exists {
  728. // make a new listener
  729. newListener, newErr := NewListener(server, newAddr, newConfig, config.Server.UnixBindMode)
  730. if newErr == nil {
  731. server.listeners[newAddr] = newListener
  732. logListener(newAddr, newConfig)
  733. } else {
  734. server.logger.Error("server", "couldn't listen on", newAddr, newErr.Error())
  735. err = newErr
  736. }
  737. }
  738. }
  739. if publicPlaintextListener != "" {
  740. server.logger.Warning("listeners", fmt.Sprintf("Your server is configured with public plaintext listener %s. Consider disabling it for improved security and privacy.", publicPlaintextListener))
  741. }
  742. return
  743. }
  744. // Gets the abstract sequence from which we're going to query history;
  745. // we may already know the channel we're querying, or we may have
  746. // to look it up via a string query. This function is responsible for
  747. // privilege checking.
  748. func (server *Server) GetHistorySequence(providedChannel *Channel, client *Client, query string) (channel *Channel, sequence history.Sequence, err error) {
  749. config := server.Config()
  750. // 4 cases: {persistent, ephemeral} x {normal, conversation}
  751. // with ephemeral history, target is implicit in the choice of `hist`,
  752. // and correspondent is "" if we're retrieving a channel or *, and the correspondent's name
  753. // if we're retrieving a DM conversation ("query buffer"). with persistent history,
  754. // target is always nonempty, and correspondent is either empty or nonempty as before.
  755. var status HistoryStatus
  756. var target, correspondent string
  757. var hist *history.Buffer
  758. restriction := HistoryCutoffNone
  759. channel = providedChannel
  760. if channel == nil {
  761. if strings.HasPrefix(query, "#") {
  762. channel = server.channels.Get(query)
  763. if channel == nil {
  764. return
  765. }
  766. }
  767. }
  768. var joinTimeCutoff time.Time
  769. if channel != nil {
  770. if present, cutoff := channel.joinTimeCutoff(client); present {
  771. joinTimeCutoff = cutoff
  772. } else {
  773. err = errInsufficientPrivs
  774. return
  775. }
  776. status, target, restriction = channel.historyStatus(config)
  777. switch status {
  778. case HistoryEphemeral:
  779. hist = &channel.history
  780. case HistoryPersistent:
  781. // already set `target`
  782. default:
  783. return
  784. }
  785. } else {
  786. status, target = client.historyStatus(config)
  787. if query != "*" {
  788. correspondent, err = CasefoldName(query)
  789. if err != nil {
  790. return
  791. }
  792. }
  793. switch status {
  794. case HistoryEphemeral:
  795. hist = &client.history
  796. case HistoryPersistent:
  797. // already set `target`, and `correspondent` if necessary
  798. default:
  799. return
  800. }
  801. }
  802. var cutoff time.Time
  803. if config.History.Restrictions.ExpireTime != 0 {
  804. cutoff = time.Now().UTC().Add(-time.Duration(config.History.Restrictions.ExpireTime))
  805. }
  806. // #836: registration date cutoff is always enforced for DMs
  807. // either way, take the later of the two cutoffs
  808. if restriction == HistoryCutoffRegistrationTime || channel == nil {
  809. regCutoff := client.historyCutoff()
  810. if regCutoff.After(cutoff) {
  811. cutoff = regCutoff
  812. }
  813. } else if restriction == HistoryCutoffJoinTime {
  814. if joinTimeCutoff.After(cutoff) {
  815. cutoff = joinTimeCutoff
  816. }
  817. }
  818. // #836 again: grace period is never applied to DMs
  819. if !cutoff.IsZero() && channel != nil && restriction != HistoryCutoffJoinTime {
  820. cutoff = cutoff.Add(-time.Duration(config.History.Restrictions.GracePeriod))
  821. }
  822. if hist != nil {
  823. sequence = hist.MakeSequence(correspondent, cutoff)
  824. } else if target != "" {
  825. sequence = server.historyDB.MakeSequence(target, correspondent, cutoff)
  826. }
  827. return
  828. }
  829. func (server *Server) ForgetHistory(accountName string) {
  830. // sanity check
  831. if accountName == "*" {
  832. return
  833. }
  834. config := server.Config()
  835. if !config.History.Enabled {
  836. return
  837. }
  838. if cfAccount, err := CasefoldName(accountName); err == nil {
  839. server.historyDB.Forget(cfAccount)
  840. }
  841. persistent := config.History.Persistent
  842. if persistent.Enabled && persistent.UnregisteredChannels && persistent.RegisteredChannels == PersistentMandatory && persistent.DirectMessages == PersistentMandatory {
  843. return
  844. }
  845. predicate := func(item *history.Item) bool { return item.AccountName == accountName }
  846. for _, channel := range server.channels.Channels() {
  847. channel.history.Delete(predicate)
  848. }
  849. for _, client := range server.clients.AllClients() {
  850. client.history.Delete(predicate)
  851. }
  852. }
  853. // deletes a message. target is a hint about what buffer it's in (not required for
  854. // persistent history, where all the msgids are indexed together). if accountName
  855. // is anything other than "*", it must match the recorded AccountName of the message
  856. func (server *Server) DeleteMessage(target, msgid, accountName string) (err error) {
  857. config := server.Config()
  858. var hist *history.Buffer
  859. if target != "" {
  860. if target[0] == '#' {
  861. channel := server.channels.Get(target)
  862. if channel != nil {
  863. if status, _, _ := channel.historyStatus(config); status == HistoryEphemeral {
  864. hist = &channel.history
  865. }
  866. }
  867. } else {
  868. client := server.clients.Get(target)
  869. if client != nil {
  870. if status, _ := client.historyStatus(config); status == HistoryEphemeral {
  871. hist = &client.history
  872. }
  873. }
  874. }
  875. }
  876. if hist == nil {
  877. err = server.historyDB.DeleteMsgid(msgid, accountName)
  878. } else {
  879. count := hist.Delete(func(item *history.Item) bool {
  880. return item.Message.Msgid == msgid && (accountName == "*" || item.AccountName == accountName)
  881. })
  882. if count == 0 {
  883. err = errNoop
  884. }
  885. }
  886. return
  887. }
  888. // elistMatcher takes and matches ELIST conditions
  889. type elistMatcher struct {
  890. MinClientsActive bool
  891. MinClients int
  892. MaxClientsActive bool
  893. MaxClients int
  894. }
  895. // Matches checks whether the given channel matches our matches.
  896. func (matcher *elistMatcher) Matches(channel *Channel) bool {
  897. if matcher.MinClientsActive {
  898. if len(channel.Members()) < matcher.MinClients {
  899. return false
  900. }
  901. }
  902. if matcher.MaxClientsActive {
  903. if len(channel.Members()) < len(channel.members) {
  904. return false
  905. }
  906. }
  907. return true
  908. }
  909. var (
  910. infoString1 = strings.Split(` ▄▄▄ ▄▄▄· ▄▄ • ▐ ▄
  911. ▪ ▀▄ █·▐█ ▀█ ▐█ ▀ ▪▪ •█▌▐█▪
  912. ▄█▀▄ ▐▀▀▄ ▄█▀▀█ ▄█ ▀█▄ ▄█▀▄▪▐█▐▐▌ ▄█▀▄
  913. ▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
  914. ▀█▄▀▪.▀ ▀ ▀ ▀ ·▀▀▀▀ ▀█▄▀ ▀▀ █▪ ▀█▄▀▪
  915. https://oragono.io/
  916. https://github.com/oragono/oragono
  917. https://crowdin.com/project/oragono
  918. `, "\n")
  919. infoString2 = strings.Split(` Daniel Oakley, DanielOaks, <daniel@danieloaks.net>
  920. Shivaram Lingamneni, slingamn, <slingamn@cs.stanford.edu>
  921. `, "\n")
  922. infoString3 = strings.Split(` Jeremy Latt, jlatt
  923. Edmund Huber, edmund-huber
  924. `, "\n")
  925. )